@aws-sdk/client-transfer 3.296.0 → 3.297.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (75) hide show
  1. package/dist-types/Transfer.d.ts +59 -0
  2. package/dist-types/TransferClient.d.ts +24 -4
  3. package/dist-types/commands/CreateAccessCommand.d.ts +16 -0
  4. package/dist-types/commands/CreateAgreementCommand.d.ts +16 -0
  5. package/dist-types/commands/CreateConnectorCommand.d.ts +16 -0
  6. package/dist-types/commands/CreateProfileCommand.d.ts +16 -0
  7. package/dist-types/commands/CreateServerCommand.d.ts +16 -0
  8. package/dist-types/commands/CreateUserCommand.d.ts +16 -0
  9. package/dist-types/commands/CreateWorkflowCommand.d.ts +16 -0
  10. package/dist-types/commands/DeleteAccessCommand.d.ts +16 -0
  11. package/dist-types/commands/DeleteAgreementCommand.d.ts +16 -0
  12. package/dist-types/commands/DeleteCertificateCommand.d.ts +16 -0
  13. package/dist-types/commands/DeleteConnectorCommand.d.ts +16 -0
  14. package/dist-types/commands/DeleteHostKeyCommand.d.ts +16 -0
  15. package/dist-types/commands/DeleteProfileCommand.d.ts +16 -0
  16. package/dist-types/commands/DeleteServerCommand.d.ts +16 -0
  17. package/dist-types/commands/DeleteSshPublicKeyCommand.d.ts +16 -0
  18. package/dist-types/commands/DeleteUserCommand.d.ts +16 -0
  19. package/dist-types/commands/DeleteWorkflowCommand.d.ts +16 -0
  20. package/dist-types/commands/DescribeAccessCommand.d.ts +16 -0
  21. package/dist-types/commands/DescribeAgreementCommand.d.ts +16 -0
  22. package/dist-types/commands/DescribeCertificateCommand.d.ts +16 -0
  23. package/dist-types/commands/DescribeConnectorCommand.d.ts +16 -0
  24. package/dist-types/commands/DescribeExecutionCommand.d.ts +16 -0
  25. package/dist-types/commands/DescribeHostKeyCommand.d.ts +16 -0
  26. package/dist-types/commands/DescribeProfileCommand.d.ts +16 -0
  27. package/dist-types/commands/DescribeSecurityPolicyCommand.d.ts +16 -0
  28. package/dist-types/commands/DescribeServerCommand.d.ts +16 -0
  29. package/dist-types/commands/DescribeUserCommand.d.ts +16 -0
  30. package/dist-types/commands/DescribeWorkflowCommand.d.ts +16 -0
  31. package/dist-types/commands/ImportCertificateCommand.d.ts +16 -0
  32. package/dist-types/commands/ImportHostKeyCommand.d.ts +16 -0
  33. package/dist-types/commands/ImportSshPublicKeyCommand.d.ts +16 -0
  34. package/dist-types/commands/ListAccessesCommand.d.ts +16 -0
  35. package/dist-types/commands/ListAgreementsCommand.d.ts +16 -0
  36. package/dist-types/commands/ListCertificatesCommand.d.ts +16 -0
  37. package/dist-types/commands/ListConnectorsCommand.d.ts +16 -0
  38. package/dist-types/commands/ListExecutionsCommand.d.ts +16 -0
  39. package/dist-types/commands/ListHostKeysCommand.d.ts +16 -0
  40. package/dist-types/commands/ListProfilesCommand.d.ts +16 -0
  41. package/dist-types/commands/ListSecurityPoliciesCommand.d.ts +16 -0
  42. package/dist-types/commands/ListServersCommand.d.ts +16 -0
  43. package/dist-types/commands/ListTagsForResourceCommand.d.ts +16 -0
  44. package/dist-types/commands/ListUsersCommand.d.ts +16 -0
  45. package/dist-types/commands/ListWorkflowsCommand.d.ts +16 -0
  46. package/dist-types/commands/SendWorkflowStepStateCommand.d.ts +16 -0
  47. package/dist-types/commands/StartFileTransferCommand.d.ts +16 -0
  48. package/dist-types/commands/StartServerCommand.d.ts +16 -0
  49. package/dist-types/commands/StopServerCommand.d.ts +16 -0
  50. package/dist-types/commands/TagResourceCommand.d.ts +16 -0
  51. package/dist-types/commands/TestIdentityProviderCommand.d.ts +16 -0
  52. package/dist-types/commands/UntagResourceCommand.d.ts +16 -0
  53. package/dist-types/commands/UpdateAccessCommand.d.ts +16 -0
  54. package/dist-types/commands/UpdateAgreementCommand.d.ts +16 -0
  55. package/dist-types/commands/UpdateCertificateCommand.d.ts +16 -0
  56. package/dist-types/commands/UpdateConnectorCommand.d.ts +16 -0
  57. package/dist-types/commands/UpdateHostKeyCommand.d.ts +16 -0
  58. package/dist-types/commands/UpdateProfileCommand.d.ts +16 -0
  59. package/dist-types/commands/UpdateServerCommand.d.ts +16 -0
  60. package/dist-types/commands/UpdateUserCommand.d.ts +16 -0
  61. package/dist-types/models/TransferServiceException.d.ts +2 -0
  62. package/dist-types/models/models_0.d.ts +478 -43
  63. package/dist-types/pagination/Interfaces.d.ts +3 -0
  64. package/dist-types/pagination/ListAccessesPaginator.d.ts +3 -0
  65. package/dist-types/pagination/ListAgreementsPaginator.d.ts +3 -0
  66. package/dist-types/pagination/ListCertificatesPaginator.d.ts +3 -0
  67. package/dist-types/pagination/ListConnectorsPaginator.d.ts +3 -0
  68. package/dist-types/pagination/ListExecutionsPaginator.d.ts +3 -0
  69. package/dist-types/pagination/ListProfilesPaginator.d.ts +3 -0
  70. package/dist-types/pagination/ListSecurityPoliciesPaginator.d.ts +3 -0
  71. package/dist-types/pagination/ListServersPaginator.d.ts +3 -0
  72. package/dist-types/pagination/ListTagsForResourcePaginator.d.ts +3 -0
  73. package/dist-types/pagination/ListUsersPaginator.d.ts +3 -0
  74. package/dist-types/pagination/ListWorkflowsPaginator.d.ts +3 -0
  75. package/package.json +3 -3
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DeleteUserRequest } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, TransferClientResolvedConfig } from "../TransferClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DeleteUserCommand}.
8
10
  */
9
11
  export interface DeleteUserCommandInput extends DeleteUserRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DeleteUserCommand}.
13
17
  */
14
18
  export interface DeleteUserCommandOutput extends __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Deletes the user belonging to a file transfer protocol-enabled server you specify.</p>
18
23
  * <p>No response returns from this operation.</p>
19
24
  * <note>
@@ -29,6 +34,8 @@ export interface DeleteUserCommandOutput extends __MetadataBearer {
29
34
  * const response = await client.send(command);
30
35
  * ```
31
36
  *
37
+ * @param DeleteUserCommandInput - {@link DeleteUserCommandInput}
38
+ * @returns {@link DeleteUserCommandOutput}
32
39
  * @see {@link DeleteUserCommandInput} for command's `input` shape.
33
40
  * @see {@link DeleteUserCommandOutput} for command's `response` shape.
34
41
  * @see {@link TransferClientResolvedConfig | config} for TransferClient's `config` shape.
@@ -51,11 +58,20 @@ export interface DeleteUserCommandOutput extends __MetadataBearer {
51
58
  export declare class DeleteUserCommand extends $Command<DeleteUserCommandInput, DeleteUserCommandOutput, TransferClientResolvedConfig> {
52
59
  readonly input: DeleteUserCommandInput;
53
60
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
61
+ /**
62
+ * @public
63
+ */
54
64
  constructor(input: DeleteUserCommandInput);
55
65
  /**
56
66
  * @internal
57
67
  */
58
68
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: TransferClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteUserCommandInput, DeleteUserCommandOutput>;
69
+ /**
70
+ * @internal
71
+ */
59
72
  private serialize;
73
+ /**
74
+ * @internal
75
+ */
60
76
  private deserialize;
61
77
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DeleteWorkflowRequest } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, TransferClientResolvedConfig } from "../TransferClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DeleteWorkflowCommand}.
8
10
  */
9
11
  export interface DeleteWorkflowCommandInput extends DeleteWorkflowRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DeleteWorkflowCommand}.
13
17
  */
14
18
  export interface DeleteWorkflowCommandOutput extends __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Deletes the specified workflow.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface DeleteWorkflowCommandOutput extends __MetadataBearer {
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param DeleteWorkflowCommandInput - {@link DeleteWorkflowCommandInput}
34
+ * @returns {@link DeleteWorkflowCommandOutput}
28
35
  * @see {@link DeleteWorkflowCommandInput} for command's `input` shape.
29
36
  * @see {@link DeleteWorkflowCommandOutput} for command's `response` shape.
30
37
  * @see {@link TransferClientResolvedConfig | config} for TransferClient's `config` shape.
@@ -50,11 +57,20 @@ export interface DeleteWorkflowCommandOutput extends __MetadataBearer {
50
57
  export declare class DeleteWorkflowCommand extends $Command<DeleteWorkflowCommandInput, DeleteWorkflowCommandOutput, TransferClientResolvedConfig> {
51
58
  readonly input: DeleteWorkflowCommandInput;
52
59
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
60
+ /**
61
+ * @public
62
+ */
53
63
  constructor(input: DeleteWorkflowCommandInput);
54
64
  /**
55
65
  * @internal
56
66
  */
57
67
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: TransferClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteWorkflowCommandInput, DeleteWorkflowCommandOutput>;
68
+ /**
69
+ * @internal
70
+ */
58
71
  private serialize;
72
+ /**
73
+ * @internal
74
+ */
59
75
  private deserialize;
60
76
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DescribeAccessRequest, DescribeAccessResponse } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, TransferClientResolvedConfig } from "../TransferClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DescribeAccessCommand}.
8
10
  */
9
11
  export interface DescribeAccessCommandInput extends DescribeAccessRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DescribeAccessCommand}.
13
17
  */
14
18
  export interface DescribeAccessCommandOutput extends DescribeAccessResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Describes the access that is assigned to the specific file transfer protocol-enabled
18
23
  * server, as identified by its <code>ServerId</code> property and its
19
24
  * <code>ExternalId</code>.</p>
@@ -29,6 +34,8 @@ export interface DescribeAccessCommandOutput extends DescribeAccessResponse, __M
29
34
  * const response = await client.send(command);
30
35
  * ```
31
36
  *
37
+ * @param DescribeAccessCommandInput - {@link DescribeAccessCommandInput}
38
+ * @returns {@link DescribeAccessCommandOutput}
32
39
  * @see {@link DescribeAccessCommandInput} for command's `input` shape.
33
40
  * @see {@link DescribeAccessCommandOutput} for command's `response` shape.
34
41
  * @see {@link TransferClientResolvedConfig | config} for TransferClient's `config` shape.
@@ -51,11 +58,20 @@ export interface DescribeAccessCommandOutput extends DescribeAccessResponse, __M
51
58
  export declare class DescribeAccessCommand extends $Command<DescribeAccessCommandInput, DescribeAccessCommandOutput, TransferClientResolvedConfig> {
52
59
  readonly input: DescribeAccessCommandInput;
53
60
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
61
+ /**
62
+ * @public
63
+ */
54
64
  constructor(input: DescribeAccessCommandInput);
55
65
  /**
56
66
  * @internal
57
67
  */
58
68
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: TransferClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeAccessCommandInput, DescribeAccessCommandOutput>;
69
+ /**
70
+ * @internal
71
+ */
59
72
  private serialize;
73
+ /**
74
+ * @internal
75
+ */
60
76
  private deserialize;
61
77
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DescribeAgreementRequest, DescribeAgreementResponse } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, TransferClientResolvedConfig } from "../TransferClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DescribeAgreementCommand}.
8
10
  */
