DataExchange ¶

Table of Contents

DataExchange
- Client
- Paginators

Client ¶

class DataExchange.Client¶

A low-level client representing AWS Data Exchange:

import boto3

client = boto3.client('dataexchange')

These are the available methods:

can_paginate(operation_name)¶

Check if an operation can be paginated.

Parameters: operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Returns: True if the operation can be paginated, False otherwise.

cancel_job(**kwargs)¶

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'
)

Parameters

JobId (string) --

[REQUIRED]

The unique identifier for a job.

Returns

None

create_data_set(**kwargs)¶

This operation creates a data set.

See also: AWS API Documentation

Request Syntax

response = client.create_data_set(
    AssetType='S3_SNAPSHOT',
    Description='string',
    Name='string',
    Tags={
        'string': 'string'
    }
)

Parameters

AssetType (string) --
[REQUIRED]

The type of file your data is stored in. Currently, the supported asset type is S3_SNAPSHOT.
Description (string) --
[REQUIRED]

A description for the data set. This value can be up to 16,348 characters long.
Name (string) --
[REQUIRED]

The name of the data set.
Tags (dict) --
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.
- (string) --
  - (string) --

Return type

dict

Returns

Response Syntax

{
    'Arn': 'string',
    'AssetType': 'S3_SNAPSHOT',
    '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 file your data is stored in. Currently, the supported asset type is S3_SNAPSHOT.
- 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) --
- 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.
  - (string) --
    - (string) --
- UpdatedAt (datetime) --
  
  The date and time that the data set was last updated, in ISO 8601 format.

create_job(**kwargs)¶

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',
            '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'
)

Parameters

Details (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.
  - 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.
Type (string) --
[REQUIRED]

The type of job to be created.

Return type

dict

Returns

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',
            '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.
    - 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 unqiue 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.

create_revision(**kwargs)¶

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'
    }
)

Parameters

Comment (string) -- An optional comment about the revision.
DataSetId (string) --
[REQUIRED]

The unique identifier for a data set.
Tags (dict) --
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.
- (string) --
  - (string) --

Return type

dict

Returns

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.
  - (string) --
    - (string) --
- UpdatedAt (datetime) --
  
  The date and time that the revision was last updated, in ISO 8601 format.

delete_asset(**kwargs)¶

This operation deletes an asset.

See also: AWS API Documentation

Request Syntax

response = client.delete_asset(
    AssetId='string',
    DataSetId='string',
    RevisionId='string'
)

Parameters

AssetId (string) --
[REQUIRED]

The unique identifier for an asset.
DataSetId (string) --
[REQUIRED]

The unique identifier for a data set.
RevisionId (string) --
[REQUIRED]

The unique identifier for a revision.

Returns

None

delete_data_set(**kwargs)¶

This operation deletes a data set.

See also: AWS API Documentation

Request Syntax

response = client.delete_data_set(
    DataSetId='string'
)

Parameters

DataSetId (string) --

[REQUIRED]

The unique identifier for a data set.

Returns

None

delete_revision(**kwargs)¶

This operation deletes a revision.

See also: AWS API Documentation

Request Syntax

response = client.delete_revision(
    DataSetId='string',
    RevisionId='string'
)

Parameters

DataSetId (string) --
[REQUIRED]

The unique identifier for a data set.
RevisionId (string) --
[REQUIRED]

The unique identifier for a revision.

Returns

None

generate_presigned_url(ClientMethod, Params=None, ExpiresIn=3600, HttpMethod=None)¶

Generate a presigned url given a client, its method, and arguments

Parameters

ClientMethod (string) -- The client method to presign for
Params (dict) -- The parameters normally passed to ClientMethod.
ExpiresIn (int) -- The number of seconds the presigned url is valid for. By default it expires in an hour (3600 seconds)
HttpMethod (string) -- The http method to use on the generated url. By default, the http method is whatever is used in the method's model.

Returns

The presigned url

get_asset(**kwargs)¶

This operation returns information about an asset.

See also: AWS API Documentation

Request Syntax

response = client.get_asset(
    AssetId='string',
    DataSetId='string',
    RevisionId='string'
)

Parameters

AssetId (string) --
[REQUIRED]

