@aws-sdk/client-appflow 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 (34) hide show
  1. package/dist-types/Appflow.d.ts +24 -0
  2. package/dist-types/AppflowClient.d.ts +24 -4
  3. package/dist-types/commands/CreateConnectorProfileCommand.d.ts +16 -0
  4. package/dist-types/commands/CreateFlowCommand.d.ts +16 -0
  5. package/dist-types/commands/DeleteConnectorProfileCommand.d.ts +16 -0
  6. package/dist-types/commands/DeleteFlowCommand.d.ts +16 -0
  7. package/dist-types/commands/DescribeConnectorCommand.d.ts +16 -0
  8. package/dist-types/commands/DescribeConnectorEntityCommand.d.ts +16 -0
  9. package/dist-types/commands/DescribeConnectorProfilesCommand.d.ts +16 -0
  10. package/dist-types/commands/DescribeConnectorsCommand.d.ts +16 -0
  11. package/dist-types/commands/DescribeFlowCommand.d.ts +16 -0
  12. package/dist-types/commands/DescribeFlowExecutionRecordsCommand.d.ts +16 -0
  13. package/dist-types/commands/ListConnectorEntitiesCommand.d.ts +16 -0
  14. package/dist-types/commands/ListConnectorsCommand.d.ts +16 -0
  15. package/dist-types/commands/ListFlowsCommand.d.ts +16 -0
  16. package/dist-types/commands/ListTagsForResourceCommand.d.ts +16 -0
  17. package/dist-types/commands/RegisterConnectorCommand.d.ts +16 -0
  18. package/dist-types/commands/StartFlowCommand.d.ts +16 -0
  19. package/dist-types/commands/StopFlowCommand.d.ts +16 -0
  20. package/dist-types/commands/TagResourceCommand.d.ts +16 -0
  21. package/dist-types/commands/UnregisterConnectorCommand.d.ts +16 -0
  22. package/dist-types/commands/UntagResourceCommand.d.ts +16 -0
  23. package/dist-types/commands/UpdateConnectorProfileCommand.d.ts +16 -0
  24. package/dist-types/commands/UpdateConnectorRegistrationCommand.d.ts +16 -0
  25. package/dist-types/commands/UpdateFlowCommand.d.ts +16 -0
  26. package/dist-types/models/AppflowServiceException.d.ts +2 -0
  27. package/dist-types/models/models_0.d.ts +421 -0
  28. package/dist-types/pagination/DescribeConnectorProfilesPaginator.d.ts +3 -0
  29. package/dist-types/pagination/DescribeConnectorsPaginator.d.ts +3 -0
  30. package/dist-types/pagination/DescribeFlowExecutionRecordsPaginator.d.ts +3 -0
  31. package/dist-types/pagination/Interfaces.d.ts +3 -0
  32. package/dist-types/pagination/ListConnectorsPaginator.d.ts +3 -0
  33. package/dist-types/pagination/ListFlowsPaginator.d.ts +3 -0
  34. package/package.json +3 -3
@@ -24,6 +24,7 @@ import { UpdateConnectorProfileCommandInput, UpdateConnectorProfileCommandOutput
24
24
  import { UpdateConnectorRegistrationCommandInput, UpdateConnectorRegistrationCommandOutput } from "./commands/UpdateConnectorRegistrationCommand";
25
25
  import { UpdateFlowCommandInput, UpdateFlowCommandOutput } from "./commands/UpdateFlowCommand";
26
26
  /**
27
+ * @public
27
28
  * <p>Welcome to the Amazon AppFlow API reference. This guide is for developers who need
28
29
  * detailed information about the Amazon AppFlow API operations, data types, and errors. </p>
29
30
  * <p>Amazon AppFlow is a fully managed integration service that enables you to securely
@@ -62,6 +63,7 @@ import { UpdateFlowCommandInput, UpdateFlowCommandOutput } from "./commands/Upda
62
63
  */
63
64
  export declare class Appflow extends AppflowClient {
64
65
  /**
66
+ * @public
65
67
  * <p> Creates a new connector profile associated with your Amazon Web Services account. There is
66
68
  * a soft quota of 100 connector profiles per Amazon Web Services account. If you need more
67
69
  * connector profiles than this quota allows, you can submit a request to the Amazon AppFlow
@@ -72,6 +74,7 @@ export declare class Appflow extends AppflowClient {
72
74
  createConnectorProfile(args: CreateConnectorProfileCommandInput, cb: (err: any, data?: CreateConnectorProfileCommandOutput) => void): void;
73
75
  createConnectorProfile(args: CreateConnectorProfileCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateConnectorProfileCommandOutput) => void): void;
74
76
  /**
77
+ * @public
75
78
  * <p> Enables your application to create a new flow using Amazon AppFlow. You must create
76
79
  * a connector profile before calling this API. Please note that the Request Syntax below shows
77
80
  * syntax for multiple destinations, however, you can only transfer data to one item in this list
@@ -82,12 +85,14 @@ export declare class Appflow extends AppflowClient {
82
85
  createFlow(args: CreateFlowCommandInput, cb: (err: any, data?: CreateFlowCommandOutput) => void): void;
83
86
  createFlow(args: CreateFlowCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateFlowCommandOutput) => void): void;
84
87
  /**
88
+ * @public
85
89
  * <p> Enables you to delete an existing connector profile. </p>
86
90
  */
87
91
  deleteConnectorProfile(args: DeleteConnectorProfileCommandInput, options?: __HttpHandlerOptions): Promise<DeleteConnectorProfileCommandOutput>;
88
92
  deleteConnectorProfile(args: DeleteConnectorProfileCommandInput, cb: (err: any, data?: DeleteConnectorProfileCommandOutput) => void): void;
89
93
  deleteConnectorProfile(args: DeleteConnectorProfileCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteConnectorProfileCommandOutput) => void): void;
90
94
  /**
95
+ * @public
91
96
  * <p> Enables your application to delete an existing flow. Before deleting the flow, Amazon AppFlow validates the request by checking the flow configuration and status. You can
92
97
  * delete flows one at a time. </p>
93
98
  */
@@ -95,6 +100,7 @@ export declare class Appflow extends AppflowClient {
95
100
  deleteFlow(args: DeleteFlowCommandInput, cb: (err: any, data?: DeleteFlowCommandOutput) => void): void;
96
101
  deleteFlow(args: DeleteFlowCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteFlowCommandOutput) => void): void;
97
102
  /**
103
+ * @public
98
104
  * <p>Describes the given custom connector registered in your Amazon Web Services account. This
99
105
  * API can be used for custom connectors that are registered in your account and also for Amazon
100
106
  * authored connectors.</p>
@@ -103,6 +109,7 @@ export declare class Appflow extends AppflowClient {
103
109
  describeConnector(args: DescribeConnectorCommandInput, cb: (err: any, data?: DescribeConnectorCommandOutput) => void): void;
104
110
  describeConnector(args: DescribeConnectorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeConnectorCommandOutput) => void): void;
105
111
  /**
112
+ * @public
106
113
  * <p> Provides details regarding the entity used with the connector, with a description of the
107
114
  * data model for each field in that entity. </p>
108
115
  */
@@ -110,6 +117,7 @@ export declare class Appflow extends AppflowClient {
110
117
  describeConnectorEntity(args: DescribeConnectorEntityCommandInput, cb: (err: any, data?: DescribeConnectorEntityCommandOutput) => void): void;
111
118
  describeConnectorEntity(args: DescribeConnectorEntityCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeConnectorEntityCommandOutput) => void): void;
112
119
  /**
120
+ * @public
113
121
  * <p> Returns a list of <code>connector-profile</code> details matching the provided
114
122
  * <code>connector-profile</code> names and <code>connector-types</code>. Both input lists are
115
123
  * optional, and you can use them to filter the result. </p>
@@ -120,6 +128,7 @@ export declare class Appflow extends AppflowClient {
120
128
  describeConnectorProfiles(args: DescribeConnectorProfilesCommandInput, cb: (err: any, data?: DescribeConnectorProfilesCommandOutput) => void): void;
121
129
  describeConnectorProfiles(args: DescribeConnectorProfilesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeConnectorProfilesCommandOutput) => void): void;
122
130
  /**
131
+ * @public
123
132
  * <p> Describes the connectors vended by Amazon AppFlow for specified connector types. If
124
133
  * you don't specify a connector type, this operation describes all connectors vended by Amazon AppFlow. If there are more connectors than can be returned in one page, the response
125
134
  * contains a <code>nextToken</code> object, which can be be passed in to the next call to the
@@ -129,18 +138,21 @@ export declare class Appflow extends AppflowClient {
129
138
  describeConnectors(args: DescribeConnectorsCommandInput, cb: (err: any, data?: DescribeConnectorsCommandOutput) => void): void;
130
139
  describeConnectors(args: DescribeConnectorsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeConnectorsCommandOutput) => void): void;
131
140
  /**
141
+ * @public
132
142
  * <p> Provides a description of the specified flow. </p>
133
143
  */
134
144
  describeFlow(args: DescribeFlowCommandInput, options?: __HttpHandlerOptions): Promise<DescribeFlowCommandOutput>;
135
145
  describeFlow(args: DescribeFlowCommandInput, cb: (err: any, data?: DescribeFlowCommandOutput) => void): void;
136
146
  describeFlow(args: DescribeFlowCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeFlowCommandOutput) => void): void;
