Serialized Form

Package com.amazonaws.services.transfer.model

Class com.amazonaws.services.transfer.model.AccessDeniedException extends AWSTransferException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.transfer.model.AWSTransferException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.transfer.model.ConflictException extends AWSTransferException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.transfer.model.CreateServerRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

certificate

String certificate

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

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

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

To request a private certificate to use FTPS through private IP addresses, see Request a private certificate in the AWS Certificate Manager User Guide.

Certificates with the following cryptographic algorithms and key sizes are supported:

• 2048-bit RSA (RSA_2048)

• 4096-bit RSA (RSA_4096)

• Elliptic Prime Curve 256 bit (EC_prime256v1)

• Elliptic Prime Curve 384 bit (EC_secp384r1)

• Elliptic Prime Curve 521 bit (EC_secp521r1)

The certificate must be a valid SSL/TLS X.509 version 3 certificate with FQDN or IP address specified and information about the issuer.

endpointDetails

EndpointDetails endpointDetails

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

endpointType

String endpointType

The type of VPC endpoint that you want your server to connect to. You can choose to connect to the public internet or a VPC endpoint. With a VPC endpoint, you can restrict access to your server and resources only within your VPC.

It is recommended that you use VPC as the EndpointType. With this endpoint type, you have the option to directly associate up to three Elastic IPv4 addresses (BYO IP included) with your server's endpoint and use VPC security groups to restrict traffic by the client's public IP address. This is not possible with EndpointType set to VPC_ENDPOINT.

hostKey

String hostKey

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

If you aren't planning to migrate existing users from an existing SFTP-enabled server to a new server, don't update the host key. Accidentally changing a server's host key can be disruptive.

For more information, see Change the host key for your SFTP-enabled server in the AWS Transfer Family User Guide.

identityProviderDetails

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

identityProviderType

String identityProviderType

Specifies the mode of authentication for a server. The default value is SERVICE_MANAGED, which allows you to store and access user credentials within the 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.

loggingRole

String loggingRole

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

protocols

List<E> 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:

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

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

• FTP (File Transfer Protocol): Unencrypted file transfer

If you select FTPS, you must choose a certificate stored in AWS Certificate Manager (ACM) which will be used to identify your server when clients connect to it over FTPS.

If Protocol includes either FTP or FTPS, then the EndpointType must be VPC and the IdentityProviderType must be API_GATEWAY.

If Protocol includes FTP, then AddressAllocationIds cannot be associated.

If Protocol is set only to SFTP, the EndpointType can be set to PUBLIC and the IdentityProviderType can be set to SERVICE_MANAGED.

securityPolicyName

String securityPolicyName

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

tags

List<E> tags

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

Class com.amazonaws.services.transfer.model.CreateServerResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Serialized Fields

serverId

String serverId

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

Class com.amazonaws.services.transfer.model.CreateUserRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

homeDirectory

String homeDirectory

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

An example is your-Amazon-S3-bucket-name>/home/username .

homeDirectoryType

String homeDirectoryType

The type of landing directory (folder) you want your users' home directory to be when they log into the server. If you set it to PATH, the user will see the absolute Amazon S3 bucket paths as is in their file transfer protocol clients. If you set it LOGICAL, you will need to provide mappings in the HomeDirectoryMappings for how you want to make Amazon S3 paths visible to your users.

homeDirectoryMappings

List<E> homeDirectoryMappings

Logical directory mappings that specify what Amazon S3 paths and keys should be visible to your user and how you want to make them visible. You will need to specify the "Entry" and "Target" pair, where Entry shows how the path is made visible and Target is the actual Amazon S3 path. If you only specify a target, it will be displayed as is. You will need to also make sure that your IAM role provides access to paths in Target. The following is an example.

'[ "/bucket2/documentation", { "Entry": "your-personal-report.pdf", "Target": "/bucket3/customized-reports/${transfer:UserName}.pdf" } ]'

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

If the target of a logical directory entry does not exist in Amazon S3, the entry will be ignored. As a workaround, you can use the Amazon S3 API to create 0 byte objects as place holders for your directory. If using the CLI, use the s3api call instead of s3 so you can use the put-object operation. For example, you use the following: aws s3api put-object --bucket bucketname --key path/to/folder/. Make sure that the end of the key name ends in a '/' for it to be considered a folder.

policy

