Values (p.awso.0.9.0.doc.awso.transfer.Awso

Sourceval service : Awso.Service.t

Sourceval apiVersion : string

Sourceval endpointPrefix : string

Sourceval serviceFullName : string

Sourceval signatureVersion : string

Sourceval protocol : string

Sourceval globalEndpoint : string

Sourceval serviceAbbreviation : string

Sourceval targetPrefix : string

Sourceval simple_to_json : ('a -> Awso__Botodata.value) -> 'a -> Yojson.Safe.t

Sourceval composed_to_json : ('a -> Awso__Botodata.value) -> 'a -> Yojson.Safe.t

Sourceval to_query : ('a -> Awso.Client.Query.value) -> 'a -> Awso.Client.Query.t

Source

val structure_to_value_aux : 
  ('a * 'b option) list ->
  f:(('a * 'b) list -> 'c) ->
  [> `Structure of 'c ]

Source

val structure_to_value : 
  ('a * 'b option) list ->
  [> `Structure of ('a * 'b) list ]

Source

val structure_to_wrapped_value : 
  wrapper:'a ->
  response:'a ->
  ('b * 'c option) list ->
  [> `Structure of ('a * [> `Structure of ('b * 'c) list ]) list ]

Sourcemodule EfsFileSystemId : sig ... end

Sourcemodule EfsPath : sig ... end

Sourcemodule S3Bucket : sig ... end

Sourcemodule S3Key : sig ... end

Sourcemodule S3TagKey : sig ... end

Sourcemodule S3TagValue : sig ... end

Sourcemodule EfsFileLocation : sig ... end

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.

Sourcemodule S3InputFileLocation : sig ... end

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.

Sourcemodule S3Tag : sig ... end

Specifies the key-value pair that are assigned to a file during the execution of a Tagging step.

Sourcemodule ExecutionErrorMessage : sig ... end

Sourcemodule ExecutionErrorType : sig ... end

Sourcemodule S3Etag : sig ... end

Sourcemodule S3VersionId : sig ... end

Sourcemodule ServerId : sig ... end

Sourcemodule SessionId : sig ... end

Sourcemodule UserName : sig ... end

Sourcemodule InputFileLocation : sig ... end

Specifies the location for the file that's being processed.

Sourcemodule OverwriteExisting : sig ... end

Sourcemodule SourceFileLocation : sig ... end

Sourcemodule WorkflowStepName : sig ... end

Sourcemodule CustomStepTarget : sig ... end

Sourcemodule CustomStepTimeoutSeconds : sig ... end

Sourcemodule EncryptionType : sig ... end

Sourcemodule S3Tags : sig ... end

Sourcemodule SubnetId : sig ... end

Sourcemodule Role : sig ... end

Sourcemodule WorkflowId : sig ... end

Sourcemodule ExecutionError : sig ... end

Specifies the error message and type, for an error that occurs during the execution of the workflow.

Sourcemodule StepResultOutputsJson : sig ... end

Sourcemodule WorkflowStepType : sig ... end

Sourcemodule S3FileLocation : sig ... end

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.

Sourcemodule UserDetails : sig ... end

Specifies the user name, server ID, and session ID for a workflow.

Sourcemodule TagKey : sig ... end

Sourcemodule TagValue : sig ... end

Sourcemodule CopyStepDetails : sig ... end

Each step type has its own StepDetails structure.

Sourcemodule CustomStepDetails : sig ... end

Each step type has its own StepDetails structure.

Sourcemodule DecryptStepDetails : sig ... end

Each step type has its own StepDetails structure.

Sourcemodule DeleteStepDetails : sig ... end

The name of the step, used to identify the delete step.

Sourcemodule TagStepDetails : sig ... end

Each step type has its own StepDetails structure. The key/value pairs used to tag a file during the execution of a workflow step.

Sourcemodule SubnetIds : sig ... end

Sourcemodule VpcEndpointId : sig ... end

Sourcemodule VpcId : sig ... end

Sourcemodule IdentityCenterApplicationArn : sig ... end

Sourcemodule IdentityCenterInstanceArn : sig ... end

Sourcemodule MapEntry : sig ... end

Sourcemodule MapTarget : sig ... end

Sourcemodule MapType : sig ... end

Sourcemodule PosixId : sig ... end

Sourcemodule DateImported : sig ... end

Sourcemodule SshPublicKeyBody : sig ... end

Sourcemodule SshPublicKeyId : sig ... end

Sourcemodule AddressAllocationId : sig ... end

Sourcemodule SecurityGroupId : sig ... end

Sourcemodule As2Transport : sig ... end

Sourcemodule WorkflowDetail : sig ... end

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.

Sourcemodule ExecutionStepResult : sig ... end

Specifies the following details for the step: error (if any), outputs (if any), and the step type.

Sourcemodule As2AsyncMdnServerIds : sig ... end

Sourcemodule Url : sig ... end

Sourcemodule SftpPort : sig ... end

Sourcemodule VpcLatticeResourceConfigurationArn : sig ... end

Sourcemodule SftpConnectorTrustedHostKey : sig ... end

Sourcemodule WebAppVpcEndpointIpAddressType : sig ... end

Sourcemodule CustomHttpHeaderKeyType : sig ... end

Sourcemodule CustomHttpHeaderValueType : sig ... end

Sourcemodule Arn : sig ... end

Sourcemodule WorkflowDescription : sig ... end

Sourcemodule WebAppAccessEndpoint : sig ... end

Sourcemodule WebAppEndpoint : sig ... end

Sourcemodule WebAppEndpointType : sig ... end

Sourcemodule WebAppId : sig ... end

Sourcemodule HomeDirectory : sig ... end

Sourcemodule HomeDirectoryType : sig ... end

Sourcemodule SshPublicKeyCount : sig ... end

Sourcemodule Domain : sig ... end

Sourcemodule EndpointType : sig ... end

Sourcemodule IdentityProviderType : sig ... end

Sourcemodule State : sig ... end

Sourcemodule UserCount : sig ... end

Sourcemodule As2Id : sig ... end

Sourcemodule ProfileId : sig ... end

Sourcemodule ProfileType : sig ... end

Sourcemodule HostKeyDescription : sig ... end

Sourcemodule HostKeyFingerprint : sig ... end

Sourcemodule HostKeyId : sig ... end

Sourcemodule HostKeyType : sig ... end

Sourcemodule FailureCode : sig ... end

Sourcemodule FilePath : sig ... end

Sourcemodule Message : sig ... end

Sourcemodule TransferTableStatus : sig ... end

Sourcemodule ExecutionId : sig ... end

Sourcemodule ExecutionStatus : sig ... end

Sourcemodule FileLocation : sig ... end

Specifies the Amazon S3 or EFS file details to be used in the step.

Sourcemodule ServiceMetadata : sig ... end

A container object for the session details that are associated with a workflow.

Sourcemodule ConnectorId : sig ... end

Sourcemodule CertDate : sig ... end

Sourcemodule CertificateId : sig ... end

Sourcemodule CertificateStatusType : sig ... end

Sourcemodule CertificateType : sig ... end

Sourcemodule CertificateUsageType : sig ... end

Sourcemodule Description : sig ... end

Sourcemodule AgreementId : sig ... end

Sourcemodule AgreementStatusType : sig ... end

Sourcemodule ExternalId : sig ... end

Sourcemodule Tag : sig ... end

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.

Sourcemodule WorkflowStep : sig ... end

The basic building block of a workflow.

Sourcemodule DescribedWebAppVpcConfig : sig ... end

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.

Sourcemodule DescribedIdentityCenterConfig : sig ... end

A structure that contains the details of the IAM Identity Center used for your web app. Returned during a call to DescribeWebApp.

Sourcemodule WebAppUnitCount : sig ... end

Sourcemodule HomeDirectoryMapEntry : sig ... end

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" } ]

Sourcemodule SecondaryGids : sig ... end

Sourcemodule SshPublicKey : sig ... end

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.

Sourcemodule AddressAllocationIds : sig ... end

Sourcemodule SecurityGroupIds : sig ... end

Sourcemodule DirectoryId : sig ... end

Sourcemodule Function : sig ... end

Sourcemodule SftpAuthenticationMethods : sig ... end

Sourcemodule As2Transports : sig ... end

Sourcemodule PassiveIp : sig ... end

Sourcemodule SetStatOption : sig ... end

Sourcemodule TlsSessionResumptionMode : sig ... end

Sourcemodule Protocol : sig ... end

Sourcemodule DirectoryListingOptimization : sig ... end

Sourcemodule ServiceManagedEgressIpAddress : sig ... end

Sourcemodule OnPartialUploadWorkflowDetails : sig ... end

Sourcemodule OnUploadWorkflowDetails : sig ... end

Sourcemodule SecurityPolicyOption : sig ... end

Sourcemodule SecurityPolicyProtocol : sig ... end

Sourcemodule ExecutionStepResults : sig ... end

Sourcemodule LogGroupName : sig ... end

Sourcemodule As2AsyncMdnConnectorConfig : sig ... end

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.

Sourcemodule As2ConnectorSecretId : sig ... end

Sourcemodule CompressionEnum : sig ... end

Sourcemodule EncryptionAlg : sig ... end

Sourcemodule MdnResponse : sig ... end

Sourcemodule MdnSigningAlg : sig ... end

Sourcemodule MessageSubject : sig ... end

Sourcemodule PreserveContentType : sig ... end

Sourcemodule SigningAlg : sig ... end

Sourcemodule DescribedConnectorVpcLatticeEgressConfig : sig ... end

VPC_LATTICE egress configuration details in the response, containing the Resource Configuration ARN and port number currently configured for the connector.

Sourcemodule MaxConcurrentConnections : sig ... end

The number of concurrent connections that the connector will create to the remote server.

Sourcemodule SecretId : sig ... end

Sourcemodule SftpConnectorTrustedHostKeyList : sig ... end

Sourcemodule ServiceErrorMessage : sig ... end

Sourcemodule Resource : sig ... end

Sourcemodule ResourceType : sig ... end

Sourcemodule RetryAfterSeconds : sig ... end

Sourcemodule UpdateWebAppVpcConfig : sig ... end

Contains the VPC configuration settings for updating a web app endpoint, including the subnet IDs where the endpoint should be deployed.

Sourcemodule UpdateWebAppIdentityCenterConfig : sig ... end

A structure that describes the values to use for the IAM Identity Center settings when you update a web app.

Sourcemodule UpdateConnectorVpcLatticeEgressConfig : sig ... end

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

Sourcemodule SftpConnectorHostKey : sig ... end

Sourcemodule CustomHttpHeader : sig ... end

Represents a custom HTTP header that can be included in AS2 messages. Each header consists of a key-value pair.

Sourcemodule ListedWorkflow : sig ... end

Contains the identifier, text description, and Amazon Resource Name (ARN) for the workflow.

Sourcemodule ListedWebApp : sig ... end

a structure that contains details for the web app.

Sourcemodule ListedUser : sig ... end

Returns properties of the user that you specify.

Sourcemodule ListedServer : sig ... end

Returns properties of a file transfer protocol-enabled server that was specified.

Sourcemodule SecurityPolicyName : sig ... end

Sourcemodule ListedProfile : sig ... end

Returns the properties of the profile that was specified.

Sourcemodule ListedHostKey : sig ... end

Returns properties of the host key that's specified.

Sourcemodule ConnectorFileTransferResult : sig ... end

A structure that contains the details for files transferred using an SFTP connector, during a single transfer.

Sourcemodule ListedExecution : sig ... end

Returns properties of the execution that is specified.

Sourcemodule ListedConnector : sig ... end

Returns details of the connector that is specified.

Sourcemodule ListedCertificate : sig ... end

Describes the properties of a certificate.

Sourcemodule ListedAgreement : sig ... end

Describes the properties of an agreement.

Sourcemodule ListedAccess : sig ... end

Lists the properties for one or more specified associated accesses.

Sourcemodule Tags : sig ... end

Sourcemodule WorkflowSteps : sig ... end

Sourcemodule DescribedWebAppEndpointDetails : sig ... end

Contains the endpoint configuration details for a web app, including VPC configuration when the endpoint is hosted within a VPC.

Sourcemodule DescribedWebAppIdentityProviderDetails : sig ... end

Returns a structure that contains the identity provider details for your web app.

Sourcemodule WebAppEndpointPolicy : sig ... end

Sourcemodule WebAppUnits : sig ... end

Contains an integer value that represents the value for number of concurrent connections or the user sessions on your web app.

Sourcemodule WebAppFaviconFile : sig ... end

Sourcemodule WebAppLogoFile : sig ... end

Sourcemodule WebAppTitle : sig ... end

Sourcemodule HomeDirectoryMappings : sig ... end

Sourcemodule Policy : sig ... end

Sourcemodule PosixProfile : sig ... end

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.

Sourcemodule SshPublicKeys : sig ... end

Sourcemodule Certificate : sig ... end

Sourcemodule EndpointDetails : sig ... end

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.

Sourcemodule IdentityProviderDetails : sig ... end

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.

Sourcemodule IpAddressType : sig ... end

Sourcemodule NullableRole : sig ... end

Sourcemodule PostAuthenticationLoginBanner : sig ... end

Sourcemodule PreAuthenticationLoginBanner : sig ... end

Sourcemodule ProtocolDetails : sig ... end

The protocol settings that are configured for your server.

Sourcemodule Protocols : sig ... end

Sourcemodule S3StorageOptions : sig ... end

The Amazon S3 storage options that are configured for your server.

Sourcemodule ServiceManagedEgressIpAddresses : sig ... end

Sourcemodule StructuredLogDestinations : sig ... end

Sourcemodule WorkflowDetails : sig ... end

Container for the WorkflowDetail data type. It is used by actions that trigger a workflow to begin execution.

Sourcemodule Fips : sig ... end

Sourcemodule SecurityPolicyOptions : sig ... end

Sourcemodule SecurityPolicyProtocols : sig ... end

Sourcemodule SecurityPolicyResourceType : sig ... end

Sourcemodule CertificateIds : sig ... end

Sourcemodule ExecutionResults : sig ... end

Specifies the steps in the workflow, as well as the steps to execute in case of any errors during workflow execution.

Sourcemodule LoggingConfiguration : sig ... end

Consists of the logging role and the log group name.

Sourcemodule As2ConnectorConfig : sig ... end

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.

Sourcemodule ConnectorEgressType : sig ... end

Sourcemodule ConnectorErrorMessage : sig ... end

Sourcemodule ConnectorSecurityPolicyName : sig ... end

Sourcemodule ConnectorStatus : sig ... end

Sourcemodule ConnectorsIpAddressType : sig ... end

Sourcemodule DescribedConnectorEgressConfig : sig ... end

Response structure containing the current egress configuration details for the connector. Shows how traffic is currently routed from the connector to the SFTP server.

Sourcemodule SftpConnectorConfig : sig ... end

Contains the details for an SFTP connector object. The connector object is used for transferring files to and from a partner's SFTP server.

Sourcemodule CertSerial : sig ... end

Sourcemodule CertificateBodyType : sig ... end

Sourcemodule CertificateChainType : sig ... end

Sourcemodule CustomDirectoriesType : sig ... end

Contains Amazon S3 locations for storing specific types of AS2 message files.

Sourcemodule EnforceMessageSigningType : sig ... end

Sourcemodule PreserveFilenameType : sig ... end

Sourcemodule WebAppVpcConfig : sig ... end

Contains the VPC configuration settings for hosting a web app endpoint, including the VPC ID, subnet IDs, and security group IDs for access control.

Sourcemodule IdentityCenterConfig : sig ... end

A structure that describes the values to use for the IAM Identity Center settings when you create or update a web app.

Sourcemodule ConnectorVpcLatticeEgressConfig : sig ... end

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.

Sourcemodule AccessDeniedException : sig ... end

You do not have sufficient access to perform this action.

Sourcemodule ConflictException : sig ... end

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.

Sourcemodule InternalServiceError : sig ... end

This exception is thrown when an error occurs in the Transfer Family service.

Sourcemodule InvalidRequestException : sig ... end

This exception is thrown when the client submits a malformed request.

Sourcemodule ResourceNotFoundException : sig ... end

This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.

Sourcemodule ThrottlingException : sig ... end

The request was denied due to request throttling.

Sourcemodule UpdateWebAppEndpointDetails : sig ... end

Contains the endpoint configuration details for updating a web app, including VPC settings for endpoints hosted within a VPC.

Sourcemodule UpdateWebAppIdentityProviderDetails : sig ... end

A union that contains the UpdateWebAppIdentityCenterConfig object.

Sourcemodule ServiceUnavailableException : sig ... end

The request has failed because the Amazon Web ServicesTransfer Family service is not available.

Sourcemodule ResourceExistsException : sig ... end

The requested resource does not exist, or exists in a region other than the one specified for the command.

Sourcemodule HostKey : sig ... end

Sourcemodule UpdateConnectorEgressConfig : sig ... end

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.

Sourcemodule TagKeys : sig ... end

Sourcemodule Response : sig ... end

Sourcemodule StatusCode : sig ... end

Sourcemodule SourceIp : sig ... end

Sourcemodule UserPassword : sig ... end

Sourcemodule SftpConnectorConnectionDetails : sig ... end

Contains the details for an SFTP connector connection.

Sourcemodule Status : sig ... end

Sourcemodule MoveId : sig ... end

Sourcemodule DeleteId : sig ... end

Sourcemodule TransferId : sig ... end

Sourcemodule CustomHttpHeaders : sig ... end

Sourcemodule FilePaths : sig ... end

Sourcemodule ListingId : sig ... end

Sourcemodule OutputFileName : sig ... end

Sourcemodule MaxItems : sig ... end

Sourcemodule CallbackToken : sig ... end

Sourcemodule CustomStepStatus : sig ... end

Sourcemodule InvalidNextTokenException : sig ... end

The NextToken parameter that was passed is invalid.

Sourcemodule ListedWorkflows : sig ... end

Sourcemodule NextToken : sig ... end

Sourcemodule MaxResults : sig ... end

Sourcemodule ListedWebApps : sig ... end

Sourcemodule ListedUsers : sig ... end

Sourcemodule ListedServers : sig ... end

Sourcemodule SecurityPolicyNames : sig ... end

Sourcemodule ListedProfiles : sig ... end

Sourcemodule ListedHostKeys : sig ... end

Sourcemodule ConnectorFileTransferResults : sig ... end

Sourcemodule ListedExecutions : sig ... end

Sourcemodule ListedConnectors : sig ... end

Sourcemodule ListedCertificates : sig ... end

Sourcemodule ListedAgreements : sig ... end

Sourcemodule ListedAccesses : sig ... end

Sourcemodule PrivateKeyType : sig ... end

Sourcemodule DescribedWorkflow : sig ... end

Describes the properties of the specified workflow

Sourcemodule DescribedWebApp : sig ... end

A structure that describes the parameters for the web app, as identified by the WebAppId.

Sourcemodule DescribedWebAppCustomization : sig ... end

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.

Sourcemodule DescribedUser : sig ... end

Describes the properties of a user that was specified.

Sourcemodule DescribedServer : sig ... end

Describes the properties of a file transfer protocol-enabled server that was specified.

Sourcemodule DescribedSecurityPolicy : sig ... end

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.

Sourcemodule DescribedProfile : sig ... end

The details for a local or partner AS2 profile.

Sourcemodule DescribedHostKey : sig ... end

The details for a server host key.

Sourcemodule DescribedExecution : sig ... end

The details for an execution object.

Sourcemodule DescribedConnector : sig ... end

Describes the parameters for the connector, as identified by the ConnectorId.

Sourcemodule DescribedCertificate : sig ... end

Describes the properties of a certificate.

Sourcemodule DescribedAgreement : sig ... end

Describes the properties of an agreement.

Sourcemodule DescribedAccess : sig ... end

Describes the properties of the access that was specified.

Sourcemodule WebAppEndpointDetails : sig ... end

Contains the endpoint configuration for a web app, including VPC settings when the endpoint is hosted within a VPC.

Sourcemodule WebAppIdentityProviderDetails : sig ... end

A union that contains the IdentityCenterConfig object.

Sourcemodule ConnectorEgressConfig : sig ... end

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.

Sourcemodule UpdateWebAppResponse : 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. For more information about using VPC endpoints with Transfer Family, see Create a Transfer Family web app in a VPC.

Sourcemodule UpdateWebAppRequest : 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. For more information about using VPC endpoints with Transfer Family, see Create a Transfer Family web app in a VPC.

Sourcemodule UpdateWebAppCustomizationResponse : sig ... end

Assigns new customization properties to a web app. You can modify the icon file, logo file, and title.

Sourcemodule UpdateWebAppCustomizationRequest : sig ... end

Assigns new customization properties to a web app. You can modify the icon file, logo file, and title.

Sourcemodule UpdateUserResponse : sig ... end

UpdateUserResponse returns the user name and identifier for the request to update a user's properties.

Sourcemodule UpdateUserRequest : 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. 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\"}]"

Sourcemodule UpdateServerResponse : sig ... end

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.

Sourcemodule UpdateServerRequest : sig ... end

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.

Sourcemodule UpdateProfileResponse : 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.

Sourcemodule UpdateProfileRequest : 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.

Sourcemodule UpdateHostKeyResponse : sig ... end

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

Sourcemodule UpdateHostKeyRequest : sig ... end

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

Sourcemodule UpdateConnectorResponse : 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.

Sourcemodule UpdateConnectorRequest : 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.

Sourcemodule UpdateCertificateResponse : sig ... end

Updates the active and inactive dates for a certificate.

Sourcemodule UpdateCertificateRequest : sig ... end

Updates the active and inactive dates for a certificate.

Sourcemodule UpdateAgreementResponse : 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. 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.

Sourcemodule UpdateAgreementRequest : 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. 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.

Sourcemodule UpdateAccessResponse : sig ... end

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

Sourcemodule UpdateAccessRequest : sig ... end

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

Sourcemodule UntagResourceRequest : 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. No response is returned from this call.

Sourcemodule TestIdentityProviderResponse : 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. 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).

Sourcemodule TestIdentityProviderRequest : 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. 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).

Sourcemodule TestConnectionResponse : 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.

Sourcemodule TestConnectionRequest : 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.

Sourcemodule TagResourceRequest : 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. There is no response returned from this call.

Sourcemodule StopServerRequest : 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. 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.

Sourcemodule StartServerRequest : 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. 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.

Sourcemodule StartRemoteMoveResponse : sig ... end

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

Sourcemodule StartRemoteMoveRequest : sig ... end

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

Sourcemodule StartRemoteDeleteResponse : sig ... end

Deletes a file or directory on the remote SFTP server.

Sourcemodule StartRemoteDeleteRequest : sig ... end

Deletes a file or directory on the remote SFTP server.

Sourcemodule StartFileTransferResponse : sig ... end

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.

Sourcemodule StartFileTransferRequest : sig ... end

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.

Sourcemodule StartDirectoryListingResponse : 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. 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).