137
147
  /**
148
+ * @public
138
149
  * <p> Fetches the execution history of the flow. </p>
139
150
  */
140
151
  describeFlowExecutionRecords(args: DescribeFlowExecutionRecordsCommandInput, options?: __HttpHandlerOptions): Promise<DescribeFlowExecutionRecordsCommandOutput>;
141
152
  describeFlowExecutionRecords(args: DescribeFlowExecutionRecordsCommandInput, cb: (err: any, data?: DescribeFlowExecutionRecordsCommandOutput) => void): void;
142
153
  describeFlowExecutionRecords(args: DescribeFlowExecutionRecordsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeFlowExecutionRecordsCommandOutput) => void): void;
143
154
  /**
155
+ * @public
144
156
  * <p> Returns the list of available connector entities supported by Amazon AppFlow. For
145
157
  * example, you can query Salesforce for <i>Account</i> and
146
158
  * <i>Opportunity</i> entities, or query ServiceNow for the
@@ -150,6 +162,7 @@ export declare class Appflow extends AppflowClient {
150
162
  listConnectorEntities(args: ListConnectorEntitiesCommandInput, cb: (err: any, data?: ListConnectorEntitiesCommandOutput) => void): void;
151
163
  listConnectorEntities(args: ListConnectorEntitiesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListConnectorEntitiesCommandOutput) => void): void;
152
164
  /**
165
+ * @public
153
166
  * <p>Returns the list of all registered custom connectors in your Amazon Web Services account.
154
167
  * This API lists only custom connectors registered in this account, not the Amazon Web Services
155
168
  * authored connectors. </p>
@@ -158,18 +171,21 @@ export declare class Appflow extends AppflowClient {
158
171
  listConnectors(args: ListConnectorsCommandInput, cb: (err: any, data?: ListConnectorsCommandOutput) => void): void;
159
172
  listConnectors(args: ListConnectorsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListConnectorsCommandOutput) => void): void;
160
173
  /**
174
+ * @public
161
175
  * <p> Lists all of the flows associated with your account. </p>
162
176
  */
163
177
  listFlows(args: ListFlowsCommandInput, options?: __HttpHandlerOptions): Promise<ListFlowsCommandOutput>;
164
178
  listFlows(args: ListFlowsCommandInput, cb: (err: any, data?: ListFlowsCommandOutput) => void): void;
165
179
  listFlows(args: ListFlowsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListFlowsCommandOutput) => void): void;
166
180
  /**
181
+ * @public
167
182
  * <p> Retrieves the tags that are associated with a specified flow. </p>
168
183
  */
169
184
  listTagsForResource(args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions): Promise<ListTagsForResourceCommandOutput>;