The unique identifier for an asset.
DataSetId (string) --
[REQUIRED]

The unique identifier for a data set.
RevisionId (string) --
[REQUIRED]

The unique identifier for a revision.

Return type

dict

Returns

Response Syntax

{
    'Arn': 'string',
    'AssetDetails': {
        'S3SnapshotAsset': {
            'Size': 123.0
        }
    },
    'AssetType': 'S3_SNAPSHOT',
    '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, including its size.
  - S3SnapshotAsset (dict) --
    
    The S3 object that is the asset.
    - Size (float) --
      
      The size of the S3 object that is the object.
- AssetType (string) --
  
  The type of file your data is stored in. Currently, the supported asset type is S3_SNAPSHOT.
- 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.
- 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.

get_data_set(**kwargs)¶

This operation returns information about a data set.

See also: AWS API Documentation

Request Syntax

response = client.get_data_set(
    DataSetId='string'
)

Parameters

DataSetId (string) --

[REQUIRED]

The unique identifier for a data set.

Return type

dict

Returns

Response Syntax

{
    'Arn': 'string',
    'AssetType': 'S3_SNAPSHOT',
    '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) --
200 response
- Arn (string) --
  The ARN for the data set.
- AssetType (string) --
  The type of file your data is stored in. Currently, the supported asset type is S3_SNAPSHOT.
- 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) --
- 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.
  - (string) --
    - (string) --
- UpdatedAt (datetime) --
  The date and time that the data set was last updated, in ISO 8601 format.

get_job(**kwargs)¶

This operation returns information about a job.

See also: AWS API Documentation

Request Syntax

response = client.get_job(
    JobId='string'
)

Parameters

JobId (string) --

[REQUIRED]

The unique identifier for a job.

Return type

dict

Returns

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',
            '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.
    - 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 unqiue 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.

get_paginator(operation_name)¶

Create a paginator for an operation.

Parameters: operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Raises OperationNotPageableError: Raised if the operation is not pageable. You can use the client.can_paginate method to check if an operation is pageable.
Return type: L{botocore.paginate.Paginator}
Returns: A paginator object.

get_revision(**kwargs)¶

This operation returns information about a revision.

See also: AWS API Documentation

Request Syntax

response = client.get_revision(
    DataSetId='string',
    RevisionId='string'
)

Parameters

DataSetId (string) --
[REQUIRED]

The unique identifier for a data set.
RevisionId (string) --
[REQUIRED]

The unique identifier for a revision.

Return type

dict

Returns

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.
  - (string) --
    - (string) --
- UpdatedAt (datetime) --
  
  The date and time that the revision was last updated, in ISO 8601 format.

get_waiter(waiter_name)¶

Returns an object that can wait for some condition.

Parameters: waiter_name (str) -- The name of the waiter to get. See the waiters section of the service docs for a list of available waiters.
Returns: The specified waiter object.
Return type: botocore.waiter.Waiter

list_data_set_revisions(**kwargs)¶

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'
)

Parameters

DataSetId (string) --
[REQUIRED]

The unique identifier for a data set.
MaxResults (integer) -- The maximum number of results returned by a single call.
NextToken (string) -- The token value retrieved from a previous call to access the next page of results.

Return type

dict

Returns

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.

list_data_sets(**kwargs)¶

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'
)

Parameters

MaxResults (integer) -- The maximum number of results returned by a single call.
NextToken (string) -- The token value retrieved from a previous call to access the next page of results.
Origin (string) -- A property that defines the data set as OWNED by the account (for providers) or ENTITLED to the account (for subscribers).

Return type

dict

Returns

Response Syntax

{
    'DataSets': [
        {
            'Arn': 'string',
            'AssetType': 'S3_SNAPSHOT',
            '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 file your data is stored in. Currently, the supported asset type is S3_SNAPSHOT.
    - 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) --
    - 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.

list_jobs(**kwargs)¶

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'
)

Parameters

DataSetId (string) -- The unique identifier for a data set.
MaxResults (integer) -- The maximum number of results returned by a single call.
NextToken (string) -- The token value retrieved from a previous call to access the next page of results.
RevisionId (string) -- The unique identifier for a revision.

Return type

dict

Returns

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',
                    '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.
        
        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 unqiue 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.

list_revision_assets(**kwargs)¶

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'
)

