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 AWS Glue DataBrew dataset for this AWS account.
-
#create_profile_job(params = {}) ⇒ Types::CreateProfileJobResponse
Creates a new job to profile an AWS Glue DataBrew dataset that exists in the current AWS account.
-
#create_project(params = {}) ⇒ Types::CreateProjectResponse
Creates a new AWS Glue DataBrew project in the current AWS account.
-
#create_recipe(params = {}) ⇒ Types::CreateRecipeResponse
Creates a new AWS Glue DataBrew recipe for the current AWS account.
-
#create_recipe_job(params = {}) ⇒ Types::CreateRecipeJobResponse
Creates a new job for an existing AWS Glue DataBrew recipe in the current AWS account.
-
#create_schedule(params = {}) ⇒ Types::CreateScheduleResponse
Creates a new schedule for one or more AWS Glue DataBrew jobs.
-
#delete_dataset(params = {}) ⇒ Types::DeleteDatasetResponse
Deletes a dataset from AWS Glue DataBrew.
-
#delete_job(params = {}) ⇒ Types::DeleteJobResponse
Deletes the specified AWS Glue DataBrew job from the current AWS account.
-
#delete_project(params = {}) ⇒ Types::DeleteProjectResponse
Deletes an existing AWS Glue DataBrew project from the current AWS account.
-
#delete_recipe_version(params = {}) ⇒ Types::DeleteRecipeVersionResponse
Deletes a single version of an AWS Glue DataBrew recipe.
-
#delete_schedule(params = {}) ⇒ Types::DeleteScheduleResponse
Deletes the specified AWS Glue DataBrew schedule from the current AWS account.
-
#describe_dataset(params = {}) ⇒ Types::DescribeDatasetResponse
Returns the definition of a specific AWS Glue DataBrew dataset that is in the current AWS account.
-
#describe_job(params = {}) ⇒ Types::DescribeJobResponse
Returns the definition of a specific AWS Glue DataBrew job that is in the current AWS account.
-
#describe_project(params = {}) ⇒ Types::DescribeProjectResponse
Returns the definition of a specific AWS Glue DataBrew project that is in the current AWS account.
-
#describe_recipe(params = {}) ⇒ Types::DescribeRecipeResponse
Returns the definition of a specific AWS Glue DataBrew recipe that is in the current AWS account.
-
#describe_schedule(params = {}) ⇒ Types::DescribeScheduleResponse
Returns the definition of a specific AWS Glue DataBrew schedule that is in the current AWS account.
-
#list_datasets(params = {}) ⇒ Types::ListDatasetsResponse
Lists all of the AWS Glue DataBrew datasets for the current AWS account.
-
#list_job_runs(params = {}) ⇒ Types::ListJobRunsResponse
Lists all of the previous runs of a particular AWS Glue DataBrew job in the current AWS account.
-
#list_jobs(params = {}) ⇒ Types::ListJobsResponse
Lists the AWS Glue DataBrew jobs in the current AWS account.
-
#list_projects(params = {}) ⇒ Types::ListProjectsResponse
Lists all of the DataBrew projects in the current AWS account.
-
#list_recipe_versions(params = {}) ⇒ Types::ListRecipeVersionsResponse
Lists all of the versions of a particular AWS Glue DataBrew recipe in the current AWS account.
-
#list_recipes(params = {}) ⇒ Types::ListRecipesResponse
Lists all of the AWS Glue DataBrew recipes in the current AWS account.
-
#list_schedules(params = {}) ⇒ Types::ListSchedulesResponse
Lists the AWS Glue DataBrew schedules in the current AWS account.
-
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Lists all the tags for an AWS Glue DataBrew resource.
-
#publish_recipe(params = {}) ⇒ Types::PublishRecipeResponse
Publishes a new major version of an AWS Glue DataBrew recipe that exists in the current AWS account.
-
#send_project_session_action(params = {}) ⇒ Types::SendProjectSessionActionResponse
Performs a recipe step within an interactive AWS Glue DataBrew session that's currently open.
-
#start_job_run(params = {}) ⇒ Types::StartJobRunResponse
Runs an AWS Glue DataBrew job that exists in the current AWS account.
-
#start_project_session(params = {}) ⇒ Types::StartProjectSessionResponse
Creates an interactive session, enabling you to manipulate an AWS Glue DataBrew project.
-
#stop_job_run(params = {}) ⇒ Types::StopJobRunResponse
Stops the specified job from running in the current AWS account.
-
#tag_resource(params = {}) ⇒ Struct
Adds metadata tags to an AWS Glue DataBrew resource, such as a dataset, job, project, or recipe.
-
#untag_resource(params = {}) ⇒ Struct
Removes metadata tags from an AWS Glue DataBrew resource.
-
#update_dataset(params = {}) ⇒ Types::UpdateDatasetResponse
Modifies the definition of an existing AWS Glue DataBrew dataset in the current AWS account.
-
#update_profile_job(params = {}) ⇒ Types::UpdateProfileJobResponse
Modifies the definition of an existing AWS Glue DataBrew job in the current AWS account.
-
#update_project(params = {}) ⇒ Types::UpdateProjectResponse
Modifies the definition of an existing AWS Glue DataBrew project in the current AWS account.
-
#update_recipe(params = {}) ⇒ Types::UpdateRecipeResponse
Modifies the definition of the latest working version of an AWS Glue DataBrew recipe in the current AWS account.
-
#update_recipe_job(params = {}) ⇒ Types::UpdateRecipeJobResponse
Modifies the definition of an existing AWS Glue DataBrew recipe job in the current AWS account.
-
#update_schedule(params = {}) ⇒ Types::UpdateScheduleResponse
Modifies the definition of an existing AWS Glue DataBrew schedule in the current AWS account.
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.
362 363 364 365 |
# File 'gems/aws-sdk-gluedatabrew/lib/aws-sdk-gluedatabrew/client.rb', line 362 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 AWS Glue DataBrew dataset for this AWS account.
428 429 430 431 |
# File 'gems/aws-sdk-gluedatabrew/lib/aws-sdk-gluedatabrew/client.rb', line 428 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 profile an AWS Glue DataBrew dataset that exists in the current AWS account.
514 515 516 517 |
# File 'gems/aws-sdk-gluedatabrew/lib/aws-sdk-gluedatabrew/client.rb', line 514 def create_profile_job(params = {}, = {}) req = build_request(:create_profile_job, params) req.send_request() end |
#create_project(params = {}) ⇒ Types::CreateProjectResponse
Creates a new AWS Glue DataBrew project in the current AWS account.
569 570 571 572 |
# File 'gems/aws-sdk-gluedatabrew/lib/aws-sdk-gluedatabrew/client.rb', line 569 def create_project(params = {}, = {}) req = build_request(:create_project, params) req.send_request() end |
#create_recipe(params = {}) ⇒ Types::CreateRecipeResponse
Creates a new AWS Glue DataBrew recipe for the current AWS account.
629 630 631 632 |
# File 'gems/aws-sdk-gluedatabrew/lib/aws-sdk-gluedatabrew/client.rb', line 629 def create_recipe(params = {}, = {}) req = build_request(:create_recipe, params) req.send_request() end |
#create_recipe_job(params = {}) ⇒ Types::CreateRecipeJobResponse
Creates a new job for an existing AWS Glue DataBrew recipe in the current AWS account. You can create a standalone job using either a project, or a combination of a recipe and a dataset.
734 735 736 737 |
# File 'gems/aws-sdk-gluedatabrew/lib/aws-sdk-gluedatabrew/client.rb', line 734 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 AWS Glue DataBrew jobs. Jobs can be run at a specific date and time, or at regular intervals.
778 779 780 781 |
# File 'gems/aws-sdk-gluedatabrew/lib/aws-sdk-gluedatabrew/client.rb', line 778 def create_schedule(params = {}, = {}) req = build_request(:create_schedule, params) req.send_request() end |
#delete_dataset(params = {}) ⇒ Types::DeleteDatasetResponse
Deletes a dataset from AWS Glue DataBrew.
806 807 808 809 |
# File 'gems/aws-sdk-gluedatabrew/lib/aws-sdk-gluedatabrew/client.rb', line 806 def delete_dataset(params = {}, = {}) req = build_request(:delete_dataset, params) req.send_request() end |
#delete_job(params = {}) ⇒ Types::DeleteJobResponse
Deletes the specified AWS Glue DataBrew job from the current AWS account. The job can be for a recipe or for a profile.
835 836 837 838 |
# File 'gems/aws-sdk-gluedatabrew/lib/aws-sdk-gluedatabrew/client.rb', line 835 def delete_job(params = {}, = {}) req = build_request(:delete_job, params) req.send_request() end |
#delete_project(params = {}) ⇒ Types::DeleteProjectResponse
Deletes an existing AWS Glue DataBrew project from the current AWS account.
864 865 866 867 |
# File 'gems/aws-sdk-gluedatabrew/lib/aws-sdk-gluedatabrew/client.rb', line 864 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 an AWS Glue DataBrew recipe.
898 899 900 901 |
# File 'gems/aws-sdk-gluedatabrew/lib/aws-sdk-gluedatabrew/client.rb', line 898 def delete_recipe_version(params = {}, = {}) req = build_request(:delete_recipe_version, params) req.send_request() end |
#delete_schedule(params = {}) ⇒ Types::DeleteScheduleResponse
Deletes the specified AWS Glue DataBrew schedule from the current AWS account.
927 928 929 930 |
# File 'gems/aws-sdk-gluedatabrew/lib/aws-sdk-gluedatabrew/client.rb', line 927 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 AWS Glue DataBrew dataset that is in the current AWS account.
985 986 987 988 |
# File 'gems/aws-sdk-gluedatabrew/lib/aws-sdk-gluedatabrew/client.rb', line 985 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 AWS Glue DataBrew job that is in the current AWS account.
1059 1060 1061 1062 |
# File 'gems/aws-sdk-gluedatabrew/lib/aws-sdk-gluedatabrew/client.rb', line 1059 def describe_job(params = {}, = {}) req = build_request(:describe_job, params) req.send_request() end |
#describe_project(params = {}) ⇒ Types::DescribeProjectResponse
Returns the definition of a specific AWS Glue DataBrew project that is in the current AWS account.
1116 1117 1118 1119 |
# File 'gems/aws-sdk-gluedatabrew/lib/aws-sdk-gluedatabrew/client.rb', line 1116 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 AWS Glue DataBrew recipe that is in the current AWS account.
1182 1183 1184 1185 |
# File 'gems/aws-sdk-gluedatabrew/lib/aws-sdk-gluedatabrew/client.rb', line 1182 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 AWS Glue DataBrew schedule that is in the current AWS account.
1229 1230 1231 1232 |
# File 'gems/aws-sdk-gluedatabrew/lib/aws-sdk-gluedatabrew/client.rb', line 1229 def describe_schedule(params = {}, = {}) req = build_request(:describe_schedule, params) req.send_request() end |
#list_datasets(params = {}) ⇒ Types::ListDatasetsResponse
Lists all of the AWS Glue DataBrew datasets for the current AWS account.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1291 1292 1293 1294 |
# File 'gems/aws-sdk-gluedatabrew/lib/aws-sdk-gluedatabrew/client.rb', line 1291 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 AWS Glue DataBrew job in the current AWS account.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1357 1358 1359 1360 |
# File 'gems/aws-sdk-gluedatabrew/lib/aws-sdk-gluedatabrew/client.rb', line 1357 def list_job_runs(params = {}, = {}) req = build_request(:list_job_runs, params) req.send_request() end |
#list_jobs(params = {}) ⇒ Types::ListJobsResponse
Lists the AWS Glue DataBrew jobs in the current AWS account.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1435 1436 1437 1438 |
# File 'gems/aws-sdk-gluedatabrew/lib/aws-sdk-gluedatabrew/client.rb', line 1435 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 in the current AWS account.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1487 1488 1489 1490 |
# File 'gems/aws-sdk-gluedatabrew/lib/aws-sdk-gluedatabrew/client.rb', line 1487 def list_projects(params = {}, = {}) req = build_request(:list_projects, params) req.send_request() end |
#list_recipe_versions(params = {}) ⇒ Types::ListRecipeVersionsResponse
Lists all of the versions of a particular AWS Glue DataBrew recipe in the current AWS account.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1549 1550 1551 1552 |
# File 'gems/aws-sdk-gluedatabrew/lib/aws-sdk-gluedatabrew/client.rb', line 1549 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 AWS Glue DataBrew recipes in the current AWS account.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1611 1612 1613 1614 |
# File 'gems/aws-sdk-gluedatabrew/lib/aws-sdk-gluedatabrew/client.rb', line 1611 def list_recipes(params = {}, = {}) req = build_request(:list_recipes, params) req.send_request() end |
#list_schedules(params = {}) ⇒ Types::ListSchedulesResponse
Lists the AWS Glue DataBrew schedules in the current AWS account.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1663 1664 1665 1666 |
# File 'gems/aws-sdk-gluedatabrew/lib/aws-sdk-gluedatabrew/client.rb', line 1663 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 an AWS Glue DataBrew resource.
1693 1694 1695 1696 |
# File 'gems/aws-sdk-gluedatabrew/lib/aws-sdk-gluedatabrew/client.rb', line 1693 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() end |
#publish_recipe(params = {}) ⇒ Types::PublishRecipeResponse
Publishes a new major version of an AWS Glue DataBrew recipe that exists in the current AWS account.
1727 1728 1729 1730 |
# File 'gems/aws-sdk-gluedatabrew/lib/aws-sdk-gluedatabrew/client.rb', line 1727 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 AWS Glue DataBrew session that's currently open.
1804 1805 1806 1807 |
# File 'gems/aws-sdk-gluedatabrew/lib/aws-sdk-gluedatabrew/client.rb', line 1804 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 an AWS Glue DataBrew job that exists in the current AWS account.
1832 1833 1834 1835 |
# File 'gems/aws-sdk-gluedatabrew/lib/aws-sdk-gluedatabrew/client.rb', line 1832 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 an AWS Glue DataBrew project.
1868 1869 1870 1871 |
# File 'gems/aws-sdk-gluedatabrew/lib/aws-sdk-gluedatabrew/client.rb', line 1868 def start_project_session(params = {}, = {}) req = build_request(:start_project_session, params) req.send_request() end |
#stop_job_run(params = {}) ⇒ Types::StopJobRunResponse
Stops the specified job from running in the current AWS account.
1900 1901 1902 1903 |
# File 'gems/aws-sdk-gluedatabrew/lib/aws-sdk-gluedatabrew/client.rb', line 1900 def stop_job_run(params = {}, = {}) req = build_request(:stop_job_run, params) req.send_request() end |
#tag_resource(params = {}) ⇒ Struct
Adds metadata tags to an AWS Glue DataBrew resource, such as a dataset, job, project, or recipe.
1931 1932 1933 1934 |
# File 'gems/aws-sdk-gluedatabrew/lib/aws-sdk-gluedatabrew/client.rb', line 1931 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Removes metadata tags from an AWS Glue DataBrew resource.
1958 1959 1960 1961 |
# File 'gems/aws-sdk-gluedatabrew/lib/aws-sdk-gluedatabrew/client.rb', line 1958 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 AWS Glue DataBrew dataset in the current AWS account.
2019 2020 2021 2022 |
# File 'gems/aws-sdk-gluedatabrew/lib/aws-sdk-gluedatabrew/client.rb', line 2019 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 AWS Glue DataBrew job in the current AWS account.
2094 2095 2096 2097 |
# File 'gems/aws-sdk-gluedatabrew/lib/aws-sdk-gluedatabrew/client.rb', line 2094 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 AWS Glue DataBrew project in the current AWS account.
2138 2139 2140 2141 |
# File 'gems/aws-sdk-gluedatabrew/lib/aws-sdk-gluedatabrew/client.rb', line 2138 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 an AWS Glue DataBrew recipe in the current AWS account.
2192 2193 2194 2195 |
# File 'gems/aws-sdk-gluedatabrew/lib/aws-sdk-gluedatabrew/client.rb', line 2192 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 AWS Glue DataBrew recipe job in the current AWS account.
2274 2275 2276 2277 |
# File 'gems/aws-sdk-gluedatabrew/lib/aws-sdk-gluedatabrew/client.rb', line 2274 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 AWS Glue DataBrew schedule in the current AWS account.
2312 2313 2314 2315 |
# File 'gems/aws-sdk-gluedatabrew/lib/aws-sdk-gluedatabrew/client.rb', line 2312 def update_schedule(params = {}, = {}) req = build_request(:update_schedule, params) req.send_request() end |