EmrClient Class

Member Function Documentation

EmrClient::EmrClient(const QtAws::Core::AwsRegion::Region region = QtAws::Core::AwsRegion::InvalidRegion, QtAws::Core::AwsAbstractCredentials *credentials = NULL, QNetworkAccessManager * const manager = NULL, QObject * const parent = 0)

Constructs a EmrClient object.

The new client object will region, credentials, and manager for network operations.

The new object will be owned by parent, if set.

EmrClient::EmrClient(const QUrl &endpoint, QtAws::Core::AwsAbstractCredentials *credentials = NULL, QNetworkAccessManager * const manager = NULL, QObject * const parent = 0)

This function overloads EmrClient().

This overload allows the caller to specify the specific endpoint to send requests to. Typically, it is easier to use the alternative constructor, which allows the caller to specify an AWS region instead, in which case this client will determine the correct endpoint for the given region automatically (via AwsEndpoint::getEndpoint).

See also QtAws::Core::AwsEndpoint::getEndpoint.

[slot] AddInstanceFleetResponse *EmrClient::addInstanceFleet(const AddInstanceFleetRequest &request)

Sends request to the EmrClient service, and returns a pointer to an AddInstanceFleetResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Adds an instance fleet to a running

cluster> <note>

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

[slot] AddInstanceGroupsResponse *EmrClient::addInstanceGroups(const AddInstanceGroupsRequest &request)

Sends request to the EmrClient service, and returns a pointer to an AddInstanceGroupsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Adds one or more instance groups to a running

[slot] AddJobFlowStepsResponse *EmrClient::addJobFlowSteps(const AddJobFlowStepsRequest &request)

Sends request to the EmrClient service, and returns a pointer to an AddJobFlowStepsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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 <a href="http://docs.aws.amazon.com/emr/latest/ManagementGuide/AddMoreThan256Steps.html">Add More than 256 Steps to a Cluster</a> in the <i>Amazon EMR Management

Guide</i>>

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

[slot] AddTagsResponse *EmrClient::addTags(const AddTagsRequest &request)

Sends request to the EmrClient service, and returns a pointer to an AddTagsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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 <a href="http://docs.aws.amazon.com/emr/latest/ManagementGuide/emr-plan-tags.html">Tag Clusters</a>.

[slot] CancelStepsResponse *EmrClient::cancelSteps(const CancelStepsRequest &request)

Sends request to the EmrClient service, and returns a pointer to an CancelStepsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Cancels a pending step or steps in a running cluster. Available only in Amazon EMR versions 4.8.0 and later, excluding version 5.0.0. A maximum of 256 steps are allowed in each CancelSteps request. CancelSteps is idempotent but asynchronous; it does not guarantee a step will be canceled, even if the request is successfully submitted. You can only cancel steps that are in a <code>PENDING</code>

[slot] CreateSecurityConfigurationResponse *EmrClient::createSecurityConfiguration(const CreateSecurityConfigurationRequest &request)

Sends request to the EmrClient service, and returns a pointer to an CreateSecurityConfigurationResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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

[slot] DeleteSecurityConfigurationResponse *EmrClient::deleteSecurityConfiguration(const DeleteSecurityConfigurationRequest &request)

Sends request to the EmrClient service, and returns a pointer to an DeleteSecurityConfigurationResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Deletes a security

[slot] DescribeClusterResponse *EmrClient::describeCluster(const DescribeClusterRequest &request)

Sends request to the EmrClient service, and returns a pointer to an DescribeClusterResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Provides cluster-level details including status, hardware and software configuration, VPC settings, and so on. For information about the cluster steps, see

[slot] DescribeJobFlowsResponse *EmrClient::describeJobFlows(const DescribeJobFlowsRequest &request)

Sends request to the EmrClient service, and returns a pointer to an DescribeJobFlowsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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

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> <ul> <li>

Job flows created and completed in the last two

week> </li> <li>

Job flows created within the last two months that are in one of the following states: <code>RUNNING</code>, <code>WAITING</code>, <code>SHUTTING_DOWN</code>, <code>STARTING</code>

</p </li> </ul>

Amazon EMR can return a maximum of 512 job flow

[slot] DescribeSecurityConfigurationResponse *EmrClient::describeSecurityConfiguration(const DescribeSecurityConfigurationRequest &request)

Sends request to the EmrClient service, and returns a pointer to an DescribeSecurityConfigurationResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Provides the details of a security configuration by returning the configuration

[slot] DescribeStepResponse *EmrClient::describeStep(const DescribeStepRequest &request)

Sends request to the EmrClient service, and returns a pointer to an DescribeStepResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Provides more detail about the cluster

[slot] ListBootstrapActionsResponse *EmrClient::listBootstrapActions(const ListBootstrapActionsRequest &request)

