Copyright | (c) 2013-2017 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 |
Language | Haskell2010 |
Gets information about the current ApiKey
resource.
- getAPIKey :: Text -> GetAPIKey
- data GetAPIKey
- gakIncludeValue :: Lens' GetAPIKey (Maybe Bool)
- gakApiKey :: Lens' GetAPIKey Text
- apiKey :: APIKey
- data APIKey
- akEnabled :: Lens' APIKey (Maybe Bool)
- akValue :: Lens' APIKey (Maybe Text)
- akCustomerId :: Lens' APIKey (Maybe Text)
- akCreatedDate :: Lens' APIKey (Maybe UTCTime)
- akName :: Lens' APIKey (Maybe Text)
- akId :: Lens' APIKey (Maybe Text)
- akStageKeys :: Lens' APIKey [Text]
- akLastUpdatedDate :: Lens' APIKey (Maybe UTCTime)
- akDescription :: Lens' APIKey (Maybe Text)
Creating a Request
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:
gakIncludeValue
- A boolean flag to specify whether (true
) or not (false
) the result contains the key value.gakApiKey
- The identifier of theApiKey
resource.
A request to get information about the current ApiKey
resource.
See: getAPIKey
smart constructor.
Request Lenses
gakIncludeValue :: Lens' GetAPIKey (Maybe Bool) Source #
A boolean flag to specify whether (true
) or not (false
) the result contains the key value.
Destructuring the Response
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:
akEnabled
- Specifies whether the API Key can be used by callers.akValue
- The value of the API Key.akCustomerId
- An AWS Marketplace customer identifier , when integrating with the AWS SaaS Marketplace.akCreatedDate
- The timestamp when the API Key was created.akName
- The name of the API Key.akId
- The identifier of the API Key.akStageKeys
- A list ofStage
resources that are associated with theApiKey
resource.akLastUpdatedDate
- The timestamp when the API Key was last updated.akDescription
- The description of the API Key.
Response Lenses
akEnabled :: Lens' APIKey (Maybe Bool) Source #
Specifies whether the API Key can be used by callers.
akCustomerId :: Lens' APIKey (Maybe Text) Source #
An AWS Marketplace customer identifier , when integrating with the AWS SaaS Marketplace.
akStageKeys :: Lens' APIKey [Text] Source #
A list of Stage
resources that are associated with the ApiKey
resource.