[ aws . dataexchange ]

send-api-asset

Description

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

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  send-api-asset
[--body <value>]
[--query-string-parameters <value>]
--asset-id <value>
--data-set-id <value>
[--request-headers <value>]
[--method <value>]
[--path <value>]
--revision-id <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--body (string)

The request body.

--query-string-parameters (map)

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

key -> (string)

value -> (string)

Shorthand Syntax:

KeyName1=string,KeyName2=string

JSON Syntax:

{"string": "string"
  ...}

--asset-id (string)

Asset ID value for the API request.

--data-set-id (string)

Data set ID value for the API request.

--request-headers (map)

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.

key -> (string)

value -> (string)

Shorthand Syntax:

KeyName1=string,KeyName2=string

JSON Syntax:

{"string": "string"
  ...}

--method (string)

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

--path (string)

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

--revision-id (string)

Revision ID value for the API request.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

See ‘aws help’ for descriptions of global parameters.

Output

Body -> (string)

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

ResponseHeaders -> (map)

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

key -> (string)

value -> (string)