Sourcemodule StartDirectoryListingRequest : 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. 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).

Sourcemodule SendWorkflowStepStateResponse : sig ... end

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.

Sourcemodule SendWorkflowStepStateRequest : sig ... end

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.

Sourcemodule ListWorkflowsResponse : sig ... end

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

Sourcemodule ListWorkflowsRequest : sig ... end

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

Sourcemodule ListWebAppsResponse : 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. For more information about using VPC endpoints with Transfer Family, see Create a Transfer Family web app in a VPC.

Sourcemodule ListWebAppsRequest : 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. For more information about using VPC endpoints with Transfer Family, see Create a Transfer Family web app in a VPC.

Sourcemodule ListUsersResponse : sig ... end

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

Sourcemodule ListUsersRequest : sig ... end

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

Sourcemodule ListTagsForResourceResponse : 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.

Sourcemodule ListTagsForResourceRequest : 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.

Sourcemodule ListServersResponse : sig ... end

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

Sourcemodule ListServersRequest : sig ... end

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

Sourcemodule ListSecurityPoliciesResponse : 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.

Sourcemodule ListSecurityPoliciesRequest : 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.

Sourcemodule ListProfilesResponse : 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.

Sourcemodule ListProfilesRequest : 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.

Sourcemodule ListHostKeysResponse : sig ... end

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

Sourcemodule ListHostKeysRequest : sig ... end

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

Sourcemodule ListFileTransferResultsResponse : 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. File transfer results are available up to 7 days after an operation has been requested.

Sourcemodule ListFileTransferResultsRequest : 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. File transfer results are available up to 7 days after an operation has been requested.

Sourcemodule ListExecutionsResponse : sig ... end

Lists all in-progress executions for the specified workflow. If the specified workflow ID cannot be found, ListExecutions returns a ResourceNotFound exception.

Sourcemodule ListExecutionsRequest : sig ... end

Lists all in-progress executions for the specified workflow. If the specified workflow ID cannot be found, ListExecutions returns a ResourceNotFound exception.

Sourcemodule ListConnectorsResponse : sig ... end

Lists the connectors for the specified Region.

Sourcemodule ListConnectorsRequest : sig ... end

Lists the connectors for the specified Region.

Sourcemodule ListCertificatesResponse : 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.

Sourcemodule ListCertificatesRequest : 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.

Sourcemodule ListAgreementsResponse : 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.

Sourcemodule ListAgreementsRequest : 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.

Sourcemodule ListAccessesResponse : sig ... end

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

Sourcemodule ListAccessesRequest : sig ... end

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

Sourcemodule ImportSshPublicKeyResponse : sig ... end

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.

Sourcemodule ImportSshPublicKeyRequest : 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. The response returns the UserName value, the ServerId value, and the name of the SshPublicKeyId.

Sourcemodule ImportHostKeyResponse : sig ... end

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

Sourcemodule ImportHostKeyRequest : sig ... end

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

Sourcemodule ImportCertificateResponse : sig ... end

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

Sourcemodule ImportCertificateRequest : sig ... end

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

Sourcemodule DescribeWorkflowResponse : sig ... end

Describes the specified workflow.

Sourcemodule DescribeWorkflowRequest : sig ... end

Describes the specified workflow.

Sourcemodule DescribeWebAppResponse : 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. For more information about using VPC endpoints with Transfer Family, see Create a Transfer Family web app in a VPC.

Sourcemodule DescribeWebAppRequest : 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. For more information about using VPC endpoints with Transfer Family, see Create a Transfer Family web app in a VPC.

Sourcemodule DescribeWebAppCustomizationResponse : sig ... end

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

Sourcemodule DescribeWebAppCustomizationRequest : sig ... end

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

Sourcemodule DescribeUserResponse : sig ... end

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.

Sourcemodule DescribeUserRequest : sig ... end

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.

Sourcemodule DescribeServerResponse : sig ... end

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.

Sourcemodule DescribeServerRequest : sig ... end

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.

