Asset - AWS Data Exchange

Asset

An asset in AWS Data Exchange is a piece of data that can be stored as an S3 object. The asset can be a structured data file, an image file, or some other data file. When you create an import job for your files, you create an asset in AWS Data Exchange for each of those files. This section defines the GetAsset, DeleteAsset, and UpdateAsset operations.

URI

/v1/data-sets/DataSetId/revisions/RevisionId/assets/AssetId

HTTP Methods

GET

Operation ID: GetAsset

This operation returns information about an asset.

Path Parameters
Name Type Required Description
RevisionId String True

The unique identifier for a revision.

AssetId String True

The unique identifier for an asset.

DataSetId String True

The unique identifier for a data set.

Responses
Status Code Response Model Description
200 Asset

200 response

400 ValidationException

400 response

404 ResourceNotFoundException

404 response

429 ThrottlingException

429 response

500 InternalServerException

500 response

DELETE

Operation ID: DeleteAsset

This operation deletes an asset.

Path Parameters
Name Type Required Description
RevisionId String True

The unique identifier for a revision.

AssetId String True

The unique identifier for an asset.

DataSetId String True

The unique identifier for a data set.

Responses
Status Code Response Model Description
204 None

204 response

400 ValidationException

400 response

403 AccessDeniedException

403 response

404 ResourceNotFoundException

404 response

409 ConflictException

409 response

429 ThrottlingException

429 response

500 InternalServerException

500 response

PATCH

Operation ID: UpdateAsset

This operation updates an asset.

Path Parameters
Name Type Required Description
RevisionId String True

The unique identifier for a revision.

AssetId String True

The unique identifier for an asset.

DataSetId String True

The unique identifier for a data set.

Responses
Status Code Response Model Description
200 Asset

200 response

400 ValidationException

400 response

403 AccessDeniedException

403 response

404 ResourceNotFoundException

404 response

409 ConflictException

409 response

429 ThrottlingException

429 response

500 InternalServerException

500 response

Schemas

Request Bodies

Example PATCH

{ "Name": "string" }

Response Bodies

Example Asset

{ "AssetType": enum, "SourceId": "string", "CreatedAt": "string", "DataSetId": "string", "Id": "string", "AssetDetails": { }, "Arn": "string", "UpdatedAt": "string", "RevisionId": "string", "Name": "string" }

Example ValidationException

{ "Message": "string" }

Example AccessDeniedException

{ "Message": "string" }

Example ResourceNotFoundException

{ "Message": "string", "ResourceId": "string", "ResourceType": enum }

Example ConflictException

{ "Message": "string", "ResourceId": "string", "ResourceType": enum }

Example ThrottlingException

{ "Message": "string" }

Example InternalServerException

{ "Message": "string" }

Properties

AccessDeniedException

Access to the resource is denied.

Property Type Required Description
Message

string

True

Access to the resource is denied.

Asset

An asset in AWS Data Exchange is a piece of data that can be stored as an S3 object. The asset can be a structured data file, an image file, or some other data file. When you create an import job for your files, you create an asset in AWS Data Exchange for each of those files.

Property Type Required Description
AssetType

AssetType

True

The type of file your data is stored in. Currently, the supported asset type is S3_SNAPSHOT.

SourceId

string

False

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.

CreatedAt

string

True

The date and time that the asset was created, in ISO 8601 format.

DataSetId

string

True

The unique identifier for the data set associated with this asset.

Id

string

True

The unique identifier for the asset.

AssetDetails

object

True

Information about the asset, including its size.

Arn

string

True

The ARN for the asset.

UpdatedAt

string

True

The date and time that the asset was last updated, in ISO 8601 format.

RevisionId

string

True

The unique identifier for the revision associated with this asset.

Name

string

True

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.

AssetType

The type of file your data is stored in. Currently, the supported asset type is S3_SNAPSHOT.

  • S3_SNAPSHOT

ConflictException

The request couldn't be completed because it conflicted with the current state of the resource.

Property Type Required Description
Message

string

True

The request couldn't be completed because it conflicted with the current state of the resource.

ResourceId

string

False

The unique identifier for the resource with the conflict.

ResourceType

string

Values: DATA_SET | REVISION | ASSET | JOB

False

The type of the resource with the conflict.

InternalServerException

An exception occurred with the service.

Property Type Required Description
Message

string

True

The message identifying the service exception that occurred.

ResourceNotFoundException

The resource couldn't be found.

Property Type Required Description
Message

string

True

The resource couldn't be found.

ResourceId

string

False

The unique identifier for the resource that couldn't be found.

ResourceType

string

Values: DATA_SET | REVISION | ASSET | JOB

False

The type of resource that couldn't be found.

ThrottlingException

The limit on the number of requests per second was exceeded.

Property Type Required Description
Message

string

True

The limit on the number of requests per second was exceeded.

UpdateAssetRequest

The request to update an asset.

Property Type Required Description
Name

string

True

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.

ValidationException

The request was invalid.

Property Type Required Description
Message

string

True

The message that informs you about what was invalid about the request.

See Also

For more information about using this API in one of the language-specific AWS SDKs and references, see the following:

GetAsset

DeleteAsset

UpdateAsset