@aws-sdk/client-transfer 3.296.0 → 3.297.0

package/dist-types/models/models_0.d.ts

@@ -1,6 +1,7 @@
 import { ExceptionOptionType as __ExceptionOptionType } from "@aws-sdk/smithy-client";
 import { TransferServiceException as __BaseException } from "./TransferServiceException";
 /**
+ * @public
  * <p>You do not have sufficient access to perform this action.</p>
  */
 export declare class AccessDeniedException extends __BaseException {
@@ -12,24 +13,39 @@ export declare class AccessDeniedException extends __BaseException {
      */
     constructor(opts: __ExceptionOptionType<AccessDeniedException, __BaseException>);
 }
+/**
+ * @public
+ */
 export declare enum AgreementStatusType {
     ACTIVE = "ACTIVE",
     INACTIVE = "INACTIVE"
 }
+/**
+ * @public
+ */
 export declare enum CompressionEnum {
     DISABLED = "DISABLED",
     ZLIB = "ZLIB"
 }
+/**
+ * @public
+ */
 export declare enum EncryptionAlg {
     AES128_CBC = "AES128_CBC",
     AES192_CBC = "AES192_CBC",
     AES256_CBC = "AES256_CBC",
     NONE = "NONE"
 }
+/**
+ * @public
+ */
 export declare enum MdnResponse {
     NONE = "NONE",
     SYNC = "SYNC"
 }
+/**
+ * @public
+ */
 export declare enum MdnSigningAlg {
     DEFAULT = "DEFAULT",
     NONE = "NONE",
@@ -38,6 +54,9 @@ export declare enum MdnSigningAlg {
     SHA384 = "SHA384",
     SHA512 = "SHA512"
 }
+/**
+ * @public
+ */
 export declare enum SigningAlg {
     NONE = "NONE",
     SHA1 = "SHA1",
@@ -46,6 +65,7 @@ export declare enum SigningAlg {
     SHA512 = "SHA512"
 }
 /**
+ * @public
  * <p>Contains the details for a connector object. The connector object is used for AS2 outbound
  *       processes, to connect the Transfer Family customer with the trading partner.</p>
  */
@@ -101,23 +121,36 @@ export interface As2ConnectorConfig {
      */
     MdnResponse?: MdnResponse | string;
 }
+/**
+ * @public
+ */
 export declare enum As2Transport {
     HTTP = "HTTP"
 }
+/**
+ * @public
+ */
 export declare enum CertificateStatusType {
     ACTIVE = "ACTIVE",
     INACTIVE = "INACTIVE",
     PENDING_ROTATION = "PENDING_ROTATION"
 }
+/**
+ * @public
+ */
 export declare enum CertificateType {
     CERTIFICATE = "CERTIFICATE",
     CERTIFICATE_WITH_PRIVATE_KEY = "CERTIFICATE_WITH_PRIVATE_KEY"
 }
+/**
+ * @public
+ */
 export declare enum CertificateUsageType {
     ENCRYPTION = "ENCRYPTION",
     SIGNING = "SIGNING"
 }
 /**
+ * @public
  * <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>
@@ -132,6 +165,7 @@ export declare class ConflictException extends __BaseException {
     constructor(opts: __ExceptionOptionType<ConflictException, __BaseException>);
 }
 /**
+ * @public
  * <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>
@@ -148,6 +182,7 @@ export interface EfsFileLocation {
     Path?: string;
 }
 /**
+ * @public
  * <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.
@@ -171,6 +206,7 @@ export interface S3InputFileLocation {
     Key?: string;
 }
 /**
+ * @public
  * <p>Specifies the location for the file that's being processed.</p>
  */
 export interface InputFileLocation {
@@ -184,11 +220,15 @@ export interface InputFileLocation {
      */
     EfsFileLocation?: EfsFileLocation;
 }
+/**
+ * @public
+ */
 export declare enum OverwriteExisting {
     FALSE = "FALSE",
     TRUE = "TRUE"
 }
 /**
+ * @public
  * <p>Each step type has its own <code>StepDetails</code> structure.</p>
  */
 export interface CopyStepDetails {
@@ -197,15 +237,15 @@ export interface CopyStepDetails {
      */
     Name?: string;
     /**
-     * <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
+     * <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
+     *                <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
+     *                <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
@@ -225,23 +265,24 @@ export interface CopyStepDetails {
      *     for the workflow.</p>
      *          <ul>
      *             <li>
-     *                <p>To use the previous file as the input, enter <code>${previous.file}</code>.
+     *                <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>
+     *                <p>To use the originally uploaded file location as input for this step, enter <code>$\{original.file\}</code>.</p>
      *             </li>
      *          </ul>
      */
     SourceFileLocation?: string;
 }
 /**
+ * @public
  * <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>
+ *             <code>[ \{ "Entry": "/", "Target": "/bucket_name/home/mydirectory" \} ]</code>
  *          </p>
  */
 export interface HomeDirectoryMapEntry {
@@ -254,11 +295,15 @@ export interface HomeDirectoryMapEntry {
      */
     Target: string | undefined;
 }
+/**
+ * @public
+ */
 export declare enum HomeDirectoryType {
     LOGICAL = "LOGICAL",
     PATH = "PATH"
 }
 /**
+ * @public
  * <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
@@ -279,6 +324,9 @@ export interface PosixProfile {
      */
     SecondaryGids?: number[];
 }
+/**
+ * @public
+ */
 export interface CreateAccessRequest {
     /**
      * <p>The landing directory (folder) for a user when they log in to the server using the client.</p>
@@ -303,7 +351,7 @@ export interface CreateAccessRequest {
      *       <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>
+     *             <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
@@ -311,14 +359,14 @@ export interface CreateAccessRequest {
      *         <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>
+     *             <code>[ \{ "Entry": "/", "Target": "/bucket_name/home/mydirectory" \} ]</code>
      *          </p>
      */
     HomeDirectoryMappings?: HomeDirectoryMapEntry[];
     /**
      * <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>
+     *      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
@@ -356,7 +404,7 @@ export interface CreateAccessRequest {
      *     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>
+     *             <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.
@@ -364,6 +412,9 @@ export interface CreateAccessRequest {
      */
     ExternalId: string | undefined;
 }
+/**
+ * @public
+ */
 export interface CreateAccessResponse {
     /**
      * <p>The identifier of the server that the user is attached to.</p>
@@ -376,6 +427,7 @@ export interface CreateAccessResponse {
     ExternalId: string | undefined;
 }
 /**
+ * @public
  * <p>This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family service.</p>
  */
 export declare class InternalServiceError extends __BaseException {
@@ -388,6 +440,7 @@ export declare class InternalServiceError extends __BaseException {
     constructor(opts: __ExceptionOptionType<InternalServiceError, __BaseException>);
 }
 /**
+ * @public
  * <p>This exception is thrown when the client submits a malformed request.</p>
  */
 export declare class InvalidRequestException extends __BaseException {
@@ -400,6 +453,7 @@ export declare class InvalidRequestException extends __BaseException {
     constructor(opts: __ExceptionOptionType<InvalidRequestException, __BaseException>);
 }
 /**
+ * @public
  * <p>The requested resource does not exist.</p>
  */
 export declare class ResourceExistsException extends __BaseException {
@@ -414,6 +468,7 @@ export declare class ResourceExistsException extends __BaseException {
     constructor(opts: __ExceptionOptionType<ResourceExistsException, __BaseException>);
 }
 /**
+ * @public
  * <p>This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family
  *       service.</p>
  */
@@ -429,6 +484,7 @@ export declare class ResourceNotFoundException extends __BaseException {
     constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
 }
 /**
+ * @public
  * <p>The request has failed because the Amazon Web ServicesTransfer Family service is not available.</p>
  */
 export declare class ServiceUnavailableException extends __BaseException {
@@ -441,6 +497,7 @@ export declare class ServiceUnavailableException extends __BaseException {
     constructor(opts: __ExceptionOptionType<ServiceUnavailableException, __BaseException>);
 }
 /**
+ * @public
  * <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
@@ -457,6 +514,9 @@ export interface Tag {
      */
     Value: string | undefined;
 }
+/**
+ * @public
+ */
 export interface CreateAgreementRequest {
     /**
      * <p>A name or short description to identify the agreement. </p>
@@ -504,6 +564,9 @@ export interface CreateAgreementRequest {
      */
     Tags?: Tag[];
 }
+/**
+ * @public
+ */
 export interface CreateAgreementResponse {
     /**
      * <p>The unique identifier for the agreement. Use this ID for deleting, or updating an
@@ -513,6 +576,7 @@ export interface CreateAgreementResponse {
     AgreementId: string | undefined;
 }
 /**
+ * @public
  * <p>The request was denied due to request throttling.</p>
  */
 export declare class ThrottlingException extends __BaseException {
@@ -524,6 +588,9 @@ export declare class ThrottlingException extends __BaseException {
      */
     constructor(opts: __ExceptionOptionType<ThrottlingException, __BaseException>);
 }
+/**
+ * @public
+ */
 export interface CreateConnectorRequest {
     /**
      * <p>The URL of the partner's AS2 endpoint.</p>
@@ -557,16 +624,25 @@ export interface CreateConnectorRequest {
      */
     Tags?: Tag[];
 }
+/**
+ * @public
+ */
 export interface CreateConnectorResponse {
     /**
      * <p>The unique identifier for the connector, returned after the API call succeeds.</p>
      */
     ConnectorId: string | undefined;
 }
+/**
+ * @public
+ */
 export declare enum ProfileType {
     LOCAL = "LOCAL",
     PARTNER = "PARTNER"
 }
+/**
+ * @public
+ */
 export interface CreateProfileRequest {
     /**
      * <p>The <code>As2Id</code> is the <i>AS2-name</i>, as defined in the
@@ -596,17 +672,24 @@ export interface CreateProfileRequest {
      */
     Tags?: Tag[];
 }
+/**
+ * @public
+ */
 export interface CreateProfileResponse {
     /**
      * <p>The unique identifier for the AS2 profile, returned after the API call succeeds.</p>
      */
     ProfileId: string | undefined;
 }
+/**
+ * @public
+ */
 export declare enum Domain {
     EFS = "EFS",
     S3 = "S3"
 }
 /**
+ * @public
  * <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
@@ -673,12 +756,16 @@ export interface EndpointDetails {
      */
     SecurityGroupIds?: string[];
 }
+/**
+ * @public
+ */
 export declare enum EndpointType {
     PUBLIC = "PUBLIC",
     VPC = "VPC",
     VPC_ENDPOINT = "VPC_ENDPOINT"
 }
 /**
+ * @public
  * <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>
@@ -702,22 +789,32 @@ export interface IdentityProviderDetails {
      */
     Function?: string;
 }
+/**
+ * @public
+ */
 export declare enum IdentityProviderType {
     API_GATEWAY = "API_GATEWAY",
     AWS_DIRECTORY_SERVICE = "AWS_DIRECTORY_SERVICE",
     AWS_LAMBDA = "AWS_LAMBDA",
     SERVICE_MANAGED = "SERVICE_MANAGED"
 }
+/**
+ * @public
+ */
 export declare enum SetStatOption {
     DEFAULT = "DEFAULT",
     ENABLE_NO_OP = "ENABLE_NO_OP"
 }
+/**
+ * @public
+ */
 export declare enum TlsSessionResumptionMode {
     DISABLED = "DISABLED",
     ENABLED = "ENABLED",
     ENFORCED = "ENFORCED"
 }
 /**
+ * @public
  * <p>
  *       The protocol settings that are configured for your server.
  *     </p>
@@ -798,6 +895,9 @@ export interface ProtocolDetails {
      */
     As2Transports?: (As2Transport | string)[];
 }
+/**
+ * @public
+ */
 export declare enum Protocol {
     AS2 = "AS2",
     FTP = "FTP",
@@ -805,6 +905,7 @@ export declare enum Protocol {
     SFTP = "SFTP"
 }
 /**
+ * @public
  * <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 a file is open when
@@ -822,6 +923,7 @@ export interface WorkflowDetail {
     ExecutionRole: string | undefined;
 }
 /**
+ * @public
  * <p>Container for the <code>WorkflowDetail</code> data type.
  *       It is used by actions that trigger a workflow to begin execution.</p>
  */
@@ -830,7 +932,7 @@ export interface WorkflowDetails {
      * <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>
+     *             <code>aws transfer update-server --server-id s-01234567890abcdef --workflow-details '\{"OnUpload":[]\}'</code>
      *          </p>
      */
     OnUpload?: WorkflowDetail[];
@@ -841,6 +943,9 @@ export interface WorkflowDetails {
      */
     OnPartialUpload?: WorkflowDetail[];
 }
+/**
+ * @public
+ */
 export interface CreateServerRequest {
     /**
      * <p>The Amazon Resource Name (ARN) of the Certificate Manager (ACM) certificate. Required
@@ -1081,12 +1186,18 @@ export interface CreateServerRequest {
      */
     WorkflowDetails?: WorkflowDetails;
 }
+/**
+ * @public
+ */
 export interface CreateServerResponse {
     /**
      * <p>The service-assigned identifier of the server that is created.</p>
      */
     ServerId: string | undefined;
 }
+/**
+ * @public
+ */
 export interface CreateUserRequest {
     /**
      * <p>The landing directory (folder) for a user when they log in to the server using the client.</p>
@@ -1111,8 +1222,8 @@ export interface CreateUserRequest {
      *       <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>
+     *             <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
@@ -1120,14 +1231,14 @@ export interface CreateUserRequest {
      *       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>
+     *             <code>[ \{ "Entry": "/", "Target": "/bucket_name/home/mydirectory" \} ]</code>
      *          </p>
      */
     HomeDirectoryMappings?: HomeDirectoryMapEntry[];
     /**
      * <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>
+     *      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
@@ -1195,6 +1306,9 @@ export interface CreateUserRequest {
      */
     UserName: string | undefined;
 }
+/**
+ * @public
+ */
 export interface CreateUserResponse {
     /**
      * <p>The identifier of the server that the user is attached to.</p>
@@ -1206,6 +1320,7 @@ export interface CreateUserResponse {
     UserName: string | undefined;
 }
 /**
+ * @public
  * <p>Each step type has its own <code>StepDetails</code> structure.</p>
  */
 export interface CustomStepDetails {
@@ -1226,21 +1341,25 @@ export interface CustomStepDetails {
      *     for the workflow.</p>
      *          <ul>
      *             <li>
-     *                <p>To use the previous file as the input, enter <code>${previous.file}</code>.
+     *                <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>
+     *                <p>To use the originally uploaded file location as input for this step, enter <code>$\{original.file\}</code>.</p>
      *             </li>
      *          </ul>
      */
     SourceFileLocation?: string;
 }
+/**
+ * @public
+ */
 export declare enum EncryptionType {
     PGP = "PGP"
 }
 /**
+ * @public
  * <p>Each step type has its own <code>StepDetails</code> structure.</p>
  */
 export interface DecryptStepDetails {
@@ -1257,12 +1376,12 @@ export interface DecryptStepDetails {
      *     for the workflow.</p>
      *          <ul>
      *             <li>
-     *                <p>To use the previous file as the input, enter <code>${previous.file}</code>.
+     *                <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>
+     *                <p>To use the originally uploaded file location as input for this step, enter <code>$\{original.file\}</code>.</p>
      *             </li>
      *          </ul>
      */
@@ -1278,6 +1397,7 @@ export interface DecryptStepDetails {
     DestinationFileLocation: InputFileLocation | undefined;
 }
 /**
+ * @public
  * <p>The name of the step, used to identify the delete step.</p>
  */
 export interface DeleteStepDetails {
@@ -1290,18 +1410,19 @@ export interface DeleteStepDetails {
      *     for the workflow.</p>
      *          <ul>
      *             <li>
-     *                <p>To use the previous file as the input, enter <code>${previous.file}</code>.
+     *                <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>
+     *                <p>To use the originally uploaded file location as input for this step, enter <code>$\{original.file\}</code>.</p>
      *             </li>
      *          </ul>
      */
     SourceFileLocation?: string;
 }
 /**
+ * @public
  * <p>Specifies the key-value pair that are assigned to a file during the execution of a Tagging step.</p>
  */
 export interface S3Tag {
@@ -1315,6 +1436,7 @@ export interface S3Tag {
     Value: string | undefined;
 }
 /**
+ * @public
  * <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>
  */
@@ -1332,17 +1454,20 @@ export interface TagStepDetails {
      *     for the workflow.</p>
      *          <ul>
      *             <li>
-     *                <p>To use the previous file as the input, enter <code>${previous.file}</code>.
+     *                <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>
+     *                <p>To use the originally uploaded file location as input for this step, enter <code>$\{original.file\}</code>.</p>
      *             </li>
      *          </ul>
      */
     SourceFileLocation?: string;
 }
+/**
+ * @public
+ */
 export declare enum WorkflowStepType {
     COPY = "COPY",
     CUSTOM = "CUSTOM",
@@ -1351,6 +1476,7 @@ export declare enum WorkflowStepType {
     TAG = "TAG"
 }
 /**
+ * @public
  * <p>The basic building block of a workflow.</p>
  */
 export interface WorkflowStep {
@@ -1450,6 +1576,9 @@ export interface WorkflowStep {
      */
     DecryptStepDetails?: DecryptStepDetails;
 }
+/**
+ * @public
+ */
 export interface CreateWorkflowRequest {
     /**
      * <p>A textual description for the workflow.</p>
@@ -1516,16 +1645,25 @@ export interface CreateWorkflowRequest {
      */
     Tags?: Tag[];
 }
+/**
+ * @public
+ */
 export interface CreateWorkflowResponse {
     /**
      * <p>A unique identifier for the workflow.</p>
      */
     WorkflowId: string | undefined;
 }
+/**
+ * @public
+ */
 export declare enum CustomStepStatus {
     FAILURE = "FAILURE",
     SUCCESS = "SUCCESS"
 }
+/**
+ * @public
+ */
 export interface DeleteAccessRequest {
     /**
      * <p>A system-assigned unique identifier for a server that has this user assigned.</p>
@@ -1537,7 +1675,7 @@ export interface DeleteAccessRequest {
      *     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>
+     *             <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.
@@ -1545,6 +1683,9 @@ export interface DeleteAccessRequest {
      */
     ExternalId: string | undefined;
 }
+/**
+ * @public
+ */
 export interface DeleteAgreementRequest {
     /**
      * <p>A unique identifier for the agreement. This identifier is returned when you create an agreement.</p>
@@ -1555,18 +1696,27 @@ export interface DeleteAgreementRequest {
      */
     ServerId: string | undefined;
 }
+/**
+ * @public
+ */
 export interface DeleteCertificateRequest {
     /**
      * <p>The identifier of the certificate object that you are deleting.</p>
      */
     CertificateId: string | undefined;
 }
+/**
+ * @public
+ */
 export interface DeleteConnectorRequest {
     /**
      * <p>The unique identifier for the connector.</p>
      */
     ConnectorId: string | undefined;
 }
+/**
+ * @public
+ */
 export interface DeleteHostKeyRequest {
     /**
      * <p>The identifier of the server that contains the host key that you are deleting.</p>
@@ -1577,18 +1727,27 @@ export interface DeleteHostKeyRequest {
      */
     HostKeyId: string | undefined;
 }
+/**
+ * @public
+ */
 export interface DeleteProfileRequest {
     /**
      * <p>The identifier of the profile that you are deleting.</p>
      */
     ProfileId: string | undefined;
 }
+/**
+ * @public
+ */
 export interface DeleteServerRequest {
     /**
      * <p>A unique system-assigned identifier for a server instance.</p>
      */
     ServerId: string | undefined;
 }
+/**
+ * @public
+ */
 export interface DeleteSshPublicKeyRequest {
     /**
      * <p>A system-assigned unique identifier for a file transfer protocol-enabled server instance
@@ -1604,6 +1763,9 @@ export interface DeleteSshPublicKeyRequest {
      */
     UserName: string | undefined;
 }
+/**
+ * @public
+ */
 export interface DeleteUserRequest {
     /**
      * <p>A system-assigned unique identifier for a server instance that has the user assigned to
@@ -1615,12 +1777,18 @@ export interface DeleteUserRequest {
      */
     UserName: string | undefined;
 }
+/**
+ * @public
+ */
 export interface DeleteWorkflowRequest {
     /**
      * <p>A unique identifier for the workflow.</p>
      */
     WorkflowId: string | undefined;
 }
+/**
+ * @public
+ */
 export interface DescribeAccessRequest {
     /**
      * <p>A system-assigned unique identifier for a server that has this access assigned.</p>
@@ -1632,7 +1800,7 @@ export interface DescribeAccessRequest {
      *     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>
+     *             <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.
@@ -1641,6 +1809,7 @@ export interface DescribeAccessRequest {
     ExternalId: string | undefined;
 }
 /**
+ * @public
  * <p>Describes the properties of the access that was specified.</p>
  */
 export interface DescribedAccess {
@@ -1673,8 +1842,8 @@ export interface DescribedAccess {
     HomeDirectoryType?: HomeDirectoryType | string;
     /**
      * <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>
+     *      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>
      */
     Policy?: string;
     /**
@@ -1698,7 +1867,7 @@ export interface DescribedAccess {
      *     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>
+     *             <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.
@@ -1706,6 +1875,9 @@ export interface DescribedAccess {
      */
     ExternalId?: string;
 }
+/**
+ * @public
+ */
 export interface DescribeAccessResponse {
     /**
      * <p>A system-assigned unique identifier for a server that has this access assigned.</p>
@@ -1716,6 +1888,9 @@ export interface DescribeAccessResponse {
      */
     Access: DescribedAccess | undefined;
 }
+/**
+ * @public
+ */
 export interface DescribeAgreementRequest {
     /**
      * <p>A unique identifier for the agreement. This identifier is returned when you create an agreement.</p>
@@ -1727,6 +1902,7 @@ export interface DescribeAgreementRequest {
     ServerId: string | undefined;
 }
 /**
+ * @public
  * <p>Describes the properties of an agreement.</p>
  */
 export interface DescribedAgreement {
@@ -1783,6 +1959,9 @@ export interface DescribedAgreement {
      */
     Tags?: Tag[];
 }
+/**
+ * @public
+ */
 export interface DescribeAgreementResponse {
     /**
      * <p>The details for the specified agreement, returned as a <code>DescribedAgreement</code>
@@ -1790,6 +1969,9 @@ export interface DescribeAgreementResponse {
      */
     Agreement: DescribedAgreement | undefined;
 }
+/**
+ * @public
+ */
 export interface DescribeCertificateRequest {
     /**
      * <p>An array of identifiers for the imported certificates. You use this identifier for working with profiles and partner profiles.</p>
@@ -1797,6 +1979,7 @@ export interface DescribeCertificateRequest {
     CertificateId: string | undefined;
 }
 /**
+ * @public
  * <p>Describes the properties of a certificate.</p>
  */
 export interface DescribedCertificate {
@@ -1860,12 +2043,18 @@ export interface DescribedCertificate {
      */
     Tags?: Tag[];
 }
+/**
+ * @public
+ */
 export interface DescribeCertificateResponse {
     /**
      * <p>The details for the specified certificate, returned as an object.</p>
      */
     Certificate: DescribedCertificate | undefined;
 }
+/**
+ * @public
+ */
 export interface DescribeConnectorRequest {
     /**
      * <p>The unique identifier for the connector.</p>
@@ -1873,6 +2062,7 @@ export interface DescribeConnectorRequest {
     ConnectorId: string | undefined;
 }
 /**
+ * @public
  * <p>Describes the parameters for the connector, as identified by the
  *       <code>ConnectorId</code>.</p>
  */
@@ -1917,6 +2107,9 @@ export interface DescribedConnector {
      */
     Tags?: Tag[];
 }
+/**
+ * @public
+ */
 export interface DescribeConnectorResponse {
     /**
      * <p>The structure that contains the details of the connector.</p>
@@ -1924,6 +2117,7 @@ export interface DescribeConnectorResponse {
     Connector: DescribedConnector | undefined;
 }
 /**
+ * @public
  * <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>
  */
 export interface S3FileLocation {
@@ -1945,6 +2139,7 @@ export interface S3FileLocation {
     Etag?: string;
 }
 /**
+ * @public
  * <p>Specifies the Amazon S3 or EFS file details to be used in the step.</p>
  */
 export interface FileLocation {
@@ -1959,6 +2154,7 @@ export interface FileLocation {
     EfsFileLocation?: EfsFileLocation;
 }
 /**
+ * @public
  * <p>Consists of the logging role and the log group name.</p>
  */
 export interface LoggingConfiguration {
@@ -1973,6 +2169,9 @@ export interface LoggingConfiguration {
      */
     LogGroupName?: string;
 }
+/**
+ * @public
+ */
 export declare enum ExecutionErrorType {
     ALREADY_EXISTS = "ALREADY_EXISTS",
     BAD_REQUEST = "BAD_REQUEST",
@@ -1984,6 +2183,7 @@ export declare enum ExecutionErrorType {
     TIMEOUT = "TIMEOUT"
 }
 /**
+ * @public
  * <p>Specifies the error message and type, for an error that occurs during the execution of the workflow.</p>
  */
 export interface ExecutionError {
@@ -2039,6 +2239,7 @@ export interface ExecutionError {
     Message: string | undefined;
 }
 /**
+ * @public
  * <p>Specifies the following details for the step: error (if any), outputs (if any), and the step type.</p>
  */
 export interface ExecutionStepResult {
@@ -2089,6 +2290,7 @@ export interface ExecutionStepResult {
     Error?: ExecutionError;
 }
 /**
+ * @public
  * <p>Specifies the steps in the workflow, as well as the steps to execute in case of any errors during workflow execution.</p>
  */
 export interface ExecutionResults {
@@ -2102,6 +2304,7 @@ export interface ExecutionResults {
     OnExceptionSteps?: ExecutionStepResult[];
 }
 /**
+ * @public
  * <p>Specifies the user name, server ID, and session ID for a workflow.</p>
  */
 export interface UserDetails {
@@ -2119,6 +2322,7 @@ export interface UserDetails {
     SessionId?: string;
 }
 /**
+ * @public
  * <p>A container object for the session details that are associated with a workflow.</p>
  */
 export interface ServiceMetadata {
@@ -2127,6 +2331,9 @@ export interface ServiceMetadata {
      */
     UserDetails: UserDetails | undefined;
 }
+/**
+ * @public
+ */
 export declare enum ExecutionStatus {
     COMPLETED = "COMPLETED",
     EXCEPTION = "EXCEPTION",
@@ -2134,6 +2341,7 @@ export declare enum ExecutionStatus {
     IN_PROGRESS = "IN_PROGRESS"
 }
 /**
+ * @public
  * <p>The details for an execution object.</p>
  */
 export interface DescribedExecution {
@@ -2179,6 +2387,7 @@ export interface DescribedExecution {
     Results?: ExecutionResults;
 }
 /**
+ * @public
  * <p>The details for a server host key.</p>
  */
 export interface DescribedHostKey {
@@ -2240,6 +2449,7 @@ export interface DescribedHostKey {
     Tags?: Tag[];
 }
 /**
+ * @public
  * <p>The details for a local or partner AS2 profile. </p>
  */
 export interface DescribedProfile {
@@ -2273,6 +2483,7 @@ export interface DescribedProfile {
     Tags?: Tag[];
 }
 /**
+ * @public
  * <p>Describes the properties of a security policy that was specified. For more information
  *       about security policies, see <a href="https://docs.aws.amazon.com/transfer/latest/userguide/security-policies.html">Working with security
  *         policies</a>.</p>
@@ -2308,6 +2519,9 @@ export interface DescribedSecurityPolicy {
      */
     TlsCiphers?: string[];
 }
+/**
+ * @public
+ */
 export declare enum State {
     OFFLINE = "OFFLINE",
     ONLINE = "ONLINE",
@@ -2317,6 +2531,7 @@ export declare enum State {
     STOP_FAILED = "STOP_FAILED"
 }
 /**
+ * @public
  * <p>Describes the properties of a file transfer protocol-enabled server that was
  *       specified.</p>
  */
@@ -2516,6 +2731,7 @@ export interface DescribedServer {
     WorkflowDetails?: WorkflowDetails;
 }
 /**
+ * @public
  * <p>Provides information about the public Secure Shell (SSH) key that is associated with a
  *       user account 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
@@ -2540,6 +2756,7 @@ export interface SshPublicKey {
     SshPublicKeyId: string | undefined;
 }
 /**
+ * @public
  * <p>Describes the properties of a user that was specified.</p>
  */
 export interface DescribedUser {
@@ -2577,8 +2794,8 @@ export interface DescribedUser {
     HomeDirectoryType?: HomeDirectoryType | string;
     /**
      * <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>
+     *      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>
      */
     Policy?: string;
     /**
@@ -2615,6 +2832,7 @@ export interface DescribedUser {
     UserName?: string;
 }
 /**
+ * @public
  * <p>Describes the properties of the specified workflow</p>
  */
 export interface DescribedWorkflow {
@@ -2643,6 +2861,9 @@ export interface DescribedWorkflow {
      */
     Tags?: Tag[];
 }
+/**
+ * @public
+ */
 export interface DescribeExecutionRequest {
     /**
      * <p>A unique identifier for the execution of a workflow.</p>
@@ -2653,6 +2874,9 @@ export interface DescribeExecutionRequest {
      */
     WorkflowId: string | undefined;
 }
+/**
+ * @public
+ */
 export interface DescribeExecutionResponse {
     /**
      * <p>A unique identifier for the workflow.</p>
@@ -2663,6 +2887,9 @@ export interface DescribeExecutionResponse {
      */
     Execution: DescribedExecution | undefined;
 }
+/**
+ * @public
+ */
 export interface DescribeHostKeyRequest {
     /**
      * <p>The identifier of the server that contains the host key that you want described.</p>
@@ -2673,42 +2900,63 @@ export interface DescribeHostKeyRequest {
      */
     HostKeyId: string | undefined;
 }
+/**
+ * @public
+ */
 export interface DescribeHostKeyResponse {
     /**
      * <p>Returns the details for the specified host key.</p>
      */
     HostKey: DescribedHostKey | undefined;
 }
+/**
+ * @public
+ */
 export interface DescribeProfileRequest {
     /**
      * <p>The identifier of the profile that you want described.</p>
      */
     ProfileId: string | undefined;
 }
+/**
+ * @public
+ */
 export interface DescribeProfileResponse {
     /**
      * <p>The details of the specified profile, returned as an object.</p>
      */
     Profile: DescribedProfile | undefined;
 }
+/**
+ * @public
+ */
 export interface DescribeSecurityPolicyRequest {
     /**
      * <p>Specifies the name of the security policy that is attached to the server.</p>
      */
     SecurityPolicyName: string | undefined;
 }
+/**
+ * @public
+ */
 export interface DescribeSecurityPolicyResponse {
     /**
      * <p>An array containing the properties of the security policy.</p>
      */
     SecurityPolicy: DescribedSecurityPolicy | undefined;
 }
+/**
+ * @public
+ */
 export interface DescribeServerRequest {
     /**
      * <p>A system-assigned unique identifier for a server.</p>
      */
     ServerId: string | undefined;
 }
+/**
+ * @public
+ */
 export interface DescribeServerResponse {
     /**
      * <p>An array containing the properties of a server with the <code>ServerID</code> you
@@ -2716,6 +2964,9 @@ export interface DescribeServerResponse {
      */
     Server: DescribedServer | undefined;
 }
+/**
+ * @public
+ */
 export interface DescribeUserRequest {
     /**
      * <p>A system-assigned unique identifier for a server that has this user assigned.</p>
@@ -2727,6 +2978,9 @@ export interface DescribeUserRequest {
      */
     UserName: string | undefined;
 }
+/**
+ * @public
+ */
 export interface DescribeUserResponse {
     /**
      * <p>A system-assigned unique identifier for a server that has this user assigned.</p>
@@ -2738,18 +2992,27 @@ export interface DescribeUserResponse {
      */
     User: DescribedUser | undefined;
 }
+/**
+ * @public
+ */
 export interface DescribeWorkflowRequest {
     /**
      * <p>A unique identifier for the workflow.</p>
      */
     WorkflowId: string | undefined;
 }
+/**
+ * @public
+ */
 export interface DescribeWorkflowResponse {
     /**
      * <p>The structure that contains the details of the workflow.</p>
      */
     Workflow: DescribedWorkflow | undefined;
 }
+/**
+ * @public
+ */
 export interface ImportCertificateRequest {
     /**
      * <p>Specifies whether this certificate is used for signing or encryption.</p>
@@ -2802,12 +3065,18 @@ export interface ImportCertificateRequest {
      */
     Tags?: Tag[];
 }
+/**
+ * @public
+ */
 export interface ImportCertificateResponse {
     /**
      * <p>An array of identifiers for the imported certificates. You use this identifier for working with profiles and partner profiles.</p>
      */
     CertificateId: string | undefined;
 }
+/**
+ * @public
+ */
 export interface ImportHostKeyRequest {
     /**
      * <p>The identifier of the server that contains the host key that you are importing.</p>
@@ -2827,6 +3096,9 @@ export interface ImportHostKeyRequest {
      */
     Tags?: Tag[];
 }
+/**
+ * @public
+ */
 export interface ImportHostKeyResponse {
     /**
      * <p>Returns the server identifier that contains the imported key.</p>
@@ -2837,6 +3109,9 @@ export interface ImportHostKeyResponse {
      */
     HostKeyId: string | undefined;
 }
+/**
+ * @public
+ */
 export interface ImportSshPublicKeyRequest {
     /**
      * <p>A system-assigned unique identifier for a server.</p>
@@ -2853,6 +3128,7 @@ export interface ImportSshPublicKeyRequest {
     UserName: string | undefined;
 }
 /**
+ * @public
  * <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>
@@ -2872,6 +3148,7 @@ export interface ImportSshPublicKeyResponse {
     UserName: string | undefined;
 }
 /**
+ * @public
  * <p>The <code>NextToken</code> parameter that was passed is invalid.</p>
  */
 export declare class InvalidNextTokenException extends __BaseException {
@@ -2883,6 +3160,9 @@ export declare class InvalidNextTokenException extends __BaseException {
      */
     constructor(opts: __ExceptionOptionType<InvalidNextTokenException, __BaseException>);
 }
+/**
+ * @public
+ */
 export interface ListAccessesRequest {
     /**
      * <p>Specifies the maximum number of access SIDs to return.</p>
@@ -2901,6 +3181,7 @@ export interface ListAccessesRequest {
     ServerId: string | undefined;
 }
 /**
+ * @public
  * <p>Lists the properties for one or more specified associated accesses.</p>
  */
 export interface ListedAccess {
@@ -2929,7 +3210,7 @@ export interface ListedAccess {
      *     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>
+     *             <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.
@@ -2937,6 +3218,9 @@ export interface ListedAccess {
      */
     ExternalId?: string;
 }
+/**
+ * @public
+ */
 export interface ListAccessesResponse {
     /**
      * <p>When you can get additional results from the <code>ListAccesses</code> call, a
@@ -2955,6 +3239,9 @@ export interface ListAccessesResponse {
      */
     Accesses: ListedAccess[] | undefined;
 }
+/**
+ * @public
+ */
 export interface ListAgreementsRequest {
     /**
      * <p>The maximum number of agreements to return.</p>
@@ -2973,6 +3260,7 @@ export interface ListAgreementsRequest {
     ServerId: string | undefined;
 }
 /**
+ * @public
  * <p>Describes the properties of an agreement.</p>
  */
 export interface ListedAgreement {
@@ -3006,6 +3294,9 @@ export interface ListedAgreement {
      */
     PartnerProfileId?: string;
 }
+/**
+ * @public
+ */
 export interface ListAgreementsResponse {
     /**
      * <p>Returns a token that you can use to call <code>ListAgreements</code> again and receive
@@ -3017,6 +3308,9 @@ export interface ListAgreementsResponse {
      */
     Agreements: ListedAgreement[] | undefined;
 }
+/**
+ * @public
+ */
 export interface ListCertificatesRequest {
     /**
      * <p>The maximum number of certificates to return.</p>
@@ -3031,6 +3325,7 @@ export interface ListCertificatesRequest {
     NextToken?: string;
 }
 /**
+ * @public
  * <p>Describes the properties of a certificate.</p>
  */
 export interface ListedCertificate {
@@ -3071,6 +3366,9 @@ export interface ListedCertificate {
      */
     Description?: string;
 }
+/**
+ * @public
+ */
 export interface ListCertificatesResponse {
     /**
      * <p>Returns the next token, which you can use to list the next certificate.</p>
@@ -3082,6 +3380,9 @@ export interface ListCertificatesResponse {
      */
     Certificates: ListedCertificate[] | undefined;
 }
+/**
+ * @public
+ */
 export interface ListConnectorsRequest {
     /**
      * <p>The maximum number of connectors to return.</p>
@@ -3096,6 +3397,7 @@ export interface ListConnectorsRequest {
     NextToken?: string;
 }
 /**
+ * @public
  * <p>Returns details of the connector that is specified.</p>
  */
 export interface ListedConnector {
@@ -3112,6 +3414,9 @@ export interface ListedConnector {
      */
     Url?: string;
 }
+/**
+ * @public
+ */
 export interface ListConnectorsResponse {
     /**
      * <p>Returns a token that you can use to call <code>ListConnectors</code> again and receive
@@ -3124,6 +3429,7 @@ export interface ListConnectorsResponse {
     Connectors: ListedConnector[] | undefined;
 }
 /**
+ * @public
  * <p>Returns properties of the execution that is specified.</p>
  */
 export interface ListedExecution {
@@ -3147,6 +3453,7 @@ export interface ListedExecution {
     Status?: ExecutionStatus | string;
 }
 /**
+ * @public
  * <p>Returns properties of the host key that's specified.</p>
  */
 export interface ListedHostKey {
@@ -3204,6 +3511,7 @@ export interface ListedHostKey {
     DateImported?: Date;
 }
 /**
+ * @public
  * <p>Returns the properties of the profile that was specified.</p>
  */
 export interface ListedProfile {
@@ -3229,6 +3537,7 @@ export interface ListedProfile {
     ProfileType?: ProfileType | string;
 }
 /**
+ * @public
  * <p>Returns properties of a file transfer protocol-enabled server that was specified.</p>
  */
 export interface ListedServer {
@@ -3289,6 +3598,7 @@ export interface ListedServer {
     UserCount?: number;
 }
 /**
+ * @public
  * <p>Returns properties of the user that you specify.</p>
  */
 export interface ListedUser {
@@ -3333,6 +3643,7 @@ export interface ListedUser {
     UserName?: string;
 }
 /**
+ * @public
  * <p>Contains the identifier, text description, and Amazon Resource Name (ARN) for the
  *       workflow.</p>
  */
@@ -3350,6 +3661,9 @@ export interface ListedWorkflow {
      */
     Arn?: string;
 }
+/**
+ * @public
+ */
 export interface ListExecutionsRequest {
     /**
      * <p>Specifies the maximum number of executions to return.</p>
@@ -3385,6 +3699,9 @@ export interface ListExecutionsRequest {
      */
     WorkflowId: string | undefined;
 }
+/**
+ * @public
+ */
 export interface ListExecutionsResponse {
     /**
      * <p>
@@ -3424,6 +3741,9 @@ export interface ListExecutionsResponse {
      */
     Executions: ListedExecution[] | undefined;
 }
+/**
+ * @public
+ */
 export interface ListHostKeysRequest {
     /**
      * <p>The maximum number of host keys to return.</p>
@@ -3440,6 +3760,9 @@ export interface ListHostKeysRequest {
      */
     ServerId: string | undefined;
 }
+/**
+ * @public
+ */
 export interface ListHostKeysResponse {
     /**
      * <p>Returns a token that you can use to call <code>ListHostKeys</code> again and receive
@@ -3455,6 +3778,9 @@ export interface ListHostKeysResponse {
      */
     HostKeys: ListedHostKey[] | undefined;
 }
+/**
+ * @public
+ */
 export interface ListProfilesRequest {
     /**
      * <p>The maximum number of profiles to return.</p>
@@ -3472,6 +3798,9 @@ export interface ListProfilesRequest {
      */
     ProfileType?: ProfileType | string;
 }
+/**
+ * @public
+ */
 export interface ListProfilesResponse {
     /**
      * <p>Returns a token that you can use to call <code>ListProfiles</code> again and receive
@@ -3483,6 +3812,9 @@ export interface ListProfilesResponse {
      */
     Profiles: ListedProfile[] | undefined;
 }
+/**
+ * @public
+ */
 export interface ListSecurityPoliciesRequest {
     /**
      * <p>Specifies the number of security policies to return as a response to the
@@ -3497,6 +3829,9 @@ export interface ListSecurityPoliciesRequest {
      */
     NextToken?: string;
 }
+/**
+ * @public
+ */
 export interface ListSecurityPoliciesResponse {
     /**
      * <p>When you can get additional results from the <code>ListSecurityPolicies</code> operation,
@@ -3509,6 +3844,9 @@ export interface ListSecurityPoliciesResponse {
      */
     SecurityPolicyNames: string[] | undefined;
 }
+/**
+ * @public
+ */
 export interface ListServersRequest {
     /**
      * <p>Specifies the number of servers to return as a response to the <code>ListServers</code>
@@ -3523,6 +3861,9 @@ export interface ListServersRequest {
      */
     NextToken?: string;
 }
+/**
+ * @public
+ */
 export interface ListServersResponse {
     /**
      * <p>When you can get additional results from the <code>ListServers</code> operation, a
@@ -3535,6 +3876,9 @@ export interface ListServersResponse {
      */
     Servers: ListedServer[] | undefined;
 }
+/**
+ * @public
+ */
 export interface ListTagsForResourceRequest {
     /**
      * <p>Requests the tags associated with a particular Amazon Resource Name (ARN). An ARN is an
@@ -3553,6 +3897,9 @@ export interface ListTagsForResourceRequest {
      */
     NextToken?: string;
 }
+/**
+ * @public
+ */
 export interface ListTagsForResourceResponse {
     /**
      * <p>The ARN you specified to list the tags of.</p>
@@ -3571,6 +3918,9 @@ export interface ListTagsForResourceResponse {
      */
     Tags?: Tag[];
 }
+/**
+ * @public
+ */
 export interface ListUsersRequest {
     /**
      * <p>Specifies the number of users to return as a response to the <code>ListUsers</code>
@@ -3589,6 +3939,9 @@ export interface ListUsersRequest {
      */
     ServerId: string | undefined;
 }
+/**
+ * @public
+ */
 export interface ListUsersResponse {
     /**
      * <p>When you can get additional results from the <code>ListUsers</code> call, a
@@ -3607,6 +3960,9 @@ export interface ListUsersResponse {
      */
     Users: ListedUser[] | undefined;
 }
+/**
+ * @public
+ */
 export interface ListWorkflowsRequest {
     /**
      * <p>Specifies the maximum number of workflows to return.</p>
@@ -3620,6 +3976,9 @@ export interface ListWorkflowsRequest {
      */
     NextToken?: string;
 }
+/**
+ * @public
+ */
 export interface ListWorkflowsResponse {
     /**
      * <p>
@@ -3633,6 +3992,9 @@ export interface ListWorkflowsResponse {
      */
     Workflows: ListedWorkflow[] | undefined;
 }
+/**
+ * @public
+ */
 export interface SendWorkflowStepStateRequest {
     /**
      * <p>A unique identifier for the workflow.</p>
@@ -3651,8 +4013,14 @@ export interface SendWorkflowStepStateRequest {
      */
     Status: CustomStepStatus | string | undefined;
 }
+/**
+ * @public
+ */
 export interface SendWorkflowStepStateResponse {
 }
+/**
+ * @public
+ */
 export interface StartFileTransferRequest {
     /**
      * <p>The unique identifier for the connector. </p>
@@ -3666,24 +4034,36 @@ export interface StartFileTransferRequest {
      */
     SendFilePaths: string[] | undefined;
 }
+/**
+ * @public
+ */
 export interface StartFileTransferResponse {
     /**
      * <p>Returns the unique identifier for this file transfer. </p>
      */
     TransferId: string | undefined;
 }
+/**
+ * @public
+ */
 export interface StartServerRequest {
     /**
      * <p>A system-assigned unique identifier for a server that you start.</p>
      */
     ServerId: string | undefined;
 }
+/**
+ * @public
+ */
 export interface StopServerRequest {
     /**
      * <p>A system-assigned unique identifier for a server that you stopped.</p>
      */
     ServerId: string | undefined;
 }
+/**
+ * @public
+ */
 export interface TagResourceRequest {
     /**
      * <p>An Amazon Resource Name (ARN) for a specific Amazon Web Services resource, such as a server, user, or
@@ -3696,6 +4076,9 @@ export interface TagResourceRequest {
      */
     Tags: Tag[] | undefined;
 }
+/**
+ * @public
+ */
 export interface TestIdentityProviderRequest {
     /**
      * <p>A system-assigned identifier for a specific server. That server's user authentication
@@ -3731,6 +4114,9 @@ export interface TestIdentityProviderRequest {
      */
     UserPassword?: string;
 }
+/**
+ * @public
+ */
 export interface TestIdentityProviderResponse {
     /**
      * <p>The response that is returned from your API Gateway.</p>
@@ -3752,6 +4138,9 @@ export interface TestIdentityProviderResponse {
      */
     Url: string | undefined;
 }
+/**
+ * @public
+ */
 export interface UntagResourceRequest {
     /**
      * <p>The value of the resource that will have the tag removed. An Amazon Resource Name (ARN) is
@@ -3764,6 +4153,9 @@ export interface UntagResourceRequest {
      */
     TagKeys: string[] | undefined;
 }
+/**
+ * @public
+ */
 export interface UpdateAccessRequest {
     /**
      * <p>The landing directory (folder) for a user when they log in to the server using the client.</p>
@@ -3788,7 +4180,7 @@ export interface UpdateAccessRequest {
      *       <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>
+     *             <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
@@ -3796,14 +4188,14 @@ export interface UpdateAccessRequest {
      *         <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>
+     *             <code>[ \{ "Entry": "/", "Target": "/bucket_name/home/mydirectory" \} ]</code>
      *          </p>
      */
     HomeDirectoryMappings?: HomeDirectoryMapEntry[];
     /**
      * <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>
+     *      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
@@ -3841,7 +4233,7 @@ export interface UpdateAccessRequest {
      *     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>
+     *             <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.
@@ -3849,6 +4241,9 @@ export interface UpdateAccessRequest {
      */
     ExternalId: string | undefined;
 }
+/**
+ * @public
+ */
 export interface UpdateAccessResponse {
     /**
      * <p>The identifier of the server that the user is attached to.</p>
@@ -3860,6 +4255,9 @@ export interface UpdateAccessResponse {
      */
     ExternalId: string | undefined;
 }
+/**
+ * @public
+ */
 export interface UpdateAgreementRequest {
     /**
      * <p>A unique identifier for the agreement. This identifier is returned when you create an agreement.</p>
@@ -3910,12 +4308,18 @@ export interface UpdateAgreementRequest {
      */
     AccessRole?: string;
 }
+/**
+ * @public
+ */
 export interface UpdateAgreementResponse {
     /**
      * <p>A unique identifier for the agreement. This identifier is returned when you create an agreement.</p>
      */
     AgreementId: string | undefined;
 }
+/**
+ * @public
+ */
 export interface UpdateCertificateRequest {
     /**
      * <p>The identifier of the certificate object that you are updating.</p>
@@ -3934,12 +4338,18 @@ export interface UpdateCertificateRequest {
      */
     Description?: string;
 }
+/**
+ * @public
+ */
 export interface UpdateCertificateResponse {
     /**
      * <p>Returns the identifier of the certificate object that you are updating.</p>
      */
     CertificateId: string | undefined;
 }
+/**
+ * @public
+ */
 export interface UpdateConnectorRequest {
     /**
      * <p>The unique identifier for the connector.</p>
@@ -3973,12 +4383,18 @@ export interface UpdateConnectorRequest {
      */
     LoggingRole?: string;
 }
+/**
+ * @public
+ */
 export interface UpdateConnectorResponse {
     /**
      * <p>Returns the identifier of the connector object that you are updating.</p>
      */
     ConnectorId: string | undefined;
 }
+/**
+ * @public
+ */
 export interface UpdateHostKeyRequest {
     /**
      * <p>The identifier of the server that contains the host key that you are updating.</p>
@@ -3993,6 +4409,9 @@ export interface UpdateHostKeyRequest {
      */
     Description: string | undefined;
 }
+/**
+ * @public
+ */
 export interface UpdateHostKeyResponse {
     /**
      * <p>Returns the server identifier for the server that contains the updated host key.</p>
@@ -4003,6 +4422,9 @@ export interface UpdateHostKeyResponse {
      */
     HostKeyId: string | undefined;
 }
+/**
+ * @public
+ */
 export interface UpdateProfileRequest {
     /**
      * <p>The identifier of the profile object that you are updating.</p>
@@ -4013,12 +4435,18 @@ export interface UpdateProfileRequest {
      */
     CertificateIds?: string[];
 }
+/**
+ * @public
+ */
 export interface UpdateProfileResponse {
     /**
      * <p>Returns the identifier for the profile that's being updated.</p>
      */
     ProfileId: string | undefined;
 }
+/**
+ * @public
+ */
 export interface UpdateServerRequest {
     /**
      * <p>The Amazon Resource Name (ARN) of the Amazon Web ServicesCertificate Manager (ACM) certificate. Required
@@ -4231,11 +4659,14 @@ export interface UpdateServerRequest {
      *     the session disconnects.</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>
+     *             <code>aws transfer update-server --server-id s-01234567890abcdef --workflow-details '\{"OnUpload":[]\}'</code>
      *          </p>
      */
     WorkflowDetails?: WorkflowDetails;
 }
+/**
+ * @public
+ */
 export interface UpdateServerResponse {
     /**
      * <p>A system-assigned unique identifier for a server that the user account is assigned
@@ -4243,6 +4674,9 @@ export interface UpdateServerResponse {
      */
     ServerId: string | undefined;
 }
+/**
+ * @public
+ */
 export interface UpdateUserRequest {
     /**
      * <p>The landing directory (folder) for a user when they log in to the server using the client.</p>
@@ -4267,7 +4701,7 @@ export interface UpdateUserRequest {
      *       <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>
+     *             <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
@@ -4275,14 +4709,14 @@ export interface UpdateUserRequest {
      *       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>
+     *             <code>[ \{ "Entry": "/", "Target": "/bucket_name/home/mydirectory" \} ]</code>
      *          </p>
      */
     HomeDirectoryMappings?: HomeDirectoryMapEntry[];
     /**
      * <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>
+     *      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
@@ -4325,6 +4759,7 @@ export interface UpdateUserRequest {
     UserName: string | undefined;
 }
 /**
+ * @public
  * <p>
  *             <code>UpdateUserResponse</code> returns the user name and identifier for the request to
  *       update a user's properties.</p>