@aws-sdk/client-appflow 3.325.0 → 3.326.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 (24) hide show
  1. package/dist-types/commands/CreateConnectorProfileCommand.d.ts +6 -0
  2. package/dist-types/commands/CreateFlowCommand.d.ts +7 -0
  3. package/dist-types/commands/DeleteConnectorProfileCommand.d.ts +4 -0
  4. package/dist-types/commands/DeleteFlowCommand.d.ts +4 -0
  5. package/dist-types/commands/DescribeConnectorCommand.d.ts +163 -0
  6. package/dist-types/commands/DescribeConnectorEntityCommand.d.ts +55 -0
  7. package/dist-types/commands/DescribeConnectorProfilesCommand.d.ts +111 -0
  8. package/dist-types/commands/DescribeConnectorsCommand.d.ts +183 -0
  9. package/dist-types/commands/DescribeFlowCommand.d.ts +303 -0
  10. package/dist-types/commands/DescribeFlowExecutionRecordsCommand.d.ts +41 -0
  11. package/dist-types/commands/ListConnectorEntitiesCommand.d.ts +15 -0
  12. package/dist-types/commands/ListConnectorsCommand.d.ts +23 -0
  13. package/dist-types/commands/ListFlowsCommand.d.ts +31 -0
  14. package/dist-types/commands/ListTagsForResourceCommand.d.ts +8 -0
  15. package/dist-types/commands/RegisterConnectorCommand.d.ts +6 -0
  16. package/dist-types/commands/StartFlowCommand.d.ts +8 -0
  17. package/dist-types/commands/StopFlowCommand.d.ts +7 -0
  18. package/dist-types/commands/TagResourceCommand.d.ts +4 -0
  19. package/dist-types/commands/UnregisterConnectorCommand.d.ts +4 -0
  20. package/dist-types/commands/UntagResourceCommand.d.ts +4 -0
  21. package/dist-types/commands/UpdateConnectorProfileCommand.d.ts +6 -0
  22. package/dist-types/commands/UpdateConnectorRegistrationCommand.d.ts +6 -0
  23. package/dist-types/commands/UpdateFlowCommand.d.ts +6 -0
  24. package/package.json +3 -3
package/dist-types/commands/CreateConnectorProfileCommand.d.ts CHANGED
@@ -267,6 +267,10 @@ export interface CreateConnectorProfileCommandOutput extends CreateConnectorProf
267
267
  * };
268
268
  * const command = new CreateConnectorProfileCommand(input);
269
269
  * const response = await client.send(command);
270
+ * // { // CreateConnectorProfileResponse
271
+ * // connectorProfileArn: "STRING_VALUE",
272
+ * // };
273
+ *
270
274
  * ```
271
275
  *
272
276
  * @param CreateConnectorProfileCommandInput - {@link CreateConnectorProfileCommandInput}
@@ -293,6 +297,8 @@ export interface CreateConnectorProfileCommandOutput extends CreateConnectorProf
293
297
  * @throws {@link ValidationException} (client fault)
294
298
  * <p> The request has invalid or missing parameters. </p>
295
299
  *
300
+ * @throws {@link AppflowServiceException}
301
+ * <p>Base exception class for all service exceptions from Appflow service.</p>
296
302
  *
297
303
  */
298
304
  export declare class CreateConnectorProfileCommand extends $Command<CreateConnectorProfileCommandInput, CreateConnectorProfileCommandOutput, AppflowClientResolvedConfig> {
package/dist-types/commands/CreateFlowCommand.d.ts CHANGED
@@ -304,6 +304,11 @@ export interface CreateFlowCommandOutput extends CreateFlowResponse, __MetadataB
304
304
  * };
305
305
  * const command = new CreateFlowCommand(input);
306
306
  * const response = await client.send(command);
307
+ * // { // CreateFlowResponse
308
+ * // flowArn: "STRING_VALUE",
309
+ * // flowStatus: "Active" || "Deprecated" || "Deleted" || "Draft" || "Errored" || "Suspended",
310
+ * // };
311
+ *
307
312
  * ```
308
313
  *
309
314
  * @param CreateFlowCommandInput - {@link CreateFlowCommandInput}
@@ -337,6 +342,8 @@ export interface CreateFlowCommandOutput extends CreateFlowResponse, __MetadataB
337
342
  * @throws {@link ValidationException} (client fault)
338
343
  * <p> The request has invalid or missing parameters. </p>
339
344
  *
345
+ * @throws {@link AppflowServiceException}
346
+ * <p>Base exception class for all service exceptions from Appflow service.</p>
340
347
  *
341
348
  */
342
349
  export declare class CreateFlowCommand extends $Command<CreateFlowCommandInput, CreateFlowCommandOutput, AppflowClientResolvedConfig> {
package/dist-types/commands/DeleteConnectorProfileCommand.d.ts CHANGED
@@ -32,6 +32,8 @@ export interface DeleteConnectorProfileCommandOutput extends DeleteConnectorProf
32
32
  * };
33
33
  * const command = new DeleteConnectorProfileCommand(input);
34
34
  * const response = await client.send(command);
35
+ * // {};
36
+ *
35
37
  * ```
36
38
  *
37
39
  * @param DeleteConnectorProfileCommandInput - {@link DeleteConnectorProfileCommandInput}
@@ -52,6 +54,8 @@ export interface DeleteConnectorProfileCommandOutput extends DeleteConnectorProf
52
54
  * <p> The resource specified in the request (such as the source or destination connector
53
55
  * profile) is not found. </p>
54
56
  *
57
+ * @throws {@link AppflowServiceException}
58
+ * <p>Base exception class for all service exceptions from Appflow service.</p>
55
59
  *
56
60
  */
57
61
  export declare class DeleteConnectorProfileCommand extends $Command<DeleteConnectorProfileCommandInput, DeleteConnectorProfileCommandOutput, AppflowClientResolvedConfig> {
package/dist-types/commands/DeleteFlowCommand.d.ts CHANGED
@@ -33,6 +33,8 @@ export interface DeleteFlowCommandOutput extends DeleteFlowResponse, __MetadataB
33
33
  * };
34
34
  * const command = new DeleteFlowCommand(input);
35
35
  * const response = await client.send(command);
36
+ * // {};
37
+ *
36
38
  * ```
37
39
  *
38
40
  * @param DeleteFlowCommandInput - {@link DeleteFlowCommandInput}
@@ -53,6 +55,8 @@ export interface DeleteFlowCommandOutput extends DeleteFlowResponse, __MetadataB
53
55
  * <p> The resource specified in the request (such as the source or destination connector
54
56
  * profile) is not found. </p>
55
57
  *
58
+ * @throws {@link AppflowServiceException}
59
+ * <p>Base exception class for all service exceptions from Appflow service.</p>
56
60
  *
57
61
  */
58
62
  export declare class DeleteFlowCommand extends $Command<DeleteFlowCommandInput, DeleteFlowCommandOutput, AppflowClientResolvedConfig> {
package/dist-types/commands/DescribeConnectorCommand.d.ts CHANGED
@@ -34,6 +34,167 @@ export interface DescribeConnectorCommandOutput extends DescribeConnectorRespons
34
34
  * };
35
35
  * const command = new DescribeConnectorCommand(input);
36
36
  * const response = await client.send(command);
