ResourceExplorer / Paginator / GetResourceExplorerSetup

GetResourceExplorerSetup¶

class ResourceExplorer.Paginator.GetResourceExplorerSetup¶

paginator = client.get_paginator('get_resource_explorer_setup')

paginate(**kwargs)¶

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

Request Syntax

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

Parameters:

TaskId (string) –
[REQUIRED]

The unique identifier of the setup task to retrieve status information for. This ID is returned by CreateResourceExplorerSetup or DeleteResourceExplorerSetup operations.
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

{
    'Regions': [
        {
            'Region': 'string',
            'Index': {
                'Status': 'SUCCEEDED'|'FAILED'|'IN_PROGRESS'|'SKIPPED',
                'Index': {
                    'Region': 'string',
                    'Arn': 'string',
                    'Type': 'LOCAL'|'AGGREGATOR'
                },
                'ErrorDetails': {
                    'Code': 'string',
                    'Message': 'string'
                }
            },
            'View': {
                'Status': 'SUCCEEDED'|'FAILED'|'IN_PROGRESS'|'SKIPPED',
                'View': {
                    'ViewArn': 'string',
                    'Owner': 'string',
                    'LastUpdatedAt': datetime(2015, 1, 1),
                    'Scope': 'string',
                    'IncludedProperties': [
                        {
                            'Name': 'string'
                        },
                    ],
                    'Filters': {
                        'FilterString': 'string'
                    }
                },
                'ErrorDetails': {
                    'Code': 'string',
                    'Message': 'string'
                }
            }
        },
    ],

}

Response Structure

(dict) –
- Regions (list) –
  
  A list of Region status objects that describe the current state of Resource Explorer configuration in each Region.
  - (dict) –
    
    Contains information about the status of Resource Explorer configuration in a specific Amazon Web Services Region.
    - Region (string) –
      
      The Amazon Web Services Region for which this status information applies.
    - Index (dict) –
      
      The status information for the Resource Explorer index in this Region.
      - Status (string) –
        
        The current status of the index operation. Valid values are SUCCEEDED, FAILED, IN_PROGRESS, or SKIPPED.
      - Index (dict) –
        
        An index is the data store used by Amazon Web Services Resource Explorer to hold information about your Amazon Web Services resources that the service discovers. Creating an index in an Amazon Web Services Region turns on Resource Explorer and lets it discover your resources.
        
        By default, an index is local, meaning that it contains information about resources in only the same Region as the index. However, you can promote the index of one Region in the account by calling UpdateIndexType to convert it into an aggregator index. The aggregator index receives a replicated copy of the index information from all other Regions where Resource Explorer is turned on. This allows search operations in that Region to return results from all Regions in the account.
        
        Region (string) –
        
        The Amazon Web Services Region in which the index exists.
        
        Arn (string) –
        
        The Amazon resource name (ARN) of the index.
        
        Type (string) –
        
        The type of index. It can be one of the following values:
        
        LOCAL – The index contains information about resources from only the same Amazon Web Services Region.
        
        AGGREGATOR – Resource Explorer replicates copies of the indexed information about resources in all other Amazon Web Services Regions to the aggregator index. This lets search results in the Region with the aggregator index to include resources from all Regions in the account where Resource Explorer is turned on.
      - ErrorDetails (dict) –
        
        Details about any error that occurred during the index operation.
        
        Code (string) –
        
        The error code that identifies the type of error that occurred.
        
        Message (string) –
        
        A human-readable description of the error that occurred.
    - View (dict) –
      
      The status information for the Resource Explorer view in this Region.
      - Status (string) –
        
        The current status of the view operation. Valid values are SUCCEEDED, FAILED, IN_PROGRESS, or SKIPPED.
      - View (dict) –
        
        A view is a structure that defines a set of filters that provide a view into the information in the Amazon Web Services Resource Explorer index. The filters specify which information from the index is visible to the users of the view. For example, you can specify filters that include only resources that are tagged with the key “ENV” and the value “DEVELOPMENT” in the results returned by this view. You could also create a second view that includes only resources that are tagged with “ENV” and “PRODUCTION”.
        
        ViewArn (string) –
        
        The Amazon resource name (ARN) of the view.
        
        Owner (string) –
        
        The Amazon Web Services account that owns this view.
        
        LastUpdatedAt (datetime) –
        
        The date and time when this view was last modified.
        
        Scope (string) –
        
        An Amazon resource name (ARN) of an Amazon Web Services account, an organization, or an organizational unit (OU) that specifies whether this view includes resources from only the specified Amazon Web Services account, all accounts in the specified organization, or all accounts in the specified OU.
        
        If not specified, the value defaults to the Amazon Web Services account used to call this operation.
        
        IncludedProperties (list) –
        
        A structure that contains additional information about the view.
        
        (dict) –
        
        Information about an additional property that describes a resource, that you can optionally include in the view. This lets you view that property in search results, and filter your search results based on the value of the property.
        
        Name (string) –
        
        The name of the property that is included in this view.
        
        You can specify the following property names for this field:
        
        tags
        
        Filters (dict) –
        
        An array of SearchFilter objects that specify which resources can be included in the results of queries made using this view.
        
        FilterString (string) –
        
        The string that contains the search keywords, prefixes, and operators to control the results that can be returned by a Search operation. For more details, see Search query syntax.
      - ErrorDetails (dict) –
        
        Details about any error that occurred during the view operation.
        
        Code (string) –
        
        The error code that identifies the type of error that occurred.
        
        Message (string) –
        
        A human-readable description of the error that occurred.