170
185
  listTagsForResource(args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
171
186
  listTagsForResource(args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
172
187
  /**
188
+ * @public
173
189
  * <p>Registers a new custom connector with your Amazon Web Services account. Before you can
174
190
  * register the connector, you must deploy the associated AWS lambda function in your
175
191
  * account.</p>
@@ -178,6 +194,7 @@ export declare class Appflow extends AppflowClient {
178
194
  registerConnector(args: RegisterConnectorCommandInput, cb: (err: any, data?: RegisterConnectorCommandOutput) => void): void;
179
195
  registerConnector(args: RegisterConnectorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RegisterConnectorCommandOutput) => void): void;
180
196
  /**
197
+ * @public
181
198
  * <p> Activates an existing flow. For on-demand flows, this operation runs the flow
182
199
  * immediately. For schedule and event-triggered flows, this operation activates the flow. </p>
183
200
  */
@@ -185,6 +202,7 @@ export declare class Appflow extends AppflowClient {
185
202
  startFlow(args: StartFlowCommandInput, cb: (err: any, data?: StartFlowCommandOutput) => void): void;
186
203
  startFlow(args: StartFlowCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartFlowCommandOutput) => void): void;
187
204
  /**
205
+ * @public
188
206
  * <p> Deactivates the existing flow. For on-demand flows, this operation returns an
189
207
  * <code>unsupportedOperationException</code> error message. For schedule and event-triggered
190
208
  * flows, this operation deactivates the flow. </p>
@@ -193,12 +211,14 @@ export declare class Appflow extends AppflowClient {
193
211
  stopFlow(args: StopFlowCommandInput, cb: (err: any, data?: StopFlowCommandOutput) => void): void;
194
212
  stopFlow(args: StopFlowCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopFlowCommandOutput) => void): void;
195
213
  /**
214
+ * @public
196
215
  * <p> Applies a tag to the specified flow. </p>
197
216
  */
198
217
  tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise<TagResourceCommandOutput>;
199
218
  tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
200
219
  tagResource(args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
201
220
  /**
221
+ * @public
202
222
  * <p>Unregisters the custom connector registered in your account that matches the connector
203
223
  * label provided in the request.</p>
204
224
  */
@@ -206,18 +226,21 @@ export declare class Appflow extends AppflowClient {
206
226
  unregisterConnector(args: UnregisterConnectorCommandInput, cb: (err: any, data?: UnregisterConnectorCommandOutput) => void): void;
207
227
  unregisterConnector(args: UnregisterConnectorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UnregisterConnectorCommandOutput) => void): void;
208
228
  /**
229
+ * @public
209
230
  * <p> Removes a tag from the specified flow. </p>
210
231
  */
211
232
  untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise<UntagResourceCommandOutput>;
212
233
  untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
213
234
  untagResource(args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
214
235
  /**
236
+ * @public
215
237
  * <p> Updates a given connector profile associated with your account. </p>
216
238
  */
217
239
  updateConnectorProfile(args: UpdateConnectorProfileCommandInput, options?: __HttpHandlerOptions): Promise<UpdateConnectorProfileCommandOutput>;
218
240
  updateConnectorProfile(args: UpdateConnectorProfileCommandInput, cb: (err: any, data?: UpdateConnectorProfileCommandOutput) => void): void;
219
241
  updateConnectorProfile(args: UpdateConnectorProfileCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateConnectorProfileCommandOutput) => void): void;
220
242
  /**
243
+ * @public
221
244
  * <p>Updates a custom connector that you've previously registered. This operation updates the
222
245
  * connector with one of the following:</p>
223
246
  * <ul>
@@ -233,6 +256,7 @@ export declare class Appflow extends AppflowClient {
233
256
  updateConnectorRegistration(args: UpdateConnectorRegistrationCommandInput, cb: (err: any, data?: UpdateConnectorRegistrationCommandOutput) => void): void;
234
257
  updateConnectorRegistration(args: UpdateConnectorRegistrationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateConnectorRegistrationCommandOutput) => void): void;
235
258
  /**
259
+ * @public
236
260
  * <p> Updates an existing flow. </p>
237
261
  */
238
262
  updateFlow(args: UpdateFlowCommandInput, options?: __HttpHandlerOptions): Promise<UpdateFlowCommandOutput>;
@@ -31,15 +31,24 @@ import { UpdateConnectorProfileCommandInput, UpdateConnectorProfileCommandOutput
31
31
  import { UpdateConnectorRegistrationCommandInput, UpdateConnectorRegistrationCommandOutput } from "./commands/UpdateConnectorRegistrationCommand";
32
32
  import { UpdateFlowCommandInput, UpdateFlowCommandOutput } from "./commands/UpdateFlowCommand";
33
33
  import { ClientInputEndpointParameters, ClientResolvedEndpointParameters, EndpointParameters } from "./endpoint/EndpointParameters";
34
+ /**
35
+ * @public
36
+ */
34
37
  export type ServiceInputTypes = CreateConnectorProfileCommandInput | CreateFlowCommandInput | DeleteConnectorProfileCommandInput | DeleteFlowCommandInput | DescribeConnectorCommandInput | DescribeConnectorEntityCommandInput | DescribeConnectorProfilesCommandInput | DescribeConnectorsCommandInput | DescribeFlowCommandInput | DescribeFlowExecutionRecordsCommandInput | ListConnectorEntitiesCommandInput | ListConnectorsCommandInput | ListFlowsCommandInput | ListTagsForResourceCommandInput | RegisterConnectorCommandInput | StartFlowCommandInput | StopFlowCommandInput | TagResourceCommandInput | UnregisterConnectorCommandInput | UntagResourceCommandInput | UpdateConnectorProfileCommandInput | UpdateConnectorRegistrationCommandInput | UpdateFlowCommandInput;
38
+ /**
39
+ * @public
40
+ */
35
41
  export type ServiceOutputTypes = CreateConnectorProfileCommandOutput | CreateFlowCommandOutput | DeleteConnectorProfileCommandOutput | DeleteFlowCommandOutput | DescribeConnectorCommandOutput | DescribeConnectorEntityCommandOutput | DescribeConnectorProfilesCommandOutput | DescribeConnectorsCommandOutput | DescribeFlowCommandOutput | DescribeFlowExecutionRecordsCommandOutput | ListConnectorEntitiesCommandOutput | ListConnectorsCommandOutput | ListFlowsCommandOutput | ListTagsForResourceCommandOutput | RegisterConnectorCommandOutput | StartFlowCommandOutput | StopFlowCommandOutput | TagResourceCommandOutput | UnregisterConnectorCommandOutput | UntagResourceCommandOutput | UpdateConnectorProfileCommandOutput | UpdateConnectorRegistrationCommandOutput | UpdateFlowCommandOutput;
42
+ /**
43
+ * @public
44
+ */
36
45
  export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__HttpHandlerOptions>> {
37
46
  /**
38
47
  * The HTTP handler to use. Fetch in browser and Https in Nodejs.
39
48
  */
40
49
  requestHandler?: __HttpHandler;
41
50
  /**
42
- * A constructor for a class implementing the {@link __Checksum} interface
51
+ * A constructor for a class implementing the {@link @aws-sdk/types#ChecksumConstructor} interface
43
52
  * that computes the SHA-256 HMAC or checksum of a string or binary buffer.
44
53
  * @internal
45
54
  */
@@ -129,23 +138,34 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
129
138
  */
130
139
  logger?: __Logger;
131
140
  /**
132
- * The {@link __DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
141
+ * The {@link @aws-sdk/smithy-client#DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
133
142
  */
134
143
  defaultsMode?: __DefaultsMode | __Provider<__DefaultsMode>;
135
144
  }
145
+ /**
146
+ * @public
147
+ */
136
148
  type AppflowClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> & ClientDefaults & RegionInputConfig & EndpointInputConfig<EndpointParameters> & RetryInputConfig & HostHeaderInputConfig & AwsAuthInputConfig & UserAgentInputConfig & ClientInputEndpointParameters;
137
149
  /**
138
- * The configuration interface of AppflowClient class constructor that set the region, credentials and other options.
150
+ * @public
151
+ *
152
+ * The configuration interface of AppflowClient class constructor that set the region, credentials and other options.
139
153
  */
140
154
  export interface AppflowClientConfig extends AppflowClientConfigType {
141
155
  }
156
+ /**
157
+ * @public
158
+ */
142
159
  type AppflowClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> & Required<ClientDefaults> & RegionResolvedConfig & EndpointResolvedConfig<EndpointParameters> & RetryResolvedConfig & HostHeaderResolvedConfig & AwsAuthResolvedConfig & UserAgentResolvedConfig & ClientResolvedEndpointParameters;
143
160
  /**
144
- * The resolved configuration interface of AppflowClient class. This is resolved and normalized from the {@link AppflowClientConfig | constructor configuration interface}.
161
+ * @public
162
+ *
163
+ * The resolved configuration interface of AppflowClient class. This is resolved and normalized from the {@link AppflowClientConfig | constructor configuration interface}.
145
164
  */
146
165
  export interface AppflowClientResolvedConfig extends AppflowClientResolvedConfigType {
147
166
  }
148
167
  /**
168
+ * @public
149
169
  * <p>Welcome to the Amazon AppFlow API reference. This guide is for developers who need
150
170
  * detailed information about the Amazon AppFlow API operations, data types, and errors. </p>
151
171
  * <p>Amazon AppFlow is a fully managed integration service that enables you to securely
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { AppflowClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../AppflowClient";
5
5
  import { CreateConnectorProfileRequest, CreateConnectorProfileResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link CreateConnectorProfileCommand}.
8
10
  */
9
11
  export interface CreateConnectorProfileCommandInput extends CreateConnectorProfileRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link CreateConnectorProfileCommand}.
13
17
  */
14
18
  export interface CreateConnectorProfileCommandOutput extends CreateConnectorProfileResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p> Creates a new connector profile associated with your Amazon Web Services account. There is
18
23
  * a soft quota of 100 connector profiles per Amazon Web Services account. If you need more
19
24
  * connector profiles than this quota allows, you can submit a request to the Amazon AppFlow
@@ -29,6 +34,8 @@ export interface CreateConnectorProfileCommandOutput extends CreateConnectorProf
29
34
  * const response = await client.send(command);
30
35
  * ```
31
36
  *
37
+ * @param CreateConnectorProfileCommandInput - {@link CreateConnectorProfileCommandInput}
38
+ * @returns {@link CreateConnectorProfileCommandOutput}
32
39
  * @see {@link CreateConnectorProfileCommandInput} for command's `input` shape.
33
40
  * @see {@link CreateConnectorProfileCommandOutput} for command's `response` shape.
34
41
  * @see {@link AppflowClientResolvedConfig | config} for AppflowClient's `config` shape.
@@ -56,11 +63,20 @@ export interface CreateConnectorProfileCommandOutput extends CreateConnectorProf
56
63
  export declare class CreateConnectorProfileCommand extends $Command<CreateConnectorProfileCommandInput, CreateConnectorProfileCommandOutput, AppflowClientResolvedConfig> {
57
64
  readonly input: CreateConnectorProfileCommandInput;
58
65
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
66
+ /**
67
+ * @public
68
+ */
59
69
  constructor(input: CreateConnectorProfileCommandInput);
60
70
  /**
61
71
  * @internal
62
72
  */
63
73
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: AppflowClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateConnectorProfileCommandInput, CreateConnectorProfileCommandOutput>;
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 { AppflowClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../AppflowClient";
5
5
  import { CreateFlowRequest, CreateFlowResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link CreateFlowCommand}.
8
10
  */
9
11
  export interface CreateFlowCommandInput extends CreateFlowRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link CreateFlowCommand}.
13
17
  */
14
18
  export interface CreateFlowCommandOutput extends CreateFlowResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p> Enables your application to create a new flow using Amazon AppFlow. You must create
18
23
  * a connector profile before calling this API. Please note that the Request Syntax below shows
19
24
  * syntax for multiple destinations, however, you can only transfer data to one item in this list
@@ -29,6 +34,8 @@ export interface CreateFlowCommandOutput extends CreateFlowResponse, __MetadataB
29
34
  * const response = await client.send(command);
30
35
  * ```
31
36
  *
37
+ * @param CreateFlowCommandInput - {@link CreateFlowCommandInput}
38
+ * @returns {@link CreateFlowCommandOutput}
32
39
  * @see {@link CreateFlowCommandInput} for command's `input` shape.
33
40
  * @see {@link CreateFlowCommandOutput} for command's `response` shape.
34
41
  * @see {@link AppflowClientResolvedConfig | config} for AppflowClient's `config` shape.
@@ -63,11 +70,20 @@ export interface CreateFlowCommandOutput extends CreateFlowResponse, __MetadataB
63
70
  export declare class CreateFlowCommand extends $Command<CreateFlowCommandInput, CreateFlowCommandOutput, AppflowClientResolvedConfig> {
64
71
  readonly input: CreateFlowCommandInput;
65
72
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
73
+ /**
74
+ * @public
75
+ */
66
76
  constructor(input: CreateFlowCommandInput);
67
77
  /**
68
78
  * @internal
69
79
  */
70
80
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: AppflowClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateFlowCommandInput, CreateFlowCommandOutput>;
81
+ /**
82
+ * @internal
83
+ */
71
84
  private serialize;
85
+ /**
86
+ * @internal
87
+ */
72
88
  private deserialize;
73
89
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { AppflowClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../AppflowClient";
5
5
  import { DeleteConnectorProfileRequest, DeleteConnectorProfileResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DeleteConnectorProfileCommand}.
8
10
  */
9
11
  export interface DeleteConnectorProfileCommandInput extends DeleteConnectorProfileRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DeleteConnectorProfileCommand}.
13
17
  */
14
18
  export interface DeleteConnectorProfileCommandOutput extends DeleteConnectorProfileResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p> Enables you to delete an existing connector profile. </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 DeleteConnectorProfileCommandOutput extends DeleteConnectorProf
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param DeleteConnectorProfileCommandInput - {@link DeleteConnectorProfileCommandInput}
34
+ * @returns {@link DeleteConnectorProfileCommandOutput}
28
35
  * @see {@link DeleteConnectorProfileCommandInput} for command's `input` shape.
29
36
  * @see {@link DeleteConnectorProfileCommandOutput} for command's `response` shape.
30
37
  * @see {@link AppflowClientResolvedConfig | config} for AppflowClient's `config` shape.
@@ -46,11 +53,20 @@ export interface DeleteConnectorProfileCommandOutput extends DeleteConnectorProf
46
53
  export declare class DeleteConnectorProfileCommand extends $Command<DeleteConnectorProfileCommandInput, DeleteConnectorProfileCommandOutput, AppflowClientResolvedConfig> {
47
54
  readonly input: DeleteConnectorProfileCommandInput;
48
55
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
56
+ /**
57
+ * @public
58
+ */
49
59
  constructor(input: DeleteConnectorProfileCommandInput);
50
60
  /**
51
61
  * @internal
52
62
  */
53
63
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: AppflowClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteConnectorProfileCommandInput, DeleteConnectorProfileCommandOutput>;
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 { AppflowClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../AppflowClient";
5
5
  import { DeleteFlowRequest, DeleteFlowResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DeleteFlowCommand}.
8
10
  */
9
11
  export interface DeleteFlowCommandInput extends DeleteFlowRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DeleteFlowCommand}.
13
17
  */
14
18
  export interface DeleteFlowCommandOutput extends DeleteFlowResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p> Enables your application to delete an existing flow. Before deleting the flow, Amazon AppFlow validates the request by checking the flow configuration and status. You can
18
23
  * delete flows one at a time. </p>
19
24
  * @example
@@ -26,6 +31,8 @@ export interface DeleteFlowCommandOutput extends DeleteFlowResponse, __MetadataB
26
31
  * const response = await client.send(command);
27
32
  * ```
28
33
  *
34
+ * @param DeleteFlowCommandInput - {@link DeleteFlowCommandInput}
35
+ * @returns {@link DeleteFlowCommandOutput}
29
36
  * @see {@link DeleteFlowCommandInput} for command's `input` shape.
30
37
  * @see {@link DeleteFlowCommandOutput} for command's `response` shape.
31
38
  * @see {@link AppflowClientResolvedConfig | config} for AppflowClient's `config` shape.
@@ -47,11 +54,20 @@ export interface DeleteFlowCommandOutput extends DeleteFlowResponse, __MetadataB
47
54
  export declare class DeleteFlowCommand extends $Command<DeleteFlowCommandInput, DeleteFlowCommandOutput, AppflowClientResolvedConfig> {
48
55
  readonly input: DeleteFlowCommandInput;
49
56
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
57
+ /**
58
+ * @public
59
+ */
50
60
  constructor(input: DeleteFlowCommandInput);
51
61
  /**
52
62
  * @internal
53
63
  */
54
64
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: AppflowClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteFlowCommandInput, DeleteFlowCommandOutput>;
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 { AppflowClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../AppflowClient";
5
5
  import { DescribeConnectorRequest, DescribeConnectorResponse } from "../models/models_0";
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 given custom connector registered in your Amazon Web Services account. This
18
23
  * API can be used for custom connectors that are registered in your account and also for Amazon
19
24
  * authored connectors.</p>
@@ -27,6 +32,8 @@ export interface DescribeConnectorCommandOutput extends DescribeConnectorRespons
27
32
  * const response = await client.send(command);
28
33
  * ```
29
34
  *
35
+ * @param DescribeConnectorCommandInput - {@link DescribeConnectorCommandInput}
36
+ * @returns {@link DescribeConnectorCommandOutput}
30
37
  * @see {@link DescribeConnectorCommandInput} for command's `input` shape.
31
38
  * @see {@link DescribeConnectorCommandOutput} for command's `response` shape.
32
39
  * @see {@link AppflowClientResolvedConfig | config} for AppflowClient's `config` shape.
@@ -47,11 +54,20 @@ export interface DescribeConnectorCommandOutput extends DescribeConnectorRespons
47
54
  export declare class DescribeConnectorCommand extends $Command<DescribeConnectorCommandInput, DescribeConnectorCommandOutput, AppflowClientResolvedConfig> {
48
55
  readonly input: DescribeConnectorCommandInput;
49
56
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
57
+ /**
58
+ * @public
59
+ */
50
60
  constructor(input: DescribeConnectorCommandInput);
51
61
  /**
52
62
  * @internal
53
63
  */
54
64
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: AppflowClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeConnectorCommandInput, DescribeConnectorCommandOutput>;
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 { AppflowClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../AppflowClient";
5
5
  import { DescribeConnectorEntityRequest, DescribeConnectorEntityResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DescribeConnectorEntityCommand}.
8
10
  */
9
11
  export interface DescribeConnectorEntityCommandInput extends DescribeConnectorEntityRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DescribeConnectorEntityCommand}.
13
17
  */
14
18
  export interface DescribeConnectorEntityCommandOutput extends DescribeConnectorEntityResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p> Provides details regarding the entity used with the connector, with a description of the
18
23
  * data model for each field in that entity. </p>
19
24
  * @example
@@ -26,6 +31,8 @@ export interface DescribeConnectorEntityCommandOutput extends DescribeConnectorE
26
31
  * const response = await client.send(command);
27
32
  * ```
28
33
  *
34
+ * @param DescribeConnectorEntityCommandInput - {@link DescribeConnectorEntityCommandInput}
35
+ * @returns {@link DescribeConnectorEntityCommandOutput}
29
36
  * @see {@link DescribeConnectorEntityCommandInput} for command's `input` shape.
30
37
  * @see {@link DescribeConnectorEntityCommandOutput} for command's `response` shape.
31
38
  * @see {@link AppflowClientResolvedConfig | config} for AppflowClient's `config` shape.
@@ -52,11 +59,20 @@ export interface DescribeConnectorEntityCommandOutput extends DescribeConnectorE
52
59
  export declare class DescribeConnectorEntityCommand extends $Command<DescribeConnectorEntityCommandInput, DescribeConnectorEntityCommandOutput, AppflowClientResolvedConfig> {
53
60
  readonly input: DescribeConnectorEntityCommandInput;
54
61
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
62
+ /**
63
+ * @public
64
+ */
55
65
  constructor(input: DescribeConnectorEntityCommandInput);
56
66
  /**
57
67
  * @internal
58
68
  */
59
69
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: AppflowClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeConnectorEntityCommandInput, DescribeConnectorEntityCommandOutput>;
70
+ /**
71
+ * @internal
72
+ */
60
73
  private serialize;
74
+ /**
75
+ * @internal
76
+ */
61
77
  private deserialize;
62
78
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { AppflowClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../AppflowClient";
5
5
  import { DescribeConnectorProfilesRequest, DescribeConnectorProfilesResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DescribeConnectorProfilesCommand}.
8
10
  */
9
11
  export interface DescribeConnectorProfilesCommandInput extends DescribeConnectorProfilesRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DescribeConnectorProfilesCommand}.
13
17
  */
14
18
  export interface DescribeConnectorProfilesCommandOutput extends DescribeConnectorProfilesResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p> Returns a list of <code>connector-profile</code> details matching the provided
18
23
  * <code>connector-profile</code> names and <code>connector-types</code>. Both input lists are
19
24
  * optional, and you can use them to filter the result. </p>
@@ -29,6 +34,8 @@ export interface DescribeConnectorProfilesCommandOutput extends DescribeConnecto
29
34
  * const response = await client.send(command);
30
35
  * ```
31
36
  *
37
+ * @param DescribeConnectorProfilesCommandInput - {@link DescribeConnectorProfilesCommandInput}
38
+ * @returns {@link DescribeConnectorProfilesCommandOutput}
32
39
  * @see {@link DescribeConnectorProfilesCommandInput} for command's `input` shape.
33
40
  * @see {@link DescribeConnectorProfilesCommandOutput} for command's `response` shape.
34
41
  * @see {@link AppflowClientResolvedConfig | config} for AppflowClient's `config` shape.
@@ -45,11 +52,20 @@ export interface DescribeConnectorProfilesCommandOutput extends DescribeConnecto
45
52
  export declare class DescribeConnectorProfilesCommand extends $Command<DescribeConnectorProfilesCommandInput, DescribeConnectorProfilesCommandOutput, AppflowClientResolvedConfig> {
46
53
  readonly input: DescribeConnectorProfilesCommandInput;
47
54
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
55
+ /**
56
+ * @public
57
+ */
48
58
  constructor(input: DescribeConnectorProfilesCommandInput);
49
59
  /**
50
60
  * @internal
51
61
  */
52
62
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: AppflowClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeConnectorProfilesCommandInput, DescribeConnectorProfilesCommandOutput>;
63
+ /**
64
+ * @internal
65
+ */
53
66
  private serialize;
67
+ /**
68
+ * @internal
69
+ */
54
70
  private deserialize;
55
71
  }