AWS Transfer for SFTP 2018-11-05
- Client: Aws\Transfer\TransferClient
- 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 = [] )
Creates a user and associates 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:
Operations
CreateServer
$result = $client->createServer([/* ... */]); $promise = $client->createServerAsync([/* ... */]);
Instantiates an autoscaling virtual server based on Secure File Transfer Protocol (SFTP) in AWS. When you make updates to your server or when you work with users, use the service-generated ServerId property that is assigned to the newly created server.
Parameter Syntax
$result = $client->createServer([
'EndpointDetails' => [
'AddressAllocationIds' => ['<string>', ...],
'SubnetIds' => ['<string>', ...],
'VpcEndpointId' => '<string>',
'VpcId' => '<string>',
],
'EndpointType' => 'PUBLIC|VPC|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 are configured for your SFTP server. With a VPC endpoint, you can restrict access to your SFTP server to resources only within your VPC. To control incoming internet traffic, you will need to invoke the
UpdateServerAPI and attach an Elastic IP to your server's endpoint. - EndpointType
-
- Type: string
The type of VPC 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, you can restrict access to your SFTP server and resources only within your VPC.
- HostKey
-
- Type: string
The RSA private key as generated by the
ssh-keygen -N "" -f my-new-server-keycommand.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 "https://alpha-docs-aws.amazon.com/transfer/latest/userguide/configuring-servers.html#change-host-key" in the AWS SFTP User Guide.
- IdentityProviderDetails
-
- Type: IdentityProviderDetails structure
This parameter is required when the
IdentityProviderTypeis set toAPI_GATEWAY. Accepts an array containing all of the information required to call a customer-supplied authentication API, including the API Gateway URL. This property is not required when theIdentityProviderTypeis set toSERVICE_MANAGED. - IdentityProviderType
-
- Type: string
Specifies the mode of authentication for the SFTP server. The default value is
SERVICE_MANAGED, which allows you to store and access SFTP user credentials within the AWS Transfer for SFTP service. Use theAPI_GATEWAYvalue to integrate with an identity provider of your choosing. TheAPI_GATEWAYsetting requires you to provide an API Gateway endpoint URL to call for authentication using theIdentityProviderDetailsparameter. - 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
Errors
-
The request has failed because the AWS Transfer for SFTP service is not available.
-
This exception is thrown when an error occurs in the AWS Transfer for SFTP service.
-
This exception is thrown when the client submits a malformed request.
-
The requested resource does not exist.
CreateUser
$result = $client->createUser([/* ... */]); $promise = $client->createUserAsync([/* ... */]);
Creates a user and associates them with an existing Secure File Transfer Protocol (SFTP) server. You can only create and associate users with SFTP servers that have the IdentityProviderType set to SERVICE_MANAGED. 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.
Parameter Syntax
$result = $client->createUser([
'HomeDirectory' => '<string>',
'HomeDirectoryMappings' => [
[
'Entry' => '<string>', // REQUIRED
'Target' => '<string>', // REQUIRED
],
// ...
],
'HomeDirectoryType' => 'PATH|LOGICAL',
'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 <
your-Amazon-S3-bucket-name>/home/username. - HomeDirectoryMappings
-
- Type: Array of HomeDirectoryMapEntry structures
Logical directory mappings that specify what S3 paths and keys should be visible to your user and how you want to make them visible. You will need to specify the "
Entry" and "Target" pair, whereEntryshows how the path is made visible andTargetis the actual S3 path. If you only specify a target, it will be displayed as is. You will need to also make sure that your AWS IAM Role provides access to paths inTarget. The following is an example.'[ "/bucket2/documentation", { "Entry": "your-personal-report.pdf", "Target": "/bucket3/customized-reports/${transfer:UserName}.pdf" } ]'In most cases, you can use this value instead of the scope down policy to lock your user down to the designated home directory ("chroot"). To do this, you can set
Entryto '/' and setTargetto the HomeDirectory parameter value.If the target of a logical directory entry does not exist in S3, the entry will be ignored. As a workaround, you can use the S3 api to create 0 byte objects as place holders for your directory. If using the CLI, use the s3api call instead of s3 so you can use the put-object operation. For example, you use the following:
aws s3api put-object --bucket bucketname --key path/to/folder/. Make sure that the end of the key name ends in a / for it to be considered a folder. - HomeDirectoryType
-
- Type: string
The type of landing directory (folder) you want your users' home directory to be when they log into the SFTP server. If you set it to
PATH, the user will see the absolute Amazon S3 bucket paths as is in their SFTP clients. If you set itLOGICAL, you will need to provide mappings in theHomeDirectoryMappingsfor how you want to make S3 paths visible to your user. - 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 that you can use inside this policy include
${Transfer:UserName},${Transfer:HomeDirectory}, and${Transfer:HomeBucket}.For scope-down policies, AWS Transfer for SFTP stores the policy as a JSON blob, instead of the Amazon Resource Name (ARN) of the policy. You save the policy as a JSON blob and pass it in the
Policyargument.For an example of a scope-down policy, see "https://docs.aws.amazon.com/transfer/latest/userguide/users.html#users-policies-scope-down">Creating a Scope-Down Policy.
For more information, see "https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html" in the AWS Security Token Service API Reference.
- 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 Shell (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
Errors
-
The request has failed because the AWS Transfer for SFTP service is not available.
-
This exception is thrown when an error occurs in the AWS Transfer for SFTP service.
-
This exception is thrown when the client submits a malformed request.
-
The requested resource does not exist.
-
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.
No response returns from this operation.
Parameter Syntax
$result = $client->deleteServer([
'ServerId' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[]
Result Details
Errors
-
The request has failed because the AWS Transfer for SFTP service is not available.
-
This exception is thrown when an error occurs in the AWS Transfer for SFTP service.
-
This exception is thrown when the client submits a malformed request.
-
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 operation.
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
Errors
-
The request has failed because the AWS Transfer for SFTP service is not available.
-
This exception is thrown when an error occurs in the AWS Transfer for SFTP service.
-
This exception is thrown when the client submits a malformed request.
-
This exception is thrown when a resource is not found by the AWS Transfer for SFTP service.
-
The request was denied due to request throttling.
HTTP Status Code: 400
DeleteUser
$result = $client->deleteUser([/* ... */]); $promise = $client->deleteUserAsync([/* ... */]);
Deletes the user belonging to the server you specify.
No response returns from this operation.
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
Result Syntax
[]
Result Details
Errors
-
The request has failed because the AWS Transfer for SFTP service is not available.
-
This exception is thrown when an error occurs in the AWS Transfer for SFTP service.
-
This exception is thrown when the client submits a malformed request.
-
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. When you set EndpointType to VPC, the response will contain the EndpointDetails.
Parameter Syntax
$result = $client->describeServer([
'ServerId' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[
'Server' => [
'Arn' => '<string>',
'EndpointDetails' => [
'AddressAllocationIds' => ['<string>', ...],
'SubnetIds' => ['<string>', ...],
'VpcEndpointId' => '<string>',
'VpcId' => '<string>',
],
'EndpointType' => 'PUBLIC|VPC|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
ServerIDyou specified.
Errors
-
The request has failed because the AWS Transfer for SFTP service is not available.
-
This exception is thrown when an error occurs in the AWS Transfer for SFTP service.
-
This exception is thrown when the client submits a malformed request.
-
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 for SFTP service and perform file transfer tasks.
Result Syntax
[
'ServerId' => '<string>',
'User' => [
'Arn' => '<string>',
'HomeDirectory' => '<string>',
'HomeDirectoryMappings' => [
[
'Entry' => '<string>',
'Target' => '<string>',
],
// ...
],
'HomeDirectoryType' => 'PATH|LOGICAL',
'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
ServerIDvalue that you specified.
Errors
-
The request has failed because the AWS Transfer for SFTP service is not available.
-
This exception is thrown when an error occurs in the AWS Transfer for SFTP service.
-
This exception is thrown when the client submits a malformed request.
-
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
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
ServerIDvalue that you specified.
Errors
-
The request has failed because the AWS Transfer for SFTP service is not available.
-
This exception is thrown when an error occurs in the AWS Transfer for SFTP service.
-
This exception is thrown when the client submits a malformed request.
-
The requested resource does not exist.
-
This exception is thrown when a resource is not found by the AWS Transfer for SFTP service.
-
The request was denied due to request throttling.
HTTP Status Code: 400
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
ListServersquery. - NextToken
-
- Type: string
When additional results are obtained from the
ListServerscommand, aNextTokenparameter is returned in the output. You can then pass theNextTokenparameter in a subsequent command to continue listing additional servers.
Result Syntax
[
'NextToken' => '<string>',
'Servers' => [
[
'Arn' => '<string>',
'EndpointType' => 'PUBLIC|VPC|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
ListServersoperation, aNextTokenparameter is returned in the output. In a following command, you can pass in theNextTokenparameter to continue listing additional servers. - Servers
-
- Required: Yes
- Type: Array of ListedServer structures
An array of servers that were listed.
Errors
-
The request has failed because the AWS Transfer for SFTP service is not available.
-
This exception is thrown when an error occurs in the AWS Transfer for SFTP service.
-
The
NextTokenparameter that was passed is invalid. -
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
ListTagsForResourcerequest. - NextToken
-
- Type: string
When you request additional results from the
ListTagsForResourceoperation, aNextTokenparameter is returned in the input. You can then pass in a subsequent command to theNextTokenparameter 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
ListTagsForResourcecall, aNextTokenparameter is returned in the output. You can then pass in a subsequent command to theNextTokenparameter 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.
Errors
-
The request has failed because the AWS Transfer for SFTP service is not available.
-
This exception is thrown when an error occurs in the AWS Transfer for SFTP service.
-
The
NextTokenparameter that was passed is invalid. -
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
ListUsersrequest. - NextToken
-
- Type: string
When you can get additional results from the
ListUserscall, aNextTokenparameter is returned in the output. You can then pass in a subsequent command to theNextTokenparameter 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 assigned to it.
Result Syntax
[
'NextToken' => '<string>',
'ServerId' => '<string>',
'Users' => [
[
'Arn' => '<string>',
'HomeDirectory' => '<string>',
'HomeDirectoryType' => 'PATH|LOGICAL',
'Role' => '<string>',
'SshPublicKeyCount' => <integer>,
'UserName' => '<string>',
],
// ...
],
]
Result Details
Members
- NextToken
-
- Type: string
When you can get additional results from the
ListUserscall, aNextTokenparameter is returned in the output. You can then pass in a subsequent command to theNextTokenparameter to continue listing additional users. - 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
ServerIdvalue that you specify.
Errors
-
The request has failed because the AWS Transfer for SFTP service is not available.
-
This exception is thrown when an error occurs in the AWS Transfer for SFTP service.
-
The
NextTokenparameter that was passed is invalid. -
This exception is thrown when the client submits a malformed request.
-
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
Result Syntax
[]
Result Details
Errors
-
The request has failed because the AWS Transfer for SFTP service is not available.
-
This exception is thrown when an error occurs in the AWS Transfer for SFTP service.
-
This exception is thrown when the client submits a malformed request.
-
This exception is thrown when a resource is not found by the AWS Transfer for SFTP service.
-
The request was denied due to request throttling.
HTTP Status Code: 400
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 state 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
Result Syntax
[]
Result Details
Errors
-
The request has failed because the AWS Transfer for SFTP service is not available.
-
This exception is thrown when an error occurs in the AWS Transfer for SFTP service.
-
This exception is thrown when the client submits a malformed request.
-
This exception is thrown when a resource is not found by the AWS Transfer for SFTP service.
-
The request was denied due to request throttling.
HTTP Status Code: 400
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
Errors
-
The request has failed because the AWS Transfer for SFTP service is not available.
-
This exception is thrown when an error occurs in the AWS Transfer for SFTP service.
-
This exception is thrown when the client submits a malformed request.
-
This exception is thrown when a resource is not found by the AWS Transfer for SFTP service.
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 operation 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 the name of the user account to be tested.
- UserPassword
-
- Type: string
The password of the user account to be tested.
Result Syntax
[
'Message' => '<string>',
'Response' => '<string>',
'StatusCode' => <integer>,
'Url' => '<string>',
]
Result Details
Members
- Message
-
- Type: string
A message that indicates whether the test was successful or not.
- Response
-
- Type: string
The response that is returned from your API Gateway.
- 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
-
The request has failed because the AWS Transfer for SFTP service is not available.
-
This exception is thrown when an error occurs in the AWS Transfer for SFTP service.
-
This exception is thrown when the client submits a malformed request.
-
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
Errors
-
The request has failed because the AWS Transfer for SFTP service is not available.
-
This exception is thrown when an error occurs in the AWS Transfer for SFTP service.
-
This exception is thrown when the client submits a malformed request.
-
This exception is thrown when a resource is not found by the AWS Transfer for SFTP service.
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' => [
'AddressAllocationIds' => ['<string>', ...],
'SubnetIds' => ['<string>', ...],
'VpcEndpointId' => '<string>',
'VpcId' => '<string>',
],
'EndpointType' => 'PUBLIC|VPC|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, you can restrict access to your SFTP server to resources only within your VPC. To control incoming internet traffic, you will need to associate one or more Elastic IP addresses with your server's endpoint.
- 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.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 "https://docs.aws.amazon.com/transfer/latest/userguide/configuring-servers.html#change-host-key" in the AWS SFTP User Guide.
- 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
Errors
-
The request has failed because the AWS Transfer for SFTP service is not available.
-
This exception is thrown when the
UpdatServeris called for a server that has VPC as the endpoint type and the server'sVpcEndpointIDis not in the available state. -
This exception is thrown when an error occurs in the AWS Transfer for SFTP service.
-
This exception is thrown when the client submits a malformed request.
-
The requested resource does not exist.
-
This exception is thrown when a resource is not found by the AWS Transfer for SFTP service.
-
The request was denied due to request throttling.
HTTP Status Code: 400
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>',
'HomeDirectoryMappings' => [
[
'Entry' => '<string>', // REQUIRED
'Target' => '<string>', // REQUIRED
],
// ...
],
'HomeDirectoryType' => 'PATH|LOGICAL',
'Policy' => '<string>',
'Role' => '<string>',
'ServerId' => '<string>', // REQUIRED
'UserName' => '<string>', // REQUIRED
]);
Parameter Details
Members
- HomeDirectory
-
- Type: string
A parameter that specifies the landing directory (folder) for a user when they log in to the server using their client.
An example is
<your-Amazon-S3-bucket-name>/home/username. - HomeDirectoryMappings
-
- Type: Array of HomeDirectoryMapEntry structures
Logical directory mappings that specify what S3 paths and keys should be visible to your user and how you want to make them visible. You will need to specify the "
Entry" and "Target" pair, whereEntryshows how the path is made visible andTargetis the actual S3 path. If you only specify a target, it will be displayed as is. You will need to also make sure that your AWS IAM Role provides access to paths inTarget. The following is an example.'[ "/bucket2/documentation", { "Entry": "your-personal-report.pdf", "Target": "/bucket3/customized-reports/${transfer:UserName}.pdf" } ]'In most cases, you can use this value instead of the scope down policy to lock your user down to the designated home directory ("chroot"). To do this, you can set
Entryto '/' and setTargetto the HomeDirectory parameter value.If the target of a logical directory entry does not exist in S3, the entry will be ignored. As a workaround, you can use the S3 api to create 0 byte objects as place holders for your directory. If using the CLI, use the s3api call instead of s3 so you can use the put-object operation. For example, you use the following:
aws s3api put-object --bucket bucketname --key path/to/folder/. Make sure that the end of the key name ends in a / for it to be considered a folder. - HomeDirectoryType
-
- Type: string
The type of landing directory (folder) you want your users' home directory to be when they log into the SFTP serve. If you set it to
PATH, the user will see the absolute Amazon S3 bucket paths as is in their SFTP clients. If you set itLOGICAL, you will need to provide mappings in theHomeDirectoryMappingsfor how you want to make S3 paths visible to your user. - 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 user access to portions of your Amazon S3 bucket. Variables you can use inside this policy include
${Transfer:UserName},${Transfer:HomeDirectory}, and${Transfer:HomeBucket}.For scope-down policies, AWS Transfer for SFTP stores the policy as a JSON blob, instead of the Amazon Resource Name (ARN) of the policy. You save the policy as a JSON blob and pass it in the
Policyargument.For an example of a scope-down policy, see "https://docs.aws.amazon.com/transfer/latest/userguide/users.html#users-policies-scope-down">Creating a Scope-Down Policy.
For more information, see "https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html" in the AWS Security Token Service API Reference.
- 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
Errors
-
The request has failed because the AWS Transfer for SFTP service is not available.
-
This exception is thrown when an error occurs in the AWS Transfer for SFTP service.
-
This exception is thrown when the client submits a malformed request.
-
This exception is thrown when a resource is not found by the AWS Transfer for SFTP service.
-
The request was denied due to request throttling.
HTTP Status Code: 400
Shapes
ConflictException
Description
This exception is thrown when the UpdatServer is called for a server that has VPC as the endpoint type and the server's VpcEndpointID is not in the available state.
Members
DescribedServer
Description
Describes the properties of the server that was specified. Information returned includes the following: the server Amazon Resource Name (ARN), the authentication configuration and type, the logging role, the 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 the
ssh-keygen -l -E md5 -f my-new-server-keycommand. - IdentityProviderDetails
-
- Type: IdentityProviderDetails structure
Specifies information to call a customer-supplied authentication API. This field is not populated when the
IdentityProviderTypeof the server isSERVICE_MANAGED>. - IdentityProviderType
-
- Type: string
This property defines the mode of authentication method enabled for this service. A value of
SERVICE_MANAGEDmeans that you are using this server to store and access SFTP user credentials within the service. A value ofAPI_GATEWAYindicates 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 viewed 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
ONLINEindicates that the server can accept jobs and transfer files. AStatevalue ofOFFLINEmeans that the server cannot perform file transfer operations.The states of
STARTINGandSTOPPINGindicate that the server is in an intermediate state, either not fully able to respond, or not fully offline. The values ofSTART_FAILEDorSTOP_FAILEDcan 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 want 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 is
/your s3 bucket name/home/username. - HomeDirectoryMappings
-
- Type: Array of HomeDirectoryMapEntry structures
Logical directory mappings that you specified for what S3 paths and keys should be visible to your user and how you want to make them visible. You will need to specify the "
Entry" and "Target" pair, whereEntryshows how the path is made visible andTargetis the actual S3 path. If you only specify a target, it will be displayed as is. You will need to also make sure that your AWS IAM Role provides access to paths inTarget.In most cases, you can use this value instead of the scope down policy to lock your user down to the designated home directory ("chroot"). To do this, you can set
Entryto '/' and setTargetto the HomeDirectory parameter value.In most cases, you can use this value instead of the scope down policy to lock your user down to the designated home directory ("chroot"). To do this, you can set
Entryto '/' and setTargetto the HomeDirectory parameter value. - HomeDirectoryType
-
- Type: string
The type of landing directory (folder) you mapped for your users' to see when they log into the SFTP server. If you set it to
PATH, the user will see the absolute Amazon S3 bucket paths as is in their SFTP clients. If you set itLOGICAL, you will need to provide mappings in theHomeDirectoryMappingsfor how you want to make S3 paths visible to your user. - 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 virtual private cloud (VPC) endpoint settings that are configured for your SFTP server. With a VPC endpoint, you can restrict access to your SFTP server and resources only within your VPC. To control incoming internet traffic, invoke the UpdateServer API and attach an Elastic IP to your server's endpoint.
Members
- AddressAllocationIds
-
- Type: Array of strings
A list of address allocation IDs that are required to attach an Elastic IP address to your SFTP server's endpoint. This is only valid in the
UpdateServerAPI.This property can only be use when
EndpointTypeis set toVPC. - SubnetIds
-
- Type: Array of strings
A list of subnet IDs that are required to host your SFTP server endpoint in your VPC.
- VpcEndpointId
-
- Type: string
The ID of the VPC endpoint.
- VpcId
-
- Type: string
The VPC ID of the virtual private cloud in which the SFTP server's endpoint will be hosted.
HomeDirectoryMapEntry
Description
Represents an object that contains entries and a targets for HomeDirectoryMappings.
Members
IdentityProviderDetails
Description
Returns information related to the type of user authentication that is in use for a server's users. A server can have only one method of authentication.
Members
InternalServiceError
Description
This exception is thrown when an error occurs in the AWS Transfer for SFTP service.
Members
InvalidNextTokenException
Description
The NextToken parameter that was passed is invalid.
Members
InvalidRequestException
Description
This exception is thrown when the client submits a malformed request.
Members
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. This can include Secure Shell (SSH), user name and password combinations, or your own custom authentication method. Valid values include
SERVICE_MANAGEDorAPI_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. AStatevalue ofOFFLINEmeans that the server cannot perform file transfer operations.The states of
STARTINGandSTOPPINGindicate that the server is in an intermediate state, either not fully able to respond, or not fully offline. The values ofSTART_FAILEDorSTOP_FAILEDcan indicate an error condition. - 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 want 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.
- HomeDirectoryType
-
- Type: string
The type of landing directory (folder) you mapped for your users' home directory. If you set it to
PATH, the user will see the absolute Amazon S3 bucket paths as is in their SFTP clients. If you set itLOGICAL, you will need to provide mappings in theHomeDirectoryMappingsfor how you want to make S3 paths visible to your user. - 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
ResourceNotFoundException
Description
This exception is thrown when a resource is not found by the AWS Transfer for SFTP service.
Members
ServiceUnavailableException
Description
The request has failed because the AWS Transfer for SFTP service is not available.
Members
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
SshPublicKeyIdparameter 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.
