Search¶

class ResourceExplorer.Paginator.Search¶

paginator = client.get_paginator('search')

paginate(**kwargs)¶

Creates an iterator that will paginate through responses from ResourceExplorer.Client.search().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    QueryString='string',
    ViewArn='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters

QueryString (string) --
[REQUIRED]

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

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.
ViewArn (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.
PaginationConfig (dict) --
A dictionary that provides parameters to control pagination.
- MaxItems (integer) --
  The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
- PageSize (integer) --
  The size of each page.
- StartingToken (string) --
  A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'Count': {
        'Complete': True|False,
        'TotalResources': 123
    },
    'Resources': [
        {
            'Arn': 'string',
            'LastReportedAt': datetime(2015, 1, 1),
            'OwningAccountId': 'string',
            'Properties': [
                {
                    'Data': {...}|[...]|123|123.4|'string'|True|None,
                    'LastReportedAt': datetime(2015, 1, 1),
                    'Name': 'string'
                },
            ],
            'Region': 'string',
            'ResourceType': 'string',
            'Service': 'string'
        },
    ],
    'ViewArn': 'string'
}

Response Structure

(dict) --
- Count (dict) --
  
  The number of resources that match the query.
  - Complete (boolean) --
    
    Indicates whether the TotalResources value represents an exhaustive count of search results.
    - If True , it indicates that the search was exhaustive. Every resource that matches the query was counted.
    - If False , then the search reached the limit of 1,000 matching results, and stopped counting.
  - TotalResources (integer) --
    
    The number of resources that match the search query. This value can't exceed 1,000. If there are more than 1,000 resources that match the query, then only 1,000 are counted and the Complete field is set to false. We recommend that you refine your query to return a smaller number of results.
- Resources (list) --
  
  The list of structures that describe the resources that match the query.
  - (dict) --
    
    A resource in Amazon Web Services that Amazon Web Services Resource Explorer has discovered, and for which it has stored information in the index of the Amazon Web Services Region that contains the resource.
    - Arn (string) --
      
      The Amazon resource name (ARN) of the resource.
    - LastReportedAt (datetime) --
      
      The date and time that Resource Explorer last queried this resource and updated the index with the latest information about the resource.
    - OwningAccountId (string) --
      
      The Amazon Web Services account that owns the resource.
    - Properties (list) --
      
      A structure with additional type-specific details about the resource. These properties can be added by turning on integration between Resource Explorer and other Amazon Web Services services.
      - (dict) --
        
        A structure that describes a property of a resource.
        
        Data (document) --
        
        Details about this property. The content of this field is a JSON object that varies based on the resource type.
        
        LastReportedAt (datetime) --
        
        The date and time that the information about this resource property was last updated.
        
        Name (string) --
        
        The name of this property of the resource.
    - Region (string) --
      
      The Amazon Web Services Region in which the resource was created and exists.
    - ResourceType (string) --
      
      The type of the resource.
    - Service (string) --
      
      The Amazon Web Service that owns the resource and is responsible for creating and updating it.
- ViewArn (string) --
  
  The Amazon resource name (ARN) of the view that this operation used to perform the search.

Table Of Contents

Search¶