Class: Aws::ResourceExplorer2::Types::SearchInput
- Inherits:
-
Struct
- Object
- Struct
- Aws::ResourceExplorer2::Types::SearchInput
- Defined in:
- gems/aws-sdk-resourceexplorer2/lib/aws-sdk-resourceexplorer2/types.rb
Overview
Constant Summary collapse
- SENSITIVE =
[:query_string]
Instance Attribute Summary collapse
-
#max_results ⇒ Integer
The maximum number of results that you want included on each page of the response.
-
#next_token ⇒ String
The parameter for receiving additional results if you receive a
NextToken
response in a previous request. -
#query_string ⇒ String
A string that includes keywords and filters that specify the resources that you want to include in the results.
-
#view_arn ⇒ String
Specifies the [Amazon resource name (ARN)][1] of the view to use for the query.
Instance Attribute Details
#max_results ⇒ Integer
The maximum number of results that you want included on each page of
the response. If you do not include this parameter, it defaults to a
value appropriate to the operation. If additional items exist beyond
those included in the current response, the NextToken
response
element is present and has a value (is not null). Include that value
as the NextToken
request parameter in the next call to the
operation to get the next part of the results.
NextToken
after
every operation to ensure that you receive all of the results.
1160 1161 1162 1163 1164 1165 1166 1167 |
# File 'gems/aws-sdk-resourceexplorer2/lib/aws-sdk-resourceexplorer2/types.rb', line 1160 class SearchInput < Struct.new( :max_results, :next_token, :query_string, :view_arn) SENSITIVE = [:query_string] include Aws::Structure end |
#next_token ⇒ String
The parameter for receiving additional results if you receive a
NextToken
response in a previous request. A NextToken
response
indicates that more output is available. Set this parameter to the
value of the previous call's NextToken
response to indicate where
the output should continue from. The pagination tokens expire after
24 hours.
1160 1161 1162 1163 1164 1165 1166 1167 |
# File 'gems/aws-sdk-resourceexplorer2/lib/aws-sdk-resourceexplorer2/types.rb', line 1160 class SearchInput < Struct.new( :max_results, :next_token, :query_string, :view_arn) SENSITIVE = [:query_string] include Aws::Structure end |
#query_string ⇒ String
A string that includes keywords and filters that specify the resources that you want to include in the results.
For the complete syntax supported by the QueryString
parameter,
see Search query syntax reference for Resource Explorer.
The search is completely case insensitive. You can specify an empty string to return all results up to the limit of 1,000 total results.
QueryString
to refine the results.
1160 1161 1162 1163 1164 1165 1166 1167 |
# File 'gems/aws-sdk-resourceexplorer2/lib/aws-sdk-resourceexplorer2/types.rb', line 1160 class SearchInput < Struct.new( :max_results, :next_token, :query_string, :view_arn) SENSITIVE = [:query_string] include Aws::Structure end |
#view_arn ⇒ String
Specifies the Amazon resource name (ARN) of the view to use for
the query. If you don't specify a value for this parameter, then
the operation automatically uses the default view for the Amazon Web
Services Region in which you called this operation. If the Region
either doesn't have a default view or if you don't have permission
to use the default view, then the operation fails with a 401
Unauthorized
exception.
1160 1161 1162 1163 1164 1165 1166 1167 |
# File 'gems/aws-sdk-resourceexplorer2/lib/aws-sdk-resourceexplorer2/types.rb', line 1160 class SearchInput < Struct.new( :max_results, :next_token, :query_string, :view_arn) SENSITIVE = [:query_string] include Aws::Structure end |