ResourceExplorer

Client

class ResourceExplorer.Client

A low-level client representing AWS Resource Explorer

Amazon Web Services Resource Explorer is a resource search and discovery service. By using Resource Explorer, you can explore your resources using an internet search engine-like experience. Examples of resources include Amazon Relational Database Service (Amazon RDS) instances, Amazon Simple Storage Service (Amazon S3) buckets, or Amazon DynamoDB tables. You can search for your resources using resource metadata like names, tags, and IDs. Resource Explorer can search across all of the Amazon Web Services Regions in your account in which you turn the service on, to simplify your cross-Region workloads.

Resource Explorer scans the resources in each of the Amazon Web Services Regions in your Amazon Web Services account in which you turn on Resource Explorer. Resource Explorer creates and maintains an index in each Region, with the details of that Region's resources.

You can search across all of the indexed Regions in your account by designating one of your Amazon Web Services Regions to contain the aggregator index for the account. When you promote a local index in a Region to become the aggregator index for the account, Resource Explorer automatically replicates the index information from all local indexes in the other Regions to the aggregator index. Therefore, the Region with the aggregator index has a copy of all resource information for all Regions in the account where you turned on Resource Explorer. As a result, views in the aggregator index Region include resources from all of the indexed Regions in your account.

For more information about Amazon Web Services Resource Explorer, including how to enable and configure the service, see the Amazon Web Services Resource Explorer User Guide.

client = session.create_client('resource-explorer-2')

These are the available methods:

associate_default_view(**kwargs)

Sets the specified view as the default for the Amazon Web Services Region in which you call this operation. When a user performs a Search that doesn't explicitly specify which view to use, then Amazon Web Services Resource Explorer automatically chooses this default view for searches performed in this Amazon Web Services Region.

If an Amazon Web Services Region doesn't have a default view configured, then users must explicitly specify a view with every Search operation performed in that Region.

See also: AWS API Documentation

Request Syntax

response = client.associate_default_view(
    ViewArn='string'
)
Parameters
ViewArn (string) --

[REQUIRED]

The Amazon resource name (ARN) of the view to set as the default for the Amazon Web Services Region and Amazon Web Services account in which you call this operation. The specified view must already exist in the called Region.

Return type
dict
Returns
Response Syntax
{
    'ViewArn': 'string'
}

Response Structure

  • (dict) --
    • ViewArn (string) --

      The Amazon resource name (ARN) of the view that the operation set as the default for queries made in the Amazon Web Services Region and Amazon Web Services account in which you called this operation.

Exceptions

batch_get_view(**kwargs)

Retrieves details about a list of views.

See also: AWS API Documentation

Request Syntax

response = client.batch_get_view(
    ViewArns=[
        'string',
    ]
)
Parameters
ViewArns (list) --

A list of Amazon resource names (ARNs) that identify the views you want details for.

  • (string) --
Return type
dict
Returns
Response Syntax
{
    'Errors': [
        {
            'ErrorMessage': 'string',
            'ViewArn': 'string'
        },
    ],
    'Views': [
        {
            'Filters': {
                'FilterString': 'string'
            },
            'IncludedProperties': [
                {
                    'Name': 'string'
                },
            ],
            'LastUpdatedAt': datetime(2015, 1, 1),
            'Owner': 'string',
            'Scope': 'string',
            'ViewArn': 'string'
        },
    ]
}

