Awso_transfer_lwtSourceval create_access :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_transfer.Values.CreateAccessRequest.t ->
(Awso_transfer.Values.CreateAccessResponse.t,
Awso_transfer.Values.CreateAccessResponse.error)
Result.t
Lwt.tval create_agreement :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_transfer.Values.CreateAgreementRequest.t ->
(Awso_transfer.Values.CreateAgreementResponse.t,
Awso_transfer.Values.CreateAgreementResponse.error)
Result.t
Lwt.tval create_connector :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_transfer.Values.CreateConnectorRequest.t ->
(Awso_transfer.Values.CreateConnectorResponse.t,
Awso_transfer.Values.CreateConnectorResponse.error)
Result.t
Lwt.tval create_profile :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_transfer.Values.CreateProfileRequest.t ->
(Awso_transfer.Values.CreateProfileResponse.t,
Awso_transfer.Values.CreateProfileResponse.error)
Result.t
Lwt.tval create_server :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_transfer.Values.CreateServerRequest.t ->
(Awso_transfer.Values.CreateServerResponse.t,
Awso_transfer.Values.CreateServerResponse.error)
Result.t
Lwt.tval create_user :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_transfer.Values.CreateUserRequest.t ->
(Awso_transfer.Values.CreateUserResponse.t,
Awso_transfer.Values.CreateUserResponse.error)
Result.t
Lwt.tval create_web_app :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_transfer.Values.CreateWebAppRequest.t ->
(Awso_transfer.Values.CreateWebAppResponse.t,
Awso_transfer.Values.CreateWebAppResponse.error)
Result.t
Lwt.tval create_workflow :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_transfer.Values.CreateWorkflowRequest.t ->
(Awso_transfer.Values.CreateWorkflowResponse.t,
Awso_transfer.Values.CreateWorkflowResponse.error)
Result.t
Lwt.tval delete_access :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_transfer.Values.DeleteAccessRequest.t ->
(unit, unit) Result.t Lwt.tval delete_agreement :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_transfer.Values.DeleteAgreementRequest.t ->
(unit, unit) Result.t Lwt.tval delete_certificate :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_transfer.Values.DeleteCertificateRequest.t ->
(unit, unit) Result.t Lwt.tval delete_connector :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_transfer.Values.DeleteConnectorRequest.t ->
(unit, unit) Result.t Lwt.tval delete_host_key :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_transfer.Values.DeleteHostKeyRequest.t ->
(unit, unit) Result.t Lwt.tval delete_profile :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_transfer.Values.DeleteProfileRequest.t ->
(unit, unit) Result.t Lwt.tval delete_server :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_transfer.Values.DeleteServerRequest.t ->
(unit, unit) Result.t Lwt.tval delete_ssh_public_key :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_transfer.Values.DeleteSshPublicKeyRequest.t ->
(unit, unit) Result.t Lwt.tval delete_user :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_transfer.Values.DeleteUserRequest.t ->
(unit, unit) Result.t Lwt.tval delete_web_app :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_transfer.Values.DeleteWebAppRequest.t ->
(unit, unit) Result.t Lwt.tval delete_web_app_customization :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_transfer.Values.DeleteWebAppCustomizationRequest.t ->
(unit, unit) Result.t Lwt.tval delete_workflow :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_transfer.Values.DeleteWorkflowRequest.t ->
(unit, unit) Result.t Lwt.tval describe_access :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_transfer.Values.DescribeAccessRequest.t ->
(Awso_transfer.Values.DescribeAccessResponse.t,
Awso_transfer.Values.DescribeAccessResponse.error)
Result.t
Lwt.tval describe_agreement :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_transfer.Values.DescribeAgreementRequest.t ->
(Awso_transfer.Values.DescribeAgreementResponse.t,
Awso_transfer.Values.DescribeAgreementResponse.error)
Result.t
Lwt.tval describe_certificate :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_transfer.Values.DescribeCertificateRequest.t ->
(Awso_transfer.Values.DescribeCertificateResponse.t,
Awso_transfer.Values.DescribeCertificateResponse.error)
Result.t
Lwt.tval describe_connector :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_transfer.Values.DescribeConnectorRequest.t ->
(Awso_transfer.Values.DescribeConnectorResponse.t,
Awso_transfer.Values.DescribeConnectorResponse.error)
Result.t
Lwt.tval describe_execution :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_transfer.Values.DescribeExecutionRequest.t ->
(Awso_transfer.Values.DescribeExecutionResponse.t,
Awso_transfer.Values.DescribeExecutionResponse.error)
Result.t
Lwt.tval describe_host_key :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_transfer.Values.DescribeHostKeyRequest.t ->
(Awso_transfer.Values.DescribeHostKeyResponse.t,
Awso_transfer.Values.DescribeHostKeyResponse.error)
Result.t
Lwt.tval describe_profile :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_transfer.Values.DescribeProfileRequest.t ->
(Awso_transfer.Values.DescribeProfileResponse.t,
Awso_transfer.Values.DescribeProfileResponse.error)
Result.t
Lwt.tval describe_security_policy :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_transfer.Values.DescribeSecurityPolicyRequest.t ->
(Awso_transfer.Values.DescribeSecurityPolicyResponse.t,
Awso_transfer.Values.DescribeSecurityPolicyResponse.error)
Result.t
Lwt.tval describe_server :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_transfer.Values.DescribeServerRequest.t ->
(Awso_transfer.Values.DescribeServerResponse.t,
Awso_transfer.Values.DescribeServerResponse.error)
Result.t
Lwt.tval describe_user :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_transfer.Values.DescribeUserRequest.t ->
(Awso_transfer.Values.DescribeUserResponse.t,
Awso_transfer.Values.DescribeUserResponse.error)
Result.t
Lwt.tval describe_web_app :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_transfer.Values.DescribeWebAppRequest.t ->
(Awso_transfer.Values.DescribeWebAppResponse.t,
Awso_transfer.Values.DescribeWebAppResponse.error)
Result.t
Lwt.tval describe_web_app_customization :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_transfer.Values.DescribeWebAppCustomizationRequest.t ->
(Awso_transfer.Values.DescribeWebAppCustomizationResponse.t,
Awso_transfer.Values.DescribeWebAppCustomizationResponse.error)
Result.t
Lwt.tval describe_workflow :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_transfer.Values.DescribeWorkflowRequest.t ->
(Awso_transfer.Values.DescribeWorkflowResponse.t,
Awso_transfer.Values.DescribeWorkflowResponse.error)
Result.t
Lwt.tval import_certificate :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_transfer.Values.ImportCertificateRequest.t ->
(Awso_transfer.Values.ImportCertificateResponse.t,
Awso_transfer.Values.ImportCertificateResponse.error)
Result.t
Lwt.tval import_host_key :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_transfer.Values.ImportHostKeyRequest.t ->
(Awso_transfer.Values.ImportHostKeyResponse.t,
Awso_transfer.Values.ImportHostKeyResponse.error)
Result.t
Lwt.tval import_ssh_public_key :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_transfer.Values.ImportSshPublicKeyRequest.t ->
(Awso_transfer.Values.ImportSshPublicKeyResponse.t,
Awso_transfer.Values.ImportSshPublicKeyResponse.error)
Result.t
Lwt.tval list_accesses :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_transfer.Values.ListAccessesRequest.t ->
(Awso_transfer.Values.ListAccessesResponse.t,
Awso_transfer.Values.ListAccessesResponse.error)
Result.t
Lwt.tval list_agreements :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_transfer.Values.ListAgreementsRequest.t ->
(Awso_transfer.Values.ListAgreementsResponse.t,
Awso_transfer.Values.ListAgreementsResponse.error)
Result.t
Lwt.tval list_certificates :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_transfer.Values.ListCertificatesRequest.t ->
(Awso_transfer.Values.ListCertificatesResponse.t,
Awso_transfer.Values.ListCertificatesResponse.error)
Result.t
Lwt.tval list_connectors :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_transfer.Values.ListConnectorsRequest.t ->
(Awso_transfer.Values.ListConnectorsResponse.t,
Awso_transfer.Values.ListConnectorsResponse.error)
Result.t
Lwt.tval list_executions :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_transfer.Values.ListExecutionsRequest.t ->
(Awso_transfer.Values.ListExecutionsResponse.t,
Awso_transfer.Values.ListExecutionsResponse.error)
Result.t
Lwt.tval list_file_transfer_results :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_transfer.Values.ListFileTransferResultsRequest.t ->
(Awso_transfer.Values.ListFileTransferResultsResponse.t,
Awso_transfer.Values.ListFileTransferResultsResponse.error)
Result.t
Lwt.tval list_host_keys :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_transfer.Values.ListHostKeysRequest.t ->
(Awso_transfer.Values.ListHostKeysResponse.t,
Awso_transfer.Values.ListHostKeysResponse.error)
Result.t
Lwt.tval list_profiles :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_transfer.Values.ListProfilesRequest.t ->
(Awso_transfer.Values.ListProfilesResponse.t,
Awso_transfer.Values.ListProfilesResponse.error)
Result.t
Lwt.tval list_security_policies :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_transfer.Values.ListSecurityPoliciesRequest.t ->
(Awso_transfer.Values.ListSecurityPoliciesResponse.t,
Awso_transfer.Values.ListSecurityPoliciesResponse.error)
Result.t
Lwt.tval list_servers :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_transfer.Values.ListServersRequest.t ->
(Awso_transfer.Values.ListServersResponse.t,
Awso_transfer.Values.ListServersResponse.error)
Result.t
Lwt.tval list_tags_for_resource :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_transfer.Values.ListTagsForResourceRequest.t ->
(Awso_transfer.Values.ListTagsForResourceResponse.t,
Awso_transfer.Values.ListTagsForResourceResponse.error)
Result.t
Lwt.tval list_users :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_transfer.Values.ListUsersRequest.t ->
(Awso_transfer.Values.ListUsersResponse.t,
Awso_transfer.Values.ListUsersResponse.error)
Result.t
Lwt.tval list_web_apps :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_transfer.Values.ListWebAppsRequest.t ->
(Awso_transfer.Values.ListWebAppsResponse.t,
Awso_transfer.Values.ListWebAppsResponse.error)
Result.t
Lwt.tval list_workflows :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_transfer.Values.ListWorkflowsRequest.t ->
(Awso_transfer.Values.ListWorkflowsResponse.t,
Awso_transfer.Values.ListWorkflowsResponse.error)
Result.t
Lwt.tval send_workflow_step_state :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_transfer.Values.SendWorkflowStepStateRequest.t ->
(Awso_transfer.Values.SendWorkflowStepStateResponse.t,
Awso_transfer.Values.SendWorkflowStepStateResponse.error)
Result.t
Lwt.tval start_directory_listing :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_transfer.Values.StartDirectoryListingRequest.t ->
(Awso_transfer.Values.StartDirectoryListingResponse.t,
Awso_transfer.Values.StartDirectoryListingResponse.error)
Result.t
Lwt.tval start_file_transfer :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_transfer.Values.StartFileTransferRequest.t ->
(Awso_transfer.Values.StartFileTransferResponse.t,
Awso_transfer.Values.StartFileTransferResponse.error)
Result.t
Lwt.tval start_remote_delete :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_transfer.Values.StartRemoteDeleteRequest.t ->
(Awso_transfer.Values.StartRemoteDeleteResponse.t,
Awso_transfer.Values.StartRemoteDeleteResponse.error)
Result.t
Lwt.tval start_remote_move :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_transfer.Values.StartRemoteMoveRequest.t ->
(Awso_transfer.Values.StartRemoteMoveResponse.t,
Awso_transfer.Values.StartRemoteMoveResponse.error)
Result.t
Lwt.tval start_server :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_transfer.Values.StartServerRequest.t ->
(unit, unit) Result.t Lwt.tval stop_server :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_transfer.Values.StopServerRequest.t ->
(unit, unit) Result.t Lwt.tval tag_resource :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_transfer.Values.TagResourceRequest.t ->
(unit, unit) Result.t Lwt.tval test_connection :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_transfer.Values.TestConnectionRequest.t ->
(Awso_transfer.Values.TestConnectionResponse.t,
Awso_transfer.Values.TestConnectionResponse.error)
Result.t
Lwt.tval test_identity_provider :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_transfer.Values.TestIdentityProviderRequest.t ->
(Awso_transfer.Values.TestIdentityProviderResponse.t,
Awso_transfer.Values.TestIdentityProviderResponse.error)
Result.t
Lwt.tval untag_resource :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_transfer.Values.UntagResourceRequest.t ->
(unit, unit) Result.t Lwt.tval update_access :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_transfer.Values.UpdateAccessRequest.t ->
(Awso_transfer.Values.UpdateAccessResponse.t,
Awso_transfer.Values.UpdateAccessResponse.error)
Result.t
Lwt.tval update_agreement :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_transfer.Values.UpdateAgreementRequest.t ->
(Awso_transfer.Values.UpdateAgreementResponse.t,
Awso_transfer.Values.UpdateAgreementResponse.error)
Result.t
Lwt.tval update_certificate :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_transfer.Values.UpdateCertificateRequest.t ->
(Awso_transfer.Values.UpdateCertificateResponse.t,
Awso_transfer.Values.UpdateCertificateResponse.error)
Result.t
Lwt.tval update_connector :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_transfer.Values.UpdateConnectorRequest.t ->
(Awso_transfer.Values.UpdateConnectorResponse.t,
Awso_transfer.Values.UpdateConnectorResponse.error)
Result.t
Lwt.tval update_host_key :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_transfer.Values.UpdateHostKeyRequest.t ->
(Awso_transfer.Values.UpdateHostKeyResponse.t,
Awso_transfer.Values.UpdateHostKeyResponse.error)
Result.t
Lwt.tval update_profile :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_transfer.Values.UpdateProfileRequest.t ->
(Awso_transfer.Values.UpdateProfileResponse.t,
Awso_transfer.Values.UpdateProfileResponse.error)
Result.t
Lwt.tval update_server :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_transfer.Values.UpdateServerRequest.t ->
(Awso_transfer.Values.UpdateServerResponse.t,
Awso_transfer.Values.UpdateServerResponse.error)
Result.t
Lwt.tval update_user :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_transfer.Values.UpdateUserRequest.t ->
(Awso_transfer.Values.UpdateUserResponse.t,
Awso_transfer.Values.UpdateUserResponse.error)
Result.t
Lwt.tval update_web_app :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_transfer.Values.UpdateWebAppRequest.t ->
(Awso_transfer.Values.UpdateWebAppResponse.t,
Awso_transfer.Values.UpdateWebAppResponse.error)
Result.t
Lwt.tval update_web_app_customization :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_transfer.Values.UpdateWebAppCustomizationRequest.t ->
(Awso_transfer.Values.UpdateWebAppCustomizationResponse.t,
Awso_transfer.Values.UpdateWebAppCustomizationResponse.error)
Result.t
Lwt.tinclude module type of struct include Awso_transfer.Values endval structure_to_value_aux :
('a * 'b option) list ->
f:(('a * 'b) list -> 'c) ->
[> `Structure of 'c ]val structure_to_wrapped_value :
wrapper:'a ->
response:'a ->
('b * 'c option) list ->
[> `Structure of ('a * [> `Structure of ('b * 'c) list ]) list ]Specifies the details for the file location for the file that's being used in the workflow. Only applicable if you are using Amazon Elastic File Systems (Amazon EFS) for storage.
Specifies the customer input Amazon S3 file location. If it is used inside copyStepDetails.DestinationFileLocation, it should be the S3 copy destination. You need to provide the bucket and key. The key can represent either a path or a file. This is determined by whether or not you end the key value with the forward slash (/) character. If the final character is "/", then your file is copied to the folder, and its name does not change. If, rather, the final character is alphanumeric, your uploaded file is renamed to the path value. In this case, if a file with that name already exists, it is overwritten. For example, if your path is shared-files/bob/, your uploaded files are copied to the shared-files/bob/, folder. If your path is shared-files/today, each uploaded file is copied to the shared-files folder and named today: each upload overwrites the previous version of the bob file.
Specifies the key-value pair that are assigned to a file during the execution of a Tagging step.
Specifies the location for the file that's being processed.
Specifies the error message and type, for an error that occurs during the execution of the workflow.
Specifies the details for the file location for the file that's being used in the workflow. Only applicable if you are using S3 storage.
Specifies the user name, server ID, and session ID for a workflow.
Each step type has its own StepDetails structure.
Each step type has its own StepDetails structure.
Each step type has its own StepDetails structure.
The name of the step, used to identify the delete step.
Each step type has its own StepDetails structure. The key/value pairs used to tag a file during the execution of a workflow step.
Specifies the workflow ID for the workflow to assign and the execution role that's used for executing the workflow. In addition to a workflow to execute when a file is uploaded completely, WorkflowDetails can also contain a workflow ID (and execution role) for a workflow to execute on partial upload. A partial upload occurs when the server session disconnects while the file is still being uploaded.
Specifies the following details for the step: error (if any), outputs (if any), and the step type.
module VpcLatticeResourceConfigurationArn =
Awso_transfer.Values.VpcLatticeResourceConfigurationArnSpecifies the Amazon S3 or EFS file details to be used in the step.
A container object for the session details that are associated with a workflow.
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.
The basic building block of a workflow.
Contains the VPC configuration details for a web app endpoint, including the VPC identifier, subnet IDs, and VPC endpoint ID used for hosting the endpoint.
A structure that contains the details of the IAM Identity Center used for your web app. Returned during a call to DescribeWebApp.
Represents an object that contains entries and targets for HomeDirectoryMappings. The following is an Entry and Target pair example for chroot. [ { "Entry": "/", "Target": "/bucket_name/home/mydirectory" } ]
Provides information about the public Secure Shell (SSH) key that is associated with a Transfer Family user for the specific file transfer protocol-enabled 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 server.
Contains the configuration details for asynchronous Message Disposition Notification (MDN) responses in AS2 connectors. This configuration specifies where asynchronous MDN responses should be sent and which servers should handle them.
module DescribedConnectorVpcLatticeEgressConfig =
Awso_transfer.Values.DescribedConnectorVpcLatticeEgressConfigVPC_LATTICE egress configuration details in the response, containing the Resource Configuration ARN and port number currently configured for the connector.
The number of concurrent connections that the connector will create to the remote server.
Contains the VPC configuration settings for updating a web app endpoint, including the subnet IDs where the endpoint should be deployed.
module UpdateWebAppIdentityCenterConfig =
Awso_transfer.Values.UpdateWebAppIdentityCenterConfigA structure that describes the values to use for the IAM Identity Center settings when you update a web app.
module UpdateConnectorVpcLatticeEgressConfig =
Awso_transfer.Values.UpdateConnectorVpcLatticeEgressConfigVPC_LATTICE egress configuration updates for modifying how the connector routes traffic through customer VPCs. Changes to these settings may require connector restart to take effect.
Represents a custom HTTP header that can be included in AS2 messages. Each header consists of a key-value pair.
Contains the identifier, text description, and Amazon Resource Name (ARN) for the workflow.
a structure that contains details for the web app.
Returns properties of the user that you specify.
Returns properties of a file transfer protocol-enabled server that was specified.
Returns the properties of the profile that was specified.
Returns properties of the host key that's specified.
A structure that contains the details for files transferred using an SFTP connector, during a single transfer.
Returns properties of the execution that is specified.
Returns details of the connector that is specified.
Describes the properties of a certificate.
Describes the properties of an agreement.
Lists the properties for one or more specified associated accesses.
Contains the endpoint configuration details for a web app, including VPC configuration when the endpoint is hosted within a VPC.
module DescribedWebAppIdentityProviderDetails =
Awso_transfer.Values.DescribedWebAppIdentityProviderDetailsReturns a structure that contains the identity provider details for your web app.
Contains an integer value that represents the value for number of concurrent connections or the user sessions on your web app.
The full POSIX identity, including user ID (Uid), group ID (Gid), and any secondary groups IDs (SecondaryGids), that controls your users' access to your Amazon EFS file systems. The POSIX permissions that are set on files and directories in your file system determine the level of access your users get when transferring files into and out of your Amazon EFS file systems.
The virtual private cloud (VPC) endpoint settings that are configured for your file transfer protocol-enabled server. With a VPC endpoint, you can restrict access to your server and resources only within your VPC. To control incoming internet traffic, invoke the UpdateServer API and attach an Elastic IP address to your server's endpoint. After May 19, 2021, you won't be able to create a server using EndpointType=VPC_ENDPOINT in your Amazon Web Services account if your account hasn't already done so before May 19, 2021. If you have already created servers with EndpointType=VPC_ENDPOINT in your Amazon Web Services account on or before May 19, 2021, you will not be affected. After this date, use EndpointType=VPC. For more information, see https://docs.aws.amazon.com/transfer/latest/userguide/create-server-in-vpc.html#deprecate-vpc-endpoint. 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.
Returns information related to the type of user authentication that is in use for a file transfer protocol-enabled server's users. A server can have only one method of authentication.
The protocol settings that are configured for your server.
The Amazon S3 storage options that are configured for your server.
Container for the WorkflowDetail data type. It is used by actions that trigger a workflow to begin execution.
Specifies the steps in the workflow, as well as the steps to execute in case of any errors during workflow execution.
Consists of the logging role and the log group name.
Contains the details for an AS2 connector object. The connector object is used for AS2 outbound processes, to connect the Transfer Family customer with the trading partner.
Response structure containing the current egress configuration details for the connector. Shows how traffic is currently routed from the connector to the SFTP server.
Contains the details for an SFTP connector object. The connector object is used for transferring files to and from a partner's SFTP server.
Contains Amazon S3 locations for storing specific types of AS2 message files.
Contains the VPC configuration settings for hosting a web app endpoint, including the VPC ID, subnet IDs, and security group IDs for access control.
A structure that describes the values to use for the IAM Identity Center settings when you create or update a web app.
VPC_LATTICE egress configuration that specifies the Resource Configuration ARN and port for connecting to SFTP servers through customer VPCs. Requires a valid Resource Configuration with appropriate network access.
You do not have sufficient access to perform this action.
This exception is thrown when the UpdateServer is called for a file transfer protocol-enabled server that has VPC as the endpoint type and the server's VpcEndpointID is not in the available state.
This exception is thrown when an error occurs in the Transfer Family service.
This exception is thrown when the client submits a malformed request.
This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.
The request was denied due to request throttling.
Contains the endpoint configuration details for updating a web app, including VPC settings for endpoints hosted within a VPC.
module UpdateWebAppIdentityProviderDetails =
Awso_transfer.Values.UpdateWebAppIdentityProviderDetailsA union that contains the UpdateWebAppIdentityCenterConfig object.
The request has failed because the Amazon Web ServicesTransfer Family service is not available.
The requested resource does not exist, or exists in a region other than the one specified for the command.
Structure for updating the egress configuration of an existing connector. Allows modification of how traffic is routed from the connector to the SFTP server, including VPC_LATTICE settings.
Contains the details for an SFTP connector connection.
The NextToken parameter that was passed is invalid.
Describes the properties of the specified workflow
A structure that describes the parameters for the web app, as identified by the WebAppId.
A structure that contains the customization fields for the web app. You can provide a title, logo, and icon to customize the appearance of your web app.
Describes the properties of a user that was specified.
Describes the properties of a file transfer protocol-enabled server that was specified.
Describes the properties of a security policy that you specify. For more information about security policies, see Working with security policies for servers or Working with security policies for SFTP connectors.
The details for a local or partner AS2 profile.
The details for a server host key.
The details for an execution object.
Describes the parameters for the connector, as identified by the ConnectorId.
Describes the properties of a certificate.
Describes the properties of an agreement.
Describes the properties of the access that was specified.
Contains the endpoint configuration for a web app, including VPC settings when the endpoint is hosted within a VPC.
A union that contains the IdentityCenterConfig object.
Configuration structure that defines how traffic is routed from the connector to the SFTP server. Contains VPC Lattice settings when using VPC_LATTICE egress type for private connectivity through customer VPCs.
Assigns new properties to a web app. You can modify the access point, identity provider details, endpoint configuration, and the web app units. For more information about using VPC endpoints with Transfer Family, see Create a Transfer Family web app in a VPC.
Assigns new properties to a web app. You can modify the access point, identity provider details, endpoint configuration, and the web app units. For more information about using VPC endpoints with Transfer Family, see Create a Transfer Family web app in a VPC.
module UpdateWebAppCustomizationResponse =
Awso_transfer.Values.UpdateWebAppCustomizationResponseAssigns new customization properties to a web app. You can modify the icon file, logo file, and title.
module UpdateWebAppCustomizationRequest =
Awso_transfer.Values.UpdateWebAppCustomizationRequestAssigns new customization properties to a web app. You can modify the icon file, logo file, and title.
UpdateUserResponse returns the user name and identifier for the request to update a user's properties.
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. In the console, you can select Restricted when you create or update a user. This ensures that the user can't access anything outside of their home directory. The programmatic way to configure this behavior is to update the user. Set their HomeDirectoryType to LOGICAL, and specify HomeDirectoryMappings with Entry as root (/) and Target as their home directory. For example, if the user's home directory is /test/admin-user, the following command updates the user so that their configuration in the console shows the Restricted flag as selected. aws transfer update-user --server-id <server-id> --user-name admin-user --home-directory-type LOGICAL --home-directory-mappings "[{\"Entry\":\"/\", \"Target\":\"/test/admin-user\"}]"
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.
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.
Updates some of the parameters for an existing profile. Provide the ProfileId for the profile that you want to update, along with the new values for the parameters to update.
Updates some of the parameters for an existing profile. Provide the ProfileId for the profile that you want to update, along with the new values for the parameters to update.
Updates the description for the host key that's specified by the ServerId and HostKeyId parameters.
Updates the description for the host key that's specified by the ServerId and HostKeyId parameters.
Updates some of the parameters for an existing connector. Provide the ConnectorId for the connector 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 the ConnectorId for the connector that you want to update, along with the new values for the parameters to update.
Updates the active and inactive dates for a certificate.
Updates the active and inactive dates for a certificate.
Updates some of the parameters for an existing agreement. Provide the AgreementId and the ServerId for the agreement that you want to update, along with the new values for the parameters to update. Specify either BaseDirectory or CustomDirectories, but not both. Specifying both causes the command to fail. If you update an agreement from using base directory to custom directories, the base directory is no longer used. Similarly, if you change from custom directories to a base directory, the custom directories are no longer used.
Updates some of the parameters for an existing agreement. Provide the AgreementId and the ServerId for the agreement that you want to update, along with the new values for the parameters to update. Specify either BaseDirectory or CustomDirectories, but not both. Specifying both causes the command to fail. If you update an agreement from using base directory to custom directories, the base directory is no longer used. Similarly, if you change from custom directories to a base directory, the custom directories are no longer used.
Allows you to update parameters for the access specified in the ServerID and ExternalID parameters.
Allows you to update parameters for the access specified in the ServerID and ExternalID parameters.
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.
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 the IdentityProviderType of your server is SERVICE_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).
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 the IdentityProviderType of your server is SERVICE_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).
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.
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.
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.
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. No response is returned from this call.
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.
Moves or renames a file or directory on the remote SFTP server.
Moves or renames a file or directory on the remote SFTP server.
Deletes a file or directory on the remote SFTP server.
Deletes a file or directory on the remote SFTP server.
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 more SendFilePaths 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 RetrieveFilePaths to identify the files you want to transfer, and a LocalDirectoryPath 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 a RemoteDirectoryPath to specify the destination folder.
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 more SendFilePaths 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 RetrieveFilePaths to identify the files you want to transfer, and a LocalDirectoryPath 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 a RemoteDirectoryPath to specify the destination folder.
Retrieves a list of the contents of a directory from a remote SFTP server. You specify the connector ID, the output path, and the remote directory path. You can also specify the optional MaxItems value to control the maximum number of items that are listed from the remote directory. This API returns a list of all files and directories in the remote directory (up to the maximum value), but does not return files or folders in sub-directories. That is, it only returns a list of files and directories one-level deep. After you receive the listing file, you can provide the files that you want to transfer to the RetrieveFilePaths parameter of the StartFileTransfer API call. The naming convention for the output file is connector-ID-listing-ID.json. The output file contains the following information: filePath: the complete path of a remote file, relative to the directory of the listing request for your SFTP connector on the remote server. modifiedTimestamp: the last time the file was modified, in UTC time format. This field is optional. If the remote file attributes don't contain a timestamp, it is omitted from the file listing. size: the size of the file, in bytes. This field is optional. If the remote file attributes don't contain a file size, it is omitted from the file listing. path: the complete path of a remote directory, relative to the directory of the listing request for your SFTP connector on the remote server. truncated: a flag indicating whether the list output contains all of the items contained in the remote directory or not. If your Truncated output value is true, you can increase the value provided in the optional max-items input attribute to be able to list more items (up to the maximum allowed list size of 200,000 items).
Retrieves a list of the contents of a directory from a remote SFTP server. You specify the connector ID, the output path, and the remote directory path. You can also specify the optional MaxItems value to control the maximum number of items that are listed from the remote directory. This API returns a list of all files and directories in the remote directory (up to the maximum value), but does not return files or folders in sub-directories. That is, it only returns a list of files and directories one-level deep. After you receive the listing file, you can provide the files that you want to transfer to the RetrieveFilePaths parameter of the StartFileTransfer API call. The naming convention for the output file is connector-ID-listing-ID.json. The output file contains the following information: filePath: the complete path of a remote file, relative to the directory of the listing request for your SFTP connector on the remote server. modifiedTimestamp: the last time the file was modified, in UTC time format. This field is optional. If the remote file attributes don't contain a timestamp, it is omitted from the file listing. size: the size of the file, in bytes. This field is optional. If the remote file attributes don't contain a file size, it is omitted from the file listing. path: the complete path of a remote directory, relative to the directory of the listing request for your SFTP connector on the remote server. truncated: a flag indicating whether the list output contains all of the items contained in the remote directory or not. If your Truncated output value is true, you can increase the value provided in the optional max-items input attribute to be able to list more items (up to the maximum allowed list size of 200,000 items).
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.
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.
Lists all workflows associated with your Amazon Web Services account for your current region.
Lists all workflows associated with your Amazon Web Services account for your current region.
Lists all web apps associated with your Amazon Web Services account for your current region. The response includes the endpoint type for each web app, showing whether it is publicly accessible or VPC hosted. For more information about using VPC endpoints with Transfer Family, see Create a Transfer Family web app in a VPC.
Lists all web apps associated with your Amazon Web Services account for your current region. The response includes the endpoint type for each web app, showing whether it is publicly accessible or VPC hosted. For more information about using VPC endpoints with Transfer Family, see Create a Transfer Family web app in a VPC.
Lists the users for a file transfer protocol-enabled server that you specify by passing the ServerId parameter.
Lists the users for a file transfer protocol-enabled server that you specify by passing the ServerId parameter.
Lists all of the tags associated with the Amazon Resource Name (ARN) that you specify. The resource can be a user, server, or role.
Lists all of the tags associated with the Amazon Resource Name (ARN) that you specify. The resource can be a user, server, or role.
Lists the file transfer protocol-enabled servers that are associated with your Amazon Web Services account.
Lists the file transfer protocol-enabled servers that are associated with your Amazon Web Services account.
Lists the security policies that are attached to your servers and SFTP connectors. For more information about security policies, see Working with security policies for servers or Working with security policies for SFTP connectors.
Lists the security policies that are attached to your servers and SFTP connectors. For more information about security policies, see Working with security policies for servers or Working with security policies for SFTP connectors.
Returns a list of the profiles for your system. If you want to limit the results to a certain number, supply a value for the MaxResults 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.
Returns a list of the profiles for your system. If you want to limit the results to a certain number, supply a value for the MaxResults 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.
Returns a list of host keys for the server that's specified by the ServerId parameter.
Returns a list of host keys for the server that's specified by the ServerId parameter.
Returns real-time updates and detailed information on the status of each individual file being transferred in a specific file transfer operation. You specify the file transfer by providing its ConnectorId and its TransferId. File transfer results are available up to 7 days after an operation has been requested.
Returns real-time updates and detailed information on the status of each individual file being transferred in a specific file transfer operation. You specify the file transfer by providing its ConnectorId and its TransferId. File transfer results are available up to 7 days after an operation has been requested.
Lists all in-progress executions for the specified workflow. If the specified workflow ID cannot be found, ListExecutions returns a ResourceNotFound exception.
Lists all in-progress executions for the specified workflow. If the specified workflow ID cannot be found, ListExecutions returns a ResourceNotFound exception.
Lists the connectors for the specified Region.
Lists the connectors for the specified Region.
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 the MaxResults 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.
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 the MaxResults 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.
Returns a list of the agreements for the server that's identified by the ServerId that you supply. If you want to limit the results to a certain number, supply a value for the 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 agreements for the server that's identified by the ServerId that you supply. If you want to limit the results to a certain number, supply a value for the 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.
Lists the details for all the accesses you have on your server.
Lists the details for all the accesses you have on your server.
Identifies the user, the 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 associated with.
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. The response returns the UserName value, the ServerId value, and the name of the SshPublicKeyId.
Adds a host key to the server that's specified by the ServerId parameter.
Adds a host key to the server that's specified by the ServerId parameter.
Imports the signing and encryption certificates that you need to create local (AS2) profiles and partner profiles. You can import both the certificate and its chain in the Certificate parameter. After importing a certificate, Transfer Family automatically creates a Amazon CloudWatch metric called DaysUntilExpiry that tracks the number of days until the certificate expires. The metric is based on the InactiveDate parameter and is published daily in the AWS/Transfer namespace. It can take up to a full day after importing a certificate for Transfer Family to emit the DaysUntilExpiry metric to your account. If you use the Certificate parameter to upload both the certificate and its chain, don't use the CertificateChain parameter. CloudWatch monitoring The DaysUntilExpiry metric includes the following specifications: Units: Count (days) Dimensions: CertificateId (always present), Description (if provided during certificate import) Statistics: Minimum, Maximum, Average Frequency: Published daily
Imports the signing and encryption certificates that you need to create local (AS2) profiles and partner profiles. You can import both the certificate and its chain in the Certificate parameter. After importing a certificate, Transfer Family automatically creates a Amazon CloudWatch metric called DaysUntilExpiry that tracks the number of days until the certificate expires. The metric is based on the InactiveDate parameter and is published daily in the AWS/Transfer namespace. It can take up to a full day after importing a certificate for Transfer Family to emit the DaysUntilExpiry metric to your account. If you use the Certificate parameter to upload both the certificate and its chain, don't use the CertificateChain parameter. CloudWatch monitoring The DaysUntilExpiry metric includes the following specifications: Units: Count (days) Dimensions: CertificateId (always present), Description (if provided during certificate import) Statistics: Minimum, Maximum, Average Frequency: Published daily
Describes the specified workflow.
Describes the specified workflow.
Describes the web app that's identified by WebAppId. The response includes endpoint configuration details such as whether the web app is publicly accessible or VPC hosted. For more information about using VPC endpoints with Transfer Family, see Create a Transfer Family web app in a VPC.
Describes the web app that's identified by WebAppId. The response includes endpoint configuration details such as whether the web app is publicly accessible or VPC hosted. For more information about using VPC endpoints with Transfer Family, see Create a Transfer Family web app in a VPC.
module DescribeWebAppCustomizationResponse =
Awso_transfer.Values.DescribeWebAppCustomizationResponseDescribes the web app customization object that's identified by WebAppId.
module DescribeWebAppCustomizationRequest =
Awso_transfer.Values.DescribeWebAppCustomizationRequestDescribes the web app customization object that's identified by WebAppId.
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.
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.
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.
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.
Describes the security policy that is attached to your server or SFTP connector. The response contains a description of the security policy's properties. For more information about security policies, see Working with security policies for servers or Working with security policies for SFTP connectors.
Describes the security policy that is attached to your server or SFTP connector. The response contains a description of the security policy's properties. For more information about security policies, see Working with security policies for servers or Working with security policies for SFTP connectors.
Returns the details of the profile that's specified by the ProfileId.
Returns the details of the profile that's specified by the ProfileId.
Returns the details of the host key that's specified by the HostKeyId and ServerId.
Returns the details of the host key that's specified by the HostKeyId and ServerId.
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 a ResourceNotFound exception.
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 a ResourceNotFound exception.
Describes the connector that's identified by the ConnectorId.
Describes the connector that's identified by the ConnectorId.
Describes the certificate that's identified by the CertificateId. Transfer Family automatically publishes a Amazon CloudWatch metric called DaysUntilExpiry for imported certificates. This metric tracks the number of days until the certificate expires based on the InactiveDate. The metric is available in the AWS/Transfer namespace and includes the CertificateId as a dimension.
Describes the certificate that's identified by the CertificateId. Transfer Family automatically publishes a Amazon CloudWatch metric called DaysUntilExpiry for imported certificates. This metric tracks the number of days until the certificate expires based on the InactiveDate. The metric is available in the AWS/Transfer namespace and includes the CertificateId as a dimension.
Describes the agreement that's identified by the AgreementId.
Describes the agreement that's identified by the AgreementId.
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.
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.
Deletes the specified workflow.
Deletes the specified web app.
module DeleteWebAppCustomizationRequest =
Awso_transfer.Values.DeleteWebAppCustomizationRequestDeletes the WebAppCustomization object that corresponds to the web app ID specified.
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.
Deletes a user's Secure Shell (SSH) public key.
Deletes the file transfer protocol-enabled server that you specify. No response returns from this operation.
Deletes the profile that's specified in the ProfileId parameter.
Deletes the host key that's specified in the HostKeyId parameter.
Deletes the connector that's specified in the provided ConnectorId.
Deletes the certificate that's specified in the CertificateId parameter.
Delete the agreement that's specified in the provided AgreementId.
Allows you to delete the access specified in the ServerID and ExternalID parameters.
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.
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.
Creates a web app based on specified parameters, and returns the ID for the new web app. You can configure the web app to be publicly accessible or hosted within a VPC. For more information about using VPC endpoints with Transfer Family, see Create a Transfer Family web app in a VPC.
Creates a web app based on specified parameters, and returns the ID for the new web app. You can configure the web app to be publicly accessible or hosted within a VPC. For more information about using VPC endpoints with Transfer Family, see Create a Transfer Family web app in a VPC.
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 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.
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 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.
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.
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.
Creates the local or partner profile to use for AS2 transfers.
Creates the local or partner profile to use for AS2 transfers.
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 Configure AS2 connectors and Create SFTP connectors. You must specify exactly one configuration object: either for AS2 (As2Config) or SFTP (SftpConfig).
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 Configure AS2 connectors and Create SFTP connectors. You must specify exactly one configuration object: either for AS2 (As2Config) or SFTP (SftpConfig).
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 the PartnerProfileId, and the AS2 process is identified with the LocalProfileId. Specify either BaseDirectory or CustomDirectories, but not both. Specifying both causes the command to fail.
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 the PartnerProfileId, and the AS2 process is identified with the LocalProfileId. Specify either BaseDirectory or CustomDirectories, but not both. Specifying both causes the command to fail.
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 use CreateAccess to limit the access to the correct set of users who need this ability.
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 use CreateAccess to limit the access to the correct set of users who need this ability.