@aws-sdk/client-transfer 3.296.0 → 3.297.0

package/dist-types/Transfer.d.ts

@@ -59,6 +59,7 @@ import { UpdateServerCommandInput, UpdateServerCommandOutput } from "./commands/
 import { UpdateUserCommandInput, UpdateUserCommandOutput } from "./commands/UpdateUserCommand";
 import { TransferClient } from "./TransferClient";
 /**
+ * @public
  * <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.
@@ -72,6 +73,7 @@ import { TransferClient } from "./TransferClient";
  */
 export declare class Transfer extends TransferClient {
     /**
+     * @public
      * <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
@@ -83,6 +85,7 @@ export declare class Transfer extends TransferClient {
     createAccess(args: CreateAccessCommandInput, cb: (err: any, data?: CreateAccessCommandOutput) => void): void;
     createAccess(args: CreateAccessCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateAccessCommandOutput) => void): void;
     /**
+     * @public
      * <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
@@ -94,6 +97,7 @@ export declare class Transfer extends TransferClient {
     createAgreement(args: CreateAgreementCommandInput, cb: (err: any, data?: CreateAgreementCommandOutput) => void): void;
     createAgreement(args: CreateAgreementCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateAgreementCommandOutput) => void): void;
     /**
+     * @public
      * <p>Creates the connector, which captures the parameters for an outbound connection for the
      *       AS2 protocol. The connector is required for sending files to an externally hosted AS2 server.
      *       For more details about connectors, see <a href="https://docs.aws.amazon.com/transfer/latest/userguide/create-b2b-server.html#configure-as2-connector">Create AS2 connectors</a>.</p>
@@ -102,12 +106,14 @@ export declare class Transfer extends TransferClient {
     createConnector(args: CreateConnectorCommandInput, cb: (err: any, data?: CreateConnectorCommandOutput) => void): void;
     createConnector(args: CreateConnectorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateConnectorCommandOutput) => void): void;
     /**
+     * @public
      * <p>Creates the local or partner profile to use for AS2 transfers.</p>
      */
     createProfile(args: CreateProfileCommandInput, options?: __HttpHandlerOptions): Promise<CreateProfileCommandOutput>;
     createProfile(args: CreateProfileCommandInput, cb: (err: any, data?: CreateProfileCommandOutput) => void): void;
     createProfile(args: CreateProfileCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateProfileCommandOutput) => void): void;
     /**
+     * @public
      * <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
@@ -117,6 +123,7 @@ export declare class Transfer extends TransferClient {
     createServer(args: CreateServerCommandInput, cb: (err: any, data?: CreateServerCommandOutput) => void): void;
     createServer(args: CreateServerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateServerCommandOutput) => void): void;
     /**
+     * @public
      * <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
@@ -129,6 +136,7 @@ export declare class Transfer extends TransferClient {
     createUser(args: CreateUserCommandInput, cb: (err: any, data?: CreateUserCommandOutput) => void): void;
     createUser(args: CreateUserCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateUserCommandOutput) => void): void;
     /**
+     * @public
      * <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.
@@ -138,6 +146,7 @@ export declare class Transfer extends TransferClient {
     createWorkflow(args: CreateWorkflowCommandInput, cb: (err: any, data?: CreateWorkflowCommandOutput) => void): void;
     createWorkflow(args: CreateWorkflowCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateWorkflowCommandOutput) => void): void;
     /**
+     * @public
      * <p>Allows you to delete the access specified in the <code>ServerID</code> and
      *       <code>ExternalID</code> parameters.</p>
      */
@@ -145,12 +154,14 @@ export declare class Transfer extends TransferClient {
     deleteAccess(args: DeleteAccessCommandInput, cb: (err: any, data?: DeleteAccessCommandOutput) => void): void;
     deleteAccess(args: DeleteAccessCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteAccessCommandOutput) => void): void;
     /**
+     * @public
      * <p>Delete the agreement that's specified in the provided <code>AgreementId</code>.</p>
      */
     deleteAgreement(args: DeleteAgreementCommandInput, options?: __HttpHandlerOptions): Promise<DeleteAgreementCommandOutput>;
     deleteAgreement(args: DeleteAgreementCommandInput, cb: (err: any, data?: DeleteAgreementCommandOutput) => void): void;
     deleteAgreement(args: DeleteAgreementCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteAgreementCommandOutput) => void): void;
     /**
+     * @public
      * <p>Deletes the certificate that's specified in the <code>CertificateId</code>
      *       parameter.</p>
      */
