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.
-
#get_resource_dashboard(params = {}) ⇒ Types::GetResourceDashboardResponse
Returns a URL that you can use to access the application UIs for a specified resource, such as a session.
-
#get_session(params = {}) ⇒ Types::GetSessionResponse
Displays detailed information about a session.
-
#get_session_endpoint(params = {}) ⇒ Types::GetSessionEndpointResponse
Returns the session endpoint URL and a time-limited authentication token for the specified session.
-
#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_sessions(params = {}) ⇒ Types::ListSessionsResponse
Lists sessions for the specified application.
-
#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.
-
#start_session(params = {}) ⇒ Types::StartSessionResponse
Creates and starts a new session on the specified application.
-
#stop_application(params = {}) ⇒ Struct
Stops a specified application and releases initial capacity if configured.
-
#tag_resource(params = {}) ⇒ Struct
Assigns tags to resources.
-
#terminate_session(params = {}) ⇒ Types::TerminateSessionResponse
Terminates the specified session.
-
#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.
479 480 481 |
# File 'gems/aws-sdk-emrserverless/lib/aws-sdk-emrserverless/client.rb', line 479 def initialize(*args) super end |
Instance Method Details
#cancel_job_run(params = {}) ⇒ Types::CancelJobRunResponse
Cancels a job run.
519 520 521 522 |
# File 'gems/aws-sdk-emrserverless/lib/aws-sdk-emrserverless/client.rb', line 519 def cancel_job_run(params = {}, = {}) req = build_request(:cancel_job_run, params) req.send_request() end |
#create_application(params = {}) ⇒ Types::CreateApplicationResponse
Creates an application.
738 739 740 741 |
# File 'gems/aws-sdk-emrserverless/lib/aws-sdk-emrserverless/client.rb', line 738 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.
761 762 763 764 |
# File 'gems/aws-sdk-emrserverless/lib/aws-sdk-emrserverless/client.rb', line 761 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.
852 853 854 855 |
# File 'gems/aws-sdk-emrserverless/lib/aws-sdk-emrserverless/client.rb', line 852 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.
907 908 909 910 |
# File 'gems/aws-sdk-emrserverless/lib/aws-sdk-emrserverless/client.rb', line 907 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.
1016 1017 1018 1019 |
# File 'gems/aws-sdk-emrserverless/lib/aws-sdk-emrserverless/client.rb', line 1016 def get_job_run(params = {}, = {}) req = build_request(:get_job_run, params) req.send_request() end |
#get_resource_dashboard(params = {}) ⇒ Types::GetResourceDashboardResponse
Returns a URL that you can use to access the application UIs for a specified resource, such as a session.
For resources in a running state, the application UI is a live user interface such as the Spark web UI. For terminated resources, the application UI is a persistent application user interface such as the Spark History Server.
1070 1071 1072 1073 |
# File 'gems/aws-sdk-emrserverless/lib/aws-sdk-emrserverless/client.rb', line 1070 def get_resource_dashboard(params = {}, = {}) req = build_request(:get_resource_dashboard, params) req.send_request() end |
#get_session(params = {}) ⇒ Types::GetSessionResponse
Displays detailed information about a session.
1134 1135 1136 1137 |
# File 'gems/aws-sdk-emrserverless/lib/aws-sdk-emrserverless/client.rb', line 1134 def get_session(params = {}, = {}) req = build_request(:get_session, params) req.send_request() end |
#get_session_endpoint(params = {}) ⇒ Types::GetSessionEndpointResponse
Returns the session endpoint URL and a time-limited authentication token for the specified session. Use the endpoint and token to connect a client to the session. Call this operation again when the authentication token expires to obtain a new token.
1177 1178 1179 1180 |
# File 'gems/aws-sdk-emrserverless/lib/aws-sdk-emrserverless/client.rb', line 1177 def get_session_endpoint(params = {}, = {}) req = build_request(:get_session_endpoint, 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.
1229 1230 1231 1232 |
# File 'gems/aws-sdk-emrserverless/lib/aws-sdk-emrserverless/client.rb', line 1229 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.
1289 1290 1291 1292 |
# File 'gems/aws-sdk-emrserverless/lib/aws-sdk-emrserverless/client.rb', line 1289 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.
1364 1365 1366 1367 |
# File 'gems/aws-sdk-emrserverless/lib/aws-sdk-emrserverless/client.rb', line 1364 def list_job_runs(params = {}, = {}) req = build_request(:list_job_runs, params) req.send_request() end |
#list_sessions(params = {}) ⇒ Types::ListSessionsResponse
Lists sessions for the specified application. You can filter sessions by state and creation time.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1430 1431 1432 1433 |
# File 'gems/aws-sdk-emrserverless/lib/aws-sdk-emrserverless/client.rb', line 1430 def list_sessions(params = {}, = {}) req = build_request(:list_sessions, params) req.send_request() end |
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Lists the tags assigned to the resources.
1461 1462 1463 1464 |
# File 'gems/aws-sdk-emrserverless/lib/aws-sdk-emrserverless/client.rb', line 1461 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.
1484 1485 1486 1487 |
# File 'gems/aws-sdk-emrserverless/lib/aws-sdk-emrserverless/client.rb', line 1484 def start_application(params = {}, = {}) req = build_request(:start_application, params) req.send_request() end |
#start_job_run(params = {}) ⇒ Types::StartJobRunResponse
Starts a job run.
1633 1634 1635 1636 |
# File 'gems/aws-sdk-emrserverless/lib/aws-sdk-emrserverless/client.rb', line 1633 def start_job_run(params = {}, = {}) req = build_request(:start_job_run, params) req.send_request() end |
#start_session(params = {}) ⇒ Types::StartSessionResponse
Creates and starts a new session on the specified application. The
application must be in the STARTED state or have AutoStart
enabled, and have interactive sessions enabled. This operation is
supported for EMR release 7.13.0 and later.
1717 1718 1719 1720 |
# File 'gems/aws-sdk-emrserverless/lib/aws-sdk-emrserverless/client.rb', line 1717 def start_session(params = {}, = {}) req = build_request(:start_session, 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.
1741 1742 1743 1744 |
# File 'gems/aws-sdk-emrserverless/lib/aws-sdk-emrserverless/client.rb', line 1741 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.
1777 1778 1779 1780 |
# File 'gems/aws-sdk-emrserverless/lib/aws-sdk-emrserverless/client.rb', line 1777 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#terminate_session(params = {}) ⇒ Types::TerminateSessionResponse
Terminates the specified session. After you terminate a session, it
enters the TERMINATING state and then the TERMINATED state. You
can still access the Spark History Server for a terminated session
through the GetResourceDashboard operation.
1814 1815 1816 1817 |
# File 'gems/aws-sdk-emrserverless/lib/aws-sdk-emrserverless/client.rb', line 1814 def terminate_session(params = {}, = {}) req = build_request(:terminate_session, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Removes tags from resources.
1842 1843 1844 1845 |
# File 'gems/aws-sdk-emrserverless/lib/aws-sdk-emrserverless/client.rb', line 1842 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.
2112 2113 2114 2115 |
# File 'gems/aws-sdk-emrserverless/lib/aws-sdk-emrserverless/client.rb', line 2112 def update_application(params = {}, = {}) req = build_request(:update_application, params) req.send_request() end |