Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

CreateResourceSnapshotJob

Use this action to create a job to generate a snapshot of the specified resource within an engagement. It initiates an asynchronous process to create a resource snapshot. The job creates a new snapshot only if the resource state has changed, adhering to the same access control and immutability rules as direct snapshot creation.

Request Syntax


{
   "Catalog": "string",
   "ClientToken": "string",
   "EngagementIdentifier": "string",
   "ResourceIdentifier": "string",
   "ResourceSnapshotTemplateIdentifier": "string",
   "ResourceType": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "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 in which to create the snapshot job. Valid values are AWS and Sandbox.

Type: String

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

Required: Yes

ClientToken

A client-generated UUID used for idempotency check. The token helps prevent duplicate job creations.

Type: String

Pattern: ^[!-~]{1,64}$

Required: Yes

EngagementIdentifier

Specifies the identifier of the engagement associated with the resource to be snapshotted.

Type: String

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

Required: Yes

ResourceIdentifier

Specifies the identifier of the specific resource to be snapshotted. The format depends on the ResourceType.

Type: String

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

Required: Yes

ResourceSnapshotTemplateIdentifier

Specifies the name of the template that defines the schema for the snapshot.

Type: String

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

Required: Yes

ResourceType

The type of resource for which the snapshot job is being created. Must be one of the supported resource types i.e. Opportunity

Type: String

Valid Values: Opportunity

Required: Yes

Tags

A map of the key-value pairs of the tag or tags to assign.

Type: Array of Tag objects

Array Members: Minimum number of 1 item. Maximum number of 200 items.

Required: No

Response Syntax


{
   "Arn": "string",
   "Id": "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.

Arn

The Amazon Resource Name (ARN) of the created snapshot job.

Type: String

Pattern: ^arn:.*

Id

The unique identifier for the created snapshot job.

Type: String

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

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

ConflictException

This error occurs when the request can’t be processed due to a conflict with the target resource's current state, which could result from updating or deleting the resource.

Suggested action: Fetch the latest state of the resource, verify the state, and retry the request.

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

ServiceQuotaExceededException

This error occurs when the request would cause a service quota to be exceeded. Service quotas represent the maximum allowed use of a specific resource, and this error indicates that the request would surpass that limit.

Suggested action: Review the Quotas for the resource, and either reduce usage or request a quota increase.

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