Parameters

DataSetId (string) --
[REQUIRED]

The unique identifier for a data set.
MaxResults (integer) -- The maximum number of results returned by a single call.
NextToken (string) -- The token value retrieved from a previous call to access the next page of results.
RevisionId (string) --
[REQUIRED]

The unique identifier for a revision.

Return type

dict

Returns

Response Syntax

{
    'Assets': [
        {
            'Arn': 'string',
            'AssetDetails': {
                'S3SnapshotAsset': {
                    'Size': 123.0
                }
            },
            'AssetType': 'S3_SNAPSHOT',
            '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 that can be stored as an S3 object. The asset can be a structured data file, an image file, or some other data file. When you create an import job for your files, you create an asset in AWS Data Exchange for each of those files.
    - Arn (string) --
      
      The ARN for the asset.
    - AssetDetails (dict) --
      
      Information about the asset, including its size.
      - S3SnapshotAsset (dict) --
        
        The S3 object that is the asset.
        
        Size (float) --
        
        The size of the S3 object that is the object.
    - AssetType (string) --
      
      The type of file your data is stored in. Currently, the supported asset type is S3_SNAPSHOT.
    - 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.
    - 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.

list_tags_for_resource(**kwargs)¶

This operation lists the tags on the resource.

See also: AWS API Documentation

Request Syntax

response = client.list_tags_for_resource(
    ResourceArn='string'
)

Parameters

ResourceArn (string) --

[REQUIRED]

An Amazon Resource Name (ARN) that uniquely identifies an AWS resource.

Return type

dict

Returns

Response Syntax

{
    'Tags': {
        'string': 'string'
    }
}

Response Structure

(dict) --
200 response
- Tags (dict) -- A label that consists of a customer-defined key and an optional value.
  - (string) --
    - (string) --

start_job(**kwargs)¶

This operation starts a job.

See also: AWS API Documentation

Request Syntax

response = client.start_job(
    JobId='string'
)

Parameters

JobId (string) --

[REQUIRED]

The unique identifier for a job.

Return type

dict

Returns

Response Syntax

{}

Response Structure

(dict) --
202 response

tag_resource(**kwargs)¶

This operation tags a resource.

See also: AWS API Documentation

Request Syntax

response = client.tag_resource(
    ResourceArn='string',
    Tags={
        'string': 'string'
    }
)

Parameters

ResourceArn (string) --
[REQUIRED]

An Amazon Resource Name (ARN) that uniquely identifies an AWS resource.
Tags (dict) --
[REQUIRED] A label that consists of a customer-defined key and an optional value.
- (string) --
  - (string) --

Returns

None

untag_resource(**kwargs)¶

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',
    ]
)

Parameters

ResourceArn (string) --
[REQUIRED]

An Amazon Resource Name (ARN) that uniquely identifies an AWS resource.
TagKeys (list) --
[REQUIRED] The key tags.
- (string) --

Returns

None

update_asset(**kwargs)¶

This operation updates an asset.

See also: AWS API Documentation

Request Syntax

response = client.update_asset(
    AssetId='string',
    DataSetId='string',
    Name='string',
    RevisionId='string'
)

Parameters

AssetId (string) --
[REQUIRED]

The unique identifier for an asset.
DataSetId (string) --
[REQUIRED]

The unique identifier for a data set.
Name (string) --
[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.
RevisionId (string) --
[REQUIRED]

The unique identifier for a revision.

Return type

dict

Returns

Response Syntax

{
    'Arn': 'string',
    'AssetDetails': {
        'S3SnapshotAsset': {
            'Size': 123.0
        }
    },
    'AssetType': 'S3_SNAPSHOT',
    '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, including its size.
  - S3SnapshotAsset (dict) --
    
    The S3 object that is the asset.
    - Size (float) --
      
      The size of the S3 object that is the object.
- AssetType (string) --
  
  The type of file your data is stored in. Currently, the supported asset type is S3_SNAPSHOT.
- 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.
- 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.

update_data_set(**kwargs)¶

This operation updates a data set.

See also: AWS API Documentation

Request Syntax

response = client.update_data_set(
    DataSetId='string',
    Description='string',
    Name='string'
)

Parameters

DataSetId (string) --
[REQUIRED]

The unique identifier for a data set.
Description (string) -- The description for the data set.
Name (string) -- The name of the data set.

Return type

dict

Returns

Response Syntax

{
    'Arn': 'string',
    'AssetType': 'S3_SNAPSHOT',
    '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 file your data is stored in. Currently, the supported asset type is S3_SNAPSHOT.
- 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) --
- 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.

update_revision(**kwargs)¶

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'
)

Parameters

Comment (string) -- An optional comment about the revision.
DataSetId (string) --
[REQUIRED]

The unique identifier for a data set.
Finalized (boolean) -- 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.
RevisionId (string) --
[REQUIRED]

The unique identifier for a revision.

Return type

dict

Returns

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.

Paginators ¶

The available paginators are:

DataExchange.Paginator.ListDataSetRevisions
DataExchange.Paginator.ListDataSets
DataExchange.Paginator.ListJobs
DataExchange.Paginator.ListRevisionAssets

class DataExchange.Paginator.ListDataSetRevisions¶

paginator = client.get_paginator('list_data_set_revisions')

paginate(**kwargs)¶

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'
    }
)

