Network.AWS.APIGateway.CreateAPIKey

Undocumented operation.

See: AWS API Reference for CreateAPIKey.

Creating a Request

createAPIKey :: CreateAPIKey

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

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

• cakEnabled
• cakName
• cakStageKeys
• cakDescription

data CreateAPIKey

See: createAPIKey smart constructor.

Instances

Eq CreateAPIKey

Data CreateAPIKey

Read CreateAPIKey

Show CreateAPIKey

Generic CreateAPIKey

ToJSON CreateAPIKey

AWSRequest CreateAPIKey

ToPath CreateAPIKey

ToHeaders CreateAPIKey

ToQuery CreateAPIKey

type Rep CreateAPIKey

type Rs CreateAPIKey = APIKey

Request Lenses

cakEnabled :: Lens' CreateAPIKey (Maybe Bool)

Specifies whether the ApiKey can be used by callers.

cakName :: Lens' CreateAPIKey (Maybe Text)

The name of the ApiKey.

cakStageKeys :: Lens' CreateAPIKey [StageKey]

Specifies whether the ApiKey can be used by callers.

cakDescription :: Lens' CreateAPIKey (Maybe Text)

The description of the ApiKey.

Destructuring the Response

apiKey :: APIKey

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
• akCreatedDate
• akName
• akId
• akStageKeys
• akLastUpdatedDate
• akDescription

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: apiKey smart constructor.

Instances

Eq APIKey

Data APIKey

Read APIKey

Show APIKey

Generic APIKey

FromJSON APIKey

type Rep APIKey

Response Lenses

akEnabled :: Lens' APIKey (Maybe Bool)

Specifies whether the API Key can be used by callers.

akCreatedDate :: Lens' APIKey (Maybe UTCTime)

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

akName :: Lens' APIKey (Maybe Text)

The name of the API Key.

akId :: Lens' APIKey (Maybe Text)

The identifier of the API Key.

akStageKeys :: Lens' APIKey [Text]

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

akLastUpdatedDate :: Lens' APIKey (Maybe UTCTime)

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

akDescription :: Lens' APIKey (Maybe Text)

The description of the API Key.