@@ -158,24 +169,28 @@ export declare class Transfer extends TransferClient {
     deleteCertificate(args: DeleteCertificateCommandInput, cb: (err: any, data?: DeleteCertificateCommandOutput) => void): void;
     deleteCertificate(args: DeleteCertificateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteCertificateCommandOutput) => void): void;
     /**
+     * @public
      * <p>Deletes the agreement that's specified in the provided <code>ConnectorId</code>.</p>
      */
     deleteConnector(args: DeleteConnectorCommandInput, options?: __HttpHandlerOptions): Promise<DeleteConnectorCommandOutput>;
     deleteConnector(args: DeleteConnectorCommandInput, cb: (err: any, data?: DeleteConnectorCommandOutput) => void): void;
     deleteConnector(args: DeleteConnectorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteConnectorCommandOutput) => void): void;
     /**
+     * @public
      * <p>Deletes the host key that's specified in the <code>HoskKeyId</code> parameter.</p>
      */
     deleteHostKey(args: DeleteHostKeyCommandInput, options?: __HttpHandlerOptions): Promise<DeleteHostKeyCommandOutput>;
     deleteHostKey(args: DeleteHostKeyCommandInput, cb: (err: any, data?: DeleteHostKeyCommandOutput) => void): void;
     deleteHostKey(args: DeleteHostKeyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteHostKeyCommandOutput) => void): void;
     /**
+     * @public
      * <p>Deletes the profile that's specified in the <code>ProfileId</code> parameter.</p>
      */
     deleteProfile(args: DeleteProfileCommandInput, options?: __HttpHandlerOptions): Promise<DeleteProfileCommandOutput>;
     deleteProfile(args: DeleteProfileCommandInput, cb: (err: any, data?: DeleteProfileCommandOutput) => void): void;
     deleteProfile(args: DeleteProfileCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteProfileCommandOutput) => void): void;
     /**
+     * @public
      * <p>Deletes the file transfer protocol-enabled server that you specify.</p>
      *          <p>No response returns from this operation.</p>
      */
@@ -183,12 +198,14 @@ export declare class Transfer extends TransferClient {
     deleteServer(args: DeleteServerCommandInput, cb: (err: any, data?: DeleteServerCommandOutput) => void): void;
     deleteServer(args: DeleteServerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteServerCommandOutput) => void): void;
     /**
+     * @public
      * <p>Deletes a user's Secure Shell (SSH) public key.</p>
      */
     deleteSshPublicKey(args: DeleteSshPublicKeyCommandInput, options?: __HttpHandlerOptions): Promise<DeleteSshPublicKeyCommandOutput>;
     deleteSshPublicKey(args: DeleteSshPublicKeyCommandInput, cb: (err: any, data?: DeleteSshPublicKeyCommandOutput) => void): void;
     deleteSshPublicKey(args: DeleteSshPublicKeyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteSshPublicKeyCommandOutput) => void): void;
     /**
+     * @public
      * <p>Deletes the user belonging to a file transfer protocol-enabled server you specify.</p>
      *          <p>No response returns from this operation.</p>
      *          <note>
@@ -199,12 +216,14 @@ export declare class Transfer extends TransferClient {
     deleteUser(args: DeleteUserCommandInput, cb: (err: any, data?: DeleteUserCommandOutput) => void): void;
     deleteUser(args: DeleteUserCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteUserCommandOutput) => void): void;
     /**
+     * @public
      * <p>Deletes the specified workflow.</p>
      */
     deleteWorkflow(args: DeleteWorkflowCommandInput, options?: __HttpHandlerOptions): Promise<DeleteWorkflowCommandOutput>;
     deleteWorkflow(args: DeleteWorkflowCommandInput, cb: (err: any, data?: DeleteWorkflowCommandOutput) => void): void;
     deleteWorkflow(args: DeleteWorkflowCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteWorkflowCommandOutput) => void): void;
     /**
+     * @public
      * <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>
@@ -215,18 +234,21 @@ export declare class Transfer extends TransferClient {
     describeAccess(args: DescribeAccessCommandInput, cb: (err: any, data?: DescribeAccessCommandOutput) => void): void;
     describeAccess(args: DescribeAccessCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeAccessCommandOutput) => void): void;
     /**
+     * @public
      * <p>Describes the agreement that's identified by the <code>AgreementId</code>.</p>
      */
     describeAgreement(args: DescribeAgreementCommandInput, options?: __HttpHandlerOptions): Promise<DescribeAgreementCommandOutput>;
     describeAgreement(args: DescribeAgreementCommandInput, cb: (err: any, data?: DescribeAgreementCommandOutput) => void): void;
     describeAgreement(args: DescribeAgreementCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeAgreementCommandOutput) => void): void;
     /**
+     * @public
      * <p>Describes the certificate that's identified by the <code>CertificateId</code>.</p>
      */
     describeCertificate(args: DescribeCertificateCommandInput, options?: __HttpHandlerOptions): Promise<DescribeCertificateCommandOutput>;
     describeCertificate(args: DescribeCertificateCommandInput, cb: (err: any, data?: DescribeCertificateCommandOutput) => void): void;
     describeCertificate(args: DescribeCertificateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeCertificateCommandOutput) => void): void;
     /**
+     * @public
      * <p>Describes the connector that's identified by the <code>ConnectorId.</code>
      *          </p>
      */
@@ -234,24 +256,28 @@ export declare class Transfer extends TransferClient {
     describeConnector(args: DescribeConnectorCommandInput, cb: (err: any, data?: DescribeConnectorCommandOutput) => void): void;
     describeConnector(args: DescribeConnectorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeConnectorCommandOutput) => void): void;
     /**
+     * @public
      * <p>You can use <code>DescribeExecution</code> to check the details of the execution of the specified workflow.</p>
      */
     describeExecution(args: DescribeExecutionCommandInput, options?: __HttpHandlerOptions): Promise<DescribeExecutionCommandOutput>;
     describeExecution(args: DescribeExecutionCommandInput, cb: (err: any, data?: DescribeExecutionCommandOutput) => void): void;
     describeExecution(args: DescribeExecutionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeExecutionCommandOutput) => void): void;
     /**
+     * @public
      * <p>Returns the details of the host key that's specified by the <code>HostKeyId</code> and <code>ServerId</code>.</p>
      */
     describeHostKey(args: DescribeHostKeyCommandInput, options?: __HttpHandlerOptions): Promise<DescribeHostKeyCommandOutput>;
     describeHostKey(args: DescribeHostKeyCommandInput, cb: (err: any, data?: DescribeHostKeyCommandOutput) => void): void;
     describeHostKey(args: DescribeHostKeyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeHostKeyCommandOutput) => void): void;
     /**
+     * @public
      * <p>Returns the details of the profile that's specified by the <code>ProfileId</code>.</p>
      */
     describeProfile(args: DescribeProfileCommandInput, options?: __HttpHandlerOptions): Promise<DescribeProfileCommandOutput>;
     describeProfile(args: DescribeProfileCommandInput, cb: (err: any, data?: DescribeProfileCommandOutput) => void): void;
     describeProfile(args: DescribeProfileCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeProfileCommandOutput) => void): void;
     /**
+     * @public
      * <p>Describes the security policy that is attached to your file transfer protocol-enabled
      *       server. 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
@@ -261,6 +287,7 @@ export declare class Transfer extends TransferClient {
     describeSecurityPolicy(args: DescribeSecurityPolicyCommandInput, cb: (err: any, data?: DescribeSecurityPolicyCommandOutput) => void): void;
     describeSecurityPolicy(args: DescribeSecurityPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeSecurityPolicyCommandOutput) => void): void;
     /**
+     * @public
      * <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
@@ -271,6 +298,7 @@ export declare class Transfer extends TransferClient {
     describeServer(args: DescribeServerCommandInput, cb: (err: any, data?: DescribeServerCommandOutput) => void): void;
     describeServer(args: DescribeServerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeServerCommandOutput) => void): void;
     /**
+     * @public
      * <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
@@ -280,12 +308,14 @@ export declare class Transfer extends TransferClient {
     describeUser(args: DescribeUserCommandInput, cb: (err: any, data?: DescribeUserCommandOutput) => void): void;
     describeUser(args: DescribeUserCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeUserCommandOutput) => void): void;
     /**
+     * @public
      * <p>Describes the specified workflow.</p>
      */
     describeWorkflow(args: DescribeWorkflowCommandInput, options?: __HttpHandlerOptions): Promise<DescribeWorkflowCommandOutput>;
     describeWorkflow(args: DescribeWorkflowCommandInput, cb: (err: any, data?: DescribeWorkflowCommandOutput) => void): void;
     describeWorkflow(args: DescribeWorkflowCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeWorkflowCommandOutput) => void): void;
     /**
+     * @public
      * <p>Imports the signing and encryption certificates that you need to create local (AS2)
      *       profiles and partner
      *       profiles.</p>
@@ -294,6 +324,7 @@ export declare class Transfer extends TransferClient {
     importCertificate(args: ImportCertificateCommandInput, cb: (err: any, data?: ImportCertificateCommandOutput) => void): void;
     importCertificate(args: ImportCertificateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ImportCertificateCommandOutput) => void): void;
     /**
+     * @public
      * <p>Adds a host key to the server that's specified by the <code>ServerId</code>
      *       parameter.</p>
      */
