Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.LexModels.PutBotAlias

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates an alias for the specified version of the bot or replaces an alias for the specified bot. To change the version of the bot that the alias points to, replace the alias. For more information about aliases, see versioning-aliases.

This operation requires permissions for the lex:PutBotAlias action.

Synopsis

data PutBotAlias = PutBotAlias' {
- checksum :: Maybe Text
- conversationLogs :: Maybe ConversationLogsRequest
- description :: Maybe Text
- tags :: Maybe [Tag]
- name :: Text
- botVersion :: Text
- botName :: Text
}
newPutBotAlias :: Text -> Text -> Text -> PutBotAlias
putBotAlias_checksum :: Lens' PutBotAlias (Maybe Text)
putBotAlias_conversationLogs :: Lens' PutBotAlias (Maybe ConversationLogsRequest)
putBotAlias_description :: Lens' PutBotAlias (Maybe Text)
putBotAlias_tags :: Lens' PutBotAlias (Maybe [Tag])
putBotAlias_name :: Lens' PutBotAlias Text
putBotAlias_botVersion :: Lens' PutBotAlias Text
putBotAlias_botName :: Lens' PutBotAlias Text
data PutBotAliasResponse = PutBotAliasResponse' {
- checksum :: Maybe Text
- botVersion :: Maybe Text
- botName :: Maybe Text
- createdDate :: Maybe POSIX
- name :: Maybe Text
- conversationLogs :: Maybe ConversationLogsResponse
- lastUpdatedDate :: Maybe POSIX
- description :: Maybe Text
- tags :: Maybe [Tag]
- httpStatus :: Int
}
newPutBotAliasResponse :: Int -> PutBotAliasResponse
putBotAliasResponse_checksum :: Lens' PutBotAliasResponse (Maybe Text)
putBotAliasResponse_botVersion :: Lens' PutBotAliasResponse (Maybe Text)
putBotAliasResponse_botName :: Lens' PutBotAliasResponse (Maybe Text)
putBotAliasResponse_createdDate :: Lens' PutBotAliasResponse (Maybe UTCTime)
putBotAliasResponse_name :: Lens' PutBotAliasResponse (Maybe Text)
putBotAliasResponse_conversationLogs :: Lens' PutBotAliasResponse (Maybe ConversationLogsResponse)
putBotAliasResponse_lastUpdatedDate :: Lens' PutBotAliasResponse (Maybe UTCTime)
putBotAliasResponse_description :: Lens' PutBotAliasResponse (Maybe Text)
putBotAliasResponse_tags :: Lens' PutBotAliasResponse (Maybe [Tag])
putBotAliasResponse_httpStatus :: Lens' PutBotAliasResponse Int

Creating a Request

data PutBotAlias Source #

See: newPutBotAlias smart constructor.

Constructors

PutBotAlias'

Fields

checksum :: Maybe Text
Identifies a specific revision of the $LATEST version.
When you create a new bot alias, leave the checksum field blank. If you specify a checksum you get a BadRequestException exception.
When you want to update a bot alias, set the checksum field to the checksum of the most recent revision of the $LATEST version. If you don't specify the checksum field, or if the checksum does not match the $LATEST version, you get a PreconditionFailedException exception.
conversationLogs :: Maybe ConversationLogsRequest
Settings for conversation logs for the alias.
description :: Maybe Text
A description of the alias.
tags :: Maybe [Tag]
A list of tags to add to the bot alias. You can only add tags when you create an alias, you can't use the PutBotAlias operation to update the tags on a bot alias. To update tags, use the TagResource operation.
name :: Text
The name of the alias. The name is not case sensitive.
botVersion :: Text
The version of the bot.
botName :: Text
The name of the bot.

Instances

Instances details

