AWS API Changes

2021/11/29 - AWS Data Exchange - 1 new 10 updated api methods

Changes This release enables providers and subscribers to use Data Set, Job, and Asset operations to work with API assets from Amazon API Gateway. In addition, this release enables subscribers to use the SendApiAsset operation to invoke a provider's Amazon API Gateway API that they are entitled to.

SendApiAsset (new)

Link ¶

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

client.send_api_asset(
    Body='string',
    QueryStringParameters={
        'string': 'string'
    },
    AssetId='string',
    DataSetId='string',
    RequestHeaders={
        'string': 'string'
    },
    Method='string',
    Path='string',
    RevisionId='string'
)

type Body

string

param Body

The request body.

type QueryStringParameters

dict

param QueryStringParameters

Attach query string parameters to the end of the URI (for example, /v1/examplePath?exampleParam=exampleValue).

(string) --
- (string) --

type AssetId

string

param AssetId

[REQUIRED]

Asset ID value for the API request.

type DataSetId

string

param DataSetId

[REQUIRED]

Data set ID value for the API request.

type RequestHeaders

dict

param RequestHeaders

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.

(string) --
- (string) --

type Method

string

param Method

HTTP method value for the API request. Alternatively, you can use the appropriate verb in your request.

type Path

string

param Path

URI path value for the API request. Alternatively, you can set the URI path directly by invoking /v1/{pathValue}

type RevisionId

string

param RevisionId

[REQUIRED]

Revision ID value for the API request.

rtype

dict

returns

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.
  - (string) --
    - (string) --

CreateDataSet (updated)

Link ¶
Changes (both)

{'AssetType': {'API_GATEWAY_API'}}

This operation creates a data set.

See also: AWS API Documentation

Request Syntax

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

type AssetType

string

param AssetType

[REQUIRED]

The type of asset that is added to a data set.

type Description

string

param Description

[REQUIRED]

A description for the data set. This value can be up to 16,348 characters long.

type Name

string

param Name

[REQUIRED]

The name of the data set.

type Tags

dict

param Tags

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

rtype

dict

returns

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

CreateJob (updated)

Link ¶
Changes (request, response)
Request

{'Details': {'ImportAssetFromApiGatewayApi': {'ApiDescription': 'string',
                                              'ApiId': 'string',
                                              'ApiKey': 'string',
                                              'ApiName': 'string',
                                              'ApiSpecificationMd5Hash': 'string',
                                              'DataSetId': 'string',
                                              'ProtocolType': 'REST',
                                              'RevisionId': 'string',
                                              'Stage': 'string'}},
 'Type': {'IMPORT_ASSET_FROM_API_GATEWAY_API'}}

Response

{'Details': {'ImportAssetFromApiGatewayApi': {'ApiDescription': 'string',
                                              'ApiId': 'string',
                                              'ApiKey': 'string',
                                              'ApiName': 'string',
                                              'ApiSpecificationMd5Hash': 'string',
                                              'ApiSpecificationUploadUrl': 'string',
                                              'ApiSpecificationUploadUrlExpiresAt': 'timestamp',
                                              'DataSetId': 'string',
                                              'ProtocolType': 'REST',
                                              'RevisionId': 'string',
                                              'Stage': 'string'}},
 'Type': {'IMPORT_ASSET_FROM_API_GATEWAY_API'}}

This operation creates a job.

See also: AWS API Documentation

Request Syntax

client.create_job(
    Details={
        'ExportAssetToSignedUrl': {
            'AssetId': 'string',
            'DataSetId': 'string',
            'RevisionId': 'string'
        },
        'ExportAssetsToS3': {
            'AssetDestinations': [
                {
                    'AssetId': 'string',
                    'Bucket': 'string',
                    'Key': 'string'
                },
            ],
            'DataSetId': 'string',
            'Encryption': {
                'KmsKeyArn': 'string',
                'Type': 'aws:kms'|'AES256'
            },
            'RevisionId': 'string'
        },
        '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'
)

type Details

dict

param Details

[REQUIRED]

The details for the CreateJob request.

ExportAssetToSignedUrl (dict) --

Details about the export to signed URL request.
- AssetId (string) -- [REQUIRED]
  
  The unique identifier for the asset that is exported to a signed URL.
- DataSetId (string) -- [REQUIRED]
  
  The unique identifier for the data set associated with this export job.
- RevisionId (string) -- [REQUIRED]
  
  The unique identifier for the revision associated with this export request.
ExportAssetsToS3 (dict) --

Details about the export to Amazon S3 request.
- AssetDestinations (list) -- [REQUIRED]
  
  The destination for the asset.
  - (dict) --
    
    The destination for the asset.
    - AssetId (string) -- [REQUIRED]
      
      The unique identifier for the asset.
    - Bucket (string) -- [REQUIRED]
      
      The S3 bucket that is the destination for the asset.
    - Key (string) --
      
      The name of the object in Amazon S3 for the asset.
- DataSetId (string) -- [REQUIRED]
  
  The unique identifier for the data set associated with this export job.
- Encryption (dict) --
  
  Encryption configuration for the export job.
  - KmsKeyArn (string) --
    
    The Amazon Resource Name (ARN) of the AWS KMS key you want to use to encrypt the Amazon S3 objects. This parameter is required if you choose aws:kms as an encryption type.
  - Type (string) -- [REQUIRED]
    
    The type of server side encryption used for encrypting the objects in Amazon S3.
- RevisionId (string) -- [REQUIRED]
  
  The unique identifier for the revision associated with this export request.
ExportRevisionsToS3 (dict) --

Details about the export to Amazon S3 request.
- DataSetId (string) -- [REQUIRED]
  
  The unique identifier for the data set associated with this export job.
- Encryption (dict) --
  
  Encryption configuration for the export job.
  - KmsKeyArn (string) --
    
    The Amazon Resource Name (ARN) of the AWS KMS key you want to use to encrypt the Amazon S3 objects. This parameter is required if you choose aws:kms as an encryption type.
  - Type (string) -- [REQUIRED]
    
    The type of server side encryption used for encrypting the objects in Amazon S3.
- RevisionDestinations (list) -- [REQUIRED]
  
  The destination for the revision.
  - (dict) --
    
    The destination where the assets in the revision will be exported.
    - Bucket (string) -- [REQUIRED]
      
      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) -- [REQUIRED]
      
      The unique identifier for the revision.
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.
ImportAssetsFromRedshiftDataShares (dict) --

