AWS SDK for Go (PILOT)
API Reference

PREVIEW DOCUMENTATION - This is a preview of a new format for the AWS SDK for Go API Reference documentation. For the current AWS SDK for Go API Reference, see https://docs.aws.amazon.com/sdk-for-go/api/.

We welcome your feedback on this new version of the documentation. Send your comments to aws-sdkdocs-feedback@amazon.com.

PutBotInput

import "github.com/aws/aws-sdk-go/service/lexmodelbuildingservice"

type PutBotInput struct { AbortStatement *Statement `locationName:"abortStatement" type:"structure"` Checksum *string `locationName:"checksum" type:"string"` ChildDirected *bool `locationName:"childDirected" type:"boolean" required:"true"` ClarificationPrompt *Prompt `locationName:"clarificationPrompt" type:"structure"` CreateVersion *bool `locationName:"createVersion" type:"boolean"` Description *string `locationName:"description" type:"string"` IdleSessionTTLInSeconds *int64 `locationName:"idleSessionTTLInSeconds" min:"60" type:"integer"` Intents []*Intent `locationName:"intents" type:"list"` Locale *string `locationName:"locale" type:"string" required:"true" enum:"Locale"` Name *string `location:"uri" locationName:"name" min:"2" type:"string" required:"true"` ProcessBehavior *string `locationName:"processBehavior" type:"string" enum:"ProcessBehavior"` VoiceId *string `locationName:"voiceId" type:"string"` }

AbortStatement

A collection of messages that convey information to the user. At runtime, Amazon Lex selects the message to convey.

Checksum

Type: *string

Identifies a specific revision of the $LATEST version.

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

When you want to update a bot, 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.

ChildDirected

Type: *bool

For each Amazon Lex bot created with the Amazon Lex Model Building Service, you must specify whether your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to the Children's Online Privacy Protection Act (COPPA) by specifying true or false in the childDirected field. By specifying true in the childDirected field, you confirm that your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. By specifying false in the childDirected field, you confirm that your use of Amazon Lex is not related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. You may not specify a default value for the childDirected field that does not accurately reflect whether your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA.

If your use of Amazon Lex relates to a website, program, or other application that is directed in whole or in part, to children under age 13, you must obtain any required verifiable parental consent under COPPA. For information regarding the use of Amazon Lex in connection with websites, programs, or other applications that are directed or targeted, in whole or in part, to children under age 13, see the Amazon Lex FAQ. (https://aws.amazon.com/lex/faqs#data-security)

ChildDirected is a required field

ClarificationPrompt

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.

CreateVersion

Type: *bool

Description

Type: *string

A description of the bot.

IdleSessionTTLInSeconds

Type: *int64

The maximum time in seconds that Amazon Lex retains the data gathered in a conversation.

A user interaction session remains active for the amount of time specified. If no conversation occurs during this time, the session expires and Amazon Lex deletes any data provided before the timeout.

For example, suppose that a user chooses the OrderPizza intent, but gets sidetracked halfway through placing an order. If the user doesn't complete the order within the specified time, Amazon Lex discards the slot information that it gathered, and the user must start over.

If you don't include the idleSessionTTLInSeconds element in a PutBot operation request, Amazon Lex uses the default value. This is also true if the request replaces an existing bot.

The default is 300 seconds (5 minutes).

Intents

Identifies the specific version of an intent.

Locale

Type: *string

Specifies the target locale for the bot. Any intent used in the bot must be compatible with the locale of the bot.

The default is en-US.

Locale is a required field

Name

Type: *string

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

Name is a required field

ProcessBehavior

Type: *string

If you set the processBehavior element to BUILD, Amazon Lex builds the bot so that it can be run. If you set the element to SAVE Amazon Lex saves the bot, but doesn't build it.

If you don't specify this value, the default value is BUILD.

VoiceId

Type: *string

The Amazon Polly voice ID that you want Amazon Lex to use for voice interactions with the user. The locale configured for the voice must match the locale of the bot. For more information, see Available Voices (https://docs.aws.amazon.com/polly/latest/dg/voicelist.html) in the Amazon Polly Developer Guide.

Method

GoString

func (s PutBotInput) GoString() string

GoString returns the string representation

SetAbortStatement

func (s *PutBotInput) SetAbortStatement(v *Statement) *PutBotInput

SetAbortStatement sets the AbortStatement field's value.

SetChecksum

func (s *PutBotInput) SetChecksum(v string) *PutBotInput

SetChecksum sets the Checksum field's value.

SetChildDirected

func (s *PutBotInput) SetChildDirected(v bool) *PutBotInput

SetChildDirected sets the ChildDirected field's value.

SetClarificationPrompt

func (s *PutBotInput) SetClarificationPrompt(v *Prompt) *PutBotInput

SetClarificationPrompt sets the ClarificationPrompt field's value.

SetCreateVersion

func (s *PutBotInput) SetCreateVersion(v bool) *PutBotInput

SetCreateVersion sets the CreateVersion field's value.

SetDescription

func (s *PutBotInput) SetDescription(v string) *PutBotInput

SetDescription sets the Description field's value.

SetIdleSessionTTLInSeconds

func (s *PutBotInput) SetIdleSessionTTLInSeconds(v int64) *PutBotInput

SetIdleSessionTTLInSeconds sets the IdleSessionTTLInSeconds field's value.

SetIntents

func (s *PutBotInput) SetIntents(v []*Intent) *PutBotInput

SetIntents sets the Intents field's value.

SetLocale

func (s *PutBotInput) SetLocale(v string) *PutBotInput

SetLocale sets the Locale field's value.

SetName

func (s *PutBotInput) SetName(v string) *PutBotInput

SetName sets the Name field's value.

SetProcessBehavior

func (s *PutBotInput) SetProcessBehavior(v string) *PutBotInput

SetProcessBehavior sets the ProcessBehavior field's value.

SetVoiceId

func (s *PutBotInput) SetVoiceId(v string) *PutBotInput

SetVoiceId sets the VoiceId field's value.

String

func (s PutBotInput) String() string

String returns the string representation

Validate

func (s *PutBotInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

On this page: