AWS Transfer Family

{'Certificate': 'string', 'Protocols': ['SFTP | FTP | FTPS']}

Instantiates an autoscaling virtual server based on the selected file transfer protocol in AWS. When you make updates to your file transfer protocol-enabled server or when you work with users, use the service-generated ServerId property that is assigned to the newly created server.

See also: AWS API Documentation

Request Syntax

client.create_server(
    Certificate='string',
    EndpointDetails={
        'AddressAllocationIds': [
            'string',
        ],
        'SubnetIds': [
            'string',
        ],
        'VpcEndpointId': 'string',
        'VpcId': 'string'
    },
    EndpointType='PUBLIC'|'VPC'|'VPC_ENDPOINT',
    HostKey='string',
    IdentityProviderDetails={
        'Url': 'string',
        'InvocationRole': 'string'
    },
    IdentityProviderType='SERVICE_MANAGED'|'API_GATEWAY',
    LoggingRole='string',
    Protocols=[
        'SFTP'|'FTP'|'FTPS',
    ],
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)

type Certificate:

string

param Certificate:

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

type EndpointDetails:

dict

param EndpointDetails:

The virtual private cloud (VPC) endpoint settings that are configured for your file transfer protocol-enabled server. When you host your endpoint within your VPC, you can make it accessible only to resources within your VPC, or you can attach Elastic IPs and make it accessible to clients over the internet. Your VPC's default security groups are automatically assigned to your endpoint.

• AddressAllocationIds (list) --

  A list of address allocation IDs that are required to attach an Elastic IP address to your file transfer protocol-enabled server's endpoint. This is only valid in the UpdateServer API.

  • (string) --

• SubnetIds (list) --

  A list of subnet IDs that are required to host your file transfer protocol-enabled server endpoint in your VPC.

  • (string) --

• VpcEndpointId (string) --

  The ID of the VPC endpoint.

• VpcId (string) --

  The VPC ID of the VPC in which a file transfer protocol-enabled server's endpoint will be hosted.

type EndpointType:

string

param EndpointType:

The type of VPC endpoint that you want your file transfer protocol-enabled server to connect to. You can choose to connect to the public internet or a virtual private cloud (VPC) endpoint. With a VPC endpoint, you can restrict access to your server and resources only within your VPC.

type HostKey:

string

param HostKey:

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

For more information, see Changing the Host Key for Your AWS Transfer Family Server in the AWS Transfer Family User Guide.

type IdentityProviderDetails:

dict

param IdentityProviderDetails:

Required when IdentityProviderType is set to API_GATEWAY. Accepts an array containing all of the information required to call a customer-supplied authentication API, including the API Gateway URL. Not required when IdentityProviderType is set to SERVICE_MANAGED.

• Url (string) --

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

• InvocationRole (string) --

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

type IdentityProviderType:

string

param IdentityProviderType:

Specifies the mode of authentication for a file transfer protocol-enabled server. The default value is SERVICE_MANAGED, which allows you to store and access user credentials within the AWS Transfer Family service. Use the API_GATEWAY value to integrate with an identity provider of your choosing. The API_GATEWAY setting requires you to provide an API Gateway endpoint URL to call for authentication using the IdentityProviderDetails parameter.

type LoggingRole:

string

param LoggingRole:

Allows the service to write your users' activity to your Amazon CloudWatch logs for monitoring and auditing purposes.

type Protocols:

list

param Protocols:

Specifies the file transfer protocol or protocols over which your file transfer protocol client can connect to your server's endpoint. The available protocols are:

• Secure Shell (SSH) File Transfer Protocol (SFTP): File transfer over SSH

• File Transfer Protocol Secure (FTPS): File transfer with TLS encryption

• File Transfer Protocol (FTP): Unencrypted file transfer

• (string) --

type Tags:

list

param Tags:

Key-value pairs that can be used to group and search for file transfer protocol-enabled servers.

• (dict) --

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

  • Key (string) -- [REQUIRED]

    The name assigned to the tag that you create.

  • Value (string) -- [REQUIRED]

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

rtype:

dict

returns:

Response Syntax

{
    'ServerId': 'string'
}

Response Structure

• (dict) --

  • ServerId (string) --

    The service-assigned ID of the file transfer protocol-enabled server that is created.

{'Server': {'Certificate': 'string', 'Protocols': ['SFTP | FTP | FTPS']}}

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.

See also: AWS API Documentation

Request Syntax

client.describe_server(
    ServerId='string'
)

type ServerId:

string

param ServerId:

