Skip to content

SendApiAssetRequest

Source code in docs_src/capo_dataexchange/types/send_api_asset_request.py
class SendApiAssetRequest(TypedDict, closed=True):
    body: NotRequired["capo_dataexchange.types.__string.__string"]
    """<p>The request body.</p>"""
    query_string_parameters: NotRequired[
        "capo_dataexchange.types.map_of__string.MapOf__string"
    ]
    """<p>Attach query string parameters to the end of the URI (for example, /v1/examplePath?exampleParam=exampleValue).</p>"""
    asset_id: "capo_dataexchange.types.__string.__string"
    """<p>Asset ID value for the API request.</p>"""
    data_set_id: "capo_dataexchange.types.__string.__string"
    """<p>Data set ID value for the API request.</p>"""
    request_headers: NotRequired["capo_dataexchange.types.map_of__string.MapOf__string"]
    """<p>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.</p>"""
    method: NotRequired["capo_dataexchange.types.__string.__string"]
    """<p>HTTP method value for the API request. Alternatively, you can use the appropriate verb in your request.</p>"""
    path: NotRequired["capo_dataexchange.types.__string.__string"]
    """<p>URI path value for the API request. Alternatively, you can set the URI path directly by invoking /v1/{pathValue}.</p>"""
    revision_id: "capo_dataexchange.types.__string.__string"
    """<p>Revision ID value for the API request.</p>"""

asset_id instance-attribute

asset_id: __string

Asset ID value for the API request.

body instance-attribute

body: NotRequired[__string]

The request body.

data_set_id instance-attribute

data_set_id: __string

Data set ID value for the API request.

method instance-attribute

method: NotRequired[__string]

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

path instance-attribute

path: NotRequired[__string]

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

query_string_parameters instance-attribute

query_string_parameters: NotRequired[MapOf__string]

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

request_headers instance-attribute

request_headers: NotRequired[MapOf__string]

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.

revision_id instance-attribute

revision_id: __string

Revision ID value for the API request.