Hi there! Are you looking for the official Deno documentation? Try docs.deno.com for all your Deno learning needs.

Usage

import * as mod from "https://aws-api.deno.dev/v0.3/services/emr.ts?docs=full";

§Classes

EMR

§Interfaces

AddInstanceFleetInput
AddInstanceFleetOutput
AddInstanceGroupsInput

Input to an AddInstanceGroups call.

AddInstanceGroupsOutput

Output from an AddInstanceGroups call.

AddJobFlowStepsInput

The input argument to the "AddJobFlowSteps" operation.

AddJobFlowStepsOutput

The output for the "AddJobFlowSteps" operation.

AddTagsInput

This input identifies an Amazon EMR resource and a list of tags to attach.

Application

With Amazon EMR release version 4.0 and later, the only accepted parameter is the application name. To pass arguments to applications, you use configuration classifications specified using configuration JSON objects. For more information, see Configuring Applications.

AutoScalingPolicy

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

AutoScalingPolicyDescription

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. See "PutAutoScalingPolicy".

AutoScalingPolicyStateChangeReason

The reason for an "AutoScalingPolicyStatus" change.

AutoScalingPolicyStatus

The status of an automatic scaling policy.

AutoTerminationPolicy

An auto-termination policy for an Amazon EMR cluster. An auto-termination policy defines the amount of idle time in seconds after which a cluster automatically terminates. For alternative cluster termination options, see Control cluster termination.

BlockPublicAccessConfiguration

A configuration for Amazon EMR block public access. When BlockPublicSecurityGroupRules is set to true, Amazon EMR prevents cluster creation if one of the cluster's security groups has a rule that allows inbound traffic from 0.0.0.0/0 or ::/0 on a port, unless the port is specified as an exception using PermittedPublicSecurityGroupRuleRanges.

BlockPublicAccessConfigurationMetadata

Properties that describe the Amazon Web Services principal that created the BlockPublicAccessConfiguration using the PutBlockPublicAccessConfiguration action as well as the date and time that the configuration was created. Each time a configuration for block public access is updated, Amazon EMR updates this metadata.

BootstrapActionConfig

Configuration of a bootstrap action.

BootstrapActionDetail

Reports the configuration of a bootstrap action in a cluster (job flow).

CancelStepsInfo

Specification of the status of a CancelSteps request. Available only in Amazon EMR version 4.8.0 and later, excluding version 5.0.0.

CancelStepsInput

The input argument to the "CancelSteps" operation.

CancelStepsOutput

The output for the "CancelSteps" operation.

CloudWatchAlarmDefinition

The definition of a CloudWatch metric alarm, which determines when an automatic scaling activity is triggered. When the defined alarm conditions are satisfied, scaling activity begins.

Cluster

The detailed description of the cluster.

ClusterStateChangeReason

The reason that the cluster changed to its current state.

ClusterStatus

The detailed status of the cluster.

ClusterSummary

The summary description of the cluster.

ClusterTimeline

Represents the timeline of the cluster's lifecycle.

Command

An entity describing an executable that runs on a cluster.

ComputeLimits

The EC2 unit limits for a managed scaling policy. The managed scaling activity of a cluster can not be above or below these limits. The limit only applies to the core and task nodes. The master node cannot be scaled after initial configuration.

Configuration

Note: Amazon EMR releases 4.x or later.

CreateSecurityConfigurationInput
CreateSecurityConfigurationOutput
CreateStudioInput
CreateStudioOutput
CreateStudioSessionMappingInput
DeleteSecurityConfigurationInput
DeleteStudioInput
DeleteStudioSessionMappingInput
DescribeClusterInput

This input determines which cluster to describe.

DescribeClusterOutput

This output contains the description of the cluster.

DescribeJobFlowsInput

The input for the "DescribeJobFlows" operation.

DescribeJobFlowsOutput

The output for the "DescribeJobFlows" operation.

DescribeNotebookExecutionInput
DescribeNotebookExecutionOutput
DescribeReleaseLabelInput
DescribeReleaseLabelOutput
DescribeSecurityConfigurationInput
DescribeSecurityConfigurationOutput
DescribeStepInput

This input determines which step to describe.

DescribeStepOutput

This output contains the description of the cluster step.

DescribeStudioInput
DescribeStudioOutput
EbsBlockDevice

Configuration of requested EBS block device associated with the instance group.

EbsBlockDeviceConfig

Configuration of requested EBS block device associated with the instance group with count of volumes that will be associated to every instance.

EbsConfiguration

The Amazon EBS configuration of a cluster instance.

EbsVolume

EBS block device that's attached to an EC2 instance.

Ec2InstanceAttributes

Provides information about the EC2 instances in a cluster grouped by category. For example, key name, subnet ID, IAM instance profile, and so on.

ExecutionEngineConfig

Specifies the execution engine (cluster) to run the notebook and perform the notebook execution, for example, an EMR cluster.

FailureDetails

The details of the step failure. The service attempts to detect the root cause for many common failures.

GetAutoTerminationPolicyInput
GetAutoTerminationPolicyOutput
GetBlockPublicAccessConfigurationOutput
GetManagedScalingPolicyInput
GetManagedScalingPolicyOutput
GetStudioSessionMappingInput
GetStudioSessionMappingOutput
HadoopJarStepConfig

A job flow step consisting of a JAR file whose main function will be executed. The main function submits a job for Hadoop to execute and waits for the job to finish or fail.

HadoopStepConfig

A cluster step consisting of a JAR file whose main function will be executed. The main function submits a job for Hadoop to execute and waits for the job to finish or fail.

Instance

Represents an EC2 instance provisioned as part of cluster.

InstanceFleet

Describes an instance fleet, which is a group of EC2 instances that host a particular node type (master, core, or task) in an Amazon EMR cluster. Instance fleets can consist of a mix of instance types and On-Demand and Spot Instances, which are provisioned to meet a defined target capacity.

InstanceFleetConfig

The configuration that defines an instance fleet.

InstanceFleetModifyConfig

Configuration parameters for an instance fleet modification request.

InstanceFleetProvisioningSpecifications

The launch specification for Spot Instances in the fleet, which determines the defined duration, provisioning timeout behavior, and allocation strategy.

InstanceFleetStateChangeReason

Provides status change reason details for the instance fleet.

InstanceFleetStatus

The status of the instance fleet.

InstanceFleetTimeline

Provides historical timestamps for the instance fleet, including the time of creation, the time it became ready to run jobs, and the time of termination.

InstanceGroup

This entity represents an instance group, which is a group of instances that have common purpose. For example, CORE instance group is used for HDFS.

InstanceGroupConfig

Configuration defining a new instance group.

InstanceGroupDetail

Detailed information about an instance group.

InstanceGroupModifyConfig

Modify the size or configurations of an instance group.

InstanceGroupStateChangeReason

The status change reason details for the instance group.

InstanceGroupStatus

The details of the instance group status.

InstanceGroupTimeline

The timeline of the instance group lifecycle.

InstanceResizePolicy

Custom policy for requesting termination protection or termination of specific instances when shrinking an instance group.

InstanceStateChangeReason

The details of the status change reason for the instance.

InstanceStatus

The instance status details.

InstanceTimeline

The timeline of the instance lifecycle.

InstanceTypeConfig

An instance type configuration for each instance type in an instance fleet, which determines the EC2 instances Amazon EMR attempts to provision to fulfill On-Demand and Spot target capacities. When you use an allocation strategy, you can include a maximum of 30 instance type configurations for a fleet. For more information about how to use an allocation strategy, see Configure Instance Fleets. Without an allocation strategy, you may specify a maximum of five instance type configurations for a fleet.

InstanceTypeSpecification

The configuration specification for each instance type in an instance fleet.

JobFlowDetail

A description of a cluster (job flow).

JobFlowExecutionStatusDetail

Describes the status of the cluster (job flow).

JobFlowInstancesConfig

A description of the Amazon EC2 instance on which the cluster (job flow) runs. A valid JobFlowInstancesConfig must contain either InstanceGroups or InstanceFleets. They cannot be used together. You may also have MasterInstanceType, SlaveInstanceType, and InstanceCount (all three must be present), but we don't recommend this configuration.

JobFlowInstancesDetail

Specify the type of Amazon EC2 instances that the cluster (job flow) runs on.

KerberosAttributes

Attributes for Kerberos configuration when Kerberos authentication is enabled using a security configuration. For more information see Use Kerberos Authentication in the Amazon EMR Management Guide.

KeyValue

A key-value pair.

ListBootstrapActionsInput

This input determines which bootstrap actions to retrieve.

ListBootstrapActionsOutput

This output contains the bootstrap actions detail.

ListClustersInput

This input determines how the ListClusters action filters the list of clusters that it returns.

ListClustersOutput

This contains a ClusterSummaryList with the cluster details; for example, the cluster IDs, names, and status.

ListInstanceFleetsInput
ListInstanceFleetsOutput
ListInstanceGroupsInput

This input determines which instance groups to retrieve.

ListInstanceGroupsOutput

This input determines which instance groups to retrieve.

ListInstancesInput

This input determines which instances to list.

ListInstancesOutput

This output contains the list of instances.

ListNotebookExecutionsInput
ListNotebookExecutionsOutput
ListReleaseLabelsInput
ListReleaseLabelsOutput
ListSecurityConfigurationsInput
ListSecurityConfigurationsOutput
ListStepsInput

This input determines which steps to list.

ListStepsOutput

This output contains the list of steps returned in reverse order. This means that the last step is the first element in the list.

ListStudioSessionMappingsInput
ListStudioSessionMappingsOutput
ListStudiosInput
ListStudiosOutput
ManagedScalingPolicy

Managed scaling policy for an Amazon EMR cluster. The policy specifies the limits for resources 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.

MetricDimension

A CloudWatch dimension, which is specified using a Key (known as a Name in CloudWatch), Value pair. By default, Amazon EMR uses one dimension whose Key is JobFlowID and Value is a variable representing the cluster ID, which is ${emr.clusterId}. This enables the rule to bootstrap when the cluster ID becomes available.

ModifyClusterInput
ModifyClusterOutput
ModifyInstanceFleetInput
ModifyInstanceGroupsInput

Change the size of some instance groups.

NotebookExecution

A notebook execution. An execution is a specific instance that an EMR Notebook is run using the StartNotebookExecution action.

NotebookExecutionSummary

Details for a notebook execution. The details include information such as the unique ID and status of the notebook execution.

OnDemandCapacityReservationOptions

Describes the strategy for using unused Capacity Reservations for fulfilling On-Demand capacity.

OnDemandProvisioningSpecification

The launch specification for On-Demand Instances in the instance fleet, which determines the allocation strategy.

PlacementGroupConfig

Placement group configuration for an Amazon EMR cluster. The configuration specifies the placement strategy that can be applied to instance roles during cluster creation.

PlacementType

The Amazon EC2 Availability Zone configuration of the cluster (job flow).

PortRange

A list of port ranges that are permitted to allow inbound traffic from all public IP addresses. To specify a single port, use the same value for MinRange and MaxRange.

PutAutoScalingPolicyInput
PutAutoScalingPolicyOutput
PutAutoTerminationPolicyInput
PutBlockPublicAccessConfigurationInput
PutManagedScalingPolicyInput
ReleaseLabelFilter

The release label filters by application or version prefix.

RemoveAutoScalingPolicyInput
RemoveAutoTerminationPolicyInput
RemoveManagedScalingPolicyInput
RemoveTagsInput

This input identifies an Amazon EMR resource and a list of tags to remove.

RunJobFlowInput

Input to the "RunJobFlow" operation.

RunJobFlowOutput

The result of the "RunJobFlow" operation.

ScalingAction

The type of adjustment the automatic scaling activity makes when triggered, and the periodicity of the adjustment.

ScalingConstraints

