You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::EMR::Client

Inherits:
Seahorse::Client::Base show all
Defined in:
(unknown)

Overview

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

emr = Aws::EMR::Client.new(
  region: region_name,
  credentials: credentials,
  # ...
)

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

Region

You can configure a default region in the following locations:

  • ENV['AWS_REGION']
  • Aws.config[:region]

Go here for a list of supported regions.

Credentials

Default credentials are loaded automatically from the following locations:

  • ENV['AWS_ACCESS_KEY_ID'] and ENV['AWS_SECRET_ACCESS_KEY']
  • Aws.config[:credentials]
  • The shared credentials ini file at ~/.aws/credentials (more information)
  • From an instance profile when running on EC2

You can also construct a credentials object from one of the following classes:

Alternatively, you configure credentials with :access_key_id and :secret_access_key:

# load credentials from disk
creds = YAML.load(File.read('/path/to/secrets'))

Aws::EMR::Client.new(
  access_key_id: creds['access_key_id'],
  secret_access_key: creds['secret_access_key']
)

Always load your credentials from outside your application. Avoid configuring credentials statically and never commit them to source control.

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

#config, #handlers

Constructor collapse

API Operations collapse

Instance Method Summary collapse

Methods inherited from Seahorse::Client::Base

add_plugin, api, #build_request, clear_plugins, define, new, #operation, #operation_names, plugins, remove_plugin, set_api, set_plugins

Methods included from Seahorse::Client::HandlerBuilder

#handle, #handle_request, #handle_response

Constructor Details

#initialize(options = {}) ⇒ Aws::EMR::Client

Constructs an API client.

Options Hash (options):

  • :access_key_id (String)

    Used to set credentials statically. See Plugins::RequestSigner for more details.

  • :active_endpoint_cache (Boolean)

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

  • :convert_params (Boolean) — default: true

    When true, an attempt is made to coerce request parameters into the required types. See Plugins::ParamConverter for more details.

  • :credentials (required, Credentials)

    Your AWS credentials. The following locations will be searched in order for credentials:

    • :access_key_id, :secret_access_key, and :session_token options
    • ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
    • HOME/.aws/credentials shared credentials file
    • EC2 instance profile credentials See Plugins::RequestSigner for more details.
  • :disable_host_prefix_injection (Boolean)

    Set to true to disable SDK automatically adding host prefix to default service endpoint when available. See Plugins::EndpointPattern for more details.

  • :endpoint (String)

    A default endpoint is constructed from the :region. See Plugins::RegionalEndpoint for more details.

  • :endpoint_cache_max_entries (Integer)

    Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000. See Plugins::EndpointDiscovery for more details.

  • :endpoint_cache_max_threads (Integer)

    Used for the maximum threads in use for polling endpoints to be cached, defaults to 10. See Plugins::EndpointDiscovery for more details.

  • :endpoint_cache_poll_interval (Integer)

    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. See Plugins::EndpointDiscovery for more details.

  • :endpoint_discovery (Boolean)

    When set to true, endpoint discovery will be enabled for operations when available. Defaults to false. See Plugins::EndpointDiscovery for more details.

  • :http_continue_timeout (Float) — default: 1

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :http_idle_timeout (Integer) — default: 5

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :http_open_timeout (Integer) — default: 15

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :http_proxy (String)

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :http_read_timeout (Integer) — default: 60

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :http_wire_trace (Boolean) — default: false

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :log_level (Symbol) — default: :info

    The log level to send messages to the logger at. See Plugins::Logging for more details.

  • :log_formatter (Logging::LogFormatter)

    The log formatter. Defaults to Seahorse::Client::Logging::Formatter.default. See Plugins::Logging for more details.

  • :logger (Logger) — default: nil

    The Logger instance to send log messages to. If this option is not set, logging will be disabled. See Plugins::Logging for more details.

  • :profile (String)

    Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, 'default' is used. See Plugins::RequestSigner for more details.

  • :raise_response_errors (Boolean) — default: true

    When true, response errors are raised. See Seahorse::Client::Plugins::RaiseResponseErrors for more details.

  • :region (required, String)

    The AWS region to connect to. The region is used to construct the client endpoint. Defaults to ENV['AWS_REGION']. Also checks AMAZON_REGION and AWS_DEFAULT_REGION. See Plugins::RegionalEndpoint for more details.

  • :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 and auth errors from expired credentials. See Plugins::RetryErrors for more details.

  • :secret_access_key (String)

    Used to set credentials statically. See Plugins::RequestSigner for more details.

  • :session_token (String)

    Used to set credentials statically. See Plugins::RequestSigner for more details.

  • :simple_json (Boolean) — default: false

    Disables request parameter conversion, validation, and formatting. Also disable response data type conversions. This option is useful when you want to ensure the highest level of performance by avoiding overhead of walking request parameters and response data structures.

    When :simple_json is enabled, the request parameters hash must be formatted exactly as the DynamoDB API expects. See Plugins::Protocols::JsonRpc for more details.

  • :ssl_ca_bundle (String)

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :ssl_ca_directory (String)

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :ssl_ca_store (String)

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :ssl_verify_peer (Boolean) — default: true

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :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. See Plugins::StubResponses for more details.

  • :validate_params (Boolean) — default: true

    When true, request parameters are validated before sending the request. See Plugins::ParamValidator for more details.

Instance Method Details

#add_instance_fleet(options = {}) ⇒ Types::AddInstanceFleetOutput

Adds an instance fleet to a running cluster.

The instance fleet configuration is available only in Amazon EMR versions 4.8.0 and later, excluding 5.0.x.

Examples:

Request syntax with placeholder values


resp = client.add_instance_fleet({
  cluster_id: "XmlStringMaxLen256", # required
  instance_fleet: { # required
    name: "XmlStringMaxLen256",
    instance_fleet_type: "MASTER", # required, accepts MASTER, CORE, TASK
    target_on_demand_capacity: 1,
    target_spot_capacity: 1,
    instance_type_configs: [
      {
        instance_type: "InstanceType", # required
        weighted_capacity: 1,
        bid_price: "XmlStringMaxLen256",
        bid_price_as_percentage_of_on_demand_price: 1.0,
        ebs_configuration: {
          ebs_block_device_configs: [
            {
              volume_specification: { # required
                volume_type: "String", # required
                iops: 1,
                size_in_gb: 1, # required
              },
              volumes_per_instance: 1,
            },
          ],
          ebs_optimized: false,
        },
        configurations: [
          {
            classification: "String",
            configurations: {
              # recursive ConfigurationList
            },
            properties: {
              "String" => "String",
            },
          },
        ],
      },
    ],
    launch_specifications: {
      spot_specification: {
        timeout_duration_minutes: 1, # required
        timeout_action: "SWITCH_TO_ON_DEMAND", # required, accepts SWITCH_TO_ON_DEMAND, TERMINATE_CLUSTER
        block_duration_minutes: 1,
        allocation_strategy: "capacity-optimized", # accepts capacity-optimized
      },
      on_demand_specification: {
        allocation_strategy: "lowest-price", # required, accepts lowest-price
      },
    },
  },
})

Response structure


resp.cluster_id #=> String
resp.instance_fleet_id #=> String
resp.cluster_arn #=> String

Options Hash (options):

  • :cluster_id (required, String)

    The unique identifier of the cluster.

  • :instance_fleet (required, Types::InstanceFleetConfig)

    Specifies the configuration of the instance fleet.

Returns:

See Also:

#add_instance_groups(options = {}) ⇒ Types::AddInstanceGroupsOutput

Adds one or more instance groups to a running cluster.

Examples:

Request syntax with placeholder values


resp = client.add_instance_groups({
  instance_groups: [ # required
    {
      name: "XmlStringMaxLen256",
      market: "ON_DEMAND", # accepts ON_DEMAND, SPOT
      instance_role: "MASTER", # required, accepts MASTER, CORE, TASK
      bid_price: "XmlStringMaxLen256",
      instance_type: "InstanceType", # required
      instance_count: 1, # required
      configurations: [
        {
          classification: "String",
          configurations: {
            # recursive ConfigurationList
          },
          properties: {
            "String" => "String",
          },
        },
      ],
      ebs_configuration: {
        ebs_block_device_configs: [
          {
            volume_specification: { # required
              volume_type: "String", # required
              iops: 1,
              size_in_gb: 1, # required
            },
            volumes_per_instance: 1,
          },
        ],
        ebs_optimized: false,
      },
      auto_scaling_policy: {
        constraints: { # required
          min_capacity: 1, # required
          max_capacity: 1, # required
        },
        rules: [ # required
          {
            name: "String", # required
            description: "String",
            action: { # required
              market: "ON_DEMAND", # accepts ON_DEMAND, SPOT
              simple_scaling_policy_configuration: { # required
                adjustment_type: "CHANGE_IN_CAPACITY", # accepts CHANGE_IN_CAPACITY, PERCENT_CHANGE_IN_CAPACITY, EXACT_CAPACITY
                scaling_adjustment: 1, # required
                cool_down: 1,
              },
            },
            trigger: { # required
              cloud_watch_alarm_definition: { # required
                comparison_operator: "GREATER_THAN_OR_EQUAL", # required, accepts GREATER_THAN_OR_EQUAL, GREATER_THAN, LESS_THAN, LESS_THAN_OR_EQUAL
                evaluation_periods: 1,
                metric_name: "String", # required
                namespace: "String",
                period: 1, # required
                statistic: "SAMPLE_COUNT", # accepts SAMPLE_COUNT, AVERAGE, SUM, MINIMUM, MAXIMUM
                threshold: 1.0, # required
                unit: "NONE", # accepts NONE, SECONDS, MICRO_SECONDS, MILLI_SECONDS, BYTES, KILO_BYTES, MEGA_BYTES, GIGA_BYTES, TERA_BYTES, BITS, KILO_BITS, MEGA_BITS, GIGA_BITS, TERA_BITS, PERCENT, COUNT, BYTES_PER_SECOND, KILO_BYTES_PER_SECOND, MEGA_BYTES_PER_SECOND, GIGA_BYTES_PER_SECOND, TERA_BYTES_PER_SECOND, BITS_PER_SECOND, KILO_BITS_PER_SECOND, MEGA_BITS_PER_SECOND, GIGA_BITS_PER_SECOND, TERA_BITS_PER_SECOND, COUNT_PER_SECOND
                dimensions: [
                  {
                    key: "String",
                    value: "String",
                  },
                ],
              },
            },
          },
        ],
      },
    },
  ],
  job_flow_id: "XmlStringMaxLen256", # required
})

Response structure


resp.job_flow_id #=> String
resp.instance_group_ids #=> Array
resp.instance_group_ids[0] #=> String
resp.cluster_arn #=> String

Options Hash (options):

  • :instance_groups (required, Array<Types::InstanceGroupConfig>)

    Instance groups to add.

  • :job_flow_id (required, String)

    Job flow in which to add the instance groups.

Returns:

See Also:

#add_job_flow_steps(options = {}) ⇒ Types::AddJobFlowStepsOutput

AddJobFlowSteps adds new steps to a running cluster. A maximum of 256 steps are allowed in each job flow.

If your cluster is long-running (such as a Hive data warehouse) or complex, you may require more than 256 steps to process your data. You can bypass the 256-step limitation in various ways, including using SSH to connect to the master node and submitting queries directly to the software running on the master node, such as Hive and Hadoop. For more information on how to do this, see Add More than 256 Steps to a Cluster in the Amazon EMR Management Guide.

A step specifies the location of a JAR file stored either on the master node of the cluster or in Amazon S3. Each step is performed by the main function of the main class of the JAR file. The main class can be specified either in the manifest of the JAR or by using the MainFunction parameter of the step.

Amazon EMR executes each step in the order listed. For a step to be considered complete, the main function must exit with a zero exit code and all Hadoop jobs started while the step was running must have completed and run successfully.

You can only add steps to a cluster that is in one of the following states: STARTING, BOOTSTRAPPING, RUNNING, or WAITING.

Examples:

Request syntax with placeholder values


