amazonka-apigateway-1.3.7: Amazon API Gateway SDK.

Copyright(c) 2013-2015 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.AWS.APIGateway.GetAPIKey

Contents

Description

Gets information about the current ApiKey resource.

See: AWS API Reference for GetAPIKey.

Synopsis

Creating a Request

getAPIKey Source

Arguments

:: Text

gakApiKey

-> GetAPIKey 

Creates a value of GetAPIKey with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

Request Lenses

gakApiKey :: Lens' GetAPIKey Text Source

The identifier of the ApiKey resource.

Destructuring the Response

apiKey :: APIKey Source

Creates a value of APIKey with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

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.

See: apiKey smart constructor.

Response Lenses

akEnabled :: Lens' APIKey (Maybe Bool) Source

Specifies whether the API Key can be used by callers.

akCreatedDate :: Lens' APIKey (Maybe UTCTime) Source

The date when the API Key was created, in ISO 8601 format.

akName :: Lens' APIKey (Maybe Text) Source

The name of the API Key.

akId :: Lens' APIKey (Maybe Text) Source

The identifier of the API Key.

akStageKeys :: Lens' APIKey [Text] Source

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

akLastUpdatedDate :: Lens' APIKey (Maybe UTCTime) Source

When the API Key was last updated, in ISO 8601 format.

akDescription :: Lens' APIKey (Maybe Text) Source

The description of the API Key.