Sourcemodule DescribeSecurityPolicyResponse : 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.

Sourcemodule DescribeSecurityPolicyRequest : 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.

Sourcemodule DescribeProfileResponse : sig ... end

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

Sourcemodule DescribeProfileRequest : sig ... end

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

Sourcemodule DescribeHostKeyResponse : sig ... end

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

Sourcemodule DescribeHostKeyRequest : sig ... end

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

Sourcemodule DescribeExecutionResponse : sig ... end

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.

Sourcemodule DescribeExecutionRequest : sig ... end

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.

Sourcemodule DescribeConnectorResponse : sig ... end

Describes the connector that's identified by the ConnectorId.

Sourcemodule DescribeConnectorRequest : sig ... end

Describes the connector that's identified by the ConnectorId.

Sourcemodule DescribeCertificateResponse : sig ... end

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.

Sourcemodule DescribeCertificateRequest : sig ... end

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.

Sourcemodule DescribeAgreementResponse : sig ... end

Describes the agreement that's identified by the AgreementId.

Sourcemodule DescribeAgreementRequest : sig ... end

Describes the agreement that's identified by the AgreementId.

Sourcemodule DescribeAccessResponse : 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. The response from this call returns the properties of the access that is associated with the ServerId value that was specified.

Sourcemodule DescribeAccessRequest : 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. The response from this call returns the properties of the access that is associated with the ServerId value that was specified.

