@aws-sdk/client-transfer 3.295.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 +30 -30
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ListUsersRequest, ListUsersResponse } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, TransferClientResolvedConfig } from "../TransferClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ListUsersCommand}.
8
10
  */
9
11
  export interface ListUsersCommandInput extends ListUsersRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ListUsersCommand}.
13
17
  */
14
18
  export interface ListUsersCommandOutput extends ListUsersResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Lists the users for a file transfer protocol-enabled server that you specify by passing
18
23
  * the <code>ServerId</code> parameter.</p>
19
24
  * @example
@@ -26,6 +31,8 @@ export interface ListUsersCommandOutput extends ListUsersResponse, __MetadataBea
26
31
  * const response = await client.send(command);
27
32
  * ```
28
33
  *
34
+ * @param ListUsersCommandInput - {@link ListUsersCommandInput}
35
+ * @returns {@link ListUsersCommandOutput}
29
36
  * @see {@link ListUsersCommandInput} for command's `input` shape.
30
37
  * @see {@link ListUsersCommandOutput} for command's `response` shape.
31
38
  * @see {@link TransferClientResolvedConfig | config} for TransferClient's `config` shape.
@@ -51,11 +58,20 @@ export interface ListUsersCommandOutput extends ListUsersResponse, __MetadataBea
51
58
  export declare class ListUsersCommand extends $Command<ListUsersCommandInput, ListUsersCommandOutput, TransferClientResolvedConfig> {
52
59
  readonly input: ListUsersCommandInput;
53
60
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
61
+ /**
62
+ * @public
63
+ */
54
64
  constructor(input: ListUsersCommandInput);
55
65
  /**
56
66
  * @internal
57
67
  */
58
68
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: TransferClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListUsersCommandInput, ListUsersCommandOutput>;
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 { ListWorkflowsRequest, ListWorkflowsResponse } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, TransferClientResolvedConfig } from "../TransferClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ListWorkflowsCommand}.
8
10
  */
9
11
  export interface ListWorkflowsCommandInput extends ListWorkflowsRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ListWorkflowsCommand}.
13
17
  */
14
18
  export interface ListWorkflowsCommandOutput extends ListWorkflowsResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Lists all of your workflows.</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 ListWorkflowsCommandOutput extends ListWorkflowsResponse, __Met
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param ListWorkflowsCommandInput - {@link ListWorkflowsCommandInput}
34
+ * @returns {@link ListWorkflowsCommandOutput}
28
35
  * @see {@link ListWorkflowsCommandInput} for command's `input` shape.
29
36
  * @see {@link ListWorkflowsCommandOutput} for command's `response` shape.
30
37
  * @see {@link TransferClientResolvedConfig | config} for TransferClient's `config` shape.
@@ -46,11 +53,20 @@ export interface ListWorkflowsCommandOutput extends ListWorkflowsResponse, __Met
46
53
  export declare class ListWorkflowsCommand extends $Command<ListWorkflowsCommandInput, ListWorkflowsCommandOutput, TransferClientResolvedConfig> {
47
54
  readonly input: ListWorkflowsCommandInput;
48
55
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
56
+ /**
57
+ * @public
58
+ */
49
59
  constructor(input: ListWorkflowsCommandInput);
50
60
  /**
51
61
  * @internal
52
62
  */
53
63
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: TransferClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListWorkflowsCommandInput, ListWorkflowsCommandOutput>;
64
+ /**
65
+ * @internal
66
+ */
54
67
  private serialize;
68
+ /**
69
+ * @internal
70
+ */
55
71
  private deserialize;
56
72
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { SendWorkflowStepStateRequest, SendWorkflowStepStateResponse } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, TransferClientResolvedConfig } from "../TransferClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link SendWorkflowStepStateCommand}.
8
10
  */
9
11
  export interface SendWorkflowStepStateCommandInput extends SendWorkflowStepStateRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link SendWorkflowStepStateCommand}.
13
17
  */
14
18
  export interface SendWorkflowStepStateCommandOutput extends SendWorkflowStepStateResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Sends a callback for asynchronous custom steps.</p>
18
23
  * <p>
19
24
  * The <code>ExecutionId</code>, <code>WorkflowId</code>, and <code>Token</code> are passed to the target resource during execution of a custom step of a workflow.
@@ -29,6 +34,8 @@ export interface SendWorkflowStepStateCommandOutput extends SendWorkflowStepStat
29
34
  * const response = await client.send(command);
30
35
  * ```
31
36
  *
37
+ * @param SendWorkflowStepStateCommandInput - {@link SendWorkflowStepStateCommandInput}
38
+ * @returns {@link SendWorkflowStepStateCommandOutput}
32
39
  * @see {@link SendWorkflowStepStateCommandInput} for command's `input` shape.
33
40
  * @see {@link SendWorkflowStepStateCommandOutput} for command's `response` shape.
34
41
  * @see {@link TransferClientResolvedConfig | config} for TransferClient's `config` shape.
@@ -57,11 +64,20 @@ export interface SendWorkflowStepStateCommandOutput extends SendWorkflowStepStat
57
64
  export declare class SendWorkflowStepStateCommand extends $Command<SendWorkflowStepStateCommandInput, SendWorkflowStepStateCommandOutput, TransferClientResolvedConfig> {
58
65
  readonly input: SendWorkflowStepStateCommandInput;
59
66
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
67
+ /**
68
+ * @public
69
+ */
60
70
  constructor(input: SendWorkflowStepStateCommandInput);
61
71
  /**
62
72
  * @internal
63
73
  */
64
74
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: TransferClientResolvedConfig, options?: __HttpHandlerOptions): Handler<SendWorkflowStepStateCommandInput, SendWorkflowStepStateCommandOutput>;
75
+ /**
76
+ * @internal
77
+ */
65
78
  private serialize;
79
+ /**
80
+ * @internal
81
+ */
66
82
  private deserialize;
67
83
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { StartFileTransferRequest, StartFileTransferResponse } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, TransferClientResolvedConfig } from "../TransferClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link StartFileTransferCommand}.
8
10
  */
9
11
  export interface StartFileTransferCommandInput extends StartFileTransferRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link StartFileTransferCommand}.
13
17
  */
14
18
  export interface StartFileTransferCommandOutput extends StartFileTransferResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Begins an outbound file transfer to a remote AS2 server. You specify the <code>ConnectorId</code> and the file
18
23
  * paths for where to send the files. </p>
19
24
  * @example
@@ -26,6 +31,8 @@ export interface StartFileTransferCommandOutput extends StartFileTransferRespons
26
31
  * const response = await client.send(command);
27
32
  * ```
28
33
  *
34
+ * @param StartFileTransferCommandInput - {@link StartFileTransferCommandInput}
35
+ * @returns {@link StartFileTransferCommandOutput}
29
36
  * @see {@link StartFileTransferCommandInput} for command's `input` shape.
30
37
  * @see {@link StartFileTransferCommandOutput} for command's `response` shape.
31
38
  * @see {@link TransferClientResolvedConfig | config} for TransferClient's `config` shape.
@@ -51,11 +58,20 @@ export interface StartFileTransferCommandOutput extends StartFileTransferRespons
51
58
  export declare class StartFileTransferCommand extends $Command<StartFileTransferCommandInput, StartFileTransferCommandOutput, TransferClientResolvedConfig> {
52
59
  readonly input: StartFileTransferCommandInput;
53
60
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
61
+ /**
62
+ * @public
63
+ */
54
64
  constructor(input: StartFileTransferCommandInput);
55
65
  /**
56
66
  * @internal
57
67
  */
58
68
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: TransferClientResolvedConfig, options?: __HttpHandlerOptions): Handler<StartFileTransferCommandInput, StartFileTransferCommandOutput>;
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 { StartServerRequest } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, TransferClientResolvedConfig } from "../TransferClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link StartServerCommand}.
8
10
  */
9
11
  export interface StartServerCommandInput extends StartServerRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link StartServerCommand}.
13
17
  */
14
18
  export interface StartServerCommandOutput extends __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Changes the state of a file transfer protocol-enabled server from <code>OFFLINE</code> to
18
23
  * <code>ONLINE</code>. It has no impact on a server that is already <code>ONLINE</code>. An
19
24
  * <code>ONLINE</code> server can accept and process file transfer jobs.</p>
@@ -31,6 +36,8 @@ export interface StartServerCommandOutput extends __MetadataBearer {
31
36
  * const response = await client.send(command);
32
37
  * ```
33
38
  *
39
+ * @param StartServerCommandInput - {@link StartServerCommandInput}
40
+ * @returns {@link StartServerCommandOutput}
34
41
  * @see {@link StartServerCommandInput} for command's `input` shape.
35
42
  * @see {@link StartServerCommandOutput} for command's `response` shape.
36
43
  * @see {@link TransferClientResolvedConfig | config} for TransferClient's `config` shape.
@@ -56,11 +63,20 @@ export interface StartServerCommandOutput extends __MetadataBearer {
56
63
  export declare class StartServerCommand extends $Command<StartServerCommandInput, StartServerCommandOutput, TransferClientResolvedConfig> {
57
64
  readonly input: StartServerCommandInput;
58
65
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
66
+ /**
67
+ * @public
68
+ */
59
69
  constructor(input: StartServerCommandInput);
60
70
  /**
61
71
  * @internal
62
72
  */
63
73
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: TransferClientResolvedConfig, options?: __HttpHandlerOptions): Handler<StartServerCommandInput, StartServerCommandOutput>;
74
+ /**
75
+ * @internal
76
+ */
64
77
  private serialize;
78
+ /**
79
+ * @internal
80
+ */
65
81
  private deserialize;
66
82
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { StopServerRequest } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, TransferClientResolvedConfig } from "../TransferClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link StopServerCommand}.
8
10
  */
9
11
  export interface StopServerCommandInput extends StopServerRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link StopServerCommand}.
13
17
  */
14
18
  export interface StopServerCommandOutput extends __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Changes the state of a file transfer protocol-enabled server from <code>ONLINE</code> to
18
23
  * <code>OFFLINE</code>. An <code>OFFLINE</code> server cannot accept and process file transfer
19
24
  * jobs. Information tied to your server, such as server and user properties, are not affected by
@@ -36,6 +41,8 @@ export interface StopServerCommandOutput extends __MetadataBearer {
36
41
  * const response = await client.send(command);
37
42
  * ```
38
43
  *
44
+ * @param StopServerCommandInput - {@link StopServerCommandInput}
45
+ * @returns {@link StopServerCommandOutput}
39
46
  * @see {@link StopServerCommandInput} for command's `input` shape.
40
47
  * @see {@link StopServerCommandOutput} for command's `response` shape.
41
48
  * @see {@link TransferClientResolvedConfig | config} for TransferClient's `config` shape.
@@ -61,11 +68,20 @@ export interface StopServerCommandOutput extends __MetadataBearer {
61
68
  export declare class StopServerCommand extends $Command<StopServerCommandInput, StopServerCommandOutput, TransferClientResolvedConfig> {
62
69
  readonly input: StopServerCommandInput;
63
70
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
71
+ /**
72
+ * @public
73
+ */
64
74
  constructor(input: StopServerCommandInput);
65
75
  /**
66
76
  * @internal
67
77
  */
68
78
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: TransferClientResolvedConfig, options?: __HttpHandlerOptions): Handler<StopServerCommandInput, StopServerCommandOutput>;
79
+ /**
80
+ * @internal
81
+ */
69
82
  private serialize;
83
+ /**
84
+ * @internal
85
+ */
70
86
  private deserialize;
71
87
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { TagResourceRequest } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, TransferClientResolvedConfig } from "../TransferClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link TagResourceCommand}.
8
10
  */
9
11
  export interface TagResourceCommandInput extends TagResourceRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link TagResourceCommand}.
13
17
  */
14
18
  export interface TagResourceCommandOutput extends __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Attaches a key-value pair to a resource, as identified by its Amazon Resource Name (ARN).
18
23
  * Resources are users, servers, roles, and other entities.</p>
19
24
  * <p>There is no response returned from this call.</p>
@@ -27,6 +32,8 @@ export interface TagResourceCommandOutput extends __MetadataBearer {
27
32
  * const response = await client.send(command);
28
33
  * ```
29
34
  *
35
+ * @param TagResourceCommandInput - {@link TagResourceCommandInput}
36
+ * @returns {@link TagResourceCommandOutput}
30
37
  * @see {@link TagResourceCommandInput} for command's `input` shape.
31
38
  * @see {@link TagResourceCommandOutput} for command's `response` shape.
32
39
  * @see {@link TransferClientResolvedConfig | config} for TransferClient's `config` shape.
@@ -49,11 +56,20 @@ export interface TagResourceCommandOutput extends __MetadataBearer {
49
56
  export declare class TagResourceCommand extends $Command<TagResourceCommandInput, TagResourceCommandOutput, TransferClientResolvedConfig> {
50
57
  readonly input: TagResourceCommandInput;
51
58
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
59
+ /**
60
+ * @public
61
+ */
52
62
  constructor(input: TagResourceCommandInput);
53
63
  /**
54
64
  * @internal
55
65
  */
56
66
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: TransferClientResolvedConfig, options?: __HttpHandlerOptions): Handler<TagResourceCommandInput, TagResourceCommandOutput>;
67
+ /**
68
+ * @internal
69
+ */
57
70
  private serialize;
71
+ /**
72
+ * @internal
73
+ */
58
74
  private deserialize;
59
75
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { TestIdentityProviderRequest, TestIdentityProviderResponse } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, TransferClientResolvedConfig } from "../TransferClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link TestIdentityProviderCommand}.
8
10
  */
9
11
  export interface TestIdentityProviderCommandInput extends TestIdentityProviderRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link TestIdentityProviderCommand}.
