ListResourceSnapshots
Retrieves a list of resource view snapshots based on specified criteria. This operation supports various use cases, including:
-
Fetching all snapshots associated with an engagement.
-
Retrieving snapshots of a specific resource type within an engagement.
-
Obtaining snapshots for a particular resource using a specified template.
-
Accessing the latest snapshot of a resource within an engagement.
-
Filtering snapshots by resource owner.
Request Syntax
{
"Catalog": "string
",
"CreatedBy": "string
",
"EngagementIdentifier": "string
",
"MaxResults": number
,
"NextToken": "string
",
"ResourceIdentifier": "string
",
"ResourceSnapshotTemplateIdentifier": "string
",
"ResourceType": "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.
Type: String
Pattern:
^[a-zA-Z]+$
Required: Yes
- EngagementIdentifier
-
The unique identifier of the engagement associated with the snapshots.
Type: String
Pattern:
^eng-[0-9a-z]{14}$
Required: Yes
- CreatedBy
-
Filters the response to include only snapshots of resources owned by the specified AWS account.
Type: String
Pattern:
^([0-9]{12}|\w{1,12})$
Required: No
- MaxResults
-
The maximum number of results to return in a single call.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 1000.
Required: No
- NextToken
-
The token for the next set of results.
Type: String
Required: No
- ResourceIdentifier
-
Filters the response to include only snapshots of the specified resource.
Type: String
Pattern:
^O[0-9]{1,19}$
Required: No
- ResourceSnapshotTemplateIdentifier
-
Filters the response to include only snapshots created using the specified template.
Type: String
Pattern:
^[a-zA-Z0-9]{3,80}$
Required: No
- ResourceType
-
Filters the response to include only snapshots of the specified resource type.
Type: String
Valid Values:
Opportunity
Required: No
Response Syntax
{
"NextToken": "string",
"ResourceSnapshotSummaries": [
{
"Arn": "string",
"CreatedBy": "string",
"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.
- ResourceSnapshotSummaries
-
An array of resource snapshot summary objects.
Type: Array of ResourceSnapshotSummary objects
- NextToken
-
The token to retrieve the next set of results. If there are no additional results, this value is null.
Type: String
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: