View Source aws_transfer (aws v1.0.4)
Transfer Family is a fully managed service that enables the transfer of files over the File Transfer Protocol (FTP), File Transfer Protocol over SSL (FTPS), or Secure Shell (SSH) File Transfer Protocol (SFTP) directly into and out of Amazon Simple Storage Service (Amazon S3) or Amazon EFS.
Additionally, you can use Applicability Statement 2 (AS2) to transfer files into and out of Amazon S3. Amazon Web Services helps you seamlessly migrate your file transfer workflows to Transfer Family by integrating with existing authentication systems, and providing DNS routing with Amazon Route 53 so nothing changes for your customers and partners, or their applications. With your data in Amazon S3, you can use it with Amazon Web Services for processing, analytics, machine learning, and archiving. Getting started with Transfer Family is easy since there is no infrastructure to buy and set up.Summary
Functions
Used by administrators to choose which groups in the directory should have access to upload and download files over the enabled protocols using Transfer Family.
Creates an agreement.
Creates the connector, which captures the parameters for a connection for the AS2 or SFTP protocol.
Instantiates an auto-scaling virtual server based on the selected file transfer protocol in Amazon Web Services.
Creates a user and associates them with an existing file transfer protocol-enabled server.
Allows you to create a workflow with specified steps and step details the workflow invokes after file transfer completes.
ServerID
and ExternalID
parameters.AgreementId
.CertificateId
parameter.ConnectorId
.HostKeyId
parameter.ProfileId
parameter.Deletes the file transfer protocol-enabled server that you specify.
Deletes the user belonging to a file transfer protocol-enabled server you specify.
Describes the access that is assigned to the specific file transfer protocol-enabled server, as identified by its ServerId
property and its ExternalId
.
AgreementId
.CertificateId
.ConnectorId.
You can use DescribeExecution
to check the details of the execution of the specified workflow.
HostKeyId
and ServerId
.ProfileId
.Describes the security policy that is attached to your file transfer protocol-enabled server.
Describes a file transfer protocol-enabled server that you specify by passing the ServerId
parameter.
Describes the user assigned to the specific file transfer protocol-enabled server, as identified by its ServerId
property.
ServerId
parameter.Adds a Secure Shell (SSH) public key to a Transfer Family user identified by a UserName
value assigned to the specific file transfer protocol-enabled server, identified by ServerId
.
Returns a list of the agreements for the server that's identified by the ServerId
that you supply.
Returns a list of the current certificates that have been imported into Transfer Family.
Lists all in-progress executions for the specified workflow.
ServerId
parameter.Returns a list of the profiles for your system.
Lists all of the tags associated with the Amazon Resource Name (ARN) that you specify.
ServerId
parameter.Sends a callback for asynchronous custom steps.
Begins a file transfer between local Amazon Web Services storage and a remote AS2 or SFTP server.
Changes the state of a file transfer protocol-enabled server from OFFLINE
to ONLINE
.
Changes the state of a file transfer protocol-enabled server from ONLINE
to OFFLINE
.
Attaches a key-value pair to a resource, as identified by its Amazon Resource Name (ARN).
Tests whether your SFTP connector is set up successfully.
If the IdentityProviderType
of a file transfer protocol-enabled server is AWS_DIRECTORY_SERVICE
or API_Gateway
, tests whether your identity provider is set up successfully.
Detaches a key-value pair from a resource, as identified by its Amazon Resource Name (ARN).
ServerID
and ExternalID
parameters.Updates some of the parameters for an existing agreement.
Updates some of the parameters for an existing connector.
ServerId
and HostKeyId
parameters.Updates some of the parameters for an existing profile.
Updates the file transfer protocol-enabled server's properties after that server has been created.
Assigns new properties to a user.
Functions
Used by administrators to choose which groups in the directory should have access to upload and download files over the enabled protocols using Transfer Family.
For example, a Microsoft Active Directory might contain 50,000 users, but only a small fraction might need the ability to transfer files to the server. An administrator can useCreateAccess
to limit the access to the correct set of users who need this ability.
Creates an agreement.
An agreement is a bilateral trading partner agreement, or partnership, between an Transfer Family server and an AS2 process. The agreement defines the file and message transfer relationship between the server and the AS2 process. To define an agreement, Transfer Family combines a server, local profile, partner profile, certificate, and other attributes.
The partner is identified with thePartnerProfileId
, and the AS2 process is identified with the LocalProfileId
.
Creates the connector, which captures the parameters for a connection for the AS2 or SFTP protocol.
For AS2, the connector is required for sending files to an externally hosted AS2 server. For SFTP, the connector is required when sending files to an SFTP server or receiving files from an SFTP server. For more details about connectors, see Create AS2 connectors: https://docs.aws.amazon.com/transfer/latest/userguide/create-b2b-server.html#configure-as2-connector and Create SFTP connectors: https://docs.aws.amazon.com/transfer/latest/userguide/configure-sftp-connector.html.
You must specify exactly one configuration object: either for AS2 (As2Config
) or SFTP (SftpConfig
).
Instantiates an auto-scaling virtual server based on the selected file transfer protocol in Amazon Web Services.
When you make updates to your file transfer protocol-enabled server or when you work with users, use the service-generatedServerId
property that is assigned to the newly created server.
Creates a user and associates them with an existing file transfer protocol-enabled server.
You can only create and associate users with servers that have theIdentityProviderType
set to SERVICE_MANAGED
. Using parameters for CreateUser
, you can specify the user name, set the home directory, store the user's public key, and assign the user's Identity and Access Management (IAM) role. You can also optionally add a session policy, and assign metadata with tags that can be used to group and search for users.
Allows you to create a workflow with specified steps and step details the workflow invokes after file transfer completes.
After creating a workflow, you can associate the workflow created with any transfer servers by specifying theworkflow-details
field in CreateServer
and UpdateServer
operations.
ServerID
and ExternalID
parameters.
AgreementId
.
CertificateId
parameter.
ConnectorId
.
HostKeyId
parameter.
ProfileId
parameter.
Deletes the file transfer protocol-enabled server that you specify.
No response returns from this operation.Deletes the user belonging to a file transfer protocol-enabled server you specify.
No response returns from this operation.
When you delete a user from a server, the user's information is lost.Describes the access that is assigned to the specific file transfer protocol-enabled server, as identified by its ServerId
property and its ExternalId
.
ServerId
value that was specified.
AgreementId
.
CertificateId
.
ConnectorId.
You can use DescribeExecution
to check the details of the execution of the specified workflow.
This API call only returns details for in-progress workflows.
If you provide an ID for an execution that is not in progress, or if the execution doesn't match the specified workflow ID, you receive aResourceNotFound
exception.
HostKeyId
and ServerId
.
ProfileId
.
Describes the security policy that is attached to your file transfer protocol-enabled server.
The response contains a description of the security policy's properties. For more information about security policies, see Working with security policies: https://docs.aws.amazon.com/transfer/latest/userguide/security-policies.html.Describes a file transfer protocol-enabled server that you specify by passing the ServerId
parameter.
EndpointType
to VPC, the response will contain the EndpointDetails
.
Describes the user assigned to the specific file transfer protocol-enabled server, as identified by its ServerId
property.
ServerId
value that was specified.
ServerId
parameter.
Adds a Secure Shell (SSH) public key to a Transfer Family user identified by a UserName
value assigned to the specific file transfer protocol-enabled server, identified by ServerId
.
UserName
value, the ServerId
value, and the name of the SshPublicKeyId
.
Returns a list of the agreements for the server that's identified by the ServerId
that you supply.
MaxResults
parameter. If you ran the command previously and received a value for NextToken
, you can supply that value to continue listing agreements from where you left off.
Returns a list of the current certificates that have been imported into Transfer Family.
If you want to limit the results to a certain number, supply a value for theMaxResults
parameter. If you ran the command previously and received a value for the NextToken
parameter, you can supply that value to continue listing certificates from where you left off.
Lists all in-progress executions for the specified workflow.
If the specified workflow ID cannot be found,ListExecutions
returns a ResourceNotFound
exception.
ServerId
parameter.
Returns a list of the profiles for your system.
If you want to limit the results to a certain number, supply a value for theMaxResults
parameter. If you ran the command previously and received a value for NextToken
, you can supply that value to continue listing profiles from where you left off.
Lists all of the tags associated with the Amazon Resource Name (ARN) that you specify.
The resource can be a user, server, or role.ServerId
parameter.
Sends a callback for asynchronous custom steps.
TheExecutionId
, WorkflowId
, and Token
are passed to the target resource during execution of a custom step of a workflow. You must include those with their callback as well as providing a status.
Begins a file transfer between local Amazon Web Services storage and a remote AS2 or SFTP server.
For an AS2 connector, you specify the
ConnectorId
and one or moreSendFilePaths
to identify the files you want to transfer.For an SFTP connector, the file transfer can be either outbound or inbound. In both cases, you specify the
ConnectorId
. Depending on the direction of the transfer, you also specify the following items:If you are transferring file from a partner's SFTP server to Amazon Web Services storage, you specify one or more
RetreiveFilePaths
to identify the files you want to transfer, and aLocalDirectoryPath
to specify the destination folder.If you are transferring file to a partner's SFTP server from Amazon Web Services storage, you specify one or more
SendFilePaths
to identify the files you want to transfer, and aRemoteDirectoryPath
to specify the destination folder.
Changes the state of a file transfer protocol-enabled server from OFFLINE
to ONLINE
.
It has no impact on a server that is already ONLINE
. An ONLINE
server can accept and process file transfer jobs.
The state of STARTING
indicates that the server is in an intermediate state, either not fully able to respond, or not fully online. The values of START_FAILED
can indicate an error condition.
Changes the state of a file transfer protocol-enabled server from ONLINE
to OFFLINE
.
An OFFLINE
server cannot accept and process file transfer jobs. Information tied to your server, such as server and user properties, are not affected by stopping your server.
Stopping the server does not reduce or impact your file transfer protocol endpoint billing; you must delete the server to stop being billed.
The state of STOPPING
indicates that the server is in an intermediate state, either not fully able to respond, or not fully offline. The values of STOP_FAILED
can indicate an error condition.
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.Tests whether your SFTP connector is set up successfully.
We highly recommend that you call this operation to test your ability to transfer files between local Amazon Web Services storage and a trading partner's SFTP server.If the IdentityProviderType
of a file transfer protocol-enabled server is AWS_DIRECTORY_SERVICE
or API_Gateway
, tests whether your identity provider is set up successfully.
We highly recommend that you call this operation to test your authentication method as soon as you create your server. By doing so, you can troubleshoot issues with the identity provider integration to ensure that your users can successfully use the service.
The ServerId
and UserName
parameters are required. The ServerProtocol
, SourceIp
, and UserPassword
are all optional.
Note the following:
You cannot use
TestIdentityProvider
if theIdentityProviderType
of your server isSERVICE_MANAGED
.TestIdentityProvider
does not work with keys: it only accepts passwords.TestIdentityProvider
can test the password operation for a custom Identity Provider that handles keys and passwords.If you provide any incorrect values for any parameters, the
Response
field is empty.If you provide a server ID for a server that uses service-managed users, you get an error:
An error occurred (InvalidRequestException) when calling the TestIdentityProvider operation: s-server-ID not configured for external auth
If you enter a Server ID for the
--server-id
parameter that does not identify an actual Transfer server, you receive the following error:An error occurred (ResourceNotFoundException) when calling the TestIdentityProvider operation: Unknown server
.It is possible your sever is in a different region. You can specify a region by adding the following:
--region region-code
, such as--region us-east-2
to specify a server in US East (Ohio).
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.ServerID
and ExternalID
parameters.
Updates some of the parameters for an existing agreement.
Provide theAgreementId
and the ServerId
for the agreement that you want to update, along with the new values for the parameters to update.
Updates some of the parameters for an existing connector.
Provide theConnectorId
for the connector that you want to update, along with the new values for the parameters to update.
ServerId
and HostKeyId
parameters.
Updates some of the parameters for an existing profile.
Provide theProfileId
for the profile that you want to update, along with the new values for the parameters to update.
Updates the file transfer protocol-enabled server's properties after that server has been created.
TheUpdateServer
call returns the ServerId
of the server you updated.
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.
ServerId
and the UserName
for the updated user.