13
17
  */
14
18
  export interface TestIdentityProviderCommandOutput extends TestIdentityProviderResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>If the <code>IdentityProviderType</code> of a file transfer protocol-enabled server is
18
23
  * <code>AWS_DIRECTORY_SERVICE</code> or <code>API_Gateway</code>, tests whether your identity
19
24
  * provider is set up successfully. We highly recommend that you call this operation to test your
@@ -63,6 +68,8 @@ export interface TestIdentityProviderCommandOutput extends TestIdentityProviderR
63
68
  * const response = await client.send(command);
64
69
  * ```
65
70
  *
71
+ * @param TestIdentityProviderCommandInput - {@link TestIdentityProviderCommandInput}
72
+ * @returns {@link TestIdentityProviderCommandOutput}
66
73
  * @see {@link TestIdentityProviderCommandInput} for command's `input` shape.
67
74
  * @see {@link TestIdentityProviderCommandOutput} for command's `response` shape.
68
75
  * @see {@link TransferClientResolvedConfig | config} for TransferClient's `config` shape.
@@ -85,11 +92,20 @@ export interface TestIdentityProviderCommandOutput extends TestIdentityProviderR
85
92
  export declare class TestIdentityProviderCommand extends $Command<TestIdentityProviderCommandInput, TestIdentityProviderCommandOutput, TransferClientResolvedConfig> {
86
93
  readonly input: TestIdentityProviderCommandInput;
87
94
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
95
+ /**
96
+ * @public
97
+ */
88
98
  constructor(input: TestIdentityProviderCommandInput);
89
99
  /**
90
100
  * @internal
91
101
  */
92
102
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: TransferClientResolvedConfig, options?: __HttpHandlerOptions): Handler<TestIdentityProviderCommandInput, TestIdentityProviderCommandOutput>;
103
+ /**
104
+ * @internal
105
+ */
93
106
  private serialize;
107
+ /**
108
+ * @internal
109
+ */
94
110
  private deserialize;
95
111
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { UntagResourceRequest } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, TransferClientResolvedConfig } from "../TransferClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link UntagResourceCommand}.
8
10
  */
9
11
  export interface UntagResourceCommandInput extends UntagResourceRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link UntagResourceCommand}.
13
17
  */
14
18
  export interface UntagResourceCommandOutput extends __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Detaches a key-value pair from a resource, as identified by its Amazon Resource Name
18
23
  * (ARN). Resources are users, servers, roles, and other entities.</p>
19
24
  * <p>No response is returned from this call.</p>
@@ -27,6 +32,8 @@ export interface UntagResourceCommandOutput extends __MetadataBearer {
27
32
  * const response = await client.send(command);
28
33
  * ```
29
34
  *
35
+ * @param UntagResourceCommandInput - {@link UntagResourceCommandInput}
36
+ * @returns {@link UntagResourceCommandOutput}
30
37
  * @see {@link UntagResourceCommandInput} for command's `input` shape.
31
38
  * @see {@link UntagResourceCommandOutput} for command's `response` shape.
32
39
  * @see {@link TransferClientResolvedConfig | config} for TransferClient's `config` shape.
@@ -49,11 +56,20 @@ export interface UntagResourceCommandOutput extends __MetadataBearer {
49
56
  export declare class UntagResourceCommand extends $Command<UntagResourceCommandInput, UntagResourceCommandOutput, TransferClientResolvedConfig> {
50
57
  readonly input: UntagResourceCommandInput;
51
58
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
59
+ /**
60
+ * @public
61
+ */
52
62
  constructor(input: UntagResourceCommandInput);
53
63
  /**
54
64
  * @internal
55
65
  */
56
66
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: TransferClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UntagResourceCommandInput, UntagResourceCommandOutput>;
67
+ /**
68
+ * @internal
69
+ */
57
70
  private serialize;
71
+ /**
72
+ * @internal
73
+ */
58
74
  private deserialize;
59
75
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { UpdateAccessRequest, UpdateAccessResponse } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, TransferClientResolvedConfig } from "../TransferClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link UpdateAccessCommand}.
8
10
  */
9
11
  export interface UpdateAccessCommandInput extends UpdateAccessRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link UpdateAccessCommand}.
13
17
  */
14
18
  export interface UpdateAccessCommandOutput extends UpdateAccessResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Allows you to update parameters for the access specified in the <code>ServerID</code> and
18
23
  * <code>ExternalID</code> parameters.</p>
19
24
  * @example
@@ -26,6 +31,8 @@ export interface UpdateAccessCommandOutput extends UpdateAccessResponse, __Metad
26
31
  * const response = await client.send(command);
27
32
  * ```
28
33
  *
34
+ * @param UpdateAccessCommandInput - {@link UpdateAccessCommandInput}
35
+ * @returns {@link UpdateAccessCommandOutput}
29
36
  * @see {@link UpdateAccessCommandInput} for command's `input` shape.
30
37
  * @see {@link UpdateAccessCommandOutput} for command's `response` shape.
31
38
  * @see {@link TransferClientResolvedConfig | config} for TransferClient's `config` shape.
@@ -54,11 +61,20 @@ export interface UpdateAccessCommandOutput extends UpdateAccessResponse, __Metad
54
61
  export declare class UpdateAccessCommand extends $Command<UpdateAccessCommandInput, UpdateAccessCommandOutput, TransferClientResolvedConfig> {
55
62
  readonly input: UpdateAccessCommandInput;
56
63
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
64
+ /**
65
+ * @public
66
+ */
57
67
  constructor(input: UpdateAccessCommandInput);
58
68
  /**
59
69
  * @internal
60
70
  */
61
71
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: TransferClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateAccessCommandInput, UpdateAccessCommandOutput>;
72
+ /**
73
+ * @internal
74
+ */
62
75
  private serialize;
76
+ /**
77
+ * @internal
78
+ */
63
79
  private deserialize;
64
80
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { UpdateAgreementRequest, UpdateAgreementResponse } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, TransferClientResolvedConfig } from "../TransferClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link UpdateAgreementCommand}.
8
10
  */
9
11
  export interface UpdateAgreementCommandInput extends UpdateAgreementRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link UpdateAgreementCommand}.
13
17
  */
14
18
  export interface UpdateAgreementCommandOutput extends UpdateAgreementResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Updates some of the parameters for an existing agreement. Provide the
18
23
  * <code>AgreementId</code> and the <code>ServerId</code> for the agreement that you want to
19
24
  * update, along with the new values for the parameters to update.</p>
@@ -27,6 +32,8 @@ export interface UpdateAgreementCommandOutput extends UpdateAgreementResponse, _
27
32
  * const response = await client.send(command);
28
33
  * ```
29
34
  *
35
+ * @param UpdateAgreementCommandInput - {@link UpdateAgreementCommandInput}
36
+ * @returns {@link UpdateAgreementCommandOutput}
30
37
  * @see {@link UpdateAgreementCommandInput} for command's `input` shape.
31
38
  * @see {@link UpdateAgreementCommandOutput} for command's `response` shape.
32
39
  * @see {@link TransferClientResolvedConfig | config} for TransferClient's `config` shape.
