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 Transfer Family.
CreateAgreement ( array $params = [] )
Creates an agreement.
CreateConnector ( array $params = [] )
Creates the connector, which captures the parameters for a connection for the AS2 or SFTP protocol.
CreateProfile ( array $params = [] )
Creates the local or partner profile to use for AS2 transfers.
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.
DeleteAgreement ( array $params = [] )
Delete the agreement that's specified in the provided AgreementId.
DeleteCertificate ( array $params = [] )
Deletes the certificate that's specified in the CertificateId parameter.
DeleteConnector ( array $params = [] )
Deletes the connector that's specified in the provided ConnectorId.
DeleteHostKey ( array $params = [] )
Deletes the host key that's specified in the HostKeyId parameter.
DeleteProfile ( array $params = [] )
Deletes the profile that's specified in the ProfileId parameter.
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.
DescribeAgreement ( array $params = [] )
Describes the agreement that's identified by the AgreementId.
DescribeCertificate ( array $params = [] )
Describes the certificate that's identified by the CertificateId.
DescribeConnector ( array $params = [] )
Describes the connector that's identified by the ConnectorId.
DescribeExecution ( array $params = [] )
You can use DescribeExecution to check the details of the execution of the specified workflow.
DescribeHostKey ( array $params = [] )
Returns the details of the host key that's specified by the HostKeyId and ServerId.
DescribeProfile ( array $params = [] )
Returns the details of the profile that's specified by the ProfileId.
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.
ImportCertificate ( array $params = [] )
Imports the signing and encryption certificates that you need to create local (AS2) profiles and partner profiles.
ImportHostKey ( array $params = [] )
Adds a host key to the server that's specified by the ServerId parameter.
ImportSshPublicKey ( array $params = [] )
Adds a Secure Shell (SSH) public key to a Transfer Family user 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.
ListAgreements ( array $params = [] )
Returns a list of the agreements for the server that's identified by the ServerId that you supply.
ListCertificates ( array $params = [] )
Returns a list of the current certificates that have been imported into Transfer Family.
ListConnectors ( array $params = [] )
Lists the connectors for the specified Region.
ListExecutions ( array $params = [] )
Lists all in-progress executions for the specified workflow.
ListHostKeys ( array $params = [] )
Returns a list of host keys for the server that's specified by the ServerId parameter.
ListProfiles ( array $params = [] )
Returns a list of the profiles for your system.
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 workflows associated with your Amazon Web Services account for your current region.
SendWorkflowStepState ( array $params = [] )
Sends a callback for asynchronous custom steps.
StartFileTransfer ( array $params = [] )
Begins a file transfer between local Amazon Web Services storage and a remote AS2 or SFTP server.
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).
TestConnection ( array $params = [] )
Tests whether your SFTP connector is set up successfully.
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.
UpdateAgreement ( array $params = [] )
Updates some of the parameters for an existing agreement.
UpdateCertificate ( array $params = [] )
Updates the active and inactive dates for a certificate.
UpdateConnector ( array $params = [] )
Updates some of the parameters for an existing connector.
UpdateHostKey ( array $params = [] )
Updates the description for the host key that's specified by the ServerId and HostKeyId parameters.
UpdateProfile ( array $params = [] )
Updates some of the parameters for an existing profile.
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
ListAgreements
ListCertificates
ListConnectors
ListExecutions
ListProfiles
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 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 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 regular expression 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 Identity and Access Management (IAM) role provides access to paths in Target. This value can be set only 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) that you want your users' home directory to be when they log in to 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 Amazon EFS paths visible to your users.

Policy

Type: string

A session policy for your user so that you can use the same Identity and Access Management (IAM) role across multiple users. This policy scopes down a user's 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 policy applies only when the domain of ServerId is Amazon S3. Amazon EFS does not use session policies.

For session policies, 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 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

The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that controls your users' access to your Amazon S3 bucket or Amazon 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 Amazon 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 identifier of the group whose users have access to your Amazon S3 or Amazon EFS resources over the enabled protocols using Transfer Family.

ServerId

Required: Yes
Type: string

The identifier 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.

CreateAgreement

$result = $client->createAgreement([/* ... */]);
$promise = $client->createAgreementAsync([/* ... */]);

Creates an agreement. An agreement is a bilateral trading partner agreement, or partnership, between an Transfer Family server and an AS2 process. The agreement defines the file and message transfer relationship between the server and the AS2 process. To define an agreement, Transfer Family combines a server, local profile, partner profile, certificate, and other attributes.

The partner is identified with the PartnerProfileId, and the AS2 process is identified with the LocalProfileId.

Parameter Syntax

