libZSservicesZSamazonka-lex-modelsZSamazonka-lex-models
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.LexModels.CreateIntentVersion

Description

Creates a new version of an intent based on the $LATEST version of the intent. If the $LATEST version of this intent hasn't changed since you last updated it, Amazon Lex doesn't create a new version. It returns the last version you created.

You can update only the $LATEST version of the intent. You can't update the numbered versions that you create with the CreateIntentVersion operation.

When you create a version of an intent, Amazon Lex sets the version to 1. Subsequent versions increment by 1. For more information, see versioning-intro.

This operation requires permissions to perform the lex:CreateIntentVersion action.

Synopsis

Creating a Request

data CreateIntentVersion Source #

See: newCreateIntentVersion smart constructor.

Constructors

CreateIntentVersion' 

Fields

  • checksum :: Maybe Text

    Checksum of the $LATEST version of the intent that should be used to create the new version. If you specify a checksum and the $LATEST version of the intent has a different checksum, Amazon Lex returns a PreconditionFailedException exception and doesn't publish a new version. If you don't specify a checksum, Amazon Lex publishes the $LATEST version.

  • name :: Text

    The name of the intent that you want to create a new version of. The name is case sensitive.

Instances

Instances details
Eq CreateIntentVersion Source # 
Instance details

Defined in Amazonka.LexModels.CreateIntentVersion

Read CreateIntentVersion Source # 
Instance details

Defined in Amazonka.LexModels.CreateIntentVersion

Show CreateIntentVersion Source # 
Instance details

Defined in Amazonka.LexModels.CreateIntentVersion

Generic CreateIntentVersion Source # 
Instance details

Defined in Amazonka.LexModels.CreateIntentVersion

Associated Types

type Rep CreateIntentVersion :: Type -> Type #

NFData CreateIntentVersion Source # 
Instance details

Defined in Amazonka.LexModels.CreateIntentVersion

Methods

rnf :: CreateIntentVersion -> () #

Hashable CreateIntentVersion Source # 
Instance details

Defined in Amazonka.LexModels.CreateIntentVersion

ToJSON CreateIntentVersion Source # 
Instance details

Defined in Amazonka.LexModels.CreateIntentVersion

AWSRequest CreateIntentVersion Source # 
Instance details

Defined in Amazonka.LexModels.CreateIntentVersion

Associated Types

type AWSResponse CreateIntentVersion #

ToHeaders CreateIntentVersion Source # 
Instance details

Defined in Amazonka.LexModels.CreateIntentVersion

ToPath CreateIntentVersion Source # 
Instance details

Defined in Amazonka.LexModels.CreateIntentVersion

ToQuery CreateIntentVersion Source # 
Instance details

Defined in Amazonka.LexModels.CreateIntentVersion

type Rep CreateIntentVersion Source # 
Instance details

Defined in Amazonka.LexModels.CreateIntentVersion

