ResourceExplorer / Client / get_index

get_index#

ResourceExplorer.Client.get_index()#

Retrieves details about the Amazon Web Services Resource Explorer index in the Amazon Web Services Region in which you invoked the operation.

See also: AWS API Documentation

Request Syntax

response = client.get_index()
Return type:

dict

Returns:

Response Syntax

{
    'Arn': 'string',
    'CreatedAt': datetime(2015, 1, 1),
    'LastUpdatedAt': datetime(2015, 1, 1),
    'ReplicatingFrom': [
        'string',
    ],
    'ReplicatingTo': [
        'string',
    ],
    'State': 'CREATING'|'ACTIVE'|'DELETING'|'DELETED'|'UPDATING',
    'Tags': {
        'string': 'string'
    },
    'Type': 'LOCAL'|'AGGREGATOR'
}

Response Structure

  • (dict) –

    • Arn (string) –

      The Amazon resource name (ARN) of the index.

    • CreatedAt (datetime) –

      The date and time when the index was originally created.

    • LastUpdatedAt (datetime) –

      The date and time when the index was last updated.

    • ReplicatingFrom (list) –

      This response value is present only if this index is Type=AGGREGATOR.

      A list of the Amazon Web Services Regions that replicate their content to the index in this Region.

      • (string) –

    • ReplicatingTo (list) –

      This response value is present only if this index is Type=LOCAL.

      The Amazon Web Services Region that contains the aggregator index, if one exists. If an aggregator index does exist then the Region in which you called this operation replicates its index information to the Region specified in this response value.

      • (string) –

    • State (string) –

      The current state of the index in this Amazon Web Services Region.

    • Tags (dict) –

      Tag key and value pairs that are attached to the index.

      • (string) –

        • (string) –

    • Type (string) –

      The type of the index in this Region. For information about the aggregator index and how it differs from a local index, see Turning on cross-Region search by creating an aggregator index.

Exceptions