9
11
  export interface DescribeAgreementCommandInput extends DescribeAgreementRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DescribeAgreementCommand}.
13
17
  */
14
18
  export interface DescribeAgreementCommandOutput extends DescribeAgreementResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Describes the agreement that's identified by the <code>AgreementId</code>.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface DescribeAgreementCommandOutput extends DescribeAgreementRespons
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param DescribeAgreementCommandInput - {@link DescribeAgreementCommandInput}
34
+ * @returns {@link DescribeAgreementCommandOutput}
28
35
  * @see {@link DescribeAgreementCommandInput} for command's `input` shape.
29
36
  * @see {@link DescribeAgreementCommandOutput} for command's `response` shape.
30
37
  * @see {@link TransferClientResolvedConfig | config} for TransferClient's `config` shape.
@@ -47,11 +54,20 @@ export interface DescribeAgreementCommandOutput extends DescribeAgreementRespons
47
54
  export declare class DescribeAgreementCommand extends $Command<DescribeAgreementCommandInput, DescribeAgreementCommandOutput, TransferClientResolvedConfig> {
48
55
  readonly input: DescribeAgreementCommandInput;
49
56
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
57
+ /**
58
+ * @public
59
+ */
50
60
  constructor(input: DescribeAgreementCommandInput);
51
61
  /**
52
62
  * @internal
53
63
  */
54
64
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: TransferClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeAgreementCommandInput, DescribeAgreementCommandOutput>;
65
+ /**
66
+ * @internal
67
+ */
55
68
  private serialize;
69
+ /**
70
+ * @internal
71
+ */
56
72
  private deserialize;
57
73
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DescribeCertificateRequest, DescribeCertificateResponse } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, TransferClientResolvedConfig } from "../TransferClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DescribeCertificateCommand}.
8
10
  */
9
11
  export interface DescribeCertificateCommandInput extends DescribeCertificateRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DescribeCertificateCommand}.
13
17
  */
14
18
  export interface DescribeCertificateCommandOutput extends DescribeCertificateResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Describes the certificate that's identified by the <code>CertificateId</code>.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface DescribeCertificateCommandOutput extends DescribeCertificateRes
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param DescribeCertificateCommandInput - {@link DescribeCertificateCommandInput}
34
+ * @returns {@link DescribeCertificateCommandOutput}
28
35
  * @see {@link DescribeCertificateCommandInput} for command's `input` shape.
29
36
  * @see {@link DescribeCertificateCommandOutput} for command's `response` shape.
30
37
  * @see {@link TransferClientResolvedConfig | config} for TransferClient's `config` shape.
@@ -47,11 +54,20 @@ export interface DescribeCertificateCommandOutput extends DescribeCertificateRes
47
54
  export declare class DescribeCertificateCommand extends $Command<DescribeCertificateCommandInput, DescribeCertificateCommandOutput, TransferClientResolvedConfig> {
48
55
  readonly input: DescribeCertificateCommandInput;
49
56
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
57
+ /**
58
+ * @public
59
+ */
50
60
  constructor(input: DescribeCertificateCommandInput);
51
61
  /**
52
62
  * @internal
53
63
  */
54
64
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: TransferClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeCertificateCommandInput, DescribeCertificateCommandOutput>;
65
+ /**
66
+ * @internal
67
+ */
55
68
  private serialize;
69
+ /**
70
+ * @internal
71
+ */
56
72
  private deserialize;
57
73
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DescribeConnectorRequest, DescribeConnectorResponse } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, TransferClientResolvedConfig } from "../TransferClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DescribeConnectorCommand}.
8
10
  */
