DataBrew

import { DataBrew } from "https://aws-api.deno.dev/v0.1/services/databrew.ts?docs=full";

class DataBrew {

constructor(apiFactory: client.ApiFactory);

async batchDeleteRecipeVersion(params: BatchDeleteRecipeVersionRequest): Promise<BatchDeleteRecipeVersionResponse>;

async createDataset(params: CreateDatasetRequest): Promise<CreateDatasetResponse>;

async createProfileJob(params: CreateProfileJobRequest): Promise<CreateProfileJobResponse>;

async createProject(params: CreateProjectRequest): Promise<CreateProjectResponse>;

async createRecipe(params: CreateRecipeRequest): Promise<CreateRecipeResponse>;

async createRecipeJob(params: CreateRecipeJobRequest): Promise<CreateRecipeJobResponse>;

async createSchedule(params: CreateScheduleRequest): Promise<CreateScheduleResponse>;

async deleteDataset(params: DeleteDatasetRequest): Promise<DeleteDatasetResponse>;

async deleteJob(params: DeleteJobRequest): Promise<DeleteJobResponse>;

async deleteProject(params: DeleteProjectRequest): Promise<DeleteProjectResponse>;

async deleteRecipeVersion(params: DeleteRecipeVersionRequest): Promise<DeleteRecipeVersionResponse>;

async deleteSchedule(params: DeleteScheduleRequest): Promise<DeleteScheduleResponse>;

async describeDataset(params: DescribeDatasetRequest): Promise<DescribeDatasetResponse>;

async describeJob(params: DescribeJobRequest): Promise<DescribeJobResponse>;

async describeJobRun(params: DescribeJobRunRequest): Promise<DescribeJobRunResponse>;

async describeProject(params: DescribeProjectRequest): Promise<DescribeProjectResponse>;

async describeRecipe(params: DescribeRecipeRequest): Promise<DescribeRecipeResponse>;

async describeSchedule(params: DescribeScheduleRequest): Promise<DescribeScheduleResponse>;

async listDatasets(params?: ListDatasetsRequest): Promise<ListDatasetsResponse>;

async listJobRuns(params: ListJobRunsRequest): Promise<ListJobRunsResponse>;

async listJobs(params?: ListJobsRequest): Promise<ListJobsResponse>;

async listProjects(params?: ListProjectsRequest): Promise<ListProjectsResponse>;

async listRecipes(params?: ListRecipesRequest): Promise<ListRecipesResponse>;

async listRecipeVersions(params: ListRecipeVersionsRequest): Promise<ListRecipeVersionsResponse>;

async listSchedules(params?: ListSchedulesRequest): Promise<ListSchedulesResponse>;

async listTagsForResource(params: ListTagsForResourceRequest): Promise<ListTagsForResourceResponse>;

async publishRecipe(params: PublishRecipeRequest): Promise<PublishRecipeResponse>;

async sendProjectSessionAction(params: SendProjectSessionActionRequest): Promise<SendProjectSessionActionResponse>;

async startJobRun(params: StartJobRunRequest): Promise<StartJobRunResponse>;

async startProjectSession(params: StartProjectSessionRequest): Promise<StartProjectSessionResponse>;

async stopJobRun(params: StopJobRunRequest): Promise<StopJobRunResponse>;

async tagResource(params: TagResourceRequest): Promise<void>;

async untagResource(params: UntagResourceRequest): Promise<void>;

async updateDataset(params: UpdateDatasetRequest): Promise<UpdateDatasetResponse>;

async updateProfileJob(params: UpdateProfileJobRequest): Promise<UpdateProfileJobResponse>;

async updateProject(params: UpdateProjectRequest): Promise<UpdateProjectResponse>;

async updateRecipe(params: UpdateRecipeRequest): Promise<UpdateRecipeResponse>;

async updateRecipeJob(params: UpdateRecipeJobRequest): Promise<UpdateRecipeJobResponse>;

async updateSchedule(params: UpdateScheduleRequest): Promise<UpdateScheduleResponse>;

static ApiMetadata: client.ApiMetadata;

}

§Constructors

new DataBrew(apiFactory: client.ApiFactory)

[src]

§Methods

batchDeleteRecipeVersion(params: BatchDeleteRecipeVersionRequest): 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): Promise<CreateDatasetResponse>

[src]

Creates a new DataBrew dataset.

createProfileJob(params: CreateProfileJobRequest): Promise<CreateProfileJobResponse>

[src]

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

createProject(params: CreateProjectRequest): Promise<CreateProjectResponse>

[src]

Creates a new DataBrew project.

createRecipe(params: CreateRecipeRequest): Promise<CreateRecipeResponse>

