prowler-sdk-poc
Version:
1,186 lines • 90.8 kB
TypeScript
import {Request} from '../lib/request';
import {Response} from '../lib/response';
import {AWSError} from '../lib/error';
import {Service} from '../lib/service';
import {ServiceConfigurationOptions} from '../lib/service';
import {ConfigBase as Config} from '../lib/config-base';
interface Blob {}
declare class DataBrew extends Service {
/**
* Constructs a service object. This object has one method for each API operation.
*/
constructor(options?: DataBrew.Types.ClientConfiguration)
config: Config & DataBrew.Types.ClientConfiguration;
/**
* Deletes one or more versions of a recipe at a time. The entire request will be rejected if: The recipe does not exist. There is an invalid version identifier in the list of versions. The version list is empty. The version list size exceeds 50. The version list contains duplicate entries. The request will complete successfully, but with partial failures, if: A version does not exist. A version is being used by a job. You specify LATEST_WORKING, but it's being used by a project. The version fails to be deleted. The LATEST_WORKING version will only be deleted if the recipe has no other versions. If you try to delete LATEST_WORKING while other versions exist (or if they can't be deleted), then LATEST_WORKING will be listed as partial failure in the response.
*/
batchDeleteRecipeVersion(params: DataBrew.Types.BatchDeleteRecipeVersionRequest, callback?: (err: AWSError, data: DataBrew.Types.BatchDeleteRecipeVersionResponse) => void): Request<DataBrew.Types.BatchDeleteRecipeVersionResponse, AWSError>;
/**
* Deletes one or more versions of a recipe at a time. The entire request will be rejected if: The recipe does not exist. There is an invalid version identifier in the list of versions. The version list is empty. The version list size exceeds 50. The version list contains duplicate entries. The request will complete successfully, but with partial failures, if: A version does not exist. A version is being used by a job. You specify LATEST_WORKING, but it's being used by a project. The version fails to be deleted. The LATEST_WORKING version will only be deleted if the recipe has no other versions. If you try to delete LATEST_WORKING while other versions exist (or if they can't be deleted), then LATEST_WORKING will be listed as partial failure in the response.
*/
batchDeleteRecipeVersion(callback?: (err: AWSError, data: DataBrew.Types.BatchDeleteRecipeVersionResponse) => void): Request<DataBrew.Types.BatchDeleteRecipeVersionResponse, AWSError>;
/**
* Creates a new DataBrew dataset.
*/
createDataset(params: DataBrew.Types.CreateDatasetRequest, callback?: (err: AWSError, data: DataBrew.Types.CreateDatasetResponse) => void): Request<DataBrew.Types.CreateDatasetResponse, AWSError>;
/**
* Creates a new DataBrew dataset.
*/
createDataset(callback?: (err: AWSError, data: DataBrew.Types.CreateDatasetResponse) => void): Request<DataBrew.Types.CreateDatasetResponse, AWSError>;
/**
* Creates a new job to analyze a dataset and create its data profile.
*/
createProfileJob(params: DataBrew.Types.CreateProfileJobRequest, callback?: (err: AWSError, data: DataBrew.Types.CreateProfileJobResponse) => void): Request<DataBrew.Types.CreateProfileJobResponse, AWSError>;
/**
* Creates a new job to analyze a dataset and create its data profile.
*/
createProfileJob(callback?: (err: AWSError, data: DataBrew.Types.CreateProfileJobResponse) => void): Request<DataBrew.Types.CreateProfileJobResponse, AWSError>;
/**
* Creates a new DataBrew project.
*/
createProject(params: DataBrew.Types.CreateProjectRequest, callback?: (err: AWSError, data: DataBrew.Types.CreateProjectResponse) => void): Request<DataBrew.Types.CreateProjectResponse, AWSError>;
/**
* Creates a new DataBrew project.
*/
createProject(callback?: (err: AWSError, data: DataBrew.Types.CreateProjectResponse) => void): Request<DataBrew.Types.CreateProjectResponse, AWSError>;
/**
* Creates a new DataBrew recipe.
*/
createRecipe(params: DataBrew.Types.CreateRecipeRequest, callback?: (err: AWSError, data: DataBrew.Types.CreateRecipeResponse) => void): Request<DataBrew.Types.CreateRecipeResponse, AWSError>;
/**
* Creates a new DataBrew recipe.
*/
createRecipe(callback?: (err: AWSError, data: DataBrew.Types.CreateRecipeResponse) => void): Request<DataBrew.Types.CreateRecipeResponse, AWSError>;
/**
* Creates a new job to transform input data, using steps defined in an existing Glue DataBrew recipe
*/
createRecipeJob(params: DataBrew.Types.CreateRecipeJobRequest, callback?: (err: AWSError, data: DataBrew.Types.CreateRecipeJobResponse) => void): Request<DataBrew.Types.CreateRecipeJobResponse, AWSError>;
/**
* Creates a new job to transform input data, using steps defined in an existing Glue DataBrew recipe
*/
createRecipeJob(callback?: (err: AWSError, data: DataBrew.Types.CreateRecipeJobResponse) => void): Request<DataBrew.Types.CreateRecipeJobResponse, AWSError>;
/**
* Creates a new schedule for one or more DataBrew jobs. Jobs can be run at a specific date and time, or at regular intervals.
*/
createSchedule(params: DataBrew.Types.CreateScheduleRequest, callback?: (err: AWSError, data: DataBrew.Types.CreateScheduleResponse) => void): Request<DataBrew.Types.CreateScheduleResponse, AWSError>;
/**
* Creates a new schedule for one or more DataBrew jobs. Jobs can be run at a specific date and time, or at regular intervals.
*/
createSchedule(callback?: (err: AWSError, data: DataBrew.Types.CreateScheduleResponse) => void): Request<DataBrew.Types.CreateScheduleResponse, AWSError>;
/**
* Deletes a dataset from DataBrew.
*/
deleteDataset(params: DataBrew.Types.DeleteDatasetRequest, callback?: (err: AWSError, data: DataBrew.Types.DeleteDatasetResponse) => void): Request<DataBrew.Types.DeleteDatasetResponse, AWSError>;
/**
* Deletes a dataset from DataBrew.
*/
deleteDataset(callback?: (err: AWSError, data: DataBrew.Types.DeleteDatasetResponse) => void): Request<DataBrew.Types.DeleteDatasetResponse, AWSError>;
/**
* Deletes the specified DataBrew job.
*/
deleteJob(params: DataBrew.Types.DeleteJobRequest, callback?: (err: AWSError, data: DataBrew.Types.DeleteJobResponse) => void): Request<DataBrew.Types.DeleteJobResponse, AWSError>;
/**
* Deletes the specified DataBrew job.
*/
deleteJob(callback?: (err: AWSError, data: DataBrew.Types.DeleteJobResponse) => void): Request<DataBrew.Types.DeleteJobResponse, AWSError>;
/**
* Deletes an existing DataBrew project.
*/
deleteProject(params: DataBrew.Types.DeleteProjectRequest, callback?: (err: AWSError, data: DataBrew.Types.DeleteProjectResponse) => void): Request<DataBrew.Types.DeleteProjectResponse, AWSError>;
/**
* Deletes an existing DataBrew project.
*/
deleteProject(callback?: (err: AWSError, data: DataBrew.Types.DeleteProjectResponse) => void): Request<DataBrew.Types.DeleteProjectResponse, AWSError>;
/**
* Deletes a single version of a DataBrew recipe.
*/
deleteRecipeVersion(params: DataBrew.Types.DeleteRecipeVersionRequest, callback?: (err: AWSError, data: DataBrew.Types.DeleteRecipeVersionResponse) => void): Request<DataBrew.Types.DeleteRecipeVersionResponse, AWSError>;
/**
* Deletes a single version of a DataBrew recipe.
*/
deleteRecipeVersion(callback?: (err: AWSError, data: DataBrew.Types.DeleteRecipeVersionResponse) => void): Request<DataBrew.Types.DeleteRecipeVersionResponse, AWSError>;
/**
* Deletes the specified DataBrew schedule.
*/
deleteSchedule(params: DataBrew.Types.DeleteScheduleRequest, callback?: (err: AWSError, data: DataBrew.Types.DeleteScheduleResponse) => void): Request<DataBrew.Types.DeleteScheduleResponse, AWSError>;
/**
* Deletes the specified DataBrew schedule.
*/
deleteSchedule(callback?: (err: AWSError, data: DataBrew.Types.DeleteScheduleResponse) => void): Request<DataBrew.Types.DeleteScheduleResponse, AWSError>;
/**
* Returns the definition of a specific DataBrew dataset.
*/
describeDataset(params: DataBrew.Types.DescribeDatasetRequest, callback?: (err: AWSError, data: DataBrew.Types.DescribeDatasetResponse) => void): Request<DataBrew.Types.DescribeDatasetResponse, AWSError>;
/**
* Returns the definition of a specific DataBrew dataset.
*/
describeDataset(callback?: (err: AWSError, data: DataBrew.Types.DescribeDatasetResponse) => void): Request<DataBrew.Types.DescribeDatasetResponse, AWSError>;
/**
* Returns the definition of a specific DataBrew job.
*/
describeJob(params: DataBrew.Types.DescribeJobRequest, callback?: (err: AWSError, data: DataBrew.Types.DescribeJobResponse) => void): Request<DataBrew.Types.DescribeJobResponse, AWSError>;
/**
* Returns the definition of a specific DataBrew job.
*/
describeJob(callback?: (err: AWSError, data: DataBrew.Types.DescribeJobResponse) => void): Request<DataBrew.Types.DescribeJobResponse, AWSError>;
/**
* Represents one run of a DataBrew job.
*/
describeJobRun(params: DataBrew.Types.DescribeJobRunRequest, callback?: (err: AWSError, data: DataBrew.Types.DescribeJobRunResponse) => void): Request<DataBrew.Types.DescribeJobRunResponse, AWSError>;
/**
* Represents one run of a DataBrew job.
*/
describeJobRun(callback?: (err: AWSError, data: DataBrew.Types.DescribeJobRunResponse) => void): Request<DataBrew.Types.DescribeJobRunResponse, AWSError>;
/**
* Returns the definition of a specific DataBrew project.
*/
describeProject(params: DataBrew.Types.DescribeProjectRequest, callback?: (err: AWSError, data: DataBrew.Types.DescribeProjectResponse) => void): Request<DataBrew.Types.DescribeProjectResponse, AWSError>;
/**
* Returns the definition of a specific DataBrew project.
*/
describeProject(callback?: (err: AWSError, data: DataBrew.Types.DescribeProjectResponse) => void): Request<DataBrew.Types.DescribeProjectResponse, AWSError>;
/**
* Returns the definition of a specific DataBrew recipe corresponding to a particular version.
*/
describeRecipe(params: DataBrew.Types.DescribeRecipeRequest, callback?: (err: AWSError, data: DataBrew.Types.DescribeRecipeResponse) => void): Request<DataBrew.Types.DescribeRecipeResponse, AWSError>;
/**
* Returns the definition of a specific DataBrew recipe corresponding to a particular version.
*/
describeRecipe(callback?: (err: AWSError, data: DataBrew.Types.DescribeRecipeResponse) => void): Request<DataBrew.Types.DescribeRecipeResponse, AWSError>;
/**
* Returns the definition of a specific DataBrew schedule.
*/
describeSchedule(params: DataBrew.Types.DescribeScheduleRequest, callback?: (err: AWSError, data: DataBrew.Types.DescribeScheduleResponse) => void): Request<DataBrew.Types.DescribeScheduleResponse, AWSError>;
/**
* Returns the definition of a specific DataBrew schedule.
*/
describeSchedule(callback?: (err: AWSError, data: DataBrew.Types.DescribeScheduleResponse) => void): Request<DataBrew.Types.DescribeScheduleResponse, AWSError>;
/**
* Lists all of the DataBrew datasets.
*/
listDatasets(params: DataBrew.Types.ListDatasetsRequest, callback?: (err: AWSError, data: DataBrew.Types.ListDatasetsResponse) => void): Request<DataBrew.Types.ListDatasetsResponse, AWSError>;
/**
* Lists all of the DataBrew datasets.
*/
listDatasets(callback?: (err: AWSError, data: DataBrew.Types.ListDatasetsResponse) => void): Request<DataBrew.Types.ListDatasetsResponse, AWSError>;
/**
* Lists all of the previous runs of a particular DataBrew job.
*/
listJobRuns(params: DataBrew.Types.ListJobRunsRequest, callback?: (err: AWSError, data: DataBrew.Types.ListJobRunsResponse) => void): Request<DataBrew.Types.ListJobRunsResponse, AWSError>;
/**
* Lists all of the previous runs of a particular DataBrew job.
*/
listJobRuns(callback?: (err: AWSError, data: DataBrew.Types.ListJobRunsResponse) => void): Request<DataBrew.Types.ListJobRunsResponse, AWSError>;
/**
* Lists all of the DataBrew jobs that are defined.
*/
listJobs(params: DataBrew.Types.ListJobsRequest, callback?: (err: AWSError, data: DataBrew.Types.ListJobsResponse) => void): Request<DataBrew.Types.ListJobsResponse, AWSError>;
/**
* Lists all of the DataBrew jobs that are defined.
*/
listJobs(callback?: (err: AWSError, data: DataBrew.Types.ListJobsResponse) => void): Request<DataBrew.Types.ListJobsResponse, AWSError>;
/**
* Lists all of the DataBrew projects that are defined.
*/
listProjects(params: DataBrew.Types.ListProjectsRequest, callback?: (err: AWSError, data: DataBrew.Types.ListProjectsResponse) => void): Request<DataBrew.Types.ListProjectsResponse, AWSError>;
/**
* Lists all of the DataBrew projects that are defined.
*/
listProjects(callback?: (err: AWSError, data: DataBrew.Types.ListProjectsResponse) => void): Request<DataBrew.Types.ListProjectsResponse, AWSError>;
/**
* Lists the versions of a particular DataBrew recipe, except for LATEST_WORKING.
*/
listRecipeVersions(params: DataBrew.Types.ListRecipeVersionsRequest, callback?: (err: AWSError, data: DataBrew.Types.ListRecipeVersionsResponse) => void): Request<DataBrew.Types.ListRecipeVersionsResponse, AWSError>;
/**
* Lists the versions of a particular DataBrew recipe, except for LATEST_WORKING.
*/
listRecipeVersions(callback?: (err: AWSError, data: DataBrew.Types.ListRecipeVersionsResponse) => void): Request<DataBrew.Types.ListRecipeVersionsResponse, AWSError>;
/**
* Lists all of the DataBrew recipes that are defined.
*/
listRecipes(params: DataBrew.Types.ListRecipesRequest, callback?: (err: AWSError, data: DataBrew.Types.ListRecipesResponse) => void): Request<DataBrew.Types.ListRecipesResponse, AWSError>;
/**
* Lists all of the DataBrew recipes that are defined.
*/
listRecipes(callback?: (err: AWSError, data: DataBrew.Types.ListRecipesResponse) => void): Request<DataBrew.Types.ListRecipesResponse, AWSError>;
/**
* Lists the DataBrew schedules that are defined.
*/
listSchedules(params: DataBrew.Types.ListSchedulesRequest, callback?: (err: AWSError, data: DataBrew.Types.ListSchedulesResponse) => void): Request<DataBrew.Types.ListSchedulesResponse, AWSError>;
/**
* Lists the DataBrew schedules that are defined.
*/
listSchedules(callback?: (err: AWSError, data: DataBrew.Types.ListSchedulesResponse) => void): Request<DataBrew.Types.ListSchedulesResponse, AWSError>;
/**
* Lists all the tags for a DataBrew resource.
*/
listTagsForResource(params: DataBrew.Types.ListTagsForResourceRequest, callback?: (err: AWSError, data: DataBrew.Types.ListTagsForResourceResponse) => void): Request<DataBrew.Types.ListTagsForResourceResponse, AWSError>;
/**
* Lists all the tags for a DataBrew resource.
*/
listTagsForResource(callback?: (err: AWSError, data: DataBrew.Types.ListTagsForResourceResponse) => void): Request<DataBrew.Types.ListTagsForResourceResponse, AWSError>;
/**
* Publishes a new version of a DataBrew recipe.
*/
publishRecipe(params: DataBrew.Types.PublishRecipeRequest, callback?: (err: AWSError, data: DataBrew.Types.PublishRecipeResponse) => void): Request<DataBrew.Types.PublishRecipeResponse, AWSError>;
/**
* Publishes a new version of a DataBrew recipe.
*/
publishRecipe(callback?: (err: AWSError, data: DataBrew.Types.PublishRecipeResponse) => void): Request<DataBrew.Types.PublishRecipeResponse, AWSError>;
/**
* Performs a recipe step within an interactive DataBrew session that's currently open.
*/
sendProjectSessionAction(params: DataBrew.Types.SendProjectSessionActionRequest, callback?: (err: AWSError, data: DataBrew.Types.SendProjectSessionActionResponse) => void): Request<DataBrew.Types.SendProjectSessionActionResponse, AWSError>;
/**
* Performs a recipe step within an interactive DataBrew session that's currently open.
*/
sendProjectSessionAction(callback?: (err: AWSError, data: DataBrew.Types.SendProjectSessionActionResponse) => void): Request<DataBrew.Types.SendProjectSessionActionResponse, AWSError>;
/**
* Runs a DataBrew job.
*/
startJobRun(params: DataBrew.Types.StartJobRunRequest, callback?: (err: AWSError, data: DataBrew.Types.StartJobRunResponse) => void): Request<DataBrew.Types.StartJobRunResponse, AWSError>;
/**
* Runs a DataBrew job.
*/
startJobRun(callback?: (err: AWSError, data: DataBrew.Types.StartJobRunResponse) => void): Request<DataBrew.Types.StartJobRunResponse, AWSError>;
/**
* Creates an interactive session, enabling you to manipulate data in a DataBrew project.
*/
startProjectSession(params: DataBrew.Types.StartProjectSessionRequest, callback?: (err: AWSError, data: DataBrew.Types.StartProjectSessionResponse) => void): Request<DataBrew.Types.StartProjectSessionResponse, AWSError>;
/**
* Creates an interactive session, enabling you to manipulate data in a DataBrew project.
*/
startProjectSession(callback?: (err: AWSError, data: DataBrew.Types.StartProjectSessionResponse) => void): Request<DataBrew.Types.StartProjectSessionResponse, AWSError>;
/**
* Stops a particular run of a job.
*/
stopJobRun(params: DataBrew.Types.StopJobRunRequest, callback?: (err: AWSError, data: DataBrew.Types.StopJobRunResponse) => void): Request<DataBrew.Types.StopJobRunResponse, AWSError>;
/**
* Stops a particular run of a job.
*/
stopJobRun(callback?: (err: AWSError, data: DataBrew.Types.StopJobRunResponse) => void): Request<DataBrew.Types.StopJobRunResponse, AWSError>;
/**
* Adds metadata tags to a DataBrew resource, such as a dataset, project, recipe, job, or schedule.
*/
tagResource(params: DataBrew.Types.TagResourceRequest, callback?: (err: AWSError, data: DataBrew.Types.TagResourceResponse) => void): Request<DataBrew.Types.TagResourceResponse, AWSError>;
/**
* Adds metadata tags to a DataBrew resource, such as a dataset, project, recipe, job, or schedule.
*/
tagResource(callback?: (err: AWSError, data: DataBrew.Types.TagResourceResponse) => void): Request<DataBrew.Types.TagResourceResponse, AWSError>;
/**
* Removes metadata tags from a DataBrew resource.
*/
untagResource(params: DataBrew.Types.UntagResourceRequest, callback?: (err: AWSError, data: DataBrew.Types.UntagResourceResponse) => void): Request<DataBrew.Types.UntagResourceResponse, AWSError>;
/**
* Removes metadata tags from a DataBrew resource.
*/
untagResource(callback?: (err: AWSError, data: DataBrew.Types.UntagResourceResponse) => void): Request<DataBrew.Types.UntagResourceResponse, AWSError>;
/**
* Modifies the definition of an existing DataBrew dataset.
*/
updateDataset(params: DataBrew.Types.UpdateDatasetRequest, callback?: (err: AWSError, data: DataBrew.Types.UpdateDatasetResponse) => void): Request<DataBrew.Types.UpdateDatasetResponse, AWSError>;
/**
* Modifies the definition of an existing DataBrew dataset.
*/
updateDataset(callback?: (err: AWSError, data: DataBrew.Types.UpdateDatasetResponse) => void): Request<DataBrew.Types.UpdateDatasetResponse, AWSError>;
/**
* Modifies the definition of an existing profile job.
*/
updateProfileJob(params: DataBrew.Types.UpdateProfileJobRequest, callback?: (err: AWSError, data: DataBrew.Types.UpdateProfileJobResponse) => void): Request<DataBrew.Types.UpdateProfileJobResponse, AWSError>;
/**
* Modifies the definition of an existing profile job.
*/
updateProfileJob(callback?: (err: AWSError, data: DataBrew.Types.UpdateProfileJobResponse) => void): Request<DataBrew.Types.UpdateProfileJobResponse, AWSError>;
/**
* Modifies the definition of an existing DataBrew project.
*/
updateProject(params: DataBrew.Types.UpdateProjectRequest, callback?: (err: AWSError, data: DataBrew.Types.UpdateProjectResponse) => void): Request<DataBrew.Types.UpdateProjectResponse, AWSError>;
/**
* Modifies the definition of an existing DataBrew project.
*/
updateProject(callback?: (err: AWSError, data: DataBrew.Types.UpdateProjectResponse) => void): Request<DataBrew.Types.UpdateProjectResponse, AWSError>;
/**
* Modifies the definition of the LATEST_WORKING version of a DataBrew recipe.
*/
updateRecipe(params: DataBrew.Types.UpdateRecipeRequest, callback?: (err: AWSError, data: DataBrew.Types.UpdateRecipeResponse) => void): Request<DataBrew.Types.UpdateRecipeResponse, AWSError>;
/**
* Modifies the definition of the LATEST_WORKING version of a DataBrew recipe.
*/
updateRecipe(callback?: (err: AWSError, data: DataBrew.Types.UpdateRecipeResponse) => void): Request<DataBrew.Types.UpdateRecipeResponse, AWSError>;
/**
* Modifies the definition of an existing DataBrew recipe job.
*/
updateRecipeJob(params: DataBrew.Types.UpdateRecipeJobRequest, callback?: (err: AWSError, data: DataBrew.Types.UpdateRecipeJobResponse) => void): Request<DataBrew.Types.UpdateRecipeJobResponse, AWSError>;
/**
* Modifies the definition of an existing DataBrew recipe job.
*/
updateRecipeJob(callback?: (err: AWSError, data: DataBrew.Types.UpdateRecipeJobResponse) => void): Request<DataBrew.Types.UpdateRecipeJobResponse, AWSError>;
/**
* Modifies the definition of an existing DataBrew schedule.
*/
updateSchedule(params: DataBrew.Types.UpdateScheduleRequest, callback?: (err: AWSError, data: DataBrew.Types.UpdateScheduleResponse) => void): Request<DataBrew.Types.UpdateScheduleResponse, AWSError>;
/**
* Modifies the definition of an existing DataBrew schedule.
*/
updateSchedule(callback?: (err: AWSError, data: DataBrew.Types.UpdateScheduleResponse) => void): Request<DataBrew.Types.UpdateScheduleResponse, AWSError>;
}
declare namespace DataBrew {
export type AccountId = string;
export type ActionId = number;
export type Arn = string;
export type AssumeControl = boolean;
export type Attempt = number;
export interface BatchDeleteRecipeVersionRequest {
/**
* The name of the recipe whose versions are to be deleted.
*/
Name: RecipeName;
/**
* An array of version identifiers, for the recipe versions to be deleted. You can specify numeric versions (X.Y) or LATEST_WORKING. LATEST_PUBLISHED is not supported.
*/
RecipeVersions: RecipeVersionList;
}
export interface BatchDeleteRecipeVersionResponse {
/**
* The name of the recipe that was modified.
*/
Name: RecipeName;
/**
* Errors, if any, that occurred while attempting to delete the recipe versions.
*/
Errors?: RecipeErrorList;
}
export type Bucket = string;
export type CatalogId = string;
export type ClientSessionId = string;
export type ColumnName = string;
export type ColumnNameList = ColumnName[];
export type ColumnRange = number;
export interface ColumnSelector {
/**
* A regular expression for selecting a column from a dataset.
*/
Regex?: ColumnName;
/**
* The name of a column from a dataset.
*/
Name?: ColumnName;
}
export type ColumnSelectorList = ColumnSelector[];
export interface ColumnStatisticsConfiguration {
/**
* List of column selectors. Selectors can be used to select columns from the dataset. When selectors are undefined, configuration will be applied to all supported columns.
*/
Selectors?: ColumnSelectorList;
/**
* Configuration for evaluations. Statistics can be used to select evaluations and override parameters of evaluations.
*/
Statistics: StatisticsConfiguration;
}
export type ColumnStatisticsConfigurationList = ColumnStatisticsConfiguration[];
export type CompressionFormat = "GZIP"|"LZ4"|"SNAPPY"|"BZIP2"|"DEFLATE"|"LZO"|"BROTLI"|"ZSTD"|"ZLIB"|string;
export type Condition = string;
export interface ConditionExpression {
/**
* A specific condition to apply to a recipe action. For more information, see Recipe structure in the Glue DataBrew Developer Guide.
*/
Condition: Condition;
/**
* A value that the condition must evaluate to for the condition to succeed.
*/
Value?: ConditionValue;
/**
* A column to apply this condition to.
*/
TargetColumn: TargetColumn;
}
export type ConditionExpressionList = ConditionExpression[];
export type ConditionValue = string;
export type CreateColumn = boolean;
export interface CreateDatasetRequest {
/**
* The name of the dataset to be created. Valid characters are alphanumeric (A-Z, a-z, 0-9), hyphen (-), period (.), and space.
*/
Name: DatasetName;
/**
* The file format of a dataset that is created from an Amazon S3 file or folder.
*/
Format?: InputFormat;
FormatOptions?: FormatOptions;
Input: Input;
/**
* A set of options that defines how DataBrew interprets an Amazon S3 path of the dataset.
*/
PathOptions?: PathOptions;
/**
* Metadata tags to apply to this dataset.
*/
Tags?: TagMap;
}
export interface CreateDatasetResponse {
/**
* The name of the dataset that you created.
*/
Name: DatasetName;
}
export interface CreateProfileJobRequest {
/**
* The name of the dataset that this job is to act upon.
*/
DatasetName: DatasetName;
/**
* The Amazon Resource Name (ARN) of an encryption key that is used to protect the job.
*/
EncryptionKeyArn?: EncryptionKeyArn;
/**
* The encryption mode for the job, which can be one of the following: SSE-KMS - SSE-KMS - Server-side encryption with KMS-managed keys. SSE-S3 - Server-side encryption with keys managed by Amazon S3.
*/
EncryptionMode?: EncryptionMode;
/**
* The name of the job to be created. Valid characters are alphanumeric (A-Z, a-z, 0-9), hyphen (-), period (.), and space.
*/
Name: JobName;
/**
* Enables or disables Amazon CloudWatch logging for the job. If logging is enabled, CloudWatch writes one log stream for each job run.
*/
LogSubscription?: LogSubscription;
/**
* The maximum number of nodes that DataBrew can use when the job processes data.
*/
MaxCapacity?: MaxCapacity;
/**
* The maximum number of times to retry the job after a job run fails.
*/
MaxRetries?: MaxRetries;
OutputLocation: S3Location;
/**
* Configuration for profile jobs. Used to select columns, do evaluations, and override default parameters of evaluations. When configuration is null, the profile job will run with default settings.
*/
Configuration?: ProfileConfiguration;
/**
* The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role to be assumed when DataBrew runs the job.
*/
RoleArn: Arn;
/**
* Metadata tags to apply to this job.
*/
Tags?: TagMap;
/**
* The job's timeout in minutes. A job that attempts to run longer than this timeout period ends with a status of TIMEOUT.
*/
Timeout?: Timeout;
/**
* Sample configuration for profile jobs only. Determines the number of rows on which the profile job will be executed. If a JobSample value is not provided, the default value will be used. The default value is CUSTOM_ROWS for the mode parameter and 20000 for the size parameter.
*/
JobSample?: JobSample;
}
export interface CreateProfileJobResponse {
/**
* The name of the job that was created.
*/
Name: JobName;
}
export interface CreateProjectRequest {
/**
* The name of an existing dataset to associate this project with.
*/
DatasetName: DatasetName;
/**
* A unique name for the new project. Valid characters are alphanumeric (A-Z, a-z, 0-9), hyphen (-), period (.), and space.
*/
Name: ProjectName;
/**
* The name of an existing recipe to associate with the project.
*/
RecipeName: RecipeName;
Sample?: Sample;
/**
* The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role to be assumed for this request.
*/
RoleArn: Arn;
/**
* Metadata tags to apply to this project.
*/
Tags?: TagMap;
}
export interface CreateProjectResponse {
/**
* The name of the project that you created.
*/
Name: ProjectName;
}
export interface CreateRecipeJobRequest {
/**
* The name of the dataset that this job processes.
*/
DatasetName?: DatasetName;
/**
* The Amazon Resource Name (ARN) of an encryption key that is used to protect the job.
*/
EncryptionKeyArn?: EncryptionKeyArn;
/**
* The encryption mode for the job, which can be one of the following: SSE-KMS - Server-side encryption with keys managed by KMS. SSE-S3 - Server-side encryption with keys managed by Amazon S3.
*/
EncryptionMode?: EncryptionMode;
/**
* A unique name for the job. Valid characters are alphanumeric (A-Z, a-z, 0-9), hyphen (-), period (.), and space.
*/
Name: JobName;
/**
* Enables or disables Amazon CloudWatch logging for the job. If logging is enabled, CloudWatch writes one log stream for each job run.
*/
LogSubscription?: LogSubscription;
/**
* The maximum number of nodes that DataBrew can consume when the job processes data.
*/
MaxCapacity?: MaxCapacity;
/**
* The maximum number of times to retry the job after a job run fails.
*/
MaxRetries?: MaxRetries;
/**
* One or more artifacts that represent the output from running the job.
*/
Outputs?: OutputList;
/**
* One or more artifacts that represent the Glue Data Catalog output from running the job.
*/
DataCatalogOutputs?: DataCatalogOutputList;
/**
* Represents a list of JDBC database output objects which defines the output destination for a DataBrew recipe job to write to.
*/
DatabaseOutputs?: DatabaseOutputList;
/**
* Either the name of an existing project, or a combination of a recipe and a dataset to associate with the recipe.
*/
ProjectName?: ProjectName;
RecipeReference?: RecipeReference;
/**
* The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role to be assumed when DataBrew runs the job.
*/
RoleArn: Arn;
/**
* Metadata tags to apply to this job.
*/
Tags?: TagMap;
/**
* The job's timeout in minutes. A job that attempts to run longer than this timeout period ends with a status of TIMEOUT.
*/
Timeout?: Timeout;
}
export interface CreateRecipeJobResponse {
/**
* The name of the job that you created.
*/
Name: JobName;
}
export interface CreateRecipeRequest {
/**
* A description for the recipe.
*/
Description?: RecipeDescription;
/**
* A unique name for the recipe. Valid characters are alphanumeric (A-Z, a-z, 0-9), hyphen (-), period (.), and space.
*/
Name: RecipeName;
/**
* An array containing the steps to be performed by the recipe. Each recipe step consists of one recipe action and (optionally) an array of condition expressions.
*/
Steps: RecipeStepList;
/**
* Metadata tags to apply to this recipe.
*/
Tags?: TagMap;
}
export interface CreateRecipeResponse {
/**
* The name of the recipe that you created.
*/
Name: RecipeName;
}
export interface CreateScheduleRequest {
/**
* The name or names of one or more jobs to be run.
*/
JobNames?: JobNameList;
/**
* The date or dates and time or times when the jobs are to be run. For more information, see Cron expressions in the Glue DataBrew Developer Guide.
*/
CronExpression: CronExpression;
/**
* Metadata tags to apply to this schedule.
*/
Tags?: TagMap;
/**
* A unique name for the schedule. Valid characters are alphanumeric (A-Z, a-z, 0-9), hyphen (-), period (.), and space.
*/
Name: ScheduleName;
}
export interface CreateScheduleResponse {
/**
* The name of the schedule that was created.
*/
Name: ScheduleName;
}
export type CreatedBy = string;
export type CronExpression = string;
export interface CsvOptions {
/**
* A single character that specifies the delimiter being used in the CSV file.
*/
Delimiter?: Delimiter;
/**
* A variable that specifies whether the first row in the file is parsed as the header. If this value is false, column names are auto-generated.
*/
HeaderRow?: HeaderRow;
}
export interface CsvOutputOptions {
/**
* A single character that specifies the delimiter used to create CSV job output.
*/
Delimiter?: Delimiter;
}
export interface DataCatalogInputDefinition {
/**
* The unique identifier of the Amazon Web Services account that holds the Data Catalog that stores the data.
*/
CatalogId?: CatalogId;
/**
* The name of a database in the Data Catalog.
*/
DatabaseName: DatabaseName;
/**
* The name of a database table in the Data Catalog. This table corresponds to a DataBrew dataset.
*/
TableName: TableName;
/**
* Represents an Amazon location where DataBrew can store intermediate results.
*/
TempDirectory?: S3Location;
}
export interface DataCatalogOutput {
/**
* The unique identifier of the Amazon Web Services account that holds the Data Catalog that stores the data.
*/
CatalogId?: CatalogId;
/**
* The name of a database in the Data Catalog.
*/
DatabaseName: DatabaseName;
/**
* The name of a table in the Data Catalog.
*/
TableName: TableName;
/**
* Represents options that specify how and where DataBrew writes the Amazon S3 output generated by recipe jobs.
*/
S3Options?: S3TableOutputOptions;
/**
* Represents options that specify how and where DataBrew writes the database output generated by recipe jobs.
*/
DatabaseOptions?: DatabaseTableOutputOptions;
/**
* A value that, if true, means that any data in the location specified for output is overwritten with new output. Not supported with DatabaseOptions.
*/
Overwrite?: OverwriteOutput;
}
export type DataCatalogOutputList = DataCatalogOutput[];
export interface DatabaseInputDefinition {
/**
* The Glue Connection that stores the connection information for the target database.
*/
GlueConnectionName: GlueConnectionName;
/**
* The table within the target database.
*/
DatabaseTableName: DatabaseTableName;
TempDirectory?: S3Location;
}
export type DatabaseName = string;
export interface DatabaseOutput {
/**
* The Glue connection that stores the connection information for the target database.
*/
GlueConnectionName: GlueConnectionName;
/**
* Represents options that specify how and where DataBrew writes the database output generated by recipe jobs.
*/
DatabaseOptions: DatabaseTableOutputOptions;
/**
* The output mode to write into the database. Currently supported option: NEW_TABLE.
*/
DatabaseOutputMode?: DatabaseOutputMode;
}
export type DatabaseOutputList = DatabaseOutput[];
export type DatabaseOutputMode = "NEW_TABLE"|string;
export type DatabaseTableName = string;
export interface DatabaseTableOutputOptions {
/**
* Represents an Amazon S3 location (bucket name and object key) where DataBrew can store intermediate results.
*/
TempDirectory?: S3Location;
/**
* A prefix for the name of a table DataBrew will create in the database.
*/
TableName: DatabaseTableName;
}
export interface Dataset {
/**
* The ID of the Amazon Web Services account that owns the dataset.
*/
AccountId?: AccountId;
/**
* The Amazon Resource Name (ARN) of the user who created the dataset.
*/
CreatedBy?: CreatedBy;
/**
* The date and time that the dataset was created.
*/
CreateDate?: _Date;
/**
* The unique name of the dataset.
*/
Name: DatasetName;
/**
* The file format of a dataset that is created from an Amazon S3 file or folder.
*/
Format?: InputFormat;
/**
* A set of options that define how DataBrew interprets the data in the dataset.
*/
FormatOptions?: FormatOptions;
/**
* Information on how DataBrew can find the dataset, in either the Glue Data Catalog or Amazon S3.
*/
Input: Input;
/**
* The last modification date and time of the dataset.
*/
LastModifiedDate?: _Date;
/**
* The Amazon Resource Name (ARN) of the user who last modified the dataset.
*/
LastModifiedBy?: LastModifiedBy;
/**
* The location of the data for the dataset, either Amazon S3 or the Glue Data Catalog.
*/
Source?: Source;
/**
* A set of options that defines how DataBrew interprets an Amazon S3 path of the dataset.
*/
PathOptions?: PathOptions;
/**
* Metadata tags that have been applied to the dataset.
*/
Tags?: TagMap;
/**
* The unique Amazon Resource Name (ARN) for the dataset.
*/
ResourceArn?: Arn;
}
export type DatasetList = Dataset[];
export type DatasetName = string;
export interface DatasetParameter {
/**
* The name of the parameter that is used in the dataset's Amazon S3 path.
*/
Name: PathParameterName;
/**
* The type of the dataset parameter, can be one of a 'String', 'Number' or 'Datetime'.
*/
Type: ParameterType;
/**
* Additional parameter options such as a format and a timezone. Required for datetime parameters.
*/
DatetimeOptions?: DatetimeOptions;
/**
* Optional boolean value that defines whether the captured value of this parameter should be used to create a new column in a dataset.
*/
CreateColumn?: CreateColumn;
/**
* The optional filter expression structure to apply additional matching criteria to the parameter.
*/
Filter?: FilterExpression;
}
export type _Date = Date;
export type DatetimeFormat = string;
export interface DatetimeOptions {
/**
* Required option, that defines the datetime format used for a date parameter in the Amazon S3 path. Should use only supported datetime specifiers and separation characters, all literal a-z or A-Z characters should be escaped with single quotes. E.g. "MM.dd.yyyy-'at'-HH:mm".
*/
Format: DatetimeFormat;
/**
* Optional value for a timezone offset of the datetime parameter value in the Amazon S3 path. Shouldn't be used if Format for this parameter includes timezone fields. If no offset specified, UTC is assumed.
*/
TimezoneOffset?: TimezoneOffset;
/**
* Optional value for a non-US locale code, needed for correct interpretation of some date formats.
*/
LocaleCode?: LocaleCode;
}
export interface DeleteDatasetRequest {
/**
* The name of the dataset to be deleted.
*/
Name: DatasetName;
}
export interface DeleteDatasetResponse {
/**
* The name of the dataset that you deleted.
*/
Name: DatasetName;
}
export interface DeleteJobRequest {
/**
* The name of the job to be deleted.
*/
Name: JobName;
}
export interface DeleteJobResponse {
/**
* The name of the job that you deleted.
*/
Name: JobName;
}
export interface DeleteProjectRequest {
/**
* The name of the project to be deleted.
*/
Name: ProjectName;
}
export interface DeleteProjectResponse {
/**
* The name of the project that you deleted.
*/
Name: ProjectName;
}
export interface DeleteRecipeVersionRequest {
/**
* The name of the recipe.
*/
Name: RecipeName;
/**
* The version of the recipe to be deleted. You can specify a numeric versions (X.Y) or LATEST_WORKING. LATEST_PUBLISHED is not supported.
*/
RecipeVersion: RecipeVersion;
}
export interface DeleteRecipeVersionResponse {
/**
* The name of the recipe that was deleted.
*/
Name: RecipeName;
/**
* The version of the recipe that was deleted.
*/
RecipeVersion: RecipeVersion;
}
export interface DeleteScheduleRequest {
/**
* The name of the schedule to be deleted.
*/
Name: ScheduleName;
}
export interface DeleteScheduleResponse {
/**
* The name of the schedule that was deleted.
*/
Name: ScheduleName;
}
export type Delimiter = string;
export interface DescribeDatasetRequest {
/**
* The name of the dataset to be described.
*/
Name: DatasetName;
}
export interface DescribeDatasetResponse {
/**
* The identifier (user name) of the user who created the dataset.
*/
CreatedBy?: CreatedBy;
/**
* The date and time that the dataset was created.
*/
CreateDate?: _Date;
/**
* The name of the dataset.
*/
Name: DatasetName;
/**
* The file format of a dataset that is created from an Amazon S3 file or folder.
*/
Format?: InputFormat;
FormatOptions?: FormatOptions;
Input: Input;
/**
* The date and time that the dataset was last modified.
*/
LastModifiedDate?: _Date;
/**
* The identifier (user name) of the user who last modified the dataset.
*/
LastModifiedBy?: LastModifiedBy;
/**
* The location of the data for this dataset, Amazon S3 or the Glue Data Catalog.
*/
Source?: Source;
/**
* A set of options that defines how DataBrew interprets an Amazon S3 path of the dataset.
*/
PathOptions?: PathOptions;
/**
* Metadata tags associated with this dataset.
*/
Tags?: TagMap;
/**
* The Amazon Resource Name (ARN) of the dataset.
*/
ResourceArn?: Arn;
}
export interface DescribeJobRequest {
/**
* The name of the job to be described.
*/
Name: JobName;
}
export interface DescribeJobResponse {
/**
* The date and time that the job was created.
*/
CreateDate?: _Date;
/**
* The identifier (user name) of the user associated with the creation of the job.
*/
CreatedBy?: CreatedBy;
/**
* The dataset that the job acts upon.
*/
DatasetName?: DatasetName;
/**
* The Amazon Resource Name (ARN) of an encryption key that is used to protect the job.
*/
EncryptionKeyArn?: EncryptionKeyArn;
/**
* The encryption mode for the job, which can be one of the following: SSE-KMS - Server-side encryption with keys managed by KMS. SSE-S3 - Server-side encryption with keys managed by Amazon S3.
*/
EncryptionMode?: EncryptionMode;
/**
* The name of the job.
*/
Name: JobName;
/**
* The job type, which must be one of the following: PROFILE - The job analyzes the dataset to determine its size, data types, data distribution, and more. RECIPE - The job applies one or more transformations to a dataset.
*/
Type?: JobType;
/**
* The identifier (user name) of the user who last modified the job.
*/
LastModifiedBy?: LastModifiedBy;
/**
* The date and time that the job was last modified.
*/
LastModifiedDate?: _Date;
/**
* Indicates whether Amazon CloudWatch logging is enabled for this job.
*/
LogSubscription?: LogSubscription;
/**
* The maximum number of compute nodes that DataBrew can consume when the job processes data.
*/
MaxCapacity?: MaxCapacity;
/**
* The maximum number of times to retry the job after a job run fails.
*/
MaxRetries?: MaxRetries;
/**
* One or more artifacts that represent the output from running the job.
*/
Outputs?: OutputList;
/**
* One or more artifacts that represent the Glue Data Catalog output from running the job.
*/
DataCatalogOutputs?: DataCatalogOutputList;
/**
* Represents a list of JDBC database output objects which defines the output destination for a DataBrew recipe job to write into.
*/
DatabaseOutputs?: DatabaseOutputList;
/**
* The DataBrew project associated with this job.
*/
ProjectName?: ProjectName;
/**
* Configuration for profile jobs. Used to select columns, do evaluations, and override default parameters of evaluations. When configuration is null, the profile job will run with default settings.
*/
ProfileConfiguration?: ProfileConfiguration;
RecipeReference?: RecipeReference;
/**
* The Amazon Resource Name (ARN) of the job.
*/
ResourceArn?: Arn;
/**
* The ARN of the Identity and Access Management (IAM) role to be assumed when DataBrew runs the job.
*/
RoleArn?: Arn;
/**
* Metadata tags associated with this job.
*/
Tags?: TagMap;
/**
* The job's timeout in minutes. A job that attempts to run longer than this timeout period ends with a status of TIMEOUT.
*/
Timeout?: Timeout;
/**
* Sample configuration for profile jobs only. Determines the number of rows on which the profile job will be executed.
*/
JobSample?: JobSample;
}
export interface DescribeJobRunRequest {
/**
* The name of the job being processed during this run.
*/
Name: JobName;
/**
* The unique identifier of the job run.
*/
RunId: JobRunId;
}
export interface DescribeJobRunResponse {
/**
* The number of times that DataBrew has attempted to run the job.
*/
Attempt?: Attempt;
/**
* The date and time when the job completed processing.
*/
CompletedOn?: _Date;
/**
* The name of the dataset for the job to process.
*/
DatasetName?: DatasetName;
/**
* A message indicating an error (if any) that was encountered when the job ran.
*/
ErrorMessage?: JobRunErrorMessage;
/**
* The amount of time, in seconds, during which the job run consumed resources.
*/
ExecutionTime?: ExecutionTime;
/**
* The name of the job being processed during this run.
*/
JobName: JobName;
/**
* Configuration for profile jobs. Used to select columns, do evaluations, and override default parameters of evaluations. When configuration is null, the profile job will run with default settings.
*/
ProfileConfiguration?: ProfileConfiguration;
/**
* The unique identifier of the job run.
*/
RunId?: JobRunId;
/**
* The current state of the job run entity itself.
*/
State?: JobRunState;
/**
* The current status of Amazon CloudWatch logging for the job run.
*/
LogSubscription?: LogSubscription;
/**
* The name of an Amazon CloudWatch log group, where the job writes diagnostic messages when it runs.
*/
LogGroupName?: LogGroupName;
/**
* One or more output artifacts from a job run.
*/
Outputs?: OutputList;
/**
* One or more artifacts that represent the Glue Data Catalog output from running the job.
*/
DataCatalogOutputs?: DataCatalogOutputList;
/**
* Represents a list of JDBC database output objects which defines the output destination for a DataBrew recipe job to write into.
*/
DatabaseOutputs?: DatabaseOutputList;
RecipeReference?: RecipeReference;
/**
* The Amazon Resource Name (ARN) of the user who started the job run.
*/
StartedBy?: StartedBy;
/**
* The date and time when the job run began.
*/
StartedOn?: _Date;
/**
* Sample configuration for profile jobs only. Determines the number of rows on which the profile job will be executed. If a JobSample value is not provided, the default value will be used. The default value is CUSTOM_ROWS for the mode parameter and 20000 for the size parameter.
*/
JobSample?: JobSample;
}
export interface DescribeProjectRequest {
/**
* The name of the project to be described.
*/
Name: ProjectName;
}
export interface DescribeProjectResponse {
/**
* The date and time that the project was created.
*/
CreateDate?: _Date;
/**
* The identifier (user name) of the user who created the project.
*/
CreatedBy?: CreatedBy;
/**
* The dataset associated with the project.
*/
DatasetName?: DatasetName;
/**
* The date and time that the project was last modified.
*/
LastModifiedDate?: _Date;
/**
* The identifier (user name) of the user who last modified the project.
*/
LastModifiedBy?: LastModifiedBy;
/**
* The name of the project.
*/
Name: ProjectName;
/**
* The recipe associated with this job.
*/
RecipeName?: RecipeName;
/**
* The Amazon Resource Name (ARN) of the project.
*/
ResourceArn?: Arn;
Sample?: Sample;
/**
* The ARN of the Identity and Access Management (IAM) role to be assumed when DataBrew runs the job.
*/
RoleArn?: Arn;
/**
* Metadata tags associated with this project.
*/
Tags?: TagMap;
/**
* Describes the current state of the session: PROVISIONING - allocating resources for the session. INITIALIZING - getting the session ready for first use. ASSIGNED - the session is ready for use.
*/
SessionStatus?: SessionStatus;
/**
* The identifier (user name) of the user that opened the project for use.
*/
OpenedBy?: OpenedBy;
/**
* The date and time when the project was opened.
*/
OpenDate?: _Date;
}
export interface DescribeRecipeRequest {
/**
* The name of the recipe to be described.
*/
Name: RecipeName;
/**
* The recipe version identifier. If this parameter isn't specified, then the latest published version is returned.
*