ListJobs - AWS Data Exchange

ListJobs

This operation lists your jobs sorted by CreatedAt in descending order.

Request Syntax

GET /v1/jobs?dataSetId=DataSetId&maxResults=MaxResults&nextToken=NextToken&revisionId=RevisionId HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

DataSetId

The unique identifier for a data set.

MaxResults

The maximum number of results returned by a single call.

Valid Range: Minimum value of 1. Maximum value of 25.

NextToken

The token value retrieved from a previous call to access the next page of results.

RevisionId

The unique identifier for a revision.

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "Jobs": [ { "Arn": "string", "CreatedAt": number, "Details": { "ExportAssetsToS3": { "AssetDestinations": [ { "AssetId": "string", "Bucket": "string", "Key": "string" } ], "DataSetId": "string", "Encryption": { "KmsKeyArn": "string", "Type": "string" }, "RevisionId": "string" }, "ExportAssetToSignedUrl": { "AssetId": "string", "DataSetId": "string", "RevisionId": "string", "SignedUrl": "string", "SignedUrlExpiresAt": number }, "ExportRevisionsToS3": { "DataSetId": "string", "Encryption": { "KmsKeyArn": "string", "Type": "string" }, "EventActionArn": "string", "RevisionDestinations": [ { "Bucket": "string", "KeyPattern": "string", "RevisionId": "string" } ] }, "ImportAssetFromApiGatewayApi": { "ApiDescription": "string", "ApiId": "string", "ApiKey": "string", "ApiName": "string", "ApiSpecificationMd5Hash": "string", "ApiSpecificationUploadUrl": "string", "ApiSpecificationUploadUrlExpiresAt": number, "DataSetId": "string", "ProtocolType": "string", "RevisionId": "string", "Stage": "string" }, "ImportAssetFromSignedUrl": { "AssetName": "string", "DataSetId": "string", "Md5Hash": "string", "RevisionId": "string", "SignedUrl": "string", "SignedUrlExpiresAt": number }, "ImportAssetsFromRedshiftDataShares": { "AssetSources": [ { "DataShareArn": "string" } ], "DataSetId": "string", "RevisionId": "string" }, "ImportAssetsFromS3": { "AssetSources": [ { "Bucket": "string", "Key": "string" } ], "DataSetId": "string", "RevisionId": "string" } }, "Errors": [ { "Code": "string", "Details": { "ImportAssetFromSignedUrlJobErrorDetails": { "AssetName": "string" }, "ImportAssetsFromS3JobErrorDetails": [ { "Bucket": "string", "Key": "string" } ] }, "LimitName": "string", "LimitValue": number, "Message": "string", "ResourceId": "string", "ResourceType": "string" } ], "Id": "string", "State": "string", "Type": "string", "UpdatedAt": number } ], "NextToken": "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.

Jobs

The jobs listed by the request.

Type: Array of JobEntry objects

NextToken

The token value retrieved from a previous call to access the next page of results.

Type: String

Errors

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

InternalServerException

An exception occurred with the service.

HTTP Status Code: 500

ResourceNotFoundException

The resource couldn't be found.

HTTP Status Code: 404

ThrottlingException

The limit on the number of requests per second was exceeded.

HTTP Status Code: 429

ValidationException

The request was invalid.

HTTP Status Code: 400

See Also

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