Asset - AWS Data Exchange

Asset

An asset in AWS Data Exchange is a piece of data (S3 object), or a means of fulfilling data (Amazon Redshift datashare or Amazon API Gateway API). The asset can be a structured data file, an image file, or some other data file that can be stored as an S3 object, an Amazon API Gateway API, or an Amazon Redshift datashare (Preview). When you create an import job for your files, API Gateway APIs, or Amazon Redshift datashares, you create an asset in AWS Data Exchange. 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
NameTypeRequiredDescription
RevisionIdStringTrue

The unique identifier for a revision.

AssetIdStringTrue

The unique identifier for an asset.

DataSetIdStringTrue

The unique identifier for a data set.

Responses
Status codeResponse modelDescription
200Asset

200 response

400ValidationException

400 response

404ResourceNotFoundException

404 response

429ThrottlingException

429 response

500InternalServerException

500 response

DELETE

Operation ID: DeleteAsset

This operation deletes an asset.

Path parameters
NameTypeRequiredDescription
RevisionIdStringTrue

The unique identifier for a revision.

AssetIdStringTrue

The unique identifier for an asset.

DataSetIdStringTrue

The unique identifier for a data set.

Responses
Status codeResponse modelDescription
204None

204 response

400ValidationException

400 response

403AccessDeniedException

403 response

404ResourceNotFoundException

404 response

409ConflictException

409 response

429ThrottlingException

429 response

500InternalServerException

500 response

PATCH

Operation ID: UpdateAsset

This operation updates an asset.

Path parameters
NameTypeRequiredDescription
RevisionIdStringTrue

The unique identifier for a revision.

AssetIdStringTrue

The unique identifier for an asset.

DataSetIdStringTrue

The unique identifier for a data set.

Responses
Status codeResponse modelDescription
200Asset

200 response

400ValidationException

400 response

403AccessDeniedException

403 response

404ResourceNotFoundException

404 response

409ConflictException

409 response

429ThrottlingException

429 response

500InternalServerException

500 response

Schemas

Request bodies

{ "Name": "string" }

Response bodies

{ "Name": "string", "RevisionId": "string", "DataSetId": "string", "AssetType": enum, "AssetDetails": { "S3SnapshotAsset": { "Size": number }, "RedshiftDataShareAsset": { "Arn": "string" }, "ApiGatewayApiAsset": { "ApiId": "string", "ProtocolType": enum, "Stage": "string", "ApiEndpoint": "string", "ApiKey": "string", "ApiName": "string", "ApiDescription": "string", "ApiSpecificationDownloadUrl": "string", "ApiSpecificationDownloadUrlExpiresAt": "string" } }, "Arn": "string", "Id": "string", "SourceId": "string", "CreatedAt": "string", "UpdatedAt": "string" }
{ "Message": "string", "ExceptionCause": enum }
{ "Message": "string" }
{ "Message": "string", "ResourceType": enum, "ResourceId": "string" }
{ "Message": "string", "ResourceType": enum, "ResourceId": "string" }
{ "Message": "string" }
{ "Message": "string" }

Properties

AccessDeniedException

Access to the resource is denied.

PropertyTypeRequiredDescription
Message

string

True

Access to the resource is denied.

ApiGatewayApiAsset

The API Gateway API that is the asset.

PropertyTypeRequiredDescription
ApiDescription

string

False

The API description of the API asset.

ApiEndpoint

string

False

The API endpoint of the API asset.

ApiId

string

False

The unique identifier of the API asset.

ApiKey

string

False

The API key of the API asset.

ApiName

string

False

The API name of the API asset.

ApiSpecificationDownloadUrl

string

False

The download URL of the API specification of the API asset.

ApiSpecificationDownloadUrlExpiresAt

string

False

The date and time that the upload URL expires, in ISO 8601 format.

ProtocolType

string

Values: REST

False

The protocol type of the API asset.

Stage

string

False

The stage of the API asset.

Asset

An asset in AWS Data Exchange is a piece of data (S3 object) or a means of fulfilling data (Amazon Redshift datashare or Amazon API Gateway API). The asset can be a structured data file, an image file, or some other data file that can be stored as an S3 object, an Amazon API Gateway API, or an Amazon Redshift datashare (Preview). When you create an import job for your files, API Gateway APIs, or Amazon Redshift datashares, you create an asset in AWS Data Exchange.

PropertyTypeRequiredDescription
Arn

string

True

The ARN for the asset.

AssetDetails

AssetDetails

True

Information about the asset.

AssetType

AssetType

True

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

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.

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. When importing from Amazon API Gateway API, the API name is used as the asset name. When importing from Amazon Redshift, the datashare name is used as the asset name.

RevisionId

string

True

The unique identifier for the revision associated with this asset.

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.

UpdatedAt

string

True

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

AssetDetails

Information about the asset.

PropertyTypeRequiredDescription
ApiGatewayApiAsset

ApiGatewayApiAsset

False

Information about the API Gateway API asset.

RedshiftDataShareAsset

RedshiftDataShareAsset

False

The Amazon Redshift datashare that is the asset.

S3SnapshotAsset

S3SnapshotAsset

False

The S3 object that is the asset.

AssetType

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

  • S3_SNAPSHOT

  • REDSHIFT_DATA_SHARE

  • API_GATEWAY_API

ConflictException

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

PropertyTypeRequiredDescription
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 | EVENT_ACTION

False

The type of the resource with the conflict.

InternalServerException

An exception occurred with the service.

PropertyTypeRequiredDescription
Message

string

True

The message identifying the service exception that occurred.

RedshiftDataShareAsset

The Amazon Redshift datashare asset.

PropertyTypeRequiredDescription
Arn

string

True

The Amazon Resource Name (ARN) of the datashare asset.

ResourceNotFoundException

The resource couldn't be found.

PropertyTypeRequiredDescription
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 | EVENT_ACTION

False

The type of resource that couldn't be found.

S3SnapshotAsset

The S3 object that is the asset.

PropertyTypeRequiredDescription
Size

number

Format: float

Minimum: 0.0

True

The size of the S3 object that is the object.

ThrottlingException

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

PropertyTypeRequiredDescription
Message

string

True

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

UpdateAssetRequest

The request to update an asset.

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

ValidationException

The request was invalid.

PropertyTypeRequiredDescription
ExceptionCause

string

Values: InsufficientS3BucketPolicy | S3AccessDenied

False

The message that informs you about what the exception was.

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