Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.APIGateway.GetApiKey

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Gets information about the current ApiKey resource.

Synopsis

data GetApiKey = GetApiKey' {
- includeValue :: Maybe Bool
- apiKey :: Text
}
newGetApiKey :: Text -> GetApiKey
getApiKey_includeValue :: Lens' GetApiKey (Maybe Bool)
getApiKey_apiKey :: Lens' GetApiKey Text
data ApiKey = ApiKey' {
- enabled :: Maybe Bool
- value :: Maybe Text
- customerId :: Maybe Text
- createdDate :: Maybe POSIX
- name :: Maybe Text
- id :: Maybe Text
- stageKeys :: Maybe [Text]
- lastUpdatedDate :: Maybe POSIX
- description :: Maybe Text
- tags :: Maybe (HashMap Text Text)
}
newApiKey :: ApiKey
apiKey_enabled :: Lens' ApiKey (Maybe Bool)
apiKey_value :: Lens' ApiKey (Maybe Text)
apiKey_customerId :: Lens' ApiKey (Maybe Text)
apiKey_createdDate :: Lens' ApiKey (Maybe UTCTime)
apiKey_name :: Lens' ApiKey (Maybe Text)
apiKey_id :: Lens' ApiKey (Maybe Text)
apiKey_stageKeys :: Lens' ApiKey (Maybe [Text])
apiKey_lastUpdatedDate :: Lens' ApiKey (Maybe UTCTime)
apiKey_description :: Lens' ApiKey (Maybe Text)
apiKey_tags :: Lens' ApiKey (Maybe (HashMap Text Text))

Creating a Request

data GetApiKey Source #

A request to get information about the current ApiKey resource.

See: newGetApiKey smart constructor.

Constructors

GetApiKey'
Fields includeValue :: Maybe Bool A boolean flag to specify whether (`true`) or not (`false`) the result contains the key value. apiKey :: Text Required The identifier of the ApiKey resource.

Instances

Instances details

Eq GetApiKey Source #
Instance details Defined in Amazonka.APIGateway.GetApiKey Methods (==) :: GetApiKey -> GetApiKey -> Bool # (/=) :: GetApiKey -> GetApiKey -> Bool #
Read GetApiKey Source #
Instance details Defined in Amazonka.APIGateway.GetApiKey Methods readsPrec :: Int -> ReadS GetApiKey # readList :: ReadS [GetApiKey] # readPrec :: ReadPrec GetApiKey # readListPrec :: ReadPrec [GetApiKey] #
Show GetApiKey Source #
Instance details Defined in Amazonka.APIGateway.GetApiKey Methods showsPrec :: Int -> GetApiKey -> ShowS # show :: GetApiKey -> String # showList :: [GetApiKey] -> ShowS #
Generic GetApiKey Source #
Instance details Defined in Amazonka.APIGateway.GetApiKey Associated Types type Rep GetApiKey :: Type -> Type # Methods from :: GetApiKey -> Rep GetApiKey x # to :: Rep GetApiKey x -> GetApiKey #
NFData GetApiKey Source #
Instance details Defined in Amazonka.APIGateway.GetApiKey Methods rnf :: GetApiKey -> () #
Hashable GetApiKey Source #
Instance details Defined in Amazonka.APIGateway.GetApiKey Methods hashWithSalt :: Int -> GetApiKey -> Int # hash :: GetApiKey -> Int #
AWSRequest GetApiKey Source #
Instance details Defined in Amazonka.APIGateway.GetApiKey Associated Types type AWSResponse GetApiKey # Methods request :: GetApiKey -> Request GetApiKey # response :: MonadResource m => Logger -> Service -> Proxy GetApiKey -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetApiKey))) #
ToHeaders GetApiKey Source #
Instance details Defined in Amazonka.APIGateway.GetApiKey Methods toHeaders :: GetApiKey -> [Header] #
ToPath GetApiKey Source #
Instance details Defined in Amazonka.APIGateway.GetApiKey Methods toPath :: GetApiKey -> ByteString #
ToQuery GetApiKey Source #
Instance details Defined in Amazonka.APIGateway.GetApiKey Methods toQuery :: GetApiKey -> QueryString #
type Rep GetApiKey Source #
Instance details Defined in Amazonka.APIGateway.GetApiKey type Rep GetApiKey = D1 ('MetaData "GetApiKey" "Amazonka.APIGateway.GetApiKey" "libZSservicesZSamazonka-apigatewayZSamazonka-apigateway" 'False) (C1 ('MetaCons "GetApiKey'" 'PrefixI 'True) (S1 ('MetaSel ('Just "includeValue") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "apiKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse GetApiKey Source #
Instance details Defined in Amazonka.APIGateway.GetApiKey type AWSResponse GetApiKey = ApiKey

newGetApiKey Source #

Arguments

:: Text	`$sel:apiKey:GetApiKey'`
-> GetApiKey

Create a value of GetApiKey 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:includeValue:GetApiKey', getApiKey_includeValue - A boolean flag to specify whether (true) or not (false) the result contains the key value.

$sel:apiKey:GetApiKey', getApiKey_apiKey - [Required] The identifier of the ApiKey resource.

Request Lenses

getApiKey_includeValue :: Lens' GetApiKey (Maybe Bool) Source #

A boolean flag to specify whether (true) or not (false) the result contains the key value.

getApiKey_apiKey :: Lens' GetApiKey Text Source #

Required: The identifier of the ApiKey resource.

Destructuring the Response

data ApiKey Source #

A resource that can be distributed to callers for executing Method resources that require an API key. API keys can be mapped to any Stage on any RestApi, which indicates that the callers with the API key can make requests to that stage.

Use API Keys

See: newApiKey smart constructor.

Constructors

ApiKey'

Fields

enabled :: Maybe Bool
Specifies whether the API Key can be used by callers.
value :: Maybe Text
The value of the API Key.
customerId :: Maybe Text
An AWS Marketplace customer identifier , when integrating with the AWS SaaS Marketplace.
createdDate :: Maybe POSIX
The timestamp when the API Key was created.
name :: Maybe Text
The name of the API Key.
id :: Maybe Text
The identifier of the API Key.
stageKeys :: Maybe [Text]
A list of Stage resources that are associated with the ApiKey resource.
lastUpdatedDate :: Maybe POSIX
The timestamp when the API Key was last updated.
description :: Maybe Text
The description of the API Key.
tags :: Maybe (HashMap Text Text)
The collection of tags. Each tag element is associated with a given resource.

Instances

Instances details

Eq ApiKey Source #
Instance details Defined in Amazonka.APIGateway.Types.ApiKey Methods (==) :: ApiKey -> ApiKey -> Bool # (/=) :: ApiKey -> ApiKey -> Bool #
Read ApiKey Source #
Instance details Defined in Amazonka.APIGateway.Types.ApiKey Methods readsPrec :: Int -> ReadS ApiKey # readList :: ReadS [ApiKey] # readPrec :: ReadPrec ApiKey # readListPrec :: ReadPrec [ApiKey] #
Show ApiKey Source #
Instance details Defined in Amazonka.APIGateway.Types.ApiKey Methods showsPrec :: Int -> ApiKey -> ShowS # show :: ApiKey -> String # showList :: [ApiKey] -> ShowS #
Generic ApiKey Source #
Instance details Defined in Amazonka.APIGateway.Types.ApiKey Associated Types type Rep ApiKey :: Type -> Type # Methods from :: ApiKey -> Rep ApiKey x # to :: Rep ApiKey x -> ApiKey #
NFData ApiKey Source #
Instance details Defined in Amazonka.APIGateway.Types.ApiKey Methods rnf :: ApiKey -> () #
Hashable ApiKey Source #
Instance details Defined in Amazonka.APIGateway.Types.ApiKey Methods hashWithSalt :: Int -> ApiKey -> Int # hash :: ApiKey -> Int #
FromJSON ApiKey Source #
Instance details Defined in Amazonka.APIGateway.Types.ApiKey Methods parseJSON :: Value -> Parser ApiKey # parseJSONList :: Value -> Parser [ApiKey] #
type Rep ApiKey Source #
Instance details Defined in Amazonka.APIGateway.Types.ApiKey type Rep ApiKey = D1 ('MetaData "ApiKey" "Amazonka.APIGateway.Types.ApiKey" "libZSservicesZSamazonka-apigatewayZSamazonka-apigateway" 'False) (C1 ('MetaCons "ApiKey'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "enabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "customerId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "createdDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: ((S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "stageKeys") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))) :: (S1 ('MetaSel ('Just "lastUpdatedDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))))))))

