v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1445428373.9 KB

Use this action to retrieve a specific snapshot record.

post/#X-Amz-Target=AWSPartnerCentralSelling.GetResourceSnapshot

Headers

X-Amz-Target'AWSPartnerCentralSelling.GetResourceSnapshot' required

Request body

Catalogstring required
<p>Specifies the catalog related to the request. Valid values are:</p> <ul> <li> <p>AWS: Retrieves the snapshot from the production AWS environment.</p> </li> <li> <p>Sandbox: Retrieves the snapshot from a sandbox environment used for testing or development purposes.</p> </li> </ul>
EngagementIdentifierstring required

The unique identifier of the engagement associated with the snapshot. This field links the snapshot to a specific engagement context.

ResourceType'Opportunity' required

Specifies the type of resource that was snapshotted. This field determines the structure and content of the snapshot payload. Valid value includes:<code>Opportunity</code>: For opportunity-related data.

ResourceIdentifierstring required

The unique identifier of the specific resource that was snapshotted. The format and constraints of this identifier depend on the ResourceType specified. For <code>Opportunity</code> type, it will be an <code>opportunity ID</code>

ResourceSnapshotTemplateIdentifierstring required

he name of the template that defines the schema for the snapshot. This template determines which subset of the resource data is included in the snapshot and must correspond to an existing and valid template for the specified <code>ResourceType</code>.

Revisioninteger

Specifies which revision of the snapshot to retrieve. If omitted returns the latest revision.

Response

Success

Catalogstring required

The catalog in which the snapshot was created. Matches the Catalog specified in the request.

Arnstring

The Amazon Resource Name (ARN) that uniquely identifies the resource snapshot.

CreatedBystring password

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

CreatedAtstring date-time

The timestamp when the snapshot was created, in ISO 8601 format (e.g., "2023-06-01T14:30:00Z"). This allows for precise tracking of when the snapshot was taken.

EngagementIdstring

The identifier of the engagement associated with this snapshot. Matches the EngagementIdentifier specified in the request.

ResourceType'Opportunity'

The type of the resource that was snapshotted. Matches the ResourceType specified in the request.

ResourceIdstring

The identifier of the specific resource that was snapshotted. Matches the ResourceIdentifier specified in the request.

ResourceSnapshotTemplateNamestring

The name of the view used for this snapshot. This is the same as the template name.

Revisioninteger

The revision number of this snapshot. This is a positive integer that is sequential and unique within the context of a resource view.

TargetMemberAccountsAwsAccount[]

Target member accounts associated with the resource snapshot.