Parameters

DataSetId (string) --
[REQUIRED]

The unique identifier for a data set.
PaginationConfig (dict) --
A dictionary that provides parameters to control pagination.
- MaxItems (integer) --
  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.
- PageSize (integer) --
  The size of each page.
- StartingToken (string) --
  A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

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.

class DataExchange.Paginator.ListDataSets¶

paginator = client.get_paginator('list_data_sets')

paginate(**kwargs)¶

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'
    }
)

Parameters

Origin (string) -- A property that defines the data set as OWNED by the account (for providers) or ENTITLED to the account (for subscribers).
PaginationConfig (dict) --
A dictionary that provides parameters to control pagination.
- MaxItems (integer) --
  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.
- PageSize (integer) --
  The size of each page.
- StartingToken (string) --
  A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'DataSets': [
        {
            'Arn': 'string',
            'AssetType': 'S3_SNAPSHOT',
            '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 file your data is stored in. Currently, the supported asset type is S3_SNAPSHOT.
    - 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) --
    - 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.

class DataExchange.Paginator.ListJobs¶

paginator = client.get_paginator('list_jobs')

paginate(**kwargs)¶

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'
    }
)

Parameters

DataSetId (string) -- The unique identifier for a data set.
RevisionId (string) -- The unique identifier for a revision.
PaginationConfig (dict) --
A dictionary that provides parameters to control pagination.
- MaxItems (integer) --
  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.
- PageSize (integer) --
  The size of each page.
- StartingToken (string) --
  A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

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',
                    '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
- 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.
        
        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 unqiue 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.

class DataExchange.Paginator.ListRevisionAssets¶

paginator = client.get_paginator('list_revision_assets')

paginate(**kwargs)¶

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'
    }
)

Parameters

DataSetId (string) --
[REQUIRED]

The unique identifier for a data set.
RevisionId (string) --
[REQUIRED]

The unique identifier for a revision.
PaginationConfig (dict) --
A dictionary that provides parameters to control pagination.
- MaxItems (integer) --
  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.
- PageSize (integer) --
  The size of each page.
- StartingToken (string) --
  A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'Assets': [
        {
            'Arn': 'string',
            'AssetDetails': {
                'S3SnapshotAsset': {
                    'Size': 123.0
                }
            },
            'AssetType': 'S3_SNAPSHOT',
            '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 that can be stored as an S3 object. The asset can be a structured data file, an image file, or some other data file. When you create an import job for your files, you create an asset in AWS Data Exchange for each of those files.
    - Arn (string) --
      
      The ARN for the asset.
    - AssetDetails (dict) --
      
      Information about the asset, including its size.
      - S3SnapshotAsset (dict) --
        
        The S3 object that is the asset.
        
        Size (float) --
        
        The size of the S3 object that is the object.
    - AssetType (string) --
      
      The type of file your data is stored in. Currently, the supported asset type is S3_SNAPSHOT.
    - 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.
    - 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.

Navigation

Table Of Contents

DataExchange¶

Client¶

Paginators¶

Navigation

DataExchange ¶

Client ¶

Paginators ¶