Response Structure

  • (dict) --
    • Errors (list) --

      If any of the specified ARNs result in an error, then this structure describes the error.

      • (dict) --

        A collection of error messages for any views that Amazon Web Services Resource Explorer couldn't retrieve details.

        • ErrorMessage (string) --

          The description of the error for the specified view.

        • ViewArn (string) --

          The Amazon resource name (ARN) of the view for which Resource Explorer failed to retrieve details.

    • Views (list) --

      A structure with a list of objects with details for each of the specified views.

      • (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".

        • 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.

        • 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
        • LastUpdatedAt (datetime) --

          The date and time when this view was last modified.

        • Owner (string) --

          The Amazon Web Services account that owns this view.

        • 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.

        • ViewArn (string) --

          The Amazon resource name (ARN) of the view.

Exceptions

can_paginate(operation_name)

Check if an operation can be paginated.

Parameters
operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Returns
True if the operation can be paginated, False otherwise.
close()

Closes underlying endpoint connections.

create_index(**kwargs)

Turns on Amazon Web Services Resource Explorer in the Amazon Web Services Region in which you called this operation by creating an index. Resource Explorer begins discovering the resources in this Region and stores the details about the resources in the index so that they can be queried by using the Search operation. You can create only one index in a Region.

Note

This operation creates only a local index. To promote the local index in one Amazon Web Services Region into the aggregator index for the Amazon Web Services account, use the UpdateIndexType operation. For more information, see Turning on cross-Region search by creating an aggregator index in the Amazon Web Services Resource Explorer User Guide .

For more details about what happens when you turn on Resource Explorer in an Amazon Web Services Region, see Turn on Resource Explorer to index your resources in an Amazon Web Services Region in the Amazon Web Services Resource Explorer User Guide .

If this is the first Amazon Web Services Region in which you've created an index for Resource Explorer, then this operation also creates a service-linked role in your Amazon Web Services account that allows Resource Explorer to enumerate your resources to populate the index.

  • Action : resource-explorer-2:CreateIndex Resource : The ARN of the index (as it will exist after the operation completes) in the Amazon Web Services Region and account in which you're trying to create the index. Use the wildcard character ( * ) at the end of the string to match the eventual UUID. For example, the following Resource element restricts the role or user to creating an index in only the us-east-2 Region of the specified account. "Resource": "arn:aws:resource-explorer-2:us-west-2:<account-id>:index/*" Alternatively, you can use "Resource": "*" to allow the role or user to create an index in any Region.
  • Action : iam:CreateServiceLinkedRole Resource : No specific resource (*). This permission is required only the first time you create an index to turn on Resource Explorer in the account. Resource Explorer uses this to create the service-linked role needed to index the resources in your account. Resource Explorer uses the same service-linked role for all additional indexes you create afterwards.

See also: AWS API Documentation

Request Syntax

response = client.create_index(
    ClientToken='string',
    Tags={
        'string': 'string'
    }
)
Parameters
  • ClientToken (string) --

    This value helps ensure idempotency. Resource Explorer uses this value to prevent the accidental creation of duplicate versions. We recommend that you generate a UUID-type value to ensure the uniqueness of your views.

    This field is autopopulated if not provided.

  • Tags (dict) --

    The specified tags are attached only to the index created in this Amazon Web Services Region. The tags aren't attached to any of the resources listed in the index.

    • (string) --
      • (string) --
Return type

dict

Returns

Response Syntax

{
    'Arn': 'string',
    'CreatedAt': datetime(2015, 1, 1),
    'State': 'CREATING'|'ACTIVE'|'DELETING'|'DELETED'|'UPDATING'
}

Response Structure

  • (dict) --

    • Arn (string) --

      The ARN of the new local index for the Region. You can reference this ARN in IAM permission policies to authorize the following operations: DeleteIndex | GetIndex | UpdateIndexType | CreateView

    • CreatedAt (datetime) --

      The date and timestamp when the index was created.

    • State (string) --

      Indicates the current state of the index. You can check for changes to the state for asynchronous operations by calling the GetIndex operation.

      Note

      The state can remain in the CREATING or UPDATING state for several hours as Resource Explorer discovers the information about your resources and populates the index.

Exceptions

create_view(**kwargs)

Creates a view that users can query by using the Search operation. Results from queries that you make using this view include only resources that match the view's Filters . For more information about Amazon Web Services Resource Explorer views, see Managing views in the Amazon Web Services Resource Explorer User Guide .

Only the principals with an IAM identity-based policy that grants Allow to the Search action on a Resource with the Amazon resource name (ARN) of this view can Search using views you create with this operation.

See also: AWS API Documentation

Request Syntax

response = client.create_view(
    ClientToken='string',
    Filters={
        'FilterString': 'string'
    },
    IncludedProperties=[
        {
            'Name': 'string'
        },
    ],
    Tags={
        'string': 'string'
    },
    ViewName='string'
)
Parameters
  • ClientToken (string) --

    This value helps ensure idempotency. Resource Explorer uses this value to prevent the accidental creation of duplicate versions. We recommend that you generate a UUID-type value to ensure the uniqueness of your views.

    This field is autopopulated if not provided.

  • Filters (dict) --

    An array of strings that specify which resources are included in the results of queries made using this view. When you use this view in a Search operation, the filter string is combined with the search's QueryString parameter using a logical AND operator.

    For information about the supported syntax, see Search query reference for Resource Explorer in the Amazon Web Services Resource Explorer User Guide .

    Warning

    This query string in the context of this operation supports only filter prefixes with optional operators. It doesn't support free-form text. For example, the string region:us* service:ec2 -tag:stage=prod includes all Amazon EC2 resources in any Amazon Web Services Region that begins with the letters us and is not tagged with a key Stage that has the value prod .

    • FilterString (string) -- [REQUIRED]

      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.

  • IncludedProperties (list) --

    Specifies optional fields that you want included in search results from this view. It is a list of objects that each describe a field to include.

    The default is an empty list, with no optional fields included in the results.

    • (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) -- [REQUIRED]

        The name of the property that is included in this view.

        You can specify the following property names for this field:

        • Tags
  • Tags (dict) --

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

    • (string) --
      • (string) --
  • ViewName (string) --

    [REQUIRED]

    The name of the new view. This name appears in the list of views in Resource Explorer.

    The name must be no more than 64 characters long, and can include letters, digits, and the dash (-) character. The name must be unique within its Amazon Web Services Region.

Return type

dict

Returns

Response Syntax

{
    'View': {
        'Filters': {
            'FilterString': 'string'
        },
        'IncludedProperties': [
            {
                'Name': 'string'
            },
        ],
        'LastUpdatedAt': datetime(2015, 1, 1),
        'Owner': 'string',
        'Scope': 'string',
        'ViewArn': 'string'
    }
}

Response Structure

  • (dict) --

    • View (dict) --

      A structure that contains the details about the new view.

      • 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.

      • 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
      • LastUpdatedAt (datetime) --

        The date and time when this view was last modified.

      • Owner (string) --

        The Amazon Web Services account that owns this view.

      • 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.

      • ViewArn (string) --

        The Amazon resource name (ARN) of the view.

Exceptions

delete_index(**kwargs)

Deletes the specified index and turns off Amazon Web Services Resource Explorer in the specified Amazon Web Services Region. When you delete an index, Resource Explorer stops discovering and indexing resources in that Region. Resource Explorer also deletes all views in that Region. These actions occur as asynchronous background tasks. You can check to see when the actions are complete by using the GetIndex operation and checking the Status response value.

Note

If the index you delete is the aggregator index for the Amazon Web Services account, you must wait 24 hours before you can promote another local index to be the aggregator index for the account. Users can't perform account-wide searches using Resource Explorer until another aggregator index is configured.

See also: AWS API Documentation

Request Syntax

response = client.delete_index(
    Arn='string'
)
Parameters
Arn (string) --

[REQUIRED]

The Amazon resource name (ARN) of the index that you want to delete.

Return type
dict
Returns
Response Syntax
{
    'Arn': 'string',
    'LastUpdatedAt': datetime(2015, 1, 1),
    'State': 'CREATING'|'ACTIVE'|'DELETING'|'DELETED'|'UPDATING'
}

Response Structure

  • (dict) --
    • Arn (string) --

      The Amazon resource name (ARN) of the index that you successfully started the deletion process.

      Note

      This operation is asynchronous. To check its status, call the GetIndex operation.

    • LastUpdatedAt (datetime) --

      The date and time when you last updated this index.

    • State (string) --

      Indicates the current state of the index.

Exceptions

delete_view(**kwargs)

Deletes the specified view.

If the specified view is the default view for its Amazon Web Services Region, then all Search operations in that Region must explicitly specify the view to use until you configure a new default by calling the AssociateDefaultView operation.

See also: AWS API Documentation

Request Syntax

response = client.delete_view(
    ViewArn='string'
)
Parameters
ViewArn (string) --

[REQUIRED]

The Amazon resource name (ARN) of the view that you want to delete.

Return type
dict
Returns
Response Syntax
{
    'ViewArn': 'string'
}

Response Structure

Exceptions

disassociate_default_view()

After you call this operation, the affected Amazon Web Services Region no longer has a default view. All Search operations in that Region must explicitly specify a view or the operation fails. You can configure a new default by calling the AssociateDefaultView operation.

If an Amazon Web Services Region doesn't have a default view configured, then users must explicitly specify a view with every Search operation performed in that Region.

See also: AWS API Documentation

Request Syntax

response = client.disassociate_default_view()
Returns
None

Exceptions

get_default_view()

Retrieves the Amazon Resource Name (ARN) of the view that is the default for the Amazon Web Services Region in which you call this operation. You can then call GetView to retrieve the details of that view.

See also: AWS API Documentation

Request Syntax

response = client.get_default_view()
Return type
dict
Returns
Response Syntax
{
    'ViewArn': 'string'
}

Response Structure

  • (dict) --
    • ViewArn (string) --

      The Amazon resource name (ARN) of the view that is the current default for the Amazon Web Services Region in which you called this operation.

Exceptions

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

get_paginator(operation_name)

Create a paginator for an operation.

Parameters
operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Raises OperationNotPageableError
Raised if the operation is not pageable. You can use the client.can_paginate method to check if an operation is pageable.
Return type
L{botocore.paginate.Paginator}
Returns
A paginator object.
get_view(**kwargs)

Retrieves details of the specified view.

See also: AWS API Documentation

Request Syntax

response = client.get_view(
    ViewArn='string'
)
Parameters
ViewArn (string) --

[REQUIRED]

The Amazon resource name (ARN) of the view that you want information about.

Return type
dict
Returns
Response Syntax
{
    'Tags': {
        'string': 'string'
    },
    'View': {
        'Filters': {
            'FilterString': 'string'
        },
        'IncludedProperties': [
            {
                'Name': 'string'
            },
        ],
        'LastUpdatedAt': datetime(2015, 1, 1),
        'Owner': 'string',
        'Scope': 'string',
        'ViewArn': 'string'
    }
}

Response Structure

  • (dict) --
    • Tags (dict) --

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

      • (string) --
        • (string) --
    • View (dict) --

      A structure that contains the details for the requested view.

      • 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.

      • 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
      • LastUpdatedAt (datetime) --

        The date and time when this view was last modified.

      • Owner (string) --

        The Amazon Web Services account that owns this view.

      • 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.

      • ViewArn (string) --

        The Amazon resource name (ARN) of the view.

Exceptions

get_waiter(waiter_name)

Returns an object that can wait for some condition.

Parameters
waiter_name (str) -- The name of the waiter to get. See the waiters section of the service docs for a list of available waiters.
Returns
The specified waiter object.
Return type
botocore.waiter.Waiter
list_indexes(**kwargs)

Retrieves a list of all of the indexes in Amazon Web Services Regions that are currently collecting resource information for Amazon Web Services Resource Explorer.

See also: AWS API Documentation

Request Syntax

response = client.list_indexes(
    MaxResults=123,
    NextToken='string',
    Regions=[
        'string',
    ],
    Type='LOCAL'|'AGGREGATOR'
)
Parameters
  • MaxResults (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

    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.

  • NextToken (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.
  • Regions (list) --

    If specified, limits the response to only information about the index in the specified list of Amazon Web Services Regions.

    • (string) --
  • Type (string) --

    If specified, limits the output to only indexes of the specified Type, either LOCAL or AGGREGATOR .

    Use this option to discover the aggregator index for your account.

Return type

dict

Returns

Response Syntax

{
    'Indexes': [
        {
            'Arn': 'string',
            'Region': 'string',
            'Type': 'LOCAL'|'AGGREGATOR'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • Indexes (list) --

      A structure that contains the details and status of each 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.

        • Arn (string) --

          The Amazon resource name (ARN) of the index.

        • Region (string) --

          The Amazon Web Services Region in which the index exists.

        • 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.
    • NextToken (string) --

      If present, indicates that more output is available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null .

Exceptions

list_supported_resource_types(**kwargs)

Retrieves a list of all resource types currently supported by Amazon Web Services Resource Explorer.

See also: AWS API Documentation

Request Syntax

response = client.list_supported_resource_types(
    MaxResults=123,
    NextToken='string'
)
Parameters
  • MaxResults (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

    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.

  • NextToken (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.
Return type

dict

Returns

Response Syntax

{
    'NextToken': 'string',
    'ResourceTypes': [
        {
            'ResourceType': 'string',
            'Service': 'string'
        },
    ]
}

Response Structure

  • (dict) --

    • NextToken (string) --

      If present, indicates that more output is available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null .

    • ResourceTypes (list) --

      The list of resource types supported by Resource Explorer.

      • (dict) --

        A structure that describes a resource type supported by Amazon Web Services Resource Explorer.

        • ResourceType (string) --

          The unique identifier of the resource type.

        • Service (string) --

          The Amazon Web Service that is associated with the resource type. This is the primary service that lets you create and interact with resources of this type.

Exceptions

list_tags_for_resource(**kwargs)

Lists the tags that are attached to the specified resource.

See also: AWS API Documentation

Request Syntax

response = client.list_tags_for_resource(
    resourceArn='string'
)
Parameters
resourceArn (string) --

[REQUIRED]

The Amazon resource name (ARN) of the view or index that you want to attach tags to.

Return type
dict
Returns
Response Syntax
{
    'Tags': {
        'string': 'string'
    }
}

Response Structure

  • (dict) --
    • Tags (dict) --

      The tag key and value pairs that you want to attach to the specified view or index.

      • (string) --
        • (string) --

Exceptions

list_views(**kwargs)

Lists the Amazon resource names (ARNs) of the views available in the Amazon Web Services Region in which you call this operation.

Note

Always check the NextToken response parameter for a null value when calling a paginated operation. These operations can occasionally return an empty set of results even when there are more results available. The NextToken response parameter value is null only when there are no more results to display.

See also: AWS API Documentation

Request Syntax

response = client.list_views(
    MaxResults=123,
    NextToken='string'
)
Parameters
  • MaxResults (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

    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.

  • NextToken (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.
Return type

dict

Returns

Response Syntax

{
    'NextToken': 'string',
    'Views': [
        'string',
    ]
}

Response Structure

  • (dict) --

    • NextToken (string) --

      If present, indicates that more output is available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null .

    • Views (list) --

      The list of views available in the Amazon Web Services Region in which you called this operation.

      • (string) --

Exceptions

search(**kwargs)

Searches for resources and displays details about all resources that match the specified criteria. You must specify a query string.

All search queries must use a view. If you don't explicitly specify a view, then Amazon Web Services Resource Explorer uses the default view for the Amazon Web Services Region in which you call this operation. The results are the logical intersection of the results that match both the QueryString parameter supplied to this operation and the SearchFilter parameter attached to the view.

For the complete syntax supported by the QueryString parameter, see Search query syntax reference for Resource Explorer.

If your search results are empty, or are missing results that you think should be there, see Troubleshooting Resource Explorer search.

See also: AWS API Documentation

Request Syntax

response = client.search(
    MaxResults=123,
    NextToken='string',
    QueryString='string',
    ViewArn='string'
)
Parameters
  • MaxResults (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

    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.

  • NextToken (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.
  • 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.
Return type

dict

Returns

Response Syntax

{
    'Count': {
        'Complete': True|False,
        'TotalResources': 123
    },
    'NextToken': 'string',
    '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.

    • NextToken (string) --

      If present, indicates that more output is available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null .

    • 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.

Exceptions

tag_resource(**kwargs)

Adds one or more tag key and value pairs to an Amazon Web Services Resource Explorer view or index.

See also: AWS API Documentation

Request Syntax

response = client.tag_resource(
    Tags={
        'string': 'string'
    },
    resourceArn='string'
)
Parameters
  • Tags (dict) --

    A list of tag key and value pairs that you want to attach to the specified view or index.

    • (string) --
      • (string) --
  • resourceArn (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) of the view or index that you want to attach tags to.

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

untag_resource(**kwargs)

Removes one or more tag key and value pairs from an Amazon Web Services Resource Explorer view or index.

See also: AWS API Documentation

Request Syntax

response = client.untag_resource(
    resourceArn='string',
    tagKeys=[
        'string',
    ]
)
Parameters
  • resourceArn (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) of the view or index that you want to remove tags from.

  • tagKeys (list) --

    [REQUIRED]

    A list of the keys for the tags that you want to remove from the specified view or index.

    • (string) --
Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

update_index_type(**kwargs)

Changes the type of the index from one of the following types to the other. For more information about indexes and the role they perform in Amazon Web Services Resource Explorer, see Turning on cross-Region search by creating an aggregator index in the Amazon Web Services Resource Explorer User Guide .

  • AGGREGATOR index type The index contains information about resources from all Amazon Web Services Regions in the Amazon Web Services account in which you've created a Resource Explorer index. Resource information from all other Regions is replicated to this Region's index. When you change the index type to AGGREGATOR , Resource Explorer turns on replication of all discovered resource information from the other Amazon Web Services Regions in your account to this index. You can then, from this Region only, perform resource search queries that span all Amazon Web Services Regions in the Amazon Web Services account. Turning on replication from all other Regions is performed by asynchronous background tasks. You can check the status of the asynchronous tasks by using the GetIndex operation. When the asynchronous tasks complete, the Status response of that operation changes from UPDATING to ACTIVE . After that, you can start to see results from other Amazon Web Services Regions in query results. However, it can take several hours for replication from all other Regions to complete.

Warning

You can have only one aggregator index per Amazon Web Services account. Before you can promote a different index to be the aggregator index for the account, you must first demote the existing aggregator index to type LOCAL .

  • LOCAL index type The index contains information about resources in only the Amazon Web Services Region in which the index exists. If an aggregator index in another Region exists, then information in this local index is replicated to the aggregator index. When you change the index type to LOCAL , Resource Explorer turns off the replication of resource information from all other Amazon Web Services Regions in the Amazon Web Services account to this Region. The aggregator index remains in the UPDATING state until all replication with other Regions successfully stops. You can check the status of the asynchronous task by using the GetIndex operation. When Resource Explorer successfully stops all replication with other Regions, the Status response of that operation changes from UPDATING to ACTIVE . Separately, the resource information from other Regions that was previously stored in the index is deleted within 30 days by another background task. Until that asynchronous task completes, some results from other Regions can continue to appear in search results.

Warning

After you demote an aggregator index to a local index, you must wait 24 hours before you can promote another index to be the new aggregator index for the account.

See also: AWS API Documentation

Request Syntax

response = client.update_index_type(
    Arn='string',
    Type='LOCAL'|'AGGREGATOR'
)
Parameters
  • Arn (string) --

    [REQUIRED]

    The Amazon resource name (ARN) of the index that you want to update.

  • Type (string) --

    [REQUIRED]

    The type of the index. To understand the difference between LOCAL and AGGREGATOR , see Turning on cross-Region search in the Amazon Web Services Resource Explorer User Guide .

Return type

dict

Returns

Response Syntax

{
    'Arn': 'string',
    'LastUpdatedAt': datetime(2015, 1, 1),
    'State': 'CREATING'|'ACTIVE'|'DELETING'|'DELETED'|'UPDATING',
    'Type': 'LOCAL'|'AGGREGATOR'
}

Response Structure

  • (dict) --

    • Arn (string) --

      The Amazon resource name (ARN) of the index that you updated.

    • LastUpdatedAt (datetime) --

      The date and timestamp when the index was last updated.

    • State (string) --

      Indicates the state of the request to update the index. This operation is asynchronous. Call the GetIndex operation to check for changes.

    • Type (string) --

      Specifies the type of the specified index after the operation completes.

Exceptions

update_view(**kwargs)

Modifies some of the details of a view. You can change the filter string and the list of included properties. You can't change the name of the view.

See also: AWS API Documentation

Request Syntax

response = client.update_view(
    Filters={
        'FilterString': 'string'
    },
    IncludedProperties=[
        {
            'Name': 'string'
        },
    ],
    ViewArn='string'
)
Parameters
  • Filters (dict) --

    An array of strings that specify which resources are included in the results of queries made using this view. When you use this view in a Search operation, the filter string is combined with the search's QueryString parameter using a logical AND operator.

    For information about the supported syntax, see Search query reference for Resource Explorer in the Amazon Web Services Resource Explorer User Guide .

    Warning

    This query string in the context of this operation supports only filter prefixes with optional operators. It doesn't support free-form text. For example, the string region:us* service:ec2 -tag:stage=prod includes all Amazon EC2 resources in any Amazon Web Services Region that begins with the letters us and is not tagged with a key Stage that has the value prod .

    • FilterString (string) -- [REQUIRED]

      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.

  • IncludedProperties (list) --

    Specifies optional fields that you want included in search results from this view. It is a list of objects that each describe a field to include.

    The default is an empty list, with no optional fields included in the results.

    • (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) -- [REQUIRED]

        The name of the property that is included in this view.

        You can specify the following property names for this field:

        • Tags
  • ViewArn (string) --

    [REQUIRED]

    The Amazon resource name (ARN) of the view that you want to modify.

Return type

dict

Returns

Response Syntax

{
    'View': {
        'Filters': {
            'FilterString': 'string'
        },
        'IncludedProperties': [
            {
                'Name': 'string'
            },
        ],
        'LastUpdatedAt': datetime(2015, 1, 1),
        'Owner': 'string',
        'Scope': 'string',
        'ViewArn': 'string'
    }
}

Response Structure

  • (dict) --

    • View (dict) --

      Details about the view that you changed with this operation.

      • 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.

      • 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
      • LastUpdatedAt (datetime) --

        The date and time when this view was last modified.

      • Owner (string) --

        The Amazon Web Services account that owns this view.

      • 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.

      • ViewArn (string) --

        The Amazon resource name (ARN) of the view.

Exceptions

Client Exceptions

Client exceptions are available on a client instance via the exceptions property. For more detailed instructions and examples on the exact usage of client exceptions, see the error handling user guide.

The available client exceptions are:

class ResourceExplorer.Client.exceptions.AccessDeniedException

The credentials that you used to call this operation don't have the minimum required permissions.

Example

try:
  ...
except client.exceptions.AccessDeniedException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The credentials that you used to call this operation don't have the minimum required permissions.

    • Message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class ResourceExplorer.Client.exceptions.ConflictException

You tried to create a new view or index when one already exists, and you either didn't specify or specified a different idempotency token as the original request.

Example

try:
  ...
except client.exceptions.ConflictException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    You tried to create a new view or index when one already exists, and you either didn't specify or specified a different idempotency token as the original request.

    • Message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class ResourceExplorer.Client.exceptions.InternalServerException

The request failed because of internal service error. Try your request again later.

Example

try:
  ...
except client.exceptions.InternalServerException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The request failed because of internal service error. Try your request again later.

    • Message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class ResourceExplorer.Client.exceptions.ResourceNotFoundException

You specified a resource that doesn't exist. Check the ID or ARN that you used to identity the resource, and try again.

Example

try:
  ...
except client.exceptions.ResourceNotFoundException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    You specified a resource that doesn't exist. Check the ID or ARN that you used to identity the resource, and try again.

    • Message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class ResourceExplorer.Client.exceptions.ServiceQuotaExceededException

The request failed because it exceeds a service quota.

Example

try:
  ...
except client.exceptions.ServiceQuotaExceededException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Name': 'string',
    'Value': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The request failed because it exceeds a service quota.

    • Message (string) --

    • Name (string) --

      The name of the service quota that was exceeded by the request.

    • Value (string) --

      The current value for the quota that the request tried to exceed.

    • Error (dict) -- Normalized access to common exception attributes.

      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class ResourceExplorer.Client.exceptions.ThrottlingException

The request failed because you exceeded a rate limit for this operation. For more information, see Quotas for Resource Explorer.

Example

try:
  ...
except client.exceptions.ThrottlingException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The request failed because you exceeded a rate limit for this operation. For more information, see Quotas for Resource Explorer.

    • Message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class ResourceExplorer.Client.exceptions.UnauthorizedException

The principal making the request isn't permitted to perform the operation.

Example

try:
  ...
except client.exceptions.UnauthorizedException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The principal making the request isn't permitted to perform the operation.

    • Message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class ResourceExplorer.Client.exceptions.ValidationException

You provided an invalid value for one of the operation's parameters. Check the syntax for the operation, and try again.

Example

try:
  ...
except client.exceptions.ValidationException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'FieldList': [
        {
            'Name': 'string',
            'ValidationIssue': 'string'
        },
    ],
    'Message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    You provided an invalid value for one of the operation's parameters. Check the syntax for the operation, and try again.

    • FieldList (list) --

      An array of the request fields that had validation errors.

      • (dict) --

        A structure that describes a request field with a validation error.

        • Name (string) --

          The name of the request field that had a validation error.

        • ValidationIssue (string) --

          The validation error caused by the request field.

    • Message (string) --

    • Error (dict) -- Normalized access to common exception attributes.

      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.

Paginators

The available paginators are:

class ResourceExplorer.Paginator.ListIndexes
paginator = client.get_paginator('list_indexes')
paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    Regions=[
        'string',
    ],
    Type='LOCAL'|'AGGREGATOR',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • Regions (list) --

    If specified, limits the response to only information about the index in the specified list of Amazon Web Services Regions.

    • (string) --
  • Type (string) --

    If specified, limits the output to only indexes of the specified Type, either LOCAL or AGGREGATOR .

    Use this option to discover the aggregator index for your account.

  • 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

{
    'Indexes': [
        {
            'Arn': 'string',
            'Region': 'string',
            'Type': 'LOCAL'|'AGGREGATOR'
        },
    ],

}

Response Structure

  • (dict) --

    • Indexes (list) --

      A structure that contains the details and status of each 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.

        • Arn (string) --

          The Amazon resource name (ARN) of the index.

        • Region (string) --

          The Amazon Web Services Region in which the index exists.

        • 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.

class ResourceExplorer.Paginator.ListSupportedResourceTypes
paginator = client.get_paginator('list_supported_resource_types')
paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
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
{
    'ResourceTypes': [
        {
            'ResourceType': 'string',
            'Service': 'string'
        },
    ]
}

Response Structure

  • (dict) --
    • ResourceTypes (list) --

      The list of resource types supported by Resource Explorer.

      • (dict) --

        A structure that describes a resource type supported by Amazon Web Services Resource Explorer.

        • ResourceType (string) --

          The unique identifier of the resource type.

        • Service (string) --

          The Amazon Web Service that is associated with the resource type. This is the primary service that lets you create and interact with resources of this type.

class ResourceExplorer.Paginator.ListViews
paginator = client.get_paginator('list_views')
paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
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
{
    'Views': [
        'string',
    ]
}

Response Structure

  • (dict) --
    • Views (list) --

      The list of views available in the Amazon Web Services Region in which you called this operation.

      • (string) --
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.