$result = $client->createAgreement([
    'AccessRole' => '<string>', // REQUIRED
    'BaseDirectory' => '<string>', // REQUIRED
    'Description' => '<string>',
    'LocalProfileId' => '<string>', // REQUIRED
    'PartnerProfileId' => '<string>', // REQUIRED
    'ServerId' => '<string>', // REQUIRED
    'Status' => 'ACTIVE|INACTIVE',
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Members

AccessRole

Required: Yes
Type: string

Connectors are used to send files using either the AS2 or SFTP protocol. For the access role, provide the Amazon Resource Name (ARN) of the Identity and Access Management role to use.

For AS2 connectors

With AS2, you can send files by calling StartFileTransfer and specifying the file paths in the request parameter, SendFilePaths. We use the file’s parent directory (for example, for --send-file-paths /bucket/dir/file.txt, parent directory is /bucket/dir/) to temporarily store a processed AS2 message file, store the MDN when we receive them from the partner, and write a final JSON file containing relevant metadata of the transmission. So, the AccessRole needs to provide read and write access to the parent directory of the file location used in the StartFileTransfer request. Additionally, you need to provide read and write access to the parent directory of the files that you intend to send with StartFileTransfer.

If you are using Basic authentication for your AS2 connector, the access role requires the secretsmanager:GetSecretValue permission for the secret. If the secret is encrypted using a customer-managed key instead of the Amazon Web Services managed key in Secrets Manager, then the role also needs the kms:Decrypt permission for that key.

For SFTP connectors

Make sure that the access role provides read and write access to the parent directory of the file location that's used in the StartFileTransfer request. Additionally, make sure that the role provides secretsmanager:GetSecretValue permission to Secrets Manager.

BaseDirectory

Required: Yes
Type: string

The landing directory (folder) for files transferred by using the AS2 protocol.

A BaseDirectory example is /DOC-EXAMPLE-BUCKET/home/mydirectory.

Description

Type: string

A name or short description to identify the agreement.

LocalProfileId

Required: Yes
Type: string

A unique identifier for the AS2 local profile.

PartnerProfileId

Required: Yes
Type: string

A unique identifier for the partner profile used in the agreement.

ServerId

Required: Yes
Type: string

A system-assigned unique identifier for a server instance. This is the specific server that the agreement uses.

Status

Type: string

The status of the agreement. The agreement can be either ACTIVE or INACTIVE.

Tags

Type: Array of Tag structures

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

Result Syntax

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

Result Details

Members

AgreementId

Required: Yes
Type: string

The unique identifier for the agreement. Use this ID for deleting, or updating an agreement, as well as in any other API calls that require that you specify the agreement ID.

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.

CreateConnector

$result = $client->createConnector([/* ... */]);
$promise = $client->createConnectorAsync([/* ... */]);

Creates the connector, which captures the parameters for a connection for the AS2 or SFTP protocol. For AS2, the connector is required for sending files to an externally hosted AS2 server. For SFTP, the connector is required when sending files to an SFTP server or receiving files from an SFTP server. For more details about connectors, see Create AS2 connectors and Create SFTP connectors.

You must specify exactly one configuration object: either for AS2 (As2Config) or SFTP (SftpConfig).

Parameter Syntax

$result = $client->createConnector([
    'AccessRole' => '<string>', // REQUIRED
    'As2Config' => [
        'BasicAuthSecretId' => '<string>',
        'Compression' => 'ZLIB|DISABLED',
        'EncryptionAlgorithm' => 'AES128_CBC|AES192_CBC|AES256_CBC|NONE',
        'LocalProfileId' => '<string>',
        'MdnResponse' => 'SYNC|NONE',
        'MdnSigningAlgorithm' => 'SHA256|SHA384|SHA512|SHA1|NONE|DEFAULT',
        'MessageSubject' => '<string>',
        'PartnerProfileId' => '<string>',
        'SigningAlgorithm' => 'SHA256|SHA384|SHA512|SHA1|NONE',
    ],
    'LoggingRole' => '<string>',
    'SftpConfig' => [
        'TrustedHostKeys' => ['<string>', ...],
        'UserSecretId' => '<string>',
    ],
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'Url' => '<string>', // REQUIRED
]);

Parameter Details

Members

AccessRole

Required: Yes
Type: string

Connectors are used to send files using either the AS2 or SFTP protocol. For the access role, provide the Amazon Resource Name (ARN) of the Identity and Access Management role to use.

For AS2 connectors

For SFTP connectors

As2Config

Type: As2ConnectorConfig structure

A structure that contains the parameters for an AS2 connector object.

LoggingRole

Type: string

The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that allows a connector to turn on CloudWatch logging for Amazon S3 events. When set, you can view connector activity in your CloudWatch logs.

SftpConfig

Type: SftpConnectorConfig structure

A structure that contains the parameters for an SFTP connector object.

Tags

Type: Array of Tag structures

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

Url

Required: Yes
Type: string

The URL of the partner's AS2 or SFTP endpoint.

Result Syntax

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

Result Details

Members

ConnectorId

Required: Yes
Type: string

The unique identifier for the connector, returned after the API call succeeds.

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.

CreateProfile

$result = $client->createProfile([/* ... */]);
$promise = $client->createProfileAsync([/* ... */]);

Creates the local or partner profile to use for AS2 transfers.

Parameter Syntax

$result = $client->createProfile([
    'As2Id' => '<string>', // REQUIRED
    'CertificateIds' => ['<string>', ...],
    'ProfileType' => 'LOCAL|PARTNER', // REQUIRED
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Members

As2Id

Required: Yes
Type: string

The As2Id is the AS2-name, as defined in the RFC 4130. For inbound transfers, this is the AS2-From header for the AS2 messages sent from the partner. For outbound connectors, this is the AS2-To header for the AS2 messages sent to the partner using the StartFileTransfer API operation. This ID cannot include spaces.

CertificateIds

Type: Array of strings

An array of identifiers for the imported certificates. You use this identifier for working with profiles and partner profiles.

ProfileType

Required: Yes
Type: string

Determines the type of profile to create:

Specify LOCAL to create a local profile. A local profile represents the AS2-enabled Transfer Family server organization or party.
Specify PARTNER to create a partner profile. A partner profile represents a remote organization, external to Transfer Family.

Tags

Type: Array of Tag structures

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

Result Syntax

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

Result Details

Members

ProfileId

Required: Yes
Type: string

The unique identifier for the AS2 profile, returned after the API call succeeds.

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.

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>',
        'SftpAuthenticationMethods' => 'PASSWORD|PUBLIC_KEY|PUBLIC_KEY_OR_PASSWORD|PUBLIC_KEY_AND_PASSWORD',
        'Url' => '<string>',
    ],
    'IdentityProviderType' => 'SERVICE_MANAGED|API_GATEWAY|AWS_DIRECTORY_SERVICE|AWS_LAMBDA',
    'LoggingRole' => '<string>',
    'PostAuthenticationLoginBanner' => '<string>',
    'PreAuthenticationLoginBanner' => '<string>',
    'ProtocolDetails' => [
        'As2Transports' => ['<string>', ...],
        'PassiveIp' => '<string>',
        'SetStatOption' => 'DEFAULT|ENABLE_NO_OP',
        'TlsSessionResumptionMode' => 'DISABLED|ENABLED|ENFORCED',
    ],
    'Protocols' => ['<string>', ...],
    'SecurityPolicyName' => '<string>',
    'StructuredLogDestinations' => ['<string>', ...],
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'WorkflowDetails' => [
        'OnPartialUpload' => [
            [
                'ExecutionRole' => '<string>', // REQUIRED
                'WorkflowId' => '<string>', // REQUIRED
            ],
            // ...
        ],
        'OnUpload' => [
            [
                'ExecutionRole' => '<string>', // REQUIRED
                'WorkflowId' => '<string>', // REQUIRED
            ],
            // ...
        ],
    ],
]);

Parameter Details

Members

Certificate

Type: string

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

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

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

To request a private certificate to use FTPS through private IP addresses, see Request a private certificate in the 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 your endpoint accessible only to resources within your VPC, or you can attach Elastic IP addresses and make your endpoint 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 SFTP-enabled server. You can add multiple host keys, in case you want to rotate keys, or have a set of active keys that use different algorithms.

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 by 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 Manage host keys for your SFTP-enabled server in the Transfer Family User Guide.

IdentityProviderDetails

Type: IdentityProviderDetails structure

Required when IdentityProviderType is set to AWS_DIRECTORY_SERVICE, Amazon Web Services_LAMBDA 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

The mode of authentication for a server. The default value is SERVICE_MANAGED, which allows you to store and access user credentials within the Transfer Family service.

Use AWS_DIRECTORY_SERVICE to provide access to Active Directory groups in Directory Service for Microsoft Active Directory or Microsoft Active Directory in your on-premises environment or in Amazon Web Services using AD Connector. This option also requires you to provide a Directory ID by 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 Amazon API Gateway endpoint URL to call for authentication by using the IdentityProviderDetails parameter.

Use the AWS_LAMBDA value to directly use an 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

The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that allows a server to turn on Amazon CloudWatch logging for Amazon S3 or Amazon EFSevents. When set, you can view user activity in your CloudWatch logs.

PostAuthenticationLoginBanner

Type: string

Specifies 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

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

To indicate passive mode (for FTP and FTPS protocols), use the PassiveIp parameter. Enter a single dotted-quad IPv4 address, such as the external IP address of a firewall, router, or load balancer.
To ignore the error that is generated when the client attempts to use the SETSTAT command on a file that you are uploading to an Amazon S3 bucket, use the SetStatOption parameter. To have the Transfer Family server ignore the SETSTAT command and upload files without needing to make any changes to your SFTP client, set the value to ENABLE_NO_OP. If you set the SetStatOption parameter to ENABLE_NO_OP, Transfer Family generates a log entry to Amazon CloudWatch Logs, so that you can determine when the client is making a SETSTAT call.
To determine whether your Transfer Family server resumes recent, negotiated sessions through a unique session ID, use the TlsSessionResumptionMode parameter.
As2Transports indicates the transport method for the AS2 messages. Currently, only HTTP is supported.

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
AS2 (Applicability Statement 2): used for transporting structured business-to-business data

If you select FTPS, you must choose a certificate stored in 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 either AWS_DIRECTORY_SERVICE, AWS_LAMBDA, 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 any of the supported identity types: SERVICE_MANAGED, AWS_DIRECTORY_SERVICE, AWS_LAMBDA, or API_GATEWAY.
If Protocol includes AS2, then the EndpointType must be VPC, and domain must be Amazon S3.

SecurityPolicyName

Type: string

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

StructuredLogDestinations

Type: Array of strings

Specifies the log groups to which your server logs are sent.

To specify a log group, you must provide the ARN for an existing log group. In this case, the format of the log group is as follows:

arn:aws:logs:region-name:amazon-account-id:log-group:log-group-name:*

For example, arn:aws:logs:us-east-1:111122223333:log-group:mytestgroup:*

If you have previously specified a log group for a server, you can clear it, and in effect turn off structured logging, by providing an empty value for this parameter in an update-server call. For example:

update-server --server-id s-1234567890abcdef0 --structured-log-destinations

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 that's used for executing the workflow.

In addition to a workflow to execute when a file is uploaded completely, WorkflowDetails can also contain a workflow ID (and execution role) for a workflow to execute on partial upload. A partial upload occurs when the server session disconnects while the file is still being uploaded.

Result Syntax

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

Result Details

Members

ServerId

Required: Yes
Type: string

The service-assigned identifier 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 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 value the user should see for their home directory when they log in.

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

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

HomeDirectoryType

Type: string

Policy

Type: string

This policy applies only when the domain of ServerId is Amazon S3. Amazon 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.

The three standard SSH public key format elements are <key type>, <body base64>, and an optional <comment>, with spaces between each element.

Transfer Family accepts RSA, ECDSA, and ED25519 keys.

For RSA keys, the key type is ssh-rsa.
For ED25519 keys, the key type is ssh-ed25519.
For ECDSA keys, the key type is either ecdsa-sha2-nistp256, ecdsa-sha2-nistp384, or ecdsa-sha2-nistp521, depending on the size of the key you generated.

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 identifier of the server that the user is attached to.

UserName

Required: Yes
Type: string

A unique string that identifies a Transfer Family 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.
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>,
            ],
            'DecryptStepDetails' => [
                'DestinationFileLocation' => [ // REQUIRED
                    'EfsFileLocation' => [
                        'FileSystemId' => '<string>',
                        'Path' => '<string>',
                    ],
                    'S3FileLocation' => [
                        'Bucket' => '<string>',
                        'Key' => '<string>',
                    ],
                ],
                'Name' => '<string>',
                'OverwriteExisting' => 'TRUE|FALSE',
                'SourceFileLocation' => '<string>',
                'Type' => 'PGP', // REQUIRED
            ],
            'DeleteStepDetails' => [
                'Name' => '<string>',
                'SourceFileLocation' => '<string>',
            ],
            'TagStepDetails' => [
                'Name' => '<string>',
                'SourceFileLocation' => '<string>',
                'Tags' => [
                    [
                        'Key' => '<string>', // REQUIRED
                        'Value' => '<string>', // REQUIRED
                    ],
                    // ...
                ],
            ],
            'Type' => 'COPY|CUSTOM|TAG|DELETE|DECRYPT',
        ],
        // ...
    ],
    '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>,
            ],
            'DecryptStepDetails' => [
                'DestinationFileLocation' => [ // REQUIRED
                    'EfsFileLocation' => [
                        'FileSystemId' => '<string>',
                        'Path' => '<string>',
                    ],
                    'S3FileLocation' => [
                        'Bucket' => '<string>',
                        'Key' => '<string>',
                    ],
                ],
                'Name' => '<string>',
                'OverwriteExisting' => 'TRUE|FALSE',
                'SourceFileLocation' => '<string>',
                'Type' => 'PGP', // REQUIRED
            ],
            'DeleteStepDetails' => [
                'Name' => '<string>',
                'SourceFileLocation' => '<string>',
            ],
            'TagStepDetails' => [
                'Name' => '<string>',
                'SourceFileLocation' => '<string>',
                'Tags' => [
                    [
                        'Key' => '<string>', // REQUIRED
                        'Value' => '<string>', // REQUIRED
                    ],
                    // ...
                ],
            ],
            'Type' => 'COPY|CUSTOM|TAG|DELETE|DECRYPT',
        ],
        // ...
    ],
    '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 - Perform a custom step with an Lambda function target.
DECRYPT - Decrypt a file that was encrypted before it was uploaded.
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 Amazon S3 bucket and key, or the Amazon EFS file system 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.

DeleteAgreement

$result = $client->deleteAgreement([/* ... */]);
$promise = $client->deleteAgreementAsync([/* ... */]);

Delete the agreement that's specified in the provided AgreementId.

Parameter Syntax

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

Parameter Details

Members

AgreementId

Required: Yes
Type: string

A unique identifier for the agreement. This identifier is returned when you create an agreement.

ServerId

Required: Yes
Type: string

The server identifier associated with the agreement that you are deleting.

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.

DeleteCertificate

$result = $client->deleteCertificate([/* ... */]);
$promise = $client->deleteCertificateAsync([/* ... */]);

Deletes the certificate that's specified in the CertificateId parameter.

Parameter Syntax

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

Parameter Details

Members

CertificateId

Required: Yes
Type: string

The identifier of the certificate object that you are deleting.

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.

DeleteConnector

$result = $client->deleteConnector([/* ... */]);
$promise = $client->deleteConnectorAsync([/* ... */]);

Deletes the connector that's specified in the provided ConnectorId.

Parameter Syntax

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

Parameter Details

Members

ConnectorId

Required: Yes
Type: string

The unique identifier for the connector.

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.

DeleteHostKey

$result = $client->deleteHostKey([/* ... */]);
$promise = $client->deleteHostKeyAsync([/* ... */]);

Deletes the host key that's specified in the HostKeyId parameter.

Parameter Syntax

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

Parameter Details

Members

HostKeyId

Required: Yes
Type: string

The identifier of the host key that you are deleting.

ServerId

Required: Yes
Type: string

The identifier of the server that contains the host key that you are deleting.

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.

DeleteProfile

$result = $client->deleteProfile([/* ... */]);
$promise = $client->deleteProfileAsync([/* ... */]);

Deletes the profile that's specified in the ProfileId parameter.

Parameter Syntax

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

Parameter Details

Members

ProfileId

Required: Yes
Type: string

The identifier of the profile that you are deleting.

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

DescribeAgreement

$result = $client->describeAgreement([/* ... */]);
$promise = $client->describeAgreementAsync([/* ... */]);

Describes the agreement that's identified by the AgreementId.

Parameter Syntax

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

Parameter Details

Members

AgreementId

Required: Yes
Type: string

A unique identifier for the agreement. This identifier is returned when you create an agreement.

ServerId

Required: Yes
Type: string

The server identifier that's associated with the agreement.

Result Syntax

[
    'Agreement' => [
        'AccessRole' => '<string>',
        'AgreementId' => '<string>',
        'Arn' => '<string>',
        'BaseDirectory' => '<string>',
        'Description' => '<string>',
        'LocalProfileId' => '<string>',
        'PartnerProfileId' => '<string>',
        'ServerId' => '<string>',
        'Status' => 'ACTIVE|INACTIVE',
        'Tags' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
    ],
]

Result Details

Members

Agreement

Required: Yes
Type: DescribedAgreement structure

The details for the specified agreement, returned as a DescribedAgreement object.

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.

DescribeCertificate

$result = $client->describeCertificate([/* ... */]);
$promise = $client->describeCertificateAsync([/* ... */]);

Describes the certificate that's identified by the CertificateId.

Parameter Syntax

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

Parameter Details

Members

CertificateId

Required: Yes
Type: string

An array of identifiers for the imported certificates. You use this identifier for working with profiles and partner profiles.

Result Syntax

[
    'Certificate' => [
        'ActiveDate' => <DateTime>,
        'Arn' => '<string>',
        'Certificate' => '<string>',
        'CertificateChain' => '<string>',
        'CertificateId' => '<string>',
        'Description' => '<string>',
        'InactiveDate' => <DateTime>,
        'NotAfterDate' => <DateTime>,
        'NotBeforeDate' => <DateTime>,
        'Serial' => '<string>',
        'Status' => 'ACTIVE|PENDING_ROTATION|INACTIVE',
        'Tags' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
        'Type' => 'CERTIFICATE|CERTIFICATE_WITH_PRIVATE_KEY',
        'Usage' => 'SIGNING|ENCRYPTION',
    ],
]

Result Details

Members

Certificate

Required: Yes
Type: DescribedCertificate structure

The details for the specified certificate, returned as an object.

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.

DescribeConnector

$result = $client->describeConnector([/* ... */]);
$promise = $client->describeConnectorAsync([/* ... */]);

Describes the connector that's identified by the ConnectorId.

Parameter Syntax

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

Parameter Details

Members

ConnectorId

Required: Yes
Type: string

The unique identifier for the connector.

Result Syntax

[
    'Connector' => [
        'AccessRole' => '<string>',
        'Arn' => '<string>',
        'As2Config' => [
            'BasicAuthSecretId' => '<string>',
            'Compression' => 'ZLIB|DISABLED',
            'EncryptionAlgorithm' => 'AES128_CBC|AES192_CBC|AES256_CBC|NONE',
            'LocalProfileId' => '<string>',
            'MdnResponse' => 'SYNC|NONE',
            'MdnSigningAlgorithm' => 'SHA256|SHA384|SHA512|SHA1|NONE|DEFAULT',
            'MessageSubject' => '<string>',
            'PartnerProfileId' => '<string>',
            'SigningAlgorithm' => 'SHA256|SHA384|SHA512|SHA1|NONE',
        ],
        'ConnectorId' => '<string>',
        'LoggingRole' => '<string>',
        'SftpConfig' => [
            'TrustedHostKeys' => ['<string>', ...],
            'UserSecretId' => '<string>',
        ],
        'Tags' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
        'Url' => '<string>',
    ],
]

Result Details

Members

Connector

Required: Yes
Type: DescribedConnector structure

The structure that contains the details of the connector.

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.

This API call only returns details for in-progress workflows.

If you provide an ID for an execution that is not in progress, or if the execution doesn't match the specified workflow ID, you receive a ResourceNotFound exception.

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|DECRYPT',
                ],
                // ...
            ],
            '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|DECRYPT',
                ],
                // ...
            ],
        ],
        '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.

DescribeHostKey

$result = $client->describeHostKey([/* ... */]);
$promise = $client->describeHostKeyAsync([/* ... */]);

Returns the details of the host key that's specified by the HostKeyId and ServerId.

Parameter Syntax

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

Parameter Details

Members

HostKeyId

Required: Yes
Type: string

The identifier of the host key that you want described.

ServerId

Required: Yes
Type: string

The identifier of the server that contains the host key that you want described.

Result Syntax

[
    'HostKey' => [
        'Arn' => '<string>',
        'DateImported' => <DateTime>,
        'Description' => '<string>',
        'HostKeyFingerprint' => '<string>',
        'HostKeyId' => '<string>',
        'Tags' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
        'Type' => '<string>',
    ],
]

Result Details

Members

HostKey

Required: Yes
Type: DescribedHostKey structure

Returns the details for the specified host key.

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.

DescribeProfile

$result = $client->describeProfile([/* ... */]);
$promise = $client->describeProfileAsync([/* ... */]);

Returns the details of the profile that's specified by the ProfileId.

Parameter Syntax

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

Parameter Details

Members

ProfileId

Required: Yes
Type: string

The identifier of the profile that you want described.

Result Syntax

[
    'Profile' => [
        'Arn' => '<string>',
        'As2Id' => '<string>',
        'CertificateIds' => ['<string>', ...],
        'ProfileId' => '<string>',
        'ProfileType' => 'LOCAL|PARTNER',
        'Tags' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
    ],
]

Result Details

Members

Profile

Required: Yes
Type: DescribedProfile structure

The details of the specified profile, returned as an object.

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>',
            'SftpAuthenticationMethods' => 'PASSWORD|PUBLIC_KEY|PUBLIC_KEY_OR_PASSWORD|PUBLIC_KEY_AND_PASSWORD',
            'Url' => '<string>',
        ],
        'IdentityProviderType' => 'SERVICE_MANAGED|API_GATEWAY|AWS_DIRECTORY_SERVICE|AWS_LAMBDA',
        'LoggingRole' => '<string>',
        'PostAuthenticationLoginBanner' => '<string>',
        'PreAuthenticationLoginBanner' => '<string>',
        'ProtocolDetails' => [
            'As2Transports' => ['<string>', ...],
            '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',
        'StructuredLogDestinations' => ['<string>', ...],
        'Tags' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
        'UserCount' => <integer>,
        'WorkflowDetails' => [
            'OnPartialUpload' => [
                [
                    'ExecutionRole' => '<string>',
                    'WorkflowId' => '<string>',
                ],
                // ...
            ],
            '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 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 Transfer Family user 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>,
                ],
                'DecryptStepDetails' => [
                    'DestinationFileLocation' => [
                        'EfsFileLocation' => [
                            'FileSystemId' => '<string>',
                            'Path' => '<string>',
                        ],
                        'S3FileLocation' => [
                            'Bucket' => '<string>',
                            'Key' => '<string>',
                        ],
                    ],
                    'Name' => '<string>',
                    'OverwriteExisting' => 'TRUE|FALSE',
                    'SourceFileLocation' => '<string>',
                    'Type' => 'PGP',
                ],
                'DeleteStepDetails' => [
                    'Name' => '<string>',
                    'SourceFileLocation' => '<string>',
                ],
                'TagStepDetails' => [
                    'Name' => '<string>',
                    'SourceFileLocation' => '<string>',
                    'Tags' => [
                        [
                            'Key' => '<string>',
                            'Value' => '<string>',
                        ],
                        // ...
                    ],
                ],
                'Type' => 'COPY|CUSTOM|TAG|DELETE|DECRYPT',
            ],
            // ...
        ],
        '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>,
                ],
                'DecryptStepDetails' => [
                    'DestinationFileLocation' => [
                        'EfsFileLocation' => [
                            'FileSystemId' => '<string>',
                            'Path' => '<string>',
                        ],
                        'S3FileLocation' => [
                            'Bucket' => '<string>',
                            'Key' => '<string>',
                        ],
                    ],
                    'Name' => '<string>',
                    'OverwriteExisting' => 'TRUE|FALSE',
                    'SourceFileLocation' => '<string>',
                    'Type' => 'PGP',
                ],
                'DeleteStepDetails' => [
                    'Name' => '<string>',
                    'SourceFileLocation' => '<string>',
                ],
                'TagStepDetails' => [
                    'Name' => '<string>',
                    'SourceFileLocation' => '<string>',
                    'Tags' => [
                        [
                            'Key' => '<string>',
                            'Value' => '<string>',
                        ],
                        // ...
                    ],
                ],
                'Type' => 'COPY|CUSTOM|TAG|DELETE|DECRYPT',
            ],
            // ...
        ],
        '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.

ImportCertificate

$result = $client->importCertificate([/* ... */]);
$promise = $client->importCertificateAsync([/* ... */]);

Imports the signing and encryption certificates that you need to create local (AS2) profiles and partner profiles.

Parameter Syntax

$result = $client->importCertificate([
    'ActiveDate' => <integer || string || DateTime>,
    'Certificate' => '<string>', // REQUIRED
    'CertificateChain' => '<string>',
    'Description' => '<string>',
    'InactiveDate' => <integer || string || DateTime>,
    'PrivateKey' => '<string>',
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'Usage' => 'SIGNING|ENCRYPTION', // REQUIRED
]);

Parameter Details

Members

ActiveDate

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

An optional date that specifies when the certificate becomes active.

Certificate

Required: Yes
Type: string

For the CLI, provide a file path for a certificate in URI format. For example, --certificate file://encryption-cert.pem. Alternatively, you can provide the raw content.
For the SDK, specify the raw content of a certificate file. For example, --certificate "`cat encryption-cert.pem`".

CertificateChain

Type: string

An optional list of certificates that make up the chain for the certificate that's being imported.

Description

Type: string

A short description that helps identify the certificate.

InactiveDate

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

An optional date that specifies when the certificate becomes inactive.

PrivateKey

Type: string

For the CLI, provide a file path for a private key in URI format.For example, --private-key file://encryption-key.pem. Alternatively, you can provide the raw content of the private key file.
For the SDK, specify the raw content of a private key file. For example, --private-key "`cat encryption-key.pem`"

Tags

Type: Array of Tag structures

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

Usage

Required: Yes
Type: string

Specifies whether this certificate is used for signing or encryption.

Result Syntax

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

Result Details

Members

CertificateId

Required: Yes
Type: string

An array of identifiers for the imported certificates. You use this identifier for working with profiles and partner profiles.

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.

ImportHostKey

$result = $client->importHostKey([/* ... */]);
$promise = $client->importHostKeyAsync([/* ... */]);

Adds a host key to the server that's specified by the ServerId parameter.

Parameter Syntax

$result = $client->importHostKey([
    'Description' => '<string>',
    'HostKeyBody' => '<string>', // REQUIRED
    'ServerId' => '<string>', // REQUIRED
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Members

Description

Type: string

The text description that identifies this host key.

HostKeyBody

Required: Yes
Type: string

The private key portion of an SSH key pair.

Transfer Family accepts RSA, ECDSA, and ED25519 keys.

ServerId

Required: Yes
Type: string

The identifier of the server that contains the host key that you are importing.

Tags

Type: Array of Tag structures

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

Result Syntax

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

Result Details

Members

HostKeyId

Required: Yes
Type: string

Returns the host key identifier for the imported key.

ServerId

Required: Yes
Type: string

Returns the server identifier that contains the imported key.

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.

ImportSshPublicKey

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

Adds a Secure Shell (SSH) public key to a Transfer Family user 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 Transfer Family user 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.

ListAgreements

$result = $client->listAgreements([/* ... */]);
$promise = $client->listAgreementsAsync([/* ... */]);

Returns a list of the agreements for the server that's identified by the ServerId that you supply. If you want to limit the results to a certain number, supply a value for the MaxResults parameter. If you ran the command previously and received a value for NextToken, you can supply that value to continue listing agreements from where you left off.

Parameter Syntax

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

Parameter Details

Members

MaxResults

Type: int

The maximum number of agreements to return.

NextToken

Type: string

When you can get additional results from the ListAgreements 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 agreements.

ServerId

Required: Yes
Type: string

The identifier of the server for which you want a list of agreements.

Result Syntax

[
    'Agreements' => [
        [
            'AgreementId' => '<string>',
            'Arn' => '<string>',
            'Description' => '<string>',
            'LocalProfileId' => '<string>',
            'PartnerProfileId' => '<string>',
            'ServerId' => '<string>',
            'Status' => 'ACTIVE|INACTIVE',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members

Agreements

Required: Yes
Type: Array of ListedAgreement structures

Returns an array, where each item contains the details of an agreement.

NextToken

Type: string

Returns a token that you can use to call ListAgreements again and receive additional results, if there are any.

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.

ListCertificates

$result = $client->listCertificates([/* ... */]);
$promise = $client->listCertificatesAsync([/* ... */]);

Returns a list of the current certificates that have been imported into Transfer Family. If you want to limit the results to a certain number, supply a value for the MaxResults parameter. If you ran the command previously and received a value for the NextToken parameter, you can supply that value to continue listing certificates from where you left off.

Parameter Syntax

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

Parameter Details

Members

MaxResults

Type: int

The maximum number of certificates to return.

NextToken

Type: string

When you can get additional results from the ListCertificates 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 certificates.

Result Syntax

[
    'Certificates' => [
        [
            'ActiveDate' => <DateTime>,
            'Arn' => '<string>',
            'CertificateId' => '<string>',
            'Description' => '<string>',
            'InactiveDate' => <DateTime>,
            'Status' => 'ACTIVE|PENDING_ROTATION|INACTIVE',
            'Type' => 'CERTIFICATE|CERTIFICATE_WITH_PRIVATE_KEY',
            'Usage' => 'SIGNING|ENCRYPTION',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members

Certificates

Required: Yes
Type: Array of ListedCertificate structures

Returns an array of the certificates that are specified in the ListCertificates call.

NextToken

Type: string

Returns the next token, which you can use to list the next certificate.

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.

ListConnectors

$result = $client->listConnectors([/* ... */]);
$promise = $client->listConnectorsAsync([/* ... */]);

Lists the connectors for the specified Region.

Parameter Syntax

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

Parameter Details

Members

MaxResults

Type: int

The maximum number of connectors to return.

NextToken

Type: string

When you can get additional results from the ListConnectors 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 connectors.

Result Syntax

[
    'Connectors' => [
        [
            'Arn' => '<string>',
            'ConnectorId' => '<string>',
            'Url' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members

Connectors

Required: Yes
Type: Array of ListedConnector structures

Returns an array, where each item contains the details of a connector.

NextToken

Type: string

Returns a token that you can use to call ListConnectors again and receive additional results, if there are any.

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 in-progress executions for the specified workflow.

If the specified workflow ID cannot be found, ListExecutions returns a ResourceNotFound exception.

Parameter Syntax

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

Parameter Details

Members

MaxResults

Type: int

Specifies the maximum 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, call the API by specifying 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, supplying 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, in a ListedExecution array.

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.

ListHostKeys

$result = $client->listHostKeys([/* ... */]);
$promise = $client->listHostKeysAsync([/* ... */]);

Returns a list of host keys for the server that's specified by the ServerId parameter.

Parameter Syntax

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

Parameter Details

Members

MaxResults

Type: int

The maximum number of host keys to return.

NextToken

Type: string

When there are additional results that were not returned, a NextToken parameter is returned. You can use that value for a subsequent call to ListHostKeys to continue listing results.

ServerId

Required: Yes
Type: string

The identifier of the server that contains the host keys that you want to view.

Result Syntax

[
    'HostKeys' => [
        [
            'Arn' => '<string>',
            'DateImported' => <DateTime>,
            'Description' => '<string>',
            'Fingerprint' => '<string>',
            'HostKeyId' => '<string>',
            'Type' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
    'ServerId' => '<string>',
]

Result Details

Members

HostKeys

Required: Yes
Type: Array of ListedHostKey structures

Returns an array, where each item contains the details of a host key.

NextToken

Type: string

Returns a token that you can use to call ListHostKeys again and receive additional results, if there are any.

ServerId

Required: Yes
Type: string

Returns the server identifier that contains the listed host keys.

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.

ListProfiles

$result = $client->listProfiles([/* ... */]);
$promise = $client->listProfilesAsync([/* ... */]);

Returns a list of the profiles for your system. If you want to limit the results to a certain number, supply a value for the MaxResults parameter. If you ran the command previously and received a value for NextToken, you can supply that value to continue listing profiles from where you left off.

Parameter Syntax

$result = $client->listProfiles([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'ProfileType' => 'LOCAL|PARTNER',
]);

Parameter Details

Members

MaxResults

Type: int

The maximum number of profiles to return.

NextToken

Type: string

When there are additional results that were not returned, a NextToken parameter is returned. You can use that value for a subsequent call to ListProfiles to continue listing results.

ProfileType

Type: string

Indicates whether to list only LOCAL type profiles or only PARTNER type profiles. If not supplied in the request, the command lists all types of profiles.

Result Syntax

[
    'NextToken' => '<string>',
    'Profiles' => [
        [
            'Arn' => '<string>',
            'As2Id' => '<string>',
            'ProfileId' => '<string>',
            'ProfileType' => 'LOCAL|PARTNER',
        ],
        // ...
    ],
]

Result Details

Members

NextToken

Type: string

Returns a token that you can use to call ListProfiles again and receive additional results, if there are any.

Profiles

Required: Yes
Type: Array of ListedProfile structures

Returns an array, where each item contains the details of a profile.

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 Transfer Family users 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 workflows associated with your Amazon Web Services account for your current region.

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.

StartFileTransfer

$result = $client->startFileTransfer([/* ... */]);
$promise = $client->startFileTransferAsync([/* ... */]);

Begins a file transfer between local Amazon Web Services storage and a remote AS2 or SFTP server.

For an AS2 connector, you specify the ConnectorId and one or more SendFilePaths to identify the files you want to transfer.
For an SFTP connector, the file transfer can be either outbound or inbound. In both cases, you specify the ConnectorId. Depending on the direction of the transfer, you also specify the following items:
- If you are transferring file from a partner's SFTP server to Amazon Web Services storage, you specify one or more RetreiveFilePaths to identify the files you want to transfer, and a LocalDirectoryPath to specify the destination folder.
- If you are transferring file to a partner's SFTP server from Amazon Web Services storage, you specify one or more SendFilePaths to identify the files you want to transfer, and a RemoteDirectoryPath to specify the destination folder.

Parameter Syntax

$result = $client->startFileTransfer([
    'ConnectorId' => '<string>', // REQUIRED
    'LocalDirectoryPath' => '<string>',
    'RemoteDirectoryPath' => '<string>',
    'RetrieveFilePaths' => ['<string>', ...],
    'SendFilePaths' => ['<string>', ...],
]);

Parameter Details

Members

ConnectorId

Required: Yes
Type: string

The unique identifier for the connector.

LocalDirectoryPath

Type: string

For an inbound transfer, the LocaDirectoryPath specifies the destination for one or more files that are transferred from the partner's SFTP server.

RemoteDirectoryPath

Type: string

For an outbound transfer, the RemoteDirectoryPath specifies the destination for one or more files that are transferred to the partner's SFTP server. If you don't specify a RemoteDirectoryPath, the destination for transferred files is the SFTP user's home directory.

RetrieveFilePaths

Type: Array of strings

One or more source paths for the partner's SFTP server. Each string represents a source file path for one inbound file transfer.

SendFilePaths

Type: Array of strings

One or more source paths for the Amazon S3 storage. Each string represents a source file path for one outbound file transfer. For example, DOC-EXAMPLE-BUCKET/myfile.txt .

Replace DOC-EXAMPLE-BUCKET with one of your actual buckets.

Result Syntax

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

Result Details

Members

TransferId

Required: Yes
Type: string

Returns the unique identifier for the file transfer.

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.

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 does 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 resources (servers, users, workflows, and so on) 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.

TestConnection

$result = $client->testConnection([/* ... */]);
$promise = $client->testConnectionAsync([/* ... */]);

Tests whether your SFTP connector is set up successfully. We highly recommend that you call this operation to test your ability to transfer files between a Transfer Family server and a trading partner's SFTP server.

Parameter Syntax

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

Parameter Details

Members

ConnectorId

Required: Yes
Type: string

The unique identifier for the connector.

Result Syntax

[
    'ConnectorId' => '<string>',
    'Status' => '<string>',
    'StatusMessage' => '<string>',
]

Result Details

Members

ConnectorId

Type: string

Returns the identifier of the connector object that you are testing.

Status

Type: string

Returns OK for successful test, or ERROR if the test fails.

StatusMessage

Type: string

Returns Connection succeeded if the test is successful. Or, returns a descriptive error message if the test fails. The following list provides the details for some error messages and troubleshooting steps for each.

Unable to access secrets manager: Verify that your secret name aligns with the one in Transfer Role permissions.
Unknown Host/Connection failed: Verify the server URL in the connector configuration , and verify that the login credentials work successfully outside of the connector.
Private key not found: Verify that the secret exists and is formatted correctly.
Invalid trusted host keys: Verify that the trusted host key in the connector configuration matches the ssh-keyscan output.

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.

Note the following:

You cannot use TestIdentityProvider if the IdentityProviderType of your server is SERVICE_MANAGED.
TestIdentityProvider does not work with keys: it only accepts passwords.
TestIdentityProvider can test the password operation for a custom Identity Provider that handles keys and passwords.
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.

It is possible your sever is in a different region. You can specify a region by adding the following: --region region-code, such as --region us-east-2 to specify a server in US East (Ohio).

Parameter Syntax

$result = $client->testIdentityProvider([
    'ServerId' => '<string>', // REQUIRED
    'ServerProtocol' => 'SFTP|FTP|FTPS|AS2',
    '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)
Applicability Statement 2 (AS2)

SourceIp

Type: string

The source IP address of the account to be tested.

UserName

Required: Yes
Type: string

The name of the account to be tested.

UserPassword

Type: string

The password of the 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 or your Lambda function.

StatusCode

Required: Yes
Type: int

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

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 policy applies only when the domain of ServerId is Amazon S3. Amazon 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 identifier 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 identifier 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.
ThrottlingException:
The request was denied due to request throttling.

UpdateAgreement

$result = $client->updateAgreement([/* ... */]);
$promise = $client->updateAgreementAsync([/* ... */]);

Updates some of the parameters for an existing agreement. Provide the AgreementId and the ServerId for the agreement that you want to update, along with the new values for the parameters to update.

Parameter Syntax

$result = $client->updateAgreement([
    'AccessRole' => '<string>',
    'AgreementId' => '<string>', // REQUIRED
    'BaseDirectory' => '<string>',
    'Description' => '<string>',
    'LocalProfileId' => '<string>',
    'PartnerProfileId' => '<string>',
    'ServerId' => '<string>', // REQUIRED
    'Status' => 'ACTIVE|INACTIVE',
]);

Parameter Details

Members

AccessRole

Type: string

Connectors are used to send files using either the AS2 or SFTP protocol. For the access role, provide the Amazon Resource Name (ARN) of the Identity and Access Management role to use.

For AS2 connectors

For SFTP connectors

AgreementId

Required: Yes
Type: string

A unique identifier for the agreement. This identifier is returned when you create an agreement.

BaseDirectory

Type: string

To change the landing directory (folder) for files that are transferred, provide the bucket folder that you want to use; for example, /DOC-EXAMPLE-BUCKET/home/mydirectory .

Description

Type: string

To replace the existing description, provide a short description for the agreement.

LocalProfileId

Type: string

A unique identifier for the AS2 local profile.

To change the local profile identifier, provide a new value here.

PartnerProfileId

Type: string

A unique identifier for the partner profile. To change the partner profile identifier, provide a new value here.

ServerId

Required: Yes
Type: string

A system-assigned unique identifier for a server instance. This is the specific server that the agreement uses.

Status

Type: string

You can update the status for the agreement, either activating an inactive agreement or the reverse.

Result Syntax

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

Result Details

Members

AgreementId

Required: Yes
Type: string

A unique identifier for the agreement. This identifier is returned when you create an agreement.

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.

UpdateCertificate

$result = $client->updateCertificate([/* ... */]);
$promise = $client->updateCertificateAsync([/* ... */]);

Updates the active and inactive dates for a certificate.

Parameter Syntax

$result = $client->updateCertificate([
    'ActiveDate' => <integer || string || DateTime>,
    'CertificateId' => '<string>', // REQUIRED
    'Description' => '<string>',
    'InactiveDate' => <integer || string || DateTime>,
]);

Parameter Details

Members

ActiveDate

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

An optional date that specifies when the certificate becomes active.

CertificateId

Required: Yes
Type: string

The identifier of the certificate object that you are updating.

Description

Type: string

A short description to help identify the certificate.

InactiveDate

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

An optional date that specifies when the certificate becomes inactive.

Result Syntax

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

Result Details

Members

CertificateId

Required: Yes
Type: string

Returns the identifier of the certificate object that you are updating.

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.

UpdateConnector

$result = $client->updateConnector([/* ... */]);
$promise = $client->updateConnectorAsync([/* ... */]);

Updates some of the parameters for an existing connector. Provide the ConnectorId for the connector that you want to update, along with the new values for the parameters to update.

Parameter Syntax

$result = $client->updateConnector([
    'AccessRole' => '<string>',
    'As2Config' => [
        'BasicAuthSecretId' => '<string>',
        'Compression' => 'ZLIB|DISABLED',
        'EncryptionAlgorithm' => 'AES128_CBC|AES192_CBC|AES256_CBC|NONE',
        'LocalProfileId' => '<string>',
        'MdnResponse' => 'SYNC|NONE',
        'MdnSigningAlgorithm' => 'SHA256|SHA384|SHA512|SHA1|NONE|DEFAULT',
        'MessageSubject' => '<string>',
        'PartnerProfileId' => '<string>',
        'SigningAlgorithm' => 'SHA256|SHA384|SHA512|SHA1|NONE',
    ],
    'ConnectorId' => '<string>', // REQUIRED
    'LoggingRole' => '<string>',
    'SftpConfig' => [
        'TrustedHostKeys' => ['<string>', ...],
        'UserSecretId' => '<string>',
    ],
    'Url' => '<string>',
]);

Parameter Details

Members

AccessRole

Type: string

Connectors are used to send files using either the AS2 or SFTP protocol. For the access role, provide the Amazon Resource Name (ARN) of the Identity and Access Management role to use.

For AS2 connectors

For SFTP connectors

As2Config

Type: As2ConnectorConfig structure

A structure that contains the parameters for an AS2 connector object.

ConnectorId

Required: Yes
Type: string

The unique identifier for the connector.

LoggingRole

Type: string

SftpConfig

Type: SftpConnectorConfig structure

A structure that contains the parameters for an SFTP connector object.

Url

Type: string

The URL of the partner's AS2 or SFTP endpoint.

Result Syntax

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

Result Details

Members

ConnectorId

Required: Yes
Type: string

Returns the identifier of the connector object that you are updating.

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.

UpdateHostKey

$result = $client->updateHostKey([/* ... */]);
$promise = $client->updateHostKeyAsync([/* ... */]);

Updates the description for the host key that's specified by the ServerId and HostKeyId parameters.

Parameter Syntax

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

Parameter Details

Members

Description

Required: Yes
Type: string

An updated description for the host key.

HostKeyId

Required: Yes
Type: string

The identifier of the host key that you are updating.

ServerId

Required: Yes
Type: string

The identifier of the server that contains the host key that you are updating.

Result Syntax

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

Result Details

Members

HostKeyId

Required: Yes
Type: string

Returns the host key identifier for the updated host key.

ServerId

Required: Yes
Type: string

Returns the server identifier for the server that contains the updated host key.

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.

UpdateProfile

$result = $client->updateProfile([/* ... */]);
$promise = $client->updateProfileAsync([/* ... */]);

Updates some of the parameters for an existing profile. Provide the ProfileId for the profile that you want to update, along with the new values for the parameters to update.

Parameter Syntax

$result = $client->updateProfile([
    'CertificateIds' => ['<string>', ...],
    'ProfileId' => '<string>', // REQUIRED
]);

Parameter Details

Members

CertificateIds

Type: Array of strings

An array of identifiers for the imported certificates. You use this identifier for working with profiles and partner profiles.

ProfileId

Required: Yes
Type: string

The identifier of the profile object that you are updating.

Result Syntax

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

Result Details

Members

ProfileId

Required: Yes
Type: string

Returns the identifier for the profile that's being updated.

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.

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>',
        'SftpAuthenticationMethods' => 'PASSWORD|PUBLIC_KEY|PUBLIC_KEY_OR_PASSWORD|PUBLIC_KEY_AND_PASSWORD',
        'Url' => '<string>',
    ],
    'LoggingRole' => '<string>',
    'PostAuthenticationLoginBanner' => '<string>',
    'PreAuthenticationLoginBanner' => '<string>',
    'ProtocolDetails' => [
        'As2Transports' => ['<string>', ...],
        'PassiveIp' => '<string>',
        'SetStatOption' => 'DEFAULT|ENABLE_NO_OP',
        'TlsSessionResumptionMode' => 'DISABLED|ENABLED|ENFORCED',
    ],
    'Protocols' => ['<string>', ...],
    'SecurityPolicyName' => '<string>',
    'ServerId' => '<string>', // REQUIRED
    'StructuredLogDestinations' => ['<string>', ...],
    'WorkflowDetails' => [
        'OnPartialUpload' => [
            [
                'ExecutionRole' => '<string>', // REQUIRED
                'WorkflowId' => '<string>', // REQUIRED
            ],
            // ...
        ],
        'OnUpload' => [
            [
                '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

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 by 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 Manage host keys for your SFTP-enabled server in the Transfer Family User Guide.

IdentityProviderDetails

Type: IdentityProviderDetails structure

An array containing all of the information required to call a customer's authentication API method.

LoggingRole

Type: string

PostAuthenticationLoginBanner

Type: string

Specifies 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

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

ProtocolDetails

Type: ProtocolDetails structure

The protocol settings that are configured for your server.

To indicate passive mode (for FTP and FTPS protocols), use the PassiveIp parameter. Enter a single dotted-quad IPv4 address, such as the external IP address of a firewall, router, or load balancer.
To ignore the error that is generated when the client attempts to use the SETSTAT command on a file that you are uploading to an Amazon S3 bucket, use the SetStatOption parameter. To have the Transfer Family server ignore the SETSTAT command and upload files without needing to make any changes to your SFTP client, set the value to ENABLE_NO_OP. If you set the SetStatOption parameter to ENABLE_NO_OP, Transfer Family generates a log entry to Amazon CloudWatch Logs, so that you can determine when the client is making a SETSTAT call.
To determine whether your Transfer Family server resumes recent, negotiated sessions through a unique session ID, use the TlsSessionResumptionMode parameter.
As2Transports indicates the transport method for the AS2 messages. Currently, only HTTP is supported.

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
AS2 (Applicability Statement 2): used for transporting structured business-to-business data

If you select FTPS, you must choose a certificate stored in 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 either AWS_DIRECTORY_SERVICE, AWS_LAMBDA, 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 any of the supported identity types: SERVICE_MANAGED, AWS_DIRECTORY_SERVICE, AWS_LAMBDA, or API_GATEWAY.
If Protocol includes AS2, then the EndpointType must be VPC, and domain must be Amazon S3.

SecurityPolicyName

Type: string

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

ServerId

Required: Yes
Type: string

A system-assigned unique identifier for a server instance that the Transfer Family user is assigned to.

StructuredLogDestinations

Type: Array of strings

Specifies the log groups to which your server logs are sent.

To specify a log group, you must provide the ARN for an existing log group. In this case, the format of the log group is as follows:

arn:aws:logs:region-name:amazon-account-id:log-group:log-group-name:*

For example, arn:aws:logs:us-east-1:111122223333:log-group:mytestgroup:*

update-server --server-id s-1234567890abcdef0 --structured-log-destinations

WorkflowDetails

Type: WorkflowDetails structure

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

To remove an associated workflow from a server, you can provide an empty OnUpload object, as in the following example.

aws transfer update-server --server-id s-01234567890abcdef --workflow-details '{"OnUpload":[]}'

Result Syntax

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

Result Details

Members

ServerId

Required: Yes
Type: string

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

Errors

AccessDeniedException:
You do not have sufficient access to perform this action.
ServiceUnavailableException:
The request has failed because the Amazon Web ServicesTransfer Family service is not available.
ConflictException:
This exception is thrown when the UpdateServer is called for a file transfer protocol-enabled server that has VPC as the endpoint type and the server's VpcEndpointID is not in the available state.
InternalServiceError:
This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family service.
InvalidRequestException:
This exception is thrown when the client submits a malformed request.
ResourceExistsException:
The requested resource does not exist.
ResourceNotFoundException:
This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.
ThrottlingException:
The request was denied due to request throttling.

UpdateUser

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

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

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

Parameter Syntax

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

Parameter Details

Members

HomeDirectory

Type: string

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

A HomeDirectory example is /bucket_name/home/mydirectory.

HomeDirectoryMappings

Type: Array of HomeDirectoryMapEntry structures

The following is an Entry and Target pair example.

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

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

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

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

HomeDirectoryType

Type: string

Policy

Type: string

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

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

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

PosixProfile

Type: PosixProfile structure

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

Role

Type: string

ServerId

Required: Yes
Type: string

A system-assigned unique identifier for a Transfer Family server instance that the user is assigned to.

UserName

Required: Yes
Type: string

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

Result Syntax

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

Result Details

Members

ServerId

Required: Yes
Type: string

A system-assigned unique identifier for a Transfer Family server instance that the account is assigned to.

UserName

Required: Yes
Type: string

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

Errors

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

Shapes

AccessDeniedException

Description

You do not have sufficient access to perform this action.

Members

Message

Type: string

As2ConnectorConfig

Description

Contains the details for an AS2 connector object. The connector object is used for AS2 outbound processes, to connect the Transfer Family customer with the trading partner.

Members

BasicAuthSecretId

Type: string

Provides Basic authentication support to the AS2 Connectors API. To use Basic authentication, you must provide the name or Amazon Resource Name (ARN) of a secret in Secrets Manager.

The default value for this parameter is null, which indicates that Basic authentication is not enabled for the connector.

If the connector should use Basic authentication, the secret needs to be in the following format:

{ "Username": "user-name", "Password": "user-password" }

Replace user-name and user-password with the credentials for the actual user that is being authenticated.

Note the following:

You are storing these credentials in Secrets Manager, not passing them directly into this API.
If you are using the API, SDKs, or CloudFormation to configure your connector, then you must create the secret before you can enable Basic authentication. However, if you are using the Amazon Web Services management console, you can have the system create the secret for you.

If you have previously enabled Basic authentication for a connector, you can disable it by using the UpdateConnector API call. For example, if you are using the CLI, you can run the following command to remove Basic authentication:

update-connector --connector-id my-connector-id --as2-config 'BasicAuthSecretId=""'

Compression

Type: string

Specifies whether the AS2 file is compressed.

EncryptionAlgorithm

Type: string

The algorithm that is used to encrypt the file.

You can only specify NONE if the URL for your connector uses HTTPS. This ensures that no traffic is sent in clear text.

LocalProfileId

Type: string

A unique identifier for the AS2 local profile.

MdnResponse

Type: string

Used for outbound requests (from an Transfer Family server to a partner AS2 server) to determine whether the partner response for transfers is synchronous or asynchronous. Specify either of the following values:

SYNC: The system expects a synchronous MDN response, confirming that the file was transferred successfully (or not).
NONE: Specifies that no MDN response is required.

MdnSigningAlgorithm

Type: string

The signing algorithm for the MDN response.

If set to DEFAULT (or not set at all), the value for SigningAlgorithm is used.

MessageSubject

Type: string

Used as the Subject HTTP header attribute in AS2 messages that are being sent with the connector.

PartnerProfileId

Type: string

A unique identifier for the partner profile for the connector.

SigningAlgorithm

Type: string

The algorithm that is used to sign the AS2 messages sent with the connector.

ConflictException

Description

This exception is thrown when the UpdateServer is called for a file transfer protocol-enabled server that has VPC as the endpoint type and the server's VpcEndpointID is not in the available state.

Members

Message

Required: Yes
Type: string

CopyStepDetails

Description

Each step type has its own StepDetails structure.

Members

DestinationFileLocation

Type: InputFileLocation structure

Specifies the location for the file being copied. Use ${Transfer:UserName} or ${Transfer:UploadDate} in this field to parametrize the destination prefix by username or uploaded date.

Set the value of DestinationFileLocation to ${Transfer:UserName} to copy uploaded files to an Amazon S3 bucket that is prefixed with the name of the Transfer Family user that uploaded the file.
Set the value of DestinationFileLocation to ${Transfer:UploadDate} to copy uploaded files to an Amazon S3 bucket that is prefixed with the date of the upload.

The system resolves UploadDate to a date format of YYYY-MM-DD, based on the date the file is uploaded in UTC.

Name

Type: string

The name of the step, used as an identifier.

OverwriteExisting

Type: string

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

If the workflow is processing a file that has the same name as an existing file, the behavior is as follows:

If OverwriteExisting is TRUE, the existing file is replaced with the file being processed.
If OverwriteExisting is FALSE, nothing happens, and the workflow processing stops.

SourceFileLocation

Type: string

Specifies which file to use as input to the workflow step: either the output from the previous step, or the originally uploaded file for the workflow.

To use the previous file as the input, enter ${previous.file}. In this case, this workflow step uses the output file from the previous workflow step as input. This is the default value.
To use the originally uploaded file location as input for this step, enter ${original.file}.

CustomStepDetails

Description

Each step type has its own StepDetails structure.

Members

Name

Type: string

The name of the step, used as an identifier.

SourceFileLocation

Type: string

Specifies which file to use as input to the workflow step: either the output from the previous step, or the originally uploaded file for the workflow.

To use the previous file as the input, enter ${previous.file}. In this case, this workflow step uses the output file from the previous workflow step as input. This is the default value.
To use the originally uploaded file location as input for this step, enter ${original.file}.

Target

Type: string

The ARN for the Lambda function that is being called.

TimeoutSeconds

Type: int

Timeout, in seconds, for the step.

DecryptStepDetails

Description

Each step type has its own StepDetails structure.

Members

DestinationFileLocation

Required: Yes
Type: InputFileLocation structure

Specifies the location for the file being decrypted. Use ${Transfer:UserName} or ${Transfer:UploadDate} in this field to parametrize the destination prefix by username or uploaded date.

Set the value of DestinationFileLocation to ${Transfer:UserName} to decrypt uploaded files to an Amazon S3 bucket that is prefixed with the name of the Transfer Family user that uploaded the file.
Set the value of DestinationFileLocation to ${Transfer:UploadDate} to decrypt uploaded files to an Amazon S3 bucket that is prefixed with the date of the upload.

The system resolves UploadDate to a date format of YYYY-MM-DD, based on the date the file is uploaded in UTC.

Name

Type: string

The name of the step, used as an identifier.

OverwriteExisting

Type: string

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

If the workflow is processing a file that has the same name as an existing file, the behavior is as follows:

If OverwriteExisting is TRUE, the existing file is replaced with the file being processed.
If OverwriteExisting is FALSE, nothing happens, and the workflow processing stops.

SourceFileLocation

Type: string

Specifies which file to use as input to the workflow step: either the output from the previous step, or the originally uploaded file for the workflow.

To use the previous file as the input, enter ${previous.file}. In this case, this workflow step uses the output file from the previous workflow step as input. This is the default value.
To use the originally uploaded file location as input for this step, enter ${original.file}.

Type

Required: Yes
Type: string

The type of encryption used. Currently, this value must be PGP.

DeleteStepDetails

Description

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

Members

Name

Type: string

The name of the step, used as an identifier.

SourceFileLocation

Type: string

Specifies which file to use as input to the workflow step: either the output from the previous step, or the originally uploaded file for the workflow.

To use the previous file as the input, enter ${previous.file}. In this case, this workflow step uses the output file from the previous workflow step as input. This is the default value.
To use the originally uploaded file location as input for this step, enter ${original.file}.

DescribedAccess

Description

Describes the properties of the access that was specified.

Members

ExternalId

Type: string

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

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

HomeDirectory

Type: string

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

A HomeDirectory example is /bucket_name/home/mydirectory.

HomeDirectoryMappings

Type: Array of HomeDirectoryMapEntry structures

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

HomeDirectoryType

Type: string

Policy

Type: string

PosixProfile

Type: PosixProfile structure

Role

Type: string

DescribedAgreement

Description

Describes the properties of an agreement.

Members

AccessRole

Type: string

Connectors are used to send files using either the AS2 or SFTP protocol. For the access role, provide the Amazon Resource Name (ARN) of the Identity and Access Management role to use.

For AS2 connectors

For SFTP connectors

AgreementId

Type: string

A unique identifier for the agreement. This identifier is returned when you create an agreement.

Arn

Required: Yes
Type: string

The unique Amazon Resource Name (ARN) for the agreement.

BaseDirectory

Type: string

The landing directory (folder) for files that are transferred by using the AS2 protocol.

Description

Type: string

The name or short description that's used to identify the agreement.

LocalProfileId

Type: string

A unique identifier for the AS2 local profile.

PartnerProfileId

Type: string

A unique identifier for the partner profile used in the agreement.

ServerId

Type: string

A system-assigned unique identifier for a server instance. This identifier indicates the specific server that the agreement uses.

Status

Type: string

The current status of the agreement, either ACTIVE or INACTIVE.

Tags

Type: Array of Tag structures

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

DescribedCertificate

Description

Describes the properties of a certificate.

Members

ActiveDate

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

An optional date that specifies when the certificate becomes active.

Arn

Required: Yes
Type: string

The unique Amazon Resource Name (ARN) for the certificate.

Certificate

Type: string

The file name for the certificate.

CertificateChain

Type: string

The list of certificates that make up the chain for the certificate.

CertificateId

Type: string

An array of identifiers for the imported certificates. You use this identifier for working with profiles and partner profiles.

Description

Type: string

The name or description that's used to identity the certificate.

InactiveDate

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

An optional date that specifies when the certificate becomes inactive.

NotAfterDate

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

The final date that the certificate is valid.

NotBeforeDate

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

The earliest date that the certificate is valid.

Serial

Type: string

The serial number for the certificate.

Status

Type: string

The certificate can be either ACTIVE, PENDING_ROTATION, or INACTIVE. PENDING_ROTATION means that this certificate will replace the current certificate when it expires.

Tags

Type: Array of Tag structures

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

Type

Type: string

If a private key has been specified for the certificate, its type is CERTIFICATE_WITH_PRIVATE_KEY. If there is no private key, the type is CERTIFICATE.

Usage

Type: string

Specifies whether this certificate is used for signing or encryption.

DescribedConnector

Description

Describes the parameters for the connector, as identified by the ConnectorId.

Members

AccessRole

Type: string

Connectors are used to send files using either the AS2 or SFTP protocol. For the access role, provide the Amazon Resource Name (ARN) of the Identity and Access Management role to use.

For AS2 connectors

For SFTP connectors

Arn

Required: Yes
Type: string

The unique Amazon Resource Name (ARN) for the connector.

As2Config

Type: As2ConnectorConfig structure

A structure that contains the parameters for an AS2 connector object.

ConnectorId

Type: string

The unique identifier for the connector.

LoggingRole

Type: string

SftpConfig

Type: SftpConnectorConfig structure

A structure that contains the parameters for an SFTP connector object.

Tags

Type: Array of Tag structures

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

Url

Type: string

The URL of the partner's AS2 or SFTP endpoint.

DescribedExecution

Description

The details for an execution object.

Members

ExecutionId

Type: string

A unique identifier for the execution of a workflow.

ExecutionRole

Type: string

The IAM role associated with the execution.

InitialFileLocation

Type: FileLocation structure

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

LoggingConfiguration

Type: LoggingConfiguration structure

The IAM logging role associated with the execution.

PosixProfile

Type: PosixProfile structure

Results

Type: ExecutionResults structure

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

ServiceMetadata

Type: ServiceMetadata structure

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

Status

Type: string

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

DescribedHostKey

Description

The details for a server host key.

Members

Arn

Required: Yes
Type: string

The unique Amazon Resource Name (ARN) for the host key.

DateImported

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

The date on which the host key was added to the server.

Description

Type: string

The text description for this host key.

HostKeyFingerprint

Type: string

The public key fingerprint, which is a short sequence of bytes used to identify the longer public key.

HostKeyId

Type: string

A unique identifier for the host key.

Tags

Type: Array of Tag structures

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

Type

Type: string

The encryption algorithm that is used for the host key. The Type parameter is specified by using one of the following values:

ssh-rsa
ssh-ed25519
ecdsa-sha2-nistp256
ecdsa-sha2-nistp384
ecdsa-sha2-nistp521

DescribedProfile

Description

The details for a local or partner AS2 profile.

Members

Arn

Required: Yes
Type: string

The unique Amazon Resource Name (ARN) for the profile.

As2Id

Type: string

CertificateIds

Type: Array of strings

An array of identifiers for the imported certificates. You use this identifier for working with profiles and partner profiles.

ProfileId

Type: string

A unique identifier for the local or partner AS2 profile.

ProfileType

Type: string

Indicates whether to list only LOCAL type profiles or only PARTNER type profiles. If not supplied in the request, the command lists all types of profiles.

Tags

Type: Array of Tag structures

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

DescribedSecurityPolicy

Description

Describes the properties of a security policy that was specified. For more information about security policies, see Working with security policies.

Members

Fips

Type: boolean

Specifies whether this policy enables Federal Information Processing Standards (FIPS).

SecurityPolicyName

Required: Yes
Type: string

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

SshCiphers

Type: Array of strings

Specifies the enabled Secure Shell (SSH) cipher encryption algorithms in the security policy that is attached to the server.

SshKexs

Type: Array of strings

Specifies the enabled SSH key exchange (KEX) encryption algorithms in the security policy that is attached to the server.

SshMacs

Type: Array of strings

Specifies the enabled SSH message authentication code (MAC) encryption algorithms in the security policy that is attached to the server.

TlsCiphers

Type: Array of strings

Specifies the enabled Transport Layer Security (TLS) cipher encryption algorithms in the security policy that is attached to the server.

DescribedServer

Description

Describes the properties of a file transfer protocol-enabled server that was specified.

Members

Arn

Required: Yes
Type: string

Specifies the unique Amazon Resource Name (ARN) of the server.

Certificate

Type: string

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

Domain

Type: string

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

EndpointDetails

Type: EndpointDetails structure

EndpointType

Type: string

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

HostKeyFingerprint

Type: string

Specifies the Base64-encoded SHA256 fingerprint of the server's host key. This value is equivalent to the output of the ssh-keygen -l -f my-new-server-key command.

IdentityProviderDetails

Type: IdentityProviderDetails structure

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

IdentityProviderType

Type: string

The mode of authentication for a server. The default value is SERVICE_MANAGED, which allows you to store and access user credentials within the Transfer Family service.

LoggingRole

Type: string

PostAuthenticationLoginBanner

Type: string

Specifies 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

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

ProtocolDetails

Type: ProtocolDetails structure

The protocol settings that are configured for your server.

To indicate passive mode (for FTP and FTPS protocols), use the PassiveIp parameter. Enter a single dotted-quad IPv4 address, such as the external IP address of a firewall, router, or load balancer.
To ignore the error that is generated when the client attempts to use the SETSTAT command on a file that you are uploading to an Amazon S3 bucket, use the SetStatOption parameter. To have the Transfer Family server ignore the SETSTAT command and upload files without needing to make any changes to your SFTP client, set the value to ENABLE_NO_OP. If you set the SetStatOption parameter to ENABLE_NO_OP, Transfer Family generates a log entry to Amazon CloudWatch Logs, so that you can determine when the client is making a SETSTAT call.
To determine whether your Transfer Family server resumes recent, negotiated sessions through a unique session ID, use the TlsSessionResumptionMode parameter.
As2Transports indicates the transport method for the AS2 messages. Currently, only HTTP is supported.

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
AS2 (Applicability Statement 2): used for transporting structured business-to-business data

If you select FTPS, you must choose a certificate stored in 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 either AWS_DIRECTORY_SERVICE, AWS_LAMBDA, 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 any of the supported identity types: SERVICE_MANAGED, AWS_DIRECTORY_SERVICE, AWS_LAMBDA, or API_GATEWAY.
If Protocol includes AS2, then the EndpointType must be VPC, and domain must be Amazon S3.

SecurityPolicyName

Type: string

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

ServerId

Type: string

Specifies the unique system-assigned identifier for a server that you instantiate.

State

Type: string

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

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

StructuredLogDestinations

Type: Array of strings

Specifies the log groups to which your server logs are sent.

To specify a log group, you must provide the ARN for an existing log group. In this case, the format of the log group is as follows:

arn:aws:logs:region-name:amazon-account-id:log-group:log-group-name:*

For example, arn:aws:logs:us-east-1:111122223333:log-group:mytestgroup:*

update-server --server-id s-1234567890abcdef0 --structured-log-destinations

Tags

Type: Array of Tag structures

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

UserCount

Type: int

Specifies the number of users that are assigned to a server you specified with the ServerId.

WorkflowDetails

Type: WorkflowDetails structure

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

DescribedUser

Description

Describes the properties of a user that was specified.

Members

Arn

Required: Yes
Type: string

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

HomeDirectory

Type: string

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

A HomeDirectory example is /bucket_name/home/mydirectory.

HomeDirectoryMappings

Type: Array of HomeDirectoryMapEntry structures

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

HomeDirectoryType

Type: string

Policy

Type: string

PosixProfile

Type: PosixProfile structure

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

Role

Type: string

SshPublicKeys

Type: Array of SshPublicKey structures

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

Tags

Type: Array of Tag structures

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

UserName

Type: string

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

DescribedWorkflow

Description

Describes the properties of the specified workflow

Members

Arn

Required: Yes
Type: string

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

Description

Type: string

Specifies the text description for the workflow.

OnExceptionSteps

Type: Array of WorkflowStep structures

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

Steps

Type: Array of WorkflowStep structures

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

Tags

Type: Array of Tag structures

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

WorkflowId

Type: string

A unique identifier for the workflow.

EfsFileLocation

Description

Specifies the details for the file location for the file that's being used in the workflow. Only applicable if you are using Amazon Elastic File Systems (Amazon EFS) for storage.

Members

FileSystemId

Type: string

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

Path

Type: string

The pathname for the folder being used by a workflow.

EndpointDetails

Description

The virtual private cloud (VPC) endpoint settings that are configured for your file transfer protocol-enabled server. With a VPC endpoint, you can restrict access to your server and resources only within your VPC. To control incoming internet traffic, invoke the UpdateServer API and attach an Elastic IP address to your server's endpoint.

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

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

Members

AddressAllocationIds

Type: Array of strings

A list of address allocation IDs that are required to attach an Elastic IP address to your server's endpoint.

This property can only be set when EndpointType is set to VPC and it is only valid in the UpdateServer API.

SecurityGroupIds

Type: Array of strings

A list of security groups IDs that are available to attach to your server's endpoint.

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

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

SubnetIds

Type: Array of strings

A list of subnet IDs that are required to host your server endpoint in your VPC.

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

VpcEndpointId

Type: string

The identifier of the VPC endpoint.

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

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

VpcId

Type: string

The VPC identifier of the VPC in which a server's endpoint will be hosted.

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

ExecutionError

Description

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

Members

Message

Required: Yes
Type: string

Specifies the descriptive message that corresponds to the ErrorType.

Type

Required: Yes
Type: string

Specifies the error type.

ALREADY_EXISTS: occurs for a copy step, if the overwrite option is not selected and a file with the same name already exists in the target location.
BAD_REQUEST: a general bad request: for example, a step that attempts to tag an EFS file returns BAD_REQUEST, as only S3 files can be tagged.
CUSTOM_STEP_FAILED: occurs when the custom step provided a callback that indicates failure.
INTERNAL_SERVER_ERROR: a catch-all error that can occur for a variety of reasons.
NOT_FOUND: occurs when a requested entity, for example a source file for a copy step, does not exist.
PERMISSION_DENIED: occurs if your policy does not contain the correct permissions to complete one or more of the steps in the workflow.
TIMEOUT: occurs when the execution times out.

You can set the TimeoutSeconds for a custom step, anywhere from 1 second to 1800 seconds (30 minutes).
THROTTLED: occurs if you exceed the new execution refill rate of one workflow per second.

ExecutionResults

Description

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

Members

OnExceptionSteps

Type: Array of ExecutionStepResult structures

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

Steps

Type: Array of ExecutionStepResult structures

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

ExecutionStepResult

Description

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

Members

Error

Type: ExecutionError structure

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

Outputs

Type: string

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

StepType

Type: string

One of the available step types.

COPY - Copy the file to another location.
CUSTOM - Perform a custom step with an Lambda function target.
DECRYPT - Decrypt a file that was encrypted before it was uploaded.
DELETE - Delete the file.
TAG - Add a tag to the file.

FileLocation

Description

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

Members

EfsFileLocation

Type: EfsFileLocation structure

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

S3FileLocation

Type: S3FileLocation structure

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

HomeDirectoryMapEntry

Description

Represents an object that contains entries and targets for HomeDirectoryMappings.

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

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

Members

Entry

Required: Yes
Type: string

Represents an entry for HomeDirectoryMappings.

Target

Required: Yes
Type: string

Represents the map target that is used in a HomeDirectorymapEntry.

IdentityProviderDetails

Description

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

Members

DirectoryId

Type: string

The identifier of the Directory Service directory that you want to stop sharing.

Function

Type: string

The ARN for a Lambda function to use for the Identity provider.

InvocationRole

Type: string

This parameter is only applicable if your IdentityProviderType is API_GATEWAY. Provides the type of InvocationRole used to authenticate the user account.

SftpAuthenticationMethods

Type: string

For SFTP-enabled servers, and for custom identity providers only, you can specify whether to authenticate using a password, SSH key pair, or both.

PASSWORD - users must provide their password to connect.
PUBLIC_KEY - users must provide their private key to connect.
PUBLIC_KEY_OR_PASSWORD - users can authenticate with either their password or their key. This is the default value.
PUBLIC_KEY_AND_PASSWORD - users must provide both their private key and their password to connect. The server checks the key first, and then if the key is valid, the system prompts for a password. If the private key provided does not match the public key that is stored, authentication fails.

Url

Type: string

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

InputFileLocation

Description

Specifies the location for the file that's being processed.

Members

EfsFileLocation

Type: EfsFileLocation structure

Specifies the details for the Amazon Elastic File System (Amazon EFS) file that's being decrypted.

S3FileLocation

Type: S3InputFileLocation structure

Specifies the details for the Amazon S3 file that's being copied or decrypted.

InternalServiceError

Description

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

Members

Message

Required: Yes
Type: string

InvalidNextTokenException

Description

The NextToken parameter that was passed is invalid.

Members

Message

Required: Yes
Type: string

InvalidRequestException

Description

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

Members

Message

Required: Yes
Type: string

ListedAccess

Description

Lists the properties for one or more specified associated accesses.

Members

ExternalId

Type: string

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

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

HomeDirectory

Type: string

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

A HomeDirectory example is /bucket_name/home/mydirectory.

HomeDirectoryType

Type: string

Role

Type: string

ListedAgreement

Description

Describes the properties of an agreement.

Members

AgreementId

Type: string

A unique identifier for the agreement. This identifier is returned when you create an agreement.

Arn

Type: string

The Amazon Resource Name (ARN) of the specified agreement.

Description

Type: string

The current description for the agreement. You can change it by calling the UpdateAgreement operation and providing a new description.

LocalProfileId

Type: string

A unique identifier for the AS2 local profile.

PartnerProfileId

Type: string

A unique identifier for the partner profile.

ServerId

Type: string

The unique identifier for the agreement.

Status

Type: string

The agreement can be either ACTIVE or INACTIVE.

ListedCertificate

Description

Describes the properties of a certificate.

Members

ActiveDate

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

An optional date that specifies when the certificate becomes active.

Arn

Type: string

The Amazon Resource Name (ARN) of the specified certificate.

CertificateId

Type: string

An array of identifiers for the imported certificates. You use this identifier for working with profiles and partner profiles.

Description

Type: string

The name or short description that's used to identify the certificate.

InactiveDate

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

An optional date that specifies when the certificate becomes inactive.

Status

Type: string

The certificate can be either ACTIVE, PENDING_ROTATION, or INACTIVE. PENDING_ROTATION means that this certificate will replace the current certificate when it expires.

Type

Type: string

The type for the certificate. If a private key has been specified for the certificate, its type is CERTIFICATE_WITH_PRIVATE_KEY. If there is no private key, the type is CERTIFICATE.

Usage

Type: string

Specifies whether this certificate is used for signing or encryption.

ListedConnector

Description

Returns details of the connector that is specified.

Members

Arn

Type: string

The Amazon Resource Name (ARN) of the specified connector.

ConnectorId

Type: string

The unique identifier for the connector.

Url

Type: string

The URL of the partner's AS2 or SFTP endpoint.

ListedExecution

Description

Returns properties of the execution that is specified.

Members

ExecutionId

Type: string

A unique identifier for the execution of a workflow.

InitialFileLocation

Type: FileLocation structure

ServiceMetadata

Type: ServiceMetadata structure

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

Status

Type: string

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

ListedHostKey

Description

Returns properties of the host key that's specified.

Members

Arn

Required: Yes
Type: string

The unique Amazon Resource Name (ARN) of the host key.

DateImported

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

The date on which the host key was added to the server.

Description

Type: string

The current description for the host key. You can change it by calling the UpdateHostKey operation and providing a new description.

Fingerprint

Type: string

The public key fingerprint, which is a short sequence of bytes used to identify the longer public key.

HostKeyId

Type: string

A unique identifier for the host key.

Type

Type: string

The encryption algorithm that is used for the host key. The Type parameter is specified by using one of the following values:

ssh-rsa
ssh-ed25519
ecdsa-sha2-nistp256
ecdsa-sha2-nistp384
ecdsa-sha2-nistp521

ListedProfile

Description

Returns the properties of the profile that was specified.

Members

Arn

Type: string

The Amazon Resource Name (ARN) of the specified profile.

As2Id

Type: string

ProfileId

Type: string

A unique identifier for the local or partner AS2 profile.

ProfileType

Type: string

Indicates whether to list only LOCAL type profiles or only PARTNER type profiles. If not supplied in the request, the command lists all types of profiles.

ListedServer

Description

Returns properties of a file transfer protocol-enabled server that was specified.

Members

Arn

Required: Yes
Type: string

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

Domain

Type: string

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

EndpointType

Type: string

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

IdentityProviderType

Type: string

The mode of authentication for a server. The default value is SERVICE_MANAGED, which allows you to store and access user credentials within the Transfer Family service.

LoggingRole

Type: string

ServerId

Type: string

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

State

Type: string

UserCount

Type: int

Specifies the number of users that are assigned to a server you specified with the ServerId.

ListedUser

Description

Returns properties of the user that you specify.

Members

Arn

Required: Yes
Type: string

Provides the unique Amazon Resource Name (ARN) for the user that you want to learn about.

HomeDirectory

Type: string

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

A HomeDirectory example is /bucket_name/home/mydirectory.

HomeDirectoryType

Type: string

Role

Type: string

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

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

SshPublicKeyCount

Type: int

Specifies the number of SSH public keys stored for the user you specified.

UserName

Type: string

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

ListedWorkflow

Description

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

Members

Arn

Type: string

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

Description

Type: string

Specifies the text description for the workflow.

WorkflowId

Type: string

A unique identifier for the workflow.

LoggingConfiguration

Description

Consists of the logging role and the log group name.

Members

LogGroupName

Type: string

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

LoggingRole

Type: string

PosixProfile

Description

Members

Gid

Required: Yes
Type: long (int|float)

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

SecondaryGids

Type: Array of long (int|float)s

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

Uid

Required: Yes
Type: long (int|float)

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

ProtocolDetails

Description

The protocol settings that are configured for your server.

Members

As2Transports

Type: Array of strings

Indicates the transport method for the AS2 messages. Currently, only HTTP is supported.

PassiveIp

Type: string

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

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

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

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

Special values

The AUTO and 0.0.0.0 are special values for the PassiveIp parameter. The value PassiveIp=AUTO is assigned by default to FTP and FTPS type servers. In this case, the server automatically responds with one of the endpoint IPs within the PASV response. PassiveIp=0.0.0.0 has a more unique application for its usage. For example, if you have a High Availability (HA) Network Load Balancer (NLB) environment, where you have 3 subnets, you can only specify a single IP address using the PassiveIp parameter. This reduces the effectiveness of having High Availability. In this case, you can specify PassiveIp=0.0.0.0. This tells the client to use the same IP address as the Control connection and utilize all AZs for their connections. Note, however, that not all FTP clients support the PassiveIp=0.0.0.0 response. FileZilla and WinSCP do support it. If you are using other clients, check to see if your client supports the PassiveIp=0.0.0.0 response.

SetStatOption

Type: string

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.

Some SFTP file transfer clients can attempt to change the attributes of remote files, including timestamp and permissions, using commands, such as SETSTAT when uploading the file. However, these commands are not compatible with object storage systems, such as Amazon S3. Due to this incompatibility, file uploads from these clients can result in errors even when the file is otherwise successfully uploaded.

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. While the SetStatOption ENABLE_NO_OP setting ignores the error, it does generate a log entry in Amazon CloudWatch Logs, so you can determine when the client is making a SETSTAT call.

If you want to preserve the original timestamp for your file, and modify other file attributes using SETSTAT, you can use Amazon EFS as backend storage with Transfer Family.

TlsSessionResumptionMode

Type: string

A property used with Transfer Family servers that use the FTPS protocol. TLS Session Resumption provides a mechanism to resume or share a negotiated secret key between the control and data connection for an FTPS session. TlsSessionResumptionMode determines whether or not the server resumes recent, negotiated sessions through a unique session ID. This property is available during CreateServer and UpdateServer calls. If a TlsSessionResumptionMode value is not specified during CreateServer, it is set to ENFORCED by default.

DISABLED: the server does not process TLS session resumption client requests and creates a new TLS session for each request.
ENABLED: the server processes and accepts clients that are performing TLS session resumption. The server doesn't reject client data connections that do not perform the TLS session resumption client processing.
ENFORCED: the server processes and accepts clients that are performing TLS session resumption. The server rejects client data connections that do not perform the TLS session resumption client processing. Before you set the value to ENFORCED, test your clients.

Not all FTPS clients perform TLS session resumption. So, if you choose to enforce TLS session resumption, you prevent any connections from FTPS clients that don't perform the protocol negotiation. To determine whether or not you can use the ENFORCED value, you need to test your clients.

ResourceExistsException

Description

The requested resource does not exist.

Members

Message

Required: Yes
Type: string

Resource

Required: Yes
Type: string

ResourceType

Required: Yes
Type: string

ResourceNotFoundException

Description

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

Members

Message

Required: Yes
Type: string

Resource

Required: Yes
Type: string

ResourceType

Required: Yes
Type: string

S3FileLocation

Description

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

Members

Bucket

Type: string

Specifies the S3 bucket that contains the file being used.

Etag

Type: string

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

Key

Type: string

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

VersionId

Type: string

Specifies the file version.

S3InputFileLocation

Description

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

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

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

Members

Bucket

Type: string

Specifies the S3 bucket for the customer input file.

Key

Type: string

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

S3Tag

Description

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

Members

Key

Required: Yes
Type: string

The name assigned to the tag that you create.

Value

Required: Yes
Type: string

The value that corresponds to the key.

ServiceMetadata

Description

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

Members

UserDetails

Required: Yes
Type: UserDetails structure

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

ServiceUnavailableException

Description

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

Members

Message

Type: string

SftpConnectorConfig

Description

Contains the details for an SFTP connector object. The connector object is used for transferring files to and from a partner's SFTP server.

Members

TrustedHostKeys

Type: Array of strings

The public portion of the host key, or keys, that are used to authenticate the user to the external server to which you are connecting. You can use the ssh-keyscan command against the SFTP server to retrieve the necessary key.

The three standard SSH public key format elements are <key type>, <body base64>, and an optional <comment>, with spaces between each element.

For the trusted host key, Transfer Family accepts RSA and ECDSA keys.

For RSA keys, the key type is ssh-rsa.
For ECDSA keys, the key type is either ecdsa-sha2-nistp256, ecdsa-sha2-nistp384, or ecdsa-sha2-nistp521, depending on the size of the key you generated.

UserSecretId

Type: string

The identifier for the secret (in Amazon Web Services Secrets Manager) that contains the SFTP user's private key, password, or both. The identifier can be either the Amazon Resource Name (ARN) or the name of the secret.

SshPublicKey

Description

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

Members

DateImported

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

Specifies the date that the public key was added to the Transfer Family user.

SshPublicKeyBody

Required: Yes
Type: string

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

Transfer Family accepts RSA, ECDSA, and ED25519 keys.

SshPublicKeyId

Required: Yes
Type: string

Specifies the SshPublicKeyId parameter contains the identifier of the public key.

Tag

Description

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

Members

Key

Required: Yes
Type: string

The name assigned to the tag that you create.

Value

Required: Yes
Type: string

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

TagStepDetails

Description

Each step type has its own StepDetails structure.

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

Members

Name

Type: string

The name of the step, used as an identifier.

SourceFileLocation

Type: string

Specifies which file to use as input to the workflow step: either the output from the previous step, or the originally uploaded file for the workflow.

To use the previous file as the input, enter ${previous.file}. In this case, this workflow step uses the output file from the previous workflow step as input. This is the default value.
To use the originally uploaded file location as input for this step, enter ${original.file}.

Tags

Type: Array of S3Tag structures

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

ThrottlingException

Description

The request was denied due to request throttling.

Members

RetryAfterSeconds

Type: string

UserDetails

Description

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

Members

ServerId

Required: Yes
Type: string

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

SessionId

Type: string

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

UserName

Required: Yes
Type: string

A unique string that identifies a Transfer Family user associated with a server.

WorkflowDetail

Description

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

Members

ExecutionRole

Required: Yes
Type: string

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

WorkflowId

Required: Yes
Type: string

A unique identifier for the workflow.

WorkflowDetails

Description

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

Members

OnPartialUpload

Type: Array of WorkflowDetail structures

A trigger that starts a workflow if a file is only partially uploaded. You can attach a workflow to a server that executes whenever there is a partial upload.

A partial upload occurs when a file is open when the session disconnects.

OnUpload

Type: Array of WorkflowDetail structures

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

To remove an associated workflow from a server, you can provide an empty OnUpload object, as in the following example.

aws transfer update-server --server-id s-01234567890abcdef --workflow-details '{"OnUpload":[]}'

WorkflowStep

Description

The basic building block of a workflow.

Members

CopyStepDetails

Type: CopyStepDetails structure

Details for a step that performs a file copy.

Consists of the following values:

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

CustomStepDetails

Type: CustomStepDetails structure

Details for a step that invokes an Lambda function.

Consists of the Lambda function's name, target, and timeout (in seconds).

DecryptStepDetails

Type: DecryptStepDetails structure

Details for a step that decrypts an encrypted file.

Consists of the following values:

A descriptive name
An Amazon S3 or Amazon Elastic File System (Amazon EFS) location for the source file to decrypt.
An S3 or Amazon EFS location for the destination of the file decryption.
A flag that indicates whether to overwrite an existing file of the same name. The default is FALSE.
The type of encryption that's used. Currently, only PGP encryption is supported.

DeleteStepDetails

Type: DeleteStepDetails structure

Details for a step that deletes the file.

TagStepDetails

Type: TagStepDetails structure

Details for a step that creates one or more tags.

You specify one or more tags. Each tag contains a key-value pair.

Type

Type: string

Currently, the following step types are supported.

COPY - Copy the file to another location.
CUSTOM - Perform a custom step with an Lambda function target.
DECRYPT - Decrypt a file that was encrypted before it was uploaded.
DELETE - Delete the file.
TAG - Add a tag to the file.

Namespaces

Classes

Interfaces

Traits

Exceptions

Functions

AWS Transfer Family 2018-11-05

Operation Summary

Paginators

Waiters

Operations

CreateAccess

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CreateAgreement

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CreateConnector

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CreateProfile

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CreateServer

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CreateUser

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CreateWorkflow

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

DeleteAccess

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

DeleteAgreement

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details