resp = client.add_job_flow_steps({
  job_flow_id: "XmlStringMaxLen256", # required
  steps: [ # required
    {
      name: "XmlStringMaxLen256", # required
      action_on_failure: "TERMINATE_JOB_FLOW", # accepts TERMINATE_JOB_FLOW, TERMINATE_CLUSTER, CANCEL_AND_WAIT, CONTINUE
      hadoop_jar_step: { # required
        properties: [
          {
            key: "XmlString",
            value: "XmlString",
          },
        ],
        jar: "XmlString", # required
        main_class: "XmlString",
        args: ["XmlString"],
      },
    },
  ],
})

Response structure


resp.step_ids #=> Array
resp.step_ids[0] #=> String

Options Hash (options):

  • :job_flow_id (required, String)

    A string that uniquely identifies the job flow. This identifier is returned by RunJobFlow and can also be obtained from ListClusters.

  • :steps (required, Array<Types::StepConfig>)

    A list of StepConfig to be executed by the job flow.

Returns:

See Also:

#add_tags(options = {}) ⇒ Struct

Adds tags to an Amazon EMR resource. Tags make it easier to associate clusters in various ways, such as grouping clusters to track your Amazon EMR resource allocation costs. For more information, see Tag Clusters.

Examples:

Request syntax with placeholder values


resp = client.add_tags({
  resource_id: "ResourceId", # required
  tags: [ # required
    {
      key: "String",
      value: "String",
    },
  ],
})

Options Hash (options):

  • :resource_id (required, String)

    The Amazon EMR resource identifier to which tags will be added. This value must be a cluster identifier.

  • :tags (required, Array<Types::Tag>)

    A list of tags to associate with a cluster and propagate to EC2 instances. Tags are user-defined key/value pairs that consist of a required key string with a maximum of 128 characters, and an optional value string with a maximum of 256 characters.

Returns:

  • (Struct)

    Returns an empty response.

See Also:

#cancel_steps(options = {}) ⇒ Types::CancelStepsOutput

Cancels a pending step or steps in a running cluster. Available only in Amazon EMR versions 4.8.0 and later, excluding version 5.0.0. A maximum of 256 steps are allowed in each CancelSteps request. CancelSteps is idempotent but asynchronous; it does not guarantee a step will be canceled, even if the request is successfully submitted. You can only cancel steps that are in a PENDING state.

Examples:

Request syntax with placeholder values


resp = client.cancel_steps({
  cluster_id: "XmlStringMaxLen256", # required
  step_ids: ["XmlStringMaxLen256"], # required
  step_cancellation_option: "SEND_INTERRUPT", # accepts SEND_INTERRUPT, TERMINATE_PROCESS
})

Response structure


resp.cancel_steps_info_list #=> Array
resp.cancel_steps_info_list[0].step_id #=> String
resp.cancel_steps_info_list[0].status #=> String, one of "SUBMITTED", "FAILED"
resp.cancel_steps_info_list[0].reason #=> String

Options Hash (options):

  • :cluster_id (required, String)

    The ClusterID for which specified steps will be canceled. Use RunJobFlow and ListClusters to get ClusterIDs.

  • :step_ids (required, Array<String>)

    The list of StepIDs to cancel. Use ListSteps to get steps and their states for the specified cluster.

  • :step_cancellation_option (String)

    The option to choose for cancelling RUNNING steps. By default, the value is SEND_INTERRUPT.

Returns:

See Also:

#create_security_configuration(options = {}) ⇒ Types::CreateSecurityConfigurationOutput

Creates a security configuration, which is stored in the service and can be specified when a cluster is created.

Examples:

Request syntax with placeholder values


resp = client.create_security_configuration({
  name: "XmlString", # required
  security_configuration: "String", # required
})

Response structure


resp.name #=> String
resp.creation_date_time #=> Time

Options Hash (options):

  • :name (required, String)

    The name of the security configuration.

  • :security_configuration (required, String)

    The security configuration details in JSON format. For JSON parameters and examples, see Use Security Configurations to Set Up Cluster Security in the Amazon EMR Management Guide.

Returns:

See Also:

#delete_security_configuration(options = {}) ⇒ Struct

Deletes a security configuration.

Examples:

Request syntax with placeholder values


resp = client.delete_security_configuration({
  name: "XmlString", # required
})

Options Hash (options):

  • :name (required, String)

    The name of the security configuration.

Returns:

  • (Struct)

    Returns an empty response.

See Also:

#describe_cluster(options = {}) ⇒ Types::DescribeClusterOutput

Provides cluster-level details including status, hardware and software configuration, VPC settings, and so on.

Examples:

Request syntax with placeholder values


resp = client.describe_cluster({
  cluster_id: "ClusterId", # required
})

Response structure


resp.cluster.id #=> String
resp.cluster.name #=> String
resp.cluster.status.state #=> String, one of "STARTING", "BOOTSTRAPPING", "RUNNING", "WAITING", "TERMINATING", "TERMINATED", "TERMINATED_WITH_ERRORS"
resp.cluster.status.state_change_reason.code #=> String, one of "INTERNAL_ERROR", "VALIDATION_ERROR", "INSTANCE_FAILURE", "INSTANCE_FLEET_TIMEOUT", "BOOTSTRAP_FAILURE", "USER_REQUEST", "STEP_FAILURE", "ALL_STEPS_COMPLETED"
resp.cluster.status.state_change_reason.message #=> String
resp.cluster.status.timeline.creation_date_time #=> Time
resp.cluster.status.timeline.ready_date_time #=> Time
resp.cluster.status.timeline.end_date_time #=> Time
resp.cluster.ec2_instance_attributes.ec2_key_name #=> String
resp.cluster.ec2_instance_attributes.ec2_subnet_id #=> String
resp.cluster.ec2_instance_attributes.requested_ec2_subnet_ids #=> Array
resp.cluster.ec2_instance_attributes.requested_ec2_subnet_ids[0] #=> String
resp.cluster.ec2_instance_attributes.ec2_availability_zone #=> String
resp.cluster.ec2_instance_attributes.requested_ec2_availability_zones #=> Array
resp.cluster.ec2_instance_attributes.requested_ec2_availability_zones[0] #=> String
resp.cluster.ec2_instance_attributes.iam_instance_profile #=> String
resp.cluster.ec2_instance_attributes.emr_managed_master_security_group #=> String
resp.cluster.ec2_instance_attributes.emr_managed_slave_security_group #=> String
resp.cluster.ec2_instance_attributes.service_access_security_group #=> String
resp.cluster.ec2_instance_attributes.additional_master_security_groups #=> Array
resp.cluster.ec2_instance_attributes.additional_master_security_groups[0] #=> String
resp.cluster.ec2_instance_attributes.additional_slave_security_groups #=> Array
resp.cluster.ec2_instance_attributes.additional_slave_security_groups[0] #=> String
resp.cluster.instance_collection_type #=> String, one of "INSTANCE_FLEET", "INSTANCE_GROUP"
resp.cluster.log_uri #=> String
resp.cluster.log_encryption_kms_key_id #=> String
resp.cluster.requested_ami_version #=> String
resp.cluster.running_ami_version #=> String
resp.cluster.release_label #=> String
resp.cluster.auto_terminate #=> true/false
resp.cluster.termination_protected #=> true/false
resp.cluster.visible_to_all_users #=> true/false
resp.cluster.applications #=> Array
resp.cluster.applications[0].name #=> String
resp.cluster.applications[0].version #=> String
resp.cluster.applications[0].args #=> Array
resp.cluster.applications[0].args[0] #=> String
resp.cluster.applications[0].additional_info #=> Hash
resp.cluster.applications[0].additional_info["String"] #=> String
resp.cluster.tags #=> Array
resp.cluster.tags[0].key #=> String
resp.cluster.tags[0].value #=> String
resp.cluster.service_role #=> String
resp.cluster.normalized_instance_hours #=> Integer
resp.cluster.master_public_dns_name #=> String
resp.cluster.configurations #=> Array
resp.cluster.configurations[0].classification #=> String
resp.cluster.configurations[0].configurations #=> Types::ConfigurationList
resp.cluster.configurations[0].properties #=> Hash
resp.cluster.configurations[0].properties["String"] #=> String
resp.cluster.security_configuration #=> String
resp.cluster.auto_scaling_role #=> String
resp.cluster.scale_down_behavior #=> String, one of "TERMINATE_AT_INSTANCE_HOUR", "TERMINATE_AT_TASK_COMPLETION"
resp.cluster.custom_ami_id #=> String
resp.cluster.ebs_root_volume_size #=> Integer
resp.cluster.repo_upgrade_on_boot #=> String, one of "SECURITY", "NONE"
resp.cluster.kerberos_attributes.realm #=> String
resp.cluster.kerberos_attributes.kdc_admin_password #=> String
resp.cluster.kerberos_attributes.cross_realm_trust_principal_password #=> String
resp.cluster.kerberos_attributes.ad_domain_join_user #=> String
resp.cluster.kerberos_attributes.ad_domain_join_password #=> String
resp.cluster.cluster_arn #=> String
resp.cluster.outpost_arn #=> String
resp.cluster.step_concurrency_level #=> Integer
resp.cluster.placement_groups #=> Array
resp.cluster.placement_groups[0].instance_role #=> String, one of "MASTER", "CORE", "TASK"
resp.cluster.placement_groups[0].placement_strategy #=> String, one of "SPREAD", "PARTITION", "CLUSTER", "NONE"

Options Hash (options):

  • :cluster_id (required, String)

    The identifier of the cluster to describe.

Returns:

See Also:

#describe_job_flows(options = {}) ⇒ Types::DescribeJobFlowsOutput

This API is deprecated and will eventually be removed. We recommend you use ListClusters, DescribeCluster, ListSteps, ListInstanceGroups and ListBootstrapActions instead.

DescribeJobFlows returns a list of job flows that match all of the supplied parameters. The parameters can include a list of job flow IDs, job flow states, and restrictions on job flow creation date and time.

Regardless of supplied parameters, only job flows created within the last two months are returned.

If no parameters are supplied, then job flows matching either of the following criteria are returned:

  • Job flows created and completed in the last two weeks

  • Job flows created within the last two months that are in one of the following states: RUNNING, WAITING, SHUTTING_DOWN, STARTING

Amazon EMR can return a maximum of 512 job flow descriptions.

Examples:

Request syntax with placeholder values


resp = client.describe_job_flows({
  created_after: Time.now,
  created_before: Time.now,
  job_flow_ids: ["XmlString"],
  job_flow_states: ["STARTING"], # accepts STARTING, BOOTSTRAPPING, RUNNING, WAITING, SHUTTING_DOWN, TERMINATED, COMPLETED, FAILED
})

Response structure


resp.job_flows #=> Array
resp.job_flows[0].job_flow_id #=> String
resp.job_flows[0].name #=> String
resp.job_flows[0].log_uri #=> String
resp.job_flows[0].log_encryption_kms_key_id #=> String
resp.job_flows[0].ami_version #=> String
resp.job_flows[0].execution_status_detail.state #=> String, one of "STARTING", "BOOTSTRAPPING", "RUNNING", "WAITING", "SHUTTING_DOWN", "TERMINATED", "COMPLETED", "FAILED"
resp.job_flows[0].execution_status_detail.creation_date_time #=> Time
resp.job_flows[0].execution_status_detail.start_date_time #=> Time
resp.job_flows[0].execution_status_detail.ready_date_time #=> Time
resp.job_flows[0].execution_status_detail.end_date_time #=> Time
resp.job_flows[0].execution_status_detail.last_state_change_reason #=> String
resp.job_flows[0].instances.master_instance_type #=> String
resp.job_flows[0].instances.master_public_dns_name #=> String
resp.job_flows[0].instances.master_instance_id #=> String
resp.job_flows[0].instances.slave_instance_type #=> String
resp.job_flows[0].instances.instance_count #=> Integer
resp.job_flows[0].instances.instance_groups #=> Array
resp.job_flows[0].instances.instance_groups[0].instance_group_id #=> String
resp.job_flows[0].instances.instance_groups[0].name #=> String
resp.job_flows[0].instances.instance_groups[0].market #=> String, one of "ON_DEMAND", "SPOT"
resp.job_flows[0].instances.instance_groups[0].instance_role #=> String, one of "MASTER", "CORE", "TASK"
resp.job_flows[0].instances.instance_groups[0].bid_price #=> String
resp.job_flows[0].instances.instance_groups[0].instance_type #=> String
resp.job_flows[0].instances.instance_groups[0].instance_request_count #=> Integer
resp.job_flows[0].instances.instance_groups[0].instance_running_count #=> Integer
resp.job_flows[0].instances.instance_groups[0].state #=> String, one of "PROVISIONING", "BOOTSTRAPPING", "RUNNING", "RECONFIGURING", "RESIZING", "SUSPENDED", "TERMINATING", "TERMINATED", "ARRESTED", "SHUTTING_DOWN", "ENDED"
resp.job_flows[0].instances.instance_groups[0].last_state_change_reason #=> String
resp.job_flows[0].instances.instance_groups[0].creation_date_time #=> Time
resp.job_flows[0].instances.instance_groups[0].start_date_time #=> Time
resp.job_flows[0].instances.instance_groups[0].ready_date_time #=> Time
resp.job_flows[0].instances.instance_groups[0].end_date_time #=> Time
resp.job_flows[0].instances.normalized_instance_hours #=> Integer
resp.job_flows[0].instances.ec2_key_name #=> String
resp.job_flows[0].instances.ec2_subnet_id #=> String
resp.job_flows[0].instances.placement.availability_zone #=> String
resp.job_flows[0].instances.placement.availability_zones #=> Array
resp.job_flows[0].instances.placement.availability_zones[0] #=> String
resp.job_flows[0].instances.keep_job_flow_alive_when_no_steps #=> true/false
resp.job_flows[0].instances.termination_protected #=> true/false
resp.job_flows[0].instances.hadoop_version #=> String
resp.job_flows[0].steps #=> Array
resp.job_flows[0].steps[0].step_config.name #=> String
resp.job_flows[0].steps[0].step_config.action_on_failure #=> String, one of "TERMINATE_JOB_FLOW", "TERMINATE_CLUSTER", "CANCEL_AND_WAIT", "CONTINUE"
resp.job_flows[0].steps[0].step_config.hadoop_jar_step.properties #=> Array
resp.job_flows[0].steps[0].step_config.hadoop_jar_step.properties[0].key #=> String
resp.job_flows[0].steps[0].step_config.hadoop_jar_step.properties[0].value #=> String
resp.job_flows[0].steps[0].step_config.hadoop_jar_step.jar #=> String
resp.job_flows[0].steps[0].step_config.hadoop_jar_step.main_class #=> String
resp.job_flows[0].steps[0].step_config.hadoop_jar_step.args #=> Array
resp.job_flows[0].steps[0].step_config.hadoop_jar_step.args[0] #=> String
resp.job_flows[0].steps[0].execution_status_detail.state #=> String, one of "PENDING", "RUNNING", "CONTINUE", "COMPLETED", "CANCELLED", "FAILED", "INTERRUPTED"
resp.job_flows[0].steps[0].execution_status_detail.creation_date_time #=> Time
resp.job_flows[0].steps[0].execution_status_detail.start_date_time #=> Time
resp.job_flows[0].steps[0].execution_status_detail.end_date_time #=> Time
resp.job_flows[0].steps[0].execution_status_detail.last_state_change_reason #=> String
resp.job_flows[0].bootstrap_actions #=> Array
resp.job_flows[0].bootstrap_actions[0].bootstrap_action_config.name #=> String
resp.job_flows[0].bootstrap_actions[0].bootstrap_action_config.script_bootstrap_action.path #=> String
resp.job_flows[0].bootstrap_actions[0].bootstrap_action_config.script_bootstrap_action.args #=> Array
resp.job_flows[0].bootstrap_actions[0].bootstrap_action_config.script_bootstrap_action.args[0] #=> String
resp.job_flows[0].supported_products #=> Array
resp.job_flows[0].supported_products[0] #=> String
resp.job_flows[0].visible_to_all_users #=> true/false
resp.job_flows[0].job_flow_role #=> String
resp.job_flows[0].service_role #=> String
resp.job_flows[0].auto_scaling_role #=> String
resp.job_flows[0].scale_down_behavior #=> String, one of "TERMINATE_AT_INSTANCE_HOUR", "TERMINATE_AT_TASK_COMPLETION"

Options Hash (options):

  • :created_after (Time)

    Return only job flows created after this date and time.

  • :created_before (Time)

    Return only job flows created before this date and time.

  • :job_flow_ids (Array<String>)

    Return only job flows whose job flow ID is contained in this list.

  • :job_flow_states (Array<String>)

    Return only job flows whose state is contained in this list.

Returns:

See Also:

#describe_notebook_execution(options = {}) ⇒ Types::DescribeNotebookExecutionOutput

Provides details of a notebook execution.

Examples:

Request syntax with placeholder values


resp = client.describe_notebook_execution({
  notebook_execution_id: "XmlStringMaxLen256", # required
})

Response structure


resp.notebook_execution.notebook_execution_id #=> String
resp.notebook_execution.editor_id #=> String
resp.notebook_execution.execution_engine.id #=> String
resp.notebook_execution.execution_engine.type #=> String, one of "EMR"
resp.notebook_execution.execution_engine.master_instance_security_group_id #=> String
resp.notebook_execution.notebook_execution_name #=> String
resp.notebook_execution.notebook_params #=> String
resp.notebook_execution.status #=> String, one of "START_PENDING", "STARTING", "RUNNING", "FINISHING", "FINISHED", "FAILING", "FAILED", "STOP_PENDING", "STOPPING", "STOPPED"
resp.notebook_execution.start_time #=> Time
resp.notebook_execution.end_time #=> Time
resp.notebook_execution.arn #=> String
resp.notebook_execution.output_notebook_uri #=> String
resp.notebook_execution.last_state_change_reason #=> String
resp.notebook_execution.notebook_instance_security_group_id #=> String
resp.notebook_execution.tags #=> Array
resp.notebook_execution.tags[0].key #=> String
resp.notebook_execution.tags[0].value #=> String

Options Hash (options):

  • :notebook_execution_id (required, String)

    The unique identifier of the notebook execution.

Returns:

See Also:

#describe_security_configuration(options = {}) ⇒ Types::DescribeSecurityConfigurationOutput

Provides the details of a security configuration by returning the configuration JSON.

Examples:

Request syntax with placeholder values


resp = client.describe_security_configuration({
  name: "XmlString", # required
})

Response structure


resp.name #=> String
resp.security_configuration #=> String
resp.creation_date_time #=> Time

Options Hash (options):

  • :name (required, String)

    The name of the security configuration.

Returns:

See Also:

#describe_step(options = {}) ⇒ Types::DescribeStepOutput

Provides more detail about the cluster step.

Examples:

Request syntax with placeholder values


resp = client.describe_step({
  cluster_id: "ClusterId", # required
  step_id: "StepId", # required
})

Response structure


resp.step.id #=> String
resp.step.name #=> String
resp.step.config.jar #=> String
resp.step.config.properties #=> Hash
resp.step.config.properties["String"] #=> String
resp.step.config.main_class #=> String
resp.step.config.args #=> Array
resp.step.config.args[0] #=> String
resp.step.action_on_failure #=> String, one of "TERMINATE_JOB_FLOW", "TERMINATE_CLUSTER", "CANCEL_AND_WAIT", "CONTINUE"
resp.step.status.state #=> String, one of "PENDING", "CANCEL_PENDING", "RUNNING", "COMPLETED", "CANCELLED", "FAILED", "INTERRUPTED"
resp.step.status.state_change_reason.code #=> String, one of "NONE"
resp.step.status.state_change_reason.message #=> String
resp.step.status.failure_details.reason #=> String
resp.step.status.failure_details.message #=> String
resp.step.status.failure_details.log_file #=> String
resp.step.status.timeline.creation_date_time #=> Time
resp.step.status.timeline.start_date_time #=> Time
resp.step.status.timeline.end_date_time #=> Time

Options Hash (options):

  • :cluster_id (required, String)

    The identifier of the cluster with steps to describe.

  • :step_id (required, String)

    The identifier of the step to describe.

Returns:

See Also:

#get_block_public_access_configuration(options = {}) ⇒ Types::GetBlockPublicAccessConfigurationOutput

Returns the Amazon EMR block public access configuration for your AWS account in the current Region. For more information see Configure Block Public Access for Amazon EMR in the Amazon EMR Management Guide.

Examples:

Request syntax with placeholder values


resp = client.get_block_public_access_configuration()

Response structure


resp.block_public_access_configuration.block_public_security_group_rules #=> true/false
resp.block_public_access_configuration.permitted_public_security_group_rule_ranges #=> Array
resp.block_public_access_configuration.permitted_public_security_group_rule_ranges[0].min_range #=> Integer
resp.block_public_access_configuration.permitted_public_security_group_rule_ranges[0].max_range #=> Integer
resp..creation_date_time #=> Time
resp..created_by_arn #=> String

Returns:

See Also:

#get_managed_scaling_policy(options = {}) ⇒ Types::GetManagedScalingPolicyOutput

Fetches the attached managed scaling policy for an Amazon EMR cluster.

Examples:

Request syntax with placeholder values


resp = client.get_managed_scaling_policy({
  cluster_id: "ClusterId", # required
})

Response structure


resp.managed_scaling_policy.compute_limits.unit_type #=> String, one of "InstanceFleetUnits", "Instances", "VCPU"
resp.managed_scaling_policy.compute_limits.minimum_capacity_units #=> Integer
resp.managed_scaling_policy.compute_limits.maximum_capacity_units #=> Integer
resp.managed_scaling_policy.compute_limits.maximum_on_demand_capacity_units #=> Integer
resp.managed_scaling_policy.compute_limits.maximum_core_capacity_units #=> Integer

Options Hash (options):

  • :cluster_id (required, String)

    Specifies the ID of the cluster for which the managed scaling policy will be fetched.

Returns:

See Also:

#list_bootstrap_actions(options = {}) ⇒ Types::ListBootstrapActionsOutput

Provides information about the bootstrap actions associated with a cluster.

Examples:

Request syntax with placeholder values


resp = client.list_bootstrap_actions({
  cluster_id: "ClusterId", # required
  marker: "Marker",
})

Response structure


resp.bootstrap_actions #=> Array
resp.bootstrap_actions[0].name #=> String
resp.bootstrap_actions[0].script_path #=> String
resp.bootstrap_actions[0].args #=> Array
resp.bootstrap_actions[0].args[0] #=> String
resp.marker #=> String

Options Hash (options):

  • :cluster_id (required, String)

    The cluster identifier for the bootstrap actions to list.

  • :marker (String)

    The pagination token that indicates the next set of results to retrieve.

Returns:

See Also:

#list_clusters(options = {}) ⇒ Types::ListClustersOutput

Provides the status of all clusters visible to this AWS account. Allows you to filter the list of clusters based on certain criteria; for example, filtering by cluster creation date and time or by status. This call returns a maximum of 50 clusters per call, but returns a marker to track the paging of the cluster list across multiple ListClusters calls.

Examples:

Request syntax with placeholder values


resp = client.list_clusters({
  created_after: Time.now,
  created_before: Time.now,
  cluster_states: ["STARTING"], # accepts STARTING, BOOTSTRAPPING, RUNNING, WAITING, TERMINATING, TERMINATED, TERMINATED_WITH_ERRORS
  marker: "Marker",
})

Response structure


resp.clusters #=> Array
resp.clusters[0].id #=> String
resp.clusters[0].name #=> String
resp.clusters[0].status.state #=> String, one of "STARTING", "BOOTSTRAPPING", "RUNNING", "WAITING", "TERMINATING", "TERMINATED", "TERMINATED_WITH_ERRORS"
resp.clusters[0].status.state_change_reason.code #=> String, one of "INTERNAL_ERROR", "VALIDATION_ERROR", "INSTANCE_FAILURE", "INSTANCE_FLEET_TIMEOUT", "BOOTSTRAP_FAILURE", "USER_REQUEST", "STEP_FAILURE", "ALL_STEPS_COMPLETED"
resp.clusters[0].status.state_change_reason.message #=> String
resp.clusters[0].status.timeline.creation_date_time #=> Time
resp.clusters[0].status.timeline.ready_date_time #=> Time
resp.clusters[0].status.timeline.end_date_time #=> Time
resp.clusters[0].normalized_instance_hours #=> Integer
resp.clusters[0].cluster_arn #=> String
resp.clusters[0].outpost_arn #=> String
resp.marker #=> String

Options Hash (options):

  • :created_after (Time)

    The creation date and time beginning value filter for listing clusters.

  • :created_before (Time)

    The creation date and time end value filter for listing clusters.

  • :cluster_states (Array<String>)

    The cluster state filters to apply when listing clusters.

  • :marker (String)

    The pagination token that indicates the next set of results to retrieve.

Returns:

See Also:

#list_instance_fleets(options = {}) ⇒ Types::ListInstanceFleetsOutput

Lists all available details about the instance fleets in a cluster.

The instance fleet configuration is available only in Amazon EMR versions 4.8.0 and later, excluding 5.0.x versions.

Examples:

Request syntax with placeholder values


resp = client.list_instance_fleets({
  cluster_id: "ClusterId", # required
  marker: "Marker",
})

Response structure


resp.instance_fleets #=> Array
resp.instance_fleets[0].id #=> String
resp.instance_fleets[0].name #=> String
resp.instance_fleets[0].status.state #=> String, one of "PROVISIONING", "BOOTSTRAPPING", "RUNNING", "RESIZING", "SUSPENDED", "TERMINATING", "TERMINATED"
resp.instance_fleets[0].status.state_change_reason.code #=> String, one of "INTERNAL_ERROR", "VALIDATION_ERROR", "INSTANCE_FAILURE", "CLUSTER_TERMINATED"
resp.instance_fleets[0].status.state_change_reason.message #=> String
resp.instance_fleets[0].status.timeline.creation_date_time #=> Time
resp.instance_fleets[0].status.timeline.ready_date_time #=> Time
resp.instance_fleets[0].status.timeline.end_date_time #=> Time
resp.instance_fleets[0].instance_fleet_type #=> String, one of "MASTER", "CORE", "TASK"
resp.instance_fleets[0].target_on_demand_capacity #=> Integer
resp.instance_fleets[0].target_spot_capacity #=> Integer
resp.instance_fleets[0].provisioned_on_demand_capacity #=> Integer
resp.instance_fleets[0].provisioned_spot_capacity #=> Integer
resp.instance_fleets[0].instance_type_specifications #=> Array
resp.instance_fleets[0].instance_type_specifications[0].instance_type #=> String
resp.instance_fleets[0].instance_type_specifications[0].weighted_capacity #=> Integer
resp.instance_fleets[0].instance_type_specifications[0].bid_price #=> String
resp.instance_fleets[0].instance_type_specifications[0].bid_price_as_percentage_of_on_demand_price #=> Float
resp.instance_fleets[0].instance_type_specifications[0].configurations #=> Array
resp.instance_fleets[0].instance_type_specifications[0].configurations[0].classification #=> String
resp.instance_fleets[0].instance_type_specifications[0].configurations[0].configurations #=> Types::ConfigurationList
resp.instance_fleets[0].instance_type_specifications[0].configurations[0].properties #=> Hash
resp.instance_fleets[0].instance_type_specifications[0].configurations[0].properties["String"] #=> String
resp.instance_fleets[0].instance_type_specifications[0].ebs_block_devices #=> Array
resp.instance_fleets[0].instance_type_specifications[0].ebs_block_devices[0].volume_specification.volume_type #=> String
resp.instance_fleets[0].instance_type_specifications[0].ebs_block_devices[0].volume_specification.iops #=> Integer
resp.instance_fleets[0].instance_type_specifications[0].ebs_block_devices[0].volume_specification.size_in_gb #=> Integer
resp.instance_fleets[0].instance_type_specifications[0].ebs_block_devices[0].device #=> String
resp.instance_fleets[0].instance_type_specifications[0].ebs_optimized #=> true/false
resp.instance_fleets[0].launch_specifications.spot_specification.timeout_duration_minutes #=> Integer
resp.instance_fleets[0].launch_specifications.spot_specification.timeout_action #=> String, one of "SWITCH_TO_ON_DEMAND", "TERMINATE_CLUSTER"
resp.instance_fleets[0].launch_specifications.spot_specification.block_duration_minutes #=> Integer
resp.instance_fleets[0].launch_specifications.spot_specification.allocation_strategy #=> String, one of "capacity-optimized"
resp.instance_fleets[0].launch_specifications.on_demand_specification.allocation_strategy #=> String, one of "lowest-price"
resp.marker #=> String

Options Hash (options):

  • :cluster_id (required, String)

    The unique identifier of the cluster.

  • :marker (String)

    The pagination token that indicates the next set of results to retrieve.

Returns:

See Also:

#list_instance_groups(options = {}) ⇒ Types::ListInstanceGroupsOutput

Provides all available details about the instance groups in a cluster.

Examples:

Request syntax with placeholder values


resp = client.list_instance_groups({
  cluster_id: "ClusterId", # required
  marker: "Marker",
})

Response structure


resp.instance_groups #=> Array
resp.instance_groups[0].id #=> String
resp.instance_groups[0].name #=> String
resp.instance_groups[0].market #=> String, one of "ON_DEMAND", "SPOT"
resp.instance_groups[0].instance_group_type #=> String, one of "MASTER", "CORE", "TASK"
resp.instance_groups[0].bid_price #=> String
resp.instance_groups[0].instance_type #=> String
resp.instance_groups[0].requested_instance_count #=> Integer
resp.instance_groups[0].running_instance_count #=> Integer
resp.instance_groups[0].status.state #=> String, one of "PROVISIONING", "BOOTSTRAPPING", "RUNNING", "RECONFIGURING", "RESIZING", "SUSPENDED", "TERMINATING", "TERMINATED", "ARRESTED", "SHUTTING_DOWN", "ENDED"
resp.instance_groups[0].status.state_change_reason.code #=> String, one of "INTERNAL_ERROR", "VALIDATION_ERROR", "INSTANCE_FAILURE", "CLUSTER_TERMINATED"
resp.instance_groups[0].status.state_change_reason.message #=> String
resp.instance_groups[0].status.timeline.creation_date_time #=> Time
resp.instance_groups[0].status.timeline.ready_date_time #=> Time
resp.instance_groups[0].status.timeline.end_date_time #=> Time
resp.instance_groups[0].configurations #=> Array
resp.instance_groups[0].configurations[0].classification #=> String
resp.instance_groups[0].configurations[0].configurations #=> Types::ConfigurationList
resp.instance_groups[0].configurations[0].properties #=> Hash
resp.instance_groups[0].configurations[0].properties["String"] #=> String
resp.instance_groups[0].configurations_version #=> Integer
resp.instance_groups[0].last_successfully_applied_configurations #=> Array
resp.instance_groups[0].last_successfully_applied_configurations[0].classification #=> String
resp.instance_groups[0].last_successfully_applied_configurations[0].configurations #=> Types::ConfigurationList
resp.instance_groups[0].last_successfully_applied_configurations[0].properties #=> Hash
resp.instance_groups[0].last_successfully_applied_configurations[0].properties["String"] #=> String
resp.instance_groups[0].last_successfully_applied_configurations_version #=> Integer
resp.instance_groups[0].ebs_block_devices #=> Array
resp.instance_groups[0].ebs_block_devices[0].volume_specification.volume_type #=> String
resp.instance_groups[0].ebs_block_devices[0].volume_specification.iops #=> Integer
resp.instance_groups[0].ebs_block_devices[0].volume_specification.size_in_gb #=> Integer
resp.instance_groups[0].ebs_block_devices[0].device #=> String
resp.instance_groups[0].ebs_optimized #=> true/false
resp.instance_groups[0].shrink_policy.decommission_timeout #=> Integer
resp.instance_groups[0].shrink_policy.instance_resize_policy.instances_to_terminate #=> Array
resp.instance_groups[0].shrink_policy.instance_resize_policy.instances_to_terminate[0] #=> String
resp.instance_groups[0].shrink_policy.instance_resize_policy.instances_to_protect #=> Array
resp.instance_groups[0].shrink_policy.instance_resize_policy.instances_to_protect[0] #=> String
resp.instance_groups[0].shrink_policy.instance_resize_policy.instance_termination_timeout #=> Integer
resp.instance_groups[0].auto_scaling_policy.status.state #=> String, one of "PENDING", "ATTACHING", "ATTACHED", "DETACHING", "DETACHED", "FAILED"
resp.instance_groups[0].auto_scaling_policy.status.state_change_reason.code #=> String, one of "USER_REQUEST", "PROVISION_FAILURE", "CLEANUP_FAILURE"
resp.instance_groups[0].auto_scaling_policy.status.state_change_reason.message #=> String
resp.instance_groups[0].auto_scaling_policy.constraints.min_capacity #=> Integer
resp.instance_groups[0].auto_scaling_policy.constraints.max_capacity #=> Integer
resp.instance_groups[0].auto_scaling_policy.rules #=> Array
resp.instance_groups[0].auto_scaling_policy.rules[0].name #=> String
resp.instance_groups[0].auto_scaling_policy.rules[0].description #=> String
resp.instance_groups[0].auto_scaling_policy.rules[0].action.market #=> String, one of "ON_DEMAND", "SPOT"
resp.instance_groups[0].auto_scaling_policy.rules[0].action.simple_scaling_policy_configuration.adjustment_type #=> String, one of "CHANGE_IN_CAPACITY", "PERCENT_CHANGE_IN_CAPACITY", "EXACT_CAPACITY"
resp.instance_groups[0].auto_scaling_policy.rules[0].action.simple_scaling_policy_configuration.scaling_adjustment #=> Integer
resp.instance_groups[0].auto_scaling_policy.rules[0].action.simple_scaling_policy_configuration.cool_down #=> Integer
resp.instance_groups[0].auto_scaling_policy.rules[0].trigger.cloud_watch_alarm_definition.comparison_operator #=> String, one of "GREATER_THAN_OR_EQUAL", "GREATER_THAN", "LESS_THAN", "LESS_THAN_OR_EQUAL"
resp.instance_groups[0].auto_scaling_policy.rules[0].trigger.cloud_watch_alarm_definition.evaluation_periods #=> Integer
resp.instance_groups[0].auto_scaling_policy.rules[0].trigger.cloud_watch_alarm_definition.metric_name #=> String
resp.instance_groups[0].auto_scaling_policy.rules[0].trigger.cloud_watch_alarm_definition.namespace #=> String
resp.instance_groups[0].auto_scaling_policy.rules[0].trigger.cloud_watch_alarm_definition.period #=> Integer
resp.instance_groups[0].auto_scaling_policy.rules[0].trigger.cloud_watch_alarm_definition.statistic #=> String, one of "SAMPLE_COUNT", "AVERAGE", "SUM", "MINIMUM", "MAXIMUM"
resp.instance_groups[0].auto_scaling_policy.rules[0].trigger.cloud_watch_alarm_definition.threshold #=> Float
resp.instance_groups[0].auto_scaling_policy.rules[0].trigger.cloud_watch_alarm_definition.unit #=> String, one of "NONE", "SECONDS", "MICRO_SECONDS", "MILLI_SECONDS", "BYTES", "KILO_BYTES", "MEGA_BYTES", "GIGA_BYTES", "TERA_BYTES", "BITS", "KILO_BITS", "MEGA_BITS", "GIGA_BITS", "TERA_BITS", "PERCENT", "COUNT", "BYTES_PER_SECOND", "KILO_BYTES_PER_SECOND", "MEGA_BYTES_PER_SECOND", "GIGA_BYTES_PER_SECOND", "TERA_BYTES_PER_SECOND", "BITS_PER_SECOND", "KILO_BITS_PER_SECOND", "MEGA_BITS_PER_SECOND", "GIGA_BITS_PER_SECOND", "TERA_BITS_PER_SECOND", "COUNT_PER_SECOND"
resp.instance_groups[0].auto_scaling_policy.rules[0].trigger.cloud_watch_alarm_definition.dimensions #=> Array
resp.instance_groups[0].auto_scaling_policy.rules[0].trigger.cloud_watch_alarm_definition.dimensions[0].key #=> String
resp.instance_groups[0].auto_scaling_policy.rules[0].trigger.cloud_watch_alarm_definition.dimensions[0].value #=> String
resp.marker #=> String

Options Hash (options):

  • :cluster_id (required, String)

    The identifier of the cluster for which to list the instance groups.

  • :marker (String)

    The pagination token that indicates the next set of results to retrieve.

Returns:

See Also:

#list_instances(options = {}) ⇒ Types::ListInstancesOutput

Provides information for all active EC2 instances and EC2 instances terminated in the last 30 days, up to a maximum of 2,000. EC2 instances in any of the following states are considered active: AWAITING_FULFILLMENT, PROVISIONING, BOOTSTRAPPING, RUNNING.

Examples:

Request syntax with placeholder values


resp = client.list_instances({
  cluster_id: "ClusterId", # required
  instance_group_id: "InstanceGroupId",
  instance_group_types: ["MASTER"], # accepts MASTER, CORE, TASK
  instance_fleet_id: "InstanceFleetId",
  instance_fleet_type: "MASTER", # accepts MASTER, CORE, TASK
  instance_states: ["AWAITING_FULFILLMENT"], # accepts AWAITING_FULFILLMENT, PROVISIONING, BOOTSTRAPPING, RUNNING, TERMINATED
  marker: "Marker",
})

Response structure


resp.instances #=> Array
resp.instances[0].id #=> String
resp.instances[0].ec2_instance_id #=> String
resp.instances[0].public_dns_name #=> String
resp.instances[0].public_ip_address #=> String
resp.instances[0].private_dns_name #=> String
resp.instances[0].private_ip_address #=> String
resp.instances[0].status.state #=> String, one of "AWAITING_FULFILLMENT", "PROVISIONING", "BOOTSTRAPPING", "RUNNING", "TERMINATED"
resp.instances[0].status.state_change_reason.code #=> String, one of "INTERNAL_ERROR", "VALIDATION_ERROR", "INSTANCE_FAILURE", "BOOTSTRAP_FAILURE", "CLUSTER_TERMINATED"
resp.instances[0].status.state_change_reason.message #=> String
resp.instances[0].status.timeline.creation_date_time #=> Time
resp.instances[0].status.timeline.ready_date_time #=> Time
resp.instances[0].status.timeline.end_date_time #=> Time
resp.instances[0].instance_group_id #=> String
resp.instances[0].instance_fleet_id #=> String
resp.instances[0].market #=> String, one of "ON_DEMAND", "SPOT"
resp.instances[0].instance_type #=> String
resp.instances[0].ebs_volumes #=> Array
resp.instances[0].ebs_volumes[0].device #=> String
resp.instances[0].ebs_volumes[0].volume_id #=> String
resp.marker #=> String

Options Hash (options):

  • :cluster_id (required, String)

    The identifier of the cluster for which to list the instances.

  • :instance_group_id (String)

    The identifier of the instance group for which to list the instances.

  • :instance_group_types (Array<String>)

    The type of instance group for which to list the instances.

  • :instance_fleet_id (String)

    The unique identifier of the instance fleet.

  • :instance_fleet_type (String)

    The node type of the instance fleet. For example MASTER, CORE, or TASK.

  • :instance_states (Array<String>)

    A list of instance states that will filter the instances returned with this request.

  • :marker (String)

    The pagination token that indicates the next set of results to retrieve.

Returns:

See Also:

#list_notebook_executions(options = {}) ⇒ Types::ListNotebookExecutionsOutput

Provides summaries of all notebook executions. You can filter the list based on multiple criteria such as status, time range, and editor id. Returns a maximum of 50 notebook executions and a marker to track the paging of a longer notebook execution list across multiple ListNotebookExecution calls.

Examples:

Request syntax with placeholder values


resp = client.list_notebook_executions({
  editor_id: "XmlStringMaxLen256",
  status: "START_PENDING", # accepts START_PENDING, STARTING, RUNNING, FINISHING, FINISHED, FAILING, FAILED, STOP_PENDING, STOPPING, STOPPED
  from: Time.now,
  to: Time.now,
  marker: "Marker",
})

Response structure


resp.notebook_executions #=> Array
resp.notebook_executions[0].notebook_execution_id #=> String
resp.notebook_executions[0].editor_id #=> String
resp.notebook_executions[0].notebook_execution_name #=> String
resp.notebook_executions[0].status #=> String, one of "START_PENDING", "STARTING", "RUNNING", "FINISHING", "FINISHED", "FAILING", "FAILED", "STOP_PENDING", "STOPPING", "STOPPED"
resp.notebook_executions[0].start_time #=> Time
resp.notebook_executions[0].end_time #=> Time
resp.marker #=> String

Options Hash (options):

  • :editor_id (String)

    The unique ID of the editor associated with the notebook execution.

  • :status (String)

    The status filter for listing notebook executions.

    • START_PENDING indicates that the cluster has received the execution request but execution has not begun.

    • STARTING indicates that the execution is starting on the cluster.

    • RUNNING indicates that the execution is being processed by the cluster.

    • FINISHING indicates that execution processing is in the final stages.

    • FINISHED indicates that the execution has completed without error.

    • FAILING indicates that the execution is failing and will not finish successfully.

    • FAILED indicates that the execution failed.

    • STOP_PENDING indicates that the cluster has received a StopNotebookExecution request and the stop is pending.

    • STOPPING indicates that the cluster is in the process of stopping the execution as a result of a StopNotebookExecution request.

    • STOPPED indicates that the execution stopped because of a StopNotebookExecution request.

  • :from (Time)

    The beginning of time range filter for listing notebook executions. The default is the timestamp of 30 days ago.

  • :to (Time)

    The end of time range filter for listing notebook executions. The default is the current timestamp.

  • :marker (String)

    The pagination token, returned by a previous ListNotebookExecutions call, that indicates the start of the list for this ListNotebookExecutions call.

Returns:

See Also:

#list_security_configurations(options = {}) ⇒ Types::ListSecurityConfigurationsOutput

Lists all the security configurations visible to this account, providing their creation dates and times, and their names. This call returns a maximum of 50 clusters per call, but returns a marker to track the paging of the cluster list across multiple ListSecurityConfigurations calls.

Examples:

Request syntax with placeholder values


resp = client.list_security_configurations({
  marker: "Marker",
})

Response structure


resp.security_configurations #=> Array
resp.security_configurations[0].name #=> String
resp.security_configurations[0].creation_date_time #=> Time
resp.marker #=> String

Options Hash (options):

  • :marker (String)

    The pagination token that indicates the set of results to retrieve.

Returns:

See Also:

#list_steps(options = {}) ⇒ Types::ListStepsOutput

Provides a list of steps for the cluster in reverse order unless you specify stepIds with the request of filter by StepStates. You can specify a maximum of ten stepIDs.

Examples:

Request syntax with placeholder values


resp = client.list_steps({
  cluster_id: "ClusterId", # required
  step_states: ["PENDING"], # accepts PENDING, CANCEL_PENDING, RUNNING, COMPLETED, CANCELLED, FAILED, INTERRUPTED
  step_ids: ["XmlString"],
  marker: "Marker",
})

Response structure


resp.steps #=> Array
resp.steps[0].id #=> String
resp.steps[0].name #=> String
resp.steps[0].config.jar #=> String
resp.steps[0].config.properties #=> Hash
resp.steps[0].config.properties["String"] #=> String
resp.steps[0].config.main_class #=> String
resp.steps[0].config.args #=> Array
resp.steps[0].config.args[0] #=> String
resp.steps[0].action_on_failure #=> String, one of "TERMINATE_JOB_FLOW", "TERMINATE_CLUSTER", "CANCEL_AND_WAIT", "CONTINUE"
resp.steps[0].status.state #=> String, one of "PENDING", "CANCEL_PENDING", "RUNNING", "COMPLETED", "CANCELLED", "FAILED", "INTERRUPTED"
resp.steps[0].status.state_change_reason.code #=> String, one of "NONE"
resp.steps[0].status.state_change_reason.message #=> String
resp.steps[0].status.failure_details.reason #=> String
resp.steps[0].status.failure_details.message #=> String
resp.steps[0].status.failure_details.log_file #=> String
resp.steps[0].status.timeline.creation_date_time #=> Time
resp.steps[0].status.timeline.start_date_time #=> Time
resp.steps[0].status.timeline.end_date_time #=> Time
resp.marker #=> String

Options Hash (options):

  • :cluster_id (required, String)

    The identifier of the cluster for which to list the steps.

  • :step_states (Array<String>)

    The filter to limit the step list based on certain states.

  • :step_ids (Array<String>)

    The filter to limit the step list based on the identifier of the steps. You can specify a maximum of ten Step IDs. The character constraint applies to the overall length of the array.

  • :marker (String)

    The pagination token that indicates the next set of results to retrieve.

Returns:

See Also:

#modify_cluster(options = {}) ⇒ Types::ModifyClusterOutput

Modifies the number of steps that can be executed concurrently for the cluster specified using ClusterID.

Examples:

Request syntax with placeholder values


resp = client.modify_cluster({
  cluster_id: "String", # required
  step_concurrency_level: 1,
})

Response structure


resp.step_concurrency_level #=> Integer

Options Hash (options):

  • :cluster_id (required, String)

    The unique identifier of the cluster.

  • :step_concurrency_level (Integer)

    The number of steps that can be executed concurrently. You can specify a maximum of 256 steps.

Returns:

See Also:

#modify_instance_fleet(options = {}) ⇒ Struct

Modifies the target On-Demand and target Spot capacities for the instance fleet with the specified InstanceFleetID within the cluster specified using ClusterID. The call either succeeds or fails atomically.

The instance fleet configuration is available only in Amazon EMR versions 4.8.0 and later, excluding 5.0.x versions.

Examples:

Request syntax with placeholder values


resp = client.modify_instance_fleet({
  cluster_id: "ClusterId", # required
  instance_fleet: { # required
    instance_fleet_id: "InstanceFleetId", # required
    target_on_demand_capacity: 1,
    target_spot_capacity: 1,
  },
})

Options Hash (options):

  • :cluster_id (required, String)

    The unique identifier of the cluster.

  • :instance_fleet (required, Types::InstanceFleetModifyConfig)

    The unique identifier of the instance fleet.

Returns:

  • (Struct)

    Returns an empty response.

See Also:

#modify_instance_groups(options = {}) ⇒ Struct

ModifyInstanceGroups modifies the number of nodes and configuration settings of an instance group. The input parameters include the new target instance count for the group and the instance group ID. The call will either succeed or fail atomically.

Examples:

Request syntax with placeholder values


resp = client.modify_instance_groups({
  cluster_id: "ClusterId",
  instance_groups: [
    {
      instance_group_id: "XmlStringMaxLen256", # required
      instance_count: 1,
      ec2_instance_ids_to_terminate: ["InstanceId"],
      shrink_policy: {
        decommission_timeout: 1,
        instance_resize_policy: {
          instances_to_terminate: ["InstanceId"],
          instances_to_protect: ["InstanceId"],
          instance_termination_timeout: 1,
        },
      },
      configurations: [
        {
          classification: "String",
          configurations: {
            # recursive ConfigurationList
          },
          properties: {
            "String" => "String",
          },
        },
      ],
    },
  ],
})

Options Hash (options):

  • :cluster_id (String)

    The ID of the cluster to which the instance group belongs.

  • :instance_groups (Array<Types::InstanceGroupModifyConfig>)

    Instance groups to change.

Returns:

  • (Struct)

    Returns an empty response.

See Also:

#put_auto_scaling_policy(options = {}) ⇒ Types::PutAutoScalingPolicyOutput

Creates or updates an automatic scaling policy for a core instance group or task instance group in an Amazon EMR cluster. The automatic scaling policy defines how an instance group dynamically adds and terminates EC2 instances in response to the value of a CloudWatch metric.

Examples:

Request syntax with placeholder values


