You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::LexModelBuildingService::Client

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

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

#config, #handlers

API Operations collapse

Instance Method Summary collapse

Methods included from ClientStubs

#stub_data, #stub_responses

Methods inherited from Seahorse::Client::Base

add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins

Methods included from Seahorse::Client::HandlerBuilder

#handle, #handle_request, #handle_response

Constructor Details

#initialize(*args) ⇒ Client

Returns a new instance of Client

Parameters:

  • options (Hash)

    a customizable set of options



142
143
144
# File 'gems/aws-sdk-lexmodelbuildingservice/lib/aws-sdk-lexmodelbuildingservice/client.rb', line 142

def initialize(*args)
  super
end

Instance Method Details

#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.

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

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"
resp.clarification_prompt.messages[0].content #=> String
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"
resp.abort_statement.messages[0].content #=> String
resp.abort_statement.response_card #=> String
resp.status #=> String, one of "BUILDING", "READY", "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 "en-US"
resp.child_directed #=> 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:



233
234
235
236
# File 'gems/aws-sdk-lexmodelbuildingservice/lib/aws-sdk-lexmodelbuildingservice/client.rb', line 233

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.

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

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

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

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"
resp.slots[0].value_elicitation_prompt.messages[0].content #=> String
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.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"
resp.confirmation_prompt.messages[0].content #=> String
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"
resp.rejection_statement.messages[0].content #=> String
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"
resp.follow_up_prompt.prompt.messages[0].content #=> String
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"
resp.follow_up_prompt.rejection_statement.messages[0].content #=> String
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"
resp.conclusion_statement.messages[0].content #=> String
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

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:



351
352
353
354
# File 'gems/aws-sdk-lexmodelbuildingservice/lib/aws-sdk-lexmodelbuildingservice/client.rb', line 351

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.

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.

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"

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:



423
424
425
426
# File 'gems/aws-sdk-lexmodelbuildingservice/lib/aws-sdk-lexmodelbuildingservice/client.rb', line 423

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.

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:



456
457
458
459
# File 'gems/aws-sdk-lexmodelbuildingservice/lib/aws-sdk-lexmodelbuildingservice/client.rb', line 456

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:



491
492
493
494
# File 'gems/aws-sdk-lexmodelbuildingservice/lib/aws-sdk-lexmodelbuildingservice/client.rb', line 491

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:



526
527
528
529
# File 'gems/aws-sdk-lexmodelbuildingservice/lib/aws-sdk-lexmodelbuildingservice/client.rb', line 526

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:



558
559
560
561
# File 'gems/aws-sdk-lexmodelbuildingservice/lib/aws-sdk-lexmodelbuildingservice/client.rb', line 558

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.

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.

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:



597
598
599
600
# File 'gems/aws-sdk-lexmodelbuildingservice/lib/aws-sdk-lexmodelbuildingservice/client.rb', line 597

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:



629
630
631
632
# File 'gems/aws-sdk-lexmodelbuildingservice/lib/aws-sdk-lexmodelbuildingservice/client.rb', line 629

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.

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.

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:



669
670
671
672
# File 'gems/aws-sdk-lexmodelbuildingservice/lib/aws-sdk-lexmodelbuildingservice/client.rb', line 669

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:



701
702
703
704
# File 'gems/aws-sdk-lexmodelbuildingservice/lib/aws-sdk-lexmodelbuildingservice/client.rb', line 701

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 unless the childDirected field in the bot is set to true. Utterances are stored for 15 days for use with the GetUtterancesView operation, and then stored indefinately for use in improving the ability of your bot to respond to user input.

Use the DeleteStoredUtterances operation to manually delete stored utterances for a specific user.

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):

  • :bot_name (required, String)

    The name of the bot that stored the utterances.

  • :user_id (required, String)

    The unique identifier for the user that made the utterances. This is the user ID that was sent in the PostContent or PostText operation request that contained the utterance.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



746
747
748
749
# File 'gems/aws-sdk-lexmodelbuildingservice/lib/aws-sdk-lexmodelbuildingservice/client.rb', line 746

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.clarification_prompt.messages #=> Array
resp.clarification_prompt.messages[0].content_type #=> String, one of "PlainText", "SSML"
resp.clarification_prompt.messages[0].content #=> String
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"
resp.abort_statement.messages[0].content #=> String
resp.abort_statement.response_card #=> String
resp.status #=> String, one of "BUILDING", "READY", "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 "en-US"
resp.child_directed #=> 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:



873
874
875
876
# File 'gems/aws-sdk-lexmodelbuildingservice/lib/aws-sdk-lexmodelbuildingservice/client.rb', line 873

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

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:



920
921
922
923
# File 'gems/aws-sdk-lexmodelbuildingservice/lib/aws-sdk-lexmodelbuildingservice/client.rb', line 920

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.

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.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:



