Amazon Elastic MapReduce 2009-03-31

AddInstanceFleet

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

Parameter Syntax

$result = $client->addInstanceFleet([
    'ClusterId' => '<string>', // REQUIRED
    'InstanceFleet' => [ // REQUIRED
        'InstanceFleetType' => 'MASTER|CORE|TASK', // REQUIRED
        'InstanceTypeConfigs' => [
            [
                'BidPrice' => '<string>',
                'BidPriceAsPercentageOfOnDemandPrice' => <float>,
                'Configurations' => [
                    [
                        'Classification' => '<string>',
                        'Configurations' => [...], // RECURSIVE
                        'Properties' => ['<string>', ...],
                    ],
                    // ...
                ],
                'EbsConfiguration' => [
                    'EbsBlockDeviceConfigs' => [
                        [
                            'VolumeSpecification' => [ // REQUIRED
                                'Iops' => <integer>,
                                'SizeInGB' => <integer>, // REQUIRED
                                'VolumeType' => '<string>', // REQUIRED
                            ],
                            'VolumesPerInstance' => <integer>,
                        ],
                        // ...
                    ],
                    'EbsOptimized' => true || false,
                ],
                'InstanceType' => '<string>', // REQUIRED
                'WeightedCapacity' => <integer>,
            ],
            // ...
        ],
        'LaunchSpecifications' => [
            'OnDemandSpecification' => [
                'AllocationStrategy' => 'lowest-price', // REQUIRED
                'CapacityReservationOptions' => [
                    'CapacityReservationPreference' => 'open|none',
                    'CapacityReservationResourceGroupArn' => '<string>',
                    'UsageStrategy' => 'use-capacity-reservations-first',
                ],
            ],
            'SpotSpecification' => [
                'AllocationStrategy' => 'capacity-optimized',
                'BlockDurationMinutes' => <integer>,
                'TimeoutAction' => 'SWITCH_TO_ON_DEMAND|TERMINATE_CLUSTER', // REQUIRED
                'TimeoutDurationMinutes' => <integer>, // REQUIRED
            ],
        ],
        'Name' => '<string>',
        '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([/* ... */]);

Parameter Syntax

$result = $client->addInstanceGroups([
    'InstanceGroups' => [ // REQUIRED
        [
            'AutoScalingPolicy' => [
                'Constraints' => [ // REQUIRED
                    'MaxCapacity' => <integer>, // REQUIRED
                    'MinCapacity' => <integer>, // REQUIRED
                ],
                'Rules' => [ // REQUIRED
                    [
                        'Action' => [ // REQUIRED
                            'Market' => 'ON_DEMAND|SPOT',
                            'SimpleScalingPolicyConfiguration' => [ // REQUIRED
                                'AdjustmentType' => 'CHANGE_IN_CAPACITY|PERCENT_CHANGE_IN_CAPACITY|EXACT_CAPACITY',
                                'CoolDown' => <integer>,
                                'ScalingAdjustment' => <integer>, // REQUIRED
                            ],
                        ],
                        'Description' => '<string>',
                        'Name' => '<string>', // REQUIRED
                        'Trigger' => [ // REQUIRED
                            'CloudWatchAlarmDefinition' => [ // REQUIRED
                                'ComparisonOperator' => 'GREATER_THAN_OR_EQUAL|GREATER_THAN|LESS_THAN|LESS_THAN_OR_EQUAL', // REQUIRED
                                'Dimensions' => [
                                    [
                                        'Key' => '<string>',
                                        'Value' => '<string>',
                                    ],
                                    // ...
                                ],
                                'EvaluationPeriods' => <integer>,
                                'MetricName' => '<string>', // REQUIRED
                                'Namespace' => '<string>',
                                'Period' => <integer>, // REQUIRED
                                'Statistic' => 'SAMPLE_COUNT|AVERAGE|SUM|MINIMUM|MAXIMUM',
                                'Threshold' => <float>, // REQUIRED
                                'Unit' => 'NONE|SECONDS|MICRO_SECONDS|MILLI_SECONDS|BYTES|KILO_BYTES|MEGA_BYTES|GIGA_BYTES|TERA_BYTES|BITS|KILO_BITS|MEGA_BITS|GIGA_BITS|TERA_BITS|PERCENT|COUNT|BYTES_PER_SECOND|KILO_BYTES_PER_SECOND|MEGA_BYTES_PER_SECOND|GIGA_BYTES_PER_SECOND|TERA_BYTES_PER_SECOND|BITS_PER_SECOND|KILO_BITS_PER_SECOND|MEGA_BITS_PER_SECOND|GIGA_BITS_PER_SECOND|TERA_BITS_PER_SECOND|COUNT_PER_SECOND',
                            ],
                        ],
                    ],
                    // ...
                ],
            ],
            'BidPrice' => '<string>',
            'Configurations' => [
                [
                    'Classification' => '<string>',
                    'Configurations' => [...], // RECURSIVE
                    'Properties' => ['<string>', ...],
                ],
                // ...
            ],
            'EbsConfiguration' => [
                'EbsBlockDeviceConfigs' => [
                    [
                        'VolumeSpecification' => [ // REQUIRED
                            'Iops' => <integer>,
                            'SizeInGB' => <integer>, // REQUIRED
                            'VolumeType' => '<string>', // REQUIRED
                        ],
                        'VolumesPerInstance' => <integer>,
                    ],
                    // ...
                ],
                'EbsOptimized' => true || false,
            ],
            'InstanceCount' => <integer>, // REQUIRED
            'InstanceRole' => 'MASTER|CORE|TASK', // REQUIRED
            'InstanceType' => '<string>', // REQUIRED
            'Market' => 'ON_DEMAND|SPOT',
            'Name' => '<string>',
        ],
        // ...
    ],
    'JobFlowId' => '<string>', // REQUIRED
]);

Parameter Details

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

Parameter Syntax

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

Parameter Details

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

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

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

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

Parameter Syntax

$result = $client->createStudio([
    'AuthMode' => 'SSO|IAM', // REQUIRED
    'DefaultS3Location' => '<string>', // REQUIRED
    'Description' => '<string>',
    'EngineSecurityGroupId' => '<string>', // REQUIRED
    'Name' => '<string>', // REQUIRED
    'ServiceRole' => '<string>', // REQUIRED
    'SubnetIds' => ['<string>', ...], // REQUIRED
    'Tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
    'UserRole' => '<string>', // REQUIRED
    '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([/* ... */]);

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

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

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

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

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>',
        'EbsRootVolumeSize' => <integer>,
        'Ec2InstanceAttributes' => [
            'AdditionalMasterSecurityGroups' => ['<string>', ...],
            'AdditionalSlaveSecurityGroups' => ['<string>', ...],
            'Ec2AvailabilityZone' => '<string>',
            'Ec2KeyName' => '<string>',
            'Ec2SubnetId' => '<string>',
            'EmrManagedMasterSecurityGroup' => '<string>',
            'EmrManagedSlaveSecurityGroup' => '<string>',
            'IamInstanceProfile' => '<string>',
            'RequestedEc2AvailabilityZones' => ['<string>', ...],
            'RequestedEc2SubnetIds' => ['<string>', ...],
            'ServiceAccessSecurityGroup' => '<string>',
        ],
        'Id' => '<string>',
        'InstanceCollectionType' => 'INSTANCE_FLEET|INSTANCE_GROUP',
        'KerberosAttributes' => [
            'ADDomainJoinPassword' => '<string>',
            'ADDomainJoinUser' => '<string>',
            'CrossRealmTrustPrincipalPassword' => '<string>',
            'KdcAdminPassword' => '<string>',
            'Realm' => '<string>',
        ],
        'LogEncryptionKmsKeyId' => '<string>',
        'LogUri' => '<string>',
        'MasterPublicDnsName' => '<string>',
        'Name' => '<string>',
        'NormalizedInstanceHours' => <integer>,
        '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' => [
            '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,
        '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([/* ... */]);

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>,
                        'EndDateTime' => <DateTime>,
                        'InstanceGroupId' => '<string>',
                        'InstanceRequestCount' => <integer>,
                        'InstanceRole' => 'MASTER|CORE|TASK',
                        'InstanceRunningCount' => <integer>,
                        'InstanceType' => '<string>',
                        'LastStateChangeReason' => '<string>',
                        'Market' => 'ON_DEMAND|SPOT',
                        'Name' => '<string>',
                        'ReadyDateTime' => <DateTime>,
                        'StartDateTime' => <DateTime>,
                        'State' => 'PROVISIONING|BOOTSTRAPPING|RUNNING|RECONFIGURING|RESIZING|SUSPENDED|TERMINATING|TERMINATED|ARRESTED|SHUTTING_DOWN|ENDED',
                    ],
                    // ...
                ],
                'KeepJobFlowAliveWhenNoSteps' => true || false,
                'MasterInstanceId' => '<string>',
                'MasterInstanceType' => '<string>',
                'MasterPublicDnsName' => '<string>',
                'NormalizedInstanceHours' => <integer>,
                'Placement' => [
                    'AvailabilityZone' => '<string>',
                    'AvailabilityZones' => ['<string>', ...],
                ],
                'SlaveInstanceType' => '<string>',
                'TerminationProtected' => true || false,
            ],
            'JobFlowId' => '<string>',
            'JobFlowRole' => '<string>',
            '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([/* ... */]);

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'NotebookExecution' => [
        'Arn' => '<string>',
        'EditorId' => '<string>',
        'EndTime' => <DateTime>,
        'ExecutionEngine' => [
            'Id' => '<string>',
            'MasterInstanceSecurityGroupId' => '<string>',
            'Type' => 'EMR',
        ],
        'LastStateChangeReason' => '<string>',
        'NotebookExecutionId' => '<string>',
        'NotebookExecutionName' => '<string>',
        'NotebookInstanceSecurityGroupId' => '<string>',
        'NotebookParams' => '<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([/* ... */]);

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'Applications' => [
        [
            'Name' => '<string>',
            'Version' => '<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([/* ... */]);

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

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

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'Studio' => [
        'AuthMode' => 'SSO|IAM',
        'CreationTime' => <DateTime>,
        'DefaultS3Location' => '<string>',
        'Description' => '<string>',
        'EngineSecurityGroupId' => '<string>',
        'Name' => '<string>',
        'ServiceRole' => '<string>',
        'StudioArn' => '<string>',
        'StudioId' => '<string>',
        'SubnetIds' => ['<string>', ...],
        'Tags' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
        '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.

GetBlockPublicAccessConfiguration

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

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.

GetManagedScalingPolicy

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

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

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

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

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

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>', ...],
                        ],
                        // ...
                    ],
                    'EbsBlockDevices' => [
                        [
                            'Device' => '<string>',
                            'VolumeSpecification' => [
                                'Iops' => <integer>,
                                'SizeInGB' => <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',
                    'BlockDurationMinutes' => <integer>,
                    'TimeoutAction' => 'SWITCH_TO_ON_DEMAND|TERMINATE_CLUSTER',
                    'TimeoutDurationMinutes' => <integer>,
                ],
            ],
            'Name' => '<string>',
            'ProvisionedOnDemandCapacity' => <integer>,
            'ProvisionedSpotCapacity' => <integer>,
            'Status' => [
                'State' => 'PROVISIONING|BOOTSTRAPPING|RUNNING|RESIZING|SUSPENDED|TERMINATING|TERMINATED',
                'StateChangeReason' => [
                    'Code' => 'INTERNAL_ERROR|VALIDATION_ERROR|INSTANCE_FAILURE|CLUSTER_TERMINATED',
                    'Message' => '<string>',
                ],
                'Timeline' => [
                    'CreationDateTime' => <DateTime>,
                    'EndDateTime' => <DateTime>,
                    'ReadyDateTime' => <DateTime>,
                ],
            ],
            'TargetOnDemandCapacity' => <integer>,
            'TargetSpotCapacity' => <integer>,
        ],
        // ...
    ],
    'Marker' => '<string>',
]

Result Details

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

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>,
            'EbsBlockDevices' => [
                [
                    'Device' => '<string>',
                    'VolumeSpecification' => [
                        'Iops' => <integer>,
                        'SizeInGB' => <integer>,
                        'VolumeType' => '<string>',
                    ],
                ],
                // ...
            ],
            'EbsOptimized' => true || false,
            'Id' => '<string>',
            'InstanceGroupType' => 'MASTER|CORE|TASK',
            'InstanceType' => '<string>',
            'LastSuccessfullyAppliedConfigurations' => [
                [
                    'Classification' => '<string>',
                    'Configurations' => [...], // RECURSIVE
                    'Properties' => ['<string>', ...],
                ],
                // ...
            ],
            'LastSuccessfullyAppliedConfigurationsVersion' => <integer>,
            'Market' => 'ON_DEMAND|SPOT',
            'Name' => '<string>',
            'RequestedInstanceCount' => <integer>,
            'RunningInstanceCount' => <integer>,
            'ShrinkPolicy' => [
                'DecommissionTimeout' => <integer>,
                'InstanceResizePolicy' => [
                    'InstanceTerminationTimeout' => <integer>,
                    'InstancesToProtect' => ['<string>', ...],
                    'InstancesToTerminate' => ['<string>', ...],
                ],
            ],
            'Status' => [
                'State' => 'PROVISIONING|BOOTSTRAPPING|RUNNING|RECONFIGURING|RESIZING|SUSPENDED|TERMINATING|TERMINATED|ARRESTED|SHUTTING_DOWN|ENDED',
                'StateChangeReason' => [
                    'Code' => 'INTERNAL_ERROR|VALIDATION_ERROR|INSTANCE_FAILURE|CLUSTER_TERMINATED',
                    'Message' => '<string>',
                ],
                'Timeline' => [
                    'CreationDateTime' => <DateTime>,
                    'EndDateTime' => <DateTime>,
                    'ReadyDateTime' => <DateTime>,
                ],
            ],
        ],
        // ...
    ],
    'Marker' => '<string>',
]

