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

Inherits:

Struct

• Object
• Struct
• Aws::LexModelsV2::Types::ListBotsRequest

Includes:

Structure

Defined in:

lib/aws-sdk-lexmodelsv2/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #filters ⇒ Array<Types::BotFilter>

  Provides the specification of a filter used to limit the bots in the response to only those that match the filter specification.

• #max_results ⇒ Integer

  The maximum number of bots to return in each page of results.

• #next_token ⇒ String

  If the response from the ‘ListBots` operation contains more results than specified in the `maxResults` parameter, a token is returned in the response.

• #sort_by ⇒ Types::BotSortBy

  Specifies sorting parameters for the list of bots.

Instance Attribute Details

#filters ⇒ Array<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:

• (Array<Types::BotFilter>)

# File 'lib/aws-sdk-lexmodelsv2/types.rb', line 9374

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

#max_results ⇒ Integer

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)

# File 'lib/aws-sdk-lexmodelsv2/types.rb', line 9374

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

#next_token ⇒ String

If the response from the ‘ListBots` operation contains more results than specified in the `maxResults` parameter, a token is returned in the response.

Use the returned token in the ‘nextToken` parameter of a `ListBots` request to return the next page of results. For a complete set of results, call the `ListBots` operation until the `nextToken` returned in the response is null.

Returns:

• (String)

# File 'lib/aws-sdk-lexmodelsv2/types.rb', line 9374

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

#sort_by ⇒ Types::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:

• (Types::BotSortBy)

# File 'lib/aws-sdk-lexmodelsv2/types.rb', line 9374

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