Class: Aws::EMRServerless::Client

Inherits:
Seahorse::Client::Base show all
Includes:
ClientStubs
Defined in:
gems/aws-sdk-emrserverless/lib/aws-sdk-emrserverless/client.rb

Overview

An API client for EMRServerless. To construct a client, you need to configure a :region and :credentials.

client = Aws::EMRServerless::Client.new(
  region: region_name,
  credentials: credentials,
  # ...
)

For details on configuring region and credentials see the developer guide.

See #initialize for a full list of supported configuration options.

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

#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. 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)
  • :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 —

    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.

  • :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::EMRServerless::EndpointProvider) —

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

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

  • :ssl_timeout (Float) — default: nil —

    Sets the SSL timeout in seconds.

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



365
366
367
 
# File 'gems/aws-sdk-emrserverless/lib/aws-sdk-emrserverless/client.rb', line 365

def initialize(*args)
  super
end

Instance Method Details

#cancel_job_run(params = {}) ⇒ Types::CancelJobRunResponse

Cancels a job run.

Examples:

Request syntax with placeholder values


resp = client.cancel_job_run({
  application_id: "ApplicationId", # required
  job_run_id: "JobRunId", # required
})

Response structure


resp.application_id #=> String
resp.job_run_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :application_id (required, String) —

    The ID of the application on which the job run will be canceled.

  • :job_run_id (required, String) —

    The ID of the job run to cancel.

Returns:

See Also:



400
401
402
403
 
# File 'gems/aws-sdk-emrserverless/lib/aws-sdk-emrserverless/client.rb', line 400

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

#create_application(params = {}) ⇒ Types::CreateApplicationResponse

Creates an application.

Examples:

Request syntax with placeholder values


resp = client.create_application({
  name: "ApplicationName",
  release_label: "ReleaseLabel", # required
  type: "EngineType", # required
  client_token: "ClientToken", # required
  initial_capacity: {
    "WorkerTypeString" => {
      worker_count: 1, # required
      worker_configuration: {
        cpu: "CpuSize", # required
        memory: "MemorySize", # required
        disk: "DiskSize",
      },
    },
  },
  maximum_capacity: {
    cpu: "CpuSize", # required
    memory: "MemorySize", # required
    disk: "DiskSize",
  },
  tags: {
    "TagKey" => "TagValue",
  },
  auto_start_configuration: {
    enabled: false,
  },
  auto_stop_configuration: {
    enabled: false,
    idle_timeout_minutes: 1,
  },
  network_configuration: {
    subnet_ids: ["SubnetString"],
    security_group_ids: ["SecurityGroupString"],
  },
  architecture: "ARM64", # accepts ARM64, X86_64
  image_configuration: {
    image_uri: "ImageUri",
  },
  worker_type_specifications: {
    "WorkerTypeString" => {
      image_configuration: {
        image_uri: "ImageUri",
      },
    },
  },
})

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :name (String) —

    The name of the application.

  • :release_label (required, String) —

    The EMR release associated with the application.

  • :type (required, String) —

    The type of application you want to start, such as Spark or Hive.

  • :client_token (required, String) —

    The client idempotency token of the application to create. Its value must be unique for each request.

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

  • :initial_capacity (Hash<String,Types::InitialCapacityConfig>) —

    The capacity to initialize when the application is created.

  • :maximum_capacity (Types::MaximumAllowedResources) —

    The maximum capacity to allocate when the application is created. This is cumulative across all workers at any given point in time, not just when an application is created. No new resources will be created once any one of the defined limits is hit.

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

    The tags assigned to the application.

  • :auto_start_configuration (Types::AutoStartConfig) —

    The configuration for an application to automatically start on job submission.

  • :auto_stop_configuration (Types::AutoStopConfig) —

    The configuration for an application to automatically stop after a certain amount of time being idle.

  • :network_configuration (Types::NetworkConfiguration) —

    The network configuration for customer VPC connectivity.

  • :architecture (String) —

    The CPU architecture of an application.

  • :image_configuration (Types::ImageConfigurationInput) —

    The image configuration for all worker types. You can either set this parameter or imageConfiguration for each worker type in workerTypeSpecifications.

  • :worker_type_specifications (Hash<String,Types::WorkerTypeSpecificationInput>) —

    The key-value pairs that specify worker type to WorkerTypeSpecificationInput. This parameter must contain all valid worker types for a Spark or Hive application. Valid worker types include Driver and Executor for Spark applications and HiveDriver and TezTask for Hive applications. You can either set image details in this parameter for each worker type, or in imageConfiguration for all worker types.

