Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.AppSync.UpdateApiKey

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Updates an API key. You can update the key as long as it's not deleted.

Synopsis

Creating a Request

data UpdateApiKey Source #

See: newUpdateApiKey smart constructor.

Constructors

UpdateApiKey'
Fields description :: Maybe Text A description of the purpose of the API key. expires :: Maybe Integer From the update time, the time after which the API key expires. The date is represented as seconds since the epoch. For more information, see . apiId :: Text The ID for the GraphQL API. id :: Text The API key ID.

Instances

Instances details

ToJSON UpdateApiKey Source #
Instance details Defined in Amazonka.AppSync.UpdateApiKey Methods toJSON :: UpdateApiKey -> Value # toEncoding :: UpdateApiKey -> Encoding # toJSONList :: [UpdateApiKey] -> Value # toEncodingList :: [UpdateApiKey] -> Encoding #
ToHeaders UpdateApiKey Source #
Instance details Defined in Amazonka.AppSync.UpdateApiKey Methods toHeaders :: UpdateApiKey -> [Header] #
ToPath UpdateApiKey Source #
Instance details Defined in Amazonka.AppSync.UpdateApiKey Methods toPath :: UpdateApiKey -> ByteString #
ToQuery UpdateApiKey Source #
Instance details Defined in Amazonka.AppSync.UpdateApiKey Methods toQuery :: UpdateApiKey -> QueryString #
AWSRequest UpdateApiKey Source #
Instance details Defined in Amazonka.AppSync.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 Source #
Instance details Defined in Amazonka.AppSync.UpdateApiKey Associated Types type Rep UpdateApiKey :: Type -> Type # Methods from :: UpdateApiKey -> Rep UpdateApiKey x # to :: Rep UpdateApiKey x -> UpdateApiKey #
Read UpdateApiKey Source #
Instance details Defined in Amazonka.AppSync.UpdateApiKey Methods readsPrec :: Int -> ReadS UpdateApiKey # readList :: ReadS [UpdateApiKey] # readPrec :: ReadPrec UpdateApiKey # readListPrec :: ReadPrec [UpdateApiKey] #
Show UpdateApiKey Source #
Instance details Defined in Amazonka.AppSync.UpdateApiKey Methods showsPrec :: Int -> UpdateApiKey -> ShowS # show :: UpdateApiKey -> String # showList :: [UpdateApiKey] -> ShowS #
NFData UpdateApiKey Source #
Instance details Defined in Amazonka.AppSync.UpdateApiKey Methods rnf :: UpdateApiKey -> () #
Eq UpdateApiKey Source #
Instance details Defined in Amazonka.AppSync.UpdateApiKey Methods (==) :: UpdateApiKey -> UpdateApiKey -> Bool # (/=) :: UpdateApiKey -> UpdateApiKey -> Bool #
Hashable UpdateApiKey Source #
Instance details Defined in Amazonka.AppSync.UpdateApiKey Methods hashWithSalt :: Int -> UpdateApiKey -> Int # hash :: UpdateApiKey -> Int #
type AWSResponse UpdateApiKey Source #
Instance details Defined in Amazonka.AppSync.UpdateApiKey type AWSResponse UpdateApiKey = UpdateApiKeyResponse
type Rep UpdateApiKey Source #
Instance details Defined in Amazonka.AppSync.UpdateApiKey type Rep UpdateApiKey = D1 ('MetaData "UpdateApiKey" "Amazonka.AppSync.UpdateApiKey" "amazonka-appsync-2.0-4Pb6UqteLv1I9NIWaj90bg" 'False) (C1 ('MetaCons "UpdateApiKey'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "expires") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer))) :: (S1 ('MetaSel ('Just "apiId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newUpdateApiKey Source #

Arguments

:: Text	`UpdateApiKey`
-> Text	`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:

UpdateApiKey, updateApiKey_description - A description of the purpose of the API key.

UpdateApiKey, updateApiKey_expires - From the update time, the time after which the API key expires. The date is represented as seconds since the epoch. For more information, see .

UpdateApiKey, updateApiKey_apiId - The ID for the GraphQL API.

UpdateApiKey, updateApiKey_id - The API key ID.

Request Lenses

updateApiKey_description :: Lens' UpdateApiKey (Maybe Text) Source #

A description of the purpose of the API key.

updateApiKey_expires :: Lens' UpdateApiKey (Maybe Integer) Source #

From the update time, the time after which the API key expires. The date is represented as seconds since the epoch. For more information, see .

updateApiKey_apiId :: Lens' UpdateApiKey Text Source #

The ID for the GraphQL API.

updateApiKey_id :: Lens' UpdateApiKey Text Source #

The API key ID.

Destructuring the Response

data UpdateApiKeyResponse Source #

See: newUpdateApiKeyResponse smart constructor.

Constructors

UpdateApiKeyResponse'
Fields apiKey :: Maybe ApiKey The API key. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic UpdateApiKeyResponse Source #
Instance details Defined in Amazonka.AppSync.UpdateApiKey Associated Types type Rep UpdateApiKeyResponse :: Type -> Type # Methods from :: UpdateApiKeyResponse -> Rep UpdateApiKeyResponse x # to :: Rep UpdateApiKeyResponse x -> UpdateApiKeyResponse #
Read UpdateApiKeyResponse Source #
Instance details Defined in Amazonka.AppSync.UpdateApiKey Methods readsPrec :: Int -> ReadS UpdateApiKeyResponse # readList :: ReadS [UpdateApiKeyResponse] # readPrec :: ReadPrec UpdateApiKeyResponse # readListPrec :: ReadPrec [UpdateApiKeyResponse] #
Show UpdateApiKeyResponse Source #
Instance details Defined in Amazonka.AppSync.UpdateApiKey Methods showsPrec :: Int -> UpdateApiKeyResponse -> ShowS # show :: UpdateApiKeyResponse -> String # showList :: [UpdateApiKeyResponse] -> ShowS #
NFData UpdateApiKeyResponse Source #
Instance details Defined in Amazonka.AppSync.UpdateApiKey Methods rnf :: UpdateApiKeyResponse -> () #
Eq UpdateApiKeyResponse Source #
Instance details Defined in Amazonka.AppSync.UpdateApiKey Methods (==) :: UpdateApiKeyResponse -> UpdateApiKeyResponse -> Bool # (/=) :: UpdateApiKeyResponse -> UpdateApiKeyResponse -> Bool #
type Rep UpdateApiKeyResponse Source #
Instance details Defined in Amazonka.AppSync.UpdateApiKey type Rep UpdateApiKeyResponse = D1 ('MetaData "UpdateApiKeyResponse" "Amazonka.AppSync.UpdateApiKey" "amazonka-appsync-2.0-4Pb6UqteLv1I9NIWaj90bg" 'False) (C1 ('MetaCons "UpdateApiKeyResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "apiKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ApiKey)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newUpdateApiKeyResponse Source #

Arguments

:: Int	`$sel:httpStatus:UpdateApiKeyResponse'`
-> UpdateApiKeyResponse

Create a value of UpdateApiKeyResponse 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:apiKey:UpdateApiKeyResponse', updateApiKeyResponse_apiKey - The API key.

$sel:httpStatus:UpdateApiKeyResponse', updateApiKeyResponse_httpStatus - The response's http status code.

Response Lenses

updateApiKeyResponse_apiKey :: Lens' UpdateApiKeyResponse (Maybe ApiKey) Source #

The API key.

updateApiKeyResponse_httpStatus :: Lens' UpdateApiKeyResponse Int Source #

The response's http status code.