@@ -301,6 +332,7 @@ export declare class Transfer extends TransferClient {
     importHostKey(args: ImportHostKeyCommandInput, cb: (err: any, data?: ImportHostKeyCommandOutput) => void): void;
     importHostKey(args: ImportHostKeyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ImportHostKeyCommandOutput) => void): void;
     /**
+     * @public
      * <p>Adds a Secure Shell (SSH) public key to a user account identified by a
      *         <code>UserName</code> value assigned to the specific file transfer protocol-enabled server,
      *       identified by <code>ServerId</code>.</p>
@@ -311,12 +343,14 @@ export declare class Transfer extends TransferClient {
     importSshPublicKey(args: ImportSshPublicKeyCommandInput, cb: (err: any, data?: ImportSshPublicKeyCommandOutput) => void): void;
     importSshPublicKey(args: ImportSshPublicKeyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ImportSshPublicKeyCommandOutput) => void): void;
     /**
+     * @public
      * <p>Lists the details for all the accesses you have on your server.</p>
      */
     listAccesses(args: ListAccessesCommandInput, options?: __HttpHandlerOptions): Promise<ListAccessesCommandOutput>;
     listAccesses(args: ListAccessesCommandInput, cb: (err: any, data?: ListAccessesCommandOutput) => void): void;
     listAccesses(args: ListAccessesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAccessesCommandOutput) => void): void;
     /**
+     * @public
      * <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
@@ -327,6 +361,7 @@ export declare class Transfer extends TransferClient {
     listAgreements(args: ListAgreementsCommandInput, cb: (err: any, data?: ListAgreementsCommandOutput) => void): void;
     listAgreements(args: ListAgreementsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAgreementsCommandOutput) => void): void;
     /**
+     * @public
      * <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
@@ -337,18 +372,21 @@ export declare class Transfer extends TransferClient {
     listCertificates(args: ListCertificatesCommandInput, cb: (err: any, data?: ListCertificatesCommandOutput) => void): void;
     listCertificates(args: ListCertificatesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListCertificatesCommandOutput) => void): void;
     /**
+     * @public
      * <p>Lists the connectors for the specified Region.</p>
      */
     listConnectors(args: ListConnectorsCommandInput, options?: __HttpHandlerOptions): Promise<ListConnectorsCommandOutput>;
     listConnectors(args: ListConnectorsCommandInput, cb: (err: any, data?: ListConnectorsCommandOutput) => void): void;
     listConnectors(args: ListConnectorsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListConnectorsCommandOutput) => void): void;
     /**
+     * @public
      * <p>Lists all executions for the specified workflow.</p>
      */
     listExecutions(args: ListExecutionsCommandInput, options?: __HttpHandlerOptions): Promise<ListExecutionsCommandOutput>;
     listExecutions(args: ListExecutionsCommandInput, cb: (err: any, data?: ListExecutionsCommandOutput) => void): void;
     listExecutions(args: ListExecutionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListExecutionsCommandOutput) => void): void;
     /**
+     * @public
      * <p>Returns a list of host keys for the server that's specified by the <code>ServerId</code>
      *       parameter.</p>
      */
