GetResourceSnapshot
Use this action to retrieve a specific snapshot record.
Request Syntax
{
"Catalog": "string
",
"EngagementIdentifier": "string
",
"ResourceIdentifier": "string
",
"ResourceSnapshotTemplateIdentifier": "string
",
"ResourceType": "string
",
"Revision": number
}
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 from the production AWS environment.
-
Sandbox: Retrieves the snapshot from a sandbox environment used for testing or development purposes.
Type: String
Pattern:
^[a-zA-Z]+$
Required: Yes
-
- EngagementIdentifier
-
The unique identifier of the engagement associated with the snapshot. This field links the snapshot to a specific engagement context.
Type: String
Pattern:
^eng-[0-9a-z]{14}$
Required: Yes
- ResourceIdentifier
-
The unique identifier of the specific resource that was snapshotted. The format and constraints of this identifier depend on the ResourceType specified. For
Opportunity
type, it will be anopportunity ID
Type: String
Pattern:
^O[0-9]{1,19}$
Required: Yes
- ResourceSnapshotTemplateIdentifier
-
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
ResourceType
.Type: String
Pattern:
^[a-zA-Z0-9]{3,80}$
Required: Yes
- ResourceType
-
Specifies the type of resource that was snapshotted. This field determines the structure and content of the snapshot payload. Valid value includes:
Opportunity
: For opportunity-related data.Type: String
Valid Values:
Opportunity
Required: Yes
- Revision
-
Specifies which revision of the snapshot to retrieve. If omitted returns the latest revision.
Type: Integer
Valid Range: Minimum value of 1.
Required: No
Response Syntax
{
"Arn": "string",
"Catalog": "string",
"CreatedAt": "string",
"CreatedBy": "string",
"EngagementId": "string",
"Payload": { ... },
"ResourceId": "string",
"ResourceSnapshotTemplateName": "string",
"ResourceType": "string",
"Revision": number
}
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 was created. Matches the Catalog specified in the request.
Type: String
Pattern:
^[a-zA-Z]+$
- Arn
-
The Amazon Resource Name (ARN) that uniquely identifies the resource snapshot.
Type: String
Pattern:
^arn:.*
- CreatedAt
-
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.
Type: Timestamp
- CreatedBy
-
The AWS account ID of the principal (user or role) who created the snapshot. This helps in tracking the origin of the snapshot.
Type: String
Pattern:
^([0-9]{12}|\w{1,12})$
- EngagementId
-
The identifier of the engagement associated with this snapshot. Matches the EngagementIdentifier specified in the request.
Type: String
Pattern:
^eng-[0-9a-z]{14}$
- Payload
-
Represents the payload of a resource snapshot. This structure is designed to accommodate different types of resource snapshots, currently supporting opportunity summaries.
Type: ResourceSnapshotPayload object
Note: This object is a Union. Only one member of this object can be specified or returned.
- ResourceId
-
The identifier of the specific resource that was snapshotted. Matches the ResourceIdentifier specified in the request.
Type: String
Pattern:
^O[0-9]{1,19}$
- ResourceSnapshotTemplateName
-
The name of the view used for this snapshot. This is the same as the template name.
Type: String
Pattern:
^[a-zA-Z0-9]{3,80}$
- ResourceType
-
The type of the resource that was snapshotted. Matches the ResourceType specified in the request.
Type: String
Valid Values:
Opportunity
- Revision
-
The revision number of this snapshot. This is a positive integer that is sequential and unique within the context of a resource view.
Type: Integer
Valid Range: Minimum value of 1.
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: