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

  • :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 used for authentication. This can be any class that includes and implements Aws::CredentialProvider, or 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.

  • :auth_scheme_preference (Array<String>) —

    A list of preferred authentication schemes to use when making a request. Supported values are: sigv4, sigv4a, httpBearerAuth, and noAuth. When set using ENV['AWS_AUTH_SCHEME_PREFERENCE'] or in shared config as auth_scheme_preference, the value should be a comma-separated list.

  • :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 the 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 - A retry mode that includes all the functionality of standard mode along with automatic client side throttling.

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

    Your Bearer token used for authentication. This can be any class that includes and implements Aws::TokenProvider, or 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_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.



471
472
473
 
# File 'gems/aws-sdk-emrserverless/lib/aws-sdk-emrserverless/client.rb', line 471

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
  shutdown_grace_period_in_seconds: 1,
})

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.

  • :shutdown_grace_period_in_seconds (Integer) —

    The duration in seconds to wait before forcefully terminating the job after cancellation is requested.

Returns:

See Also:



511
512
513
514
 
# File 'gems/aws-sdk-emrserverless/lib/aws-sdk-emrserverless/client.rb', line 511

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",
        disk_type: "DiskType",
      },
    },
  },
  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",
      },
    },
  },
  runtime_configuration: [
    {
      classification: "String1024", # required
      properties: {
        "ConfigurationPropertyKey" => "ConfigurationPropertyValue",
      },
      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",
    },
    cloud_watch_logging_configuration: {
      enabled: false, # required
      log_group_name: "LogGroupName",
      log_stream_name_prefix: "LogStreamNamePrefix",
      encryption_key_arn: "EncryptionKeyArn",
      log_types: {
        "WorkerTypeString" => ["LogTypeString"],
      },
    },
    prometheus_monitoring_configuration: {
      remote_write_url: "PrometheusUrlString",
    },
  },
  disk_encryption_configuration: {
    encryption_context: {
      "EncryptionContextKey" => "EncryptionContextValue",
    },
    encryption_key_arn: "EncryptionKeyArn",
  },
  interactive_configuration: {
    studio_enabled: false,
    livy_endpoint_enabled: false,
    session_enabled: false,
  },
  scheduler_configuration: {
    queue_timeout_minutes: 1,
    max_concurrent_runs: 1,
  },
  identity_center_configuration: {
    identity_center_instance_arn: "IdentityCenterInstanceArn",
    user_background_sessions_enabled: false,
  },
  job_level_cost_allocation_configuration: {
    enabled: false,
  },
})

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

  • :runtime_configuration (Array<Types::Configuration>) —

    The Configuration specifications to use when creating an application. Each configuration consists of a classification and properties. This configuration is applied to all the job runs submitted under the application.

  • :monitoring_configuration (Types::MonitoringConfiguration) —

    The configuration setting for monitoring.

  • :disk_encryption_configuration (Types::DiskEncryptionConfiguration) —

    The configuration object that allows encrypting local disks.

  • :interactive_configuration (Types::InteractiveConfiguration) —

    The interactive configuration object that enables the interactive use cases to use when running an application.

  • :scheduler_configuration (Types::SchedulerConfiguration) —

    The scheduler configuration for batch and streaming jobs running on this application. Supported with release labels emr-7.0.0 and above.

  • :identity_center_configuration (Types::IdentityCenterConfigurationInput) —

    The IAM Identity Center Configuration accepts the Identity Center instance parameter required to enable trusted identity propagation. This configuration allows identity propagation between integrated services and the Identity Center instance.

  • :job_level_cost_allocation_configuration (Types::JobLevelCostAllocationConfiguration) —

    The configuration object that enables job level cost allocation.

Returns:

See Also:



728
729
730
731
 
# File 'gems/aws-sdk-emrserverless/lib/aws-sdk-emrserverless/client.rb', line 728

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:



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

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.initial_capacity["WorkerTypeString"].worker_configuration.disk_type #=> 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
resp.application.runtime_configuration #=> Array
resp.application.runtime_configuration[0].classification #=> String
resp.application.runtime_configuration[0].properties #=> Hash
resp.application.runtime_configuration[0].properties["ConfigurationPropertyKey"] #=> String
resp.application.runtime_configuration[0].configurations #=> Types::ConfigurationList
resp.application.monitoring_configuration.s3_monitoring_configuration.log_uri #=> String
resp.application.monitoring_configuration.s3_monitoring_configuration.encryption_key_arn #=> String
resp.application.monitoring_configuration.managed_persistence_monitoring_configuration.enabled #=> Boolean
resp.application.monitoring_configuration.managed_persistence_monitoring_configuration.encryption_key_arn #=> String
resp.application.monitoring_configuration.cloud_watch_logging_configuration.enabled #=> Boolean
resp.application.monitoring_configuration.cloud_watch_logging_configuration.log_group_name #=> String
resp.application.monitoring_configuration.cloud_watch_logging_configuration.log_stream_name_prefix #=> String
resp.application.monitoring_configuration.cloud_watch_logging_configuration.encryption_key_arn #=> String
resp.application.monitoring_configuration.cloud_watch_logging_configuration.log_types #=> Hash
resp.application.monitoring_configuration.cloud_watch_logging_configuration.log_types["WorkerTypeString"] #=> Array
resp.application.monitoring_configuration.cloud_watch_logging_configuration.log_types["WorkerTypeString"][0] #=> String
resp.application.monitoring_configuration.prometheus_monitoring_configuration.remote_write_url #=> String
resp.application.disk_encryption_configuration.encryption_context #=> Hash
resp.application.disk_encryption_configuration.encryption_context["EncryptionContextKey"] #=> String
resp.application.disk_encryption_configuration.encryption_key_arn #=> String
resp.application.interactive_configuration.studio_enabled #=> Boolean
resp.application.interactive_configuration.livy_endpoint_enabled #=> Boolean
resp.application.interactive_configuration.session_enabled #=> Boolean
resp.application.scheduler_configuration.queue_timeout_minutes #=> Integer
resp.application.scheduler_configuration.max_concurrent_runs #=> Integer
resp.application.identity_center_configuration.identity_center_instance_arn #=> String
resp.application.identity_center_configuration.identity_center_application_arn #=> String
resp.application.identity_center_configuration.user_background_sessions_enabled #=> Boolean
resp.application.job_level_cost_allocation_configuration.enabled #=> Boolean

Parameters:

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

    ({})

Options Hash (params):

  • :application_id (required, String) —

    The ID of the application that will be described.

Returns:

See Also:



840
841
842
843
 
# File 'gems/aws-sdk-emrserverless/lib/aws-sdk-emrserverless/client.rb', line 840

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

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

Creates and returns a URL that you can use to access the application UIs for a job run.

For jobs in a running state, the application UI is a live user interface such as the Spark or Tez web UI. For completed jobs, the application UI is a persistent application user interface such as the Spark History Server or persistent Tez UI.

The URL is valid for one hour after you generate it. To access the application UI after that hour elapses, you must invoke the API again to generate a new URL.

Examples:

Request syntax with placeholder values


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

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.

  • :attempt (Integer) —

    An optimal parameter that indicates the amount of attempts for the job. If not specified, this value defaults to the attempt of the latest job.

  • :access_system_profile_logs (Boolean) —

    Allows access to system profile logs for Lake Formation-enabled jobs. Default is false.

Returns:

See Also:



895
896
897
898
 
