Class: Aws::EMRContainers::Client

Inherits:
Seahorse::Client::Base show all
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

#config, #handlers

API Operations collapse

Instance Method Summary collapse

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.

Parameters:

  • options (Hash)

Options Hash (options):

  • :credentials (required, Aws::CredentialProvider) —

    Your AWS credentials. This can be an instance of any one of the following classes:

    • Aws::Credentials - Used for configuring static, non-refreshing credentials.

    • Aws::SharedCredentials - Used for loading static credentials from a shared file, such as ~/.aws/config.

    • Aws::AssumeRoleCredentials - Used when you need to assume a role.

    • Aws::AssumeRoleWebIdentityCredentials - Used when you need to assume a role after providing credentials via the web.

    • Aws::SSOCredentials - Used for loading credentials from AWS SSO using an access token generated from aws login.

    • Aws::ProcessCredentials - Used for loading credentials from a process that outputs to stdout.

    • Aws::InstanceProfileCredentials - Used for loading credentials from an EC2 IMDS on an EC2 instance.

    • Aws::ECSCredentials - Used for loading credentials from instances running in ECS.

    • Aws::CognitoIdentityCredentials - Used for loading credentials from the Cognito Identity service.

    When :credentials are not configured directly, the following locations will be searched for credentials:

    • Aws.config[:credentials]
    • The :access_key_id, :secret_access_key, and :session_token options.
    • ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
    • ~/.aws/credentials
    • ~/.aws/config
    • EC2/ECS IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of Aws::InstanceProfileCredentails or Aws::ECSCredentials to enable retries and extended timeouts.
  • :region (required, String) —

    The AWS region to connect to. The configured :region is used to determine the service :endpoint. When not passed, a default :region is searched for in the following locations:

    • Aws.config[:region]
    • ENV['AWS_REGION']
    • ENV['AMAZON_REGION']
    • ENV['AWS_DEFAULT_REGION']
    • ~/.aws/credentials
    • ~/.aws/config
  • :access_key_id (String)
  • :active_endpoint_cache (Boolean) — default: false —

    When set to true, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to false.

  • :adaptive_retry_wait_to_fill (Boolean) — default: true —

    Used only in adaptive retry mode. When true, the request will sleep until there is sufficent client side capacity to retry the request. When false, the request will raise a RetryCapacityNotAvailableError and will not retry instead of sleeping.

  • :client_side_monitoring (Boolean) — default: false —

    When true, client-side metrics will be collected for all API requests from this client.

  • :client_side_monitoring_client_id (String) — default: "" —

    Allows you to provide an identifier for this client which will be attached to all generated client side metrics. Defaults to an empty string.

  • :client_side_monitoring_host (String) — default: "127.0.0.1" —

    Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_port (Integer) — default: 31000 —

    Required for publishing client metrics. The port that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher) — default: Aws::ClientSideMonitoring::Publisher —

    Allows you to provide a custom client-side monitoring publisher class. By default, will use the Client Side Monitoring Agent Publisher.

  • :convert_params (Boolean) — default: true —

    When true, an attempt is made to coerce request parameters into the required types.

  • :correct_clock_skew (Boolean) — default: true —

    Used only in standard and adaptive retry modes. Specifies whether to apply a clock skew correction and retry requests with skewed client clocks.

  • :disable_host_prefix_injection (Boolean) — default: false —

    Set to true to disable SDK automatically adding host prefix to default service endpoint when available.

  • :endpoint (String) —

    The client endpoint is normally constructed from the :region option. You should only configure an :endpoint when connecting to test or custom endpoints. This should be a valid HTTP(S) URI.

  • :endpoint_cache_max_entries (Integer) — default: 1000 —

    Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000.

  • :endpoint_cache_max_threads (Integer) — default: 10 —

    Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.

  • :endpoint_cache_poll_interval (Integer) — default: 60 —

    When :endpoint_discovery and :active_endpoint_cache is enabled, Use this option to config the time interval in seconds for making requests fetching endpoints information. Defaults to 60 sec.

  • :endpoint_discovery (Boolean) — default: false —

    When set to true, endpoint discovery will be enabled for operations when available.

  • :log_formatter (Aws::Log::Formatter) — default: Aws::Log::Formatter.default —

    The log formatter.

  • :log_level (Symbol) — default: :info —

    The log level to send messages to the :logger at.

  • :logger (Logger) —

    The Logger instance to send log messages to. If this option is not set, logging will be disabled.

  • :max_attempts (Integer) — default: 3 —

    An integer representing the maximum number attempts that will be made for a single request, including the initial attempt. For example, setting this value to 5 will result in a request being retried up to 4 times. Used in standard and adaptive retry modes.

  • :profile (String) — default: "default" —

    Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, 'default' is used.

  • :retry_backoff (Proc) —

    A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay. This option is only used in the legacy retry mode.

  • :retry_base_delay (Float) — default: 0.3 —

    The base delay in seconds used by the default backoff function. This option is only used in the legacy retry mode.

  • :retry_jitter (Symbol) — default: :none —

    A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number. This option is only used in the legacy retry mode.

    @see https://www.awsarchitectureblog.com/2015/03/backoff.html

  • :retry_limit (Integer) — default: 3 —

    The maximum number of times to retry failed requests. Only ~ 500 level server errors and certain ~ 400 level client errors are retried. Generally, these are throttling errors, data checksum errors, networking errors, timeout errors, auth errors, endpoint discovery, and errors from expired credentials. This option is only used in the legacy retry mode.

  • :retry_max_delay (Integer) — default: 0 —

    The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function. This option is only used in the legacy retry mode.

  • :retry_mode (String) — default: "legacy" —

    Specifies which retry algorithm to use. Values are:

    • legacy - The pre-existing retry behavior. This is default value if no retry mode is provided.

    • standard - A standardized set of retry rules across the AWS SDKs. This includes support for retry quotas, which limit the number of unsuccessful retries a client can make.

    • adaptive - An experimental retry mode that includes all the functionality of standard mode along with automatic client side throttling. This is a provisional mode that may change behavior in the future.

  • :secret_access_key (String)
  • :session_token (String)
  • :stub_responses (Boolean) — default: false —

    Causes the client to return stubbed responses. By default fake responses are generated and returned. You can specify the response data to return or errors to raise by calling ClientStubs#stub_responses. See ClientStubs for more information.

    Please note When response stubbing is enabled, no HTTP requests are made, and retries are disabled.

  • :validate_params (Boolean) — default: true —

    When true, request parameters are validated before sending the request.

  • :http_proxy (URI::HTTP, String) —

    A proxy to send requests through. Formatted like 'http://proxy.com:123'.

  • :http_open_timeout (Float) — default: 15 —

    The number of seconds to wait when opening a HTTP session before raising a Timeout::Error.

  • :http_read_timeout (Integer) — default: 60 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_idle_timeout (Float) — default: 5 —

    The number of seconds a connection is allowed to sit idle before it is considered stale. Stale connections are closed and removed from the pool before making a request.

  • :http_continue_timeout (Float) — default: 1 —

    The number of seconds to wait for a 100-continue response before sending the request body. This option has no effect unless the request has "Expect" header set to "100-continue". Defaults to nil which disables this behaviour. This value can safely be set per request on the session.

  • :http_wire_trace (Boolean) — default: false —

    When true, HTTP debug output will be sent to the :logger.

  • :ssl_verify_peer (Boolean) — default: true —

    When true, SSL peer certificates are verified when establishing a connection.

  • :ssl_ca_bundle (String) —

    Full path to the SSL certificate authority bundle file that should be used when verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.

  • :ssl_ca_directory (String) —

    Full path of the directory that contains the unbundled SSL certificate authority files for verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.



324
325
326
 
# File 'gems/aws-sdk-emrcontainers/lib/aws-sdk-emrcontainers/client.rb', line 324

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.

Examples:

Request syntax with placeholder values


resp = client.cancel_job_run({
  id: "ResourceIdString", # required
  virtual_cluster_id: "ResourceIdString", # required
})

Response structure


resp.id #=> String
resp.virtual_cluster_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :id (required, String) —

    The ID of the job run to cancel.

  • :virtual_cluster_id (required, String) —

    The ID of the virtual cluster for which the job run will be canceled.

Returns:

See Also:



361
362
363
364
 
# File 'gems/aws-sdk-emrcontainers/lib/aws-sdk-emrcontainers/client.rb', line 361

def cancel_job_run(params = {}, options = {})
  req = build_request(:cancel_job_run, params)
  req.send_request(options)
end

#create_managed_endpoint(params = {}) ⇒ Types::CreateManagedEndpointResponse

Creates a managed endpoint. A managed endpoint is a gateway that connects EMR Studio to Amazon EMR on EKS so that EMR Studio can communicate with your virtual cluster.

Examples:

Request syntax with placeholder values


resp = client.create_managed_endpoint({
  name: "ResourceNameString", # required
  virtual_cluster_id: "ResourceIdString", # required
  type: "EndpointType", # required
  release_label: "ReleaseLabel", # required
  execution_role_arn: "IAMRoleArn", # required
  certificate_arn: "ACMCertArn", # required
  configuration_overrides: {
    application_configuration: [
      {
        classification: "String1024", # required
        properties: {
          "String1024" => "String1024",
        },
        configurations: {
          # recursive ConfigurationList
        },
      },
    ],
    monitoring_configuration: {
      persistent_app_ui: "ENABLED", # accepts ENABLED, DISABLED
      cloud_watch_monitoring_configuration: {
        log_group_name: "LogGroupName", # required
        log_stream_name_prefix: "String256",
      },
      s3_monitoring_configuration: {
        log_uri: "UriString", # required
      },
    },
  },
  client_token: "ClientToken", # required
  tags: {
    "String128" => "StringEmpty256",
  },
})

