AddInstanceFleet

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

Adds an instance fleet to a running cluster.

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>', ...],
                    ],
                    // ...
                ],
                'CustomAmiId' => '<string>',
                'EbsConfiguration' => [
                    'EbsBlockDeviceConfigs' => [
                        [
                            'VolumeSpecification' => [ // REQUIRED
                                'Iops' => <integer>,
                                'SizeInGB' => <integer>, // REQUIRED
                                'Throughput' => <integer>,
                                'VolumeType' => '<string>', // REQUIRED
                            ],
                            'VolumesPerInstance' => <integer>,
                        ],
                        // ...
                    ],
                    'EbsOptimized' => true || false,
                ],
                'InstanceType' => '<string>', // REQUIRED
                'WeightedCapacity' => <integer>,
            ],
            // ...
        ],
        'LaunchSpecifications' => [
            'OnDemandSpecification' => [
                'AllocationStrategy' => 'lowest-price', // REQUIRED
                'CapacityReservationOptions' => [
                    'CapacityReservationPreference' => 'open|none',
                    'CapacityReservationResourceGroupArn' => '<string>',
                    'UsageStrategy' => 'use-capacity-reservations-first',
                ],
            ],
            'SpotSpecification' => [
                'AllocationStrategy' => 'capacity-optimized|price-capacity-optimized|lowest-price|diversified',
                'BlockDurationMinutes' => <integer>,
                'TimeoutAction' => 'SWITCH_TO_ON_DEMAND|TERMINATE_CLUSTER', // REQUIRED
                'TimeoutDurationMinutes' => <integer>, // REQUIRED
            ],
        ],
        'Name' => '<string>',
        'ResizeSpecifications' => [
            'OnDemandResizeSpecification' => [
                'TimeoutDurationMinutes' => <integer>, // REQUIRED
            ],
            'SpotResizeSpecification' => [
                'TimeoutDurationMinutes' => <integer>, // REQUIRED
            ],
        ],
        'TargetOnDemandCapacity' => <integer>,
        'TargetSpotCapacity' => <integer>,
    ],
]);

Parameter Details

Result Syntax

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

Result Details

Errors

InternalServerException:

