# frozen_string_literal: true # WARNING ABOUT GENERATED CODE # # This file is generated. See the contributing guide for more information: # https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md # # WARNING ABOUT GENERATED CODE require 'seahorse/client/plugins/content_length.rb' require 'aws-sdk-core/plugins/credentials_configuration.rb' require 'aws-sdk-core/plugins/logging.rb' require 'aws-sdk-core/plugins/param_converter.rb' require 'aws-sdk-core/plugins/param_validator.rb' require 'aws-sdk-core/plugins/user_agent.rb' require 'aws-sdk-core/plugins/helpful_socket_errors.rb' require 'aws-sdk-core/plugins/retry_errors.rb' require 'aws-sdk-core/plugins/global_configuration.rb' require 'aws-sdk-core/plugins/regional_endpoint.rb' require 'aws-sdk-core/plugins/endpoint_discovery.rb' require 'aws-sdk-core/plugins/endpoint_pattern.rb' require 'aws-sdk-core/plugins/response_paging.rb' require 'aws-sdk-core/plugins/stub_responses.rb' require 'aws-sdk-core/plugins/idempotency_token.rb' require 'aws-sdk-core/plugins/jsonvalue_converter.rb' require 'aws-sdk-core/plugins/client_metrics_plugin.rb' require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb' require 'aws-sdk-core/plugins/transfer_encoding.rb' require 'aws-sdk-core/plugins/http_checksum.rb' require 'aws-sdk-core/plugins/checksum_algorithm.rb' require 'aws-sdk-core/plugins/defaults_mode.rb' require 'aws-sdk-core/plugins/recursion_detection.rb' require 'aws-sdk-core/plugins/sign.rb' require 'aws-sdk-core/plugins/protocols/rest_json.rb' Aws::Plugins::GlobalConfiguration.add_identifier(:emrserverless) module Aws::EMRServerless # 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](/sdk-for-ruby/v3/developer-guide/setup-config.html). # # See {#initialize} for a full list of supported configuration options. class Client < Seahorse::Client::Base include Aws::ClientStubs @identifier = :emrserverless set_api(ClientApi::API) add_plugin(Seahorse::Client::Plugins::ContentLength) add_plugin(Aws::Plugins::CredentialsConfiguration) add_plugin(Aws::Plugins::Logging) add_plugin(Aws::Plugins::ParamConverter) add_plugin(Aws::Plugins::ParamValidator) add_plugin(Aws::Plugins::UserAgent) add_plugin(Aws::Plugins::HelpfulSocketErrors) add_plugin(Aws::Plugins::RetryErrors) add_plugin(Aws::Plugins::GlobalConfiguration) add_plugin(Aws::Plugins::RegionalEndpoint) add_plugin(Aws::Plugins::EndpointDiscovery) add_plugin(Aws::Plugins::EndpointPattern) add_plugin(Aws::Plugins::ResponsePaging) add_plugin(Aws::Plugins::StubResponses) add_plugin(Aws::Plugins::IdempotencyToken) add_plugin(Aws::Plugins::JsonvalueConverter) add_plugin(Aws::Plugins::ClientMetricsPlugin) add_plugin(Aws::Plugins::ClientMetricsSendPlugin) add_plugin(Aws::Plugins::TransferEncoding) add_plugin(Aws::Plugins::HttpChecksum) add_plugin(Aws::Plugins::ChecksumAlgorithm) add_plugin(Aws::Plugins::DefaultsMode) add_plugin(Aws::Plugins::RecursionDetection) add_plugin(Aws::Plugins::Sign) add_plugin(Aws::Plugins::Protocols::RestJson) add_plugin(Aws::EMRServerless::Plugins::Endpoints) # @overload initialize(options) # @param [Hash] options # @option options [required, Aws::CredentialProvider] :credentials # 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. # # @option options [required, String] :region # 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` # # @option options [String] :access_key_id # # @option options [Boolean] :active_endpoint_cache (false) # When set to `true`, a thread polling for endpoints will be running in # the background every 60 secs (default). Defaults to `false`. # # @option options [Boolean] :adaptive_retry_wait_to_fill (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. # # @option options [Boolean] :client_side_monitoring (false) # When `true`, client-side metrics will be collected for all API requests from # this client. # # @option options [String] :client_side_monitoring_client_id ("") # Allows you to provide an identifier for this client which will be attached to # all generated client side metrics. Defaults to an empty string. # # @option options [String] :client_side_monitoring_host ("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. # # @option options [Integer] :client_side_monitoring_port (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. # # @option options [Aws::ClientSideMonitoring::Publisher] :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher) # Allows you to provide a custom client-side monitoring publisher class. By default, # will use the Client Side Monitoring Agent Publisher. # # @option options [Boolean] :convert_params (true) # When `true`, an attempt is made to coerce request parameters into # the required types. # # @option options [Boolean] :correct_clock_skew (true) # Used only in `standard` and adaptive retry modes. Specifies whether to apply # a clock skew correction and retry requests with skewed client clocks. # # @option options [String] :defaults_mode ("legacy") # See {Aws::DefaultsModeConfiguration} for a list of the # accepted modes and the configuration defaults that are included. # # @option options [Boolean] :disable_host_prefix_injection (false) # Set to true to disable SDK automatically adding host prefix # to default service endpoint when available. # # @option options [String] :endpoint # 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. # # @option options [Integer] :endpoint_cache_max_entries (1000) # Used for the maximum size limit of the LRU cache storing endpoints data # for endpoint discovery enabled operations. Defaults to 1000. # # @option options [Integer] :endpoint_cache_max_threads (10) # Used for the maximum threads in use for polling endpoints to be cached, defaults to 10. # # @option options [Integer] :endpoint_cache_poll_interval (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. # # @option options [Boolean] :endpoint_discovery (false) # When set to `true`, endpoint discovery will be enabled for operations when available. # # @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default) # The log formatter. # # @option options [Symbol] :log_level (:info) # The log level to send messages to the `:logger` at. # # @option options [Logger] :logger # The Logger instance to send log messages to. If this option # is not set, logging will be disabled. # # @option options [Integer] :max_attempts (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. # # @option options [String] :profile ("default") # Used when loading credentials from the shared credentials file # at HOME/.aws/credentials. When not specified, 'default' is used. # # @option options [Proc] :retry_backoff # A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay. # This option is only used in the `legacy` retry mode. # # @option options [Float] :retry_base_delay (0.3) # The base delay in seconds used by the default backoff function. This option # is only used in the `legacy` retry mode. # # @option options [Symbol] :retry_jitter (: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 # # @option options [Integer] :retry_limit (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. # # @option options [Integer] :retry_max_delay (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. # # @option options [String] :retry_mode ("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. # # # @option options [String] :secret_access_key # # @option options [String] :session_token # # @option options [Boolean] :stub_responses (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. # # @option options [Aws::TokenProvider] :token_provider # 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. # # @option options [Boolean] :use_dualstack_endpoint # When set to `true`, dualstack enabled endpoints (with `.aws` TLD) # will be used if available. # # @option options [Boolean] :use_fips_endpoint # 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`. # # @option options [Boolean] :validate_params (true) # When `true`, request parameters are validated before # sending the request. # # @option options [Aws::EMRServerless::EndpointProvider] :endpoint_provider # 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` # # @option options [URI::HTTP,String] :http_proxy A proxy to send # requests through. Formatted like 'http://proxy.com:123'. # # @option options [Float] :http_open_timeout (15) The number of # seconds to wait when opening a HTTP session before raising a # `Timeout::Error`. # # @option options [Float] :http_read_timeout (60) The default # number of seconds to wait for response data. This value can # safely be set per-request on the session. # # @option options [Float] :http_idle_timeout (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. # # @option options [Float] :http_continue_timeout (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. # # @option options [Float] :ssl_timeout (nil) Sets the SSL timeout # in seconds. # # @option options [Boolean] :http_wire_trace (false) When `true`, # HTTP debug output will be sent to the `:logger`. # # @option options [Boolean] :ssl_verify_peer (true) When `true`, # SSL peer certificates are verified when establishing a # connection. # # @option options [String] :ssl_ca_bundle 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. # # @option options [String] :ssl_ca_directory 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. # def initialize(*args) super end # @!group API Operations # Cancels a job run. # # @option params [required, String] :application_id # The ID of the application on which the job run will be canceled. # # @option params [required, String] :job_run_id # The ID of the job run to cancel. # # @return [Types::CancelJobRunResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::CancelJobRunResponse#application_id #application_id} => String # * {Types::CancelJobRunResponse#job_run_id #job_run_id} => String # # @example Request syntax with placeholder values # # resp = client.cancel_job_run({ # application_id: "ApplicationId", # required # job_run_id: "JobRunId", # required # }) # # @example Response structure # # resp.application_id #=> String # resp.job_run_id #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/emr-serverless-2021-07-13/CancelJobRun AWS API Documentation # # @overload cancel_job_run(params = {}) # @param [Hash] params ({}) def cancel_job_run(params = {}, options = {}) req = build_request(:cancel_job_run, params) req.send_request(options) end # Creates an application. # # @option params [String] :name # The name of the application. # # @option params [required, String] :release_label # The EMR release associated with the application. # # @option params [required, String] :type # The type of application you want to start, such as Spark or Hive. # # @option params [required, String] :client_token # 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.** # # @option params [Hash] :initial_capacity # The capacity to initialize when the application is created. # # @option params [Types::MaximumAllowedResources] :maximum_capacity # 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. # # @option params [Hash] :tags # The tags assigned to the application. # # @option params [Types::AutoStartConfig] :auto_start_configuration # The configuration for an application to automatically start on job # submission. # # @option params [Types::AutoStopConfig] :auto_stop_configuration # The configuration for an application to automatically stop after a # certain amount of time being idle. # # @option params [Types::NetworkConfiguration] :network_configuration # The network configuration for customer VPC connectivity. # # @option params [String] :architecture # The CPU architecture of an application. # # @option params [Types::ImageConfigurationInput] :image_configuration # The image configuration for all worker types. You can either set this # parameter or `imageConfiguration` for each worker type in # `workerTypeSpecifications`. # # @option params [Hash] :worker_type_specifications # 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. # # @return [Types::CreateApplicationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::CreateApplicationResponse#application_id #application_id} => String # * {Types::CreateApplicationResponse#name #name} => String # * {Types::CreateApplicationResponse#arn #arn} => String # # @example 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", # }, # }, # }, # }) # # @example Response structure # # resp.application_id #=> String # resp.name #=> String # resp.arn #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/emr-serverless-2021-07-13/CreateApplication AWS API Documentation # # @overload create_application(params = {}) # @param [Hash] params ({}) def create_application(params = {}, options = {}) req = build_request(:create_application, params) req.send_request(options) end # Deletes an application. An application has to be in a stopped or # created state in order to be deleted. # # @option params [required, String] :application_id # The ID of the application that will be deleted. # # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # # @example Request syntax with placeholder values # # resp = client.delete_application({ # application_id: "ApplicationId", # required # }) # # @see http://docs.aws.amazon.com/goto/WebAPI/emr-serverless-2021-07-13/DeleteApplication AWS API Documentation # # @overload delete_application(params = {}) # @param [Hash] params ({}) def delete_application(params = {}, options = {}) req = build_request(:delete_application, params) req.send_request(options) end # Displays detailed information about a specified application. # # @option params [required, String] :application_id # The ID of the application that will be described. # # @return [Types::GetApplicationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::GetApplicationResponse#application #application} => Types::Application # # @example Request syntax with placeholder values # # resp = client.get_application({ # application_id: "ApplicationId", # required # }) # # @example 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 # # @see http://docs.aws.amazon.com/goto/WebAPI/emr-serverless-2021-07-13/GetApplication AWS API Documentation # # @overload get_application(params = {}) # @param [Hash] params ({}) def get_application(params = {}, options = {}) req = build_request(:get_application, params) req.send_request(options) end # Returns a URL to access the job run dashboard. # # @option params [required, String] :application_id # The ID of the application. # # @option params [required, String] :job_run_id # The ID of the job run. # # @return [Types::GetDashboardForJobRunResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::GetDashboardForJobRunResponse#url #url} => String # # @example Request syntax with placeholder values # # resp = client.get_dashboard_for_job_run({ # application_id: "ApplicationId", # required # job_run_id: "JobRunId", # required # }) # # @example Response structure # # resp.url #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/emr-serverless-2021-07-13/GetDashboardForJobRun AWS API Documentation # # @overload get_dashboard_for_job_run(params = {}) # @param [Hash] params ({}) def get_dashboard_for_job_run(params = {}, options = {}) req = build_request(:get_dashboard_for_job_run, params) req.send_request(options) end # Displays detailed information about a job run. # # @option params [required, String] :application_id # The ID of the application on which the job run is submitted. # # @option params [required, String] :job_run_id # The ID of the job run. # # @return [Types::GetJobRunResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::GetJobRunResponse#job_run #job_run} => Types::JobRun # # @example Request syntax with placeholder values # # resp = client.get_job_run({ # application_id: "ApplicationId", # required # job_run_id: "JobRunId", # required # }) # # @example 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 # # @see http://docs.aws.amazon.com/goto/WebAPI/emr-serverless-2021-07-13/GetJobRun AWS API Documentation # # @overload get_job_run(params = {}) # @param [Hash] params ({}) def get_job_run(params = {}, options = {}) req = build_request(:get_job_run, params) req.send_request(options) end # Lists applications based on a set of parameters. # # @option params [String] :next_token # The token for the next set of application results. # # @option params [Integer] :max_results # The maximum number of applications that can be listed. # # @option params [Array] :states # An optional filter for application states. Note that if this filter # contains multiple states, the resulting list will be grouped by the # state. # # @return [Types::ListApplicationsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::ListApplicationsResponse#applications #applications} => Array<Types::ApplicationSummary> # * {Types::ListApplicationsResponse#next_token #next_token} => String # # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}. # # @example 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 # }) # # @example 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 # # @see http://docs.aws.amazon.com/goto/WebAPI/emr-serverless-2021-07-13/ListApplications AWS API Documentation # # @overload list_applications(params = {}) # @param [Hash] params ({}) def list_applications(params = {}, options = {}) req = build_request(:list_applications, params) req.send_request(options) end # Lists job runs based on a set of parameters. # # @option params [required, String] :application_id # The ID of the application for which to list the job run. # # @option params [String] :next_token # The token for the next set of job run results. # # @option params [Integer] :max_results # The maximum number of job runs that can be listed. # # @option params [Time,DateTime,Date,Integer,String] :created_at_after # The lower bound of the option to filter by creation date and time. # # @option params [Time,DateTime,Date,Integer,String] :created_at_before # The upper bound of the option to filter by creation date and time. # # @option params [Array] :states # An optional filter for job run states. Note that if this filter # contains multiple states, the resulting list will be grouped by the # state. # # @return [Types::ListJobRunsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::ListJobRunsResponse#job_runs #job_runs} => Array<Types::JobRunSummary> # * {Types::ListJobRunsResponse#next_token #next_token} => String # # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}. # # @example 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 # }) # # @example 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 # # @see http://docs.aws.amazon.com/goto/WebAPI/emr-serverless-2021-07-13/ListJobRuns AWS API Documentation # # @overload list_job_runs(params = {}) # @param [Hash] params ({}) def list_job_runs(params = {}, options = {}) req = build_request(:list_job_runs, params) req.send_request(options) end # Lists the tags assigned to the resources. # # @option params [required, String] :resource_arn # 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. # # @return [Types::ListTagsForResourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::ListTagsForResourceResponse#tags #tags} => Hash<String,String> # # @example Request syntax with placeholder values # # resp = client.list_tags_for_resource({ # resource_arn: "ResourceArn", # required # }) # # @example Response structure # # resp.tags #=> Hash # resp.tags["TagKey"] #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/emr-serverless-2021-07-13/ListTagsForResource AWS API Documentation # # @overload list_tags_for_resource(params = {}) # @param [Hash] params ({}) def list_tags_for_resource(params = {}, options = {}) req = build_request(:list_tags_for_resource, params) req.send_request(options) end # Starts a specified application and initializes initial capacity if # configured. # # @option params [required, String] :application_id # The ID of the application to start. # # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # # @example Request syntax with placeholder values # # resp = client.start_application({ # application_id: "ApplicationId", # required # }) # # @see http://docs.aws.amazon.com/goto/WebAPI/emr-serverless-2021-07-13/StartApplication AWS API Documentation # # @overload start_application(params = {}) # @param [Hash] params ({}) def start_application(params = {}, options = {}) req = build_request(:start_application, params) req.send_request(options) end # Starts a job run. # # @option params [required, String] :application_id # The ID of the application on which to run the job. # # @option params [required, String] :client_token # 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.** # # @option params [required, String] :execution_role_arn # The execution role ARN for the job run. # # @option params [Types::JobDriver] :job_driver # The job driver for the job run. # # @option params [Types::ConfigurationOverrides] :configuration_overrides # The configuration overrides for the job run. # # @option params [Hash] :tags # The tags assigned to the job run. # # @option params [Integer] :execution_timeout_minutes # The maximum duration for the job run to run. If the job run runs # beyond this duration, it will be automatically cancelled. # # @option params [String] :name # The optional job run name. This doesn't have to be unique. # # @return [Types::StartJobRunResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::StartJobRunResponse#application_id #application_id} => String # * {Types::StartJobRunResponse#job_run_id #job_run_id} => String # * {Types::StartJobRunResponse#arn #arn} => String # # @example 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", # }) # # @example Response structure # # resp.application_id #=> String # resp.job_run_id #=> String # resp.arn #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/emr-serverless-2021-07-13/StartJobRun AWS API Documentation # # @overload start_job_run(params = {}) # @param [Hash] params ({}) def start_job_run(params = {}, options = {}) req = build_request(:start_job_run, params) req.send_request(options) end # Stops a specified application and releases initial capacity if # configured. All scheduled and running jobs must be completed or # cancelled before stopping an application. # # @option params [required, String] :application_id # The ID of the application to stop. # # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # # @example Request syntax with placeholder values # # resp = client.stop_application({ # application_id: "ApplicationId", # required # }) # # @see http://docs.aws.amazon.com/goto/WebAPI/emr-serverless-2021-07-13/StopApplication AWS API Documentation # # @overload stop_application(params = {}) # @param [Hash] params ({}) def stop_application(params = {}, options = {}) req = build_request(:stop_application, params) req.send_request(options) end # 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. # # @option params [required, String] :resource_arn # 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. # # @option params [required, Hash] :tags # The tags to add to the resource. A tag is an array of key-value pairs. # # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # # @example Request syntax with placeholder values # # resp = client.tag_resource({ # resource_arn: "ResourceArn", # required # tags: { # required # "TagKey" => "TagValue", # }, # }) # # @see http://docs.aws.amazon.com/goto/WebAPI/emr-serverless-2021-07-13/TagResource AWS API Documentation # # @overload tag_resource(params = {}) # @param [Hash] params ({}) def tag_resource(params = {}, options = {}) req = build_request(:tag_resource, params) req.send_request(options) end # Removes tags from resources. # # @option params [required, String] :resource_arn # 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. # # @option params [required, Array] :tag_keys # The keys of the tags to be removed. # # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # # @example Request syntax with placeholder values # # resp = client.untag_resource({ # resource_arn: "ResourceArn", # required # tag_keys: ["TagKey"], # required # }) # # @see http://docs.aws.amazon.com/goto/WebAPI/emr-serverless-2021-07-13/UntagResource AWS API Documentation # # @overload untag_resource(params = {}) # @param [Hash] params ({}) def untag_resource(params = {}, options = {}) req = build_request(:untag_resource, params) req.send_request(options) end # Updates a specified application. An application has to be in a stopped # or created state in order to be updated. # # @option params [required, String] :application_id # The ID of the application to update. # # @option params [required, String] :client_token # 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.** # # @option params [Hash] :initial_capacity # The capacity to initialize when the application is updated. # # @option params [Types::MaximumAllowedResources] :maximum_capacity # 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. # # @option params [Types::AutoStartConfig] :auto_start_configuration # The configuration for an application to automatically start on job # submission. # # @option params [Types::AutoStopConfig] :auto_stop_configuration # The configuration for an application to automatically stop after a # certain amount of time being idle. # # @option params [Types::NetworkConfiguration] :network_configuration # The network configuration for customer VPC connectivity. # # @option params [String] :architecture # The CPU architecture of an application. # # @option params [Types::ImageConfigurationInput] :image_configuration # The image configuration to be used for all worker types. You can # either set this parameter or `imageConfiguration` for each worker type # in `WorkerTypeSpecificationInput`. # # @option params [Hash] :worker_type_specifications # 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. # # @return [Types::UpdateApplicationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::UpdateApplicationResponse#application #application} => Types::Application # # @example 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", # }, # }, # }, # }) # # @example 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 # # @see http://docs.aws.amazon.com/goto/WebAPI/emr-serverless-2021-07-13/UpdateApplication AWS API Documentation # # @overload update_application(params = {}) # @param [Hash] params ({}) def update_application(params = {}, options = {}) req = build_request(:update_application, params) req.send_request(options) end # @!endgroup # @param params ({}) # @api private def build_request(operation_name, params = {}) handlers = @handlers.for(operation_name) context = Seahorse::Client::RequestContext.new( operation_name: operation_name, operation: config.api.operation(operation_name), client: self, params: params, config: config) context[:gem_name] = 'aws-sdk-emrserverless' context[:gem_version] = '1.4.0' Seahorse::Client::Request.new(handlers, context) end # @api private # @deprecated def waiter_names [] end class << self # @api private attr_reader :identifier # @api private def errors_module Errors end end end end