# File 'gems/aws-sdk-emrserverless/lib/aws-sdk-emrserverless/client.rb', line 895

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
  attempt: 1,
})

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.execution_iam_policy.policy #=> String
resp.job_run.execution_iam_policy.policy_arns #=> Array
resp.job_run.execution_iam_policy.policy_arns[0] #=> String
resp.job_run.state #=> String, one of "SUBMITTED", "PENDING", "SCHEDULED", "RUNNING", "SUCCESS", "FAILED", "CANCELLING", "CANCELLED", "QUEUED"
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["ConfigurationPropertyKey"] #=> 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.configuration_overrides.monitoring_configuration.cloud_watch_logging_configuration.enabled #=> Boolean
resp.job_run.configuration_overrides.monitoring_configuration.cloud_watch_logging_configuration.log_group_name #=> String
resp.job_run.configuration_overrides.monitoring_configuration.cloud_watch_logging_configuration.log_stream_name_prefix #=> String
resp.job_run.configuration_overrides.monitoring_configuration.cloud_watch_logging_configuration.encryption_key_arn #=> String
resp.job_run.configuration_overrides.monitoring_configuration.cloud_watch_logging_configuration.log_types #=> Hash
resp.job_run.configuration_overrides.monitoring_configuration.cloud_watch_logging_configuration.log_types["WorkerTypeString"] #=> Array
resp.job_run.configuration_overrides.monitoring_configuration.cloud_watch_logging_configuration.log_types["WorkerTypeString"][0] #=> String
resp.job_run.configuration_overrides.monitoring_configuration.prometheus_monitoring_configuration.remote_write_url #=> String
resp.job_run.configuration_overrides.disk_encryption_configuration.encryption_context #=> Hash
resp.job_run.configuration_overrides.disk_encryption_configuration.encryption_context["EncryptionContextKey"] #=> String
resp.job_run.configuration_overrides.disk_encryption_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
resp.job_run.execution_timeout_minutes #=> Integer
resp.job_run.billed_resource_utilization.v_cpu_hour #=> Float
resp.job_run.billed_resource_utilization.memory_gb_hour #=> Float
resp.job_run.billed_resource_utilization.storage_gb_hour #=> Float
resp.job_run.mode #=> String, one of "BATCH", "STREAMING"
resp.job_run.retry_policy.max_attempts #=> Integer
resp.job_run.retry_policy.max_failed_attempts_per_hour #=> Integer
resp.job_run.attempt #=> Integer
resp.job_run.attempt_created_at #=> Time
resp.job_run.attempt_updated_at #=> Time
resp.job_run.started_at #=> Time
resp.job_run.ended_at #=> Time
resp.job_run.queued_duration_milliseconds #=> 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.

  • :attempt (Integer) —

    An optimal parameter that indicates the amount of attempts for the job. If not specified, this value defaults to the attempt of the latest job.

Returns:

See Also:



996
997
998
999
 
# File 'gems/aws-sdk-emrserverless/lib/aws-sdk-emrserverless/client.rb', line 996

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

#get_resource_dashboard(params = {}) ⇒ Types::GetResourceDashboardResponse

Returns a URL that you can use to access the application UIs for a specified resource, such as a session.

For resources in a running state, the application UI is a live user interface such as the Spark web UI. For terminated resources, the application UI is a persistent application user interface such as the Spark History Server.

The URL is valid for one hour after you generate it. To access the application UI after that hour elapses, you must invoke the API again to generate a new URL.

Examples:

Request syntax with placeholder values


resp = client.get_resource_dashboard({
  application_id: "ApplicationId", # required
  resource_id: "ResourceId", # required
  resource_type: "SESSION", # required, accepts SESSION
})

Response structure


resp.url #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :application_id (required, String) —

    The ID of the application that the resource belongs to.

  • :resource_id (required, String) —

    The ID of the resource.

  • :resource_type (required, String) —

    The type of resource to access the dashboard for. Currently, only Session is supported.

Returns:

See Also:



1045
1046
1047
1048
 
# File 'gems/aws-sdk-emrserverless/lib/aws-sdk-emrserverless/client.rb', line 1045

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

#get_session(params = {}) ⇒ Types::GetSessionResponse

Displays detailed information about a session.

Examples:

Request syntax with placeholder values


resp = client.get_session({
  application_id: "ApplicationId", # required
  session_id: "SessionId", # required
})

Response structure


resp.session.application_id #=> String
resp.session.session_id #=> String
resp.session.arn #=> String
resp.session.name #=> String
resp.session.state #=> String, one of "SUBMITTED", "STARTING", "STARTED", "IDLE", "BUSY", "FAILED", "TERMINATING", "TERMINATED"
resp.session.state_details #=> String
resp.session.release_label #=> String
resp.session.execution_role_arn #=> String
resp.session.created_by #=> String
resp.session.created_at #=> Time
resp.session.updated_at #=> Time
resp.session.started_at #=> Time
resp.session.ended_at #=> Time
resp.session.idle_since #=> Time
resp.session.configuration_overrides.runtime_configuration #=> Array
resp.session.configuration_overrides.runtime_configuration[0].classification #=> String
resp.session.configuration_overrides.runtime_configuration[0].properties #=> Hash
resp.session.configuration_overrides.runtime_configuration[0].properties["ConfigurationPropertyKey"] #=> String
resp.session.configuration_overrides.runtime_configuration[0].configurations #=> Types::ConfigurationList
resp.session.network_configuration.subnet_ids #=> Array
resp.session.network_configuration.subnet_ids[0] #=> String
resp.session.network_configuration.security_group_ids #=> Array
resp.session.network_configuration.security_group_ids[0] #=> String
resp.session.idle_timeout_minutes #=> Integer
resp.session.tags #=> Hash
resp.session.tags["TagKey"] #=> String
resp.session.total_resource_utilization.v_cpu_hour #=> Float
resp.session.total_resource_utilization.memory_gb_hour #=> Float
resp.session.total_resource_utilization.storage_gb_hour #=> Float
resp.session.billed_resource_utilization.v_cpu_hour #=> Float
resp.session.billed_resource_utilization.memory_gb_hour #=> Float
resp.session.billed_resource_utilization.storage_gb_hour #=> Float
resp.session.total_execution_duration_seconds #=> Integer

Parameters:

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

    ({})

Options Hash (params):

  • :application_id (required, String) —

    The ID of the application that the session belongs to.

  • :session_id (required, String) —

    The ID of the session.

Returns:

See Also:



1109
1110
1111
1112
 
# File 'gems/aws-sdk-emrserverless/lib/aws-sdk-emrserverless/client.rb', line 1109

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

#get_session_endpoint(params = {}) ⇒ Types::GetSessionEndpointResponse

Returns the session endpoint URL and a time-limited authentication token for the specified session. Use the endpoint and token to connect a client to the session. Call this operation again when the authentication token expires to obtain a new token.

Examples:

Request syntax with placeholder values


resp = client.get_session_endpoint({
  application_id: "ApplicationId", # required
  session_id: "SessionId", # required
})

Response structure


resp.application_id #=> String
resp.session_id #=> String
resp.endpoint #=> String
resp.auth_token #=> String
resp.auth_token_expires_at #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :application_id (required, String) —

    The ID of the application that the session belongs to.

  • :session_id (required, String) —

    The ID of the session.

Returns:

See Also:



1152
1153
1154
1155
 
# File 'gems/aws-sdk-emrserverless/lib/aws-sdk-emrserverless/client.rb', line 1152

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



1204
1205
1206
1207
 
# File 'gems/aws-sdk-emrserverless/lib/aws-sdk-emrserverless/client.rb', line 1204

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

#list_job_run_attempts(params = {}) ⇒ Types::ListJobRunAttemptsResponse

Lists all attempt of a job run.

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

Examples:

Request syntax with placeholder values


resp = client.list_job_run_attempts({
  application_id: "ApplicationId", # required
  job_run_id: "JobRunId", # required
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.job_run_attempts #=> Array
resp.job_run_attempts[0].application_id #=> String
resp.job_run_attempts[0].id #=> String
resp.job_run_attempts[0].name #=> String
resp.job_run_attempts[0].mode #=> String, one of "BATCH", "STREAMING"
resp.job_run_attempts[0].arn #=> String
resp.job_run_attempts[0].created_by #=> String
resp.job_run_attempts[0].job_created_at #=> Time
resp.job_run_attempts[0].created_at #=> Time
resp.job_run_attempts[0].updated_at #=> Time
resp.job_run_attempts[0].execution_role #=> String
resp.job_run_attempts[0].state #=> String, one of "SUBMITTED", "PENDING", "SCHEDULED", "RUNNING", "SUCCESS", "FAILED", "CANCELLING", "CANCELLED", "QUEUED"
resp.job_run_attempts[0].state_details #=> String
resp.job_run_attempts[0].release_label #=> String
resp.job_run_attempts[0].type #=> String
resp.job_run_attempts[0].attempt #=> Integer
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 job runs.

  • :job_run_id (required, String) —

    The ID of the job run to list.

  • :next_token (String) —

    The token for the next set of job run attempt results.

  • :max_results (Integer) —

    The maximum number of job run attempts to list.

Returns:

See Also:



1263
1264
1265
1266
 
# File 'gems/aws-sdk-emrserverless/lib/aws-sdk-emrserverless/client.rb', line 1263

def list_job_run_attempts(params = {}, options = {})
  req = build_request(:list_job_run_attempts, 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, QUEUED
  mode: "BATCH", # accepts BATCH, STREAMING
})

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].mode #=> String, one of "BATCH", "STREAMING"
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", "QUEUED"
resp.job_runs[0].state_details #=> String
resp.job_runs[0].release_label #=> String
resp.job_runs[0].type #=> String
resp.job_runs[0].attempt #=> Integer
resp.job_runs[0].attempt_created_at #=> Time
resp.job_runs[0].attempt_updated_at #=> Time
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.

  • :mode (String) —

    The mode of the job runs to list.

Returns:

See Also:



1337
1338
1339
1340
 
# File 'gems/aws-sdk-emrserverless/lib/aws-sdk-emrserverless/client.rb', line 1337

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

#list_sessions(params = {}) ⇒ Types::ListSessionsResponse

Lists sessions for the specified application. You can filter sessions by state and creation time.

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

Examples:

Request syntax with placeholder values


resp = client.list_sessions({
  application_id: "ApplicationId", # required
  next_token: "NextToken",
  max_results: 1,
  states: ["SUBMITTED"], # accepts SUBMITTED, STARTING, STARTED, IDLE, BUSY, FAILED, TERMINATING, TERMINATED
  created_at_after: Time.now,
  created_at_before: Time.now,
})

Response structure


resp.sessions #=> Array
resp.sessions[0].application_id #=> String
resp.sessions[0].session_id #=> String
resp.sessions[0].arn #=> String
resp.sessions[0].name #=> String
resp.sessions[0].state #=> String, one of "SUBMITTED", "STARTING", "STARTED", "IDLE", "BUSY", "FAILED", "TERMINATING", "TERMINATED"
resp.sessions[0].state_details #=> String
resp.sessions[0].release_label #=> String
resp.sessions[0].execution_role_arn #=> String
resp.sessions[0].created_by #=> String
resp.sessions[0].created_at #=> Time
resp.sessions[0].updated_at #=> Time
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :application_id (required, String) —

    The ID of the application to list sessions for.

  • :next_token (String) —

    The token for the next set of session results.

  • :max_results (Integer) —

    The maximum number of sessions to return in each page of results.

  • :states (Array<String>) —

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

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

Returns:

See Also:



1403
1404
1405
1406
 
# File 'gems/aws-sdk-emrserverless/lib/aws-sdk-emrserverless/client.rb', line 1403

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



1434
1435
1436
1437
 
# File 'gems/aws-sdk-emrserverless/lib/aws-sdk-emrserverless/client.rb', line 1434

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:



1457
1458
1459
1460
 
# File 'gems/aws-sdk-emrserverless/lib/aws-sdk-emrserverless/client.rb', line 1457

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
  execution_iam_policy: {
    policy: "PolicyDocument",
    policy_arns: ["Arn"],
  },
  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: {
          "ConfigurationPropertyKey" => "ConfigurationPropertyValue",
        },
        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",
      },
      cloud_watch_logging_configuration: {
        enabled: false, # required
        log_group_name: "LogGroupName",
        log_stream_name_prefix: "LogStreamNamePrefix",
        encryption_key_arn: "EncryptionKeyArn",
        log_types: {
          "WorkerTypeString" => ["LogTypeString"],
        },
      },
      prometheus_monitoring_configuration: {
        remote_write_url: "PrometheusUrlString",
      },
    },
    disk_encryption_configuration: {
      encryption_context: {
        "EncryptionContextKey" => "EncryptionContextValue",
      },
      encryption_key_arn: "EncryptionKeyArn",
    },
  },
  tags: {
    "TagKey" => "TagValue",
  },
  execution_timeout_minutes: 1,
  name: "String256",
  mode: "BATCH", # accepts BATCH, STREAMING
  retry_policy: {
    max_attempts: 1,
    max_failed_attempts_per_hour: 1,
  },
})

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.

  • :execution_iam_policy (Types::JobRunExecutionIamPolicy) —

    You can pass an optional IAM policy. The resulting job IAM role permissions will be an intersection of this policy and the policy associated with your job execution role.

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

  • :mode (String) —

    The mode of the job run when it starts.

  • :retry_policy (Types::RetryPolicy) —

    The retry policy when job run starts.

