Sign In to the Console
AWS Transfer for SFTP
User Guide

AWS Documentation » AWS SFTP » User Guide » API Reference » Actions » DescribeUser

DescribeUser

Describes the user assigned to a specific server, as identified by its ServerId property.

The response from this call returns the properties of the user associated with the ServerId value that was specified.

Request Syntax

{
   "ServerId": "string",
   "UserName": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

ServerId

A system-assigned unique identifier for an SFTP server that has this user assigned.

Type: String

Pattern: ^s-([0-9a-f]{17})$

Required: Yes

UserName

The name of the user assigned to one or more servers. User names are part of the sign-in credentials to use the AWS Transfer service and perform file transfer tasks.

Type: String

Pattern: ^[a-z0-9]{3,32}$

Required: Yes

Response Syntax

{
   "ServerId": "string",
   "User": { 
      "Arn": "string",
      "HomeDirectory": "string",
      "Policy": "string",
      "Role": "string",
      "SshPublicKeys": [ 
         { 
            "DateImported": number,
            "SshPublicKeyBody": "string",
            "SshPublicKeyId": "string"
         }
      ],
      "Tags": [ 
         { 
            "Key": "string",
            "Value": "string"
         }
      ],
      "UserName": "string"
   }
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

ServerId

A system-assigned unique identifier for an SFTP server that has this user assigned.

Type: String

Pattern: ^s-([0-9a-f]{17})$

User

An array containing the properties of the user account for the ServerID value that you specified.

Type: DescribedUser object

Errors

For information about the errors that are common to all actions, see Common Errors.

InternalServiceError

This exception is thrown when an error occurs in the AWS Transfer for SFTP service.

HTTP Status Code: 500

InvalidRequestException

This exception is thrown when the client submits a malformed request.

HTTP Status Code: 400

ResourceNotFoundException

This exception is thrown when a resource is not found by the AWS Transfer for SFTP service.

HTTP Status Code: 400

ServiceUnavailableException

The request has failed because the AWS Transfer for SFTP service is not available.

HTTP Status Code: 500

Examples

Example

The following example returns the properties assigned to a Secure File Transfer Protocol (SFTP) server.

Sample Request


{
   "ServerId": "s-01234567890abcdef"
   "UserName": "SFTP_USER"
}

Example

Sample Response


{
   "User": { 
      "Arn": "arn:aws:necco:us-east-1:176354371281:server/s-01234567890abcdef"
      "HomeDirectory": "/home/mydirectory",
      "Role": "arn:aws:iam::176354371281:role/SFTP_role",
      "SshPublicKeys": "AAAAB3NzaC1yc2EAAAADAQABAAABAQCOtfCAis3aHfM6yc8KWAlMQxVDBHyccCde9MdLf4DQNXn8HjAHf+Bc1vGGCAREFUL1NO2PEEKING3ALLOWEDfIf+JBecywfO35Cm6IKIV0JF2YOPXvOuQRs80hQaBUvQL9xw6VEb4xzbit2QB6",
      "Tags": [ 
         { 
            "Key": "Name",
            "Value": "MySFTPServer"
         }
      "UserName": "SFTP_USER",
      ]
   }
}

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: