Job - AWS Data Exchange

Job

AWS Data Exchange jobs are asynchronous import or export operations used to create or copy assets. A data set owner can both import and export as they see fit. Someone with an entitlement to a data set can only export. Jobs are deleted 90 days after they are created.

This section defines the GetJob, CancelJob, and StartJob operations.

URI

/v1/jobs/JobId

HTTP Methods

GET

Operation ID: GetJob

This operation returns information about a job.

Path Parameters
Name Type Required Description
JobId String True

The unique identifier for a job.

Responses
Status Code Response Model Description
200 Job

200 response

400 ValidationException

400 response

404 ResourceNotFoundException

404 response

429 ThrottlingException

429 response

500 InternalServerException

500 response

DELETE

Operation ID: CancelJob

This operation cancels a job. Jobs can be cancelled only when they are in the WAITING state.

Path Parameters
Name Type Required Description
JobId String True

The unique identifier for a job.

Responses
Status Code Response Model Description
204 None

204 response

400 ValidationException

400 response

404 ResourceNotFoundException

404 response

409 ConflictException

409 response

429 ThrottlingException

429 response

500 InternalServerException

500 response

PATCH

Operation ID: StartJob

This operation starts a job.

Path Parameters
Name Type Required Description
JobId String True

The unique identifier for a job.

Responses
Status Code Response Model Description
202 None

202 response

400 ValidationException

400 response

403 AccessDeniedException

403 response

404 ResourceNotFoundException

404 response

409 ConflictException

409 response

429 ThrottlingException

429 response

500 InternalServerException

500 response

Schemas

Response Bodies

Example Job

{ "Errors": [ { "Details": { }, "Message": "string", "ResourceId": "string", "ResourceType": enum, "Code": enum, "LimitName": enum, "LimitValue": number } ], "Type": enum, "Details": { "ImportAssetFromSignedUrl": { "SignedUrl": "string", "DataSetId": "string", "Md5Hash": "string", "RevisionId": "string", "AssetName": "string", "SignedUrlExpiresAt": "string" }, "ExportAssetToSignedUrl": { "SignedUrl": "string", "DataSetId": "string", "AssetId": "string", "RevisionId": "string", "SignedUrlExpiresAt": "string" }, "ImportAssetsFromS3": { "AssetSources": [ { "Bucket": "string", "Key": "string" } ], "DataSetId": "string", "RevisionId": "string" }, "ExportAssetsToS3": { "AssetDestinations": [ { "Bucket": "string", "AssetId": "string", "Key": "string" } ], "DataSetId": "string", "Encryption": { "Type": enum, "KmsKeyArn": "string" }, "RevisionId": "string" } }, "State": enum, "CreatedAt": "string", "Id": "string", "Arn": "string", "UpdatedAt": "string" }

Example ValidationException

{ "Message": "string" }

Example AccessDeniedException

{ "Message": "string" }

Example ResourceNotFoundException

{ "Message": "string", "ResourceId": "string", "ResourceType": enum }

Example ConflictException

{ "Message": "string", "ResourceId": "string", "ResourceType": enum }

Example ThrottlingException

{ "Message": "string" }

Example InternalServerException

{ "Message": "string" }

Properties

AccessDeniedException

Access to the resource is denied.

Property Type Required Description
Message

string

True

Access to the resource is denied.

AssetDestinationEntry

The destination for the asset.

Property Type Required Description
Bucket

string

True

The S3 bucket that is the destination for the asset.

AssetId

string

True

The unique identifier for the asset.

Key

string

False

The name of the object in Amazon S3 for the asset.

AssetSourceEntry

The source of the assets.

Property Type Required Description
Bucket

string

True

The S3 bucket that's part of the source of the asset.

Key

string

True

The name of the object in Amazon S3 for the asset.

ConflictException

The request couldn't be completed because it conflicted with the current state of the resource.

Property Type Required Description
Message

string

True

The request couldn't be completed because it conflicted with the current state of the resource.

ResourceId

string

False

The unique identifier for the resource with the conflict.

ResourceType

string

Values: DATA_SET | REVISION | ASSET | JOB

False

The type of the resource with the conflict.

ExportAssetToSignedUrlResponseDetails

The details of the export to signed URL response.

Property Type Required Description
SignedUrl

string

False

The signed URL for the export request.

DataSetId

string

True

The unique identifier for the data set associated with this export job.

AssetId

string

True

The unique identifier for the asset associated with this export job.

RevisionId

string

True

The unique identifier for the revision associated with this export response.

SignedUrlExpiresAt

string

False

The date and time that the signed URL expires, in ISO 8601 format.

ExportAssetsToS3ResponseDetails

Details about the export to Amazon S3 response.

Property Type Required Description
AssetDestinations

Array of type AssetDestinationEntry

True

The destination in Amazon S3 where the asset is exported.

DataSetId

string

True

The unique identifier for the data set associated with this export job.

Encryption

ExportServerSideEncryption

False

