Table of Contents
A low-level client representing AWS Data Exchange
AWS Data Exchange is a service that makes it easy for AWS customers to exchange data in the cloud. You can use the AWS Data Exchange APIs to create, update, manage, and access file-based data set in the AWS Cloud.
As a subscriber, you can view and access the data sets that you have an entitlement to through a subscription. You can use the APIS to download or copy your entitled data sets to Amazon S3 for use across a variety of AWS analytics and machine learning services.
As a provider, you can create and manage your data sets that you would like to publish to a product. Being able to package and provide your data sets into products requires a few steps to determine eligibility. For more information, visit the AWS Data Exchange User Guide.
A data set is a collection of data that can be changed or updated over time. Data sets can be updated using revisions, which represent a new version or incremental change to a data set. A revision contains one or more assets. An asset in AWS Data Exchange is a piece of data that can be stored as an Amazon S3 object. The asset can be a structured data file, an image file, or some other data file. Jobs are asynchronous import or export operations used to create or copy assets.
import boto3
client = boto3.client('dataexchange')
These are the available methods:
Check if an operation can be paginated.
This operation cancels a job. Jobs can be cancelled only when they are in the WAITING state.
See also: AWS API Documentation
Request Syntax
response = client.cancel_job(
JobId='string'
)
[REQUIRED]
The unique identifier for a job.
Exceptions
This operation creates a data set.
See also: AWS API Documentation
Request Syntax
response = client.create_data_set(
AssetType='S3_SNAPSHOT'|'REDSHIFT_DATA_SHARE'|'API_GATEWAY_API',
Description='string',
Name='string',
Tags={
'string': 'string'
}
)
[REQUIRED]
The type of asset that is added to a data set.
[REQUIRED]
A description for the data set. This value can be up to 16,348 characters long.
[REQUIRED]
The name of the data set.
A data set tag is an optional label that you can assign to a data set when you create it. Each tag consists of a key and an optional value, both of which you define. When you use tagging, you can also use tag-based access control in IAM policies to control access to these data sets and revisions.
dict
Response Syntax
{
'Arn': 'string',
'AssetType': 'S3_SNAPSHOT'|'REDSHIFT_DATA_SHARE'|'API_GATEWAY_API',
'CreatedAt': datetime(2015, 1, 1),
'Description': 'string',
'Id': 'string',
'Name': 'string',
'Origin': 'OWNED'|'ENTITLED',
'OriginDetails': {
'ProductId': 'string'
},
'SourceId': 'string',
'Tags': {
'string': 'string'
},
'UpdatedAt': datetime(2015, 1, 1)
}
Response Structure
(dict) --
201 response
Arn (string) --
The ARN for the data set.
AssetType (string) --
The type of asset that is added to a data set.
CreatedAt (datetime) --
The date and time that the data set was created, in ISO 8601 format.
Description (string) --
The description for the data set.
Id (string) --
The unique identifier for the data set.
Name (string) --
The name of the data set.
Origin (string) --
A property that defines the data set as OWNED by the account (for providers) or ENTITLED to the account (for subscribers).
OriginDetails (dict) --
If the origin of this data set is ENTITLED, includes the details for the product on AWS Marketplace.
ProductId (string) --
The product ID of the origin of the data set.
SourceId (string) --
The data set ID of the owned data set corresponding to the entitled data set being viewed. This parameter is returned when a data set owner is viewing the entitled copy of its owned data set.
Tags (dict) --
The tags for the data set.
UpdatedAt (datetime) --
The date and time that the data set was last updated, in ISO 8601 format.
Exceptions
This operation creates an event action.
See also: AWS API Documentation
Request Syntax
response = client.create_event_action(
Action={
'ExportRevisionToS3': {
'Encryption': {
'KmsKeyArn': 'string',
'Type': 'aws:kms'|'AES256'
},
'RevisionDestination': {
'Bucket': 'string',
'KeyPattern': 'string'
}
}
},
Event={
'RevisionPublished': {
'DataSetId': 'string'
}
}
)
[REQUIRED]
What occurs after a certain event.
Details for the export revision to Amazon S3 action.
Encryption configuration for the auto export job.
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.
The type of server side encryption used for encrypting the objects in Amazon S3.
A revision destination is the Amazon S3 bucket folder destination to where the export will be sent.
The S3 bucket that is the destination for the event action.
A string representing the pattern for generated names of the individual assets in the revision. For more information about key patterns, see Key patterns when exporting revisions .
[REQUIRED]
What occurs to start an action.
What occurs to start the revision publish action.
The data set ID of the published revision.
dict
Response Syntax
{
'Action': {
'ExportRevisionToS3': {
'Encryption': {
'KmsKeyArn': 'string',
'Type': 'aws:kms'|'AES256'
},
'RevisionDestination': {
'Bucket': 'string',
'KeyPattern': 'string'
}
}
},
'Arn': 'string',
'CreatedAt': datetime(2015, 1, 1),
'Event': {
'RevisionPublished': {
'DataSetId': 'string'
}
},
'Id': 'string',
'UpdatedAt': datetime(2015, 1, 1)
}
Response Structure
(dict) --
201 response
Action (dict) --
What occurs after a certain event.
ExportRevisionToS3 (dict) --
Details for the export revision to Amazon S3 action.
Encryption (dict) --
Encryption configuration for the auto export job.
KmsKeyArn (string) --
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) --
The type of server side encryption used for encrypting the objects in Amazon S3.
RevisionDestination (dict) --
A revision destination is the Amazon S3 bucket folder destination to where the export will be sent.
Bucket (string) --
The S3 bucket that is the destination for the event action.
KeyPattern (string) --
A string representing the pattern for generated names of the individual assets in the revision. For more information about key patterns, see Key patterns when exporting revisions .
Arn (string) --
The ARN for the event action.
CreatedAt (datetime) --
The date and time that the event action was created, in ISO 8601 format.
Event (dict) --
What occurs to start an action.
RevisionPublished (dict) --
What occurs to start the revision publish action.
DataSetId (string) --
The data set ID of the published revision.
Id (string) --
The unique identifier for the event action.
UpdatedAt (datetime) --
The date and time that the event action was last updated, in ISO 8601 format.
Exceptions
This operation creates a job.
See also: AWS API Documentation
Request Syntax
response = 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'
},
'ExportRevisionsToS3': {
'DataSetId': 'string',
'Encryption': {
'KmsKeyArn': 'string',
'Type': 'aws:kms'|'AES256'
},
'RevisionDestinations': [
{
'Bucket': 'string',
'KeyPattern': 'string',
'RevisionId': 'string'
},
]
},
'ImportAssetFromSignedUrl': {
'AssetName': 'string',
'DataSetId': 'string',
'Md5Hash': 'string',
'RevisionId': 'string'
},
'ImportAssetsFromS3': {
'AssetSources': [
{
'Bucket': 'string',
'Key': 'string'
},
],
'DataSetId': 'string',
'RevisionId': 'string'
},
'ImportAssetsFromRedshiftDataShares': {
'AssetSources': [
{
'DataShareArn': 'string'
},
],
'DataSetId': 'string',
'RevisionId': 'string'
},
'ImportAssetFromApiGatewayApi': {
'ApiDescription': 'string',
'ApiId': 'string',
'ApiKey': 'string',
'ApiName': 'string',
'ApiSpecificationMd5Hash': 'string',
'DataSetId': 'string',
'ProtocolType': 'REST',
'RevisionId': 'string',
'Stage': 'string'
}
},
Type='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'
)
[REQUIRED]
The details for the CreateJob request.
Details about the export to signed URL request.
The unique identifier for the asset that is exported to a signed URL.
The unique identifier for the data set associated with this export job.
The unique identifier for the revision associated with this export request.
Details about the export to Amazon S3 request.
The destination for the asset.
The destination for the asset.
The unique identifier for the asset.
The S3 bucket that is the destination for the asset.
The name of the object in Amazon S3 for the asset.
The unique identifier for the data set associated with this export job.
Encryption configuration for the export job.
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.
The type of server side encryption used for encrypting the objects in Amazon S3.
The unique identifier for the revision associated with this export request.
Details about the export to Amazon S3 request.
The unique identifier for the data set associated with this export job.
Encryption configuration for the export job.
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.
The type of server side encryption used for encrypting the objects in Amazon S3.
The destination for the revision.
The destination where the assets in the revision will be exported.
The S3 bucket that is the destination for the assets in the revision.
A string representing the pattern for generated names of the individual assets in the revision. For more information about key patterns, see Key patterns when exporting revisions .
The unique identifier for the revision.
Details about the import from signed URL request.
The name of the asset. When importing from Amazon S3, the S3 object key is used as the asset name.
The unique identifier for the data set associated with this import job.
The Base64-encoded Md5 hash for the asset, used to ensure the integrity of the file at that location.
The unique identifier for the revision associated with this import request.
Details about the import from Amazon S3 request.
Is a list of S3 bucket and object key pairs.
The source of the assets.
The S3 bucket that's part of the source of the asset.
The name of the object in Amazon S3 for the asset.
The unique identifier for the data set associated with this import job.
The unique identifier for the revision associated with this import request.
Details from an import from Amazon Redshift datashare request.
The source of the Amazon Redshift datashare asset.
Information about the import asset from API Gateway API request.
The API description. Markdown supported.
The API Gateway API ID.
The API Gateway API key.
The API name.
The Base64-encoded MD5 hash of the OpenAPI 3.0 JSON API specification file. It is used to ensure the integrity of the file.
The data set ID.
The protocol type.
The revision ID.
The API stage.
[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'
},
'ExportRevisionsToS3': {
'DataSetId': 'string',
'Encryption': {
'KmsKeyArn': 'string',
'Type': 'aws:kms'|'AES256'
},
'RevisionDestinations': [
{
'Bucket': 'string',
'KeyPattern': 'string',
'RevisionId': 'string'
},
],
'EventActionArn': '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'
},
'ImportAssetsFromRedshiftDataShares': {
'AssetSources': [
{
'DataShareArn': 'string'
},
],
'DataSetId': 'string',
'RevisionId': 'string'
},
'ImportAssetFromApiGatewayApi': {
'ApiDescription': 'string',
'ApiId': 'string',
'ApiKey': 'string',
'ApiName': 'string',
'ApiSpecificationMd5Hash': 'string',
'ApiSpecificationUploadUrl': 'string',
'ApiSpecificationUploadUrlExpiresAt': datetime(2015, 1, 1),
'DataSetId': 'string',
'ProtocolType': 'REST',
'RevisionId': 'string',
'Stage': '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'|'Amazon Redshift datashare assets per revision',
'LimitValue': 123.0,
'Message': 'string',
'ResourceId': 'string',
'ResourceType': 'REVISION'|'ASSET'|'DATA_SET'
},
],
'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'|'EXPORT_REVISIONS_TO_S3'|'IMPORT_ASSETS_FROM_REDSHIFT_DATA_SHARES'|'IMPORT_ASSET_FROM_API_GATEWAY_API',
'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 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.
ExportRevisionsToS3 (dict) --
Details for the export revisions to Amazon S3 response.
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 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.
RevisionDestinations (list) --
The destination in Amazon S3 where the revision is exported.
(dict) --
The destination where the assets in the revision will be exported.
Bucket (string) --
The S3 bucket that is the destination for the assets in the revision.
KeyPattern (string) --
A string representing the pattern for generated names of the individual assets in the revision. For more information about key patterns, see Key patterns when exporting revisions .
RevisionId (string) --
The unique identifier for the revision.
EventActionArn (string) --
The Amazon Resource Name (ARN) of the event action.
ImportAssetFromSignedUrl (dict) --
Details for the import from signed URL response.
AssetName (string) --
The name for the asset associated with this import job.
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.
ImportAssetsFromRedshiftDataShares (dict) --
Details from an import from Amazon Redshift datashare response.
AssetSources (list) -- A list of Amazon Redshift datashare asset sources.
(dict) --
The source of the Amazon Redshift datashare 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 job.
ImportAssetFromApiGatewayApi (dict) --
The response details.
ApiDescription (string) --
The API description.
ApiId (string) --
The API ID.
ApiKey (string) --
The API key.
ApiName (string) --
The API name.
ApiSpecificationMd5Hash (string) --
The Base64-encoded Md5 hash for the API asset, used to ensure the integrity of the API at that location.
ApiSpecificationUploadUrl (string) --
The upload URL of the API specification.
ApiSpecificationUploadUrlExpiresAt (datetime) --
The date and time that the upload URL expires, in ISO 8601 format.
DataSetId (string) --
The data set ID.
ProtocolType (string) --
The protocol type.
RevisionId (string) --
The revision ID.
Stage (string) --
The API stage.
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) --
The details about the job error.
ImportAssetFromSignedUrlJobErrorDetails (dict) --
Information about the job error.
AssetName (string) --
Information about the job error.
ImportAssetsFromS3JobErrorDetails (list) --
Information about the job error.
(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.
Exceptions
This operation creates a revision for a data set.
See also: AWS API Documentation
Request Syntax
response = client.create_revision(
Comment='string',
DataSetId='string',
Tags={
'string': 'string'
}
)
[REQUIRED]
The unique identifier for a data set.
A revision tag is an optional label that you can assign to a revision when you create it. Each tag consists of a key and an optional value, both of which you define. When you use tagging, you can also use tag-based access control in IAM policies to control access to these data sets and revisions.
dict
Response Syntax
{
'Arn': 'string',
'Comment': 'string',
'CreatedAt': datetime(2015, 1, 1),
'DataSetId': 'string',
'Finalized': True|False,
'Id': 'string',
'SourceId': 'string',
'Tags': {
'string': 'string'
},
'UpdatedAt': datetime(2015, 1, 1)
}
Response Structure
(dict) --
201 response
Arn (string) --
The ARN for the revision.
Comment (string) --
An optional comment about the revision.
CreatedAt (datetime) --
The date and time that the revision was created, in ISO 8601 format.
DataSetId (string) --
The unique identifier for the data set associated with this revision.
Finalized (boolean) --
To publish a revision to a data set in a product, the revision must first be finalized. Finalizing a revision tells AWS Data Exchange that your changes to the assets in the revision are complete. After it's in this read-only state, you can publish the revision to your products.
Finalized revisions can be published through the AWS Data Exchange console or the AWS Marketplace Catalog API, using the StartChangeSet AWS Marketplace Catalog API action. When using the API, revisions are uniquely identified by their ARN.
Id (string) --
The unique identifier for the revision.
SourceId (string) --
The revision ID of the owned revision corresponding to the entitled revision being viewed. This parameter is returned when a revision owner is viewing the entitled copy of its owned revision.
Tags (dict) --
The tags for the revision.
UpdatedAt (datetime) --
The date and time that the revision was last updated, in ISO 8601 format.
Exceptions
This operation deletes an asset.
See also: AWS API Documentation
Request Syntax
response = client.delete_asset(
AssetId='string',
DataSetId='string',
RevisionId='string'
)
[REQUIRED]
The unique identifier for an asset.
[REQUIRED]
The unique identifier for a data set.
[REQUIRED]
The unique identifier for a revision.
None
Exceptions
This operation deletes a data set.
See also: AWS API Documentation
Request Syntax
response = client.delete_data_set(
DataSetId='string'
)
[REQUIRED]
The unique identifier for a data set.
Exceptions
This operation deletes the event action.
See also: AWS API Documentation
Request Syntax
response = client.delete_event_action(
EventActionId='string'
)
[REQUIRED]
The unique identifier for the event action.
Exceptions
This operation deletes a revision.
See also: AWS API Documentation
Request Syntax
response = client.delete_revision(
DataSetId='string',
RevisionId='string'
)
[REQUIRED]
The unique identifier for a data set.
[REQUIRED]
The unique identifier for a revision.
None
Exceptions
This operation returns information about an asset.
See also: AWS API Documentation
Request Syntax
response = client.get_asset(
AssetId='string',
DataSetId='string',
RevisionId='string'
)
[REQUIRED]
The unique identifier for an asset.
[REQUIRED]
The unique identifier for a data set.
[REQUIRED]
The unique identifier for a revision.
dict
Response Syntax
{
'Arn': 'string',
'AssetDetails': {
'S3SnapshotAsset': {
'Size': 123.0
},
'RedshiftDataShareAsset': {
'Arn': 'string'
},
'ApiGatewayApiAsset': {
'ApiDescription': 'string',
'ApiEndpoint': 'string',
'ApiId': 'string',
'ApiKey': 'string',
'ApiName': 'string',
'ApiSpecificationDownloadUrl': 'string',
'ApiSpecificationDownloadUrlExpiresAt': datetime(2015, 1, 1),
'ProtocolType': 'REST',
'Stage': 'string'
}
},
'AssetType': 'S3_SNAPSHOT'|'REDSHIFT_DATA_SHARE'|'API_GATEWAY_API',
'CreatedAt': datetime(2015, 1, 1),
'DataSetId': 'string',
'Id': 'string',
'Name': 'string',
'RevisionId': 'string',
'SourceId': 'string',
'UpdatedAt': datetime(2015, 1, 1)
}
Response Structure
(dict) --
200 response
Arn (string) --
The ARN for the asset.
AssetDetails (dict) --
Information about the asset.
S3SnapshotAsset (dict) --
The S3 object that is the asset.
Size (float) --
The size of the S3 object that is the object.
RedshiftDataShareAsset (dict) --
The Amazon Redshift datashare that is the asset.
ApiGatewayApiAsset (dict) --
Information about the API Gateway API asset.
ApiDescription (string) --
The API description of the API asset.
ApiEndpoint (string) --
The API endpoint of the API asset.
ApiId (string) --
The unique identifier of the API asset.
ApiKey (string) --
The API key of the API asset.
ApiName (string) --
The API name of the API asset.
ApiSpecificationDownloadUrl (string) --
The download URL of the API specification of the API asset.
ApiSpecificationDownloadUrlExpiresAt (datetime) --
The date and time that the upload URL expires, in ISO 8601 format.
ProtocolType (string) --
The protocol type of the API asset.
Stage (string) --
The stage of the API asset.
AssetType (string) --
The type of asset that is added to a data set.
CreatedAt (datetime) --
The date and time that the asset was created, in ISO 8601 format.
DataSetId (string) --
The unique identifier for the data set associated with this asset.
Id (string) --
The unique identifier for the asset.
Name (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. When importing from Amazon API Gateway API, the API name is used as the asset name. When importing from Amazon Redshift, the datashare name is used as the asset name.
RevisionId (string) --
The unique identifier for the revision associated with this asset.
SourceId (string) --
The asset ID of the owned asset corresponding to the entitled asset being viewed. This parameter is returned when an asset owner is viewing the entitled copy of its owned asset.
UpdatedAt (datetime) --
The date and time that the asset was last updated, in ISO 8601 format.
Exceptions
This operation returns information about a data set.
See also: AWS API Documentation
Request Syntax
response = client.get_data_set(
DataSetId='string'
)
[REQUIRED]
The unique identifier for a data set.
{
'Arn': 'string',
'AssetType': 'S3_SNAPSHOT'|'REDSHIFT_DATA_SHARE'|'API_GATEWAY_API',
'CreatedAt': datetime(2015, 1, 1),
'Description': 'string',
'Id': 'string',
'Name': 'string',
'Origin': 'OWNED'|'ENTITLED',
'OriginDetails': {
'ProductId': 'string'
},
'SourceId': 'string',
'Tags': {
'string': 'string'
},
'UpdatedAt': datetime(2015, 1, 1)
}
Response Structure
200 response
The ARN for the data set.
The type of asset that is added to a data set.
The date and time that the data set was created, in ISO 8601 format.
The description for the data set.
The unique identifier for the data set.
The name of the data set.
A property that defines the data set as OWNED by the account (for providers) or ENTITLED to the account (for subscribers).
If the origin of this data set is ENTITLED, includes the details for the product on AWS Marketplace.
The product ID of the origin of the data set.
The data set ID of the owned data set corresponding to the entitled data set being viewed. This parameter is returned when a data set owner is viewing the entitled copy of its owned data set.
The tags for the data set.
The date and time that the data set was last updated, in ISO 8601 format.
Exceptions
This operation retrieves information about an event action.
See also: AWS API Documentation
Request Syntax
response = client.get_event_action(
EventActionId='string'
)
[REQUIRED]
The unique identifier for the event action.
{
'Action': {
'ExportRevisionToS3': {
'Encryption': {
'KmsKeyArn': 'string',
'Type': 'aws:kms'|'AES256'
},
'RevisionDestination': {
'Bucket': 'string',
'KeyPattern': 'string'
}
}
},
'Arn': 'string',
'CreatedAt': datetime(2015, 1, 1),
'Event': {
'RevisionPublished': {
'DataSetId': 'string'
}
},
'Id': 'string',
'UpdatedAt': datetime(2015, 1, 1)
}
Response Structure
200 response
What occurs after a certain event.
Details for the export revision to Amazon S3 action.
Encryption configuration for the auto export job.
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.
The type of server side encryption used for encrypting the objects in Amazon S3.
A revision destination is the Amazon S3 bucket folder destination to where the export will be sent.
The S3 bucket that is the destination for the event action.
A string representing the pattern for generated names of the individual assets in the revision. For more information about key patterns, see Key patterns when exporting revisions .
The ARN for the event action.
The date and time that the event action was created, in ISO 8601 format.
What occurs to start an action.
What occurs to start the revision publish action.
The data set ID of the published revision.
The unique identifier for the event action.
The date and time that the event action was last updated, in ISO 8601 format.
Exceptions
This operation returns information about a job.
See also: AWS API Documentation
Request Syntax
response = client.get_job(
JobId='string'
)
[REQUIRED]
The unique identifier for a job.
{
'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'
},
'ExportRevisionsToS3': {
'DataSetId': 'string',
'Encryption': {
'KmsKeyArn': 'string',
'Type': 'aws:kms'|'AES256'
},
'RevisionDestinations': [
{
'Bucket': 'string',
'KeyPattern': 'string',
'RevisionId': 'string'
},
],
'EventActionArn': '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'
},
'ImportAssetsFromRedshiftDataShares': {
'AssetSources': [
{
'DataShareArn': 'string'
},
],
'DataSetId': 'string',
'RevisionId': 'string'
},
'ImportAssetFromApiGatewayApi': {
'ApiDescription': 'string',
'ApiId': 'string',
'ApiKey': 'string',
'ApiName': 'string',
'ApiSpecificationMd5Hash': 'string',
'ApiSpecificationUploadUrl': 'string',
'ApiSpecificationUploadUrlExpiresAt': datetime(2015, 1, 1),
'DataSetId': 'string',
'ProtocolType': 'REST',
'RevisionId': 'string',
'Stage': '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'|'Amazon Redshift datashare assets per revision',
'LimitValue': 123.0,
'Message': 'string',
'ResourceId': 'string',
'ResourceType': 'REVISION'|'ASSET'|'DATA_SET'
},
],
'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'|'EXPORT_REVISIONS_TO_S3'|'IMPORT_ASSETS_FROM_REDSHIFT_DATA_SHARES'|'IMPORT_ASSET_FROM_API_GATEWAY_API',
'UpdatedAt': datetime(2015, 1, 1)
}
Response Structure
200 response
The ARN for the job.
The date and time that the job was created, in ISO 8601 format.
Details about the job.
Details for the export to signed URL response.
The unique identifier for the asset associated with this export job.
The unique identifier for the data set associated with this export job.
The unique identifier for the revision associated with this export response.
The signed URL for the export request.
The date and time that the signed URL expires, in ISO 8601 format.
Details for the export to Amazon S3 response.
The destination in Amazon S3 where the asset is exported.
The destination for the asset.
The unique identifier for the asset.
The S3 bucket that is the destination for the asset.
The name of the object in Amazon S3 for the asset.
The unique identifier for the data set associated with this export job.
Encryption configuration of the export job.
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.
The type of server side encryption used for encrypting the objects in Amazon S3.
The unique identifier for the revision associated with this export response.
Details for the export revisions to Amazon S3 response.
The unique identifier for the data set associated with this export job.
Encryption configuration of the export job.
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.
The type of server side encryption used for encrypting the objects in Amazon S3.
The destination in Amazon S3 where the revision is exported.
The destination where the assets in the revision will be exported.
The S3 bucket that is the destination for the assets in the revision.
A string representing the pattern for generated names of the individual assets in the revision. For more information about key patterns, see Key patterns when exporting revisions .
The unique identifier for the revision.
The Amazon Resource Name (ARN) of the event action.
Details for the import from signed URL response.
The name for the asset associated with this import job.
The unique identifier for the data set associated with this import job.
The Base64-encoded Md5 hash for the asset, used to ensure the integrity of the file at that location.
The unique identifier for the revision associated with this import response.
The signed URL.
The time and date at which the signed URL expires, in ISO 8601 format.
Details for the import from Amazon S3 response.
Is a list of Amazon S3 bucket and object key pairs.
The source of the assets.
The S3 bucket that's part of the source of the asset.
The name of the object in Amazon S3 for the asset.
The unique identifier for the data set associated with this import job.
The unique identifier for the revision associated with this import response.
Details from an import from Amazon Redshift datashare response.
The source of the Amazon Redshift datashare asset.
The response details.
The API description.
The API ID.
The API key.
The API name.
The Base64-encoded Md5 hash for the API asset, used to ensure the integrity of the API at that location.
The upload URL of the API specification.
The date and time that the upload URL expires, in ISO 8601 format.
The data set ID.
The protocol type.
The revision ID.
The API stage.
The errors associated with jobs.
The details about the job error.
Information about the job error.
Information about the job error.
Information about the job error.
The source of the assets.
The S3 bucket that's part of the source of the asset.
The name of the object in Amazon S3 for the asset.
The name of the limit that was reached.
The unique identifier for the job.
The state of the job.
The job type.
The date and time that the job was last updated, in ISO 8601 format.
Exceptions
Create a paginator for an operation.
This operation returns information about a revision.
See also: AWS API Documentation
Request Syntax
response = client.get_revision(
DataSetId='string',
RevisionId='string'
)
[REQUIRED]
The unique identifier for a data set.
[REQUIRED]
The unique identifier for a revision.
dict
Response Syntax
{
'Arn': 'string',
'Comment': 'string',
'CreatedAt': datetime(2015, 1, 1),
'DataSetId': 'string',
'Finalized': True|False,
'Id': 'string',
'SourceId': 'string',
'Tags': {
'string': 'string'
},
'UpdatedAt': datetime(2015, 1, 1)
}
Response Structure
(dict) --
200 response
Arn (string) --
The ARN for the revision.
Comment (string) --
An optional comment about the revision.
CreatedAt (datetime) --
The date and time that the revision was created, in ISO 8601 format.
DataSetId (string) --
The unique identifier for the data set associated with this revision.
Finalized (boolean) --
To publish a revision to a data set in a product, the revision must first be finalized. Finalizing a revision tells AWS Data Exchange that your changes to the assets in the revision are complete. After it's in this read-only state, you can publish the revision to your products.
Finalized revisions can be published through the AWS Data Exchange console or the AWS Marketplace Catalog API, using the StartChangeSet AWS Marketplace Catalog API action. When using the API, revisions are uniquely identified by their ARN.
Id (string) --
The unique identifier for the revision.
SourceId (string) --
The revision ID of the owned revision corresponding to the entitled revision being viewed. This parameter is returned when a revision owner is viewing the entitled copy of its owned revision.
Tags (dict) --
The tags for the revision.
UpdatedAt (datetime) --
The date and time that the revision was last updated, in ISO 8601 format.
Exceptions
Returns an object that can wait for some condition.
This operation lists a data set's revisions sorted by CreatedAt in descending order.
See also: AWS API Documentation
Request Syntax
response = client.list_data_set_revisions(
DataSetId='string',
MaxResults=123,
NextToken='string'
)
[REQUIRED]
The unique identifier for a data set.
dict
Response Syntax
{
'NextToken': 'string',
'Revisions': [
{
'Arn': 'string',
'Comment': 'string',
'CreatedAt': datetime(2015, 1, 1),
'DataSetId': 'string',
'Finalized': True|False,
'Id': 'string',
'SourceId': 'string',
'UpdatedAt': datetime(2015, 1, 1)
},
]
}
Response Structure
(dict) --
200 response
NextToken (string) --
The token value retrieved from a previous call to access the next page of results.
Revisions (list) --
The asset objects listed by the request.
(dict) --
A revision is a container for one or more assets.
Arn (string) --
The ARN for the revision.
Comment (string) --
An optional comment about the revision.
CreatedAt (datetime) --
The date and time that the revision was created, in ISO 8601 format.
DataSetId (string) --
The unique identifier for the data set associated with this revision.
Finalized (boolean) --
To publish a revision to a data set in a product, the revision must first be finalized. Finalizing a revision tells AWS Data Exchange that your changes to the assets in the revision are complete. After it's in this read-only state, you can publish the revision to your products.
Finalized revisions can be published through the AWS Data Exchange console or the AWS Marketplace Catalog API, using the StartChangeSet AWS Marketplace Catalog API action. When using the API, revisions are uniquely identified by their ARN.
Id (string) --
The unique identifier for the revision.
SourceId (string) --
The revision ID of the owned revision corresponding to the entitled revision being viewed. This parameter is returned when a revision owner is viewing the entitled copy of its owned revision.
UpdatedAt (datetime) --
The date and time that the revision was last updated, in ISO 8601 format.
Exceptions
This operation lists your data sets. When listing by origin OWNED, results are sorted by CreatedAt in descending order. When listing by origin ENTITLED, there is no order and the maxResults parameter is ignored.
See also: AWS API Documentation
Request Syntax
response = client.list_data_sets(
MaxResults=123,
NextToken='string',
Origin='string'
)
dict
Response Syntax
{
'DataSets': [
{
'Arn': 'string',
'AssetType': 'S3_SNAPSHOT'|'REDSHIFT_DATA_SHARE'|'API_GATEWAY_API',
'CreatedAt': datetime(2015, 1, 1),
'Description': 'string',
'Id': 'string',
'Name': 'string',
'Origin': 'OWNED'|'ENTITLED',
'OriginDetails': {
'ProductId': 'string'
},
'SourceId': 'string',
'UpdatedAt': datetime(2015, 1, 1)
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
200 response
DataSets (list) --
The data set objects listed by the request.
(dict) --
A data set is an AWS resource with one or more revisions.
Arn (string) --
The ARN for the data set.
AssetType (string) --
The type of asset that is added to a data set.
CreatedAt (datetime) --
The date and time that the data set was created, in ISO 8601 format.
Description (string) --
The description for the data set.
Id (string) --
The unique identifier for the data set.
Name (string) --
The name of the data set.
Origin (string) --
A property that defines the data set as OWNED by the account (for providers) or ENTITLED to the account (for subscribers).
OriginDetails (dict) --
If the origin of this data set is ENTITLED, includes the details for the product on AWS Marketplace.
ProductId (string) --
The product ID of the origin of the data set.
SourceId (string) --
The data set ID of the owned data set corresponding to the entitled data set being viewed. This parameter is returned when a data set owner is viewing the entitled copy of its owned data set.
UpdatedAt (datetime) --
The date and time that the data set was last updated, in ISO 8601 format.
NextToken (string) --
The token value retrieved from a previous call to access the next page of results.
Exceptions
This operation lists your event actions.
See also: AWS API Documentation
Request Syntax
response = client.list_event_actions(
EventSourceId='string',
MaxResults=123,
NextToken='string'
)
dict
Response Syntax
{
'EventActions': [
{
'Action': {
'ExportRevisionToS3': {
'Encryption': {
'KmsKeyArn': 'string',
'Type': 'aws:kms'|'AES256'
},
'RevisionDestination': {
'Bucket': 'string',
'KeyPattern': 'string'
}
}
},
'Arn': 'string',
'CreatedAt': datetime(2015, 1, 1),
'Event': {
'RevisionPublished': {
'DataSetId': 'string'
}
},
'Id': 'string',
'UpdatedAt': datetime(2015, 1, 1)
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
200 response
EventActions (list) --
The event action objects listed by the request.
(dict) --
An event action is an object that defines the relationship between a specific event and an automated action that will be taken on behalf of the customer.
Action (dict) --
What occurs after a certain event.
ExportRevisionToS3 (dict) --
Details for the export revision to Amazon S3 action.
Encryption (dict) --
Encryption configuration for the auto export job.
KmsKeyArn (string) --
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) --
The type of server side encryption used for encrypting the objects in Amazon S3.
RevisionDestination (dict) --
A revision destination is the Amazon S3 bucket folder destination to where the export will be sent.
Bucket (string) --
The S3 bucket that is the destination for the event action.
KeyPattern (string) --
A string representing the pattern for generated names of the individual assets in the revision. For more information about key patterns, see Key patterns when exporting revisions .
Arn (string) --
The Amazon Resource Name (ARN) for the event action.
CreatedAt (datetime) --
The date and time that the event action was created, in ISO 8601 format.
Event (dict) --
What occurs to start an action.
RevisionPublished (dict) --
What occurs to start the revision publish action.
DataSetId (string) --
The data set ID of the published revision.
Id (string) --
The unique identifier for the event action.
UpdatedAt (datetime) --
The date and time that the event action was last updated, in ISO 8601 format.
NextToken (string) --
The token value retrieved from a previous call to access the next page of results.
Exceptions
This operation lists your jobs sorted by CreatedAt in descending order.
See also: AWS API Documentation
Request Syntax
response = client.list_jobs(
DataSetId='string',
MaxResults=123,
NextToken='string',
RevisionId='string'
)
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'
},
'ExportRevisionsToS3': {
'DataSetId': 'string',
'Encryption': {
'KmsKeyArn': 'string',
'Type': 'aws:kms'|'AES256'
},
'RevisionDestinations': [
{
'Bucket': 'string',
'KeyPattern': 'string',
'RevisionId': 'string'
},
],
'EventActionArn': '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'
},
'ImportAssetsFromRedshiftDataShares': {
'AssetSources': [
{
'DataShareArn': 'string'
},
],
'DataSetId': 'string',
'RevisionId': 'string'
},
'ImportAssetFromApiGatewayApi': {
'ApiDescription': 'string',
'ApiId': 'string',
'ApiKey': 'string',
'ApiName': 'string',
'ApiSpecificationMd5Hash': 'string',
'ApiSpecificationUploadUrl': 'string',
'ApiSpecificationUploadUrlExpiresAt': datetime(2015, 1, 1),
'DataSetId': 'string',
'ProtocolType': 'REST',
'RevisionId': 'string',
'Stage': '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'|'Amazon Redshift datashare assets per revision',
'LimitValue': 123.0,
'Message': 'string',
'ResourceId': 'string',
'ResourceType': 'REVISION'|'ASSET'|'DATA_SET'
},
],
'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'|'EXPORT_REVISIONS_TO_S3'|'IMPORT_ASSETS_FROM_REDSHIFT_DATA_SHARES'|'IMPORT_ASSET_FROM_API_GATEWAY_API',
'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 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.
ExportRevisionsToS3 (dict) --
Details for the export revisions to Amazon S3 response.
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 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.
RevisionDestinations (list) --
The destination in Amazon S3 where the revision is exported.
(dict) --
The destination where the assets in the revision will be exported.
Bucket (string) --
The S3 bucket that is the destination for the assets in the revision.
KeyPattern (string) --
A string representing the pattern for generated names of the individual assets in the revision. For more information about key patterns, see Key patterns when exporting revisions .
RevisionId (string) --
The unique identifier for the revision.
EventActionArn (string) --
The Amazon Resource Name (ARN) of the event action.
ImportAssetFromSignedUrl (dict) --
Details for the import from signed URL response.
AssetName (string) --
The name for the asset associated with this import job.
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.
ImportAssetsFromRedshiftDataShares (dict) --
Details from an import from Amazon Redshift datashare response.
AssetSources (list) -- A list of Amazon Redshift datashare asset sources.
(dict) --
The source of the Amazon Redshift datashare 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 job.
ImportAssetFromApiGatewayApi (dict) --
The response details.
ApiDescription (string) --
The API description.
ApiId (string) --
The API ID.
ApiKey (string) --
The API key.
ApiName (string) --
The API name.
ApiSpecificationMd5Hash (string) --
The Base64-encoded Md5 hash for the API asset, used to ensure the integrity of the API at that location.
ApiSpecificationUploadUrl (string) --
The upload URL of the API specification.
ApiSpecificationUploadUrlExpiresAt (datetime) --
The date and time that the upload URL expires, in ISO 8601 format.
DataSetId (string) --
The data set ID.
ProtocolType (string) --
The protocol type.
RevisionId (string) --
The revision ID.
Stage (string) --
The API stage.
Errors (list) --
Errors for jobs.
(dict) -- An error that occurred with the job request.
Code (string) -- The code for the job error.
Details (dict) --
The details about the job error.
ImportAssetFromSignedUrlJobErrorDetails (dict) --
Information about the job error.
AssetName (string) --
Information about the job error.
ImportAssetsFromS3JobErrorDetails (list) --
Information about the job error.
(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.
Exceptions
This operation lists a revision's assets sorted alphabetically in descending order.
See also: AWS API Documentation
Request Syntax
response = client.list_revision_assets(
DataSetId='string',
MaxResults=123,
NextToken='string',
RevisionId='string'
)
[REQUIRED]
The unique identifier for a data set.
[REQUIRED]
The unique identifier for a revision.
dict
Response Syntax
{
'Assets': [
{
'Arn': 'string',
'AssetDetails': {
'S3SnapshotAsset': {
'Size': 123.0
},
'RedshiftDataShareAsset': {
'Arn': 'string'
},
'ApiGatewayApiAsset': {
'ApiDescription': 'string',
'ApiEndpoint': 'string',
'ApiId': 'string',
'ApiKey': 'string',
'ApiName': 'string',
'ApiSpecificationDownloadUrl': 'string',
'ApiSpecificationDownloadUrlExpiresAt': datetime(2015, 1, 1),
'ProtocolType': 'REST',
'Stage': 'string'
}
},
'AssetType': 'S3_SNAPSHOT'|'REDSHIFT_DATA_SHARE'|'API_GATEWAY_API',
'CreatedAt': datetime(2015, 1, 1),
'DataSetId': 'string',
'Id': 'string',
'Name': 'string',
'RevisionId': 'string',
'SourceId': 'string',
'UpdatedAt': datetime(2015, 1, 1)
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
200 response
Assets (list) --
The asset objects listed by the request.
(dict) --
An asset in AWS Data Exchange is a piece of data (S3 object) or a means of fulfilling data (Amazon Redshift datashare or Amazon API Gateway API). The asset can be a structured data file, an image file, or some other data file that can be stored as an S3 object, an Amazon API Gateway API, or an Amazon Redshift datashare (Preview). When you create an import job for your files, API Gateway APIs, or Amazon Redshift datashares, you create an asset in AWS Data Exchange.
Arn (string) --
The ARN for the asset.
AssetDetails (dict) --
Information about the asset.
S3SnapshotAsset (dict) --
The S3 object that is the asset.
Size (float) --
The size of the S3 object that is the object.
RedshiftDataShareAsset (dict) --
The Amazon Redshift datashare that is the asset.
ApiGatewayApiAsset (dict) --
Information about the API Gateway API asset.
ApiDescription (string) --
The API description of the API asset.
ApiEndpoint (string) --
The API endpoint of the API asset.
ApiId (string) --
The unique identifier of the API asset.
ApiKey (string) --
The API key of the API asset.
ApiName (string) --
The API name of the API asset.
ApiSpecificationDownloadUrl (string) --
The download URL of the API specification of the API asset.
ApiSpecificationDownloadUrlExpiresAt (datetime) --
The date and time that the upload URL expires, in ISO 8601 format.
ProtocolType (string) --
The protocol type of the API asset.
Stage (string) --
The stage of the API asset.
AssetType (string) --
The type of asset that is added to a data set.
CreatedAt (datetime) --
The date and time that the asset was created, in ISO 8601 format.
DataSetId (string) --
The unique identifier for the data set associated with this asset.
Id (string) --
The unique identifier for the asset.
Name (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. When importing from Amazon API Gateway API, the API name is used as the asset name. When importing from Amazon Redshift, the datashare name is used as the asset name.
RevisionId (string) --
The unique identifier for the revision associated with this asset.
SourceId (string) --
The asset ID of the owned asset corresponding to the entitled asset being viewed. This parameter is returned when an asset owner is viewing the entitled copy of its owned asset.
UpdatedAt (datetime) --
The date and time that the asset was last updated, in ISO 8601 format.
NextToken (string) --
The token value retrieved from a previous call to access the next page of results.
Exceptions
This operation lists the tags on the resource.
See also: AWS API Documentation
Request Syntax
response = client.list_tags_for_resource(
ResourceArn='string'
)
[REQUIRED]
An Amazon Resource Name (ARN) that uniquely identifies an AWS resource.
{
'Tags': {
'string': 'string'
}
}
Response Structure
200 response
This operation invokes an API Gateway API asset. The request is proxied to the provider’s API Gateway API.
See also: AWS API Documentation
Request Syntax
response = client.send_api_asset(
Body='string',
QueryStringParameters={
'string': 'string'
},
AssetId='string',
DataSetId='string',
RequestHeaders={
'string': 'string'
},
Method='string',
Path='string',
RevisionId='string'
)
Attach query string parameters to the end of the URI (for example, /v1/examplePath?exampleParam=exampleValue).
[REQUIRED]
Asset ID value for the API request.
[REQUIRED]
Data set ID value for the API request.
Any header value prefixed with x-amzn-dataexchange-header- will have that stripped before sending the Asset API request. Use this when you want to override a header that AWS Data Exchange uses. Alternatively, you can use the header without a prefix to the HTTP request.
[REQUIRED]
Revision ID value for the API request.
dict
Response Syntax
{
'Body': 'string',
'ResponseHeaders': {
'string': 'string'
}
}
Response Structure
(dict) --
200 response
Body (string) --
The response body from the underlying API tracked by the API asset.
ResponseHeaders (dict) --
The response headers from the underlying API tracked by the API asset.
Exceptions
This operation starts a job.
See also: AWS API Documentation
Request Syntax
response = client.start_job(
JobId='string'
)
[REQUIRED]
The unique identifier for a job.
{}
Response Structure
202 response
Exceptions
This operation tags a resource.
See also: AWS API Documentation
Request Syntax
response = client.tag_resource(
ResourceArn='string',
Tags={
'string': 'string'
}
)
[REQUIRED]
An Amazon Resource Name (ARN) that uniquely identifies an AWS resource.
[REQUIRED] A label that consists of a customer-defined key and an optional value.
None
This operation removes one or more tags from a resource.
See also: AWS API Documentation
Request Syntax
response = client.untag_resource(
ResourceArn='string',
TagKeys=[
'string',
]
)
[REQUIRED]
An Amazon Resource Name (ARN) that uniquely identifies an AWS resource.
[REQUIRED] The key tags.
None
This operation updates an asset.
See also: AWS API Documentation
Request Syntax
response = client.update_asset(
AssetId='string',
DataSetId='string',
Name='string',
RevisionId='string'
)
[REQUIRED]
The unique identifier for an asset.
[REQUIRED]
The unique identifier for a data set.
[REQUIRED]
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. When importing from Amazon API Gateway API, the API name is used as the asset name. When importing from Amazon Redshift, the datashare name is used as the asset name.
[REQUIRED]
The unique identifier for a revision.
dict
Response Syntax
{
'Arn': 'string',
'AssetDetails': {
'S3SnapshotAsset': {
'Size': 123.0
},
'RedshiftDataShareAsset': {
'Arn': 'string'
},
'ApiGatewayApiAsset': {
'ApiDescription': 'string',
'ApiEndpoint': 'string',
'ApiId': 'string',
'ApiKey': 'string',
'ApiName': 'string',
'ApiSpecificationDownloadUrl': 'string',
'ApiSpecificationDownloadUrlExpiresAt': datetime(2015, 1, 1),
'ProtocolType': 'REST',
'Stage': 'string'
}
},
'AssetType': 'S3_SNAPSHOT'|'REDSHIFT_DATA_SHARE'|'API_GATEWAY_API',
'CreatedAt': datetime(2015, 1, 1),
'DataSetId': 'string',
'Id': 'string',
'Name': 'string',
'RevisionId': 'string',
'SourceId': 'string',
'UpdatedAt': datetime(2015, 1, 1)
}
Response Structure
(dict) --
200 response
Arn (string) --
The ARN for the asset.
AssetDetails (dict) --
Information about the asset.
S3SnapshotAsset (dict) --
The S3 object that is the asset.
Size (float) --
The size of the S3 object that is the object.
RedshiftDataShareAsset (dict) --
The Amazon Redshift datashare that is the asset.
ApiGatewayApiAsset (dict) --
Information about the API Gateway API asset.
ApiDescription (string) --
The API description of the API asset.
ApiEndpoint (string) --
The API endpoint of the API asset.
ApiId (string) --
The unique identifier of the API asset.
ApiKey (string) --
The API key of the API asset.
ApiName (string) --
The API name of the API asset.
ApiSpecificationDownloadUrl (string) --
The download URL of the API specification of the API asset.
ApiSpecificationDownloadUrlExpiresAt (datetime) --
The date and time that the upload URL expires, in ISO 8601 format.
ProtocolType (string) --
The protocol type of the API asset.
Stage (string) --
The stage of the API asset.
AssetType (string) --
The type of asset that is added to a data set.
CreatedAt (datetime) --
The date and time that the asset was created, in ISO 8601 format.
DataSetId (string) --
The unique identifier for the data set associated with this asset.
Id (string) --
The unique identifier for the asset.
Name (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. When importing from Amazon API Gateway API, the API name is used as the asset name. When importing from Amazon Redshift, the datashare name is used as the asset name.
RevisionId (string) --
The unique identifier for the revision associated with this asset.
SourceId (string) --
The asset ID of the owned asset corresponding to the entitled asset being viewed. This parameter is returned when an asset owner is viewing the entitled copy of its owned asset.
UpdatedAt (datetime) --
The date and time that the asset was last updated, in ISO 8601 format.
Exceptions
This operation updates a data set.
See also: AWS API Documentation
Request Syntax
response = client.update_data_set(
DataSetId='string',
Description='string',
Name='string'
)
[REQUIRED]
The unique identifier for a data set.
dict
Response Syntax
{
'Arn': 'string',
'AssetType': 'S3_SNAPSHOT'|'REDSHIFT_DATA_SHARE'|'API_GATEWAY_API',
'CreatedAt': datetime(2015, 1, 1),
'Description': 'string',
'Id': 'string',
'Name': 'string',
'Origin': 'OWNED'|'ENTITLED',
'OriginDetails': {
'ProductId': 'string'
},
'SourceId': 'string',
'UpdatedAt': datetime(2015, 1, 1)
}
Response Structure
(dict) --
200 response
Arn (string) --
The ARN for the data set.
AssetType (string) --
The type of asset that is added to a data set.
CreatedAt (datetime) --
The date and time that the data set was created, in ISO 8601 format.
Description (string) --
The description for the data set.
Id (string) --
The unique identifier for the data set.
Name (string) --
The name of the data set.
Origin (string) --
A property that defines the data set as OWNED by the account (for providers) or ENTITLED to the account (for subscribers).
OriginDetails (dict) --
If the origin of this data set is ENTITLED, includes the details for the product on AWS Marketplace.
ProductId (string) --
The product ID of the origin of the data set.
SourceId (string) --
The data set ID of the owned data set corresponding to the entitled data set being viewed. This parameter is returned when a data set owner is viewing the entitled copy of its owned data set.
UpdatedAt (datetime) --
The date and time that the data set was last updated, in ISO 8601 format.
Exceptions
This operation updates the event action.
See also: AWS API Documentation
Request Syntax
response = client.update_event_action(
Action={
'ExportRevisionToS3': {
'Encryption': {
'KmsKeyArn': 'string',
'Type': 'aws:kms'|'AES256'
},
'RevisionDestination': {
'Bucket': 'string',
'KeyPattern': 'string'
}
}
},
EventActionId='string'
)
What occurs after a certain event.
Details for the export revision to Amazon S3 action.
Encryption configuration for the auto export job.
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.
The type of server side encryption used for encrypting the objects in Amazon S3.
A revision destination is the Amazon S3 bucket folder destination to where the export will be sent.
The S3 bucket that is the destination for the event action.
A string representing the pattern for generated names of the individual assets in the revision. For more information about key patterns, see Key patterns when exporting revisions .
[REQUIRED]
The unique identifier for the event action.
dict
Response Syntax
{
'Action': {
'ExportRevisionToS3': {
'Encryption': {
'KmsKeyArn': 'string',
'Type': 'aws:kms'|'AES256'
},
'RevisionDestination': {
'Bucket': 'string',
'KeyPattern': 'string'
}
}
},
'Arn': 'string',
'CreatedAt': datetime(2015, 1, 1),
'Event': {
'RevisionPublished': {
'DataSetId': 'string'
}
},
'Id': 'string',
'UpdatedAt': datetime(2015, 1, 1)
}
Response Structure
(dict) --
200 response
Action (dict) --
What occurs after a certain event.
ExportRevisionToS3 (dict) --
Details for the export revision to Amazon S3 action.
Encryption (dict) --
Encryption configuration for the auto export job.
KmsKeyArn (string) --
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) --
The type of server side encryption used for encrypting the objects in Amazon S3.
RevisionDestination (dict) --
A revision destination is the Amazon S3 bucket folder destination to where the export will be sent.
Bucket (string) --
The S3 bucket that is the destination for the event action.
KeyPattern (string) --
A string representing the pattern for generated names of the individual assets in the revision. For more information about key patterns, see Key patterns when exporting revisions .
Arn (string) --
The ARN for the event action.
CreatedAt (datetime) --
The date and time that the event action was created, in ISO 8601 format.
Event (dict) --
What occurs to start an action.
RevisionPublished (dict) --
What occurs to start the revision publish action.
DataSetId (string) --
The data set ID of the published revision.
Id (string) --
The unique identifier for the event action.
UpdatedAt (datetime) --
The date and time that the event action was last updated, in ISO 8601 format.
Exceptions
This operation updates a revision.
See also: AWS API Documentation
Request Syntax
response = client.update_revision(
Comment='string',
DataSetId='string',
Finalized=True|False,
RevisionId='string'
)
[REQUIRED]
The unique identifier for a data set.
[REQUIRED]
The unique identifier for a revision.
dict
Response Syntax
{
'Arn': 'string',
'Comment': 'string',
'CreatedAt': datetime(2015, 1, 1),
'DataSetId': 'string',
'Finalized': True|False,
'Id': 'string',
'SourceId': 'string',
'UpdatedAt': datetime(2015, 1, 1)
}
Response Structure
(dict) --
200 response
Arn (string) --
The ARN for the revision.
Comment (string) --
An optional comment about the revision.
CreatedAt (datetime) --
The date and time that the revision was created, in ISO 8601 format.
DataSetId (string) --
The unique identifier for the data set associated with this revision.
Finalized (boolean) --
To publish a revision to a data set in a product, the revision must first be finalized. Finalizing a revision tells AWS Data Exchange that changes to the assets in the revision are complete. After it's in this read-only state, you can publish the revision to your products.
Finalized revisions can be published through the AWS Data Exchange console or the AWS Marketplace Catalog API, using the StartChangeSet AWS Marketplace Catalog API action. When using the API, revisions are uniquely identified by their ARN.
Id (string) --
The unique identifier for the revision.
SourceId (string) --
The revision ID of the owned revision corresponding to the entitled revision being viewed. This parameter is returned when a revision owner is viewing the entitled copy of its owned revision.
UpdatedAt (datetime) --
The date and time that the revision was last updated, in ISO 8601 format.
Exceptions
The available paginators are:
paginator = client.get_paginator('list_data_set_revisions')
Creates an iterator that will paginate through responses from DataExchange.Client.list_data_set_revisions().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
DataSetId='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The unique identifier for a data set.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'Revisions': [
{
'Arn': 'string',
'Comment': 'string',
'CreatedAt': datetime(2015, 1, 1),
'DataSetId': 'string',
'Finalized': True|False,
'Id': 'string',
'SourceId': 'string',
'UpdatedAt': datetime(2015, 1, 1)
},
]
}
Response Structure
(dict) --
200 response
Revisions (list) --
The asset objects listed by the request.
(dict) --
A revision is a container for one or more assets.
Arn (string) --
The ARN for the revision.
Comment (string) --
An optional comment about the revision.
CreatedAt (datetime) --
The date and time that the revision was created, in ISO 8601 format.
DataSetId (string) --
The unique identifier for the data set associated with this revision.
Finalized (boolean) --
To publish a revision to a data set in a product, the revision must first be finalized. Finalizing a revision tells AWS Data Exchange that your changes to the assets in the revision are complete. After it's in this read-only state, you can publish the revision to your products.
Finalized revisions can be published through the AWS Data Exchange console or the AWS Marketplace Catalog API, using the StartChangeSet AWS Marketplace Catalog API action. When using the API, revisions are uniquely identified by their ARN.
Id (string) --
The unique identifier for the revision.
SourceId (string) --
The revision ID of the owned revision corresponding to the entitled revision being viewed. This parameter is returned when a revision owner is viewing the entitled copy of its owned revision.
UpdatedAt (datetime) --
The date and time that the revision was last updated, in ISO 8601 format.
paginator = client.get_paginator('list_data_sets')
Creates an iterator that will paginate through responses from DataExchange.Client.list_data_sets().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
Origin='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'DataSets': [
{
'Arn': 'string',
'AssetType': 'S3_SNAPSHOT'|'REDSHIFT_DATA_SHARE'|'API_GATEWAY_API',
'CreatedAt': datetime(2015, 1, 1),
'Description': 'string',
'Id': 'string',
'Name': 'string',
'Origin': 'OWNED'|'ENTITLED',
'OriginDetails': {
'ProductId': 'string'
},
'SourceId': 'string',
'UpdatedAt': datetime(2015, 1, 1)
},
],
}
Response Structure
(dict) --
200 response
DataSets (list) --
The data set objects listed by the request.
(dict) --
A data set is an AWS resource with one or more revisions.
Arn (string) --
The ARN for the data set.
AssetType (string) --
The type of asset that is added to a data set.
CreatedAt (datetime) --
The date and time that the data set was created, in ISO 8601 format.
Description (string) --
The description for the data set.
Id (string) --
The unique identifier for the data set.
Name (string) --
The name of the data set.
Origin (string) --
A property that defines the data set as OWNED by the account (for providers) or ENTITLED to the account (for subscribers).
OriginDetails (dict) --
If the origin of this data set is ENTITLED, includes the details for the product on AWS Marketplace.
ProductId (string) --
The product ID of the origin of the data set.
SourceId (string) --
The data set ID of the owned data set corresponding to the entitled data set being viewed. This parameter is returned when a data set owner is viewing the entitled copy of its owned data set.
UpdatedAt (datetime) --
The date and time that the data set was last updated, in ISO 8601 format.
paginator = client.get_paginator('list_event_actions')
Creates an iterator that will paginate through responses from DataExchange.Client.list_event_actions().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
EventSourceId='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'EventActions': [
{
'Action': {
'ExportRevisionToS3': {
'Encryption': {
'KmsKeyArn': 'string',
'Type': 'aws:kms'|'AES256'
},
'RevisionDestination': {
'Bucket': 'string',
'KeyPattern': 'string'
}
}
},
'Arn': 'string',
'CreatedAt': datetime(2015, 1, 1),
'Event': {
'RevisionPublished': {
'DataSetId': 'string'
}
},
'Id': 'string',
'UpdatedAt': datetime(2015, 1, 1)
},
],
}
Response Structure
(dict) --
200 response
EventActions (list) --
The event action objects listed by the request.
(dict) --
An event action is an object that defines the relationship between a specific event and an automated action that will be taken on behalf of the customer.
Action (dict) --
What occurs after a certain event.
ExportRevisionToS3 (dict) --
Details for the export revision to Amazon S3 action.
Encryption (dict) --
Encryption configuration for the auto export job.
KmsKeyArn (string) --
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) --
The type of server side encryption used for encrypting the objects in Amazon S3.
RevisionDestination (dict) --
A revision destination is the Amazon S3 bucket folder destination to where the export will be sent.
Bucket (string) --
The S3 bucket that is the destination for the event action.
KeyPattern (string) --
A string representing the pattern for generated names of the individual assets in the revision. For more information about key patterns, see Key patterns when exporting revisions .
Arn (string) --
The Amazon Resource Name (ARN) for the event action.
CreatedAt (datetime) --
The date and time that the event action was created, in ISO 8601 format.
Event (dict) --
What occurs to start an action.
RevisionPublished (dict) --
What occurs to start the revision publish action.
DataSetId (string) --
The data set ID of the published revision.
Id (string) --
The unique identifier for the event action.
UpdatedAt (datetime) --
The date and time that the event action was last updated, in ISO 8601 format.
paginator = client.get_paginator('list_jobs')
Creates an iterator that will paginate through responses from DataExchange.Client.list_jobs().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
DataSetId='string',
RevisionId='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
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'
},
'ExportRevisionsToS3': {
'DataSetId': 'string',
'Encryption': {
'KmsKeyArn': 'string',
'Type': 'aws:kms'|'AES256'
},
'RevisionDestinations': [
{
'Bucket': 'string',
'KeyPattern': 'string',
'RevisionId': 'string'
},
],
'EventActionArn': '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'
},
'ImportAssetsFromRedshiftDataShares': {
'AssetSources': [
{
'DataShareArn': 'string'
},
],
'DataSetId': 'string',
'RevisionId': 'string'
},
'ImportAssetFromApiGatewayApi': {
'ApiDescription': 'string',
'ApiId': 'string',
'ApiKey': 'string',
'ApiName': 'string',
'ApiSpecificationMd5Hash': 'string',
'ApiSpecificationUploadUrl': 'string',
'ApiSpecificationUploadUrlExpiresAt': datetime(2015, 1, 1),
'DataSetId': 'string',
'ProtocolType': 'REST',
'RevisionId': 'string',
'Stage': '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'|'Amazon Redshift datashare assets per revision',
'LimitValue': 123.0,
'Message': 'string',
'ResourceId': 'string',
'ResourceType': 'REVISION'|'ASSET'|'DATA_SET'
},
],
'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'|'EXPORT_REVISIONS_TO_S3'|'IMPORT_ASSETS_FROM_REDSHIFT_DATA_SHARES'|'IMPORT_ASSET_FROM_API_GATEWAY_API',
'UpdatedAt': datetime(2015, 1, 1)
},
],
}
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 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.
ExportRevisionsToS3 (dict) --
Details for the export revisions to Amazon S3 response.
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 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.
RevisionDestinations (list) --
The destination in Amazon S3 where the revision is exported.
(dict) --
The destination where the assets in the revision will be exported.
Bucket (string) --
The S3 bucket that is the destination for the assets in the revision.
KeyPattern (string) --
A string representing the pattern for generated names of the individual assets in the revision. For more information about key patterns, see Key patterns when exporting revisions .
RevisionId (string) --
The unique identifier for the revision.
EventActionArn (string) --
The Amazon Resource Name (ARN) of the event action.
ImportAssetFromSignedUrl (dict) --
Details for the import from signed URL response.
AssetName (string) --
The name for the asset associated with this import job.
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.
ImportAssetsFromRedshiftDataShares (dict) --
Details from an import from Amazon Redshift datashare response.
AssetSources (list) -- A list of Amazon Redshift datashare asset sources.
(dict) --
The source of the Amazon Redshift datashare 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 job.
ImportAssetFromApiGatewayApi (dict) --
The response details.
ApiDescription (string) --
The API description.
ApiId (string) --
The API ID.
ApiKey (string) --
The API key.
ApiName (string) --
The API name.
ApiSpecificationMd5Hash (string) --
The Base64-encoded Md5 hash for the API asset, used to ensure the integrity of the API at that location.
ApiSpecificationUploadUrl (string) --
The upload URL of the API specification.
ApiSpecificationUploadUrlExpiresAt (datetime) --
The date and time that the upload URL expires, in ISO 8601 format.
DataSetId (string) --
The data set ID.
ProtocolType (string) --
The protocol type.
RevisionId (string) --
The revision ID.
Stage (string) --
The API stage.
Errors (list) --
Errors for jobs.
(dict) -- An error that occurred with the job request.
Code (string) -- The code for the job error.
Details (dict) --
The details about the job error.
ImportAssetFromSignedUrlJobErrorDetails (dict) --
Information about the job error.
AssetName (string) --
Information about the job error.
ImportAssetsFromS3JobErrorDetails (list) --
Information about the job error.
(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.
paginator = client.get_paginator('list_revision_assets')
Creates an iterator that will paginate through responses from DataExchange.Client.list_revision_assets().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
DataSetId='string',
RevisionId='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The unique identifier for a data set.
[REQUIRED]
The unique identifier for a revision.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'Assets': [
{
'Arn': 'string',
'AssetDetails': {
'S3SnapshotAsset': {
'Size': 123.0
},
'RedshiftDataShareAsset': {
'Arn': 'string'
},
'ApiGatewayApiAsset': {
'ApiDescription': 'string',
'ApiEndpoint': 'string',
'ApiId': 'string',
'ApiKey': 'string',
'ApiName': 'string',
'ApiSpecificationDownloadUrl': 'string',
'ApiSpecificationDownloadUrlExpiresAt': datetime(2015, 1, 1),
'ProtocolType': 'REST',
'Stage': 'string'
}
},
'AssetType': 'S3_SNAPSHOT'|'REDSHIFT_DATA_SHARE'|'API_GATEWAY_API',
'CreatedAt': datetime(2015, 1, 1),
'DataSetId': 'string',
'Id': 'string',
'Name': 'string',
'RevisionId': 'string',
'SourceId': 'string',
'UpdatedAt': datetime(2015, 1, 1)
},
],
}
Response Structure
(dict) --
200 response
Assets (list) --
The asset objects listed by the request.
(dict) --
An asset in AWS Data Exchange is a piece of data (S3 object) or a means of fulfilling data (Amazon Redshift datashare or Amazon API Gateway API). The asset can be a structured data file, an image file, or some other data file that can be stored as an S3 object, an Amazon API Gateway API, or an Amazon Redshift datashare (Preview). When you create an import job for your files, API Gateway APIs, or Amazon Redshift datashares, you create an asset in AWS Data Exchange.
Arn (string) --
The ARN for the asset.
AssetDetails (dict) --
Information about the asset.
S3SnapshotAsset (dict) --
The S3 object that is the asset.
Size (float) --
The size of the S3 object that is the object.
RedshiftDataShareAsset (dict) --
The Amazon Redshift datashare that is the asset.
ApiGatewayApiAsset (dict) --
Information about the API Gateway API asset.
ApiDescription (string) --
The API description of the API asset.
ApiEndpoint (string) --
The API endpoint of the API asset.
ApiId (string) --
The unique identifier of the API asset.
ApiKey (string) --
The API key of the API asset.
ApiName (string) --
The API name of the API asset.
ApiSpecificationDownloadUrl (string) --
The download URL of the API specification of the API asset.
ApiSpecificationDownloadUrlExpiresAt (datetime) --
The date and time that the upload URL expires, in ISO 8601 format.
ProtocolType (string) --
The protocol type of the API asset.
Stage (string) --
The stage of the API asset.
AssetType (string) --
The type of asset that is added to a data set.
CreatedAt (datetime) --
The date and time that the asset was created, in ISO 8601 format.
DataSetId (string) --
The unique identifier for the data set associated with this asset.
Id (string) --
The unique identifier for the asset.
Name (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. When importing from Amazon API Gateway API, the API name is used as the asset name. When importing from Amazon Redshift, the datashare name is used as the asset name.
RevisionId (string) --
The unique identifier for the revision associated with this asset.
SourceId (string) --
The asset ID of the owned asset corresponding to the entitled asset being viewed. This parameter is returned when an asset owner is viewing the entitled copy of its owned asset.
UpdatedAt (datetime) --
The date and time that the asset was last updated, in ISO 8601 format.