Hi there! Are you looking for the official Deno documentation? Try docs.deno.com for all your Deno learning needs.

DataBrew

import { DataBrew } from "https://aws-api.deno.dev/v0.4/services/databrew.ts?docs=full";
class DataBrew {
constructor(apiFactory: client.ApiFactory);
async batchDeleteRecipeVersion(params: BatchDeleteRecipeVersionRequest, opts?: client.RequestOptions): Promise<BatchDeleteRecipeVersionResponse>;
async createDataset(params: CreateDatasetRequest, opts?: client.RequestOptions): Promise<CreateDatasetResponse>;
async createProfileJob(params: CreateProfileJobRequest, opts?: client.RequestOptions): Promise<CreateProfileJobResponse>;
async createProject(params: CreateProjectRequest, opts?: client.RequestOptions): Promise<CreateProjectResponse>;
async createRecipe(params: CreateRecipeRequest, opts?: client.RequestOptions): Promise<CreateRecipeResponse>;
async createRecipeJob(params: CreateRecipeJobRequest, opts?: client.RequestOptions): Promise<CreateRecipeJobResponse>;
async createRuleset(params: CreateRulesetRequest, opts?: client.RequestOptions): Promise<CreateRulesetResponse>;
async createSchedule(params: CreateScheduleRequest, opts?: client.RequestOptions): Promise<CreateScheduleResponse>;
async deleteDataset(params: DeleteDatasetRequest, opts?: client.RequestOptions): Promise<DeleteDatasetResponse>;
async deleteJob(params: DeleteJobRequest, opts?: client.RequestOptions): Promise<DeleteJobResponse>;
async deleteProject(params: DeleteProjectRequest, opts?: client.RequestOptions): Promise<DeleteProjectResponse>;
async deleteRecipeVersion(params: DeleteRecipeVersionRequest, opts?: client.RequestOptions): Promise<DeleteRecipeVersionResponse>;
async deleteRuleset(params: DeleteRulesetRequest, opts?: client.RequestOptions): Promise<DeleteRulesetResponse>;
async deleteSchedule(params: DeleteScheduleRequest, opts?: client.RequestOptions): Promise<DeleteScheduleResponse>;
async describeDataset(params: DescribeDatasetRequest, opts?: client.RequestOptions): Promise<DescribeDatasetResponse>;
async describeJob(params: DescribeJobRequest, opts?: client.RequestOptions): Promise<DescribeJobResponse>;
async describeJobRun(params: DescribeJobRunRequest, opts?: client.RequestOptions): Promise<DescribeJobRunResponse>;
async describeProject(params: DescribeProjectRequest, opts?: client.RequestOptions): Promise<DescribeProjectResponse>;
async describeRecipe(params: DescribeRecipeRequest, opts?: client.RequestOptions): Promise<DescribeRecipeResponse>;
async describeRuleset(params: DescribeRulesetRequest, opts?: client.RequestOptions): Promise<DescribeRulesetResponse>;
async describeSchedule(params: DescribeScheduleRequest, opts?: client.RequestOptions): Promise<DescribeScheduleResponse>;
async listDatasets(params?: ListDatasetsRequest, opts?: client.RequestOptions): Promise<ListDatasetsResponse>;
async listJobRuns(params: ListJobRunsRequest, opts?: client.RequestOptions): Promise<ListJobRunsResponse>;
async listJobs(params?: ListJobsRequest, opts?: client.RequestOptions): Promise<ListJobsResponse>;
async listProjects(params?: ListProjectsRequest, opts?: client.RequestOptions): Promise<ListProjectsResponse>;
async listRecipes(params?: ListRecipesRequest, opts?: client.RequestOptions): Promise<ListRecipesResponse>;
async listRecipeVersions(params: ListRecipeVersionsRequest, opts?: client.RequestOptions): Promise<ListRecipeVersionsResponse>;
async listRulesets(params?: ListRulesetsRequest, opts?: client.RequestOptions): Promise<ListRulesetsResponse>;
async listSchedules(params?: ListSchedulesRequest, opts?: client.RequestOptions): Promise<ListSchedulesResponse>;
async listTagsForResource(params: ListTagsForResourceRequest, opts?: client.RequestOptions): Promise<ListTagsForResourceResponse>;
async publishRecipe(params: PublishRecipeRequest, opts?: client.RequestOptions): Promise<PublishRecipeResponse>;
async sendProjectSessionAction(params: SendProjectSessionActionRequest, opts?: client.RequestOptions): Promise<SendProjectSessionActionResponse>;
async startJobRun(params: StartJobRunRequest, opts?: client.RequestOptions): Promise<StartJobRunResponse>;
async startProjectSession(params: StartProjectSessionRequest, opts?: client.RequestOptions): Promise<StartProjectSessionResponse>;
async stopJobRun(params: StopJobRunRequest, opts?: client.RequestOptions): Promise<StopJobRunResponse>;
async tagResource(params: TagResourceRequest, opts?: client.RequestOptions): Promise<void>;
async untagResource(params: UntagResourceRequest, opts?: client.RequestOptions): Promise<void>;
async updateDataset(params: UpdateDatasetRequest, opts?: client.RequestOptions): Promise<UpdateDatasetResponse>;
async updateProfileJob(params: UpdateProfileJobRequest, opts?: client.RequestOptions): Promise<UpdateProfileJobResponse>;
async updateProject(params: UpdateProjectRequest, opts?: client.RequestOptions): Promise<UpdateProjectResponse>;
async updateRecipe(params: UpdateRecipeRequest, opts?: client.RequestOptions): Promise<UpdateRecipeResponse>;
async updateRecipeJob(params: UpdateRecipeJobRequest, opts?: client.RequestOptions): Promise<UpdateRecipeJobResponse>;
async updateRuleset(params: UpdateRulesetRequest, opts?: client.RequestOptions): Promise<UpdateRulesetResponse>;
async updateSchedule(params: UpdateScheduleRequest, opts?: client.RequestOptions): Promise<UpdateScheduleResponse>;
 
static ApiMetadata: client.ApiMetadata;
}

§Constructors

§
new DataBrew(apiFactory: client.ApiFactory)
[src]

§Methods

§
batchDeleteRecipeVersion(params: BatchDeleteRecipeVersionRequest, opts?: client.RequestOptions): Promise<BatchDeleteRecipeVersionResponse>
[src]

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.

§
createDataset(params: CreateDatasetRequest, opts?: client.RequestOptions): Promise<CreateDatasetResponse>
[src]

Creates a new DataBrew dataset.

§
createProfileJob(params: CreateProfileJobRequest, opts?: client.RequestOptions): Promise<CreateProfileJobResponse>
[src]

Creates a new job to analyze a dataset and create its data profile.

§
createProject(params: CreateProjectRequest, opts?: client.RequestOptions): Promise<CreateProjectResponse>
[src]

Creates a new DataBrew project.

§
createRecipe(params: CreateRecipeRequest, opts?: client.RequestOptions): Promise<CreateRecipeResponse>
[src]

Creates a new DataBrew recipe.

§
createRecipeJob(params: CreateRecipeJobRequest, opts?: client.RequestOptions): Promise<CreateRecipeJobResponse>
[src]

Creates a new job to transform input data, using steps defined in an existing Glue DataBrew recipe

§
createRuleset(params: CreateRulesetRequest, opts?: client.RequestOptions): Promise<CreateRulesetResponse>
[src]

Creates a new ruleset that can be used in a profile job to validate the data quality of a dataset.

§
createSchedule(params: CreateScheduleRequest, opts?: client.RequestOptions): Promise<CreateScheduleResponse>
[src]

Creates a new schedule for one or more DataBrew jobs. Jobs can be run at a specific date and time, or at regular intervals.

§
deleteDataset(params: DeleteDatasetRequest, opts?: client.RequestOptions): Promise<DeleteDatasetResponse>
[src]

Deletes a dataset from DataBrew.

§
deleteJob(params: DeleteJobRequest, opts?: client.RequestOptions): Promise<DeleteJobResponse>
[src]

Deletes the specified DataBrew job.

§
deleteProject(params: DeleteProjectRequest, opts?: client.RequestOptions): Promise<DeleteProjectResponse>
[src]

Deletes an existing DataBrew project.

§
deleteRecipeVersion(params: DeleteRecipeVersionRequest, opts?: client.RequestOptions): Promise<DeleteRecipeVersionResponse>
[src]

Deletes a single version of a DataBrew recipe.

§
deleteRuleset(params: DeleteRulesetRequest, opts?: client.RequestOptions): Promise<DeleteRulesetResponse>
[src]

Deletes a ruleset.

§
deleteSchedule(params: DeleteScheduleRequest, opts?: client.RequestOptions): Promise<DeleteScheduleResponse>
[src]

Deletes the specified DataBrew schedule.

§
describeDataset(params: DescribeDatasetRequest, opts?: client.RequestOptions): Promise<DescribeDatasetResponse>
[src]

Returns the definition of a specific DataBrew dataset.

§
describeJob(params: DescribeJobRequest, opts?: client.RequestOptions): Promise<DescribeJobResponse>
[src]

Returns the definition of a specific DataBrew job.

§
describeJobRun(params: DescribeJobRunRequest, opts?: client.RequestOptions): Promise<DescribeJobRunResponse>
[src]

Represents one run of a DataBrew job.

§
describeProject(params: DescribeProjectRequest, opts?: client.RequestOptions): Promise<DescribeProjectResponse>
[src]

Returns the definition of a specific DataBrew project.

§
describeRecipe(params: DescribeRecipeRequest, opts?: client.RequestOptions): Promise<DescribeRecipeResponse>
[src]

