GetResourceSnapshotJob - AWS Partner Central

GetResourceSnapshotJob

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

Request Syntax

{ "Catalog": "string", "ResourceSnapshotJobIdentifier": "string" }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

Note

In the following list, the required parameters are described first.

Catalog

Specifies the catalog related to the request. Valid values are:

  • AWS: Retrieves the snapshot job from the production AWS environment.

  • Sandbox: Retrieves the snapshot job from a sandbox environment used for testing or development purposes.

Type: String

Pattern: ^[a-zA-Z]+$

Required: Yes

ResourceSnapshotJobIdentifier

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

Type: String

Pattern: ^job-[0-9a-z]{13}$

Required: Yes

Response Syntax

{ "Arn": "string", "Catalog": "string", "CreatedAt": "string", "EngagementId": "string", "Id": "string", "LastFailure": "string", "LastSuccessfulExecutionDate": "string", "ResourceArn": "string", "ResourceId": "string", "ResourceSnapshotTemplateName": "string", "ResourceType": "string", "Status": "string" }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Catalog

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

Type: String

Pattern: ^[a-zA-Z]+$

Arn

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

Type: String

Pattern: ^arn:.*

CreatedAt

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

Type: Timestamp

EngagementId

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

Type: String

Pattern: ^eng-[0-9a-z]{14}$

Id

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

Type: String

Pattern: ^job-[0-9a-z]{13}$

LastFailure

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.

Type: String

LastSuccessfulExecutionDate

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

Type: Timestamp

ResourceArn

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

Type: String

Pattern: ^arn:.*

ResourceId

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

Type: String

Pattern: ^O[0-9]{1,19}$

ResourceSnapshotTemplateName

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.

Type: String

Pattern: ^[a-zA-Z0-9]{3,80}$

ResourceType

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

Type: String

Valid Values: Opportunity

Status

The current status of the snapshot job. Valid values:

  • STOPPED: The job is not currently running.

  • RUNNING: The job is actively executing.

Type: String

Valid Values: Running | Stopped

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

This error occurs when you don't have permission to perform the requested action.

You don’t have access to this action or resource. Review IAM policies or contact your AWS administrator for assistance.

HTTP Status Code: 400

ResourceNotFoundException

This error occurs when the specified resource can't be found. The resource might not exist, or isn't visible with the current credentials.

Suggested action: Verify that the resource ID is correct and the resource is in the expected AWS region. Check IAM permissions for accessing the resource.

HTTP Status Code: 400

ThrottlingException

This error occurs when there are too many requests sent. Review the provided quotas and adapt your usage to avoid throttling.

This error occurs when there are too many requests sent. Review the provided Quotas and retry after the provided delay.

HTTP Status Code: 400

ValidationException

The input fails to satisfy the constraints specified by the service or business validation rules.

Suggested action: Review the error message, including the failed fields and reasons, to correct the request payload.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: