@aws-sdk/client-transfer 3.321.1 → 3.326.0

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

@@ -54,6 +54,11 @@ export interface CreateAccessCommandOutput extends CreateAccessResponse, __Metad
  * };
  * const command = new CreateAccessCommand(input);
  * const response = await client.send(command);
+ * // { // CreateAccessResponse
+ * //   ServerId: "STRING_VALUE", // required
+ * //   ExternalId: "STRING_VALUE", // required
+ * // };
+ *
  * ```
  *
  * @param CreateAccessCommandInput - {@link CreateAccessCommandInput}
@@ -78,6 +83,8 @@ export interface CreateAccessCommandOutput extends CreateAccessResponse, __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 CreateAccessCommand extends $Command<CreateAccessCommandInput, CreateAccessCommandOutput, TransferClientResolvedConfig> {

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

@@ -48,6 +48,10 @@ export interface CreateAgreementCommandOutput extends CreateAgreementResponse, _
  * };
  * const command = new CreateAgreementCommand(input);
  * const response = await client.send(command);
+ * // { // CreateAgreementResponse
+ * //   AgreementId: "STRING_VALUE", // required
+ * // };
+ *
  * ```
  *
  * @param CreateAgreementCommandInput - {@link CreateAgreementCommandInput}
@@ -75,6 +79,8 @@ export interface CreateAgreementCommandOutput extends CreateAgreementResponse, _
  * @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 CreateAgreementCommand extends $Command<CreateAgreementCommandInput, CreateAgreementCommandOutput, TransferClientResolvedConfig> {

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

@@ -51,6 +51,10 @@ export interface CreateConnectorCommandOutput extends CreateConnectorResponse, _
  * };
  * const command = new CreateConnectorCommand(input);
  * const response = await client.send(command);
+ * // { // CreateConnectorResponse
+ * //   ConnectorId: "STRING_VALUE", // required
+ * // };
+ *
  * ```
  *
  * @param CreateConnectorCommandInput - {@link CreateConnectorCommandInput}
@@ -78,6 +82,8 @@ export interface CreateConnectorCommandOutput extends CreateConnectorResponse, _
  * @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 CreateConnectorCommand extends $Command<CreateConnectorCommandInput, CreateConnectorCommandOutput, TransferClientResolvedConfig> {

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

@@ -41,6 +41,10 @@ export interface CreateProfileCommandOutput extends CreateProfileResponse, __Met
  * };
  * const command = new CreateProfileCommand(input);
  * const response = await client.send(command);
+ * // { // CreateProfileResponse
+ * //   ProfileId: "STRING_VALUE", // required
+ * // };
+ *
  * ```
  *
  * @param CreateProfileCommandInput - {@link CreateProfileCommandInput}
@@ -65,6 +69,8 @@ export interface CreateProfileCommandOutput extends CreateProfileResponse, __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 CreateProfileCommand extends $Command<CreateProfileCommandInput, CreateProfileCommandOutput, TransferClientResolvedConfig> {

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

@@ -92,6 +92,10 @@ export interface CreateServerCommandOutput extends CreateServerResponse, __Metad
  * };
  * const command = new CreateServerCommand(input);
  * const response = await client.send(command);
+ * // { // CreateServerResponse
+ * //   ServerId: "STRING_VALUE", // required
+ * // };
+ *
  * ```
  *
  * @param CreateServerCommandInput - {@link CreateServerCommandInput}
@@ -122,6 +126,8 @@ export interface CreateServerCommandOutput extends CreateServerResponse, __Metad
  * @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 CreateServerCommand extends $Command<CreateServerCommandInput, CreateServerCommandOutput, TransferClientResolvedConfig> {

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

@@ -62,6 +62,11 @@ export interface CreateUserCommandOutput extends CreateUserResponse, __MetadataB
  * };
  * const command = new CreateUserCommand(input);
  * const response = await client.send(command);
+ * // { // CreateUserResponse
+ * //   ServerId: "STRING_VALUE", // required
+ * //   UserName: "STRING_VALUE", // required
+ * // };
+ *
  * ```
  *
  * @param CreateUserCommandInput - {@link CreateUserCommandInput}
@@ -86,6 +91,8 @@ export interface CreateUserCommandOutput extends CreateUserResponse, __MetadataB
  * @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 CreateUserCommand extends $Command<CreateUserCommandInput, CreateUserCommandOutput, TransferClientResolvedConfig> {

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

@@ -152,6 +152,10 @@ export interface CreateWorkflowCommandOutput extends CreateWorkflowResponse, __M
  * };
  * const command = new CreateWorkflowCommand(input);
  * const response = await client.send(command);
+ * // { // CreateWorkflowResponse
+ * //   WorkflowId: "STRING_VALUE", // required
+ * // };
+ *
  * ```
  *
  * @param CreateWorkflowCommandInput - {@link CreateWorkflowCommandInput}
@@ -178,6 +182,8 @@ export interface CreateWorkflowCommandOutput extends CreateWorkflowResponse, __M
  * @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 CreateWorkflowCommand extends $Command<CreateWorkflowCommandInput, CreateWorkflowCommandOutput, TransferClientResolvedConfig> {

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

@@ -33,6 +33,8 @@ export interface DeleteAccessCommandOutput extends __MetadataBearer {
  * };
  * const command = new DeleteAccessCommand(input);
  * const response = await client.send(command);
+ * // {};
+ *
  * ```
  *
  * @param DeleteAccessCommandInput - {@link DeleteAccessCommandInput}
@@ -54,6 +56,8 @@ export interface DeleteAccessCommandOutput extends __MetadataBearer {
  * @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 DeleteAccessCommand extends $Command<DeleteAccessCommandInput, DeleteAccessCommandOutput, TransferClientResolvedConfig> {

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

@@ -32,6 +32,8 @@ export interface DeleteAgreementCommandOutput extends __MetadataBearer {
  * };
  * const command = new DeleteAgreementCommand(input);
  * const response = await client.send(command);
+ * // {};
+ *
  * ```
  *
  * @param DeleteAgreementCommandInput - {@link DeleteAgreementCommandInput}
@@ -53,6 +55,8 @@ export interface DeleteAgreementCommandOutput extends __MetadataBearer {
  * @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 DeleteAgreementCommand extends $Command<DeleteAgreementCommandInput, DeleteAgreementCommandOutput, TransferClientResolvedConfig> {

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

@@ -32,6 +32,8 @@ export interface DeleteCertificateCommandOutput extends __MetadataBearer {
  * };
  * const command = new DeleteCertificateCommand(input);
  * const response = await client.send(command);
+ * // {};
+ *
  * ```
  *
  * @param DeleteCertificateCommandInput - {@link DeleteCertificateCommandInput}
@@ -53,6 +55,8 @@ export interface DeleteCertificateCommandOutput extends __MetadataBearer {
  * @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 DeleteCertificateCommand extends $Command<DeleteCertificateCommandInput, DeleteCertificateCommandOutput, TransferClientResolvedConfig> {

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

@@ -31,6 +31,8 @@ export interface DeleteConnectorCommandOutput extends __MetadataBearer {
  * };
  * const command = new DeleteConnectorCommand(input);
  * const response = await client.send(command);
+ * // {};
+ *
  * ```
  *
  * @param DeleteConnectorCommandInput - {@link DeleteConnectorCommandInput}
@@ -52,6 +54,8 @@ export interface DeleteConnectorCommandOutput extends __MetadataBearer {
  * @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 DeleteConnectorCommand extends $Command<DeleteConnectorCommandInput, DeleteConnectorCommandOutput, TransferClientResolvedConfig> {

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

@@ -32,6 +32,8 @@ export interface DeleteHostKeyCommandOutput extends __MetadataBearer {
  * };
  * const command = new DeleteHostKeyCommand(input);
  * const response = await client.send(command);
+ * // {};
+ *
  * ```
  *
  * @param DeleteHostKeyCommandInput - {@link DeleteHostKeyCommandInput}
@@ -56,6 +58,8 @@ export interface DeleteHostKeyCommandOutput extends __MetadataBearer {
  * @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 DeleteHostKeyCommand extends $Command<DeleteHostKeyCommandInput, DeleteHostKeyCommandOutput, TransferClientResolvedConfig> {

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

@@ -31,6 +31,8 @@ export interface DeleteProfileCommandOutput extends __MetadataBearer {
  * };
  * const command = new DeleteProfileCommand(input);
  * const response = await client.send(command);
+ * // {};
+ *
  * ```
  *
  * @param DeleteProfileCommandInput - {@link DeleteProfileCommandInput}
@@ -52,6 +54,8 @@ export interface DeleteProfileCommandOutput extends __MetadataBearer {
  * @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 DeleteProfileCommand extends $Command<DeleteProfileCommandInput, DeleteProfileCommandOutput, TransferClientResolvedConfig> {

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

@@ -32,6 +32,8 @@ export interface DeleteServerCommandOutput extends __MetadataBearer {
  * };
  * const command = new DeleteServerCommand(input);
  * const response = await client.send(command);
+ * // {};
+ *
  * ```
  *
  * @param DeleteServerCommandInput - {@link DeleteServerCommandInput}
@@ -56,6 +58,8 @@ export interface DeleteServerCommandOutput extends __MetadataBearer {
  * @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 DeleteServerCommand extends $Command<DeleteServerCommandInput, DeleteServerCommandOutput, TransferClientResolvedConfig> {

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

@@ -33,6 +33,8 @@ export interface DeleteSshPublicKeyCommandOutput extends __MetadataBearer {
  * };
  * const command = new DeleteSshPublicKeyCommand(input);
  * const response = await client.send(command);
+ * // {};
+ *
  * ```
  *
  * @param DeleteSshPublicKeyCommandInput - {@link DeleteSshPublicKeyCommandInput}
@@ -57,6 +59,8 @@ export interface DeleteSshPublicKeyCommandOutput extends __MetadataBearer {
  * @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 DeleteSshPublicKeyCommand extends $Command<DeleteSshPublicKeyCommandInput, DeleteSshPublicKeyCommandOutput, TransferClientResolvedConfig> {

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

@@ -36,6 +36,8 @@ export interface DeleteUserCommandOutput extends __MetadataBearer {
  * };
  * const command = new DeleteUserCommand(input);
  * const response = await client.send(command);
+ * // {};
+ *
  * ```
  *
  * @param DeleteUserCommandInput - {@link DeleteUserCommandInput}
@@ -57,6 +59,8 @@ export interface DeleteUserCommandOutput extends __MetadataBearer {
  * @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 DeleteUserCommand extends $Command<DeleteUserCommandInput, DeleteUserCommandOutput, TransferClientResolvedConfig> {

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

@@ -31,6 +31,8 @@ export interface DeleteWorkflowCommandOutput extends __MetadataBearer {
  * };
  * const command = new DeleteWorkflowCommand(input);
  * const response = await client.send(command);
+ * // {};
+ *
  * ```
  *
  * @param DeleteWorkflowCommandInput - {@link DeleteWorkflowCommandInput}
@@ -55,6 +57,8 @@ export interface DeleteWorkflowCommandOutput extends __MetadataBearer {
  * @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 DeleteWorkflowCommand extends $Command<DeleteWorkflowCommandInput, DeleteWorkflowCommandOutput, TransferClientResolvedConfig> {

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

@@ -36,6 +36,30 @@ export interface DescribeAccessCommandOutput extends DescribeAccessResponse, __M
  * };
  * const command = new DescribeAccessCommand(input);
  * const response = await client.send(command);
+ * // { // DescribeAccessResponse
+ * //   ServerId: "STRING_VALUE", // required
+ * //   Access: { // DescribedAccess
+ * //     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",
+ * //     ExternalId: "STRING_VALUE",
+ * //   },
+ * // };
+ *
  * ```
  *
  * @param DescribeAccessCommandInput - {@link DescribeAccessCommandInput}
@@ -57,6 +81,8 @@ export interface DescribeAccessCommandOutput extends DescribeAccessResponse, __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 DescribeAccessCommand extends $Command<DescribeAccessCommandInput, DescribeAccessCommandOutput, TransferClientResolvedConfig> {

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

@@ -32,6 +32,26 @@ export interface DescribeAgreementCommandOutput extends DescribeAgreementRespons
  * };
  * const command = new DescribeAgreementCommand(input);
  * const response = await client.send(command);
+ * // { // DescribeAgreementResponse
+ * //   Agreement: { // DescribedAgreement
+ * //     Arn: "STRING_VALUE", // required
+ * //     AgreementId: "STRING_VALUE",
+ * //     Description: "STRING_VALUE",
+ * //     Status: "ACTIVE" || "INACTIVE",
+ * //     ServerId: "STRING_VALUE",
+ * //     LocalProfileId: "STRING_VALUE",
+ * //     PartnerProfileId: "STRING_VALUE",
+ * //     BaseDirectory: "STRING_VALUE",
+ * //     AccessRole: "STRING_VALUE",
+ * //     Tags: [ // Tags
+ * //       { // Tag
+ * //         Key: "STRING_VALUE", // required
+ * //         Value: "STRING_VALUE", // required
+ * //       },
+ * //     ],
+ * //   },
+ * // };
+ *
  * ```
  *
  * @param DescribeAgreementCommandInput - {@link DescribeAgreementCommandInput}
@@ -53,6 +73,8 @@ export interface DescribeAgreementCommandOutput extends DescribeAgreementRespons
  * @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 DescribeAgreementCommand extends $Command<DescribeAgreementCommandInput, DescribeAgreementCommandOutput, TransferClientResolvedConfig> {

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

@@ -31,6 +31,30 @@ export interface DescribeCertificateCommandOutput extends DescribeCertificateRes
  * };
  * const command = new DescribeCertificateCommand(input);
  * const response = await client.send(command);
+ * // { // DescribeCertificateResponse
+ * //   Certificate: { // DescribedCertificate
+ * //     Arn: "STRING_VALUE", // required
+ * //     CertificateId: "STRING_VALUE",
+ * //     Usage: "SIGNING" || "ENCRYPTION",
+ * //     Status: "ACTIVE" || "PENDING_ROTATION" || "INACTIVE",
+ * //     Certificate: "STRING_VALUE",
+ * //     CertificateChain: "STRING_VALUE",
+ * //     ActiveDate: new Date("TIMESTAMP"),
+ * //     InactiveDate: new Date("TIMESTAMP"),
+ * //     Serial: "STRING_VALUE",
+ * //     NotBeforeDate: new Date("TIMESTAMP"),
+ * //     NotAfterDate: new Date("TIMESTAMP"),
+ * //     Type: "CERTIFICATE" || "CERTIFICATE_WITH_PRIVATE_KEY",
+ * //     Description: "STRING_VALUE",
+ * //     Tags: [ // Tags
+ * //       { // Tag
+ * //         Key: "STRING_VALUE", // required
+ * //         Value: "STRING_VALUE", // required
+ * //       },
+ * //     ],
+ * //   },
+ * // };
+ *
  * ```
  *
  * @param DescribeCertificateCommandInput - {@link DescribeCertificateCommandInput}
@@ -52,6 +76,8 @@ export interface DescribeCertificateCommandOutput extends DescribeCertificateRes
  * @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 DescribeCertificateCommand extends $Command<DescribeCertificateCommandInput, DescribeCertificateCommandOutput, TransferClientResolvedConfig> {

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

@@ -32,6 +32,32 @@ export interface DescribeConnectorCommandOutput extends DescribeConnectorRespons
  * };
  * const command = new DescribeConnectorCommand(input);
  * const response = await client.send(command);
+ * // { // DescribeConnectorResponse
+ * //   Connector: { // DescribedConnector
+ * //     Arn: "STRING_VALUE", // required
+ * //     ConnectorId: "STRING_VALUE",
+ * //     Url: "STRING_VALUE",
+ * //     As2Config: { // As2ConnectorConfig
+ * //       LocalProfileId: "STRING_VALUE",
+ * //       PartnerProfileId: "STRING_VALUE",
+ * //       MessageSubject: "STRING_VALUE",
+ * //       Compression: "ZLIB" || "DISABLED",
+ * //       EncryptionAlgorithm: "AES128_CBC" || "AES192_CBC" || "AES256_CBC" || "NONE",
+ * //       SigningAlgorithm: "SHA256" || "SHA384" || "SHA512" || "SHA1" || "NONE",
+ * //       MdnSigningAlgorithm: "SHA256" || "SHA384" || "SHA512" || "SHA1" || "NONE" || "DEFAULT",
+ * //       MdnResponse: "SYNC" || "NONE",
+ * //     },
+ * //     AccessRole: "STRING_VALUE",
+ * //     LoggingRole: "STRING_VALUE",
+ * //     Tags: [ // Tags
+ * //       { // Tag
+ * //         Key: "STRING_VALUE", // required
+ * //         Value: "STRING_VALUE", // required
+ * //       },
+ * //     ],
+ * //   },
+ * // };
+ *
  * ```
  *
  * @param DescribeConnectorCommandInput - {@link DescribeConnectorCommandInput}
@@ -53,6 +79,8 @@ export interface DescribeConnectorCommandOutput extends DescribeConnectorRespons
  * @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 DescribeConnectorCommand extends $Command<DescribeConnectorCommandInput, DescribeConnectorCommandOutput, TransferClientResolvedConfig> {

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

@@ -32,6 +32,67 @@ export interface DescribeExecutionCommandOutput extends DescribeExecutionRespons
  * };
  * const command = new DescribeExecutionCommand(input);
  * const response = await client.send(command);
+ * // { // DescribeExecutionResponse
+ * //   WorkflowId: "STRING_VALUE", // required
+ * //   Execution: { // DescribedExecution
+ * //     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",
+ * //       },
+ * //     },
+ * //     ExecutionRole: "STRING_VALUE",
+ * //     LoggingConfiguration: { // LoggingConfiguration
+ * //       LoggingRole: "STRING_VALUE",
+ * //       LogGroupName: "STRING_VALUE",
+ * //     },
+ * //     PosixProfile: { // PosixProfile
+ * //       Uid: Number("long"), // required
+ * //       Gid: Number("long"), // required
+ * //       SecondaryGids: [ // SecondaryGids
+ * //         Number("long"),
+ * //       ],
+ * //     },
+ * //     Status: "IN_PROGRESS" || "COMPLETED" || "EXCEPTION" || "HANDLING_EXCEPTION",
+ * //     Results: { // ExecutionResults
+ * //       Steps: [ // ExecutionStepResults
+ * //         { // ExecutionStepResult
+ * //           StepType: "COPY" || "CUSTOM" || "TAG" || "DELETE" || "DECRYPT",
+ * //           Outputs: "STRING_VALUE",
+ * //           Error: { // ExecutionError
+ * //             Type: "PERMISSION_DENIED" || "CUSTOM_STEP_FAILED" || "THROTTLED" || "ALREADY_EXISTS" || "NOT_FOUND" || "BAD_REQUEST" || "TIMEOUT" || "INTERNAL_SERVER_ERROR", // required
+ * //             Message: "STRING_VALUE", // required
+ * //           },
+ * //         },
+ * //       ],
+ * //       OnExceptionSteps: [
+ * //         {
+ * //           StepType: "COPY" || "CUSTOM" || "TAG" || "DELETE" || "DECRYPT",
+ * //           Outputs: "STRING_VALUE",
+ * //           Error: {
+ * //             Type: "PERMISSION_DENIED" || "CUSTOM_STEP_FAILED" || "THROTTLED" || "ALREADY_EXISTS" || "NOT_FOUND" || "BAD_REQUEST" || "TIMEOUT" || "INTERNAL_SERVER_ERROR", // required
+ * //             Message: "STRING_VALUE", // required
+ * //           },
+ * //         },
+ * //       ],
+ * //     },
+ * //   },
+ * // };
+ *
  * ```
  *
  * @param DescribeExecutionCommandInput - {@link DescribeExecutionCommandInput}
@@ -53,6 +114,8 @@ export interface DescribeExecutionCommandOutput extends DescribeExecutionRespons
  * @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 DescribeExecutionCommand extends $Command<DescribeExecutionCommandInput, DescribeExecutionCommandOutput, TransferClientResolvedConfig> {

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

@@ -32,6 +32,23 @@ export interface DescribeHostKeyCommandOutput extends DescribeHostKeyResponse, _
  * };
  * const command = new DescribeHostKeyCommand(input);
  * const response = await client.send(command);
+ * // { // DescribeHostKeyResponse
+ * //   HostKey: { // DescribedHostKey
+ * //     Arn: "STRING_VALUE", // required
+ * //     HostKeyId: "STRING_VALUE",
+ * //     HostKeyFingerprint: "STRING_VALUE",
+ * //     Description: "STRING_VALUE",
+ * //     Type: "STRING_VALUE",
+ * //     DateImported: new Date("TIMESTAMP"),
+ * //     Tags: [ // Tags
+ * //       { // Tag
+ * //         Key: "STRING_VALUE", // required
+ * //         Value: "STRING_VALUE", // required
+ * //       },
+ * //     ],
+ * //   },
+ * // };
+ *
  * ```
  *
  * @param DescribeHostKeyCommandInput - {@link DescribeHostKeyCommandInput}
@@ -53,6 +70,8 @@ export interface DescribeHostKeyCommandOutput extends DescribeHostKeyResponse, _
  * @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 DescribeHostKeyCommand extends $Command<DescribeHostKeyCommandInput, DescribeHostKeyCommandOutput, TransferClientResolvedConfig> {

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

@@ -31,6 +31,24 @@ export interface DescribeProfileCommandOutput extends DescribeProfileResponse, _
  * };
  * const command = new DescribeProfileCommand(input);
  * const response = await client.send(command);
+ * // { // DescribeProfileResponse
+ * //   Profile: { // DescribedProfile
+ * //     Arn: "STRING_VALUE", // required
+ * //     ProfileId: "STRING_VALUE",
+ * //     ProfileType: "LOCAL" || "PARTNER",
+ * //     As2Id: "STRING_VALUE",
+ * //     CertificateIds: [ // CertificateIds
+ * //       "STRING_VALUE",
+ * //     ],
+ * //     Tags: [ // Tags
+ * //       { // Tag
+ * //         Key: "STRING_VALUE", // required
+ * //         Value: "STRING_VALUE", // required
+ * //       },
+ * //     ],
+ * //   },
+ * // };
+ *
  * ```
  *
  * @param DescribeProfileCommandInput - {@link DescribeProfileCommandInput}
@@ -52,6 +70,8 @@ export interface DescribeProfileCommandOutput extends DescribeProfileResponse, _
  * @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 DescribeProfileCommand extends $Command<DescribeProfileCommandInput, DescribeProfileCommandOutput, TransferClientResolvedConfig> {