Send API Asset - AWS Data Exchange

Send API Asset

You can invoke an API Gateway API asset. This section defines the SendApiAsset operation. The base URL for this API is available at the following subdomain: http://api-fulfill.dataexchange.us-east-1.amazonaws.com/v1/. Anything added at the end of the URI will be proxied.

While the documentation below describes making a POST request, any HTTP verb is supported. Some verbs may not support all features (for example, a GET typically does not have a request body).

URI

/v1

HTTP methods

POST

Operation ID: SendApiAsset

This operation invokes an API Gateway API asset. The request is proxied to the provider’s API Gateway API.

Header parameters
NameTypeRequiredDescription
x-amzn-dataexchange-header-StringFalse

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.

x-amzn-dataexchange-pathStringFalse

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

x-amzn-dataexchange-http-methodStringFalse

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

x-amzn-dataexchange-data-set-idStringTrue

Data set ID value for the API request.

x-amzn-dataexchange-revision-idStringTrue

Revision ID value for the API request.

x-amzn-dataexchange-asset-idStringTrue

Asset ID value for the API request.

Query parameters
NameTypeRequiredDescription
QueryStringParametersStringFalse

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

Responses
Status codeResponse modelDescription
200SendApiAssetResponse

200 response

400ValidationException

400 response

403AccessDeniedException

403 response

404ResourceNotFoundException

404 response

429ThrottlingException

429 response

500InternalServerException

500 response

Schemas

Request bodies

{ "body": "string" }

Response bodies

{ "body": "string", "headers": { } }
{ "Message": "string", "ExceptionCause": enum }
{ "Message": "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.

Body

The API request body should be exactly what you to send to the provider's asset. There is no need to wrap it or to send JSON.

PropertyTypeRequiredDescription
body

string

False

The request body.

InternalServerException

An exception occurred with the service.

PropertyTypeRequiredDescription
Message

string

True

The message identifying the service exception that occurred.

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.

SendApiAssetResponse

The details of the send API asset response.

PropertyTypeRequiredDescription
body

string

False

The response body from the underlying API tracked by the API asset.

headers

object

False

The response headers from the underlying API tracked by the API asset.

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.

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:

SendApiAsset