Sourcemodule DeleteWorkflowRequest : sig ... end

Deletes the specified workflow.

Sourcemodule DeleteWebAppRequest : sig ... end

Deletes the specified web app.

Sourcemodule DeleteWebAppCustomizationRequest : sig ... end

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

Sourcemodule DeleteUserRequest : sig ... end

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.

Sourcemodule DeleteSshPublicKeyRequest : sig ... end

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

Sourcemodule DeleteServerRequest : sig ... end

Deletes the file transfer protocol-enabled server that you specify. No response returns from this operation.

Sourcemodule DeleteProfileRequest : sig ... end

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

Sourcemodule DeleteHostKeyRequest : sig ... end

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

Sourcemodule DeleteConnectorRequest : sig ... end

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

Sourcemodule DeleteCertificateRequest : sig ... end

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

Sourcemodule DeleteAgreementRequest : sig ... end

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

Sourcemodule DeleteAccessRequest : sig ... end

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

Sourcemodule CreateWorkflowResponse : 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.

Sourcemodule CreateWorkflowRequest : 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.

Sourcemodule CreateWebAppResponse : 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. For more information about using VPC endpoints with Transfer Family, see Create a Transfer Family web app in a VPC.

Sourcemodule CreateWebAppRequest : 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. For more information about using VPC endpoints with Transfer Family, see Create a Transfer Family web app in a VPC.

Sourcemodule CreateUserResponse : 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.

Sourcemodule CreateUserRequest : 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.

Sourcemodule CreateServerResponse : 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.

Sourcemodule CreateServerRequest : 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.

Sourcemodule CreateProfileResponse : sig ... end

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

Sourcemodule CreateProfileRequest : sig ... end

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

Sourcemodule CreateConnectorResponse : 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. You must specify exactly one configuration object: either for AS2 (As2Config) or SFTP (SftpConfig).

Sourcemodule CreateConnectorRequest : 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. You must specify exactly one configuration object: either for AS2 (As2Config) or SFTP (SftpConfig).

Sourcemodule CreateAgreementResponse : 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. 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.

Sourcemodule CreateAgreementRequest : 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. 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.

Sourcemodule CreateAccessResponse : 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.

Sourcemodule CreateAccessRequest : 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.