Encryption configuration of the export job.

RevisionId

string

True

The unique identifier for the revision associated with this export response.

ExportServerSideEncryption

Encryption configuration of the export job. Includes the encryption type as well as the AWS KMS key. The KMS key is only necessary if you chose the KMS encryption type.

Property Type Required Description
Type

ServerSideEncryptionTypes

True

The type of server side encryption used for encrypting the objects in Amazon S3.

KmsKeyArn

string

True

The Amazon Resource Name (ARN) of the the AWS KMS key you want to use to encrypt the Amazon S3 objects. This parameter is required if you choose aws:kms as an encryption type.

ImportAssetFromSignedUrlResponseDetails

The details in the response for an import request, including the signed URL and other information.

Property Type Required Description
SignedUrl

string

False

The signed URL.

DataSetId

string

True

The unique identifier for the data set associated with this import job.

Md5Hash

string

Pattern: /^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$/

MinLength: 24

MaxLength: 24

False

The Base64-encoded Md5 hash for the asset, used to ensure the integrity of the file at that location.

RevisionId

string

True

The unique identifier for the revision associated with this import response.

AssetName

string

True

The name for the asset associated with this import response.

SignedUrlExpiresAt

string

False

The time and date at which the signed URL expires, in ISO 8601 format.

ImportAssetsFromS3ResponseDetails

Details from an import from Amazon S3 response.

Property Type Required Description
AssetSources

Array of type AssetSourceEntry

True

Is a list of Amazon S3 bucket and object key pairs.

DataSetId

string

True

The unique identifier for the data set associated with this import job.

RevisionId

string

True

The unique identifier for the revision associated with this import response.

InternalServerException

An exception occurred with the service.

Property Type Required Description
Message

string

True

The message identifying the service exception that occurred.

Job

AWS Data Exchange jobs are asynchronous import or export operations used to create or copy assets. Jobs are deleted 90 days after they are created.

Property Type Required Description
Errors

Array of type JobError

False

The errors associated with jobs.

Type

string

Values: IMPORT_ASSETS_FROM_S3 | IMPORT_ASSET_FROM_SIGNED_URL | EXPORT_ASSETS_TO_S3 | EXPORT_ASSET_TO_SIGNED_URL

True

The job type.

Details

ResponseDetails

True

Details about the job.

State

string

Values: WAITING | IN_PROGRESS | ERROR | COMPLETED | CANCELLED | TIMED_OUT

True

The state of the job.

CreatedAt

string

True

The date and time that the job was created, in ISO 8601 format.

Id

string

True

The unique identifier for the job.

Arn

string

True

The ARN for the job.

UpdatedAt

string

True

The date and time that the job was last updated, in ISO 8601 format.

JobError

An error that occurred with the job request.

Property Type Required Description
Details

object

False
Message

string

True

The message related to the job error.

ResourceId

string

False

The unique identifier for the resource related to the error.

ResourceType

JobErrorResourceTypes

False

The type of resource related to the error.

Code

string

Values: ACCESS_DENIED_EXCEPTION | INTERNAL_SERVER_EXCEPTION | MALWARE_DETECTED | RESOURCE_NOT_FOUND_EXCEPTION | SERVICE_QUOTA_EXCEEDED_EXCEPTION | VALIDATION_EXCEPTION | MALWARE_SCAN_ENCRYPTED_FILE

True

The code for the job error.

LimitName

JobErrorLimitName

False

The name of the limit that was reached.

LimitValue

number

Format: float

False

The value of the exceeded limit.

JobErrorLimitName

The name of the limit that was reached.

  • Assets per revision

  • Asset size in GB

JobErrorResourceTypes

The types of resource which the job error can apply to.

  • REVISION

  • ASSET

ResourceNotFoundException

The resource couldn't be found.

Property Type Required Description
Message

string

True

The resource couldn't be found.

ResourceId

string

False

The unique identifier for the resource that couldn't be found.

ResourceType

string

Values: DATA_SET | REVISION | ASSET | JOB

False

The type of resource that couldn't be found.

ResponseDetails

Details for the response.

Property Type Required Description
ImportAssetFromSignedUrl

ImportAssetFromSignedUrlResponseDetails

False

Details for the import from signed URL response.

ExportAssetToSignedUrl

ExportAssetToSignedUrlResponseDetails

False

Details for the export to signed URL response.

ImportAssetsFromS3

ImportAssetsFromS3ResponseDetails

False

Details for the import from Amazon S3 response.

ExportAssetsToS3

ExportAssetsToS3ResponseDetails

False

Details for the export to Amazon S3 response.

ServerSideEncryptionTypes

The types of encryption supported in export jobs to Amazon S3.

  • aws:kms

  • AES256

ThrottlingException

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

Property Type Required Description
Message

string

True

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

ValidationException

The request was invalid.

Property Type Required Description
Message

string

True

The message that informs you about what was invalid about the request.

See Also

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

GetJob

CancelJob

StartJob