@@ -55,11 +62,20 @@ export interface UpdateAgreementCommandOutput extends UpdateAgreementResponse, _
55
62
  export declare class UpdateAgreementCommand extends $Command<UpdateAgreementCommandInput, UpdateAgreementCommandOutput, TransferClientResolvedConfig> {
56
63
  readonly input: UpdateAgreementCommandInput;
57
64
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
65
+ /**
66
+ * @public
67
+ */
58
68
  constructor(input: UpdateAgreementCommandInput);
59
69
  /**
60
70
  * @internal
61
71
  */
62
72
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: TransferClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateAgreementCommandInput, UpdateAgreementCommandOutput>;
73
+ /**
74
+ * @internal
75
+ */
63
76
  private serialize;
77
+ /**
78
+ * @internal
79
+ */
64
80
  private deserialize;
65
81
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { UpdateCertificateRequest, UpdateCertificateResponse } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, TransferClientResolvedConfig } from "../TransferClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link UpdateCertificateCommand}.
8
10
  */
9
11
  export interface UpdateCertificateCommandInput extends UpdateCertificateRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link UpdateCertificateCommand}.
13
17
  */
14
18
  export interface UpdateCertificateCommandOutput extends UpdateCertificateResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Updates the active and inactive dates for a certificate.</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 UpdateCertificateCommandOutput extends UpdateCertificateRespons
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param UpdateCertificateCommandInput - {@link UpdateCertificateCommandInput}
34
+ * @returns {@link UpdateCertificateCommandOutput}
28
35
  * @see {@link UpdateCertificateCommandInput} for command's `input` shape.
29
36
  * @see {@link UpdateCertificateCommandOutput} for command's `response` shape.
30
37
  * @see {@link TransferClientResolvedConfig | config} for TransferClient's `config` shape.
@@ -50,11 +57,20 @@ export interface UpdateCertificateCommandOutput extends UpdateCertificateRespons
50
57
  export declare class UpdateCertificateCommand extends $Command<UpdateCertificateCommandInput, UpdateCertificateCommandOutput, TransferClientResolvedConfig> {
51
58
  readonly input: UpdateCertificateCommandInput;
52
59
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
60
+ /**
61
+ * @public
62
+ */
53
63
  constructor(input: UpdateCertificateCommandInput);
54
64
  /**
55
65
  * @internal
56
66
  */
57
67
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: TransferClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateCertificateCommandInput, UpdateCertificateCommandOutput>;
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 { UpdateConnectorRequest, UpdateConnectorResponse } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, TransferClientResolvedConfig } from "../TransferClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link UpdateConnectorCommand}.
8
10
  */
9
11
  export interface UpdateConnectorCommandInput extends UpdateConnectorRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link UpdateConnectorCommand}.
13
17
  */
14
18
  export interface UpdateConnectorCommandOutput extends UpdateConnectorResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Updates some of the parameters for an existing connector. Provide the
18
23
  * <code>ConnectorId</code> for the connector that you want to update, along with the new
19
24
  * values for the parameters to update.</p>
@@ -27,6 +32,8 @@ export interface UpdateConnectorCommandOutput extends UpdateConnectorResponse, _
27
32
  * const response = await client.send(command);
28
33
  * ```
29
34
  *
35
+ * @param UpdateConnectorCommandInput - {@link UpdateConnectorCommandInput}
36
+ * @returns {@link UpdateConnectorCommandOutput}
30
37
  * @see {@link UpdateConnectorCommandInput} for command's `input` shape.
31
38
  * @see {@link UpdateConnectorCommandOutput} for command's `response` shape.
32
39
  * @see {@link TransferClientResolvedConfig | config} for TransferClient's `config` shape.
@@ -55,11 +62,20 @@ export interface UpdateConnectorCommandOutput extends UpdateConnectorResponse, _
55
62
  export declare class UpdateConnectorCommand extends $Command<UpdateConnectorCommandInput, UpdateConnectorCommandOutput, TransferClientResolvedConfig> {
56
63
  readonly input: UpdateConnectorCommandInput;
57
64
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
65
+ /**
66
+ * @public
67
+ */
58
68
  constructor(input: UpdateConnectorCommandInput);
59
69
  /**
60
70
  * @internal
61
71
  */
62
72
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: TransferClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateConnectorCommandInput, UpdateConnectorCommandOutput>;
73
+ /**
74
+ * @internal
75
+ */
63
76
  private serialize;
77
+ /**
78
+ * @internal
79
+ */
64
80
  private deserialize;
65
81
  }