978
979
980
981
# File 'gems/aws-sdk-lexmodelbuildingservice/lib/aws-sdk-lexmodelbuildingservice/client.rb', line 978

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"
resp.bot_configuration #=> Hash
resp.bot_configuration["String"] #=> 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:



1033
1034
1035
1036
# File 'gems/aws-sdk-lexmodelbuildingservice/lib/aws-sdk-lexmodelbuildingservice/client.rb', line 1033

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.

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"
resp.bot_channel_associations[0].bot_configuration #=> Hash
resp.bot_channel_associations[0].bot_configuration["String"] #=> 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:



1100
1101
1102
1103
# File 'gems/aws-sdk-lexmodelbuildingservice/lib/aws-sdk-lexmodelbuildingservice/client.rb', line 1100

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.

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", "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:



1160
1161
1162
1163
# File 'gems/aws-sdk-lexmodelbuildingservice/lib/aws-sdk-lexmodelbuildingservice/client.rb', line 1160

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.

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", "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:



1243
1244
1245
1246
# File 'gems/aws-sdk-lexmodelbuildingservice/lib/aws-sdk-lexmodelbuildingservice/client.rb', line 1243

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 "en-US"
resp.slots #=> Array
resp.slots[0].name #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :signature (required, String)

    The unique identifier for a built-in intent. To find the signature for an intent, see Standard Built-in Intents in the Alexa Skills Kit.

Returns:

See Also:



1286
1287
1288
1289
# File 'gems/aws-sdk-lexmodelbuildingservice/lib/aws-sdk-lexmodelbuildingservice/client.rb', line 1286

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.

Examples:

Request syntax with placeholder values


