AWS Data Exchange 2017-07-25
- Client: Aws\DataExchange\DataExchangeClient
- Service ID: dataexchange
- Version: 2017-07-25
This page describes the parameters and results for the operations of the AWS Data Exchange (2017-07-25), and shows how to use the Aws\DataExchange\DataExchangeClient object to call the described operations. This documentation is specific to the 2017-07-25 API version of the service.
Operation Summary
Each of the following operations can be created from a client using
$client->getCommand('CommandName'), where "CommandName" is the
name of one of the following operations. Note: a command is a value that
encapsulates an operation and the parameters used to create an HTTP request.
You can also create and send a command immediately using the magic methods
available on a client object: $client->commandName(/* parameters */).
You can send the command asynchronously (returning a promise) by appending the
word "Async" to the operation name: $client->commandNameAsync(/* parameters */).
- CancelJob ( array $params = [] )
This operation cancels a job.
- CreateDataSet ( array $params = [] )
This operation creates a data set.
- CreateEventAction ( array $params = [] )
This operation creates an event action.
- CreateJob ( array $params = [] )
This operation creates a job.
- CreateRevision ( array $params = [] )
This operation creates a revision for a data set.
- DeleteAsset ( array $params = [] )
This operation deletes an asset.
- DeleteDataSet ( array $params = [] )
This operation deletes a data set.
- DeleteEventAction ( array $params = [] )
This operation deletes the event action.
- DeleteRevision ( array $params = [] )
This operation deletes a revision.
- GetAsset ( array $params = [] )
This operation returns information about an asset.
- GetDataSet ( array $params = [] )
This operation returns information about a data set.
- GetEventAction ( array $params = [] )
This operation retrieves information about an event action.
- GetJob ( array $params = [] )
This operation returns information about a job.
- GetRevision ( array $params = [] )
This operation returns information about a revision.
- ListDataSetRevisions ( array $params = [] )
This operation lists a data set's revisions sorted by CreatedAt in descending order.
- ListDataSets ( array $params = [] )
This operation lists your data sets.
- ListEventActions ( array $params = [] )
This operation lists your event actions.
- ListJobs ( array $params = [] )
This operation lists your jobs sorted by CreatedAt in descending order.
- ListRevisionAssets ( array $params = [] )
This operation lists a revision's assets sorted alphabetically in descending order.
- ListTagsForResource ( array $params = [] )
This operation lists the tags on the resource.
- RevokeRevision ( array $params = [] )
This operation revokes subscribers' access to a revision.
- SendApiAsset ( array $params = [] )
This operation invokes an API Gateway API asset.
- StartJob ( array $params = [] )
This operation starts a job.
- TagResource ( array $params = [] )
This operation tags a resource.
- UntagResource ( array $params = [] )
This operation removes one or more tags from a resource.
- UpdateAsset ( array $params = [] )
This operation updates an asset.
- UpdateDataSet ( array $params = [] )
This operation updates a data set.
- UpdateEventAction ( array $params = [] )
This operation updates the event action.
- UpdateRevision ( array $params = [] )
This operation updates a revision.
Paginators
Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:
Operations
CancelJob
$result = $client->cancelJob([/* ... */]); $promise = $client->cancelJobAsync([/* ... */]);
This operation cancels a job. Jobs can be cancelled only when they are in the WAITING state.
Parameter Syntax
$result = $client->cancelJob([
'JobId' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[]
Result Details
Errors
-
The resource couldn't be found.
-
The limit on the number of requests per second was exceeded.
-
The request couldn't be completed because it conflicted with the current state of the resource.
-
The request was invalid.
-
An exception occurred with the service.
CreateDataSet
$result = $client->createDataSet([/* ... */]); $promise = $client->createDataSetAsync([/* ... */]);
This operation creates a data set.
Parameter Syntax
$result = $client->createDataSet([
'AssetType' => 'S3_SNAPSHOT|REDSHIFT_DATA_SHARE|API_GATEWAY_API', // REQUIRED
'Description' => '<string>', // REQUIRED
'Name' => '<string>', // REQUIRED
'Tags' => ['<string>', ...],
]);
Parameter Details
Members
- AssetType
-
- Required: Yes
- Type: string
The type of asset that is added to a data set.
- Description
-
- Required: Yes
- Type: string
A description for the data set. This value can be up to 16,348 characters long.
- Name
-
- Required: Yes
- Type: string
The name of the data set.
- Tags
-
- Type: Associative array of custom strings keys (__string) to strings
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.
Result Syntax
[
'Arn' => '<string>',
'AssetType' => 'S3_SNAPSHOT|REDSHIFT_DATA_SHARE|API_GATEWAY_API',
'CreatedAt' => <DateTime>,
'Description' => '<string>',
'Id' => '<string>',
'Name' => '<string>',
'Origin' => 'OWNED|ENTITLED',
'OriginDetails' => [
'ProductId' => '<string>',
],
'SourceId' => '<string>',
'Tags' => ['<string>', ...],
'UpdatedAt' => <DateTime>,
]
Result Details
Members
- Arn
-
- Type: string
The ARN for the data set.
- AssetType
-
- Type: string
The type of asset that is added to a data set.
- CreatedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time that the data set was created, in ISO 8601 format.
- Description
-
- Type: string
The description for the data set.
- Id
-
- Type: string
The unique identifier for the data set.
- Name
-
- Type: string
The name of the data set.
- Origin
-
- Type: string
A property that defines the data set as OWNED by the account (for providers) or ENTITLED to the account (for subscribers).
- OriginDetails
-
- Type: OriginDetails structure
If the origin of this data set is ENTITLED, includes the details for the product on AWS Marketplace.
- SourceId
-
- Type: 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
-
- Type: Associative array of custom strings keys (__string) to strings
The tags for the data set.
- UpdatedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time that the data set was last updated, in ISO 8601 format.
Errors
-
ServiceLimitExceededException:
The request has exceeded the quotas imposed by the service.
-
The limit on the number of requests per second was exceeded.
-
Access to the resource is denied.
-
The request was invalid.
-
An exception occurred with the service.
CreateEventAction
$result = $client->createEventAction([/* ... */]); $promise = $client->createEventActionAsync([/* ... */]);
This operation creates an event action.
Parameter Syntax
$result = $client->createEventAction([
'Action' => [ // REQUIRED
'ExportRevisionToS3' => [
'Encryption' => [
'KmsKeyArn' => '<string>',
'Type' => 'aws:kms|AES256', // REQUIRED
],
'RevisionDestination' => [ // REQUIRED
'Bucket' => '<string>', // REQUIRED
'KeyPattern' => '<string>',
],
],
],
'Event' => [ // REQUIRED
'RevisionPublished' => [
'DataSetId' => '<string>', // REQUIRED
],
],
]);
Parameter Details
Members
Result Syntax
[
'Action' => [
'ExportRevisionToS3' => [
'Encryption' => [
'KmsKeyArn' => '<string>',
'Type' => 'aws:kms|AES256',
],
'RevisionDestination' => [
'Bucket' => '<string>',
'KeyPattern' => '<string>',
],
],
],
'Arn' => '<string>',
'CreatedAt' => <DateTime>,
'Event' => [
'RevisionPublished' => [
'DataSetId' => '<string>',
],
],
'Id' => '<string>',
'UpdatedAt' => <DateTime>,
]
Result Details
Members
- Action
-
- Type: Action structure
What occurs after a certain event.
- Arn
-
- Type: string
The ARN for the event action.
- CreatedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time that the event action was created, in ISO 8601 format.
- Event
-
- Type: Event structure
What occurs to start an action.
- Id
-
- Type: string
The unique identifier for the event action.
- UpdatedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time that the event action was last updated, in ISO 8601 format.
Errors
-
ServiceLimitExceededException:
The request has exceeded the quotas imposed by the service.
-
The limit on the number of requests per second was exceeded.
-
Access to the resource is denied.
-
The request was invalid.
-
An exception occurred with the service.
CreateJob
$result = $client->createJob([/* ... */]); $promise = $client->createJobAsync([/* ... */]);
This operation creates a job.
Parameter Syntax
$result = $client->createJob([
'Details' => [ // REQUIRED
'ExportAssetToSignedUrl' => [
'AssetId' => '<string>', // REQUIRED
'DataSetId' => '<string>', // REQUIRED
'RevisionId' => '<string>', // REQUIRED
],
'ExportAssetsToS3' => [
'AssetDestinations' => [ // REQUIRED
[
'AssetId' => '<string>', // REQUIRED
'Bucket' => '<string>', // REQUIRED
'Key' => '<string>',
],
// ...
],
'DataSetId' => '<string>', // REQUIRED
'Encryption' => [
'KmsKeyArn' => '<string>',
'Type' => 'aws:kms|AES256', // REQUIRED
],
'RevisionId' => '<string>', // REQUIRED
],
'ExportRevisionsToS3' => [
'DataSetId' => '<string>', // REQUIRED
'Encryption' => [
'KmsKeyArn' => '<string>',
'Type' => 'aws:kms|AES256', // REQUIRED
],
'RevisionDestinations' => [ // REQUIRED
[
'Bucket' => '<string>', // REQUIRED
'KeyPattern' => '<string>',
'RevisionId' => '<string>', // REQUIRED
],
// ...
],
],
'ImportAssetFromApiGatewayApi' => [
'ApiDescription' => '<string>',
'ApiId' => '<string>', // REQUIRED
'ApiKey' => '<string>',
'ApiName' => '<string>', // REQUIRED
'ApiSpecificationMd5Hash' => '<string>', // REQUIRED
'DataSetId' => '<string>', // REQUIRED
'ProtocolType' => 'REST', // REQUIRED
'RevisionId' => '<string>', // REQUIRED
'Stage' => '<string>', // REQUIRED
],
'ImportAssetFromSignedUrl' => [
'AssetName' => '<string>', // REQUIRED
'DataSetId' => '<string>', // REQUIRED
'Md5Hash' => '<string>', // REQUIRED
'RevisionId' => '<string>', // REQUIRED
],
'ImportAssetsFromRedshiftDataShares' => [
'AssetSources' => [ // REQUIRED
[
'DataShareArn' => '<string>', // REQUIRED
],
// ...
],
'DataSetId' => '<string>', // REQUIRED
'RevisionId' => '<string>', // REQUIRED
],
'ImportAssetsFromS3' => [
'AssetSources' => [ // REQUIRED
[
'Bucket' => '<string>', // REQUIRED
'Key' => '<string>', // REQUIRED
],
// ...
],
'DataSetId' => '<string>', // REQUIRED
'RevisionId' => '<string>', // REQUIRED
],
],
'Type' => 'IMPORT_ASSETS_FROM_S3|IMPORT_ASSET_FROM_SIGNED_URL|EXPORT_ASSETS_TO_S3|EXPORT_ASSET_TO_SIGNED_URL|EXPORT_REVISIONS_TO_S3|IMPORT_ASSETS_FROM_REDSHIFT_DATA_SHARES|IMPORT_ASSET_FROM_API_GATEWAY_API', // REQUIRED
]);
Parameter Details
Members
- Details
-
- Required: Yes
- Type: RequestDetails structure
The details for the CreateJob request.
- Type
-
- Required: Yes
- Type: string
The type of job to be created.
Result Syntax
[
'Arn' => '<string>',
'CreatedAt' => <DateTime>,
'Details' => [
'ExportAssetToSignedUrl' => [
'AssetId' => '<string>',
'DataSetId' => '<string>',
'RevisionId' => '<string>',
'SignedUrl' => '<string>',
'SignedUrlExpiresAt' => <DateTime>,
],
'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',
],
'EventActionArn' => '<string>',
'RevisionDestinations' => [
[
'Bucket' => '<string>',
'KeyPattern' => '<string>',
'RevisionId' => '<string>',
],
// ...
],
],
'ImportAssetFromApiGatewayApi' => [
'ApiDescription' => '<string>',
'ApiId' => '<string>',
'ApiKey' => '<string>',
'ApiName' => '<string>',
'ApiSpecificationMd5Hash' => '<string>',
'ApiSpecificationUploadUrl' => '<string>',
'ApiSpecificationUploadUrlExpiresAt' => <DateTime>,
'DataSetId' => '<string>',
'ProtocolType' => 'REST',
'RevisionId' => '<string>',
'Stage' => '<string>',
],
'ImportAssetFromSignedUrl' => [
'AssetName' => '<string>',
'DataSetId' => '<string>',
'Md5Hash' => '<string>',
'RevisionId' => '<string>',
'SignedUrl' => '<string>',
'SignedUrlExpiresAt' => <DateTime>,
],
'ImportAssetsFromRedshiftDataShares' => [
'AssetSources' => [
[
'DataShareArn' => '<string>',
],
// ...
],
'DataSetId' => '<string>',
'RevisionId' => '<string>',
],
'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|Amazon Redshift datashare assets per revision',
'LimitValue' => <float>,
'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>,
]
Result Details
Members
- Arn
-
- Type: string
The ARN for the job.
- CreatedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time that the job was created, in ISO 8601 format.
- Details
-
- Type: ResponseDetails structure
Details about the job.
- Errors
-
- Type: Array of JobError structures
The errors associated with jobs.
- Id
-
- Type: string
The unique identifier for the job.
- State
-
- Type: string
The state of the job.
- Type
-
- Type: string
The job type.
- UpdatedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time that the job was last updated, in ISO 8601 format.
Errors
-
The resource couldn't be found.
-
The limit on the number of requests per second was exceeded.
-
Access to the resource is denied.
-
The request couldn't be completed because it conflicted with the current state of the resource.
-
The request was invalid.
-
An exception occurred with the service.
CreateRevision
$result = $client->createRevision([/* ... */]); $promise = $client->createRevisionAsync([/* ... */]);
This operation creates a revision for a data set.
Parameter Syntax
$result = $client->createRevision([
'Comment' => '<string>',
'DataSetId' => '<string>', // REQUIRED
'Tags' => ['<string>', ...],
]);
Parameter Details
Members
- Comment
-
- Type: string
An optional comment about the revision.
- DataSetId
-
- Required: Yes
- Type: string
The unique identifier for a data set.
- Tags
-
- Type: Associative array of custom strings keys (__string) to strings
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.
Result Syntax
[
'Arn' => '<string>',
'Comment' => '<string>',
'CreatedAt' => <DateTime>,
'DataSetId' => '<string>',
'Finalized' => true || false,
'Id' => '<string>',
'RevocationComment' => '<string>',
'Revoked' => true || false,
'RevokedAt' => <DateTime>,
'SourceId' => '<string>',
'Tags' => ['<string>', ...],
'UpdatedAt' => <DateTime>,
]
Result Details
Members
- Arn
-
- Type: string
The ARN for the revision.
- Comment
-
- Type: string
An optional comment about the revision.
- CreatedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time that the revision was created, in ISO 8601 format.
- DataSetId
-
- Type: string
The unique identifier for the data set associated with this revision.
- Finalized
-
- Type: 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
-
- Type: string
The unique identifier for the revision.
- RevocationComment
-
- Type: string
A required comment to inform subscribers of the reason their access to the revision was revoked.
- Revoked
-
- Type: boolean
A status indicating that subscribers' access to the revision was revoked.
- RevokedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time that the revision was revoked, in ISO 8601 format.
- SourceId
-
- Type: 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
-
- Type: Associative array of custom strings keys (__string) to strings
The tags for the revision.
- UpdatedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time that the revision was last updated, in ISO 8601 format.
Errors
-
The resource couldn't be found.
-
The limit on the number of requests per second was exceeded.
-
Access to the resource is denied.
-
The request was invalid.
-
An exception occurred with the service.
DeleteAsset
$result = $client->deleteAsset([/* ... */]); $promise = $client->deleteAssetAsync([/* ... */]);
This operation deletes an asset.
Parameter Syntax
$result = $client->deleteAsset([
'AssetId' => '<string>', // REQUIRED
'DataSetId' => '<string>', // REQUIRED
'RevisionId' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[]
Result Details
Errors
-
The resource couldn't be found.
-
The limit on the number of requests per second was exceeded.
-
Access to the resource is denied.
-
The request couldn't be completed because it conflicted with the current state of the resource.
-
The request was invalid.
-
An exception occurred with the service.
DeleteDataSet
$result = $client->deleteDataSet([/* ... */]); $promise = $client->deleteDataSetAsync([/* ... */]);
This operation deletes a data set.
Parameter Syntax
$result = $client->deleteDataSet([
'DataSetId' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[]
Result Details
Errors
-
The resource couldn't be found.
-
The limit on the number of requests per second was exceeded.
-
Access to the resource is denied.
-
The request couldn't be completed because it conflicted with the current state of the resource.
-
The request was invalid.
-
An exception occurred with the service.
DeleteEventAction
$result = $client->deleteEventAction([/* ... */]); $promise = $client->deleteEventActionAsync([/* ... */]);
This operation deletes the event action.
Parameter Syntax
$result = $client->deleteEventAction([
'EventActionId' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[]
Result Details
Errors
-
The resource couldn't be found.
-
The limit on the number of requests per second was exceeded.
-
The request was invalid.
-
An exception occurred with the service.
DeleteRevision
$result = $client->deleteRevision([/* ... */]); $promise = $client->deleteRevisionAsync([/* ... */]);
This operation deletes a revision.
Parameter Syntax
$result = $client->deleteRevision([
'DataSetId' => '<string>', // REQUIRED
'RevisionId' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[]
Result Details
Errors
-
The resource couldn't be found.
-
The limit on the number of requests per second was exceeded.
-
Access to the resource is denied.
-
The request couldn't be completed because it conflicted with the current state of the resource.
-
The request was invalid.
-
An exception occurred with the service.
GetAsset
$result = $client->getAsset([/* ... */]); $promise = $client->getAssetAsync([/* ... */]);
This operation returns information about an asset.
Parameter Syntax
$result = $client->getAsset([
'AssetId' => '<string>', // REQUIRED
'DataSetId' => '<string>', // REQUIRED
'RevisionId' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'Arn' => '<string>',
'AssetDetails' => [
'ApiGatewayApiAsset' => [
'ApiDescription' => '<string>',
'ApiEndpoint' => '<string>',
'ApiId' => '<string>',
'ApiKey' => '<string>',
'ApiName' => '<string>',
'ApiSpecificationDownloadUrl' => '<string>',
'ApiSpecificationDownloadUrlExpiresAt' => <DateTime>,
'ProtocolType' => 'REST',
'Stage' => '<string>',
],
'RedshiftDataShareAsset' => [
'Arn' => '<string>',
],
'S3SnapshotAsset' => [
'Size' => <float>,
],
],
'AssetType' => 'S3_SNAPSHOT|REDSHIFT_DATA_SHARE|API_GATEWAY_API',
'CreatedAt' => <DateTime>,
'DataSetId' => '<string>',
'Id' => '<string>',
'Name' => '<string>',
'RevisionId' => '<string>',
'SourceId' => '<string>',
'UpdatedAt' => <DateTime>,
]
Result Details
Members
- Arn
-
- Type: string
The ARN for the asset.
- AssetDetails
-
- Type: AssetDetails structure
Information about the asset.
- AssetType
-
- Type: string
The type of asset that is added to a data set.
- CreatedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time that the asset was created, in ISO 8601 format.
- DataSetId
-
- Type: string
The unique identifier for the data set associated with this asset.
- Id
-
- Type: string
The unique identifier for the asset.
- Name
-
- Type: 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
-
- Type: string
The unique identifier for the revision associated with this asset.
- SourceId
-
- Type: 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
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time that the asset was last updated, in ISO 8601 format.
Errors
-
The resource couldn't be found.
-
The limit on the number of requests per second was exceeded.
-
The request was invalid.
-
An exception occurred with the service.
GetDataSet
$result = $client->getDataSet([/* ... */]); $promise = $client->getDataSetAsync([/* ... */]);
This operation returns information about a data set.
Parameter Syntax
$result = $client->getDataSet([
'DataSetId' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[
'Arn' => '<string>',
'AssetType' => 'S3_SNAPSHOT|REDSHIFT_DATA_SHARE|API_GATEWAY_API',
'CreatedAt' => <DateTime>,
'Description' => '<string>',
'Id' => '<string>',
'Name' => '<string>',
'Origin' => 'OWNED|ENTITLED',
'OriginDetails' => [
'ProductId' => '<string>',
],
'SourceId' => '<string>',
'Tags' => ['<string>', ...],
'UpdatedAt' => <DateTime>,
]
Result Details
Members
- Arn
-
- Type: string
The ARN for the data set.
- AssetType
-
- Type: string
The type of asset that is added to a data set.
- CreatedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time that the data set was created, in ISO 8601 format.
- Description
-
- Type: string
The description for the data set.
- Id
-
- Type: string
The unique identifier for the data set.
- Name
-
- Type: string
The name of the data set.
- Origin
-
- Type: string
A property that defines the data set as OWNED by the account (for providers) or ENTITLED to the account (for subscribers).
- OriginDetails
-
- Type: OriginDetails structure
If the origin of this data set is ENTITLED, includes the details for the product on AWS Marketplace.
- SourceId
-
- Type: 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
-
- Type: Associative array of custom strings keys (__string) to strings
The tags for the data set.
- UpdatedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time that the data set was last updated, in ISO 8601 format.
Errors
-
The resource couldn't be found.
-
The limit on the number of requests per second was exceeded.
-
The request was invalid.
-
An exception occurred with the service.
GetEventAction
$result = $client->getEventAction([/* ... */]); $promise = $client->getEventActionAsync([/* ... */]);
This operation retrieves information about an event action.
Parameter Syntax
$result = $client->getEventAction([
'EventActionId' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[
'Action' => [
'ExportRevisionToS3' => [
'Encryption' => [
'KmsKeyArn' => '<string>',
'Type' => 'aws:kms|AES256',
],
'RevisionDestination' => [
'Bucket' => '<string>',
'KeyPattern' => '<string>',
],
],
],
'Arn' => '<string>',
'CreatedAt' => <DateTime>,
'Event' => [
'RevisionPublished' => [
'DataSetId' => '<string>',
],
],
'Id' => '<string>',
'UpdatedAt' => <DateTime>,
]
Result Details
Members
- Action
-
- Type: Action structure
What occurs after a certain event.
- Arn
-
- Type: string
The ARN for the event action.
- CreatedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time that the event action was created, in ISO 8601 format.
- Event
-
- Type: Event structure
What occurs to start an action.
- Id
-
- Type: string
The unique identifier for the event action.
- UpdatedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time that the event action was last updated, in ISO 8601 format.
Errors
-
The resource couldn't be found.
-
The limit on the number of requests per second was exceeded.
-
The request was invalid.
-
An exception occurred with the service.
GetJob
$result = $client->getJob([/* ... */]); $promise = $client->getJobAsync([/* ... */]);
This operation returns information about a job.
Parameter Syntax
$result = $client->getJob([
'JobId' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[
'Arn' => '<string>',
'CreatedAt' => <DateTime>,
'Details' => [
'ExportAssetToSignedUrl' => [
'AssetId' => '<string>',
'DataSetId' => '<string>',
'RevisionId' => '<string>',
'SignedUrl' => '<string>',
'SignedUrlExpiresAt' => <DateTime>,
],
'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',
],
'EventActionArn' => '<string>',
'RevisionDestinations' => [
[
'Bucket' => '<string>',
'KeyPattern' => '<string>',
'RevisionId' => '<string>',
],
// ...
],
],
'ImportAssetFromApiGatewayApi' => [
'ApiDescription' => '<string>',
'ApiId' => '<string>',
'ApiKey' => '<string>',
'ApiName' => '<string>',
'ApiSpecificationMd5Hash' => '<string>',
'ApiSpecificationUploadUrl' => '<string>',
'ApiSpecificationUploadUrlExpiresAt' => <DateTime>,
'DataSetId' => '<string>',
'ProtocolType' => 'REST',
'RevisionId' => '<string>',
'Stage' => '<string>',
],
'ImportAssetFromSignedUrl' => [
'AssetName' => '<string>',
'DataSetId' => '<string>',
'Md5Hash' => '<string>',
'RevisionId' => '<string>',
'SignedUrl' => '<string>',
'SignedUrlExpiresAt' => <DateTime>,
],
'ImportAssetsFromRedshiftDataShares' => [
'AssetSources' => [
[
'DataShareArn' => '<string>',
],
// ...
],
'DataSetId' => '<string>',
'RevisionId' => '<string>',
],
'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|Amazon Redshift datashare assets per revision',
'LimitValue' => <float>,
'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>,
]
Result Details
Members
- Arn
-
- Type: string
The ARN for the job.
- CreatedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time that the job was created, in ISO 8601 format.
- Details
-
- Type: ResponseDetails structure
Details about the job.
- Errors
-
- Type: Array of JobError structures
The errors associated with jobs.
- Id
-
- Type: string
The unique identifier for the job.
- State
-
- Type: string
The state of the job.
- Type
-
- Type: string
The job type.
- UpdatedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time that the job was last updated, in ISO 8601 format.
Errors
-
The resource couldn't be found.
-
The limit on the number of requests per second was exceeded.
-
The request was invalid.
-
An exception occurred with the service.
GetRevision
$result = $client->getRevision([/* ... */]); $promise = $client->getRevisionAsync([/* ... */]);
This operation returns information about a revision.
Parameter Syntax
$result = $client->getRevision([
'DataSetId' => '<string>', // REQUIRED
'RevisionId' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'Arn' => '<string>',
'Comment' => '<string>',
'CreatedAt' => <DateTime>,
'DataSetId' => '<string>',
'Finalized' => true || false,
'Id' => '<string>',
'RevocationComment' => '<string>',
'Revoked' => true || false,
'RevokedAt' => <DateTime>,
'SourceId' => '<string>',
'Tags' => ['<string>', ...],
'UpdatedAt' => <DateTime>,
]
Result Details
Members
- Arn
-
- Type: string
The ARN for the revision.
- Comment
-
- Type: string
An optional comment about the revision.
- CreatedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time that the revision was created, in ISO 8601 format.
- DataSetId
-
- Type: string
The unique identifier for the data set associated with this revision.
- Finalized
-
- Type: 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
-
- Type: string
The unique identifier for the revision.
- RevocationComment
-
- Type: string
A required comment to inform subscribers of the reason their access to the revision was revoked.
- Revoked
-
- Type: boolean
A status indicating that subscribers' access to the revision was revoked.
- RevokedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time that the revision was revoked, in ISO 8601 format.
- SourceId
-
- Type: 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
-
- Type: Associative array of custom strings keys (__string) to strings
The tags for the revision.
- UpdatedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time that the revision was last updated, in ISO 8601 format.
Errors
-
The resource couldn't be found.
-
The limit on the number of requests per second was exceeded.
-
The request was invalid.
-
An exception occurred with the service.
ListDataSetRevisions
$result = $client->listDataSetRevisions([/* ... */]); $promise = $client->listDataSetRevisionsAsync([/* ... */]);
This operation lists a data set's revisions sorted by CreatedAt in descending order.
Parameter Syntax
$result = $client->listDataSetRevisions([
'DataSetId' => '<string>', // REQUIRED
'MaxResults' => <integer>,
'NextToken' => '<string>',
]);
Parameter Details
Members
Result Syntax
[
'NextToken' => '<string>',
'Revisions' => [
[
'Arn' => '<string>',
'Comment' => '<string>',
'CreatedAt' => <DateTime>,
'DataSetId' => '<string>',
'Finalized' => true || false,
'Id' => '<string>',
'RevocationComment' => '<string>',
'Revoked' => true || false,
'RevokedAt' => <DateTime>,
'SourceId' => '<string>',
'UpdatedAt' => <DateTime>,
],
// ...
],
]
Result Details
Members
- NextToken
-
- Type: string
The token value retrieved from a previous call to access the next page of results.
- Revisions
-
- Type: Array of RevisionEntry structures
The asset objects listed by the request.
Errors
-
The resource couldn't be found.
-
The limit on the number of requests per second was exceeded.
-
The request was invalid.
-
An exception occurred with the service.
ListDataSets
$result = $client->listDataSets([/* ... */]); $promise = $client->listDataSetsAsync([/* ... */]);
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.
Parameter Syntax
$result = $client->listDataSets([
'MaxResults' => <integer>,
'NextToken' => '<string>',
'Origin' => '<string>',
]);
Parameter Details
Members
- MaxResults
-
- Type: int
The maximum number of results returned by a single call.
- NextToken
-
- Type: string
The token value retrieved from a previous call to access the next page of results.
- Origin
-
- Type: string
A property that defines the data set as OWNED by the account (for providers) or ENTITLED to the account (for subscribers).
Result Syntax
[
'DataSets' => [
[
'Arn' => '<string>',
'AssetType' => 'S3_SNAPSHOT|REDSHIFT_DATA_SHARE|API_GATEWAY_API',
'CreatedAt' => <DateTime>,
'Description' => '<string>',
'Id' => '<string>',
'Name' => '<string>',
'Origin' => 'OWNED|ENTITLED',
'OriginDetails' => [
'ProductId' => '<string>',
],
'SourceId' => '<string>',
'UpdatedAt' => <DateTime>,
],
// ...
],
'NextToken' => '<string>',
]
Result Details
Members
- DataSets
-
- Type: Array of DataSetEntry structures
The data set objects listed by the request.
- NextToken
-
- Type: string
The token value retrieved from a previous call to access the next page of results.
Errors
-
The resource couldn't be found.
-
The limit on the number of requests per second was exceeded.
-
The request was invalid.
-
An exception occurred with the service.
ListEventActions
$result = $client->listEventActions([/* ... */]); $promise = $client->listEventActionsAsync([/* ... */]);
This operation lists your event actions.
Parameter Syntax
$result = $client->listEventActions([
'EventSourceId' => '<string>',
'MaxResults' => <integer>,
'NextToken' => '<string>',
]);
Parameter Details
Members
Result Syntax
[
'EventActions' => [
[
'Action' => [
'ExportRevisionToS3' => [
'Encryption' => [
'KmsKeyArn' => '<string>',
'Type' => 'aws:kms|AES256',
],
'RevisionDestination' => [
'Bucket' => '<string>',
'KeyPattern' => '<string>',
],
],
],
'Arn' => '<string>',
'CreatedAt' => <DateTime>,
'Event' => [
'RevisionPublished' => [
'DataSetId' => '<string>',
],
],
'Id' => '<string>',
'UpdatedAt' => <DateTime>,
],
// ...
],
'NextToken' => '<string>',
]
Result Details
Members
- EventActions
-
- Type: Array of EventActionEntry structures
The event action objects listed by the request.
- NextToken
-
- Type: string
The token value retrieved from a previous call to access the next page of results.
Errors
-
The resource couldn't be found.
-
The limit on the number of requests per second was exceeded.
-
The request was invalid.
-
An exception occurred with the service.
ListJobs
$result = $client->listJobs([/* ... */]); $promise = $client->listJobsAsync([/* ... */]);
This operation lists your jobs sorted by CreatedAt in descending order.
Parameter Syntax
$result = $client->listJobs([
'DataSetId' => '<string>',
'MaxResults' => <integer>,
'NextToken' => '<string>',
'RevisionId' => '<string>',
]);
Parameter Details
Members
- DataSetId
-
- Type: string
The unique identifier for a data set.
- MaxResults
-
- Type: int
The maximum number of results returned by a single call.
- NextToken
-
- Type: string
The token value retrieved from a previous call to access the next page of results.
- RevisionId
-
- Type: string
The unique identifier for a revision.
Result Syntax
[
'Jobs' => [
[
'Arn' => '<string>',
'CreatedAt' => <DateTime>,
'Details' => [
'ExportAssetToSignedUrl' => [
'AssetId' => '<string>',
'DataSetId' => '<string>',
'RevisionId' => '<string>',
'SignedUrl' => '<string>',
'SignedUrlExpiresAt' => <DateTime>,
],
'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',
],
'EventActionArn' => '<string>',
'RevisionDestinations' => [
[
'Bucket' => '<string>',
'KeyPattern' => '<string>',
'RevisionId' => '<string>',
],
// ...
],
],
'ImportAssetFromApiGatewayApi' => [
'ApiDescription' => '<string>',
'ApiId' => '<string>',
'ApiKey' => '<string>',
'ApiName' => '<string>',
'ApiSpecificationMd5Hash' => '<string>',
'ApiSpecificationUploadUrl' => '<string>',
'ApiSpecificationUploadUrlExpiresAt' => <DateTime>,
'DataSetId' => '<string>',
'ProtocolType' => 'REST',
'RevisionId' => '<string>',
'Stage' => '<string>',
],
'ImportAssetFromSignedUrl' => [
'AssetName' => '<string>',
'DataSetId' => '<string>',
'Md5Hash' => '<string>',
'RevisionId' => '<string>',
'SignedUrl' => '<string>',
'SignedUrlExpiresAt' => <DateTime>,
],
'ImportAssetsFromRedshiftDataShares' => [
'AssetSources' => [
[
'DataShareArn' => '<string>',
],
// ...
],
'DataSetId' => '<string>',
'RevisionId' => '<string>',
],
'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|Amazon Redshift datashare assets per revision',
'LimitValue' => <float>,
'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>,
],
// ...
],
'NextToken' => '<string>',
]
Result Details
Members
- Jobs
-
- Type: Array of JobEntry structures
The jobs listed by the request.
- NextToken
-
- Type: string
The token value retrieved from a previous call to access the next page of results.
Errors
-
The resource couldn't be found.
-
The limit on the number of requests per second was exceeded.
-
The request was invalid.
-
An exception occurred with the service.
ListRevisionAssets
$result = $client->listRevisionAssets([/* ... */]); $promise = $client->listRevisionAssetsAsync([/* ... */]);
This operation lists a revision's assets sorted alphabetically in descending order.
Parameter Syntax
$result = $client->listRevisionAssets([
'DataSetId' => '<string>', // REQUIRED
'MaxResults' => <integer>,
'NextToken' => '<string>',
'RevisionId' => '<string>', // REQUIRED
]);
Parameter Details
Members
- DataSetId
-
- Required: Yes
- Type: string
The unique identifier for a data set.
- MaxResults
-
- Type: int
The maximum number of results returned by a single call.
- NextToken
-
- Type: string
The token value retrieved from a previous call to access the next page of results.
- RevisionId
-
- Required: Yes
- Type: string
The unique identifier for a revision.
Result Syntax
[
'Assets' => [
[
'Arn' => '<string>',
'AssetDetails' => [
'ApiGatewayApiAsset' => [
'ApiDescription' => '<string>',
'ApiEndpoint' => '<string>',
'ApiId' => '<string>',
'ApiKey' => '<string>',
'ApiName' => '<string>',
'ApiSpecificationDownloadUrl' => '<string>',
'ApiSpecificationDownloadUrlExpiresAt' => <DateTime>,
'ProtocolType' => 'REST',
'Stage' => '<string>',
],
'RedshiftDataShareAsset' => [
'Arn' => '<string>',
],
'S3SnapshotAsset' => [
'Size' => <float>,
],
],
'AssetType' => 'S3_SNAPSHOT|REDSHIFT_DATA_SHARE|API_GATEWAY_API',
'CreatedAt' => <DateTime>,
'DataSetId' => '<string>',
'Id' => '<string>',
'Name' => '<string>',
'RevisionId' => '<string>',
'SourceId' => '<string>',
'UpdatedAt' => <DateTime>,
],
// ...
],
'NextToken' => '<string>',
]
Result Details
Members
- Assets
-
- Type: Array of AssetEntry structures
The asset objects listed by the request.
- NextToken
-
- Type: string
The token value retrieved from a previous call to access the next page of results.
Errors
-
The resource couldn't be found.
-
The limit on the number of requests per second was exceeded.
-
The request was invalid.
-
An exception occurred with the service.
ListTagsForResource
$result = $client->listTagsForResource([/* ... */]); $promise = $client->listTagsForResourceAsync([/* ... */]);
This operation lists the tags on the resource.
Parameter Syntax
$result = $client->listTagsForResource([
'ResourceArn' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'Tags' => ['<string>', ...],
]
Result Details
Members
Errors
There are no errors described for this operation.
RevokeRevision
$result = $client->revokeRevision([/* ... */]); $promise = $client->revokeRevisionAsync([/* ... */]);
This operation revokes subscribers' access to a revision.
Parameter Syntax
$result = $client->revokeRevision([
'DataSetId' => '<string>', // REQUIRED
'RevisionId' => '<string>', // REQUIRED
'RevocationComment' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'Arn' => '<string>',
'Comment' => '<string>',
'CreatedAt' => <DateTime>,
'DataSetId' => '<string>',
'Finalized' => true || false,
'Id' => '<string>',
'RevocationComment' => '<string>',
'Revoked' => true || false,
'RevokedAt' => <DateTime>,
'SourceId' => '<string>',
'UpdatedAt' => <DateTime>,
]
Result Details
Members
- Arn
-
- Type: string
The ARN for the revision.
- Comment
-
- Type: string
An optional comment about the revision.
- CreatedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time that the revision was created, in ISO 8601 format.
- DataSetId
-
- Type: string
The unique identifier for the data set associated with this revision.
- Finalized
-
- Type: 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
-
- Type: string
The unique identifier for the revision.
- RevocationComment
-
- Type: string
A required comment to inform subscribers of the reason their access to the revision was revoked.
- Revoked
-
- Type: boolean
A status indicating that subscribers' access to the revision was revoked.
- RevokedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time that the revision was revoked, in ISO 8601 format.
- SourceId
-
- Type: 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
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time that the revision was last updated, in ISO 8601 format.
Errors
-
The resource couldn't be found.
-
The limit on the number of requests per second was exceeded.
-
Access to the resource is denied.
-
The request couldn't be completed because it conflicted with the current state of the resource.
-
The request was invalid.
-
An exception occurred with the service.
SendApiAsset
$result = $client->sendApiAsset([/* ... */]); $promise = $client->sendApiAssetAsync([/* ... */]);
This operation invokes an API Gateway API asset. The request is proxied to the provider’s API Gateway API.
Parameter Syntax
$result = $client->sendApiAsset([
'AssetId' => '<string>', // REQUIRED
'Body' => '<string>',
'DataSetId' => '<string>', // REQUIRED
'Method' => '<string>',
'Path' => '<string>',
'QueryStringParameters' => ['<string>', ...],
'RequestHeaders' => ['<string>', ...],
'RevisionId' => '<string>', // REQUIRED
]);
Parameter Details
Members
- AssetId
-
- Required: Yes
- Type: string
Asset ID value for the API request.
- Body
-
- Type: string
The request body.
- DataSetId
-
- Required: Yes
- Type: string
Data set ID value for the API request.
- Method
-
- Type: string
HTTP method value for the API request. Alternatively, you can use the appropriate verb in your request.
- Path
-
- Type: string
URI path value for the API request. Alternatively, you can set the URI path directly by invoking /v1/{pathValue}.
- QueryStringParameters
-
- Type: Associative array of custom strings keys (__string) to strings
Attach query string parameters to the end of the URI (for example, /v1/examplePath?exampleParam=exampleValue).
- RequestHeaders
-
- Type: Associative array of custom strings keys (__string) to strings
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.
- RevisionId
-
- Required: Yes
- Type: string
Revision ID value for the API request.
Result Syntax
[
'Body' => '<string>',
'ResponseHeaders' => ['<string>', ...],
]
Result Details
Members
Errors
-
The resource couldn't be found.
-
The limit on the number of requests per second was exceeded.
-
Access to the resource is denied.
-
The request was invalid.
-
An exception occurred with the service.
StartJob
$result = $client->startJob([/* ... */]); $promise = $client->startJobAsync([/* ... */]);
This operation starts a job.
Parameter Syntax
$result = $client->startJob([
'JobId' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[]
Result Details
Errors
-
The resource couldn't be found.
-
The limit on the number of requests per second was exceeded.
-
Access to the resource is denied.
-
The request couldn't be completed because it conflicted with the current state of the resource.
-
The request was invalid.
-
An exception occurred with the service.
TagResource
$result = $client->tagResource([/* ... */]); $promise = $client->tagResourceAsync([/* ... */]);
This operation tags a resource.
Parameter Syntax
$result = $client->tagResource([
'ResourceArn' => '<string>', // REQUIRED
'Tags' => ['<string>', ...], // REQUIRED
]);
Parameter Details
Members
Result Syntax
[]
Result Details
Errors
There are no errors described for this operation.
UntagResource
$result = $client->untagResource([/* ... */]); $promise = $client->untagResourceAsync([/* ... */]);
This operation removes one or more tags from a resource.
Parameter Syntax
$result = $client->untagResource([
'ResourceArn' => '<string>', // REQUIRED
'TagKeys' => ['<string>', ...], // REQUIRED
]);
Parameter Details
Members
Result Syntax
[]
Result Details
Errors
There are no errors described for this operation.
UpdateAsset
$result = $client->updateAsset([/* ... */]); $promise = $client->updateAssetAsync([/* ... */]);
This operation updates an asset.
Parameter Syntax
$result = $client->updateAsset([
'AssetId' => '<string>', // REQUIRED
'DataSetId' => '<string>', // REQUIRED
'Name' => '<string>', // REQUIRED
'RevisionId' => '<string>', // REQUIRED
]);
Parameter Details
Members
- AssetId
-
- Required: Yes
- Type: string
The unique identifier for an asset.
- DataSetId
-
- Required: Yes
- Type: string
The unique identifier for a data set.
- Name
-
- Required: Yes
- Type: 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
-
- Required: Yes
- Type: string
The unique identifier for a revision.
Result Syntax
[
'Arn' => '<string>',
'AssetDetails' => [
'ApiGatewayApiAsset' => [
'ApiDescription' => '<string>',
'ApiEndpoint' => '<string>',
'ApiId' => '<string>',
'ApiKey' => '<string>',
'ApiName' => '<string>',
'ApiSpecificationDownloadUrl' => '<string>',
'ApiSpecificationDownloadUrlExpiresAt' => <DateTime>,
'ProtocolType' => 'REST',
'Stage' => '<string>',
],
'RedshiftDataShareAsset' => [
'Arn' => '<string>',
],
'S3SnapshotAsset' => [
'Size' => <float>,
],
],
'AssetType' => 'S3_SNAPSHOT|REDSHIFT_DATA_SHARE|API_GATEWAY_API',
'CreatedAt' => <DateTime>,
'DataSetId' => '<string>',
'Id' => '<string>',
'Name' => '<string>',
'RevisionId' => '<string>',
'SourceId' => '<string>',
'UpdatedAt' => <DateTime>,
]
Result Details
Members
- Arn
-
- Type: string
The ARN for the asset.
- AssetDetails
-
- Type: AssetDetails structure
Information about the asset.
- AssetType
-
- Type: string
The type of asset that is added to a data set.
- CreatedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time that the asset was created, in ISO 8601 format.
- DataSetId
-
- Type: string
The unique identifier for the data set associated with this asset.
- Id
-
- Type: string
The unique identifier for the asset.
- Name
-
- Type: 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
-
- Type: string
The unique identifier for the revision associated with this asset.
- SourceId
-
- Type: 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
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time that the asset was last updated, in ISO 8601 format.
Errors
-
The resource couldn't be found.
-
The limit on the number of requests per second was exceeded.
-
Access to the resource is denied.
-
The request couldn't be completed because it conflicted with the current state of the resource.
-
The request was invalid.
-
An exception occurred with the service.
UpdateDataSet
$result = $client->updateDataSet([/* ... */]); $promise = $client->updateDataSetAsync([/* ... */]);
This operation updates a data set.
Parameter Syntax
$result = $client->updateDataSet([
'DataSetId' => '<string>', // REQUIRED
'Description' => '<string>',
'Name' => '<string>',
]);
Parameter Details
Members
Result Syntax
[
'Arn' => '<string>',
'AssetType' => 'S3_SNAPSHOT|REDSHIFT_DATA_SHARE|API_GATEWAY_API',
'CreatedAt' => <DateTime>,
'Description' => '<string>',
'Id' => '<string>',
'Name' => '<string>',
'Origin' => 'OWNED|ENTITLED',
'OriginDetails' => [
'ProductId' => '<string>',
],
'SourceId' => '<string>',
'UpdatedAt' => <DateTime>,
]
Result Details
Members
- Arn
-
- Type: string
The ARN for the data set.
- AssetType
-
- Type: string
The type of asset that is added to a data set.
- CreatedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time that the data set was created, in ISO 8601 format.
- Description
-
- Type: string
The description for the data set.
- Id
-
- Type: string
The unique identifier for the data set.
- Name
-
- Type: string
The name of the data set.
- Origin
-
- Type: string
A property that defines the data set as OWNED by the account (for providers) or ENTITLED to the account (for subscribers).
- OriginDetails
-
- Type: OriginDetails structure
If the origin of this data set is ENTITLED, includes the details for the product on AWS Marketplace.
- SourceId
-
- Type: 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
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time that the data set was last updated, in ISO 8601 format.
Errors
-
The resource couldn't be found.
-
The limit on the number of requests per second was exceeded.
-
Access to the resource is denied.
-
The request was invalid.
-
An exception occurred with the service.
UpdateEventAction
$result = $client->updateEventAction([/* ... */]); $promise = $client->updateEventActionAsync([/* ... */]);
This operation updates the event action.
Parameter Syntax
$result = $client->updateEventAction([
'Action' => [
'ExportRevisionToS3' => [
'Encryption' => [
'KmsKeyArn' => '<string>',
'Type' => 'aws:kms|AES256', // REQUIRED
],
'RevisionDestination' => [ // REQUIRED
'Bucket' => '<string>', // REQUIRED
'KeyPattern' => '<string>',
],
],
],
'EventActionId' => '<string>', // REQUIRED
]);
Parameter Details
Members
- Action
-
- Type: Action structure
What occurs after a certain event.
- EventActionId
-
- Required: Yes
- Type: string
The unique identifier for the event action.
Result Syntax
[
'Action' => [
'ExportRevisionToS3' => [
'Encryption' => [
'KmsKeyArn' => '<string>',
'Type' => 'aws:kms|AES256',
],
'RevisionDestination' => [
'Bucket' => '<string>',
'KeyPattern' => '<string>',
],
],
],
'Arn' => '<string>',
'CreatedAt' => <DateTime>,
'Event' => [
'RevisionPublished' => [
'DataSetId' => '<string>',
],
],
'Id' => '<string>',
'UpdatedAt' => <DateTime>,
]
Result Details
Members
- Action
-
- Type: Action structure
What occurs after a certain event.
- Arn
-
- Type: string
The ARN for the event action.
- CreatedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time that the event action was created, in ISO 8601 format.
- Event
-
- Type: Event structure
What occurs to start an action.
- Id
-
- Type: string
The unique identifier for the event action.
- UpdatedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time that the event action was last updated, in ISO 8601 format.
Errors
-
The resource couldn't be found.
-
The limit on the number of requests per second was exceeded.
-
Access to the resource is denied.
-
The request was invalid.
-
An exception occurred with the service.
UpdateRevision
$result = $client->updateRevision([/* ... */]); $promise = $client->updateRevisionAsync([/* ... */]);
This operation updates a revision.
Parameter Syntax
$result = $client->updateRevision([
'Comment' => '<string>',
'DataSetId' => '<string>', // REQUIRED
'Finalized' => true || false,
'RevisionId' => '<string>', // REQUIRED
]);
Parameter Details
Members
- Comment
-
- Type: string
An optional comment about the revision.
- DataSetId
-
- Required: Yes
- Type: string
The unique identifier for a data set.
- Finalized
-
- Type: 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
-
- Required: Yes
- Type: string
The unique identifier for a revision.
Result Syntax
[
'Arn' => '<string>',
'Comment' => '<string>',
'CreatedAt' => <DateTime>,
'DataSetId' => '<string>',
'Finalized' => true || false,
'Id' => '<string>',
'RevocationComment' => '<string>',
'Revoked' => true || false,
'RevokedAt' => <DateTime>,
'SourceId' => '<string>',
'UpdatedAt' => <DateTime>,
]
Result Details
Members
- Arn
-
- Type: string
The ARN for the revision.
- Comment
-
- Type: string
An optional comment about the revision.
- CreatedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time that the revision was created, in ISO 8601 format.
- DataSetId
-
- Type: string
The unique identifier for the data set associated with this revision.
- Finalized
-
- Type: 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
-
- Type: string
The unique identifier for the revision.
- RevocationComment
-
- Type: string
A required comment to inform subscribers of the reason their access to the revision was revoked.
- Revoked
-
- Type: boolean
A status indicating that subscribers' access to the revision was revoked.
- RevokedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time that the revision was revoked, in ISO 8601 format.
- SourceId
-
- Type: 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
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time that the revision was last updated, in ISO 8601 format.
Errors
-
The resource couldn't be found.
-
The limit on the number of requests per second was exceeded.
-
Access to the resource is denied.
-
The request couldn't be completed because it conflicted with the current state of the resource.
-
The request was invalid.
-
An exception occurred with the service.
Shapes
AccessDeniedException
Description
Access to the resource is denied.
Members
Action
Description
What occurs after a certain event.
Members
- ExportRevisionToS3
-
- Type: AutoExportRevisionToS3RequestDetails structure
Details for the export revision to Amazon S3 action.
ApiGatewayApiAsset
Description
The API Gateway API that is the asset.
Members
- ApiDescription
-
- Type: string
The API description of the API asset.
- ApiEndpoint
-
- Type: string
The API endpoint of the API asset.
- ApiId
-
- Type: string
The unique identifier of the API asset.
- ApiKey
-
- Type: string
The API key of the API asset.
- ApiName
-
- Type: string
The API name of the API asset.
- ApiSpecificationDownloadUrl
-
- Type: string
The download URL of the API specification of the API asset.
- ApiSpecificationDownloadUrlExpiresAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time that the upload URL expires, in ISO 8601 format.
- ProtocolType
-
- Type: string
The protocol type of the API asset.
- Stage
-
- Type: string
The stage of the API asset.
AssetDestinationEntry
Description
The destination for the asset.
Members
AssetDetails
Description
Information about the asset.
Members
- ApiGatewayApiAsset
-
- Type: ApiGatewayApiAsset structure
Information about the API Gateway API asset.
- RedshiftDataShareAsset
-
- Type: RedshiftDataShareAsset structure
The Amazon Redshift datashare that is the asset.
- S3SnapshotAsset
-
- Type: S3SnapshotAsset structure
The S3 object that is the asset.
AssetEntry
Description
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. When you create an import job for your files, API Gateway APIs, or Amazon Redshift datashares, you create an asset in AWS Data Exchange.
Members
- Arn
-
- Required: Yes
- Type: string
The ARN for the asset.
- AssetDetails
-
- Required: Yes
- Type: AssetDetails structure
Information about the asset.
- AssetType
-
- Required: Yes
- Type: string
The type of asset that is added to a data set.
- CreatedAt
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time that the asset was created, in ISO 8601 format.
- DataSetId
-
- Required: Yes
- Type: string
The unique identifier for the data set associated with this asset.
- Id
-
- Required: Yes
- Type: string
The unique identifier for the asset.
- Name
-
- Required: Yes
- Type: 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
-
- Required: Yes
- Type: string
The unique identifier for the revision associated with this asset.
- SourceId
-
- Type: 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
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time that the asset was last updated, in ISO 8601 format.
AssetSourceEntry
Description
The source of the assets.
Members
AutoExportRevisionDestinationEntry
Description
A revision destination is the Amazon S3 bucket folder destination to where the export will be sent.
Members
- Bucket
-
- Required: Yes
- Type: string
The S3 bucket that is the destination for the event action.
- KeyPattern
-
- Type: 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.
AutoExportRevisionToS3RequestDetails
Description
Details of the operation to be performed by the job.
Members
- Encryption
-
- Type: ExportServerSideEncryption structure
Encryption configuration for the auto export job.
- RevisionDestination
-
- Required: Yes
- Type: AutoExportRevisionDestinationEntry structure
A revision destination is the Amazon S3 bucket folder destination to where the export will be sent.
ConflictException
Description
The request couldn't be completed because it conflicted with the current state of the resource.
Members
DataSetEntry
Description
A data set is an AWS resource with one or more revisions.
Members
- Arn
-
- Required: Yes
- Type: string
The ARN for the data set.
- AssetType
-
- Required: Yes
- Type: string
The type of asset that is added to a data set.
- CreatedAt
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time that the data set was created, in ISO 8601 format.
- Description
-
- Required: Yes
- Type: string
The description for the data set.
- Id
-
- Required: Yes
- Type: string
The unique identifier for the data set.
- Name
-
- Required: Yes
- Type: string
The name of the data set.
- Origin
-
- Required: Yes
- Type: string
A property that defines the data set as OWNED by the account (for providers) or ENTITLED to the account (for subscribers).
- OriginDetails
-
- Type: OriginDetails structure
If the origin of this data set is ENTITLED, includes the details for the product on AWS Marketplace.
- SourceId
-
- Type: 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
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time that the data set was last updated, in ISO 8601 format.
Details
Description
Information about the job error.
Members
- ImportAssetFromSignedUrlJobErrorDetails
-
- Type: ImportAssetFromSignedUrlJobErrorDetails structure
Information about the job error.
- ImportAssetsFromS3JobErrorDetails
-
- Type: Array of AssetSourceEntry structures
Information about the job error.
Event
Description
What occurs to start an action.
Members
- RevisionPublished
-
- Type: RevisionPublished structure
What occurs to start the revision publish action.
EventActionEntry
Description
An event action is an object that defines the relationship between a specific event and an automated action that will be taken on behalf of the customer.
Members
- Action
-
- Required: Yes
- Type: Action structure
What occurs after a certain event.
- Arn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) for the event action.
- CreatedAt
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time that the event action was created, in ISO 8601 format.
- Event
-
- Required: Yes
- Type: Event structure
What occurs to start an action.
- Id
-
- Required: Yes
- Type: string
The unique identifier for the event action.
- UpdatedAt
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time that the event action was last updated, in ISO 8601 format.
ExportAssetToSignedUrlRequestDetails
Description
Details of the operation to be performed by the job.
Members
- AssetId
-
- Required: Yes
- Type: string
The unique identifier for the asset that is exported to a signed URL.
- DataSetId
-
- Required: Yes
- Type: string
The unique identifier for the data set associated with this export job.
- RevisionId
-
- Required: Yes
- Type: string
The unique identifier for the revision associated with this export request.
ExportAssetToSignedUrlResponseDetails
Description
The details of the export to signed URL response.
Members
- AssetId
-
- Required: Yes
- Type: string
The unique identifier for the asset associated with this export job.
- DataSetId
-
- Required: Yes
- Type: string
The unique identifier for the data set associated with this export job.
- RevisionId
-
- Required: Yes
- Type: string
The unique identifier for the revision associated with this export response.
- SignedUrl
-
- Type: string
The signed URL for the export request.
- SignedUrlExpiresAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time that the signed URL expires, in ISO 8601 format.
ExportAssetsToS3RequestDetails
Description
Details of the operation to be performed by the job.
Members
- AssetDestinations
-
- Required: Yes
- Type: Array of AssetDestinationEntry structures
The destination for the asset.
- DataSetId
-
- Required: Yes
- Type: string
The unique identifier for the data set associated with this export job.
- Encryption
-
- Type: ExportServerSideEncryption structure
Encryption configuration for the export job.
- RevisionId
-
- Required: Yes
- Type: string
The unique identifier for the revision associated with this export request.
ExportAssetsToS3ResponseDetails
Description
Details about the export to Amazon S3 response.
Members
- AssetDestinations
-
- Required: Yes
- Type: Array of AssetDestinationEntry structures
The destination in Amazon S3 where the asset is exported.
- DataSetId
-
- Required: Yes
- Type: string
The unique identifier for the data set associated with this export job.
- Encryption
-
- Type: ExportServerSideEncryption structure
Encryption configuration of the export job.
- RevisionId
-
- Required: Yes
- Type: string
The unique identifier for the revision associated with this export response.
ExportRevisionsToS3RequestDetails
Description
Details of the operation to be performed by the job.
Members
- DataSetId
-
- Required: Yes
- Type: string
The unique identifier for the data set associated with this export job.
- Encryption
-
- Type: ExportServerSideEncryption structure
Encryption configuration for the export job.
- RevisionDestinations
-
- Required: Yes
- Type: Array of RevisionDestinationEntry structures
The destination for the revision.
ExportRevisionsToS3ResponseDetails
Description
Details about the export revisions to Amazon S3 response.
Members
- DataSetId
-
- Required: Yes
- Type: string
The unique identifier for the data set associated with this export job.
- Encryption
-
- Type: ExportServerSideEncryption structure
Encryption configuration of the export job.
- EventActionArn
-
- Type: string
The Amazon Resource Name (ARN) of the event action.
- RevisionDestinations
-
- Required: Yes
- Type: Array of RevisionDestinationEntry structures
The destination in Amazon S3 where the revision is exported.
ExportServerSideEncryption
Description
Encryption configuration of the export job. Includes the encryption type in addition to the AWS KMS key. The KMS key is only necessary if you chose the KMS encryption type.
Members
- KmsKeyArn
-
- Type: 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
-
- Required: Yes
- Type: string
The type of server side encryption used for encrypting the objects in Amazon S3.
ImportAssetFromApiGatewayApiRequestDetails
Description
The request details.
Members
- ApiDescription
-
- Type: string
The API description. Markdown supported.
- ApiId
-
- Required: Yes
- Type: string
The API Gateway API ID.
- ApiKey
-
- Type: string
The API Gateway API key.
- ApiName
-
- Required: Yes
- Type: string
The API name.
- ApiSpecificationMd5Hash
-
- Required: Yes
- Type: string
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
-
- Required: Yes
- Type: string
The data set ID.
- ProtocolType
-
- Required: Yes
- Type: string
The protocol type.
- RevisionId
-
- Required: Yes
- Type: string
The revision ID.
- Stage
-
- Required: Yes
- Type: string
The API stage.
ImportAssetFromApiGatewayApiResponseDetails
Description
The response details.
Members
- ApiDescription
-
- Type: string
The API description.
- ApiId
-
- Required: Yes
- Type: string
The API ID.
- ApiKey
-
- Type: string
The API key.
- ApiName
-
- Required: Yes
- Type: string
The API name.
- ApiSpecificationMd5Hash
-
- Required: Yes
- Type: string
The Base64-encoded Md5 hash for the API asset, used to ensure the integrity of the API at that location.
- ApiSpecificationUploadUrl
-
- Required: Yes
- Type: string
The upload URL of the API specification.
- ApiSpecificationUploadUrlExpiresAt
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time that the upload URL expires, in ISO 8601 format.
- DataSetId
-
- Required: Yes
- Type: string
The data set ID.
- ProtocolType
-
- Required: Yes
- Type: string
The protocol type.
- RevisionId
-
- Required: Yes
- Type: string
The revision ID.
- Stage
-
- Required: Yes
- Type: string
The API stage.
ImportAssetFromSignedUrlJobErrorDetails
Description
Information about the job error.
Members
ImportAssetFromSignedUrlRequestDetails
Description
Details of the operation to be performed by the job.
Members
- AssetName
-
- Required: Yes
- Type: string
The name of the asset. When importing from Amazon S3, the S3 object key is used as the asset name.
- DataSetId
-
- Required: Yes
- Type: string
The unique identifier for the data set associated with this import job.
- Md5Hash
-
- Required: Yes
- Type: string
The Base64-encoded Md5 hash for the asset, used to ensure the integrity of the file at that location.
- RevisionId
-
- Required: Yes
- Type: string
The unique identifier for the revision associated with this import request.
ImportAssetFromSignedUrlResponseDetails
Description
The details in the response for an import request, including the signed URL and other information.
Members
- AssetName
-
- Required: Yes
- Type: string
The name for the asset associated with this import job.
- DataSetId
-
- Required: Yes
- Type: string
The unique identifier for the data set associated with this import job.
- Md5Hash
-
- Type: string
The Base64-encoded Md5 hash for the asset, used to ensure the integrity of the file at that location.
- RevisionId
-
- Required: Yes
- Type: string
The unique identifier for the revision associated with this import response.
- SignedUrl
-
- Type: string
The signed URL.
- SignedUrlExpiresAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time and date at which the signed URL expires, in ISO 8601 format.
ImportAssetsFromRedshiftDataSharesRequestDetails
Description
Details from an import from Amazon Redshift datashare request.
Members
- AssetSources
-
- Required: Yes
- Type: Array of RedshiftDataShareAssetSourceEntry structures
A list of Amazon Redshift datashare assets.
- DataSetId
-
- Required: Yes
- Type: string
The unique identifier for the data set associated with this import job.
- RevisionId
-
- Required: Yes
- Type: string
The unique identifier for the revision associated with this import job.
ImportAssetsFromRedshiftDataSharesResponseDetails
Description
Details from an import from Amazon Redshift datashare response.
Members
- AssetSources
-
- Required: Yes
- Type: Array of RedshiftDataShareAssetSourceEntry structures
A list of Amazon Redshift datashare asset sources.
- DataSetId
-
- Required: Yes
- Type: string
The unique identifier for the data set associated with this import job.
- RevisionId
-
- Required: Yes
- Type: string
The unique identifier for the revision associated with this import job.
ImportAssetsFromS3RequestDetails
Description
Details of the operation to be performed by the job.
Members
- AssetSources
-
- Required: Yes
- Type: Array of AssetSourceEntry structures
Is a list of S3 bucket and object key pairs.
- DataSetId
-
- Required: Yes
- Type: string
The unique identifier for the data set associated with this import job.
- RevisionId
-
- Required: Yes
- Type: string
The unique identifier for the revision associated with this import request.
ImportAssetsFromS3ResponseDetails
Description
Details from an import from Amazon S3 response.
Members
- AssetSources
-
- Required: Yes
- Type: Array of AssetSourceEntry structures
Is a list of Amazon S3 bucket and object key pairs.
- DataSetId
-
- Required: Yes
- Type: string
The unique identifier for the data set associated with this import job.
- RevisionId
-
- Required: Yes
- Type: string
The unique identifier for the revision associated with this import response.
InternalServerException
Description
An exception occurred with the service.
Members
JobEntry
Description
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.
Members
- Arn
-
- Required: Yes
- Type: string
The ARN for the job.
- CreatedAt
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time that the job was created, in ISO 8601 format.
- Details
-
- Required: Yes
- Type: ResponseDetails structure
Details of the operation to be performed by the job, such as export destination details or import source details.
- Errors
-
- Type: Array of JobError structures
Errors for jobs.
- Id
-
- Required: Yes
- Type: string
The unique identifier for the job.
- State
-
- Required: Yes
- Type: string
The state of the job.
- Type
-
- Required: Yes
- Type: string
The job type.
- UpdatedAt
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time that the job was last updated, in ISO 8601 format.
JobError
Description
An error that occurred with the job request.
Members
- Code
-
- Required: Yes
- Type: string
The code for the job error.
- Details
-
- Type: Details structure
The details about the job error.
- LimitName
-
- Type: string
The name of the limit that was reached.
- LimitValue
-
- Type: double
The value of the exceeded limit.
- Message
-
- Required: Yes
- Type: string
The message related to the job error.
- ResourceId
-
- Type: string
The unique identifier for the resource related to the error.
- ResourceType
-
- Type: string
The type of resource related to the error.
OriginDetails
Description
Information about the origin of the data set.
Members
RedshiftDataShareAsset
Description
The Amazon Redshift datashare asset.
Members
RedshiftDataShareAssetSourceEntry
Description
The source of the Amazon Redshift datashare asset.
Members
RequestDetails
Description
The details for the request.
Members
- ExportAssetToSignedUrl
-
- Type: ExportAssetToSignedUrlRequestDetails structure
Details about the export to signed URL request.
- ExportAssetsToS3
-
- Type: ExportAssetsToS3RequestDetails structure
Details about the export to Amazon S3 request.
- ExportRevisionsToS3
-
- Type: ExportRevisionsToS3RequestDetails structure
Details about the export to Amazon S3 request.
- ImportAssetFromApiGatewayApi
-
- Type: ImportAssetFromApiGatewayApiRequestDetails structure
Details about the import from signed URL request.
- ImportAssetFromSignedUrl
-
- Type: ImportAssetFromSignedUrlRequestDetails structure
Details about the import from Amazon S3 request.
- ImportAssetsFromRedshiftDataShares
-
- Type: ImportAssetsFromRedshiftDataSharesRequestDetails structure
Details from an import from Amazon Redshift datashare request.
- ImportAssetsFromS3
-
- Type: ImportAssetsFromS3RequestDetails structure
Information about the import asset from API Gateway API request.
ResourceNotFoundException
Description
The resource couldn't be found.
Members
ResponseDetails
Description
Details for the response.
Members
- ExportAssetToSignedUrl
-
- Type: ExportAssetToSignedUrlResponseDetails structure
Details for the export to signed URL response.
- ExportAssetsToS3
-
- Type: ExportAssetsToS3ResponseDetails structure
Details for the export to Amazon S3 response.
- ExportRevisionsToS3
-
- Type: ExportRevisionsToS3ResponseDetails structure
Details for the export revisions to Amazon S3 response.
- ImportAssetFromApiGatewayApi
-
- Type: ImportAssetFromApiGatewayApiResponseDetails structure
The response details.
- ImportAssetFromSignedUrl
-
- Type: ImportAssetFromSignedUrlResponseDetails structure
Details for the import from signed URL response.
- ImportAssetsFromRedshiftDataShares
-
- Type: ImportAssetsFromRedshiftDataSharesResponseDetails structure
Details from an import from Amazon Redshift datashare response.
- ImportAssetsFromS3
-
- Type: ImportAssetsFromS3ResponseDetails structure
Details for the import from Amazon S3 response.
RevisionDestinationEntry
Description
The destination where the assets in the revision will be exported.
Members
- Bucket
-
- Required: Yes
- Type: string
The S3 bucket that is the destination for the assets in the revision.
- KeyPattern
-
- Type: 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
-
- Required: Yes
- Type: string
The unique identifier for the revision.
RevisionEntry
Description
A revision is a container for one or more assets.
Members
- Arn
-
- Required: Yes
- Type: string
The ARN for the revision.
- Comment
-
- Type: string
An optional comment about the revision.
- CreatedAt
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time that the revision was created, in ISO 8601 format.
- DataSetId
-
- Required: Yes
- Type: string
The unique identifier for the data set associated with this revision.
- Finalized
-
- Type: 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
-
- Required: Yes
- Type: string
The unique identifier for the revision.
- RevocationComment
-
- Type: string
A required comment to inform subscribers of the reason their access to the revision was revoked.
- Revoked
-
- Type: boolean
A status indicating that subscribers' access to the revision was revoked.
- RevokedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time that the revision was revoked, in ISO 8601 format.
- SourceId
-
- Type: 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
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time that the revision was last updated, in ISO 8601 format.
RevisionPublished
Description
Information about the published revision.
Members
S3SnapshotAsset
Description
The S3 object that is the asset.
Members
ServiceLimitExceededException
Description
The request has exceeded the quotas imposed by the service.
Members
ThrottlingException
Description
The limit on the number of requests per second was exceeded.