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. */ batchDeleteRecipeVersion(params: DataBrew.Types.BatchDeleteRecipeVersionRequest, callback?: (err: AWSError, data: DataBrew.Types.BatchDeleteRecipeVersionResponse) => void): Request; /** * Deletes one or more versions of a recipe at a time. */ batchDeleteRecipeVersion(callback?: (err: AWSError, data: DataBrew.Types.BatchDeleteRecipeVersionResponse) => void): Request; /** * Creates a new AWS Glue DataBrew dataset for this AWS account. */ createDataset(params: DataBrew.Types.CreateDatasetRequest, callback?: (err: AWSError, data: DataBrew.Types.CreateDatasetResponse) => void): Request; /** * Creates a new AWS Glue DataBrew dataset for this AWS account. */ createDataset(callback?: (err: AWSError, data: DataBrew.Types.CreateDatasetResponse) => void): Request; /** * Creates a new job to profile an AWS Glue DataBrew dataset that exists in the current AWS account. */ createProfileJob(params: DataBrew.Types.CreateProfileJobRequest, callback?: (err: AWSError, data: DataBrew.Types.CreateProfileJobResponse) => void): Request; /** * Creates a new job to profile an AWS Glue DataBrew dataset that exists in the current AWS account. */ createProfileJob(callback?: (err: AWSError, data: DataBrew.Types.CreateProfileJobResponse) => void): Request; /** * Creates a new AWS Glue DataBrew project in the current AWS account. */ createProject(params: DataBrew.Types.CreateProjectRequest, callback?: (err: AWSError, data: DataBrew.Types.CreateProjectResponse) => void): Request; /** * Creates a new AWS Glue DataBrew project in the current AWS account. */ createProject(callback?: (err: AWSError, data: DataBrew.Types.CreateProjectResponse) => void): Request; /** * Creates a new AWS Glue DataBrew recipe for the current AWS account. */ createRecipe(params: DataBrew.Types.CreateRecipeRequest, callback?: (err: AWSError, data: DataBrew.Types.CreateRecipeResponse) => void): Request; /** * Creates a new AWS Glue DataBrew recipe for the current AWS account. */ createRecipe(callback?: (err: AWSError, data: DataBrew.Types.CreateRecipeResponse) => void): Request; /** * Creates a new job for an existing AWS Glue DataBrew recipe in the current AWS account. You can create a standalone job using either a project, or a combination of a recipe and a dataset. */ createRecipeJob(params: DataBrew.Types.CreateRecipeJobRequest, callback?: (err: AWSError, data: DataBrew.Types.CreateRecipeJobResponse) => void): Request; /** * Creates a new job for an existing AWS Glue DataBrew recipe in the current AWS account. You can create a standalone job using either a project, or a combination of a recipe and a dataset. */ createRecipeJob(callback?: (err: AWSError, data: DataBrew.Types.CreateRecipeJobResponse) => void): Request; /** * Creates a new schedule for one or more AWS Glue 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; /** * Creates a new schedule for one or more AWS Glue 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; /** * Deletes a dataset from AWS Glue DataBrew. */ deleteDataset(params: DataBrew.Types.DeleteDatasetRequest, callback?: (err: AWSError, data: DataBrew.Types.DeleteDatasetResponse) => void): Request; /** * Deletes a dataset from AWS Glue DataBrew. */ deleteDataset(callback?: (err: AWSError, data: DataBrew.Types.DeleteDatasetResponse) => void): Request; /** * Deletes the specified AWS Glue DataBrew job from the current AWS account. The job can be for a recipe or for a profile. */ deleteJob(params: DataBrew.Types.DeleteJobRequest, callback?: (err: AWSError, data: DataBrew.Types.DeleteJobResponse) => void): Request; /** * Deletes the specified AWS Glue DataBrew job from the current AWS account. The job can be for a recipe or for a profile. */ deleteJob(callback?: (err: AWSError, data: DataBrew.Types.DeleteJobResponse) => void): Request; /** * Deletes an existing AWS Glue DataBrew project from the current AWS account. */ deleteProject(params: DataBrew.Types.DeleteProjectRequest, callback?: (err: AWSError, data: DataBrew.Types.DeleteProjectResponse) => void): Request; /** * Deletes an existing AWS Glue DataBrew project from the current AWS account. */ deleteProject(callback?: (err: AWSError, data: DataBrew.Types.DeleteProjectResponse) => void): Request; /** * Deletes a single version of an AWS Glue DataBrew recipe. */ deleteRecipeVersion(params: DataBrew.Types.DeleteRecipeVersionRequest, callback?: (err: AWSError, data: DataBrew.Types.DeleteRecipeVersionResponse) => void): Request; /** * Deletes a single version of an AWS Glue DataBrew recipe. */ deleteRecipeVersion(callback?: (err: AWSError, data: DataBrew.Types.DeleteRecipeVersionResponse) => void): Request; /** * Deletes the specified AWS Glue DataBrew schedule from the current AWS account. */ deleteSchedule(params: DataBrew.Types.DeleteScheduleRequest, callback?: (err: AWSError, data: DataBrew.Types.DeleteScheduleResponse) => void): Request; /** * Deletes the specified AWS Glue DataBrew schedule from the current AWS account. */ deleteSchedule(callback?: (err: AWSError, data: DataBrew.Types.DeleteScheduleResponse) => void): Request; /** * Returns the definition of a specific AWS Glue DataBrew dataset that is in the current AWS account. */ describeDataset(params: DataBrew.Types.DescribeDatasetRequest, callback?: (err: AWSError, data: DataBrew.Types.DescribeDatasetResponse) => void): Request; /** * Returns the definition of a specific AWS Glue DataBrew dataset that is in the current AWS account. */ describeDataset(callback?: (err: AWSError, data: DataBrew.Types.DescribeDatasetResponse) => void): Request; /** * Returns the definition of a specific AWS Glue DataBrew job that is in the current AWS account. */ describeJob(params: DataBrew.Types.DescribeJobRequest, callback?: (err: AWSError, data: DataBrew.Types.DescribeJobResponse) => void): Request; /** * Returns the definition of a specific AWS Glue DataBrew job that is in the current AWS account. */ describeJob(callback?: (err: AWSError, data: DataBrew.Types.DescribeJobResponse) => void): Request; /** * Returns the definition of a specific AWS Glue DataBrew project that is in the current AWS account. */ describeProject(params: DataBrew.Types.DescribeProjectRequest, callback?: (err: AWSError, data: DataBrew.Types.DescribeProjectResponse) => void): Request; /** * Returns the definition of a specific AWS Glue DataBrew project that is in the current AWS account. */ describeProject(callback?: (err: AWSError, data: DataBrew.Types.DescribeProjectResponse) => void): Request; /** * Returns the definition of a specific AWS Glue DataBrew recipe that is in the current AWS account. */ describeRecipe(params: DataBrew.Types.DescribeRecipeRequest, callback?: (err: AWSError, data: DataBrew.Types.DescribeRecipeResponse) => void): Request; /** * Returns the definition of a specific AWS Glue DataBrew recipe that is in the current AWS account. */ describeRecipe(callback?: (err: AWSError, data: DataBrew.Types.DescribeRecipeResponse) => void): Request; /** * Returns the definition of a specific AWS Glue DataBrew schedule that is in the current AWS account. */ describeSchedule(params: DataBrew.Types.DescribeScheduleRequest, callback?: (err: AWSError, data: DataBrew.Types.DescribeScheduleResponse) => void): Request; /** * Returns the definition of a specific AWS Glue DataBrew schedule that is in the current AWS account. */ describeSchedule(callback?: (err: AWSError, data: DataBrew.Types.DescribeScheduleResponse) => void): Request; /** * Lists all of the AWS Glue DataBrew datasets for the current AWS account. */ listDatasets(params: DataBrew.Types.ListDatasetsRequest, callback?: (err: AWSError, data: DataBrew.Types.ListDatasetsResponse) => void): Request; /** * Lists all of the AWS Glue DataBrew datasets for the current AWS account. */ listDatasets(callback?: (err: AWSError, data: DataBrew.Types.ListDatasetsResponse) => void): Request; /** * Lists all of the previous runs of a particular AWS Glue DataBrew job in the current AWS account. */ listJobRuns(params: DataBrew.Types.ListJobRunsRequest, callback?: (err: AWSError, data: DataBrew.Types.ListJobRunsResponse) => void): Request; /** * Lists all of the previous runs of a particular AWS Glue DataBrew job in the current AWS account. */ listJobRuns(callback?: (err: AWSError, data: DataBrew.Types.ListJobRunsResponse) => void): Request; /** * Lists the AWS Glue DataBrew jobs in the current AWS account. */ listJobs(params: DataBrew.Types.ListJobsRequest, callback?: (err: AWSError, data: DataBrew.Types.ListJobsResponse) => void): Request; /** * Lists the AWS Glue DataBrew jobs in the current AWS account. */ listJobs(callback?: (err: AWSError, data: DataBrew.Types.ListJobsResponse) => void): Request; /** * Lists all of the DataBrew projects in the current AWS account. */ listProjects(params: DataBrew.Types.ListProjectsRequest, callback?: (err: AWSError, data: DataBrew.Types.ListProjectsResponse) => void): Request; /** * Lists all of the DataBrew projects in the current AWS account. */ listProjects(callback?: (err: AWSError, data: DataBrew.Types.ListProjectsResponse) => void): Request; /** * Lists all of the versions of a particular AWS Glue DataBrew recipe in the current AWS account. */ listRecipeVersions(params: DataBrew.Types.ListRecipeVersionsRequest, callback?: (err: AWSError, data: DataBrew.Types.ListRecipeVersionsResponse) => void): Request; /** * Lists all of the versions of a particular AWS Glue DataBrew recipe in the current AWS account. */ listRecipeVersions(callback?: (err: AWSError, data: DataBrew.Types.ListRecipeVersionsResponse) => void): Request; /** * Lists all of the AWS Glue DataBrew recipes in the current AWS account. */ listRecipes(params: DataBrew.Types.ListRecipesRequest, callback?: (err: AWSError, data: DataBrew.Types.ListRecipesResponse) => void): Request; /** * Lists all of the AWS Glue DataBrew recipes in the current AWS account. */ listRecipes(callback?: (err: AWSError, data: DataBrew.Types.ListRecipesResponse) => void): Request; /** * Lists the AWS Glue DataBrew schedules in the current AWS account. */ listSchedules(params: DataBrew.Types.ListSchedulesRequest, callback?: (err: AWSError, data: DataBrew.Types.ListSchedulesResponse) => void): Request; /** * Lists the AWS Glue DataBrew schedules in the current AWS account. */ listSchedules(callback?: (err: AWSError, data: DataBrew.Types.ListSchedulesResponse) => void): Request; /** * Lists all the tags for an AWS Glue DataBrew resource. */ listTagsForResource(params: DataBrew.Types.ListTagsForResourceRequest, callback?: (err: AWSError, data: DataBrew.Types.ListTagsForResourceResponse) => void): Request; /** * Lists all the tags for an AWS Glue DataBrew resource. */ listTagsForResource(callback?: (err: AWSError, data: DataBrew.Types.ListTagsForResourceResponse) => void): Request; /** * Publishes a new major version of an AWS Glue DataBrew recipe that exists in the current AWS account. */ publishRecipe(params: DataBrew.Types.PublishRecipeRequest, callback?: (err: AWSError, data: DataBrew.Types.PublishRecipeResponse) => void): Request; /** * Publishes a new major version of an AWS Glue DataBrew recipe that exists in the current AWS account. */ publishRecipe(callback?: (err: AWSError, data: DataBrew.Types.PublishRecipeResponse) => void): Request; /** * Performs a recipe step within an interactive AWS Glue DataBrew session that's currently open. */ sendProjectSessionAction(params: DataBrew.Types.SendProjectSessionActionRequest, callback?: (err: AWSError, data: DataBrew.Types.SendProjectSessionActionResponse) => void): Request; /** * Performs a recipe step within an interactive AWS Glue DataBrew session that's currently open. */ sendProjectSessionAction(callback?: (err: AWSError, data: DataBrew.Types.SendProjectSessionActionResponse) => void): Request; /** * Runs an AWS Glue DataBrew job that exists in the current AWS account. */ startJobRun(params: DataBrew.Types.StartJobRunRequest, callback?: (err: AWSError, data: DataBrew.Types.StartJobRunResponse) => void): Request; /** * Runs an AWS Glue DataBrew job that exists in the current AWS account. */ startJobRun(callback?: (err: AWSError, data: DataBrew.Types.StartJobRunResponse) => void): Request; /** * Creates an interactive session, enabling you to manipulate an AWS Glue DataBrew project. */ startProjectSession(params: DataBrew.Types.StartProjectSessionRequest, callback?: (err: AWSError, data: DataBrew.Types.StartProjectSessionResponse) => void): Request; /** * Creates an interactive session, enabling you to manipulate an AWS Glue DataBrew project. */ startProjectSession(callback?: (err: AWSError, data: DataBrew.Types.StartProjectSessionResponse) => void): Request; /** * Stops the specified job from running in the current AWS account. */ stopJobRun(params: DataBrew.Types.StopJobRunRequest, callback?: (err: AWSError, data: DataBrew.Types.StopJobRunResponse) => void): Request; /** * Stops the specified job from running in the current AWS account. */ stopJobRun(callback?: (err: AWSError, data: DataBrew.Types.StopJobRunResponse) => void): Request; /** * Adds metadata tags to an AWS Glue DataBrew resource, such as a dataset, job, project, or recipe. */ tagResource(params: DataBrew.Types.TagResourceRequest, callback?: (err: AWSError, data: DataBrew.Types.TagResourceResponse) => void): Request; /** * Adds metadata tags to an AWS Glue DataBrew resource, such as a dataset, job, project, or recipe. */ tagResource(callback?: (err: AWSError, data: DataBrew.Types.TagResourceResponse) => void): Request; /** * Removes metadata tags from an AWS Glue DataBrew resource. */ untagResource(params: DataBrew.Types.UntagResourceRequest, callback?: (err: AWSError, data: DataBrew.Types.UntagResourceResponse) => void): Request; /** * Removes metadata tags from an AWS Glue DataBrew resource. */ untagResource(callback?: (err: AWSError, data: DataBrew.Types.UntagResourceResponse) => void): Request; /** * Modifies the definition of an existing AWS Glue DataBrew dataset in the current AWS account. */ updateDataset(params: DataBrew.Types.UpdateDatasetRequest, callback?: (err: AWSError, data: DataBrew.Types.UpdateDatasetResponse) => void): Request; /** * Modifies the definition of an existing AWS Glue DataBrew dataset in the current AWS account. */ updateDataset(callback?: (err: AWSError, data: DataBrew.Types.UpdateDatasetResponse) => void): Request; /** * Modifies the definition of an existing AWS Glue DataBrew job in the current AWS account. */ updateProfileJob(params: DataBrew.Types.UpdateProfileJobRequest, callback?: (err: AWSError, data: DataBrew.Types.UpdateProfileJobResponse) => void): Request; /** * Modifies the definition of an existing AWS Glue DataBrew job in the current AWS account. */ updateProfileJob(callback?: (err: AWSError, data: DataBrew.Types.UpdateProfileJobResponse) => void): Request; /** * Modifies the definition of an existing AWS Glue DataBrew project in the current AWS account. */ updateProject(params: DataBrew.Types.UpdateProjectRequest, callback?: (err: AWSError, data: DataBrew.Types.UpdateProjectResponse) => void): Request; /** * Modifies the definition of an existing AWS Glue DataBrew project in the current AWS account. */ updateProject(callback?: (err: AWSError, data: DataBrew.Types.UpdateProjectResponse) => void): Request; /** * Modifies the definition of the latest working version of an AWS Glue DataBrew recipe in the current AWS account. */ updateRecipe(params: DataBrew.Types.UpdateRecipeRequest, callback?: (err: AWSError, data: DataBrew.Types.UpdateRecipeResponse) => void): Request; /** * Modifies the definition of the latest working version of an AWS Glue DataBrew recipe in the current AWS account. */ updateRecipe(callback?: (err: AWSError, data: DataBrew.Types.UpdateRecipeResponse) => void): Request; /** * Modifies the definition of an existing AWS Glue DataBrew recipe job in the current AWS account. */ updateRecipeJob(params: DataBrew.Types.UpdateRecipeJobRequest, callback?: (err: AWSError, data: DataBrew.Types.UpdateRecipeJobResponse) => void): Request; /** * Modifies the definition of an existing AWS Glue DataBrew recipe job in the current AWS account. */ updateRecipeJob(callback?: (err: AWSError, data: DataBrew.Types.UpdateRecipeJobResponse) => void): Request; /** * Modifies the definition of an existing AWS Glue DataBrew schedule in the current AWS account. */ updateSchedule(params: DataBrew.Types.UpdateScheduleRequest, callback?: (err: AWSError, data: DataBrew.Types.UpdateScheduleResponse) => void): Request; /** * Modifies the definition of an existing AWS Glue DataBrew schedule in the current AWS account. */ updateSchedule(callback?: (err: AWSError, data: DataBrew.Types.UpdateScheduleResponse) => void): Request; } 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 to be modified. */ Name: RecipeName; /** * An array of version identifiers to be deleted. */ RecipeVersions: RecipeVersionList; } export interface BatchDeleteRecipeVersionResponse { /** * The name of the recipe that was modified. */ Name: RecipeName; /** * Errors, if any, that were encountered when deleting 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 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 AWS 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, within an AWS Glue DataBrew dataset. */ TargetColumn: TargetColumn; } export type ConditionExpressionList = ConditionExpression[]; export type ConditionValue = string; export interface CreateDatasetRequest { /** * The name of the dataset to be created. */ Name: DatasetName; FormatOptions?: FormatOptions; Input: Input; /** * 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 - para>SSE-KMS - server-side encryption with AWS KMS-managed keys. SSE-S3 - Server-side encryption with keys managed by Amazon S3. */ EncryptionMode?: EncryptionMode; /** * The name of the job to be created. */ Name: JobName; /** * A value that enables or disables Amazon CloudWatch logging for the current AWS account. 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; /** * The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role to be assumed for this request. */ 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 CreateProfileJobResponse { /** * The name of the job that was created. */ Name: JobName; } export interface CreateProjectRequest { /** * The name of the dataset to associate this project with. */ DatasetName: DatasetName; /** * A unique name for the new project. */ Name: ProjectName; /** * The name of an existing recipe to associate with the project. */ RecipeName: RecipeName; Sample?: Sample; /** * The Amazon Resource Name (ARN) of the AWS 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 AWS KMS-managed keys. SSE-S3 - Server-side encryption with keys managed by Amazon S3. */ EncryptionMode?: EncryptionMode; /** * A unique name for the job. */ Name: JobName; /** * A value that enables or disables Amazon CloudWatch logging for the current AWS account. 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; /** * 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 AWS Identity and Access Management (IAM) role to be assumed for this request. */ RoleArn: Arn; /** * Metadata tags to apply to this job dataset. */ 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. */ 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, in cron format, when the jobs are to be run. */ CronExpression: CronExpression; /** * Metadata tags to apply to this schedule. */ Tags?: TagMap; /** * A unique name for the schedule. */ 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 DataCatalogInputDefinition { /** * The unique identifier of the AWS 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; /** * An Amazon location that AWS Glue Data Catalog can use as a temporary directory. */ TempDirectory?: S3Location; } export type DatabaseName = string; export interface Dataset { /** * The ID of the AWS account that owns the dataset. */ AccountId?: AccountId; /** * The identifier (the user name) 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; /** * Options that define how DataBrew interprets the data in the dataset. */ FormatOptions?: FormatOptions; /** * Information on how DataBrew can find the dataset, in either the AWS Glue Data Catalog or Amazon S3. */ Input: Input; /** * The last modification date and time of the dataset. */ LastModifiedDate?: _Date; /** * The identifier (the user name) of the user who last modified the dataset. */ LastModifiedBy?: LastModifiedBy; /** * The location of the data for the dataset, either Amazon S3 or the AWS Glue Data Catalog. */ Source?: Source; /** * 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 type _Date = Date; 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 to be deleted. */ Name: RecipeName; /** * The version of the recipe to be deleted. */ 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 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; 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 AWS Glue Data Catalog. */ Source?: Source; /** * 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 AWS KMS-managed keys. 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; /** * A value that indicates whether Amazon CloudWatch logging is enabled for this job. */ LogSubscription?: LogSubscription; /** * The maximum number of nodes that AWS Glue 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; /** * The DataBrew project associated with this job. */ ProjectName?: ProjectName; RecipeReference?: RecipeReference; /** * The Amazon Resource Name (ARN) of the job. */ ResourceArn?: Arn; /** * The ARN of the AWS Identity and Access Management (IAM) role that was assumed for this request. */ 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; } 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 AWS Identity and Access Management (IAM) role that was assumed for this request. */ 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. */ RecipeVersion?: RecipeVersion; } export interface DescribeRecipeResponse { /** * The identifier (user name) of the user who created the recipe. */ CreatedBy?: CreatedBy; /** * The date and time that the recipe was created. */ CreateDate?: _Date; /** * The identifier (user name) of the user who last modified the recipe. */ LastModifiedBy?: LastModifiedBy; /** * The date and time that the recipe was last modified. */ LastModifiedDate?: _Date; /** * The name of the project associated with this recipe. */ ProjectName?: ProjectName; /** * The identifier (user name) of the user who last published the recipe. */ PublishedBy?: PublishedBy; /** * The date and time when the recipe was last published. */ PublishedDate?: _Date; /** * The description of the recipe. */ Description?: RecipeDescription; /** * The name of the recipe. */ Name: RecipeName; /** * One or more steps to be performed by the recipe. Each step consists of an action, and the conditions under which the action should succeed. */ Steps?: RecipeStepList; /** * Metadata tags associated with this project. */ Tags?: TagMap; /** * The ARN of the recipe. */ ResourceArn?: Arn; /** * The recipe version identifier. */ RecipeVersion?: RecipeVersion; } export interface DescribeScheduleRequest { /** * The name of the schedule to be described. */ Name: ScheduleName; } export interface DescribeScheduleResponse { /** * The date and time that the schedule was created. */ CreateDate?: _Date; /** * The identifier (user name) of the user who created the schedule. */ CreatedBy?: CreatedBy; /** * The name or names of one or more jobs to be run by using the schedule. */ JobNames?: JobNameList; /** * The identifier (user name) of the user who last modified the schedule. */ LastModifiedBy?: LastModifiedBy; /** * The date and time that the schedule was last modified. */ LastModifiedDate?: _Date; /** * The Amazon Resource Name (ARN) of the schedule. */ ResourceArn?: Arn; /** * The date or dates and time or times, in cron format, when the jobs are to be run for the schedule. */ CronExpression?: CronExpression; /** * Metadata tags associated with this schedule. */ Tags?: TagMap; /** * The name of the schedule. */ Name: ScheduleName; } export type EncryptionKeyArn = string; export type EncryptionMode = "SSE-KMS"|"SSE-S3"|string; export type ErrorCode = string; export interface ExcelOptions { /** * Specifies one or more named sheets in the Excel file, which will be included in the dataset. */ SheetNames?: SheetNameList; /** * Specifies one or more sheet numbers in the Excel file, which will be included in the dataset. */ SheetIndexes?: SheetIndexList; } export type ExecutionTime = number; export interface FormatOptions { /** * Options that define how JSON input is to be interpreted by DataBrew. */ Json?: JsonOptions; /** * Options that define how Excel input is to be interpreted by DataBrew. */ Excel?: ExcelOptions; } export type HiddenColumnList = ColumnName[]; export interface Input { /** * The Amazon S3 location where the data is stored. */ S3InputDefinition?: S3Location; /** * The AWS Glue Data Catalog parameters for the data. */ DataCatalogInputDefinition?: DataCatalogInputDefinition; } export interface Job { /** * The ID of the AWS account that owns the job. */ AccountId?: AccountId; /** * The identifier (the user name) of the user who created the job. */ CreatedBy?: CreatedBy; /** * The date and time that the job was created. */ CreateDate?: _Date; /** * A dataset that the job is to process. */ DatasetName?: DatasetName; /** * The Amazon Resource Name (ARN) of an encryption key that is used to protect a job. */ EncryptionKeyArn?: EncryptionKeyArn; /** * The encryption mode for the job, which can be one of the following: SSE-KMS - Server-side encryption with AWS KMS-managed keys. SSE-S3 - Server-side encryption with keys managed by Amazon S3. */ EncryptionMode?: EncryptionMode; /** * The unique name of the job. */ Name: JobName; /** * The job type of the job, which must be one of the following: PROFILE - A job to analyze a dataset, to determine its size, data types, data distribution, and more. RECIPE - A job to apply one or more transformations to a dataset. */ Type?: JobType; /** * The identifier (the user name) of the user who last modified the job. */ LastModifiedBy?: LastModifiedBy; /** * The modification date and time of the job. */ LastModifiedDate?: _Date; /** * The current status of Amazon CloudWatch logging for the job. */ LogSubscription?: LogSubscription; /** * The maximum number of nodes that can be consumed 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 output from running the job. */ Outputs?: OutputList; /** * The name of the project that the job is associated with. */ ProjectName?: ProjectName; /** * A set of steps that the job runs. */ RecipeReference?: RecipeReference; /** * The unique Amazon Resource Name (ARN) for the job. */ ResourceArn?: Arn; /** * The Amazon Resource Name (ARN) of the role that will be assumed for this job. */ RoleArn?: Arn; /** * 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; /** * Metadata tags that have been applied to the job. */ Tags?: TagMap; } export type JobList = Job[]; export type JobName = string; export type JobNameList = JobName[]; export interface JobRun { /** * 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 a job run consumed resources. */ ExecutionTime?: ExecutionTime; /** * The name of the job being processed during this run. */ JobName?: JobName; /** * 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; /** * The set of steps processed by the job. */ RecipeReference?: RecipeReference; /** * The identifier (the user name) of the user who initiated the job run. */ StartedBy?: StartedBy; /** * The date and time when the job run began. */ StartedOn?: _Date; } export type JobRunErrorMessage = string; export type JobRunId = string; export type JobRunList = JobRun[]; export type JobRunState = "STARTING"|"RUNNING"|"STOPPING"|"STOPPED"|"SUCCEEDED"|"FAILED"|"TIMEOUT"|string; export type JobType = "PROFILE"|"RECIPE"|string; export interface JsonOptions { /** * A value that specifies whether JSON input contains embedded new line characters. */ MultiLine?: MultiLine; } export type Key = string; export type LastModifiedBy = string; export interface ListDatasetsRequest { /** * The maximum number of results to return in this request. */ MaxResults?: MaxResults100; /** * A token generated by DataBrew that specifies where to continue pagination if a previous request was truncated. To get the next set of pages, pass in the NextToken value from the response object of the previous page call. */ NextToken?: NextToken; } export interface ListDatasetsResponse { /** * A list of datasets that are defined in the current AWS account. */ Datasets: DatasetList; /** * A token generated by DataBrew that specifies where to continue pagination if a previous request was truncated. To obtain the next set of pages, pass in the NextToken from the response object of the previous page call. */ NextToken?: NextToken; } export interface ListJobRunsRequest { /** * The name of the job. */ Name: JobName; /** * The maximum number of results to return in this request. */ MaxResults?: MaxResults100; /** * A token generated by AWS Glue DataBrew that specifies where to continue pagination if a previous request was truncated. To get the next set of pages, pass in the NextToken value from the response object of the previous page call. */ NextToken?: NextToken; } export interface ListJobRunsResponse { /** * A list of job runs that have occurred for the specified job. */ JobRuns: JobRunList; /** * A token generated by DataBrew that specifies where to continue pagination if a previous request was truncated. To obtain the next set of pages, pass in the NextToken from the response object of the previous page call. */ NextToken?: NextToken; } export interface ListJobsRequest { /** * The name of a dataset. Using this parameter indicates to return only those jobs that act on the specified dataset. */ DatasetName?: DatasetName; /** * The maximum number of results to return in this request. */ MaxResults?: MaxResults100; /** * A token generated by DataBrew that specifies where to continue pagination if a previous request was truncated. To get the next set of pages, pass in the NextToken value from the response object of the previous page call. */ NextToken?: NextToken; /** * The name of a project. Using this parameter indicates to return only those jobs that are associated with the specified project. */ ProjectName?: ProjectName; } export interface ListJobsResponse { /** * A list of jobs that are defined in the current AWS account. */ Jobs: JobList; /** * A token generated by DataBrew that specifies where to continue pagination if a previous request was truncated. To obtain the next set of pages, pass in the NextToken from the response object of the previous page call. */ NextToken?: NextToken; } export interface ListProjectsRequest { /** * A pagination token that can be used in a subsequent request. */ NextToken?: NextToken; /** * The maximum number of results to return in this request. */ MaxResults?: MaxResults100; } export interface ListProjectsResponse { /** * A list of projects that are defined in the current AWS account. */ Projects: ProjectList; /** * A token generated by DataBrew that specifies where to continue pagination if a previous request was truncated. To get the next set of pages, pass in the NextToken value from the response object of the previous page call. */ NextToken?: NextToken; } export interface ListRecipeVersionsRequest { /** * The maximum number of results to return in this request. */ MaxResults?: MaxResults100; /** * A pagination token that can be used in a subsequent request. */ NextToken?: NextToken; /** * The name of the recipe for which to return version information. */ Name: RecipeName; } export interface ListRecipeVersionsResponse { /** * A token generated by DataBrew that specifies where to continue pagination if a previous request was truncated. To get the next set of pages, pass in the NextToken value from the response object of the previous page call. */ NextToken?: NextToken; /** * A list of versions for the specified recipe. */ Recipes: RecipeList; } export interface ListRecipesRequest { /** * The maximum number of results to return in this request. */ MaxResults?: MaxResults100; /** * A pagination token that can be used in a subsequent request. */ NextToken?: NextToken; /** * A version identifier. Using this parameter indicates to return only those recipes that have this version identifier. */ RecipeVersion?: RecipeVersion; } export interface ListRecipesResponse { /** * A list of recipes that are defined in the current AWS account. */ Recipes: RecipeList; /** * A token generated by DataBrew that specifies where to continue pagination if a previous request was truncated. To get the next set of pages, pass in the NextToken value from the response object of the previous page call. */ NextToken?: NextToken; } export interface ListSchedulesRequest { /** * The name of the job that these schedules apply to. */ JobName?: JobName; /** * The maximum number of results to return in this request. */ MaxResults?: MaxResults100; /** * A pagination token that can be used in a subsequent request. */ NextToken?: NextToken; } export interface ListSchedulesResponse { /** * A list of schedules in the current AWS account. */ Schedules: ScheduleList; /** * A token generated by DataBrew that specifies where to continue pagination if a previous request was truncated. To get the next set of pages, pass in the NextToken value from the response object of the previous page call. */ NextToken?: NextToken; } export interface ListTagsForResourceRequest { /** * The Amazon Resource Name (ARN) string that uniquely identifies the DataBrew resource. */ ResourceArn: Arn; } export interface ListTagsForResourceResponse { /** * A list of tags associated with the DataBrew resource. */ Tags?: TagMap; } export type LogGroupName = string; export type LogSubscription = "ENABLE"|"DISABLE"|string; export type MaxCapacity = number; export type MaxResults100 = number; export type MaxRetries = number; export type MultiLine = boolean; export type NextToken = string; export type OpenedBy = string; export type Operation = string; export interface Output { /** * The compression algorithm used to compress the output text of the job. */ CompressionFormat?: CompressionFormat; /** * The data format of the output of the job. */ Format?: OutputFormat; /** * The names of one or more partition columns for the output of the job. */ PartitionColumns?: ColumnNameList; /** * The location in Amazon S3 where the job writes its output. */ Location: S3Location; /** * A value that, if true, means that any data in the location specified for output is overwritten with new output. */ Overwrite?: OverwriteOutput; } export type OutputFormat = "CSV"|"JSON"|"PARQUET"|"GLUEPARQUET"|"AVRO"|"ORC"|"XML"|string; export type OutputList = Output[]; export type OverwriteOutput = boolean; export type ParameterMap = {[key: string]: ParameterValue}; export type ParameterName = string; export type ParameterValue = string; export type Preview = boolean; export interface Project { /** * The ID of the AWS account that owns the project. */ AccountId?: AccountId; /** * The date and time that the project was created. */ CreateDate?: _Date; /** * The identifier (the user name) of the user who crated the project. */ CreatedBy?: CreatedBy; /** * The dataset that the project is to act upon. */ DatasetName?: DatasetName; /** * The last modification date and time for the project. */ LastModifiedDate?: _Date; /** * The identifier (user name) of the user who last modified the project. */ LastModifiedBy?: LastModifiedBy; /** * The unique name of a project. */ Name: ProjectName; /** * The name of a recipe that will be developed during a project session. */ RecipeName: RecipeName; /** * The Amazon Resource Name (ARN) for the project. */ ResourceArn?: Arn; /** * The sample size and sampling type to apply to the data. If this parameter isn't specified, then the sample will consiste of the first 500 rows from the dataset. */ Sample?: Sample; /** * Metadata tags that have been applied to the project. */ Tags?: TagMap; /** * The Amazon Resource Name (ARN) of the role that will be assumed for this project. */ RoleArn?: Arn; /** * The identifier (the 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 type ProjectList = Project[]; export type ProjectName = string; export interface PublishRecipeRequest { /** * A description of the recipe to be published, for this version of the recipe. */ Description?: RecipeDescription; /** * The name of the recipe to be published. */ Name: RecipeName; } export interface PublishRecipeResponse { /** * The name of the recipe that you published. */ Name: RecipeName; } export type PublishedBy = string; export interface Recipe { /** * The identifier (the user name) of the user who created the recipe. */ CreatedBy?: CreatedBy; /** * The date and time that the recipe was created. */ CreateDate?: _Date; /** * The identifier (user name) of the user who last modified the recipe. */ LastModifiedBy?: LastModifiedBy; /** * The last modification date and time of the recipe. */ LastModifiedDate?: _Date; /** * The name of the project that the recipe is associated with. */ ProjectName?: ProjectName; /** * The identifier (the user name) of the user who published the recipe. */ PublishedBy?: PublishedBy; /** * The date and time when the recipe was published. */ PublishedDate?: _Date; /** * The description of the recipe. */ Description?: RecipeDescription; /** * The unique name for the recipe. */ Name: RecipeName; /** * The Amazon Resource Name (ARN) for the recipe. */ ResourceArn?: Arn; /** * A list of steps that are defined by the recipe. */ Steps?: RecipeStepList; /** * Metadata tags that have been applied to the recipe. */ Tags?: TagMap; /** * The identifier for the version for the recipe. */ RecipeVersion?: RecipeVersion; } export interface RecipeAction { /** * The name of a valid DataBrew transformation to be performed on the data. */ Operation: Operation; /** * Contextual parameters for the transformation. */ Parameters?: ParameterMap; } export type RecipeDescription = string; export type RecipeErrorList = RecipeVersionErrorDetail[]; export type RecipeErrorMessage = string; export type RecipeList = Recipe[]; export type RecipeName = string; export interface RecipeReference { /** * The name of the recipe. */ Name: RecipeName; /** * The identifier for the version for the recipe. */ RecipeVersion?: RecipeVersion; } export interface RecipeStep { /** * The particular action to be performed in the recipe step. */ Action: RecipeAction; /** * One or more conditions that must be met, in order for the recipe step to succeed. All of the conditions in the array must be met. In other words, all of the conditions must be combined using a logical AND operation. */ ConditionExpressions?: ConditionExpressionList; } export type RecipeStepList = RecipeStep[]; export type RecipeVersion = string; export interface RecipeVersionErrorDetail { /** * The HTTP status code for the error. */ ErrorCode?: ErrorCode; /** * The text of the error message. */ ErrorMessage?: RecipeErrorMessage; /** * The identifier for the recipe version associated with this error. */ RecipeVersion?: RecipeVersion; } export type RecipeVersionList = RecipeVersion[]; export type Result = string; export interface S3Location { /** * The S3 bucket name. */ Bucket: Bucket; /** * The unique name of the object in the bucket. */ Key?: Key; } export interface Sample { /** * The number of rows in the sample. */ Size?: SampleSize; /** * The way in which DataBrew obtains rows from a dataset. */ Type: SampleType; } export type SampleSize = number; export type SampleType = "FIRST_N"|"LAST_N"|"RANDOM"|string; export interface Schedule { /** * The ID of the AWS account that owns the schedule. */ AccountId?: AccountId; /** * The identifier (the user name) of the user who created the schedule. */ CreatedBy?: CreatedBy; /** * The date and time that the schedule was created. */ CreateDate?: _Date; /** * A list of jobs to be run, according to the schedule. */ JobNames?: JobNameList; /** * The identifier (the user name) of the user who last modified the schedule. */ LastModifiedBy?: LastModifiedBy; /** * The date and time when the schedule was last modified. */ LastModifiedDate?: _Date; /** * The Amazon Resource Name (ARN) of the schedule. */ ResourceArn?: Arn; /** * The date(s) and time(s), in cron format, when the job will run. */ CronExpression?: CronExpression; /** * Metadata tags that have been applied to the schedule. */ Tags?: TagMap; /** * The name of the schedule. */ Name: ScheduleName; } export type ScheduleList = Schedule[]; export type ScheduleName = string; export interface SendProjectSessionActionRequest { /** * Returns the result of the recipe step, without applying it. The result isn't added to the view frame stack. */ Preview?: Preview; /** * The name of the project to apply the action to. */ Name: ProjectName; RecipeStep?: RecipeStep; /** * The index from which to preview a step. This index is used to preview the result of steps that have already been applied, so that the resulting view frame is from earlier in the view frame stack. */ StepIndex?: StepIndex; /** * A unique identifier for an interactive session that's currently open and ready for work. The action will be performed on this session. */ ClientSessionId?: ClientSessionId; ViewFrame?: ViewFrame; } export interface SendProjectSessionActionResponse { /** * A message indicating the result of performing the action. */ Result?: Result; /** * The name of the project that was affected by the action. */ Name: ProjectName; /** * A unique identifier for the action that was performed. */ ActionId?: ActionId; } export type SessionStatus = "ASSIGNED"|"FAILED"|"INITIALIZING"|"PROVISIONING"|"READY"|"RECYCLING"|"ROTATING"|"TERMINATED"|"TERMINATING"|"UPDATING"|string; export type SheetIndex = number; export type SheetIndexList = SheetIndex[]; export type SheetName = string; export type SheetNameList = SheetName[]; export type Source = "S3"|"DATA-CATALOG"|string; export type StartColumnIndex = number; export interface StartJobRunRequest { /** * The name of the job to be run. */ Name: JobName; } export interface StartJobRunResponse { /** * A system-generated identifier for this particular job run. */ RunId: JobRunId; } export interface StartProjectSessionRequest { /** * The name of the project to act upon. */ Name: ProjectName; /** * A value that, if true, enables you to take control of a session, even if a different client is currently accessing the project. */ AssumeControl?: AssumeControl; } export interface StartProjectSessionResponse { /** * The name of the project to be acted upon. */ Name: ProjectName; /** * A system-generated identifier for the session. */ ClientSessionId?: ClientSessionId; } export type StartedBy = string; export type StepIndex = number; export interface StopJobRunRequest { /** * The name of the job to be stopped. */ Name: JobName; /** * The ID of the job run to be stopped. */ RunId: JobRunId; } export interface StopJobRunResponse { /** * The ID of the job run that you stopped. */ RunId: JobRunId; } export type TableName = string; export type TagKey = string; export type TagKeyList = TagKey[]; export type TagMap = {[key: string]: TagValue}; export interface TagResourceRequest { /** * The DataBrew resource to which tags should be added. The value for this parameter is an Amazon Resource Name (ARN). For DataBrew, you can tag a dataset, a job, a project, or a recipe. */ ResourceArn: Arn; /** * One or more tags to be assigned to the resource. */ Tags: TagMap; } export interface TagResourceResponse { } export type TagValue = string; export type TargetColumn = string; export type Timeout = number; export interface UntagResourceRequest { /** * An DataBrew resource from which you want to remove a tag or tags. The value for this parameter is an Amazon Resource Name (ARN). */ ResourceArn: Arn; /** * The tag keys (names) of one or more tags to be removed. */ TagKeys: TagKeyList; } export interface UntagResourceResponse { } export interface UpdateDatasetRequest { /** * The name of the dataset to be updated. */ Name: DatasetName; FormatOptions?: FormatOptions; Input: Input; } export interface UpdateDatasetResponse { /** * The name of the dataset that you updated. */ Name: DatasetName; } export interface UpdateProfileJobRequest { /** * 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 AWS KMS-managed keys. SSE-S3 - Server-side encryption with keys managed by Amazon S3. */ EncryptionMode?: EncryptionMode; /** * The name of the job to be updated. */ Name: JobName; /** * A value that enables or disables Amazon CloudWatch logging for the current AWS account. 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; /** * The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role to be assumed for this request. */ RoleArn: Arn; /** * 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 UpdateProfileJobResponse { /** * The name of the job that was updated. */ Name: JobName; } export interface UpdateProjectRequest { Sample?: Sample; /** * The Amazon Resource Name (ARN) of the IAM role to be assumed for this request. */ RoleArn: Arn; /** * The name of the project to be updated. */ Name: ProjectName; } export interface UpdateProjectResponse { /** * The date and time that the project was last modified. */ LastModifiedDate?: _Date; /** * The name of the project that you updated. */ Name: ProjectName; } export interface UpdateRecipeJobRequest { /** * 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 AWS KMS-managed keys. SSE-S3 - Server-side encryption with keys managed by Amazon S3. */ EncryptionMode?: EncryptionMode; /** * The name of the job to update. */ Name: JobName; /** * A value that enables or disables Amazon CloudWatch logging for the current AWS account. 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; /** * The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role to be assumed for this request. */ RoleArn: Arn; /** * 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 UpdateRecipeJobResponse { /** * The name of the job that you updated. */ Name: JobName; } export interface UpdateRecipeRequest { /** * A description of the recipe. */ Description?: RecipeDescription; /** * The name of the recipe to be updated. */ Name: RecipeName; /** * One or more steps to be performed by the recipe. Each step consists of an action, and the conditions under which the action should succeed. */ Steps?: RecipeStepList; } export interface UpdateRecipeResponse { /** * The name of the recipe that was updated. */ Name: RecipeName; } export interface UpdateScheduleRequest { /** * The name or names of one or more jobs to be run for this schedule. */ JobNames?: JobNameList; /** * The date or dates and time or times, in cron format, when the jobs are to be run. */ CronExpression: CronExpression; /** * The name of the schedule to update. */ Name: ScheduleName; } export interface UpdateScheduleResponse { /** * The name of the schedule that was updated. */ Name: ScheduleName; } export interface ViewFrame { /** * The starting index for the range of columns to return in the view frame. */ StartColumnIndex: StartColumnIndex; /** * The number of columns to include in the view frame, beginning with the StartColumnIndex value and ignoring any columns in the HiddenColumns list. */ ColumnRange?: ColumnRange; /** * A list of columns to hide in the view frame. */ HiddenColumns?: HiddenColumnList; } /** * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. */ export type apiVersion = "2017-07-25"|"latest"|string; export interface ClientApiVersions { /** * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. */ apiVersion?: apiVersion; } export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; /** * Contains interfaces for use with the DataBrew client. */ export import Types = DataBrew; } export = DataBrew;