Amazonka.APIGateway.UpdateApiKey

Changes information about an ApiKey resource.

Creating a Request

data UpdateApiKey

A request to change information about an ApiKey resource.

See: newUpdateApiKey smart constructor.

Constructors

UpdateApiKey'

Fields

• patchOperations :: Maybe [PatchOperation]

  For more information about supported patch operations, see Patch Operations.

• apiKey :: Text

  The identifier of the ApiKey resource to be updated.

Instances

ToJSON UpdateApiKey

Defined in Amazonka.APIGateway.UpdateApiKey

Methods

toJSON :: UpdateApiKey -> Value

toEncoding :: UpdateApiKey -> Encoding

toJSONList :: [UpdateApiKey] -> Value

toEncodingList :: [UpdateApiKey] -> Encoding

ToHeaders UpdateApiKey

Defined in Amazonka.APIGateway.UpdateApiKey

Methods

toHeaders :: UpdateApiKey -> [Header]

ToPath UpdateApiKey

Defined in Amazonka.APIGateway.UpdateApiKey

Methods

toPath :: UpdateApiKey -> ByteString

ToQuery UpdateApiKey

Defined in Amazonka.APIGateway.UpdateApiKey

Methods

toQuery :: UpdateApiKey -> QueryString

AWSRequest UpdateApiKey

Defined in Amazonka.APIGateway.UpdateApiKey

Associated Types

type AWSResponse UpdateApiKey

Methods

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

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

Generic UpdateApiKey

Defined in Amazonka.APIGateway.UpdateApiKey

Associated Types

type Rep UpdateApiKey :: Type -> Type

Methods

from :: UpdateApiKey -> Rep UpdateApiKey x

to :: Rep UpdateApiKey x -> UpdateApiKey

Read UpdateApiKey

Defined in Amazonka.APIGateway.UpdateApiKey

Methods

readsPrec :: Int -> ReadS UpdateApiKey

readList :: ReadS [UpdateApiKey]

readPrec :: ReadPrec UpdateApiKey

readListPrec :: ReadPrec [UpdateApiKey]

Show UpdateApiKey

Defined in Amazonka.APIGateway.UpdateApiKey

Methods

showsPrec :: Int -> UpdateApiKey -> ShowS

show :: UpdateApiKey -> String

showList :: [UpdateApiKey] -> ShowS

NFData UpdateApiKey

Defined in Amazonka.APIGateway.UpdateApiKey

Methods

rnf :: UpdateApiKey -> ()

Eq UpdateApiKey

Defined in Amazonka.APIGateway.UpdateApiKey

Methods

(==) :: UpdateApiKey -> UpdateApiKey -> Bool

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

Hashable UpdateApiKey

Defined in Amazonka.APIGateway.UpdateApiKey

Methods

hashWithSalt :: Int -> UpdateApiKey -> Int

hash :: UpdateApiKey -> Int

type AWSResponse UpdateApiKey

Defined in Amazonka.APIGateway.UpdateApiKey

type AWSResponse UpdateApiKey = ApiKey

type Rep UpdateApiKey

Defined in Amazonka.APIGateway.UpdateApiKey

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

newUpdateApiKey

Arguments

:: Text

$sel:apiKey:UpdateApiKey'

-> UpdateApiKey

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 - For more information about supported patch operations, see Patch Operations.

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

Request Lenses

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

For more information about supported patch operations, see Patch Operations.

updateApiKey_apiKey :: Lens' UpdateApiKey Text

The identifier of the ApiKey resource to be updated.

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.