resp = client.put_auto_scaling_policy({
  cluster_id: "ClusterId", # required
  instance_group_id: "InstanceGroupId", # required
  auto_scaling_policy: { # required
    constraints: { # required
      min_capacity: 1, # required
      max_capacity: 1, # required
    },
    rules: [ # required
      {
        name: "String", # required
        description: "String",
        action: { # required
          market: "ON_DEMAND", # accepts ON_DEMAND, SPOT
          simple_scaling_policy_configuration: { # required
            adjustment_type: "CHANGE_IN_CAPACITY", # accepts CHANGE_IN_CAPACITY, PERCENT_CHANGE_IN_CAPACITY, EXACT_CAPACITY
            scaling_adjustment: 1, # required
            cool_down: 1,
          },
        },
        trigger: { # required
          cloud_watch_alarm_definition: { # required
            comparison_operator: "GREATER_THAN_OR_EQUAL", # required, accepts GREATER_THAN_OR_EQUAL, GREATER_THAN, LESS_THAN, LESS_THAN_OR_EQUAL
            evaluation_periods: 1,
            metric_name: "String", # required
            namespace: "String",
            period: 1, # required
            statistic: "SAMPLE_COUNT", # accepts SAMPLE_COUNT, AVERAGE, SUM, MINIMUM, MAXIMUM
            threshold: 1.0, # required
            unit: "NONE", # accepts NONE, SECONDS, MICRO_SECONDS, MILLI_SECONDS, BYTES, KILO_BYTES, MEGA_BYTES, GIGA_BYTES, TERA_BYTES, BITS, KILO_BITS, MEGA_BITS, GIGA_BITS, TERA_BITS, PERCENT, COUNT, BYTES_PER_SECOND, KILO_BYTES_PER_SECOND, MEGA_BYTES_PER_SECOND, GIGA_BYTES_PER_SECOND, TERA_BYTES_PER_SECOND, BITS_PER_SECOND, KILO_BITS_PER_SECOND, MEGA_BITS_PER_SECOND, GIGA_BITS_PER_SECOND, TERA_BITS_PER_SECOND, COUNT_PER_SECOND
            dimensions: [
              {
                key: "String",
                value: "String",
              },
            ],
          },
        },
      },
    ],
  },
})

Response structure


resp.cluster_id #=> String
resp.instance_group_id #=> String
resp.auto_scaling_policy.status.state #=> String, one of "PENDING", "ATTACHING", "ATTACHED", "DETACHING", "DETACHED", "FAILED"
resp.auto_scaling_policy.status.state_change_reason.code #=> String, one of "USER_REQUEST", "PROVISION_FAILURE", "CLEANUP_FAILURE"
resp.auto_scaling_policy.status.state_change_reason.message #=> String
resp.auto_scaling_policy.constraints.min_capacity #=> Integer
resp.auto_scaling_policy.constraints.max_capacity #=> Integer
resp.auto_scaling_policy.rules #=> Array
resp.auto_scaling_policy.rules[0].name #=> String
resp.auto_scaling_policy.rules[0].description #=> String
resp.auto_scaling_policy.rules[0].action.market #=> String, one of "ON_DEMAND", "SPOT"
resp.auto_scaling_policy.rules[0].action.simple_scaling_policy_configuration.adjustment_type #=> String, one of "CHANGE_IN_CAPACITY", "PERCENT_CHANGE_IN_CAPACITY", "EXACT_CAPACITY"
resp.auto_scaling_policy.rules[0].action.simple_scaling_policy_configuration.scaling_adjustment #=> Integer
resp.auto_scaling_policy.rules[0].action.simple_scaling_policy_configuration.cool_down #=> Integer
resp.auto_scaling_policy.rules[0].trigger.cloud_watch_alarm_definition.comparison_operator #=> String, one of "GREATER_THAN_OR_EQUAL", "GREATER_THAN", "LESS_THAN", "LESS_THAN_OR_EQUAL"
resp.auto_scaling_policy.rules[0].trigger.cloud_watch_alarm_definition.evaluation_periods #=> Integer
resp.auto_scaling_policy.rules[0].trigger.cloud_watch_alarm_definition.metric_name #=> String
resp.auto_scaling_policy.rules[0].trigger.cloud_watch_alarm_definition.namespace #=> String
resp.auto_scaling_policy.rules[0].trigger.cloud_watch_alarm_definition.period #=> Integer
resp.auto_scaling_policy.rules[0].trigger.cloud_watch_alarm_definition.statistic #=> String, one of "SAMPLE_COUNT", "AVERAGE", "SUM", "MINIMUM", "MAXIMUM"
resp.auto_scaling_policy.rules[0].trigger.cloud_watch_alarm_definition.threshold #=> Float
resp.auto_scaling_policy.rules[0].trigger.cloud_watch_alarm_definition.unit #=> String, one of "NONE", "SECONDS", "MICRO_SECONDS", "MILLI_SECONDS", "BYTES", "KILO_BYTES", "MEGA_BYTES", "GIGA_BYTES", "TERA_BYTES", "BITS", "KILO_BITS", "MEGA_BITS", "GIGA_BITS", "TERA_BITS", "PERCENT", "COUNT", "BYTES_PER_SECOND", "KILO_BYTES_PER_SECOND", "MEGA_BYTES_PER_SECOND", "GIGA_BYTES_PER_SECOND", "TERA_BYTES_PER_SECOND", "BITS_PER_SECOND", "KILO_BITS_PER_SECOND", "MEGA_BITS_PER_SECOND", "GIGA_BITS_PER_SECOND", "TERA_BITS_PER_SECOND", "COUNT_PER_SECOND"
resp.auto_scaling_policy.rules[0].trigger.cloud_watch_alarm_definition.dimensions #=> Array
resp.auto_scaling_policy.rules[0].trigger.cloud_watch_alarm_definition.dimensions[0].key #=> String
resp.auto_scaling_policy.rules[0].trigger.cloud_watch_alarm_definition.dimensions[0].value #=> String
resp.cluster_arn #=> String

Options Hash (options):

  • :cluster_id (required, String)

    Specifies the ID of a cluster. The instance group to which the automatic scaling policy is applied is within this cluster.

  • :instance_group_id (required, String)

    Specifies the ID of the instance group to which the automatic scaling policy is applied.

  • :auto_scaling_policy (required, Types::AutoScalingPolicy)

    Specifies the definition of the automatic scaling policy.

Returns:

See Also:

#put_block_public_access_configuration(options = {}) ⇒ Struct

Creates or updates an Amazon EMR block public access configuration for your AWS account in the current Region. For more information see Configure Block Public Access for Amazon EMR in the Amazon EMR Management Guide.

Examples:

Request syntax with placeholder values


resp = client.put_block_public_access_configuration({
  block_public_access_configuration: { # required
    block_public_security_group_rules: false, # required
    permitted_public_security_group_rule_ranges: [
      {
        min_range: 1, # required
        max_range: 1,
      },
    ],
  },
})

Options Hash (options):

  • :block_public_access_configuration (required, Types::BlockPublicAccessConfiguration)

    A configuration for Amazon EMR block public access. The configuration applies to all clusters created in your account for the current Region. The configuration specifies whether block public access is enabled. If block public access is enabled, security groups associated with the cluster cannot have rules that allow inbound traffic from 0.0.0.0/0 or ::/0 on a port, unless the port is specified as an exception using PermittedPublicSecurityGroupRuleRanges in the BlockPublicAccessConfiguration. By default, Port 22 (SSH) is an exception, and public access is allowed on this port. You can change this by updating BlockPublicSecurityGroupRules to remove the exception.

    For accounts that created clusters in a Region before November 25, 2019, block public access is disabled by default in that Region. To use this feature, you must manually enable and configure it. For accounts that did not create an EMR cluster in a Region before this date, block public access is enabled by default in that Region.

Returns:

  • (Struct)

    Returns an empty response.

See Also:

#put_managed_scaling_policy(options = {}) ⇒ Struct

Creates or updates a managed scaling policy for an Amazon EMR cluster. The managed scaling policy defines the limits for resources, such as EC2 instances that can be added or terminated from a cluster. The policy only applies to the core and task nodes. The master node cannot be scaled after initial configuration.

Examples:

Request syntax with placeholder values


resp = client.put_managed_scaling_policy({
  cluster_id: "ClusterId", # required
  managed_scaling_policy: { # required
    compute_limits: {
      unit_type: "InstanceFleetUnits", # required, accepts InstanceFleetUnits, Instances, VCPU
      minimum_capacity_units: 1, # required
      maximum_capacity_units: 1, # required
      maximum_on_demand_capacity_units: 1,
      maximum_core_capacity_units: 1,
    },
  },
})

Options Hash (options):

  • :cluster_id (required, String)

    Specifies the ID of an EMR cluster where the managed scaling policy is attached.

  • :managed_scaling_policy (required, Types::ManagedScalingPolicy)

    Specifies the constraints for the managed scaling policy.

Returns:

  • (Struct)

    Returns an empty response.

See Also:

#remove_auto_scaling_policy(options = {}) ⇒ Struct

Removes an automatic scaling policy from a specified instance group within an EMR cluster.

Examples:

Request syntax with placeholder values


resp = client.remove_auto_scaling_policy({
  cluster_id: "ClusterId", # required
  instance_group_id: "InstanceGroupId", # required
})

Options Hash (options):

  • :cluster_id (required, String)

    Specifies the ID of a cluster. The instance group to which the automatic scaling policy is applied is within this cluster.

  • :instance_group_id (required, String)

    Specifies the ID of the instance group to which the scaling policy is applied.

Returns:

  • (Struct)

    Returns an empty response.

See Also:

#remove_managed_scaling_policy(options = {}) ⇒ Struct

Removes a managed scaling policy from a specified EMR cluster.

Examples:

Request syntax with placeholder values


resp = client.remove_managed_scaling_policy({
  cluster_id: "ClusterId", # required
})

Options Hash (options):

  • :cluster_id (required, String)

    Specifies the ID of the cluster from which the managed scaling policy will be removed.

Returns:

  • (Struct)

    Returns an empty response.

See Also:

#remove_tags(options = {}) ⇒ Struct

Removes tags from an Amazon EMR resource. Tags make it easier to associate clusters in various ways, such as grouping clusters to track your Amazon EMR resource allocation costs. For more information, see Tag Clusters.

The following example removes the stack tag with value Prod from a cluster:

Examples:

Request syntax with placeholder values


resp = client.remove_tags({
  resource_id: "ResourceId", # required
  tag_keys: ["String"], # required
})

Options Hash (options):

  • :resource_id (required, String)

    The Amazon EMR resource identifier from which tags will be removed. This value must be a cluster identifier.

  • :tag_keys (required, Array<String>)

    A list of tag keys to remove from a resource.

Returns:

  • (Struct)

    Returns an empty response.

See Also:

#run_job_flow(options = {}) ⇒ Types::RunJobFlowOutput

RunJobFlow creates and starts running a new cluster (job flow). The cluster runs the steps specified. After the steps complete, the cluster stops and the HDFS partition is lost. To prevent loss of data, configure the last step of the job flow to store results in Amazon S3. If the JobFlowInstancesConfig KeepJobFlowAliveWhenNoSteps parameter is set to TRUE, the cluster transitions to the WAITING state rather than shutting down after the steps have completed.

For additional protection, you can set the JobFlowInstancesConfig TerminationProtected parameter to TRUE to lock the cluster and prevent it from being terminated by API call, user intervention, or in the event of a job flow error.

A maximum of 256 steps are allowed in each job flow.

If your cluster is long-running (such as a Hive data warehouse) or complex, you may require more than 256 steps to process your data. You can bypass the 256-step limitation in various ways, including using the SSH shell to connect to the master node and submitting queries directly to the software running on the master node, such as Hive and Hadoop. For more information on how to do this, see Add More than 256 Steps to a Cluster in the Amazon EMR Management Guide.

For long running clusters, we recommend that you periodically store your results.

The instance fleets configuration is available only in Amazon EMR versions 4.8.0 and later, excluding 5.0.x versions. The RunJobFlow request can contain InstanceFleets parameters or InstanceGroups parameters, but not both.

Examples:

Request syntax with placeholder values


