@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.
Files changed (45) hide show
  1. package/dist-types/commands/BatchDeleteRecipeVersionCommand.d.ts +13 -0
  2. package/dist-types/commands/CreateDatasetCommand.d.ts +6 -0
  3. package/dist-types/commands/CreateProfileJobCommand.d.ts +6 -0
  4. package/dist-types/commands/CreateProjectCommand.d.ts +6 -0
  5. package/dist-types/commands/CreateRecipeCommand.d.ts +6 -0
  6. package/dist-types/commands/CreateRecipeJobCommand.d.ts +6 -0
  7. package/dist-types/commands/CreateRulesetCommand.d.ts +6 -0
  8. package/dist-types/commands/CreateScheduleCommand.d.ts +6 -0
  9. package/dist-types/commands/DeleteDatasetCommand.d.ts +6 -0
  10. package/dist-types/commands/DeleteJobCommand.d.ts +6 -0
  11. package/dist-types/commands/DeleteProjectCommand.d.ts +6 -0
  12. package/dist-types/commands/DeleteRecipeVersionCommand.d.ts +7 -0
  13. package/dist-types/commands/DeleteRulesetCommand.d.ts +6 -0
  14. package/dist-types/commands/DeleteScheduleCommand.d.ts +6 -0
  15. package/dist-types/commands/DescribeDatasetCommand.d.ts +95 -0
  16. package/dist-types/commands/DescribeJobCommand.d.ts +152 -0
  17. package/dist-types/commands/DescribeJobRunCommand.d.ts +145 -0
  18. package/dist-types/commands/DescribeProjectCommand.d.ts +24 -0
  19. package/dist-types/commands/DescribeRecipeCommand.d.ts +36 -0
  20. package/dist-types/commands/DescribeRulesetCommand.d.ts +37 -0
  21. package/dist-types/commands/DescribeScheduleCommand.d.ts +18 -0
  22. package/dist-types/commands/ListDatasetsCommand.d.ts +101 -0
  23. package/dist-types/commands/ListJobRunsCommand.d.ts +94 -0
  24. package/dist-types/commands/ListJobsCommand.d.ts +102 -0
  25. package/dist-types/commands/ListProjectsCommand.d.ts +29 -0
  26. package/dist-types/commands/ListRecipeVersionsCommand.d.ts +41 -0
  27. package/dist-types/commands/ListRecipesCommand.d.ts +41 -0
  28. package/dist-types/commands/ListRulesetsCommand.d.ts +23 -0
  29. package/dist-types/commands/ListSchedulesCommand.d.ts +24 -0
  30. package/dist-types/commands/ListTagsForResourceCommand.d.ts +8 -0
  31. package/dist-types/commands/PublishRecipeCommand.d.ts +6 -0
  32. package/dist-types/commands/SendProjectSessionActionCommand.d.ts +8 -0
  33. package/dist-types/commands/StartJobRunCommand.d.ts +6 -0
  34. package/dist-types/commands/StartProjectSessionCommand.d.ts +7 -0
  35. package/dist-types/commands/StopJobRunCommand.d.ts +6 -0
  36. package/dist-types/commands/TagResourceCommand.d.ts +4 -0
  37. package/dist-types/commands/UntagResourceCommand.d.ts +4 -0
  38. package/dist-types/commands/UpdateDatasetCommand.d.ts +6 -0
  39. package/dist-types/commands/UpdateProfileJobCommand.d.ts +6 -0
  40. package/dist-types/commands/UpdateProjectCommand.d.ts +7 -0
  41. package/dist-types/commands/UpdateRecipeCommand.d.ts +6 -0
  42. package/dist-types/commands/UpdateRecipeJobCommand.d.ts +6 -0
  43. package/dist-types/commands/UpdateRulesetCommand.d.ts +6 -0
  44. package/dist-types/commands/UpdateScheduleCommand.d.ts +6 -0
  45. package/package.json +3 -3
@@ -72,6 +72,17 @@ export interface BatchDeleteRecipeVersionCommandOutput extends BatchDeleteRecipe
72
72
  * };
73
73
  * const command = new BatchDeleteRecipeVersionCommand(input);
74
74
  * const response = await client.send(command);