Details from an import from Amazon Redshift datashare request.
- AssetSources (list) -- [REQUIRED] A list of Amazon Redshift datashare assets.
  - (dict) --
    
    The source of the Amazon Redshift datashare asset.
    - DataShareArn (string) -- [REQUIRED] The Amazon Resource Name (ARN) of the datashare 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 job.
ImportAssetFromApiGatewayApi (dict) --

Information about the import asset from API Gateway API request.
- ApiDescription (string) --
  
  The API description. Markdown supported.
- ApiId (string) -- [REQUIRED]
  
  The API Gateway API ID.
- ApiKey (string) --
  
  The API Gateway API key.
- ApiName (string) -- [REQUIRED]
  
  The API name.
- ApiSpecificationMd5Hash (string) -- [REQUIRED]
  
  The Base64-encoded MD5 hash of the OpenAPI 3.0 JSON API specification file. It is used to ensure the integrity of the file.
- DataSetId (string) -- [REQUIRED]
  
  The data set ID.
- ProtocolType (string) -- [REQUIRED]
  
  The protocol type.
- RevisionId (string) -- [REQUIRED]
  
  The revision ID.
- Stage (string) -- [REQUIRED]
  
  The API stage.

type Type

string

param Type

[REQUIRED]

The type of job to be created.

rtype

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',
            '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.
        
        DataShareArn (string) -- The Amazon Resource Name (ARN) of the 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.

GetAsset (updated)

Link ¶
Changes (response)

{'AssetDetails': {'ApiGatewayApiAsset': {'ApiDescription': 'string',
                                         'ApiEndpoint': 'string',
                                         'ApiId': 'string',
                                         'ApiKey': 'string',
                                         'ApiName': 'string',
                                         'ApiSpecificationDownloadUrl': 'string',
                                         'ApiSpecificationDownloadUrlExpiresAt': 'timestamp',
                                         'ProtocolType': 'REST',
                                         'Stage': 'string'}},
 'AssetType': {'API_GATEWAY_API'}}

This operation returns information about an asset.

See also: AWS API Documentation

Request Syntax

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

type AssetId

string

param AssetId

[REQUIRED]

The unique identifier for an asset.

type DataSetId

string

param DataSetId

[REQUIRED]

The unique identifier for a data set.

type RevisionId

string

param RevisionId

[REQUIRED]

The unique identifier for a revision.

rtype

dict

returns

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.
    - Arn (string) -- The Amazon Resource Name (ARN) of the datashare 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.

GetDataSet (updated)

Link ¶
Changes (response)

{'AssetType': {'API_GATEWAY_API'}}

This operation returns information about a data set.

See also: AWS API Documentation

Request Syntax

client.get_data_set(
    DataSetId='string'
)

type DataSetId

string

param DataSetId

[REQUIRED]

The unique identifier for a data set.

rtype

dict

returns

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

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.
- 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.

GetJob (updated)

Link ¶
Changes (response)

{'Details': {'ImportAssetFromApiGatewayApi': {'ApiDescription': 'string',
                                              'ApiId': 'string',
                                              'ApiKey': 'string',
                                              'ApiName': 'string',
                                              'ApiSpecificationMd5Hash': 'string',
                                              'ApiSpecificationUploadUrl': 'string',
                                              'ApiSpecificationUploadUrlExpiresAt': 'timestamp',
                                              'DataSetId': 'string',
                                              'ProtocolType': 'REST',
                                              'RevisionId': 'string',
                                              'Stage': 'string'}},
 'Type': {'IMPORT_ASSET_FROM_API_GATEWAY_API'}}

This operation returns information about a job.

See also: AWS API Documentation

Request Syntax

client.get_job(
    JobId='string'
)

