},
"ImportAssetFromSignedUrl": { "DataSetId": "string", "RevisionId": "string", "AssetName": "string", "Md5Hash": "string"
},
"ExportAssetToSignedUrl": { "DataSetId": "string", "RevisionId": "string", "AssetId": "string"
},
"ExportRevisionsToS3": { "DataSetId": "string", "RevisionDestinations": [ {
"ImportAssetsFromRedshiftDataShares": { "AssetSources": [ "RevisionId": "string"
},
"ImportAssetFromApiGatewayApi": { "DataSetId": "string",
"RevisionId": "string", "ApiId": "string", "ProtocolType": enum, "Stage": "string", "ApiKey": "string", "ApiName": "string",
"ApiSpecificationMd5Hash": "string", "ApiDescription": "string"
}
Schemas
"ImportAssetFromSignedUrlJobErrorDetails": { "AssetName": "string"
Schemas
"ImportAssetsFromRedshiftDataShares": { "AssetSources": [
"ImportAssetFromApiGatewayApi": { "DataSetId": "string",
"ApiSpecificationMd5Hash": "string", "ApiDescription": "string",
"ApiSpecificationUploadUrl": "string",
"ApiSpecificationUploadUrlExpiresAt": "string"
}
], "NextToken": "string"
}
Job schema
{ "Type": enum, "State": enum, "Errors": [ {
"Code": enum, "Message": "string", "ResourceType": enum, "ResourceId": "string", "LimitName": enum, "LimitValue": number, "Details": {
"ImportAssetsFromS3JobErrorDetails": [ {
"Bucket": "string", "Key": "string"
} ],
"ImportAssetFromSignedUrlJobErrorDetails": { "AssetName": "string"
} }
Schemas
}
], "Details": {
"ImportAssetsFromS3": { "AssetSources": [ "RevisionId": "string"
},
"ExportAssetsToS3": { "DataSetId": "string", "RevisionId": "string", "AssetDestinations": [
"ImportAssetFromSignedUrl": { "DataSetId": "string", "RevisionId": "string", "AssetName": "string", "SignedUrl": "string",
"SignedUrlExpiresAt": "string", "Md5Hash": "string"
},
"ExportAssetToSignedUrl": { "DataSetId": "string", "RevisionId": "string", "AssetId": "string", "SignedUrl": "string",
"SignedUrlExpiresAt": "string"
},
"ExportRevisionsToS3": { "DataSetId": "string", "RevisionDestinations": [ {
"EventActionArn": "string"
},
"ImportAssetsFromRedshiftDataShares": { "AssetSources": [ "RevisionId": "string"
Schemas
},
"ImportAssetFromApiGatewayApi": { "DataSetId": "string",
"RevisionId": "string", "ApiId": "string", "ProtocolType": enum, "Stage": "string", "ApiKey": "string", "ApiName": "string",
"ApiSpecificationMd5Hash": "string", "ApiDescription": "string",
"ApiSpecificationUploadUrl": "string",
"ApiSpecificationUploadUrlExpiresAt": "string"
}
}, "CreatedAt": "string", "UpdatedAt": "string", "Arn": "string", "Id": "string"
}
ValidationException schema
{ "Message": "string", "ExceptionCause": enum }
AccessDeniedException schema
{
"Message": "string"
}
ResourceNotFoundException schema
{ "Message": "string", "ResourceType": enum, "ResourceId": "string"
}
ThrottlingException schema
{ "Message": "string"
}
InternalServerException schema
{ "Message": "string"
}
Properties
Properties
AccessDeniedException
Access to the resource is denied.
Message
Access to the resource is denied.
Type: string Required: True
AssetDestinationEntry
The destination for the asset.
Bucket
The S3 bucket that is the destination for the asset.
Type: string Required: True
Key
The name of the object in Amazon S3 for the asset.
Type: string Required: False
AssetId
The unique identifier for the asset.
Type: string Required: True
AssetSourceEntry
The source of the assets.
Bucket
The S3 bucket that's part of the source of the asset.
Type: string Required: True
Key
The name of the object in Amazon S3 for the asset.
Type: string
Properties
Required: True
CreateJobRequest
The CreateJob request. 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 assets. A subscriber with an entitlement to a data set can only export. Jobs are deleted 90 days after they are created. Created jobs must be started with the StartJob operation.
Type
The type of job to be created.
Type: string Required: True
Values: IMPORT_ASSETS_FROM_S3 | IMPORT_ASSET_FROM_SIGNED_URL |
EXPORT_ASSETS_TO_S3 | EXPORT_ASSET_TO_SIGNED_URL | EXPORT_REVISIONS_TO_S3 | IMPORT_ASSETS_FROM_REDSHIFT_DATA_SHARES | IMPORT_ASSET_FROM_API_GATEWAY_API
Details
The details for the CreateJob request.
Type: RequestDetails (p. 105) Required: True
Details
Information about the job error.
ImportAssetsFromS3JobErrorDetails
Information about the job error.Type: Array of type AssetSourceEntry (p. 89) Required: False
ImportAssetFromSignedUrlJobErrorDetails
Information about the job error.Type: ImportAssetFromSignedUrlJobErrorDetails (p. 97) Required: False
ExportAssetToSignedUrlRequestDetails
Details of the operation to be performed by the job.
DataSetId
The unique identifier for the data set associated with this export job.
Type: string
Properties
Required: True
RevisionId
The unique identifier for the revision associated with this export request.
Type: string Required: True
AssetId
The unique identifier for the asset that is exported to a signed URL.
Type: string Required: True
ExportAssetToSignedUrlResponseDetails
The details of the export to signed URL response.
DataSetId
The unique identifier for the data set associated with this export job.
Type: string Required: True
RevisionId
The unique identifier for the revision associated with this export response.
Type: string Required: True
AssetId
The unique identifier for the asset associated with this export job.
Type: string Required: True
SignedUrl
The signed URL for the export request.
Type: string Required: False
SignedUrlExpiresAt
The date and time that the signed URL expires, in ISO 8601 format.
Type: string Required: False
Properties
ExportAssetsToS3RequestDetails
Details of the operation to be performed by the job.
DataSetId
The unique identifier for the data set associated with this export job.
Type: string Required: True
RevisionId
The unique identifier for the revision associated with this export request.
Type: string Required: True
AssetDestinations
The destination for the asset.
Type: Array of type AssetDestinationEntry (p. 89) Required: True
Encryption
Encryption configuration for the export job.
Type: ExportServerSideEncryption (p. 94) Required: False
ExportAssetsToS3ResponseDetails
Details about the export to Amazon S3 response.
DataSetId
The unique identifier for the data set associated with this export job.
Type: string Required: True
RevisionId
The unique identifier for the revision associated with this export response.
Type: string Required: True
AssetDestinations
The destination in Amazon S3 where the asset is exported.
Properties
Type: Array of type AssetDestinationEntry (p. 89) Required: True
Encryption
Encryption configuration of the export job.
Type: ExportServerSideEncryption (p. 94) Required: False
ExportRevisionsToS3RequestDetails
Details of the operation to be performed by the job.
DataSetId
The unique identifier for the data set associated with this export job.
Type: string Required: True
RevisionDestinations
The destination for the revision.
Type: Array of type RevisionDestinationEntry (p. 108) Required: True
Encryption
Encryption configuration for the export job.
Type: ExportServerSideEncryption (p. 94) Required: False
ExportRevisionsToS3ResponseDetails
Details about the export revisions to Amazon S3 response.
DataSetId
The unique identifier for the data set associated with this export job.
Type: string Required: True
RevisionDestinations
The destination in Amazon S3 where the revision is exported.
Type: Array of type RevisionDestinationEntry (p. 108) Required: True
Properties
Encryption
Encryption configuration of the export job.
Type: ExportServerSideEncryption (p. 94) Required: False
EventActionArn
The Amazon Resource Name (ARN) of the event action.
Type: string Required: False
ExportServerSideEncryption
Encryption configuration of the export job. Includes the encryption type in addition to the AWS KMS key.
The KMS key is only necessary if you chose the KMS encryption. type.
Type
The type of server side encryption used for encrypting the objects in Amazon S3.
Type: ServerSideEncryptionTypes (p. 108) Required: True
KmsKeyArn
The Amazon Resource Name (ARN) of 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.
Type: string Required: False
ImportAssetFromApiGatewayApiRequestDetails
The request details.
DataSetId
The data set ID.Type: string Required: True
RevisionId
The revision ID.Type: string Required: True
ApiId
The API Gateway API ID.
Properties
Type: string Required: True
ProtocolType
The protocol type.Type: string Required: True Values: REST
Stage
The API stage.Type: string Required: True
ApiKey
The API Gateway API key.
Type: string Required: False