UpdateSSHPublicKey
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.
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
- 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. Type: String
Length Constraints: Minimum length of 20. Maximum length of 128.
Pattern:
[\w]+Required: Yes
- Status
-
The status to assign to the SSH public key.
Activemeans that the key can be used for authentication with an CodeCommit repository.Inactivemeans that the key cannot be used.Type: String
Valid Values:
Active | InactiveRequired: Yes
- 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: _+=,.@- Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
[\w+=,.@-]+Required: Yes
Errors
For information about the errors that are common to all actions, see Common Errors.
- NoSuchEntity
-
The request was rejected because it referenced a resource entity that does not exist. The error message describes the resource.
HTTP Status Code: 404
Examples
Example
This example illustrates one usage of UpdateSSHPublicKey.
Sample Request
https://iam.amazonaws.com/?Action=UpdateSSHPublicKey
&SSHPublicKeyId=APKAEIVFHP46CEXAMPLE
&Status=Inactive
&UserName=Jane
&Version=2010-05-08
&AUTHPARAMSSample Response
<UpdateSSHPublicKeyResponse xmlns="https://iam.amazonaws.com/doc/2010-05-08/">
<ResponseMetadata>
<RequestId>d3d9215c-f36b-11e4-97ab-c53b2EXAMPLE</RequestId>
</ResponseMetadata>
</UpdateSSHPublicKeyResponse>See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
