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

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

Network.AWS.IAM.UpdateSSHPublicKey

Contents

Description

Sets the status of an IAM user's SSH public key to active or inactive. SSH public keys that are inactive cannot be used for authentication. This action can be used to disable a user's SSH public key as part of a key rotation work flow.

The SSH public key affected by this action is used only for authenticating the associated IAM user to an AWS CodeCommit repository. For more information about using SSH keys to authenticate to an AWS CodeCommit repository, see Set up AWS CodeCommit for SSH Connections in the AWS CodeCommit User Guide .

Synopsis

Creating a Request

updateSSHPublicKey #

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

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

  • uspkUserName - The name of the IAM user associated with the SSH public key. The regex pattern for this parameter is a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-
  • uspkSSHPublicKeyId - The unique identifier for the SSH public key. The regex pattern for this parameter is a string of characters that can consist of any upper or lowercased letter or digit.
  • uspkStatus - The status to assign to the SSH public key. Active means the key can be used for authentication with an AWS CodeCommit repository. Inactive means the key cannot be used.

data UpdateSSHPublicKey #

See: updateSSHPublicKey smart constructor.

Instances

Eq UpdateSSHPublicKey # 
Data UpdateSSHPublicKey # 

Methods

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

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

toConstr :: UpdateSSHPublicKey -> Constr #

dataTypeOf :: UpdateSSHPublicKey -> DataType #

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

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

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

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

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

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

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

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

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

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

Read UpdateSSHPublicKey # 
Show UpdateSSHPublicKey # 
Generic UpdateSSHPublicKey # 
Hashable UpdateSSHPublicKey # 
NFData UpdateSSHPublicKey # 

Methods

rnf :: UpdateSSHPublicKey -> () #

AWSRequest UpdateSSHPublicKey # 
ToQuery UpdateSSHPublicKey # 
ToPath UpdateSSHPublicKey # 
ToHeaders UpdateSSHPublicKey # 
type Rep UpdateSSHPublicKey # 
type Rep UpdateSSHPublicKey = D1 (MetaData "UpdateSSHPublicKey" "Network.AWS.IAM.UpdateSSHPublicKey" "amazonka-iam-1.4.5-1ijrgQyRuWgA7Tx0390Dx2" False) (C1 (MetaCons "UpdateSSHPublicKey'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_uspkUserName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) ((:*:) (S1 (MetaSel (Just Symbol "_uspkSSHPublicKeyId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) (S1 (MetaSel (Just Symbol "_uspkStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 StatusType)))))
type Rs UpdateSSHPublicKey # 

Request Lenses

uspkUserName :: Lens' UpdateSSHPublicKey Text #

The name of the IAM user associated with the SSH public key. The regex pattern for this parameter is a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-

uspkSSHPublicKeyId :: Lens' UpdateSSHPublicKey Text #

The unique identifier for the SSH public key. The regex pattern for this parameter is a string of characters that can consist of any upper or lowercased letter or digit.

uspkStatus :: Lens' UpdateSSHPublicKey StatusType #

The status to assign to the SSH public key. Active means the key can be used for authentication with an AWS CodeCommit repository. Inactive means the key cannot be used.

Destructuring the Response

updateSSHPublicKeyResponse :: UpdateSSHPublicKeyResponse #

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

data UpdateSSHPublicKeyResponse #

See: updateSSHPublicKeyResponse smart constructor.

Instances

Eq UpdateSSHPublicKeyResponse # 
Data UpdateSSHPublicKeyResponse # 

Methods

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

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

toConstr :: UpdateSSHPublicKeyResponse -> Constr #

dataTypeOf :: UpdateSSHPublicKeyResponse -> DataType #

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

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

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

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

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

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

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

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

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

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

Read UpdateSSHPublicKeyResponse # 
Show UpdateSSHPublicKeyResponse # 
Generic UpdateSSHPublicKeyResponse # 
NFData UpdateSSHPublicKeyResponse # 
type Rep UpdateSSHPublicKeyResponse # 
type Rep UpdateSSHPublicKeyResponse = D1 (MetaData "UpdateSSHPublicKeyResponse" "Network.AWS.IAM.UpdateSSHPublicKey" "amazonka-iam-1.4.5-1ijrgQyRuWgA7Tx0390Dx2" False) (C1 (MetaCons "UpdateSSHPublicKeyResponse'" PrefixI False) U1)