Transfer

Table of Contents

Client

class Transfer.Client

A low-level client representing AWS Transfer for SFTP:

client = session.create_client('transfer')

These are the available methods:

can_paginate(operation_name)

Check if an operation can be paginated.

Parameters
operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Returns
True if the operation can be paginated, False otherwise.
create_server(**kwargs)

Instantiates an autoscaling virtual server based on Secure File Transfer Protocol (SFTP) in AWS. The call returns the ServerId property assigned by the service to the newly created server. Reference this ServerId property when you make updates to your server, or work with users.

The response returns the ServerId value for the newly created server.

See also: AWS API Documentation

Request Syntax

response = client.create_server(
    EndpointDetails={
        'VpcEndpointId': 'string'
    },
    EndpointType='PUBLIC'|'VPC_ENDPOINT',
    HostKey='string',
    IdentityProviderDetails={
        'Url': 'string',
        'InvocationRole': 'string'
    },
    IdentityProviderType='SERVICE_MANAGED'|'API_GATEWAY',
    LoggingRole='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)
Parameters
  • EndpointDetails (dict) --

    The virtual private cloud (VPC) endpoint settings that you want to configure for your SFTP server.

    • VpcEndpointId (string) --

      The ID of the VPC endpoint.

  • EndpointType (string) -- The type of VPC endpoint that you want your SFTP server connect to. If you connect to a VPC endpoint, your SFTP server isn't accessible over the public internet.
  • HostKey (string) --

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

    Warning

    If you aren't planning to migrate existing users from an existing SFTP server to a new AWS SFTP server, don't update the host key. Accidentally changing a server's host key can be disruptive. For more information, see change-host-key in the AWS SFTP User Guide.

  • IdentityProviderDetails (dict) --

    An array containing all of the information required to call a customer-supplied authentication API. This parameter is not required when the IdentityProviderType value of server that is created uses the SERVICE_MANAGED authentication method.

    • Url (string) --

      The IdentityProviderDetail parameter contains the location of the service endpoint used to authenticate users.

    • InvocationRole (string) --

      The Role parameter provides the type of InvocationRole used to authenticate the user account.

  • IdentityProviderType (string) -- The mode of authentication enabled for this service. The default value is SERVICE_MANAGED , which allows you to store and access SFTP user credentials within the service. An IdentityProviderType value of API_GATEWAY indicates that user authentication requires a call to an API Gateway endpoint URL provided by you to integrate an identity provider of your choice.
  • LoggingRole (string) -- A value that allows the service to write your SFTP users' activity to your Amazon CloudWatch logs for monitoring and auditing purposes.
  • Tags (list) --

    Key-value pairs that can be used to group and search for 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]

        This property contains one or more values that you assigned to the key name you create.

Return type

dict

Returns

Response Syntax

{
    'ServerId': 'string'
}

Response Structure

  • (dict) --

    • ServerId (string) --

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

create_user(**kwargs)

Adds a user and associate them with an existing Secure File Transfer Protocol (SFTP) server. 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 AWS Identity and Access Management (IAM) role. You can also optionally add a scope-down policy, and assign metadata with tags that can be used to group and search for users.

The response returns the UserName and ServerId values of the new user for that server.

See also: AWS API Documentation

Request Syntax

response = client.create_user(
    HomeDirectory='string',
    Policy='string',
    Role='string',
    ServerId='string',
    SshPublicKeyBody='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    UserName='string'
)
Parameters
  • HomeDirectory (string) -- The landing directory (folder) for a user when they log in to the server using their SFTP client. An example is ``/home/username `` .
  • Policy (string) -- A scope-down policy for your user so you can use the same IAM role across multiple users. This policy scopes down user access to portions of their Amazon S3 bucket. Variables you can use inside this policy include ${Transfer:UserName} , ${Transfer:HomeDirectory} , and ${Transfer:HomeBucket} .
  • Role (string) --

    [REQUIRED]

    The IAM role that controls your user's access to your Amazon S3 bucket. The policies attached to this role will determine the level of access you want to provide your users when transferring files into and out of your Amazon S3 bucket or buckets. The IAM role should also contain a trust relationship that allows the SFTP server to access your resources when servicing your SFTP user's transfer requests.

  • ServerId (string) --

    [REQUIRED]

    A system-assigned unique identifier for an SFTP server instance. This is the specific SFTP server that you added your user to.

  • SshPublicKeyBody (string) -- The public portion of the Secure Shall (SSH) key used to authenticate the user to the SFTP server.
  • Tags (list) --

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

    • (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]

        This property contains one or more values that you assigned to the key name you create.

  • UserName (string) --

    [REQUIRED]

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

