Module Smaws_Client_Transfer

Transfer client library built on EIO.

Types

module Types : sig ... end

Builders

val make_s3_input_file_location : ?key:Types.s3_key -> ?bucket:Types.s3_bucket -> unit -> Types.s3_input_file_location
val make_efs_file_location : ?path:Types.efs_path -> ?file_system_id:Types.efs_file_system_id -> unit -> Types.efs_file_location
val make_input_file_location : ?efs_file_location:Types.efs_file_location -> ?s3_file_location:Types.s3_input_file_location -> unit -> Types.input_file_location
val make_copy_step_details : ?source_file_location:Types.source_file_location -> ?overwrite_existing:Types.overwrite_existing -> ?destination_file_location:Types.input_file_location -> ?name:Types.workflow_step_name -> unit -> Types.copy_step_details
val make_custom_step_details : ?source_file_location:Types.source_file_location -> ?timeout_seconds:Types.custom_step_timeout_seconds -> ?target:Types.custom_step_target -> ?name:Types.workflow_step_name -> unit -> Types.custom_step_details
val make_delete_step_details : ?source_file_location:Types.source_file_location -> ?name:Types.workflow_step_name -> unit -> Types.delete_step_details
val make_s3_tag : value:Types.s3_tag_value -> key:Types.s3_tag_key -> unit -> Types.s3_tag
val make_tag_step_details : ?source_file_location:Types.source_file_location -> ?tags:Types.s3_tags -> ?name:Types.workflow_step_name -> unit -> Types.tag_step_details
val make_decrypt_step_details : ?overwrite_existing:Types.overwrite_existing -> ?source_file_location:Types.source_file_location -> ?name:Types.workflow_step_name -> destination_file_location:Types.input_file_location -> type_:Types.encryption_type -> unit -> Types.decrypt_step_details
val make_workflow_step : ?decrypt_step_details:Types.decrypt_step_details -> ?tag_step_details:Types.tag_step_details -> ?delete_step_details:Types.delete_step_details -> ?custom_step_details:Types.custom_step_details -> ?copy_step_details:Types.copy_step_details -> ?type_:Types.workflow_step_type -> unit -> Types.workflow_step
val make_workflow_detail : execution_role:Types.role -> workflow_id:Types.workflow_id -> unit -> Types.workflow_detail
val make_workflow_details : ?on_partial_upload:Types.on_partial_upload_workflow_details -> ?on_upload:Types.on_upload_workflow_details -> unit -> Types.workflow_details
val make_web_app_vpc_config : ?ip_address_type:Types.web_app_vpc_endpoint_ip_address_type -> ?security_group_ids:Types.security_group_ids -> ?vpc_id:Types.vpc_id -> ?subnet_ids:Types.subnet_ids -> unit -> Types.web_app_vpc_config
val make_identity_center_config : ?role:Types.role -> ?instance_arn:Types.identity_center_instance_arn -> unit -> Types.identity_center_config
val make_user_details : ?session_id:Types.session_id -> server_id:Types.server_id -> user_name:Types.user_name -> unit -> Types.user_details
val make_update_web_app_vpc_config : ?ip_address_type:Types.web_app_vpc_endpoint_ip_address_type -> ?subnet_ids:Types.subnet_ids -> unit -> Types.update_web_app_vpc_config
val make_update_web_app_response : web_app_id:Types.web_app_id -> unit -> Types.update_web_app_response
val make_update_web_app_identity_center_config : ?role:Types.role -> unit -> Types.update_web_app_identity_center_config
val make_update_web_app_request : ?endpoint_details:Types.update_web_app_endpoint_details -> ?web_app_units:Types.web_app_units -> ?access_endpoint:Types.web_app_access_endpoint -> ?identity_provider_details:Types.update_web_app_identity_provider_details -> web_app_id:Types.web_app_id -> unit -> Types.update_web_app_request
val make_update_web_app_customization_response : web_app_id:Types.web_app_id -> unit -> Types.update_web_app_customization_response
val make_update_web_app_customization_request : ?favicon_file:Types.web_app_favicon_file -> ?logo_file:Types.web_app_logo_file -> ?title:Types.web_app_title -> web_app_id:Types.web_app_id -> unit -> Types.update_web_app_customization_request
val make_update_user_response : user_name:Types.user_name -> server_id:Types.server_id -> unit -> Types.update_user_response
val make_home_directory_map_entry : ?type_:Types.map_type -> target:Types.map_target -> entry:Types.map_entry -> unit -> Types.home_directory_map_entry
val make_posix_profile : ?secondary_gids:Types.secondary_gids -> gid:Types.posix_id -> uid:Types.posix_id -> unit -> Types.posix_profile
val make_update_user_request : ?role:Types.role -> ?posix_profile:Types.posix_profile -> ?policy:Types.policy -> ?home_directory_mappings:Types.home_directory_mappings -> ?home_directory_type:Types.home_directory_type -> ?home_directory:Types.home_directory -> user_name:Types.user_name -> server_id:Types.server_id -> unit -> Types.update_user_request
val make_update_server_response : server_id:Types.server_id -> unit -> Types.update_server_response
val make_protocol_details : ?as2_transports:Types.as2_transports -> ?set_stat_option:Types.set_stat_option -> ?tls_session_resumption_mode:Types.tls_session_resumption_mode -> ?passive_ip:Types.passive_ip -> unit -> Types.protocol_details
val make_endpoint_details : ?security_group_ids:Types.security_group_ids -> ?vpc_id:Types.vpc_id -> ?vpc_endpoint_id:Types.vpc_endpoint_id -> ?subnet_ids:Types.subnet_ids -> ?address_allocation_ids:Types.address_allocation_ids -> unit -> Types.endpoint_details
val make_identity_provider_details : ?sftp_authentication_methods:Types.sftp_authentication_methods -> ?function:Types.function -> ?directory_id:Types.directory_id -> ?invocation_role:Types.role -> ?url:Types.url -> unit -> Types.identity_provider_details
val make_s3_storage_options : ?directory_listing_optimization:Types.directory_listing_optimization -> unit -> Types.s3_storage_options
val make_update_server_request : ?identity_provider_type:Types.identity_provider_type -> ?ip_address_type:Types.ip_address_type -> ?s3_storage_options:Types.s3_storage_options -> ?structured_log_destinations:Types.structured_log_destinations -> ?workflow_details:Types.workflow_details -> ?security_policy_name:Types.security_policy_name -> ?protocols:Types.protocols -> ?pre_authentication_login_banner:Types.pre_authentication_login_banner -> ?post_authentication_login_banner:Types.post_authentication_login_banner -> ?logging_role:Types.nullable_role -> ?identity_provider_details:Types.identity_provider_details -> ?host_key:Types.host_key -> ?endpoint_type:Types.endpoint_type -> ?endpoint_details:Types.endpoint_details -> ?protocol_details:Types.protocol_details -> ?certificate:Types.certificate -> server_id:Types.server_id -> unit -> Types.update_server_request
val make_update_profile_response : profile_id:Types.profile_id -> unit -> Types.update_profile_response
val make_update_profile_request : ?certificate_ids:Types.certificate_ids -> profile_id:Types.profile_id -> unit -> Types.update_profile_request
val make_update_host_key_response : host_key_id:Types.host_key_id -> server_id:Types.server_id -> unit -> Types.update_host_key_response
val make_update_host_key_request : description:Types.host_key_description -> host_key_id:Types.host_key_id -> server_id:Types.server_id -> unit -> Types.update_host_key_request
val make_update_connector_vpc_lattice_egress_config : ?port_number:Types.sftp_port -> ?resource_configuration_arn:Types.vpc_lattice_resource_configuration_arn -> unit -> Types.update_connector_vpc_lattice_egress_config
val make_update_connector_response : connector_id:Types.connector_id -> unit -> Types.update_connector_response
val make_as2_async_mdn_connector_config : ?server_ids:Types.as2_async_mdn_server_ids -> ?url:Types.url -> unit -> Types.as2_async_mdn_connector_config
val make_as2_connector_config : ?async_mdn_config:Types.as2_async_mdn_connector_config -> ?preserve_content_type:Types.preserve_content_type -> ?basic_auth_secret_id:Types.as2_connector_secret_id -> ?mdn_response:Types.mdn_response -> ?mdn_signing_algorithm:Types.mdn_signing_alg -> ?signing_algorithm:Types.signing_alg -> ?encryption_algorithm:Types.encryption_alg -> ?compression:Types.compression_enum -> ?message_subject:Types.message_subject -> ?partner_profile_id:Types.profile_id -> ?local_profile_id:Types.profile_id -> unit -> Types.as2_connector_config
val make_sftp_connector_config : ?max_concurrent_connections:Types.max_concurrent_connections -> ?trusted_host_keys:Types.sftp_connector_trusted_host_key_list -> ?user_secret_id:Types.secret_id -> unit -> Types.sftp_connector_config
val make_update_connector_request : ?ip_address_type:Types.connectors_ip_address_type -> ?egress_config:Types.update_connector_egress_config -> ?security_policy_name:Types.connector_security_policy_name -> ?sftp_config:Types.sftp_connector_config -> ?logging_role:Types.role -> ?access_role:Types.role -> ?as2_config:Types.as2_connector_config -> ?url:Types.url -> connector_id:Types.connector_id -> unit -> Types.update_connector_request
val make_update_certificate_response : certificate_id:Types.certificate_id -> unit -> Types.update_certificate_response
val make_update_certificate_request : ?description:Types.description -> ?inactive_date:Types.cert_date -> ?active_date:Types.cert_date -> certificate_id:Types.certificate_id -> unit -> Types.update_certificate_request
val make_update_agreement_response : agreement_id:Types.agreement_id -> unit -> Types.update_agreement_response
val make_custom_directories_type : temporary_files_directory:Types.home_directory -> status_files_directory:Types.home_directory -> payload_files_directory:Types.home_directory -> mdn_files_directory:Types.home_directory -> failed_files_directory:Types.home_directory -> unit -> Types.custom_directories_type
val make_update_agreement_request : ?custom_directories:Types.custom_directories_type -> ?enforce_message_signing:Types.enforce_message_signing_type -> ?preserve_filename:Types.preserve_filename_type -> ?access_role:Types.role -> ?base_directory:Types.home_directory -> ?partner_profile_id:Types.profile_id -> ?local_profile_id:Types.profile_id -> ?status:Types.agreement_status_type -> ?description:Types.description -> server_id:Types.server_id -> agreement_id:Types.agreement_id -> unit -> Types.update_agreement_request
val make_update_access_response : external_id:Types.external_id -> server_id:Types.server_id -> unit -> Types.update_access_response
val make_update_access_request : ?role:Types.role -> ?posix_profile:Types.posix_profile -> ?policy:Types.policy -> ?home_directory_mappings:Types.home_directory_mappings -> ?home_directory_type:Types.home_directory_type -> ?home_directory:Types.home_directory -> external_id:Types.external_id -> server_id:Types.server_id -> unit -> Types.update_access_request
val make_untag_resource_request : tag_keys:Types.tag_keys -> arn:Types.arn -> unit -> Types.untag_resource_request
val make_test_identity_provider_response : ?message:Types.message -> ?response:Types.response -> url:Types.url -> status_code:Types.status_code -> unit -> Types.test_identity_provider_response
val make_test_identity_provider_request : ?user_password:Types.user_password -> ?source_ip:Types.source_ip -> ?server_protocol:Types.protocol -> user_name:Types.user_name -> server_id:Types.server_id -> unit -> Types.test_identity_provider_request
val make_sftp_connector_connection_details : ?host_key:Types.sftp_connector_host_key -> unit -> Types.sftp_connector_connection_details
val make_test_connection_response : ?sftp_connection_details:Types.sftp_connector_connection_details -> ?status_message:Types.message -> ?status:Types.status -> ?connector_id:Types.connector_id -> unit -> Types.test_connection_response
val make_test_connection_request : connector_id:Types.connector_id -> unit -> Types.test_connection_request
val make_tag : value:Types.tag_value -> key:Types.tag_key -> unit -> Types.tag
val make_tag_resource_request : tags:Types.tags -> arn:Types.arn -> unit -> Types.tag_resource_request
val make_stop_server_request : server_id:Types.server_id -> unit -> Types.stop_server_request
val make_start_server_request : server_id:Types.server_id -> unit -> Types.start_server_request
val make_start_remote_move_response : move_id:Types.move_id -> unit -> Types.start_remote_move_response
val make_start_remote_move_request : target_path:Types.file_path -> source_path:Types.file_path -> connector_id:Types.connector_id -> unit -> Types.start_remote_move_request
val make_start_remote_delete_response : delete_id:Types.delete_id -> unit -> Types.start_remote_delete_response
val make_start_remote_delete_request : delete_path:Types.file_path -> connector_id:Types.connector_id -> unit -> Types.start_remote_delete_request
val make_start_file_transfer_response : transfer_id:Types.transfer_id -> unit -> Types.start_file_transfer_response
val make_start_file_transfer_request : ?custom_http_headers:Types.custom_http_headers -> ?remote_directory_path:Types.file_path -> ?local_directory_path:Types.file_path -> ?retrieve_file_paths:Types.file_paths -> ?send_file_paths:Types.file_paths -> connector_id:Types.connector_id -> unit -> Types.start_file_transfer_request
val make_start_directory_listing_response : output_file_name:Types.output_file_name -> listing_id:Types.listing_id -> unit -> Types.start_directory_listing_response
val make_start_directory_listing_request : ?max_items:Types.max_items -> output_directory_path:Types.file_path -> remote_directory_path:Types.file_path -> connector_id:Types.connector_id -> unit -> Types.start_directory_listing_request
val make_send_workflow_step_state_response : unit -> unit
val make_send_workflow_step_state_request : status:Types.custom_step_status -> token:Types.callback_token -> execution_id:Types.execution_id -> workflow_id:Types.workflow_id -> unit -> Types.send_workflow_step_state_request
val make_list_tags_for_resource_response : ?tags:Types.tags -> ?next_token:Types.next_token -> ?arn:Types.arn -> unit -> Types.list_tags_for_resource_response
val make_list_tags_for_resource_request : ?next_token:Types.next_token -> ?max_results:Types.max_results -> arn:Types.arn -> unit -> Types.list_tags_for_resource_request
val make_list_security_policies_response : ?next_token:Types.next_token -> security_policy_names:Types.security_policy_names -> unit -> Types.list_security_policies_response
val make_list_security_policies_request : ?next_token:Types.next_token -> ?max_results:Types.max_results -> unit -> Types.list_security_policies_request
val make_listed_host_key : ?date_imported:Types.date_imported -> ?type_:Types.host_key_type -> ?description:Types.host_key_description -> ?fingerprint:Types.host_key_fingerprint -> ?host_key_id:Types.host_key_id -> arn:Types.arn -> unit -> Types.listed_host_key
val make_list_host_keys_response : ?next_token:Types.next_token -> host_keys:Types.listed_host_keys -> server_id:Types.server_id -> unit -> Types.list_host_keys_response
val make_list_host_keys_request : ?next_token:Types.next_token -> ?max_results:Types.max_results -> server_id:Types.server_id -> unit -> Types.list_host_keys_request
val make_list_file_transfer_results_response : ?next_token:Types.next_token -> file_transfer_results:Types.connector_file_transfer_results -> unit -> Types.list_file_transfer_results_response
val make_list_file_transfer_results_request : ?max_results:Types.max_results -> ?next_token:Types.next_token -> transfer_id:Types.transfer_id -> connector_id:Types.connector_id -> unit -> Types.list_file_transfer_results_request
val make_s3_file_location : ?etag:Types.s3_etag -> ?version_id:Types.s3_version_id -> ?key:Types.s3_key -> ?bucket:Types.s3_bucket -> unit -> Types.s3_file_location
val make_file_location : ?efs_file_location:Types.efs_file_location -> ?s3_file_location:Types.s3_file_location -> unit -> Types.file_location
val make_service_metadata : user_details:Types.user_details -> unit -> Types.service_metadata
val make_listed_execution : ?status:Types.execution_status -> ?service_metadata:Types.service_metadata -> ?initial_file_location:Types.file_location -> ?execution_id:Types.execution_id -> unit -> Types.listed_execution
val make_list_executions_response : ?next_token:Types.next_token -> executions:Types.listed_executions -> workflow_id:Types.workflow_id -> unit -> Types.list_executions_response
val make_list_executions_request : ?next_token:Types.next_token -> ?max_results:Types.max_results -> workflow_id:Types.workflow_id -> unit -> Types.list_executions_request
val make_listed_access : ?external_id:Types.external_id -> ?role:Types.role -> ?home_directory_type:Types.home_directory_type -> ?home_directory:Types.home_directory -> unit -> Types.listed_access
val make_list_accesses_response : ?next_token:Types.next_token -> accesses:Types.listed_accesses -> server_id:Types.server_id -> unit -> Types.list_accesses_response
val make_list_accesses_request : ?next_token:Types.next_token -> ?max_results:Types.max_results -> server_id:Types.server_id -> unit -> Types.list_accesses_request
val make_import_ssh_public_key_response : user_name:Types.user_name -> ssh_public_key_id:Types.ssh_public_key_id -> server_id:Types.server_id -> unit -> Types.import_ssh_public_key_response
val make_import_ssh_public_key_request : user_name:Types.user_name -> ssh_public_key_body:Types.ssh_public_key_body -> server_id:Types.server_id -> unit -> Types.import_ssh_public_key_request
val make_import_host_key_response : host_key_id:Types.host_key_id -> server_id:Types.server_id -> unit -> Types.import_host_key_response
val make_import_host_key_request : ?tags:Types.tags -> ?description:Types.host_key_description -> host_key_body:Types.host_key -> server_id:Types.server_id -> unit -> Types.import_host_key_request
val make_described_security_policy : ?protocols:Types.security_policy_protocols -> ?type_:Types.security_policy_resource_type -> ?ssh_host_key_algorithms:Types.security_policy_options -> ?tls_ciphers:Types.security_policy_options -> ?ssh_macs:Types.security_policy_options -> ?ssh_kexs:Types.security_policy_options -> ?ssh_ciphers:Types.security_policy_options -> ?fips:Types.fips -> security_policy_name:Types.security_policy_name -> unit -> Types.described_security_policy
val make_describe_security_policy_response : security_policy:Types.described_security_policy -> unit -> Types.describe_security_policy_response
val make_describe_security_policy_request : security_policy_name:Types.security_policy_name -> unit -> Types.describe_security_policy_request
val make_described_host_key : ?tags:Types.tags -> ?date_imported:Types.date_imported -> ?type_:Types.host_key_type -> ?description:Types.host_key_description -> ?host_key_fingerprint:Types.host_key_fingerprint -> ?host_key_id:Types.host_key_id -> arn:Types.arn -> unit -> Types.described_host_key
val make_describe_host_key_response : host_key:Types.described_host_key -> unit -> Types.describe_host_key_response
val make_describe_host_key_request : host_key_id:Types.host_key_id -> server_id:Types.server_id -> unit -> Types.describe_host_key_request
val make_logging_configuration : ?log_group_name:Types.log_group_name -> ?logging_role:Types.role -> unit -> Types.logging_configuration
val make_execution_error : message:Types.execution_error_message -> type_:Types.execution_error_type -> unit -> Types.execution_error
val make_execution_results : ?on_exception_steps:Types.execution_step_results -> ?steps:Types.execution_step_results -> unit -> Types.execution_results
val make_described_execution : ?results:Types.execution_results -> ?status:Types.execution_status -> ?posix_profile:Types.posix_profile -> ?logging_configuration:Types.logging_configuration -> ?execution_role:Types.role -> ?service_metadata:Types.service_metadata -> ?initial_file_location:Types.file_location -> ?execution_id:Types.execution_id -> unit -> Types.described_execution
val make_describe_execution_response : execution:Types.described_execution -> workflow_id:Types.workflow_id -> unit -> Types.describe_execution_response
val make_describe_execution_request : workflow_id:Types.workflow_id -> execution_id:Types.execution_id -> unit -> Types.describe_execution_request
val make_described_access : ?external_id:Types.external_id -> ?role:Types.role -> ?posix_profile:Types.posix_profile -> ?policy:Types.policy -> ?home_directory_type:Types.home_directory_type -> ?home_directory_mappings:Types.home_directory_mappings -> ?home_directory:Types.home_directory -> unit -> Types.described_access
val make_describe_access_response : access:Types.described_access -> server_id:Types.server_id -> unit -> Types.describe_access_response
val make_describe_access_request : external_id:Types.external_id -> server_id:Types.server_id -> unit -> Types.describe_access_request
val make_delete_ssh_public_key_request : user_name:Types.user_name -> ssh_public_key_id:Types.ssh_public_key_id -> server_id:Types.server_id -> unit -> Types.delete_ssh_public_key_request
val make_delete_host_key_request : host_key_id:Types.host_key_id -> server_id:Types.server_id -> unit -> Types.delete_host_key_request
val make_delete_access_request : external_id:Types.external_id -> server_id:Types.server_id -> unit -> Types.delete_access_request
val make_create_access_response : external_id:Types.external_id -> server_id:Types.server_id -> unit -> Types.create_access_response
val make_create_access_request : ?posix_profile:Types.posix_profile -> ?policy:Types.policy -> ?home_directory_mappings:Types.home_directory_mappings -> ?home_directory_type:Types.home_directory_type -> ?home_directory:Types.home_directory -> external_id:Types.external_id -> server_id:Types.server_id -> role:Types.role -> unit -> Types.create_access_request
val make_ssh_public_key : ssh_public_key_id:Types.ssh_public_key_id -> ssh_public_key_body:Types.ssh_public_key_body -> date_imported:Types.date_imported -> unit -> Types.ssh_public_key
val make_listed_workflow : ?arn:Types.arn -> ?description:Types.workflow_description -> ?workflow_id:Types.workflow_id -> unit -> Types.listed_workflow
val make_listed_web_app : ?endpoint_type:Types.web_app_endpoint_type -> ?web_app_endpoint:Types.web_app_endpoint -> ?access_endpoint:Types.web_app_access_endpoint -> web_app_id:Types.web_app_id -> arn:Types.arn -> unit -> Types.listed_web_app
val make_listed_user : ?user_name:Types.user_name -> ?ssh_public_key_count:Types.ssh_public_key_count -> ?role:Types.role -> ?home_directory_type:Types.home_directory_type -> ?home_directory:Types.home_directory -> arn:Types.arn -> unit -> Types.listed_user
val make_listed_server : ?user_count:Types.user_count -> ?state:Types.state -> ?server_id:Types.server_id -> ?logging_role:Types.role -> ?endpoint_type:Types.endpoint_type -> ?identity_provider_type:Types.identity_provider_type -> ?domain:Types.domain -> arn:Types.arn -> unit -> Types.listed_server
val make_listed_profile : ?profile_type:Types.profile_type -> ?as2_id:Types.as2_id -> ?profile_id:Types.profile_id -> ?arn:Types.arn -> unit -> Types.listed_profile
val make_listed_connector : ?url:Types.url -> ?connector_id:Types.connector_id -> ?arn:Types.arn -> unit -> Types.listed_connector
val make_listed_certificate : ?description:Types.description -> ?type_:Types.certificate_type -> ?inactive_date:Types.cert_date -> ?active_date:Types.cert_date -> ?status:Types.certificate_status_type -> ?usage:Types.certificate_usage_type -> ?certificate_id:Types.certificate_id -> ?arn:Types.arn -> unit -> Types.listed_certificate
val make_listed_agreement : ?partner_profile_id:Types.profile_id -> ?local_profile_id:Types.profile_id -> ?server_id:Types.server_id -> ?status:Types.agreement_status_type -> ?description:Types.description -> ?agreement_id:Types.agreement_id -> ?arn:Types.arn -> unit -> Types.listed_agreement
val make_list_workflows_response : ?next_token:Types.next_token -> workflows:Types.listed_workflows -> unit -> Types.list_workflows_response
val make_list_workflows_request : ?next_token:Types.next_token -> ?max_results:Types.max_results -> unit -> Types.list_workflows_request
val make_list_web_apps_response : ?next_token:Types.next_token -> web_apps:Types.listed_web_apps -> unit -> Types.list_web_apps_response
val make_list_web_apps_request : ?next_token:Types.next_token -> ?max_results:Types.max_results -> unit -> Types.list_web_apps_request
val make_list_users_response : ?next_token:Types.next_token -> users:Types.listed_users -> server_id:Types.server_id -> unit -> Types.list_users_response
val make_list_users_request : ?next_token:Types.next_token -> ?max_results:Types.max_results -> server_id:Types.server_id -> unit -> Types.list_users_request
val make_list_servers_response : ?next_token:Types.next_token -> servers:Types.listed_servers -> unit -> Types.list_servers_response
val make_list_servers_request : ?next_token:Types.next_token -> ?max_results:Types.max_results -> unit -> Types.list_servers_request
val make_list_profiles_response : ?next_token:Types.next_token -> profiles:Types.listed_profiles -> unit -> Types.list_profiles_response
val make_list_profiles_request : ?profile_type:Types.profile_type -> ?next_token:Types.next_token -> ?max_results:Types.max_results -> unit -> Types.list_profiles_request
val make_list_connectors_response : ?next_token:Types.next_token -> connectors:Types.listed_connectors -> unit -> Types.list_connectors_response
val make_list_connectors_request : ?next_token:Types.next_token -> ?max_results:Types.max_results -> unit -> Types.list_connectors_request
val make_list_certificates_response : ?next_token:Types.next_token -> certificates:Types.listed_certificates -> unit -> Types.list_certificates_response
val make_list_certificates_request : ?next_token:Types.next_token -> ?max_results:Types.max_results -> unit -> Types.list_certificates_request
val make_list_agreements_response : ?next_token:Types.next_token -> agreements:Types.listed_agreements -> unit -> Types.list_agreements_response
val make_list_agreements_request : ?next_token:Types.next_token -> ?max_results:Types.max_results -> server_id:Types.server_id -> unit -> Types.list_agreements_request
val make_import_certificate_response : certificate_id:Types.certificate_id -> unit -> Types.import_certificate_response
val make_import_certificate_request : ?tags:Types.tags -> ?description:Types.description -> ?inactive_date:Types.cert_date -> ?active_date:Types.cert_date -> ?private_key:Types.private_key_type -> ?certificate_chain:Types.certificate_chain_type -> certificate:Types.certificate_body_type -> usage:Types.certificate_usage_type -> unit -> Types.import_certificate_request
val make_described_workflow : ?tags:Types.tags -> ?workflow_id:Types.workflow_id -> ?on_exception_steps:Types.workflow_steps -> ?steps:Types.workflow_steps -> ?description:Types.workflow_description -> arn:Types.arn -> unit -> Types.described_workflow
val make_described_web_app_vpc_config : ?vpc_endpoint_id:Types.vpc_endpoint_id -> ?vpc_id:Types.vpc_id -> ?subnet_ids:Types.subnet_ids -> unit -> Types.described_web_app_vpc_config
val make_described_identity_center_config : ?role:Types.role -> ?instance_arn:Types.identity_center_instance_arn -> ?application_arn:Types.identity_center_application_arn -> unit -> Types.described_identity_center_config
val make_described_web_app_customization : ?favicon_file:Types.web_app_favicon_file -> ?logo_file:Types.web_app_logo_file -> ?title:Types.web_app_title -> web_app_id:Types.web_app_id -> arn:Types.arn -> unit -> Types.described_web_app_customization
val make_described_web_app : ?described_endpoint_details:Types.described_web_app_endpoint_details -> ?endpoint_type:Types.web_app_endpoint_type -> ?web_app_endpoint_policy:Types.web_app_endpoint_policy -> ?tags:Types.tags -> ?web_app_units:Types.web_app_units -> ?web_app_endpoint:Types.web_app_endpoint -> ?access_endpoint:Types.web_app_access_endpoint -> ?described_identity_provider_details: Types.described_web_app_identity_provider_details -> web_app_id:Types.web_app_id -> arn:Types.arn -> unit -> Types.described_web_app
val make_described_user : ?user_name:Types.user_name -> ?tags:Types.tags -> ?ssh_public_keys:Types.ssh_public_keys -> ?role:Types.role -> ?posix_profile:Types.posix_profile -> ?policy:Types.policy -> ?home_directory_type:Types.home_directory_type -> ?home_directory_mappings:Types.home_directory_mappings -> ?home_directory:Types.home_directory -> arn:Types.arn -> unit -> Types.described_user
val make_described_server : ?ip_address_type:Types.ip_address_type -> ?as2_service_managed_egress_ip_addresses: Types.service_managed_egress_ip_addresses -> ?s3_storage_options:Types.s3_storage_options -> ?structured_log_destinations:Types.structured_log_destinations -> ?workflow_details:Types.workflow_details -> ?user_count:Types.user_count -> ?tags:Types.tags -> ?state:Types.state -> ?server_id:Types.server_id -> ?security_policy_name:Types.security_policy_name -> ?protocols:Types.protocols -> ?pre_authentication_login_banner:Types.pre_authentication_login_banner -> ?post_authentication_login_banner:Types.post_authentication_login_banner -> ?logging_role:Types.nullable_role -> ?identity_provider_type:Types.identity_provider_type -> ?identity_provider_details:Types.identity_provider_details -> ?host_key_fingerprint:Types.host_key_fingerprint -> ?endpoint_type:Types.endpoint_type -> ?endpoint_details:Types.endpoint_details -> ?domain:Types.domain -> ?protocol_details:Types.protocol_details -> ?certificate:Types.certificate -> arn:Types.arn -> unit -> Types.described_server
val make_described_profile : ?tags:Types.tags -> ?certificate_ids:Types.certificate_ids -> ?as2_id:Types.as2_id -> ?profile_type:Types.profile_type -> ?profile_id:Types.profile_id -> arn:Types.arn -> unit -> Types.described_profile
val make_described_connector_vpc_lattice_egress_config : ?port_number:Types.sftp_port -> resource_configuration_arn:Types.vpc_lattice_resource_configuration_arn -> unit -> Types.described_connector_vpc_lattice_egress_config
val make_described_connector : ?ip_address_type:Types.connectors_ip_address_type -> ?error_message:Types.connector_error_message -> ?egress_config:Types.described_connector_egress_config -> ?security_policy_name:Types.connector_security_policy_name -> ?service_managed_egress_ip_addresses: Types.service_managed_egress_ip_addresses -> ?sftp_config:Types.sftp_connector_config -> ?tags:Types.tags -> ?logging_role:Types.role -> ?access_role:Types.role -> ?as2_config:Types.as2_connector_config -> ?url:Types.url -> ?connector_id:Types.connector_id -> status:Types.connector_status -> egress_type:Types.connector_egress_type -> arn:Types.arn -> unit -> Types.described_connector
val make_described_certificate : ?tags:Types.tags -> ?description:Types.description -> ?type_:Types.certificate_type -> ?not_after_date:Types.cert_date -> ?not_before_date:Types.cert_date -> ?serial:Types.cert_serial -> ?inactive_date:Types.cert_date -> ?active_date:Types.cert_date -> ?certificate_chain:Types.certificate_chain_type -> ?certificate:Types.certificate_body_type -> ?status:Types.certificate_status_type -> ?usage:Types.certificate_usage_type -> ?certificate_id:Types.certificate_id -> arn:Types.arn -> unit -> Types.described_certificate
val make_described_agreement : ?custom_directories:Types.custom_directories_type -> ?enforce_message_signing:Types.enforce_message_signing_type -> ?preserve_filename:Types.preserve_filename_type -> ?tags:Types.tags -> ?access_role:Types.role -> ?base_directory:Types.home_directory -> ?partner_profile_id:Types.profile_id -> ?local_profile_id:Types.profile_id -> ?server_id:Types.server_id -> ?status:Types.agreement_status_type -> ?description:Types.description -> ?agreement_id:Types.agreement_id -> arn:Types.arn -> unit -> Types.described_agreement
val make_describe_workflow_response : workflow:Types.described_workflow -> unit -> Types.describe_workflow_response
val make_describe_workflow_request : workflow_id:Types.workflow_id -> unit -> Types.describe_workflow_request
val make_describe_web_app_response : web_app:Types.described_web_app -> unit -> Types.describe_web_app_response
val make_describe_web_app_request : web_app_id:Types.web_app_id -> unit -> Types.describe_web_app_request
val make_describe_web_app_customization_response : web_app_customization:Types.described_web_app_customization -> unit -> Types.describe_web_app_customization_response
val make_describe_web_app_customization_request : web_app_id:Types.web_app_id -> unit -> Types.describe_web_app_customization_request
val make_describe_user_response : user:Types.described_user -> server_id:Types.server_id -> unit -> Types.describe_user_response
val make_describe_user_request : user_name:Types.user_name -> server_id:Types.server_id -> unit -> Types.describe_user_request
val make_describe_server_response : server:Types.described_server -> unit -> Types.describe_server_response
val make_describe_server_request : server_id:Types.server_id -> unit -> Types.describe_server_request
val make_describe_profile_response : profile:Types.described_profile -> unit -> Types.describe_profile_response
val make_describe_profile_request : profile_id:Types.profile_id -> unit -> Types.describe_profile_request
val make_describe_connector_response : connector:Types.described_connector -> unit -> Types.describe_connector_response
val make_describe_connector_request : connector_id:Types.connector_id -> unit -> Types.describe_connector_request
val make_describe_certificate_response : certificate:Types.described_certificate -> unit -> Types.describe_certificate_response
val make_describe_certificate_request : certificate_id:Types.certificate_id -> unit -> Types.describe_certificate_request
val make_describe_agreement_response : agreement:Types.described_agreement -> unit -> Types.describe_agreement_response
val make_describe_agreement_request : server_id:Types.server_id -> agreement_id:Types.agreement_id -> unit -> Types.describe_agreement_request
val make_delete_workflow_request : workflow_id:Types.workflow_id -> unit -> Types.delete_workflow_request
val make_delete_web_app_request : web_app_id:Types.web_app_id -> unit -> Types.delete_web_app_request
val make_delete_web_app_customization_request : web_app_id:Types.web_app_id -> unit -> Types.delete_web_app_customization_request
val make_delete_user_request : user_name:Types.user_name -> server_id:Types.server_id -> unit -> Types.delete_user_request
val make_delete_server_request : server_id:Types.server_id -> unit -> Types.delete_server_request
val make_delete_profile_request : profile_id:Types.profile_id -> unit -> Types.delete_profile_request
val make_delete_connector_request : connector_id:Types.connector_id -> unit -> Types.delete_connector_request
val make_delete_certificate_request : certificate_id:Types.certificate_id -> unit -> Types.delete_certificate_request
val make_delete_agreement_request : server_id:Types.server_id -> agreement_id:Types.agreement_id -> unit -> Types.delete_agreement_request
val make_create_workflow_response : workflow_id:Types.workflow_id -> unit -> Types.create_workflow_response
val make_create_workflow_request : ?tags:Types.tags -> ?on_exception_steps:Types.workflow_steps -> ?description:Types.workflow_description -> steps:Types.workflow_steps -> unit -> Types.create_workflow_request
val make_create_web_app_response : web_app_id:Types.web_app_id -> unit -> Types.create_web_app_response
val make_create_web_app_request : ?endpoint_details:Types.web_app_endpoint_details -> ?web_app_endpoint_policy:Types.web_app_endpoint_policy -> ?tags:Types.tags -> ?web_app_units:Types.web_app_units -> ?access_endpoint:Types.web_app_access_endpoint -> identity_provider_details:Types.web_app_identity_provider_details -> unit -> Types.create_web_app_request
val make_create_user_response : user_name:Types.user_name -> server_id:Types.server_id -> unit -> Types.create_user_response
val make_create_user_request : ?tags:Types.tags -> ?ssh_public_key_body:Types.ssh_public_key_body -> ?posix_profile:Types.posix_profile -> ?policy:Types.policy -> ?home_directory_mappings:Types.home_directory_mappings -> ?home_directory_type:Types.home_directory_type -> ?home_directory:Types.home_directory -> user_name:Types.user_name -> server_id:Types.server_id -> role:Types.role -> unit -> Types.create_user_request
val make_create_server_response : server_id:Types.server_id -> unit -> Types.create_server_response
val make_create_server_request : ?ip_address_type:Types.ip_address_type -> ?s3_storage_options:Types.s3_storage_options -> ?structured_log_destinations:Types.structured_log_destinations -> ?workflow_details:Types.workflow_details -> ?tags:Types.tags -> ?security_policy_name:Types.security_policy_name -> ?protocol_details:Types.protocol_details -> ?protocols:Types.protocols -> ?pre_authentication_login_banner:Types.pre_authentication_login_banner -> ?post_authentication_login_banner:Types.post_authentication_login_banner -> ?logging_role:Types.nullable_role -> ?identity_provider_type:Types.identity_provider_type -> ?identity_provider_details:Types.identity_provider_details -> ?host_key:Types.host_key -> ?endpoint_type:Types.endpoint_type -> ?endpoint_details:Types.endpoint_details -> ?domain:Types.domain -> ?certificate:Types.certificate -> unit -> Types.create_server_request
val make_create_profile_response : profile_id:Types.profile_id -> unit -> Types.create_profile_response
val make_create_profile_request : ?tags:Types.tags -> ?certificate_ids:Types.certificate_ids -> profile_type:Types.profile_type -> as2_id:Types.as2_id -> unit -> Types.create_profile_request
val make_create_connector_response : connector_id:Types.connector_id -> unit -> Types.create_connector_response
val make_connector_vpc_lattice_egress_config : ?port_number:Types.sftp_port -> resource_configuration_arn:Types.vpc_lattice_resource_configuration_arn -> unit -> Types.connector_vpc_lattice_egress_config
val make_create_connector_request : ?ip_address_type:Types.connectors_ip_address_type -> ?egress_config:Types.connector_egress_config -> ?security_policy_name:Types.connector_security_policy_name -> ?sftp_config:Types.sftp_connector_config -> ?tags:Types.tags -> ?logging_role:Types.role -> ?as2_config:Types.as2_connector_config -> ?url:Types.url -> access_role:Types.role -> unit -> Types.create_connector_request
val make_create_agreement_response : agreement_id:Types.agreement_id -> unit -> Types.create_agreement_response
val make_create_agreement_request : ?custom_directories:Types.custom_directories_type -> ?enforce_message_signing:Types.enforce_message_signing_type -> ?preserve_filename:Types.preserve_filename_type -> ?tags:Types.tags -> ?status:Types.agreement_status_type -> ?base_directory:Types.home_directory -> ?description:Types.description -> access_role:Types.role -> partner_profile_id:Types.profile_id -> local_profile_id:Types.profile_id -> server_id:Types.server_id -> unit -> Types.create_agreement_request

Operations

module CreateAgreement : sig ... end

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.

module CreateConnector : sig ... end

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.

module CreateProfile : sig ... end

Creates the local or partner profile to use for AS2 transfers.

module CreateServer : sig ... end

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.

module CreateUser : sig ... end

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.

module CreateWebApp : sig ... end

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.

module CreateWorkflow : sig ... end

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.

module DeleteAgreement : sig ... end

Delete the agreement that's specified in the provided AgreementId.

module DeleteCertificate : sig ... end

Deletes the certificate that's specified in the CertificateId parameter.

module DeleteConnector : sig ... end

Deletes the connector that's specified in the provided ConnectorId.

module DeleteProfile : sig ... end

Deletes the profile that's specified in the ProfileId parameter.

module DeleteServer : sig ... end

Deletes the file transfer protocol-enabled server that you specify.

module DeleteUser : sig ... end

Deletes the user belonging to a file transfer protocol-enabled server you specify.

module DeleteWebApp : sig ... end

Deletes the specified web app.

module DeleteWebAppCustomization : sig ... end

Deletes the WebAppCustomization object that corresponds to the web app ID specified.

module DeleteWorkflow : sig ... end

Deletes the specified workflow.

module DescribeAgreement : sig ... end

Describes the agreement that's identified by the AgreementId.

module DescribeCertificate : sig ... end

Describes the certificate that's identified by the CertificateId.

module DescribeConnector : sig ... end

Describes the connector that's identified by the ConnectorId.

module DescribeProfile : sig ... end

Returns the details of the profile that's specified by the ProfileId.

module DescribeServer : sig ... end

Describes a file transfer protocol-enabled server that you specify by passing the ServerId parameter.

module DescribeUser : sig ... end

Describes the user assigned to the specific file transfer protocol-enabled server, as identified by its ServerId property.

module DescribeWebApp : sig ... end

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.

module DescribeWebAppCustomization : sig ... end

Describes the web app customization object that's identified by WebAppId.

module DescribeWorkflow : sig ... end

Describes the specified workflow.

module ImportCertificate : sig ... end

Imports the signing and encryption certificates that you need to create local (AS2) profiles and partner profiles.

module ListAgreements : sig ... end

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.

module ListCertificates : sig ... end

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.

module ListConnectors : sig ... end

Lists the connectors for the specified Region.

module ListProfiles : sig ... end

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.

module ListServers : sig ... end

Lists the file transfer protocol-enabled servers that are associated with your Amazon Web Services account.

module ListUsers : sig ... end

Lists the users for a file transfer protocol-enabled server that you specify by passing the ServerId parameter.