Returns:

See Also:



1595
1596
1597
1598
 
# File 'gems/aws-sdk-emrserverless/lib/aws-sdk-emrserverless/client.rb', line 1595

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

#start_session(params = {}) ⇒ Types::StartSessionResponse

Creates and starts a new session on the specified application. The application must be in the STARTED state or have AutoStart enabled, and have interactive sessions enabled. This operation is supported for EMR release 7.13.0 and later.

Examples:

Request syntax with placeholder values


resp = client.start_session({
  application_id: "ApplicationId", # required
  client_token: "ClientToken", # required
  execution_role_arn: "IAMRoleArn", # required
  configuration_overrides: {
    runtime_configuration: [
      {
        classification: "String1024", # required
        properties: {
          "ConfigurationPropertyKey" => "ConfigurationPropertyValue",
        },
        configurations: {
          # recursive ConfigurationList
        },
      },
    ],
  },
  tags: {
    "TagKey" => "TagValue",
  },
  idle_timeout_minutes: 1,
  name: "String256",
})

Response structure


resp.application_id #=> String
resp.session_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 start the session.

  • :client_token (required, String) —

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you retry a request that completed successfully using the same client token, the server returns the successful response without performing the operation again.

    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 session. Amazon EMR Serverless uses this role to access Amazon Web Services resources on your behalf during session execution.

  • :configuration_overrides (Types::SessionConfigurationOverrides) —

    The configuration overrides for the session. Only runtime configuration overrides are supported.

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

    The tags to assign to the session.

  • :idle_timeout_minutes (Integer) —

    The idle timeout in minutes for the session. After the session remains idle for this duration, Amazon EMR Serverless automatically terminates it.

  • :name (String) —

    The optional name for the session.

Returns:

See Also:



1679
1680
1681
1682
 
# File 'gems/aws-sdk-emrserverless/lib/aws-sdk-emrserverless/client.rb', line 1679

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



1703
1704
1705
1706
 
# File 'gems/aws-sdk-emrserverless/lib/aws-sdk-emrserverless/client.rb', line 1703

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

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:



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

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

#terminate_session(params = {}) ⇒ Types::TerminateSessionResponse

Terminates the specified session. After you terminate a session, it enters the TERMINATING state and then the TERMINATED state. You can still access the Spark History Server for a terminated session through the GetResourceDashboard operation.

Examples:

Request syntax with placeholder values


resp = client.terminate_session({
  application_id: "ApplicationId", # required
  session_id: "SessionId", # required
})

Response structure


resp.application_id #=> String
resp.session_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :application_id (required, String) —

    The ID of the application that the session belongs to.

  • :session_id (required, String) —

    The ID of the session to terminate.

Returns:

See Also:



1776
1777
1778
1779
 
# File 'gems/aws-sdk-emrserverless/lib/aws-sdk-emrserverless/client.rb', line 1776

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



1804
1805
1806
1807
 