Return type

dict

Returns

Response Syntax

{
    'ServerId': 'string',
    'UserName': 'string'
}

Response Structure

  • (dict) --

    • ServerId (string) --

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

    • UserName (string) --

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

delete_server(**kwargs)

Deletes the Secure File Transfer Protocol (SFTP) server that you specify. If you used SERVICE_MANAGED as your IdentityProviderType , you need to delete all users associated with this server before deleting the server itself

No response returns from this call.

See also: AWS API Documentation

Request Syntax

response = client.delete_server(
    ServerId='string'
)
Parameters
ServerId (string) --

[REQUIRED]

A unique system-assigned identifier for an SFTP server instance.

Returns
None
delete_ssh_public_key(**kwargs)

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

No response is returned from this call.

See also: AWS API Documentation

Request Syntax

response = client.delete_ssh_public_key(
    ServerId='string',
    SshPublicKeyId='string',
    UserName='string'
)
Parameters
  • ServerId (string) --

    [REQUIRED]

    A system-assigned unique identifier for a Secure File Transfer Protocol (SFTP) server instance that has the user assigned to it.

  • SshPublicKeyId (string) --

    [REQUIRED]

    A unique identifier used to reference your user's specific SSH key.

  • UserName (string) --

    [REQUIRED]

    A unique string that identifies a user whose public key is being deleted.

Returns

None

delete_user(**kwargs)

Deletes the user belonging to the server you specify.

No response returns from this call.

Note

When you delete a user from a server, the user's information is lost.

See also: AWS API Documentation

Request Syntax

response = client.delete_user(
    ServerId='string',
    UserName='string'
)
Parameters
  • ServerId (string) --

    [REQUIRED]

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

  • UserName (string) --

    [REQUIRED]

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

Returns

None

describe_server(**kwargs)

Describes the server that you specify by passing the ServerId parameter.

The response contains a description of the server's properties.

See also: AWS API Documentation

Request Syntax

response = client.describe_server(
    ServerId='string'
)
Parameters
ServerId (string) --

[REQUIRED]

A system-assigned unique identifier for an SFTP server.

Return type
dict
Returns
Response Syntax
{
    'Server': {
        'Arn': 'string',
        'EndpointDetails': {
            'VpcEndpointId': 'string'
        },
        'EndpointType': 'PUBLIC'|'VPC_ENDPOINT',
        'HostKeyFingerprint': 'string',
        'IdentityProviderDetails': {
            'Url': 'string',
            'InvocationRole': 'string'
        },
        'IdentityProviderType': 'SERVICE_MANAGED'|'API_GATEWAY',
        'LoggingRole': 'string',
        '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 the server with the ServerID you specified.

      • Arn (string) --

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

      • EndpointDetails (dict) --

        The virtual private cloud (VPC) endpoint settings that you configured for your SFTP server.

        • VpcEndpointId (string) --

          The ID of the VPC endpoint.

      • EndpointType (string) --

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

      • HostKeyFingerprint (string) --

        This value contains the Message-Digest Algorithm (MD5) hash of the server's host key. This value is equivalent to the output of 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 the server is SERVICE_MANAGED >.

        • Url (string) --

          The IdentityProviderDetail parameter contains the location of the service endpoint used to authenticate users.

        • InvocationRole (string) --

          The Role parameter provides the type of InvocationRole used to authenticate the user account.

      • IdentityProviderType (string) --

        This property defines the mode of authentication method enabled for this service. A value of SERVICE_MANAGED , means that you are using this Server to store and access SFTP 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) --

        This property is an AWS Identity and Access Management (IAM) entity that allows the server to turn on Amazon CloudWatch logging for Amazon S3 events. When set, user activity can be view in your CloudWatch logs.

      • ServerId (string) --

        This property is a unique system assigned identifier for the SFTP server that you instantiate.

      • State (string) --

        The condition of the SFTP 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 indicated 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) --

        This property contains the key-value pairs that you can use to search for and group 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) --

            This property contains one or more values that you assigned to the key name you create.

      • UserCount (integer) --

        The number of users that are assigned to the SFTP server you specified with the ServerId .

describe_user(**kwargs)

Describes the user assigned to a specific 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.

See also: AWS API Documentation

Request Syntax

response = client.describe_user(
    ServerId='string',
    UserName='string'
)
Parameters
  • ServerId (string) --

    [REQUIRED]

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

  • UserName (string) --

    [REQUIRED]

    The name of the user assigned to one or more servers. User names are part of the sign-in credentials to use the AWS Transfer service and perform file transfer tasks.

Return type

dict

Returns

Response Syntax

{
    'ServerId': 'string',
    'User': {
        'Arn': 'string',
        'HomeDirectory': 'string',
        'Policy': 'string',
        'Role': 'string',
        'SshPublicKeys': [
            {
                'DateImported': datetime(2015, 1, 1),
                'SshPublicKeyBody': 'string',
                'SshPublicKeyId': 'string'
            },
        ],
        'Tags': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ],
        'UserName': 'string'
    }
}

Response Structure

  • (dict) --

    • ServerId (string) --

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

    • User (dict) --

      An array containing the properties of the user account for the ServerID value that you specified.

      • Arn (string) --

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

      • HomeDirectory (string) --

        This property specifies the landing directory (or folder) which is the location that files are written to or read from in an Amazon S3 bucket for the described user. An example would be: ``/bucket_name /home/username `` .

      • Policy (string) --

        Specifies the name of the policy in use for the described user.

      • Role (string) --

        This property specifies the IAM role that controls your user's access to your Amazon S3 bucket. The policies attached to this role will determine the level of access you want to provide your users when transferring files into and out of your Amazon S3 bucket or buckets. The IAM role should also contain a trust relationship that allows the SFTP server to access your resources when servicing your SFTP user's transfer requests.

      • SshPublicKeys (list) --

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

        • (dict) --

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

          • DateImported (datetime) --

            The date that the public key was added to the user account.

          • SshPublicKeyBody (string) --

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

          • SshPublicKeyId (string) --

            The SshPublicKeyId parameter contains the identifier of the public key.

      • Tags (list) --

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

        • (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) --

            This property contains one or more values that you assigned to the key name you create.

      • UserName (string) --

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

generate_presigned_url(ClientMethod, Params=None, ExpiresIn=3600, HttpMethod=None)

Generate a presigned url given a client, its method, and arguments

Parameters
  • ClientMethod (string) -- The client method to presign for
  • Params (dict) -- The parameters normally passed to ClientMethod.
  • ExpiresIn (int) -- The number of seconds the presigned url is valid for. By default it expires in an hour (3600 seconds)
  • HttpMethod (string) -- The http method to use on the generated url. By default, the http method is whatever is used in the method's model.
Returns

The presigned url

get_paginator(operation_name)

Create a paginator for an operation.

Parameters
operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Raises OperationNotPageableError
Raised if the operation is not pageable. You can use the client.can_paginate method to check if an operation is pageable.
Return type
L{botocore.paginate.Paginator}
Returns
A paginator object.
get_waiter(waiter_name)

Returns an object that can wait for some condition.

Parameters
waiter_name (str) -- The name of the waiter to get. See the waiters section of the service docs for a list of available waiters.
Returns
The specified waiter object.
Return type
botocore.waiter.Waiter
import_ssh_public_key(**kwargs)

Adds a Secure Shell (SSH) public key to a user account identified by a UserName value assigned to a specific server, identified by ServerId .

The response returns the UserName value, the ServerId value, and the name of the SshPublicKeyId .

See also: AWS API Documentation

Request Syntax

response = client.import_ssh_public_key(
    ServerId='string',
    SshPublicKeyBody='string',
    UserName='string'
)
Parameters
  • ServerId (string) --

    [REQUIRED]

    A system-assigned unique identifier for an SFTP server.

  • SshPublicKeyBody (string) --

    [REQUIRED]

    The public key portion of an SSH key pair.

  • UserName (string) --

    [REQUIRED]

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

Return type

dict

Returns

Response Syntax

{
    'ServerId': 'string',
    'SshPublicKeyId': 'string',
    'UserName': 'string'
}

Response Structure

  • (dict) --

    This response identifies the user, server they belong to, and the identifier of the SSH public key associated with that user. A user can have more than one key on each server that they are associate with.

    • ServerId (string) --

      A system-assigned unique identifier for an SFTP server.

    • SshPublicKeyId (string) --

      This identifier is the name given to a public key by the system that was imported.

    • UserName (string) --

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

list_servers(**kwargs)

Lists the Secure File Transfer Protocol (SFTP) servers that are associated with your AWS account.

See also: AWS API Documentation

Request Syntax

response = client.list_servers(
    MaxResults=123,
    NextToken='string'
)
Parameters
  • MaxResults (integer) -- Specifies the number of servers to return as a response to the ListServers query.
  • NextToken (string) -- When additional results are obtained from the ListServers command, a NextToken parameter is returned in the output. You can then pass the NextToken parameter in a subsequent command to continue listing additional servers.
Return type

dict

Returns

Response Syntax

{
    'NextToken': 'string',
    'Servers': [
        {
            'Arn': 'string',
            'IdentityProviderType': 'SERVICE_MANAGED'|'API_GATEWAY',
            'EndpointType': 'PUBLIC'|'VPC_ENDPOINT',
            'LoggingRole': 'string',
            'ServerId': 'string',
            'State': 'OFFLINE'|'ONLINE'|'STARTING'|'STOPPING'|'START_FAILED'|'STOP_FAILED',
            'UserCount': 123
        },
    ]
}

Response Structure

  • (dict) --

    • NextToken (string) --

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

    • Servers (list) --

      An array of servers that were listed.

      • (dict) --

        Returns properties of the server that was specified.

        • Arn (string) --

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

        • IdentityProviderType (string) --

          The authentication method used to validate a user for the server that was specified. listed. This can include Secure Shell (SSH), user name and password combinations, or your own custom authentication method. Valid values include SERVICE_MANAGED or API_GATEWAY .

        • EndpointType (string) --

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

        • LoggingRole (string) --

          The AWS Identity and Access Management entity that allows the server to turn on Amazon CloudWatch logging.

        • ServerId (string) --

          This value is the unique system assigned identifier for the SFTP servers that were listed.

        • State (string) --

          This property describes the condition of the SFTP 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 indicated 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.

        • UserCount (integer) --

          This property is a numeric value that indicates the number of users that are assigned to the SFTP server you specified with the ServerId .

list_tags_for_resource(**kwargs)

Lists all of the tags associated with the Amazon Resource Number (ARN) you specify. The resource can be a user, server, or role.

See also: AWS API Documentation

Request Syntax

response = client.list_tags_for_resource(
    Arn='string',
    MaxResults=123,
    NextToken='string'
)
Parameters
  • Arn (string) --

    [REQUIRED]

    Requests the tags associated with a particular Amazon Resource Name (ARN). An ARN is an identifier for a specific AWS resource, such as a server, user, or role.

  • MaxResults (integer) -- Specifies the number of tags to return as a response to the ListTagsForResource request.
  • NextToken (string) -- When you request additional results from the ListTagsForResource call, a NextToken parameter is returned in the input. You can then pass in a subsequent command the NextToken parameter to continue listing additional tags.
Return type

dict

Returns

Response Syntax

{
    'Arn': 'string',
    'NextToken': 'string',
    'Tags': [
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
}

Response Structure

  • (dict) --

    • Arn (string) --

      This value is the ARN you specified to list the tags of.

    • NextToken (string) --

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

    • Tags (list) --

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

      • (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) --

          This property contains one or more values that you assigned to the key name you create.

list_users(**kwargs)

Lists the users for the server that you specify by passing the ServerId parameter.

See also: AWS API Documentation

Request Syntax

response = client.list_users(
    MaxResults=123,
    NextToken='string',
    ServerId='string'
)
Parameters
  • MaxResults (integer) -- Specifies the number of users to return as a response to the ListUsers request.
  • NextToken (string) -- When you can get additional results from the ListUsers call, a NextToken parameter is returned in the output. You can then pass in a subsequent command the NextToken parameter to continue listing additional users.
  • ServerId (string) --

    [REQUIRED]

    A system-assigned unique identifier for a Secure File Transfer Protocol (SFTP) server that has users are assigned to it.

Return type

dict

Returns

Response Syntax

{
    'NextToken': 'string',
    'ServerId': 'string',
    'Users': [
        {
            'Arn': 'string',
            'HomeDirectory': 'string',
            'Role': 'string',
            'SshPublicKeyCount': 123,
            'UserName': 'string'
        },
    ]
}

Response Structure

  • (dict) --

    • NextToken (string) --

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

    • ServerId (string) --

      A system-assigned unique identifier for an SFTP server that the users are assigned to.

    • Users (list) --

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

      • (dict) --

        Returns properties of the user that you specify.

        • Arn (string) --

          This property is the unique Amazon Resource Name (ARN) for the user that you wish to learn about.

        • HomeDirectory (string) --

          This value specifies the location that files are written to or read from an Amazon S3 bucket for the user you specify by their ARN.

        • Role (string) --

          The role in use by this user. A role is an AWS Identity and Access Management (IAM) entity that in this case allows the SFTP server to act on a user's behalf. It allows the server to inherit the trust relationship that enables that user to perform file operations to their Amazon S3 bucket.

        • SshPublicKeyCount (integer) --

          This value is the number of SSH public keys stored for the user you specified.

        • UserName (string) --

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

start_server(**kwargs)

Changes the state of a Secure File Transfer Protocol (SFTP) server from OFFLINE to ONLINE . It has no impact on an SFTP 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.

See also: AWS API Documentation

Request Syntax

response = client.start_server(
    ServerId='string'
)
Parameters
ServerId (string) --

[REQUIRED]

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

Returns
None
stop_server(**kwargs)

Changes the state of an SFTP server from ONLINE to OFFLINE . An OFFLINE server cannot accept and process file transfer jobs. Information tied to your server such as server and user properties are not affected by stopping your server. Stopping a server will not reduce or impact your Secure File Transfer Protocol (SFTP) endpoint billing.

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

See also: AWS API Documentation

Request Syntax

response = client.stop_server(
    ServerId='string'
)
Parameters
ServerId (string) --

[REQUIRED]

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

Returns
None
tag_resource(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.tag_resource(
    Arn='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)
Parameters
  • Arn (string) --

    [REQUIRED]

    An Amazon Resource Name (ARN) for a specific AWS resource, such as a server, user, or role.

  • Tags (list) --

    [REQUIRED]

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

    • (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]

        This property contains one or more values that you assigned to the key name you create.

Returns

None

test_identity_provider(**kwargs)

If the IdentityProviderType of the server is API_Gateway , tests whether your API Gateway is set up successfully. We highly recommend that you call this method 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

response = client.test_identity_provider(
    ServerId='string',
    UserName='string',
    UserPassword='string'
)
Parameters
  • ServerId (string) --

    [REQUIRED]

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

  • UserName (string) --

    [REQUIRED]

    This request parameter is name of the user account to be tested.

  • UserPassword (string) -- The password of the user account to be tested.
Return type

dict

Returns

Response Syntax

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

Response Structure

  • (dict) --

    • Message (string) --

      The result of the authorization test as a message.

    • StatusCode (integer) --

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

    • Url (string) --

      The endpoint of the service used to authenticate a user.

untag_resource(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.untag_resource(
    Arn='string',
    TagKeys=[
        'string',
    ]
)
Parameters
  • Arn (string) --

    [REQUIRED]

    This is the value of the resource that will have the tag removed. An Amazon Resource Name (ARN) is an identifier for a specific AWS resource, such as a server, user, or role.

  • TagKeys (list) --

    [REQUIRED]

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

    • (string) --
Returns

None

update_server(**kwargs)

Updates the server properties after that server has been created.

The UpdateServer call returns the ServerId of the Secure File Transfer Protocol (SFTP) server you updated.

See also: AWS API Documentation

Request Syntax

response = client.update_server(
    EndpointDetails={
        'VpcEndpointId': 'string'
    },
    EndpointType='PUBLIC'|'VPC_ENDPOINT',
    HostKey='string',
    IdentityProviderDetails={
        'Url': 'string',
        'InvocationRole': 'string'
    },
    LoggingRole='string',
    ServerId='string'
)
Parameters
  • EndpointDetails (dict) --

    The virtual private cloud (VPC) endpoint settings that are configured for your SFTP server. With a VPC endpoint, your SFTP server isn't accessible over the public internet.

    • VpcEndpointId (string) --

      The ID of the VPC endpoint.

  • EndpointType (string) -- The type of endpoint that you want your SFTP server to connect to. You can choose to connect to the public internet or a virtual private cloud (VPC) endpoint. With a VPC endpoint, your SFTP server isn't accessible over the public internet.
  • HostKey (string) --

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

    Warning

    If you aren't planning to migrate existing users from an existing SFTP server to a new AWS SFTP server, don't update the host key. Accidentally changing a server's host key can be disruptive. For more information, see change-host-key in the AWS SFTP User Guide.

  • IdentityProviderDetails (dict) --

    This response parameter is an array containing all of the information required to call a customer's authentication API method.

    • Url (string) --

      The IdentityProviderDetail parameter contains the location of the service endpoint used to authenticate users.

    • InvocationRole (string) --

      The Role parameter provides the type of InvocationRole used to authenticate the user account.

  • LoggingRole (string) -- A value that 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.
  • ServerId (string) --

    [REQUIRED]

    A system-assigned unique identifier for an SFTP server instance that the user account is assigned to.

Return type

dict

Returns

Response Syntax

{
    'ServerId': 'string'
}

Response Structure

  • (dict) --

    • ServerId (string) --

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

update_user(**kwargs)

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

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

See also: AWS API Documentation

Request Syntax

response = client.update_user(
    HomeDirectory='string',
    Policy='string',
    Role='string',
    ServerId='string',
    UserName='string'
)
Parameters
  • HomeDirectory (string) -- The HomeDirectory parameter specifies the landing directory (folder) for a user when they log in to the server using their client. An example would be: ``/home/username `` .
  • Policy (string) -- Allows you to supply a scope-down policy for your user so you can use the same AWS Identity and Access Management (IAM) role across multiple users. The policy scopes down users access to portions of your Amazon S3 bucket. Variables you can use inside this policy include ${Transfer:UserName} , ${Transfer:HomeDirectory} , and ${Transfer:HomeBucket} .
  • Role (string) -- The IAM role that controls your user's access to your Amazon S3 bucket. The policies attached to this role will determine the level of access you want to provide your users when transferring files into and out of your Amazon S3 bucket or buckets. The IAM role should also contain a trust relationship that allows the Secure File Transfer Protocol (SFTP) server to access your resources when servicing your SFTP user's transfer requests.
  • ServerId (string) --

    [REQUIRED]

    A system-assigned unique identifier for an SFTP server instance that the user account is assigned to.

  • UserName (string) --

    [REQUIRED]

    A unique string that identifies a user and is associated with a server as specified by the ServerId. This is the string that will be used by your user when they log in to your SFTP server. This user name is a minimum of 3 and a maximum of 32 characters long. The following are valid characters: a-z, A-Z, 0-9, underscore, and hyphen. The user name can't start with a hyphen.

Return type

dict

Returns

Response Syntax

{
    'ServerId': 'string',
    'UserName': 'string'
}

Response Structure

  • (dict) --

    UpdateUserResponse returns the user name and server identifier for the request to update a user's properties.

    • ServerId (string) --

      A system-assigned unique identifier for an SFTP server instance that the user account is assigned to.

    • UserName (string) --

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

Paginators

The available paginators are:

class Transfer.Paginator.ListServers
paginator = client.get_paginator('list_servers')
paginate(**kwargs)

Creates an iterator that will paginate through responses from Transfer.Client.list_servers().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
PaginationConfig (dict) --

A dictionary that provides parameters to control pagination.

  • MaxItems (integer) --

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) --

    The size of each page.

  • StartingToken (string) --

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type
dict
Returns
Response Syntax
{
    'Servers': [
        {
            'Arn': 'string',
            'IdentityProviderType': 'SERVICE_MANAGED'|'API_GATEWAY',
            'EndpointType': 'PUBLIC'|'VPC_ENDPOINT',
            'LoggingRole': 'string',
            'ServerId': 'string',
            'State': 'OFFLINE'|'ONLINE'|'STARTING'|'STOPPING'|'START_FAILED'|'STOP_FAILED',
            'UserCount': 123
        },
    ]
}

Response Structure

  • (dict) --
    • Servers (list) --

      An array of servers that were listed.

      • (dict) --

        Returns properties of the server that was specified.

        • Arn (string) --

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

        • IdentityProviderType (string) --

          The authentication method used to validate a user for the server that was specified. listed. This can include Secure Shell (SSH), user name and password combinations, or your own custom authentication method. Valid values include SERVICE_MANAGED or API_GATEWAY .

        • EndpointType (string) --

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

        • LoggingRole (string) --

          The AWS Identity and Access Management entity that allows the server to turn on Amazon CloudWatch logging.

        • ServerId (string) --

          This value is the unique system assigned identifier for the SFTP servers that were listed.

        • State (string) --

          This property describes the condition of the SFTP 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 indicated 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.

        • UserCount (integer) --

          This property is a numeric value that indicates the number of users that are assigned to the SFTP server you specified with the ServerId .