/ 
Paws-0.46
River stage two • 9 direct dependents • 11 total dependents
/ Paws::GlueDataBrew

NAME

Paws::GlueDataBrew - Perl Interface to AWS AWS Glue DataBrew

SYNOPSIS

use Paws;

my $obj = Paws->service('GlueDataBrew');
my $res = $obj->Method(
  Arg1 => $val1,
  Arg2 => [ 'V1', 'V2' ],
  # if Arg3 is an object, the HashRef will be used as arguments to the constructor
  # of the arguments type
  Arg3 => { Att1 => 'Val1' },
  # if Arg4 is an array of objects, the HashRefs will be passed as arguments to
  # the constructor of the arguments type
  Arg4 => [ { Att1 => 'Val1'  }, { Att1 => 'Val2' } ],
);

DESCRIPTION

Glue DataBrew is a visual, cloud-scale data-preparation service. DataBrew simplifies data preparation tasks, targeting data issues that are hard to spot and time-consuming to fix. DataBrew empowers users of all technical levels to visualize the data and perform one-click data transformations, with no coding required.

For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/databrew-2017-07-25

METHODS

BatchDeleteRecipeVersion

Name => Str
RecipeVersions => ArrayRef[Str|Undef]

Each argument is described in detail in: Paws::GlueDataBrew::BatchDeleteRecipeVersion

Returns: a Paws::GlueDataBrew::BatchDeleteRecipeVersionResponse instance

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

Input => Paws::GlueDataBrew::Input
Name => Str
[Format => Str]
[FormatOptions => Paws::GlueDataBrew::FormatOptions]
[PathOptions => Paws::GlueDataBrew::PathOptions]
[Tags => Paws::GlueDataBrew::TagMap]

Each argument is described in detail in: Paws::GlueDataBrew::CreateDataset

Returns: a Paws::GlueDataBrew::CreateDatasetResponse instance

Creates a new DataBrew dataset.

CreateProfileJob

DatasetName => Str
Name => Str
OutputLocation => Paws::GlueDataBrew::S3Location
RoleArn => Str
[EncryptionKeyArn => Str]
[EncryptionMode => Str]
[JobSample => Paws::GlueDataBrew::JobSample]
[LogSubscription => Str]
[MaxCapacity => Int]
[MaxRetries => Int]
[Tags => Paws::GlueDataBrew::TagMap]
[Timeout => Int]

Each argument is described in detail in: Paws::GlueDataBrew::CreateProfileJob

Returns: a Paws::GlueDataBrew::CreateProfileJobResponse instance

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

CreateProject

DatasetName => Str
Name => Str
RecipeName => Str
RoleArn => Str
[Sample => Paws::GlueDataBrew::Sample]
[Tags => Paws::GlueDataBrew::TagMap]

Each argument is described in detail in: Paws::GlueDataBrew::CreateProject

Returns: a Paws::GlueDataBrew::CreateProjectResponse instance

Creates a new DataBrew project.

CreateRecipe

Name => Str
Steps => ArrayRef[Paws::GlueDataBrew::RecipeStep]
[Description => Str]
[Tags => Paws::GlueDataBrew::TagMap]

Each argument is described in detail in: Paws::GlueDataBrew::CreateRecipe

Returns: a Paws::GlueDataBrew::CreateRecipeResponse instance

Creates a new DataBrew recipe.

CreateRecipeJob

Name => Str
RoleArn => Str
[DataCatalogOutputs => ArrayRef[Paws::GlueDataBrew::DataCatalogOutput]]
[DatasetName => Str]
[EncryptionKeyArn => Str]
[EncryptionMode => Str]
[LogSubscription => Str]
[MaxCapacity => Int]
[MaxRetries => Int]
[Outputs => ArrayRef[Paws::GlueDataBrew::Output]]
[ProjectName => Str]
[RecipeReference => Paws::GlueDataBrew::RecipeReference]
[Tags => Paws::GlueDataBrew::TagMap]
[Timeout => Int]

Each argument is described in detail in: Paws::GlueDataBrew::CreateRecipeJob