9
11
  export interface DescribeConnectorCommandInput extends DescribeConnectorRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DescribeConnectorCommand}.
13
17
  */
14
18
  export interface DescribeConnectorCommandOutput extends DescribeConnectorResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Describes the connector that's identified by the <code>ConnectorId.</code>
18
23
  * </p>
19
24
  * @example
@@ -26,6 +31,8 @@ export interface DescribeConnectorCommandOutput extends DescribeConnectorRespons
26
31
  * const response = await client.send(command);
27
32
  * ```
28
33
  *
34
+ * @param DescribeConnectorCommandInput - {@link DescribeConnectorCommandInput}
35
+ * @returns {@link DescribeConnectorCommandOutput}
29
36
  * @see {@link DescribeConnectorCommandInput} for command's `input` shape.
30
37
  * @see {@link DescribeConnectorCommandOutput} for command's `response` shape.
31
38
  * @see {@link TransferClientResolvedConfig | config} for TransferClient's `config` shape.
@@ -48,11 +55,20 @@ export interface DescribeConnectorCommandOutput extends DescribeConnectorRespons
48
55
  export declare class DescribeConnectorCommand extends $Command<DescribeConnectorCommandInput, DescribeConnectorCommandOutput, TransferClientResolvedConfig> {
49
56
  readonly input: DescribeConnectorCommandInput;
50
57
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
58
+ /**
59
+ * @public
60
+ */
51
61
  constructor(input: DescribeConnectorCommandInput);
52
62
  /**
53
63
  * @internal
54
64
  */
55
65
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: TransferClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeConnectorCommandInput, DescribeConnectorCommandOutput>;
66
+ /**
67
+ * @internal
68
+ */
56
69
  private serialize;
70
+ /**
71
+ * @internal
72
+ */
57
73
  private deserialize;
58
74
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DescribeExecutionRequest, DescribeExecutionResponse } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, TransferClientResolvedConfig } from "../TransferClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DescribeExecutionCommand}.
8
10
  */
9
11
  export interface DescribeExecutionCommandInput extends DescribeExecutionRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DescribeExecutionCommand}.
13
17
  */
14
18
  export interface DescribeExecutionCommandOutput extends DescribeExecutionResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>You can use <code>DescribeExecution</code> to check the details of the execution of the specified workflow.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface DescribeExecutionCommandOutput extends DescribeExecutionRespons
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param DescribeExecutionCommandInput - {@link DescribeExecutionCommandInput}
34
+ * @returns {@link DescribeExecutionCommandOutput}
28
35
  * @see {@link DescribeExecutionCommandInput} for command's `input` shape.
29
36
  * @see {@link DescribeExecutionCommandOutput} for command's `response` shape.
30
37
  * @see {@link TransferClientResolvedConfig | config} for TransferClient's `config` shape.
@@ -47,11 +54,20 @@ export interface DescribeExecutionCommandOutput extends DescribeExecutionRespons
47
54
  export declare class DescribeExecutionCommand extends $Command<DescribeExecutionCommandInput, DescribeExecutionCommandOutput, TransferClientResolvedConfig> {
48
55
  readonly input: DescribeExecutionCommandInput;
49
56
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
57
+ /**
58
+ * @public
59
+ */
50
60
  constructor(input: DescribeExecutionCommandInput);
51
61
  /**
52
62
  * @internal
53
63
  */
54
64
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: TransferClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeExecutionCommandInput, DescribeExecutionCommandOutput>;
65
+ /**
66
+ * @internal
67
+ */
55
68
  private serialize;
69
+ /**
70
+ * @internal
71
+ */
56
72
  private deserialize;
57
73
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DescribeHostKeyRequest, DescribeHostKeyResponse } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, TransferClientResolvedConfig } from "../TransferClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DescribeHostKeyCommand}.
8
10
  */
9
11
  export interface DescribeHostKeyCommandInput extends DescribeHostKeyRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DescribeHostKeyCommand}.
13
17
  */
14
18
  export interface DescribeHostKeyCommandOutput extends DescribeHostKeyResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Returns the details of the host key that's specified by the <code>HostKeyId</code> and <code>ServerId</code>.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface DescribeHostKeyCommandOutput extends DescribeHostKeyResponse, _
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param DescribeHostKeyCommandInput - {@link DescribeHostKeyCommandInput}
34
+ * @returns {@link DescribeHostKeyCommandOutput}
28
35
  * @see {@link DescribeHostKeyCommandInput} for command's `input` shape.
29
36
  * @see {@link DescribeHostKeyCommandOutput} for command's `response` shape.
30
37
  * @see {@link TransferClientResolvedConfig | config} for TransferClient's `config` shape.
@@ -47,11 +54,20 @@ export interface DescribeHostKeyCommandOutput extends DescribeHostKeyResponse, _
47
54
  export declare class DescribeHostKeyCommand extends $Command<DescribeHostKeyCommandInput, DescribeHostKeyCommandOutput, TransferClientResolvedConfig> {
48
55
  readonly input: DescribeHostKeyCommandInput;
49
56
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
57
+ /**
58
+ * @public
59
+ */
50
60
  constructor(input: DescribeHostKeyCommandInput);
51
61
  /**
52
62
  * @internal
53
63
  */
54
64
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: TransferClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeHostKeyCommandInput, DescribeHostKeyCommandOutput>;
65
+ /**
66
+ * @internal
67
+ */
55
68
  private serialize;
69
+ /**
70
+ * @internal
71
+ */
56
72
  private deserialize;
57
73
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DescribeProfileRequest, DescribeProfileResponse } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, TransferClientResolvedConfig } from "../TransferClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DescribeProfileCommand}.
8
10
  */
9
11
  export interface DescribeProfileCommandInput extends DescribeProfileRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DescribeProfileCommand}.
13
17
  */
14
18
  export interface DescribeProfileCommandOutput extends DescribeProfileResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Returns the details of the profile that's specified by the <code>ProfileId</code>.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface DescribeProfileCommandOutput extends DescribeProfileResponse, _
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param DescribeProfileCommandInput - {@link DescribeProfileCommandInput}
34
+ * @returns {@link DescribeProfileCommandOutput}
28
35
  * @see {@link DescribeProfileCommandInput} for command's `input` shape.
29
36
  * @see {@link DescribeProfileCommandOutput} for command's `response` shape.
30
37
  * @see {@link TransferClientResolvedConfig | config} for TransferClient's `config` shape.
@@ -47,11 +54,20 @@ export interface DescribeProfileCommandOutput extends DescribeProfileResponse, _
47
54
  export declare class DescribeProfileCommand extends $Command<DescribeProfileCommandInput, DescribeProfileCommandOutput, TransferClientResolvedConfig> {
48
55
  readonly input: DescribeProfileCommandInput;
49
56
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
57
+ /**
58
+ * @public
59
+ */
50
60
  constructor(input: DescribeProfileCommandInput);
51
61
  /**
52
62
  * @internal
53
63
  */
54
64
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: TransferClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeProfileCommandInput, DescribeProfileCommandOutput>;
65
+ /**
66
+ * @internal
67
+ */
55
68
  private serialize;
69
+ /**
70
+ * @internal
71
+ */
56
72
  private deserialize;
57
73
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DescribeSecurityPolicyRequest, DescribeSecurityPolicyResponse } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, TransferClientResolvedConfig } from "../TransferClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DescribeSecurityPolicyCommand}.
8
10
  */
9
11
  export interface DescribeSecurityPolicyCommandInput extends DescribeSecurityPolicyRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DescribeSecurityPolicyCommand}.
13
17
  */
14
18
  export interface DescribeSecurityPolicyCommandOutput extends DescribeSecurityPolicyResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Describes the security policy that is attached to your file transfer protocol-enabled
18
23
  * server. The response contains a description of the security policy's properties. For more
19
24
  * information about security policies, see <a href="https://docs.aws.amazon.com/transfer/latest/userguide/security-policies.html">Working with security
@@ -28,6 +33,8 @@ export interface DescribeSecurityPolicyCommandOutput extends DescribeSecurityPol
28
33
  * const response = await client.send(command);
29
34
  * ```
30
35
  *
36
+ * @param DescribeSecurityPolicyCommandInput - {@link DescribeSecurityPolicyCommandInput}
37
+ * @returns {@link DescribeSecurityPolicyCommandOutput}
31
38
  * @see {@link DescribeSecurityPolicyCommandInput} for command's `input` shape.
32
39
  * @see {@link DescribeSecurityPolicyCommandOutput} for command's `response` shape.
33
40
  * @see {@link TransferClientResolvedConfig | config} for TransferClient's `config` shape.
@@ -50,11 +57,20 @@ export interface DescribeSecurityPolicyCommandOutput extends DescribeSecurityPol
50
57
  export declare class DescribeSecurityPolicyCommand extends $Command<DescribeSecurityPolicyCommandInput, DescribeSecurityPolicyCommandOutput, TransferClientResolvedConfig> {
51
58
  readonly input: DescribeSecurityPolicyCommandInput;
52
59
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
60
+ /**
61
+ * @public
62
+ */
53
63
  constructor(input: DescribeSecurityPolicyCommandInput);
54
64
  /**
55
65
  * @internal
56
66
  */
57
67
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: TransferClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeSecurityPolicyCommandInput, DescribeSecurityPolicyCommandOutput>;
68
+ /**
69
+ * @internal
70
+ */
58
71
  private serialize;
72
+ /**
73
+ * @internal
74
+ */
59
75
  private deserialize;
60
76
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DescribeServerRequest, DescribeServerResponse } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, TransferClientResolvedConfig } from "../TransferClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DescribeServerCommand}.
8
10
  */
9
11
  export interface DescribeServerCommandInput extends DescribeServerRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DescribeServerCommand}.
13
17
  */
14
18
  export interface DescribeServerCommandOutput extends DescribeServerResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Describes a file transfer protocol-enabled server that you specify by passing the
18
23
  * <code>ServerId</code> parameter.</p>
19
24
  * <p>The response contains a description of a server's properties. When you set
@@ -29,6 +34,8 @@ export interface DescribeServerCommandOutput extends DescribeServerResponse, __M
29
34
  * const response = await client.send(command);
30
35
  * ```
31
36
  *
37
+ * @param DescribeServerCommandInput - {@link DescribeServerCommandInput}
38
+ * @returns {@link DescribeServerCommandOutput}
32
39
  * @see {@link DescribeServerCommandInput} for command's `input` shape.
33
40
  * @see {@link DescribeServerCommandOutput} for command's `response` shape.
34
41
  * @see {@link TransferClientResolvedConfig | config} for TransferClient's `config` shape.
@@ -51,11 +58,20 @@ export interface DescribeServerCommandOutput extends DescribeServerResponse, __M
51
58
  export declare class DescribeServerCommand extends $Command<DescribeServerCommandInput, DescribeServerCommandOutput, TransferClientResolvedConfig> {
52
59
  readonly input: DescribeServerCommandInput;
53
60
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
61
+ /**
62
+ * @public
63
+ */
54
64
  constructor(input: DescribeServerCommandInput);
55
65
  /**
56
66
  * @internal
57
67
  */
58
68
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: TransferClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeServerCommandInput, DescribeServerCommandOutput>;
69
+ /**
70
+ * @internal
71
+ */
59
72
  private serialize;
73
+ /**
74
+ * @internal
75
+ */
60
76
  private deserialize;
61
77
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DescribeUserRequest, DescribeUserResponse } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, TransferClientResolvedConfig } from "../TransferClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DescribeUserCommand}.
8
10
  */
9
11
  export interface DescribeUserCommandInput extends DescribeUserRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DescribeUserCommand}.
13
17
  */
14
18
  export interface DescribeUserCommandOutput extends DescribeUserResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Describes the user assigned to the specific file transfer protocol-enabled server, as
18
23
  * identified by its <code>ServerId</code> property.</p>
19
24
  * <p>The response from this call returns the properties of the user associated with the
@@ -28,6 +33,8 @@ export interface DescribeUserCommandOutput extends DescribeUserResponse, __Metad
28
33
  * const response = await client.send(command);
29
34
  * ```
30
35
  *
36
+ * @param DescribeUserCommandInput - {@link DescribeUserCommandInput}
37
+ * @returns {@link DescribeUserCommandOutput}
31
38
  * @see {@link DescribeUserCommandInput} for command's `input` shape.
32
39
  * @see {@link DescribeUserCommandOutput} for command's `response` shape.
33
40
  * @see {@link TransferClientResolvedConfig | config} for TransferClient's `config` shape.
@@ -50,11 +57,20 @@ export interface DescribeUserCommandOutput extends DescribeUserResponse, __Metad
50
57
  export declare class DescribeUserCommand extends $Command<DescribeUserCommandInput, DescribeUserCommandOutput, TransferClientResolvedConfig> {
51
58
  readonly input: DescribeUserCommandInput;
52
59
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
60
+ /**
61
+ * @public
62
+ */
53
63
  constructor(input: DescribeUserCommandInput);
54
64
  /**
55
65
  * @internal
56
66
  */
57
67
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: TransferClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeUserCommandInput, DescribeUserCommandOutput>;
68
+ /**
69
+ * @internal
70
+ */
58
71
  private serialize;
72
+ /**
73
+ * @internal
74
+ */
59
75
  private deserialize;
60
76
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DescribeWorkflowRequest, DescribeWorkflowResponse } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, TransferClientResolvedConfig } from "../TransferClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DescribeWorkflowCommand}.
8
10
  */
9
11
  export interface DescribeWorkflowCommandInput extends DescribeWorkflowRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DescribeWorkflowCommand}.
13
17
  */
14
18
  export interface DescribeWorkflowCommandOutput extends DescribeWorkflowResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Describes the specified workflow.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface DescribeWorkflowCommandOutput extends DescribeWorkflowResponse,
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param DescribeWorkflowCommandInput - {@link DescribeWorkflowCommandInput}
34
+ * @returns {@link DescribeWorkflowCommandOutput}
28
35
  * @see {@link DescribeWorkflowCommandInput} for command's `input` shape.
29
36
  * @see {@link DescribeWorkflowCommandOutput} for command's `response` shape.
30
37
  * @see {@link TransferClientResolvedConfig | config} for TransferClient's `config` shape.
@@ -47,11 +54,20 @@ export interface DescribeWorkflowCommandOutput extends DescribeWorkflowResponse,
47
54
  export declare class DescribeWorkflowCommand extends $Command<DescribeWorkflowCommandInput, DescribeWorkflowCommandOutput, TransferClientResolvedConfig> {
48
55
  readonly input: DescribeWorkflowCommandInput;
49
56
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
57
+ /**
58
+ * @public
59
+ */
50
60
  constructor(input: DescribeWorkflowCommandInput);
51
61
  /**
52
62
  * @internal
53
63
  */
54
64
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: TransferClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeWorkflowCommandInput, DescribeWorkflowCommandOutput>;
65
+ /**
66
+ * @internal
67
+ */
55
68
  private serialize;
69
+ /**
70
+ * @internal
71
+ */
56
72
  private deserialize;
57
73
  }