@aws-sdk/client-appflow 3.212.0 → 3.214.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.
- package/dist-cjs/Appflow.js +15 -0
- package/dist-cjs/commands/UpdateConnectorRegistrationCommand.js +46 -0
- package/dist-cjs/commands/index.js +1 -0
- package/dist-cjs/models/models_0.js +40 -5
- package/dist-cjs/protocols/Aws_restJson1.js +186 -1
- package/dist-es/Appflow.js +15 -0
- package/dist-es/commands/UpdateConnectorRegistrationCommand.js +42 -0
- package/dist-es/commands/index.js +1 -0
- package/dist-es/models/models_0.js +29 -0
- package/dist-es/protocols/Aws_restJson1.js +183 -0
- package/dist-types/Appflow.d.ts +18 -3
- package/dist-types/AppflowClient.d.ts +3 -2
- package/dist-types/commands/RegisterConnectorCommand.d.ts +2 -2
- package/dist-types/commands/UnregisterConnectorCommand.d.ts +1 -1
- package/dist-types/commands/UpdateConnectorRegistrationCommand.d.ts +45 -0
- package/dist-types/commands/index.d.ts +1 -0
- package/dist-types/models/models_0.d.ts +244 -7
- package/dist-types/protocols/Aws_restJson1.d.ts +3 -0
- package/dist-types/ts3.4/Appflow.d.ts +17 -0
- package/dist-types/ts3.4/AppflowClient.d.ts +6 -0
- package/dist-types/ts3.4/commands/UpdateConnectorRegistrationCommand.d.ts +41 -0
- package/dist-types/ts3.4/commands/index.d.ts +1 -0
- package/dist-types/ts3.4/models/models_0.d.ts +62 -0
- package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +12 -0
- package/package.json +2 -2
|
@@ -25,6 +25,13 @@ export interface AggregationConfig {
|
|
|
25
25
|
* leave them unaggregated. </p>
|
|
26
26
|
*/
|
|
27
27
|
aggregationType?: AggregationType | string;
|
|
28
|
+
/**
|
|
29
|
+
* <p>The desired file size, in MB, for each output file that Amazon AppFlow writes to the
|
|
30
|
+
* flow destination. For each file, Amazon AppFlow attempts to achieve the size that you
|
|
31
|
+
* specify. The actual file sizes might differ from this target based on the number and size of
|
|
32
|
+
* the records that each file contains.</p>
|
|
33
|
+
*/
|
|
34
|
+
targetFileSize?: number;
|
|
28
35
|
}
|
|
29
36
|
export declare enum AmplitudeConnectorOperator {
|
|
30
37
|
BETWEEN = "BETWEEN"
|
|
@@ -233,6 +240,9 @@ export interface BasicAuthCredentials {
|
|
|
233
240
|
*/
|
|
234
241
|
password: string | undefined;
|
|
235
242
|
}
|
|
243
|
+
export declare enum CatalogType {
|
|
244
|
+
GLUE = "GLUE"
|
|
245
|
+
}
|
|
236
246
|
/**
|
|
237
247
|
* <p> There was a conflict when processing the request (for example, a flow with the given name
|
|
238
248
|
* already exists within the account. Check for conflicting resource names and try again. </p>
|
|
@@ -2423,6 +2433,10 @@ export declare enum FileType {
|
|
|
2423
2433
|
JSON = "JSON",
|
|
2424
2434
|
PARQUET = "PARQUET"
|
|
2425
2435
|
}
|
|
2436
|
+
export declare enum PathPrefix {
|
|
2437
|
+
EXECUTION_ID = "EXECUTION_ID",
|
|
2438
|
+
SCHEMA_VERSION = "SCHEMA_VERSION"
|
|
2439
|
+
}
|
|
2426
2440
|
export declare enum PrefixFormat {
|
|
2427
2441
|
DAY = "DAY",
|
|
2428
2442
|
HOUR = "HOUR",
|
|
@@ -2436,19 +2450,47 @@ export declare enum PrefixType {
|
|
|
2436
2450
|
PATH_AND_FILENAME = "PATH_AND_FILENAME"
|
|
2437
2451
|
}
|
|
2438
2452
|
/**
|
|
2439
|
-
* <p>
|
|
2440
|
-
*
|
|
2453
|
+
* <p>Specifies elements that Amazon AppFlow includes in the file and folder names in the flow
|
|
2454
|
+
* destination.</p>
|
|
2441
2455
|
*/
|
|
2442
2456
|
export interface PrefixConfig {
|
|
2443
2457
|
/**
|
|
2444
|
-
* <p>
|
|
2458
|
+
* <p>Determines the format of the prefix, and whether it applies to the file name, file path,
|
|
2445
2459
|
* or both. </p>
|
|
2446
2460
|
*/
|
|
2447
2461
|
prefixType?: PrefixType | string;
|
|
2448
2462
|
/**
|
|
2449
|
-
* <p>
|
|
2463
|
+
* <p>Determines the level of granularity for the date and time that's included in the prefix. </p>
|
|
2450
2464
|
*/
|
|
2451
2465
|
prefixFormat?: PrefixFormat | string;
|
|
2466
|
+
/**
|
|
2467
|
+
* <p>Specifies whether the destination file path includes either or both of the following
|
|
2468
|
+
* elements:</p>
|
|
2469
|
+
* <dl>
|
|
2470
|
+
* <dt>EXECUTION_ID</dt>
|
|
2471
|
+
* <dd>
|
|
2472
|
+
* <p>The ID that Amazon AppFlow assigns to the flow run.</p>
|
|
2473
|
+
* </dd>
|
|
2474
|
+
* <dt>SCHEMA_VERSION</dt>
|
|
2475
|
+
* <dd>
|
|
2476
|
+
* <p>The version number of your data schema. Amazon AppFlow assigns this version
|
|
2477
|
+
* number. The version number increases by one when you change any of the following
|
|
2478
|
+
* settings in your flow configuration:</p>
|
|
2479
|
+
* <ul>
|
|
2480
|
+
* <li>
|
|
2481
|
+
* <p>Source-to-destination field mappings</p>
|
|
2482
|
+
* </li>
|
|
2483
|
+
* <li>
|
|
2484
|
+
* <p>Field data types</p>
|
|
2485
|
+
* </li>
|
|
2486
|
+
* <li>
|
|
2487
|
+
* <p>Partition keys</p>
|
|
2488
|
+
* </li>
|
|
2489
|
+
* </ul>
|
|
2490
|
+
* </dd>
|
|
2491
|
+
* </dl>
|
|
2492
|
+
*/
|
|
2493
|
+
pathPrefixHierarchy?: (PathPrefix | string)[];
|
|
2452
2494
|
}
|
|
2453
2495
|
/**
|
|
2454
2496
|
* <p> The configuration that determines how Amazon AppFlow should format the flow output
|
|
@@ -2662,8 +2704,8 @@ export interface UpsolverS3OutputFormatConfig {
|
|
|
2662
2704
|
*/
|
|
2663
2705
|
fileType?: FileType | string;
|
|
2664
2706
|
/**
|
|
2665
|
-
* <p>
|
|
2666
|
-
*
|
|
2707
|
+
* <p>Specifies elements that Amazon AppFlow includes in the file and folder names in the flow
|
|
2708
|
+
* destination.</p>
|
|
2667
2709
|
*/
|
|
2668
2710
|
prefixConfig: PrefixConfig | undefined;
|
|
2669
2711
|
/**
|
|
@@ -2798,6 +2840,52 @@ export interface DestinationFlowConfig {
|
|
|
2798
2840
|
*/
|
|
2799
2841
|
destinationConnectorProperties: DestinationConnectorProperties | undefined;
|
|
2800
2842
|
}
|
|
2843
|
+
/**
|
|
2844
|
+
* <p>Specifies the configuration that Amazon AppFlow uses when it catalogs your data with
|
|
2845
|
+
* the Glue Data Catalog. When Amazon AppFlow catalogs your data, it stores
|
|
2846
|
+
* metadata in Data Catalog tables. This metadata represents the data that's transferred
|
|
2847
|
+
* by the flow that you configure with these settings.</p>
|
|
2848
|
+
* <note>
|
|
2849
|
+
* <p>You can configure a flow with these settings only when the flow destination is Amazon S3.</p>
|
|
2850
|
+
* </note>
|
|
2851
|
+
*/
|
|
2852
|
+
export interface GlueDataCatalogConfig {
|
|
2853
|
+
/**
|
|
2854
|
+
* <p>The Amazon Resource Name (ARN) of an IAM role that grants Amazon AppFlow the permissions it needs to create Data Catalog tables, databases, and
|
|
2855
|
+
* partitions.</p>
|
|
2856
|
+
* <p>For an example IAM policy that has the required permissions, see <a href="https://docs.aws.amazon.com/appflow/latest/userguide/security_iam_id-based-policy-examples.html">Identity-based
|
|
2857
|
+
* policy examples for Amazon AppFlow</a>.</p>
|
|
2858
|
+
*/
|
|
2859
|
+
roleArn: string | undefined;
|
|
2860
|
+
/**
|
|
2861
|
+
* <p>The name of the Data Catalog database that stores the metadata tables that
|
|
2862
|
+
* Amazon AppFlow creates in your Amazon Web Services account. These tables contain
|
|
2863
|
+
* metadata for the data that's transferred by the flow that you configure with this
|
|
2864
|
+
* parameter.</p>
|
|
2865
|
+
* <note>
|
|
2866
|
+
* <p>When you configure a new flow with this parameter, you must specify an existing
|
|
2867
|
+
* database.</p>
|
|
2868
|
+
* </note>
|
|
2869
|
+
*/
|
|
2870
|
+
databaseName: string | undefined;
|
|
2871
|
+
/**
|
|
2872
|
+
* <p>A naming prefix for each Data Catalog table that Amazon AppFlow creates for
|
|
2873
|
+
* the flow that you configure with this setting. Amazon AppFlow adds the prefix to the
|
|
2874
|
+
* beginning of the each table name.</p>
|
|
2875
|
+
*/
|
|
2876
|
+
tablePrefix: string | undefined;
|
|
2877
|
+
}
|
|
2878
|
+
/**
|
|
2879
|
+
* <p>Specifies the configuration that Amazon AppFlow uses when it catalogs your data.
|
|
2880
|
+
* When Amazon AppFlow catalogs your data, it stores metadata in a data catalog.</p>
|
|
2881
|
+
*/
|
|
2882
|
+
export interface MetadataCatalogConfig {
|
|
2883
|
+
/**
|
|
2884
|
+
* <p>Specifies the configuration that Amazon AppFlow uses when it catalogs your data with the
|
|
2885
|
+
* Glue Data Catalog.</p>
|
|
2886
|
+
*/
|
|
2887
|
+
glueDataCatalog?: GlueDataCatalogConfig;
|
|
2888
|
+
}
|
|
2801
2889
|
/**
|
|
2802
2890
|
* <p> Specifies the configuration used when importing incremental records from the source.
|
|
2803
2891
|
* </p>
|
|
@@ -2953,7 +3041,7 @@ export interface SalesforceSourceProperties {
|
|
|
2953
3041
|
* <p>Amazon AppFlow uses only Salesforce REST API. By choosing this option, you
|
|
2954
3042
|
* ensure that your flow writes consistent output, but you decrease performance for large
|
|
2955
3043
|
* data transfers that are better suited for Bulk API 2.0. In some cases, if your flow
|
|
2956
|
-
* attempts to transfer a vary large set of data, it might fail
|
|
3044
|
+
* attempts to transfer a vary large set of data, it might fail wituh a timed out
|
|
2957
3045
|
* error.</p>
|
|
2958
3046
|
* </dd>
|
|
2959
3047
|
* </dl>
|
|
@@ -3149,6 +3237,7 @@ export declare enum OperatorPropertiesKeys {
|
|
|
3149
3237
|
MASK_LENGTH = "MASK_LENGTH",
|
|
3150
3238
|
MASK_VALUE = "MASK_VALUE",
|
|
3151
3239
|
MATH_OPERATION_FIELDS_ORDER = "MATH_OPERATION_FIELDS_ORDER",
|
|
3240
|
+
ORDERED_PARTITION_KEYS_LIST = "ORDERED_PARTITION_KEYS_LIST",
|
|
3152
3241
|
SOURCE_DATA_TYPE = "SOURCE_DATA_TYPE",
|
|
3153
3242
|
SUBFIELD_CATEGORY_MAP = "SUBFIELD_CATEGORY_MAP",
|
|
3154
3243
|
TRUNCATE_LENGTH = "TRUNCATE_LENGTH",
|
|
@@ -3164,6 +3253,7 @@ export declare enum TaskType {
|
|
|
3164
3253
|
MAP_ALL = "Map_all",
|
|
3165
3254
|
MASK = "Mask",
|
|
3166
3255
|
MERGE = "Merge",
|
|
3256
|
+
PARTITION = "Partition",
|
|
3167
3257
|
PASSTHROUGH = "Passthrough",
|
|
3168
3258
|
TRUNCATE = "Truncate",
|
|
3169
3259
|
VALIDATE = "Validate"
|
|
@@ -3318,6 +3408,12 @@ export interface CreateFlowRequest {
|
|
|
3318
3408
|
* <p> The tags used to organize, track, or control access for your flow. </p>
|
|
3319
3409
|
*/
|
|
3320
3410
|
tags?: Record<string, string>;
|
|
3411
|
+
/**
|
|
3412
|
+
* <p>Specifies the configuration that Amazon AppFlow uses when it catalogs the data
|
|
3413
|
+
* that's transferred by the associated flow. When Amazon AppFlow catalogs the data from a
|
|
3414
|
+
* flow, it stores metadata in a data catalog.</p>
|
|
3415
|
+
*/
|
|
3416
|
+
metadataCatalogConfig?: MetadataCatalogConfig;
|
|
3321
3417
|
}
|
|
3322
3418
|
export declare enum FlowStatus {
|
|
3323
3419
|
ACTIVE = "Active",
|
|
@@ -3519,6 +3615,65 @@ export interface ExecutionDetails {
|
|
|
3519
3615
|
*/
|
|
3520
3616
|
mostRecentExecutionStatus?: ExecutionStatus | string;
|
|
3521
3617
|
}
|
|
3618
|
+
/**
|
|
3619
|
+
* <p>Describes the status of an attempt from Amazon AppFlow to register a
|
|
3620
|
+
* resource.</p>
|
|
3621
|
+
* <p>When you run a flow that you've configured to use a metadata catalog, Amazon AppFlow
|
|
3622
|
+
* registers a metadata table and data partitions with that catalog. This operation provides the
|
|
3623
|
+
* status of that registration attempt. The operation also indicates how many related resources
|
|
3624
|
+
* Amazon AppFlow created or updated.</p>
|
|
3625
|
+
*/
|
|
3626
|
+
export interface RegistrationOutput {
|
|
3627
|
+
/**
|
|
3628
|
+
* <p>Explains the status of the registration attempt from Amazon AppFlow. If the attempt
|
|
3629
|
+
* fails, the message explains why.</p>
|
|
3630
|
+
*/
|
|
3631
|
+
message?: string;
|
|
3632
|
+
/**
|
|
3633
|
+
* <p>Indicates the number of resources that Amazon AppFlow created or updated. Possible
|
|
3634
|
+
* resources include metadata tables and data partitions.</p>
|
|
3635
|
+
*/
|
|
3636
|
+
result?: string;
|
|
3637
|
+
/**
|
|
3638
|
+
* <p>Indicates the status of the registration attempt from Amazon AppFlow.</p>
|
|
3639
|
+
*/
|
|
3640
|
+
status?: ExecutionStatus | string;
|
|
3641
|
+
}
|
|
3642
|
+
/**
|
|
3643
|
+
* <p>Describes the metadata catalog, metadata table, and data partitions that Amazon AppFlow used for the associated flow run.</p>
|
|
3644
|
+
*/
|
|
3645
|
+
export interface MetadataCatalogDetail {
|
|
3646
|
+
/**
|
|
3647
|
+
* <p>The type of metadata catalog that Amazon AppFlow used for the associated flow run.
|
|
3648
|
+
* This parameter returns the following value:</p>
|
|
3649
|
+
* <dl>
|
|
3650
|
+
* <dt>GLUE</dt>
|
|
3651
|
+
* <dd>
|
|
3652
|
+
* <p>The metadata catalog is provided by the Glue Data Catalog. Glue includes the Glue Data Catalog as a component.</p>
|
|
3653
|
+
* </dd>
|
|
3654
|
+
* </dl>
|
|
3655
|
+
*/
|
|
3656
|
+
catalogType?: CatalogType | string;
|
|
3657
|
+
/**
|
|
3658
|
+
* <p>The name of the table that stores the metadata for the associated flow run. The table
|
|
3659
|
+
* stores metadata that represents the data that the flow transferred. Amazon AppFlow
|
|
3660
|
+
* stores the table in the metadata catalog.</p>
|
|
3661
|
+
*/
|
|
3662
|
+
tableName?: string;
|
|
3663
|
+
/**
|
|
3664
|
+
* <p>Describes the status of the attempt from Amazon AppFlow to register the metadata
|
|
3665
|
+
* table with the metadata catalog. Amazon AppFlow creates or updates this table for the
|
|
3666
|
+
* associated flow run.</p>
|
|
3667
|
+
*/
|
|
3668
|
+
tableRegistrationOutput?: RegistrationOutput;
|
|
3669
|
+
/**
|
|
3670
|
+
* <p>Describes the status of the attempt from Amazon AppFlow to register the data
|
|
3671
|
+
* partitions with the metadata catalog. The data partitions organize the flow output into a
|
|
3672
|
+
* hierarchical path, such as a folder path in an S3 bucket. Amazon AppFlow creates the
|
|
3673
|
+
* partitions (if they don't already exist) based on your flow configuration.</p>
|
|
3674
|
+
*/
|
|
3675
|
+
partitionRegistrationOutput?: RegistrationOutput;
|
|
3676
|
+
}
|
|
3522
3677
|
export interface DescribeFlowResponse {
|
|
3523
3678
|
/**
|
|
3524
3679
|
* <p> The flow's Amazon Resource Name (ARN). </p>
|
|
@@ -3591,6 +3746,33 @@ export interface DescribeFlowResponse {
|
|
|
3591
3746
|
* <p> The tags used to organize, track, or control access for your flow. </p>
|
|
3592
3747
|
*/
|
|
3593
3748
|
tags?: Record<string, string>;
|
|
3749
|
+
/**
|
|
3750
|
+
* <p>Specifies the configuration that Amazon AppFlow uses when it catalogs the data
|
|
3751
|
+
* that's transferred by the associated flow. When Amazon AppFlow catalogs the data from a
|
|
3752
|
+
* flow, it stores metadata in a data catalog.</p>
|
|
3753
|
+
*/
|
|
3754
|
+
metadataCatalogConfig?: MetadataCatalogConfig;
|
|
3755
|
+
/**
|
|
3756
|
+
* <p>Describes the metadata catalog, metadata table, and data partitions that Amazon AppFlow used for the associated flow run.</p>
|
|
3757
|
+
*/
|
|
3758
|
+
lastRunMetadataCatalogDetails?: MetadataCatalogDetail[];
|
|
3759
|
+
/**
|
|
3760
|
+
* <p>The version number of your data schema. Amazon AppFlow assigns this version number.
|
|
3761
|
+
* The version number increases by one when you change any of the following settings in your flow
|
|
3762
|
+
* configuration:</p>
|
|
3763
|
+
* <ul>
|
|
3764
|
+
* <li>
|
|
3765
|
+
* <p>Source-to-destination field mappings</p>
|
|
3766
|
+
* </li>
|
|
3767
|
+
* <li>
|
|
3768
|
+
* <p>Field data types</p>
|
|
3769
|
+
* </li>
|
|
3770
|
+
* <li>
|
|
3771
|
+
* <p>Partition keys</p>
|
|
3772
|
+
* </li>
|
|
3773
|
+
* </ul>
|
|
3774
|
+
*/
|
|
3775
|
+
schemaVersion?: number;
|
|
3594
3776
|
}
|
|
3595
3777
|
export interface DescribeFlowExecutionRecordsRequest {
|
|
3596
3778
|
/**
|
|
@@ -3678,6 +3860,10 @@ export interface ExecutionRecord {
|
|
|
3678
3860
|
* run. </p>
|
|
3679
3861
|
*/
|
|
3680
3862
|
dataPullEndTime?: Date;
|
|
3863
|
+
/**
|
|
3864
|
+
* <p>Describes the metadata catalog, metadata table, and data partitions that Amazon AppFlow used for the associated flow run.</p>
|
|
3865
|
+
*/
|
|
3866
|
+
metadataCatalogDetails?: MetadataCatalogDetail[];
|
|
3681
3867
|
}
|
|
3682
3868
|
export interface DescribeFlowExecutionRecordsResponse {
|
|
3683
3869
|
/**
|
|
@@ -3993,6 +4179,27 @@ export interface UpdateConnectorProfileResponse {
|
|
|
3993
4179
|
*/
|
|
3994
4180
|
connectorProfileArn?: string;
|
|
3995
4181
|
}
|
|
4182
|
+
export interface UpdateConnectorRegistrationRequest {
|
|
4183
|
+
/**
|
|
4184
|
+
* <p>The name of the connector. The name is unique for each connector registration in your AWS
|
|
4185
|
+
* account.</p>
|
|
4186
|
+
*/
|
|
4187
|
+
connectorLabel: string | undefined;
|
|
4188
|
+
/**
|
|
4189
|
+
* <p>A description about the update that you're applying to the connector.</p>
|
|
4190
|
+
*/
|
|
4191
|
+
description?: string;
|
|
4192
|
+
/**
|
|
4193
|
+
* <p>Contains information about the configuration of the connector being registered.</p>
|
|
4194
|
+
*/
|
|
4195
|
+
connectorProvisioningConfig?: ConnectorProvisioningConfig;
|
|
4196
|
+
}
|
|
4197
|
+
export interface UpdateConnectorRegistrationResponse {
|
|
4198
|
+
/**
|
|
4199
|
+
* <p>The ARN of the connector being updated.</p>
|
|
4200
|
+
*/
|
|
4201
|
+
connectorArn?: string;
|
|
4202
|
+
}
|
|
3996
4203
|
export interface UpdateFlowRequest {
|
|
3997
4204
|
/**
|
|
3998
4205
|
* <p> The specified name of the flow. Spaces are not allowed. Use underscores (_) or hyphens
|
|
@@ -4022,6 +4229,12 @@ export interface UpdateFlowRequest {
|
|
|
4022
4229
|
* flow run. </p>
|
|
4023
4230
|
*/
|
|
4024
4231
|
tasks: Task[] | undefined;
|
|
4232
|
+
/**
|
|
4233
|
+
* <p>Specifies the configuration that Amazon AppFlow uses when it catalogs the data
|
|
4234
|
+
* that's transferred by the associated flow. When Amazon AppFlow catalogs the data from a
|
|
4235
|
+
* flow, it stores metadata in a data catalog.</p>
|
|
4236
|
+
*/
|
|
4237
|
+
metadataCatalogConfig?: MetadataCatalogConfig;
|
|
4025
4238
|
}
|
|
4026
4239
|
export interface UpdateFlowResponse {
|
|
4027
4240
|
/**
|
|
@@ -4481,6 +4694,14 @@ export declare const DestinationConnectorPropertiesFilterSensitiveLog: (obj: Des
|
|
|
4481
4694
|
* @internal
|
|
4482
4695
|
*/
|
|
4483
4696
|
export declare const DestinationFlowConfigFilterSensitiveLog: (obj: DestinationFlowConfig) => any;
|
|
4697
|
+
/**
|
|
4698
|
+
* @internal
|
|
4699
|
+
*/
|
|
4700
|
+
export declare const GlueDataCatalogConfigFilterSensitiveLog: (obj: GlueDataCatalogConfig) => any;
|
|
4701
|
+
/**
|
|
4702
|
+
* @internal
|
|
4703
|
+
*/
|
|
4704
|
+
export declare const MetadataCatalogConfigFilterSensitiveLog: (obj: MetadataCatalogConfig) => any;
|
|
4484
4705
|
/**
|
|
4485
4706
|
* @internal
|
|
4486
4707
|
*/
|
|
@@ -4637,6 +4858,14 @@ export declare const DescribeFlowRequestFilterSensitiveLog: (obj: DescribeFlowRe
|
|
|
4637
4858
|
* @internal
|
|
4638
4859
|
*/
|
|
4639
4860
|
export declare const ExecutionDetailsFilterSensitiveLog: (obj: ExecutionDetails) => any;
|
|
4861
|
+
/**
|
|
4862
|
+
* @internal
|
|
4863
|
+
*/
|
|
4864
|
+
export declare const RegistrationOutputFilterSensitiveLog: (obj: RegistrationOutput) => any;
|
|
4865
|
+
/**
|
|
4866
|
+
* @internal
|
|
4867
|
+
*/
|
|
4868
|
+
export declare const MetadataCatalogDetailFilterSensitiveLog: (obj: MetadataCatalogDetail) => any;
|
|
4640
4869
|
/**
|
|
4641
4870
|
* @internal
|
|
4642
4871
|
*/
|
|
@@ -4753,6 +4982,14 @@ export declare const UpdateConnectorProfileRequestFilterSensitiveLog: (obj: Upda
|
|
|
4753
4982
|
* @internal
|
|
4754
4983
|
*/
|
|
4755
4984
|
export declare const UpdateConnectorProfileResponseFilterSensitiveLog: (obj: UpdateConnectorProfileResponse) => any;
|
|
4985
|
+
/**
|
|
4986
|
+
* @internal
|
|
4987
|
+
*/
|
|
4988
|
+
export declare const UpdateConnectorRegistrationRequestFilterSensitiveLog: (obj: UpdateConnectorRegistrationRequest) => any;
|
|
4989
|
+
/**
|
|
4990
|
+
* @internal
|
|
4991
|
+
*/
|
|
4992
|
+
export declare const UpdateConnectorRegistrationResponseFilterSensitiveLog: (obj: UpdateConnectorRegistrationResponse) => any;
|
|
4756
4993
|
/**
|
|
4757
4994
|
* @internal
|
|
4758
4995
|
*/
|
|
@@ -21,6 +21,7 @@ import { TagResourceCommandInput, TagResourceCommandOutput } from "../commands/T
|
|
|
21
21
|
import { UnregisterConnectorCommandInput, UnregisterConnectorCommandOutput } from "../commands/UnregisterConnectorCommand";
|
|
22
22
|
import { UntagResourceCommandInput, UntagResourceCommandOutput } from "../commands/UntagResourceCommand";
|
|
23
23
|
import { UpdateConnectorProfileCommandInput, UpdateConnectorProfileCommandOutput } from "../commands/UpdateConnectorProfileCommand";
|
|
24
|
+
import { UpdateConnectorRegistrationCommandInput, UpdateConnectorRegistrationCommandOutput } from "../commands/UpdateConnectorRegistrationCommand";
|
|
24
25
|
import { UpdateFlowCommandInput, UpdateFlowCommandOutput } from "../commands/UpdateFlowCommand";
|
|
25
26
|
export declare const serializeAws_restJson1CreateConnectorProfileCommand: (input: CreateConnectorProfileCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
|
|
26
27
|
export declare const serializeAws_restJson1CreateFlowCommand: (input: CreateFlowCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
|
|
@@ -43,6 +44,7 @@ export declare const serializeAws_restJson1TagResourceCommand: (input: TagResour
|
|
|
43
44
|
export declare const serializeAws_restJson1UnregisterConnectorCommand: (input: UnregisterConnectorCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
|
|
44
45
|
export declare const serializeAws_restJson1UntagResourceCommand: (input: UntagResourceCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
|
|
45
46
|
export declare const serializeAws_restJson1UpdateConnectorProfileCommand: (input: UpdateConnectorProfileCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
|
|
47
|
+
export declare const serializeAws_restJson1UpdateConnectorRegistrationCommand: (input: UpdateConnectorRegistrationCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
|
|
46
48
|
export declare const serializeAws_restJson1UpdateFlowCommand: (input: UpdateFlowCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
|
|
47
49
|
export declare const deserializeAws_restJson1CreateConnectorProfileCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<CreateConnectorProfileCommandOutput>;
|
|
48
50
|
export declare const deserializeAws_restJson1CreateFlowCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<CreateFlowCommandOutput>;
|
|
@@ -65,4 +67,5 @@ export declare const deserializeAws_restJson1TagResourceCommand: (output: __Http
|
|
|
65
67
|
export declare const deserializeAws_restJson1UnregisterConnectorCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<UnregisterConnectorCommandOutput>;
|
|
66
68
|
export declare const deserializeAws_restJson1UntagResourceCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<UntagResourceCommandOutput>;
|
|
67
69
|
export declare const deserializeAws_restJson1UpdateConnectorProfileCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<UpdateConnectorProfileCommandOutput>;
|
|
70
|
+
export declare const deserializeAws_restJson1UpdateConnectorRegistrationCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<UpdateConnectorRegistrationCommandOutput>;
|
|
68
71
|
export declare const deserializeAws_restJson1UpdateFlowCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<UpdateFlowCommandOutput>;
|
|
@@ -84,6 +84,10 @@ import {
|
|
|
84
84
|
UpdateConnectorProfileCommandInput,
|
|
85
85
|
UpdateConnectorProfileCommandOutput,
|
|
86
86
|
} from "./commands/UpdateConnectorProfileCommand";
|
|
87
|
+
import {
|
|
88
|
+
UpdateConnectorRegistrationCommandInput,
|
|
89
|
+
UpdateConnectorRegistrationCommandOutput,
|
|
90
|
+
} from "./commands/UpdateConnectorRegistrationCommand";
|
|
87
91
|
import {
|
|
88
92
|
UpdateFlowCommandInput,
|
|
89
93
|
UpdateFlowCommandOutput,
|
|
@@ -362,6 +366,19 @@ export declare class Appflow extends AppflowClient {
|
|
|
362
366
|
options: __HttpHandlerOptions,
|
|
363
367
|
cb: (err: any, data?: UpdateConnectorProfileCommandOutput) => void
|
|
364
368
|
): void;
|
|
369
|
+
updateConnectorRegistration(
|
|
370
|
+
args: UpdateConnectorRegistrationCommandInput,
|
|
371
|
+
options?: __HttpHandlerOptions
|
|
372
|
+
): Promise<UpdateConnectorRegistrationCommandOutput>;
|
|
373
|
+
updateConnectorRegistration(
|
|
374
|
+
args: UpdateConnectorRegistrationCommandInput,
|
|
375
|
+
cb: (err: any, data?: UpdateConnectorRegistrationCommandOutput) => void
|
|
376
|
+
): void;
|
|
377
|
+
updateConnectorRegistration(
|
|
378
|
+
args: UpdateConnectorRegistrationCommandInput,
|
|
379
|
+
options: __HttpHandlerOptions,
|
|
380
|
+
cb: (err: any, data?: UpdateConnectorRegistrationCommandOutput) => void
|
|
381
|
+
): void;
|
|
365
382
|
updateFlow(
|
|
366
383
|
args: UpdateFlowCommandInput,
|
|
367
384
|
options?: __HttpHandlerOptions
|
|
@@ -127,6 +127,10 @@ import {
|
|
|
127
127
|
UpdateConnectorProfileCommandInput,
|
|
128
128
|
UpdateConnectorProfileCommandOutput,
|
|
129
129
|
} from "./commands/UpdateConnectorProfileCommand";
|
|
130
|
+
import {
|
|
131
|
+
UpdateConnectorRegistrationCommandInput,
|
|
132
|
+
UpdateConnectorRegistrationCommandOutput,
|
|
133
|
+
} from "./commands/UpdateConnectorRegistrationCommand";
|
|
130
134
|
import {
|
|
131
135
|
UpdateFlowCommandInput,
|
|
132
136
|
UpdateFlowCommandOutput,
|
|
@@ -158,6 +162,7 @@ export declare type ServiceInputTypes =
|
|
|
158
162
|
| UnregisterConnectorCommandInput
|
|
159
163
|
| UntagResourceCommandInput
|
|
160
164
|
| UpdateConnectorProfileCommandInput
|
|
165
|
+
| UpdateConnectorRegistrationCommandInput
|
|
161
166
|
| UpdateFlowCommandInput;
|
|
162
167
|
export declare type ServiceOutputTypes =
|
|
163
168
|
| CreateConnectorProfileCommandOutput
|
|
@@ -181,6 +186,7 @@ export declare type ServiceOutputTypes =
|
|
|
181
186
|
| UnregisterConnectorCommandOutput
|
|
182
187
|
| UntagResourceCommandOutput
|
|
183
188
|
| UpdateConnectorProfileCommandOutput
|
|
189
|
+
| UpdateConnectorRegistrationCommandOutput
|
|
184
190
|
| UpdateFlowCommandOutput;
|
|
185
191
|
export interface ClientDefaults
|
|
186
192
|
extends Partial<__SmithyResolvedConfiguration<__HttpHandlerOptions>> {
|
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint";
|
|
2
|
+
import { Command as $Command } from "@aws-sdk/smithy-client";
|
|
3
|
+
import {
|
|
4
|
+
Handler,
|
|
5
|
+
HttpHandlerOptions as __HttpHandlerOptions,
|
|
6
|
+
MetadataBearer as __MetadataBearer,
|
|
7
|
+
MiddlewareStack,
|
|
8
|
+
} from "@aws-sdk/types";
|
|
9
|
+
import {
|
|
10
|
+
AppflowClientResolvedConfig,
|
|
11
|
+
ServiceInputTypes,
|
|
12
|
+
ServiceOutputTypes,
|
|
13
|
+
} from "../AppflowClient";
|
|
14
|
+
import {
|
|
15
|
+
UpdateConnectorRegistrationRequest,
|
|
16
|
+
UpdateConnectorRegistrationResponse,
|
|
17
|
+
} from "../models/models_0";
|
|
18
|
+
export interface UpdateConnectorRegistrationCommandInput
|
|
19
|
+
extends UpdateConnectorRegistrationRequest {}
|
|
20
|
+
export interface UpdateConnectorRegistrationCommandOutput
|
|
21
|
+
extends UpdateConnectorRegistrationResponse,
|
|
22
|
+
__MetadataBearer {}
|
|
23
|
+
export declare class UpdateConnectorRegistrationCommand extends $Command<
|
|
24
|
+
UpdateConnectorRegistrationCommandInput,
|
|
25
|
+
UpdateConnectorRegistrationCommandOutput,
|
|
26
|
+
AppflowClientResolvedConfig
|
|
27
|
+
> {
|
|
28
|
+
readonly input: UpdateConnectorRegistrationCommandInput;
|
|
29
|
+
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
30
|
+
constructor(input: UpdateConnectorRegistrationCommandInput);
|
|
31
|
+
resolveMiddleware(
|
|
32
|
+
clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>,
|
|
33
|
+
configuration: AppflowClientResolvedConfig,
|
|
34
|
+
options?: __HttpHandlerOptions
|
|
35
|
+
): Handler<
|
|
36
|
+
UpdateConnectorRegistrationCommandInput,
|
|
37
|
+
UpdateConnectorRegistrationCommandOutput
|
|
38
|
+
>;
|
|
39
|
+
private serialize;
|
|
40
|
+
private deserialize;
|
|
41
|
+
}
|
|
@@ -19,4 +19,5 @@ export * from "./TagResourceCommand";
|
|
|
19
19
|
export * from "./UnregisterConnectorCommand";
|
|
20
20
|
export * from "./UntagResourceCommand";
|
|
21
21
|
export * from "./UpdateConnectorProfileCommand";
|
|
22
|
+
export * from "./UpdateConnectorRegistrationCommand";
|
|
22
23
|
export * from "./UpdateFlowCommand";
|
|
@@ -13,6 +13,7 @@ export declare enum AggregationType {
|
|
|
13
13
|
}
|
|
14
14
|
export interface AggregationConfig {
|
|
15
15
|
aggregationType?: AggregationType | string;
|
|
16
|
+
targetFileSize?: number;
|
|
16
17
|
}
|
|
17
18
|
export declare enum AmplitudeConnectorOperator {
|
|
18
19
|
BETWEEN = "BETWEEN",
|
|
@@ -84,6 +85,9 @@ export interface BasicAuthCredentials {
|
|
|
84
85
|
username: string | undefined;
|
|
85
86
|
password: string | undefined;
|
|
86
87
|
}
|
|
88
|
+
export declare enum CatalogType {
|
|
89
|
+
GLUE = "GLUE",
|
|
90
|
+
}
|
|
87
91
|
export declare class ConflictException extends __BaseException {
|
|
88
92
|
readonly name: "ConflictException";
|
|
89
93
|
readonly $fault: "client";
|
|
@@ -960,6 +964,10 @@ export declare enum FileType {
|
|
|
960
964
|
JSON = "JSON",
|
|
961
965
|
PARQUET = "PARQUET",
|
|
962
966
|
}
|
|
967
|
+
export declare enum PathPrefix {
|
|
968
|
+
EXECUTION_ID = "EXECUTION_ID",
|
|
969
|
+
SCHEMA_VERSION = "SCHEMA_VERSION",
|
|
970
|
+
}
|
|
963
971
|
export declare enum PrefixFormat {
|
|
964
972
|
DAY = "DAY",
|
|
965
973
|
HOUR = "HOUR",
|
|
@@ -975,6 +983,7 @@ export declare enum PrefixType {
|
|
|
975
983
|
export interface PrefixConfig {
|
|
976
984
|
prefixType?: PrefixType | string;
|
|
977
985
|
prefixFormat?: PrefixFormat | string;
|
|
986
|
+
pathPrefixHierarchy?: (PathPrefix | string)[];
|
|
978
987
|
}
|
|
979
988
|
export interface S3OutputFormatConfig {
|
|
980
989
|
fileType?: FileType | string;
|
|
@@ -1048,6 +1057,14 @@ export interface DestinationFlowConfig {
|
|
|
1048
1057
|
connectorProfileName?: string;
|
|
1049
1058
|
destinationConnectorProperties: DestinationConnectorProperties | undefined;
|
|
1050
1059
|
}
|
|
1060
|
+
export interface GlueDataCatalogConfig {
|
|
1061
|
+
roleArn: string | undefined;
|
|
1062
|
+
databaseName: string | undefined;
|
|
1063
|
+
tablePrefix: string | undefined;
|
|
1064
|
+
}
|
|
1065
|
+
export interface MetadataCatalogConfig {
|
|
1066
|
+
glueDataCatalog?: GlueDataCatalogConfig;
|
|
1067
|
+
}
|
|
1051
1068
|
export interface IncrementalPullConfig {
|
|
1052
1069
|
datetimeTypeFieldName?: string;
|
|
1053
1070
|
}
|
|
@@ -1148,6 +1165,7 @@ export declare enum OperatorPropertiesKeys {
|
|
|
1148
1165
|
MASK_LENGTH = "MASK_LENGTH",
|
|
1149
1166
|
MASK_VALUE = "MASK_VALUE",
|
|
1150
1167
|
MATH_OPERATION_FIELDS_ORDER = "MATH_OPERATION_FIELDS_ORDER",
|
|
1168
|
+
ORDERED_PARTITION_KEYS_LIST = "ORDERED_PARTITION_KEYS_LIST",
|
|
1151
1169
|
SOURCE_DATA_TYPE = "SOURCE_DATA_TYPE",
|
|
1152
1170
|
SUBFIELD_CATEGORY_MAP = "SUBFIELD_CATEGORY_MAP",
|
|
1153
1171
|
TRUNCATE_LENGTH = "TRUNCATE_LENGTH",
|
|
@@ -1163,6 +1181,7 @@ export declare enum TaskType {
|
|
|
1163
1181
|
MAP_ALL = "Map_all",
|
|
1164
1182
|
MASK = "Mask",
|
|
1165
1183
|
MERGE = "Merge",
|
|
1184
|
+
PARTITION = "Partition",
|
|
1166
1185
|
PASSTHROUGH = "Passthrough",
|
|
1167
1186
|
TRUNCATE = "Truncate",
|
|
1168
1187
|
VALIDATE = "Validate",
|
|
@@ -1204,6 +1223,7 @@ export interface CreateFlowRequest {
|
|
|
1204
1223
|
destinationFlowConfigList: DestinationFlowConfig[] | undefined;
|
|
1205
1224
|
tasks: Task[] | undefined;
|
|
1206
1225
|
tags?: Record<string, string>;
|
|
1226
|
+
metadataCatalogConfig?: MetadataCatalogConfig;
|
|
1207
1227
|
}
|
|
1208
1228
|
export declare enum FlowStatus {
|
|
1209
1229
|
ACTIVE = "Active",
|
|
@@ -1284,6 +1304,17 @@ export interface ExecutionDetails {
|
|
|
1284
1304
|
mostRecentExecutionTime?: Date;
|
|
1285
1305
|
mostRecentExecutionStatus?: ExecutionStatus | string;
|
|
1286
1306
|
}
|
|
1307
|
+
export interface RegistrationOutput {
|
|
1308
|
+
message?: string;
|
|
1309
|
+
result?: string;
|
|
1310
|
+
status?: ExecutionStatus | string;
|
|
1311
|
+
}
|
|
1312
|
+
export interface MetadataCatalogDetail {
|
|
1313
|
+
catalogType?: CatalogType | string;
|
|
1314
|
+
tableName?: string;
|
|
1315
|
+
tableRegistrationOutput?: RegistrationOutput;
|
|
1316
|
+
partitionRegistrationOutput?: RegistrationOutput;
|
|
1317
|
+
}
|
|
1287
1318
|
export interface DescribeFlowResponse {
|
|
1288
1319
|
flowArn?: string;
|
|
1289
1320
|
description?: string;
|
|
@@ -1301,6 +1332,9 @@ export interface DescribeFlowResponse {
|
|
|
1301
1332
|
createdBy?: string;
|
|
1302
1333
|
lastUpdatedBy?: string;
|
|
1303
1334
|
tags?: Record<string, string>;
|
|
1335
|
+
metadataCatalogConfig?: MetadataCatalogConfig;
|
|
1336
|
+
lastRunMetadataCatalogDetails?: MetadataCatalogDetail[];
|
|
1337
|
+
schemaVersion?: number;
|
|
1304
1338
|
}
|
|
1305
1339
|
export interface DescribeFlowExecutionRecordsRequest {
|
|
1306
1340
|
flowName: string | undefined;
|
|
@@ -1325,6 +1359,7 @@ export interface ExecutionRecord {
|
|
|
1325
1359
|
lastUpdatedAt?: Date;
|
|
1326
1360
|
dataPullStartTime?: Date;
|
|
1327
1361
|
dataPullEndTime?: Date;
|
|
1362
|
+
metadataCatalogDetails?: MetadataCatalogDetail[];
|
|
1328
1363
|
}
|
|
1329
1364
|
export interface DescribeFlowExecutionRecordsResponse {
|
|
1330
1365
|
flowExecutions?: ExecutionRecord[];
|
|
@@ -1439,6 +1474,14 @@ export interface UpdateConnectorProfileRequest {
|
|
|
1439
1474
|
export interface UpdateConnectorProfileResponse {
|
|
1440
1475
|
connectorProfileArn?: string;
|
|
1441
1476
|
}
|
|
1477
|
+
export interface UpdateConnectorRegistrationRequest {
|
|
1478
|
+
connectorLabel: string | undefined;
|
|
1479
|
+
description?: string;
|
|
1480
|
+
connectorProvisioningConfig?: ConnectorProvisioningConfig;
|
|
1481
|
+
}
|
|
1482
|
+
export interface UpdateConnectorRegistrationResponse {
|
|
1483
|
+
connectorArn?: string;
|
|
1484
|
+
}
|
|
1442
1485
|
export interface UpdateFlowRequest {
|
|
1443
1486
|
flowName: string | undefined;
|
|
1444
1487
|
description?: string;
|
|
@@ -1446,6 +1489,7 @@ export interface UpdateFlowRequest {
|
|
|
1446
1489
|
sourceFlowConfig: SourceFlowConfig | undefined;
|
|
1447
1490
|
destinationFlowConfigList: DestinationFlowConfig[] | undefined;
|
|
1448
1491
|
tasks: Task[] | undefined;
|
|
1492
|
+
metadataCatalogConfig?: MetadataCatalogConfig;
|
|
1449
1493
|
}
|
|
1450
1494
|
export interface UpdateFlowResponse {
|
|
1451
1495
|
flowStatus?: FlowStatus | string;
|
|
@@ -1783,6 +1827,12 @@ export declare const DestinationConnectorPropertiesFilterSensitiveLog: (
|
|
|
1783
1827
|
export declare const DestinationFlowConfigFilterSensitiveLog: (
|
|
1784
1828
|
obj: DestinationFlowConfig
|
|
1785
1829
|
) => any;
|
|
1830
|
+
export declare const GlueDataCatalogConfigFilterSensitiveLog: (
|
|
1831
|
+
obj: GlueDataCatalogConfig
|
|
1832
|
+
) => any;
|
|
1833
|
+
export declare const MetadataCatalogConfigFilterSensitiveLog: (
|
|
1834
|
+
obj: MetadataCatalogConfig
|
|
1835
|
+
) => any;
|
|
1786
1836
|
export declare const IncrementalPullConfigFilterSensitiveLog: (
|
|
1787
1837
|
obj: IncrementalPullConfig
|
|
1788
1838
|
) => any;
|
|
@@ -1898,6 +1948,12 @@ export declare const DescribeFlowRequestFilterSensitiveLog: (
|
|
|
1898
1948
|
export declare const ExecutionDetailsFilterSensitiveLog: (
|
|
1899
1949
|
obj: ExecutionDetails
|
|
1900
1950
|
) => any;
|
|
1951
|
+
export declare const RegistrationOutputFilterSensitiveLog: (
|
|
1952
|
+
obj: RegistrationOutput
|
|
1953
|
+
) => any;
|
|
1954
|
+
export declare const MetadataCatalogDetailFilterSensitiveLog: (
|
|
1955
|
+
obj: MetadataCatalogDetail
|
|
1956
|
+
) => any;
|
|
1901
1957
|
export declare const DescribeFlowResponseFilterSensitiveLog: (
|
|
1902
1958
|
obj: DescribeFlowResponse
|
|
1903
1959
|
) => any;
|
|
@@ -1983,6 +2039,12 @@ export declare const UpdateConnectorProfileRequestFilterSensitiveLog: (
|
|
|
1983
2039
|
export declare const UpdateConnectorProfileResponseFilterSensitiveLog: (
|
|
1984
2040
|
obj: UpdateConnectorProfileResponse
|
|
1985
2041
|
) => any;
|
|
2042
|
+
export declare const UpdateConnectorRegistrationRequestFilterSensitiveLog: (
|
|
2043
|
+
obj: UpdateConnectorRegistrationRequest
|
|
2044
|
+
) => any;
|
|
2045
|
+
export declare const UpdateConnectorRegistrationResponseFilterSensitiveLog: (
|
|
2046
|
+
obj: UpdateConnectorRegistrationResponse
|
|
2047
|
+
) => any;
|
|
1986
2048
|
export declare const UpdateFlowRequestFilterSensitiveLog: (
|
|
1987
2049
|
obj: UpdateFlowRequest
|
|
1988
2050
|
) => any;
|