AWS SDK for PHP 3.x

Service ID: transfer

Version: 2018-11-05

This page describes the parameters and results for the operations of the AWS Transfer for SFTP (2018-11-05), and shows how to use the Aws\Transfer\TransferClient object to call the described operations. This documentation is specific to the 2018-11-05 API version of the service.

Operation Summary

Each of the following operations can be created from a client using $client->getCommand('CommandName'), where "CommandName" is the name of one of the following operations. Note: a command is a value that encapsulates an operation and the parameters used to create an HTTP request.

You can also create and send a command immediately using the magic methods available on a client object: $client->commandName(/* parameters */). You can send the command asynchronously (returning a promise) by appending the word "Async" to the operation name: $client->commandNameAsync(/* parameters */).

CreateServer ( array $params = [] )
Instantiates an autoscaling virtual server based on Secure File Transfer Protocol (SFTP) in AWS.
CreateUser ( array $params = [] )
Adds a user and associate them with an existing Secure File Transfer Protocol (SFTP) server.
DeleteServer ( array $params = [] )
Deletes the Secure File Transfer Protocol (SFTP) server that you specify.
DeleteSshPublicKey ( array $params = [] )
Deletes a user's Secure Shell (SSH) public key.
DeleteUser ( array $params = [] )
Deletes the user belonging to the server you specify.
DescribeServer ( array $params = [] )
Describes the server that you specify by passing the ServerId parameter.
DescribeUser ( array $params = [] )
Describes the user assigned to a specific server, as identified by its ServerId property.
ImportSshPublicKey ( array $params = [] )
Adds a Secure Shell (SSH) public key to a user account identified by a UserName value assigned to a specific server, identified by ServerId.
ListServers ( array $params = [] )
Lists the Secure File Transfer Protocol (SFTP) servers that are associated with your AWS account.
ListTagsForResource ( array $params = [] )
Lists all of the tags associated with the Amazon Resource Number (ARN) you specify.
ListUsers ( array $params = [] )
Lists the users for the server that you specify by passing the ServerId parameter.
StartServer ( array $params = [] )
Changes the state of a Secure File Transfer Protocol (SFTP) server from OFFLINE to ONLINE.
StopServer ( array $params = [] )
Changes the state of an SFTP server from ONLINE to OFFLINE.
TagResource ( array $params = [] )
Attaches a key-value pair to a resource, as identified by its Amazon Resource Name (ARN).
TestIdentityProvider ( array $params = [] )
If the IdentityProviderType of the server is API_Gateway, tests whether your API Gateway is set up successfully.
UntagResource ( array $params = [] )
Detaches a key-value pair from a resource, as identified by its Amazon Resource Name (ARN).
UpdateServer ( array $params = [] )
Updates the server properties after that server has been created.
UpdateUser ( array $params = [] )
Assigns new properties to a user.

Paginators

Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:

ListServers
ListTagsForResource
ListUsers

Operations

CreateServer

$result = $client->createServer([/* ... */]);
$promise = $client->createServerAsync([/* ... */]);

Instantiates an autoscaling virtual server based on Secure File Transfer Protocol (SFTP) in AWS. The call returns the ServerId property assigned by the service to the newly created server. Reference this ServerId property when you make updates to your server, or work with users.

The response returns the ServerId value for the newly created server.

Parameter Syntax

