Class: Aws::LexModelsV2::Types::ListBotsRequest

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 ListBotsRequest data as a hash:

{
  sort_by: {
    attribute: "BotName", # required, accepts BotName
    order: "Ascending", # required, accepts Ascending, Descending
  },
  filters: [
    {
      name: "BotName", # required, accepts BotName
      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

#filtersArray<Types::BotFilter>

Provides the specification of a filter used to limit the bots in the response to only those that match the filter specification. You can only specify one filter and one string to filter on.

Returns:



6824
6825
6826
6827
6828
6829
6830
6831
# File 'gems/aws-sdk-lexmodelsv2/lib/aws-sdk-lexmodelsv2/types.rb', line 6824

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

#max_resultsInteger

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

Returns:

  • (Integer)


6824
6825
6826
6827
6828
6829
6830
6831
# File 'gems/aws-sdk-lexmodelsv2/lib/aws-sdk-lexmodelsv2/types.rb', line 6824

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

#next_tokenString

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

Returns:

  • (String)


6824
6825
6826
6827
6828
6829
6830
6831
# File 'gems/aws-sdk-lexmodelsv2/lib/aws-sdk-lexmodelsv2/types.rb', line 6824

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

#sort_byTypes::BotSortBy

Specifies sorting parameters for the list of bots. You can specify that the list be sorted by bot name in ascending or descending order.

Returns:



6824
6825
6826
6827
6828
6829
6830
6831
# File 'gems/aws-sdk-lexmodelsv2/lib/aws-sdk-lexmodelsv2/types.rb', line 6824

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