The upper and lower EC2 instance limits for an automatic scaling policy. Automatic scaling activities triggered by automatic scaling rules will not cause an instance group to grow above or below these limits.

ScalingRule

A scale-in or scale-out rule that defines scaling activity, including the CloudWatch metric alarm that triggers activity, how EC2 instances are added or removed, and the periodicity of adjustments. The automatic scaling policy for an instance group can comprise one or more automatic scaling rules.

ScalingTrigger

The conditions that trigger an automatic scaling activity.

ScriptBootstrapActionConfig

Configuration of the script to run during a bootstrap action.

SecurityConfigurationSummary

The creation date and time, and name, of a security configuration.

SessionMappingDetail

Details for an Amazon EMR Studio session mapping including creation time, user or group ID, Studio ID, and so on.

SessionMappingSummary

Details for an Amazon EMR Studio session mapping. The details do not include the time the session mapping was last modified.

SetTerminationProtectionInput

The input argument to the "TerminationProtection" operation.

SetVisibleToAllUsersInput

The input to the SetVisibleToAllUsers action.

ShrinkPolicy

Policy for customizing shrink operations. Allows configuration of decommissioning timeout and targeted instance shrinking.

SimpleScalingPolicyConfiguration

An automatic scaling configuration, which describes how the policy adds or removes instances, the cooldown period, and the number of EC2 instances that will be added each time the CloudWatch metric alarm condition is satisfied.

SimplifiedApplication

The returned release label application names or versions.

SpotProvisioningSpecification

The launch specification for Spot Instances in the instance fleet, which determines the defined duration, provisioning timeout behavior, and allocation strategy.

StartNotebookExecutionInput
StartNotebookExecutionOutput
Step

This represents a step in a cluster.

StepConfig

Specification for a cluster (job flow) step.

StepDetail

Combines the execution state and configuration of a step.

StepExecutionStatusDetail

The execution state of a step.

StepStateChangeReason

The details of the step state change reason.

StepStatus

The execution status details of the cluster step.

StepSummary

The summary of the cluster step.

StepTimeline

The timeline of the cluster step lifecycle.

StopNotebookExecutionInput
Studio

Details for an Amazon EMR Studio including ID, creation time, name, and so on.

StudioSummary

Details for an Amazon EMR Studio, including ID, Name, VPC, and Description. The details do not include subnets, IAM roles, security groups, or tags associated with the Studio.

SupportedProductConfig

The list of supported product configurations that allow user-supplied arguments. EMR accepts these arguments and forwards them to the corresponding installation script as bootstrap action arguments.

Tag

A key-value pair containing user-defined metadata that you can associate with 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.

TerminateJobFlowsInput

Input to the "TerminateJobFlows" operation.

UpdateStudioInput
UpdateStudioSessionMappingInput
VolumeSpecification

EBS volume specifications such as volume type, IOPS, and size (GiB) that will be requested for the EBS volume attached to an EC2 instance in the cluster.

§Type Aliases

ActionOnFailure
AdjustmentType
AuthMode
AutoScalingPolicyState
AutoScalingPolicyStateChangeReasonCode
CancelStepsRequestStatus
ClusterState
ClusterStateChangeReasonCode
ComparisonOperator
ComputeLimitsUnitType
ExecutionEngineType
IdentityType
InstanceCollectionType
InstanceFleetState
InstanceFleetStateChangeReasonCode
InstanceFleetType
InstanceGroupState
InstanceGroupStateChangeReasonCode
InstanceGroupType
InstanceRoleType
InstanceState
InstanceStateChangeReasonCode
JobFlowExecutionState

The type of instance.

MarketType
NotebookExecutionStatus
OnDemandCapacityReservationPreference
OnDemandCapacityReservationUsageStrategy
OnDemandProvisioningAllocationStrategy
PlacementGroupStrategy
RepoUpgradeOnBoot
ScaleDownBehavior
SpotProvisioningAllocationStrategy
SpotProvisioningTimeoutAction
Statistic
StepCancellationOption
StepExecutionState
StepState
StepStateChangeReasonCode
Unit