newApiKey :: ApiKey Source #

Create a value of ApiKey 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:enabled:ApiKey', apiKey_enabled - Specifies whether the API Key can be used by callers.

$sel:value:ApiKey', apiKey_value - The value of the API Key.

$sel:customerId:ApiKey', apiKey_customerId - An AWS Marketplace customer identifier , when integrating with the AWS SaaS Marketplace.

$sel:createdDate:ApiKey', apiKey_createdDate - The timestamp when the API Key was created.

$sel:name:ApiKey', apiKey_name - The name of the API Key.

$sel:id:ApiKey', apiKey_id - The identifier of the API Key.

$sel:stageKeys:ApiKey', apiKey_stageKeys - A list of Stage resources that are associated with the ApiKey resource.

$sel:lastUpdatedDate:ApiKey', apiKey_lastUpdatedDate - The timestamp when the API Key was last updated.

$sel:description:ApiKey', apiKey_description - The description of the API Key.

$sel:tags:ApiKey', apiKey_tags - The collection of tags. Each tag element is associated with a given resource.

Response Lenses

apiKey_enabled :: Lens' ApiKey (Maybe Bool) Source #

Specifies whether the API Key can be used by callers.

apiKey_value :: Lens' ApiKey (Maybe Text) Source #

The value of the API Key.

apiKey_customerId :: Lens' ApiKey (Maybe Text) Source #

An AWS Marketplace customer identifier , when integrating with the AWS SaaS Marketplace.

apiKey_createdDate :: Lens' ApiKey (Maybe UTCTime) Source #

The timestamp when the API Key was created.

apiKey_name :: Lens' ApiKey (Maybe Text) Source #

The name of the API Key.

apiKey_id :: Lens' ApiKey (Maybe Text) Source #

The identifier of the API Key.

apiKey_stageKeys :: Lens' ApiKey (Maybe [Text]) Source #

A list of Stage resources that are associated with the ApiKey resource.

apiKey_lastUpdatedDate :: Lens' ApiKey (Maybe UTCTime) Source #

The timestamp when the API Key was last updated.

apiKey_description :: Lens' ApiKey (Maybe Text) Source #

The description of the API Key.

apiKey_tags :: Lens' ApiKey (Maybe (HashMap Text Text)) Source #

The collection of tags. Each tag element is associated with a given resource.