module ListWebApps : sig ... end

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.

module ListWorkflows : sig ... end

Lists all workflows associated with your Amazon Web Services account for your current region.

module CreateAccess : sig ... end

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.

module DeleteAccess : sig ... end

Allows you to delete the access specified in the ServerID and ExternalID parameters.

module DeleteHostKey : sig ... end

Deletes the host key that's specified in the HostKeyId parameter.

module DeleteSshPublicKey : sig ... end

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

module DescribeAccess : sig ... end

Describes the access that is assigned to the specific file transfer protocol-enabled server, as identified by its ServerId property and its ExternalId.

module DescribeExecution : sig ... end

You can use DescribeExecution to check the details of the execution of the specified workflow.

module DescribeHostKey : sig ... end

Returns the details of the host key that's specified by the HostKeyId and ServerId.

module DescribeSecurityPolicy : sig ... end

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.

module ImportHostKey : sig ... end

Adds a host key to the server that's specified by the ServerId parameter.

module ImportSshPublicKey : sig ... end

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.

module ListAccesses : sig ... end

Lists the details for all the accesses you have on your server.

module ListExecutions : sig ... end

Lists all in-progress executions for the specified workflow.

module ListFileTransferResults : sig ... end

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.

module ListHostKeys : sig ... end

Returns a list of host keys for the server that's specified by the ServerId parameter.

