Class: Aws::LexModelsV2::Types::ListBuiltInIntentsRequest

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

{
  locale_id: "LocaleId", # required
  sort_by: {
    attribute: "IntentSignature", # required, accepts IntentSignature
    order: "Ascending", # required, accepts Ascending, Descending
  },
  max_results: 1,
  next_token: "NextToken",
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#locale_idString

The identifier of the language and locale of the intents to list. The string must match one of the supported locales. For more information, see Supported languages.

Returns:

  • (String)


6901
6902
6903
6904
6905
6906
6907
6908
# File 'gems/aws-sdk-lexmodelsv2/lib/aws-sdk-lexmodelsv2/types.rb', line 6901

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

#max_resultsInteger

The maximum number of built-in intents 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)


6901
6902
6903
6904
6905
6906
6907
6908
# File 'gems/aws-sdk-lexmodelsv2/lib/aws-sdk-lexmodelsv2/types.rb', line 6901

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

#next_tokenString

If the response from the ListBuiltInIntents 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)


6901
6902
6903
6904
6905
6906
6907
6908
# File 'gems/aws-sdk-lexmodelsv2/lib/aws-sdk-lexmodelsv2/types.rb', line 6901

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

#sort_byTypes::BuiltInIntentSortBy

Specifies sorting parameters for the list of built-in intents. You can specify that the list be sorted by the built-in intent signature in either ascending or descending order.



6901
6902
6903
6904
6905
6906
6907
6908
# File 'gems/aws-sdk-lexmodelsv2/lib/aws-sdk-lexmodelsv2/types.rb', line 6901

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