Sends request to the EmrClient service, and returns a pointer to an ListBootstrapActionsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Provides information about the bootstrap actions associated with a

[slot] ListClustersResponse *EmrClient::listClusters(const ListClustersRequest &request)

Sends request to the EmrClient service, and returns a pointer to an ListClustersResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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

[slot] ListInstanceFleetsResponse *EmrClient::listInstanceFleets(const ListInstanceFleetsRequest &request)

Sends request to the EmrClient service, and returns a pointer to an ListInstanceFleetsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Lists all available details about the instance fleets in a

cluster> <note>

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

[slot] ListInstanceGroupsResponse *EmrClient::listInstanceGroups(const ListInstanceGroupsRequest &request)

Sends request to the EmrClient service, and returns a pointer to an ListInstanceGroupsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Provides all available details about the instance groups in a

[slot] ListInstancesResponse *EmrClient::listInstances(const ListInstancesRequest &request)

Sends request to the EmrClient service, and returns a pointer to an ListInstancesResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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,

[slot] ListSecurityConfigurationsResponse *EmrClient::listSecurityConfigurations(const ListSecurityConfigurationsRequest &request)

Sends request to the EmrClient service, and returns a pointer to an ListSecurityConfigurationsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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

[slot] ListStepsResponse *EmrClient::listSteps(const ListStepsRequest &request)

Sends request to the EmrClient service, and returns a pointer to an ListStepsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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

[slot] ModifyInstanceFleetResponse *EmrClient::modifyInstanceFleet(const ModifyInstanceFleetRequest &request)

Sends request to the EmrClient service, and returns a pointer to an ModifyInstanceFleetResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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

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

[slot] ModifyInstanceGroupsResponse *EmrClient::modifyInstanceGroups(const ModifyInstanceGroupsRequest &request)

Sends request to the EmrClient service, and returns a pointer to an ModifyInstanceGroupsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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

[slot] PutAutoScalingPolicyResponse *EmrClient::putAutoScalingPolicy(const PutAutoScalingPolicyRequest &request)

Sends request to the EmrClient service, and returns a pointer to an PutAutoScalingPolicyResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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

[slot] RemoveAutoScalingPolicyResponse *EmrClient::removeAutoScalingPolicy(const RemoveAutoScalingPolicyRequest &request)

Sends request to the EmrClient service, and returns a pointer to an RemoveAutoScalingPolicyResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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

[slot] RemoveTagsResponse *EmrClient::removeTags(const RemoveTagsRequest &request)

Sends request to the EmrClient service, and returns a pointer to an RemoveTagsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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 <a href="http://docs.aws.amazon.com/emr/latest/ManagementGuide/emr-plan-tags.html">Tag Clusters</a>.

</p

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

[slot] RunJobFlowResponse *EmrClient::runJobFlow(const RunJobFlowRequest &request)

Sends request to the EmrClient service, and returns a pointer to an RunJobFlowResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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 <a>JobFlowInstancesConfig</a> <code>KeepJobFlowAliveWhenNoSteps</code> parameter is set to <code>TRUE</code>, the cluster transitions to the WAITING state rather than shutting down after the steps have completed.

</p

For additional protection, you can set the <a>JobFlowInstancesConfig</a> <code>TerminationProtected</code> parameter to <code>TRUE</code> 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 <a href="http://docs.aws.amazon.com/emr/latest/ManagementGuide/AddMoreThan256Steps.html">Add More than 256 Steps to a Cluster</a> in the <i>Amazon EMR Management

Guide</i>>

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

results> <note>

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

[slot] SetTerminationProtectionResponse *EmrClient::setTerminationProtection(const SetTerminationProtectionRequest &request)

Sends request to the EmrClient service, and returns a pointer to an SetTerminationProtectionResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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 <code>SetTerminationProtection</code> on a cluster is similar to calling the Amazon EC2 <code>DisableAPITermination</code> API on all EC2 instances in a

cluster>

<code>SetTerminationProtection</code> 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 <code>SetTerminationProtection</code> to <code>true</code>, you must first unlock the job flow by a subsequent call to <code>SetTerminationProtection</code> in which you set the value to <code>false</code>.

</p

For more information, see<a href="http://docs.aws.amazon.com/emr/latest/ManagementGuide/UsingEMR_TerminationProtection.html">Managing Cluster Termination</a> in the <i>Amazon EMR Management Guide</i>.

[slot] SetVisibleToAllUsersResponse *EmrClient::setVisibleToAllUsers(const SetVisibleToAllUsersRequest &request)

Sends request to the EmrClient service, and returns a pointer to an SetVisibleToAllUsersResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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

[slot] TerminateJobFlowsResponse *EmrClient::terminateJobFlows(const TerminateJobFlowsRequest &request)

Sends request to the EmrClient service, and returns a pointer to an TerminateJobFlowsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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 <code>TerminateJobFlows</code> 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