Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
Paws::EMR(3)	      User Contributed Perl Documentation	  Paws::EMR(3)

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

SYNOPSIS
	 use Paws;

	 my $obj = Paws->service('EMR')->new;
	 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 Elastic MapReduce	(Amazon	EMR) is	a web service that makes it
       easy to process large amounts of	data efficiently. Amazon EMR uses
       Hadoop processing combined with several AWS products to do tasks	such
       as web indexing,	data mining, log file analysis,	machine	learning,
       scientific simulation, and data warehousing.

METHODS
   AddInstanceGroups(InstanceGroups =>
       ArrayRef[Paws::EMR::InstanceGroupConfig], JobFlowId => Str)
       Each argument is	described in detail in:	Paws::EMR::AddInstanceGroups

       Returns:	a Paws::EMR::AddInstanceGroupsOutput instance

       AddInstanceGroups adds an instance group	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 job flow. A maximum of 256
       steps are allowed in each job flow.

       If your job flow	is long-running	(such as a Hive	data warehouse)	or
       complex,	you may	require	more than 256 steps to process your data. You
       can bypass the 256-step limitation in various ways, including using the
       SSH shell to connect to the master node and submitting queries directly
       to the software running on the master node, such	as Hive	and Hadoop.
       For more	information on how to do this, go to Add More than 256 Steps
       to a Job	Flow in	the Amazon Elastic MapReduce Developer's Guide.

       A step specifies	the location of	a JAR file stored either on the	master
       node of the job flow 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.

       Elastic MapReduce 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 job flow 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 Tagging
       Amazon EMR Resources.

   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. For information about the
       cluster steps, see ListSteps.

   DescribeJobFlows([CreatedAfter => Str, CreatedBefore	=> Str,	JobFlowIds =>
       ArrayRef[Str], JobFlowStates => ArrayRef[Str]])
       Each argument is	described in detail in:	Paws::EMR::DescribeJobFlows

       Returns:	a Paws::EMR::DescribeJobFlowsOutput instance

       This API	is deprecated and will eventually be removed. We recommend you
       use ListClusters, DescribeCluster, ListSteps, ListInstanceGroups	and
       ListBootstrapActions instead.

       DescribeJobFlows	returns	a list of job flows that match all of the
       supplied	parameters. The	parameters can include a list of job flow IDs,
       job flow	states,	and restrictions on job	flow creation date and time.

       Regardless of supplied parameters, only job flows created within	the
       last two	months are returned.

       If no parameters	are supplied, then job flows matching either of	the
       following criteria are returned:

       o   Job flows created and completed in the last two weeks

       o   Job flows created within the	last two months	that are in one	of the
	   following states: "RUNNING",	"WAITING", "SHUTTING_DOWN", "STARTING"

       Amazon Elastic MapReduce	can return a maximum of	512 job	flow
       descriptions.

   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.

   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], 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.

   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, [InstanceGroupId => Str, InstanceGroupTypes
       => ArrayRef[Str], Marker	=> Str])
       Each argument is	described in detail in:	Paws::EMR::ListInstances

       Returns:	a Paws::EMR::ListInstancesOutput instance

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

   ListSteps(ClusterId => Str, [Marker => Str, StepIds => ArrayRef[Str],
       StepStates => ArrayRef[Str]])
       Each argument is	described in detail in:	Paws::EMR::ListSteps

       Returns:	a Paws::EMR::ListStepsOutput instance

       Provides	a list of steps	for the	cluster.

   ModifyInstanceGroups([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.

   RemoveTags(ResourceId => Str, TagKeys => ArrayRef[Str])
       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
       Tagging Amazon EMR Resources.

       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], BootstrapActions =>
       ArrayRef[Paws::EMR::BootstrapActionConfig], Configurations =>
       ArrayRef[Paws::EMR::Configuration], JobFlowRole => Str, LogUri => Str,
       NewSupportedProducts => ArrayRef[Paws::EMR::SupportedProductConfig],
       ReleaseLabel => Str, ServiceRole	=> Str,	Steps =>
       ArrayRef[Paws::EMR::StepConfig],	SupportedProducts => ArrayRef[Str],
       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 job flow. The job flow will
       run the steps specified.	Once the job flow completes, the cluster is
       stopped and the HDFS partition is lost. To prevent loss of data,
       configure the last step of the job flow to store	results	in Amazon S3.
       If the JobFlowInstancesConfig "KeepJobFlowAliveWhenNoSteps" parameter
       is set to "TRUE", the job flow will transition to the WAITING state
       rather than shutting down once the steps	have completed.

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

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

       If your job flow	is long-running	(such as a Hive	data warehouse)	or
       complex,	you may	require	more than 256 steps to process your data. You
       can bypass the 256-step limitation in various ways, including using the
       SSH shell to connect to the master node and submitting queries directly
       to the software running on the master node, such	as Hive	and Hadoop.
       For more	information on how to do this, go to Add More than 256 Steps
       to a Job	Flow in	the Amazon Elastic MapReduce Developer's Guide.

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

   SetTerminationProtection(JobFlowIds => ArrayRef[Str], TerminationProtected
       => Bool)
       Each argument is	described in detail in:
       Paws::EMR::SetTerminationProtection

       Returns:	nothing

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

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

       To terminate a job flow 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, go	to Protecting a	Job Flow from Termination in
       the Amazon Elastic MapReduce Developer's	Guide.

   SetVisibleToAllUsers(JobFlowIds => ArrayRef[Str], VisibleToAllUsers =>
       Bool)
       Each argument is	described in detail in:
       Paws::EMR::SetVisibleToAllUsers

       Returns:	nothing

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

   TerminateJobFlows(JobFlowIds	=> ArrayRef[Str])
       Each argument is	described in detail in:	Paws::EMR::TerminateJobFlows

       Returns:	nothing

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

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

SEE ALSO
       This service class forms	part of	Paws

BUGS and CONTRIBUTIONS
       The source code is located here:	https://github.com/pplu/aws-sdk-perl

       Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues

perl v5.24.1			  2015-08-06			  Paws::EMR(3)

NAME | SYNOPSIS | DESCRIPTION | METHODS | SEE ALSO | BUGS and CONTRIBUTIONS

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=Paws::EMR&sektion=3&manpath=FreeBSD+12.0-RELEASE+and+Ports>

home | help