@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AWSGlueDataBrewClient extends AmazonWebServiceClient implements AWSGlueDataBrew
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.
LOGGING_AWS_REQUEST_METRIC
ENDPOINT_PREFIX
Modifier and Type | Method and Description |
---|---|
BatchDeleteRecipeVersionResult |
batchDeleteRecipeVersion(BatchDeleteRecipeVersionRequest request)
Deletes one or more versions of a recipe at a time.
|
static AWSGlueDataBrewClientBuilder |
builder() |
CreateDatasetResult |
createDataset(CreateDatasetRequest request)
Creates a new DataBrew dataset.
|
CreateProfileJobResult |
createProfileJob(CreateProfileJobRequest request)
Creates a new job to analyze a dataset and create its data profile.
|
CreateProjectResult |
createProject(CreateProjectRequest request)
Creates a new DataBrew project.
|
CreateRecipeResult |
createRecipe(CreateRecipeRequest request)
Creates a new DataBrew recipe.
|
CreateRecipeJobResult |
createRecipeJob(CreateRecipeJobRequest request)
Creates a new job to transform input data, using steps defined in an existing Glue DataBrew recipe
|
CreateRulesetResult |
createRuleset(CreateRulesetRequest request)
Creates a new ruleset that can be used in a profile job to validate the data quality of a dataset.
|
CreateScheduleResult |
createSchedule(CreateScheduleRequest request)
Creates a new schedule for one or more DataBrew jobs.
|
DeleteDatasetResult |
deleteDataset(DeleteDatasetRequest request)
Deletes a dataset from DataBrew.
|
DeleteJobResult |
deleteJob(DeleteJobRequest request)
Deletes the specified DataBrew job.
|
DeleteProjectResult |
deleteProject(DeleteProjectRequest request)
Deletes an existing DataBrew project.
|
DeleteRecipeVersionResult |
deleteRecipeVersion(DeleteRecipeVersionRequest request)
Deletes a single version of a DataBrew recipe.
|
DeleteRulesetResult |
deleteRuleset(DeleteRulesetRequest request)
Deletes a ruleset.
|
DeleteScheduleResult |
deleteSchedule(DeleteScheduleRequest request)
Deletes the specified DataBrew schedule.
|
DescribeDatasetResult |
describeDataset(DescribeDatasetRequest request)
Returns the definition of a specific DataBrew dataset.
|
DescribeJobResult |
describeJob(DescribeJobRequest request)
Returns the definition of a specific DataBrew job.
|
DescribeJobRunResult |
describeJobRun(DescribeJobRunRequest request)
Represents one run of a DataBrew job.
|
DescribeProjectResult |
describeProject(DescribeProjectRequest request)
Returns the definition of a specific DataBrew project.
|
DescribeRecipeResult |
describeRecipe(DescribeRecipeRequest request)
Returns the definition of a specific DataBrew recipe corresponding to a particular version.
|
DescribeRulesetResult |
describeRuleset(DescribeRulesetRequest request)
Retrieves detailed information about the ruleset.
|
DescribeScheduleResult |
describeSchedule(DescribeScheduleRequest request)
Returns the definition of a specific DataBrew schedule.
|
ResponseMetadata |
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful, request, typically used for debugging issues
where a service isn't acting as expected.
|
ListDatasetsResult |
listDatasets(ListDatasetsRequest request)
Lists all of the DataBrew datasets.
|
ListJobRunsResult |
listJobRuns(ListJobRunsRequest request)
Lists all of the previous runs of a particular DataBrew job.
|
ListJobsResult |
listJobs(ListJobsRequest request)
Lists all of the DataBrew jobs that are defined.
|
ListProjectsResult |
listProjects(ListProjectsRequest request)
Lists all of the DataBrew projects that are defined.
|
ListRecipesResult |
listRecipes(ListRecipesRequest request)
Lists all of the DataBrew recipes that are defined.
|
ListRecipeVersionsResult |
listRecipeVersions(ListRecipeVersionsRequest request)
Lists the versions of a particular DataBrew recipe, except for
LATEST_WORKING . |
ListRulesetsResult |
listRulesets(ListRulesetsRequest request)
List all rulesets available in the current account or rulesets associated with a specific resource (dataset).
|
ListSchedulesResult |
listSchedules(ListSchedulesRequest request)
Lists the DataBrew schedules that are defined.
|
ListTagsForResourceResult |
listTagsForResource(ListTagsForResourceRequest request)
Lists all the tags for a DataBrew resource.
|
PublishRecipeResult |
publishRecipe(PublishRecipeRequest request)
Publishes a new version of a DataBrew recipe.
|
SendProjectSessionActionResult |
sendProjectSessionAction(SendProjectSessionActionRequest request)
Performs a recipe step within an interactive DataBrew session that's currently open.
|
void |
shutdown()
Shuts down this client object, releasing any resources that might be held
open.
|
StartJobRunResult |
startJobRun(StartJobRunRequest request)
Runs a DataBrew job.
|
StartProjectSessionResult |
startProjectSession(StartProjectSessionRequest request)
Creates an interactive session, enabling you to manipulate data in a DataBrew project.
|
StopJobRunResult |
stopJobRun(StopJobRunRequest request)
Stops a particular run of a job.
|
TagResourceResult |
tagResource(TagResourceRequest request)
Adds metadata tags to a DataBrew resource, such as a dataset, project, recipe, job, or schedule.
|
UntagResourceResult |
untagResource(UntagResourceRequest request)
Removes metadata tags from a DataBrew resource.
|
UpdateDatasetResult |
updateDataset(UpdateDatasetRequest request)
Modifies the definition of an existing DataBrew dataset.
|
UpdateProfileJobResult |
updateProfileJob(UpdateProfileJobRequest request)
Modifies the definition of an existing profile job.
|
UpdateProjectResult |
updateProject(UpdateProjectRequest request)
Modifies the definition of an existing DataBrew project.
|
UpdateRecipeResult |
updateRecipe(UpdateRecipeRequest request)
Modifies the definition of the
LATEST_WORKING version of a DataBrew recipe. |
UpdateRecipeJobResult |
updateRecipeJob(UpdateRecipeJobRequest request)
Modifies the definition of an existing DataBrew recipe job.
|
UpdateRulesetResult |
updateRuleset(UpdateRulesetRequest request)
Updates specified ruleset.
|
UpdateScheduleResult |
updateSchedule(UpdateScheduleRequest request)
Modifies the definition of an existing DataBrew schedule.
|
addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffset
public static AWSGlueDataBrewClientBuilder builder()
public BatchDeleteRecipeVersionResult batchDeleteRecipeVersion(BatchDeleteRecipeVersionRequest request)
Deletes one or more versions of a recipe at a time.
The entire request will be rejected if:
The recipe does not exist.
There is an invalid version identifier in the list of versions.
The version list is empty.
The version list size exceeds 50.
The version list contains duplicate entries.
The request will complete successfully, but with partial failures, if:
A version does not exist.
A version is being used by a job.
You specify LATEST_WORKING
, but it's being used by a project.
The version fails to be deleted.
The LATEST_WORKING
version will only be deleted if the recipe has no other versions. If you try to
delete LATEST_WORKING
while other versions exist (or if they can't be deleted), then
LATEST_WORKING
will be listed as partial failure in the response.
batchDeleteRecipeVersion
in interface AWSGlueDataBrew
batchDeleteRecipeVersionRequest
- ConflictException
- Updating or deleting a resource can cause an inconsistent state.ResourceNotFoundException
- One or more resources can't be found.ValidationException
- The input parameters for this request failed validation.public CreateDatasetResult createDataset(CreateDatasetRequest request)
Creates a new DataBrew dataset.
createDataset
in interface AWSGlueDataBrew
createDatasetRequest
- AccessDeniedException
- Access to the specified resource was denied.ConflictException
- Updating or deleting a resource can cause an inconsistent state.ServiceQuotaExceededException
- A service quota is exceeded.ValidationException
- The input parameters for this request failed validation.public CreateProfileJobResult createProfileJob(CreateProfileJobRequest request)
Creates a new job to analyze a dataset and create its data profile.
createProfileJob
in interface AWSGlueDataBrew
createProfileJobRequest
- AccessDeniedException
- Access to the specified resource was denied.ConflictException
- Updating or deleting a resource can cause an inconsistent state.ResourceNotFoundException
- One or more resources can't be found.ServiceQuotaExceededException
- A service quota is exceeded.ValidationException
- The input parameters for this request failed validation.public CreateProjectResult createProject(CreateProjectRequest request)
Creates a new DataBrew project.
createProject
in interface AWSGlueDataBrew
createProjectRequest
- ConflictException
- Updating or deleting a resource can cause an inconsistent state.InternalServerException
- An internal service failure occurred.ServiceQuotaExceededException
- A service quota is exceeded.ValidationException
- The input parameters for this request failed validation.public CreateRecipeResult createRecipe(CreateRecipeRequest request)
Creates a new DataBrew recipe.
createRecipe
in interface AWSGlueDataBrew
createRecipeRequest
- ConflictException
- Updating or deleting a resource can cause an inconsistent state.ServiceQuotaExceededException
- A service quota is exceeded.ValidationException
- The input parameters for this request failed validation.public CreateRecipeJobResult createRecipeJob(CreateRecipeJobRequest request)
Creates a new job to transform input data, using steps defined in an existing Glue DataBrew recipe
createRecipeJob
in interface AWSGlueDataBrew
createRecipeJobRequest
- AccessDeniedException
- Access to the specified resource was denied.ConflictException
- Updating or deleting a resource can cause an inconsistent state.ResourceNotFoundException
- One or more resources can't be found.ServiceQuotaExceededException
- A service quota is exceeded.ValidationException
- The input parameters for this request failed validation.public CreateRulesetResult createRuleset(CreateRulesetRequest request)
Creates a new ruleset that can be used in a profile job to validate the data quality of a dataset.
createRuleset
in interface AWSGlueDataBrew
createRulesetRequest
- ConflictException
- Updating or deleting a resource can cause an inconsistent state.ServiceQuotaExceededException
- A service quota is exceeded.ValidationException
- The input parameters for this request failed validation.public CreateScheduleResult createSchedule(CreateScheduleRequest request)
Creates a new schedule for one or more DataBrew jobs. Jobs can be run at a specific date and time, or at regular intervals.
createSchedule
in interface AWSGlueDataBrew
createScheduleRequest
- ConflictException
- Updating or deleting a resource can cause an inconsistent state.ServiceQuotaExceededException
- A service quota is exceeded.ValidationException
- The input parameters for this request failed validation.public DeleteDatasetResult deleteDataset(DeleteDatasetRequest request)
Deletes a dataset from DataBrew.
deleteDataset
in interface AWSGlueDataBrew
deleteDatasetRequest
- ConflictException
- Updating or deleting a resource can cause an inconsistent state.ResourceNotFoundException
- One or more resources can't be found.ValidationException
- The input parameters for this request failed validation.public DeleteJobResult deleteJob(DeleteJobRequest request)
Deletes the specified DataBrew job.
deleteJob
in interface AWSGlueDataBrew
deleteJobRequest
- ConflictException
- Updating or deleting a resource can cause an inconsistent state.ResourceNotFoundException
- One or more resources can't be found.ValidationException
- The input parameters for this request failed validation.public DeleteProjectResult deleteProject(DeleteProjectRequest request)
Deletes an existing DataBrew project.
deleteProject
in interface AWSGlueDataBrew
deleteProjectRequest
- ConflictException
- Updating or deleting a resource can cause an inconsistent state.ResourceNotFoundException
- One or more resources can't be found.ValidationException
- The input parameters for this request failed validation.public DeleteRecipeVersionResult deleteRecipeVersion(DeleteRecipeVersionRequest request)
Deletes a single version of a DataBrew recipe.
deleteRecipeVersion
in interface AWSGlueDataBrew
deleteRecipeVersionRequest
- ConflictException
- Updating or deleting a resource can cause an inconsistent state.ResourceNotFoundException
- One or more resources can't be found.ValidationException
- The input parameters for this request failed validation.public DeleteRulesetResult deleteRuleset(DeleteRulesetRequest request)
Deletes a ruleset.
deleteRuleset
in interface AWSGlueDataBrew
deleteRulesetRequest
- ResourceNotFoundException
- One or more resources can't be found.ValidationException
- The input parameters for this request failed validation.ConflictException
- Updating or deleting a resource can cause an inconsistent state.public DeleteScheduleResult deleteSchedule(DeleteScheduleRequest request)
Deletes the specified DataBrew schedule.
deleteSchedule
in interface AWSGlueDataBrew
deleteScheduleRequest
- ResourceNotFoundException
- One or more resources can't be found.ValidationException
- The input parameters for this request failed validation.public DescribeDatasetResult describeDataset(DescribeDatasetRequest request)
Returns the definition of a specific DataBrew dataset.
describeDataset
in interface AWSGlueDataBrew
describeDatasetRequest
- ResourceNotFoundException
- One or more resources can't be found.ValidationException
- The input parameters for this request failed validation.public DescribeJobResult describeJob(DescribeJobRequest request)
Returns the definition of a specific DataBrew job.
describeJob
in interface AWSGlueDataBrew
describeJobRequest
- ResourceNotFoundException
- One or more resources can't be found.ValidationException
- The input parameters for this request failed validation.public DescribeJobRunResult describeJobRun(DescribeJobRunRequest request)
Represents one run of a DataBrew job.
describeJobRun
in interface AWSGlueDataBrew
describeJobRunRequest
- ResourceNotFoundException
- One or more resources can't be found.ValidationException
- The input parameters for this request failed validation.public DescribeProjectResult describeProject(DescribeProjectRequest request)
Returns the definition of a specific DataBrew project.
describeProject
in interface AWSGlueDataBrew
describeProjectRequest
- ResourceNotFoundException
- One or more resources can't be found.ValidationException
- The input parameters for this request failed validation.public DescribeRecipeResult describeRecipe(DescribeRecipeRequest request)
Returns the definition of a specific DataBrew recipe corresponding to a particular version.
describeRecipe
in interface AWSGlueDataBrew
describeRecipeRequest
- ResourceNotFoundException
- One or more resources can't be found.ValidationException
- The input parameters for this request failed validation.public DescribeRulesetResult describeRuleset(DescribeRulesetRequest request)
Retrieves detailed information about the ruleset.
describeRuleset
in interface AWSGlueDataBrew
describeRulesetRequest
- ResourceNotFoundException
- One or more resources can't be found.ValidationException
- The input parameters for this request failed validation.public DescribeScheduleResult describeSchedule(DescribeScheduleRequest request)
Returns the definition of a specific DataBrew schedule.
describeSchedule
in interface AWSGlueDataBrew
describeScheduleRequest
- ResourceNotFoundException
- One or more resources can't be found.ValidationException
- The input parameters for this request failed validation.public ListDatasetsResult listDatasets(ListDatasetsRequest request)
Lists all of the DataBrew datasets.
listDatasets
in interface AWSGlueDataBrew
listDatasetsRequest
- ValidationException
- The input parameters for this request failed validation.public ListJobRunsResult listJobRuns(ListJobRunsRequest request)
Lists all of the previous runs of a particular DataBrew job.
listJobRuns
in interface AWSGlueDataBrew
listJobRunsRequest
- ResourceNotFoundException
- One or more resources can't be found.ValidationException
- The input parameters for this request failed validation.public ListJobsResult listJobs(ListJobsRequest request)
Lists all of the DataBrew jobs that are defined.
listJobs
in interface AWSGlueDataBrew
listJobsRequest
- ValidationException
- The input parameters for this request failed validation.public ListProjectsResult listProjects(ListProjectsRequest request)
Lists all of the DataBrew projects that are defined.
listProjects
in interface AWSGlueDataBrew
listProjectsRequest
- ValidationException
- The input parameters for this request failed validation.public ListRecipeVersionsResult listRecipeVersions(ListRecipeVersionsRequest request)
Lists the versions of a particular DataBrew recipe, except for LATEST_WORKING
.
listRecipeVersions
in interface AWSGlueDataBrew
listRecipeVersionsRequest
- ValidationException
- The input parameters for this request failed validation.public ListRecipesResult listRecipes(ListRecipesRequest request)
Lists all of the DataBrew recipes that are defined.
listRecipes
in interface AWSGlueDataBrew
listRecipesRequest
- ValidationException
- The input parameters for this request failed validation.public ListRulesetsResult listRulesets(ListRulesetsRequest request)
List all rulesets available in the current account or rulesets associated with a specific resource (dataset).
listRulesets
in interface AWSGlueDataBrew
listRulesetsRequest
- ResourceNotFoundException
- One or more resources can't be found.ValidationException
- The input parameters for this request failed validation.public ListSchedulesResult listSchedules(ListSchedulesRequest request)
Lists the DataBrew schedules that are defined.
listSchedules
in interface AWSGlueDataBrew
listSchedulesRequest
- ValidationException
- The input parameters for this request failed validation.public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
Lists all the tags for a DataBrew resource.
listTagsForResource
in interface AWSGlueDataBrew
listTagsForResourceRequest
- InternalServerException
- An internal service failure occurred.ResourceNotFoundException
- One or more resources can't be found.ValidationException
- The input parameters for this request failed validation.public PublishRecipeResult publishRecipe(PublishRecipeRequest request)
Publishes a new version of a DataBrew recipe.
publishRecipe
in interface AWSGlueDataBrew
publishRecipeRequest
- ValidationException
- The input parameters for this request failed validation.ResourceNotFoundException
- One or more resources can't be found.ServiceQuotaExceededException
- A service quota is exceeded.public SendProjectSessionActionResult sendProjectSessionAction(SendProjectSessionActionRequest request)
Performs a recipe step within an interactive DataBrew session that's currently open.
sendProjectSessionAction
in interface AWSGlueDataBrew
sendProjectSessionActionRequest
- ConflictException
- Updating or deleting a resource can cause an inconsistent state.ResourceNotFoundException
- One or more resources can't be found.ValidationException
- The input parameters for this request failed validation.public StartJobRunResult startJobRun(StartJobRunRequest request)
Runs a DataBrew job.
startJobRun
in interface AWSGlueDataBrew
startJobRunRequest
- ConflictException
- Updating or deleting a resource can cause an inconsistent state.ResourceNotFoundException
- One or more resources can't be found.ServiceQuotaExceededException
- A service quota is exceeded.ValidationException
- The input parameters for this request failed validation.public StartProjectSessionResult startProjectSession(StartProjectSessionRequest request)
Creates an interactive session, enabling you to manipulate data in a DataBrew project.
startProjectSession
in interface AWSGlueDataBrew
startProjectSessionRequest
- ConflictException
- Updating or deleting a resource can cause an inconsistent state.ResourceNotFoundException
- One or more resources can't be found.ServiceQuotaExceededException
- A service quota is exceeded.ValidationException
- The input parameters for this request failed validation.public StopJobRunResult stopJobRun(StopJobRunRequest request)
Stops a particular run of a job.
stopJobRun
in interface AWSGlueDataBrew
stopJobRunRequest
- ResourceNotFoundException
- One or more resources can't be found.ValidationException
- The input parameters for this request failed validation.public TagResourceResult tagResource(TagResourceRequest request)
Adds metadata tags to a DataBrew resource, such as a dataset, project, recipe, job, or schedule.
tagResource
in interface AWSGlueDataBrew
tagResourceRequest
- InternalServerException
- An internal service failure occurred.ResourceNotFoundException
- One or more resources can't be found.ValidationException
- The input parameters for this request failed validation.public UntagResourceResult untagResource(UntagResourceRequest request)
Removes metadata tags from a DataBrew resource.
untagResource
in interface AWSGlueDataBrew
untagResourceRequest
- InternalServerException
- An internal service failure occurred.ResourceNotFoundException
- One or more resources can't be found.ValidationException
- The input parameters for this request failed validation.public UpdateDatasetResult updateDataset(UpdateDatasetRequest request)
Modifies the definition of an existing DataBrew dataset.
updateDataset
in interface AWSGlueDataBrew
updateDatasetRequest
- AccessDeniedException
- Access to the specified resource was denied.ResourceNotFoundException
- One or more resources can't be found.ValidationException
- The input parameters for this request failed validation.public UpdateProfileJobResult updateProfileJob(UpdateProfileJobRequest request)
Modifies the definition of an existing profile job.
updateProfileJob
in interface AWSGlueDataBrew
updateProfileJobRequest
- AccessDeniedException
- Access to the specified resource was denied.ResourceNotFoundException
- One or more resources can't be found.ValidationException
- The input parameters for this request failed validation.public UpdateProjectResult updateProject(UpdateProjectRequest request)
Modifies the definition of an existing DataBrew project.
updateProject
in interface AWSGlueDataBrew
updateProjectRequest
- ResourceNotFoundException
- One or more resources can't be found.ValidationException
- The input parameters for this request failed validation.public UpdateRecipeResult updateRecipe(UpdateRecipeRequest request)
Modifies the definition of the LATEST_WORKING
version of a DataBrew recipe.
updateRecipe
in interface AWSGlueDataBrew
updateRecipeRequest
- ValidationException
- The input parameters for this request failed validation.ResourceNotFoundException
- One or more resources can't be found.public UpdateRecipeJobResult updateRecipeJob(UpdateRecipeJobRequest request)
Modifies the definition of an existing DataBrew recipe job.
updateRecipeJob
in interface AWSGlueDataBrew
updateRecipeJobRequest
- AccessDeniedException
- Access to the specified resource was denied.ResourceNotFoundException
- One or more resources can't be found.ValidationException
- The input parameters for this request failed validation.public UpdateRulesetResult updateRuleset(UpdateRulesetRequest request)
Updates specified ruleset.
updateRuleset
in interface AWSGlueDataBrew
updateRulesetRequest
- ResourceNotFoundException
- One or more resources can't be found.ValidationException
- The input parameters for this request failed validation.public UpdateScheduleResult updateSchedule(UpdateScheduleRequest request)
Modifies the definition of an existing DataBrew schedule.
updateSchedule
in interface AWSGlueDataBrew
updateScheduleRequest
- ResourceNotFoundException
- One or more resources can't be found.ServiceQuotaExceededException
- A service quota is exceeded.ValidationException
- The input parameters for this request failed validation.public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing the request.
getCachedResponseMetadata
in interface AWSGlueDataBrew
request
- The originally executed requestpublic void shutdown()
AmazonWebServiceClient
shutdown
in interface AWSGlueDataBrew
shutdown
in class AmazonWebServiceClient