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.IAM.UpdateAccessKey

Contents

Creating a Request
Request Lenses
Destructuring the Response

Description

Changes the status of the specified access key from Active to Inactive, or vice versa. This operation can be used to disable a user's key as part of a key rotation workflow.

If the UserName is not specified, the user name is determined implicitly based on the Amazon Web Services access key ID used to sign the request. If a temporary access key is used, then UserName is required. If a long-term key is assigned to the user, then UserName is not required. This operation works for access keys under the Amazon Web Services account. Consequently, you can use this operation to manage Amazon Web Services account root user credentials even if the Amazon Web Services account has no associated users.

For information about rotating keys, see Managing keys and certificates in the IAM User Guide.

Creating a Request

data UpdateAccessKey Source #

See: newUpdateAccessKey smart constructor.

Constructors

UpdateAccessKey'

Fields

userName :: Maybe Text
The name of the user whose key you want to update.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
accessKeyId :: AccessKey
The access key ID of the secret access key you want to update.
This parameter allows (through its regex pattern) a string of characters that can consist of any upper or lowercased letter or digit.
status :: StatusType
The status you want to assign to the secret access key. Active means that the key can be used for programmatic calls to Amazon Web Services, while Inactive means that the key cannot be used.

Instances

Instances details

ToHeaders UpdateAccessKey Source #
Instance details Defined in Amazonka.IAM.UpdateAccessKey Methods toHeaders :: UpdateAccessKey -> [Header] #
ToPath UpdateAccessKey Source #
Instance details Defined in Amazonka.IAM.UpdateAccessKey Methods toPath :: UpdateAccessKey -> ByteString #
ToQuery UpdateAccessKey Source #
Instance details Defined in Amazonka.IAM.UpdateAccessKey Methods toQuery :: UpdateAccessKey -> QueryString #
AWSRequest UpdateAccessKey Source #
Instance details Defined in Amazonka.IAM.UpdateAccessKey Associated Types type AWSResponse UpdateAccessKey # Methods request :: (Service -> Service) -> UpdateAccessKey -> Request UpdateAccessKey # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy UpdateAccessKey -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse UpdateAccessKey))) #
Generic UpdateAccessKey Source #
Instance details Defined in Amazonka.IAM.UpdateAccessKey Associated Types type Rep UpdateAccessKey :: Type -> Type # Methods from :: UpdateAccessKey -> Rep UpdateAccessKey x # to :: Rep UpdateAccessKey x -> UpdateAccessKey #
Read UpdateAccessKey Source #
Instance details Defined in Amazonka.IAM.UpdateAccessKey Methods readsPrec :: Int -> ReadS UpdateAccessKey # readList :: ReadS [UpdateAccessKey] # readPrec :: ReadPrec UpdateAccessKey # readListPrec :: ReadPrec [UpdateAccessKey] #
Show UpdateAccessKey Source #
Instance details Defined in Amazonka.IAM.UpdateAccessKey Methods showsPrec :: Int -> UpdateAccessKey -> ShowS # show :: UpdateAccessKey -> String # showList :: [UpdateAccessKey] -> ShowS #
NFData UpdateAccessKey Source #
Instance details Defined in Amazonka.IAM.UpdateAccessKey Methods rnf :: UpdateAccessKey -> () #
Eq UpdateAccessKey Source #
Instance details Defined in Amazonka.IAM.UpdateAccessKey Methods (==) :: UpdateAccessKey -> UpdateAccessKey -> Bool # (/=) :: UpdateAccessKey -> UpdateAccessKey -> Bool #
Hashable UpdateAccessKey Source #
Instance details Defined in Amazonka.IAM.UpdateAccessKey Methods hashWithSalt :: Int -> UpdateAccessKey -> Int # hash :: UpdateAccessKey -> Int #
type AWSResponse UpdateAccessKey Source #
Instance details Defined in Amazonka.IAM.UpdateAccessKey type AWSResponse UpdateAccessKey = UpdateAccessKeyResponse
type Rep UpdateAccessKey Source #
Instance details Defined in Amazonka.IAM.UpdateAccessKey type Rep UpdateAccessKey = D1 ('MetaData "UpdateAccessKey" "Amazonka.IAM.UpdateAccessKey" "amazonka-iam-2.0-5DxkArXx9sD3CCYYGFyGET" 'False) (C1 ('MetaCons "UpdateAccessKey'" 'PrefixI 'True) (S1 ('MetaSel ('Just "userName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "accessKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 AccessKey) :: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 StatusType))))

newUpdateAccessKey Source #

Arguments

:: AccessKey	`UpdateAccessKey`
-> StatusType	`UpdateAccessKey`
-> UpdateAccessKey

Create a value of UpdateAccessKey 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:

UpdateAccessKey, updateAccessKey_userName - The name of the user whose key you want to update.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

UpdateAccessKey, updateAccessKey_accessKeyId - The access key ID of the secret access key you want to update.

This parameter allows (through its regex pattern) a string of characters that can consist of any upper or lowercased letter or digit.

UpdateAccessKey, updateAccessKey_status - The status you want to assign to the secret access key. Active means that the key can be used for programmatic calls to Amazon Web Services, while Inactive means that the key cannot be used.

Request Lenses

updateAccessKey_userName :: Lens' UpdateAccessKey (Maybe Text) Source #

The name of the user whose key you want to update.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

updateAccessKey_accessKeyId :: Lens' UpdateAccessKey AccessKey Source #

The access key ID of the secret access key you want to update.

This parameter allows (through its regex pattern) a string of characters that can consist of any upper or lowercased letter or digit.

updateAccessKey_status :: Lens' UpdateAccessKey StatusType Source #

The status you want to assign to the secret access key. Active means that the key can be used for programmatic calls to Amazon Web Services, while Inactive means that the key cannot be used.

Destructuring the Response

data UpdateAccessKeyResponse Source #

See: newUpdateAccessKeyResponse smart constructor.

Constructors

UpdateAccessKeyResponse'

Instances

Instances details

Generic UpdateAccessKeyResponse Source #
Instance details Defined in Amazonka.IAM.UpdateAccessKey Associated Types type Rep UpdateAccessKeyResponse :: Type -> Type # Methods from :: UpdateAccessKeyResponse -> Rep UpdateAccessKeyResponse x # to :: Rep UpdateAccessKeyResponse x -> UpdateAccessKeyResponse #
Read UpdateAccessKeyResponse Source #
Instance details Defined in Amazonka.IAM.UpdateAccessKey Methods readsPrec :: Int -> ReadS UpdateAccessKeyResponse # readList :: ReadS [UpdateAccessKeyResponse] # readPrec :: ReadPrec UpdateAccessKeyResponse # readListPrec :: ReadPrec [UpdateAccessKeyResponse] #
Show UpdateAccessKeyResponse Source #
Instance details Defined in Amazonka.IAM.UpdateAccessKey Methods showsPrec :: Int -> UpdateAccessKeyResponse -> ShowS # show :: UpdateAccessKeyResponse -> String # showList :: [UpdateAccessKeyResponse] -> ShowS #
NFData UpdateAccessKeyResponse Source #
Instance details Defined in Amazonka.IAM.UpdateAccessKey Methods rnf :: UpdateAccessKeyResponse -> () #
Eq UpdateAccessKeyResponse Source #
Instance details Defined in Amazonka.IAM.UpdateAccessKey Methods (==) :: UpdateAccessKeyResponse -> UpdateAccessKeyResponse -> Bool # (/=) :: UpdateAccessKeyResponse -> UpdateAccessKeyResponse -> Bool #
type Rep UpdateAccessKeyResponse Source #
Instance details Defined in Amazonka.IAM.UpdateAccessKey type Rep UpdateAccessKeyResponse = D1 ('MetaData "UpdateAccessKeyResponse" "Amazonka.IAM.UpdateAccessKey" "amazonka-iam-2.0-5DxkArXx9sD3CCYYGFyGET" 'False) (C1 ('MetaCons "UpdateAccessKeyResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newUpdateAccessKeyResponse :: UpdateAccessKeyResponse Source #

Create a value of UpdateAccessKeyResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.