[src]

Creates a new DataBrew recipe.

createRecipeJob(params: CreateRecipeJobRequest): Promise<CreateRecipeJobResponse>

[src]

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

createSchedule(params: CreateScheduleRequest): 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): Promise<DeleteDatasetResponse>

[src]

Deletes a dataset from DataBrew.

deleteJob(params: DeleteJobRequest): Promise<DeleteJobResponse>

[src]

Deletes the specified DataBrew job.

deleteProject(params: DeleteProjectRequest): Promise<DeleteProjectResponse>

[src]

Deletes an existing DataBrew project.

deleteRecipeVersion(params: DeleteRecipeVersionRequest): Promise<DeleteRecipeVersionResponse>

[src]

Deletes a single version of a DataBrew recipe.

deleteSchedule(params: DeleteScheduleRequest): Promise<DeleteScheduleResponse>

[src]

Deletes the specified DataBrew schedule.

describeDataset(params: DescribeDatasetRequest): Promise<DescribeDatasetResponse>

[src]

Returns the definition of a specific DataBrew dataset.

describeJob(params: DescribeJobRequest): Promise<DescribeJobResponse>

[src]

Returns the definition of a specific DataBrew job.

describeJobRun(params: DescribeJobRunRequest): Promise<DescribeJobRunResponse>

[src]

Represents one run of a DataBrew job.

describeProject(params: DescribeProjectRequest): Promise<DescribeProjectResponse>

[src]

Returns the definition of a specific DataBrew project.

describeRecipe(params: DescribeRecipeRequest): Promise<DescribeRecipeResponse>

[src]

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

describeSchedule(params: DescribeScheduleRequest): Promise<DescribeScheduleResponse>

[src]

Returns the definition of a specific DataBrew schedule.

listDatasets(params?: ListDatasetsRequest): Promise<ListDatasetsResponse>

[src]

Lists all of the DataBrew datasets.

listJobRuns(params: ListJobRunsRequest): Promise<ListJobRunsResponse>

[src]

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

listJobs(params?: ListJobsRequest): Promise<ListJobsResponse>

[src]

Lists all of the DataBrew jobs that are defined.

listProjects(params?: ListProjectsRequest): Promise<ListProjectsResponse>

[src]

Lists all of the DataBrew projects that are defined.

listRecipes(params?: ListRecipesRequest): Promise<ListRecipesResponse>

[src]

Lists all of the DataBrew recipes that are defined.

listRecipeVersions(params: ListRecipeVersionsRequest): Promise<ListRecipeVersionsResponse>

[src]

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

listSchedules(params?: ListSchedulesRequest): Promise<ListSchedulesResponse>

[src]

Lists the DataBrew schedules that are defined.

listTagsForResource(params: ListTagsForResourceRequest): Promise<ListTagsForResourceResponse>

[src]

Lists all the tags for a DataBrew resource.

publishRecipe(params: PublishRecipeRequest): Promise<PublishRecipeResponse>

[src]

Publishes a new version of a DataBrew recipe.

sendProjectSessionAction(params: SendProjectSessionActionRequest): Promise<SendProjectSessionActionResponse>

[src]

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

startJobRun(params: StartJobRunRequest): Promise<StartJobRunResponse>

[src]

Runs a DataBrew job.

startProjectSession(params: StartProjectSessionRequest): Promise<StartProjectSessionResponse>

[src]

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

stopJobRun(params: StopJobRunRequest): Promise<StopJobRunResponse>

[src]

Stops a particular run of a job.

tagResource(params: TagResourceRequest): Promise<void>

[src]

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

untagResource(params: UntagResourceRequest): Promise<void>

[src]

Removes metadata tags from a DataBrew resource.

updateDataset(params: UpdateDatasetRequest): Promise<UpdateDatasetResponse>

[src]

Modifies the definition of an existing DataBrew dataset.

updateProfileJob(params: UpdateProfileJobRequest): Promise<UpdateProfileJobResponse>

[src]

Modifies the definition of an existing profile job.

updateProject(params: UpdateProjectRequest): Promise<UpdateProjectResponse>

[src]

Modifies the definition of an existing DataBrew project.

updateRecipe(params: UpdateRecipeRequest): Promise<UpdateRecipeResponse>

[src]

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

updateRecipeJob(params: UpdateRecipeJobRequest): Promise<UpdateRecipeJobResponse>

[src]

Modifies the definition of an existing DataBrew recipe job.

updateSchedule(params: UpdateScheduleRequest): Promise<UpdateScheduleResponse>

[src]

Modifies the definition of an existing DataBrew schedule.

§Static Properties

ApiMetadata: client.ApiMetadata

[src]