String policy

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 that you can use inside this policy include ${Transfer:UserName}, ${Transfer:HomeDirectory}, and ${Transfer:HomeBucket}.

For scope-down policies, AWS Transfer Family stores the policy as a JSON blob, instead of the Amazon Resource Name (ARN) of the policy. You save the policy as a JSON blob and pass it in the Policy argument.

For an example of a scope-down policy, see Creating a scope-down policy.

For more information, see AssumeRole in the AWS Security Token Service API Reference.

role

String role

The IAM role that controls your users' 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 server to access your resources when servicing your users' transfer requests.

serverId

String serverId

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

sshPublicKeyBody

String sshPublicKeyBody

The public portion of the Secure Shell (SSH) key used to authenticate the user to the server.

tags

List<E> tags

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

userName

String userName

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

Class com.amazonaws.services.transfer.model.CreateUserResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Serialized Fields

serverId

String serverId

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

userName

String userName

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

Class com.amazonaws.services.transfer.model.DeleteServerRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

serverId

String serverId

A unique system-assigned identifier for a server instance.

Class com.amazonaws.services.transfer.model.DeleteServerResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Class com.amazonaws.services.transfer.model.DeleteSshPublicKeyRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

serverId

String serverId

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

sshPublicKeyId

String sshPublicKeyId

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

userName

String userName

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

Class com.amazonaws.services.transfer.model.DeleteSshPublicKeyResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Class com.amazonaws.services.transfer.model.DeleteUserRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

serverId

String serverId

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

userName

String userName

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

Class com.amazonaws.services.transfer.model.DeleteUserResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Class com.amazonaws.services.transfer.model.DescribedSecurityPolicy extends Object implements Serializable

Serialized Fields

fips

Boolean fips

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

securityPolicyName

String securityPolicyName

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

sshCiphers

List<E> sshCiphers

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

sshKexs

List<E> sshKexs

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

sshMacs

List<E> sshMacs

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

tlsCiphers

List<E> tlsCiphers

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

Class com.amazonaws.services.transfer.model.DescribedServer extends Object implements Serializable

Serialized Fields

arn

String arn

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

certificate

String certificate

Specifies the ARN of the AWS Certificate Manager (ACM) certificate. Required when Protocols is set to FTPS.

endpointDetails

EndpointDetails endpointDetails

Specifies the virtual private cloud (VPC) endpoint settings that you configured for your server.

endpointType

String endpointType

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

hostKeyFingerprint

String hostKeyFingerprint

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

identityProviderDetails

IdentityProviderDetails identityProviderDetails

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

identityProviderType

String identityProviderType

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

Specifies the AWS Identity and Access Management (IAM) role that allows a server to turn on Amazon CloudWatch logging for Amazon S3 events. When set, user activity can be viewed in your CloudWatch logs.

protocols

List<E> 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:

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

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

• FTP (File Transfer Protocol): Unencrypted file transfer

securityPolicyName

String securityPolicyName

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

serverId

String serverId

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

state

String state

Specifies the condition of a 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<E> tags

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

userCount

Integer userCount

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

Class com.amazonaws.services.transfer.model.DescribedUser extends Object implements Serializable

Serialized Fields

arn

String arn

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

homeDirectory

String homeDirectory

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 is your-Amazon-S3-bucket-name>/home/username .

homeDirectoryMappings

List<E> homeDirectoryMappings

Specifies the logical directory mappings that specify what Amazon S3 paths and keys should be visible to your user and how you want to make them visible. You will need to specify the "Entry" and " Target" pair, where Entry shows how the path is made visible and Target is the actual Amazon S3 path. If you only specify a target, it will be displayed as is. You will need to also make sure that your AWS Identity and Access Management (IAM) role provides access to paths in Target.

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

homeDirectoryType

String homeDirectoryType

Specifies the type of landing directory (folder) you mapped for your users to see when they log into the file transfer protocol-enabled server. If you set it to PATH, the user will see the absolute Amazon S3 bucket paths as is in their file transfer protocol clients. If you set it LOGICAL, you will need to provide mappings in the HomeDirectoryMappings for how you want to make Amazon S3 paths visible to your users.

policy

String policy

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

role

String role

Specifies the IAM role that controls your users' 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 a server to access your resources when servicing your users' transfer requests.

sshPublicKeys

List<E> sshPublicKeys

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

tags

List<E> tags

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