$result = $client->createServer([
    'EndpointDetails' => [
        'VpcEndpointId' => '<string>',
    ],
    'EndpointType' => 'PUBLIC|VPC_ENDPOINT',
    'HostKey' => '<string>',
    'IdentityProviderDetails' => [
        'InvocationRole' => '<string>',
        'Url' => '<string>',
    ],
    'IdentityProviderType' => 'SERVICE_MANAGED|API_GATEWAY',
    'LoggingRole' => '<string>',
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Members

EndpointDetails

Type: EndpointDetails structure

The virtual private cloud (VPC) endpoint settings that you want to configure for your SFTP server.

EndpointType

Type: string

The type of VPC endpoint that you want your SFTP server connect to. If you connect to a VPC endpoint, your SFTP server isn't accessible over the public internet.

HostKey

Type: string

The RSA private key as generated by ssh-keygen -N "" -f my-new-server-key command.

If you aren't planning to migrate existing users from an existing SFTP server to a new AWS SFTP server, don't update the host key. Accidentally changing a server's host key can be disruptive. For more information, see change-host-key in the AWS SFTP User Guide.

IdentityProviderDetails

Type: IdentityProviderDetails structure

An array containing all of the information required to call a customer-supplied authentication API. This parameter is not required when the IdentityProviderType value of server that is created uses the SERVICE_MANAGED authentication method.

IdentityProviderType

Type: string

The mode of authentication enabled for this service. The default value is SERVICE_MANAGED, which allows you to store and access SFTP user credentials within the service. An IdentityProviderType value of API_GATEWAY indicates that user authentication requires a call to an API Gateway endpoint URL provided by you to integrate an identity provider of your choice.

LoggingRole

Type: string

A value that allows the service to write your SFTP users' activity to your Amazon CloudWatch logs for monitoring and auditing purposes.

Tags

Type: Array of Tag structures

Key-value pairs that can be used to group and search for servers.

Result Syntax

[
    'ServerId' => '<string>',
]

Result Details

Members

ServerId

Required: Yes
Type: string

The service-assigned ID of the SFTP server that is created.

Errors

ServiceUnavailableException:
The request has failed because the AWS Transfer for SFTP service is not available.
InternalServiceError:
This exception is thrown when an error occurs in the AWS Transfer for SFTP service.
InvalidRequestException:
This exception is thrown when the client submits a malformed request.
ResourceExistsException:
The requested resource does not exist.

CreateUser

$result = $client->createUser([/* ... */]);
$promise = $client->createUserAsync([/* ... */]);

Adds a user and associate them with an existing Secure File Transfer Protocol (SFTP) server. Using parameters for CreateUser, you can specify the user name, set the home directory, store the user's public key, and assign the user's AWS Identity and Access Management (IAM) role. You can also optionally add a scope-down policy, and assign metadata with tags that can be used to group and search for users.

The response returns the UserName and ServerId values of the new user for that server.

Parameter Syntax

$result = $client->createUser([
    'HomeDirectory' => '<string>',
    'Policy' => '<string>',
    'Role' => '<string>', // REQUIRED
    'ServerId' => '<string>', // REQUIRED
    'SshPublicKeyBody' => '<string>',
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'UserName' => '<string>', // REQUIRED
]);

Parameter Details

Members

HomeDirectory

Type: string

The landing directory (folder) for a user when they log in to the server using their SFTP client. An example is /home/username .

Policy

Type: string

A scope-down policy for your user so you can use the same IAM role across multiple users. This policy scopes down user access to portions of their Amazon S3 bucket. Variables you can use inside this policy include ${Transfer:UserName}, ${Transfer:HomeDirectory}, and ${Transfer:HomeBucket}.

Role

Required: Yes
Type: string

The IAM role that controls your user's access to your Amazon S3 bucket. The policies attached to this role will determine the level of access you want to provide your users when transferring files into and out of your Amazon S3 bucket or buckets. The IAM role should also contain a trust relationship that allows the SFTP server to access your resources when servicing your SFTP user's transfer requests.

ServerId

Required: Yes
Type: string

A system-assigned unique identifier for an SFTP server instance. This is the specific SFTP server that you added your user to.

SshPublicKeyBody

Type: string

The public portion of the Secure Shall (SSH) key used to authenticate the user to the SFTP server.

Tags

Type: Array of Tag structures

Key-value pairs that can be used to group and search for users. Tags are metadata attached to users for any purpose.

UserName

Required: Yes
Type: string

A unique string that identifies a user and is associated with a server as specified by the ServerId. This user name must be a minimum of 3 and a maximum of 32 characters long. The following are valid characters: a-z, A-Z, 0-9, underscore, and hyphen. The user name can't start with a hyphen.

Result Syntax

[
    'ServerId' => '<string>',
    'UserName' => '<string>',
]

Result Details

Members

ServerId

Required: Yes
Type: string

The ID of the SFTP server that the user is attached to.

UserName

Required: Yes
Type: string

A unique string that identifies a user account associated with an SFTP server.

Errors

ServiceUnavailableException:
The request has failed because the AWS Transfer for SFTP service is not available.
InternalServiceError:
This exception is thrown when an error occurs in the AWS Transfer for SFTP service.
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 for SFTP service.

DeleteServer

$result = $client->deleteServer([/* ... */]);
$promise = $client->deleteServerAsync([/* ... */]);

Deletes the Secure File Transfer Protocol (SFTP) server that you specify. If you used SERVICE_MANAGED as your IdentityProviderType, you need to delete all users associated with this server before deleting the server itself

No response returns from this call.

Parameter Syntax

$result = $client->deleteServer([
    'ServerId' => '<string>', // REQUIRED
]);

Parameter Details

Members

ServerId

Required: Yes
Type: string

A unique system-assigned identifier for an SFTP server instance.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ServiceUnavailableException:
The request has failed because the AWS Transfer for SFTP service is not available.
InternalServiceError:
This exception is thrown when an error occurs in the AWS Transfer for SFTP service.
InvalidRequestException:
This exception is thrown when the client submits a malformed request.
ResourceNotFoundException:
This exception is thrown when a resource is not found by the AWS Transfer for SFTP service.

DeleteSshPublicKey

$result = $client->deleteSshPublicKey([/* ... */]);
$promise = $client->deleteSshPublicKeyAsync([/* ... */]);

Deletes a user's Secure Shell (SSH) public key.

No response is returned from this call.

Parameter Syntax

$result = $client->deleteSshPublicKey([
    'ServerId' => '<string>', // REQUIRED
    'SshPublicKeyId' => '<string>', // REQUIRED
    'UserName' => '<string>', // REQUIRED
]);

Parameter Details

Members

ServerId

Required: Yes
Type: string

A system-assigned unique identifier for a Secure File Transfer Protocol (SFTP) server instance that has the user assigned to it.

SshPublicKeyId

Required: Yes
Type: string

A unique identifier used to reference your user's specific SSH key.

UserName

Required: Yes
Type: string

A unique string that identifies a user whose public key is being deleted.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ServiceUnavailableException:
The request has failed because the AWS Transfer for SFTP service is not available.
InternalServiceError:
This exception is thrown when an error occurs in the AWS Transfer for SFTP service.
InvalidRequestException:
This exception is thrown when the client submits a malformed request.
ResourceNotFoundException:
This exception is thrown when a resource is not found by the AWS Transfer for SFTP service.

DeleteUser

$result = $client->deleteUser([/* ... */]);
$promise = $client->deleteUserAsync([/* ... */]);

Deletes the user belonging to the server you specify.

No response returns from this call.

When you delete a user from a server, the user's information is lost.

Parameter Syntax

$result = $client->deleteUser([
    'ServerId' => '<string>', // REQUIRED
    'UserName' => '<string>', // REQUIRED
]);

Parameter Details

Members

ServerId

Required: Yes
Type: string

A system-assigned unique identifier for an SFTP server instance that has the user assigned to it.

UserName

Required: Yes
Type: string

A unique string that identifies a user that is being deleted from the server.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ServiceUnavailableException:
The request has failed because the AWS Transfer for SFTP service is not available.
InternalServiceError:
This exception is thrown when an error occurs in the AWS Transfer for SFTP service.
InvalidRequestException:
This exception is thrown when the client submits a malformed request.
ResourceNotFoundException:
This exception is thrown when a resource is not found by the AWS Transfer for SFTP service.

DescribeServer

$result = $client->describeServer([/* ... */]);
$promise = $client->describeServerAsync([/* ... */]);

Describes the server that you specify by passing the ServerId parameter.

The response contains a description of the server's properties.

Parameter Syntax

$result = $client->describeServer([
    'ServerId' => '<string>', // REQUIRED
]);

Parameter Details

Members

ServerId

Required: Yes
Type: string

A system-assigned unique identifier for an SFTP server.

Result Syntax

[
    'Server' => [
        'Arn' => '<string>',
        'EndpointDetails' => [
            'VpcEndpointId' => '<string>',
        ],
        'EndpointType' => 'PUBLIC|VPC_ENDPOINT',
        'HostKeyFingerprint' => '<string>',
        'IdentityProviderDetails' => [
            'InvocationRole' => '<string>',
            'Url' => '<string>',
        ],
        'IdentityProviderType' => 'SERVICE_MANAGED|API_GATEWAY',
        'LoggingRole' => '<string>',
        'ServerId' => '<string>',
        'State' => 'OFFLINE|ONLINE|STARTING|STOPPING|START_FAILED|STOP_FAILED',
        'Tags' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
        'UserCount' => <integer>,
    ],
]

Result Details

Members

Server

Required: Yes
Type: DescribedServer structure

An array containing the properties of the server with the ServerID you specified.

Errors

ServiceUnavailableException:
The request has failed because the AWS Transfer for SFTP service is not available.
InternalServiceError:
This exception is thrown when an error occurs in the AWS Transfer for SFTP service.
InvalidRequestException:
This exception is thrown when the client submits a malformed request.
ResourceNotFoundException:
This exception is thrown when a resource is not found by the AWS Transfer for SFTP service.

DescribeUser

$result = $client->describeUser([/* ... */]);
$promise = $client->describeUserAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->describeUser([
    'ServerId' => '<string>', // REQUIRED
    'UserName' => '<string>', // REQUIRED
]);

Parameter Details

Members

ServerId

Required: Yes
Type: string

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

UserName

Required: Yes
Type: string

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.

Result Syntax

[
    'ServerId' => '<string>',
    'User' => [
        'Arn' => '<string>',
        'HomeDirectory' => '<string>',
        'Policy' => '<string>',
        'Role' => '<string>',
        'SshPublicKeys' => [
            [
                'DateImported' => <DateTime>,
                'SshPublicKeyBody' => '<string>',
                'SshPublicKeyId' => '<string>',
            ],
            // ...
        ],
        'Tags' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
        'UserName' => '<string>',
    ],
]

Result Details

Members

ServerId

Required: Yes
Type: string

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

User

Required: Yes
Type: DescribedUser structure

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

Errors

ServiceUnavailableException:
The request has failed because the AWS Transfer for SFTP service is not available.
InternalServiceError:
This exception is thrown when an error occurs in the AWS Transfer for SFTP service.
InvalidRequestException:
This exception is thrown when the client submits a malformed request.
ResourceNotFoundException:
This exception is thrown when a resource is not found by the AWS Transfer for SFTP service.

ImportSshPublicKey

$result = $client->importSshPublicKey([/* ... */]);
$promise = $client->importSshPublicKeyAsync([/* ... */]);

Adds a Secure Shell (SSH) public key to a user account identified by a UserName value assigned to a specific server, identified by ServerId.

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

Parameter Syntax

$result = $client->importSshPublicKey([
    'ServerId' => '<string>', // REQUIRED
    'SshPublicKeyBody' => '<string>', // REQUIRED
    'UserName' => '<string>', // REQUIRED
]);

Parameter Details

Members

ServerId

Required: Yes
Type: string

A system-assigned unique identifier for an SFTP server.

SshPublicKeyBody

Required: Yes
Type: string

The public key portion of an SSH key pair.

UserName

Required: Yes
Type: string

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

Result Syntax

[
    'ServerId' => '<string>',
    'SshPublicKeyId' => '<string>',
    'UserName' => '<string>',
]

Result Details

Members

ServerId

Required: Yes
Type: string

A system-assigned unique identifier for an SFTP server.

SshPublicKeyId

Required: Yes
Type: string

This identifier is the name given to a public key by the system that was imported.

UserName

Required: Yes
Type: string

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

Errors

ServiceUnavailableException:
The request has failed because the AWS Transfer for SFTP service is not available.
InternalServiceError:
This exception is thrown when an error occurs in the AWS Transfer for SFTP service.
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 for SFTP service.

ListServers

$result = $client->listServers([/* ... */]);
$promise = $client->listServersAsync([/* ... */]);

Lists the Secure File Transfer Protocol (SFTP) servers that are associated with your AWS account.

Parameter Syntax

$result = $client->listServers([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members

MaxResults

Type: int

Specifies the number of servers to return as a response to the ListServers query.

NextToken

Type: string

When additional results are obtained from the ListServers command, a NextToken parameter is returned in the output. You can then pass the NextToken parameter in a subsequent command to continue listing additional servers.

Result Syntax

[
    'NextToken' => '<string>',
    'Servers' => [
        [
            'Arn' => '<string>',
            'EndpointType' => 'PUBLIC|VPC_ENDPOINT',
            'IdentityProviderType' => 'SERVICE_MANAGED|API_GATEWAY',
            'LoggingRole' => '<string>',
            'ServerId' => '<string>',
            'State' => 'OFFLINE|ONLINE|STARTING|STOPPING|START_FAILED|STOP_FAILED',
            'UserCount' => <integer>,
        ],
        // ...
    ],
]

Result Details

Members

NextToken

Type: string

When you can get additional results from the ListServers operation, a NextToken parameter is returned in the output. In a following command, you can pass in the NextToken parameter to continue listing additional servers.

Servers

Required: Yes
Type: Array of ListedServer structures

An array of servers that were listed.

Errors

ServiceUnavailableException:
The request has failed because the AWS Transfer for SFTP service is not available.
InternalServiceError:
This exception is thrown when an error occurs in the AWS Transfer for SFTP service.
InvalidNextTokenException:
The NextToken parameter that was passed is invalid.
InvalidRequestException:
This exception is thrown when the client submits a malformed request.

ListTagsForResource

$result = $client->listTagsForResource([/* ... */]);
$promise = $client->listTagsForResourceAsync([/* ... */]);

Lists all of the tags associated with the Amazon Resource Number (ARN) you specify. The resource can be a user, server, or role.

Parameter Syntax

$result = $client->listTagsForResource([
    'Arn' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members

Arn

Required: Yes
Type: string

Requests the tags associated with a particular Amazon Resource Name (ARN). An ARN is an identifier for a specific AWS resource, such as a server, user, or role.

MaxResults

Type: int

Specifies the number of tags to return as a response to the ListTagsForResource request.

NextToken

Type: string

When you request additional results from the ListTagsForResource call, a NextToken parameter is returned in the input. You can then pass in a subsequent command the NextToken parameter to continue listing additional tags.

Result Syntax

[
    'Arn' => '<string>',
    'NextToken' => '<string>',
    'Tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members

Arn

Type: string

This value is the ARN you specified to list the tags of.

NextToken

Type: string

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

Tags

Type: Array of Tag structures

Key-value pairs that are assigned to a resource, usually for the purpose of grouping and searching for items. Tags are metadata that you define that you can use for any purpose.

Errors

ServiceUnavailableException:
The request has failed because the AWS Transfer for SFTP service is not available.
InternalServiceError:
This exception is thrown when an error occurs in the AWS Transfer for SFTP service.
InvalidNextTokenException:
The NextToken parameter that was passed is invalid.
InvalidRequestException:
This exception is thrown when the client submits a malformed request.

ListUsers

$result = $client->listUsers([/* ... */]);
$promise = $client->listUsersAsync([/* ... */]);

Lists the users for the server that you specify by passing the ServerId parameter.

Parameter Syntax

$result = $client->listUsers([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'ServerId' => '<string>', // REQUIRED
]);

Parameter Details

Members

MaxResults

Type: int

Specifies the number of users to return as a response to the ListUsers request.

NextToken

Type: string

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

ServerId

Required: Yes
Type: string

A system-assigned unique identifier for a Secure File Transfer Protocol (SFTP) server that has users are assigned to it.

Result Syntax

[
    'NextToken' => '<string>',
    'ServerId' => '<string>',
    'Users' => [
        [
            'Arn' => '<string>',
            'HomeDirectory' => '<string>',
            'Role' => '<string>',
            'SshPublicKeyCount' => <integer>,
            'UserName' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members

NextToken

Type: string

ServerId

Required: Yes
Type: string

A system-assigned unique identifier for an SFTP server that the users are assigned to.

Users

Required: Yes
Type: Array of ListedUser structures

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

Errors

ServiceUnavailableException:
The request has failed because the AWS Transfer for SFTP service is not available.
InternalServiceError:
This exception is thrown when an error occurs in the AWS Transfer for SFTP service.
InvalidNextTokenException:
The NextToken parameter that was passed is invalid.
InvalidRequestException:
This exception is thrown when the client submits a malformed request.
ResourceNotFoundException:
This exception is thrown when a resource is not found by the AWS Transfer for SFTP service.

StartServer

$result = $client->startServer([/* ... */]);
$promise = $client->startServerAsync([/* ... */]);

Changes the state of a Secure File Transfer Protocol (SFTP) server from OFFLINE to ONLINE. It has no impact on an SFTP server that is already ONLINE. An ONLINE server can accept and process file transfer jobs.

The state of STARTING indicates that the server is in an intermediate state, either not fully able to respond, or not fully online. The values of START_FAILED can indicate an error condition.

No response is returned from this call.

Parameter Syntax

$result = $client->startServer([
    'ServerId' => '<string>', // REQUIRED
]);

Parameter Details

Members

ServerId

Required: Yes
Type: string

A system-assigned unique identifier for an SFTP server that you start.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ServiceUnavailableException:
The request has failed because the AWS Transfer for SFTP service is not available.
InternalServiceError:
This exception is thrown when an error occurs in the AWS Transfer for SFTP service.
InvalidRequestException:
This exception is thrown when the client submits a malformed request.
ResourceNotFoundException:
This exception is thrown when a resource is not found by the AWS Transfer for SFTP service.

StopServer

$result = $client->stopServer([/* ... */]);
$promise = $client->stopServerAsync([/* ... */]);

Changes the state of an SFTP server from ONLINE to OFFLINE. An OFFLINE server cannot accept and process file transfer jobs. Information tied to your server such as server and user properties are not affected by stopping your server. Stopping a server will not reduce or impact your Secure File Transfer Protocol (SFTP) endpoint billing.

The states of STOPPING indicates that the server is in an intermediate state, either not fully able to respond, or not fully offline. The values of STOP_FAILED can indicate an error condition.

No response is returned from this call.

Parameter Syntax

$result = $client->stopServer([
    'ServerId' => '<string>', // REQUIRED
]);

Parameter Details

Members

ServerId

Required: Yes
Type: string

A system-assigned unique identifier for an SFTP server that you stopped.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ServiceUnavailableException:
The request has failed because the AWS Transfer for SFTP service is not available.
InternalServiceError:
This exception is thrown when an error occurs in the AWS Transfer for SFTP service.
InvalidRequestException:
This exception is thrown when the client submits a malformed request.
ResourceNotFoundException:
This exception is thrown when a resource is not found by the AWS Transfer for SFTP service.

TagResource

$result = $client->tagResource([/* ... */]);
$promise = $client->tagResourceAsync([/* ... */]);

Attaches a key-value pair to a resource, as identified by its Amazon Resource Name (ARN). Resources are users, servers, roles, and other entities.

There is no response returned from this call.

Parameter Syntax

$result = $client->tagResource([
    'Arn' => '<string>', // REQUIRED
    'Tags' => [ // REQUIRED
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Members

Arn

Required: Yes
Type: string

An Amazon Resource Name (ARN) for a specific AWS resource, such as a server, user, or role.

Tags

Required: Yes
Type: Array of Tag structures

Key-value pairs assigned to ARNs that you can use to group and search for resources by type. You can attach this metadata to user accounts for any purpose.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ServiceUnavailableException:
The request has failed because the AWS Transfer for SFTP service is not available.
InternalServiceError:
This exception is thrown when an error occurs in the AWS Transfer for SFTP service.
InvalidRequestException:
This exception is thrown when the client submits a malformed request.

TestIdentityProvider

$result = $client->testIdentityProvider([/* ... */]);
$promise = $client->testIdentityProviderAsync([/* ... */]);

If the IdentityProviderType of the server is API_Gateway, tests whether your API Gateway is set up successfully. We highly recommend that you call this method to test your authentication method as soon as you create your server. By doing so, you can troubleshoot issues with the API Gateway integration to ensure that your users can successfully use the service.

Parameter Syntax

$result = $client->testIdentityProvider([
    'ServerId' => '<string>', // REQUIRED
    'UserName' => '<string>', // REQUIRED
    'UserPassword' => '<string>',
]);

Parameter Details

Members

ServerId

Required: Yes
Type: string

A system assigned identifier for a specific server. That server's user authentication method is tested with a user name and password.

UserName

Required: Yes
Type: string

This request parameter is name of the user account to be tested.

UserPassword

Type: string

The password of the user account to be tested.

Result Syntax

[
    'Message' => '<string>',
    'StatusCode' => <integer>,
    'Url' => '<string>',
]

Result Details

Members

Message

Type: string

The result of the authorization test as a message.

StatusCode

Required: Yes
Type: int

The HTTP status code that is the response from your API Gateway.

Url

Required: Yes
Type: string

The endpoint of the service used to authenticate a user.

Errors

ServiceUnavailableException:
The request has failed because the AWS Transfer for SFTP service is not available.
InternalServiceError:
This exception is thrown when an error occurs in the AWS Transfer for SFTP service.
InvalidRequestException:
This exception is thrown when the client submits a malformed request.
ResourceNotFoundException:
This exception is thrown when a resource is not found by the AWS Transfer for SFTP service.

UntagResource

$result = $client->untagResource([/* ... */]);
$promise = $client->untagResourceAsync([/* ... */]);

Detaches a key-value pair from a resource, as identified by its Amazon Resource Name (ARN). Resources are users, servers, roles, and other entities.

No response is returned from this call.

Parameter Syntax

$result = $client->untagResource([
    'Arn' => '<string>', // REQUIRED
    'TagKeys' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members

Arn

Required: Yes
Type: string

This is the value of the resource that will have the tag removed. An Amazon Resource Name (ARN) is an identifier for a specific AWS resource, such as a server, user, or role.

TagKeys

Required: Yes
Type: Array of strings

TagKeys are key-value pairs assigned to ARNs that can be used to group and search for resources by type. This metadata can be attached to resources for any purpose.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ServiceUnavailableException:
The request has failed because the AWS Transfer for SFTP service is not available.
InternalServiceError:
This exception is thrown when an error occurs in the AWS Transfer for SFTP service.
InvalidRequestException:
This exception is thrown when the client submits a malformed request.

UpdateServer

$result = $client->updateServer([/* ... */]);
$promise = $client->updateServerAsync([/* ... */]);

Updates the server properties after that server has been created.

The UpdateServer call returns the ServerId of the Secure File Transfer Protocol (SFTP) server you updated.

Parameter Syntax

$result = $client->updateServer([
    'EndpointDetails' => [
        'VpcEndpointId' => '<string>',
    ],
    'EndpointType' => 'PUBLIC|VPC_ENDPOINT',
    'HostKey' => '<string>',
    'IdentityProviderDetails' => [
        'InvocationRole' => '<string>',
        'Url' => '<string>',
    ],
    'LoggingRole' => '<string>',
    'ServerId' => '<string>', // REQUIRED
]);

Parameter Details

Members

EndpointDetails

Type: EndpointDetails structure

The virtual private cloud (VPC) endpoint settings that are configured for your SFTP server. With a VPC endpoint, your SFTP server isn't accessible over the public internet.

EndpointType

Type: string

The type of endpoint that you want your SFTP server to connect to. You can choose to connect to the public internet or a virtual private cloud (VPC) endpoint. With a VPC endpoint, your SFTP server isn't accessible over the public internet.

HostKey

Type: string

The RSA private key as generated by ssh-keygen -N "" -f my-new-server-key.

IdentityProviderDetails

Type: IdentityProviderDetails structure

This response parameter is an array containing all of the information required to call a customer's authentication API method.

LoggingRole

Type: string

A value that changes the AWS Identity and Access Management (IAM) role that allows Amazon S3 events to be logged in Amazon CloudWatch, turning logging on or off.

ServerId

Required: Yes
Type: string

A system-assigned unique identifier for an SFTP server instance that the user account is assigned to.

Result Syntax

[
    'ServerId' => '<string>',
]

Result Details

Members

ServerId

Required: Yes
Type: string

A system-assigned unique identifier for an SFTP server that the user account is assigned to.

Errors

ServiceUnavailableException:
The request has failed because the AWS Transfer for SFTP service is not available.
InternalServiceError:
This exception is thrown when an error occurs in the AWS Transfer for SFTP service.
InvalidRequestException:
This exception is thrown when the client submits a malformed request.
ResourceNotFoundException:
This exception is thrown when a resource is not found by the AWS Transfer for SFTP service.

UpdateUser

$result = $client->updateUser([/* ... */]);
$promise = $client->updateUserAsync([/* ... */]);

Assigns new properties to a user. Parameters you pass modify any or all of the following: the home directory, role, and policy for the UserName and ServerId you specify.

The response returns the ServerId and the UserName for the updated user.

Parameter Syntax

$result = $client->updateUser([
    'HomeDirectory' => '<string>',
    'Policy' => '<string>',
    'Role' => '<string>',
    'ServerId' => '<string>', // REQUIRED
    'UserName' => '<string>', // REQUIRED
]);

Parameter Details

Members

HomeDirectory

Type: string

The HomeDirectory parameter specifies the landing directory (folder) for a user when they log in to the server using their client. An example would be: /home/username .

Policy

Type: string

Allows you to supply a scope-down policy for your user so you can use the same AWS Identity and Access Management (IAM) role across multiple users. The policy scopes down users access to portions of your Amazon S3 bucket. Variables you can use inside this policy include ${Transfer:UserName}, ${Transfer:HomeDirectory}, and ${Transfer:HomeBucket}.

Role

Type: string

The IAM role that controls your user's access to your Amazon S3 bucket. The policies attached to this role will determine the level of access you want to provide your users when transferring files into and out of your Amazon S3 bucket or buckets. The IAM role should also contain a trust relationship that allows the Secure File Transfer Protocol (SFTP) server to access your resources when servicing your SFTP user's transfer requests.

ServerId

Required: Yes
Type: string

A system-assigned unique identifier for an SFTP server instance that the user account is assigned to.

UserName

Required: Yes
Type: string

A unique string that identifies a user and is associated with a server as specified by the ServerId. This is the string that will be used by your user when they log in to your SFTP server. This user name is a minimum of 3 and a maximum of 32 characters long. The following are valid characters: a-z, A-Z, 0-9, underscore, and hyphen. The user name can't start with a hyphen.

Result Syntax

[
    'ServerId' => '<string>',
    'UserName' => '<string>',
]

Result Details

Members

ServerId

Required: Yes
Type: string

A system-assigned unique identifier for an SFTP server instance that the user account is assigned to.

UserName

Required: Yes
Type: string

The unique identifier for a user that is assigned to the SFTP server instance that was specified in the request.

Errors

ServiceUnavailableException:
The request has failed because the AWS Transfer for SFTP service is not available.
InternalServiceError:
This exception is thrown when an error occurs in the AWS Transfer for SFTP service.
InvalidRequestException:
This exception is thrown when the client submits a malformed request.
ResourceNotFoundException:
This exception is thrown when a resource is not found by the AWS Transfer for SFTP service.

Shapes

DescribedServer

Description

Describe the properties of the server that was specified. Information returned includes: the server Amazon Resource Name (ARN), the authentication configuration and type, the logging role, server Id and state, and assigned tags or metadata.

Members

Arn

Required: Yes
Type: string

Specifies the unique Amazon Resource Name (ARN) for the server to be described.

EndpointDetails

Type: EndpointDetails structure

The virtual private cloud (VPC) endpoint settings that you configured for your SFTP server.

EndpointType

Type: string

The type of endpoint that your SFTP server is connected to. If your SFTP server is connected to a VPC endpoint, your server isn't accessible over the public internet.

HostKeyFingerprint

Type: string

This value contains the Message-Digest Algorithm (MD5) hash of the server's host key. This value is equivalent to the output of ssh-keygen -l -E md5 -f my-new-server-key command.

IdentityProviderDetails

Type: IdentityProviderDetails structure

Specifies information to call a customer-supplied authentication API. This field is not populated when the IdentityProviderType of the server is SERVICE_MANAGED>.

IdentityProviderType

Type: string

This property defines the mode of authentication method enabled for this service. A value of SERVICE_MANAGED, means that you are using this Server to store and access SFTP user credentials within the service. A value of API_GATEWAY indicates that you have integrated an API Gateway endpoint that will be invoked for authenticating your user into the service.

LoggingRole

Type: string

This property is an AWS Identity and Access Management (IAM) entity that allows the server to turn on Amazon CloudWatch logging for Amazon S3 events. When set, user activity can be view in your CloudWatch logs.

ServerId

Type: string

This property is a unique system assigned identifier for the SFTP server that you instantiate.

State

Type: string

The condition of the SFTP server for the server that was described. A value of ONLINE indicates that the server can accept jobs and transfer files. A State value of OFFLINE means that the server cannot perform file transfer operations.

The states of STARTING and STOPPING indicated that the server is in an intermediate state, either not fully able to respond, or not fully offline. The values of START_FAILED or STOP_FAILED can indicate an error condition.

Tags

Type: Array of Tag structures

This property contains the key-value pairs that you can use to search for and group servers that were assigned to the server that was described.

UserCount

Type: int

The number of users that are assigned to the SFTP server you specified with the ServerId.

DescribedUser

Description

Returns properties of the user that you wish to describe.

Members

Arn

Required: Yes
Type: string

This property contains the unique Amazon Resource Name (ARN) for the user that was requested to be described.

HomeDirectory

Type: string

This property specifies the landing directory (or folder) which is the location that files are written to or read from in an Amazon S3 bucket for the described user. An example would be: /bucket_name/home/username .

Policy

Type: string

Specifies the name of the policy in use for the described user.

Role

Type: string

This property specifies the IAM role that controls your user's access to your Amazon S3 bucket. The policies attached to this role will determine the level of access you want to provide your users when transferring files into and out of your Amazon S3 bucket or buckets. The IAM role should also contain a trust relationship that allows the SFTP server to access your resources when servicing your SFTP user's transfer requests.

SshPublicKeys

Type: Array of SshPublicKey structures

This property contains the public key portion of the Secure Shell (SSH) keys stored for the described user.

Tags

Type: Array of Tag structures

This property contains the key-value pairs for the user requested. Tag can be used to search for and group users for a variety of purposes.

UserName

Type: string

This property is the name of the user that was requested to be described. User names are used for authentication purposes. This is the string that will be used by your user when they log in to your SFTP server.

EndpointDetails

Description

The configuration settings for the virtual private cloud (VPC) endpoint for your SFTP server.

Members

VpcEndpointId

Type: string

The ID of the VPC endpoint.

IdentityProviderDetails

Description

Returns information related to the type of user authentication that is in use for a server's users. A server can only have one method of authentication.

Members

InvocationRole

Type: string

The Role parameter provides the type of InvocationRole used to authenticate the user account.

Url

Type: string

The IdentityProviderDetail parameter contains the location of the service endpoint used to authenticate users.

InternalServiceError

Description

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

Members

Message

Required: Yes
Type: string

InvalidNextTokenException

Description

The NextToken parameter that was passed is invalid.

Members

Message

Required: Yes
Type: string

InvalidRequestException

Description

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

Members

Message

Required: Yes
Type: string

ListedServer

Description

Returns properties of the server that was specified.

Members

Arn

Required: Yes
Type: string

The unique Amazon Resource Name (ARN) for the server to be listed.

EndpointType

Type: string

The type of VPC endpoint that your SFTP server is connected to. If your SFTP server is connected to a VPC endpoint, your server isn't accessible over the public internet.

IdentityProviderType

Type: string

The authentication method used to validate a user for the server that was specified. listed. This can include Secure Shell (SSH), user name and password combinations, or your own custom authentication method. Valid values include SERVICE_MANAGED or API_GATEWAY.

LoggingRole

Type: string

The AWS Identity and Access Management entity that allows the server to turn on Amazon CloudWatch logging.

ServerId

Type: string

This value is the unique system assigned identifier for the SFTP servers that were listed.

State

Type: string

This property describes the condition of the SFTP server for the server that was described. A value of ONLINE> indicates that the server can accept jobs and transfer files. A State value of OFFLINE means that the server cannot perform file transfer operations.

UserCount

Type: int

This property is a numeric value that indicates the number of users that are assigned to the SFTP server you specified with the ServerId.

ListedUser

Description

Returns properties of the user that you specify.

Members

Arn

Required: Yes
Type: string

This property is the unique Amazon Resource Name (ARN) for the user that you wish to learn about.

HomeDirectory

Type: string

This value specifies the location that files are written to or read from an Amazon S3 bucket for the user you specify by their ARN.

Role

Type: string

The role in use by this user. A role is an AWS Identity and Access Management (IAM) entity that in this case allows the SFTP server to act on a user's behalf. It allows the server to inherit the trust relationship that enables that user to perform file operations to their Amazon S3 bucket.

SshPublicKeyCount

Type: int

This value is the number of SSH public keys stored for the user you specified.

UserName

Type: string

The name of the user whose ARN was specified. User names are used for authentication purposes.

ResourceExistsException

Description

The requested resource does not exist.

Members

Message

Required: Yes
Type: string

Resource

Required: Yes
Type: string

ResourceType

Required: Yes
Type: string

ResourceNotFoundException

Description

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

Members

Message

Required: Yes
Type: string

Resource

Required: Yes
Type: string

ResourceType

Required: Yes
Type: string

ServiceUnavailableException

Description

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

Members

Message

Type: string

SshPublicKey

Description

Provides information about the public Secure Shell (SSH) key that is associated with a user account for a specific server (as identified by ServerId). The information returned includes the date the key was imported, the public key contents, and the public key ID. A user can store more than one SSH public key associated with their user name on a specific SFTP server.

Members

DateImported

Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date that the public key was added to the user account.

SshPublicKeyBody

Required: Yes
Type: string

The content of the SSH public key as specified by the PublicKeyId.

SshPublicKeyId

Required: Yes
Type: string

The SshPublicKeyId parameter contains the identifier of the public key.

Tag

Description

Creates a key-value pair for a specific resource. Tags are metadata that you can use to search for and group a resource for various purposes. You can apply tags to servers, users, and roles. A tag key can take more than one value. For example, to group servers for accounting purposes, you might create a tag called Group and assign the values Research and Accounting to that group.

Members

Key

Required: Yes
Type: string

The name assigned to the tag that you create.

Value

Required: Yes
Type: string

This property contains one or more values that you assigned to the key name you create.

Namespaces

Classes

Interfaces

Traits

Exceptions

Functions

AWS Transfer for SFTP 2018-11-05

Operation Summary

Paginators

Operations

CreateServer

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CreateUser

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

DeleteServer

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

DeleteSshPublicKey

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

DeleteUser

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

DescribeServer

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

DescribeUser

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

ImportSshPublicKey

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

ListServers

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

ListTagsForResource