amazonka-iam-1.6.0: Amazon Identity and Access Management SDK.

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

Network.AWS.IAM.UpdateAccessKey

Contents

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 field is not specified, the user name is determined implicitly based on the AWS access key ID used to sign the request. Because this operation works for access keys under the AWS account, you can use this operation to manage AWS account root user credentials even if the AWS account has no associated users.

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

Synopsis

Creating a Request

updateAccessKey #

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

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

  • uakUserName - The name of the user whose key you want to update. This parameter allows (per 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: _+=,.@-
  • uakAccessKeyId - The access key ID of the secret access key you want to update. This parameter allows (per its regex pattern ) a string of characters that can consist of any upper or lowercased letter or digit.
  • uakStatus - The status you want to assign to the secret access key. Active means that the key can be used for API calls to AWS, while Inactive means that the key cannot be used.

data UpdateAccessKey #

See: updateAccessKey smart constructor.

Instances

Eq UpdateAccessKey # 
Data UpdateAccessKey # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> UpdateAccessKey -> c UpdateAccessKey #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c UpdateAccessKey #

toConstr :: UpdateAccessKey -> Constr #

dataTypeOf :: UpdateAccessKey -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c UpdateAccessKey) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c UpdateAccessKey) #

gmapT :: (forall b. Data b => b -> b) -> UpdateAccessKey -> UpdateAccessKey #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> UpdateAccessKey -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> UpdateAccessKey -> r #

gmapQ :: (forall d. Data d => d -> u) -> UpdateAccessKey -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> UpdateAccessKey -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> UpdateAccessKey -> m UpdateAccessKey #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> UpdateAccessKey -> m UpdateAccessKey #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> UpdateAccessKey -> m UpdateAccessKey #

Read UpdateAccessKey # 
Show UpdateAccessKey # 
Generic UpdateAccessKey # 
Hashable UpdateAccessKey # 
NFData UpdateAccessKey # 

Methods

rnf :: UpdateAccessKey -> () #

AWSRequest UpdateAccessKey # 
ToHeaders UpdateAccessKey # 
ToPath UpdateAccessKey # 
ToQuery UpdateAccessKey # 
type Rep UpdateAccessKey # 
type Rep UpdateAccessKey = D1 * (MetaData "UpdateAccessKey" "Network.AWS.IAM.UpdateAccessKey" "amazonka-iam-1.6.0-1EzdHSXYgBWIEzsCXYmity" False) (C1 * (MetaCons "UpdateAccessKey'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_uakUserName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) ((:*:) * (S1 * (MetaSel (Just Symbol "_uakAccessKeyId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * AccessKey)) (S1 * (MetaSel (Just Symbol "_uakStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * StatusType)))))
type Rs UpdateAccessKey # 

Request Lenses

uakUserName :: Lens' UpdateAccessKey (Maybe Text) #

The name of the user whose key you want to update. This parameter allows (per 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: _+=,.@-

uakAccessKeyId :: Lens' UpdateAccessKey AccessKey #

The access key ID of the secret access key you want to update. This parameter allows (per its regex pattern ) a string of characters that can consist of any upper or lowercased letter or digit.

uakStatus :: Lens' UpdateAccessKey StatusType #

The status you want to assign to the secret access key. Active means that the key can be used for API calls to AWS, while Inactive means that the key cannot be used.

Destructuring the Response

updateAccessKeyResponse :: UpdateAccessKeyResponse #

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

data UpdateAccessKeyResponse #

See: updateAccessKeyResponse smart constructor.

Instances

Eq UpdateAccessKeyResponse # 
Data UpdateAccessKeyResponse # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> UpdateAccessKeyResponse -> c UpdateAccessKeyResponse #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c UpdateAccessKeyResponse #

toConstr :: UpdateAccessKeyResponse -> Constr #

dataTypeOf :: UpdateAccessKeyResponse -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c UpdateAccessKeyResponse) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c UpdateAccessKeyResponse) #

gmapT :: (forall b. Data b => b -> b) -> UpdateAccessKeyResponse -> UpdateAccessKeyResponse #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> UpdateAccessKeyResponse -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> UpdateAccessKeyResponse -> r #

gmapQ :: (forall d. Data d => d -> u) -> UpdateAccessKeyResponse -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> UpdateAccessKeyResponse -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> UpdateAccessKeyResponse -> m UpdateAccessKeyResponse #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> UpdateAccessKeyResponse -> m UpdateAccessKeyResponse #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> UpdateAccessKeyResponse -> m UpdateAccessKeyResponse #

Read UpdateAccessKeyResponse # 
Show UpdateAccessKeyResponse # 
Generic UpdateAccessKeyResponse # 
NFData UpdateAccessKeyResponse # 

Methods

rnf :: UpdateAccessKeyResponse -> () #

type Rep UpdateAccessKeyResponse # 
type Rep UpdateAccessKeyResponse = D1 * (MetaData "UpdateAccessKeyResponse" "Network.AWS.IAM.UpdateAccessKey" "amazonka-iam-1.6.0-1EzdHSXYgBWIEzsCXYmity" False) (C1 * (MetaCons "UpdateAccessKeyResponse'" PrefixI False) (U1 *))