PartnerCentralSellingAPI / Client / list_resource_snapshots

list_resource_snapshots#

PartnerCentralSellingAPI.Client.list_resource_snapshots(**kwargs)#

Retrieves a list of resource view snapshots based on specified criteria. This operation supports various use cases, including:

  • Fetching all snapshots associated with an engagement.

  • Retrieving snapshots of a specific resource type within an engagement.

  • Obtaining snapshots for a particular resource using a specified template.

  • Accessing the latest snapshot of a resource within an engagement.

  • Filtering snapshots by resource owner.

See also: AWS API Documentation

Request Syntax

response = client.list_resource_snapshots(
    Catalog='string',
    CreatedBy='string',
    EngagementIdentifier='string',
    MaxResults=123,
    NextToken='string',
    ResourceIdentifier='string',
    ResourceSnapshotTemplateIdentifier='string',
    ResourceType='Opportunity'
)
Parameters:

  • Catalog (string) –

    [REQUIRED]

    Specifies the catalog related to the request.

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

  • EngagementIdentifier (string) –

    [REQUIRED]

    The unique identifier of the engagement associated with the snapshots.

  • MaxResults (integer) – The maximum number of results to return in a single call.

  • NextToken (string) – The token for the next set of results.

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

Return type:

dict

Returns:

Response Syntax

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

Response Structure

  • (dict) –

    • NextToken (string) –

      The token to retrieve the next set of results. If there are no additional results, this value is null.

    • 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 entity that owns the resource from which the snapshot was created.

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

Exceptions

  • PartnerCentralSellingAPI.Client.exceptions.ThrottlingException

  • PartnerCentralSellingAPI.Client.exceptions.AccessDeniedException

  • PartnerCentralSellingAPI.Client.exceptions.ValidationException

  • PartnerCentralSellingAPI.Client.exceptions.ResourceNotFoundException