37
+ * // { // DescribeConnectorResponse
38
+ * // connectorConfiguration: { // ConnectorConfiguration
39
+ * // canUseAsSource: true || false,
40
+ * // canUseAsDestination: true || false,
41
+ * // supportedDestinationConnectors: [ // ConnectorTypeList
42
+ * // "Salesforce" || "Singular" || "Slack" || "Redshift" || "S3" || "Marketo" || "Googleanalytics" || "Zendesk" || "Servicenow" || "Datadog" || "Trendmicro" || "Snowflake" || "Dynatrace" || "Infornexus" || "Amplitude" || "Veeva" || "EventBridge" || "LookoutMetrics" || "Upsolver" || "Honeycode" || "CustomerProfiles" || "SAPOData" || "CustomConnector" || "Pardot",
43
+ * // ],
44
+ * // supportedSchedulingFrequencies: [ // SchedulingFrequencyTypeList
45
+ * // "BYMINUTE" || "HOURLY" || "DAILY" || "WEEKLY" || "MONTHLY" || "ONCE",
46
+ * // ],
47
+ * // isPrivateLinkEnabled: true || false,
48
+ * // isPrivateLinkEndpointUrlRequired: true || false,
49
+ * // supportedTriggerTypes: [ // TriggerTypeList
50
+ * // "Scheduled" || "Event" || "OnDemand",
51
+ * // ],
52
+ * // connectorMetadata: { // ConnectorMetadata
53
+ * // Amplitude: {},
54
+ * // Datadog: {},
55
+ * // Dynatrace: {},
56
+ * // GoogleAnalytics: { // GoogleAnalyticsMetadata
57
+ * // oAuthScopes: [ // OAuthScopeList
58
+ * // "STRING_VALUE",
59
+ * // ],
60
+ * // },
61
+ * // InforNexus: {},
62
+ * // Marketo: {},
63
+ * // Redshift: {},
64
+ * // S3: {},
65
+ * // Salesforce: { // SalesforceMetadata
66
+ * // oAuthScopes: [
67
+ * // "STRING_VALUE",
68
+ * // ],
69
+ * // dataTransferApis: [ // SalesforceDataTransferApiList
70
+ * // "AUTOMATIC" || "BULKV2" || "REST_SYNC",
71
+ * // ],
72
+ * // oauth2GrantTypesSupported: [ // OAuth2GrantTypeSupportedList
73
+ * // "CLIENT_CREDENTIALS" || "AUTHORIZATION_CODE" || "JWT_BEARER",
74
+ * // ],
75
+ * // },
76
+ * // ServiceNow: {},
77
+ * // Singular: {},
78
+ * // Slack: { // SlackMetadata
79
+ * // oAuthScopes: [
80
+ * // "STRING_VALUE",
81
+ * // ],
82
+ * // },
83
+ * // Snowflake: { // SnowflakeMetadata
84
+ * // supportedRegions: [ // RegionList
85
+ * // "STRING_VALUE",
86
+ * // ],
87
+ * // },
88
+ * // Trendmicro: {},
89
+ * // Veeva: {},
90
+ * // Zendesk: { // ZendeskMetadata
91
+ * // oAuthScopes: [
92
+ * // "STRING_VALUE",
93
+ * // ],
94
+ * // },
95
+ * // EventBridge: {},
96
+ * // Upsolver: {},
97
+ * // CustomerProfiles: {},
98
+ * // Honeycode: { // HoneycodeMetadata
99
+ * // oAuthScopes: [
100
+ * // "STRING_VALUE",
101
+ * // ],
102
+ * // },
103
+ * // SAPOData: {},
104
+ * // Pardot: {},
105
+ * // },
106
+ * // connectorType: "Salesforce" || "Singular" || "Slack" || "Redshift" || "S3" || "Marketo" || "Googleanalytics" || "Zendesk" || "Servicenow" || "Datadog" || "Trendmicro" || "Snowflake" || "Dynatrace" || "Infornexus" || "Amplitude" || "Veeva" || "EventBridge" || "LookoutMetrics" || "Upsolver" || "Honeycode" || "CustomerProfiles" || "SAPOData" || "CustomConnector" || "Pardot",
107
+ * // connectorLabel: "STRING_VALUE",
108
+ * // connectorDescription: "STRING_VALUE",
109
+ * // connectorOwner: "STRING_VALUE",
110
+ * // connectorName: "STRING_VALUE",
111
+ * // connectorVersion: "STRING_VALUE",
112
+ * // connectorArn: "STRING_VALUE",
113
+ * // connectorModes: [ // ConnectorModeList
114
+ * // "STRING_VALUE",
115
+ * // ],
116
+ * // authenticationConfig: { // AuthenticationConfig
117
+ * // isBasicAuthSupported: true || false,
118
+ * // isApiKeyAuthSupported: true || false,
119
+ * // isOAuth2Supported: true || false,
120
+ * // isCustomAuthSupported: true || false,
121
+ * // oAuth2Defaults: { // OAuth2Defaults
122
+ * // oauthScopes: "<OAuthScopeList>",
123
+ * // tokenUrls: [ // TokenUrlList
124
+ * // "STRING_VALUE",
125
+ * // ],
126
+ * // authCodeUrls: [ // AuthCodeUrlList
127
+ * // "STRING_VALUE",
128
+ * // ],
129
+ * // oauth2GrantTypesSupported: [
130
+ * // "CLIENT_CREDENTIALS" || "AUTHORIZATION_CODE" || "JWT_BEARER",
131
+ * // ],
132
+ * // oauth2CustomProperties: [ // OAuth2CustomPropertiesList
133
+ * // { // OAuth2CustomParameter
134
+ * // key: "STRING_VALUE",
135
+ * // isRequired: true || false,
136
+ * // label: "STRING_VALUE",
137
+ * // description: "STRING_VALUE",
138
+ * // isSensitiveField: true || false,
139
+ * // connectorSuppliedValues: [ // ConnectorSuppliedValueList
140
+ * // "STRING_VALUE",
141
+ * // ],
142
+ * // type: "TOKEN_URL" || "AUTH_URL",
143
+ * // },
144
+ * // ],
145
+ * // },
146
+ * // customAuthConfigs: [ // CustomAuthConfigList
147
+ * // { // CustomAuthConfig
148
+ * // customAuthenticationType: "STRING_VALUE",
149
+ * // authParameters: [ // AuthParameterList
150
+ * // { // AuthParameter
151
+ * // key: "STRING_VALUE",
152
+ * // isRequired: true || false,
153
+ * // label: "STRING_VALUE",
154
+ * // description: "STRING_VALUE",
155
+ * // isSensitiveField: true || false,
156
+ * // connectorSuppliedValues: [
157
+ * // "STRING_VALUE",
158
+ * // ],
159
+ * // },
160
+ * // ],
161
+ * // },
162
+ * // ],
163
+ * // },
164
+ * // connectorRuntimeSettings: [ // ConnectorRuntimeSettingList
165
+ * // { // ConnectorRuntimeSetting
166
+ * // key: "STRING_VALUE",
167
+ * // dataType: "STRING_VALUE",
168
+ * // isRequired: true || false,
169
+ * // label: "STRING_VALUE",
170
+ * // description: "STRING_VALUE",
171
+ * // scope: "STRING_VALUE",
172
+ * // connectorSuppliedValueOptions: [ // ConnectorSuppliedValueOptionList
173
+ * // "STRING_VALUE",
174
+ * // ],
175
+ * // },
176
+ * // ],
177
+ * // supportedApiVersions: [ // SupportedApiVersionList
178
+ * // "STRING_VALUE",
179
+ * // ],
180
+ * // supportedOperators: [ // SupportedOperatorList
181
+ * // "PROJECTION" || "LESS_THAN" || "GREATER_THAN" || "CONTAINS" || "BETWEEN" || "LESS_THAN_OR_EQUAL_TO" || "GREATER_THAN_OR_EQUAL_TO" || "EQUAL_TO" || "NOT_EQUAL_TO" || "ADDITION" || "MULTIPLICATION" || "DIVISION" || "SUBTRACTION" || "MASK_ALL" || "MASK_FIRST_N" || "MASK_LAST_N" || "VALIDATE_NON_NULL" || "VALIDATE_NON_ZERO" || "VALIDATE_NON_NEGATIVE" || "VALIDATE_NUMERIC" || "NO_OP",
182
+ * // ],
183
+ * // supportedWriteOperations: [ // SupportedWriteOperationList
184
+ * // "INSERT" || "UPSERT" || "UPDATE" || "DELETE",
185
+ * // ],
186
+ * // connectorProvisioningType: "LAMBDA",
187
+ * // connectorProvisioningConfig: { // ConnectorProvisioningConfig
188
+ * // lambda: { // LambdaConnectorProvisioningConfig
189
+ * // lambdaArn: "STRING_VALUE", // required
190
+ * // },
191
+ * // },
192
+ * // logoURL: "STRING_VALUE",
193
+ * // registeredAt: new Date("TIMESTAMP"),
194
+ * // registeredBy: "STRING_VALUE",
195
+ * // },
196
+ * // };
197
+ *
37
198
  * ```
38
199
  *
39
200
  * @param DescribeConnectorCommandInput - {@link DescribeConnectorCommandInput}
@@ -53,6 +214,8 @@ export interface DescribeConnectorCommandOutput extends DescribeConnectorRespons
53
214
  * @throws {@link ValidationException} (client fault)
54
215
  * <p> The request has invalid or missing parameters. </p>
55
216
  *
217
+ * @throws {@link AppflowServiceException}
218
+ * <p>Base exception class for all service exceptions from Appflow service.</p>
56
219
  *
57
220
  */
58
221
  export declare class DescribeConnectorCommand extends $Command<DescribeConnectorCommandInput, DescribeConnectorCommandOutput, AppflowClientResolvedConfig> {
package/dist-types/commands/DescribeConnectorEntityCommand.d.ts CHANGED
@@ -35,6 +35,59 @@ export interface DescribeConnectorEntityCommandOutput extends DescribeConnectorE
35
35
  * };
36
36
  * const command = new DescribeConnectorEntityCommand(input);
37
37
  * const response = await client.send(command);
38
+ * // { // DescribeConnectorEntityResponse
39
+ * // connectorEntityFields: [ // ConnectorEntityFieldList // required
40
+ * // { // ConnectorEntityField
41
+ * // identifier: "STRING_VALUE", // required
42
+ * // parentIdentifier: "STRING_VALUE",
43
+ * // label: "STRING_VALUE",
44
+ * // isPrimaryKey: true || false,
45
+ * // defaultValue: "STRING_VALUE",
46
+ * // isDeprecated: true || false,
47
+ * // supportedFieldTypeDetails: { // SupportedFieldTypeDetails
48
+ * // v1: { // FieldTypeDetails
49
+ * // fieldType: "STRING_VALUE", // required
50
+ * // filterOperators: [ // FilterOperatorList // required
51
+ * // "PROJECTION" || "LESS_THAN" || "GREATER_THAN" || "CONTAINS" || "BETWEEN" || "LESS_THAN_OR_EQUAL_TO" || "GREATER_THAN_OR_EQUAL_TO" || "EQUAL_TO" || "NOT_EQUAL_TO" || "ADDITION" || "MULTIPLICATION" || "DIVISION" || "SUBTRACTION" || "MASK_ALL" || "MASK_FIRST_N" || "MASK_LAST_N" || "VALIDATE_NON_NULL" || "VALIDATE_NON_ZERO" || "VALIDATE_NON_NEGATIVE" || "VALIDATE_NUMERIC" || "NO_OP",
52
+ * // ],
53
+ * // supportedValues: [ // SupportedValueList
54
+ * // "STRING_VALUE",
55
+ * // ],
56
+ * // valueRegexPattern: "STRING_VALUE",
57
+ * // supportedDateFormat: "STRING_VALUE",
58
+ * // fieldValueRange: { // Range
59
+ * // maximum: Number("double"),
60
+ * // minimum: Number("double"),
61
+ * // },
62
+ * // fieldLengthRange: {
63
+ * // maximum: Number("double"),
64
+ * // minimum: Number("double"),
65
+ * // },
66
+ * // },
67
+ * // },
68
+ * // description: "STRING_VALUE",
69
+ * // sourceProperties: { // SourceFieldProperties
70
+ * // isRetrievable: true || false,
71
+ * // isQueryable: true || false,
72
+ * // isTimestampFieldForIncrementalQueries: true || false,
73
+ * // },
74
+ * // destinationProperties: { // DestinationFieldProperties
75
+ * // isCreatable: true || false,
76
+ * // isNullable: true || false,
77
+ * // isUpsertable: true || false,
78
+ * // isUpdatable: true || false,
79
+ * // isDefaultedOnCreate: true || false,
80
+ * // supportedWriteOperations: [ // SupportedWriteOperationList
81
+ * // "INSERT" || "UPSERT" || "UPDATE" || "DELETE",
82
+ * // ],
83
+ * // },
84
+ * // customProperties: { // CustomProperties
85
+ * // "<keys>": "STRING_VALUE",
86
+ * // },
87
+ * // },
88
+ * // ],
89
+ * // };
90
+ *
38
91
  * ```
39
92
  *
40
93
  * @param DescribeConnectorEntityCommandInput - {@link DescribeConnectorEntityCommandInput}
@@ -60,6 +113,8 @@ export interface DescribeConnectorEntityCommandOutput extends DescribeConnectorE
60
113
  * @throws {@link ValidationException} (client fault)
61
114
  * <p> The request has invalid or missing parameters. </p>
62
115
  *
116
+ * @throws {@link AppflowServiceException}
117
+ * <p>Base exception class for all service exceptions from Appflow service.</p>
63
118
  *
64
119
  */
65
120
  export declare class DescribeConnectorEntityCommand extends $Command<DescribeConnectorEntityCommandInput, DescribeConnectorEntityCommandOutput, AppflowClientResolvedConfig> {
package/dist-types/commands/DescribeConnectorProfilesCommand.d.ts CHANGED
@@ -41,6 +41,115 @@ export interface DescribeConnectorProfilesCommandOutput extends DescribeConnecto
41
41
  * };
42
42
  * const command = new DescribeConnectorProfilesCommand(input);
43
43
  * const response = await client.send(command);
44
+ * // { // DescribeConnectorProfilesResponse
45
+ * // connectorProfileDetails: [ // ConnectorProfileDetailList
46
+ * // { // ConnectorProfile
47
+ * // connectorProfileArn: "STRING_VALUE",
48
+ * // connectorProfileName: "STRING_VALUE",
49
+ * // connectorType: "Salesforce" || "Singular" || "Slack" || "Redshift" || "S3" || "Marketo" || "Googleanalytics" || "Zendesk" || "Servicenow" || "Datadog" || "Trendmicro" || "Snowflake" || "Dynatrace" || "Infornexus" || "Amplitude" || "Veeva" || "EventBridge" || "LookoutMetrics" || "Upsolver" || "Honeycode" || "CustomerProfiles" || "SAPOData" || "CustomConnector" || "Pardot",
50
+ * // connectorLabel: "STRING_VALUE",
51
+ * // connectionMode: "Public" || "Private",
52
+ * // credentialsArn: "STRING_VALUE",
53
+ * // connectorProfileProperties: { // ConnectorProfileProperties
54
+ * // Amplitude: {},
55
+ * // Datadog: { // DatadogConnectorProfileProperties
56
+ * // instanceUrl: "STRING_VALUE", // required
57
+ * // },
58
+ * // Dynatrace: { // DynatraceConnectorProfileProperties
59
+ * // instanceUrl: "STRING_VALUE", // required
60
+ * // },
61
+ * // GoogleAnalytics: {},
62
+ * // Honeycode: {},
63
+ * // InforNexus: { // InforNexusConnectorProfileProperties
64
+ * // instanceUrl: "STRING_VALUE", // required
65
+ * // },
66
+ * // Marketo: { // MarketoConnectorProfileProperties
67
+ * // instanceUrl: "STRING_VALUE", // required
68
+ * // },
69
+ * // Redshift: { // RedshiftConnectorProfileProperties
70
+ * // databaseUrl: "STRING_VALUE",
71
+ * // bucketName: "STRING_VALUE", // required
72
+ * // bucketPrefix: "STRING_VALUE",
73
+ * // roleArn: "STRING_VALUE", // required
74
+ * // dataApiRoleArn: "STRING_VALUE",
75
+ * // isRedshiftServerless: true || false,
76
+ * // clusterIdentifier: "STRING_VALUE",
77
+ * // workgroupName: "STRING_VALUE",
78
+ * // databaseName: "STRING_VALUE",
79
+ * // },
80
+ * // Salesforce: { // SalesforceConnectorProfileProperties
81
+ * // instanceUrl: "STRING_VALUE",
82
+ * // isSandboxEnvironment: true || false,
83
+ * // usePrivateLinkForMetadataAndAuthorization: true || false,
84
+ * // },
85
+ * // ServiceNow: { // ServiceNowConnectorProfileProperties
86
+ * // instanceUrl: "STRING_VALUE", // required
87
+ * // },
88
+ * // Singular: {},
89
+ * // Slack: { // SlackConnectorProfileProperties
90
+ * // instanceUrl: "STRING_VALUE", // required
91
+ * // },
92
+ * // Snowflake: { // SnowflakeConnectorProfileProperties
93
+ * // warehouse: "STRING_VALUE", // required
94
+ * // stage: "STRING_VALUE", // required
95
+ * // bucketName: "STRING_VALUE", // required
96
+ * // bucketPrefix: "STRING_VALUE",
97
+ * // privateLinkServiceName: "STRING_VALUE",
98
+ * // accountName: "STRING_VALUE",
99
+ * // region: "STRING_VALUE",
100
+ * // },
101
+ * // Trendmicro: {},
102
+ * // Veeva: { // VeevaConnectorProfileProperties
103
+ * // instanceUrl: "STRING_VALUE", // required
104
+ * // },
105
+ * // Zendesk: { // ZendeskConnectorProfileProperties
106
+ * // instanceUrl: "STRING_VALUE", // required
107
+ * // },
108
+ * // SAPOData: { // SAPODataConnectorProfileProperties
109
+ * // applicationHostUrl: "STRING_VALUE", // required
110
+ * // applicationServicePath: "STRING_VALUE", // required
111
+ * // portNumber: Number("int"), // required
112
+ * // clientNumber: "STRING_VALUE", // required
113
+ * // logonLanguage: "STRING_VALUE",
114
+ * // privateLinkServiceName: "STRING_VALUE",
115
+ * // oAuthProperties: { // OAuthProperties
116
+ * // tokenUrl: "STRING_VALUE", // required
117
+ * // authCodeUrl: "STRING_VALUE", // required
118
+ * // oAuthScopes: [ // OAuthScopeList // required
119
+ * // "STRING_VALUE",
120
+ * // ],
121
+ * // },
122
+ * // },
123
+ * // CustomConnector: { // CustomConnectorProfileProperties
124
+ * // profileProperties: { // ProfilePropertiesMap
125
+ * // "<keys>": "STRING_VALUE",
126
+ * // },
127
+ * // oAuth2Properties: { // OAuth2Properties
128
+ * // tokenUrl: "STRING_VALUE", // required
129
+ * // oAuth2GrantType: "CLIENT_CREDENTIALS" || "AUTHORIZATION_CODE" || "JWT_BEARER", // required
130
+ * // tokenUrlCustomProperties: { // TokenUrlCustomProperties
131
+ * // "<keys>": "STRING_VALUE",
132
+ * // },
133
+ * // },
134
+ * // },
135
+ * // Pardot: { // PardotConnectorProfileProperties
136
+ * // instanceUrl: "STRING_VALUE",
137
+ * // isSandboxEnvironment: true || false,
138
+ * // businessUnitId: "STRING_VALUE",
139
+ * // },
140
+ * // },
141
+ * // createdAt: new Date("TIMESTAMP"),
142
+ * // lastUpdatedAt: new Date("TIMESTAMP"),
143
+ * // privateConnectionProvisioningState: { // PrivateConnectionProvisioningState
144
+ * // status: "FAILED" || "PENDING" || "CREATED",
145
+ * // failureMessage: "STRING_VALUE",
146
+ * // failureCause: "CONNECTOR_AUTHENTICATION" || "CONNECTOR_SERVER" || "INTERNAL_SERVER" || "ACCESS_DENIED" || "VALIDATION",
147
+ * // },
148
+ * // },
149
+ * // ],
150
+ * // nextToken: "STRING_VALUE",
151
+ * // };
152
+ *
44
153
  * ```
45
154
  *
46
155
  * @param DescribeConnectorProfilesCommandInput - {@link DescribeConnectorProfilesCommandInput}
@@ -56,6 +165,8 @@ export interface DescribeConnectorProfilesCommandOutput extends DescribeConnecto
56
165
  * @throws {@link ValidationException} (client fault)
57
166
  * <p> The request has invalid or missing parameters. </p>
58
167
  *
168
+ * @throws {@link AppflowServiceException}
169
+ * <p>Base exception class for all service exceptions from Appflow service.</p>
59
170
  *
60
171
  */
61
172
  export declare class DescribeConnectorProfilesCommand extends $Command<DescribeConnectorProfilesCommandInput, DescribeConnectorProfilesCommandOutput, AppflowClientResolvedConfig> {
package/dist-types/commands/DescribeConnectorsCommand.d.ts CHANGED
@@ -38,6 +38,187 @@ export interface DescribeConnectorsCommandOutput extends DescribeConnectorsRespo
38
38
  * };
39
39
  * const command = new DescribeConnectorsCommand(input);
40
40
  * const response = await client.send(command);
41
+ * // { // DescribeConnectorsResponse
42
+ * // connectorConfigurations: { // ConnectorConfigurationsMap
43
+ * // "<keys>": { // ConnectorConfiguration
44
+ * // canUseAsSource: true || false,
45
+ * // canUseAsDestination: true || false,
46
+ * // supportedDestinationConnectors: [ // ConnectorTypeList
47
+ * // "Salesforce" || "Singular" || "Slack" || "Redshift" || "S3" || "Marketo" || "Googleanalytics" || "Zendesk" || "Servicenow" || "Datadog" || "Trendmicro" || "Snowflake" || "Dynatrace" || "Infornexus" || "Amplitude" || "Veeva" || "EventBridge" || "LookoutMetrics" || "Upsolver" || "Honeycode" || "CustomerProfiles" || "SAPOData" || "CustomConnector" || "Pardot",
48
+ * // ],
49
+ * // supportedSchedulingFrequencies: [ // SchedulingFrequencyTypeList
50
+ * // "BYMINUTE" || "HOURLY" || "DAILY" || "WEEKLY" || "MONTHLY" || "ONCE",
51
+ * // ],
52
+ * // isPrivateLinkEnabled: true || false,
53
+ * // isPrivateLinkEndpointUrlRequired: true || false,
54
+ * // supportedTriggerTypes: [ // TriggerTypeList
55
+ * // "Scheduled" || "Event" || "OnDemand",
56
+ * // ],
57
+ * // connectorMetadata: { // ConnectorMetadata
58
+ * // Amplitude: {},
59
+ * // Datadog: {},
60
+ * // Dynatrace: {},
61
+ * // GoogleAnalytics: { // GoogleAnalyticsMetadata
62
+ * // oAuthScopes: [ // OAuthScopeList
63
+ * // "STRING_VALUE",
64
+ * // ],
65
+ * // },
66
+ * // InforNexus: {},
67
+ * // Marketo: {},
68
+ * // Redshift: {},
69
+ * // S3: {},
70
+ * // Salesforce: { // SalesforceMetadata
71
+ * // oAuthScopes: [
72
+ * // "STRING_VALUE",
73
+ * // ],
74
+ * // dataTransferApis: [ // SalesforceDataTransferApiList
75
+ * // "AUTOMATIC" || "BULKV2" || "REST_SYNC",
76
+ * // ],
77
+ * // oauth2GrantTypesSupported: [ // OAuth2GrantTypeSupportedList
78
+ * // "CLIENT_CREDENTIALS" || "AUTHORIZATION_CODE" || "JWT_BEARER",
79
+ * // ],
80
+ * // },
81
+ * // ServiceNow: {},
82
+ * // Singular: {},
83
+ * // Slack: { // SlackMetadata
84
+ * // oAuthScopes: [
85
+ * // "STRING_VALUE",
86
+ * // ],
87
+ * // },
88
+ * // Snowflake: { // SnowflakeMetadata
89
+ * // supportedRegions: [ // RegionList
90
+ * // "STRING_VALUE",
91
+ * // ],
92
+ * // },
93
+ * // Trendmicro: {},
94
+ * // Veeva: {},
95
+ * // Zendesk: { // ZendeskMetadata
96
+ * // oAuthScopes: [
97
+ * // "STRING_VALUE",
98
+ * // ],
99
+ * // },
100
+ * // EventBridge: {},
101
+ * // Upsolver: {},
102
+ * // CustomerProfiles: {},
103
+ * // Honeycode: { // HoneycodeMetadata
104
+ * // oAuthScopes: [
105
+ * // "STRING_VALUE",
106
+ * // ],
107
+ * // },
108
+ * // SAPOData: {},
109
+ * // Pardot: {},
110
+ * // },
111
+ * // connectorType: "Salesforce" || "Singular" || "Slack" || "Redshift" || "S3" || "Marketo" || "Googleanalytics" || "Zendesk" || "Servicenow" || "Datadog" || "Trendmicro" || "Snowflake" || "Dynatrace" || "Infornexus" || "Amplitude" || "Veeva" || "EventBridge" || "LookoutMetrics" || "Upsolver" || "Honeycode" || "CustomerProfiles" || "SAPOData" || "CustomConnector" || "Pardot",
112
+ * // connectorLabel: "STRING_VALUE",
113
+ * // connectorDescription: "STRING_VALUE",
114
+ * // connectorOwner: "STRING_VALUE",
115
+ * // connectorName: "STRING_VALUE",
116
+ * // connectorVersion: "STRING_VALUE",
117
+ * // connectorArn: "STRING_VALUE",
118
+ * // connectorModes: [ // ConnectorModeList
119
+ * // "STRING_VALUE",
120
+ * // ],
121
+ * // authenticationConfig: { // AuthenticationConfig
122
+ * // isBasicAuthSupported: true || false,
123
+ * // isApiKeyAuthSupported: true || false,
124
+ * // isOAuth2Supported: true || false,
125
+ * // isCustomAuthSupported: true || false,
126
+ * // oAuth2Defaults: { // OAuth2Defaults
127
+ * // oauthScopes: "<OAuthScopeList>",
128
+ * // tokenUrls: [ // TokenUrlList
129
+ * // "STRING_VALUE",
130
+ * // ],
131
+ * // authCodeUrls: [ // AuthCodeUrlList
132
+ * // "STRING_VALUE",
133
+ * // ],
134
+ * // oauth2GrantTypesSupported: [
135
+ * // "CLIENT_CREDENTIALS" || "AUTHORIZATION_CODE" || "JWT_BEARER",
136
+ * // ],
137
+ * // oauth2CustomProperties: [ // OAuth2CustomPropertiesList
138
+ * // { // OAuth2CustomParameter
139
+ * // key: "STRING_VALUE",
140
+ * // isRequired: true || false,
141
+ * // label: "STRING_VALUE",
142
+ * // description: "STRING_VALUE",
143
+ * // isSensitiveField: true || false,
144
+ * // connectorSuppliedValues: [ // ConnectorSuppliedValueList
145
+ * // "STRING_VALUE",
146
+ * // ],
147
+ * // type: "TOKEN_URL" || "AUTH_URL",
148
+ * // },
149
+ * // ],
150
+ * // },
151
+ * // customAuthConfigs: [ // CustomAuthConfigList
152
+ * // { // CustomAuthConfig
153
+ * // customAuthenticationType: "STRING_VALUE",
154
+ * // authParameters: [ // AuthParameterList
155
+ * // { // AuthParameter
156
+ * // key: "STRING_VALUE",
157
+ * // isRequired: true || false,
158
+ * // label: "STRING_VALUE",
159
+ * // description: "STRING_VALUE",
160
+ * // isSensitiveField: true || false,
161
+ * // connectorSuppliedValues: [
162
+ * // "STRING_VALUE",
163
+ * // ],
164
+ * // },
165
+ * // ],
166
+ * // },
167
+ * // ],
168
+ * // },
169
+ * // connectorRuntimeSettings: [ // ConnectorRuntimeSettingList
170
+ * // { // ConnectorRuntimeSetting
171
+ * // key: "STRING_VALUE",
172
+ * // dataType: "STRING_VALUE",
173
+ * // isRequired: true || false,
174
+ * // label: "STRING_VALUE",
175
+ * // description: "STRING_VALUE",
176
+ * // scope: "STRING_VALUE",
177
+ * // connectorSuppliedValueOptions: [ // ConnectorSuppliedValueOptionList
178
+ * // "STRING_VALUE",
179
+ * // ],
180
+ * // },
181
+ * // ],
182
+ * // supportedApiVersions: [ // SupportedApiVersionList
183
+ * // "STRING_VALUE",
184
+ * // ],
185
+ * // supportedOperators: [ // SupportedOperatorList
186
+ * // "PROJECTION" || "LESS_THAN" || "GREATER_THAN" || "CONTAINS" || "BETWEEN" || "LESS_THAN_OR_EQUAL_TO" || "GREATER_THAN_OR_EQUAL_TO" || "EQUAL_TO" || "NOT_EQUAL_TO" || "ADDITION" || "MULTIPLICATION" || "DIVISION" || "SUBTRACTION" || "MASK_ALL" || "MASK_FIRST_N" || "MASK_LAST_N" || "VALIDATE_NON_NULL" || "VALIDATE_NON_ZERO" || "VALIDATE_NON_NEGATIVE" || "VALIDATE_NUMERIC" || "NO_OP",
187
+ * // ],
188
+ * // supportedWriteOperations: [ // SupportedWriteOperationList
189
+ * // "INSERT" || "UPSERT" || "UPDATE" || "DELETE",
190
+ * // ],
191
+ * // connectorProvisioningType: "LAMBDA",
192
+ * // connectorProvisioningConfig: { // ConnectorProvisioningConfig
193
+ * // lambda: { // LambdaConnectorProvisioningConfig
194
+ * // lambdaArn: "STRING_VALUE", // required
195
+ * // },
196
+ * // },
197
+ * // logoURL: "STRING_VALUE",
198
+ * // registeredAt: new Date("TIMESTAMP"),
199
+ * // registeredBy: "STRING_VALUE",
200
+ * // },
201
+ * // },
202
+ * // connectors: [ // ConnectorList
203
+ * // { // ConnectorDetail
204
+ * // connectorDescription: "STRING_VALUE",
205
+ * // connectorName: "STRING_VALUE",
206
+ * // connectorOwner: "STRING_VALUE",
207
+ * // connectorVersion: "STRING_VALUE",
208
+ * // applicationType: "STRING_VALUE",
209
+ * // connectorType: "Salesforce" || "Singular" || "Slack" || "Redshift" || "S3" || "Marketo" || "Googleanalytics" || "Zendesk" || "Servicenow" || "Datadog" || "Trendmicro" || "Snowflake" || "Dynatrace" || "Infornexus" || "Amplitude" || "Veeva" || "EventBridge" || "LookoutMetrics" || "Upsolver" || "Honeycode" || "CustomerProfiles" || "SAPOData" || "CustomConnector" || "Pardot",
210
+ * // connectorLabel: "STRING_VALUE",
211
+ * // registeredAt: new Date("TIMESTAMP"),
212
+ * // registeredBy: "STRING_VALUE",
213
+ * // connectorProvisioningType: "LAMBDA",
214
+ * // connectorModes: [
215
+ * // "STRING_VALUE",
216
+ * // ],
217
+ * // },
218
+ * // ],
219
+ * // nextToken: "STRING_VALUE",
220
+ * // };
221
+ *
41
222
  * ```
42
223
  *
43
224
  * @param DescribeConnectorsCommandInput - {@link DescribeConnectorsCommandInput}
@@ -53,6 +234,8 @@ export interface DescribeConnectorsCommandOutput extends DescribeConnectorsRespo
53
234
  * @throws {@link ValidationException} (client fault)
54
235
  * <p> The request has invalid or missing parameters. </p>
55
236
  *
237
+ * @throws {@link AppflowServiceException}
238
+ * <p>Base exception class for all service exceptions from Appflow service.</p>
56
239
  *
57
240
  */
58
241
  export declare class DescribeConnectorsCommand extends $Command<DescribeConnectorsCommandInput, DescribeConnectorsCommandOutput, AppflowClientResolvedConfig> {