[REQUIRED]

A system-assigned unique identifier for a file transfer protocol-enabled server.

rtype:

dict

returns:

Response Syntax

{
    'Server': {
        'Arn': 'string',
        'Certificate': 'string',
        'EndpointDetails': {
            'AddressAllocationIds': [
                'string',
            ],
            'SubnetIds': [
                'string',
            ],
            'VpcEndpointId': 'string',
            'VpcId': 'string'
        },
        'EndpointType': 'PUBLIC'|'VPC'|'VPC_ENDPOINT',
        'HostKeyFingerprint': 'string',
        'IdentityProviderDetails': {
            'Url': 'string',
            'InvocationRole': 'string'
        },
        'IdentityProviderType': 'SERVICE_MANAGED'|'API_GATEWAY',
        'LoggingRole': 'string',
        'Protocols': [
            'SFTP'|'FTP'|'FTPS',
        ],
        'ServerId': 'string',
        'State': 'OFFLINE'|'ONLINE'|'STARTING'|'STOPPING'|'START_FAILED'|'STOP_FAILED',
        'Tags': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ],
        'UserCount': 123
    }
}

Response Structure

• (dict) --

  • Server (dict) --

    An array containing the properties of a file transfer protocol-enabled server with the ServerID you specified.

    • Arn (string) --

      Specifies the unique Amazon Resource Name (ARN) for a file transfer protocol-enabled server to be described.

    • Certificate (string) --

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

    • EndpointDetails (dict) --

      The virtual private cloud (VPC) endpoint settings that you configured for your file transfer protocol-enabled server.

      • AddressAllocationIds (list) --

        A list of address allocation IDs that are required to attach an Elastic IP address to your file transfer protocol-enabled server's endpoint. This is only valid in the UpdateServer API.

        • (string) --

      • SubnetIds (list) --

        A list of subnet IDs that are required to host your file transfer protocol-enabled server endpoint in your VPC.

        • (string) --

      • VpcEndpointId (string) --

        The ID of the VPC endpoint.

      • VpcId (string) --

        The VPC ID of the VPC in which a file transfer protocol-enabled server's endpoint will be hosted.

    • EndpointType (string) --

      The type of endpoint that your file transfer protocol-enabled server is connected to. If your server is connected to a VPC endpoint, your server isn't accessible over the public internet.

    • HostKeyFingerprint (string) --

      Contains the message-digest algorithm (MD5) hash of a file transfer protocol-enabled server's host key. This value is equivalent to the output of the ssh-keygen -l -E md5 -f my-new-server-key command.

    • IdentityProviderDetails (dict) --

      Specifies information to call a customer-supplied authentication API. This field is not populated when the IdentityProviderType of a file transfer protocol-enabled server is SERVICE_MANAGED.

      • Url (string) --

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

      • InvocationRole (string) --

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

    • IdentityProviderType (string) --

      Defines the mode of authentication method enabled for this service. A value of SERVICE_MANAGED means that you are using this file transfer protocol-enabled server to store and access user credentials within the service. A value of API_GATEWAY indicates that you have integrated an API Gateway endpoint that will be invoked for authenticating your user into the service.

    • LoggingRole (string) --

      An AWS Identity and Access Management (IAM) entity that allows a file transfer protocol-enabled server to turn on Amazon CloudWatch logging for Amazon S3 events. When set, user activity can be viewed in your CloudWatch logs.

    • Protocols (list) --

      Specifies the file transfer protocol or protocols over which your file transfer protocol client can connect to your server's endpoint. The available protocols are:

      • Secure Shell (SSH) File Transfer Protocol (SFTP): File transfer over SSH

      • File Transfer Protocol Secure (FTPS): File transfer with TLS encryption

      • File Transfer Protocol (FTP): Unencrypted file transfer

      • (string) --

    • ServerId (string) --

      Unique system-assigned identifier for a file transfer protocol-enabled server that you instantiate.

    • State (string) --

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

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

    • Tags (list) --

      Contains the key-value pairs that you can use to search for and group file transfer protocol-enabled servers that were assigned to the server that was described.

      • (dict) --

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

        • Key (string) --

          The name assigned to the tag that you create.

        • Value (string) --

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

    • UserCount (integer) --

      The number of users that are assigned to a file transfer protocol-enabled server you specified with the ServerId.

{'ServerProtocol': 'SFTP | FTP | FTPS'}

If the IdentityProviderType of a file transfer protocol-enabled server is API_Gateway, tests whether your API Gateway is set up successfully. We highly recommend that you call this operation to test your authentication method as soon as you create your server. By doing so, you can troubleshoot issues with the API Gateway integration to ensure that your users can successfully use the service.

See also: AWS API Documentation

Request Syntax

client.test_identity_provider(
    ServerId='string',
    UserName='string',
    UserPassword='string',
    ServerProtocol='SFTP'|'FTP'|'FTPS'
)

type ServerId:

string

param ServerId:

[REQUIRED]

A system-assigned identifier for a specific file transfer protocol-enabled server. That server's user authentication method is tested with a user name and password.

type UserName:

string

param UserName:

[REQUIRED]

The name of the user account to be tested.

type UserPassword:

string

param UserPassword:

The password of the user account to be tested.

type ServerProtocol:

string

param ServerProtocol:

The type of file transfer protocol to be tested.

The available protocols are:

• Secure Shell (SSH) File Transfer Protocol (SFTP)

• File Transfer Protocol Secure (FTPS)

• File Transfer Protocol (FTP)

rtype:

dict

returns:

Response Syntax

{
    'Response': 'string',
    'StatusCode': 123,
    'Message': 'string',
    'Url': 'string'
}

Response Structure

• (dict) --

  • Response (string) --

    The response that is returned from your API Gateway.

  • StatusCode (integer) --

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

  • Message (string) --

    A message that indicates whether the test was successful or not.

  • Url (string) --

    The endpoint of the service used to authenticate a user.

{'Certificate': 'string', 'Protocols': ['SFTP | FTP | FTPS']}

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.

See also: AWS API Documentation

Request Syntax

client.update_server(
    Certificate='string',
    EndpointDetails={
        'AddressAllocationIds': [
            'string',
        ],
        'SubnetIds': [
            'string',
        ],
        'VpcEndpointId': 'string',
        'VpcId': 'string'
    },
    EndpointType='PUBLIC'|'VPC'|'VPC_ENDPOINT',
    HostKey='string',
    IdentityProviderDetails={
        'Url': 'string',
        'InvocationRole': 'string'
    },
    LoggingRole='string',
    Protocols=[
        'SFTP'|'FTP'|'FTPS',
    ],
    ServerId='string'
)

type Certificate:

string

param Certificate:

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

type EndpointDetails:

dict

param EndpointDetails:

The virtual private cloud (VPC) endpoint settings that are configured for your file transfer protocol-enabled server. With a VPC endpoint, you can restrict access to your server to resources only within your VPC. To control incoming internet traffic, you will need to associate one or more Elastic IP addresses with your server's endpoint.

• AddressAllocationIds (list) --

  A list of address allocation IDs that are required to attach an Elastic IP address to your file transfer protocol-enabled server's endpoint. This is only valid in the UpdateServer API.

  • (string) --

• SubnetIds (list) --

  A list of subnet IDs that are required to host your file transfer protocol-enabled server endpoint in your VPC.

  • (string) --

• VpcEndpointId (string) --

  The ID of the VPC endpoint.

• VpcId (string) --

  The VPC ID of the VPC in which a file transfer protocol-enabled server's endpoint will be hosted.

type EndpointType:

string

param EndpointType:

The type of endpoint that you want your file transfer protocol-enabled server to connect to. You can choose to connect to the public internet or a VPC endpoint. With a VPC endpoint, your server isn't accessible over the public internet.

type HostKey:

string

param HostKey:

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

For more information, see Changing the Host Key for Your AWS Transfer Family Server in the AWS Transfer Family User Guide.

type IdentityProviderDetails:

dict

param IdentityProviderDetails:

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

• Url (string) --

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

• InvocationRole (string) --

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

type LoggingRole:

string

param LoggingRole:

Changes the AWS Identity and Access Management (IAM) role that allows Amazon S3 events to be logged in Amazon CloudWatch, turning logging on or off.

type Protocols:

list

param Protocols:

Specifies the file transfer protocol or protocols over which your file transfer protocol client can connect to your server's endpoint. The available protocols are:

• Secure Shell (SSH) File Transfer Protocol (SFTP): File transfer over SSH

• File Transfer Protocol Secure (FTPS): File transfer with TLS encryption

• File Transfer Protocol (FTP): Unencrypted file transfer

• (string) --

type ServerId:

string

param ServerId:

[REQUIRED]

A system-assigned unique identifier for a file transfer protocol-enabled server instance that the user account is assigned to.

rtype:

dict

returns:

Response Syntax

{
    'ServerId': 'string'
}

Response Structure

• (dict) --

  • ServerId (string) --

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