Eq PutBotAlias Source #
Instance details Defined in Amazonka.LexModels.PutBotAlias Methods (==) :: PutBotAlias -> PutBotAlias -> Bool # (/=) :: PutBotAlias -> PutBotAlias -> Bool #
Read PutBotAlias Source #
Instance details Defined in Amazonka.LexModels.PutBotAlias Methods readsPrec :: Int -> ReadS PutBotAlias # readList :: ReadS [PutBotAlias] # readPrec :: ReadPrec PutBotAlias # readListPrec :: ReadPrec [PutBotAlias] #
Show PutBotAlias Source #
Instance details Defined in Amazonka.LexModels.PutBotAlias Methods showsPrec :: Int -> PutBotAlias -> ShowS # show :: PutBotAlias -> String # showList :: [PutBotAlias] -> ShowS #
Generic PutBotAlias Source #
Instance details Defined in Amazonka.LexModels.PutBotAlias Associated Types type Rep PutBotAlias :: Type -> Type # Methods from :: PutBotAlias -> Rep PutBotAlias x # to :: Rep PutBotAlias x -> PutBotAlias #
NFData PutBotAlias Source #
Instance details Defined in Amazonka.LexModels.PutBotAlias Methods rnf :: PutBotAlias -> () #
Hashable PutBotAlias Source #
Instance details Defined in Amazonka.LexModels.PutBotAlias Methods hashWithSalt :: Int -> PutBotAlias -> Int # hash :: PutBotAlias -> Int #
ToJSON PutBotAlias Source #
Instance details Defined in Amazonka.LexModels.PutBotAlias Methods toJSON :: PutBotAlias -> Value # toEncoding :: PutBotAlias -> Encoding # toJSONList :: [PutBotAlias] -> Value # toEncodingList :: [PutBotAlias] -> Encoding #
AWSRequest PutBotAlias Source #
Instance details Defined in Amazonka.LexModels.PutBotAlias Associated Types type AWSResponse PutBotAlias # Methods request :: PutBotAlias -> Request PutBotAlias # response :: MonadResource m => Logger -> Service -> Proxy PutBotAlias -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse PutBotAlias))) #
ToHeaders PutBotAlias Source #
Instance details Defined in Amazonka.LexModels.PutBotAlias Methods toHeaders :: PutBotAlias -> [Header] #
ToPath PutBotAlias Source #
Instance details Defined in Amazonka.LexModels.PutBotAlias Methods toPath :: PutBotAlias -> ByteString #
ToQuery PutBotAlias Source #
Instance details Defined in Amazonka.LexModels.PutBotAlias Methods toQuery :: PutBotAlias -> QueryString #
type Rep PutBotAlias Source #
Instance details Defined in Amazonka.LexModels.PutBotAlias type Rep PutBotAlias = D1 ('MetaData "PutBotAlias" "Amazonka.LexModels.PutBotAlias" "libZSservicesZSamazonka-lex-modelsZSamazonka-lex-models" 'False) (C1 ('MetaCons "PutBotAlias'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "checksum") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "conversationLogs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ConversationLogsRequest)) :: S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])) :: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :: (S1 ('MetaSel ('Just "botVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "botName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))
type AWSResponse PutBotAlias Source #
Instance details Defined in Amazonka.LexModels.PutBotAlias type AWSResponse PutBotAlias = PutBotAliasResponse

newPutBotAlias Source #

Arguments

:: Text	`$sel:name:PutBotAlias'`
-> Text	`$sel:botVersion:PutBotAlias'`
-> Text	`$sel:botName:PutBotAlias'`
-> PutBotAlias

Create a value of PutBotAlias 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:checksum:PutBotAlias', putBotAlias_checksum - Identifies a specific revision of the $LATEST version.

When you create a new bot alias, leave the checksum field blank. If you specify a checksum you get a BadRequestException exception.

When you want to update a bot alias, set the checksum field to the checksum of the most recent revision of the $LATEST version. If you don't specify the checksum field, or if the checksum does not match the $LATEST version, you get a PreconditionFailedException exception.

$sel:conversationLogs:PutBotAlias', putBotAlias_conversationLogs - Settings for conversation logs for the alias.

$sel:description:PutBotAlias', putBotAlias_description - A description of the alias.

$sel:tags:PutBotAlias', putBotAlias_tags - A list of tags to add to the bot alias. You can only add tags when you create an alias, you can't use the PutBotAlias operation to update the tags on a bot alias. To update tags, use the TagResource operation.

$sel:name:PutBotAlias', putBotAlias_name - The name of the alias. The name is not case sensitive.

$sel:botVersion:PutBotAlias', putBotAlias_botVersion - The version of the bot.

$sel:botName:PutBotAlias', putBotAlias_botName - The name of the bot.

Request Lenses

putBotAlias_checksum :: Lens' PutBotAlias (Maybe Text) Source #

Identifies a specific revision of the $LATEST version.

When you create a new bot alias, leave the checksum field blank. If you specify a checksum you get a BadRequestException exception.

When you want to update a bot alias, set the checksum field to the checksum of the most recent revision of the $LATEST version. If you don't specify the checksum field, or if the checksum does not match the $LATEST version, you get a PreconditionFailedException exception.

putBotAlias_conversationLogs :: Lens' PutBotAlias (Maybe ConversationLogsRequest) Source #

Settings for conversation logs for the alias.

putBotAlias_description :: Lens' PutBotAlias (Maybe Text) Source #

A description of the alias.

putBotAlias_tags :: Lens' PutBotAlias (Maybe [Tag]) Source #

A list of tags to add to the bot alias. You can only add tags when you create an alias, you can't use the PutBotAlias operation to update the tags on a bot alias. To update tags, use the TagResource operation.

putBotAlias_name :: Lens' PutBotAlias Text Source #

The name of the alias. The name is not case sensitive.

putBotAlias_botVersion :: Lens' PutBotAlias Text Source #

The version of the bot.

putBotAlias_botName :: Lens' PutBotAlias Text Source #

The name of the bot.

Destructuring the Response

data PutBotAliasResponse Source #

See: newPutBotAliasResponse smart constructor.

Constructors

PutBotAliasResponse'

Fields

checksum :: Maybe Text
The checksum for the current version of the alias.
botVersion :: Maybe Text
The version of the bot that the alias points to.
botName :: Maybe Text
The name of the bot that the alias points to.
createdDate :: Maybe POSIX
The date that the bot alias was created.
name :: Maybe Text
The name of the alias.
conversationLogs :: Maybe ConversationLogsResponse
The settings that determine how Amazon Lex uses conversation logs for the alias.
lastUpdatedDate :: Maybe POSIX
The date that the bot alias was updated. When you create a resource, the creation date and the last updated date are the same.
description :: Maybe Text
A description of the alias.
tags :: Maybe [Tag]
A list of tags associated with a bot.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Eq PutBotAliasResponse Source #
Instance details Defined in Amazonka.LexModels.PutBotAlias Methods (==) :: PutBotAliasResponse -> PutBotAliasResponse -> Bool # (/=) :: PutBotAliasResponse -> PutBotAliasResponse -> Bool #
Read PutBotAliasResponse Source #
Instance details Defined in Amazonka.LexModels.PutBotAlias Methods readsPrec :: Int -> ReadS PutBotAliasResponse # readList :: ReadS [PutBotAliasResponse] # readPrec :: ReadPrec PutBotAliasResponse # readListPrec :: ReadPrec [PutBotAliasResponse] #
Show PutBotAliasResponse Source #
Instance details Defined in Amazonka.LexModels.PutBotAlias Methods showsPrec :: Int -> PutBotAliasResponse -> ShowS # show :: PutBotAliasResponse -> String # showList :: [PutBotAliasResponse] -> ShowS #
Generic PutBotAliasResponse Source #
Instance details Defined in Amazonka.LexModels.PutBotAlias Associated Types type Rep PutBotAliasResponse :: Type -> Type # Methods from :: PutBotAliasResponse -> Rep PutBotAliasResponse x # to :: Rep PutBotAliasResponse x -> PutBotAliasResponse #
NFData PutBotAliasResponse Source #
Instance details Defined in Amazonka.LexModels.PutBotAlias Methods rnf :: PutBotAliasResponse -> () #
type Rep PutBotAliasResponse Source #
Instance details Defined in Amazonka.LexModels.PutBotAlias type Rep PutBotAliasResponse = D1 ('MetaData "PutBotAliasResponse" "Amazonka.LexModels.PutBotAlias" "libZSservicesZSamazonka-lex-modelsZSamazonka-lex-models" 'False) (C1 ('MetaCons "PutBotAliasResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "checksum") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "botVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "botName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "createdDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: ((S1 ('MetaSel ('Just "conversationLogs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ConversationLogsResponse)) :: S1 ('MetaSel ('Just "lastUpdatedDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))) :: (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))))

newPutBotAliasResponse Source #

Arguments

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

Create a value of PutBotAliasResponse 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:checksum:PutBotAlias', putBotAliasResponse_checksum - The checksum for the current version of the alias.

$sel:botVersion:PutBotAlias', putBotAliasResponse_botVersion - The version of the bot that the alias points to.

$sel:botName:PutBotAlias', putBotAliasResponse_botName - The name of the bot that the alias points to.

$sel:createdDate:PutBotAliasResponse', putBotAliasResponse_createdDate - The date that the bot alias was created.

$sel:name:PutBotAlias', putBotAliasResponse_name - The name of the alias.

$sel:conversationLogs:PutBotAlias', putBotAliasResponse_conversationLogs - The settings that determine how Amazon Lex uses conversation logs for the alias.

$sel:lastUpdatedDate:PutBotAliasResponse', putBotAliasResponse_lastUpdatedDate - The date that the bot alias was updated. When you create a resource, the creation date and the last updated date are the same.

$sel:description:PutBotAlias', putBotAliasResponse_description - A description of the alias.

$sel:tags:PutBotAlias', putBotAliasResponse_tags - A list of tags associated with a bot.

$sel:httpStatus:PutBotAliasResponse', putBotAliasResponse_httpStatus - The response's http status code.