Returns the definition of a specific DataBrew recipe corresponding to a particular version.

§
describeRuleset(params: DescribeRulesetRequest, opts?: client.RequestOptions): Promise<DescribeRulesetResponse>
[src]

Retrieves detailed information about the ruleset.

§
describeSchedule(params: DescribeScheduleRequest, opts?: client.RequestOptions): Promise<DescribeScheduleResponse>
[src]

Returns the definition of a specific DataBrew schedule.

§
listDatasets(params?: ListDatasetsRequest, opts?: client.RequestOptions): Promise<ListDatasetsResponse>
[src]

Lists all of the DataBrew datasets.

§
listJobRuns(params: ListJobRunsRequest, opts?: client.RequestOptions): Promise<ListJobRunsResponse>
[src]

Lists all of the previous runs of a particular DataBrew job.

§
listJobs(params?: ListJobsRequest, opts?: client.RequestOptions): Promise<ListJobsResponse>
[src]

Lists all of the DataBrew jobs that are defined.

§
listProjects(params?: ListProjectsRequest, opts?: client.RequestOptions): Promise<ListProjectsResponse>
[src]

Lists all of the DataBrew projects that are defined.

§
listRecipes(params?: ListRecipesRequest, opts?: client.RequestOptions): Promise<ListRecipesResponse>
[src]

Lists all of the DataBrew recipes that are defined.

§
listRecipeVersions(params: ListRecipeVersionsRequest, opts?: client.RequestOptions): Promise<ListRecipeVersionsResponse>
[src]

Lists the versions of a particular DataBrew recipe, except for LATEST_WORKING.

§
listRulesets(params?: ListRulesetsRequest, opts?: client.RequestOptions): Promise<ListRulesetsResponse>
[src]

List all rulesets available in the current account or rulesets associated with a specific resource (dataset).

§
listSchedules(params?: ListSchedulesRequest, opts?: client.RequestOptions): Promise<ListSchedulesResponse>
[src]

Lists the DataBrew schedules that are defined.

§
listTagsForResource(params: ListTagsForResourceRequest, opts?: client.RequestOptions): Promise<ListTagsForResourceResponse>
[src]

Lists all the tags for a DataBrew resource.

§
publishRecipe(params: PublishRecipeRequest, opts?: client.RequestOptions): Promise<PublishRecipeResponse>
[src]

Publishes a new version of a DataBrew recipe.

§
sendProjectSessionAction(params: SendProjectSessionActionRequest, opts?: client.RequestOptions): Promise<SendProjectSessionActionResponse>
[src]

Performs a recipe step within an interactive DataBrew session that's currently open.

§
startJobRun(params: StartJobRunRequest, opts?: client.RequestOptions): Promise<StartJobRunResponse>
[src]

Runs a DataBrew job.

§
startProjectSession(params: StartProjectSessionRequest, opts?: client.RequestOptions): Promise<StartProjectSessionResponse>
[src]

Creates an interactive session, enabling you to manipulate data in a DataBrew project.

§
stopJobRun(params: StopJobRunRequest, opts?: client.RequestOptions): Promise<StopJobRunResponse>
[src]

Stops a particular run of a job.

§
tagResource(params: TagResourceRequest, opts?: client.RequestOptions): Promise<void>
[src]

Adds metadata tags to a DataBrew resource, such as a dataset, project, recipe, job, or schedule.

§
untagResource(params: UntagResourceRequest, opts?: client.RequestOptions): Promise<void>
[src]

Removes metadata tags from a DataBrew resource.

§
updateDataset(params: UpdateDatasetRequest, opts?: client.RequestOptions): Promise<UpdateDatasetResponse>
[src]

Modifies the definition of an existing DataBrew dataset.

§
updateProfileJob(params: UpdateProfileJobRequest, opts?: client.RequestOptions): Promise<UpdateProfileJobResponse>
[src]

Modifies the definition of an existing profile job.

§
updateProject(params: UpdateProjectRequest, opts?: client.RequestOptions): Promise<UpdateProjectResponse>
[src]

Modifies the definition of an existing DataBrew project.

§
updateRecipe(params: UpdateRecipeRequest, opts?: client.RequestOptions): Promise<UpdateRecipeResponse>
[src]

Modifies the definition of the LATEST_WORKING version of a DataBrew recipe.

§
updateRecipeJob(params: UpdateRecipeJobRequest, opts?: client.RequestOptions): Promise<UpdateRecipeJobResponse>
[src]

Modifies the definition of an existing DataBrew recipe job.

§
updateRuleset(params: UpdateRulesetRequest, opts?: client.RequestOptions): Promise<UpdateRulesetResponse>
[src]

Updates specified ruleset.

§
updateSchedule(params: UpdateScheduleRequest, opts?: client.RequestOptions): Promise<UpdateScheduleResponse>
[src]

Modifies the definition of an existing DataBrew schedule.

§Static Properties