/* * Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with * the License. A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions * and limitations under the License. */ package com.amazonaws.services.gluedatabrew; import javax.annotation.Generated; import com.amazonaws.*; import com.amazonaws.regions.*; import com.amazonaws.services.gluedatabrew.model.*; /** * Interface for accessing AWS Glue DataBrew. *

* Note: Do not directly implement this interface, new methods are added to it regularly. Extend from * {@link com.amazonaws.services.gluedatabrew.AbstractAWSGlueDataBrew} instead. *

*

*

* 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. *

*/ @Generated("com.amazonaws:aws-java-sdk-code-generator") public interface AWSGlueDataBrew { /** * The region metadata service name for computing region endpoints. You can use this value to retrieve metadata * (such as supported regions) of the service. * * @see RegionUtils#getRegionsForService(String) */ String ENDPOINT_PREFIX = "databrew"; /** *

* Deletes one or more versions of a recipe at a time. *

*

* The entire request will be rejected if: *

* *

* The request will complete successfully, but with partial failures, if: *

* *

* 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. *

* * @param batchDeleteRecipeVersionRequest * @return Result of the BatchDeleteRecipeVersion operation returned by the service. * @throws ConflictException * Updating or deleting a resource can cause an inconsistent state. * @throws ResourceNotFoundException * One or more resources can't be found. * @throws ValidationException * The input parameters for this request failed validation. * @sample AWSGlueDataBrew.BatchDeleteRecipeVersion * @see AWS API Documentation */ BatchDeleteRecipeVersionResult batchDeleteRecipeVersion(BatchDeleteRecipeVersionRequest batchDeleteRecipeVersionRequest); /** *

* Creates a new DataBrew dataset. *

* * @param createDatasetRequest * @return Result of the CreateDataset operation returned by the service. * @throws AccessDeniedException * Access to the specified resource was denied. * @throws ConflictException * Updating or deleting a resource can cause an inconsistent state. * @throws ServiceQuotaExceededException * A service quota is exceeded. * @throws ValidationException * The input parameters for this request failed validation. * @sample AWSGlueDataBrew.CreateDataset * @see AWS API * Documentation */ CreateDatasetResult createDataset(CreateDatasetRequest createDatasetRequest); /** *

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

* * @param createProfileJobRequest * @return Result of the CreateProfileJob operation returned by the service. * @throws AccessDeniedException * Access to the specified resource was denied. * @throws ConflictException * Updating or deleting a resource can cause an inconsistent state. * @throws ResourceNotFoundException * One or more resources can't be found. * @throws ServiceQuotaExceededException * A service quota is exceeded. * @throws ValidationException * The input parameters for this request failed validation. * @sample AWSGlueDataBrew.CreateProfileJob * @see AWS API * Documentation */ CreateProfileJobResult createProfileJob(CreateProfileJobRequest createProfileJobRequest); /** *

* Creates a new DataBrew project. *

* * @param createProjectRequest * @return Result of the CreateProject operation returned by the service. * @throws ConflictException * Updating or deleting a resource can cause an inconsistent state. * @throws InternalServerException * An internal service failure occurred. * @throws ServiceQuotaExceededException * A service quota is exceeded. * @throws ValidationException * The input parameters for this request failed validation. * @sample AWSGlueDataBrew.CreateProject * @see AWS API * Documentation */ CreateProjectResult createProject(CreateProjectRequest createProjectRequest); /** *

* Creates a new DataBrew recipe. *

* * @param createRecipeRequest * @return Result of the CreateRecipe operation returned by the service. * @throws ConflictException * Updating or deleting a resource can cause an inconsistent state. * @throws ServiceQuotaExceededException * A service quota is exceeded. * @throws ValidationException * The input parameters for this request failed validation. * @sample AWSGlueDataBrew.CreateRecipe * @see AWS API * Documentation */ CreateRecipeResult createRecipe(CreateRecipeRequest createRecipeRequest); /** *

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

* * @param createRecipeJobRequest * @return Result of the CreateRecipeJob operation returned by the service. * @throws AccessDeniedException * Access to the specified resource was denied. * @throws ConflictException * Updating or deleting a resource can cause an inconsistent state. * @throws ResourceNotFoundException * One or more resources can't be found. * @throws ServiceQuotaExceededException * A service quota is exceeded. * @throws ValidationException * The input parameters for this request failed validation. * @sample AWSGlueDataBrew.CreateRecipeJob * @see AWS API * Documentation */ CreateRecipeJobResult createRecipeJob(CreateRecipeJobRequest createRecipeJobRequest); /** *

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

* * @param createRulesetRequest * @return Result of the CreateRuleset operation returned by the service. * @throws ConflictException * Updating or deleting a resource can cause an inconsistent state. * @throws ServiceQuotaExceededException * A service quota is exceeded. * @throws ValidationException * The input parameters for this request failed validation. * @sample AWSGlueDataBrew.CreateRuleset * @see AWS API * Documentation */ CreateRulesetResult createRuleset(CreateRulesetRequest createRulesetRequest); /** *

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

* * @param createScheduleRequest * @return Result of the CreateSchedule operation returned by the service. * @throws ConflictException * Updating or deleting a resource can cause an inconsistent state. * @throws ServiceQuotaExceededException * A service quota is exceeded. * @throws ValidationException * The input parameters for this request failed validation. * @sample AWSGlueDataBrew.CreateSchedule * @see AWS API * Documentation */ CreateScheduleResult createSchedule(CreateScheduleRequest createScheduleRequest); /** *

* Deletes a dataset from DataBrew. *

* * @param deleteDatasetRequest * @return Result of the DeleteDataset operation returned by the service. * @throws ConflictException * Updating or deleting a resource can cause an inconsistent state. * @throws ResourceNotFoundException * One or more resources can't be found. * @throws ValidationException * The input parameters for this request failed validation. * @sample AWSGlueDataBrew.DeleteDataset * @see AWS API * Documentation */ DeleteDatasetResult deleteDataset(DeleteDatasetRequest deleteDatasetRequest); /** *

* Deletes the specified DataBrew job. *

* * @param deleteJobRequest * @return Result of the DeleteJob operation returned by the service. * @throws ConflictException * Updating or deleting a resource can cause an inconsistent state. * @throws ResourceNotFoundException * One or more resources can't be found. * @throws ValidationException * The input parameters for this request failed validation. * @sample AWSGlueDataBrew.DeleteJob * @see AWS API * Documentation */ DeleteJobResult deleteJob(DeleteJobRequest deleteJobRequest); /** *

* Deletes an existing DataBrew project. *

* * @param deleteProjectRequest * @return Result of the DeleteProject operation returned by the service. * @throws ConflictException * Updating or deleting a resource can cause an inconsistent state. * @throws ResourceNotFoundException * One or more resources can't be found. * @throws ValidationException * The input parameters for this request failed validation. * @sample AWSGlueDataBrew.DeleteProject * @see AWS API * Documentation */ DeleteProjectResult deleteProject(DeleteProjectRequest deleteProjectRequest); /** *

* Deletes a single version of a DataBrew recipe. *

* * @param deleteRecipeVersionRequest * @return Result of the DeleteRecipeVersion operation returned by the service. * @throws ConflictException * Updating or deleting a resource can cause an inconsistent state. * @throws ResourceNotFoundException * One or more resources can't be found. * @throws ValidationException * The input parameters for this request failed validation. * @sample AWSGlueDataBrew.DeleteRecipeVersion * @see AWS * API Documentation */ DeleteRecipeVersionResult deleteRecipeVersion(DeleteRecipeVersionRequest deleteRecipeVersionRequest); /** *

* Deletes a ruleset. *

* * @param deleteRulesetRequest * @return Result of the DeleteRuleset operation returned by the service. * @throws ResourceNotFoundException * One or more resources can't be found. * @throws ValidationException * The input parameters for this request failed validation. * @throws ConflictException * Updating or deleting a resource can cause an inconsistent state. * @sample AWSGlueDataBrew.DeleteRuleset * @see AWS API * Documentation */ DeleteRulesetResult deleteRuleset(DeleteRulesetRequest deleteRulesetRequest); /** *

* Deletes the specified DataBrew schedule. *

* * @param deleteScheduleRequest * @return Result of the DeleteSchedule operation returned by the service. * @throws ResourceNotFoundException * One or more resources can't be found. * @throws ValidationException * The input parameters for this request failed validation. * @sample AWSGlueDataBrew.DeleteSchedule * @see AWS API * Documentation */ DeleteScheduleResult deleteSchedule(DeleteScheduleRequest deleteScheduleRequest); /** *

* Returns the definition of a specific DataBrew dataset. *

* * @param describeDatasetRequest * @return Result of the DescribeDataset operation returned by the service. * @throws ResourceNotFoundException * One or more resources can't be found. * @throws ValidationException * The input parameters for this request failed validation. * @sample AWSGlueDataBrew.DescribeDataset * @see AWS API * Documentation */ DescribeDatasetResult describeDataset(DescribeDatasetRequest describeDatasetRequest); /** *

* Returns the definition of a specific DataBrew job. *

* * @param describeJobRequest * @return Result of the DescribeJob operation returned by the service. * @throws ResourceNotFoundException * One or more resources can't be found. * @throws ValidationException * The input parameters for this request failed validation. * @sample AWSGlueDataBrew.DescribeJob * @see AWS API * Documentation */ DescribeJobResult describeJob(DescribeJobRequest describeJobRequest); /** *

* Represents one run of a DataBrew job. *

* * @param describeJobRunRequest * @return Result of the DescribeJobRun operation returned by the service. * @throws ResourceNotFoundException * One or more resources can't be found. * @throws ValidationException * The input parameters for this request failed validation. * @sample AWSGlueDataBrew.DescribeJobRun * @see AWS API * Documentation */ DescribeJobRunResult describeJobRun(DescribeJobRunRequest describeJobRunRequest); /** *

* Returns the definition of a specific DataBrew project. *

* * @param describeProjectRequest * @return Result of the DescribeProject operation returned by the service. * @throws ResourceNotFoundException * One or more resources can't be found. * @throws ValidationException * The input parameters for this request failed validation. * @sample AWSGlueDataBrew.DescribeProject * @see AWS API * Documentation */ DescribeProjectResult describeProject(DescribeProjectRequest describeProjectRequest); /** *

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

* * @param describeRecipeRequest * @return Result of the DescribeRecipe operation returned by the service. * @throws ResourceNotFoundException * One or more resources can't be found. * @throws ValidationException * The input parameters for this request failed validation. * @sample AWSGlueDataBrew.DescribeRecipe * @see AWS API * Documentation */ DescribeRecipeResult describeRecipe(DescribeRecipeRequest describeRecipeRequest); /** *

* Retrieves detailed information about the ruleset. *

* * @param describeRulesetRequest * @return Result of the DescribeRuleset operation returned by the service. * @throws ResourceNotFoundException * One or more resources can't be found. * @throws ValidationException * The input parameters for this request failed validation. * @sample AWSGlueDataBrew.DescribeRuleset * @see AWS API * Documentation */ DescribeRulesetResult describeRuleset(DescribeRulesetRequest describeRulesetRequest); /** *

* Returns the definition of a specific DataBrew schedule. *

* * @param describeScheduleRequest * @return Result of the DescribeSchedule operation returned by the service. * @throws ResourceNotFoundException * One or more resources can't be found. * @throws ValidationException * The input parameters for this request failed validation. * @sample AWSGlueDataBrew.DescribeSchedule * @see AWS API * Documentation */ DescribeScheduleResult describeSchedule(DescribeScheduleRequest describeScheduleRequest); /** *

* Lists all of the DataBrew datasets. *

* * @param listDatasetsRequest * @return Result of the ListDatasets operation returned by the service. * @throws ValidationException * The input parameters for this request failed validation. * @sample AWSGlueDataBrew.ListDatasets * @see AWS API * Documentation */ ListDatasetsResult listDatasets(ListDatasetsRequest listDatasetsRequest); /** *

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

* * @param listJobRunsRequest * @return Result of the ListJobRuns operation returned by the service. * @throws ResourceNotFoundException * One or more resources can't be found. * @throws ValidationException * The input parameters for this request failed validation. * @sample AWSGlueDataBrew.ListJobRuns * @see AWS API * Documentation */ ListJobRunsResult listJobRuns(ListJobRunsRequest listJobRunsRequest); /** *

* Lists all of the DataBrew jobs that are defined. *

* * @param listJobsRequest * @return Result of the ListJobs operation returned by the service. * @throws ValidationException * The input parameters for this request failed validation. * @sample AWSGlueDataBrew.ListJobs * @see AWS API * Documentation */ ListJobsResult listJobs(ListJobsRequest listJobsRequest); /** *

* Lists all of the DataBrew projects that are defined. *

* * @param listProjectsRequest * @return Result of the ListProjects operation returned by the service. * @throws ValidationException * The input parameters for this request failed validation. * @sample AWSGlueDataBrew.ListProjects * @see AWS API * Documentation */ ListProjectsResult listProjects(ListProjectsRequest listProjectsRequest); /** *

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

* * @param listRecipeVersionsRequest * @return Result of the ListRecipeVersions operation returned by the service. * @throws ValidationException * The input parameters for this request failed validation. * @sample AWSGlueDataBrew.ListRecipeVersions * @see AWS * API Documentation */ ListRecipeVersionsResult listRecipeVersions(ListRecipeVersionsRequest listRecipeVersionsRequest); /** *

* Lists all of the DataBrew recipes that are defined. *

* * @param listRecipesRequest * @return Result of the ListRecipes operation returned by the service. * @throws ValidationException * The input parameters for this request failed validation. * @sample AWSGlueDataBrew.ListRecipes * @see AWS API * Documentation */ ListRecipesResult listRecipes(ListRecipesRequest listRecipesRequest); /** *

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

* * @param listRulesetsRequest * @return Result of the ListRulesets operation returned by the service. * @throws ResourceNotFoundException * One or more resources can't be found. * @throws ValidationException * The input parameters for this request failed validation. * @sample AWSGlueDataBrew.ListRulesets * @see AWS API * Documentation */ ListRulesetsResult listRulesets(ListRulesetsRequest listRulesetsRequest); /** *

* Lists the DataBrew schedules that are defined. *

* * @param listSchedulesRequest * @return Result of the ListSchedules operation returned by the service. * @throws ValidationException * The input parameters for this request failed validation. * @sample AWSGlueDataBrew.ListSchedules * @see AWS API * Documentation */ ListSchedulesResult listSchedules(ListSchedulesRequest listSchedulesRequest); /** *

* Lists all the tags for a DataBrew resource. *

* * @param listTagsForResourceRequest * @return Result of the ListTagsForResource operation returned by the service. * @throws InternalServerException * An internal service failure occurred. * @throws ResourceNotFoundException * One or more resources can't be found. * @throws ValidationException * The input parameters for this request failed validation. * @sample AWSGlueDataBrew.ListTagsForResource * @see AWS * API Documentation */ ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest); /** *

* Publishes a new version of a DataBrew recipe. *

* * @param publishRecipeRequest * @return Result of the PublishRecipe operation returned by the service. * @throws ValidationException * The input parameters for this request failed validation. * @throws ResourceNotFoundException * One or more resources can't be found. * @throws ServiceQuotaExceededException * A service quota is exceeded. * @sample AWSGlueDataBrew.PublishRecipe * @see AWS API * Documentation */ PublishRecipeResult publishRecipe(PublishRecipeRequest publishRecipeRequest); /** *

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

* * @param sendProjectSessionActionRequest * @return Result of the SendProjectSessionAction operation returned by the service. * @throws ConflictException * Updating or deleting a resource can cause an inconsistent state. * @throws ResourceNotFoundException * One or more resources can't be found. * @throws ValidationException * The input parameters for this request failed validation. * @sample AWSGlueDataBrew.SendProjectSessionAction * @see AWS API Documentation */ SendProjectSessionActionResult sendProjectSessionAction(SendProjectSessionActionRequest sendProjectSessionActionRequest); /** *

* Runs a DataBrew job. *

* * @param startJobRunRequest * @return Result of the StartJobRun operation returned by the service. * @throws ConflictException * Updating or deleting a resource can cause an inconsistent state. * @throws ResourceNotFoundException * One or more resources can't be found. * @throws ServiceQuotaExceededException * A service quota is exceeded. * @throws ValidationException * The input parameters for this request failed validation. * @sample AWSGlueDataBrew.StartJobRun * @see AWS API * Documentation */ StartJobRunResult startJobRun(StartJobRunRequest startJobRunRequest); /** *

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

* * @param startProjectSessionRequest * @return Result of the StartProjectSession operation returned by the service. * @throws ConflictException * Updating or deleting a resource can cause an inconsistent state. * @throws ResourceNotFoundException * One or more resources can't be found. * @throws ServiceQuotaExceededException * A service quota is exceeded. * @throws ValidationException * The input parameters for this request failed validation. * @sample AWSGlueDataBrew.StartProjectSession * @see AWS * API Documentation */ StartProjectSessionResult startProjectSession(StartProjectSessionRequest startProjectSessionRequest); /** *

* Stops a particular run of a job. *

* * @param stopJobRunRequest * @return Result of the StopJobRun operation returned by the service. * @throws ResourceNotFoundException * One or more resources can't be found. * @throws ValidationException * The input parameters for this request failed validation. * @sample AWSGlueDataBrew.StopJobRun * @see AWS API * Documentation */ StopJobRunResult stopJobRun(StopJobRunRequest stopJobRunRequest); /** *

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

* * @param tagResourceRequest * @return Result of the TagResource operation returned by the service. * @throws InternalServerException * An internal service failure occurred. * @throws ResourceNotFoundException * One or more resources can't be found. * @throws ValidationException * The input parameters for this request failed validation. * @sample AWSGlueDataBrew.TagResource * @see AWS API * Documentation */ TagResourceResult tagResource(TagResourceRequest tagResourceRequest); /** *

* Removes metadata tags from a DataBrew resource. *

* * @param untagResourceRequest * @return Result of the UntagResource operation returned by the service. * @throws InternalServerException * An internal service failure occurred. * @throws ResourceNotFoundException * One or more resources can't be found. * @throws ValidationException * The input parameters for this request failed validation. * @sample AWSGlueDataBrew.UntagResource * @see AWS API * Documentation */ UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest); /** *

* Modifies the definition of an existing DataBrew dataset. *

* * @param updateDatasetRequest * @return Result of the UpdateDataset operation returned by the service. * @throws AccessDeniedException * Access to the specified resource was denied. * @throws ResourceNotFoundException * One or more resources can't be found. * @throws ValidationException * The input parameters for this request failed validation. * @sample AWSGlueDataBrew.UpdateDataset * @see AWS API * Documentation */ UpdateDatasetResult updateDataset(UpdateDatasetRequest updateDatasetRequest); /** *

* Modifies the definition of an existing profile job. *

* * @param updateProfileJobRequest * @return Result of the UpdateProfileJob operation returned by the service. * @throws AccessDeniedException * Access to the specified resource was denied. * @throws ResourceNotFoundException * One or more resources can't be found. * @throws ValidationException * The input parameters for this request failed validation. * @sample AWSGlueDataBrew.UpdateProfileJob * @see AWS API * Documentation */ UpdateProfileJobResult updateProfileJob(UpdateProfileJobRequest updateProfileJobRequest); /** *

* Modifies the definition of an existing DataBrew project. *

* * @param updateProjectRequest * @return Result of the UpdateProject operation returned by the service. * @throws ResourceNotFoundException * One or more resources can't be found. * @throws ValidationException * The input parameters for this request failed validation. * @sample AWSGlueDataBrew.UpdateProject * @see AWS API * Documentation */ UpdateProjectResult updateProject(UpdateProjectRequest updateProjectRequest); /** *

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

* * @param updateRecipeRequest * @return Result of the UpdateRecipe operation returned by the service. * @throws ValidationException * The input parameters for this request failed validation. * @throws ResourceNotFoundException * One or more resources can't be found. * @sample AWSGlueDataBrew.UpdateRecipe * @see AWS API * Documentation */ UpdateRecipeResult updateRecipe(UpdateRecipeRequest updateRecipeRequest); /** *

* Modifies the definition of an existing DataBrew recipe job. *

* * @param updateRecipeJobRequest * @return Result of the UpdateRecipeJob operation returned by the service. * @throws AccessDeniedException * Access to the specified resource was denied. * @throws ResourceNotFoundException * One or more resources can't be found. * @throws ValidationException * The input parameters for this request failed validation. * @sample AWSGlueDataBrew.UpdateRecipeJob * @see AWS API * Documentation */ UpdateRecipeJobResult updateRecipeJob(UpdateRecipeJobRequest updateRecipeJobRequest); /** *

* Updates specified ruleset. *

* * @param updateRulesetRequest * @return Result of the UpdateRuleset operation returned by the service. * @throws ResourceNotFoundException * One or more resources can't be found. * @throws ValidationException * The input parameters for this request failed validation. * @sample AWSGlueDataBrew.UpdateRuleset * @see AWS API * Documentation */ UpdateRulesetResult updateRuleset(UpdateRulesetRequest updateRulesetRequest); /** *

* Modifies the definition of an existing DataBrew schedule. *

* * @param updateScheduleRequest * @return Result of the UpdateSchedule operation returned by the service. * @throws ResourceNotFoundException * One or more resources can't be found. * @throws ServiceQuotaExceededException * A service quota is exceeded. * @throws ValidationException * The input parameters for this request failed validation. * @sample AWSGlueDataBrew.UpdateSchedule * @see AWS API * Documentation */ UpdateScheduleResult updateSchedule(UpdateScheduleRequest updateScheduleRequest); /** * Shuts down this client object, releasing any resources that might be held open. This is an optional method, and * callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client * has been shutdown, it should not be used to make any more requests. */ void shutdown(); /** * Returns additional metadata for a previously executed successful request, typically used for debugging issues * where a service isn't acting as expected. This data isn't considered part of the result data returned by an * operation, so it's available through this separate, diagnostic interface. *

* 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 a request. * * @param request * The originally executed request. * * @return The response metadata for the specified request, or null if none is available. */ ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request); }