lexmodelsv2

package module
v1.43.4 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Mar 29, 2024 License: Apache-2.0 Imports: 43 Imported by: 3

Documentation

Overview

Package lexmodelsv2 provides the API client, operations, and parameter types for Amazon Lex Model Building V2.

Index

Constants

View Source 
const ServiceAPIVersion = "2020-08-07"
View Source 
const ServiceID = "Lex Models V2"

Variables

This section is empty.

Functions

func NewDefaultEndpointResolver 

func NewDefaultEndpointResolver() *internalendpoints.Resolver

NewDefaultEndpointResolver constructs a new service endpoint resolver

func WithAPIOptions 

func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options)

WithAPIOptions returns a functional option for setting the Client's APIOptions option.

func WithEndpointResolver deprecated 

func WithEndpointResolver(v EndpointResolver) func(*Options)

Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for this field will likely prevent you from using any endpoint-related service features released after the introduction of EndpointResolverV2 and BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom endpoint, set the client option BaseEndpoint instead.

func WithEndpointResolverV2 added in v1.32.0 

func WithEndpointResolverV2(v EndpointResolverV2) func(*Options)

WithEndpointResolverV2 returns a functional option for setting the Client's EndpointResolverV2 option.

func WithSigV4SigningName added in v1.36.2 

func WithSigV4SigningName(name string) func(*Options)

WithSigV4SigningName applies an override to the authentication workflow to use the given signing name for SigV4-authenticated operations.

This is an advanced setting. The value here is FINAL, taking precedence over the resolved signing name from both auth scheme resolution and endpoint resolution.

func WithSigV4SigningRegion added in v1.36.2 

func WithSigV4SigningRegion(region string) func(*Options)

WithSigV4SigningRegion applies an override to the authentication workflow to use the given signing region for SigV4-authenticated operations.

This is an advanced setting. The value here is FINAL, taking precedence over the resolved signing region from both auth scheme resolution and endpoint resolution.

Types

type AuthResolverParameters added in v1.36.2 

type AuthResolverParameters struct {
	// The name of the operation being invoked.
	Operation string

	// The region in which the operation is being invoked.
	Region string
}

AuthResolverParameters contains the set of inputs necessary for auth scheme resolution.

type AuthSchemeResolver added in v1.36.2 

type AuthSchemeResolver interface {
	ResolveAuthSchemes(context.Context, *AuthResolverParameters) ([]*smithyauth.Option, error)
}

AuthSchemeResolver returns a set of possible authentication options for an operation.

type BatchCreateCustomVocabularyItemInput added in v1.26.0 

type BatchCreateCustomVocabularyItemInput struct {

	// The identifier of the bot associated with this custom vocabulary.
	//
	// This member is required.
	BotId *string

	// The identifier of the version of the bot associated with this custom vocabulary.
	//
	// This member is required.
	BotVersion *string

	// A list of new custom vocabulary items. Each entry must contain a phrase and can
	// optionally contain a displayAs and/or a weight.
	//
	// This member is required.
	CustomVocabularyItemList []types.NewCustomVocabularyItem

	// The identifier of the language and locale where this custom vocabulary is used.
	// The string must match one of the supported locales. For more information, see
	// Supported Languages  (https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html)
	// .
	//
	// This member is required.
	LocaleId *string
	// contains filtered or unexported fields
}

type BatchCreateCustomVocabularyItemOutput added in v1.26.0 

