Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
This operation invokes an API Gateway API asset. The request is proxied to the provider’s API Gateway API.
Synopsis
- data SendApiAsset = SendApiAsset' {}
- newSendApiAsset :: Text -> Text -> Text -> SendApiAsset
- sendApiAsset_body :: Lens' SendApiAsset (Maybe ByteString)
- sendApiAsset_method :: Lens' SendApiAsset (Maybe Text)
- sendApiAsset_path :: Lens' SendApiAsset (Maybe Text)
- sendApiAsset_queryStringParameters :: Lens' SendApiAsset (Maybe (HashMap Text Text))
- sendApiAsset_requestHeaders :: Lens' SendApiAsset (HashMap Text Text)
- sendApiAsset_assetId :: Lens' SendApiAsset Text
- sendApiAsset_dataSetId :: Lens' SendApiAsset Text
- sendApiAsset_revisionId :: Lens' SendApiAsset Text
- data SendApiAssetResponse = SendApiAssetResponse' {}
- newSendApiAssetResponse :: Int -> SendApiAssetResponse
- sendApiAssetResponse_body :: Lens' SendApiAssetResponse (Maybe ByteString)
- sendApiAssetResponse_responseHeaders :: Lens' SendApiAssetResponse (HashMap Text Text)
- sendApiAssetResponse_httpStatus :: Lens' SendApiAssetResponse Int
Creating a Request
data SendApiAsset Source #
See: newSendApiAsset
smart constructor.
SendApiAsset' | |
|
Instances
Create a value of SendApiAsset
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
SendApiAsset
, sendApiAsset_body
- The request body.
$sel:method:SendApiAsset'
, sendApiAsset_method
- HTTP method value for the API request. Alternatively, you can use the
appropriate verb in your request.
$sel:path:SendApiAsset'
, sendApiAsset_path
- URI path value for the API request. Alternatively, you can set the URI
path directly by invoking /v1/{pathValue}.
$sel:queryStringParameters:SendApiAsset'
, sendApiAsset_queryStringParameters
- Attach query string parameters to the end of the URI (for example,
/v1/examplePath?exampleParam=exampleValue).
$sel:requestHeaders:SendApiAsset'
, sendApiAsset_requestHeaders
- 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.
SendApiAsset
, sendApiAsset_assetId
- Asset ID value for the API request.
SendApiAsset
, sendApiAsset_dataSetId
- Data set ID value for the API request.
SendApiAsset
, sendApiAsset_revisionId
- Revision ID value for the API request.
Request Lenses
sendApiAsset_body :: Lens' SendApiAsset (Maybe ByteString) Source #
The request body.
sendApiAsset_method :: Lens' SendApiAsset (Maybe Text) Source #
HTTP method value for the API request. Alternatively, you can use the appropriate verb in your request.
sendApiAsset_path :: Lens' SendApiAsset (Maybe Text) Source #
URI path value for the API request. Alternatively, you can set the URI path directly by invoking /v1/{pathValue}.
sendApiAsset_queryStringParameters :: Lens' SendApiAsset (Maybe (HashMap Text Text)) Source #
Attach query string parameters to the end of the URI (for example, /v1/examplePath?exampleParam=exampleValue).
sendApiAsset_requestHeaders :: Lens' SendApiAsset (HashMap Text Text) Source #
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.
sendApiAsset_assetId :: Lens' SendApiAsset Text Source #
Asset ID value for the API request.
sendApiAsset_dataSetId :: Lens' SendApiAsset Text Source #
Data set ID value for the API request.
sendApiAsset_revisionId :: Lens' SendApiAsset Text Source #
Revision ID value for the API request.
Destructuring the Response
data SendApiAssetResponse Source #
See: newSendApiAssetResponse
smart constructor.
SendApiAssetResponse' | |
|
Instances
newSendApiAssetResponse Source #
Create a value of SendApiAssetResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
SendApiAsset
, sendApiAssetResponse_body
- The response body from the underlying API tracked by the API asset.
$sel:responseHeaders:SendApiAssetResponse'
, sendApiAssetResponse_responseHeaders
- The response headers from the underlying API tracked by the API asset.
$sel:httpStatus:SendApiAssetResponse'
, sendApiAssetResponse_httpStatus
- The response's http status code.
Response Lenses
sendApiAssetResponse_body :: Lens' SendApiAssetResponse (Maybe ByteString) Source #
The response body from the underlying API tracked by the API asset.
sendApiAssetResponse_responseHeaders :: Lens' SendApiAssetResponse (HashMap Text Text) Source #
The response headers from the underlying API tracked by the API asset.
sendApiAssetResponse_httpStatus :: Lens' SendApiAssetResponse Int Source #
The response's http status code.