@aws-sdk/client-databrew 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.
- package/dist-types/commands/BatchDeleteRecipeVersionCommand.d.ts +13 -0
- package/dist-types/commands/CreateDatasetCommand.d.ts +6 -0
- package/dist-types/commands/CreateProfileJobCommand.d.ts +6 -0
- package/dist-types/commands/CreateProjectCommand.d.ts +6 -0
- package/dist-types/commands/CreateRecipeCommand.d.ts +6 -0
- package/dist-types/commands/CreateRecipeJobCommand.d.ts +6 -0
- package/dist-types/commands/CreateRulesetCommand.d.ts +6 -0
- package/dist-types/commands/CreateScheduleCommand.d.ts +6 -0
- package/dist-types/commands/DeleteDatasetCommand.d.ts +6 -0
- package/dist-types/commands/DeleteJobCommand.d.ts +6 -0
- package/dist-types/commands/DeleteProjectCommand.d.ts +6 -0
- package/dist-types/commands/DeleteRecipeVersionCommand.d.ts +7 -0
- package/dist-types/commands/DeleteRulesetCommand.d.ts +6 -0
- package/dist-types/commands/DeleteScheduleCommand.d.ts +6 -0
- package/dist-types/commands/DescribeDatasetCommand.d.ts +95 -0
- package/dist-types/commands/DescribeJobCommand.d.ts +152 -0
- package/dist-types/commands/DescribeJobRunCommand.d.ts +145 -0
- package/dist-types/commands/DescribeProjectCommand.d.ts +24 -0
- package/dist-types/commands/DescribeRecipeCommand.d.ts +36 -0
- package/dist-types/commands/DescribeRulesetCommand.d.ts +37 -0
- package/dist-types/commands/DescribeScheduleCommand.d.ts +18 -0
- package/dist-types/commands/ListDatasetsCommand.d.ts +101 -0
- package/dist-types/commands/ListJobRunsCommand.d.ts +94 -0
- package/dist-types/commands/ListJobsCommand.d.ts +102 -0
- package/dist-types/commands/ListProjectsCommand.d.ts +29 -0
- package/dist-types/commands/ListRecipeVersionsCommand.d.ts +41 -0
- package/dist-types/commands/ListRecipesCommand.d.ts +41 -0
- package/dist-types/commands/ListRulesetsCommand.d.ts +23 -0
- package/dist-types/commands/ListSchedulesCommand.d.ts +24 -0
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +8 -0
- package/dist-types/commands/PublishRecipeCommand.d.ts +6 -0
- package/dist-types/commands/SendProjectSessionActionCommand.d.ts +8 -0
- package/dist-types/commands/StartJobRunCommand.d.ts +6 -0
- package/dist-types/commands/StartProjectSessionCommand.d.ts +7 -0
- package/dist-types/commands/StopJobRunCommand.d.ts +6 -0
- package/dist-types/commands/TagResourceCommand.d.ts +4 -0
- package/dist-types/commands/UntagResourceCommand.d.ts +4 -0
- package/dist-types/commands/UpdateDatasetCommand.d.ts +6 -0
- package/dist-types/commands/UpdateProfileJobCommand.d.ts +6 -0
- package/dist-types/commands/UpdateProjectCommand.d.ts +7 -0
- package/dist-types/commands/UpdateRecipeCommand.d.ts +6 -0
- package/dist-types/commands/UpdateRecipeJobCommand.d.ts +6 -0
- package/dist-types/commands/UpdateRulesetCommand.d.ts +6 -0
- package/dist-types/commands/UpdateScheduleCommand.d.ts +6 -0
- package/package.json +3 -3
|
@@ -32,6 +32,149 @@ export interface DescribeJobRunCommandOutput extends DescribeJobRunResponse, __M
|
|
|
32
32
|
* };
|
|
33
33
|
* const command = new DescribeJobRunCommand(input);
|
|
34
34
|
* const response = await client.send(command);
|
|
35
|
+
* // { // DescribeJobRunResponse
|
|
36
|
+
* // Attempt: Number("int"),
|
|
37
|
+
* // CompletedOn: new Date("TIMESTAMP"),
|
|
38
|
+
* // DatasetName: "STRING_VALUE",
|
|
39
|
+
* // ErrorMessage: "STRING_VALUE",
|
|
40
|
+
* // ExecutionTime: Number("int"),
|
|
41
|
+
* // JobName: "STRING_VALUE", // required
|
|
42
|
+
* // ProfileConfiguration: { // ProfileConfiguration
|
|
43
|
+
* // DatasetStatisticsConfiguration: { // StatisticsConfiguration
|
|
44
|
+
* // IncludedStatistics: [ // StatisticList
|
|
45
|
+
* // "STRING_VALUE",
|
|
46
|
+
* // ],
|
|
47
|
+
* // Overrides: [ // StatisticOverrideList
|
|
48
|
+
* // { // StatisticOverride
|
|
49
|
+
* // Statistic: "STRING_VALUE", // required
|
|
50
|
+
* // Parameters: { // ParameterMap // required
|
|
51
|
+
* // "<keys>": "STRING_VALUE",
|
|
52
|
+
* // },
|
|
53
|
+
* // },
|
|
54
|
+
* // ],
|
|
55
|
+
* // },
|
|
56
|
+
* // ProfileColumns: [ // ColumnSelectorList
|
|
57
|
+
* // { // ColumnSelector
|
|
58
|
+
* // Regex: "STRING_VALUE",
|
|
59
|
+
* // Name: "STRING_VALUE",
|
|
60
|
+
* // },
|
|
61
|
+
* // ],
|
|
62
|
+
* // ColumnStatisticsConfigurations: [ // ColumnStatisticsConfigurationList
|
|
63
|
+
* // { // ColumnStatisticsConfiguration
|
|
64
|
+
* // Selectors: [
|
|
65
|
+
* // {
|
|
66
|
+
* // Regex: "STRING_VALUE",
|
|
67
|
+
* // Name: "STRING_VALUE",
|
|
68
|
+
* // },
|
|
69
|
+
* // ],
|
|
70
|
+
* // Statistics: {
|
|
71
|
+
* // IncludedStatistics: [
|
|
72
|
+
* // "STRING_VALUE",
|
|
73
|
+
* // ],
|
|
74
|
+
* // Overrides: [
|
|
75
|
+
* // {
|
|
76
|
+
* // Statistic: "STRING_VALUE", // required
|
|
77
|
+
* // Parameters: { // required
|
|
78
|
+
* // "<keys>": "STRING_VALUE",
|
|
79
|
+
* // },
|
|
80
|
+
* // },
|
|
81
|
+
* // ],
|
|
82
|
+
* // },
|
|
83
|
+
* // },
|
|
84
|
+
* // ],
|
|
85
|
+
* // EntityDetectorConfiguration: { // EntityDetectorConfiguration
|
|
86
|
+
* // EntityTypes: [ // EntityTypeList // required
|
|
87
|
+
* // "STRING_VALUE",
|
|
88
|
+
* // ],
|
|
89
|
+
* // AllowedStatistics: [ // AllowedStatisticList
|
|
90
|
+
* // { // AllowedStatistics
|
|
91
|
+
* // Statistics: [ // required
|
|
92
|
+
* // "STRING_VALUE",
|
|
93
|
+
* // ],
|
|
94
|
+
* // },
|
|
95
|
+
* // ],
|
|
96
|
+
* // },
|
|
97
|
+
* // },
|
|
98
|
+
* // ValidationConfigurations: [ // ValidationConfigurationList
|
|
99
|
+
* // { // ValidationConfiguration
|
|
100
|
+
* // RulesetArn: "STRING_VALUE", // required
|
|
101
|
+
* // ValidationMode: "CHECK_ALL",
|
|
102
|
+
* // },
|
|
103
|
+
* // ],
|
|
104
|
+
* // RunId: "STRING_VALUE",
|
|
105
|
+
* // State: "STARTING" || "RUNNING" || "STOPPING" || "STOPPED" || "SUCCEEDED" || "FAILED" || "TIMEOUT",
|
|
106
|
+
* // LogSubscription: "ENABLE" || "DISABLE",
|
|
107
|
+
* // LogGroupName: "STRING_VALUE",
|
|
108
|
+
* // Outputs: [ // OutputList
|
|
109
|
+
* // { // Output
|
|
110
|
+
* // CompressionFormat: "GZIP" || "LZ4" || "SNAPPY" || "BZIP2" || "DEFLATE" || "LZO" || "BROTLI" || "ZSTD" || "ZLIB",
|
|
111
|
+
* // Format: "CSV" || "JSON" || "PARQUET" || "GLUEPARQUET" || "AVRO" || "ORC" || "XML" || "TABLEAUHYPER",
|
|
112
|
+
* // PartitionColumns: [ // ColumnNameList
|
|
113
|
+
* // "STRING_VALUE",
|
|
114
|
+
* // ],
|
|
115
|
+
* // Location: { // S3Location
|
|
116
|
+
* // Bucket: "STRING_VALUE", // required
|
|
117
|
+
* // Key: "STRING_VALUE",
|
|
118
|
+
* // BucketOwner: "STRING_VALUE",
|
|
119
|
+
* // },
|
|
120
|
+
* // Overwrite: true || false,
|
|
121
|
+
* // FormatOptions: { // OutputFormatOptions
|
|
122
|
+
* // Csv: { // CsvOutputOptions
|
|
123
|
+
* // Delimiter: "STRING_VALUE",
|
|
124
|
+
* // },
|
|
125
|
+
* // },
|
|
126
|
+
* // MaxOutputFiles: Number("int"),
|
|
127
|
+
* // },
|
|
128
|
+
* // ],
|
|
129
|
+
* // DataCatalogOutputs: [ // DataCatalogOutputList
|
|
130
|
+
* // { // DataCatalogOutput
|
|
131
|
+
* // CatalogId: "STRING_VALUE",
|
|
132
|
+
* // DatabaseName: "STRING_VALUE", // required
|
|
133
|
+
* // TableName: "STRING_VALUE", // required
|
|
134
|
+
* // S3Options: { // S3TableOutputOptions
|
|
135
|
+
* // Location: {
|
|
136
|
+
* // Bucket: "STRING_VALUE", // required
|
|
137
|
+
* // Key: "STRING_VALUE",
|
|
138
|
+
* // BucketOwner: "STRING_VALUE",
|
|
139
|
+
* // },
|
|
140
|
+
* // },
|
|
141
|
+
* // DatabaseOptions: { // DatabaseTableOutputOptions
|
|
142
|
+
* // TempDirectory: {
|
|
143
|
+
* // Bucket: "STRING_VALUE", // required
|
|
144
|
+
* // Key: "STRING_VALUE",
|
|
145
|
+
* // BucketOwner: "STRING_VALUE",
|
|
146
|
+
* // },
|
|
147
|
+
* // TableName: "STRING_VALUE", // required
|
|
148
|
+
* // },
|
|
149
|
+
* // Overwrite: true || false,
|
|
150
|
+
* // },
|
|
151
|
+
* // ],
|
|
152
|
+
* // DatabaseOutputs: [ // DatabaseOutputList
|
|
153
|
+
* // { // DatabaseOutput
|
|
154
|
+
* // GlueConnectionName: "STRING_VALUE", // required
|
|
155
|
+
* // DatabaseOptions: {
|
|
156
|
+
* // TempDirectory: {
|
|
157
|
+
* // Bucket: "STRING_VALUE", // required
|
|
158
|
+
* // Key: "STRING_VALUE",
|
|
159
|
+
* // BucketOwner: "STRING_VALUE",
|
|
160
|
+
* // },
|
|
161
|
+
* // TableName: "STRING_VALUE", // required
|
|
162
|
+
* // },
|
|
163
|
+
* // DatabaseOutputMode: "NEW_TABLE",
|
|
164
|
+
* // },
|
|
165
|
+
* // ],
|
|
166
|
+
* // RecipeReference: { // RecipeReference
|
|
167
|
+
* // Name: "STRING_VALUE", // required
|
|
168
|
+
* // RecipeVersion: "STRING_VALUE",
|
|
169
|
+
* // },
|
|
170
|
+
* // StartedBy: "STRING_VALUE",
|
|
171
|
+
* // StartedOn: new Date("TIMESTAMP"),
|
|
172
|
+
* // JobSample: { // JobSample
|
|
173
|
+
* // Mode: "FULL_DATASET" || "CUSTOM_ROWS",
|
|
174
|
+
* // Size: Number("long"),
|
|
175
|
+
* // },
|
|
176
|
+
* // };
|
|
177
|
+
*
|
|
35
178
|
* ```
|
|
36
179
|
*
|
|
37
180
|
* @param DescribeJobRunCommandInput - {@link DescribeJobRunCommandInput}
|
|
@@ -46,6 +189,8 @@ export interface DescribeJobRunCommandOutput extends DescribeJobRunResponse, __M
|
|
|
46
189
|
* @throws {@link ValidationException} (client fault)
|
|
47
190
|
* <p>The input parameters for this request failed validation.</p>
|
|
48
191
|
*
|
|
192
|
+
* @throws {@link DataBrewServiceException}
|
|
193
|
+
* <p>Base exception class for all service exceptions from DataBrew service.</p>
|
|
49
194
|
*
|
|
50
195
|
*/
|
|
51
196
|
export declare class DescribeJobRunCommand extends $Command<DescribeJobRunCommandInput, DescribeJobRunCommandOutput, DataBrewClientResolvedConfig> {
|
|
@@ -31,6 +31,28 @@ export interface DescribeProjectCommandOutput extends DescribeProjectResponse, _
|
|
|
31
31
|
* };
|
|
32
32
|
* const command = new DescribeProjectCommand(input);
|
|
33
33
|
* const response = await client.send(command);
|
|
34
|
+
* // { // DescribeProjectResponse
|
|
35
|
+
* // CreateDate: new Date("TIMESTAMP"),
|
|
36
|
+
* // CreatedBy: "STRING_VALUE",
|
|
37
|
+
* // DatasetName: "STRING_VALUE",
|
|
38
|
+
* // LastModifiedDate: new Date("TIMESTAMP"),
|
|
39
|
+
* // LastModifiedBy: "STRING_VALUE",
|
|
40
|
+
* // Name: "STRING_VALUE", // required
|
|
41
|
+
* // RecipeName: "STRING_VALUE",
|
|
42
|
+
* // ResourceArn: "STRING_VALUE",
|
|
43
|
+
* // Sample: { // Sample
|
|
44
|
+
* // Size: Number("int"),
|
|
45
|
+
* // Type: "FIRST_N" || "LAST_N" || "RANDOM", // required
|
|
46
|
+
* // },
|
|
47
|
+
* // RoleArn: "STRING_VALUE",
|
|
48
|
+
* // Tags: { // TagMap
|
|
49
|
+
* // "<keys>": "STRING_VALUE",
|
|
50
|
+
* // },
|
|
51
|
+
* // SessionStatus: "ASSIGNED" || "FAILED" || "INITIALIZING" || "PROVISIONING" || "READY" || "RECYCLING" || "ROTATING" || "TERMINATED" || "TERMINATING" || "UPDATING",
|
|
52
|
+
* // OpenedBy: "STRING_VALUE",
|
|
53
|
+
* // OpenDate: new Date("TIMESTAMP"),
|
|
54
|
+
* // };
|
|
55
|
+
*
|
|
34
56
|
* ```
|
|
35
57
|
*
|
|
36
58
|
* @param DescribeProjectCommandInput - {@link DescribeProjectCommandInput}
|
|
@@ -45,6 +67,8 @@ export interface DescribeProjectCommandOutput extends DescribeProjectResponse, _
|
|
|
45
67
|
* @throws {@link ValidationException} (client fault)
|
|
46
68
|
* <p>The input parameters for this request failed validation.</p>
|
|
47
69
|
*
|
|
70
|
+
* @throws {@link DataBrewServiceException}
|
|
71
|
+
* <p>Base exception class for all service exceptions from DataBrew service.</p>
|
|
48
72
|
*
|
|
49
73
|
*/
|
|
50
74
|
export declare class DescribeProjectCommand extends $Command<DescribeProjectCommandInput, DescribeProjectCommandOutput, DataBrewClientResolvedConfig> {
|
|
@@ -33,6 +33,40 @@ export interface DescribeRecipeCommandOutput extends DescribeRecipeResponse, __M
|
|
|
33
33
|
* };
|
|
34
34
|
* const command = new DescribeRecipeCommand(input);
|
|
35
35
|
* const response = await client.send(command);
|
|
36
|
+
* // { // DescribeRecipeResponse
|
|
37
|
+
* // CreatedBy: "STRING_VALUE",
|
|
38
|
+
* // CreateDate: new Date("TIMESTAMP"),
|
|
39
|
+
* // LastModifiedBy: "STRING_VALUE",
|
|
40
|
+
* // LastModifiedDate: new Date("TIMESTAMP"),
|
|
41
|
+
* // ProjectName: "STRING_VALUE",
|
|
42
|
+
* // PublishedBy: "STRING_VALUE",
|
|
43
|
+
* // PublishedDate: new Date("TIMESTAMP"),
|
|
44
|
+
* // Description: "STRING_VALUE",
|
|
45
|
+
* // Name: "STRING_VALUE", // required
|
|
46
|
+
* // Steps: [ // RecipeStepList
|
|
47
|
+
* // { // RecipeStep
|
|
48
|
+
* // Action: { // RecipeAction
|
|
49
|
+
* // Operation: "STRING_VALUE", // required
|
|
50
|
+
* // Parameters: { // ParameterMap
|
|
51
|
+
* // "<keys>": "STRING_VALUE",
|
|
52
|
+
* // },
|
|
53
|
+
* // },
|
|
54
|
+
* // ConditionExpressions: [ // ConditionExpressionList
|
|
55
|
+
* // { // ConditionExpression
|
|
56
|
+
* // Condition: "STRING_VALUE", // required
|
|
57
|
+
* // Value: "STRING_VALUE",
|
|
58
|
+
* // TargetColumn: "STRING_VALUE", // required
|
|
59
|
+
* // },
|
|
60
|
+
* // ],
|
|
61
|
+
* // },
|
|
62
|
+
* // ],
|
|
63
|
+
* // Tags: { // TagMap
|
|
64
|
+
* // "<keys>": "STRING_VALUE",
|
|
65
|
+
* // },
|
|
66
|
+
* // ResourceArn: "STRING_VALUE",
|
|
67
|
+
* // RecipeVersion: "STRING_VALUE",
|
|
68
|
+
* // };
|
|
69
|
+
*
|
|
36
70
|
* ```
|
|
37
71
|
*
|
|
38
72
|
* @param DescribeRecipeCommandInput - {@link DescribeRecipeCommandInput}
|
|
@@ -47,6 +81,8 @@ export interface DescribeRecipeCommandOutput extends DescribeRecipeResponse, __M
|
|
|
47
81
|
* @throws {@link ValidationException} (client fault)
|
|
48
82
|
* <p>The input parameters for this request failed validation.</p>
|
|
49
83
|
*
|
|
84
|
+
* @throws {@link DataBrewServiceException}
|
|
85
|
+
* <p>Base exception class for all service exceptions from DataBrew service.</p>
|
|
50
86
|
*
|
|
51
87
|
*/
|
|
52
88
|
export declare class DescribeRecipeCommand extends $Command<DescribeRecipeCommandInput, DescribeRecipeCommandOutput, DataBrewClientResolvedConfig> {
|
|
@@ -31,6 +31,41 @@ export interface DescribeRulesetCommandOutput extends DescribeRulesetResponse, _
|
|
|
31
31
|
* };
|
|
32
32
|
* const command = new DescribeRulesetCommand(input);
|
|
33
33
|
* const response = await client.send(command);
|
|
34
|
+
* // { // DescribeRulesetResponse
|
|
35
|
+
* // Name: "STRING_VALUE", // required
|
|
36
|
+
* // Description: "STRING_VALUE",
|
|
37
|
+
* // TargetArn: "STRING_VALUE",
|
|
38
|
+
* // Rules: [ // RuleList
|
|
39
|
+
* // { // Rule
|
|
40
|
+
* // Name: "STRING_VALUE", // required
|
|
41
|
+
* // Disabled: true || false,
|
|
42
|
+
* // CheckExpression: "STRING_VALUE", // required
|
|
43
|
+
* // SubstitutionMap: { // ValuesMap
|
|
44
|
+
* // "<keys>": "STRING_VALUE",
|
|
45
|
+
* // },
|
|
46
|
+
* // Threshold: { // Threshold
|
|
47
|
+
* // Value: Number("double"), // required
|
|
48
|
+
* // Type: "GREATER_THAN_OR_EQUAL" || "LESS_THAN_OR_EQUAL" || "GREATER_THAN" || "LESS_THAN",
|
|
49
|
+
* // Unit: "COUNT" || "PERCENTAGE",
|
|
50
|
+
* // },
|
|
51
|
+
* // ColumnSelectors: [ // ColumnSelectorList
|
|
52
|
+
* // { // ColumnSelector
|
|
53
|
+
* // Regex: "STRING_VALUE",
|
|
54
|
+
* // Name: "STRING_VALUE",
|
|
55
|
+
* // },
|
|
56
|
+
* // ],
|
|
57
|
+
* // },
|
|
58
|
+
* // ],
|
|
59
|
+
* // CreateDate: new Date("TIMESTAMP"),
|
|
60
|
+
* // CreatedBy: "STRING_VALUE",
|
|
61
|
+
* // LastModifiedBy: "STRING_VALUE",
|
|
62
|
+
* // LastModifiedDate: new Date("TIMESTAMP"),
|
|
63
|
+
* // ResourceArn: "STRING_VALUE",
|
|
64
|
+
* // Tags: { // TagMap
|
|
65
|
+
* // "<keys>": "STRING_VALUE",
|
|
66
|
+
* // },
|
|
67
|
+
* // };
|
|
68
|
+
*
|
|
34
69
|
* ```
|
|
35
70
|
*
|
|
36
71
|
* @param DescribeRulesetCommandInput - {@link DescribeRulesetCommandInput}
|
|
@@ -45,6 +80,8 @@ export interface DescribeRulesetCommandOutput extends DescribeRulesetResponse, _
|
|
|
45
80
|
* @throws {@link ValidationException} (client fault)
|
|
46
81
|
* <p>The input parameters for this request failed validation.</p>
|
|
47
82
|
*
|
|
83
|
+
* @throws {@link DataBrewServiceException}
|
|
84
|
+
* <p>Base exception class for all service exceptions from DataBrew service.</p>
|
|
48
85
|
*
|
|
49
86
|
*/
|
|
50
87
|
export declare class DescribeRulesetCommand extends $Command<DescribeRulesetCommandInput, DescribeRulesetCommandOutput, DataBrewClientResolvedConfig> {
|
|
@@ -31,6 +31,22 @@ export interface DescribeScheduleCommandOutput extends DescribeScheduleResponse,
|
|
|
31
31
|
* };
|
|
32
32
|
* const command = new DescribeScheduleCommand(input);
|
|
33
33
|
* const response = await client.send(command);
|
|
34
|
+
* // { // DescribeScheduleResponse
|
|
35
|
+
* // CreateDate: new Date("TIMESTAMP"),
|
|
36
|
+
* // CreatedBy: "STRING_VALUE",
|
|
37
|
+
* // JobNames: [ // JobNameList
|
|
38
|
+
* // "STRING_VALUE",
|
|
39
|
+
* // ],
|
|
40
|
+
* // LastModifiedBy: "STRING_VALUE",
|
|
41
|
+
* // LastModifiedDate: new Date("TIMESTAMP"),
|
|
42
|
+
* // ResourceArn: "STRING_VALUE",
|
|
43
|
+
* // CronExpression: "STRING_VALUE",
|
|
44
|
+
* // Tags: { // TagMap
|
|
45
|
+
* // "<keys>": "STRING_VALUE",
|
|
46
|
+
* // },
|
|
47
|
+
* // Name: "STRING_VALUE", // required
|
|
48
|
+
* // };
|
|
49
|
+
*
|
|
34
50
|
* ```
|
|
35
51
|
*
|
|
36
52
|
* @param DescribeScheduleCommandInput - {@link DescribeScheduleCommandInput}
|
|
@@ -45,6 +61,8 @@ export interface DescribeScheduleCommandOutput extends DescribeScheduleResponse,
|
|
|
45
61
|
* @throws {@link ValidationException} (client fault)
|
|
46
62
|
* <p>The input parameters for this request failed validation.</p>
|
|
47
63
|
*
|
|
64
|
+
* @throws {@link DataBrewServiceException}
|
|
65
|
+
* <p>Base exception class for all service exceptions from DataBrew service.</p>
|
|
48
66
|
*
|
|
49
67
|
*/
|
|
50
68
|
export declare class DescribeScheduleCommand extends $Command<DescribeScheduleCommandInput, DescribeScheduleCommandOutput, DataBrewClientResolvedConfig> {
|
|
@@ -32,6 +32,105 @@ export interface ListDatasetsCommandOutput extends ListDatasetsResponse, __Metad
|
|
|
32
32
|
* };
|
|
33
33
|
* const command = new ListDatasetsCommand(input);
|
|
34
34
|
* const response = await client.send(command);
|
|
35
|
+
* // { // ListDatasetsResponse
|
|
36
|
+
* // Datasets: [ // DatasetList // required
|
|
37
|
+
* // { // Dataset
|
|
38
|
+
* // AccountId: "STRING_VALUE",
|
|
39
|
+
* // CreatedBy: "STRING_VALUE",
|
|
40
|
+
* // CreateDate: new Date("TIMESTAMP"),
|
|
41
|
+
* // Name: "STRING_VALUE", // required
|
|
42
|
+
* // Format: "CSV" || "JSON" || "PARQUET" || "EXCEL" || "ORC",
|
|
43
|
+
* // FormatOptions: { // FormatOptions
|
|
44
|
+
* // Json: { // JsonOptions
|
|
45
|
+
* // MultiLine: true || false,
|
|
46
|
+
* // },
|
|
47
|
+
* // Excel: { // ExcelOptions
|
|
48
|
+
* // SheetNames: [ // SheetNameList
|
|
49
|
+
* // "STRING_VALUE",
|
|
50
|
+
* // ],
|
|
51
|
+
* // SheetIndexes: [ // SheetIndexList
|
|
52
|
+
* // Number("int"),
|
|
53
|
+
* // ],
|
|
54
|
+
* // HeaderRow: true || false,
|
|
55
|
+
* // },
|
|
56
|
+
* // Csv: { // CsvOptions
|
|
57
|
+
* // Delimiter: "STRING_VALUE",
|
|
58
|
+
* // HeaderRow: true || false,
|
|
59
|
+
* // },
|
|
60
|
+
* // },
|
|
61
|
+
* // Input: { // Input
|
|
62
|
+
* // S3InputDefinition: { // S3Location
|
|
63
|
+
* // Bucket: "STRING_VALUE", // required
|
|
64
|
+
* // Key: "STRING_VALUE",
|
|
65
|
+
* // BucketOwner: "STRING_VALUE",
|
|
66
|
+
* // },
|
|
67
|
+
* // DataCatalogInputDefinition: { // DataCatalogInputDefinition
|
|
68
|
+
* // CatalogId: "STRING_VALUE",
|
|
69
|
+
* // DatabaseName: "STRING_VALUE", // required
|
|
70
|
+
* // TableName: "STRING_VALUE", // required
|
|
71
|
+
* // TempDirectory: {
|
|
72
|
+
* // Bucket: "STRING_VALUE", // required
|
|
73
|
+
* // Key: "STRING_VALUE",
|
|
74
|
+
* // BucketOwner: "STRING_VALUE",
|
|
75
|
+
* // },
|
|
76
|
+
* // },
|
|
77
|
+
* // DatabaseInputDefinition: { // DatabaseInputDefinition
|
|
78
|
+
* // GlueConnectionName: "STRING_VALUE", // required
|
|
79
|
+
* // DatabaseTableName: "STRING_VALUE",
|
|
80
|
+
* // TempDirectory: {
|
|
81
|
+
* // Bucket: "STRING_VALUE", // required
|
|
82
|
+
* // Key: "STRING_VALUE",
|
|
83
|
+
* // BucketOwner: "STRING_VALUE",
|
|
84
|
+
* // },
|
|
85
|
+
* // QueryString: "STRING_VALUE",
|
|
86
|
+
* // },
|
|
87
|
+
* // Metadata: { // Metadata
|
|
88
|
+
* // SourceArn: "STRING_VALUE",
|
|
89
|
+
* // },
|
|
90
|
+
* // },
|
|
91
|
+
* // LastModifiedDate: new Date("TIMESTAMP"),
|
|
92
|
+
* // LastModifiedBy: "STRING_VALUE",
|
|
93
|
+
* // Source: "S3" || "DATA-CATALOG" || "DATABASE",
|
|
94
|
+
* // PathOptions: { // PathOptions
|
|
95
|
+
* // LastModifiedDateCondition: { // FilterExpression
|
|
96
|
+
* // Expression: "STRING_VALUE", // required
|
|
97
|
+
* // ValuesMap: { // ValuesMap // required
|
|
98
|
+
* // "<keys>": "STRING_VALUE",
|
|
99
|
+
* // },
|
|
100
|
+
* // },
|
|
101
|
+
* // FilesLimit: { // FilesLimit
|
|
102
|
+
* // MaxFiles: Number("int"), // required
|
|
103
|
+
* // OrderedBy: "LAST_MODIFIED_DATE",
|
|
104
|
+
* // Order: "DESCENDING" || "ASCENDING",
|
|
105
|
+
* // },
|
|
106
|
+
* // Parameters: { // PathParametersMap
|
|
107
|
+
* // "<keys>": { // DatasetParameter
|
|
108
|
+
* // Name: "STRING_VALUE", // required
|
|
109
|
+
* // Type: "Datetime" || "Number" || "String", // required
|
|
110
|
+
* // DatetimeOptions: { // DatetimeOptions
|
|
111
|
+
* // Format: "STRING_VALUE", // required
|
|
112
|
+
* // TimezoneOffset: "STRING_VALUE",
|
|
113
|
+
* // LocaleCode: "STRING_VALUE",
|
|
114
|
+
* // },
|
|
115
|
+
* // CreateColumn: true || false,
|
|
116
|
+
* // Filter: {
|
|
117
|
+
* // Expression: "STRING_VALUE", // required
|
|
118
|
+
* // ValuesMap: { // required
|
|
119
|
+
* // "<keys>": "STRING_VALUE",
|
|
120
|
+
* // },
|
|
121
|
+
* // },
|
|
122
|
+
* // },
|
|
123
|
+
* // },
|
|
124
|
+
* // },
|
|
125
|
+
* // Tags: { // TagMap
|
|
126
|
+
* // "<keys>": "STRING_VALUE",
|
|
127
|
+
* // },
|
|
128
|
+
* // ResourceArn: "STRING_VALUE",
|
|
129
|
+
* // },
|
|
130
|
+
* // ],
|
|
131
|
+
* // NextToken: "STRING_VALUE",
|
|
132
|
+
* // };
|
|
133
|
+
*
|
|
35
134
|
* ```
|
|
36
135
|
*
|
|
37
136
|
* @param ListDatasetsCommandInput - {@link ListDatasetsCommandInput}
|
|
@@ -43,6 +142,8 @@ export interface ListDatasetsCommandOutput extends ListDatasetsResponse, __Metad
|
|
|
43
142
|
* @throws {@link ValidationException} (client fault)
|
|
44
143
|
* <p>The input parameters for this request failed validation.</p>
|
|
45
144
|
*
|
|
145
|
+
* @throws {@link DataBrewServiceException}
|
|
146
|
+
* <p>Base exception class for all service exceptions from DataBrew service.</p>
|
|
46
147
|
*
|
|
47
148
|
*/
|
|
48
149
|
export declare class ListDatasetsCommand extends $Command<ListDatasetsCommandInput, ListDatasetsCommandOutput, DataBrewClientResolvedConfig> {
|
|
@@ -33,6 +33,98 @@ export interface ListJobRunsCommandOutput extends ListJobRunsResponse, __Metadat
|
|
|
33
33
|
* };
|
|
34
34
|
* const command = new ListJobRunsCommand(input);
|
|
35
35
|
* const response = await client.send(command);
|
|
36
|
+
* // { // ListJobRunsResponse
|
|
37
|
+
* // JobRuns: [ // JobRunList // required
|
|
38
|
+
* // { // JobRun
|
|
39
|
+
* // Attempt: Number("int"),
|
|
40
|
+
* // CompletedOn: new Date("TIMESTAMP"),
|
|
41
|
+
* // DatasetName: "STRING_VALUE",
|
|
42
|
+
* // ErrorMessage: "STRING_VALUE",
|
|
43
|
+
* // ExecutionTime: Number("int"),
|
|
44
|
+
* // JobName: "STRING_VALUE",
|
|
45
|
+
* // RunId: "STRING_VALUE",
|
|
46
|
+
* // State: "STARTING" || "RUNNING" || "STOPPING" || "STOPPED" || "SUCCEEDED" || "FAILED" || "TIMEOUT",
|
|
47
|
+
* // LogSubscription: "ENABLE" || "DISABLE",
|
|
48
|
+
* // LogGroupName: "STRING_VALUE",
|
|
49
|
+
* // Outputs: [ // OutputList
|
|
50
|
+
* // { // Output
|
|
51
|
+
* // CompressionFormat: "GZIP" || "LZ4" || "SNAPPY" || "BZIP2" || "DEFLATE" || "LZO" || "BROTLI" || "ZSTD" || "ZLIB",
|
|
52
|
+
* // Format: "CSV" || "JSON" || "PARQUET" || "GLUEPARQUET" || "AVRO" || "ORC" || "XML" || "TABLEAUHYPER",
|
|
53
|
+
* // PartitionColumns: [ // ColumnNameList
|
|
54
|
+
* // "STRING_VALUE",
|
|
55
|
+
* // ],
|
|
56
|
+
* // Location: { // S3Location
|
|
57
|
+
* // Bucket: "STRING_VALUE", // required
|
|
58
|
+
* // Key: "STRING_VALUE",
|
|
59
|
+
* // BucketOwner: "STRING_VALUE",
|
|
60
|
+
* // },
|
|
61
|
+
* // Overwrite: true || false,
|
|
62
|
+
* // FormatOptions: { // OutputFormatOptions
|
|
63
|
+
* // Csv: { // CsvOutputOptions
|
|
64
|
+
* // Delimiter: "STRING_VALUE",
|
|
65
|
+
* // },
|
|
66
|
+
* // },
|
|
67
|
+
* // MaxOutputFiles: Number("int"),
|
|
68
|
+
* // },
|
|
69
|
+
* // ],
|
|
70
|
+
* // DataCatalogOutputs: [ // DataCatalogOutputList
|
|
71
|
+
* // { // DataCatalogOutput
|
|
72
|
+
* // CatalogId: "STRING_VALUE",
|
|
73
|
+
* // DatabaseName: "STRING_VALUE", // required
|
|
74
|
+
* // TableName: "STRING_VALUE", // required
|
|
75
|
+
* // S3Options: { // S3TableOutputOptions
|
|
76
|
+
* // Location: {
|
|
77
|
+
* // Bucket: "STRING_VALUE", // required
|
|
78
|
+
* // Key: "STRING_VALUE",
|
|
79
|
+
* // BucketOwner: "STRING_VALUE",
|
|
80
|
+
* // },
|
|
81
|
+
* // },
|
|
82
|
+
* // DatabaseOptions: { // DatabaseTableOutputOptions
|
|
83
|
+
* // TempDirectory: {
|
|
84
|
+
* // Bucket: "STRING_VALUE", // required
|
|
85
|
+
* // Key: "STRING_VALUE",
|
|
86
|
+
* // BucketOwner: "STRING_VALUE",
|
|
87
|
+
* // },
|
|
88
|
+
* // TableName: "STRING_VALUE", // required
|
|
89
|
+
* // },
|
|
90
|
+
* // Overwrite: true || false,
|
|
91
|
+
* // },
|
|
92
|
+
* // ],
|
|
93
|
+
* // DatabaseOutputs: [ // DatabaseOutputList
|
|
94
|
+
* // { // DatabaseOutput
|
|
95
|
+
* // GlueConnectionName: "STRING_VALUE", // required
|
|
96
|
+
* // DatabaseOptions: {
|
|
97
|
+
* // TempDirectory: {
|
|
98
|
+
* // Bucket: "STRING_VALUE", // required
|
|
99
|
+
* // Key: "STRING_VALUE",
|
|
100
|
+
* // BucketOwner: "STRING_VALUE",
|
|
101
|
+
* // },
|
|
102
|
+
* // TableName: "STRING_VALUE", // required
|
|
103
|
+
* // },
|
|
104
|
+
* // DatabaseOutputMode: "NEW_TABLE",
|
|
105
|
+
* // },
|
|
106
|
+
* // ],
|
|
107
|
+
* // RecipeReference: { // RecipeReference
|
|
108
|
+
* // Name: "STRING_VALUE", // required
|
|
109
|
+
* // RecipeVersion: "STRING_VALUE",
|
|
110
|
+
* // },
|
|
111
|
+
* // StartedBy: "STRING_VALUE",
|
|
112
|
+
* // StartedOn: new Date("TIMESTAMP"),
|
|
113
|
+
* // JobSample: { // JobSample
|
|
114
|
+
* // Mode: "FULL_DATASET" || "CUSTOM_ROWS",
|
|
115
|
+
* // Size: Number("long"),
|
|
116
|
+
* // },
|
|
117
|
+
* // ValidationConfigurations: [ // ValidationConfigurationList
|
|
118
|
+
* // { // ValidationConfiguration
|
|
119
|
+
* // RulesetArn: "STRING_VALUE", // required
|
|
120
|
+
* // ValidationMode: "CHECK_ALL",
|
|
121
|
+
* // },
|
|
122
|
+
* // ],
|
|
123
|
+
* // },
|
|
124
|
+
* // ],
|
|
125
|
+
* // NextToken: "STRING_VALUE",
|
|
126
|
+
* // };
|
|
127
|
+
*
|
|
36
128
|
* ```
|
|
37
129
|
*
|
|
38
130
|
* @param ListJobRunsCommandInput - {@link ListJobRunsCommandInput}
|
|
@@ -47,6 +139,8 @@ export interface ListJobRunsCommandOutput extends ListJobRunsResponse, __Metadat
|
|
|
47
139
|
* @throws {@link ValidationException} (client fault)
|
|
48
140
|
* <p>The input parameters for this request failed validation.</p>
|
|
49
141
|
*
|
|
142
|
+
* @throws {@link DataBrewServiceException}
|
|
143
|
+
* <p>Base exception class for all service exceptions from DataBrew service.</p>
|
|
50
144
|
*
|
|
51
145
|
*/
|
|
52
146
|
export declare class ListJobRunsCommand extends $Command<ListJobRunsCommandInput, ListJobRunsCommandOutput, DataBrewClientResolvedConfig> {
|
|
@@ -34,6 +34,106 @@ export interface ListJobsCommandOutput extends ListJobsResponse, __MetadataBeare
|
|
|
34
34
|
* };
|
|
35
35
|
* const command = new ListJobsCommand(input);
|
|
36
36
|
* const response = await client.send(command);
|
|
37
|
+
* // { // ListJobsResponse
|
|
38
|
+
* // Jobs: [ // JobList // required
|
|
39
|
+
* // { // Job
|
|
40
|
+
* // AccountId: "STRING_VALUE",
|
|
41
|
+
* // CreatedBy: "STRING_VALUE",
|
|
42
|
+
* // CreateDate: new Date("TIMESTAMP"),
|
|
43
|
+
* // DatasetName: "STRING_VALUE",
|
|
44
|
+
* // EncryptionKeyArn: "STRING_VALUE",
|
|
45
|
+
* // EncryptionMode: "SSE-KMS" || "SSE-S3",
|
|
46
|
+
* // Name: "STRING_VALUE", // required
|
|
47
|
+
* // Type: "PROFILE" || "RECIPE",
|
|
48
|
+
* // LastModifiedBy: "STRING_VALUE",
|
|
49
|
+
* // LastModifiedDate: new Date("TIMESTAMP"),
|
|
50
|
+
* // LogSubscription: "ENABLE" || "DISABLE",
|
|
51
|
+
* // MaxCapacity: Number("int"),
|
|
52
|
+
* // MaxRetries: Number("int"),
|
|
53
|
+
* // Outputs: [ // OutputList
|
|
54
|
+
* // { // Output
|
|
55
|
+
* // CompressionFormat: "GZIP" || "LZ4" || "SNAPPY" || "BZIP2" || "DEFLATE" || "LZO" || "BROTLI" || "ZSTD" || "ZLIB",
|
|
56
|
+
* // Format: "CSV" || "JSON" || "PARQUET" || "GLUEPARQUET" || "AVRO" || "ORC" || "XML" || "TABLEAUHYPER",
|
|
57
|
+
* // PartitionColumns: [ // ColumnNameList
|
|
58
|
+
* // "STRING_VALUE",
|
|
59
|
+
* // ],
|
|
60
|
+
* // Location: { // S3Location
|
|
61
|
+
* // Bucket: "STRING_VALUE", // required
|
|
62
|
+
* // Key: "STRING_VALUE",
|
|
63
|
+
* // BucketOwner: "STRING_VALUE",
|
|
64
|
+
* // },
|
|
65
|
+
* // Overwrite: true || false,
|
|
66
|
+
* // FormatOptions: { // OutputFormatOptions
|
|
67
|
+
* // Csv: { // CsvOutputOptions
|
|
68
|
+
* // Delimiter: "STRING_VALUE",
|
|
69
|
+
* // },
|
|
70
|
+
* // },
|
|
71
|
+
* // MaxOutputFiles: Number("int"),
|
|
72
|
+
* // },
|
|
73
|
+
* // ],
|
|
74
|
+
* // DataCatalogOutputs: [ // DataCatalogOutputList
|
|
75
|
+
* // { // DataCatalogOutput
|
|
76
|
+
* // CatalogId: "STRING_VALUE",
|
|
77
|
+
* // DatabaseName: "STRING_VALUE", // required
|
|
78
|
+
* // TableName: "STRING_VALUE", // required
|
|
79
|
+
* // S3Options: { // S3TableOutputOptions
|
|
80
|
+
* // Location: {
|
|
81
|
+
* // Bucket: "STRING_VALUE", // required
|
|
82
|
+
* // Key: "STRING_VALUE",
|
|
83
|
+
* // BucketOwner: "STRING_VALUE",
|
|
84
|
+
* // },
|
|
85
|
+
* // },
|
|
86
|
+
* // DatabaseOptions: { // DatabaseTableOutputOptions
|
|
87
|
+
* // TempDirectory: {
|
|
88
|
+
* // Bucket: "STRING_VALUE", // required
|
|
89
|
+
* // Key: "STRING_VALUE",
|
|
90
|
+
* // BucketOwner: "STRING_VALUE",
|
|
91
|
+
* // },
|
|
92
|
+
* // TableName: "STRING_VALUE", // required
|
|
93
|
+
* // },
|
|
94
|
+
* // Overwrite: true || false,
|
|
95
|
+
* // },
|
|
96
|
+
* // ],
|
|
97
|
+
* // DatabaseOutputs: [ // DatabaseOutputList
|
|
98
|
+
* // { // DatabaseOutput
|
|
99
|
+
* // GlueConnectionName: "STRING_VALUE", // required
|
|
100
|
+
* // DatabaseOptions: {
|
|
101
|
+
* // TempDirectory: {
|
|
102
|
+
* // Bucket: "STRING_VALUE", // required
|
|
103
|
+
* // Key: "STRING_VALUE",
|
|
104
|
+
* // BucketOwner: "STRING_VALUE",
|
|
105
|
+
* // },
|
|
106
|
+
* // TableName: "STRING_VALUE", // required
|
|
107
|
+
* // },
|
|
108
|
+
* // DatabaseOutputMode: "NEW_TABLE",
|
|
109
|
+
* // },
|
|
110
|
+
* // ],
|
|
111
|
+
* // ProjectName: "STRING_VALUE",
|
|
112
|
+
* // RecipeReference: { // RecipeReference
|
|
113
|
+
* // Name: "STRING_VALUE", // required
|
|
114
|
+
* // RecipeVersion: "STRING_VALUE",
|
|
115
|
+
* // },
|
|
116
|
+
* // ResourceArn: "STRING_VALUE",
|
|
117
|
+
* // RoleArn: "STRING_VALUE",
|
|
118
|
+
* // Timeout: Number("int"),
|
|
119
|
+
* // Tags: { // TagMap
|
|
120
|
+
* // "<keys>": "STRING_VALUE",
|
|
121
|
+
* // },
|
|
122
|
+
* // JobSample: { // JobSample
|
|
123
|
+
* // Mode: "FULL_DATASET" || "CUSTOM_ROWS",
|
|
124
|
+
* // Size: Number("long"),
|
|
125
|
+
* // },
|
|
126
|
+
* // ValidationConfigurations: [ // ValidationConfigurationList
|
|
127
|
+
* // { // ValidationConfiguration
|
|
128
|
+
* // RulesetArn: "STRING_VALUE", // required
|
|
129
|
+
* // ValidationMode: "CHECK_ALL",
|
|
130
|
+
* // },
|
|
131
|
+
* // ],
|
|
132
|
+
* // },
|
|
133
|
+
* // ],
|
|
134
|
+
* // NextToken: "STRING_VALUE",
|
|
135
|
+
* // };
|
|
136
|
+
*
|
|
37
137
|
* ```
|
|
38
138
|
*
|
|
39
139
|
* @param ListJobsCommandInput - {@link ListJobsCommandInput}
|
|
@@ -45,6 +145,8 @@ export interface ListJobsCommandOutput extends ListJobsResponse, __MetadataBeare
|
|
|
45
145
|
* @throws {@link ValidationException} (client fault)
|
|
46
146
|
* <p>The input parameters for this request failed validation.</p>
|
|
47
147
|
*
|
|
148
|
+
* @throws {@link DataBrewServiceException}
|
|
149
|
+
* <p>Base exception class for all service exceptions from DataBrew service.</p>
|
|
48
150
|
*
|
|
49
151
|
*/
|
|
50
152
|
export declare class ListJobsCommand extends $Command<ListJobsCommandInput, ListJobsCommandOutput, DataBrewClientResolvedConfig> {
|