@@ -356,6 +394,7 @@ export declare class Transfer extends TransferClient {
     listHostKeys(args: ListHostKeysCommandInput, cb: (err: any, data?: ListHostKeysCommandOutput) => void): void;
     listHostKeys(args: ListHostKeysCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListHostKeysCommandOutput) => void): void;
     /**
+     * @public
      * <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
@@ -365,6 +404,7 @@ export declare class Transfer extends TransferClient {
     listProfiles(args: ListProfilesCommandInput, cb: (err: any, data?: ListProfilesCommandOutput) => void): void;
     listProfiles(args: ListProfilesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListProfilesCommandOutput) => void): void;
     /**
+     * @public
      * <p>Lists the security policies that are attached to your file transfer protocol-enabled
      *       servers.</p>
      */
@@ -372,6 +412,7 @@ export declare class Transfer extends TransferClient {
     listSecurityPolicies(args: ListSecurityPoliciesCommandInput, cb: (err: any, data?: ListSecurityPoliciesCommandOutput) => void): void;
     listSecurityPolicies(args: ListSecurityPoliciesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListSecurityPoliciesCommandOutput) => void): void;
     /**
+     * @public
      * <p>Lists the file transfer protocol-enabled servers that are associated with your Amazon Web Services
      *       account.</p>
      */
@@ -379,6 +420,7 @@ export declare class Transfer extends TransferClient {
     listServers(args: ListServersCommandInput, cb: (err: any, data?: ListServersCommandOutput) => void): void;
     listServers(args: ListServersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListServersCommandOutput) => void): void;
     /**
+     * @public
      * <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>
      */
