Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.VoiceId.UpdateDomain

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Updates the specified domain. This API has clobber behavior, and clears and replaces all attributes. If an optional field, such as 'Description' is not provided, it is removed from the domain.

Creating a Request

data UpdateDomain Source #

See: newUpdateDomain smart constructor.

Constructors

UpdateDomain'

Fields

description :: Maybe (Sensitive Text)
A brief description of the domain.
domainId :: Text
The identifier of the domain to be updated.
name :: Sensitive Text
The name of the domain.
serverSideEncryptionConfiguration :: ServerSideEncryptionConfiguration
The configuration, containing the KMS key identifier, to be used by Voice ID for the server-side encryption of your data. Changing the domain's associated KMS key immediately triggers an asynchronous process to remove dependency on the old KMS key, such that the domain's data can only be accessed using the new KMS key. The domain's ServerSideEncryptionUpdateDetails contains the details for this process.

Instances

Instances details

ToJSON UpdateDomain Source #
Instance details Defined in Amazonka.VoiceId.UpdateDomain Methods toJSON :: UpdateDomain -> Value # toEncoding :: UpdateDomain -> Encoding # toJSONList :: [UpdateDomain] -> Value # toEncodingList :: [UpdateDomain] -> Encoding #
ToHeaders UpdateDomain Source #
Instance details Defined in Amazonka.VoiceId.UpdateDomain Methods toHeaders :: UpdateDomain -> [Header] #
ToPath UpdateDomain Source #
Instance details Defined in Amazonka.VoiceId.UpdateDomain Methods toPath :: UpdateDomain -> ByteString #
ToQuery UpdateDomain Source #
Instance details Defined in Amazonka.VoiceId.UpdateDomain Methods toQuery :: UpdateDomain -> QueryString #
AWSRequest UpdateDomain Source #
Instance details Defined in Amazonka.VoiceId.UpdateDomain Associated Types type AWSResponse UpdateDomain # Methods request :: (Service -> Service) -> UpdateDomain -> Request UpdateDomain # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy UpdateDomain -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse UpdateDomain))) #
Generic UpdateDomain Source #
Instance details Defined in Amazonka.VoiceId.UpdateDomain Associated Types type Rep UpdateDomain :: Type -> Type # Methods from :: UpdateDomain -> Rep UpdateDomain x # to :: Rep UpdateDomain x -> UpdateDomain #
Show UpdateDomain Source #
Instance details Defined in Amazonka.VoiceId.UpdateDomain Methods showsPrec :: Int -> UpdateDomain -> ShowS # show :: UpdateDomain -> String # showList :: [UpdateDomain] -> ShowS #
NFData UpdateDomain Source #
Instance details Defined in Amazonka.VoiceId.UpdateDomain Methods rnf :: UpdateDomain -> () #
Eq UpdateDomain Source #
Instance details Defined in Amazonka.VoiceId.UpdateDomain Methods (==) :: UpdateDomain -> UpdateDomain -> Bool # (/=) :: UpdateDomain -> UpdateDomain -> Bool #
Hashable UpdateDomain Source #
Instance details Defined in Amazonka.VoiceId.UpdateDomain Methods hashWithSalt :: Int -> UpdateDomain -> Int # hash :: UpdateDomain -> Int #
type AWSResponse UpdateDomain Source #
Instance details Defined in Amazonka.VoiceId.UpdateDomain type AWSResponse UpdateDomain = UpdateDomainResponse
type Rep UpdateDomain Source #
Instance details Defined in Amazonka.VoiceId.UpdateDomain type Rep UpdateDomain = D1 ('MetaData "UpdateDomain" "Amazonka.VoiceId.UpdateDomain" "amazonka-voice-id-2.0-E9fR3xKghdA6rj9Pl7P2NC" 'False) (C1 ('MetaCons "UpdateDomain'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :: S1 ('MetaSel ('Just "domainId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Sensitive Text)) :*: S1 ('MetaSel ('Just "serverSideEncryptionConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ServerSideEncryptionConfiguration))))

newUpdateDomain Source #

