Class: Aws::LexModelsV2::Types::ListBotLocalesRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-lexmodelsv2/lib/aws-sdk-lexmodelsv2/types.rb

Overview

Note:

When making an API call, you may pass ListBotLocalesRequest data as a hash:

{
  bot_id: "Id", # required
  bot_version: "BotVersion", # required
  sort_by: {
    attribute: "BotLocaleName", # required, accepts BotLocaleName
    order: "Ascending", # required, accepts Ascending, Descending
  },
  filters: [
    {
      name: "BotLocaleName", # required, accepts BotLocaleName
      values: ["FilterValue"], # required
      operator: "CO", # required, accepts CO, EQ
    },
  ],
  max_results: 1,
  next_token: "NextToken",
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#bot_idString

The identifier of the bot to list locales for.

Returns:

  • (String)


6656
6657
6658
6659
6660
6661
6662
6663
6664
6665
# File 'gems/aws-sdk-lexmodelsv2/lib/aws-sdk-lexmodelsv2/types.rb', line 6656

class ListBotLocalesRequest < Struct.new(
  :bot_id,
  :bot_version,
  :sort_by,
  :filters,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#bot_versionString

The version of the bot to list locales for.

Returns:

  • (String)


6656
6657
6658
6659
6660
6661
6662
6663
6664
6665
# File 'gems/aws-sdk-lexmodelsv2/lib/aws-sdk-lexmodelsv2/types.rb', line 6656

class ListBotLocalesRequest < Struct.new(
  :bot_id,
  :bot_version,
  :sort_by,
  :filters,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#filtersArray<Types::BotLocaleFilter>

Provides the specification for a filter used to limit the response to only those locales that match the filter specification. You can only specify one filter and one value to filter on.

Returns:



6656
6657
6658
6659
6660
6661
6662
6663
6664
6665
# File 'gems/aws-sdk-lexmodelsv2/lib/aws-sdk-lexmodelsv2/types.rb', line 6656

class ListBotLocalesRequest < Struct.new(
  :bot_id,
  :bot_version,
  :sort_by,
  :filters,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#max_resultsInteger

The maximum number of aliases to return in each page of results. If there are fewer results than the max page size, only the actual number of results are returned.

Returns:

  • (Integer)


6656
6657
6658
6659
6660
6661
6662
6663
6664
6665
# File 'gems/aws-sdk-lexmodelsv2/lib/aws-sdk-lexmodelsv2/types.rb', line 6656

class ListBotLocalesRequest < Struct.new(
  :bot_id,
  :bot_version,
  :sort_by,
  :filters,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#next_tokenString

If the response from the ListBotLocales operation contains more results than specified in the maxResults parameter, a token is returned in the response. Use that token as the nextToken parameter to return the next page of results.

Returns:

  • (String)


6656
6657
6658
6659
6660
6661
6662
6663
6664
6665
# File 'gems/aws-sdk-lexmodelsv2/lib/aws-sdk-lexmodelsv2/types.rb', line 6656

class ListBotLocalesRequest < Struct.new(
  :bot_id,
  :bot_version,
  :sort_by,
  :filters,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#sort_byTypes::BotLocaleSortBy

Specifies sorting parameters for the list of locales. You can sort by locale name in ascending or descending order.



6656
6657
6658
6659
6660
6661
6662
6663
6664
6665
# File 'gems/aws-sdk-lexmodelsv2/lib/aws-sdk-lexmodelsv2/types.rb', line 6656

class ListBotLocalesRequest < Struct.new(
  :bot_id,
  :bot_version,
  :sort_by,
  :filters,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end