@@ -386,6 +428,7 @@ export declare class Transfer extends TransferClient {
     listTagsForResource(args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
     listTagsForResource(args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
     /**
+     * @public
      * <p>Lists the users for a file transfer protocol-enabled server that you specify by passing
      *       the <code>ServerId</code> parameter.</p>
      */
@@ -393,12 +436,14 @@ export declare class Transfer extends TransferClient {
     listUsers(args: ListUsersCommandInput, cb: (err: any, data?: ListUsersCommandOutput) => void): void;
     listUsers(args: ListUsersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListUsersCommandOutput) => void): void;
     /**
+     * @public
      * <p>Lists all of your workflows.</p>
      */
     listWorkflows(args: ListWorkflowsCommandInput, options?: __HttpHandlerOptions): Promise<ListWorkflowsCommandOutput>;
     listWorkflows(args: ListWorkflowsCommandInput, cb: (err: any, data?: ListWorkflowsCommandOutput) => void): void;
     listWorkflows(args: ListWorkflowsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListWorkflowsCommandOutput) => void): void;
     /**
+     * @public
      * <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.
@@ -409,6 +454,7 @@ export declare class Transfer extends TransferClient {
     sendWorkflowStepState(args: SendWorkflowStepStateCommandInput, cb: (err: any, data?: SendWorkflowStepStateCommandOutput) => void): void;
     sendWorkflowStepState(args: SendWorkflowStepStateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SendWorkflowStepStateCommandOutput) => void): void;
     /**
+     * @public
      * <p>Begins an outbound file transfer to a remote AS2 server. You specify the <code>ConnectorId</code> and the file
      *       paths for where to send the files. </p>
      */
@@ -416,6 +462,7 @@ export declare class Transfer extends TransferClient {
     startFileTransfer(args: StartFileTransferCommandInput, cb: (err: any, data?: StartFileTransferCommandOutput) => void): void;
     startFileTransfer(args: StartFileTransferCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartFileTransferCommandOutput) => void): void;
     /**
+     * @public
      * <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>
@@ -428,6 +475,7 @@ export declare class Transfer extends TransferClient {
     startServer(args: StartServerCommandInput, cb: (err: any, data?: StartServerCommandOutput) => void): void;
     startServer(args: StartServerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartServerCommandOutput) => void): void;
     /**
+     * @public
      * <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
@@ -445,6 +493,7 @@ export declare class Transfer extends TransferClient {
     stopServer(args: StopServerCommandInput, cb: (err: any, data?: StopServerCommandOutput) => void): void;
     stopServer(args: StopServerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopServerCommandOutput) => void): void;
     /**
+     * @public
      * <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>
@@ -453,6 +502,7 @@ export declare class Transfer extends TransferClient {
     tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
     tagResource(args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
     /**
+     * @public
      * <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
@@ -497,6 +547,7 @@ export declare class Transfer extends TransferClient {
     testIdentityProvider(args: TestIdentityProviderCommandInput, cb: (err: any, data?: TestIdentityProviderCommandOutput) => void): void;
     testIdentityProvider(args: TestIdentityProviderCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TestIdentityProviderCommandOutput) => void): void;
     /**
+     * @public
      * <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>
@@ -505,6 +556,7 @@ export declare class Transfer extends TransferClient {
     untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
     untagResource(args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
     /**
+     * @public
      * <p>Allows you to update parameters for the access specified in the <code>ServerID</code> and
      *       <code>ExternalID</code> parameters.</p>
      */
@@ -512,6 +564,7 @@ export declare class Transfer extends TransferClient {
     updateAccess(args: UpdateAccessCommandInput, cb: (err: any, data?: UpdateAccessCommandOutput) => void): void;
     updateAccess(args: UpdateAccessCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateAccessCommandOutput) => void): void;
     /**
+     * @public
      * <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>
@@ -520,12 +573,14 @@ export declare class Transfer extends TransferClient {
     updateAgreement(args: UpdateAgreementCommandInput, cb: (err: any, data?: UpdateAgreementCommandOutput) => void): void;
     updateAgreement(args: UpdateAgreementCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateAgreementCommandOutput) => void): void;
     /**
+     * @public
      * <p>Updates the active and inactive dates for a certificate.</p>
      */
     updateCertificate(args: UpdateCertificateCommandInput, options?: __HttpHandlerOptions): Promise<UpdateCertificateCommandOutput>;
     updateCertificate(args: UpdateCertificateCommandInput, cb: (err: any, data?: UpdateCertificateCommandOutput) => void): void;
     updateCertificate(args: UpdateCertificateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateCertificateCommandOutput) => void): void;
     /**
+     * @public
      * <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>
@@ -534,6 +589,7 @@ export declare class Transfer extends TransferClient {
     updateConnector(args: UpdateConnectorCommandInput, cb: (err: any, data?: UpdateConnectorCommandOutput) => void): void;
     updateConnector(args: UpdateConnectorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateConnectorCommandOutput) => void): void;
     /**
+     * @public
      * <p>Updates the description for the host key that's specified by the <code>ServerId</code> and
      *         <code>HostKeyId</code> parameters.</p>
      */
@@ -541,6 +597,7 @@ export declare class Transfer extends TransferClient {
     updateHostKey(args: UpdateHostKeyCommandInput, cb: (err: any, data?: UpdateHostKeyCommandOutput) => void): void;
     updateHostKey(args: UpdateHostKeyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateHostKeyCommandOutput) => void): void;
     /**
+     * @public
      * <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>
@@ -549,6 +606,7 @@ export declare class Transfer extends TransferClient {
     updateProfile(args: UpdateProfileCommandInput, cb: (err: any, data?: UpdateProfileCommandOutput) => void): void;
     updateProfile(args: UpdateProfileCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateProfileCommandOutput) => void): void;
     /**
+     * @public
      * <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
@@ -558,6 +616,7 @@ export declare class Transfer extends TransferClient {
     updateServer(args: UpdateServerCommandInput, cb: (err: any, data?: UpdateServerCommandOutput) => void): void;
     updateServer(args: UpdateServerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateServerCommandOutput) => void): void;
     /**
+     * @public
      * <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>

package/dist-types/TransferClient.d.ts

@@ -66,15 +66,24 @@ import { UpdateProfileCommandInput, UpdateProfileCommandOutput } from "./command
 import { UpdateServerCommandInput, UpdateServerCommandOutput } from "./commands/UpdateServerCommand";
 import { UpdateUserCommandInput, UpdateUserCommandOutput } from "./commands/UpdateUserCommand";
 import { ClientInputEndpointParameters, ClientResolvedEndpointParameters, EndpointParameters } from "./endpoint/EndpointParameters";
+/**
+ * @public
+ */
 export type ServiceInputTypes = CreateAccessCommandInput | CreateAgreementCommandInput | CreateConnectorCommandInput | CreateProfileCommandInput | CreateServerCommandInput | CreateUserCommandInput | CreateWorkflowCommandInput | DeleteAccessCommandInput | DeleteAgreementCommandInput | DeleteCertificateCommandInput | DeleteConnectorCommandInput | DeleteHostKeyCommandInput | DeleteProfileCommandInput | DeleteServerCommandInput | DeleteSshPublicKeyCommandInput | DeleteUserCommandInput | DeleteWorkflowCommandInput | DescribeAccessCommandInput | DescribeAgreementCommandInput | DescribeCertificateCommandInput | DescribeConnectorCommandInput | DescribeExecutionCommandInput | DescribeHostKeyCommandInput | DescribeProfileCommandInput | DescribeSecurityPolicyCommandInput | DescribeServerCommandInput | DescribeUserCommandInput | DescribeWorkflowCommandInput | ImportCertificateCommandInput | ImportHostKeyCommandInput | ImportSshPublicKeyCommandInput | ListAccessesCommandInput | ListAgreementsCommandInput | ListCertificatesCommandInput | ListConnectorsCommandInput | ListExecutionsCommandInput | ListHostKeysCommandInput | ListProfilesCommandInput | ListSecurityPoliciesCommandInput | ListServersCommandInput | ListTagsForResourceCommandInput | ListUsersCommandInput | ListWorkflowsCommandInput | SendWorkflowStepStateCommandInput | StartFileTransferCommandInput | StartServerCommandInput | StopServerCommandInput | TagResourceCommandInput | TestIdentityProviderCommandInput | UntagResourceCommandInput | UpdateAccessCommandInput | UpdateAgreementCommandInput | UpdateCertificateCommandInput | UpdateConnectorCommandInput | UpdateHostKeyCommandInput | UpdateProfileCommandInput | UpdateServerCommandInput | UpdateUserCommandInput;
+/**
+ * @public
+ */
 export type ServiceOutputTypes = CreateAccessCommandOutput | CreateAgreementCommandOutput | CreateConnectorCommandOutput | CreateProfileCommandOutput | CreateServerCommandOutput | CreateUserCommandOutput | CreateWorkflowCommandOutput | DeleteAccessCommandOutput | DeleteAgreementCommandOutput | DeleteCertificateCommandOutput | DeleteConnectorCommandOutput | DeleteHostKeyCommandOutput | DeleteProfileCommandOutput | DeleteServerCommandOutput | DeleteSshPublicKeyCommandOutput | DeleteUserCommandOutput | DeleteWorkflowCommandOutput | DescribeAccessCommandOutput | DescribeAgreementCommandOutput | DescribeCertificateCommandOutput | DescribeConnectorCommandOutput | DescribeExecutionCommandOutput | DescribeHostKeyCommandOutput | DescribeProfileCommandOutput | DescribeSecurityPolicyCommandOutput | DescribeServerCommandOutput | DescribeUserCommandOutput | DescribeWorkflowCommandOutput | ImportCertificateCommandOutput | ImportHostKeyCommandOutput | ImportSshPublicKeyCommandOutput | ListAccessesCommandOutput | ListAgreementsCommandOutput | ListCertificatesCommandOutput | ListConnectorsCommandOutput | ListExecutionsCommandOutput | ListHostKeysCommandOutput | ListProfilesCommandOutput | ListSecurityPoliciesCommandOutput | ListServersCommandOutput | ListTagsForResourceCommandOutput | ListUsersCommandOutput | ListWorkflowsCommandOutput | SendWorkflowStepStateCommandOutput | StartFileTransferCommandOutput | StartServerCommandOutput | StopServerCommandOutput | TagResourceCommandOutput | TestIdentityProviderCommandOutput | UntagResourceCommandOutput | UpdateAccessCommandOutput | UpdateAgreementCommandOutput | UpdateCertificateCommandOutput | UpdateConnectorCommandOutput | UpdateHostKeyCommandOutput | UpdateProfileCommandOutput | UpdateServerCommandOutput | UpdateUserCommandOutput;
+/**
+ * @public
+ */
 export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__HttpHandlerOptions>> {
     /**
      * The HTTP handler to use. Fetch in browser and Https in Nodejs.
      */
     requestHandler?: __HttpHandler;
     /**
-     * A constructor for a class implementing the {@link __Checksum} interface
+     * A constructor for a class implementing the {@link @aws-sdk/types#ChecksumConstructor} interface
      * that computes the SHA-256 HMAC or checksum of a string or binary buffer.
      * @internal
      */
@@ -164,23 +173,34 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
      */
     logger?: __Logger;
     /**
-     * The {@link __DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
+     * The {@link @aws-sdk/smithy-client#DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
      */
     defaultsMode?: __DefaultsMode | __Provider<__DefaultsMode>;
 }
+/**
+ * @public
+ */
 type TransferClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> & ClientDefaults & RegionInputConfig & EndpointInputConfig<EndpointParameters> & RetryInputConfig & HostHeaderInputConfig & AwsAuthInputConfig & UserAgentInputConfig & ClientInputEndpointParameters;
 /**
- * The configuration interface of TransferClient class constructor that set the region, credentials and other options.
+ * @public
+ *
+ *  The configuration interface of TransferClient class constructor that set the region, credentials and other options.
  */
 export interface TransferClientConfig extends TransferClientConfigType {
 }
+/**
+ * @public
+ */
 type TransferClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> & Required<ClientDefaults> & RegionResolvedConfig & EndpointResolvedConfig<EndpointParameters> & RetryResolvedConfig & HostHeaderResolvedConfig & AwsAuthResolvedConfig & UserAgentResolvedConfig & ClientResolvedEndpointParameters;
 /**
- * The resolved configuration interface of TransferClient class. This is resolved and normalized from the {@link TransferClientConfig | constructor configuration interface}.
+ * @public
+ *
+ *  The resolved configuration interface of TransferClient class. This is resolved and normalized from the {@link TransferClientConfig | constructor configuration interface}.
  */
 export interface TransferClientResolvedConfig extends TransferClientResolvedConfigType {
 }
 /**
+ * @public
  * <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.

package/dist-types/commands/CreateAccessCommand.d.ts

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { CreateAccessRequest, CreateAccessResponse } from "../models/models_0";
 import { ServiceInputTypes, ServiceOutputTypes, TransferClientResolvedConfig } from "../TransferClient";
 /**
+ * @public
+ *
  * The input for {@link CreateAccessCommand}.
  */
 export interface CreateAccessCommandInput extends CreateAccessRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link CreateAccessCommand}.
  */
 export interface CreateAccessCommandOutput extends CreateAccessResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <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
