v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1445428373.9 KB

Use this action to retrieves information about a specific resource snapshot job.

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

Headers

X-Amz-Target'AWSPartnerCentralSelling.GetResourceSnapshotJob' required

Request body

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

The unique identifier of the resource snapshot job to be retrieved. This identifier is crucial for pinpointing the specific job you want to query.

Response

Success

Catalogstring required

The catalog in which the snapshot job was created. This will match the Catalog specified in the request.

Idstring

The unique identifier of the snapshot job. This matches the ResourceSnapshotJobIdentifier provided in the request.

Arnstring

The Amazon Resource Name (ARN) of the snapshot job. This globally unique identifier can be used for resource-specific operations across AWS services.

EngagementIdstring

The identifier of the engagement associated with this snapshot job. This links the job to a specific engagement context.

ResourceType'Opportunity'

The type of resource being snapshotted. This would have "Opportunity" as a value as it is dependent on the supported resource type.

ResourceIdstring

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

ResourceArnstring

The Amazon Resource Name (ARN) of the resource being snapshotted. This provides a globally unique identifier for the resource across AWS.

ResourceSnapshotTemplateNamestring

The name of the template used for creating the snapshot. This is the same as the template name. It defines the structure and content of the snapshot.

CreatedAtstring date-time

The date and time when the snapshot job was created in ISO 8601 format (UTC). Example: "2023-05-01T20:37:46Z"

Status'Running' | 'Stopped'
<p>The current status of the snapshot job. Valid values:</p> <ul> <li> <p>STOPPED: The job is not currently running.</p> </li> <li> <p>RUNNING: The job is actively executing.</p> </li> </ul>
LastSuccessfulExecutionDatestring date-time

The date and time of the last successful execution of the job, in ISO 8601 format (UTC). Example: "2023-05-01T20:37:46Z"

LastFailurestring

If the job has encountered any failures, this field contains the error message from the most recent failure. This can be useful for troubleshooting issues with the job.