Amazon Elastic MapReduce

2016/02/16 - Amazon Elastic MapReduce - 4 updated api methods

AddInstanceGroups (updated) Link ¶
Changes (request)
{'InstanceGroups': {'EbsConfiguration': {'EbsBlockDeviceConfigs': [{'VolumeSpecification': {'Iops': 'integer',
                                                                                            'SizeInGB': 'integer',
                                                                                            'VolumeType': 'string'},
                                                                    'VolumesPerInstance': 'integer'}],
                                         'EbsOptimized': 'boolean'}}}

AddInstanceGroups adds an instance group to a running cluster.

Request Syntax

client.add_instance_groups(
    InstanceGroups=[
        {
            'Name': 'string',
            'Market': 'ON_DEMAND'|'SPOT',
            'InstanceRole': 'MASTER'|'CORE'|'TASK',
            'BidPrice': 'string',
            'InstanceType': 'string',
            'InstanceCount': 123,
            'Configurations': [
                {
                    'Classification': 'string',
                    'Configurations': {'... recursive ...'},
                    'Properties': {
                        'string': 'string'
                    }
                },
            ],
            'EbsConfiguration': {
                'EbsBlockDeviceConfigs': [
                    {
                        'VolumeSpecification': {
                            'VolumeType': 'string',
                            'Iops': 123,
                            'SizeInGB': 123
                        },
                        'VolumesPerInstance': 123
                    },
                ],
                'EbsOptimized': True|False
            }
        },
    ],
    JobFlowId='string'
)
type InstanceGroups

list

param InstanceGroups

[REQUIRED]

Instance Groups to add.

  • (dict) --

    Configuration defining a new instance group.

    • Name (string) --

      Friendly name given to the instance group.

    • Market (string) --

      Market type of the Amazon EC2 instances used to create a cluster node.

    • InstanceRole (string) -- [REQUIRED]

      The role of the instance group in the cluster.

    • BidPrice (string) --

      Bid price for each Amazon EC2 instance in the instance group when launching nodes as Spot Instances, expressed in USD.

    • InstanceType (string) -- [REQUIRED]

      The Amazon EC2 instance type for all instances in the instance group.

    • InstanceCount (integer) -- [REQUIRED]

      Target number of instances for the instance group.

    • Configurations (list) --

      Note

      Amazon EMR releases 4.x or later.

      The list of configurations supplied for an EMR cluster instance group. You can specify a separate configuration for each instance group (master, core, and task).

      • (dict) --

        Note

        Amazon EMR releases 4.x or later.

        Specifies a hardware and software configuration of the EMR cluster. This includes configurations for applications and software bundled with Amazon EMR. The Configuration object is a JSON object which is defined by a classification and a set of properties. Configurations can be nested, so a configuration may have its own Configuration objects listed.

        • Classification (string) --

          The classification of a configuration. For more information see, Amazon EMR Configurations.

        • Configurations (list) --

          A list of configurations you apply to this configuration object.

        • Properties (dict) --

          A set of properties supplied to the Configuration object.

          • (string) --

            • (string) --

    • EbsConfiguration (dict) --

      EBS configurations that will be attached to each Amazon EC2 instance in the instance group.

      • EbsBlockDeviceConfigs (list) --

        • (dict) --

          Configuration of requested EBS block device associated with the instance group with count of volumes that will be associated to every instance.

          • VolumeSpecification (dict) -- [REQUIRED]

            EBS volume specifications such as volume type, IOPS, and size(GiB) that will be requested for the EBS volume attached to an EC2 instance in the cluster.

            • VolumeType (string) -- [REQUIRED]

              The volume type. Volume types supported are gp2, io1, standard.

            • Iops (integer) --

              The number of I/O operations per second (IOPS) that the volume supports.

            • SizeInGB (integer) -- [REQUIRED]

              The volume size, in gibibytes (GiB). This can be a number from 1 – 1024. If the volume type is EBS-optimized, the minimum value is 10.

          • VolumesPerInstance (integer) --

            Number of EBS volumes with specific volume configuration, that will be associated with every instance in the instance group

      • EbsOptimized (boolean) --

type JobFlowId

string

param JobFlowId

[REQUIRED]

Job flow in which to add the instance groups.

rtype

dict

returns

Response Syntax

{
    'JobFlowId': 'string',
    'InstanceGroupIds': [
        'string',
    ]
}

Response Structure

  • (dict) --

    Output from an AddInstanceGroups call.

    • JobFlowId (string) --

      The job flow ID in which the instance groups are added.

    • InstanceGroupIds (list) --

      Instance group IDs of the newly created instance groups.

      • (string) --

ListInstanceGroups (updated) Link ¶
Changes (response)
{'InstanceGroups': {'EbsBlockDevices': [{'Device': 'string',
                                         'VolumeSpecification': {'Iops': 'integer',
                                                                 'SizeInGB': 'integer',
                                                                 'VolumeType': 'string'}}],
                    'EbsOptimized': 'boolean'}}

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

Request Syntax

client.list_instance_groups(
    ClusterId='string',
    Marker='string'
)
type ClusterId

string

param ClusterId

[REQUIRED]

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

type Marker

string

param Marker

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

rtype

dict

returns

Response Syntax

{
    'InstanceGroups': [
        {
            'Id': 'string',
            'Name': 'string',
            'Market': 'ON_DEMAND'|'SPOT',
            'InstanceGroupType': 'MASTER'|'CORE'|'TASK',
            'BidPrice': 'string',
            'InstanceType': 'string',
            'RequestedInstanceCount': 123,
            'RunningInstanceCount': 123,
            'Status': {
                'State': 'PROVISIONING'|'BOOTSTRAPPING'|'RUNNING'|'RESIZING'|'SUSPENDED'|'TERMINATING'|'TERMINATED'|'ARRESTED'|'SHUTTING_DOWN'|'ENDED',
                'StateChangeReason': {
                    'Code': 'INTERNAL_ERROR'|'VALIDATION_ERROR'|'INSTANCE_FAILURE'|'CLUSTER_TERMINATED',
                    'Message': 'string'
                },
                'Timeline': {
                    'CreationDateTime': datetime(2015, 1, 1),
                    'ReadyDateTime': datetime(2015, 1, 1),
                    'EndDateTime': datetime(2015, 1, 1)
                }
            },
            'Configurations': [
                {
                    'Classification': 'string',
                    'Configurations': {'... recursive ...'},
                    'Properties': {
                        'string': 'string'
                    }
                },
            ],
            'EbsBlockDevices': [
                {
                    'VolumeSpecification': {
                        'VolumeType': 'string',
                        'Iops': 123,
                        'SizeInGB': 123
                    },
                    'Device': 'string'
                },
            ],
            'EbsOptimized': True|False
        },
    ],
    'Marker': 'string'
}

