Class: Aws::EMRContainers::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::EMRContainers::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-emrcontainers/lib/aws-sdk-emrcontainers/client.rb
Overview
An API client for EMRContainers. To construct a client, you need to configure a :region and :credentials.
client = Aws::EMRContainers::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_job_template(params = {}) ⇒ Types::CreateJobTemplateResponse
Creates a job template.
-
#create_managed_endpoint(params = {}) ⇒ Types::CreateManagedEndpointResponse
Creates a managed endpoint.
-
#create_security_configuration(params = {}) ⇒ Types::CreateSecurityConfigurationResponse
Creates a security configuration.
-
#create_virtual_cluster(params = {}) ⇒ Types::CreateVirtualClusterResponse
Creates a virtual cluster.
-
#delete_job_template(params = {}) ⇒ Types::DeleteJobTemplateResponse
Deletes a job template.
-
#delete_managed_endpoint(params = {}) ⇒ Types::DeleteManagedEndpointResponse
Deletes a managed endpoint.
-
#delete_security_configuration(params = {}) ⇒ Types::DeleteSecurityConfigurationResponse
Deletes a security configuration.
-
#delete_virtual_cluster(params = {}) ⇒ Types::DeleteVirtualClusterResponse
Deletes a virtual cluster.
-
#describe_job_run(params = {}) ⇒ Types::DescribeJobRunResponse
Displays detailed information about a job run.
-
#describe_job_template(params = {}) ⇒ Types::DescribeJobTemplateResponse
Displays detailed information about a specified job template.
-
#describe_managed_endpoint(params = {}) ⇒ Types::DescribeManagedEndpointResponse
Displays detailed information about a managed endpoint.
-
#describe_security_configuration(params = {}) ⇒ Types::DescribeSecurityConfigurationResponse
Displays detailed information about a specified security configuration.
-
#describe_virtual_cluster(params = {}) ⇒ Types::DescribeVirtualClusterResponse
Displays detailed information about a specified virtual cluster.
-
#get_managed_endpoint_session_credentials(params = {}) ⇒ Types::GetManagedEndpointSessionCredentialsResponse
Generate a session token to connect to a managed endpoint.
-
#list_job_runs(params = {}) ⇒ Types::ListJobRunsResponse
Lists job runs based on a set of parameters.
-
#list_job_templates(params = {}) ⇒ Types::ListJobTemplatesResponse
Lists job templates based on a set of parameters.
-
#list_managed_endpoints(params = {}) ⇒ Types::ListManagedEndpointsResponse
Lists managed endpoints based on a set of parameters.
-
#list_security_configurations(params = {}) ⇒ Types::ListSecurityConfigurationsResponse
Lists security configurations based on a set of parameters.
-
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Lists the tags assigned to the resources.
-
#list_virtual_clusters(params = {}) ⇒ Types::ListVirtualClustersResponse
Lists information about the specified virtual cluster.
-
#start_job_run(params = {}) ⇒ Types::StartJobRunResponse
Starts a job run.
-
#tag_resource(params = {}) ⇒ Struct
Assigns tags to resources.
-
#untag_resource(params = {}) ⇒ Struct
Removes tags from resources.
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.
471 472 473 |
# File 'gems/aws-sdk-emrcontainers/lib/aws-sdk-emrcontainers/client.rb', line 471 def initialize(*args) super end |
Instance Method Details
#cancel_job_run(params = {}) ⇒ Types::CancelJobRunResponse
Cancels a job run. A job run is a unit of work, such as a Spark jar, PySpark script, or SparkSQL query, that you submit to Amazon EMR on EKS.
508 509 510 511 |
# File 'gems/aws-sdk-emrcontainers/lib/aws-sdk-emrcontainers/client.rb', line 508 def cancel_job_run(params = {}, = {}) req = build_request(:cancel_job_run, params) req.send_request() end |
#create_job_template(params = {}) ⇒ Types::CreateJobTemplateResponse
Creates a job template. Job template stores values of StartJobRun API request in a template and can be used to start a job run. Job template allows two use cases: avoid repeating recurring StartJobRun API request values, enforcing certain values in StartJobRun API request.
612 613 614 615 |
# File 'gems/aws-sdk-emrcontainers/lib/aws-sdk-emrcontainers/client.rb', line 612 def create_job_template(params = {}, = {}) req = build_request(:create_job_template, params) req.send_request() end |
#create_managed_endpoint(params = {}) ⇒ Types::CreateManagedEndpointResponse
Creates a managed endpoint. A managed endpoint is a gateway that connects Amazon EMR Studio to Amazon EMR on EKS so that Amazon EMR Studio can communicate with your virtual cluster.
722 723 724 725 |
# File 'gems/aws-sdk-emrcontainers/lib/aws-sdk-emrcontainers/client.rb', line 722 def create_managed_endpoint(params = {}, = {}) req = build_request(:create_managed_endpoint, params) req.send_request() end |
#create_security_configuration(params = {}) ⇒ Types::CreateSecurityConfigurationResponse
Creates a security configuration. Security configurations in Amazon EMR on EKS are templates for different security setups. You can use security configurations to configure the Lake Formation integration setup. You can also create a security configuration to re-use a security setup each time you create a virtual cluster.
820 821 822 823 |
# File 'gems/aws-sdk-emrcontainers/lib/aws-sdk-emrcontainers/client.rb', line 820 def create_security_configuration(params = {}, = {}) req = build_request(:create_security_configuration, params) req.send_request() end |
#create_virtual_cluster(params = {}) ⇒ Types::CreateVirtualClusterResponse
Creates a virtual cluster. Virtual cluster is a managed entity on Amazon EMR on EKS. You can create, describe, list and delete virtual clusters. They do not consume any additional resource in your system. A single virtual cluster maps to a single Kubernetes namespace. Given this relationship, you can model virtual clusters the same way you model Kubernetes namespaces to meet your requirements.
891 892 893 894 |
# File 'gems/aws-sdk-emrcontainers/lib/aws-sdk-emrcontainers/client.rb', line 891 def create_virtual_cluster(params = {}, = {}) req = build_request(:create_virtual_cluster, params) req.send_request() end |
#delete_job_template(params = {}) ⇒ Types::DeleteJobTemplateResponse
Deletes a job template. Job template stores values of StartJobRun API request in a template and can be used to start a job run. Job template allows two use cases: avoid repeating recurring StartJobRun API request values, enforcing certain values in StartJobRun API request.
922 923 924 925 |
# File 'gems/aws-sdk-emrcontainers/lib/aws-sdk-emrcontainers/client.rb', line 922 def delete_job_template(params = {}, = {}) req = build_request(:delete_job_template, params) req.send_request() end |
#delete_managed_endpoint(params = {}) ⇒ Types::DeleteManagedEndpointResponse
Deletes a managed endpoint. A managed endpoint is a gateway that connects Amazon EMR Studio to Amazon EMR on EKS so that Amazon EMR Studio can communicate with your virtual cluster.
958 959 960 961 |
# File 'gems/aws-sdk-emrcontainers/lib/aws-sdk-emrcontainers/client.rb', line 958 def delete_managed_endpoint(params = {}, = {}) req = build_request(:delete_managed_endpoint, params) req.send_request() end |
#delete_security_configuration(params = {}) ⇒ Types::DeleteSecurityConfigurationResponse
Deletes a security configuration.
986 987 988 989 |
# File 'gems/aws-sdk-emrcontainers/lib/aws-sdk-emrcontainers/client.rb', line 986 def delete_security_configuration(params = {}, = {}) req = build_request(:delete_security_configuration, params) req.send_request() end |
#delete_virtual_cluster(params = {}) ⇒ Types::DeleteVirtualClusterResponse
Deletes a virtual cluster. Virtual cluster is a managed entity on Amazon EMR on EKS. You can create, describe, list and delete virtual clusters. They do not consume any additional resource in your system. A single virtual cluster maps to a single Kubernetes namespace. Given this relationship, you can model virtual clusters the same way you model Kubernetes namespaces to meet your requirements.
1019 1020 1021 1022 |
# File 'gems/aws-sdk-emrcontainers/lib/aws-sdk-emrcontainers/client.rb', line 1019 def delete_virtual_cluster(params = {}, = {}) req = build_request(:delete_virtual_cluster, params) req.send_request() end |
#describe_job_run(params = {}) ⇒ Types::DescribeJobRunResponse
Displays detailed information about a job run. A job run is a unit of work, such as a Spark jar, PySpark script, or SparkSQL query, that you submit to Amazon EMR on EKS.
1089 1090 1091 1092 |
# File 'gems/aws-sdk-emrcontainers/lib/aws-sdk-emrcontainers/client.rb', line 1089 def describe_job_run(params = {}, = {}) req = build_request(:describe_job_run, params) req.send_request() end |
#describe_job_template(params = {}) ⇒ Types::DescribeJobTemplateResponse
Displays detailed information about a specified job template. Job template stores values of StartJobRun API request in a template and can be used to start a job run. Job template allows two use cases: avoid repeating recurring StartJobRun API request values, enforcing certain values in StartJobRun API request.
1151 1152 1153 1154 |
# File 'gems/aws-sdk-emrcontainers/lib/aws-sdk-emrcontainers/client.rb', line 1151 def describe_job_template(params = {}, = {}) req = build_request(:describe_job_template, params) req.send_request() end |
#describe_managed_endpoint(params = {}) ⇒ Types::DescribeManagedEndpointResponse
Displays detailed information about a managed endpoint. A managed endpoint is a gateway that connects Amazon EMR Studio to Amazon EMR on EKS so that Amazon EMR Studio can communicate with your virtual cluster.
1220 1221 1222 1223 |
# File 'gems/aws-sdk-emrcontainers/lib/aws-sdk-emrcontainers/client.rb', line 1220 def describe_managed_endpoint(params = {}, = {}) req = build_request(:describe_managed_endpoint, params) req.send_request() end |
#describe_security_configuration(params = {}) ⇒ Types::DescribeSecurityConfigurationResponse
Displays detailed information about a specified security configuration. Security configurations in Amazon EMR on EKS are templates for different security setups. You can use security configurations to configure the Lake Formation integration setup. You can also create a security configuration to re-use a security setup each time you create a virtual cluster.
1271 1272 1273 1274 |
# File 'gems/aws-sdk-emrcontainers/lib/aws-sdk-emrcontainers/client.rb', line 1271 def describe_security_configuration(params = {}, = {}) req = build_request(:describe_security_configuration, params) req.send_request() end |
#describe_virtual_cluster(params = {}) ⇒ Types::DescribeVirtualClusterResponse
Displays detailed information about a specified virtual cluster. Virtual cluster is a managed entity on Amazon EMR on EKS. You can create, describe, list and delete virtual clusters. They do not consume any additional resource in your system. A single virtual cluster maps to a single Kubernetes namespace. Given this relationship, you can model virtual clusters the same way you model Kubernetes namespaces to meet your requirements.
1317 1318 1319 1320 |
# File 'gems/aws-sdk-emrcontainers/lib/aws-sdk-emrcontainers/client.rb', line 1317 def describe_virtual_cluster(params = {}, = {}) req = build_request(:describe_virtual_cluster, params) req.send_request() end |
#get_managed_endpoint_session_credentials(params = {}) ⇒ Types::GetManagedEndpointSessionCredentialsResponse
Generate a session token to connect to a managed endpoint.
1381 1382 1383 1384 |
# File 'gems/aws-sdk-emrcontainers/lib/aws-sdk-emrcontainers/client.rb', line 1381 def get_managed_endpoint_session_credentials(params = {}, = {}) req = build_request(:get_managed_endpoint_session_credentials, params) req.send_request() end |
#list_job_runs(params = {}) ⇒ Types::ListJobRunsResponse
Lists job runs based on a set of parameters. A job run is a unit of work, such as a Spark jar, PySpark script, or SparkSQL query, that you submit to Amazon EMR on EKS.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1476 1477 1478 1479 |
# File 'gems/aws-sdk-emrcontainers/lib/aws-sdk-emrcontainers/client.rb', line 1476 def list_job_runs(params = {}, = {}) req = build_request(:list_job_runs, params) req.send_request() end |
#list_job_templates(params = {}) ⇒ Types::ListJobTemplatesResponse
Lists job templates based on a set of parameters. Job template stores values of StartJobRun API request in a template and can be used to start a job run. Job template allows two use cases: avoid repeating recurring StartJobRun API request values, enforcing certain values in StartJobRun API request.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1555 1556 1557 1558 |
# File 'gems/aws-sdk-emrcontainers/lib/aws-sdk-emrcontainers/client.rb', line 1555 def list_job_templates(params = {}, = {}) req = build_request(:list_job_templates, params) req.send_request() end |
#list_managed_endpoints(params = {}) ⇒ Types::ListManagedEndpointsResponse
Lists managed endpoints based on a set of parameters. A managed endpoint is a gateway that connects Amazon EMR Studio to Amazon EMR on EKS so that Amazon EMR Studio can communicate with your virtual cluster.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1649 1650 1651 1652 |
# File 'gems/aws-sdk-emrcontainers/lib/aws-sdk-emrcontainers/client.rb', line 1649 def list_managed_endpoints(params = {}, = {}) req = build_request(:list_managed_endpoints, params) req.send_request() end |
#list_security_configurations(params = {}) ⇒ Types::ListSecurityConfigurationsResponse
Lists security configurations based on a set of parameters. Security configurations in Amazon EMR on EKS are templates for different security setups. You can use security configurations to configure the Lake Formation integration setup. You can also create a security configuration to re-use a security setup each time you create a virtual cluster.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1717 1718 1719 1720 |
# File 'gems/aws-sdk-emrcontainers/lib/aws-sdk-emrcontainers/client.rb', line 1717 def list_security_configurations(params = {}, = {}) req = build_request(:list_security_configurations, params) req.send_request() end |
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Lists the tags assigned to the resources.
1746 1747 1748 1749 |
# File 'gems/aws-sdk-emrcontainers/lib/aws-sdk-emrcontainers/client.rb', line 1746 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() end |
#list_virtual_clusters(params = {}) ⇒ Types::ListVirtualClustersResponse
Lists information about the specified virtual cluster. Virtual cluster is a managed entity on Amazon EMR on EKS. You can create, describe, list and delete virtual clusters. They do not consume any additional resource in your system. A single virtual cluster maps to a single Kubernetes namespace. Given this relationship, you can model virtual clusters the same way you model Kubernetes namespaces to meet your requirements.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1829 1830 1831 1832 |
# File 'gems/aws-sdk-emrcontainers/lib/aws-sdk-emrcontainers/client.rb', line 1829 def list_virtual_clusters(params = {}, = {}) req = build_request(:list_virtual_clusters, params) req.send_request() end |
#start_job_run(params = {}) ⇒ Types::StartJobRunResponse
Starts a job run. A job run is a unit of work, such as a Spark jar, PySpark script, or SparkSQL query, that you submit to Amazon EMR on EKS.
1955 1956 1957 1958 |
# File 'gems/aws-sdk-emrcontainers/lib/aws-sdk-emrcontainers/client.rb', line 1955 def start_job_run(params = {}, = {}) req = build_request(:start_job_run, 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. For example, you can define a set of tags for your Amazon EMR on EKS clusters to help you track each cluster's owner and stack level. We recommend that you devise a consistent set of tag keys for each resource type. You can then search and filter the resources based on the tags that you add.
1993 1994 1995 1996 |
# File 'gems/aws-sdk-emrcontainers/lib/aws-sdk-emrcontainers/client.rb', line 1993 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Removes tags from resources.
2019 2020 2021 2022 |
# File 'gems/aws-sdk-emrcontainers/lib/aws-sdk-emrcontainers/client.rb', line 2019 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |