Class: Aws::LexModelBuildingService::Client

Inherits:
Seahorse::Client::Base
  • Object
show all
Includes:
ClientStubs
Defined in:
lib/aws-sdk-lexmodelbuildingservice/client.rb

Overview

An API client for LexModelBuildingService. To construct a client, you need to configure a ‘:region` and `:credentials`.

client = Aws::LexModelBuildingService::Client.new(
  region: region_name,
  credentials: credentials,
  # ...
)

For details on configuring region and credentials see the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).

See #initialize for a full list of supported configuration options.

Class Attribute Summary collapse

API Operations collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options) ⇒ Client

Returns a new instance of Client.

Parameters:

  • options (Hash)

Options Hash (options):

  • :plugins (Array<Seahorse::Client::Plugin>) — default: []] —

    A list of plugins to apply to the client. Each plugin is either a class name or an instance of a plugin class.

  • :credentials (required, Aws::CredentialProvider) —

    Your AWS credentials used for authentication. This can be any class that includes and implements ‘Aws::CredentialProvider`, or instance of any one of the following classes:

    • ‘Aws::Credentials` - Used for configuring static, non-refreshing credentials.

    • ‘Aws::SharedCredentials` - Used for loading static credentials from a shared file, such as `~/.aws/config`.

    • ‘Aws::AssumeRoleCredentials` - Used when you need to assume a role.

    • ‘Aws::AssumeRoleWebIdentityCredentials` - Used when you need to assume a role after providing credentials via the web.

    • ‘Aws::SSOCredentials` - Used for loading credentials from AWS SSO using an access token generated from `aws login`.

    • ‘Aws::ProcessCredentials` - Used for loading credentials from a process that outputs to stdout.

    • ‘Aws::InstanceProfileCredentials` - Used for loading credentials from an EC2 IMDS on an EC2 instance.

    • ‘Aws::ECSCredentials` - Used for loading credentials from instances running in ECS.

    • ‘Aws::CognitoIdentityCredentials` - Used for loading credentials from the Cognito Identity service.

    When ‘:credentials` are not configured directly, the following locations will be searched for credentials:

    • ‘Aws.config`

    • The ‘:access_key_id`, `:secret_access_key`, `:session_token`, and `:account_id` options.

    • ‘ENV`, `ENV`, `ENV`, and `ENV`.

    • ‘~/.aws/credentials`

    • ‘~/.aws/config`

    • EC2/ECS IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of ‘Aws::InstanceProfileCredentials` or `Aws::ECSCredentials` to enable retries and extended timeouts. Instance profile credential fetching can be disabled by setting `ENV` to `true`.

  • :region (required, String) —

    The AWS region to connect to. The configured ‘:region` is used to determine the service `:endpoint`. When not passed, a default `:region` is searched for in the following locations:

  • :access_key_id (String)
  • :account_id (String)
  • :active_endpoint_cache (Boolean) — default: false —

    When set to ‘true`, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to `false`.

  • :adaptive_retry_wait_to_fill (Boolean) — default: true —

    Used only in ‘adaptive` retry mode. When true, the request will sleep until there is sufficent client side capacity to retry the request. When false, the request will raise a `RetryCapacityNotAvailableError` and will not retry instead of sleeping.

  • :auth_scheme_preference (Array<String>) —

    A list of preferred authentication schemes to use when making a request. Supported values are: ‘sigv4`, `sigv4a`, `httpBearerAuth`, and `noAuth`. When set using `ENV` or in shared config as `auth_scheme_preference`, the value should be a comma-separated list.

  • :client_side_monitoring (Boolean) — default: false —

    When ‘true`, client-side metrics will be collected for all API requests from this client.

  • :client_side_monitoring_client_id (String) — default: "" —

    Allows you to provide an identifier for this client which will be attached to all generated client side metrics. Defaults to an empty string.

  • :client_side_monitoring_host (String) — default: "127.0.0.1" —

    Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_port (Integer) — default: 31000 —

    Required for publishing client metrics. The port that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher) — default: Aws::ClientSideMonitoring::Publisher —

    Allows you to provide a custom client-side monitoring publisher class. By default, will use the Client Side Monitoring Agent Publisher.

  • :convert_params (Boolean) — default: true —

    When ‘true`, an attempt is made to coerce request parameters into the required types.

  • :correct_clock_skew (Boolean) — default: true —

    Used only in ‘standard` and `adaptive` retry modes. Specifies whether to apply a clock skew correction and retry requests with skewed client clocks.

  • :defaults_mode (String) — default: "legacy" —

    See DefaultsModeConfiguration for a list of the accepted modes and the configuration defaults that are included.

  • :disable_host_prefix_injection (Boolean) — default: false —

    When ‘true`, the SDK will not prepend the modeled host prefix to the endpoint.

  • :disable_request_compression (Boolean) — default: false —

    When set to ‘true’ the request body will not be compressed for supported operations.

  • :endpoint (String, URI::HTTPS, URI::HTTP) —

    Normally you should not configure the ‘:endpoint` option directly. This is normally constructed from the `:region` option. Configuring `:endpoint` is normally reserved for connecting to test or custom endpoints. The endpoint should be a URI formatted like:

    'http://example.com'
'https://example.com'
'http://example.com:123'
  • :endpoint_cache_max_entries (Integer) — default: 1000 —

    Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000.

  • :endpoint_cache_max_threads (Integer) — default: 10 —

    Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.

  • :endpoint_cache_poll_interval (Integer) — default: 60 —

    When :endpoint_discovery and :active_endpoint_cache is enabled, Use this option to config the time interval in seconds for making requests fetching endpoints information. Defaults to 60 sec.

  • :endpoint_discovery (Boolean) — default: false —

    When set to ‘true`, endpoint discovery will be enabled for operations when available.

  • :ignore_configured_endpoint_urls (Boolean) —

    Setting to true disables use of endpoint URLs provided via environment variables and the shared configuration file.

  • :log_formatter (Aws::Log::Formatter) — default: Aws::Log::Formatter.default —

    The log formatter.

  • :log_level (Symbol) — default: :info —

    The log level to send messages to the ‘:logger` at.

  • :logger (Logger) —

    The Logger instance to send log messages to. If this option is not set, logging will be disabled.

  • :max_attempts (Integer) — default: 3 —

    An integer representing the maximum number attempts that will be made for a single request, including the initial attempt. For example, setting this value to 5 will result in a request being retried up to 4 times. Used in ‘standard` and `adaptive` retry modes.

  • :profile (String) — default: "default" —

    Used when loading credentials from the shared credentials file at ‘HOME/.aws/credentials`. When not specified, ’default’ is used.

  • :request_checksum_calculation (String) — default: "when_supported" —

    Determines when a checksum will be calculated for request payloads. Values are:

    • ‘when_supported` - (default) When set, a checksum will be calculated for all request payloads of operations modeled with the `httpChecksum` trait where `requestChecksumRequired` is `true` and/or a `requestAlgorithmMember` is modeled.

    • ‘when_required` - When set, a checksum will only be calculated for request payloads of operations modeled with the `httpChecksum` trait where `requestChecksumRequired` is `true` or where a `requestAlgorithmMember` is modeled and supplied.

  • :request_min_compression_size_bytes (Integer) — default: 10240 —

    The minimum size in bytes that triggers compression for request bodies. The value must be non-negative integer value between 0 and 10485780 bytes inclusive.

  • :response_checksum_validation (String) — default: "when_supported" —

    Determines when checksum validation will be performed on response payloads. Values are:

    • ‘when_supported` - (default) When set, checksum validation is performed on all response payloads of operations modeled with the `httpChecksum` trait where `responseAlgorithms` is modeled, except when no modeled checksum algorithms are supported.

    • ‘when_required` - When set, checksum validation is not performed on response payloads of operations unless the checksum algorithm is supported and the `requestValidationModeMember` member is set to `ENABLED`.

  • :retry_backoff (Proc) —

    A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay. This option is only used in the ‘legacy` retry mode.

  • :retry_base_delay (Float) — default: 0.3 —

    The base delay in seconds used by the default backoff function. This option is only used in the ‘legacy` retry mode.

  • :retry_jitter (Symbol) — default: :none —

    A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number. This option is only used in the ‘legacy` retry mode.

    @see www.awsarchitectureblog.com/2015/03/backoff.html

  • :retry_limit (Integer) — default: 3 —

    The maximum number of times to retry failed requests. Only ~ 500 level server errors and certain ~ 400 level client errors are retried. Generally, these are throttling errors, data checksum errors, networking errors, timeout errors, auth errors, endpoint discovery, and errors from expired credentials. This option is only used in the ‘legacy` retry mode.

  • :retry_max_delay (Integer) — default: 0 —

    The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function. This option is only used in the ‘legacy` retry mode.

  • :retry_mode (String) — default: "legacy" —

    Specifies which retry algorithm to use. Values are:

    • ‘legacy` - The pre-existing retry behavior. This is the default value if no retry mode is provided.

    • ‘standard` - A standardized set of retry rules across the AWS SDKs. This includes support for retry quotas, which limit the number of unsuccessful retries a client can make.

    • ‘adaptive` - A retry mode that includes all the functionality of `standard` mode along with automatic client side throttling.

  • :sdk_ua_app_id (String) —

    A unique and opaque application ID that is appended to the User-Agent header as app/sdk_ua_app_id. It should have a maximum length of 50. This variable is sourced from environment variable AWS_SDK_UA_APP_ID or the shared config profile attribute sdk_ua_app_id.

  • :secret_access_key (String)
  • :session_token (String)
  • :sigv4a_signing_region_set (Array) —

    A list of regions that should be signed with SigV4a signing. When not passed, a default ‘:sigv4a_signing_region_set` is searched for in the following locations:

  • :stub_responses (Boolean) — default: false —

    Causes the client to return stubbed responses. By default fake responses are generated and returned. You can specify the response data to return or errors to raise by calling ClientStubs#stub_responses. See ClientStubs for more information.

    ** Please note ** When response stubbing is enabled, no HTTP requests are made, and retries are disabled.

  • :telemetry_provider (Aws::Telemetry::TelemetryProviderBase) — default: Aws::Telemetry::NoOpTelemetryProvider —

    Allows you to provide a telemetry provider, which is used to emit telemetry data. By default, uses ‘NoOpTelemetryProvider` which will not record or emit any telemetry data. The SDK supports the following telemetry providers:

    • OpenTelemetry (OTel) - To use the OTel provider, install and require the

    ‘opentelemetry-sdk` gem and then, pass in an instance of a `Aws::Telemetry::OTelProvider` for telemetry provider.

  • :token_provider (Aws::TokenProvider) —

    Your Bearer token used for authentication. This can be any class that includes and implements ‘Aws::TokenProvider`, or instance of any one of the following classes:

    • ‘Aws::StaticTokenProvider` - Used for configuring static, non-refreshing tokens.

    • ‘Aws::SSOTokenProvider` - Used for loading tokens from AWS SSO using an access token generated from `aws login`.

    When ‘:token_provider` is not configured directly, the `Aws::TokenProviderChain` will be used to search for tokens configured for your profile in shared configuration files.

  • :use_dualstack_endpoint (Boolean) —

    When set to ‘true`, dualstack enabled endpoints (with `.aws` TLD) will be used if available.

  • :use_fips_endpoint (Boolean) —

    When set to ‘true`, fips compatible endpoints will be used if available. When a `fips` region is used, the region is normalized and this config is set to `true`.

  • :validate_params (Boolean) — default: true —

    When ‘true`, request parameters are validated before sending the request.

  • :endpoint_provider (Aws::LexModelBuildingService::EndpointProvider) —

    The endpoint provider used to resolve endpoints. Any object that responds to ‘#resolve_endpoint(parameters)` where `parameters` is a Struct similar to `Aws::LexModelBuildingService::EndpointParameters`.

  • :http_continue_timeout (Float) — default: 1 —

    The number of seconds to wait for a 100-continue response before sending the request body. This option has no effect unless the request has “Expect” header set to “100-continue”. Defaults to ‘nil` which disables this behaviour. This value can safely be set per request on the session.

  • :http_idle_timeout (Float) — default: 5 —

    The number of seconds a connection is allowed to sit idle before it is considered stale. Stale connections are closed and removed from the pool before making a request.

  • :http_open_timeout (Float) — default: 15 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_proxy (URI::HTTP, String) —

    A proxy to send requests through. Formatted like ‘proxy.com:123’.

  • :http_read_timeout (Float) — default: 60 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_wire_trace (Boolean) — default: false —

    When ‘true`, HTTP debug output will be sent to the `:logger`.

  • :on_chunk_received (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the response body is received. It provides three arguments: the chunk, the number of bytes received, and the total number of bytes in the response (or nil if the server did not send a ‘content-length`).

  • :on_chunk_sent (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the request body is sent. It provides three arguments: the chunk, the number of bytes read from the body, and the total number of bytes in the body.

  • :raise_response_errors (Boolean) — default: true —

    When ‘true`, response errors are raised.

  • :ssl_ca_bundle (String) —

    Full path to the SSL certificate authority bundle file that should be used when verifying peer certificates. If you do not pass ‘:ssl_ca_bundle` or `:ssl_ca_directory` the the system default will be used if available.

  • :ssl_ca_directory (String) —

    Full path of the directory that contains the unbundled SSL certificate authority files for verifying peer certificates. If you do not pass ‘:ssl_ca_bundle` or `:ssl_ca_directory` the the system default will be used if available.

  • :ssl_ca_store (String) —

    Sets the X509::Store to verify peer certificate.

  • :ssl_cert (OpenSSL::X509::Certificate) —

    Sets a client certificate when creating http connections.

  • :ssl_key (OpenSSL::PKey) —

    Sets a client key when creating http connections.

  • :ssl_timeout (Float) —

    Sets the SSL timeout in seconds

  • :ssl_verify_peer (Boolean) — default: true —

    When ‘true`, SSL peer certificates are verified when establishing a connection.



471
472
473
 
# File 'lib/aws-sdk-lexmodelbuildingservice/client.rb', line 471

def initialize(*args)
  super
end

Class Attribute Details

.identifier ⇒ Object (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



4537
4538
4539
 
# File 'lib/aws-sdk-lexmodelbuildingservice/client.rb', line 4537

def identifier
  @identifier
end

Class Method Details

.errors_module ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



4540
4541
4542
 
# File 'lib/aws-sdk-lexmodelbuildingservice/client.rb', line 4540

def errors_module
  Errors
end

Instance Method Details

#build_request(operation_name, params = {}) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Parameters:

  • params ({}) (defaults to: {}) 


4510
4511
4512
4513
4514
4515
4516
4517
4518
4519
4520
4521
4522
4523
4524
4525
4526
 
# File 'lib/aws-sdk-lexmodelbuildingservice/client.rb', line 4510

def build_request(operation_name, params = {})
  handlers = @handlers.for(operation_name)
  tracer = config.telemetry_provider.tracer_provider.tracer(
    Aws::Telemetry.module_to_tracer_name('Aws::LexModelBuildingService')
  )
  context = Seahorse::Client::RequestContext.new(
    operation_name: operation_name,
    operation: config.api.operation(operation_name),
    client: self,
    params: params,
    config: config,
    tracer: tracer
  )
  context[:gem_name] = 'aws-sdk-lexmodelbuildingservice'
  context[:gem_version] = '1.106.0'
  Seahorse::Client::Request.new(handlers, context)
end

#create_bot_version(params = {}) ⇒ Types::CreateBotVersionResponse

Creates a new version of the bot based on the ‘$LATEST` version. If the `$LATEST` version of this resource hasn’t changed since you created the last version, Amazon Lex doesn’t create a new version. It returns the last created version.

<note markdown=“1”> You can update only the ‘$LATEST` version of the bot. You can’t update the numbered versions that you create with the ‘CreateBotVersion` operation.

</note>

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

This operation requires permission for the ‘lex:CreateBotVersion` action.

Examples:

Request syntax with placeholder values


resp = client.create_bot_version({
  name: "BotName", # required
  checksum: "String",
})

Response structure


resp.name #=> String
resp.description #=> String
resp.intents #=> Array
resp.intents[0].intent_name #=> String
resp.intents[0].intent_version #=> String
resp.clarification_prompt.messages #=> Array
resp.clarification_prompt.messages[0].content_type #=> String, one of "PlainText", "SSML", "CustomPayload"
resp.clarification_prompt.messages[0].content #=> String
resp.clarification_prompt.messages[0].group_number #=> Integer
resp.clarification_prompt.max_attempts #=> Integer
resp.clarification_prompt.response_card #=> String
resp.abort_statement.messages #=> Array
resp.abort_statement.messages[0].content_type #=> String, one of "PlainText", "SSML", "CustomPayload"
resp.abort_statement.messages[0].content #=> String
resp.abort_statement.messages[0].group_number #=> Integer
resp.abort_statement.response_card #=> String
resp.status #=> String, one of "BUILDING", "READY", "READY_BASIC_TESTING", "FAILED", "NOT_BUILT"
resp.failure_reason #=> String
resp.last_updated_date #=> Time
resp.created_date #=> Time
resp.idle_session_ttl_in_seconds #=> Integer
resp.voice_id #=> String
resp.checksum #=> String
resp.version #=> String
resp.locale #=> String, one of "de-DE", "en-AU", "en-GB", "en-IN", "en-US", "es-419", "es-ES", "es-US", "fr-FR", "fr-CA", "it-IT", "ja-JP", "ko-KR"
resp.child_directed #=> Boolean
resp.enable_model_improvements #=> Boolean
resp.detect_sentiment #=> Boolean

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :name (required, String) —

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

  • :checksum (String) —

    Identifies a specific revision of the ‘$LATEST` version of the bot. If you specify a checksum and the `$LATEST` version of the bot has a different checksum, a `PreconditionFailedException` exception is returned and Amazon Lex doesn’t publish a new version. If you don’t specify a checksum, Amazon Lex publishes the ‘$LATEST` version.

Returns:

See Also:



568
569
570
571
 
# File 'lib/aws-sdk-lexmodelbuildingservice/client.rb', line 568

def create_bot_version(params = {}, options = {})
  req = build_request(:create_bot_version, params)
  req.send_request(options)
end

#create_intent_version(params = {}) ⇒ Types::CreateIntentVersionResponse

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

<note markdown=“1”> You can update only the ‘$LATEST` version of the intent. You can’t update the numbered versions that you create with the ‘CreateIntentVersion` operation.

</note>

When you create a version of an intent, Amazon Lex sets the version to

  1. Subsequent versions increment by 1. For more information, see

versioning-intro.

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

Examples:

Request syntax with placeholder values


resp = client.create_intent_version({
  name: "IntentName", # required
  checksum: "String",
})

Response structure


resp.name #=> String
resp.description #=> String
resp.slots #=> Array
resp.slots[0].name #=> String
resp.slots[0].description #=> String
resp.slots[0].slot_constraint #=> String, one of "Required", "Optional"
resp.slots[0].slot_type #=> String
resp.slots[0].slot_type_version #=> String
resp.slots[0].value_elicitation_prompt.messages #=> Array
resp.slots[0].value_elicitation_prompt.messages[0].content_type #=> String, one of "PlainText", "SSML", "CustomPayload"
resp.slots[0].value_elicitation_prompt.messages[0].content #=> String
resp.slots[0].value_elicitation_prompt.messages[0].group_number #=> Integer
resp.slots[0].value_elicitation_prompt.max_attempts #=> Integer
resp.slots[0].value_elicitation_prompt.response_card #=> String
resp.slots[0].priority #=> Integer
resp.slots[0].sample_utterances #=> Array
resp.slots[0].sample_utterances[0] #=> String
resp.slots[0].response_card #=> String
resp.slots[0].obfuscation_setting #=> String, one of "NONE", "DEFAULT_OBFUSCATION"
resp.slots[0].default_value_spec.default_value_list #=> Array
resp.slots[0].default_value_spec.default_value_list[0].default_value #=> String
resp.sample_utterances #=> Array
resp.sample_utterances[0] #=> String
resp.confirmation_prompt.messages #=> Array
resp.confirmation_prompt.messages[0].content_type #=> String, one of "PlainText", "SSML", "CustomPayload"
resp.confirmation_prompt.messages[0].content #=> String
resp.confirmation_prompt.messages[0].group_number #=> Integer
resp.confirmation_prompt.max_attempts #=> Integer
resp.confirmation_prompt.response_card #=> String
resp.rejection_statement.messages #=> Array
resp.rejection_statement.messages[0].content_type #=> String, one of "PlainText", "SSML", "CustomPayload"
resp.rejection_statement.messages[0].content #=> String
resp.rejection_statement.messages[0].group_number #=> Integer
resp.rejection_statement.response_card #=> String
resp.follow_up_prompt.prompt.messages #=> Array
resp.follow_up_prompt.prompt.messages[0].content_type #=> String, one of "PlainText", "SSML", "CustomPayload"
resp.follow_up_prompt.prompt.messages[0].content #=> String
resp.follow_up_prompt.prompt.messages[0].group_number #=> Integer
resp.follow_up_prompt.prompt.max_attempts #=> Integer
resp.follow_up_prompt.prompt.response_card #=> String
resp.follow_up_prompt.rejection_statement.messages #=> Array
resp.follow_up_prompt.rejection_statement.messages[0].content_type #=> String, one of "PlainText", "SSML", "CustomPayload"
resp.follow_up_prompt.rejection_statement.messages[0].content #=> String
resp.follow_up_prompt.rejection_statement.messages[0].group_number #=> Integer
resp.follow_up_prompt.rejection_statement.response_card #=> String
resp.conclusion_statement.messages #=> Array
resp.conclusion_statement.messages[0].content_type #=> String, one of "PlainText", "SSML", "CustomPayload"
resp.conclusion_statement.messages[0].content #=> String
resp.conclusion_statement.messages[0].group_number #=> Integer
resp.conclusion_statement.response_card #=> String
resp.dialog_code_hook.uri #=> String
resp.dialog_code_hook.message_version #=> String
resp.fulfillment_activity.type #=> String, one of "ReturnIntent", "CodeHook"
resp.fulfillment_activity.code_hook.uri #=> String
resp.fulfillment_activity.code_hook.message_version #=> String
resp.parent_intent_signature #=> String
resp.last_updated_date #=> Time
resp.created_date #=> Time
resp.version #=> String
resp.checksum #=> String
resp.kendra_configuration.kendra_index #=> String
resp.kendra_configuration.query_filter_string #=> String
resp.kendra_configuration.role #=> String
resp.input_contexts #=> Array
resp.input_contexts[0].name #=> String
resp.output_contexts #=> Array
resp.output_contexts[0].name #=> String
resp.output_contexts[0].time_to_live_in_seconds #=> Integer
resp.output_contexts[0].turns_to_live #=> Integer

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :name (required, String) —

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

  • :checksum (String) —

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

Returns:

See Also:



707
708
709
710
 
# File 'lib/aws-sdk-lexmodelbuildingservice/client.rb', line 707

def create_intent_version(params = {}, options = {})
  req = build_request(:create_intent_version, params)
  req.send_request(options)
end

#create_slot_type_version(params = {}) ⇒ Types::CreateSlotTypeVersionResponse

Creates a new version of a slot type based on the ‘$LATEST` version of the specified slot type. If the `$LATEST` version of this resource has not changed since the last version that you created, Amazon Lex doesn’t create a new version. It returns the last version that you created.

<note markdown=“1”> You can update only the ‘$LATEST` version of a slot type. You can’t update the numbered versions that you create with the ‘CreateSlotTypeVersion` operation.

</note>

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

This operation requires permissions for the ‘lex:CreateSlotTypeVersion` action.

Examples:

Request syntax with placeholder values


resp = client.create_slot_type_version({
  name: "SlotTypeName", # required
  checksum: "String",
})

Response structure


resp.name #=> String
resp.description #=> String
resp.enumeration_values #=> Array
resp.enumeration_values[0].value #=> String
resp.enumeration_values[0].synonyms #=> Array
resp.enumeration_values[0].synonyms[0] #=> String
resp.last_updated_date #=> Time
resp.created_date #=> Time
resp.version #=> String
resp.checksum #=> String
resp.value_selection_strategy #=> String, one of "ORIGINAL_VALUE", "TOP_RESOLUTION"
resp.parent_slot_type_signature #=> String
resp.slot_type_configurations #=> Array
resp.slot_type_configurations[0].regex_configuration.pattern #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :name (required, String) —

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

  • :checksum (String) —

    Checksum for the ‘$LATEST` version of the slot type that you want to publish. If you specify a checksum and the `$LATEST` version of the slot type has a different checksum, Amazon Lex returns a `PreconditionFailedException` exception and doesn’t publish the new version. If you don’t specify a checksum, Amazon Lex publishes the ‘$LATEST` version.

Returns:

See Also:



784
785
786
787
 
# File 'lib/aws-sdk-lexmodelbuildingservice/client.rb', line 784

def create_slot_type_version(params = {}, options = {})
  req = build_request(:create_slot_type_version, params)
  req.send_request(options)
end

#delete_bot(params = {}) ⇒ Struct

Deletes all versions of the bot, including the ‘$LATEST` version. To delete a specific version of the bot, use the DeleteBotVersion operation. The `DeleteBot` operation doesn’t immediately remove the bot schema. Instead, it is marked for deletion and removed later.

Amazon Lex stores utterances indefinitely for improving the ability of your bot to respond to user inputs. These utterances are not removed when the bot is deleted. To remove the utterances, use the DeleteUtterances operation.

If a bot has an alias, you can’t delete it. Instead, the ‘DeleteBot` operation returns a `ResourceInUseException` exception that includes a reference to the alias that refers to the bot. To remove the reference to the bot, delete the alias. If you get the same exception again, delete the referring alias until the `DeleteBot` operation is successful.

This operation requires permissions for the ‘lex:DeleteBot` action.

Examples:

Request syntax with placeholder values


resp = client.delete_bot({
  name: "BotName", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :name (required, String) —

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

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



823
824
825
826
 
# File 'lib/aws-sdk-lexmodelbuildingservice/client.rb', line 823

def delete_bot(params = {}, options = {})
  req = build_request(:delete_bot, params)
  req.send_request(options)
end

#delete_bot_alias(params = {}) ⇒ Struct

Deletes an alias for the specified bot.

You can’t delete an alias that is used in the association between a bot and a messaging channel. If an alias is used in a channel association, the ‘DeleteBot` operation returns a `ResourceInUseException` exception that includes a reference to the channel association that refers to the bot. You can remove the reference to the alias by deleting the channel association. If you get the same exception again, delete the referring association until the `DeleteBotAlias` operation is successful.

Examples:

Request syntax with placeholder values


resp = client.delete_bot_alias({
  name: "AliasName", # required
  bot_name: "BotName", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :name (required, String) —

    The name of the alias to delete. The name is case sensitive.

  • :bot_name (required, String) —

    The name of the bot that the alias points to.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



858
859
860
861
 
# File 'lib/aws-sdk-lexmodelbuildingservice/client.rb', line 858

def delete_bot_alias(params = {}, options = {})
  req = build_request(:delete_bot_alias, params)
  req.send_request(options)
end

#delete_bot_channel_association(params = {}) ⇒ Struct

Deletes the association between an Amazon Lex bot and a messaging platform.

This operation requires permission for the ‘lex:DeleteBotChannelAssociation` action.

Examples:

Request syntax with placeholder values


resp = client.delete_bot_channel_association({
  name: "BotChannelName", # required
  bot_name: "BotName", # required
  bot_alias: "AliasName", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :name (required, String) —

    The name of the association. The name is case sensitive.

  • :bot_name (required, String) —

    The name of the Amazon Lex bot.

  • :bot_alias (required, String) —

    An alias that points to the specific version of the Amazon Lex bot to which this association is being made.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



893
894
895
896
 
# File 'lib/aws-sdk-lexmodelbuildingservice/client.rb', line 893

def delete_bot_channel_association(params = {}, options = {})
  req = build_request(:delete_bot_channel_association, params)
  req.send_request(options)
end

#delete_bot_version(params = {}) ⇒ Struct

Deletes a specific version of a bot. To delete all versions of a bot, use the DeleteBot operation.

This operation requires permissions for the ‘lex:DeleteBotVersion` action.

Examples:

Request syntax with placeholder values


resp = client.delete_bot_version({
  name: "BotName", # required
  version: "NumericalVersion", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :name (required, String) —

    The name of the bot.

  • :version (required, String) —

    The version of the bot to delete. You cannot delete the ‘$LATEST` version of the bot. To delete the `$LATEST` version, use the DeleteBot operation.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



925
926
927
928
 
# File 'lib/aws-sdk-lexmodelbuildingservice/client.rb', line 925

def delete_bot_version(params = {}, options = {})
  req = build_request(:delete_bot_version, params)
  req.send_request(options)
end

#delete_intent(params = {}) ⇒ Struct

Deletes all versions of the intent, including the ‘$LATEST` version. To delete a specific version of the intent, use the DeleteIntentVersion operation.

You can delete a version of an intent only if it is not referenced. To delete an intent that is referred to in one or more bots (see how-it-works), you must remove those references first.

<note markdown=“1”> If you get the ‘ResourceInUseException` exception, it provides an example reference that shows where the intent is referenced. To remove the reference to the intent, either update the bot or delete it. If you get the same exception when you attempt to delete the intent again, repeat until the intent has no references and the call to `DeleteIntent` is successful.

</note>

This operation requires permission for the ‘lex:DeleteIntent` action.

Examples:

Request syntax with placeholder values


resp = client.delete_intent({
  name: "IntentName", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :name (required, String) —

    The name of the intent. The name is case sensitive.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



964
965
966
967
 
# File 'lib/aws-sdk-lexmodelbuildingservice/client.rb', line 964

def delete_intent(params = {}, options = {})
  req = build_request(:delete_intent, params)
  req.send_request(options)
end

#delete_intent_version(params = {}) ⇒ Struct

Deletes a specific version of an intent. To delete all versions of a intent, use the DeleteIntent operation.

This operation requires permissions for the ‘lex:DeleteIntentVersion` action.

Examples:

Request syntax with placeholder values


resp = client.delete_intent_version({
  name: "IntentName", # required
  version: "NumericalVersion", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :name (required, String) —

    The name of the intent.

  • :version (required, String) —

    The version of the intent to delete. You cannot delete the ‘$LATEST` version of the intent. To delete the `$LATEST` version, use the DeleteIntent operation.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



996
997
998
999
 
# File 'lib/aws-sdk-lexmodelbuildingservice/client.rb', line 996

def delete_intent_version(params = {}, options = {})
  req = build_request(:delete_intent_version, params)
  req.send_request(options)
end

#delete_slot_type(params = {}) ⇒ Struct

Deletes all versions of the slot type, including the ‘$LATEST` version. To delete a specific version of the slot type, use the DeleteSlotTypeVersion operation.

You can delete a version of a slot type only if it is not referenced. To delete a slot type that is referred to in one or more intents, you must remove those references first.

<note markdown=“1”> If you get the ‘ResourceInUseException` exception, the exception provides an example reference that shows the intent where the slot type is referenced. To remove the reference to the slot type, either update the intent or delete it. If you get the same exception when you attempt to delete the slot type again, repeat until the slot type has no references and the `DeleteSlotType` call is successful.

</note>

This operation requires permission for the ‘lex:DeleteSlotType` action.

Examples:

Request syntax with placeholder values


resp = client.delete_slot_type({
  name: "SlotTypeName", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :name (required, String) —

    The name of the slot type. The name is case sensitive.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1036
1037
1038
1039
 
# File 'lib/aws-sdk-lexmodelbuildingservice/client.rb', line 1036

def delete_slot_type(params = {}, options = {})
  req = build_request(:delete_slot_type, params)
  req.send_request(options)
end

#delete_slot_type_version(params = {}) ⇒ Struct

Deletes a specific version of a slot type. To delete all versions of a slot type, use the DeleteSlotType operation.

This operation requires permissions for the ‘lex:DeleteSlotTypeVersion` action.

Examples:

Request syntax with placeholder values


resp = client.delete_slot_type_version({
  name: "SlotTypeName", # required
  version: "NumericalVersion", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :name (required, String) —

    The name of the slot type.

  • :version (required, String) —

    The version of the slot type to delete. You cannot delete the ‘$LATEST` version of the slot type. To delete the `$LATEST` version, use the DeleteSlotType operation.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1068
1069
1070
1071
 
# File 'lib/aws-sdk-lexmodelbuildingservice/client.rb', line 1068

def delete_slot_type_version(params = {}, options = {})
  req = build_request(:delete_slot_type_version, params)
  req.send_request(options)
end

#delete_utterances(params = {}) ⇒ Struct

Deletes stored utterances.

Amazon Lex stores the utterances that users send to your bot. Utterances are stored for 15 days for use with the GetUtterancesView 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 stored utterances for a specific user. 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 ‘GetUtterancesView` operation are deleted after 15 days.

This operation requires permissions for the ‘lex:DeleteUtterances` action.

Examples:

Request syntax with placeholder values


resp = client.delete_utterances({
  bot_name: "BotName", # required
  user_id: "UserId", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1115
1116
1117
1118
 
# File 'lib/aws-sdk-lexmodelbuildingservice/client.rb', line 1115

def delete_utterances(params = {}, options = {})
  req = build_request(:delete_utterances, params)
  req.send_request(options)
end

#get_bot(params = {}) ⇒ Types::GetBotResponse

Returns metadata information for a specific bot. You must provide the bot name and the bot version or alias.

This operation requires permissions for the ‘lex:GetBot` action.

Examples:

Example: To get information about a bot


# This example shows how to get configuration information for a bot.

resp = client.get_bot({
  name: "DocOrderPizza", 
  version_or_alias: "$LATEST", 
})

resp.to_h outputs the following:
{
  version: "$LATEST", 
  name: "DocOrderPizzaBot", 
  abort_statement: {
    messages: [
      {
        content: "I don't understand. Can you try again?", 
        content_type: "PlainText", 
      }, 
      {
        content: "I'm sorry, I don't understand.", 
        content_type: "PlainText", 
      }, 
    ], 
  }, 
  checksum: "20172ee3-fa06-49b2-bbc5-667c090303e9", 
  child_directed: true, 
  clarification_prompt: {
    max_attempts: 1, 
    messages: [
      {
        content: "I'm sorry, I didn't hear that. Can you repeate what you just said?", 
        content_type: "PlainText", 
      }, 
      {
        content: "Can you say that again?", 
        content_type: "PlainText", 
      }, 
    ], 
  }, 
  created_date: Time.parse(1494360160.133), 
  description: "Orders a pizza from a local pizzeria.", 
  idle_session_ttl_in_seconds: 300, 
  intents: [
    {
      intent_name: "DocOrderPizza", 
      intent_version: "$LATEST", 
    }, 
  ], 
  last_updated_date: Time.parse(1494360160.133), 
  locale: "en-US", 
  status: "NOT_BUILT", 
}

Request syntax with placeholder values


resp = client.get_bot({
  name: "BotName", # required
  version_or_alias: "String", # required
})

Response structure


resp.name #=> String
resp.description #=> String
resp.intents #=> Array
resp.intents[0].intent_name #=> String
resp.intents[0].intent_version #=> String
resp.enable_model_improvements #=> Boolean
resp.nlu_intent_confidence_threshold #=> Float
resp.clarification_prompt.messages #=> Array
resp.clarification_prompt.messages[0].content_type #=> String, one of "PlainText", "SSML", "CustomPayload"
resp.clarification_prompt.messages[0].content #=> String
resp.clarification_prompt.messages[0].group_number #=> Integer
resp.clarification_prompt.max_attempts #=> Integer
resp.clarification_prompt.response_card #=> String
resp.abort_statement.messages #=> Array
resp.abort_statement.messages[0].content_type #=> String, one of "PlainText", "SSML", "CustomPayload"
resp.abort_statement.messages[0].content #=> String
resp.abort_statement.messages[0].group_number #=> Integer
resp.abort_statement.response_card #=> String
resp.status #=> String, one of "BUILDING", "READY", "READY_BASIC_TESTING", "FAILED", "NOT_BUILT"
resp.failure_reason #=> String
resp.last_updated_date #=> Time
resp.created_date #=> Time
resp.idle_session_ttl_in_seconds #=> Integer
resp.voice_id #=> String
resp.checksum #=> String
resp.version #=> String
resp.locale #=> String, one of "de-DE", "en-AU", "en-GB", "en-IN", "en-US", "es-419", "es-ES", "es-US", "fr-FR", "fr-CA", "it-IT", "ja-JP", "ko-KR"
resp.child_directed #=> Boolean
resp.detect_sentiment #=> Boolean

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :name (required, String) —

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

  • :version_or_alias (required, String) —

    The version or alias of the bot.

Returns:

See Also:



1250
1251
1252
1253
 
# File 'lib/aws-sdk-lexmodelbuildingservice/client.rb', line 1250

def get_bot(params = {}, options = {})
  req = build_request(:get_bot, params)
  req.send_request(options)
end

#get_bot_alias(params = {}) ⇒ Types::GetBotAliasResponse

Returns information about an Amazon Lex bot alias. For more information about aliases, see versioning-aliases.

This operation requires permissions for the ‘lex:GetBotAlias` action.

Examples:

Request syntax with placeholder values


resp = client.get_bot_alias({
  name: "AliasName", # required
  bot_name: "BotName", # required
})

Response structure


resp.name #=> String
resp.description #=> String
resp.bot_version #=> String
resp.bot_name #=> String
resp.last_updated_date #=> Time
resp.created_date #=> Time
resp.checksum #=> String
resp.conversation_logs.log_settings #=> Array
resp.conversation_logs.log_settings[0].log_type #=> String, one of "AUDIO", "TEXT"
resp.conversation_logs.log_settings[0].destination #=> String, one of "CLOUDWATCH_LOGS", "S3"
resp.conversation_logs.log_settings[0].kms_key_arn #=> String
resp.conversation_logs.log_settings[0].resource_arn #=> String
resp.conversation_logs.log_settings[0].resource_prefix #=> String
resp.conversation_logs.iam_role_arn #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :name (required, String) —

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

  • :bot_name (required, String) —

    The name of the bot.

Returns:

See Also:



1305
1306
1307
1308
 
# File 'lib/aws-sdk-lexmodelbuildingservice/client.rb', line 1305

def get_bot_alias(params = {}, options = {})
  req = build_request(:get_bot_alias, params)
  req.send_request(options)
end

#get_bot_aliases(params = {}) ⇒ Types::GetBotAliasesResponse

Returns a list of aliases for a specified Amazon Lex bot.

This operation requires permissions for the ‘lex:GetBotAliases` action.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.get_bot_aliases({
  bot_name: "BotName", # required
  next_token: "NextToken",
  max_results: 1,
  name_contains: "AliasName",
})

Response structure


resp.bot_aliases #=> Array
resp.bot_aliases[0].name #=> String
resp.bot_aliases[0].description #=> String
resp.bot_aliases[0].bot_version #=> String
resp.bot_aliases[0].bot_name #=> String
resp.bot_aliases[0].last_updated_date #=> Time
resp.bot_aliases[0].created_date #=> Time
resp.bot_aliases[0].checksum #=> String
resp.bot_aliases[0].conversation_logs.log_settings #=> Array
resp.bot_aliases[0].conversation_logs.log_settings[0].log_type #=> String, one of "AUDIO", "TEXT"
resp.bot_aliases[0].conversation_logs.log_settings[0].destination #=> String, one of "CLOUDWATCH_LOGS", "S3"
resp.bot_aliases[0].conversation_logs.log_settings[0].kms_key_arn #=> String
resp.bot_aliases[0].conversation_logs.log_settings[0].resource_arn #=> String
resp.bot_aliases[0].conversation_logs.log_settings[0].resource_prefix #=> String
resp.bot_aliases[0].conversation_logs.iam_role_arn #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :bot_name (required, String) —

    The name of the bot.

  • :next_token (String) —

    A pagination token for fetching the next page of aliases. If the response to this call is truncated, Amazon Lex returns a pagination token in the response. To fetch the next page of aliases, specify the pagination token in the next request.

  • :max_results (Integer) —

    The maximum number of aliases to return in the response. The default is 50. .

  • :name_contains (String) —

    Substring to match in bot alias names. An alias will be returned if any part of its name matches the substring. For example, “xyz” matches both “xyzabc” and “abcxyz.”

Returns:

See Also:



1372
1373
1374
1375
 
# File 'lib/aws-sdk-lexmodelbuildingservice/client.rb', line 1372

def get_bot_aliases(params = {}, options = {})
  req = build_request(:get_bot_aliases, params)
  req.send_request(options)
end

#get_bot_channel_association(params = {}) ⇒ Types::GetBotChannelAssociationResponse

Returns information about the association between an Amazon Lex bot and a messaging platform.

This operation requires permissions for the ‘lex:GetBotChannelAssociation` action.

Examples:

Request syntax with placeholder values


resp = client.get_bot_channel_association({
  name: "BotChannelName", # required
  bot_name: "BotName", # required
  bot_alias: "AliasName", # required
})

Response structure


resp.name #=> String
resp.description #=> String
resp.bot_alias #=> String
resp.bot_name #=> String
resp.created_date #=> Time
resp.type #=> String, one of "Facebook", "Slack", "Twilio-Sms", "Kik"
resp.bot_configuration #=> Hash
resp.bot_configuration["String"] #=> String
resp.status #=> String, one of "IN_PROGRESS", "CREATED", "FAILED"
resp.failure_reason #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :name (required, String) —

    The name of the association between the bot and the channel. The name is case sensitive.

  • :bot_name (required, String) —

    The name of the Amazon Lex bot.

  • :bot_alias (required, String) —

    An alias pointing to the specific version of the Amazon Lex bot to which this association is being made.

Returns:

See Also:



1431
1432
1433
1434
 
# File 'lib/aws-sdk-lexmodelbuildingservice/client.rb', line 1431

def get_bot_channel_association(params = {}, options = {})
  req = build_request(:get_bot_channel_association, params)
  req.send_request(options)
end

#get_bot_channel_associations(params = {}) ⇒ Types::GetBotChannelAssociationsResponse

Returns a list of all of the channels associated with the specified bot.

The ‘GetBotChannelAssociations` operation requires permissions for the `lex:GetBotChannelAssociations` action.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.get_bot_channel_associations({
  bot_name: "BotName", # required
  bot_alias: "AliasNameOrListAll", # required
  next_token: "NextToken",
  max_results: 1,
  name_contains: "BotChannelName",
})

Response structure


resp.bot_channel_associations #=> Array
resp.bot_channel_associations[0].name #=> String
resp.bot_channel_associations[0].description #=> String
resp.bot_channel_associations[0].bot_alias #=> String
resp.bot_channel_associations[0].bot_name #=> String
resp.bot_channel_associations[0].created_date #=> Time
resp.bot_channel_associations[0].type #=> String, one of "Facebook", "Slack", "Twilio-Sms", "Kik"
resp.bot_channel_associations[0].bot_configuration #=> Hash
resp.bot_channel_associations[0].bot_configuration["String"] #=> String
resp.bot_channel_associations[0].status #=> String, one of "IN_PROGRESS", "CREATED", "FAILED"
resp.bot_channel_associations[0].failure_reason #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :bot_name (required, String) —

    The name of the Amazon Lex bot in the association.

  • :bot_alias (required, String) —

    An alias pointing to the specific version of the Amazon Lex bot to which this association is being made.

  • :next_token (String) —

    A pagination token for fetching the next page of associations. If the response to this call is truncated, Amazon Lex returns a pagination token in the response. To fetch the next page of associations, specify the pagination token in the next request.

  • :max_results (Integer) —

    The maximum number of associations to return in the response. The default is 50.

  • :name_contains (String) —

    Substring to match in channel association names. An association will be returned if any part of its name matches the substring. For example, “xyz” matches both “xyzabc” and “abcxyz.” To return all bot channel associations, use a hyphen (“-”) as the ‘nameContains` parameter.

Returns:

See Also:



1502
1503
1504
1505
 
# File 'lib/aws-sdk-lexmodelbuildingservice/client.rb', line 1502

def get_bot_channel_associations(params = {}, options = {})
  req = build_request(:get_bot_channel_associations, params)
  req.send_request(options)
end

#get_bot_versions(params = {}) ⇒ Types::GetBotVersionsResponse

Gets information about all of the versions of a bot.

The ‘GetBotVersions` operation returns a `BotMetadata` object for each version of a bot. For example, if a bot has three numbered versions, the `GetBotVersions` operation returns four `BotMetadata` objects in the response, one for each numbered version and one for the `$LATEST` version.

The ‘GetBotVersions` operation always returns at least one version, the `$LATEST` version.

This operation requires permissions for the ‘lex:GetBotVersions` action.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.get_bot_versions({
  name: "BotName", # required
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.bots #=> Array
resp.bots[0].name #=> String
resp.bots[0].description #=> String
resp.bots[0].status #=> String, one of "BUILDING", "READY", "READY_BASIC_TESTING", "FAILED", "NOT_BUILT"
resp.bots[0].last_updated_date #=> Time
resp.bots[0].created_date #=> Time
resp.bots[0].version #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :name (required, String) —

    The name of the bot for which versions should be returned.

  • :next_token (String) —

    A pagination token for fetching the next page of bot versions. If the response to this call is truncated, Amazon Lex returns a pagination token in the response. To fetch the next page of versions, specify the pagination token in the next request.

  • :max_results (Integer) —

    The maximum number of bot versions to return in the response. The default is 10.

Returns:

See Also:



1564
1565
1566
1567
 
# File 'lib/aws-sdk-lexmodelbuildingservice/client.rb', line 1564

def get_bot_versions(params = {}, options = {})
  req = build_request(:get_bot_versions, params)
  req.send_request(options)
end

#get_bots(params = {}) ⇒ Types::GetBotsResponse

Returns bot information as follows:

  • If you provide the ‘nameContains` field, the response includes information for the `$LATEST` version of all bots whose name contains the specified string.

  • If you don’t specify the ‘nameContains` field, the operation returns information about the `$LATEST` version of all of your bots.

This operation requires permission for the ‘lex:GetBots` action.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Example: To get a list of bots


# This example shows how to get a list of all of the bots in your account.

resp = client.get_bots({
  max_results: 5, 
  next_token: "", 
})

resp.to_h outputs the following:
{
  bots: [
    {
      version: "$LATEST", 
      name: "DocOrderPizzaBot", 
      created_date: Time.parse(1494360160.133), 
      description: "Orders a pizza from a local pizzeria.", 
      last_updated_date: Time.parse(1494360160.133), 
      status: "NOT_BUILT", 
    }, 
  ], 
}

Request syntax with placeholder values


resp = client.get_bots({
  next_token: "NextToken",
  max_results: 1,
  name_contains: "BotName",
})

Response structure


resp.bots #=> Array
resp.bots[0].name #=> String
resp.bots[0].description #=> String
resp.bots[0].status #=> String, one of "BUILDING", "READY", "READY_BASIC_TESTING", "FAILED", "NOT_BUILT"
resp.bots[0].last_updated_date #=> Time
resp.bots[0].created_date #=> Time
resp.bots[0].version #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :next_token (String) —

    A pagination token that fetches the next page of bots. If the response to this call is truncated, Amazon Lex returns a pagination token in the response. To fetch the next page of bots, specify the pagination token in the next request.

  • :max_results (Integer) —

    The maximum number of bots to return in the response that the request will return. The default is 10.

  • :name_contains (String) —

    Substring to match in bot names. A bot will be returned if any part of its name matches the substring. For example, “xyz” matches both “xyzabc” and “abcxyz.”

Returns:

See Also:



1649
1650
1651
1652
 
# File 'lib/aws-sdk-lexmodelbuildingservice/client.rb', line 1649

def get_bots(params = {}, options = {})
  req = build_request(:get_bots, params)
  req.send_request(options)
end

#get_builtin_intent(params = {}) ⇒ Types::GetBuiltinIntentResponse

Returns information about a built-in intent.

This operation requires permission for the ‘lex:GetBuiltinIntent` action.

Examples:

Request syntax with placeholder values


resp = client.get_builtin_intent({
  signature: "BuiltinIntentSignature", # required
})

Response structure


resp.signature #=> String
resp.supported_locales #=> Array
resp.supported_locales[0] #=> String, one of "de-DE", "en-AU", "en-GB", "en-IN", "en-US", "es-419", "es-ES", "es-US", "fr-FR", "fr-CA", "it-IT", "ja-JP", "ko-KR"
resp.slots #=> Array
resp.slots[0].name #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

Returns:

See Also:



1692
1693
1694
1695
 
# File 'lib/aws-sdk-lexmodelbuildingservice/client.rb', line 1692

def get_builtin_intent(params = {}, options = {})
  req = build_request(:get_builtin_intent, params)
  req.send_request(options)
end

#get_builtin_intents(params = {}) ⇒ Types::GetBuiltinIntentsResponse

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

This operation requires permission for the ‘lex:GetBuiltinIntents` action.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.get_builtin_intents({
  locale: "de-DE", # accepts de-DE, en-AU, en-GB, en-IN, en-US, es-419, es-ES, es-US, fr-FR, fr-CA, it-IT, ja-JP, ko-KR
  signature_contains: "String",
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.intents #=> Array
resp.intents[0].signature #=> String
resp.intents[0].supported_locales #=> Array
resp.intents[0].supported_locales[0] #=> String, one of "de-DE", "en-AU", "en-GB", "en-IN", "en-US", "es-419", "es-ES", "es-US", "fr-FR", "fr-CA", "it-IT", "ja-JP", "ko-KR"
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :locale (String) —

    A list of locales that the intent supports.

  • :signature_contains (String) —

    Substring to match in built-in intent signatures. An intent will be returned if any part of its signature matches the substring. For example, “xyz” matches both “xyzabc” and “abcxyz.” To find the signature for an intent, see [Standard Built-in Intents] in the *Alexa Skills Kit*.

    [1]: developer.amazon.com/public/solutions/alexa/alexa-skills-kit/docs/built-in-intent-ref/standard-intents

  • :next_token (String) —

    A pagination token that fetches the next page of intents. If this API call is truncated, Amazon Lex returns a pagination token in the response. To fetch the next page of intents, use the pagination token in the next request.

  • :max_results (Integer) —

    The maximum number of intents to return in the response. The default is 10.

Returns:

See Also:



1754
1755
1756
1757
 
# File 'lib/aws-sdk-lexmodelbuildingservice/client.rb', line 1754

def get_builtin_intents(params = {}, options = {})
  req = build_request(:get_builtin_intents, params)
  req.send_request(options)
end

#get_builtin_slot_types(params = {}) ⇒ Types::GetBuiltinSlotTypesResponse

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

For a list of built-in slot types, see [Slot Type Reference] in the *Alexa Skills Kit*.

This operation requires permission for the ‘lex:GetBuiltInSlotTypes` action.

[1]: developer.amazon.com/public/solutions/alexa/alexa-skills-kit/docs/built-in-intent-ref/slot-type-reference

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.get_builtin_slot_types({
  locale: "de-DE", # accepts de-DE, en-AU, en-GB, en-IN, en-US, es-419, es-ES, es-US, fr-FR, fr-CA, it-IT, ja-JP, ko-KR
  signature_contains: "String",
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.slot_types #=> Array
resp.slot_types[0].signature #=> String
resp.slot_types[0].supported_locales #=> Array
resp.slot_types[0].supported_locales[0] #=> String, one of "de-DE", "en-AU", "en-GB", "en-IN", "en-US", "es-419", "es-ES", "es-US", "fr-FR", "fr-CA", "it-IT", "ja-JP", "ko-KR"
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :locale (String) —

    A list of locales that the slot type supports.

  • :signature_contains (String) —

    Substring to match in built-in slot type signatures. A slot type will be returned if any part of its signature matches the substring. For example, “xyz” matches both “xyzabc” and “abcxyz.”

  • :next_token (String) —

    A pagination token that fetches the next page of slot types. If the response to this API call is truncated, Amazon Lex returns a pagination token in the response. To fetch the next page of slot types, specify the pagination token in the next request.

  • :max_results (Integer) —

    The maximum number of slot types to return in the response. The default is 10.

Returns:

See Also:



1817
1818
1819
1820
 
# File 'lib/aws-sdk-lexmodelbuildingservice/client.rb', line 1817

def get_builtin_slot_types(params = {}, options = {})
  req = build_request(:get_builtin_slot_types, params)
  req.send_request(options)
end

#get_export(params = {}) ⇒ Types::GetExportResponse

Exports the contents of a Amazon Lex resource in a specified format.

Examples:

Request syntax with placeholder values


resp = client.get_export({
  name: "Name", # required
  version: "NumericalVersion", # required
  resource_type: "BOT", # required, accepts BOT, INTENT, SLOT_TYPE
  export_type: "ALEXA_SKILLS_KIT", # required, accepts ALEXA_SKILLS_KIT, LEX
})

Response structure


resp.name #=> String
resp.version #=> String
resp.resource_type #=> String, one of "BOT", "INTENT", "SLOT_TYPE"
resp.export_type #=> String, one of "ALEXA_SKILLS_KIT", "LEX"
resp.export_status #=> String, one of "IN_PROGRESS", "READY", "FAILED"
resp.failure_reason #=> String
resp.url #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :name (required, String) —

    The name of the bot to export.

  • :version (required, String) —

    The version of the bot to export.

  • :resource_type (required, String) —

    The type of resource to export.

  • :export_type (required, String) —

    The format of the exported data.

Returns:

See Also:



1869
1870
1871
1872
 
# File 'lib/aws-sdk-lexmodelbuildingservice/client.rb', line 1869

def get_export(params = {}, options = {})
  req = build_request(:get_export, params)
  req.send_request(options)
end

#get_import(params = {}) ⇒ Types::GetImportResponse

Gets information about an import job started with the ‘StartImport` operation.

Examples:

Request syntax with placeholder values


resp = client.get_import({
  import_id: "String", # required
})

Response structure


resp.name #=> String
resp.resource_type #=> String, one of "BOT", "INTENT", "SLOT_TYPE"
resp.merge_strategy #=> String, one of "OVERWRITE_LATEST", "FAIL_ON_CONFLICT"
resp.import_id #=> String
resp.import_status #=> String, one of "IN_PROGRESS", "COMPLETE", "FAILED"
resp.failure_reason #=> Array
resp.failure_reason[0] #=> String
resp.created_date #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :import_id (required, String) —

    The identifier of the import job information to return.

Returns:

See Also:



1911
1912
1913
1914
 
# File 'lib/aws-sdk-lexmodelbuildingservice/client.rb', line 1911

def get_import(params = {}, options = {})
  req = build_request(:get_import, params)
  req.send_request(options)
end

#get_intent(params = {}) ⇒ Types::GetIntentResponse

Returns information about an intent. In addition to the intent name, you must specify the intent version.

This operation requires permissions to perform the ‘lex:GetIntent` action.

Examples:

Example: To get a information about an intent


# This example shows how to get information about an intent.

resp = client.get_intent({
  version: "$LATEST", 
  name: "DocOrderPizza", 
})

resp.to_h outputs the following:
{
  version: "$LATEST", 
  name: "DocOrderPizza", 
  checksum: "ca9bc13d-afc8-4706-bbaf-091f7a5935d6", 
  conclusion_statement: {
    messages: [
      {
        content: "All right, I ordered  you a {Crust} crust {Type} pizza with {Sauce} sauce.", 
        content_type: "PlainText", 
      }, 
      {
        content: "OK, your {Crust} crust {Type} pizza with {Sauce} sauce is on the way.", 
        content_type: "PlainText", 
      }, 
    ], 
    response_card: "foo", 
  }, 
  confirmation_prompt: {
    max_attempts: 1, 
    messages: [
      {
        content: "Should I order  your {Crust} crust {Type} pizza with {Sauce} sauce?", 
        content_type: "PlainText", 
      }, 
    ], 
  }, 
  created_date: Time.parse(1494359783.453), 
  description: "Order a pizza from a local pizzeria.", 
  fulfillment_activity: {
    type: "ReturnIntent", 
  }, 
  last_updated_date: Time.parse(1494359783.453), 
  rejection_statement: {
    messages: [
      {
        content: "Ok, I'll cancel your order.", 
        content_type: "PlainText", 
      }, 
      {
        content: "I cancelled your order.", 
        content_type: "PlainText", 
      }, 
    ], 
  }, 
  sample_utterances: [
    "Order me a pizza.", 
    "Order me a {Type} pizza.", 
    "I want a {Crust} crust {Type} pizza", 
    "I want a {Crust} crust {Type} pizza with {Sauce} sauce.", 
  ], 
  slots: [
    {
      name: "Type", 
      description: "The type of pizza to order.", 
      priority: 1, 
      sample_utterances: [
        "Get me a {Type} pizza.", 
        "A {Type} pizza please.", 
        "I'd like a {Type} pizza.", 
      ], 
      slot_constraint: "Required", 
      slot_type: "DocPizzaType", 
      slot_type_version: "$LATEST", 
      value_elicitation_prompt: {
        max_attempts: 1, 
        messages: [
          {
            content: "What type of pizza would you like?", 
            content_type: "PlainText", 
          }, 
          {
            content: "Vegie or cheese pizza?", 
            content_type: "PlainText", 
          }, 
          {
            content: "I can get you a vegie or a cheese pizza.", 
            content_type: "PlainText", 
          }, 
        ], 
      }, 
    }, 
    {
      name: "Crust", 
      description: "The type of pizza crust to order.", 
      priority: 2, 
      sample_utterances: [
        "Make it a {Crust} crust.", 
        "I'd like a {Crust} crust.", 
      ], 
      slot_constraint: "Required", 
      slot_type: "DocPizzaCrustType", 
      slot_type_version: "$LATEST", 
      value_elicitation_prompt: {
        max_attempts: 1, 
        messages: [
          {
            content: "What type of crust would you like?", 
            content_type: "PlainText", 
          }, 
          {
            content: "Thick or thin crust?", 
            content_type: "PlainText", 
          }, 
        ], 
      }, 
    }, 
    {
      name: "Sauce", 
      description: "The type of sauce to use on the pizza.", 
      priority: 3, 
      sample_utterances: [
        "Make it {Sauce} sauce.", 
        "I'd like {Sauce} sauce.", 
      ], 
      slot_constraint: "Required", 
      slot_type: "DocPizzaSauceType", 
      slot_type_version: "$LATEST", 
      value_elicitation_prompt: {
        max_attempts: 1, 
        messages: [
          {
            content: "White or red sauce?", 
            content_type: "PlainText", 
          }, 
          {
            content: "Garlic or tomato sauce?", 
            content_type: "PlainText", 
          }, 
        ], 
      }, 
    }, 
  ], 
}

Request syntax with placeholder values


resp = client.get_intent({
  name: "IntentName", # required
  version: "Version", # required
})

Response structure


resp.name #=> String
resp.description #=> String
resp.slots #=> Array
resp.slots[0].name #=> String
resp.slots[0].description #=> String
resp.slots[0].slot_constraint #=> String, one of "Required", "Optional"
resp.slots[0].slot_type #=> String
resp.slots[0].slot_type_version #=> String
resp.slots[0].value_elicitation_prompt.messages #=> Array
resp.slots[0].value_elicitation_prompt.messages[0].content_type #=> String, one of "PlainText", "SSML", "CustomPayload"
resp.slots[0].value_elicitation_prompt.messages[0].content #=> String
resp.slots[0].value_elicitation_prompt.messages[0].group_number #=> Integer
resp.slots[0].value_elicitation_prompt.max_attempts #=> Integer
resp.slots[0].value_elicitation_prompt.response_card #=> String
resp.slots[0].priority #=> Integer
resp.slots[0].sample_utterances #=> Array
resp.slots[0].sample_utterances[0] #=> String
resp.slots[0].response_card #=> String
resp.slots[0].obfuscation_setting #=> String, one of "NONE", "DEFAULT_OBFUSCATION"
resp.slots[0].default_value_spec.default_value_list #=> Array
resp.slots[0].default_value_spec.default_value_list[0].default_value #=> String
resp.sample_utterances #=> Array
resp.sample_utterances[0] #=> String
resp.confirmation_prompt.messages #=> Array
resp.confirmation_prompt.messages[0].content_type #=> String, one of "PlainText", "SSML", "CustomPayload"
resp.confirmation_prompt.messages[0].content #=> String
resp.confirmation_prompt.messages[0].group_number #=> Integer
resp.confirmation_prompt.max_attempts #=> Integer
resp.confirmation_prompt.response_card #=> String
resp.rejection_statement.messages #=> Array
resp.rejection_statement.messages[0].content_type #=> String, one of "PlainText", "SSML", "CustomPayload"
resp.rejection_statement.messages[0].content #=> String
resp.rejection_statement.messages[0].group_number #=> Integer
resp.rejection_statement.response_card #=> String
resp.follow_up_prompt.prompt.messages #=> Array
resp.follow_up_prompt.prompt.messages[0].content_type #=> String, one of "PlainText", "SSML", "CustomPayload"
resp.follow_up_prompt.prompt.messages[0].content #=> String
resp.follow_up_prompt.prompt.messages[0].group_number #=> Integer
resp.follow_up_prompt.prompt.max_attempts #=> Integer
resp.follow_up_prompt.prompt.response_card #=> String
resp.follow_up_prompt.rejection_statement.messages #=> Array
resp.follow_up_prompt.rejection_statement.messages[0].content_type #=> String, one of "PlainText", "SSML", "CustomPayload"
resp.follow_up_prompt.rejection_statement.messages[0].content #=> String
resp.follow_up_prompt.rejection_statement.messages[0].group_number #=> Integer
resp.follow_up_prompt.rejection_statement.response_card #=> String
resp.conclusion_statement.messages #=> Array
resp.conclusion_statement.messages[0].content_type #=> String, one of "PlainText", "SSML", "CustomPayload"
resp.conclusion_statement.messages[0].content #=> String
resp.conclusion_statement.messages[0].group_number #=> Integer
resp.conclusion_statement.response_card #=> String
resp.dialog_code_hook.uri #=> String
resp.dialog_code_hook.message_version #=> String
resp.fulfillment_activity.type #=> String, one of "ReturnIntent", "CodeHook"
resp.fulfillment_activity.code_hook.uri #=> String
resp.fulfillment_activity.code_hook.message_version #=> String
resp.parent_intent_signature #=> String
resp.last_updated_date #=> Time
resp.created_date #=> Time
resp.version #=> String
resp.checksum #=> String
resp.kendra_configuration.kendra_index #=> String
resp.kendra_configuration.query_filter_string #=> String
resp.kendra_configuration.role #=> String
resp.input_contexts #=> Array
resp.input_contexts[0].name #=> String
resp.output_contexts #=> Array
resp.output_contexts[0].name #=> String
resp.output_contexts[0].time_to_live_in_seconds #=> Integer
resp.output_contexts[0].turns_to_live #=> Integer

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :name (required, String) —

    The name of the intent. The name is case sensitive.

  • :version (required, String) —

    The version of the intent.

Returns:

See Also:



2177
2178
2179
2180
 
# File 'lib/aws-sdk-lexmodelbuildingservice/client.rb', line 2177

def get_intent(params = {}, options = {})
  req = build_request(:get_intent, params)
  req.send_request(options)
end

#get_intent_versions(params = {}) ⇒ Types::GetIntentVersionsResponse

Gets information about all of the versions of an intent.

The ‘GetIntentVersions` operation returns an `IntentMetadata` object for each version of an intent. For example, if an intent has three numbered versions, the `GetIntentVersions` operation returns four `IntentMetadata` objects in the response, one for each numbered version and one for the `$LATEST` version.

The ‘GetIntentVersions` operation always returns at least one version, the `$LATEST` version.

This operation requires permissions for the ‘lex:GetIntentVersions` action.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.get_intent_versions({
  name: "IntentName", # required
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.intents #=> Array
resp.intents[0].name #=> String
resp.intents[0].description #=> String
resp.intents[0].last_updated_date #=> Time
resp.intents[0].created_date #=> Time
resp.intents[0].version #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :name (required, String) —

    The name of the intent for which versions should be returned.

  • :next_token (String) —

    A pagination token for fetching the next page of intent versions. If the response to this call is truncated, Amazon Lex returns a pagination token in the response. To fetch the next page of versions, specify the pagination token in the next request.

  • :max_results (Integer) —

    The maximum number of intent versions to return in the response. The default is 10.

Returns:

See Also:



2238
2239
2240
2241
 
# File 'lib/aws-sdk-lexmodelbuildingservice/client.rb', line 2238

def get_intent_versions(params = {}, options = {})
  req = build_request(:get_intent_versions, params)
  req.send_request(options)
end

#get_intents(params = {}) ⇒ Types::GetIntentsResponse

Returns intent information as follows:

  • If you specify the ‘nameContains` field, returns the `$LATEST` version of all intents that contain the specified string.

  • If you don’t specify the ‘nameContains` field, returns information about the `$LATEST` version of all intents.

The operation requires permission for the ‘lex:GetIntents` action.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Example: To get a list of intents


# This example shows how to get a list of all of the intents in your account.

resp = client.get_intents({
  max_results: 10, 
  next_token: "", 
})

resp.to_h outputs the following:
{
  intents: [
    {
      version: "$LATEST", 
      name: "DocOrderPizza", 
      created_date: Time.parse(1494359783.453), 
      description: "Order a pizza from a local pizzeria.", 
      last_updated_date: Time.parse(1494359783.453), 
    }, 
  ], 
}

Request syntax with placeholder values


resp = client.get_intents({
  next_token: "NextToken",
  max_results: 1,
  name_contains: "IntentName",
})

Response structure


resp.intents #=> Array
resp.intents[0].name #=> String
resp.intents[0].description #=> String
resp.intents[0].last_updated_date #=> Time
resp.intents[0].created_date #=> Time
resp.intents[0].version #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :next_token (String) —

    A pagination token that fetches the next page of intents. If the response to this API call is truncated, Amazon Lex returns a pagination token in the response. To fetch the next page of intents, specify the pagination token in the next request.

  • :max_results (Integer) —

    The maximum number of intents to return in the response. The default is 10.

  • :name_contains (String) —

    Substring to match in intent names. An intent will be returned if any part of its name matches the substring. For example, “xyz” matches both “xyzabc” and “abcxyz.”

Returns:

See Also:



2320
2321
2322
2323
 
# File 'lib/aws-sdk-lexmodelbuildingservice/client.rb', line 2320

def get_intents(params = {}, options = {})
  req = build_request(:get_intents, params)
  req.send_request(options)
end

#get_migration(params = {}) ⇒ Types::GetMigrationResponse

Provides details about an ongoing or complete migration from an Amazon Lex V1 bot to an Amazon Lex V2 bot. Use this operation to view the migration alerts and warnings related to the migration.

Examples:

Request syntax with placeholder values


resp = client.get_migration({
  migration_id: "MigrationId", # required
})

Response structure


resp.migration_id #=> String
resp.v1_bot_name #=> String
resp.v1_bot_version #=> String
resp.v1_bot_locale #=> String, one of "de-DE", "en-AU", "en-GB", "en-IN", "en-US", "es-419", "es-ES", "es-US", "fr-FR", "fr-CA", "it-IT", "ja-JP", "ko-KR"
resp.v2_bot_id #=> String
resp.v2_bot_role #=> String
resp.migration_status #=> String, one of "IN_PROGRESS", "COMPLETED", "FAILED"
resp.migration_strategy #=> String, one of "CREATE_NEW", "UPDATE_EXISTING"
resp.migration_timestamp #=> Time
resp.alerts #=> Array
resp.alerts[0].type #=> String, one of "ERROR", "WARN"
resp.alerts[0].message #=> String
resp.alerts[0].details #=> Array
resp.alerts[0].details[0] #=> String
resp.alerts[0].reference_urls #=> Array
resp.alerts[0].reference_urls[0] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :migration_id (required, String) —

    The unique identifier of the migration to view. The ‘migrationID` is returned by the operation.

Returns:

See Also:



2375
2376
2377
2378
 
# File 'lib/aws-sdk-lexmodelbuildingservice/client.rb', line 2375

def get_migration(params = {}, options = {})
  req = build_request(:get_migration, params)
  req.send_request(options)
end

#get_migrations(params = {}) ⇒ Types::GetMigrationsResponse

Gets a list of migrations between Amazon Lex V1 and Amazon Lex V2.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.get_migrations({
  sort_by_attribute: "V1_BOT_NAME", # accepts V1_BOT_NAME, MIGRATION_DATE_TIME
  sort_by_order: "ASCENDING", # accepts ASCENDING, DESCENDING
  v1_bot_name_contains: "BotName",
  migration_status_equals: "IN_PROGRESS", # accepts IN_PROGRESS, COMPLETED, FAILED
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.migration_summaries #=> Array
resp.migration_summaries[0].migration_id #=> String
resp.migration_summaries[0].v1_bot_name #=> String
resp.migration_summaries[0].v1_bot_version #=> String
resp.migration_summaries[0].v1_bot_locale #=> String, one of "de-DE", "en-AU", "en-GB", "en-IN", "en-US", "es-419", "es-ES", "es-US", "fr-FR", "fr-CA", "it-IT", "ja-JP", "ko-KR"
resp.migration_summaries[0].v2_bot_id #=> String
resp.migration_summaries[0].v2_bot_role #=> String
resp.migration_summaries[0].migration_status #=> String, one of "IN_PROGRESS", "COMPLETED", "FAILED"
resp.migration_summaries[0].migration_strategy #=> String, one of "CREATE_NEW", "UPDATE_EXISTING"
resp.migration_summaries[0].migration_timestamp #=> Time
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :sort_by_attribute (String) —

    The field to sort the list of migrations by. You can sort by the Amazon Lex V1 bot name or the date and time that the migration was started.

  • :sort_by_order (String) —

    The order so sort the list.

  • :v1_bot_name_contains (String) —

    Filters the list to contain only bots whose name contains the specified string. The string is matched anywhere in bot name.

  • :migration_status_equals (String) —

    Filters the list to contain only migrations in the specified state.

  • :max_results (Integer) —

    The maximum number of migrations to return in the response. The default is 10.

  • :next_token (String) —

    A pagination token that fetches the next page of migrations. If the response to this operation is truncated, Amazon Lex returns a pagination token in the response. To fetch the next page of migrations, specify the pagination token in the request.

Returns:

See Also:



2443
2444
2445
2446
 
# File 'lib/aws-sdk-lexmodelbuildingservice/client.rb', line 2443

def get_migrations(params = {}, options = {})
  req = build_request(:get_migrations, params)
  req.send_request(options)
end

#get_slot_type(params = {}) ⇒ Types::GetSlotTypeResponse

Returns information about a specific version of a slot type. In addition to specifying the slot type name, you must specify the slot type version.

This operation requires permissions for the ‘lex:GetSlotType` action.

Examples:

Example: To get information about a slot type


# This example shows how to get information about a slot type.

resp = client.get_slot_type({
  version: "$LATEST", 
  name: "DocPizzaCrustType", 
})

resp.to_h outputs the following:
{
  version: "$LATEST", 
  name: "DocPizzaCrustType", 
  checksum: "210b3d5a-90a3-4b22-ac7e-f50c2c71095f", 
  created_date: Time.parse(1494359274.403), 
  description: "Available crust types", 
  enumeration_values: [
    {
      value: "thick", 
    }, 
    {
      value: "thin", 
    }, 
  ], 
  last_updated_date: Time.parse(1494359274.403), 
}

Request syntax with placeholder values


resp = client.get_slot_type({
  name: "SlotTypeName", # required
  version: "Version", # required
})

Response structure


resp.name #=> String
resp.description #=> String
resp.enumeration_values #=> Array
resp.enumeration_values[0].value #=> String
resp.enumeration_values[0].synonyms #=> Array
resp.enumeration_values[0].synonyms[0] #=> String
resp.last_updated_date #=> Time
resp.created_date #=> Time
resp.version #=> String
resp.checksum #=> String
resp.value_selection_strategy #=> String, one of "ORIGINAL_VALUE", "TOP_RESOLUTION"
resp.parent_slot_type_signature #=> String
resp.slot_type_configurations #=> Array
resp.slot_type_configurations[0].regex_configuration.pattern #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :name (required, String) —

    The name of the slot type. The name is case sensitive.

  • :version (required, String) —

    The version of the slot type.

Returns:

See Also:



2529
2530
2531
2532
 
# File 'lib/aws-sdk-lexmodelbuildingservice/client.rb', line 2529

def get_slot_type(params = {}, options = {})
  req = build_request(:get_slot_type, params)
  req.send_request(options)
end

#get_slot_type_versions(params = {}) ⇒ Types::GetSlotTypeVersionsResponse

Gets information about all versions of a slot type.

The ‘GetSlotTypeVersions` operation returns a `SlotTypeMetadata` object for each version of a slot type. For example, if a slot type has three numbered versions, the `GetSlotTypeVersions` operation returns four `SlotTypeMetadata` objects in the response, one for each numbered version and one for the `$LATEST` version.

The ‘GetSlotTypeVersions` operation always returns at least one version, the `$LATEST` version.

This operation requires permissions for the ‘lex:GetSlotTypeVersions` action.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.get_slot_type_versions({
  name: "SlotTypeName", # required
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.slot_types #=> Array
resp.slot_types[0].name #=> String
resp.slot_types[0].description #=> String
resp.slot_types[0].last_updated_date #=> Time
resp.slot_types[0].created_date #=> Time
resp.slot_types[0].version #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :name (required, String) —

    The name of the slot type for which versions should be returned.

  • :next_token (String) —

    A pagination token for fetching the next page of slot type versions. If the response to this call is truncated, Amazon Lex returns a pagination token in the response. To fetch the next page of versions, specify the pagination token in the next request.

  • :max_results (Integer) —

    The maximum number of slot type versions to return in the response. The default is 10.

Returns:

See Also:



2590
2591
2592
2593
 
# File 'lib/aws-sdk-lexmodelbuildingservice/client.rb', line 2590

def get_slot_type_versions(params = {}, options = {})
  req = build_request(:get_slot_type_versions, params)
  req.send_request(options)
end

#get_slot_types(params = {}) ⇒ Types::GetSlotTypesResponse

Returns slot type information as follows:

  • If you specify the ‘nameContains` field, returns the `$LATEST` version of all slot types that contain the specified string.

  • If you don’t specify the ‘nameContains` field, returns information about the `$LATEST` version of all slot types.

The operation requires permission for the ‘lex:GetSlotTypes` action.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Example: To get a list of slot types


# This example shows how to get a list of all of the slot types in your account.

resp = client.get_slot_types({
  max_results: 10, 
  next_token: "", 
})

resp.to_h outputs the following:
{
  slot_types: [
    {
      version: "$LATEST", 
      name: "DocPizzaCrustType", 
      created_date: Time.parse(1494359274.403), 
      description: "Available crust types", 
      last_updated_date: Time.parse(1494359274.403), 
    }, 
    {
      version: "$LATEST", 
      name: "DocPizzaSauceType", 
      created_date: Time.parse(1494356442.23), 
      description: "Available pizza sauces", 
      last_updated_date: Time.parse(1494356442.23), 
    }, 
    {
      version: "$LATEST", 
      name: "DocPizzaType", 
      created_date: Time.parse(1494359198.656), 
      description: "Available pizzas", 
      last_updated_date: Time.parse(1494359198.656), 
    }, 
  ], 
}

Request syntax with placeholder values


resp = client.get_slot_types({
  next_token: "NextToken",
  max_results: 1,
  name_contains: "SlotTypeName",
})

Response structure


resp.slot_types #=> Array
resp.slot_types[0].name #=> String
resp.slot_types[0].description #=> String
resp.slot_types[0].last_updated_date #=> Time
resp.slot_types[0].created_date #=> Time
resp.slot_types[0].version #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :next_token (String) —

    A pagination token that fetches the next page of slot types. If the response to this API call is truncated, Amazon Lex returns a pagination token in the response. To fetch next page of slot types, specify the pagination token in the next request.

  • :max_results (Integer) —

    The maximum number of slot types to return in the response. The default is 10.

  • :name_contains (String) —

    Substring to match in slot type names. A slot type will be returned if any part of its name matches the substring. For example, “xyz” matches both “xyzabc” and “abcxyz.”

Returns:

See Also:



2686
2687
2688
2689
 
# File 'lib/aws-sdk-lexmodelbuildingservice/client.rb', line 2686

def get_slot_types(params = {}, options = {})
  req = build_request(:get_slot_types, params)
  req.send_request(options)
end

#get_utterances_view(params = {}) ⇒ Types::GetUtterancesViewResponse

Use the ‘GetUtterancesView` operation to get information about the utterances that your users have made to your bot. You can use this list to tune the utterances that your bot responds to.

For example, say that you have created a bot to order flowers. After your users have used your bot for a while, use the ‘GetUtterancesView` operation to see the requests that they have made and whether they have been successful. You might find that the utterance “I want flowers” is not being recognized. You could add this utterance to the `OrderFlowers` intent so that your bot recognizes that utterance.

After you publish a new version of a bot, you can get information about the old version and the new so that you can compare the performance across the two versions.

Utterance statistics are generated once a day. Data is available for the last 15 days. You can request information for up to 5 versions of your bot in each request. Amazon Lex returns the most frequent utterances received by the bot in the last 15 days. The response contains information about a maximum of 100 utterances for each version.

If you set ‘childDirected` field to true when you created your bot, if you are using slot obfuscation with one or more slots, or if you opted out of participating in improving Amazon Lex, utterances are not available.

This operation requires permissions for the ‘lex:GetUtterancesView` action.

Examples:

Request syntax with placeholder values


resp = client.get_utterances_view({
  bot_name: "BotName", # required
  bot_versions: ["Version"], # required
  status_type: "Detected", # required, accepts Detected, Missed
})

Response structure


resp.bot_name #=> String
resp.utterances #=> Array
resp.utterances[0].bot_version #=> String
resp.utterances[0].utterances #=> Array
resp.utterances[0].utterances[0].utterance_string #=> String
resp.utterances[0].utterances[0].count #=> Integer
resp.utterances[0].utterances[0].distinct_users #=> Integer
resp.utterances[0].utterances[0].first_uttered_date #=> Time
resp.utterances[0].utterances[0].last_uttered_date #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :bot_name (required, String) —

    The name of the bot for which utterance information should be returned.

  • :bot_versions (required, Array<String>) —

    An array of bot versions for which utterance information should be returned. The limit is 5 versions per request.

  • :status_type (required, String) —

    To return utterances that were recognized and handled, use ‘Detected`. To return utterances that were not recognized, use `Missed`.

Returns:

See Also:



2762
2763
2764
2765
 
# File 'lib/aws-sdk-lexmodelbuildingservice/client.rb', line 2762

def get_utterances_view(params = {}, options = {})
  req = build_request(:get_utterances_view, params)
  req.send_request(options)
end

#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse

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

Examples:

Request syntax with placeholder values


resp = client.list_tags_for_resource({
  resource_arn: "AmazonResourceName", # required
})

Response structure


resp.tags #=> Array
resp.tags[0].key #=> String
resp.tags[0].value #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The Amazon Resource Name (ARN) of the resource to get a list of tags for.

Returns:

See Also:



2794
2795
2796
2797
 
# File 'lib/aws-sdk-lexmodelbuildingservice/client.rb', line 2794

def list_tags_for_resource(params = {}, options = {})
  req = build_request(:list_tags_for_resource, params)
  req.send_request(options)
end

#put_bot(params = {}) ⇒ Types::PutBotResponse

Creates an Amazon Lex conversational bot or replaces an existing bot. When you create or update a bot you are only required to specify a name, a locale, and whether the bot is directed toward children under age 13. You can use this to add intents later, or to remove intents from an existing bot. When you create a bot with the minimum information, the bot is created or updated but Amazon Lex returns the ‘ response FAILED. You can build the bot after you add one or more intents. For more information about Amazon Lex bots, see how-it-works. </p> If you specify the name of an existing bot, the fields in the request replace the existing values in the $LATEST version of the bot. Amazon Lex removes any fields that you don’t provide values for in the request, except for the idleTTLInSeconds and privacySettings fields, which are set to their default values. If you don’t specify values for required fields, Amazon Lex throws an exception. This operation requires permissions for the lex:PutBot action. For more information, see security-iam. ‘

Examples:

Example: To create a bot


# This example shows how to create a bot for ordering pizzas.

resp = client.put_bot({
  name: "DocOrderPizzaBot", 
  abort_statement: {
    messages: [
      {
        content: "I don't understand. Can you try again?", 
        content_type: "PlainText", 
      }, 
      {
        content: "I'm sorry, I don't understand.", 
        content_type: "PlainText", 
      }, 
    ], 
  }, 
  child_directed: true, 
  clarification_prompt: {
    max_attempts: 1, 
    messages: [
      {
        content: "I'm sorry, I didn't hear that. Can you repeat what you just said?", 
        content_type: "PlainText", 
      }, 
      {
        content: "Can you say that again?", 
        content_type: "PlainText", 
      }, 
    ], 
  }, 
  description: "Orders a pizza from a local pizzeria.", 
  idle_session_ttl_in_seconds: 300, 
  intents: [
    {
      intent_name: "DocOrderPizza", 
      intent_version: "$LATEST", 
    }, 
  ], 
  locale: "en-US", 
  process_behavior: "SAVE", 
})

resp.to_h outputs the following:
{
  version: "$LATEST", 
  name: "DocOrderPizzaBot", 
  abort_statement: {
    messages: [
      {
        content: "I don't understand. Can you try again?", 
        content_type: "PlainText", 
      }, 
      {
        content: "I'm sorry, I don't understand.", 
        content_type: "PlainText", 
      }, 
    ], 
  }, 
  checksum: "20172ee3-fa06-49b2-bbc5-667c090303e9", 
  child_directed: true, 
  clarification_prompt: {
    max_attempts: 1, 
    messages: [
      {
        content: "I'm sorry, I didn't hear that. Can you repeate what you just said?", 
        content_type: "PlainText", 
      }, 
      {
        content: "Can you say that again?", 
        content_type: "PlainText", 
      }, 
    ], 
  }, 
  created_date: Time.parse(1494360160.133), 
  description: "Orders a pizza from a local pizzeria.", 
  idle_session_ttl_in_seconds: 300, 
  intents: [
    {
      intent_name: "DocOrderPizza", 
      intent_version: "$LATEST", 
    }, 
  ], 
  last_updated_date: Time.parse(1494360160.133), 
  locale: "en-US", 
  status: "NOT_BUILT", 
}

Request syntax with placeholder values


resp = client.put_bot({
  name: "BotName", # required
  description: "Description",
  intents: [
    {
      intent_name: "IntentName", # required
      intent_version: "Version", # required
    },
  ],
  enable_model_improvements: false,
  nlu_intent_confidence_threshold: 1.0,
  clarification_prompt: {
    messages: [ # required
      {
        content_type: "PlainText", # required, accepts PlainText, SSML, CustomPayload
        content: "ContentString", # required
        group_number: 1,
      },
    ],
    max_attempts: 1, # required
    response_card: "ResponseCard",
  },
  abort_statement: {
    messages: [ # required
      {
        content_type: "PlainText", # required, accepts PlainText, SSML, CustomPayload
        content: "ContentString", # required
        group_number: 1,
      },
    ],
    response_card: "ResponseCard",
  },
  idle_session_ttl_in_seconds: 1,
  voice_id: "String",
  checksum: "String",
  process_behavior: "SAVE", # accepts SAVE, BUILD
  locale: "de-DE", # required, accepts de-DE, en-AU, en-GB, en-IN, en-US, es-419, es-ES, es-US, fr-FR, fr-CA, it-IT, ja-JP, ko-KR
  child_directed: false, # required
  detect_sentiment: false,
  create_version: false,
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
})

Response structure


resp.name #=> String
resp.description #=> String
resp.intents #=> Array
resp.intents[0].intent_name #=> String
resp.intents[0].intent_version #=> String
resp.enable_model_improvements #=> Boolean
resp.nlu_intent_confidence_threshold #=> Float
resp.clarification_prompt.messages #=> Array
resp.clarification_prompt.messages[0].content_type #=> String, one of "PlainText", "SSML", "CustomPayload"
resp.clarification_prompt.messages[0].content #=> String
resp.clarification_prompt.messages[0].group_number #=> Integer
resp.clarification_prompt.max_attempts #=> Integer
resp.clarification_prompt.response_card #=> String
resp.abort_statement.messages #=> Array
resp.abort_statement.messages[0].content_type #=> String, one of "PlainText", "SSML", "CustomPayload"
resp.abort_statement.messages[0].content #=> String
resp.abort_statement.messages[0].group_number #=> Integer
resp.abort_statement.response_card #=> String
resp.status #=> String, one of "BUILDING", "READY", "READY_BASIC_TESTING", "FAILED", "NOT_BUILT"
resp.failure_reason #=> String
resp.last_updated_date #=> Time
resp.created_date #=> Time
resp.idle_session_ttl_in_seconds #=> Integer
resp.voice_id #=> String
resp.checksum #=> String
resp.version #=> String
resp.locale #=> String, one of "de-DE", "en-AU", "en-GB", "en-IN", "en-US", "es-419", "es-ES", "es-US", "fr-FR", "fr-CA", "it-IT", "ja-JP", "ko-KR"
resp.child_directed #=> Boolean
resp.create_version #=> Boolean
resp.detect_sentiment #=> Boolean
resp.tags #=> Array
resp.tags[0].key #=> String
resp.tags[0].value #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :name (required, String) —

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

  • :description (String) —

    A description of the bot.

  • :intents (Array<Types::Intent>) —

    An array of ‘Intent` objects. Each intent represents a command that a user can express. For example, a pizza ordering bot might support an OrderPizza intent. For more information, see how-it-works.

  • :enable_model_improvements (Boolean) —

    Set to ‘true` to enable access to natural language understanding improvements.

    When you set the ‘enableModelImprovements` parameter to `true` you can use the `nluIntentConfidenceThreshold` parameter to configure confidence scores. For more information, see [Confidence Scores].

    You can only set the ‘enableModelImprovements` parameter in certain Regions. If you set the parameter to `true`, your bot has access to accuracy improvements.

    The Regions where you can set the ‘enableModelImprovements` parameter to `true` are:

    • US East (N. Virginia) (us-east-1)

    • US West (Oregon) (us-west-2)

    • Asia Pacific (Sydney) (ap-southeast-2)

    • EU (Ireland) (eu-west-1)

    In other Regions, the ‘enableModelImprovements` parameter is set to `true` by default. In these Regions setting the parameter to `false` throws a `ValidationException` exception.

    [1]: docs.aws.amazon.com/lex/latest/dg/confidence-scores.html

  • :nlu_intent_confidence_threshold (Float) —

    Determines the threshold where Amazon Lex will insert the ‘AMAZON.FallbackIntent`, `AMAZON.KendraSearchIntent`, or both when returning alternative intents in a [PostContent] or [PostText] response. `AMAZON.FallbackIntent` and `AMAZON.KendraSearchIntent` are only inserted if they are configured for the bot.

    You must set the ‘enableModelImprovements` parameter to `true` to use confidence scores in the following regions.

    • US East (N. Virginia) (us-east-1)

    • US West (Oregon) (us-west-2)

    • Asia Pacific (Sydney) (ap-southeast-2)

    • EU (Ireland) (eu-west-1)

    In other Regions, the ‘enableModelImprovements` parameter is set to `true` by default.

    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 `PostText` operation would be:

    • AMAZON.FallbackIntent

    • IntentA

    • IntentB

    • IntentC

    [1]: docs.aws.amazon.com/lex/latest/dg/API_runtime_PostContent.html [2]: docs.aws.amazon.com/lex/latest/dg/API_runtime_PostText.html

  • :clarification_prompt (Types::Prompt) —

    When Amazon Lex doesn’t understand the user’s intent, it uses this message to get clarification. To specify how many times Amazon Lex should repeat the clarification prompt, use the ‘maxAttempts` field. If Amazon Lex still doesn’t understand, it sends the message in the ‘abortStatement` field.

    When you create a clarification prompt, make sure that it suggests the correct response from the user. for example, for a bot that orders pizza and drinks, you might create this clarification prompt: “What would you like to do? You can say ‘Order a pizza’ or ‘Order a drink.’”

    If you have defined a fallback intent, it will be invoked if the clarification prompt is repeated the number of times defined in the ‘maxAttempts` field. For more information, see [ AMAZON.FallbackIntent].

    If you don’t define a clarification prompt, at runtime Amazon Lex will return a 400 Bad Request exception in three cases:

    • Follow-up prompt - When the user responds to a follow-up prompt but does not provide an intent. For example, in response to a follow-up prompt that says “Would you like anything else today?” the user says “Yes.” Amazon Lex will return a 400 Bad Request exception because it does not have a clarification prompt to send to the user to get an intent.

    • Lambda function - When using a Lambda function, you return an ‘ElicitIntent` dialog type. Since Amazon Lex does not have a clarification prompt to get an intent from the user, it returns a 400 Bad Request exception.

    • PutSession operation - When using the ‘PutSession` operation, you send an `ElicitIntent` dialog type. Since Amazon Lex does not have a clarification prompt to get an intent from the user, it returns a 400 Bad Request exception.

    [1]: docs.aws.amazon.com/lex/latest/dg/built-in-intent-fallback.html

  • :abort_statement (Types::Statement) —

    When Amazon Lex can’t understand the user’s input in context, it tries to elicit the information a few times. After that, Amazon Lex sends the message defined in ‘abortStatement` to the user, and then cancels the conversation. To set the number of retries, use the `valueElicitationPrompt` field for the slot type.

    For example, in a pizza ordering bot, Amazon Lex might ask a user “What type of crust would you like?” If the user’s response is not one of the expected responses (for example, “thin crust, ”deep dish,“ etc.), Amazon Lex tries to elicit a correct response a few more times.

    For example, in a pizza ordering application, ‘OrderPizza` might be one of the intents. This intent might require the `CrustType` slot. You specify the `valueElicitationPrompt` field when you create the `CrustType` slot.

    If you have defined a fallback intent the cancel statement will not be sent to the user, the fallback intent is used instead. For more information, see [ AMAZON.FallbackIntent].

    [1]: docs.aws.amazon.com/lex/latest/dg/built-in-intent-fallback.html

  • :idle_session_ttl_in_seconds (Integer) —

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

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

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

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

    The default is 300 seconds (5 minutes).

  • :voice_id (String) —

    The Amazon Polly voice ID that you want Amazon Lex to use for voice interactions with the user. The locale configured for the voice must match the locale of the bot. For more information, see [Voices in Amazon Polly] in the *Amazon Polly Developer Guide*.

    [1]: docs.aws.amazon.com/polly/latest/dg/voicelist.html

  • :checksum (String) —

    Identifies a specific revision of the ‘$LATEST` version.

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

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

  • :process_behavior (String) —

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

    If you don’t specify this value, the default value is ‘BUILD`.

  • :locale (required, String) —

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

    The default is ‘en-US`.

  • :child_directed (required, Boolean) —

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

    If your use of Amazon Lex relates to a website, program, or other application that is directed in whole or in part, to children under age 13, you must obtain any required verifiable parental consent under COPPA. For information regarding the use of Amazon Lex in connection with websites, programs, or other applications that are directed or targeted, in whole or in part, to children under age 13, see the

    Amazon Lex FAQ.][1

    [1]: aws.amazon.com/lex/faqs#data-security

  • :detect_sentiment (Boolean) —

    When set to ‘true` user utterances are sent to Amazon Comprehend for sentiment analysis. If you don’t specify ‘detectSentiment`, the default is `false`.

  • :create_version (Boolean) —

    When set to ‘true` a new numbered version of the bot is created. This is the same as calling the `CreateBotVersion` operation. If you don’t specify ‘createVersion`, the default is `false`.

  • :tags (Array<Types::Tag>) —

    A list of tags to add to the bot. You can only add tags when you create a bot, you can’t use the ‘PutBot` operation to update the tags on a bot. To update tags, use the `TagResource` operation.

Returns:

See Also:



3271
3272
3273
3274
 
# File 'lib/aws-sdk-lexmodelbuildingservice/client.rb', line 3271

def put_bot(params = {}, options = {})
  req = build_request(:put_bot, params)
  req.send_request(options)
end

#put_bot_alias(params = {}) ⇒ Types::PutBotAliasResponse

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

This operation requires permissions for the ‘lex:PutBotAlias` action.

Examples:

Request syntax with placeholder values


resp = client.put_bot_alias({
  name: "AliasName", # required
  description: "Description",
  bot_version: "Version", # required
  bot_name: "BotName", # required
  checksum: "String",
  conversation_logs: {
    log_settings: [ # required
      {
        log_type: "AUDIO", # required, accepts AUDIO, TEXT
        destination: "CLOUDWATCH_LOGS", # required, accepts CLOUDWATCH_LOGS, S3
        kms_key_arn: "KmsKeyArn",
        resource_arn: "ResourceArn", # required
      },
    ],
    iam_role_arn: "IamRoleArn", # required
  },
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
})

Response structure


resp.name #=> String
resp.description #=> String
resp.bot_version #=> String
resp.bot_name #=> String
resp.last_updated_date #=> Time
resp.created_date #=> Time
resp.checksum #=> String
resp.conversation_logs.log_settings #=> Array
resp.conversation_logs.log_settings[0].log_type #=> String, one of "AUDIO", "TEXT"
resp.conversation_logs.log_settings[0].destination #=> String, one of "CLOUDWATCH_LOGS", "S3"
resp.conversation_logs.log_settings[0].kms_key_arn #=> String
resp.conversation_logs.log_settings[0].resource_arn #=> String
resp.conversation_logs.log_settings[0].resource_prefix #=> String
resp.conversation_logs.iam_role_arn #=> String
resp.tags #=> Array
resp.tags[0].key #=> String
resp.tags[0].value #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :name (required, String) —

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

  • :description (String) —

    A description of the alias.

  • :bot_version (required, String) —

    The version of the bot.

  • :bot_name (required, String) —

    The name of the bot.

  • :checksum (String) —

    Identifies a specific revision of the ‘$LATEST` version.

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

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

  • :conversation_logs (Types::ConversationLogsRequest) —

    Settings for conversation logs for the alias.

  • :tags (Array<Types::Tag>) —

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

Returns:

See Also:



3379
3380
3381
3382
 
# File 'lib/aws-sdk-lexmodelbuildingservice/client.rb', line 3379

def put_bot_alias(params = {}, options = {})
  req = build_request(:put_bot_alias, params)
  req.send_request(options)
end

#put_intent(params = {}) ⇒ Types::PutIntentResponse

Creates an intent or replaces an existing intent.

To define the interaction between the user and your bot, you use one or more intents. For a pizza ordering bot, for example, you would create an ‘OrderPizza` intent.

To create an intent or replace an existing intent, you must provide the following:

  • Intent name. For example, ‘OrderPizza`.

  • Sample utterances. For example, “Can I order a pizza, please.” and “I want to order a pizza.”

  • Information to be gathered. You specify slot types for the information that your bot will request from the user. You can specify standard slot types, such as a date or a time, or custom slot types such as the size and crust of a pizza.

  • How the intent will be fulfilled. You can provide a Lambda function or configure the intent to return the intent information to the client application. If you use a Lambda function, when all of the intent information is available, Amazon Lex invokes your Lambda function. If you configure your intent to return the intent information to the client application.

You can specify other optional information in the request, such as:

  • A confirmation prompt to ask the user to confirm an intent. For example, “Shall I order your pizza?”

  • A conclusion statement to send to the user after the intent has been fulfilled. For example, “I placed your pizza order.”

  • A follow-up prompt that asks the user for additional activity. For example, asking “Do you want to order a drink with your pizza?”

If you specify an existing intent name to update the intent, Amazon Lex replaces the values in the ‘$LATEST` version of the intent with the values in the request. Amazon Lex removes fields that you don’t provide in the request. If you don’t specify the required fields, Amazon Lex throws an exception. When you update the ‘$LATEST` version of an intent, the `status` field of any bot that uses the `$LATEST` version of the intent is set to `NOT_BUILT`.

For more information, see how-it-works.

This operation requires permissions for the ‘lex:PutIntent` action.

Examples:

Example: To create an intent


# This example shows how to create an intent for ordering pizzas.

resp = client.put_intent({
  name: "DocOrderPizza", 
  conclusion_statement: {
    messages: [
      {
        content: "All right, I ordered  you a {Crust} crust {Type} pizza with {Sauce} sauce.", 
        content_type: "PlainText", 
      }, 
      {
        content: "OK, your {Crust} crust {Type} pizza with {Sauce} sauce is on the way.", 
        content_type: "PlainText", 
      }, 
    ], 
    response_card: "foo", 
  }, 
  confirmation_prompt: {
    max_attempts: 1, 
    messages: [
      {
        content: "Should I order  your {Crust} crust {Type} pizza with {Sauce} sauce?", 
        content_type: "PlainText", 
      }, 
    ], 
  }, 
  description: "Order a pizza from a local pizzeria.", 
  fulfillment_activity: {
    type: "ReturnIntent", 
  }, 
  rejection_statement: {
    messages: [
      {
        content: "Ok, I'll cancel your order.", 
        content_type: "PlainText", 
      }, 
      {
        content: "I cancelled your order.", 
        content_type: "PlainText", 
      }, 
    ], 
  }, 
  sample_utterances: [
    "Order me a pizza.", 
    "Order me a {Type} pizza.", 
    "I want a {Crust} crust {Type} pizza", 
    "I want a {Crust} crust {Type} pizza with {Sauce} sauce.", 
  ], 
  slots: [
    {
      name: "Type", 
      description: "The type of pizza to order.", 
      priority: 1, 
      sample_utterances: [
        "Get me a {Type} pizza.", 
        "A {Type} pizza please.", 
        "I'd like a {Type} pizza.", 
      ], 
      slot_constraint: "Required", 
      slot_type: "DocPizzaType", 
      slot_type_version: "$LATEST", 
      value_elicitation_prompt: {
        max_attempts: 1, 
        messages: [
          {
            content: "What type of pizza would you like?", 
            content_type: "PlainText", 
          }, 
          {
            content: "Vegie or cheese pizza?", 
            content_type: "PlainText", 
          }, 
          {
            content: "I can get you a vegie or a cheese pizza.", 
            content_type: "PlainText", 
          }, 
        ], 
      }, 
    }, 
    {
      name: "Crust", 
      description: "The type of pizza crust to order.", 
      priority: 2, 
      sample_utterances: [
        "Make it a {Crust} crust.", 
        "I'd like a {Crust} crust.", 
      ], 
      slot_constraint: "Required", 
      slot_type: "DocPizzaCrustType", 
      slot_type_version: "$LATEST", 
      value_elicitation_prompt: {
        max_attempts: 1, 
        messages: [
          {
            content: "What type of crust would you like?", 
            content_type: "PlainText", 
          }, 
          {
            content: "Thick or thin crust?", 
            content_type: "PlainText", 
          }, 
        ], 
      }, 
    }, 
    {
      name: "Sauce", 
      description: "The type of sauce to use on the pizza.", 
      priority: 3, 
      sample_utterances: [
        "Make it {Sauce} sauce.", 
        "I'd like {Sauce} sauce.", 
      ], 
      slot_constraint: "Required", 
      slot_type: "DocPizzaSauceType", 
      slot_type_version: "$LATEST", 
      value_elicitation_prompt: {
        max_attempts: 1, 
        messages: [
          {
            content: "White or red sauce?", 
            content_type: "PlainText", 
          }, 
          {
            content: "Garlic or tomato sauce?", 
            content_type: "PlainText", 
          }, 
        ], 
      }, 
    }, 
  ], 
})

resp.to_h outputs the following:
{
  version: "$LATEST", 
  name: "DocOrderPizza", 
  checksum: "ca9bc13d-afc8-4706-bbaf-091f7a5935d6", 
  conclusion_statement: {
    messages: [
      {
        content: "All right, I ordered  you a {Crust} crust {Type} pizza with {Sauce} sauce.", 
        content_type: "PlainText", 
      }, 
      {
        content: "OK, your {Crust} crust {Type} pizza with {Sauce} sauce is on the way.", 
        content_type: "PlainText", 
      }, 
    ], 
    response_card: "foo", 
  }, 
  confirmation_prompt: {
    max_attempts: 1, 
    messages: [
      {
        content: "Should I order  your {Crust} crust {Type} pizza with {Sauce} sauce?", 
        content_type: "PlainText", 
      }, 
    ], 
  }, 
  created_date: Time.parse(1494359783.453), 
  description: "Order a pizza from a local pizzeria.", 
  fulfillment_activity: {
    type: "ReturnIntent", 
  }, 
  last_updated_date: Time.parse(1494359783.453), 
  rejection_statement: {
    messages: [
      {
        content: "Ok, I'll cancel your order.", 
        content_type: "PlainText", 
      }, 
      {
        content: "I cancelled your order.", 
        content_type: "PlainText", 
      }, 
    ], 
  }, 
  sample_utterances: [
    "Order me a pizza.", 
    "Order me a {Type} pizza.", 
    "I want a {Crust} crust {Type} pizza", 
    "I want a {Crust} crust {Type} pizza with {Sauce} sauce.", 
  ], 
  slots: [
    {
      name: "Sauce", 
      description: "The type of sauce to use on the pizza.", 
      priority: 3, 
      sample_utterances: [
        "Make it {Sauce} sauce.", 
        "I'd like {Sauce} sauce.", 
      ], 
      slot_constraint: "Required", 
      slot_type: "DocPizzaSauceType", 
      slot_type_version: "$LATEST", 
      value_elicitation_prompt: {
        max_attempts: 1, 
        messages: [
          {
            content: "White or red sauce?", 
            content_type: "PlainText", 
          }, 
          {
            content: "Garlic or tomato sauce?", 
            content_type: "PlainText", 
          }, 
        ], 
      }, 
    }, 
    {
      name: "Type", 
      description: "The type of pizza to order.", 
      priority: 1, 
      sample_utterances: [
        "Get me a {Type} pizza.", 
        "A {Type} pizza please.", 
        "I'd like a {Type} pizza.", 
      ], 
      slot_constraint: "Required", 
      slot_type: "DocPizzaType", 
      slot_type_version: "$LATEST", 
      value_elicitation_prompt: {
        max_attempts: 1, 
        messages: [
          {
            content: "What type of pizza would you like?", 
            content_type: "PlainText", 
          }, 
          {
            content: "Vegie or cheese pizza?", 
            content_type: "PlainText", 
          }, 
          {
            content: "I can get you a vegie or a cheese pizza.", 
            content_type: "PlainText", 
          }, 
        ], 
      }, 
    }, 
    {
      name: "Crust", 
      description: "The type of pizza crust to order.", 
      priority: 2, 
      sample_utterances: [
        "Make it a {Crust} crust.", 
        "I'd like a {Crust} crust.", 
      ], 
      slot_constraint: "Required", 
      slot_type: "DocPizzaCrustType", 
      slot_type_version: "$LATEST", 
      value_elicitation_prompt: {
        max_attempts: 1, 
        messages: [
          {
            content: "What type of crust would you like?", 
            content_type: "PlainText", 
          }, 
          {
            content: "Thick or thin crust?", 
            content_type: "PlainText", 
          }, 
        ], 
      }, 
    }, 
  ], 
}

Request syntax with placeholder values


resp = client.put_intent({
  name: "IntentName", # required
  description: "Description",
  slots: [
    {
      name: "SlotName", # required
      description: "Description",
      slot_constraint: "Required", # required, accepts Required, Optional
      slot_type: "CustomOrBuiltinSlotTypeName",
      slot_type_version: "Version",
      value_elicitation_prompt: {
        messages: [ # required
          {
            content_type: "PlainText", # required, accepts PlainText, SSML, CustomPayload
            content: "ContentString", # required
            group_number: 1,
          },
        ],
        max_attempts: 1, # required
        response_card: "ResponseCard",
      },
      priority: 1,
      sample_utterances: ["Utterance"],
      response_card: "ResponseCard",
      obfuscation_setting: "NONE", # accepts NONE, DEFAULT_OBFUSCATION
      default_value_spec: {
        default_value_list: [ # required
          {
            default_value: "SlotDefaultValueString", # required
          },
        ],
      },
    },
  ],
  sample_utterances: ["Utterance"],
  confirmation_prompt: {
    messages: [ # required
      {
        content_type: "PlainText", # required, accepts PlainText, SSML, CustomPayload
        content: "ContentString", # required
        group_number: 1,
      },
    ],
    max_attempts: 1, # required
    response_card: "ResponseCard",
  },
  rejection_statement: {
    messages: [ # required
      {
        content_type: "PlainText", # required, accepts PlainText, SSML, CustomPayload
        content: "ContentString", # required
        group_number: 1,
      },
    ],
    response_card: "ResponseCard",
  },
  follow_up_prompt: {
    prompt: { # required
      messages: [ # required
        {
          content_type: "PlainText", # required, accepts PlainText, SSML, CustomPayload
          content: "ContentString", # required
          group_number: 1,
        },
      ],
      max_attempts: 1, # required
      response_card: "ResponseCard",
    },
    rejection_statement: { # required
      messages: [ # required
        {
          content_type: "PlainText", # required, accepts PlainText, SSML, CustomPayload
          content: "ContentString", # required
          group_number: 1,
        },
      ],
      response_card: "ResponseCard",
    },
  },
  conclusion_statement: {
    messages: [ # required
      {
        content_type: "PlainText", # required, accepts PlainText, SSML, CustomPayload
        content: "ContentString", # required
        group_number: 1,
      },
    ],
    response_card: "ResponseCard",
  },
  dialog_code_hook: {
    uri: "LambdaARN", # required
    message_version: "MessageVersion", # required
  },
  fulfillment_activity: {
    type: "ReturnIntent", # required, accepts ReturnIntent, CodeHook
    code_hook: {
      uri: "LambdaARN", # required
      message_version: "MessageVersion", # required
    },
  },
  parent_intent_signature: "BuiltinIntentSignature",
  checksum: "String",
  create_version: false,
  kendra_configuration: {
    kendra_index: "KendraIndexArn", # required
    query_filter_string: "QueryFilterString",
    role: "roleArn", # required
  },
  input_contexts: [
    {
      name: "InputContextName", # required
    },
  ],
  output_contexts: [
    {
      name: "OutputContextName", # required
      time_to_live_in_seconds: 1, # required
      turns_to_live: 1, # required
    },
  ],
})

Response structure


resp.name #=> String
resp.description #=> String
resp.slots #=> Array
resp.slots[0].name #=> String
resp.slots[0].description #=> String
resp.slots[0].slot_constraint #=> String, one of "Required", "Optional"
resp.slots[0].slot_type #=> String
resp.slots[0].slot_type_version #=> String
resp.slots[0].value_elicitation_prompt.messages #=> Array
resp.slots[0].value_elicitation_prompt.messages[0].content_type #=> String, one of "PlainText", "SSML", "CustomPayload"
resp.slots[0].value_elicitation_prompt.messages[0].content #=> String
resp.slots[0].value_elicitation_prompt.messages[0].group_number #=> Integer
resp.slots[0].value_elicitation_prompt.max_attempts #=> Integer
resp.slots[0].value_elicitation_prompt.response_card #=> String
resp.slots[0].priority #=> Integer
resp.slots[0].sample_utterances #=> Array
resp.slots[0].sample_utterances[0] #=> String
resp.slots[0].response_card #=> String
resp.slots[0].obfuscation_setting #=> String, one of "NONE", "DEFAULT_OBFUSCATION"
resp.slots[0].default_value_spec.default_value_list #=> Array
resp.slots[0].default_value_spec.default_value_list[0].default_value #=> String
resp.sample_utterances #=> Array
resp.sample_utterances[0] #=> String
resp.confirmation_prompt.messages #=> Array
resp.confirmation_prompt.messages[0].content_type #=> String, one of "PlainText", "SSML", "CustomPayload"
resp.confirmation_prompt.messages[0].content #=> String
resp.confirmation_prompt.messages[0].group_number #=> Integer
resp.confirmation_prompt.max_attempts #=> Integer
resp.confirmation_prompt.response_card #=> String
resp.rejection_statement.messages #=> Array
resp.rejection_statement.messages[0].content_type #=> String, one of "PlainText", "SSML", "CustomPayload"
resp.rejection_statement.messages[0].content #=> String
resp.rejection_statement.messages[0].group_number #=> Integer
resp.rejection_statement.response_card #=> String
resp.follow_up_prompt.prompt.messages #=> Array
resp.follow_up_prompt.prompt.messages[0].content_type #=> String, one of "PlainText", "SSML", "CustomPayload"
resp.follow_up_prompt.prompt.messages[0].content #=> String
resp.follow_up_prompt.prompt.messages[0].group_number #=> Integer
resp.follow_up_prompt.prompt.max_attempts #=> Integer
resp.follow_up_prompt.prompt.response_card #=> String
resp.follow_up_prompt.rejection_statement.messages #=> Array
resp.follow_up_prompt.rejection_statement.messages[0].content_type #=> String, one of "PlainText", "SSML", "CustomPayload"
resp.follow_up_prompt.rejection_statement.messages[0].content #=> String
resp.follow_up_prompt.rejection_statement.messages[0].group_number #=> Integer
resp.follow_up_prompt.rejection_statement.response_card #=> String
resp.conclusion_statement.messages #=> Array
resp.conclusion_statement.messages[0].content_type #=> String, one of "PlainText", "SSML", "CustomPayload"
resp.conclusion_statement.messages[0].content #=> String
resp.conclusion_statement.messages[0].group_number #=> Integer
resp.conclusion_statement.response_card #=> String
resp.dialog_code_hook.uri #=> String
resp.dialog_code_hook.message_version #=> String
resp.fulfillment_activity.type #=> String, one of "ReturnIntent", "CodeHook"
resp.fulfillment_activity.code_hook.uri #=> String
resp.fulfillment_activity.code_hook.message_version #=> String
resp.parent_intent_signature #=> String
resp.last_updated_date #=> Time
resp.created_date #=> Time
resp.version #=> String
resp.checksum #=> String
resp.create_version #=> Boolean
resp.kendra_configuration.kendra_index #=> String
resp.kendra_configuration.query_filter_string #=> String
resp.kendra_configuration.role #=> String
resp.input_contexts #=> Array
resp.input_contexts[0].name #=> String
resp.output_contexts #=> Array
resp.output_contexts[0].name #=> String
resp.output_contexts[0].time_to_live_in_seconds #=> Integer
resp.output_contexts[0].turns_to_live #=> Integer

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :name (required, String) —

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

    The name can’t match a built-in intent name, or a built-in intent name with “AMAZON.” removed. For example, because there is a built-in intent called ‘AMAZON.HelpIntent`, you can’t create a custom intent called ‘HelpIntent`.

    For a list of built-in intents, see [Standard Built-in Intents] in the *Alexa Skills Kit*.

    [1]: developer.amazon.com/public/solutions/alexa/alexa-skills-kit/docs/built-in-intent-ref/standard-intents

  • :description (String) —

    A description of the intent.

  • :slots (Array<Types::Slot>) —

    An array of intent slots. At runtime, Amazon Lex elicits required slot values from the user using prompts defined in the slots. For more information, see how-it-works.

  • :sample_utterances (Array<String>) —

    An array of utterances (strings) that a user might say to signal the intent. For example, “I want PizzaSize pizza”, “Order Quantity PizzaSize pizzas”.

    In each utterance, a slot name is enclosed in curly braces.

  • :confirmation_prompt (Types::Prompt) —

    Prompts the user to confirm the intent. This question should have a yes or no answer.

    Amazon Lex uses this prompt to ensure that the user acknowledges that the intent is ready for fulfillment. For example, with the ‘OrderPizza` intent, you might want to confirm that the order is correct before placing it. For other intents, such as intents that simply respond to user questions, you might not need to ask the user for confirmation before providing the information.

    <note markdown=“1”> You you must provide both the ‘rejectionStatement` and the `confirmationPrompt`, or neither.

    </note>
  • :rejection_statement (Types::Statement) —

    When the user answers “no” to the question defined in ‘confirmationPrompt`, Amazon Lex responds with this statement to acknowledge that the intent was canceled.

    <note markdown=“1”> You must provide both the ‘rejectionStatement` and the `confirmationPrompt`, or neither.

    </note>
  • :follow_up_prompt (Types::FollowUpPrompt) —

    Amazon Lex uses this prompt to solicit additional activity after fulfilling an intent. For example, after the ‘OrderPizza` intent is fulfilled, you might prompt the user to order a drink.

    The action that Amazon Lex takes depends on the user’s response, as follows:

    • If the user says “Yes” it responds with the clarification prompt that is configured for the bot.

    • if the user says “Yes” and continues with an utterance that triggers an intent it starts a conversation for the intent.

    • If the user says “No” it responds with the rejection statement configured for the the follow-up prompt.

    • If it doesn’t recognize the utterance it repeats the follow-up prompt again.

    The ‘followUpPrompt` field and the `conclusionStatement` field are mutually exclusive. You can specify only one.

  • :conclusion_statement (Types::Statement) —

    The statement that you want Amazon Lex to convey to the user after the intent is successfully fulfilled by the Lambda function.

    This element is relevant only if you provide a Lambda function in the ‘fulfillmentActivity`. If you return the intent to the client application, you can’t specify this element.

    <note markdown=“1”> The ‘followUpPrompt` and `conclusionStatement` are mutually exclusive. You can specify only one.

    </note>
  • :dialog_code_hook (Types::CodeHook) —

    Specifies a Lambda function to invoke for each user input. You can invoke this Lambda function to personalize user interaction.

    For example, suppose your bot determines that the user is John. Your 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.

  • :fulfillment_activity (Types::FulfillmentActivity) —

    Required. Describes how the intent is fulfilled. For example, after a user provides all of the information for a pizza order, ‘fulfillmentActivity` defines how the bot places an order with a local pizza store.

    You might configure Amazon Lex to return all of the intent information to the client application, or direct it to invoke a Lambda function that can process the intent (for example, place an order with a pizzeria).

  • :parent_intent_signature (String) —

    A unique identifier for the built-in intent to base this intent on. To find the signature for an intent, see [Standard Built-in Intents] in the *Alexa Skills Kit*.

    [1]: developer.amazon.com/public/solutions/alexa/alexa-skills-kit/docs/built-in-intent-ref/standard-intents

  • :checksum (String) —

    Identifies a specific revision of the ‘$LATEST` version.

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

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

  • :create_version (Boolean) —

    When set to ‘true` a new numbered version of the intent is created. This is the same as calling the `CreateIntentVersion` operation. If you do not specify `createVersion`, the default is `false`.

  • :kendra_configuration (Types::KendraConfiguration) —

    Configuration information required to use the ‘AMAZON.KendraSearchIntent` intent to connect to an Amazon Kendra index. For more information, see [ AMAZON.KendraSearchIntent].

    [1]: docs.aws.amazon.com/lex/latest/dg/built-in-intent-kendra-search.html

  • :input_contexts (Array<Types::InputContext>) —

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

  • :output_contexts (Array<Types::OutputContext>) —

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

Returns:

See Also:



4084
4085
4086
4087
 
# File 'lib/aws-sdk-lexmodelbuildingservice/client.rb', line 4084

def put_intent(params = {}, options = {})
  req = build_request(:put_intent, params)
  req.send_request(options)
end

#put_slot_type(params = {}) ⇒ Types::PutSlotTypeResponse

Creates a custom slot type or replaces an existing custom slot type.

To create a custom slot type, specify a name for the slot type and a set of enumeration values, which are the values that a slot of this type can assume. For more information, see how-it-works.

If you specify the name of an existing slot type, the fields in the request replace the existing values in the ‘$LATEST` version of the slot type. Amazon Lex removes the fields that you don’t provide in the request. If you don’t specify required fields, Amazon Lex throws an exception. When you update the ‘$LATEST` version of a slot type, if a bot uses the `$LATEST` version of an intent that contains the slot type, the bot’s ‘status` field is set to `NOT_BUILT`.

This operation requires permissions for the ‘lex:PutSlotType` action.

Examples:

Example: To Create a Slot Type


# This example shows how to create a slot type that describes pizza sauces.

resp = client.put_slot_type({
  name: "PizzaSauceType", 
  description: "Available pizza sauces", 
  enumeration_values: [
    {
      value: "red", 
    }, 
    {
      value: "white", 
    }, 
  ], 
})

resp.to_h outputs the following:
{
  version: "$LATEST", 
  name: "DocPizzaSauceType", 
  checksum: "cfd00ed1-775d-4357-947c-aca7e73b44ba", 
  created_date: Time.parse(1494356442.23), 
  description: "Available pizza sauces", 
  enumeration_values: [
    {
      value: "red", 
    }, 
    {
      value: "white", 
    }, 
  ], 
  last_updated_date: Time.parse(1494356442.23), 
}

Request syntax with placeholder values


resp = client.put_slot_type({
  name: "SlotTypeName", # required
  description: "Description",
  enumeration_values: [
    {
      value: "Value", # required
      synonyms: ["Value"],
    },
  ],
  checksum: "String",
  value_selection_strategy: "ORIGINAL_VALUE", # accepts ORIGINAL_VALUE, TOP_RESOLUTION
  create_version: false,
  parent_slot_type_signature: "CustomOrBuiltinSlotTypeName",
  slot_type_configurations: [
    {
      regex_configuration: {
        pattern: "RegexPattern", # required
      },
    },
  ],
})

Response structure


resp.name #=> String
resp.description #=> String
resp.enumeration_values #=> Array
resp.enumeration_values[0].value #=> String
resp.enumeration_values[0].synonyms #=> Array
resp.enumeration_values[0].synonyms[0] #=> String
resp.last_updated_date #=> Time
resp.created_date #=> Time
resp.version #=> String
resp.checksum #=> String
resp.value_selection_strategy #=> String, one of "ORIGINAL_VALUE", "TOP_RESOLUTION"
resp.create_version #=> Boolean
resp.parent_slot_type_signature #=> String
resp.slot_type_configurations #=> Array
resp.slot_type_configurations[0].regex_configuration.pattern #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :name (required, String) —

    The name of the slot type. The name is not case sensitive.

    The name can’t match a built-in slot type name, or a built-in slot type name with “AMAZON.” removed. For example, because there is a built-in slot type called ‘AMAZON.DATE`, you can’t create a custom slot type called ‘DATE`.

    For a list of built-in slot types, see [Slot Type Reference] in the *Alexa Skills Kit*.

    [1]: developer.amazon.com/public/solutions/alexa/alexa-skills-kit/docs/built-in-intent-ref/slot-type-reference

  • :description (String) —

    A description of the slot type.

  • :enumeration_values (Array<Types::EnumerationValue>) —

    A list of ‘EnumerationValue` objects that defines the values that the slot type can take. Each value can have a list of `synonyms`, which are additional values that help train the machine learning model about the values that it resolves for a slot.

    A regular expression slot type doesn’t require enumeration values. All other slot types require a list of enumeration values.

    When Amazon Lex resolves a slot value, it generates a resolution list that contains up to five possible values for the slot. If you are using a Lambda function, this resolution list is passed to the function. If you are not using a Lambda function you can choose to return the value that the user entered or the first value in the resolution list as the slot value. The ‘valueSelectionStrategy` field indicates the option to use.

  • :checksum (String) —

    Identifies a specific revision of the ‘$LATEST` version.

    When you create a new slot type, leave the ‘checksum` field blank. If you specify a checksum you get a `BadRequestException` exception.

    When you want to update a slot type, set the ‘checksum` field to the checksum of the most recent revision of the `$LATEST` version. If you don’t specify the ‘ checksum` field, or if the checksum does not match the `$LATEST` version, you get a `PreconditionFailedException` exception.

  • :value_selection_strategy (String) —

    Determines the slot resolution strategy that Amazon Lex uses to return slot type 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 as the slot type value. If there is no resolution list, null is returned.

    If you don’t specify the ‘valueSelectionStrategy`, the default is `ORIGINAL_VALUE`.

  • :create_version (Boolean) —

    When set to ‘true` a new numbered version of the slot type is created. This is the same as calling the `CreateSlotTypeVersion` operation. If you do not specify `createVersion`, the default is `false`.

  • :parent_slot_type_signature (String) —

    The built-in slot type used as the parent of the slot type. When you define a parent slot type, the new slot type has all of the same configuration as the parent.

    Only ‘AMAZON.AlphaNumeric` is supported.

  • :slot_type_configurations (Array<Types::SlotTypeConfiguration>) —

    Configuration information that extends the parent built-in slot type. The configuration is added to the settings for the parent slot type.

Returns:

See Also:



4278
4279
4280
4281
 
# File 'lib/aws-sdk-lexmodelbuildingservice/client.rb', line 4278

def put_slot_type(params = {}, options = {})
  req = build_request(:put_slot_type, params)
  req.send_request(options)
end

#start_import(params = {}) ⇒ Types::StartImportResponse

Starts a job to import a resource to Amazon Lex.

Examples:

Request syntax with placeholder values


resp = client.start_import({
  payload: "data", # required
  resource_type: "BOT", # required, accepts BOT, INTENT, SLOT_TYPE
  merge_strategy: "OVERWRITE_LATEST", # required, accepts OVERWRITE_LATEST, FAIL_ON_CONFLICT
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
})

Response structure


resp.name #=> String
resp.resource_type #=> String, one of "BOT", "INTENT", "SLOT_TYPE"
resp.merge_strategy #=> String, one of "OVERWRITE_LATEST", "FAIL_ON_CONFLICT"
resp.import_id #=> String
resp.import_status #=> String, one of "IN_PROGRESS", "COMPLETE", "FAILED"
resp.tags #=> Array
resp.tags[0].key #=> String
resp.tags[0].value #=> String
resp.created_date #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :payload (required, String, StringIO, File) —

    A zip archive in binary format. The archive should contain one file, a JSON file containing the resource to import. The resource should match the type specified in the ‘resourceType` field.

  • :resource_type (required, String) —

    Specifies the type of resource to export. Each resource also exports any resources that it depends on.

    • A bot exports dependent intents.

    • An intent exports dependent slot types.

  • :merge_strategy (required, String) —

    Specifies the action that the ‘StartImport` operation should take when there is an existing resource with the same name.

    • FAIL_ON_CONFLICT - The import operation is stopped on the first conflict between a resource in the import file and an existing resource. The name of the resource causing the conflict is in the ‘failureReason` field of the response to the `GetImport` operation.

      OVERWRITE_LATEST - The import operation proceeds even if there is a conflict with an existing resource. The $LASTEST version of the existing resource is overwritten with the data from the import file.

  • :tags (Array<Types::Tag>) —

    A list of tags to add to the imported bot. You can only add tags when you import a bot, you can’t add tags to an intent or slot type.

Returns:

See Also:



4355
4356
4357
4358
 
# File 'lib/aws-sdk-lexmodelbuildingservice/client.rb', line 4355

def start_import(params = {}, options = {})
  req = build_request(:start_import, params)
  req.send_request(options)
end

#start_migration(params = {}) ⇒ Types::StartMigrationResponse

Starts migrating a bot from Amazon Lex V1 to Amazon Lex V2. Migrate your bot when you want to take advantage of the new features of Amazon Lex V2.

For more information, see [Migrating a bot] in the *Amazon Lex developer guide*.

[1]: docs.aws.amazon.com/lex/latest/dg/migrate.html

Examples:

Request syntax with placeholder values


resp = client.start_migration({
  v1_bot_name: "BotName", # required
  v1_bot_version: "Version", # required
  v2_bot_name: "V2BotName", # required
  v2_bot_role: "IamRoleArn", # required
  migration_strategy: "CREATE_NEW", # required, accepts CREATE_NEW, UPDATE_EXISTING
})

Response structure


resp.v1_bot_name #=> String
resp.v1_bot_version #=> String
resp.v1_bot_locale #=> String, one of "de-DE", "en-AU", "en-GB", "en-IN", "en-US", "es-419", "es-ES", "es-US", "fr-FR", "fr-CA", "it-IT", "ja-JP", "ko-KR"
resp.v2_bot_id #=> String
resp.v2_bot_role #=> String
resp.migration_id #=> String
resp.migration_strategy #=> String, one of "CREATE_NEW", "UPDATE_EXISTING"
resp.migration_timestamp #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :v1_bot_name (required, String) —

    The name of the Amazon Lex V1 bot that you are migrating to Amazon Lex V2.

  • :v1_bot_version (required, String) —

    The version of the bot to migrate to Amazon Lex V2. You can migrate the ‘$LATEST` version as well as any numbered version.

  • :v2_bot_name (required, String) —

    The name of the Amazon Lex V2 bot that you are migrating the Amazon Lex V1 bot to.

    • If the Amazon Lex V2 bot doesn’t exist, you must use the ‘CREATE_NEW` migration strategy.

    • If the Amazon Lex V2 bot exists, you must use the ‘UPDATE_EXISTING` migration strategy to change the contents of the Amazon Lex V2 bot.

  • :v2_bot_role (required, String) —

    The IAM role that Amazon Lex uses to run the Amazon Lex V2 bot.

  • :migration_strategy (required, String) —

    The strategy used to conduct the migration.

    • ‘CREATE_NEW` - Creates a new Amazon Lex V2 bot and migrates the Amazon Lex V1 bot to the new bot.

    • ‘UPDATE_EXISTING` - Overwrites the existing Amazon Lex V2 bot metadata and the locale being migrated. It doesn’t change any other locales in the Amazon Lex V2 bot. If the locale doesn’t exist, a new locale is created in the Amazon Lex V2 bot.

Returns:

See Also:



4439
4440
4441
4442
 
# File 'lib/aws-sdk-lexmodelbuildingservice/client.rb', line 4439

def start_migration(params = {}, options = {})
  req = build_request(:start_migration, params)
  req.send_request(options)
end

#tag_resource(params = {}) ⇒ Struct

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

Examples:

Request syntax with placeholder values


resp = client.tag_resource({
  resource_arn: "AmazonResourceName", # required
  tags: [ # required
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The Amazon Resource Name (ARN) of the bot, bot alias, or bot channel to tag.

  • :tags (required, Array<Types::Tag>) —

    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.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



4473
4474
4475
4476
 
# File 'lib/aws-sdk-lexmodelbuildingservice/client.rb', line 4473

def tag_resource(params = {}, options = {})
  req = build_request(:tag_resource, params)
  req.send_request(options)
end

#untag_resource(params = {}) ⇒ Struct

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

Examples:

Request syntax with placeholder values


resp = client.untag_resource({
  resource_arn: "AmazonResourceName", # required
  tag_keys: ["TagKey"], # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The Amazon Resource Name (ARN) of the resource to remove the tags from.

  • :tag_keys (required, Array<String>) —

    A list of tag keys to remove from the resource. If a tag key does not exist on the resource, it is ignored.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



4501
4502
4503
4504
 
# File 'lib/aws-sdk-lexmodelbuildingservice/client.rb', line 4501

def untag_resource(params = {}, options = {})
  req = build_request(:untag_resource, params)
  req.send_request(options)
end

#waiter_names ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Deprecated. 


4530
4531
4532
 
# File 'lib/aws-sdk-lexmodelbuildingservice/client.rb', line 4530

def waiter_names
  []
end