Amazonka.APIGateway.GetApiKey

Gets information about the current ApiKey resource.

Creating a Request

data GetApiKey

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

  The identifier of the ApiKey resource.

Instances

ToHeaders GetApiKey

Defined in Amazonka.APIGateway.GetApiKey

Methods

toHeaders :: GetApiKey -> [Header]

ToPath GetApiKey

Defined in Amazonka.APIGateway.GetApiKey

Methods

toPath :: GetApiKey -> ByteString

ToQuery GetApiKey

Defined in Amazonka.APIGateway.GetApiKey

Methods

toQuery :: GetApiKey -> QueryString

AWSRequest GetApiKey

Defined in Amazonka.APIGateway.GetApiKey

Associated Types

type AWSResponse GetApiKey

Methods

request :: (Service -> Service) -> GetApiKey -> Request GetApiKey

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetApiKey -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetApiKey)))

Generic GetApiKey

Defined in Amazonka.APIGateway.GetApiKey

Associated Types

type Rep GetApiKey :: Type -> Type

Methods

from :: GetApiKey -> Rep GetApiKey x

to :: Rep GetApiKey x -> GetApiKey

Read GetApiKey

Defined in Amazonka.APIGateway.GetApiKey

Methods

readsPrec :: Int -> ReadS GetApiKey

readList :: ReadS [GetApiKey]

readPrec :: ReadPrec GetApiKey

readListPrec :: ReadPrec [GetApiKey]

Show GetApiKey

Defined in Amazonka.APIGateway.GetApiKey

Methods

showsPrec :: Int -> GetApiKey -> ShowS

show :: GetApiKey -> String

showList :: [GetApiKey] -> ShowS

NFData GetApiKey

Defined in Amazonka.APIGateway.GetApiKey

Methods

rnf :: GetApiKey -> ()

Eq GetApiKey

Defined in Amazonka.APIGateway.GetApiKey

Methods

(==) :: GetApiKey -> GetApiKey -> Bool

(/=) :: GetApiKey -> GetApiKey -> Bool

Hashable GetApiKey

Defined in Amazonka.APIGateway.GetApiKey

Methods

hashWithSalt :: Int -> GetApiKey -> Int

hash :: GetApiKey -> Int

type AWSResponse GetApiKey

Defined in Amazonka.APIGateway.GetApiKey

type AWSResponse GetApiKey = ApiKey

type Rep GetApiKey

Defined in Amazonka.APIGateway.GetApiKey

type Rep GetApiKey = D1 ('MetaData "GetApiKey" "Amazonka.APIGateway.GetApiKey" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" '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)))

newGetApiKey

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 - The identifier of the ApiKey resource.

Request Lenses

getApiKey_includeValue :: Lens' GetApiKey (Maybe Bool)

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

getApiKey_apiKey :: Lens' GetApiKey Text

The identifier of the ApiKey resource.

Destructuring the Response

data ApiKey

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.

See: newApiKey smart constructor.

Constructors

ApiKey'

Fields

• createdDate :: Maybe POSIX

  The timestamp when the API Key was created.

• customerId :: Maybe Text

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

• description :: Maybe Text

  The description of the API Key.

• enabled :: Maybe Bool

  Specifies whether the API Key can be used by callers.

• id :: Maybe Text

  The identifier of the API Key.

• lastUpdatedDate :: Maybe POSIX

  The timestamp when the API Key was last updated.

• name :: Maybe Text

  The name of the API Key.

• stageKeys :: Maybe [Text]

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

• tags :: Maybe (HashMap Text Text)

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

• value :: Maybe Text

  The value of the API Key.

Instances

FromJSON ApiKey

Defined in Amazonka.APIGateway.Types.ApiKey

Methods

parseJSON :: Value -> Parser ApiKey

parseJSONList :: Value -> Parser [ApiKey]

Generic ApiKey

Defined in Amazonka.APIGateway.Types.ApiKey

Associated Types

type Rep ApiKey :: Type -> Type

Methods

from :: ApiKey -> Rep ApiKey x

to :: Rep ApiKey x -> ApiKey

Read ApiKey

Defined in Amazonka.APIGateway.Types.ApiKey

Methods

readsPrec :: Int -> ReadS ApiKey

readList :: ReadS [ApiKey]

readPrec :: ReadPrec ApiKey

readListPrec :: ReadPrec [ApiKey]

Show ApiKey

Defined in Amazonka.APIGateway.Types.ApiKey

Methods

showsPrec :: Int -> ApiKey -> ShowS

show :: ApiKey -> String

showList :: [ApiKey] -> ShowS

NFData ApiKey

Defined in Amazonka.APIGateway.Types.ApiKey

Methods

rnf :: ApiKey -> ()

Eq ApiKey

Defined in Amazonka.APIGateway.Types.ApiKey

Methods

(==) :: ApiKey -> ApiKey -> Bool

(/=) :: ApiKey -> ApiKey -> Bool

Hashable ApiKey

Defined in Amazonka.APIGateway.Types.ApiKey

Methods

hashWithSalt :: Int -> ApiKey -> Int

hash :: ApiKey -> Int

type Rep ApiKey

Defined in Amazonka.APIGateway.Types.ApiKey

type Rep ApiKey = D1 ('MetaData "ApiKey" "Amazonka.APIGateway.Types.ApiKey" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "ApiKey'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "createdDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "customerId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "enabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :*: ((S1 ('MetaSel ('Just "lastUpdatedDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "stageKeys") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :*: S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))))

newApiKey :: ApiKey

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:createdDate:ApiKey', apiKey_createdDate - The timestamp when the API Key was created.

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

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

$sel:enabled:ApiKey', apiKey_enabled - Specifies whether the API Key can be used by callers.

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

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

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

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

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

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

Response Lenses

apiKey_createdDate :: Lens' ApiKey (Maybe UTCTime)

The timestamp when the API Key was created.

apiKey_customerId :: Lens' ApiKey (Maybe Text)

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

apiKey_description :: Lens' ApiKey (Maybe Text)

The description of the API Key.

apiKey_enabled :: Lens' ApiKey (Maybe Bool)

Specifies whether the API Key can be used by callers.

apiKey_id :: Lens' ApiKey (Maybe Text)

The identifier of the API Key.

apiKey_lastUpdatedDate :: Lens' ApiKey (Maybe UTCTime)

The timestamp when the API Key was last updated.

apiKey_name :: Lens' ApiKey (Maybe Text)

The name of the API Key.

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

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

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

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

apiKey_value :: Lens' ApiKey (Maybe Text)

The value of the API Key.