Result Details

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

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

Parameter Syntax

$result = $client->listNotebookExecutions([
    'EditorId' => '<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>,
            'NotebookExecutionId' => '<string>',
            'NotebookExecutionName' => '<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([/* ... */]);

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

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

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

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

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'Marker' => '<string>',
    'Studios' => [
        [
            '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.

ModifyCluster

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

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

Parameter Syntax

$result = $client->modifyInstanceFleet([
    'ClusterId' => '<string>', // REQUIRED
    'InstanceFleet' => [ // REQUIRED
        'InstanceFleetId' => '<string>', // 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([/* ... */]);

Parameter Syntax

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

Parameter Details

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

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.

PutBlockPublicAccessConfiguration

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

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

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

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.

RemoveManagedScalingPolicy

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

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

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

Parameter Syntax

$result = $client->runJobFlow([
    'AdditionalInfo' => '<string>',
    'AmiVersion' => '<string>',
    'Applications' => [
        [
            'AdditionalInfo' => ['<string>', ...],
            'Args' => ['<string>', ...],
            'Name' => '<string>',
            'Version' => '<string>',
        ],
        // ...
    ],
    'AutoScalingRole' => '<string>',
    'BootstrapActions' => [
        [
            'Name' => '<string>', // REQUIRED
            'ScriptBootstrapAction' => [ // REQUIRED
                'Args' => ['<string>', ...],
                'Path' => '<string>', // REQUIRED
            ],
        ],
        // ...
    ],
    'Configurations' => [
        [
            'Classification' => '<string>',
            'Configurations' => [...], // RECURSIVE
            'Properties' => ['<string>', ...],
        ],
        // ...
    ],
    'CustomAmiId' => '<string>',
    'EbsRootVolumeSize' => <integer>,
    'Instances' => [ // REQUIRED
        'AdditionalMasterSecurityGroups' => ['<string>', ...],
        'AdditionalSlaveSecurityGroups' => ['<string>', ...],
        'Ec2KeyName' => '<string>',
        'Ec2SubnetId' => '<string>',
        'Ec2SubnetIds' => ['<string>', ...],
        'EmrManagedMasterSecurityGroup' => '<string>',
        'EmrManagedSlaveSecurityGroup' => '<string>',
        'HadoopVersion' => '<string>',
        'InstanceCount' => <integer>,
        'InstanceFleets' => [
            [
                'InstanceFleetType' => 'MASTER|CORE|TASK', // REQUIRED
                'InstanceTypeConfigs' => [
                    [
                        'BidPrice' => '<string>',
                        'BidPriceAsPercentageOfOnDemandPrice' => <float>,
                        'Configurations' => [
                            [
                                'Classification' => '<string>',
                                'Configurations' => [...], // RECURSIVE
                                'Properties' => ['<string>', ...],
                            ],
                            // ...
                        ],
                        'EbsConfiguration' => [
                            'EbsBlockDeviceConfigs' => [
                                [
                                    'VolumeSpecification' => [ // REQUIRED
                                        'Iops' => <integer>,
                                        'SizeInGB' => <integer>, // REQUIRED
                                        'VolumeType' => '<string>', // REQUIRED
                                    ],
                                    'VolumesPerInstance' => <integer>,
                                ],
                                // ...
                            ],
                            'EbsOptimized' => true || false,
                        ],
                        'InstanceType' => '<string>', // REQUIRED
                        'WeightedCapacity' => <integer>,
                    ],
                    // ...
                ],
                'LaunchSpecifications' => [
                    'OnDemandSpecification' => [
                        'AllocationStrategy' => 'lowest-price', // REQUIRED
                        'CapacityReservationOptions' => [
                            'CapacityReservationPreference' => 'open|none',
                            'CapacityReservationResourceGroupArn' => '<string>',
                            'UsageStrategy' => 'use-capacity-reservations-first',
                        ],
                    ],
                    'SpotSpecification' => [
                        'AllocationStrategy' => 'capacity-optimized',
                        'BlockDurationMinutes' => <integer>,
                        'TimeoutAction' => 'SWITCH_TO_ON_DEMAND|TERMINATE_CLUSTER', // REQUIRED
                        'TimeoutDurationMinutes' => <integer>, // REQUIRED
                    ],
                ],
                'Name' => '<string>',
                'TargetOnDemandCapacity' => <integer>,
                'TargetSpotCapacity' => <integer>,
            ],
            // ...
        ],
        'InstanceGroups' => [
            [
                'AutoScalingPolicy' => [
                    'Constraints' => [ // REQUIRED
                        'MaxCapacity' => <integer>, // REQUIRED
                        'MinCapacity' => <integer>, // REQUIRED
                    ],
                    'Rules' => [ // REQUIRED
                        [
                            'Action' => [ // REQUIRED
                                'Market' => 'ON_DEMAND|SPOT',
                                'SimpleScalingPolicyConfiguration' => [ // REQUIRED
                                    'AdjustmentType' => 'CHANGE_IN_CAPACITY|PERCENT_CHANGE_IN_CAPACITY|EXACT_CAPACITY',
                                    'CoolDown' => <integer>,
                                    'ScalingAdjustment' => <integer>, // REQUIRED
                                ],
                            ],
                            'Description' => '<string>',
                            'Name' => '<string>', // REQUIRED
                            'Trigger' => [ // REQUIRED
                                'CloudWatchAlarmDefinition' => [ // REQUIRED
                                    'ComparisonOperator' => 'GREATER_THAN_OR_EQUAL|GREATER_THAN|LESS_THAN|LESS_THAN_OR_EQUAL', // REQUIRED
                                    'Dimensions' => [
                                        [
                                            'Key' => '<string>',
                                            'Value' => '<string>',
                                        ],
                                        // ...
                                    ],
                                    'EvaluationPeriods' => <integer>,
                                    'MetricName' => '<string>', // REQUIRED
                                    'Namespace' => '<string>',
                                    'Period' => <integer>, // REQUIRED
                                    'Statistic' => 'SAMPLE_COUNT|AVERAGE|SUM|MINIMUM|MAXIMUM',
                                    'Threshold' => <float>, // REQUIRED
                                    'Unit' => 'NONE|SECONDS|MICRO_SECONDS|MILLI_SECONDS|BYTES|KILO_BYTES|MEGA_BYTES|GIGA_BYTES|TERA_BYTES|BITS|KILO_BITS|MEGA_BITS|GIGA_BITS|TERA_BITS|PERCENT|COUNT|BYTES_PER_SECOND|KILO_BYTES_PER_SECOND|MEGA_BYTES_PER_SECOND|GIGA_BYTES_PER_SECOND|TERA_BYTES_PER_SECOND|BITS_PER_SECOND|KILO_BITS_PER_SECOND|MEGA_BITS_PER_SECOND|GIGA_BITS_PER_SECOND|TERA_BITS_PER_SECOND|COUNT_PER_SECOND',
                                ],
                            ],
                        ],
                        // ...
                    ],
                ],
                'BidPrice' => '<string>',
                'Configurations' => [
                    [
                        'Classification' => '<string>',
                        'Configurations' => [...], // RECURSIVE
                        'Properties' => ['<string>', ...],
                    ],
                    // ...
                ],
                'EbsConfiguration' => [
                    'EbsBlockDeviceConfigs' => [
                        [
                            'VolumeSpecification' => [ // REQUIRED
                                'Iops' => <integer>,
                                'SizeInGB' => <integer>, // REQUIRED
                                'VolumeType' => '<string>', // REQUIRED
                            ],
                            'VolumesPerInstance' => <integer>,
                        ],
                        // ...
                    ],
                    'EbsOptimized' => true || false,
                ],
                'InstanceCount' => <integer>, // REQUIRED
                'InstanceRole' => 'MASTER|CORE|TASK', // REQUIRED
                'InstanceType' => '<string>', // REQUIRED
                'Market' => 'ON_DEMAND|SPOT',
                'Name' => '<string>',
            ],
            // ...
        ],
        'KeepJobFlowAliveWhenNoSteps' => true || false,
        'MasterInstanceType' => '<string>',
        'Placement' => [
            'AvailabilityZone' => '<string>',
            'AvailabilityZones' => ['<string>', ...],
        ],
        'ServiceAccessSecurityGroup' => '<string>',
        'SlaveInstanceType' => '<string>',
        'TerminationProtected' => true || false,
    ],
    'JobFlowRole' => '<string>',
    'KerberosAttributes' => [
        'ADDomainJoinPassword' => '<string>',
        'ADDomainJoinUser' => '<string>',
        'CrossRealmTrustPrincipalPassword' => '<string>',
        'KdcAdminPassword' => '<string>', // REQUIRED
        'Realm' => '<string>', // REQUIRED
    ],
    '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>',
        ],
        // ...
    ],
    '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.

SetTerminationProtection

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

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.

SetVisibleToAllUsers

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

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

Parameter Syntax

$result = $client->startNotebookExecution([
    'EditorId' => '<string>', // REQUIRED
    'ExecutionEngine' => [ // REQUIRED
        'Id' => '<string>', // REQUIRED
        'MasterInstanceSecurityGroupId' => '<string>',
        'Type' => 'EMR',
    ],
    'NotebookExecutionName' => '<string>',
    'NotebookInstanceSecurityGroupId' => '<string>',
    'NotebookParams' => '<string>',
    'RelativePath' => '<string>', // REQUIRED
    '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([/* ... */]);

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

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

Parameter Syntax

$result = $client->updateStudio([
    'DefaultS3Location' => '<string>',
    'Description' => '<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([/* ... */]);

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.