Type: string Required: True
ApiSpecificationMd5Hash
The Base64-encoded MD5 hash of the OpenAPI 3.0 JSON API specification file. It is used to ensure the integrity of the file.
Type: string Required: True
Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
MinLength: 24 MaxLength: 24
ApiDescription
The API description. Markdown supported.
Type: string Required: False
ImportAssetFromApiGatewayApiResponseDetails
The response details.
Properties
DataSetId
The data set ID.Type: string Required: True
RevisionId
The revision ID.Type: string Required: True
ApiId
The API ID.Type: string Required: True
ProtocolType
The protocol type.Type: string Required: True Values: REST
Stage
The API stage.Type: string Required: True
ApiKey
The API key.Type: string Required: False
ApiName
The API name.Type: string Required: True
ApiSpecificationMd5Hash
The Base64-encoded Md5 hash for the API asset, used to ensure the integrity of the API at that location.
Type: string
Properties
Required: True
Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
MinLength: 24 MaxLength: 24
ApiDescription
The API description.Type: string Required: False
ApiSpecificationUploadUrl
The upload URL of the API specification.
Type: string Required: True
ApiSpecificationUploadUrlExpiresAt
The date and time that the upload URL expires, in ISO 8601 format.
Type: string Required: True
ImportAssetFromSignedUrlJobErrorDetails
Information about the job error.
AssetName
Information about the job error.
Type: string Required: True
ImportAssetFromSignedUrlRequestDetails
Details of the operation to be performed by the job.
DataSetId
The unique identifier for the data set associated with this import job.
Type: string Required: True
RevisionId
The unique identifier for the revision associated with this import request.
Type: string Required: True
Properties
AssetName
The name of the asset. When importing from Amazon S3, the S3 object key is used as the asset name.
Type: string Required: True
Md5Hash
The Base64-encoded Md5 hash for the asset, used to ensure the integrity of the file at that location.
Type: string Required: True
Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
MinLength: 24 MaxLength: 24
ImportAssetFromSignedUrlResponseDetails
The details in the response for an import request, including the signed URL and other information.
DataSetId
The unique identifier for the data set associated with this import job.
Type: string Required: True
RevisionId
The unique identifier for the revision associated with this import response.
Type: string Required: True
AssetName
The name for the asset associated with this import job.
Type: string Required: True
SignedUrl
The signed URL.Type: string Required: False
SignedUrlExpiresAt
The time and date at which the signed URL expires, in ISO 8601 format.
Type: string
Properties
Required: False
Md5Hash
The Base64-encoded Md5 hash for the asset, used to ensure the integrity of the file at that location.
Type: string Required: False
Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
MinLength: 24 MaxLength: 24
ImportAssetsFromRedshiftDataSharesRequestDetails
Details from an import from Amazon Redshift datashare request.
AssetSources
A list of Amazon Redshift datashare assets.
Type: Array of type RedshiftDataShareAssetSourceEntry (p. 105) Required: True
DataSetId
The unique identifier for the data set associated with this import job.
Type: string Required: True
RevisionId
The unique identifier for the revision associated with this import job.
Type: string Required: True
ImportAssetsFromRedshiftDataSharesResponseDetails
Details from an import from Amazon Redshift datashare response.
AssetSources
A list of Amazon Redshift datashare asset sources.
Type: Array of type RedshiftDataShareAssetSourceEntry (p. 105) Required: True
DataSetId
The unique identifier for the data set associated with this import job.
Type: string Required: True
Properties
RevisionId
The unique identifier for the revision associated with this import job.
Type: string Required: True
ImportAssetsFromS3RequestDetails
Details of the operation to be performed by the job.
AssetSources
Is a list of S3 bucket and object key pairs.
Type: Array of type AssetSourceEntry (p. 89) Required: True
DataSetId
The unique identifier for the data set associated with this import job.
Type: string Required: True
RevisionId
The unique identifier for the revision associated with this import request.
Type: string Required: True
ImportAssetsFromS3ResponseDetails
Details from an import from Amazon S3 response.
AssetSources
Is a list of Amazon S3 bucket and object key pairs.
Type: Array of type AssetSourceEntry (p. 89) Required: True
DataSetId
The unique identifier for the data set associated with this import job.
Type: string Required: True
RevisionId
The unique identifier for the revision associated with this import response.
Type: string
Properties
Required: True
InternalServerException
An exception occurred with the service.
Message
The message identifying the service exception that occurred.
Type: string Required: True
Job
AWS Data Exchange jobs are asynchronous import or export operations used to create or copy assets.
Jobs are deleted 90 days after they are created.
Type
The job type.Type: string Required: True
Values: IMPORT_ASSETS_FROM_S3 | IMPORT_ASSET_FROM_SIGNED_URL |
EXPORT_ASSETS_TO_S3 | EXPORT_ASSET_TO_SIGNED_URL | EXPORT_REVISIONS_TO_S3 | IMPORT_ASSETS_FROM_REDSHIFT_DATA_SHARES | IMPORT_ASSET_FROM_API_GATEWAY_API
State
The state of the job.
Type: string Required: True
Values: WAITING | IN_PROGRESS | ERROR | COMPLETED | CANCELLED | TIMED_OUT
Errors
The errors associated with jobs.
Type: Array of type JobError (p. 103) Required: False
Details
Details about the job.
Type: ResponseDetails (p. 107) Required: True
CreatedAt
The date and time that the job was created, in ISO 8601 format.
Properties
Type: string Required: True
UpdatedAt
The date and time that the job was last updated, in ISO 8601 format.
Type: string Required: True
Arn
The ARN for the job.
Type: string Required: True
Id
The unique identifier for the job.
Type: string Required: True
JobEntry
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.
Type
The job type.Type: string Required: True
Values: IMPORT_ASSETS_FROM_S3 | IMPORT_ASSET_FROM_SIGNED_URL |
EXPORT_ASSETS_TO_S3 | EXPORT_ASSET_TO_SIGNED_URL | EXPORT_REVISIONS_TO_S3 | IMPORT_ASSETS_FROM_REDSHIFT_DATA_SHARES | IMPORT_ASSET_FROM_API_GATEWAY_API
State
The state of the job.
Type: string Required: True
Values: WAITING | IN_PROGRESS | ERROR | COMPLETED | CANCELLED | TIMED_OUT