75
+ * // { // BatchDeleteRecipeVersionResponse
76
+ * // Name: "STRING_VALUE", // required
77
+ * // Errors: [ // RecipeErrorList
78
+ * // { // RecipeVersionErrorDetail
79
+ * // ErrorCode: "STRING_VALUE",
80
+ * // ErrorMessage: "STRING_VALUE",
81
+ * // RecipeVersion: "STRING_VALUE",
82
+ * // },
83
+ * // ],
84
+ * // };
85
+ *
75
86
  * ```
76
87
  *
77
88
  * @param BatchDeleteRecipeVersionCommandInput - {@link BatchDeleteRecipeVersionCommandInput}
@@ -89,6 +100,8 @@ export interface BatchDeleteRecipeVersionCommandOutput extends BatchDeleteRecipe
89
100
  * @throws {@link ValidationException} (client fault)
90
101
  * <p>The input parameters for this request failed validation.</p>
91
102
  *
103
+ * @throws {@link DataBrewServiceException}
104
+ * <p>Base exception class for all service exceptions from DataBrew service.</p>
92
105
  *
93
106
  */
94
107
  export declare class BatchDeleteRecipeVersionCommand extends $Command<BatchDeleteRecipeVersionCommandInput, BatchDeleteRecipeVersionCommandOutput, DataBrewClientResolvedConfig> {
@@ -114,6 +114,10 @@ export interface CreateDatasetCommandOutput extends CreateDatasetResponse, __Met
114
114
  * };
115
115
  * const command = new CreateDatasetCommand(input);
116
116
  * const response = await client.send(command);
117
+ * // { // CreateDatasetResponse
118
+ * // Name: "STRING_VALUE", // required
119
+ * // };
120
+ *
117
121
  * ```
118
122
  *
119
123
  * @param CreateDatasetCommandInput - {@link CreateDatasetCommandInput}
@@ -134,6 +138,8 @@ export interface CreateDatasetCommandOutput extends CreateDatasetResponse, __Met
134
138
  * @throws {@link ValidationException} (client fault)
135
139
  * <p>The input parameters for this request failed validation.</p>
136
140
  *
141
+ * @throws {@link DataBrewServiceException}
142
+ * <p>Base exception class for all service exceptions from DataBrew service.</p>
137
143
  *
138
144
  */
139
145
  export declare class CreateDatasetCommand extends $Command<CreateDatasetCommandInput, CreateDatasetCommandOutput, DataBrewClientResolvedConfig> {
@@ -113,6 +113,10 @@ export interface CreateProfileJobCommandOutput extends CreateProfileJobResponse,
113
113
  * };
114
114
  * const command = new CreateProfileJobCommand(input);
115
115
  * const response = await client.send(command);
116
+ * // { // CreateProfileJobResponse
117
+ * // Name: "STRING_VALUE", // required
118
+ * // };
119
+ *
116
120
  * ```
117
121
  *
118
122
  * @param CreateProfileJobCommandInput - {@link CreateProfileJobCommandInput}
@@ -136,6 +140,8 @@ export interface CreateProfileJobCommandOutput extends CreateProfileJobResponse,
136
140
  * @throws {@link ValidationException} (client fault)
137
141
  * <p>The input parameters for this request failed validation.</p>
138
142
  *
143
+ * @throws {@link DataBrewServiceException}
144
+ * <p>Base exception class for all service exceptions from DataBrew service.</p>
139
145
  *
140
146
  */
141
147
  export declare class CreateProfileJobCommand extends $Command<CreateProfileJobCommandInput, CreateProfileJobCommandOutput, DataBrewClientResolvedConfig> {
@@ -41,6 +41,10 @@ export interface CreateProjectCommandOutput extends CreateProjectResponse, __Met
41
41
  * };
42
42
  * const command = new CreateProjectCommand(input);
43
43
  * const response = await client.send(command);
44
+ * // { // CreateProjectResponse
45
+ * // Name: "STRING_VALUE", // required
46
+ * // };
47
+ *
44
48
  * ```
45
49
  *
46
50
  * @param CreateProjectCommandInput - {@link CreateProjectCommandInput}
@@ -61,6 +65,8 @@ export interface CreateProjectCommandOutput extends CreateProjectResponse, __Met
61
65
  * @throws {@link ValidationException} (client fault)
62
66
  * <p>The input parameters for this request failed validation.</p>
63
67
  *
68
+ * @throws {@link DataBrewServiceException}
69
+ * <p>Base exception class for all service exceptions from DataBrew service.</p>
64
70
  *
65
71
  */
66
72
  export declare class CreateProjectCommand extends $Command<CreateProjectCommandInput, CreateProjectCommandOutput, DataBrewClientResolvedConfig> {
@@ -52,6 +52,10 @@ export interface CreateRecipeCommandOutput extends CreateRecipeResponse, __Metad
52
52
  * };
53
53
  * const command = new CreateRecipeCommand(input);
54
54
  * const response = await client.send(command);
55
+ * // { // CreateRecipeResponse
56
+ * // Name: "STRING_VALUE", // required
57
+ * // };
58
+ *
55
59
  * ```
56
60
  *
57
61
  * @param CreateRecipeCommandInput - {@link CreateRecipeCommandInput}
@@ -69,6 +73,8 @@ export interface CreateRecipeCommandOutput extends CreateRecipeResponse, __Metad
69
73
  * @throws {@link ValidationException} (client fault)
70
74
  * <p>The input parameters for this request failed validation.</p>
71
75
  *
76
+ * @throws {@link DataBrewServiceException}
77
+ * <p>Base exception class for all service exceptions from DataBrew service.</p>
72
78
  *
73
79
  */
74
80
  export declare class CreateRecipeCommand extends $Command<CreateRecipeCommandInput, CreateRecipeCommandOutput, DataBrewClientResolvedConfig> {
@@ -105,6 +105,10 @@ export interface CreateRecipeJobCommandOutput extends CreateRecipeJobResponse, _
105
105
  * };
106
106
  * const command = new CreateRecipeJobCommand(input);
107
107
  * const response = await client.send(command);
108
+ * // { // CreateRecipeJobResponse
109
+ * // Name: "STRING_VALUE", // required
110
+ * // };
111
+ *
108
112
  * ```
109
113
  *
110
114
  * @param CreateRecipeJobCommandInput - {@link CreateRecipeJobCommandInput}
@@ -128,6 +132,8 @@ export interface CreateRecipeJobCommandOutput extends CreateRecipeJobResponse, _
128
132
  * @throws {@link ValidationException} (client fault)
129
133
  * <p>The input parameters for this request failed validation.</p>
130
134
  *
135
+ * @throws {@link DataBrewServiceException}
136
+ * <p>Base exception class for all service exceptions from DataBrew service.</p>
131
137
  *
132
138
  */
133
139
  export declare class CreateRecipeJobCommand extends $Command<CreateRecipeJobCommandInput, CreateRecipeJobCommandOutput, DataBrewClientResolvedConfig> {
@@ -58,6 +58,10 @@ export interface CreateRulesetCommandOutput extends CreateRulesetResponse, __Met
58
58
  * };
59
59
  * const command = new CreateRulesetCommand(input);
60
60
  * const response = await client.send(command);
61
+ * // { // CreateRulesetResponse
62
+ * // Name: "STRING_VALUE", // required
63
+ * // };
64
+ *
61
65
  * ```
62
66
  *
63
67
  * @param CreateRulesetCommandInput - {@link CreateRulesetCommandInput}
@@ -75,6 +79,8 @@ export interface CreateRulesetCommandOutput extends CreateRulesetResponse, __Met
75
79
  * @throws {@link ValidationException} (client fault)
76
80
  * <p>The input parameters for this request failed validation.</p>
77
81
  *
82
+ * @throws {@link DataBrewServiceException}
83
+ * <p>Base exception class for all service exceptions from DataBrew service.</p>
78
84
  *
79
85
  */
80
86
  export declare class CreateRulesetCommand extends $Command<CreateRulesetCommandInput, CreateRulesetCommandOutput, DataBrewClientResolvedConfig> {
@@ -39,6 +39,10 @@ export interface CreateScheduleCommandOutput extends CreateScheduleResponse, __M
39
39
  * };
40
40
  * const command = new CreateScheduleCommand(input);
41
41
  * const response = await client.send(command);
42
+ * // { // CreateScheduleResponse
43
+ * // Name: "STRING_VALUE", // required
44
+ * // };
45
+ *
42
46
  * ```
