AWS SDK for PHP 3.x

Service ID: transfer

Version: 2018-11-05

This page describes the parameters and results for the operations of the AWS Transfer 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 */).

CreateAccess ( array $params = [] )
Used by administrators to choose which groups in the directory should have access to upload and download files over the enabled protocols using Amazon Web Services Transfer Family.
CreateServer ( array $params = [] )
Instantiates an auto-scaling virtual server based on the selected file transfer protocol in Amazon Web Services.
CreateUser ( array $params = [] )
Creates a user and associates them with an existing file transfer protocol-enabled server.
CreateWorkflow ( array $params = [] )
Allows you to create a workflow with specified steps and step details the workflow invokes after file transfer completes.
DeleteAccess ( array $params = [] )
Allows you to delete the access specified in the ServerID and ExternalID parameters.
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.
DeleteWorkflow ( array $params = [] )
Deletes the specified workflow.
DescribeAccess ( array $params = [] )
Describes the access that is assigned to the specific file transfer protocol-enabled server, as identified by its ServerId property and its ExternalID.
DescribeExecution ( array $params = [] )
You can use DescribeExecution to check the details of the execution of the specified workflow.
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.
DescribeWorkflow ( array $params = [] )
Describes the specified workflow.
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.
ListAccesses ( array $params = [] )
Lists the details for all the accesses you have on your server.
ListExecutions ( array $params = [] )
Lists all executions for the specified workflow.
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 Amazon Web Services account.
ListTagsForResource ( array $params = [] )
Lists all of the tags associated with the Amazon Resource Name (ARN) that you specify.
ListUsers ( array $params = [] )
Lists the users for a file transfer protocol-enabled server that you specify by passing the ServerId parameter.
ListWorkflows ( array $params = [] )
Lists all of your workflows.
SendWorkflowStepState ( array $params = [] )
Sends a callback for asynchronous custom steps.
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 AWS_DIRECTORY_SERVICE or API_Gateway, tests whether your identity provider is set up successfully.
UntagResource ( array $params = [] )
Detaches a key-value pair from a resource, as identified by its Amazon Resource Name (ARN).
UpdateAccess ( array $params = [] )
Allows you to update parameters for the access specified in the ServerID and ExternalID parameters.
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:

ListAccesses
ListExecutions
ListSecurityPolicies
ListServers
ListTagsForResource
ListUsers
ListWorkflows

Operations

CreateAccess

$result = $client->createAccess([/* ... */]);
$promise = $client->createAccessAsync([/* ... */]);

Used by administrators to choose which groups in the directory should have access to upload and download files over the enabled protocols using Amazon Web Services Transfer Family. For example, a Microsoft Active Directory might contain 50,000 users, but only a small fraction might need the ability to transfer files to the server. An administrator can use CreateAccess to limit the access to the correct set of users who need this ability.

Parameter Syntax

$result = $client->createAccess([
    'ExternalId' => '<string>', // REQUIRED
    'HomeDirectory' => '<string>',
    'HomeDirectoryMappings' => [
        [
            'Entry' => '<string>', // REQUIRED
            'Target' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'HomeDirectoryType' => 'PATH|LOGICAL',
    'Policy' => '<string>',
    'PosixProfile' => [
        'Gid' => <integer>, // REQUIRED
        'SecondaryGids' => [<integer>, ...],
        'Uid' => <integer>, // REQUIRED
    ],
    'Role' => '<string>', // REQUIRED
    'ServerId' => '<string>', // REQUIRED
]);

Parameter Details

Members

ExternalId

Required: Yes
Type: string

A unique identifier that is required to identify specific groups within your directory. The users of the group that you associate have access to your Amazon S3 or Amazon EFS resources over the enabled protocols using Amazon Web Services Transfer Family. If you know the group name, you can view the SID values by running the following command using Windows PowerShell.

Get-ADGroup -Filter {samAccountName -like "YourGroupName*"} -Properties * | Select SamAccountName,ObjectSid

In that command, replace YourGroupName with the name of your Active Directory group.

The regex used to validate this parameter is a string of characters consisting of uppercase and lowercase alphanumeric characters with no spaces. You can also include underscores or any of the following characters: =,.@:/-

HomeDirectory

Type: string

The landing directory (folder) for a user when they log in to the server using the client.

A HomeDirectory example is /bucket_name/home/mydirectory.

HomeDirectoryMappings

Type: Array of HomeDirectoryMapEntry structures

Logical directory mappings that specify what Amazon S3 or Amazon EFS paths and keys should be visible to your user and how you want to make them visible. You must specify the Entry and Target pair, where Entry shows how the path is made visible and Target is the actual Amazon S3 or Amazon EFS path. If you only specify a target, it is displayed as is. You also must ensure that your Amazon Web Services Identity and Access Management (IAM) role provides access to paths in Target. This value can only be set when HomeDirectoryType is set to LOGICAL.

The following is an Entry and Target pair example.

[ { "Entry": "/directory1", "Target": "/bucket_name/home/mydirectory" } ]

In most cases, you can use this value instead of the session policy to lock down your user to the designated home directory ("chroot"). To do this, you can set Entry to / and set Target to the HomeDirectory parameter value.

The following is an Entry and Target pair example for chroot.

[ { "Entry:": "/", "Target": "/bucket_name/home/mydirectory" } ]

If the target of a logical directory entry does not exist in Amazon S3 or EFS, the entry is ignored. As a workaround, you can use the Amazon S3 API or EFS API to create 0 byte objects as place holders for your directory. If using the CLI, use the s3api or efsapi call instead of s3 or efs 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 server. If you set it to PATH, the user will see the absolute Amazon S3 bucket or EFS paths as is in their file transfer protocol clients. If you set it LOGICAL, you need to provide mappings in the HomeDirectoryMappings for how you want to make Amazon S3 or EFS paths visible to your users.

Policy

Type: string

A session policy for your user so that 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}.

This only applies when the domain of ServerId is S3. EFS does not use session policies.

For session policies, Amazon Web Services 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 Policy argument.

For an example of a session policy, see Example session policy.

For more information, see AssumeRole in the Amazon Web Services Security Token Service API Reference.

PosixProfile

Type: PosixProfile structure

The full POSIX identity, including user ID (Uid), group ID (Gid), and any secondary groups IDs (SecondaryGids), that controls your users' access to your Amazon EFS file systems. The POSIX permissions that are set on files and directories in your file system determine the level of access your users get when transferring files into and out of your Amazon EFS file systems.

Role

Required: Yes
Type: string

Specifies the Amazon Resource Name (ARN) of the IAM role that controls your users' access to your Amazon S3 bucket or EFS file system. The policies attached to this role determine the level of access that you want to provide your users when transferring files into and out of your Amazon S3 bucket or EFS file system. 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.

Result Syntax

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

Result Details

Members

ExternalId

Required: Yes
Type: string

The external ID of the group whose users have access to your Amazon S3 or Amazon EFS resources over the enabled protocols using Amazon Web Services Transfer Family.

ServerId

Required: Yes
Type: string

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

Errors

ServiceUnavailableException:
The request has failed because the Amazon Web ServicesTransfer Family service is not available.
InternalServiceError:
This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family service.
InvalidRequestException:
This exception is thrown when the client submits a malformed request.
ResourceExistsException:
The requested resource does not exist.
ResourceNotFoundException:
This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.

CreateServer

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

Instantiates an auto-scaling virtual server based on the selected file transfer protocol in Amazon Web Services. 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>',
    'Domain' => 'S3|EFS',
    'EndpointDetails' => [
        'AddressAllocationIds' => ['<string>', ...],
        'SecurityGroupIds' => ['<string>', ...],
        'SubnetIds' => ['<string>', ...],
        'VpcEndpointId' => '<string>',
        'VpcId' => '<string>',
    ],
    'EndpointType' => 'PUBLIC|VPC|VPC_ENDPOINT',
    'HostKey' => '<string>',
    'IdentityProviderDetails' => [
        'DirectoryId' => '<string>',
        'InvocationRole' => '<string>',
        'Url' => '<string>',
    ],
    'IdentityProviderType' => 'SERVICE_MANAGED|API_GATEWAY|AWS_DIRECTORY_SERVICE',
    'LoggingRole' => '<string>',
    'Protocols' => ['<string>', ...],
    'SecurityPolicyName' => '<string>',
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'WorkflowDetails' => [
        'OnUpload' => [ // REQUIRED
            [
                'ExecutionRole' => '<string>', // REQUIRED
                'WorkflowId' => '<string>', // REQUIRED
            ],
            // ...
        ],
    ],
]);