resp = client.run_job_flow({
  name: "XmlStringMaxLen256", # required
  log_uri: "XmlString",
  log_encryption_kms_key_id: "XmlString",
  additional_info: "XmlString",
  ami_version: "XmlStringMaxLen256",
  release_label: "XmlStringMaxLen256",
  instances: { # required
    master_instance_type: "InstanceType",
    slave_instance_type: "InstanceType",
    instance_count: 1,
    instance_groups: [
      {
        name: "XmlStringMaxLen256",
        market: "ON_DEMAND", # accepts ON_DEMAND, SPOT
        instance_role: "MASTER", # required, accepts MASTER, CORE, TASK
        bid_price: "XmlStringMaxLen256",
        instance_type: "InstanceType", # required
        instance_count: 1, # required
        configurations: [
          {
            classification: "String",
            configurations: {
              # recursive ConfigurationList
            },
            properties: {
              "String" => "String",
            },
          },
        ],
        ebs_configuration: {
          ebs_block_device_configs: [
            {
              volume_specification: { # required
                volume_type: "String", # required
                iops: 1,
                size_in_gb: 1, # required
              },
              volumes_per_instance: 1,
            },
          ],
          ebs_optimized: false,
        },
        auto_scaling_policy: {
          constraints: { # required
            min_capacity: 1, # required
            max_capacity: 1, # required
          },
          rules: [ # required
            {
              name: "String", # required
              description: "String",
              action: { # required
                market: "ON_DEMAND", # accepts ON_DEMAND, SPOT
                simple_scaling_policy_configuration: { # required
                  adjustment_type: "CHANGE_IN_CAPACITY", # accepts CHANGE_IN_CAPACITY, PERCENT_CHANGE_IN_CAPACITY, EXACT_CAPACITY
                  scaling_adjustment: 1, # required
                  cool_down: 1,
                },
              },
              trigger: { # required
                cloud_watch_alarm_definition: { # required
                  comparison_operator: "GREATER_THAN_OR_EQUAL", # required, accepts GREATER_THAN_OR_EQUAL, GREATER_THAN, LESS_THAN, LESS_THAN_OR_EQUAL
                  evaluation_periods: 1,
                  metric_name: "String", # required
                  namespace: "String",
                  period: 1, # required
                  statistic: "SAMPLE_COUNT", # accepts SAMPLE_COUNT, AVERAGE, SUM, MINIMUM, MAXIMUM
                  threshold: 1.0, # required
                  unit: "NONE", # accepts NONE, SECONDS, MICRO_SECONDS, MILLI_SECONDS, BYTES, KILO_BYTES, MEGA_BYTES, GIGA_BYTES, TERA_BYTES, BITS, KILO_BITS, MEGA_BITS, GIGA_BITS, TERA_BITS, PERCENT, COUNT, BYTES_PER_SECOND, KILO_BYTES_PER_SECOND, MEGA_BYTES_PER_SECOND, GIGA_BYTES_PER_SECOND, TERA_BYTES_PER_SECOND, BITS_PER_SECOND, KILO_BITS_PER_SECOND, MEGA_BITS_PER_SECOND, GIGA_BITS_PER_SECOND, TERA_BITS_PER_SECOND, COUNT_PER_SECOND
                  dimensions: [
                    {
                      key: "String",
                      value: "String",
                    },
                  ],
                },
              },
            },
          ],
        },
      },
    ],
    instance_fleets: [
      {
        name: "XmlStringMaxLen256",
        instance_fleet_type: "MASTER", # required, accepts MASTER, CORE, TASK
        target_on_demand_capacity: 1,
        target_spot_capacity: 1,
        instance_type_configs: [
          {
            instance_type: "InstanceType", # required
            weighted_capacity: 1,
            bid_price: "XmlStringMaxLen256",
            bid_price_as_percentage_of_on_demand_price: 1.0,
            ebs_configuration: {
              ebs_block_device_configs: [
                {
                  volume_specification: { # required
                    volume_type: "String", # required
                    iops: 1,
                    size_in_gb: 1, # required
                  },
                  volumes_per_instance: 1,
                },
              ],
              ebs_optimized: false,
            },
            configurations: [
              {
                classification: "String",
                configurations: {
                  # recursive ConfigurationList
                },
                properties: {
                  "String" => "String",
                },
              },
            ],
          },
        ],
        launch_specifications: {
          spot_specification: {
            timeout_duration_minutes: 1, # required
            timeout_action: "SWITCH_TO_ON_DEMAND", # required, accepts SWITCH_TO_ON_DEMAND, TERMINATE_CLUSTER
            block_duration_minutes: 1,
            allocation_strategy: "capacity-optimized", # accepts capacity-optimized
          },
          on_demand_specification: {
            allocation_strategy: "lowest-price", # required, accepts lowest-price
          },
        },
      },
    ],
    ec2_key_name: "XmlStringMaxLen256",
    placement: {
      availability_zone: "XmlString",
      availability_zones: ["XmlStringMaxLen256"],
    },
    keep_job_flow_alive_when_no_steps: false,
    termination_protected: false,
    hadoop_version: "XmlStringMaxLen256",
    ec2_subnet_id: "XmlStringMaxLen256",
    ec2_subnet_ids: ["XmlStringMaxLen256"],
    emr_managed_master_security_group: "XmlStringMaxLen256",
    emr_managed_slave_security_group: "XmlStringMaxLen256",
    service_access_security_group: "XmlStringMaxLen256",
    additional_master_security_groups: ["XmlStringMaxLen256"],
    additional_slave_security_groups: ["XmlStringMaxLen256"],
  },
  steps: [
    {
      name: "XmlStringMaxLen256", # required
      action_on_failure: "TERMINATE_JOB_FLOW", # accepts TERMINATE_JOB_FLOW, TERMINATE_CLUSTER, CANCEL_AND_WAIT, CONTINUE
      hadoop_jar_step: { # required
        properties: [
          {
            key: "XmlString",
            value: "XmlString",
          },
        ],
        jar: "XmlString", # required
        main_class: "XmlString",
        args: ["XmlString"],
      },
    },
  ],
  bootstrap_actions: [
    {
      name: "XmlStringMaxLen256", # required
      script_bootstrap_action: { # required
        path: "XmlString", # required
        args: ["XmlString"],
      },
    },
  ],
  supported_products: ["XmlStringMaxLen256"],
  new_supported_products: [
    {
      name: "XmlStringMaxLen256",
      args: ["XmlString"],
    },
  ],
  applications: [
    {
      name: "String",
      version: "String",
      args: ["String"],
      additional_info: {
        "String" => "String",
      },
    },
  ],
  configurations: [
    {
      classification: "String",
      configurations: {
        # recursive ConfigurationList
      },
      properties: {
        "String" => "String",
      },
    },
  ],
  visible_to_all_users: false,
  job_flow_role: "XmlString",
  service_role: "XmlString",
  tags: [
    {
      key: "String",
      value: "String",
    },
  ],
  security_configuration: "XmlString",
  auto_scaling_role: "XmlString",
  scale_down_behavior: "TERMINATE_AT_INSTANCE_HOUR", # accepts TERMINATE_AT_INSTANCE_HOUR, TERMINATE_AT_TASK_COMPLETION
  custom_ami_id: "XmlStringMaxLen256",
  ebs_root_volume_size: 1,
  repo_upgrade_on_boot: "SECURITY", # accepts SECURITY, NONE
  kerberos_attributes: {
    realm: "XmlStringMaxLen256", # required
    kdc_admin_password: "XmlStringMaxLen256", # required
    cross_realm_trust_principal_password: "XmlStringMaxLen256",
    ad_domain_join_user: "XmlStringMaxLen256",
    ad_domain_join_password: "XmlStringMaxLen256",
  },
  step_concurrency_level: 1,
  managed_scaling_policy: {
    compute_limits: {
      unit_type: "InstanceFleetUnits", # required, accepts InstanceFleetUnits, Instances, VCPU
      minimum_capacity_units: 1, # required
      maximum_capacity_units: 1, # required
      maximum_on_demand_capacity_units: 1,
      maximum_core_capacity_units: 1,
    },
  },
  placement_group_configs: [
    {
      instance_role: "MASTER", # required, accepts MASTER, CORE, TASK
      placement_strategy: "SPREAD", # accepts SPREAD, PARTITION, CLUSTER, NONE
    },
  ],
})

Response structure


resp.job_flow_id #=> String
resp.cluster_arn #=> String

Options Hash (options):

  • :name (required, String)

    The name of the job flow.

  • :log_uri (String)

    The location in Amazon S3 to write the log files of the job flow. If a value is not provided, logs are not created.

  • :log_encryption_kms_key_id (String)

    The AWS KMS customer master key (CMK) used for encrypting log files. If a value is not provided, the logs will remain encrypted by AES-256. This attribute is only available with EMR version 5.30.0 and later, excluding EMR 6.0.0.

  • :additional_info (String)

    A JSON string for selecting additional features.

  • :ami_version (String)

    Applies only to Amazon EMR AMI versions 3.x and 2.x. For Amazon EMR releases 4.0 and later, ReleaseLabel is used. To specify a custom AMI, use CustomAmiID.

  • :release_label (String)

    The Amazon EMR release label, which determines the version of open-source application packages installed on the cluster. Release labels are in the form emr-x.x.x, where x.x.x is an Amazon EMR release version such as emr-5.14.0. For more information about Amazon EMR release versions and included application versions and features, see https://docs.aws.amazon.com/emr/latest/ReleaseGuide/. The release label applies only to Amazon EMR releases version 4.0 and later. Earlier versions use AmiVersion.

  • :instances (required, Types::JobFlowInstancesConfig)

    A specification of the number and type of Amazon EC2 instances.

  • :steps (Array<Types::StepConfig>)

    A list of steps to run.

  • :bootstrap_actions (Array<Types::BootstrapActionConfig>)

    A list of bootstrap actions to run before Hadoop starts on the cluster nodes.

  • :supported_products (Array<String>)

    For Amazon EMR releases 3.x and 2.x. For Amazon EMR releases 4.x and later, use Applications.

    A list of strings that indicates third-party software to use. For more information, see the Amazon EMR Developer Guide. Currently supported values are:

    • \"mapr-m3\" - launch the job flow using MapR M3 Edition.

    • \"mapr-m5\" - launch the job flow using MapR M5 Edition.

  • :new_supported_products (Array<Types::SupportedProductConfig>)

    For Amazon EMR releases 3.x and 2.x. For Amazon EMR releases 4.x and later, use Applications.

    A list of strings that indicates third-party software to use with the job flow that accepts a user argument list. EMR accepts and forwards the argument list to the corresponding installation script as bootstrap action arguments. For more information, see \"Launch a Job Flow on the MapR Distribution for Hadoop\" in the Amazon EMR Developer Guide. Supported values are:

    • \"mapr-m3\" - launch the cluster using MapR M3 Edition.

    • \"mapr-m5\" - launch the cluster using MapR M5 Edition.

    • \"mapr\" with the user arguments specifying \"--edition,m3\" or \"--edition,m5\" - launch the job flow using MapR M3 or M5 Edition respectively.

    • \"mapr-m7\" - launch the cluster using MapR M7 Edition.

    • \"hunk\" - launch the cluster with the Hunk Big Data Analtics Platform.

    • \"hue\"- launch the cluster with Hue installed.

    • \"spark\" - launch the cluster with Apache Spark installed.

    • \"ganglia\" - launch the cluster with the Ganglia Monitoring System installed.

  • :applications (Array<Types::Application>)

    Applies to Amazon EMR releases 4.0 and later. A case-insensitive list of applications for Amazon EMR to install and configure when launching the cluster. For a list of applications available for each Amazon EMR release version, see the Amazon EMR Release Guide.

  • :configurations (Array<Types::Configuration>)

    For Amazon EMR releases 4.0 and later. The list of configurations supplied for the EMR cluster you are creating.

  • :visible_to_all_users (Boolean)

    A value of true indicates that all IAM users in the AWS account can perform cluster actions if they have the proper IAM policy permissions. This is the default. A value of false indicates that only the IAM user who created the cluster can perform actions.

  • :job_flow_role (String)

    Also called instance profile and EC2 role. An IAM role for an EMR cluster. The EC2 instances of the cluster assume this role. The default role is EMR_EC2_DefaultRole. In order to use the default role, you must have already created it using the CLI or console.

  • :service_role (String)

    The IAM role that will be assumed by the Amazon EMR service to access AWS resources on your behalf.

  • :tags (Array<Types::Tag>)

    A list of tags to associate with a cluster and propagate to Amazon EC2 instances.

  • :security_configuration (String)

    The name of a security configuration to apply to the cluster.

  • :auto_scaling_role (String)

    An IAM role for automatic scaling policies. The default role is EMR_AutoScaling_DefaultRole. The IAM role provides permissions that the automatic scaling feature requires to launch and terminate EC2 instances in an instance group.

  • :scale_down_behavior (String)

    Specifies the way that individual Amazon EC2 instances terminate when an automatic scale-in activity occurs or an instance group is resized. TERMINATE_AT_INSTANCE_HOUR indicates that Amazon EMR terminates nodes at the instance-hour boundary, regardless of when the request to terminate the instance was submitted. This option is only available with Amazon EMR 5.1.0 and later and is the default for clusters created using that version. TERMINATE_AT_TASK_COMPLETION indicates that Amazon EMR blacklists and drains tasks from nodes before terminating the Amazon EC2 instances, regardless of the instance-hour boundary. With either behavior, Amazon EMR removes the least active nodes first and blocks instance termination if it could lead to HDFS corruption. TERMINATE_AT_TASK_COMPLETION available only in Amazon EMR version 4.1.0 and later, and is the default for versions of Amazon EMR earlier than 5.1.0.

  • :custom_ami_id (String)

    Available only in Amazon EMR version 5.7.0 and later. The ID of a custom Amazon EBS-backed Linux AMI. If specified, Amazon EMR uses this AMI when it launches cluster EC2 instances. For more information about custom AMIs in Amazon EMR, see Using a Custom AMI in the Amazon EMR Management Guide. If omitted, the cluster uses the base Linux AMI for the ReleaseLabel specified. For Amazon EMR versions 2.x and 3.x, use AmiVersion instead.

    For information about creating a custom AMI, see Creating an Amazon EBS-Backed Linux AMI in the Amazon Elastic Compute Cloud User Guide for Linux Instances. For information about finding an AMI ID, see Finding a Linux AMI.

  • :ebs_root_volume_size (Integer)

    The size, in GiB, of the EBS root device volume of the Linux AMI that is used for each EC2 instance. Available in Amazon EMR version 4.x and later.

  • :repo_upgrade_on_boot (String)

    Applies only when CustomAmiID is used. Specifies which updates from the Amazon Linux AMI package repositories to apply automatically when the instance boots using the AMI. If omitted, the default is SECURITY, which indicates that only security updates are applied. If NONE is specified, no updates are applied, and all updates must be applied manually.

  • :kerberos_attributes (Types::KerberosAttributes)

    Attributes for Kerberos configuration when Kerberos authentication is enabled using a security configuration. For more information see Use Kerberos Authentication in the EMR Management Guide.

  • :step_concurrency_level (Integer)

    Specifies the number of steps that can be executed concurrently. The default value is 1. The maximum value is 256.

  • :managed_scaling_policy (Types::ManagedScalingPolicy)

    The specified managed scaling policy for an Amazon EMR cluster.

  • :placement_group_configs (Array<Types::PlacementGroupConfig>)

    The specified placement group configuration for an Amazon EMR cluster.

