ListAccesses - AWS Transfer Family

ListAccesses

Lists the details for all the accesses you have on your server.

Request Syntax

{ "MaxResults": number, "NextToken": "string", "ServerId": "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.

MaxResults

Specifies the maximum number of access SIDs to return.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 1000.

Required: No

NextToken

When you can get additional results from the ListAccesses call, a NextToken parameter is returned in the output. You can then pass in a subsequent command to the NextToken parameter to continue listing additional accesses.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 6144.

Required: No

ServerId

A system-assigned unique identifier for a server that has users assigned to it.

Type: String

Length Constraints: Fixed length of 19.

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

Required: Yes

Response Syntax

{ "Accesses": [ { "ExternalId": "string", "HomeDirectory": "string", "HomeDirectoryType": "string", "Role": "string" } ], "NextToken": "string", "ServerId": "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.

Accesses

Returns the accesses and their properties for the ServerId value that you specify.

Type: Array of ListedAccess objects

NextToken

When you can get additional results from the ListAccesses call, a NextToken parameter is returned in the output. You can then pass in a subsequent command to the NextToken parameter to continue listing additional accesses.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 6144.

ServerId

A system-assigned unique identifier for a server that has users assigned to it.

Type: String

Length Constraints: Fixed length of 19.

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

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 AWSTransfer Family service.

HTTP Status Code: 500

InvalidNextTokenException

The NextToken parameter that was passed is invalid.

HTTP Status Code: 400

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 AWSTransfer Family service.

HTTP Status Code: 400

ServiceUnavailableException

The request has failed because the AWSTransfer Family service is not available.

HTTP Status Code: 500

See Also

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