type Rep CreateIntentVersion = D1 ('MetaData "CreateIntentVersion" "Amazonka.LexModels.CreateIntentVersion" "libZSservicesZSamazonka-lex-modelsZSamazonka-lex-models" 'False) (C1 ('MetaCons "CreateIntentVersion'" 'PrefixI 'True) (S1 ('MetaSel ('Just "checksum") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse CreateIntentVersion Source # 
Instance details

Defined in Amazonka.LexModels.CreateIntentVersion

newCreateIntentVersion Source #

Create a value of CreateIntentVersion 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:CreateIntentVersion', createIntentVersion_checksum - Checksum of the $LATEST version of the intent that should be used to create the new version. If you specify a checksum and the $LATEST version of the intent has a different checksum, Amazon Lex returns a PreconditionFailedException exception and doesn't publish a new version. If you don't specify a checksum, Amazon Lex publishes the $LATEST version.

$sel:name:CreateIntentVersion', createIntentVersion_name - The name of the intent that you want to create a new version of. The name is case sensitive.

Request Lenses

createIntentVersion_checksum :: Lens' CreateIntentVersion (Maybe Text) Source #

Checksum of the $LATEST version of the intent that should be used to create the new version. If you specify a checksum and the $LATEST version of the intent has a different checksum, Amazon Lex returns a PreconditionFailedException exception and doesn't publish a new version. If you don't specify a checksum, Amazon Lex publishes the $LATEST version.

createIntentVersion_name :: Lens' CreateIntentVersion Text Source #

The name of the intent that you want to create a new version of. The name is case sensitive.

Destructuring the Response

data CreateIntentVersionResponse Source #

See: newCreateIntentVersionResponse smart constructor.

Constructors

CreateIntentVersionResponse' 

Fields

Instances

Instances details
Eq CreateIntentVersionResponse Source # 
Instance details

Defined in Amazonka.LexModels.CreateIntentVersion

Read CreateIntentVersionResponse Source # 
Instance details

Defined in Amazonka.LexModels.CreateIntentVersion

Show CreateIntentVersionResponse Source # 
Instance details

Defined in Amazonka.LexModels.CreateIntentVersion

Generic CreateIntentVersionResponse Source # 
Instance details

Defined in Amazonka.LexModels.CreateIntentVersion

Associated Types

type Rep CreateIntentVersionResponse :: Type -> Type #

NFData CreateIntentVersionResponse Source # 
Instance details

Defined in Amazonka.LexModels.CreateIntentVersion

type Rep CreateIntentVersionResponse Source # 
Instance details

Defined in Amazonka.LexModels.CreateIntentVersion

type Rep CreateIntentVersionResponse = D1 ('MetaData "CreateIntentVersionResponse" "Amazonka.LexModels.CreateIntentVersion" "libZSservicesZSamazonka-lex-modelsZSamazonka-lex-models" 'False) (C1 ('MetaCons "CreateIntentVersionResponse'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "fulfillmentActivity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe FulfillmentActivity)) :*: S1 ('MetaSel ('Just "slots") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Slot]))) :*: (S1 ('MetaSel ('Just "rejectionStatement") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Statement)) :*: S1 ('MetaSel ('Just "checksum") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "conclusionStatement") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Statement)) :*: S1 ('MetaSel ('Just "sampleUtterances") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))) :*: (S1 ('MetaSel ('Just "parentIntentSignature") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "createdDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "kendraConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe KendraConfiguration)))))) :*: (((S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "version") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "inputContexts") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [InputContext])) :*: (S1 ('MetaSel ('Just "followUpPrompt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe FollowUpPrompt)) :*: S1 ('MetaSel ('Just "lastUpdatedDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))))) :*: ((S1 ('MetaSel ('Just "outputContexts") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [OutputContext])) :*: S1 ('MetaSel ('Just "confirmationPrompt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Prompt))) :*: (S1 ('MetaSel ('Just "dialogCodeHook") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CodeHook)) :*: (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))))

newCreateIntentVersionResponse Source #

Create a value of CreateIntentVersionResponse 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:fulfillmentActivity:CreateIntentVersionResponse', createIntentVersionResponse_fulfillmentActivity - Describes how the intent is fulfilled.

$sel:slots:CreateIntentVersionResponse', createIntentVersionResponse_slots - An array of slot types that defines the information required to fulfill the intent.

$sel:rejectionStatement:CreateIntentVersionResponse', createIntentVersionResponse_rejectionStatement - If the user answers "no" to the question defined in confirmationPrompt, Amazon Lex responds with this statement to acknowledge that the intent was canceled.

$sel:checksum:CreateIntentVersion', createIntentVersionResponse_checksum - Checksum of the intent version created.

$sel:conclusionStatement:CreateIntentVersionResponse', createIntentVersionResponse_conclusionStatement - After the Lambda function specified in the fulfillmentActivity field fulfills the intent, Amazon Lex conveys this statement to the user.

$sel:sampleUtterances:CreateIntentVersionResponse', createIntentVersionResponse_sampleUtterances - An array of sample utterances configured for the intent.

$sel:parentIntentSignature:CreateIntentVersionResponse', createIntentVersionResponse_parentIntentSignature - A unique identifier for a built-in intent.

$sel:createdDate:CreateIntentVersionResponse', createIntentVersionResponse_createdDate - The date that the intent was created.