@@ -30,6 +35,8 @@ export interface CreateAccessCommandOutput extends CreateAccessResponse, __Metad
  * const response = await client.send(command);
  * ```
  *
+ * @param CreateAccessCommandInput - {@link CreateAccessCommandInput}
+ * @returns {@link CreateAccessCommandOutput}
  * @see {@link CreateAccessCommandInput} for command's `input` shape.
  * @see {@link CreateAccessCommandOutput} for command's `response` shape.
  * @see {@link TransferClientResolvedConfig | config} for TransferClient's `config` shape.
@@ -55,11 +62,20 @@ export interface CreateAccessCommandOutput extends CreateAccessResponse, __Metad
 export declare class CreateAccessCommand extends $Command<CreateAccessCommandInput, CreateAccessCommandOutput, TransferClientResolvedConfig> {
     readonly input: CreateAccessCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: CreateAccessCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: TransferClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateAccessCommandInput, CreateAccessCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

package/dist-types/commands/CreateAgreementCommand.d.ts

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { CreateAgreementRequest, CreateAgreementResponse } from "../models/models_0";
 import { ServiceInputTypes, ServiceOutputTypes, TransferClientResolvedConfig } from "../TransferClient";
 /**
+ * @public
+ *
  * The input for {@link CreateAgreementCommand}.
  */
 export interface CreateAgreementCommandInput extends CreateAgreementRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link CreateAgreementCommand}.
  */
 export interface CreateAgreementCommandOutput extends CreateAgreementResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <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
@@ -30,6 +35,8 @@ export interface CreateAgreementCommandOutput extends CreateAgreementResponse, _
  * const response = await client.send(command);
  * ```
  *
+ * @param CreateAgreementCommandInput - {@link CreateAgreementCommandInput}
+ * @returns {@link CreateAgreementCommandOutput}
  * @see {@link CreateAgreementCommandInput} for command's `input` shape.
  * @see {@link CreateAgreementCommandOutput} for command's `response` shape.
  * @see {@link TransferClientResolvedConfig | config} for TransferClient's `config` shape.
@@ -58,11 +65,20 @@ export interface CreateAgreementCommandOutput extends CreateAgreementResponse, _
 export declare class CreateAgreementCommand extends $Command<CreateAgreementCommandInput, CreateAgreementCommandOutput, TransferClientResolvedConfig> {
     readonly input: CreateAgreementCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: CreateAgreementCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: TransferClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateAgreementCommandInput, CreateAgreementCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }