ResourceExplorer / Paginator / ListResources

ListResources

class ResourceExplorer.Paginator.ListResources

paginator = client.get_paginator('list_resources')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

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

Parameters:

• Filters (dict) –

  A search filter defines which resources can be part of a search query result set.

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

• 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

{
    '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) –

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