$sel:kendraConfiguration:CreateIntentVersionResponse', createIntentVersionResponse_kendraConfiguration - Configuration information, if any, for connecting an Amazon Kendra index with the AMAZON.KendraSearchIntent intent.

$sel:name:CreateIntentVersion', createIntentVersionResponse_name - The name of the intent.

$sel:version:CreateIntentVersionResponse', createIntentVersionResponse_version - The version number assigned to the new version of the intent.

$sel:inputContexts:CreateIntentVersionResponse', createIntentVersionResponse_inputContexts - An array of InputContext objects that lists the contexts that must be active for Amazon Lex to choose the intent in a conversation with the user.

$sel:followUpPrompt:CreateIntentVersionResponse', createIntentVersionResponse_followUpPrompt - If defined, Amazon Lex uses this prompt to solicit additional user activity after the intent is fulfilled.

$sel:lastUpdatedDate:CreateIntentVersionResponse', createIntentVersionResponse_lastUpdatedDate - The date that the intent was updated.

$sel:outputContexts:CreateIntentVersionResponse', createIntentVersionResponse_outputContexts - An array of OutputContext objects that lists the contexts that the intent activates when the intent is fulfilled.

$sel:confirmationPrompt:CreateIntentVersionResponse', createIntentVersionResponse_confirmationPrompt - If defined, the prompt that Amazon Lex uses to confirm the user's intent before fulfilling it.

$sel:dialogCodeHook:CreateIntentVersionResponse', createIntentVersionResponse_dialogCodeHook - If defined, Amazon Lex invokes this Lambda function for each user input.

$sel:description:CreateIntentVersionResponse', createIntentVersionResponse_description - A description of the intent.

$sel:httpStatus:CreateIntentVersionResponse', createIntentVersionResponse_httpStatus - The response's http status code.

Response Lenses

createIntentVersionResponse_slots :: Lens' CreateIntentVersionResponse (Maybe [Slot]) Source #

An array of slot types that defines the information required to fulfill the intent.

createIntentVersionResponse_rejectionStatement :: Lens' CreateIntentVersionResponse (Maybe Statement) Source #

If the user answers "no" to the question defined in confirmationPrompt, Amazon Lex responds with this statement to acknowledge that the intent was canceled.

createIntentVersionResponse_conclusionStatement :: Lens' CreateIntentVersionResponse (Maybe Statement) Source #

After the Lambda function specified in the fulfillmentActivity field fulfills the intent, Amazon Lex conveys this statement to the user.

createIntentVersionResponse_sampleUtterances :: Lens' CreateIntentVersionResponse (Maybe [Text]) Source #

An array of sample utterances configured for the intent.

createIntentVersionResponse_kendraConfiguration :: Lens' CreateIntentVersionResponse (Maybe KendraConfiguration) Source #

Configuration information, if any, for connecting an Amazon Kendra index with the AMAZON.KendraSearchIntent intent.

createIntentVersionResponse_version :: Lens' CreateIntentVersionResponse (Maybe Text) Source #

The version number assigned to the new version of the intent.

createIntentVersionResponse_inputContexts :: Lens' CreateIntentVersionResponse (Maybe [InputContext]) Source #

An array of InputContext objects that lists the contexts that must be active for Amazon Lex to choose the intent in a conversation with the user.

createIntentVersionResponse_followUpPrompt :: Lens' CreateIntentVersionResponse (Maybe FollowUpPrompt) Source #

If defined, Amazon Lex uses this prompt to solicit additional user activity after the intent is fulfilled.

createIntentVersionResponse_outputContexts :: Lens' CreateIntentVersionResponse (Maybe [OutputContext]) Source #

An array of OutputContext objects that lists the contexts that the intent activates when the intent is fulfilled.

createIntentVersionResponse_confirmationPrompt :: Lens' CreateIntentVersionResponse (Maybe Prompt) Source #

If defined, the prompt that Amazon Lex uses to confirm the user's intent before fulfilling it.

createIntentVersionResponse_dialogCodeHook :: Lens' CreateIntentVersionResponse (Maybe CodeHook) Source #

If defined, Amazon Lex invokes this Lambda function for each user input.