AWS Transfer Family 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 Family (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 the selected file transfer protocol in AWS.
- CreateUser ( array $params = [] )
Creates a user and associates them with an existing file transfer protocol-enabled server.
- DeleteServer ( array $params = [] )
Deletes the file transfer protocol-enabled server that you specify.
- DeleteSshPublicKey ( array $params = [] )
Deletes a user's Secure Shell (SSH) public key.
- DeleteUser ( array $params = [] )
Deletes the user belonging to a file transfer protocol-enabled server you specify.
- DescribeSecurityPolicy ( array $params = [] )
Describes the security policy that is attached to your file transfer protocol-enabled server.
- DescribeServer ( array $params = [] )
Describes a file transfer protocol-enabled server that you specify by passing the ServerId parameter.
- DescribeUser ( array $params = [] )
Describes the user assigned to the specific file transfer protocol-enabled 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 the specific file transfer protocol-enabled server, identified by ServerId.
- ListSecurityPolicies ( array $params = [] )
Lists the security policies that are attached to your file transfer protocol-enabled servers.
- ListServers ( array $params = [] )
Lists the file transfer protocol-enabled 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 a file transfer protocol-enabled server that you specify by passing the ServerId parameter.
- StartServer ( array $params = [] )
Changes the state of a file transfer protocol-enabled server from OFFLINE to ONLINE.
- StopServer ( array $params = [] )
Changes the state of a file transfer protocol-enabled 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 a file transfer protocol-enabled 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 file transfer protocol-enabled server's 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 the selected file transfer protocol in AWS. When you make updates to your file transfer protocol-enabled 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([
'Certificate' => '<string>',
'EndpointDetails' => [
'AddressAllocationIds' => ['<string>', ...],
'SecurityGroupIds' => ['<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>',
'Protocols' => ['<string>', ...],
'SecurityPolicyName' => '<string>',
'Tags' => [
[
'Key' => '<string>', // REQUIRED
'Value' => '<string>', // REQUIRED
],
// ...
],
]);
Parameter Details
Members
- Certificate
-
- Type: string
The Amazon Resource Name (ARN) of the AWS Certificate Manager (ACM) certificate. Required when
Protocolsis set toFTPS.To request a new public certificate, see Request a public certificate in the AWS Certificate Manager User Guide.
To import an existing certificate into ACM, see Importing certificates into ACM in the AWS Certificate Manager User Guide.
To request a private certificate to use FTPS through private IP addresses, see Request a private certificate in the AWS Certificate Manager User Guide.
Certificates with the following cryptographic algorithms and key sizes are supported:
-
2048-bit RSA (RSA_2048)
-
4096-bit RSA (RSA_4096)
-
Elliptic Prime Curve 256 bit (EC_prime256v1)
-
Elliptic Prime Curve 384 bit (EC_secp384r1)
-
Elliptic Prime Curve 521 bit (EC_secp521r1)
The certificate must be a valid SSL/TLS X.509 version 3 certificate with FQDN or IP address specified and information about the issuer.
- EndpointDetails
-
- Type: EndpointDetails structure
The virtual private cloud (VPC) endpoint settings that are configured for your server. When you host your endpoint within your VPC, you can make it accessible only to resources within your VPC, or you can attach Elastic IPs and make it accessible to clients over the internet. Your VPC's default security groups are automatically assigned to your endpoint.
- EndpointType
-
- Type: string
The type of VPC endpoint that you want your server to connect to. You can choose to connect to the public internet or a VPC endpoint. With a VPC endpoint, you can restrict access to your server and resources only within your VPC.
It is recommended that you use
VPCas theEndpointType. With this endpoint type, you have the option to directly associate up to three Elastic IPv4 addresses (BYO IP included) with your server's endpoint and use VPC security groups to restrict traffic by the client's public IP address. This is not possible withEndpointTypeset toVPC_ENDPOINT. - HostKey
-
- Type: string
The RSA private key as generated by the
ssh-keygen -N "" -m PEM -f my-new-server-keycommand.If you aren't planning to migrate existing users from an existing SFTP-enabled server to a new server, don't update the host key. Accidentally changing a server's host key can be disruptive.
For more information, see Change the host key for your SFTP-enabled server in the AWS Transfer Family User Guide.
- IdentityProviderDetails
-
- Type: IdentityProviderDetails structure
Required when
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. Not required whenIdentityProviderTypeis set toSERVICE_MANAGED. - IdentityProviderType
-
- Type: string
Specifies the mode of authentication for a server. The default value is
SERVICE_MANAGED, which allows you to store and access user credentials within the AWS Transfer Family 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
Allows the service to write your users' activity to your Amazon CloudWatch logs for monitoring and auditing purposes.
- Protocols
-
- Type: Array of strings
Specifies the file transfer protocol or protocols over which your file transfer protocol client can connect to your server's endpoint. The available protocols are:
-
SFTP(Secure Shell (SSH) File Transfer Protocol): File transfer over SSH -
FTPS(File Transfer Protocol Secure): File transfer with TLS encryption -
FTP(File Transfer Protocol): Unencrypted file transfer
If you select
FTPS, you must choose a certificate stored in AWS Certificate Manager (ACM) which will be used to identify your server when clients connect to it over FTPS.If
Protocolincludes eitherFTPorFTPS, then theEndpointTypemust beVPCand theIdentityProviderTypemust beAPI_GATEWAY.If
ProtocolincludesFTP, thenAddressAllocationIdscannot be associated.If
Protocolis set only toSFTP, theEndpointTypecan be set toPUBLICand theIdentityProviderTypecan be set toSERVICE_MANAGED. - SecurityPolicyName
-
- Type: string
Specifies the name of the security policy that is attached to the server.
- 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
Errors
-
You do not have sufficient access to perform this action.
-
The request has failed because the AWS Transfer Family service is not available.
-
This exception is thrown when an error occurs in the AWS Transfer Family service.
-
This exception is thrown when the client submits a malformed request.
-
The requested resource does not exist.
-
The request was denied due to request throttling.
HTTP Status Code: 400
CreateUser
$result = $client->createUser([/* ... */]); $promise = $client->createUserAsync([/* ... */]);
Creates a user and associates them with an existing file transfer protocol-enabled server. You can only create and associate users with 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 the client.
An example is
your-Amazon-S3-bucket-name>/home/username. - HomeDirectoryMappings
-
- Type: Array of HomeDirectoryMapEntry structures
Logical directory mappings that specify what Amazon 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 Amazon S3 path. If you only specify a target, it will be displayed as is. You will need to also make sure that your 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 Amazon S3, the entry will be ignored. As a workaround, you can use the Amazon S3 API to create 0 byte objects as place holders for your directory. If using the CLI, use the
s3apicall instead ofs3so 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 server. If you set it to
PATH, the user will see the absolute Amazon S3 bucket paths as is in their file transfer protocol clients. If you set itLOGICAL, you will need to provide mappings in theHomeDirectoryMappingsfor how you want to make Amazon S3 paths visible to your users. - 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 Family 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 Creating a scope-down policy.
For more information, see AssumeRole in the AWS Security Token Service API Reference.
- Role
-
- Required: Yes
- Type: string
The IAM role that controls your users' 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 server to access your resources when servicing your users' transfer requests.
- ServerId
-
- Required: Yes
- Type: string
A system-assigned unique identifier for a server instance. This is the specific 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 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 as specified by the
ServerId. This user name must be a minimum of 3 and a maximum of 100 characters long. The following are valid characters: a-z, A-Z, 0-9, underscore '_', hyphen '-', period '.', and at sign '@'. The user name can't start with a hyphen, period, or at sign.
Result Syntax
[
'ServerId' => '<string>',
'UserName' => '<string>',
]
Result Details
Members
Errors
-
The request has failed because the AWS Transfer Family service is not available.
-
This exception is thrown when an error occurs in the AWS Transfer Family 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 Family service.
DeleteServer
$result = $client->deleteServer([/* ... */]); $promise = $client->deleteServerAsync([/* ... */]);
Deletes the file transfer protocol-enabled 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
-
You do not have sufficient access to perform this action.
-
The request has failed because the AWS Transfer Family service is not available.
-
This exception is thrown when an error occurs in the AWS Transfer Family 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 Family 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 file transfer protocol-enabled 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 Family service is not available.
-
This exception is thrown when an error occurs in the AWS Transfer Family 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 Family 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 a file transfer protocol-enabled 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 Family service is not available.
-
This exception is thrown when an error occurs in the AWS Transfer Family 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 Family service.
DescribeSecurityPolicy
$result = $client->describeSecurityPolicy([/* ... */]); $promise = $client->describeSecurityPolicyAsync([/* ... */]);
Describes the security policy that is attached to your file transfer protocol-enabled server. The response contains a description of the security policy's properties. For more information about security policies, see Working with security policies.
Parameter Syntax
$result = $client->describeSecurityPolicy([
'SecurityPolicyName' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'SecurityPolicy' => [
'Fips' => true || false,
'SecurityPolicyName' => '<string>',
'SshCiphers' => ['<string>', ...],
'SshKexs' => ['<string>', ...],
'SshMacs' => ['<string>', ...],
'TlsCiphers' => ['<string>', ...],
],
]
Result Details
Members
- SecurityPolicy
-
- Required: Yes
- Type: DescribedSecurityPolicy structure
An array containing the properties of the security policy.
Errors
-
The request has failed because the AWS Transfer Family service is not available.
-
This exception is thrown when an error occurs in the AWS Transfer Family 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 Family service.
DescribeServer
$result = $client->describeServer([/* ... */]); $promise = $client->describeServerAsync([/* ... */]);
Describes a file transfer protocol-enabled server that you specify by passing the ServerId parameter.
The response contains a description of a 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>',
'Certificate' => '<string>',
'EndpointDetails' => [
'AddressAllocationIds' => ['<string>', ...],
'SecurityGroupIds' => ['<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>',
'Protocols' => ['<string>', ...],
'SecurityPolicyName' => '<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 a server with the
ServerIDyou specified.
Errors
-
The request has failed because the AWS Transfer Family service is not available.
-
This exception is thrown when an error occurs in the AWS Transfer Family 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 Family service.
DescribeUser
$result = $client->describeUser([/* ... */]); $promise = $client->describeUserAsync([/* ... */]);
Describes the user assigned to the specific file transfer protocol-enabled 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 a 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 Family 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 a 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 Family service is not available.
-
This exception is thrown when an error occurs in the AWS Transfer Family 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 Family 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 the specific file transfer protocol-enabled 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
Errors
-
The request has failed because the AWS Transfer Family service is not available.
-
This exception is thrown when an error occurs in the AWS Transfer Family 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 Family service.
-
The request was denied due to request throttling.
HTTP Status Code: 400
ListSecurityPolicies
$result = $client->listSecurityPolicies([/* ... */]); $promise = $client->listSecurityPoliciesAsync([/* ... */]);
Lists the security policies that are attached to your file transfer protocol-enabled servers.
Parameter Syntax
$result = $client->listSecurityPolicies([
'MaxResults' => <integer>,
'NextToken' => '<string>',
]);
Parameter Details
Members
- MaxResults
-
- Type: int
Specifies the number of security policies to return as a response to the
ListSecurityPoliciesquery. - NextToken
-
- Type: string
When additional results are obtained from the
ListSecurityPoliciescommand, aNextTokenparameter is returned in the output. You can then pass theNextTokenparameter in a subsequent command to continue listing additional security policies.
Result Syntax
[
'NextToken' => '<string>',
'SecurityPolicyNames' => ['<string>', ...],
]
Result Details
Members
- NextToken
-
- Type: string
When you can get additional results from the
ListSecurityPoliciesoperation, aNextTokenparameter is returned in the output. In a following command, you can pass in theNextTokenparameter to continue listing security policies. - SecurityPolicyNames
-
- Required: Yes
- Type: Array of strings
An array of security policies that were listed.
Errors
-
The request has failed because the AWS Transfer Family service is not available.
-
This exception is thrown when an error occurs in the AWS Transfer Family service.
-
The
NextTokenparameter that was passed is invalid. -
This exception is thrown when the client submits a malformed request.
ListServers
$result = $client->listServers([/* ... */]); $promise = $client->listServersAsync([/* ... */]);
Lists the file transfer protocol-enabled 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 Family service is not available.
-
This exception is thrown when an error occurs in the AWS Transfer Family 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
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 Family service is not available.
-
This exception is thrown when an error occurs in the AWS Transfer Family 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 a file transfer protocol-enabled 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 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 a 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 Family service is not available.
-
This exception is thrown when an error occurs in the AWS Transfer Family 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 Family service.
StartServer
$result = $client->startServer([/* ... */]); $promise = $client->startServerAsync([/* ... */]);
Changes the state of a file transfer protocol-enabled server from OFFLINE to ONLINE. It has no impact on a 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 Family service is not available.
-
This exception is thrown when an error occurs in the AWS Transfer Family 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 Family service.
-
The request was denied due to request throttling.
HTTP Status Code: 400
StopServer
$result = $client->stopServer([/* ... */]); $promise = $client->stopServerAsync([/* ... */]);
Changes the state of a file transfer protocol-enabled 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 the server will not reduce or impact your file transfer protocol endpoint billing; you must delete the server to stop being billed.
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 Family service is not available.
-
This exception is thrown when an error occurs in the AWS Transfer Family 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 Family 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 Family service is not available.
-
This exception is thrown when an error occurs in the AWS Transfer Family 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 Family service.
TestIdentityProvider
$result = $client->testIdentityProvider([/* ... */]); $promise = $client->testIdentityProviderAsync([/* ... */]);
If the IdentityProviderType of a file transfer protocol-enabled 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
'ServerProtocol' => 'SFTP|FTP|FTPS',
'SourceIp' => '<string>',
'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.
- ServerProtocol
-
- Type: string
The type of file transfer protocol to be tested.
The available protocols are:
-
Secure Shell (SSH) File Transfer Protocol (SFTP)
-
File Transfer Protocol Secure (FTPS)
-
File Transfer Protocol (FTP)
- SourceIp
-
- Type: string
The source IP address of the user account to be tested.
- UserName
-
- Required: Yes
- Type: string
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 Family service is not available.
-
This exception is thrown when an error occurs in the AWS Transfer Family 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 Family 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
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 Family service is not available.
-
This exception is thrown when an error occurs in the AWS Transfer Family 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 Family service.
UpdateServer
$result = $client->updateServer([/* ... */]); $promise = $client->updateServerAsync([/* ... */]);
Updates the file transfer protocol-enabled server's properties after that server has been created.
The UpdateServer call returns the ServerId of the server you updated.
Parameter Syntax
$result = $client->updateServer([
'Certificate' => '<string>',
'EndpointDetails' => [
'AddressAllocationIds' => ['<string>', ...],
'SecurityGroupIds' => ['<string>', ...],
'SubnetIds' => ['<string>', ...],
'VpcEndpointId' => '<string>',
'VpcId' => '<string>',
],
'EndpointType' => 'PUBLIC|VPC|VPC_ENDPOINT',
'HostKey' => '<string>',
'IdentityProviderDetails' => [
'InvocationRole' => '<string>',
'Url' => '<string>',
],
'LoggingRole' => '<string>',
'Protocols' => ['<string>', ...],
'SecurityPolicyName' => '<string>',
'ServerId' => '<string>', // REQUIRED
]);
Parameter Details
Members
- Certificate
-
- Type: string
The Amazon Resource Name (ARN) of the AWS Certificate Manager (ACM) certificate. Required when
Protocolsis set toFTPS.To request a new public certificate, see Request a public certificate in the AWS Certificate Manager User Guide.
To import an existing certificate into ACM, see Importing certificates into ACM in the AWS Certificate Manager User Guide.
To request a private certificate to use FTPS through private IP addresses, see Request a private certificate in the AWS Certificate Manager User Guide.
Certificates with the following cryptographic algorithms and key sizes are supported:
-
2048-bit RSA (RSA_2048)
-
4096-bit RSA (RSA_4096)
-
Elliptic Prime Curve 256 bit (EC_prime256v1)
-
Elliptic Prime Curve 384 bit (EC_secp384r1)
-
Elliptic Prime Curve 521 bit (EC_secp521r1)
The certificate must be a valid SSL/TLS X.509 version 3 certificate with FQDN or IP address specified and information about the issuer.
- EndpointDetails
-
- Type: EndpointDetails structure
The virtual private cloud (VPC) endpoint settings that are configured for your server. With a VPC endpoint, you can restrict access to your 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 server to connect to. You can choose to connect to the public internet or a VPC endpoint. With a VPC endpoint, you can restrict access to your server and resources only within your VPC.
It is recommended that you use
VPCas theEndpointType. With this endpoint type, you have the option to directly associate up to three Elastic IPv4 addresses (BYO IP included) with your server's endpoint and use VPC security groups to restrict traffic by the client's public IP address. This is not possible withEndpointTypeset toVPC_ENDPOINT. - HostKey
-
- Type: string
The RSA private key as generated by
ssh-keygen -N "" -m PEM -f my-new-server-key.If you aren't planning to migrate existing users from an existing server to a new server, don't update the host key. Accidentally changing a server's host key can be disruptive.
For more information, see Change the host key for your SFTP-enabled server in the AWS Transfer Family User Guide.
- IdentityProviderDetails
-
- Type: IdentityProviderDetails structure
An array containing all of the information required to call a customer's authentication API method.
- LoggingRole
-
- Type: string
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.
- Protocols
-
- Type: Array of strings
Specifies the file transfer protocol or protocols over which your file transfer protocol client can connect to your server's endpoint. The available protocols are:
-
Secure Shell (SSH) File Transfer Protocol (SFTP): File transfer over SSH
-
File Transfer Protocol Secure (FTPS): File transfer with TLS encryption
-
File Transfer Protocol (FTP): Unencrypted file transfer
If you select
FTPS, you must choose a certificate stored in AWS Certificate Manager (ACM) which will be used to identify your server when clients connect to it over FTPS.If
Protocolincludes eitherFTPorFTPS, then theEndpointTypemust beVPCand theIdentityProviderTypemust beAPI_GATEWAY.If
ProtocolincludesFTP, thenAddressAllocationIdscannot be associated.If
Protocolis set only toSFTP, theEndpointTypecan be set toPUBLICand theIdentityProviderTypecan be set toSERVICE_MANAGED. - SecurityPolicyName
-
- Type: string
Specifies the name of the security policy that is attached to the server.
- ServerId
-
- Required: Yes
- Type: string
A system-assigned unique identifier for a server instance that the user account is assigned to.
Result Syntax
[
'ServerId' => '<string>',
]
Result Details
Members
Errors
-
You do not have sufficient access to perform this action.
-
The request has failed because the AWS Transfer Family service is not available.
-
This exception is thrown when the
UpdatServeris called for a file transfer protocol-enabled 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 Family 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 Family 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
Specifies the landing directory (folder) for a user when they log in to the server using their file transfer protocol client.
An example is
your-Amazon-S3-bucket-name>/home/username. - HomeDirectoryMappings
-
- Type: Array of HomeDirectoryMapEntry structures
Logical directory mappings that specify what Amazon 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 Amazon S3 path. If you only specify a target, it will be displayed as is. You will need to also make sure that your 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 Amazon S3, the entry will be ignored. As a workaround, you can use the Amazon S3 API to create 0 byte objects as place holders for your directory. If using the CLI, use the
s3apicall instead ofs3so 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 server. If you set it to
PATH, the user will see the absolute Amazon S3 bucket paths as is in their file transfer protocol clients. If you set itLOGICAL, you will need to provide mappings in theHomeDirectoryMappingsfor how you want to make Amazon S3 paths visible to your users. - Policy
-
- Type: string
Allows you to supply a scope-down policy for your user so you can use the same 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 Family 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 Creating a scope-down policy.
For more information, see AssumeRole in the AWS Security Token Service API Reference.
- Role
-
- Type: string
The IAM role that controls your users' 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 server to access your resources when servicing your users' transfer requests.
- ServerId
-
- Required: Yes
- Type: string
A system-assigned unique identifier for a 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 user name must be a minimum of 3 and a maximum of 100 characters long. The following are valid characters: a-z, A-Z, 0-9, underscore '_', hyphen '-', period '.', and at sign '@'. The user name can't start with a hyphen, period, or at sign.
Result Syntax
[
'ServerId' => '<string>',
'UserName' => '<string>',
]
Result Details
Members
Errors
-
The request has failed because the AWS Transfer Family service is not available.
-
This exception is thrown when an error occurs in the AWS Transfer Family 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 Family service.
-
The request was denied due to request throttling.
HTTP Status Code: 400
Shapes
AccessDeniedException
ConflictException
Description
This exception is thrown when the UpdatServer is called for a file transfer protocol-enabled server that has VPC as the endpoint type and the server's VpcEndpointID is not in the available state.
Members
DescribedSecurityPolicy
Description
Describes the properties of a security policy that was specified. For more information about security policies, see Working with security policies.
Members
- Fips
-
- Type: boolean
Specifies whether this policy enables Federal Information Processing Standards (FIPS).
- SecurityPolicyName
-
- Required: Yes
- Type: string
Specifies the name of the security policy that is attached to the server.
- SshCiphers
-
- Type: Array of strings
Specifies the enabled Secure Shell (SSH) cipher encryption algorithms in the security policy that is attached to the server.
- SshKexs
-
- Type: Array of strings
Specifies the enabled SSH key exchange (KEX) encryption algorithms in the security policy that is attached to the server.
- SshMacs
-
- Type: Array of strings
Specifies the enabled SSH message authentication code (MAC) encryption algorithms in the security policy that is attached to the server.
- TlsCiphers
-
- Type: Array of strings
Specifies the enabled Transport Layer Security (TLS) cipher encryption algorithms in the security policy that is attached to the server.
DescribedServer
Description
Describes the properties of a file transfer protocol-enabled server that was specified.
Members
- Arn
-
- Required: Yes
- Type: string
Specifies the unique Amazon Resource Name (ARN) of the server.
- Certificate
-
- Type: string
Specifies the ARN of the AWS Certificate Manager (ACM) certificate. Required when
Protocolsis set toFTPS. - EndpointDetails
-
- Type: EndpointDetails structure
Specifies the virtual private cloud (VPC) endpoint settings that you configured for your server.
- EndpointType
-
- Type: string
Defines the type of endpoint that your server is connected to. If your server is connected to a VPC endpoint, your server isn't accessible over the public internet.
- HostKeyFingerprint
-
- Type: string
Specifies the Base64-encoded SHA256 fingerprint of the server's host key. This value is equivalent to the output of the
ssh-keygen -l -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 a server isSERVICE_MANAGED. - IdentityProviderType
-
- Type: string
Specifies the mode of authentication method enabled for this service. A value of
SERVICE_MANAGEDmeans that you are using this server to store and access 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
Specifies the AWS Identity and Access Management (IAM) role that allows a server to turn on Amazon CloudWatch logging for Amazon S3 events. When set, user activity can be viewed in your CloudWatch logs.
- Protocols
-
- Type: Array of strings
Specifies the file transfer protocol or protocols over which your file transfer protocol client can connect to your server's endpoint. The available protocols are:
-
SFTP(Secure Shell (SSH) File Transfer Protocol): File transfer over SSH -
FTPS(File Transfer Protocol Secure): File transfer with TLS encryption -
FTP(File Transfer Protocol): Unencrypted file transfer
- SecurityPolicyName
-
- Type: string
Specifies the name of the security policy that is attached to the server.
- ServerId
-
- Type: string
Specifies the unique system-assigned identifier for a server that you instantiate.
- State
-
- Type: string
Specifies the condition of a 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
Specifies 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
Specifies the number of users that are assigned to a server you specified with the
ServerId.
DescribedUser
Description
Describes the properties of a user that was specified.
Members
- Arn
-
- Required: Yes
- Type: string
Specifies the unique Amazon Resource Name (ARN) for the user that was requested to be described.
- HomeDirectory
-
- Type: string
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-Amazon-S3-bucket-name>/home/username. - HomeDirectoryMappings
-
- Type: Array of HomeDirectoryMapEntry structures
Specifies the logical directory mappings that specify what Amazon 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 Amazon S3 path. If you only specify a target, it will be displayed as is. You will need to also make sure that your AWS Identity and Access Management (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. - HomeDirectoryType
-
- Type: string
Specifies the type of landing directory (folder) you mapped for your users to see when they log into the file transfer protocol-enabled server. If you set it to
PATH, the user will see the absolute Amazon S3 bucket paths as is in their file transfer protocol clients. If you set itLOGICAL, you will need to provide mappings in theHomeDirectoryMappingsfor how you want to make Amazon S3 paths visible to your users. - Policy
-
- Type: string
Specifies the name of the policy in use for the described user.
- Role
-
- Type: string
Specifies the IAM role that controls your users' 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 a server to access your resources when servicing your users' transfer requests.
- SshPublicKeys
-
- Type: Array of SshPublicKey structures
Specifies the public key portion of the Secure Shell (SSH) keys stored for the described user.
- Tags
-
- Type: Array of Tag structures
Specifies 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
Specifies 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 server.
EndpointDetails
Description
The virtual private cloud (VPC) endpoint settings that are configured for your file transfer protocol-enabled server. With a VPC endpoint, you can restrict access to your 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 server's endpoint.
This property can only be set when
EndpointTypeis set toVPCand it is only valid in theUpdateServerAPI. - SecurityGroupIds
-
- Type: Array of strings
A list of security groups IDs that are available to attach to your server's endpoint.
This property can only be set when
EndpointTypeis set toVPC.You can only edit the
SecurityGroupIdsproperty in theUpdateServerAPI and only if you are changing theEndpointTypefromPUBLICorVPC_ENDPOINTtoVPC. - SubnetIds
-
- Type: Array of strings
A list of subnet IDs that are required to host your server endpoint in your VPC.
This property can only be set when
EndpointTypeis set toVPC. - VpcEndpointId
-
- Type: string
The ID of the VPC endpoint.
This property can only be set when
EndpointTypeis set toVPC_ENDPOINT. - VpcId
-
- Type: string
The VPC ID of the VPC in which a server's endpoint will be hosted.
This property can only be set when
EndpointTypeis set toVPC.
HomeDirectoryMapEntry
Description
Represents an object that contains entries and targets for HomeDirectoryMappings.
Members
IdentityProviderDetails
Description
Returns information related to the type of user authentication that is in use for a file transfer protocol-enabled 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 Family 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 a file transfer protocol-enabled server that was specified.
Members
- Arn
-
- Required: Yes
- Type: string
Specifies the unique Amazon Resource Name (ARN) for a server to be listed.
- EndpointType
-
- Type: string
Specifies the type of VPC endpoint that your server is connected to. If your server is connected to a VPC endpoint, your server isn't accessible over the public internet.
- IdentityProviderType
-
- Type: string
Specifies the authentication method used to validate a user for a 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
Specifies the AWS Identity and Access Management (IAM) role that allows a server to turn on Amazon CloudWatch logging.
- ServerId
-
- Type: string
Specifies the unique system assigned identifier for the servers that were listed.
- State
-
- Type: string
Specifies the condition of a 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. - UserCount
-
- Type: int
Specifies the number of users that are assigned to a server you specified with the
ServerId.
ListedUser
Description
Returns properties of the user that you specify.
Members
- Arn
-
- Required: Yes
- Type: string
Provides the unique Amazon Resource Name (ARN) for the user that you want to learn about.
- HomeDirectory
-
- Type: string
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
Specifies 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 file transfer protocol clients. If you set itLOGICAL, you will need to provide mappings in theHomeDirectoryMappingsfor how you want to make Amazon S3 paths visible to your users. - Role
-
- Type: string
Specifies the role that is in use by this user. A role is an AWS Identity and Access Management (IAM) entity that, in this case, allows a file transfer protocol-enabled 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
Specifies the number of SSH public keys stored for the user you specified.
- UserName
-
- Type: string
Specifies 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 Family service.
Members
ServiceUnavailableException
Description
The request has failed because the AWS Transfer Family service is not available.
Members
SshPublicKey
Description
Provides information about the public Secure Shell (SSH) key that is associated with a user account for the specific file transfer protocol-enabled server (as identified by ServerId). 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 server.
Members
- DateImported
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
Specifies the date that the public key was added to the user account.
- SshPublicKeyBody
-
- Required: Yes
- Type: string
Specifies the content of the SSH public key as specified by the
PublicKeyId. - SshPublicKeyId
-
- Required: Yes
- Type: string
Specifies 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.