Returns:

See Also:

#set_termination_protection(options = {}) ⇒ Struct

SetTerminationProtection locks a cluster (job flow) so the EC2 instances in the cluster cannot be terminated by user intervention, an API call, or in the event of a job-flow error. The cluster still terminates upon successful completion of the job flow. Calling SetTerminationProtection on a cluster is similar to calling the Amazon EC2 DisableAPITermination API on all EC2 instances in a cluster.

SetTerminationProtection is used to prevent accidental termination of a cluster and to ensure that in the event of an error, the instances persist so that you can recover any data stored in their ephemeral instance storage.

To terminate a cluster that has been locked by setting SetTerminationProtection to true, you must first unlock the job flow by a subsequent call to SetTerminationProtection in which you set the value to false.

For more information, seeManaging Cluster Termination in the Amazon EMR Management Guide.

Examples:

Request syntax with placeholder values


resp = client.set_termination_protection({
  job_flow_ids: ["XmlString"], # required
  termination_protected: false, # required
})

Options Hash (options):

  • :job_flow_ids (required, Array<String>)

    A list of strings that uniquely identify the clusters to protect. This identifier is returned by RunJobFlow and can also be obtained from DescribeJobFlows .

  • :termination_protected (required, Boolean)

    A Boolean that indicates whether to protect the cluster and prevent the Amazon EC2 instances in the cluster from shutting down due to API calls, user intervention, or job-flow error.

Returns:

  • (Struct)

    Returns an empty response.

See Also:

#set_visible_to_all_users(options = {}) ⇒ Struct

Sets the Cluster$VisibleToAllUsers value, which determines whether the cluster is visible to all IAM users of the AWS account associated with the cluster. Only the IAM user who created the cluster or the AWS account root user can call this action. The default value, true, indicates that all IAM users in the AWS account can perform cluster actions if they have the proper IAM policy permissions. If set to false, only the IAM user that created the cluster can perform actions. This action works on running clusters. You can override the default true setting when you create a cluster by using the VisibleToAllUsers parameter with RunJobFlow.

Examples:

Request syntax with placeholder values


resp = client.set_visible_to_all_users({
  job_flow_ids: ["XmlString"], # required
  visible_to_all_users: false, # required
})

Options Hash (options):

  • :job_flow_ids (required, Array<String>)

    The unique identifier of the job flow (cluster).

  • :visible_to_all_users (required, Boolean)

    A value of true indicates that all IAM users in the AWS account can perform cluster actions if they have the proper IAM policy permissions. This is the default. A value of false indicates that only the IAM user who created the cluster can perform actions.

Returns:

  • (Struct)

    Returns an empty response.

See Also:

#start_notebook_execution(options = {}) ⇒ Types::StartNotebookExecutionOutput

Starts a notebook execution.

Examples:

Request syntax with placeholder values


resp = client.start_notebook_execution({
  editor_id: "XmlStringMaxLen256", # required
  relative_path: "XmlString", # required
  notebook_execution_name: "XmlStringMaxLen256",
  notebook_params: "XmlString",
  execution_engine: { # required
    id: "XmlStringMaxLen256", # required
    type: "EMR", # accepts EMR
    master_instance_security_group_id: "XmlStringMaxLen256",
  },
  service_role: "XmlString", # required
  notebook_instance_security_group_id: "XmlStringMaxLen256",
  tags: [
    {
      key: "String",
      value: "String",
    },
  ],
})

Response structure


resp.notebook_execution_id #=> String

Options Hash (options):

  • :editor_id (required, String)

    The unique identifier of the EMR Notebook to use for notebook execution.

  • :relative_path (required, String)

    The path and file name of the notebook file for this execution, relative to the path specified for the EMR Notebook. For example, if you specify a path of s3://MyBucket/MyNotebooks when you create an EMR Notebook for a notebook with an ID of e-ABCDEFGHIJK1234567890ABCD (the EditorID of this request), and you specify a RelativePath of my_notebook_executions/notebook_execution.ipynb, the location of the file for the notebook execution is s3://MyBucket/MyNotebooks/e-ABCDEFGHIJK1234567890ABCD/my_notebook_executions/notebook_execution.ipynb.

  • :notebook_execution_name (String)

    An optional name for the notebook execution.

  • :notebook_params (String)

    Input parameters in JSON format passed to the EMR Notebook at runtime for execution.

  • :execution_engine (required, Types::ExecutionEngineConfig)

    Specifies the execution engine (cluster) that runs the notebook execution.

  • :service_role (required, String)

    The name or ARN of the IAM role that is used as the service role for Amazon EMR (the EMR role) for the notebook execution.

  • :notebook_instance_security_group_id (String)

    The unique identifier of the Amazon EC2 security group to associate with the EMR Notebook for this notebook execution.

  • :tags (Array<Types::Tag>)

    A list of tags associated with a notebook execution. Tags are user-defined key value pairs that consist of a required key string with a maximum of 128 characters and an optional value string with a maximum of 256 characters.

Returns:

See Also:

#stop_notebook_execution(options = {}) ⇒ Struct

Stops a notebook execution.

Examples:

Request syntax with placeholder values


resp = client.stop_notebook_execution({
  notebook_execution_id: "XmlStringMaxLen256", # required
})

Options Hash (options):

  • :notebook_execution_id (required, String)

    The unique identifier of the notebook execution.

Returns:

  • (Struct)

    Returns an empty response.

See Also:

#terminate_job_flows(options = {}) ⇒ Struct

TerminateJobFlows shuts a list of clusters (job flows) down. When a job flow is shut down, any step not yet completed is canceled and the EC2 instances on which the cluster is running are stopped. Any log files not already saved are uploaded to Amazon S3 if a LogUri was specified when the cluster was created.

The maximum number of clusters allowed is 10. The call to TerminateJobFlows is asynchronous. Depending on the configuration of the cluster, it may take up to 1-5 minutes for the cluster to completely terminate and release allocated resources, such as Amazon EC2 instances.

Examples:

Request syntax with placeholder values


resp = client.terminate_job_flows({
  job_flow_ids: ["XmlString"], # required
})

Options Hash (options):

  • :job_flow_ids (required, Array<String>)

    A list of job flows to be shutdown.

Returns:

  • (Struct)

    Returns an empty response.

See Also:

#wait_until(waiter_name, params = {}) {|waiter| ... } ⇒ Boolean

Waiters polls an API operation until a resource enters a desired state.

Basic Usage

Waiters will poll until they are succesful, they fail by entering a terminal state, or until a maximum number of attempts are made.

# polls in a loop, sleeping between attempts client.waiter_until(waiter_name, params)

Configuration

You can configure the maximum number of polling attempts, and the delay (in seconds) between each polling attempt. You configure waiters by passing a block to #wait_until:

# poll for ~25 seconds
client.wait_until(...) do |w|
  w.max_attempts = 5
  w.delay = 5
end

Callbacks

You can be notified before each polling attempt and before each delay. If you throw :success or :failure from these callbacks, it will terminate the waiter.

started_at = Time.now
client.wait_until(...) do |w|

  # disable max attempts
  w.max_attempts = nil

  # poll for 1 hour, instead of a number of attempts
  w.before_wait do |attempts, response|
    throw :failure if Time.now - started_at > 3600
  end

end

Handling Errors

When a waiter is successful, it returns true. When a waiter fails, it raises an error. All errors raised extend from Waiters::Errors::WaiterFailed.

begin
  client.wait_until(...)
rescue Aws::Waiters::Errors::WaiterFailed
  # resource did not enter the desired state in time
end

Parameters:

  • waiter_name (Symbol)

    The name of the waiter. See #waiter_names for a full list of supported waiters.

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

    Additional request parameters. See the #waiter_names for a list of supported waiters and what request they call. The called request determines the list of accepted parameters.

Yield Parameters:

Returns:

  • (Boolean)

    Returns true if the waiter was successful.

Raises:

  • (Errors::FailureStateError)

    Raised when the waiter terminates because the waiter has entered a state that it will not transition out of, preventing success.

  • (Errors::TooManyAttemptsError)

    Raised when the configured maximum number of attempts have been made, and the waiter is not yet successful.

  • (Errors::UnexpectedError)

    Raised when an error is encounted while polling for a resource that is not expected.

  • (Errors::NoSuchWaiterError)

    Raised when you request to wait for an unknown state.

#waiter_namesArray<Symbol>

Returns the list of supported waiters. The following table lists the supported waiters and the client method they call:

Waiter NameClient MethodDefault Delay:Default Max Attempts:
:cluster_running#describe_cluster3060
:cluster_terminated#describe_cluster3060
:step_complete#describe_step3060

Returns:

  • (Array<Symbol>)

    the list of supported waiters.