getSSHPublicKey method

Future<GetSSHPublicKeyResponse> getSSHPublicKey({ required EncodingType encoding, required String sSHPublicKeyId, required String userName, })

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

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.

May throw NoSuchEntityException. May throw UnrecognizedPublicKeyEncodingException.

Parameter encoding : 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.

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

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

Implementation

Future<GetSSHPublicKeyResponse> getSSHPublicKey({
  required EncodingType encoding,
  required String sSHPublicKeyId,
  required String userName,
}) async {
  ArgumentError.checkNotNull(encoding, 'encoding');
  ArgumentError.checkNotNull(sSHPublicKeyId, 'sSHPublicKeyId');
  _s.validateStringLength(
    'sSHPublicKeyId',
    sSHPublicKeyId,
    20,
    128,
    isRequired: true,
  );
  ArgumentError.checkNotNull(userName, 'userName');
  _s.validateStringLength(
    'userName',
    userName,
    1,
    64,
    isRequired: true,
  );
  final $request = <String, dynamic>{};
  $request['Encoding'] = encoding.toValue();
  $request['SSHPublicKeyId'] = sSHPublicKeyId;
  $request['UserName'] = userName;
  final $result = await _protocol.send(
    $request,
    action: 'GetSSHPublicKey',
    version: '2010-05-08',
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    shape: shapes['GetSSHPublicKeyRequest'],
    shapes: shapes,
    resultWrapper: 'GetSSHPublicKeyResult',
  );
  return GetSSHPublicKeyResponse.fromXml($result);
}