resp = client.get_builtin_intents({
  locale: "en-US", # accepts en-US
  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 "en-US"
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.

  • :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:



1346
1347
1348
1349
# File 'gems/aws-sdk-lexmodelbuildingservice/lib/aws-sdk-lexmodelbuildingservice/client.rb', line 1346

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.

Examples:

Request syntax with placeholder values


resp = client.get_builtin_slot_types({
  locale: "en-US", # accepts en-US
  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 "en-US"
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:



1407
1408
1409
1410
# File 'gems/aws-sdk-lexmodelbuildingservice/lib/aws-sdk-lexmodelbuildingservice/client.rb', line 1407

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
  export_type: "ALEXA_SKILLS_KIT", # required, accepts ALEXA_SKILLS_KIT
})

Response structure


resp.name #=> String
resp.version #=> String
resp.resource_type #=> String, one of "BOT"
resp.export_type #=> String, one of "ALEXA_SKILLS_KIT"
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:



1459
1460
1461
1462
# File 'gems/aws-sdk-lexmodelbuildingservice/lib/aws-sdk-lexmodelbuildingservice/client.rb', line 1459

def get_export(params = {}, options = {})
  req = build_request(:get_export, 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"
resp.slots[0].value_elicitation_prompt.messages[0].content #=> String
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.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"
resp.confirmation_prompt.messages[0].content #=> String
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"
resp.rejection_statement.messages[0].content #=> String
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"
resp.follow_up_prompt.prompt.messages[0].content #=> String
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"
resp.follow_up_prompt.rejection_statement.messages[0].content #=> String
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"
resp.conclusion_statement.messages[0].content #=> String
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

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:



1704
1705
1706
1707
# File 'gems/aws-sdk-lexmodelbuildingservice/lib/aws-sdk-lexmodelbuildingservice/client.rb', line 1704

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.

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:



1763
1764
1765
1766
# File 'gems/aws-sdk-lexmodelbuildingservice/lib/aws-sdk-lexmodelbuildingservice/client.rb', line 1763

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.

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:



1843
1844
1845
1846
# File 'gems/aws-sdk-lexmodelbuildingservice/lib/aws-sdk-lexmodelbuildingservice/client.rb', line 1843

def get_intents(params = {}, options = {})
  req = build_request(:get_intents, 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"

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:



1924
1925
1926
1927
# File 'gems/aws-sdk-lexmodelbuildingservice/lib/aws-sdk-lexmodelbuildingservice/client.rb', line 1924

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.

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:



1983
1984
1985
1986
# File 'gems/aws-sdk-lexmodelbuildingservice/lib/aws-sdk-lexmodelbuildingservice/client.rb', line 1983

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.

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:



2077
2078
2079
2080
# File 'gems/aws-sdk-lexmodelbuildingservice/lib/aws-sdk-lexmodelbuildingservice/client.rb', line 2077

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.

Data is available for the last 15 days. You can request information for up to 5 versions in each request. The response contains information about a maximum of 100 utterances for each version.

If the bot's childDirected field is set to true, utterances for the bot are not stored and cannot be retrieved with the GetUtterancesView operation. For more information, see PutBot.

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, useDetected. To return utterances that were not recognized, use Missed.

Returns:

See Also:



2149
2150
2151
2152
# File 'gems/aws-sdk-lexmodelbuildingservice/lib/aws-sdk-lexmodelbuildingservice/client.rb', line 2149

def get_utterances_view(params = {}, options = {})
  req = build_request(:get_utterances_view, 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. You can use this to add intents later, or to remove intents from an existing bot. When you create a bot with a name only, 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 auth-and-access-control.

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 repeate 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
    },
  ],
  clarification_prompt: {
    messages: [ # required
      {
        content_type: "PlainText", # required, accepts PlainText, SSML
        content: "ContentString", # required
      },
    ],
    max_attempts: 1, # required
    response_card: "ResponseCard",
  },
  abort_statement: {
    messages: [ # required
      {
        content_type: "PlainText", # required, accepts PlainText, SSML
        content: "ContentString", # required
      },
    ],
    response_card: "ResponseCard",
  },
  idle_session_ttl_in_seconds: 1,
  voice_id: "String",
  checksum: "String",
  process_behavior: "SAVE", # accepts SAVE, BUILD
  locale: "en-US", # required, accepts en-US
  child_directed: false, # 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.clarification_prompt.messages #=> Array
resp.clarification_prompt.messages[0].content_type #=> String, one of "PlainText", "SSML"
resp.clarification_prompt.messages[0].content #=> String
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"
resp.abort_statement.messages[0].content #=> String
resp.abort_statement.response_card #=> String
resp.status #=> String, one of "BUILDING", "READY", "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 "en-US"
resp.child_directed #=> Boolean

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.

  • :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 repeate 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.'"

  • :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 aborts 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.

  • :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 Available Voices in the Amazon Polly Developer Guide.

  • :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 SaveAmazon Lex saves the bot, but doesn't build it.

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

  • :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.

Returns:

See Also:



2476
2477
2478
2479
# File 'gems/aws-sdk-lexmodelbuildingservice/lib/aws-sdk-lexmodelbuildingservice/client.rb', line 2476

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",
})

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

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.

Returns:

See Also:



2546
2547
2548
2549
# File 'gems/aws-sdk-lexmodelbuildingservice/lib/aws-sdk-lexmodelbuildingservice/client.rb', line 2546

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 slot type 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.

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
            content: "ContentString", # required
          },
        ],
        max_attempts: 1, # required
        response_card: "ResponseCard",
      },
      priority: 1,
      sample_utterances: ["Utterance"],
      response_card: "ResponseCard",
    },
  ],
  sample_utterances: ["Utterance"],
  confirmation_prompt: {
    messages: [ # required
      {
        content_type: "PlainText", # required, accepts PlainText, SSML
        content: "ContentString", # required
      },
    ],
    max_attempts: 1, # required
    response_card: "ResponseCard",
  },
  rejection_statement: {
    messages: [ # required
      {
        content_type: "PlainText", # required, accepts PlainText, SSML
        content: "ContentString", # required
      },
    ],
    response_card: "ResponseCard",
  },
  follow_up_prompt: {
    prompt: { # required
      messages: [ # required
        {
          content_type: "PlainText", # required, accepts PlainText, SSML
          content: "ContentString", # required
        },
      ],
      max_attempts: 1, # required
      response_card: "ResponseCard",
    },
    rejection_statement: { # required
      messages: [ # required
        {
          content_type: "PlainText", # required, accepts PlainText, SSML
          content: "ContentString", # required
        },
      ],
      response_card: "ResponseCard",
    },
  },
  conclusion_statement: {
    messages: [ # required
      {
        content_type: "PlainText", # required, accepts PlainText, SSML
        content: "ContentString", # required
      },
    ],
    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",
})

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"
resp.slots[0].value_elicitation_prompt.messages[0].content #=> String
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.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"
resp.confirmation_prompt.messages[0].content #=> String
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"
resp.rejection_statement.messages[0].content #=> String
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"
resp.follow_up_prompt.prompt.messages[0].content #=> String
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"
resp.follow_up_prompt.rejection_statement.messages[0].content #=> String
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"
resp.conclusion_statement.messages[0].content #=> String
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

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.

  • :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.

    You you must provide both the rejectionStatement and the confirmationPrompt, or neither.

  • :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.

    You must provide both the rejectionStatement and the confirmationPrompt, or neither.

  • :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.

    The followUpPrompt and conclusionStatement are mutually exclusive. You can specify only one.

  • :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.

  • :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.

Returns:

See Also:



3171
3172
3173
3174
# File 'gems/aws-sdk-lexmodelbuildingservice/lib/aws-sdk-lexmodelbuildingservice/client.rb', line 3171

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.

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
})

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"

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.

  • :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.

    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.

Returns:

See Also:



3328
3329
3330
3331
# File 'gems/aws-sdk-lexmodelbuildingservice/lib/aws-sdk-lexmodelbuildingservice/client.rb', line 3328

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