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.Types.ApiGatewayApiAsset

Description

Synopsis

data ApiGatewayApiAsset = ApiGatewayApiAsset' {
- apiDescription :: Maybe Text
- apiEndpoint :: Maybe Text
- apiId :: Maybe Text
- apiKey :: Maybe Text
- apiName :: Maybe Text
- apiSpecificationDownloadUrl :: Maybe Text
- apiSpecificationDownloadUrlExpiresAt :: Maybe ISO8601
- protocolType :: Maybe ProtocolType
- stage :: Maybe Text
}
newApiGatewayApiAsset :: ApiGatewayApiAsset
apiGatewayApiAsset_apiDescription :: Lens' ApiGatewayApiAsset (Maybe Text)
apiGatewayApiAsset_apiEndpoint :: Lens' ApiGatewayApiAsset (Maybe Text)
apiGatewayApiAsset_apiId :: Lens' ApiGatewayApiAsset (Maybe Text)
apiGatewayApiAsset_apiKey :: Lens' ApiGatewayApiAsset (Maybe Text)
apiGatewayApiAsset_apiName :: Lens' ApiGatewayApiAsset (Maybe Text)
apiGatewayApiAsset_apiSpecificationDownloadUrl :: Lens' ApiGatewayApiAsset (Maybe Text)
apiGatewayApiAsset_apiSpecificationDownloadUrlExpiresAt :: Lens' ApiGatewayApiAsset (Maybe UTCTime)
apiGatewayApiAsset_protocolType :: Lens' ApiGatewayApiAsset (Maybe ProtocolType)
apiGatewayApiAsset_stage :: Lens' ApiGatewayApiAsset (Maybe Text)

Documentation

data ApiGatewayApiAsset Source #

The API Gateway API that is the asset.

See: newApiGatewayApiAsset smart constructor.

Constructors

ApiGatewayApiAsset'

Fields

apiDescription :: Maybe Text
The API description of the API asset.
apiEndpoint :: Maybe Text
The API endpoint of the API asset.
apiId :: Maybe Text
The unique identifier of the API asset.
apiKey :: Maybe Text
The API key of the API asset.
apiName :: Maybe Text
The API name of the API asset.
apiSpecificationDownloadUrl :: Maybe Text
The download URL of the API specification of the API asset.
apiSpecificationDownloadUrlExpiresAt :: Maybe ISO8601
The date and time that the upload URL expires, in ISO 8601 format.
protocolType :: Maybe ProtocolType
The protocol type of the API asset.
stage :: Maybe Text
The stage of the API asset.

Instances

Instances details

FromJSON ApiGatewayApiAsset Source #
Instance details Defined in Amazonka.DataExchange.Types.ApiGatewayApiAsset Methods parseJSON :: Value -> Parser ApiGatewayApiAsset # parseJSONList :: Value -> Parser [ApiGatewayApiAsset] #
Generic ApiGatewayApiAsset Source #
Instance details Defined in Amazonka.DataExchange.Types.ApiGatewayApiAsset Associated Types type Rep ApiGatewayApiAsset :: Type -> Type # Methods from :: ApiGatewayApiAsset -> Rep ApiGatewayApiAsset x # to :: Rep ApiGatewayApiAsset x -> ApiGatewayApiAsset #
Read ApiGatewayApiAsset Source #
Instance details Defined in Amazonka.DataExchange.Types.ApiGatewayApiAsset Methods readsPrec :: Int -> ReadS ApiGatewayApiAsset # readList :: ReadS [ApiGatewayApiAsset] # readPrec :: ReadPrec ApiGatewayApiAsset # readListPrec :: ReadPrec [ApiGatewayApiAsset] #
Show ApiGatewayApiAsset Source #
Instance details Defined in Amazonka.DataExchange.Types.ApiGatewayApiAsset Methods showsPrec :: Int -> ApiGatewayApiAsset -> ShowS # show :: ApiGatewayApiAsset -> String # showList :: [ApiGatewayApiAsset] -> ShowS #
NFData ApiGatewayApiAsset Source #
Instance details Defined in Amazonka.DataExchange.Types.ApiGatewayApiAsset Methods rnf :: ApiGatewayApiAsset -> () #
Eq ApiGatewayApiAsset Source #
Instance details Defined in Amazonka.DataExchange.Types.ApiGatewayApiAsset Methods (==) :: ApiGatewayApiAsset -> ApiGatewayApiAsset -> Bool # (/=) :: ApiGatewayApiAsset -> ApiGatewayApiAsset -> Bool #
Hashable ApiGatewayApiAsset Source #
Instance details Defined in Amazonka.DataExchange.Types.ApiGatewayApiAsset Methods hashWithSalt :: Int -> ApiGatewayApiAsset -> Int # hash :: ApiGatewayApiAsset -> Int #
type Rep ApiGatewayApiAsset Source #
Instance details Defined in Amazonka.DataExchange.Types.ApiGatewayApiAsset type Rep ApiGatewayApiAsset = D1 ('MetaData "ApiGatewayApiAsset" "Amazonka.DataExchange.Types.ApiGatewayApiAsset" "amazonka-dataexchange-2.0-E9wmOad6xSxAaT3Y4FNlvY" 'False) (C1 ('MetaCons "ApiGatewayApiAsset'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "apiDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "apiEndpoint") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "apiId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "apiKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "apiName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "apiSpecificationDownloadUrl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "apiSpecificationDownloadUrlExpiresAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601)) :: (S1 ('MetaSel ('Just "protocolType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ProtocolType)) :: S1 ('MetaSel ('Just "stage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))))

