5.0.0 • Published 7 years ago
@datafire/amazonaws_elasticmapreduce v5.0.0
@datafire/amazonaws_elasticmapreduce
Client library for Amazon Elastic MapReduce
Installation and Usage
npm install --save @datafire/amazonaws_elasticmapreduce
let amazonaws_elasticmapreduce = require('@datafire/amazonaws_elasticmapreduce').create({
accessKeyId: "",
secretAccessKey: "",
region: ""
});
amazonaws_elasticmapreduce.AddInstanceFleet({
"ClusterId": "",
"InstanceFleet": {
"InstanceFleetType": ""
}
}).then(data => {
console.log(data);
});
Description
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.
Actions
AddInstanceFleet
amazonaws_elasticmapreduce.AddInstanceFleet({
"ClusterId": "",
"InstanceFleet": {
"InstanceFleetType": ""
}
}, context)
Input
- input
object
- ClusterId required XmlStringMaxLen256
- InstanceFleet required InstanceFleetConfig
Output
- output AddInstanceFleetOutput
AddInstanceGroups
amazonaws_elasticmapreduce.AddInstanceGroups({
"InstanceGroups": [],
"JobFlowId": ""
}, context)
Input
- input
object
- InstanceGroups required InstanceGroupConfigList
- JobFlowId required XmlStringMaxLen256
Output
- output AddInstanceGroupsOutput
AddJobFlowSteps
amazonaws_elasticmapreduce.AddJobFlowSteps({
"JobFlowId": "",
"Steps": []
}, context)
Input
- input
object
- JobFlowId required XmlStringMaxLen256
- Steps required StepConfigList
Output
- output AddJobFlowStepsOutput
AddTags
amazonaws_elasticmapreduce.AddTags({
"ResourceId": "",
"Tags": []
}, context)
Input
- input
object
- ResourceId required ResourceId
- Tags required TagList
Output
- output AddTagsOutput
CancelSteps
amazonaws_elasticmapreduce.CancelSteps({}, context)
Input
- input
object
- ClusterId XmlStringMaxLen256
- StepIds StepIdsList
Output
- output CancelStepsOutput
CreateSecurityConfiguration
amazonaws_elasticmapreduce.CreateSecurityConfiguration({
"Name": "",
"SecurityConfiguration": ""
}, context)
Input
Output
DeleteSecurityConfiguration
amazonaws_elasticmapreduce.DeleteSecurityConfiguration({
"Name": ""
}, context)
Input
- input
object
- Name required XmlString
Output
DescribeCluster
amazonaws_elasticmapreduce.DescribeCluster({
"ClusterId": ""
}, context)
Input
- input
object
- ClusterId required ClusterId
Output
- output DescribeClusterOutput
DescribeJobFlows
amazonaws_elasticmapreduce.DescribeJobFlows({}, context)
Input
- input
object
- CreatedAfter Date
- CreatedBefore Date
- JobFlowIds XmlStringList
- JobFlowStates JobFlowExecutionStateList
Output
- output DescribeJobFlowsOutput
DescribeSecurityConfiguration
amazonaws_elasticmapreduce.DescribeSecurityConfiguration({
"Name": ""
}, context)
Input
- input
object
- Name required XmlString
Output
DescribeStep
amazonaws_elasticmapreduce.DescribeStep({
"ClusterId": "",
"StepId": ""
}, context)
Input
Output
- output DescribeStepOutput
ListBootstrapActions
amazonaws_elasticmapreduce.ListBootstrapActions({
"ClusterId": ""
}, context)
Input
Output
- output ListBootstrapActionsOutput
ListClusters
amazonaws_elasticmapreduce.ListClusters({}, context)
Input
- input
object
- Marker
string
- ClusterStates ClusterStateList
- CreatedAfter Date
- CreatedBefore Date
- Marker Marker
- Marker
Output
- output ListClustersOutput
ListInstanceFleets
amazonaws_elasticmapreduce.ListInstanceFleets({
"ClusterId": ""
}, context)
Input
Output
- output ListInstanceFleetsOutput
ListInstanceGroups
amazonaws_elasticmapreduce.ListInstanceGroups({
"ClusterId": ""
}, context)
Input
Output
- output ListInstanceGroupsOutput
ListInstances
amazonaws_elasticmapreduce.ListInstances({
"ClusterId": ""
}, context)
Input
- input
object
- Marker
string
- ClusterId required ClusterId
- InstanceFleetId InstanceFleetId
- InstanceFleetType InstanceFleetType
- InstanceGroupId InstanceGroupId
- InstanceGroupTypes InstanceGroupTypeList
- InstanceStates InstanceStateList
- Marker Marker
- Marker
Output
- output ListInstancesOutput
ListSecurityConfigurations
amazonaws_elasticmapreduce.ListSecurityConfigurations({}, context)
Input
- input
object
- Marker Marker
Output
ListSteps
amazonaws_elasticmapreduce.ListSteps({
"ClusterId": ""
}, context)
Input
- input
object
- Marker
string
- ClusterId required ClusterId
- Marker Marker
- StepIds XmlStringList
- StepStates StepStateList
- Marker
Output
- output ListStepsOutput
ModifyInstanceFleet
amazonaws_elasticmapreduce.ModifyInstanceFleet({
"ClusterId": "",
"InstanceFleet": {
"InstanceFleetId": ""
}
}, context)
Input
- input
object
- ClusterId required ClusterId
- InstanceFleet required InstanceFleetModifyConfig
Output
Output schema unknown
ModifyInstanceGroups
amazonaws_elasticmapreduce.ModifyInstanceGroups({}, context)
Input
- input
object
- ClusterId ClusterId
- InstanceGroups InstanceGroupModifyConfigList
Output
Output schema unknown
PutAutoScalingPolicy
amazonaws_elasticmapreduce.PutAutoScalingPolicy({
"ClusterId": "",
"InstanceGroupId": "",
"AutoScalingPolicy": {
"Constraints": {
"MinCapacity": 0,
"MaxCapacity": 0
},
"Rules": []
}
}, context)
Input
- input
object
- AutoScalingPolicy required AutoScalingPolicy
- ClusterId required ClusterId
- InstanceGroupId required InstanceGroupId
Output
- output PutAutoScalingPolicyOutput
RemoveAutoScalingPolicy
amazonaws_elasticmapreduce.RemoveAutoScalingPolicy({
"ClusterId": "",
"InstanceGroupId": ""
}, context)
Input
- input
object
- ClusterId required ClusterId
- InstanceGroupId required InstanceGroupId
Output
RemoveTags
amazonaws_elasticmapreduce.RemoveTags({
"ResourceId": "",
"TagKeys": []
}, context)
Input
- input
object
- ResourceId required ResourceId
- TagKeys required StringList
Output
- output RemoveTagsOutput
RunJobFlow
amazonaws_elasticmapreduce.RunJobFlow({
"Name": "",
"Instances": {}
}, context)
Input
- input
object
- AdditionalInfo XmlString
- AmiVersion XmlStringMaxLen256
- Applications ApplicationList
- AutoScalingRole XmlString
- BootstrapActions BootstrapActionConfigList
- Configurations ConfigurationList
- CustomAmiId XmlStringMaxLen256
- EbsRootVolumeSize Integer
- Instances required JobFlowInstancesConfig
- JobFlowRole XmlString
- KerberosAttributes KerberosAttributes
- LogUri XmlString
- Name required XmlStringMaxLen256
- NewSupportedProducts NewSupportedProductsList
- ReleaseLabel XmlStringMaxLen256
- RepoUpgradeOnBoot RepoUpgradeOnBoot
- ScaleDownBehavior ScaleDownBehavior
- SecurityConfiguration XmlString
- ServiceRole XmlString
- Steps StepConfigList
- SupportedProducts SupportedProductsList
- Tags TagList
- VisibleToAllUsers Boolean
Output
- output RunJobFlowOutput
SetTerminationProtection
amazonaws_elasticmapreduce.SetTerminationProtection({
"JobFlowIds": [],
"TerminationProtected": true
}, context)
Input
- input
object
- JobFlowIds required XmlStringList
- TerminationProtected required Boolean
Output
Output schema unknown
SetVisibleToAllUsers
amazonaws_elasticmapreduce.SetVisibleToAllUsers({
"JobFlowIds": [],
"VisibleToAllUsers": true
}, context)
Input
- input
object
- JobFlowIds required XmlStringList
- VisibleToAllUsers required Boolean
Output
Output schema unknown
TerminateJobFlows
amazonaws_elasticmapreduce.TerminateJobFlows({
"JobFlowIds": []
}, context)
Input
- input
object
- JobFlowIds required XmlStringList
Output
Output schema unknown
Definitions
ActionOnFailure
- ActionOnFailure
string
(values: TERMINATE_JOB_FLOW, TERMINATE_CLUSTER, CANCEL_AND_WAIT, CONTINUE)
AddInstanceFleetInput
- AddInstanceFleetInput
object
- ClusterId required XmlStringMaxLen256
- InstanceFleet required InstanceFleetConfig
AddInstanceFleetOutput
- AddInstanceFleetOutput
object
- ClusterId XmlStringMaxLen256
- InstanceFleetId InstanceFleetId
AddInstanceGroupsInput
- AddInstanceGroupsInput
object
: Input to an AddInstanceGroups call.- InstanceGroups required InstanceGroupConfigList
- JobFlowId required XmlStringMaxLen256
AddInstanceGroupsOutput
- AddInstanceGroupsOutput
object
: Output from an AddInstanceGroups call.- InstanceGroupIds InstanceGroupIdsList
- JobFlowId XmlStringMaxLen256
AddJobFlowStepsInput
- AddJobFlowStepsInput
object
: The input argument to the AddJobFlowSteps operation.- JobFlowId required XmlStringMaxLen256
- Steps required StepConfigList
AddJobFlowStepsOutput
- AddJobFlowStepsOutput
object
: The output for the AddJobFlowSteps operation.- StepIds StepIdsList
AddTagsInput
- AddTagsInput
object
: This input identifies a cluster and a list of tags to attach.- ResourceId required ResourceId
- Tags required TagList
AddTagsOutput
- AddTagsOutput
object
: This output indicates the result of adding tags to a resource.
AdjustmentType
- AdjustmentType
string
(values: CHANGE_IN_CAPACITY, PERCENT_CHANGE_IN_CAPACITY, EXACT_CAPACITY)
Application
- Application
object
: An application is any Amazon or third-party software that you can add to the cluster. This structure contains a list of strings that indicates the software to use with the cluster and accepts a user argument list. Amazon EMR accepts and forwards the argument list to the corresponding installation script as bootstrap action argument. For more information, see Using the MapR Distribution for Hadoop. Currently supported values are: "mapr-m3" - launch the cluster using MapR M3 Edition. "mapr-m5" - launch the cluster using MapR M5 Edition. "mapr" with the user arguments specifying "--edition,m3" or "--edition,m5" - launch the cluster using MapR M3 or M5 Edition, respectively. In Amazon EMR releases 4.x and later, the only accepted parameter is the application name. To pass arguments to applications, you supply a configuration for each application.- AdditionalInfo StringMap
- Args StringList
- Name String
- Version String
ApplicationList
- ApplicationList
array
- items Application
AutoScalingPolicy
- AutoScalingPolicy
object
: 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.- Constraints required ScalingConstraints
- Rules required ScalingRuleList
AutoScalingPolicyDescription
- AutoScalingPolicyDescription
object
: 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.- Constraints ScalingConstraints
- Rules ScalingRuleList
- Status AutoScalingPolicyStatus
AutoScalingPolicyState
- AutoScalingPolicyState
string
(values: PENDING, ATTACHING, ATTACHED, DETACHING, DETACHED, FAILED)
AutoScalingPolicyStateChangeReason
- AutoScalingPolicyStateChangeReason
object
: The reason for an AutoScalingPolicyStatus change.- Code AutoScalingPolicyStateChangeReasonCode
- Message String
AutoScalingPolicyStateChangeReasonCode
- AutoScalingPolicyStateChangeReasonCode
string
(values: USER_REQUEST, PROVISION_FAILURE, CLEANUP_FAILURE)
AutoScalingPolicyStatus
- AutoScalingPolicyStatus
object
: The status of an automatic scaling policy.- State AutoScalingPolicyState
- StateChangeReason AutoScalingPolicyStateChangeReason
Boolean
- Boolean
boolean
BooleanObject
- BooleanObject
boolean
BootstrapActionConfig
- BootstrapActionConfig
object
: Configuration of a bootstrap action.- Name required XmlStringMaxLen256
- ScriptBootstrapAction required ScriptBootstrapActionConfig
BootstrapActionConfigList
- BootstrapActionConfigList
array
- items BootstrapActionConfig
BootstrapActionDetail
- BootstrapActionDetail
object
: Reports the configuration of a bootstrap action in a cluster (job flow).- BootstrapActionConfig BootstrapActionConfig
BootstrapActionDetailList
- BootstrapActionDetailList
array
- items BootstrapActionDetail
CancelStepsInfo
- CancelStepsInfo
object
: Specification of the status of a CancelSteps request. Available only in Amazon EMR version 4.8.0 and later, excluding version 5.0.0.- Reason String
- Status CancelStepsRequestStatus
- StepId StepId
CancelStepsInfoList
- CancelStepsInfoList
array
- items CancelStepsInfo
CancelStepsInput
- CancelStepsInput
object
: The input argument to the CancelSteps operation.- ClusterId XmlStringMaxLen256
- StepIds StepIdsList
CancelStepsOutput
- CancelStepsOutput
object
: The output for the CancelSteps operation.- CancelStepsInfoList CancelStepsInfoList
CancelStepsRequestStatus
- CancelStepsRequestStatus
string
(values: SUBMITTED, FAILED)
CloudWatchAlarmDefinition
- CloudWatchAlarmDefinition
object
: 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.- ComparisonOperator required ComparisonOperator
- Dimensions MetricDimensionList
- EvaluationPeriods Integer
- MetricName required String
- Namespace String
- Period required Integer
- Statistic Statistic
- Threshold required NonNegativeDouble
- Unit Unit
Cluster
- Cluster
object
: The detailed description of the cluster.- Applications ApplicationList
- AutoScalingRole XmlString
- AutoTerminate Boolean
- Configurations ConfigurationList
- CustomAmiId XmlStringMaxLen256
- EbsRootVolumeSize Integer
- Ec2InstanceAttributes Ec2InstanceAttributes
- Id ClusterId
- InstanceCollectionType InstanceCollectionType
- KerberosAttributes KerberosAttributes
- LogUri String
- MasterPublicDnsName String
- Name String
- NormalizedInstanceHours Integer
- ReleaseLabel String
- RepoUpgradeOnBoot RepoUpgradeOnBoot
- RequestedAmiVersion String
- RunningAmiVersion String
- ScaleDownBehavior ScaleDownBehavior
- SecurityConfiguration XmlString
- ServiceRole String
- Status ClusterStatus
- Tags TagList
- TerminationProtected Boolean
- VisibleToAllUsers Boolean
ClusterId
- ClusterId
string
ClusterState
- ClusterState
string
(values: STARTING, BOOTSTRAPPING, RUNNING, WAITING, TERMINATING, TERMINATED, TERMINATED_WITH_ERRORS)
ClusterStateChangeReason
- ClusterStateChangeReason
object
: The reason that the cluster changed to its current state.- Code ClusterStateChangeReasonCode
- Message String
ClusterStateChangeReasonCode
- ClusterStateChangeReasonCode
string
(values: INTERNAL_ERROR, VALIDATION_ERROR, INSTANCE_FAILURE, INSTANCE_FLEET_TIMEOUT, BOOTSTRAP_FAILURE, USER_REQUEST, STEP_FAILURE, ALL_STEPS_COMPLETED)
ClusterStateList
- ClusterStateList
array
- items ClusterState
ClusterStatus
- ClusterStatus
object
: The detailed status of the cluster.- State ClusterState
- StateChangeReason ClusterStateChangeReason
- Timeline ClusterTimeline
ClusterSummary
- ClusterSummary
object
: The summary description of the cluster.- Id ClusterId
- Name String
- NormalizedInstanceHours Integer
- Status ClusterStatus
ClusterSummaryList
- ClusterSummaryList
array
- items ClusterSummary
ClusterTimeline
- ClusterTimeline
object
: Represents the timeline of the cluster's lifecycle.
Command
- Command
object
: An entity describing an executable that runs on a cluster.- Args StringList
- Name String
- ScriptPath String
CommandList
- CommandList
array
- items Command
ComparisonOperator
- ComparisonOperator
string
(values: GREATER_THAN_OR_EQUAL, GREATER_THAN, LESS_THAN, LESS_THAN_OR_EQUAL)
Configuration
- Configuration
object
: Amazon EMR releases 4.x or later. An optional configuration specification to be used when provisioning cluster instances, which can include configurations for applications and software bundled with Amazon EMR. A configuration consists of a classification, properties, and optional nested configurations. A classification refers to an application-specific configuration file. Properties are the settings you want to change in that file. For more information, see Configuring Applications.- Classification String
- Configurations ConfigurationList
- Properties StringMap
ConfigurationList
- ConfigurationList
array
- items Configuration
CreateSecurityConfigurationInput
CreateSecurityConfigurationOutput
Date
- Date
string
DeleteSecurityConfigurationInput
- DeleteSecurityConfigurationInput
object
- Name required XmlString
DeleteSecurityConfigurationOutput
- DeleteSecurityConfigurationOutput
object
DescribeClusterInput
- DescribeClusterInput
object
: This input determines which cluster to describe.- ClusterId required ClusterId
DescribeClusterOutput
- DescribeClusterOutput
object
: This output contains the description of the cluster.- Cluster Cluster
DescribeJobFlowsInput
- DescribeJobFlowsInput
object
: The input for the DescribeJobFlows operation.- CreatedAfter Date
- CreatedBefore Date
- JobFlowIds XmlStringList
- JobFlowStates JobFlowExecutionStateList
DescribeJobFlowsOutput
- DescribeJobFlowsOutput
object
: The output for the DescribeJobFlows operation.- JobFlows JobFlowDetailList
DescribeSecurityConfigurationInput
- DescribeSecurityConfigurationInput
object
- Name required XmlString
DescribeSecurityConfigurationOutput
- DescribeSecurityConfigurationOutput
object
DescribeStepInput
- DescribeStepInput
object
: This input determines which step to describe.
DescribeStepOutput
- DescribeStepOutput
object
: This output contains the description of the cluster step.- Step Step
EC2InstanceIdsList
- EC2InstanceIdsList
array
- items InstanceId
EC2InstanceIdsToTerminateList
- EC2InstanceIdsToTerminateList
array
- items InstanceId
EbsBlockDevice
- EbsBlockDevice
object
: Configuration of requested EBS block device associated with the instance group.- Device String
- VolumeSpecification VolumeSpecification
EbsBlockDeviceConfig
- EbsBlockDeviceConfig
object
: Configuration of requested EBS block device associated with the instance group with count of volumes that will be associated to every instance.- VolumeSpecification required VolumeSpecification
- VolumesPerInstance Integer
EbsBlockDeviceConfigList
- EbsBlockDeviceConfigList
array
- items EbsBlockDeviceConfig
EbsBlockDeviceList
- EbsBlockDeviceList
array
- items EbsBlockDevice
EbsConfiguration
- EbsConfiguration
object
: The Amazon EBS configuration of a cluster instance.- EbsBlockDeviceConfigs EbsBlockDeviceConfigList
- EbsOptimized BooleanObject
EbsVolume
EbsVolumeList
- EbsVolumeList
array
- items EbsVolume
Ec2InstanceAttributes
- Ec2InstanceAttributes
object
: Provides information about the EC2 instances in a cluster grouped by category. For example, key name, subnet ID, IAM instance profile, and so on.- AdditionalMasterSecurityGroups StringList
- AdditionalSlaveSecurityGroups StringList
- Ec2AvailabilityZone String
- Ec2KeyName String
- Ec2SubnetId String
- EmrManagedMasterSecurityGroup String
- EmrManagedSlaveSecurityGroup String
- IamInstanceProfile String
- RequestedEc2AvailabilityZones XmlStringMaxLen256List
- RequestedEc2SubnetIds XmlStringMaxLen256List
- ServiceAccessSecurityGroup String
ErrorCode
- ErrorCode
string
ErrorMessage
- ErrorMessage
string
FailureDetails
- FailureDetails
object
: The details of the step failure. The service attempts to detect the root cause for many common failures.
HadoopJarStepConfig
- HadoopJarStepConfig
object
: 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.- Args XmlStringList
- Jar required XmlString
- MainClass XmlString
- Properties KeyValueList
HadoopStepConfig
- HadoopStepConfig
object
: 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.- Args StringList
- Jar String
- MainClass String
- Properties StringMap
Instance
- Instance
object
: Represents an EC2 instance provisioned as part of cluster.- EbsVolumes EbsVolumeList
- Ec2InstanceId InstanceId
- Id InstanceId
- InstanceFleetId InstanceFleetId
- InstanceGroupId String
- InstanceType InstanceType
- Market MarketType
- PrivateDnsName String
- PrivateIpAddress String
- PublicDnsName String
- PublicIpAddress String
- Status InstanceStatus
InstanceCollectionType
- InstanceCollectionType
string
(values: INSTANCE_FLEET, INSTANCE_GROUP)
InstanceFleet
- InstanceFleet
object
: 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. The instance fleet configuration is available only in Amazon EMR versions 4.8.0 and later, excluding 5.0.x versions.- Id InstanceFleetId
- InstanceFleetType InstanceFleetType
- InstanceTypeSpecifications InstanceTypeSpecificationList
- LaunchSpecifications InstanceFleetProvisioningSpecifications
- Name XmlStringMaxLen256
- ProvisionedOnDemandCapacity WholeNumber
- ProvisionedSpotCapacity WholeNumber
- Status InstanceFleetStatus
- TargetOnDemandCapacity WholeNumber
- TargetSpotCapacity WholeNumber
InstanceFleetConfig
- InstanceFleetConfig
object
: The configuration that defines an instance fleet. The instance fleet configuration is available only in Amazon EMR versions 4.8.0 and later, excluding 5.0.x versions.- InstanceFleetType required InstanceFleetType
- InstanceTypeConfigs InstanceTypeConfigList
- LaunchSpecifications InstanceFleetProvisioningSpecifications
- Name XmlStringMaxLen256
- TargetOnDemandCapacity WholeNumber
- TargetSpotCapacity WholeNumber
InstanceFleetConfigList
- InstanceFleetConfigList
array
- items InstanceFleetConfig
InstanceFleetId
- InstanceFleetId
string
InstanceFleetList
- InstanceFleetList
array
- items InstanceFleet
InstanceFleetModifyConfig
- InstanceFleetModifyConfig
object
: Configuration parameters for an instance fleet modification request. The instance fleet configuration is available only in Amazon EMR versions 4.8.0 and later, excluding 5.0.x versions.- InstanceFleetId required InstanceFleetId
- TargetOnDemandCapacity WholeNumber
- TargetSpotCapacity WholeNumber
InstanceFleetProvisioningSpecifications
- InstanceFleetProvisioningSpecifications
object
: The launch specification for Spot instances in the fleet, which determines the defined duration and provisioning timeout behavior. The instance fleet configuration is available only in Amazon EMR versions 4.8.0 and later, excluding 5.0.x versions.- SpotSpecification required SpotProvisioningSpecification
InstanceFleetState
- InstanceFleetState
string
(values: PROVISIONING, BOOTSTRAPPING, RUNNING, RESIZING, SUSPENDED, TERMINATING, TERMINATED)
InstanceFleetStateChangeReason
- InstanceFleetStateChangeReason
object
: Provides status change reason details for the instance fleet. The instance fleet configuration is available only in Amazon EMR versions 4.8.0 and later, excluding 5.0.x versions.- Code InstanceFleetStateChangeReasonCode
- Message String
InstanceFleetStateChangeReasonCode
- InstanceFleetStateChangeReasonCode
string
(values: INTERNAL_ERROR, VALIDATION_ERROR, INSTANCE_FAILURE, CLUSTER_TERMINATED)
InstanceFleetStatus
- InstanceFleetStatus
object
: The status of the instance fleet. The instance fleet configuration is available only in Amazon EMR versions 4.8.0 and later, excluding 5.0.x versions.- State InstanceFleetState
- StateChangeReason InstanceFleetStateChangeReason
- Timeline InstanceFleetTimeline
InstanceFleetTimeline
- InstanceFleetTimeline
object
: 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. The instance fleet configuration is available only in Amazon EMR versions 4.8.0 and later, excluding 5.0.x versions.
InstanceFleetType
- InstanceFleetType
string
(values: MASTER, CORE, TASK)
InstanceGroup
- InstanceGroup
object
: 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.- AutoScalingPolicy AutoScalingPolicyDescription
- BidPrice String
- Configurations ConfigurationList
- EbsBlockDevices EbsBlockDeviceList
- EbsOptimized BooleanObject
- Id InstanceGroupId
- InstanceGroupType InstanceGroupType
- InstanceType InstanceType
- Market MarketType
- Name String
- RequestedInstanceCount Integer
- RunningInstanceCount Integer
- ShrinkPolicy ShrinkPolicy
- Status InstanceGroupStatus
InstanceGroupConfig
- InstanceGroupConfig
object
: Configuration defining a new instance group.- AutoScalingPolicy AutoScalingPolicy
- BidPrice XmlStringMaxLen256
- Configurations ConfigurationList
- EbsConfiguration EbsConfiguration
- InstanceCount required Integer
- InstanceRole required InstanceRoleType
- InstanceType required InstanceType
- Market MarketType
- Name XmlStringMaxLen256
InstanceGroupConfigList
- InstanceGroupConfigList
array
- items InstanceGroupConfig
InstanceGroupDetail
- InstanceGroupDetail
object
: Detailed information about an instance group.- BidPrice XmlStringMaxLen256
- CreationDateTime required Date
- EndDateTime Date
- InstanceGroupId XmlStringMaxLen256
- InstanceRequestCount required Integer
- InstanceRole required InstanceRoleType
- InstanceRunningCount required Integer
- InstanceType required InstanceType
- LastStateChangeReason XmlString
- Market required MarketType
- Name XmlStringMaxLen256
- ReadyDateTime Date
- StartDateTime Date
- State required InstanceGroupState
InstanceGroupDetailList
- InstanceGroupDetailList
array
- items InstanceGroupDetail
InstanceGroupId
- InstanceGroupId
string
InstanceGroupIdsList
- InstanceGroupIdsList
array
- items XmlStringMaxLen256
InstanceGroupList
- InstanceGroupList
array
- items InstanceGroup
InstanceGroupModifyConfig
- InstanceGroupModifyConfig
object
: Modify an instance group size.- EC2InstanceIdsToTerminate EC2InstanceIdsToTerminateList
- InstanceCount Integer
- InstanceGroupId required XmlStringMaxLen256
- ShrinkPolicy ShrinkPolicy
InstanceGroupModifyConfigList
- InstanceGroupModifyConfigList
array
InstanceGroupState
- InstanceGroupState
string
(values: PROVISIONING, BOOTSTRAPPING, RUNNING, RESIZING, SUSPENDED, TERMINATING, TERMINATED, ARRESTED, SHUTTING_DOWN, ENDED)
InstanceGroupStateChangeReason
- InstanceGroupStateChangeReason
object
: The status change reason details for the instance group.- Code InstanceGroupStateChangeReasonCode
- Message String
InstanceGroupStateChangeReasonCode
- InstanceGroupStateChangeReasonCode
string
(values: INTERNAL_ERROR, VALIDATION_ERROR, INSTANCE_FAILURE, CLUSTER_TERMINATED)
InstanceGroupStatus
- InstanceGroupStatus
object
: The details of the instance group status.- State InstanceGroupState
- StateChangeReason InstanceGroupStateChangeReason
- Timeline InstanceGroupTimeline
InstanceGroupTimeline
- InstanceGroupTimeline
object
: The timeline of the instance group lifecycle.
InstanceGroupType
- InstanceGroupType
string
(values: MASTER, CORE, TASK)
InstanceGroupTypeList
- InstanceGroupTypeList
array
- items InstanceGroupType
InstanceId
- InstanceId
string
InstanceList
- InstanceList
array
- items Instance
InstanceResizePolicy
- InstanceResizePolicy
object
: Custom policy for requesting termination protection or termination of specific instances when shrinking an instance group.- InstanceTerminationTimeout Integer
- InstancesToProtect EC2InstanceIdsList
- InstancesToTerminate EC2InstanceIdsList
InstanceRoleType
- InstanceRoleType
string
(values: MASTER, CORE, TASK)
InstanceState
- InstanceState
string
(values: AWAITING_FULFILLMENT, PROVISIONING, BOOTSTRAPPING, RUNNING, TERMINATED)
InstanceStateChangeReason
- InstanceStateChangeReason
object
: The details of the status change reason for the instance.- Code InstanceStateChangeReasonCode
- Message String
InstanceStateChangeReasonCode
- InstanceStateChangeReasonCode
string
(values: INTERNAL_ERROR, VALIDATION_ERROR, INSTANCE_FAILURE, BOOTSTRAP_FAILURE, CLUSTER_TERMINATED)
InstanceStateList
- InstanceStateList
array
- items InstanceState
InstanceStatus
- InstanceStatus
object
: The instance status details.- State InstanceState
- StateChangeReason InstanceStateChangeReason
- Timeline InstanceTimeline
InstanceTimeline
- InstanceTimeline
object
: The timeline of the instance lifecycle.
InstanceType
- InstanceType
string
InstanceTypeConfig
- InstanceTypeConfig
object
: 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. There can be a maximum of 5 instance type configurations in a fleet. The instance fleet configuration is available only in Amazon EMR versions 4.8.0 and later, excluding 5.0.x versions.- BidPrice XmlStringMaxLen256
- BidPriceAsPercentageOfOnDemandPrice NonNegativeDouble
- Configurations ConfigurationList
- EbsConfiguration EbsConfiguration
- InstanceType required InstanceType
- WeightedCapacity WholeNumber
InstanceTypeConfigList
- InstanceTypeConfigList
array
- items InstanceTypeConfig
InstanceTypeSpecification
- InstanceTypeSpecification
object
: The configuration specification for each instance type in an instance fleet. The instance fleet configuration is available only in Amazon EMR versions 4.8.0 and later, excluding 5.0.x versions.- BidPrice XmlStringMaxLen256
- BidPriceAsPercentageOfOnDemandPrice NonNegativeDouble
- Configurations ConfigurationList
- EbsBlockDevices EbsBlockDeviceList
- EbsOptimized BooleanObject
- InstanceType InstanceType
- WeightedCapacity WholeNumber
InstanceTypeSpecificationList
- InstanceTypeSpecificationList
array
Integer
- Integer
integer
InternalServerError
- InternalServerError
object
: Indicates that an error occurred while processing the request and that the request was not completed.
InternalServerException
- InternalServerException
object
: This exception occurs when there is an internal failure in the EMR service.- Message ErrorMessage
InvalidRequestException
- InvalidRequestException
object
: This exception occurs when there is something wrong with user input.- ErrorCode ErrorCode
- Message ErrorMessage
JobFlowDetail
- JobFlowDetail
object
: A description of a cluster (job flow).- AmiVersion XmlStringMaxLen256
- AutoScalingRole XmlString
- BootstrapActions BootstrapActionDetailList
- ExecutionStatusDetail required JobFlowExecutionStatusDetail
- Instances required JobFlowInstancesDetail
- JobFlowId required XmlStringMaxLen256
- JobFlowRole XmlString
- LogUri XmlString
- Name required XmlStringMaxLen256
- ScaleDownBehavior ScaleDownBehavior
- ServiceRole XmlString
- Steps StepDetailList
- SupportedProducts SupportedProductsList
- VisibleToAllUsers Boolean
JobFlowDetailList
- JobFlowDetailList
array
- items JobFlowDetail
JobFlowExecutionState
- JobFlowExecutionState
string
(values: STARTING, BOOTSTRAPPING, RUNNING, WAITING, SHUTTING_DOWN, TERMINATED, COMPLETED, FAILED): The type of instance.
JobFlowExecutionStateList
- JobFlowExecutionStateList
array
- items JobFlowExecutionState
JobFlowExecutionStatusDetail
- JobFlowExecutionStatusDetail
object
: Describes the status of the cluster (job flow).
JobFlowInstancesConfig
- JobFlowInstancesConfig
object
: A description of the Amazon EC2 instance on which the cluster (job flow) runs. A valid JobFlowInstancesConfig must contain either InstanceGroups or InstanceFleets, which is the recommended configuration. 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.- AdditionalMasterSecurityGroups SecurityGroupsList
- AdditionalSlaveSecurityGroups SecurityGroupsList
- Ec2KeyName XmlStringMaxLen256
- Ec2SubnetId XmlStringMaxLen256
- Ec2SubnetIds XmlStringMaxLen256List
- EmrManagedMasterSecurityGroup XmlStringMaxLen256
- EmrManagedSlaveSecurityGroup XmlStringMaxLen256
- HadoopVersion XmlStringMaxLen256
- InstanceCount Integer
- InstanceFleets InstanceFleetConfigList
- InstanceGroups InstanceGroupConfigList
- KeepJobFlowAliveWhenNoSteps Boolean
- MasterInstanceType InstanceType
- Placement PlacementType
- ServiceAccessSecurityGroup XmlStringMaxLen256
- SlaveInstanceType InstanceType
- TerminationProtected Boolean
JobFlowInstancesDetail
- JobFlowInstancesDetail
object
: Specify the type of Amazon EC2 instances that the cluster (job flow) runs on.- Ec2KeyName XmlStringMaxLen256
- Ec2SubnetId XmlStringMaxLen256
- HadoopVersion XmlStringMaxLen256
- InstanceCount required Integer
- InstanceGroups InstanceGroupDetailList
- KeepJobFlowAliveWhenNoSteps Boolean
- MasterInstanceId XmlString
- MasterInstanceType required InstanceType
- MasterPublicDnsName XmlString
- NormalizedInstanceHours Integer
- Placement PlacementType
- SlaveInstanceType required InstanceType
- TerminationProtected Boolean
KerberosAttributes
- KerberosAttributes
object
: Attributes for Kerberos configuration when Kerberos authentication is enabled using a security configuration. For more information see Use Kerberos Authentication in the EMR Management Guide.- ADDomainJoinPassword XmlStringMaxLen256
- ADDomainJoinUser XmlStringMaxLen256
- CrossRealmTrustPrincipalPassword XmlStringMaxLen256
- KdcAdminPassword required XmlStringMaxLen256
- Realm required XmlStringMaxLen256
KeyValue
KeyValueList
- KeyValueList
array
- items KeyValue
ListBootstrapActionsInput
- ListBootstrapActionsInput
object
: This input determines which bootstrap actions to retrieve.
ListBootstrapActionsOutput
- ListBootstrapActionsOutput
object
: This output contains the bootstrap actions detail.- BootstrapActions CommandList
- Marker Marker
ListClustersInput
- ListClustersInput
object
: This input determines how the ListClusters action filters the list of clusters that it returns.- ClusterStates ClusterStateList
- CreatedAfter Date
- CreatedBefore Date
- Marker Marker
ListClustersOutput
- ListClustersOutput
object
: This contains a ClusterSummaryList with the cluster details; for example, the cluster IDs, names, and status.- Clusters ClusterSummaryList
- Marker Marker
ListInstanceFleetsInput
ListInstanceFleetsOutput
- ListInstanceFleetsOutput
object
- InstanceFleets InstanceFleetList
- Marker Marker
ListInstanceGroupsInput
- ListInstanceGroupsInput
object
: This input determines which instance groups to retrieve.
ListInstanceGroupsOutput
- ListInstanceGroupsOutput
object
: This input determines which instance groups to retrieve.- InstanceGroups InstanceGroupList
- Marker Marker
ListInstancesInput
- ListInstancesInput
object
: This input determines which instances to list.- ClusterId required ClusterId
- InstanceFleetId InstanceFleetId
- InstanceFleetType InstanceFleetType
- InstanceGroupId InstanceGroupId
- InstanceGroupTypes InstanceGroupTypeList
- InstanceStates InstanceStateList
- Marker Marker
ListInstancesOutput
- ListInstancesOutput
object
: This output contains the list of instances.- Instances InstanceList
- Marker Marker
ListSecurityConfigurationsInput
- ListSecurityConfigurationsInput
object
- Marker Marker
ListSecurityConfigurationsOutput
- ListSecurityConfigurationsOutput
object
- Marker Marker
- SecurityConfigurations SecurityConfigurationList
ListStepsInput
- ListStepsInput
object
: This input determines which steps to list.- ClusterId required ClusterId
- Marker Marker
- StepIds XmlStringList
- StepStates StepStateList
ListStepsOutput
- ListStepsOutput
object
: This output contains the list of steps returned in reverse order. This means that the last step is the first element in the list.- Marker Marker
- Steps StepSummaryList
Marker
- Marker
string
MarketType
- MarketType
string
(values: ON_DEMAND, SPOT)
MetricDimension
- MetricDimension
object
: 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.
MetricDimensionList
- MetricDimensionList
array
- items MetricDimension
ModifyInstanceFleetInput
- ModifyInstanceFleetInput
object
- ClusterId required ClusterId
- InstanceFleet required InstanceFleetModifyConfig
ModifyInstanceGroupsInput
- ModifyInstanceGroupsInput
object
: Change the size of some instance groups.- ClusterId ClusterId
- InstanceGroups InstanceGroupModifyConfigList
NewSupportedProductsList
- NewSupportedProductsList
array
- items SupportedProductConfig
NonNegativeDouble
- NonNegativeDouble
number
PlacementType
- PlacementType
object
: The Amazon EC2 Availability Zone configuration of the cluster (job flow).- AvailabilityZone XmlString
- AvailabilityZones XmlStringMaxLen256List
PutAutoScalingPolicyInput
- PutAutoScalingPolicyInput
object
- AutoScalingPolicy required AutoScalingPolicy
- ClusterId required ClusterId
- InstanceGroupId required InstanceGroupId
PutAutoScalingPolicyOutput
- PutAutoScalingPolicyOutput
object
- AutoScalingPolicy AutoScalingPolicyDescription
- ClusterId ClusterId
- InstanceGroupId InstanceGroupId
RemoveAutoScalingPolicyInput
- RemoveAutoScalingPolicyInput
object
- ClusterId required ClusterId
- InstanceGroupId required InstanceGroupId
RemoveAutoScalingPolicyOutput
- RemoveAutoScalingPolicyOutput
object
RemoveTagsInput
- RemoveTagsInput
object
: This input identifies a cluster and a list of tags to remove.- ResourceId required ResourceId
- TagKeys required StringList
RemoveTagsOutput
- RemoveTagsOutput
object
: This output indicates the result of removing tags from a resource.
RepoUpgradeOnBoot
- RepoUpgradeOnBoot
string
(values: SECURITY, NONE)
ResourceId
- ResourceId
string
RunJobFlowInput
- RunJobFlowInput
object
: Input to the RunJobFlow operation.- AdditionalInfo XmlString
- AmiVersion XmlStringMaxLen256
- Applications ApplicationList
- AutoScalingRole XmlString
- BootstrapActions BootstrapActionConfigList
- Configurations ConfigurationList
- CustomAmiId XmlStringMaxLen256
- EbsRootVolumeSize Integer
- Instances required JobFlowInstancesConfig
- JobFlowRole XmlString
- KerberosAttributes KerberosAttributes
- LogUri XmlString
- Name required XmlStringMaxLen256
- NewSupportedProducts NewSupportedProductsList
- ReleaseLabel XmlStringMaxLen256
- RepoUpgradeOnBoot RepoUpgradeOnBoot
- ScaleDownBehavior ScaleDownBehavior
- SecurityConfiguration XmlString
- ServiceRole XmlString
- Steps StepConfigList
- SupportedProducts SupportedProductsList
- Tags TagList
- VisibleToAllUsers Boolean
RunJobFlowOutput
- RunJobFlowOutput
object
: The result of the RunJobFlow operation.- JobFlowId XmlStringMaxLen256
ScaleDownBehavior
- ScaleDownBehavior
string
(values: TERMINATE_AT_INSTANCE_HOUR, TERMINATE_AT_TASK_COMPLETION)
ScalingAction
- ScalingAction
object
: The type of adjustment the automatic scaling activity makes when triggered, and the periodicity of the adjustment.- Market MarketType
- SimpleScalingPolicyConfiguration required SimpleScalingPolicyConfiguration
ScalingConstraints
- ScalingConstraints
object
: 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
- ScalingRule
object
: 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.- Action required ScalingAction
- Description String
- Name required String
- Trigger required ScalingTrigger
ScalingRuleList
- ScalingRuleList
array
- items ScalingRule
ScalingTrigger
- ScalingTrigger
object
: The conditions that trigger an automatic scaling activity.- CloudWatchAlarmDefinition required CloudWatchAlarmDefinition
ScriptBootstrapActionConfig
- ScriptBootstrapActionConfig
object
: Configuration of the script to run during a bootstrap action.- Args XmlStringList
- Path required XmlString
SecurityConfigurationList
- SecurityConfigurationList
array
SecurityConfigurationSummary
- SecurityConfigurationSummary
object
: The creation date and time, and name, of a security configuration.
SecurityGroupsList
- SecurityGroupsList
array
- items XmlStringMaxLen256
SetTerminationProtectionInput
- SetTerminationProtectionInput
object
: The input argument to the TerminationProtection operation.- JobFlowIds required XmlStringList
- TerminationProtected required Boolean
SetVisibleToAllUsersInput
- SetVisibleToAllUsersInput
object
: The input to the SetVisibleToAllUsers action.- JobFlowIds required XmlStringList
- VisibleToAllUsers required Boolean
ShrinkPolicy
- ShrinkPolicy
object
: Policy for customizing shrink operations. Allows configuration of decommissioning timeout and targeted instance shrinking.- DecommissionTimeout Integer
- InstanceResizePolicy InstanceResizePolicy
SimpleScalingPolicyConfiguration
- SimpleScalingPolicyConfiguration
object
: 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.- AdjustmentType AdjustmentType
- CoolDown Integer
- ScalingAdjustment required Integer
SpotProvisioningSpecification
- SpotProvisioningSpecification
object
: The launch specification for Spot instances in the instance fleet, which determines the defined duration and provisioning timeout behavior. The instance fleet configuration is available only in Amazon EMR versions 4.8.0 and later, excluding 5.0.x versions.- BlockDurationMinutes WholeNumber
- TimeoutAction required SpotProvisioningTimeoutAction
- TimeoutDurationMinutes required WholeNumber
SpotProvisioningTimeoutAction
- SpotProvisioningTimeoutAction
string
(values: SWITCH_TO_ON_DEMAND, TERMINATE_CLUSTER)
Statistic
- Statistic
string
(values: SAMPLE_COUNT, AVERAGE, SUM, MINIMUM, MAXIMUM)
Step
- Step
object
: This represents a step in a cluster.- ActionOnFailure ActionOnFailure
- Config HadoopStepConfig
- Id StepId
- Name String
- Status StepStatus
StepConfig
- StepConfig
object
: Specification of a cluster (job flow) step.- ActionOnFailure ActionOnFailure
- HadoopJarStep required HadoopJarStepConfig
- Name required XmlStringMaxLen256
StepConfigList
- StepConfigList
array
- items StepConfig
StepDetail
- StepDetail
object
: Combines the execution state and configuration of a step.- ExecutionStatusDetail required StepExecutionStatusDetail
- StepConfig required StepConfig
StepDetailList
- StepDetailList
array
- items StepDetail
StepExecutionState
- StepExecutionState
string
(values: PENDING, RUNNING, CONTINUE, COMPLETED, CANCELLED, FAILED, INTERRUPTED)
StepExecutionStatusDetail
- StepExecutionStatusDetail
object
: The execution state of a step.- CreationDateTime required Date
- EndDateTime Date
- LastStateChangeReason XmlString
- StartDateTime Date
- State required StepExecutionState
StepId
- StepId
string
StepIdsList
- StepIdsList
array
- items XmlStringMaxLen256
StepState
- StepState
string
(values: PENDING, CANCEL_PENDING, RUNNING, COMPLETED, CANCELLED, FAILED, INTERRUPTED)
StepStateChangeReason
- StepStateChangeReason
object
: The details of the step state change reason.- Code StepStateChangeReasonCode
- Message String
StepStateChangeReasonCode
- StepStateChangeReasonCode
string
(values: NONE)
StepStateList
- StepStateList
array
- items StepState
StepStatus
- StepStatus
object
: The execution status details of the cluster step.- FailureDetails FailureDetails
- State StepState
- StateChangeReason StepStateChangeReason
- Timeline StepTimeline
StepSummary
- StepSummary
object
: The summary of the cluster step.- ActionOnFailure ActionOnFailure
- Config HadoopStepConfig
- Id StepId
- Name String
- Status StepStatus
StepSummaryList
- StepSummaryList
array
- items StepSummary
StepTimeline
- StepTimeline
object
: The timeline of the cluster step lifecycle.
String
- String
string
StringList
- StringList
array
- items String
StringMap
SupportedProductConfig
- SupportedProductConfig
object
: The list of supported product configurations which allow user-supplied arguments. EMR accepts these arguments and forwards them to the corresponding installation script as bootstrap action arguments.- Args XmlStringList
- Name XmlStringMaxLen256
SupportedProductsList
- SupportedProductsList
array
- items XmlStringMaxLen256
Tag
- Tag
object
: 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.
TagList
- TagList
array
- items Tag
TerminateJobFlowsInput
- TerminateJobFlowsInput
object
: Input to the TerminateJobFlows operation.- JobFlowIds required XmlStringList
Unit
- Unit
string
(values: NONE, SECONDS, MICRO_SECONDS, MILLI_SECONDS, BYTES, KILO_BYTES, MEGA_BYTES, GIGA_BYTES, TERA_BYTES, BITS, KILO_BITS, MEGA_BITS, GIGA_BITS, TERA_BITS, PERCENT, COUNT, BYTES_PER_SECOND, KILO_BYTES_PER_SECOND, MEGA_BYTES_PER_SECOND, GIGA_BYTES_PER_SECOND, TERA_BYTES_PER_SECOND, BITS_PER_SECOND, KILO_BITS_PER_SECOND, MEGA_BITS_PER_SECOND, GIGA_BITS_PER_SECOND, TERA_BITS_PER_SECOND, COUNT_PER_SECOND)
VolumeSpecification
- VolumeSpecification
object
: 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.
WholeNumber
- WholeNumber
integer
XmlString
- XmlString
string
XmlStringList
- XmlStringList
array
- items XmlString
XmlStringMaxLen256
- XmlStringMaxLen256
string
XmlStringMaxLen256List
- XmlStringMaxLen256List
array
- items XmlStringMaxLen256