Class: Aws::EMRServerless::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::EMRServerless::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-emrserverless/lib/aws-sdk-emrserverless/client.rb
Overview
An API client for EMRServerless. To construct a client, you need to configure a :region
and :credentials
.
client = Aws::EMRServerless::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
-
#cancel_job_run(params = {}) ⇒ Types::CancelJobRunResponse
Cancels a job run.
-
#create_application(params = {}) ⇒ Types::CreateApplicationResponse
Creates an application.
-
#delete_application(params = {}) ⇒ Struct
Deletes an application.
-
#get_application(params = {}) ⇒ Types::GetApplicationResponse
Displays detailed information about a specified application.
-
#get_dashboard_for_job_run(params = {}) ⇒ Types::GetDashboardForJobRunResponse
Creates and returns a URL that you can use to access the application UIs for a job run.
-
#get_job_run(params = {}) ⇒ Types::GetJobRunResponse
Displays detailed information about a job run.
-
#list_applications(params = {}) ⇒ Types::ListApplicationsResponse
Lists applications based on a set of parameters.
-
#list_job_run_attempts(params = {}) ⇒ Types::ListJobRunAttemptsResponse
Lists all attempt of a job run.
-
#list_job_runs(params = {}) ⇒ Types::ListJobRunsResponse
Lists job runs based on a set of parameters.
-
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Lists the tags assigned to the resources.
-
#start_application(params = {}) ⇒ Struct
Starts a specified application and initializes initial capacity if configured.
-
#start_job_run(params = {}) ⇒ Types::StartJobRunResponse
Starts a job run.
-
#stop_application(params = {}) ⇒ Struct
Stops a specified application and releases initial capacity if configured.
-
#tag_resource(params = {}) ⇒ Struct
Assigns tags to resources.
-
#untag_resource(params = {}) ⇒ Struct
Removes tags from resources.
-
#update_application(params = {}) ⇒ Types::UpdateApplicationResponse
Updates a specified application.
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.
410 411 412 |
# File 'gems/aws-sdk-emrserverless/lib/aws-sdk-emrserverless/client.rb', line 410 def initialize(*args) super end |
Instance Method Details
#cancel_job_run(params = {}) ⇒ Types::CancelJobRunResponse
Cancels a job run.
445 446 447 448 |
# File 'gems/aws-sdk-emrserverless/lib/aws-sdk-emrserverless/client.rb', line 445 def cancel_job_run(params = {}, = {}) req = build_request(:cancel_job_run, params) req.send_request() end |
#create_application(params = {}) ⇒ Types::CreateApplicationResponse
Creates an application.
628 629 630 631 |
# File 'gems/aws-sdk-emrserverless/lib/aws-sdk-emrserverless/client.rb', line 628 def create_application(params = {}, = {}) req = build_request(:create_application, params) req.send_request() end |
#delete_application(params = {}) ⇒ Struct
Deletes an application. An application has to be in a stopped or created state in order to be deleted.
651 652 653 654 |
# File 'gems/aws-sdk-emrserverless/lib/aws-sdk-emrserverless/client.rb', line 651 def delete_application(params = {}, = {}) req = build_request(:delete_application, params) req.send_request() end |
#get_application(params = {}) ⇒ Types::GetApplicationResponse
Displays detailed information about a specified application.
730 731 732 733 |
# File 'gems/aws-sdk-emrserverless/lib/aws-sdk-emrserverless/client.rb', line 730 def get_application(params = {}, = {}) req = build_request(:get_application, params) req.send_request() end |
#get_dashboard_for_job_run(params = {}) ⇒ Types::GetDashboardForJobRunResponse
Creates and returns a URL that you can use to access the application UIs for a job run.
For jobs in a running state, the application UI is a live user interface such as the Spark or Tez web UI. For completed jobs, the application UI is a persistent application user interface such as the Spark History Server or persistent Tez UI.
780 781 782 783 |
# File 'gems/aws-sdk-emrserverless/lib/aws-sdk-emrserverless/client.rb', line 780 def get_dashboard_for_job_run(params = {}, = {}) req = build_request(:get_dashboard_for_job_run, params) req.send_request() end |
#get_job_run(params = {}) ⇒ Types::GetJobRunResponse
Displays detailed information about a job run.
872 873 874 875 |
# File 'gems/aws-sdk-emrserverless/lib/aws-sdk-emrserverless/client.rb', line 872 def get_job_run(params = {}, = {}) req = build_request(:get_job_run, params) req.send_request() end |
#list_applications(params = {}) ⇒ Types::ListApplicationsResponse
Lists applications based on a set of parameters.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
924 925 926 927 |
# File 'gems/aws-sdk-emrserverless/lib/aws-sdk-emrserverless/client.rb', line 924 def list_applications(params = {}, = {}) req = build_request(:list_applications, params) req.send_request() end |
#list_job_run_attempts(params = {}) ⇒ Types::ListJobRunAttemptsResponse
Lists all attempt of a job run.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
983 984 985 986 |
# File 'gems/aws-sdk-emrserverless/lib/aws-sdk-emrserverless/client.rb', line 983 def list_job_run_attempts(params = {}, = {}) req = build_request(:list_job_run_attempts, params) req.send_request() end |
#list_job_runs(params = {}) ⇒ Types::ListJobRunsResponse
Lists job runs based on a set of parameters.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1057 1058 1059 1060 |
# File 'gems/aws-sdk-emrserverless/lib/aws-sdk-emrserverless/client.rb', line 1057 def list_job_runs(params = {}, = {}) req = build_request(:list_job_runs, params) req.send_request() end |
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Lists the tags assigned to the resources.
1088 1089 1090 1091 |
# File 'gems/aws-sdk-emrserverless/lib/aws-sdk-emrserverless/client.rb', line 1088 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() end |
#start_application(params = {}) ⇒ Struct
Starts a specified application and initializes initial capacity if configured.
1111 1112 1113 1114 |
# File 'gems/aws-sdk-emrserverless/lib/aws-sdk-emrserverless/client.rb', line 1111 def start_application(params = {}, = {}) req = build_request(:start_application, params) req.send_request() end |
#start_job_run(params = {}) ⇒ Types::StartJobRunResponse
Starts a job run.
1234 1235 1236 1237 |
# File 'gems/aws-sdk-emrserverless/lib/aws-sdk-emrserverless/client.rb', line 1234 def start_job_run(params = {}, = {}) req = build_request(:start_job_run, params) req.send_request() end |
#stop_application(params = {}) ⇒ Struct
Stops a specified application and releases initial capacity if configured. All scheduled and running jobs must be completed or cancelled before stopping an application.
1258 1259 1260 1261 |
# File 'gems/aws-sdk-emrserverless/lib/aws-sdk-emrserverless/client.rb', line 1258 def stop_application(params = {}, = {}) req = build_request(:stop_application, params) req.send_request() end |
#tag_resource(params = {}) ⇒ Struct
Assigns tags to resources. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value, both of which you define. Tags enable you to categorize your Amazon Web Services resources by attributes such as purpose, owner, or environment. When you have many resources of the same type, you can quickly identify a specific resource based on the tags you've assigned to it.
1294 1295 1296 1297 |
# File 'gems/aws-sdk-emrserverless/lib/aws-sdk-emrserverless/client.rb', line 1294 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Removes tags from resources.
1322 1323 1324 1325 |
# File 'gems/aws-sdk-emrserverless/lib/aws-sdk-emrserverless/client.rb', line 1322 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_application(params = {}) ⇒ Types::UpdateApplicationResponse
Updates a specified application. An application has to be in a stopped or created state in order to be updated.
1544 1545 1546 1547 |
# File 'gems/aws-sdk-emrserverless/lib/aws-sdk-emrserverless/client.rb', line 1544 def update_application(params = {}, = {}) req = build_request(:update_application, params) req.send_request() end |