Arguments

:: Text	`UpdateDomain`
-> Text	`UpdateDomain`
-> ServerSideEncryptionConfiguration	`UpdateDomain`
-> UpdateDomain

Create a value of UpdateDomain with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

UpdateDomain, updateDomain_description - A brief description of the domain.

UpdateDomain, updateDomain_domainId - The identifier of the domain to be updated.

UpdateDomain, updateDomain_name - The name of the domain.

UpdateDomain, updateDomain_serverSideEncryptionConfiguration - The configuration, containing the KMS key identifier, to be used by Voice ID for the server-side encryption of your data. Changing the domain's associated KMS key immediately triggers an asynchronous process to remove dependency on the old KMS key, such that the domain's data can only be accessed using the new KMS key. The domain's ServerSideEncryptionUpdateDetails contains the details for this process.

Request Lenses

updateDomain_description :: Lens' UpdateDomain (Maybe Text) Source #

A brief description of the domain.

updateDomain_domainId :: Lens' UpdateDomain Text Source #

The identifier of the domain to be updated.

updateDomain_name :: Lens' UpdateDomain Text Source #

The name of the domain.

updateDomain_serverSideEncryptionConfiguration :: Lens' UpdateDomain ServerSideEncryptionConfiguration Source #

The configuration, containing the KMS key identifier, to be used by Voice ID for the server-side encryption of your data. Changing the domain's associated KMS key immediately triggers an asynchronous process to remove dependency on the old KMS key, such that the domain's data can only be accessed using the new KMS key. The domain's ServerSideEncryptionUpdateDetails contains the details for this process.

Destructuring the Response

data UpdateDomainResponse Source #

See: newUpdateDomainResponse smart constructor.

Constructors

UpdateDomainResponse'
Fields domain :: Maybe Domain Details about the updated domain httpStatus :: Int The response's http status code.

Instances

Instances details

Generic UpdateDomainResponse Source #
Instance details Defined in Amazonka.VoiceId.UpdateDomain Associated Types type Rep UpdateDomainResponse :: Type -> Type # Methods from :: UpdateDomainResponse -> Rep UpdateDomainResponse x # to :: Rep UpdateDomainResponse x -> UpdateDomainResponse #
Show UpdateDomainResponse Source #
Instance details Defined in Amazonka.VoiceId.UpdateDomain Methods showsPrec :: Int -> UpdateDomainResponse -> ShowS # show :: UpdateDomainResponse -> String # showList :: [UpdateDomainResponse] -> ShowS #
NFData UpdateDomainResponse Source #
Instance details Defined in Amazonka.VoiceId.UpdateDomain Methods rnf :: UpdateDomainResponse -> () #
Eq UpdateDomainResponse Source #
Instance details Defined in Amazonka.VoiceId.UpdateDomain Methods (==) :: UpdateDomainResponse -> UpdateDomainResponse -> Bool # (/=) :: UpdateDomainResponse -> UpdateDomainResponse -> Bool #
type Rep UpdateDomainResponse Source #
Instance details Defined in Amazonka.VoiceId.UpdateDomain type Rep UpdateDomainResponse = D1 ('MetaData "UpdateDomainResponse" "Amazonka.VoiceId.UpdateDomain" "amazonka-voice-id-2.0-E9fR3xKghdA6rj9Pl7P2NC" 'False) (C1 ('MetaCons "UpdateDomainResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "domain") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Domain)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newUpdateDomainResponse Source #

Arguments

:: Int	`$sel:httpStatus:UpdateDomainResponse'`
-> UpdateDomainResponse

Create a value of UpdateDomainResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:domain:UpdateDomainResponse', updateDomainResponse_domain - Details about the updated domain

$sel:httpStatus:UpdateDomainResponse', updateDomainResponse_httpStatus - The response's http status code.

Response Lenses

updateDomainResponse_domain :: Lens' UpdateDomainResponse (Maybe Domain) Source #

Details about the updated domain

updateDomainResponse_httpStatus :: Lens' UpdateDomainResponse Int Source #

The response's http status code.