# File 'gems/aws-sdk-emrserverless/lib/aws-sdk-emrserverless/client.rb', line 1804

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",
        disk_type: "DiskType",
      },
    },
  },
  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",
      },
    },
  },
  interactive_configuration: {
    studio_enabled: false,
    livy_endpoint_enabled: false,
    session_enabled: false,
  },
  release_label: "ReleaseLabel",
  runtime_configuration: [
    {
      classification: "String1024", # required
      properties: {
        "ConfigurationPropertyKey" => "ConfigurationPropertyValue",
      },
      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",
    },
    cloud_watch_logging_configuration: {
      enabled: false, # required
      log_group_name: "LogGroupName",
      log_stream_name_prefix: "LogStreamNamePrefix",
      encryption_key_arn: "EncryptionKeyArn",
      log_types: {
        "WorkerTypeString" => ["LogTypeString"],
      },
    },
    prometheus_monitoring_configuration: {
      remote_write_url: "PrometheusUrlString",
    },
  },
  disk_encryption_configuration: {
    encryption_context: {
      "EncryptionContextKey" => "EncryptionContextValue",
    },
    encryption_key_arn: "EncryptionKeyArn",
  },
  scheduler_configuration: {
    queue_timeout_minutes: 1,
    max_concurrent_runs: 1,
  },
  identity_center_configuration: {
    identity_center_instance_arn: "IdentityCenterInstanceArn",
    user_background_sessions_enabled: false,
  },
  job_level_cost_allocation_configuration: {
    enabled: false,
  },
})

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.initial_capacity["WorkerTypeString"].worker_configuration.disk_type #=> 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
resp.application.runtime_configuration #=> Array
resp.application.runtime_configuration[0].classification #=> String
resp.application.runtime_configuration[0].properties #=> Hash
resp.application.runtime_configuration[0].properties["ConfigurationPropertyKey"] #=> String
resp.application.runtime_configuration[0].configurations #=> Types::ConfigurationList
resp.application.monitoring_configuration.s3_monitoring_configuration.log_uri #=> String
resp.application.monitoring_configuration.s3_monitoring_configuration.encryption_key_arn #=> String
resp.application.monitoring_configuration.managed_persistence_monitoring_configuration.enabled #=> Boolean
resp.application.monitoring_configuration.managed_persistence_monitoring_configuration.encryption_key_arn #=> String
resp.application.monitoring_configuration.cloud_watch_logging_configuration.enabled #=> Boolean
resp.application.monitoring_configuration.cloud_watch_logging_configuration.log_group_name #=> String
resp.application.monitoring_configuration.cloud_watch_logging_configuration.log_stream_name_prefix #=> String
resp.application.monitoring_configuration.cloud_watch_logging_configuration.encryption_key_arn #=> String
resp.application.monitoring_configuration.cloud_watch_logging_configuration.log_types #=> Hash
resp.application.monitoring_configuration.cloud_watch_logging_configuration.log_types["WorkerTypeString"] #=> Array
resp.application.monitoring_configuration.cloud_watch_logging_configuration.log_types["WorkerTypeString"][0] #=> String
resp.application.monitoring_configuration.prometheus_monitoring_configuration.remote_write_url #=> String
resp.application.disk_encryption_configuration.encryption_context #=> Hash
resp.application.disk_encryption_configuration.encryption_context["EncryptionContextKey"] #=> String
resp.application.disk_encryption_configuration.encryption_key_arn #=> String
resp.application.interactive_configuration.studio_enabled #=> Boolean
resp.application.interactive_configuration.livy_endpoint_enabled #=> Boolean
resp.application.interactive_configuration.session_enabled #=> Boolean
resp.application.scheduler_configuration.queue_timeout_minutes #=> Integer
resp.application.scheduler_configuration.max_concurrent_runs #=> Integer
resp.application.identity_center_configuration.identity_center_instance_arn #=> String
resp.application.identity_center_configuration.identity_center_application_arn #=> String
resp.application.identity_center_configuration.user_background_sessions_enabled #=> Boolean
resp.application.job_level_cost_allocation_configuration.enabled #=> Boolean

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.

  • :interactive_configuration (Types::InteractiveConfiguration) —

    The interactive configuration object that contains new interactive use cases when the application is updated.

  • :release_label (String) —

    The Amazon EMR release label for the application. You can change the release label to use a different release of Amazon EMR.

  • :runtime_configuration (Array<Types::Configuration>) —

    The Configuration specifications to use when updating an application. Each configuration consists of a classification and properties. This configuration is applied across all the job runs submitted under the application.

  • :monitoring_configuration (Types::MonitoringConfiguration) —

    The configuration setting for monitoring.

  • :disk_encryption_configuration (Types::DiskEncryptionConfiguration) —

    The configuration object that allows encrypting local disks.

  • :scheduler_configuration (Types::SchedulerConfiguration) —

    The scheduler configuration for batch and streaming jobs running on this application. Supported with release labels emr-7.0.0 and above.

  • :identity_center_configuration (Types::IdentityCenterConfigurationInput) —

    Specifies the IAM Identity Center configuration used to enable or disable trusted identity propagation. When provided, this configuration determines how the application interacts with IAM Identity Center for user authentication and access control.

  • :job_level_cost_allocation_configuration (Types::JobLevelCostAllocationConfiguration) —

    The configuration object that enables job level cost allocation.

Returns:

See Also:



2070
2071
2072
2073
 
# File 'gems/aws-sdk-emrserverless/lib/aws-sdk-emrserverless/client.rb', line 2070

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