type JobId

string

param JobId

[REQUIRED]

The unique identifier for a job.

rtype

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',
            '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
- 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.
        
        DataShareArn (string) -- The Amazon Resource Name (ARN) of the 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.

ListDataSets (updated)

Link ¶
Changes (response)

{'DataSets': {'AssetType': {'API_GATEWAY_API'}}}

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

client.list_data_sets(
    MaxResults=123,
    NextToken='string',
    Origin='string'
)

type MaxResults

integer

param MaxResults

The maximum number of results returned by a single call.

type NextToken

string

param NextToken

The token value retrieved from a previous call to access the next page of results.

type Origin

string

param Origin

A property that defines the data set as OWNED by the account (for providers) or ENTITLED to the account (for subscribers).

rtype

dict

returns

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.

ListJobs (updated)

Link ¶
Changes (response)

{'Jobs': {'Details': {'ImportAssetFromApiGatewayApi': {'ApiDescription': 'string',
                                                       'ApiId': 'string',
                                                       'ApiKey': 'string',
                                                       'ApiName': 'string',
                                                       'ApiSpecificationMd5Hash': 'string',
                                                       'ApiSpecificationUploadUrl': 'string',
                                                       'ApiSpecificationUploadUrlExpiresAt': 'timestamp',
                                                       'DataSetId': 'string',
                                                       'ProtocolType': 'REST',
                                                       'RevisionId': 'string',
                                                       'Stage': 'string'}},
          'Type': {'IMPORT_ASSET_FROM_API_GATEWAY_API'}}}

This operation lists your jobs sorted by CreatedAt in descending order.

See also: AWS API Documentation

Request Syntax

client.list_jobs(
    DataSetId='string',
    MaxResults=123,
    NextToken='string',
    RevisionId='string'
)

type DataSetId

string

param DataSetId

The unique identifier for a data set.

type MaxResults

integer

param MaxResults

The maximum number of results returned by a single call.

type NextToken

string

param NextToken

The token value retrieved from a previous call to access the next page of results.

type RevisionId

string

param RevisionId

The unique identifier for a revision.

rtype

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',
                    '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.
        
        DataShareArn (string) -- The Amazon Resource Name (ARN) of the 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.

ListRevisionAssets (updated)

Link ¶
Changes (response)

{'Assets': {'AssetDetails': {'ApiGatewayApiAsset': {'ApiDescription': 'string',
                                                    'ApiEndpoint': 'string',
                                                    'ApiId': 'string',
                                                    'ApiKey': 'string',
                                                    'ApiName': 'string',
                                                    'ApiSpecificationDownloadUrl': 'string',
                                                    'ApiSpecificationDownloadUrlExpiresAt': 'timestamp',
                                                    'ProtocolType': 'REST',
                                                    'Stage': 'string'}},
            'AssetType': {'API_GATEWAY_API'}}}

This operation lists a revision's assets sorted alphabetically in descending order.

See also: AWS API Documentation

Request Syntax

client.list_revision_assets(
    DataSetId='string',
    MaxResults=123,
    NextToken='string',
    RevisionId='string'
)

type DataSetId

string

param DataSetId

[REQUIRED]

The unique identifier for a data set.

type MaxResults

integer

param MaxResults

The maximum number of results returned by a single call.

type NextToken

string

param NextToken

The token value retrieved from a previous call to access the next page of results.

type RevisionId

string

param RevisionId

[REQUIRED]

The unique identifier for a revision.

rtype

dict

returns

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.
        
        Arn (string) -- The Amazon Resource Name (ARN) of the datashare 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.

UpdateAsset (updated)

Link ¶
Changes (response)

{'AssetDetails': {'ApiGatewayApiAsset': {'ApiDescription': 'string',
                                         'ApiEndpoint': 'string',
                                         'ApiId': 'string',
                                         'ApiKey': 'string',
                                         'ApiName': 'string',
                                         'ApiSpecificationDownloadUrl': 'string',
                                         'ApiSpecificationDownloadUrlExpiresAt': 'timestamp',
                                         'ProtocolType': 'REST',
                                         'Stage': 'string'}},
 'AssetType': {'API_GATEWAY_API'}}

This operation updates an asset.

See also: AWS API Documentation

Request Syntax

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

type AssetId

string

param AssetId

[REQUIRED]

The unique identifier for an asset.

type DataSetId

string

param DataSetId

[REQUIRED]

The unique identifier for a data set.

type Name

string

param Name

[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.

type RevisionId

string

param RevisionId

[REQUIRED]

The unique identifier for a revision.

rtype

dict

returns

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.
    - Arn (string) -- The Amazon Resource Name (ARN) of the datashare 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.

UpdateDataSet (updated)

Link ¶
Changes (response)

{'AssetType': {'API_GATEWAY_API'}}

This operation updates a data set.

See also: AWS API Documentation

Request Syntax

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

type DataSetId

string

param DataSetId

[REQUIRED]

The unique identifier for a data set.

type Description

string

param Description

The description for the data set.

type Name

string

param Name

The name of the data set.

rtype

dict

returns

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.