Class: Aws::GlueDataBrew::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::GlueDataBrew::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-gluedatabrew/lib/aws-sdk-gluedatabrew/client.rb
Overview
An API client for GlueDataBrew. To construct a client, you need to configure a :region
and :credentials
.
client = Aws::GlueDataBrew::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the developer guide.
See #initialize for a full list of supported configuration options.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
API Operations collapse
-
#batch_delete_recipe_version(params = {}) ⇒ Types::BatchDeleteRecipeVersionResponse
Deletes one or more versions of a recipe at a time.
-
#create_dataset(params = {}) ⇒ Types::CreateDatasetResponse
Creates a new DataBrew dataset.
-
#create_profile_job(params = {}) ⇒ Types::CreateProfileJobResponse
Creates a new job to analyze a dataset and create its data profile.
-
#create_project(params = {}) ⇒ Types::CreateProjectResponse
Creates a new DataBrew project.
-
#create_recipe(params = {}) ⇒ Types::CreateRecipeResponse
Creates a new DataBrew recipe.
-
#create_recipe_job(params = {}) ⇒ Types::CreateRecipeJobResponse
Creates a new job to transform input data, using steps defined in an existing AWS Glue DataBrew recipe.
-
#create_schedule(params = {}) ⇒ Types::CreateScheduleResponse
Creates a new schedule for one or more DataBrew jobs.
-
#delete_dataset(params = {}) ⇒ Types::DeleteDatasetResponse
Deletes a dataset from DataBrew.
-
#delete_job(params = {}) ⇒ Types::DeleteJobResponse
Deletes the specified DataBrew job.
-
#delete_project(params = {}) ⇒ Types::DeleteProjectResponse
Deletes an existing DataBrew project.
-
#delete_recipe_version(params = {}) ⇒ Types::DeleteRecipeVersionResponse
Deletes a single version of a DataBrew recipe.
-
#delete_schedule(params = {}) ⇒ Types::DeleteScheduleResponse
Deletes the specified DataBrew schedule.
-
#describe_dataset(params = {}) ⇒ Types::DescribeDatasetResponse
Returns the definition of a specific DataBrew dataset.
-
#describe_job(params = {}) ⇒ Types::DescribeJobResponse
Returns the definition of a specific DataBrew job.
-
#describe_job_run(params = {}) ⇒ Types::DescribeJobRunResponse
Represents one run of a DataBrew job.
-
#describe_project(params = {}) ⇒ Types::DescribeProjectResponse
Returns the definition of a specific DataBrew project.
-
#describe_recipe(params = {}) ⇒ Types::DescribeRecipeResponse
Returns the definition of a specific DataBrew recipe corresponding to a particular version.
-
#describe_schedule(params = {}) ⇒ Types::DescribeScheduleResponse
Returns the definition of a specific DataBrew schedule.
-
#list_datasets(params = {}) ⇒ Types::ListDatasetsResponse
Lists all of the DataBrew datasets.
-
#list_job_runs(params = {}) ⇒ Types::ListJobRunsResponse
Lists all of the previous runs of a particular DataBrew job.
-
#list_jobs(params = {}) ⇒ Types::ListJobsResponse
Lists all of the DataBrew jobs that are defined.
-
#list_projects(params = {}) ⇒ Types::ListProjectsResponse
Lists all of the DataBrew projects that are defined.
-
#list_recipe_versions(params = {}) ⇒ Types::ListRecipeVersionsResponse
Lists the versions of a particular DataBrew recipe, except for
LATEST_WORKING
. -
#list_recipes(params = {}) ⇒ Types::ListRecipesResponse
Lists all of the DataBrew recipes that are defined.
-
#list_schedules(params = {}) ⇒ Types::ListSchedulesResponse
Lists the DataBrew schedules that are defined.
-
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Lists all the tags for a DataBrew resource.
-
#publish_recipe(params = {}) ⇒ Types::PublishRecipeResponse
Publishes a new version of a DataBrew recipe.
-
#send_project_session_action(params = {}) ⇒ Types::SendProjectSessionActionResponse
Performs a recipe step within an interactive DataBrew session that's currently open.
-
#start_job_run(params = {}) ⇒ Types::StartJobRunResponse
Runs a DataBrew job.
-
#start_project_session(params = {}) ⇒ Types::StartProjectSessionResponse
Creates an interactive session, enabling you to manipulate data in a DataBrew project.
-
#stop_job_run(params = {}) ⇒ Types::StopJobRunResponse
Stops a particular run of a job.
-
#tag_resource(params = {}) ⇒ Struct
Adds metadata tags to a DataBrew resource, such as a dataset, project, recipe, job, or schedule.
-
#untag_resource(params = {}) ⇒ Struct
Removes metadata tags from a DataBrew resource.
-
#update_dataset(params = {}) ⇒ Types::UpdateDatasetResponse
Modifies the definition of an existing DataBrew dataset.
-
#update_profile_job(params = {}) ⇒ Types::UpdateProfileJobResponse
Modifies the definition of an existing profile job.
-
#update_project(params = {}) ⇒ Types::UpdateProjectResponse
Modifies the definition of an existing DataBrew project.
-
#update_recipe(params = {}) ⇒ Types::UpdateRecipeResponse
Modifies the definition of the
LATEST_WORKING
version of a DataBrew recipe. -
#update_recipe_job(params = {}) ⇒ Types::UpdateRecipeJobResponse
Modifies the definition of an existing DataBrew recipe job.
-
#update_schedule(params = {}) ⇒ Types::UpdateScheduleResponse
Modifies the definition of an existing DataBrew schedule.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
Methods included from ClientStubs
#api_requests, #stub_data, #stub_responses
Methods inherited from Seahorse::Client::Base
add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder
#handle, #handle_request, #handle_response
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
324 325 326 |
# File 'gems/aws-sdk-gluedatabrew/lib/aws-sdk-gluedatabrew/client.rb', line 324 def initialize(*args) super end |
Instance Method Details
#batch_delete_recipe_version(params = {}) ⇒ Types::BatchDeleteRecipeVersionResponse
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.
391 392 393 394 |
# File 'gems/aws-sdk-gluedatabrew/lib/aws-sdk-gluedatabrew/client.rb', line 391 def batch_delete_recipe_version(params = {}, = {}) req = build_request(:batch_delete_recipe_version, params) req.send_request() end |
#create_dataset(params = {}) ⇒ Types::CreateDatasetResponse
Creates a new DataBrew dataset.
511 512 513 514 |
# File 'gems/aws-sdk-gluedatabrew/lib/aws-sdk-gluedatabrew/client.rb', line 511 def create_dataset(params = {}, = {}) req = build_request(:create_dataset, params) req.send_request() end |
#create_profile_job(params = {}) ⇒ Types::CreateProfileJobResponse
Creates a new job to analyze a dataset and create its data profile.
606 607 608 609 |
# File 'gems/aws-sdk-gluedatabrew/lib/aws-sdk-gluedatabrew/client.rb', line 606 def create_profile_job(params = {}, = {}) req = build_request(:create_profile_job, params) req.send_request() end |
#create_project(params = {}) ⇒ Types::CreateProjectResponse
Creates a new DataBrew project.
662 663 664 665 |
# File 'gems/aws-sdk-gluedatabrew/lib/aws-sdk-gluedatabrew/client.rb', line 662 def create_project(params = {}, = {}) req = build_request(:create_project, params) req.send_request() end |
#create_recipe(params = {}) ⇒ Types::CreateRecipeResponse
Creates a new DataBrew recipe.
723 724 725 726 |
# File 'gems/aws-sdk-gluedatabrew/lib/aws-sdk-gluedatabrew/client.rb', line 723 def create_recipe(params = {}, = {}) req = build_request(:create_recipe, params) req.send_request() end |
#create_recipe_job(params = {}) ⇒ Types::CreateRecipeJobResponse
Creates a new job to transform input data, using steps defined in an existing AWS Glue DataBrew recipe
832 833 834 835 |
# File 'gems/aws-sdk-gluedatabrew/lib/aws-sdk-gluedatabrew/client.rb', line 832 def create_recipe_job(params = {}, = {}) req = build_request(:create_recipe_job, params) req.send_request() end |
#create_schedule(params = {}) ⇒ Types::CreateScheduleResponse
Creates a new schedule for one or more DataBrew jobs. Jobs can be run at a specific date and time, or at regular intervals.
882 883 884 885 |
# File 'gems/aws-sdk-gluedatabrew/lib/aws-sdk-gluedatabrew/client.rb', line 882 def create_schedule(params = {}, = {}) req = build_request(:create_schedule, params) req.send_request() end |
#delete_dataset(params = {}) ⇒ Types::DeleteDatasetResponse
Deletes a dataset from DataBrew.
910 911 912 913 |
# File 'gems/aws-sdk-gluedatabrew/lib/aws-sdk-gluedatabrew/client.rb', line 910 def delete_dataset(params = {}, = {}) req = build_request(:delete_dataset, params) req.send_request() end |
#delete_job(params = {}) ⇒ Types::DeleteJobResponse
Deletes the specified DataBrew job.
938 939 940 941 |
# File 'gems/aws-sdk-gluedatabrew/lib/aws-sdk-gluedatabrew/client.rb', line 938 def delete_job(params = {}, = {}) req = build_request(:delete_job, params) req.send_request() end |
#delete_project(params = {}) ⇒ Types::DeleteProjectResponse
Deletes an existing DataBrew project.
966 967 968 969 |
# File 'gems/aws-sdk-gluedatabrew/lib/aws-sdk-gluedatabrew/client.rb', line 966 def delete_project(params = {}, = {}) req = build_request(:delete_project, params) req.send_request() end |
#delete_recipe_version(params = {}) ⇒ Types::DeleteRecipeVersionResponse
Deletes a single version of a DataBrew recipe.
1002 1003 1004 1005 |
# File 'gems/aws-sdk-gluedatabrew/lib/aws-sdk-gluedatabrew/client.rb', line 1002 def delete_recipe_version(params = {}, = {}) req = build_request(:delete_recipe_version, params) req.send_request() end |
#delete_schedule(params = {}) ⇒ Types::DeleteScheduleResponse
Deletes the specified DataBrew schedule.
1030 1031 1032 1033 |
# File 'gems/aws-sdk-gluedatabrew/lib/aws-sdk-gluedatabrew/client.rb', line 1030 def delete_schedule(params = {}, = {}) req = build_request(:delete_schedule, params) req.send_request() end |
#describe_dataset(params = {}) ⇒ Types::DescribeDatasetResponse
Returns the definition of a specific DataBrew dataset.
1113 1114 1115 1116 |
# File 'gems/aws-sdk-gluedatabrew/lib/aws-sdk-gluedatabrew/client.rb', line 1113 def describe_dataset(params = {}, = {}) req = build_request(:describe_dataset, params) req.send_request() end |
#describe_job(params = {}) ⇒ Types::DescribeJobResponse
Returns the definition of a specific DataBrew job.
1190 1191 1192 1193 |
# File 'gems/aws-sdk-gluedatabrew/lib/aws-sdk-gluedatabrew/client.rb', line 1190 def describe_job(params = {}, = {}) req = build_request(:describe_job, params) req.send_request() end |
#describe_job_run(params = {}) ⇒ Types::DescribeJobRunResponse
Represents one run of a DataBrew job.
1260 1261 1262 1263 |
# File 'gems/aws-sdk-gluedatabrew/lib/aws-sdk-gluedatabrew/client.rb', line 1260 def describe_job_run(params = {}, = {}) req = build_request(:describe_job_run, params) req.send_request() end |
#describe_project(params = {}) ⇒ Types::DescribeProjectResponse
Returns the definition of a specific DataBrew project.
1316 1317 1318 1319 |
# File 'gems/aws-sdk-gluedatabrew/lib/aws-sdk-gluedatabrew/client.rb', line 1316 def describe_project(params = {}, = {}) req = build_request(:describe_project, params) req.send_request() end |
#describe_recipe(params = {}) ⇒ Types::DescribeRecipeResponse
Returns the definition of a specific DataBrew recipe corresponding to a particular version.
1382 1383 1384 1385 |
# File 'gems/aws-sdk-gluedatabrew/lib/aws-sdk-gluedatabrew/client.rb', line 1382 def describe_recipe(params = {}, = {}) req = build_request(:describe_recipe, params) req.send_request() end |
#describe_schedule(params = {}) ⇒ Types::DescribeScheduleResponse
Returns the definition of a specific DataBrew schedule.
1428 1429 1430 1431 |
# File 'gems/aws-sdk-gluedatabrew/lib/aws-sdk-gluedatabrew/client.rb', line 1428 def describe_schedule(params = {}, = {}) req = build_request(:describe_schedule, params) req.send_request() end |
#list_datasets(params = {}) ⇒ Types::ListDatasetsResponse
Lists all of the DataBrew datasets.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1511 1512 1513 1514 |
# File 'gems/aws-sdk-gluedatabrew/lib/aws-sdk-gluedatabrew/client.rb', line 1511 def list_datasets(params = {}, = {}) req = build_request(:list_datasets, params) req.send_request() end |
#list_job_runs(params = {}) ⇒ Types::ListJobRunsResponse
Lists all of the previous runs of a particular DataBrew job.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1577 1578 1579 1580 |
# File 'gems/aws-sdk-gluedatabrew/lib/aws-sdk-gluedatabrew/client.rb', line 1577 def list_job_runs(params = {}, = {}) req = build_request(:list_job_runs, params) req.send_request() end |
#list_jobs(params = {}) ⇒ Types::ListJobsResponse
Lists all of the DataBrew jobs that are defined.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1658 1659 1660 1661 |
# File 'gems/aws-sdk-gluedatabrew/lib/aws-sdk-gluedatabrew/client.rb', line 1658 def list_jobs(params = {}, = {}) req = build_request(:list_jobs, params) req.send_request() end |
#list_projects(params = {}) ⇒ Types::ListProjectsResponse
Lists all of the DataBrew projects that are defined.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1711 1712 1713 1714 |
# File 'gems/aws-sdk-gluedatabrew/lib/aws-sdk-gluedatabrew/client.rb', line 1711 def list_projects(params = {}, = {}) req = build_request(:list_projects, params) req.send_request() end |
#list_recipe_versions(params = {}) ⇒ Types::ListRecipeVersionsResponse
Lists the versions of a particular DataBrew recipe, except for
LATEST_WORKING
.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1774 1775 1776 1777 |
# File 'gems/aws-sdk-gluedatabrew/lib/aws-sdk-gluedatabrew/client.rb', line 1774 def list_recipe_versions(params = {}, = {}) req = build_request(:list_recipe_versions, params) req.send_request() end |
#list_recipes(params = {}) ⇒ Types::ListRecipesResponse
Lists all of the DataBrew recipes that are defined.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1840 1841 1842 1843 |
# File 'gems/aws-sdk-gluedatabrew/lib/aws-sdk-gluedatabrew/client.rb', line 1840 def list_recipes(params = {}, = {}) req = build_request(:list_recipes, params) req.send_request() end |
#list_schedules(params = {}) ⇒ Types::ListSchedulesResponse
Lists the DataBrew schedules that are defined.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1893 1894 1895 1896 |
# File 'gems/aws-sdk-gluedatabrew/lib/aws-sdk-gluedatabrew/client.rb', line 1893 def list_schedules(params = {}, = {}) req = build_request(:list_schedules, params) req.send_request() end |
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Lists all the tags for a DataBrew resource.
1923 1924 1925 1926 |
# File 'gems/aws-sdk-gluedatabrew/lib/aws-sdk-gluedatabrew/client.rb', line 1923 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() end |
#publish_recipe(params = {}) ⇒ Types::PublishRecipeResponse
Publishes a new version of a DataBrew recipe.
1956 1957 1958 1959 |
# File 'gems/aws-sdk-gluedatabrew/lib/aws-sdk-gluedatabrew/client.rb', line 1956 def publish_recipe(params = {}, = {}) req = build_request(:publish_recipe, params) req.send_request() end |
#send_project_session_action(params = {}) ⇒ Types::SendProjectSessionActionResponse
Performs a recipe step within an interactive DataBrew session that's currently open.
2031 2032 2033 2034 |
# File 'gems/aws-sdk-gluedatabrew/lib/aws-sdk-gluedatabrew/client.rb', line 2031 def send_project_session_action(params = {}, = {}) req = build_request(:send_project_session_action, params) req.send_request() end |
#start_job_run(params = {}) ⇒ Types::StartJobRunResponse
Runs a DataBrew job.
2059 2060 2061 2062 |
# File 'gems/aws-sdk-gluedatabrew/lib/aws-sdk-gluedatabrew/client.rb', line 2059 def start_job_run(params = {}, = {}) req = build_request(:start_job_run, params) req.send_request() end |
#start_project_session(params = {}) ⇒ Types::StartProjectSessionResponse
Creates an interactive session, enabling you to manipulate data in a DataBrew project.
2095 2096 2097 2098 |
# File 'gems/aws-sdk-gluedatabrew/lib/aws-sdk-gluedatabrew/client.rb', line 2095 def start_project_session(params = {}, = {}) req = build_request(:start_project_session, params) req.send_request() end |
#stop_job_run(params = {}) ⇒ Types::StopJobRunResponse
Stops a particular run of a job.
2127 2128 2129 2130 |
# File 'gems/aws-sdk-gluedatabrew/lib/aws-sdk-gluedatabrew/client.rb', line 2127 def stop_job_run(params = {}, = {}) req = build_request(:stop_job_run, params) req.send_request() end |
#tag_resource(params = {}) ⇒ Struct
Adds metadata tags to a DataBrew resource, such as a dataset, project, recipe, job, or schedule.
2158 2159 2160 2161 |
# File 'gems/aws-sdk-gluedatabrew/lib/aws-sdk-gluedatabrew/client.rb', line 2158 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Removes metadata tags from a DataBrew resource.
2185 2186 2187 2188 |
# File 'gems/aws-sdk-gluedatabrew/lib/aws-sdk-gluedatabrew/client.rb', line 2185 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_dataset(params = {}) ⇒ Types::UpdateDatasetResponse
Modifies the definition of an existing DataBrew dataset.
2298 2299 2300 2301 |
# File 'gems/aws-sdk-gluedatabrew/lib/aws-sdk-gluedatabrew/client.rb', line 2298 def update_dataset(params = {}, = {}) req = build_request(:update_dataset, params) req.send_request() end |
#update_profile_job(params = {}) ⇒ Types::UpdateProfileJobResponse
Modifies the definition of an existing profile job.
2382 2383 2384 2385 |
# File 'gems/aws-sdk-gluedatabrew/lib/aws-sdk-gluedatabrew/client.rb', line 2382 def update_profile_job(params = {}, = {}) req = build_request(:update_profile_job, params) req.send_request() end |
#update_project(params = {}) ⇒ Types::UpdateProjectResponse
Modifies the definition of an existing DataBrew project.
2425 2426 2427 2428 |
# File 'gems/aws-sdk-gluedatabrew/lib/aws-sdk-gluedatabrew/client.rb', line 2425 def update_project(params = {}, = {}) req = build_request(:update_project, params) req.send_request() end |
#update_recipe(params = {}) ⇒ Types::UpdateRecipeResponse
Modifies the definition of the LATEST_WORKING
version of a DataBrew
recipe.
2479 2480 2481 2482 |
# File 'gems/aws-sdk-gluedatabrew/lib/aws-sdk-gluedatabrew/client.rb', line 2479 def update_recipe(params = {}, = {}) req = build_request(:update_recipe, params) req.send_request() end |
#update_recipe_job(params = {}) ⇒ Types::UpdateRecipeJobResponse
Modifies the definition of an existing DataBrew recipe job.
2564 2565 2566 2567 |
# File 'gems/aws-sdk-gluedatabrew/lib/aws-sdk-gluedatabrew/client.rb', line 2564 def update_recipe_job(params = {}, = {}) req = build_request(:update_recipe_job, params) req.send_request() end |
#update_schedule(params = {}) ⇒ Types::UpdateScheduleResponse
Modifies the definition of an existing DataBrew schedule.
2606 2607 2608 2609 |
# File 'gems/aws-sdk-gluedatabrew/lib/aws-sdk-gluedatabrew/client.rb', line 2606 def update_schedule(params = {}, = {}) req = build_request(:update_schedule, params) req.send_request() end |