AWS SDK for PHP 3.x

Service ID: elasticmapreduce

Version: 2009-03-31

This page describes the parameters and results for the operations of the Amazon Elastic MapReduce (2009-03-31), and shows how to use the Aws\Emr\EmrClient object to call the described operations. This documentation is specific to the 2009-03-31 API version of the service.

Operation Summary

Each of the following operations can be created from a client using $client->getCommand('CommandName'), where "CommandName" is the name of one of the following operations. Note: a command is a value that encapsulates an operation and the parameters used to create an HTTP request.

You can also create and send a command immediately using the magic methods available on a client object: $client->commandName(/* parameters */). You can send the command asynchronously (returning a promise) by appending the word "Async" to the operation name: $client->commandNameAsync(/* parameters */).

AddInstanceFleet ( array $params = [] )
Adds an instance fleet to a running cluster.
AddInstanceGroups ( array $params = [] )
Adds one or more instance groups to a running cluster.
AddJobFlowSteps ( array $params = [] )
AddJobFlowSteps adds new steps to a running cluster.
AddTags ( array $params = [] )
Adds tags to an Amazon EMR resource.
CancelSteps ( array $params = [] )
Cancels a pending step or steps in a running cluster.
CreateSecurityConfiguration ( array $params = [] )
Creates a security configuration, which is stored in the service and can be specified when a cluster is created.
DeleteSecurityConfiguration ( array $params = [] )
Deletes a security configuration.
DescribeCluster ( array $params = [] )
Provides cluster-level details including status, hardware and software configuration, VPC settings, and so on.
DescribeJobFlows ( array $params = [] )
This API is deprecated and will eventually be removed.
DescribeSecurityConfiguration ( array $params = [] )
Provides the details of a security configuration by returning the configuration JSON.
DescribeStep ( array $params = [] )
Provides more detail about the cluster step.
GetBlockPublicAccessConfiguration ( array $params = [] )
Returns the Amazon EMR block public access configuration for your AWS account in the current Region.
ListBootstrapActions ( array $params = [] )
Provides information about the bootstrap actions associated with a cluster.
ListClusters ( array $params = [] )
Provides the status of all clusters visible to this AWS account.
ListInstanceFleets ( array $params = [] )
Lists all available details about the instance fleets in a cluster.
ListInstanceGroups ( array $params = [] )
Provides all available details about the instance groups in a cluster.
ListInstances ( array $params = [] )
Provides information for all active EC2 instances and EC2 instances terminated in the last 30 days, up to a maximum of 2,000.
ListSecurityConfigurations ( array $params = [] )
Lists all the security configurations visible to this account, providing their creation dates and times, and their names.
ListSteps ( array $params = [] )
Provides a list of steps for the cluster in reverse order unless you specify stepIds with the request.
ModifyInstanceFleet ( array $params = [] )
Modifies the target On-Demand and target Spot capacities for the instance fleet with the specified InstanceFleetID within the cluster specified using ClusterID.
ModifyInstanceGroups ( array $params = [] )
ModifyInstanceGroups modifies the number of nodes and configuration settings of an instance group.
PutAutoScalingPolicy ( array $params = [] )
Creates or updates an automatic scaling policy for a core instance group or task instance group in an Amazon EMR cluster.
PutBlockPublicAccessConfiguration ( array $params = [] )
Creates or updates an Amazon EMR block public access configuration for your AWS account in the current Region.
RemoveAutoScalingPolicy ( array $params = [] )
Removes an automatic scaling policy from a specified instance group within an EMR cluster.
RemoveTags ( array $params = [] )
Removes tags from an Amazon EMR resource.
RunJobFlow ( array $params = [] )
RunJobFlow creates and starts running a new cluster (job flow).
SetTerminationProtection ( array $params = [] )
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.
SetVisibleToAllUsers ( array $params = [] )
This member will be deprecated.
TerminateJobFlows ( array $params = [] )
TerminateJobFlows shuts a list of clusters (job flows) down.

Paginators

Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:

DescribeJobFlows
ListBootstrapActions
ListClusters
ListInstanceFleets
ListInstanceGroups
ListInstances
ListSecurityConfigurations
ListSteps

Waiters

Waiters allow you to poll a resource until it enters into a desired state. A waiter has a name used to describe what it does, and is associated with an API operation. When creating a waiter, you can provide the API operation parameters associated with the corresponding operation. Waiters can be accessed using the getWaiter($waiterName, $operationParameters) method of a client object. This client supports the following waiters:

Waiter name	API Operation	Delay	Max Attempts
ClusterRunning	DescribeCluster	30	60
StepComplete	DescribeStep	30	60
ClusterTerminated	DescribeCluster	30	60

Operations

AddInstanceFleet

$result = $client->addInstanceFleet([/* ... */]);
$promise = $client->addInstanceFleetAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->addInstanceFleet([
    'ClusterId' => '<string>', // REQUIRED
    'InstanceFleet' => [ // REQUIRED
        'InstanceFleetType' => 'MASTER|CORE|TASK', // REQUIRED
        'InstanceTypeConfigs' => [
            [
                'BidPrice' => '<string>',
                'BidPriceAsPercentageOfOnDemandPrice' => <float>,
                'Configurations' => [
                    [
                        'Classification' => '<string>',
                        'Configurations' => [...], // RECURSIVE
                        'Properties' => ['<string>', ...],
                    ],
                    // ...
                ],
                'EbsConfiguration' => [
                    'EbsBlockDeviceConfigs' => [
                        [
                            'VolumeSpecification' => [ // REQUIRED
                                'Iops' => <integer>,
                                'SizeInGB' => <integer>, // REQUIRED
                                'VolumeType' => '<string>', // REQUIRED
                            ],
                            'VolumesPerInstance' => <integer>,
                        ],
                        // ...
                    ],
                    'EbsOptimized' => true || false,
                ],
                'InstanceType' => '<string>', // REQUIRED
                'WeightedCapacity' => <integer>,
            ],
            // ...
        ],
        'LaunchSpecifications' => [
            'SpotSpecification' => [ // REQUIRED
                'BlockDurationMinutes' => <integer>,
                'TimeoutAction' => 'SWITCH_TO_ON_DEMAND|TERMINATE_CLUSTER', // REQUIRED
                'TimeoutDurationMinutes' => <integer>, // REQUIRED
            ],
        ],
        'Name' => '<string>',
        'TargetOnDemandCapacity' => <integer>,
        'TargetSpotCapacity' => <integer>,
    ],
]);

Parameter Details

Members

ClusterId

Required: Yes
Type: string

The unique identifier of the cluster.

InstanceFleet

Required: Yes
Type: InstanceFleetConfig structure

Specifies the configuration of the instance fleet.

Result Syntax

[
    'ClusterId' => '<string>',
    'InstanceFleetId' => '<string>',
]

Result Details

Members

ClusterId

Type: string

The unique identifier of the cluster.

InstanceFleetId

Type: string

The unique identifier of the instance fleet.

Errors

InternalServerException:
This exception occurs when there is an internal failure in the EMR service.
InvalidRequestException:
This exception occurs when there is something wrong with user input.

AddInstanceGroups

$result = $client->addInstanceGroups([/* ... */]);
$promise = $client->addInstanceGroupsAsync([/* ... */]);

Adds one or more instance groups to a running cluster.

Parameter Syntax

$result = $client->addInstanceGroups([
    'InstanceGroups' => [ // REQUIRED
        [
            'AutoScalingPolicy' => [
                'Constraints' => [ // REQUIRED
                    'MaxCapacity' => <integer>, // REQUIRED
                    'MinCapacity' => <integer>, // REQUIRED
                ],
                'Rules' => [ // REQUIRED
                    [
                        'Action' => [ // REQUIRED
                            'Market' => 'ON_DEMAND|SPOT',
                            'SimpleScalingPolicyConfiguration' => [ // REQUIRED
                                'AdjustmentType' => 'CHANGE_IN_CAPACITY|PERCENT_CHANGE_IN_CAPACITY|EXACT_CAPACITY',
                                'CoolDown' => <integer>,
                                'ScalingAdjustment' => <integer>, // REQUIRED
                            ],
                        ],
                        'Description' => '<string>',
                        'Name' => '<string>', // REQUIRED
                        'Trigger' => [ // REQUIRED
                            'CloudWatchAlarmDefinition' => [ // REQUIRED
                                'ComparisonOperator' => 'GREATER_THAN_OR_EQUAL|GREATER_THAN|LESS_THAN|LESS_THAN_OR_EQUAL', // REQUIRED
                                'Dimensions' => [
                                    [
                                        'Key' => '<string>',
                                        'Value' => '<string>',
                                    ],
                                    // ...
                                ],
                                'EvaluationPeriods' => <integer>,
                                'MetricName' => '<string>', // REQUIRED
                                'Namespace' => '<string>',
                                'Period' => <integer>, // REQUIRED
                                'Statistic' => 'SAMPLE_COUNT|AVERAGE|SUM|MINIMUM|MAXIMUM',
                                'Threshold' => <float>, // REQUIRED
                                'Unit' => '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',
                            ],
                        ],
                    ],
                    // ...
                ],
            ],
            'BidPrice' => '<string>',
            'Configurations' => [
                [
                    'Classification' => '<string>',
                    'Configurations' => [...], // RECURSIVE
                    'Properties' => ['<string>', ...],
                ],
                // ...
            ],
            'EbsConfiguration' => [
                'EbsBlockDeviceConfigs' => [
                    [
                        'VolumeSpecification' => [ // REQUIRED
                            'Iops' => <integer>,
                            'SizeInGB' => <integer>, // REQUIRED
                            'VolumeType' => '<string>', // REQUIRED
                        ],
                        'VolumesPerInstance' => <integer>,
                    ],
                    // ...
                ],
                'EbsOptimized' => true || false,
            ],
            'InstanceCount' => <integer>, // REQUIRED
            'InstanceRole' => 'MASTER|CORE|TASK', // REQUIRED
            'InstanceType' => '<string>', // REQUIRED
            'Market' => 'ON_DEMAND|SPOT',
            'Name' => '<string>',
        ],
        // ...
    ],
    'JobFlowId' => '<string>', // REQUIRED
]);

Parameter Details

Members

InstanceGroups

Required: Yes
Type: Array of InstanceGroupConfig structures

Instance groups to add.

JobFlowId

Required: Yes
Type: string

Job flow in which to add the instance groups.

Result Syntax

[
    'InstanceGroupIds' => ['<string>', ...],
    'JobFlowId' => '<string>',
]

Result Details

Members

InstanceGroupIds

Type: Array of strings

Instance group IDs of the newly created instance groups.

JobFlowId

Type: string

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

Errors

InternalServerError:
Indicates that an error occurred while processing the request and that the request was not completed.

AddJobFlowSteps

$result = $client->addJobFlowSteps([/* ... */]);
$promise = $client->addJobFlowStepsAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->addJobFlowSteps([
    'JobFlowId' => '<string>', // REQUIRED
    'Steps' => [ // REQUIRED
        [
            'ActionOnFailure' => 'TERMINATE_JOB_FLOW|TERMINATE_CLUSTER|CANCEL_AND_WAIT|CONTINUE',
            'HadoopJarStep' => [ // REQUIRED
                'Args' => ['<string>', ...],
                'Jar' => '<string>', // REQUIRED
                'MainClass' => '<string>',
                'Properties' => [
                    [
                        'Key' => '<string>',
                        'Value' => '<string>',
                    ],
                    // ...
                ],
            ],
            'Name' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Members

JobFlowId

Required: Yes
Type: string

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

Steps

Required: Yes
Type: Array of StepConfig structures

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

Result Syntax

[
    'StepIds' => ['<string>', ...],
]

Result Details

Members

StepIds

Type: Array of strings

The identifiers of the list of steps added to the job flow.

Errors

InternalServerError:
Indicates that an error occurred while processing the request and that the request was not completed.

AddTags

$result = $client->addTags([/* ... */]);
$promise = $client->addTagsAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->addTags([
    'ResourceId' => '<string>', // REQUIRED
    'Tags' => [ // REQUIRED
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Members

ResourceId

Required: Yes
Type: string

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

Tags

Required: Yes
Type: Array of Tag structures

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.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InternalServerException:
This exception occurs when there is an internal failure in the EMR service.
InvalidRequestException:
This exception occurs when there is something wrong with user input.

CancelSteps

$result = $client->cancelSteps([/* ... */]);
$promise = $client->cancelStepsAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->cancelSteps([
    'ClusterId' => '<string>',
    'StepIds' => ['<string>', ...],
]);

Parameter Details

Members

ClusterId

Type: string

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

StepIds

Type: Array of strings

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

Result Syntax

[
    'CancelStepsInfoList' => [
        [
            'Reason' => '<string>',
            'Status' => 'SUBMITTED|FAILED',
            'StepId' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members

CancelStepsInfoList

Type: Array of CancelStepsInfo structures

A list of CancelStepsInfo, which shows the status of specified cancel requests for each StepID specified.

Errors

InternalServerError:
Indicates that an error occurred while processing the request and that the request was not completed.
InvalidRequestException:
This exception occurs when there is something wrong with user input.

CreateSecurityConfiguration

$result = $client->createSecurityConfiguration([/* ... */]);
$promise = $client->createSecurityConfigurationAsync([/* ... */]);

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

Parameter Syntax

$result = $client->createSecurityConfiguration([
    'Name' => '<string>', // REQUIRED
    'SecurityConfiguration' => '<string>', // REQUIRED
]);

Parameter Details

Members

Name

Required: Yes
Type: string

The name of the security configuration.

SecurityConfiguration

Required: Yes
Type: 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.

Result Syntax

[
    'CreationDateTime' => <DateTime>,
    'Name' => '<string>',
]

Result Details

Members

CreationDateTime

Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time the security configuration was created.

Name

Required: Yes
Type: string

The name of the security configuration.

Errors

InternalServerException:
This exception occurs when there is an internal failure in the EMR service.
InvalidRequestException:
This exception occurs when there is something wrong with user input.

DeleteSecurityConfiguration

$result = $client->deleteSecurityConfiguration([/* ... */]);
$promise = $client->deleteSecurityConfigurationAsync([/* ... */]);

Deletes a security configuration.

Parameter Syntax

$result = $client->deleteSecurityConfiguration([
    'Name' => '<string>', // REQUIRED
]);

Parameter Details

Members

Name

Required: Yes
Type: string

The name of the security configuration.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InternalServerException:
This exception occurs when there is an internal failure in the EMR service.
InvalidRequestException:
This exception occurs when there is something wrong with user input.

DescribeCluster

$result = $client->describeCluster([/* ... */]);
$promise = $client->describeClusterAsync([/* ... */]);

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

Parameter Syntax

$result = $client->describeCluster([
    'ClusterId' => '<string>', // REQUIRED
]);

Parameter Details

Members

ClusterId

Required: Yes
Type: string

The identifier of the cluster to describe.

Result Syntax

[
    'Cluster' => [
        'Applications' => [
            [
                'AdditionalInfo' => ['<string>', ...],
                'Args' => ['<string>', ...],
                'Name' => '<string>',
                'Version' => '<string>',
            ],
            // ...
        ],
        'AutoScalingRole' => '<string>',
        'AutoTerminate' => true || false,
        'Configurations' => [
            [
                'Classification' => '<string>',
                'Configurations' => [...], // RECURSIVE
                'Properties' => ['<string>', ...],
            ],
            // ...
        ],
        'CustomAmiId' => '<string>',
        'EbsRootVolumeSize' => <integer>,
        'Ec2InstanceAttributes' => [
            'AdditionalMasterSecurityGroups' => ['<string>', ...],
            'AdditionalSlaveSecurityGroups' => ['<string>', ...],
            'Ec2AvailabilityZone' => '<string>',
            'Ec2KeyName' => '<string>',
            'Ec2SubnetId' => '<string>',
            'EmrManagedMasterSecurityGroup' => '<string>',
            'EmrManagedSlaveSecurityGroup' => '<string>',
            'IamInstanceProfile' => '<string>',
            'RequestedEc2AvailabilityZones' => ['<string>', ...],
            'RequestedEc2SubnetIds' => ['<string>', ...],
            'ServiceAccessSecurityGroup' => '<string>',
        ],
        'Id' => '<string>',
        'InstanceCollectionType' => 'INSTANCE_FLEET|INSTANCE_GROUP',
        'KerberosAttributes' => [
            'ADDomainJoinPassword' => '<string>',
            'ADDomainJoinUser' => '<string>',
            'CrossRealmTrustPrincipalPassword' => '<string>',
            'KdcAdminPassword' => '<string>',
            'Realm' => '<string>',
        ],
        'LogUri' => '<string>',
        'MasterPublicDnsName' => '<string>',
        'Name' => '<string>',
        'NormalizedInstanceHours' => <integer>,
        'ReleaseLabel' => '<string>',
        'RepoUpgradeOnBoot' => 'SECURITY|NONE',
        'RequestedAmiVersion' => '<string>',
        'RunningAmiVersion' => '<string>',
        'ScaleDownBehavior' => 'TERMINATE_AT_INSTANCE_HOUR|TERMINATE_AT_TASK_COMPLETION',
        'SecurityConfiguration' => '<string>',
        'ServiceRole' => '<string>',
        'Status' => [
            'State' => 'STARTING|BOOTSTRAPPING|RUNNING|WAITING|TERMINATING|TERMINATED|TERMINATED_WITH_ERRORS',
            'StateChangeReason' => [
                'Code' => 'INTERNAL_ERROR|VALIDATION_ERROR|INSTANCE_FAILURE|INSTANCE_FLEET_TIMEOUT|BOOTSTRAP_FAILURE|USER_REQUEST|STEP_FAILURE|ALL_STEPS_COMPLETED',
                'Message' => '<string>',
            ],
            'Timeline' => [
                'CreationDateTime' => <DateTime>,
                'EndDateTime' => <DateTime>,
                'ReadyDateTime' => <DateTime>,
            ],
        ],
        'Tags' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
        'TerminationProtected' => true || false,
        'VisibleToAllUsers' => true || false,
    ],
]

Result Details

Members

Cluster

Type: Cluster structure

This output contains the details for the requested cluster.

Errors

InternalServerException:
This exception occurs when there is an internal failure in the EMR service.
InvalidRequestException:
This exception occurs when there is something wrong with user input.

DescribeJobFlows

$result = $client->describeJobFlows([/* ... */]);
$promise = $client->describeJobFlowsAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->describeJobFlows([
    'CreatedAfter' => <integer || string || DateTime>,
    'CreatedBefore' => <integer || string || DateTime>,
    'JobFlowIds' => ['<string>', ...],
    'JobFlowStates' => ['<string>', ...],
]);

Parameter Details

Members

CreatedAfter

Type: timestamp (string|DateTime or anything parsable by strtotime)

Return only job flows created after this date and time.

CreatedBefore

Type: timestamp (string|DateTime or anything parsable by strtotime)

Return only job flows created before this date and time.

JobFlowIds

Type: Array of strings

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

JobFlowStates

Type: Array of strings

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

Result Syntax

[
    'JobFlows' => [
        [
            'AmiVersion' => '<string>',
            'AutoScalingRole' => '<string>',
            'BootstrapActions' => [
                [
                    'BootstrapActionConfig' => [
                        'Name' => '<string>',
                        'ScriptBootstrapAction' => [
                            'Args' => ['<string>', ...],
                            'Path' => '<string>',
                        ],
                    ],
                ],
                // ...
            ],
            'ExecutionStatusDetail' => [
                'CreationDateTime' => <DateTime>,
                'EndDateTime' => <DateTime>,
                'LastStateChangeReason' => '<string>',
                'ReadyDateTime' => <DateTime>,
                'StartDateTime' => <DateTime>,
                'State' => 'STARTING|BOOTSTRAPPING|RUNNING|WAITING|SHUTTING_DOWN|TERMINATED|COMPLETED|FAILED',
            ],
            'Instances' => [
                'Ec2KeyName' => '<string>',
                'Ec2SubnetId' => '<string>',
                'HadoopVersion' => '<string>',
                'InstanceCount' => <integer>,
                'InstanceGroups' => [
                    [
                        'BidPrice' => '<string>',
                        'CreationDateTime' => <DateTime>,
                        'EndDateTime' => <DateTime>,
                        'InstanceGroupId' => '<string>',
                        'InstanceRequestCount' => <integer>,
                        'InstanceRole' => 'MASTER|CORE|TASK',
                        'InstanceRunningCount' => <integer>,
                        'InstanceType' => '<string>',
                        'LastStateChangeReason' => '<string>',
                        'Market' => 'ON_DEMAND|SPOT',
                        'Name' => '<string>',
                        'ReadyDateTime' => <DateTime>,
                        'StartDateTime' => <DateTime>,
                        'State' => 'PROVISIONING|BOOTSTRAPPING|RUNNING|RECONFIGURING|RESIZING|SUSPENDED|TERMINATING|TERMINATED|ARRESTED|SHUTTING_DOWN|ENDED',
                    ],
                    // ...
                ],
                'KeepJobFlowAliveWhenNoSteps' => true || false,
                'MasterInstanceId' => '<string>',
                'MasterInstanceType' => '<string>',
                'MasterPublicDnsName' => '<string>',
                'NormalizedInstanceHours' => <integer>,
                'Placement' => [
                    'AvailabilityZone' => '<string>',
                    'AvailabilityZones' => ['<string>', ...],
                ],
                'SlaveInstanceType' => '<string>',
                'TerminationProtected' => true || false,
            ],
            'JobFlowId' => '<string>',
            'JobFlowRole' => '<string>',
            'LogUri' => '<string>',
            'Name' => '<string>',
            'ScaleDownBehavior' => 'TERMINATE_AT_INSTANCE_HOUR|TERMINATE_AT_TASK_COMPLETION',
            'ServiceRole' => '<string>',
            'Steps' => [
                [
                    'ExecutionStatusDetail' => [
                        'CreationDateTime' => <DateTime>,
                        'EndDateTime' => <DateTime>,
                        'LastStateChangeReason' => '<string>',
                        'StartDateTime' => <DateTime>,
                        'State' => 'PENDING|RUNNING|CONTINUE|COMPLETED|CANCELLED|FAILED|INTERRUPTED',
                    ],
                    'StepConfig' => [
                        'ActionOnFailure' => 'TERMINATE_JOB_FLOW|TERMINATE_CLUSTER|CANCEL_AND_WAIT|CONTINUE',
                        'HadoopJarStep' => [
                            'Args' => ['<string>', ...],
                            'Jar' => '<string>',
                            'MainClass' => '<string>',
                            'Properties' => [
                                [
                                    'Key' => '<string>',
                                    'Value' => '<string>',
                                ],
                                // ...
                            ],
                        ],
                        'Name' => '<string>',
                    ],
                ],
                // ...
            ],
            'SupportedProducts' => ['<string>', ...],
            'VisibleToAllUsers' => true || false,
        ],
        // ...
    ],
]

Result Details

Members

JobFlows

Type: Array of JobFlowDetail structures

A list of job flows matching the parameters supplied.

Errors

InternalServerError:
Indicates that an error occurred while processing the request and that the request was not completed.

DescribeSecurityConfiguration

$result = $client->describeSecurityConfiguration([/* ... */]);
$promise = $client->describeSecurityConfigurationAsync([/* ... */]);

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

Parameter Syntax

$result = $client->describeSecurityConfiguration([
    'Name' => '<string>', // REQUIRED
]);

Parameter Details

Members

Name

Required: Yes
Type: string

The name of the security configuration.

Result Syntax

[
    'CreationDateTime' => <DateTime>,
    'Name' => '<string>',
    'SecurityConfiguration' => '<string>',
]

Result Details

Members

CreationDateTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time the security configuration was created

Name

Type: string

The name of the security configuration.

SecurityConfiguration

Type: string

The security configuration details in JSON format.

Errors

InternalServerException:
This exception occurs when there is an internal failure in the EMR service.
InvalidRequestException:
This exception occurs when there is something wrong with user input.

DescribeStep

$result = $client->describeStep([/* ... */]);
$promise = $client->describeStepAsync([/* ... */]);

Provides more detail about the cluster step.

Parameter Syntax

$result = $client->describeStep([
    'ClusterId' => '<string>', // REQUIRED
    'StepId' => '<string>', // REQUIRED
]);

Parameter Details

Members

ClusterId

Required: Yes
Type: string

The identifier of the cluster with steps to describe.

StepId

Required: Yes
Type: string

The identifier of the step to describe.

Result Syntax

[
    'Step' => [
        'ActionOnFailure' => 'TERMINATE_JOB_FLOW|TERMINATE_CLUSTER|CANCEL_AND_WAIT|CONTINUE',
        'Config' => [
            'Args' => ['<string>', ...],
            'Jar' => '<string>',
            'MainClass' => '<string>',
            'Properties' => ['<string>', ...],
        ],
        'Id' => '<string>',
        'Name' => '<string>',
        'Status' => [
            'FailureDetails' => [
                'LogFile' => '<string>',
                'Message' => '<string>',
                'Reason' => '<string>',
            ],
            'State' => 'PENDING|CANCEL_PENDING|RUNNING|COMPLETED|CANCELLED|FAILED|INTERRUPTED',
            'StateChangeReason' => [
                'Code' => 'NONE',
                'Message' => '<string>',
            ],
            'Timeline' => [
                'CreationDateTime' => <DateTime>,
                'EndDateTime' => <DateTime>,
                'StartDateTime' => <DateTime>,
            ],
        ],
    ],
]

Result Details

Members

Step

Type: Step structure

The step details for the requested step identifier.

Errors

InternalServerException:
This exception occurs when there is an internal failure in the EMR service.
InvalidRequestException:
This exception occurs when there is something wrong with user input.

GetBlockPublicAccessConfiguration

$result = $client->getBlockPublicAccessConfiguration([/* ... */]);
$promise = $client->getBlockPublicAccessConfigurationAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->getBlockPublicAccessConfiguration([
]);

Parameter Details

Members

Result Syntax

[
    'BlockPublicAccessConfiguration' => [
        'BlockPublicSecurityGroupRules' => true || false,
        'PermittedPublicSecurityGroupRuleRanges' => [
            [
                'MaxRange' => <integer>,
                'MinRange' => <integer>,
            ],
            // ...
        ],
    ],
    'BlockPublicAccessConfigurationMetadata' => [
        'CreatedByArn' => '<string>',
        'CreationDateTime' => <DateTime>,
    ],
]

Result Details

Members

BlockPublicAccessConfiguration

Required: Yes
Type: BlockPublicAccessConfiguration structure

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 the block public access configuration to remove the exception.

BlockPublicAccessConfigurationMetadata

Required: Yes
Type: BlockPublicAccessConfigurationMetadata structure

Properties that describe the AWS principal that created the BlockPublicAccessConfiguration using the PutBlockPublicAccessConfiguration action as well as the date and time that the configuration was created. Each time a configuration for block public access is updated, Amazon EMR updates this metadata.

Errors

InternalServerException:
This exception occurs when there is an internal failure in the EMR service.
InvalidRequestException:
This exception occurs when there is something wrong with user input.

ListBootstrapActions

$result = $client->listBootstrapActions([/* ... */]);
$promise = $client->listBootstrapActionsAsync([/* ... */]);

Provides information about the bootstrap actions associated with a cluster.

Parameter Syntax

$result = $client->listBootstrapActions([
    'ClusterId' => '<string>', // REQUIRED
    'Marker' => '<string>',
]);

Parameter Details

Members

ClusterId

Required: Yes
Type: string

The cluster identifier for the bootstrap actions to list.

Marker

Type: string

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

Result Syntax

[
    'BootstrapActions' => [
        [
            'Args' => ['<string>', ...],
            'Name' => '<string>',
            'ScriptPath' => '<string>',
        ],
        // ...
    ],
    'Marker' => '<string>',
]

Result Details

Members

BootstrapActions

Type: Array of Command structures

The bootstrap actions associated with the cluster.

Marker

Type: string

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

Errors

InternalServerException:
This exception occurs when there is an internal failure in the EMR service.
InvalidRequestException:
This exception occurs when there is something wrong with user input.

ListClusters

$result = $client->listClusters([/* ... */]);
$promise = $client->listClustersAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->listClusters([
    'ClusterStates' => ['<string>', ...],
    'CreatedAfter' => <integer || string || DateTime>,
    'CreatedBefore' => <integer || string || DateTime>,
    'Marker' => '<string>',
]);

Parameter Details

Members

ClusterStates

Type: Array of strings

The cluster state filters to apply when listing clusters.

CreatedAfter

Type: timestamp (string|DateTime or anything parsable by strtotime)

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

CreatedBefore

Type: timestamp (string|DateTime or anything parsable by strtotime)

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

Marker

Type: string

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

Result Syntax

[
    'Clusters' => [
        [
            'Id' => '<string>',
            'Name' => '<string>',
            'NormalizedInstanceHours' => <integer>,
            'Status' => [
                'State' => 'STARTING|BOOTSTRAPPING|RUNNING|WAITING|TERMINATING|TERMINATED|TERMINATED_WITH_ERRORS',
                'StateChangeReason' => [
                    'Code' => 'INTERNAL_ERROR|VALIDATION_ERROR|INSTANCE_FAILURE|INSTANCE_FLEET_TIMEOUT|BOOTSTRAP_FAILURE|USER_REQUEST|STEP_FAILURE|ALL_STEPS_COMPLETED',
                    'Message' => '<string>',
                ],
                'Timeline' => [
                    'CreationDateTime' => <DateTime>,
                    'EndDateTime' => <DateTime>,
                    'ReadyDateTime' => <DateTime>,
                ],
            ],
        ],
        // ...
    ],
    'Marker' => '<string>',
]

Result Details

Members

Clusters

Type: Array of ClusterSummary structures

The list of clusters for the account based on the given filters.

Marker

Type: string

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

Errors

InternalServerException:
This exception occurs when there is an internal failure in the EMR service.
InvalidRequestException:
This exception occurs when there is something wrong with user input.

ListInstanceFleets

$result = $client->listInstanceFleets([/* ... */]);
$promise = $client->listInstanceFleetsAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->listInstanceFleets([
    'ClusterId' => '<string>', // REQUIRED
    'Marker' => '<string>',
]);

Parameter Details

Members

ClusterId

Required: Yes
Type: string

The unique identifier of the cluster.

Marker

Type: string

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

Result Syntax

[
    'InstanceFleets' => [
        [
            'Id' => '<string>',
            'InstanceFleetType' => 'MASTER|CORE|TASK',
            'InstanceTypeSpecifications' => [
                [
                    'BidPrice' => '<string>',
                    'BidPriceAsPercentageOfOnDemandPrice' => <float>,
                    'Configurations' => [
                        [
                            'Classification' => '<string>',
                            'Configurations' => [...], // RECURSIVE
                            'Properties' => ['<string>', ...],
                        ],
                        // ...
                    ],
                    'EbsBlockDevices' => [
                        [
                            'Device' => '<string>',
                            'VolumeSpecification' => [
                                'Iops' => <integer>,
                                'SizeInGB' => <integer>,
                                'VolumeType' => '<string>',
                            ],
                        ],
                        // ...
                    ],
                    'EbsOptimized' => true || false,
                    'InstanceType' => '<string>',
                    'WeightedCapacity' => <integer>,
                ],
                // ...
            ],
            'LaunchSpecifications' => [
                'SpotSpecification' => [
                    'BlockDurationMinutes' => <integer>,
                    'TimeoutAction' => 'SWITCH_TO_ON_DEMAND|TERMINATE_CLUSTER',
                    'TimeoutDurationMinutes' => <integer>,
                ],
            ],
            'Name' => '<string>',
            'ProvisionedOnDemandCapacity' => <integer>,
            'ProvisionedSpotCapacity' => <integer>,
            'Status' => [
                'State' => 'PROVISIONING|BOOTSTRAPPING|RUNNING|RESIZING|SUSPENDED|TERMINATING|TERMINATED',
                'StateChangeReason' => [
                    'Code' => 'INTERNAL_ERROR|VALIDATION_ERROR|INSTANCE_FAILURE|CLUSTER_TERMINATED',
                    'Message' => '<string>',
                ],
                'Timeline' => [
                    'CreationDateTime' => <DateTime>,
                    'EndDateTime' => <DateTime>,
                    'ReadyDateTime' => <DateTime>,
                ],
            ],
            'TargetOnDemandCapacity' => <integer>,
            'TargetSpotCapacity' => <integer>,
        ],
        // ...
    ],
    'Marker' => '<string>',
]

Result Details

Members

InstanceFleets

Type: Array of InstanceFleet structures

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

Marker

Type: string

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

Errors

InternalServerException:
This exception occurs when there is an internal failure in the EMR service.
InvalidRequestException:
This exception occurs when there is something wrong with user input.

ListInstanceGroups

$result = $client->listInstanceGroups([/* ... */]);
$promise = $client->listInstanceGroupsAsync([/* ... */]);

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

Parameter Syntax

$result = $client->listInstanceGroups([
    'ClusterId' => '<string>', // REQUIRED
    'Marker' => '<string>',
]);

Parameter Details

Members

ClusterId

Required: Yes
Type: string

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

Marker

Type: string

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

Result Syntax

[
    'InstanceGroups' => [
        [
            'AutoScalingPolicy' => [
                'Constraints' => [
                    'MaxCapacity' => <integer>,
                    'MinCapacity' => <integer>,
                ],
                'Rules' => [
                    [
                        'Action' => [
                            'Market' => 'ON_DEMAND|SPOT',
                            'SimpleScalingPolicyConfiguration' => [
                                'AdjustmentType' => 'CHANGE_IN_CAPACITY|PERCENT_CHANGE_IN_CAPACITY|EXACT_CAPACITY',
                                'CoolDown' => <integer>,
                                'ScalingAdjustment' => <integer>,
                            ],
                        ],
                        'Description' => '<string>',
                        'Name' => '<string>',
                        'Trigger' => [
                            'CloudWatchAlarmDefinition' => [
                                'ComparisonOperator' => 'GREATER_THAN_OR_EQUAL|GREATER_THAN|LESS_THAN|LESS_THAN_OR_EQUAL',
                                'Dimensions' => [
                                    [
                                        'Key' => '<string>',
                                        'Value' => '<string>',
                                    ],
                                    // ...
                                ],
                                'EvaluationPeriods' => <integer>,
                                'MetricName' => '<string>',
                                'Namespace' => '<string>',
                                'Period' => <integer>,
                                'Statistic' => 'SAMPLE_COUNT|AVERAGE|SUM|MINIMUM|MAXIMUM',
                                'Threshold' => <float>,
                                'Unit' => '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',
                            ],
                        ],
                    ],
                    // ...
                ],
                'Status' => [
                    'State' => 'PENDING|ATTACHING|ATTACHED|DETACHING|DETACHED|FAILED',
                    'StateChangeReason' => [
                        'Code' => 'USER_REQUEST|PROVISION_FAILURE|CLEANUP_FAILURE',
                        'Message' => '<string>',
                    ],
                ],
            ],
            'BidPrice' => '<string>',
            'Configurations' => [
                [
                    'Classification' => '<string>',
                    'Configurations' => [...], // RECURSIVE
                    'Properties' => ['<string>', ...],
                ],
                // ...
            ],
            'ConfigurationsVersion' => <integer>,
            'EbsBlockDevices' => [
                [
                    'Device' => '<string>',
                    'VolumeSpecification' => [
                        'Iops' => <integer>,
                        'SizeInGB' => <integer>,
                        'VolumeType' => '<string>',
                    ],
                ],
                // ...
            ],
            'EbsOptimized' => true || false,
            'Id' => '<string>',
            'InstanceGroupType' => 'MASTER|CORE|TASK',
            'InstanceType' => '<string>',
            'LastSuccessfullyAppliedConfigurations' => [
                [
                    'Classification' => '<string>',
                    'Configurations' => [...], // RECURSIVE
                    'Properties' => ['<string>', ...],
                ],
                // ...
            ],
            'LastSuccessfullyAppliedConfigurationsVersion' => <integer>,
            'Market' => 'ON_DEMAND|SPOT',
            'Name' => '<string>',
            'RequestedInstanceCount' => <integer>,
            'RunningInstanceCount' => <integer>,
            'ShrinkPolicy' => [
                'DecommissionTimeout' => <integer>,
                'InstanceResizePolicy' => [
                    'InstanceTerminationTimeout' => <integer>,
                    'InstancesToProtect' => ['<string>', ...],
                    'InstancesToTerminate' => ['<string>', ...],
                ],
            ],
            'Status' => [
                'State' => 'PROVISIONING|BOOTSTRAPPING|RUNNING|RECONFIGURING|RESIZING|SUSPENDED|TERMINATING|TERMINATED|ARRESTED|SHUTTING_DOWN|ENDED',
                'StateChangeReason' => [
                    'Code' => 'INTERNAL_ERROR|VALIDATION_ERROR|INSTANCE_FAILURE|CLUSTER_TERMINATED',
                    'Message' => '<string>',
                ],
                'Timeline' => [
                    'CreationDateTime' => <DateTime>,
                    'EndDateTime' => <DateTime>,
                    'ReadyDateTime' => <DateTime>,
                ],
            ],
        ],
        // ...
    ],
    'Marker' => '<string>',
]

Result Details

Members

InstanceGroups

Type: Array of InstanceGroup structures

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

Marker

Type: string

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

Errors

InternalServerException:
This exception occurs when there is an internal failure in the EMR service.
InvalidRequestException:
This exception occurs when there is something wrong with user input.

ListInstances

$result = $client->listInstances([/* ... */]);
$promise = $client->listInstancesAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->listInstances([
    'ClusterId' => '<string>', // REQUIRED
    'InstanceFleetId' => '<string>',
    'InstanceFleetType' => 'MASTER|CORE|TASK',
    'InstanceGroupId' => '<string>',
    'InstanceGroupTypes' => ['<string>', ...],
    'InstanceStates' => ['<string>', ...],
    'Marker' => '<string>',
]);

Parameter Details

Members

ClusterId

Required: Yes
Type: string

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

InstanceFleetId

Type: string

The unique identifier of the instance fleet.

InstanceFleetType

Type: string

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

InstanceGroupId

Type: string

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

InstanceGroupTypes

Type: Array of strings

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

InstanceStates

Type: Array of strings

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

Marker

Type: string

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

Result Syntax

[
    'Instances' => [
        [
            'EbsVolumes' => [
                [
                    'Device' => '<string>',
                    'VolumeId' => '<string>',
                ],
                // ...
            ],
            'Ec2InstanceId' => '<string>',
            'Id' => '<string>',
            'InstanceFleetId' => '<string>',
            'InstanceGroupId' => '<string>',
            'InstanceType' => '<string>',
            'Market' => 'ON_DEMAND|SPOT',
            'PrivateDnsName' => '<string>',
            'PrivateIpAddress' => '<string>',
            'PublicDnsName' => '<string>',
            'PublicIpAddress' => '<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>,
                    'EndDateTime' => <DateTime>,
                    'ReadyDateTime' => <DateTime>,
                ],
            ],
        ],
        // ...
    ],
    'Marker' => '<string>',
]

Result Details

Members

Instances

Type: Array of Instance structures

The list of instances for the cluster and given filters.

Marker

Type: string

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

Errors

InternalServerException:
This exception occurs when there is an internal failure in the EMR service.
InvalidRequestException:
This exception occurs when there is something wrong with user input.

ListSecurityConfigurations

$result = $client->listSecurityConfigurations([/* ... */]);
$promise = $client->listSecurityConfigurationsAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->listSecurityConfigurations([
    'Marker' => '<string>',
]);

Parameter Details

Members

Marker

Type: string

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

Result Syntax

[
    'Marker' => '<string>',
    'SecurityConfigurations' => [
        [
            'CreationDateTime' => <DateTime>,
            'Name' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members

Marker

Type: string

A pagination token that indicates the next set of results to retrieve. Include the marker in the next ListSecurityConfiguration call to retrieve the next page of results, if required.

SecurityConfigurations

Type: Array of SecurityConfigurationSummary structures

The creation date and time, and name, of each security configuration.

Errors

InternalServerException:
This exception occurs when there is an internal failure in the EMR service.
InvalidRequestException:
This exception occurs when there is something wrong with user input.

ListSteps

$result = $client->listSteps([/* ... */]);
$promise = $client->listStepsAsync([/* ... */]);

Provides a list of steps for the cluster in reverse order unless you specify stepIds with the request.

Parameter Syntax

$result = $client->listSteps([
    'ClusterId' => '<string>', // REQUIRED
    'Marker' => '<string>',
    'StepIds' => ['<string>', ...],
    'StepStates' => ['<string>', ...],
]);

Parameter Details

Members

ClusterId

Required: Yes
Type: string

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

Marker

Type: string

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

StepIds

Type: Array of strings

The filter to limit the step list based on the identifier of the steps.

StepStates

Type: Array of strings

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

Result Syntax

[
    'Marker' => '<string>',
    'Steps' => [
        [
            'ActionOnFailure' => 'TERMINATE_JOB_FLOW|TERMINATE_CLUSTER|CANCEL_AND_WAIT|CONTINUE',
            'Config' => [
                'Args' => ['<string>', ...],
                'Jar' => '<string>',
                'MainClass' => '<string>',
                'Properties' => ['<string>', ...],
            ],
            'Id' => '<string>',
            'Name' => '<string>',
            'Status' => [
                'FailureDetails' => [
                    'LogFile' => '<string>',
                    'Message' => '<string>',
                    'Reason' => '<string>',
                ],
                'State' => 'PENDING|CANCEL_PENDING|RUNNING|COMPLETED|CANCELLED|FAILED|INTERRUPTED',
                'StateChangeReason' => [
                    'Code' => 'NONE',
                    'Message' => '<string>',
                ],
                'Timeline' => [
                    'CreationDateTime' => <DateTime>,
                    'EndDateTime' => <DateTime>,
                    'StartDateTime' => <DateTime>,
                ],
            ],
        ],
        // ...
    ],
]

Result Details

Members

Marker

Type: string

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

Steps

Type: Array of StepSummary structures

The filtered list of steps for the cluster.

Errors

InternalServerException:
This exception occurs when there is an internal failure in the EMR service.
InvalidRequestException:
This exception occurs when there is something wrong with user input.

ModifyInstanceFleet

$result = $client->modifyInstanceFleet([/* ... */]);
$promise = $client->modifyInstanceFleetAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->modifyInstanceFleet([
    'ClusterId' => '<string>', // REQUIRED
    'InstanceFleet' => [ // REQUIRED
        'InstanceFleetId' => '<string>', // REQUIRED
        'TargetOnDemandCapacity' => <integer>,
        'TargetSpotCapacity' => <integer>,
    ],
]);

Parameter Details

Members

ClusterId

Required: Yes
Type: string

The unique identifier of the cluster.

InstanceFleet

Required: Yes
Type: InstanceFleetModifyConfig structure

The unique identifier of the instance fleet.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InternalServerException:
This exception occurs when there is an internal failure in the EMR service.
InvalidRequestException:
This exception occurs when there is something wrong with user input.

ModifyInstanceGroups

$result = $client->modifyInstanceGroups([/* ... */]);
$promise = $client->modifyInstanceGroupsAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->modifyInstanceGroups([
    'ClusterId' => '<string>',
    'InstanceGroups' => [
        [
            'Configurations' => [
                [
                    'Classification' => '<string>',
                    'Configurations' => [...], // RECURSIVE
                    'Properties' => ['<string>', ...],
                ],
                // ...
            ],
            'EC2InstanceIdsToTerminate' => ['<string>', ...],
            'InstanceCount' => <integer>,
            'InstanceGroupId' => '<string>', // REQUIRED
            'ShrinkPolicy' => [
                'DecommissionTimeout' => <integer>,
                'InstanceResizePolicy' => [
                    'InstanceTerminationTimeout' => <integer>,
                    'InstancesToProtect' => ['<string>', ...],
                    'InstancesToTerminate' => ['<string>', ...],
                ],
            ],
        ],
        // ...
    ],
]);

Parameter Details

Members

ClusterId

Type: string

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

InstanceGroups

Type: Array of InstanceGroupModifyConfig structures

Instance groups to change.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InternalServerError:
Indicates that an error occurred while processing the request and that the request was not completed.

PutAutoScalingPolicy

$result = $client->putAutoScalingPolicy([/* ... */]);
$promise = $client->putAutoScalingPolicyAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->putAutoScalingPolicy([
    'AutoScalingPolicy' => [ // REQUIRED
        'Constraints' => [ // REQUIRED
            'MaxCapacity' => <integer>, // REQUIRED
            'MinCapacity' => <integer>, // REQUIRED
        ],
        'Rules' => [ // REQUIRED
            [
                'Action' => [ // REQUIRED
                    'Market' => 'ON_DEMAND|SPOT',
                    'SimpleScalingPolicyConfiguration' => [ // REQUIRED
                        'AdjustmentType' => 'CHANGE_IN_CAPACITY|PERCENT_CHANGE_IN_CAPACITY|EXACT_CAPACITY',
                        'CoolDown' => <integer>,
                        'ScalingAdjustment' => <integer>, // REQUIRED
                    ],
                ],
                'Description' => '<string>',
                'Name' => '<string>', // REQUIRED
                'Trigger' => [ // REQUIRED
                    'CloudWatchAlarmDefinition' => [ // REQUIRED
                        'ComparisonOperator' => 'GREATER_THAN_OR_EQUAL|GREATER_THAN|LESS_THAN|LESS_THAN_OR_EQUAL', // REQUIRED
                        'Dimensions' => [
                            [
                                'Key' => '<string>',
                                'Value' => '<string>',
                            ],
                            // ...
                        ],
                        'EvaluationPeriods' => <integer>,
                        'MetricName' => '<string>', // REQUIRED
                        'Namespace' => '<string>',
                        'Period' => <integer>, // REQUIRED
                        'Statistic' => 'SAMPLE_COUNT|AVERAGE|SUM|MINIMUM|MAXIMUM',
                        'Threshold' => <float>, // REQUIRED
                        'Unit' => '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',
                    ],
                ],
            ],
            // ...
        ],
    ],
    'ClusterId' => '<string>', // REQUIRED
    'InstanceGroupId' => '<string>', // REQUIRED
]);

Parameter Details

Members

AutoScalingPolicy

Required: Yes
Type: AutoScalingPolicy structure

Specifies the definition of the automatic scaling policy.

ClusterId

Required: Yes
Type: string

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

InstanceGroupId

Required: Yes
Type: string

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

Result Syntax

[
    'AutoScalingPolicy' => [
        'Constraints' => [
            'MaxCapacity' => <integer>,
            'MinCapacity' => <integer>,
        ],
        'Rules' => [
            [
                'Action' => [
                    'Market' => 'ON_DEMAND|SPOT',
                    'SimpleScalingPolicyConfiguration' => [
                        'AdjustmentType' => 'CHANGE_IN_CAPACITY|PERCENT_CHANGE_IN_CAPACITY|EXACT_CAPACITY',
                        'CoolDown' => <integer>,
                        'ScalingAdjustment' => <integer>,
                    ],
                ],
                'Description' => '<string>',
                'Name' => '<string>',
                'Trigger' => [
                    'CloudWatchAlarmDefinition' => [
                        'ComparisonOperator' => 'GREATER_THAN_OR_EQUAL|GREATER_THAN|LESS_THAN|LESS_THAN_OR_EQUAL',
                        'Dimensions' => [
                            [
                                'Key' => '<string>',
                                'Value' => '<string>',
                            ],
                            // ...
                        ],
                        'EvaluationPeriods' => <integer>,
                        'MetricName' => '<string>',
                        'Namespace' => '<string>',
                        'Period' => <integer>,
                        'Statistic' => 'SAMPLE_COUNT|AVERAGE|SUM|MINIMUM|MAXIMUM',
                        'Threshold' => <float>,
                        'Unit' => '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',
                    ],
                ],
            ],
            // ...
        ],
        'Status' => [
            'State' => 'PENDING|ATTACHING|ATTACHED|DETACHING|DETACHED|FAILED',
            'StateChangeReason' => [
                'Code' => 'USER_REQUEST|PROVISION_FAILURE|CLEANUP_FAILURE',
                'Message' => '<string>',
            ],
        ],
    ],
    'ClusterId' => '<string>',
    'InstanceGroupId' => '<string>',
]

Result Details

Members

AutoScalingPolicy

Type: AutoScalingPolicyDescription structure

The automatic scaling policy definition.

ClusterId

Type: string

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

InstanceGroupId

Type: string

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

Errors

There are no errors described for this operation.

PutBlockPublicAccessConfiguration

$result = $client->putBlockPublicAccessConfiguration([/* ... */]);
$promise = $client->putBlockPublicAccessConfigurationAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->putBlockPublicAccessConfiguration([
    'BlockPublicAccessConfiguration' => [ // REQUIRED
        'BlockPublicSecurityGroupRules' => true || false, // REQUIRED
        'PermittedPublicSecurityGroupRuleRanges' => [
            [
                'MaxRange' => <integer>,
                'MinRange' => <integer>, // REQUIRED
            ],
            // ...
        ],
    ],
]);

Parameter Details

Members

BlockPublicAccessConfiguration

Required: Yes
Type: BlockPublicAccessConfiguration structure

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.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InternalServerException:
This exception occurs when there is an internal failure in the EMR service.
InvalidRequestException:
This exception occurs when there is something wrong with user input.

RemoveAutoScalingPolicy

$result = $client->removeAutoScalingPolicy([/* ... */]);
$promise = $client->removeAutoScalingPolicyAsync([/* ... */]);

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

Parameter Syntax

$result = $client->removeAutoScalingPolicy([
    'ClusterId' => '<string>', // REQUIRED
    'InstanceGroupId' => '<string>', // REQUIRED
]);

Parameter Details

Members

ClusterId

Required: Yes
Type: string

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

InstanceGroupId

Required: Yes
Type: string

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

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

There are no errors described for this operation.

RemoveTags

$result = $client->removeTags([/* ... */]);
$promise = $client->removeTagsAsync([/* ... */]);

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:

Parameter Syntax

$result = $client->removeTags([
    'ResourceId' => '<string>', // REQUIRED
    'TagKeys' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members

ResourceId

Required: Yes
Type: string

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

TagKeys

Required: Yes
Type: Array of strings

A list of tag keys to remove from a resource.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InternalServerException:
This exception occurs when there is an internal failure in the EMR service.
InvalidRequestException:
This exception occurs when there is something wrong with user input.

RunJobFlow

$result = $client->runJobFlow([/* ... */]);
$promise = $client->runJobFlowAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->runJobFlow([
    'AdditionalInfo' => '<string>',
    'AmiVersion' => '<string>',
    'Applications' => [
        [
            'AdditionalInfo' => ['<string>', ...],
            'Args' => ['<string>', ...],
            'Name' => '<string>',
            'Version' => '<string>',
        ],
        // ...
    ],
    'AutoScalingRole' => '<string>',
    'BootstrapActions' => [
        [
            'Name' => '<string>', // REQUIRED
            'ScriptBootstrapAction' => [ // REQUIRED
                'Args' => ['<string>', ...],
                'Path' => '<string>', // REQUIRED
            ],
        ],
        // ...
    ],
    'Configurations' => [
        [
            'Classification' => '<string>',
            'Configurations' => [...], // RECURSIVE
            'Properties' => ['<string>', ...],
        ],
        // ...
    ],
    'CustomAmiId' => '<string>',
    'EbsRootVolumeSize' => <integer>,
    'Instances' => [ // REQUIRED
        'AdditionalMasterSecurityGroups' => ['<string>', ...],
        'AdditionalSlaveSecurityGroups' => ['<string>', ...],
        'Ec2KeyName' => '<string>',
        'Ec2SubnetId' => '<string>',
        'Ec2SubnetIds' => ['<string>', ...],
        'EmrManagedMasterSecurityGroup' => '<string>',
        'EmrManagedSlaveSecurityGroup' => '<string>',
        'HadoopVersion' => '<string>',
        'InstanceCount' => <integer>,
        'InstanceFleets' => [
            [
                'InstanceFleetType' => 'MASTER|CORE|TASK', // REQUIRED
                'InstanceTypeConfigs' => [
                    [
                        'BidPrice' => '<string>',
                        'BidPriceAsPercentageOfOnDemandPrice' => <float>,
                        'Configurations' => [
                            [
                                'Classification' => '<string>',
                                'Configurations' => [...], // RECURSIVE
                                'Properties' => ['<string>', ...],
                            ],
                            // ...
                        ],
                        'EbsConfiguration' => [
                            'EbsBlockDeviceConfigs' => [
                                [
                                    'VolumeSpecification' => [ // REQUIRED
                                        'Iops' => <integer>,
                                        'SizeInGB' => <integer>, // REQUIRED
                                        'VolumeType' => '<string>', // REQUIRED
                                    ],
                                    'VolumesPerInstance' => <integer>,
                                ],
                                // ...
                            ],
                            'EbsOptimized' => true || false,
                        ],
                        'InstanceType' => '<string>', // REQUIRED
                        'WeightedCapacity' => <integer>,
                    ],
                    // ...
                ],
                'LaunchSpecifications' => [
                    'SpotSpecification' => [ // REQUIRED
                        'BlockDurationMinutes' => <integer>,
                        'TimeoutAction' => 'SWITCH_TO_ON_DEMAND|TERMINATE_CLUSTER', // REQUIRED
                        'TimeoutDurationMinutes' => <integer>, // REQUIRED
                    ],
                ],
                'Name' => '<string>',
                'TargetOnDemandCapacity' => <integer>,
                'TargetSpotCapacity' => <integer>,
            ],
            // ...
        ],
        'InstanceGroups' => [
            [
                'AutoScalingPolicy' => [
                    'Constraints' => [ // REQUIRED
                        'MaxCapacity' => <integer>, // REQUIRED
                        'MinCapacity' => <integer>, // REQUIRED
                    ],
                    'Rules' => [ // REQUIRED
                        [
                            'Action' => [ // REQUIRED
                                'Market' => 'ON_DEMAND|SPOT',
                                'SimpleScalingPolicyConfiguration' => [ // REQUIRED
                                    'AdjustmentType' => 'CHANGE_IN_CAPACITY|PERCENT_CHANGE_IN_CAPACITY|EXACT_CAPACITY',
                                    'CoolDown' => <integer>,
                                    'ScalingAdjustment' => <integer>, // REQUIRED
                                ],
                            ],
                            'Description' => '<string>',
                            'Name' => '<string>', // REQUIRED
                            'Trigger' => [ // REQUIRED
                                'CloudWatchAlarmDefinition' => [ // REQUIRED
                                    'ComparisonOperator' => 'GREATER_THAN_OR_EQUAL|GREATER_THAN|LESS_THAN|LESS_THAN_OR_EQUAL', // REQUIRED
                                    'Dimensions' => [
                                        [
                                            'Key' => '<string>',
                                            'Value' => '<string>',
                                        ],
                                        // ...
                                    ],
                                    'EvaluationPeriods' => <integer>,
                                    'MetricName' => '<string>', // REQUIRED
                                    'Namespace' => '<string>',
                                    'Period' => <integer>, // REQUIRED
                                    'Statistic' => 'SAMPLE_COUNT|AVERAGE|SUM|MINIMUM|MAXIMUM',
                                    'Threshold' => <float>, // REQUIRED
                                    'Unit' => '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',
                                ],
                            ],
                        ],
                        // ...
                    ],
                ],
                'BidPrice' => '<string>',
                'Configurations' => [
                    [
                        'Classification' => '<string>',
                        'Configurations' => [...], // RECURSIVE
                        'Properties' => ['<string>', ...],
                    ],
                    // ...
                ],
                'EbsConfiguration' => [
                    'EbsBlockDeviceConfigs' => [
                        [
                            'VolumeSpecification' => [ // REQUIRED
                                'Iops' => <integer>,
                                'SizeInGB' => <integer>, // REQUIRED
                                'VolumeType' => '<string>', // REQUIRED
                            ],
                            'VolumesPerInstance' => <integer>,
                        ],
                        // ...
                    ],
                    'EbsOptimized' => true || false,
                ],
                'InstanceCount' => <integer>, // REQUIRED
                'InstanceRole' => 'MASTER|CORE|TASK', // REQUIRED
                'InstanceType' => '<string>', // REQUIRED
                'Market' => 'ON_DEMAND|SPOT',
                'Name' => '<string>',
            ],
            // ...
        ],
        'KeepJobFlowAliveWhenNoSteps' => true || false,
        'MasterInstanceType' => '<string>',
        'Placement' => [
            'AvailabilityZone' => '<string>',
            'AvailabilityZones' => ['<string>', ...],
        ],
        'ServiceAccessSecurityGroup' => '<string>',
        'SlaveInstanceType' => '<string>',
        'TerminationProtected' => true || false,
    ],
    'JobFlowRole' => '<string>',
    'KerberosAttributes' => [
        'ADDomainJoinPassword' => '<string>',
        'ADDomainJoinUser' => '<string>',
        'CrossRealmTrustPrincipalPassword' => '<string>',
        'KdcAdminPassword' => '<string>', // REQUIRED
        'Realm' => '<string>', // REQUIRED
    ],
    'LogUri' => '<string>',
    'Name' => '<string>', // REQUIRED
    'NewSupportedProducts' => [
        [
            'Args' => ['<string>', ...],
            'Name' => '<string>',
        ],
        // ...
    ],
    'ReleaseLabel' => '<string>',
    'RepoUpgradeOnBoot' => 'SECURITY|NONE',
    'ScaleDownBehavior' => 'TERMINATE_AT_INSTANCE_HOUR|TERMINATE_AT_TASK_COMPLETION',
    'SecurityConfiguration' => '<string>',
    'ServiceRole' => '<string>',
    'Steps' => [
        [
            'ActionOnFailure' => 'TERMINATE_JOB_FLOW|TERMINATE_CLUSTER|CANCEL_AND_WAIT|CONTINUE',
            'HadoopJarStep' => [ // REQUIRED
                'Args' => ['<string>', ...],
                'Jar' => '<string>', // REQUIRED
                'MainClass' => '<string>',
                'Properties' => [
                    [
                        'Key' => '<string>',
                        'Value' => '<string>',
                    ],
                    // ...
                ],
            ],
            'Name' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'SupportedProducts' => ['<string>', ...],
    'Tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
    'VisibleToAllUsers' => true || false,
]);

Parameter Details

Members

AdditionalInfo

Type: string

A JSON string for selecting additional features.

AmiVersion

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

Applications

Type: Array of Application structures

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.

AutoScalingRole

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

BootstrapActions

Type: Array of BootstrapActionConfig structures

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

Configurations

Type: Array of Configuration structures

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

CustomAmiId

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

EbsRootVolumeSize

Type: int

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.

Instances

Required: Yes
Type: JobFlowInstancesConfig structure

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

JobFlowRole

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

KerberosAttributes

Type: KerberosAttributes structure

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.

LogUri

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

Name

Required: Yes
Type: string

The name of the job flow.

NewSupportedProducts

Type: Array of SupportedProductConfig structures

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.

ReleaseLabel

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

RepoUpgradeOnBoot

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

ScaleDownBehavior

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

SecurityConfiguration

Type: string

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

ServiceRole

Type: string

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

Steps

Type: Array of StepConfig structures

A list of steps to run.

SupportedProducts

Type: Array of strings

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.

Tags

Type: Array of Tag structures

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

VisibleToAllUsers

Type: boolean

This member will be deprecated.

Whether the cluster is visible to all IAM users of the AWS account associated with the cluster. 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 cluster. If it is set to false, only the IAM user that created the cluster can view and manage it.

Result Syntax

[
    'JobFlowId' => '<string>',
]

Result Details

Members

JobFlowId

Type: string

An unique identifier for the job flow.

Errors

InternalServerError:
Indicates that an error occurred while processing the request and that the request was not completed.

SetTerminationProtection

$result = $client->setTerminationProtection([/* ... */]);
$promise = $client->setTerminationProtectionAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->setTerminationProtection([
    'JobFlowIds' => ['<string>', ...], // REQUIRED
    'TerminationProtected' => true || false, // REQUIRED
]);

Parameter Details

Members

JobFlowIds

Required: Yes
Type: Array of strings

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

TerminationProtected

Required: Yes
Type: 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.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InternalServerError:
Indicates that an error occurred while processing the request and that the request was not completed.

SetVisibleToAllUsers

$result = $client->setVisibleToAllUsers([/* ... */]);
$promise = $client->setVisibleToAllUsersAsync([/* ... */]);

This member will be deprecated.

Sets whether all AWS Identity and Access Management (IAM) users under your account can access the specified clusters (job flows). This action works on running clusters. You can also set the visibility of a cluster when you launch it using the VisibleToAllUsers parameter of RunJobFlow. The SetVisibleToAllUsers action can be called only by an IAM user who created the cluster or the AWS account that owns the cluster.

Parameter Syntax

$result = $client->setVisibleToAllUsers([
    'JobFlowIds' => ['<string>', ...], // REQUIRED
    'VisibleToAllUsers' => true || false, // REQUIRED
]);

Parameter Details

Members

JobFlowIds

Required: Yes
Type: Array of strings

Identifiers of the job flows to receive the new visibility setting.

VisibleToAllUsers

Required: Yes
Type: boolean

This member will be deprecated.

Whether the specified clusters are visible to all IAM users of the AWS account associated with the cluster. If this value is set to True, all IAM users of that AWS account can view and, if they have the proper IAM policy permissions set, manage the clusters. If it is set to False, only the IAM user that created a cluster can view and manage it.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InternalServerError:
Indicates that an error occurred while processing the request and that the request was not completed.

TerminateJobFlows

$result = $client->terminateJobFlows([/* ... */]);
$promise = $client->terminateJobFlowsAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->terminateJobFlows([
    'JobFlowIds' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members

JobFlowIds

Required: Yes
Type: Array of strings

A list of job flows to be shutdown.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InternalServerError:
Indicates that an error occurred while processing the request and that the request was not completed.

Shapes

Application

Description

With Amazon EMR release version 4.0 and later, the only accepted parameter is the application name. To pass arguments to applications, you use configuration classifications specified using configuration JSON objects. For more information, see Configuring Applications.

With earlier Amazon EMR releases, the 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.

Members

AdditionalInfo

Type: Associative array of custom strings keys (String) to strings

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

Args

Type: Array of strings

Arguments for Amazon EMR to pass to the application.

Name

Type: string

The name of the application.

Version

Type: string

The version of the application.

AutoScalingPolicy

Description

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

Members

Constraints

Required: Yes
Type: ScalingConstraints structure

The upper and lower EC2 instance limits for an automatic scaling policy. Automatic scaling activity will not cause an instance group to grow above or below these limits.

Rules

Required: Yes
Type: Array of ScalingRule structures

The scale-in and scale-out rules that comprise the automatic scaling policy.

AutoScalingPolicyDescription

Description

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

Members

Constraints

Type: ScalingConstraints structure

The upper and lower EC2 instance limits for an automatic scaling policy. Automatic scaling activity will not cause an instance group to grow above or below these limits.

Rules

Type: Array of ScalingRule structures

The scale-in and scale-out rules that comprise the automatic scaling policy.

Status

Type: AutoScalingPolicyStatus structure

The status of an automatic scaling policy.

AutoScalingPolicyStateChangeReason

Description

The reason for an AutoScalingPolicyStatus change.

Members

Code

Type: string

The code indicating the reason for the change in status.USER_REQUEST indicates that the scaling policy status was changed by a user. PROVISION_FAILURE indicates that the status change was because the policy failed to provision. CLEANUP_FAILURE indicates an error.

Message

Type: string

A friendly, more verbose message that accompanies an automatic scaling policy state change.

AutoScalingPolicyStatus

Description

The status of an automatic scaling policy.

Members

State

Type: string

Indicates the status of the automatic scaling policy.

StateChangeReason

Type: AutoScalingPolicyStateChangeReason structure

The reason for a change in status.

BlockPublicAccessConfiguration

Description

A configuration for Amazon EMR block public access. When BlockPublicSecurityGroupRules is set to true, Amazon EMR prevents cluster creation if one of the cluster's security groups has a rule that allows inbound traffic from 0.0.0.0/0 or ::/0 on a port, unless the port is specified as an exception using PermittedPublicSecurityGroupRuleRanges.

Members

BlockPublicSecurityGroupRules

Required: Yes
Type: boolean

Indicates whether EMR block public access is enabled (true) or disabled (false). By default, the value is false for accounts that have created EMR clusters before July 2019. For accounts created after this, the default is true.

PermittedPublicSecurityGroupRuleRanges

Type: Array of PortRange structures

Specifies ports and port ranges that are permitted to have security group rules that allow inbound traffic from all public sources. For example, if Port 23 (Telnet) is specified for PermittedPublicSecurityGroupRuleRanges, Amazon EMR allows cluster creation if a security group associated with the cluster has a rule that allows inbound traffic on Port 23 from IPv4 0.0.0.0/0 or IPv6 port ::/0 as the source.

By default, Port 22, which is used for SSH access to the cluster EC2 instances, is in the list of PermittedPublicSecurityGroupRuleRanges.

BlockPublicAccessConfigurationMetadata

Description

Members

CreatedByArn

Required: Yes
Type: string

The Amazon Resource Name that created or last modified the configuration.

CreationDateTime

Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time that the configuration was created.

BootstrapActionConfig

Description

Configuration of a bootstrap action.

Members

Name

Required: Yes
Type: string

The name of the bootstrap action.

ScriptBootstrapAction

Required: Yes
Type: ScriptBootstrapActionConfig structure

The script run by the bootstrap action.

BootstrapActionDetail

Description

Reports the configuration of a bootstrap action in a cluster (job flow).

Members

BootstrapActionConfig

Type: BootstrapActionConfig structure

A description of the bootstrap action.

CancelStepsInfo

Description

Specification of the status of a CancelSteps request. Available only in Amazon EMR version 4.8.0 and later, excluding version 5.0.0.

Members

Reason

Type: string

The reason for the failure if the CancelSteps request fails.

Status

Type: string

The status of a CancelSteps Request. The value may be SUBMITTED or FAILED.

StepId

Type: string

The encrypted StepId of a step.

CloudWatchAlarmDefinition

Description

The definition of a CloudWatch metric alarm, which determines when an automatic scaling activity is triggered. When the defined alarm conditions are satisfied, scaling activity begins.

Members

ComparisonOperator

Required: Yes
Type: string

Determines how the metric specified by MetricName is compared to the value specified by Threshold.

Dimensions

Type: Array of MetricDimension structures

A CloudWatch metric dimension.

EvaluationPeriods

Type: int

The number of periods, expressed in seconds using Period, during which the alarm condition must exist before the alarm triggers automatic scaling activity. The default value is 1.

MetricName

Required: Yes
Type: string

The name of the CloudWatch metric that is watched to determine an alarm condition.

Namespace

Type: string

The namespace for the CloudWatch metric. The default is AWS/ElasticMapReduce.

Period

Required: Yes
Type: int

The period, in seconds, over which the statistic is applied. EMR CloudWatch metrics are emitted every five minutes (300 seconds), so if an EMR CloudWatch metric is specified, specify 300.

Statistic

Type: string

The statistic to apply to the metric associated with the alarm. The default is AVERAGE.

Threshold

Required: Yes
Type: double

The value against which the specified statistic is compared.

Unit

Type: string

The unit of measure associated with the CloudWatch metric being watched. The value specified for Unit must correspond to the units specified in the CloudWatch metric.

Cluster

Description

The detailed description of the cluster.

Members

Applications

Type: Array of Application structures

The applications installed on this cluster.

AutoScalingRole

Type: string

AutoTerminate

Type: boolean

Specifies whether the cluster should terminate after completing all steps.

Configurations

Type: Array of Configuration structures

Applies only to Amazon EMR releases 4.x and later. The list of Configurations supplied to the EMR cluster.

CustomAmiId

Type: string

Available only in Amazon EMR version 5.7.0 and later. The ID of a custom Amazon EBS-backed Linux AMI if the cluster uses a custom AMI.

EbsRootVolumeSize

Type: int

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.

Ec2InstanceAttributes

Type: Ec2InstanceAttributes structure

Provides information about the EC2 instances in a cluster grouped by category. For example, key name, subnet ID, IAM instance profile, and so on.

Id

Type: string

The unique identifier for the cluster.

InstanceCollectionType

Type: string

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

The instance group configuration of the cluster. A value of INSTANCE_GROUP indicates a uniform instance group configuration. A value of INSTANCE_FLEET indicates an instance fleets configuration.

KerberosAttributes

Type: KerberosAttributes structure

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.

LogUri

Type: string

The path to the Amazon S3 location where logs for this cluster are stored.

MasterPublicDnsName

Type: string

The DNS name of the master node. If the cluster is on a private subnet, this is the private DNS name. On a public subnet, this is the public DNS name.

Name

Type: string

The name of the cluster.

NormalizedInstanceHours

Type: int

An approximation of the cost of the cluster, represented in m1.small/hours. This value is incremented one time for every hour an m1.small instance runs. Larger instances are weighted more, so an EC2 instance that is roughly four times more expensive would result in the normalized instance hours being incremented by four. This result is only an approximation and does not reflect the actual billing rate.

ReleaseLabel

Type: string

RepoUpgradeOnBoot

Type: string

Applies only when CustomAmiID is used. Specifies the type of updates that are applied from the Amazon Linux AMI package repositories when an instance boots using the AMI.

RequestedAmiVersion

Type: string

The AMI version requested for this cluster.

RunningAmiVersion

Type: string

The AMI version running on this cluster.

ScaleDownBehavior

Type: string

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

SecurityConfiguration

Type: string

The name of the security configuration applied to the cluster.

ServiceRole

Type: string

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

Status

Type: ClusterStatus structure

The current status details about the cluster.

Tags

Type: Array of Tag structures

A list of tags associated with a cluster.

TerminationProtected

Type: boolean

Indicates whether Amazon EMR will lock the cluster to prevent the EC2 instances from being terminated by an API call or user intervention, or in the event of a cluster error.

VisibleToAllUsers

Type: boolean

This member will be deprecated.

Indicates whether the cluster is visible to all IAM users of the AWS account associated with the cluster. If this value is set to true, all IAM users of that AWS account can view and manage the cluster if they have the proper policy permissions set. If this value is false, only the IAM user that created the cluster can view and manage it. This value can be changed using the SetVisibleToAllUsers action.

ClusterStateChangeReason

Description

The reason that the cluster changed to its current state.

Members

Code

Type: string

The programmatic code for the state change reason.

Message

Type: string

The descriptive message for the state change reason.

ClusterStatus

Description

The detailed status of the cluster.

Members

State

Type: string

The current state of the cluster.

StateChangeReason

Type: ClusterStateChangeReason structure

The reason for the cluster status change.

Timeline

Type: ClusterTimeline structure

A timeline that represents the status of a cluster over the lifetime of the cluster.

ClusterSummary

Description

The summary description of the cluster.

Members

Id

Type: string

The unique identifier for the cluster.

Name

Type: string

The name of the cluster.

NormalizedInstanceHours

Type: int

Status

Type: ClusterStatus structure

The details about the current status of the cluster.

ClusterTimeline

Description

Represents the timeline of the cluster's lifecycle.

Members

CreationDateTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

The creation date and time of the cluster.

EndDateTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time when the cluster was terminated.

ReadyDateTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time when the cluster was ready to execute steps.

Command

Description

An entity describing an executable that runs on a cluster.

Members

Args

Type: Array of strings

Arguments for Amazon EMR to pass to the command for execution.

Name

Type: string

The name of the command.

ScriptPath

Type: string

The Amazon S3 location of the command script.

Configuration

Description

Amazon EMR releases 4.x or later.

An optional configuration specification to be used when provisioning cluster instances, which can include configurations for applications and software bundled with Amazon EMR. A configuration consists of a classification, properties, and optional nested configurations. A classification refers to an application-specific configuration file. Properties are the settings you want to change in that file. For more information, see Configuring Applications.

Members

Classification

Type: string

The classification within a configuration.

Configurations

Type: Array of Configuration structures

A list of additional configurations to apply within a configuration object.

Properties

Type: Associative array of custom strings keys (String) to strings

A set of properties specified within a configuration classification.

EbsBlockDevice

Description

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

Members

Device

Type: string

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

VolumeSpecification

Type: VolumeSpecification structure

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.

EbsBlockDeviceConfig

Description

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

Members

VolumeSpecification

Required: Yes
Type: VolumeSpecification structure

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.

VolumesPerInstance

Type: int

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

EbsConfiguration

Description

The Amazon EBS configuration of a cluster instance.

Members

EbsBlockDeviceConfigs

Type: Array of EbsBlockDeviceConfig structures

An array of Amazon EBS volume specifications attached to a cluster instance.

EbsOptimized

Type: boolean

Indicates whether an Amazon EBS volume is EBS-optimized.

EbsVolume

Description

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

Members

Device

Type: string

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

VolumeId

Type: string

The volume identifier of the EBS volume.

Ec2InstanceAttributes

Description

Provides information about the EC2 instances in a cluster grouped by category. For example, key name, subnet ID, IAM instance profile, and so on.

Members

AdditionalMasterSecurityGroups

Type: Array of strings

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

AdditionalSlaveSecurityGroups

Type: Array of strings

A list of additional Amazon EC2 security group IDs for the core and task nodes.

Ec2AvailabilityZone

Type: string

The Availability Zone in which the cluster will run.

Ec2KeyName

Type: string

The name of the Amazon EC2 key pair to use when connecting with SSH into the master node as a user named "hadoop".

Ec2SubnetId

Type: string

Set this parameter to the identifier of the Amazon VPC subnet where you want the cluster to launch. If you do not specify this value, and your account supports EC2-Classic, the cluster launches in EC2-Classic.

EmrManagedMasterSecurityGroup

Type: string

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

EmrManagedSlaveSecurityGroup

Type: string

The identifier of the Amazon EC2 security group for the core and task nodes.

IamInstanceProfile

Type: string

The IAM role that was specified when the cluster was launched. The EC2 instances of the cluster assume this role.

RequestedEc2AvailabilityZones

Type: Array of strings

Applies to clusters configured with the instance fleets option. Specifies one or more Availability Zones in which to launch EC2 cluster instances when the EC2-Classic network configuration is supported. Amazon EMR chooses the Availability Zone with the best fit from among the list of RequestedEc2AvailabilityZones, and then launches all cluster instances within that Availability Zone. If you do not specify this value, Amazon EMR chooses the Availability Zone for you. RequestedEc2SubnetIDs and RequestedEc2AvailabilityZones cannot be specified together.

RequestedEc2SubnetIds

Type: Array of strings

Applies to clusters configured with the instance fleets option. Specifies the unique identifier of one or more Amazon EC2 subnets in which to launch EC2 cluster instances. Subnets must exist within the same VPC. Amazon EMR chooses the EC2 subnet with the best fit from among the list of RequestedEc2SubnetIds, and then launches all cluster instances within that Subnet. If this value is not specified, and the account and Region support EC2-Classic networks, the cluster launches instances in the EC2-Classic network and uses RequestedEc2AvailabilityZones instead of this setting. If EC2-Classic is not supported, and no Subnet is specified, Amazon EMR chooses the subnet for you. RequestedEc2SubnetIDs and RequestedEc2AvailabilityZones cannot be specified together.

ServiceAccessSecurityGroup

Type: string

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

FailureDetails

Description

The details of the step failure. The service attempts to detect the root cause for many common failures.

Members

LogFile

Type: string

The path to the log file where the step failure root cause was originally recorded.

Message

Type: string

The descriptive message including the error the EMR service has identified as the cause of step failure. This is text from an error log that describes the root cause of the failure.

Reason

Type: string

The reason for the step failure. In the case where the service cannot successfully determine the root cause of the failure, it returns "Unknown Error" as a reason.

HadoopJarStepConfig

Description

A job flow step consisting of a JAR file whose main function will be executed. The main function submits a job for Hadoop to execute and waits for the job to finish or fail.

Members

Args

Type: Array of strings

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

Jar

Required: Yes
Type: string

A path to a JAR file run during the step.

MainClass

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

Properties

Type: Array of KeyValue structures

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.

HadoopStepConfig

Description

A cluster step consisting of a JAR file whose main function will be executed. The main function submits a job for Hadoop to execute and waits for the job to finish or fail.

Members

Args

Type: Array of strings

The list of command line arguments to pass to the JAR file's main function for execution.

Jar

Type: string

The path to the JAR file that runs during the step.

MainClass

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

Properties

Type: Associative array of custom strings keys (String) to strings

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

Instance

Description

Represents an EC2 instance provisioned as part of cluster.

Members

EbsVolumes

Type: Array of EbsVolume structures

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

Ec2InstanceId

Type: string

The unique identifier of the instance in Amazon EC2.

Id

Type: string

The unique identifier for the instance in Amazon EMR.

InstanceFleetId

Type: string

The unique identifier of the instance fleet to which an EC2 instance belongs.

InstanceGroupId

Type: string

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

InstanceType

Type: string

The EC2 instance type, for example m3.xlarge.

Market

Type: string

The instance purchasing option. Valid values are ON_DEMAND or SPOT.

PrivateDnsName

Type: string

The private DNS name of the instance.

PrivateIpAddress

Type: string

The private IP address of the instance.

PublicDnsName

Type: string

The public DNS name of the instance.

PublicIpAddress

Type: string

The public IP address of the instance.

Status

Type: InstanceStatus structure

The current status of the instance.

InstanceFleet

Description

Describes an instance fleet, which is a group of EC2 instances that host a particular node type (master, core, or task) in an Amazon EMR cluster. Instance fleets can consist of a mix of instance types and On-Demand and Spot instances, which are provisioned to meet a defined target capacity.

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

Members

Id

Type: string

The unique identifier of the instance fleet.

InstanceFleetType

Type: string

The node type that the instance fleet hosts. Valid values are MASTER, CORE, or TASK.

InstanceTypeSpecifications

Type: Array of InstanceTypeSpecification structures

The specification for the instance types that comprise an instance fleet. Up to five unique instance specifications may be defined for each instance fleet.

LaunchSpecifications

Type: InstanceFleetProvisioningSpecifications structure

Describes the launch specification for an instance fleet.

Name

Type: string

A friendly name for the instance fleet.

ProvisionedOnDemandCapacity

Type: int

The number of On-Demand units that have been provisioned for the instance fleet to fulfill TargetOnDemandCapacity. This provisioned capacity might be less than or greater than TargetOnDemandCapacity.

ProvisionedSpotCapacity

Type: int

The number of Spot units that have been provisioned for this instance fleet to fulfill TargetSpotCapacity. This provisioned capacity might be less than or greater than TargetSpotCapacity.

Status

Type: InstanceFleetStatus structure

The current status of the instance fleet.

TargetOnDemandCapacity

Type: int

The target capacity of On-Demand units for the instance fleet, which determines how many On-Demand instances to provision. When the instance fleet launches, Amazon EMR tries to provision On-Demand instances as specified by InstanceTypeConfig. Each instance configuration has a specified WeightedCapacity. When an On-Demand instance is provisioned, the WeightedCapacity units count toward the target capacity. Amazon EMR provisions instances until the target capacity is totally fulfilled, even if this results in an overage. For example, if there are 2 units remaining to fulfill capacity, and Amazon EMR can only provision an instance with a WeightedCapacity of 5 units, the instance is provisioned, and the target capacity is exceeded by 3 units. You can use InstanceFleet$ProvisionedOnDemandCapacity to determine the Spot capacity units that have been provisioned for the instance fleet.

If not specified or set to 0, only Spot instances are provisioned for the instance fleet using TargetSpotCapacity. At least one of TargetSpotCapacity and TargetOnDemandCapacity should be greater than 0. For a master instance fleet, only one of TargetSpotCapacity and TargetOnDemandCapacity can be specified, and its value must be 1.

TargetSpotCapacity

Type: int

The target capacity of Spot units for the instance fleet, which determines how many Spot instances to provision. When the instance fleet launches, Amazon EMR tries to provision Spot instances as specified by InstanceTypeConfig. Each instance configuration has a specified WeightedCapacity. When a Spot instance is provisioned, the WeightedCapacity units count toward the target capacity. Amazon EMR provisions instances until the target capacity is totally fulfilled, even if this results in an overage. For example, if there are 2 units remaining to fulfill capacity, and Amazon EMR can only provision an instance with a WeightedCapacity of 5 units, the instance is provisioned, and the target capacity is exceeded by 3 units. You can use InstanceFleet$ProvisionedSpotCapacity to determine the Spot capacity units that have been provisioned for the instance fleet.

If not specified or set to 0, only On-Demand instances are provisioned for the instance fleet. At least one of TargetSpotCapacity and TargetOnDemandCapacity should be greater than 0. For a master instance fleet, only one of TargetSpotCapacity and TargetOnDemandCapacity can be specified, and its value must be 1.

InstanceFleetConfig

Description

The configuration that defines an instance fleet.

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

Members

InstanceFleetType

Required: Yes
Type: string

The node type that the instance fleet hosts. Valid values are MASTER,CORE,and TASK.

InstanceTypeConfigs

Type: Array of InstanceTypeConfig structures

The instance type configurations that define the EC2 instances in the instance fleet.

LaunchSpecifications

Type: InstanceFleetProvisioningSpecifications structure

The launch specification for the instance fleet.

Name

Type: string

The friendly name of the instance fleet.

TargetOnDemandCapacity

Type: int

TargetSpotCapacity

Type: int

InstanceFleetModifyConfig

Description

Configuration parameters for an instance fleet modification request.

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

Members

InstanceFleetId

Required: Yes
Type: string

A unique identifier for the instance fleet.

TargetOnDemandCapacity

Type: int

The target capacity of On-Demand units for the instance fleet. For more information see InstanceFleetConfig$TargetOnDemandCapacity.

TargetSpotCapacity

Type: int

The target capacity of Spot units for the instance fleet. For more information, see InstanceFleetConfig$TargetSpotCapacity.

InstanceFleetProvisioningSpecifications

Description

The launch specification for Spot instances in the fleet, which determines the defined duration and provisioning timeout behavior.

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

Members

SpotSpecification

Required: Yes
Type: SpotProvisioningSpecification structure

The launch specification for Spot instances in the fleet, which determines the defined duration and provisioning timeout behavior.

InstanceFleetStateChangeReason

Description

Provides status change reason details for the instance fleet.

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

Members

Code

Type: string

A code corresponding to the reason the state change occurred.

Message

Type: string

An explanatory message.

InstanceFleetStatus

Description

The status of the instance fleet.

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

Members

State

Type: string

A code representing the instance fleet status.

PROVISIONING—The instance fleet is provisioning EC2 resources and is not yet ready to run jobs.
BOOTSTRAPPING—EC2 instances and other resources have been provisioned and the bootstrap actions specified for the instances are underway.
RUNNING—EC2 instances and other resources are running. They are either executing jobs or waiting to execute jobs.
RESIZING—A resize operation is underway. EC2 instances are either being added or removed.
SUSPENDED—A resize operation could not complete. Existing EC2 instances are running, but instances can't be added or removed.
TERMINATING—The instance fleet is terminating EC2 instances.
TERMINATED—The instance fleet is no longer active, and all EC2 instances have been terminated.

StateChangeReason

Type: InstanceFleetStateChangeReason structure

Provides status change reason details for the instance fleet.

Timeline

Type: InstanceFleetTimeline structure

Provides historical timestamps for the instance fleet, including the time of creation, the time it became ready to run jobs, and the time of termination.

InstanceFleetTimeline

Description

Provides historical timestamps for the instance fleet, including the time of creation, the time it became ready to run jobs, and the time of termination.

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

Members

CreationDateTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

The time and date the instance fleet was created.

EndDateTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

The time and date the instance fleet terminated.

ReadyDateTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

The time and date the instance fleet was ready to run jobs.

InstanceGroup

Description

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.

Members

AutoScalingPolicy

Type: AutoScalingPolicyDescription structure

BidPrice

Type: string

The maximum Spot price your are willing to pay for EC2 instances.

An optional, nullable field that applies if the MarketType for the instance group is specified as SPOT. Specify the maximum spot price in USD. If the value is NULL and SPOT is specified, the maximum Spot price is set equal to the On-Demand price.

Configurations

Type: Array of Configuration structures

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

ConfigurationsVersion

Type: long (int|float)

The version number of the requested configuration specification for this instance group.

EbsBlockDevices

Type: Array of EbsBlockDevice structures

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

EbsOptimized

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

Id

Type: string

The identifier of the instance group.

InstanceGroupType

Type: string

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

InstanceType

Type: string

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

LastSuccessfullyAppliedConfigurations

Type: Array of Configuration structures

A list of configurations that were successfully applied for an instance group last time.

LastSuccessfullyAppliedConfigurationsVersion

Type: long (int|float)

The version number of a configuration specification that was successfully applied for an instance group last time.

Market

Type: string

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

Name

Type: string

The name of the instance group.

RequestedInstanceCount

Type: int

The target number of instances for the instance group.

RunningInstanceCount

Type: int

The number of instances currently running in this instance group.

ShrinkPolicy

Type: ShrinkPolicy structure

Policy for customizing shrink operations.

Status

Type: InstanceGroupStatus structure

The current status of the instance group.

InstanceGroupConfig

Description

Configuration defining a new instance group.

Members

AutoScalingPolicy

Type: AutoScalingPolicy structure

BidPrice

Type: string

The maximum Spot price your are willing to pay for EC2 instances.

Configurations

Type: Array of Configuration structures

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

EbsConfiguration

Type: EbsConfiguration structure

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

InstanceCount

Required: Yes
Type: int

Target number of instances for the instance group.

InstanceRole

Required: Yes
Type: string

The role of the instance group in the cluster.

InstanceType

Required: Yes
Type: string

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

Market

Type: string

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

Name

Type: string

Friendly name given to the instance group.

InstanceGroupDetail

Description

Detailed information about an instance group.

Members

BidPrice

Type: string

The maximum Spot price your are willing to pay for EC2 instances.

An optional, nullable field that applies if the MarketType for the instance group is specified as SPOT. Specified in USD. If the value is NULL and SPOT is specified, the maximum Spot price is set equal to the On-Demand price.

CreationDateTime

Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date/time the instance group was created.

EndDateTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

The date/time the instance group was terminated.

InstanceGroupId

Type: string

Unique identifier for the instance group.

InstanceRequestCount

Required: Yes
Type: int

Target number of instances to run in the instance group.

InstanceRole

Required: Yes
Type: string

Instance group role in the cluster

InstanceRunningCount

Required: Yes
Type: int

Actual count of running instances.

InstanceType

Required: Yes
Type: string

EC2 instance type.

LastStateChangeReason

Type: string

Details regarding the state of the instance group.

Market

Required: Yes
Type: string

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

Name

Type: string

Friendly name for the instance group.

ReadyDateTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

The date/time the instance group was available to the cluster.

StartDateTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

The date/time the instance group was started.

State

Required: Yes
Type: string

State of instance group. The following values are deprecated: STARTING, TERMINATED, and FAILED.

InstanceGroupModifyConfig

Description

Modify the size or configurations of an instance group.

Members

Configurations

Type: Array of Configuration structures

A list of new or modified configurations to apply for an instance group.

EC2InstanceIdsToTerminate

Type: Array of strings

The EC2 InstanceIds to terminate. After you terminate the instances, the instance group will not return to its original requested size.

InstanceCount

Type: int

Target size for the instance group.

InstanceGroupId

Required: Yes
Type: string

Unique ID of the instance group to expand or shrink.

ShrinkPolicy

Type: ShrinkPolicy structure

Policy for customizing shrink operations.

InstanceGroupStateChangeReason

Description

The status change reason details for the instance group.

Members

Code

Type: string

The programmable code for the state change reason.

Message

Type: string

The status change reason description.

InstanceGroupStatus

Description

The details of the instance group status.

Members

State

Type: string

The current state of the instance group.

StateChangeReason

Type: InstanceGroupStateChangeReason structure

The status change reason details for the instance group.

Timeline

Type: InstanceGroupTimeline structure

The timeline of the instance group status over time.

InstanceGroupTimeline

Description

The timeline of the instance group lifecycle.

Members

CreationDateTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

The creation date and time of the instance group.

EndDateTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time when the instance group terminated.

ReadyDateTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

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

InstanceResizePolicy

Description

Custom policy for requesting termination protection or termination of specific instances when shrinking an instance group.

Members

InstanceTerminationTimeout

Type: int

Decommissioning timeout override for the specific list of instances to be terminated.

InstancesToProtect

Type: Array of strings

Specific list of instances to be protected when shrinking an instance group.

InstancesToTerminate

Type: Array of strings

Specific list of instances to be terminated when shrinking an instance group.

InstanceStateChangeReason

Description

The details of the status change reason for the instance.

Members

Code

Type: string

The programmable code for the state change reason.

Message

Type: string

The status change reason description.

InstanceStatus

Description

The instance status details.

Members

State

Type: string

The current state of the instance.

StateChangeReason

Type: InstanceStateChangeReason structure

The details of the status change reason for the instance.

Timeline

Type: InstanceTimeline structure

The timeline of the instance status over time.

InstanceTimeline

Description

The timeline of the instance lifecycle.

Members

CreationDateTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

The creation date and time of the instance.

EndDateTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time when the instance was terminated.

ReadyDateTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

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

InstanceTypeConfig

Description

An instance type configuration for each instance type in an instance fleet, which determines the EC2 instances Amazon EMR attempts to provision to fulfill On-Demand and Spot target capacities. There can be a maximum of 5 instance type configurations in a fleet.

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

Members

BidPrice

Type: string

The bid price for each EC2 Spot instance type as defined by InstanceType. Expressed in USD. If neither BidPrice nor BidPriceAsPercentageOfOnDemandPrice is provided, BidPriceAsPercentageOfOnDemandPrice defaults to 100%.

BidPriceAsPercentageOfOnDemandPrice

Type: double

The bid price, as a percentage of On-Demand price, for each EC2 Spot instance as defined by InstanceType. Expressed as a number (for example, 20 specifies 20%). If neither BidPrice nor BidPriceAsPercentageOfOnDemandPrice is provided, BidPriceAsPercentageOfOnDemandPrice defaults to 100%.

Configurations

Type: Array of Configuration structures

A configuration classification that applies when provisioning cluster instances, which can include configurations for applications and software that run on the cluster.

EbsConfiguration

Type: EbsConfiguration structure

The configuration of Amazon Elastic Block Storage (EBS) attached to each instance as defined by InstanceType.

InstanceType

Required: Yes
Type: string

An EC2 instance type, such as m3.xlarge.

WeightedCapacity

Type: int

The number of units that a provisioned instance of this type provides toward fulfilling the target capacities defined in InstanceFleetConfig. This value is 1 for a master instance fleet, and must be 1 or greater for core and task instance fleets. Defaults to 1 if not specified.

InstanceTypeSpecification

Description

The configuration specification for each instance type in an instance fleet.

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

Members

BidPrice

Type: string

The bid price for each EC2 Spot instance type as defined by InstanceType. Expressed in USD.

BidPriceAsPercentageOfOnDemandPrice

Type: double

The bid price, as a percentage of On-Demand price, for each EC2 Spot instance as defined by InstanceType. Expressed as a number (for example, 20 specifies 20%).

Configurations

Type: Array of Configuration structures

A configuration classification that applies when provisioning cluster instances, which can include configurations for applications and software bundled with Amazon EMR.

EbsBlockDevices

Type: Array of EbsBlockDevice structures

The configuration of Amazon Elastic Block Storage (EBS) attached to each instance as defined by InstanceType.

EbsOptimized

Type: boolean

Evaluates to TRUE when the specified InstanceType is EBS-optimized.

InstanceType

Type: string

The EC2 instance type, for example m3.xlarge.

WeightedCapacity

Type: int

The number of units that a provisioned instance of this type provides toward fulfilling the target capacities defined in InstanceFleetConfig. Capacity values represent performance characteristics such as vCPUs, memory, or I/O. If not specified, the default value is 1.

InternalServerError

Description

Indicates that an error occurred while processing the request and that the request was not completed.

Members

InternalServerException

Description

This exception occurs when there is an internal failure in the EMR service.

Members

Message

Type: string

The message associated with the exception.

InvalidRequestException

Description

This exception occurs when there is something wrong with user input.

Members

ErrorCode

Type: string

The error code associated with the exception.

Message

Type: string

The message associated with the exception.

JobFlowDetail

Description

A description of a cluster (job flow).

Members

AmiVersion

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

AutoScalingRole

Type: string

An IAM role for automatic scaling policies. The default role is EMR_AutoScaling_DefaultRole. The IAM role provides a way for the automatic scaling feature to get the required permissions it needs to launch and terminate EC2 instances in an instance group.

BootstrapActions

Type: Array of BootstrapActionDetail structures

A list of the bootstrap actions run by the job flow.

ExecutionStatusDetail

Required: Yes
Type: JobFlowExecutionStatusDetail structure

Describes the execution status of the job flow.

Instances

Required: Yes
Type: JobFlowInstancesDetail structure

Describes the Amazon EC2 instances of the job flow.

JobFlowId

Required: Yes
Type: string

The job flow identifier.

JobFlowRole

Type: string

The IAM role that was specified when the job flow was launched. The EC2 instances of the job flow assume this role.

LogUri

Type: string

The location in Amazon S3 where log files for the job are stored.

Name

Required: Yes
Type: string

The name of the job flow.

ScaleDownBehavior

Type: string

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.

ServiceRole

Type: string

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

Steps

Type: Array of StepDetail structures

A list of steps run by the job flow.

SupportedProducts

Type: Array of strings

A list of strings set by third party software when the job flow is launched. If you are not using third party software to manage the job flow this value is empty.

VisibleToAllUsers

Type: boolean

This member will be deprecated.

Specifies whether the cluster is visible to all IAM users of the AWS account associated with the cluster. 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 cluster. If it is set to false, only the IAM user that created the cluster can view and manage it. This value can be changed using the SetVisibleToAllUsers action.

JobFlowExecutionStatusDetail

Description

Describes the status of the cluster (job flow).

Members

CreationDateTime

Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The creation date and time of the job flow.

EndDateTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

The completion date and time of the job flow.

LastStateChangeReason

Type: string

Description of the job flow last changed state.

ReadyDateTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time when the job flow was ready to start running bootstrap actions.

StartDateTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

The start date and time of the job flow.

State

Required: Yes
Type: string

The state of the job flow.

JobFlowInstancesConfig

Description

A description of the Amazon EC2 instance on which the cluster (job flow) runs. A valid JobFlowInstancesConfig must contain either InstanceGroups or InstanceFleets, which is the recommended configuration. They cannot be used together. You may also have MasterInstanceType, SlaveInstanceType, and InstanceCount (all three must be present), but we don't recommend this configuration.

Members

AdditionalMasterSecurityGroups

Type: Array of strings

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

AdditionalSlaveSecurityGroups

Type: Array of strings

A list of additional Amazon EC2 security group IDs for the core and task nodes.

Ec2KeyName

Type: string

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

Ec2SubnetId

Type: string

Applies to clusters that use the uniform instance group configuration. To launch the cluster in Amazon Virtual Private Cloud (Amazon VPC), set this parameter to the identifier of the Amazon VPC subnet where you want the cluster to launch. If you do not specify this value and your account supports EC2-Classic, the cluster launches in EC2-Classic.

Ec2SubnetIds

Type: Array of strings

Applies to clusters that use the instance fleet configuration. When multiple EC2 subnet IDs are specified, Amazon EMR evaluates them and launches instances in the optimal subnet.

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

EmrManagedMasterSecurityGroup

Type: string

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

EmrManagedSlaveSecurityGroup

Type: string

The identifier of the Amazon EC2 security group for the core and task nodes.

HadoopVersion

Type: string

Applies only to Amazon EMR release versions earlier than 4.0. The Hadoop version for the cluster. 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.

InstanceCount

Type: int

The number of EC2 instances in the cluster.

InstanceFleets

Type: Array of InstanceFleetConfig structures

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

Describes the EC2 instances and instance configurations for clusters that use the instance fleet configuration.

InstanceGroups

Type: Array of InstanceGroupConfig structures

Configuration for the instance groups in a cluster.

KeepJobFlowAliveWhenNoSteps

Type: boolean

Specifies whether the cluster should remain available after completing all steps.

MasterInstanceType

Type: string

The EC2 instance type of the master node.

Placement

Type: PlacementType structure

The Availability Zone in which the cluster runs.

ServiceAccessSecurityGroup

Type: string

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

SlaveInstanceType

Type: string

The EC2 instance type of the core and task nodes.

TerminationProtected

Type: boolean

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

JobFlowInstancesDetail

Description

Specify the type of Amazon EC2 instances that the cluster (job flow) runs on.

Members

Ec2KeyName

Type: string

The name of an Amazon EC2 key pair that can be used to ssh to the master node.

Ec2SubnetId

Type: string

For clusters launched within Amazon Virtual Private Cloud, this is the identifier of the subnet where the cluster was launched.

HadoopVersion

Type: string

The Hadoop version for the cluster.

InstanceCount

Required: Yes
Type: int

The number of Amazon EC2 instances in the cluster. If the value is 1, the same instance serves as both the master and core and task node. If the value is greater than 1, one instance is the master node and all others are core and task nodes.

InstanceGroups

Type: Array of InstanceGroupDetail structures

Details about the instance groups in a cluster.

KeepJobFlowAliveWhenNoSteps

Type: boolean

Specifies whether the cluster should remain available after completing all steps.

MasterInstanceId

Type: string

The Amazon EC2 instance identifier of the master node.

MasterInstanceType

Required: Yes
Type: string

The Amazon EC2 master node instance type.

MasterPublicDnsName

Type: string

The DNS name of the master node. If the cluster is on a private subnet, this is the private DNS name. On a public subnet, this is the public DNS name.

NormalizedInstanceHours

Type: int

An approximation of the cost of the cluster, represented in m1.small/hours. This value is incremented one time for every hour that an m1.small runs. Larger instances are weighted more, so an Amazon EC2 instance that is roughly four times more expensive would result in the normalized instance hours being incremented by four. This result is only an approximation and does not reflect the actual billing rate.

Placement

Type: PlacementType structure

The Amazon EC2 Availability Zone for the cluster.

SlaveInstanceType

Required: Yes
Type: string

The Amazon EC2 core and task node instance type.

TerminationProtected

Type: boolean

Specifies whether the Amazon EC2 instances in the cluster are protected from termination by API calls, user intervention, or in the event of a job-flow error.

KerberosAttributes

Description

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.

Members

ADDomainJoinPassword

Type: string

The Active Directory password for ADDomainJoinUser.

ADDomainJoinUser

Type: string

Required only when establishing a cross-realm trust with an Active Directory domain. A user with sufficient privileges to join resources to the domain.

CrossRealmTrustPrincipalPassword

Type: string

Required only when establishing a cross-realm trust with a KDC in a different realm. The cross-realm principal password, which must be identical across realms.

KdcAdminPassword

Required: Yes
Type: string

The password used within the cluster for the kadmin service on the cluster-dedicated KDC, which maintains Kerberos principals, password policies, and keytabs for the cluster.

Realm

Required: Yes
Type: string

The name of the Kerberos realm to which all nodes in a cluster belong. For example, EC2.INTERNAL.

KeyValue

Description

A key value pair.

Members

Key

Type: string

The unique identifier of a key value pair.

Value

Type: string

The value part of the identified key.

MetricDimension

Description

A CloudWatch dimension, which is specified using a Key (known as a Name in CloudWatch), Value pair. By default, Amazon EMR uses one dimension whose Key is JobFlowID and Value is a variable representing the cluster ID, which is ${emr.clusterId}. This enables the rule to bootstrap when the cluster ID becomes available.

Members

Key

Type: string

The dimension name.

Value

Type: string

The dimension value.

PlacementType

Description

The Amazon EC2 Availability Zone configuration of the cluster (job flow).

Members

AvailabilityZone

Type: string

The Amazon EC2 Availability Zone for the cluster. AvailabilityZone is used for uniform instance groups, while AvailabilityZones (plural) is used for instance fleets.

AvailabilityZones

Type: Array of strings

When multiple Availability Zones are specified, Amazon EMR evaluates them and launches instances in the optimal Availability Zone. AvailabilityZones is used for instance fleets, while AvailabilityZone (singular) is used for uniform instance groups.

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

PortRange

Description

A list of port ranges that are permitted to allow inbound traffic from all public IP addresses. To specify a single port, use the same value for MinRange and MaxRange.

Members

MaxRange

Type: int

The smallest port number in a specified range of port numbers.

MinRange

Required: Yes
Type: int

The smallest port number in a specified range of port numbers.

ScalingAction

Description

The type of adjustment the automatic scaling activity makes when triggered, and the periodicity of the adjustment.

Members

Market

Type: string

Not available for instance groups. Instance groups use the market type specified for the group.

SimpleScalingPolicyConfiguration

Required: Yes
Type: SimpleScalingPolicyConfiguration structure

The type of adjustment the automatic scaling activity makes when triggered, and the periodicity of the adjustment.

ScalingConstraints

Description

The upper and lower EC2 instance limits for an automatic scaling policy. Automatic scaling activities triggered by automatic scaling rules will not cause an instance group to grow above or below these limits.

Members

MaxCapacity

Required: Yes
Type: int

The upper boundary of EC2 instances in an instance group beyond which scaling activities are not allowed to grow. Scale-out activities will not add instances beyond this boundary.

MinCapacity

Required: Yes
Type: int

The lower boundary of EC2 instances in an instance group below which scaling activities are not allowed to shrink. Scale-in activities will not terminate instances below this boundary.

ScalingRule

Description

A scale-in or scale-out rule that defines scaling activity, including the CloudWatch metric alarm that triggers activity, how EC2 instances are added or removed, and the periodicity of adjustments. The automatic scaling policy for an instance group can comprise one or more automatic scaling rules.

Members

Action

Required: Yes
Type: ScalingAction structure

The conditions that trigger an automatic scaling activity.

Description

Type: string

A friendly, more verbose description of the automatic scaling rule.

Name

Required: Yes
Type: string

The name used to identify an automatic scaling rule. Rule names must be unique within a scaling policy.

Trigger

Required: Yes
Type: ScalingTrigger structure

The CloudWatch alarm definition that determines when automatic scaling activity is triggered.

ScalingTrigger

Description

The conditions that trigger an automatic scaling activity.

Members

CloudWatchAlarmDefinition

Required: Yes
Type: CloudWatchAlarmDefinition structure

The definition of a CloudWatch metric alarm. When the defined alarm conditions are met along with other trigger parameters, scaling activity begins.

ScriptBootstrapActionConfig

Description

Configuration of the script to run during a bootstrap action.

Members

Args

Type: Array of strings

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

Path

Required: Yes
Type: string

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

SecurityConfigurationSummary

Description

The creation date and time, and name, of a security configuration.

Members

CreationDateTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time the security configuration was created.

Name

Type: string

The name of the security configuration.

ShrinkPolicy

Description

Policy for customizing shrink operations. Allows configuration of decommissioning timeout and targeted instance shrinking.

Members

DecommissionTimeout

Type: int

The desired timeout for decommissioning an instance. Overrides the default YARN decommissioning timeout.

InstanceResizePolicy

Type: InstanceResizePolicy structure

Custom policy for requesting termination protection or termination of specific instances when shrinking an instance group.

SimpleScalingPolicyConfiguration

Description

An automatic scaling configuration, which describes how the policy adds or removes instances, the cooldown period, and the number of EC2 instances that will be added each time the CloudWatch metric alarm condition is satisfied.

Members

AdjustmentType

Type: string

The way in which EC2 instances are added (if ScalingAdjustment is a positive number) or terminated (if ScalingAdjustment is a negative number) each time the scaling activity is triggered. CHANGE_IN_CAPACITY is the default. CHANGE_IN_CAPACITY indicates that the EC2 instance count increments or decrements by ScalingAdjustment, which should be expressed as an integer. PERCENT_CHANGE_IN_CAPACITY indicates the instance count increments or decrements by the percentage specified by ScalingAdjustment, which should be expressed as an integer. For example, 20 indicates an increase in 20% increments of cluster capacity. EXACT_CAPACITY indicates the scaling activity results in an instance group with the number of EC2 instances specified by ScalingAdjustment, which should be expressed as a positive integer.

CoolDown

Type: int

The amount of time, in seconds, after a scaling activity completes before any further trigger-related scaling activities can start. The default value is 0.

ScalingAdjustment

Required: Yes
Type: int

The amount by which to scale in or scale out, based on the specified AdjustmentType. A positive value adds to the instance group's EC2 instance count while a negative number removes instances. If AdjustmentType is set to EXACT_CAPACITY, the number should only be a positive integer. If AdjustmentType is set to PERCENT_CHANGE_IN_CAPACITY, the value should express the percentage as an integer. For example, -20 indicates a decrease in 20% increments of cluster capacity.

SpotProvisioningSpecification

Description

The launch specification for Spot instances in the instance fleet, which determines the defined duration and provisioning timeout behavior.

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

Members

BlockDurationMinutes

Type: int

The defined duration for Spot instances (also known as Spot blocks) in minutes. When specified, the Spot instance does not terminate before the defined duration expires, and defined duration pricing for Spot instances applies. Valid values are 60, 120, 180, 240, 300, or 360. The duration period starts as soon as a Spot instance receives its instance ID. At the end of the duration, Amazon EC2 marks the Spot instance for termination and provides a Spot instance termination notice, which gives the instance a two-minute warning before it terminates.

TimeoutAction

Required: Yes
Type: string

The action to take when TargetSpotCapacity has not been fulfilled when the TimeoutDurationMinutes has expired; that is, when all Spot instances could not be provisioned within the Spot provisioning timeout. Valid values are TERMINATE_CLUSTER and SWITCH_TO_ON_DEMAND. SWITCH_TO_ON_DEMAND specifies that if no Spot instances are available, On-Demand Instances should be provisioned to fulfill any remaining Spot capacity.

TimeoutDurationMinutes

Required: Yes
Type: int

The spot provisioning timeout period in minutes. If Spot instances are not provisioned within this time period, the TimeOutAction is taken. Minimum value is 5 and maximum value is 1440. The timeout applies only during initial provisioning, when the cluster is first created.

Step

Description

This represents a step in a cluster.

Members

ActionOnFailure

Type: string

The action to take when the cluster step fails. Possible values are TERMINATE_CLUSTER, CANCEL_AND_WAIT, and CONTINUE. TERMINATE_JOB_FLOW is provided for backward compatibility. We recommend using TERMINATE_CLUSTER instead.

Config

Type: HadoopStepConfig structure

The Hadoop job configuration of the cluster step.

Id

Type: string

The identifier of the cluster step.

Name

Type: string

The name of the cluster step.

Status

Type: StepStatus structure

The current execution status details of the cluster step.

StepConfig

Description

Specification of a cluster (job flow) step.

Members

ActionOnFailure

Type: string

HadoopJarStep

Required: Yes
Type: HadoopJarStepConfig structure

The JAR file used for the step.

Name

Required: Yes
Type: string

The name of the step.

StepDetail

Description

Combines the execution state and configuration of a step.

Members

ExecutionStatusDetail

Required: Yes
Type: StepExecutionStatusDetail structure

The description of the step status.

StepConfig

Required: Yes
Type: StepConfig structure

The step configuration.

StepExecutionStatusDetail

Description

The execution state of a step.

Members

CreationDateTime

Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The creation date and time of the step.

EndDateTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

The completion date and time of the step.

LastStateChangeReason

Type: string

A description of the step's current state.

StartDateTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

The start date and time of the step.

State

Required: Yes
Type: string

The state of the step.

StepStateChangeReason

Description

The details of the step state change reason.

Members

Code

Type: string

The programmable code for the state change reason. Note: Currently, the service provides no code for the state change.

Message

Type: string

The descriptive message for the state change reason.

StepStatus

Description

The execution status details of the cluster step.

Members

FailureDetails

Type: FailureDetails structure

The details for the step failure including reason, message, and log file path where the root cause was identified.

State

Type: string

The execution state of the cluster step.

StateChangeReason

Type: StepStateChangeReason structure

The reason for the step execution status change.

Timeline

Type: StepTimeline structure

The timeline of the cluster step status over time.

StepSummary

Description

The summary of the cluster step.

Members

ActionOnFailure

Type: string

The action to take when the cluster step fails. Possible values are TERMINATE_CLUSTER, CANCEL_AND_WAIT, and CONTINUE. TERMINATE_JOB_FLOW is available for backward compatibility. We recommend using TERMINATE_CLUSTER instead.

Config

Type: HadoopStepConfig structure

The Hadoop job configuration of the cluster step.

Id

Type: string

The identifier of the cluster step.

Name

Type: string

The name of the cluster step.

Status

Type: StepStatus structure

The current execution status details of the cluster step.

StepTimeline

Description

The timeline of the cluster step lifecycle.

Members

CreationDateTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time when the cluster step was created.

EndDateTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time when the cluster step execution completed or failed.

StartDateTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time when the cluster step execution started.

SupportedProductConfig

Description

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.

Members

Args

Type: Array of strings

The list of user-supplied arguments.

Name

Type: string

The name of the product configuration.

Tag

Description

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

Members

Key

Type: string

A user-defined key, which is the minimum required information for a valid tag. For more information, see Tag .

Value

Type: string

A user-defined value, which is optional in a tag. For more information, see Tag Clusters.

VolumeSpecification

Description

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.

Members

Iops

Type: int

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

SizeInGB

Required: Yes
Type: int

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.

VolumeType

Required: Yes
Type: string

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

Namespaces

Classes

Interfaces

Traits

Exceptions

Functions

Amazon Elastic MapReduce 2009-03-31

Operation Summary

Paginators

Waiters

Operations

AddInstanceFleet

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

AddInstanceGroups

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

AddJobFlowSteps

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

AddTags

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

CancelSteps

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CreateSecurityConfiguration

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

DeleteSecurityConfiguration

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

DescribeCluster

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

DescribeJobFlows

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members