libZSservicesZSamazonka-transferZSamazonka-transfer
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.Transfer.ImportSshPublicKey

Description

Adds a Secure Shell (SSH) public key to a user account identified by a UserName value assigned to the specific file transfer protocol-enabled server, identified by ServerId.

The response returns the UserName value, the ServerId value, and the name of the SshPublicKeyId.

Synopsis

Creating a Request

data ImportSshPublicKey Source #

See: newImportSshPublicKey smart constructor.

Constructors

ImportSshPublicKey' 

Fields

Instances

Instances details
Eq ImportSshPublicKey Source # 
Instance details

Defined in Amazonka.Transfer.ImportSshPublicKey

Read ImportSshPublicKey Source # 
Instance details

Defined in Amazonka.Transfer.ImportSshPublicKey

Show ImportSshPublicKey Source # 
Instance details

Defined in Amazonka.Transfer.ImportSshPublicKey

Generic ImportSshPublicKey Source # 
Instance details

Defined in Amazonka.Transfer.ImportSshPublicKey

Associated Types

type Rep ImportSshPublicKey :: Type -> Type #

NFData ImportSshPublicKey Source # 
Instance details

Defined in Amazonka.Transfer.ImportSshPublicKey

Methods

rnf :: ImportSshPublicKey -> () #

Hashable ImportSshPublicKey Source # 
Instance details

Defined in Amazonka.Transfer.ImportSshPublicKey

ToJSON ImportSshPublicKey Source # 
Instance details

Defined in Amazonka.Transfer.ImportSshPublicKey

AWSRequest ImportSshPublicKey Source # 
Instance details

Defined in Amazonka.Transfer.ImportSshPublicKey

Associated Types

type AWSResponse ImportSshPublicKey #

ToHeaders ImportSshPublicKey Source # 
Instance details

Defined in Amazonka.Transfer.ImportSshPublicKey

ToPath ImportSshPublicKey Source # 
Instance details

Defined in Amazonka.Transfer.ImportSshPublicKey

ToQuery ImportSshPublicKey Source # 
Instance details

Defined in Amazonka.Transfer.ImportSshPublicKey

type Rep ImportSshPublicKey Source # 
Instance details

Defined in Amazonka.Transfer.ImportSshPublicKey

type Rep ImportSshPublicKey = D1 ('MetaData "ImportSshPublicKey" "Amazonka.Transfer.ImportSshPublicKey" "libZSservicesZSamazonka-transferZSamazonka-transfer" 'False) (C1 ('MetaCons "ImportSshPublicKey'" 'PrefixI 'True) (S1 ('MetaSel ('Just "serverId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "sshPublicKeyBody") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "userName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))
type AWSResponse ImportSshPublicKey Source # 
Instance details

Defined in Amazonka.Transfer.ImportSshPublicKey

newImportSshPublicKey Source #

Create a value of ImportSshPublicKey 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:serverId:ImportSshPublicKey', importSshPublicKey_serverId - A system-assigned unique identifier for a server.

$sel:sshPublicKeyBody:ImportSshPublicKey', importSshPublicKey_sshPublicKeyBody - The public key portion of an SSH key pair.

$sel:userName:ImportSshPublicKey', importSshPublicKey_userName - The name of the user account that is assigned to one or more servers.

Request Lenses

importSshPublicKey_serverId :: Lens' ImportSshPublicKey Text Source #

A system-assigned unique identifier for a server.

importSshPublicKey_sshPublicKeyBody :: Lens' ImportSshPublicKey Text Source #

The public key portion of an SSH key pair.

importSshPublicKey_userName :: Lens' ImportSshPublicKey Text Source #

The name of the user account that is assigned to one or more servers.

Destructuring the Response

data ImportSshPublicKeyResponse Source #

Identifies the user, the server they belong to, and the identifier of the SSH public key associated with that user. A user can have more than one key on each server that they are associated with.

See: newImportSshPublicKeyResponse smart constructor.

Constructors

ImportSshPublicKeyResponse' 

Fields

  • httpStatus :: Int

    The response's http status code.

  • serverId :: Text

    A system-assigned unique identifier for a server.

  • sshPublicKeyId :: Text

    The name given to a public key by the system that was imported.

  • userName :: Text

    A user name assigned to the ServerID value that you specified.

Instances

Instances details
Eq ImportSshPublicKeyResponse Source # 
Instance details

Defined in Amazonka.Transfer.ImportSshPublicKey

Read ImportSshPublicKeyResponse Source # 
Instance details

Defined in Amazonka.Transfer.ImportSshPublicKey

Show ImportSshPublicKeyResponse Source # 
Instance details

Defined in Amazonka.Transfer.ImportSshPublicKey

Generic ImportSshPublicKeyResponse Source # 
Instance details

Defined in Amazonka.Transfer.ImportSshPublicKey

Associated Types

type Rep ImportSshPublicKeyResponse :: Type -> Type #

NFData ImportSshPublicKeyResponse Source # 
Instance details

Defined in Amazonka.Transfer.ImportSshPublicKey

type Rep ImportSshPublicKeyResponse Source # 
Instance details

Defined in Amazonka.Transfer.ImportSshPublicKey

type Rep ImportSshPublicKeyResponse = D1 ('MetaData "ImportSshPublicKeyResponse" "Amazonka.Transfer.ImportSshPublicKey" "libZSservicesZSamazonka-transferZSamazonka-transfer" 'False) (C1 ('MetaCons "ImportSshPublicKeyResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "serverId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "sshPublicKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "userName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newImportSshPublicKeyResponse Source #

Create a value of ImportSshPublicKeyResponse 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:httpStatus:ImportSshPublicKeyResponse', importSshPublicKeyResponse_httpStatus - The response's http status code.

$sel:serverId:ImportSshPublicKey', importSshPublicKeyResponse_serverId - A system-assigned unique identifier for a server.

$sel:sshPublicKeyId:ImportSshPublicKeyResponse', importSshPublicKeyResponse_sshPublicKeyId - The name given to a public key by the system that was imported.

$sel:userName:ImportSshPublicKey', importSshPublicKeyResponse_userName - A user name assigned to the ServerID value that you specified.

Response Lenses

importSshPublicKeyResponse_serverId :: Lens' ImportSshPublicKeyResponse Text Source #

A system-assigned unique identifier for a server.

importSshPublicKeyResponse_sshPublicKeyId :: Lens' ImportSshPublicKeyResponse Text Source #

The name given to a public key by the system that was imported.

importSshPublicKeyResponse_userName :: Lens' ImportSshPublicKeyResponse Text Source #

A user name assigned to the ServerID value that you specified.