PartnerCentralSellingAPI / Paginator / ListResourceSnapshots

ListResourceSnapshots

class PartnerCentralSellingAPI.Paginator.ListResourceSnapshots

paginator = client.get_paginator('list_resource_snapshots')

paginate(**kwargs)

Creates an iterator that will paginate through responses from PartnerCentralSellingAPI.Client.list_resource_snapshots().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    Catalog='string',
    CreatedBy='string',
    EngagementIdentifier='string',
    ResourceIdentifier='string',
    ResourceSnapshotTemplateIdentifier='string',
    ResourceType='Opportunity',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• Catalog (string) –

  [REQUIRED]

  Specifies the catalog related to the request.

• CreatedBy (string) – Filters the response to include only snapshots of resources created by the specified AWS account.

• EngagementIdentifier (string) –

  [REQUIRED]

  The unique identifier of the engagement associated with the snapshots.

• ResourceIdentifier (string) – Filters the response to include only snapshots of the specified resource.

• ResourceSnapshotTemplateIdentifier (string) – Filters the response to include only snapshots created using the specified template.

• ResourceType (string) – Filters the response to include only snapshots of the specified resource type.

• 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

{
    'ResourceSnapshotSummaries': [
        {
            'Arn': 'string',
            'CreatedBy': 'string',
            'ResourceId': 'string',
            'ResourceSnapshotTemplateName': 'string',
            'ResourceType': 'Opportunity',
            'Revision': 123
        },
    ]
}

Response Structure

• (dict) –

  • ResourceSnapshotSummaries (list) –

    An array of resource snapshot summary objects.

    • (dict) –

      Provides a concise summary of a resource snapshot, including its unique identifier and version information. This structure is used to quickly reference and identify specific versions of resource snapshots.

      • Arn (string) –

        The Amazon Resource Name (ARN) of the snapshot. This globally unique identifier can be used for cross-service references and in IAM policies.

      • CreatedBy (string) –

        The AWS account ID of the principal (user or role) who created the snapshot. This helps in tracking the origin of the snapshot.

      • ResourceId (string) –

        The identifier of the specific resource snapshotted. The format might vary depending on the ResourceType.

      • ResourceSnapshotTemplateName (string) –

        The name of the template used to create the snapshot.

      • ResourceType (string) –

        The type of resource snapshotted.

      • Revision (integer) –

        The revision number of the snapshot. This integer value is incremented each time the snapshot is updated, allowing for version tracking of the resource snapshot.