@aws-sdk/client-transfer 3.321.1 → 3.326.0

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

@@ -34,6 +34,25 @@ export interface DescribeSecurityPolicyCommandOutput extends DescribeSecurityPol
  * };
  * const command = new DescribeSecurityPolicyCommand(input);
  * const response = await client.send(command);
+ * // { // DescribeSecurityPolicyResponse
+ * //   SecurityPolicy: { // DescribedSecurityPolicy
+ * //     Fips: true || false,
+ * //     SecurityPolicyName: "STRING_VALUE", // required
+ * //     SshCiphers: [ // SecurityPolicyOptions
+ * //       "STRING_VALUE",
+ * //     ],
+ * //     SshKexs: [
+ * //       "STRING_VALUE",
+ * //     ],
+ * //     SshMacs: [
+ * //       "STRING_VALUE",
+ * //     ],
+ * //     TlsCiphers: [
+ * //       "STRING_VALUE",
+ * //     ],
+ * //   },
+ * // };
+ *
  * ```
  *
  * @param DescribeSecurityPolicyCommandInput - {@link DescribeSecurityPolicyCommandInput}
@@ -55,6 +74,8 @@ export interface DescribeSecurityPolicyCommandOutput extends DescribeSecurityPol
  * @throws {@link ServiceUnavailableException} (server fault)
  *  <p>The request has failed because the Amazon Web ServicesTransfer Family service is not available.</p>
  *
+ * @throws {@link TransferServiceException}
+ * <p>Base exception class for all service exceptions from Transfer service.</p>
  *
  */
 export declare class DescribeSecurityPolicyCommand extends $Command<DescribeSecurityPolicyCommandInput, DescribeSecurityPolicyCommandOutput, TransferClientResolvedConfig> {

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

@@ -35,6 +35,74 @@ export interface DescribeServerCommandOutput extends DescribeServerResponse, __M
  * };
  * const command = new DescribeServerCommand(input);
  * const response = await client.send(command);
+ * // { // DescribeServerResponse
+ * //   Server: { // DescribedServer
+ * //     Arn: "STRING_VALUE", // required
+ * //     Certificate: "STRING_VALUE",
+ * //     ProtocolDetails: { // ProtocolDetails
+ * //       PassiveIp: "STRING_VALUE",
+ * //       TlsSessionResumptionMode: "DISABLED" || "ENABLED" || "ENFORCED",
+ * //       SetStatOption: "DEFAULT" || "ENABLE_NO_OP",
+ * //       As2Transports: [ // As2Transports
+ * //         "HTTP",
+ * //       ],
+ * //     },
+ * //     Domain: "S3" || "EFS",
+ * //     EndpointDetails: { // EndpointDetails
+ * //       AddressAllocationIds: [ // AddressAllocationIds
+ * //         "STRING_VALUE",
+ * //       ],
+ * //       SubnetIds: [ // SubnetIds
+ * //         "STRING_VALUE",
+ * //       ],
+ * //       VpcEndpointId: "STRING_VALUE",
+ * //       VpcId: "STRING_VALUE",
+ * //       SecurityGroupIds: [ // SecurityGroupIds
+ * //         "STRING_VALUE",
+ * //       ],
+ * //     },
+ * //     EndpointType: "PUBLIC" || "VPC" || "VPC_ENDPOINT",
+ * //     HostKeyFingerprint: "STRING_VALUE",
+ * //     IdentityProviderDetails: { // IdentityProviderDetails
+ * //       Url: "STRING_VALUE",
+ * //       InvocationRole: "STRING_VALUE",
+ * //       DirectoryId: "STRING_VALUE",
+ * //       Function: "STRING_VALUE",
+ * //     },
+ * //     IdentityProviderType: "SERVICE_MANAGED" || "API_GATEWAY" || "AWS_DIRECTORY_SERVICE" || "AWS_LAMBDA",
+ * //     LoggingRole: "STRING_VALUE",
+ * //     PostAuthenticationLoginBanner: "STRING_VALUE",
+ * //     PreAuthenticationLoginBanner: "STRING_VALUE",
+ * //     Protocols: [ // Protocols
+ * //       "SFTP" || "FTP" || "FTPS" || "AS2",
+ * //     ],
+ * //     SecurityPolicyName: "STRING_VALUE",
+ * //     ServerId: "STRING_VALUE",
+ * //     State: "OFFLINE" || "ONLINE" || "STARTING" || "STOPPING" || "START_FAILED" || "STOP_FAILED",
+ * //     Tags: [ // Tags
+ * //       { // Tag
+ * //         Key: "STRING_VALUE", // required
+ * //         Value: "STRING_VALUE", // required
+ * //       },
+ * //     ],
+ * //     UserCount: Number("int"),
+ * //     WorkflowDetails: { // WorkflowDetails
+ * //       OnUpload: [ // OnUploadWorkflowDetails
+ * //         { // WorkflowDetail
+ * //           WorkflowId: "STRING_VALUE", // required
+ * //           ExecutionRole: "STRING_VALUE", // required
+ * //         },
+ * //       ],
+ * //       OnPartialUpload: [ // OnPartialUploadWorkflowDetails
+ * //         {
+ * //           WorkflowId: "STRING_VALUE", // required
+ * //           ExecutionRole: "STRING_VALUE", // required
+ * //         },
+ * //       ],
+ * //     },
+ * //   },
+ * // };
+ *
  * ```
  *
  * @param DescribeServerCommandInput - {@link DescribeServerCommandInput}
@@ -56,6 +124,8 @@ export interface DescribeServerCommandOutput extends DescribeServerResponse, __M
  * @throws {@link ServiceUnavailableException} (server fault)
  *  <p>The request has failed because the Amazon Web ServicesTransfer Family service is not available.</p>
  *
+ * @throws {@link TransferServiceException}
+ * <p>Base exception class for all service exceptions from Transfer service.</p>
  *
  */
 export declare class DescribeServerCommand extends $Command<DescribeServerCommandInput, DescribeServerCommandOutput, TransferClientResolvedConfig> {

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

@@ -35,6 +35,44 @@ export interface DescribeUserCommandOutput extends DescribeUserResponse, __Metad
  * };
  * const command = new DescribeUserCommand(input);
  * const response = await client.send(command);
+ * // { // DescribeUserResponse
+ * //   ServerId: "STRING_VALUE", // required
+ * //   User: { // DescribedUser
+ * //     Arn: "STRING_VALUE", // required
+ * //     HomeDirectory: "STRING_VALUE",
+ * //     HomeDirectoryMappings: [ // HomeDirectoryMappings
+ * //       { // HomeDirectoryMapEntry
+ * //         Entry: "STRING_VALUE", // required
+ * //         Target: "STRING_VALUE", // required
+ * //       },
+ * //     ],
+ * //     HomeDirectoryType: "PATH" || "LOGICAL",
+ * //     Policy: "STRING_VALUE",
+ * //     PosixProfile: { // PosixProfile
+ * //       Uid: Number("long"), // required
+ * //       Gid: Number("long"), // required
+ * //       SecondaryGids: [ // SecondaryGids
+ * //         Number("long"),
+ * //       ],
+ * //     },
+ * //     Role: "STRING_VALUE",
+ * //     SshPublicKeys: [ // SshPublicKeys
+ * //       { // SshPublicKey
+ * //         DateImported: new Date("TIMESTAMP"), // required
+ * //         SshPublicKeyBody: "STRING_VALUE", // required
+ * //         SshPublicKeyId: "STRING_VALUE", // required
+ * //       },
+ * //     ],
+ * //     Tags: [ // Tags
+ * //       { // Tag
+ * //         Key: "STRING_VALUE", // required
+ * //         Value: "STRING_VALUE", // required
+ * //       },
+ * //     ],
+ * //     UserName: "STRING_VALUE",
+ * //   },
+ * // };
+ *
  * ```
  *
  * @param DescribeUserCommandInput - {@link DescribeUserCommandInput}
@@ -56,6 +94,8 @@ export interface DescribeUserCommandOutput extends DescribeUserResponse, __Metad
  * @throws {@link ServiceUnavailableException} (server fault)
  *  <p>The request has failed because the Amazon Web ServicesTransfer Family service is not available.</p>
  *
+ * @throws {@link TransferServiceException}
+ * <p>Base exception class for all service exceptions from Transfer service.</p>
  *
  */
 export declare class DescribeUserCommand extends $Command<DescribeUserCommandInput, DescribeUserCommandOutput, TransferClientResolvedConfig> {

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

@@ -31,6 +31,132 @@ export interface DescribeWorkflowCommandOutput extends DescribeWorkflowResponse,
  * };
  * const command = new DescribeWorkflowCommand(input);
  * const response = await client.send(command);
+ * // { // DescribeWorkflowResponse
+ * //   Workflow: { // DescribedWorkflow
+ * //     Arn: "STRING_VALUE", // required
+ * //     Description: "STRING_VALUE",
+ * //     Steps: [ // WorkflowSteps
+ * //       { // WorkflowStep
+ * //         Type: "COPY" || "CUSTOM" || "TAG" || "DELETE" || "DECRYPT",
+ * //         CopyStepDetails: { // CopyStepDetails
+ * //           Name: "STRING_VALUE",
+ * //           DestinationFileLocation: { // InputFileLocation
+ * //             S3FileLocation: { // S3InputFileLocation
+ * //               Bucket: "STRING_VALUE",
+ * //               Key: "STRING_VALUE",
+ * //             },
+ * //             EfsFileLocation: { // EfsFileLocation
+ * //               FileSystemId: "STRING_VALUE",
+ * //               Path: "STRING_VALUE",
+ * //             },
+ * //           },
+ * //           OverwriteExisting: "TRUE" || "FALSE",
+ * //           SourceFileLocation: "STRING_VALUE",
+ * //         },
+ * //         CustomStepDetails: { // CustomStepDetails
+ * //           Name: "STRING_VALUE",
+ * //           Target: "STRING_VALUE",
+ * //           TimeoutSeconds: Number("int"),
+ * //           SourceFileLocation: "STRING_VALUE",
+ * //         },
+ * //         DeleteStepDetails: { // DeleteStepDetails
+ * //           Name: "STRING_VALUE",
+ * //           SourceFileLocation: "STRING_VALUE",
+ * //         },
+ * //         TagStepDetails: { // TagStepDetails
+ * //           Name: "STRING_VALUE",
+ * //           Tags: [ // S3Tags
+ * //             { // S3Tag
+ * //               Key: "STRING_VALUE", // required
+ * //               Value: "STRING_VALUE", // required
+ * //             },
+ * //           ],
+ * //           SourceFileLocation: "STRING_VALUE",
+ * //         },
+ * //         DecryptStepDetails: { // DecryptStepDetails
+ * //           Name: "STRING_VALUE",
+ * //           Type: "PGP", // required
+ * //           SourceFileLocation: "STRING_VALUE",
+ * //           OverwriteExisting: "TRUE" || "FALSE",
+ * //           DestinationFileLocation: {
+ * //             S3FileLocation: {
+ * //               Bucket: "STRING_VALUE",
+ * //               Key: "STRING_VALUE",
+ * //             },
+ * //             EfsFileLocation: {
+ * //               FileSystemId: "STRING_VALUE",
+ * //               Path: "STRING_VALUE",
+ * //             },
+ * //           },
+ * //         },
+ * //       },
+ * //     ],
+ * //     OnExceptionSteps: [
+ * //       {
+ * //         Type: "COPY" || "CUSTOM" || "TAG" || "DELETE" || "DECRYPT",
+ * //         CopyStepDetails: {
+ * //           Name: "STRING_VALUE",
+ * //           DestinationFileLocation: {
+ * //             S3FileLocation: {
+ * //               Bucket: "STRING_VALUE",
+ * //               Key: "STRING_VALUE",
+ * //             },
+ * //             EfsFileLocation: {
+ * //               FileSystemId: "STRING_VALUE",
+ * //               Path: "STRING_VALUE",
+ * //             },
+ * //           },
+ * //           OverwriteExisting: "TRUE" || "FALSE",
+ * //           SourceFileLocation: "STRING_VALUE",
+ * //         },
+ * //         CustomStepDetails: {
+ * //           Name: "STRING_VALUE",
+ * //           Target: "STRING_VALUE",
+ * //           TimeoutSeconds: Number("int"),
+ * //           SourceFileLocation: "STRING_VALUE",
+ * //         },
+ * //         DeleteStepDetails: {
+ * //           Name: "STRING_VALUE",
+ * //           SourceFileLocation: "STRING_VALUE",
+ * //         },
+ * //         TagStepDetails: {
+ * //           Name: "STRING_VALUE",
+ * //           Tags: [
+ * //             {
+ * //               Key: "STRING_VALUE", // required
+ * //               Value: "STRING_VALUE", // required
+ * //             },
+ * //           ],
+ * //           SourceFileLocation: "STRING_VALUE",
+ * //         },
+ * //         DecryptStepDetails: {
+ * //           Name: "STRING_VALUE",
+ * //           Type: "PGP", // required
+ * //           SourceFileLocation: "STRING_VALUE",
+ * //           OverwriteExisting: "TRUE" || "FALSE",
+ * //           DestinationFileLocation: {
+ * //             S3FileLocation: {
+ * //               Bucket: "STRING_VALUE",
+ * //               Key: "STRING_VALUE",
+ * //             },
+ * //             EfsFileLocation: {
+ * //               FileSystemId: "STRING_VALUE",
+ * //               Path: "STRING_VALUE",
+ * //             },
+ * //           },
+ * //         },
+ * //       },
+ * //     ],
+ * //     WorkflowId: "STRING_VALUE",
+ * //     Tags: [ // Tags
+ * //       { // Tag
+ * //         Key: "STRING_VALUE", // required
+ * //         Value: "STRING_VALUE", // required
+ * //       },
+ * //     ],
+ * //   },
+ * // };
+ *
  * ```
  *
  * @param DescribeWorkflowCommandInput - {@link DescribeWorkflowCommandInput}
@@ -52,6 +178,8 @@ export interface DescribeWorkflowCommandOutput extends DescribeWorkflowResponse,
  * @throws {@link ServiceUnavailableException} (server fault)
  *  <p>The request has failed because the Amazon Web ServicesTransfer Family service is not available.</p>
  *
+ * @throws {@link TransferServiceException}
+ * <p>Base exception class for all service exceptions from Transfer service.</p>
  *
  */
 export declare class DescribeWorkflowCommand extends $Command<DescribeWorkflowCommandInput, DescribeWorkflowCommandOutput, TransferClientResolvedConfig> {

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

@@ -45,6 +45,10 @@ export interface ImportCertificateCommandOutput extends ImportCertificateRespons
  * };
  * const command = new ImportCertificateCommand(input);
  * const response = await client.send(command);
+ * // { // ImportCertificateResponse
+ * //   CertificateId: "STRING_VALUE", // required
+ * // };
+ *
  * ```
  *
  * @param ImportCertificateCommandInput - {@link ImportCertificateCommandInput}
@@ -66,6 +70,8 @@ export interface ImportCertificateCommandOutput extends ImportCertificateRespons
  * @throws {@link ServiceUnavailableException} (server fault)
  *  <p>The request has failed because the Amazon Web ServicesTransfer Family service is not available.</p>
  *
+ * @throws {@link TransferServiceException}
+ * <p>Base exception class for all service exceptions from Transfer service.</p>
  *
  */
 export declare class ImportCertificateCommand extends $Command<ImportCertificateCommandInput, ImportCertificateCommandOutput, TransferClientResolvedConfig> {

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

@@ -40,6 +40,11 @@ export interface ImportHostKeyCommandOutput extends ImportHostKeyResponse, __Met
  * };
  * const command = new ImportHostKeyCommand(input);
  * const response = await client.send(command);
+ * // { // ImportHostKeyResponse
+ * //   ServerId: "STRING_VALUE", // required
+ * //   HostKeyId: "STRING_VALUE", // required
+ * // };
+ *
  * ```
  *
  * @param ImportHostKeyCommandInput - {@link ImportHostKeyCommandInput}
@@ -67,6 +72,8 @@ export interface ImportHostKeyCommandOutput extends ImportHostKeyResponse, __Met
  * @throws {@link ThrottlingException} (client fault)
  *  <p>The request was denied due to request throttling.</p>
  *
+ * @throws {@link TransferServiceException}
+ * <p>Base exception class for all service exceptions from Transfer service.</p>
  *
  */
 export declare class ImportHostKeyCommand extends $Command<ImportHostKeyCommandInput, ImportHostKeyCommandOutput, TransferClientResolvedConfig> {

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

@@ -37,6 +37,12 @@ export interface ImportSshPublicKeyCommandOutput extends ImportSshPublicKeyRespo
  * };
  * const command = new ImportSshPublicKeyCommand(input);
  * const response = await client.send(command);
+ * // { // ImportSshPublicKeyResponse
+ * //   ServerId: "STRING_VALUE", // required
+ * //   SshPublicKeyId: "STRING_VALUE", // required
+ * //   UserName: "STRING_VALUE", // required
+ * // };
+ *
  * ```
  *
  * @param ImportSshPublicKeyCommandInput - {@link ImportSshPublicKeyCommandInput}
@@ -64,6 +70,8 @@ export interface ImportSshPublicKeyCommandOutput extends ImportSshPublicKeyRespo
  * @throws {@link ThrottlingException} (client fault)
  *  <p>The request was denied due to request throttling.</p>
  *
+ * @throws {@link TransferServiceException}
+ * <p>Base exception class for all service exceptions from Transfer service.</p>
  *
  */
 export declare class ImportSshPublicKeyCommand extends $Command<ImportSshPublicKeyCommandInput, ImportSshPublicKeyCommandOutput, TransferClientResolvedConfig> {

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

@@ -33,6 +33,19 @@ export interface ListAccessesCommandOutput extends ListAccessesResponse, __Metad
  * };
  * const command = new ListAccessesCommand(input);
  * const response = await client.send(command);
+ * // { // ListAccessesResponse
+ * //   NextToken: "STRING_VALUE",
+ * //   ServerId: "STRING_VALUE", // required
+ * //   Accesses: [ // ListedAccesses // required
+ * //     { // ListedAccess
+ * //       HomeDirectory: "STRING_VALUE",
+ * //       HomeDirectoryType: "PATH" || "LOGICAL",
+ * //       Role: "STRING_VALUE",
+ * //       ExternalId: "STRING_VALUE",
+ * //     },
+ * //   ],
+ * // };
+ *
  * ```
  *
  * @param ListAccessesCommandInput - {@link ListAccessesCommandInput}
@@ -57,6 +70,8 @@ export interface ListAccessesCommandOutput extends ListAccessesResponse, __Metad
  * @throws {@link ServiceUnavailableException} (server fault)
  *  <p>The request has failed because the Amazon Web ServicesTransfer Family service is not available.</p>
  *
+ * @throws {@link TransferServiceException}
+ * <p>Base exception class for all service exceptions from Transfer service.</p>
  *
  */
 export declare class ListAccessesCommand extends $Command<ListAccessesCommandInput, ListAccessesCommandOutput, TransferClientResolvedConfig> {

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

@@ -37,6 +37,21 @@ export interface ListAgreementsCommandOutput extends ListAgreementsResponse, __M
  * };
  * const command = new ListAgreementsCommand(input);
  * const response = await client.send(command);
+ * // { // ListAgreementsResponse
+ * //   NextToken: "STRING_VALUE",
+ * //   Agreements: [ // ListedAgreements // required
+ * //     { // ListedAgreement
+ * //       Arn: "STRING_VALUE",
+ * //       AgreementId: "STRING_VALUE",
+ * //       Description: "STRING_VALUE",
+ * //       Status: "ACTIVE" || "INACTIVE",
+ * //       ServerId: "STRING_VALUE",
+ * //       LocalProfileId: "STRING_VALUE",
+ * //       PartnerProfileId: "STRING_VALUE",
+ * //     },
+ * //   ],
+ * // };
+ *
  * ```
  *
  * @param ListAgreementsCommandInput - {@link ListAgreementsCommandInput}
@@ -61,6 +76,8 @@ export interface ListAgreementsCommandOutput extends ListAgreementsResponse, __M
  * @throws {@link ServiceUnavailableException} (server fault)
  *  <p>The request has failed because the Amazon Web ServicesTransfer Family service is not available.</p>
  *
+ * @throws {@link TransferServiceException}
+ * <p>Base exception class for all service exceptions from Transfer service.</p>
  *
  */
 export declare class ListAgreementsCommand extends $Command<ListAgreementsCommandInput, ListAgreementsCommandOutput, TransferClientResolvedConfig> {

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

@@ -36,6 +36,22 @@ export interface ListCertificatesCommandOutput extends ListCertificatesResponse,
  * };
  * const command = new ListCertificatesCommand(input);
  * const response = await client.send(command);
+ * // { // ListCertificatesResponse
+ * //   NextToken: "STRING_VALUE",
+ * //   Certificates: [ // ListedCertificates // required
+ * //     { // ListedCertificate
+ * //       Arn: "STRING_VALUE",
+ * //       CertificateId: "STRING_VALUE",
+ * //       Usage: "SIGNING" || "ENCRYPTION",
+ * //       Status: "ACTIVE" || "PENDING_ROTATION" || "INACTIVE",
+ * //       ActiveDate: new Date("TIMESTAMP"),
+ * //       InactiveDate: new Date("TIMESTAMP"),
+ * //       Type: "CERTIFICATE" || "CERTIFICATE_WITH_PRIVATE_KEY",
+ * //       Description: "STRING_VALUE",
+ * //     },
+ * //   ],
+ * // };
+ *
  * ```
  *
  * @param ListCertificatesCommandInput - {@link ListCertificatesCommandInput}
@@ -60,6 +76,8 @@ export interface ListCertificatesCommandOutput extends ListCertificatesResponse,
  * @throws {@link ServiceUnavailableException} (server fault)
  *  <p>The request has failed because the Amazon Web ServicesTransfer Family service is not available.</p>
  *
+ * @throws {@link TransferServiceException}
+ * <p>Base exception class for all service exceptions from Transfer service.</p>
  *
  */
 export declare class ListCertificatesCommand extends $Command<ListCertificatesCommandInput, ListCertificatesCommandOutput, TransferClientResolvedConfig> {

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

@@ -32,6 +32,17 @@ export interface ListConnectorsCommandOutput extends ListConnectorsResponse, __M
  * };
  * const command = new ListConnectorsCommand(input);
  * const response = await client.send(command);
+ * // { // ListConnectorsResponse
+ * //   NextToken: "STRING_VALUE",
+ * //   Connectors: [ // ListedConnectors // required
+ * //     { // ListedConnector
+ * //       Arn: "STRING_VALUE",
+ * //       ConnectorId: "STRING_VALUE",
+ * //       Url: "STRING_VALUE",
+ * //     },
+ * //   ],
+ * // };
+ *
  * ```
  *
  * @param ListConnectorsCommandInput - {@link ListConnectorsCommandInput}
@@ -56,6 +67,8 @@ export interface ListConnectorsCommandOutput extends ListConnectorsResponse, __M
  * @throws {@link ServiceUnavailableException} (server fault)
  *  <p>The request has failed because the Amazon Web ServicesTransfer Family service is not available.</p>
  *
+ * @throws {@link TransferServiceException}
+ * <p>Base exception class for all service exceptions from Transfer service.</p>
  *
  */
 export declare class ListConnectorsCommand extends $Command<ListConnectorsCommandInput, ListConnectorsCommandOutput, TransferClientResolvedConfig> {

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

@@ -33,6 +33,36 @@ export interface ListExecutionsCommandOutput extends ListExecutionsResponse, __M
  * };
  * const command = new ListExecutionsCommand(input);
  * const response = await client.send(command);
+ * // { // ListExecutionsResponse
+ * //   NextToken: "STRING_VALUE",
+ * //   WorkflowId: "STRING_VALUE", // required
+ * //   Executions: [ // ListedExecutions // required
+ * //     { // ListedExecution
+ * //       ExecutionId: "STRING_VALUE",
+ * //       InitialFileLocation: { // FileLocation
+ * //         S3FileLocation: { // S3FileLocation
+ * //           Bucket: "STRING_VALUE",
+ * //           Key: "STRING_VALUE",
+ * //           VersionId: "STRING_VALUE",
+ * //           Etag: "STRING_VALUE",
+ * //         },
+ * //         EfsFileLocation: { // EfsFileLocation
+ * //           FileSystemId: "STRING_VALUE",
+ * //           Path: "STRING_VALUE",
+ * //         },
+ * //       },
+ * //       ServiceMetadata: { // ServiceMetadata
+ * //         UserDetails: { // UserDetails
+ * //           UserName: "STRING_VALUE", // required
+ * //           ServerId: "STRING_VALUE", // required
+ * //           SessionId: "STRING_VALUE",
+ * //         },
+ * //       },
+ * //       Status: "IN_PROGRESS" || "COMPLETED" || "EXCEPTION" || "HANDLING_EXCEPTION",
+ * //     },
+ * //   ],
+ * // };
+ *
  * ```
  *
  * @param ListExecutionsCommandInput - {@link ListExecutionsCommandInput}