newApiGatewayApiAsset :: ApiGatewayApiAsset Source #

Create a value of ApiGatewayApiAsset 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:

$sel:apiDescription:ApiGatewayApiAsset', apiGatewayApiAsset_apiDescription - The API description of the API asset.

$sel:apiEndpoint:ApiGatewayApiAsset', apiGatewayApiAsset_apiEndpoint - The API endpoint of the API asset.

$sel:apiId:ApiGatewayApiAsset', apiGatewayApiAsset_apiId - The unique identifier of the API asset.

$sel:apiKey:ApiGatewayApiAsset', apiGatewayApiAsset_apiKey - The API key of the API asset.

$sel:apiName:ApiGatewayApiAsset', apiGatewayApiAsset_apiName - The API name of the API asset.

$sel:apiSpecificationDownloadUrl:ApiGatewayApiAsset', apiGatewayApiAsset_apiSpecificationDownloadUrl - The download URL of the API specification of the API asset.

$sel:apiSpecificationDownloadUrlExpiresAt:ApiGatewayApiAsset', apiGatewayApiAsset_apiSpecificationDownloadUrlExpiresAt - The date and time that the upload URL expires, in ISO 8601 format.

$sel:protocolType:ApiGatewayApiAsset', apiGatewayApiAsset_protocolType - The protocol type of the API asset.

$sel:stage:ApiGatewayApiAsset', apiGatewayApiAsset_stage - The stage of the API asset.

apiGatewayApiAsset_apiDescription :: Lens' ApiGatewayApiAsset (Maybe Text) Source #

The API description of the API asset.

apiGatewayApiAsset_apiEndpoint :: Lens' ApiGatewayApiAsset (Maybe Text) Source #

The API endpoint of the API asset.

apiGatewayApiAsset_apiId :: Lens' ApiGatewayApiAsset (Maybe Text) Source #

The unique identifier of the API asset.

apiGatewayApiAsset_apiKey :: Lens' ApiGatewayApiAsset (Maybe Text) Source #

The API key of the API asset.

apiGatewayApiAsset_apiName :: Lens' ApiGatewayApiAsset (Maybe Text) Source #

The API name of the API asset.

apiGatewayApiAsset_apiSpecificationDownloadUrl :: Lens' ApiGatewayApiAsset (Maybe Text) Source #

The download URL of the API specification of the API asset.

apiGatewayApiAsset_apiSpecificationDownloadUrlExpiresAt :: Lens' ApiGatewayApiAsset (Maybe UTCTime) Source #

The date and time that the upload URL expires, in ISO 8601 format.

apiGatewayApiAsset_protocolType :: Lens' ApiGatewayApiAsset (Maybe ProtocolType) Source #

The protocol type of the API asset.

apiGatewayApiAsset_stage :: Lens' ApiGatewayApiAsset (Maybe Text) Source #

The stage of the API asset.