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

Amazonka.DataExchange.SendApiAsset

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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

Synopsis

data SendApiAsset = SendApiAsset' {
- body :: Maybe ByteString
- method :: Maybe Text
- path :: Maybe Text
- queryStringParameters :: Maybe (HashMap Text Text)
- requestHeaders :: HashMap Text Text
- assetId :: Text
- dataSetId :: Text
- revisionId :: Text
}
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' {
- body :: Maybe ByteString
- responseHeaders :: HashMap Text Text
- httpStatus :: Int
}
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.

Constructors

SendApiAsset'

Fields

body :: Maybe ByteString
The request body.
method :: Maybe Text
HTTP method value for the API request. Alternatively, you can use the appropriate verb in your request.
path :: Maybe Text
URI path value for the API request. Alternatively, you can set the URI path directly by invoking /v1/{pathValue}.
queryStringParameters :: Maybe (HashMap Text Text)
Attach query string parameters to the end of the URI (for example, /v1/examplePath?exampleParam=exampleValue).
requestHeaders :: HashMap Text Text
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.
assetId :: Text
Asset ID value for the API request.
dataSetId :: Text
Data set ID value for the API request.
revisionId :: Text
Revision ID value for the API request.

Instances

Instances details

ToBody SendApiAsset Source #
Instance details Defined in Amazonka.DataExchange.SendApiAsset Methods toBody :: SendApiAsset -> RequestBody #
ToHeaders SendApiAsset Source #
Instance details Defined in Amazonka.DataExchange.SendApiAsset Methods toHeaders :: SendApiAsset -> [Header] #
ToPath SendApiAsset Source #
Instance details Defined in Amazonka.DataExchange.SendApiAsset Methods toPath :: SendApiAsset -> ByteString #
ToQuery SendApiAsset Source #
Instance details Defined in Amazonka.DataExchange.SendApiAsset Methods toQuery :: SendApiAsset -> QueryString #
AWSRequest SendApiAsset Source #
Instance details Defined in Amazonka.DataExchange.SendApiAsset Associated Types type AWSResponse SendApiAsset # Methods request :: (Service -> Service) -> SendApiAsset -> Request SendApiAsset # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy SendApiAsset -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse SendApiAsset))) #
Generic SendApiAsset Source #
Instance details Defined in Amazonka.DataExchange.SendApiAsset Associated Types type Rep SendApiAsset :: Type -> Type # Methods from :: SendApiAsset -> Rep SendApiAsset x # to :: Rep SendApiAsset x -> SendApiAsset #
Read SendApiAsset Source #
Instance details Defined in Amazonka.DataExchange.SendApiAsset Methods readsPrec :: Int -> ReadS SendApiAsset # readList :: ReadS [SendApiAsset] # readPrec :: ReadPrec SendApiAsset # readListPrec :: ReadPrec [SendApiAsset] #
Show SendApiAsset Source #
Instance details Defined in Amazonka.DataExchange.SendApiAsset Methods showsPrec :: Int -> SendApiAsset -> ShowS # show :: SendApiAsset -> String # showList :: [SendApiAsset] -> ShowS #
NFData SendApiAsset Source #
Instance details Defined in Amazonka.DataExchange.SendApiAsset Methods rnf :: SendApiAsset -> () #
Eq SendApiAsset Source #
Instance details Defined in Amazonka.DataExchange.SendApiAsset Methods (==) :: SendApiAsset -> SendApiAsset -> Bool # (/=) :: SendApiAsset -> SendApiAsset -> Bool #
Hashable SendApiAsset Source #
Instance details Defined in Amazonka.DataExchange.SendApiAsset Methods hashWithSalt :: Int -> SendApiAsset -> Int # hash :: SendApiAsset -> Int #
type AWSResponse SendApiAsset Source #
Instance details Defined in Amazonka.DataExchange.SendApiAsset type AWSResponse SendApiAsset = SendApiAssetResponse
type Rep SendApiAsset Source #
Instance details Defined in Amazonka.DataExchange.SendApiAsset type Rep SendApiAsset = D1 ('MetaData "SendApiAsset" "Amazonka.DataExchange.SendApiAsset" "amazonka-dataexchange-2.0-E9wmOad6xSxAaT3Y4FNlvY" 'False) (C1 ('MetaCons "SendApiAsset'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "body") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ByteString)) :: S1 ('MetaSel ('Just "method") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "path") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "queryStringParameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))))) :: ((S1 ('MetaSel ('Just "requestHeaders") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (HashMap Text Text)) :: S1 ('MetaSel ('Just "assetId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :: (S1 ('MetaSel ('Just "dataSetId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "revisionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newSendApiAsset Source #

Arguments

:: Text	`SendApiAsset`
-> Text	`SendApiAsset`
-> Text	`SendApiAsset`
-> SendApiAsset

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.

Constructors

SendApiAssetResponse'
Fields body :: Maybe ByteString The response body from the underlying API tracked by the API asset. responseHeaders :: HashMap Text Text The response headers from the underlying API tracked by the API asset. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic SendApiAssetResponse Source #
Instance details Defined in Amazonka.DataExchange.SendApiAsset Associated Types type Rep SendApiAssetResponse :: Type -> Type # Methods from :: SendApiAssetResponse -> Rep SendApiAssetResponse x # to :: Rep SendApiAssetResponse x -> SendApiAssetResponse #
Read SendApiAssetResponse Source #
Instance details Defined in Amazonka.DataExchange.SendApiAsset Methods readsPrec :: Int -> ReadS SendApiAssetResponse # readList :: ReadS [SendApiAssetResponse] # readPrec :: ReadPrec SendApiAssetResponse # readListPrec :: ReadPrec [SendApiAssetResponse] #
Show SendApiAssetResponse Source #
Instance details Defined in Amazonka.DataExchange.SendApiAsset Methods showsPrec :: Int -> SendApiAssetResponse -> ShowS # show :: SendApiAssetResponse -> String # showList :: [SendApiAssetResponse] -> ShowS #
NFData SendApiAssetResponse Source #
Instance details Defined in Amazonka.DataExchange.SendApiAsset Methods rnf :: SendApiAssetResponse -> () #
Eq SendApiAssetResponse Source #
Instance details Defined in Amazonka.DataExchange.SendApiAsset Methods (==) :: SendApiAssetResponse -> SendApiAssetResponse -> Bool # (/=) :: SendApiAssetResponse -> SendApiAssetResponse -> Bool #
type Rep SendApiAssetResponse Source #
Instance details Defined in Amazonka.DataExchange.SendApiAsset type Rep SendApiAssetResponse = D1 ('MetaData "SendApiAssetResponse" "Amazonka.DataExchange.SendApiAsset" "amazonka-dataexchange-2.0-E9wmOad6xSxAaT3Y4FNlvY" 'False) (C1 ('MetaCons "SendApiAssetResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "body") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ByteString)) :: (S1 ('MetaSel ('Just "responseHeaders") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (HashMap Text Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newSendApiAssetResponse Source #

Arguments

:: Int	`$sel:httpStatus:SendApiAssetResponse'`
-> SendApiAssetResponse

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.