| Class | Description |
|---|---|
| CreateServerRequest | |
| CreateServerResponse | |
| CreateUserRequest | |
| CreateUserResponse | |
| DeleteServerRequest | |
| DeleteServerResponse | |
| DeleteSshPublicKeyRequest | |
| DeleteSshPublicKeyResponse | |
| DeleteUserRequest | |
| DeleteUserResponse | |
| DescribedSecurityPolicy |
Describes the properties of a security policy that was specified.
|
| DescribedServer |
Describes the properties of a file transfer protocol-enabled server that was specified.
|
| DescribedUser |
Describes the properties of a user that was specified.
|
| DescribeSecurityPolicyRequest | |
| DescribeSecurityPolicyResponse | |
| DescribeServerRequest | |
| DescribeServerResponse | |
| DescribeUserRequest | |
| DescribeUserResponse | |
| EndpointDetails |
The virtual private cloud (VPC) endpoint settings that are configured for your file transfer protocol-enabled server.
|
| HomeDirectoryMapEntry |
Represents an object that contains entries and targets for
HomeDirectoryMappings. |
| IdentityProviderDetails |
Returns information related to the type of user authentication that is in use for a file transfer protocol-enabled
server's users.
|
| ImportSshPublicKeyRequest | |
| ImportSshPublicKeyResponse |
Identifies the user, the server they belong to, and the identifier of the SSH public key associated with that user.
|
| ListedServer |
Returns properties of a file transfer protocol-enabled server that was specified.
|
| ListedUser |
Returns properties of the user that you specify.
|
| ListSecurityPoliciesRequest | |
| ListSecurityPoliciesResponse | |
| ListServersRequest | |
| ListServersResponse | |
| ListTagsForResourceRequest | |
| ListTagsForResourceResponse | |
| ListUsersRequest | |
| ListUsersResponse | |
| PosixProfile | |
| SshPublicKey |
Provides information about the public Secure Shell (SSH) key that is associated with a user account for the specific
file transfer protocol-enabled server (as identified by
ServerId). |
| StartServerRequest | |
| StartServerResponse | |
| StopServerRequest | |
| StopServerResponse | |
| Tag |
Creates a key-value pair for a specific resource.
|
| TagResourceRequest | |
| TagResourceResponse | |
| TestIdentityProviderRequest | |
| TestIdentityProviderResponse | |
| TransferRequest | |
| TransferResponse | |
| TransferResponseMetadata | |
| UntagResourceRequest | |
| UntagResourceResponse | |
| UpdateServerRequest | |
| UpdateServerResponse | |
| UpdateUserRequest | |
| UpdateUserResponse |
UpdateUserResponse returns the user name and identifier for the request to update a user's properties. |
| Enum | Description |
|---|---|
| Domain | |
| EndpointType | |
| HomeDirectoryType | |
| IdentityProviderType |
Returns information related to the type of user authentication that is in use for a file transfer protocol-enabled
server's users.
|
| Protocol | |
| State |
Describes the condition of a file transfer protocol-enabled server with respect to its ability to perform file
operations.
|
| Exception | Description |
|---|---|
| AccessDeniedException |
You do not have sufficient access to perform this action.
|
| ConflictException |
This exception is thrown when the
UpdatServer is called for a file transfer protocol-enabled server that
has VPC as the endpoint type and the server's VpcEndpointID is not in the available state. |
| InternalServiceErrorException |
This exception is thrown when an error occurs in the AWS Transfer Family service.
|
| InvalidNextTokenException |
The
NextToken parameter that was passed is invalid. |
| InvalidRequestException |
This exception is thrown when the client submits a malformed request.
|
| ResourceExistsException |
The requested resource does not exist.
|
| ResourceNotFoundException |
This exception is thrown when a resource is not found by the AWS Transfer Family service.
|
| ServiceUnavailableException |
The request has failed because the AWS Transfer Family service is not available.
|
| ThrottlingException |
The request was denied due to request throttling.
|
| TransferException |