This exception occurs when there is an internal failure in the Amazon 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>', ...],
                ],
                // ...
            ],
            'CustomAmiId' => '<string>',
            'EbsConfiguration' => [
                'EbsBlockDeviceConfigs' => [
                    [
                        'VolumeSpecification' => [ // REQUIRED
                            'Iops' => <integer>,
                            'SizeInGB' => <integer>, // REQUIRED
                            'Throughput' => <integer>,
                            '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

Result Syntax

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

Result Details

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.

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([
    'ExecutionRoleArn' => '<string>',
    '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

Result Syntax

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

Result Details

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, such as a cluster or an Amazon EMR Studio. Tags make it easier to associate resources 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

Result Syntax

[]

Result Details

Errors

InternalServerException:

This exception occurs when there is an internal failure in the Amazon 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 that a step will be canceled, even if the request is successfully submitted. When you use Amazon EMR releases 5.28.0 and later, you can cancel steps that are in a PENDING or RUNNING state. In earlier versions of Amazon EMR, you can only cancel steps that are in a PENDING state.

Parameter Syntax

$result = $client->cancelSteps([
    'ClusterId' => '<string>', // REQUIRED
    'StepCancellationOption' => 'SEND_INTERRUPT|TERMINATE_PROCESS',
    'StepIds' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

Errors

InternalServerException:

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

InvalidRequestException:

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

CreateStudio

$result = $client->createStudio([/* ... */]);
$promise = $client->createStudioAsync([/* ... */]);

Creates a new Amazon EMR Studio.

Parameter Syntax

$result = $client->createStudio([
    'AuthMode' => 'SSO|IAM', // REQUIRED
    'DefaultS3Location' => '<string>', // REQUIRED
    'Description' => '<string>',
    'EncryptionKeyArn' => '<string>',
    'EngineSecurityGroupId' => '<string>', // REQUIRED
    'IdcInstanceArn' => '<string>',
    'IdcUserAssignment' => 'REQUIRED|OPTIONAL',
    'IdpAuthUrl' => '<string>',
    'IdpRelayStateParameterName' => '<string>',
    'Name' => '<string>', // REQUIRED
    'ServiceRole' => '<string>', // REQUIRED
    'SubnetIds' => ['<string>', ...], // REQUIRED
    'Tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
    'TrustedIdentityPropagationEnabled' => true || false,
    'UserRole' => '<string>',
    'VpcId' => '<string>', // REQUIRED
    'WorkspaceSecurityGroupId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'StudioId' => '<string>',
    'Url' => '<string>',
]

Result Details

Errors

InternalServerException:

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

InvalidRequestException:

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

CreateStudioSessionMapping

$result = $client->createStudioSessionMapping([/* ... */]);
$promise = $client->createStudioSessionMappingAsync([/* ... */]);

Maps a user or group to the Amazon EMR Studio specified by StudioId, and applies a session policy to refine Studio permissions for that user or group. Use CreateStudioSessionMapping to assign users to a Studio when you use IAM Identity Center authentication. For instructions on how to assign users to a Studio when you use IAM authentication, see Assign a user or group to your EMR Studio.

Parameter Syntax

$result = $client->createStudioSessionMapping([
    'IdentityId' => '<string>',
    'IdentityName' => '<string>',
    'IdentityType' => 'USER|GROUP', // REQUIRED
    'SessionPolicyArn' => '<string>', // REQUIRED
    'StudioId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

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.

DeleteSecurityConfiguration

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

Deletes a security configuration.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

InternalServerException:

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

InvalidRequestException:

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

DeleteStudio

$result = $client->deleteStudio([/* ... */]);
$promise = $client->deleteStudioAsync([/* ... */]);

Removes an Amazon EMR Studio from the Studio metadata store.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

InternalServerException:

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

InvalidRequestException:

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

DeleteStudioSessionMapping

$result = $client->deleteStudioSessionMapping([/* ... */]);
$promise = $client->deleteStudioSessionMappingAsync([/* ... */]);

Removes a user or group from an Amazon EMR Studio.

Parameter Syntax

$result = $client->deleteStudioSessionMapping([
    'IdentityId' => '<string>',
    'IdentityName' => '<string>',
    'IdentityType' => 'USER|GROUP', // REQUIRED
    'StudioId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

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.

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

Result Syntax

[
    'Cluster' => [
        'Applications' => [
            [
                'AdditionalInfo' => ['<string>', ...],
                'Args' => ['<string>', ...],
                'Name' => '<string>',
                'Version' => '<string>',
            ],
            // ...
        ],
        'AutoScalingRole' => '<string>',
        'AutoTerminate' => true || false,
        'ClusterArn' => '<string>',
        'Configurations' => [
            [
                'Classification' => '<string>',
                'Configurations' => [...], // RECURSIVE
                'Properties' => ['<string>', ...],
            ],
            // ...
        ],
        'CustomAmiId' => '<string>',
        'EbsRootVolumeIops' => <integer>,
        'EbsRootVolumeSize' => <integer>,
        'EbsRootVolumeThroughput' => <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>',
        ],
        'LogEncryptionKmsKeyId' => '<string>',
        'LogUri' => '<string>',
        'MasterPublicDnsName' => '<string>',
        'Name' => '<string>',
        'NormalizedInstanceHours' => <integer>,
        'OSReleaseLabel' => '<string>',
        'OutpostArn' => '<string>',
        'PlacementGroups' => [
            [
                'InstanceRole' => 'MASTER|CORE|TASK',
                'PlacementStrategy' => 'SPREAD|PARTITION|CLUSTER|NONE',
            ],
            // ...
        ],
        'ReleaseLabel' => '<string>',
        'RepoUpgradeOnBoot' => 'SECURITY|NONE',
        'RequestedAmiVersion' => '<string>',
        'RunningAmiVersion' => '<string>',
        'ScaleDownBehavior' => 'TERMINATE_AT_INSTANCE_HOUR|TERMINATE_AT_TASK_COMPLETION',
        'SecurityConfiguration' => '<string>',
        'ServiceRole' => '<string>',
        'Status' => [
            'ErrorDetails' => [
                [
                    'ErrorCode' => '<string>',
                    'ErrorData' => [
                        ['<string>', ...],
                        // ...
                    ],
                    'ErrorMessage' => '<string>',
                ],
                // ...
            ],
            '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>,
            ],
        ],
        'StepConcurrencyLevel' => <integer>,
        'Tags' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
        'TerminationProtected' => true || false,
        'UnhealthyNodeReplacement' => true || false,
        'VisibleToAllUsers' => true || false,
    ],
]

Result Details

Errors

InternalServerException:

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

InvalidRequestException:

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

DescribeJobFlows

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

This API is no longer supported 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

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>,
                        'CustomAmiId' => '<string>',
                        '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,
                'UnhealthyNodeReplacement' => true || false,
            ],
            'JobFlowId' => '<string>',
            'JobFlowRole' => '<string>',
            'LogEncryptionKmsKeyId' => '<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

Errors

InternalServerError:

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

DescribeNotebookExecution

$result = $client->describeNotebookExecution([/* ... */]);
$promise = $client->describeNotebookExecutionAsync([/* ... */]);

Provides details of a notebook execution.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'NotebookExecution' => [
        'Arn' => '<string>',
        'EditorId' => '<string>',
        'EndTime' => <DateTime>,
        'EnvironmentVariables' => ['<string>', ...],
        'ExecutionEngine' => [
            'ExecutionRoleArn' => '<string>',
            'Id' => '<string>',
            'MasterInstanceSecurityGroupId' => '<string>',
            'Type' => 'EMR',
        ],
        'LastStateChangeReason' => '<string>',
        'NotebookExecutionId' => '<string>',
        'NotebookExecutionName' => '<string>',
        'NotebookInstanceSecurityGroupId' => '<string>',
        'NotebookParams' => '<string>',
        'NotebookS3Location' => [
            'Bucket' => '<string>',
            'Key' => '<string>',
        ],
        'OutputNotebookFormat' => 'HTML',
        'OutputNotebookS3Location' => [
            'Bucket' => '<string>',
            'Key' => '<string>',
        ],
        'OutputNotebookURI' => '<string>',
        'StartTime' => <DateTime>,
        'Status' => 'START_PENDING|STARTING|RUNNING|FINISHING|FINISHED|FAILING|FAILED|STOP_PENDING|STOPPING|STOPPED',
        'Tags' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
    ],
]

Result Details

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.

DescribeReleaseLabel

$result = $client->describeReleaseLabel([/* ... */]);
$promise = $client->describeReleaseLabelAsync([/* ... */]);

Provides Amazon EMR release label details, such as the releases available the Region where the API request is run, and the available applications for a specific Amazon EMR release label. Can also list Amazon EMR releases that support a specified version of Spark.

Parameter Syntax

$result = $client->describeReleaseLabel([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'ReleaseLabel' => '<string>',
]);

Parameter Details

Result Syntax

[
    'Applications' => [
        [
            'Name' => '<string>',
            'Version' => '<string>',
        ],
        // ...
    ],
    'AvailableOSReleases' => [
        [
            'Label' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
    'ReleaseLabel' => '<string>',
]

Result Details

Errors

InternalServerException:

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

InvalidRequestException:

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

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

Result Syntax

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

Result Details

Errors

InternalServerException:

This exception occurs when there is an internal failure in the Amazon 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

Result Syntax

[
    'Step' => [
        'ActionOnFailure' => 'TERMINATE_JOB_FLOW|TERMINATE_CLUSTER|CANCEL_AND_WAIT|CONTINUE',
        'Config' => [
            'Args' => ['<string>', ...],
            'Jar' => '<string>',
            'MainClass' => '<string>',
            'Properties' => ['<string>', ...],
        ],
        'ExecutionRoleArn' => '<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

Errors

InternalServerException:

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

InvalidRequestException:

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

DescribeStudio

$result = $client->describeStudio([/* ... */]);
$promise = $client->describeStudioAsync([/* ... */]);

Returns details for the specified Amazon EMR Studio including ID, Name, VPC, Studio access URL, and so on.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'Studio' => [
        'AuthMode' => 'SSO|IAM',
        'CreationTime' => <DateTime>,
        'DefaultS3Location' => '<string>',
        'Description' => '<string>',
        'EncryptionKeyArn' => '<string>',
        'EngineSecurityGroupId' => '<string>',
        'IdcInstanceArn' => '<string>',
        'IdcUserAssignment' => 'REQUIRED|OPTIONAL',
        'IdpAuthUrl' => '<string>',
        'IdpRelayStateParameterName' => '<string>',
        'Name' => '<string>',
        'ServiceRole' => '<string>',
        'StudioArn' => '<string>',
        'StudioId' => '<string>',
        'SubnetIds' => ['<string>', ...],
        'Tags' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
        'TrustedIdentityPropagationEnabled' => true || false,
        'Url' => '<string>',
        'UserRole' => '<string>',
        'VpcId' => '<string>',
        'WorkspaceSecurityGroupId' => '<string>',
    ],
]

Result Details

Errors

InternalServerException:

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

InvalidRequestException:

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

GetAutoTerminationPolicy

$result = $client->getAutoTerminationPolicy([/* ... */]);
$promise = $client->getAutoTerminationPolicyAsync([/* ... */]);

Returns the auto-termination policy for an Amazon EMR cluster.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'AutoTerminationPolicy' => [
        'IdleTimeout' => <integer>,
    ],
]

Result Details

Errors

There are no errors described for this operation.

GetBlockPublicAccessConfiguration

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

Returns the Amazon EMR block public access configuration for your Amazon Web Services 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

Result Syntax

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

Result Details

Errors

InternalServerException:

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

InvalidRequestException:

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

GetClusterSessionCredentials

$result = $client->getClusterSessionCredentials([/* ... */]);
$promise = $client->getClusterSessionCredentialsAsync([/* ... */]);

Provides temporary, HTTP basic credentials that are associated with a given runtime IAM role and used by a cluster with fine-grained access control activated. You can use these credentials to connect to cluster endpoints that support username and password authentication.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'Credentials' => [
        'UsernamePassword' => [
            'Password' => '<string>',
            'Username' => '<string>',
        ],
    ],
    'ExpiresAt' => <DateTime>,
]

Result Details

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.

GetManagedScalingPolicy

$result = $client->getManagedScalingPolicy([/* ... */]);
$promise = $client->getManagedScalingPolicyAsync([/* ... */]);

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

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'ManagedScalingPolicy' => [
        'ComputeLimits' => [
            'MaximumCapacityUnits' => <integer>,
            'MaximumCoreCapacityUnits' => <integer>,
            'MaximumOnDemandCapacityUnits' => <integer>,
            'MinimumCapacityUnits' => <integer>,
            'UnitType' => 'InstanceFleetUnits|Instances|VCPU',
        ],
    ],
]

Result Details

Errors

There are no errors described for this operation.

GetStudioSessionMapping

$result = $client->getStudioSessionMapping([/* ... */]);
$promise = $client->getStudioSessionMappingAsync([/* ... */]);

Fetches mapping details for the specified Amazon EMR Studio and identity (user or group).

Parameter Syntax

$result = $client->getStudioSessionMapping([
    'IdentityId' => '<string>',
    'IdentityName' => '<string>',
    'IdentityType' => 'USER|GROUP', // REQUIRED
    'StudioId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'SessionMapping' => [
        'CreationTime' => <DateTime>,
        'IdentityId' => '<string>',
        'IdentityName' => '<string>',
        'IdentityType' => 'USER|GROUP',
        'LastModifiedTime' => <DateTime>,
        'SessionPolicyArn' => '<string>',
        'StudioId' => '<string>',
    ],
]

Result Details

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.

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

Result Syntax

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

Result Details

Errors

InternalServerException:

This exception occurs when there is an internal failure in the Amazon 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 Amazon Web Services 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 in unsorted order 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

Result Syntax

[
    'Clusters' => [
        [
            'ClusterArn' => '<string>',
            'Id' => '<string>',
            'Name' => '<string>',
            'NormalizedInstanceHours' => <integer>,
            'OutpostArn' => '<string>',
            'Status' => [
                'ErrorDetails' => [
                    [
                        'ErrorCode' => '<string>',
                        'ErrorData' => [
                            ['<string>', ...],
                            // ...
                        ],
                        'ErrorMessage' => '<string>',
                    ],
                    // ...
                ],
                '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

Errors

InternalServerException:

This exception occurs when there is an internal failure in the Amazon 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.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'InstanceFleets' => [
        [
            'Id' => '<string>',
            'InstanceFleetType' => 'MASTER|CORE|TASK',
            'InstanceTypeSpecifications' => [
                [
                    'BidPrice' => '<string>',
                    'BidPriceAsPercentageOfOnDemandPrice' => <float>,
                    'Configurations' => [
                        [
                            'Classification' => '<string>',
                            'Configurations' => [...], // RECURSIVE
                            'Properties' => ['<string>', ...],
                        ],
                        // ...
                    ],
                    'CustomAmiId' => '<string>',
                    'EbsBlockDevices' => [
                        [
                            'Device' => '<string>',
                            'VolumeSpecification' => [
                                'Iops' => <integer>,
                                'SizeInGB' => <integer>,
                                'Throughput' => <integer>,
                                'VolumeType' => '<string>',
                            ],
                        ],
                        // ...
                    ],
                    'EbsOptimized' => true || false,
                    'InstanceType' => '<string>',
                    'WeightedCapacity' => <integer>,
                ],
                // ...
            ],
            'LaunchSpecifications' => [
                'OnDemandSpecification' => [
                    'AllocationStrategy' => 'lowest-price',
                    'CapacityReservationOptions' => [
                        'CapacityReservationPreference' => 'open|none',
                        'CapacityReservationResourceGroupArn' => '<string>',
                        'UsageStrategy' => 'use-capacity-reservations-first',
                    ],
                ],
                'SpotSpecification' => [
                    'AllocationStrategy' => 'capacity-optimized|price-capacity-optimized|lowest-price|diversified',
                    'BlockDurationMinutes' => <integer>,
                    'TimeoutAction' => 'SWITCH_TO_ON_DEMAND|TERMINATE_CLUSTER',
                    'TimeoutDurationMinutes' => <integer>,
                ],
            ],
            'Name' => '<string>',
            'ProvisionedOnDemandCapacity' => <integer>,
            'ProvisionedSpotCapacity' => <integer>,
            'ResizeSpecifications' => [
                'OnDemandResizeSpecification' => [
                    'TimeoutDurationMinutes' => <integer>,
                ],
                'SpotResizeSpecification' => [
                    'TimeoutDurationMinutes' => <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

Errors

InternalServerException:

This exception occurs when there is an internal failure in the Amazon 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

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>,
            'CustomAmiId' => '<string>',
            'EbsBlockDevices' => [
                [
                    'Device' => '<string>',
                    'VolumeSpecification' => [
                        'Iops' => <integer>,
                        'SizeInGB' => <integer>,
                        'Throughput' => <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

Errors

InternalServerException:

This exception occurs when there is an internal failure in the Amazon 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 Amazon EC2 instances and Amazon EC2 instances terminated in the last 30 days, up to a maximum of 2,000. Amazon 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

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

Errors

InternalServerException:

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

InvalidRequestException:

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

ListNotebookExecutions

$result = $client->listNotebookExecutions([/* ... */]);
$promise = $client->listNotebookExecutionsAsync([/* ... */]);

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

Parameter Syntax

$result = $client->listNotebookExecutions([
    'EditorId' => '<string>',
    'ExecutionEngineId' => '<string>',
    'From' => <integer || string || DateTime>,
    'Marker' => '<string>',
    'Status' => 'START_PENDING|STARTING|RUNNING|FINISHING|FINISHED|FAILING|FAILED|STOP_PENDING|STOPPING|STOPPED',
    'To' => <integer || string || DateTime>,
]);

Parameter Details

Result Syntax

[
    'Marker' => '<string>',
    'NotebookExecutions' => [
        [
            'EditorId' => '<string>',
            'EndTime' => <DateTime>,
            'ExecutionEngineId' => '<string>',
            'NotebookExecutionId' => '<string>',
            'NotebookExecutionName' => '<string>',
            'NotebookS3Location' => [
                'Bucket' => '<string>',
                'Key' => '<string>',
            ],
            'StartTime' => <DateTime>,
            'Status' => 'START_PENDING|STARTING|RUNNING|FINISHING|FINISHED|FAILING|FAILED|STOP_PENDING|STOPPING|STOPPED',
        ],
        // ...
    ],
]

Result Details

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.

ListReleaseLabels

$result = $client->listReleaseLabels([/* ... */]);
$promise = $client->listReleaseLabelsAsync([/* ... */]);

Retrieves release labels of Amazon EMR services in the Region where the API is called.

Parameter Syntax

$result = $client->listReleaseLabels([
    'Filters' => [
        'Application' => '<string>',
        'Prefix' => '<string>',
    ],
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'ReleaseLabels' => ['<string>', ...],
]

Result Details

Errors

InternalServerException:

This exception occurs when there is an internal failure in the Amazon 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

Result Syntax

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

Result Details

Errors

InternalServerException:

This exception occurs when there is an internal failure in the Amazon 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 or filter by StepStates. You can specify a maximum of 10 stepIDs. The CLI automatically paginates results to return a list greater than 50 steps. To return more than 50 steps using the CLI, specify a Marker, which is a pagination token that indicates the next set of steps to retrieve.

Parameter Syntax

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

Parameter Details

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

Errors

InternalServerException:

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

InvalidRequestException:

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

ListStudioSessionMappings

$result = $client->listStudioSessionMappings([/* ... */]);
$promise = $client->listStudioSessionMappingsAsync([/* ... */]);

Returns a list of all user or group session mappings for the Amazon EMR Studio specified by StudioId.

Parameter Syntax

$result = $client->listStudioSessionMappings([
    'IdentityType' => 'USER|GROUP',
    'Marker' => '<string>',
    'StudioId' => '<string>',
]);

Parameter Details

Result Syntax

[
    'Marker' => '<string>',
    'SessionMappings' => [
        [
            'CreationTime' => <DateTime>,
            'IdentityId' => '<string>',
            'IdentityName' => '<string>',
            'IdentityType' => 'USER|GROUP',
            'SessionPolicyArn' => '<string>',
            'StudioId' => '<string>',
        ],
        // ...
    ],
]

Result Details

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.

ListStudios

$result = $client->listStudios([/* ... */]);
$promise = $client->listStudiosAsync([/* ... */]);

Returns a list of all Amazon EMR Studios associated with the Amazon Web Services account. The list includes details such as ID, Studio Access URL, and creation time for each Studio.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'Marker' => '<string>',
    'Studios' => [
        [
            'AuthMode' => 'SSO|IAM',
            'CreationTime' => <DateTime>,
            'Description' => '<string>',
            'Name' => '<string>',
            'StudioId' => '<string>',
            'Url' => '<string>',
            'VpcId' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

InternalServerException:

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

InvalidRequestException:

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

ListSupportedInstanceTypes

$result = $client->listSupportedInstanceTypes([/* ... */]);
$promise = $client->listSupportedInstanceTypesAsync([/* ... */]);

A list of the instance types that Amazon EMR supports. You can filter the list by Amazon Web Services Region and Amazon EMR release.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'Marker' => '<string>',
    'SupportedInstanceTypes' => [
        [
            'Architecture' => '<string>',
            'EbsOptimizedAvailable' => true || false,
            'EbsOptimizedByDefault' => true || false,
            'EbsStorageOnly' => true || false,
            'InstanceFamilyId' => '<string>',
            'Is64BitsOnly' => true || false,
            'MemoryGB' => <float>,
            'NumberOfDisks' => <integer>,
            'StorageGB' => <integer>,
            'Type' => '<string>',
            'VCPU' => <integer>,
        ],
        // ...
    ],
]

Result Details

Errors

InternalServerException:

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

InvalidRequestException:

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

ModifyCluster

$result = $client->modifyCluster([/* ... */]);
$promise = $client->modifyClusterAsync([/* ... */]);

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

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'StepConcurrencyLevel' => <integer>,
]

Result Details

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.

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.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

InternalServerException:

This exception occurs when there is an internal failure in the Amazon 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
            'ReconfigurationType' => 'OVERWRITE|MERGE',
            'ShrinkPolicy' => [
                'DecommissionTimeout' => <integer>,
                'InstanceResizePolicy' => [
                    'InstanceTerminationTimeout' => <integer>,
                    'InstancesToProtect' => ['<string>', ...],
                    'InstancesToTerminate' => ['<string>', ...],
                ],
            ],
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[]

Result Details

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

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>',
            ],
        ],
    ],
    'ClusterArn' => '<string>',
    'ClusterId' => '<string>',
    'InstanceGroupId' => '<string>',
]

Result Details

Errors

There are no errors described for this operation.

PutAutoTerminationPolicy

$result = $client->putAutoTerminationPolicy([/* ... */]);
$promise = $client->putAutoTerminationPolicyAsync([/* ... */]);

Auto-termination is supported in Amazon EMR releases 5.30.0 and 6.1.0 and later. For more information, see Using an auto-termination policy.

Creates or updates an auto-termination policy for an Amazon EMR cluster. An auto-termination policy defines the amount of idle time in seconds after which a cluster automatically terminates. For alternative cluster termination options, see Control cluster termination.

Parameter Syntax

$result = $client->putAutoTerminationPolicy([
    'AutoTerminationPolicy' => [
        'IdleTimeout' => <integer>,
    ],
    'ClusterId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

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 Amazon Web Services 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

Result Syntax

[]

Result Details

Errors

InternalServerException:

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

InvalidRequestException:

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

PutManagedScalingPolicy

$result = $client->putManagedScalingPolicy([/* ... */]);
$promise = $client->putManagedScalingPolicyAsync([/* ... */]);

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

Parameter Syntax

$result = $client->putManagedScalingPolicy([
    'ClusterId' => '<string>', // REQUIRED
    'ManagedScalingPolicy' => [ // REQUIRED
        'ComputeLimits' => [
            'MaximumCapacityUnits' => <integer>, // REQUIRED
            'MaximumCoreCapacityUnits' => <integer>,
            'MaximumOnDemandCapacityUnits' => <integer>,
            'MinimumCapacityUnits' => <integer>, // REQUIRED
            'UnitType' => 'InstanceFleetUnits|Instances|VCPU', // REQUIRED
        ],
    ],
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

There are no errors described for this operation.

RemoveAutoScalingPolicy

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

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

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

There are no errors described for this operation.

RemoveAutoTerminationPolicy

$result = $client->removeAutoTerminationPolicy([/* ... */]);
$promise = $client->removeAutoTerminationPolicyAsync([/* ... */]);

Removes an auto-termination policy from an Amazon EMR cluster.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

There are no errors described for this operation.

RemoveManagedScalingPolicy

$result = $client->removeManagedScalingPolicy([/* ... */]);
$promise = $client->removeManagedScalingPolicyAsync([/* ... */]);

Removes a managed scaling policy from a specified Amazon EMR cluster.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

There are no errors described for this operation.

RemoveTags

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

Removes tags from an Amazon EMR resource, such as a cluster or Amazon EMR Studio. Tags make it easier to associate resources 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

Result Syntax

[]

Result Details

Errors

InternalServerException:

This exception occurs when there is an internal failure in the Amazon 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 long-running clusters, we recommend that you periodically store your results.

Parameter Syntax

$result = $client->runJobFlow([
    'AdditionalInfo' => '<string>',
    'AmiVersion' => '<string>',
    'Applications' => [
        [
            'AdditionalInfo' => ['<string>', ...],
            'Args' => ['<string>', ...],
            'Name' => '<string>',
            'Version' => '<string>',
        ],
        // ...
    ],
    'AutoScalingRole' => '<string>',
    'AutoTerminationPolicy' => [
        'IdleTimeout' => <integer>,
    ],
    'BootstrapActions' => [
        [
            'Name' => '<string>', // REQUIRED
            'ScriptBootstrapAction' => [ // REQUIRED
                'Args' => ['<string>', ...],
                'Path' => '<string>', // REQUIRED
            ],
        ],
        // ...
    ],
    'Configurations' => [
        [
            'Classification' => '<string>',
            'Configurations' => [...], // RECURSIVE
            'Properties' => ['<string>', ...],
        ],
        // ...
    ],
    'CustomAmiId' => '<string>',
    'EbsRootVolumeIops' => <integer>,
    'EbsRootVolumeSize' => <integer>,
    'EbsRootVolumeThroughput' => <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>', ...],
                            ],
                            // ...
                        ],
                        'CustomAmiId' => '<string>',
                        'EbsConfiguration' => [
                            'EbsBlockDeviceConfigs' => [
                                [
                                    'VolumeSpecification' => [ // REQUIRED
                                        'Iops' => <integer>,
                                        'SizeInGB' => <integer>, // REQUIRED
                                        'Throughput' => <integer>,
                                        'VolumeType' => '<string>', // REQUIRED
                                    ],
                                    'VolumesPerInstance' => <integer>,
                                ],
                                // ...
                            ],
                            'EbsOptimized' => true || false,
                        ],
                        'InstanceType' => '<string>', // REQUIRED
                        'WeightedCapacity' => <integer>,
                    ],
                    // ...
                ],
                'LaunchSpecifications' => [
                    'OnDemandSpecification' => [
                        'AllocationStrategy' => 'lowest-price', // REQUIRED
                        'CapacityReservationOptions' => [
                            'CapacityReservationPreference' => 'open|none',
                            'CapacityReservationResourceGroupArn' => '<string>',
                            'UsageStrategy' => 'use-capacity-reservations-first',
                        ],
                    ],
                    'SpotSpecification' => [
                        'AllocationStrategy' => 'capacity-optimized|price-capacity-optimized|lowest-price|diversified',
                        'BlockDurationMinutes' => <integer>,
                        'TimeoutAction' => 'SWITCH_TO_ON_DEMAND|TERMINATE_CLUSTER', // REQUIRED
                        'TimeoutDurationMinutes' => <integer>, // REQUIRED
                    ],
                ],
                'Name' => '<string>',
                'ResizeSpecifications' => [
                    'OnDemandResizeSpecification' => [
                        'TimeoutDurationMinutes' => <integer>, // REQUIRED
                    ],
                    'SpotResizeSpecification' => [
                        'TimeoutDurationMinutes' => <integer>, // REQUIRED
                    ],
                ],
                '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>', ...],
                    ],
                    // ...
                ],
                'CustomAmiId' => '<string>',
                'EbsConfiguration' => [
                    'EbsBlockDeviceConfigs' => [
                        [
                            'VolumeSpecification' => [ // REQUIRED
                                'Iops' => <integer>,
                                'SizeInGB' => <integer>, // REQUIRED
                                'Throughput' => <integer>,
                                '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,
        'UnhealthyNodeReplacement' => true || false,
    ],
    'JobFlowRole' => '<string>',
    'KerberosAttributes' => [
        'ADDomainJoinPassword' => '<string>',
        'ADDomainJoinUser' => '<string>',
        'CrossRealmTrustPrincipalPassword' => '<string>',
        'KdcAdminPassword' => '<string>', // REQUIRED
        'Realm' => '<string>', // REQUIRED
    ],
    'LogEncryptionKmsKeyId' => '<string>',
    'LogUri' => '<string>',
    'ManagedScalingPolicy' => [
        'ComputeLimits' => [
            'MaximumCapacityUnits' => <integer>, // REQUIRED
            'MaximumCoreCapacityUnits' => <integer>,
            'MaximumOnDemandCapacityUnits' => <integer>,
            'MinimumCapacityUnits' => <integer>, // REQUIRED
            'UnitType' => 'InstanceFleetUnits|Instances|VCPU', // REQUIRED
        ],
    ],
    'Name' => '<string>', // REQUIRED
    'NewSupportedProducts' => [
        [
            'Args' => ['<string>', ...],
            'Name' => '<string>',
        ],
        // ...
    ],
    'OSReleaseLabel' => '<string>',
    'PlacementGroupConfigs' => [
        [
            'InstanceRole' => 'MASTER|CORE|TASK', // REQUIRED
            'PlacementStrategy' => 'SPREAD|PARTITION|CLUSTER|NONE',
        ],
        // ...
    ],
    'ReleaseLabel' => '<string>',
    'RepoUpgradeOnBoot' => 'SECURITY|NONE',
    'ScaleDownBehavior' => 'TERMINATE_AT_INSTANCE_HOUR|TERMINATE_AT_TASK_COMPLETION',
    'SecurityConfiguration' => '<string>',
    'ServiceRole' => '<string>',
    'StepConcurrencyLevel' => <integer>,
    '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

Result Syntax

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

Result Details

Errors

InternalServerError:

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

SetKeepJobFlowAliveWhenNoSteps

$result = $client->setKeepJobFlowAliveWhenNoSteps([/* ... */]);
$promise = $client->setKeepJobFlowAliveWhenNoStepsAsync([/* ... */]);

You can use the SetKeepJobFlowAliveWhenNoSteps to configure a cluster (job flow) to terminate after the step execution, i.e., all your steps are executed. If you want a transient cluster that shuts down after the last of the current executing steps are completed, you can configure SetKeepJobFlowAliveWhenNoSteps to false. If you want a long running cluster, configure SetKeepJobFlowAliveWhenNoSteps to true.

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

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

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 Amazon 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 Amazon 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, see Managing Cluster Termination in the Amazon EMR Management Guide.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

InternalServerError:

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

SetUnhealthyNodeReplacement

$result = $client->setUnhealthyNodeReplacement([/* ... */]);
$promise = $client->setUnhealthyNodeReplacementAsync([/* ... */]);

Specify whether to enable unhealthy node replacement, which lets Amazon EMR gracefully replace core nodes on a cluster if any nodes become unhealthy. For example, a node becomes unhealthy if disk usage is above 90%. If unhealthy node replacement is on and TerminationProtected are off, Amazon EMR immediately terminates the unhealthy core nodes. To use unhealthy node replacement and retain unhealthy core nodes, use to turn on termination protection. In such cases, Amazon EMR adds the unhealthy nodes to a denylist, reducing job interruptions and failures.

If unhealthy node replacement is on, Amazon EMR notifies YARN and other applications on the cluster to stop scheduling tasks with these nodes, moves the data, and then terminates the nodes.

For more information, see graceful node replacement in the Amazon EMR Management Guide.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

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([/* ... */]);

The SetVisibleToAllUsers parameter is no longer supported. Your cluster may be visible to all users in your account. To restrict cluster access using an IAM policy, see Identity and Access Management for Amazon EMR.

Sets the Cluster$VisibleToAllUsers value for an Amazon EMR cluster. When true, IAM principals in the Amazon Web Services account can perform Amazon EMR cluster actions that their IAM policies allow. When false, only the IAM principal that created the cluster and the Amazon Web Services account root user can perform Amazon EMR actions on the cluster, regardless of IAM permissions policies attached to other IAM principals.

This action works on running clusters. When you create a cluster, use the RunJobFlowInput$VisibleToAllUsers parameter.

For more information, see Understanding the Amazon EMR Cluster VisibleToAllUsers Setting in the Amazon EMR Management Guide.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

InternalServerError:

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

StartNotebookExecution

$result = $client->startNotebookExecution([/* ... */]);
$promise = $client->startNotebookExecutionAsync([/* ... */]);

Starts a notebook execution.

Parameter Syntax

$result = $client->startNotebookExecution([
    'EditorId' => '<string>',
    'EnvironmentVariables' => ['<string>', ...],
    'ExecutionEngine' => [ // REQUIRED
        'ExecutionRoleArn' => '<string>',
        'Id' => '<string>', // REQUIRED
        'MasterInstanceSecurityGroupId' => '<string>',
        'Type' => 'EMR',
    ],
    'NotebookExecutionName' => '<string>',
    'NotebookInstanceSecurityGroupId' => '<string>',
    'NotebookParams' => '<string>',
    'NotebookS3Location' => [
        'Bucket' => '<string>',
        'Key' => '<string>',
    ],
    'OutputNotebookFormat' => 'HTML',
    'OutputNotebookS3Location' => [
        'Bucket' => '<string>',
        'Key' => '<string>',
    ],
    'RelativePath' => '<string>',
    'ServiceRole' => '<string>', // REQUIRED
    'Tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

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

Result Details

Errors

InternalServerException:

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

InvalidRequestException:

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

StopNotebookExecution

$result = $client->stopNotebookExecution([/* ... */]);
$promise = $client->stopNotebookExecutionAsync([/* ... */]);

Stops a notebook execution.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

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.

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

Result Syntax

[]

Result Details

Errors

InternalServerError:

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

UpdateStudio

$result = $client->updateStudio([/* ... */]);
$promise = $client->updateStudioAsync([/* ... */]);

Updates an Amazon EMR Studio configuration, including attributes such as name, description, and subnets.

Parameter Syntax

$result = $client->updateStudio([
    'DefaultS3Location' => '<string>',
    'Description' => '<string>',
    'EncryptionKeyArn' => '<string>',
    'Name' => '<string>',
    'StudioId' => '<string>', // REQUIRED
    'SubnetIds' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InternalServerException:

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

InvalidRequestException:

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

UpdateStudioSessionMapping

$result = $client->updateStudioSessionMapping([/* ... */]);
$promise = $client->updateStudioSessionMappingAsync([/* ... */]);

Updates the session policy attached to the user or group for the specified Amazon EMR Studio.

Parameter Syntax

$result = $client->updateStudioSessionMapping([
    'IdentityId' => '<string>',
    'IdentityName' => '<string>',
    'IdentityType' => 'USER|GROUP', // REQUIRED
    'SessionPolicyArn' => '<string>', // REQUIRED
    'StudioId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

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.