module ListSecurityPolicies : sig ... end

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.

module ListTagsForResource : sig ... end

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

module SendWorkflowStepState : sig ... end

Sends a callback for asynchronous custom steps.

module StartDirectoryListing : sig ... end

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.

module StartFileTransfer : sig ... end

Begins a file transfer between local Amazon Web Services storage and a remote AS2 or SFTP server.

module StartRemoteDelete : sig ... end

Deletes a file or directory on the remote SFTP server.

module StartRemoteMove : sig ... end

Moves or renames a file or directory on the remote SFTP server.

module StartServer : sig ... end

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.

module StopServer : sig ... end

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.

module TagResource : sig ... end

Attaches a key-value pair to a resource, as identified by its Amazon Resource Name (ARN). Resources are users, servers, roles, and other entities.

module TestConnection : sig ... end

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.

module TestIdentityProvider : sig ... end

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.

module UntagResource : sig ... end

Detaches a key-value pair from a resource, as identified by its Amazon Resource Name (ARN). Resources are users, servers, roles, and other entities.

module UpdateAccess : sig ... end

Allows you to update parameters for the access specified in the ServerID and ExternalID parameters.

module UpdateAgreement : sig ... end

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.

module UpdateCertificate : sig ... end

Updates the active and inactive dates for a certificate.

module UpdateConnector : sig ... end

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.

module UpdateHostKey : sig ... end

Updates the description for the host key that's specified by the ServerId and HostKeyId parameters.

module UpdateProfile : sig ... end

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.

module UpdateServer : sig ... end

Updates the file transfer protocol-enabled server's properties after that server has been created.

module UpdateUser : sig ... end

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.

module UpdateWebApp : sig ... end

Assigns new properties to a web app. You can modify the access point, identity provider details, endpoint configuration, and the web app units.

module UpdateWebAppCustomization : sig ... end
module Json_serializers : sig ... end
module Json_deserializers : sig ... end