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

Waiters

Waiters allow you to poll a resource until it enters into a desired state. A waiter has a name used to describe what it does, and is associated with an API operation. When creating a waiter, you can provide the API operation parameters associated with the corresponding operation. Waiters can be accessed using the getWaiter($waiterName, $operationParameters) method of a client object. This client supports the following waiters:

Waiter name	API Operation	Delay	Max Attempts
ServerOffline	DescribeServer	30	120
ServerOnline	DescribeServer	30	120

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" } ]

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>',
        'Function' => '<string>',
        'InvocationRole' => '<string>',
        'Url' => '<string>',
    ],
    'IdentityProviderType' => 'SERVICE_MANAGED|API_GATEWAY|AWS_DIRECTORY_SERVICE|AWS_LAMBDA',
    'LoggingRole' => '<string>',
    'PostAuthenticationLoginBanner' => '<string>',
    'PreAuthenticationLoginBanner' => '<string>',
    'ProtocolDetails' => [
        'PassiveIp' => '<string>',
        'SetStatOption' => 'DEFAULT|ENABLE_NO_OP',
        'TlsSessionResumptionMode' => 'DISABLED|ENABLED|ENFORCED',
    ],
    '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, ECDSA, or ED25519 private key to use for your server.

Use the following command to generate an RSA 2048 bit key with no passphrase:

ssh-keygen -t rsa -b 2048 -N "" -m PEM -f my-new-server-key.

Use a minimum value of 2048 for the -b option: you can create a stronger key using 3072 or 4096.

Use the following command to generate an ECDSA 256 bit key with no passphrase:

ssh-keygen -t ecdsa -b 256 -N "" -m PEM -f my-new-server-key.

Valid values for the -b option for ECDSA are 256, 384, and 521.

Use the following command to generate an ED25519 key with no passphrase:

ssh-keygen -t ed25519 -N "" -f my-new-server-key.

For all of these commands, you can replace my-new-server-key with a string of your choice.

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.

Use the AWS_LAMBDA value to directly use a Lambda function as your identity provider. If you choose this value, you must specify the ARN for the lambda function in the Function parameter for the IdentityProviderDetails data type.

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.

PostAuthenticationLoginBanner

Type: string

Specify a string to display when users connect to a server. This string is displayed after the user authenticates.

The SFTP protocol does not support post-authentication display banners.

PreAuthenticationLoginBanner

Type: string

Specify a string to display when users connect to a server. This string is displayed before the user authenticates. For example, the following banner displays details about using the system.

This system is for the use of authorized users only. Individuals using this computer system without authority, or in excess of their authority, are subject to having all of their activities on this system monitored and recorded by system personnel.

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.
Use the SetStatOption to ignore the error that is generated when the client attempts to use SETSTAT on a file you are uploading to an S3 bucket. Set the value to ENABLE_NO_OP to have the Transfer Family server ignore the SETSTAT command, and upload files without needing to make any changes to your SFTP client. Note that with SetStatOption set to ENABLE_NO_OP, Transfer generates a log entry to CloudWatch Logs, so you can determine when the client is making a SETSTAT call.
Use the TlsSessionResumptionMode parameter to determine whether or not your Transfer server resumes recent, negotiated sessions through a unique session ID.

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.

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.

Transfer Family accepts RSA, ECDSA, and ED25519 keys.

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',
                'SourceFileLocation' => '<string>',
            ],
            'CustomStepDetails' => [
                'Name' => '<string>',
                'SourceFileLocation' => '<string>',
                'Target' => '<string>',
                'TimeoutSeconds' => <integer>,
            ],
            'DeleteStepDetails' => [
                'Name' => '<string>',
                'SourceFileLocation' => '<string>',
            ],
            'TagStepDetails' => [
                'Name' => '<string>',
                'SourceFileLocation' => '<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',
                'SourceFileLocation' => '<string>',
            ],
            'CustomStepDetails' => [
                'Name' => '<string>',
                'SourceFileLocation' => '<string>',
                'Target' => '<string>',
                'TimeoutSeconds' => <integer>,
            ],
            'DeleteStepDetails' => [
                'Name' => '<string>',
                'SourceFileLocation' => '<string>',
            ],
            'TagStepDetails' => [
                'Name' => '<string>',
                'SourceFileLocation' => '<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.

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.

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|CUSTOM_STEP_FAILED|THROTTLED|ALREADY_EXISTS|NOT_FOUND|BAD_REQUEST|TIMEOUT|INTERNAL_SERVER_ERROR',
                    ],
                    'Outputs' => '<string>',
                    'StepType' => 'COPY|CUSTOM|TAG|DELETE',
                ],
                // ...
            ],
            'Steps' => [
                [
                    'Error' => [
                        'Message' => '<string>',
                        'Type' => 'PERMISSION_DENIED|CUSTOM_STEP_FAILED|THROTTLED|ALREADY_EXISTS|NOT_FOUND|BAD_REQUEST|TIMEOUT|INTERNAL_SERVER_ERROR',
                    ],
                    '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>',
            'Function' => '<string>',
            'InvocationRole' => '<string>',
            'Url' => '<string>',
        ],
        'IdentityProviderType' => 'SERVICE_MANAGED|API_GATEWAY|AWS_DIRECTORY_SERVICE|AWS_LAMBDA',
        'LoggingRole' => '<string>',
        'PostAuthenticationLoginBanner' => '<string>',
        'PreAuthenticationLoginBanner' => '<string>',
        'ProtocolDetails' => [
            'PassiveIp' => '<string>',
            'SetStatOption' => 'DEFAULT|ENABLE_NO_OP',
            'TlsSessionResumptionMode' => 'DISABLED|ENABLED|ENFORCED',
        ],
        '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',
                    'SourceFileLocation' => '<string>',
                ],
                'CustomStepDetails' => [
                    'Name' => '<string>',
                    'SourceFileLocation' => '<string>',
                    'Target' => '<string>',
                    'TimeoutSeconds' => <integer>,
                ],
                'DeleteStepDetails' => [
                    'Name' => '<string>',
                    'SourceFileLocation' => '<string>',
                ],
                'TagStepDetails' => [
                    'Name' => '<string>',
                    'SourceFileLocation' => '<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',
                    'SourceFileLocation' => '<string>',
                ],
                'CustomStepDetails' => [
                    'Name' => '<string>',
                    'SourceFileLocation' => '<string>',
                    'Target' => '<string>',
                    'TimeoutSeconds' => <integer>,
                ],
                'DeleteStepDetails' => [
                    'Name' => '<string>',
                    'SourceFileLocation' => '<string>',
                ],
                'TagStepDetails' => [
                    'Name' => '<string>',
                    'SourceFileLocation' => '<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.

Transfer Family accepts RSA, ECDSA, and ED25519 keys.

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.

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|AWS_LAMBDA',
            '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.

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.

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.

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.

If an empty string is returned, the most likely cause is that the authentication failed due to an incorrect username or password.

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>',
        'Function' => '<string>',
        'InvocationRole' => '<string>',
        'Url' => '<string>',
    ],
    'LoggingRole' => '<string>',
    'PostAuthenticationLoginBanner' => '<string>',
    'PreAuthenticationLoginBanner' => '<string>',
    'ProtocolDetails' => [
        'PassiveIp' => '<string>',
        'SetStatOption' => 'DEFAULT|ENABLE_NO_OP',
        'TlsSessionResumptionMode' => 'DISABLED|ENABLED|ENFORCED',
    ],
    '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