Parameter Details

Members

Certificate

Type: string

The Amazon Resource Name (ARN) of the Amazon Web Services Certificate Manager (ACM) certificate. Required when Protocols is set to FTPS.

To request a new public certificate, see Request a public certificate in the Amazon Web Services Certificate Manager User Guide.

To import an existing certificate into ACM, see Importing certificates into ACM in the Amazon Web Services Certificate Manager User Guide.

To request a private certificate to use FTPS through private IP addresses, see Request a private certificate in the Amazon Web Services 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.

Domain

Type: string

The domain of the storage system that is used for file transfers. There are two domains available: Amazon Simple Storage Service (Amazon S3) and Amazon Elastic File System (Amazon EFS). The default value is S3.

After the server is created, the domain cannot be changed.

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 IP addresses 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 endpoint that you want your server to use. You can choose to make your server's endpoint publicly accessible (PUBLIC) or host it inside your VPC. With an endpoint that is hosted in a VPC, you can restrict access to your server and resources only within your VPC or choose to make it internet facing by attaching Elastic IP addresses directly to it.

After May 19, 2021, you won't be able to create a server using EndpointType=VPC_ENDPOINT in your Amazon Web Services account if your account hasn't already done so before May 19, 2021. If you have already created servers with EndpointType=VPC_ENDPOINT in your Amazon Web Services account on or before May 19, 2021, you will not be affected. After this date, use EndpointType=VPC.

For more information, see https://docs.aws.amazon.com/transfer/latest/userguide/create-server-in-vpc.html#deprecate-vpc-endpoint.

It is recommended that you use VPC as the EndpointType. 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 with EndpointType set to VPC_ENDPOINT.

HostKey

Type: string

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

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 Amazon Web Services Transfer Family User Guide.

IdentityProviderDetails

Type: IdentityProviderDetails structure

Required when IdentityProviderType is set to AWS_DIRECTORY_SERVICE or API_GATEWAY. Accepts an array containing all of the information required to use a directory in AWS_DIRECTORY_SERVICE or invoke a customer-supplied authentication API, including the API Gateway URL. Not required when IdentityProviderType is set to SERVICE_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 Amazon Web Services Transfer Family service.

Use AWS_DIRECTORY_SERVICE to provide access to Active Directory groups in Amazon Web Services Managed Active Directory or Microsoft Active Directory in your on-premises environment or in Amazon Web Services using AD Connectors. This option also requires you to provide a Directory ID using the IdentityProviderDetails parameter.

Use the API_GATEWAY value to integrate with an identity provider of your choosing. The API_GATEWAY setting requires you to provide an API Gateway endpoint URL to call for authentication using the IdentityProviderDetails parameter.

LoggingRole

Type: string

Specifies the Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) role that allows a server to turn on Amazon CloudWatch logging for Amazon S3 or Amazon EFS 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

If you select FTPS, you must choose a certificate stored in Amazon Web Services Certificate Manager (ACM) which is used to identify your server when clients connect to it over FTPS.

If Protocol includes either FTP or FTPS, then the EndpointType must be VPC and the IdentityProviderType must be AWS_DIRECTORY_SERVICE or API_GATEWAY.

If Protocol includes FTP, then AddressAllocationIds cannot be associated.

If Protocol is set only to SFTP, the EndpointType can be set to PUBLIC and the IdentityProviderType can be set to SERVICE_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.

WorkflowDetails

Type: WorkflowDetails structure

Specifies the workflow ID for the workflow to assign and the execution role used for executing the workflow.

Result Syntax

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

Result Details

Members

ServerId

Required: Yes
Type: string

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

Errors

AccessDeniedException:
You do not have sufficient access to perform this action.
ServiceUnavailableException:
The request has failed because the Amazon Web ServicesTransfer Family service is not available.
InternalServiceError:
This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family service.
InvalidRequestException:
This exception is thrown when the client submits a malformed request.
ResourceExistsException:
The requested resource does not exist.
ResourceNotFoundException:
This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.
ThrottlingException:
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 Amazon Web Services Identity and Access Management (IAM) role. You can also optionally add a session 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>',
    'PosixProfile' => [
        'Gid' => <integer>, // REQUIRED
        'SecondaryGids' => [<integer>, ...],
        'Uid' => <integer>, // REQUIRED
    ],
    '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.

A HomeDirectory example is /bucket_name/home/mydirectory.

HomeDirectoryMappings

Type: Array of HomeDirectoryMapEntry structures

The following is an Entry and Target pair example.

[ { "Entry": "/directory1", "Target": "/bucket_name/home/mydirectory" } ]

In most cases, you can use this value instead of the session policy to lock your user down to the designated home directory ("chroot"). To do this, you can set Entry to / and set Target to the HomeDirectory parameter value.

The following is an Entry and Target pair example for chroot.

[ { "Entry:": "/", "Target": "/bucket_name/home/mydirectory" } ]

HomeDirectoryType

Type: string

Policy

Type: string

This only applies when the domain of ServerId is S3. EFS does not use session policies.

For an example of a session policy, see Example session policy.

For more information, see AssumeRole in the Amazon Web Services Security Token Service API Reference.

PosixProfile

Type: PosixProfile structure

Specifies the full POSIX identity, including user ID (Uid), group ID (Gid), and any secondary groups IDs (SecondaryGids), that controls your users' access to your Amazon EFS file systems. The POSIX permissions that are set on files and directories in Amazon EFS determine the level of access your users get when transferring files into and out of your Amazon EFS file systems.

Role

Required: Yes
Type: string

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 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

ServerId

Required: Yes
Type: string

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

UserName

Required: Yes
Type: string

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

Errors

ServiceUnavailableException:
The request has failed because the Amazon Web ServicesTransfer Family service is not available.
InternalServiceError:
This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family service.
InvalidRequestException:
This exception is thrown when the client submits a malformed request.
ResourceExistsException:
The requested resource does not exist.
ResourceNotFoundException:
This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.

CreateWorkflow

$result = $client->createWorkflow([/* ... */]);
$promise = $client->createWorkflowAsync([/* ... */]);

Allows you to create a workflow with specified steps and step details the workflow invokes after file transfer completes. After creating a workflow, you can associate the workflow created with any transfer servers by specifying the workflow-details field in CreateServer and UpdateServer operations.

Parameter Syntax