userName

String userName

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

Class com.amazonaws.services.transfer.model.DescribeSecurityPolicyRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

securityPolicyName

String securityPolicyName

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

Class com.amazonaws.services.transfer.model.DescribeSecurityPolicyResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Serialized Fields

securityPolicy

DescribedSecurityPolicy securityPolicy

An array containing the properties of the security policy.

Class com.amazonaws.services.transfer.model.DescribeServerRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

serverId

String serverId

A system-assigned unique identifier for a server.

Class com.amazonaws.services.transfer.model.DescribeServerResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Serialized Fields

server

DescribedServer server

An array containing the properties of a server with the ServerID you specified.

Class com.amazonaws.services.transfer.model.DescribeUserRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

serverId

String serverId

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

userName

String userName

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 Family service and perform file transfer tasks.

Class com.amazonaws.services.transfer.model.DescribeUserResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Serialized Fields

serverId

String serverId

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

user

DescribedUser user

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

Class com.amazonaws.services.transfer.model.EndpointDetails extends Object implements Serializable

Serialized Fields

addressAllocationIds

List<E> addressAllocationIds

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

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

subnetIds

List<E> subnetIds

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

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

vpcEndpointId

String vpcEndpointId

The ID of the VPC endpoint.

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

vpcId

String vpcId

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

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

securityGroupIds

List<E> securityGroupIds

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

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

You can only edit the SecurityGroupIds property in the UpdateServer API and only if you are changing the EndpointType from PUBLIC or VPC_ENDPOINT to VPC.

Class com.amazonaws.services.transfer.model.HomeDirectoryMapEntry extends Object implements Serializable

Serialized Fields

entry

String entry

Represents an entry and a target for HomeDirectoryMappings.

target

String target

Represents the map target that is used in a HomeDirectorymapEntry.

Class com.amazonaws.services.transfer.model.IdentityProviderDetails extends Object implements Serializable

Serialized Fields

url

String url

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

invocationRole

String invocationRole

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

Class com.amazonaws.services.transfer.model.ImportSshPublicKeyRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

serverId

String serverId

A system-assigned unique identifier for a server.

sshPublicKeyBody

String sshPublicKeyBody

The public key portion of an SSH key pair.

userName

String userName

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

Class com.amazonaws.services.transfer.model.ImportSshPublicKeyResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Serialized Fields

serverId

String serverId

A system-assigned unique identifier for a server.

sshPublicKeyId

String sshPublicKeyId

The name given to a public key by the system that was imported.

userName

String userName

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

Class com.amazonaws.services.transfer.model.InternalServiceErrorException extends AWSTransferException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.transfer.model.InvalidNextTokenException extends AWSTransferException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.transfer.model.InvalidRequestException extends AWSTransferException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.transfer.model.ListedServer extends Object implements Serializable

Serialized Fields

arn

String arn

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

identityProviderType

String identityProviderType

Specifies the authentication method used to validate a user for a server that was specified. 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 endpointType

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

loggingRole

String loggingRole

Specifies the AWS Identity and Access Management (IAM) role that allows a server to turn on Amazon CloudWatch logging.

serverId

String serverId

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

state

String state

Specifies the condition of a 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.

userCount

Integer userCount

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

Class com.amazonaws.services.transfer.model.ListedUser extends Object implements Serializable

Serialized Fields

arn

String arn

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

homeDirectory

String homeDirectory

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

homeDirectoryType

String homeDirectoryType

Specifies the type of landing directory (folder) you mapped for your users' home directory. If you set it to PATH, the user will see the absolute Amazon S3 bucket paths as is in their file transfer protocol clients. If you set it LOGICAL, you will need to provide mappings in the HomeDirectoryMappings for how you want to make Amazon S3 paths visible to your users.

role

String role

Specifies the role that is in use by this user. A role is an AWS Identity and Access Management (IAM) entity that, in this case, allows a file transfer protocol-enabled 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 sshPublicKeyCount

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

userName

String userName

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

Class com.amazonaws.services.transfer.model.ListSecurityPoliciesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

maxResults

Integer maxResults

Specifies the number of security policies to return as a response to the ListSecurityPolicies query.

nextToken

String nextToken

When additional results are obtained from the ListSecurityPolicies command, a NextToken parameter is returned in the output. You can then pass the NextToken parameter in a subsequent command to continue listing additional security policies.

Class com.amazonaws.services.transfer.model.ListSecurityPoliciesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Serialized Fields

nextToken

String nextToken

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

securityPolicyNames

List<E> securityPolicyNames

An array of security policies that were listed.

Class com.amazonaws.services.transfer.model.ListServersRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

maxResults

Integer maxResults

Specifies the number of servers to return as a response to the ListServers query.

nextToken

String nextToken

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.

Class com.amazonaws.services.transfer.model.ListServersResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Serialized Fields

nextToken

String nextToken

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<E> servers

An array of servers that were listed.

Class com.amazonaws.services.transfer.model.ListTagsForResourceRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

arn

String arn

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 maxResults

Specifies the number of tags to return as a response to the ListTagsForResource request.

nextToken

String nextToken

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

Class com.amazonaws.services.transfer.model.ListTagsForResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Serialized Fields

arn

String arn

The ARN you specified to list the tags of.

nextToken

String nextToken

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

tags

List<E> tags

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.

Class com.amazonaws.services.transfer.model.ListUsersRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

maxResults

Integer maxResults

Specifies the number of users to return as a response to the ListUsers request.

nextToken

String nextToken

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

serverId

String serverId

A system-assigned unique identifier for a server that has users assigned to it.

Class com.amazonaws.services.transfer.model.ListUsersResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Serialized Fields

nextToken

String nextToken

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

serverId

String serverId

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

users

List<E> users

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

Class com.amazonaws.services.transfer.model.ResourceExistsException extends AWSTransferException implements Serializable

serialVersionUID:

1L

Serialized Fields

resource

String resource

resourceType

String resourceType

Class com.amazonaws.services.transfer.model.ResourceNotFoundException extends AWSTransferException implements Serializable

serialVersionUID:

1L

Serialized Fields

resource

String resource

resourceType

String resourceType

Class com.amazonaws.services.transfer.model.ServiceUnavailableException extends AWSTransferException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.transfer.model.SshPublicKey extends Object implements Serializable

Serialized Fields

dateImported

Date dateImported

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

sshPublicKeyBody

String sshPublicKeyBody

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

sshPublicKeyId

String sshPublicKeyId

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

Class com.amazonaws.services.transfer.model.StartServerRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

serverId

String serverId

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

Class com.amazonaws.services.transfer.model.StartServerResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Class com.amazonaws.services.transfer.model.StopServerRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

serverId

String serverId

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

Class com.amazonaws.services.transfer.model.StopServerResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Class com.amazonaws.services.transfer.model.Tag extends Object implements Serializable

Serialized Fields

key

String key

The name assigned to the tag that you create.

value

String value

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

Class com.amazonaws.services.transfer.model.TagResourceRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

arn

String arn

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

tags

List<E> tags

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.

Class com.amazonaws.services.transfer.model.TagResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Class com.amazonaws.services.transfer.model.TestIdentityProviderRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

serverId

String serverId

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

serverProtocol

String 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)

sourceIp

String sourceIp

The source IP address of the user account to be tested.

userName

String userName

The name of the user account to be tested.

userPassword

String userPassword

The password of the user account to be tested.

Class com.amazonaws.services.transfer.model.TestIdentityProviderResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Serialized Fields

response

String response

The response that is returned from your API Gateway.

statusCode

Integer statusCode

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

message

String message

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

url

String url

The endpoint of the service used to authenticate a user.

Class com.amazonaws.services.transfer.model.ThrottlingException extends AWSTransferException implements Serializable

serialVersionUID:

1L

Serialized Fields

retryAfterSeconds

String retryAfterSeconds

Class com.amazonaws.services.transfer.model.UntagResourceRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

arn

String arn

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<E> tagKeys

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.

Class com.amazonaws.services.transfer.model.UntagResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Class com.amazonaws.services.transfer.model.UpdateServerRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

certificate

String certificate

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

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

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

To request a private certificate to use FTPS through private IP addresses, see Request a private certificate in the AWS Certificate Manager User Guide.

Certificates with the following cryptographic algorithms and key sizes are supported:

• 2048-bit RSA (RSA_2048)

• 4096-bit RSA (RSA_4096)

• Elliptic Prime Curve 256 bit (EC_prime256v1)

• Elliptic Prime Curve 384 bit (EC_secp384r1)

• Elliptic Prime Curve 521 bit (EC_secp521r1)

The certificate must be a valid SSL/TLS X.509 version 3 certificate with FQDN or IP address specified and information about the issuer.

endpointDetails

EndpointDetails endpointDetails

The virtual private cloud (VPC) endpoint settings that are configured for your 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.

endpointType

String endpointType

The type of endpoint that you want your server to connect to. You can choose to connect to the public internet or a VPC endpoint. With a VPC endpoint, you can restrict access to your server and resources only within your VPC.

It is recommended that you use VPC as the EndpointType. With this endpoint type, you have the option to directly associate up to three Elastic IPv4 addresses (BYO IP included) with your server's endpoint and use VPC security groups to restrict traffic by the client's public IP address. This is not possible with EndpointType set to VPC_ENDPOINT.

hostKey

String hostKey

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

If you aren't planning to migrate existing users from an existing server to a new server, don't update the host key. Accidentally changing a server's host key can be disruptive.

For more information, see Change the host key for your SFTP-enabled server in the AWS Transfer Family User Guide.

identityProviderDetails

IdentityProviderDetails identityProviderDetails

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

loggingRole

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

protocols

List<E> 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

If you select FTPS, you must choose a certificate stored in AWS Certificate Manager (ACM) which will be used to identify your server when clients connect to it over FTPS.

If Protocol includes either FTP or FTPS, then the EndpointType must be VPC and the IdentityProviderType must be API_GATEWAY.

If Protocol includes FTP, then AddressAllocationIds cannot be associated.

If Protocol is set only to SFTP, the EndpointType can be set to PUBLIC and the IdentityProviderType can be set to SERVICE_MANAGED.

securityPolicyName

String securityPolicyName

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

serverId

String serverId

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

Class com.amazonaws.services.transfer.model.UpdateServerResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Serialized Fields

serverId

String serverId

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

Class com.amazonaws.services.transfer.model.UpdateUserRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

homeDirectory

String homeDirectory

Specifies the landing directory (folder) for a user when they log in to the server using their file transfer protocol client.

An example is your-Amazon-S3-bucket-name>/home/username.

homeDirectoryType

String homeDirectoryType

The type of landing directory (folder) you want your users' home directory to be when they log into the server. If you set it to PATH, the user will see the absolute Amazon S3 bucket paths as is in their file transfer protocol clients. If you set it LOGICAL, you will need to provide mappings in the HomeDirectoryMappings for how you want to make Amazon S3 paths visible to your users.

homeDirectoryMappings

List<E> homeDirectoryMappings

Logical directory mappings that specify what Amazon S3 paths and keys should be visible to your user and how you want to make them visible. You will need to specify the "Entry" and "Target" pair, where Entry shows how the path is made visible and Target is the actual Amazon S3 path. If you only specify a target, it will be displayed as is. You will need to also make sure that your IAM role provides access to paths in Target. The following is an example.

'[ "/bucket2/documentation", { "Entry": "your-personal-report.pdf", "Target": "/bucket3/customized-reports/${transfer:UserName}.pdf" } ]'

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

If the target of a logical directory entry does not exist in Amazon S3, the entry will be ignored. As a workaround, you can use the Amazon S3 API to create 0 byte objects as place holders for your directory. If using the CLI, use the s3api call instead of s3 so you can use the put-object operation. For example, you use the following: aws s3api put-object --bucket bucketname --key path/to/folder/. Make sure that the end of the key name ends in a / for it to be considered a folder.

policy

String policy

Allows you to supply a scope-down policy for your user so you can use the same IAM role across multiple users. The policy scopes down user access to portions of your Amazon S3 bucket. Variables you can use inside this policy include ${Transfer:UserName}, ${Transfer:HomeDirectory}, and ${Transfer:HomeBucket}.

For scope-down policies, AWS Transfer Family stores the policy as a JSON blob, instead of the Amazon Resource Name (ARN) of the policy. You save the policy as a JSON blob and pass it in the Policy argument.

For an example of a scope-down policy, see Creating a scope-down policy.

For more information, see AssumeRole in the AWS Security Token Service API Reference.

role

String role

The IAM role that controls your users' 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 server to access your resources when servicing your users' transfer requests.

serverId

String serverId

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

userName

String userName

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

Class com.amazonaws.services.transfer.model.UpdateUserResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Serialized Fields

serverId

String serverId

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

userName

String userName

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