<?php
// This file was auto-generated from sdk-root/src/data/transfer/2018-11-05/docs-2.json
return [ 'version' => '2.0', 'service' => '<p>Transfer Family is a fully managed service that enables the transfer of files over the File Transfer Protocol (FTP), File Transfer Protocol over SSL (FTPS), or Secure Shell (SSH) File Transfer Protocol (SFTP) directly into and out of Amazon Simple Storage Service (Amazon S3) or Amazon EFS. Additionally, you can use Applicability Statement 2 (AS2) to transfer files into and out of Amazon S3. Amazon Web Services helps you seamlessly migrate your file transfer workflows to Transfer Family by integrating with existing authentication systems, and providing DNS routing with Amazon Route 53 so nothing changes for your customers and partners, or their applications. With your data in Amazon S3, you can use it with Amazon Web Services services for processing, analytics, machine learning, and archiving. Getting started with Transfer Family is easy since there is no infrastructure to buy and set up.</p>', 'operations' => [ 'CreateAccess' => '<p>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 <code>CreateAccess</code> to limit the access to the correct set of users who need this ability.</p>', 'CreateAgreement' => '<p>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.</p> <p>The partner is identified with the <code>PartnerProfileId</code>, and the AS2 process is identified with the <code>LocalProfileId</code>.</p> <note> <p>Specify <i>either</i> <code>BaseDirectory</code> or <code>CustomDirectories</code>, but not both. Specifying both causes the command to fail.</p> </note>', 'CreateConnector' => '<p>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 <a href="https://docs.aws.amazon.com/transfer/latest/userguide/configure-as2-connector.html">Configure AS2 connectors</a> and <a href="https://docs.aws.amazon.com/transfer/latest/userguide/configure-sftp-connector.html">Create SFTP connectors</a>.</p> <note> <p>You must specify exactly one configuration object: either for AS2 (<code>As2Config</code>) or SFTP (<code>SftpConfig</code>).</p> </note>', 'CreateProfile' => '<p>Creates the local or partner profile to use for AS2 transfers.</p>', 'CreateServer' => '<p>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 <code>ServerId</code> property that is assigned to the newly created server.</p>', 'CreateUser' => '<p>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 <code>IdentityProviderType</code> set to <code>SERVICE_MANAGED</code>. Using parameters for <code>CreateUser</code>, 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.</p>', 'CreateWebApp' => '<p>Creates a web app based on specified parameters, and returns the ID for the new web app.</p>', 'CreateWorkflow' => '<p> 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 <code>workflow-details</code> field in <code>CreateServer</code> and <code>UpdateServer</code> operations. </p>', 'DeleteAccess' => '<p>Allows you to delete the access specified in the <code>ServerID</code> and <code>ExternalID</code> parameters.</p>', 'DeleteAgreement' => '<p>Delete the agreement that\'s specified in the provided <code>AgreementId</code>.</p>', 'DeleteCertificate' => '<p>Deletes the certificate that\'s specified in the <code>CertificateId</code> parameter.</p>', 'DeleteConnector' => '<p>Deletes the connector that\'s specified in the provided <code>ConnectorId</code>.</p>', 'DeleteHostKey' => '<p>Deletes the host key that\'s specified in the <code>HostKeyId</code> parameter.</p>', 'DeleteProfile' => '<p>Deletes the profile that\'s specified in the <code>ProfileId</code> parameter.</p>', 'DeleteServer' => '<p>Deletes the file transfer protocol-enabled server that you specify.</p> <p>No response returns from this operation.</p>', 'DeleteSshPublicKey' => '<p>Deletes a user\'s Secure Shell (SSH) public key.</p>', 'DeleteUser' => '<p>Deletes the user belonging to a file transfer protocol-enabled server you specify.</p> <p>No response returns from this operation.</p> <note> <p>When you delete a user from a server, the user\'s information is lost.</p> </note>', 'DeleteWebApp' => '<p>Deletes the specified web app.</p>', 'DeleteWebAppCustomization' => '<p>Deletes the <code>WebAppCustomization</code> object that corresponds to the web app ID specified.</p>', 'DeleteWorkflow' => '<p>Deletes the specified workflow.</p>', 'DescribeAccess' => '<p>Describes the access that is assigned to the specific file transfer protocol-enabled server, as identified by its <code>ServerId</code> property and its <code>ExternalId</code>.</p> <p>The response from this call returns the properties of the access that is associated with the <code>ServerId</code> value that was specified.</p>', 'DescribeAgreement' => '<p>Describes the agreement that\'s identified by the <code>AgreementId</code>.</p>', 'DescribeCertificate' => '<p>Describes the certificate that\'s identified by the <code>CertificateId</code>.</p> <note> <p>Transfer Family automatically publishes a Amazon CloudWatch metric called <code>DaysUntilExpiry</code> for imported certificates. This metric tracks the number of days until the certificate expires based on the <code>InactiveDate</code>. The metric is available in the <code>AWS/Transfer</code> namespace and includes the <code>CertificateId</code> as a dimension.</p> </note>', 'DescribeConnector' => '<p>Describes the connector that\'s identified by the <code>ConnectorId.</code> </p>', 'DescribeExecution' => '<p>You can use <code>DescribeExecution</code> to check the details of the execution of the specified workflow.</p> <note> <p>This API call only returns details for in-progress workflows.</p> <p> 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 <code>ResourceNotFound</code> exception.</p> </note>', 'DescribeHostKey' => '<p>Returns the details of the host key that\'s specified by the <code>HostKeyId</code> and <code>ServerId</code>.</p>', 'DescribeProfile' => '<p>Returns the details of the profile that\'s specified by the <code>ProfileId</code>.</p>', 'DescribeSecurityPolicy' => '<p>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 <a href="https://docs.aws.amazon.com/transfer/latest/userguide/security-policies.html">Working with security policies for servers</a> or <a href="https://docs.aws.amazon.com/transfer/latest/userguide/security-policies-connectors.html">Working with security policies for SFTP connectors</a>.</p>', 'DescribeServer' => '<p>Describes a file transfer protocol-enabled server that you specify by passing the <code>ServerId</code> parameter.</p> <p>The response contains a description of a server\'s properties. When you set <code>EndpointType</code> to VPC, the response will contain the <code>EndpointDetails</code>.</p>', 'DescribeUser' => '<p>Describes the user assigned to the specific file transfer protocol-enabled server, as identified by its <code>ServerId</code> property.</p> <p>The response from this call returns the properties of the user associated with the <code>ServerId</code> value that was specified.</p>', 'DescribeWebApp' => '<p>Describes the web app that\'s identified by <code>WebAppId</code>.</p>', 'DescribeWebAppCustomization' => '<p>Describes the web app customization object that\'s identified by <code>WebAppId</code>.</p>', 'DescribeWorkflow' => '<p>Describes the specified workflow.</p>', 'ImportCertificate' => '<p>Imports the signing and encryption certificates that you need to create local (AS2) profiles and partner profiles.</p> <p>You can import both the certificate and its chain in the <code>Certificate</code> parameter.</p> <p>After importing a certificate, Transfer Family automatically creates a Amazon CloudWatch metric called <code>DaysUntilExpiry</code> that tracks the number of days until the certificate expires. The metric is based on the <code>InactiveDate</code> parameter and is published daily in the <code>AWS/Transfer</code> namespace.</p> <important> <p>It can take up to a full day after importing a certificate for Transfer Family to emit the <code>DaysUntilExpiry</code> metric to your account.</p> </important> <note> <p>If you use the <code>Certificate</code> parameter to upload both the certificate and its chain, don\'t use the <code>CertificateChain</code> parameter.</p> </note> <p> <b>CloudWatch monitoring</b> </p> <p>The <code>DaysUntilExpiry</code> metric includes the following specifications:</p> <ul> <li> <p> <b>Units:</b> Count (days)</p> </li> <li> <p> <b>Dimensions:</b> <code>CertificateId</code> (always present), <code>Description</code> (if provided during certificate import)</p> </li> <li> <p> <b>Statistics:</b> Minimum, Maximum, Average</p> </li> <li> <p> <b>Frequency:</b> Published daily</p> </li> </ul>', 'ImportHostKey' => '<p>Adds a host key to the server that\'s specified by the <code>ServerId</code> parameter.</p>', 'ImportSshPublicKey' => '<p>Adds a Secure Shell (SSH) public key to a Transfer Family user identified by a <code>UserName</code> value assigned to the specific file transfer protocol-enabled server, identified by <code>ServerId</code>.</p> <p>The response returns the <code>UserName</code> value, the <code>ServerId</code> value, and the name of the <code>SshPublicKeyId</code>.</p>', 'ListAccesses' => '<p>Lists the details for all the accesses you have on your server.</p>', 'ListAgreements' => '<p>Returns a list of the agreements for the server that\'s identified by the <code>ServerId</code> that you supply. If you want to limit the results to a certain number, supply a value for the <code>MaxResults</code> parameter. If you ran the command previously and received a value for <code>NextToken</code>, you can supply that value to continue listing agreements from where you left off.</p>', 'ListCertificates' => '<p>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 <code>MaxResults</code> parameter. If you ran the command previously and received a value for the <code>NextToken</code> parameter, you can supply that value to continue listing certificates from where you left off.</p>', 'ListConnectors' => '<p>Lists the connectors for the specified Region.</p>', 'ListExecutions' => '<p>Lists all in-progress executions for the specified workflow.</p> <note> <p>If the specified workflow ID cannot be found, <code>ListExecutions</code> returns a <code>ResourceNotFound</code> exception.</p> </note>', 'ListFileTransferResults' => '<p> 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 <code>ConnectorId</code> and its <code>TransferId</code>.</p> <note> <p>File transfer results are available up to 7 days after an operation has been requested.</p> </note>', 'ListHostKeys' => '<p>Returns a list of host keys for the server that\'s specified by the <code>ServerId</code> parameter.</p>', 'ListProfiles' => '<p>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 <code>MaxResults</code> parameter. If you ran the command previously and received a value for <code>NextToken</code>, you can supply that value to continue listing profiles from where you left off.</p>', 'ListSecurityPolicies' => '<p>Lists the security policies that are attached to your servers and SFTP connectors. For more information about security policies, see <a href="https://docs.aws.amazon.com/transfer/latest/userguide/security-policies.html">Working with security policies for servers</a> or <a href="https://docs.aws.amazon.com/transfer/latest/userguide/security-policies-connectors.html">Working with security policies for SFTP connectors</a>.</p>', 'ListServers' => '<p>Lists the file transfer protocol-enabled servers that are associated with your Amazon Web Services account.</p>', 'ListTagsForResource' => '<p>Lists all of the tags associated with the Amazon Resource Name (ARN) that you specify. The resource can be a user, server, or role.</p>', 'ListUsers' => '<p>Lists the users for a file transfer protocol-enabled server that you specify by passing the <code>ServerId</code> parameter.</p>', 'ListWebApps' => '<p>Lists all web apps associated with your Amazon Web Services account for your current region.</p>', 'ListWorkflows' => '<p>Lists all workflows associated with your Amazon Web Services account for your current region.</p>', 'SendWorkflowStepState' => '<p>Sends a callback for asynchronous custom steps.</p> <p> The <code>ExecutionId</code>, <code>WorkflowId</code>, and <code>Token</code> 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. </p>', 'StartDirectoryListing' => '<p>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 <code>MaxItems</code> 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.</p> <p>After you receive the listing file, you can provide the files that you want to transfer to the <code>RetrieveFilePaths</code> parameter of the <code>StartFileTransfer</code> API call.</p> <p>The naming convention for the output file is <code> <i>connector-ID</i>-<i>listing-ID</i>.json</code>. The output file contains the following information:</p> <ul> <li> <p> <code>filePath</code>: the complete path of a remote file, relative to the directory of the listing request for your SFTP connector on the remote server.</p> </li> <li> <p> <code>modifiedTimestamp</code>: 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.</p> </li> <li> <p> <code>size</code>: 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.</p> </li> <li> <p> <code>path</code>: the complete path of a remote directory, relative to the directory of the listing request for your SFTP connector on the remote server.</p> </li> <li> <p> <code>truncated</code>: a flag indicating whether the list output contains all of the items contained in the remote directory or not. If your <code>Truncated</code> output value is true, you can increase the value provided in the optional <code>max-items</code> input attribute to be able to list more items (up to the maximum allowed list size of 10,000 items).</p> </li> </ul>', 'StartFileTransfer' => '<p>Begins a file transfer between local Amazon Web Services storage and a remote AS2 or SFTP server.</p> <ul> <li> <p>For an AS2 connector, you specify the <code>ConnectorId</code> and one or more <code>SendFilePaths</code> to identify the files you want to transfer.</p> </li> <li> <p>For an SFTP connector, the file transfer can be either outbound or inbound. In both cases, you specify the <code>ConnectorId</code>. Depending on the direction of the transfer, you also specify the following items:</p> <ul> <li> <p>If you are transferring file from a partner\'s SFTP server to Amazon Web Services storage, you specify one or more <code>RetrieveFilePaths</code> to identify the files you want to transfer, and a <code>LocalDirectoryPath</code> to specify the destination folder.</p> </li> <li> <p>If you are transferring file to a partner\'s SFTP server from Amazon Web Services storage, you specify one or more <code>SendFilePaths</code> to identify the files you want to transfer, and a <code>RemoteDirectoryPath</code> to specify the destination folder.</p> </li> </ul> </li> </ul>', 'StartRemoteDelete' => '<p>Deletes a file or directory on the remote SFTP server.</p>', 'StartRemoteMove' => '<p>Moves or renames a file or directory on the remote SFTP server.</p>', 'StartServer' => '<p>Changes the state of a file transfer protocol-enabled server from <code>OFFLINE</code> to <code>ONLINE</code>. It has no impact on a server that is already <code>ONLINE</code>. An <code>ONLINE</code> server can accept and process file transfer jobs.</p> <p>The state of <code>STARTING</code> indicates that the server is in an intermediate state, either not fully able to respond, or not fully online. The values of <code>START_FAILED</code> can indicate an error condition.</p> <p>No response is returned from this call.</p>', 'StopServer' => '<p>Changes the state of a file transfer protocol-enabled server from <code>ONLINE</code> to <code>OFFLINE</code>. An <code>OFFLINE</code> 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.</p> <note> <p>Stopping the server does not reduce or impact your file transfer protocol endpoint billing; you must delete the server to stop being billed.</p> </note> <p>The state of <code>STOPPING</code> indicates that the server is in an intermediate state, either not fully able to respond, or not fully offline. The values of <code>STOP_FAILED</code> can indicate an error condition.</p> <p>No response is returned from this call.</p>', 'TagResource' => '<p>Attaches a key-value pair to a resource, as identified by its Amazon Resource Name (ARN). Resources are users, servers, roles, and other entities.</p> <p>There is no response returned from this call.</p>', 'TestConnection' => '<p>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.</p>', 'TestIdentityProvider' => '<p>If the <code>IdentityProviderType</code> of a file transfer protocol-enabled server is <code>AWS_DIRECTORY_SERVICE</code> or <code>API_Gateway</code>, 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.</p> <p> The <code>ServerId</code> and <code>UserName</code> parameters are required. The <code>ServerProtocol</code>, <code>SourceIp</code>, and <code>UserPassword</code> are all optional. </p> <p>Note the following:</p> <ul> <li> <p> You cannot use <code>TestIdentityProvider</code> if the <code>IdentityProviderType</code> of your server is <code>SERVICE_MANAGED</code>.</p> </li> <li> <p> <code>TestIdentityProvider</code> does not work with keys: it only accepts passwords.</p> </li> <li> <p> <code>TestIdentityProvider</code> can test the password operation for a custom Identity Provider that handles keys and passwords.</p> </li> <li> <p> If you provide any incorrect values for any parameters, the <code>Response</code> field is empty. </p> </li> <li> <p> If you provide a server ID for a server that uses service-managed users, you get an error: </p> <p> <code> An error occurred (InvalidRequestException) when calling the TestIdentityProvider operation: s-<i>server-ID</i> not configured for external auth </code> </p> </li> <li> <p> If you enter a Server ID for the <code>--server-id</code> parameter that does not identify an actual Transfer server, you receive the following error: </p> <p> <code>An error occurred (ResourceNotFoundException) when calling the TestIdentityProvider operation: Unknown server</code>. </p> <p>It is possible your sever is in a different region. You can specify a region by adding the following: <code>--region region-code</code>, such as <code>--region us-east-2</code> to specify a server in <b>US East (Ohio)</b>.</p> </li> </ul>', 'UntagResource' => '<p>Detaches a key-value pair from a resource, as identified by its Amazon Resource Name (ARN). Resources are users, servers, roles, and other entities.</p> <p>No response is returned from this call.</p>', 'UpdateAccess' => '<p>Allows you to update parameters for the access specified in the <code>ServerID</code> and <code>ExternalID</code> parameters.</p>', 'UpdateAgreement' => '<p>Updates some of the parameters for an existing agreement. Provide the <code>AgreementId</code> and the <code>ServerId</code> for the agreement that you want to update, along with the new values for the parameters to update.</p> <note> <p>Specify <i>either</i> <code>BaseDirectory</code> or <code>CustomDirectories</code>, but not both. Specifying both causes the command to fail.</p> <p>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.</p> </note>', 'UpdateCertificate' => '<p>Updates the active and inactive dates for a certificate.</p>', 'UpdateConnector' => '<p>Updates some of the parameters for an existing connector. Provide the <code>ConnectorId</code> for the connector that you want to update, along with the new values for the parameters to update.</p>', 'UpdateHostKey' => '<p>Updates the description for the host key that\'s specified by the <code>ServerId</code> and <code>HostKeyId</code> parameters.</p>', 'UpdateProfile' => '<p>Updates some of the parameters for an existing profile. Provide the <code>ProfileId</code> for the profile that you want to update, along with the new values for the parameters to update.</p>', 'UpdateServer' => '<p>Updates the file transfer protocol-enabled server\'s properties after that server has been created.</p> <p>The <code>UpdateServer</code> call returns the <code>ServerId</code> of the server you updated.</p>', 'UpdateUser' => '<p>Assigns new properties to a user. Parameters you pass modify any or all of the following: the home directory, role, and policy for the <code>UserName</code> and <code>ServerId</code> you specify.</p> <p>The response returns the <code>ServerId</code> and the <code>UserName</code> for the updated user.</p> <p>In the console, you can select <i>Restricted</i> 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 <code>HomeDirectoryType</code> to <code>LOGICAL</code>, and specify <code>HomeDirectoryMappings</code> with <code>Entry</code> as root (<code>/</code>) and <code>Target</code> as their home directory.</p> <p>For example, if the user\'s home directory is <code>/test/admin-user</code>, the following command updates the user so that their configuration in the console shows the <i>Restricted</i> flag as selected.</p> <p> <code> aws transfer update-user --server-id &lt;server-id&gt; --user-name admin-user --home-directory-type LOGICAL --home-directory-mappings "[{\\"Entry\\":\\"/\\", \\"Target\\":\\"/test/admin-user\\"}]"</code> </p>', 'UpdateWebApp' => '<p>Assigns new properties to a web app. You can modify the access point, identity provider details, and the web app units.</p>', 'UpdateWebAppCustomization' => '<p>Assigns new customization properties to a web app. You can modify the icon file, logo file, and title.</p>', ], 'shapes' => [ 'AccessDeniedException' => [ 'base' => '<p>You do not have sufficient access to perform this action.</p>', 'refs' => [], ], 'AddressAllocationId' => [ 'base' => NULL, 'refs' => [ 'AddressAllocationIds$member' => NULL, ], ], 'AddressAllocationIds' => [ 'base' => NULL, 'refs' => [ 'EndpointDetails$AddressAllocationIds' => '<p>A list of address allocation IDs that are required to attach an Elastic IP address to your server\'s endpoint.</p> <p>An address allocation ID corresponds to the allocation ID of an Elastic IP address. This value can be retrieved from the <code>allocationId</code> field from the Amazon EC2 <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_Address.html">Address</a> data type. One way to retrieve this value is by calling the EC2 <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeAddresses.html">DescribeAddresses</a> API.</p> <p>This parameter is optional. Set this parameter if you want to make your VPC endpoint public-facing. For details, see <a href="https://docs.aws.amazon.com/transfer/latest/userguide/create-server-in-vpc.html#create-internet-facing-endpoint">Create an internet-facing endpoint for your server</a>.</p> <note> <p>This property can only be set as follows:</p> <ul> <li> <p> <code>EndpointType</code> must be set to <code>VPC</code> </p> </li> <li> <p>The Transfer Family server must be offline.</p> </li> <li> <p>You cannot set this parameter for Transfer Family servers that use the FTP protocol.</p> </li> <li> <p>The server must already have <code>SubnetIds</code> populated (<code>SubnetIds</code> and <code>AddressAllocationIds</code> cannot be updated simultaneously).</p> </li> <li> <p> <code>AddressAllocationIds</code> can\'t contain duplicates, and must be equal in length to <code>SubnetIds</code>. For example, if you have three subnet IDs, you must also specify three address allocation IDs.</p> </li> <li> <p>Call the <code>UpdateServer</code> API to set or change this parameter.</p> </li> <li> <p>You can\'t set address allocation IDs for servers that have an <code>IpAddressType</code> set to <code>DUALSTACK</code> You can only set this property if <code>IpAddressType</code> is set to <code>IPV4</code>.</p> </li> </ul> </note>', ], ], 'AgreementId' => [ 'base' => NULL, 'refs' => [ 'CreateAgreementResponse$AgreementId' => '<p>The unique identifier for the agreement. Use this ID for deleting, or updating an agreement, as well as in any other API calls that require that you specify the agreement ID.</p>', 'DeleteAgreementRequest$AgreementId' => '<p>A unique identifier for the agreement. This identifier is returned when you create an agreement.</p>', 'DescribeAgreementRequest$AgreementId' => '<p>A unique identifier for the agreement. This identifier is returned when you create an agreement.</p>', 'DescribedAgreement$AgreementId' => '<p>A unique identifier for the agreement. This identifier is returned when you create an agreement.</p>', 'ListedAgreement$AgreementId' => '<p>A unique identifier for the agreement. This identifier is returned when you create an agreement.</p>', 'UpdateAgreementRequest$AgreementId' => '<p>A unique identifier for the agreement. This identifier is returned when you create an agreement.</p>', 'UpdateAgreementResponse$AgreementId' => '<p>A unique identifier for the agreement. This identifier is returned when you create an agreement.</p>', ], ], 'AgreementStatusType' => [ 'base' => NULL, 'refs' => [ 'CreateAgreementRequest$Status' => '<p>The status of the agreement. The agreement can be either <code>ACTIVE</code> or <code>INACTIVE</code>.</p>', 'DescribedAgreement$Status' => '<p>The current status of the agreement, either <code>ACTIVE</code> or <code>INACTIVE</code>.</p>', 'ListedAgreement$Status' => '<p>The agreement can be either <code>ACTIVE</code> or <code>INACTIVE</code>.</p>', 'UpdateAgreementRequest$Status' => '<p>You can update the status for the agreement, either activating an inactive agreement or the reverse.</p>', ], ], 'Arn' => [ 'base' => NULL, 'refs' => [ 'DescribedAgreement$Arn' => '<p>The unique Amazon Resource Name (ARN) for the agreement.</p>', 'DescribedCertificate$Arn' => '<p>The unique Amazon Resource Name (ARN) for the certificate.</p>', 'DescribedConnector$Arn' => '<p>The unique Amazon Resource Name (ARN) for the connector.</p>', 'DescribedHostKey$Arn' => '<p>The unique Amazon Resource Name (ARN) for the host key.</p>', 'DescribedProfile$Arn' => '<p>The unique Amazon Resource Name (ARN) for the profile.</p>', 'DescribedServer$Arn' => '<p>Specifies the unique Amazon Resource Name (ARN) of the server.</p>', 'DescribedUser$Arn' => '<p>Specifies the unique Amazon Resource Name (ARN) for the user that was requested to be described.</p>', 'DescribedWebApp$Arn' => '<p>The Amazon Resource Name (ARN) of the web app.</p>', 'DescribedWebAppCustomization$Arn' => '<p>Returns the Amazon Resource Name (ARN) for the web app.</p>', 'DescribedWorkflow$Arn' => '<p>Specifies the unique Amazon Resource Name (ARN) for the workflow.</p>', 'ListTagsForResourceRequest$Arn' => '<p>Requests the tags associated with a particular Amazon Resource Name (ARN). An ARN is an identifier for a specific Amazon Web Services resource, such as a server, user, or role.</p>', 'ListTagsForResourceResponse$Arn' => '<p>The ARN you specified to list the tags of.</p>', 'ListedAgreement$Arn' => '<p>The Amazon Resource Name (ARN) of the specified agreement.</p>', 'ListedCertificate$Arn' => '<p>The Amazon Resource Name (ARN) of the specified certificate.</p>', 'ListedConnector$Arn' => '<p>The Amazon Resource Name (ARN) of the specified connector.</p>', 'ListedHostKey$Arn' => '<p>The unique Amazon Resource Name (ARN) of the host key.</p>', 'ListedProfile$Arn' => '<p>The Amazon Resource Name (ARN) of the specified profile.</p>', 'ListedServer$Arn' => '<p>Specifies the unique Amazon Resource Name (ARN) for a server to be listed.</p>', 'ListedUser$Arn' => '<p>Provides the unique Amazon Resource Name (ARN) for the user that you want to learn about.</p>', 'ListedWebApp$Arn' => '<p>The Amazon Resource Name (ARN) for the web app.</p>', 'ListedWorkflow$Arn' => '<p>Specifies the unique Amazon Resource Name (ARN) for the workflow.</p>', 'StructuredLogDestinations$member' => NULL, 'TagResourceRequest$Arn' => '<p>An Amazon Resource Name (ARN) for a specific Amazon Web Services resource, such as a server, user, or role.</p>', 'UntagResourceRequest$Arn' => '<p>The value of the resource that will have the tag removed. An Amazon Resource Name (ARN) is an identifier for a specific Amazon Web Services resource, such as a server, user, or role.</p>', ], ], 'As2ConnectorConfig' => [ 'base' => '<p>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.</p>', 'refs' => [ 'CreateConnectorRequest$As2Config' => '<p>A structure that contains the parameters for an AS2 connector object.</p>', 'DescribedConnector$As2Config' => '<p>A structure that contains the parameters for an AS2 connector object.</p>', 'UpdateConnectorRequest$As2Config' => '<p>A structure that contains the parameters for an AS2 connector object.</p>', ], ], 'As2ConnectorSecretId' => [ 'base' => NULL, 'refs' => [ 'As2ConnectorConfig$BasicAuthSecretId' => '<p>Provides Basic authentication support to the AS2 Connectors API. To use Basic authentication, you must provide the name or Amazon Resource Name (ARN) of a secret in Secrets Manager.</p> <p>The default value for this parameter is <code>null</code>, which indicates that Basic authentication is not enabled for the connector.</p> <p>If the connector should use Basic authentication, the secret needs to be in the following format:</p> <p> <code>{ "Username": "user-name", "Password": "user-password" }</code> </p> <p>Replace <code>user-name</code> and <code>user-password</code> with the credentials for the actual user that is being authenticated.</p> <p>Note the following:</p> <ul> <li> <p>You are storing these credentials in Secrets Manager, <i>not passing them directly</i> into this API.</p> </li> <li> <p>If you are using the API, SDKs, or CloudFormation to configure your connector, then you must create the secret before you can enable Basic authentication. However, if you are using the Amazon Web Services management console, you can have the system create the secret for you.</p> </li> </ul> <p>If you have previously enabled Basic authentication for a connector, you can disable it by using the <code>UpdateConnector</code> API call. For example, if you are using the CLI, you can run the following command to remove Basic authentication:</p> <p> <code>update-connector --connector-id my-connector-id --as2-config \'BasicAuthSecretId=""\'</code> </p>', ], ], 'As2Id' => [ 'base' => NULL, 'refs' => [ 'CreateProfileRequest$As2Id' => '<p>The <code>As2Id</code> is the <i>AS2-name</i>, as defined in the <a href="https://datatracker.ietf.org/doc/html/rfc4130">RFC 4130</a>. For inbound transfers, this is the <code>AS2-From</code> header for the AS2 messages sent from the partner. For outbound connectors, this is the <code>AS2-To</code> header for the AS2 messages sent to the partner using the <code>StartFileTransfer</code> API operation. This ID cannot include spaces.</p>', 'DescribedProfile$As2Id' => '<p>The <code>As2Id</code> is the <i>AS2-name</i>, as defined in the <a href="https://datatracker.ietf.org/doc/html/rfc4130">RFC 4130</a>. For inbound transfers, this is the <code>AS2-From</code> header for the AS2 messages sent from the partner. For outbound connectors, this is the <code>AS2-To</code> header for the AS2 messages sent to the partner using the <code>StartFileTransfer</code> API operation. This ID cannot include spaces.</p>', 'ListedProfile$As2Id' => '<p>The <code>As2Id</code> is the <i>AS2-name</i>, as defined in the <a href="https://datatracker.ietf.org/doc/html/rfc4130">RFC 4130</a>. For inbound transfers, this is the <code>AS2-From</code> header for the AS2 messages sent from the partner. For outbound connectors, this is the <code>AS2-To</code> header for the AS2 messages sent to the partner using the <code>StartFileTransfer</code> API operation. This ID cannot include spaces.</p>', ], ], 'As2Transport' => [ 'base' => NULL, 'refs' => [ 'As2Transports$member' => NULL, ], ], 'As2Transports' => [ 'base' => NULL, 'refs' => [ 'ProtocolDetails$As2Transports' => '<p>Indicates the transport method for the AS2 messages. Currently, only HTTP is supported.</p>', ], ], 'CallbackToken' => [ 'base' => NULL, 'refs' => [ 'SendWorkflowStepStateRequest$Token' => '<p>Used to distinguish between multiple callbacks for multiple Lambda steps within the same execution.</p>', ], ], 'CertDate' => [ 'base' => NULL, 'refs' => [ 'DescribedCertificate$ActiveDate' => '<p>An optional date that specifies when the certificate becomes active. If you do not specify a value, <code>ActiveDate</code> takes the same value as <code>NotBeforeDate</code>, which is specified by the CA. </p>', 'DescribedCertificate$InactiveDate' => '<p>An optional date that specifies when the certificate becomes inactive. If you do not specify a value, <code>InactiveDate</code> takes the same value as <code>NotAfterDate</code>, which is specified by the CA.</p>', 'DescribedCertificate$NotBeforeDate' => '<p>The earliest date that the certificate is valid.</p>', 'DescribedCertificate$NotAfterDate' => '<p>The final date that the certificate is valid.</p>', 'ImportCertificateRequest$ActiveDate' => '<p>An optional date that specifies when the certificate becomes active. If you do not specify a value, <code>ActiveDate</code> takes the same value as <code>NotBeforeDate</code>, which is specified by the CA. </p>', 'ImportCertificateRequest$InactiveDate' => '<p>An optional date that specifies when the certificate becomes inactive. If you do not specify a value, <code>InactiveDate</code> takes the same value as <code>NotAfterDate</code>, which is specified by the CA.</p>', 'ListedCertificate$ActiveDate' => '<p>An optional date that specifies when the certificate becomes active. If you do not specify a value, <code>ActiveDate</code> takes the same value as <code>NotBeforeDate</code>, which is specified by the CA. </p>', 'ListedCertificate$InactiveDate' => '<p>An optional date that specifies when the certificate becomes inactive. If you do not specify a value, <code>InactiveDate</code> takes the same value as <code>NotAfterDate</code>, which is specified by the CA.</p>', 'UpdateCertificateRequest$ActiveDate' => '<p>An optional date that specifies when the certificate becomes active. If you do not specify a value, <code>ActiveDate</code> takes the same value as <code>NotBeforeDate</code>, which is specified by the CA. </p>', 'UpdateCertificateRequest$InactiveDate' => '<p>An optional date that specifies when the certificate becomes inactive. If you do not specify a value, <code>InactiveDate</code> takes the same value as <code>NotAfterDate</code>, which is specified by the CA.</p>', ], ], 'CertSerial' => [ 'base' => NULL, 'refs' => [ 'DescribedCertificate$Serial' => '<p>The serial number for the certificate.</p>', ], ], 'Certificate' => [ 'base' => NULL, 'refs' => [ 'CreateServerRequest$Certificate' => '<p>The Amazon Resource Name (ARN) of the Certificate Manager (ACM) certificate. Required when <code>Protocols</code> is set to <code>FTPS</code>.</p> <p>To request a new public certificate, see <a href="https://docs.aws.amazon.com/acm/latest/userguide/gs-acm-request-public.html">Request a public certificate</a> in the <i>Certificate Manager User Guide</i>.</p> <p>To import an existing certificate into ACM, see <a href="https://docs.aws.amazon.com/acm/latest/userguide/import-certificate.html">Importing certificates into ACM</a> in the <i>Certificate Manager User Guide</i>.</p> <p>To request a private certificate to use FTPS through private IP addresses, see <a href="https://docs.aws.amazon.com/acm/latest/userguide/gs-acm-request-private.html">Request a private certificate</a> in the <i>Certificate Manager User Guide</i>.</p> <p>Certificates with the following cryptographic algorithms and key sizes are supported:</p> <ul> <li> <p>2048-bit RSA (RSA_2048)</p> </li> <li> <p>4096-bit RSA (RSA_4096)</p> </li> <li> <p>Elliptic Prime Curve 256 bit (EC_prime256v1)</p> </li> <li> <p>Elliptic Prime Curve 384 bit (EC_secp384r1)</p> </li> <li> <p>Elliptic Prime Curve 521 bit (EC_secp521r1)</p> </li> </ul> <note> <p>The certificate must be a valid SSL/TLS X.509 version 3 certificate with FQDN or IP address specified and information about the issuer.</p> </note>', 'DescribedServer$Certificate' => '<p>Specifies the ARN of the Amazon Web ServicesCertificate Manager (ACM) certificate. Required when <code>Protocols</code> is set to <code>FTPS</code>.</p>', 'UpdateServerRequest$Certificate' => '<p>The Amazon Resource Name (ARN) of the Amazon Web ServicesCertificate Manager (ACM) certificate. Required when <code>Protocols</code> is set to <code>FTPS</code>.</p> <p>To request a new public certificate, see <a href="https://docs.aws.amazon.com/acm/latest/userguide/gs-acm-request-public.html">Request a public certificate</a> in the <i> Amazon Web ServicesCertificate Manager User Guide</i>.</p> <p>To import an existing certificate into ACM, see <a href="https://docs.aws.amazon.com/acm/latest/userguide/import-certificate.html">Importing certificates into ACM</a> in the <i> Amazon Web ServicesCertificate Manager User Guide</i>.</p> <p>To request a private certificate to use FTPS through private IP addresses, see <a href="https://docs.aws.amazon.com/acm/latest/userguide/gs-acm-request-private.html">Request a private certificate</a> in the <i> Amazon Web ServicesCertificate Manager User Guide</i>.</p> <p>Certificates with the following cryptographic algorithms and key sizes are supported:</p> <ul> <li> <p>2048-bit RSA (RSA_2048)</p> </li> <li> <p>4096-bit RSA (RSA_4096)</p> </li> <li> <p>Elliptic Prime Curve 256 bit (EC_prime256v1)</p> </li> <li> <p>Elliptic Prime Curve 384 bit (EC_secp384r1)</p> </li> <li> <p>Elliptic Prime Curve 521 bit (EC_secp521r1)</p> </li> </ul> <note> <p>The certificate must be a valid SSL/TLS X.509 version 3 certificate with FQDN or IP address specified and information about the issuer.</p> </note>', ], ], 'CertificateBodyType' => [ 'base' => NULL, 'refs' => [ 'DescribedCertificate$Certificate' => '<p>The file name for the certificate.</p>', 'ImportCertificateRequest$Certificate' => '<ul> <li> <p>For the CLI, provide a file path for a certificate in URI format. For example, <code>--certificate file://encryption-cert.pem</code>. Alternatively, you can provide the raw content.</p> </li> <li> <p>For the SDK, specify the raw content of a certificate file. For example, <code>--certificate "`cat encryption-cert.pem`"</code>.</p> </li> </ul> <note> <p>You can provide both the certificate and its chain in this parameter, without needing to use the <code>CertificateChain</code> parameter. If you use this parameter for both the certificate and its chain, do not use the <code>CertificateChain</code> parameter.</p> </note>', ], ], 'CertificateChainType' => [ 'base' => NULL, 'refs' => [ 'DescribedCertificate$CertificateChain' => '<p>The list of certificates that make up the chain for the certificate.</p>', 'ImportCertificateRequest$CertificateChain' => '<p>An optional list of certificates that make up the chain for the certificate that\'s being imported.</p>', ], ], 'CertificateId' => [ 'base' => NULL, 'refs' => [ 'CertificateIds$member' => NULL, 'DeleteCertificateRequest$CertificateId' => '<p>The identifier of the certificate object that you are deleting.</p>', 'DescribeCertificateRequest$CertificateId' => '<p>An array of identifiers for the imported certificates. You use this identifier for working with profiles and partner profiles.</p>', 'DescribedCertificate$CertificateId' => '<p>An array of identifiers for the imported certificates. You use this identifier for working with profiles and partner profiles.</p>', 'ImportCertificateResponse$CertificateId' => '<p>An array of identifiers for the imported certificates. You use this identifier for working with profiles and partner profiles.</p>', 'ListedCertificate$CertificateId' => '<p>An array of identifiers for the imported certificates. You use this identifier for working with profiles and partner profiles.</p>', 'UpdateCertificateRequest$CertificateId' => '<p>The identifier of the certificate object that you are updating.</p>', 'UpdateCertificateResponse$CertificateId' => '<p>Returns the identifier of the certificate object that you are updating.</p>', ], ], 'CertificateIds' => [ 'base' => NULL, 'refs' => [ 'CreateProfileRequest$CertificateIds' => '<p>An array of identifiers for the imported certificates. You use this identifier for working with profiles and partner profiles.</p>', 'DescribedProfile$CertificateIds' => '<p>An array of identifiers for the imported certificates. You use this identifier for working with profiles and partner profiles.</p>', 'UpdateProfileRequest$CertificateIds' => '<p>An array of identifiers for the imported certificates. You use this identifier for working with profiles and partner profiles.</p>', ], ], 'CertificateStatusType' => [ 'base' => NULL, 'refs' => [ 'DescribedCertificate$Status' => '<p>A certificate\'s status can be either <code>ACTIVE</code> or <code>INACTIVE</code>.</p> <p>You can set <code>ActiveDate</code> and <code>InactiveDate</code> in the <code>UpdateCertificate</code> call. If you set values for these parameters, those values are used to determine whether the certificate has a status of <code>ACTIVE</code> or <code>INACTIVE</code>.</p> <p>If you don\'t set values for <code>ActiveDate</code> and <code>InactiveDate</code>, we use the <code>NotBefore</code> and <code>NotAfter</code> date as specified on the X509 certificate to determine when a certificate is active and when it is inactive.</p>', 'ListedCertificate$Status' => '<p>The certificate can be either <code>ACTIVE</code>, <code>PENDING_ROTATION</code>, or <code>INACTIVE</code>. <code>PENDING_ROTATION</code> means that this certificate will replace the current certificate when it expires.</p>', ], ], 'CertificateType' => [ 'base' => NULL, 'refs' => [ 'DescribedCertificate$Type' => '<p>If a private key has been specified for the certificate, its type is <code>CERTIFICATE_WITH_PRIVATE_KEY</code>. If there is no private key, the type is <code>CERTIFICATE</code>.</p>', 'ListedCertificate$Type' => '<p>The type for the certificate. If a private key has been specified for the certificate, its type is <code>CERTIFICATE_WITH_PRIVATE_KEY</code>. If there is no private key, the type is <code>CERTIFICATE</code>.</p>', ], ], 'CertificateUsageType' => [ 'base' => NULL, 'refs' => [ 'DescribedCertificate$Usage' => '<p>Specifies how this certificate is used. It can be used in the following ways:</p> <ul> <li> <p> <code>SIGNING</code>: For signing AS2 messages</p> </li> <li> <p> <code>ENCRYPTION</code>: For encrypting AS2 messages</p> </li> <li> <p> <code>TLS</code>: For securing AS2 communications sent over HTTPS</p> </li> </ul>', 'ImportCertificateRequest$Usage' => '<p>Specifies how this certificate is used. It can be used in the following ways:</p> <ul> <li> <p> <code>SIGNING</code>: For signing AS2 messages</p> </li> <li> <p> <code>ENCRYPTION</code>: For encrypting AS2 messages</p> </li> <li> <p> <code>TLS</code>: For securing AS2 communications sent over HTTPS</p> </li> </ul>', 'ListedCertificate$Usage' => '<p>Specifies how this certificate is used. It can be used in the following ways:</p> <ul> <li> <p> <code>SIGNING</code>: For signing AS2 messages</p> </li> <li> <p> <code>ENCRYPTION</code>: For encrypting AS2 messages</p> </li> <li> <p> <code>TLS</code>: For securing AS2 communications sent over HTTPS</p> </li> </ul>', ], ], 'CompressionEnum' => [ 'base' => NULL, 'refs' => [ 'As2ConnectorConfig$Compression' => '<p>Specifies whether the AS2 file is compressed.</p>', ], ], 'ConflictException' => [ 'base' => '<p>This exception is thrown when the <code>UpdateServer</code> is called for a file transfer protocol-enabled server that has VPC as the endpoint type and the server\'s <code>VpcEndpointID</code> is not in the available state.</p>', 'refs' => [], ], 'ConnectorFileTransferResult' => [ 'base' => '<p>A structure that contains the details for files transferred using an SFTP connector, during a single transfer.</p>', 'refs' => [ 'ConnectorFileTransferResults$member' => NULL, ], ], 'ConnectorFileTransferResults' => [ 'base' => NULL, 'refs' => [ 'ListFileTransferResultsResponse$FileTransferResults' => '<p>Returns the details for the files transferred in the transfer identified by the <code>TransferId</code> and <code>ConnectorId</code> specified.</p> <ul> <li> <p> <code>FilePath</code>: the filename and path to where the file was sent to or retrieved from.</p> </li> <li> <p> <code>StatusCode</code>: current status for the transfer. The status returned is one of the following values:<code>QUEUED</code>, <code>IN_PROGRESS</code>, <code>COMPLETED</code>, or <code>FAILED</code> </p> </li> <li> <p> <code>FailureCode</code>: for transfers that fail, this parameter contains a code indicating the reason. For example, <code>RETRIEVE_FILE_NOT_FOUND</code> </p> </li> <li> <p> <code>FailureMessage</code>: for transfers that fail, this parameter describes the reason for the failure.</p> </li> </ul>', ], ], 'ConnectorId' => [ 'base' => NULL, 'refs' => [ 'CreateConnectorResponse$ConnectorId' => '<p>The unique identifier for the connector, returned after the API call succeeds.</p>', 'DeleteConnectorRequest$ConnectorId' => '<p>The unique identifier for the connector.</p>', 'DescribeConnectorRequest$ConnectorId' => '<p>The unique identifier for the connector.</p>', 'DescribedConnector$ConnectorId' => '<p>The unique identifier for the connector.</p>', 'ListFileTransferResultsRequest$ConnectorId' => '<p>A unique identifier for a connector. This value should match the value supplied to the corresponding <code>StartFileTransfer</code> call.</p>', 'ListedConnector$ConnectorId' => '<p>The unique identifier for the connector.</p>', 'StartDirectoryListingRequest$ConnectorId' => '<p>The unique identifier for the connector.</p>', 'StartFileTransferRequest$ConnectorId' => '<p>The unique identifier for the connector.</p>', 'StartRemoteDeleteRequest$ConnectorId' => '<p>The unique identifier for the connector.</p>', 'StartRemoteMoveRequest$ConnectorId' => '<p>The unique identifier for the connector.</p>', 'TestConnectionRequest$ConnectorId' => '<p>The unique identifier for the connector.</p>', 'TestConnectionResponse$ConnectorId' => '<p>Returns the identifier of the connector object that you are testing.</p>', 'UpdateConnectorRequest$ConnectorId' => '<p>The unique identifier for the connector.</p>', 'UpdateConnectorResponse$ConnectorId' => '<p>Returns the identifier of the connector object that you are updating.</p>', ], ], 'ConnectorSecurityPolicyName' => [ 'base' => NULL, 'refs' => [ 'CreateConnectorRequest$SecurityPolicyName' => '<p>Specifies the name of the security policy for the connector.</p>', 'DescribedConnector$SecurityPolicyName' => '<p>The text name of the security policy for the specified connector.</p>', 'UpdateConnectorRequest$SecurityPolicyName' => '<p>Specifies the name of the security policy for the connector.</p>', ], ], 'CopyStepDetails' => [ 'base' => '<p>Each step type has its own <code>StepDetails</code> structure.</p>', 'refs' => [ 'WorkflowStep$CopyStepDetails' => '<p>Details for a step that performs a file copy.</p> <p> Consists of the following values: </p> <ul> <li> <p>A description</p> </li> <li> <p>An Amazon S3 location for the destination of the file copy.</p> </li> <li> <p>A flag that indicates whether to overwrite an existing file of the same name. The default is <code>FALSE</code>.</p> </li> </ul>', ], ], 'CreateAccessRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateAccessResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateAgreementRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateAgreementResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateConnectorRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateConnectorResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateProfileRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateProfileResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateServerRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateServerResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateUserRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateUserResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateWebAppRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateWebAppResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateWorkflowRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateWorkflowResponse' => [ 'base' => NULL, 'refs' => [], ], 'CustomDirectoriesType' => [ 'base' => '<p>Contains Amazon S3 locations for storing specific types of AS2 message files.</p>', 'refs' => [ 'CreateAgreementRequest$CustomDirectories' => '<p>A <code>CustomDirectoriesType</code> structure. This structure specifies custom directories for storing various AS2 message files. You can specify directories for the following types of files.</p> <ul> <li> <p>Failed files</p> </li> <li> <p>MDN files</p> </li> <li> <p>Payload files</p> </li> <li> <p>Status files</p> </li> <li> <p>Temporary files</p> </li> </ul>', 'DescribedAgreement$CustomDirectories' => '<p>A <code>CustomDirectoriesType</code> structure. This structure specifies custom directories for storing various AS2 message files. You can specify directories for the following types of files.</p> <ul> <li> <p>Failed files</p> </li> <li> <p>MDN files</p> </li> <li> <p>Payload files</p> </li> <li> <p>Status files</p> </li> <li> <p>Temporary files</p> </li> </ul>', 'UpdateAgreementRequest$CustomDirectories' => '<p>A <code>CustomDirectoriesType</code> structure. This structure specifies custom directories for storing various AS2 message files. You can specify directories for the following types of files.</p> <ul> <li> <p>Failed files</p> </li> <li> <p>MDN files</p> </li> <li> <p>Payload files</p> </li> <li> <p>Status files</p> </li> <li> <p>Temporary files</p> </li> </ul>', ], ], 'CustomStepDetails' => [ 'base' => '<p>Each step type has its own <code>StepDetails</code> structure.</p>', 'refs' => [ 'WorkflowStep$CustomStepDetails' => '<p>Details for a step that invokes an Lambda function.</p> <p>Consists of the Lambda function\'s name, target, and timeout (in seconds). </p>', ], ], 'CustomStepStatus' => [ 'base' => NULL, 'refs' => [ 'SendWorkflowStepStateRequest$Status' => '<p>Indicates whether the specified step succeeded or failed.</p>', ], ], 'CustomStepTarget' => [ 'base' => NULL, 'refs' => [ 'CustomStepDetails$Target' => '<p>The ARN for the Lambda function that is being called.</p>', ], ], 'CustomStepTimeoutSeconds' => [ 'base' => NULL, 'refs' => [ 'CustomStepDetails$TimeoutSeconds' => '<p>Timeout, in seconds, for the step.</p>', ], ], 'DateImported' => [ 'base' => NULL, 'refs' => [ 'DescribedHostKey$DateImported' => '<p>The date on which the host key was added to the server.</p>', 'ListedHostKey$DateImported' => '<p>The date on which the host key was added to the server.</p>', 'SshPublicKey$DateImported' => '<p>Specifies the date that the public key was added to the Transfer Family user.</p>', ], ], 'DecryptStepDetails' => [ 'base' => '<p>Each step type has its own <code>StepDetails</code> structure.</p>', 'refs' => [ 'WorkflowStep$DecryptStepDetails' => '<p>Details for a step that decrypts an encrypted file.</p> <p>Consists of the following values:</p> <ul> <li> <p>A descriptive name</p> </li> <li> <p>An Amazon S3 or Amazon Elastic File System (Amazon EFS) location for the source file to decrypt.</p> </li> <li> <p>An S3 or Amazon EFS location for the destination of the file decryption.</p> </li> <li> <p>A flag that indicates whether to overwrite an existing file of the same name. The default is <code>FALSE</code>.</p> </li> <li> <p>The type of encryption that\'s used. Currently, only PGP encryption is supported.</p> </li> </ul>', ], ], 'DeleteAccessRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteAgreementRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteCertificateRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteConnectorRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteHostKeyRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteId' => [ 'base' => NULL, 'refs' => [ 'StartRemoteDeleteResponse$DeleteId' => '<p>Returns a unique identifier for the delete operation.</p>', ], ], 'DeleteProfileRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteServerRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteSshPublicKeyRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteStepDetails' => [ 'base' => '<p>The name of the step, used to identify the delete step.</p>', 'refs' => [ 'WorkflowStep$DeleteStepDetails' => '<p>Details for a step that deletes the file.</p>', ], ], 'DeleteUserRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteWebAppCustomizationRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteWebAppRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteWorkflowRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeAccessRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeAccessResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeAgreementRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeAgreementResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeCertificateRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeCertificateResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeConnectorRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeConnectorResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeExecutionRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeExecutionResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeHostKeyRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeHostKeyResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeProfileRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeProfileResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeSecurityPolicyRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeSecurityPolicyResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeServerRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeServerResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeUserRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeUserResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeWebAppCustomizationRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeWebAppCustomizationResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeWebAppRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeWebAppResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeWorkflowRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeWorkflowResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribedAccess' => [ 'base' => '<p>Describes the properties of the access that was specified.</p>', 'refs' => [ 'DescribeAccessResponse$Access' => '<p>The external identifier of the server that the access is attached to.</p>', ], ], 'DescribedAgreement' => [ 'base' => '<p>Describes the properties of an agreement.</p>', 'refs' => [ 'DescribeAgreementResponse$Agreement' => '<p>The details for the specified agreement, returned as a <code>DescribedAgreement</code> object.</p>', ], ], 'DescribedCertificate' => [ 'base' => '<p>Describes the properties of a certificate.</p>', 'refs' => [ 'DescribeCertificateResponse$Certificate' => '<p>The details for the specified certificate, returned as an object.</p>', ], ], 'DescribedConnector' => [ 'base' => '<p>Describes the parameters for the connector, as identified by the <code>ConnectorId</code>.</p>', 'refs' => [ 'DescribeConnectorResponse$Connector' => '<p>The structure that contains the details of the connector.</p>', ], ], 'DescribedExecution' => [ 'base' => '<p>The details for an execution object.</p>', 'refs' => [ 'DescribeExecutionResponse$Execution' => '<p>The structure that contains the details of the workflow\' execution.</p>', ], ], 'DescribedHostKey' => [ 'base' => '<p>The details for a server host key.</p>', 'refs' => [ 'DescribeHostKeyResponse$HostKey' => '<p>Returns the details for the specified host key.</p>', ], ], 'DescribedIdentityCenterConfig' => [ 'base' => '<p>A structure that contains the details of the IAM Identity Center used for your web app. Returned during a call to <code>DescribeWebApp</code>.</p>', 'refs' => [ 'DescribedWebAppIdentityProviderDetails$IdentityCenterConfig' => '<p>Returns a structure for your identity provider details. This structure contains the instance ARN and role being used for the web app.</p>', ], ], 'DescribedProfile' => [ 'base' => '<p>The details for a local or partner AS2 profile. </p>', 'refs' => [ 'DescribeProfileResponse$Profile' => '<p>The details of the specified profile, returned as an object.</p>', ], ], 'DescribedSecurityPolicy' => [ 'base' => '<p>Describes the properties of a security policy that you specify. For more information about security policies, see <a href="https://docs.aws.amazon.com/transfer/latest/userguide/security-policies.html">Working with security policies for servers</a> or <a href="https://docs.aws.amazon.com/transfer/latest/userguide/security-policies-connectors.html">Working with security policies for SFTP connectors</a>.</p>', 'refs' => [ 'DescribeSecurityPolicyResponse$SecurityPolicy' => '<p>An array containing the properties of the security policy.</p>', ], ], 'DescribedServer' => [ 'base' => '<p>Describes the properties of a file transfer protocol-enabled server that was specified.</p>', 'refs' => [ 'DescribeServerResponse$Server' => '<p>An array containing the properties of a server with the <code>ServerID</code> you specified.</p>', ], ], 'DescribedUser' => [ 'base' => '<p>Describes the properties of a user that was specified.</p>', 'refs' => [ 'DescribeUserResponse$User' => '<p>An array containing the properties of the Transfer Family user for the <code>ServerID</code> value that you specified.</p>', ], ], 'DescribedWebApp' => [ 'base' => '<p>A structure that describes the parameters for the web app, as identified by the <code>WebAppId</code>.</p>', 'refs' => [ 'DescribeWebAppResponse$WebApp' => '<p>Returns a structure that contains the details of the web app.</p>', ], ], 'DescribedWebAppCustomization' => [ 'base' => '<p>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.</p>', 'refs' => [ 'DescribeWebAppCustomizationResponse$WebAppCustomization' => '<p>Returns a structure that contains the details of the web app customizations.</p>', ], ], 'DescribedWebAppIdentityProviderDetails' => [ 'base' => '<p>Returns a structure that contains the identity provider details for your web app.</p>', 'refs' => [ 'DescribedWebApp$DescribedIdentityProviderDetails' => '<p>A structure that contains the details for the identity provider used by the web app.</p>', ], ], 'DescribedWorkflow' => [ 'base' => '<p>Describes the properties of the specified workflow</p>', 'refs' => [ 'DescribeWorkflowResponse$Workflow' => '<p>The structure that contains the details of the workflow.</p>', ], ], 'Description' => [ 'base' => NULL, 'refs' => [ 'CreateAgreementRequest$Description' => '<p>A name or short description to identify the agreement. </p>', 'DescribedAgreement$Description' => '<p>The name or short description that\'s used to identify the agreement.</p>', 'DescribedCertificate$Description' => '<p>The name or description that\'s used to identity the certificate. </p>', 'ImportCertificateRequest$Description' => '<p>A short description that helps identify the certificate. </p>', 'ListedAgreement$Description' => '<p>The current description for the agreement. You can change it by calling the <code>UpdateAgreement</code> operation and providing a new description. </p>', 'ListedCertificate$Description' => '<p>The name or short description that\'s used to identify the certificate.</p>', 'UpdateAgreementRequest$Description' => '<p>To replace the existing description, provide a short description for the agreement. </p>', 'UpdateCertificateRequest$Description' => '<p>A short description to help identify the certificate.</p>', ], ], 'DirectoryId' => [ 'base' => NULL, 'refs' => [ 'IdentityProviderDetails$DirectoryId' => '<p>The identifier of the Directory Service directory that you want to use as your identity provider.</p>', ], ], 'DirectoryListingOptimization' => [ 'base' => '<p>Indicates whether optimization to directory listing on S3 servers is used. Disabled by default for compatibility.</p>', 'refs' => [ 'S3StorageOptions$DirectoryListingOptimization' => '<p>Specifies whether or not performance for your Amazon S3 directories is optimized.</p> <ul> <li> <p>If using the console, this is enabled by default.</p> </li> <li> <p>If using the API or CLI, this is disabled by default.</p> </li> </ul> <p>By default, home directory mappings have a <code>TYPE</code> of <code>DIRECTORY</code>. If you enable this option, you would then need to explicitly set the <code>HomeDirectoryMapEntry</code> <code>Type</code> to <code>FILE</code> if you want a mapping to have a file target.</p>', ], ], 'Domain' => [ 'base' => NULL, 'refs' => [ 'CreateServerRequest$Domain' => '<p>The domain of the storage system that is used for file transfers. There are two domains available: Amazon Simple Storage Service (Amazon S3) and Amazon Elastic File System (Amazon EFS). The default value is S3.</p> <note> <p>After the server is created, the domain cannot be changed.</p> </note>', 'DescribedServer$Domain' => '<p>Specifies the domain of the storage system that is used for file transfers. There are two domains available: Amazon Simple Storage Service (Amazon S3) and Amazon Elastic File System (Amazon EFS). The default value is S3.</p>', 'ListedServer$Domain' => '<p>Specifies the domain of the storage system that is used for file transfers. There are two domains available: Amazon Simple Storage Service (Amazon S3) and Amazon Elastic File System (Amazon EFS). The default value is S3.</p>', ], ], 'EfsFileLocation' => [ 'base' => '<p>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.</p> <p> </p>', 'refs' => [ 'FileLocation$EfsFileLocation' => '<p>Specifies the Amazon EFS identifier and the path for the file being used.</p>', 'InputFileLocation$EfsFileLocation' => '<p>Specifies the details for the Amazon Elastic File System (Amazon EFS) file that\'s being decrypted.</p>', ], ], 'EfsFileSystemId' => [ 'base' => NULL, 'refs' => [ 'EfsFileLocation$FileSystemId' => '<p>The identifier of the file system, assigned by Amazon EFS.</p>', ], ], 'EfsPath' => [ 'base' => NULL, 'refs' => [ 'EfsFileLocation$Path' => '<p>The pathname for the folder being used by a workflow.</p>', ], ], 'EncryptionAlg' => [ 'base' => NULL, 'refs' => [ 'As2ConnectorConfig$EncryptionAlgorithm' => '<p>The algorithm that is used to encrypt the file.</p> <p>Note the following:</p> <ul> <li> <p>Do not use the <code>DES_EDE3_CBC</code> algorithm unless you must support a legacy client that requires it, as it is a weak encryption algorithm.</p> </li> <li> <p>You can only specify <code>NONE</code> if the URL for your connector uses HTTPS. Using HTTPS ensures that no traffic is sent in clear text.</p> </li> </ul>', ], ], 'EncryptionType' => [ 'base' => NULL, 'refs' => [ 'DecryptStepDetails$Type' => '<p>The type of encryption used. Currently, this value must be <code>PGP</code>.</p>', ], ], 'EndpointDetails' => [ 'base' => '<p>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 <code>UpdateServer</code> API and attach an Elastic IP address to your server\'s endpoint.</p> <note> <p> After May 19, 2021, you won\'t be able to create a server using <code>EndpointType=VPC_ENDPOINT</code> 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 <code>EndpointType=VPC_ENDPOINT</code> in your Amazon Web Services account on or before May 19, 2021, you will not be affected. After this date, use <code>EndpointType</code>=<code>VPC</code>.</p> <p>For more information, see https://docs.aws.amazon.com/transfer/latest/userguide/create-server-in-vpc.html#deprecate-vpc-endpoint.</p> <p>It is recommended that you use <code>VPC</code> as the <code>EndpointType</code>. 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 <code>EndpointType</code> set to <code>VPC_ENDPOINT</code>.</p> </note>', 'refs' => [ 'CreateServerRequest$EndpointDetails' => '<p>The virtual private cloud (VPC) endpoint settings that are configured for your server. When you host your endpoint within your VPC, you can make your endpoint accessible only to resources within your VPC, or you can attach Elastic IP addresses and make your endpoint accessible to clients over the internet. Your VPC\'s default security groups are automatically assigned to your endpoint.</p>', 'DescribedServer$EndpointDetails' => '<p>The virtual private cloud (VPC) endpoint settings that are configured for your server. When you host your endpoint within your VPC, you can make your endpoint accessible only to resources within your VPC, or you can attach Elastic IP addresses and make your endpoint accessible to clients over the internet. Your VPC\'s default security groups are automatically assigned to your endpoint.</p>', 'UpdateServerRequest$EndpointDetails' => '<p>The virtual private cloud (VPC) endpoint settings that are configured for your server. When you host your endpoint within your VPC, you can make your endpoint accessible only to resources within your VPC, or you can attach Elastic IP addresses and make your endpoint accessible to clients over the internet. Your VPC\'s default security groups are automatically assigned to your endpoint.</p>', ], ], 'EndpointType' => [ 'base' => NULL, 'refs' => [ 'CreateServerRequest$EndpointType' => '<p>The type of endpoint that you want your server to use. You can choose to make your server\'s endpoint publicly accessible (PUBLIC) or host it inside your VPC. With an endpoint that is hosted in a VPC, you can restrict access to your server and resources only within your VPC or choose to make it internet facing by attaching Elastic IP addresses directly to it.</p> <note> <p> After May 19, 2021, you won\'t be able to create a server using <code>EndpointType=VPC_ENDPOINT</code> 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 <code>EndpointType=VPC_ENDPOINT</code> in your Amazon Web Services account on or before May 19, 2021, you will not be affected. After this date, use <code>EndpointType</code>=<code>VPC</code>.</p> <p>For more information, see https://docs.aws.amazon.com/transfer/latest/userguide/create-server-in-vpc.html#deprecate-vpc-endpoint.</p> <p>It is recommended that you use <code>VPC</code> as the <code>EndpointType</code>. 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 <code>EndpointType</code> set to <code>VPC_ENDPOINT</code>.</p> </note>', 'DescribedServer$EndpointType' => '<p>Defines the type of endpoint that your server is connected to. If your server is connected to a VPC endpoint, your server isn\'t accessible over the public internet.</p>', 'ListedServer$EndpointType' => '<p>Specifies the type of VPC endpoint that your server is connected to. If your server is connected to a VPC endpoint, your server isn\'t accessible over the public internet.</p>', 'UpdateServerRequest$EndpointType' => '<p>The type of endpoint that you want your server to use. You can choose to make your server\'s endpoint publicly accessible (PUBLIC) or host it inside your VPC. With an endpoint that is hosted in a VPC, you can restrict access to your server and resources only within your VPC or choose to make it internet facing by attaching Elastic IP addresses directly to it.</p> <note> <p> After May 19, 2021, you won\'t be able to create a server using <code>EndpointType=VPC_ENDPOINT</code> 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 <code>EndpointType=VPC_ENDPOINT</code> in your Amazon Web Services account on or before May 19, 2021, you will not be affected. After this date, use <code>EndpointType</code>=<code>VPC</code>.</p> <p>For more information, see https://docs.aws.amazon.com/transfer/latest/userguide/create-server-in-vpc.html#deprecate-vpc-endpoint.</p> <p>It is recommended that you use <code>VPC</code> as the <code>EndpointType</code>. 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 <code>EndpointType</code> set to <code>VPC_ENDPOINT</code>.</p> </note>', ], ], 'EnforceMessageSigningType' => [ 'base' => NULL, 'refs' => [ 'CreateAgreementRequest$EnforceMessageSigning' => '<p> Determines whether or not unsigned messages from your trading partners will be accepted. </p> <ul> <li> <p> <code>ENABLED</code>: Transfer Family rejects unsigned messages from your trading partner.</p> </li> <li> <p> <code>DISABLED</code> (default value): Transfer Family accepts unsigned messages from your trading partner.</p> </li> </ul>', 'DescribedAgreement$EnforceMessageSigning' => '<p> Determines whether or not unsigned messages from your trading partners will be accepted. </p> <ul> <li> <p> <code>ENABLED</code>: Transfer Family rejects unsigned messages from your trading partner.</p> </li> <li> <p> <code>DISABLED</code> (default value): Transfer Family accepts unsigned messages from your trading partner.</p> </li> </ul>', 'UpdateAgreementRequest$EnforceMessageSigning' => '<p> Determines whether or not unsigned messages from your trading partners will be accepted. </p> <ul> <li> <p> <code>ENABLED</code>: Transfer Family rejects unsigned messages from your trading partner.</p> </li> <li> <p> <code>DISABLED</code> (default value): Transfer Family accepts unsigned messages from your trading partner.</p> </li> </ul>', ], ], 'ExecutionError' => [ 'base' => '<p>Specifies the error message and type, for an error that occurs during the execution of the workflow.</p>', 'refs' => [ 'ExecutionStepResult$Error' => '<p>Specifies the details for an error, if it occurred during execution of the specified workflow step.</p>', ], ], 'ExecutionErrorMessage' => [ 'base' => NULL, 'refs' => [ 'ExecutionError$Message' => '<p>Specifies the descriptive message that corresponds to the <code>ErrorType</code>.</p>', ], ], 'ExecutionErrorType' => [ 'base' => NULL, 'refs' => [ 'ExecutionError$Type' => '<p>Specifies the error type.</p> <ul> <li> <p> <code>ALREADY_EXISTS</code>: occurs for a copy step, if the overwrite option is not selected and a file with the same name already exists in the target location.</p> </li> <li> <p> <code>BAD_REQUEST</code>: a general bad request: for example, a step that attempts to tag an EFS file returns <code>BAD_REQUEST</code>, as only S3 files can be tagged.</p> </li> <li> <p> <code>CUSTOM_STEP_FAILED</code>: occurs when the custom step provided a callback that indicates failure.</p> </li> <li> <p> <code>INTERNAL_SERVER_ERROR</code>: a catch-all error that can occur for a variety of reasons.</p> </li> <li> <p> <code>NOT_FOUND</code>: occurs when a requested entity, for example a source file for a copy step, does not exist.</p> </li> <li> <p> <code>PERMISSION_DENIED</code>: occurs if your policy does not contain the correct permissions to complete one or more of the steps in the workflow.</p> </li> <li> <p> <code>TIMEOUT</code>: occurs when the execution times out.</p> <note> <p> You can set the <code>TimeoutSeconds</code> for a custom step, anywhere from 1 second to 1800 seconds (30 minutes). </p> </note> </li> <li> <p> <code>THROTTLED</code>: occurs if you exceed the new execution refill rate of one workflow per second.</p> </li> </ul>', ], ], 'ExecutionId' => [ 'base' => NULL, 'refs' => [ 'DescribeExecutionRequest$ExecutionId' => '<p>A unique identifier for the execution of a workflow.</p>', 'DescribedExecution$ExecutionId' => '<p>A unique identifier for the execution of a workflow.</p>', 'ListedExecution$ExecutionId' => '<p>A unique identifier for the execution of a workflow.</p>', 'SendWorkflowStepStateRequest$ExecutionId' => '<p>A unique identifier for the execution of a workflow.</p>', ], ], 'ExecutionResults' => [ 'base' => '<p>Specifies the steps in the workflow, as well as the steps to execute in case of any errors during workflow execution.</p>', 'refs' => [ 'DescribedExecution$Results' => '<p>A structure that describes the execution results. This includes a list of the steps along with the details of each step, error type and message (if any), and the <code>OnExceptionSteps</code> structure.</p>', ], ], 'ExecutionStatus' => [ 'base' => NULL, 'refs' => [ 'DescribedExecution$Status' => '<p>The status is one of the execution. Can be in progress, completed, exception encountered, or handling the exception. </p>', 'ListedExecution$Status' => '<p>The status is one of the execution. Can be in progress, completed, exception encountered, or handling the exception.</p>', ], ], 'ExecutionStepResult' => [ 'base' => '<p>Specifies the following details for the step: error (if any), outputs (if any), and the step type.</p>', 'refs' => [ 'ExecutionStepResults$member' => NULL, ], ], 'ExecutionStepResults' => [ 'base' => NULL, 'refs' => [ 'ExecutionResults$Steps' => '<p>Specifies the details for the steps that are in the specified workflow.</p>', 'ExecutionResults$OnExceptionSteps' => '<p>Specifies the steps (actions) to take if errors are encountered during execution of the workflow.</p>', ], ], 'ExternalId' => [ 'base' => NULL, 'refs' => [ 'CreateAccessRequest$ExternalId' => '<p>A unique identifier that is required to identify specific groups within your directory. The users of the group that you associate have access to your Amazon S3 or Amazon EFS resources over the enabled protocols using Transfer Family. If you know the group name, you can view the SID values by running the following command using Windows PowerShell.</p> <p> <code>Get-ADGroup -Filter {samAccountName -like "<i>YourGroupName</i>*"} -Properties * | Select SamAccountName,ObjectSid</code> </p> <p>In that command, replace <i>YourGroupName</i> with the name of your Active Directory group.</p> <p>The regular expression used to validate this parameter is a string of characters consisting of uppercase and lowercase alphanumeric characters with no spaces. You can also include underscores or any of the following characters: =,.@:/-</p>', 'CreateAccessResponse$ExternalId' => '<p>The external identifier of the group whose users have access to your Amazon S3 or Amazon EFS resources over the enabled protocols using Transfer Family.</p>', 'DeleteAccessRequest$ExternalId' => '<p>A unique identifier that is required to identify specific groups within your directory. The users of the group that you associate have access to your Amazon S3 or Amazon EFS resources over the enabled protocols using Transfer Family. If you know the group name, you can view the SID values by running the following command using Windows PowerShell.</p> <p> <code>Get-ADGroup -Filter {samAccountName -like "<i>YourGroupName</i>*"} -Properties * | Select SamAccountName,ObjectSid</code> </p> <p>In that command, replace <i>YourGroupName</i> with the name of your Active Directory group.</p> <p>The regular expression used to validate this parameter is a string of characters consisting of uppercase and lowercase alphanumeric characters with no spaces. You can also include underscores or any of the following characters: =,.@:/-</p>', 'DescribeAccessRequest$ExternalId' => '<p>A unique identifier that is required to identify specific groups within your directory. The users of the group that you associate have access to your Amazon S3 or Amazon EFS resources over the enabled protocols using Transfer Family. If you know the group name, you can view the SID values by running the following command using Windows PowerShell.</p> <p> <code>Get-ADGroup -Filter {samAccountName -like "<i>YourGroupName</i>*"} -Properties * | Select SamAccountName,ObjectSid</code> </p> <p>In that command, replace <i>YourGroupName</i> with the name of your Active Directory group.</p> <p>The regular expression used to validate this parameter is a string of characters consisting of uppercase and lowercase alphanumeric characters with no spaces. You can also include underscores or any of the following characters: =,.@:/-</p>', 'DescribedAccess$ExternalId' => '<p>A unique identifier that is required to identify specific groups within your directory. The users of the group that you associate have access to your Amazon S3 or Amazon EFS resources over the enabled protocols using Transfer Family. If you know the group name, you can view the SID values by running the following command using Windows PowerShell.</p> <p> <code>Get-ADGroup -Filter {samAccountName -like "<i>YourGroupName</i>*"} -Properties * | Select SamAccountName,ObjectSid</code> </p> <p>In that command, replace <i>YourGroupName</i> with the name of your Active Directory group.</p> <p>The regular expression used to validate this parameter is a string of characters consisting of uppercase and lowercase alphanumeric characters with no spaces. You can also include underscores or any of the following characters: =,.@:/-</p>', 'ListedAccess$ExternalId' => '<p>A unique identifier that is required to identify specific groups within your directory. The users of the group that you associate have access to your Amazon S3 or Amazon EFS resources over the enabled protocols using Transfer Family. If you know the group name, you can view the SID values by running the following command using Windows PowerShell.</p> <p> <code>Get-ADGroup -Filter {samAccountName -like "<i>YourGroupName</i>*"} -Properties * | Select SamAccountName,ObjectSid</code> </p> <p>In that command, replace <i>YourGroupName</i> with the name of your Active Directory group.</p> <p>The regular expression used to validate this parameter is a string of characters consisting of uppercase and lowercase alphanumeric characters with no spaces. You can also include underscores or any of the following characters: =,.@:/-</p>', 'UpdateAccessRequest$ExternalId' => '<p>A unique identifier that is required to identify specific groups within your directory. The users of the group that you associate have access to your Amazon S3 or Amazon EFS resources over the enabled protocols using Transfer Family. If you know the group name, you can view the SID values by running the following command using Windows PowerShell.</p> <p> <code>Get-ADGroup -Filter {samAccountName -like "<i>YourGroupName</i>*"} -Properties * | Select SamAccountName,ObjectSid</code> </p> <p>In that command, replace <i>YourGroupName</i> with the name of your Active Directory group.</p> <p>The regular expression used to validate this parameter is a string of characters consisting of uppercase and lowercase alphanumeric characters with no spaces. You can also include underscores or any of the following characters: =,.@:/-</p>', 'UpdateAccessResponse$ExternalId' => '<p>The external identifier of the group whose users have access to your Amazon S3 or Amazon EFS resources over the enabled protocols using Amazon Web ServicesTransfer Family.</p>', ], ], 'FailureCode' => [ 'base' => NULL, 'refs' => [ 'ConnectorFileTransferResult$FailureCode' => '<p>For transfers that fail, this parameter contains a code indicating the reason. For example, <code>RETRIEVE_FILE_NOT_FOUND</code> </p>', ], ], 'FileLocation' => [ 'base' => '<p>Specifies the Amazon S3 or EFS file details to be used in the step.</p>', 'refs' => [ 'DescribedExecution$InitialFileLocation' => '<p>A structure that describes the Amazon S3 or EFS file location. This is the file location when the execution begins: if the file is being copied, this is the initial (as opposed to destination) file location.</p>', 'ListedExecution$InitialFileLocation' => '<p>A structure that describes the Amazon S3 or EFS file location. This is the file location when the execution begins: if the file is being copied, this is the initial (as opposed to destination) file location.</p>', ], ], 'FilePath' => [ 'base' => NULL, 'refs' => [ 'ConnectorFileTransferResult$FilePath' => '<p>The filename and path to where the file was sent to or retrieved from.</p>', 'FilePaths$member' => NULL, 'StartDirectoryListingRequest$RemoteDirectoryPath' => '<p>Specifies the directory on the remote SFTP server for which you want to list its contents.</p>', 'StartDirectoryListingRequest$OutputDirectoryPath' => '<p>Specifies the path (bucket and prefix) in Amazon S3 storage to store the results of the directory listing.</p>', 'StartFileTransferRequest$LocalDirectoryPath' => '<p>For an inbound transfer, the <code>LocaDirectoryPath</code> specifies the destination for one or more files that are transferred from the partner\'s SFTP server.</p>', 'StartFileTransferRequest$RemoteDirectoryPath' => '<p>For an outbound transfer, the <code>RemoteDirectoryPath</code> specifies the destination for one or more files that are transferred to the partner\'s SFTP server. If you don\'t specify a <code>RemoteDirectoryPath</code>, the destination for transferred files is the SFTP user\'s home directory.</p>', 'StartRemoteDeleteRequest$DeletePath' => '<p>The absolute path of the file or directory to delete. You can only specify one path per call to this operation.</p>', 'StartRemoteMoveRequest$SourcePath' => '<p>The absolute path of the file or directory to move or rename. You can only specify one path per call to this operation.</p>', 'StartRemoteMoveRequest$TargetPath' => '<p>The absolute path for the target of the move/rename operation.</p>', ], ], 'FilePaths' => [ 'base' => NULL, 'refs' => [ 'StartFileTransferRequest$SendFilePaths' => '<p>One or more source paths for the Amazon S3 storage. Each string represents a source file path for one outbound file transfer. For example, <code> <i>amzn-s3-demo-bucket</i>/<i>myfile.txt</i> </code>.</p> <note> <p>Replace <code> <i>amzn-s3-demo-bucket</i> </code> with one of your actual buckets.</p> </note>', 'StartFileTransferRequest$RetrieveFilePaths' => '<p>One or more source paths for the partner\'s SFTP server. Each string represents a source file path for one inbound file transfer.</p>', ], ], 'Fips' => [ 'base' => NULL, 'refs' => [ 'DescribedSecurityPolicy$Fips' => '<p>Specifies whether this policy enables Federal Information Processing Standards (FIPS). This parameter applies to both server and connector security policies.</p>', ], ], 'Function' => [ 'base' => NULL, 'refs' => [ 'IdentityProviderDetails$Function' => '<p>The ARN for a Lambda function to use for the Identity provider.</p>', ], ], 'HomeDirectory' => [ 'base' => NULL, 'refs' => [ 'CreateAccessRequest$HomeDirectory' => '<p>The landing directory (folder) for a user when they log in to the server using the client.</p> <p>A <code>HomeDirectory</code> example is <code>/bucket_name/home/mydirectory</code>.</p> <note> <p>You can use the <code>HomeDirectory</code> parameter for <code>HomeDirectoryType</code> when it is set to either <code>PATH</code> or <code>LOGICAL</code>.</p> </note>', 'CreateAgreementRequest$BaseDirectory' => '<p>The landing directory (folder) for files transferred by using the AS2 protocol.</p> <p>A <code>BaseDirectory</code> example is <code>/<i>amzn-s3-demo-bucket</i>/home/mydirectory</code>.</p>', 'CreateUserRequest$HomeDirectory' => '<p>The landing directory (folder) for a user when they log in to the server using the client.</p> <p>A <code>HomeDirectory</code> example is <code>/bucket_name/home/mydirectory</code>.</p> <note> <p>You can use the <code>HomeDirectory</code> parameter for <code>HomeDirectoryType</code> when it is set to either <code>PATH</code> or <code>LOGICAL</code>.</p> </note>', 'CustomDirectoriesType$FailedFilesDirectory' => '<p>Specifies a location to store failed AS2 message files.</p>', 'CustomDirectoriesType$MdnFilesDirectory' => '<p>Specifies a location to store MDN files.</p>', 'CustomDirectoriesType$PayloadFilesDirectory' => '<p>Specifies a location to store the payload for AS2 message files.</p>', 'CustomDirectoriesType$StatusFilesDirectory' => '<p>Specifies a location to store AS2 status messages.</p>', 'CustomDirectoriesType$TemporaryFilesDirectory' => '<p>Specifies a location to store temporary AS2 message files.</p>', 'DescribedAccess$HomeDirectory' => '<p>The landing directory (folder) for a user when they log in to the server using the client.</p> <p>A <code>HomeDirectory</code> example is <code>/bucket_name/home/mydirectory</code>.</p> <note> <p>You can use the <code>HomeDirectory</code> parameter for <code>HomeDirectoryType</code> when it is set to either <code>PATH</code> or <code>LOGICAL</code>.</p> </note>', 'DescribedAgreement$BaseDirectory' => '<p>The landing directory (folder) for files that are transferred by using the AS2 protocol.</p>', 'DescribedUser$HomeDirectory' => '<p>The landing directory (folder) for a user when they log in to the server using the client.</p> <p>A <code>HomeDirectory</code> example is <code>/bucket_name/home/mydirectory</code>.</p> <note> <p>You can use the <code>HomeDirectory</code> parameter for <code>HomeDirectoryType</code> when it is set to either <code>PATH</code> or <code>LOGICAL</code>.</p> </note>', 'ListedAccess$HomeDirectory' => '<p>The landing directory (folder) for a user when they log in to the server using the client.</p> <p>A <code>HomeDirectory</code> example is <code>/bucket_name/home/mydirectory</code>.</p> <note> <p>You can use the <code>HomeDirectory</code> parameter for <code>HomeDirectoryType</code> when it is set to either <code>PATH</code> or <code>LOGICAL</code>.</p> </note>', 'ListedUser$HomeDirectory' => '<p>The landing directory (folder) for a user when they log in to the server using the client.</p> <p>A <code>HomeDirectory</code> example is <code>/bucket_name/home/mydirectory</code>.</p> <note> <p>You can use the <code>HomeDirectory</code> parameter for <code>HomeDirectoryType</code> when it is set to either <code>PATH</code> or <code>LOGICAL</code>.</p> </note>', 'UpdateAccessRequest$HomeDirectory' => '<p>The landing directory (folder) for a user when they log in to the server using the client.</p> <p>A <code>HomeDirectory</code> example is <code>/bucket_name/home/mydirectory</code>.</p> <note> <p>You can use the <code>HomeDirectory</code> parameter for <code>HomeDirectoryType</code> when it is set to either <code>PATH</code> or <code>LOGICAL</code>.</p> </note>', 'UpdateAgreementRequest$BaseDirectory' => '<p>To change the landing directory (folder) for files that are transferred, provide the bucket folder that you want to use; for example, <code>/<i>amzn-s3-demo-bucket</i>/<i>home</i>/<i>mydirectory</i> </code>.</p>', 'UpdateUserRequest$HomeDirectory' => '<p>The landing directory (folder) for a user when they log in to the server using the client.</p> <p>A <code>HomeDirectory</code> example is <code>/bucket_name/home/mydirectory</code>.</p> <note> <p>You can use the <code>HomeDirectory</code> parameter for <code>HomeDirectoryType</code> when it is set to either <code>PATH</code> or <code>LOGICAL</code>.</p> </note>', ], ], 'HomeDirectoryMapEntry' => [ 'base' => '<p>Represents an object that contains entries and targets for <code>HomeDirectoryMappings</code>.</p> <p>The following is an <code>Entry</code> and <code>Target</code> pair example for <code>chroot</code>.</p> <p> <code>[ { "Entry": "/", "Target": "/bucket_name/home/mydirectory" } ]</code> </p>', 'refs' => [ 'HomeDirectoryMappings$member' => NULL, ], ], 'HomeDirectoryMappings' => [ 'base' => NULL, 'refs' => [ 'CreateAccessRequest$HomeDirectoryMappings' => '<p>Logical directory mappings that specify what Amazon S3 or Amazon EFS paths and keys should be visible to your user and how you want to make them visible. You must specify the <code>Entry</code> and <code>Target</code> pair, where <code>Entry</code> shows how the path is made visible and <code>Target</code> is the actual Amazon S3 or Amazon EFS path. If you only specify a target, it is displayed as is. You also must ensure that your Identity and Access Management (IAM) role provides access to paths in <code>Target</code>. This value can be set only when <code>HomeDirectoryType</code> is set to <i>LOGICAL</i>.</p> <p>The following is an <code>Entry</code> and <code>Target</code> pair example.</p> <p> <code>[ { "Entry": "/directory1", "Target": "/bucket_name/home/mydirectory" } ]</code> </p> <p>In most cases, you can use this value instead of the session policy to lock down your user to the designated home directory ("<code>chroot</code>"). To do this, you can set <code>Entry</code> to <code>/</code> and set <code>Target</code> to the <code>HomeDirectory</code> parameter value.</p> <p>The following is an <code>Entry</code> and <code>Target</code> pair example for <code>chroot</code>.</p> <p> <code>[ { "Entry": "/", "Target": "/bucket_name/home/mydirectory" } ]</code> </p>', 'CreateUserRequest$HomeDirectoryMappings' => '<p>Logical directory mappings that specify what Amazon S3 or Amazon EFS paths and keys should be visible to your user and how you want to make them visible. You must specify the <code>Entry</code> and <code>Target</code> pair, where <code>Entry</code> shows how the path is made visible and <code>Target</code> is the actual Amazon S3 or Amazon EFS path. If you only specify a target, it is displayed as is. You also must ensure that your Identity and Access Management (IAM) role provides access to paths in <code>Target</code>. This value can be set only when <code>HomeDirectoryType</code> is set to <i>LOGICAL</i>.</p> <p>The following is an <code>Entry</code> and <code>Target</code> pair example.</p> <p> <code>[ { "Entry": "/directory1", "Target": "/bucket_name/home/mydirectory" } ]</code> </p> <p>In most cases, you can use this value instead of the session policy to lock your user down to the designated home directory ("<code>chroot</code>"). To do this, you can set <code>Entry</code> to <code>/</code> and set <code>Target</code> to the value the user should see for their home directory when they log in.</p> <p>The following is an <code>Entry</code> and <code>Target</code> pair example for <code>chroot</code>.</p> <p> <code>[ { "Entry": "/", "Target": "/bucket_name/home/mydirectory" } ]</code> </p>', 'DescribedAccess$HomeDirectoryMappings' => '<p>Logical directory mappings that specify what Amazon S3 or Amazon EFS paths and keys should be visible to your user and how you want to make them visible. You must specify the <code>Entry</code> and <code>Target</code> pair, where <code>Entry</code> shows how the path is made visible and <code>Target</code> is the actual Amazon S3 or Amazon EFS path. If you only specify a target, it is displayed as is. You also must ensure that your Identity and Access Management (IAM) role provides access to paths in <code>Target</code>. This value can be set only when <code>HomeDirectoryType</code> is set to <i>LOGICAL</i>.</p> <p>In most cases, you can use this value instead of the session policy to lock down the associated access to the designated home directory ("<code>chroot</code>"). To do this, you can set <code>Entry</code> to \'/\' and set <code>Target</code> to the <code>HomeDirectory</code> parameter value.</p>', 'DescribedUser$HomeDirectoryMappings' => '<p>Logical directory mappings that specify what Amazon S3 or Amazon EFS paths and keys should be visible to your user and how you want to make them visible. You must specify the <code>Entry</code> and <code>Target</code> pair, where <code>Entry</code> shows how the path is made visible and <code>Target</code> is the actual Amazon S3 or Amazon EFS path. If you only specify a target, it is displayed as is. You also must ensure that your Identity and Access Management (IAM) role provides access to paths in <code>Target</code>. This value can be set only when <code>HomeDirectoryType</code> is set to <i>LOGICAL</i>.</p> <p>In most cases, you can use this value instead of the session policy to lock your user down to the designated home directory ("<code>chroot</code>"). To do this, you can set <code>Entry</code> to \'/\' and set <code>Target</code> to the HomeDirectory parameter value.</p>', 'UpdateAccessRequest$HomeDirectoryMappings' => '<p>Logical directory mappings that specify what Amazon S3 or Amazon EFS paths and keys should be visible to your user and how you want to make them visible. You must specify the <code>Entry</code> and <code>Target</code> pair, where <code>Entry</code> shows how the path is made visible and <code>Target</code> is the actual Amazon S3 or Amazon EFS path. If you only specify a target, it is displayed as is. You also must ensure that your Identity and Access Management (IAM) role provides access to paths in <code>Target</code>. This value can be set only when <code>HomeDirectoryType</code> is set to <i>LOGICAL</i>.</p> <p>The following is an <code>Entry</code> and <code>Target</code> pair example.</p> <p> <code>[ { "Entry": "/directory1", "Target": "/bucket_name/home/mydirectory" } ]</code> </p> <p>In most cases, you can use this value instead of the session policy to lock down your user to the designated home directory ("<code>chroot</code>"). To do this, you can set <code>Entry</code> to <code>/</code> and set <code>Target</code> to the <code>HomeDirectory</code> parameter value.</p> <p>The following is an <code>Entry</code> and <code>Target</code> pair example for <code>chroot</code>.</p> <p> <code>[ { "Entry": "/", "Target": "/bucket_name/home/mydirectory" } ]</code> </p>', 'UpdateUserRequest$HomeDirectoryMappings' => '<p>Logical directory mappings that specify what Amazon S3 or Amazon EFS paths and keys should be visible to your user and how you want to make them visible. You must specify the <code>Entry</code> and <code>Target</code> pair, where <code>Entry</code> shows how the path is made visible and <code>Target</code> is the actual Amazon S3 or Amazon EFS path. If you only specify a target, it is displayed as is. You also must ensure that your Identity and Access Management (IAM) role provides access to paths in <code>Target</code>. This value can be set only when <code>HomeDirectoryType</code> is set to <i>LOGICAL</i>.</p> <p>The following is an <code>Entry</code> and <code>Target</code> pair example.</p> <p> <code>[ { "Entry": "/directory1", "Target": "/bucket_name/home/mydirectory" } ]</code> </p> <p>In most cases, you can use this value instead of the session policy to lock down your user to the designated home directory ("<code>chroot</code>"). To do this, you can set <code>Entry</code> to \'/\' and set <code>Target</code> to the HomeDirectory parameter value.</p> <p>The following is an <code>Entry</code> and <code>Target</code> pair example for <code>chroot</code>.</p> <p> <code>[ { "Entry": "/", "Target": "/bucket_name/home/mydirectory" } ]</code> </p>', ], ], 'HomeDirectoryType' => [ 'base' => NULL, 'refs' => [ 'CreateAccessRequest$HomeDirectoryType' => '<p>The type of landing directory (folder) that you want your users\' home directory to be when they log in to the server. If you set it to <code>PATH</code>, the user will see the absolute Amazon S3 bucket or Amazon EFS path as is in their file transfer protocol clients. If you set it to <code>LOGICAL</code>, you need to provide mappings in the <code>HomeDirectoryMappings</code> for how you want to make Amazon S3 or Amazon EFS paths visible to your users.</p> <note> <p>If <code>HomeDirectoryType</code> is <code>LOGICAL</code>, you must provide mappings, using the <code>HomeDirectoryMappings</code> parameter. If, on the other hand, <code>HomeDirectoryType</code> is <code>PATH</code>, you provide an absolute path using the <code>HomeDirectory</code> parameter. You cannot have both <code>HomeDirectory</code> and <code>HomeDirectoryMappings</code> in your template.</p> </note>', 'CreateUserRequest$HomeDirectoryType' => '<p>The type of landing directory (folder) that you want your users\' home directory to be when they log in to the server. If you set it to <code>PATH</code>, the user will see the absolute Amazon S3 bucket or Amazon EFS path as is in their file transfer protocol clients. If you set it to <code>LOGICAL</code>, you need to provide mappings in the <code>HomeDirectoryMappings</code> for how you want to make Amazon S3 or Amazon EFS paths visible to your users.</p> <note> <p>If <code>HomeDirectoryType</code> is <code>LOGICAL</code>, you must provide mappings, using the <code>HomeDirectoryMappings</code> parameter. If, on the other hand, <code>HomeDirectoryType</code> is <code>PATH</code>, you provide an absolute path using the <code>HomeDirectory</code> parameter. You cannot have both <code>HomeDirectory</code> and <code>HomeDirectoryMappings</code> in your template.</p> </note>', 'DescribedAccess$HomeDirectoryType' => '<p>The type of landing directory (folder) that you want your users\' home directory to be when they log in to the server. If you set it to <code>PATH</code>, the user will see the absolute Amazon S3 bucket or Amazon EFS path as is in their file transfer protocol clients. If you set it to <code>LOGICAL</code>, you need to provide mappings in the <code>HomeDirectoryMappings</code> for how you want to make Amazon S3 or Amazon EFS paths visible to your users.</p> <note> <p>If <code>HomeDirectoryType</code> is <code>LOGICAL</code>, you must provide mappings, using the <code>HomeDirectoryMappings</code> parameter. If, on the other hand, <code>HomeDirectoryType</code> is <code>PATH</code>, you provide an absolute path using the <code>HomeDirectory</code> parameter. You cannot have both <code>HomeDirectory</code> and <code>HomeDirectoryMappings</code> in your template.</p> </note>', 'DescribedUser$HomeDirectoryType' => '<p>The type of landing directory (folder) that you want your users\' home directory to be when they log in to the server. If you set it to <code>PATH</code>, the user will see the absolute Amazon S3 bucket or Amazon EFS path as is in their file transfer protocol clients. If you set it to <code>LOGICAL</code>, you need to provide mappings in the <code>HomeDirectoryMappings</code> for how you want to make Amazon S3 or Amazon EFS paths visible to your users.</p> <note> <p>If <code>HomeDirectoryType</code> is <code>LOGICAL</code>, you must provide mappings, using the <code>HomeDirectoryMappings</code> parameter. If, on the other hand, <code>HomeDirectoryType</code> is <code>PATH</code>, you provide an absolute path using the <code>HomeDirectory</code> parameter. You cannot have both <code>HomeDirectory</code> and <code>HomeDirectoryMappings</code> in your template.</p> </note>', 'ListedAccess$HomeDirectoryType' => '<p>The type of landing directory (folder) that you want your users\' home directory to be when they log in to the server. If you set it to <code>PATH</code>, the user will see the absolute Amazon S3 bucket or Amazon EFS path as is in their file transfer protocol clients. If you set it to <code>LOGICAL</code>, you need to provide mappings in the <code>HomeDirectoryMappings</code> for how you want to make Amazon S3 or Amazon EFS paths visible to your users.</p> <note> <p>If <code>HomeDirectoryType</code> is <code>LOGICAL</code>, you must provide mappings, using the <code>HomeDirectoryMappings</code> parameter. If, on the other hand, <code>HomeDirectoryType</code> is <code>PATH</code>, you provide an absolute path using the <code>HomeDirectory</code> parameter. You cannot have both <code>HomeDirectory</code> and <code>HomeDirectoryMappings</code> in your template.</p> </note>', 'ListedUser$HomeDirectoryType' => '<p>The type of landing directory (folder) that you want your users\' home directory to be when they log in to the server. If you set it to <code>PATH</code>, the user will see the absolute Amazon S3 bucket or Amazon EFS path as is in their file transfer protocol clients. If you set it to <code>LOGICAL</code>, you need to provide mappings in the <code>HomeDirectoryMappings</code> for how you want to make Amazon S3 or Amazon EFS paths visible to your users.</p> <note> <p>If <code>HomeDirectoryType</code> is <code>LOGICAL</code>, you must provide mappings, using the <code>HomeDirectoryMappings</code> parameter. If, on the other hand, <code>HomeDirectoryType</code> is <code>PATH</code>, you provide an absolute path using the <code>HomeDirectory</code> parameter. You cannot have both <code>HomeDirectory</code> and <code>HomeDirectoryMappings</code> in your template.</p> </note>', 'UpdateAccessRequest$HomeDirectoryType' => '<p>The type of landing directory (folder) that you want your users\' home directory to be when they log in to the server. If you set it to <code>PATH</code>, the user will see the absolute Amazon S3 bucket or Amazon EFS path as is in their file transfer protocol clients. If you set it to <code>LOGICAL</code>, you need to provide mappings in the <code>HomeDirectoryMappings</code> for how you want to make Amazon S3 or Amazon EFS paths visible to your users.</p> <note> <p>If <code>HomeDirectoryType</code> is <code>LOGICAL</code>, you must provide mappings, using the <code>HomeDirectoryMappings</code> parameter. If, on the other hand, <code>HomeDirectoryType</code> is <code>PATH</code>, you provide an absolute path using the <code>HomeDirectory</code> parameter. You cannot have both <code>HomeDirectory</code> and <code>HomeDirectoryMappings</code> in your template.</p> </note>', 'UpdateUserRequest$HomeDirectoryType' => '<p>The type of landing directory (folder) that you want your users\' home directory to be when they log in to the server. If you set it to <code>PATH</code>, the user will see the absolute Amazon S3 bucket or Amazon EFS path as is in their file transfer protocol clients. If you set it to <code>LOGICAL</code>, you need to provide mappings in the <code>HomeDirectoryMappings</code> for how you want to make Amazon S3 or Amazon EFS paths visible to your users.</p> <note> <p>If <code>HomeDirectoryType</code> is <code>LOGICAL</code>, you must provide mappings, using the <code>HomeDirectoryMappings</code> parameter. If, on the other hand, <code>HomeDirectoryType</code> is <code>PATH</code>, you provide an absolute path using the <code>HomeDirectory</code> parameter. You cannot have both <code>HomeDirectory</code> and <code>HomeDirectoryMappings</code> in your template.</p> </note>', ], ], 'HostKey' => [ 'base' => NULL, 'refs' => [ 'CreateServerRequest$HostKey' => '<p>The RSA, ECDSA, or ED25519 private key to use for your SFTP-enabled server. You can add multiple host keys, in case you want to rotate keys, or have a set of active keys that use different algorithms.</p> <p>Use the following command to generate an RSA 2048 bit key with no passphrase:</p> <p> <code>ssh-keygen -t rsa -b 2048 -N "" -m PEM -f my-new-server-key</code>.</p> <p>Use a minimum value of 2048 for the <code>-b</code> option. You can create a stronger key by using 3072 or 4096.</p> <p>Use the following command to generate an ECDSA 256 bit key with no passphrase:</p> <p> <code>ssh-keygen -t ecdsa -b 256 -N "" -m PEM -f my-new-server-key</code>.</p> <p>Valid values for the <code>-b</code> option for ECDSA are 256, 384, and 521.</p> <p>Use the following command to generate an ED25519 key with no passphrase:</p> <p> <code>ssh-keygen -t ed25519 -N "" -f my-new-server-key</code>.</p> <p>For all of these commands, you can replace <i>my-new-server-key</i> with a string of your choice.</p> <important> <p>If you aren\'t planning to migrate existing users from an existing SFTP-enabled server to a new server, don\'t update the host key. Accidentally changing a server\'s host key can be disruptive.</p> </important> <p>For more information, see <a href="https://docs.aws.amazon.com/transfer/latest/userguide/edit-server-config.html#configuring-servers-change-host-key">Manage host keys for your SFTP-enabled server</a> in the <i>Transfer Family User Guide</i>.</p>', 'ImportHostKeyRequest$HostKeyBody' => '<p>The private key portion of an SSH key pair.</p> <p>Transfer Family accepts RSA, ECDSA, and ED25519 keys.</p>', 'UpdateServerRequest$HostKey' => '<p>The RSA, ECDSA, or ED25519 private key to use for your SFTP-enabled server. You can add multiple host keys, in case you want to rotate keys, or have a set of active keys that use different algorithms.</p> <p>Use the following command to generate an RSA 2048 bit key with no passphrase:</p> <p> <code>ssh-keygen -t rsa -b 2048 -N "" -m PEM -f my-new-server-key</code>.</p> <p>Use a minimum value of 2048 for the <code>-b</code> option. You can create a stronger key by using 3072 or 4096.</p> <p>Use the following command to generate an ECDSA 256 bit key with no passphrase:</p> <p> <code>ssh-keygen -t ecdsa -b 256 -N "" -m PEM -f my-new-server-key</code>.</p> <p>Valid values for the <code>-b</code> option for ECDSA are 256, 384, and 521.</p> <p>Use the following command to generate an ED25519 key with no passphrase:</p> <p> <code>ssh-keygen -t ed25519 -N "" -f my-new-server-key</code>.</p> <p>For all of these commands, you can replace <i>my-new-server-key</i> with a string of your choice.</p> <important> <p>If you aren\'t planning to migrate existing users from an existing SFTP-enabled server to a new server, don\'t update the host key. Accidentally changing a server\'s host key can be disruptive.</p> </important> <p>For more information, see <a href="https://docs.aws.amazon.com/transfer/latest/userguide/edit-server-config.html#configuring-servers-change-host-key">Manage host keys for your SFTP-enabled server</a> in the <i>Transfer Family User Guide</i>.</p>', ], ], 'HostKeyDescription' => [ 'base' => NULL, 'refs' => [ 'DescribedHostKey$Description' => '<p>The text description for this host key.</p>', 'ImportHostKeyRequest$Description' => '<p>The text description that identifies this host key.</p>', 'ListedHostKey$Description' => '<p>The current description for the host key. You can change it by calling the <code>UpdateHostKey</code> operation and providing a new description.</p>', 'UpdateHostKeyRequest$Description' => '<p>An updated description for the host key.</p>', ], ], 'HostKeyFingerprint' => [ 'base' => NULL, 'refs' => [ 'DescribedHostKey$HostKeyFingerprint' => '<p>The public key fingerprint, which is a short sequence of bytes used to identify the longer public key.</p>', 'DescribedServer$HostKeyFingerprint' => '<p>Specifies the Base64-encoded SHA256 fingerprint of the server\'s host key. This value is equivalent to the output of the <code>ssh-keygen -l -f my-new-server-key</code> command.</p>', 'ListedHostKey$Fingerprint' => '<p>The public key fingerprint, which is a short sequence of bytes used to identify the longer public key.</p>', ], ], 'HostKeyId' => [ 'base' => NULL, 'refs' => [ 'DeleteHostKeyRequest$HostKeyId' => '<p>The identifier of the host key that you are deleting.</p>', 'DescribeHostKeyRequest$HostKeyId' => '<p>The identifier of the host key that you want described.</p>', 'DescribedHostKey$HostKeyId' => '<p>A unique identifier for the host key.</p>', 'ImportHostKeyResponse$HostKeyId' => '<p>Returns the host key identifier for the imported key.</p>', 'ListedHostKey$HostKeyId' => '<p>A unique identifier for the host key.</p>', 'UpdateHostKeyRequest$HostKeyId' => '<p>The identifier of the host key that you are updating.</p>', 'UpdateHostKeyResponse$HostKeyId' => '<p>Returns the host key identifier for the updated host key.</p>', ], ], 'HostKeyType' => [ 'base' => NULL, 'refs' => [ 'DescribedHostKey$Type' => '<p>The encryption algorithm that is used for the host key. The <code>Type</code> parameter is specified by using one of the following values:</p> <ul> <li> <p> <code>ssh-rsa</code> </p> </li> <li> <p> <code>ssh-ed25519</code> </p> </li> <li> <p> <code>ecdsa-sha2-nistp256</code> </p> </li> <li> <p> <code>ecdsa-sha2-nistp384</code> </p> </li> <li> <p> <code>ecdsa-sha2-nistp521</code> </p> </li> </ul>', 'ListedHostKey$Type' => '<p>The encryption algorithm that is used for the host key. The <code>Type</code> parameter is specified by using one of the following values:</p> <ul> <li> <p> <code>ssh-rsa</code> </p> </li> <li> <p> <code>ssh-ed25519</code> </p> </li> <li> <p> <code>ecdsa-sha2-nistp256</code> </p> </li> <li> <p> <code>ecdsa-sha2-nistp384</code> </p> </li> <li> <p> <code>ecdsa-sha2-nistp521</code> </p> </li> </ul>', ], ], 'IdentityCenterApplicationArn' => [ 'base' => NULL, 'refs' => [ 'DescribedIdentityCenterConfig$ApplicationArn' => '<p>The Amazon Resource Name (ARN) for the IAM Identity Center application: this value is set automatically when you create your web app.</p>', ], ], 'IdentityCenterConfig' => [ 'base' => '<p>A structure that describes the values to use for the IAM Identity Center settings when you create or update a web app.</p>', 'refs' => [ 'WebAppIdentityProviderDetails$IdentityCenterConfig' => '<p>A structure that describes the values to use for the IAM Identity Center settings when you create a web app.</p>', ], ], 'IdentityCenterInstanceArn' => [ 'base' => NULL, 'refs' => [ 'DescribedIdentityCenterConfig$InstanceArn' => '<p>The Amazon Resource Name (ARN) for the IAM Identity Center used for the web app.</p>', 'IdentityCenterConfig$InstanceArn' => '<p>The Amazon Resource Name (ARN) for the IAM Identity Center used for the web app.</p>', ], ], 'IdentityProviderDetails' => [ 'base' => '<p>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.</p>', 'refs' => [ 'CreateServerRequest$IdentityProviderDetails' => '<p>Required when <code>IdentityProviderType</code> is set to <code>AWS_DIRECTORY_SERVICE</code>, <code>Amazon Web Services_LAMBDA</code> or <code>API_GATEWAY</code>. Accepts an array containing all of the information required to use a directory in <code>AWS_DIRECTORY_SERVICE</code> or invoke a customer-supplied authentication API, including the API Gateway URL. Cannot be specified when <code>IdentityProviderType</code> is set to <code>SERVICE_MANAGED</code>.</p>', 'DescribedServer$IdentityProviderDetails' => '<p>Specifies information to call a customer-supplied authentication API. This field is not populated when the <code>IdentityProviderType</code> of a server is <code>AWS_DIRECTORY_SERVICE</code> or <code>SERVICE_MANAGED</code>.</p>', 'UpdateServerRequest$IdentityProviderDetails' => '<p>An array containing all of the information required to call a customer\'s authentication API method.</p>', ], ], 'IdentityProviderType' => [ 'base' => '<p>The mode of authentication for a server. The default value is <code>SERVICE_MANAGED</code>, which allows you to store and access user credentials within the Transfer Family service.</p> <p>Use <code>AWS_DIRECTORY_SERVICE</code> to provide access to Active Directory groups in Directory Service for Microsoft Active Directory or Microsoft Active Directory in your on-premises environment or in Amazon Web Services using AD Connector. This option also requires you to provide a Directory ID by using the <code>IdentityProviderDetails</code> parameter.</p> <p>Use the <code>API_GATEWAY</code> value to integrate with an identity provider of your choosing. The <code>API_GATEWAY</code> setting requires you to provide an Amazon API Gateway endpoint URL to call for authentication by using the <code>IdentityProviderDetails</code> parameter.</p> <p>Use the <code>AWS_LAMBDA</code> value to directly use an Lambda function as your identity provider. If you choose this value, you must specify the ARN for the Lambda function in the <code>Function</code> parameter for the <code>IdentityProviderDetails</code> data type.</p>', 'refs' => [ 'CreateServerRequest$IdentityProviderType' => '<p>The mode of authentication for a server. The default value is <code>SERVICE_MANAGED</code>, which allows you to store and access user credentials within the Transfer Family service.</p> <p>Use <code>AWS_DIRECTORY_SERVICE</code> to provide access to Active Directory groups in Directory Service for Microsoft Active Directory or Microsoft Active Directory in your on-premises environment or in Amazon Web Services using AD Connector. This option also requires you to provide a Directory ID by using the <code>IdentityProviderDetails</code> parameter.</p> <p>Use the <code>API_GATEWAY</code> value to integrate with an identity provider of your choosing. The <code>API_GATEWAY</code> setting requires you to provide an Amazon API Gateway endpoint URL to call for authentication by using the <code>IdentityProviderDetails</code> parameter.</p> <p>Use the <code>AWS_LAMBDA</code> value to directly use an Lambda function as your identity provider. If you choose this value, you must specify the ARN for the Lambda function in the <code>Function</code> parameter for the <code>IdentityProviderDetails</code> data type.</p>', 'DescribedServer$IdentityProviderType' => '<p>The mode of authentication for a server. The default value is <code>SERVICE_MANAGED</code>, which allows you to store and access user credentials within the Transfer Family service.</p> <p>Use <code>AWS_DIRECTORY_SERVICE</code> to provide access to Active Directory groups in Directory Service for Microsoft Active Directory or Microsoft Active Directory in your on-premises environment or in Amazon Web Services using AD Connector. This option also requires you to provide a Directory ID by using the <code>IdentityProviderDetails</code> parameter.</p> <p>Use the <code>API_GATEWAY</code> value to integrate with an identity provider of your choosing. The <code>API_GATEWAY</code> setting requires you to provide an Amazon API Gateway endpoint URL to call for authentication by using the <code>IdentityProviderDetails</code> parameter.</p> <p>Use the <code>AWS_LAMBDA</code> value to directly use an Lambda function as your identity provider. If you choose this value, you must specify the ARN for the Lambda function in the <code>Function</code> parameter for the <code>IdentityProviderDetails</code> data type.</p>', 'ListedServer$IdentityProviderType' => '<p>The mode of authentication for a server. The default value is <code>SERVICE_MANAGED</code>, which allows you to store and access user credentials within the Transfer Family service.</p> <p>Use <code>AWS_DIRECTORY_SERVICE</code> to provide access to Active Directory groups in Directory Service for Microsoft Active Directory or Microsoft Active Directory in your on-premises environment or in Amazon Web Services using AD Connector. This option also requires you to provide a Directory ID by using the <code>IdentityProviderDetails</code> parameter.</p> <p>Use the <code>API_GATEWAY</code> value to integrate with an identity provider of your choosing. The <code>API_GATEWAY</code> setting requires you to provide an Amazon API Gateway endpoint URL to call for authentication by using the <code>IdentityProviderDetails</code> parameter.</p> <p>Use the <code>AWS_LAMBDA</code> value to directly use an Lambda function as your identity provider. If you choose this value, you must specify the ARN for the Lambda function in the <code>Function</code> parameter for the <code>IdentityProviderDetails</code> data type.</p>', 'UpdateServerRequest$IdentityProviderType' => '<p>The mode of authentication for a server. The default value is <code>SERVICE_MANAGED</code>, which allows you to store and access user credentials within the Transfer Family service.</p> <p>Use <code>AWS_DIRECTORY_SERVICE</code> to provide access to Active Directory groups in Directory Service for Microsoft Active Directory or Microsoft Active Directory in your on-premises environment or in Amazon Web Services using AD Connector. This option also requires you to provide a Directory ID by using the <code>IdentityProviderDetails</code> parameter.</p> <p>Use the <code>API_GATEWAY</code> value to integrate with an identity provider of your choosing. The <code>API_GATEWAY</code> setting requires you to provide an Amazon API Gateway endpoint URL to call for authentication by using the <code>IdentityProviderDetails</code> parameter.</p> <p>Use the <code>AWS_LAMBDA</code> value to directly use an Lambda function as your identity provider. If you choose this value, you must specify the ARN for the Lambda function in the <code>Function</code> parameter for the <code>IdentityProviderDetails</code> data type.</p>', ], ], 'ImportCertificateRequest' => [ 'base' => NULL, 'refs' => [], ], 'ImportCertificateResponse' => [ 'base' => NULL, 'refs' => [], ], 'ImportHostKeyRequest' => [ 'base' => NULL, 'refs' => [], ], 'ImportHostKeyResponse' => [ 'base' => NULL, 'refs' => [], ], 'ImportSshPublicKeyRequest' => [ 'base' => NULL, 'refs' => [], ], 'ImportSshPublicKeyResponse' => [ 'base' => '<p>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.</p>', 'refs' => [], ], 'InputFileLocation' => [ 'base' => '<p>Specifies the location for the file that\'s being processed.</p>', 'refs' => [ 'CopyStepDetails$DestinationFileLocation' => '<p>Specifies the location for the file being copied. Use <code>${Transfer:UserName}</code> or <code>${Transfer:UploadDate}</code> in this field to parametrize the destination prefix by username or uploaded date.</p> <ul> <li> <p>Set the value of <code>DestinationFileLocation</code> to <code>${Transfer:UserName}</code> to copy uploaded files to an Amazon S3 bucket that is prefixed with the name of the Transfer Family user that uploaded the file.</p> </li> <li> <p>Set the value of <code>DestinationFileLocation</code> to <code>${Transfer:UploadDate}</code> to copy uploaded files to an Amazon S3 bucket that is prefixed with the date of the upload.</p> <note> <p>The system resolves <code>UploadDate</code> to a date format of <i>YYYY-MM-DD</i>, based on the date the file is uploaded in UTC.</p> </note> </li> </ul>', 'DecryptStepDetails$DestinationFileLocation' => '<p>Specifies the location for the file being decrypted. Use <code>${Transfer:UserName}</code> or <code>${Transfer:UploadDate}</code> in this field to parametrize the destination prefix by username or uploaded date.</p> <ul> <li> <p>Set the value of <code>DestinationFileLocation</code> to <code>${Transfer:UserName}</code> to decrypt uploaded files to an Amazon S3 bucket that is prefixed with the name of the Transfer Family user that uploaded the file.</p> </li> <li> <p>Set the value of <code>DestinationFileLocation</code> to <code>${Transfer:UploadDate}</code> to decrypt uploaded files to an Amazon S3 bucket that is prefixed with the date of the upload.</p> <note> <p>The system resolves <code>UploadDate</code> to a date format of <i>YYYY-MM-DD</i>, based on the date the file is uploaded in UTC.</p> </note> </li> </ul>', ], ], 'InternalServiceError' => [ 'base' => '<p>This exception is thrown when an error occurs in the Transfer Family service.</p>', 'refs' => [], ], 'InvalidNextTokenException' => [ 'base' => '<p>The <code>NextToken</code> parameter that was passed is invalid.</p>', 'refs' => [], ], 'InvalidRequestException' => [ 'base' => '<p>This exception is thrown when the client submits a malformed request.</p>', 'refs' => [], ], 'IpAddressType' => [ 'base' => NULL, 'refs' => [ 'CreateServerRequest$IpAddressType' => '<p>Specifies whether to use IPv4 only, or to use dual-stack (IPv4 and IPv6) for your Transfer Family endpoint. The default value is <code>IPV4</code>.</p> <important> <p>The <code>IpAddressType</code> parameter has the following limitations:</p> <ul> <li> <p>It cannot be changed while the server is online. You must stop the server before modifying this parameter.</p> </li> <li> <p>It cannot be updated to <code>DUALSTACK</code> if the server has <code>AddressAllocationIds</code> specified.</p> </li> </ul> </important> <note> <p>When using <code>DUALSTACK</code> as the <code>IpAddressType</code>, you cannot set the <code>AddressAllocationIds</code> parameter for the <a href="https://docs.aws.amazon.com/transfer/latest/APIReference/API_EndpointDetails.html">EndpointDetails</a> for the server.</p> </note>', 'DescribedServer$IpAddressType' => '<p>Specifies whether to use IPv4 only, or to use dual-stack (IPv4 and IPv6) for your Transfer Family endpoint. The default value is <code>IPV4</code>.</p> <important> <p>The <code>IpAddressType</code> parameter has the following limitations:</p> <ul> <li> <p>It cannot be changed while the server is online. You must stop the server before modifying this parameter.</p> </li> <li> <p>It cannot be updated to <code>DUALSTACK</code> if the server has <code>AddressAllocationIds</code> specified.</p> </li> </ul> </important> <note> <p>When using <code>DUALSTACK</code> as the <code>IpAddressType</code>, you cannot set the <code>AddressAllocationIds</code> parameter for the <a href="https://docs.aws.amazon.com/transfer/latest/APIReference/API_EndpointDetails.html">EndpointDetails</a> for the server.</p> </note>', 'UpdateServerRequest$IpAddressType' => '<p>Specifies whether to use IPv4 only, or to use dual-stack (IPv4 and IPv6) for your Transfer Family endpoint. The default value is <code>IPV4</code>.</p> <important> <p>The <code>IpAddressType</code> parameter has the following limitations:</p> <ul> <li> <p>It cannot be changed while the server is online. You must stop the server before modifying this parameter.</p> </li> <li> <p>It cannot be updated to <code>DUALSTACK</code> if the server has <code>AddressAllocationIds</code> specified.</p> </li> </ul> </important> <note> <p>When using <code>DUALSTACK</code> as the <code>IpAddressType</code>, you cannot set the <code>AddressAllocationIds</code> parameter for the <a href="https://docs.aws.amazon.com/transfer/latest/APIReference/API_EndpointDetails.html">EndpointDetails</a> for the server.</p> </note>', ], ], 'ListAccessesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListAccessesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListAgreementsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListAgreementsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListCertificatesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListCertificatesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListConnectorsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListConnectorsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListExecutionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListExecutionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListFileTransferResultsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListFileTransferResultsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListHostKeysRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListHostKeysResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListProfilesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListProfilesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListSecurityPoliciesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListSecurityPoliciesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListServersRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListServersResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListTagsForResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListTagsForResourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListUsersRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListUsersResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListWebAppsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListWebAppsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListWorkflowsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListWorkflowsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListedAccess' => [ 'base' => '<p>Lists the properties for one or more specified associated accesses.</p>', 'refs' => [ 'ListedAccesses$member' => NULL, ], ], 'ListedAccesses' => [ 'base' => NULL, 'refs' => [ 'ListAccessesResponse$Accesses' => '<p>Returns the accesses and their properties for the <code>ServerId</code> value that you specify.</p>', ], ], 'ListedAgreement' => [ 'base' => '<p>Describes the properties of an agreement.</p>', 'refs' => [ 'ListedAgreements$member' => NULL, ], ], 'ListedAgreements' => [ 'base' => NULL, 'refs' => [ 'ListAgreementsResponse$Agreements' => '<p>Returns an array, where each item contains the details of an agreement.</p>', ], ], 'ListedCertificate' => [ 'base' => '<p>Describes the properties of a certificate.</p>', 'refs' => [ 'ListedCertificates$member' => NULL, ], ], 'ListedCertificates' => [ 'base' => NULL, 'refs' => [ 'ListCertificatesResponse$Certificates' => '<p>Returns an array of the certificates that are specified in the <code>ListCertificates</code> call.</p>', ], ], 'ListedConnector' => [ 'base' => '<p>Returns details of the connector that is specified.</p>', 'refs' => [ 'ListedConnectors$member' => NULL, ], ], 'ListedConnectors' => [ 'base' => NULL, 'refs' => [ 'ListConnectorsResponse$Connectors' => '<p>Returns an array, where each item contains the details of a connector.</p>', ], ], 'ListedExecution' => [ 'base' => '<p>Returns properties of the execution that is specified.</p>', 'refs' => [ 'ListedExecutions$member' => NULL, ], ], 'ListedExecutions' => [ 'base' => NULL, 'refs' => [ 'ListExecutionsResponse$Executions' => '<p>Returns the details for each execution, in a <code>ListedExecution</code> array.</p>', ], ], 'ListedHostKey' => [ 'base' => '<p>Returns properties of the host key that\'s specified.</p>', 'refs' => [ 'ListedHostKeys$member' => NULL, ], ], 'ListedHostKeys' => [ 'base' => NULL, 'refs' => [ 'ListHostKeysResponse$HostKeys' => '<p>Returns an array, where each item contains the details of a host key.</p>', ], ], 'ListedProfile' => [ 'base' => '<p>Returns the properties of the profile that was specified.</p>', 'refs' => [ 'ListedProfiles$member' => NULL, ], ], 'ListedProfiles' => [ 'base' => NULL, 'refs' => [ 'ListProfilesResponse$Profiles' => '<p>Returns an array, where each item contains the details of a profile.</p>', ], ], 'ListedServer' => [ 'base' => '<p>Returns properties of a file transfer protocol-enabled server that was specified.</p>', 'refs' => [ 'ListedServers$member' => NULL, ], ], 'ListedServers' => [ 'base' => NULL, 'refs' => [ 'ListServersResponse$Servers' => '<p>An array of servers that were listed.</p>', ], ], 'ListedUser' => [ 'base' => '<p>Returns properties of the user that you specify.</p>', 'refs' => [ 'ListedUsers$member' => NULL, ], ], 'ListedUsers' => [ 'base' => NULL, 'refs' => [ 'ListUsersResponse$Users' => '<p>Returns the Transfer Family users and their properties for the <code>ServerId</code> value that you specify.</p>', ], ], 'ListedWebApp' => [ 'base' => '<p> a structure that contains details for the web app.</p>', 'refs' => [ 'ListedWebApps$member' => NULL, ], ], 'ListedWebApps' => [ 'base' => NULL, 'refs' => [ 'ListWebAppsResponse$WebApps' => '<p>Returns, for each listed web app, a structure that contains details for the web app.</p>', ], ], 'ListedWorkflow' => [ 'base' => '<p>Contains the identifier, text description, and Amazon Resource Name (ARN) for the workflow.</p>', 'refs' => [ 'ListedWorkflows$member' => NULL, ], ], 'ListedWorkflows' => [ 'base' => NULL, 'refs' => [ 'ListWorkflowsResponse$Workflows' => '<p>Returns the <code>Arn</code>, <code>WorkflowId</code>, and <code>Description</code> for each workflow.</p>', ], ], 'ListingId' => [ 'base' => NULL, 'refs' => [ 'StartDirectoryListingResponse$ListingId' => '<p>Returns a unique identifier for the directory listing call.</p>', ], ], 'LogGroupName' => [ 'base' => NULL, 'refs' => [ 'LoggingConfiguration$LogGroupName' => '<p>The name of the CloudWatch logging group for the Transfer Family server to which this workflow belongs.</p>', ], ], 'LoggingConfiguration' => [ 'base' => '<p>Consists of the logging role and the log group name.</p>', 'refs' => [ 'DescribedExecution$LoggingConfiguration' => '<p>The IAM logging role associated with the execution.</p>', ], ], 'MapEntry' => [ 'base' => NULL, 'refs' => [ 'HomeDirectoryMapEntry$Entry' => '<p>Represents an entry for <code>HomeDirectoryMappings</code>.</p>', ], ], 'MapTarget' => [ 'base' => NULL, 'refs' => [ 'HomeDirectoryMapEntry$Target' => '<p>Represents the map target that is used in a <code>HomeDirectoryMapEntry</code>.</p>', ], ], 'MapType' => [ 'base' => NULL, 'refs' => [ 'HomeDirectoryMapEntry$Type' => '<p>Specifies the type of mapping. Set the type to <code>FILE</code> if you want the mapping to point to a file, or <code>DIRECTORY</code> for the directory to point to a directory.</p> <note> <p>By default, home directory mappings have a <code>Type</code> of <code>DIRECTORY</code> when you create a Transfer Family server. You would need to explicitly set <code>Type</code> to <code>FILE</code> if you want a mapping to have a file target.</p> </note>', ], ], 'MaxConcurrentConnections' => [ 'base' => '<p>The number of concurrent connections that the connector will create to the remote server.</p>', 'refs' => [ 'SftpConnectorConfig$MaxConcurrentConnections' => '<p>Specify the number of concurrent connections that your connector creates to the remote server. The default value is <code>1</code>. The maximum values is <code>5</code>.</p> <note> <p>If you are using the Amazon Web Services Management Console, the default value is <code>5</code>.</p> </note> <p>This parameter specifies the number of active connections that your connector can establish with the remote server at the same time. Increasing this value can enhance connector performance when transferring large file batches by enabling parallel operations.</p>', ], ], 'MaxItems' => [ 'base' => NULL, 'refs' => [ 'StartDirectoryListingRequest$MaxItems' => '<p>An optional parameter where you can specify the maximum number of file/directory names to retrieve. The default value is 1,000.</p>', ], ], 'MaxResults' => [ 'base' => NULL, 'refs' => [ 'ListAccessesRequest$MaxResults' => '<p>The maximum number of items to return.</p>', 'ListAgreementsRequest$MaxResults' => '<p>The maximum number of items to return.</p>', 'ListCertificatesRequest$MaxResults' => '<p>The maximum number of items to return.</p>', 'ListConnectorsRequest$MaxResults' => '<p>The maximum number of items to return.</p>', 'ListExecutionsRequest$MaxResults' => '<p>The maximum number of items to return.</p>', 'ListFileTransferResultsRequest$MaxResults' => '<p>The maximum number of files to return in a single page. Note that currently you can specify a maximum of 10 file paths in a single <a href="https://docs.aws.amazon.com/transfer/latest/APIReference/API_StartFileTransfer.html">StartFileTransfer</a> operation. Thus, the maximum number of file transfer results that can be returned in a single page is 10. </p>', 'ListHostKeysRequest$MaxResults' => '<p>The maximum number of items to return.</p>', 'ListProfilesRequest$MaxResults' => '<p>The maximum number of items to return.</p>', 'ListSecurityPoliciesRequest$MaxResults' => '<p>Specifies the number of security policies to return as a response to the <code>ListSecurityPolicies</code> query.</p>', 'ListServersRequest$MaxResults' => '<p>Specifies the number of servers to return as a response to the <code>ListServers</code> query.</p>', 'ListTagsForResourceRequest$MaxResults' => '<p>Specifies the number of tags to return as a response to the <code>ListTagsForResource</code> request.</p>', 'ListUsersRequest$MaxResults' => '<p>Specifies the number of users to return as a response to the <code>ListUsers</code> request.</p>', 'ListWebAppsRequest$MaxResults' => '<p>The maximum number of items to return.</p>', 'ListWorkflowsRequest$MaxResults' => '<p>The maximum number of items to return.</p>', ], ], 'MdnResponse' => [ 'base' => NULL, 'refs' => [ 'As2ConnectorConfig$MdnResponse' => '<p>Used for outbound requests (from an Transfer Family connector to a partner AS2 server) to determine whether the partner response for transfers is synchronous or asynchronous. Specify either of the following values:</p> <ul> <li> <p> <code>SYNC</code>: The system expects a synchronous MDN response, confirming that the file was transferred successfully (or not).</p> </li> <li> <p> <code>NONE</code>: Specifies that no MDN response is required.</p> </li> </ul>', ], ], 'MdnSigningAlg' => [ 'base' => NULL, 'refs' => [ 'As2ConnectorConfig$MdnSigningAlgorithm' => '<p>The signing algorithm for the MDN response.</p> <note> <p>If set to DEFAULT (or not set at all), the value for <code>SigningAlgorithm</code> is used.</p> </note>', ], ], 'Message' => [ 'base' => NULL, 'refs' => [ 'ConflictException$Message' => NULL, 'ConnectorFileTransferResult$FailureMessage' => '<p>For transfers that fail, this parameter describes the reason for the failure.</p>', 'InternalServiceError$Message' => NULL, 'InvalidNextTokenException$Message' => NULL, 'InvalidRequestException$Message' => NULL, 'ResourceExistsException$Message' => NULL, 'ResourceNotFoundException$Message' => NULL, 'TestConnectionResponse$StatusMessage' => '<p>Returns <code>Connection succeeded</code> if the test is successful. Or, returns a descriptive error message if the test fails. The following list provides troubleshooting details, depending on the error message that you receive.</p> <ul> <li> <p>Verify that your secret name aligns with the one in Transfer Role permissions.</p> </li> <li> <p>Verify the server URL in the connector configuration , and verify that the login credentials work successfully outside of the connector.</p> </li> <li> <p>Verify that the secret exists and is formatted correctly.</p> </li> <li> <p>Verify that the trusted host key in the connector configuration matches the <code>ssh-keyscan</code> output.</p> </li> </ul>', 'TestIdentityProviderResponse$Message' => '<p>A message that indicates whether the test was successful or not.</p> <note> <p>If an empty string is returned, the most likely cause is that the authentication failed due to an incorrect username or password.</p> </note>', ], ], 'MessageSubject' => [ 'base' => NULL, 'refs' => [ 'As2ConnectorConfig$MessageSubject' => '<p>Used as the <code>Subject</code> HTTP header attribute in AS2 messages that are being sent with the connector.</p>', ], ], 'MoveId' => [ 'base' => NULL, 'refs' => [ 'StartRemoteMoveResponse$MoveId' => '<p>Returns a unique identifier for the move/rename operation.</p>', ], ], 'NextToken' => [ 'base' => NULL, 'refs' => [ 'ListAccessesRequest$NextToken' => '<p>When you can get additional results from the <code>ListAccesses</code> call, a <code>NextToken</code> parameter is returned in the output. You can then pass in a subsequent command to the <code>NextToken</code> parameter to continue listing additional accesses.</p>', 'ListAccessesResponse$NextToken' => '<p>When you can get additional results from the <code>ListAccesses</code> call, a <code>NextToken</code> parameter is returned in the output. You can then pass in a subsequent command to the <code>NextToken</code> parameter to continue listing additional accesses.</p>', 'ListAgreementsRequest$NextToken' => '<p>When you can get additional results from the <code>ListAgreements</code> call, a <code>NextToken</code> parameter is returned in the output. You can then pass in a subsequent command to the <code>NextToken</code> parameter to continue listing additional agreements.</p>', 'ListAgreementsResponse$NextToken' => '<p>Returns a token that you can use to call <code>ListAgreements</code> again and receive additional results, if there are any.</p>', 'ListCertificatesRequest$NextToken' => '<p>When you can get additional results from the <code>ListCertificates</code> call, a <code>NextToken</code> parameter is returned in the output. You can then pass in a subsequent command to the <code>NextToken</code> parameter to continue listing additional certificates.</p>', 'ListCertificatesResponse$NextToken' => '<p>Returns the next token, which you can use to list the next certificate.</p>', 'ListConnectorsRequest$NextToken' => '<p>When you can get additional results from the <code>ListConnectors</code> call, a <code>NextToken</code> parameter is returned in the output. You can then pass in a subsequent command to the <code>NextToken</code> parameter to continue listing additional connectors.</p>', 'ListConnectorsResponse$NextToken' => '<p>Returns a token that you can use to call <code>ListConnectors</code> again and receive additional results, if there are any.</p>', 'ListExecutionsRequest$NextToken' => '<p> <code>ListExecutions</code> returns the <code>NextToken</code> parameter in the output. You can then pass the <code>NextToken</code> parameter in a subsequent command to continue listing additional executions.</p> <p> This is useful for pagination, for instance. If you have 100 executions for a workflow, you might only want to list first 10. If so, call the API by specifying the <code>max-results</code>: </p> <p> <code>aws transfer list-executions --max-results 10</code> </p> <p> This returns details for the first 10 executions, as well as the pointer (<code>NextToken</code>) to the eleventh execution. You can now call the API again, supplying the <code>NextToken</code> value you received: </p> <p> <code>aws transfer list-executions --max-results 10 --next-token $somePointerReturnedFromPreviousListResult</code> </p> <p> This call returns the next 10 executions, the 11th through the 20th. You can then repeat the call until the details for all 100 executions have been returned. </p>', 'ListExecutionsResponse$NextToken' => '<p> <code>ListExecutions</code> returns the <code>NextToken</code> parameter in the output. You can then pass the <code>NextToken</code> parameter in a subsequent command to continue listing additional executions.</p>', 'ListFileTransferResultsRequest$NextToken' => '<p>If there are more file details than returned in this call, use this value for a subsequent call to <code>ListFileTransferResults</code> to retrieve them.</p>', 'ListFileTransferResultsResponse$NextToken' => '<p>Returns a token that you can use to call <code>ListFileTransferResults</code> again and receive additional results, if there are any (against the same <code>TransferId</code>.</p>', 'ListHostKeysRequest$NextToken' => '<p>When there are additional results that were not returned, a <code>NextToken</code> parameter is returned. You can use that value for a subsequent call to <code>ListHostKeys</code> to continue listing results.</p>', 'ListHostKeysResponse$NextToken' => '<p>Returns a token that you can use to call <code>ListHostKeys</code> again and receive additional results, if there are any.</p>', 'ListProfilesRequest$NextToken' => '<p>When there are additional results that were not returned, a <code>NextToken</code> parameter is returned. You can use that value for a subsequent call to <code>ListProfiles</code> to continue listing results.</p>', 'ListProfilesResponse$NextToken' => '<p>Returns a token that you can use to call <code>ListProfiles</code> again and receive additional results, if there are any.</p>', 'ListSecurityPoliciesRequest$NextToken' => '<p>When additional results are obtained from the <code>ListSecurityPolicies</code> command, a <code>NextToken</code> parameter is returned in the output. You can then pass the <code>NextToken</code> parameter in a subsequent command to continue listing additional security policies.</p>', 'ListSecurityPoliciesResponse$NextToken' => '<p>When you can get additional results from the <code>ListSecurityPolicies</code> operation, a <code>NextToken</code> parameter is returned in the output. In a following command, you can pass in the <code>NextToken</code> parameter to continue listing security policies.</p>', 'ListServersRequest$NextToken' => '<p>When additional results are obtained from the <code>ListServers</code> command, a <code>NextToken</code> parameter is returned in the output. You can then pass the <code>NextToken</code> parameter in a subsequent command to continue listing additional servers.</p>', 'ListServersResponse$NextToken' => '<p>When you can get additional results from the <code>ListServers</code> operation, a <code>NextToken</code> parameter is returned in the output. In a following command, you can pass in the <code>NextToken</code> parameter to continue listing additional servers.</p>', 'ListTagsForResourceRequest$NextToken' => '<p>When you request additional results from the <code>ListTagsForResource</code> operation, a <code>NextToken</code> parameter is returned in the input. You can then pass in a subsequent command to the <code>NextToken</code> parameter to continue listing additional tags.</p>', 'ListTagsForResourceResponse$NextToken' => '<p>When you can get additional results from the <code>ListTagsForResource</code> call, a <code>NextToken</code> parameter is returned in the output. You can then pass in a subsequent command to the <code>NextToken</code> parameter to continue listing additional tags.</p>', 'ListUsersRequest$NextToken' => '<p>If there are additional results from the <code>ListUsers</code> call, a <code>NextToken</code> parameter is returned in the output. You can then pass the <code>NextToken</code> to a subsequent <code>ListUsers</code> command, to continue listing additional users.</p>', 'ListUsersResponse$NextToken' => '<p>When you can get additional results from the <code>ListUsers</code> call, a <code>NextToken</code> parameter is returned in the output. You can then pass in a subsequent command to the <code>NextToken</code> parameter to continue listing additional users.</p>', 'ListWebAppsRequest$NextToken' => '<p>Returns the <code>NextToken</code> parameter in the output. You can then pass the <code>NextToken</code> parameter in a subsequent command to continue listing additional web apps.</p>', 'ListWebAppsResponse$NextToken' => '<p>Provide this value for the <code>NextToken</code> parameter in a subsequent command to continue listing additional web apps.</p>', 'ListWorkflowsRequest$NextToken' => '<p> <code>ListWorkflows</code> returns the <code>NextToken</code> parameter in the output. You can then pass the <code>NextToken</code> parameter in a subsequent command to continue listing additional workflows.</p>', 'ListWorkflowsResponse$NextToken' => '<p> <code>ListWorkflows</code> returns the <code>NextToken</code> parameter in the output. You can then pass the <code>NextToken</code> parameter in a subsequent command to continue listing additional workflows.</p>', ], ], 'NullableRole' => [ 'base' => NULL, 'refs' => [ 'CreateServerRequest$LoggingRole' => '<p>The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that allows a server to turn on Amazon CloudWatch logging for Amazon S3 or Amazon EFS events. When set, you can view user activity in your CloudWatch logs.</p>', 'DescribedServer$LoggingRole' => '<p>The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that allows a server to turn on Amazon CloudWatch logging for Amazon S3 or Amazon EFS events. When set, you can view user activity in your CloudWatch logs.</p>', 'UpdateServerRequest$LoggingRole' => '<p>The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that allows a server to turn on Amazon CloudWatch logging for Amazon S3 or Amazon EFS events. When set, you can view user activity in your CloudWatch logs.</p>', ], ], 'OnPartialUploadWorkflowDetails' => [ 'base' => NULL, 'refs' => [ 'WorkflowDetails$OnPartialUpload' => '<p>A trigger that starts a workflow if a file is only partially uploaded. You can attach a workflow to a server that executes whenever there is a partial upload.</p> <p>A <i>partial upload</i> occurs when a file is open when the session disconnects.</p> <note> <p> <code>OnPartialUpload</code> can contain a maximum of one <code>WorkflowDetail</code> object.</p> </note>', ], ], 'OnUploadWorkflowDetails' => [ 'base' => NULL, 'refs' => [ 'WorkflowDetails$OnUpload' => '<p>A trigger that starts a workflow: the workflow begins to execute after a file is uploaded.</p> <p>To remove an associated workflow from a server, you can provide an empty <code>OnUpload</code> object, as in the following example.</p> <p> <code>aws transfer update-server --server-id s-01234567890abcdef --workflow-details \'{"OnUpload":[]}\'</code> </p> <note> <p> <code>OnUpload</code> can contain a maximum of one <code>WorkflowDetail</code> object.</p> </note>', ], ], 'OutputFileName' => [ 'base' => NULL, 'refs' => [ 'StartDirectoryListingResponse$OutputFileName' => '<p>Returns the file name where the results are stored. This is a combination of the connector ID and the listing ID: <code>&lt;connector-id&gt;-&lt;listing-id&gt;.json</code>.</p>', ], ], 'OverwriteExisting' => [ 'base' => NULL, 'refs' => [ 'CopyStepDetails$OverwriteExisting' => '<p>A flag that indicates whether to overwrite an existing file of the same name. The default is <code>FALSE</code>.</p> <p>If the workflow is processing a file that has the same name as an existing file, the behavior is as follows:</p> <ul> <li> <p>If <code>OverwriteExisting</code> is <code>TRUE</code>, the existing file is replaced with the file being processed.</p> </li> <li> <p>If <code>OverwriteExisting</code> is <code>FALSE</code>, nothing happens, and the workflow processing stops.</p> </li> </ul>', 'DecryptStepDetails$OverwriteExisting' => '<p>A flag that indicates whether to overwrite an existing file of the same name. The default is <code>FALSE</code>.</p> <p>If the workflow is processing a file that has the same name as an existing file, the behavior is as follows:</p> <ul> <li> <p>If <code>OverwriteExisting</code> is <code>TRUE</code>, the existing file is replaced with the file being processed.</p> </li> <li> <p>If <code>OverwriteExisting</code> is <code>FALSE</code>, nothing happens, and the workflow processing stops.</p> </li> </ul>', ], ], 'PassiveIp' => [ 'base' => NULL, 'refs' => [ 'ProtocolDetails$PassiveIp' => '<p> Indicates passive mode, for FTP and FTPS protocols. Enter a single IPv4 address, such as the public IP address of a firewall, router, or load balancer. For example: </p> <p> <code>aws transfer update-server --protocol-details PassiveIp=0.0.0.0</code> </p> <p>Replace <code>0.0.0.0</code> in the example above with the actual IP address you want to use.</p> <note> <p> If you change the <code>PassiveIp</code> value, you must stop and then restart your Transfer Family server for the change to take effect. For details on using passive mode (PASV) in a NAT environment, see <a href="http://aws.amazon.com/blogs/storage/configuring-your-ftps-server-behind-a-firewall-or-nat-with-aws-transfer-family/">Configuring your FTPS server behind a firewall or NAT with Transfer Family</a>. </p> </note> <p> <i>Special values</i> </p> <p>The <code>AUTO</code> and <code>0.0.0.0</code> are special values for the <code>PassiveIp</code> parameter. The value <code>PassiveIp=AUTO</code> is assigned by default to FTP and FTPS type servers. In this case, the server automatically responds with one of the endpoint IPs within the PASV response. <code>PassiveIp=0.0.0.0</code> has a more unique application for its usage. For example, if you have a High Availability (HA) Network Load Balancer (NLB) environment, where you have 3 subnets, you can only specify a single IP address using the <code>PassiveIp</code> parameter. This reduces the effectiveness of having High Availability. In this case, you can specify <code>PassiveIp=0.0.0.0</code>. This tells the client to use the same IP address as the Control connection and utilize all AZs for their connections. Note, however, that not all FTP clients support the <code>PassiveIp=0.0.0.0</code> response. FileZilla and WinSCP do support it. If you are using other clients, check to see if your client supports the <code>PassiveIp=0.0.0.0</code> response.</p>', ], ], 'Policy' => [ 'base' => NULL, 'refs' => [ 'CreateAccessRequest$Policy' => '<p>A session policy for your user so that you can use the same Identity and Access Management (IAM) role across multiple users. This policy scopes down a user\'s access to portions of their Amazon S3 bucket. Variables that you can use inside this policy include <code>${Transfer:UserName}</code>, <code>${Transfer:HomeDirectory}</code>, and <code>${Transfer:HomeBucket}</code>.</p> <note> <p>This policy applies only when the domain of <code>ServerId</code> is Amazon S3. Amazon EFS does not use session policies.</p> <p>For session policies, Transfer Family stores the policy as a JSON blob, instead of the Amazon Resource Name (ARN) of the policy. You save the policy as a JSON blob and pass it in the <code>Policy</code> argument.</p> <p>For an example of a session policy, see <a href="https://docs.aws.amazon.com/transfer/latest/userguide/session-policy.html">Example session policy</a>.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html">AssumeRole</a> in the <i>Security Token Service API Reference</i>.</p> </note>', 'CreateUserRequest$Policy' => '<p>A session policy for your user so that you can use the same Identity and Access Management (IAM) role across multiple users. This policy scopes down a user\'s access to portions of their Amazon S3 bucket. Variables that you can use inside this policy include <code>${Transfer:UserName}</code>, <code>${Transfer:HomeDirectory}</code>, and <code>${Transfer:HomeBucket}</code>.</p> <note> <p>This policy applies only when the domain of <code>ServerId</code> is Amazon S3. Amazon EFS does not use session policies.</p> <p>For session policies, Transfer Family stores the policy as a JSON blob, instead of the Amazon Resource Name (ARN) of the policy. You save the policy as a JSON blob and pass it in the <code>Policy</code> argument.</p> <p>For an example of a session policy, see <a href="https://docs.aws.amazon.com/transfer/latest/userguide/session-policy.html">Example session policy</a>.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html">AssumeRole</a> in the <i>Amazon Web Services Security Token Service API Reference</i>.</p> </note>', 'DescribedAccess$Policy' => '<p>A session policy for your user so that you can use the same Identity and Access Management (IAM) role across multiple users. This policy scopes down a user\'s access to portions of their Amazon S3 bucket. Variables that you can use inside this policy include <code>${Transfer:UserName}</code>, <code>${Transfer:HomeDirectory}</code>, and <code>${Transfer:HomeBucket}</code>.</p>', 'DescribedUser$Policy' => '<p>A session policy for your user so that you can use the same Identity and Access Management (IAM) role across multiple users. This policy scopes down a user\'s access to portions of their Amazon S3 bucket. Variables that you can use inside this policy include <code>${Transfer:UserName}</code>, <code>${Transfer:HomeDirectory}</code>, and <code>${Transfer:HomeBucket}</code>.</p>', 'UpdateAccessRequest$Policy' => '<p>A session policy for your user so that you can use the same Identity and Access Management (IAM) role across multiple users. This policy scopes down a user\'s access to portions of their Amazon S3 bucket. Variables that you can use inside this policy include <code>${Transfer:UserName}</code>, <code>${Transfer:HomeDirectory}</code>, and <code>${Transfer:HomeBucket}</code>.</p> <note> <p>This policy applies only when the domain of <code>ServerId</code> is Amazon S3. Amazon EFS does not use session policies.</p> <p>For session policies, Transfer Family stores the policy as a JSON blob, instead of the Amazon Resource Name (ARN) of the policy. You save the policy as a JSON blob and pass it in the <code>Policy</code> argument.</p> <p>For an example of a session policy, see <a href="https://docs.aws.amazon.com/transfer/latest/userguide/session-policy.html">Example session policy</a>.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html">AssumeRole</a> in the <i>Amazon Web ServicesSecurity Token Service API Reference</i>.</p> </note>', 'UpdateUserRequest$Policy' => '<p>A session policy for your user so that you can use the same Identity and Access Management (IAM) role across multiple users. This policy scopes down a user\'s access to portions of their Amazon S3 bucket. Variables that you can use inside this policy include <code>${Transfer:UserName}</code>, <code>${Transfer:HomeDirectory}</code>, and <code>${Transfer:HomeBucket}</code>.</p> <note> <p>This policy applies only when the domain of <code>ServerId</code> is Amazon S3. Amazon EFS does not use session policies.</p> <p>For session policies, Transfer Family stores the policy as a JSON blob, instead of the Amazon Resource Name (ARN) of the policy. You save the policy as a JSON blob and pass it in the <code>Policy</code> argument.</p> <p>For an example of a session policy, see <a href="https://docs.aws.amazon.com/transfer/latest/userguide/session-policy">Creating a session policy</a>.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html">AssumeRole</a> in the <i>Amazon Web Services Security Token Service API Reference</i>.</p> </note>', ], ], 'PosixId' => [ 'base' => NULL, 'refs' => [ 'PosixProfile$Uid' => '<p>The POSIX user ID used for all EFS operations by this user.</p>', 'PosixProfile$Gid' => '<p>The POSIX group ID used for all EFS operations by this user.</p>', 'SecondaryGids$member' => NULL, ], ], 'PosixProfile' => [ 'base' => '<p>The full POSIX identity, including user ID (<code>Uid</code>), group ID (<code>Gid</code>), and any secondary groups IDs (<code>SecondaryGids</code>), 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.</p>', 'refs' => [ 'CreateAccessRequest$PosixProfile' => NULL, 'CreateUserRequest$PosixProfile' => '<p>Specifies the full POSIX identity, including user ID (<code>Uid</code>), group ID (<code>Gid</code>), and any secondary groups IDs (<code>SecondaryGids</code>), that controls your users\' access to your Amazon EFS file systems. The POSIX permissions that are set on files and directories in Amazon EFS determine the level of access your users get when transferring files into and out of your Amazon EFS file systems.</p>', 'DescribedAccess$PosixProfile' => NULL, 'DescribedExecution$PosixProfile' => NULL, 'DescribedUser$PosixProfile' => '<p>Specifies the full POSIX identity, including user ID (<code>Uid</code>), group ID (<code>Gid</code>), and any secondary groups IDs (<code>SecondaryGids</code>), that controls your users\' access to your Amazon Elastic File System (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.</p>', 'UpdateAccessRequest$PosixProfile' => NULL, 'UpdateUserRequest$PosixProfile' => '<p>Specifies the full POSIX identity, including user ID (<code>Uid</code>), group ID (<code>Gid</code>), and any secondary groups IDs (<code>SecondaryGids</code>), that controls your users\' access to your Amazon Elastic File Systems (Amazon EFS). The POSIX permissions that are set on files and directories in your file system determines the level of access your users get when transferring files into and out of your Amazon EFS file systems.</p>', ], ], 'PostAuthenticationLoginBanner' => [ 'base' => NULL, 'refs' => [ 'CreateServerRequest$PostAuthenticationLoginBanner' => '<p>Specifies a string to display when users connect to a server. This string is displayed after the user authenticates.</p> <note> <p>The SFTP protocol does not support post-authentication display banners.</p> </note>', 'DescribedServer$PostAuthenticationLoginBanner' => '<p>Specifies a string to display when users connect to a server. This string is displayed after the user authenticates.</p> <note> <p>The SFTP protocol does not support post-authentication display banners.</p> </note>', 'UpdateServerRequest$PostAuthenticationLoginBanner' => '<p>Specifies a string to display when users connect to a server. This string is displayed after the user authenticates.</p> <note> <p>The SFTP protocol does not support post-authentication display banners.</p> </note>', ], ], 'PreAuthenticationLoginBanner' => [ 'base' => NULL, 'refs' => [ 'CreateServerRequest$PreAuthenticationLoginBanner' => '<p>Specifies a string to display when users connect to a server. This string is displayed before the user authenticates. For example, the following banner displays details about using the system:</p> <p> <code>This system is for the use of authorized users only. Individuals using this computer system without authority, or in excess of their authority, are subject to having all of their activities on this system monitored and recorded by system personnel.</code> </p>', 'DescribedServer$PreAuthenticationLoginBanner' => '<p>Specifies a string to display when users connect to a server. This string is displayed before the user authenticates. For example, the following banner displays details about using the system:</p> <p> <code>This system is for the use of authorized users only. Individuals using this computer system without authority, or in excess of their authority, are subject to having all of their activities on this system monitored and recorded by system personnel.</code> </p>', 'UpdateServerRequest$PreAuthenticationLoginBanner' => '<p>Specifies a string to display when users connect to a server. This string is displayed before the user authenticates. For example, the following banner displays details about using the system:</p> <p> <code>This system is for the use of authorized users only. Individuals using this computer system without authority, or in excess of their authority, are subject to having all of their activities on this system monitored and recorded by system personnel.</code> </p>', ], ], 'PreserveContentType' => [ 'base' => NULL, 'refs' => [ 'As2ConnectorConfig$PreserveContentType' => '<p>Allows you to use the Amazon S3 <code>Content-Type</code> that is associated with objects in S3 instead of having the content type mapped based on the file extension. This parameter is enabled by default when you create an AS2 connector from the console, but disabled by default when you create an AS2 connector by calling the API directly.</p>', ], ], 'PreserveFilenameType' => [ 'base' => NULL, 'refs' => [ 'CreateAgreementRequest$PreserveFilename' => '<p> Determines whether or not Transfer Family appends a unique string of characters to the end of the AS2 message payload filename when saving it. </p> <ul> <li> <p> <code>ENABLED</code>: the filename provided by your trading parter is preserved when the file is saved.</p> </li> <li> <p> <code>DISABLED</code> (default value): when Transfer Family saves the file, the filename is adjusted, as described in <a href="https://docs.aws.amazon.com/transfer/latest/userguide/send-as2-messages.html#file-names-as2">File names and locations</a>.</p> </li> </ul>', 'DescribedAgreement$PreserveFilename' => '<p> Determines whether or not Transfer Family appends a unique string of characters to the end of the AS2 message payload filename when saving it. </p> <ul> <li> <p> <code>ENABLED</code>: the filename provided by your trading parter is preserved when the file is saved.</p> </li> <li> <p> <code>DISABLED</code> (default value): when Transfer Family saves the file, the filename is adjusted, as described in <a href="https://docs.aws.amazon.com/transfer/latest/userguide/send-as2-messages.html#file-names-as2">File names and locations</a>.</p> </li> </ul>', 'UpdateAgreementRequest$PreserveFilename' => '<p> Determines whether or not Transfer Family appends a unique string of characters to the end of the AS2 message payload filename when saving it. </p> <ul> <li> <p> <code>ENABLED</code>: the filename provided by your trading parter is preserved when the file is saved.</p> </li> <li> <p> <code>DISABLED</code> (default value): when Transfer Family saves the file, the filename is adjusted, as described in <a href="https://docs.aws.amazon.com/transfer/latest/userguide/send-as2-messages.html#file-names-as2">File names and locations</a>.</p> </li> </ul>', ], ], 'PrivateKeyType' => [ 'base' => NULL, 'refs' => [ 'ImportCertificateRequest$PrivateKey' => '<ul> <li> <p>For the CLI, provide a file path for a private key in URI format. For example, <code>--private-key file://encryption-key.pem</code>. Alternatively, you can provide the raw content of the private key file.</p> </li> <li> <p>For the SDK, specify the raw content of a private key file. For example, <code>--private-key "`cat encryption-key.pem`"</code> </p> </li> </ul>', ], ], 'ProfileId' => [ 'base' => NULL, 'refs' => [ 'As2ConnectorConfig$LocalProfileId' => '<p>A unique identifier for the AS2 local profile.</p>', 'As2ConnectorConfig$PartnerProfileId' => '<p>A unique identifier for the partner profile for the connector.</p>', 'CreateAgreementRequest$LocalProfileId' => '<p>A unique identifier for the AS2 local profile.</p>', 'CreateAgreementRequest$PartnerProfileId' => '<p>A unique identifier for the partner profile used in the agreement.</p>', 'CreateProfileResponse$ProfileId' => '<p>The unique identifier for the AS2 profile, returned after the API call succeeds.</p>', 'DeleteProfileRequest$ProfileId' => '<p>The identifier of the profile that you are deleting.</p>', 'DescribeProfileRequest$ProfileId' => '<p>The identifier of the profile that you want described.</p>', 'DescribedAgreement$LocalProfileId' => '<p>A unique identifier for the AS2 local profile.</p>', 'DescribedAgreement$PartnerProfileId' => '<p>A unique identifier for the partner profile used in the agreement.</p>', 'DescribedProfile$ProfileId' => '<p>A unique identifier for the local or partner AS2 profile.</p>', 'ListedAgreement$LocalProfileId' => '<p>A unique identifier for the AS2 local profile.</p>', 'ListedAgreement$PartnerProfileId' => '<p>A unique identifier for the partner profile.</p>', 'ListedProfile$ProfileId' => '<p>A unique identifier for the local or partner AS2 profile.</p>', 'UpdateAgreementRequest$LocalProfileId' => '<p>A unique identifier for the AS2 local profile.</p> <p>To change the local profile identifier, provide a new value here.</p>', 'UpdateAgreementRequest$PartnerProfileId' => '<p>A unique identifier for the partner profile. To change the partner profile identifier, provide a new value here.</p>', 'UpdateProfileRequest$ProfileId' => '<p>The identifier of the profile object that you are updating.</p>', 'UpdateProfileResponse$ProfileId' => '<p>Returns the identifier for the profile that\'s being updated.</p>', ], ], 'ProfileType' => [ 'base' => NULL, 'refs' => [ 'CreateProfileRequest$ProfileType' => '<p>Determines the type of profile to create:</p> <ul> <li> <p>Specify <code>LOCAL</code> to create a local profile. A local profile represents the AS2-enabled Transfer Family server organization or party.</p> </li> <li> <p>Specify <code>PARTNER</code> to create a partner profile. A partner profile represents a remote organization, external to Transfer Family.</p> </li> </ul>', 'DescribedProfile$ProfileType' => '<p>Indicates whether to list only <code>LOCAL</code> type profiles or only <code>PARTNER</code> type profiles. If not supplied in the request, the command lists all types of profiles.</p>', 'ListProfilesRequest$ProfileType' => '<p>Indicates whether to list only <code>LOCAL</code> type profiles or only <code>PARTNER</code> type profiles. If not supplied in the request, the command lists all types of profiles.</p>', 'ListedProfile$ProfileType' => '<p>Indicates whether to list only <code>LOCAL</code> type profiles or only <code>PARTNER</code> type profiles. If not supplied in the request, the command lists all types of profiles.</p>', ], ], 'Protocol' => [ 'base' => NULL, 'refs' => [ 'Protocols$member' => NULL, 'TestIdentityProviderRequest$ServerProtocol' => '<p>The type of file transfer protocol to be tested.</p> <p>The available protocols are:</p> <ul> <li> <p>Secure Shell (SSH) File Transfer Protocol (SFTP)</p> </li> <li> <p>File Transfer Protocol Secure (FTPS)</p> </li> <li> <p>File Transfer Protocol (FTP)</p> </li> <li> <p>Applicability Statement 2 (AS2)</p> </li> </ul>', ], ], 'ProtocolDetails' => [ 'base' => '<p> The protocol settings that are configured for your server. </p>', 'refs' => [ 'CreateServerRequest$ProtocolDetails' => '<p>The protocol settings that are configured for your server.</p> <ul> <li> <p> To indicate passive mode (for FTP and FTPS protocols), use the <code>PassiveIp</code> parameter. Enter a single dotted-quad IPv4 address, such as the external IP address of a firewall, router, or load balancer. </p> </li> <li> <p>To ignore the error that is generated when the client attempts to use the <code>SETSTAT</code> command on a file that you are uploading to an Amazon S3 bucket, use the <code>SetStatOption</code> parameter. To have the Transfer Family server ignore the <code>SETSTAT</code> command and upload files without needing to make any changes to your SFTP client, set the value to <code>ENABLE_NO_OP</code>. If you set the <code>SetStatOption</code> parameter to <code>ENABLE_NO_OP</code>, Transfer Family generates a log entry to Amazon CloudWatch Logs, so that you can determine when the client is making a <code>SETSTAT</code> call.</p> </li> <li> <p>To determine whether your Transfer Family server resumes recent, negotiated sessions through a unique session ID, use the <code>TlsSessionResumptionMode</code> parameter.</p> </li> <li> <p> <code>As2Transports</code> indicates the transport method for the AS2 messages. Currently, only HTTP is supported.</p> </li> </ul>', 'DescribedServer$ProtocolDetails' => '<p>The protocol settings that are configured for your server.</p> <ul> <li> <p> To indicate passive mode (for FTP and FTPS protocols), use the <code>PassiveIp</code> parameter. Enter a single dotted-quad IPv4 address, such as the external IP address of a firewall, router, or load balancer. </p> </li> <li> <p>To ignore the error that is generated when the client attempts to use the <code>SETSTAT</code> command on a file that you are uploading to an Amazon S3 bucket, use the <code>SetStatOption</code> parameter. To have the Transfer Family server ignore the <code>SETSTAT</code> command and upload files without needing to make any changes to your SFTP client, set the value to <code>ENABLE_NO_OP</code>. If you set the <code>SetStatOption</code> parameter to <code>ENABLE_NO_OP</code>, Transfer Family generates a log entry to Amazon CloudWatch Logs, so that you can determine when the client is making a <code>SETSTAT</code> call.</p> </li> <li> <p>To determine whether your Transfer Family server resumes recent, negotiated sessions through a unique session ID, use the <code>TlsSessionResumptionMode</code> parameter.</p> </li> <li> <p> <code>As2Transports</code> indicates the transport method for the AS2 messages. Currently, only HTTP is supported.</p> </li> </ul>', 'UpdateServerRequest$ProtocolDetails' => '<p>The protocol settings that are configured for your server.</p> <ul> <li> <p> To indicate passive mode (for FTP and FTPS protocols), use the <code>PassiveIp</code> parameter. Enter a single dotted-quad IPv4 address, such as the external IP address of a firewall, router, or load balancer. </p> </li> <li> <p>To ignore the error that is generated when the client attempts to use the <code>SETSTAT</code> command on a file that you are uploading to an Amazon S3 bucket, use the <code>SetStatOption</code> parameter. To have the Transfer Family server ignore the <code>SETSTAT</code> command and upload files without needing to make any changes to your SFTP client, set the value to <code>ENABLE_NO_OP</code>. If you set the <code>SetStatOption</code> parameter to <code>ENABLE_NO_OP</code>, Transfer Family generates a log entry to Amazon CloudWatch Logs, so that you can determine when the client is making a <code>SETSTAT</code> call.</p> </li> <li> <p>To determine whether your Transfer Family server resumes recent, negotiated sessions through a unique session ID, use the <code>TlsSessionResumptionMode</code> parameter.</p> </li> <li> <p> <code>As2Transports</code> indicates the transport method for the AS2 messages. Currently, only HTTP is supported.</p> </li> </ul>', ], ], 'Protocols' => [ 'base' => NULL, 'refs' => [ 'CreateServerRequest$Protocols' => '<p>Specifies the file transfer protocol or protocols over which your file transfer protocol client can connect to your server\'s endpoint. The available protocols are:</p> <ul> <li> <p> <code>SFTP</code> (Secure Shell (SSH) File Transfer Protocol): File transfer over SSH</p> </li> <li> <p> <code>FTPS</code> (File Transfer Protocol Secure): File transfer with TLS encryption</p> </li> <li> <p> <code>FTP</code> (File Transfer Protocol): Unencrypted file transfer</p> </li> <li> <p> <code>AS2</code> (Applicability Statement 2): used for transporting structured business-to-business data</p> </li> </ul> <note> <ul> <li> <p>If you select <code>FTPS</code>, you must choose a certificate stored in Certificate Manager (ACM) which is used to identify your server when clients connect to it over FTPS.</p> </li> <li> <p>If <code>Protocol</code> includes either <code>FTP</code> or <code>FTPS</code>, then the <code>EndpointType</code> must be <code>VPC</code> and the <code>IdentityProviderType</code> must be either <code>AWS_DIRECTORY_SERVICE</code>, <code>AWS_LAMBDA</code>, or <code>API_GATEWAY</code>.</p> </li> <li> <p>If <code>Protocol</code> includes <code>FTP</code>, then <code>AddressAllocationIds</code> cannot be associated.</p> </li> <li> <p>If <code>Protocol</code> is set only to <code>SFTP</code>, the <code>EndpointType</code> can be set to <code>PUBLIC</code> and the <code>IdentityProviderType</code> can be set any of the supported identity types: <code>SERVICE_MANAGED</code>, <code>AWS_DIRECTORY_SERVICE</code>, <code>AWS_LAMBDA</code>, or <code>API_GATEWAY</code>.</p> </li> <li> <p>If <code>Protocol</code> includes <code>AS2</code>, then the <code>EndpointType</code> must be <code>VPC</code>, and domain must be Amazon S3.</p> </li> </ul> </note>', 'DescribedServer$Protocols' => '<p>Specifies the file transfer protocol or protocols over which your file transfer protocol client can connect to your server\'s endpoint. The available protocols are:</p> <ul> <li> <p> <code>SFTP</code> (Secure Shell (SSH) File Transfer Protocol): File transfer over SSH</p> </li> <li> <p> <code>FTPS</code> (File Transfer Protocol Secure): File transfer with TLS encryption</p> </li> <li> <p> <code>FTP</code> (File Transfer Protocol): Unencrypted file transfer</p> </li> <li> <p> <code>AS2</code> (Applicability Statement 2): used for transporting structured business-to-business data</p> </li> </ul> <note> <ul> <li> <p>If you select <code>FTPS</code>, you must choose a certificate stored in Certificate Manager (ACM) which is used to identify your server when clients connect to it over FTPS.</p> </li> <li> <p>If <code>Protocol</code> includes either <code>FTP</code> or <code>FTPS</code>, then the <code>EndpointType</code> must be <code>VPC</code> and the <code>IdentityProviderType</code> must be either <code>AWS_DIRECTORY_SERVICE</code>, <code>AWS_LAMBDA</code>, or <code>API_GATEWAY</code>.</p> </li> <li> <p>If <code>Protocol</code> includes <code>FTP</code>, then <code>AddressAllocationIds</code> cannot be associated.</p> </li> <li> <p>If <code>Protocol</code> is set only to <code>SFTP</code>, the <code>EndpointType</code> can be set to <code>PUBLIC</code> and the <code>IdentityProviderType</code> can be set any of the supported identity types: <code>SERVICE_MANAGED</code>, <code>AWS_DIRECTORY_SERVICE</code>, <code>AWS_LAMBDA</code>, or <code>API_GATEWAY</code>.</p> </li> <li> <p>If <code>Protocol</code> includes <code>AS2</code>, then the <code>EndpointType</code> must be <code>VPC</code>, and domain must be Amazon S3.</p> </li> </ul> </note>', 'UpdateServerRequest$Protocols' => '<p>Specifies the file transfer protocol or protocols over which your file transfer protocol client can connect to your server\'s endpoint. The available protocols are:</p> <ul> <li> <p> <code>SFTP</code> (Secure Shell (SSH) File Transfer Protocol): File transfer over SSH</p> </li> <li> <p> <code>FTPS</code> (File Transfer Protocol Secure): File transfer with TLS encryption</p> </li> <li> <p> <code>FTP</code> (File Transfer Protocol): Unencrypted file transfer</p> </li> <li> <p> <code>AS2</code> (Applicability Statement 2): used for transporting structured business-to-business data</p> </li> </ul> <note> <ul> <li> <p>If you select <code>FTPS</code>, you must choose a certificate stored in Certificate Manager (ACM) which is used to identify your server when clients connect to it over FTPS.</p> </li> <li> <p>If <code>Protocol</code> includes either <code>FTP</code> or <code>FTPS</code>, then the <code>EndpointType</code> must be <code>VPC</code> and the <code>IdentityProviderType</code> must be either <code>AWS_DIRECTORY_SERVICE</code>, <code>AWS_LAMBDA</code>, or <code>API_GATEWAY</code>.</p> </li> <li> <p>If <code>Protocol</code> includes <code>FTP</code>, then <code>AddressAllocationIds</code> cannot be associated.</p> </li> <li> <p>If <code>Protocol</code> is set only to <code>SFTP</code>, the <code>EndpointType</code> can be set to <code>PUBLIC</code> and the <code>IdentityProviderType</code> can be set any of the supported identity types: <code>SERVICE_MANAGED</code>, <code>AWS_DIRECTORY_SERVICE</code>, <code>AWS_LAMBDA</code>, or <code>API_GATEWAY</code>.</p> </li> <li> <p>If <code>Protocol</code> includes <code>AS2</code>, then the <code>EndpointType</code> must be <code>VPC</code>, and domain must be Amazon S3.</p> </li> </ul> </note>', ], ], 'Resource' => [ 'base' => NULL, 'refs' => [ 'ResourceExistsException$Resource' => NULL, 'ResourceNotFoundException$Resource' => NULL, ], ], 'ResourceExistsException' => [ 'base' => '<p>The requested resource does not exist, or exists in a region other than the one specified for the command.</p>', 'refs' => [], ], 'ResourceNotFoundException' => [ 'base' => '<p>This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.</p>', 'refs' => [], ], 'ResourceType' => [ 'base' => NULL, 'refs' => [ 'ResourceExistsException$ResourceType' => NULL, 'ResourceNotFoundException$ResourceType' => NULL, ], ], 'Response' => [ 'base' => NULL, 'refs' => [ 'TestIdentityProviderResponse$Response' => '<p>The response that is returned from your API Gateway or your Lambda function.</p>', ], ], 'RetryAfterSeconds' => [ 'base' => NULL, 'refs' => [ 'ThrottlingException$RetryAfterSeconds' => NULL, ], ], 'Role' => [ 'base' => NULL, 'refs' => [ 'CreateAccessRequest$Role' => '<p>The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that controls your users\' access to your Amazon S3 bucket or Amazon EFS file system. The policies attached to this role determine the level of access that you want to provide your users when transferring files into and out of your Amazon S3 bucket or Amazon EFS file system. The IAM role should also contain a trust relationship that allows the server to access your resources when servicing your users\' transfer requests.</p>', 'CreateAgreementRequest$AccessRole' => '<p>Connectors are used to send files using either the AS2 or SFTP protocol. For the access role, provide the Amazon Resource Name (ARN) of the Identity and Access Management role to use.</p> <p> <b>For AS2 connectors</b> </p> <p>With AS2, you can send files by calling <code>StartFileTransfer</code> and specifying the file paths in the request parameter, <code>SendFilePaths</code>. We use the file’s parent directory (for example, for <code>--send-file-paths /bucket/dir/file.txt</code>, parent directory is <code>/bucket/dir/</code>) to temporarily store a processed AS2 message file, store the MDN when we receive them from the partner, and write a final JSON file containing relevant metadata of the transmission. So, the <code>AccessRole</code> needs to provide read and write access to the parent directory of the file location used in the <code>StartFileTransfer</code> request. Additionally, you need to provide read and write access to the parent directory of the files that you intend to send with <code>StartFileTransfer</code>.</p> <p>If you are using Basic authentication for your AS2 connector, the access role requires the <code>secretsmanager:GetSecretValue</code> permission for the secret. If the secret is encrypted using a customer-managed key instead of the Amazon Web Services managed key in Secrets Manager, then the role also needs the <code>kms:Decrypt</code> permission for that key.</p> <p> <b>For SFTP connectors</b> </p> <p>Make sure that the access role provides read and write access to the parent directory of the file location that\'s used in the <code>StartFileTransfer</code> request. Additionally, make sure that the role provides <code>secretsmanager:GetSecretValue</code> permission to Secrets Manager.</p>', 'CreateConnectorRequest$AccessRole' => '<p>Connectors are used to send files using either the AS2 or SFTP protocol. For the access role, provide the Amazon Resource Name (ARN) of the Identity and Access Management role to use.</p> <p> <b>For AS2 connectors</b> </p> <p>With AS2, you can send files by calling <code>StartFileTransfer</code> and specifying the file paths in the request parameter, <code>SendFilePaths</code>. We use the file’s parent directory (for example, for <code>--send-file-paths /bucket/dir/file.txt</code>, parent directory is <code>/bucket/dir/</code>) to temporarily store a processed AS2 message file, store the MDN when we receive them from the partner, and write a final JSON file containing relevant metadata of the transmission. So, the <code>AccessRole</code> needs to provide read and write access to the parent directory of the file location used in the <code>StartFileTransfer</code> request. Additionally, you need to provide read and write access to the parent directory of the files that you intend to send with <code>StartFileTransfer</code>.</p> <p>If you are using Basic authentication for your AS2 connector, the access role requires the <code>secretsmanager:GetSecretValue</code> permission for the secret. If the secret is encrypted using a customer-managed key instead of the Amazon Web Services managed key in Secrets Manager, then the role also needs the <code>kms:Decrypt</code> permission for that key.</p> <p> <b>For SFTP connectors</b> </p> <p>Make sure that the access role provides read and write access to the parent directory of the file location that\'s used in the <code>StartFileTransfer</code> request. Additionally, make sure that the role provides <code>secretsmanager:GetSecretValue</code> permission to Secrets Manager.</p>', 'CreateConnectorRequest$LoggingRole' => '<p>The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that allows a connector to turn on CloudWatch logging for Amazon S3 events. When set, you can view connector activity in your CloudWatch logs.</p>', 'CreateUserRequest$Role' => '<p>The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that controls your users\' access to your Amazon S3 bucket or Amazon EFS file system. The policies attached to this role determine the level of access that you want to provide your users when transferring files into and out of your Amazon S3 bucket or Amazon EFS file system. The IAM role should also contain a trust relationship that allows the server to access your resources when servicing your users\' transfer requests.</p>', 'DescribedAccess$Role' => '<p>The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that controls your users\' access to your Amazon S3 bucket or Amazon EFS file system. The policies attached to this role determine the level of access that you want to provide your users when transferring files into and out of your Amazon S3 bucket or Amazon EFS file system. The IAM role should also contain a trust relationship that allows the server to access your resources when servicing your users\' transfer requests.</p>', 'DescribedAgreement$AccessRole' => '<p>Connectors are used to send files using either the AS2 or SFTP protocol. For the access role, provide the Amazon Resource Name (ARN) of the Identity and Access Management role to use.</p> <p> <b>For AS2 connectors</b> </p> <p>With AS2, you can send files by calling <code>StartFileTransfer</code> and specifying the file paths in the request parameter, <code>SendFilePaths</code>. We use the file’s parent directory (for example, for <code>--send-file-paths /bucket/dir/file.txt</code>, parent directory is <code>/bucket/dir/</code>) to temporarily store a processed AS2 message file, store the MDN when we receive them from the partner, and write a final JSON file containing relevant metadata of the transmission. So, the <code>AccessRole</code> needs to provide read and write access to the parent directory of the file location used in the <code>StartFileTransfer</code> request. Additionally, you need to provide read and write access to the parent directory of the files that you intend to send with <code>StartFileTransfer</code>.</p> <p>If you are using Basic authentication for your AS2 connector, the access role requires the <code>secretsmanager:GetSecretValue</code> permission for the secret. If the secret is encrypted using a customer-managed key instead of the Amazon Web Services managed key in Secrets Manager, then the role also needs the <code>kms:Decrypt</code> permission for that key.</p> <p> <b>For SFTP connectors</b> </p> <p>Make sure that the access role provides read and write access to the parent directory of the file location that\'s used in the <code>StartFileTransfer</code> request. Additionally, make sure that the role provides <code>secretsmanager:GetSecretValue</code> permission to Secrets Manager.</p>', 'DescribedConnector$AccessRole' => '<p>Connectors are used to send files using either the AS2 or SFTP protocol. For the access role, provide the Amazon Resource Name (ARN) of the Identity and Access Management role to use.</p> <p> <b>For AS2 connectors</b> </p> <p>With AS2, you can send files by calling <code>StartFileTransfer</code> and specifying the file paths in the request parameter, <code>SendFilePaths</code>. We use the file’s parent directory (for example, for <code>--send-file-paths /bucket/dir/file.txt</code>, parent directory is <code>/bucket/dir/</code>) to temporarily store a processed AS2 message file, store the MDN when we receive them from the partner, and write a final JSON file containing relevant metadata of the transmission. So, the <code>AccessRole</code> needs to provide read and write access to the parent directory of the file location used in the <code>StartFileTransfer</code> request. Additionally, you need to provide read and write access to the parent directory of the files that you intend to send with <code>StartFileTransfer</code>.</p> <p>If you are using Basic authentication for your AS2 connector, the access role requires the <code>secretsmanager:GetSecretValue</code> permission for the secret. If the secret is encrypted using a customer-managed key instead of the Amazon Web Services managed key in Secrets Manager, then the role also needs the <code>kms:Decrypt</code> permission for that key.</p> <p> <b>For SFTP connectors</b> </p> <p>Make sure that the access role provides read and write access to the parent directory of the file location that\'s used in the <code>StartFileTransfer</code> request. Additionally, make sure that the role provides <code>secretsmanager:GetSecretValue</code> permission to Secrets Manager.</p>', 'DescribedConnector$LoggingRole' => '<p>The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that allows a connector to turn on CloudWatch logging for Amazon S3 events. When set, you can view connector activity in your CloudWatch logs.</p>', 'DescribedExecution$ExecutionRole' => '<p>The IAM role associated with the execution.</p>', 'DescribedIdentityCenterConfig$Role' => '<p>The IAM role in IAM Identity Center used for the web app.</p>', 'DescribedUser$Role' => '<p>The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that controls your users\' access to your Amazon S3 bucket or Amazon EFS file system. The policies attached to this role determine the level of access that you want to provide your users when transferring files into and out of your Amazon S3 bucket or Amazon EFS file system. The IAM role should also contain a trust relationship that allows the server to access your resources when servicing your users\' transfer requests.</p>', 'IdentityCenterConfig$Role' => '<p>The IAM role in IAM Identity Center used for the web app.</p>', 'IdentityProviderDetails$InvocationRole' => '<p>This parameter is only applicable if your <code>IdentityProviderType</code> is <code>API_GATEWAY</code>. Provides the type of <code>InvocationRole</code> used to authenticate the user account.</p>', 'ListedAccess$Role' => '<p>The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that controls your users\' access to your Amazon S3 bucket or Amazon EFS file system. The policies attached to this role determine the level of access that you want to provide your users when transferring files into and out of your Amazon S3 bucket or Amazon EFS file system. The IAM role should also contain a trust relationship that allows the server to access your resources when servicing your users\' transfer requests.</p>', 'ListedServer$LoggingRole' => '<p>The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that allows a server to turn on Amazon CloudWatch logging for Amazon S3 or Amazon EFS events. When set, you can view user activity in your CloudWatch logs.</p>', 'ListedUser$Role' => '<p>The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that controls your users\' access to your Amazon S3 bucket or Amazon EFS file system. The policies attached to this role determine the level of access that you want to provide your users when transferring files into and out of your Amazon S3 bucket or Amazon EFS file system. The IAM role should also contain a trust relationship that allows the server to access your resources when servicing your users\' transfer requests.</p> <note> <p>The IAM role that controls your users\' access to your Amazon S3 bucket for servers with <code>Domain=S3</code>, or your EFS file system for servers with <code>Domain=EFS</code>. </p> <p>The policies attached to this role determine the level of access you want to provide your users when transferring files into and out of your S3 buckets or EFS file systems.</p> </note>', 'LoggingConfiguration$LoggingRole' => '<p>The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that allows a server to turn on Amazon CloudWatch logging for Amazon S3 or Amazon EFS events. When set, you can view user activity in your CloudWatch logs.</p>', 'UpdateAccessRequest$Role' => '<p>The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that controls your users\' access to your Amazon S3 bucket or Amazon EFS file system. The policies attached to this role determine the level of access that you want to provide your users when transferring files into and out of your Amazon S3 bucket or Amazon EFS file system. The IAM role should also contain a trust relationship that allows the server to access your resources when servicing your users\' transfer requests.</p>', 'UpdateAgreementRequest$AccessRole' => '<p>Connectors are used to send files using either the AS2 or SFTP protocol. For the access role, provide the Amazon Resource Name (ARN) of the Identity and Access Management role to use.</p> <p> <b>For AS2 connectors</b> </p> <p>With AS2, you can send files by calling <code>StartFileTransfer</code> and specifying the file paths in the request parameter, <code>SendFilePaths</code>. We use the file’s parent directory (for example, for <code>--send-file-paths /bucket/dir/file.txt</code>, parent directory is <code>/bucket/dir/</code>) to temporarily store a processed AS2 message file, store the MDN when we receive them from the partner, and write a final JSON file containing relevant metadata of the transmission. So, the <code>AccessRole</code> needs to provide read and write access to the parent directory of the file location used in the <code>StartFileTransfer</code> request. Additionally, you need to provide read and write access to the parent directory of the files that you intend to send with <code>StartFileTransfer</code>.</p> <p>If you are using Basic authentication for your AS2 connector, the access role requires the <code>secretsmanager:GetSecretValue</code> permission for the secret. If the secret is encrypted using a customer-managed key instead of the Amazon Web Services managed key in Secrets Manager, then the role also needs the <code>kms:Decrypt</code> permission for that key.</p> <p> <b>For SFTP connectors</b> </p> <p>Make sure that the access role provides read and write access to the parent directory of the file location that\'s used in the <code>StartFileTransfer</code> request. Additionally, make sure that the role provides <code>secretsmanager:GetSecretValue</code> permission to Secrets Manager.</p>', 'UpdateConnectorRequest$AccessRole' => '<p>Connectors are used to send files using either the AS2 or SFTP protocol. For the access role, provide the Amazon Resource Name (ARN) of the Identity and Access Management role to use.</p> <p> <b>For AS2 connectors</b> </p> <p>With AS2, you can send files by calling <code>StartFileTransfer</code> and specifying the file paths in the request parameter, <code>SendFilePaths</code>. We use the file’s parent directory (for example, for <code>--send-file-paths /bucket/dir/file.txt</code>, parent directory is <code>/bucket/dir/</code>) to temporarily store a processed AS2 message file, store the MDN when we receive them from the partner, and write a final JSON file containing relevant metadata of the transmission. So, the <code>AccessRole</code> needs to provide read and write access to the parent directory of the file location used in the <code>StartFileTransfer</code> request. Additionally, you need to provide read and write access to the parent directory of the files that you intend to send with <code>StartFileTransfer</code>.</p> <p>If you are using Basic authentication for your AS2 connector, the access role requires the <code>secretsmanager:GetSecretValue</code> permission for the secret. If the secret is encrypted using a customer-managed key instead of the Amazon Web Services managed key in Secrets Manager, then the role also needs the <code>kms:Decrypt</code> permission for that key.</p> <p> <b>For SFTP connectors</b> </p> <p>Make sure that the access role provides read and write access to the parent directory of the file location that\'s used in the <code>StartFileTransfer</code> request. Additionally, make sure that the role provides <code>secretsmanager:GetSecretValue</code> permission to Secrets Manager.</p>', 'UpdateConnectorRequest$LoggingRole' => '<p>The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that allows a connector to turn on CloudWatch logging for Amazon S3 events. When set, you can view connector activity in your CloudWatch logs.</p>', 'UpdateUserRequest$Role' => '<p>The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that controls your users\' access to your Amazon S3 bucket or Amazon EFS file system. The policies attached to this role determine the level of access that you want to provide your users when transferring files into and out of your Amazon S3 bucket or Amazon EFS file system. The IAM role should also contain a trust relationship that allows the server to access your resources when servicing your users\' transfer requests.</p>', 'UpdateWebAppIdentityCenterConfig$Role' => '<p>The IAM role used to access IAM Identity Center.</p>', 'WorkflowDetail$ExecutionRole' => '<p>Includes the necessary permissions for S3, EFS, and Lambda operations that Transfer can assume, so that all workflow steps can operate on the required resources</p>', ], ], 'S3Bucket' => [ 'base' => NULL, 'refs' => [ 'S3FileLocation$Bucket' => '<p>Specifies the S3 bucket that contains the file being used.</p>', 'S3InputFileLocation$Bucket' => '<p>Specifies the S3 bucket for the customer input file.</p>', ], ], 'S3Etag' => [ 'base' => NULL, 'refs' => [ 'S3FileLocation$Etag' => '<p>The entity tag is a hash of the object. The ETag reflects changes only to the contents of an object, not its metadata.</p>', ], ], 'S3FileLocation' => [ 'base' => '<p>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.</p>', 'refs' => [ 'FileLocation$S3FileLocation' => '<p>Specifies the S3 details for the file being used, such as bucket, ETag, and so forth.</p>', ], ], 'S3InputFileLocation' => [ 'base' => '<p>Specifies the customer input Amazon S3 file location. If it is used inside <code>copyStepDetails.DestinationFileLocation</code>, it should be the S3 copy destination.</p> <p> 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. </p> <p>For example, if your path is <code>shared-files/bob/</code>, your uploaded files are copied to the <code>shared-files/bob/</code>, folder. If your path is <code>shared-files/today</code>, each uploaded file is copied to the <code>shared-files</code> folder and named <code>today</code>: each upload overwrites the previous version of the <i>bob</i> file.</p>', 'refs' => [ 'InputFileLocation$S3FileLocation' => '<p>Specifies the details for the Amazon S3 file that\'s being copied or decrypted.</p>', ], ], 'S3Key' => [ 'base' => NULL, 'refs' => [ 'S3FileLocation$Key' => '<p>The name assigned to the file when it was created in Amazon S3. You use the object key to retrieve the object.</p>', 'S3InputFileLocation$Key' => '<p>The name assigned to the file when it was created in Amazon S3. You use the object key to retrieve the object.</p>', ], ], 'S3StorageOptions' => [ 'base' => '<p>The Amazon S3 storage options that are configured for your server.</p>', 'refs' => [ 'CreateServerRequest$S3StorageOptions' => '<p>Specifies whether or not performance for your Amazon S3 directories is optimized.</p> <ul> <li> <p>If using the console, this is enabled by default.</p> </li> <li> <p>If using the API or CLI, this is disabled by default.</p> </li> </ul> <p>By default, home directory mappings have a <code>TYPE</code> of <code>DIRECTORY</code>. If you enable this option, you would then need to explicitly set the <code>HomeDirectoryMapEntry</code> <code>Type</code> to <code>FILE</code> if you want a mapping to have a file target.</p>', 'DescribedServer$S3StorageOptions' => '<p>Specifies whether or not performance for your Amazon S3 directories is optimized.</p> <ul> <li> <p>If using the console, this is enabled by default.</p> </li> <li> <p>If using the API or CLI, this is disabled by default.</p> </li> </ul> <p>By default, home directory mappings have a <code>TYPE</code> of <code>DIRECTORY</code>. If you enable this option, you would then need to explicitly set the <code>HomeDirectoryMapEntry</code> <code>Type</code> to <code>FILE</code> if you want a mapping to have a file target.</p>', 'UpdateServerRequest$S3StorageOptions' => '<p>Specifies whether or not performance for your Amazon S3 directories is optimized.</p> <ul> <li> <p>If using the console, this is enabled by default.</p> </li> <li> <p>If using the API or CLI, this is disabled by default.</p> </li> </ul> <p>By default, home directory mappings have a <code>TYPE</code> of <code>DIRECTORY</code>. If you enable this option, you would then need to explicitly set the <code>HomeDirectoryMapEntry</code> <code>Type</code> to <code>FILE</code> if you want a mapping to have a file target.</p>', ], ], 'S3Tag' => [ 'base' => '<p>Specifies the key-value pair that are assigned to a file during the execution of a Tagging step.</p>', 'refs' => [ 'S3Tags$member' => NULL, ], ], 'S3TagKey' => [ 'base' => NULL, 'refs' => [ 'S3Tag$Key' => '<p>The name assigned to the tag that you create.</p>', ], ], 'S3TagValue' => [ 'base' => NULL, 'refs' => [ 'S3Tag$Value' => '<p>The value that corresponds to the key.</p>', ], ], 'S3Tags' => [ 'base' => NULL, 'refs' => [ 'TagStepDetails$Tags' => '<p>Array that contains from 1 to 10 key/value pairs.</p>', ], ], 'S3VersionId' => [ 'base' => NULL, 'refs' => [ 'S3FileLocation$VersionId' => '<p>Specifies the file version.</p>', ], ], 'SecondaryGids' => [ 'base' => NULL, 'refs' => [ 'PosixProfile$SecondaryGids' => '<p>The secondary POSIX group IDs used for all EFS operations by this user.</p>', ], ], 'SecretId' => [ 'base' => NULL, 'refs' => [ 'SftpConnectorConfig$UserSecretId' => '<p>The identifier for the secret (in Amazon Web Services Secrets Manager) that contains the SFTP user\'s private key, password, or both. The identifier must be the Amazon Resource Name (ARN) of the secret.</p> <note> <ul> <li> <p>Required when creating an SFTP connector</p> </li> <li> <p>Optional when updating an existing SFTP connector</p> </li> </ul> </note>', ], ], 'SecurityGroupId' => [ 'base' => NULL, 'refs' => [ 'SecurityGroupIds$member' => NULL, ], ], 'SecurityGroupIds' => [ 'base' => NULL, 'refs' => [ 'EndpointDetails$SecurityGroupIds' => '<p>A list of security groups IDs that are available to attach to your server\'s endpoint.</p> <note> <p>While <code>SecurityGroupIds</code> appears in the response syntax for consistency with <code>CreateServer</code> and <code>UpdateServer</code> operations, this field is not populated in <code>DescribeServer</code> responses. Security groups are managed at the VPC endpoint level and can be modified outside of the Transfer Family service. To retrieve current security group information, use the EC2 <code>DescribeVpcEndpoints</code> API with the <code>VpcEndpointId</code> returned in the response.</p> <p>This property can only be set when <code>EndpointType</code> is set to <code>VPC</code>.</p> <p>You can edit the <code>SecurityGroupIds</code> property in the <a href="https://docs.aws.amazon.com/transfer/latest/userguide/API_UpdateServer.html">UpdateServer</a> API only if you are changing the <code>EndpointType</code> from <code>PUBLIC</code> or <code>VPC_ENDPOINT</code> to <code>VPC</code>. To change security groups associated with your server\'s VPC endpoint after creation, use the Amazon EC2 <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ModifyVpcEndpoint.html">ModifyVpcEndpoint</a> API.</p> </note>', ], ], 'SecurityPolicyName' => [ 'base' => NULL, 'refs' => [ 'CreateServerRequest$SecurityPolicyName' => '<p>Specifies the name of the security policy for the server.</p>', 'DescribeSecurityPolicyRequest$SecurityPolicyName' => '<p>Specify the text name of the security policy for which you want the details.</p>', 'DescribedSecurityPolicy$SecurityPolicyName' => '<p>The text name of the specified security policy.</p>', 'DescribedServer$SecurityPolicyName' => '<p>Specifies the name of the security policy for the server.</p>', 'SecurityPolicyNames$member' => NULL, 'UpdateServerRequest$SecurityPolicyName' => '<p>Specifies the name of the security policy for the server.</p>', ], ], 'SecurityPolicyNames' => [ 'base' => NULL, 'refs' => [ 'ListSecurityPoliciesResponse$SecurityPolicyNames' => '<p>An array of security policies that were listed.</p>', ], ], 'SecurityPolicyOption' => [ 'base' => NULL, 'refs' => [ 'SecurityPolicyOptions$member' => NULL, ], ], 'SecurityPolicyOptions' => [ 'base' => NULL, 'refs' => [ 'DescribedSecurityPolicy$SshCiphers' => '<p>Lists the enabled Secure Shell (SSH) cipher encryption algorithms in the security policy that is attached to the server or connector. This parameter applies to both server and connector security policies.</p>', 'DescribedSecurityPolicy$SshKexs' => '<p>Lists the enabled SSH key exchange (KEX) encryption algorithms in the security policy that is attached to the server or connector. This parameter applies to both server and connector security policies.</p>', 'DescribedSecurityPolicy$SshMacs' => '<p>Lists the enabled SSH message authentication code (MAC) encryption algorithms in the security policy that is attached to the server or connector. This parameter applies to both server and connector security policies.</p>', 'DescribedSecurityPolicy$TlsCiphers' => '<p>Lists the enabled Transport Layer Security (TLS) cipher encryption algorithms in the security policy that is attached to the server.</p> <note> <p>This parameter only applies to security policies for servers.</p> </note>', 'DescribedSecurityPolicy$SshHostKeyAlgorithms' => '<p>Lists the host key algorithms for the security policy.</p> <note> <p>This parameter only applies to security policies for connectors.</p> </note>', ], ], 'SecurityPolicyProtocol' => [ 'base' => NULL, 'refs' => [ 'SecurityPolicyProtocols$member' => NULL, ], ], 'SecurityPolicyProtocols' => [ 'base' => NULL, 'refs' => [ 'DescribedSecurityPolicy$Protocols' => '<p>Lists the file transfer protocols that the security policy applies to.</p>', ], ], 'SecurityPolicyResourceType' => [ 'base' => NULL, 'refs' => [ 'DescribedSecurityPolicy$Type' => '<p>The resource type to which the security policy applies, either server or connector.</p>', ], ], 'SendWorkflowStepStateRequest' => [ 'base' => NULL, 'refs' => [], ], 'SendWorkflowStepStateResponse' => [ 'base' => NULL, 'refs' => [], ], 'ServerId' => [ 'base' => NULL, 'refs' => [ 'CreateAccessRequest$ServerId' => '<p>A system-assigned unique identifier for a server instance. This is the specific server that you added your user to.</p>', 'CreateAccessResponse$ServerId' => '<p>The identifier of the server that the user is attached to.</p>', 'CreateAgreementRequest$ServerId' => '<p>A system-assigned unique identifier for a server instance. This is the specific server that the agreement uses.</p>', 'CreateServerResponse$ServerId' => '<p>The service-assigned identifier of the server that is created.</p>', 'CreateUserRequest$ServerId' => '<p>A system-assigned unique identifier for a server instance. This is the specific server that you added your user to.</p>', 'CreateUserResponse$ServerId' => '<p>The identifier of the server that the user is attached to.</p>', 'DeleteAccessRequest$ServerId' => '<p>A system-assigned unique identifier for a server that has this user assigned.</p>', 'DeleteAgreementRequest$ServerId' => '<p>The server identifier associated with the agreement that you are deleting.</p>', 'DeleteHostKeyRequest$ServerId' => '<p>The identifier of the server that contains the host key that you are deleting.</p>', 'DeleteServerRequest$ServerId' => '<p>A unique system-assigned identifier for a server instance.</p>', 'DeleteSshPublicKeyRequest$ServerId' => '<p>A system-assigned unique identifier for a file transfer protocol-enabled server instance that has the user assigned to it.</p>', 'DeleteUserRequest$ServerId' => '<p>A system-assigned unique identifier for a server instance that has the user assigned to it.</p>', 'DescribeAccessRequest$ServerId' => '<p>A system-assigned unique identifier for a server that has this access assigned.</p>', 'DescribeAccessResponse$ServerId' => '<p>A system-assigned unique identifier for a server that has this access assigned.</p>', 'DescribeAgreementRequest$ServerId' => '<p>The server identifier that\'s associated with the agreement.</p>', 'DescribeHostKeyRequest$ServerId' => '<p>The identifier of the server that contains the host key that you want described.</p>', 'DescribeServerRequest$ServerId' => '<p>A system-assigned unique identifier for a server.</p>', 'DescribeUserRequest$ServerId' => '<p>A system-assigned unique identifier for a server that has this user assigned.</p>', 'DescribeUserResponse$ServerId' => '<p>A system-assigned unique identifier for a server that has this user assigned.</p>', 'DescribedAgreement$ServerId' => '<p>A system-assigned unique identifier for a server instance. This identifier indicates the specific server that the agreement uses.</p>', 'DescribedServer$ServerId' => '<p>Specifies the unique system-assigned identifier for a server that you instantiate.</p>', 'ImportHostKeyRequest$ServerId' => '<p>The identifier of the server that contains the host key that you are importing.</p>', 'ImportHostKeyResponse$ServerId' => '<p>Returns the server identifier that contains the imported key.</p>', 'ImportSshPublicKeyRequest$ServerId' => '<p>A system-assigned unique identifier for a server.</p>', 'ImportSshPublicKeyResponse$ServerId' => '<p>A system-assigned unique identifier for a server.</p>', 'ListAccessesRequest$ServerId' => '<p>A system-assigned unique identifier for a server that has users assigned to it.</p>', 'ListAccessesResponse$ServerId' => '<p>A system-assigned unique identifier for a server that has users assigned to it.</p>', 'ListAgreementsRequest$ServerId' => '<p>The identifier of the server for which you want a list of agreements.</p>', 'ListHostKeysRequest$ServerId' => '<p>The identifier of the server that contains the host keys that you want to view.</p>', 'ListHostKeysResponse$ServerId' => '<p>Returns the server identifier that contains the listed host keys.</p>', 'ListUsersRequest$ServerId' => '<p>A system-assigned unique identifier for a server that has users assigned to it.</p>', 'ListUsersResponse$ServerId' => '<p>A system-assigned unique identifier for a server that the users are assigned to.</p>', 'ListedAgreement$ServerId' => '<p>The unique identifier for the agreement.</p>', 'ListedServer$ServerId' => '<p>Specifies the unique system assigned identifier for the servers that were listed.</p>', 'StartServerRequest$ServerId' => '<p>A system-assigned unique identifier for a server that you start.</p>', 'StopServerRequest$ServerId' => '<p>A system-assigned unique identifier for a server that you stopped.</p>', 'TestIdentityProviderRequest$ServerId' => '<p>A system-assigned identifier for a specific server. That server\'s user authentication method is tested with a user name and password.</p>', 'UpdateAccessRequest$ServerId' => '<p>A system-assigned unique identifier for a server instance. This is the specific server that you added your user to.</p>', 'UpdateAccessResponse$ServerId' => '<p>The identifier of the server that the user is attached to.</p>', 'UpdateAgreementRequest$ServerId' => '<p>A system-assigned unique identifier for a server instance. This is the specific server that the agreement uses.</p>', 'UpdateHostKeyRequest$ServerId' => '<p>The identifier of the server that contains the host key that you are updating.</p>', 'UpdateHostKeyResponse$ServerId' => '<p>Returns the server identifier for the server that contains the updated host key.</p>', 'UpdateServerRequest$ServerId' => '<p>A system-assigned unique identifier for a server instance that the Transfer Family user is assigned to.</p>', 'UpdateServerResponse$ServerId' => '<p>A system-assigned unique identifier for a server that the Transfer Family user is assigned to.</p>', 'UpdateUserRequest$ServerId' => '<p>A system-assigned unique identifier for a Transfer Family server instance that the user is assigned to.</p>', 'UpdateUserResponse$ServerId' => '<p>A system-assigned unique identifier for a Transfer Family server instance that the account is assigned to.</p>', 'UserDetails$ServerId' => '<p>The system-assigned unique identifier for a Transfer server instance. </p>', ], ], 'ServiceErrorMessage' => [ 'base' => NULL, 'refs' => [ 'AccessDeniedException$Message' => NULL, 'ServiceUnavailableException$Message' => NULL, ], ], 'ServiceManagedEgressIpAddress' => [ 'base' => NULL, 'refs' => [ 'ServiceManagedEgressIpAddresses$member' => NULL, ], ], 'ServiceManagedEgressIpAddresses' => [ 'base' => '<p>The list of egress IP addresses of this server. These IP addresses are only relevant for servers that use the AS2 protocol. They are used for sending asynchronous MDNs. These IP addresses are assigned automatically when you create an AS2 server. Additionally, if you update an existing server and add the AS2 protocol, static IP addresses are assigned as well.</p>', 'refs' => [ 'DescribedConnector$ServiceManagedEgressIpAddresses' => '<p>The list of egress IP addresses of this connector. These IP addresses are assigned automatically when you create the connector.</p>', 'DescribedServer$As2ServiceManagedEgressIpAddresses' => '<p>The list of egress IP addresses of this server. These IP addresses are only relevant for servers that use the AS2 protocol. They are used for sending asynchronous MDNs.</p> <p>These IP addresses are assigned automatically when you create an AS2 server. Additionally, if you update an existing server and add the AS2 protocol, static IP addresses are assigned as well.</p>', ], ], 'ServiceMetadata' => [ 'base' => '<p>A container object for the session details that are associated with a workflow.</p>', 'refs' => [ 'DescribedExecution$ServiceMetadata' => '<p>A container object for the session details that are associated with a workflow.</p>', 'ListedExecution$ServiceMetadata' => '<p>A container object for the session details that are associated with a workflow.</p>', ], ], 'ServiceUnavailableException' => [ 'base' => '<p>The request has failed because the Amazon Web ServicesTransfer Family service is not available.</p>', 'refs' => [], ], 'SessionId' => [ 'base' => NULL, 'refs' => [ 'UserDetails$SessionId' => '<p>The system-assigned unique identifier for a session that corresponds to the workflow.</p>', ], ], 'SetStatOption' => [ 'base' => NULL, 'refs' => [ 'ProtocolDetails$SetStatOption' => '<p>Use the <code>SetStatOption</code> to ignore the error that is generated when the client attempts to use <code>SETSTAT</code> on a file you are uploading to an S3 bucket.</p> <p>Some SFTP file transfer clients can attempt to change the attributes of remote files, including timestamp and permissions, using commands, such as <code>SETSTAT</code> when uploading the file. However, these commands are not compatible with object storage systems, such as Amazon S3. Due to this incompatibility, file uploads from these clients can result in errors even when the file is otherwise successfully uploaded.</p> <p>Set the value to <code>ENABLE_NO_OP</code> to have the Transfer Family server ignore the <code>SETSTAT</code> command, and upload files without needing to make any changes to your SFTP client. While the <code>SetStatOption</code> <code>ENABLE_NO_OP</code> setting ignores the error, it does generate a log entry in Amazon CloudWatch Logs, so you can determine when the client is making a <code>SETSTAT</code> call.</p> <note> <p>If you want to preserve the original timestamp for your file, and modify other file attributes using <code>SETSTAT</code>, you can use Amazon EFS as backend storage with Transfer Family.</p> </note>', ], ], 'SftpAuthenticationMethods' => [ 'base' => NULL, 'refs' => [ 'IdentityProviderDetails$SftpAuthenticationMethods' => '<p>For SFTP-enabled servers, and for custom identity providers <i>only</i>, you can specify whether to authenticate using a password, SSH key pair, or both.</p> <ul> <li> <p> <code>PASSWORD</code> - users must provide their password to connect.</p> </li> <li> <p> <code>PUBLIC_KEY</code> - users must provide their private key to connect.</p> </li> <li> <p> <code>PUBLIC_KEY_OR_PASSWORD</code> - users can authenticate with either their password or their key. This is the default value.</p> </li> <li> <p> <code>PUBLIC_KEY_AND_PASSWORD</code> - users must provide both their private key and their password to connect. The server checks the key first, and then if the key is valid, the system prompts for a password. If the private key provided does not match the public key that is stored, authentication fails.</p> </li> </ul>', ], ], 'SftpConnectorConfig' => [ 'base' => '<p>Contains the details for an SFTP connector object. The connector object is used for transferring files to and from a partner\'s SFTP server.</p>', 'refs' => [ 'CreateConnectorRequest$SftpConfig' => '<p>A structure that contains the parameters for an SFTP connector object.</p>', 'DescribedConnector$SftpConfig' => '<p>A structure that contains the parameters for an SFTP connector object.</p>', 'UpdateConnectorRequest$SftpConfig' => '<p>A structure that contains the parameters for an SFTP connector object.</p>', ], ], 'SftpConnectorConnectionDetails' => [ 'base' => '<p>Contains the details for an SFTP connector connection.</p>', 'refs' => [ 'TestConnectionResponse$SftpConnectionDetails' => '<p>Structure that contains the SFTP connector host key.</p>', ], ], 'SftpConnectorHostKey' => [ 'base' => NULL, 'refs' => [ 'SftpConnectorConnectionDetails$HostKey' => '<p>The SSH public key of the remote SFTP server. This is returned during the initial connection attempt when you call <code>TestConnection</code>. It allows you to retrieve the valid server host key to update the connector when you are unable to obtain it in advance.</p>', ], ], 'SftpConnectorTrustedHostKey' => [ 'base' => NULL, 'refs' => [ 'SftpConnectorTrustedHostKeyList$member' => NULL, ], ], 'SftpConnectorTrustedHostKeyList' => [ 'base' => NULL, 'refs' => [ 'SftpConnectorConfig$TrustedHostKeys' => '<p>The public portion of the host key, or keys, that are used to identify the external server to which you are connecting. You can use the <code>ssh-keyscan</code> command against the SFTP server to retrieve the necessary key.</p> <note> <p> <code>TrustedHostKeys</code> is optional for <code>CreateConnector</code>. If not provided, you can use <code>TestConnection</code> to retrieve the server host key during the initial connection attempt, and subsequently update the connector with the observed host key.</p> </note> <p>The three standard SSH public key format elements are <code>&lt;key type&gt;</code>, <code>&lt;body base64&gt;</code>, and an optional <code>&lt;comment&gt;</code>, with spaces between each element. Specify only the <code>&lt;key type&gt;</code> and <code>&lt;body base64&gt;</code>: do not enter the <code>&lt;comment&gt;</code> portion of the key.</p> <p>For the trusted host key, Transfer Family accepts RSA and ECDSA keys.</p> <ul> <li> <p>For RSA keys, the <code>&lt;key type&gt;</code> string is <code>ssh-rsa</code>.</p> </li> <li> <p>For ECDSA keys, the <code>&lt;key type&gt;</code> string is either <code>ecdsa-sha2-nistp256</code>, <code>ecdsa-sha2-nistp384</code>, or <code>ecdsa-sha2-nistp521</code>, depending on the size of the key you generated.</p> </li> </ul> <p>Run this command to retrieve the SFTP server host key, where your SFTP server name is <code>ftp.host.com</code>.</p> <p> <code>ssh-keyscan ftp.host.com</code> </p> <p>This prints the public host key to standard output.</p> <p> <code>ftp.host.com ssh-rsa AAAAB3Nza...&lt;long-string-for-public-key</code> </p> <p>Copy and paste this string into the <code>TrustedHostKeys</code> field for the <code>create-connector</code> command or into the <b>Trusted host keys</b> field in the console.</p>', ], ], 'SigningAlg' => [ 'base' => NULL, 'refs' => [ 'As2ConnectorConfig$SigningAlgorithm' => '<p>The algorithm that is used to sign the AS2 messages sent with the connector.</p>', ], ], 'SourceFileLocation' => [ 'base' => NULL, 'refs' => [ 'CopyStepDetails$SourceFileLocation' => '<p>Specifies which file to use as input to the workflow step: either the output from the previous step, or the originally uploaded file for the workflow.</p> <ul> <li> <p>To use the previous file as the input, enter <code>${previous.file}</code>. In this case, this workflow step uses the output file from the previous workflow step as input. This is the default value.</p> </li> <li> <p>To use the originally uploaded file location as input for this step, enter <code>${original.file}</code>.</p> </li> </ul>', 'CustomStepDetails$SourceFileLocation' => '<p>Specifies which file to use as input to the workflow step: either the output from the previous step, or the originally uploaded file for the workflow.</p> <ul> <li> <p>To use the previous file as the input, enter <code>${previous.file}</code>. In this case, this workflow step uses the output file from the previous workflow step as input. This is the default value.</p> </li> <li> <p>To use the originally uploaded file location as input for this step, enter <code>${original.file}</code>.</p> </li> </ul>', 'DecryptStepDetails$SourceFileLocation' => '<p>Specifies which file to use as input to the workflow step: either the output from the previous step, or the originally uploaded file for the workflow.</p> <ul> <li> <p>To use the previous file as the input, enter <code>${previous.file}</code>. In this case, this workflow step uses the output file from the previous workflow step as input. This is the default value.</p> </li> <li> <p>To use the originally uploaded file location as input for this step, enter <code>${original.file}</code>.</p> </li> </ul>', 'DeleteStepDetails$SourceFileLocation' => '<p>Specifies which file to use as input to the workflow step: either the output from the previous step, or the originally uploaded file for the workflow.</p> <ul> <li> <p>To use the previous file as the input, enter <code>${previous.file}</code>. In this case, this workflow step uses the output file from the previous workflow step as input. This is the default value.</p> </li> <li> <p>To use the originally uploaded file location as input for this step, enter <code>${original.file}</code>.</p> </li> </ul>', 'TagStepDetails$SourceFileLocation' => '<p>Specifies which file to use as input to the workflow step: either the output from the previous step, or the originally uploaded file for the workflow.</p> <ul> <li> <p>To use the previous file as the input, enter <code>${previous.file}</code>. In this case, this workflow step uses the output file from the previous workflow step as input. This is the default value.</p> </li> <li> <p>To use the originally uploaded file location as input for this step, enter <code>${original.file}</code>.</p> </li> </ul>', ], ], 'SourceIp' => [ 'base' => NULL, 'refs' => [ 'TestIdentityProviderRequest$SourceIp' => '<p>The source IP address of the account to be tested.</p>', ], ], 'SshPublicKey' => [ 'base' => '<p>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 <code>ServerId</code>). 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.</p>', 'refs' => [ 'SshPublicKeys$member' => NULL, ], ], 'SshPublicKeyBody' => [ 'base' => NULL, 'refs' => [ 'CreateUserRequest$SshPublicKeyBody' => '<p>The public portion of the Secure Shell (SSH) key used to authenticate the user to the server.</p> <p>The three standard SSH public key format elements are <code>&lt;key type&gt;</code>, <code>&lt;body base64&gt;</code>, and an optional <code>&lt;comment&gt;</code>, with spaces between each element.</p> <p>Transfer Family accepts RSA, ECDSA, and ED25519 keys.</p> <ul> <li> <p>For RSA keys, the key type is <code>ssh-rsa</code>.</p> </li> <li> <p>For ED25519 keys, the key type is <code>ssh-ed25519</code>.</p> </li> <li> <p>For ECDSA keys, the key type is either <code>ecdsa-sha2-nistp256</code>, <code>ecdsa-sha2-nistp384</code>, or <code>ecdsa-sha2-nistp521</code>, depending on the size of the key you generated.</p> </li> </ul>', 'ImportSshPublicKeyRequest$SshPublicKeyBody' => '<p>The public key portion of an SSH key pair.</p> <p>Transfer Family accepts RSA, ECDSA, and ED25519 keys.</p>', 'SshPublicKey$SshPublicKeyBody' => '<p>Specifies the content of the SSH public key as specified by the <code>PublicKeyId</code>.</p> <p>Transfer Family accepts RSA, ECDSA, and ED25519 keys.</p>', ], ], 'SshPublicKeyCount' => [ 'base' => NULL, 'refs' => [ 'ListedUser$SshPublicKeyCount' => '<p>Specifies the number of SSH public keys stored for the user you specified.</p>', ], ], 'SshPublicKeyId' => [ 'base' => NULL, 'refs' => [ 'DeleteSshPublicKeyRequest$SshPublicKeyId' => '<p>A unique identifier used to reference your user\'s specific SSH key.</p>', 'ImportSshPublicKeyResponse$SshPublicKeyId' => '<p>The name given to a public key by the system that was imported.</p>', 'SshPublicKey$SshPublicKeyId' => '<p>Specifies the <code>SshPublicKeyId</code> parameter contains the identifier of the public key.</p>', ], ], 'SshPublicKeys' => [ 'base' => NULL, 'refs' => [ 'DescribedUser$SshPublicKeys' => '<p>Specifies the public key portion of the Secure Shell (SSH) keys stored for the described user.</p> <note> <p>To delete the public key body, set its value to zero keys, as shown here:</p> <p> <code>SshPublicKeys: []</code> </p> </note>', ], ], 'StartDirectoryListingRequest' => [ 'base' => NULL, 'refs' => [], ], 'StartDirectoryListingResponse' => [ 'base' => NULL, 'refs' => [], ], 'StartFileTransferRequest' => [ 'base' => NULL, 'refs' => [], ], 'StartFileTransferResponse' => [ 'base' => NULL, 'refs' => [], ], 'StartRemoteDeleteRequest' => [ 'base' => NULL, 'refs' => [], ], 'StartRemoteDeleteResponse' => [ 'base' => NULL, 'refs' => [], ], 'StartRemoteMoveRequest' => [ 'base' => NULL, 'refs' => [], ], 'StartRemoteMoveResponse' => [ 'base' => NULL, 'refs' => [], ], 'StartServerRequest' => [ 'base' => NULL, 'refs' => [], ], 'State' => [ 'base' => '<p>Describes the condition of a file transfer protocol-enabled server with respect to its ability to perform file operations. There are six possible states: <code>OFFLINE</code>, <code>ONLINE</code>, <code>STARTING</code>, <code>STOPPING</code>, <code>START_FAILED</code>, and <code>STOP_FAILED</code>.</p> <p> <code>OFFLINE</code> indicates that the server exists, but that it is not available for file operations. <code>ONLINE</code> indicates that the server is available to perform file operations. <code>STARTING</code> indicates that the server\'s was instantiated, but the server is not yet available to perform file operations. Under normal conditions, it can take a couple of minutes for the server to be completely operational. Both <code>START_FAILED</code> and <code>STOP_FAILED</code> are error conditions.</p>', 'refs' => [ 'DescribedServer$State' => '<p>The condition of the server that was described. A value of <code>ONLINE</code> indicates that the server can accept jobs and transfer files. A <code>State</code> value of <code>OFFLINE</code> means that the server cannot perform file transfer operations.</p> <p>The states of <code>STARTING</code> and <code>STOPPING</code> indicate that the server is in an intermediate state, either not fully able to respond, or not fully offline. The values of <code>START_FAILED</code> or <code>STOP_FAILED</code> can indicate an error condition.</p>', 'ListedServer$State' => '<p>The condition of the server that was described. A value of <code>ONLINE</code> indicates that the server can accept jobs and transfer files. A <code>State</code> value of <code>OFFLINE</code> means that the server cannot perform file transfer operations.</p> <p>The states of <code>STARTING</code> and <code>STOPPING</code> indicate that the server is in an intermediate state, either not fully able to respond, or not fully offline. The values of <code>START_FAILED</code> or <code>STOP_FAILED</code> can indicate an error condition.</p>', ], ], 'Status' => [ 'base' => NULL, 'refs' => [ 'TestConnectionResponse$Status' => '<p>Returns <code>OK</code> for successful test, or <code>ERROR</code> if the test fails.</p>', ], ], 'StatusCode' => [ 'base' => NULL, 'refs' => [ 'TestIdentityProviderResponse$StatusCode' => '<p>The HTTP status code that is the response from your API Gateway or your Lambda function.</p>', ], ], 'StepResultOutputsJson' => [ 'base' => NULL, 'refs' => [ 'ExecutionStepResult$Outputs' => '<p>The values for the key/value pair applied as a tag to the file. Only applicable if the step type is <code>TAG</code>.</p>', ], ], 'StopServerRequest' => [ 'base' => NULL, 'refs' => [], ], 'StructuredLogDestinations' => [ 'base' => NULL, 'refs' => [ 'CreateServerRequest$StructuredLogDestinations' => '<p>Specifies the log groups to which your server logs are sent.</p> <p>To specify a log group, you must provide the ARN for an existing log group. In this case, the format of the log group is as follows:</p> <p> <code>arn:aws:logs:region-name:amazon-account-id:log-group:log-group-name:*</code> </p> <p>For example, <code>arn:aws:logs:us-east-1:111122223333:log-group:mytestgroup:*</code> </p> <p>If you have previously specified a log group for a server, you can clear it, and in effect turn off structured logging, by providing an empty value for this parameter in an <code>update-server</code> call. For example:</p> <p> <code>update-server --server-id s-1234567890abcdef0 --structured-log-destinations</code> </p>', 'DescribedServer$StructuredLogDestinations' => '<p>Specifies the log groups to which your server logs are sent.</p> <p>To specify a log group, you must provide the ARN for an existing log group. In this case, the format of the log group is as follows:</p> <p> <code>arn:aws:logs:region-name:amazon-account-id:log-group:log-group-name:*</code> </p> <p>For example, <code>arn:aws:logs:us-east-1:111122223333:log-group:mytestgroup:*</code> </p> <p>If you have previously specified a log group for a server, you can clear it, and in effect turn off structured logging, by providing an empty value for this parameter in an <code>update-server</code> call. For example:</p> <p> <code>update-server --server-id s-1234567890abcdef0 --structured-log-destinations</code> </p>', 'UpdateServerRequest$StructuredLogDestinations' => '<p>Specifies the log groups to which your server logs are sent.</p> <p>To specify a log group, you must provide the ARN for an existing log group. In this case, the format of the log group is as follows:</p> <p> <code>arn:aws:logs:region-name:amazon-account-id:log-group:log-group-name:*</code> </p> <p>For example, <code>arn:aws:logs:us-east-1:111122223333:log-group:mytestgroup:*</code> </p> <p>If you have previously specified a log group for a server, you can clear it, and in effect turn off structured logging, by providing an empty value for this parameter in an <code>update-server</code> call. For example:</p> <p> <code>update-server --server-id s-1234567890abcdef0 --structured-log-destinations</code> </p>', ], ], 'SubnetId' => [ 'base' => NULL, 'refs' => [ 'SubnetIds$member' => NULL, ], ], 'SubnetIds' => [ 'base' => NULL, 'refs' => [ 'EndpointDetails$SubnetIds' => '<p>A list of subnet IDs that are required to host your server endpoint in your VPC.</p> <note> <p>This property can only be set when <code>EndpointType</code> is set to <code>VPC</code>.</p> </note>', ], ], 'Tag' => [ 'base' => '<p>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 <code>Group</code> and assign the values <code>Research</code> and <code>Accounting</code> to that group.</p>', 'refs' => [ 'Tags$member' => NULL, ], ], 'TagKey' => [ 'base' => NULL, 'refs' => [ 'Tag$Key' => '<p>The name assigned to the tag that you create.</p>', 'TagKeys$member' => NULL, ], ], 'TagKeys' => [ 'base' => NULL, 'refs' => [ 'UntagResourceRequest$TagKeys' => '<p>TagKeys are key-value pairs assigned to ARNs that can be used to group and search for resources by type. This metadata can be attached to resources for any purpose.</p>', ], ], 'TagResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'TagStepDetails' => [ 'base' => '<p>Each step type has its own <code>StepDetails</code> structure.</p> <p>The key/value pairs used to tag a file during the execution of a workflow step.</p>', 'refs' => [ 'WorkflowStep$TagStepDetails' => '<p>Details for a step that creates one or more tags.</p> <p>You specify one or more tags. Each tag contains a key-value pair.</p>', ], ], 'TagValue' => [ 'base' => NULL, 'refs' => [ 'Tag$Value' => '<p>Contains one or more values that you assigned to the key name you create.</p>', ], ], 'Tags' => [ 'base' => NULL, 'refs' => [ 'CreateAgreementRequest$Tags' => '<p>Key-value pairs that can be used to group and search for agreements.</p>', 'CreateConnectorRequest$Tags' => '<p>Key-value pairs that can be used to group and search for connectors. Tags are metadata attached to connectors for any purpose.</p>', 'CreateProfileRequest$Tags' => '<p>Key-value pairs that can be used to group and search for AS2 profiles.</p>', 'CreateServerRequest$Tags' => '<p>Key-value pairs that can be used to group and search for servers.</p>', 'CreateUserRequest$Tags' => '<p>Key-value pairs that can be used to group and search for users. Tags are metadata attached to users for any purpose.</p>', 'CreateWebAppRequest$Tags' => '<p>Key-value pairs that can be used to group and search for web apps.</p>', 'CreateWorkflowRequest$Tags' => '<p>Key-value pairs that can be used to group and search for workflows. Tags are metadata attached to workflows for any purpose.</p>', 'DescribedAgreement$Tags' => '<p>Key-value pairs that can be used to group and search for agreements.</p>', 'DescribedCertificate$Tags' => '<p>Key-value pairs that can be used to group and search for certificates.</p>', 'DescribedConnector$Tags' => '<p>Key-value pairs that can be used to group and search for connectors.</p>', 'DescribedHostKey$Tags' => '<p>Key-value pairs that can be used to group and search for host keys.</p>', 'DescribedProfile$Tags' => '<p>Key-value pairs that can be used to group and search for profiles.</p>', 'DescribedServer$Tags' => '<p>Specifies the key-value pairs that you can use to search for and group servers that were assigned to the server that was described.</p>', 'DescribedUser$Tags' => '<p>Specifies the key-value pairs for the user requested. Tag can be used to search for and group users for a variety of purposes.</p>', 'DescribedWebApp$Tags' => '<p>Key-value pairs that can be used to group and search for web apps. Tags are metadata attached to web apps for any purpose.</p>', 'DescribedWorkflow$Tags' => '<p>Key-value pairs that can be used to group and search for workflows. Tags are metadata attached to workflows for any purpose.</p>', 'ImportCertificateRequest$Tags' => '<p>Key-value pairs that can be used to group and search for certificates.</p>', 'ImportHostKeyRequest$Tags' => '<p>Key-value pairs that can be used to group and search for host keys.</p>', 'ListTagsForResourceResponse$Tags' => '<p>Key-value pairs that are assigned to a resource, usually for the purpose of grouping and searching for items. Tags are metadata that you define.</p>', 'TagResourceRequest$Tags' => '<p>Key-value pairs assigned to ARNs that you can use to group and search for resources by type. You can attach this metadata to resources (servers, users, workflows, and so on) for any purpose.</p>', ], ], 'TestConnectionRequest' => [ 'base' => NULL, 'refs' => [], ], 'TestConnectionResponse' => [ 'base' => NULL, 'refs' => [], ], 'TestIdentityProviderRequest' => [ 'base' => NULL, 'refs' => [], ], 'TestIdentityProviderResponse' => [ 'base' => NULL, 'refs' => [], ], 'ThrottlingException' => [ 'base' => '<p>The request was denied due to request throttling.</p>', 'refs' => [], ], 'TlsSessionResumptionMode' => [ 'base' => NULL, 'refs' => [ 'ProtocolDetails$TlsSessionResumptionMode' => '<p>A property used with Transfer Family servers that use the FTPS protocol. TLS Session Resumption provides a mechanism to resume or share a negotiated secret key between the control and data connection for an FTPS session. <code>TlsSessionResumptionMode</code> determines whether or not the server resumes recent, negotiated sessions through a unique session ID. This property is available during <code>CreateServer</code> and <code>UpdateServer</code> calls. If a <code>TlsSessionResumptionMode</code> value is not specified during <code>CreateServer</code>, it is set to <code>ENFORCED</code> by default.</p> <ul> <li> <p> <code>DISABLED</code>: the server does not process TLS session resumption client requests and creates a new TLS session for each request. </p> </li> <li> <p> <code>ENABLED</code>: the server processes and accepts clients that are performing TLS session resumption. The server doesn\'t reject client data connections that do not perform the TLS session resumption client processing.</p> </li> <li> <p> <code>ENFORCED</code>: the server processes and accepts clients that are performing TLS session resumption. The server rejects client data connections that do not perform the TLS session resumption client processing. Before you set the value to <code>ENFORCED</code>, test your clients.</p> <note> <p>Not all FTPS clients perform TLS session resumption. So, if you choose to enforce TLS session resumption, you prevent any connections from FTPS clients that don\'t perform the protocol negotiation. To determine whether or not you can use the <code>ENFORCED</code> value, you need to test your clients.</p> </note> </li> </ul>', ], ], 'TransferId' => [ 'base' => NULL, 'refs' => [ 'ListFileTransferResultsRequest$TransferId' => '<p>A unique identifier for a file transfer. This value should match the value supplied to the corresponding <code>StartFileTransfer</code> call.</p>', 'StartFileTransferResponse$TransferId' => '<p>Returns the unique identifier for the file transfer.</p>', ], ], 'TransferTableStatus' => [ 'base' => NULL, 'refs' => [ 'ConnectorFileTransferResult$StatusCode' => '<p>The current status for the transfer.</p>', ], ], 'UntagResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateAccessRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateAccessResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateAgreementRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateAgreementResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateCertificateRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateCertificateResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateConnectorRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateConnectorResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateHostKeyRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateHostKeyResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateProfileRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateProfileResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateServerRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateServerResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateUserRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateUserResponse' => [ 'base' => '<p> <code>UpdateUserResponse</code> returns the user name and identifier for the request to update a user\'s properties.</p>', 'refs' => [], ], 'UpdateWebAppCustomizationRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateWebAppCustomizationResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateWebAppIdentityCenterConfig' => [ 'base' => '<p>A structure that describes the values to use for the IAM Identity Center settings when you update a web app.</p>', 'refs' => [ 'UpdateWebAppIdentityProviderDetails$IdentityCenterConfig' => '<p>A structure that describes the values to use for the IAM Identity Center settings when you update a web app.</p>', ], ], 'UpdateWebAppIdentityProviderDetails' => [ 'base' => '<p>A union that contains the <code>UpdateWebAppIdentityCenterConfig</code> object.</p>', 'refs' => [ 'UpdateWebAppRequest$IdentityProviderDetails' => '<p>Provide updated identity provider values in a <code>WebAppIdentityProviderDetails</code> object.</p>', ], ], 'UpdateWebAppRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateWebAppResponse' => [ 'base' => NULL, 'refs' => [], ], 'Url' => [ 'base' => NULL, 'refs' => [ 'CreateConnectorRequest$Url' => '<p>The URL of the partner\'s AS2 or SFTP endpoint.</p>', 'DescribedConnector$Url' => '<p>The URL of the partner\'s AS2 or SFTP endpoint.</p>', 'IdentityProviderDetails$Url' => '<p>Provides the location of the service endpoint used to authenticate users.</p>', 'ListedConnector$Url' => '<p>The URL of the partner\'s AS2 or SFTP endpoint.</p>', 'TestIdentityProviderResponse$Url' => '<p>The endpoint of the service used to authenticate a user.</p>', 'UpdateConnectorRequest$Url' => '<p>The URL of the partner\'s AS2 or SFTP endpoint.</p>', ], ], 'UserCount' => [ 'base' => NULL, 'refs' => [ 'DescribedServer$UserCount' => '<p>Specifies the number of users that are assigned to a server you specified with the <code>ServerId</code>.</p>', 'ListedServer$UserCount' => '<p>Specifies the number of users that are assigned to a server you specified with the <code>ServerId</code>.</p>', ], ], 'UserDetails' => [ 'base' => '<p>Specifies the user name, server ID, and session ID for a workflow.</p>', 'refs' => [ 'ServiceMetadata$UserDetails' => '<p>The Server ID (<code>ServerId</code>), Session ID (<code>SessionId</code>) and user (<code>UserName</code>) make up the <code>UserDetails</code>.</p>', ], ], 'UserName' => [ 'base' => NULL, 'refs' => [ 'CreateUserRequest$UserName' => '<p>A unique string that identifies a user and is associated with a <code>ServerId</code>. This user name must be a minimum of 3 and a maximum of 100 characters long. The following are valid characters: a-z, A-Z, 0-9, underscore \'_\', hyphen \'-\', period \'.\', and at sign \'@\'. The user name can\'t start with a hyphen, period, or at sign.</p>', 'CreateUserResponse$UserName' => '<p>A unique string that identifies a Transfer Family user.</p>', 'DeleteSshPublicKeyRequest$UserName' => '<p>A unique string that identifies a user whose public key is being deleted.</p>', 'DeleteUserRequest$UserName' => '<p>A unique string that identifies a user that is being deleted from a server.</p>', 'DescribeUserRequest$UserName' => '<p>The name of the user assigned to one or more servers. User names are part of the sign-in credentials to use the Transfer Family service and perform file transfer tasks.</p>', 'DescribedUser$UserName' => '<p>Specifies the name of the user that was requested to be described. User names are used for authentication purposes. This is the string that will be used by your user when they log in to your server.</p>', 'ImportSshPublicKeyRequest$UserName' => '<p>The name of the Transfer Family user that is assigned to one or more servers.</p>', 'ImportSshPublicKeyResponse$UserName' => '<p>A user name assigned to the <code>ServerID</code> value that you specified.</p>', 'ListedUser$UserName' => '<p>Specifies the name of the user whose ARN was specified. User names are used for authentication purposes.</p>', 'TestIdentityProviderRequest$UserName' => '<p>The name of the account to be tested.</p>', 'UpdateUserRequest$UserName' => '<p>A unique string that identifies a user and is associated with a server as specified by the <code>ServerId</code>. This user name must be a minimum of 3 and a maximum of 100 characters long. The following are valid characters: a-z, A-Z, 0-9, underscore \'_\', hyphen \'-\', period \'.\', and at sign \'@\'. The user name can\'t start with a hyphen, period, or at sign.</p>', 'UpdateUserResponse$UserName' => '<p>The unique identifier for a user that is assigned to a server instance that was specified in the request.</p>', 'UserDetails$UserName' => '<p>A unique string that identifies a Transfer Family user associated with a server.</p>', ], ], 'UserPassword' => [ 'base' => NULL, 'refs' => [ 'TestIdentityProviderRequest$UserPassword' => '<p>The password of the account to be tested.</p>', ], ], 'VpcEndpointId' => [ 'base' => NULL, 'refs' => [ 'EndpointDetails$VpcEndpointId' => '<p>The identifier of the VPC endpoint.</p> <note> <p>This property can only be set when <code>EndpointType</code> is set to <code>VPC_ENDPOINT</code>.</p> <p>For more information, see https://docs.aws.amazon.com/transfer/latest/userguide/create-server-in-vpc.html#deprecate-vpc-endpoint.</p> </note>', ], ], 'VpcId' => [ 'base' => NULL, 'refs' => [ 'EndpointDetails$VpcId' => '<p>The VPC identifier of the VPC in which a server\'s endpoint will be hosted.</p> <note> <p>This property can only be set when <code>EndpointType</code> is set to <code>VPC</code>.</p> </note>', ], ], 'WebAppAccessEndpoint' => [ 'base' => NULL, 'refs' => [ 'CreateWebAppRequest$AccessEndpoint' => '<p>The <code>AccessEndpoint</code> is the URL that you provide to your users for them to interact with the Transfer Family web app. You can specify a custom URL or use the default value.</p> <p>Before you enter a custom URL for this parameter, follow the steps described in <a href="https://docs.aws.amazon.com/transfer/latest/userguide/webapp-customize.html">Update your access endpoint with a custom URL</a>.</p>', 'DescribedWebApp$AccessEndpoint' => '<p>The <code>AccessEndpoint</code> is the URL that you provide to your users for them to interact with the Transfer Family web app. You can specify a custom URL or use the default value.</p>', 'ListedWebApp$AccessEndpoint' => '<p>The <code>AccessEndpoint</code> is the URL that you provide to your users for them to interact with the Transfer Family web app. You can specify a custom URL or use the default value.</p>', 'UpdateWebAppRequest$AccessEndpoint' => '<p>The <code>AccessEndpoint</code> is the URL that you provide to your users for them to interact with the Transfer Family web app. You can specify a custom URL or use the default value.</p>', ], ], 'WebAppEndpoint' => [ 'base' => NULL, 'refs' => [ 'DescribedWebApp$WebAppEndpoint' => '<p>The <code>WebAppEndpoint</code> is the unique URL for your Transfer Family web app. This is the value that you use when you configure <b>Origins</b> on CloudFront.</p>', 'ListedWebApp$WebAppEndpoint' => '<p>The <code>WebAppEndpoint</code> is the unique URL for your Transfer Family web app. This is the value that you use when you configure <b>Origins</b> on CloudFront.</p>', ], ], 'WebAppEndpointPolicy' => [ 'base' => NULL, 'refs' => [ 'CreateWebAppRequest$WebAppEndpointPolicy' => '<p> Setting for the type of endpoint policy for the web app. The default value is <code>STANDARD</code>. </p> <p>If you are creating the web app in an Amazon Web Services GovCloud (US) Region, you can set this parameter to <code>FIPS</code>.</p>', 'DescribedWebApp$WebAppEndpointPolicy' => '<p> Setting for the type of endpoint policy for the web app. The default value is <code>STANDARD</code>. </p> <p>If your web app was created in an Amazon Web Services GovCloud (US) Region, the value of this parameter can be <code>FIPS</code>, which indicates the web app endpoint is FIPS-compliant.</p>', ], ], 'WebAppFaviconFile' => [ 'base' => NULL, 'refs' => [ 'DescribedWebAppCustomization$FaviconFile' => '<p>Returns an icon file data string (in base64 encoding).</p>', 'UpdateWebAppCustomizationRequest$FaviconFile' => '<p>Specify an icon file data string (in base64 encoding).</p>', ], ], 'WebAppId' => [ 'base' => NULL, 'refs' => [ 'CreateWebAppResponse$WebAppId' => '<p>Returns a unique identifier for the web app.</p>', 'DeleteWebAppCustomizationRequest$WebAppId' => '<p>Provide the unique identifier for the web app that contains the customizations that you are deleting.</p>', 'DeleteWebAppRequest$WebAppId' => '<p>Provide the unique identifier for the web app that you are deleting.</p>', 'DescribeWebAppCustomizationRequest$WebAppId' => '<p>Provide the unique identifier for the web app.</p>', 'DescribeWebAppRequest$WebAppId' => '<p>Provide the unique identifier for the web app.</p>', 'DescribedWebApp$WebAppId' => '<p>The unique identifier for the web app.</p>', 'DescribedWebAppCustomization$WebAppId' => '<p>Returns the unique identifier for your web app.</p>', 'ListedWebApp$WebAppId' => '<p>The unique identifier for the web app.</p>', 'UpdateWebAppCustomizationRequest$WebAppId' => '<p>Provide the identifier of the web app that you are updating.</p>', 'UpdateWebAppCustomizationResponse$WebAppId' => '<p>Returns the unique identifier for the web app being updated.</p>', 'UpdateWebAppRequest$WebAppId' => '<p>Provide the identifier of the web app that you are updating.</p>', 'UpdateWebAppResponse$WebAppId' => '<p>Returns the unique identifier for the web app being updated.</p>', ], ], 'WebAppIdentityProviderDetails' => [ 'base' => '<p>A union that contains the <code>IdentityCenterConfig</code> object.</p>', 'refs' => [ 'CreateWebAppRequest$IdentityProviderDetails' => '<p>You can provide a structure that contains the details for the identity provider to use with your web app.</p> <p>For more details about this parameter, see <a href="https://docs.aws.amazon.com/transfer/latest/userguide/webapp-identity-center.html">Configure your identity provider for Transfer Family web apps</a>.</p>', ], ], 'WebAppLogoFile' => [ 'base' => NULL, 'refs' => [ 'DescribedWebAppCustomization$LogoFile' => '<p>Returns a logo file data string (in base64 encoding).</p>', 'UpdateWebAppCustomizationRequest$LogoFile' => '<p>Specify logo file data string (in base64 encoding).</p>', ], ], 'WebAppTitle' => [ 'base' => NULL, 'refs' => [ 'DescribedWebAppCustomization$Title' => '<p>Returns the page title that you defined for your web app.</p>', 'UpdateWebAppCustomizationRequest$Title' => '<p>Provide an updated title.</p>', ], ], 'WebAppUnitCount' => [ 'base' => NULL, 'refs' => [ 'WebAppUnits$Provisioned' => '<p>An integer that represents the number of units for your desired number of concurrent connections, or the number of user sessions on your web app at the same time.</p> <p>Each increment allows an additional 250 concurrent sessions: a value of <code>1</code> sets the number of concurrent sessions to 250; <code>2</code> sets a value of 500, and so on. </p>', ], ], 'WebAppUnits' => [ 'base' => '<p>Contains an integer value that represents the value for number of concurrent connections or the user sessions on your web app.</p>', 'refs' => [ 'CreateWebAppRequest$WebAppUnits' => '<p>A union that contains the value for number of concurrent connections or the user sessions on your web app.</p>', 'DescribedWebApp$WebAppUnits' => '<p>A union that contains the value for number of concurrent connections or the user sessions on your web app.</p>', 'UpdateWebAppRequest$WebAppUnits' => '<p>A union that contains the value for number of concurrent connections or the user sessions on your web app.</p>', ], ], 'WorkflowDescription' => [ 'base' => NULL, 'refs' => [ 'CreateWorkflowRequest$Description' => '<p>A textual description for the workflow.</p>', 'DescribedWorkflow$Description' => '<p>Specifies the text description for the workflow.</p>', 'ListedWorkflow$Description' => '<p>Specifies the text description for the workflow.</p>', ], ], 'WorkflowDetail' => [ 'base' => '<p>Specifies the workflow ID for the workflow to assign and the execution role that\'s used for executing the workflow.</p> <p>In addition to a workflow to execute when a file is uploaded completely, <code>WorkflowDetails</code> 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.</p>', 'refs' => [ 'OnPartialUploadWorkflowDetails$member' => NULL, 'OnUploadWorkflowDetails$member' => NULL, ], ], 'WorkflowDetails' => [ 'base' => '<p>Container for the <code>WorkflowDetail</code> data type. It is used by actions that trigger a workflow to begin execution.</p>', 'refs' => [ 'CreateServerRequest$WorkflowDetails' => '<p>Specifies the workflow ID for the workflow to assign and the execution role that\'s used for executing the workflow.</p> <p>In addition to a workflow to execute when a file is uploaded completely, <code>WorkflowDetails</code> 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.</p>', 'DescribedServer$WorkflowDetails' => '<p>Specifies the workflow ID for the workflow to assign and the execution role that\'s used for executing the workflow.</p> <p>In addition to a workflow to execute when a file is uploaded completely, <code>WorkflowDetails</code> 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.</p>', 'UpdateServerRequest$WorkflowDetails' => '<p>Specifies the workflow ID for the workflow to assign and the execution role that\'s used for executing the workflow.</p> <p>In addition to a workflow to execute when a file is uploaded completely, <code>WorkflowDetails</code> 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.</p> <p>To remove an associated workflow from a server, you can provide an empty <code>OnUpload</code> object, as in the following example.</p> <p> <code>aws transfer update-server --server-id s-01234567890abcdef --workflow-details \'{"OnUpload":[]}\'</code> </p>', ], ], 'WorkflowId' => [ 'base' => NULL, 'refs' => [ 'CreateWorkflowResponse$WorkflowId' => '<p>A unique identifier for the workflow.</p>', 'DeleteWorkflowRequest$WorkflowId' => '<p>A unique identifier for the workflow.</p>', 'DescribeExecutionRequest$WorkflowId' => '<p>A unique identifier for the workflow.</p>', 'DescribeExecutionResponse$WorkflowId' => '<p>A unique identifier for the workflow.</p>', 'DescribeWorkflowRequest$WorkflowId' => '<p>A unique identifier for the workflow.</p>', 'DescribedWorkflow$WorkflowId' => '<p>A unique identifier for the workflow.</p>', 'ListExecutionsRequest$WorkflowId' => '<p>A unique identifier for the workflow.</p>', 'ListExecutionsResponse$WorkflowId' => '<p>A unique identifier for the workflow.</p>', 'ListedWorkflow$WorkflowId' => '<p>A unique identifier for the workflow.</p>', 'SendWorkflowStepStateRequest$WorkflowId' => '<p>A unique identifier for the workflow.</p>', 'WorkflowDetail$WorkflowId' => '<p>A unique identifier for the workflow.</p>', ], ], 'WorkflowStep' => [ 'base' => '<p>The basic building block of a workflow.</p>', 'refs' => [ 'WorkflowSteps$member' => NULL, ], ], 'WorkflowStepName' => [ 'base' => NULL, 'refs' => [ 'CopyStepDetails$Name' => '<p>The name of the step, used as an identifier.</p>', 'CustomStepDetails$Name' => '<p>The name of the step, used as an identifier.</p>', 'DecryptStepDetails$Name' => '<p>The name of the step, used as an identifier.</p>', 'DeleteStepDetails$Name' => '<p>The name of the step, used as an identifier.</p>', 'TagStepDetails$Name' => '<p>The name of the step, used as an identifier.</p>', ], ], 'WorkflowStepType' => [ 'base' => NULL, 'refs' => [ 'ExecutionStepResult$StepType' => '<p>One of the available step types.</p> <ul> <li> <p> <b> <code>COPY</code> </b> - Copy the file to another location.</p> </li> <li> <p> <b> <code>CUSTOM</code> </b> - Perform a custom step with an Lambda function target.</p> </li> <li> <p> <b> <code>DECRYPT</code> </b> - Decrypt a file that was encrypted before it was uploaded.</p> </li> <li> <p> <b> <code>DELETE</code> </b> - Delete the file.</p> </li> <li> <p> <b> <code>TAG</code> </b> - Add a tag to the file.</p> </li> </ul>', 'WorkflowStep$Type' => '<p> Currently, the following step types are supported. </p> <ul> <li> <p> <b> <code>COPY</code> </b> - Copy the file to another location.</p> </li> <li> <p> <b> <code>CUSTOM</code> </b> - Perform a custom step with an Lambda function target.</p> </li> <li> <p> <b> <code>DECRYPT</code> </b> - Decrypt a file that was encrypted before it was uploaded.</p> </li> <li> <p> <b> <code>DELETE</code> </b> - Delete the file.</p> </li> <li> <p> <b> <code>TAG</code> </b> - Add a tag to the file.</p> </li> </ul>', ], ], 'WorkflowSteps' => [ 'base' => NULL, 'refs' => [ 'CreateWorkflowRequest$Steps' => '<p>Specifies the details for the steps that are in the specified workflow.</p> <p> The <code>TYPE</code> specifies which of the following actions is being taken for this step. </p> <ul> <li> <p> <b> <code>COPY</code> </b> - Copy the file to another location.</p> </li> <li> <p> <b> <code>CUSTOM</code> </b> - Perform a custom step with an Lambda function target.</p> </li> <li> <p> <b> <code>DECRYPT</code> </b> - Decrypt a file that was encrypted before it was uploaded.</p> </li> <li> <p> <b> <code>DELETE</code> </b> - Delete the file.</p> </li> <li> <p> <b> <code>TAG</code> </b> - Add a tag to the file.</p> </li> </ul> <note> <p> Currently, copying and tagging are supported only on S3. </p> </note> <p> For file location, you specify either the Amazon S3 bucket and key, or the Amazon EFS file system ID and path. </p>', 'CreateWorkflowRequest$OnExceptionSteps' => '<p>Specifies the steps (actions) to take if errors are encountered during execution of the workflow.</p> <note> <p>For custom steps, the Lambda function needs to send <code>FAILURE</code> to the call back API to kick off the exception steps. Additionally, if the Lambda does not send <code>SUCCESS</code> before it times out, the exception steps are executed.</p> </note>', 'DescribedWorkflow$Steps' => '<p>Specifies the details for the steps that are in the specified workflow.</p>', 'DescribedWorkflow$OnExceptionSteps' => '<p>Specifies the steps (actions) to take if errors are encountered during execution of the workflow.</p>', ], ], ],];
