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

Amazonka.APIGateway.UpdateApiKey

Description

Changes information about an ApiKey resource.

Synopsis

Creating a Request

data UpdateApiKey Source #

A request to change information about an ApiKey resource.

See: newUpdateApiKey smart constructor.

Constructors

UpdateApiKey' 

Fields

  • patchOperations :: Maybe [PatchOperation]

    A list of update operations to be applied to the specified resource and in the order specified in this list.

  • apiKey :: Text
    Required
    The identifier of the ApiKey resource to be updated.

Instances

Instances details
Eq UpdateApiKey Source # 
Instance details

Defined in Amazonka.APIGateway.UpdateApiKey

Read UpdateApiKey Source # 
Instance details

Defined in Amazonka.APIGateway.UpdateApiKey

Show UpdateApiKey Source # 
Instance details

Defined in Amazonka.APIGateway.UpdateApiKey

Generic UpdateApiKey Source # 
Instance details

Defined in Amazonka.APIGateway.UpdateApiKey

Associated Types

type Rep UpdateApiKey :: Type -> Type #

NFData UpdateApiKey Source # 
Instance details

Defined in Amazonka.APIGateway.UpdateApiKey

Methods

rnf :: UpdateApiKey -> () #

Hashable UpdateApiKey Source # 
Instance details

Defined in Amazonka.APIGateway.UpdateApiKey

ToJSON UpdateApiKey Source # 
Instance details

Defined in Amazonka.APIGateway.UpdateApiKey

AWSRequest UpdateApiKey Source # 
Instance details

Defined in Amazonka.APIGateway.UpdateApiKey

Associated Types

type AWSResponse UpdateApiKey #

ToHeaders UpdateApiKey Source # 
Instance details

Defined in Amazonka.APIGateway.UpdateApiKey

ToPath UpdateApiKey Source # 
Instance details

Defined in Amazonka.APIGateway.UpdateApiKey

ToQuery UpdateApiKey Source # 
Instance details

Defined in Amazonka.APIGateway.UpdateApiKey

type Rep UpdateApiKey Source # 
Instance details

Defined in Amazonka.APIGateway.UpdateApiKey

type Rep UpdateApiKey = D1 ('MetaData "UpdateApiKey" "Amazonka.APIGateway.UpdateApiKey" "libZSservicesZSamazonka-apigatewayZSamazonka-apigateway" 'False) (C1 ('MetaCons "UpdateApiKey'" 'PrefixI 'True) (S1 ('MetaSel ('Just "patchOperations") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [PatchOperation])) :*: S1 ('MetaSel ('Just "apiKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse UpdateApiKey Source # 
Instance details

Defined in Amazonka.APIGateway.UpdateApiKey

newUpdateApiKey Source #

Create a value of UpdateApiKey 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:patchOperations:UpdateApiKey', updateApiKey_patchOperations - A list of update operations to be applied to the specified resource and in the order specified in this list.

$sel:apiKey:UpdateApiKey', updateApiKey_apiKey - [Required] The identifier of the ApiKey resource to be updated.

Request Lenses

updateApiKey_patchOperations :: Lens' UpdateApiKey (Maybe [PatchOperation]) Source #

A list of update operations to be applied to the specified resource and in the order specified in this list.

updateApiKey_apiKey :: Lens' UpdateApiKey Text Source #

Required
The identifier of the ApiKey resource to be updated.

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

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

Show ApiKey Source # 
Instance details

Defined in Amazonka.APIGateway.Types.ApiKey

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

type Rep ApiKey Source # 
Instance details

Defined in Amazonka.APIGateway.Types.ApiKey

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.