$result = $client->createWorkflow([
    'Description' => '<string>',
    'OnExceptionSteps' => [
        [
            'CopyStepDetails' => [
                'DestinationFileLocation' => [
                    'EfsFileLocation' => [
                        'FileSystemId' => '<string>',
                        'Path' => '<string>',
                    ],
                    'S3FileLocation' => [
                        'Bucket' => '<string>',
                        'Key' => '<string>',
                    ],
                ],
                'Name' => '<string>',
                'OverwriteExisting' => 'TRUE|FALSE',
            ],
            'CustomStepDetails' => [
                'Name' => '<string>',
                'Target' => '<string>',
                'TimeoutSeconds' => <integer>,
            ],
            'DeleteStepDetails' => [
                'Name' => '<string>',
            ],
            'TagStepDetails' => [
                'Name' => '<string>',
                'Tags' => [
                    [
                        'Key' => '<string>', // REQUIRED
                        'Value' => '<string>', // REQUIRED
                    ],
                    // ...
                ],
            ],
            'Type' => 'COPY|CUSTOM|TAG|DELETE',
        ],
        // ...
    ],
    'Steps' => [ // REQUIRED
        [
            'CopyStepDetails' => [
                'DestinationFileLocation' => [
                    'EfsFileLocation' => [
                        'FileSystemId' => '<string>',
                        'Path' => '<string>',
                    ],
                    'S3FileLocation' => [
                        'Bucket' => '<string>',
                        'Key' => '<string>',
                    ],
                ],
                'Name' => '<string>',
                'OverwriteExisting' => 'TRUE|FALSE',
            ],
            'CustomStepDetails' => [
                'Name' => '<string>',
                'Target' => '<string>',
                'TimeoutSeconds' => <integer>,
            ],
            'DeleteStepDetails' => [
                'Name' => '<string>',
            ],
            'TagStepDetails' => [
                'Name' => '<string>',
                'Tags' => [
                    [
                        'Key' => '<string>', // REQUIRED
                        'Value' => '<string>', // REQUIRED
                    ],
                    // ...
                ],
            ],
            'Type' => 'COPY|CUSTOM|TAG|DELETE',
        ],
        // ...
    ],
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Members

Description

Type: string

A textual description for the workflow.

OnExceptionSteps

Type: Array of WorkflowStep structures

Specifies the steps (actions) to take if errors are encountered during execution of the workflow.

For custom steps, the lambda function needs to send FAILURE to the call back API to kick off the exception steps. Additionally, if the lambda does not send SUCCESS before it times out, the exception steps are executed.

Steps

Required: Yes
Type: Array of WorkflowStep structures

Specifies the details for the steps that are in the specified workflow.

The TYPE specifies which of the following actions is being taken for this step.

Copy: copy the file to another location
Custom: custom step with a lambda target
Delete: delete the file
Tag: add a tag to the file

Currently, copying and tagging are supported only on S3.

For file location, you specify either the S3 bucket and key, or the EFS filesystem ID and path.

Tags

Type: Array of Tag structures

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

Result Syntax

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

Result Details

Members

WorkflowId

Required: Yes
Type: string

A unique identifier for the workflow.

Errors

AccessDeniedException:
You do not have sufficient access to perform this action.
ServiceUnavailableException:
The request has failed because the Amazon Web ServicesTransfer Family service is not available.
InternalServiceError:
This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family service.
InvalidRequestException:
This exception is thrown when the client submits a malformed request.
ResourceExistsException:
The requested resource does not exist.
ThrottlingException:
The request was denied due to request throttling.

HTTP Status Code: 400

DeleteAccess

$result = $client->deleteAccess([/* ... */]);
$promise = $client->deleteAccessAsync([/* ... */]);

Allows you to delete the access specified in the ServerID and ExternalID parameters.

Parameter Syntax

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

Parameter Details

Members

ExternalId

Required: Yes
Type: string

Get-ADGroup -Filter {samAccountName -like "YourGroupName*"} -Properties * | Select SamAccountName,ObjectSid

In that command, replace YourGroupName with the name of your Active Directory group.

ServerId

Required: Yes
Type: string

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

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ServiceUnavailableException:
The request has failed because the Amazon Web ServicesTransfer Family service is not available.
InternalServiceError:
This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family service.
InvalidRequestException:
This exception is thrown when the client submits a malformed request.
ResourceNotFoundException:
This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer 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

ServerId

Required: Yes
Type: string

A unique system-assigned identifier for a server instance.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

AccessDeniedException:
You do not have sufficient access to perform this action.
ServiceUnavailableException:
The request has failed because the Amazon Web ServicesTransfer Family service is not available.
InternalServiceError:
This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family service.
InvalidRequestException:
This exception is thrown when the client submits a malformed request.
ResourceNotFoundException:
This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.

DeleteSshPublicKey

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

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

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

The results for this operation are always empty.

Errors

ServiceUnavailableException:
The request has failed because the Amazon Web ServicesTransfer Family service is not available.
InternalServiceError:
This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family service.
InvalidRequestException:
This exception is thrown when the client submits a malformed request.
ResourceNotFoundException:
This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.
ThrottlingException:
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

ServerId

Required: Yes
Type: string

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

UserName

Required: Yes
Type: string

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

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ServiceUnavailableException:
The request has failed because the Amazon Web ServicesTransfer Family service is not available.
InternalServiceError:
This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family service.
InvalidRequestException:
This exception is thrown when the client submits a malformed request.
ResourceNotFoundException:
This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.

DeleteWorkflow

$result = $client->deleteWorkflow([/* ... */]);
$promise = $client->deleteWorkflowAsync([/* ... */]);

Deletes the specified workflow.

Parameter Syntax

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

Parameter Details

Members

WorkflowId

Required: Yes
Type: string

A unique identifier for the workflow.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

AccessDeniedException:
You do not have sufficient access to perform this action.
ServiceUnavailableException:
The request has failed because the Amazon Web ServicesTransfer Family service is not available.
InternalServiceError:
This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family service.
InvalidRequestException:
This exception is thrown when the client submits a malformed request.
ResourceNotFoundException:
This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.

DescribeAccess

$result = $client->describeAccess([/* ... */]);
$promise = $client->describeAccessAsync([/* ... */]);

Describes the access that is assigned to the specific file transfer protocol-enabled server, as identified by its ServerId property and its ExternalID.

The response from this call returns the properties of the access that is associated with the ServerId value that was specified.

Parameter Syntax

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

Parameter Details

Members

ExternalId

Required: Yes
Type: string

Get-ADGroup -Filter {samAccountName -like "YourGroupName*"} -Properties * | Select SamAccountName,ObjectSid

In that command, replace YourGroupName with the name of your Active Directory group.

ServerId

Required: Yes
Type: string

A system-assigned unique identifier for a server that has this access assigned.

Result Syntax

[
    'Access' => [
        'ExternalId' => '<string>',
        'HomeDirectory' => '<string>',
        'HomeDirectoryMappings' => [
            [
                'Entry' => '<string>',
                'Target' => '<string>',
            ],
            // ...
        ],
        'HomeDirectoryType' => 'PATH|LOGICAL',
        'Policy' => '<string>',
        'PosixProfile' => [
            'Gid' => <integer>,
            'SecondaryGids' => [<integer>, ...],
            'Uid' => <integer>,
        ],
        'Role' => '<string>',
    ],
    'ServerId' => '<string>',
]

Result Details

Members

Access

Required: Yes
Type: DescribedAccess structure

The external ID of the server that the access is attached to.

ServerId

Required: Yes
Type: string

A system-assigned unique identifier for a server that has this access assigned.

Errors

ServiceUnavailableException:
The request has failed because the Amazon Web ServicesTransfer Family service is not available.
InternalServiceError:
This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family service.
InvalidRequestException:
This exception is thrown when the client submits a malformed request.
ResourceNotFoundException:
This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.

DescribeExecution

$result = $client->describeExecution([/* ... */]);
$promise = $client->describeExecutionAsync([/* ... */]);

You can use DescribeExecution to check the details of the execution of the specified workflow.

Parameter Syntax

$result = $client->describeExecution([
    'ExecutionId' => '<string>', // REQUIRED
    'WorkflowId' => '<string>', // REQUIRED
]);

Parameter Details

Members

ExecutionId

Required: Yes
Type: string

A unique identifier for the execution of a workflow.

WorkflowId

Required: Yes
Type: string

A unique identifier for the workflow.

Result Syntax

[
    'Execution' => [
        'ExecutionId' => '<string>',
        'ExecutionRole' => '<string>',
        'InitialFileLocation' => [
            'EfsFileLocation' => [
                'FileSystemId' => '<string>',
                'Path' => '<string>',
            ],
            'S3FileLocation' => [
                'Bucket' => '<string>',
                'Etag' => '<string>',
                'Key' => '<string>',
                'VersionId' => '<string>',
            ],
        ],
        'LoggingConfiguration' => [
            'LogGroupName' => '<string>',
            'LoggingRole' => '<string>',
        ],
        'PosixProfile' => [
            'Gid' => <integer>,
            'SecondaryGids' => [<integer>, ...],
            'Uid' => <integer>,
        ],
        'Results' => [
            'OnExceptionSteps' => [
                [
                    'Error' => [
                        'Message' => '<string>',
                        'Type' => 'PERMISSION_DENIED',
                    ],
                    'Outputs' => '<string>',
                    'StepType' => 'COPY|CUSTOM|TAG|DELETE',
                ],
                // ...
            ],
            'Steps' => [
                [
                    'Error' => [
                        'Message' => '<string>',
                        'Type' => 'PERMISSION_DENIED',
                    ],
                    'Outputs' => '<string>',
                    'StepType' => 'COPY|CUSTOM|TAG|DELETE',
                ],
                // ...
            ],
        ],
        'ServiceMetadata' => [
            'UserDetails' => [
                'ServerId' => '<string>',
                'SessionId' => '<string>',
                'UserName' => '<string>',
            ],
        ],
        'Status' => 'IN_PROGRESS|COMPLETED|EXCEPTION|HANDLING_EXCEPTION',
    ],
    'WorkflowId' => '<string>',
]

Result Details

Members

Execution

Required: Yes
Type: DescribedExecution structure

The structure that contains the details of the workflow' execution.

WorkflowId

Required: Yes
Type: string

A unique identifier for the workflow.

Errors

ServiceUnavailableException:
The request has failed because the Amazon Web ServicesTransfer Family service is not available.
InternalServiceError:
This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family service.
InvalidRequestException:
This exception is thrown when the client submits a malformed request.
ResourceNotFoundException:
This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer 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

SecurityPolicyName

Required: Yes
Type: string

Specifies the name of the security policy that is attached to the server.

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

ServiceUnavailableException:
The request has failed because the Amazon Web ServicesTransfer Family service is not available.
InternalServiceError:
This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family service.
InvalidRequestException:
This exception is thrown when the client submits a malformed request.
ResourceNotFoundException:
This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer 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

Members

ServerId

Required: Yes
Type: string

A system-assigned unique identifier for a server.

Result Syntax

[
    'Server' => [
        'Arn' => '<string>',
        'Certificate' => '<string>',
        'Domain' => 'S3|EFS',
        'EndpointDetails' => [
            'AddressAllocationIds' => ['<string>', ...],
            'SecurityGroupIds' => ['<string>', ...],
            'SubnetIds' => ['<string>', ...],
            'VpcEndpointId' => '<string>',
            'VpcId' => '<string>',
        ],
        'EndpointType' => 'PUBLIC|VPC|VPC_ENDPOINT',
        'HostKeyFingerprint' => '<string>',
        'IdentityProviderDetails' => [
            'DirectoryId' => '<string>',
            'InvocationRole' => '<string>',
            'Url' => '<string>',
        ],
        'IdentityProviderType' => 'SERVICE_MANAGED|API_GATEWAY|AWS_DIRECTORY_SERVICE',
        'LoggingRole' => '<string>',
        'ProtocolDetails' => [
            'PassiveIp' => '<string>',
        ],
        'Protocols' => ['<string>', ...],
        'SecurityPolicyName' => '<string>',
        'ServerId' => '<string>',
        'State' => 'OFFLINE|ONLINE|STARTING|STOPPING|START_FAILED|STOP_FAILED',
        'Tags' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
        'UserCount' => <integer>,
        'WorkflowDetails' => [
            'OnUpload' => [
                [
                    'ExecutionRole' => '<string>',
                    'WorkflowId' => '<string>',
                ],
                // ...
            ],
        ],
    ],
]

Result Details

Members

Server

Required: Yes
Type: DescribedServer structure

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

Errors

ServiceUnavailableException:
The request has failed because the Amazon Web ServicesTransfer Family service is not available.
InternalServiceError:
This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family service.
InvalidRequestException:
This exception is thrown when the client submits a malformed request.
ResourceNotFoundException:
This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer 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 Amazon Web Services 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>',
        'PosixProfile' => [
            'Gid' => <integer>,
            'SecondaryGids' => [<integer>, ...],
            'Uid' => <integer>,
        ],
        '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 ServerID value that you specified.

Errors

ServiceUnavailableException:
The request has failed because the Amazon Web ServicesTransfer Family service is not available.
InternalServiceError:
This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family service.
InvalidRequestException:
This exception is thrown when the client submits a malformed request.
ResourceNotFoundException:
This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.

DescribeWorkflow

$result = $client->describeWorkflow([/* ... */]);
$promise = $client->describeWorkflowAsync([/* ... */]);

Describes the specified workflow.

Parameter Syntax

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

Parameter Details

Members

WorkflowId

Required: Yes
Type: string

A unique identifier for the workflow.

Result Syntax

[
    'Workflow' => [
        'Arn' => '<string>',
        'Description' => '<string>',
        'OnExceptionSteps' => [
            [
                'CopyStepDetails' => [
                    'DestinationFileLocation' => [
                        'EfsFileLocation' => [
                            'FileSystemId' => '<string>',
                            'Path' => '<string>',
                        ],
                        'S3FileLocation' => [
                            'Bucket' => '<string>',
                            'Key' => '<string>',
                        ],
                    ],
                    'Name' => '<string>',
                    'OverwriteExisting' => 'TRUE|FALSE',
                ],
                'CustomStepDetails' => [
                    'Name' => '<string>',
                    'Target' => '<string>',
                    'TimeoutSeconds' => <integer>,
                ],
                'DeleteStepDetails' => [
                    'Name' => '<string>',
                ],
                'TagStepDetails' => [
                    'Name' => '<string>',
                    'Tags' => [
                        [
                            'Key' => '<string>',
                            'Value' => '<string>',
                        ],
                        // ...
                    ],
                ],
                'Type' => 'COPY|CUSTOM|TAG|DELETE',
            ],
            // ...
        ],
        'Steps' => [
            [
                'CopyStepDetails' => [
                    'DestinationFileLocation' => [
                        'EfsFileLocation' => [
                            'FileSystemId' => '<string>',
                            'Path' => '<string>',
                        ],
                        'S3FileLocation' => [
                            'Bucket' => '<string>',
                            'Key' => '<string>',
                        ],
                    ],
                    'Name' => '<string>',
                    'OverwriteExisting' => 'TRUE|FALSE',
                ],
                'CustomStepDetails' => [
                    'Name' => '<string>',
                    'Target' => '<string>',
                    'TimeoutSeconds' => <integer>,
                ],
                'DeleteStepDetails' => [
                    'Name' => '<string>',
                ],
                'TagStepDetails' => [
                    'Name' => '<string>',
                    'Tags' => [
                        [
                            'Key' => '<string>',
                            'Value' => '<string>',
                        ],
                        // ...
                    ],
                ],
                'Type' => 'COPY|CUSTOM|TAG|DELETE',
            ],
            // ...
        ],
        'Tags' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
        'WorkflowId' => '<string>',
    ],
]

Result Details

Members

Workflow

Required: Yes
Type: DescribedWorkflow structure

The structure that contains the details of the workflow.

Errors

ServiceUnavailableException:
The request has failed because the Amazon Web ServicesTransfer Family service is not available.
InternalServiceError:
This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family service.
InvalidRequestException:
This exception is thrown when the client submits a malformed request.
ResourceNotFoundException:
This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer 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

ServerId

Required: Yes
Type: string

A system-assigned unique identifier for a server.

SshPublicKeyBody

Required: Yes
Type: string

The public key portion of an SSH key pair.

UserName

Required: Yes
Type: string

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

Result Syntax

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

Result Details

Members

ServerId

Required: Yes
Type: string

A system-assigned unique identifier for a server.

SshPublicKeyId

Required: Yes
Type: string

The name given to a public key by the system that was imported.

UserName

Required: Yes
Type: string

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

Errors

ServiceUnavailableException:
The request has failed because the Amazon Web ServicesTransfer Family service is not available.
InternalServiceError:
This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family service.
InvalidRequestException:
This exception is thrown when the client submits a malformed request.
ResourceExistsException:
The requested resource does not exist.
ResourceNotFoundException:
This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.
ThrottlingException:
The request was denied due to request throttling.

HTTP Status Code: 400

ListAccesses

$result = $client->listAccesses([/* ... */]);
$promise = $client->listAccessesAsync([/* ... */]);

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

Parameter Syntax

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

Parameter Details

Members

MaxResults

Type: int

Specifies the maximum number of access SIDs to return.

NextToken

Type: string

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

ServerId

Required: Yes
Type: string

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

Result Syntax

[
    'Accesses' => [
        [
            'ExternalId' => '<string>',
            'HomeDirectory' => '<string>',
            'HomeDirectoryType' => 'PATH|LOGICAL',
            'Role' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
    'ServerId' => '<string>',
]

Result Details

Members

Accesses

Required: Yes
Type: Array of ListedAccess structures

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

NextToken

Type: string

ServerId

Required: Yes
Type: string

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

Errors

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

ListExecutions

$result = $client->listExecutions([/* ... */]);
$promise = $client->listExecutionsAsync([/* ... */]);

Lists all executions for the specified workflow.

Parameter Syntax

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

Parameter Details

Members

MaxResults

Type: int

Specifies the aximum number of executions to return.

NextToken

Type: string

ListExecutions returns the NextToken parameter in the output. You can then pass the NextToken parameter in a subsequent command to continue listing additional executions.

This is useful for pagination, for instance. If you have 100 executions for a workflow, you might only want to list first 10. If so, callthe API by specifing the max-results:

aws transfer list-executions --max-results 10

This returns details for the first 10 executions, as well as the pointer (NextToken) to the eleventh execution. You can now call the API again, suppling the NextToken value you received:

aws transfer list-executions --max-results 10 --next-token $somePointerReturnedFromPreviousListResult

This call returns the next 10 executions, the 11th through the 20th. You can then repeat the call until the details for all 100 executions have been returned.

WorkflowId

Required: Yes
Type: string

A unique identifier for the workflow.

Result Syntax

[
    'Executions' => [
        [
            'ExecutionId' => '<string>',
            'InitialFileLocation' => [
                'EfsFileLocation' => [
                    'FileSystemId' => '<string>',
                    'Path' => '<string>',
                ],
                'S3FileLocation' => [
                    'Bucket' => '<string>',
                    'Etag' => '<string>',
                    'Key' => '<string>',
                    'VersionId' => '<string>',
                ],
            ],
            'ServiceMetadata' => [
                'UserDetails' => [
                    'ServerId' => '<string>',
                    'SessionId' => '<string>',
                    'UserName' => '<string>',
                ],
            ],
            'Status' => 'IN_PROGRESS|COMPLETED|EXCEPTION|HANDLING_EXCEPTION',
        ],
        // ...
    ],
    'NextToken' => '<string>',
    'WorkflowId' => '<string>',
]

Result Details

Members

Executions

Required: Yes
Type: Array of ListedExecution structures

Returns the details for each execution.

NextToken: returned from a call to several APIs, you can use pass it to a subsequent command to continue listing additional executions.
StartTime: timestamp indicating when the execution began.
Executions: details of the execution, including the execution ID, initial file location, and Service metadata.
Status: one of the following values: IN_PROGRESS, COMPLETED, EXCEPTION, HANDLING_EXEPTION.

NextToken

Type: string

ListExecutions returns the NextToken parameter in the output. You can then pass the NextToken parameter in a subsequent command to continue listing additional executions.

WorkflowId

Required: Yes
Type: string

A unique identifier for the workflow.

Errors

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

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 ListSecurityPolicies query.

NextToken

Type: string

When additional results are obtained from the ListSecurityPolicies command, a NextToken parameter is returned in the output. You can then pass the NextToken parameter 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 ListSecurityPolicies operation, a NextToken parameter is returned in the output. In a following command, you can pass in the NextToken parameter to continue listing security policies.

SecurityPolicyNames

Required: Yes
Type: Array of strings

An array of security policies that were listed.

Errors

ServiceUnavailableException:
The request has failed because the Amazon Web ServicesTransfer Family service is not available.
InternalServiceError:
This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family service.
InvalidNextTokenException:
The NextToken parameter that was passed is invalid.
InvalidRequestException:
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 Amazon Web Services account.

Parameter Syntax

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

Parameter Details

Members

MaxResults

Type: int

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

NextToken

Type: string

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

Result Syntax

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

Result Details

Members

NextToken

Type: string

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

Servers

Required: Yes
Type: Array of ListedServer structures

An array of servers that were listed.

Errors

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

ListTagsForResource

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

Lists all of the tags associated with the Amazon Resource Name (ARN) that 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 Amazon Web Services resource, such as a server, user, or role.

MaxResults

Type: int

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

NextToken

Type: string

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

Result Syntax

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

Result Details

Members

Arn

Type: string

The ARN you specified to list the tags of.

NextToken

Type: string

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

Tags

Type: Array of Tag structures

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

Errors

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

ListUsers

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

Lists the users for 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 ListUsers request.

NextToken

Type: string

When you can get additional results from the ListUsers call, a NextToken parameter is returned in the output. You can then pass in a subsequent command to the NextToken parameter 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

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 ServerId value that you specify.

Errors

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

ListWorkflows

$result = $client->listWorkflows([/* ... */]);
$promise = $client->listWorkflowsAsync([/* ... */]);

Lists all of your workflows.

Parameter Syntax

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

Parameter Details

Members

MaxResults

Type: int

Specifies the maximum number of workflows to return.

NextToken

Type: string

ListWorkflows returns the NextToken parameter in the output. You can then pass the NextToken parameter in a subsequent command to continue listing additional workflows.

Result Syntax

[
    'NextToken' => '<string>',
    'Workflows' => [
        [
            'Arn' => '<string>',
            'Description' => '<string>',
            'WorkflowId' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members

NextToken

Type: string

ListWorkflows returns the NextToken parameter in the output. You can then pass the NextToken parameter in a subsequent command to continue listing additional workflows.

Workflows

Required: Yes
Type: Array of ListedWorkflow structures

Returns the Arn, WorkflowId, and Description for each workflow.

Errors

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

SendWorkflowStepState

$result = $client->sendWorkflowStepState([/* ... */]);
$promise = $client->sendWorkflowStepStateAsync([/* ... */]);

Sends a callback for asynchronous custom steps.

The ExecutionId, WorkflowId, and Token are passed to the target resource during execution of a custom step of a workflow. You must include those with their callback as well as providing a status.

Parameter Syntax

$result = $client->sendWorkflowStepState([
    'ExecutionId' => '<string>', // REQUIRED
    'Status' => 'SUCCESS|FAILURE', // REQUIRED
    'Token' => '<string>', // REQUIRED
    'WorkflowId' => '<string>', // REQUIRED
]);

Parameter Details

Members

ExecutionId

Required: Yes
Type: string

A unique identifier for the execution of a workflow.

Status

Required: Yes
Type: string

Indicates whether the specified step succeeded or failed.

Token

Required: Yes
Type: string

Used to distinguish between multiple callbacks for multiple Lambda steps within the same execution.

WorkflowId

Required: Yes
Type: string

A unique identifier for the workflow.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

AccessDeniedException:
You do not have sufficient access to perform this action.
ServiceUnavailableException:
The request has failed because the Amazon Web ServicesTransfer Family service is not available.
InternalServiceError:
This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family service.
InvalidRequestException:
This exception is thrown when the client submits a malformed request.
ResourceNotFoundException:
This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.
ThrottlingException:
The request was denied due to request throttling.

HTTP Status Code: 400

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

ServerId

Required: Yes
Type: string

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

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ServiceUnavailableException:
The request has failed because the Amazon Web ServicesTransfer Family service is not available.
InternalServiceError:
This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family service.
InvalidRequestException:
This exception is thrown when the client submits a malformed request.
ResourceNotFoundException:
This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.
ThrottlingException:
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

ServerId

Required: Yes
Type: string

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

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ServiceUnavailableException:
The request has failed because the Amazon Web ServicesTransfer Family service is not available.
InternalServiceError:
This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family service.
InvalidRequestException:
This exception is thrown when the client submits a malformed request.
ResourceNotFoundException:
This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.
ThrottlingException:
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 Amazon Web Services resource, such as a server, user, or role.

Tags

Required: Yes
Type: Array of Tag structures

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

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ServiceUnavailableException:
The request has failed because the Amazon Web ServicesTransfer Family service is not available.
InternalServiceError:
This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family service.
InvalidRequestException:
This exception is thrown when the client submits a malformed request.
ResourceNotFoundException:
This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.

TestIdentityProvider

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

If the IdentityProviderType of a file transfer protocol-enabled server is AWS_DIRECTORY_SERVICE or API_Gateway, tests whether your identity provider 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 identity provider integration to ensure that your users can successfully use the service.

The ServerId and UserName parameters are required. The ServerProtocol, SourceIp, and UserPassword are all optional.

You cannot use TestIdentityProvider if the IdentityProviderType of your server is SERVICE_MANAGED.

If you provide any incorrect values for any parameters, the Response field is empty.
If you provide a server ID for a server that uses service-managed users, you get an error:

An error occurred (InvalidRequestException) when calling the TestIdentityProvider operation: s-server-ID not configured for external auth
If you enter a Server ID for the --server-id parameter that does not identify an actual Transfer server, you receive the following error:

An error occurred (ResourceNotFoundException) when calling the TestIdentityProvider operation: Unknown server

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

ServiceUnavailableException:
The request has failed because the Amazon Web ServicesTransfer Family service is not available.
InternalServiceError:
This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family service.
InvalidRequestException:
This exception is thrown when the client submits a malformed request.
ResourceNotFoundException:
This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer 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 Amazon Web Services resource, such as a server, user, or role.

TagKeys

Required: Yes
Type: Array of strings

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

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ServiceUnavailableException:
The request has failed because the Amazon Web ServicesTransfer Family service is not available.
InternalServiceError:
This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family service.
InvalidRequestException:
This exception is thrown when the client submits a malformed request.
ResourceNotFoundException:
This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.

UpdateAccess

$result = $client->updateAccess([/* ... */]);
$promise = $client->updateAccessAsync([/* ... */]);

Allows you to update parameters for the access specified in the ServerID and ExternalID parameters.

Parameter Syntax

$result = $client->updateAccess([
    'ExternalId' => '<string>', // REQUIRED
    'HomeDirectory' => '<string>',
    'HomeDirectoryMappings' => [
        [
            'Entry' => '<string>', // REQUIRED
            'Target' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'HomeDirectoryType' => 'PATH|LOGICAL',
    'Policy' => '<string>',
    'PosixProfile' => [
        'Gid' => <integer>, // REQUIRED
        'SecondaryGids' => [<integer>, ...],
        'Uid' => <integer>, // REQUIRED
    ],
    'Role' => '<string>',
    'ServerId' => '<string>', // REQUIRED
]);

Parameter Details

Members

ExternalId

Required: Yes
Type: string

Get-ADGroup -Filter {samAccountName -like "YourGroupName*"} -Properties * | Select SamAccountName,ObjectSid

In that command, replace YourGroupName with the name of your Active Directory group.

HomeDirectory

Type: string

The landing directory (folder) for a user when they log in to the server using the client.

A HomeDirectory example is /bucket_name/home/mydirectory.

HomeDirectoryMappings

Type: Array of HomeDirectoryMapEntry structures

The following is an Entry and Target pair example.

[ { "Entry": "/directory1", "Target": "/bucket_name/home/mydirectory" } ]

The following is an Entry and Target pair example for chroot.

[ { "Entry:": "/", "Target": "/bucket_name/home/mydirectory" } ]

HomeDirectoryType

Type: string

Policy

Type: string

This only applies when the domain of ServerId is S3. EFS does not use session policies.

For an example of a session policy, see Example session policy.

For more information, see AssumeRole in the Amazon Web ServicesSecurity Token Service API Reference.

PosixProfile

Type: PosixProfile structure

Role

Type: string

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.

Result Syntax

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

Result Details

Members

ExternalId

Required: Yes
Type: string

The external ID of the group whose users have access to your Amazon S3 or Amazon EFS resources over the enabled protocols using Amazon Web ServicesTransfer Family.

ServerId

Required: Yes
Type: string

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

Errors

ServiceUnavailableException:
The request has failed because the Amazon Web ServicesTransfer Family service is not available.
InternalServiceError:
This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family service.
InvalidRequestException:
This exception is thrown when the client submits a malformed request.
ResourceExistsException:
The requested resource does not exist.
ResourceNotFoundException:
This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer 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' => [
        'DirectoryId' => '<string>',
        'InvocationRole' => '<string>',
        'Url' => '<string>',
    ],
    'LoggingRole' => '<string>',
    'ProtocolDetails' => [
        'PassiveIp' => '<string>',
    ],
    'Protocols' => ['<string>', ...],
    'SecurityPolicyName' => '<string>',
    'ServerId' => '<string>', // REQUIRED
    'WorkflowDetails' => [
        'OnUpload' => [ // REQUIRED
            [
                'ExecutionRole' => '<string>', // REQUIRED
                'WorkflowId' => '<string>', // REQUIRED
            ],
            // ...
        ],
    ],
]);

Parameter Details

Members

Certificate

Type: string

The Amazon Resource Name (ARN) of the Amazon Web ServicesCertificate Manager (ACM) certificate. Required when Protocols is set to FTPS.

To request a new public certificate, see Request a public certificate in the Amazon Web ServicesCertificate Manager User Guide.

To import an existing certificate into ACM, see Importing certificates into ACM in the Amazon Web ServicesCertificate Manager User Guide.

To request a private certificate to use FTPS through private IP addresses, see Request a private certificate in the Amazon Web ServicesCertificate 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

EndpointType

Type: string

After May 19, 2021, you won't be able to create a server using EndpointType=VPC_ENDPOINT in your Amazon Web Servicesaccount if your account hasn't already done so before May 19, 2021. If you have already created servers with EndpointType=VPC_ENDPOINT in your Amazon Web Servicesaccount on or before May 19, 2021, you will not be affected. After this date, use EndpointType=VPC.

For more information, see https://docs.aws.amazon.com/transfer/latest/userguide/create-server-in-vpc.html#deprecate-vpc-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 Amazon Web ServicesTransfer 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

ProtocolDetails

Type: ProtocolDetails structure

The protocol settings that are configured for your server.

Use the PassiveIp parameter to indicate passive mode (for FTP and FTPS protocols). Enter a single dotted-quad IPv4 address, such as the external IP address of a firewall, router, or load balancer.

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 Amazon Web ServicesCertificate Manager (ACM) which will be used to identify your server when clients connect to it over FTPS.

If Protocol includes either FTP or FTPS, then the EndpointType must be VPC and the IdentityProviderType must be AWS_DIRECTORY_SERVICE or API_GATEWAY.

If Protocol includes FTP, then AddressAllocationIds cannot be associated.

If Protocol is set only to SFTP, the EndpointType can be set to PUBLIC and the IdentityProviderType can be set to SERVICE_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.

WorkflowDetails

Type: WorkflowDetails structure

Specifies the workflow ID for the workflow to assign and the execution role used for executing the workflow.

Result Syntax

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

Result Details

Members

ServerId

Required: Yes
Type: string

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

Errors

AccessDeniedException:
You do not have sufficient access to perform this action.
ServiceUnavailableException:
The request has failed because the Amazon Web ServicesTransfer Family service is not available.
ConflictException:
This exception is thrown when the UpdateServer 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.
InternalServiceError:
This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family service.
InvalidRequestException:
This exception is thrown when the client submits a malformed request.
ResourceExistsException:
The requested resource does not exist.
ResourceNotFoundException:
This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.
ThrottlingException:
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>',
    'PosixProfile' => [
        'Gid' => <integer>, // REQUIRED
        'SecondaryGids' => [<integer>, ...],
        'Uid' => <integer>, // REQUIRED
    ],
    'Role' => '<string>',
    'ServerId' => '<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.

A HomeDirectory example is /bucket_name/home/mydirectory.

HomeDirectoryMappings

Type: Array of HomeDirectoryMapEntry structures

The following is an Entry and Target pair example.

[ { "Entry": "/directory1", "Target": "/bucket_name/home/mydirectory" } ]

In most cases, you can use this value instead of the session policy to lock down your user to the designated home directory ("chroot"). To do this, you can set Entry to '/' and set Target to the HomeDirectory parameter value.

The following is an Entry and Target pair example for chroot.

[ { "Entry:": "/", "Target": "/bucket_name/home/mydirectory" } ]

HomeDirectoryType

Type: string

Policy

Type: string

This only applies when the domain of ServerId is S3. EFS does not use session policies.

For an example of a session policy, see Creating a session policy.

For more information, see AssumeRole in the Amazon Web Services Security Token Service API Reference.

PosixProfile

Type: PosixProfile structure

Specifies the full POSIX identity, including user ID (Uid), group ID (Gid), and any secondary groups IDs (SecondaryGids), that controls your users' access to your Amazon Elastic File Systems (Amazon EFS). The POSIX permissions that are set on files and directories in your file system determines the level of access your users get when transferring files into and out of your Amazon EFS file systems.

Role

Type: string

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

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

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

Errors

ServiceUnavailableException:
The request has failed because the Amazon Web ServicesTransfer Family service is not available.
InternalServiceError:
This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family service.
InvalidRequestException:
This exception is thrown when the client submits a malformed request.
ResourceNotFoundException:
This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.
ThrottlingException:
The request was denied due to request throttling.

HTTP Status Code: 400

Shapes

AccessDeniedException

Description

You do not have sufficient access to perform this action.

Members

Message

Type: string

ConflictException

Description

This exception is thrown when the UpdateServer 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

Message

Required: Yes
Type: string

CopyStepDetails

Description

Each step type has its own StepDetails structure.

Members

DestinationFileLocation

Type: InputFileLocation structure

Specifies the location for the file being copied. Only applicable for the Copy type of workflow steps.

Name

Type: string

The name of the step, used as an identifier.

OverwriteExisting

Type: string

A flag that indicates whether or not to overwrite an existing file of the same name. The default is FALSE.

CustomStepDetails

Description

Each step type has its own StepDetails structure.

Members

Name

Type: string

The name of the step, used as an identifier.

Target

Type: string

The ARN for the lambda function that is being called.

TimeoutSeconds

Type: int

Timeout, in seconds, for the step.

DeleteStepDetails

Description

The name of the step, used to identify the delete step.

Members

Name

Type: string

The name of the step, used as an identifier.

DescribedAccess

Description

Describes the properties of the access that was specified.

Members

ExternalId

Type: string

Get-ADGroup -Filter {samAccountName -like "YourGroupName*"} -Properties * | Select SamAccountName,ObjectSid

In that command, replace YourGroupName with the name of your Active Directory group.

HomeDirectory

Type: string

The landing directory (folder) for a user when they log in to the server using the client.

A HomeDirectory example is /bucket_name/home/mydirectory.

HomeDirectoryMappings

Type: Array of HomeDirectoryMapEntry structures

In most cases, you can use this value instead of the session policy to lock down the associated access to the designated home directory ("chroot"). To do this, you can set Entry to '/' and set Target to the HomeDirectory parameter value.

HomeDirectoryType

Type: string

Policy

Type: string

PosixProfile

Type: PosixProfile structure

Role

Type: string

DescribedExecution

Description

The details for an execution object.

Members

ExecutionId

Type: string

A unique identifier for the execution of a workflow.

ExecutionRole

Type: string

The IAM role associated with the execution.

InitialFileLocation

Type: FileLocation structure

A structure that describes the Amazon S3 or EFS file location. This is the file location when the execution begins: if the file is being copied, this is the initial (as opposed to destination) file location.

LoggingConfiguration

Type: LoggingConfiguration structure

The IAM logging role associated with the execution.

PosixProfile

Type: PosixProfile structure

Results

Type: ExecutionResults structure

A structure that describes the execution results. This includes a list of the steps along with the details of each step, error type and message (if any), and the OnExceptionSteps structure.

ServiceMetadata

Type: ServiceMetadata structure

A container object for the session details associated with a workflow.

Status

Type: string

The status is one of the execution. Can be in progress, completed, exception encountered, or handling the exception.

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 Amazon Web ServicesCertificate Manager (ACM) certificate. Required when Protocols is set to FTPS.

Domain

Type: string

Specifies the domain of the storage system that is used for file transfers.

EndpointDetails

Type: EndpointDetails structure

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-key command.

IdentityProviderDetails

Type: IdentityProviderDetails structure

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

IdentityProviderType

Type: string

LoggingRole

Type: string

ProtocolDetails

Type: ProtocolDetails structure

The protocol settings that are configured for your server.

Use the PassiveIp parameter to indicate passive mode. Enter a single dotted-quad IPv4 address, such as the external IP address of a firewall, router, or load balancer.

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 ONLINE indicates that the server can accept jobs and transfer files. A State value of OFFLINE means that the server cannot perform file transfer operations.

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

Tags

Type: Array of Tag structures

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.

WorkflowDetails

Type: WorkflowDetails structure

Specifies the workflow ID for the workflow to assign and the execution role used for executing the workflow.

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

The landing directory (folder) for a user when they log in to the server using the client.

A HomeDirectory example is /bucket_name/home/mydirectory.

HomeDirectoryMappings

Type: Array of HomeDirectoryMapEntry structures

In most cases, you can use this value instead of the session policy to lock your user down to the designated home directory ("chroot"). To do this, you can set Entry to '/' and set Target to the HomeDirectory parameter value.

HomeDirectoryType

Type: string

Policy

Type: string

PosixProfile

Type: PosixProfile structure

Specifies the full POSIX identity, including user ID (Uid), group ID (Gid), and any secondary groups IDs (SecondaryGids), that controls your users' access to your Amazon Elastic File System (Amazon EFS) file systems. The POSIX permissions that are set on files and directories in your file system determine the level of access your users get when transferring files into and out of your Amazon EFS file systems.

Role

Type: string

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.

DescribedWorkflow

Description

Describes the properties of the specified workflow

Members

Arn

Required: Yes
Type: string

Specifies the unique Amazon Resource Name (ARN) for the workflow.

Description

Type: string

Specifies the text description for the workflow.

OnExceptionSteps

Type: Array of WorkflowStep structures

Specifies the steps (actions) to take if errors are encountered during execution of the workflow.

Steps

Type: Array of WorkflowStep structures

Specifies the details for the steps that are in the specified workflow.

Tags

Type: Array of Tag structures

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

WorkflowId

Type: string

A unique identifier for the workflow.

EfsFileLocation

Description

Reserved for future use.

Members

FileSystemId

Type: string

The ID of the file system, assigned by Amazon EFS.

Path

Type: string

The pathname for the folder being used by a workflow.

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 address to your server's endpoint.

After May 19, 2021, you won't be able to create a server using EndpointType=VPC_ENDPOINT in your Amazon Web Servicesaccount if your account hasn't already done so before May 19, 2021. If you have already created servers with EndpointType=VPC_ENDPOINT in your Amazon Web Servicesaccount on or before May 19, 2021, you will not be affected. After this date, use EndpointType=VPC.

For more information, see https://docs.aws.amazon.com/transfer/latest/userguide/create-server-in-vpc.html#deprecate-vpc-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 EndpointType is set to VPC and it is only valid in the UpdateServer API.

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 EndpointType is set to VPC.

You can edit the SecurityGroupIds property in the UpdateServer API only if you are changing the EndpointType from PUBLIC or VPC_ENDPOINT to VPC. To change security groups associated with your server's VPC endpoint after creation, use the Amazon EC2 ModifyVpcEndpoint API.

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 EndpointType is set to VPC.

VpcEndpointId

Type: string

The ID of the VPC endpoint.

This property can only be set when EndpointType is set to VPC_ENDPOINT.

For more information, see https://docs.aws.amazon.com/transfer/latest/userguide/create-server-in-vpc.html#deprecate-vpc-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 EndpointType is set to VPC.

ExecutionError

Description

Specifies the error message and type, for an error that occurs during the execution of the workflow.

Members

Message

Required: Yes
Type: string

Specifies the descriptive message that corresponds to the ErrorType.

Type

Required: Yes
Type: string

Specifies the error type: currently, the only valid value is PERMISSION_DENIED, which occurs if your policy does not contain the correct permissions to complete one or more of the steps in the workflow.

ExecutionResults

Description

Specifies the steps in the workflow, as well as the steps to execute in case of any errors during workflow execution.

Members

OnExceptionSteps

Type: Array of ExecutionStepResult structures

Specifies the steps (actions) to take if errors are encountered during execution of the workflow.

Steps

Type: Array of ExecutionStepResult structures

Specifies the details for the steps that are in the specified workflow.

ExecutionStepResult

Description

Specifies the following details for the step: error (if any), outputs (if any), and the step type.

Members

Error

Type: ExecutionError structure

Specifies the details for an error, if it occurred during execution of the specified workfow step.

Outputs

Type: string

The values for the key/value pair applied as a tag to the file. Only applicable if the step type is TAG.

StepType

Type: string

One of the available step types.

Copy: copy the file to another location
Custom: custom step with a lambda target
Delete: delete the file
Tag: add a tag to the file

FileLocation

Description

Specifies the Amazon S3 or EFS file details to be used in the step.

Members

EfsFileLocation

Type: EfsFileLocation structure

Specifies the Amazon EFS ID and the path for the file being used.

S3FileLocation

Type: S3FileLocation structure

Specifies the S3 details for the file being used, such as bucket, Etag, and so forth.

HomeDirectoryMapEntry

Description

Represents an object that contains entries and targets for HomeDirectoryMappings.

The following is an Entry and Target pair example for chroot.

[ { "Entry:": "/", "Target": "/bucket_name/home/mydirectory" } ]

Members

Entry

Required: Yes
Type: string

Represents an entry for HomeDirectoryMappings.

Target

Required: Yes
Type: string

Represents the map target that is used in a HomeDirectorymapEntry.

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

DirectoryId

Type: string

The identifier of the Amazon Web ServicesDirectory Service directory that you want to stop sharing.

InvocationRole

Type: string

Provides the type of InvocationRole used to authenticate the user account.

Url

Type: string

Provides the location of the service endpoint used to authenticate users.

InputFileLocation

Description

Specifies the location for the file being copied. Only applicable for the Copy type of workflow steps.

Members

EfsFileLocation

Type: EfsFileLocation structure

Reserved for future use.

S3FileLocation

Type: S3InputFileLocation structure

Specifies the details for the S3 file being copied.

InternalServiceError

Description

This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family service.

Members

Message

Required: Yes
Type: string

InvalidNextTokenException

Description

The NextToken parameter that was passed is invalid.

Members

Message

Required: Yes
Type: string

InvalidRequestException

Description

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

Members

Message

Required: Yes
Type: string

ListedAccess

Description

Lists the properties for one or more specified associated accesses.

Members

ExternalId

Type: string

Get-ADGroup -Filter {samAccountName -like "YourGroupName*"} -Properties * | Select SamAccountName,ObjectSid

In that command, replace YourGroupName with the name of your Active Directory group.

HomeDirectory

Type: string

The landing directory (folder) for a user when they log in to the server using the client.

A HomeDirectory example is /bucket_name/home/mydirectory.

HomeDirectoryType

Type: string

Role

Type: string

ListedExecution

Description

Returns properties of the execution that is specified.

Members

ExecutionId

Type: string

A unique identifier for the execution of a workflow.

InitialFileLocation

Type: FileLocation structure

ServiceMetadata

Type: ServiceMetadata structure

A container object for the session details associated with a workflow.

Status

Type: string

The status is one of the execution. Can be in progress, completed, exception encountered, or handling the exception.

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.

Domain

Type: string

Specifies the domain of the storage system that is used for file transfers.

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

LoggingRole

Type: string

ServerId

Type: string

Specifies the unique system assigned identifier for the servers that were listed.

State

Type: string

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

The landing directory (folder) for a user when they log in to the server using the client.

A HomeDirectory example is /bucket_name/home/mydirectory.

HomeDirectoryType

Type: string

Role

Type: string

The IAM role that controls your users' access to your Amazon S3 bucket for servers with Domain=S3, or your EFS file system for servers with Domain=EFS.

The policies attached to this role determine the level of access you want to provide your users when transferring files into and out of your S3 buckets or EFS file systems.

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.

ListedWorkflow

Description

Contains the ID, text description, and Amazon Resource Name (ARN) for the workflow.

Members

Arn

Type: string

Specifies the unique Amazon Resource Name (ARN) for the workflow.

Description

Type: string

Specifies the text description for the workflow.

WorkflowId

Type: string

A unique identifier for the workflow.

LoggingConfiguration

Description

Consists of the logging role and the log group name.

Members

LogGroupName

Type: string

The name of the CloudWatch logging group for the Amazon Web Services Transfer server to which this workflow belongs.

LoggingRole

Type: string

PosixProfile

Description

Members

Gid

Required: Yes
Type: long (int|float)

The POSIX group ID used for all EFS operations by this user.

SecondaryGids

Type: Array of long (int|float)s

The secondary POSIX group IDs used for all EFS operations by this user.

Uid

Required: Yes
Type: long (int|float)

The POSIX user ID used for all EFS operations by this user.

ProtocolDetails

Description

The protocol settings that are configured for your server.

This type is only valid in the UpdateServer API.

Members

PassiveIp

Type: string

Indicates passive mode, for FTP and FTPS protocols. Enter a single dotted-quad IPv4 address, such as the external IP address of a firewall, router, or load balancer. For example:

aws transfer update-server --protocol-details PassiveIp=0.0.0.0

Replace 0.0.0.0 in the example above with the actual IP address you want to use.

If you change the PassiveIp value, you must stop and then restart your Transfer server for the change to take effect. For details on using Passive IP (PASV) in a NAT environment, see Configuring your FTPS server behind a firewall or NAT with Amazon Web Services Transfer Family.

ResourceExistsException

Description

The requested resource does not exist.

Members

Message

Required: Yes
Type: string

Resource

Required: Yes
Type: string

ResourceType

Required: Yes
Type: string

ResourceNotFoundException

Description

This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.

Members

Message

Required: Yes
Type: string

Resource

Required: Yes
Type: string

ResourceType

Required: Yes
Type: string

S3FileLocation

Description

Specifies the details for the file location for the file being used in the workflow. Only applicable if you are using S3 storage.

Members

Bucket

Type: string

Specifies the S3 bucket that contains the file being used.

Etag

Type: string

The entity tag is a hash of the object. The ETag reflects changes only to the contents of an object, not its metadata.

Key

Type: string

The name assigned to the file when it was created in S3. You use the object key to retrieve the object.

VersionId

Type: string

Specifies the file version.

S3InputFileLocation

Description

Specifies the customer input S3 file location. If it is used inside copyStepDetails.DestinationFileLocation, it should be the S3 copy destination.

You need to provide the bucket and key. The key can represent either a path or a file. This is determined by whether or not you end the key value with the forward slash (/) character. If the final character is "/", then your file is copied to the folder, and its name does not change. If, rather, the final character is alphanumeric, your uploaded file is renamed to the path value. In this case, if a file with that name already exists, it is overwritten.

For example, if your path is shared-files/bob/, your uploaded files are copied to the shared-files/bob/, folder. If your path is shared-files/today, each uploaded file is copied to the shared-files folder and named today: each upload overwrites the previous version of the bob file.

Members

Bucket

Type: string

Specifies the S3 bucket for the customer input file.

Key

Type: string

The name assigned to the file when it was created in S3. You use the object key to retrieve the object.

S3Tag

Description

Specifies the key-value pair that are assigned to a file during the execution of a Tagging step.

Members

Key

Required: Yes
Type: string

The name assigned to the tag that you create.

Value

Required: Yes
Type: string

The value that corresponds to the key.

ServiceMetadata

Description

A container object for the session details associated with a workflow.

Members

UserDetails

Required: Yes
Type: UserDetails structure

The Server ID (ServerId), Session ID (SessionId) and user (UserName) make up the UserDetails.

ServiceUnavailableException

Description

The request has failed because the Amazon Web ServicesTransfer Family service is not available.

Members

Message

Type: string

SshPublicKey

Description

Provides information about the public Secure Shell (SSH) key that is associated with a user account for 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 SshPublicKeyId parameter contains the identifier of the public key.

Tag

Description

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

Members

Key

Required: Yes
Type: string

The name assigned to the tag that you create.

Value

Required: Yes
Type: string

Contains one or more values that you assigned to the key name you create.

TagStepDetails

Description

Each step type has its own StepDetails structure.

The key/value pairs used to tag a file during the execution of a workflow step.

Members

Name

Type: string

The name of the step, used as an identifier.

Tags

Type: Array of S3Tag structures

Array that contains from 1 to 10 key/value pairs.

ThrottlingException

Description

The request was denied due to request throttling.

HTTP Status Code: 400

Members

RetryAfterSeconds

Type: string

UserDetails

Description

Specifies the user name, server ID, and session ID for a workflow.

Members

ServerId

Required: Yes
Type: string

The system-assigned unique identifier for a Transfer server instance.

SessionId

Type: string

The system-assigned unique identifier for a session that corresponds to the workflow.

UserName

Required: Yes
Type: string

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

WorkflowDetail

Description

Specifies the workflow ID for the workflow to assign and the execution role used for executing the workflow.

Members

ExecutionRole

Required: Yes
Type: string

Includes the necessary permissions for S3, EFS, and Lambda operations that Transfer can assume, so that all workflow steps can operate on the required resources

WorkflowId

Required: Yes
Type: string

A unique identifier for the workflow.

WorkflowDetails

Description

Container for the WorkflowDetail data type. It is used by actions that trigger a workflow to begin execution.

Members

OnUpload

Required: Yes
Type: Array of WorkflowDetail structures

A trigger that starts a workflow: the workflow begins to execute after a file is uploaded.

WorkflowStep

Description

The basic building block of a workflow.

Members

CopyStepDetails

Type: CopyStepDetails structure

Details for a step that performs a file copy.

Consists of the following values:

A description
An S3 location for the destination of the file copy.
A flag that indicates whether or not to overwrite an existing file of the same name. The default is FALSE.

CustomStepDetails

Type: CustomStepDetails structure

Details for a step that invokes a lambda function.

Consists of the lambda function name, target, and timeout (in seconds).

DeleteStepDetails

Type: DeleteStepDetails structure

Details for a step that deletes the file.

TagStepDetails

Type: TagStepDetails structure

Details for a step that creates one or more tags.

You specify one or more tags: each tag contains a key/value pair.

Type

Type: string

Currently, the following step types are supported.

Copy: copy the file to another location
Custom: custom step with a lambda target
Delete: delete the file
Tag: add a tag to the file

Namespaces

Classes

Interfaces

Traits

Exceptions

Functions

AWS Transfer Family 2018-11-05

Operation Summary

Paginators

Operations

CreateAccess

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CreateServer

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CreateUser

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CreateWorkflow

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

DeleteAccess

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

DeleteServer

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

DeleteSshPublicKey

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

DeleteUser

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

DeleteWorkflow

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

DescribeAccess

Parameter Syntax

Parameter Details