Returns:

See Also:



528
529
530
531
 
# File 'gems/aws-sdk-emrserverless/lib/aws-sdk-emrserverless/client.rb', line 528

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

#delete_application(params = {}) ⇒ Struct

Deletes an application. An application has to be in a stopped or created state in order to be deleted.

Examples:

Request syntax with placeholder values


resp = client.delete_application({
  application_id: "ApplicationId", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :application_id (required, String) —

    The ID of the application that will be deleted.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



551
552
553
554
 
# File 'gems/aws-sdk-emrserverless/lib/aws-sdk-emrserverless/client.rb', line 551

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

#get_application(params = {}) ⇒ Types::GetApplicationResponse

Displays detailed information about a specified application.

Examples:

Request syntax with placeholder values


resp = client.get_application({
  application_id: "ApplicationId", # required
})

Response structure


resp.application.application_id #=> String
resp.application.name #=> String
resp.application.arn #=> String
resp.application.release_label #=> String
resp.application.type #=> String
resp.application.state #=> String, one of "CREATING", "CREATED", "STARTING", "STARTED", "STOPPING", "STOPPED", "TERMINATED"
resp.application.state_details #=> String
resp.application.initial_capacity #=> Hash
resp.application.initial_capacity["WorkerTypeString"].worker_count #=> Integer
resp.application.initial_capacity["WorkerTypeString"].worker_configuration.cpu #=> String
resp.application.initial_capacity["WorkerTypeString"].worker_configuration.memory #=> String
resp.application.initial_capacity["WorkerTypeString"].worker_configuration.disk #=> String
resp.application.maximum_capacity.cpu #=> String
resp.application.maximum_capacity.memory #=> String
resp.application.maximum_capacity.disk #=> String
resp.application.created_at #=> Time
resp.application.updated_at #=> Time
resp.application.tags #=> Hash
resp.application.tags["TagKey"] #=> String
resp.application.auto_start_configuration.enabled #=> Boolean
resp.application.auto_stop_configuration.enabled #=> Boolean
resp.application.auto_stop_configuration.idle_timeout_minutes #=> Integer
resp.application.network_configuration.subnet_ids #=> Array
resp.application.network_configuration.subnet_ids[0] #=> String
resp.application.network_configuration.security_group_ids #=> Array
resp.application.network_configuration.security_group_ids[0] #=> String
resp.application.architecture #=> String, one of "ARM64", "X86_64"
resp.application.image_configuration.image_uri #=> String
resp.application.image_configuration.resolved_image_digest #=> String
resp.application.worker_type_specifications #=> Hash
resp.application.worker_type_specifications["WorkerTypeString"].image_configuration.image_uri #=> String
resp.application.worker_type_specifications["WorkerTypeString"].image_configuration.resolved_image_digest #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :application_id (required, String) —

    The ID of the application that will be described.

Returns:

See Also:



610
611
612
613
 
# File 'gems/aws-sdk-emrserverless/lib/aws-sdk-emrserverless/client.rb', line 610

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

#get_dashboard_for_job_run(params = {}) ⇒ Types::GetDashboardForJobRunResponse

Returns a URL to access the job run dashboard.

Examples:

Request syntax with placeholder values


resp = client.get_dashboard_for_job_run({
  application_id: "ApplicationId", # required
  job_run_id: "JobRunId", # required
})

Response structure


resp.url #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :application_id (required, String) —

    The ID of the application.

  • :job_run_id (required, String) —

    The ID of the job run.

Returns:

See Also:



642
643
644
645
 
# File 'gems/aws-sdk-emrserverless/lib/aws-sdk-emrserverless/client.rb', line 642

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

#get_job_run(params = {}) ⇒ Types::GetJobRunResponse

Displays detailed information about a job run.

Examples:

Request syntax with placeholder values


resp = client.get_job_run({
  application_id: "ApplicationId", # required
  job_run_id: "JobRunId", # required
})

Response structure


resp.job_run.application_id #=> String
resp.job_run.job_run_id #=> String
resp.job_run.name #=> String
resp.job_run.arn #=> String
resp.job_run.created_by #=> String
resp.job_run.created_at #=> Time
resp.job_run.updated_at #=> Time
resp.job_run.execution_role #=> String
resp.job_run.state #=> String, one of "SUBMITTED", "PENDING", "SCHEDULED", "RUNNING", "SUCCESS", "FAILED", "CANCELLING", "CANCELLED"
resp.job_run.state_details #=> 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.s3_monitoring_configuration.log_uri #=> String
resp.job_run.configuration_overrides.monitoring_configuration.s3_monitoring_configuration.encryption_key_arn #=> String
resp.job_run.configuration_overrides.monitoring_configuration.managed_persistence_monitoring_configuration.enabled #=> Boolean
resp.job_run.configuration_overrides.monitoring_configuration.managed_persistence_monitoring_configuration.encryption_key_arn #=> String
resp.job_run.job_driver.spark_submit.entry_point #=> String
resp.job_run.job_driver.spark_submit.entry_point_arguments #=> Array
resp.job_run.job_driver.spark_submit.entry_point_arguments[0] #=> String
resp.job_run.job_driver.spark_submit.spark_submit_parameters #=> String
resp.job_run.job_driver.hive.query #=> String
resp.job_run.job_driver.hive.init_query_file #=> String
resp.job_run.job_driver.hive.parameters #=> String
resp.job_run.tags #=> Hash
resp.job_run.tags["TagKey"] #=> String
resp.job_run.total_resource_utilization.v_cpu_hour #=> Float
resp.job_run.total_resource_utilization.memory_gb_hour #=> Float
resp.job_run.total_resource_utilization.storage_gb_hour #=> Float
resp.job_run.network_configuration.subnet_ids #=> Array
resp.job_run.network_configuration.subnet_ids[0] #=> String
resp.job_run.network_configuration.security_group_ids #=> Array
resp.job_run.network_configuration.security_group_ids[0] #=> String
resp.job_run.total_execution_duration_seconds #=> Integer

Parameters:

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

    ({})

Options Hash (params):

  • :application_id (required, String) —

    The ID of the application on which the job run is submitted.

  • :job_run_id (required, String) —

    The ID of the job run.

Returns:

See Also:



710
711
712
713
 
# File 'gems/aws-sdk-emrserverless/lib/aws-sdk-emrserverless/client.rb', line 710

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

#list_applications(params = {}) ⇒ Types::ListApplicationsResponse

Lists applications based on a set of parameters.

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

Examples:

Request syntax with placeholder values


resp = client.list_applications({
  next_token: "NextToken",
  max_results: 1,
  states: ["CREATING"], # accepts CREATING, CREATED, STARTING, STARTED, STOPPING, STOPPED, TERMINATED
})

Response structure


resp.applications #=> Array
resp.applications[0].id #=> String
resp.applications[0].name #=> String
resp.applications[0].arn #=> String
resp.applications[0].release_label #=> String
resp.applications[0].type #=> String
resp.applications[0].state #=> String, one of "CREATING", "CREATED", "STARTING", "STARTED", "STOPPING", "STOPPED", "TERMINATED"
resp.applications[0].state_details #=> String
resp.applications[0].created_at #=> Time
resp.applications[0].updated_at #=> Time
resp.applications[0].architecture #=> String, one of "ARM64", "X86_64"
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :next_token (String) —

    The token for the next set of application results.

  • :max_results (Integer) —

    The maximum number of applications that can be listed.

  • :states (Array<String>) —

    An optional filter for application states. Note that if this filter contains multiple states, the resulting list will be grouped by the state.

Returns:

See Also:



762
763
764
765
 
# File 'gems/aws-sdk-emrserverless/lib/aws-sdk-emrserverless/client.rb', line 762

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

#list_job_runs(params = {}) ⇒ Types::ListJobRunsResponse

Lists job runs based on a set of parameters.

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

Examples:

Request syntax with placeholder values


resp = client.list_job_runs({
  application_id: "ApplicationId", # required
  next_token: "NextToken",
  max_results: 1,
  created_at_after: Time.now,
  created_at_before: Time.now,
  states: ["SUBMITTED"], # accepts SUBMITTED, PENDING, SCHEDULED, RUNNING, SUCCESS, FAILED, CANCELLING, CANCELLED
})

Response structure


resp.job_runs #=> Array
resp.job_runs[0].application_id #=> String
resp.job_runs[0].id #=> String
resp.job_runs[0].name #=> String
resp.job_runs[0].arn #=> String
resp.job_runs[0].created_by #=> String
resp.job_runs[0].created_at #=> Time
resp.job_runs[0].updated_at #=> Time
resp.job_runs[0].execution_role #=> String
resp.job_runs[0].state #=> String, one of "SUBMITTED", "PENDING", "SCHEDULED", "RUNNING", "SUCCESS", "FAILED", "CANCELLING", "CANCELLED"
resp.job_runs[0].state_details #=> String
resp.job_runs[0].release_label #=> String
resp.job_runs[0].type #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :application_id (required, String) —

    The ID of the application for which to list the job run.

  • :next_token (String) —

    The token for the next set of job run results.

  • :max_results (Integer) —

    The maximum number of job runs that can be listed.

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

    The lower bound of the option to filter by creation date and time.

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

    The upper bound of the option to filter by creation date and time.

  • :states (Array<String>) —

    An optional filter for job run states. Note that if this filter contains multiple states, the resulting list will be grouped by the state.

Returns:

See Also:



828
829
830
831
 
# File 'gems/aws-sdk-emrserverless/lib/aws-sdk-emrserverless/client.rb', line 828

def list_job_runs(params = {}, options = {})
  req = build_request(:list_job_runs, 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: "ResourceArn", # required
})

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The Amazon Resource Name (ARN) that identifies the resource to list the tags for. Currently, the supported resources are Amazon EMR Serverless applications and job runs.

Returns:

See Also:



859
860
861
862
 
# File 'gems/aws-sdk-emrserverless/lib/aws-sdk-emrserverless/client.rb', line 859

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

#start_application(params = {}) ⇒ Struct

Starts a specified application and initializes initial capacity if configured.

Examples:

Request syntax with placeholder values


resp = client.start_application({
  application_id: "ApplicationId", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :application_id (required, String) —

    The ID of the application to start.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



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

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

#start_job_run(params = {}) ⇒ Types::StartJobRunResponse

Starts a job run.

Examples:

Request syntax with placeholder values


resp = client.start_job_run({
  application_id: "ApplicationId", # required
  client_token: "ClientToken", # required
  execution_role_arn: "IAMRoleArn", # required
  job_driver: {
    spark_submit: {
      entry_point: "EntryPointPath", # required
      entry_point_arguments: ["EntryPointArgument"],
      spark_submit_parameters: "SparkSubmitParameters",
    },
    hive: {
      query: "Query", # required
      init_query_file: "InitScriptPath",
      parameters: "HiveCliParameters",
    },
  },
  configuration_overrides: {
    application_configuration: [
      {
        classification: "String1024", # required
        properties: {
          "String1024" => "String1024",
        },
        configurations: {
          # recursive ConfigurationList
        },
      },
    ],
    monitoring_configuration: {
      s3_monitoring_configuration: {
        log_uri: "UriString",
        encryption_key_arn: "EncryptionKeyArn",
      },
      managed_persistence_monitoring_configuration: {
        enabled: false,
        encryption_key_arn: "EncryptionKeyArn",
      },
    },
  },
  tags: {
    "TagKey" => "TagValue",
  },
  execution_timeout_minutes: 1,
  name: "String256",
})

Response structure


resp.application_id #=> String
resp.job_run_id #=> String
resp.arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :application_id (required, String) —

    The ID of the application on which to run the job.

  • :client_token (required, String) —

    The client idempotency token of the job run to start. Its value must be unique for each 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.

  • :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 the job run.

  • :execution_timeout_minutes (Integer) —

    The maximum duration for the job run to run. If the job run runs beyond this duration, it will be automatically cancelled.

  • :name (String) —

    The optional job run name. This doesn't have to be unique.

Returns:

See Also:



982
983
984
985
 
# File 'gems/aws-sdk-emrserverless/lib/aws-sdk-emrserverless/client.rb', line 982

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

#stop_application(params = {}) ⇒ Struct

Stops a specified application and releases initial capacity if configured. All scheduled and running jobs must be completed or cancelled before stopping an application.

Examples:

Request syntax with placeholder values


resp = client.stop_application({
  application_id: "ApplicationId", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :application_id (required, String) —

    The ID of the application to stop.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1006
1007
1008
1009
 
# File 'gems/aws-sdk-emrserverless/lib/aws-sdk-emrserverless/client.rb', line 1006

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

Examples:

Request syntax with placeholder values


resp = client.tag_resource({
  resource_arn: "ResourceArn", # required
  tags: { # required
    "TagKey" => "TagValue",
  },
})

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The Amazon Resource Name (ARN) that identifies the resource to list the tags for. Currently, the supported resources are Amazon EMR Serverless applications and job runs.

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

    The tags to add to the resource. A tag is an array of key-value pairs.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1041
1042
1043
1044
 
# File 'gems/aws-sdk-emrserverless/lib/aws-sdk-emrserverless/client.rb', line 1041

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: "ResourceArn", # required
  tag_keys: ["TagKey"], # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The Amazon Resource Name (ARN) that identifies the resource to list the tags for. Currently, the supported resources are Amazon EMR Serverless applications and job runs.

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

    The keys of the tags to be removed.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1069
1070
1071
1072
 
# File 'gems/aws-sdk-emrserverless/lib/aws-sdk-emrserverless/client.rb', line 1069

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

#update_application(params = {}) ⇒ Types::UpdateApplicationResponse

Updates a specified application. An application has to be in a stopped or created state in order to be updated.

Examples:

Request syntax with placeholder values


resp = client.update_application({
  application_id: "ApplicationId", # required
  client_token: "ClientToken", # required
  initial_capacity: {
    "WorkerTypeString" => {
      worker_count: 1, # required
      worker_configuration: {
        cpu: "CpuSize", # required
        memory: "MemorySize", # required
        disk: "DiskSize",
      },
    },
  },
  maximum_capacity: {
    cpu: "CpuSize", # required
    memory: "MemorySize", # required
    disk: "DiskSize",
  },
  auto_start_configuration: {
    enabled: false,
  },
  auto_stop_configuration: {
    enabled: false,
    idle_timeout_minutes: 1,
  },
  network_configuration: {
    subnet_ids: ["SubnetString"],
    security_group_ids: ["SecurityGroupString"],
  },
  architecture: "ARM64", # accepts ARM64, X86_64
  image_configuration: {
    image_uri: "ImageUri",
  },
  worker_type_specifications: {
    "WorkerTypeString" => {
      image_configuration: {
        image_uri: "ImageUri",
      },
    },
  },
})

Response structure


resp.application.application_id #=> String
resp.application.name #=> String
resp.application.arn #=> String
resp.application.release_label #=> String
resp.application.type #=> String
resp.application.state #=> String, one of "CREATING", "CREATED", "STARTING", "STARTED", "STOPPING", "STOPPED", "TERMINATED"
resp.application.state_details #=> String
resp.application.initial_capacity #=> Hash
resp.application.initial_capacity["WorkerTypeString"].worker_count #=> Integer
resp.application.initial_capacity["WorkerTypeString"].worker_configuration.cpu #=> String
resp.application.initial_capacity["WorkerTypeString"].worker_configuration.memory #=> String
resp.application.initial_capacity["WorkerTypeString"].worker_configuration.disk #=> String
resp.application.maximum_capacity.cpu #=> String
resp.application.maximum_capacity.memory #=> String
resp.application.maximum_capacity.disk #=> String
resp.application.created_at #=> Time
resp.application.updated_at #=> Time
resp.application.tags #=> Hash
resp.application.tags["TagKey"] #=> String
resp.application.auto_start_configuration.enabled #=> Boolean
resp.application.auto_stop_configuration.enabled #=> Boolean
resp.application.auto_stop_configuration.idle_timeout_minutes #=> Integer
resp.application.network_configuration.subnet_ids #=> Array
resp.application.network_configuration.subnet_ids[0] #=> String
resp.application.network_configuration.security_group_ids #=> Array
resp.application.network_configuration.security_group_ids[0] #=> String
resp.application.architecture #=> String, one of "ARM64", "X86_64"
resp.application.image_configuration.image_uri #=> String
resp.application.image_configuration.resolved_image_digest #=> String
resp.application.worker_type_specifications #=> Hash
resp.application.worker_type_specifications["WorkerTypeString"].image_configuration.image_uri #=> String
resp.application.worker_type_specifications["WorkerTypeString"].image_configuration.resolved_image_digest #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :application_id (required, String) —

    The ID of the application to update.

  • :client_token (required, String) —

    The client idempotency token of the application to update. Its value must be unique for each request.

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

  • :initial_capacity (Hash<String,Types::InitialCapacityConfig>) —

    The capacity to initialize when the application is updated.

  • :maximum_capacity (Types::MaximumAllowedResources) —

    The maximum capacity to allocate when the application is updated. This is cumulative across all workers at any given point in time during the lifespan of the application. No new resources will be created once any one of the defined limits is hit.

  • :auto_start_configuration (Types::AutoStartConfig) —

    The configuration for an application to automatically start on job submission.

  • :auto_stop_configuration (Types::AutoStopConfig) —

    The configuration for an application to automatically stop after a certain amount of time being idle.

  • :network_configuration (Types::NetworkConfiguration) —

    The network configuration for customer VPC connectivity.

  • :architecture (String) —

    The CPU architecture of an application.

  • :image_configuration (Types::ImageConfigurationInput) —

    The image configuration to be used for all worker types. You can either set this parameter or imageConfiguration for each worker type in WorkerTypeSpecificationInput.

  • :worker_type_specifications (Hash<String,Types::WorkerTypeSpecificationInput>) —

    The key-value pairs that specify worker type to WorkerTypeSpecificationInput. This parameter must contain all valid worker types for a Spark or Hive application. Valid worker types include Driver and Executor for Spark applications and HiveDriver and TezTask for Hive applications. You can either set image details in this parameter for each worker type, or in imageConfiguration for all worker types.

Returns:

See Also:



1211
1212
1213
1214
 
# File 'gems/aws-sdk-emrserverless/lib/aws-sdk-emrserverless/client.rb', line 1211

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