Returns: a Paws::GlueDataBrew::CreateRecipeJobResponse instance

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

CreateSchedule

CronExpression => Str
Name => Str
[JobNames => ArrayRef[Str|Undef]]
[Tags => Paws::GlueDataBrew::TagMap]

Each argument is described in detail in: Paws::GlueDataBrew::CreateSchedule

Returns: a Paws::GlueDataBrew::CreateScheduleResponse instance

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

Name => Str

Each argument is described in detail in: Paws::GlueDataBrew::DeleteDataset

Returns: a Paws::GlueDataBrew::DeleteDatasetResponse instance

Deletes a dataset from DataBrew.

DeleteJob

Name => Str

Each argument is described in detail in: Paws::GlueDataBrew::DeleteJob

Returns: a Paws::GlueDataBrew::DeleteJobResponse instance

Deletes the specified DataBrew job.

DeleteProject

Name => Str

Each argument is described in detail in: Paws::GlueDataBrew::DeleteProject

Returns: a Paws::GlueDataBrew::DeleteProjectResponse instance

Deletes an existing DataBrew project.

DeleteRecipeVersion

Name => Str
RecipeVersion => Str

Each argument is described in detail in: Paws::GlueDataBrew::DeleteRecipeVersion

Returns: a Paws::GlueDataBrew::DeleteRecipeVersionResponse instance

Deletes a single version of a DataBrew recipe.

DeleteSchedule

Name => Str

Each argument is described in detail in: Paws::GlueDataBrew::DeleteSchedule

Returns: a Paws::GlueDataBrew::DeleteScheduleResponse instance

Deletes the specified DataBrew schedule.

DescribeDataset

Name => Str

Each argument is described in detail in: Paws::GlueDataBrew::DescribeDataset

Returns: a Paws::GlueDataBrew::DescribeDatasetResponse instance

Returns the definition of a specific DataBrew dataset.

DescribeJob

Name => Str

Each argument is described in detail in: Paws::GlueDataBrew::DescribeJob

Returns: a Paws::GlueDataBrew::DescribeJobResponse instance

Returns the definition of a specific DataBrew job.

DescribeJobRun

Name => Str
RunId => Str

Each argument is described in detail in: Paws::GlueDataBrew::DescribeJobRun

Returns: a Paws::GlueDataBrew::DescribeJobRunResponse instance

Represents one run of a DataBrew job.

DescribeProject

Name => Str

Each argument is described in detail in: Paws::GlueDataBrew::DescribeProject

Returns: a Paws::GlueDataBrew::DescribeProjectResponse instance

Returns the definition of a specific DataBrew project.

DescribeRecipe

Name => Str
[RecipeVersion => Str]

Each argument is described in detail in: Paws::GlueDataBrew::DescribeRecipe

Returns: a Paws::GlueDataBrew::DescribeRecipeResponse instance

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

DescribeSchedule

Name => Str

Each argument is described in detail in: Paws::GlueDataBrew::DescribeSchedule

Returns: a Paws::GlueDataBrew::DescribeScheduleResponse instance

Returns the definition of a specific DataBrew schedule.

ListDatasets

[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::GlueDataBrew::ListDatasets

Returns: a Paws::GlueDataBrew::ListDatasetsResponse instance

Lists all of the DataBrew datasets.

ListJobRuns

Name => Str
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::GlueDataBrew::ListJobRuns

Returns: a Paws::GlueDataBrew::ListJobRunsResponse instance

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

ListJobs

[DatasetName => Str]
[MaxResults => Int]
[NextToken => Str]
[ProjectName => Str]

Each argument is described in detail in: Paws::GlueDataBrew::ListJobs

Returns: a Paws::GlueDataBrew::ListJobsResponse instance

Lists all of the DataBrew jobs that are defined.

ListProjects

[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::GlueDataBrew::ListProjects

Returns: a Paws::GlueDataBrew::ListProjectsResponse instance

Lists all of the DataBrew projects that are defined.

ListRecipes

[MaxResults => Int]
[NextToken => Str]
[RecipeVersion => Str]

Each argument is described in detail in: Paws::GlueDataBrew::ListRecipes

Returns: a Paws::GlueDataBrew::ListRecipesResponse instance

Lists all of the DataBrew recipes that are defined.

ListRecipeVersions

Name => Str
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::GlueDataBrew::ListRecipeVersions

Returns: a Paws::GlueDataBrew::ListRecipeVersionsResponse instance

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

ListSchedules

[JobName => Str]
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::GlueDataBrew::ListSchedules

Returns: a Paws::GlueDataBrew::ListSchedulesResponse instance

Lists the DataBrew schedules that are defined.

ListTagsForResource

ResourceArn => Str

Each argument is described in detail in: Paws::GlueDataBrew::ListTagsForResource

Returns: a Paws::GlueDataBrew::ListTagsForResourceResponse instance

Lists all the tags for a DataBrew resource.

PublishRecipe

Name => Str
[Description => Str]

Each argument is described in detail in: Paws::GlueDataBrew::PublishRecipe

Returns: a Paws::GlueDataBrew::PublishRecipeResponse instance

Publishes a new version of a DataBrew recipe.

SendProjectSessionAction

Name => Str
[ClientSessionId => Str]
[Preview => Bool]
[RecipeStep => Paws::GlueDataBrew::RecipeStep]
[StepIndex => Int]
[ViewFrame => Paws::GlueDataBrew::ViewFrame]

Each argument is described in detail in: Paws::GlueDataBrew::SendProjectSessionAction

Returns: a Paws::GlueDataBrew::SendProjectSessionActionResponse instance

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

StartJobRun

Name => Str

Each argument is described in detail in: Paws::GlueDataBrew::StartJobRun

Returns: a Paws::GlueDataBrew::StartJobRunResponse instance

Runs a DataBrew job.

StartProjectSession

Name => Str
[AssumeControl => Bool]

Each argument is described in detail in: Paws::GlueDataBrew::StartProjectSession

Returns: a Paws::GlueDataBrew::StartProjectSessionResponse instance

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

StopJobRun

Name => Str
RunId => Str

Each argument is described in detail in: Paws::GlueDataBrew::StopJobRun

Returns: a Paws::GlueDataBrew::StopJobRunResponse instance

Stops a particular run of a job.

TagResource

ResourceArn => Str
Tags => Paws::GlueDataBrew::TagMap

Each argument is described in detail in: Paws::GlueDataBrew::TagResource

Returns: a Paws::GlueDataBrew::TagResourceResponse instance

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

UntagResource

ResourceArn => Str
TagKeys => ArrayRef[Str|Undef]

Each argument is described in detail in: Paws::GlueDataBrew::UntagResource

Returns: a Paws::GlueDataBrew::UntagResourceResponse instance

Removes metadata tags from a DataBrew resource.

UpdateDataset

Input => Paws::GlueDataBrew::Input
Name => Str
[Format => Str]
[FormatOptions => Paws::GlueDataBrew::FormatOptions]
[PathOptions => Paws::GlueDataBrew::PathOptions]

Each argument is described in detail in: Paws::GlueDataBrew::UpdateDataset

Returns: a Paws::GlueDataBrew::UpdateDatasetResponse instance

Modifies the definition of an existing DataBrew dataset.

UpdateProfileJob

Name => Str
OutputLocation => Paws::GlueDataBrew::S3Location
RoleArn => Str
[EncryptionKeyArn => Str]
[EncryptionMode => Str]
[JobSample => Paws::GlueDataBrew::JobSample]
[LogSubscription => Str]
[MaxCapacity => Int]
[MaxRetries => Int]
[Timeout => Int]

Each argument is described in detail in: Paws::GlueDataBrew::UpdateProfileJob

Returns: a Paws::GlueDataBrew::UpdateProfileJobResponse instance

Modifies the definition of an existing profile job.

UpdateProject

Name => Str
RoleArn => Str
[Sample => Paws::GlueDataBrew::Sample]

Each argument is described in detail in: Paws::GlueDataBrew::UpdateProject

Returns: a Paws::GlueDataBrew::UpdateProjectResponse instance

Modifies the definition of an existing DataBrew project.

UpdateRecipe

Name => Str
[Description => Str]
[Steps => ArrayRef[Paws::GlueDataBrew::RecipeStep]]

Each argument is described in detail in: Paws::GlueDataBrew::UpdateRecipe

Returns: a Paws::GlueDataBrew::UpdateRecipeResponse instance

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

UpdateRecipeJob

Name => Str
RoleArn => Str
[DataCatalogOutputs => ArrayRef[Paws::GlueDataBrew::DataCatalogOutput]]
[EncryptionKeyArn => Str]
[EncryptionMode => Str]
[LogSubscription => Str]
[MaxCapacity => Int]
[MaxRetries => Int]
[Outputs => ArrayRef[Paws::GlueDataBrew::Output]]
[Timeout => Int]

Each argument is described in detail in: Paws::GlueDataBrew::UpdateRecipeJob

Returns: a Paws::GlueDataBrew::UpdateRecipeJobResponse instance

Modifies the definition of an existing DataBrew recipe job.

UpdateSchedule

CronExpression => Str
Name => Str
[JobNames => ArrayRef[Str|Undef]]

Each argument is described in detail in: Paws::GlueDataBrew::UpdateSchedule

Returns: a Paws::GlueDataBrew::UpdateScheduleResponse instance

Modifies the definition of an existing DataBrew schedule.

PAGINATORS

Paginator methods are helpers that repetively call methods that return partial results

ListAllDatasets(sub { },[MaxResults => Int, NextToken => Str])

ListAllDatasets([MaxResults => Int, NextToken => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

- Datasets, passing the object as the first parameter, and the string 'Datasets' as the second parameter

If not, it will return a a Paws::GlueDataBrew::ListDatasetsResponse instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

ListAllJobRuns(sub { },Name => Str, [MaxResults => Int, NextToken => Str])

ListAllJobRuns(Name => Str, [MaxResults => Int, NextToken => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

- JobRuns, passing the object as the first parameter, and the string 'JobRuns' as the second parameter

If not, it will return a a Paws::GlueDataBrew::ListJobRunsResponse instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

ListAllJobs(sub { },[DatasetName => Str, MaxResults => Int, NextToken => Str, ProjectName => Str])

ListAllJobs([DatasetName => Str, MaxResults => Int, NextToken => Str, ProjectName => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

- Jobs, passing the object as the first parameter, and the string 'Jobs' as the second parameter

If not, it will return a a Paws::GlueDataBrew::ListJobsResponse instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

ListAllProjects(sub { },[MaxResults => Int, NextToken => Str])

ListAllProjects([MaxResults => Int, NextToken => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

- Projects, passing the object as the first parameter, and the string 'Projects' as the second parameter

If not, it will return a a Paws::GlueDataBrew::ListProjectsResponse instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

ListAllRecipes(sub { },[MaxResults => Int, NextToken => Str, RecipeVersion => Str])

ListAllRecipes([MaxResults => Int, NextToken => Str, RecipeVersion => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

- Recipes, passing the object as the first parameter, and the string 'Recipes' as the second parameter

If not, it will return a a Paws::GlueDataBrew::ListRecipesResponse instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

ListAllRecipeVersions(sub { },Name => Str, [MaxResults => Int, NextToken => Str])

ListAllRecipeVersions(Name => Str, [MaxResults => Int, NextToken => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

- Recipes, passing the object as the first parameter, and the string 'Recipes' as the second parameter

If not, it will return a a Paws::GlueDataBrew::ListRecipeVersionsResponse instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

ListAllSchedules(sub { },[JobName => Str, MaxResults => Int, NextToken => Str])

ListAllSchedules([JobName => Str, MaxResults => Int, NextToken => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

- Schedules, passing the object as the first parameter, and the string 'Schedules' as the second parameter

If not, it will return a a Paws::GlueDataBrew::ListSchedulesResponse instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

SEE ALSO

This service class forms part of Paws

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues