Copyright	(c) 2013-2018 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None
Language	Haskell2010

Network.AWS.IAM.UpdateSSHPublicKey

Contents

Creating a Request
Request Lenses
Destructuring the Response

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 operation 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 operation 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 .

Creating a Request

updateSSHPublicKey #

Arguments

:: Text	`uspkUserName`
-> Text	`uspkSSHPublicKeyId`
-> StatusType	`uspkStatus`
-> 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. 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: _+=,.@-
uspkSSHPublicKeyId - The unique identifier for the SSH public key. This parameter allows (per its regex pattern ) 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 that the key can be used for authentication with an AWS CodeCommit repository. Inactive means that the key cannot be used.

data UpdateSSHPublicKey #

See: updateSSHPublicKey smart constructor.

Instances

Eq UpdateSSHPublicKey #
Instance details Defined in Network.AWS.IAM.UpdateSSHPublicKey Methods (==) :: UpdateSSHPublicKey -> UpdateSSHPublicKey -> Bool # (/=) :: UpdateSSHPublicKey -> UpdateSSHPublicKey -> Bool #
Data UpdateSSHPublicKey #
Instance details Defined in Network.AWS.IAM.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 #
Instance details Defined in Network.AWS.IAM.UpdateSSHPublicKey Methods readsPrec :: Int -> ReadS UpdateSSHPublicKey # readList :: ReadS [UpdateSSHPublicKey] # readPrec :: ReadPrec UpdateSSHPublicKey # readListPrec :: ReadPrec [UpdateSSHPublicKey] #
Show UpdateSSHPublicKey #
Instance details Defined in Network.AWS.IAM.UpdateSSHPublicKey Methods showsPrec :: Int -> UpdateSSHPublicKey -> ShowS # show :: UpdateSSHPublicKey -> String # showList :: [UpdateSSHPublicKey] -> ShowS #
Generic UpdateSSHPublicKey #
Instance details Defined in Network.AWS.IAM.UpdateSSHPublicKey Associated Types type Rep UpdateSSHPublicKey :: * -> * # Methods from :: UpdateSSHPublicKey -> Rep UpdateSSHPublicKey x # to :: Rep UpdateSSHPublicKey x -> UpdateSSHPublicKey #
Hashable UpdateSSHPublicKey #
Instance details Defined in Network.AWS.IAM.UpdateSSHPublicKey Methods hashWithSalt :: Int -> UpdateSSHPublicKey -> Int # hash :: UpdateSSHPublicKey -> Int #
AWSRequest UpdateSSHPublicKey #
Instance details Defined in Network.AWS.IAM.UpdateSSHPublicKey Associated Types type Rs UpdateSSHPublicKey :: * # Methods request :: UpdateSSHPublicKey -> Request UpdateSSHPublicKey # response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy UpdateSSHPublicKey -> ClientResponse -> m (Response UpdateSSHPublicKey) #
ToHeaders UpdateSSHPublicKey #
Instance details Defined in Network.AWS.IAM.UpdateSSHPublicKey Methods toHeaders :: UpdateSSHPublicKey -> [Header] #
ToPath UpdateSSHPublicKey #
Instance details Defined in Network.AWS.IAM.UpdateSSHPublicKey Methods toPath :: UpdateSSHPublicKey -> ByteString #
ToQuery UpdateSSHPublicKey #
Instance details Defined in Network.AWS.IAM.UpdateSSHPublicKey Methods toQuery :: UpdateSSHPublicKey -> QueryString #
NFData UpdateSSHPublicKey #
Instance details Defined in Network.AWS.IAM.UpdateSSHPublicKey Methods rnf :: UpdateSSHPublicKey -> () #
type Rep UpdateSSHPublicKey #
Instance details Defined in Network.AWS.IAM.UpdateSSHPublicKey type Rep UpdateSSHPublicKey = D1 (MetaData "UpdateSSHPublicKey" "Network.AWS.IAM.UpdateSSHPublicKey" "amazonka-iam-1.6.0-KLHg33OPBsA2oss7MTCyZq" False) (C1 (MetaCons "UpdateSSHPublicKey'" PrefixI True) (S1 (MetaSel (Just "_uspkUserName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :: (S1 (MetaSel (Just "_uspkSSHPublicKeyId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :: S1 (MetaSel (Just "_uspkStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 StatusType))))
type Rs UpdateSSHPublicKey #
Instance details Defined in Network.AWS.IAM.UpdateSSHPublicKey type Rs UpdateSSHPublicKey = UpdateSSHPublicKeyResponse

Request Lenses

uspkUserName :: Lens' UpdateSSHPublicKey Text #

The name of the IAM user associated with the SSH public key. 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: _+=,.@-

uspkSSHPublicKeyId :: Lens' UpdateSSHPublicKey Text #

The unique identifier for the SSH public key. This parameter allows (per its regex pattern ) 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 that the key can be used for authentication with an AWS CodeCommit repository. Inactive means that 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 #
Instance details Defined in Network.AWS.IAM.UpdateSSHPublicKey Methods (==) :: UpdateSSHPublicKeyResponse -> UpdateSSHPublicKeyResponse -> Bool # (/=) :: UpdateSSHPublicKeyResponse -> UpdateSSHPublicKeyResponse -> Bool #
Data UpdateSSHPublicKeyResponse #
Instance details Defined in Network.AWS.IAM.UpdateSSHPublicKey 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 #
Instance details Defined in Network.AWS.IAM.UpdateSSHPublicKey Methods readsPrec :: Int -> ReadS UpdateSSHPublicKeyResponse # readList :: ReadS [UpdateSSHPublicKeyResponse] # readPrec :: ReadPrec UpdateSSHPublicKeyResponse # readListPrec :: ReadPrec [UpdateSSHPublicKeyResponse] #
Show UpdateSSHPublicKeyResponse #
Instance details Defined in Network.AWS.IAM.UpdateSSHPublicKey Methods showsPrec :: Int -> UpdateSSHPublicKeyResponse -> ShowS # show :: UpdateSSHPublicKeyResponse -> String # showList :: [UpdateSSHPublicKeyResponse] -> ShowS #
Generic UpdateSSHPublicKeyResponse #
Instance details Defined in Network.AWS.IAM.UpdateSSHPublicKey Associated Types type Rep UpdateSSHPublicKeyResponse :: * -> * # Methods from :: UpdateSSHPublicKeyResponse -> Rep UpdateSSHPublicKeyResponse x # to :: Rep UpdateSSHPublicKeyResponse x -> UpdateSSHPublicKeyResponse #
NFData UpdateSSHPublicKeyResponse #
Instance details Defined in Network.AWS.IAM.UpdateSSHPublicKey Methods rnf :: UpdateSSHPublicKeyResponse -> () #
type Rep UpdateSSHPublicKeyResponse #
Instance details Defined in Network.AWS.IAM.UpdateSSHPublicKey type Rep UpdateSSHPublicKeyResponse = D1 (MetaData "UpdateSSHPublicKeyResponse" "Network.AWS.IAM.UpdateSSHPublicKey" "amazonka-iam-1.6.0-KLHg33OPBsA2oss7MTCyZq" False) (C1 (MetaCons "UpdateSSHPublicKeyResponse'" PrefixI False) (U1 :: * -> *))