NAME

Paws::EMR - Perl Interface to AWS Amazon Elastic MapReduce

SYNOPSIS

use Paws;

my $obj = Paws->service('EMR');
my $res = $obj->Method(
  Arg1 => $val1,
  Arg2 => [ 'V1', 'V2' ],
  # if Arg3 is an object, the HashRef will be used as arguments to the constructor
  # of the arguments type
  Arg3 => { Att1 => 'Val1' },
  # if Arg4 is an array of objects, the HashRefs will be passed as arguments to
  # the constructor of the arguments type
  Arg4 => [ { Att1 => 'Val1'  }, { Att1 => 'Val2' } ],
);

DESCRIPTION

Amazon EMR is a web service that makes it easier to process large amounts of data efficiently. Amazon EMR uses Hadoop processing combined with several AWS services to do tasks such as web indexing, data mining, log file analysis, machine learning, scientific simulation, and data warehouse management.

For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/elasticmapreduce-2009-03-31

METHODS

AddInstanceFleet

ClusterId => Str
InstanceFleet => Paws::EMR::InstanceFleetConfig

Each argument is described in detail in: Paws::EMR::AddInstanceFleet

Returns: a Paws::EMR::AddInstanceFleetOutput instance

Adds an instance fleet to a running cluster.

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

AddInstanceGroups

InstanceGroups => ArrayRef[Paws::EMR::InstanceGroupConfig]
JobFlowId => Str

Each argument is described in detail in: Paws::EMR::AddInstanceGroups

Returns: a Paws::EMR::AddInstanceGroupsOutput instance

Adds one or more instance groups to a running cluster.

AddJobFlowSteps

JobFlowId => Str
Steps => ArrayRef[Paws::EMR::StepConfig]

Each argument is described in detail in: Paws::EMR::AddJobFlowSteps

Returns: a Paws::EMR::AddJobFlowStepsOutput instance

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

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

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

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

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

AddTags

ResourceId => Str
Tags => ArrayRef[Paws::EMR::Tag]

Each argument is described in detail in: Paws::EMR::AddTags

Returns: a Paws::EMR::AddTagsOutput instance