@@ -57,6 +87,8 @@ export interface ListExecutionsCommandOutput extends ListExecutionsResponse, __M
  * @throws {@link ServiceUnavailableException} (server fault)
  *  <p>The request has failed because the Amazon Web ServicesTransfer Family service is not available.</p>
  *
+ * @throws {@link TransferServiceException}
+ * <p>Base exception class for all service exceptions from Transfer service.</p>
  *
  */
 export declare class ListExecutionsCommand extends $Command<ListExecutionsCommandInput, ListExecutionsCommandOutput, TransferClientResolvedConfig> {

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

@@ -34,6 +34,21 @@ export interface ListHostKeysCommandOutput extends ListHostKeysResponse, __Metad
  * };
  * const command = new ListHostKeysCommand(input);
  * const response = await client.send(command);
+ * // { // ListHostKeysResponse
+ * //   NextToken: "STRING_VALUE",
+ * //   ServerId: "STRING_VALUE", // required
+ * //   HostKeys: [ // ListedHostKeys // required
+ * //     { // ListedHostKey
+ * //       Arn: "STRING_VALUE", // required
+ * //       HostKeyId: "STRING_VALUE",
+ * //       Fingerprint: "STRING_VALUE",
+ * //       Description: "STRING_VALUE",
+ * //       Type: "STRING_VALUE",
+ * //       DateImported: new Date("TIMESTAMP"),
+ * //     },
+ * //   ],
+ * // };
+ *
  * ```
  *
  * @param ListHostKeysCommandInput - {@link ListHostKeysCommandInput}
@@ -58,6 +73,8 @@ export interface ListHostKeysCommandOutput extends ListHostKeysResponse, __Metad
  * @throws {@link ServiceUnavailableException} (server fault)
  *  <p>The request has failed because the Amazon Web ServicesTransfer Family service is not available.</p>
  *
+ * @throws {@link TransferServiceException}
+ * <p>Base exception class for all service exceptions from Transfer service.</p>
  *
  */
 export declare class ListHostKeysCommand extends $Command<ListHostKeysCommandInput, ListHostKeysCommandOutput, TransferClientResolvedConfig> {

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

@@ -36,6 +36,18 @@ export interface ListProfilesCommandOutput extends ListProfilesResponse, __Metad
  * };
  * const command = new ListProfilesCommand(input);
  * const response = await client.send(command);
+ * // { // ListProfilesResponse
+ * //   NextToken: "STRING_VALUE",
+ * //   Profiles: [ // ListedProfiles // required
+ * //     { // ListedProfile
+ * //       Arn: "STRING_VALUE",
+ * //       ProfileId: "STRING_VALUE",
+ * //       As2Id: "STRING_VALUE",
+ * //       ProfileType: "LOCAL" || "PARTNER",
+ * //     },
+ * //   ],
+ * // };
+ *
  * ```
  *
  * @param ListProfilesCommandInput - {@link ListProfilesCommandInput}
@@ -60,6 +72,8 @@ export interface ListProfilesCommandOutput extends ListProfilesResponse, __Metad
  * @throws {@link ServiceUnavailableException} (server fault)
  *  <p>The request has failed because the Amazon Web ServicesTransfer Family service is not available.</p>
  *
+ * @throws {@link TransferServiceException}
+ * <p>Base exception class for all service exceptions from Transfer service.</p>
  *
  */
 export declare class ListProfilesCommand extends $Command<ListProfilesCommandInput, ListProfilesCommandOutput, TransferClientResolvedConfig> {

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

@@ -33,6 +33,13 @@ export interface ListSecurityPoliciesCommandOutput extends ListSecurityPoliciesR
  * };
  * const command = new ListSecurityPoliciesCommand(input);
  * const response = await client.send(command);
+ * // { // ListSecurityPoliciesResponse
+ * //   NextToken: "STRING_VALUE",
+ * //   SecurityPolicyNames: [ // SecurityPolicyNames // required
+ * //     "STRING_VALUE",
+ * //   ],
+ * // };
+ *
  * ```
  *
  * @param ListSecurityPoliciesCommandInput - {@link ListSecurityPoliciesCommandInput}
@@ -53,6 +60,8 @@ export interface ListSecurityPoliciesCommandOutput extends ListSecurityPoliciesR
  * @throws {@link ServiceUnavailableException} (server fault)
  *  <p>The request has failed because the Amazon Web ServicesTransfer Family service is not available.</p>
  *
+ * @throws {@link TransferServiceException}
+ * <p>Base exception class for all service exceptions from Transfer service.</p>
  *
  */
 export declare class ListSecurityPoliciesCommand extends $Command<ListSecurityPoliciesCommandInput, ListSecurityPoliciesCommandOutput, TransferClientResolvedConfig> {

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

@@ -33,6 +33,22 @@ export interface ListServersCommandOutput extends ListServersResponse, __Metadat
  * };
  * const command = new ListServersCommand(input);
  * const response = await client.send(command);
+ * // { // ListServersResponse
+ * //   NextToken: "STRING_VALUE",
+ * //   Servers: [ // ListedServers // required
+ * //     { // ListedServer
+ * //       Arn: "STRING_VALUE", // required
+ * //       Domain: "S3" || "EFS",
+ * //       IdentityProviderType: "SERVICE_MANAGED" || "API_GATEWAY" || "AWS_DIRECTORY_SERVICE" || "AWS_LAMBDA",
+ * //       EndpointType: "PUBLIC" || "VPC" || "VPC_ENDPOINT",
+ * //       LoggingRole: "STRING_VALUE",
+ * //       ServerId: "STRING_VALUE",
+ * //       State: "OFFLINE" || "ONLINE" || "STARTING" || "STOPPING" || "START_FAILED" || "STOP_FAILED",
+ * //       UserCount: Number("int"),
+ * //     },
+ * //   ],
+ * // };
+ *
  * ```
  *
  * @param ListServersCommandInput - {@link ListServersCommandInput}
@@ -53,6 +69,8 @@ export interface ListServersCommandOutput extends ListServersResponse, __Metadat
  * @throws {@link ServiceUnavailableException} (server fault)
  *  <p>The request has failed because the Amazon Web ServicesTransfer Family service is not available.</p>
  *
+ * @throws {@link TransferServiceException}
+ * <p>Base exception class for all service exceptions from Transfer service.</p>
  *
  */
 export declare class ListServersCommand extends $Command<ListServersCommandInput, ListServersCommandOutput, TransferClientResolvedConfig> {