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
            'Type' => 'FILE|DIRECTORY',
        ],
        // ...
    ],
    'HomeDirectoryType' => 'PATH|LOGICAL',
    'Policy' => '<string>',
    'PosixProfile' => [
        'Gid' => <integer>, // REQUIRED
        'SecondaryGids' => [<integer>, ...],
        'Uid' => <integer>, // REQUIRED
    ],
    'Role' => '<string>', // REQUIRED
    'ServerId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

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

Result Details

Errors

ResourceNotFoundException:

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

InvalidRequestException:

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

InternalServiceError:

This exception is thrown when an error occurs in the Transfer Family service.

ServiceUnavailableException:

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

ResourceExistsException:

The requested resource does not exist, or exists in a region other than the one specified for the command.

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

Result Syntax

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

Result Details

Errors

ResourceNotFoundException:

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

InvalidRequestException:

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

ThrottlingException:

The request was denied due to request throttling.

InternalServiceError:

This exception is thrown when an error occurs in the Transfer Family service.

ServiceUnavailableException:

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

ResourceExistsException:

The requested resource does not exist, or exists in a region other than the one specified for the command.

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 Configure AS2 connectors and Create SFTP connectors.

Parameter Syntax

$result = $client->createConnector([
    'AccessRole' => '<string>', // REQUIRED
    'As2Config' => [
        'BasicAuthSecretId' => '<string>',
        'Compression' => 'ZLIB|DISABLED',
        'EncryptionAlgorithm' => 'AES128_CBC|AES192_CBC|AES256_CBC|DES_EDE3_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>',
    'SecurityPolicyName' => '<string>',
    'SftpConfig' => [
        'TrustedHostKeys' => ['<string>', ...],
        'UserSecretId' => '<string>',
    ],
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'Url' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

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

Result Details

Errors

ResourceNotFoundException:

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

InvalidRequestException:

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

ThrottlingException:

The request was denied due to request throttling.

InternalServiceError:

This exception is thrown when an error occurs in the Transfer Family service.

ServiceUnavailableException:

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

ResourceExistsException:

The requested resource does not exist, or exists in a region other than the one specified for the command.

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

Result Syntax

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

Result Details

Errors

ResourceNotFoundException:

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

InvalidRequestException:

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

ThrottlingException:

The request was denied due to request throttling.

InternalServiceError:

This exception is thrown when an error occurs in the Transfer Family service.

ServiceUnavailableException:

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

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>', ...],
    'S3StorageOptions' => [
        'DirectoryListingOptimization' => 'ENABLED|DISABLED',
    ],
    '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

Result Syntax

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

Result Details

Errors

ResourceNotFoundException:

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

InvalidRequestException:

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

ThrottlingException:

The request was denied due to request throttling.

InternalServiceError:

This exception is thrown when an error occurs in the Transfer Family service.

ServiceUnavailableException:

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

ResourceExistsException:

The requested resource does not exist, or exists in a region other than the one specified for the command.

AccessDeniedException:

You do not have sufficient access to perform this action.

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
            'Type' => 'FILE|DIRECTORY',
        ],
        // ...
    ],
    '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

Result Syntax

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

Result Details

Errors

ResourceNotFoundException:

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

InvalidRequestException:

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

InternalServiceError:

This exception is thrown when an error occurs in the Transfer Family service.

ServiceUnavailableException:

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

ResourceExistsException:

The requested resource does not exist, or exists in a region other than the one specified for the command.

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

Result Syntax

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

Result Details

Errors

InvalidRequestException:

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

ThrottlingException:

The request was denied due to request throttling.

InternalServiceError:

This exception is thrown when an error occurs in the Transfer Family service.

ServiceUnavailableException:

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

ResourceExistsException:

The requested resource does not exist, or exists in a region other than the one specified for the command.

AccessDeniedException:

You do not have sufficient access to perform this action.

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

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

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

InvalidRequestException:

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

InternalServiceError:

This exception is thrown when an error occurs in the Transfer Family service.

ServiceUnavailableException:

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

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

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

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

InvalidRequestException:

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

InternalServiceError:

This exception is thrown when an error occurs in the Transfer Family service.

ServiceUnavailableException:

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

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

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

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

InvalidRequestException:

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

InternalServiceError:

This exception is thrown when an error occurs in the Transfer Family service.

ServiceUnavailableException:

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

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

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

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

InvalidRequestException:

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

InternalServiceError:

This exception is thrown when an error occurs in the Transfer Family service.

ServiceUnavailableException:

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

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

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

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

InvalidRequestException:

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

ThrottlingException:

The request was denied due to request throttling.

InternalServiceError:

This exception is thrown when an error occurs in the Transfer Family service.

ServiceUnavailableException:

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

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

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

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

InvalidRequestException:

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

InternalServiceError:

This exception is thrown when an error occurs in the Transfer Family service.

ServiceUnavailableException:

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

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

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

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

InvalidRequestException:

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

InternalServiceError:

This exception is thrown when an error occurs in the Transfer Family service.

ServiceUnavailableException:

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

AccessDeniedException:

You do not have sufficient access to perform this action.

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

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

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

InvalidRequestException:

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

ThrottlingException:

The request was denied due to request throttling.

InternalServiceError:

This exception is thrown when an error occurs in the Transfer Family service.

ServiceUnavailableException:

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

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.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

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

InvalidRequestException:

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

InternalServiceError:

This exception is thrown when an error occurs in the Transfer Family service.

ServiceUnavailableException:

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

DeleteWorkflow

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

Deletes the specified workflow.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

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

InvalidRequestException:

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

InternalServiceError:

This exception is thrown when an error occurs in the Transfer Family service.

ServiceUnavailableException:

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

AccessDeniedException:

You do not have sufficient access to perform this action.

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

Result Syntax

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

Result Details

Errors

ResourceNotFoundException:

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

InvalidRequestException:

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

InternalServiceError:

This exception is thrown when an error occurs in the Transfer Family service.

ServiceUnavailableException:

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

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

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

Errors

ResourceNotFoundException:

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

InvalidRequestException:

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

InternalServiceError:

This exception is thrown when an error occurs in the Transfer Family service.

ServiceUnavailableException:

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

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

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|TLS',
    ],
]

Result Details

Errors

ResourceNotFoundException:

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

InvalidRequestException:

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

InternalServiceError:

This exception is thrown when an error occurs in the Transfer Family service.

ServiceUnavailableException:

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

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

Result Syntax

[
    'Connector' => [
        'AccessRole' => '<string>',
        'Arn' => '<string>',
        'As2Config' => [
            'BasicAuthSecretId' => '<string>',
            'Compression' => 'ZLIB|DISABLED',
            'EncryptionAlgorithm' => 'AES128_CBC|AES192_CBC|AES256_CBC|DES_EDE3_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>',
        'SecurityPolicyName' => '<string>',
        'ServiceManagedEgressIpAddresses' => ['<string>', ...],
        'SftpConfig' => [
            'TrustedHostKeys' => ['<string>', ...],
            'UserSecretId' => '<string>',
        ],
        'Tags' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
        'Url' => '<string>',
    ],
]

Result Details

Errors

ResourceNotFoundException:

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

InvalidRequestException:

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

InternalServiceError:

This exception is thrown when an error occurs in the Transfer Family service.

ServiceUnavailableException:

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

DescribeExecution

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

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

Parameter Syntax

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

Parameter Details

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

Errors

ResourceNotFoundException:

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

InvalidRequestException:

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

InternalServiceError:

This exception is thrown when an error occurs in the Transfer Family service.

ServiceUnavailableException:

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

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

Result Syntax

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

Result Details

Errors

ResourceNotFoundException:

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

InvalidRequestException:

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

InternalServiceError:

This exception is thrown when an error occurs in the Transfer Family service.

ServiceUnavailableException:

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

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

Result Syntax

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

Result Details

Errors

ResourceNotFoundException:

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

InvalidRequestException:

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

InternalServiceError:

This exception is thrown when an error occurs in the Transfer Family service.

ServiceUnavailableException:

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

DescribeSecurityPolicy

$result = $client->describeSecurityPolicy([/* ... */]);
$promise = $client->describeSecurityPolicyAsync([/* ... */]);

Describes the security policy that is attached to your server or SFTP connector. The response contains a description of the security policy's properties. For more information about security policies, see Working with security policies for servers or Working with security policies for SFTP connectors.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'SecurityPolicy' => [
        'Fips' => true || false,
        'Protocols' => ['<string>', ...],
        'SecurityPolicyName' => '<string>',
        'SshCiphers' => ['<string>', ...],
        'SshHostKeyAlgorithms' => ['<string>', ...],
        'SshKexs' => ['<string>', ...],
        'SshMacs' => ['<string>', ...],
        'TlsCiphers' => ['<string>', ...],
        'Type' => 'SERVER|CONNECTOR',
    ],
]

Result Details

Errors

ResourceNotFoundException:

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

InvalidRequestException:

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

InternalServiceError:

This exception is thrown when an error occurs in the Transfer Family service.

ServiceUnavailableException:

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

DescribeServer

$result = $client->describeServer([/* ... */]);
$promise = $client->describeServerAsync([/* ... */]);

Describes a file transfer protocol-enabled server that you specify by passing the ServerId parameter.

The response contains a description of a server's properties. When you set EndpointType to VPC, the response will contain the EndpointDetails.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'Server' => [
        'Arn' => '<string>',
        'As2ServiceManagedEgressIpAddresses' => ['<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>', ...],
        'S3StorageOptions' => [
            'DirectoryListingOptimization' => 'ENABLED|DISABLED',
        ],
        '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

Errors

ResourceNotFoundException:

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

InvalidRequestException:

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

InternalServiceError:

This exception is thrown when an error occurs in the Transfer Family service.

ServiceUnavailableException:

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

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

Result Syntax

[
    'ServerId' => '<string>',
    'User' => [
        'Arn' => '<string>',
        'HomeDirectory' => '<string>',
        'HomeDirectoryMappings' => [
            [
                'Entry' => '<string>',
                'Target' => '<string>',
                'Type' => 'FILE|DIRECTORY',
            ],
            // ...
        ],
        '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

Errors

ResourceNotFoundException:

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

InvalidRequestException:

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

InternalServiceError:

This exception is thrown when an error occurs in the Transfer Family service.

ServiceUnavailableException:

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

DescribeWorkflow

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

Describes the specified workflow.

Parameter Syntax

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

Parameter Details

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

Errors

ResourceNotFoundException:

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

InvalidRequestException:

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

InternalServiceError:

This exception is thrown when an error occurs in the Transfer Family service.

ServiceUnavailableException:

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

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|TLS', // REQUIRED
]);

Parameter Details

Result Syntax

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

Result Details

Errors

ResourceNotFoundException:

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

InvalidRequestException:

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

InternalServiceError:

This exception is thrown when an error occurs in the Transfer Family service.

ServiceUnavailableException:

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

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

Result Syntax

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

Result Details

Errors

ResourceNotFoundException:

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

InvalidRequestException:

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

ThrottlingException:

The request was denied due to request throttling.

InternalServiceError:

This exception is thrown when an error occurs in the Transfer Family service.

ServiceUnavailableException:

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

ResourceExistsException:

The requested resource does not exist, or exists in a region other than the one specified for the command.

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

Result Syntax

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

Result Details

Errors

ResourceNotFoundException:

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

InvalidRequestException:

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

ThrottlingException:

The request was denied due to request throttling.

InternalServiceError:

This exception is thrown when an error occurs in the Transfer Family service.

ServiceUnavailableException:

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

ResourceExistsException:

The requested resource does not exist, or exists in a region other than the one specified for the command.

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

Result Syntax

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

Result Details

Errors

ResourceNotFoundException:

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

InvalidRequestException:

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

InternalServiceError:

This exception is thrown when an error occurs in the Transfer Family service.

ServiceUnavailableException:

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

InvalidNextTokenException:

The NextToken parameter that was passed is invalid.

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

Result Syntax

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

Result Details

Errors

ResourceNotFoundException:

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

InvalidRequestException:

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

InternalServiceError:

This exception is thrown when an error occurs in the Transfer Family service.

ServiceUnavailableException:

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

InvalidNextTokenException:

The NextToken parameter that was passed is invalid.

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

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|TLS',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

ResourceNotFoundException:

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

InvalidRequestException:

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

InternalServiceError:

This exception is thrown when an error occurs in the Transfer Family service.

ServiceUnavailableException:

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

InvalidNextTokenException:

The NextToken parameter that was passed is invalid.

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

Result Syntax

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

Result Details

Errors

ResourceNotFoundException:

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

InvalidRequestException:

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

InternalServiceError:

This exception is thrown when an error occurs in the Transfer Family service.

ServiceUnavailableException:

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

InvalidNextTokenException:

The NextToken parameter that was passed is invalid.

ListExecutions

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

Lists all in-progress executions for the specified workflow.

Parameter Syntax

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

Parameter Details

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

Errors

ResourceNotFoundException:

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

InvalidRequestException:

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

InternalServiceError:

This exception is thrown when an error occurs in the Transfer Family service.

ServiceUnavailableException:

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

InvalidNextTokenException:

The NextToken parameter that was passed is invalid.

ListFileTransferResults

$result = $client->listFileTransferResults([/* ... */]);
$promise = $client->listFileTransferResultsAsync([/* ... */]);

Returns real-time updates and detailed information on the status of each individual file being transferred in a specific file transfer operation. You specify the file transfer by providing its ConnectorId and its TransferId.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'FileTransferResults' => [
        [
            'FailureCode' => '<string>',
            'FailureMessage' => '<string>',
            'FilePath' => '<string>',
            'StatusCode' => 'QUEUED|IN_PROGRESS|COMPLETED|FAILED',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

ResourceNotFoundException:

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

InvalidRequestException:

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

InternalServiceError:

This exception is thrown when an error occurs in the Transfer Family service.

ServiceUnavailableException:

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

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

Result Syntax

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

Result Details

Errors

ResourceNotFoundException:

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

InvalidRequestException:

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

InternalServiceError:

This exception is thrown when an error occurs in the Transfer Family service.

ServiceUnavailableException:

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

InvalidNextTokenException:

The NextToken parameter that was passed is invalid.

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

Result Syntax

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

Result Details

Errors

ResourceNotFoundException:

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

InvalidRequestException:

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

InternalServiceError:

This exception is thrown when an error occurs in the Transfer Family service.

ServiceUnavailableException:

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

InvalidNextTokenException:

The NextToken parameter that was passed is invalid.

ListSecurityPolicies

$result = $client->listSecurityPolicies([/* ... */]);
$promise = $client->listSecurityPoliciesAsync([/* ... */]);

Lists the security policies that are attached to your servers and SFTP connectors. For more information about security policies, see Working with security policies for servers or Working with security policies for SFTP connectors.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'SecurityPolicyNames' => ['<string>', ...],
]

Result Details

Errors

InvalidRequestException:

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

InternalServiceError:

This exception is thrown when an error occurs in the Transfer Family service.

ServiceUnavailableException:

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

InvalidNextTokenException:

The NextToken parameter that was passed is invalid.

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

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

Errors

InvalidRequestException:

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

InternalServiceError:

This exception is thrown when an error occurs in the Transfer Family service.

ServiceUnavailableException:

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

InvalidNextTokenException:

The NextToken parameter that was passed is invalid.

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

Result Syntax

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

Result Details

Errors

InvalidRequestException:

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

InternalServiceError:

This exception is thrown when an error occurs in the Transfer Family service.

ServiceUnavailableException:

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

InvalidNextTokenException:

The NextToken parameter that was passed is invalid.

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

Result Syntax

[
    'NextToken' => '<string>',
    'ServerId' => '<string>',
    'Users' => [
        [
            'Arn' => '<string>',
            'HomeDirectory' => '<string>',
            'HomeDirectoryType' => 'PATH|LOGICAL',
            'Role' => '<string>',
            'SshPublicKeyCount' => <integer>,
            'UserName' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

ResourceNotFoundException:

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

InvalidRequestException:

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

InternalServiceError:

This exception is thrown when an error occurs in the Transfer Family service.

ServiceUnavailableException:

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

InvalidNextTokenException:

The NextToken parameter that was passed is invalid.

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

Result Syntax

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

Result Details

Errors

InvalidRequestException:

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

InternalServiceError:

This exception is thrown when an error occurs in the Transfer Family service.

ServiceUnavailableException:

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

InvalidNextTokenException:

The NextToken parameter that was passed is invalid.

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

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

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

InvalidRequestException:

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

ThrottlingException:

The request was denied due to request throttling.

InternalServiceError:

This exception is thrown when an error occurs in the Transfer Family service.

ServiceUnavailableException:

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

AccessDeniedException:

You do not have sufficient access to perform this action.

StartDirectoryListing

$result = $client->startDirectoryListing([/* ... */]);
$promise = $client->startDirectoryListingAsync([/* ... */]);

Retrieves a list of the contents of a directory from a remote SFTP server. You specify the connector ID, the output path, and the remote directory path. You can also specify the optional MaxItems value to control the maximum number of items that are listed from the remote directory. This API returns a list of all files and directories in the remote directory (up to the maximum value), but does not return files or folders in sub-directories. That is, it only returns a list of files and directories one-level deep.

After you receive the listing file, you can provide the files that you want to transfer to the RetrieveFilePaths parameter of the StartFileTransfer API call.

The naming convention for the output file is connector-ID-listing-ID.json. The output file contains the following information:

• filePath: the complete path of a remote file, relative to the directory of the listing request for your SFTP connector on the remote server.

• modifiedTimestamp: the last time the file was modified, in UTC time format. This field is optional. If the remote file attributes don't contain a timestamp, it is omitted from the file listing.

• size: the size of the file, in bytes. This field is optional. If the remote file attributes don't contain a file size, it is omitted from the file listing.

• path: the complete path of a remote directory, relative to the directory of the listing request for your SFTP connector on the remote server.

• truncated: a flag indicating whether the list output contains all of the items contained in the remote directory or not. If your Truncated output value is true, you can increase the value provided in the optional max-items input attribute to be able to list more items (up to the maximum allowed list size of 10,000 items).

Parameter Syntax

$result = $client->startDirectoryListing([
    'ConnectorId' => '<string>', // REQUIRED
    'MaxItems' => <integer>,
    'OutputDirectoryPath' => '<string>', // REQUIRED
    'RemoteDirectoryPath' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'ListingId' => '<string>',
    'OutputFileName' => '<string>',
]

Result Details

Errors

ResourceNotFoundException:

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

InvalidRequestException:

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

ThrottlingException:

The request was denied due to request throttling.

InternalServiceError:

This exception is thrown when an error occurs in the Transfer Family service.

ServiceUnavailableException:

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

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

Result Syntax

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

Result Details

Errors

ResourceNotFoundException:

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

InvalidRequestException:

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

ThrottlingException:

The request was denied due to request throttling.

InternalServiceError:

This exception is thrown when an error occurs in the Transfer Family service.

ServiceUnavailableException:

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

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

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

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

InvalidRequestException:

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

ThrottlingException:

The request was denied due to request throttling.

InternalServiceError:

This exception is thrown when an error occurs in the Transfer Family service.

ServiceUnavailableException:

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

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.

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

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

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

InvalidRequestException:

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

ThrottlingException:

The request was denied due to request throttling.

InternalServiceError:

This exception is thrown when an error occurs in the Transfer Family service.

ServiceUnavailableException:

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

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

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

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

InvalidRequestException:

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

InternalServiceError:

This exception is thrown when an error occurs in the Transfer Family service.

ServiceUnavailableException:

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

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 local Amazon Web Services storage and a trading partner's SFTP server.

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

ResourceNotFoundException:

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

InvalidRequestException:

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

InternalServiceError:

This exception is thrown when an error occurs in the Transfer Family service.

ServiceUnavailableException:

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

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

Result Syntax

[
    'Message' => '<string>',
    'Response' => '<string>',
    'StatusCode' => <integer>,
    'Url' => '<string>',
]

Result Details

Errors

ResourceNotFoundException:

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

InvalidRequestException:

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

InternalServiceError:

This exception is thrown when an error occurs in the Transfer Family service.

ServiceUnavailableException:

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

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

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

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

InvalidRequestException:

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

InternalServiceError:

This exception is thrown when an error occurs in the Transfer Family service.

ServiceUnavailableException:

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

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
            'Type' => 'FILE|DIRECTORY',
        ],
        // ...
    ],
    'HomeDirectoryType' => 'PATH|LOGICAL',
    'Policy' => '<string>',
    'PosixProfile' => [
        'Gid' => <integer>, // REQUIRED
        'SecondaryGids' => [<integer>, ...],
        'Uid' => <integer>, // REQUIRED
    ],
    'Role' => '<string>',
    'ServerId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

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

Result Details

Errors

ResourceNotFoundException:

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

InvalidRequestException:

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

ThrottlingException:

The request was denied due to request throttling.

InternalServiceError:

This exception is thrown when an error occurs in the Transfer Family service.

ServiceUnavailableException:

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

ResourceExistsException:

The requested resource does not exist, or exists in a region other than the one specified for the command.

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

Result Syntax

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

Result Details

Errors

ResourceNotFoundException:

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

InvalidRequestException:

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

ThrottlingException:

The request was denied due to request throttling.

InternalServiceError:

This exception is thrown when an error occurs in the Transfer Family service.

ServiceUnavailableException:

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

ResourceExistsException:

The requested resource does not exist, or exists in a region other than the one specified for the command.

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

Result Syntax

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

Result Details

Errors

ResourceNotFoundException:

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

InvalidRequestException:

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

ThrottlingException:

The request was denied due to request throttling.

InternalServiceError:

This exception is thrown when an error occurs in the Transfer Family service.

ServiceUnavailableException:

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

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|DES_EDE3_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>',
    'SecurityPolicyName' => '<string>',
    'SftpConfig' => [
        'TrustedHostKeys' => ['<string>', ...],
        'UserSecretId' => '<string>',
    ],
    'Url' => '<string>',
]);

Parameter Details

Result Syntax

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

Result Details

Errors

ResourceNotFoundException:

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

InvalidRequestException:

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

ThrottlingException:

The request was denied due to request throttling.

InternalServiceError:

This exception is thrown when an error occurs in the Transfer Family service.

ServiceUnavailableException:

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

ResourceExistsException:

The requested resource does not exist, or exists in a region other than the one specified for the command.

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

Result Syntax

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

Result Details

Errors

ResourceNotFoundException:

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

InvalidRequestException:

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

ThrottlingException:

The request was denied due to request throttling.

InternalServiceError:

This exception is thrown when an error occurs in the Transfer Family service.

ServiceUnavailableException:

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

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

Result Syntax

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

Result Details

Errors

ResourceNotFoundException:

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

InvalidRequestException:

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

ThrottlingException:

The request was denied due to request throttling.

InternalServiceError:

This exception is thrown when an error occurs in the Transfer Family service.

ServiceUnavailableException:

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

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>', ...],
    'S3StorageOptions' => [
        'DirectoryListingOptimization' => 'ENABLED|DISABLED',
    ],
    'SecurityPolicyName' => '<string>',
    'ServerId' => '<string>', // REQUIRED
    'StructuredLogDestinations' => ['<string>', ...],
    'WorkflowDetails' => [
        'OnPartialUpload' => [
            [
                'ExecutionRole' => '<string>', // REQUIRED
                'WorkflowId' => '<string>', // REQUIRED
            ],
            // ...
        ],
        'OnUpload' => [
            [
                'ExecutionRole' => '<string>', // REQUIRED
                'WorkflowId' => '<string>', // REQUIRED
            ],
            // ...
        ],
    ],
]);

Parameter Details