Documentation ¶
Index ¶
- type BadRequestException
- type BotAliasMetadata
- type BotChannelAssociation
- type BotMetadata
- type BuiltinIntentMetadata
- type BuiltinIntentSlot
- type BuiltinSlotTypeMetadata
- type ChannelStatus
- type ChannelType
- type CodeHook
- type ConflictException
- type ContentType
- type ConversationLogsRequest
- type ConversationLogsResponse
- type Destination
- type EnumerationValue
- type ExportStatus
- type ExportType
- type FollowUpPrompt
- type FulfillmentActivity
- type FulfillmentActivityType
- type ImportStatus
- type Intent
- type IntentMetadata
- type InternalFailureException
- type KendraConfiguration
- type LimitExceededException
- type Locale
- type LogSettingsRequest
- type LogSettingsResponse
- type LogType
- type MergeStrategy
- type Message
- type NotFoundException
- type ObfuscationSetting
- type PreconditionFailedException
- type ProcessBehavior
- type Prompt
- type ReferenceType
- type ResourceInUseException
- type ResourceReference
- type ResourceType
- type Slot
- type SlotConstraint
- type SlotTypeConfiguration
- type SlotTypeMetadata
- type SlotTypeRegexConfiguration
- type SlotValueSelectionStrategy
- type Statement
- type Status
- type StatusType
- type Tag
- type UtteranceData
- type UtteranceList
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type BadRequestException ¶
type BadRequestException struct {
Message *string
}
The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and try again.
func (*BadRequestException) Error ¶
func (e *BadRequestException) Error() string
func (*BadRequestException) ErrorCode ¶
func (e *BadRequestException) ErrorCode() string
func (*BadRequestException) ErrorFault ¶
func (e *BadRequestException) ErrorFault() smithy.ErrorFault
func (*BadRequestException) ErrorMessage ¶
func (e *BadRequestException) ErrorMessage() string
type BotAliasMetadata ¶
type BotAliasMetadata struct { // The name of the bot to which the alias points. BotName *string // The version of the Amazon Lex bot to which the alias points. BotVersion *string // Checksum of the bot alias. Checksum *string // Settings that determine how Amazon Lex uses conversation logs for the alias. ConversationLogs *ConversationLogsResponse // The date that the bot alias was created. CreatedDate *time.Time // A description of the bot alias. Description *string // The date that the bot alias was updated. When you create a resource, the // creation date and last updated date are the same. LastUpdatedDate *time.Time // The name of the bot alias. Name *string }
Provides information about a bot alias.
type BotChannelAssociation ¶
type BotChannelAssociation struct { // An alias pointing to the specific version of the Amazon Lex bot to which this // association is being made. BotAlias *string // Provides information necessary to communicate with the messaging platform. BotConfiguration map[string]*string // The name of the Amazon Lex bot to which this association is being made. // Currently, Amazon Lex supports associations with Facebook and Slack, and Twilio. BotName *string // The date that the association between the Amazon Lex bot and the channel was // created. CreatedDate *time.Time // A text description of the association you are creating. Description *string // If status is FAILED, Amazon Lex provides the reason that it failed to create the // association. FailureReason *string // The name of the association between the bot and the channel. Name *string // The status of the bot channel. // // * CREATED - The channel has been created and // is ready for use. // // * IN_PROGRESS - Channel creation is in progress. // // * // FAILED - There was an error creating the channel. For information about the // reason for the failure, see the failureReason field. Status ChannelStatus // Specifies the type of association by indicating the type of channel being // established between the Amazon Lex bot and the external messaging platform. Type ChannelType }
Represents an association between an Amazon Lex bot and an external messaging platform.
type BotMetadata ¶
type BotMetadata struct { // The date that the bot was created. CreatedDate *time.Time // A description of the bot. Description *string // The date that the bot was updated. When you create a bot, the creation date and // last updated date are the same. LastUpdatedDate *time.Time // The name of the bot. Name *string // The status of the bot. Status Status // The version of the bot. For a new bot, the version is always $LATEST. Version *string }
Provides information about a bot. .
type BuiltinIntentMetadata ¶
type BuiltinIntentMetadata struct { // A unique identifier for the built-in intent. To find the signature for an // intent, see Standard Built-in Intents // (https://developer.amazon.com/public/solutions/alexa/alexa-skills-kit/docs/built-in-intent-ref/standard-intents) // in the Alexa Skills Kit. Signature *string // A list of identifiers for the locales that the intent supports. SupportedLocales []Locale }
Provides metadata for a built-in intent.
type BuiltinIntentSlot ¶
type BuiltinIntentSlot struct { // A list of the slots defined for the intent. Name *string }
Provides information about a slot used in a built-in intent.
type BuiltinSlotTypeMetadata ¶
type BuiltinSlotTypeMetadata struct { // A unique identifier for the built-in slot type. To find the signature for a slot // type, see Slot Type Reference // (https://developer.amazon.com/public/solutions/alexa/alexa-skills-kit/docs/built-in-intent-ref/slot-type-reference) // in the Alexa Skills Kit. Signature *string // A list of target locales for the slot. SupportedLocales []Locale }
Provides information about a built in slot type.
type ChannelStatus ¶
type ChannelStatus string
const ( ChannelStatusIn_progress ChannelStatus = "IN_PROGRESS" ChannelStatusCreated ChannelStatus = "CREATED" ChannelStatusFailed ChannelStatus = "FAILED" )
Enum values for ChannelStatus
type ChannelType ¶
type ChannelType string
const ( ChannelTypeFacebook ChannelType = "Facebook" ChannelTypeSlack ChannelType = "Slack" ChannelTypeTwilio_sms ChannelType = "Twilio-Sms" ChannelTypeKik ChannelType = "Kik" )
Enum values for ChannelType
type CodeHook ¶
type CodeHook struct { // The version of the request-response that you want Amazon Lex to use to invoke // your Lambda function. For more information, see using-lambda. // // This member is required. MessageVersion *string // The Amazon Resource Name (ARN) of the Lambda function. // // This member is required. Uri *string }
Specifies a Lambda function that verifies requests to a bot or fulfills the user's request to a bot..
type ConflictException ¶
type ConflictException struct {
Message *string
}
There was a conflict processing the request. Try your request again.
func (*ConflictException) Error ¶
func (e *ConflictException) Error() string
func (*ConflictException) ErrorCode ¶
func (e *ConflictException) ErrorCode() string
func (*ConflictException) ErrorFault ¶
func (e *ConflictException) ErrorFault() smithy.ErrorFault
func (*ConflictException) ErrorMessage ¶
func (e *ConflictException) ErrorMessage() string
type ContentType ¶
type ContentType string
const ( ContentTypePlain_text ContentType = "PlainText" ContentTypeSsml ContentType = "SSML" ContentTypeCustom_payload ContentType = "CustomPayload" )
Enum values for ContentType
type ConversationLogsRequest ¶
type ConversationLogsRequest struct { // The Amazon Resource Name (ARN) of an IAM role with permission to write to your // CloudWatch Logs for text logs and your S3 bucket for audio logs. If audio // encryption is enabled, this role also provides access permission for the AWS KMS // key used for encrypting audio logs. For more information, see Creating an IAM // Role and Policy for Conversation Logs // (https://docs.aws.amazon.com/lex/latest/dg/conversation-logs-role-and-policy.html). // // This member is required. IamRoleArn *string // The settings for your conversation logs. You can log the conversation text, // conversation audio, or both. // // This member is required. LogSettings []*LogSettingsRequest }
Provides the settings needed for conversation logs.
type ConversationLogsResponse ¶
type ConversationLogsResponse struct { // The Amazon Resource Name (ARN) of the IAM role used to write your logs to // CloudWatch Logs or an S3 bucket. IamRoleArn *string // The settings for your conversation logs. You can log text, audio, or both. LogSettings []*LogSettingsResponse }
Contains information about conversation log settings.
type Destination ¶
type Destination string
const ( DestinationCloudwatch_logs Destination = "CLOUDWATCH_LOGS" DestinationS3 Destination = "S3" )
Enum values for Destination
type EnumerationValue ¶
type EnumerationValue struct { // The value of the slot type. // // This member is required. Value *string // Additional values related to the slot type value. Synonyms []*string }
Each slot type can have a set of values. Each enumeration value represents a value the slot type can take. For example, a pizza ordering bot could have a slot type that specifies the type of crust that the pizza should have. The slot type could include the values
thick
thin
stuffed
type ExportStatus ¶
type ExportStatus string
const ( ExportStatusIn_progress ExportStatus = "IN_PROGRESS" ExportStatusReady ExportStatus = "READY" ExportStatusFailed ExportStatus = "FAILED" )
Enum values for ExportStatus
type ExportType ¶
type ExportType string
const ( ExportTypeAlexa_skills_kit ExportType = "ALEXA_SKILLS_KIT" ExportTypeLex ExportType = "LEX" )
Enum values for ExportType
type FollowUpPrompt ¶
type FollowUpPrompt struct { // Prompts for information from the user. // // This member is required. Prompt *Prompt // If the user answers "no" to the question defined in the prompt field, Amazon Lex // responds with this statement to acknowledge that the intent was canceled. // // This member is required. RejectionStatement *Statement }
A prompt for additional activity after an intent is fulfilled. For example, after the OrderPizza intent is fulfilled, you might prompt the user to find out whether the user wants to order drinks.
type FulfillmentActivity ¶
type FulfillmentActivity struct { // How the intent should be fulfilled, either by running a Lambda function or by // returning the slot data to the client application. // // This member is required. Type FulfillmentActivityType // A description of the Lambda function that is run to fulfill the intent. CodeHook *CodeHook }
Describes how the intent is fulfilled after the user provides all of the information required for the intent. You can provide a Lambda function to process the intent, or you can return the intent information to the client application. We recommend that you use a Lambda function so that the relevant logic lives in the Cloud and limit the client-side code primarily to presentation. If you need to update the logic, you only update the Lambda function; you don't need to upgrade your client application. Consider the following examples:
- In a pizza ordering application, after the user
provides all of the information for placing an order, you use a Lambda function to place an order with a pizzeria.
- In a gaming application, when a user
says "pick up a rock," this information must go back to the client application so that it can perform the operation and update the graphics. In this case, you want Amazon Lex to return the intent data to the client.
type FulfillmentActivityType ¶
type FulfillmentActivityType string
const ( FulfillmentActivityTypeReturn_intent FulfillmentActivityType = "ReturnIntent" FulfillmentActivityTypeCode_hook FulfillmentActivityType = "CodeHook" )
Enum values for FulfillmentActivityType
type ImportStatus ¶
type ImportStatus string
const ( ImportStatusIn_progress ImportStatus = "IN_PROGRESS" ImportStatusComplete ImportStatus = "COMPLETE" ImportStatusFailed ImportStatus = "FAILED" )
Enum values for ImportStatus
type Intent ¶
type Intent struct { // The name of the intent. // // This member is required. IntentName *string // The version of the intent. // // This member is required. IntentVersion *string }
Identifies the specific version of an intent.
type IntentMetadata ¶
type IntentMetadata struct { // The date that the intent was created. CreatedDate *time.Time // A description of the intent. Description *string // The date that the intent was updated. When you create an intent, the creation // date and last updated date are the same. LastUpdatedDate *time.Time // The name of the intent. Name *string // The version of the intent. Version *string }
Provides information about an intent.
type InternalFailureException ¶
type InternalFailureException struct {
Message *string
}
An internal Amazon Lex error occurred. Try your request again.
func (*InternalFailureException) Error ¶
func (e *InternalFailureException) Error() string
func (*InternalFailureException) ErrorCode ¶
func (e *InternalFailureException) ErrorCode() string
func (*InternalFailureException) ErrorFault ¶
func (e *InternalFailureException) ErrorFault() smithy.ErrorFault
func (*InternalFailureException) ErrorMessage ¶
func (e *InternalFailureException) ErrorMessage() string
type KendraConfiguration ¶
type KendraConfiguration struct { // The Amazon Resource Name (ARN) of the Amazon Kendra index that you want the // AMAZON.KendraSearchIntent intent to search. The index must be in the same // account and Region as the Amazon Lex bot. If the Amazon Kendra index does not // exist, you get an exception when you call the PutIntent operation. // // This member is required. KendraIndex *string // The Amazon Resource Name (ARN) of an IAM role that has permission to search the // Amazon Kendra index. The role must be in the same account and Region as the // Amazon Lex bot. If the role does not exist, you get an exception when you call // the PutIntent operation. // // This member is required. Role *string // A query filter that Amazon Lex sends to Amazon Kendra to filter the response // from the query. The filter is in the format defined by Amazon Kendra. For more // information, see Filtering queries // (http://docs.aws.amazon.com/kendra/latest/dg/filtering.html). You can override // this filter string with a new filter string at runtime. QueryFilterString *string }
Provides configuration information for the AMAZON.KendraSearchIntent intent. When you use this intent, Amazon Lex searches the specified Amazon Kendra index and returns documents from the index that match the user's utterance. For more information, see AMAZON.KendraSearchIntent (http://docs.aws.amazon.com/lex/latest/dg/built-in-intent-kendra-search.html).
type LimitExceededException ¶
The request exceeded a limit. Try your request again.
func (*LimitExceededException) Error ¶
func (e *LimitExceededException) Error() string
func (*LimitExceededException) ErrorCode ¶
func (e *LimitExceededException) ErrorCode() string
func (*LimitExceededException) ErrorFault ¶
func (e *LimitExceededException) ErrorFault() smithy.ErrorFault
func (*LimitExceededException) ErrorMessage ¶
func (e *LimitExceededException) ErrorMessage() string
type LogSettingsRequest ¶
type LogSettingsRequest struct { // Where the logs will be delivered. Text logs are delivered to a CloudWatch Logs // log group. Audio logs are delivered to an S3 bucket. // // This member is required. Destination Destination // The type of logging to enable. Text logs are delivered to a CloudWatch Logs log // group. Audio logs are delivered to an S3 bucket. // // This member is required. LogType LogType // The Amazon Resource Name (ARN) of the CloudWatch Logs log group or S3 bucket // where the logs should be delivered. // // This member is required. ResourceArn *string // The Amazon Resource Name (ARN) of the AWS KMS customer managed key for // encrypting audio logs delivered to an S3 bucket. The key does not apply to // CloudWatch Logs and is optional for S3 buckets. KmsKeyArn *string }
Settings used to configure delivery mode and destination for conversation logs.
type LogSettingsResponse ¶
type LogSettingsResponse struct { // The destination where logs are delivered. Destination Destination // The Amazon Resource Name (ARN) of the key used to encrypt audio logs in an S3 // bucket. KmsKeyArn *string // The type of logging that is enabled. LogType LogType // The Amazon Resource Name (ARN) of the CloudWatch Logs log group or S3 bucket // where the logs are delivered. ResourceArn *string // The resource prefix is the first part of the S3 object key within the S3 bucket // that you specified to contain audio logs. For CloudWatch Logs it is the prefix // of the log stream name within the log group that you specified. ResourcePrefix *string }
The settings for conversation logs.
type MergeStrategy ¶
type MergeStrategy string
const ( MergeStrategyOverwrite_latest MergeStrategy = "OVERWRITE_LATEST" MergeStrategyFail_on_conflict MergeStrategy = "FAIL_ON_CONFLICT" )
Enum values for MergeStrategy
type Message ¶
type Message struct { // The text of the message. // // This member is required. Content *string // The content type of the message string. // // This member is required. ContentType ContentType // Identifies the message group that the message belongs to. When a group is // assigned to a message, Amazon Lex returns one message from each group in the // response. GroupNumber *int32 }
The message object that provides the message text and its type.
type NotFoundException ¶
type NotFoundException struct {
Message *string
}
The resource specified in the request was not found. Check the resource and try again.
func (*NotFoundException) Error ¶
func (e *NotFoundException) Error() string
func (*NotFoundException) ErrorCode ¶
func (e *NotFoundException) ErrorCode() string
func (*NotFoundException) ErrorFault ¶
func (e *NotFoundException) ErrorFault() smithy.ErrorFault
func (*NotFoundException) ErrorMessage ¶
func (e *NotFoundException) ErrorMessage() string
type ObfuscationSetting ¶
type ObfuscationSetting string
const ( ObfuscationSettingNone ObfuscationSetting = "NONE" ObfuscationSettingDefault_obfuscation ObfuscationSetting = "DEFAULT_OBFUSCATION" )
Enum values for ObfuscationSetting
type PreconditionFailedException ¶
type PreconditionFailedException struct {
Message *string
}
The checksum of the resource that you are trying to change does not match the checksum in the request. Check the resource's checksum and try again.
func (*PreconditionFailedException) Error ¶
func (e *PreconditionFailedException) Error() string
func (*PreconditionFailedException) ErrorCode ¶
func (e *PreconditionFailedException) ErrorCode() string
func (*PreconditionFailedException) ErrorFault ¶
func (e *PreconditionFailedException) ErrorFault() smithy.ErrorFault
func (*PreconditionFailedException) ErrorMessage ¶
func (e *PreconditionFailedException) ErrorMessage() string
type ProcessBehavior ¶
type ProcessBehavior string
const ( ProcessBehaviorSave ProcessBehavior = "SAVE" ProcessBehaviorBuild ProcessBehavior = "BUILD" )
Enum values for ProcessBehavior
type Prompt ¶
type Prompt struct { // The number of times to prompt the user for information. // // This member is required. MaxAttempts *int32 // An array of objects, each of which provides a message string and its type. You // can specify the message string in plain text or in Speech Synthesis Markup // Language (SSML). // // This member is required. Messages []*Message // A response card. Amazon Lex uses this prompt at runtime, in the PostText API // response. It substitutes session attributes and slot values for placeholders in // the response card. For more information, see ex-resp-card. ResponseCard *string }
Obtains information from the user. To define a prompt, provide one or more messages and specify the number of attempts to get information from the user. If you provide more than one message, Amazon Lex chooses one of the messages to use to prompt the user. For more information, see how-it-works.
type ReferenceType ¶
type ReferenceType string
const ( ReferenceTypeIntent ReferenceType = "Intent" ReferenceTypeBot ReferenceType = "Bot" ReferenceTypeBotalias ReferenceType = "BotAlias" ReferenceTypeBotchannel ReferenceType = "BotChannel" )
Enum values for ReferenceType
type ResourceInUseException ¶
type ResourceInUseException struct { Message *string ReferenceType ReferenceType ExampleReference *ResourceReference }
The resource that you are attempting to delete is referred to by another resource. Use this information to remove references to the resource that you are trying to delete. The body of the exception contains a JSON object that describes the resource. { "resourceType": BOT | BOTALIAS | BOTCHANNEL | INTENT,
"resourceReference": {
"name": string, "version": string } }
func (*ResourceInUseException) Error ¶
func (e *ResourceInUseException) Error() string
func (*ResourceInUseException) ErrorCode ¶
func (e *ResourceInUseException) ErrorCode() string
func (*ResourceInUseException) ErrorFault ¶
func (e *ResourceInUseException) ErrorFault() smithy.ErrorFault
func (*ResourceInUseException) ErrorMessage ¶
func (e *ResourceInUseException) ErrorMessage() string
type ResourceReference ¶
type ResourceReference struct { // The name of the resource that is using the resource that you are trying to // delete. Name *string // The version of the resource that is using the resource that you are trying to // delete. Version *string }
Describes the resource that refers to the resource that you are attempting to delete. This object is returned as part of the ResourceInUseException exception.
type ResourceType ¶
type ResourceType string
const ( ResourceTypeBot ResourceType = "BOT" ResourceTypeIntent ResourceType = "INTENT" ResourceTypeSlot_type ResourceType = "SLOT_TYPE" )
Enum values for ResourceType
type Slot ¶
type Slot struct { // The name of the slot. // // This member is required. Name *string // Specifies whether the slot is required or optional. // // This member is required. SlotConstraint SlotConstraint // A description of the slot. Description *string // Determines whether a slot is obfuscated in conversation logs and stored // utterances. When you obfuscate a slot, the value is replaced by the slot name in // curly braces ({}). For example, if the slot name is "full_name", obfuscated // values are replaced with "{full_name}". For more information, see Slot // Obfuscation (https://docs.aws.amazon.com/lex/latest/dg/how-obfuscate.html). ObfuscationSetting ObfuscationSetting // Directs Amazon Lex the order in which to elicit this slot value from the user. // For example, if the intent has two slots with priorities 1 and 2, AWS Amazon Lex // first elicits a value for the slot with priority 1. If multiple slots share the // same priority, the order in which Amazon Lex elicits values is arbitrary. Priority *int32 // A set of possible responses for the slot type used by text-based clients. A user // chooses an option from the response card, instead of using text to reply. ResponseCard *string // If you know a specific pattern with which users might respond to an Amazon Lex // request for a slot value, you can provide those utterances to improve accuracy. // This is optional. In most cases, Amazon Lex is capable of understanding user // utterances. SampleUtterances []*string // The type of the slot, either a custom slot type that you defined or one of the // built-in slot types. SlotType *string // The version of the slot type. SlotTypeVersion *string // The prompt that Amazon Lex uses to elicit the slot value from the user. ValueElicitationPrompt *Prompt }
Identifies the version of a specific slot.
type SlotConstraint ¶
type SlotConstraint string
const ( SlotConstraintRequired SlotConstraint = "Required" SlotConstraintOptional SlotConstraint = "Optional" )
Enum values for SlotConstraint
type SlotTypeConfiguration ¶
type SlotTypeConfiguration struct { // A regular expression used to validate the value of a slot. RegexConfiguration *SlotTypeRegexConfiguration }
Provides configuration information for a slot type.
type SlotTypeMetadata ¶
type SlotTypeMetadata struct { // The date that the slot type was created. CreatedDate *time.Time // A description of the slot type. Description *string // The date that the slot type was updated. When you create a resource, the // creation date and last updated date are the same. LastUpdatedDate *time.Time // The name of the slot type. Name *string // The version of the slot type. Version *string }
Provides information about a slot type..
type SlotTypeRegexConfiguration ¶
type SlotTypeRegexConfiguration struct { // A regular expression used to validate the value of a slot. Use a standard // regular expression. Amazon Lex supports the following characters in the regular // expression: // // * A-Z, a-z // // * 0-9 // // * Unicode characters ("\ // u") // // Represent Unicode characters with four digits, for example "\u0041" or // "\u005A". The following regular expression operators are not supported: // // * // Infinite repeaters: *, +, or {x,} with no upper bound. // // * Wild card (.) // // This member is required. Pattern *string }
Provides a regular expression used to validate the value of a slot.
type SlotValueSelectionStrategy ¶
type SlotValueSelectionStrategy string
const ( SlotValueSelectionStrategyOriginal_value SlotValueSelectionStrategy = "ORIGINAL_VALUE" SlotValueSelectionStrategyTop_resolution SlotValueSelectionStrategy = "TOP_RESOLUTION" )
Enum values for SlotValueSelectionStrategy
type Statement ¶
type Statement struct { // A collection of message objects. // // This member is required. Messages []*Message // At runtime, if the client is using the PostText // (http://docs.aws.amazon.com/lex/latest/dg/API_runtime_PostText.html) API, Amazon // Lex includes the response card in the response. It substitutes all of the // session attributes and slot values for placeholders in the response card. ResponseCard *string }
A collection of messages that convey information to the user. At runtime, Amazon Lex selects the message to convey.
type StatusType ¶
type StatusType string
const ( StatusTypeDetected StatusType = "Detected" StatusTypeMissed StatusType = "Missed" )
Enum values for StatusType
type Tag ¶
type Tag struct { // The key for the tag. Keys are not case-sensitive and must be unique. // // This member is required. Key *string // The value associated with a key. The value may be an empty string but it can't // be null. // // This member is required. Value *string }
A list of key/value pairs that identify a bot, bot alias, or bot channel. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.
type UtteranceData ¶
type UtteranceData struct { // The number of times that the utterance was processed. Count *int32 // The total number of individuals that used the utterance. DistinctUsers *int32 // The date that the utterance was first recorded. FirstUtteredDate *time.Time // The date that the utterance was last recorded. LastUtteredDate *time.Time // The text that was entered by the user or the text representation of an audio // clip. UtteranceString *string }
Provides information about a single utterance that was made to your bot.
type UtteranceList ¶
type UtteranceList struct { // The version of the bot that processed the list. BotVersion *string // One or more UtteranceData objects that contain information about the utterances // that have been made to a bot. The maximum number of object is 100. Utterances []*UtteranceData }
Provides a list of utterances that have been made to a specific version of your bot. The list contains a maximum of 100 utterances.