Adds tags to an Amazon EMR resource. Tags make it easier to associate clusters in various ways, such as grouping clusters to track your Amazon EMR resource allocation costs. For more information, see Tag Clusters (https://docs.aws.amazon.com/emr/latest/ManagementGuide/emr-plan-tags.html).

CancelSteps

ClusterId => Str
StepIds => ArrayRef[Str|Undef]
[StepCancellationOption => Str]

Each argument is described in detail in: Paws::EMR::CancelSteps

Returns: a Paws::EMR::CancelStepsOutput instance

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. You can only cancel steps that are in a PENDING state.

CreateSecurityConfiguration

Name => Str
SecurityConfiguration => Str

Each argument is described in detail in: Paws::EMR::CreateSecurityConfiguration

Returns: a Paws::EMR::CreateSecurityConfigurationOutput instance

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

CreateStudio

AuthMode => Str
DefaultS3Location => Str
EngineSecurityGroupId => Str
Name => Str
ServiceRole => Str
SubnetIds => ArrayRef[Str|Undef]
UserRole => Str
VpcId => Str
WorkspaceSecurityGroupId => Str
[Description => Str]
[Tags => ArrayRef[Paws::EMR::Tag]]

Each argument is described in detail in: Paws::EMR::CreateStudio

Returns: a Paws::EMR::CreateStudioOutput instance

Creates a new Amazon EMR Studio.

CreateStudioSessionMapping

IdentityType => Str
SessionPolicyArn => Str
StudioId => Str
[IdentityId => Str]
[IdentityName => Str]

Each argument is described in detail in: Paws::EMR::CreateStudioSessionMapping

Returns: nothing

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.

DeleteSecurityConfiguration

Name => Str

Each argument is described in detail in: Paws::EMR::DeleteSecurityConfiguration

Returns: a Paws::EMR::DeleteSecurityConfigurationOutput instance

Deletes a security configuration.

DeleteStudio

StudioId => Str

Each argument is described in detail in: Paws::EMR::DeleteStudio

Returns: nothing

Removes an Amazon EMR Studio from the Studio metadata store.

DeleteStudioSessionMapping

IdentityType => Str
StudioId => Str
[IdentityId => Str]
[IdentityName => Str]

Each argument is described in detail in: Paws::EMR::DeleteStudioSessionMapping

Returns: nothing

Removes a user or group from an Amazon EMR Studio.

DescribeCluster

ClusterId => Str

Each argument is described in detail in: Paws::EMR::DescribeCluster

Returns: a Paws::EMR::DescribeClusterOutput instance

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

DescribeJobFlows

[CreatedAfter => Str]
[CreatedBefore => Str]
[JobFlowIds => ArrayRef[Str|Undef]]
[JobFlowStates => ArrayRef[Str|Undef]]

Each argument is described in detail in: Paws::EMR::DescribeJobFlows

Returns: a Paws::EMR::DescribeJobFlowsOutput instance

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.

DescribeNotebookExecution

NotebookExecutionId => Str

Each argument is described in detail in: Paws::EMR::DescribeNotebookExecution

Returns: a Paws::EMR::DescribeNotebookExecutionOutput instance

Provides details of a notebook execution.

DescribeSecurityConfiguration

Name => Str

Each argument is described in detail in: Paws::EMR::DescribeSecurityConfiguration

Returns: a Paws::EMR::DescribeSecurityConfigurationOutput instance

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

DescribeStep

ClusterId => Str
StepId => Str

Each argument is described in detail in: Paws::EMR::DescribeStep

Returns: a Paws::EMR::DescribeStepOutput instance

Provides more detail about the cluster step.

DescribeStudio

StudioId => Str

Each argument is described in detail in: Paws::EMR::DescribeStudio

Returns: a Paws::EMR::DescribeStudioOutput instance

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

GetBlockPublicAccessConfiguration

Each argument is described in detail in: Paws::EMR::GetBlockPublicAccessConfiguration

Returns: a Paws::EMR::GetBlockPublicAccessConfigurationOutput instance

Returns the Amazon EMR block public access configuration for your AWS account in the current Region. For more information see Configure Block Public Access for Amazon EMR (https://docs.aws.amazon.com/emr/latest/ManagementGuide/configure-block-public-access.html) in the Amazon EMR Management Guide.

GetManagedScalingPolicy

ClusterId => Str

Each argument is described in detail in: Paws::EMR::GetManagedScalingPolicy

Returns: a Paws::EMR::GetManagedScalingPolicyOutput instance

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

GetStudioSessionMapping

IdentityType => Str
StudioId => Str
[IdentityId => Str]
[IdentityName => Str]

Each argument is described in detail in: Paws::EMR::GetStudioSessionMapping

Returns: a Paws::EMR::GetStudioSessionMappingOutput instance

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

ListBootstrapActions

ClusterId => Str
[Marker => Str]

Each argument is described in detail in: Paws::EMR::ListBootstrapActions

Returns: a Paws::EMR::ListBootstrapActionsOutput instance

Provides information about the bootstrap actions associated with a cluster.

ListClusters

[ClusterStates => ArrayRef[Str|Undef]]
[CreatedAfter => Str]
[CreatedBefore => Str]
[Marker => Str]

Each argument is described in detail in: Paws::EMR::ListClusters

Returns: a Paws::EMR::ListClustersOutput instance

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

ListInstanceFleets

ClusterId => Str
[Marker => Str]

Each argument is described in detail in: Paws::EMR::ListInstanceFleets

Returns: a Paws::EMR::ListInstanceFleetsOutput instance

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

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

ListInstanceGroups

ClusterId => Str
[Marker => Str]

Each argument is described in detail in: Paws::EMR::ListInstanceGroups

Returns: a Paws::EMR::ListInstanceGroupsOutput instance

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

ListInstances

ClusterId => Str
[InstanceFleetId => Str]
[InstanceFleetType => Str]
[InstanceGroupId => Str]
[InstanceGroupTypes => ArrayRef[Str|Undef]]
[InstanceStates => ArrayRef[Str|Undef]]
[Marker => Str]

Each argument is described in detail in: Paws::EMR::ListInstances

Returns: a Paws::EMR::ListInstancesOutput instance

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

ListNotebookExecutions

[EditorId => Str]
[From => Str]
[Marker => Str]
[Status => Str]
[To => Str]

Each argument is described in detail in: Paws::EMR::ListNotebookExecutions

Returns: a Paws::EMR::ListNotebookExecutionsOutput instance

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

ListSecurityConfigurations

[Marker => Str]

Each argument is described in detail in: Paws::EMR::ListSecurityConfigurations

Returns: a Paws::EMR::ListSecurityConfigurationsOutput instance

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.

ListSteps

ClusterId => Str
[Marker => Str]
[StepIds => ArrayRef[Str|Undef]]
[StepStates => ArrayRef[Str|Undef]]

Each argument is described in detail in: Paws::EMR::ListSteps

Returns: a Paws::EMR::ListStepsOutput instance

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

ListStudios

[Marker => Str]

Each argument is described in detail in: Paws::EMR::ListStudios

Returns: a Paws::EMR::ListStudiosOutput instance

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

ListStudioSessionMappings

[IdentityType => Str]
[Marker => Str]
[StudioId => Str]

Each argument is described in detail in: Paws::EMR::ListStudioSessionMappings

Returns: a Paws::EMR::ListStudioSessionMappingsOutput instance

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

ModifyCluster

ClusterId => Str
[StepConcurrencyLevel => Int]

Each argument is described in detail in: Paws::EMR::ModifyCluster

Returns: a Paws::EMR::ModifyClusterOutput instance

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

ModifyInstanceFleet

ClusterId => Str
InstanceFleet => Paws::EMR::InstanceFleetModifyConfig

Each argument is described in detail in: Paws::EMR::ModifyInstanceFleet

Returns: nothing

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

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

ModifyInstanceGroups

[ClusterId => Str]
[InstanceGroups => ArrayRef[Paws::EMR::InstanceGroupModifyConfig]]

Each argument is described in detail in: Paws::EMR::ModifyInstanceGroups

Returns: nothing

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.

PutAutoScalingPolicy

AutoScalingPolicy => Paws::EMR::AutoScalingPolicy
ClusterId => Str
InstanceGroupId => Str

Each argument is described in detail in: Paws::EMR::PutAutoScalingPolicy

Returns: a Paws::EMR::PutAutoScalingPolicyOutput instance

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

PutBlockPublicAccessConfiguration

BlockPublicAccessConfiguration => Paws::EMR::BlockPublicAccessConfiguration

Each argument is described in detail in: Paws::EMR::PutBlockPublicAccessConfiguration

Returns: a Paws::EMR::PutBlockPublicAccessConfigurationOutput instance

Creates or updates an Amazon EMR block public access configuration for your AWS account in the current Region. For more information see Configure Block Public Access for Amazon EMR (https://docs.aws.amazon.com/emr/latest/ManagementGuide/configure-block-public-access.html) in the Amazon EMR Management Guide.

PutManagedScalingPolicy

ClusterId => Str
ManagedScalingPolicy => Paws::EMR::ManagedScalingPolicy

Each argument is described in detail in: Paws::EMR::PutManagedScalingPolicy

Returns: a Paws::EMR::PutManagedScalingPolicyOutput instance

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

RemoveAutoScalingPolicy

ClusterId => Str
InstanceGroupId => Str

Each argument is described in detail in: Paws::EMR::RemoveAutoScalingPolicy

Returns: a Paws::EMR::RemoveAutoScalingPolicyOutput instance

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

RemoveManagedScalingPolicy

ClusterId => Str

Each argument is described in detail in: Paws::EMR::RemoveManagedScalingPolicy

Returns: a Paws::EMR::RemoveManagedScalingPolicyOutput instance

Removes a managed scaling policy from a specified EMR cluster.

RemoveTags

ResourceId => Str
TagKeys => ArrayRef[Str|Undef]

Each argument is described in detail in: Paws::EMR::RemoveTags

Returns: a Paws::EMR::RemoveTagsOutput instance

Removes tags from an Amazon EMR resource. Tags make it easier to associate clusters in various ways, such as grouping clusters to track your Amazon EMR resource allocation costs. For more information, see Tag Clusters (https://docs.aws.amazon.com/emr/latest/ManagementGuide/emr-plan-tags.html).

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

RunJobFlow

Instances => Paws::EMR::JobFlowInstancesConfig
Name => Str
[AdditionalInfo => Str]
[AmiVersion => Str]
[Applications => ArrayRef[Paws::EMR::Application]]
[AutoScalingRole => Str]
[BootstrapActions => ArrayRef[Paws::EMR::BootstrapActionConfig]]
[Configurations => ArrayRef[Paws::EMR::Configuration]]
[CustomAmiId => Str]
[EbsRootVolumeSize => Int]
[JobFlowRole => Str]
[KerberosAttributes => Paws::EMR::KerberosAttributes]
[LogEncryptionKmsKeyId => Str]
[LogUri => Str]
[ManagedScalingPolicy => Paws::EMR::ManagedScalingPolicy]
[NewSupportedProducts => ArrayRef[Paws::EMR::SupportedProductConfig]]
[PlacementGroupConfigs => ArrayRef[Paws::EMR::PlacementGroupConfig]]
[ReleaseLabel => Str]
[RepoUpgradeOnBoot => Str]
[ScaleDownBehavior => Str]
[SecurityConfiguration => Str]
[ServiceRole => Str]
[StepConcurrencyLevel => Int]
[Steps => ArrayRef[Paws::EMR::StepConfig]]
[SupportedProducts => ArrayRef[Str|Undef]]
[Tags => ArrayRef[Paws::EMR::Tag]]
[VisibleToAllUsers => Bool]

Each argument is described in detail in: Paws::EMR::RunJobFlow

Returns: a Paws::EMR::RunJobFlowOutput instance

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

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

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

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

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

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

SetTerminationProtection

JobFlowIds => ArrayRef[Str|Undef]
TerminationProtected => Bool

Each argument is described in detail in: Paws::EMR::SetTerminationProtection

Returns: nothing

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

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

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

For more information, seeManaging Cluster Termination (https://docs.aws.amazon.com/emr/latest/ManagementGuide/UsingEMR_TerminationProtection.html) in the Amazon EMR Management Guide.

SetVisibleToAllUsers

JobFlowIds => ArrayRef[Str|Undef]
VisibleToAllUsers => Bool

Each argument is described in detail in: Paws::EMR::SetVisibleToAllUsers

Returns: nothing

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

StartNotebookExecution

EditorId => Str
ExecutionEngine => Paws::EMR::ExecutionEngineConfig
RelativePath => Str
ServiceRole => Str
[NotebookExecutionName => Str]
[NotebookInstanceSecurityGroupId => Str]
[NotebookParams => Str]
[Tags => ArrayRef[Paws::EMR::Tag]]

Each argument is described in detail in: Paws::EMR::StartNotebookExecution

Returns: a Paws::EMR::StartNotebookExecutionOutput instance

Starts a notebook execution.

StopNotebookExecution

NotebookExecutionId => Str

Each argument is described in detail in: Paws::EMR::StopNotebookExecution

Returns: nothing

Stops a notebook execution.

TerminateJobFlows

JobFlowIds => ArrayRef[Str|Undef]

Each argument is described in detail in: Paws::EMR::TerminateJobFlows

Returns: nothing

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

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

UpdateStudio

StudioId => Str
[DefaultS3Location => Str]
[Description => Str]
[Name => Str]
[SubnetIds => ArrayRef[Str|Undef]]

Each argument is described in detail in: Paws::EMR::UpdateStudio

Returns: nothing

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

UpdateStudioSessionMapping

IdentityType => Str
SessionPolicyArn => Str
StudioId => Str
[IdentityId => Str]
[IdentityName => Str]

Each argument is described in detail in: Paws::EMR::UpdateStudioSessionMapping

Returns: nothing

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

PAGINATORS

Paginator methods are helpers that repetively call methods that return partial results