iam_get_ssh_public_key: Retrieves the specified SSH public key, including metadata...

Description Usage Arguments Details Request syntax

View source: R/iam_operations.R

Description

Retrieves the specified SSH public key, including metadata about the key.

Usage

1
iam_get_ssh_public_key(UserName, SSHPublicKeyId, Encoding)

Arguments

UserName

[required] 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: \_+=,[email protected]

SSHPublicKeyId

[required] 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.

Encoding

[required] Specifies the public key encoding format to use in the response. To retrieve the public key in ssh-rsa format, use SSH. To retrieve the public key in PEM format, use PEM.

Details

The SSH public key retrieved 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.

Request syntax

1
2
3
4
5
svc$get_ssh_public_key(
  UserName = "string",
  SSHPublicKeyId = "string",
  Encoding = "SSH"|"PEM"
)

paws.security.identity documentation built on Oct. 30, 2019, 11:26 a.m.