43
47
  *
44
48
  * @param CreateScheduleCommandInput - {@link CreateScheduleCommandInput}
@@ -56,6 +60,8 @@ export interface CreateScheduleCommandOutput extends CreateScheduleResponse, __M
56
60
  * @throws {@link ValidationException} (client fault)
57
61
  * <p>The input parameters for this request failed validation.</p>
58
62
  *
63
+ * @throws {@link DataBrewServiceException}
64
+ * <p>Base exception class for all service exceptions from DataBrew service.</p>
59
65
  *
60
66
  */
61
67
  export declare class CreateScheduleCommand extends $Command<CreateScheduleCommandInput, CreateScheduleCommandOutput, DataBrewClientResolvedConfig> {
@@ -31,6 +31,10 @@ export interface DeleteDatasetCommandOutput extends DeleteDatasetResponse, __Met
31
31
  * };
32
32
  * const command = new DeleteDatasetCommand(input);
33
33
  * const response = await client.send(command);
34
+ * // { // DeleteDatasetResponse
35
+ * // Name: "STRING_VALUE", // required
36
+ * // };
37
+ *
34
38
  * ```
35
39
  *
36
40
  * @param DeleteDatasetCommandInput - {@link DeleteDatasetCommandInput}
@@ -48,6 +52,8 @@ export interface DeleteDatasetCommandOutput extends DeleteDatasetResponse, __Met
48
52
  * @throws {@link ValidationException} (client fault)
49
53
  * <p>The input parameters for this request failed validation.</p>
50
54
  *
55
+ * @throws {@link DataBrewServiceException}
56
+ * <p>Base exception class for all service exceptions from DataBrew service.</p>
51
57
  *
52
58
  */
53
59
  export declare class DeleteDatasetCommand extends $Command<DeleteDatasetCommandInput, DeleteDatasetCommandOutput, DataBrewClientResolvedConfig> {
@@ -31,6 +31,10 @@ export interface DeleteJobCommandOutput extends DeleteJobResponse, __MetadataBea
31
31
  * };
32
32
  * const command = new DeleteJobCommand(input);
33
33
  * const response = await client.send(command);
34
+ * // { // DeleteJobResponse
35
+ * // Name: "STRING_VALUE", // required
36
+ * // };
37
+ *
34
38
  * ```
35
39
  *
36
40
  * @param DeleteJobCommandInput - {@link DeleteJobCommandInput}
@@ -48,6 +52,8 @@ export interface DeleteJobCommandOutput extends DeleteJobResponse, __MetadataBea
48
52
  * @throws {@link ValidationException} (client fault)
49
53
  * <p>The input parameters for this request failed validation.</p>
50
54
  *
55
+ * @throws {@link DataBrewServiceException}
56
+ * <p>Base exception class for all service exceptions from DataBrew service.</p>
51
57
  *
52
58
  */
53
59
  export declare class DeleteJobCommand extends $Command<DeleteJobCommandInput, DeleteJobCommandOutput, DataBrewClientResolvedConfig> {
@@ -31,6 +31,10 @@ export interface DeleteProjectCommandOutput extends DeleteProjectResponse, __Met
31
31
  * };
32
32
  * const command = new DeleteProjectCommand(input);
33
33
  * const response = await client.send(command);
34
+ * // { // DeleteProjectResponse
35
+ * // Name: "STRING_VALUE", // required
36
+ * // };
37
+ *
34
38
  * ```
35
39
  *
36
40
  * @param DeleteProjectCommandInput - {@link DeleteProjectCommandInput}
@@ -48,6 +52,8 @@ export interface DeleteProjectCommandOutput extends DeleteProjectResponse, __Met
48
52
  * @throws {@link ValidationException} (client fault)
49
53
  * <p>The input parameters for this request failed validation.</p>
50
54
  *
55
+ * @throws {@link DataBrewServiceException}
56
+ * <p>Base exception class for all service exceptions from DataBrew service.</p>
51
57
  *
52
58
  */
53
59
  export declare class DeleteProjectCommand extends $Command<DeleteProjectCommandInput, DeleteProjectCommandOutput, DataBrewClientResolvedConfig> {
@@ -32,6 +32,11 @@ export interface DeleteRecipeVersionCommandOutput extends DeleteRecipeVersionRes
32
32
  * };
33
33
  * const command = new DeleteRecipeVersionCommand(input);
34
34
  * const response = await client.send(command);
35
+ * // { // DeleteRecipeVersionResponse
36
+ * // Name: "STRING_VALUE", // required
37
+ * // RecipeVersion: "STRING_VALUE", // required
38
+ * // };
39
+ *
35
40
  * ```
36
41
  *
37
42
  * @param DeleteRecipeVersionCommandInput - {@link DeleteRecipeVersionCommandInput}
@@ -49,6 +54,8 @@ export interface DeleteRecipeVersionCommandOutput extends DeleteRecipeVersionRes
49
54
  * @throws {@link ValidationException} (client fault)
50
55
  * <p>The input parameters for this request failed validation.</p>
51
56
  *
57
+ * @throws {@link DataBrewServiceException}
58
+ * <p>Base exception class for all service exceptions from DataBrew service.</p>
52
59
  *
53
60
  */
54
61
  export declare class DeleteRecipeVersionCommand extends $Command<DeleteRecipeVersionCommandInput, DeleteRecipeVersionCommandOutput, DataBrewClientResolvedConfig> {
@@ -31,6 +31,10 @@ export interface DeleteRulesetCommandOutput extends DeleteRulesetResponse, __Met
31
31
  * };
32
32
  * const command = new DeleteRulesetCommand(input);
33
33
  * const response = await client.send(command);
34
+ * // { // DeleteRulesetResponse
35
+ * // Name: "STRING_VALUE", // required
36
+ * // };
37
+ *
34
38
  * ```
35
39
  *
36
40
  * @param DeleteRulesetCommandInput - {@link DeleteRulesetCommandInput}
@@ -48,6 +52,8 @@ export interface DeleteRulesetCommandOutput extends DeleteRulesetResponse, __Met
48
52
  * @throws {@link ValidationException} (client fault)
49
53
  * <p>The input parameters for this request failed validation.</p>
50
54
  *
55
+ * @throws {@link DataBrewServiceException}
56
+ * <p>Base exception class for all service exceptions from DataBrew service.</p>
51
57
  *
52
58
  */
53
59
  export declare class DeleteRulesetCommand extends $Command<DeleteRulesetCommandInput, DeleteRulesetCommandOutput, DataBrewClientResolvedConfig> {
@@ -31,6 +31,10 @@ export interface DeleteScheduleCommandOutput extends DeleteScheduleResponse, __M
31
31
  * };
32
32
  * const command = new DeleteScheduleCommand(input);
33
33
  * const response = await client.send(command);
34
+ * // { // DeleteScheduleResponse
35
+ * // Name: "STRING_VALUE", // required
36
+ * // };
37
+ *
34
38
  * ```
35
39
  *
36
40
  * @param DeleteScheduleCommandInput - {@link DeleteScheduleCommandInput}
@@ -45,6 +49,8 @@ export interface DeleteScheduleCommandOutput extends DeleteScheduleResponse, __M
45
49
  * @throws {@link ValidationException} (client fault)
46
50
  * <p>The input parameters for this request failed validation.</p>
47
51
  *
52
+ * @throws {@link DataBrewServiceException}
53
+ * <p>Base exception class for all service exceptions from DataBrew service.</p>
48
54
  *
49
55
  */
50
56
  export declare class DeleteScheduleCommand extends $Command<DeleteScheduleCommandInput, DeleteScheduleCommandOutput, DataBrewClientResolvedConfig> {
@@ -31,6 +31,99 @@ export interface DescribeDatasetCommandOutput extends DescribeDatasetResponse, _
31
31
  * };
32
32
  * const command = new DescribeDatasetCommand(input);
33
33
  * const response = await client.send(command);