Response Structure

  • (dict) --

    This input determines which instance groups to retrieve.

    • InstanceGroups (list) --

      The list of instance groups for the cluster and given filters.

      • (dict) --

        This entity represents an instance group, which is a group of instances that have common purpose. For example, CORE instance group is used for HDFS.

        • Id (string) --

          The identifier of the instance group.

        • Name (string) --

          The name of the instance group.

        • Market (string) --

          The marketplace to provision instances for this group. Valid values are ON_DEMAND or SPOT.

        • InstanceGroupType (string) --

          The type of the instance group. Valid values are MASTER, CORE or TASK.

        • BidPrice (string) --

          The bid price for each EC2 instance in the instance group when launching nodes as Spot Instances, expressed in USD.

        • InstanceType (string) --

          The EC2 instance type for all instances in the instance group.

        • RequestedInstanceCount (integer) --

          The target number of instances for the instance group.

        • RunningInstanceCount (integer) --

          The number of instances currently running in this instance group.

        • Status (dict) --

          The current status of the instance group.

          • State (string) --

            The current state of the instance group.

          • StateChangeReason (dict) --

            The status change reason details for the instance group.

            • Code (string) --

              The programmable code for the state change reason.

            • Message (string) --

              The status change reason description.

          • Timeline (dict) --

            The timeline of the instance group status over time.

            • CreationDateTime (datetime) --

              The creation date and time of the instance group.

            • ReadyDateTime (datetime) --

              The date and time when the instance group became ready to perform tasks.

            • EndDateTime (datetime) --

              The date and time when the instance group terminated.

        • Configurations (list) --

          Note

          Amazon EMR releases 4.x or later.

          The list of configurations supplied for an EMR cluster instance group. You can specify a separate configuration for each instance group (master, core, and task).

          • (dict) --

            Note

            Amazon EMR releases 4.x or later.

            Specifies a hardware and software configuration of the EMR cluster. This includes configurations for applications and software bundled with Amazon EMR. The Configuration object is a JSON object which is defined by a classification and a set of properties. Configurations can be nested, so a configuration may have its own Configuration objects listed.

            • Classification (string) --

              The classification of a configuration. For more information see, Amazon EMR Configurations.

            • Configurations (list) --

              A list of configurations you apply to this configuration object.

            • Properties (dict) --

              A set of properties supplied to the Configuration object.

              • (string) --

                • (string) --

        • EbsBlockDevices (list) --

          The EBS block devices that are mapped to this instance group.

          • (dict) --

            Configuration of requested EBS block device associated with the instance group.

            • VolumeSpecification (dict) --

              EBS volume specifications such as volume type, IOPS, and size(GiB) that will be requested for the EBS volume attached to an EC2 instance in the cluster.

              • VolumeType (string) --

                The volume type. Volume types supported are gp2, io1, standard.

              • Iops (integer) --

                The number of I/O operations per second (IOPS) that the volume supports.

              • SizeInGB (integer) --

                The volume size, in gibibytes (GiB). This can be a number from 1 – 1024. If the volume type is EBS-optimized, the minimum value is 10.

            • Device (string) --

              The device name that is exposed to the instance, such as /dev/sdh.

        • EbsOptimized (boolean) --

          If the instance group is EBS-optimized. An Amazon EBS–optimized instance uses an optimized configuration stack and provides additional, dedicated capacity for Amazon EBS I/O.

    • Marker (string) --

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

ListInstances (updated) Link ¶
Changes (response)
{'Instances': {'EbsVolumes': [{'Device': 'string', 'VolumeId': 'string'}],
               'InstanceGroupId': 'string'}}

Provides information about the cluster instances that Amazon EMR provisions on behalf of a user when it creates the cluster. For example, this operation indicates when the EC2 instances reach the Ready state, when instances become available to Amazon EMR to use for jobs, and the IP addresses for cluster instances, etc.

Request Syntax

client.list_instances(
    ClusterId='string',
    InstanceGroupId='string',
    InstanceGroupTypes=[
        'MASTER'|'CORE'|'TASK',
    ],
    Marker='string'
)
type ClusterId

string

param ClusterId

[REQUIRED]

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

type InstanceGroupId

string

param InstanceGroupId

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

type InstanceGroupTypes

list

param InstanceGroupTypes

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

  • (string) --

type Marker

string

param Marker

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

rtype

dict

returns

Response Syntax

{
    'Instances': [
        {
            'Id': 'string',
            'Ec2InstanceId': 'string',
            'PublicDnsName': 'string',
            'PublicIpAddress': 'string',
            'PrivateDnsName': 'string',
            'PrivateIpAddress': 'string',
            'Status': {
                'State': 'AWAITING_FULFILLMENT'|'PROVISIONING'|'BOOTSTRAPPING'|'RUNNING'|'TERMINATED',
                'StateChangeReason': {
                    'Code': 'INTERNAL_ERROR'|'VALIDATION_ERROR'|'INSTANCE_FAILURE'|'BOOTSTRAP_FAILURE'|'CLUSTER_TERMINATED',
                    'Message': 'string'
                },
                'Timeline': {
                    'CreationDateTime': datetime(2015, 1, 1),
                    'ReadyDateTime': datetime(2015, 1, 1),
                    'EndDateTime': datetime(2015, 1, 1)
                }
            },
            'InstanceGroupId': 'string',
            'EbsVolumes': [
                {
                    'Device': 'string',
                    'VolumeId': 'string'
                },
            ]
        },
    ],
    'Marker': 'string'
}

Response Structure

  • (dict) --

    This output contains the list of instances.

    • Instances (list) --

      The list of instances for the cluster and given filters.

      • (dict) --

        Represents an EC2 instance provisioned as part of cluster.

        • Id (string) --

          The unique identifier for the instance in Amazon EMR.

        • Ec2InstanceId (string) --

          The unique identifier of the instance in Amazon EC2.

        • PublicDnsName (string) --

          The public DNS name of the instance.

        • PublicIpAddress (string) --

          The public IP address of the instance.

        • PrivateDnsName (string) --

          The private DNS name of the instance.

        • PrivateIpAddress (string) --

          The private IP address of the instance.

        • Status (dict) --

          The current status of the instance.

          • State (string) --

            The current state of the instance.

          • StateChangeReason (dict) --

            The details of the status change reason for the instance.

            • Code (string) --

              The programmable code for the state change reason.

            • Message (string) --

              The status change reason description.

          • Timeline (dict) --

            The timeline of the instance status over time.

            • CreationDateTime (datetime) --

              The creation date and time of the instance.

            • ReadyDateTime (datetime) --

              The date and time when the instance was ready to perform tasks.

            • EndDateTime (datetime) --

              The date and time when the instance was terminated.

        • InstanceGroupId (string) --

          The identifier of the instance group to which this instance belongs.

        • EbsVolumes (list) --

          The list of EBS volumes that are attached to this instance.

          • (dict) --

            EBS block device that's attached to an EC2 instance.

            • Device (string) --

              The device name that is exposed to the instance, such as /dev/sdh.

            • VolumeId (string) --

              The volume identifier of the EBS volume.

    • Marker (string) --

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

RunJobFlow (updated) Link ¶
Changes (request)
{'Instances': {'InstanceGroups': {'EbsConfiguration': {'EbsBlockDeviceConfigs': [{'VolumeSpecification': {'Iops': 'integer',
                                                                                                          'SizeInGB': 'integer',
                                                                                                          'VolumeType': 'string'},
                                                                                  'VolumesPerInstance': 'integer'}],
                                                       'EbsOptimized': 'boolean'}}}}

RunJobFlow creates and starts running a new job flow. The job flow will run the steps specified. Once the job flow completes, the cluster is stopped 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 job flow will transition to the WAITING state rather than shutting down once the steps have completed.

For additional protection, you can set the JobFlowInstancesConfig TerminationProtected parameter to TRUE to lock the job flow 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 job flow 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, go to Add More than 256 Steps to a Job Flow in the Amazon Elastic MapReduce Developer's Guide .

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

Request Syntax

client.run_job_flow(
    Name='string',
    LogUri='string',
    AdditionalInfo='string',
    AmiVersion='string',
    ReleaseLabel='string',
    Instances={
        'MasterInstanceType': 'string',
        'SlaveInstanceType': 'string',
        'InstanceCount': 123,
        'InstanceGroups': [
            {
                'Name': 'string',
                'Market': 'ON_DEMAND'|'SPOT',
                'InstanceRole': 'MASTER'|'CORE'|'TASK',
                'BidPrice': 'string',
                'InstanceType': 'string',
                'InstanceCount': 123,
                'Configurations': [
                    {
                        'Classification': 'string',
                        'Configurations': {'... recursive ...'},
                        'Properties': {
                            'string': 'string'
                        }
                    },
                ],
                'EbsConfiguration': {
                    'EbsBlockDeviceConfigs': [
                        {
                            'VolumeSpecification': {
                                'VolumeType': 'string',
                                'Iops': 123,
                                'SizeInGB': 123
                            },
                            'VolumesPerInstance': 123
                        },
                    ],
                    'EbsOptimized': True|False
                }
            },
        ],
        'Ec2KeyName': 'string',
        'Placement': {
            'AvailabilityZone': 'string'
        },
        'KeepJobFlowAliveWhenNoSteps': True|False,
        'TerminationProtected': True|False,
        'HadoopVersion': 'string',
        'Ec2SubnetId': 'string',
        'EmrManagedMasterSecurityGroup': 'string',
        'EmrManagedSlaveSecurityGroup': 'string',
        'ServiceAccessSecurityGroup': 'string',
        'AdditionalMasterSecurityGroups': [
            'string',
        ],
        'AdditionalSlaveSecurityGroups': [
            'string',
        ]
    },
    Steps=[
        {
            'Name': 'string',
            'ActionOnFailure': 'TERMINATE_JOB_FLOW'|'TERMINATE_CLUSTER'|'CANCEL_AND_WAIT'|'CONTINUE',
            'HadoopJarStep': {
                'Properties': [
                    {
                        'Key': 'string',
                        'Value': 'string'
                    },
                ],
                'Jar': 'string',
                'MainClass': 'string',
                'Args': [
                    'string',
                ]
            }
        },
    ],
    BootstrapActions=[
        {
            'Name': 'string',
            'ScriptBootstrapAction': {
                'Path': 'string',
                'Args': [
                    'string',
                ]
            }
        },
    ],
    SupportedProducts=[
        'string',
    ],
    NewSupportedProducts=[
        {
            'Name': 'string',
            'Args': [
                'string',
            ]
        },
    ],
    Applications=[
        {
            'Name': 'string',
            'Version': 'string',
            'Args': [
                'string',
            ],
            'AdditionalInfo': {
                'string': 'string'
            }
        },
    ],
    Configurations=[
        {
            'Classification': 'string',
            'Configurations': {'... recursive ...'},
            'Properties': {
                'string': 'string'
            }
        },
    ],
    VisibleToAllUsers=True|False,
    JobFlowRole='string',
    ServiceRole='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)
type Name

string

param Name

[REQUIRED]

The name of the job flow.

type LogUri

string

param LogUri

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

type AdditionalInfo

string

param AdditionalInfo

A JSON string for selecting additional features.

type AmiVersion

string

param AmiVersion

Note

For Amazon EMR releases 3.x and 2.x. For Amazon EMR releases 4.x and greater, use ReleaseLabel.

The version of the Amazon Machine Image (AMI) to use when launching Amazon EC2 instances in the job flow. The following values are valid:

  • The version number of the AMI to use, for example, "2.0."

If the AMI supports multiple versions of Hadoop (for example, AMI 1.0 supports both Hadoop 0.18 and 0.20) you can use the JobFlowInstancesConfig HadoopVersion parameter to modify the version of Hadoop from the defaults shown above.

For details about the AMI versions currently supported by Amazon Elastic MapReduce, go to AMI Versions Supported in Elastic MapReduce in the Amazon Elastic MapReduce Developer's Guide.

type ReleaseLabel

string

param ReleaseLabel

Note

Amazon EMR releases 4.x or later.

The release label for the Amazon EMR release. For Amazon EMR 3.x and 2.x AMIs, use amiVersion instead instead of ReleaseLabel.

type Instances

dict

param Instances

[REQUIRED]

A specification of the number and type of Amazon EC2 instances on which to run the job flow.

  • MasterInstanceType (string) --

    The EC2 instance type of the master node.

  • SlaveInstanceType (string) --

    The EC2 instance type of the slave nodes.

  • InstanceCount (integer) --

    The number of Amazon EC2 instances used to execute the job flow.

  • InstanceGroups (list) --

    Configuration for the job flow's instance groups.

    • (dict) --

      Configuration defining a new instance group.

      • Name (string) --

        Friendly name given to the instance group.

      • Market (string) --

        Market type of the Amazon EC2 instances used to create a cluster node.

      • InstanceRole (string) -- [REQUIRED]

        The role of the instance group in the cluster.

      • BidPrice (string) --

        Bid price for each Amazon EC2 instance in the instance group when launching nodes as Spot Instances, expressed in USD.

      • InstanceType (string) -- [REQUIRED]

        The Amazon EC2 instance type for all instances in the instance group.

      • InstanceCount (integer) -- [REQUIRED]

        Target number of instances for the instance group.

      • Configurations (list) --

        Note

        Amazon EMR releases 4.x or later.

        The list of configurations supplied for an EMR cluster instance group. You can specify a separate configuration for each instance group (master, core, and task).

        • (dict) --

          Note

          Amazon EMR releases 4.x or later.

          Specifies a hardware and software configuration of the EMR cluster. This includes configurations for applications and software bundled with Amazon EMR. The Configuration object is a JSON object which is defined by a classification and a set of properties. Configurations can be nested, so a configuration may have its own Configuration objects listed.

          • Classification (string) --

            The classification of a configuration. For more information see, Amazon EMR Configurations.

          • Configurations (list) --

            A list of configurations you apply to this configuration object.

          • Properties (dict) --

            A set of properties supplied to the Configuration object.

            • (string) --

              • (string) --

      • EbsConfiguration (dict) --

        EBS configurations that will be attached to each Amazon EC2 instance in the instance group.

        • EbsBlockDeviceConfigs (list) --

          • (dict) --

            Configuration of requested EBS block device associated with the instance group with count of volumes that will be associated to every instance.

            • VolumeSpecification (dict) -- [REQUIRED]

              EBS volume specifications such as volume type, IOPS, and size(GiB) that will be requested for the EBS volume attached to an EC2 instance in the cluster.

              • VolumeType (string) -- [REQUIRED]

                The volume type. Volume types supported are gp2, io1, standard.

              • Iops (integer) --

                The number of I/O operations per second (IOPS) that the volume supports.

              • SizeInGB (integer) -- [REQUIRED]

                The volume size, in gibibytes (GiB). This can be a number from 1 – 1024. If the volume type is EBS-optimized, the minimum value is 10.

            • VolumesPerInstance (integer) --

              Number of EBS volumes with specific volume configuration, that will be associated with every instance in the instance group

        • EbsOptimized (boolean) --

  • Ec2KeyName (string) --

    The name of the Amazon EC2 key pair that can be used to ssh to the master node as the user called "hadoop."

  • Placement (dict) --

    The Availability Zone the job flow will run in.

    • AvailabilityZone (string) -- [REQUIRED]

      The Amazon EC2 Availability Zone for the job flow.

  • KeepJobFlowAliveWhenNoSteps (boolean) --

    Specifies whether the job flow should be kept alive after completing all steps.

  • TerminationProtected (boolean) --

    Specifies whether to lock the job flow to prevent the Amazon EC2 instances from being terminated by API call, user intervention, or in the event of a job flow error.

  • HadoopVersion (string) --

    The Hadoop version for the job flow. Valid inputs are "0.18" (deprecated), "0.20" (deprecated), "0.20.205" (deprecated), "1.0.3", "2.2.0", or "2.4.0". If you do not set this value, the default of 0.18 is used, unless the AmiVersion parameter is set in the RunJobFlow call, in which case the default version of Hadoop for that AMI version is used.

  • Ec2SubnetId (string) --

    To launch the job flow in Amazon Virtual Private Cloud (Amazon VPC), set this parameter to the identifier of the Amazon VPC subnet where you want the job flow to launch. If you do not specify this value, the job flow is launched in the normal Amazon Web Services cloud, outside of an Amazon VPC.

    Amazon VPC currently does not support cluster compute quadruple extra large (cc1.4xlarge) instances. Thus you cannot specify the cc1.4xlarge instance type for nodes of a job flow launched in a Amazon VPC.

  • EmrManagedMasterSecurityGroup (string) --

    The identifier of the Amazon EC2 security group for the master node.

  • EmrManagedSlaveSecurityGroup (string) --

    The identifier of the Amazon EC2 security group for the slave nodes.

  • ServiceAccessSecurityGroup (string) --

    The identifier of the Amazon EC2 security group for the Amazon EMR service to access clusters in VPC private subnets.

  • AdditionalMasterSecurityGroups (list) --

    A list of additional Amazon EC2 security group IDs for the master node.

    • (string) --

  • AdditionalSlaveSecurityGroups (list) --

    A list of additional Amazon EC2 security group IDs for the slave nodes.

    • (string) --

type Steps

list

param Steps

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

  • (dict) --

    Specification of a job flow step.

    • Name (string) -- [REQUIRED]

      The name of the job flow step.

    • ActionOnFailure (string) --

      The action to take if the job flow step fails.

    • HadoopJarStep (dict) -- [REQUIRED]

      The JAR file used for the job flow step.

      • Properties (list) --

        A list of Java properties that are set when the step runs. You can use these properties to pass key value pairs to your main function.

        • (dict) --

          A key value pair.

          • Key (string) --

            The unique identifier of a key value pair.

          • Value (string) --

            The value part of the identified key.

      • Jar (string) -- [REQUIRED]

        A path to a JAR file run during the step.

      • MainClass (string) --

        The name of the main class in the specified Java file. If not specified, the JAR file should specify a Main-Class in its manifest file.

      • Args (list) --

        A list of command line arguments passed to the JAR file's main function when executed.

        • (string) --

type BootstrapActions

list

param BootstrapActions

A list of bootstrap actions that will be run before Hadoop is started on the cluster nodes.

  • (dict) --

    Configuration of a bootstrap action.

    • Name (string) -- [REQUIRED]

      The name of the bootstrap action.

    • ScriptBootstrapAction (dict) -- [REQUIRED]

      The script run by the bootstrap action.

      • Path (string) -- [REQUIRED]

        Location of the script to run during a bootstrap action. Can be either a location in Amazon S3 or on a local file system.

      • Args (list) --

        A list of command line arguments to pass to the bootstrap action script.

        • (string) --

type SupportedProducts

list

param SupportedProducts

Note

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

A list of strings that indicates third-party software to use with the job flow. For more information, go to Use Third Party Applications with Amazon EMR. Currently supported values are:

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

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

  • (string) --

type NewSupportedProducts

list

param NewSupportedProducts

Note

For Amazon EMR releases 3.x and 2.x. For Amazon EMR releases 4.x and greater, 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. Currently 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.

  • (dict) --

    The list of supported product configurations which allow user-supplied arguments. EMR accepts these arguments and forwards them to the corresponding installation script as bootstrap action arguments.

    • Name (string) --

      The name of the product configuration.

    • Args (list) --

      The list of user-supplied arguments.

      • (string) --

type Applications

list

param Applications

Note

Amazon EMR releases 4.x or later.

A list of applications for the cluster. Valid values are: "Hadoop", "Hive", "Mahout", "Pig", and "Spark." They are case insensitive.

  • (dict) --

    An application is any Amazon or third-party software that you can add to the cluster. This structure contains a list of strings that indicates the software to use with the cluster and accepts a user argument list. Amazon EMR accepts and forwards the argument list to the corresponding installation script as bootstrap action argument. For more information, see Launch a Job Flow on the MapR Distribution for Hadoop. Currently supported values are:

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

    • "mapr-m5" - launch the job flow 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.

    Note

    In Amazon EMR releases 4.0 and greater, the only accepted parameter is the application name. To pass arguments to applications, you supply a configuration for each application.

    • Name (string) --

      The name of the application.

    • Version (string) --

      The version of the application.

    • Args (list) --

      Arguments for Amazon EMR to pass to the application.

      • (string) --

    • AdditionalInfo (dict) --

      This option is for advanced users only. This is meta information about third-party applications that third-party vendors use for testing purposes.

      • (string) --

        • (string) --

type Configurations

list

param Configurations

Note

Amazon EMR releases 4.x or later.

The list of configurations supplied for the EMR cluster you are creating.

  • (dict) --

    Note

    Amazon EMR releases 4.x or later.

    Specifies a hardware and software configuration of the EMR cluster. This includes configurations for applications and software bundled with Amazon EMR. The Configuration object is a JSON object which is defined by a classification and a set of properties. Configurations can be nested, so a configuration may have its own Configuration objects listed.

    • Classification (string) --

      The classification of a configuration. For more information see, Amazon EMR Configurations.

    • Configurations (list) --

      A list of configurations you apply to this configuration object.

    • Properties (dict) --

      A set of properties supplied to the Configuration object.

      • (string) --

        • (string) --

type VisibleToAllUsers

boolean

param VisibleToAllUsers

Whether the job flow is visible to all IAM users of the AWS account associated with the job flow. If this value is set to true , all IAM users of that AWS account can view and (if they have the proper policy permissions set) manage the job flow. If it is set to false , only the IAM user that created the job flow can view and manage it.

type JobFlowRole

string

param JobFlowRole

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.

type ServiceRole

string

param ServiceRole

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

type Tags

list

param Tags

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

  • (dict) --

    A key/value pair containing user-defined metadata that you can associate with 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 Tagging Amazon EMR Resources.

rtype

dict

returns

Response Syntax

{
    'JobFlowId': 'string'
}

Response Structure

  • (dict) --

    The result of the RunJobFlow operation.

    • JobFlowId (string) --

      An unique identifier for the job flow.