ListResourceSnapshotJobs - AWS Partner Central

ListResourceSnapshotJobs

Lists resource snapshot jobs owned by the customer. This operation supports various filtering scenarios, including listing all jobs owned by the caller, jobs for a specific engagement, jobs with a specific status, or any combination of these filters.

Request Syntax

{ "Catalog": "string", "EngagementIdentifier": "string", "MaxResults": number, "NextToken": "string", "Sort": { "SortBy": "string", "SortOrder": "string" }, "Status": "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 identifier of the engagement to filter the response.

Type: String

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

Required: No

MaxResults

The maximum number of results to return in a single call. If omitted, defaults to 50.

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

Sort

Configures the sorting of the response. If omitted, results are sorted by CreatedDate in descending order.

Type: SortObject object

Required: No

Status

The status of the jobs to filter the response.

Type: String

Valid Values: Running | Stopped

Required: No

Response Syntax

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

ResourceSnapshotJobSummaries

An array of resource snapshot job summary objects.

Type: Array of ResourceSnapshotJobSummary 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: