# WARNING: DO NOT EDIT, AUTO-GENERATED CODE!
# See https://github.com/aws-beam/aws-codegen for more details.
defmodule AWS.Transfer do
@moduledoc """
Amazon Web Services 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).
Amazon Web Services helps you seamlessly migrate your file transfer workflows to
Amazon Web Services 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 services for processing, analytics,
machine learning, and archiving. Getting started with Amazon Web Services
Transfer Family is easy since there is no infrastructure to buy and set up.
"""
alias AWS.Client
alias AWS.Request
def metadata do
%AWS.ServiceMetadata{
abbreviation: "AWS Transfer",
api_version: "2018-11-05",
content_type: "application/x-amz-json-1.1",
credential_scope: nil,
endpoint_prefix: "transfer",
global?: false,
protocol: "json",
service_id: "Transfer",
signature_version: "v4",
signing_name: "transfer",
target_prefix: "TransferService"
}
end
@doc """
Used by administrators to choose which groups in the directory should have
access to upload and download files over the enabled protocols using Amazon Web
Services Transfer Family.
For example, a Microsoft Active Directory might contain 50,000 users, but only a
small fraction might need the ability to transfer files to the server. An
administrator can use `CreateAccess` to limit the access to the correct set of
users who need this ability.
"""
def create_access(%Client{} = client, input, options \\ []) do
Request.request_post(client, metadata(), "CreateAccess", input, options)
end
@doc """
Instantiates an auto-scaling virtual server based on the selected file transfer
protocol in Amazon Web Services.
When you make updates to your file transfer protocol-enabled server or when you
work with users, use the service-generated `ServerId` property that is assigned
to the newly created server.
"""
def create_server(%Client{} = client, input, options \\ []) do
Request.request_post(client, metadata(), "CreateServer", input, options)
end
@doc """
Creates a user and associates them with an existing file transfer
protocol-enabled server.
You can only create and associate users with servers that have the
`IdentityProviderType` set to `SERVICE_MANAGED`. Using parameters for
`CreateUser`, you can specify the user name, set the home directory, store the
user's public key, and assign the user's Amazon Web Services 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.
"""
def create_user(%Client{} = client, input, options \\ []) do
Request.request_post(client, metadata(), "CreateUser", input, options)
end
@doc """
Allows you to create a workflow with specified steps and step details the
workflow invokes after file transfer completes.
After creating a workflow, you can associate the workflow created with any
transfer servers by specifying the `workflow-details` field in `CreateServer`
and `UpdateServer` operations.
"""
def create_workflow(%Client{} = client, input, options \\ []) do
Request.request_post(client, metadata(), "CreateWorkflow", input, options)
end
@doc """
Allows you to delete the access specified in the `ServerID` and `ExternalID`
parameters.
"""
def delete_access(%Client{} = client, input, options \\ []) do
Request.request_post(client, metadata(), "DeleteAccess", input, options)
end
@doc """
Deletes the file transfer protocol-enabled server that you specify.
No response returns from this operation.
"""
def delete_server(%Client{} = client, input, options \\ []) do
Request.request_post(client, metadata(), "DeleteServer", input, options)
end
@doc """
Deletes a user's Secure Shell (SSH) public key.
"""
def delete_ssh_public_key(%Client{} = client, input, options \\ []) do
Request.request_post(client, metadata(), "DeleteSshPublicKey", input, options)
end
@doc """
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.
"""
def delete_user(%Client{} = client, input, options \\ []) do
Request.request_post(client, metadata(), "DeleteUser", input, options)
end
@doc """
Deletes the specified workflow.
"""
def delete_workflow(%Client{} = client, input, options \\ []) do
Request.request_post(client, metadata(), "DeleteWorkflow", input, options)
end
@doc """
Describes the access that is assigned to the specific file transfer
protocol-enabled server, as identified by its `ServerId` property and its
`ExternalID`.
The response from this call returns the properties of the access that is
associated with the `ServerId` value that was specified.
"""
def describe_access(%Client{} = client, input, options \\ []) do
Request.request_post(client, metadata(), "DescribeAccess", input, options)
end
@doc """
You can use `DescribeExecution` to check the details of the execution of the
specified workflow.
"""
def describe_execution(%Client{} = client, input, options \\ []) do
Request.request_post(client, metadata(), "DescribeExecution", input, options)
end
@doc """
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).
"""
def describe_security_policy(%Client{} = client, input, options \\ []) do
Request.request_post(client, metadata(), "DescribeSecurityPolicy", input, options)
end
@doc """
Describes a file transfer protocol-enabled server that you specify by passing
the `ServerId` parameter.
The response contains a description of a server's properties. When you set
`EndpointType` to VPC, the response will contain the `EndpointDetails`.
"""
def describe_server(%Client{} = client, input, options \\ []) do
Request.request_post(client, metadata(), "DescribeServer", input, options)
end
@doc """
Describes the user assigned to the specific file transfer protocol-enabled
server, as identified by its `ServerId` property.
The response from this call returns the properties of the user associated with
the `ServerId` value that was specified.
"""
def describe_user(%Client{} = client, input, options \\ []) do
Request.request_post(client, metadata(), "DescribeUser", input, options)
end
@doc """
Describes the specified workflow.
"""
def describe_workflow(%Client{} = client, input, options \\ []) do
Request.request_post(client, metadata(), "DescribeWorkflow", input, options)
end
@doc """
Adds a Secure Shell (SSH) public key to a user account identified by a
`UserName` value assigned to the specific file transfer protocol-enabled server,
identified by `ServerId`.
The response returns the `UserName` value, the `ServerId` value, and the name of
the `SshPublicKeyId`.
"""
def import_ssh_public_key(%Client{} = client, input, options \\ []) do
Request.request_post(client, metadata(), "ImportSshPublicKey", input, options)
end
@doc """
Lists the details for all the accesses you have on your server.
"""
def list_accesses(%Client{} = client, input, options \\ []) do
Request.request_post(client, metadata(), "ListAccesses", input, options)
end
@doc """
Lists all executions for the specified workflow.
"""
def list_executions(%Client{} = client, input, options \\ []) do
Request.request_post(client, metadata(), "ListExecutions", input, options)
end
@doc """
Lists the security policies that are attached to your file transfer
protocol-enabled servers.
"""
def list_security_policies(%Client{} = client, input, options \\ []) do
Request.request_post(client, metadata(), "ListSecurityPolicies", input, options)
end
@doc """
Lists the file transfer protocol-enabled servers that are associated with your
Amazon Web Services account.
"""
def list_servers(%Client{} = client, input, options \\ []) do
Request.request_post(client, metadata(), "ListServers", input, options)
end
@doc """
Lists all of the tags associated with the Amazon Resource Name (ARN) that you
specify.
The resource can be a user, server, or role.
"""
def list_tags_for_resource(%Client{} = client, input, options \\ []) do
Request.request_post(client, metadata(), "ListTagsForResource", input, options)
end
@doc """
Lists the users for a file transfer protocol-enabled server that you specify by
passing the `ServerId` parameter.
"""
def list_users(%Client{} = client, input, options \\ []) do
Request.request_post(client, metadata(), "ListUsers", input, options)
end
@doc """
Lists all of your workflows.
"""
def list_workflows(%Client{} = client, input, options \\ []) do
Request.request_post(client, metadata(), "ListWorkflows", input, options)
end
@doc """
Sends a callback for asynchronous custom steps.
The `ExecutionId`, `WorkflowId`, and `Token` are passed to the target resource
during execution of a custom step of a workflow. You must include those with
their callback as well as providing a status.
"""
def send_workflow_step_state(%Client{} = client, input, options \\ []) do
Request.request_post(client, metadata(), "SendWorkflowStepState", input, options)
end
@doc """
Changes the state of a file transfer protocol-enabled server from `OFFLINE` to
`ONLINE`.
It has no impact on a server that is already `ONLINE`. An `ONLINE` server can
accept and process file transfer jobs.
The state of `STARTING` indicates that the server is in an intermediate state,
either not fully able to respond, or not fully online. The values of
`START_FAILED` can indicate an error condition.
No response is returned from this call.
"""
def start_server(%Client{} = client, input, options \\ []) do
Request.request_post(client, metadata(), "StartServer", input, options)
end
@doc """
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 will 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.
No response is returned from this call.
"""
def stop_server(%Client{} = client, input, options \\ []) do
Request.request_post(client, metadata(), "StopServer", input, options)
end
@doc """
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.
"""
def tag_resource(%Client{} = client, input, options \\ []) do
Request.request_post(client, metadata(), "TagResource", input, options)
end
@doc """
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.
You cannot use `TestIdentityProvider` if the `IdentityProviderType` of your
server is `SERVICE_MANAGED`.
* 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`
"""
def test_identity_provider(%Client{} = client, input, options \\ []) do
Request.request_post(client, metadata(), "TestIdentityProvider", input, options)
end
@doc """
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.
"""
def untag_resource(%Client{} = client, input, options \\ []) do
Request.request_post(client, metadata(), "UntagResource", input, options)
end
@doc """
Allows you to update parameters for the access specified in the `ServerID` and
`ExternalID` parameters.
"""
def update_access(%Client{} = client, input, options \\ []) do
Request.request_post(client, metadata(), "UpdateAccess", input, options)
end
@doc """
Updates the file transfer protocol-enabled server's properties after that server
has been created.
The `UpdateServer` call returns the `ServerId` of the server you updated.
"""
def update_server(%Client{} = client, input, options \\ []) do
Request.request_post(client, metadata(), "UpdateServer", input, options)
end
@doc """
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.
"""
def update_user(%Client{} = client, input, options \\ []) do
Request.request_post(client, metadata(), "UpdateUser", input, options)
end
end
