UNPKG

133 kBTypeScriptView Raw
1import {Request} from '../lib/request';
2import {Response} from '../lib/response';
3import {AWSError} from '../lib/error';
4import {Service} from '../lib/service';
5import {WaiterConfiguration} from '../lib/service';
6import {ServiceConfigurationOptions} from '../lib/service';
7import {ConfigBase as Config} from '../lib/config';
8interface Blob {}
9declare class EMR extends Service {
10 /**
11 * Constructs a service object. This object has one method for each API operation.
12 */
13 constructor(options?: EMR.Types.ClientConfiguration)
14 config: Config & EMR.Types.ClientConfiguration;
15 /**
16 * Adds an instance fleet to a running cluster. The instance fleet configuration is available only in Amazon EMR versions 4.8.0 and later, excluding 5.0.x.
17 */
18 addInstanceFleet(params: EMR.Types.AddInstanceFleetInput, callback?: (err: AWSError, data: EMR.Types.AddInstanceFleetOutput) => void): Request<EMR.Types.AddInstanceFleetOutput, AWSError>;
19 /**
20 * Adds an instance fleet to a running cluster. The instance fleet configuration is available only in Amazon EMR versions 4.8.0 and later, excluding 5.0.x.
21 */
22 addInstanceFleet(callback?: (err: AWSError, data: EMR.Types.AddInstanceFleetOutput) => void): Request<EMR.Types.AddInstanceFleetOutput, AWSError>;
23 /**
24 * Adds one or more instance groups to a running cluster.
25 */
26 addInstanceGroups(params: EMR.Types.AddInstanceGroupsInput, callback?: (err: AWSError, data: EMR.Types.AddInstanceGroupsOutput) => void): Request<EMR.Types.AddInstanceGroupsOutput, AWSError>;
27 /**
28 * Adds one or more instance groups to a running cluster.
29 */
30 addInstanceGroups(callback?: (err: AWSError, data: EMR.Types.AddInstanceGroupsOutput) => void): Request<EMR.Types.AddInstanceGroupsOutput, AWSError>;
31 /**
32 * 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 Add More than 256 Steps to a Cluster in the Amazon EMR Management Guide. 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 WAITING.
33 */
34 addJobFlowSteps(params: EMR.Types.AddJobFlowStepsInput, callback?: (err: AWSError, data: EMR.Types.AddJobFlowStepsOutput) => void): Request<EMR.Types.AddJobFlowStepsOutput, AWSError>;
35 /**
36 * 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 Add More than 256 Steps to a Cluster in the Amazon EMR Management Guide. 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 WAITING.
37 */
38 addJobFlowSteps(callback?: (err: AWSError, data: EMR.Types.AddJobFlowStepsOutput) => void): Request<EMR.Types.AddJobFlowStepsOutput, AWSError>;
39 /**
40 * 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.
41 */
42 addTags(params: EMR.Types.AddTagsInput, callback?: (err: AWSError, data: EMR.Types.AddTagsOutput) => void): Request<EMR.Types.AddTagsOutput, AWSError>;
43 /**
44 * 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.
45 */
46 addTags(callback?: (err: AWSError, data: EMR.Types.AddTagsOutput) => void): Request<EMR.Types.AddTagsOutput, AWSError>;
47 /**
48 * 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 PENDING state.
49 */
50 cancelSteps(params: EMR.Types.CancelStepsInput, callback?: (err: AWSError, data: EMR.Types.CancelStepsOutput) => void): Request<EMR.Types.CancelStepsOutput, AWSError>;
51 /**
52 * 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 PENDING state.
53 */
54 cancelSteps(callback?: (err: AWSError, data: EMR.Types.CancelStepsOutput) => void): Request<EMR.Types.CancelStepsOutput, AWSError>;
55 /**
56 * Creates a security configuration, which is stored in the service and can be specified when a cluster is created.
57 */
58 createSecurityConfiguration(params: EMR.Types.CreateSecurityConfigurationInput, callback?: (err: AWSError, data: EMR.Types.CreateSecurityConfigurationOutput) => void): Request<EMR.Types.CreateSecurityConfigurationOutput, AWSError>;
59 /**
60 * Creates a security configuration, which is stored in the service and can be specified when a cluster is created.
61 */
62 createSecurityConfiguration(callback?: (err: AWSError, data: EMR.Types.CreateSecurityConfigurationOutput) => void): Request<EMR.Types.CreateSecurityConfigurationOutput, AWSError>;
63 /**
64 * Deletes a security configuration.
65 */
66 deleteSecurityConfiguration(params: EMR.Types.DeleteSecurityConfigurationInput, callback?: (err: AWSError, data: EMR.Types.DeleteSecurityConfigurationOutput) => void): Request<EMR.Types.DeleteSecurityConfigurationOutput, AWSError>;
67 /**
68 * Deletes a security configuration.
69 */
70 deleteSecurityConfiguration(callback?: (err: AWSError, data: EMR.Types.DeleteSecurityConfigurationOutput) => void): Request<EMR.Types.DeleteSecurityConfigurationOutput, AWSError>;
71 /**
72 * Provides cluster-level details including status, hardware and software configuration, VPC settings, and so on.
73 */
74 describeCluster(params: EMR.Types.DescribeClusterInput, callback?: (err: AWSError, data: EMR.Types.DescribeClusterOutput) => void): Request<EMR.Types.DescribeClusterOutput, AWSError>;
75 /**
76 * Provides cluster-level details including status, hardware and software configuration, VPC settings, and so on.
77 */
78 describeCluster(callback?: (err: AWSError, data: EMR.Types.DescribeClusterOutput) => void): Request<EMR.Types.DescribeClusterOutput, AWSError>;
79 /**
80 * This API is deprecated and will eventually be removed. We recommend you use ListClusters, DescribeCluster, ListSteps, ListInstanceGroups and ListBootstrapActions instead. DescribeJobFlows returns a list of job flows that match all of the supplied parameters. The parameters can include a list of job flow IDs, job flow states, and restrictions on job flow creation date and time. Regardless of supplied parameters, only job flows created within the last two months are returned. If no parameters are supplied, then job flows matching either of the following criteria are returned: Job flows created and completed in the last two weeks Job flows created within the last two months that are in one of the following states: RUNNING, WAITING, SHUTTING_DOWN, STARTING Amazon EMR can return a maximum of 512 job flow descriptions.
81 */
82 describeJobFlows(params: EMR.Types.DescribeJobFlowsInput, callback?: (err: AWSError, data: EMR.Types.DescribeJobFlowsOutput) => void): Request<EMR.Types.DescribeJobFlowsOutput, AWSError>;
83 /**
84 * This API is deprecated and will eventually be removed. We recommend you use ListClusters, DescribeCluster, ListSteps, ListInstanceGroups and ListBootstrapActions instead. DescribeJobFlows returns a list of job flows that match all of the supplied parameters. The parameters can include a list of job flow IDs, job flow states, and restrictions on job flow creation date and time. Regardless of supplied parameters, only job flows created within the last two months are returned. If no parameters are supplied, then job flows matching either of the following criteria are returned: Job flows created and completed in the last two weeks Job flows created within the last two months that are in one of the following states: RUNNING, WAITING, SHUTTING_DOWN, STARTING Amazon EMR can return a maximum of 512 job flow descriptions.
85 */
86 describeJobFlows(callback?: (err: AWSError, data: EMR.Types.DescribeJobFlowsOutput) => void): Request<EMR.Types.DescribeJobFlowsOutput, AWSError>;
87 /**
88 * Provides the details of a security configuration by returning the configuration JSON.
89 */
90 describeSecurityConfiguration(params: EMR.Types.DescribeSecurityConfigurationInput, callback?: (err: AWSError, data: EMR.Types.DescribeSecurityConfigurationOutput) => void): Request<EMR.Types.DescribeSecurityConfigurationOutput, AWSError>;
91 /**
92 * Provides the details of a security configuration by returning the configuration JSON.
93 */
94 describeSecurityConfiguration(callback?: (err: AWSError, data: EMR.Types.DescribeSecurityConfigurationOutput) => void): Request<EMR.Types.DescribeSecurityConfigurationOutput, AWSError>;
95 /**
96 * Provides more detail about the cluster step.
97 */
98 describeStep(params: EMR.Types.DescribeStepInput, callback?: (err: AWSError, data: EMR.Types.DescribeStepOutput) => void): Request<EMR.Types.DescribeStepOutput, AWSError>;
99 /**
100 * Provides more detail about the cluster step.
101 */
102 describeStep(callback?: (err: AWSError, data: EMR.Types.DescribeStepOutput) => void): Request<EMR.Types.DescribeStepOutput, AWSError>;
103 /**
104 * 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.
105 */
106 getBlockPublicAccessConfiguration(params: EMR.Types.GetBlockPublicAccessConfigurationInput, callback?: (err: AWSError, data: EMR.Types.GetBlockPublicAccessConfigurationOutput) => void): Request<EMR.Types.GetBlockPublicAccessConfigurationOutput, AWSError>;
107 /**
108 * 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.
109 */
110 getBlockPublicAccessConfiguration(callback?: (err: AWSError, data: EMR.Types.GetBlockPublicAccessConfigurationOutput) => void): Request<EMR.Types.GetBlockPublicAccessConfigurationOutput, AWSError>;
111 /**
112 * Provides information about the bootstrap actions associated with a cluster.
113 */
114 listBootstrapActions(params: EMR.Types.ListBootstrapActionsInput, callback?: (err: AWSError, data: EMR.Types.ListBootstrapActionsOutput) => void): Request<EMR.Types.ListBootstrapActionsOutput, AWSError>;
115 /**
116 * Provides information about the bootstrap actions associated with a cluster.
117 */
118 listBootstrapActions(callback?: (err: AWSError, data: EMR.Types.ListBootstrapActionsOutput) => void): Request<EMR.Types.ListBootstrapActionsOutput, AWSError>;
119 /**
120 * 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.
121 */
122 listClusters(params: EMR.Types.ListClustersInput, callback?: (err: AWSError, data: EMR.Types.ListClustersOutput) => void): Request<EMR.Types.ListClustersOutput, AWSError>;
123 /**
124 * 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.
125 */
126 listClusters(callback?: (err: AWSError, data: EMR.Types.ListClustersOutput) => void): Request<EMR.Types.ListClustersOutput, AWSError>;
127 /**
128 * Lists all available details about the instance fleets in a cluster. The instance fleet configuration is available only in Amazon EMR versions 4.8.0 and later, excluding 5.0.x versions.
129 */
130 listInstanceFleets(params: EMR.Types.ListInstanceFleetsInput, callback?: (err: AWSError, data: EMR.Types.ListInstanceFleetsOutput) => void): Request<EMR.Types.ListInstanceFleetsOutput, AWSError>;
131 /**
132 * Lists all available details about the instance fleets in a cluster. The instance fleet configuration is available only in Amazon EMR versions 4.8.0 and later, excluding 5.0.x versions.
133 */
134 listInstanceFleets(callback?: (err: AWSError, data: EMR.Types.ListInstanceFleetsOutput) => void): Request<EMR.Types.ListInstanceFleetsOutput, AWSError>;
135 /**
136 * Provides all available details about the instance groups in a cluster.
137 */
138 listInstanceGroups(params: EMR.Types.ListInstanceGroupsInput, callback?: (err: AWSError, data: EMR.Types.ListInstanceGroupsOutput) => void): Request<EMR.Types.ListInstanceGroupsOutput, AWSError>;
139 /**
140 * Provides all available details about the instance groups in a cluster.
141 */
142 listInstanceGroups(callback?: (err: AWSError, data: EMR.Types.ListInstanceGroupsOutput) => void): Request<EMR.Types.ListInstanceGroupsOutput, AWSError>;
143 /**
144 * 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.
145 */
146 listInstances(params: EMR.Types.ListInstancesInput, callback?: (err: AWSError, data: EMR.Types.ListInstancesOutput) => void): Request<EMR.Types.ListInstancesOutput, AWSError>;
147 /**
148 * 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.
149 */
150 listInstances(callback?: (err: AWSError, data: EMR.Types.ListInstancesOutput) => void): Request<EMR.Types.ListInstancesOutput, AWSError>;
151 /**
152 * 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.
153 */
154 listSecurityConfigurations(params: EMR.Types.ListSecurityConfigurationsInput, callback?: (err: AWSError, data: EMR.Types.ListSecurityConfigurationsOutput) => void): Request<EMR.Types.ListSecurityConfigurationsOutput, AWSError>;
155 /**
156 * 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.
157 */
158 listSecurityConfigurations(callback?: (err: AWSError, data: EMR.Types.ListSecurityConfigurationsOutput) => void): Request<EMR.Types.ListSecurityConfigurationsOutput, AWSError>;
159 /**
160 * 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.
161 */
162 listSteps(params: EMR.Types.ListStepsInput, callback?: (err: AWSError, data: EMR.Types.ListStepsOutput) => void): Request<EMR.Types.ListStepsOutput, AWSError>;
163 /**
164 * 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.
165 */
166 listSteps(callback?: (err: AWSError, data: EMR.Types.ListStepsOutput) => void): Request<EMR.Types.ListStepsOutput, AWSError>;
167 /**
168 * Modifies the number of steps that can be executed concurrently for the cluster specified using ClusterID.
169 */
170 modifyCluster(params: EMR.Types.ModifyClusterInput, callback?: (err: AWSError, data: EMR.Types.ModifyClusterOutput) => void): Request<EMR.Types.ModifyClusterOutput, AWSError>;
171 /**
172 * Modifies the number of steps that can be executed concurrently for the cluster specified using ClusterID.
173 */
174 modifyCluster(callback?: (err: AWSError, data: EMR.Types.ModifyClusterOutput) => void): Request<EMR.Types.ModifyClusterOutput, AWSError>;
175 /**
176 * 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. The instance fleet configuration is available only in Amazon EMR versions 4.8.0 and later, excluding 5.0.x versions.
177 */
178 modifyInstanceFleet(params: EMR.Types.ModifyInstanceFleetInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
179 /**
180 * 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. The instance fleet configuration is available only in Amazon EMR versions 4.8.0 and later, excluding 5.0.x versions.
181 */
182 modifyInstanceFleet(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
183 /**
184 * 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.
185 */
186 modifyInstanceGroups(params: EMR.Types.ModifyInstanceGroupsInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
187 /**
188 * 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.
189 */
190 modifyInstanceGroups(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
191 /**
192 * 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.
193 */
194 putAutoScalingPolicy(params: EMR.Types.PutAutoScalingPolicyInput, callback?: (err: AWSError, data: EMR.Types.PutAutoScalingPolicyOutput) => void): Request<EMR.Types.PutAutoScalingPolicyOutput, AWSError>;
195 /**
196 * 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.
197 */
198 putAutoScalingPolicy(callback?: (err: AWSError, data: EMR.Types.PutAutoScalingPolicyOutput) => void): Request<EMR.Types.PutAutoScalingPolicyOutput, AWSError>;
199 /**
200 * 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.
201 */
202 putBlockPublicAccessConfiguration(params: EMR.Types.PutBlockPublicAccessConfigurationInput, callback?: (err: AWSError, data: EMR.Types.PutBlockPublicAccessConfigurationOutput) => void): Request<EMR.Types.PutBlockPublicAccessConfigurationOutput, AWSError>;
203 /**
204 * 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.
205 */
206 putBlockPublicAccessConfiguration(callback?: (err: AWSError, data: EMR.Types.PutBlockPublicAccessConfigurationOutput) => void): Request<EMR.Types.PutBlockPublicAccessConfigurationOutput, AWSError>;
207 /**
208 * Removes an automatic scaling policy from a specified instance group within an EMR cluster.
209 */
210 removeAutoScalingPolicy(params: EMR.Types.RemoveAutoScalingPolicyInput, callback?: (err: AWSError, data: EMR.Types.RemoveAutoScalingPolicyOutput) => void): Request<EMR.Types.RemoveAutoScalingPolicyOutput, AWSError>;
211 /**
212 * Removes an automatic scaling policy from a specified instance group within an EMR cluster.
213 */
214 removeAutoScalingPolicy(callback?: (err: AWSError, data: EMR.Types.RemoveAutoScalingPolicyOutput) => void): Request<EMR.Types.RemoveAutoScalingPolicyOutput, AWSError>;
215 /**
216 * 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. The following example removes the stack tag with value Prod from a cluster:
217 */
218 removeTags(params: EMR.Types.RemoveTagsInput, callback?: (err: AWSError, data: EMR.Types.RemoveTagsOutput) => void): Request<EMR.Types.RemoveTagsOutput, AWSError>;
219 /**
220 * 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. The following example removes the stack tag with value Prod from a cluster:
221 */
222 removeTags(callback?: (err: AWSError, data: EMR.Types.RemoveTagsOutput) => void): Request<EMR.Types.RemoveTagsOutput, AWSError>;
223 /**
224 * 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. For additional protection, you can set the JobFlowInstancesConfig TerminationProtected parameter to TRUE 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 Add More than 256 Steps to a Cluster in the Amazon EMR Management Guide. For long running clusters, we recommend that you periodically store your results. 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 both.
225 */
226 runJobFlow(params: EMR.Types.RunJobFlowInput, callback?: (err: AWSError, data: EMR.Types.RunJobFlowOutput) => void): Request<EMR.Types.RunJobFlowOutput, AWSError>;
227 /**
228 * 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. For additional protection, you can set the JobFlowInstancesConfig TerminationProtected parameter to TRUE 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 Add More than 256 Steps to a Cluster in the Amazon EMR Management Guide. For long running clusters, we recommend that you periodically store your results. 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 both.
229 */
230 runJobFlow(callback?: (err: AWSError, data: EMR.Types.RunJobFlowOutput) => void): Request<EMR.Types.RunJobFlowOutput, AWSError>;
231 /**
232 * 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. SetTerminationProtection 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 SetTerminationProtection to true, you must first unlock the job flow by a subsequent call to SetTerminationProtection in which you set the value to false. For more information, seeManaging Cluster Termination in the Amazon EMR Management Guide.
233 */
234 setTerminationProtection(params: EMR.Types.SetTerminationProtectionInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
235 /**
236 * 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. SetTerminationProtection 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 SetTerminationProtection to true, you must first unlock the job flow by a subsequent call to SetTerminationProtection in which you set the value to false. For more information, seeManaging Cluster Termination in the Amazon EMR Management Guide.
237 */
238 setTerminationProtection(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
239 /**
240 * 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.
241 */
242 setVisibleToAllUsers(params: EMR.Types.SetVisibleToAllUsersInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
243 /**
244 * 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.
245 */
246 setVisibleToAllUsers(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
247 /**
248 * 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 TerminateJobFlows 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 instances.
249 */
250 terminateJobFlows(params: EMR.Types.TerminateJobFlowsInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
251 /**
252 * 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 TerminateJobFlows 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 instances.
253 */
254 terminateJobFlows(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
255 /**
256 * Waits for the clusterRunning state by periodically calling the underlying EMR.describeClusteroperation every 30 seconds (at most 60 times).
257 */
258 waitFor(state: "clusterRunning", params: EMR.Types.DescribeClusterInput & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: EMR.Types.DescribeClusterOutput) => void): Request<EMR.Types.DescribeClusterOutput, AWSError>;
259 /**
260 * Waits for the clusterRunning state by periodically calling the underlying EMR.describeClusteroperation every 30 seconds (at most 60 times).
261 */
262 waitFor(state: "clusterRunning", callback?: (err: AWSError, data: EMR.Types.DescribeClusterOutput) => void): Request<EMR.Types.DescribeClusterOutput, AWSError>;
263 /**
264 * Waits for the stepComplete state by periodically calling the underlying EMR.describeStepoperation every 30 seconds (at most 60 times).
265 */
266 waitFor(state: "stepComplete", params: EMR.Types.DescribeStepInput & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: EMR.Types.DescribeStepOutput) => void): Request<EMR.Types.DescribeStepOutput, AWSError>;
267 /**
268 * Waits for the stepComplete state by periodically calling the underlying EMR.describeStepoperation every 30 seconds (at most 60 times).
269 */
270 waitFor(state: "stepComplete", callback?: (err: AWSError, data: EMR.Types.DescribeStepOutput) => void): Request<EMR.Types.DescribeStepOutput, AWSError>;
271 /**
272 * Waits for the clusterTerminated state by periodically calling the underlying EMR.describeClusteroperation every 30 seconds (at most 60 times).
273 */
274 waitFor(state: "clusterTerminated", params: EMR.Types.DescribeClusterInput & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: EMR.Types.DescribeClusterOutput) => void): Request<EMR.Types.DescribeClusterOutput, AWSError>;
275 /**
276 * Waits for the clusterTerminated state by periodically calling the underlying EMR.describeClusteroperation every 30 seconds (at most 60 times).
277 */
278 waitFor(state: "clusterTerminated", callback?: (err: AWSError, data: EMR.Types.DescribeClusterOutput) => void): Request<EMR.Types.DescribeClusterOutput, AWSError>;
279}
280declare namespace EMR {
281 export type ActionOnFailure = "TERMINATE_JOB_FLOW"|"TERMINATE_CLUSTER"|"CANCEL_AND_WAIT"|"CONTINUE"|string;
282 export interface AddInstanceFleetInput {
283 /**
284 * The unique identifier of the cluster.
285 */
286 ClusterId: XmlStringMaxLen256;
287 /**
288 * Specifies the configuration of the instance fleet.
289 */
290 InstanceFleet: InstanceFleetConfig;
291 }
292 export interface AddInstanceFleetOutput {
293 /**
294 * The unique identifier of the cluster.
295 */
296 ClusterId?: XmlStringMaxLen256;
297 /**
298 * The unique identifier of the instance fleet.
299 */
300 InstanceFleetId?: InstanceFleetId;
301 /**
302 * The Amazon Resource Name of the cluster.
303 */
304 ClusterArn?: ArnType;
305 }
306 export interface AddInstanceGroupsInput {
307 /**
308 * Instance groups to add.
309 */
310 InstanceGroups: InstanceGroupConfigList;
311 /**
312 * Job flow in which to add the instance groups.
313 */
314 JobFlowId: XmlStringMaxLen256;
315 }
316 export interface AddInstanceGroupsOutput {
317 /**
318 * The job flow ID in which the instance groups are added.
319 */
320 JobFlowId?: XmlStringMaxLen256;
321 /**
322 * Instance group IDs of the newly created instance groups.
323 */
324 InstanceGroupIds?: InstanceGroupIdsList;
325 /**
326 * The Amazon Resource Name of the cluster.
327 */
328 ClusterArn?: ArnType;
329 }
330 export interface AddJobFlowStepsInput {
331 /**
332 * A string that uniquely identifies the job flow. This identifier is returned by RunJobFlow and can also be obtained from ListClusters.
333 */
334 JobFlowId: XmlStringMaxLen256;
335 /**
336 * A list of StepConfig to be executed by the job flow.
337 */
338 Steps: StepConfigList;
339 }
340 export interface AddJobFlowStepsOutput {
341 /**
342 * The identifiers of the list of steps added to the job flow.
343 */
344 StepIds?: StepIdsList;
345 }
346 export interface AddTagsInput {
347 /**
348 * The Amazon EMR resource identifier to which tags will be added. This value must be a cluster identifier.
349 */
350 ResourceId: ResourceId;
351 /**
352 * A list of tags to associate with a cluster and propagate to EC2 instances. Tags are user-defined key/value pairs that consist of a required key string with a maximum of 128 characters, and an optional value string with a maximum of 256 characters.
353 */
354 Tags: TagList;
355 }
356 export interface AddTagsOutput {
357 }
358 export type AdjustmentType = "CHANGE_IN_CAPACITY"|"PERCENT_CHANGE_IN_CAPACITY"|"EXACT_CAPACITY"|string;
359 export interface Application {
360 /**
361 * The name of the application.
362 */
363 Name?: String;
364 /**
365 * The version of the application.
366 */
367 Version?: String;
368 /**
369 * Arguments for Amazon EMR to pass to the application.
370 */
371 Args?: StringList;
372 /**
373 * This option is for advanced users only. This is meta information about third-party applications that third-party vendors use for testing purposes.
374 */
375 AdditionalInfo?: StringMap;
376 }
377 export type ApplicationList = Application[];
378 export type ArnType = string;
379 export interface AutoScalingPolicy {
380 /**
381 * The upper and lower EC2 instance limits for an automatic scaling policy. Automatic scaling activity will not cause an instance group to grow above or below these limits.
382 */
383 Constraints: ScalingConstraints;
384 /**
385 * The scale-in and scale-out rules that comprise the automatic scaling policy.
386 */
387 Rules: ScalingRuleList;
388 }
389 export interface AutoScalingPolicyDescription {
390 /**
391 * The status of an automatic scaling policy.
392 */
393 Status?: AutoScalingPolicyStatus;
394 /**
395 * The upper and lower EC2 instance limits for an automatic scaling policy. Automatic scaling activity will not cause an instance group to grow above or below these limits.
396 */
397 Constraints?: ScalingConstraints;
398 /**
399 * The scale-in and scale-out rules that comprise the automatic scaling policy.
400 */
401 Rules?: ScalingRuleList;
402 }
403 export type AutoScalingPolicyState = "PENDING"|"ATTACHING"|"ATTACHED"|"DETACHING"|"DETACHED"|"FAILED"|string;
404 export interface AutoScalingPolicyStateChangeReason {
405 /**
406 * The code indicating the reason for the change in status.USER_REQUEST indicates that the scaling policy status was changed by a user. PROVISION_FAILURE indicates that the status change was because the policy failed to provision. CLEANUP_FAILURE indicates an error.
407 */
408 Code?: AutoScalingPolicyStateChangeReasonCode;
409 /**
410 * A friendly, more verbose message that accompanies an automatic scaling policy state change.
411 */
412 Message?: String;
413 }
414 export type AutoScalingPolicyStateChangeReasonCode = "USER_REQUEST"|"PROVISION_FAILURE"|"CLEANUP_FAILURE"|string;
415 export interface AutoScalingPolicyStatus {
416 /**
417 * Indicates the status of the automatic scaling policy.
418 */
419 State?: AutoScalingPolicyState;
420 /**
421 * The reason for a change in status.
422 */
423 StateChangeReason?: AutoScalingPolicyStateChangeReason;
424 }
425 export interface BlockPublicAccessConfiguration {
426 /**
427 * Indicates whether EMR block public access is enabled (true) or disabled (false). By default, the value is false for accounts that have created EMR clusters before July 2019. For accounts created after this, the default is true.
428 */
429 BlockPublicSecurityGroupRules: Boolean;
430 /**
431 * Specifies ports and port ranges that are permitted to have security group rules that allow inbound traffic from all public sources. For example, if Port 23 (Telnet) is specified for PermittedPublicSecurityGroupRuleRanges, Amazon EMR allows cluster creation if a security group associated with the cluster has a rule that allows inbound traffic on Port 23 from IPv4 0.0.0.0/0 or IPv6 port ::/0 as the source. By default, Port 22, which is used for SSH access to the cluster EC2 instances, is in the list of PermittedPublicSecurityGroupRuleRanges.
432 */
433 PermittedPublicSecurityGroupRuleRanges?: PortRanges;
434 }
435 export interface BlockPublicAccessConfigurationMetadata {
436 /**
437 * The date and time that the configuration was created.
438 */
439 CreationDateTime: _Date;
440 /**
441 * The Amazon Resource Name that created or last modified the configuration.
442 */
443 CreatedByArn: ArnType;
444 }
445 export type Boolean = boolean;
446 export type BooleanObject = boolean;
447 export interface BootstrapActionConfig {
448 /**
449 * The name of the bootstrap action.
450 */
451 Name: XmlStringMaxLen256;
452 /**
453 * The script run by the bootstrap action.
454 */
455 ScriptBootstrapAction: ScriptBootstrapActionConfig;
456 }
457 export type BootstrapActionConfigList = BootstrapActionConfig[];
458 export interface BootstrapActionDetail {
459 /**
460 * A description of the bootstrap action.
461 */
462 BootstrapActionConfig?: BootstrapActionConfig;
463 }
464 export type BootstrapActionDetailList = BootstrapActionDetail[];
465 export interface CancelStepsInfo {
466 /**
467 * The encrypted StepId of a step.
468 */
469 StepId?: StepId;
470 /**
471 * The status of a CancelSteps Request. The value may be SUBMITTED or FAILED.
472 */
473 Status?: CancelStepsRequestStatus;
474 /**
475 * The reason for the failure if the CancelSteps request fails.
476 */
477 Reason?: String;
478 }
479 export type CancelStepsInfoList = CancelStepsInfo[];
480 export interface CancelStepsInput {
481 /**
482 * The ClusterID for which specified steps will be canceled. Use RunJobFlow and ListClusters to get ClusterIDs.
483 */
484 ClusterId: XmlStringMaxLen256;
485 /**
486 * The list of StepIDs to cancel. Use ListSteps to get steps and their states for the specified cluster.
487 */
488 StepIds: StepIdsList;
489 /**
490 * The option to choose for cancelling RUNNING steps. By default, the value is SEND_INTERRUPT.
491 */
492 StepCancellationOption?: StepCancellationOption;
493 }
494 export interface CancelStepsOutput {
495 /**
496 * A list of CancelStepsInfo, which shows the status of specified cancel requests for each StepID specified.
497 */
498 CancelStepsInfoList?: CancelStepsInfoList;
499 }
500 export type CancelStepsRequestStatus = "SUBMITTED"|"FAILED"|string;
501 export interface CloudWatchAlarmDefinition {
502 /**
503 * Determines how the metric specified by MetricName is compared to the value specified by Threshold.
504 */
505 ComparisonOperator: ComparisonOperator;
506 /**
507 * The number of periods, in five-minute increments, during which the alarm condition must exist before the alarm triggers automatic scaling activity. The default value is 1.
508 */
509 EvaluationPeriods?: Integer;
510 /**
511 * The name of the CloudWatch metric that is watched to determine an alarm condition.
512 */
513 MetricName: String;
514 /**
515 * The namespace for the CloudWatch metric. The default is AWS/ElasticMapReduce.
516 */
517 Namespace?: String;
518 /**
519 * The period, in seconds, over which the statistic is applied. EMR CloudWatch metrics are emitted every five minutes (300 seconds), so if an EMR CloudWatch metric is specified, specify 300.
520 */
521 Period: Integer;
522 /**
523 * The statistic to apply to the metric associated with the alarm. The default is AVERAGE.
524 */
525 Statistic?: Statistic;
526 /**
527 * The value against which the specified statistic is compared.
528 */
529 Threshold: NonNegativeDouble;
530 /**
531 * The unit of measure associated with the CloudWatch metric being watched. The value specified for Unit must correspond to the units specified in the CloudWatch metric.
532 */
533 Unit?: Unit;
534 /**
535 * A CloudWatch metric dimension.
536 */
537 Dimensions?: MetricDimensionList;
538 }
539 export interface Cluster {
540 /**
541 * The unique identifier for the cluster.
542 */
543 Id?: ClusterId;
544 /**
545 * The name of the cluster.
546 */
547 Name?: String;
548 /**
549 * The current status details about the cluster.
550 */
551 Status?: ClusterStatus;
552 /**
553 * Provides information about the EC2 instances in a cluster grouped by category. For example, key name, subnet ID, IAM instance profile, and so on.
554 */
555 Ec2InstanceAttributes?: Ec2InstanceAttributes;
556 /**
557 * The instance fleet configuration is available only in Amazon EMR versions 4.8.0 and later, excluding 5.0.x versions. The instance group configuration of the cluster. A value of INSTANCE_GROUP indicates a uniform instance group configuration. A value of INSTANCE_FLEET indicates an instance fleets configuration.
558 */
559 InstanceCollectionType?: InstanceCollectionType;
560 /**
561 * The path to the Amazon S3 location where logs for this cluster are stored.
562 */
563 LogUri?: String;
564 /**
565 * The AMI version requested for this cluster.
566 */
567 RequestedAmiVersion?: String;
568 /**
569 * The AMI version running on this cluster.
570 */
571 RunningAmiVersion?: String;
572 /**
573 * The Amazon EMR release label, which determines the version of open-source application packages installed on the cluster. Release labels are in the form emr-x.x.x, where x.x.x is an Amazon EMR release version such as emr-5.14.0. For more information about Amazon EMR release versions and included application versions and features, see https://docs.aws.amazon.com/emr/latest/ReleaseGuide/. The release label applies only to Amazon EMR releases version 4.0 and later. Earlier versions use AmiVersion.
574 */
575 ReleaseLabel?: String;
576 /**
577 * Specifies whether the cluster should terminate after completing all steps.
578 */
579 AutoTerminate?: Boolean;
580 /**
581 * Indicates whether Amazon EMR will lock the cluster to prevent the EC2 instances from being terminated by an API call or user intervention, or in the event of a cluster error.
582 */
583 TerminationProtected?: Boolean;
584 /**
585 * Indicates whether the cluster is visible to all IAM users of the AWS account associated with the cluster. 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 this value is false, only the IAM user that created the cluster can perform actions. This value can be changed on a running cluster by using the SetVisibleToAllUsers action. You can override the default value of true when you create a cluster by using the VisibleToAllUsers parameter of the RunJobFlow action.
586 */
587 VisibleToAllUsers?: Boolean;
588 /**
589 * The applications installed on this cluster.
590 */
591 Applications?: ApplicationList;
592 /**
593 * A list of tags associated with a cluster.
594 */
595 Tags?: TagList;
596 /**
597 * The IAM role that will be assumed by the Amazon EMR service to access AWS resources on your behalf.
598 */
599 ServiceRole?: String;
600 /**
601 * An approximation of the cost of the cluster, represented in m1.small/hours. This value is incremented one time for every hour an m1.small instance runs. Larger instances are weighted more, so an EC2 instance that is roughly four times more expensive would result in the normalized instance hours being incremented by four. This result is only an approximation and does not reflect the actual billing rate.
602 */
603 NormalizedInstanceHours?: Integer;
604 /**
605 * The DNS name of the master node. If the cluster is on a private subnet, this is the private DNS name. On a public subnet, this is the public DNS name.
606 */
607 MasterPublicDnsName?: String;
608 /**
609 * Applies only to Amazon EMR releases 4.x and later. The list of Configurations supplied to the EMR cluster.
610 */
611 Configurations?: ConfigurationList;
612 /**
613 * The name of the security configuration applied to the cluster.
614 */
615 SecurityConfiguration?: XmlString;
616 /**
617 * An IAM role for automatic scaling policies. The default role is EMR_AutoScaling_DefaultRole. The IAM role provides permissions that the automatic scaling feature requires to launch and terminate EC2 instances in an instance group.
618 */
619 AutoScalingRole?: XmlString;
620 /**
621 * The way that individual Amazon EC2 instances terminate when an automatic scale-in activity occurs or an instance group is resized. TERMINATE_AT_INSTANCE_HOUR indicates that Amazon EMR terminates nodes at the instance-hour boundary, regardless of when the request to terminate the instance was submitted. This option is only available with Amazon EMR 5.1.0 and later and is the default for clusters created using that version. TERMINATE_AT_TASK_COMPLETION indicates that Amazon EMR blacklists and drains tasks from nodes before terminating the Amazon EC2 instances, regardless of the instance-hour boundary. With either behavior, Amazon EMR removes the least active nodes first and blocks instance termination if it could lead to HDFS corruption. TERMINATE_AT_TASK_COMPLETION is available only in Amazon EMR version 4.1.0 and later, and is the default for versions of Amazon EMR earlier than 5.1.0.
622 */
623 ScaleDownBehavior?: ScaleDownBehavior;
624 /**
625 * Available only in Amazon EMR version 5.7.0 and later. The ID of a custom Amazon EBS-backed Linux AMI if the cluster uses a custom AMI.
626 */
627 CustomAmiId?: XmlStringMaxLen256;
628 /**
629 * The size, in GiB, of the EBS root device volume of the Linux AMI that is used for each EC2 instance. Available in Amazon EMR version 4.x and later.
630 */
631 EbsRootVolumeSize?: Integer;
632 /**
633 * Applies only when CustomAmiID is used. Specifies the type of updates that are applied from the Amazon Linux AMI package repositories when an instance boots using the AMI.
634 */
635 RepoUpgradeOnBoot?: RepoUpgradeOnBoot;
636 /**
637 * 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.
638 */
639 KerberosAttributes?: KerberosAttributes;
640 /**
641 * The Amazon Resource Name of the cluster.
642 */
643 ClusterArn?: ArnType;
644 /**
645 * Specifies the number of steps that can be executed concurrently.
646 */
647 StepConcurrencyLevel?: Integer;
648 /**
649 * The Amazon Resource Name (ARN) of the Outpost where the cluster is launched.
650 */
651 OutpostArn?: OptionalArnType;
652 }
653 export type ClusterId = string;
654 export type ClusterState = "STARTING"|"BOOTSTRAPPING"|"RUNNING"|"WAITING"|"TERMINATING"|"TERMINATED"|"TERMINATED_WITH_ERRORS"|string;
655 export interface ClusterStateChangeReason {
656 /**
657 * The programmatic code for the state change reason.
658 */
659 Code?: ClusterStateChangeReasonCode;
660 /**
661 * The descriptive message for the state change reason.
662 */
663 Message?: String;
664 }
665 export type ClusterStateChangeReasonCode = "INTERNAL_ERROR"|"VALIDATION_ERROR"|"INSTANCE_FAILURE"|"INSTANCE_FLEET_TIMEOUT"|"BOOTSTRAP_FAILURE"|"USER_REQUEST"|"STEP_FAILURE"|"ALL_STEPS_COMPLETED"|string;
666 export type ClusterStateList = ClusterState[];
667 export interface ClusterStatus {
668 /**
669 * The current state of the cluster.
670 */
671 State?: ClusterState;
672 /**
673 * The reason for the cluster status change.
674 */
675 StateChangeReason?: ClusterStateChangeReason;
676 /**
677 * A timeline that represents the status of a cluster over the lifetime of the cluster.
678 */
679 Timeline?: ClusterTimeline;
680 }
681 export interface ClusterSummary {
682 /**
683 * The unique identifier for the cluster.
684 */
685 Id?: ClusterId;
686 /**
687 * The name of the cluster.
688 */
689 Name?: String;
690 /**
691 * The details about the current status of the cluster.
692 */
693 Status?: ClusterStatus;
694 /**
695 * An approximation of the cost of the cluster, represented in m1.small/hours. This value is incremented one time for every hour an m1.small instance runs. Larger instances are weighted more, so an EC2 instance that is roughly four times more expensive would result in the normalized instance hours being incremented by four. This result is only an approximation and does not reflect the actual billing rate.
696 */
697 NormalizedInstanceHours?: Integer;
698 /**
699 * The Amazon Resource Name of the cluster.
700 */
701 ClusterArn?: ArnType;
702 /**
703 * The Amazon Resource Name (ARN) of the Outpost where the cluster is launched.
704 */
705 OutpostArn?: OptionalArnType;
706 }
707 export type ClusterSummaryList = ClusterSummary[];
708 export interface ClusterTimeline {
709 /**
710 * The creation date and time of the cluster.
711 */
712 CreationDateTime?: _Date;
713 /**
714 * The date and time when the cluster was ready to execute steps.
715 */
716 ReadyDateTime?: _Date;
717 /**
718 * The date and time when the cluster was terminated.
719 */
720 EndDateTime?: _Date;
721 }
722 export interface Command {
723 /**
724 * The name of the command.
725 */
726 Name?: String;
727 /**
728 * The Amazon S3 location of the command script.
729 */
730 ScriptPath?: String;
731 /**
732 * Arguments for Amazon EMR to pass to the command for execution.
733 */
734 Args?: StringList;
735 }
736 export type CommandList = Command[];
737 export type ComparisonOperator = "GREATER_THAN_OR_EQUAL"|"GREATER_THAN"|"LESS_THAN"|"LESS_THAN_OR_EQUAL"|string;
738 export interface Configuration {
739 /**
740 * The classification within a configuration.
741 */
742 Classification?: String;
743 /**
744 * A list of additional configurations to apply within a configuration object.
745 */
746 Configurations?: ConfigurationList;
747 /**
748 * A set of properties specified within a configuration classification.
749 */
750 Properties?: StringMap;
751 }
752 export type ConfigurationList = Configuration[];
753 export interface CreateSecurityConfigurationInput {
754 /**
755 * The name of the security configuration.
756 */
757 Name: XmlString;
758 /**
759 * The security configuration details in JSON format. For JSON parameters and examples, see Use Security Configurations to Set Up Cluster Security in the Amazon EMR Management Guide.
760 */
761 SecurityConfiguration: String;
762 }
763 export interface CreateSecurityConfigurationOutput {
764 /**
765 * The name of the security configuration.
766 */
767 Name: XmlString;
768 /**
769 * The date and time the security configuration was created.
770 */
771 CreationDateTime: _Date;
772 }
773 export type _Date = Date;
774 export interface DeleteSecurityConfigurationInput {
775 /**
776 * The name of the security configuration.
777 */
778 Name: XmlString;
779 }
780 export interface DeleteSecurityConfigurationOutput {
781 }
782 export interface DescribeClusterInput {
783 /**
784 * The identifier of the cluster to describe.
785 */
786 ClusterId: ClusterId;
787 }
788 export interface DescribeClusterOutput {
789 /**
790 * This output contains the details for the requested cluster.
791 */
792 Cluster?: Cluster;
793 }
794 export interface DescribeJobFlowsInput {
795 /**
796 * Return only job flows created after this date and time.
797 */
798 CreatedAfter?: _Date;
799 /**
800 * Return only job flows created before this date and time.
801 */
802 CreatedBefore?: _Date;
803 /**
804 * Return only job flows whose job flow ID is contained in this list.
805 */
806 JobFlowIds?: XmlStringList;
807 /**
808 * Return only job flows whose state is contained in this list.
809 */
810 JobFlowStates?: JobFlowExecutionStateList;
811 }
812 export interface DescribeJobFlowsOutput {
813 /**
814 * A list of job flows matching the parameters supplied.
815 */
816 JobFlows?: JobFlowDetailList;
817 }
818 export interface DescribeSecurityConfigurationInput {
819 /**
820 * The name of the security configuration.
821 */
822 Name: XmlString;
823 }
824 export interface DescribeSecurityConfigurationOutput {
825 /**
826 * The name of the security configuration.
827 */
828 Name?: XmlString;
829 /**
830 * The security configuration details in JSON format.
831 */
832 SecurityConfiguration?: String;
833 /**
834 * The date and time the security configuration was created
835 */
836 CreationDateTime?: _Date;
837 }
838 export interface DescribeStepInput {
839 /**
840 * The identifier of the cluster with steps to describe.
841 */
842 ClusterId: ClusterId;
843 /**
844 * The identifier of the step to describe.
845 */
846 StepId: StepId;
847 }
848 export interface DescribeStepOutput {
849 /**
850 * The step details for the requested step identifier.
851 */
852 Step?: Step;
853 }
854 export type EC2InstanceIdsList = InstanceId[];
855 export type EC2InstanceIdsToTerminateList = InstanceId[];
856 export interface EbsBlockDevice {
857 /**
858 * 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.
859 */
860 VolumeSpecification?: VolumeSpecification;
861 /**
862 * The device name that is exposed to the instance, such as /dev/sdh.
863 */
864 Device?: String;
865 }
866 export interface EbsBlockDeviceConfig {
867 /**
868 * 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.
869 */
870 VolumeSpecification: VolumeSpecification;
871 /**
872 * Number of EBS volumes with a specific volume configuration that will be associated with every instance in the instance group
873 */
874 VolumesPerInstance?: Integer;
875 }
876 export type EbsBlockDeviceConfigList = EbsBlockDeviceConfig[];
877 export type EbsBlockDeviceList = EbsBlockDevice[];
878 export interface EbsConfiguration {
879 /**
880 * An array of Amazon EBS volume specifications attached to a cluster instance.
881 */
882 EbsBlockDeviceConfigs?: EbsBlockDeviceConfigList;
883 /**
884 * Indicates whether an Amazon EBS volume is EBS-optimized.
885 */
886 EbsOptimized?: BooleanObject;
887 }
888 export interface EbsVolume {
889 /**
890 * The device name that is exposed to the instance, such as /dev/sdh.
891 */
892 Device?: String;
893 /**
894 * The volume identifier of the EBS volume.
895 */
896 VolumeId?: String;
897 }
898 export type EbsVolumeList = EbsVolume[];
899 export interface Ec2InstanceAttributes {
900 /**
901 * The name of the Amazon EC2 key pair to use when connecting with SSH into the master node as a user named "hadoop".
902 */
903 Ec2KeyName?: String;
904 /**
905 * Set this parameter to the identifier of the Amazon VPC subnet where you want the cluster to launch. If you do not specify this value, and your account supports EC2-Classic, the cluster launches in EC2-Classic.
906 */
907 Ec2SubnetId?: String;
908 /**
909 * Applies to clusters configured with the instance fleets option. Specifies the unique identifier of one or more Amazon EC2 subnets in which to launch EC2 cluster instances. Subnets must exist within the same VPC. Amazon EMR chooses the EC2 subnet with the best fit from among the list of RequestedEc2SubnetIds, and then launches all cluster instances within that Subnet. If this value is not specified, and the account and Region support EC2-Classic networks, the cluster launches instances in the EC2-Classic network and uses RequestedEc2AvailabilityZones instead of this setting. If EC2-Classic is not supported, and no Subnet is specified, Amazon EMR chooses the subnet for you. RequestedEc2SubnetIDs and RequestedEc2AvailabilityZones cannot be specified together.
910 */
911 RequestedEc2SubnetIds?: XmlStringMaxLen256List;
912 /**
913 * The Availability Zone in which the cluster will run.
914 */
915 Ec2AvailabilityZone?: String;
916 /**
917 * Applies to clusters configured with the instance fleets option. Specifies one or more Availability Zones in which to launch EC2 cluster instances when the EC2-Classic network configuration is supported. Amazon EMR chooses the Availability Zone with the best fit from among the list of RequestedEc2AvailabilityZones, and then launches all cluster instances within that Availability Zone. If you do not specify this value, Amazon EMR chooses the Availability Zone for you. RequestedEc2SubnetIDs and RequestedEc2AvailabilityZones cannot be specified together.
918 */
919 RequestedEc2AvailabilityZones?: XmlStringMaxLen256List;
920 /**
921 * The IAM role that was specified when the cluster was launched. The EC2 instances of the cluster assume this role.
922 */
923 IamInstanceProfile?: String;
924 /**
925 * The identifier of the Amazon EC2 security group for the master node.
926 */
927 EmrManagedMasterSecurityGroup?: String;
928 /**
929 * The identifier of the Amazon EC2 security group for the core and task nodes.
930 */
931 EmrManagedSlaveSecurityGroup?: String;
932 /**
933 * The identifier of the Amazon EC2 security group for the Amazon EMR service to access clusters in VPC private subnets.
934 */
935 ServiceAccessSecurityGroup?: String;
936 /**
937 * A list of additional Amazon EC2 security group IDs for the master node.
938 */
939 AdditionalMasterSecurityGroups?: StringList;
940 /**
941 * A list of additional Amazon EC2 security group IDs for the core and task nodes.
942 */
943 AdditionalSlaveSecurityGroups?: StringList;
944 }
945 export interface FailureDetails {
946 /**
947 * The reason for the step failure. In the case where the service cannot successfully determine the root cause of the failure, it returns "Unknown Error" as a reason.
948 */
949 Reason?: String;
950 /**
951 * The descriptive message including the error the EMR service has identified as the cause of step failure. This is text from an error log that describes the root cause of the failure.
952 */
953 Message?: String;
954 /**
955 * The path to the log file where the step failure root cause was originally recorded.
956 */
957 LogFile?: String;
958 }
959 export interface GetBlockPublicAccessConfigurationInput {
960 }
961 export interface GetBlockPublicAccessConfigurationOutput {
962 /**
963 * A configuration for Amazon EMR block public access. The configuration applies to all clusters created in your account for the current Region. The configuration specifies whether block public access is enabled. If block public access is enabled, security groups associated with the cluster cannot have rules that allow inbound traffic from 0.0.0.0/0 or ::/0 on a port, unless the port is specified as an exception using PermittedPublicSecurityGroupRuleRanges in the BlockPublicAccessConfiguration. By default, Port 22 (SSH) is an exception, and public access is allowed on this port. You can change this by updating the block public access configuration to remove the exception.
964 */
965 BlockPublicAccessConfiguration: BlockPublicAccessConfiguration;
966 /**
967 * Properties that describe the AWS 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.
968 */
969 BlockPublicAccessConfigurationMetadata: BlockPublicAccessConfigurationMetadata;
970 }
971 export interface HadoopJarStepConfig {
972 /**
973 * A list of Java properties that are set when the step runs. You can use these properties to pass key value pairs to your main function.
974 */
975 Properties?: KeyValueList;
976 /**
977 * A path to a JAR file run during the step.
978 */
979 Jar: XmlString;
980 /**
981 * The name of the main class in the specified Java file. If not specified, the JAR file should specify a Main-Class in its manifest file.
982 */
983 MainClass?: XmlString;
984 /**
985 * A list of command line arguments passed to the JAR file's main function when executed.
986 */
987 Args?: XmlStringList;
988 }
989 export interface HadoopStepConfig {
990 /**
991 * The path to the JAR file that runs during the step.
992 */
993 Jar?: String;
994 /**
995 * The list of Java properties that are set when the step runs. You can use these properties to pass key value pairs to your main function.
996 */
997 Properties?: StringMap;
998 /**
999 * The name of the main class in the specified Java file. If not specified, the JAR file should specify a main class in its manifest file.
1000 */
1001 MainClass?: String;
1002 /**
1003 * The list of command line arguments to pass to the JAR file's main function for execution.
1004 */
1005 Args?: StringList;
1006 }
1007 export interface Instance {
1008 /**
1009 * The unique identifier for the instance in Amazon EMR.
1010 */
1011 Id?: InstanceId;
1012 /**
1013 * The unique identifier of the instance in Amazon EC2.
1014 */
1015 Ec2InstanceId?: InstanceId;
1016 /**
1017 * The public DNS name of the instance.
1018 */
1019 PublicDnsName?: String;
1020 /**
1021 * The public IP address of the instance.
1022 */
1023 PublicIpAddress?: String;
1024 /**
1025 * The private DNS name of the instance.
1026 */
1027 PrivateDnsName?: String;
1028 /**
1029 * The private IP address of the instance.
1030 */
1031 PrivateIpAddress?: String;
1032 /**
1033 * The current status of the instance.
1034 */
1035 Status?: InstanceStatus;
1036 /**
1037 * The identifier of the instance group to which this instance belongs.
1038 */
1039 InstanceGroupId?: String;
1040 /**
1041 * The unique identifier of the instance fleet to which an EC2 instance belongs.
1042 */
1043 InstanceFleetId?: InstanceFleetId;
1044 /**
1045 * The instance purchasing option. Valid values are ON_DEMAND or SPOT.
1046 */
1047 Market?: MarketType;
1048 /**
1049 * The EC2 instance type, for example m3.xlarge.
1050 */
1051 InstanceType?: InstanceType;
1052 /**
1053 * The list of EBS volumes that are attached to this instance.
1054 */
1055 EbsVolumes?: EbsVolumeList;
1056 }
1057 export type InstanceCollectionType = "INSTANCE_FLEET"|"INSTANCE_GROUP"|string;
1058 export interface InstanceFleet {
1059 /**
1060 * The unique identifier of the instance fleet.
1061 */
1062 Id?: InstanceFleetId;
1063 /**
1064 * A friendly name for the instance fleet.
1065 */
1066 Name?: XmlStringMaxLen256;
1067 /**
1068 * The current status of the instance fleet.
1069 */
1070 Status?: InstanceFleetStatus;
1071 /**
1072 * The node type that the instance fleet hosts. Valid values are MASTER, CORE, or TASK.
1073 */
1074 InstanceFleetType?: InstanceFleetType;
1075 /**
1076 * The target capacity of On-Demand units for the instance fleet, which determines how many On-Demand instances to provision. When the instance fleet launches, Amazon EMR tries to provision On-Demand instances as specified by InstanceTypeConfig. Each instance configuration has a specified WeightedCapacity. When an On-Demand instance is provisioned, the WeightedCapacity units count toward the target capacity. Amazon EMR provisions instances until the target capacity is totally fulfilled, even if this results in an overage. For example, if there are 2 units remaining to fulfill capacity, and Amazon EMR can only provision an instance with a WeightedCapacity of 5 units, the instance is provisioned, and the target capacity is exceeded by 3 units. You can use InstanceFleet$ProvisionedOnDemandCapacity to determine the Spot capacity units that have been provisioned for the instance fleet. If not specified or set to 0, only Spot instances are provisioned for the instance fleet using TargetSpotCapacity. At least one of TargetSpotCapacity and TargetOnDemandCapacity should be greater than 0. For a master instance fleet, only one of TargetSpotCapacity and TargetOnDemandCapacity can be specified, and its value must be 1.
1077 */
1078 TargetOnDemandCapacity?: WholeNumber;
1079 /**
1080 * The target capacity of Spot units for the instance fleet, which determines how many Spot instances to provision. When the instance fleet launches, Amazon EMR tries to provision Spot instances as specified by InstanceTypeConfig. Each instance configuration has a specified WeightedCapacity. When a Spot instance is provisioned, the WeightedCapacity units count toward the target capacity. Amazon EMR provisions instances until the target capacity is totally fulfilled, even if this results in an overage. For example, if there are 2 units remaining to fulfill capacity, and Amazon EMR can only provision an instance with a WeightedCapacity of 5 units, the instance is provisioned, and the target capacity is exceeded by 3 units. You can use InstanceFleet$ProvisionedSpotCapacity to determine the Spot capacity units that have been provisioned for the instance fleet. If not specified or set to 0, only On-Demand instances are provisioned for the instance fleet. At least one of TargetSpotCapacity and TargetOnDemandCapacity should be greater than 0. For a master instance fleet, only one of TargetSpotCapacity and TargetOnDemandCapacity can be specified, and its value must be 1.
1081 */
1082 TargetSpotCapacity?: WholeNumber;
1083 /**
1084 * The number of On-Demand units that have been provisioned for the instance fleet to fulfill TargetOnDemandCapacity. This provisioned capacity might be less than or greater than TargetOnDemandCapacity.
1085 */
1086 ProvisionedOnDemandCapacity?: WholeNumber;
1087 /**
1088 * The number of Spot units that have been provisioned for this instance fleet to fulfill TargetSpotCapacity. This provisioned capacity might be less than or greater than TargetSpotCapacity.
1089 */
1090 ProvisionedSpotCapacity?: WholeNumber;
1091 /**
1092 * The specification for the instance types that comprise an instance fleet. Up to five unique instance specifications may be defined for each instance fleet.
1093 */
1094 InstanceTypeSpecifications?: InstanceTypeSpecificationList;
1095 /**
1096 * Describes the launch specification for an instance fleet.
1097 */
1098 LaunchSpecifications?: InstanceFleetProvisioningSpecifications;
1099 }
1100 export interface InstanceFleetConfig {
1101 /**
1102 * The friendly name of the instance fleet.
1103 */
1104 Name?: XmlStringMaxLen256;
1105 /**
1106 * The node type that the instance fleet hosts. Valid values are MASTER,CORE,and TASK.
1107 */
1108 InstanceFleetType: InstanceFleetType;
1109 /**
1110 * The target capacity of On-Demand units for the instance fleet, which determines how many On-Demand instances to provision. When the instance fleet launches, Amazon EMR tries to provision On-Demand instances as specified by InstanceTypeConfig. Each instance configuration has a specified WeightedCapacity. When an On-Demand instance is provisioned, the WeightedCapacity units count toward the target capacity. Amazon EMR provisions instances until the target capacity is totally fulfilled, even if this results in an overage. For example, if there are 2 units remaining to fulfill capacity, and Amazon EMR can only provision an instance with a WeightedCapacity of 5 units, the instance is provisioned, and the target capacity is exceeded by 3 units. If not specified or set to 0, only Spot instances are provisioned for the instance fleet using TargetSpotCapacity. At least one of TargetSpotCapacity and TargetOnDemandCapacity should be greater than 0. For a master instance fleet, only one of TargetSpotCapacity and TargetOnDemandCapacity can be specified, and its value must be 1.
1111 */
1112 TargetOnDemandCapacity?: WholeNumber;
1113 /**
1114 * The target capacity of Spot units for the instance fleet, which determines how many Spot instances to provision. When the instance fleet launches, Amazon EMR tries to provision Spot instances as specified by InstanceTypeConfig. Each instance configuration has a specified WeightedCapacity. When a Spot instance is provisioned, the WeightedCapacity units count toward the target capacity. Amazon EMR provisions instances until the target capacity is totally fulfilled, even if this results in an overage. For example, if there are 2 units remaining to fulfill capacity, and Amazon EMR can only provision an instance with a WeightedCapacity of 5 units, the instance is provisioned, and the target capacity is exceeded by 3 units. If not specified or set to 0, only On-Demand instances are provisioned for the instance fleet. At least one of TargetSpotCapacity and TargetOnDemandCapacity should be greater than 0. For a master instance fleet, only one of TargetSpotCapacity and TargetOnDemandCapacity can be specified, and its value must be 1.
1115 */
1116 TargetSpotCapacity?: WholeNumber;
1117 /**
1118 * The instance type configurations that define the EC2 instances in the instance fleet.
1119 */
1120 InstanceTypeConfigs?: InstanceTypeConfigList;
1121 /**
1122 * The launch specification for the instance fleet.
1123 */
1124 LaunchSpecifications?: InstanceFleetProvisioningSpecifications;
1125 }
1126 export type InstanceFleetConfigList = InstanceFleetConfig[];
1127 export type InstanceFleetId = string;
1128 export type InstanceFleetList = InstanceFleet[];
1129 export interface InstanceFleetModifyConfig {
1130 /**
1131 * A unique identifier for the instance fleet.
1132 */
1133 InstanceFleetId: InstanceFleetId;
1134 /**
1135 * The target capacity of On-Demand units for the instance fleet. For more information see InstanceFleetConfig$TargetOnDemandCapacity.
1136 */
1137 TargetOnDemandCapacity?: WholeNumber;
1138 /**
1139 * The target capacity of Spot units for the instance fleet. For more information, see InstanceFleetConfig$TargetSpotCapacity.
1140 */
1141 TargetSpotCapacity?: WholeNumber;
1142 }
1143 export interface InstanceFleetProvisioningSpecifications {
1144 /**
1145 * The launch specification for Spot instances in the fleet, which determines the defined duration and provisioning timeout behavior.
1146 */
1147 SpotSpecification: SpotProvisioningSpecification;
1148 }
1149 export type InstanceFleetState = "PROVISIONING"|"BOOTSTRAPPING"|"RUNNING"|"RESIZING"|"SUSPENDED"|"TERMINATING"|"TERMINATED"|string;
1150 export interface InstanceFleetStateChangeReason {
1151 /**
1152 * A code corresponding to the reason the state change occurred.
1153 */
1154 Code?: InstanceFleetStateChangeReasonCode;
1155 /**
1156 * An explanatory message.
1157 */
1158 Message?: String;
1159 }
1160 export type InstanceFleetStateChangeReasonCode = "INTERNAL_ERROR"|"VALIDATION_ERROR"|"INSTANCE_FAILURE"|"CLUSTER_TERMINATED"|string;
1161 export interface InstanceFleetStatus {
1162 /**
1163 * A code representing the instance fleet status. PROVISIONING—The instance fleet is provisioning EC2 resources and is not yet ready to run jobs. BOOTSTRAPPING—EC2 instances and other resources have been provisioned and the bootstrap actions specified for the instances are underway. RUNNING—EC2 instances and other resources are running. They are either executing jobs or waiting to execute jobs. RESIZING—A resize operation is underway. EC2 instances are either being added or removed. SUSPENDED—A resize operation could not complete. Existing EC2 instances are running, but instances can't be added or removed. TERMINATING—The instance fleet is terminating EC2 instances. TERMINATED—The instance fleet is no longer active, and all EC2 instances have been terminated.
1164 */
1165 State?: InstanceFleetState;
1166 /**
1167 * Provides status change reason details for the instance fleet.
1168 */
1169 StateChangeReason?: InstanceFleetStateChangeReason;
1170 /**
1171 * 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.
1172 */
1173 Timeline?: InstanceFleetTimeline;
1174 }
1175 export interface InstanceFleetTimeline {
1176 /**
1177 * The time and date the instance fleet was created.
1178 */
1179 CreationDateTime?: _Date;
1180 /**
1181 * The time and date the instance fleet was ready to run jobs.
1182 */
1183 ReadyDateTime?: _Date;
1184 /**
1185 * The time and date the instance fleet terminated.
1186 */
1187 EndDateTime?: _Date;
1188 }
1189 export type InstanceFleetType = "MASTER"|"CORE"|"TASK"|string;
1190 export interface InstanceGroup {
1191 /**
1192 * The identifier of the instance group.
1193 */
1194 Id?: InstanceGroupId;
1195 /**
1196 * The name of the instance group.
1197 */
1198 Name?: String;
1199 /**
1200 * The marketplace to provision instances for this group. Valid values are ON_DEMAND or SPOT.
1201 */
1202 Market?: MarketType;
1203 /**
1204 * The type of the instance group. Valid values are MASTER, CORE or TASK.
1205 */
1206 InstanceGroupType?: InstanceGroupType;
1207 /**
1208 * The bid price for each EC2 Spot instance type as defined by InstanceType. Expressed in USD. If neither BidPrice nor BidPriceAsPercentageOfOnDemandPrice is provided, BidPriceAsPercentageOfOnDemandPrice defaults to 100%.
1209 */
1210 BidPrice?: String;
1211 /**
1212 * The EC2 instance type for all instances in the instance group.
1213 */
1214 InstanceType?: InstanceType;
1215 /**
1216 * The target number of instances for the instance group.
1217 */
1218 RequestedInstanceCount?: Integer;
1219 /**
1220 * The number of instances currently running in this instance group.
1221 */
1222 RunningInstanceCount?: Integer;
1223 /**
1224 * The current status of the instance group.
1225 */
1226 Status?: InstanceGroupStatus;
1227 /**
1228 * Amazon EMR releases 4.x or later. The list of configurations supplied for an EMR cluster instance group. You can specify a separate configuration for each instance group (master, core, and task).
1229 */
1230 Configurations?: ConfigurationList;
1231 /**
1232 * The version number of the requested configuration specification for this instance group.
1233 */
1234 ConfigurationsVersion?: Long;
1235 /**
1236 * A list of configurations that were successfully applied for an instance group last time.
1237 */
1238 LastSuccessfullyAppliedConfigurations?: ConfigurationList;
1239 /**
1240 * The version number of a configuration specification that was successfully applied for an instance group last time.
1241 */
1242 LastSuccessfullyAppliedConfigurationsVersion?: Long;
1243 /**
1244 * The EBS block devices that are mapped to this instance group.
1245 */
1246 EbsBlockDevices?: EbsBlockDeviceList;
1247 /**
1248 * If the instance group is EBS-optimized. An Amazon EBS-optimized instance uses an optimized configuration stack and provides additional, dedicated capacity for Amazon EBS I/O.
1249 */
1250 EbsOptimized?: BooleanObject;
1251 /**
1252 * Policy for customizing shrink operations.
1253 */
1254 ShrinkPolicy?: ShrinkPolicy;
1255 /**
1256 * 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.
1257 */
1258 AutoScalingPolicy?: AutoScalingPolicyDescription;
1259 }
1260 export interface InstanceGroupConfig {
1261 /**
1262 * Friendly name given to the instance group.
1263 */
1264 Name?: XmlStringMaxLen256;
1265 /**
1266 * Market type of the EC2 instances used to create a cluster node.
1267 */
1268 Market?: MarketType;
1269 /**
1270 * The role of the instance group in the cluster.
1271 */
1272 InstanceRole: InstanceRoleType;
1273 /**
1274 * The bid price for each EC2 Spot instance type as defined by InstanceType. Expressed in USD. If neither BidPrice nor BidPriceAsPercentageOfOnDemandPrice is provided, BidPriceAsPercentageOfOnDemandPrice defaults to 100%.
1275 */
1276 BidPrice?: XmlStringMaxLen256;
1277 /**
1278 * The EC2 instance type for all instances in the instance group.
1279 */
1280 InstanceType: InstanceType;
1281 /**
1282 * Target number of instances for the instance group.
1283 */
1284 InstanceCount: Integer;
1285 /**
1286 * Amazon EMR releases 4.x or later. The list of configurations supplied for an EMR cluster instance group. You can specify a separate configuration for each instance group (master, core, and task).
1287 */
1288 Configurations?: ConfigurationList;
1289 /**
1290 * EBS configurations that will be attached to each EC2 instance in the instance group.
1291 */
1292 EbsConfiguration?: EbsConfiguration;
1293 /**
1294 * 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.
1295 */
1296 AutoScalingPolicy?: AutoScalingPolicy;
1297 }
1298 export type InstanceGroupConfigList = InstanceGroupConfig[];
1299 export interface InstanceGroupDetail {
1300 /**
1301 * Unique identifier for the instance group.
1302 */
1303 InstanceGroupId?: XmlStringMaxLen256;
1304 /**
1305 * Friendly name for the instance group.
1306 */
1307 Name?: XmlStringMaxLen256;
1308 /**
1309 * Market type of the EC2 instances used to create a cluster node.
1310 */
1311 Market: MarketType;
1312 /**
1313 * Instance group role in the cluster
1314 */
1315 InstanceRole: InstanceRoleType;
1316 /**
1317 * The bid price for each EC2 Spot instance type as defined by InstanceType. Expressed in USD. If neither BidPrice nor BidPriceAsPercentageOfOnDemandPrice is provided, BidPriceAsPercentageOfOnDemandPrice defaults to 100%.
1318 */
1319 BidPrice?: XmlStringMaxLen256;
1320 /**
1321 * EC2 instance type.
1322 */
1323 InstanceType: InstanceType;
1324 /**
1325 * Target number of instances to run in the instance group.
1326 */
1327 InstanceRequestCount: Integer;
1328 /**
1329 * Actual count of running instances.
1330 */
1331 InstanceRunningCount: Integer;
1332 /**
1333 * State of instance group. The following values are deprecated: STARTING, TERMINATED, and FAILED.
1334 */
1335 State: InstanceGroupState;
1336 /**
1337 * Details regarding the state of the instance group.
1338 */
1339 LastStateChangeReason?: XmlString;
1340 /**
1341 * The date/time the instance group was created.
1342 */
1343 CreationDateTime: _Date;
1344 /**
1345 * The date/time the instance group was started.
1346 */
1347 StartDateTime?: _Date;
1348 /**
1349 * The date/time the instance group was available to the cluster.
1350 */
1351 ReadyDateTime?: _Date;
1352 /**
1353 * The date/time the instance group was terminated.
1354 */
1355 EndDateTime?: _Date;
1356 }
1357 export type InstanceGroupDetailList = InstanceGroupDetail[];
1358 export type InstanceGroupId = string;
1359 export type InstanceGroupIdsList = XmlStringMaxLen256[];
1360 export type InstanceGroupList = InstanceGroup[];
1361 export interface InstanceGroupModifyConfig {
1362 /**
1363 * Unique ID of the instance group to expand or shrink.
1364 */
1365 InstanceGroupId: XmlStringMaxLen256;
1366 /**
1367 * Target size for the instance group.
1368 */
1369 InstanceCount?: Integer;
1370 /**
1371 * The EC2 InstanceIds to terminate. After you terminate the instances, the instance group will not return to its original requested size.
1372 */
1373 EC2InstanceIdsToTerminate?: EC2InstanceIdsToTerminateList;
1374 /**
1375 * Policy for customizing shrink operations.
1376 */
1377 ShrinkPolicy?: ShrinkPolicy;
1378 /**
1379 * A list of new or modified configurations to apply for an instance group.
1380 */
1381 Configurations?: ConfigurationList;
1382 }
1383 export type InstanceGroupModifyConfigList = InstanceGroupModifyConfig[];
1384 export type InstanceGroupState = "PROVISIONING"|"BOOTSTRAPPING"|"RUNNING"|"RECONFIGURING"|"RESIZING"|"SUSPENDED"|"TERMINATING"|"TERMINATED"|"ARRESTED"|"SHUTTING_DOWN"|"ENDED"|string;
1385 export interface InstanceGroupStateChangeReason {
1386 /**
1387 * The programmable code for the state change reason.
1388 */
1389 Code?: InstanceGroupStateChangeReasonCode;
1390 /**
1391 * The status change reason description.
1392 */
1393 Message?: String;
1394 }
1395 export type InstanceGroupStateChangeReasonCode = "INTERNAL_ERROR"|"VALIDATION_ERROR"|"INSTANCE_FAILURE"|"CLUSTER_TERMINATED"|string;
1396 export interface InstanceGroupStatus {
1397 /**
1398 * The current state of the instance group.
1399 */
1400 State?: InstanceGroupState;
1401 /**
1402 * The status change reason details for the instance group.
1403 */
1404 StateChangeReason?: InstanceGroupStateChangeReason;
1405 /**
1406 * The timeline of the instance group status over time.
1407 */
1408 Timeline?: InstanceGroupTimeline;
1409 }
1410 export interface InstanceGroupTimeline {
1411 /**
1412 * The creation date and time of the instance group.
1413 */
1414 CreationDateTime?: _Date;
1415 /**
1416 * The date and time when the instance group became ready to perform tasks.
1417 */
1418 ReadyDateTime?: _Date;
1419 /**
1420 * The date and time when the instance group terminated.
1421 */
1422 EndDateTime?: _Date;
1423 }
1424 export type InstanceGroupType = "MASTER"|"CORE"|"TASK"|string;
1425 export type InstanceGroupTypeList = InstanceGroupType[];
1426 export type InstanceId = string;
1427 export type InstanceList = Instance[];
1428 export interface InstanceResizePolicy {
1429 /**
1430 * Specific list of instances to be terminated when shrinking an instance group.
1431 */
1432 InstancesToTerminate?: EC2InstanceIdsList;
1433 /**
1434 * Specific list of instances to be protected when shrinking an instance group.
1435 */
1436 InstancesToProtect?: EC2InstanceIdsList;
1437 /**
1438 * Decommissioning timeout override for the specific list of instances to be terminated.
1439 */
1440 InstanceTerminationTimeout?: Integer;
1441 }
1442 export type InstanceRoleType = "MASTER"|"CORE"|"TASK"|string;
1443 export type InstanceState = "AWAITING_FULFILLMENT"|"PROVISIONING"|"BOOTSTRAPPING"|"RUNNING"|"TERMINATED"|string;
1444 export interface InstanceStateChangeReason {
1445 /**
1446 * The programmable code for the state change reason.
1447 */
1448 Code?: InstanceStateChangeReasonCode;
1449 /**
1450 * The status change reason description.
1451 */
1452 Message?: String;
1453 }
1454 export type InstanceStateChangeReasonCode = "INTERNAL_ERROR"|"VALIDATION_ERROR"|"INSTANCE_FAILURE"|"BOOTSTRAP_FAILURE"|"CLUSTER_TERMINATED"|string;
1455 export type InstanceStateList = InstanceState[];
1456 export interface InstanceStatus {
1457 /**
1458 * The current state of the instance.
1459 */
1460 State?: InstanceState;
1461 /**
1462 * The details of the status change reason for the instance.
1463 */
1464 StateChangeReason?: InstanceStateChangeReason;
1465 /**
1466 * The timeline of the instance status over time.
1467 */
1468 Timeline?: InstanceTimeline;
1469 }
1470 export interface InstanceTimeline {
1471 /**
1472 * The creation date and time of the instance.
1473 */
1474 CreationDateTime?: _Date;
1475 /**
1476 * The date and time when the instance was ready to perform tasks.
1477 */
1478 ReadyDateTime?: _Date;
1479 /**
1480 * The date and time when the instance was terminated.
1481 */
1482 EndDateTime?: _Date;
1483 }
1484 export type InstanceType = string;
1485 export interface InstanceTypeConfig {
1486 /**
1487 * An EC2 instance type, such as m3.xlarge.
1488 */
1489 InstanceType: InstanceType;
1490 /**
1491 * The number of units that a provisioned instance of this type provides toward fulfilling the target capacities defined in InstanceFleetConfig. This value is 1 for a master instance fleet, and must be 1 or greater for core and task instance fleets. Defaults to 1 if not specified.
1492 */
1493 WeightedCapacity?: WholeNumber;
1494 /**
1495 * The bid price for each EC2 Spot instance type as defined by InstanceType. Expressed in USD. If neither BidPrice nor BidPriceAsPercentageOfOnDemandPrice is provided, BidPriceAsPercentageOfOnDemandPrice defaults to 100%.
1496 */
1497 BidPrice?: XmlStringMaxLen256;
1498 /**
1499 * The bid price, as a percentage of On-Demand price, for each EC2 Spot instance as defined by InstanceType. Expressed as a number (for example, 20 specifies 20%). If neither BidPrice nor BidPriceAsPercentageOfOnDemandPrice is provided, BidPriceAsPercentageOfOnDemandPrice defaults to 100%.
1500 */
1501 BidPriceAsPercentageOfOnDemandPrice?: NonNegativeDouble;
1502 /**
1503 * The configuration of Amazon Elastic Block Storage (EBS) attached to each instance as defined by InstanceType.
1504 */
1505 EbsConfiguration?: EbsConfiguration;
1506 /**
1507 * A configuration classification that applies when provisioning cluster instances, which can include configurations for applications and software that run on the cluster.
1508 */
1509 Configurations?: ConfigurationList;
1510 }
1511 export type InstanceTypeConfigList = InstanceTypeConfig[];
1512 export interface InstanceTypeSpecification {
1513 /**
1514 * The EC2 instance type, for example m3.xlarge.
1515 */
1516 InstanceType?: InstanceType;
1517 /**
1518 * The number of units that a provisioned instance of this type provides toward fulfilling the target capacities defined in InstanceFleetConfig. Capacity values represent performance characteristics such as vCPUs, memory, or I/O. If not specified, the default value is 1.
1519 */
1520 WeightedCapacity?: WholeNumber;
1521 /**
1522 * The bid price for each EC2 Spot instance type as defined by InstanceType. Expressed in USD.
1523 */
1524 BidPrice?: XmlStringMaxLen256;
1525 /**
1526 * The bid price, as a percentage of On-Demand price, for each EC2 Spot instance as defined by InstanceType. Expressed as a number (for example, 20 specifies 20%).
1527 */
1528 BidPriceAsPercentageOfOnDemandPrice?: NonNegativeDouble;
1529 /**
1530 * A configuration classification that applies when provisioning cluster instances, which can include configurations for applications and software bundled with Amazon EMR.
1531 */
1532 Configurations?: ConfigurationList;
1533 /**
1534 * The configuration of Amazon Elastic Block Storage (EBS) attached to each instance as defined by InstanceType.
1535 */
1536 EbsBlockDevices?: EbsBlockDeviceList;
1537 /**
1538 * Evaluates to TRUE when the specified InstanceType is EBS-optimized.
1539 */
1540 EbsOptimized?: BooleanObject;
1541 }
1542 export type InstanceTypeSpecificationList = InstanceTypeSpecification[];
1543 export type Integer = number;
1544 export interface JobFlowDetail {
1545 /**
1546 * The job flow identifier.
1547 */
1548 JobFlowId: XmlStringMaxLen256;
1549 /**
1550 * The name of the job flow.
1551 */
1552 Name: XmlStringMaxLen256;
1553 /**
1554 * The location in Amazon S3 where log files for the job are stored.
1555 */
1556 LogUri?: XmlString;
1557 /**
1558 * Applies only to Amazon EMR AMI versions 3.x and 2.x. For Amazon EMR releases 4.0 and later, ReleaseLabel is used. To specify a custom AMI, use CustomAmiID.
1559 */
1560 AmiVersion?: XmlStringMaxLen256;
1561 /**
1562 * Describes the execution status of the job flow.
1563 */
1564 ExecutionStatusDetail: JobFlowExecutionStatusDetail;
1565 /**
1566 * Describes the Amazon EC2 instances of the job flow.
1567 */
1568 Instances: JobFlowInstancesDetail;
1569 /**
1570 * A list of steps run by the job flow.
1571 */
1572 Steps?: StepDetailList;
1573 /**
1574 * A list of the bootstrap actions run by the job flow.
1575 */
1576 BootstrapActions?: BootstrapActionDetailList;
1577 /**
1578 * A list of strings set by third party software when the job flow is launched. If you are not using third party software to manage the job flow this value is empty.
1579 */
1580 SupportedProducts?: SupportedProductsList;
1581 /**
1582 * Indicates whether the cluster is visible to all IAM users of the AWS account associated with the cluster. 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 this value is false, only the IAM user that created the cluster can perform actions. This value can be changed on a running cluster by using the SetVisibleToAllUsers action. You can override the default value of true when you create a cluster by using the VisibleToAllUsers parameter of the RunJobFlow action.
1583 */
1584 VisibleToAllUsers?: Boolean;
1585 /**
1586 * The IAM role that was specified when the job flow was launched. The EC2 instances of the job flow assume this role.
1587 */
1588 JobFlowRole?: XmlString;
1589 /**
1590 * The IAM role that will be assumed by the Amazon EMR service to access AWS resources on your behalf.
1591 */
1592 ServiceRole?: XmlString;
1593 /**
1594 * An IAM role for automatic scaling policies. The default role is EMR_AutoScaling_DefaultRole. The IAM role provides a way for the automatic scaling feature to get the required permissions it needs to launch and terminate EC2 instances in an instance group.
1595 */
1596 AutoScalingRole?: XmlString;
1597 /**
1598 * The way that individual Amazon EC2 instances terminate when an automatic scale-in activity occurs or an instance group is resized. TERMINATE_AT_INSTANCE_HOUR indicates that Amazon EMR terminates nodes at the instance-hour boundary, regardless of when the request to terminate the instance was submitted. This option is only available with Amazon EMR 5.1.0 and later and is the default for clusters created using that version. TERMINATE_AT_TASK_COMPLETION indicates that Amazon EMR blacklists and drains tasks from nodes before terminating the Amazon EC2 instances, regardless of the instance-hour boundary. With either behavior, Amazon EMR removes the least active nodes first and blocks instance termination if it could lead to HDFS corruption. TERMINATE_AT_TASK_COMPLETION available only in Amazon EMR version 4.1.0 and later, and is the default for versions of Amazon EMR earlier than 5.1.0.
1599 */
1600 ScaleDownBehavior?: ScaleDownBehavior;
1601 }
1602 export type JobFlowDetailList = JobFlowDetail[];
1603 export type JobFlowExecutionState = "STARTING"|"BOOTSTRAPPING"|"RUNNING"|"WAITING"|"SHUTTING_DOWN"|"TERMINATED"|"COMPLETED"|"FAILED"|string;
1604 export type JobFlowExecutionStateList = JobFlowExecutionState[];
1605 export interface JobFlowExecutionStatusDetail {
1606 /**
1607 * The state of the job flow.
1608 */
1609 State: JobFlowExecutionState;
1610 /**
1611 * The creation date and time of the job flow.
1612 */
1613 CreationDateTime: _Date;
1614 /**
1615 * The start date and time of the job flow.
1616 */
1617 StartDateTime?: _Date;
1618 /**
1619 * The date and time when the job flow was ready to start running bootstrap actions.
1620 */
1621 ReadyDateTime?: _Date;
1622 /**
1623 * The completion date and time of the job flow.
1624 */
1625 EndDateTime?: _Date;
1626 /**
1627 * Description of the job flow last changed state.
1628 */
1629 LastStateChangeReason?: XmlString;
1630 }
1631 export interface JobFlowInstancesConfig {
1632 /**
1633 * The EC2 instance type of the master node.
1634 */
1635 MasterInstanceType?: InstanceType;
1636 /**
1637 * The EC2 instance type of the core and task nodes.
1638 */
1639 SlaveInstanceType?: InstanceType;
1640 /**
1641 * The number of EC2 instances in the cluster.
1642 */
1643 InstanceCount?: Integer;
1644 /**
1645 * Configuration for the instance groups in a cluster.
1646 */
1647 InstanceGroups?: InstanceGroupConfigList;
1648 /**
1649 * The instance fleet configuration is available only in Amazon EMR versions 4.8.0 and later, excluding 5.0.x versions. Describes the EC2 instances and instance configurations for clusters that use the instance fleet configuration.
1650 */
1651 InstanceFleets?: InstanceFleetConfigList;
1652 /**
1653 * The name of the EC2 key pair that can be used to ssh to the master node as the user called "hadoop."
1654 */
1655 Ec2KeyName?: XmlStringMaxLen256;
1656 /**
1657 * The Availability Zone in which the cluster runs.
1658 */
1659 Placement?: PlacementType;
1660 /**
1661 * Specifies whether the cluster should remain available after completing all steps.
1662 */
1663 KeepJobFlowAliveWhenNoSteps?: Boolean;
1664 /**
1665 * Specifies whether to lock the cluster to prevent the Amazon EC2 instances from being terminated by API call, user intervention, or in the event of a job-flow error.
1666 */
1667 TerminationProtected?: Boolean;
1668 /**
1669 * Applies only to Amazon EMR release versions earlier than 4.0. The Hadoop version for the cluster. Valid inputs are "0.18" (deprecated), "0.20" (deprecated), "0.20.205" (deprecated), "1.0.3", "2.2.0", or "2.4.0". If you do not set this value, the default of 0.18 is used, unless the AmiVersion parameter is set in the RunJobFlow call, in which case the default version of Hadoop for that AMI version is used.
1670 */
1671 HadoopVersion?: XmlStringMaxLen256;
1672 /**
1673 * Applies to clusters that use the uniform instance group configuration. To launch the cluster in Amazon Virtual Private Cloud (Amazon VPC), set this parameter to the identifier of the Amazon VPC subnet where you want the cluster to launch. If you do not specify this value and your account supports EC2-Classic, the cluster launches in EC2-Classic.
1674 */
1675 Ec2SubnetId?: XmlStringMaxLen256;
1676 /**
1677 * Applies to clusters that use the instance fleet configuration. When multiple EC2 subnet IDs are specified, Amazon EMR evaluates them and launches instances in the optimal subnet. The instance fleet configuration is available only in Amazon EMR versions 4.8.0 and later, excluding 5.0.x versions.
1678 */
1679 Ec2SubnetIds?: XmlStringMaxLen256List;
1680 /**
1681 * The identifier of the Amazon EC2 security group for the master node.
1682 */
1683 EmrManagedMasterSecurityGroup?: XmlStringMaxLen256;
1684 /**
1685 * The identifier of the Amazon EC2 security group for the core and task nodes.
1686 */
1687 EmrManagedSlaveSecurityGroup?: XmlStringMaxLen256;
1688 /**
1689 * The identifier of the Amazon EC2 security group for the Amazon EMR service to access clusters in VPC private subnets.
1690 */
1691 ServiceAccessSecurityGroup?: XmlStringMaxLen256;
1692 /**
1693 * A list of additional Amazon EC2 security group IDs for the master node.
1694 */
1695 AdditionalMasterSecurityGroups?: SecurityGroupsList;
1696 /**
1697 * A list of additional Amazon EC2 security group IDs for the core and task nodes.
1698 */
1699 AdditionalSlaveSecurityGroups?: SecurityGroupsList;
1700 }
1701 export interface JobFlowInstancesDetail {
1702 /**
1703 * The Amazon EC2 master node instance type.
1704 */
1705 MasterInstanceType: InstanceType;
1706 /**
1707 * The DNS name of the master node. If the cluster is on a private subnet, this is the private DNS name. On a public subnet, this is the public DNS name.
1708 */
1709 MasterPublicDnsName?: XmlString;
1710 /**
1711 * The Amazon EC2 instance identifier of the master node.
1712 */
1713 MasterInstanceId?: XmlString;
1714 /**
1715 * The Amazon EC2 core and task node instance type.
1716 */
1717 SlaveInstanceType: InstanceType;
1718 /**
1719 * The number of Amazon EC2 instances in the cluster. If the value is 1, the same instance serves as both the master and core and task node. If the value is greater than 1, one instance is the master node and all others are core and task nodes.
1720 */
1721 InstanceCount: Integer;
1722 /**
1723 * Details about the instance groups in a cluster.
1724 */
1725 InstanceGroups?: InstanceGroupDetailList;
1726 /**
1727 * An approximation of the cost of the cluster, represented in m1.small/hours. This value is incremented one time for every hour that an m1.small runs. Larger instances are weighted more, so an Amazon EC2 instance that is roughly four times more expensive would result in the normalized instance hours being incremented by four. This result is only an approximation and does not reflect the actual billing rate.
1728 */
1729 NormalizedInstanceHours?: Integer;
1730 /**
1731 * The name of an Amazon EC2 key pair that can be used to ssh to the master node.
1732 */
1733 Ec2KeyName?: XmlStringMaxLen256;
1734 /**
1735 * For clusters launched within Amazon Virtual Private Cloud, this is the identifier of the subnet where the cluster was launched.
1736 */
1737 Ec2SubnetId?: XmlStringMaxLen256;
1738 /**
1739 * The Amazon EC2 Availability Zone for the cluster.
1740 */
1741 Placement?: PlacementType;
1742 /**
1743 * Specifies whether the cluster should remain available after completing all steps.
1744 */
1745 KeepJobFlowAliveWhenNoSteps?: Boolean;
1746 /**
1747 * Specifies whether the Amazon EC2 instances in the cluster are protected from termination by API calls, user intervention, or in the event of a job-flow error.
1748 */
1749 TerminationProtected?: Boolean;
1750 /**
1751 * The Hadoop version for the cluster.
1752 */
1753 HadoopVersion?: XmlStringMaxLen256;
1754 }
1755 export interface KerberosAttributes {
1756 /**
1757 * The name of the Kerberos realm to which all nodes in a cluster belong. For example, EC2.INTERNAL.
1758 */
1759 Realm: XmlStringMaxLen256;
1760 /**
1761 * The password used within the cluster for the kadmin service on the cluster-dedicated KDC, which maintains Kerberos principals, password policies, and keytabs for the cluster.
1762 */
1763 KdcAdminPassword: XmlStringMaxLen256;
1764 /**
1765 * Required only when establishing a cross-realm trust with a KDC in a different realm. The cross-realm principal password, which must be identical across realms.
1766 */
1767 CrossRealmTrustPrincipalPassword?: XmlStringMaxLen256;
1768 /**
1769 * Required only when establishing a cross-realm trust with an Active Directory domain. A user with sufficient privileges to join resources to the domain.
1770 */
1771 ADDomainJoinUser?: XmlStringMaxLen256;
1772 /**
1773 * The Active Directory password for ADDomainJoinUser.
1774 */
1775 ADDomainJoinPassword?: XmlStringMaxLen256;
1776 }
1777 export interface KeyValue {
1778 /**
1779 * The unique identifier of a key value pair.
1780 */
1781 Key?: XmlString;
1782 /**
1783 * The value part of the identified key.
1784 */
1785 Value?: XmlString;
1786 }
1787 export type KeyValueList = KeyValue[];
1788 export interface ListBootstrapActionsInput {
1789 /**
1790 * The cluster identifier for the bootstrap actions to list.
1791 */
1792 ClusterId: ClusterId;
1793 /**
1794 * The pagination token that indicates the next set of results to retrieve.
1795 */
1796 Marker?: Marker;
1797 }
1798 export interface ListBootstrapActionsOutput {
1799 /**
1800 * The bootstrap actions associated with the cluster.
1801 */
1802 BootstrapActions?: CommandList;
1803 /**
1804 * The pagination token that indicates the next set of results to retrieve.
1805 */
1806 Marker?: Marker;
1807 }
1808 export interface ListClustersInput {
1809 /**
1810 * The creation date and time beginning value filter for listing clusters.
1811 */
1812 CreatedAfter?: _Date;
1813 /**
1814 * The creation date and time end value filter for listing clusters.
1815 */
1816 CreatedBefore?: _Date;
1817 /**
1818 * The cluster state filters to apply when listing clusters.
1819 */
1820 ClusterStates?: ClusterStateList;
1821 /**
1822 * The pagination token that indicates the next set of results to retrieve.
1823 */
1824 Marker?: Marker;
1825 }
1826 export interface ListClustersOutput {
1827 /**
1828 * The list of clusters for the account based on the given filters.
1829 */
1830 Clusters?: ClusterSummaryList;
1831 /**
1832 * The pagination token that indicates the next set of results to retrieve.
1833 */
1834 Marker?: Marker;
1835 }
1836 export interface ListInstanceFleetsInput {
1837 /**
1838 * The unique identifier of the cluster.
1839 */
1840 ClusterId: ClusterId;
1841 /**
1842 * The pagination token that indicates the next set of results to retrieve.
1843 */
1844 Marker?: Marker;
1845 }
1846 export interface ListInstanceFleetsOutput {
1847 /**
1848 * The list of instance fleets for the cluster and given filters.
1849 */
1850 InstanceFleets?: InstanceFleetList;
1851 /**
1852 * The pagination token that indicates the next set of results to retrieve.
1853 */
1854 Marker?: Marker;
1855 }
1856 export interface ListInstanceGroupsInput {
1857 /**
1858 * The identifier of the cluster for which to list the instance groups.
1859 */
1860 ClusterId: ClusterId;
1861 /**
1862 * The pagination token that indicates the next set of results to retrieve.
1863 */
1864 Marker?: Marker;
1865 }
1866 export interface ListInstanceGroupsOutput {
1867 /**
1868 * The list of instance groups for the cluster and given filters.
1869 */
1870 InstanceGroups?: InstanceGroupList;
1871 /**
1872 * The pagination token that indicates the next set of results to retrieve.
1873 */
1874 Marker?: Marker;
1875 }
1876 export interface ListInstancesInput {
1877 /**
1878 * The identifier of the cluster for which to list the instances.
1879 */
1880 ClusterId: ClusterId;
1881 /**
1882 * The identifier of the instance group for which to list the instances.
1883 */
1884 InstanceGroupId?: InstanceGroupId;
1885 /**
1886 * The type of instance group for which to list the instances.
1887 */
1888 InstanceGroupTypes?: InstanceGroupTypeList;
1889 /**
1890 * The unique identifier of the instance fleet.
1891 */
1892 InstanceFleetId?: InstanceFleetId;
1893 /**
1894 * The node type of the instance fleet. For example MASTER, CORE, or TASK.
1895 */
1896 InstanceFleetType?: InstanceFleetType;
1897 /**
1898 * A list of instance states that will filter the instances returned with this request.
1899 */
1900 InstanceStates?: InstanceStateList;
1901 /**
1902 * The pagination token that indicates the next set of results to retrieve.
1903 */
1904 Marker?: Marker;
1905 }
1906 export interface ListInstancesOutput {
1907 /**
1908 * The list of instances for the cluster and given filters.
1909 */
1910 Instances?: InstanceList;
1911 /**
1912 * The pagination token that indicates the next set of results to retrieve.
1913 */
1914 Marker?: Marker;
1915 }
1916 export interface ListSecurityConfigurationsInput {
1917 /**
1918 * The pagination token that indicates the set of results to retrieve.
1919 */
1920 Marker?: Marker;
1921 }
1922 export interface ListSecurityConfigurationsOutput {
1923 /**
1924 * The creation date and time, and name, of each security configuration.
1925 */
1926 SecurityConfigurations?: SecurityConfigurationList;
1927 /**
1928 * A pagination token that indicates the next set of results to retrieve. Include the marker in the next ListSecurityConfiguration call to retrieve the next page of results, if required.
1929 */
1930 Marker?: Marker;
1931 }
1932 export interface ListStepsInput {
1933 /**
1934 * The identifier of the cluster for which to list the steps.
1935 */
1936 ClusterId: ClusterId;
1937 /**
1938 * The filter to limit the step list based on certain states.
1939 */
1940 StepStates?: StepStateList;
1941 /**
1942 * The filter to limit the step list based on the identifier of the steps. You can specify a maximum of ten Step IDs. The character constraint applies to the overall length of the array.
1943 */
1944 StepIds?: XmlStringList;
1945 /**
1946 * The pagination token that indicates the next set of results to retrieve.
1947 */
1948 Marker?: Marker;
1949 }
1950 export interface ListStepsOutput {
1951 /**
1952 * The filtered list of steps for the cluster.
1953 */
1954 Steps?: StepSummaryList;
1955 /**
1956 * The pagination token that indicates the next set of results to retrieve.
1957 */
1958 Marker?: Marker;
1959 }
1960 export type Long = number;
1961 export type Marker = string;
1962 export type MarketType = "ON_DEMAND"|"SPOT"|string;
1963 export interface MetricDimension {
1964 /**
1965 * The dimension name.
1966 */
1967 Key?: String;
1968 /**
1969 * The dimension value.
1970 */
1971 Value?: String;
1972 }
1973 export type MetricDimensionList = MetricDimension[];
1974 export interface ModifyClusterInput {
1975 /**
1976 * The unique identifier of the cluster.
1977 */
1978 ClusterId: String;
1979 /**
1980 * The number of steps that can be executed concurrently. You can specify a maximum of 256 steps.
1981 */
1982 StepConcurrencyLevel?: Integer;
1983 }
1984 export interface ModifyClusterOutput {
1985 /**
1986 * The number of steps that can be executed concurrently.
1987 */
1988 StepConcurrencyLevel?: Integer;
1989 }
1990 export interface ModifyInstanceFleetInput {
1991 /**
1992 * The unique identifier of the cluster.
1993 */
1994 ClusterId: ClusterId;
1995 /**
1996 * The unique identifier of the instance fleet.
1997 */
1998 InstanceFleet: InstanceFleetModifyConfig;
1999 }
2000 export interface ModifyInstanceGroupsInput {
2001 /**
2002 * The ID of the cluster to which the instance group belongs.
2003 */
2004 ClusterId?: ClusterId;
2005 /**
2006 * Instance groups to change.
2007 */
2008 InstanceGroups?: InstanceGroupModifyConfigList;
2009 }
2010 export type NewSupportedProductsList = SupportedProductConfig[];
2011 export type NonNegativeDouble = number;
2012 export type OptionalArnType = string;
2013 export interface PlacementType {
2014 /**
2015 * The Amazon EC2 Availability Zone for the cluster. AvailabilityZone is used for uniform instance groups, while AvailabilityZones (plural) is used for instance fleets.
2016 */
2017 AvailabilityZone?: XmlString;
2018 /**
2019 * When multiple Availability Zones are specified, Amazon EMR evaluates them and launches instances in the optimal Availability Zone. AvailabilityZones is used for instance fleets, while AvailabilityZone (singular) is used for uniform instance groups. The instance fleet configuration is available only in Amazon EMR versions 4.8.0 and later, excluding 5.0.x versions.
2020 */
2021 AvailabilityZones?: XmlStringMaxLen256List;
2022 }
2023 export type Port = number;
2024 export interface PortRange {
2025 /**
2026 * The smallest port number in a specified range of port numbers.
2027 */
2028 MinRange: Port;
2029 /**
2030 * The smallest port number in a specified range of port numbers.
2031 */
2032 MaxRange?: Port;
2033 }
2034 export type PortRanges = PortRange[];
2035 export interface PutAutoScalingPolicyInput {
2036 /**
2037 * Specifies the ID of a cluster. The instance group to which the automatic scaling policy is applied is within this cluster.
2038 */
2039 ClusterId: ClusterId;
2040 /**
2041 * Specifies the ID of the instance group to which the automatic scaling policy is applied.
2042 */
2043 InstanceGroupId: InstanceGroupId;
2044 /**
2045 * Specifies the definition of the automatic scaling policy.
2046 */
2047 AutoScalingPolicy: AutoScalingPolicy;
2048 }
2049 export interface PutAutoScalingPolicyOutput {
2050 /**
2051 * Specifies the ID of a cluster. The instance group to which the automatic scaling policy is applied is within this cluster.
2052 */
2053 ClusterId?: ClusterId;
2054 /**
2055 * Specifies the ID of the instance group to which the scaling policy is applied.
2056 */
2057 InstanceGroupId?: InstanceGroupId;
2058 /**
2059 * The automatic scaling policy definition.
2060 */
2061 AutoScalingPolicy?: AutoScalingPolicyDescription;
2062 /**
2063 * The Amazon Resource Name of the cluster.
2064 */
2065 ClusterArn?: ArnType;
2066 }
2067 export interface PutBlockPublicAccessConfigurationInput {
2068 /**
2069 * A configuration for Amazon EMR block public access. The configuration applies to all clusters created in your account for the current Region. The configuration specifies whether block public access is enabled. If block public access is enabled, security groups associated with the cluster cannot have rules that allow inbound traffic from 0.0.0.0/0 or ::/0 on a port, unless the port is specified as an exception using PermittedPublicSecurityGroupRuleRanges in the BlockPublicAccessConfiguration. By default, Port 22 (SSH) is an exception, and public access is allowed on this port. You can change this by updating BlockPublicSecurityGroupRules to remove the exception.
2070 */
2071 BlockPublicAccessConfiguration: BlockPublicAccessConfiguration;
2072 }
2073 export interface PutBlockPublicAccessConfigurationOutput {
2074 }
2075 export interface RemoveAutoScalingPolicyInput {
2076 /**
2077 * Specifies the ID of a cluster. The instance group to which the automatic scaling policy is applied is within this cluster.
2078 */
2079 ClusterId: ClusterId;
2080 /**
2081 * Specifies the ID of the instance group to which the scaling policy is applied.
2082 */
2083 InstanceGroupId: InstanceGroupId;
2084 }
2085 export interface RemoveAutoScalingPolicyOutput {
2086 }
2087 export interface RemoveTagsInput {
2088 /**
2089 * The Amazon EMR resource identifier from which tags will be removed. This value must be a cluster identifier.
2090 */
2091 ResourceId: ResourceId;
2092 /**
2093 * A list of tag keys to remove from a resource.
2094 */
2095 TagKeys: StringList;
2096 }
2097 export interface RemoveTagsOutput {
2098 }
2099 export type RepoUpgradeOnBoot = "SECURITY"|"NONE"|string;
2100 export type ResourceId = string;
2101 export interface RunJobFlowInput {
2102 /**
2103 * The name of the job flow.
2104 */
2105 Name: XmlStringMaxLen256;
2106 /**
2107 * The location in Amazon S3 to write the log files of the job flow. If a value is not provided, logs are not created.
2108 */
2109 LogUri?: XmlString;
2110 /**
2111 * A JSON string for selecting additional features.
2112 */
2113 AdditionalInfo?: XmlString;
2114 /**
2115 * Applies only to Amazon EMR AMI versions 3.x and 2.x. For Amazon EMR releases 4.0 and later, ReleaseLabel is used. To specify a custom AMI, use CustomAmiID.
2116 */
2117 AmiVersion?: XmlStringMaxLen256;
2118 /**
2119 * The Amazon EMR release label, which determines the version of open-source application packages installed on the cluster. Release labels are in the form emr-x.x.x, where x.x.x is an Amazon EMR release version such as emr-5.14.0. For more information about Amazon EMR release versions and included application versions and features, see https://docs.aws.amazon.com/emr/latest/ReleaseGuide/. The release label applies only to Amazon EMR releases version 4.0 and later. Earlier versions use AmiVersion.
2120 */
2121 ReleaseLabel?: XmlStringMaxLen256;
2122 /**
2123 * A specification of the number and type of Amazon EC2 instances.
2124 */
2125 Instances: JobFlowInstancesConfig;
2126 /**
2127 * A list of steps to run.
2128 */
2129 Steps?: StepConfigList;
2130 /**
2131 * A list of bootstrap actions to run before Hadoop starts on the cluster nodes.
2132 */
2133 BootstrapActions?: BootstrapActionConfigList;
2134 /**
2135 * For Amazon EMR releases 3.x and 2.x. For Amazon EMR releases 4.x and later, use Applications. A list of strings that indicates third-party software to use. For more information, see the Amazon EMR Developer Guide. Currently supported values are: "mapr-m3" - launch the job flow using MapR M3 Edition. "mapr-m5" - launch the job flow using MapR M5 Edition.
2136 */
2137 SupportedProducts?: SupportedProductsList;
2138 /**
2139 * For Amazon EMR releases 3.x and 2.x. For Amazon EMR releases 4.x and later, use Applications. A list of strings that indicates third-party software to use with the job flow that accepts a user argument list. EMR accepts and forwards the argument list to the corresponding installation script as bootstrap action arguments. For more information, see "Launch a Job Flow on the MapR Distribution for Hadoop" in the Amazon EMR Developer Guide. 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 job flow using MapR M3 or M5 Edition respectively. "mapr-m7" - launch the cluster using MapR M7 Edition. "hunk" - launch the cluster with the Hunk Big Data Analtics Platform. "hue"- launch the cluster with Hue installed. "spark" - launch the cluster with Apache Spark installed. "ganglia" - launch the cluster with the Ganglia Monitoring System installed.
2140 */
2141 NewSupportedProducts?: NewSupportedProductsList;
2142 /**
2143 * Applies to Amazon EMR releases 4.0 and later. A case-insensitive list of applications for Amazon EMR to install and configure when launching the cluster. For a list of applications available for each Amazon EMR release version, see the Amazon EMR Release Guide.
2144 */
2145 Applications?: ApplicationList;
2146 /**
2147 * For Amazon EMR releases 4.0 and later. The list of configurations supplied for the EMR cluster you are creating.
2148 */
2149 Configurations?: ConfigurationList;
2150 /**
2151 * A value of true indicates that all IAM users in the AWS account can perform cluster actions if they have the proper IAM policy permissions. This is the default. A value of false indicates that only the IAM user who created the cluster can perform actions.
2152 */
2153 VisibleToAllUsers?: Boolean;
2154 /**
2155 * Also called instance profile and EC2 role. An IAM role for an EMR cluster. The EC2 instances of the cluster assume this role. The default role is EMR_EC2_DefaultRole. In order to use the default role, you must have already created it using the CLI or console.
2156 */
2157 JobFlowRole?: XmlString;
2158 /**
2159 * The IAM role that will be assumed by the Amazon EMR service to access AWS resources on your behalf.
2160 */
2161 ServiceRole?: XmlString;
2162 /**
2163 * A list of tags to associate with a cluster and propagate to Amazon EC2 instances.
2164 */
2165 Tags?: TagList;
2166 /**
2167 * The name of a security configuration to apply to the cluster.
2168 */
2169 SecurityConfiguration?: XmlString;
2170 /**
2171 * An IAM role for automatic scaling policies. The default role is EMR_AutoScaling_DefaultRole. The IAM role provides permissions that the automatic scaling feature requires to launch and terminate EC2 instances in an instance group.
2172 */
2173 AutoScalingRole?: XmlString;
2174 /**
2175 * Specifies the way that individual Amazon EC2 instances terminate when an automatic scale-in activity occurs or an instance group is resized. TERMINATE_AT_INSTANCE_HOUR indicates that Amazon EMR terminates nodes at the instance-hour boundary, regardless of when the request to terminate the instance was submitted. This option is only available with Amazon EMR 5.1.0 and later and is the default for clusters created using that version. TERMINATE_AT_TASK_COMPLETION indicates that Amazon EMR blacklists and drains tasks from nodes before terminating the Amazon EC2 instances, regardless of the instance-hour boundary. With either behavior, Amazon EMR removes the least active nodes first and blocks instance termination if it could lead to HDFS corruption. TERMINATE_AT_TASK_COMPLETION available only in Amazon EMR version 4.1.0 and later, and is the default for versions of Amazon EMR earlier than 5.1.0.
2176 */
2177 ScaleDownBehavior?: ScaleDownBehavior;
2178 /**
2179 * Available only in Amazon EMR version 5.7.0 and later. The ID of a custom Amazon EBS-backed Linux AMI. If specified, Amazon EMR uses this AMI when it launches cluster EC2 instances. For more information about custom AMIs in Amazon EMR, see Using a Custom AMI in the Amazon EMR Management Guide. If omitted, the cluster uses the base Linux AMI for the ReleaseLabel specified. For Amazon EMR versions 2.x and 3.x, use AmiVersion instead. For information about creating a custom AMI, see Creating an Amazon EBS-Backed Linux AMI in the Amazon Elastic Compute Cloud User Guide for Linux Instances. For information about finding an AMI ID, see Finding a Linux AMI.
2180 */
2181 CustomAmiId?: XmlStringMaxLen256;
2182 /**
2183 * The size, in GiB, of the EBS root device volume of the Linux AMI that is used for each EC2 instance. Available in Amazon EMR version 4.x and later.
2184 */
2185 EbsRootVolumeSize?: Integer;
2186 /**
2187 * Applies only when CustomAmiID is used. Specifies which updates from the Amazon Linux AMI package repositories to apply automatically when the instance boots using the AMI. If omitted, the default is SECURITY, which indicates that only security updates are applied. If NONE is specified, no updates are applied, and all updates must be applied manually.
2188 */
2189 RepoUpgradeOnBoot?: RepoUpgradeOnBoot;
2190 /**
2191 * 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.
2192 */
2193 KerberosAttributes?: KerberosAttributes;
2194 /**
2195 * Specifies the number of steps that can be executed concurrently. The default value is 1. The maximum value is 256.
2196 */
2197 StepConcurrencyLevel?: Integer;
2198 }
2199 export interface RunJobFlowOutput {
2200 /**
2201 * An unique identifier for the job flow.
2202 */
2203 JobFlowId?: XmlStringMaxLen256;
2204 /**
2205 * The Amazon Resource Name of the cluster.
2206 */
2207 ClusterArn?: ArnType;
2208 }
2209 export type ScaleDownBehavior = "TERMINATE_AT_INSTANCE_HOUR"|"TERMINATE_AT_TASK_COMPLETION"|string;
2210 export interface ScalingAction {
2211 /**
2212 * Not available for instance groups. Instance groups use the market type specified for the group.
2213 */
2214 Market?: MarketType;
2215 /**
2216 * The type of adjustment the automatic scaling activity makes when triggered, and the periodicity of the adjustment.
2217 */
2218 SimpleScalingPolicyConfiguration: SimpleScalingPolicyConfiguration;
2219 }
2220 export interface ScalingConstraints {
2221 /**
2222 * The lower boundary of EC2 instances in an instance group below which scaling activities are not allowed to shrink. Scale-in activities will not terminate instances below this boundary.
2223 */
2224 MinCapacity: Integer;
2225 /**
2226 * The upper boundary of EC2 instances in an instance group beyond which scaling activities are not allowed to grow. Scale-out activities will not add instances beyond this boundary.
2227 */
2228 MaxCapacity: Integer;
2229 }
2230 export interface ScalingRule {
2231 /**
2232 * The name used to identify an automatic scaling rule. Rule names must be unique within a scaling policy.
2233 */
2234 Name: String;
2235 /**
2236 * A friendly, more verbose description of the automatic scaling rule.
2237 */
2238 Description?: String;
2239 /**
2240 * The conditions that trigger an automatic scaling activity.
2241 */
2242 Action: ScalingAction;
2243 /**
2244 * The CloudWatch alarm definition that determines when automatic scaling activity is triggered.
2245 */
2246 Trigger: ScalingTrigger;
2247 }
2248 export type ScalingRuleList = ScalingRule[];
2249 export interface ScalingTrigger {
2250 /**
2251 * The definition of a CloudWatch metric alarm. When the defined alarm conditions are met along with other trigger parameters, scaling activity begins.
2252 */
2253 CloudWatchAlarmDefinition: CloudWatchAlarmDefinition;
2254 }
2255 export interface ScriptBootstrapActionConfig {
2256 /**
2257 * Location of the script to run during a bootstrap action. Can be either a location in Amazon S3 or on a local file system.
2258 */
2259 Path: XmlString;
2260 /**
2261 * A list of command line arguments to pass to the bootstrap action script.
2262 */
2263 Args?: XmlStringList;
2264 }
2265 export type SecurityConfigurationList = SecurityConfigurationSummary[];
2266 export interface SecurityConfigurationSummary {
2267 /**
2268 * The name of the security configuration.
2269 */
2270 Name?: XmlString;
2271 /**
2272 * The date and time the security configuration was created.
2273 */
2274 CreationDateTime?: _Date;
2275 }
2276 export type SecurityGroupsList = XmlStringMaxLen256[];
2277 export interface SetTerminationProtectionInput {
2278 /**
2279 * A list of strings that uniquely identify the clusters to protect. This identifier is returned by RunJobFlow and can also be obtained from DescribeJobFlows .
2280 */
2281 JobFlowIds: XmlStringList;
2282 /**
2283 * A Boolean that indicates whether to protect the cluster and prevent the Amazon EC2 instances in the cluster from shutting down due to API calls, user intervention, or job-flow error.
2284 */
2285 TerminationProtected: Boolean;
2286 }
2287 export interface SetVisibleToAllUsersInput {
2288 /**
2289 * The unique identifier of the job flow (cluster).
2290 */
2291 JobFlowIds: XmlStringList;
2292 /**
2293 * A value of true indicates that all IAM users in the AWS account can perform cluster actions if they have the proper IAM policy permissions. This is the default. A value of false indicates that only the IAM user who created the cluster can perform actions.
2294 */
2295 VisibleToAllUsers: Boolean;
2296 }
2297 export interface ShrinkPolicy {
2298 /**
2299 * The desired timeout for decommissioning an instance. Overrides the default YARN decommissioning timeout.
2300 */
2301 DecommissionTimeout?: Integer;
2302 /**
2303 * Custom policy for requesting termination protection or termination of specific instances when shrinking an instance group.
2304 */
2305 InstanceResizePolicy?: InstanceResizePolicy;
2306 }
2307 export interface SimpleScalingPolicyConfiguration {
2308 /**
2309 * The way in which EC2 instances are added (if ScalingAdjustment is a positive number) or terminated (if ScalingAdjustment is a negative number) each time the scaling activity is triggered. CHANGE_IN_CAPACITY is the default. CHANGE_IN_CAPACITY indicates that the EC2 instance count increments or decrements by ScalingAdjustment, which should be expressed as an integer. PERCENT_CHANGE_IN_CAPACITY indicates the instance count increments or decrements by the percentage specified by ScalingAdjustment, which should be expressed as an integer. For example, 20 indicates an increase in 20% increments of cluster capacity. EXACT_CAPACITY indicates the scaling activity results in an instance group with the number of EC2 instances specified by ScalingAdjustment, which should be expressed as a positive integer.
2310 */
2311 AdjustmentType?: AdjustmentType;
2312 /**
2313 * The amount by which to scale in or scale out, based on the specified AdjustmentType. A positive value adds to the instance group's EC2 instance count while a negative number removes instances. If AdjustmentType is set to EXACT_CAPACITY, the number should only be a positive integer. If AdjustmentType is set to PERCENT_CHANGE_IN_CAPACITY, the value should express the percentage as an integer. For example, -20 indicates a decrease in 20% increments of cluster capacity.
2314 */
2315 ScalingAdjustment: Integer;
2316 /**
2317 * The amount of time, in seconds, after a scaling activity completes before any further trigger-related scaling activities can start. The default value is 0.
2318 */
2319 CoolDown?: Integer;
2320 }
2321 export interface SpotProvisioningSpecification {
2322 /**
2323 * The spot provisioning timeout period in minutes. If Spot instances are not provisioned within this time period, the TimeOutAction is taken. Minimum value is 5 and maximum value is 1440. The timeout applies only during initial provisioning, when the cluster is first created.
2324 */
2325 TimeoutDurationMinutes: WholeNumber;
2326 /**
2327 * The action to take when TargetSpotCapacity has not been fulfilled when the TimeoutDurationMinutes has expired; that is, when all Spot instances could not be provisioned within the Spot provisioning timeout. Valid values are TERMINATE_CLUSTER and SWITCH_TO_ON_DEMAND. SWITCH_TO_ON_DEMAND specifies that if no Spot instances are available, On-Demand Instances should be provisioned to fulfill any remaining Spot capacity.
2328 */
2329 TimeoutAction: SpotProvisioningTimeoutAction;
2330 /**
2331 * The defined duration for Spot instances (also known as Spot blocks) in minutes. When specified, the Spot instance does not terminate before the defined duration expires, and defined duration pricing for Spot instances applies. Valid values are 60, 120, 180, 240, 300, or 360. The duration period starts as soon as a Spot instance receives its instance ID. At the end of the duration, Amazon EC2 marks the Spot instance for termination and provides a Spot instance termination notice, which gives the instance a two-minute warning before it terminates.
2332 */
2333 BlockDurationMinutes?: WholeNumber;
2334 }
2335 export type SpotProvisioningTimeoutAction = "SWITCH_TO_ON_DEMAND"|"TERMINATE_CLUSTER"|string;
2336 export type Statistic = "SAMPLE_COUNT"|"AVERAGE"|"SUM"|"MINIMUM"|"MAXIMUM"|string;
2337 export interface Step {
2338 /**
2339 * The identifier of the cluster step.
2340 */
2341 Id?: StepId;
2342 /**
2343 * The name of the cluster step.
2344 */
2345 Name?: String;
2346 /**
2347 * The Hadoop job configuration of the cluster step.
2348 */
2349 Config?: HadoopStepConfig;
2350 /**
2351 * The action to take when the cluster step fails. Possible values are TERMINATE_CLUSTER, CANCEL_AND_WAIT, and CONTINUE. TERMINATE_JOB_FLOW is provided for backward compatibility. We recommend using TERMINATE_CLUSTER instead.
2352 */
2353 ActionOnFailure?: ActionOnFailure;
2354 /**
2355 * The current execution status details of the cluster step.
2356 */
2357 Status?: StepStatus;
2358 }
2359 export type StepCancellationOption = "SEND_INTERRUPT"|"TERMINATE_PROCESS"|string;
2360 export interface StepConfig {
2361 /**
2362 * The name of the step.
2363 */
2364 Name: XmlStringMaxLen256;
2365 /**
2366 * The action to take when the cluster step fails. Possible values are TERMINATE_CLUSTER, CANCEL_AND_WAIT, and CONTINUE. TERMINATE_JOB_FLOW is provided for backward compatibility. We recommend using TERMINATE_CLUSTER instead.
2367 */
2368 ActionOnFailure?: ActionOnFailure;
2369 /**
2370 * The JAR file used for the step.
2371 */
2372 HadoopJarStep: HadoopJarStepConfig;
2373 }
2374 export type StepConfigList = StepConfig[];
2375 export interface StepDetail {
2376 /**
2377 * The step configuration.
2378 */
2379 StepConfig: StepConfig;
2380 /**
2381 * The description of the step status.
2382 */
2383 ExecutionStatusDetail: StepExecutionStatusDetail;
2384 }
2385 export type StepDetailList = StepDetail[];
2386 export type StepExecutionState = "PENDING"|"RUNNING"|"CONTINUE"|"COMPLETED"|"CANCELLED"|"FAILED"|"INTERRUPTED"|string;
2387 export interface StepExecutionStatusDetail {
2388 /**
2389 * The state of the step.
2390 */
2391 State: StepExecutionState;
2392 /**
2393 * The creation date and time of the step.
2394 */
2395 CreationDateTime: _Date;
2396 /**
2397 * The start date and time of the step.
2398 */
2399 StartDateTime?: _Date;
2400 /**
2401 * The completion date and time of the step.
2402 */
2403 EndDateTime?: _Date;
2404 /**
2405 * A description of the step's current state.
2406 */
2407 LastStateChangeReason?: XmlString;
2408 }
2409 export type StepId = string;
2410 export type StepIdsList = XmlStringMaxLen256[];
2411 export type StepState = "PENDING"|"CANCEL_PENDING"|"RUNNING"|"COMPLETED"|"CANCELLED"|"FAILED"|"INTERRUPTED"|string;
2412 export interface StepStateChangeReason {
2413 /**
2414 * The programmable code for the state change reason. Note: Currently, the service provides no code for the state change.
2415 */
2416 Code?: StepStateChangeReasonCode;
2417 /**
2418 * The descriptive message for the state change reason.
2419 */
2420 Message?: String;
2421 }
2422 export type StepStateChangeReasonCode = "NONE"|string;
2423 export type StepStateList = StepState[];
2424 export interface StepStatus {
2425 /**
2426 * The execution state of the cluster step.
2427 */
2428 State?: StepState;
2429 /**
2430 * The reason for the step execution status change.
2431 */
2432 StateChangeReason?: StepStateChangeReason;
2433 /**
2434 * The details for the step failure including reason, message, and log file path where the root cause was identified.
2435 */
2436 FailureDetails?: FailureDetails;
2437 /**
2438 * The timeline of the cluster step status over time.
2439 */
2440 Timeline?: StepTimeline;
2441 }
2442 export interface StepSummary {
2443 /**
2444 * The identifier of the cluster step.
2445 */
2446 Id?: StepId;
2447 /**
2448 * The name of the cluster step.
2449 */
2450 Name?: String;
2451 /**
2452 * The Hadoop job configuration of the cluster step.
2453 */
2454 Config?: HadoopStepConfig;
2455 /**
2456 * The action to take when the cluster step fails. Possible values are TERMINATE_CLUSTER, CANCEL_AND_WAIT, and CONTINUE. TERMINATE_JOB_FLOW is available for backward compatibility. We recommend using TERMINATE_CLUSTER instead.
2457 */
2458 ActionOnFailure?: ActionOnFailure;
2459 /**
2460 * The current execution status details of the cluster step.
2461 */
2462 Status?: StepStatus;
2463 }
2464 export type StepSummaryList = StepSummary[];
2465 export interface StepTimeline {
2466 /**
2467 * The date and time when the cluster step was created.
2468 */
2469 CreationDateTime?: _Date;
2470 /**
2471 * The date and time when the cluster step execution started.
2472 */
2473 StartDateTime?: _Date;
2474 /**
2475 * The date and time when the cluster step execution completed or failed.
2476 */
2477 EndDateTime?: _Date;
2478 }
2479 export type String = string;
2480 export type StringList = String[];
2481 export type StringMap = {[key: string]: String};
2482 export interface SupportedProductConfig {
2483 /**
2484 * The name of the product configuration.
2485 */
2486 Name?: XmlStringMaxLen256;
2487 /**
2488 * The list of user-supplied arguments.
2489 */
2490 Args?: XmlStringList;
2491 }
2492 export type SupportedProductsList = XmlStringMaxLen256[];
2493 export interface Tag {
2494 /**
2495 * A user-defined key, which is the minimum required information for a valid tag. For more information, see Tag .
2496 */
2497 Key?: String;
2498 /**
2499 * A user-defined value, which is optional in a tag. For more information, see Tag Clusters.
2500 */
2501 Value?: String;
2502 }
2503 export type TagList = Tag[];
2504 export interface TerminateJobFlowsInput {
2505 /**
2506 * A list of job flows to be shutdown.
2507 */
2508 JobFlowIds: XmlStringList;
2509 }
2510 export type Unit = "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"|string;
2511 export interface VolumeSpecification {
2512 /**
2513 * The volume type. Volume types supported are gp2, io1, standard.
2514 */
2515 VolumeType: String;
2516 /**
2517 * The number of I/O operations per second (IOPS) that the volume supports.
2518 */
2519 Iops?: Integer;
2520 /**
2521 * The volume size, in gibibytes (GiB). This can be a number from 1 - 1024. If the volume type is EBS-optimized, the minimum value is 10.
2522 */
2523 SizeInGB: Integer;
2524 }
2525 export type WholeNumber = number;
2526 export type XmlString = string;
2527 export type XmlStringList = XmlString[];
2528 export type XmlStringMaxLen256 = string;
2529 export type XmlStringMaxLen256List = XmlStringMaxLen256[];
2530 /**
2531 * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
2532 */
2533 export type apiVersion = "2009-03-31"|"latest"|string;
2534 export interface ClientApiVersions {
2535 /**
2536 * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
2537 */
2538 apiVersion?: apiVersion;
2539 }
2540 export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions;
2541 /**
2542 * Contains interfaces for use with the EMR client.
2543 */
2544 export import Types = EMR;
2545}
2546export = EMR;