type BatchCreateCustomVocabularyItemOutput struct {

	// The identifier of the bot associated with this custom vocabulary.
	BotId *string

	// The identifier of the version of the bot associated with this custom vocabulary.
	BotVersion *string

	// A list of custom vocabulary items that failed to create during the operation.
	// The reason for the error is contained within each error object.
	Errors []types.FailedCustomVocabularyItem

	// The identifier of the language and locale where this custom vocabulary is used.
	// The string must match one of the supported locales. For more information, see
	// Supported Languages  (https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html)
	// .
	LocaleId *string

	// A list of custom vocabulary items that were successfully created during the
	// operation.
	Resources []types.CustomVocabularyItem

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type BatchDeleteCustomVocabularyItemInput added in v1.26.0 

type BatchDeleteCustomVocabularyItemInput struct {

	// The identifier of the bot associated with this custom vocabulary.
	//
	// This member is required.
	BotId *string

	// The identifier of the version of the bot associated with this custom vocabulary.
	//
	// This member is required.
	BotVersion *string

	// A list of custom vocabulary items requested to be deleted. Each entry must
	// contain the unique custom vocabulary entry identifier.
	//
	// This member is required.
	CustomVocabularyItemList []types.CustomVocabularyEntryId

	// The identifier of the language and locale where this custom vocabulary is used.
	// The string must match one of the supported locales. For more information, see
	// Supported Languages  (https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html)
	// .
	//
	// This member is required.
	LocaleId *string
	// contains filtered or unexported fields
}

type BatchDeleteCustomVocabularyItemOutput added in v1.26.0 

type BatchDeleteCustomVocabularyItemOutput struct {

	// The identifier of the bot associated with this custom vocabulary.
	BotId *string

	// The identifier of the version of the bot associated with this custom vocabulary.
	BotVersion *string

	// A list of custom vocabulary items that failed to delete during the operation.
	// The reason for the error is contained within each error object.
	Errors []types.FailedCustomVocabularyItem

	// The identifier of the language and locale where this custom vocabulary is used.
	// The string must match one of the supported locales. For more information, see
	// Supported languages
	// (https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html).
	LocaleId *string

	// A list of custom vocabulary items that were successfully deleted during the
	// operation.
	Resources []types.CustomVocabularyItem

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type BatchUpdateCustomVocabularyItemInput added in v1.26.0 

type BatchUpdateCustomVocabularyItemInput struct {

	// The identifier of the bot associated with this custom vocabulary
	//
	// This member is required.
	BotId *string

	// The identifier of the version of the bot associated with this custom vocabulary.
	//
	// This member is required.
	BotVersion *string

	// A list of custom vocabulary items with updated fields. Each entry must contain
	// a phrase and can optionally contain a displayAs and/or a weight.
	//
	// This member is required.
	CustomVocabularyItemList []types.CustomVocabularyItem

	// The identifier of the language and locale where this custom vocabulary is used.
	// The string must match one of the supported locales. For more information, see
	// Supported Languages  (https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html)
	// .
	//
	// This member is required.
	LocaleId *string
	// contains filtered or unexported fields
}

type BatchUpdateCustomVocabularyItemOutput added in v1.26.0 

type BatchUpdateCustomVocabularyItemOutput struct {

	// The identifier of the bot associated with this custom vocabulary.
	BotId *string

	// The identifier of the version of the bot associated with this custom vocabulary.
	BotVersion *string

	// A list of custom vocabulary items that failed to update during the operation.
	// The reason for the error is contained within each error object.
	Errors []types.FailedCustomVocabularyItem

	// The identifier of the language and locale where this custom vocabulary is used.
	// The string must match one of the supported locales. For more information, see
	// Supported Languages  (https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html)
	// .
	LocaleId *string

	// A list of custom vocabulary items that were successfully updated during the
	// operation.
	Resources []types.CustomVocabularyItem

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type BotAliasAvailableWaiter added in v1.5.0 

type BotAliasAvailableWaiter struct {
	// contains filtered or unexported fields
}

BotAliasAvailableWaiter defines the waiters for BotAliasAvailable

func NewBotAliasAvailableWaiter added in v1.5.0 

func NewBotAliasAvailableWaiter(client DescribeBotAliasAPIClient, optFns ...func(*BotAliasAvailableWaiterOptions)) *BotAliasAvailableWaiter

NewBotAliasAvailableWaiter constructs a BotAliasAvailableWaiter.

func (*BotAliasAvailableWaiter) Wait added in v1.5.0 

func (w *BotAliasAvailableWaiter) Wait(ctx context.Context, params *DescribeBotAliasInput, maxWaitDur time.Duration, optFns ...func(*BotAliasAvailableWaiterOptions)) error

Wait calls the waiter function for BotAliasAvailable waiter. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.

func (*BotAliasAvailableWaiter) WaitForOutput added in v1.12.0 

func (w *BotAliasAvailableWaiter) WaitForOutput(ctx context.Context, params *DescribeBotAliasInput, maxWaitDur time.Duration, optFns ...func(*BotAliasAvailableWaiterOptions)) (*DescribeBotAliasOutput, error)

WaitForOutput calls the waiter function for BotAliasAvailable waiter and returns the output of the successful operation. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.

type BotAliasAvailableWaiterOptions added in v1.5.0 

type BotAliasAvailableWaiterOptions struct {

	// Set of options to modify how an operation is invoked. These apply to all
	// operations invoked for this client. Use functional options on operation call to
	// modify this list for per operation behavior.
	//
	// Passing options here is functionally equivalent to passing values to this
	// config's ClientOptions field that extend the inner client's APIOptions directly.
	APIOptions []func(*middleware.Stack) error

	// Functional options to be passed to all operations invoked by this client.
	//
	// Function values that modify the inner APIOptions are applied after the waiter
	// config's own APIOptions modifiers.
	ClientOptions []func(*Options)

	// MinDelay is the minimum amount of time to delay between retries. If unset,
	// BotAliasAvailableWaiter will use default minimum delay of 10 seconds. Note that
	// MinDelay must resolve to a value lesser than or equal to the MaxDelay.
	MinDelay time.Duration

	// MaxDelay is the maximum amount of time to delay between retries. If unset or
	// set to zero, BotAliasAvailableWaiter will use default max delay of 120 seconds.
	// Note that MaxDelay must resolve to value greater than or equal to the MinDelay.
	MaxDelay time.Duration

	// LogWaitAttempts is used to enable logging for waiter retry attempts
	LogWaitAttempts bool

	// Retryable is function that can be used to override the service defined
	// waiter-behavior based on operation output, or returned error. This function is
	// used by the waiter to decide if a state is retryable or a terminal state. By
	// default service-modeled logic will populate this option. This option can thus be
	// used to define a custom waiter state with fall-back to service-modeled waiter
	// state mutators.The function returns an error in case of a failure state. In case
	// of retry state, this function returns a bool value of true and nil error, while
	// in case of success it returns a bool value of false and nil error.
	Retryable func(context.Context, *DescribeBotAliasInput, *DescribeBotAliasOutput, error) (bool, error)
}

BotAliasAvailableWaiterOptions are waiter options for BotAliasAvailableWaiter

type BotAvailableWaiter added in v1.5.0 

type BotAvailableWaiter struct {
	// contains filtered or unexported fields
}

BotAvailableWaiter defines the waiters for BotAvailable

func NewBotAvailableWaiter added in v1.5.0 

func NewBotAvailableWaiter(client DescribeBotAPIClient, optFns ...func(*BotAvailableWaiterOptions)) *BotAvailableWaiter

NewBotAvailableWaiter constructs a BotAvailableWaiter.

func (*BotAvailableWaiter) Wait added in v1.5.0 

func (w *BotAvailableWaiter) Wait(ctx context.Context, params *DescribeBotInput, maxWaitDur time.Duration, optFns ...func(*BotAvailableWaiterOptions)) error

Wait calls the waiter function for BotAvailable waiter. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.

func (*BotAvailableWaiter) WaitForOutput added in v1.12.0 

func (w *BotAvailableWaiter) WaitForOutput(ctx context.Context, params *DescribeBotInput, maxWaitDur time.Duration, optFns ...func(*BotAvailableWaiterOptions)) (*DescribeBotOutput, error)

WaitForOutput calls the waiter function for BotAvailable waiter and returns the output of the successful operation. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.

type BotAvailableWaiterOptions added in v1.5.0 

type BotAvailableWaiterOptions struct {

	// Set of options to modify how an operation is invoked. These apply to all
	// operations invoked for this client. Use functional options on operation call to
	// modify this list for per operation behavior.
	//
	// Passing options here is functionally equivalent to passing values to this
	// config's ClientOptions field that extend the inner client's APIOptions directly.
	APIOptions []func(*middleware.Stack) error

	// Functional options to be passed to all operations invoked by this client.
	//
	// Function values that modify the inner APIOptions are applied after the waiter
	// config's own APIOptions modifiers.
	ClientOptions []func(*Options)

	// MinDelay is the minimum amount of time to delay between retries. If unset,
	// BotAvailableWaiter will use default minimum delay of 10 seconds. Note that
	// MinDelay must resolve to a value lesser than or equal to the MaxDelay.
	MinDelay time.Duration

	// MaxDelay is the maximum amount of time to delay between retries. If unset or
	// set to zero, BotAvailableWaiter will use default max delay of 120 seconds. Note
	// that MaxDelay must resolve to value greater than or equal to the MinDelay.
	MaxDelay time.Duration

	// LogWaitAttempts is used to enable logging for waiter retry attempts
	LogWaitAttempts bool

	// Retryable is function that can be used to override the service defined
	// waiter-behavior based on operation output, or returned error. This function is
	// used by the waiter to decide if a state is retryable or a terminal state. By
	// default service-modeled logic will populate this option. This option can thus be
	// used to define a custom waiter state with fall-back to service-modeled waiter
	// state mutators.The function returns an error in case of a failure state. In case
	// of retry state, this function returns a bool value of true and nil error, while
	// in case of success it returns a bool value of false and nil error.
	Retryable func(context.Context, *DescribeBotInput, *DescribeBotOutput, error) (bool, error)
}

BotAvailableWaiterOptions are waiter options for BotAvailableWaiter

type BotExportCompletedWaiter added in v1.5.0 

type BotExportCompletedWaiter struct {
	// contains filtered or unexported fields
}

BotExportCompletedWaiter defines the waiters for BotExportCompleted

func NewBotExportCompletedWaiter added in v1.5.0 

func NewBotExportCompletedWaiter(client DescribeExportAPIClient, optFns ...func(*BotExportCompletedWaiterOptions)) *BotExportCompletedWaiter

NewBotExportCompletedWaiter constructs a BotExportCompletedWaiter.

func (*BotExportCompletedWaiter) Wait added in v1.5.0 

func (w *BotExportCompletedWaiter) Wait(ctx context.Context, params *DescribeExportInput, maxWaitDur time.Duration, optFns ...func(*BotExportCompletedWaiterOptions)) error

Wait calls the waiter function for BotExportCompleted waiter. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.

func (*BotExportCompletedWaiter) WaitForOutput added in v1.12.0 

func (w *BotExportCompletedWaiter) WaitForOutput(ctx context.Context, params *DescribeExportInput, maxWaitDur time.Duration, optFns ...func(*BotExportCompletedWaiterOptions)) (*DescribeExportOutput, error)

WaitForOutput calls the waiter function for BotExportCompleted waiter and returns the output of the successful operation. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.

type BotExportCompletedWaiterOptions added in v1.5.0 

type BotExportCompletedWaiterOptions struct {

	// Set of options to modify how an operation is invoked. These apply to all
	// operations invoked for this client. Use functional options on operation call to
	// modify this list for per operation behavior.
	//
	// Passing options here is functionally equivalent to passing values to this
	// config's ClientOptions field that extend the inner client's APIOptions directly.
	APIOptions []func(*middleware.Stack) error

	// Functional options to be passed to all operations invoked by this client.
	//
	// Function values that modify the inner APIOptions are applied after the waiter
	// config's own APIOptions modifiers.
	ClientOptions []func(*Options)

	// MinDelay is the minimum amount of time to delay between retries. If unset,
	// BotExportCompletedWaiter will use default minimum delay of 10 seconds. Note that
	// MinDelay must resolve to a value lesser than or equal to the MaxDelay.
	MinDelay time.Duration

	// MaxDelay is the maximum amount of time to delay between retries. If unset or
	// set to zero, BotExportCompletedWaiter will use default max delay of 120 seconds.
	// Note that MaxDelay must resolve to value greater than or equal to the MinDelay.
	MaxDelay time.Duration

	// LogWaitAttempts is used to enable logging for waiter retry attempts
	LogWaitAttempts bool

	// Retryable is function that can be used to override the service defined
	// waiter-behavior based on operation output, or returned error. This function is
	// used by the waiter to decide if a state is retryable or a terminal state. By
	// default service-modeled logic will populate this option. This option can thus be
	// used to define a custom waiter state with fall-back to service-modeled waiter
	// state mutators.The function returns an error in case of a failure state. In case
	// of retry state, this function returns a bool value of true and nil error, while
	// in case of success it returns a bool value of false and nil error.
	Retryable func(context.Context, *DescribeExportInput, *DescribeExportOutput, error) (bool, error)
}

BotExportCompletedWaiterOptions are waiter options for BotExportCompletedWaiter

type BotImportCompletedWaiter added in v1.5.0 

type BotImportCompletedWaiter struct {
	// contains filtered or unexported fields
}

BotImportCompletedWaiter defines the waiters for BotImportCompleted

func NewBotImportCompletedWaiter added in v1.5.0 

func NewBotImportCompletedWaiter(client DescribeImportAPIClient, optFns ...func(*BotImportCompletedWaiterOptions)) *BotImportCompletedWaiter

NewBotImportCompletedWaiter constructs a BotImportCompletedWaiter.

func (*BotImportCompletedWaiter) Wait added in v1.5.0 

func (w *BotImportCompletedWaiter) Wait(ctx context.Context, params *DescribeImportInput, maxWaitDur time.Duration, optFns ...func(*BotImportCompletedWaiterOptions)) error

Wait calls the waiter function for BotImportCompleted waiter. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.

func (*BotImportCompletedWaiter) WaitForOutput added in v1.12.0 

func (w *BotImportCompletedWaiter) WaitForOutput(ctx context.Context, params *DescribeImportInput, maxWaitDur time.Duration, optFns ...func(*BotImportCompletedWaiterOptions)) (*DescribeImportOutput, error)

WaitForOutput calls the waiter function for BotImportCompleted waiter and returns the output of the successful operation. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.

type BotImportCompletedWaiterOptions added in v1.5.0 

type BotImportCompletedWaiterOptions struct {

	// Set of options to modify how an operation is invoked. These apply to all
	// operations invoked for this client. Use functional options on operation call to
	// modify this list for per operation behavior.
	//
	// Passing options here is functionally equivalent to passing values to this
	// config's ClientOptions field that extend the inner client's APIOptions directly.
	APIOptions []func(*middleware.Stack) error

	// Functional options to be passed to all operations invoked by this client.
	//
	// Function values that modify the inner APIOptions are applied after the waiter
	// config's own APIOptions modifiers.
	ClientOptions []func(*Options)

	// MinDelay is the minimum amount of time to delay between retries. If unset,
	// BotImportCompletedWaiter will use default minimum delay of 10 seconds. Note that
	// MinDelay must resolve to a value lesser than or equal to the MaxDelay.
	MinDelay time.Duration

	// MaxDelay is the maximum amount of time to delay between retries. If unset or
	// set to zero, BotImportCompletedWaiter will use default max delay of 120 seconds.
	// Note that MaxDelay must resolve to value greater than or equal to the MinDelay.
	MaxDelay time.Duration

	// LogWaitAttempts is used to enable logging for waiter retry attempts
	LogWaitAttempts bool

	// Retryable is function that can be used to override the service defined
	// waiter-behavior based on operation output, or returned error. This function is
	// used by the waiter to decide if a state is retryable or a terminal state. By
	// default service-modeled logic will populate this option. This option can thus be
	// used to define a custom waiter state with fall-back to service-modeled waiter
	// state mutators.The function returns an error in case of a failure state. In case
	// of retry state, this function returns a bool value of true and nil error, while
	// in case of success it returns a bool value of false and nil error.
	Retryable func(context.Context, *DescribeImportInput, *DescribeImportOutput, error) (bool, error)
}

BotImportCompletedWaiterOptions are waiter options for BotImportCompletedWaiter

type BotLocaleBuiltWaiter added in v1.5.0 

type BotLocaleBuiltWaiter struct {
	// contains filtered or unexported fields
}

BotLocaleBuiltWaiter defines the waiters for BotLocaleBuilt

func NewBotLocaleBuiltWaiter added in v1.5.0 

func NewBotLocaleBuiltWaiter(client DescribeBotLocaleAPIClient, optFns ...func(*BotLocaleBuiltWaiterOptions)) *BotLocaleBuiltWaiter

NewBotLocaleBuiltWaiter constructs a BotLocaleBuiltWaiter.

func (*BotLocaleBuiltWaiter) Wait added in v1.5.0 

func (w *BotLocaleBuiltWaiter) Wait(ctx context.Context, params *DescribeBotLocaleInput, maxWaitDur time.Duration, optFns ...func(*BotLocaleBuiltWaiterOptions)) error

Wait calls the waiter function for BotLocaleBuilt waiter. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.

func (*BotLocaleBuiltWaiter) WaitForOutput added in v1.12.0 

func (w *BotLocaleBuiltWaiter) WaitForOutput(ctx context.Context, params *DescribeBotLocaleInput, maxWaitDur time.Duration, optFns ...func(*BotLocaleBuiltWaiterOptions)) (*DescribeBotLocaleOutput, error)

WaitForOutput calls the waiter function for BotLocaleBuilt waiter and returns the output of the successful operation. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.

type BotLocaleBuiltWaiterOptions added in v1.5.0 

type BotLocaleBuiltWaiterOptions struct {

	// Set of options to modify how an operation is invoked. These apply to all
	// operations invoked for this client. Use functional options on operation call to
	// modify this list for per operation behavior.
	//
	// Passing options here is functionally equivalent to passing values to this
	// config's ClientOptions field that extend the inner client's APIOptions directly.
	APIOptions []func(*middleware.Stack) error

	// Functional options to be passed to all operations invoked by this client.
	//
	// Function values that modify the inner APIOptions are applied after the waiter
	// config's own APIOptions modifiers.
	ClientOptions []func(*Options)

	// MinDelay is the minimum amount of time to delay between retries. If unset,
	// BotLocaleBuiltWaiter will use default minimum delay of 10 seconds. Note that
	// MinDelay must resolve to a value lesser than or equal to the MaxDelay.
	MinDelay time.Duration

	// MaxDelay is the maximum amount of time to delay between retries. If unset or
	// set to zero, BotLocaleBuiltWaiter will use default max delay of 120 seconds.
	// Note that MaxDelay must resolve to value greater than or equal to the MinDelay.
	MaxDelay time.Duration

	// LogWaitAttempts is used to enable logging for waiter retry attempts
	LogWaitAttempts bool

	// Retryable is function that can be used to override the service defined
	// waiter-behavior based on operation output, or returned error. This function is
	// used by the waiter to decide if a state is retryable or a terminal state. By
	// default service-modeled logic will populate this option. This option can thus be
	// used to define a custom waiter state with fall-back to service-modeled waiter
	// state mutators.The function returns an error in case of a failure state. In case
	// of retry state, this function returns a bool value of true and nil error, while
	// in case of success it returns a bool value of false and nil error.
	Retryable func(context.Context, *DescribeBotLocaleInput, *DescribeBotLocaleOutput, error) (bool, error)
}

BotLocaleBuiltWaiterOptions are waiter options for BotLocaleBuiltWaiter

type BotLocaleCreatedWaiter added in v1.5.0 

type BotLocaleCreatedWaiter struct {
	// contains filtered or unexported fields
}

BotLocaleCreatedWaiter defines the waiters for BotLocaleCreated

func NewBotLocaleCreatedWaiter added in v1.5.0 

func NewBotLocaleCreatedWaiter(client DescribeBotLocaleAPIClient, optFns ...func(*BotLocaleCreatedWaiterOptions)) *BotLocaleCreatedWaiter

NewBotLocaleCreatedWaiter constructs a BotLocaleCreatedWaiter.

func (*BotLocaleCreatedWaiter) Wait added in v1.5.0 

func (w *BotLocaleCreatedWaiter) Wait(ctx context.Context, params *DescribeBotLocaleInput, maxWaitDur time.Duration, optFns ...func(*BotLocaleCreatedWaiterOptions)) error

Wait calls the waiter function for BotLocaleCreated waiter. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.

func (*BotLocaleCreatedWaiter) WaitForOutput added in v1.12.0 

func (w *BotLocaleCreatedWaiter) WaitForOutput(ctx context.Context, params *DescribeBotLocaleInput, maxWaitDur time.Duration, optFns ...func(*BotLocaleCreatedWaiterOptions)) (*DescribeBotLocaleOutput, error)

WaitForOutput calls the waiter function for BotLocaleCreated waiter and returns the output of the successful operation. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.

type BotLocaleCreatedWaiterOptions added in v1.5.0 

type BotLocaleCreatedWaiterOptions struct {

	// Set of options to modify how an operation is invoked. These apply to all
	// operations invoked for this client. Use functional options on operation call to
	// modify this list for per operation behavior.
	//
	// Passing options here is functionally equivalent to passing values to this
	// config's ClientOptions field that extend the inner client's APIOptions directly.
	APIOptions []func(*middleware.Stack) error

	// Functional options to be passed to all operations invoked by this client.
	//
	// Function values that modify the inner APIOptions are applied after the waiter
	// config's own APIOptions modifiers.
	ClientOptions []func(*Options)

	// MinDelay is the minimum amount of time to delay between retries. If unset,
	// BotLocaleCreatedWaiter will use default minimum delay of 10 seconds. Note that
	// MinDelay must resolve to a value lesser than or equal to the MaxDelay.
	MinDelay time.Duration

	// MaxDelay is the maximum amount of time to delay between retries. If unset or
	// set to zero, BotLocaleCreatedWaiter will use default max delay of 120 seconds.
	// Note that MaxDelay must resolve to value greater than or equal to the MinDelay.
	MaxDelay time.Duration

	// LogWaitAttempts is used to enable logging for waiter retry attempts
	LogWaitAttempts bool

	// Retryable is function that can be used to override the service defined
	// waiter-behavior based on operation output, or returned error. This function is
	// used by the waiter to decide if a state is retryable or a terminal state. By
	// default service-modeled logic will populate this option. This option can thus be
	// used to define a custom waiter state with fall-back to service-modeled waiter
	// state mutators.The function returns an error in case of a failure state. In case
	// of retry state, this function returns a bool value of true and nil error, while
	// in case of success it returns a bool value of false and nil error.
	Retryable func(context.Context, *DescribeBotLocaleInput, *DescribeBotLocaleOutput, error) (bool, error)
}

BotLocaleCreatedWaiterOptions are waiter options for BotLocaleCreatedWaiter

type BotLocaleExpressTestingAvailableWaiter added in v1.5.0 

type BotLocaleExpressTestingAvailableWaiter struct {
	// contains filtered or unexported fields
}

BotLocaleExpressTestingAvailableWaiter defines the waiters for BotLocaleExpressTestingAvailable

func NewBotLocaleExpressTestingAvailableWaiter added in v1.5.0 

func NewBotLocaleExpressTestingAvailableWaiter(client DescribeBotLocaleAPIClient, optFns ...func(*BotLocaleExpressTestingAvailableWaiterOptions)) *BotLocaleExpressTestingAvailableWaiter

NewBotLocaleExpressTestingAvailableWaiter constructs a BotLocaleExpressTestingAvailableWaiter.

func (*BotLocaleExpressTestingAvailableWaiter) Wait added in v1.5.0 

func (w *BotLocaleExpressTestingAvailableWaiter) Wait(ctx context.Context, params *DescribeBotLocaleInput, maxWaitDur time.Duration, optFns ...func(*BotLocaleExpressTestingAvailableWaiterOptions)) error

Wait calls the waiter function for BotLocaleExpressTestingAvailable waiter. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.

func (*BotLocaleExpressTestingAvailableWaiter) WaitForOutput added in v1.12.0 

func (w *BotLocaleExpressTestingAvailableWaiter) WaitForOutput(ctx context.Context, params *DescribeBotLocaleInput, maxWaitDur time.Duration, optFns ...func(*BotLocaleExpressTestingAvailableWaiterOptions)) (*DescribeBotLocaleOutput, error)

WaitForOutput calls the waiter function for BotLocaleExpressTestingAvailable waiter and returns the output of the successful operation. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.

type BotLocaleExpressTestingAvailableWaiterOptions added in v1.5.0 

type BotLocaleExpressTestingAvailableWaiterOptions struct {

	// Set of options to modify how an operation is invoked. These apply to all
	// operations invoked for this client. Use functional options on operation call to
	// modify this list for per operation behavior.
	//
	// Passing options here is functionally equivalent to passing values to this
	// config's ClientOptions field that extend the inner client's APIOptions directly.
	APIOptions []func(*middleware.Stack) error

	// Functional options to be passed to all operations invoked by this client.
	//
	// Function values that modify the inner APIOptions are applied after the waiter
	// config's own APIOptions modifiers.
	ClientOptions []func(*Options)

	// MinDelay is the minimum amount of time to delay between retries. If unset,
	// BotLocaleExpressTestingAvailableWaiter will use default minimum delay of 10
	// seconds. Note that MinDelay must resolve to a value lesser than or equal to the
	// MaxDelay.
	MinDelay time.Duration

	// MaxDelay is the maximum amount of time to delay between retries. If unset or
	// set to zero, BotLocaleExpressTestingAvailableWaiter will use default max delay
	// of 120 seconds. Note that MaxDelay must resolve to value greater than or equal
	// to the MinDelay.
	MaxDelay time.Duration

	// LogWaitAttempts is used to enable logging for waiter retry attempts
	LogWaitAttempts bool

	// Retryable is function that can be used to override the service defined
	// waiter-behavior based on operation output, or returned error. This function is
	// used by the waiter to decide if a state is retryable or a terminal state. By
	// default service-modeled logic will populate this option. This option can thus be
	// used to define a custom waiter state with fall-back to service-modeled waiter
	// state mutators.The function returns an error in case of a failure state. In case
	// of retry state, this function returns a bool value of true and nil error, while
	// in case of success it returns a bool value of false and nil error.
	Retryable func(context.Context, *DescribeBotLocaleInput, *DescribeBotLocaleOutput, error) (bool, error)
}

BotLocaleExpressTestingAvailableWaiterOptions are waiter options for BotLocaleExpressTestingAvailableWaiter

type BotVersionAvailableWaiter added in v1.5.0 

type BotVersionAvailableWaiter struct {
	// contains filtered or unexported fields
}

BotVersionAvailableWaiter defines the waiters for BotVersionAvailable

func NewBotVersionAvailableWaiter added in v1.5.0 

func NewBotVersionAvailableWaiter(client DescribeBotVersionAPIClient, optFns ...func(*BotVersionAvailableWaiterOptions)) *BotVersionAvailableWaiter

NewBotVersionAvailableWaiter constructs a BotVersionAvailableWaiter.

func (*BotVersionAvailableWaiter) Wait added in v1.5.0 

func (w *BotVersionAvailableWaiter) Wait(ctx context.Context, params *DescribeBotVersionInput, maxWaitDur time.Duration, optFns ...func(*BotVersionAvailableWaiterOptions)) error

Wait calls the waiter function for BotVersionAvailable waiter. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.

func (*BotVersionAvailableWaiter) WaitForOutput added in v1.12.0 

func (w *BotVersionAvailableWaiter) WaitForOutput(ctx context.Context, params *DescribeBotVersionInput, maxWaitDur time.Duration, optFns ...func(*BotVersionAvailableWaiterOptions)) (*DescribeBotVersionOutput, error)

WaitForOutput calls the waiter function for BotVersionAvailable waiter and returns the output of the successful operation. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.

type BotVersionAvailableWaiterOptions added in v1.5.0 

type BotVersionAvailableWaiterOptions struct {

	// Set of options to modify how an operation is invoked. These apply to all
	// operations invoked for this client. Use functional options on operation call to
	// modify this list for per operation behavior.
	//
	// Passing options here is functionally equivalent to passing values to this
	// config's ClientOptions field that extend the inner client's APIOptions directly.
	APIOptions []func(*middleware.Stack) error

	// Functional options to be passed to all operations invoked by this client.
	//
	// Function values that modify the inner APIOptions are applied after the waiter
	// config's own APIOptions modifiers.
	ClientOptions []func(*Options)

	// MinDelay is the minimum amount of time to delay between retries. If unset,
	// BotVersionAvailableWaiter will use default minimum delay of 10 seconds. Note
	// that MinDelay must resolve to a value lesser than or equal to the MaxDelay.
	MinDelay time.Duration

	// MaxDelay is the maximum amount of time to delay between retries. If unset or
	// set to zero, BotVersionAvailableWaiter will use default max delay of 120
	// seconds. Note that MaxDelay must resolve to value greater than or equal to the
	// MinDelay.
	MaxDelay time.Duration

	// LogWaitAttempts is used to enable logging for waiter retry attempts
	LogWaitAttempts bool

	// Retryable is function that can be used to override the service defined
	// waiter-behavior based on operation output, or returned error. This function is
	// used by the waiter to decide if a state is retryable or a terminal state. By
	// default service-modeled logic will populate this option. This option can thus be
	// used to define a custom waiter state with fall-back to service-modeled waiter
	// state mutators.The function returns an error in case of a failure state. In case
	// of retry state, this function returns a bool value of true and nil error, while
	// in case of success it returns a bool value of false and nil error.
	Retryable func(context.Context, *DescribeBotVersionInput, *DescribeBotVersionOutput, error) (bool, error)
}

BotVersionAvailableWaiterOptions are waiter options for BotVersionAvailableWaiter

type BuildBotLocaleInput 

type BuildBotLocaleInput struct {

	// The identifier of the bot to build. The identifier is returned in the response
	// from the CreateBot (https://docs.aws.amazon.com/lexv2/latest/APIReference/API_CreateBot.html)
	// operation.
	//
	// This member is required.
	BotId *string

	// The version of the bot to build. This can only be the draft version of the bot.
	//
	// This member is required.
	BotVersion *string

	// The identifier of the language and locale that the bot will be used in. The
	// string must match one of the supported locales. All of the intents, slot types,
	// and slots used in the bot must have the same locale. For more information, see
	// Supported languages (https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html)
	// .
	//
	// This member is required.
	LocaleId *string
	// contains filtered or unexported fields
}

type BuildBotLocaleOutput 

type BuildBotLocaleOutput struct {

	// The identifier of the specified bot.
	BotId *string

	// The bot's build status. When the status is ReadyExpressTesting you can test the
	// bot using the utterances defined for the intents and slot types. When the status
	// is Built , the bot is ready for use and can be tested using any utterance.
	BotLocaleStatus types.BotLocaleStatus

	// The version of the bot that was built. This is only the draft version of the
	// bot.
	BotVersion *string

	// A timestamp indicating the date and time that the bot was last built for this
	// locale.
	LastBuildSubmittedDateTime *time.Time

	// The language and locale specified of where the bot can be used.
	LocaleId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type Client 

type Client struct {
	// contains filtered or unexported fields
}

Client provides the API client to make operations call for Amazon Lex Model Building V2.

func New 

func New(options Options, optFns ...func(*Options)) *Client

New returns an initialized Client based on the functional options. Provide additional functional options to further configure the behavior of the client, such as changing the client's endpoint or adding custom middleware behavior.

func NewFromConfig 

func NewFromConfig(cfg aws.Config, optFns ...func(*Options)) *Client

NewFromConfig returns a new client from the provided config.

func (*Client) BatchCreateCustomVocabularyItem added in v1.26.0 

func (c *Client) BatchCreateCustomVocabularyItem(ctx context.Context, params *BatchCreateCustomVocabularyItemInput, optFns ...func(*Options)) (*BatchCreateCustomVocabularyItemOutput, error)

Create a batch of custom vocabulary items for a given bot locale's custom vocabulary.

func (*Client) BatchDeleteCustomVocabularyItem added in v1.26.0 

func (c *Client) BatchDeleteCustomVocabularyItem(ctx context.Context, params *BatchDeleteCustomVocabularyItemInput, optFns ...func(*Options)) (*BatchDeleteCustomVocabularyItemOutput, error)

Delete a batch of custom vocabulary items for a given bot locale's custom vocabulary.

func (*Client) BatchUpdateCustomVocabularyItem added in v1.26.0 

func (c *Client) BatchUpdateCustomVocabularyItem(ctx context.Context, params *BatchUpdateCustomVocabularyItemInput, optFns ...func(*Options)) (*BatchUpdateCustomVocabularyItemOutput, error)

Update a batch of custom vocabulary items for a given bot locale's custom vocabulary.

func (*Client) BuildBotLocale 

func (c *Client) BuildBotLocale(ctx context.Context, params *BuildBotLocaleInput, optFns ...func(*Options)) (*BuildBotLocaleOutput, error)

Builds a bot, its intents, and its slot types into a specific locale. A bot can be built into multiple locales. At runtime the locale is used to choose a specific build of the bot.

func (*Client) CreateBot 

func (c *Client) CreateBot(ctx context.Context, params *CreateBotInput, optFns ...func(*Options)) (*CreateBotOutput, error)

Creates an Amazon Lex conversational bot.

func (*Client) CreateBotAlias 

func (c *Client) CreateBotAlias(ctx context.Context, params *CreateBotAliasInput, optFns ...func(*Options)) (*CreateBotAliasOutput, error)

Creates an alias for the specified version of a bot. Use an alias to enable you to change the version of a bot without updating applications that use the bot. For example, you can create an alias called "PROD" that your applications use to call the Amazon Lex bot.

func (*Client) CreateBotLocale 

func (c *Client) CreateBotLocale(ctx context.Context, params *CreateBotLocaleInput, optFns ...func(*Options)) (*CreateBotLocaleOutput, error)

Creates a locale in the bot. The locale contains the intents and slot types that the bot uses in conversations with users in the specified language and locale. You must add a locale to a bot before you can add intents and slot types to the bot.

func (*Client) CreateBotReplica added in v1.39.0 

func (c *Client) CreateBotReplica(ctx context.Context, params *CreateBotReplicaInput, optFns ...func(*Options)) (*CreateBotReplicaOutput, error)

Action to create a replication of the source bot in the secondary region.

func (*Client) CreateBotVersion 

func (c *Client) CreateBotVersion(ctx context.Context, params *CreateBotVersionInput, optFns ...func(*Options)) (*CreateBotVersionOutput, error)

Creates an immutable version of the bot. When you create the first version of a bot, Amazon Lex sets the version number to 1. Subsequent bot versions increase in an increment of 1. The version number will always represent the total number of versions created of the bot, not the current number of versions. If a bot version is deleted, that bot version number will not be reused.

func (*Client) CreateExport added in v1.2.0 

func (c *Client) CreateExport(ctx context.Context, params *CreateExportInput, optFns ...func(*Options)) (*CreateExportOutput, error)

Creates a zip archive containing the contents of a bot or a bot locale. The archive contains a directory structure that contains JSON files that define the bot. You can create an archive that contains the complete definition of a bot, or you can specify that the archive contain only the definition of a single bot locale. For more information about exporting bots, and about the structure of the export archive, see Importing and exporting bots (https://docs.aws.amazon.com/lexv2/latest/dg/importing-exporting.html)

func (*Client) CreateIntent 

func (c *Client) CreateIntent(ctx context.Context, params *CreateIntentInput, optFns ...func(*Options)) (*CreateIntentOutput, error)

Creates an intent. To define the interaction between the user and your bot, you define one or more intents. For example, for a pizza ordering bot you would create an OrderPizza intent. When you create an intent, you must provide a name. You can optionally provide the following:

  • Sample utterances. For example, "I want to order a pizza" and "Can I order a pizza." You can't provide utterances for built-in intents.
  • Information to be gathered. You specify slots for the information that you bot requests from the user. You can specify standard slot types, such as date and time, or custom slot types for your application.
  • How the intent is fulfilled. You can provide a Lambda function or configure the intent to return the intent information to your client application. If you use a Lambda function, Amazon Lex invokes the function when all of the intent information is available.
  • A confirmation prompt to send to the user to confirm an intent. For example, "Shall I order your pizza?"
  • A conclusion statement to send to the user after the intent is fulfilled. For example, "I ordered your pizza."
  • A follow-up prompt that asks the user for additional activity. For example, "Do you want a drink with your pizza?"

func (*Client) CreateResourcePolicy added in v1.2.0 

func (c *Client) CreateResourcePolicy(ctx context.Context, params *CreateResourcePolicyInput, optFns ...func(*Options)) (*CreateResourcePolicyOutput, error)

Creates a new resource policy with the specified policy statements.

func (*Client) CreateResourcePolicyStatement added in v1.2.0 

func (c *Client) CreateResourcePolicyStatement(ctx context.Context, params *CreateResourcePolicyStatementInput, optFns ...func(*Options)) (*CreateResourcePolicyStatementOutput, error)

Adds a new resource policy statement to a bot or bot alias. If a resource policy exists, the statement is added to the current resource policy. If a policy doesn't exist, a new policy is created. You can't create a resource policy statement that allows cross-account access.

func (*Client) CreateSlot 

func (c *Client) CreateSlot(ctx context.Context, params *CreateSlotInput, optFns ...func(*Options)) (*CreateSlotOutput, error)

Creates a slot in an intent. A slot is a variable needed to fulfill an intent. For example, an OrderPizza intent might need slots for size, crust, and number of pizzas. For each slot, you define one or more utterances that Amazon Lex uses to elicit a response from the user.

func (*Client) CreateSlotType 

func (c *Client) CreateSlotType(ctx context.Context, params *CreateSlotTypeInput, optFns ...func(*Options)) (*CreateSlotTypeOutput, error)

Creates a custom slot type To create a custom slot type, specify a name for the slot type and a set of enumeration values, the values that a slot of this type can assume.

func (*Client) CreateTestSetDiscrepancyReport added in v1.29.0 

func (c *Client) CreateTestSetDiscrepancyReport(ctx context.Context, params *CreateTestSetDiscrepancyReportInput, optFns ...func(*Options)) (*CreateTestSetDiscrepancyReportOutput, error)

Create a report that describes the differences between the bot and the test set.

func (*Client) CreateUploadUrl added in v1.2.0 

func (c *Client) CreateUploadUrl(ctx context.Context, params *CreateUploadUrlInput, optFns ...func(*Options)) (*CreateUploadUrlOutput, error)

Gets a pre-signed S3 write URL that you use to upload the zip archive when importing a bot or a bot locale.

func (*Client) DeleteBot 

func (c *Client) DeleteBot(ctx context.Context, params *DeleteBotInput, optFns ...func(*Options)) (*DeleteBotOutput, error)

Deletes all versions of a bot, including the Draft version. To delete a specific version, use the DeleteBotVersion operation. When you delete a bot, all of the resources contained in the bot are also deleted. Deleting a bot removes all locales, intents, slot, and slot types defined for the bot. If a bot has an alias, the DeleteBot operation returns a ResourceInUseException exception. If you want to delete the bot and the alias, set the skipResourceInUseCheck parameter to true .

func (*Client) DeleteBotAlias 

func (c *Client) DeleteBotAlias(ctx context.Context, params *DeleteBotAliasInput, optFns ...func(*Options)) (*DeleteBotAliasOutput, error)

Deletes the specified bot alias.

func (*Client) DeleteBotLocale 

func (c *Client) DeleteBotLocale(ctx context.Context, params *DeleteBotLocaleInput, optFns ...func(*Options)) (*DeleteBotLocaleOutput, error)

Removes a locale from a bot. When you delete a locale, all intents, slots, and slot types defined for the locale are also deleted.

func (*Client) DeleteBotReplica added in v1.39.0 

func (c *Client) DeleteBotReplica(ctx context.Context, params *DeleteBotReplicaInput, optFns ...func(*Options)) (*DeleteBotReplicaOutput, error)

The action to delete the replicated bot in the secondary region.

func (*Client) DeleteBotVersion 

func (c *Client) DeleteBotVersion(ctx context.Context, params *DeleteBotVersionInput, optFns ...func(*Options)) (*DeleteBotVersionOutput, error)

Deletes a specific version of a bot. To delete all versions of a bot, use the DeleteBot (https://docs.aws.amazon.com/lexv2/latest/APIReference/API_DeleteBot.html) operation.

func (*Client) DeleteCustomVocabulary added in v1.17.0 

func (c *Client) DeleteCustomVocabulary(ctx context.Context, params *DeleteCustomVocabularyInput, optFns ...func(*Options)) (*DeleteCustomVocabularyOutput, error)

Removes a custom vocabulary from the specified locale in the specified bot.

func (*Client) DeleteExport added in v1.2.0 

func (c *Client) DeleteExport(ctx context.Context, params *DeleteExportInput, optFns ...func(*Options)) (*DeleteExportOutput, error)

Removes a previous export and the associated files stored in an S3 bucket.

func (*Client) DeleteImport added in v1.2.0 

func (c *Client) DeleteImport(ctx context.Context, params *DeleteImportInput, optFns ...func(*Options)) (*DeleteImportOutput, error)

Removes a previous import and the associated file stored in an S3 bucket.

func (*Client) DeleteIntent 

func (c *Client) DeleteIntent(ctx context.Context, params *DeleteIntentInput, optFns ...func(*Options)) (*DeleteIntentOutput, error)

Removes the specified intent. Deleting an intent also deletes the slots associated with the intent.

func (*Client) DeleteResourcePolicy added in v1.2.0 

func (c *Client) DeleteResourcePolicy(ctx context.Context, params *DeleteResourcePolicyInput, optFns ...func(*Options)) (*DeleteResourcePolicyOutput, error)

Removes an existing policy from a bot or bot alias. If the resource doesn't have a policy attached, Amazon Lex returns an exception.

func (*Client) DeleteResourcePolicyStatement added in v1.2.0 

func (c *Client) DeleteResourcePolicyStatement(ctx context.Context, params *DeleteResourcePolicyStatementInput, optFns ...func(*Options)) (*DeleteResourcePolicyStatementOutput, error)

Deletes a policy statement from a resource policy. If you delete the last statement from a policy, the policy is deleted. If you specify a statement ID that doesn't exist in the policy, or if the bot or bot alias doesn't have a policy attached, Amazon Lex returns an exception.

func (*Client) DeleteSlot 

func (c *Client) DeleteSlot(ctx context.Context, params *DeleteSlotInput, optFns ...func(*Options)) (*DeleteSlotOutput, error)

Deletes the specified slot from an intent.

func (*Client) DeleteSlotType 

func (c *Client) DeleteSlotType(ctx context.Context, params *DeleteSlotTypeInput, optFns ...func(*Options)) (*DeleteSlotTypeOutput, error)

Deletes a slot type from a bot locale. If a slot is using the slot type, Amazon Lex throws a ResourceInUseException exception. To avoid the exception, set the skipResourceInUseCheck parameter to true .

func (*Client) DeleteTestSet added in v1.29.0 

func (c *Client) DeleteTestSet(ctx context.Context, params *DeleteTestSetInput, optFns ...func(*Options)) (*DeleteTestSetOutput, error)

The action to delete the selected test set.

func (*Client) DeleteUtterances added in v1.8.0 

func (c *Client) DeleteUtterances(ctx context.Context, params *DeleteUtterancesInput, optFns ...func(*Options)) (*DeleteUtterancesOutput, error)

Deletes stored utterances. Amazon Lex stores the utterances that users send to your bot. Utterances are stored for 15 days for use with the ListAggregatedUtterances (https://docs.aws.amazon.com/lexv2/latest/APIReference/API_ListAggregatedUtterances.html) operation, and then stored indefinitely for use in improving the ability of your bot to respond to user input.. Use the DeleteUtterances operation to manually delete utterances for a specific session. When you use the DeleteUtterances operation, utterances stored for improving your bot's ability to respond to user input are deleted immediately. Utterances stored for use with the ListAggregatedUtterances operation are deleted after 15 days.

func (*Client) DescribeBot 

func (c *Client) DescribeBot(ctx context.Context, params *DescribeBotInput, optFns ...func(*Options)) (*DescribeBotOutput, error)

Provides metadata information about a bot.

func (*Client) DescribeBotAlias 

func (c *Client) DescribeBotAlias(ctx context.Context, params *DescribeBotAliasInput, optFns ...func(*Options)) (*DescribeBotAliasOutput, error)

Get information about a specific bot alias.

func (*Client) DescribeBotLocale 

func (c *Client) DescribeBotLocale(ctx context.Context, params *DescribeBotLocaleInput, optFns ...func(*Options)) (*DescribeBotLocaleOutput, error)

Describes the settings that a bot has for a specific locale.

func (*Client) DescribeBotRecommendation added in v1.14.0 

func (c *Client) DescribeBotRecommendation(ctx context.Context, params *DescribeBotRecommendationInput, optFns ...func(*Options)) (*DescribeBotRecommendationOutput, error)

Provides metadata information about a bot recommendation. This information will enable you to get a description on the request inputs, to download associated transcripts after processing is complete, and to download intents and slot-types generated by the bot recommendation.

func (*Client) DescribeBotReplica added in v1.39.0 

func (c *Client) DescribeBotReplica(ctx context.Context, params *DescribeBotReplicaInput, optFns ...func(*Options)) (*DescribeBotReplicaOutput, error)

Monitors the bot replication status through the UI console.

func (*Client) DescribeBotResourceGeneration added in v1.37.0 

func (c *Client) DescribeBotResourceGeneration(ctx context.Context, params *DescribeBotResourceGenerationInput, optFns ...func(*Options)) (*DescribeBotResourceGenerationOutput, error)

Returns information about a request to generate a bot through natural language description, made through the StartBotResource API. Use the generatedBotLocaleUrl to retrieve the Amazon S3 object containing the bot locale configuration. You can then modify and import this configuration.

func (*Client) DescribeBotVersion 

func (c *Client) DescribeBotVersion(ctx context.Context, params *DescribeBotVersionInput, optFns ...func(*Options)) (*DescribeBotVersionOutput, error)

Provides metadata about a version of a bot.

func (*Client) DescribeCustomVocabularyMetadata added in v1.17.0 

func (c *Client) DescribeCustomVocabularyMetadata(ctx context.Context, params *DescribeCustomVocabularyMetadataInput, optFns ...func(*Options)) (*DescribeCustomVocabularyMetadataOutput, error)

Provides metadata information about a custom vocabulary.

func (*Client) DescribeExport added in v1.2.0 

func (c *Client) DescribeExport(ctx context.Context, params *DescribeExportInput, optFns ...func(*Options)) (*DescribeExportOutput, error)

Gets information about a specific export.

func (*Client) DescribeImport added in v1.2.0 

func (c *Client) DescribeImport(ctx context.Context, params *DescribeImportInput, optFns ...func(*Options)) (*DescribeImportOutput, error)

Gets information about a specific import.

func (*Client) DescribeIntent 

func (c *Client) DescribeIntent(ctx context.Context, params *DescribeIntentInput, optFns ...func(*Options)) (*DescribeIntentOutput, error)

Returns metadata about an intent.

func (*Client) DescribeResourcePolicy added in v1.2.0 

func (c *Client) DescribeResourcePolicy(ctx context.Context, params *DescribeResourcePolicyInput, optFns ...func(*Options)) (*DescribeResourcePolicyOutput, error)

Gets the resource policy and policy revision for a bot or bot alias.

func (*Client) DescribeSlot 

func (c *Client) DescribeSlot(ctx context.Context, params *DescribeSlotInput, optFns ...func(*Options)) (*DescribeSlotOutput, error)

Gets metadata information about a slot.

func (*Client) DescribeSlotType 

func (c *Client) DescribeSlotType(ctx context.Context, params *DescribeSlotTypeInput, optFns ...func(*Options)) (*DescribeSlotTypeOutput, error)

Gets metadata information about a slot type.

func (*Client) DescribeTestExecution added in v1.29.0 

func (c *Client) DescribeTestExecution(ctx context.Context, params *DescribeTestExecutionInput, optFns ...func(*Options)) (*DescribeTestExecutionOutput, error)

Gets metadata information about the test execution.

func (*Client) DescribeTestSet added in v1.29.0 

func (c *Client) DescribeTestSet(ctx context.Context, params *DescribeTestSetInput, optFns ...func(*Options)) (*DescribeTestSetOutput, error)

Gets metadata information about the test set.

func (*Client) DescribeTestSetDiscrepancyReport added in v1.29.0 

func (c *Client) DescribeTestSetDiscrepancyReport(ctx context.Context, params *DescribeTestSetDiscrepancyReportInput, optFns ...func(*Options)) (*DescribeTestSetDiscrepancyReportOutput, error)

Gets metadata information about the test set discrepancy report.

func (*Client) DescribeTestSetGeneration added in v1.29.0 

func (c *Client) DescribeTestSetGeneration(ctx context.Context, params *DescribeTestSetGenerationInput, optFns ...func(*Options)) (*DescribeTestSetGenerationOutput, error)

Gets metadata information about the test set generation.

func (*Client) GenerateBotElement added in v1.37.0 

func (c *Client) GenerateBotElement(ctx context.Context, params *GenerateBotElementInput, optFns ...func(*Options)) (*GenerateBotElementOutput, error)

Generates sample utterances for an intent.

func (*Client) GetTestExecutionArtifactsUrl added in v1.29.0 

func (c *Client) GetTestExecutionArtifactsUrl(ctx context.Context, params *GetTestExecutionArtifactsUrlInput, optFns ...func(*Options)) (*GetTestExecutionArtifactsUrlOutput, error)

The pre-signed Amazon S3 URL to download the test execution result artifacts.

func (*Client) ListAggregatedUtterances added in v1.8.0 

func (c *Client) ListAggregatedUtterances(ctx context.Context, params *ListAggregatedUtterancesInput, optFns ...func(*Options)) (*ListAggregatedUtterancesOutput, error)

Provides a list of utterances that users have sent to the bot. Utterances are aggregated by the text of the utterance. For example, all instances where customers used the phrase "I want to order pizza" are aggregated into the same line in the response. You can see both detected utterances and missed utterances. A detected utterance is where the bot properly recognized the utterance and activated the associated intent. A missed utterance was not recognized by the bot and didn't activate an intent. Utterances can be aggregated for a bot alias or for a bot version, but not both at the same time. Utterances statistics are not generated under the following conditions:

  • The childDirected field was set to true when the bot was created.
  • You are using slot obfuscation with one or more slots.
  • You opted out of participating in improving Amazon Lex.

func (*Client) ListBotAliasReplicas added in v1.39.0 

func (c *Client) ListBotAliasReplicas(ctx context.Context, params *ListBotAliasReplicasInput, optFns ...func(*Options)) (*ListBotAliasReplicasOutput, error)

The action to list the replicated bots created from the source bot alias.

func (*Client) ListBotAliases 

func (c *Client) ListBotAliases(ctx context.Context, params *ListBotAliasesInput, optFns ...func(*Options)) (*ListBotAliasesOutput, error)

Gets a list of aliases for the specified bot.

func (*Client) ListBotLocales 

func (c *Client) ListBotLocales(ctx context.Context, params *ListBotLocalesInput, optFns ...func(*Options)) (*ListBotLocalesOutput, error)

Gets a list of locales for the specified bot.

func (*Client) ListBotRecommendations added in v1.14.0 

func (c *Client) ListBotRecommendations(ctx context.Context, params *ListBotRecommendationsInput, optFns ...func(*Options)) (*ListBotRecommendationsOutput, error)

Get a list of bot recommendations that meet the specified criteria.

func (*Client) ListBotReplicas added in v1.39.0 

func (c *Client) ListBotReplicas(ctx context.Context, params *ListBotReplicasInput, optFns ...func(*Options)) (*ListBotReplicasOutput, error)

The action to list the replicated bots.

func (*Client) ListBotResourceGenerations added in v1.37.0 

func (c *Client) ListBotResourceGenerations(ctx context.Context, params *ListBotResourceGenerationsInput, optFns ...func(*Options)) (*ListBotResourceGenerationsOutput, error)

Lists the generation requests made for a bot locale.

func (*Client) ListBotVersionReplicas added in v1.39.0 

func (c *Client) ListBotVersionReplicas(ctx context.Context, params *ListBotVersionReplicasInput, optFns ...func(*Options)) (*ListBotVersionReplicasOutput, error)

Contains information about all the versions replication statuses applicable for Global Resiliency.

func (*Client) ListBotVersions 

func (c *Client) ListBotVersions(ctx context.Context, params *ListBotVersionsInput, optFns ...func(*Options)) (*ListBotVersionsOutput, error)

Gets information about all of the versions of a bot. The ListBotVersions operation returns a summary of each version of a bot. For example, if a bot has three numbered versions, the ListBotVersions operation returns for summaries, one for each numbered version and one for the DRAFT version. The ListBotVersions operation always returns at least one version, the DRAFT version.

func (*Client) ListBots 

func (c *Client) ListBots(ctx context.Context, params *ListBotsInput, optFns ...func(*Options)) (*ListBotsOutput, error)

Gets a list of available bots.

func (*Client) ListBuiltInIntents 

func (c *Client) ListBuiltInIntents(ctx context.Context, params *ListBuiltInIntentsInput, optFns ...func(*Options)) (*ListBuiltInIntentsOutput, error)

Gets a list of built-in intents provided by Amazon Lex that you can use in your bot. To use a built-in intent as a the base for your own intent, include the built-in intent signature in the parentIntentSignature parameter when you call the CreateIntent operation. For more information, see CreateIntent (https://docs.aws.amazon.com/lexv2/latest/APIReference/API_CreateIntent.html) .

func (*Client) ListBuiltInSlotTypes 

func (c *Client) ListBuiltInSlotTypes(ctx context.Context, params *ListBuiltInSlotTypesInput, optFns ...func(*Options)) (*ListBuiltInSlotTypesOutput, error)

Gets a list of built-in slot types that meet the specified criteria.

func (*Client) ListCustomVocabularyItems added in v1.26.0 

func (c *Client) ListCustomVocabularyItems(ctx context.Context, params *ListCustomVocabularyItemsInput, optFns ...func(*Options)) (*ListCustomVocabularyItemsOutput, error)

Paginated list of custom vocabulary items for a given bot locale's custom vocabulary.

func (*Client) ListExports added in v1.2.0 

func (c *Client) ListExports(ctx context.Context, params *ListExportsInput, optFns ...func(*Options)) (*ListExportsOutput, error)

Lists the exports for a bot, bot locale, or custom vocabulary. Exports are kept in the list for 7 days.

func (*Client) ListImports added in v1.2.0 

func (c *Client) ListImports(ctx context.Context, params *ListImportsInput, optFns ...func(*Options)) (*ListImportsOutput, error)

Lists the imports for a bot, bot locale, or custom vocabulary. Imports are kept in the list for 7 days.

func (*Client) ListIntentMetrics added in v1.30.0 

func (c *Client) ListIntentMetrics(ctx context.Context, params *ListIntentMetricsInput, optFns ...func(*Options)) (*ListIntentMetricsOutput, error)

Retrieves summary metrics for the intents in your bot. The following fields are required:

  • metrics – A list of AnalyticsIntentMetric (https://docs.aws.amazon.com/lexv2/latest/APIReference/API_AnalyticsIntentMetric.html) objects. In each object, use the name field to specify the metric to calculate, the statistic field to specify whether to calculate the Sum , Average , or Max number, and the order field to specify whether to sort the results in Ascending or Descending order.
  • startDateTime and endDateTime – Define a time range for which you want to retrieve results.

Of the optional fields, you can organize the results in the following ways:

  • Use the filters field to filter the results, the groupBy field to specify categories by which to group the results, and the binBy field to specify time intervals by which to group the results.
  • Use the maxResults field to limit the number of results to return in a single response and the nextToken field to return the next batch of results if the response does not return the full set of results.

Note that an order field exists in both binBy and metrics . You can specify only one order in a given request.

func (*Client) ListIntentPaths added in v1.30.0 

func (c *Client) ListIntentPaths(ctx context.Context, params *ListIntentPathsInput, optFns ...func(*Options)) (*ListIntentPathsOutput, error)

Retrieves summary statistics for a path of intents that users take over sessions with your bot. The following fields are required:

  • startDateTime and endDateTime – Define a time range for which you want to retrieve results.
  • intentPath – Define an order of intents for which you want to retrieve metrics. Separate intents in the path with a forward slash. For example, populate the intentPath field with /BookCar/BookHotel to see details about how many times users invoked the BookCar and BookHotel intents in that order.

Use the optional filters field to filter the results.

func (*Client) ListIntentStageMetrics added in v1.30.0 

func (c *Client) ListIntentStageMetrics(ctx context.Context, params *ListIntentStageMetricsInput, optFns ...func(*Options)) (*ListIntentStageMetricsOutput, error)

Retrieves summary metrics for the stages within intents in your bot. The following fields are required:

  • metrics – A list of AnalyticsIntentStageMetric (https://docs.aws.amazon.com/lexv2/latest/APIReference/API_AnalyticsIntentStageMetric.html) objects. In each object, use the name field to specify the metric to calculate, the statistic field to specify whether to calculate the Sum , Average , or Max number, and the order field to specify whether to sort the results in Ascending or Descending order.
  • startDateTime and endDateTime – Define a time range for which you want to retrieve results.

Of the optional fields, you can organize the results in the following ways:

  • Use the filters field to filter the results, the groupBy field to specify categories by which to group the results, and the binBy field to specify time intervals by which to group the results.
  • Use the maxResults field to limit the number of results to return in a single response and the nextToken field to return the next batch of results if the response does not return the full set of results.

Note that an order field exists in both binBy and metrics . You can only specify one order in a given request.

func (*Client) ListIntents 

func (c *Client) ListIntents(ctx context.Context, params *ListIntentsInput, optFns ...func(*Options)) (*ListIntentsOutput, error)

Get a list of intents that meet the specified criteria.

func (*Client) ListRecommendedIntents added in v1.14.0 

func (c *Client) ListRecommendedIntents(ctx context.Context, params *ListRecommendedIntentsInput, optFns ...func(*Options)) (*ListRecommendedIntentsOutput, error)

Gets a list of recommended intents provided by the bot recommendation that you can use in your bot. Intents in the response are ordered by relevance.

func (*Client) ListSessionAnalyticsData added in v1.30.0 

func (c *Client) ListSessionAnalyticsData(ctx context.Context, params *ListSessionAnalyticsDataInput, optFns ...func(*Options)) (*ListSessionAnalyticsDataOutput, error)

Retrieves a list of metadata for individual user sessions with your bot. The startDateTime and endDateTime fields are required. These fields define a time range for which you want to retrieve results. Of the optional fields, you can organize the results in the following ways:

  • Use the filters field to filter the results and the sortBy field to specify the values by which to sort the results.
  • Use the maxResults field to limit the number of results to return in a single response and the nextToken field to return the next batch of results if the response does not return the full set of results.

func (*Client) ListSessionMetrics added in v1.30.0 

func (c *Client) ListSessionMetrics(ctx context.Context, params *ListSessionMetricsInput, optFns ...func(*Options)) (*ListSessionMetricsOutput, error)

Retrieves summary metrics for the user sessions with your bot. The following fields are required:

  • metrics – A list of AnalyticsSessionMetric (https://docs.aws.amazon.com/lexv2/latest/APIReference/API_AnalyticsSessionMetric.html) objects. In each object, use the name field to specify the metric to calculate, the statistic field to specify whether to calculate the Sum , Average , or Max number, and the order field to specify whether to sort the results in Ascending or Descending order.
  • startDateTime and endDateTime – Define a time range for which you want to retrieve results.

Of the optional fields, you can organize the results in the following ways:

  • Use the filters field to filter the results, the groupBy field to specify categories by which to group the results, and the binBy field to specify time intervals by which to group the results.
  • Use the maxResults field to limit the number of results to return in a single response and the nextToken field to return the next batch of results if the response does not return the full set of results.

Note that an order field exists in both binBy and metrics . Currently, you can specify it in either field, but not in both.

func (*Client) ListSlotTypes 

func (c *Client) ListSlotTypes(ctx context.Context, params *ListSlotTypesInput, optFns ...func(*Options)) (*ListSlotTypesOutput, error)

Gets a list of slot types that match the specified criteria.

func (*Client) ListSlots 

func (c *Client) ListSlots(ctx context.Context, params *ListSlotsInput, optFns ...func(*Options)) (*ListSlotsOutput, error)

Gets a list of slots that match the specified criteria.

func (*Client) ListTagsForResource 

func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, optFns ...func(*Options)) (*ListTagsForResourceOutput, error)

Gets a list of tags associated with a resource. Only bots, bot aliases, and bot channels can have tags associated with them.

func (*Client) ListTestExecutionResultItems added in v1.29.0 

func (c *Client) ListTestExecutionResultItems(ctx context.Context, params *ListTestExecutionResultItemsInput, optFns ...func(*Options)) (*ListTestExecutionResultItemsOutput, error)

Gets a list of test execution result items.

func (*Client) ListTestExecutions added in v1.29.0 

func (c *Client) ListTestExecutions(ctx context.Context, params *ListTestExecutionsInput, optFns ...func(*Options)) (*ListTestExecutionsOutput, error)

The list of test set executions.

func (*Client) ListTestSetRecords added in v1.29.0 

func (c *Client) ListTestSetRecords(ctx context.Context, params *ListTestSetRecordsInput, optFns ...func(*Options)) (*ListTestSetRecordsOutput, error)

The list of test set records.

func (*Client) ListTestSets added in v1.29.0 

func (c *Client) ListTestSets(ctx context.Context, params *ListTestSetsInput, optFns ...func(*Options)) (*ListTestSetsOutput, error)

The list of the test sets

func (*Client) ListUtteranceAnalyticsData added in v1.30.0 

func (c *Client) ListUtteranceAnalyticsData(ctx context.Context, params *ListUtteranceAnalyticsDataInput, optFns ...func(*Options)) (*ListUtteranceAnalyticsDataOutput, error)

To use this API operation, your IAM role must have permissions to perform the ListAggregatedUtterances (https://docs.aws.amazon.com/lexv2/latest/APIReference/API_ListAggregatedUtterances.html) operation, which provides access to utterance-related analytics. See Viewing utterance statistics (https://docs.aws.amazon.com/lexv2/latest/dg/monitoring-utterances.html) for the IAM policy to apply to the IAM role. Retrieves a list of metadata for individual user utterances to your bot. The following fields are required:

  • startDateTime and endDateTime – Define a time range for which you want to retrieve results.

Of the optional fields, you can organize the results in the following ways:

  • Use the filters field to filter the results and the sortBy field to specify the values by which to sort the results.
  • Use the maxResults field to limit the number of results to return in a single response and the nextToken field to return the next batch of results if the response does not return the full set of results.

func (*Client) ListUtteranceMetrics added in v1.30.0 

func (c *Client) ListUtteranceMetrics(ctx context.Context, params *ListUtteranceMetricsInput, optFns ...func(*Options)) (*ListUtteranceMetricsOutput, error)

To use this API operation, your IAM role must have permissions to perform the ListAggregatedUtterances (https://docs.aws.amazon.com/lexv2/latest/APIReference/API_ListAggregatedUtterances.html) operation, which provides access to utterance-related analytics. See Viewing utterance statistics (https://docs.aws.amazon.com/lexv2/latest/dg/monitoring-utterances.html) for the IAM policy to apply to the IAM role. Retrieves summary metrics for the utterances in your bot. The following fields are required:

  • metrics – A list of AnalyticsUtteranceMetric (https://docs.aws.amazon.com/lexv2/latest/APIReference/API_AnalyticsUtteranceMetric.html) objects. In each object, use the name field to specify the metric to calculate, the statistic field to specify whether to calculate the Sum , Average , or Max number, and the order field to specify whether to sort the results in Ascending or Descending order.
  • startDateTime and endDateTime – Define a time range for which you want to retrieve results.

Of the optional fields, you can organize the results in the following ways:

  • Use the filters field to filter the results, the groupBy field to specify categories by which to group the results, and the binBy field to specify time intervals by which to group the results.
  • Use the maxResults field to limit the number of results to return in a single response and the nextToken field to return the next batch of results if the response does not return the full set of results.

Note that an order field exists in both binBy and metrics . Currently, you can specify it in either field, but not in both.

func (*Client) Options added in v1.38.0 

func (c *Client) Options() Options

Options returns a copy of the client configuration.

Callers SHOULD NOT perform mutations on any inner structures within client config. Config overrides should instead be made on a per-operation basis through functional options.

func (*Client) SearchAssociatedTranscripts added in v1.14.0 

func (c *Client) SearchAssociatedTranscripts(ctx context.Context, params *SearchAssociatedTranscriptsInput, optFns ...func(*Options)) (*SearchAssociatedTranscriptsOutput, error)

Search for associated transcripts that meet the specified criteria.

func (*Client) StartBotRecommendation added in v1.14.0 

func (c *Client) StartBotRecommendation(ctx context.Context, params *StartBotRecommendationInput, optFns ...func(*Options)) (*StartBotRecommendationOutput, error)

Use this to provide your transcript data, and to start the bot recommendation process.

func (*Client) StartBotResourceGeneration added in v1.37.0 

func (c *Client) StartBotResourceGeneration(ctx context.Context, params *StartBotResourceGenerationInput, optFns ...func(*Options)) (*StartBotResourceGenerationOutput, error)

Starts a request for the descriptive bot builder to generate a bot locale configuration based on the prompt you provide it. After you make this call, use the DescribeBotResourceGeneration operation to check on the status of the generation and for the generatedBotLocaleUrl when the generation is complete. Use that value to retrieve the Amazon S3 object containing the bot locale configuration. You can then modify and import this configuration.

func (*Client) StartImport added in v1.2.0 

func (c *Client) StartImport(ctx context.Context, params *StartImportInput, optFns ...func(*Options)) (*StartImportOutput, error)

Starts importing a bot, bot locale, or custom vocabulary from a zip archive that you uploaded to an S3 bucket.

func (*Client) StartTestExecution added in v1.29.0 

func (c *Client) StartTestExecution(ctx context.Context, params *StartTestExecutionInput, optFns ...func(*Options)) (*StartTestExecutionOutput, error)

The action to start test set execution.

func (*Client) StartTestSetGeneration added in v1.29.0 

func (c *Client) StartTestSetGeneration(ctx context.Context, params *StartTestSetGenerationInput, optFns ...func(*Options)) (*StartTestSetGenerationOutput, error)

The action to start the generation of test set.

func (*Client) StopBotRecommendation added in v1.23.0 

func (c *Client) StopBotRecommendation(ctx context.Context, params *StopBotRecommendationInput, optFns ...func(*Options)) (*StopBotRecommendationOutput, error)

Stop an already running Bot Recommendation request.

func (*Client) TagResource 

func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error)

Adds the specified tags to the specified resource. If a tag key already exists, the existing value is replaced with the new value.

func (*Client) UntagResource 

func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error)

Removes tags from a bot, bot alias, or bot channel.

func (*Client) UpdateBot 

func (c *Client) UpdateBot(ctx context.Context, params *UpdateBotInput, optFns ...func(*Options)) (*UpdateBotOutput, error)

Updates the configuration of an existing bot.

func (*Client) UpdateBotAlias 

func (c *Client) UpdateBotAlias(ctx context.Context, params *UpdateBotAliasInput, optFns ...func(*Options)) (*UpdateBotAliasOutput, error)

Updates the configuration of an existing bot alias.

func (*Client) UpdateBotLocale 

func (c *Client) UpdateBotLocale(ctx context.Context, params *UpdateBotLocaleInput, optFns ...func(*Options)) (*UpdateBotLocaleOutput, error)

Updates the settings that a bot has for a specific locale.

func (*Client) UpdateBotRecommendation added in v1.14.0 

func (c *Client) UpdateBotRecommendation(ctx context.Context, params *UpdateBotRecommendationInput, optFns ...func(*Options)) (*UpdateBotRecommendationOutput, error)

Updates an existing bot recommendation request.

func (*Client) UpdateExport added in v1.2.0 

func (c *Client) UpdateExport(ctx context.Context, params *UpdateExportInput, optFns ...func(*Options)) (*UpdateExportOutput, error)

Updates the password used to protect an export zip archive. The password is not required. If you don't supply a password, Amazon Lex generates a zip file that is not protected by a password. This is the archive that is available at the pre-signed S3 URL provided by the DescribeExport (https://docs.aws.amazon.com/lexv2/latest/APIReference/API_DescribeExport.html) operation.

func (*Client) UpdateIntent 

func (c *Client) UpdateIntent(ctx context.Context, params *UpdateIntentInput, optFns ...func(*Options)) (*UpdateIntentOutput, error)

Updates the settings for an intent.

func (*Client) UpdateResourcePolicy added in v1.2.0 

func (c *Client) UpdateResourcePolicy(ctx context.Context, params *UpdateResourcePolicyInput, optFns ...func(*Options)) (*UpdateResourcePolicyOutput, error)

Replaces the existing resource policy for a bot or bot alias with a new one. If the policy doesn't exist, Amazon Lex returns an exception.

func (*Client) UpdateSlot 

func (c *Client) UpdateSlot(ctx context.Context, params *UpdateSlotInput, optFns ...func(*Options)) (*UpdateSlotOutput, error)

Updates the settings for a slot.

func (*Client) UpdateSlotType 

func (c *Client) UpdateSlotType(ctx context.Context, params *UpdateSlotTypeInput, optFns ...func(*Options)) (*UpdateSlotTypeOutput, error)

Updates the configuration of an existing slot type.

func (*Client) UpdateTestSet added in v1.29.0 

func (c *Client) UpdateTestSet(ctx context.Context, params *UpdateTestSetInput, optFns ...func(*Options)) (*UpdateTestSetOutput, error)

The action to update the test set.

type CreateBotAliasInput 

type CreateBotAliasInput struct {

	// The alias to create. The name must be unique for the bot.
	//
	// This member is required.
	BotAliasName *string

	// The unique identifier of the bot that the alias applies to.
	//
	// This member is required.
	BotId *string

	// Maps configuration information to a specific locale. You can use this parameter
	// to specify a specific Lambda function to run different functions in different
	// locales.
	BotAliasLocaleSettings map[string]types.BotAliasLocaleSettings

	// The version of the bot that this alias points to. You can use the UpdateBotAlias (https://docs.aws.amazon.com/lexv2/latest/APIReference/API_UpdateBotAlias.html)
	// operation to change the bot version associated with the alias.
	BotVersion *string

	// Specifies whether Amazon Lex logs text and audio for a conversation with the
	// bot. When you enable conversation logs, text logs store text input, transcripts
	// of audio input, and associated metadata in Amazon CloudWatch Logs. Audio logs
	// store audio input in Amazon S3.
	ConversationLogSettings *types.ConversationLogSettings

	// A description of the alias. Use this description to help identify the alias.
	Description *string

	// Determines whether Amazon Lex will use Amazon Comprehend to detect the
	// sentiment of user utterances.
	SentimentAnalysisSettings *types.SentimentAnalysisSettings

	// 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 UpdateBotAlias operation to update the tags on a
	// bot alias. To update tags, use the TagResource operation.
	Tags map[string]string
	// contains filtered or unexported fields
}

type CreateBotAliasOutput 

type CreateBotAliasOutput struct {

	// The unique identifier of the bot alias.
	BotAliasId *string

	// Configuration information for a specific locale.
	BotAliasLocaleSettings map[string]types.BotAliasLocaleSettings

	// The name specified for the bot alias.
	BotAliasName *string

	// The current status of the alias. The alias is first put into the Creating
	// state. When the alias is ready to be used, it is put into the Available state.
	// You can use the DescribeBotAlias operation to get the current state of an alias.
	BotAliasStatus types.BotAliasStatus

	// The unique identifier of the bot that this alias applies to.
	BotId *string

	// The version of the bot associated with this alias.
	BotVersion *string

	// The conversation log settings specified for the alias.
	ConversationLogSettings *types.ConversationLogSettings

	// A Unix timestamp indicating the date and time that the bot alias was created.
	CreationDateTime *time.Time

	// The description specified for the bot alias.
	Description *string

	// Determines whether Amazon Lex will use Amazon Comprehend to detect the
	// sentiment of user utterances.
	SentimentAnalysisSettings *types.SentimentAnalysisSettings

	// A list of tags associated with the bot alias.
	Tags map[string]string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateBotInput 

type CreateBotInput struct {

	// The name of the bot. The bot name must be unique in the account that creates
	// the bot.
	//
	// This member is required.
	BotName *string

	// Provides information on additional privacy protections Amazon Lex should use
	// with the bot's data.
	//
	// This member is required.
	DataPrivacy *types.DataPrivacy

	// The time, in seconds, that Amazon Lex should keep information about a user's
	// conversation with the bot. A user interaction 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. You can specify
	// between 60 (1 minute) and 86,400 (24 hours) seconds.
	//
	// This member is required.
	IdleSessionTTLInSeconds *int32

	// The Amazon Resource Name (ARN) of an IAM role that has permission to access the
	// bot.
	//
	// This member is required.
	RoleArn *string

	// The list of bot members in a network to be created.
	BotMembers []types.BotMember

	// A list of tags to add to the bot. You can only add tags when you create a bot.
	// You can't use the UpdateBot operation to update tags. To update tags, use the
	// TagResource operation.
	BotTags map[string]string

	// The type of a bot to create.
	BotType types.BotType

	// A description of the bot. It appears in lists to help you identify a particular
	// bot.
	Description *string

	// A list of tags to add to the test alias for a bot. You can only add tags when
	// you create a bot. You can't use the UpdateAlias operation to update tags. To
	// update tags on the test alias, use the TagResource operation.
	TestBotAliasTags map[string]string
	// contains filtered or unexported fields
}

type CreateBotLocaleInput 

type CreateBotLocaleInput struct {

	// The identifier of the bot to create the locale for.
	//
	// This member is required.
	BotId *string

	// The version of the bot to create the locale for. This can only be the draft
	// version of the bot.
	//
	// This member is required.
	BotVersion *string

	// The identifier of the language and locale that the bot will be used in. The
	// string must match one of the supported locales. All of the intents, slot types,
	// and slots used in the bot must have the same locale. For more information, see
	// Supported languages (https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html)
	// .
	//
	// This member is required.
	LocaleId *string

	// Determines the threshold where Amazon Lex will insert the AMAZON.FallbackIntent
	// , AMAZON.KendraSearchIntent , or both when returning alternative intents.
	// AMAZON.FallbackIntent and AMAZON.KendraSearchIntent are only inserted if they
	// are configured for the bot. For example, suppose a bot is configured with the
	// confidence threshold of 0.80 and the AMAZON.FallbackIntent . Amazon Lex returns
	// three alternative intents with the following confidence scores: IntentA (0.70),
	// IntentB (0.60), IntentC (0.50). The response from the RecognizeText operation
	// would be:
	//   - AMAZON.FallbackIntent
	//   - IntentA
	//   - IntentB
	//   - IntentC
	//
	// This member is required.
	NluIntentConfidenceThreshold *float64

	// A description of the bot locale. Use this to help identify the bot locale in
	// lists.
	Description *string

	// Contains specifications about the generative AI capabilities from Amazon
	// Bedrock that you can turn on for your bot.
	GenerativeAISettings *types.GenerativeAISettings

	// The Amazon Polly voice ID that Amazon Lex uses for voice interaction with the
	// user.
	VoiceSettings *types.VoiceSettings
	// contains filtered or unexported fields
}

type CreateBotLocaleOutput 

type CreateBotLocaleOutput struct {

	// The specified bot identifier.
	BotId *string

	// The status of the bot. When the status is Creating the bot locale is being
	// configured. When the status is Building Amazon Lex is building the bot for
	// testing and use. If the status of the bot is ReadyExpressTesting , you can test
	// the bot using the exact utterances specified in the bots' intents. When the bot
	// is ready for full testing or to run, the status is Built . If there was a
	// problem with building the bot, the status is Failed . If the bot was saved but
	// not built, the status is NotBuilt .
	BotLocaleStatus types.BotLocaleStatus

	// The specified bot version.
	BotVersion *string

	// A timestamp specifying the date and time that the bot locale was created.
	CreationDateTime *time.Time

	// The specified description of the bot locale.
	Description *string

	// Contains specifications about the generative AI capabilities from Amazon
	// Bedrock that you can turn on for your bot.
	GenerativeAISettings *types.GenerativeAISettings

	// The specified locale identifier.
	LocaleId *string

	// The specified locale name.
	LocaleName *string

	// The specified confidence threshold for inserting the AMAZON.FallbackIntent and
	// AMAZON.KendraSearchIntent intents.
	NluIntentConfidenceThreshold *float64

	// The Amazon Polly voice ID that Amazon Lex uses for voice interaction with the
	// user.
	VoiceSettings *types.VoiceSettings

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateBotOutput 

type CreateBotOutput struct {

	// A unique identifier for a particular bot. You use this to identify the bot when
	// you call other Amazon Lex API operations.
	BotId *string

	// The list of bots in a network that was created.
	BotMembers []types.BotMember

	// The name specified for the bot.
	BotName *string

	// Shows the current status of the bot. The bot is first in the Creating status.
	// Once the bot is read for use, it changes to the Available status. After the bot
	// is created, you can use the DRAFT version of the bot.
	BotStatus types.BotStatus

	// A list of tags associated with the bot.
	BotTags map[string]string

	// The type of a bot that was created.
	BotType types.BotType

	// A timestamp indicating the date and time that the bot was created.
	CreationDateTime *time.Time

	// The data privacy settings specified for the bot.
	DataPrivacy *types.DataPrivacy

	// The description specified for the bot.
	Description *string

	// The session idle time specified for the bot.
	IdleSessionTTLInSeconds *int32

	// The IAM role specified for the bot.
	RoleArn *string

	// A list of tags associated with the test alias for the bot.
	TestBotAliasTags map[string]string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateBotReplicaInput added in v1.39.0 

type CreateBotReplicaInput struct {

	// The request for the unique bot ID of the source bot to be replicated in the
	// secondary region.
	//
	// This member is required.
	BotId *string

	// The request for the secondary region that will be used in the replication of
	// the source bot.
	//
	// This member is required.
	ReplicaRegion *string
	// contains filtered or unexported fields
}

type CreateBotReplicaOutput added in v1.39.0 

type CreateBotReplicaOutput struct {

	// The unique bot ID of the replicated bot generated.
	BotId *string

	// The operational status of the replicated bot generated.
	BotReplicaStatus types.BotReplicaStatus

	// The creation date and time of the replicated bot generated.
	CreationDateTime *time.Time

	// The region of the replicated bot generated.
	ReplicaRegion *string

	// The source region for the source bot used for the replicated bot generated.
	SourceRegion *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateBotVersionInput 

type CreateBotVersionInput struct {

	// The identifier of the bot to create the version for.
	//
	// This member is required.
	BotId *string

	// Specifies the locales that Amazon Lex adds to this version. You can choose the
	// Draft version or any other previously published version for each locale. When
	// you specify a source version, the locale data is copied from the source version
	// to the new version.
	//
	// This member is required.
	BotVersionLocaleSpecification map[string]types.BotVersionLocaleDetails

	// A description of the version. Use the description to help identify the version
	// in lists.
	Description *string
	// contains filtered or unexported fields
}

type CreateBotVersionOutput 

type CreateBotVersionOutput struct {

	// The bot identifier specified in the request.
	BotId *string

	// When you send a request to create or update a bot, Amazon Lex sets the status
	// response element to Creating . After Amazon Lex builds the bot, it sets status
	// to Available . If Amazon Lex can't build the bot, it sets status to Failed .
	BotStatus types.BotStatus

	// The version number assigned to the version.
	BotVersion *string

	// The source versions used for each locale in the new version.
	BotVersionLocaleSpecification map[string]types.BotVersionLocaleDetails

	// A timestamp of the date and time that the version was created.
	CreationDateTime *time.Time

	// The description of the version specified in the request.
	Description *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateExportInput added in v1.2.0 

type CreateExportInput struct {

	// The file format of the bot or bot locale definition files.
	//
	// This member is required.
	FileFormat types.ImportExportFileFormat

	// Specifies the type of resource to export, either a bot or a bot locale. You can
	// only specify one type of resource to export.
	//
	// This member is required.
	ResourceSpecification *types.ExportResourceSpecification

	// An password to use to encrypt the exported archive. Using a password is
	// optional, but you should encrypt the archive to protect the data in transit
	// between Amazon Lex and your local computer.
	FilePassword *string
	// contains filtered or unexported fields
}

type CreateExportOutput added in v1.2.0 

type CreateExportOutput struct {

	// The date and time that the request to export a bot was created.
	CreationDateTime *time.Time

	// An identifier for a specific request to create an export.
	ExportId *string

	// The status of the export. When the status is Completed , you can use the
	// DescribeExport (https://docs.aws.amazon.com/lexv2/latest/APIReference/API_DescribeExport.html)
	// operation to get the pre-signed S3 URL link to your exported bot or bot locale.
	ExportStatus types.ExportStatus

	// The file format used for the bot or bot locale definition files.
	FileFormat types.ImportExportFileFormat

	// A description of the type of resource that was exported, either a bot or a bot
	// locale.
	ResourceSpecification *types.ExportResourceSpecification

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateIntentInput 

type CreateIntentInput struct {

	// The identifier of the bot associated with this intent.
	//
	// This member is required.
	BotId *string

	// The version of the bot associated with this intent.
	//
	// This member is required.
	BotVersion *string

	// The name of the intent. Intent names must be unique in the locale that contains
	// the intent and cannot match the name of any built-in intent.
	//
	// This member is required.
	IntentName *string

	// The identifier of the language and locale where this intent is used. All of the
	// bots, slot types, and slots used by the intent must have the same locale. For
	// more information, see Supported languages (https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html)
	// .
	//
	// This member is required.
	LocaleId *string

	// A description of the intent. Use the description to help identify the intent in
	// lists.
	Description *string

	// Specifies that Amazon Lex invokes the alias Lambda function for each user
	// input. You can invoke this Lambda function to personalize user interaction. For
	// example, suppose that your bot determines that the user's name is John. You
	// Lambda function might retrieve John's information from a backend database and
	// prepopulate some of the values. For example, if you find that John is gluten
	// intolerant, you might set the corresponding intent slot, glutenIntolerant to
	// true . You might find John's phone number and set the corresponding session
	// attribute.
	DialogCodeHook *types.DialogCodeHookSettings

	// Specifies that Amazon Lex invokes the alias Lambda function when the intent is
	// ready for fulfillment. You can invoke this function to complete the bot's
	// transaction with the user. For example, in a pizza ordering bot, the Lambda
	// function can look up the closest pizza restaurant to the customer's location and
	// then place an order on the customer's behalf.
	FulfillmentCodeHook *types.FulfillmentCodeHookSettings

	// Configuration settings for the response that is sent to the user at the
	// beginning of a conversation, before eliciting slot values.
	InitialResponseSetting *types.InitialResponseSetting

	// A list of contexts that must be active for this intent to be considered by
	// Amazon Lex. When an intent has an input context list, Amazon Lex only considers
	// using the intent in an interaction with the user when the specified contexts are
	// included in the active context list for the session. If the contexts are not
	// active, then Amazon Lex will not use the intent. A context can be automatically
	// activated using the outputContexts property or it can be set at runtime. For
	// example, if there are two intents with different input contexts that respond to
	// the same utterances, only the intent with the active context will respond. An
	// intent may have up to 5 input contexts. If an intent has multiple input
	// contexts, all of the contexts must be active to consider the intent.
	InputContexts []types.InputContext

	// Sets the response that Amazon Lex sends to the user when the intent is closed.
	IntentClosingSetting *types.IntentClosingSetting

	// Provides prompts that Amazon Lex sends to the user to confirm the completion of
	// an intent. If the user answers "no," the settings contain a statement that is
	// sent to the user to end the intent.
	IntentConfirmationSetting *types.IntentConfirmationSetting

	// Configuration information required to use the AMAZON.KendraSearchIntent intent
	// to connect to an Amazon Kendra index. The AMAZON.KendraSearchIntent intent is
	// called when Amazon Lex can't determine another intent to invoke.
	KendraConfiguration *types.KendraConfiguration

	// A lists of contexts that the intent activates when it is fulfilled. You can use
	// an output context to indicate the intents that Amazon Lex should consider for
	// the next turn of the conversation with a customer. When you use the
	// outputContextsList property, all of the contexts specified in the list are
	// activated when the intent is fulfilled. You can set up to 10 output contexts.
	// You can also set the number of conversation turns that the context should be
	// active, or the length of time that the context should be active.
	OutputContexts []types.OutputContext

	// A unique identifier for the built-in intent to base this intent on.
	ParentIntentSignature *string

	// Specifies the configuration of the built-in Amazon.QnAIntent . The
	// AMAZON.QnAIntent intent is called when Amazon Lex can't determine another intent
	// to invoke. If you specify this field, you can't specify the kendraConfiguration
	// field.
	QnAIntentConfiguration *types.QnAIntentConfiguration

	// An array of strings that a user might say to signal the intent. For example, "I
	// want a pizza", or "I want a {PizzaSize} pizza". In an utterance, slot names are
	// enclosed in curly braces ("{", "}") to indicate where they should be displayed
	// in the utterance shown to the user..
	SampleUtterances []types.SampleUtterance
	// contains filtered or unexported fields
}

type CreateIntentOutput 

type CreateIntentOutput struct {

	// The identifier of the bot associated with the intent.
	BotId *string

	// The version of the bot associated with the intent.
	BotVersion *string

	// A timestamp of the date and time that the intent was created.
	CreationDateTime *time.Time

	// The description specified for the intent.
	Description *string

	// The dialog Lambda function specified for the intent.
	DialogCodeHook *types.DialogCodeHookSettings

	// The fulfillment Lambda function specified for the intent.
	FulfillmentCodeHook *types.FulfillmentCodeHookSettings

	// Configuration settings for the response that is sent to the user at the
	// beginning of a conversation, before eliciting slot values.
	InitialResponseSetting *types.InitialResponseSetting

	// The list of input contexts specified for the intent.
	InputContexts []types.InputContext

	// The closing setting specified for the intent.
	IntentClosingSetting *types.IntentClosingSetting

	// The confirmation setting specified for the intent.
	IntentConfirmationSetting *types.IntentConfirmationSetting

	// A unique identifier for the intent.
	IntentId *string

	// The name specified for the intent.
	IntentName *string

	// Configuration for searching a Amazon Kendra index specified for the intent.
	KendraConfiguration *types.KendraConfiguration

	// The locale that the intent is specified to use.
	LocaleId *string

	// The list of output contexts specified for the intent.
	OutputContexts []types.OutputContext

	// The signature of the parent intent specified for the intent.
	ParentIntentSignature *string

	// Details about the the configuration of the built-in Amazon.QnAIntent .
	QnAIntentConfiguration *types.QnAIntentConfiguration

	// The sample utterances specified for the intent.
	SampleUtterances []types.SampleUtterance

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateResourcePolicyInput added in v1.2.0 

type CreateResourcePolicyInput struct {

	// A resource policy to add to the resource. The policy is a JSON structure that
	// contains one or more statements that define the policy. The policy must follow
	// the IAM syntax. For more information about the contents of a JSON policy
	// document, see IAM JSON policy reference  (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies.html)
	// . If the policy isn't valid, Amazon Lex returns a validation exception.
	//
	// This member is required.
	Policy *string

	// The Amazon Resource Name (ARN) of the bot or bot alias that the resource policy
	// is attached to.
	//
	// This member is required.
	ResourceArn *string
	// contains filtered or unexported fields
}

type CreateResourcePolicyOutput added in v1.2.0 

type CreateResourcePolicyOutput struct {

	// The Amazon Resource Name (ARN) of the bot or bot alias that the resource policy
	// was attached to.
	ResourceArn *string

	// The current revision of the resource policy. Use the revision ID to make sure
	// that you are updating the most current version of a resource policy when you add
	// a policy statement to a resource, delete a resource, or update a resource.
	RevisionId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateResourcePolicyStatementInput added in v1.2.0 

type CreateResourcePolicyStatementInput struct {

	// The Amazon Lex action that this policy either allows or denies. The action must
	// apply to the resource type of the specified ARN. For more information, see
	// Actions, resources, and condition keys for Amazon Lex V2 (https://docs.aws.amazon.com/service-authorization/latest/reference/list_amazonlexv2.html)
	// .
	//
	// This member is required.
	Action []string

	// Determines whether the statement allows or denies access to the resource.
	//
	// This member is required.
	Effect types.Effect

	// An IAM principal, such as an IAM user, IAM role, or Amazon Web Services
	// services that is allowed or denied access to a resource. For more information,
	// see Amazon Web Services JSON policy elements: Principal (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_principal.html)
	// .
	//
	// This member is required.
	Principal []types.Principal

	// The Amazon Resource Name (ARN) of the bot or bot alias that the resource policy
	// is attached to.
	//
	// This member is required.
	ResourceArn *string

	// The name of the statement. The ID is the same as the Sid IAM property. The
	// statement name must be unique within the policy. For more information, see IAM
	// JSON policy elements: Sid (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_sid.html)
	// .
	//
	// This member is required.
	StatementId *string

	// Specifies a condition when the policy is in effect. If the principal of the
	// policy is a service principal, you must provide two condition blocks, one with a
	// SourceAccount global condition key and one with a SourceArn global condition
	// key. For more information, see IAM JSON policy elements: Condition  (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_condition.html)
	// .
	Condition map[string]map[string]string

	// The identifier of the revision of the policy to edit. If this revision ID
	// doesn't match the current revision ID, Amazon Lex throws an exception. If you
	// don't specify a revision, Amazon Lex overwrites the contents of the policy with
	// the new values.
	ExpectedRevisionId *string
	// contains filtered or unexported fields
}

type CreateResourcePolicyStatementOutput added in v1.2.0 

type CreateResourcePolicyStatementOutput struct {

	// The Amazon Resource Name (ARN) of the bot or bot alias that the resource policy
	// is attached to.
	ResourceArn *string

	// The current revision of the resource policy. Use the revision ID to make sure
	// that you are updating the most current version of a resource policy when you add
	// a policy statement to a resource, delete a resource, or update a resource.
	RevisionId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateSlotInput 

type CreateSlotInput struct {

	// The identifier of the bot associated with the slot.
	//
	// This member is required.
	BotId *string

	// The version of the bot associated with the slot.
	//
	// This member is required.
	BotVersion *string

	// The identifier of the intent that contains the slot.
	//
	// This member is required.
	IntentId *string

	// The identifier of the language and locale that the slot will be used in. The
	// string must match one of the supported locales. All of the bots, intents, slot
	// types used by the slot must have the same locale. For more information, see
	// Supported languages (https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html)
	// .
	//
	// This member is required.
	LocaleId *string

	// The name of the slot. Slot names must be unique within the bot that contains
	// the slot.
	//
	// This member is required.
	SlotName *string

	// Specifies prompts that Amazon Lex sends to the user to elicit a response that
	// provides the value for the slot.
	//
	// This member is required.
	ValueElicitationSetting *types.SlotValueElicitationSetting

	// A description of the slot. Use this to help identify the slot in lists.
	Description *string

	// Indicates whether the slot returns multiple values in one response. Multi-value
	// slots are only available in the en-US locale. If you set this value to true in
	// any other locale, Amazon Lex throws a ValidationException . If the
	// multipleValuesSetting is not set, the default value is false .
	MultipleValuesSetting *types.MultipleValuesSetting

	// Determines how slot values are used in Amazon CloudWatch logs. If the value of
	// the obfuscationSetting parameter is DefaultObfuscation , slot values are
	// obfuscated in the log output. If the value is None , the actual value is present
	// in the log output. The default is to obfuscate values in the CloudWatch logs.
	ObfuscationSetting *types.ObfuscationSetting

	// The unique identifier for the slot type associated with this slot. The slot
	// type determines the values that can be entered into the slot.
	SlotTypeId *string

	// Specifications for the constituent sub slots and the expression for the
	// composite slot.
	SubSlotSetting *types.SubSlotSetting
	// contains filtered or unexported fields
}

type CreateSlotOutput 

type CreateSlotOutput struct {

	// The unique identifier of the bot associated with the slot.
	BotId *string

	// The version of the bot associated with the slot.
	BotVersion *string

	// The timestamp of the date and time that the slot was created.
	CreationDateTime *time.Time

	// The description associated with the slot.
	Description *string

	// The unique identifier of the intent associated with the slot.
	IntentId *string

	// The language and local specified for the slot.
	LocaleId *string

	// Indicates whether the slot returns multiple values in one response.
	MultipleValuesSetting *types.MultipleValuesSetting

	// Indicates whether the slot is configured to obfuscate values in Amazon
	// CloudWatch logs.
	ObfuscationSetting *types.ObfuscationSetting

	// The unique identifier associated with the slot. Use this to identify the slot
	// when you update or delete it.
	SlotId *string

	// The name specified for the slot.
	SlotName *string

	// The unique identifier of the slot type associated with this slot.
	SlotTypeId *string

	// Specifications for the constituent sub slots and the expression for the
	// composite slot.
	SubSlotSetting *types.SubSlotSetting

	// The value elicitation settings specified for the slot.
	ValueElicitationSetting *types.SlotValueElicitationSetting

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateSlotTypeInput 

type CreateSlotTypeInput struct {

	// The identifier of the bot associated with this slot type.
	//
	// This member is required.
	BotId *string

	// The identifier of the bot version associated with this slot type.
	//
	// This member is required.
	BotVersion *string

	// The identifier of the language and locale that the slot type will be used in.
	// The string must match one of the supported locales. All of the bots, intents,
	// and slots used by the slot type must have the same locale. For more information,
	// see Supported languages (https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html)
	// .
	//
	// This member is required.
	LocaleId *string

	// The name for the slot. A slot type name must be unique within the intent.
	//
	// This member is required.
	SlotTypeName *string

	// Specifications for a composite slot type.
	CompositeSlotTypeSetting *types.CompositeSlotTypeSetting

	// A description of the slot type. Use the description to help identify the slot
	// type in lists.
	Description *string

	// Sets the type of external information used to create the slot type.
	ExternalSourceSetting *types.ExternalSourceSetting

	// The built-in slot type used as a parent of this slot type. When you define a
	// parent slot type, the new slot type has the configuration of the parent slot
	// type. Only AMAZON.AlphaNumeric is supported.
	ParentSlotTypeSignature *string

	// A list of SlotTypeValue objects that defines the values that the slot type can
	// take. Each value can have a list of synonyms, additional values that help train
	// the machine learning model about the values that it resolves for a slot.
	SlotTypeValues []types.SlotTypeValue

	// Determines the strategy that Amazon Lex uses to select a value from the list of
	// possible values. The field can be set to one of the following values:
	//   - ORIGINAL_VALUE - Returns the value entered by the user, if the user value is
	//   similar to the slot value.
	//   - TOP_RESOLUTION - If there is a resolution list for the slot, return the
	//   first value in the resolution list. If there is no resolution list, return null.
	//
	// If you don't specify the valueSelectionSetting parameter, the default is
	// ORIGINAL_VALUE .
	ValueSelectionSetting *types.SlotValueSelectionSetting
	// contains filtered or unexported fields
}

type CreateSlotTypeOutput 

type CreateSlotTypeOutput struct {

	// The identifier for the bot associated with the slot type.
	BotId *string

	// The version of the bot associated with the slot type.
	BotVersion *string

	// Specifications for a composite slot type.
	CompositeSlotTypeSetting *types.CompositeSlotTypeSetting

	// A timestamp of the date and time that the slot type was created.
	CreationDateTime *time.Time

	// The description specified for the slot type.
	Description *string

	// The type of external information used to create the slot type.
	ExternalSourceSetting *types.ExternalSourceSetting

	// The specified language and local specified for the slot type.
	LocaleId *string

	// The signature of the base slot type specified for the slot type.
	ParentSlotTypeSignature *string

	// The unique identifier assigned to the slot type. Use this to identify the slot
	// type in the UpdateSlotType and DeleteSlotType operations.
	SlotTypeId *string

	// The name specified for the slot type.
	SlotTypeName *string

	// The list of values that the slot type can assume.
	SlotTypeValues []types.SlotTypeValue

	// The strategy that Amazon Lex uses to select a value from the list of possible
	// values.
	ValueSelectionSetting *types.SlotValueSelectionSetting

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateTestSetDiscrepancyReportInput added in v1.29.0 

type CreateTestSetDiscrepancyReportInput struct {

	// The target bot for the test set discrepancy report.
	//
	// This member is required.
	Target *types.TestSetDiscrepancyReportResourceTarget

	// The test set Id for the test set discrepancy report.
	//
	// This member is required.
	TestSetId *string
	// contains filtered or unexported fields
}

type CreateTestSetDiscrepancyReportOutput added in v1.29.0 

type CreateTestSetDiscrepancyReportOutput struct {

	// The creation date and time for the test set discrepancy report.
	CreationDateTime *time.Time

	// The target bot for the test set discrepancy report.
	Target *types.TestSetDiscrepancyReportResourceTarget

	// The unique identifier of the test set discrepancy report to describe.
	TestSetDiscrepancyReportId *string

	// The test set Id for the test set discrepancy report.
	TestSetId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateUploadUrlInput added in v1.2.0 

type CreateUploadUrlInput struct {
	// contains filtered or unexported fields
}

type CreateUploadUrlOutput added in v1.2.0 

type CreateUploadUrlOutput struct {

	// An identifier for a unique import job. Use it when you call the StartImport (https://docs.aws.amazon.com/lexv2/latest/APIReference/API_StartImport.html)
	// operation.
	ImportId *string

	// A pre-signed S3 write URL. Upload the zip archive file that contains the
	// definition of your bot or bot locale.
	UploadUrl *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteBotAliasInput 

type DeleteBotAliasInput struct {

	// The unique identifier of the bot alias to delete.
	//
	// This member is required.
	BotAliasId *string

	// The unique identifier of the bot associated with the alias to delete.
	//
	// This member is required.
	BotId *string

	// By default, Amazon Lex checks if any other resource, such as a bot network, is
	// using the bot alias before it is deleted and throws a ResourceInUseException
	// exception if the alias is being used by another resource. Set this parameter to
	// true to skip this check and remove the alias even if it is being used by another
	// resource.
	SkipResourceInUseCheck bool
	// contains filtered or unexported fields
}

type DeleteBotAliasOutput 

type DeleteBotAliasOutput struct {

	// The unique identifier of the bot alias to delete.
	BotAliasId *string

	// The current status of the alias. The status is Deleting while the alias is in
	// the process of being deleted. Once the alias is deleted, it will no longer
	// appear in the list of aliases returned by the ListBotAliases operation.
	BotAliasStatus types.BotAliasStatus

	// The unique identifier of the bot that contains the alias to delete.
	BotId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteBotInput 

type DeleteBotInput struct {

	// The identifier of the bot to delete.
	//
	// This member is required.
	BotId *string

	// By default, Amazon Lex checks if any other resource, such as an alias or bot
	// network, is using the bot version before it is deleted and throws a
	// ResourceInUseException exception if the bot is being used by another resource.
	// Set this parameter to true to skip this check and remove the bot even if it is
	// being used by another resource.
	SkipResourceInUseCheck bool
	// contains filtered or unexported fields
}

type DeleteBotLocaleInput 

type DeleteBotLocaleInput struct {

	// The unique identifier of the bot that contains the locale.
	//
	// This member is required.
	BotId *string

	// The version of the bot that contains the locale.
	//
	// This member is required.
	BotVersion *string

	// The identifier of the language and locale that will be deleted. The string must
	// match one of the supported locales. For more information, see Supported
	// languages (https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html) .
	//
	// This member is required.
	LocaleId *string
	// contains filtered or unexported fields
}

type DeleteBotLocaleOutput 

type DeleteBotLocaleOutput struct {

	// The identifier of the bot that contained the deleted locale.
	BotId *string

	// The status of deleting the bot locale. The locale first enters the Deleting
	// status. Once the locale is deleted it no longer appears in the list of locales
	// for the bot.
	BotLocaleStatus types.BotLocaleStatus

	// The version of the bot that contained the deleted locale.
	BotVersion *string

	// The language and locale of the deleted locale.
	LocaleId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteBotOutput 

type DeleteBotOutput struct {

	// The unique identifier of the bot that Amazon Lex is deleting.
	BotId *string

	// The current status of the bot. The status is Deleting while the bot and its
	// associated resources are being deleted.
	BotStatus types.BotStatus

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteBotReplicaInput added in v1.39.0 

type DeleteBotReplicaInput struct {

	// The unique ID of the replicated bot to be deleted from the secondary region
	//
	// This member is required.
	BotId *string

	// The secondary region of the replicated bot that will be deleted.
	//
	// This member is required.
	ReplicaRegion *string
	// contains filtered or unexported fields
}

type DeleteBotReplicaOutput added in v1.39.0 

type DeleteBotReplicaOutput struct {

	// The unique bot ID of the replicated bot generated.
	BotId *string

	// The operational status of the replicated bot generated.
	BotReplicaStatus types.BotReplicaStatus

	// The region of the replicated bot generated.
	ReplicaRegion *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteBotVersionInput 

type DeleteBotVersionInput struct {

	// The identifier of the bot that contains the version.
	//
	// This member is required.
	BotId *string

	// The version of the bot to delete.
	//
	// This member is required.
	BotVersion *string

	// By default, Amazon Lex checks if any other resource, such as an alias or bot
	// network, is using the bot version before it is deleted and throws a
	// ResourceInUseException exception if the version is being used by another
	// resource. Set this parameter to true to skip this check and remove the version
	// even if it is being used by another resource.
	SkipResourceInUseCheck bool
	// contains filtered or unexported fields
}

type DeleteBotVersionOutput 

type DeleteBotVersionOutput struct {

	// The identifier of the bot that is being deleted.
	BotId *string

	// The current status of the bot.
	BotStatus types.BotStatus

	// The version of the bot that is being deleted.
	BotVersion *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteCustomVocabularyInput added in v1.17.0 

type DeleteCustomVocabularyInput struct {

	// The unique identifier of the bot to remove the custom vocabulary from.
	//
	// This member is required.
	BotId *string

	// The version of the bot to remove the custom vocabulary from.
	//
	// This member is required.
	BotVersion *string

	// The locale identifier for the locale that contains the custom vocabulary to
	// remove.
	//
	// This member is required.
	LocaleId *string
	// contains filtered or unexported fields
}

type DeleteCustomVocabularyOutput added in v1.17.0 

type DeleteCustomVocabularyOutput struct {

	// The identifier of the bot that the custom vocabulary was removed from.
	BotId *string

	// The version of the bot that the custom vocabulary was removed from.
	BotVersion *string

	// The status of removing the custom vocabulary.
	CustomVocabularyStatus types.CustomVocabularyStatus

	// The locale identifier for the locale that the custom vocabulary was removed
	// from.
	LocaleId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteExportInput added in v1.2.0 

type DeleteExportInput struct {

	// The unique identifier of the export to delete.
	//
	// This member is required.
	ExportId *string
	// contains filtered or unexported fields
}

type DeleteExportOutput added in v1.2.0 

type DeleteExportOutput struct {

	// The unique identifier of the deleted export.
	ExportId *string

	// The current status of the deletion. When the deletion is complete, the export
	// will no longer be returned by the ListExports (https://docs.aws.amazon.com/lexv2/latest/APIReference/API_ListExports.html)
	// operation and calls to the DescribeExport (https://docs.aws.amazon.com/lexv2/latest/APIReference/API_DescribeExport.html)
	// operation with the export identifier will fail.
	ExportStatus types.ExportStatus

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteImportInput added in v1.2.0 

type DeleteImportInput struct {

	// The unique identifier of the import to delete.
	//
	// This member is required.
	ImportId *string
	// contains filtered or unexported fields
}

type DeleteImportOutput added in v1.2.0 

type DeleteImportOutput struct {

	// The unique identifier of the deleted import.
	ImportId *string

	// The current status of the deletion. When the deletion is complete, the import
	// will no longer be returned by the ListImports (https://docs.aws.amazon.com/lexv2/latest/APIReference/API_ListImports.html)
	// operation and calls to the DescribeImport (https://docs.aws.amazon.com/lexv2/latest/APIReference/API_DescribeImport.html)
	// operation with the import identifier will fail.
	ImportStatus types.ImportStatus

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteIntentInput 

type DeleteIntentInput struct {

	// The identifier of the bot associated with the intent.
	//
	// This member is required.
	BotId *string

	// The version of the bot associated with the intent.
	//
	// This member is required.
	BotVersion *string

	// The unique identifier of the intent to delete.
	//
	// This member is required.
	IntentId *string

	// The identifier of the language and locale where the bot will be deleted. The
	// string must match one of the supported locales. For more information, see
	// Supported languages (https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html)
	// .
	//
	// This member is required.
	LocaleId *string
	// contains filtered or unexported fields
}

type DeleteIntentOutput 

type DeleteIntentOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteResourcePolicyInput added in v1.2.0 

type DeleteResourcePolicyInput struct {

	// The Amazon Resource Name (ARN) of the bot or bot alias that has the resource
	// policy attached.
	//
	// This member is required.
	ResourceArn *string

	// The identifier of the revision to edit. If this ID doesn't match the current
	// revision number, Amazon Lex returns an exception If you don't specify a revision
	// ID, Amazon Lex will delete the current policy.
	ExpectedRevisionId *string
	// contains filtered or unexported fields
}

type DeleteResourcePolicyOutput added in v1.2.0 

type DeleteResourcePolicyOutput struct {

	// The Amazon Resource Name (ARN) of the bot or bot alias that the resource policy
	// was deleted from.
	ResourceArn *string

	// The current revision of the resource policy. Use the revision ID to make sure
	// that you are updating the most current version of a resource policy when you add
	// a policy statement to a resource, delete a resource, or update a resource.
	RevisionId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteResourcePolicyStatementInput added in v1.2.0 

type DeleteResourcePolicyStatementInput struct {

	// The Amazon Resource Name (ARN) of the bot or bot alias that the resource policy
	// is attached to.
	//
	// This member is required.
	ResourceArn *string

	// The name of the statement (SID) to delete from the policy.
	//
	// This member is required.
	StatementId *string

	// The identifier of the revision of the policy to delete the statement from. If
	// this revision ID doesn't match the current revision ID, Amazon Lex throws an
	// exception. If you don't specify a revision, Amazon Lex removes the current
	// contents of the statement.
	ExpectedRevisionId *string
	// contains filtered or unexported fields
}

type DeleteResourcePolicyStatementOutput added in v1.2.0 

type DeleteResourcePolicyStatementOutput struct {

	// The Amazon Resource Name (ARN) of the bot or bot alias that the resource policy
	// statement was removed from.
	ResourceArn *string

	// The current revision of the resource policy. Use the revision ID to make sure
	// that you are updating the most current version of a resource policy when you add
	// a policy statement to a resource, delete a resource, or update a resource.
	RevisionId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteSlotInput 

type DeleteSlotInput struct {

	// The identifier of the bot associated with the slot to delete.
	//
	// This member is required.
	BotId *string

	// The version of the bot associated with the slot to delete.
	//
	// This member is required.
	BotVersion *string

	// The identifier of the intent associated with the slot.
	//
	// This member is required.
	IntentId *string

	// The identifier of the language and locale that the slot will be deleted from.
	// The string must match one of the supported locales. For more information, see
	// Supported languages (https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html)
	// .
	//
	// This member is required.
	LocaleId *string

	// The identifier of the slot to delete.
	//
	// This member is required.
	SlotId *string
	// contains filtered or unexported fields
}

type DeleteSlotOutput 

type DeleteSlotOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteSlotTypeInput 

type DeleteSlotTypeInput struct {

	// The identifier of the bot associated with the slot type.
	//
	// This member is required.
	BotId *string

	// The version of the bot associated with the slot type.
	//
	// This member is required.
	BotVersion *string

	// The identifier of the language and locale that the slot type will be deleted
	// from. The string must match one of the supported locales. For more information,
	// see Supported languages (https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html)
	// .
	//
	// This member is required.
	LocaleId *string

	// The identifier of the slot type to delete.
	//
	// This member is required.
	SlotTypeId *string

	// By default, the DeleteSlotType operations throws a ResourceInUseException
	// exception if you try to delete a slot type used by a slot. Set the
	// skipResourceInUseCheck parameter to true to skip this check and remove the slot
	// type even if a slot uses it.
	SkipResourceInUseCheck bool
	// contains filtered or unexported fields
}

type DeleteSlotTypeOutput 

type DeleteSlotTypeOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteTestSetInput added in v1.29.0 

type DeleteTestSetInput struct {

	// The test set Id of the test set to be deleted.
	//
	// This member is required.
	TestSetId *string
	// contains filtered or unexported fields
}

type DeleteTestSetOutput added in v1.29.0 

type DeleteTestSetOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteUtterancesInput added in v1.8.0 

type DeleteUtterancesInput struct {

	// The unique identifier of the bot that contains the utterances.
	//
	// This member is required.
	BotId *string

	// The identifier of the language and locale where the utterances were collected.
	// The string must match one of the supported locales. For more information, see
	// Supported languages (https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html)
	// .
	LocaleId *string

	// The unique identifier of the session with the user. The ID is returned in the
	// response from the RecognizeText (https://docs.aws.amazon.com/lexv2/latest/APIReference/API_runtime_RecognizeText.html)
	// and RecognizeUtterance (https://docs.aws.amazon.com/lexv2/latest/APIReference/API_runtime_RecognizeUtterance.html)
	// operations.
	SessionId *string
	// contains filtered or unexported fields
}

type DeleteUtterancesOutput added in v1.8.0 

type DeleteUtterancesOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeBotAPIClient added in v1.5.0 

type DescribeBotAPIClient interface {
	DescribeBot(context.Context, *DescribeBotInput, ...func(*Options)) (*DescribeBotOutput, error)
}

DescribeBotAPIClient is a client that implements the DescribeBot operation.

type DescribeBotAliasAPIClient added in v1.5.0 

type DescribeBotAliasAPIClient interface {
	DescribeBotAlias(context.Context, *DescribeBotAliasInput, ...func(*Options)) (*DescribeBotAliasOutput, error)
}

DescribeBotAliasAPIClient is a client that implements the DescribeBotAlias operation.

type DescribeBotAliasInput 

type DescribeBotAliasInput struct {

	// The identifier of the bot alias to describe.
	//
	// This member is required.
	BotAliasId *string

	// The identifier of the bot associated with the bot alias to describe.
	//
	// This member is required.
	BotId *string
	// contains filtered or unexported fields
}

type DescribeBotAliasOutput 

type DescribeBotAliasOutput struct {

	// A list of events that affect a bot alias. For example, an event is recorded
	// when the version that the alias points to changes.
	BotAliasHistoryEvents []types.BotAliasHistoryEvent

	// The identifier of the bot alias.
	BotAliasId *string

	// The locale settings that are unique to the alias.
	BotAliasLocaleSettings map[string]types.BotAliasLocaleSettings

	// The name of the bot alias.
	BotAliasName *string

	// The current status of the alias. When the alias is Available , the alias is
	// ready for use with your bot.
	BotAliasStatus types.BotAliasStatus

	// The identifier of the bot associated with the bot alias.
	BotId *string

	// The version of the bot associated with the bot alias.
	BotVersion *string

	// Specifics of how Amazon Lex logs text and audio conversations with the bot
	// associated with the alias.
	ConversationLogSettings *types.ConversationLogSettings

	// A timestamp of the date and time that the alias was created.
	CreationDateTime *time.Time

	// The description of the bot alias.
	Description *string

	// A timestamp of the date and time that the alias was last updated.
	LastUpdatedDateTime *time.Time

	// A list of the networks to which the bot alias you described belongs.
	ParentBotNetworks []types.ParentBotNetwork

	// Determines whether Amazon Lex will use Amazon Comprehend to detect the
	// sentiment of user utterances.
	SentimentAnalysisSettings *types.SentimentAnalysisSettings

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeBotInput 

type DescribeBotInput struct {

	// The unique identifier of the bot to describe.
	//
	// This member is required.
	BotId *string
	// contains filtered or unexported fields
}

type DescribeBotLocaleAPIClient added in v1.5.0 

type DescribeBotLocaleAPIClient interface {
	DescribeBotLocale(context.Context, *DescribeBotLocaleInput, ...func(*Options)) (*DescribeBotLocaleOutput, error)
}

DescribeBotLocaleAPIClient is a client that implements the DescribeBotLocale operation.

type DescribeBotLocaleInput 

type DescribeBotLocaleInput struct {

	// The identifier of the bot associated with the locale.
	//
	// This member is required.
	BotId *string

	// The version of the bot associated with the locale.
	//
	// This member is required.
	BotVersion *string

	// The unique identifier of the locale to describe. The string must match one of
	// the supported locales. For more information, see Supported languages (https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html)
	// .
	//
	// This member is required.
	LocaleId *string
	// contains filtered or unexported fields
}

type DescribeBotLocaleOutput 

type DescribeBotLocaleOutput struct {

	// The identifier of the bot associated with the locale.
	BotId *string

	// History of changes, such as when a locale is used in an alias, that have taken
	// place for the locale.
	BotLocaleHistoryEvents []types.BotLocaleHistoryEvent

	// The status of the bot. If the status is Failed , the reasons for the failure are
	// listed in the failureReasons field.
	BotLocaleStatus types.BotLocaleStatus

	// The version of the bot associated with the locale.
	BotVersion *string

	// The date and time that the locale was created.
	CreationDateTime *time.Time

	// The description of the locale.
	Description *string

	// if botLocaleStatus is Failed , Amazon Lex explains why it failed to build the
	// bot.
	FailureReasons []string

	// Contains settings for Amazon Bedrock's generative AI features for your bot
	// locale.
	GenerativeAISettings *types.GenerativeAISettings

	// The number of intents defined for the locale.
	IntentsCount *int32

	// The date and time that the locale was last submitted for building.
	LastBuildSubmittedDateTime *time.Time

	// The date and time that the locale was last updated.
	LastUpdatedDateTime *time.Time

	// The unique identifier of the described locale.
	LocaleId *string

	// The name of the locale.
	LocaleName *string

	// The confidence threshold where Amazon Lex inserts the AMAZON.FallbackIntent and
	// AMAZON.KendraSearchIntent intents in the list of possible intents for an
	// utterance.
	NluIntentConfidenceThreshold *float64

	// Recommended actions to take to resolve an error in the failureReasons field.
	RecommendedActions []string

	// The number of slot types defined for the locale.
	SlotTypesCount *int32

	// The Amazon Polly voice Amazon Lex uses for voice interaction with the user.
	VoiceSettings *types.VoiceSettings

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeBotOutput 

type DescribeBotOutput struct {

	// The unique identifier of the bot.
	BotId *string

	// The list of bots in the network that was described.
	BotMembers []types.BotMember

	// The name of the bot.
	BotName *string

	// The current status of the bot. When the status is Available the bot is ready to
	// be used in conversations with users.
	BotStatus types.BotStatus

	// The type of the bot that was described.
	BotType types.BotType

	// A timestamp of the date and time that the bot was created.
	CreationDateTime *time.Time

	// Settings for managing data privacy of the bot and its conversations with users.
	DataPrivacy *types.DataPrivacy

	// The description of the bot.
	Description *string

	// If the botStatus is Failed , this contains a list of reasons that the bot
	// couldn't be built.
	FailureReasons []string

	// The maximum time in seconds that Amazon Lex retains the data gathered in a
	// conversation.
	IdleSessionTTLInSeconds *int32

	// A timestamp of the date and time that the bot was last updated.
	LastUpdatedDateTime *time.Time

	// The Amazon Resource Name (ARN) of an IAM role that has permission to access the
	// bot.
	RoleArn *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeBotRecommendationInput added in v1.14.0 

type DescribeBotRecommendationInput struct {

	// The unique identifier of the bot associated with the bot recommendation.
	//
	// This member is required.
	BotId *string

	// The identifier of the bot recommendation to describe.
	//
	// This member is required.
	BotRecommendationId *string

	// The version of the bot associated with the bot recommendation.
	//
	// This member is required.
	BotVersion *string

	// The identifier of the language and locale of the bot recommendation to
	// describe. The string must match one of the supported locales. For more
	// information, see Supported languages (https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html)
	// .
	//
	// This member is required.
	LocaleId *string
	// contains filtered or unexported fields
}

type DescribeBotRecommendationOutput added in v1.14.0 

type DescribeBotRecommendationOutput struct {

	// The identifier of the bot associated with the bot recommendation.
	BotId *string

	// The identifier of the bot recommendation being described.
	BotRecommendationId *string

	// The object representing the URL of the bot definition, the URL of the
	// associated transcript and a statistical summary of the bot recommendation
	// results.
	BotRecommendationResults *types.BotRecommendationResults

	// The status of the bot recommendation. If the status is Failed, then the reasons
	// for the failure are listed in the failureReasons field.
	BotRecommendationStatus types.BotRecommendationStatus

	// The version of the bot associated with the bot recommendation.
	BotVersion *string

	// The date and time that the bot recommendation was created.
	CreationDateTime *time.Time

	// The object representing the passwords that were used to encrypt the data
	// related to the bot recommendation results, as well as the KMS key ARN used to
	// encrypt the associated metadata.
	EncryptionSetting *types.EncryptionSetting

	// If botRecommendationStatus is Failed, Amazon Lex explains why.
	FailureReasons []string

	// The date and time that the bot recommendation was last updated.
	LastUpdatedDateTime *time.Time

	// The identifier of the language and locale of the bot recommendation to describe.
	LocaleId *string

	// The object representing the Amazon S3 bucket containing the transcript, as well
	// as the associated metadata.
	TranscriptSourceSetting *types.TranscriptSourceSetting

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeBotReplicaInput added in v1.39.0 

type DescribeBotReplicaInput struct {

	// The request for the unique bot ID of the replicated bot being monitored.
	//
	// This member is required.
	BotId *string

	// The request for the region of the replicated bot being monitored.
	//
	// This member is required.
	ReplicaRegion *string
	// contains filtered or unexported fields
}

type DescribeBotReplicaOutput added in v1.39.0 

type DescribeBotReplicaOutput struct {

	// The unique bot ID of the replicated bot being monitored.
	BotId *string

	// The operational status of the replicated bot being monitored.
	BotReplicaStatus types.BotReplicaStatus

	// The creation date and time of the replicated bot being monitored.
	CreationDateTime *time.Time

	// The failure reasons the bot being monitored failed to replicate.
	FailureReasons []string

	// The region of the replicated bot being monitored.
	ReplicaRegion *string

	// The source region of the replicated bot being monitored.
	SourceRegion *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeBotResourceGenerationInput added in v1.37.0 

type DescribeBotResourceGenerationInput struct {

	// The unique identifier of the bot for which to return the generation details.
	//
	// This member is required.
	BotId *string

	// The version of the bot for which to return the generation details.
	//
	// This member is required.
	BotVersion *string

	// The unique identifier of the generation request for which to return the
	// generation details.
	//
	// This member is required.
	GenerationId *string

	// The locale of the bot for which to return the generation details.
	//
	// This member is required.
	LocaleId *string
	// contains filtered or unexported fields
}

type DescribeBotResourceGenerationOutput added in v1.37.0 

type DescribeBotResourceGenerationOutput struct {

	// The unique identifier of the bot for which the generation request was made.
	BotId *string

	// The version of the bot for which the generation request was made.
	BotVersion *string

	// The date and time at which the item was generated.
	CreationDateTime *time.Time

	// A list of reasons why the generation of bot resources through natural language
	// description failed.
	FailureReasons []string

	// The Amazon S3 location of the generated bot locale configuration.
	GeneratedBotLocaleUrl *string

	// The generation ID for which to return the generation details.
	GenerationId *string

	// The prompt used in the generation request.
	GenerationInputPrompt *string

	// The status of the generation request.
	GenerationStatus types.GenerationStatus

	// The date and time at which the generated item was updated.
	LastUpdatedDateTime *time.Time

	// The locale of the bot for which the generation request was made.
	LocaleId *string

	// The ARN of the model used to generate the bot resources.
	ModelArn *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeBotVersionAPIClient added in v1.5.0 

type DescribeBotVersionAPIClient interface {
	DescribeBotVersion(context.Context, *DescribeBotVersionInput, ...func(*Options)) (*DescribeBotVersionOutput, error)
}

DescribeBotVersionAPIClient is a client that implements the DescribeBotVersion operation.

type DescribeBotVersionInput 

type DescribeBotVersionInput struct {

	// The identifier of the bot containing the version to return metadata for.
	//
	// This member is required.
	BotId *string

	// The version of the bot to return metadata for.
	//
	// This member is required.
	BotVersion *string
	// contains filtered or unexported fields
}

type DescribeBotVersionOutput 

type DescribeBotVersionOutput struct {

	// The identifier of the bot that contains the version.
	BotId *string

	// The members of bot network in the version that was described.
	BotMembers []types.BotMember

	// The name of the bot that contains the version.
	BotName *string

	// The current status of the bot. When the status is Available , the bot version is
	// ready for use.
	BotStatus types.BotStatus

	// The type of the bot in the version that was described.
	BotType types.BotType

	// The version of the bot that was described.
	BotVersion *string

	// A timestamp of the date and time that the bot version was created.
	CreationDateTime *time.Time

	// Data privacy settings for the bot version.
	DataPrivacy *types.DataPrivacy

	// The description specified for the bot.
	Description *string

	// If the botStatus is Failed , this contains a list of reasons that the version
	// couldn't be built.
	FailureReasons []string

	// The number of seconds that a session with the bot remains active before it is
	// discarded by Amazon Lex.
	IdleSessionTTLInSeconds *int32

	// A list of the networks to which the bot version you described belongs.
	ParentBotNetworks []types.ParentBotNetwork

	// The Amazon Resource Name (ARN) of an IAM role that has permission to access the
	// bot version.
	RoleArn *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeCustomVocabularyMetadataInput added in v1.17.0 

type DescribeCustomVocabularyMetadataInput struct {

	// The unique identifier of the bot that contains the custom vocabulary.
	//
	// This member is required.
	BotId *string

	// The bot version of the bot to return metadata for.
	//
	// This member is required.
	BotVersion *string

	// The locale to return the custom vocabulary information for. The locale must be
	// en_GB .
	//
	// This member is required.
	LocaleId *string
	// contains filtered or unexported fields
}

type DescribeCustomVocabularyMetadataOutput added in v1.17.0 

type DescribeCustomVocabularyMetadataOutput struct {

	// The identifier of the bot that contains the custom vocabulary.
	BotId *string

	// The version of the bot that contains the custom vocabulary to describe.
	BotVersion *string

	// The date and time that the custom vocabulary was created.
	CreationDateTime *time.Time

	// The status of the custom vocabulary. If the status is Ready the custom
	// vocabulary is ready to use.
	CustomVocabularyStatus types.CustomVocabularyStatus

	// The date and time that the custom vocabulary was last updated.
	LastUpdatedDateTime *time.Time

	// The locale that contains the custom vocabulary to describe.
	LocaleId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeExportAPIClient added in v1.5.0 

type DescribeExportAPIClient interface {
	DescribeExport(context.Context, *DescribeExportInput, ...func(*Options)) (*DescribeExportOutput, error)
}

DescribeExportAPIClient is a client that implements the DescribeExport operation.

type DescribeExportInput added in v1.2.0 

type DescribeExportInput struct {

	// The unique identifier of the export to describe.
	//
	// This member is required.
	ExportId *string
	// contains filtered or unexported fields
}

type DescribeExportOutput added in v1.2.0 

type DescribeExportOutput struct {

	// The date and time that the export was created.
	CreationDateTime *time.Time

	// A pre-signed S3 URL that points to the bot or bot locale archive. The URL is
	// only available for 5 minutes after calling the DescribeExport operation.
	DownloadUrl *string

	// The unique identifier of the described export.
	ExportId *string

	// The status of the export. When the status is Complete the export archive file
	// is available for download.
	ExportStatus types.ExportStatus

	// If the exportStatus is failed, contains one or more reasons why the export
	// could not be completed.
	FailureReasons []string

	// The file format used in the files that describe the resource.
	FileFormat types.ImportExportFileFormat

	// The last date and time that the export was updated.
	LastUpdatedDateTime *time.Time

	// The bot, bot ID, and optional locale ID of the exported bot or bot locale.
	ResourceSpecification *types.ExportResourceSpecification

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeImportAPIClient added in v1.5.0 

type DescribeImportAPIClient interface {
	DescribeImport(context.Context, *DescribeImportInput, ...func(*Options)) (*DescribeImportOutput, error)
}

DescribeImportAPIClient is a client that implements the DescribeImport operation.

type DescribeImportInput added in v1.2.0 

type DescribeImportInput struct {

	// The unique identifier of the import to describe.
	//
	// This member is required.
	ImportId *string
	// contains filtered or unexported fields
}

type DescribeImportOutput added in v1.2.0 

type DescribeImportOutput struct {

	// The date and time that the import was created.
	CreationDateTime *time.Time

	// If the importStatus field is Failed , this provides one or more reasons for the
	// failure.
	FailureReasons []string

	// The unique identifier of the described import.
	ImportId *string

	// The status of the import process. When the status is Completed the resource is
	// imported and ready for use.
	ImportStatus types.ImportStatus

	// The unique identifier that Amazon Lex assigned to the resource created by the
	// import.
	ImportedResourceId *string

	// The name of the imported resource.
	ImportedResourceName *string

	// The date and time that the import was last updated.
	LastUpdatedDateTime *time.Time

	// The strategy used when there was a name conflict between the imported resource
	// and an existing resource. When the merge strategy is FailOnConflict existing
	// resources are not overwritten and the import fails.
	MergeStrategy types.MergeStrategy

	// The specifications of the imported bot, bot locale, or custom vocabulary.
	ResourceSpecification *types.ImportResourceSpecification

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeIntentInput 

type DescribeIntentInput struct {

	// The identifier of the bot associated with the intent.
	//
	// This member is required.
	BotId *string

	// The version of the bot associated with the intent.
	//
	// This member is required.
	BotVersion *string

	// The identifier of the intent to describe.
	//
	// This member is required.
	IntentId *string

	// The identifier of the language and locale of the intent to describe. The string
	// must match one of the supported locales. For more information, see Supported
	// languages (https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html) .
	//
	// This member is required.
	LocaleId *string
	// contains filtered or unexported fields
}

type DescribeIntentOutput 

type DescribeIntentOutput struct {

	// The identifier of the bot associated with the intent.
	BotId *string

	// The version of the bot associated with the intent.
	BotVersion *string

	// A timestamp of the date and time that the intent was created.
	CreationDateTime *time.Time

	// The description of the intent.
	Description *string

	// The Lambda function called during each turn of a conversation with the intent.
	DialogCodeHook *types.DialogCodeHookSettings

	// The Lambda function called when the intent is complete and ready for
	// fulfillment.
	FulfillmentCodeHook *types.FulfillmentCodeHookSettings

	// Configuration setting for a response sent to the user before Amazon Lex starts
	// eliciting slots.
	InitialResponseSetting *types.InitialResponseSetting

	// A list of contexts that must be active for the intent to be considered for
	// sending to the user.
	InputContexts []types.InputContext

	// The response that Amazon Lex sends to when the intent is closed.
	IntentClosingSetting *types.IntentClosingSetting

	// Prompts that Amazon Lex sends to the user to confirm completion of an intent.
	IntentConfirmationSetting *types.IntentConfirmationSetting

	// The unique identifier assigned to the intent when it was created.
	IntentId *string

	// The name specified for the intent.
	IntentName *string

	// Configuration information required to use the AMAZON.KendraSearchIntent intent.
	KendraConfiguration *types.KendraConfiguration

	// A timestamp of the date and time that the intent was last updated.
	LastUpdatedDateTime *time.Time

	// The language and locale specified for the intent.
	LocaleId *string

	// A list of contexts that are activated when the intent is fulfilled.
	OutputContexts []types.OutputContext

	// The identifier of the built-in intent that this intent is derived from, if any.
	ParentIntentSignature *string

	// Details about the configuration of the built-in Amazon.QnAIntent .
	QnAIntentConfiguration *types.QnAIntentConfiguration

	// User utterances that trigger this intent.
	SampleUtterances []types.SampleUtterance

	// The list that determines the priority that slots should be elicited from the
	// user.
	SlotPriorities []types.SlotPriority

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeResourcePolicyInput added in v1.2.0 

type DescribeResourcePolicyInput struct {

	// The Amazon Resource Name (ARN) of the bot or bot alias that the resource policy
	// is attached to.
	//
	// This member is required.
	ResourceArn *string
	// contains filtered or unexported fields
}

type DescribeResourcePolicyOutput added in v1.2.0 

type DescribeResourcePolicyOutput struct {

	// The JSON structure that contains the resource policy. For more information
	// about the contents of a JSON policy document, see IAM JSON policy reference  (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies.html)
	// .
	Policy *string

	// The Amazon Resource Name (ARN) of the bot or bot alias that the resource policy
	// is attached to.
	ResourceArn *string

	// The current revision of the resource policy. Use the revision ID to make sure
	// that you are updating the most current version of a resource policy when you add
	// a policy statement to a resource, delete a resource, or update a resource.
	RevisionId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeSlotInput 

type DescribeSlotInput struct {

	// The identifier of the bot associated with the slot.
	//
	// This member is required.
	BotId *string

	// The version of the bot associated with the slot.
	//
	// This member is required.
	BotVersion *string

	// The identifier of the intent that contains the slot.
	//
	// This member is required.
	IntentId *string

	// The identifier of the language and locale of the slot to describe. The string
	// must match one of the supported locales. For more information, see Supported
	// languages (https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html) .
	//
	// This member is required.
	LocaleId *string

	// The unique identifier for the slot.
	//
	// This member is required.
	SlotId *string
	// contains filtered or unexported fields
}

type DescribeSlotOutput 

type DescribeSlotOutput struct {

	// The identifier of the bot associated with the slot.
	BotId *string

	// The version of the bot associated with the slot.
	BotVersion *string

	// A timestamp of the date and time that the slot was created.
	CreationDateTime *time.Time

	// The description specified for the slot.
	Description *string

	// The identifier of the intent associated with the slot.
	IntentId *string

	// A timestamp of the date and time that the slot was last updated.
	LastUpdatedDateTime *time.Time

	// The language and locale specified for the slot.
	LocaleId *string

	// Indicates whether the slot accepts multiple values in a single utterance. If
	// the multipleValuesSetting is not set, the default value is false .
	MultipleValuesSetting *types.MultipleValuesSetting

	// Whether slot values are shown in Amazon CloudWatch logs. If the value is None ,
	// the actual value of the slot is shown in logs.
	ObfuscationSetting *types.ObfuscationSetting

	// The unique identifier generated for the slot.
	SlotId *string

	// The name specified for the slot.
	SlotName *string

	// The identifier of the slot type that determines the values entered into the
	// slot.
	SlotTypeId *string

	// Specifications for the constituent sub slots and the expression for the
	// composite slot.
	SubSlotSetting *types.SubSlotSetting

	// Prompts that Amazon Lex uses to elicit a value for the slot.
	ValueElicitationSetting *types.SlotValueElicitationSetting

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeSlotTypeInput 

type DescribeSlotTypeInput struct {

	// The identifier of the bot associated with the slot type.
	//
	// This member is required.
	BotId *string

	// The version of the bot associated with the slot type.
	//
	// This member is required.
	BotVersion *string

	// The identifier of the language and locale of the slot type to describe. The
	// string must match one of the supported locales. For more information, see
	// Supported languages (https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html)
	// .
	//
	// This member is required.
	LocaleId *string

	// The identifier of the slot type.
	//
	// This member is required.
	SlotTypeId *string
	// contains filtered or unexported fields
}

type DescribeSlotTypeOutput 

type DescribeSlotTypeOutput struct {

	// The identifier of the bot associated with the slot type.
	BotId *string

	// The version of the bot associated with the slot type.
	BotVersion *string

	// Specifications for a composite slot type.
	CompositeSlotTypeSetting *types.CompositeSlotTypeSetting

	// A timestamp of the date and time that the slot type was created.
	CreationDateTime *time.Time

	// The description specified for the slot type.
	Description *string

	// Provides information about the external source of the slot type's definition.
	ExternalSourceSetting *types.ExternalSourceSetting

	// A timestamp of the date and time that the slot type was last updated.
	LastUpdatedDateTime *time.Time

	// The language and locale specified for the slot type.
	LocaleId *string

	// The built in slot type used as a parent to this slot type.
	ParentSlotTypeSignature *string

	// The unique identifier for the slot type.
	SlotTypeId *string

	// The name specified for the slot type.
	SlotTypeName *string

	// The values that the slot type can take. Includes any synonyms for the slot type
	// values.
	SlotTypeValues []types.SlotTypeValue

	// The strategy that Amazon Lex uses to choose a value from a list of possible
	// values.
	ValueSelectionSetting *types.SlotValueSelectionSetting

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeTestExecutionInput added in v1.29.0 

type DescribeTestExecutionInput struct {

	// The execution Id of the test set execution.
	//
	// This member is required.
	TestExecutionId *string
	// contains filtered or unexported fields
}

type DescribeTestExecutionOutput added in v1.29.0 

type DescribeTestExecutionOutput struct {

	// Indicates whether we use streaming or non-streaming APIs are used for the test
	// set execution. For streaming, StartConversation Amazon Lex Runtime API is used.
	// Whereas for non-streaming, RecognizeUtterance and RecognizeText Amazon Lex
	// Runtime API is used.
	ApiMode types.TestExecutionApiMode

	// The execution creation date and time for the test set execution.
	CreationDateTime *time.Time

	// Reasons for the failure of the test set execution.
	FailureReasons []string

	// The date and time of the last update for the execution.
	LastUpdatedDateTime *time.Time

	// The target bot for the test set execution details.
	Target *types.TestExecutionTarget

	// The execution Id for the test set execution.
	TestExecutionId *string

	// Indicates whether test set is audio or text.
	TestExecutionModality types.TestExecutionModality

	// The test execution status for the test execution.
	TestExecutionStatus types.TestExecutionStatus

	// The test set Id for the test set execution.
	TestSetId *string

	// The test set name of the test set execution.
	TestSetName *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeTestSetDiscrepancyReportInput added in v1.29.0 

type DescribeTestSetDiscrepancyReportInput struct {

	// The unique identifier of the test set discrepancy report.
	//
	// This member is required.
	TestSetDiscrepancyReportId *string
	// contains filtered or unexported fields
}

type DescribeTestSetDiscrepancyReportOutput added in v1.29.0 

type DescribeTestSetDiscrepancyReportOutput struct {

	// The time and date of creation for the test set discrepancy report.
	CreationDateTime *time.Time

	// The failure report for the test set discrepancy report generation action.
	FailureReasons []string

	// The date and time of the last update for the test set discrepancy report.
	LastUpdatedDataTime *time.Time

	// The target bot location for the test set discrepancy report.
	Target *types.TestSetDiscrepancyReportResourceTarget

	// Pre-signed Amazon S3 URL to download the test set discrepancy report.
	TestSetDiscrepancyRawOutputUrl *string

	// The unique identifier of the test set discrepancy report to describe.
	TestSetDiscrepancyReportId *string

	// The status for the test set discrepancy report.
	TestSetDiscrepancyReportStatus types.TestSetDiscrepancyReportStatus

	// The top 200 error results from the test set discrepancy report.
	TestSetDiscrepancyTopErrors *types.TestSetDiscrepancyErrors

	// The test set Id for the test set discrepancy report.
	TestSetId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeTestSetGenerationInput added in v1.29.0 

type DescribeTestSetGenerationInput struct {

	// The unique identifier of the test set generation.
	//
	// This member is required.
	TestSetGenerationId *string
	// contains filtered or unexported fields
}

type DescribeTestSetGenerationOutput added in v1.29.0 

type DescribeTestSetGenerationOutput struct {

	// The creation date and time for the test set generation.
	CreationDateTime *time.Time

	// The test set description for the test set generation.
	Description *string

	// The reasons the test set generation failed.
	FailureReasons []string

	// The data source of the test set used for the test set generation.
	GenerationDataSource *types.TestSetGenerationDataSource

	// The date and time of the last update for the test set generation.
	LastUpdatedDateTime *time.Time

	// The roleARN of the test set used for the test set generation.
	RoleArn *string

	// The Amazon S3 storage location for the test set generation.
	StorageLocation *types.TestSetStorageLocation

	// The unique identifier of the test set generation.
	TestSetGenerationId *string

	// The status for the test set generation.
	TestSetGenerationStatus types.TestSetGenerationStatus

	// The unique identifier for the test set created for the generated test set.
	TestSetId *string

	// The test set name for the generated test set.
	TestSetName *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeTestSetInput added in v1.29.0 

type DescribeTestSetInput struct {

	// The test set Id for the test set request.
	//
	// This member is required.
	TestSetId *string
	// contains filtered or unexported fields
}

type DescribeTestSetOutput added in v1.29.0 

type DescribeTestSetOutput struct {

	// The creation date and time for the test set data.
	CreationDateTime *time.Time

	// The description of the test set.
	Description *string

	// The date and time for the last update of the test set data.
	LastUpdatedDateTime *time.Time

	// Indicates whether the test set is audio or text data.
	Modality types.TestSetModality

	// The total number of agent and user turn in the test set.
	NumTurns *int32

	// The roleARN used for any operation in the test set to access resources in the
	// Amazon Web Services account.
	RoleArn *string

	// The status of the test set.
	Status types.TestSetStatus

	// The Amazon S3 storage location for the test set data.
	StorageLocation *types.TestSetStorageLocation

	// The test set Id for the test set response.
	TestSetId *string

	// The test set name of the test set.
	TestSetName *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type EndpointParameters added in v1.32.0 

type EndpointParameters struct {
	// The AWS region used to dispatch the request.
	//
	// Parameter is
	// required.
	//
	// AWS::Region
	Region *string

	// When true, use the dual-stack endpoint. If the configured endpoint does not
	// support dual-stack, dispatching the request MAY return an error.
	//
	// Defaults to
	// false if no value is provided.
	//
	// AWS::UseDualStack
	UseDualStack *bool

	// When true, send this request to the FIPS-compliant regional endpoint. If the
	// configured endpoint does not have a FIPS compliant endpoint, dispatching the
	// request will return an error.
	//
	// Defaults to false if no value is
	// provided.
	//
	// AWS::UseFIPS
	UseFIPS *bool

	// Override the endpoint used to send this request
	//
	// Parameter is
	// required.
	//
	// SDK::Endpoint
	Endpoint *string
}

EndpointParameters provides the parameters that influence how endpoints are resolved.

func (EndpointParameters) ValidateRequired added in v1.32.0 

func (p EndpointParameters) ValidateRequired() error

ValidateRequired validates required parameters are set.

func (EndpointParameters) WithDefaults added in v1.32.0 

func (p EndpointParameters) WithDefaults() EndpointParameters

WithDefaults returns a shallow copy of EndpointParameterswith default values applied to members where applicable.

type EndpointResolver 

type EndpointResolver interface {
	ResolveEndpoint(region string, options EndpointResolverOptions) (aws.Endpoint, error)
}

EndpointResolver interface for resolving service endpoints.

func EndpointResolverFromURL 

func EndpointResolverFromURL(url string, optFns ...func(*aws.Endpoint)) EndpointResolver

EndpointResolverFromURL returns an EndpointResolver configured using the provided endpoint url. By default, the resolved endpoint resolver uses the client region as signing region, and the endpoint source is set to EndpointSourceCustom.You can provide functional options to configure endpoint values for the resolved endpoint.

type EndpointResolverFunc 

type EndpointResolverFunc func(region string, options EndpointResolverOptions) (aws.Endpoint, error)

EndpointResolverFunc is a helper utility that wraps a function so it satisfies the EndpointResolver interface. This is useful when you want to add additional endpoint resolving logic, or stub out specific endpoints with custom values.

func (EndpointResolverFunc) ResolveEndpoint 

func (fn EndpointResolverFunc) ResolveEndpoint(region string, options EndpointResolverOptions) (endpoint aws.Endpoint, err error)

type EndpointResolverOptions 

type EndpointResolverOptions = internalendpoints.Options

EndpointResolverOptions is the service endpoint resolver options

type EndpointResolverV2 added in v1.32.0 

type EndpointResolverV2 interface {
	// ResolveEndpoint attempts to resolve the endpoint with the provided options,
	// returning the endpoint if found. Otherwise an error is returned.
	ResolveEndpoint(ctx context.Context, params EndpointParameters) (
		smithyendpoints.Endpoint, error,
	)
}

EndpointResolverV2 provides the interface for resolving service endpoints.

func NewDefaultEndpointResolverV2 added in v1.32.0 

func NewDefaultEndpointResolverV2() EndpointResolverV2

type GenerateBotElementInput added in v1.37.0 

type GenerateBotElementInput struct {

	// The bot unique Id for the bot request to generate utterances.
	//
	// This member is required.
	BotId *string

	// The bot version for the bot request to generate utterances.
	//
	// This member is required.
	BotVersion *string

	// The intent unique Id for the bot request to generate utterances.
	//
	// This member is required.
	IntentId *string

	// The unique locale Id for the bot request to generate utterances.
	//
	// This member is required.
	LocaleId *string
	// contains filtered or unexported fields
}

type GenerateBotElementOutput added in v1.37.0 

type GenerateBotElementOutput struct {

	// The unique bot Id for the bot which received the response.
	BotId *string

	// The unique bot version for the bot which received the response.
	BotVersion *string

	// The unique intent Id for the bot which received the response.
	IntentId *string

	// The unique locale Id for the bot which received the response.
	LocaleId *string

	// The sample utterances for the bot which received the response.
	SampleUtterances []types.SampleUtterance

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetTestExecutionArtifactsUrlInput added in v1.29.0 

type GetTestExecutionArtifactsUrlInput struct {

	// The unique identifier of the completed test execution.
	//
	// This member is required.
	TestExecutionId *string
	// contains filtered or unexported fields
}

type GetTestExecutionArtifactsUrlOutput added in v1.29.0 

type GetTestExecutionArtifactsUrlOutput struct {

	// The pre-signed Amazon S3 URL to download completed test execution.
	DownloadArtifactsUrl *string

	// The unique identifier of the completed test execution.
	TestExecutionId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type HTTPClient 

type HTTPClient interface {
	Do(*http.Request) (*http.Response, error)
}

type HTTPSignerV4 

type HTTPSignerV4 interface {
	SignHTTP(ctx context.Context, credentials aws.Credentials, r *http.Request, payloadHash string, service string, region string, signingTime time.Time, optFns ...func(*v4.SignerOptions)) error
}

type ListAggregatedUtterancesAPIClient added in v1.8.0 

type ListAggregatedUtterancesAPIClient interface {
	ListAggregatedUtterances(context.Context, *ListAggregatedUtterancesInput, ...func(*Options)) (*ListAggregatedUtterancesOutput, error)
}

ListAggregatedUtterancesAPIClient is a client that implements the ListAggregatedUtterances operation.

type ListAggregatedUtterancesInput added in v1.8.0 

type ListAggregatedUtterancesInput struct {

	// The time window for aggregating the utterance information. You can specify a
	// time between one hour and two weeks.
	//
	// This member is required.
	AggregationDuration *types.UtteranceAggregationDuration

	// The unique identifier of the bot associated with this request.
	//
	// This member is required.
	BotId *string

	// The identifier of the language and locale where the utterances were collected.
	// For more information, see Supported languages (https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html)
	// .
	//
	// This member is required.
	LocaleId *string

	// The identifier of the bot alias associated with this request. If you specify
	// the bot alias, you can't specify the bot version.
	BotAliasId *string

	// The identifier of the bot version associated with this request. If you specify
	// the bot version, you can't specify the bot alias.
	BotVersion *string

	// Provides the specification of a filter used to limit the utterances in the
	// response to only those that match the filter specification. You can only specify
	// one filter and one string to filter on.
	Filters []types.AggregatedUtterancesFilter

	// The maximum number of utterances to return in each page of results. If there
	// are fewer results than the maximum page size, only the actual number of results
	// are returned. If you don't specify the maxResults parameter, 1,000 results are
	// returned.
	MaxResults *int32

	// If the response from the ListAggregatedUtterances operation contains more
	// results that specified in the maxResults parameter, a token is returned in the
	// response. Use that token in the nextToken parameter to return the next page of
	// results.
	NextToken *string

	// Specifies sorting parameters for the list of utterances. You can sort by the
	// hit count, the missed count, or the number of distinct sessions the utterance
	// appeared in.
	SortBy *types.AggregatedUtterancesSortBy
	// contains filtered or unexported fields
}

type ListAggregatedUtterancesOutput added in v1.8.0 

type ListAggregatedUtterancesOutput struct {

	// Summaries of the aggregated utterance data. Each response contains information
	// about the number of times that the utterance was seen during the time period,
	// whether it was detected or missed, and when it was seen during the time period.
	AggregatedUtterancesSummaries []types.AggregatedUtterancesSummary

	// The time period used to aggregate the utterance data.
	AggregationDuration *types.UtteranceAggregationDuration

	// The last date and time that the aggregated data was collected. The time period
	// depends on the length of the aggregation window.
	//   - Hours - for 1 hour time window, every half hour; otherwise every hour.
	//   - Days - every 6 hours
	//   - Weeks - for a one week time window, every 12 hours; otherwise, every day
	AggregationLastRefreshedDateTime *time.Time

	// The date and time that the aggregation window ends. Only data collected between
	// the start time and the end time are returned in the results.
	AggregationWindowEndTime *time.Time

	// The date and time that the aggregation window begins. Only data collected after
	// this time is returned in the results.
	AggregationWindowStartTime *time.Time

	// The identifier of the bot alias that contains the utterances. If you specified
	// the bot version, the bot alias ID isn't returned.
	BotAliasId *string

	// The identifier of the bot that contains the utterances.
	BotId *string

	// The identifier of the bot version that contains the utterances. If you
	// specified the bot alias, the bot version isn't returned.
	BotVersion *string

	// The identifier of the language and locale that the utterances are in.
	LocaleId *string

	// A token that indicates whether there are more results to return in a response
	// to the ListAggregatedUtterances operation. If the nextToken field is present,
	// you send the contents as the nextToken parameter of a ListAggregatedUtterances
	// operation request to get the next page of results.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListAggregatedUtterancesPaginator added in v1.8.0 

type ListAggregatedUtterancesPaginator struct {
	// contains filtered or unexported fields
}

ListAggregatedUtterancesPaginator is a paginator for ListAggregatedUtterances

func NewListAggregatedUtterancesPaginator added in v1.8.0 

func NewListAggregatedUtterancesPaginator(client ListAggregatedUtterancesAPIClient, params *ListAggregatedUtterancesInput, optFns ...func(*ListAggregatedUtterancesPaginatorOptions)) *ListAggregatedUtterancesPaginator

NewListAggregatedUtterancesPaginator returns a new ListAggregatedUtterancesPaginator

func (*ListAggregatedUtterancesPaginator) HasMorePages added in v1.8.0 

func (p *ListAggregatedUtterancesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListAggregatedUtterancesPaginator) NextPage added in v1.8.0 

func (p *ListAggregatedUtterancesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListAggregatedUtterancesOutput, error)

NextPage retrieves the next ListAggregatedUtterances page.

type ListAggregatedUtterancesPaginatorOptions added in v1.8.0 

type ListAggregatedUtterancesPaginatorOptions struct {
	// The maximum number of utterances to return in each page of results. If there
	// are fewer results than the maximum page size, only the actual number of results
	// are returned. If you don't specify the maxResults parameter, 1,000 results are
	// returned.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListAggregatedUtterancesPaginatorOptions is the paginator options for ListAggregatedUtterances

type ListBotAliasReplicasAPIClient added in v1.39.0 

type ListBotAliasReplicasAPIClient interface {
	ListBotAliasReplicas(context.Context, *ListBotAliasReplicasInput, ...func(*Options)) (*ListBotAliasReplicasOutput, error)
}

ListBotAliasReplicasAPIClient is a client that implements the ListBotAliasReplicas operation.

type ListBotAliasReplicasInput added in v1.39.0 

type ListBotAliasReplicasInput struct {

	// The request for the unique bot ID of the replicated bot created from the source
	// bot alias.
	//
	// This member is required.
	BotId *string

	// The request for the secondary region of the replicated bot created from the
	// source bot alias.
	//
	// This member is required.
	ReplicaRegion *string

	// The request for maximum results to list the replicated bots created from the
	// source bot alias.
	MaxResults *int32

	// The request for the next token for the replicated bot created from the source
	// bot alias.
	NextToken *string
	// contains filtered or unexported fields
}

type ListBotAliasReplicasOutput added in v1.39.0 

type ListBotAliasReplicasOutput struct {

	// The summary information of the replicated bot created from the source bot alias.
	BotAliasReplicaSummaries []types.BotAliasReplicaSummary

	// The unique bot ID of the replicated bot created from the source bot alias.
	BotId *string

	// The next token for the replicated bots created from the source bot alias.
	NextToken *string

	// The secondary region of the replicated bot created from the source bot alias.
	ReplicaRegion *string

	// The source region of the replicated bot created from the source bot alias.
	SourceRegion *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListBotAliasReplicasPaginator added in v1.39.0 

type ListBotAliasReplicasPaginator struct {
	// contains filtered or unexported fields
}

ListBotAliasReplicasPaginator is a paginator for ListBotAliasReplicas

func NewListBotAliasReplicasPaginator added in v1.39.0 

func NewListBotAliasReplicasPaginator(client ListBotAliasReplicasAPIClient, params *ListBotAliasReplicasInput, optFns ...func(*ListBotAliasReplicasPaginatorOptions)) *ListBotAliasReplicasPaginator

NewListBotAliasReplicasPaginator returns a new ListBotAliasReplicasPaginator

func (*ListBotAliasReplicasPaginator) HasMorePages added in v1.39.0 

func (p *ListBotAliasReplicasPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListBotAliasReplicasPaginator) NextPage added in v1.39.0 

func (p *ListBotAliasReplicasPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListBotAliasReplicasOutput, error)

NextPage retrieves the next ListBotAliasReplicas page.

type ListBotAliasReplicasPaginatorOptions added in v1.39.0 

type ListBotAliasReplicasPaginatorOptions struct {
	// The request for maximum results to list the replicated bots created from the
	// source bot alias.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListBotAliasReplicasPaginatorOptions is the paginator options for ListBotAliasReplicas

type ListBotAliasesAPIClient 

type ListBotAliasesAPIClient interface {
	ListBotAliases(context.Context, *ListBotAliasesInput, ...func(*Options)) (*ListBotAliasesOutput, error)
}

ListBotAliasesAPIClient is a client that implements the ListBotAliases operation.

type ListBotAliasesInput 

type ListBotAliasesInput struct {

	// The identifier of the bot to list aliases for.
	//
	// This member is required.
	BotId *string

	// The maximum number of aliases to return in each page of results. If there are
	// fewer results than the max page size, only the actual number of results are
	// returned.
	MaxResults *int32

	// If the response from the ListBotAliases operation contains more results than
	// specified in the maxResults parameter, a token is returned in the response. Use
	// that token in the nextToken parameter to return the next page of results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListBotAliasesOutput 

type ListBotAliasesOutput struct {

	// Summary information for the bot aliases that meet the filter criteria specified
	// in the request. The length of the list is specified in the maxResults parameter
	// of the request. If there are more aliases available, the nextToken field
	// contains a token to get the next page of results.
	BotAliasSummaries []types.BotAliasSummary

	// The identifier of the bot associated with the aliases.
	BotId *string

	// A token that indicates whether there are more results to return in a response
	// to the ListBotAliases operation. If the nextToken field is present, you send
	// the contents as the nextToken parameter of a ListBotAliases operation request
	// to get the next page of results.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListBotAliasesPaginator 

type ListBotAliasesPaginator struct {
	// contains filtered or unexported fields
}

ListBotAliasesPaginator is a paginator for ListBotAliases

func NewListBotAliasesPaginator 

func NewListBotAliasesPaginator(client ListBotAliasesAPIClient, params *ListBotAliasesInput, optFns ...func(*ListBotAliasesPaginatorOptions)) *ListBotAliasesPaginator

NewListBotAliasesPaginator returns a new ListBotAliasesPaginator

func (*ListBotAliasesPaginator) HasMorePages 

func (p *ListBotAliasesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListBotAliasesPaginator) NextPage 

func (p *ListBotAliasesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListBotAliasesOutput, error)

NextPage retrieves the next ListBotAliases page.

type ListBotAliasesPaginatorOptions 

type ListBotAliasesPaginatorOptions struct {
	// The maximum number of aliases to return in each page of results. If there are
	// fewer results than the max page size, only the actual number of results are
	// returned.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListBotAliasesPaginatorOptions is the paginator options for ListBotAliases

type ListBotLocalesAPIClient 

type ListBotLocalesAPIClient interface {
	ListBotLocales(context.Context, *ListBotLocalesInput, ...func(*Options)) (*ListBotLocalesOutput, error)
}

ListBotLocalesAPIClient is a client that implements the ListBotLocales operation.

type ListBotLocalesInput 

type ListBotLocalesInput struct {

	// The identifier of the bot to list locales for.
	//
	// This member is required.
	BotId *string

	// The version of the bot to list locales for.
	//
	// This member is required.
	BotVersion *string

	// Provides the specification for a filter used to limit the response to only
	// those locales that match the filter specification. You can only specify one
	// filter and one value to filter on.
	Filters []types.BotLocaleFilter

	// The maximum number of aliases to return in each page of results. If there are
	// fewer results than the max page size, only the actual number of results are
	// returned.
	MaxResults *int32

	// If the response from the ListBotLocales operation contains more results than
	// specified in the maxResults parameter, a token is returned in the response. Use
	// that token as the nextToken parameter to return the next page of results.
	NextToken *string

	// Specifies sorting parameters for the list of locales. You can sort by locale
	// name in ascending or descending order.
	SortBy *types.BotLocaleSortBy
	// contains filtered or unexported fields
}

type ListBotLocalesOutput 

type ListBotLocalesOutput struct {

	// The identifier of the bot to list locales for.
	BotId *string

	// Summary information for the locales that meet the filter criteria specified in
	// the request. The length of the list is specified in the maxResults parameter of
	// the request. If there are more locales available, the nextToken field contains
	// a token to get the next page of results.
	BotLocaleSummaries []types.BotLocaleSummary

	// The version of the bot.
	BotVersion *string

	// A token that indicates whether there are more results to return in a response
	// to the ListBotLocales operation. If the nextToken field is present, you send
	// the contents as the nextToken parameter of a ListBotLocales operation request
	// to get the next page of results.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListBotLocalesPaginator 

type ListBotLocalesPaginator struct {
	// contains filtered or unexported fields
}

ListBotLocalesPaginator is a paginator for ListBotLocales

func NewListBotLocalesPaginator 

func NewListBotLocalesPaginator(client ListBotLocalesAPIClient, params *ListBotLocalesInput, optFns ...func(*ListBotLocalesPaginatorOptions)) *ListBotLocalesPaginator

NewListBotLocalesPaginator returns a new ListBotLocalesPaginator

func (*ListBotLocalesPaginator) HasMorePages 

func (p *ListBotLocalesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListBotLocalesPaginator) NextPage 

func (p *ListBotLocalesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListBotLocalesOutput, error)

NextPage retrieves the next ListBotLocales page.

type ListBotLocalesPaginatorOptions 

type ListBotLocalesPaginatorOptions struct {
	// The maximum number of aliases to return in each page of results. If there are
	// fewer results than the max page size, only the actual number of results are
	// returned.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListBotLocalesPaginatorOptions is the paginator options for ListBotLocales

type ListBotRecommendationsAPIClient added in v1.14.0 

type ListBotRecommendationsAPIClient interface {
	ListBotRecommendations(context.Context, *ListBotRecommendationsInput, ...func(*Options)) (*ListBotRecommendationsOutput, error)
}

ListBotRecommendationsAPIClient is a client that implements the ListBotRecommendations operation.

type ListBotRecommendationsInput added in v1.14.0 

type ListBotRecommendationsInput struct {

	// The unique identifier of the bot that contains the bot recommendation list.
	//
	// This member is required.
	BotId *string

	// The version of the bot that contains the bot recommendation list.
	//
	// This member is required.
	BotVersion *string

	// The identifier of the language and locale of the bot recommendation list.
	//
	// This member is required.
	LocaleId *string

	// The maximum number of bot recommendations to return in each page of results. If
	// there are fewer results than the max page size, only the actual number of
	// results are returned.
	MaxResults *int32

	// If the response from the ListBotRecommendation operation contains more results
	// than specified in the maxResults parameter, a token is returned in the response.
	// Use that token in the nextToken parameter to return the next page of results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListBotRecommendationsOutput added in v1.14.0 

type ListBotRecommendationsOutput struct {

	// The unique identifier of the bot that contains the bot recommendation list.
	BotId *string

	// Summary information for the bot recommendations that meet the filter specified
	// in this request. The length of the list is specified in the maxResults parameter
	// of the request. If there are more bot recommendations available, the nextToken
	// field contains a token to get the next page of results.
	BotRecommendationSummaries []types.BotRecommendationSummary

	// The version of the bot that contains the bot recommendation list.
	BotVersion *string

	// The identifier of the language and locale of the bot recommendation list.
	LocaleId *string

	// A token that indicates whether there are more results to return in a response
	// to the ListBotRecommendations operation. If the nextToken field is present, you
	// send the contents as the nextToken parameter of a ListBotRecommendations
	// operation request to get the next page of results.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListBotRecommendationsPaginator added in v1.14.0 

type ListBotRecommendationsPaginator struct {
	// contains filtered or unexported fields
}

ListBotRecommendationsPaginator is a paginator for ListBotRecommendations

func NewListBotRecommendationsPaginator added in v1.14.0 

func NewListBotRecommendationsPaginator(client ListBotRecommendationsAPIClient, params *ListBotRecommendationsInput, optFns ...func(*ListBotRecommendationsPaginatorOptions)) *ListBotRecommendationsPaginator

NewListBotRecommendationsPaginator returns a new ListBotRecommendationsPaginator

func (*ListBotRecommendationsPaginator) HasMorePages added in v1.14.0 

func (p *ListBotRecommendationsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListBotRecommendationsPaginator) NextPage added in v1.14.0 

func (p *ListBotRecommendationsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListBotRecommendationsOutput, error)

NextPage retrieves the next ListBotRecommendations page.

type ListBotRecommendationsPaginatorOptions added in v1.14.0 

type ListBotRecommendationsPaginatorOptions struct {
	// The maximum number of bot recommendations to return in each page of results. If
	// there are fewer results than the max page size, only the actual number of
	// results are returned.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListBotRecommendationsPaginatorOptions is the paginator options for ListBotRecommendations

type ListBotReplicasInput added in v1.39.0 

type ListBotReplicasInput struct {

	// The request for the unique bot IDs in the list of replicated bots.
	//
	// This member is required.
	BotId *string
	// contains filtered or unexported fields
}

type ListBotReplicasOutput added in v1.39.0 

type ListBotReplicasOutput struct {

	// the unique bot IDs in the list of replicated bots.
	BotId *string

	// The summary details for the replicated bots.
	BotReplicaSummaries []types.BotReplicaSummary

	// The source region of the source bots in the list of replicated bots.
	SourceRegion *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListBotResourceGenerationsAPIClient added in v1.37.0 

type ListBotResourceGenerationsAPIClient interface {
	ListBotResourceGenerations(context.Context, *ListBotResourceGenerationsInput, ...func(*Options)) (*ListBotResourceGenerationsOutput, error)
}

ListBotResourceGenerationsAPIClient is a client that implements the ListBotResourceGenerations operation.

type ListBotResourceGenerationsInput added in v1.37.0 

type ListBotResourceGenerationsInput struct {

	// The unique identifier of the bot whose generation requests you want to view.
	//
	// This member is required.
	BotId *string

	// The version of the bot whose generation requests you want to view.
	//
	// This member is required.
	BotVersion *string

	// The locale of the bot whose generation requests you want to view.
	//
	// This member is required.
	LocaleId *string

	// The maximum number of results to return in the response.
	MaxResults *int32

	// If the total number of results is greater than the number specified in the
	// maxResults , the response returns a token in the nextToken field. Use this
	// token when making a request to return the next batch of results.
	NextToken *string

	// An object containing information about the attribute and the method by which to
	// sort the results
	SortBy *types.GenerationSortBy
	// contains filtered or unexported fields
}

type ListBotResourceGenerationsOutput added in v1.37.0 

type ListBotResourceGenerationsOutput struct {

	// The unique identifier of the bot for which the generation requests were made.
	BotId *string

	// The version of the bot for which the generation requests were made.
	BotVersion *string

	// A list of objects, each containing information about a generation request for
	// the bot locale.
	GenerationSummaries []types.GenerationSummary

	// The locale of the bot for which the generation requests were made.
	LocaleId *string

	// If the total number of results is greater than the number specified in the
	// maxResults , the response returns a token in the nextToken field. Use this
	// token when making a request to return the next batch of results.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListBotResourceGenerationsPaginator added in v1.37.0 

type ListBotResourceGenerationsPaginator struct {
	// contains filtered or unexported fields
}

ListBotResourceGenerationsPaginator is a paginator for ListBotResourceGenerations

func NewListBotResourceGenerationsPaginator added in v1.37.0 

func NewListBotResourceGenerationsPaginator(client ListBotResourceGenerationsAPIClient, params *ListBotResourceGenerationsInput, optFns ...func(*ListBotResourceGenerationsPaginatorOptions)) *ListBotResourceGenerationsPaginator

NewListBotResourceGenerationsPaginator returns a new ListBotResourceGenerationsPaginator

func (*ListBotResourceGenerationsPaginator) HasMorePages added in v1.37.0 

func (p *ListBotResourceGenerationsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListBotResourceGenerationsPaginator) NextPage added in v1.37.0 

func (p *ListBotResourceGenerationsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListBotResourceGenerationsOutput, error)

NextPage retrieves the next ListBotResourceGenerations page.

type ListBotResourceGenerationsPaginatorOptions added in v1.37.0 

type ListBotResourceGenerationsPaginatorOptions struct {
	// The maximum number of results to return in the response.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListBotResourceGenerationsPaginatorOptions is the paginator options for ListBotResourceGenerations

type ListBotVersionReplicasAPIClient added in v1.39.0 

type ListBotVersionReplicasAPIClient interface {
	ListBotVersionReplicas(context.Context, *ListBotVersionReplicasInput, ...func(*Options)) (*ListBotVersionReplicasOutput, error)
}

ListBotVersionReplicasAPIClient is a client that implements the ListBotVersionReplicas operation.

type ListBotVersionReplicasInput added in v1.39.0 

type ListBotVersionReplicasInput struct {

	// The request for the unique ID in the list of replicated bots.
	//
	// This member is required.
	BotId *string

	// The request for the region used in the list of replicated bots.
	//
	// This member is required.
	ReplicaRegion *string

	// The maximum results given in the list of replicated bots.
	MaxResults *int32

	// The next token given in the list of replicated bots.
	NextToken *string

	// The requested sort category for the list of replicated bots.
	SortBy *types.BotVersionReplicaSortBy
	// contains filtered or unexported fields
}

type ListBotVersionReplicasOutput added in v1.39.0 

type ListBotVersionReplicasOutput struct {

	// The unique ID of the bots in the list of replicated bots.
	BotId *string

	// The information summary used for the replicated bots in the list of replicated
	// bots.
	BotVersionReplicaSummaries []types.BotVersionReplicaSummary

	// The next token used for the replicated bots in the list of replicated bots.
	NextToken *string

	// The region used for the replicated bots in the list of replicated bots.
	ReplicaRegion *string

	// The source region used for the bots in the list of replicated bots.
	SourceRegion *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListBotVersionReplicasPaginator added in v1.39.0 

type ListBotVersionReplicasPaginator struct {
	// contains filtered or unexported fields
}

ListBotVersionReplicasPaginator is a paginator for ListBotVersionReplicas

func NewListBotVersionReplicasPaginator added in v1.39.0 

func NewListBotVersionReplicasPaginator(client ListBotVersionReplicasAPIClient, params *ListBotVersionReplicasInput, optFns ...func(*ListBotVersionReplicasPaginatorOptions)) *ListBotVersionReplicasPaginator

NewListBotVersionReplicasPaginator returns a new ListBotVersionReplicasPaginator

func (*ListBotVersionReplicasPaginator) HasMorePages added in v1.39.0 

func (p *ListBotVersionReplicasPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListBotVersionReplicasPaginator) NextPage added in v1.39.0 

func (p *ListBotVersionReplicasPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListBotVersionReplicasOutput, error)

NextPage retrieves the next ListBotVersionReplicas page.

type ListBotVersionReplicasPaginatorOptions added in v1.39.0 

type ListBotVersionReplicasPaginatorOptions struct {
	// The maximum results given in the list of replicated bots.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListBotVersionReplicasPaginatorOptions is the paginator options for ListBotVersionReplicas

type ListBotVersionsAPIClient 

type ListBotVersionsAPIClient interface {
	ListBotVersions(context.Context, *ListBotVersionsInput, ...func(*Options)) (*ListBotVersionsOutput, error)
}

ListBotVersionsAPIClient is a client that implements the ListBotVersions operation.

type ListBotVersionsInput 

type ListBotVersionsInput struct {

	// The identifier of the bot to list versions for.
	//
	// This member is required.
	BotId *string

	// The maximum number of versions to return in each page of results. If there are
	// fewer results than the max page size, only the actual number of results are
	// returned.
	MaxResults *int32

	// If the response to the ListBotVersion operation contains more results than
	// specified in the maxResults parameter, a token is returned in the response. Use
	// that token in the nextToken parameter to return the next page of results.
	NextToken *string

	// Specifies sorting parameters for the list of versions. You can specify that the
	// list be sorted by version name in either ascending or descending order.
	SortBy *types.BotVersionSortBy
	// contains filtered or unexported fields
}

type ListBotVersionsOutput 

type ListBotVersionsOutput struct {

	// The identifier of the bot to list versions for.
	BotId *string

	// Summary information for the bot versions that meet the filter criteria
	// specified in the request. The length of the list is specified in the maxResults
	// parameter of the request. If there are more versions available, the nextToken
	// field contains a token to get the next page of results.
	BotVersionSummaries []types.BotVersionSummary

	// A token that indicates whether there are more results to return in a response
	// to the ListBotVersions operation. If the nextToken field is present, you send
	// the contents as the nextToken parameter of a ListBotAliases operation request
	// to get the next page of results.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListBotVersionsPaginator 

type ListBotVersionsPaginator struct {
	// contains filtered or unexported fields
}

ListBotVersionsPaginator is a paginator for ListBotVersions

func NewListBotVersionsPaginator 

func NewListBotVersionsPaginator(client ListBotVersionsAPIClient, params *ListBotVersionsInput, optFns ...func(*ListBotVersionsPaginatorOptions)) *ListBotVersionsPaginator

NewListBotVersionsPaginator returns a new ListBotVersionsPaginator

func (*ListBotVersionsPaginator) HasMorePages 

func (p *ListBotVersionsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListBotVersionsPaginator) NextPage 

func (p *ListBotVersionsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListBotVersionsOutput, error)

NextPage retrieves the next ListBotVersions page.

type ListBotVersionsPaginatorOptions 

type ListBotVersionsPaginatorOptions struct {
	// The maximum number of versions to return in each page of results. If there are
	// fewer results than the max page size, only the actual number of results are
	// returned.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListBotVersionsPaginatorOptions is the paginator options for ListBotVersions

type ListBotsAPIClient 

type ListBotsAPIClient interface {
	ListBots(context.Context, *ListBotsInput, ...func(*Options)) (*ListBotsOutput, error)
}

ListBotsAPIClient is a client that implements the ListBots operation.

type ListBotsInput 

type ListBotsInput struct {

	// Provides the specification of a filter used to limit the bots in the response
	// to only those that match the filter specification. You can only specify one
	// filter and one string to filter on.
	Filters []types.BotFilter

	// The maximum number of bots to return in each page of results. If there are
	// fewer results than the maximum page size, only the actual number of results are
	// returned.
	MaxResults *int32

	// If the response from the ListBots operation contains more results than
	// specified in the maxResults parameter, a token is returned in the response. Use
	// the returned token in the nextToken parameter of a ListBots request to return
	// the next page of results. For a complete set of results, call the ListBots
	// operation until the nextToken returned in the response is null.
	NextToken *string

	// Specifies sorting parameters for the list of bots. You can specify that the
	// list be sorted by bot name in ascending or descending order.
	SortBy *types.BotSortBy
	// contains filtered or unexported fields
}

type ListBotsOutput 

type ListBotsOutput struct {

	// Summary information for the bots that meet the filter criteria specified in the
	// request. The length of the list is specified in the maxResults parameter of the
	// request. If there are more bots available, the nextToken field contains a token
	// to the next page of results.
	BotSummaries []types.BotSummary

	// A token that indicates whether there are more results to return in a response
	// to the ListBots operation. If the nextToken field is present, you send the
	// contents as the nextToken parameter of a ListBots operation request to get the
	// next page of results.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListBotsPaginator 

type ListBotsPaginator struct {
	// contains filtered or unexported fields
}

ListBotsPaginator is a paginator for ListBots

func NewListBotsPaginator 

func NewListBotsPaginator(client ListBotsAPIClient, params *ListBotsInput, optFns ...func(*ListBotsPaginatorOptions)) *ListBotsPaginator

NewListBotsPaginator returns a new ListBotsPaginator

func (*ListBotsPaginator) HasMorePages 

func (p *ListBotsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListBotsPaginator) NextPage 

func (p *ListBotsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListBotsOutput, error)

NextPage retrieves the next ListBots page.

type ListBotsPaginatorOptions 

type ListBotsPaginatorOptions struct {
	// The maximum number of bots to return in each page of results. If there are
	// fewer results than the maximum page size, only the actual number of results are
	// returned.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListBotsPaginatorOptions is the paginator options for ListBots

type ListBuiltInIntentsAPIClient 

type ListBuiltInIntentsAPIClient interface {
	ListBuiltInIntents(context.Context, *ListBuiltInIntentsInput, ...func(*Options)) (*ListBuiltInIntentsOutput, error)
}

ListBuiltInIntentsAPIClient is a client that implements the ListBuiltInIntents operation.

type ListBuiltInIntentsInput 

type ListBuiltInIntentsInput struct {

	// The identifier of the language and locale of the intents to list. The string
	// must match one of the supported locales. For more information, see Supported
	// languages (https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html) .
	//
	// This member is required.
	LocaleId *string

	// The maximum number of built-in intents to return in each page of results. If
	// there are fewer results than the max page size, only the actual number of
	// results are returned.
	MaxResults *int32

	// If the response from the ListBuiltInIntents operation contains more results
	// than specified in the maxResults parameter, a token is returned in the
	// response. Use that token in the nextToken parameter to return the next page of
	// results.
	NextToken *string

	// Specifies sorting parameters for the list of built-in intents. You can specify
	// that the list be sorted by the built-in intent signature in either ascending or
	// descending order.
	SortBy *types.BuiltInIntentSortBy
	// contains filtered or unexported fields
}

type ListBuiltInIntentsOutput 

type ListBuiltInIntentsOutput struct {

	// Summary information for the built-in intents that meet the filter criteria
	// specified in the request. The length of the list is specified in the maxResults
	// parameter of the request. If there are more intents available, the nextToken
	// field contains a token to get the next page of results.
	BuiltInIntentSummaries []types.BuiltInIntentSummary

	// The language and locale of the intents in the list.
	LocaleId *string

	// A token that indicates whether there are more results to return in a response
	// to the ListBuiltInIntents operation. If the nextToken field is present, you
	// send the contents as the nextToken parameter of a ListBotAliases operation
	// request to get the next page of results.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListBuiltInIntentsPaginator 

type ListBuiltInIntentsPaginator struct {
	// contains filtered or unexported fields
}

ListBuiltInIntentsPaginator is a paginator for ListBuiltInIntents

func NewListBuiltInIntentsPaginator 

func NewListBuiltInIntentsPaginator(client ListBuiltInIntentsAPIClient, params *ListBuiltInIntentsInput, optFns ...func(*ListBuiltInIntentsPaginatorOptions)) *ListBuiltInIntentsPaginator

NewListBuiltInIntentsPaginator returns a new ListBuiltInIntentsPaginator

func (*ListBuiltInIntentsPaginator) HasMorePages 

func (p *ListBuiltInIntentsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListBuiltInIntentsPaginator) NextPage 

func (p *ListBuiltInIntentsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListBuiltInIntentsOutput, error)

NextPage retrieves the next ListBuiltInIntents page.

type ListBuiltInIntentsPaginatorOptions 

type ListBuiltInIntentsPaginatorOptions struct {
	// The maximum number of built-in intents to return in each page of results. If
	// there are fewer results than the max page size, only the actual number of
	// results are returned.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListBuiltInIntentsPaginatorOptions is the paginator options for ListBuiltInIntents

type ListBuiltInSlotTypesAPIClient 

type ListBuiltInSlotTypesAPIClient interface {
	ListBuiltInSlotTypes(context.Context, *ListBuiltInSlotTypesInput, ...func(*Options)) (*ListBuiltInSlotTypesOutput, error)
}

ListBuiltInSlotTypesAPIClient is a client that implements the ListBuiltInSlotTypes operation.

type ListBuiltInSlotTypesInput 

type ListBuiltInSlotTypesInput struct {

	// The identifier of the language and locale of the slot types to list. The string
	// must match one of the supported locales. For more information, see Supported
	// languages (https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html) .
	//
	// This member is required.
	LocaleId *string

	// The maximum number of built-in slot types to return in each page of results. If
	// there are fewer results than the max page size, only the actual number of
	// results are returned.
	MaxResults *int32

	// If the response from the ListBuiltInSlotTypes operation contains more results
	// than specified in the maxResults parameter, a token is returned in the
	// response. Use that token in the nextToken parameter to return the next page of
	// results.
	NextToken *string

	// Determines the sort order for the response from the ListBuiltInSlotTypes
	// operation. You can choose to sort by the slot type signature in either ascending
	// or descending order.
	SortBy *types.BuiltInSlotTypeSortBy
	// contains filtered or unexported fields
}

type ListBuiltInSlotTypesOutput 

type ListBuiltInSlotTypesOutput struct {

	// Summary information for the built-in slot types that meet the filter criteria
	// specified in the request. The length of the list is specified in the maxResults
	// parameter of the request. If there are more slot types available, the nextToken
	// field contains a token to get the next page of results.
	BuiltInSlotTypeSummaries []types.BuiltInSlotTypeSummary

	// The language and locale of the slot types in the list.
	LocaleId *string

	// A token that indicates whether there are more results to return in a response
	// to the ListBuiltInSlotTypes operation. If the nextToken field is present, you
	// send the contents as the nextToken parameter of a LIstBuiltInSlotTypes
	// operation request to get the next page of results.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListBuiltInSlotTypesPaginator 

type ListBuiltInSlotTypesPaginator struct {
	// contains filtered or unexported fields
}

ListBuiltInSlotTypesPaginator is a paginator for ListBuiltInSlotTypes

func NewListBuiltInSlotTypesPaginator 

func NewListBuiltInSlotTypesPaginator(client ListBuiltInSlotTypesAPIClient, params *ListBuiltInSlotTypesInput, optFns ...func(*ListBuiltInSlotTypesPaginatorOptions)) *ListBuiltInSlotTypesPaginator

NewListBuiltInSlotTypesPaginator returns a new ListBuiltInSlotTypesPaginator

func (*ListBuiltInSlotTypesPaginator) HasMorePages 

func (p *ListBuiltInSlotTypesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListBuiltInSlotTypesPaginator) NextPage 

func (p *ListBuiltInSlotTypesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListBuiltInSlotTypesOutput, error)

NextPage retrieves the next ListBuiltInSlotTypes page.

type ListBuiltInSlotTypesPaginatorOptions 

type ListBuiltInSlotTypesPaginatorOptions struct {
	// The maximum number of built-in slot types to return in each page of results. If
	// there are fewer results than the max page size, only the actual number of
	// results are returned.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListBuiltInSlotTypesPaginatorOptions is the paginator options for ListBuiltInSlotTypes

type ListCustomVocabularyItemsAPIClient added in v1.26.0 

type ListCustomVocabularyItemsAPIClient interface {
	ListCustomVocabularyItems(context.Context, *ListCustomVocabularyItemsInput, ...func(*Options)) (*ListCustomVocabularyItemsOutput, error)
}

ListCustomVocabularyItemsAPIClient is a client that implements the ListCustomVocabularyItems operation.

type ListCustomVocabularyItemsInput added in v1.26.0 

type ListCustomVocabularyItemsInput struct {

	// The identifier of the version of the bot associated with this custom vocabulary.
	//
	// This member is required.
	BotId *string

	// The bot version of the bot to the list custom vocabulary request.
	//
	// This member is required.
	BotVersion *string

	// The identifier of the language and locale where this custom vocabulary is used.
	// The string must match one of the supported locales. For more information, see
	// Supported languages
	// (https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html).
	//
	// This member is required.
	LocaleId *string

	// The maximum number of items returned by the list operation.
	MaxResults *int32

	// The nextToken identifier to the list custom vocabulary request.
	NextToken *string
	// contains filtered or unexported fields
}

type ListCustomVocabularyItemsOutput added in v1.26.0 

type ListCustomVocabularyItemsOutput struct {

	// The identifier of the bot associated with this custom vocabulary.
	BotId *string

	// The identifier of the version of the bot associated with this custom vocabulary.
	BotVersion *string

	// The custom vocabulary items from the list custom vocabulary response.
	CustomVocabularyItems []types.CustomVocabularyItem

	// The identifier of the language and locale where this custom vocabulary is used.
	// The string must match one of the supported locales. For more information, see
	// Supported Languages  (https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html)
	// .
	LocaleId *string

	// The nextToken identifier to the list custom vocabulary response.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListCustomVocabularyItemsPaginator added in v1.26.0 

type ListCustomVocabularyItemsPaginator struct {
	// contains filtered or unexported fields
}

ListCustomVocabularyItemsPaginator is a paginator for ListCustomVocabularyItems

func NewListCustomVocabularyItemsPaginator added in v1.26.0 

func NewListCustomVocabularyItemsPaginator(client ListCustomVocabularyItemsAPIClient, params *ListCustomVocabularyItemsInput, optFns ...func(*ListCustomVocabularyItemsPaginatorOptions)) *ListCustomVocabularyItemsPaginator

NewListCustomVocabularyItemsPaginator returns a new ListCustomVocabularyItemsPaginator

func (*ListCustomVocabularyItemsPaginator) HasMorePages added in v1.26.0 

func (p *ListCustomVocabularyItemsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListCustomVocabularyItemsPaginator) NextPage added in v1.26.0 

func (p *ListCustomVocabularyItemsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListCustomVocabularyItemsOutput, error)

NextPage retrieves the next ListCustomVocabularyItems page.

type ListCustomVocabularyItemsPaginatorOptions added in v1.26.0 

type ListCustomVocabularyItemsPaginatorOptions struct {
	// The maximum number of items returned by the list operation.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListCustomVocabularyItemsPaginatorOptions is the paginator options for ListCustomVocabularyItems

type ListExportsAPIClient added in v1.2.0 

type ListExportsAPIClient interface {
	ListExports(context.Context, *ListExportsInput, ...func(*Options)) (*ListExportsOutput, error)
}

ListExportsAPIClient is a client that implements the ListExports operation.

type ListExportsInput added in v1.2.0 

type ListExportsInput struct {

	// The unique identifier that Amazon Lex assigned to the bot.
	BotId *string

	// The version of the bot to list exports for.
	BotVersion *string

	// Provides the specification of a filter used to limit the exports in the
	// response to only those that match the filter specification. You can only specify
	// one filter and one string to filter on.
	Filters []types.ExportFilter

	// Specifies the resources that should be exported. If you don't specify a
	// resource type in the filters parameter, both bot locales and custom
	// vocabularies are exported.
	LocaleId *string

	// The maximum number of exports to return in each page of results. If there are
	// fewer results than the max page size, only the actual number of results are
	// returned.
	MaxResults *int32

	// If the response from the ListExports operation contains more results that
	// specified in the maxResults parameter, a token is returned in the response. Use
	// the returned token in the nextToken parameter of a ListExports request to
	// return the next page of results. For a complete set of results, call the
	// ListExports operation until the nextToken returned in the response is null.
	NextToken *string

	// Determines the field that the list of exports is sorted by. You can sort by the
	// LastUpdatedDateTime field in ascending or descending order.
	SortBy *types.ExportSortBy
	// contains filtered or unexported fields
}

type ListExportsOutput added in v1.2.0 

type ListExportsOutput struct {

	// The unique identifier assigned to the bot by Amazon Lex.
	BotId *string

	// The version of the bot that was exported.
	BotVersion *string

	// Summary information for the exports that meet the filter criteria specified in
	// the request. The length of the list is specified in the maxResults parameter.
	// If there are more exports available, the nextToken field contains a token to
	// get the next page of results.
	ExportSummaries []types.ExportSummary

	// The locale specified in the request.
	LocaleId *string

	// A token that indicates whether there are more results to return in a response
	// to the ListExports operation. If the nextToken field is present, you send the
	// contents as the nextToken parameter of a ListExports operation request to get
	// the next page of results.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListExportsPaginator added in v1.2.0 

type ListExportsPaginator struct {
	// contains filtered or unexported fields
}

ListExportsPaginator is a paginator for ListExports

func NewListExportsPaginator added in v1.2.0 

func NewListExportsPaginator(client ListExportsAPIClient, params *ListExportsInput, optFns ...func(*ListExportsPaginatorOptions)) *ListExportsPaginator

NewListExportsPaginator returns a new ListExportsPaginator

func (*ListExportsPaginator) HasMorePages added in v1.2.0 

func (p *ListExportsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListExportsPaginator) NextPage added in v1.2.0 

func (p *ListExportsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListExportsOutput, error)

NextPage retrieves the next ListExports page.

type ListExportsPaginatorOptions added in v1.2.0 

type ListExportsPaginatorOptions struct {
	// The maximum number of exports to return in each page of results. If there are
	// fewer results than the max page size, only the actual number of results are
	// returned.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListExportsPaginatorOptions is the paginator options for ListExports

type ListImportsAPIClient added in v1.2.0 

type ListImportsAPIClient interface {
	ListImports(context.Context, *ListImportsInput, ...func(*Options)) (*ListImportsOutput, error)
}

ListImportsAPIClient is a client that implements the ListImports operation.

type ListImportsInput added in v1.2.0 

type ListImportsInput struct {

	// The unique identifier that Amazon Lex assigned to the bot.
	BotId *string

	// The version of the bot to list imports for.
	BotVersion *string

	// Provides the specification of a filter used to limit the bots in the response
	// to only those that match the filter specification. You can only specify one
	// filter and one string to filter on.
	Filters []types.ImportFilter

	// Specifies the locale that should be present in the list. If you don't specify a
	// resource type in the filters parameter, the list contains both bot locales and
	// custom vocabularies.
	LocaleId *string

	// The maximum number of imports to return in each page of results. If there are
	// fewer results than the max page size, only the actual number of results are
	// returned.
	MaxResults *int32

	// If the response from the ListImports operation contains more results than
	// specified in the maxResults parameter, a token is returned in the response. Use
	// the returned token in the nextToken parameter of a ListImports request to
	// return the next page of results. For a complete set of results, call the
	// ListImports operation until the nextToken returned in the response is null.
	NextToken *string

	// Determines the field that the list of imports is sorted by. You can sort by the
	// LastUpdatedDateTime field in ascending or descending order.
	SortBy *types.ImportSortBy
	// contains filtered or unexported fields
}

type ListImportsOutput added in v1.2.0 

type ListImportsOutput struct {

	// The unique identifier assigned by Amazon Lex to the bot.
	BotId *string

	// The version of the bot that was imported. It will always be DRAFT .
	BotVersion *string

	// Summary information for the imports that meet the filter criteria specified in
	// the request. The length of the list is specified in the maxResults parameter.
	// If there are more imports available, the nextToken field contains a token to
	// get the next page of results.
	ImportSummaries []types.ImportSummary

	// The locale specified in the request.
	LocaleId *string

	// A token that indicates whether there are more results to return in a response
	// to the ListImports operation. If the nextToken field is present, you send the
	// contents as the nextToken parameter of a ListImports operation request to get
	// the next page of results.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListImportsPaginator added in v1.2.0 

type ListImportsPaginator struct {
	// contains filtered or unexported fields
}

ListImportsPaginator is a paginator for ListImports

func NewListImportsPaginator added in v1.2.0 

func NewListImportsPaginator(client ListImportsAPIClient, params *ListImportsInput, optFns ...func(*ListImportsPaginatorOptions)) *ListImportsPaginator

NewListImportsPaginator returns a new ListImportsPaginator

func (*ListImportsPaginator) HasMorePages added in v1.2.0 

func (p *ListImportsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListImportsPaginator) NextPage added in v1.2.0 

func (p *ListImportsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListImportsOutput, error)

NextPage retrieves the next ListImports page.

type ListImportsPaginatorOptions added in v1.2.0 

type ListImportsPaginatorOptions struct {
	// The maximum number of imports to return in each page of results. If there are
	// fewer results than the max page size, only the actual number of results are
	// returned.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListImportsPaginatorOptions is the paginator options for ListImports

type ListIntentMetricsAPIClient added in v1.30.0 

type ListIntentMetricsAPIClient interface {
	ListIntentMetrics(context.Context, *ListIntentMetricsInput, ...func(*Options)) (*ListIntentMetricsOutput, error)
}

ListIntentMetricsAPIClient is a client that implements the ListIntentMetrics operation.

type ListIntentMetricsInput added in v1.30.0 

type ListIntentMetricsInput struct {

	// The identifier for the bot for which you want to retrieve intent metrics.
	//
	// This member is required.
	BotId *string

	// The date and time that marks the end of the range of time for which you want to
	// see intent metrics.
	//
	// This member is required.
	EndDateTime *time.Time

	// A list of objects, each of which contains a metric you want to list, the
	// statistic for the metric you want to return, and the order by which to organize
	// the results.
	//
	// This member is required.
	Metrics []types.AnalyticsIntentMetric

	// The timestamp that marks the beginning of the range of time for which you want
	// to see intent metrics.
	//
	// This member is required.
	StartDateTime *time.Time

	// A list of objects, each of which contains specifications for organizing the
	// results by time.
	BinBy []types.AnalyticsBinBySpecification

	// A list of objects, each of which describes a condition by which you want to
	// filter the results.
	Filters []types.AnalyticsIntentFilter

	// A list of objects, each of which specifies how to group the results. You can
	// group by the following criteria:
	//   - IntentName – The name of the intent.
	//   - IntentEndState – The final state of the intent. The possible end states are
	//   detailed in Key definitions (https://docs.aws.amazon.com/analytics-key-definitions-intents)
	//   in the user guide.
	GroupBy []types.AnalyticsIntentGroupBySpecification

	// The maximum number of results to return in each page of results. If there are
	// fewer results than the maximum page size, only the actual number of results are
	// returned.
	MaxResults *int32

	// If the response from the ListIntentMetrics operation contains more results than
	// specified in the maxResults parameter, a token is returned in the response. Use
	// the returned token in the nextToken parameter of a ListIntentMetrics request to
	// return the next page of results. For a complete set of results, call the
	// ListIntentMetrics operation until the nextToken returned in the response is
	// null.
	NextToken *string
	// contains filtered or unexported fields
}

type ListIntentMetricsOutput added in v1.30.0 

type ListIntentMetricsOutput struct {

	// The identifier for the bot for which you retrieved intent metrics.
	BotId *string

	// If the response from the ListIntentMetrics operation contains more results than
	// specified in the maxResults parameter, a token is returned in the response. Use
	// the returned token in the nextToken parameter of a ListIntentMetrics request to
	// return the next page of results. For a complete set of results, call the
	// ListIntentMetrics operation until the nextToken returned in the response is
	// null.
	NextToken *string

	// The results for the intent metrics.
	Results []types.AnalyticsIntentResult

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListIntentMetricsPaginator added in v1.30.0 

type ListIntentMetricsPaginator struct {
	// contains filtered or unexported fields
}

ListIntentMetricsPaginator is a paginator for ListIntentMetrics

func NewListIntentMetricsPaginator added in v1.30.0 

func NewListIntentMetricsPaginator(client ListIntentMetricsAPIClient, params *ListIntentMetricsInput, optFns ...func(*ListIntentMetricsPaginatorOptions)) *ListIntentMetricsPaginator

NewListIntentMetricsPaginator returns a new ListIntentMetricsPaginator

func (*ListIntentMetricsPaginator) HasMorePages added in v1.30.0 

func (p *ListIntentMetricsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListIntentMetricsPaginator) NextPage added in v1.30.0 

func (p *ListIntentMetricsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListIntentMetricsOutput, error)

NextPage retrieves the next ListIntentMetrics page.

type ListIntentMetricsPaginatorOptions added in v1.30.0 

type ListIntentMetricsPaginatorOptions struct {
	// The maximum number of results to return in each page of results. If there are
	// fewer results than the maximum page size, only the actual number of results are
	// returned.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListIntentMetricsPaginatorOptions is the paginator options for ListIntentMetrics

type ListIntentPathsInput added in v1.30.0 

type ListIntentPathsInput struct {

	// The identifier for the bot for which you want to retrieve intent path metrics.
	//
	// This member is required.
	BotId *string

	// The date and time that marks the end of the range of time for which you want to
	// see intent path metrics.
	//
	// This member is required.
	EndDateTime *time.Time

	// The intent path for which you want to retrieve metrics. Use a forward slash to
	// separate intents in the path. For example:
	//   - /BookCar
	//   - /BookCar/BookHotel
	//   - /BookHotel/BookCar
	//
	// This member is required.
	IntentPath *string

	// The date and time that marks the beginning of the range of time for which you
	// want to see intent path metrics.
	//
	// This member is required.
	StartDateTime *time.Time

	// A list of objects, each describes a condition by which you want to filter the
	// results.
	Filters []types.AnalyticsPathFilter
	// contains filtered or unexported fields
}

type ListIntentPathsOutput added in v1.30.0 

type ListIntentPathsOutput struct {

	// A list of objects, each of which contains information about a node in the
	// intent path for which you requested metrics.
	NodeSummaries []types.AnalyticsIntentNodeSummary

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListIntentStageMetricsAPIClient added in v1.30.0 

type ListIntentStageMetricsAPIClient interface {
	ListIntentStageMetrics(context.Context, *ListIntentStageMetricsInput, ...func(*Options)) (*ListIntentStageMetricsOutput, error)
}

ListIntentStageMetricsAPIClient is a client that implements the ListIntentStageMetrics operation.

type ListIntentStageMetricsInput added in v1.30.0 

type ListIntentStageMetricsInput struct {

	// The identifier for the bot for which you want to retrieve intent stage metrics.
	//
	// This member is required.
	BotId *string

	// The date and time that marks the end of the range of time for which you want to
	// see intent stage metrics.
	//
	// This member is required.
	EndDateTime *time.Time

	// A list of objects, each of which contains a metric you want to list, the
	// statistic for the metric you want to return, and the method by which to organize
	// the results.
	//
	// This member is required.
	Metrics []types.AnalyticsIntentStageMetric

	// The date and time that marks the beginning of the range of time for which you
	// want to see intent stage metrics.
	//
	// This member is required.
	StartDateTime *time.Time

	// A list of objects, each of which contains specifications for organizing the
	// results by time.
	BinBy []types.AnalyticsBinBySpecification

	// A list of objects, each of which describes a condition by which you want to
	// filter the results.
	Filters []types.AnalyticsIntentStageFilter

	// A list of objects, each of which specifies how to group the results. You can
	// group by the following criteria:
	//   - IntentStageName – The name of the intent stage.
	//   - SwitchedToIntent – The intent to which the conversation was switched (if
	//   any).
	GroupBy []types.AnalyticsIntentStageGroupBySpecification

	// The maximum number of results to return in each page of results. If there are
	// fewer results than the maximum page size, only the actual number of results are
	// returned.
	MaxResults *int32

	// If the response from the ListIntentStageMetrics operation contains more results
	// than specified in the maxResults parameter, a token is returned in the response.
	// Use the returned token in the nextToken parameter of a ListIntentStageMetrics
	// request to return the next page of results. For a complete set of results, call
	// the ListIntentStageMetrics operation until the nextToken returned in the
	// response is null.
	NextToken *string
	// contains filtered or unexported fields
}

type ListIntentStageMetricsOutput added in v1.30.0 

type ListIntentStageMetricsOutput struct {

	// The identifier for the bot for which you retrieved intent stage metrics.
	BotId *string

	// If the response from the ListIntentStageMetrics operation contains more results
	// than specified in the maxResults parameter, a token is returned in the response.
	// Use the returned token in the nextToken parameter of a ListIntentStageMetrics
	// request to return the next page of results. For a complete set of results, call
	// the ListIntentStageMetrics operation until the nextToken returned in the
	// response is null.
	NextToken *string

	// The results for the intent stage metrics.
	Results []types.AnalyticsIntentStageResult

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListIntentStageMetricsPaginator added in v1.30.0 

type ListIntentStageMetricsPaginator struct {
	// contains filtered or unexported fields
}

ListIntentStageMetricsPaginator is a paginator for ListIntentStageMetrics

func NewListIntentStageMetricsPaginator added in v1.30.0 

func NewListIntentStageMetricsPaginator(client ListIntentStageMetricsAPIClient, params *ListIntentStageMetricsInput, optFns ...func(*ListIntentStageMetricsPaginatorOptions)) *ListIntentStageMetricsPaginator

NewListIntentStageMetricsPaginator returns a new ListIntentStageMetricsPaginator

func (*ListIntentStageMetricsPaginator) HasMorePages added in v1.30.0 

func (p *ListIntentStageMetricsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListIntentStageMetricsPaginator) NextPage added in v1.30.0 

func (p *ListIntentStageMetricsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListIntentStageMetricsOutput, error)

NextPage retrieves the next ListIntentStageMetrics page.

type ListIntentStageMetricsPaginatorOptions added in v1.30.0 

type ListIntentStageMetricsPaginatorOptions struct {
	// The maximum number of results to return in each page of results. If there are
	// fewer results than the maximum page size, only the actual number of results are
	// returned.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListIntentStageMetricsPaginatorOptions is the paginator options for ListIntentStageMetrics

type ListIntentsAPIClient 

type ListIntentsAPIClient interface {
	ListIntents(context.Context, *ListIntentsInput, ...func(*Options)) (*ListIntentsOutput, error)
}

ListIntentsAPIClient is a client that implements the ListIntents operation.

type ListIntentsInput 

type ListIntentsInput struct {

	// The unique identifier of the bot that contains the intent.
	//
	// This member is required.
	BotId *string

	// The version of the bot that contains the intent.
	//
	// This member is required.
	BotVersion *string

	// The identifier of the language and locale of the intents to list. The string
	// must match one of the supported locales. For more information, see Supported
	// languages (https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html) .
	//
	// This member is required.
	LocaleId *string

	// Provides the specification of a filter used to limit the intents in the
	// response to only those that match the filter specification. You can only specify
	// one filter and only one string to filter on.
	Filters []types.IntentFilter

	// The maximum number of intents to return in each page of results. If there are
	// fewer results than the max page size, only the actual number of results are
	// returned.
	MaxResults *int32

	// If the response from the ListIntents operation contains more results than
	// specified in the maxResults parameter, a token is returned in the response. Use
	// the returned token in the nextToken parameter of a ListIntents request to
	// return the next page of results. For a complete set of results, call the
	// ListIntents operation until the nextToken returned in the response is null.
	NextToken *string

	// Determines the sort order for the response from the ListIntents operation. You
	// can choose to sort by the intent name or last updated date in either ascending
	// or descending order.
	SortBy *types.IntentSortBy
	// contains filtered or unexported fields
}

type ListIntentsOutput 

type ListIntentsOutput struct {

	// The identifier of the bot that contains the intent.
	BotId *string

	// The version of the bot that contains the intent.
	BotVersion *string

	// Summary information for the intents that meet the filter criteria specified in
	// the request. The length of the list is specified in the maxResults parameter of
	// the request. If there are more intents available, the nextToken field contains
	// a token to get the next page of results.
	IntentSummaries []types.IntentSummary

	// The language and locale of the intents in the list.
	LocaleId *string

	// A token that indicates whether there are more results to return in a response
	// to the ListIntents operation. If the nextToken field is present, you send the
	// contents as the nextToken parameter of a ListIntents operation request to get
	// the next page of results.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListIntentsPaginator 

type ListIntentsPaginator struct {
	// contains filtered or unexported fields
}

ListIntentsPaginator is a paginator for ListIntents

func NewListIntentsPaginator 

func NewListIntentsPaginator(client ListIntentsAPIClient, params *ListIntentsInput, optFns ...func(*ListIntentsPaginatorOptions)) *ListIntentsPaginator

NewListIntentsPaginator returns a new ListIntentsPaginator

func (*ListIntentsPaginator) HasMorePages 

func (p *ListIntentsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListIntentsPaginator) NextPage 

func (p *ListIntentsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListIntentsOutput, error)

NextPage retrieves the next ListIntents page.

type ListIntentsPaginatorOptions 

type ListIntentsPaginatorOptions struct {
	// The maximum number of intents to return in each page of results. If there are
	// fewer results than the max page size, only the actual number of results are
	// returned.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListIntentsPaginatorOptions is the paginator options for ListIntents

type ListRecommendedIntentsAPIClient added in v1.14.0 

type ListRecommendedIntentsAPIClient interface {
	ListRecommendedIntents(context.Context, *ListRecommendedIntentsInput, ...func(*Options)) (*ListRecommendedIntentsOutput, error)
}

ListRecommendedIntentsAPIClient is a client that implements the ListRecommendedIntents operation.

type ListRecommendedIntentsInput added in v1.14.0 

type ListRecommendedIntentsInput struct {

	// The unique identifier of the bot associated with the recommended intents.
	//
	// This member is required.
	BotId *string

	// The identifier of the bot recommendation that contains the recommended intents.
	//
	// This member is required.
	BotRecommendationId *string

	// The version of the bot that contains the recommended intents.
	//
	// This member is required.
	BotVersion *string

	// The identifier of the language and locale of the recommended intents.
	//
	// This member is required.
	LocaleId *string

	// The maximum number of bot recommendations to return in each page of results. If
	// there are fewer results than the max page size, only the actual number of
	// results are returned.
	MaxResults *int32

	// If the response from the ListRecommendedIntents operation contains more results
	// than specified in the maxResults parameter, a token is returned in the response.
	// Use that token in the nextToken parameter to return the next page of results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListRecommendedIntentsOutput added in v1.14.0 

type ListRecommendedIntentsOutput struct {

	// The unique identifier of the bot associated with the recommended intent.
	BotId *string

	// The identifier of the bot recommendation that contains the recommended intent.
	BotRecommendationId *string

	// The version of the bot that contains the intent.
	BotVersion *string

	// The identifier of the language and locale of the intents to list. The string
	// must match one of the supported locales. For more information, see Supported
	// languages (https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html) .
	LocaleId *string

	// A token that indicates whether there are more results to return in a response
	// to the ListRecommendedIntents operation. If the nextToken field is present, you
	// send the contents as the nextToken parameter of a ListRecommendedIntents
	// operation request to get the next page of results.
	NextToken *string

	// Summary information for the intents that meet the filter criteria specified in
	// the request. The length of the list is specified in the maxResults parameter of
	// the request. If there are more intents available, the nextToken field contains a
	// token to get the next page of results.
	SummaryList []types.RecommendedIntentSummary

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListRecommendedIntentsPaginator added in v1.14.0 

type ListRecommendedIntentsPaginator struct {
	// contains filtered or unexported fields
}

ListRecommendedIntentsPaginator is a paginator for ListRecommendedIntents

func NewListRecommendedIntentsPaginator added in v1.14.0 

func NewListRecommendedIntentsPaginator(client ListRecommendedIntentsAPIClient, params *ListRecommendedIntentsInput, optFns ...func(*ListRecommendedIntentsPaginatorOptions)) *ListRecommendedIntentsPaginator

NewListRecommendedIntentsPaginator returns a new ListRecommendedIntentsPaginator

func (*ListRecommendedIntentsPaginator) HasMorePages added in v1.14.0 

func (p *ListRecommendedIntentsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListRecommendedIntentsPaginator) NextPage added in v1.14.0 

func (p *ListRecommendedIntentsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListRecommendedIntentsOutput, error)

NextPage retrieves the next ListRecommendedIntents page.

type ListRecommendedIntentsPaginatorOptions added in v1.14.0 

type ListRecommendedIntentsPaginatorOptions struct {
	// The maximum number of bot recommendations to return in each page of results. If
	// there are fewer results than the max page size, only the actual number of
	// results are returned.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListRecommendedIntentsPaginatorOptions is the paginator options for ListRecommendedIntents

type ListSessionAnalyticsDataAPIClient added in v1.30.0 

type ListSessionAnalyticsDataAPIClient interface {
	ListSessionAnalyticsData(context.Context, *ListSessionAnalyticsDataInput, ...func(*Options)) (*ListSessionAnalyticsDataOutput, error)
}

ListSessionAnalyticsDataAPIClient is a client that implements the ListSessionAnalyticsData operation.

type ListSessionAnalyticsDataInput added in v1.30.0 

type ListSessionAnalyticsDataInput struct {

	// The identifier for the bot for which you want to retrieve session analytics.
	//
	// This member is required.
	BotId *string

	// The date and time that marks the end of the range of time for which you want to
	// see session analytics.
	//
	// This member is required.
	EndDateTime *time.Time

	// The date and time that marks the beginning of the range of time for which you
	// want to see session analytics.
	//
	// This member is required.
	StartDateTime *time.Time

	// A list of objects, each of which describes a condition by which you want to
	// filter the results.
	Filters []types.AnalyticsSessionFilter

	// The maximum number of results to return in each page of results. If there are
	// fewer results than the maximum page size, only the actual number of results are
	// returned.
	MaxResults *int32

	// If the response from the ListSessionAnalyticsData operation contains more
	// results than specified in the maxResults parameter, a token is returned in the
	// response. Use the returned token in the nextToken parameter of a
	// ListSessionAnalyticsData request to return the next page of results. For a
	// complete set of results, call the ListSessionAnalyticsData operation until the
	// nextToken returned in the response is null.
	NextToken *string

	// An object specifying the measure and method by which to sort the session
	// analytics data.
	SortBy *types.SessionDataSortBy
	// contains filtered or unexported fields
}

type ListSessionAnalyticsDataOutput added in v1.30.0 

type ListSessionAnalyticsDataOutput struct {

	// The unique identifier of the bot that the sessions belong to.
	BotId *string

	// If the response from the ListSessionAnalyticsData operation contains more
	// results than specified in the maxResults parameter, a token is returned in the
	// response. Use the returned token in the nextToken parameter of a
	// ListSessionAnalyticsData request to return the next page of results. For a
	// complete set of results, call the ListSessionAnalyticsData operation until the
	// nextToken returned in the response is null.
	NextToken *string

	// A list of objects, each of which contains information about a session with the
	// bot.
	Sessions []types.SessionSpecification

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListSessionAnalyticsDataPaginator added in v1.30.0 

type ListSessionAnalyticsDataPaginator struct {
	// contains filtered or unexported fields
}

ListSessionAnalyticsDataPaginator is a paginator for ListSessionAnalyticsData

func NewListSessionAnalyticsDataPaginator added in v1.30.0 

func NewListSessionAnalyticsDataPaginator(client ListSessionAnalyticsDataAPIClient, params *ListSessionAnalyticsDataInput, optFns ...func(*ListSessionAnalyticsDataPaginatorOptions)) *ListSessionAnalyticsDataPaginator

NewListSessionAnalyticsDataPaginator returns a new ListSessionAnalyticsDataPaginator

func (*ListSessionAnalyticsDataPaginator) HasMorePages added in v1.30.0 

func (p *ListSessionAnalyticsDataPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListSessionAnalyticsDataPaginator) NextPage added in v1.30.0 

func (p *ListSessionAnalyticsDataPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListSessionAnalyticsDataOutput, error)

NextPage retrieves the next ListSessionAnalyticsData page.

type ListSessionAnalyticsDataPaginatorOptions added in v1.30.0 

type ListSessionAnalyticsDataPaginatorOptions struct {
	// The maximum number of results to return in each page of results. If there are
	// fewer results than the maximum page size, only the actual number of results are
	// returned.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListSessionAnalyticsDataPaginatorOptions is the paginator options for ListSessionAnalyticsData

type ListSessionMetricsAPIClient added in v1.30.0 

type ListSessionMetricsAPIClient interface {
	ListSessionMetrics(context.Context, *ListSessionMetricsInput, ...func(*Options)) (*ListSessionMetricsOutput, error)
}

ListSessionMetricsAPIClient is a client that implements the ListSessionMetrics operation.

type ListSessionMetricsInput added in v1.30.0 

type ListSessionMetricsInput struct {

	// The identifier for the bot for which you want to retrieve session metrics.
	//
	// This member is required.
	BotId *string

	// The date and time that marks the end of the range of time for which you want to
	// see session metrics.
	//
	// This member is required.
	EndDateTime *time.Time

	// A list of objects, each of which contains a metric you want to list, the
	// statistic for the metric you want to return, and the method by which to organize
	// the results.
	//
	// This member is required.
	Metrics []types.AnalyticsSessionMetric

	// The date and time that marks the beginning of the range of time for which you
	// want to see session metrics.
	//
	// This member is required.
	StartDateTime *time.Time

	// A list of objects, each of which contains specifications for organizing the
	// results by time.
	BinBy []types.AnalyticsBinBySpecification

	// A list of objects, each of which describes a condition by which you want to
	// filter the results.
	Filters []types.AnalyticsSessionFilter

	// A list of objects, each of which specifies how to group the results. You can
	// group by the following criteria:
	//   - ConversationEndState – The final state of the conversation. The possible end
	//   states are detailed in Key definitions (https://docs.aws.amazon.com/analytics-key-definitions-conversations)
	//   in the user guide.
	//   - LocaleId – The unique identifier of the bot locale.
	GroupBy []types.AnalyticsSessionGroupBySpecification

	// The maximum number of results to return in each page of results. If there are
	// fewer results than the maximum page size, only the actual number of results are
	// returned.
	MaxResults *int32

	// If the response from the ListSessionMetrics operation contains more results
	// than specified in the maxResults parameter, a token is returned in the response.
	// Use the returned token in the nextToken parameter of a ListSessionMetrics
	// request to return the next page of results. For a complete set of results, call
	// the ListSessionMetrics operation until the nextToken returned in the response is
	// null.
	NextToken *string
	// contains filtered or unexported fields
}

type ListSessionMetricsOutput added in v1.30.0 

type ListSessionMetricsOutput struct {

	// The identifier for the bot for which you retrieved session metrics.
	BotId *string

	// If the response from the ListSessionMetrics operation contains more results
	// than specified in the maxResults parameter, a token is returned in the response.
	// Use the returned token in the nextToken parameter of a ListSessionMetrics
	// request to return the next page of results. For a complete set of results, call
	// the ListSessionMetrics operation until the nextToken returned in the response is
	// null.
	NextToken *string

	// The results for the session metrics.
	Results []types.AnalyticsSessionResult

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListSessionMetricsPaginator added in v1.30.0 

type ListSessionMetricsPaginator struct {
	// contains filtered or unexported fields
}

ListSessionMetricsPaginator is a paginator for ListSessionMetrics

func NewListSessionMetricsPaginator added in v1.30.0 

func NewListSessionMetricsPaginator(client ListSessionMetricsAPIClient, params *ListSessionMetricsInput, optFns ...func(*ListSessionMetricsPaginatorOptions)) *ListSessionMetricsPaginator

NewListSessionMetricsPaginator returns a new ListSessionMetricsPaginator

func (*ListSessionMetricsPaginator) HasMorePages added in v1.30.0 

func (p *ListSessionMetricsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListSessionMetricsPaginator) NextPage added in v1.30.0 

func (p *ListSessionMetricsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListSessionMetricsOutput, error)

NextPage retrieves the next ListSessionMetrics page.

type ListSessionMetricsPaginatorOptions added in v1.30.0 

type ListSessionMetricsPaginatorOptions struct {
	// The maximum number of results to return in each page of results. If there are
	// fewer results than the maximum page size, only the actual number of results are
	// returned.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListSessionMetricsPaginatorOptions is the paginator options for ListSessionMetrics

type ListSlotTypesAPIClient 

type ListSlotTypesAPIClient interface {
	ListSlotTypes(context.Context, *ListSlotTypesInput, ...func(*Options)) (*ListSlotTypesOutput, error)
}

ListSlotTypesAPIClient is a client that implements the ListSlotTypes operation.

type ListSlotTypesInput 

type ListSlotTypesInput struct {

	// The unique identifier of the bot that contains the slot types.
	//
	// This member is required.
	BotId *string

	// The version of the bot that contains the slot type.
	//
	// This member is required.
	BotVersion *string

	// The identifier of the language and locale of the slot types to list. The string
	// must match one of the supported locales. For more information, see Supported
	// languages (https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html) .
	//
	// This member is required.
	LocaleId *string

	// Provides the specification of a filter used to limit the slot types in the
	// response to only those that match the filter specification. You can only specify
	// one filter and only one string to filter on.
	Filters []types.SlotTypeFilter

	// The maximum number of slot types to return in each page of results. If there
	// are fewer results than the max page size, only the actual number of results are
	// returned.
	MaxResults *int32

	// If the response from the ListSlotTypes operation contains more results than
	// specified in the maxResults parameter, a token is returned in the response. Use
	// that token in the nextToken parameter to return the next page of results.
	NextToken *string

	// Determines the sort order for the response from the ListSlotTypes operation.
	// You can choose to sort by the slot type name or last updated date in either
	// ascending or descending order.
	SortBy *types.SlotTypeSortBy
	// contains filtered or unexported fields
}

type ListSlotTypesOutput 

type ListSlotTypesOutput struct {

	// The identifier of the bot that contains the slot types.
	BotId *string

	// The version of the bot that contains the slot types.
	BotVersion *string

	// The language and local of the slot types in the list.
	LocaleId *string

	// A token that indicates whether there are more results to return in a response
	// to the ListSlotTypes operation. If the nextToken field is present, you send the
	// contents as the nextToken parameter of a ListSlotTypes operation request to get
	// the next page of results.
	NextToken *string

	// Summary information for the slot types that meet the filter criteria specified
	// in the request. The length of the list is specified in the maxResults parameter
	// of the request. If there are more slot types available, the nextToken field
	// contains a token to get the next page of results.
	SlotTypeSummaries []types.SlotTypeSummary

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListSlotTypesPaginator 

type ListSlotTypesPaginator struct {
	// contains filtered or unexported fields
}

ListSlotTypesPaginator is a paginator for ListSlotTypes

func NewListSlotTypesPaginator 

func NewListSlotTypesPaginator(client ListSlotTypesAPIClient, params *ListSlotTypesInput, optFns ...func(*ListSlotTypesPaginatorOptions)) *ListSlotTypesPaginator

NewListSlotTypesPaginator returns a new ListSlotTypesPaginator

func (*ListSlotTypesPaginator) HasMorePages 

func (p *ListSlotTypesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListSlotTypesPaginator) NextPage 

func (p *ListSlotTypesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListSlotTypesOutput, error)

NextPage retrieves the next ListSlotTypes page.

type ListSlotTypesPaginatorOptions 

type ListSlotTypesPaginatorOptions struct {
	// The maximum number of slot types to return in each page of results. If there
	// are fewer results than the max page size, only the actual number of results are
	// returned.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListSlotTypesPaginatorOptions is the paginator options for ListSlotTypes

type ListSlotsAPIClient 

type ListSlotsAPIClient interface {
	ListSlots(context.Context, *ListSlotsInput, ...func(*Options)) (*ListSlotsOutput, error)
}

ListSlotsAPIClient is a client that implements the ListSlots operation.

type ListSlotsInput 

type ListSlotsInput struct {

	// The identifier of the bot that contains the slot.
	//
	// This member is required.
	BotId *string

	// The version of the bot that contains the slot.
	//
	// This member is required.
	BotVersion *string

	// The unique identifier of the intent that contains the slot.
	//
	// This member is required.
	IntentId *string

	// The identifier of the language and locale of the slots to list. The string must
	// match one of the supported locales. For more information, see Supported
	// languages (https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html) .
	//
	// This member is required.
	LocaleId *string

	// Provides the specification of a filter used to limit the slots in the response
	// to only those that match the filter specification. You can only specify one
	// filter and only one string to filter on.
	Filters []types.SlotFilter

	// The maximum number of slots to return in each page of results. If there are
	// fewer results than the max page size, only the actual number of results are
	// returned.
	MaxResults *int32

	// If the response from the ListSlots operation contains more results than
	// specified in the maxResults parameter, a token is returned in the response. Use
	// that token in the nextToken parameter to return the next page of results.
	NextToken *string

	// Determines the sort order for the response from the ListSlots operation. You
	// can choose to sort by the slot name or last updated date in either ascending or
	// descending order.
	SortBy *types.SlotSortBy
	// contains filtered or unexported fields
}

type ListSlotsOutput 

type ListSlotsOutput struct {

	// The identifier of the bot that contains the slots.
	BotId *string

	// The version of the bot that contains the slots.
	BotVersion *string

	// The identifier of the intent that contains the slots.
	IntentId *string

	// The language and locale of the slots in the list.
	LocaleId *string

	// A token that indicates whether there are more results to return in a response
	// to the ListSlots operation. If the nextToken field is present, you send the
	// contents as the nextToken parameter of a ListSlots operation request to get the
	// next page of results.
	NextToken *string

	// Summary information for the slots that meet the filter criteria specified in
	// the request. The length of the list is specified in the maxResults parameter of
	// the request. If there are more slots available, the nextToken field contains a
	// token to get the next page of results.
	SlotSummaries []types.SlotSummary

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListSlotsPaginator 

type ListSlotsPaginator struct {
	// contains filtered or unexported fields
}

ListSlotsPaginator is a paginator for ListSlots

func NewListSlotsPaginator 

func NewListSlotsPaginator(client ListSlotsAPIClient, params *ListSlotsInput, optFns ...func(*ListSlotsPaginatorOptions)) *ListSlotsPaginator

NewListSlotsPaginator returns a new ListSlotsPaginator

func (*ListSlotsPaginator) HasMorePages 

func (p *ListSlotsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListSlotsPaginator) NextPage 

func (p *ListSlotsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListSlotsOutput, error)

NextPage retrieves the next ListSlots page.

type ListSlotsPaginatorOptions 

type ListSlotsPaginatorOptions struct {
	// The maximum number of slots to return in each page of results. If there are
	// fewer results than the max page size, only the actual number of results are
	// returned.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListSlotsPaginatorOptions is the paginator options for ListSlots

type ListTagsForResourceInput 

type ListTagsForResourceInput struct {

	// The Amazon Resource Name (ARN) of the resource to get a list of tags for.
	//
	// This member is required.
	ResourceARN *string
	// contains filtered or unexported fields
}

type ListTagsForResourceOutput 

type ListTagsForResourceOutput struct {

	// The tags associated with a resource.
	Tags map[string]string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListTestExecutionResultItemsAPIClient added in v1.29.0 

type ListTestExecutionResultItemsAPIClient interface {
	ListTestExecutionResultItems(context.Context, *ListTestExecutionResultItemsInput, ...func(*Options)) (*ListTestExecutionResultItemsOutput, error)
}

ListTestExecutionResultItemsAPIClient is a client that implements the ListTestExecutionResultItems operation.

type ListTestExecutionResultItemsInput added in v1.29.0 

type ListTestExecutionResultItemsInput struct {

	// The filter for the list of results from the test set execution.
	//
	// This member is required.
	ResultFilterBy *types.TestExecutionResultFilterBy

	// The unique identifier of the test execution to list the result items.
	//
	// This member is required.
	TestExecutionId *string

	// The maximum number of test execution result items to return in each page. If
	// there are fewer results than the max page size, only the actual number of
	// results are returned.
	MaxResults *int32

	// If the response from the ListTestExecutionResultItems operation contains more
	// results than specified in the maxResults parameter, a token is returned in the
	// response. Use that token in the nextToken parameter to return the next page of
	// results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListTestExecutionResultItemsOutput added in v1.29.0 

type ListTestExecutionResultItemsOutput struct {

	// A token that indicates whether there are more results to return in a response
	// to the ListTestExecutionResultItems operation. If the nextToken field is
	// present, you send the contents as the nextToken parameter of a
	// ListTestExecutionResultItems operation request to get the next page of results.
	NextToken *string

	// The list of results from the test execution.
	TestExecutionResults *types.TestExecutionResultItems

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListTestExecutionResultItemsPaginator added in v1.29.0 

type ListTestExecutionResultItemsPaginator struct {
	// contains filtered or unexported fields
}

ListTestExecutionResultItemsPaginator is a paginator for ListTestExecutionResultItems

func NewListTestExecutionResultItemsPaginator added in v1.29.0 

func NewListTestExecutionResultItemsPaginator(client ListTestExecutionResultItemsAPIClient, params *ListTestExecutionResultItemsInput, optFns ...func(*ListTestExecutionResultItemsPaginatorOptions)) *ListTestExecutionResultItemsPaginator

NewListTestExecutionResultItemsPaginator returns a new ListTestExecutionResultItemsPaginator

func (*ListTestExecutionResultItemsPaginator) HasMorePages added in v1.29.0 

func (p *ListTestExecutionResultItemsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListTestExecutionResultItemsPaginator) NextPage added in v1.29.0 

func (p *ListTestExecutionResultItemsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListTestExecutionResultItemsOutput, error)

NextPage retrieves the next ListTestExecutionResultItems page.

type ListTestExecutionResultItemsPaginatorOptions added in v1.29.0 

type ListTestExecutionResultItemsPaginatorOptions struct {
	// The maximum number of test execution result items to return in each page. If
	// there are fewer results than the max page size, only the actual number of
	// results are returned.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListTestExecutionResultItemsPaginatorOptions is the paginator options for ListTestExecutionResultItems

type ListTestExecutionsAPIClient added in v1.29.0 

type ListTestExecutionsAPIClient interface {
	ListTestExecutions(context.Context, *ListTestExecutionsInput, ...func(*Options)) (*ListTestExecutionsOutput, error)
}

ListTestExecutionsAPIClient is a client that implements the ListTestExecutions operation.

type ListTestExecutionsInput added in v1.29.0 

type ListTestExecutionsInput struct {

	// The maximum number of test executions to return in each page. If there are
	// fewer results than the max page size, only the actual number of results are
	// returned.
	MaxResults *int32

	// If the response from the ListTestExecutions operation contains more results
	// than specified in the maxResults parameter, a token is returned in the response.
	// Use that token in the nextToken parameter to return the next page of results.
	NextToken *string

	// The sort order of the test set executions.
	SortBy *types.TestExecutionSortBy
	// contains filtered or unexported fields
}

type ListTestExecutionsOutput added in v1.29.0 

type ListTestExecutionsOutput struct {

	// A token that indicates whether there are more results to return in a response
	// to the ListTestExecutions operation. If the nextToken field is present, you send
	// the contents as the nextToken parameter of a ListTestExecutions operation
	// request to get the next page of results.
	NextToken *string

	// The list of test executions.
	TestExecutions []types.TestExecutionSummary

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListTestExecutionsPaginator added in v1.29.0 

type ListTestExecutionsPaginator struct {
	// contains filtered or unexported fields
}

ListTestExecutionsPaginator is a paginator for ListTestExecutions

func NewListTestExecutionsPaginator added in v1.29.0 

func NewListTestExecutionsPaginator(client ListTestExecutionsAPIClient, params *ListTestExecutionsInput, optFns ...func(*ListTestExecutionsPaginatorOptions)) *ListTestExecutionsPaginator

NewListTestExecutionsPaginator returns a new ListTestExecutionsPaginator

func (*ListTestExecutionsPaginator) HasMorePages added in v1.29.0 

func (p *ListTestExecutionsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListTestExecutionsPaginator) NextPage added in v1.29.0 

func (p *ListTestExecutionsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListTestExecutionsOutput, error)

NextPage retrieves the next ListTestExecutions page.

type ListTestExecutionsPaginatorOptions added in v1.29.0 

type ListTestExecutionsPaginatorOptions struct {
	// The maximum number of test executions to return in each page. If there are
	// fewer results than the max page size, only the actual number of results are
	// returned.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListTestExecutionsPaginatorOptions is the paginator options for ListTestExecutions

type ListTestSetRecordsAPIClient added in v1.29.0 

type ListTestSetRecordsAPIClient interface {
	ListTestSetRecords(context.Context, *ListTestSetRecordsInput, ...func(*Options)) (*ListTestSetRecordsOutput, error)
}

ListTestSetRecordsAPIClient is a client that implements the ListTestSetRecords operation.

type ListTestSetRecordsInput added in v1.29.0 

type ListTestSetRecordsInput struct {

	// The identifier of the test set to list its test set records.
	//
	// This member is required.
	TestSetId *string

	// The maximum number of test set records to return in each page. If there are
	// fewer records than the max page size, only the actual number of records are
	// returned.
	MaxResults *int32

	// If the response from the ListTestSetRecords operation contains more results
	// than specified in the maxResults parameter, a token is returned in the response.
	// Use that token in the nextToken parameter to return the next page of results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListTestSetRecordsOutput added in v1.29.0 

type ListTestSetRecordsOutput struct {

	// A token that indicates whether there are more records to return in a response
	// to the ListTestSetRecords operation. If the nextToken field is present, you send
	// the contents as the nextToken parameter of a ListTestSetRecords operation
	// request to get the next page of records.
	NextToken *string

	// The list of records from the test set.
	TestSetRecords []types.TestSetTurnRecord

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListTestSetRecordsPaginator added in v1.29.0 

type ListTestSetRecordsPaginator struct {
	// contains filtered or unexported fields
}

ListTestSetRecordsPaginator is a paginator for ListTestSetRecords

func NewListTestSetRecordsPaginator added in v1.29.0 

func NewListTestSetRecordsPaginator(client ListTestSetRecordsAPIClient, params *ListTestSetRecordsInput, optFns ...func(*ListTestSetRecordsPaginatorOptions)) *ListTestSetRecordsPaginator

NewListTestSetRecordsPaginator returns a new ListTestSetRecordsPaginator

func (*ListTestSetRecordsPaginator) HasMorePages added in v1.29.0 

func (p *ListTestSetRecordsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListTestSetRecordsPaginator) NextPage added in v1.29.0 

func (p *ListTestSetRecordsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListTestSetRecordsOutput, error)

NextPage retrieves the next ListTestSetRecords page.

type ListTestSetRecordsPaginatorOptions added in v1.29.0 

type ListTestSetRecordsPaginatorOptions struct {
	// The maximum number of test set records to return in each page. If there are
	// fewer records than the max page size, only the actual number of records are
	// returned.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListTestSetRecordsPaginatorOptions is the paginator options for ListTestSetRecords

type ListTestSetsAPIClient added in v1.29.0 

type ListTestSetsAPIClient interface {
	ListTestSets(context.Context, *ListTestSetsInput, ...func(*Options)) (*ListTestSetsOutput, error)
}

ListTestSetsAPIClient is a client that implements the ListTestSets operation.

type ListTestSetsInput added in v1.29.0 

type ListTestSetsInput struct {

	// The maximum number of test sets to return in each page. If there are fewer
	// results than the max page size, only the actual number of results are returned.
	MaxResults *int32

	// If the response from the ListTestSets operation contains more results than
	// specified in the maxResults parameter, a token is returned in the response. Use
	// that token in the nextToken parameter to return the next page of results.
	NextToken *string

	// The sort order for the list of test sets.
	SortBy *types.TestSetSortBy
	// contains filtered or unexported fields
}

type ListTestSetsOutput added in v1.29.0 

type ListTestSetsOutput struct {

	// A token that indicates whether there are more results to return in a response
	// to the ListTestSets operation. If the nextToken field is present, you send the
	// contents as the nextToken parameter of a ListTestSets operation request to get
	// the next page of results.
	NextToken *string

	// The selected test sets in a list of test sets.
	TestSets []types.TestSetSummary

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListTestSetsPaginator added in v1.29.0 

type ListTestSetsPaginator struct {
	// contains filtered or unexported fields
}

ListTestSetsPaginator is a paginator for ListTestSets

func NewListTestSetsPaginator added in v1.29.0 

func NewListTestSetsPaginator(client ListTestSetsAPIClient, params *ListTestSetsInput, optFns ...func(*ListTestSetsPaginatorOptions)) *ListTestSetsPaginator

NewListTestSetsPaginator returns a new ListTestSetsPaginator

func (*ListTestSetsPaginator) HasMorePages added in v1.29.0 

func (p *ListTestSetsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListTestSetsPaginator) NextPage added in v1.29.0 

func (p *ListTestSetsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListTestSetsOutput, error)

NextPage retrieves the next ListTestSets page.

type ListTestSetsPaginatorOptions added in v1.29.0 

type ListTestSetsPaginatorOptions struct {
	// The maximum number of test sets to return in each page. If there are fewer
	// results than the max page size, only the actual number of results are returned.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListTestSetsPaginatorOptions is the paginator options for ListTestSets

type ListUtteranceAnalyticsDataAPIClient added in v1.30.0 

type ListUtteranceAnalyticsDataAPIClient interface {
	ListUtteranceAnalyticsData(context.Context, *ListUtteranceAnalyticsDataInput, ...func(*Options)) (*ListUtteranceAnalyticsDataOutput, error)
}

ListUtteranceAnalyticsDataAPIClient is a client that implements the ListUtteranceAnalyticsData operation.

type ListUtteranceAnalyticsDataInput added in v1.30.0 

type ListUtteranceAnalyticsDataInput struct {

	// The identifier for the bot for which you want to retrieve utterance analytics.
	//
	// This member is required.
	BotId *string

	// The date and time that marks the end of the range of time for which you want to
	// see utterance analytics.
	//
	// This member is required.
	EndDateTime *time.Time

	// The date and time that marks the beginning of the range of time for which you
	// want to see utterance analytics.
	//
	// This member is required.
	StartDateTime *time.Time

	// A list of objects, each of which describes a condition by which you want to
	// filter the results.
	Filters []types.AnalyticsUtteranceFilter

	// The maximum number of results to return in each page of results. If there are
	// fewer results than the maximum page size, only the actual number of results are
	// returned.
	MaxResults *int32

	// If the response from the ListUtteranceAnalyticsData operation contains more
	// results than specified in the maxResults parameter, a token is returned in the
	// response. Use the returned token in the nextToken parameter of a
	// ListUtteranceAnalyticsData request to return the next page of results. For a
	// complete set of results, call the ListUtteranceAnalyticsData operation until the
	// nextToken returned in the response is null.
	NextToken *string

	// An object specifying the measure and method by which to sort the utterance
	// analytics data.
	SortBy *types.UtteranceDataSortBy
	// contains filtered or unexported fields
}

type ListUtteranceAnalyticsDataOutput added in v1.30.0 

type ListUtteranceAnalyticsDataOutput struct {

	// The unique identifier of the bot that the utterances belong to.
	BotId *string

	// If the response from the ListUtteranceAnalyticsData operation contains more
	// results than specified in the maxResults parameter, a token is returned in the
	// response. Use the returned token in the nextToken parameter of a
	// ListUtteranceAnalyticsData request to return the next page of results. For a
	// complete set of results, call the ListUtteranceAnalyticsData operation until the
	// nextToken returned in the response is null.
	NextToken *string

	// A list of objects, each of which contains information about an utterance in a
	// user session with your bot.
	Utterances []types.UtteranceSpecification

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListUtteranceAnalyticsDataPaginator added in v1.30.0 

type ListUtteranceAnalyticsDataPaginator struct {
	// contains filtered or unexported fields
}

ListUtteranceAnalyticsDataPaginator is a paginator for ListUtteranceAnalyticsData

func NewListUtteranceAnalyticsDataPaginator added in v1.30.0 

func NewListUtteranceAnalyticsDataPaginator(client ListUtteranceAnalyticsDataAPIClient, params *ListUtteranceAnalyticsDataInput, optFns ...func(*ListUtteranceAnalyticsDataPaginatorOptions)) *ListUtteranceAnalyticsDataPaginator

NewListUtteranceAnalyticsDataPaginator returns a new ListUtteranceAnalyticsDataPaginator

func (*ListUtteranceAnalyticsDataPaginator) HasMorePages added in v1.30.0 

func (p *ListUtteranceAnalyticsDataPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListUtteranceAnalyticsDataPaginator) NextPage added in v1.30.0 

func (p *ListUtteranceAnalyticsDataPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListUtteranceAnalyticsDataOutput, error)

NextPage retrieves the next ListUtteranceAnalyticsData page.

type ListUtteranceAnalyticsDataPaginatorOptions added in v1.30.0 

type ListUtteranceAnalyticsDataPaginatorOptions struct {
	// The maximum number of results to return in each page of results. If there are
	// fewer results than the maximum page size, only the actual number of results are
	// returned.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListUtteranceAnalyticsDataPaginatorOptions is the paginator options for ListUtteranceAnalyticsData

type ListUtteranceMetricsAPIClient added in v1.30.0 

type ListUtteranceMetricsAPIClient interface {
	ListUtteranceMetrics(context.Context, *ListUtteranceMetricsInput, ...func(*Options)) (*ListUtteranceMetricsOutput, error)
}

ListUtteranceMetricsAPIClient is a client that implements the ListUtteranceMetrics operation.

type ListUtteranceMetricsInput added in v1.30.0 

type ListUtteranceMetricsInput struct {

	// The identifier for the bot for which you want to retrieve utterance metrics.
	//
	// This member is required.
	BotId *string

	// The date and time that marks the end of the range of time for which you want to
	// see utterance metrics.
	//
	// This member is required.
	EndDateTime *time.Time

	// A list of objects, each of which contains a metric you want to list, the
	// statistic for the metric you want to return, and the method by which to organize
	// the results.
	//
	// This member is required.
	Metrics []types.AnalyticsUtteranceMetric

	// The date and time that marks the beginning of the range of time for which you
	// want to see utterance metrics.
	//
	// This member is required.
	StartDateTime *time.Time

	// A list containing attributes related to the utterance that you want the
	// response to return. The following attributes are possible:
	//   - LastUsedIntent – The last used intent at the time of the utterance.
	Attributes []types.AnalyticsUtteranceAttribute

	// A list of objects, each of which contains specifications for organizing the
	// results by time.
	BinBy []types.AnalyticsBinBySpecification

	// A list of objects, each of which describes a condition by which you want to
	// filter the results.
	Filters []types.AnalyticsUtteranceFilter

	// A list of objects, each of which specifies how to group the results. You can
	// group by the following criteria:
	//   - UtteranceText – The transcription of the utterance.
	//   - UtteranceState – The state of the utterance. The possible states are
	//   detailed in Key definitions (https://docs.aws.amazon.com/analytics-key-definitions-utterances)
	//   in the user guide.
	GroupBy []types.AnalyticsUtteranceGroupBySpecification

	// The maximum number of results to return in each page of results. If there are
	// fewer results than the maximum page size, only the actual number of results are
	// returned.
	MaxResults *int32

	// If the response from the ListUtteranceMetrics operation contains more results
	// than specified in the maxResults parameter, a token is returned in the response.
	// Use the returned token in the nextToken parameter of a ListUtteranceMetrics
	// request to return the next page of results. For a complete set of results, call
	// the ListUtteranceMetrics operation until the nextToken returned in the response
	// is null.
	NextToken *string
	// contains filtered or unexported fields
}

type ListUtteranceMetricsOutput added in v1.30.0 

type ListUtteranceMetricsOutput struct {

	// The identifier for the bot for which you retrieved utterance metrics.
	BotId *string

	// If the response from the ListUtteranceMetrics operation contains more results
	// than specified in the maxResults parameter, a token is returned in the response.
	// Use the returned token in the nextToken parameter of a ListUtteranceMetrics
	// request to return the next page of results. For a complete set of results, call
	// the ListUtteranceMetrics operation until the nextToken returned in the response
	// is null.
	NextToken *string

	// The results for the utterance metrics.
	Results []types.AnalyticsUtteranceResult

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListUtteranceMetricsPaginator added in v1.30.0 

type ListUtteranceMetricsPaginator struct {
	// contains filtered or unexported fields
}

ListUtteranceMetricsPaginator is a paginator for ListUtteranceMetrics

func NewListUtteranceMetricsPaginator added in v1.30.0 

func NewListUtteranceMetricsPaginator(client ListUtteranceMetricsAPIClient, params *ListUtteranceMetricsInput, optFns ...func(*ListUtteranceMetricsPaginatorOptions)) *ListUtteranceMetricsPaginator

NewListUtteranceMetricsPaginator returns a new ListUtteranceMetricsPaginator

func (*ListUtteranceMetricsPaginator) HasMorePages added in v1.30.0 

func (p *ListUtteranceMetricsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListUtteranceMetricsPaginator) NextPage added in v1.30.0 

func (p *ListUtteranceMetricsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListUtteranceMetricsOutput, error)

NextPage retrieves the next ListUtteranceMetrics page.

type ListUtteranceMetricsPaginatorOptions added in v1.30.0 

type ListUtteranceMetricsPaginatorOptions struct {
	// The maximum number of results to return in each page of results. If there are
	// fewer results than the maximum page size, only the actual number of results are
	// returned.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListUtteranceMetricsPaginatorOptions is the paginator options for ListUtteranceMetrics

type Options 

type Options struct {
	// Set of options to modify how an operation is invoked. These apply to all
	// operations invoked for this client. Use functional options on operation call to
	// modify this list for per operation behavior.
	APIOptions []func(*middleware.Stack) error

	// The optional application specific identifier appended to the User-Agent header.
	AppID string

	// This endpoint will be given as input to an EndpointResolverV2. It is used for
	// providing a custom base endpoint that is subject to modifications by the
	// processing EndpointResolverV2.
	BaseEndpoint *string

	// Configures the events that will be sent to the configured logger.
	ClientLogMode aws.ClientLogMode

	// The credentials object to use when signing requests.
	Credentials aws.CredentialsProvider

	// The configuration DefaultsMode that the SDK should use when constructing the
	// clients initial default settings.
	DefaultsMode aws.DefaultsMode

	// The endpoint options to be used when attempting to resolve an endpoint.
	EndpointOptions EndpointResolverOptions

	// The service endpoint resolver.
	//
	// Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a
	// value for this field will likely prevent you from using any endpoint-related
	// service features released after the introduction of EndpointResolverV2 and
	// BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom
	// endpoint, set the client option BaseEndpoint instead.
	EndpointResolver EndpointResolver

	// Resolves the endpoint used for a particular service operation. This should be
	// used over the deprecated EndpointResolver.
	EndpointResolverV2 EndpointResolverV2

	// Signature Version 4 (SigV4) Signer
	HTTPSignerV4 HTTPSignerV4

	// The logger writer interface to write logging messages to.
	Logger logging.Logger

	// The region to send requests to. (Required)
	Region string

	// RetryMaxAttempts specifies the maximum number attempts an API client will call
	// an operation that fails with a retryable error. A value of 0 is ignored, and
	// will not be used to configure the API client created default retryer, or modify
	// per operation call's retry max attempts. If specified in an operation call's
	// functional options with a value that is different than the constructed client's
	// Options, the Client's Retryer will be wrapped to use the operation's specific
	// RetryMaxAttempts value.
	RetryMaxAttempts int

	// RetryMode specifies the retry mode the API client will be created with, if
	// Retryer option is not also specified. When creating a new API Clients this
	// member will only be used if the Retryer Options member is nil. This value will
	// be ignored if Retryer is not nil. Currently does not support per operation call
	// overrides, may in the future.
	RetryMode aws.RetryMode

	// Retryer guides how HTTP requests should be retried in case of recoverable
	// failures. When nil the API client will use a default retryer. The kind of
	// default retry created by the API client can be changed with the RetryMode
	// option.
	Retryer aws.Retryer

	// The RuntimeEnvironment configuration, only populated if the DefaultsMode is set
	// to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You
	// should not populate this structure programmatically, or rely on the values here
	// within your applications.
	RuntimeEnvironment aws.RuntimeEnvironment

	// The HTTP client to invoke API calls with. Defaults to client's default HTTP
	// implementation if nil.
	HTTPClient HTTPClient

	// The auth scheme resolver which determines how to authenticate for each
	// operation.
	AuthSchemeResolver AuthSchemeResolver

	// The list of auth schemes supported by the client.
	AuthSchemes []smithyhttp.AuthScheme
	// contains filtered or unexported fields
}

func (Options) Copy 

func (o Options) Copy() Options

Copy creates a clone where the APIOptions list is deep copied.

func (Options) GetIdentityResolver added in v1.36.2 

func (o Options) GetIdentityResolver(schemeID string) smithyauth.IdentityResolver

type ResolveEndpoint 

type ResolveEndpoint struct {
	Resolver EndpointResolver
	Options  EndpointResolverOptions
}

func (*ResolveEndpoint) HandleSerialize 

func (m *ResolveEndpoint) HandleSerialize(ctx context.Context, in middleware.SerializeInput, next middleware.SerializeHandler) (
	out middleware.SerializeOutput, metadata middleware.Metadata, err error,
)

func (*ResolveEndpoint) ID 

func (*ResolveEndpoint) ID() string

type SearchAssociatedTranscriptsInput added in v1.14.0 

type SearchAssociatedTranscriptsInput struct {

	// The unique identifier of the bot associated with the transcripts that you are
	// searching.
	//
	// This member is required.
	BotId *string

	// The unique identifier of the bot recommendation associated with the transcripts
	// to search.
	//
	// This member is required.
	BotRecommendationId *string

	// The version of the bot containing the transcripts that you are searching.
	//
	// This member is required.
	BotVersion *string

	// A list of filter objects.
	//
	// This member is required.
	Filters []types.AssociatedTranscriptFilter

	// The identifier of the language and locale of the transcripts to search. The
	// string must match one of the supported locales. For more information, see
	// Supported languages (https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html)
	//
	// This member is required.
	LocaleId *string

	// The maximum number of bot recommendations to return in each page of results. If
	// there are fewer results than the max page size, only the actual number of
	// results are returned.
	MaxResults *int32

	// If the response from the SearchAssociatedTranscriptsRequest operation contains
	// more results than specified in the maxResults parameter, an index is returned in
	// the response. Use that index in the nextIndex parameter to return the next page
	// of results.
	NextIndex *int32

	// How SearchResults are ordered. Valid values are Ascending or Descending. The
	// default is Descending.
	SearchOrder types.SearchOrder
	// contains filtered or unexported fields
}

type SearchAssociatedTranscriptsOutput added in v1.14.0 

type SearchAssociatedTranscriptsOutput struct {

	// The object that contains the associated transcript that meet the criteria you
	// specified.
	AssociatedTranscripts []types.AssociatedTranscript

	// The unique identifier of the bot associated with the transcripts that you are
	// searching.
	BotId *string

	// The unique identifier of the bot recommendation associated with the transcripts
	// to search.
	BotRecommendationId *string

	// The version of the bot containing the transcripts that you are searching.
	BotVersion *string

	// The identifier of the language and locale of the transcripts to search. The
	// string must match one of the supported locales. For more information, see
	// Supported languages (https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html)
	LocaleId *string

	// A index that indicates whether there are more results to return in a response
	// to the SearchAssociatedTranscripts operation. If the nextIndex field is present,
	// you send the contents as the nextIndex parameter of a
	// SearchAssociatedTranscriptsRequest operation to get the next page of results.
	NextIndex *int32

	// The total number of transcripts returned by the search.
	TotalResults *int32

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type StartBotRecommendationInput added in v1.14.0 

type StartBotRecommendationInput struct {

	// The unique identifier of the bot containing the bot recommendation.
	//
	// This member is required.
	BotId *string

	// The version of the bot containing the bot recommendation.
	//
	// This member is required.
	BotVersion *string

	// The identifier of the language and locale of the bot recommendation to start.
	// The string must match one of the supported locales. For more information, see
	// Supported languages (https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html)
	//
	// This member is required.
	LocaleId *string

	// The object representing the Amazon S3 bucket containing the transcript, as well
	// as the associated metadata.
	//
	// This member is required.
	TranscriptSourceSetting *types.TranscriptSourceSetting

	// The object representing the passwords that will be used to encrypt the data
	// related to the bot recommendation results, as well as the KMS key ARN used to
	// encrypt the associated metadata.
	EncryptionSetting *types.EncryptionSetting
	// contains filtered or unexported fields
}

type StartBotRecommendationOutput added in v1.14.0 

type StartBotRecommendationOutput struct {

	// The unique identifier of the bot containing the bot recommendation.
	BotId *string

	// The identifier of the bot recommendation that you have created.
	BotRecommendationId *string

	// The status of the bot recommendation. If the status is Failed, then the reasons
	// for the failure are listed in the failureReasons field.
	BotRecommendationStatus types.BotRecommendationStatus

	// The version of the bot containing the bot recommendation.
	BotVersion *string

	// A timestamp of the date and time that the bot recommendation was created.
	CreationDateTime *time.Time

	// The object representing the passwords that were used to encrypt the data
	// related to the bot recommendation results, as well as the KMS key ARN used to
	// encrypt the associated metadata.
	EncryptionSetting *types.EncryptionSetting

	// The identifier of the language and locale of the bot recommendation to start.
	// The string must match one of the supported locales. For more information, see
	// Supported languages (https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html)
	LocaleId *string

	// The object representing the Amazon S3 bucket containing the transcript, as well
	// as the associated metadata.
	TranscriptSourceSetting *types.TranscriptSourceSetting

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type StartBotResourceGenerationInput added in v1.37.0 

type StartBotResourceGenerationInput struct {

	// The unique identifier of the bot for which to generate intents and slot types.
	//
	// This member is required.
	BotId *string

	// The version of the bot for which to generate intents and slot types.
	//
	// This member is required.
	BotVersion *string

	// The prompt to generate intents and slot types for the bot locale. Your
	// description should be both detailed and precise to help generate appropriate and
	// sufficient intents for your bot. Include a list of actions to improve the intent
	// creation process.
	//
	// This member is required.
	GenerationInputPrompt *string

	// The locale of the bot for which to generate intents and slot types.
	//
	// This member is required.
	LocaleId *string
	// contains filtered or unexported fields
}

type StartBotResourceGenerationOutput added in v1.37.0 

type StartBotResourceGenerationOutput struct {

	// The unique identifier of the bot for which the generation request was made.
	BotId *string

	// The version of the bot for which the generation request was made.
	BotVersion *string

	// The date and time at which the generation request was made.
	CreationDateTime *time.Time

	// The unique identifier of the generation request.
	GenerationId *string

	// The prompt that was used generate intents and slot types for the bot locale.
	GenerationInputPrompt *string

	// The status of the generation request.
	GenerationStatus types.GenerationStatus

	// The locale of the bot for which the generation request was made.
	LocaleId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type StartImportInput added in v1.2.0 

type StartImportInput struct {

	// The unique identifier for the import. It is included in the response from the
	// CreateUploadUrl (https://docs.aws.amazon.com/lexv2/latest/APIReference/API_CreateUploadUrl.html)
	// operation.
	//
	// This member is required.
	ImportId *string

	// The strategy to use when there is a name conflict between the imported resource
	// and an existing resource. When the merge strategy is FailOnConflict existing
	// resources are not overwritten and the import fails.
	//
	// This member is required.
	MergeStrategy types.MergeStrategy

	// Parameters for creating the bot, bot locale or custom vocabulary.
	//
	// This member is required.
	ResourceSpecification *types.ImportResourceSpecification

	// The password used to encrypt the zip archive that contains the resource
	// definition. You should always encrypt the zip archive to protect it during
	// transit between your site and Amazon Lex.
	FilePassword *string
	// contains filtered or unexported fields
}

type StartImportOutput added in v1.2.0 

type StartImportOutput struct {

	// The date and time that the import request was created.
	CreationDateTime *time.Time

	// A unique identifier for the import.
	ImportId *string

	// The current status of the import. When the status is Complete the bot, bot
	// alias, or custom vocabulary is ready to use.
	ImportStatus types.ImportStatus

	// The strategy used when there was a name conflict between the imported resource
	// and an existing resource. When the merge strategy is FailOnConflict existing
	// resources are not overwritten and the import fails.
	MergeStrategy types.MergeStrategy

	// The parameters used when importing the resource.
	ResourceSpecification *types.ImportResourceSpecification

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type StartTestExecutionInput added in v1.29.0 

type StartTestExecutionInput struct {

	// Indicates whether we use streaming or non-streaming APIs for the test set
	// execution. For streaming, StartConversation Runtime API is used. Whereas, for
	// non-streaming, RecognizeUtterance and RecognizeText Amazon Lex Runtime API are
	// used.
	//
	// This member is required.
	ApiMode types.TestExecutionApiMode

	// The target bot for the test set execution.
	//
	// This member is required.
	Target *types.TestExecutionTarget

	// The test set Id for the test set execution.
	//
	// This member is required.
	TestSetId *string

	// Indicates whether audio or text is used.
	TestExecutionModality types.TestExecutionModality
	// contains filtered or unexported fields
}

type StartTestExecutionOutput added in v1.29.0 

type StartTestExecutionOutput struct {

	// Indicates whether we use streaming or non-streaming APIs for the test set
	// execution. For streaming, StartConversation Amazon Lex Runtime API is used.
	// Whereas for non-streaming, RecognizeUtterance and RecognizeText Amazon Lex
	// Runtime API are used.
	ApiMode types.TestExecutionApiMode

	// The creation date and time for the test set execution.
	CreationDateTime *time.Time

	// The target bot for the test set execution.
	Target *types.TestExecutionTarget

	// The unique identifier of the test set execution.
	TestExecutionId *string

	// Indicates whether audio or text is used.
	TestExecutionModality types.TestExecutionModality

	// The test set Id for the test set execution.
	TestSetId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type StartTestSetGenerationInput added in v1.29.0 

type StartTestSetGenerationInput struct {

	// The data source for the test set generation.
	//
	// This member is required.
	GenerationDataSource *types.TestSetGenerationDataSource

	// The roleARN used for any operation in the test set to access resources in the
	// Amazon Web Services account.
	//
	// This member is required.
	RoleArn *string

	// The Amazon S3 storage location for the test set generation.
	//
	// This member is required.
	StorageLocation *types.TestSetStorageLocation

	// The test set name for the test set generation request.
	//
	// This member is required.
	TestSetName *string

	// The test set description for the test set generation request.
	Description *string

	// A list of tags to add to the test set. You can only add tags when you
	// import/generate a new test set. You can't use the UpdateTestSet operation to
	// update tags. To update tags, use the TagResource operation.
	TestSetTags map[string]string
	// contains filtered or unexported fields
}

type StartTestSetGenerationOutput added in v1.29.0 

type StartTestSetGenerationOutput struct {

	// The creation date and time for the test set generation.
	CreationDateTime *time.Time

	// The description used for the test set generation.
	Description *string

	// The data source for the test set generation.
	GenerationDataSource *types.TestSetGenerationDataSource

	// The roleARN used for any operation in the test set to access resources in the
	// Amazon Web Services account.
	RoleArn *string

	// The Amazon S3 storage location for the test set generation.
	StorageLocation *types.TestSetStorageLocation

	// The unique identifier of the test set generation to describe.
	TestSetGenerationId *string

	// The status for the test set generation.
	TestSetGenerationStatus types.TestSetGenerationStatus

	// The test set name used for the test set generation.
	TestSetName *string

	// A list of tags that was used for the test set that is being generated.
	TestSetTags map[string]string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type StopBotRecommendationInput added in v1.23.0 

type StopBotRecommendationInput struct {

	// The unique identifier of the bot containing the bot recommendation to be
	// stopped.
	//
	// This member is required.
	BotId *string

	// The unique identifier of the bot recommendation to be stopped.
	//
	// This member is required.
	BotRecommendationId *string

	// The version of the bot containing the bot recommendation.
	//
	// This member is required.
	BotVersion *string

	// The identifier of the language and locale of the bot recommendation to stop.
	// The string must match one of the supported locales. For more information, see
	// Supported languages (https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html)
	//
	// This member is required.
	LocaleId *string
	// contains filtered or unexported fields
}

type StopBotRecommendationOutput added in v1.23.0 

type StopBotRecommendationOutput struct {

	// The unique identifier of the bot containing the bot recommendation that is
	// being stopped.
	BotId *string

	// The unique identifier of the bot recommendation that is being stopped.
	BotRecommendationId *string

	// The status of the bot recommendation. If the status is Failed, then the reasons
	// for the failure are listed in the failureReasons field.
	BotRecommendationStatus types.BotRecommendationStatus

	// The version of the bot containing the recommendation that is being stopped.
	BotVersion *string

	// The identifier of the language and locale of the bot response to stop. The
	// string must match one of the supported locales. For more information, see
	// Supported languages (https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html)
	LocaleId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type TagResourceInput 

type TagResourceInput struct {

	// The Amazon Resource Name (ARN) of the bot, bot alias, or bot channel to tag.
	//
	// This member is required.
	ResourceARN *string

	// A list of tag keys to add to the resource. If a tag key already exists, the
	// existing value is replaced with the new value.
	//
	// This member is required.
	Tags map[string]string
	// contains filtered or unexported fields
}

type TagResourceOutput 

type TagResourceOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UntagResourceInput 

type UntagResourceInput struct {

	// The Amazon Resource Name (ARN) of the resource to remove the tags from.
	//
	// This member is required.
	ResourceARN *string

	// A list of tag keys to remove from the resource. If a tag key does not exist on
	// the resource, it is ignored.
	//
	// This member is required.
	TagKeys []string
	// contains filtered or unexported fields
}

type UntagResourceOutput 

type UntagResourceOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateBotAliasInput 

type UpdateBotAliasInput struct {

	// The unique identifier of the bot alias.
	//
	// This member is required.
	BotAliasId *string

	// The new name to assign to the bot alias.
	//
	// This member is required.
	BotAliasName *string

	// The identifier of the bot with the updated alias.
	//
	// This member is required.
	BotId *string

	// The new Lambda functions to use in each locale for the bot alias.
	BotAliasLocaleSettings map[string]types.BotAliasLocaleSettings

	// The new bot version to assign to the bot alias.
	BotVersion *string

	// The new settings for storing conversation logs in Amazon CloudWatch Logs and
	// Amazon S3 buckets.
	ConversationLogSettings *types.ConversationLogSettings

	// The new description to assign to the bot alias.
	Description *string

	// Determines whether Amazon Lex will use Amazon Comprehend to detect the
	// sentiment of user utterances.
	SentimentAnalysisSettings *types.SentimentAnalysisSettings
	// contains filtered or unexported fields
}

type UpdateBotAliasOutput 

type UpdateBotAliasOutput struct {

	// The identifier of the updated bot alias.
	BotAliasId *string

	// The updated Lambda functions to use in each locale for the bot alias.
	BotAliasLocaleSettings map[string]types.BotAliasLocaleSettings

	// The updated name of the bot alias.
	BotAliasName *string

	// The current status of the bot alias. When the status is Available the alias is
	// ready for use.
	BotAliasStatus types.BotAliasStatus

	// The identifier of the bot with the updated alias.
	BotId *string

	// The updated version of the bot that the alias points to.
	BotVersion *string

	// The updated settings for storing conversation logs in Amazon CloudWatch Logs
	// and Amazon S3 buckets.
	ConversationLogSettings *types.ConversationLogSettings

	// A timestamp of the date and time that the bot was created.
	CreationDateTime *time.Time

	// The updated description of the bot alias.
	Description *string

	// A timestamp of the date and time that the bot was last updated.
	LastUpdatedDateTime *time.Time

	// Determines whether Amazon Lex will use Amazon Comprehend to detect the
	// sentiment of user utterances.
	SentimentAnalysisSettings *types.SentimentAnalysisSettings

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateBotInput 

type UpdateBotInput struct {

	// The unique identifier of the bot to update. This identifier is returned by the
	// CreateBot (https://docs.aws.amazon.com/lexv2/latest/APIReference/API_CreateBot.html)
	// operation.
	//
	// This member is required.
	BotId *string

	// The new name of the bot. The name must be unique in the account that creates
	// the bot.
	//
	// This member is required.
	BotName *string

	// Provides information on additional privacy protections Amazon Lex should use
	// with the bot's data.
	//
	// This member is required.
	DataPrivacy *types.DataPrivacy

	// The time, in seconds, that Amazon Lex should keep information about a user's
	// conversation with the bot. A user interaction 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. You can specify
	// between 60 (1 minute) and 86,400 (24 hours) seconds.
	//
	// This member is required.
	IdleSessionTTLInSeconds *int32

	// The Amazon Resource Name (ARN) of an IAM role that has permissions to access
	// the bot.
	//
	// This member is required.
	RoleArn *string

	// The list of bot members in the network associated with the update action.
	BotMembers []types.BotMember

	// The type of the bot to be updated.
	BotType types.BotType

	// A description of the bot.
	Description *string
	// contains filtered or unexported fields
}

type UpdateBotLocaleInput 

type UpdateBotLocaleInput struct {

	// The unique identifier of the bot that contains the locale.
	//
	// This member is required.
	BotId *string

	// The version of the bot that contains the locale to be updated. The version can
	// only be the DRAFT version.
	//
	// This member is required.
	BotVersion *string

	// The identifier of the language and locale to update. The string must match one
	// of the supported locales. For more information, see Supported languages (https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html)
	// .
	//
	// This member is required.
	LocaleId *string

	// The new confidence threshold where Amazon Lex inserts the AMAZON.FallbackIntent
	// and AMAZON.KendraSearchIntent intents in the list of possible intents for an
	// utterance.
	//
	// This member is required.
	NluIntentConfidenceThreshold *float64

	// The new description of the locale.
	Description *string

	// Contains settings for generative AI features powered by Amazon Bedrock for your
	// bot locale. Use this object to turn generative AI features on and off. Pricing
	// may differ if you turn a feature on. For more information, see LINK.
	GenerativeAISettings *types.GenerativeAISettings

	// The new Amazon Polly voice Amazon Lex should use for voice interaction with the
	// user.
	VoiceSettings *types.VoiceSettings
	// contains filtered or unexported fields
}

type UpdateBotLocaleOutput 

type UpdateBotLocaleOutput struct {

	// The identifier of the bot that contains the updated locale.
	BotId *string

	// The current status of the locale. When the bot status is Built the locale is
	// ready for use.
	BotLocaleStatus types.BotLocaleStatus

	// The version of the bot that contains the updated locale.
	BotVersion *string

	// A timestamp of the date and time that the locale was created.
	CreationDateTime *time.Time

	// The updated description of the locale.
	Description *string

	// If the botLocaleStatus is Failed , the failureReasons field lists the errors
	// that occurred while building the bot.
	FailureReasons []string

	// Contains settings for generative AI features powered by Amazon Bedrock for your
	// bot locale.
	GenerativeAISettings *types.GenerativeAISettings

	// A timestamp of the date and time that the locale was last updated.
	LastUpdatedDateTime *time.Time

	// The language and locale of the updated bot locale.
	LocaleId *string

	// The updated locale name for the locale.
	LocaleName *string

	// The updated confidence threshold for inserting the AMAZON.FallbackIntent and
	// AMAZON.KendraSearchIntent intents in the list of possible intents for an
	// utterance.
	NluIntentConfidenceThreshold *float64

	// Recommended actions to take to resolve an error in the failureReasons field.
	RecommendedActions []string

	// The updated Amazon Polly voice to use for voice interaction with the user.
	VoiceSettings *types.VoiceSettings

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateBotOutput 

type UpdateBotOutput struct {

	// The unique identifier of the bot that was updated.
	BotId *string

	// The list of bot members in the network that was updated.
	BotMembers []types.BotMember

	// The name of the bot after the update.
	BotName *string

	// Shows the current status of the bot. The bot is first in the Creating status.
	// Once the bot is read for use, it changes to the Available status. After the bot
	// is created, you can use the DRAFT version of the bot.
	BotStatus types.BotStatus

	// The type of the bot that was updated.
	BotType types.BotType

	// A timestamp of the date and time that the bot was created.
	CreationDateTime *time.Time

	// The data privacy settings for the bot after the update.
	DataPrivacy *types.DataPrivacy

	// The description of the bot after the update.
	Description *string

	// The session timeout, in seconds, for the bot after the update.
	IdleSessionTTLInSeconds *int32

	// A timestamp of the date and time that the bot was last updated.
	LastUpdatedDateTime *time.Time

	// The Amazon Resource Name (ARN) of the IAM role used by the bot after the update.
	RoleArn *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateBotRecommendationInput added in v1.14.0 

type UpdateBotRecommendationInput struct {

	// The unique identifier of the bot containing the bot recommendation to be
	// updated.
	//
	// This member is required.
	BotId *string

	// The unique identifier of the bot recommendation to be updated.
	//
	// This member is required.
	BotRecommendationId *string

	// The version of the bot containing the bot recommendation to be updated.
	//
	// This member is required.
	BotVersion *string

	// The object representing the passwords that will be used to encrypt the data
	// related to the bot recommendation results, as well as the KMS key ARN used to
	// encrypt the associated metadata.
	//
	// This member is required.
	EncryptionSetting *types.EncryptionSetting

	// The identifier of the language and locale of the bot recommendation to update.
	// The string must match one of the supported locales. For more information, see
	// Supported languages (https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html)
	//
	// This member is required.
	LocaleId *string
	// contains filtered or unexported fields
}

type UpdateBotRecommendationOutput added in v1.14.0 

type UpdateBotRecommendationOutput struct {

	// The unique identifier of the bot containing the bot recommendation that has
	// been updated.
	BotId *string

	// The unique identifier of the bot recommendation to be updated.
	BotRecommendationId *string

	// The status of the bot recommendation. If the status is Failed, then the reasons
	// for the failure are listed in the failureReasons field.
	BotRecommendationStatus types.BotRecommendationStatus

	// The version of the bot containing the bot recommendation that has been updated.
	BotVersion *string

	// A timestamp of the date and time that the bot recommendation was created.
	CreationDateTime *time.Time

	// The object representing the passwords that were used to encrypt the data
	// related to the bot recommendation results, as well as the KMS key ARN used to
	// encrypt the associated metadata.
	EncryptionSetting *types.EncryptionSetting

	// A timestamp of the date and time that the bot recommendation was last updated.
	LastUpdatedDateTime *time.Time

	// The identifier of the language and locale of the bot recommendation to update.
	// The string must match one of the supported locales. For more information, see
	// Supported languages (https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html)
	LocaleId *string

	// The object representing the Amazon S3 bucket containing the transcript, as well
	// as the associated metadata.
	TranscriptSourceSetting *types.TranscriptSourceSetting

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateExportInput added in v1.2.0 

type UpdateExportInput struct {

	// The unique identifier Amazon Lex assigned to the export.
	//
	// This member is required.
	ExportId *string

	// The new password to use to encrypt the export zip archive.
	FilePassword *string
	// contains filtered or unexported fields
}

type UpdateExportOutput added in v1.2.0 

type UpdateExportOutput struct {

	// The date and time that the export was created.
	CreationDateTime *time.Time

	// The unique identifier Amazon Lex assigned to the export.
	ExportId *string

	// The status of the export. When the status is Completed the export archive is
	// available for download.
	ExportStatus types.ExportStatus

	// The file format used for the files that define the resource. The TSV format is
	// required to export a custom vocabulary only; otherwise use LexJson format.
	FileFormat types.ImportExportFileFormat

	// The date and time that the export was last updated.
	LastUpdatedDateTime *time.Time

	// A description of the type of resource that was exported, either a bot or a bot
	// locale.
	ResourceSpecification *types.ExportResourceSpecification

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateIntentInput 

type UpdateIntentInput struct {

	// The identifier of the bot that contains the intent.
	//
	// This member is required.
	BotId *string

	// The version of the bot that contains the intent. Must be DRAFT .
	//
	// This member is required.
	BotVersion *string

	// The unique identifier of the intent to update.
	//
	// This member is required.
	IntentId *string

	// The new name for the intent.
	//
	// This member is required.
	IntentName *string

	// The identifier of the language and locale where this intent is used. The string
	// must match one of the supported locales. For more information, see Supported
	// languages (https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html) .
	//
	// This member is required.
	LocaleId *string

	// The new description of the intent.
	Description *string

	// The new Lambda function to use between each turn of the conversation with the
	// bot.
	DialogCodeHook *types.DialogCodeHookSettings

	// The new Lambda function to call when all of the intents required slots are
	// provided and the intent is ready for fulfillment.
	FulfillmentCodeHook *types.FulfillmentCodeHookSettings

	// Configuration settings for a response sent to the user before Amazon Lex starts
	// eliciting slots.
	InitialResponseSetting *types.InitialResponseSetting

	// A new list of contexts that must be active in order for Amazon Lex to consider
	// the intent.
	InputContexts []types.InputContext

	// The new response that Amazon Lex sends the user when the intent is closed.
	IntentClosingSetting *types.IntentClosingSetting

	// New prompts that Amazon Lex sends to the user to confirm the completion of an
	// intent.
	IntentConfirmationSetting *types.IntentConfirmationSetting

	// New configuration settings for connecting to an Amazon Kendra index.
	KendraConfiguration *types.KendraConfiguration

	// A new list of contexts that Amazon Lex activates when the intent is fulfilled.
	OutputContexts []types.OutputContext

	// The signature of the new built-in intent to use as the parent of this intent.
	ParentIntentSignature *string

	// Specifies the configuration of the built-in Amazon.QnAIntent . The
	// AMAZON.QnAIntent intent is called when Amazon Lex can't determine another intent
	// to invoke. If you specify this field, you can't specify the kendraConfiguration
	// field.
	QnAIntentConfiguration *types.QnAIntentConfiguration

	// New utterances used to invoke the intent.
	SampleUtterances []types.SampleUtterance

	// A new list of slots and their priorities that are contained by the intent.
	SlotPriorities []types.SlotPriority
	// contains filtered or unexported fields
}

type UpdateIntentOutput 

type UpdateIntentOutput struct {

	// The identifier of the bot that contains the intent.
	BotId *string

	// The version of the bot that contains the intent. Will always be DRAFT .
	BotVersion *string

	// A timestamp of when the intent was created.
	CreationDateTime *time.Time

	// The updated description of the intent.
	Description *string

	// The updated Lambda function called during each turn of the conversation with
	// the user.
	DialogCodeHook *types.DialogCodeHookSettings

	// The updated Lambda function called when the intent is ready for fulfillment.
	FulfillmentCodeHook *types.FulfillmentCodeHookSettings

	// Configuration settings for a response sent to the user before Amazon Lex starts
	// eliciting slots.
	InitialResponseSetting *types.InitialResponseSetting

	// The updated list of contexts that must be active for the intent to be
	// considered by Amazon Lex.
	InputContexts []types.InputContext

	// The updated response that Amazon Lex sends the user when the intent is closed.
	IntentClosingSetting *types.IntentClosingSetting

	// The updated prompts that Amazon Lex sends to the user to confirm the completion
	// of an intent.
	IntentConfirmationSetting *types.IntentConfirmationSetting

	// The identifier of the intent that was updated.
	IntentId *string

	// The updated name of the intent.
	IntentName *string

	// The updated configuration for connecting to an Amazon Kendra index with the
	// AMAZON.KendraSearchIntent intent.
	KendraConfiguration *types.KendraConfiguration

	// A timestamp of the last time that the intent was modified.
	LastUpdatedDateTime *time.Time

	// The updated language and locale of the intent.
	LocaleId *string

	// The updated list of contexts that Amazon Lex activates when the intent is
	// fulfilled.
	OutputContexts []types.OutputContext

	// The updated built-in intent that is the parent of this intent.
	ParentIntentSignature *string

	// Details about the configuration of the built-in Amazon.QnAIntent .
	QnAIntentConfiguration *types.QnAIntentConfiguration

	// The updated list of sample utterances for the intent.
	SampleUtterances []types.SampleUtterance

	// The updated list of slots and their priorities that are elicited from the user
	// for the intent.
	SlotPriorities []types.SlotPriority

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateResourcePolicyInput added in v1.2.0 

type UpdateResourcePolicyInput struct {

	// A resource policy to add to the resource. The policy is a JSON structure that
	// contains one or more statements that define the policy. The policy must follow
	// the IAM syntax. For more information about the contents of a JSON policy
	// document, see IAM JSON policy reference  (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies.html)
	// . If the policy isn't valid, Amazon Lex returns a validation exception.
	//
	// This member is required.
	Policy *string

	// The Amazon Resource Name (ARN) of the bot or bot alias that the resource policy
	// is attached to.
	//
	// This member is required.
	ResourceArn *string

	// The identifier of the revision of the policy to update. If this revision ID
	// doesn't match the current revision ID, Amazon Lex throws an exception. If you
	// don't specify a revision, Amazon Lex overwrites the contents of the policy with
	// the new values.
	ExpectedRevisionId *string
	// contains filtered or unexported fields
}

type UpdateResourcePolicyOutput added in v1.2.0 

type UpdateResourcePolicyOutput struct {

	// The Amazon Resource Name (ARN) of the bot or bot alias that the resource policy
	// is attached to.
	ResourceArn *string

	// The current revision of the resource policy. Use the revision ID to make sure
	// that you are updating the most current version of a resource policy when you add
	// a policy statement to a resource, delete a resource, or update a resource.
	RevisionId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateSlotInput 

type UpdateSlotInput struct {

	// The unique identifier of the bot that contains the slot.
	//
	// This member is required.
	BotId *string

	// The version of the bot that contains the slot. Must always be DRAFT .
	//
	// This member is required.
	BotVersion *string

	// The identifier of the intent that contains the slot.
	//
	// This member is required.
	IntentId *string

	// The identifier of the language and locale that contains the slot. The string
	// must match one of the supported locales. For more information, see Supported
	// languages (https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html) .
	//
	// This member is required.
	LocaleId *string

	// The unique identifier for the slot to update.
	//
	// This member is required.
	SlotId *string

	// The new name for the slot.
	//
	// This member is required.
	SlotName *string

	// A new set of prompts that Amazon Lex sends to the user to elicit a response the
	// provides a value for the slot.
	//
	// This member is required.
	ValueElicitationSetting *types.SlotValueElicitationSetting

	// The new description for the slot.
	Description *string

	// Determines whether the slot accepts multiple values in one response. Multiple
	// value slots are only available in the en-US locale. If you set this value to
	// true in any other locale, Amazon Lex throws a ValidationException . If the
	// multipleValuesSetting is not set, the default value is false .
	MultipleValuesSetting *types.MultipleValuesSetting

	// New settings that determine how slot values are formatted in Amazon CloudWatch
	// logs.
	ObfuscationSetting *types.ObfuscationSetting

	// The unique identifier of the new slot type to associate with this slot.
	SlotTypeId *string

	// Specifications for the constituent sub slots and the expression for the
	// composite slot.
	SubSlotSetting *types.SubSlotSetting
	// contains filtered or unexported fields
}

type UpdateSlotOutput 

type UpdateSlotOutput struct {

	// The identifier of the bot that contains the slot.
	BotId *string

	// The version of the bot that contains the slot. Will always be DRAFT .
	BotVersion *string

	// The timestamp of the date and time that the slot was created.
	CreationDateTime *time.Time

	// The updated description of the bot.
	Description *string

	// The intent that contains the slot.
	IntentId *string

	// The timestamp of the date and time that the slot was last updated.
	LastUpdatedDateTime *time.Time

	// The locale that contains the slot.
	LocaleId *string

	// Indicates whether the slot accepts multiple values in one response.
	MultipleValuesSetting *types.MultipleValuesSetting

	// The updated setting that determines whether the slot value is obfuscated in the
	// Amazon CloudWatch logs.
	ObfuscationSetting *types.ObfuscationSetting

	// The unique identifier of the slot that was updated.
	SlotId *string

	// The updated name of the slot.
	SlotName *string

	// The updated identifier of the slot type that provides values for the slot.
	SlotTypeId *string

	// Specifications for the constituent sub slots and the expression for the
	// composite slot.
	SubSlotSetting *types.SubSlotSetting

	// The updated prompts that Amazon Lex sends to the user to elicit a response that
	// provides a value for the slot.
	ValueElicitationSetting *types.SlotValueElicitationSetting

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateSlotTypeInput 

type UpdateSlotTypeInput struct {

	// The identifier of the bot that contains the slot type.
	//
	// This member is required.
	BotId *string

	// The version of the bot that contains the slot type. Must be DRAFT .
	//
	// This member is required.
	BotVersion *string

	// The identifier of the language and locale that contains the slot type. The
	// string must match one of the supported locales. For more information, see
	// Supported languages (https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html)
	// .
	//
	// This member is required.
	LocaleId *string

	// The unique identifier of the slot type to update.
	//
	// This member is required.
	SlotTypeId *string

	// The new name of the slot type.
	//
	// This member is required.
	SlotTypeName *string

	// Specifications for a composite slot type.
	CompositeSlotTypeSetting *types.CompositeSlotTypeSetting

	// The new description of the slot type.
	Description *string

	// Provides information about the external source of the slot type's definition.
	ExternalSourceSetting *types.ExternalSourceSetting

	// The new built-in slot type that should be used as the parent of this slot type.
	ParentSlotTypeSignature *string

	// A new list of values and their optional synonyms that define the values that
	// the slot type can take.
	SlotTypeValues []types.SlotTypeValue

	// The strategy that Amazon Lex should use when deciding on a value from the list
	// of slot type values.
	ValueSelectionSetting *types.SlotValueSelectionSetting
	// contains filtered or unexported fields
}

type UpdateSlotTypeOutput 

type UpdateSlotTypeOutput struct {

	// The identifier of the bot that contains the slot type.
	BotId *string

	// The version of the bot that contains the slot type. This is always DRAFT .
	BotVersion *string

	// Specifications for a composite slot type.
	CompositeSlotTypeSetting *types.CompositeSlotTypeSetting

	// The timestamp of the date and time that the slot type was created.
	CreationDateTime *time.Time

	// The updated description of the slot type.
	Description *string

	// Provides information about the external source of the slot type's definition.
	ExternalSourceSetting *types.ExternalSourceSetting

	// A timestamp of the date and time that the slot type was last updated.
	LastUpdatedDateTime *time.Time

	// The language and locale of the updated slot type.
	LocaleId *string

	// The updated signature of the built-in slot type that is the parent of this slot
	// type.
	ParentSlotTypeSignature *string

	// The unique identifier of the updated slot type.
	SlotTypeId *string

	// The updated name of the slot type.
	SlotTypeName *string

	// The updated values that the slot type provides.
	SlotTypeValues []types.SlotTypeValue

	// The updated strategy that Amazon Lex uses to determine which value to select
	// from the slot type.
	ValueSelectionSetting *types.SlotValueSelectionSetting

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateTestSetInput added in v1.29.0 

type UpdateTestSetInput struct {

	// The test set Id for which update test operation to be performed.
	//
	// This member is required.
	TestSetId *string

	// The new test set name.
	//
	// This member is required.
	TestSetName *string

	// The new test set description.
	Description *string
	// contains filtered or unexported fields
}

type UpdateTestSetOutput added in v1.29.0 

type UpdateTestSetOutput struct {

	// The creation date and time for the updated test set.
	CreationDateTime *time.Time

	// The test set description for the updated test set.
	Description *string

	// The date and time of the last update for the updated test set.
	LastUpdatedDateTime *time.Time

	// Indicates whether audio or text is used for the updated test set.
	Modality types.TestSetModality

	// The number of conversation turns from the updated test set.
	NumTurns *int32

	// The roleARN used for any operation in the test set to access resources in the
	// Amazon Web Services account.
	RoleArn *string

	// The status for the updated test set.
	Status types.TestSetStatus

	// The Amazon S3 storage location for the updated test set.
	StorageLocation *types.TestSetStorageLocation

	// The test set Id for which update test operation to be performed.
	TestSetId *string

	// The test set name for the updated test set.
	TestSetName *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

Source Files

View all Source files

Directories

Path Synopsis
internal
endpoints

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.