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):

  • :plugins (Array<Seahorse::Client::Plugin>) — default: []] —

    A list of plugins to apply to the client. Each plugin is either a class name or an instance of a plugin class.

  • :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, :session_token, and :account_id options.
    • ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY'], ENV['AWS_SESSION_TOKEN'], and ENV['AWS_ACCOUNT_ID']
    • ~/.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::InstanceProfileCredentials or Aws::ECSCredentials to enable retries and extended timeouts. Instance profile credential fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED'] to true.
  • :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)
  • :account_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.

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

    See DefaultsModeConfiguration for a list of the accepted modes and the configuration defaults that are included.

  • :disable_host_prefix_injection (Boolean) — default: false —

    When true, the SDK will not prepend the modeled host prefix to the endpoint.

  • :disable_request_compression (Boolean) — default: false —

    When set to 'true' the request body will not be compressed for supported operations.

  • :endpoint (String, URI::HTTPS, URI::HTTP) —

    Normally you should not configure the :endpoint option directly. This is normally constructed from the :region option. Configuring :endpoint is normally reserved for connecting to test or custom endpoints. The endpoint should be a URI formatted like:

    'http://example.com'
'https://example.com'
'http://example.com:123'
  • :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.

  • :ignore_configured_endpoint_urls (Boolean) —

    Setting to true disables use of endpoint URLs provided via environment variables and the shared configuration file.

  • :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.

  • :request_checksum_calculation (String) — default: "when_supported" —

    Determines when a checksum will be calculated for request payloads. Values are:

    • when_supported - (default) When set, a checksum will be calculated for all request payloads of operations modeled with the httpChecksum trait where requestChecksumRequired is true and/or a requestAlgorithmMember is modeled.
    • when_required - When set, a checksum will only be calculated for request payloads of operations modeled with the httpChecksum trait where requestChecksumRequired is true or where a requestAlgorithmMember is modeled and supplied.
  • :request_min_compression_size_bytes (Integer) — default: 10240 —

    The minimum size in bytes that triggers compression for request bodies. The value must be non-negative integer value between 0 and 10485780 bytes inclusive.

  • :response_checksum_validation (String) — default: "when_supported" —

    Determines when checksum validation will be performed on response payloads. Values are:

    • when_supported - (default) When set, checksum validation is performed on all response payloads of operations modeled with the httpChecksum trait where responseAlgorithms is modeled, except when no modeled checksum algorithms are supported.
    • when_required - When set, checksum validation is not performed on response payloads of operations unless the checksum algorithm is supported and the requestValidationModeMember member is set to ENABLED.
  • :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.

  • :sdk_ua_app_id (String) —

    A unique and opaque application ID that is appended to the User-Agent header as app/sdk_ua_app_id. It should have a maximum length of 50. This variable is sourced from environment variable AWS_SDK_UA_APP_ID or the shared config profile attribute sdk_ua_app_id.

  • :secret_access_key (String)
  • :session_token (String)
  • :sigv4a_signing_region_set (Array) —

    A list of regions that should be signed with SigV4a signing. When not passed, a default :sigv4a_signing_region_set is searched for in the following locations:

    • Aws.config[:sigv4a_signing_region_set]
    • ENV['AWS_SIGV4A_SIGNING_REGION_SET']
    • ~/.aws/config
  • :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.

  • :telemetry_provider (Aws::Telemetry::TelemetryProviderBase) — default: Aws::Telemetry::NoOpTelemetryProvider —

    Allows you to provide a telemetry provider, which is used to emit telemetry data. By default, uses NoOpTelemetryProvider which will not record or emit any telemetry data. The SDK supports the following telemetry providers:

    • OpenTelemetry (OTel) - To use the OTel provider, install and require the opentelemetry-sdk gem and then, pass in an instance of a Aws::Telemetry::OTelProvider for telemetry provider.
  • :token_provider (Aws::TokenProvider) —

    A Bearer Token Provider. This can be an instance of any one of the following classes:

    • Aws::StaticTokenProvider - Used for configuring static, non-refreshing tokens.

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

    When :token_provider is not configured directly, the Aws::TokenProviderChain will be used to search for tokens configured for your profile in shared configuration files.

  • :use_dualstack_endpoint (Boolean) —

    When set to true, dualstack enabled endpoints (with .aws TLD) will be used if available.

  • :use_fips_endpoint (Boolean) —

    When set to true, fips compatible endpoints will be used if available. When a fips region is used, the region is normalized and this config is set to true.

  • :validate_params (Boolean) — default: true —

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

  • :endpoint_provider (Aws::EMRContainers::EndpointProvider) —

    The endpoint provider used to resolve endpoints. Any object that responds to #resolve_endpoint(parameters) where parameters is a Struct similar to Aws::EMRContainers::EndpointParameters.

  • :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_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_open_timeout (Float) — default: 15 —

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

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

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

  • :http_read_timeout (Float) — default: 60 —

    The default number of seconds to wait for response data. 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.

  • :on_chunk_received (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the response body is received. It provides three arguments: the chunk, the number of bytes received, and the total number of bytes in the response (or nil if the server did not send a content-length).

  • :on_chunk_sent (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the request body is sent. It provides three arguments: the chunk, the number of bytes read from the body, and the total number of bytes in the body.

  • :raise_response_errors (Boolean) — default: true —

    When true, response errors are raised.

  • :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.

  • :ssl_ca_store (String) —

    Sets the X509::Store to verify peer certificate.

  • :ssl_cert (OpenSSL::X509::Certificate) —

    Sets a client certificate when creating http connections.

  • :ssl_key (OpenSSL::PKey) —

    Sets a client key when creating http connections.

  • :ssl_timeout (Float) —

    Sets the SSL timeout in seconds

  • :ssl_verify_peer (Boolean) — default: true —

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



466
467
468
 
# File 'gems/aws-sdk-emrcontainers/lib/aws-sdk-emrcontainers/client.rb', line 466

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:



503
504
505
506
 
# File 'gems/aws-sdk-emrcontainers/lib/aws-sdk-emrcontainers/client.rb', line 503

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

Examples:

Request syntax with placeholder values


resp = client.create_job_template({
  name: "ResourceNameString", # required
  client_token: "ClientToken", # required
  job_template_data: { # required
    execution_role_arn: "ParametricIAMRoleArn", # required
    release_label: "ParametricReleaseLabel", # required
    configuration_overrides: {
      application_configuration: [
        {
          classification: "String1024", # required
          properties: {
            "String1024" => "String1024",
          },
          configurations: {
            # recursive ConfigurationList
          },
        },
      ],
      monitoring_configuration: {
        persistent_app_ui: "TemplateParameter",
        cloud_watch_monitoring_configuration: {
          log_group_name: "TemplateParameter",
          log_stream_name_prefix: "String256",
        },
        s3_monitoring_configuration: {
          log_uri: "UriString",
        },
      },
    },
    job_driver: { # required
      spark_submit_job_driver: {
        entry_point: "EntryPointPath", # required
        entry_point_arguments: ["EntryPointArgument"],
        spark_submit_parameters: "SparkSubmitParameters",
      },
      spark_sql_job_driver: {
        entry_point: "EntryPointPath",
        spark_sql_parameters: "SparkSqlParameters",
      },
    },
    parameter_configuration: {
      "TemplateParameterName" => {
        type: "NUMBER", # accepts NUMBER, STRING
        default_value: "String1024",
      },
    },
    job_tags: {
      "String128" => "StringEmpty256",
    },
  },
  tags: {
    "String128" => "StringEmpty256",
  },
  kms_key_arn: "KmsKeyArn",
})

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :name (required, String) —

    The specified name of the job template.

  • :client_token (required, String) —

    The client token of the job template.

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

  • :job_template_data (required, Types::JobTemplateData) —

    The job template data which holds values of StartJobRun API request.

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

    The tags that are associated with the job template.

  • :kms_key_arn (String) —

    The KMS key ARN used to encrypt the job template.

Returns:

See Also:



607
608
609
610
 
# File 'gems/aws-sdk-emrcontainers/lib/aws-sdk-emrcontainers/client.rb', line 607

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

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",
  configuration_overrides: {
    application_configuration: [
      {
        classification: "String1024", # required
        properties: {
          "String1024" => "String1024",
        },
        configurations: {
          # recursive ConfigurationList
        },
      },
    ],
    monitoring_configuration: {
      managed_logs: {
        allow_aws_to_retain_logs: "ENABLED", # accepts ENABLED, DISABLED
        encryption_key_arn: "KmsKeyArn",
      },
      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
      },
      container_log_rotation_configuration: {
        rotation_size: "RotationSize", # required
        max_files_to_keep: 1, # 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 (String) —

    The certificate ARN provided by users for the managed endpoint. This field is under deprecation and will be removed in future releases.

  • :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:



712
713
714
715
 
# File 'gems/aws-sdk-emrcontainers/lib/aws-sdk-emrcontainers/client.rb', line 712

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

Examples:

Request syntax with placeholder values


resp = client.create_security_configuration({
  client_token: "ClientToken", # required
  name: "ResourceNameString", # required
  security_configuration_data: { # required
    authorization_configuration: {
      lake_formation_configuration: {
        authorized_session_tag_value: "SessionTagValue",
        secure_namespace_info: {
          cluster_id: "ClusterId",
          namespace: "KubernetesNamespace",
        },
        query_engine_role_arn: "IAMRoleArn",
      },
      encryption_configuration: {
        in_transit_encryption_configuration: {
          tls_certificate_configuration: {
            certificate_provider_type: "PEM", # accepts PEM
            public_certificate_secret_arn: "SecretsManagerArn",
            private_certificate_secret_arn: "SecretsManagerArn",
          },
        },
      },
    },
  },
  tags: {
    "String128" => "StringEmpty256",
  },
})

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :client_token (required, String) —

    The client idempotency token to use when creating the security configuration.

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

  • :name (required, String) —

    The name of the security configuration.

  • :security_configuration_data (required, Types::SecurityConfigurationData) —

    Security configuration input for the request.

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

    The tags to add to the security configuration.

Returns:

See Also:



786
787
788
789
 
# File 'gems/aws-sdk-emrcontainers/lib/aws-sdk-emrcontainers/client.rb', line 786

def create_security_configuration(params = {}, options = {})
  req = build_request(:create_security_configuration, 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: "ClusterId", # required
    info: {
      eks_info: {
        namespace: "KubernetesNamespace",
      },
    },
  },
  client_token: "ClientToken", # required
  tags: {
    "String128" => "StringEmpty256",
  },
  security_configuration_id: "ResourceIdString",
})

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.

  • :security_configuration_id (String) —

    The ID of the security configuration.

Returns:

See Also:



852
853
854
855
 
# File 'gems/aws-sdk-emrcontainers/lib/aws-sdk-emrcontainers/client.rb', line 852

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

Examples:

Request syntax with placeholder values


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

Response structure


resp.id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :id (required, String) —

    The ID of the job template that will be deleted.

Returns:

See Also:



883
884
885
886
 
# File 'gems/aws-sdk-emrcontainers/lib/aws-sdk-emrcontainers/client.rb', line 883

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

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:



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

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:



952
953
954
955
 
# File 'gems/aws-sdk-emrcontainers/lib/aws-sdk-emrcontainers/client.rb', line 952

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.managed_logs.allow_aws_to_retain_logs #=> String, one of "ENABLED", "DISABLED"
resp.job_run.configuration_overrides.monitoring_configuration.managed_logs.encryption_key_arn #=> String
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.configuration_overrides.monitoring_configuration.container_log_rotation_configuration.rotation_size #=> String
resp.job_run.configuration_overrides.monitoring_configuration.container_log_rotation_configuration.max_files_to_keep #=> Integer
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.job_driver.spark_sql_job_driver.entry_point #=> String
resp.job_run.job_driver.spark_sql_job_driver.spark_sql_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
resp.job_run.retry_policy_configuration.max_attempts #=> Integer
resp.job_run.retry_policy_execution.current_attempt_count #=> Integer

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:



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

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

Examples:

Request syntax with placeholder values


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

Response structure


resp.job_template.name #=> String
resp.job_template.id #=> String
resp.job_template.arn #=> String
resp.job_template.created_at #=> Time
resp.job_template.created_by #=> String
resp.job_template.tags #=> Hash
resp.job_template.tags["String128"] #=> String
resp.job_template.job_template_data.execution_role_arn #=> String
resp.job_template.job_template_data.release_label #=> String
resp.job_template.job_template_data.configuration_overrides.application_configuration #=> Array
resp.job_template.job_template_data.configuration_overrides.application_configuration[0].classification #=> String
resp.job_template.job_template_data.configuration_overrides.application_configuration[0].properties #=> Hash
resp.job_template.job_template_data.configuration_overrides.application_configuration[0].properties["String1024"] #=> String
resp.job_template.job_template_data.configuration_overrides.application_configuration[0].configurations #=> Types::ConfigurationList
resp.job_template.job_template_data.configuration_overrides.monitoring_configuration.persistent_app_ui #=> String
resp.job_template.job_template_data.configuration_overrides.monitoring_configuration.cloud_watch_monitoring_configuration.log_group_name #=> String
resp.job_template.job_template_data.configuration_overrides.monitoring_configuration.cloud_watch_monitoring_configuration.log_stream_name_prefix #=> String
resp.job_template.job_template_data.configuration_overrides.monitoring_configuration.s3_monitoring_configuration.log_uri #=> String
resp.job_template.job_template_data.job_driver.spark_submit_job_driver.entry_point #=> String
resp.job_template.job_template_data.job_driver.spark_submit_job_driver.entry_point_arguments #=> Array
resp.job_template.job_template_data.job_driver.spark_submit_job_driver.entry_point_arguments[0] #=> String
resp.job_template.job_template_data.job_driver.spark_submit_job_driver.spark_submit_parameters #=> String
resp.job_template.job_template_data.job_driver.spark_sql_job_driver.entry_point #=> String
resp.job_template.job_template_data.job_driver.spark_sql_job_driver.spark_sql_parameters #=> String
resp.job_template.job_template_data.parameter_configuration #=> Hash
resp.job_template.job_template_data.parameter_configuration["TemplateParameterName"].type #=> String, one of "NUMBER", "STRING"
resp.job_template.job_template_data.parameter_configuration["TemplateParameterName"].default_value #=> String
resp.job_template.job_template_data.job_tags #=> Hash
resp.job_template.job_template_data.job_tags["String128"] #=> String
resp.job_template.kms_key_arn #=> String
resp.job_template.decryption_error #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :id (required, String) —

    The ID of the job template that will be described.

Returns:

See Also:



1083
1084
1085
1086
 
# File 'gems/aws-sdk-emrcontainers/lib/aws-sdk-emrcontainers/client.rb', line 1083

def describe_job_template(params = {}, options = {})
  req = build_request(:describe_job_template, 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 Amazon EMR Studio to Amazon EMR on EKS so that Amazon 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.certificate_authority.certificate_arn #=> String
resp.endpoint.certificate_authority.certificate_data #=> 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.managed_logs.allow_aws_to_retain_logs #=> String, one of "ENABLED", "DISABLED"
resp.endpoint.configuration_overrides.monitoring_configuration.managed_logs.encryption_key_arn #=> String
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.configuration_overrides.monitoring_configuration.container_log_rotation_configuration.rotation_size #=> String
resp.endpoint.configuration_overrides.monitoring_configuration.container_log_rotation_configuration.max_files_to_keep #=> Integer
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.state_details #=> String
resp.endpoint.failure_reason #=> String, one of "INTERNAL_ERROR", "USER_ERROR", "VALIDATION_ERROR", "CLUSTER_UNAVAILABLE"
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:



1150
1151
1152
1153
 
# File 'gems/aws-sdk-emrcontainers/lib/aws-sdk-emrcontainers/client.rb', line 1150

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

Examples:

Request syntax with placeholder values


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

Response structure


resp.security_configuration.id #=> String
resp.security_configuration.name #=> String
resp.security_configuration.arn #=> String
resp.security_configuration.created_at #=> Time
resp.security_configuration.created_by #=> String
resp.security_configuration.security_configuration_data.authorization_configuration.lake_formation_configuration.authorized_session_tag_value #=> String
resp.security_configuration.security_configuration_data.authorization_configuration.lake_formation_configuration.secure_namespace_info.cluster_id #=> String
resp.security_configuration.security_configuration_data.authorization_configuration.lake_formation_configuration.secure_namespace_info.namespace #=> String
resp.security_configuration.security_configuration_data.authorization_configuration.lake_formation_configuration.query_engine_role_arn #=> String
resp.security_configuration.security_configuration_data.authorization_configuration.encryption_configuration.in_transit_encryption_configuration.tls_certificate_configuration.certificate_provider_type #=> String, one of "PEM"
resp.security_configuration.security_configuration_data.authorization_configuration.encryption_configuration.in_transit_encryption_configuration.tls_certificate_configuration.public_certificate_secret_arn #=> String
resp.security_configuration.security_configuration_data.authorization_configuration.encryption_configuration.in_transit_encryption_configuration.tls_certificate_configuration.private_certificate_secret_arn #=> String
resp.security_configuration.tags #=> Hash
resp.security_configuration.tags["String128"] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :id (required, String) —

    The ID of the security configuration.

Returns:

See Also:



1196
1197
1198
1199
 
# File 'gems/aws-sdk-emrcontainers/lib/aws-sdk-emrcontainers/client.rb', line 1196

def describe_security_configuration(params = {}, options = {})
  req = build_request(:describe_security_configuration, 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
resp.virtual_cluster.security_configuration_id #=> 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:



1240
1241
1242
1243
 
# File 'gems/aws-sdk-emrcontainers/lib/aws-sdk-emrcontainers/client.rb', line 1240

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

#get_managed_endpoint_session_credentials(params = {}) ⇒ Types::GetManagedEndpointSessionCredentialsResponse

Generate a session token to connect to a managed endpoint.

Examples:

Request syntax with placeholder values


resp = client.get_managed_endpoint_session_credentials({
  endpoint_identifier: "String2048", # required
  virtual_cluster_identifier: "String2048", # required
  execution_role_arn: "IAMRoleArn", # required
  credential_type: "CredentialType", # required
  duration_in_seconds: 1,
  log_context: "LogContext",
  client_token: "ClientToken",
})

Response structure


resp.id #=> String
resp.credentials.token #=> String
resp.expires_at #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :endpoint_identifier (required, String) —

    The ARN of the managed endpoint for which the request is submitted.

  • :virtual_cluster_identifier (required, String) —

    The ARN of the Virtual Cluster which the Managed Endpoint belongs to.

  • :execution_role_arn (required, String) —

    The IAM Execution Role ARN that will be used by the job run.

  • :credential_type (required, String) —

    Type of the token requested. Currently supported and default value of this field is “TOKEN.”

  • :duration_in_seconds (Integer) —

    Duration in seconds for which the session token is valid. The default duration is 15 minutes and the maximum is 12 hours.

  • :log_context (String) —

    String identifier used to separate sections of the execution logs uploaded to S3.

  • :client_token (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.**

Returns:

See Also:



1302
1303
1304
1305
 
# File 'gems/aws-sdk-emrcontainers/lib/aws-sdk-emrcontainers/client.rb', line 1302

def get_managed_endpoint_session_credentials(params = {}, options = {})
  req = build_request(:get_managed_endpoint_session_credentials, 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.managed_logs.allow_aws_to_retain_logs #=> String, one of "ENABLED", "DISABLED"
resp.job_runs[0].configuration_overrides.monitoring_configuration.managed_logs.encryption_key_arn #=> String
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].configuration_overrides.monitoring_configuration.container_log_rotation_configuration.rotation_size #=> String
resp.job_runs[0].configuration_overrides.monitoring_configuration.container_log_rotation_configuration.max_files_to_keep #=> Integer
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].job_driver.spark_sql_job_driver.entry_point #=> String
resp.job_runs[0].job_driver.spark_sql_job_driver.spark_sql_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.job_runs[0].retry_policy_configuration.max_attempts #=> Integer
resp.job_runs[0].retry_policy_execution.current_attempt_count #=> Integer
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:



1396
1397
1398
1399
 
# File 'gems/aws-sdk-emrcontainers/lib/aws-sdk-emrcontainers/client.rb', line 1396

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

Examples:

Request syntax with placeholder values


resp = client.list_job_templates({
  created_after: Time.now,
  created_before: Time.now,
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.templates #=> Array
resp.templates[0].name #=> String
resp.templates[0].id #=> String
resp.templates[0].arn #=> String
resp.templates[0].created_at #=> Time
resp.templates[0].created_by #=> String
resp.templates[0].tags #=> Hash
resp.templates[0].tags["String128"] #=> String
resp.templates[0].job_template_data.execution_role_arn #=> String
resp.templates[0].job_template_data.release_label #=> String
resp.templates[0].job_template_data.configuration_overrides.application_configuration #=> Array
resp.templates[0].job_template_data.configuration_overrides.application_configuration[0].classification #=> String
resp.templates[0].job_template_data.configuration_overrides.application_configuration[0].properties #=> Hash
resp.templates[0].job_template_data.configuration_overrides.application_configuration[0].properties["String1024"] #=> String
resp.templates[0].job_template_data.configuration_overrides.application_configuration[0].configurations #=> Types::ConfigurationList
resp.templates[0].job_template_data.configuration_overrides.monitoring_configuration.persistent_app_ui #=> String
resp.templates[0].job_template_data.configuration_overrides.monitoring_configuration.cloud_watch_monitoring_configuration.log_group_name #=> String
resp.templates[0].job_template_data.configuration_overrides.monitoring_configuration.cloud_watch_monitoring_configuration.log_stream_name_prefix #=> String
resp.templates[0].job_template_data.configuration_overrides.monitoring_configuration.s3_monitoring_configuration.log_uri #=> String
resp.templates[0].job_template_data.job_driver.spark_submit_job_driver.entry_point #=> String
resp.templates[0].job_template_data.job_driver.spark_submit_job_driver.entry_point_arguments #=> Array
resp.templates[0].job_template_data.job_driver.spark_submit_job_driver.entry_point_arguments[0] #=> String
resp.templates[0].job_template_data.job_driver.spark_submit_job_driver.spark_submit_parameters #=> String
resp.templates[0].job_template_data.job_driver.spark_sql_job_driver.entry_point #=> String
resp.templates[0].job_template_data.job_driver.spark_sql_job_driver.spark_sql_parameters #=> String
resp.templates[0].job_template_data.parameter_configuration #=> Hash
resp.templates[0].job_template_data.parameter_configuration["TemplateParameterName"].type #=> String, one of "NUMBER", "STRING"
resp.templates[0].job_template_data.parameter_configuration["TemplateParameterName"].default_value #=> String
resp.templates[0].job_template_data.job_tags #=> Hash
resp.templates[0].job_template_data.job_tags["String128"] #=> String
resp.templates[0].kms_key_arn #=> String
resp.templates[0].decryption_error #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

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

    The date and time after which the job templates were created.

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

    The date and time before which the job templates were created.

  • :max_results (Integer) —

    The maximum number of job templates that can be listed.

  • :next_token (String) —

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

Returns:

See Also:



1475
1476
1477
1478
 
# File 'gems/aws-sdk-emrcontainers/lib/aws-sdk-emrcontainers/client.rb', line 1475

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

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].certificate_authority.certificate_arn #=> String
resp.endpoints[0].certificate_authority.certificate_data #=> 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.managed_logs.allow_aws_to_retain_logs #=> String, one of "ENABLED", "DISABLED"
resp.endpoints[0].configuration_overrides.monitoring_configuration.managed_logs.encryption_key_arn #=> String
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].configuration_overrides.monitoring_configuration.container_log_rotation_configuration.rotation_size #=> String
resp.endpoints[0].configuration_overrides.monitoring_configuration.container_log_rotation_configuration.max_files_to_keep #=> Integer
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].state_details #=> String
resp.endpoints[0].failure_reason #=> String, one of "INTERNAL_ERROR", "USER_ERROR", "VALIDATION_ERROR", "CLUSTER_UNAVAILABLE"
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:



1567
1568
1569
1570
 
# File 'gems/aws-sdk-emrcontainers/lib/aws-sdk-emrcontainers/client.rb', line 1567

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

Examples:

Request syntax with placeholder values


resp = client.list_security_configurations({
  created_after: Time.now,
  created_before: Time.now,
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.security_configurations #=> Array
resp.security_configurations[0].id #=> String
resp.security_configurations[0].name #=> String
resp.security_configurations[0].arn #=> String
resp.security_configurations[0].created_at #=> Time
resp.security_configurations[0].created_by #=> String
resp.security_configurations[0].security_configuration_data.authorization_configuration.lake_formation_configuration.authorized_session_tag_value #=> String
resp.security_configurations[0].security_configuration_data.authorization_configuration.lake_formation_configuration.secure_namespace_info.cluster_id #=> String
resp.security_configurations[0].security_configuration_data.authorization_configuration.lake_formation_configuration.secure_namespace_info.namespace #=> String
resp.security_configurations[0].security_configuration_data.authorization_configuration.lake_formation_configuration.query_engine_role_arn #=> String
resp.security_configurations[0].security_configuration_data.authorization_configuration.encryption_configuration.in_transit_encryption_configuration.tls_certificate_configuration.certificate_provider_type #=> String, one of "PEM"
resp.security_configurations[0].security_configuration_data.authorization_configuration.encryption_configuration.in_transit_encryption_configuration.tls_certificate_configuration.public_certificate_secret_arn #=> String
resp.security_configurations[0].security_configuration_data.authorization_configuration.encryption_configuration.in_transit_encryption_configuration.tls_certificate_configuration.private_certificate_secret_arn #=> String
resp.security_configurations[0].tags #=> Hash
resp.security_configurations[0].tags["String128"] #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

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

    The date and time after which the security configuration was created.

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

    The date and time before which the security configuration was created.

  • :max_results (Integer) —

    The maximum number of security configurations the operation can list.

  • :next_token (String) —

    The token for the next set of security configurations to return.

Returns:

See Also:



1630
1631
1632
1633
 
# File 'gems/aws-sdk-emrcontainers/lib/aws-sdk-emrcontainers/client.rb', line 1630

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



1659
1660
1661
1662
 
# File 'gems/aws-sdk-emrcontainers/lib/aws-sdk-emrcontainers/client.rb', line 1659

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",
  eks_access_entry_integrated: false,
})

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.virtual_clusters[0].security_configuration_id #=> 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. Amazon 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.

  • :eks_access_entry_integrated (Boolean) —

    Optional Boolean that specifies whether the operation should return the virtual clusters that have the access entry integration enabled or disabled. If not specified, the operation returns all applicable virtual clusters.

Returns:

See Also:



1740
1741
1742
1743
 
# File 'gems/aws-sdk-emrcontainers/lib/aws-sdk-emrcontainers/client.rb', line 1740

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",
  release_label: "ReleaseLabel",
  job_driver: {
    spark_submit_job_driver: {
      entry_point: "EntryPointPath", # required
      entry_point_arguments: ["EntryPointArgument"],
      spark_submit_parameters: "SparkSubmitParameters",
    },
    spark_sql_job_driver: {
      entry_point: "EntryPointPath",
      spark_sql_parameters: "SparkSqlParameters",
    },
  },
  configuration_overrides: {
    application_configuration: [
      {
        classification: "String1024", # required
        properties: {
          "String1024" => "String1024",
        },
        configurations: {
          # recursive ConfigurationList
        },
      },
    ],
    monitoring_configuration: {
      managed_logs: {
        allow_aws_to_retain_logs: "ENABLED", # accepts ENABLED, DISABLED
        encryption_key_arn: "KmsKeyArn",
      },
      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
      },
      container_log_rotation_configuration: {
        rotation_size: "RotationSize", # required
        max_files_to_keep: 1, # required
      },
    },
  },
  tags: {
    "String128" => "StringEmpty256",
  },
  job_template_id: "ResourceIdString",
  job_template_parameters: {
    "TemplateParameterName" => "String1024",
  },
  retry_policy_configuration: {
    max_attempts: 1, # required
  },
})

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 (String) —

    The execution role ARN for the job run.

  • :release_label (String) —

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

  • :job_driver (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.

  • :job_template_id (String) —

    The job template ID to be used to start the job run.

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

    The values of job template parameters to start a job run.

  • :retry_policy_configuration (Types::RetryPolicyConfiguration) —

    The retry policy configuration for the job run.

Returns:

See Also:



1865
1866
1867
1868
 
# File 'gems/aws-sdk-emrcontainers/lib/aws-sdk-emrcontainers/client.rb', line 1865

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 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.

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:



1903
1904
1905
1906
 
# File 'gems/aws-sdk-emrcontainers/lib/aws-sdk-emrcontainers/client.rb', line 1903

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:



1929
1930
1931
1932
 
# File 'gems/aws-sdk-emrcontainers/lib/aws-sdk-emrcontainers/client.rb', line 1929

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