2020/04/27 - AWS Data Exchange - 3 updated api methods
Changes Update dataexchange client to latest version
{'Details': {'ExportAssetsToS3': {'Encryption': {'KmsKeyArn': 'string',
'Type': 'aws:kms | AES256'}}}}
This operation creates a job.
See also: AWS API Documentation
Request Syntax
client.create_job(
Details={
'ExportAssetToSignedUrl': {
'AssetId': 'string',
'DataSetId': 'string',
'RevisionId': 'string'
},
'ExportAssetsToS3': {
'AssetDestinations': [
{
'AssetId': 'string',
'Bucket': 'string',
'Key': 'string'
},
],
'DataSetId': 'string',
'Encryption': {
'KmsKeyArn': 'string',
'Type': 'aws:kms'|'AES256'
},
'RevisionId': 'string'
},
'ImportAssetFromSignedUrl': {
'AssetName': 'string',
'DataSetId': 'string',
'Md5Hash': 'string',
'RevisionId': 'string'
},
'ImportAssetsFromS3': {
'AssetSources': [
{
'Bucket': 'string',
'Key': 'string'
},
],
'DataSetId': 'string',
'RevisionId': 'string'
}
},
Type='IMPORT_ASSETS_FROM_S3'|'IMPORT_ASSET_FROM_SIGNED_URL'|'EXPORT_ASSETS_TO_S3'|'EXPORT_ASSET_TO_SIGNED_URL'
)
dict
[REQUIRED]
The details for the CreateJob request.
ExportAssetToSignedUrl (dict) --
Details about the export to signed URL request.
AssetId (string) -- [REQUIRED]
The unique identifier for the asset that is exported to a signed URL.
DataSetId (string) -- [REQUIRED]
The unique identifier for the data set associated with this export job.
RevisionId (string) -- [REQUIRED]
The unique identifier for the revision associated with this export request.
ExportAssetsToS3 (dict) --
Details about the export to Amazon S3 request.
AssetDestinations (list) -- [REQUIRED]
The destination for the asset.
(dict) --
The destination for the asset.
AssetId (string) -- [REQUIRED]
The unique identifier for the asset.
Bucket (string) -- [REQUIRED]
The S3 bucket that is the destination for the asset.
Key (string) --
The name of the object in Amazon S3 for the asset.
DataSetId (string) -- [REQUIRED]
The unique identifier for the data set associated with this export job.
Encryption (dict) --
Encryption configuration for the export job.
KmsKeyArn (string) -- [REQUIRED]
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.
Type (string) -- [REQUIRED]
The type of server side encryption used for encrypting the objects in Amazon S3.
RevisionId (string) -- [REQUIRED]
The unique identifier for the revision associated with this export request.
ImportAssetFromSignedUrl (dict) --
Details about the import from signed URL request.
AssetName (string) -- [REQUIRED]
The name of the asset. When importing from Amazon S3, the S3 object key is used as the asset name.
DataSetId (string) -- [REQUIRED]
The unique identifier for the data set associated with this import job.
Md5Hash (string) -- [REQUIRED]
The Base64-encoded Md5 hash for the asset, used to ensure the integrity of the file at that location.
RevisionId (string) -- [REQUIRED]
The unique identifier for the revision associated with this import request.
ImportAssetsFromS3 (dict) --
Details about the import from Amazon S3 request.
AssetSources (list) -- [REQUIRED]
Is a list of S3 bucket and object key pairs.
(dict) --
The source of the assets.
Bucket (string) -- [REQUIRED]
The S3 bucket that's part of the source of the asset.
Key (string) -- [REQUIRED]
The name of the object in Amazon S3 for the asset.
DataSetId (string) -- [REQUIRED]
The unique identifier for the data set associated with this import job.
RevisionId (string) -- [REQUIRED]
The unique identifier for the revision associated with this import request.
string
[REQUIRED]
The type of job to be created.
dict
Response Syntax
{
'Arn': 'string',
'CreatedAt': datetime(2015, 1, 1),
'Details': {
'ExportAssetToSignedUrl': {
'AssetId': 'string',
'DataSetId': 'string',
'RevisionId': 'string',
'SignedUrl': 'string',
'SignedUrlExpiresAt': datetime(2015, 1, 1)
},
'ExportAssetsToS3': {
'AssetDestinations': [
{
'AssetId': 'string',
'Bucket': 'string',
'Key': 'string'
},
],
'DataSetId': 'string',
'Encryption': {
'KmsKeyArn': 'string',
'Type': 'aws:kms'|'AES256'
},
'RevisionId': 'string'
},
'ImportAssetFromSignedUrl': {
'AssetName': 'string',
'DataSetId': 'string',
'Md5Hash': 'string',
'RevisionId': 'string',
'SignedUrl': 'string',
'SignedUrlExpiresAt': datetime(2015, 1, 1)
},
'ImportAssetsFromS3': {
'AssetSources': [
{
'Bucket': 'string',
'Key': 'string'
},
],
'DataSetId': 'string',
'RevisionId': 'string'
}
},
'Errors': [
{
'Code': 'ACCESS_DENIED_EXCEPTION'|'INTERNAL_SERVER_EXCEPTION'|'MALWARE_DETECTED'|'RESOURCE_NOT_FOUND_EXCEPTION'|'SERVICE_QUOTA_EXCEEDED_EXCEPTION'|'VALIDATION_EXCEPTION'|'MALWARE_SCAN_ENCRYPTED_FILE',
'Details': {
'ImportAssetFromSignedUrlJobErrorDetails': {
'AssetName': 'string'
},
'ImportAssetsFromS3JobErrorDetails': [
{
'Bucket': 'string',
'Key': 'string'
},
]
},
'LimitName': 'Assets per revision'|'Asset size in GB',
'LimitValue': 123.0,
'Message': 'string',
'ResourceId': 'string',
'ResourceType': 'REVISION'|'ASSET'
},
],
'Id': 'string',
'State': 'WAITING'|'IN_PROGRESS'|'ERROR'|'COMPLETED'|'CANCELLED'|'TIMED_OUT',
'Type': 'IMPORT_ASSETS_FROM_S3'|'IMPORT_ASSET_FROM_SIGNED_URL'|'EXPORT_ASSETS_TO_S3'|'EXPORT_ASSET_TO_SIGNED_URL',
'UpdatedAt': datetime(2015, 1, 1)
}
Response Structure
(dict) --
201 response
Arn (string) --
The ARN for the job.
CreatedAt (datetime) --
The date and time that the job was created, in ISO 8601 format.
Details (dict) --
Details about the job.
ExportAssetToSignedUrl (dict) --
Details for the export to signed URL response.
AssetId (string) --
The unique identifier for the asset associated with this export job.
DataSetId (string) --
The unique identifier for the data set associated with this export job.
RevisionId (string) --
The unique identifier for the revision associated with this export response.
SignedUrl (string) --
The signed URL for the export request.
SignedUrlExpiresAt (datetime) --
The date and time that the signed URL expires, in ISO 8601 format.
ExportAssetsToS3 (dict) --
Details for the export to Amazon S3 response.
AssetDestinations (list) --
The destination in Amazon S3 where the asset is exported.
(dict) --
The destination for the asset.
AssetId (string) --
The unique identifier for the asset.
Bucket (string) --
The S3 bucket that is the destination for the asset.
Key (string) --
The name of the object in Amazon S3 for the asset.
DataSetId (string) --
The unique identifier for the data set associated with this export job.
Encryption (dict) --
Encryption configuration of the export job.
KmsKeyArn (string) --
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.
Type (string) --
The type of server side encryption used for encrypting the objects in Amazon S3.
RevisionId (string) --
The unique identifier for the revision associated with this export response.
ImportAssetFromSignedUrl (dict) --
Details for the import from signed URL response.
AssetName (string) --
The name for the asset associated with this import response.
DataSetId (string) --
The unique identifier for the data set associated with this import job.
Md5Hash (string) --
The Base64-encoded Md5 hash for the asset, used to ensure the integrity of the file at that location.
RevisionId (string) --
The unique identifier for the revision associated with this import response.
SignedUrl (string) --
The signed URL.
SignedUrlExpiresAt (datetime) --
The time and date at which the signed URL expires, in ISO 8601 format.
ImportAssetsFromS3 (dict) --
Details for the import from Amazon S3 response.
AssetSources (list) --
Is a list of Amazon S3 bucket and object key pairs.
(dict) --
The source of the assets.
Bucket (string) --
The S3 bucket that's part of the source of the asset.
Key (string) --
The name of the object in Amazon S3 for the asset.
DataSetId (string) --
The unique identifier for the data set associated with this import job.
RevisionId (string) --
The unique identifier for the revision associated with this import response.
Errors (list) --
The errors associated with jobs.
(dict) -- An error that occurred with the job request.
Code (string) -- The code for the job error.
Details (dict) --
ImportAssetFromSignedUrlJobErrorDetails (dict) --
AssetName (string) --
The name of the asset. When importing from Amazon S3, the S3 object key is used as the asset name. When exporting to Amazon S3, the asset name is used as default target S3 object key.
ImportAssetsFromS3JobErrorDetails (list) --
The list of sources for the assets.
(dict) --
The source of the assets.
Bucket (string) --
The S3 bucket that's part of the source of the asset.
Key (string) --
The name of the object in Amazon S3 for the asset.
LimitName (string) --
The name of the limit that was reached.
LimitValue (float) -- The value of the exceeded limit.
Message (string) -- The message related to the job error.
ResourceId (string) -- The unique identifier for the resource related to the error.
ResourceType (string) -- The type of resource related to the error.
Id (string) --
The unique identifier for the job.
State (string) --
The state of the job.
Type (string) --
The job type.
UpdatedAt (datetime) --
The date and time that the job was last updated, in ISO 8601 format.
{'Details': {'ExportAssetsToS3': {'Encryption': {'KmsKeyArn': 'string',
'Type': 'aws:kms | AES256'}}}}
This operation returns information about a job.
See also: AWS API Documentation
Request Syntax
client.get_job(
JobId='string'
)
string
[REQUIRED]
The unique identifier for a job.
dict
Response Syntax
{
'Arn': 'string',
'CreatedAt': datetime(2015, 1, 1),
'Details': {
'ExportAssetToSignedUrl': {
'AssetId': 'string',
'DataSetId': 'string',
'RevisionId': 'string',
'SignedUrl': 'string',
'SignedUrlExpiresAt': datetime(2015, 1, 1)
},
'ExportAssetsToS3': {
'AssetDestinations': [
{
'AssetId': 'string',
'Bucket': 'string',
'Key': 'string'
},
],
'DataSetId': 'string',
'Encryption': {
'KmsKeyArn': 'string',
'Type': 'aws:kms'|'AES256'
},
'RevisionId': 'string'
},
'ImportAssetFromSignedUrl': {
'AssetName': 'string',
'DataSetId': 'string',
'Md5Hash': 'string',
'RevisionId': 'string',
'SignedUrl': 'string',
'SignedUrlExpiresAt': datetime(2015, 1, 1)
},
'ImportAssetsFromS3': {
'AssetSources': [
{
'Bucket': 'string',
'Key': 'string'
},
],
'DataSetId': 'string',
'RevisionId': 'string'
}
},
'Errors': [
{
'Code': 'ACCESS_DENIED_EXCEPTION'|'INTERNAL_SERVER_EXCEPTION'|'MALWARE_DETECTED'|'RESOURCE_NOT_FOUND_EXCEPTION'|'SERVICE_QUOTA_EXCEEDED_EXCEPTION'|'VALIDATION_EXCEPTION'|'MALWARE_SCAN_ENCRYPTED_FILE',
'Details': {
'ImportAssetFromSignedUrlJobErrorDetails': {
'AssetName': 'string'
},
'ImportAssetsFromS3JobErrorDetails': [
{
'Bucket': 'string',
'Key': 'string'
},
]
},
'LimitName': 'Assets per revision'|'Asset size in GB',
'LimitValue': 123.0,
'Message': 'string',
'ResourceId': 'string',
'ResourceType': 'REVISION'|'ASSET'
},
],
'Id': 'string',
'State': 'WAITING'|'IN_PROGRESS'|'ERROR'|'COMPLETED'|'CANCELLED'|'TIMED_OUT',
'Type': 'IMPORT_ASSETS_FROM_S3'|'IMPORT_ASSET_FROM_SIGNED_URL'|'EXPORT_ASSETS_TO_S3'|'EXPORT_ASSET_TO_SIGNED_URL',
'UpdatedAt': datetime(2015, 1, 1)
}
Response Structure
(dict) --
200 response
Arn (string) --
The ARN for the job.
CreatedAt (datetime) --
The date and time that the job was created, in ISO 8601 format.
Details (dict) --
Details about the job.
ExportAssetToSignedUrl (dict) --
Details for the export to signed URL response.
AssetId (string) --
The unique identifier for the asset associated with this export job.
DataSetId (string) --
The unique identifier for the data set associated with this export job.
RevisionId (string) --
The unique identifier for the revision associated with this export response.
SignedUrl (string) --
The signed URL for the export request.
SignedUrlExpiresAt (datetime) --
The date and time that the signed URL expires, in ISO 8601 format.
ExportAssetsToS3 (dict) --
Details for the export to Amazon S3 response.
AssetDestinations (list) --
The destination in Amazon S3 where the asset is exported.
(dict) --
The destination for the asset.
AssetId (string) --
The unique identifier for the asset.
Bucket (string) --
The S3 bucket that is the destination for the asset.
Key (string) --
The name of the object in Amazon S3 for the asset.
DataSetId (string) --
The unique identifier for the data set associated with this export job.
Encryption (dict) --
Encryption configuration of the export job.
KmsKeyArn (string) --
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.
Type (string) --
The type of server side encryption used for encrypting the objects in Amazon S3.
RevisionId (string) --
The unique identifier for the revision associated with this export response.
ImportAssetFromSignedUrl (dict) --
Details for the import from signed URL response.
AssetName (string) --
The name for the asset associated with this import response.
DataSetId (string) --
The unique identifier for the data set associated with this import job.
Md5Hash (string) --
The Base64-encoded Md5 hash for the asset, used to ensure the integrity of the file at that location.
RevisionId (string) --
The unique identifier for the revision associated with this import response.
SignedUrl (string) --
The signed URL.
SignedUrlExpiresAt (datetime) --
The time and date at which the signed URL expires, in ISO 8601 format.
ImportAssetsFromS3 (dict) --
Details for the import from Amazon S3 response.
AssetSources (list) --
Is a list of Amazon S3 bucket and object key pairs.
(dict) --
The source of the assets.
Bucket (string) --
The S3 bucket that's part of the source of the asset.
Key (string) --
The name of the object in Amazon S3 for the asset.
DataSetId (string) --
The unique identifier for the data set associated with this import job.
RevisionId (string) --
The unique identifier for the revision associated with this import response.
Errors (list) --
The errors associated with jobs.
(dict) -- An error that occurred with the job request.
Code (string) -- The code for the job error.
Details (dict) --
ImportAssetFromSignedUrlJobErrorDetails (dict) --
AssetName (string) --
The name of the asset. When importing from Amazon S3, the S3 object key is used as the asset name. When exporting to Amazon S3, the asset name is used as default target S3 object key.
ImportAssetsFromS3JobErrorDetails (list) --
The list of sources for the assets.
(dict) --
The source of the assets.
Bucket (string) --
The S3 bucket that's part of the source of the asset.
Key (string) --
The name of the object in Amazon S3 for the asset.
LimitName (string) --
The name of the limit that was reached.
LimitValue (float) -- The value of the exceeded limit.
Message (string) -- The message related to the job error.
ResourceId (string) -- The unique identifier for the resource related to the error.
ResourceType (string) -- The type of resource related to the error.
Id (string) --
The unique identifier for the job.
State (string) --
The state of the job.
Type (string) --
The job type.
UpdatedAt (datetime) --
The date and time that the job was last updated, in ISO 8601 format.
{'Jobs': {'Details': {'ExportAssetsToS3': {'Encryption': {'KmsKeyArn': 'string',
'Type': 'aws:kms | '
'AES256'}}}}}
This operation lists your jobs sorted by CreatedAt in descending order.
See also: AWS API Documentation
Request Syntax
client.list_jobs(
DataSetId='string',
MaxResults=123,
NextToken='string',
RevisionId='string'
)
string
The unique identifier for a data set.
integer
The maximum number of results returned by a single call.
string
The token value retrieved from a previous call to access the next page of results.
string
The unique identifier for a revision.
dict
Response Syntax
{
'Jobs': [
{
'Arn': 'string',
'CreatedAt': datetime(2015, 1, 1),
'Details': {
'ExportAssetToSignedUrl': {
'AssetId': 'string',
'DataSetId': 'string',
'RevisionId': 'string',
'SignedUrl': 'string',
'SignedUrlExpiresAt': datetime(2015, 1, 1)
},
'ExportAssetsToS3': {
'AssetDestinations': [
{
'AssetId': 'string',
'Bucket': 'string',
'Key': 'string'
},
],
'DataSetId': 'string',
'Encryption': {
'KmsKeyArn': 'string',
'Type': 'aws:kms'|'AES256'
},
'RevisionId': 'string'
},
'ImportAssetFromSignedUrl': {
'AssetName': 'string',
'DataSetId': 'string',
'Md5Hash': 'string',
'RevisionId': 'string',
'SignedUrl': 'string',
'SignedUrlExpiresAt': datetime(2015, 1, 1)
},
'ImportAssetsFromS3': {
'AssetSources': [
{
'Bucket': 'string',
'Key': 'string'
},
],
'DataSetId': 'string',
'RevisionId': 'string'
}
},
'Errors': [
{
'Code': 'ACCESS_DENIED_EXCEPTION'|'INTERNAL_SERVER_EXCEPTION'|'MALWARE_DETECTED'|'RESOURCE_NOT_FOUND_EXCEPTION'|'SERVICE_QUOTA_EXCEEDED_EXCEPTION'|'VALIDATION_EXCEPTION'|'MALWARE_SCAN_ENCRYPTED_FILE',
'Details': {
'ImportAssetFromSignedUrlJobErrorDetails': {
'AssetName': 'string'
},
'ImportAssetsFromS3JobErrorDetails': [
{
'Bucket': 'string',
'Key': 'string'
},
]
},
'LimitName': 'Assets per revision'|'Asset size in GB',
'LimitValue': 123.0,
'Message': 'string',
'ResourceId': 'string',
'ResourceType': 'REVISION'|'ASSET'
},
],
'Id': 'string',
'State': 'WAITING'|'IN_PROGRESS'|'ERROR'|'COMPLETED'|'CANCELLED'|'TIMED_OUT',
'Type': 'IMPORT_ASSETS_FROM_S3'|'IMPORT_ASSET_FROM_SIGNED_URL'|'EXPORT_ASSETS_TO_S3'|'EXPORT_ASSET_TO_SIGNED_URL',
'UpdatedAt': datetime(2015, 1, 1)
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
200 response
Jobs (list) --
The jobs listed by the request.
(dict) -- 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.
Arn (string) --
The ARN for the job.
CreatedAt (datetime) --
The date and time that the job was created, in ISO 8601 format.
Details (dict) --
Details of the operation to be performed by the job, such as export destination details or import source details.
ExportAssetToSignedUrl (dict) --
Details for the export to signed URL response.
AssetId (string) --
The unique identifier for the asset associated with this export job.
DataSetId (string) --
The unique identifier for the data set associated with this export job.
RevisionId (string) --
The unique identifier for the revision associated with this export response.
SignedUrl (string) --
The signed URL for the export request.
SignedUrlExpiresAt (datetime) --
The date and time that the signed URL expires, in ISO 8601 format.
ExportAssetsToS3 (dict) --
Details for the export to Amazon S3 response.
AssetDestinations (list) --
The destination in Amazon S3 where the asset is exported.
(dict) --
The destination for the asset.
AssetId (string) --
The unique identifier for the asset.
Bucket (string) --
The S3 bucket that is the destination for the asset.
Key (string) --
The name of the object in Amazon S3 for the asset.
DataSetId (string) --
The unique identifier for the data set associated with this export job.
Encryption (dict) --
Encryption configuration of the export job.
KmsKeyArn (string) --
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.
Type (string) --
The type of server side encryption used for encrypting the objects in Amazon S3.
RevisionId (string) --
The unique identifier for the revision associated with this export response.
ImportAssetFromSignedUrl (dict) --
Details for the import from signed URL response.
AssetName (string) --
The name for the asset associated with this import response.
DataSetId (string) --
The unique identifier for the data set associated with this import job.
Md5Hash (string) --
The Base64-encoded Md5 hash for the asset, used to ensure the integrity of the file at that location.
RevisionId (string) --
The unique identifier for the revision associated with this import response.
SignedUrl (string) --
The signed URL.
SignedUrlExpiresAt (datetime) --
The time and date at which the signed URL expires, in ISO 8601 format.
ImportAssetsFromS3 (dict) --
Details for the import from Amazon S3 response.
AssetSources (list) --
Is a list of Amazon S3 bucket and object key pairs.
(dict) --
The source of the assets.
Bucket (string) --
The S3 bucket that's part of the source of the asset.
Key (string) --
The name of the object in Amazon S3 for the asset.
DataSetId (string) --
The unique identifier for the data set associated with this import job.
RevisionId (string) --
The unique identifier for the revision associated with this import response.
Errors (list) --
Errors for jobs.
(dict) -- An error that occurred with the job request.
Code (string) -- The code for the job error.
Details (dict) --
ImportAssetFromSignedUrlJobErrorDetails (dict) --
AssetName (string) --
The name of the asset. When importing from Amazon S3, the S3 object key is used as the asset name. When exporting to Amazon S3, the asset name is used as default target S3 object key.
ImportAssetsFromS3JobErrorDetails (list) --
The list of sources for the assets.
(dict) --
The source of the assets.
Bucket (string) --
The S3 bucket that's part of the source of the asset.
Key (string) --
The name of the object in Amazon S3 for the asset.
LimitName (string) --
The name of the limit that was reached.
LimitValue (float) -- The value of the exceeded limit.
Message (string) -- The message related to the job error.
ResourceId (string) -- The unique identifier for the resource related to the error.
ResourceType (string) -- The type of resource related to the error.
Id (string) --
The unique identifier for the job.
State (string) --
The state of the job.
Type (string) --
The job type.
UpdatedAt (datetime) --
The date and time that the job was last updated, in ISO 8601 format.
NextToken (string) --
The token value retrieved from a previous call to access the next page of results.