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

Amazonka.IAM.UpdateSSHPublicKey

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 CodeCommit repository. For more information about using SSH keys to authenticate to an CodeCommit repository, see Set up CodeCommit for SSH connections in the CodeCommit User Guide.

Synopsis

Creating a Request

data UpdateSSHPublicKey Source #

See: newUpdateSSHPublicKey smart constructor.

Constructors

UpdateSSHPublicKey' 

Fields

  • userName :: Text

    The name of the IAM user associated with the SSH public key.

    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: _+=,.@-

  • sSHPublicKeyId :: Text

    The unique identifier for the SSH public key.

    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 to assign to the SSH public key. Active means that the key can be used for authentication with an CodeCommit repository. Inactive means that the key cannot be used.

Instances

Instances details
Eq UpdateSSHPublicKey Source # 
Instance details

Defined in Amazonka.IAM.UpdateSSHPublicKey

Read UpdateSSHPublicKey Source # 
Instance details

Defined in Amazonka.IAM.UpdateSSHPublicKey

Show UpdateSSHPublicKey Source # 
Instance details

Defined in Amazonka.IAM.UpdateSSHPublicKey

Generic UpdateSSHPublicKey Source # 
Instance details

Defined in Amazonka.IAM.UpdateSSHPublicKey

Associated Types

type Rep UpdateSSHPublicKey :: Type -> Type #

NFData UpdateSSHPublicKey Source # 
Instance details

Defined in Amazonka.IAM.UpdateSSHPublicKey

Methods

rnf :: UpdateSSHPublicKey -> () #

Hashable UpdateSSHPublicKey Source # 
Instance details

Defined in Amazonka.IAM.UpdateSSHPublicKey

AWSRequest UpdateSSHPublicKey Source # 
Instance details

Defined in Amazonka.IAM.UpdateSSHPublicKey

Associated Types

type AWSResponse UpdateSSHPublicKey #

ToHeaders UpdateSSHPublicKey Source # 
Instance details

Defined in Amazonka.IAM.UpdateSSHPublicKey

ToPath UpdateSSHPublicKey Source # 
Instance details

Defined in Amazonka.IAM.UpdateSSHPublicKey

ToQuery UpdateSSHPublicKey Source # 
Instance details

Defined in Amazonka.IAM.UpdateSSHPublicKey

type Rep UpdateSSHPublicKey Source # 
Instance details

Defined in Amazonka.IAM.UpdateSSHPublicKey

type Rep UpdateSSHPublicKey = D1 ('MetaData "UpdateSSHPublicKey" "Amazonka.IAM.UpdateSSHPublicKey" "libZSservicesZSamazonka-iamZSamazonka-iam" 'False) (C1 ('MetaCons "UpdateSSHPublicKey'" 'PrefixI 'True) (S1 ('MetaSel ('Just "userName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "sSHPublicKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 StatusType))))
type AWSResponse UpdateSSHPublicKey Source # 
Instance details

Defined in Amazonka.IAM.UpdateSSHPublicKey

newUpdateSSHPublicKey Source #

Create a value of UpdateSSHPublicKey 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:userName:UpdateSSHPublicKey', updateSSHPublicKey_userName - The name of the IAM user associated with the SSH public key.

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: _+=,.@-

$sel:sSHPublicKeyId:UpdateSSHPublicKey', updateSSHPublicKey_sSHPublicKeyId - The unique identifier for the SSH public key.

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

$sel:status:UpdateSSHPublicKey', updateSSHPublicKey_status - The status to assign to the SSH public key. Active means that the key can be used for authentication with an CodeCommit repository. Inactive means that the key cannot be used.

Request Lenses

updateSSHPublicKey_userName :: Lens' UpdateSSHPublicKey Text Source #

The name of the IAM user associated with the SSH public key.

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: _+=,.@-

updateSSHPublicKey_sSHPublicKeyId :: Lens' UpdateSSHPublicKey Text Source #

The unique identifier for the SSH public key.

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

updateSSHPublicKey_status :: Lens' UpdateSSHPublicKey StatusType Source #

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

Destructuring the Response

data UpdateSSHPublicKeyResponse Source #

See: newUpdateSSHPublicKeyResponse smart constructor.

Instances

Instances details
Eq UpdateSSHPublicKeyResponse Source # 
Instance details

Defined in Amazonka.IAM.UpdateSSHPublicKey

Read UpdateSSHPublicKeyResponse Source # 
Instance details

Defined in Amazonka.IAM.UpdateSSHPublicKey

Show UpdateSSHPublicKeyResponse Source # 
Instance details

Defined in Amazonka.IAM.UpdateSSHPublicKey

Generic UpdateSSHPublicKeyResponse Source # 
Instance details

Defined in Amazonka.IAM.UpdateSSHPublicKey

Associated Types

type Rep UpdateSSHPublicKeyResponse :: Type -> Type #

NFData UpdateSSHPublicKeyResponse Source # 
Instance details

Defined in Amazonka.IAM.UpdateSSHPublicKey

type Rep UpdateSSHPublicKeyResponse Source # 
Instance details

Defined in Amazonka.IAM.UpdateSSHPublicKey

type Rep UpdateSSHPublicKeyResponse = D1 ('MetaData "UpdateSSHPublicKeyResponse" "Amazonka.IAM.UpdateSSHPublicKey" "libZSservicesZSamazonka-iamZSamazonka-iam" 'False) (C1 ('MetaCons "UpdateSSHPublicKeyResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newUpdateSSHPublicKeyResponse :: UpdateSSHPublicKeyResponse Source #

Create a value of UpdateSSHPublicKeyResponse with all optional fields omitted.

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