Response structure


resp.id #=> String
resp.name #=> String
resp.arn #=> String
resp.virtual_cluster_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :name (required, String) —

    The name of the managed endpoint.

  • :virtual_cluster_id (required, String) —

    The ID of the virtual cluster for which a managed endpoint is created.

  • :type (required, String) —

    The type of the managed endpoint.

  • :release_label (required, String) —

    The Amazon EMR release version.

  • :execution_role_arn (required, String) —

    The ARN of the execution role.

  • :certificate_arn (required, String) —

    The certificate ARN of the managed endpoint.

  • :configuration_overrides (Types::ConfigurationOverrides) —

    The configuration settings that will be used to override existing configurations.

  • :client_token (required, String) —

    The client idempotency token for this create call.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :tags (Hash<String,String>) —

    The tags of the managed endpoint.

Returns:

See Also:



457
458
459
460
 
# File 'gems/aws-sdk-emrcontainers/lib/aws-sdk-emrcontainers/client.rb', line 457

def create_managed_endpoint(params = {}, options = {})
  req = build_request(:create_managed_endpoint, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.create_virtual_cluster({
  name: "ResourceNameString", # required
  container_provider: { # required
    type: "EKS", # required, accepts EKS
    id: "String256", # required
    info: {
      eks_info: {
        namespace: "String256",
      },
    },
  },
  client_token: "ClientToken", # required
  tags: {
    "String128" => "StringEmpty256",
  },
})

Response structure


resp.id #=> String
resp.name #=> String
resp.arn #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :name (required, String) —

    The specified name of the virtual cluster.

  • :container_provider (required, Types::ContainerProvider) —

    The container provider of the virtual cluster.

  • :client_token (required, String) —

    The client token of the virtual cluster.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :tags (Hash<String,String>) —

    The tags assigned to the virtual cluster.

Returns:

See Also:



519
520
521
522
 
# File 'gems/aws-sdk-emrcontainers/lib/aws-sdk-emrcontainers/client.rb', line 519

def create_virtual_cluster(params = {}, options = {})
  req = build_request(:create_virtual_cluster, params)
  req.send_request(options)
end

#delete_managed_endpoint(params = {}) ⇒ Types::DeleteManagedEndpointResponse

Deletes a managed endpoint. A managed endpoint is a gateway that connects EMR Studio to Amazon EMR on EKS so that EMR Studio can communicate with your virtual cluster.

Examples:

Request syntax with placeholder values


resp = client.delete_managed_endpoint({
  id: "ResourceIdString", # required
  virtual_cluster_id: "ResourceIdString", # required
})

Response structure


resp.id #=> String
resp.virtual_cluster_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :id (required, String) —

    The ID of the managed endpoint.

  • :virtual_cluster_id (required, String) —

    The ID of the endpoint's virtual cluster.

Returns:

See Also:



555
556
557
558
 
# File 'gems/aws-sdk-emrcontainers/lib/aws-sdk-emrcontainers/client.rb', line 555

def delete_managed_endpoint(params = {}, options = {})
  req = build_request(:delete_managed_endpoint, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.delete_virtual_cluster({
  id: "ResourceIdString", # required
})

Response structure


resp.id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :id (required, String) —

    The ID of the virtual cluster that will be deleted.

Returns:

See Also:



588
589
590
591
 
# File 'gems/aws-sdk-emrcontainers/lib/aws-sdk-emrcontainers/client.rb', line 588

def delete_virtual_cluster(params = {}, options = {})
  req = build_request(:delete_virtual_cluster, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.describe_job_run({
  id: "ResourceIdString", # required
  virtual_cluster_id: "ResourceIdString", # required
})

Response structure


resp.job_run.id #=> String
resp.job_run.name #=> String
resp.job_run.virtual_cluster_id #=> String
resp.job_run.arn #=> String
resp.job_run.state #=> String, one of "PENDING", "SUBMITTED", "RUNNING", "FAILED", "CANCELLED", "CANCEL_PENDING", "COMPLETED"
resp.job_run.client_token #=> String
resp.job_run.execution_role_arn #=> String
resp.job_run.release_label #=> String
resp.job_run.configuration_overrides.application_configuration #=> Array
resp.job_run.configuration_overrides.application_configuration[0].classification #=> String
resp.job_run.configuration_overrides.application_configuration[0].properties #=> Hash
resp.job_run.configuration_overrides.application_configuration[0].properties["String1024"] #=> String
resp.job_run.configuration_overrides.application_configuration[0].configurations #=> Types::ConfigurationList
resp.job_run.configuration_overrides.monitoring_configuration.persistent_app_ui #=> String, one of "ENABLED", "DISABLED"
resp.job_run.configuration_overrides.monitoring_configuration.cloud_watch_monitoring_configuration.log_group_name #=> String
resp.job_run.configuration_overrides.monitoring_configuration.cloud_watch_monitoring_configuration.log_stream_name_prefix #=> String
resp.job_run.configuration_overrides.monitoring_configuration.s3_monitoring_configuration.log_uri #=> String
resp.job_run.job_driver.spark_submit_job_driver.entry_point #=> String
resp.job_run.job_driver.spark_submit_job_driver.entry_point_arguments #=> Array
resp.job_run.job_driver.spark_submit_job_driver.entry_point_arguments[0] #=> String
resp.job_run.job_driver.spark_submit_job_driver.spark_submit_parameters #=> String
resp.job_run.created_at #=> Time
resp.job_run.created_by #=> String
resp.job_run.finished_at #=> Time
resp.job_run.state_details #=> String
resp.job_run.failure_reason #=> String, one of "INTERNAL_ERROR", "USER_ERROR", "VALIDATION_ERROR", "CLUSTER_UNAVAILABLE"
resp.job_run.tags #=> Hash
resp.job_run.tags["String128"] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :id (required, String) —

    The ID of the job run request.

  • :virtual_cluster_id (required, String) —

    The ID of the virtual cluster for which the job run is submitted.

Returns:

See Also:



649
650
651
652
 
# File 'gems/aws-sdk-emrcontainers/lib/aws-sdk-emrcontainers/client.rb', line 649

def describe_job_run(params = {}, options = {})
  req = build_request(:describe_job_run, params)
  req.send_request(options)
end

#describe_managed_endpoint(params = {}) ⇒ Types::DescribeManagedEndpointResponse

Displays detailed information about a managed endpoint. A managed endpoint is a gateway that connects EMR Studio to Amazon EMR on EKS so that EMR Studio can communicate with your virtual cluster.

Examples:

Request syntax with placeholder values


resp = client.describe_managed_endpoint({
  id: "ResourceIdString", # required
  virtual_cluster_id: "ResourceIdString", # required
})

Response structure


resp.endpoint.id #=> String
resp.endpoint.name #=> String
resp.endpoint.arn #=> String
resp.endpoint.virtual_cluster_id #=> String
resp.endpoint.type #=> String
resp.endpoint.state #=> String, one of "CREATING", "ACTIVE", "TERMINATING", "TERMINATED", "TERMINATED_WITH_ERRORS"
resp.endpoint.release_label #=> String
resp.endpoint.execution_role_arn #=> String
resp.endpoint.certificate_arn #=> String
resp.endpoint.configuration_overrides.application_configuration #=> Array
resp.endpoint.configuration_overrides.application_configuration[0].classification #=> String
resp.endpoint.configuration_overrides.application_configuration[0].properties #=> Hash
resp.endpoint.configuration_overrides.application_configuration[0].properties["String1024"] #=> String
resp.endpoint.configuration_overrides.application_configuration[0].configurations #=> Types::ConfigurationList
resp.endpoint.configuration_overrides.monitoring_configuration.persistent_app_ui #=> String, one of "ENABLED", "DISABLED"
resp.endpoint.configuration_overrides.monitoring_configuration.cloud_watch_monitoring_configuration.log_group_name #=> String
resp.endpoint.configuration_overrides.monitoring_configuration.cloud_watch_monitoring_configuration.log_stream_name_prefix #=> String
resp.endpoint.configuration_overrides.monitoring_configuration.s3_monitoring_configuration.log_uri #=> String
resp.endpoint.server_url #=> String
resp.endpoint.created_at #=> Time
resp.endpoint.security_group #=> String
resp.endpoint.subnet_ids #=> Array
resp.endpoint.subnet_ids[0] #=> String
resp.endpoint.tags #=> Hash
resp.endpoint.tags["String128"] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :id (required, String) —

    This output displays ID of the managed endpoint.

  • :virtual_cluster_id (required, String) —

    The ID of the endpoint's virtual cluster.

Returns:

See Also:



707
708
709
710
 
# File 'gems/aws-sdk-emrcontainers/lib/aws-sdk-emrcontainers/client.rb', line 707

def describe_managed_endpoint(params = {}, options = {})
  req = build_request(:describe_managed_endpoint, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.describe_virtual_cluster({
  id: "ResourceIdString", # required
})

Response structure


resp.virtual_cluster.id #=> String
resp.virtual_cluster.name #=> String
resp.virtual_cluster.arn #=> String
resp.virtual_cluster.state #=> String, one of "RUNNING", "TERMINATING", "TERMINATED", "ARRESTED"
resp.virtual_cluster.container_provider.type #=> String, one of "EKS"
resp.virtual_cluster.container_provider.id #=> String
resp.virtual_cluster.container_provider.info.eks_info.namespace #=> String
resp.virtual_cluster.created_at #=> Time
resp.virtual_cluster.tags #=> Hash
resp.virtual_cluster.tags["String128"] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :id (required, String) —

    The ID of the virtual cluster that will be described.

Returns:

See Also:



750
751
752
753
 
# File 'gems/aws-sdk-emrcontainers/lib/aws-sdk-emrcontainers/client.rb', line 750

def describe_virtual_cluster(params = {}, options = {})
  req = build_request(:describe_virtual_cluster, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.list_job_runs({
  virtual_cluster_id: "ResourceIdString", # required
  created_before: Time.now,
  created_after: Time.now,
  name: "ResourceNameString",
  states: ["PENDING"], # accepts PENDING, SUBMITTED, RUNNING, FAILED, CANCELLED, CANCEL_PENDING, COMPLETED
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.job_runs #=> Array
resp.job_runs[0].id #=> String
resp.job_runs[0].name #=> String
resp.job_runs[0].virtual_cluster_id #=> String
resp.job_runs[0].arn #=> String
resp.job_runs[0].state #=> String, one of "PENDING", "SUBMITTED", "RUNNING", "FAILED", "CANCELLED", "CANCEL_PENDING", "COMPLETED"
resp.job_runs[0].client_token #=> String
resp.job_runs[0].execution_role_arn #=> String
resp.job_runs[0].release_label #=> String
resp.job_runs[0].configuration_overrides.application_configuration #=> Array
resp.job_runs[0].configuration_overrides.application_configuration[0].classification #=> String
resp.job_runs[0].configuration_overrides.application_configuration[0].properties #=> Hash
resp.job_runs[0].configuration_overrides.application_configuration[0].properties["String1024"] #=> String
resp.job_runs[0].configuration_overrides.application_configuration[0].configurations #=> Types::ConfigurationList
resp.job_runs[0].configuration_overrides.monitoring_configuration.persistent_app_ui #=> String, one of "ENABLED", "DISABLED"
resp.job_runs[0].configuration_overrides.monitoring_configuration.cloud_watch_monitoring_configuration.log_group_name #=> String
resp.job_runs[0].configuration_overrides.monitoring_configuration.cloud_watch_monitoring_configuration.log_stream_name_prefix #=> String
resp.job_runs[0].configuration_overrides.monitoring_configuration.s3_monitoring_configuration.log_uri #=> String
resp.job_runs[0].job_driver.spark_submit_job_driver.entry_point #=> String
resp.job_runs[0].job_driver.spark_submit_job_driver.entry_point_arguments #=> Array
resp.job_runs[0].job_driver.spark_submit_job_driver.entry_point_arguments[0] #=> String
resp.job_runs[0].job_driver.spark_submit_job_driver.spark_submit_parameters #=> String
resp.job_runs[0].created_at #=> Time
resp.job_runs[0].created_by #=> String
resp.job_runs[0].finished_at #=> Time
resp.job_runs[0].state_details #=> String
resp.job_runs[0].failure_reason #=> String, one of "INTERNAL_ERROR", "USER_ERROR", "VALIDATION_ERROR", "CLUSTER_UNAVAILABLE"
resp.job_runs[0].tags #=> Hash
resp.job_runs[0].tags["String128"] #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :virtual_cluster_id (required, String) —

    The ID of the virtual cluster for which to list the job run.

  • :created_before (Time, DateTime, Date, Integer, String) —

    The date and time before which the job runs were submitted.

  • :created_after (Time, DateTime, Date, Integer, String) —

    The date and time after which the job runs were submitted.

  • :name (String) —

    The name of the job run.

  • :states (Array<String>) —

    The states of the job run.

  • :max_results (Integer) —

    The maximum number of job runs that can be listed.

  • :next_token (String) —

    The token for the next set of job runs to return.

Returns:

See Also:



836
837
838
839
 
# File 'gems/aws-sdk-emrcontainers/lib/aws-sdk-emrcontainers/client.rb', line 836

def list_job_runs(params = {}, options = {})
  req = build_request(:list_job_runs, params)
  req.send_request(options)
end

#list_managed_endpoints(params = {}) ⇒ Types::ListManagedEndpointsResponse

Lists managed endpoints based on a set of parameters. A managed endpoint is a gateway that connects EMR Studio to Amazon EMR on EKS so that EMR Studio can communicate with your virtual cluster.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_managed_endpoints({
  virtual_cluster_id: "ResourceIdString", # required
  created_before: Time.now,
  created_after: Time.now,
  types: ["EndpointType"],
  states: ["CREATING"], # accepts CREATING, ACTIVE, TERMINATING, TERMINATED, TERMINATED_WITH_ERRORS
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.endpoints #=> Array
resp.endpoints[0].id #=> String
resp.endpoints[0].name #=> String
resp.endpoints[0].arn #=> String
resp.endpoints[0].virtual_cluster_id #=> String
resp.endpoints[0].type #=> String
resp.endpoints[0].state #=> String, one of "CREATING", "ACTIVE", "TERMINATING", "TERMINATED", "TERMINATED_WITH_ERRORS"
resp.endpoints[0].release_label #=> String
resp.endpoints[0].execution_role_arn #=> String
resp.endpoints[0].certificate_arn #=> String
resp.endpoints[0].configuration_overrides.application_configuration #=> Array
resp.endpoints[0].configuration_overrides.application_configuration[0].classification #=> String
resp.endpoints[0].configuration_overrides.application_configuration[0].properties #=> Hash
resp.endpoints[0].configuration_overrides.application_configuration[0].properties["String1024"] #=> String
resp.endpoints[0].configuration_overrides.application_configuration[0].configurations #=> Types::ConfigurationList
resp.endpoints[0].configuration_overrides.monitoring_configuration.persistent_app_ui #=> String, one of "ENABLED", "DISABLED"
resp.endpoints[0].configuration_overrides.monitoring_configuration.cloud_watch_monitoring_configuration.log_group_name #=> String
resp.endpoints[0].configuration_overrides.monitoring_configuration.cloud_watch_monitoring_configuration.log_stream_name_prefix #=> String
resp.endpoints[0].configuration_overrides.monitoring_configuration.s3_monitoring_configuration.log_uri #=> String
resp.endpoints[0].server_url #=> String
resp.endpoints[0].created_at #=> Time
resp.endpoints[0].security_group #=> String
resp.endpoints[0].subnet_ids #=> Array
resp.endpoints[0].subnet_ids[0] #=> String
resp.endpoints[0].tags #=> Hash
resp.endpoints[0].tags["String128"] #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :virtual_cluster_id (required, String) —

    The ID of the virtual cluster.

  • :created_before (Time, DateTime, Date, Integer, String) —

    The date and time before which the endpoints are created.

  • :created_after (Time, DateTime, Date, Integer, String) —

    The date and time after which the endpoints are created.

  • :types (Array<String>) —

    The types of the managed endpoints.

  • :states (Array<String>) —

    The states of the managed endpoints.

  • :max_results (Integer) —

    The maximum number of managed endpoints that can be listed.

  • :next_token (String) —

    The token for the next set of managed endpoints to return.

Returns:

See Also:



919
920
921
922
 
# File 'gems/aws-sdk-emrcontainers/lib/aws-sdk-emrcontainers/client.rb', line 919

def list_managed_endpoints(params = {}, options = {})
  req = build_request(:list_managed_endpoints, params)
  req.send_request(options)
end

#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse

Lists the tags assigned to the resources.

Examples:

Request syntax with placeholder values


resp = client.list_tags_for_resource({
  resource_arn: "RsiArn", # required
})

Response structure


resp.tags #=> Hash
resp.tags["String128"] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The ARN of tagged resources.

Returns:

See Also:



948
949
950
951
 
# File 'gems/aws-sdk-emrcontainers/lib/aws-sdk-emrcontainers/client.rb', line 948

def list_tags_for_resource(params = {}, options = {})
  req = build_request(:list_tags_for_resource, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.list_virtual_clusters({
  container_provider_id: "String1024",
  container_provider_type: "EKS", # accepts EKS
  created_after: Time.now,
  created_before: Time.now,
  states: ["RUNNING"], # accepts RUNNING, TERMINATING, TERMINATED, ARRESTED
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.virtual_clusters #=> Array
resp.virtual_clusters[0].id #=> String
resp.virtual_clusters[0].name #=> String
resp.virtual_clusters[0].arn #=> String
resp.virtual_clusters[0].state #=> String, one of "RUNNING", "TERMINATING", "TERMINATED", "ARRESTED"
resp.virtual_clusters[0].container_provider.type #=> String, one of "EKS"
resp.virtual_clusters[0].container_provider.id #=> String
resp.virtual_clusters[0].container_provider.info.eks_info.namespace #=> String
resp.virtual_clusters[0].created_at #=> Time
resp.virtual_clusters[0].tags #=> Hash
resp.virtual_clusters[0].tags["String128"] #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :container_provider_id (String) —

    The container provider ID of the virtual cluster.

  • :container_provider_type (String) —

    The container provider type of the virtual cluster. EKS is the only supported type as of now.

  • :created_after (Time, DateTime, Date, Integer, String) —

    The date and time after which the virtual clusters are created.

  • :created_before (Time, DateTime, Date, Integer, String) —

    The date and time before which the virtual clusters are created.

  • :states (Array<String>) —

    The states of the requested virtual clusters.

  • :max_results (Integer) —

    The maximum number of virtual clusters that can be listed.

  • :next_token (String) —

    The token for the next set of virtual clusters to return.

Returns:

See Also:



1021
1022
1023
1024
 
# File 'gems/aws-sdk-emrcontainers/lib/aws-sdk-emrcontainers/client.rb', line 1021

def list_virtual_clusters(params = {}, options = {})
  req = build_request(:list_virtual_clusters, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.start_job_run({
  name: "ResourceNameString",
  virtual_cluster_id: "ResourceIdString", # required
  client_token: "ClientToken", # required
  execution_role_arn: "IAMRoleArn", # required
  release_label: "ReleaseLabel", # required
  job_driver: { # required
    spark_submit_job_driver: {
      entry_point: "EntryPointPath", # required
      entry_point_arguments: ["EntryPointArgument"],
      spark_submit_parameters: "SparkSubmitParameters",
    },
  },
  configuration_overrides: {
    application_configuration: [
      {
        classification: "String1024", # required
        properties: {
          "String1024" => "String1024",
        },
        configurations: {
          # recursive ConfigurationList
        },
      },
    ],
    monitoring_configuration: {
      persistent_app_ui: "ENABLED", # accepts ENABLED, DISABLED
      cloud_watch_monitoring_configuration: {
        log_group_name: "LogGroupName", # required
        log_stream_name_prefix: "String256",
      },
      s3_monitoring_configuration: {
        log_uri: "UriString", # required
      },
    },
  },
  tags: {
    "String128" => "StringEmpty256",
  },
})

Response structure


resp.id #=> String
resp.name #=> String
resp.arn #=> String
resp.virtual_cluster_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :name (String) —

    The name of the job run.

  • :virtual_cluster_id (required, String) —

    The virtual cluster ID for which the job run request is submitted.

  • :client_token (required, String) —

    The client idempotency token of the job run request.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :execution_role_arn (required, String) —

    The execution role ARN for the job run.

  • :release_label (required, String) —

    The Amazon EMR release version to use for the job run.

  • :job_driver (required, Types::JobDriver) —

    The job driver for the job run.

  • :configuration_overrides (Types::ConfigurationOverrides) —

    The configuration overrides for the job run.

  • :tags (Hash<String,String>) —

    The tags assigned to job runs.

Returns:

See Also:



1118
1119
1120
1121
 
# File 'gems/aws-sdk-emrcontainers/lib/aws-sdk-emrcontainers/client.rb', line 1118

def start_job_run(params = {}, options = {})
  req = build_request(:start_job_run, params)
  req.send_request(options)
end

#tag_resource(params = {}) ⇒ Struct

Assigns tags to resources. A tag is a label that you assign to an AWS resource. Each tag consists of a key and an optional value, both of which you define. Tags enable you to categorize your AWS 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.

Examples:

Request syntax with placeholder values


resp = client.tag_resource({
  resource_arn: "RsiArn", # required
  tags: { # required
    "String128" => "StringEmpty256",
  },
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The ARN of resources.

  • :tags (required, Hash<String,String>) —

    The tags assigned to resources.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1155
1156
1157
1158
 
# File 'gems/aws-sdk-emrcontainers/lib/aws-sdk-emrcontainers/client.rb', line 1155

def tag_resource(params = {}, options = {})
  req = build_request(:tag_resource, params)
  req.send_request(options)
end

#untag_resource(params = {}) ⇒ Struct

Removes tags from resources.

Examples:

Request syntax with placeholder values


resp = client.untag_resource({
  resource_arn: "RsiArn", # required
  tag_keys: ["String128"], # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The ARN of resources.

  • :tag_keys (required, Array<String>) —

    The tag keys of the resources.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1181
1182
1183
1184
 
# File 'gems/aws-sdk-emrcontainers/lib/aws-sdk-emrcontainers/client.rb', line 1181

def untag_resource(params = {}, options = {})
  req = build_request(:untag_resource, params)
  req.send_request(options)
end