EMR class

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.

Constructors

EMR({required String region, AwsClientCredentials? credentials, AwsClientCredentialsProvider? credentialsProvider, Client? client, String? endpointUrl})

Properties

hashCode → int
The hash code for this object.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

addInstanceFleet({required String clusterId, required InstanceFleetConfig instanceFleet}) → Future<AddInstanceFleetOutput>
Adds an instance fleet to a running cluster.
addInstanceGroups({required List<InstanceGroupConfig> instanceGroups, required String jobFlowId}) → Future<AddInstanceGroupsOutput>
Adds one or more instance groups to a running cluster.
addJobFlowSteps({required String jobFlowId, required List<StepConfig> steps}) → Future<AddJobFlowStepsOutput>
AddJobFlowSteps adds new steps to a running cluster. A maximum of 256 steps are allowed in each job flow.
addTags({required String resourceId, required List<Tag> tags}) → Future<void>
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.
cancelSteps({required String clusterId, required List<String> stepIds, StepCancellationOption? stepCancellationOption}) → Future<CancelStepsOutput>
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.
close() → void
Closes the internal HTTP client if none was provided at creation. If a client was passed as a constructor argument, this becomes a noop.
createSecurityConfiguration({required String name, required String securityConfiguration}) → Future<CreateSecurityConfigurationOutput>
Creates a security configuration, which is stored in the service and can be specified when a cluster is created.
createStudio({required AuthMode authMode, required String engineSecurityGroupId, required String name, required String serviceRole, required List<String> subnetIds, required String userRole, required String vpcId, required String workspaceSecurityGroupId, String? defaultS3Location, String? description, List<Tag>? tags}) → Future<CreateStudioOutput>
May throw InternalServerException. May throw InvalidRequestException.
createStudioSessionMapping({required IdentityType identityType, required String sessionPolicyArn, required String studioId, String? identityId, String? identityName}) → Future<void>
StudioId
deleteSecurityConfiguration({required String name}) → Future<void>
Deletes a security configuration.
deleteStudio({required String studioId}) → Future<void>
May throw InternalServerException. May throw InvalidRequestException.
deleteStudioSessionMapping({required IdentityType identityType, required String studioId, String? identityId, String? identityName}) → Future<void>
May throw InternalServerError. May throw InvalidRequestException.
describeCluster({required String clusterId}) → Future<DescribeClusterOutput>
Provides cluster-level details including status, hardware and software configuration, VPC settings, and so on.
describeJobFlows({DateTime? createdAfter, DateTime? createdBefore, List<String>? jobFlowIds, List<JobFlowExecutionState>? jobFlowStates}) → Future<DescribeJobFlowsOutput>
This API is no longer supported and will eventually be removed. We recommend you use ListClusters, DescribeCluster, ListSteps, ListInstanceGroups and ListBootstrapActions instead.
describeNotebookExecution({required String notebookExecutionId}) → Future<DescribeNotebookExecutionOutput>
Provides details of a notebook execution.
describeSecurityConfiguration({required String name}) → Future<DescribeSecurityConfigurationOutput>
Provides the details of a security configuration by returning the configuration JSON.
describeStep({required String clusterId, required String stepId}) → Future<DescribeStepOutput>
Provides more detail about the cluster step.
describeStudio({required String studioId}) → Future<DescribeStudioOutput>
May throw InternalServerException. May throw InvalidRequestException.
getBlockPublicAccessConfiguration() → Future<GetBlockPublicAccessConfigurationOutput>
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 in the Amazon EMR Management Guide.
getManagedScalingPolicy({required String clusterId}) → Future<GetManagedScalingPolicyOutput>
Fetches the attached managed scaling policy for an Amazon EMR cluster.
getStudioSessionMapping({required IdentityType identityType, required String studioId, String? identityId, String? identityName}) → Future<GetStudioSessionMappingOutput>
May throw InternalServerError. May throw InvalidRequestException.
listBootstrapActions({required String clusterId, String? marker}) → Future<ListBootstrapActionsOutput>
Provides information about the bootstrap actions associated with a cluster.
listClusters({List<ClusterState>? clusterStates, DateTime? createdAfter, DateTime? createdBefore, String? marker}) → Future<ListClustersOutput>
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({required String clusterId, String? marker}) → Future<ListInstanceFleetsOutput>
Lists all available details about the instance fleets in a cluster.
listInstanceGroups({required String clusterId, String? marker}) → Future<ListInstanceGroupsOutput>
Provides all available details about the instance groups in a cluster.
listInstances({required String clusterId, String? instanceFleetId, InstanceFleetType? instanceFleetType, String? instanceGroupId, List<InstanceGroupType>? instanceGroupTypes, List<InstanceState>? instanceStates, String? marker}) → Future<ListInstancesOutput>
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({String? editorId, DateTime? from, String? marker, NotebookExecutionStatus? status, DateTime? to}) → Future<ListNotebookExecutionsOutput>
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({String? marker}) → Future<ListSecurityConfigurationsOutput>
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({required String clusterId, String? marker, List<String>? stepIds, List<StepState>? stepStates}) → Future<ListStepsOutput>
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 ten stepIDs.
listStudios({String? marker}) → Future<ListStudiosOutput>
May throw InternalServerException. May throw InvalidRequestException.
listStudioSessionMappings({IdentityType? identityType, String? marker, String? studioId}) → Future<ListStudioSessionMappingsOutput>
StudioId
modifyCluster({required String clusterId, int? stepConcurrencyLevel}) → Future<ModifyClusterOutput>
Modifies the number of steps that can be executed concurrently for the cluster specified using ClusterID.
modifyInstanceFleet({required String clusterId, required InstanceFleetModifyConfig instanceFleet}) → Future<void>
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.
modifyInstanceGroups({String? clusterId, List<InstanceGroupModifyConfig>? instanceGroups}) → Future<void>
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.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
putAutoScalingPolicy({required AutoScalingPolicy autoScalingPolicy, required String clusterId, required String instanceGroupId}) → Future<PutAutoScalingPolicyOutput>
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({required BlockPublicAccessConfiguration blockPublicAccessConfiguration}) → Future<void>
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 in the Amazon EMR Management Guide.
putManagedScalingPolicy({required String clusterId, required ManagedScalingPolicy managedScalingPolicy}) → Future<void>
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({required String clusterId, required String instanceGroupId}) → Future<void>
Removes an automatic scaling policy from a specified instance group within an EMR cluster.
removeManagedScalingPolicy({required String clusterId}) → Future<void>
Removes a managed scaling policy from a specified EMR cluster.
removeTags({required String resourceId, required List<String> tagKeys}) → Future<void>
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.
runJobFlow({required JobFlowInstancesConfig instances, required String name, String? additionalInfo, String? amiVersion, List<Application>? applications, String? autoScalingRole, List<BootstrapActionConfig>? bootstrapActions, List<Configuration>? configurations, String? customAmiId, int? ebsRootVolumeSize, String? jobFlowRole, KerberosAttributes? kerberosAttributes, String? logEncryptionKmsKeyId, String? logUri, ManagedScalingPolicy? managedScalingPolicy, List<SupportedProductConfig>? newSupportedProducts, List<PlacementGroupConfig>? placementGroupConfigs, String? releaseLabel, RepoUpgradeOnBoot? repoUpgradeOnBoot, ScaleDownBehavior? scaleDownBehavior, String? securityConfiguration, String? serviceRole, int? stepConcurrencyLevel, List<StepConfig>? steps, List<String>? supportedProducts, List<Tag>? tags, bool? visibleToAllUsers}) → Future<RunJobFlowOutput>
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.
setTerminationProtection({required List<String> jobFlowIds, required bool terminationProtected}) → Future<void>
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.
setVisibleToAllUsers({required List<String> jobFlowIds, required bool visibleToAllUsers}) → Future<void>
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({required String editorId, required ExecutionEngineConfig executionEngine, required String relativePath, required String serviceRole, String? notebookExecutionName, String? notebookInstanceSecurityGroupId, String? notebookParams, List<Tag>? tags}) → Future<StartNotebookExecutionOutput>
Starts a notebook execution.
stopNotebookExecution({required String notebookExecutionId}) → Future<void>
Stops a notebook execution.
terminateJobFlows({required List<String> jobFlowIds}) → Future<void>
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.
toString() → String
A string representation of this object.
inherited
updateStudioSessionMapping({required IdentityType identityType, required String sessionPolicyArn, required String studioId, String? identityId, String? identityName}) → Future<void>
May throw InternalServerError. May throw InvalidRequestException.

Operators

operator ==(Object other) → bool
The equality operator.
inherited