34
+ * // { // DescribeDatasetResponse
35
+ * // CreatedBy: "STRING_VALUE",
36
+ * // CreateDate: new Date("TIMESTAMP"),
37
+ * // Name: "STRING_VALUE", // required
38
+ * // Format: "CSV" || "JSON" || "PARQUET" || "EXCEL" || "ORC",
39
+ * // FormatOptions: { // FormatOptions
40
+ * // Json: { // JsonOptions
41
+ * // MultiLine: true || false,
42
+ * // },
43
+ * // Excel: { // ExcelOptions
44
+ * // SheetNames: [ // SheetNameList
45
+ * // "STRING_VALUE",
46
+ * // ],
47
+ * // SheetIndexes: [ // SheetIndexList
48
+ * // Number("int"),
49
+ * // ],
50
+ * // HeaderRow: true || false,
51
+ * // },
52
+ * // Csv: { // CsvOptions
53
+ * // Delimiter: "STRING_VALUE",
54
+ * // HeaderRow: true || false,
55
+ * // },
56
+ * // },
57
+ * // Input: { // Input
58
+ * // S3InputDefinition: { // S3Location
59
+ * // Bucket: "STRING_VALUE", // required
60
+ * // Key: "STRING_VALUE",
61
+ * // BucketOwner: "STRING_VALUE",
62
+ * // },
63
+ * // DataCatalogInputDefinition: { // DataCatalogInputDefinition
64
+ * // CatalogId: "STRING_VALUE",
65
+ * // DatabaseName: "STRING_VALUE", // required
66
+ * // TableName: "STRING_VALUE", // required
67
+ * // TempDirectory: {
68
+ * // Bucket: "STRING_VALUE", // required
69
+ * // Key: "STRING_VALUE",
70
+ * // BucketOwner: "STRING_VALUE",
71
+ * // },
72
+ * // },
73
+ * // DatabaseInputDefinition: { // DatabaseInputDefinition
74
+ * // GlueConnectionName: "STRING_VALUE", // required
75
+ * // DatabaseTableName: "STRING_VALUE",
76
+ * // TempDirectory: {
77
+ * // Bucket: "STRING_VALUE", // required
78
+ * // Key: "STRING_VALUE",
79
+ * // BucketOwner: "STRING_VALUE",
80
+ * // },
81
+ * // QueryString: "STRING_VALUE",
82
+ * // },
83
+ * // Metadata: { // Metadata
84
+ * // SourceArn: "STRING_VALUE",
85
+ * // },
86
+ * // },
87
+ * // LastModifiedDate: new Date("TIMESTAMP"),
88
+ * // LastModifiedBy: "STRING_VALUE",
89
+ * // Source: "S3" || "DATA-CATALOG" || "DATABASE",
90
+ * // PathOptions: { // PathOptions
91
+ * // LastModifiedDateCondition: { // FilterExpression
92
+ * // Expression: "STRING_VALUE", // required
93
+ * // ValuesMap: { // ValuesMap // required
94
+ * // "<keys>": "STRING_VALUE",
95
+ * // },
96
+ * // },
97
+ * // FilesLimit: { // FilesLimit
98
+ * // MaxFiles: Number("int"), // required
99
+ * // OrderedBy: "LAST_MODIFIED_DATE",
100
+ * // Order: "DESCENDING" || "ASCENDING",
101
+ * // },
102
+ * // Parameters: { // PathParametersMap
103
+ * // "<keys>": { // DatasetParameter
104
+ * // Name: "STRING_VALUE", // required
105
+ * // Type: "Datetime" || "Number" || "String", // required
106
+ * // DatetimeOptions: { // DatetimeOptions
107
+ * // Format: "STRING_VALUE", // required
108
+ * // TimezoneOffset: "STRING_VALUE",
109
+ * // LocaleCode: "STRING_VALUE",
110
+ * // },
111
+ * // CreateColumn: true || false,
112
+ * // Filter: {
113
+ * // Expression: "STRING_VALUE", // required
114
+ * // ValuesMap: { // required
115
+ * // "<keys>": "STRING_VALUE",
116
+ * // },
117
+ * // },
118
+ * // },
119
+ * // },
120
+ * // },
121
+ * // Tags: { // TagMap
122
+ * // "<keys>": "STRING_VALUE",
123
+ * // },
124
+ * // ResourceArn: "STRING_VALUE",
125
+ * // };
126
+ *
34
127
  * ```
35
128
  *
36
129
  * @param DescribeDatasetCommandInput - {@link DescribeDatasetCommandInput}
@@ -45,6 +138,8 @@ export interface DescribeDatasetCommandOutput extends DescribeDatasetResponse, _
45
138
  * @throws {@link ValidationException} (client fault)
46
139
  * <p>The input parameters for this request failed validation.</p>
47
140
  *
141
+ * @throws {@link DataBrewServiceException}
142
+ * <p>Base exception class for all service exceptions from DataBrew service.</p>
48
143
  *
49
144
  */
50
145
  export declare class DescribeDatasetCommand extends $Command<DescribeDatasetCommandInput, DescribeDatasetCommandOutput, DataBrewClientResolvedConfig> {
@@ -31,6 +31,156 @@ export interface DescribeJobCommandOutput extends DescribeJobResponse, __Metadat
31
31
  * };
32
32
  * const command = new DescribeJobCommand(input);
33
33
  * const response = await client.send(command);
34
+ * // { // DescribeJobResponse
35
+ * // CreateDate: new Date("TIMESTAMP"),
36
+ * // CreatedBy: "STRING_VALUE",
37
+ * // DatasetName: "STRING_VALUE",
38
+ * // EncryptionKeyArn: "STRING_VALUE",
39
+ * // EncryptionMode: "SSE-KMS" || "SSE-S3",
40
+ * // Name: "STRING_VALUE", // required
41
+ * // Type: "PROFILE" || "RECIPE",
42
+ * // LastModifiedBy: "STRING_VALUE",
43
+ * // LastModifiedDate: new Date("TIMESTAMP"),
44
+ * // LogSubscription: "ENABLE" || "DISABLE",
45
+ * // MaxCapacity: Number("int"),
46
+ * // MaxRetries: Number("int"),
47
+ * // Outputs: [ // OutputList
48
+ * // { // Output
49
+ * // CompressionFormat: "GZIP" || "LZ4" || "SNAPPY" || "BZIP2" || "DEFLATE" || "LZO" || "BROTLI" || "ZSTD" || "ZLIB",
50
+ * // Format: "CSV" || "JSON" || "PARQUET" || "GLUEPARQUET" || "AVRO" || "ORC" || "XML" || "TABLEAUHYPER",
51
+ * // PartitionColumns: [ // ColumnNameList
52
+ * // "STRING_VALUE",
53
+ * // ],
54
+ * // Location: { // S3Location
55
+ * // Bucket: "STRING_VALUE", // required
56
+ * // Key: "STRING_VALUE",
57
+ * // BucketOwner: "STRING_VALUE",
58
+ * // },
59
+ * // Overwrite: true || false,
60
+ * // FormatOptions: { // OutputFormatOptions
61
+ * // Csv: { // CsvOutputOptions
62
+ * // Delimiter: "STRING_VALUE",
63
+ * // },
64
+ * // },
65
+ * // MaxOutputFiles: Number("int"),
66
+ * // },
67
+ * // ],
68
+ * // DataCatalogOutputs: [ // DataCatalogOutputList
69
+ * // { // DataCatalogOutput
70
+ * // CatalogId: "STRING_VALUE",
71
+ * // DatabaseName: "STRING_VALUE", // required
72
+ * // TableName: "STRING_VALUE", // required
73
+ * // S3Options: { // S3TableOutputOptions
74
+ * // Location: {
75
+ * // Bucket: "STRING_VALUE", // required
76
+ * // Key: "STRING_VALUE",
77
+ * // BucketOwner: "STRING_VALUE",
78
+ * // },
79
+ * // },
80
+ * // DatabaseOptions: { // DatabaseTableOutputOptions
81
+ * // TempDirectory: {
82
+ * // Bucket: "STRING_VALUE", // required
83
+ * // Key: "STRING_VALUE",
84
+ * // BucketOwner: "STRING_VALUE",
85
+ * // },
86
+ * // TableName: "STRING_VALUE", // required
87
+ * // },
88
+ * // Overwrite: true || false,
89
+ * // },
90
+ * // ],
91
+ * // DatabaseOutputs: [ // DatabaseOutputList
92
+ * // { // DatabaseOutput
93
+ * // GlueConnectionName: "STRING_VALUE", // required
94
+ * // DatabaseOptions: {
95
+ * // TempDirectory: {
96
+ * // Bucket: "STRING_VALUE", // required
97
+ * // Key: "STRING_VALUE",
98
+ * // BucketOwner: "STRING_VALUE",
99
+ * // },
100
+ * // TableName: "STRING_VALUE", // required
101
+ * // },
102
+ * // DatabaseOutputMode: "NEW_TABLE",
103
+ * // },
104
+ * // ],
105
+ * // ProjectName: "STRING_VALUE",
106
+ * // ProfileConfiguration: { // ProfileConfiguration
107
+ * // DatasetStatisticsConfiguration: { // StatisticsConfiguration
108
+ * // IncludedStatistics: [ // StatisticList
109
+ * // "STRING_VALUE",
110
+ * // ],
111
+ * // Overrides: [ // StatisticOverrideList
112
+ * // { // StatisticOverride
113
+ * // Statistic: "STRING_VALUE", // required
114
+ * // Parameters: { // ParameterMap // required
115
+ * // "<keys>": "STRING_VALUE",
116
+ * // },
117
+ * // },
118
+ * // ],
119
+ * // },
120
+ * // ProfileColumns: [ // ColumnSelectorList
121
+ * // { // ColumnSelector
122
+ * // Regex: "STRING_VALUE",
123
+ * // Name: "STRING_VALUE",
124
+ * // },
125
+ * // ],
126
+ * // ColumnStatisticsConfigurations: [ // ColumnStatisticsConfigurationList
127
+ * // { // ColumnStatisticsConfiguration
128
+ * // Selectors: [
129
+ * // {
130
+ * // Regex: "STRING_VALUE",
131
+ * // Name: "STRING_VALUE",
132
+ * // },
133
+ * // ],
134
+ * // Statistics: {
135
+ * // IncludedStatistics: [
136
+ * // "STRING_VALUE",
137
+ * // ],
138
+ * // Overrides: [
139
+ * // {
140
+ * // Statistic: "STRING_VALUE", // required
141
+ * // Parameters: { // required
142
+ * // "<keys>": "STRING_VALUE",
143
+ * // },
144
+ * // },
145
+ * // ],
146
+ * // },
147
+ * // },
148
+ * // ],
149
+ * // EntityDetectorConfiguration: { // EntityDetectorConfiguration
150
+ * // EntityTypes: [ // EntityTypeList // required
151
+ * // "STRING_VALUE",
152
+ * // ],
153
+ * // AllowedStatistics: [ // AllowedStatisticList
154
+ * // { // AllowedStatistics
155
+ * // Statistics: [ // required
156
+ * // "STRING_VALUE",
157
+ * // ],
158
+ * // },
159
+ * // ],
160
+ * // },
161
+ * // },
162
+ * // ValidationConfigurations: [ // ValidationConfigurationList
163
+ * // { // ValidationConfiguration
164
+ * // RulesetArn: "STRING_VALUE", // required
165
+ * // ValidationMode: "CHECK_ALL",
166
+ * // },
167
+ * // ],
168
+ * // RecipeReference: { // RecipeReference
169
+ * // Name: "STRING_VALUE", // required
170
+ * // RecipeVersion: "STRING_VALUE",
171
+ * // },
172
+ * // ResourceArn: "STRING_VALUE",
173
+ * // RoleArn: "STRING_VALUE",
174
+ * // Tags: { // TagMap
175
+ * // "<keys>": "STRING_VALUE",
176
+ * // },
177
+ * // Timeout: Number("int"),
178
+ * // JobSample: { // JobSample
179
+ * // Mode: "FULL_DATASET" || "CUSTOM_ROWS",
180
+ * // Size: Number("long"),
181
+ * // },
182
+ * // };
183
+ *
34
184
  * ```
35
185
  *
36
186
  * @param DescribeJobCommandInput - {@link DescribeJobCommandInput}
@@ -45,6 +195,8 @@ export interface DescribeJobCommandOutput extends DescribeJobResponse, __Metadat
45
195
  * @throws {@link ValidationException} (client fault)
46
196
  * <p>The input parameters for this request failed validation.</p>
47
197
  *
198
+ * @throws {@link DataBrewServiceException}
199
+ * <p>Base exception class for all service exceptions from DataBrew service.</p>
48
200
  *
49
201
  */
50
202
  export declare class DescribeJobCommand extends $Command<DescribeJobCommandInput, DescribeJobCommandOutput, DataBrewClientResolvedConfig> {