Class: Aws::ResourceExplorer2::Types::SearchInput

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-resourceexplorer2/types.rb

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[:query_string]

Instance Attribute Summary collapse

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.

<note markdown=“1”> An API operation can return fewer results than the maximum even when there are more results available. You should check ‘NextToken` after every operation to ensure that you receive all of the results.

</note>

Returns:

  • (Integer) 


1413
1414
1415
1416
1417
1418
1419
1420
 
# File 'lib/aws-sdk-resourceexplorer2/types.rb', line 1413

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.

Returns:

  • (String) 


1413
1414
1415
1416
1417
1418
1419
1420
 
# File 'lib/aws-sdk-resourceexplorer2/types.rb', line 1413

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.

<note markdown=“1”> The operation can return only the first 1,000 results. If the resource you want is not included, then use a different value for ‘QueryString` to refine the results.

</note>

[1]: docs.aws.amazon.com/resource-explorer/latest/userguide/using-search-query-syntax.html

Returns:

  • (String) 


1413
1414
1415
1416
1417
1418
1419
1420
 
# File 'lib/aws-sdk-resourceexplorer2/types.rb', line 1413

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.

[1]: docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html

Returns:

  • (String) 


1413
1414
1415
1416
1417
1418
1419
1420
 
# File 'lib/aws-sdk-resourceexplorer2/types.rb', line 1413

class SearchInput < Struct.new(
  :max_results,
  :next_token,
  :query_string,
  :view_arn)
  SENSITIVE = [:query_string]
  include Aws::Structure
end