openapi: 3.0.0 info: version: 2009-03-31 x-release: v4 title: Amazon EMR description: Amazon EMR is a web service that makes it easier to process large amounts of data efficiently. Amazon EMR uses Hadoop processing combined with several Amazon Web Services services to do tasks such as web indexing, data mining, log file analysis, machine learning, scientific simulation, and data warehouse management. x-logo: url: https://api.apis.guru/v2/cache/logo/https_twitter.com_awscloud_profile_image.png backgroundColor: "#FFFFFF" termsOfService: https://aws.amazon.com/service-terms/ contact: name: Mike Ralphson email: mike.ralphson@gmail.com url: https://github.com/mermade/aws2openapi x-twitter: PermittedSoc license: name: Apache 2.0 License url: http://www.apache.org/licenses/ x-providerName: amazonaws.com x-serviceName: elasticmapreduce x-origin: - contentType: application/json url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/elasticmapreduce-2009-03-31.normal.json converter: url: https://github.com/mermade/aws2openapi version: 1.0.0 x-apisguru-driver: external x-apiClientRegistration: url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct x-apisguru-categories: - cloud x-preferred: true externalDocs: description: Amazon Web Services documentation url: https://docs.aws.amazon.com/elasticmapreduce/ servers: - url: http://elasticmapreduce.{region}.amazonaws.com variables: region: description: The AWS region enum: - us-east-1 - us-east-2 - us-west-1 - us-west-2 - us-gov-west-1 - us-gov-east-1 - ca-central-1 - eu-north-1 - eu-west-1 - eu-west-2 - eu-west-3 - eu-central-1 - eu-south-1 - af-south-1 - ap-northeast-1 - ap-northeast-2 - ap-northeast-3 - ap-southeast-1 - ap-southeast-2 - ap-east-1 - ap-south-1 - sa-east-1 - me-south-1 default: us-east-1 description: The Amazon EMR multi-region endpoint - url: https://elasticmapreduce.{region}.amazonaws.com variables: region: description: The AWS region enum: - us-east-1 - us-east-2 - us-west-1 - us-west-2 - us-gov-west-1 - us-gov-east-1 - ca-central-1 - eu-north-1 - eu-west-1 - eu-west-2 - eu-west-3 - eu-central-1 - eu-south-1 - af-south-1 - ap-northeast-1 - ap-northeast-2 - ap-northeast-3 - ap-southeast-1 - ap-southeast-2 - ap-east-1 - ap-south-1 - sa-east-1 - me-south-1 default: us-east-1 description: The Amazon EMR multi-region endpoint - url: http://elasticmapreduce.amazonaws.com variables: {} description: The general Amazon EMR endpoint for US West (Oregon) - url: https://elasticmapreduce.amazonaws.com variables: {} description: The general Amazon EMR endpoint for US West (Oregon) - url: http://elasticmapreduce.{region}.amazonaws.com.cn variables: region: description: The AWS region enum: - cn-north-1 - cn-northwest-1 default: cn-north-1 description: The Amazon EMR endpoint for China (Beijing) and China (Ningxia) - url: https://elasticmapreduce.{region}.amazonaws.com.cn variables: region: description: The AWS region enum: - cn-north-1 - cn-northwest-1 default: cn-north-1 description: The Amazon EMR endpoint for China (Beijing) and China (Ningxia) x-hasEquivalentPaths: true paths: /#X-Amz-Target=ElasticMapReduce.AddInstanceFleet: post: operationId: AddInstanceFleet description:
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.
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.
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.
The string values passed into HadoopJarStep
object cannot exceed a total of 10240 characters.
PENDING
or RUNNING
state. In earlier versions of Amazon EMR, you can only cancel steps that are in a PENDING
state. "
responses:
"200":
description: Success
content:
application/json:
schema:
$ref: "#/components/schemas/CancelStepsOutput"
"480":
description: InternalServerError
content:
application/json:
schema:
$ref: "#/components/schemas/InternalServerError"
"481":
description: InvalidRequestException
content:
application/json:
schema:
$ref: "#/components/schemas/InvalidRequestException"
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/CancelStepsInput"
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- ElasticMapReduce.CancelSteps
parameters:
- $ref: "#/components/parameters/X-Amz-Content-Sha256"
- $ref: "#/components/parameters/X-Amz-Date"
- $ref: "#/components/parameters/X-Amz-Algorithm"
- $ref: "#/components/parameters/X-Amz-Credential"
- $ref: "#/components/parameters/X-Amz-Security-Token"
- $ref: "#/components/parameters/X-Amz-Signature"
- $ref: "#/components/parameters/X-Amz-SignedHeaders"
/#X-Amz-Target=ElasticMapReduce.CreateSecurityConfiguration:
post:
operationId: CreateSecurityConfiguration
description: Creates a security configuration, which is stored in the service and can be specified when a cluster is created.
responses:
"200":
description: Success
content:
application/json:
schema:
$ref: "#/components/schemas/CreateSecurityConfigurationOutput"
"480":
description: InternalServerException
content:
application/json:
schema:
$ref: "#/components/schemas/InternalServerException"
"481":
description: InvalidRequestException
content:
application/json:
schema:
$ref: "#/components/schemas/InvalidRequestException"
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/CreateSecurityConfigurationInput"
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- ElasticMapReduce.CreateSecurityConfiguration
parameters:
- $ref: "#/components/parameters/X-Amz-Content-Sha256"
- $ref: "#/components/parameters/X-Amz-Date"
- $ref: "#/components/parameters/X-Amz-Algorithm"
- $ref: "#/components/parameters/X-Amz-Credential"
- $ref: "#/components/parameters/X-Amz-Security-Token"
- $ref: "#/components/parameters/X-Amz-Signature"
- $ref: "#/components/parameters/X-Amz-SignedHeaders"
/#X-Amz-Target=ElasticMapReduce.CreateStudio:
post:
operationId: CreateStudio
description: Creates a new Amazon EMR Studio.
responses:
"200":
description: Success
content:
application/json:
schema:
$ref: "#/components/schemas/CreateStudioOutput"
"480":
description: InternalServerException
content:
application/json:
schema:
$ref: "#/components/schemas/InternalServerException"
"481":
description: InvalidRequestException
content:
application/json:
schema:
$ref: "#/components/schemas/InvalidRequestException"
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/CreateStudioInput"
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- ElasticMapReduce.CreateStudio
parameters:
- $ref: "#/components/parameters/X-Amz-Content-Sha256"
- $ref: "#/components/parameters/X-Amz-Date"
- $ref: "#/components/parameters/X-Amz-Algorithm"
- $ref: "#/components/parameters/X-Amz-Credential"
- $ref: "#/components/parameters/X-Amz-Security-Token"
- $ref: "#/components/parameters/X-Amz-Signature"
- $ref: "#/components/parameters/X-Amz-SignedHeaders"
/#X-Amz-Target=ElasticMapReduce.CreateStudioSessionMapping:
post:
operationId: CreateStudioSessionMapping
description: Maps a user or group to the Amazon EMR Studio specified by StudioId
, and applies a session policy to refine Studio permissions for that user or group. Use CreateStudioSessionMapping
to assign users to a Studio when you use IAM Identity Center authentication. For instructions on how to assign users to a Studio when you use IAM authentication, see Assign a user or group to your EMR Studio.
responses:
"200":
description: Success
"480":
description: InternalServerError
content:
application/json:
schema:
$ref: "#/components/schemas/InternalServerError"
"481":
description: InvalidRequestException
content:
application/json:
schema:
$ref: "#/components/schemas/InvalidRequestException"
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/CreateStudioSessionMappingInput"
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- ElasticMapReduce.CreateStudioSessionMapping
parameters:
- $ref: "#/components/parameters/X-Amz-Content-Sha256"
- $ref: "#/components/parameters/X-Amz-Date"
- $ref: "#/components/parameters/X-Amz-Algorithm"
- $ref: "#/components/parameters/X-Amz-Credential"
- $ref: "#/components/parameters/X-Amz-Security-Token"
- $ref: "#/components/parameters/X-Amz-Signature"
- $ref: "#/components/parameters/X-Amz-SignedHeaders"
/#X-Amz-Target=ElasticMapReduce.DeleteSecurityConfiguration:
post:
operationId: DeleteSecurityConfiguration
description: Deletes a security configuration.
responses:
"200":
description: Success
content:
application/json:
schema:
$ref: "#/components/schemas/DeleteSecurityConfigurationOutput"
"480":
description: InternalServerException
content:
application/json:
schema:
$ref: "#/components/schemas/InternalServerException"
"481":
description: InvalidRequestException
content:
application/json:
schema:
$ref: "#/components/schemas/InvalidRequestException"
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/DeleteSecurityConfigurationInput"
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- ElasticMapReduce.DeleteSecurityConfiguration
parameters:
- $ref: "#/components/parameters/X-Amz-Content-Sha256"
- $ref: "#/components/parameters/X-Amz-Date"
- $ref: "#/components/parameters/X-Amz-Algorithm"
- $ref: "#/components/parameters/X-Amz-Credential"
- $ref: "#/components/parameters/X-Amz-Security-Token"
- $ref: "#/components/parameters/X-Amz-Signature"
- $ref: "#/components/parameters/X-Amz-SignedHeaders"
/#X-Amz-Target=ElasticMapReduce.DeleteStudio:
post:
operationId: DeleteStudio
description: Removes an Amazon EMR Studio from the Studio metadata store.
responses:
"200":
description: Success
"480":
description: InternalServerException
content:
application/json:
schema:
$ref: "#/components/schemas/InternalServerException"
"481":
description: InvalidRequestException
content:
application/json:
schema:
$ref: "#/components/schemas/InvalidRequestException"
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/DeleteStudioInput"
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- ElasticMapReduce.DeleteStudio
parameters:
- $ref: "#/components/parameters/X-Amz-Content-Sha256"
- $ref: "#/components/parameters/X-Amz-Date"
- $ref: "#/components/parameters/X-Amz-Algorithm"
- $ref: "#/components/parameters/X-Amz-Credential"
- $ref: "#/components/parameters/X-Amz-Security-Token"
- $ref: "#/components/parameters/X-Amz-Signature"
- $ref: "#/components/parameters/X-Amz-SignedHeaders"
/#X-Amz-Target=ElasticMapReduce.DeleteStudioSessionMapping:
post:
operationId: DeleteStudioSessionMapping
description: Removes a user or group from an Amazon EMR Studio.
responses:
"200":
description: Success
"480":
description: InternalServerError
content:
application/json:
schema:
$ref: "#/components/schemas/InternalServerError"
"481":
description: InvalidRequestException
content:
application/json:
schema:
$ref: "#/components/schemas/InvalidRequestException"
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/DeleteStudioSessionMappingInput"
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- ElasticMapReduce.DeleteStudioSessionMapping
parameters:
- $ref: "#/components/parameters/X-Amz-Content-Sha256"
- $ref: "#/components/parameters/X-Amz-Date"
- $ref: "#/components/parameters/X-Amz-Algorithm"
- $ref: "#/components/parameters/X-Amz-Credential"
- $ref: "#/components/parameters/X-Amz-Security-Token"
- $ref: "#/components/parameters/X-Amz-Signature"
- $ref: "#/components/parameters/X-Amz-SignedHeaders"
/#X-Amz-Target=ElasticMapReduce.DescribeCluster:
post:
operationId: DescribeCluster
description: Provides cluster-level details including status, hardware and software configuration, VPC settings, and so on.
responses:
"200":
description: Success
content:
application/json:
schema:
$ref: "#/components/schemas/DescribeClusterOutput"
"480":
description: InternalServerException
content:
application/json:
schema:
$ref: "#/components/schemas/InternalServerException"
"481":
description: InvalidRequestException
content:
application/json:
schema:
$ref: "#/components/schemas/InvalidRequestException"
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/DescribeClusterInput"
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- ElasticMapReduce.DescribeCluster
parameters:
- $ref: "#/components/parameters/X-Amz-Content-Sha256"
- $ref: "#/components/parameters/X-Amz-Date"
- $ref: "#/components/parameters/X-Amz-Algorithm"
- $ref: "#/components/parameters/X-Amz-Credential"
- $ref: "#/components/parameters/X-Amz-Security-Token"
- $ref: "#/components/parameters/X-Amz-Signature"
- $ref: "#/components/parameters/X-Amz-SignedHeaders"
/#X-Amz-Target=ElasticMapReduce.DescribeJobFlows:
post:
deprecated: true
operationId: DescribeJobFlows
description: "This API is no longer supported 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.
" responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/DescribeJobFlowsOutput" "480": description: InternalServerError content: application/json: schema: $ref: "#/components/schemas/InternalServerError" requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/DescribeJobFlowsInput" parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - ElasticMapReduce.DescribeJobFlows parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" /#X-Amz-Target=ElasticMapReduce.DescribeNotebookExecution: post: operationId: DescribeNotebookExecution description: Provides details of a notebook execution. responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/DescribeNotebookExecutionOutput" "480": description: InternalServerError content: application/json: schema: $ref: "#/components/schemas/InternalServerError" "481": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/DescribeNotebookExecutionInput" parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - ElasticMapReduce.DescribeNotebookExecution parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" /#X-Amz-Target=ElasticMapReduce.DescribeReleaseLabel: post: operationId: DescribeReleaseLabel description: Provides EMR release label details, such as releases available the region where the API request is run, and the available applications for a specific EMR release label. Can also list EMR release versions that support a specified version of Spark. responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/DescribeReleaseLabelOutput" "480": description: InternalServerException content: application/json: schema: $ref: "#/components/schemas/InternalServerException" "481": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/DescribeReleaseLabelInput" parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - ElasticMapReduce.DescribeReleaseLabel parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" /#X-Amz-Target=ElasticMapReduce.DescribeSecurityConfiguration: post: operationId: DescribeSecurityConfiguration description: Provides the details of a security configuration by returning the configuration JSON. responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/DescribeSecurityConfigurationOutput" "480": description: InternalServerException content: application/json: schema: $ref: "#/components/schemas/InternalServerException" "481": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/DescribeSecurityConfigurationInput" parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - ElasticMapReduce.DescribeSecurityConfiguration parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" /#X-Amz-Target=ElasticMapReduce.DescribeStep: post: operationId: DescribeStep description: Provides more detail about the cluster step. responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/DescribeStepOutput" "480": description: InternalServerException content: application/json: schema: $ref: "#/components/schemas/InternalServerException" "481": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/DescribeStepInput" parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - ElasticMapReduce.DescribeStep parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" /#X-Amz-Target=ElasticMapReduce.DescribeStudio: post: operationId: DescribeStudio description: Returns details for the specified Amazon EMR Studio including ID, Name, VPC, Studio access URL, and so on. responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/DescribeStudioOutput" "480": description: InternalServerException content: application/json: schema: $ref: "#/components/schemas/InternalServerException" "481": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/DescribeStudioInput" parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - ElasticMapReduce.DescribeStudio parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" /#X-Amz-Target=ElasticMapReduce.GetAutoTerminationPolicy: post: operationId: GetAutoTerminationPolicy description: Returns the auto-termination policy for an Amazon EMR cluster. responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/GetAutoTerminationPolicyOutput" requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/GetAutoTerminationPolicyInput" parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - ElasticMapReduce.GetAutoTerminationPolicy parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" /#X-Amz-Target=ElasticMapReduce.GetBlockPublicAccessConfiguration: post: operationId: GetBlockPublicAccessConfiguration description: Returns the Amazon EMR block public access configuration for your Amazon Web Services account in the current Region. For more information see Configure Block Public Access for Amazon EMR in the Amazon EMR Management Guide. responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/GetBlockPublicAccessConfigurationOutput" "480": description: InternalServerException content: application/json: schema: $ref: "#/components/schemas/InternalServerException" "481": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/GetBlockPublicAccessConfigurationInput" parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - ElasticMapReduce.GetBlockPublicAccessConfiguration parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" /#X-Amz-Target=ElasticMapReduce.GetClusterSessionCredentials: post: operationId: GetClusterSessionCredentials description: Provides temporary, HTTP basic credentials that are associated with a given runtime IAM role and used by a cluster with fine-grained access control activated. You can use these credentials to connect to cluster endpoints that support username and password authentication. responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/GetClusterSessionCredentialsOutput" "480": description: InternalServerError content: application/json: schema: $ref: "#/components/schemas/InternalServerError" "481": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/GetClusterSessionCredentialsInput" parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - ElasticMapReduce.GetClusterSessionCredentials parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" /#X-Amz-Target=ElasticMapReduce.GetManagedScalingPolicy: post: operationId: GetManagedScalingPolicy description: "Fetches the attached managed scaling policy for an Amazon EMR cluster. " responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/GetManagedScalingPolicyOutput" requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/GetManagedScalingPolicyInput" parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - ElasticMapReduce.GetManagedScalingPolicy parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" /#X-Amz-Target=ElasticMapReduce.GetStudioSessionMapping: post: operationId: GetStudioSessionMapping description: Fetches mapping details for the specified Amazon EMR Studio and identity (user or group). responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/GetStudioSessionMappingOutput" "480": description: InternalServerError content: application/json: schema: $ref: "#/components/schemas/InternalServerError" "481": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/GetStudioSessionMappingInput" parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - ElasticMapReduce.GetStudioSessionMapping parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" /#X-Amz-Target=ElasticMapReduce.ListBootstrapActions: post: operationId: ListBootstrapActions description: Provides information about the bootstrap actions associated with a cluster. responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/ListBootstrapActionsOutput" "480": description: InternalServerException content: application/json: schema: $ref: "#/components/schemas/InternalServerException" "481": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/ListBootstrapActionsInput" parameters: - name: Marker in: query schema: type: string description: Pagination token required: false - name: X-Amz-Target in: header required: true schema: type: string enum: - ElasticMapReduce.ListBootstrapActions parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" /#X-Amz-Target=ElasticMapReduce.ListClusters: post: operationId: ListClusters description: Provides the status of all clusters visible to this Amazon Web Services 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 in unsorted order per call, but returns a marker to track the paging of the cluster list across multiple ListClusters calls. responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/ListClustersOutput" "480": description: InternalServerException content: application/json: schema: $ref: "#/components/schemas/InternalServerException" "481": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/ListClustersInput" parameters: - name: Marker in: query schema: type: string description: Pagination token required: false - name: X-Amz-Target in: header required: true schema: type: string enum: - ElasticMapReduce.ListClusters parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" /#X-Amz-Target=ElasticMapReduce.ListInstanceFleets: post: operationId: ListInstanceFleets description: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.
ListNotebookExecution
calls.
responses:
"200":
description: Success
content:
application/json:
schema:
$ref: "#/components/schemas/ListNotebookExecutionsOutput"
"480":
description: InternalServerError
content:
application/json:
schema:
$ref: "#/components/schemas/InternalServerError"
"481":
description: InvalidRequestException
content:
application/json:
schema:
$ref: "#/components/schemas/InvalidRequestException"
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/ListNotebookExecutionsInput"
parameters:
- name: Marker
in: query
schema:
type: string
description: Pagination token
required: false
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- ElasticMapReduce.ListNotebookExecutions
parameters:
- $ref: "#/components/parameters/X-Amz-Content-Sha256"
- $ref: "#/components/parameters/X-Amz-Date"
- $ref: "#/components/parameters/X-Amz-Algorithm"
- $ref: "#/components/parameters/X-Amz-Credential"
- $ref: "#/components/parameters/X-Amz-Security-Token"
- $ref: "#/components/parameters/X-Amz-Signature"
- $ref: "#/components/parameters/X-Amz-SignedHeaders"
/#X-Amz-Target=ElasticMapReduce.ListReleaseLabels:
post:
operationId: ListReleaseLabels
description: Retrieves release labels of EMR services in the region where the API is called.
responses:
"200":
description: Success
content:
application/json:
schema:
$ref: "#/components/schemas/ListReleaseLabelsOutput"
"480":
description: InternalServerException
content:
application/json:
schema:
$ref: "#/components/schemas/InternalServerException"
"481":
description: InvalidRequestException
content:
application/json:
schema:
$ref: "#/components/schemas/InvalidRequestException"
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/ListReleaseLabelsInput"
parameters:
- name: MaxResults
in: query
schema:
type: string
description: Pagination limit
required: false
- name: NextToken
in: query
schema:
type: string
description: Pagination token
required: false
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- ElasticMapReduce.ListReleaseLabels
parameters:
- $ref: "#/components/parameters/X-Amz-Content-Sha256"
- $ref: "#/components/parameters/X-Amz-Date"
- $ref: "#/components/parameters/X-Amz-Algorithm"
- $ref: "#/components/parameters/X-Amz-Credential"
- $ref: "#/components/parameters/X-Amz-Security-Token"
- $ref: "#/components/parameters/X-Amz-Signature"
- $ref: "#/components/parameters/X-Amz-SignedHeaders"
/#X-Amz-Target=ElasticMapReduce.ListSecurityConfigurations:
post:
operationId: ListSecurityConfigurations
description: 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.
responses:
"200":
description: Success
content:
application/json:
schema:
$ref: "#/components/schemas/ListSecurityConfigurationsOutput"
"480":
description: InternalServerException
content:
application/json:
schema:
$ref: "#/components/schemas/InternalServerException"
"481":
description: InvalidRequestException
content:
application/json:
schema:
$ref: "#/components/schemas/InvalidRequestException"
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/ListSecurityConfigurationsInput"
parameters:
- name: Marker
in: query
schema:
type: string
description: Pagination token
required: false
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- ElasticMapReduce.ListSecurityConfigurations
parameters:
- $ref: "#/components/parameters/X-Amz-Content-Sha256"
- $ref: "#/components/parameters/X-Amz-Date"
- $ref: "#/components/parameters/X-Amz-Algorithm"
- $ref: "#/components/parameters/X-Amz-Credential"
- $ref: "#/components/parameters/X-Amz-Security-Token"
- $ref: "#/components/parameters/X-Amz-Signature"
- $ref: "#/components/parameters/X-Amz-SignedHeaders"
/#X-Amz-Target=ElasticMapReduce.ListSteps:
post:
operationId: ListSteps
description: Provides a list of steps for the cluster in reverse order unless you specify stepIds
with the request or filter by StepStates
. You can specify a maximum of 10 stepIDs
. The CLI automatically paginates results to return a list greater than 50 steps. To return more than 50 steps using the CLI, specify a Marker
, which is a pagination token that indicates the next set of steps to retrieve.
responses:
"200":
description: Success
content:
application/json:
schema:
$ref: "#/components/schemas/ListStepsOutput"
"480":
description: InternalServerException
content:
application/json:
schema:
$ref: "#/components/schemas/InternalServerException"
"481":
description: InvalidRequestException
content:
application/json:
schema:
$ref: "#/components/schemas/InvalidRequestException"
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/ListStepsInput"
parameters:
- name: Marker
in: query
schema:
type: string
description: Pagination token
required: false
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- ElasticMapReduce.ListSteps
parameters:
- $ref: "#/components/parameters/X-Amz-Content-Sha256"
- $ref: "#/components/parameters/X-Amz-Date"
- $ref: "#/components/parameters/X-Amz-Algorithm"
- $ref: "#/components/parameters/X-Amz-Credential"
- $ref: "#/components/parameters/X-Amz-Security-Token"
- $ref: "#/components/parameters/X-Amz-Signature"
- $ref: "#/components/parameters/X-Amz-SignedHeaders"
/#X-Amz-Target=ElasticMapReduce.ListStudioSessionMappings:
post:
operationId: ListStudioSessionMappings
description: Returns a list of all user or group session mappings for the Amazon EMR Studio specified by StudioId
.
responses:
"200":
description: Success
content:
application/json:
schema:
$ref: "#/components/schemas/ListStudioSessionMappingsOutput"
"480":
description: InternalServerError
content:
application/json:
schema:
$ref: "#/components/schemas/InternalServerError"
"481":
description: InvalidRequestException
content:
application/json:
schema:
$ref: "#/components/schemas/InvalidRequestException"
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/ListStudioSessionMappingsInput"
parameters:
- name: Marker
in: query
schema:
type: string
description: Pagination token
required: false
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- ElasticMapReduce.ListStudioSessionMappings
parameters:
- $ref: "#/components/parameters/X-Amz-Content-Sha256"
- $ref: "#/components/parameters/X-Amz-Date"
- $ref: "#/components/parameters/X-Amz-Algorithm"
- $ref: "#/components/parameters/X-Amz-Credential"
- $ref: "#/components/parameters/X-Amz-Security-Token"
- $ref: "#/components/parameters/X-Amz-Signature"
- $ref: "#/components/parameters/X-Amz-SignedHeaders"
/#X-Amz-Target=ElasticMapReduce.ListStudios:
post:
operationId: ListStudios
description: Returns a list of all Amazon EMR Studios associated with the Amazon Web Services account. The list includes details such as ID, Studio Access URL, and creation time for each Studio.
responses:
"200":
description: Success
content:
application/json:
schema:
$ref: "#/components/schemas/ListStudiosOutput"
"480":
description: InternalServerException
content:
application/json:
schema:
$ref: "#/components/schemas/InternalServerException"
"481":
description: InvalidRequestException
content:
application/json:
schema:
$ref: "#/components/schemas/InvalidRequestException"
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/ListStudiosInput"
parameters:
- name: Marker
in: query
schema:
type: string
description: Pagination token
required: false
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- ElasticMapReduce.ListStudios
parameters:
- $ref: "#/components/parameters/X-Amz-Content-Sha256"
- $ref: "#/components/parameters/X-Amz-Date"
- $ref: "#/components/parameters/X-Amz-Algorithm"
- $ref: "#/components/parameters/X-Amz-Credential"
- $ref: "#/components/parameters/X-Amz-Security-Token"
- $ref: "#/components/parameters/X-Amz-Signature"
- $ref: "#/components/parameters/X-Amz-SignedHeaders"
/#X-Amz-Target=ElasticMapReduce.ModifyCluster:
post:
operationId: ModifyCluster
description: Modifies the number of steps that can be executed concurrently for the cluster specified using ClusterID.
responses:
"200":
description: Success
content:
application/json:
schema:
$ref: "#/components/schemas/ModifyClusterOutput"
"480":
description: InternalServerError
content:
application/json:
schema:
$ref: "#/components/schemas/InternalServerError"
"481":
description: InvalidRequestException
content:
application/json:
schema:
$ref: "#/components/schemas/InvalidRequestException"
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/ModifyClusterInput"
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- ElasticMapReduce.ModifyCluster
parameters:
- $ref: "#/components/parameters/X-Amz-Content-Sha256"
- $ref: "#/components/parameters/X-Amz-Date"
- $ref: "#/components/parameters/X-Amz-Algorithm"
- $ref: "#/components/parameters/X-Amz-Credential"
- $ref: "#/components/parameters/X-Amz-Security-Token"
- $ref: "#/components/parameters/X-Amz-Signature"
- $ref: "#/components/parameters/X-Amz-SignedHeaders"
/#X-Amz-Target=ElasticMapReduce.ModifyInstanceFleet:
post:
operationId: ModifyInstanceFleet
description: 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.
Auto-termination is supported in Amazon EMR versions 5.30.0 and 6.1.0 and later. For more information, see Using an auto-termination policy.
Creates or updates an auto-termination policy for an Amazon EMR cluster. An auto-termination policy defines the amount of idle time in seconds after which a cluster automatically terminates. For alternative cluster termination options, see Control cluster termination.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/PutAutoTerminationPolicyOutput" requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/PutAutoTerminationPolicyInput" parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - ElasticMapReduce.PutAutoTerminationPolicy parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" /#X-Amz-Target=ElasticMapReduce.PutBlockPublicAccessConfiguration: post: operationId: PutBlockPublicAccessConfiguration description: Creates or updates an Amazon EMR block public access configuration for your Amazon Web Services account in the current Region. For more information see Configure Block Public Access for Amazon EMR in the Amazon EMR Management Guide. responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/PutBlockPublicAccessConfigurationOutput" "480": description: InternalServerException content: application/json: schema: $ref: "#/components/schemas/InternalServerException" "481": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/PutBlockPublicAccessConfigurationInput" parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - ElasticMapReduce.PutBlockPublicAccessConfiguration parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" /#X-Amz-Target=ElasticMapReduce.PutManagedScalingPolicy: post: operationId: PutManagedScalingPolicy description: "Creates or updates a managed scaling policy for an Amazon EMR cluster. The managed scaling policy defines the limits for resources, such as EC2 instances that can be added or terminated from a cluster. The policy only applies to the core and task nodes. The master node cannot be scaled after initial configuration. " responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/PutManagedScalingPolicyOutput" requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/PutManagedScalingPolicyInput" parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - ElasticMapReduce.PutManagedScalingPolicy parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" /#X-Amz-Target=ElasticMapReduce.RemoveAutoScalingPolicy: post: operationId: RemoveAutoScalingPolicy description: Removes an automatic scaling policy from a specified instance group within an EMR cluster. responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/RemoveAutoScalingPolicyOutput" requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/RemoveAutoScalingPolicyInput" parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - ElasticMapReduce.RemoveAutoScalingPolicy parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" /#X-Amz-Target=ElasticMapReduce.RemoveAutoTerminationPolicy: post: operationId: RemoveAutoTerminationPolicy description: Removes an auto-termination policy from an Amazon EMR cluster. responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/RemoveAutoTerminationPolicyOutput" requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/RemoveAutoTerminationPolicyInput" parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - ElasticMapReduce.RemoveAutoTerminationPolicy parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" /#X-Amz-Target=ElasticMapReduce.RemoveManagedScalingPolicy: post: operationId: RemoveManagedScalingPolicy description: " Removes a managed scaling policy from a specified EMR cluster. " responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/RemoveManagedScalingPolicyOutput" requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/RemoveManagedScalingPolicyInput" parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - ElasticMapReduce.RemoveManagedScalingPolicy parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" /#X-Amz-Target=ElasticMapReduce.RemoveTags: post: operationId: RemoveTags description:Removes tags from an Amazon EMR resource, such as a cluster or Amazon EMR Studio. Tags make it easier to associate resources 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:
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/RemoveTagsOutput" "480": description: InternalServerException content: application/json: schema: $ref: "#/components/schemas/InternalServerException" "481": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/RemoveTagsInput" parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - ElasticMapReduce.RemoveTags parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" /#X-Amz-Target=ElasticMapReduce.RunJobFlow: post: operationId: RunJobFlow description: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 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.
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.
responses: "200": description: Success "480": description: InternalServerError content: application/json: schema: $ref: "#/components/schemas/InternalServerError" requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/SetTerminationProtectionInput" parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - ElasticMapReduce.SetTerminationProtection parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" /#X-Amz-Target=ElasticMapReduce.SetVisibleToAllUsers: post: operationId: SetVisibleToAllUsers description:The SetVisibleToAllUsers parameter is no longer supported. Your cluster may be visible to all users in your account. To restrict cluster access using an IAM policy, see Identity and Access Management for EMR.
Sets the Cluster$VisibleToAllUsers value for an EMR cluster. When true
, IAM principals in the Amazon Web Services account can perform EMR cluster actions that their IAM policies allow. When false
, only the IAM principal that created the cluster and the Amazon Web Services account root user can perform EMR actions on the cluster, regardless of IAM permissions policies attached to other IAM principals.
This action works on running clusters. When you create a cluster, use the RunJobFlowInput$VisibleToAllUsers parameter.
For more information, see Understanding the EMR Cluster VisibleToAllUsers Setting in the Amazon EMRManagement Guide.
responses: "200": description: Success "480": description: InternalServerError content: application/json: schema: $ref: "#/components/schemas/InternalServerError" requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/SetVisibleToAllUsersInput" parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - ElasticMapReduce.SetVisibleToAllUsers parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" /#X-Amz-Target=ElasticMapReduce.StartNotebookExecution: post: operationId: StartNotebookExecution description: Starts a notebook execution. responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/StartNotebookExecutionOutput" "480": description: InternalServerException content: application/json: schema: $ref: "#/components/schemas/InternalServerException" "481": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/StartNotebookExecutionInput" parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - ElasticMapReduce.StartNotebookExecution parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" /#X-Amz-Target=ElasticMapReduce.StopNotebookExecution: post: operationId: StopNotebookExecution description: Stops a notebook execution. responses: "200": description: Success "480": description: InternalServerError content: application/json: schema: $ref: "#/components/schemas/InternalServerError" "481": description: InvalidRequestException content: application/json: schema: $ref: "#/components/schemas/InvalidRequestException" requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/StopNotebookExecutionInput" parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - ElasticMapReduce.StopNotebookExecution parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" /#X-Amz-Target=ElasticMapReduce.TerminateJobFlows: post: operationId: TerminateJobFlows description: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.
The Amazon Resource Name (ARN) of the runtime role for a step on the cluster. The runtime role can be a cross-account IAM role. The runtime role ARN is a combination of account ID, role name, and role type using the following format: arn:partition:service:region:account:resource
.
For example, arn:aws:iam::1234567890:role/ReadOnly
is a correctly formatted runtime role ARN.
StepID
specified.
description: " The output for the CancelSteps operation. "
CancelStepsInput:
type: object
required:
- ClusterId
- StepIds
title: CancelStepsInput
properties:
ClusterId:
allOf:
- $ref: "#/components/schemas/XmlStringMaxLen256"
- description: "The ClusterID
for the specified steps that will be canceled. Use RunJobFlow and ListClusters to get ClusterIDs. "
StepIds:
allOf:
- $ref: "#/components/schemas/StepIdsList"
- description: The list of StepIDs
to cancel. Use ListSteps to get steps and their states for the specified cluster.
StepCancellationOption:
allOf:
- $ref: "#/components/schemas/StepCancellationOption"
- description: The option to choose to cancel RUNNING
steps. By default, the value is SEND_INTERRUPT
.
description: The input argument to the CancelSteps operation.
CreateSecurityConfigurationOutput:
type: object
required:
- Name
- CreationDateTime
properties:
Name:
allOf:
- $ref: "#/components/schemas/XmlString"
- description: The name of the security configuration.
CreationDateTime:
allOf:
- $ref: "#/components/schemas/Date"
- description: The date and time the security configuration was created.
CreateSecurityConfigurationInput:
type: object
required:
- Name
- SecurityConfiguration
title: CreateSecurityConfigurationInput
properties:
Name:
allOf:
- $ref: "#/components/schemas/XmlString"
- description: The name of the security configuration.
SecurityConfiguration:
allOf:
- $ref: "#/components/schemas/String"
- description: 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.
CreateStudioOutput:
type: object
properties:
StudioId:
allOf:
- $ref: "#/components/schemas/XmlStringMaxLen256"
- description: The ID of the Amazon EMR Studio.
Url:
allOf:
- $ref: "#/components/schemas/XmlString"
- description: The unique Studio access URL.
CreateStudioInput:
type: object
required:
- Name
- AuthMode
- VpcId
- SubnetIds
- ServiceRole
- WorkspaceSecurityGroupId
- EngineSecurityGroupId
- DefaultS3Location
title: CreateStudioInput
properties:
Name:
allOf:
- $ref: "#/components/schemas/XmlStringMaxLen256"
- description: A descriptive name for the Amazon EMR Studio.
Description:
allOf:
- $ref: "#/components/schemas/XmlStringMaxLen256"
- description: A detailed description of the Amazon EMR Studio.
AuthMode:
allOf:
- $ref: "#/components/schemas/AuthMode"
- description: Specifies whether the Studio authenticates users using IAM or IAM Identity Center.
VpcId:
allOf:
- $ref: "#/components/schemas/XmlStringMaxLen256"
- description: The ID of the Amazon Virtual Private Cloud (Amazon VPC) to associate with the Studio.
SubnetIds:
allOf:
- $ref: "#/components/schemas/SubnetIdList"
- description: A list of subnet IDs to associate with the Amazon EMR Studio. A Studio can have a maximum of 5 subnets. The subnets must belong to the VPC specified by VpcId
. Studio users can create a Workspace in any of the specified subnets.
ServiceRole:
allOf:
- $ref: "#/components/schemas/XmlString"
- description: The IAM role that the Amazon EMR Studio assumes. The service role provides a way for Amazon EMR Studio to interoperate with other Amazon Web Services services.
UserRole:
allOf:
- $ref: "#/components/schemas/XmlString"
- description: The IAM user role that users and groups assume when logged in to an Amazon EMR Studio. Only specify a UserRole
when you use IAM Identity Center authentication. The permissions attached to the UserRole
can be scoped down for each user or group using session policies.
WorkspaceSecurityGroupId:
allOf:
- $ref: "#/components/schemas/XmlStringMaxLen256"
- description: The ID of the Amazon EMR Studio Workspace security group. The Workspace security group allows outbound network traffic to resources in the Engine security group, and it must be in the same VPC specified by VpcId
.
EngineSecurityGroupId:
allOf:
- $ref: "#/components/schemas/XmlStringMaxLen256"
- description: The ID of the Amazon EMR Studio Engine security group. The Engine security group allows inbound network traffic from the Workspace security group, and it must be in the same VPC specified by VpcId
.
DefaultS3Location:
allOf:
- $ref: "#/components/schemas/XmlString"
- description: The Amazon S3 location to back up Amazon EMR Studio Workspaces and notebook files.
IdpAuthUrl:
allOf:
- $ref: "#/components/schemas/XmlString"
- description: The authentication endpoint of your identity provider (IdP). Specify this value when you use IAM authentication and want to let federated users log in to a Studio with the Studio URL and credentials from your IdP. Amazon EMR Studio redirects users to this endpoint to enter credentials.
IdpRelayStateParameterName:
allOf:
- $ref: "#/components/schemas/XmlStringMaxLen256"
- description: The name that your identity provider (IdP) uses for its RelayState
parameter. For example, RelayState
or TargetSource
. Specify this value when you use IAM authentication and want to let federated users log in to a Studio using the Studio URL. The RelayState
parameter differs by IdP.
Tags:
allOf:
- $ref: "#/components/schemas/TagList"
- description: A list of tags to associate with the Amazon EMR Studio. 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.
CreateStudioSessionMappingInput:
type: object
required:
- StudioId
- IdentityType
- SessionPolicyArn
title: CreateStudioSessionMappingInput
properties:
StudioId:
allOf:
- $ref: "#/components/schemas/XmlStringMaxLen256"
- description: The ID of the Amazon EMR Studio to which the user or group will be mapped.
IdentityId:
allOf:
- $ref: "#/components/schemas/XmlStringMaxLen256"
- description: The globally unique identifier (GUID) of the user or group from the IAM Identity Center Identity Store. For more information, see UserId and GroupId in the IAM Identity Center Identity Store API Reference. Either IdentityName
or IdentityId
must be specified, but not both.
IdentityName:
allOf:
- $ref: "#/components/schemas/XmlStringMaxLen256"
- description: The name of the user or group. For more information, see UserName and DisplayName in the IAM Identity Center Identity Store API Reference. Either IdentityName
or IdentityId
must be specified, but not both.
IdentityType:
allOf:
- $ref: "#/components/schemas/IdentityType"
- description: Specifies whether the identity to map to the Amazon EMR Studio is a user or a group.
SessionPolicyArn:
allOf:
- $ref: "#/components/schemas/XmlStringMaxLen256"
- description: The Amazon Resource Name (ARN) for the session policy that will be applied to the user or group. You should specify the ARN for the session policy that you want to apply, not the ARN of your user role. For more information, see Create an EMR Studio User Role with Session Policies.
DeleteSecurityConfigurationOutput:
type: object
properties: {}
DeleteSecurityConfigurationInput:
type: object
required:
- Name
title: DeleteSecurityConfigurationInput
properties:
Name:
allOf:
- $ref: "#/components/schemas/XmlString"
- description: The name of the security configuration.
DeleteStudioInput:
type: object
required:
- StudioId
title: DeleteStudioInput
properties:
StudioId:
allOf:
- $ref: "#/components/schemas/XmlStringMaxLen256"
- description: The ID of the Amazon EMR Studio.
DeleteStudioSessionMappingInput:
type: object
required:
- StudioId
- IdentityType
title: DeleteStudioSessionMappingInput
properties:
StudioId:
allOf:
- $ref: "#/components/schemas/XmlStringMaxLen256"
- description: The ID of the Amazon EMR Studio.
IdentityId:
allOf:
- $ref: "#/components/schemas/XmlStringMaxLen256"
- description: The globally unique identifier (GUID) of the user or group to remove from the Amazon EMR Studio. For more information, see UserId and GroupId in the IAM Identity Center Identity Store API Reference. Either IdentityName
or IdentityId
must be specified.
IdentityName:
allOf:
- $ref: "#/components/schemas/XmlStringMaxLen256"
- description: The name of the user name or group to remove from the Amazon EMR Studio. For more information, see UserName and DisplayName in the IAM Identity Center Store API Reference. Either IdentityName
or IdentityId
must be specified.
IdentityType:
allOf:
- $ref: "#/components/schemas/IdentityType"
- description: Specifies whether the identity to delete from the Amazon EMR Studio is a user or a group.
DescribeClusterOutput:
type: object
properties:
Cluster:
allOf:
- $ref: "#/components/schemas/Cluster"
- description: This output contains the details for the requested cluster.
description: This output contains the description of the cluster.
DescribeClusterInput:
type: object
required:
- ClusterId
title: DescribeClusterInput
properties:
ClusterId:
allOf:
- $ref: "#/components/schemas/ClusterId"
- description: The identifier of the cluster to describe.
description: This input determines which cluster to describe.
DescribeJobFlowsOutput:
type: object
properties:
JobFlows:
allOf:
- $ref: "#/components/schemas/JobFlowDetailList"
- description: A list of job flows matching the parameters supplied.
description: " The output for the DescribeJobFlows operation. "
DescribeJobFlowsInput:
type: object
title: DescribeJobFlowsInput
properties:
CreatedAfter:
allOf:
- $ref: "#/components/schemas/Date"
- description: Return only job flows created after this date and time.
CreatedBefore:
allOf:
- $ref: "#/components/schemas/Date"
- description: Return only job flows created before this date and time.
JobFlowIds:
allOf:
- $ref: "#/components/schemas/XmlStringList"
- description: Return only job flows whose job flow ID is contained in this list.
JobFlowStates:
allOf:
- $ref: "#/components/schemas/JobFlowExecutionStateList"
- description: Return only job flows whose state is contained in this list.
description: " The input for the DescribeJobFlows operation. "
DescribeNotebookExecutionOutput:
type: object
properties:
NotebookExecution:
allOf:
- $ref: "#/components/schemas/NotebookExecution"
- description: Properties of the notebook execution.
DescribeNotebookExecutionInput:
type: object
required:
- NotebookExecutionId
title: DescribeNotebookExecutionInput
properties:
NotebookExecutionId:
allOf:
- $ref: "#/components/schemas/XmlStringMaxLen256"
- description: The unique identifier of the notebook execution.
DescribeReleaseLabelOutput:
type: object
properties:
ReleaseLabel:
allOf:
- $ref: "#/components/schemas/String"
- description: The target release label described in the response.
Applications:
allOf:
- $ref: "#/components/schemas/SimplifiedApplicationList"
- description: The list of applications available for the target release label. Name
is the name of the application. Version
is the concise version of the application.
NextToken:
allOf:
- $ref: "#/components/schemas/String"
- description: The pagination token. Reserved for future use. Currently set to null.
AvailableOSReleases:
allOf:
- $ref: "#/components/schemas/OSReleaseList"
- description: The list of available Amazon Linux release versions for an Amazon EMR release. Contains a Label field that is formatted as shown in Amazon Linux 2 Release Notes . For example, 2.0.20220218.1.
DescribeReleaseLabelInput:
type: object
title: DescribeReleaseLabelInput
properties:
ReleaseLabel:
allOf:
- $ref: "#/components/schemas/String"
- description: The target release label to be described.
NextToken:
allOf:
- $ref: "#/components/schemas/String"
- description: The pagination token. Reserved for future use. Currently set to null.
MaxResults:
allOf:
- $ref: "#/components/schemas/MaxResultsNumber"
- description: Reserved for future use. Currently set to null.
DescribeSecurityConfigurationOutput:
type: object
properties:
Name:
allOf:
- $ref: "#/components/schemas/XmlString"
- description: The name of the security configuration.
SecurityConfiguration:
allOf:
- $ref: "#/components/schemas/String"
- description: The security configuration details in JSON format.
CreationDateTime:
allOf:
- $ref: "#/components/schemas/Date"
- description: The date and time the security configuration was created
DescribeSecurityConfigurationInput:
type: object
required:
- Name
title: DescribeSecurityConfigurationInput
properties:
Name:
allOf:
- $ref: "#/components/schemas/XmlString"
- description: The name of the security configuration.
DescribeStepOutput:
type: object
properties:
Step:
allOf:
- $ref: "#/components/schemas/Step"
- description: The step details for the requested step identifier.
description: This output contains the description of the cluster step.
DescribeStepInput:
type: object
required:
- ClusterId
- StepId
title: DescribeStepInput
properties:
ClusterId:
allOf:
- $ref: "#/components/schemas/ClusterId"
- description: The identifier of the cluster with steps to describe.
StepId:
allOf:
- $ref: "#/components/schemas/StepId"
- description: The identifier of the step to describe.
description: This input determines which step to describe.
DescribeStudioOutput:
type: object
properties:
Studio:
allOf:
- $ref: "#/components/schemas/Studio"
- description: The Amazon EMR Studio details.
DescribeStudioInput:
type: object
required:
- StudioId
title: DescribeStudioInput
properties:
StudioId:
allOf:
- $ref: "#/components/schemas/XmlStringMaxLen256"
- description: The Amazon EMR Studio ID.
GetAutoTerminationPolicyOutput:
type: object
properties:
AutoTerminationPolicy:
allOf:
- $ref: "#/components/schemas/AutoTerminationPolicy"
- description: "Specifies the auto-termination policy that is attached to an Amazon EMR cluster. "
GetAutoTerminationPolicyInput:
type: object
required:
- ClusterId
title: GetAutoTerminationPolicyInput
properties:
ClusterId:
allOf:
- $ref: "#/components/schemas/ClusterId"
- description: Specifies the ID of the Amazon EMR cluster for which the auto-termination policy will be fetched.
GetBlockPublicAccessConfigurationOutput:
type: object
required:
- BlockPublicAccessConfiguration
- BlockPublicAccessConfigurationMetadata
properties:
BlockPublicAccessConfiguration:
allOf:
- $ref: "#/components/schemas/BlockPublicAccessConfiguration"
- description: 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.
For accounts that created clusters in a Region before November 25, 2019, block public access is disabled by default in that Region. To use this feature, you must manually enable and configure it. For accounts that did not create an EMR cluster in a Region before this date, block public access is enabled by default in that Region.
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.
GetBlockPublicAccessConfigurationInput:
type: object
title: GetBlockPublicAccessConfigurationInput
properties: {}
GetClusterSessionCredentialsOutput:
type: object
properties:
Credentials:
allOf:
- $ref: "#/components/schemas/Credentials"
- description: The credentials that you can use to connect to cluster endpoints that support username and password authentication.
ExpiresAt:
allOf:
- $ref: "#/components/schemas/Date"
- description: The time when the credentials that are returned by the GetClusterSessionCredentials
API expire.
GetClusterSessionCredentialsInput:
type: object
required:
- ClusterId
- ExecutionRoleArn
title: GetClusterSessionCredentialsInput
properties:
ClusterId:
allOf:
- $ref: "#/components/schemas/XmlStringMaxLen256"
- description: The unique identifier of the cluster.
ExecutionRoleArn:
allOf:
- $ref: "#/components/schemas/ArnType"
- description: "The Amazon Resource Name (ARN) of the runtime role for interactive workload submission on the cluster. The runtime role can be a cross-account IAM role. The runtime role ARN is a combination of account ID, role name, and role type using the following format: arn:partition:service:region:account:resource
."
GetManagedScalingPolicyOutput:
type: object
properties:
ManagedScalingPolicy:
allOf:
- $ref: "#/components/schemas/ManagedScalingPolicy"
- description: "Specifies the managed scaling policy that is attached to an Amazon EMR cluster. "
GetManagedScalingPolicyInput:
type: object
required:
- ClusterId
title: GetManagedScalingPolicyInput
properties:
ClusterId:
allOf:
- $ref: "#/components/schemas/ClusterId"
- description: "Specifies the ID of the cluster for which the managed scaling policy will be fetched. "
GetStudioSessionMappingOutput:
type: object
properties:
SessionMapping:
allOf:
- $ref: "#/components/schemas/SessionMappingDetail"
- description: The session mapping details for the specified Amazon EMR Studio and identity, including session policy ARN and creation time.
GetStudioSessionMappingInput:
type: object
required:
- StudioId
- IdentityType
title: GetStudioSessionMappingInput
properties:
StudioId:
allOf:
- $ref: "#/components/schemas/XmlStringMaxLen256"
- description: The ID of the Amazon EMR Studio.
IdentityId:
allOf:
- $ref: "#/components/schemas/XmlStringMaxLen256"
- description: The globally unique identifier (GUID) of the user or group. For more information, see UserId and GroupId in the IAM Identity Center Identity Store API Reference. Either IdentityName
or IdentityId
must be specified.
IdentityName:
allOf:
- $ref: "#/components/schemas/XmlStringMaxLen256"
- description: The name of the user or group to fetch. For more information, see UserName and DisplayName in the IAM Identity Center Identity Store API Reference. Either IdentityName
or IdentityId
must be specified.
IdentityType:
allOf:
- $ref: "#/components/schemas/IdentityType"
- description: Specifies whether the identity to fetch is a user or a group.
ListBootstrapActionsOutput:
type: object
properties:
BootstrapActions:
allOf:
- $ref: "#/components/schemas/CommandList"
- description: The bootstrap actions associated with the cluster.
Marker:
allOf:
- $ref: "#/components/schemas/Marker"
- description: The pagination token that indicates the next set of results to retrieve.
description: This output contains the bootstrap actions detail.
ListBootstrapActionsInput:
type: object
required:
- ClusterId
title: ListBootstrapActionsInput
properties:
ClusterId:
allOf:
- $ref: "#/components/schemas/ClusterId"
- description: The cluster identifier for the bootstrap actions to list.
Marker:
allOf:
- $ref: "#/components/schemas/Marker"
- description: The pagination token that indicates the next set of results to retrieve.
description: This input determines which bootstrap actions to retrieve.
ListClustersOutput:
type: object
properties:
Clusters:
allOf:
- $ref: "#/components/schemas/ClusterSummaryList"
- description: The list of clusters for the account based on the given filters.
Marker:
allOf:
- $ref: "#/components/schemas/Marker"
- description: The pagination token that indicates the next set of results to retrieve.
description: This contains a ClusterSummaryList with the cluster details; for example, the cluster IDs, names, and status.
ListClustersInput:
type: object
title: ListClustersInput
properties:
CreatedAfter:
allOf:
- $ref: "#/components/schemas/Date"
- description: The creation date and time beginning value filter for listing clusters.
CreatedBefore:
allOf:
- $ref: "#/components/schemas/Date"
- description: The creation date and time end value filter for listing clusters.
ClusterStates:
allOf:
- $ref: "#/components/schemas/ClusterStateList"
- description: The cluster state filters to apply when listing clusters. Clusters that change state while this action runs may be not be returned as expected in the list of clusters.
Marker:
allOf:
- $ref: "#/components/schemas/Marker"
- description: The pagination token that indicates the next set of results to retrieve.
description: This input determines how the ListClusters action filters the list of clusters that it returns.
ListInstanceFleetsOutput:
type: object
properties:
InstanceFleets:
allOf:
- $ref: "#/components/schemas/InstanceFleetList"
- description: The list of instance fleets for the cluster and given filters.
Marker:
allOf:
- $ref: "#/components/schemas/Marker"
- description: The pagination token that indicates the next set of results to retrieve.
ListInstanceFleetsInput:
type: object
required:
- ClusterId
title: ListInstanceFleetsInput
properties:
ClusterId:
allOf:
- $ref: "#/components/schemas/ClusterId"
- description: The unique identifier of the cluster.
Marker:
allOf:
- $ref: "#/components/schemas/Marker"
- description: The pagination token that indicates the next set of results to retrieve.
ListInstanceGroupsOutput:
type: object
properties:
InstanceGroups:
allOf:
- $ref: "#/components/schemas/InstanceGroupList"
- description: The list of instance groups for the cluster and given filters.
Marker:
allOf:
- $ref: "#/components/schemas/Marker"
- description: The pagination token that indicates the next set of results to retrieve.
description: This input determines which instance groups to retrieve.
ListInstanceGroupsInput:
type: object
required:
- ClusterId
title: ListInstanceGroupsInput
properties:
ClusterId:
allOf:
- $ref: "#/components/schemas/ClusterId"
- description: The identifier of the cluster for which to list the instance groups.
Marker:
allOf:
- $ref: "#/components/schemas/Marker"
- description: The pagination token that indicates the next set of results to retrieve.
description: This input determines which instance groups to retrieve.
ListInstancesOutput:
type: object
properties:
Instances:
allOf:
- $ref: "#/components/schemas/InstanceList"
- description: The list of instances for the cluster and given filters.
Marker:
allOf:
- $ref: "#/components/schemas/Marker"
- description: The pagination token that indicates the next set of results to retrieve.
description: This output contains the list of instances.
ListInstancesInput:
type: object
required:
- ClusterId
title: ListInstancesInput
properties:
ClusterId:
allOf:
- $ref: "#/components/schemas/ClusterId"
- description: The identifier of the cluster for which to list the instances.
InstanceGroupId:
allOf:
- $ref: "#/components/schemas/InstanceGroupId"
- description: The identifier of the instance group for which to list the instances.
InstanceGroupTypes:
allOf:
- $ref: "#/components/schemas/InstanceGroupTypeList"
- description: The type of instance group for which to list the instances.
InstanceFleetId:
allOf:
- $ref: "#/components/schemas/InstanceFleetId"
- description: The unique identifier of the instance fleet.
InstanceFleetType:
allOf:
- $ref: "#/components/schemas/InstanceFleetType"
- description: The node type of the instance fleet. For example MASTER, CORE, or TASK.
InstanceStates:
allOf:
- $ref: "#/components/schemas/InstanceStateList"
- description: A list of instance states that will filter the instances returned with this request.
Marker:
allOf:
- $ref: "#/components/schemas/Marker"
- description: The pagination token that indicates the next set of results to retrieve.
description: This input determines which instances to list.
ListNotebookExecutionsOutput:
type: object
properties:
NotebookExecutions:
allOf:
- $ref: "#/components/schemas/NotebookExecutionSummaryList"
- description: A list of notebook executions.
Marker:
allOf:
- $ref: "#/components/schemas/Marker"
- description: A pagination token that a subsequent ListNotebookExecutions
can use to determine the next set of results to retrieve.
ListNotebookExecutionsInput:
type: object
title: ListNotebookExecutionsInput
properties:
EditorId:
allOf:
- $ref: "#/components/schemas/XmlStringMaxLen256"
- description: The unique ID of the editor associated with the notebook execution.
Status:
allOf:
- $ref: "#/components/schemas/NotebookExecutionStatus"
- description: The status filter for listing notebook executions.
START_PENDING
indicates that the cluster has received the execution request but execution has not begun.
STARTING
indicates that the execution is starting on the cluster.
RUNNING
indicates that the execution is being processed by the cluster.
FINISHING
indicates that execution processing is in the final stages.
FINISHED
indicates that the execution has completed without error.
FAILING
indicates that the execution is failing and will not finish successfully.
FAILED
indicates that the execution failed.
STOP_PENDING
indicates that the cluster has received a StopNotebookExecution
request and the stop is pending.
STOPPING
indicates that the cluster is in the process of stopping the execution as a result of a StopNotebookExecution
request.
STOPPED
indicates that the execution stopped because of a StopNotebookExecution
request.
ListNotebookExecutions
call, that indicates the start of the list for this ListNotebookExecutions
call.
ListReleaseLabelsOutput:
type: object
properties:
ReleaseLabels:
allOf:
- $ref: "#/components/schemas/StringList"
- description: The returned release labels.
NextToken:
allOf:
- $ref: "#/components/schemas/String"
- description: Used to paginate the next page of results if specified in the next ListReleaseLabels
request.
ListReleaseLabelsInput:
type: object
title: ListReleaseLabelsInput
properties:
Filters:
allOf:
- $ref: "#/components/schemas/ReleaseLabelFilter"
- description: Filters the results of the request. Prefix
specifies the prefix of release labels to return. Application
specifies the application (with/without version) of release labels to return.
NextToken:
allOf:
- $ref: "#/components/schemas/String"
- description: Specifies the next page of results. If NextToken
is not specified, which is usually the case for the first request of ListReleaseLabels, the first page of results are determined by other filtering parameters or by the latest version. The ListReleaseLabels
request fails if the identity (Amazon Web Services account ID) and all filtering parameters are different from the original request, or if the NextToken
is expired or tampered with.
MaxResults:
allOf:
- $ref: "#/components/schemas/MaxResultsNumber"
- description: Defines the maximum number of release labels to return in a single response. The default is 100
.
ListSecurityConfigurationsOutput:
type: object
properties:
SecurityConfigurations:
allOf:
- $ref: "#/components/schemas/SecurityConfigurationList"
- description: The creation date and time, and name, of each security configuration.
Marker:
allOf:
- $ref: "#/components/schemas/Marker"
- description: 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.
ListSecurityConfigurationsInput:
type: object
title: ListSecurityConfigurationsInput
properties:
Marker:
allOf:
- $ref: "#/components/schemas/Marker"
- description: The pagination token that indicates the set of results to retrieve.
ListStepsOutput:
type: object
properties:
Steps:
allOf:
- $ref: "#/components/schemas/StepSummaryList"
- description: The filtered list of steps for the cluster.
Marker:
allOf:
- $ref: "#/components/schemas/Marker"
- description: The maximum number of steps that a single ListSteps
action returns is 50. To return a longer list of steps, use multiple ListSteps
actions along with the Marker
parameter, which is a pagination token that indicates the next set of results to retrieve.
description: This output contains the list of steps returned in reverse order. This means that the last step is the first element in the list.
ListStepsInput:
type: object
required:
- ClusterId
title: ListStepsInput
properties:
ClusterId:
allOf:
- $ref: "#/components/schemas/ClusterId"
- description: The identifier of the cluster for which to list the steps.
StepStates:
allOf:
- $ref: "#/components/schemas/StepStateList"
- description: The filter to limit the step list based on certain states.
StepIds:
allOf:
- $ref: "#/components/schemas/XmlStringList"
- description: 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.
Marker:
allOf:
- $ref: "#/components/schemas/Marker"
- description: The maximum number of steps that a single ListSteps
action returns is 50. To return a longer list of steps, use multiple ListSteps
actions along with the Marker
parameter, which is a pagination token that indicates the next set of results to retrieve.
description: This input determines which steps to list.
ListStudioSessionMappingsOutput:
type: object
properties:
SessionMappings:
allOf:
- $ref: "#/components/schemas/SessionMappingSummaryList"
- description: A list of session mapping summary objects. Each object includes session mapping details such as creation time, identity type (user or group), and Amazon EMR Studio ID.
Marker:
allOf:
- $ref: "#/components/schemas/Marker"
- description: The pagination token that indicates the next set of results to retrieve.
ListStudioSessionMappingsInput:
type: object
title: ListStudioSessionMappingsInput
properties:
StudioId:
allOf:
- $ref: "#/components/schemas/XmlStringMaxLen256"
- description: The ID of the Amazon EMR Studio.
IdentityType:
allOf:
- $ref: "#/components/schemas/IdentityType"
- description: Specifies whether to return session mappings for users or groups. If not specified, the results include session mapping details for both users and groups.
Marker:
allOf:
- $ref: "#/components/schemas/Marker"
- description: The pagination token that indicates the set of results to retrieve.
ListStudiosOutput:
type: object
properties:
Studios:
allOf:
- $ref: "#/components/schemas/StudioSummaryList"
- description: The list of Studio summary objects.
Marker:
allOf:
- $ref: "#/components/schemas/Marker"
- description: The pagination token that indicates the next set of results to retrieve.
ListStudiosInput:
type: object
title: ListStudiosInput
properties:
Marker:
allOf:
- $ref: "#/components/schemas/Marker"
- description: The pagination token that indicates the set of results to retrieve.
ModifyClusterOutput:
type: object
properties:
StepConcurrencyLevel:
allOf:
- $ref: "#/components/schemas/Integer"
- description: The number of steps that can be executed concurrently.
ModifyClusterInput:
type: object
required:
- ClusterId
title: ModifyClusterInput
properties:
ClusterId:
allOf:
- $ref: "#/components/schemas/String"
- description: The unique identifier of the cluster.
StepConcurrencyLevel:
allOf:
- $ref: "#/components/schemas/Integer"
- description: The number of steps that can be executed concurrently. You can specify a minimum of 1 step and a maximum of 256 steps. We recommend that you do not change this parameter while steps are running or the ActionOnFailure
setting may not behave as expected. For more information see Step$ActionOnFailure.
ModifyInstanceFleetInput:
type: object
required:
- ClusterId
- InstanceFleet
title: ModifyInstanceFleetInput
properties:
ClusterId:
allOf:
- $ref: "#/components/schemas/ClusterId"
- description: The unique identifier of the cluster.
InstanceFleet:
allOf:
- $ref: "#/components/schemas/InstanceFleetModifyConfig"
- description: The configuration parameters of the instance fleet.
ModifyInstanceGroupsInput:
type: object
title: ModifyInstanceGroupsInput
properties:
ClusterId:
allOf:
- $ref: "#/components/schemas/ClusterId"
- description: The ID of the cluster to which the instance group belongs.
InstanceGroups:
allOf:
- $ref: "#/components/schemas/InstanceGroupModifyConfigList"
- description: Instance groups to change.
description: Change the size of some instance groups.
PutAutoScalingPolicyOutput:
type: object
properties:
ClusterId:
allOf:
- $ref: "#/components/schemas/ClusterId"
- description: Specifies the ID of a cluster. The instance group to which the automatic scaling policy is applied is within this cluster.
InstanceGroupId:
allOf:
- $ref: "#/components/schemas/InstanceGroupId"
- description: Specifies the ID of the instance group to which the scaling policy is applied.
AutoScalingPolicy:
allOf:
- $ref: "#/components/schemas/AutoScalingPolicyDescription"
- description: The automatic scaling policy definition.
ClusterArn:
allOf:
- $ref: "#/components/schemas/ArnType"
- description: The Amazon Resource Name (ARN) of the cluster.
PutAutoScalingPolicyInput:
type: object
required:
- ClusterId
- InstanceGroupId
- AutoScalingPolicy
title: PutAutoScalingPolicyInput
properties:
ClusterId:
allOf:
- $ref: "#/components/schemas/ClusterId"
- description: Specifies the ID of a cluster. The instance group to which the automatic scaling policy is applied is within this cluster.
InstanceGroupId:
allOf:
- $ref: "#/components/schemas/InstanceGroupId"
- description: Specifies the ID of the instance group to which the automatic scaling policy is applied.
AutoScalingPolicy:
allOf:
- $ref: "#/components/schemas/AutoScalingPolicy"
- description: Specifies the definition of the automatic scaling policy.
PutAutoTerminationPolicyOutput:
type: object
properties: {}
PutAutoTerminationPolicyInput:
type: object
required:
- ClusterId
title: PutAutoTerminationPolicyInput
properties:
ClusterId:
allOf:
- $ref: "#/components/schemas/ClusterId"
- description: Specifies the ID of the Amazon EMR cluster to which the auto-termination policy will be attached.
AutoTerminationPolicy:
allOf:
- $ref: "#/components/schemas/AutoTerminationPolicy"
- description: Specifies the auto-termination policy to attach to the cluster.
PutBlockPublicAccessConfigurationOutput:
type: object
properties: {}
PutBlockPublicAccessConfigurationInput:
type: object
required:
- BlockPublicAccessConfiguration
title: PutBlockPublicAccessConfigurationInput
properties:
BlockPublicAccessConfiguration:
allOf:
- $ref: "#/components/schemas/BlockPublicAccessConfiguration"
- description: 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.
For accounts that created clusters in a Region before November 25, 2019, block public access is disabled by default in that Region. To use this feature, you must manually enable and configure it. For accounts that did not create an EMR cluster in a Region before this date, block public access is enabled by default in that Region.
ReleaseLabel
is used. To specify a custom AMI, use CustomAmiID
.
ReleaseLabel:
allOf:
- $ref: "#/components/schemas/XmlStringMaxLen256"
- description: 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
.
Instances:
allOf:
- $ref: "#/components/schemas/JobFlowInstancesConfig"
- description: A specification of the number and type of Amazon EC2 instances.
Steps:
allOf:
- $ref: "#/components/schemas/StepConfigList"
- description: A list of steps to run.
BootstrapActions:
allOf:
- $ref: "#/components/schemas/BootstrapActionConfigList"
- description: A list of bootstrap actions to run before Hadoop starts on the cluster nodes.
SupportedProducts:
allOf:
- $ref: "#/components/schemas/SupportedProductsList"
- description: 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.
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 Analytics 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.
The VisibleToAllUsers parameter is no longer supported. By default, the value is set to true
. Setting it to false
now has no effect.
Set this value to true
so that IAM principals in the Amazon Web Services account associated with the cluster can perform EMR actions on the cluster that their IAM policies allow. This value defaults to true
for clusters created using the EMR API or the CLI create-cluster command.
When set to false
, only the IAM principal that created the cluster and the Amazon Web Services account root user can perform EMR actions for the cluster, regardless of the IAM permissions policies attached to other IAM principals. For more information, see Understanding the EMR Cluster VisibleToAllUsers Setting in the Amazon EMRManagement Guide.
EMR_EC2_DefaultRole
. In order to use the default role, you must have already created it using the CLI or console.
ServiceRole:
allOf:
- $ref: "#/components/schemas/XmlString"
- description: The IAM role that Amazon EMR assumes in order to access Amazon Web Services resources on your behalf. If you've created a custom service role path, you must specify it for the service role when you launch your cluster.
Tags:
allOf:
- $ref: "#/components/schemas/TagList"
- description: A list of tags to associate with a cluster and propagate to Amazon EC2 instances.
SecurityConfiguration:
allOf:
- $ref: "#/components/schemas/XmlString"
- description: The name of a security configuration to apply to the cluster.
AutoScalingRole:
allOf:
- $ref: "#/components/schemas/XmlString"
- description: 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.
ScaleDownBehavior:
allOf:
- $ref: "#/components/schemas/ScaleDownBehavior"
- description: 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 adds nodes to a deny list 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.
CustomAmiId:
allOf:
- $ref: "#/components/schemas/XmlStringMaxLen256"
- description: 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.
EbsRootVolumeSize: allOf: - $ref: "#/components/schemas/Integer" - description: The size, in GiB, of the Amazon EBS root device volume of the Linux AMI that is used for each EC2 instance. Available in Amazon EMR version 4.x and later. RepoUpgradeOnBoot: allOf: - $ref: "#/components/schemas/RepoUpgradeOnBoot" - description: Applies only whenCustomAmiID
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.
KerberosAttributes:
allOf:
- $ref: "#/components/schemas/KerberosAttributes"
- description: Attributes for Kerberos configuration when Kerberos authentication is enabled using a security configuration. For more information see Use Kerberos Authentication in the Amazon EMR Management Guide.
StepConcurrencyLevel:
allOf:
- $ref: "#/components/schemas/Integer"
- description: Specifies the number of steps that can be executed concurrently. The default value is 1
. The maximum value is 256
.
ManagedScalingPolicy:
allOf:
- $ref: "#/components/schemas/ManagedScalingPolicy"
- description: " The specified managed scaling policy for an Amazon EMR cluster. "
PlacementGroupConfigs:
allOf:
- $ref: "#/components/schemas/PlacementGroupConfigList"
- description: The specified placement group configuration for an Amazon EMR cluster.
AutoTerminationPolicy:
$ref: "#/components/schemas/AutoTerminationPolicy"
OSReleaseLabel:
allOf:
- $ref: "#/components/schemas/XmlStringMaxLen256"
- description: Specifies a particular Amazon Linux release for all nodes in a cluster launch RunJobFlow request. If a release is not specified, Amazon EMR uses the latest validated Amazon Linux release for cluster launch.
description: " Input to the RunJobFlow operation. "
SetTerminationProtectionInput:
type: object
required:
- JobFlowIds
- TerminationProtected
title: SetTerminationProtectionInput
properties:
JobFlowIds:
allOf:
- $ref: "#/components/schemas/XmlStringList"
- description: " A list of strings that uniquely identify the clusters to protect. This identifier is returned by RunJobFlow and can also be obtained from DescribeJobFlows . "
TerminationProtected:
allOf:
- $ref: "#/components/schemas/Boolean"
- description: 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.
description: " The input argument to the TerminationProtection operation. "
SetVisibleToAllUsersInput:
type: object
required:
- JobFlowIds
- VisibleToAllUsers
title: SetVisibleToAllUsersInput
properties:
JobFlowIds:
allOf:
- $ref: "#/components/schemas/XmlStringList"
- description: The unique identifier of the job flow (cluster).
VisibleToAllUsers:
allOf:
- $ref: "#/components/schemas/Boolean"
- description: A value of true
indicates that an IAM principal in the Amazon Web Services account can perform EMR actions on the cluster that the IAM policies attached to the principal allow. A value of false
indicates that only the IAM principal that created the cluster and the Amazon Web Services root user can perform EMR actions on the cluster.
description: The input to the SetVisibleToAllUsers action.
StartNotebookExecutionOutput:
type: object
properties:
NotebookExecutionId:
allOf:
- $ref: "#/components/schemas/XmlStringMaxLen256"
- description: The unique identifier of the notebook execution.
StartNotebookExecutionInput:
type: object
required:
- EditorId
- RelativePath
- ExecutionEngine
- ServiceRole
title: StartNotebookExecutionInput
properties:
EditorId:
allOf:
- $ref: "#/components/schemas/XmlStringMaxLen256"
- description: The unique identifier of the EMR Notebook to use for notebook execution.
RelativePath:
allOf:
- $ref: "#/components/schemas/XmlString"
- description: The path and file name of the notebook file for this execution, relative to the path specified for the EMR Notebook. For example, if you specify a path of s3://MyBucket/MyNotebooks
when you create an EMR Notebook for a notebook with an ID of e-ABCDEFGHIJK1234567890ABCD
(the EditorID
of this request), and you specify a RelativePath
of my_notebook_executions/notebook_execution.ipynb
, the location of the file for the notebook execution is s3://MyBucket/MyNotebooks/e-ABCDEFGHIJK1234567890ABCD/my_notebook_executions/notebook_execution.ipynb
.
NotebookExecutionName:
allOf:
- $ref: "#/components/schemas/XmlStringMaxLen256"
- description: An optional name for the notebook execution.
NotebookParams:
allOf:
- $ref: "#/components/schemas/XmlString"
- description: Input parameters in JSON format passed to the EMR Notebook at runtime for execution.
ExecutionEngine:
allOf:
- $ref: "#/components/schemas/ExecutionEngineConfig"
- description: Specifies the execution engine (cluster) that runs the notebook execution.
ServiceRole:
allOf:
- $ref: "#/components/schemas/XmlString"
- description: The name or ARN of the IAM role that is used as the service role for Amazon EMR (the EMR role) for the notebook execution.
NotebookInstanceSecurityGroupId:
allOf:
- $ref: "#/components/schemas/XmlStringMaxLen256"
- description: The unique identifier of the Amazon EC2 security group to associate with the EMR Notebook for this notebook execution.
Tags:
allOf:
- $ref: "#/components/schemas/TagList"
- description: A list of tags associated with a notebook execution. 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.
StopNotebookExecutionInput:
type: object
required:
- NotebookExecutionId
title: StopNotebookExecutionInput
properties:
NotebookExecutionId:
allOf:
- $ref: "#/components/schemas/XmlStringMaxLen256"
- description: The unique identifier of the notebook execution.
TerminateJobFlowsInput:
type: object
required:
- JobFlowIds
title: TerminateJobFlowsInput
properties:
JobFlowIds:
allOf:
- $ref: "#/components/schemas/XmlStringList"
- description: A list of job flows to be shut down.
description: " Input to the TerminateJobFlows operation. "
UpdateStudioInput:
type: object
required:
- StudioId
title: UpdateStudioInput
properties:
StudioId:
allOf:
- $ref: "#/components/schemas/XmlStringMaxLen256"
- description: The ID of the Amazon EMR Studio to update.
Name:
allOf:
- $ref: "#/components/schemas/XmlStringMaxLen256"
- description: A descriptive name for the Amazon EMR Studio.
Description:
allOf:
- $ref: "#/components/schemas/XmlStringMaxLen256"
- description: A detailed description to assign to the Amazon EMR Studio.
SubnetIds:
allOf:
- $ref: "#/components/schemas/SubnetIdList"
- description: "A list of subnet IDs to associate with the Amazon EMR Studio. The list can include new subnet IDs, but must also include all of the subnet IDs previously associated with the Studio. The list order does not matter. A Studio can have a maximum of 5 subnets. The subnets must belong to the same VPC as the Studio. "
DefaultS3Location:
allOf:
- $ref: "#/components/schemas/XmlString"
- description: The Amazon S3 location to back up Workspaces and notebook files for the Amazon EMR Studio.
UpdateStudioSessionMappingInput:
type: object
required:
- StudioId
- IdentityType
- SessionPolicyArn
title: UpdateStudioSessionMappingInput
properties:
StudioId:
allOf:
- $ref: "#/components/schemas/XmlStringMaxLen256"
- description: The ID of the Amazon EMR Studio.
IdentityId:
allOf:
- $ref: "#/components/schemas/XmlStringMaxLen256"
- description: The globally unique identifier (GUID) of the user or group. For more information, see UserId and GroupId in the IAM Identity Center Identity Store API Reference. Either IdentityName
or IdentityId
must be specified.
IdentityName:
allOf:
- $ref: "#/components/schemas/XmlStringMaxLen256"
- description: The name of the user or group to update. For more information, see UserName and DisplayName in the IAM Identity Center Identity Store API Reference. Either IdentityName
or IdentityId
must be specified.
IdentityType:
allOf:
- $ref: "#/components/schemas/IdentityType"
- description: Specifies whether the identity to update is a user or a group.
SessionPolicyArn:
allOf:
- $ref: "#/components/schemas/XmlStringMaxLen256"
- description: The Amazon Resource Name (ARN) of the session policy to associate with the specified user or group.
ActionOnFailure:
type: string
enum:
- TERMINATE_JOB_FLOW
- TERMINATE_CLUSTER
- CANCEL_AND_WAIT
- CONTINUE
XmlStringMaxLen256:
type: string
minLength: 0
maxLength: 256
x-pattern: "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*"
InstanceFleetConfig:
type: object
required:
- InstanceFleetType
properties:
Name:
allOf:
- $ref: "#/components/schemas/XmlStringMaxLen256"
- description: The friendly name of the instance fleet.
InstanceFleetType:
allOf:
- $ref: "#/components/schemas/InstanceFleetType"
- description: The node type that the instance fleet hosts. Valid values are MASTER, CORE, and TASK.
TargetOnDemandCapacity:
allOf:
- $ref: "#/components/schemas/WholeNumber"
- description: 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.
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.
The configuration that defines an instance fleet.
The instance fleet configuration is available only in Amazon EMR versions 4.8.0 and later, excluding 5.0.x versions.
With Amazon EMR release version 4.0 and later, the only accepted parameter is the application name. To pass arguments to applications, you use configuration classifications specified using configuration JSON objects. For more information, see Configuring Applications.
With earlier Amazon EMR releases, the application is any Amazon or third-party software that you can add to the cluster. This structure contains a list of strings that indicates the software to use with the cluster and accepts a user argument list. Amazon EMR accepts and forwards the argument list to the corresponding installation script as bootstrap action argument.
ApplicationList: type: array items: $ref: "#/components/schemas/Application" AuthMode: type: string enum: - SSO - IAM ScalingConstraints: type: object required: - MinCapacity - MaxCapacity properties: MinCapacity: allOf: - $ref: "#/components/schemas/Integer" - description: 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. MaxCapacity: allOf: - $ref: "#/components/schemas/Integer" - description: 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. description: The upper and lower EC2 instance limits for an automatic scaling policy. Automatic scaling activities triggered by automatic scaling rules will not cause an instance group to grow above or below these limits. ScalingRuleList: type: array items: $ref: "#/components/schemas/ScalingRule" AutoScalingPolicy: type: object required: - Constraints - Rules properties: Constraints: allOf: - $ref: "#/components/schemas/ScalingConstraints" - description: 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. Rules: allOf: - $ref: "#/components/schemas/ScalingRuleList" - description: The scale-in and scale-out rules that comprise the automatic scaling policy. description: An automatic scaling policy for a core instance group or task instance group in an Amazon EMR cluster. An automatic scaling policy defines how an instance group dynamically adds and terminates EC2 instances in response to the value of a CloudWatch metric. See PutAutoScalingPolicy. AutoScalingPolicyStatus: type: object properties: State: allOf: - $ref: "#/components/schemas/AutoScalingPolicyState" - description: Indicates the status of the automatic scaling policy. StateChangeReason: allOf: - $ref: "#/components/schemas/AutoScalingPolicyStateChangeReason" - description: The reason for a change in status. description: "The status of an automatic scaling policy. " AutoScalingPolicyDescription: type: object properties: Status: allOf: - $ref: "#/components/schemas/AutoScalingPolicyStatus" - description: "The status of an automatic scaling policy. " Constraints: allOf: - $ref: "#/components/schemas/ScalingConstraints" - description: 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. Rules: allOf: - $ref: "#/components/schemas/ScalingRuleList" - description: The scale-in and scale-out rules that comprise the automatic scaling policy. description: 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. AutoScalingPolicyState: type: string enum: - PENDING - ATTACHING - ATTACHED - DETACHING - DETACHED - FAILED AutoScalingPolicyStateChangeReasonCode: type: string enum: - USER_REQUEST - PROVISION_FAILURE - CLEANUP_FAILURE AutoScalingPolicyStateChangeReason: type: object properties: Code: allOf: - $ref: "#/components/schemas/AutoScalingPolicyStateChangeReasonCode" - description: 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.
Message:
allOf:
- $ref: "#/components/schemas/String"
- description: A friendly, more verbose message that accompanies an automatic scaling policy state change.
description: The reason for an AutoScalingPolicyStatus change.
Long:
type: integer
AutoTerminationPolicy:
type: object
properties:
IdleTimeout:
allOf:
- $ref: "#/components/schemas/Long"
- description: Specifies the amount of idle time in seconds after which the cluster automatically terminates. You can specify a minimum of 60 seconds and a maximum of 604800 seconds (seven days).
description: An auto-termination policy for an Amazon EMR cluster. An auto-termination policy defines the amount of idle time in seconds after which a cluster automatically terminates. For alternative cluster termination options, see Control cluster termination.
Boolean:
type: boolean
PortRanges:
type: array
items:
$ref: "#/components/schemas/PortRange"
BlockPublicAccessConfiguration:
type: object
required:
- BlockPublicSecurityGroupRules
properties:
BlockPublicSecurityGroupRules:
allOf:
- $ref: "#/components/schemas/Boolean"
- description: Indicates whether Amazon 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
.
PermittedPublicSecurityGroupRuleRanges:
allOf:
- $ref: "#/components/schemas/PortRanges"
- description: 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
.
BlockPublicSecurityGroupRules
is set to true
, Amazon EMR prevents cluster creation if one of the cluster's security groups has a rule that allows inbound traffic from 0.0.0.0/0 or ::/0 on a port, unless the port is specified as an exception using PermittedPublicSecurityGroupRuleRanges
.
Date:
type: string
format: date-time
BlockPublicAccessConfigurationMetadata:
type: object
required:
- CreationDateTime
- CreatedByArn
properties:
CreationDateTime:
allOf:
- $ref: "#/components/schemas/Date"
- description: The date and time that the configuration was created.
CreatedByArn:
allOf:
- $ref: "#/components/schemas/ArnType"
- description: The Amazon Resource Name that created or last modified the configuration.
description: Properties that describe the Amazon Web Services principal that created the BlockPublicAccessConfiguration
using the PutBlockPublicAccessConfiguration
action as well as the date and time that the configuration was created. Each time a configuration for block public access is updated, Amazon EMR updates this metadata.
BooleanObject:
type: boolean
ScriptBootstrapActionConfig:
type: object
required:
- Path
properties:
Path:
allOf:
- $ref: "#/components/schemas/XmlString"
- description: Location in Amazon S3 of the script to run during a bootstrap action.
Args:
allOf:
- $ref: "#/components/schemas/XmlStringList"
- description: A list of command line arguments to pass to the bootstrap action script.
description: Configuration of the script to run during a bootstrap action.
BootstrapActionConfig:
type: object
required:
- Name
- ScriptBootstrapAction
properties:
Name:
allOf:
- $ref: "#/components/schemas/XmlStringMaxLen256"
- description: The name of the bootstrap action.
ScriptBootstrapAction:
allOf:
- $ref: "#/components/schemas/ScriptBootstrapActionConfig"
- description: The script run by the bootstrap action.
description: Configuration of a bootstrap action.
BootstrapActionConfigList:
type: array
items:
$ref: "#/components/schemas/BootstrapActionConfig"
BootstrapActionDetail:
type: object
properties:
BootstrapActionConfig:
allOf:
- $ref: "#/components/schemas/BootstrapActionConfig"
- description: A description of the bootstrap action.
description: Reports the configuration of a bootstrap action in a cluster (job flow).
BootstrapActionDetailList:
type: array
items:
$ref: "#/components/schemas/BootstrapActionDetail"
StepId:
type: string
CancelStepsRequestStatus:
type: string
enum:
- SUBMITTED
- FAILED
CancelStepsInfo:
type: object
properties:
StepId:
allOf:
- $ref: "#/components/schemas/StepId"
- description: The encrypted StepId of a step.
Status:
allOf:
- $ref: "#/components/schemas/CancelStepsRequestStatus"
- description: The status of a CancelSteps Request. The value may be SUBMITTED or FAILED.
Reason:
allOf:
- $ref: "#/components/schemas/String"
- description: The reason for the failure if the CancelSteps request fails.
description: Specification of the status of a CancelSteps request. Available only in Amazon EMR version 4.8.0 and later, excluding version 5.0.0.
CancelStepsInfoList:
type: array
items:
$ref: "#/components/schemas/CancelStepsInfo"
StepCancellationOption:
type: string
enum:
- SEND_INTERRUPT
- TERMINATE_PROCESS
ComparisonOperator:
type: string
enum:
- GREATER_THAN_OR_EQUAL
- GREATER_THAN
- LESS_THAN
- LESS_THAN_OR_EQUAL
Integer:
type: integer
Statistic:
type: string
enum:
- SAMPLE_COUNT
- AVERAGE
- SUM
- MINIMUM
- MAXIMUM
NonNegativeDouble:
type: number
format: double
minimum: 0
Unit:
type: string
enum:
- 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
MetricDimensionList:
type: array
items:
$ref: "#/components/schemas/MetricDimension"
CloudWatchAlarmDefinition:
type: object
required:
- ComparisonOperator
- MetricName
- Period
- Threshold
properties:
ComparisonOperator:
allOf:
- $ref: "#/components/schemas/ComparisonOperator"
- description: Determines how the metric specified by MetricName
is compared to the value specified by Threshold
.
EvaluationPeriods:
allOf:
- $ref: "#/components/schemas/Integer"
- description: 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
.
MetricName:
allOf:
- $ref: "#/components/schemas/String"
- description: The name of the CloudWatch metric that is watched to determine an alarm condition.
Namespace:
allOf:
- $ref: "#/components/schemas/String"
- description: The namespace for the CloudWatch metric. The default is AWS/ElasticMapReduce
.
Period:
allOf:
- $ref: "#/components/schemas/Integer"
- description: 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
.
Statistic:
allOf:
- $ref: "#/components/schemas/Statistic"
- description: The statistic to apply to the metric associated with the alarm. The default is AVERAGE
.
Threshold:
allOf:
- $ref: "#/components/schemas/NonNegativeDouble"
- description: The value against which the specified statistic is compared.
Unit:
allOf:
- $ref: "#/components/schemas/Unit"
- description: 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.
Dimensions:
allOf:
- $ref: "#/components/schemas/MetricDimensionList"
- description: A CloudWatch metric dimension.
description: The definition of a CloudWatch metric alarm, which determines when an automatic scaling activity is triggered. When the defined alarm conditions are satisfied, scaling activity begins.
ClusterId:
type: string
ClusterStatus:
type: object
properties:
State:
allOf:
- $ref: "#/components/schemas/ClusterState"
- description: The current state of the cluster.
StateChangeReason:
allOf:
- $ref: "#/components/schemas/ClusterStateChangeReason"
- description: The reason for the cluster status change.
Timeline:
allOf:
- $ref: "#/components/schemas/ClusterTimeline"
- description: A timeline that represents the status of a cluster over the lifetime of the cluster.
ErrorDetails:
allOf:
- $ref: "#/components/schemas/ErrorDetailList"
- description: A list of tuples that provide information about the errors that caused a cluster termination. This structure may have up to 10 different ErrorDetail
tuples.
description: The detailed status of the cluster.
Ec2InstanceAttributes:
type: object
properties:
Ec2KeyName:
allOf:
- $ref: "#/components/schemas/String"
- description: The name of the Amazon EC2 key pair to use when connecting with SSH into the master node as a user named "hadoop".
Ec2SubnetId:
allOf:
- $ref: "#/components/schemas/String"
- description: 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.
RequestedEc2SubnetIds:
allOf:
- $ref: "#/components/schemas/XmlStringMaxLen256List"
- description: 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.
Ec2AvailabilityZone:
allOf:
- $ref: "#/components/schemas/String"
- description: "The Availability Zone in which the cluster will run. "
RequestedEc2AvailabilityZones:
allOf:
- $ref: "#/components/schemas/XmlStringMaxLen256List"
- description: 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.
IamInstanceProfile:
allOf:
- $ref: "#/components/schemas/String"
- description: The IAM role that was specified when the cluster was launched. The EC2 instances of the cluster assume this role.
EmrManagedMasterSecurityGroup:
allOf:
- $ref: "#/components/schemas/String"
- description: The identifier of the Amazon EC2 security group for the master node.
EmrManagedSlaveSecurityGroup:
allOf:
- $ref: "#/components/schemas/String"
- description: The identifier of the Amazon EC2 security group for the core and task nodes.
ServiceAccessSecurityGroup:
allOf:
- $ref: "#/components/schemas/String"
- description: The identifier of the Amazon EC2 security group for the Amazon EMR service to access clusters in VPC private subnets.
AdditionalMasterSecurityGroups:
allOf:
- $ref: "#/components/schemas/StringList"
- description: A list of additional Amazon EC2 security group IDs for the master node.
AdditionalSlaveSecurityGroups:
allOf:
- $ref: "#/components/schemas/StringList"
- description: A list of additional Amazon EC2 security group IDs for the core and task nodes.
description: Provides information about the EC2 instances in a cluster grouped by category. For example, key name, subnet ID, IAM instance profile, and so on.
InstanceCollectionType:
type: string
enum:
- INSTANCE_FLEET
- INSTANCE_GROUP
ConfigurationList:
type: array
items:
$ref: "#/components/schemas/Configuration"
XmlString:
type: string
minLength: 0
maxLength: 10280
x-pattern: "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*"
ScaleDownBehavior:
type: string
enum:
- TERMINATE_AT_INSTANCE_HOUR
- TERMINATE_AT_TASK_COMPLETION
RepoUpgradeOnBoot:
type: string
enum:
- SECURITY
- NONE
KerberosAttributes:
type: object
required:
- Realm
- KdcAdminPassword
properties:
Realm:
allOf:
- $ref: "#/components/schemas/XmlStringMaxLen256"
- description: "The name of the Kerberos realm to which all nodes in a cluster belong. For example, EC2.INTERNAL
. "
KdcAdminPassword:
allOf:
- $ref: "#/components/schemas/XmlStringMaxLen256"
- description: 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.
CrossRealmTrustPrincipalPassword:
allOf:
- $ref: "#/components/schemas/XmlStringMaxLen256"
- description: 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.
ADDomainJoinUser:
allOf:
- $ref: "#/components/schemas/XmlStringMaxLen256"
- description: Required only when establishing a cross-realm trust with an Active Directory domain. A user with sufficient privileges to join resources to the domain.
ADDomainJoinPassword:
allOf:
- $ref: "#/components/schemas/XmlStringMaxLen256"
- description: The Active Directory password for ADDomainJoinUser
.
description: Attributes for Kerberos configuration when Kerberos authentication is enabled using a security configuration. For more information see Use Kerberos Authentication in the Amazon EMR Management Guide.
OptionalArnType:
type: string
minLength: 0
maxLength: 2048
PlacementGroupConfigList:
type: array
items:
$ref: "#/components/schemas/PlacementGroupConfig"
Cluster:
type: object
properties:
Id:
allOf:
- $ref: "#/components/schemas/ClusterId"
- description: The unique identifier for the cluster.
Name:
allOf:
- $ref: "#/components/schemas/String"
- description: The name of the cluster.
Status:
allOf:
- $ref: "#/components/schemas/ClusterStatus"
- description: The current status details about the cluster.
Ec2InstanceAttributes:
allOf:
- $ref: "#/components/schemas/Ec2InstanceAttributes"
- description: Provides information about the EC2 instances in a cluster grouped by category. For example, key name, subnet ID, IAM instance profile, and so on.
InstanceCollectionType:
allOf:
- $ref: "#/components/schemas/InstanceCollectionType"
- description: 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.
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
.
AutoTerminate:
allOf:
- $ref: "#/components/schemas/Boolean"
- description: Specifies whether the cluster should terminate after completing all steps.
TerminationProtected:
allOf:
- $ref: "#/components/schemas/Boolean"
- description: 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.
VisibleToAllUsers:
allOf:
- $ref: "#/components/schemas/Boolean"
- description: Indicates whether the cluster is visible to IAM principals in the Amazon Web Services account associated with the cluster. When true
, IAM principals in the Amazon Web Services account can perform EMR cluster actions on the cluster that their IAM policies allow. When false
, only the IAM principal that created the cluster and the Amazon Web Services account root user can perform EMR actions, regardless of IAM permissions policies attached to other IAM principals.
The default value is true
if a value is not provided when creating a cluster using the EMR API RunJobFlow command, the CLI create-cluster command, or the Amazon Web Services Management Console.
EMR_AutoScaling_DefaultRole
. The IAM role provides permissions that the automatic scaling feature requires to launch and terminate EC2 instances in an instance group.
ScaleDownBehavior:
allOf:
- $ref: "#/components/schemas/ScaleDownBehavior"
- description: 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 adds nodes to a deny list 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.
CustomAmiId:
allOf:
- $ref: "#/components/schemas/XmlStringMaxLen256"
- description: 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.
EbsRootVolumeSize:
allOf:
- $ref: "#/components/schemas/Integer"
- description: The size, in GiB, of the Amazon EBS root device volume of the Linux AMI that is used for each EC2 instance. Available in Amazon EMR version 4.x and later.
RepoUpgradeOnBoot:
allOf:
- $ref: "#/components/schemas/RepoUpgradeOnBoot"
- description: 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.
KerberosAttributes:
allOf:
- $ref: "#/components/schemas/KerberosAttributes"
- description: Attributes for Kerberos configuration when Kerberos authentication is enabled using a security configuration. For more information see Use Kerberos Authentication in the Amazon EMR Management Guide.
ClusterArn:
allOf:
- $ref: "#/components/schemas/ArnType"
- description: The Amazon Resource Name of the cluster.
OutpostArn:
allOf:
- $ref: "#/components/schemas/OptionalArnType"
- description: " The Amazon Resource Name (ARN) of the Outpost where the cluster is launched. "
StepConcurrencyLevel:
allOf:
- $ref: "#/components/schemas/Integer"
- description: Specifies the number of steps that can be executed concurrently.
PlacementGroups:
allOf:
- $ref: "#/components/schemas/PlacementGroupConfigList"
- description: Placement group configured for an Amazon EMR cluster.
OSReleaseLabel:
allOf:
- $ref: "#/components/schemas/String"
- description: The Amazon Linux release specified in a cluster launch RunJobFlow request. If no Amazon Linux release was specified, the default Amazon Linux release is shown in the response.
description: The detailed description of the cluster.
ClusterState:
type: string
enum:
- STARTING
- BOOTSTRAPPING
- RUNNING
- WAITING
- TERMINATING
- TERMINATED
- TERMINATED_WITH_ERRORS
ClusterStateChangeReasonCode:
type: string
enum:
- INTERNAL_ERROR
- VALIDATION_ERROR
- INSTANCE_FAILURE
- INSTANCE_FLEET_TIMEOUT
- BOOTSTRAP_FAILURE
- USER_REQUEST
- STEP_FAILURE
- ALL_STEPS_COMPLETED
ClusterStateChangeReason:
type: object
properties:
Code:
allOf:
- $ref: "#/components/schemas/ClusterStateChangeReasonCode"
- description: The programmatic code for the state change reason.
Message:
allOf:
- $ref: "#/components/schemas/String"
- description: The descriptive message for the state change reason.
description: The reason that the cluster changed to its current state.
ClusterStateList:
type: array
items:
$ref: "#/components/schemas/ClusterState"
ClusterTimeline:
type: object
properties:
CreationDateTime:
allOf:
- $ref: "#/components/schemas/Date"
- description: The creation date and time of the cluster.
ReadyDateTime:
allOf:
- $ref: "#/components/schemas/Date"
- description: The date and time when the cluster was ready to run steps.
EndDateTime:
allOf:
- $ref: "#/components/schemas/Date"
- description: The date and time when the cluster was terminated.
description: Represents the timeline of the cluster's lifecycle.
ErrorDetailList:
type: array
items:
$ref: "#/components/schemas/ErrorDetail"
ClusterSummary:
type: object
properties:
Id:
allOf:
- $ref: "#/components/schemas/ClusterId"
- description: The unique identifier for the cluster.
Name:
allOf:
- $ref: "#/components/schemas/String"
- description: The name of the cluster.
Status:
allOf:
- $ref: "#/components/schemas/ClusterStatus"
- description: The details about the current status of the cluster.
NormalizedInstanceHours:
allOf:
- $ref: "#/components/schemas/Integer"
- description: 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.
ClusterArn:
allOf:
- $ref: "#/components/schemas/ArnType"
- description: The Amazon Resource Name of the cluster.
OutpostArn:
allOf:
- $ref: "#/components/schemas/OptionalArnType"
- description: " The Amazon Resource Name (ARN) of the Outpost where the cluster is launched. "
description: The summary description of the cluster.
ClusterSummaryList:
type: array
items:
$ref: "#/components/schemas/ClusterSummary"
Command:
type: object
properties:
Name:
allOf:
- $ref: "#/components/schemas/String"
- description: The name of the command.
ScriptPath:
allOf:
- $ref: "#/components/schemas/String"
- description: The Amazon S3 location of the command script.
Args:
allOf:
- $ref: "#/components/schemas/StringList"
- description: Arguments for Amazon EMR to pass to the command for execution.
description: An entity describing an executable that runs on a cluster.
CommandList:
type: array
items:
$ref: "#/components/schemas/Command"
ComputeLimitsUnitType:
type: string
enum:
- InstanceFleetUnits
- Instances
- VCPU
ComputeLimits:
type: object
required:
- UnitType
- MinimumCapacityUnits
- MaximumCapacityUnits
properties:
UnitType:
allOf:
- $ref: "#/components/schemas/ComputeLimitsUnitType"
- description: " The unit type used for specifying a managed scaling policy. "
MinimumCapacityUnits:
allOf:
- $ref: "#/components/schemas/Integer"
- description: " The lower boundary of EC2 units. It is measured through vCPU cores or instances for instance groups and measured through units for instance fleets. Managed scaling activities are not allowed beyond this boundary. The limit only applies to the core and task nodes. The master node cannot be scaled after initial configuration. "
MaximumCapacityUnits:
allOf:
- $ref: "#/components/schemas/Integer"
- description: " The upper boundary of EC2 units. It is measured through vCPU cores or instances for instance groups and measured through units for instance fleets. Managed scaling activities are not allowed beyond this boundary. The limit only applies to the core and task nodes. The master node cannot be scaled after initial configuration. "
MaximumOnDemandCapacityUnits:
allOf:
- $ref: "#/components/schemas/Integer"
- description: " The upper boundary of On-Demand EC2 units. It is measured through vCPU cores or instances for instance groups and measured through units for instance fleets. The On-Demand units are not allowed to scale beyond this boundary. The parameter is used to split capacity allocation between On-Demand and Spot Instances. "
MaximumCoreCapacityUnits:
allOf:
- $ref: "#/components/schemas/Integer"
- description: " The upper boundary of EC2 units for core node type in a cluster. It is measured through vCPU cores or instances for instance groups and measured through units for instance fleets. The core units are not allowed to scale beyond this boundary. The parameter is used to split capacity allocation between core and task nodes. "
description: " The EC2 unit limits for a managed scaling policy. The managed scaling activity of a cluster can not be above or below these limits. The limit only applies to the core and task nodes. The master node cannot be scaled after initial configuration. "
Configuration:
type: object
properties:
Classification:
allOf:
- $ref: "#/components/schemas/String"
- description: The classification within a configuration.
Configurations:
allOf:
- $ref: "#/components/schemas/ConfigurationList"
- description: A list of additional configurations to apply within a configuration object.
Properties:
allOf:
- $ref: "#/components/schemas/StringMap"
- description: A set of properties specified within a configuration classification.
description: Amazon EMR releases 4.x or later.
An optional configuration specification to be used when provisioning cluster instances, which can include configurations for applications and software bundled with Amazon EMR. A configuration consists of a classification, properties, and optional nested configurations. A classification refers to an application-specific configuration file. Properties are the settings you want to change in that file. For more information, see Configuring Applications.
SubnetIdList: type: array items: $ref: "#/components/schemas/String" IdentityType: type: string enum: - USER - GROUP UsernamePassword: type: object properties: Username: allOf: - $ref: "#/components/schemas/XmlStringMaxLen256" - description: The username associated with the temporary credentials that you use to connect to cluster endpoints. Password: allOf: - $ref: "#/components/schemas/XmlStringMaxLen256" - description: The password associated with the temporary credentials that you use to connect to cluster endpoints. description: The username and password that you use to connect to cluster endpoints. Credentials: type: object properties: UsernamePassword: allOf: - $ref: "#/components/schemas/UsernamePassword" - description: The username and password that you use to connect to cluster endpoints. description: The credentials that you can use to connect to cluster endpoints. Credentials consist of a username and a password. XmlStringList: type: array items: $ref: "#/components/schemas/XmlString" JobFlowExecutionStateList: type: array items: $ref: "#/components/schemas/JobFlowExecutionState" JobFlowDetailList: type: array items: $ref: "#/components/schemas/JobFlowDetail" NotebookExecution: type: object properties: NotebookExecutionId: allOf: - $ref: "#/components/schemas/XmlStringMaxLen256" - description: The unique identifier of a notebook execution. EditorId: allOf: - $ref: "#/components/schemas/XmlStringMaxLen256" - description: The unique identifier of the EMR Notebook that is used for the notebook execution. ExecutionEngine: allOf: - $ref: "#/components/schemas/ExecutionEngineConfig" - description: The execution engine, such as an EMR cluster, used to run the EMR notebook and perform the notebook execution. NotebookExecutionName: allOf: - $ref: "#/components/schemas/XmlStringMaxLen256" - description: A name for the notebook execution. NotebookParams: allOf: - $ref: "#/components/schemas/XmlString" - description: Input parameters in JSON format passed to the EMR Notebook at runtime for execution. Status: allOf: - $ref: "#/components/schemas/NotebookExecutionStatus" - description:The status of the notebook execution.
START_PENDING
indicates that the cluster has received the execution request but execution has not begun.
STARTING
indicates that the execution is starting on the cluster.
RUNNING
indicates that the execution is being processed by the cluster.
FINISHING
indicates that execution processing is in the final stages.
FINISHED
indicates that the execution has completed without error.
FAILING
indicates that the execution is failing and will not finish successfully.
FAILED
indicates that the execution failed.
STOP_PENDING
indicates that the cluster has received a StopNotebookExecution
request and the stop is pending.
STOPPING
indicates that the cluster is in the process of stopping the execution as a result of a StopNotebookExecution
request.
STOPPED
indicates that the execution stopped because of a StopNotebookExecution
request.
StartNotebookExecution
action.
MaxResultsNumber:
type: integer
minimum: 1
maximum: 100
SimplifiedApplicationList:
type: array
items:
$ref: "#/components/schemas/SimplifiedApplication"
OSReleaseList:
type: array
items:
$ref: "#/components/schemas/OSRelease"
Step:
type: object
properties:
Id:
allOf:
- $ref: "#/components/schemas/StepId"
- description: The identifier of the cluster step.
Name:
allOf:
- $ref: "#/components/schemas/String"
- description: The name of the cluster step.
Config:
allOf:
- $ref: "#/components/schemas/HadoopStepConfig"
- description: The Hadoop job configuration of the cluster step.
ActionOnFailure:
allOf:
- $ref: "#/components/schemas/ActionOnFailure"
- description: 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.
If a cluster's StepConcurrencyLevel
is greater than 1
, do not use AddJobFlowSteps
to submit a step with this parameter set to CANCEL_AND_WAIT
or TERMINATE_CLUSTER
. The step is not submitted and the action fails with a message that the ActionOnFailure
setting is not valid.
If you change a cluster's StepConcurrencyLevel
to be greater than 1 while a step is running, the ActionOnFailure
parameter may not behave as you expect. In this case, for a step that fails with this parameter set to CANCEL_AND_WAIT
, pending steps and the running step are not canceled; for a step that fails with this parameter set to TERMINATE_CLUSTER
, the cluster does not terminate.
The Amazon Resource Name (ARN) of the runtime role for a step on the cluster. The runtime role can be a cross-account IAM role. The runtime role ARN is a combination of account ID, role name, and role type using the following format: arn:partition:service:region:account:resource
.
For example, arn:aws:iam::1234567890:role/ReadOnly
is a correctly formatted runtime role ARN.
UserRole
when you use IAM authentication.
WorkspaceSecurityGroupId:
allOf:
- $ref: "#/components/schemas/XmlStringMaxLen256"
- description: The ID of the Workspace security group associated with the Amazon EMR Studio. The Workspace security group allows outbound network traffic to resources in the Engine security group and to the internet.
EngineSecurityGroupId:
allOf:
- $ref: "#/components/schemas/XmlStringMaxLen256"
- description: The ID of the Engine security group associated with the Amazon EMR Studio. The Engine security group allows inbound network traffic from resources in the Workspace security group.
Url:
allOf:
- $ref: "#/components/schemas/XmlString"
- description: The unique access URL of the Amazon EMR Studio.
CreationTime:
allOf:
- $ref: "#/components/schemas/Date"
- description: The time the Amazon EMR Studio was created.
DefaultS3Location:
allOf:
- $ref: "#/components/schemas/XmlString"
- description: The Amazon S3 location to back up Amazon EMR Studio Workspaces and notebook files.
IdpAuthUrl:
allOf:
- $ref: "#/components/schemas/XmlString"
- description: Your identity provider's authentication endpoint. Amazon EMR Studio redirects federated users to this endpoint for authentication when logging in to a Studio with the Studio URL.
IdpRelayStateParameterName:
allOf:
- $ref: "#/components/schemas/XmlStringMaxLen256"
- description: The name of your identity provider's RelayState
parameter.
Tags:
allOf:
- $ref: "#/components/schemas/TagList"
- description: A list of tags associated with the Amazon EMR Studio.
description: Details for an Amazon EMR Studio including ID, creation time, name, and so on.
InstanceId:
type: string
EC2InstanceIdsList:
type: array
items:
$ref: "#/components/schemas/InstanceId"
EC2InstanceIdsToTerminateList:
type: array
items:
$ref: "#/components/schemas/InstanceId"
VolumeSpecification:
type: object
required:
- VolumeType
- SizeInGB
properties:
VolumeType:
allOf:
- $ref: "#/components/schemas/String"
- description: The volume type. Volume types supported are gp3, gp2, io1, st1, sc1, and standard.
Iops:
allOf:
- $ref: "#/components/schemas/Integer"
- description: The number of I/O operations per second (IOPS) that the volume supports.
SizeInGB:
allOf:
- $ref: "#/components/schemas/Integer"
- description: 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.
Throughput:
allOf:
- $ref: "#/components/schemas/ThroughputVal"
- description: The throughput, in mebibyte per second (MiB/s). This optional parameter can be a number from 125 - 1000 and is valid only for gp3 volumes.
description: EBS volume specifications such as volume type, IOPS, size (GiB) and throughput (MiB/s) that are requested for the EBS volume attached to an EC2 instance in the cluster.
EbsBlockDevice:
type: object
properties:
VolumeSpecification:
allOf:
- $ref: "#/components/schemas/VolumeSpecification"
- description: EBS volume specifications such as volume type, IOPS, size (GiB) and throughput (MiB/s) that are requested for the EBS volume attached to an EC2 instance in the cluster.
Device:
allOf:
- $ref: "#/components/schemas/String"
- description: The device name that is exposed to the instance, such as /dev/sdh.
description: Configuration of requested EBS block device associated with the instance group.
EbsBlockDeviceConfig:
type: object
required:
- VolumeSpecification
properties:
VolumeSpecification:
allOf:
- $ref: "#/components/schemas/VolumeSpecification"
- description: EBS volume specifications such as volume type, IOPS, size (GiB) and throughput (MiB/s) that are requested for the EBS volume attached to an EC2 instance in the cluster.
VolumesPerInstance:
allOf:
- $ref: "#/components/schemas/Integer"
- description: Number of EBS volumes with a specific volume configuration that are associated with every instance in the instance group
description: Configuration of requested EBS block device associated with the instance group with count of volumes that are associated to every instance.
EbsBlockDeviceConfigList:
type: array
items:
$ref: "#/components/schemas/EbsBlockDeviceConfig"
EbsBlockDeviceList:
type: array
items:
$ref: "#/components/schemas/EbsBlockDevice"
EbsConfiguration:
type: object
properties:
EbsBlockDeviceConfigs:
allOf:
- $ref: "#/components/schemas/EbsBlockDeviceConfigList"
- description: An array of Amazon EBS volume specifications attached to a cluster instance.
EbsOptimized:
allOf:
- $ref: "#/components/schemas/BooleanObject"
- description: Indicates whether an Amazon EBS volume is EBS-optimized.
description: The Amazon EBS configuration of a cluster instance.
EbsVolume:
type: object
properties:
Device:
allOf:
- $ref: "#/components/schemas/String"
- description: The device name that is exposed to the instance, such as /dev/sdh.
VolumeId:
allOf:
- $ref: "#/components/schemas/String"
- description: The volume identifier of the EBS volume.
description: EBS block device that's attached to an EC2 instance.
EbsVolumeList:
type: array
items:
$ref: "#/components/schemas/EbsVolume"
XmlStringMaxLen256List:
type: array
items:
$ref: "#/components/schemas/XmlStringMaxLen256"
ErrorData:
type: array
items:
$ref: "#/components/schemas/StringMap"
ErrorDetail:
type: object
properties:
ErrorCode:
allOf:
- $ref: "#/components/schemas/String"
- description: The name or code that's associated with the error.
ErrorData:
allOf:
- $ref: "#/components/schemas/ErrorData"
- description: A list of key value pairs that provide contextual information to explain why the error may have occured.
ErrorMessage:
allOf:
- $ref: "#/components/schemas/String"
- description: A message describing the error that occured.
description: A tuple that provides information about an error that caused a cluster to terminate.
ExecutionEngineType:
type: string
enum:
- EMR
ExecutionEngineConfig:
type: object
required:
- Id
properties:
Id:
allOf:
- $ref: "#/components/schemas/XmlStringMaxLen256"
- description: The unique identifier of the execution engine. For an EMR cluster, this is the cluster ID.
Type:
allOf:
- $ref: "#/components/schemas/ExecutionEngineType"
- description: The type of execution engine. A value of EMR
specifies an EMR cluster.
MasterInstanceSecurityGroupId:
allOf:
- $ref: "#/components/schemas/XmlStringMaxLen256"
- description: An optional unique ID of an EC2 security group to associate with the master instance of the EMR cluster for this notebook execution. For more information see Specifying EC2 Security Groups for EMR Notebooks in the EMR Management Guide.
description: Specifies the execution engine (cluster) to run the notebook and perform the notebook execution, for example, an EMR cluster.
FailureDetails:
type: object
properties:
Reason:
allOf:
- $ref: "#/components/schemas/String"
- description: 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.
Message:
allOf:
- $ref: "#/components/schemas/String"
- description: The descriptive message including the error the Amazon 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.
LogFile:
allOf:
- $ref: "#/components/schemas/String"
- description: The path to the log file where the step failure root cause was originally recorded.
description: The details of the step failure. The service attempts to detect the root cause for many common failures.
ManagedScalingPolicy:
type: object
properties:
ComputeLimits:
allOf:
- $ref: "#/components/schemas/ComputeLimits"
- description: The EC2 unit limits for a managed scaling policy. The managed scaling activity of a cluster is not allowed to go above or below these limits. The limit only applies to the core and task nodes. The master node cannot be scaled after initial configuration.
description: " Managed scaling policy for an Amazon EMR cluster. The policy specifies the limits for resources that can be added or terminated from a cluster. The policy only applies to the core and task nodes. The master node cannot be scaled after initial configuration. "
SessionMappingDetail:
type: object
properties:
StudioId:
allOf:
- $ref: "#/components/schemas/XmlStringMaxLen256"
- description: The ID of the Amazon EMR Studio.
IdentityId:
allOf:
- $ref: "#/components/schemas/XmlStringMaxLen256"
- description: The globally unique identifier (GUID) of the user or group.
IdentityName:
allOf:
- $ref: "#/components/schemas/XmlStringMaxLen256"
- description: The name of the user or group. For more information, see UserName and DisplayName in the IAM Identity Center Identity Store API Reference.
IdentityType:
allOf:
- $ref: "#/components/schemas/IdentityType"
- description: Specifies whether the identity mapped to the Amazon EMR Studio is a user or a group.
SessionPolicyArn:
allOf:
- $ref: "#/components/schemas/XmlStringMaxLen256"
- description: The Amazon Resource Name (ARN) of the session policy associated with the user or group.
CreationTime:
allOf:
- $ref: "#/components/schemas/Date"
- description: The time the session mapping was created.
LastModifiedTime:
allOf:
- $ref: "#/components/schemas/Date"
- description: The time the session mapping was last modified.
description: Details for an Amazon EMR Studio session mapping including creation time, user or group ID, Studio ID, and so on.
KeyValueList:
type: array
items:
$ref: "#/components/schemas/KeyValue"
HadoopJarStepConfig:
type: object
required:
- Jar
properties:
Properties:
allOf:
- $ref: "#/components/schemas/KeyValueList"
- description: 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.
Jar:
allOf:
- $ref: "#/components/schemas/XmlString"
- description: A path to a JAR file run during the step.
MainClass:
allOf:
- $ref: "#/components/schemas/XmlString"
- description: 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.
Args:
allOf:
- $ref: "#/components/schemas/XmlStringList"
- description: A list of command line arguments passed to the JAR file's main function when executed.
description: A job flow step consisting of a JAR file whose main function will be executed. The main function submits a job for Hadoop to execute and waits for the job to finish or fail.
HadoopStepConfig:
type: object
properties:
Jar:
allOf:
- $ref: "#/components/schemas/String"
- description: The path to the JAR file that runs during the step.
Properties:
allOf:
- $ref: "#/components/schemas/StringMap"
- description: 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.
MainClass:
allOf:
- $ref: "#/components/schemas/String"
- description: 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.
Args:
allOf:
- $ref: "#/components/schemas/StringList"
- description: The list of command line arguments to pass to the JAR file's main function for execution.
description: A cluster step consisting of a JAR file whose main function will be executed. The main function submits a job for Hadoop to execute and waits for the job to finish or fail.
InstanceStatus:
type: object
properties:
State:
allOf:
- $ref: "#/components/schemas/InstanceState"
- description: The current state of the instance.
StateChangeReason:
allOf:
- $ref: "#/components/schemas/InstanceStateChangeReason"
- description: The details of the status change reason for the instance.
Timeline:
allOf:
- $ref: "#/components/schemas/InstanceTimeline"
- description: The timeline of the instance status over time.
description: The instance status details.
MarketType:
type: string
enum:
- ON_DEMAND
- SPOT
InstanceType:
type: string
minLength: 1
maxLength: 256
x-pattern: "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*"
Instance:
type: object
properties:
Id:
allOf:
- $ref: "#/components/schemas/InstanceId"
- description: The unique identifier for the instance in Amazon EMR.
Ec2InstanceId:
allOf:
- $ref: "#/components/schemas/InstanceId"
- description: The unique identifier of the instance in Amazon EC2.
PublicDnsName:
allOf:
- $ref: "#/components/schemas/String"
- description: The public DNS name of the instance.
PublicIpAddress:
allOf:
- $ref: "#/components/schemas/String"
- description: The public IP address of the instance.
PrivateDnsName:
allOf:
- $ref: "#/components/schemas/String"
- description: The private DNS name of the instance.
PrivateIpAddress:
allOf:
- $ref: "#/components/schemas/String"
- description: The private IP address of the instance.
Status:
allOf:
- $ref: "#/components/schemas/InstanceStatus"
- description: The current status of the instance.
InstanceGroupId:
allOf:
- $ref: "#/components/schemas/String"
- description: The identifier of the instance group to which this instance belongs.
InstanceFleetId:
allOf:
- $ref: "#/components/schemas/InstanceFleetId"
- description: The unique identifier of the instance fleet to which an EC2 instance belongs.
Market:
allOf:
- $ref: "#/components/schemas/MarketType"
- description: "The instance purchasing option. Valid values are ON_DEMAND
or SPOT
. "
InstanceType:
allOf:
- $ref: "#/components/schemas/InstanceType"
- description: The EC2 instance type, for example m3.xlarge
.
EbsVolumes:
allOf:
- $ref: "#/components/schemas/EbsVolumeList"
- description: The list of Amazon EBS volumes that are attached to this instance.
description: Represents an EC2 instance provisioned as part of cluster.
InstanceFleetStatus:
type: object
properties:
State:
allOf:
- $ref: "#/components/schemas/InstanceFleetState"
- description: 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.
The status of the instance fleet.
The instance fleet configuration is available only in Amazon EMR versions 4.8.0 and later, excluding 5.0.x versions.
The launch specification for On-Demand Instances in the instance fleet, which determines the allocation strategy.
The instance fleet configuration is available only in Amazon EMR versions 4.8.0 and later, excluding 5.0.x versions. On-Demand Instances allocation strategy is available in Amazon EMR version 5.12.1 and later.
The launch specification for Spot Instances in the fleet, which determines the defined duration, provisioning timeout behavior, and allocation strategy.
The instance fleet configuration is available only in Amazon EMR versions 4.8.0 and later, excluding 5.0.x versions. On-Demand and Spot instance allocation strategies are available in Amazon EMR version 5.12.1 and later.
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.
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.
TargetOnDemandCapacity
. This provisioned capacity might be less than or greater than TargetOnDemandCapacity
.
ProvisionedSpotCapacity:
allOf:
- $ref: "#/components/schemas/WholeNumber"
- description: 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
.
InstanceTypeSpecifications:
allOf:
- $ref: "#/components/schemas/InstanceTypeSpecificationList"
- description: An array of specifications for the instance types that comprise an instance fleet.
LaunchSpecifications:
allOf:
- $ref: "#/components/schemas/InstanceFleetProvisioningSpecifications"
- description: "Describes the launch specification for an instance fleet. "
ResizeSpecifications:
allOf:
- $ref: "#/components/schemas/InstanceFleetResizingSpecifications"
- description: The resize specification for the instance fleet.
description: Describes an instance fleet, which is a group of EC2 instances that host a particular node type (master, core, or task) in an Amazon EMR cluster. Instance fleets can consist of a mix of instance types and On-Demand and Spot Instances, which are provisioned to meet a defined target capacity.
The instance fleet configuration is available only in Amazon EMR versions 4.8.0 and later, excluding 5.0.x versions.
Configuration parameters for an instance fleet modification request.
The instance fleet configuration is available only in Amazon EMR versions 4.8.0 and later, excluding 5.0.x versions.
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.
TimeoutAction:
allOf:
- $ref: "#/components/schemas/SpotProvisioningTimeoutAction"
- description: 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.
BlockDurationMinutes:
allOf:
- $ref: "#/components/schemas/WholeNumber"
- description: 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.
Spot Instances with a defined duration (also known as Spot blocks) are no longer available to new customers from July 1, 2021. For customers who have previously used the feature, we will continue to support Spot Instances with a defined duration until December 31, 2022.
The launch specification for Spot Instances in the instance fleet, which determines the defined duration, provisioning timeout behavior, and allocation strategy.
The instance fleet configuration is available only in Amazon EMR versions 4.8.0 and later, excluding 5.0.x versions. Spot Instance allocation strategy is available in Amazon EMR version 5.12.1 and later.
Spot Instances with a defined duration (also known as Spot blocks) are no longer available to new customers from July 1, 2021. For customers who have previously used the feature, we will continue to support Spot Instances with a defined duration until December 31, 2022.
lowest-price
(the default), which launches the lowest price first.
CapacityReservationOptions:
allOf:
- $ref: "#/components/schemas/OnDemandCapacityReservationOptions"
- description: The launch specification for On-Demand instances in the instance fleet, which determines the allocation strategy.
description: The launch specification for On-Demand Instances in the instance fleet, which determines the allocation strategy.
The instance fleet configuration is available only in Amazon EMR versions 4.8.0 and later, excluding 5.0.x versions. On-Demand Instances allocation strategy is available in Amazon EMR version 5.12.1 and later.
Provides status change reason details for the instance fleet.
The instance fleet configuration is available only in Amazon EMR versions 4.8.0 and later, excluding 5.0.x versions.
Provides historical timestamps for the instance fleet, including the time of creation, the time it became ready to run jobs, and the time of termination.
The instance fleet configuration is available only in Amazon EMR versions 4.8.0 and later, excluding 5.0.x versions.
OnDemandPrice
to set the amount equal to the On-Demand price, or specify an amount in USD.
InstanceType:
allOf:
- $ref: "#/components/schemas/InstanceType"
- description: The EC2 instance type for all instances in the instance group.
RequestedInstanceCount:
allOf:
- $ref: "#/components/schemas/Integer"
- description: The target number of instances for the instance group.
RunningInstanceCount:
allOf:
- $ref: "#/components/schemas/Integer"
- description: The number of instances currently running in this instance group.
Status:
allOf:
- $ref: "#/components/schemas/InstanceGroupStatus"
- description: The current status of the instance group.
Configurations:
allOf:
- $ref: "#/components/schemas/ConfigurationList"
- description: Amazon EMR releases 4.x or later.
The list of configurations supplied for an Amazon EMR cluster instance group. You can specify a separate configuration for each instance group (master, core, and task).
ConfigurationsVersion: allOf: - $ref: "#/components/schemas/Long" - description: The version number of the requested configuration specification for this instance group. LastSuccessfullyAppliedConfigurations: allOf: - $ref: "#/components/schemas/ConfigurationList" - description: A list of configurations that were successfully applied for an instance group last time. LastSuccessfullyAppliedConfigurationsVersion: allOf: - $ref: "#/components/schemas/Long" - description: "The version number of a configuration specification that was successfully applied for an instance group last time. " EbsBlockDevices: allOf: - $ref: "#/components/schemas/EbsBlockDeviceList" - description: The EBS block devices that are mapped to this instance group. EbsOptimized: allOf: - $ref: "#/components/schemas/BooleanObject" - description: 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. ShrinkPolicy: allOf: - $ref: "#/components/schemas/ShrinkPolicy" - description: Policy for customizing shrink operations. AutoScalingPolicy: allOf: - $ref: "#/components/schemas/AutoScalingPolicyDescription" - description: 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. CustomAmiId: allOf: - $ref: "#/components/schemas/XmlStringMaxLen256" - description: The custom AMI ID to use for the provisioned instance group. description: This entity represents an instance group, which is a group of instances that have common purpose. For example, CORE instance group is used for HDFS. InstanceRoleType: type: string enum: - MASTER - CORE - TASK InstanceGroupConfig: type: object required: - InstanceRole - InstanceType - InstanceCount properties: Name: allOf: - $ref: "#/components/schemas/XmlStringMaxLen256" - description: Friendly name given to the instance group. Market: allOf: - $ref: "#/components/schemas/MarketType" - description: Market type of the EC2 instances used to create a cluster node. InstanceRole: allOf: - $ref: "#/components/schemas/InstanceRoleType" - description: The role of the instance group in the cluster. BidPrice: allOf: - $ref: "#/components/schemas/XmlStringMaxLen256" - description: If specified, indicates that the instance group uses Spot Instances. This is the maximum price you are willing to pay for Spot Instances. SpecifyOnDemandPrice
to set the amount equal to the On-Demand price, or specify an amount in USD.
InstanceType:
allOf:
- $ref: "#/components/schemas/InstanceType"
- description: The EC2 instance type for all instances in the instance group.
InstanceCount:
allOf:
- $ref: "#/components/schemas/Integer"
- description: Target number of instances for the instance group.
Configurations:
allOf:
- $ref: "#/components/schemas/ConfigurationList"
- description: 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).
EbsConfiguration: allOf: - $ref: "#/components/schemas/EbsConfiguration" - description: EBS configurations that will be attached to each EC2 instance in the instance group. AutoScalingPolicy: allOf: - $ref: "#/components/schemas/AutoScalingPolicy" - description: 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. CustomAmiId: allOf: - $ref: "#/components/schemas/XmlStringMaxLen256" - description: The custom AMI ID to use for the provisioned instance group. description: Configuration defining a new instance group. InstanceGroupState: type: string enum: - PROVISIONING - BOOTSTRAPPING - RUNNING - RECONFIGURING - RESIZING - SUSPENDED - TERMINATING - TERMINATED - ARRESTED - SHUTTING_DOWN - ENDED InstanceGroupDetail: type: object required: - Market - InstanceRole - InstanceType - InstanceRequestCount - InstanceRunningCount - State - CreationDateTime properties: InstanceGroupId: allOf: - $ref: "#/components/schemas/XmlStringMaxLen256" - description: Unique identifier for the instance group. Name: allOf: - $ref: "#/components/schemas/XmlStringMaxLen256" - description: Friendly name for the instance group. Market: allOf: - $ref: "#/components/schemas/MarketType" - description: Market type of the EC2 instances used to create a cluster node. InstanceRole: allOf: - $ref: "#/components/schemas/InstanceRoleType" - description: Instance group role in the cluster BidPrice: allOf: - $ref: "#/components/schemas/XmlStringMaxLen256" - description: If specified, indicates that the instance group uses Spot Instances. This is the maximum price you are willing to pay for Spot Instances. SpecifyOnDemandPrice
to set the amount equal to the On-Demand price, or specify an amount in USD.
InstanceType:
allOf:
- $ref: "#/components/schemas/InstanceType"
- description: EC2 instance type.
InstanceRequestCount:
allOf:
- $ref: "#/components/schemas/Integer"
- description: Target number of instances to run in the instance group.
InstanceRunningCount:
allOf:
- $ref: "#/components/schemas/Integer"
- description: Actual count of running instances.
State:
allOf:
- $ref: "#/components/schemas/InstanceGroupState"
- description: "State of instance group. The following values are no longer supported: STARTING, TERMINATED, and FAILED."
LastStateChangeReason:
allOf:
- $ref: "#/components/schemas/XmlString"
- description: Details regarding the state of the instance group.
CreationDateTime:
allOf:
- $ref: "#/components/schemas/Date"
- description: The date/time the instance group was created.
StartDateTime:
allOf:
- $ref: "#/components/schemas/Date"
- description: The date/time the instance group was started.
ReadyDateTime:
allOf:
- $ref: "#/components/schemas/Date"
- description: The date/time the instance group was available to the cluster.
EndDateTime:
allOf:
- $ref: "#/components/schemas/Date"
- description: The date/time the instance group was terminated.
CustomAmiId:
allOf:
- $ref: "#/components/schemas/XmlStringMaxLen256"
- description: The custom AMI ID to use for the provisioned instance group.
description: Detailed information about an instance group.
InstanceGroupDetailList:
type: array
items:
$ref: "#/components/schemas/InstanceGroupDetail"
InstanceGroupList:
type: array
items:
$ref: "#/components/schemas/InstanceGroup"
ReconfigurationType:
type: string
enum:
- OVERWRITE
- MERGE
InstanceGroupModifyConfig:
type: object
required:
- InstanceGroupId
properties:
InstanceGroupId:
allOf:
- $ref: "#/components/schemas/XmlStringMaxLen256"
- description: Unique ID of the instance group to modify.
InstanceCount:
allOf:
- $ref: "#/components/schemas/Integer"
- description: Target size for the instance group.
EC2InstanceIdsToTerminate:
allOf:
- $ref: "#/components/schemas/EC2InstanceIdsToTerminateList"
- description: The EC2 InstanceIds to terminate. After you terminate the instances, the instance group will not return to its original requested size.
ShrinkPolicy:
allOf:
- $ref: "#/components/schemas/ShrinkPolicy"
- description: Policy for customizing shrink operations.
ReconfigurationType:
allOf:
- $ref: "#/components/schemas/ReconfigurationType"
- description: Type of reconfiguration requested. Valid values are MERGE and OVERWRITE.
Configurations:
allOf:
- $ref: "#/components/schemas/ConfigurationList"
- description: A list of new or modified configurations to apply for an instance group.
description: Modify the size or configurations of an instance group.
InstanceGroupModifyConfigList:
type: array
items:
$ref: "#/components/schemas/InstanceGroupModifyConfig"
InstanceGroupStateChangeReasonCode:
type: string
enum:
- INTERNAL_ERROR
- VALIDATION_ERROR
- INSTANCE_FAILURE
- CLUSTER_TERMINATED
InstanceGroupStateChangeReason:
type: object
properties:
Code:
allOf:
- $ref: "#/components/schemas/InstanceGroupStateChangeReasonCode"
- description: The programmable code for the state change reason.
Message:
allOf:
- $ref: "#/components/schemas/String"
- description: The status change reason description.
description: The status change reason details for the instance group.
InstanceGroupTimeline:
type: object
properties:
CreationDateTime:
allOf:
- $ref: "#/components/schemas/Date"
- description: The creation date and time of the instance group.
ReadyDateTime:
allOf:
- $ref: "#/components/schemas/Date"
- description: The date and time when the instance group became ready to perform tasks.
EndDateTime:
allOf:
- $ref: "#/components/schemas/Date"
- description: The date and time when the instance group terminated.
description: The timeline of the instance group lifecycle.
InstanceGroupTypeList:
type: array
items:
$ref: "#/components/schemas/InstanceGroupType"
InstanceList:
type: array
items:
$ref: "#/components/schemas/Instance"
InstanceResizePolicy:
type: object
properties:
InstancesToTerminate:
allOf:
- $ref: "#/components/schemas/EC2InstanceIdsList"
- description: Specific list of instances to be terminated when shrinking an instance group.
InstancesToProtect:
allOf:
- $ref: "#/components/schemas/EC2InstanceIdsList"
- description: Specific list of instances to be protected when shrinking an instance group.
InstanceTerminationTimeout:
allOf:
- $ref: "#/components/schemas/Integer"
- description: Decommissioning timeout override for the specific list of instances to be terminated.
description: Custom policy for requesting termination protection or termination of specific instances when shrinking an instance group.
InstanceState:
type: string
enum:
- AWAITING_FULFILLMENT
- PROVISIONING
- BOOTSTRAPPING
- RUNNING
- TERMINATED
InstanceStateChangeReasonCode:
type: string
enum:
- INTERNAL_ERROR
- VALIDATION_ERROR
- INSTANCE_FAILURE
- BOOTSTRAP_FAILURE
- CLUSTER_TERMINATED
InstanceStateChangeReason:
type: object
properties:
Code:
allOf:
- $ref: "#/components/schemas/InstanceStateChangeReasonCode"
- description: The programmable code for the state change reason.
Message:
allOf:
- $ref: "#/components/schemas/String"
- description: The status change reason description.
description: The details of the status change reason for the instance.
InstanceStateList:
type: array
items:
$ref: "#/components/schemas/InstanceState"
InstanceTimeline:
type: object
properties:
CreationDateTime:
allOf:
- $ref: "#/components/schemas/Date"
- description: The creation date and time of the instance.
ReadyDateTime:
allOf:
- $ref: "#/components/schemas/Date"
- description: The date and time when the instance was ready to perform tasks.
EndDateTime:
allOf:
- $ref: "#/components/schemas/Date"
- description: The date and time when the instance was terminated.
description: The timeline of the instance lifecycle.
InstanceTypeConfig:
type: object
required:
- InstanceType
properties:
InstanceType:
allOf:
- $ref: "#/components/schemas/InstanceType"
- description: "An EC2 instance type, such as m3.xlarge
. "
WeightedCapacity:
allOf:
- $ref: "#/components/schemas/WholeNumber"
- description: "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. "
BidPrice:
allOf:
- $ref: "#/components/schemas/XmlStringMaxLen256"
- description: "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%. "
BidPriceAsPercentageOfOnDemandPrice:
allOf:
- $ref: "#/components/schemas/NonNegativeDouble"
- description: 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%.
EbsConfiguration:
allOf:
- $ref: "#/components/schemas/EbsConfiguration"
- description: "The configuration of Amazon Elastic Block Store (Amazon EBS) attached to each instance as defined by InstanceType
. "
Configurations:
allOf:
- $ref: "#/components/schemas/ConfigurationList"
- description: A configuration classification that applies when provisioning cluster instances, which can include configurations for applications and software that run on the cluster.
CustomAmiId:
allOf:
- $ref: "#/components/schemas/XmlStringMaxLen256"
- description: The custom AMI ID to use for the instance type.
description: An instance type configuration for each instance type in an instance fleet, which determines the EC2 instances Amazon EMR attempts to provision to fulfill On-Demand and Spot target capacities. When you use an allocation strategy, you can include a maximum of 30 instance type configurations for a fleet. For more information about how to use an allocation strategy, see Configure Instance Fleets. Without an allocation strategy, you may specify a maximum of five instance type configurations for a fleet.
The instance fleet configuration is available only in Amazon EMR versions 4.8.0 and later, excluding 5.0.x versions.
m3.xlarge
.
WeightedCapacity:
allOf:
- $ref: "#/components/schemas/WholeNumber"
- description: 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.
BidPrice:
allOf:
- $ref: "#/components/schemas/XmlStringMaxLen256"
- description: The bid price for each EC2 Spot Instance type as defined by InstanceType
. Expressed in USD.
BidPriceAsPercentageOfOnDemandPrice:
allOf:
- $ref: "#/components/schemas/NonNegativeDouble"
- description: 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%).
Configurations:
allOf:
- $ref: "#/components/schemas/ConfigurationList"
- description: A configuration classification that applies when provisioning cluster instances, which can include configurations for applications and software bundled with Amazon EMR.
EbsBlockDevices:
allOf:
- $ref: "#/components/schemas/EbsBlockDeviceList"
- description: The configuration of Amazon Elastic Block Store (Amazon EBS) attached to each instance as defined by InstanceType
.
EbsOptimized:
allOf:
- $ref: "#/components/schemas/BooleanObject"
- description: Evaluates to TRUE
when the specified InstanceType
is EBS-optimized.
CustomAmiId:
allOf:
- $ref: "#/components/schemas/XmlStringMaxLen256"
- description: The custom AMI ID to use for the instance type.
description: The configuration specification for each instance type in an instance fleet.
The instance fleet configuration is available only in Amazon EMR versions 4.8.0 and later, excluding 5.0.x versions.
ReleaseLabel
is used. To specify a custom AMI, use CustomAmiID
.
ExecutionStatusDetail:
allOf:
- $ref: "#/components/schemas/JobFlowExecutionStatusDetail"
- description: Describes the execution status of the job flow.
Instances:
allOf:
- $ref: "#/components/schemas/JobFlowInstancesDetail"
- description: Describes the Amazon EC2 instances of the job flow.
Steps:
allOf:
- $ref: "#/components/schemas/StepDetailList"
- description: A list of steps run by the job flow.
BootstrapActions:
allOf:
- $ref: "#/components/schemas/BootstrapActionDetailList"
- description: A list of the bootstrap actions run by the job flow.
SupportedProducts:
allOf:
- $ref: "#/components/schemas/SupportedProductsList"
- description: 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.
VisibleToAllUsers:
allOf:
- $ref: "#/components/schemas/Boolean"
- description: Indicates whether the cluster is visible to IAM principals in the Amazon Web Services account associated with the cluster. When true
, IAM principals in the Amazon Web Services account can perform EMR cluster actions that their IAM policies allow. When false
, only the IAM principal that created the cluster and the Amazon Web Services account root user can perform EMR actions, regardless of IAM permissions policies attached to other IAM principals.
The default value is true
if a value is not provided when creating a cluster using the EMR API RunJobFlow command, the CLI create-cluster command, or the Amazon Web Services Management Console.
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.
ScaleDownBehavior:
allOf:
- $ref: "#/components/schemas/ScaleDownBehavior"
- description: 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 adds nodes to a deny list 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.
description: A description of a cluster (job flow).
JobFlowExecutionState:
type: string
enum:
- STARTING
- BOOTSTRAPPING
- RUNNING
- WAITING
- SHUTTING_DOWN
- TERMINATED
- COMPLETED
- FAILED
description: The type of instance.
PlacementType:
type: object
properties:
AvailabilityZone:
allOf:
- $ref: "#/components/schemas/XmlString"
- description: The Amazon EC2 Availability Zone for the cluster. AvailabilityZone
is used for uniform instance groups, while AvailabilityZones
(plural) is used for instance fleets.
AvailabilityZones:
allOf:
- $ref: "#/components/schemas/XmlStringMaxLen256List"
- description: 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.
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.
Ec2KeyName: allOf: - $ref: "#/components/schemas/XmlStringMaxLen256" - description: The name of the EC2 key pair that can be used to connect to the master node using SSH as the user called "hadoop." Placement: allOf: - $ref: "#/components/schemas/PlacementType" - description: The Availability Zone in which the cluster runs. KeepJobFlowAliveWhenNoSteps: allOf: - $ref: "#/components/schemas/Boolean" - description: Specifies whether the cluster should remain available after completing all steps. Defaults totrue
. For more information about configuring cluster termination, see Control Cluster Termination in the EMR Management Guide.
TerminationProtected:
allOf:
- $ref: "#/components/schemas/Boolean"
- description: 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.
HadoopVersion:
allOf:
- $ref: "#/components/schemas/XmlStringMaxLen256"
- description: Applies only to Amazon EMR release versions earlier than 4.0. The Hadoop version for the cluster. Valid inputs are "0.18" (no longer maintained), "0.20" (no longer maintained), "0.20.205" (no longer maintained), "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.
Ec2SubnetId:
allOf:
- $ref: "#/components/schemas/XmlStringMaxLen256"
- description: 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.
Ec2SubnetIds:
allOf:
- $ref: "#/components/schemas/XmlStringMaxLen256List"
- description: 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.
EmrManagedMasterSecurityGroup
, you must also specify EmrManagedSlaveSecurityGroup
.
EmrManagedSlaveSecurityGroup:
allOf:
- $ref: "#/components/schemas/XmlStringMaxLen256"
- description: The identifier of the Amazon EC2 security group for the core and task nodes. If you specify EmrManagedSlaveSecurityGroup
, you must also specify EmrManagedMasterSecurityGroup
.
ServiceAccessSecurityGroup:
allOf:
- $ref: "#/components/schemas/XmlStringMaxLen256"
- description: The identifier of the Amazon EC2 security group for the Amazon EMR service to access clusters in VPC private subnets.
AdditionalMasterSecurityGroups:
allOf:
- $ref: "#/components/schemas/SecurityGroupsList"
- description: A list of additional Amazon EC2 security group IDs for the master node.
AdditionalSlaveSecurityGroups:
allOf:
- $ref: "#/components/schemas/SecurityGroupsList"
- description: A list of additional Amazon EC2 security group IDs for the core and task nodes.
description: A description of the Amazon EC2 instance on which the cluster (job flow) runs. A valid JobFlowInstancesConfig must contain either InstanceGroups or InstanceFleets. They cannot be used together. You may also have MasterInstanceType, SlaveInstanceType, and InstanceCount (all three must be present), but we don't recommend this configuration.
KeyValue:
type: object
properties:
Key:
allOf:
- $ref: "#/components/schemas/XmlString"
- description: The unique identifier of a key-value pair.
Value:
allOf:
- $ref: "#/components/schemas/XmlString"
- description: The value part of the identified key.
description: A key-value pair.
Marker:
type: string
NotebookExecutionStatus:
type: string
enum:
- START_PENDING
- STARTING
- RUNNING
- FINISHING
- FINISHED
- FAILING
- FAILED
- STOP_PENDING
- STOPPING
- STOPPED
NotebookExecutionSummaryList:
type: array
items:
$ref: "#/components/schemas/NotebookExecutionSummary"
ReleaseLabelFilter:
type: object
properties:
Prefix:
allOf:
- $ref: "#/components/schemas/String"
- description: Optional release label version prefix filter. For example, emr-5
.
Application:
allOf:
- $ref: "#/components/schemas/String"
- description: Optional release label application filter. For example, spark@2.1.0
.
description: The release label filters by application or version prefix.
SecurityConfigurationList:
type: array
items:
$ref: "#/components/schemas/SecurityConfigurationSummary"
StepStateList:
type: array
items:
$ref: "#/components/schemas/StepState"
StepSummaryList:
type: array
items:
$ref: "#/components/schemas/StepSummary"
SessionMappingSummaryList:
type: array
items:
$ref: "#/components/schemas/SessionMappingSummary"
StudioSummaryList:
type: array
items:
$ref: "#/components/schemas/StudioSummary"
MetricDimension:
type: object
properties:
Key:
allOf:
- $ref: "#/components/schemas/String"
- description: The dimension name.
Value:
allOf:
- $ref: "#/components/schemas/String"
- description: The dimension value.
description: A CloudWatch dimension, which is specified using a Key
(known as a Name
in CloudWatch), Value
pair. By default, Amazon EMR uses one dimension whose Key
is JobFlowID
and Value
is a variable representing the cluster ID, which is ${emr.clusterId}
. This enables the rule to bootstrap when the cluster ID becomes available.
SupportedProductConfig:
type: object
properties:
Name:
allOf:
- $ref: "#/components/schemas/XmlStringMaxLen256"
- description: The name of the product configuration.
Args:
allOf:
- $ref: "#/components/schemas/XmlStringList"
- description: The list of user-supplied arguments.
description: The list of supported product configurations that allow user-supplied arguments. EMR accepts these arguments and forwards them to the corresponding installation script as bootstrap action arguments.
NewSupportedProductsList:
type: array
items:
$ref: "#/components/schemas/SupportedProductConfig"
NotebookExecutionSummary:
type: object
properties:
NotebookExecutionId:
allOf:
- $ref: "#/components/schemas/XmlStringMaxLen256"
- description: The unique identifier of the notebook execution.
EditorId:
allOf:
- $ref: "#/components/schemas/XmlStringMaxLen256"
- description: The unique identifier of the editor associated with the notebook execution.
NotebookExecutionName:
allOf:
- $ref: "#/components/schemas/XmlStringMaxLen256"
- description: The name of the notebook execution.
Status:
allOf:
- $ref: "#/components/schemas/NotebookExecutionStatus"
- description: The status of the notebook execution.
START_PENDING
indicates that the cluster has received the execution request but execution has not begun.
STARTING
indicates that the execution is starting on the cluster.
RUNNING
indicates that the execution is being processed by the cluster.
FINISHING
indicates that execution processing is in the final stages.
FINISHED
indicates that the execution has completed without error.
FAILING
indicates that the execution is failing and will not finish successfully.
FAILED
indicates that the execution failed.
STOP_PENDING
indicates that the cluster has received a StopNotebookExecution
request and the stop is pending.
STOPPING
indicates that the cluster is in the process of stopping the execution as a result of a StopNotebookExecution
request.
STOPPED
indicates that the execution stopped because of a StopNotebookExecution
request.
Indicates whether to use unused Capacity Reservations for fulfilling On-Demand capacity.
If you specify use-capacity-reservations-first
, the fleet uses unused Capacity Reservations to fulfill On-Demand capacity up to the target On-Demand capacity. If multiple instance pools have unused Capacity Reservations, the On-Demand allocation strategy (lowest-price
) is applied. If the number of unused Capacity Reservations is less than the On-Demand target capacity, the remaining On-Demand target capacity is launched according to the On-Demand allocation strategy (lowest-price
).
If you do not specify a value, the fleet fulfills the On-Demand capacity according to the chosen On-Demand allocation strategy.
CapacityReservationPreference: allOf: - $ref: "#/components/schemas/OnDemandCapacityReservationPreference" - description:Indicates the instance's Capacity Reservation preferences. Possible preferences include:
open
- The instance can run in any open Capacity Reservation that has matching attributes (instance type, platform, Availability Zone).
none
- The instance avoids running in a Capacity Reservation even if one is available. The instance runs as an On-Demand Instance.
Role of the instance in the cluster.
Starting with Amazon EMR version 5.23.0, the only supported instance role is MASTER
.
EC2 Placement Group strategy associated with instance role.
Starting with Amazon EMR version 5.23.0, the only supported placement strategy is SPREAD
for the MASTER
instance role.
Placement group configuration for an Amazon EMR cluster. The configuration specifies the placement strategy that can be applied to instance roles during cluster creation.
To use this configuration, consider attaching managed policy AmazonElasticMapReducePlacementGroupPolicy to the EMR role.
Port: type: integer minimum: -1 maximum: 65535 PortRange: type: object required: - MinRange properties: MinRange: allOf: - $ref: "#/components/schemas/Port" - description: The smallest port number in a specified range of port numbers. MaxRange: allOf: - $ref: "#/components/schemas/Port" - description: The smallest port number in a specified range of port numbers. description: A list of port ranges that are permitted to allow inbound traffic from all public IP addresses. To specify a single port, use the same value forMinRange
and MaxRange
.
SimpleScalingPolicyConfiguration:
type: object
required:
- ScalingAdjustment
properties:
AdjustmentType:
allOf:
- $ref: "#/components/schemas/AdjustmentType"
- description: 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.
ScalingAdjustment:
allOf:
- $ref: "#/components/schemas/Integer"
- description: 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.
CoolDown:
allOf:
- $ref: "#/components/schemas/Integer"
- description: 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.
description: An automatic scaling configuration, which describes how the policy adds or removes instances, the cooldown period, and the number of EC2 instances that will be added each time the CloudWatch metric alarm condition is satisfied.
ScalingAction:
type: object
required:
- SimpleScalingPolicyConfiguration
properties:
Market:
allOf:
- $ref: "#/components/schemas/MarketType"
- description: Not available for instance groups. Instance groups use the market type specified for the group.
SimpleScalingPolicyConfiguration:
allOf:
- $ref: "#/components/schemas/SimpleScalingPolicyConfiguration"
- description: The type of adjustment the automatic scaling activity makes when triggered, and the periodicity of the adjustment.
description: The type of adjustment the automatic scaling activity makes when triggered, and the periodicity of the adjustment.
ScalingTrigger:
type: object
required:
- CloudWatchAlarmDefinition
properties:
CloudWatchAlarmDefinition:
allOf:
- $ref: "#/components/schemas/CloudWatchAlarmDefinition"
- description: The definition of a CloudWatch metric alarm. When the defined alarm conditions are met along with other trigger parameters, scaling activity begins.
description: The conditions that trigger an automatic scaling activity.
ScalingRule:
type: object
required:
- Name
- Action
- Trigger
properties:
Name:
allOf:
- $ref: "#/components/schemas/String"
- description: The name used to identify an automatic scaling rule. Rule names must be unique within a scaling policy.
Description:
allOf:
- $ref: "#/components/schemas/String"
- description: A friendly, more verbose description of the automatic scaling rule.
Action:
allOf:
- $ref: "#/components/schemas/ScalingAction"
- description: The conditions that trigger an automatic scaling activity.
Trigger:
allOf:
- $ref: "#/components/schemas/ScalingTrigger"
- description: The CloudWatch alarm definition that determines when automatic scaling activity is triggered.
description: A scale-in or scale-out rule that defines scaling activity, including the CloudWatch metric alarm that triggers activity, how EC2 instances are added or removed, and the periodicity of adjustments. The automatic scaling policy for an instance group can comprise one or more automatic scaling rules.
SecurityConfigurationSummary:
type: object
properties:
Name:
allOf:
- $ref: "#/components/schemas/XmlString"
- description: The name of the security configuration.
CreationDateTime:
allOf:
- $ref: "#/components/schemas/Date"
- description: The date and time the security configuration was created.
description: The creation date and time, and name, of a security configuration.
SessionMappingSummary:
type: object
properties:
StudioId:
allOf:
- $ref: "#/components/schemas/XmlStringMaxLen256"
- description: The ID of the Amazon EMR Studio.
IdentityId:
allOf:
- $ref: "#/components/schemas/XmlStringMaxLen256"
- description: The globally unique identifier (GUID) of the user or group from the IAM Identity Center Identity Store.
IdentityName:
allOf:
- $ref: "#/components/schemas/XmlStringMaxLen256"
- description: The name of the user or group. For more information, see UserName and DisplayName in the IAM Identity Center Identity Store API Reference.
IdentityType:
allOf:
- $ref: "#/components/schemas/IdentityType"
- description: Specifies whether the identity mapped to the Amazon EMR Studio is a user or a group.
SessionPolicyArn:
allOf:
- $ref: "#/components/schemas/XmlStringMaxLen256"
- description: The Amazon Resource Name (ARN) of the session policy associated with the user or group.
CreationTime:
allOf:
- $ref: "#/components/schemas/Date"
- description: The time the session mapping was created.
description: Details for an Amazon EMR Studio session mapping. The details do not include the time the session mapping was last modified.
SimplifiedApplication:
type: object
properties:
Name:
allOf:
- $ref: "#/components/schemas/String"
- description: The returned release label application name. For example, hadoop
.
Version:
allOf:
- $ref: "#/components/schemas/String"
- description: The returned release label application version. For example, 3.2.1
.
description: The returned release label application names or versions.
SpotProvisioningAllocationStrategy:
type: string
enum:
- capacity-optimized
SpotProvisioningTimeoutAction:
type: string
enum:
- SWITCH_TO_ON_DEMAND
- TERMINATE_CLUSTER
StepStatus:
type: object
properties:
State:
allOf:
- $ref: "#/components/schemas/StepState"
- description: The execution state of the cluster step.
StateChangeReason:
allOf:
- $ref: "#/components/schemas/StepStateChangeReason"
- description: The reason for the step execution status change.
FailureDetails:
allOf:
- $ref: "#/components/schemas/FailureDetails"
- description: The details for the step failure including reason, message, and log file path where the root cause was identified.
Timeline:
allOf:
- $ref: "#/components/schemas/StepTimeline"
- description: The timeline of the cluster step status over time.
description: The execution status details of the cluster step.
StepConfig:
type: object
required:
- Name
- HadoopJarStep
properties:
Name:
allOf:
- $ref: "#/components/schemas/XmlStringMaxLen256"
- description: The name of the step.
ActionOnFailure:
allOf:
- $ref: "#/components/schemas/ActionOnFailure"
- description: The action to take when the step fails. Use one of the following values:
TERMINATE_CLUSTER
- Shuts down the cluster.
CANCEL_AND_WAIT
- Cancels any pending steps and returns the cluster to the WAITING
state.
CONTINUE
- Continues to the next step in the queue.
TERMINATE_JOB_FLOW
- Shuts down the cluster. TERMINATE_JOB_FLOW
is provided for backward compatibility. We recommend using TERMINATE_CLUSTER
instead.
If a cluster's StepConcurrencyLevel
is greater than 1
, do not use AddJobFlowSteps
to submit a step with this parameter set to CANCEL_AND_WAIT
or TERMINATE_CLUSTER
. The step is not submitted and the action fails with a message that the ActionOnFailure
setting is not valid.
If you change a cluster's StepConcurrencyLevel
to be greater than 1 while a step is running, the ActionOnFailure
parameter may not behave as you expect. In this case, for a step that fails with this parameter set to CANCEL_AND_WAIT
, pending steps and the running step are not canceled; for a step that fails with this parameter set to TERMINATE_CLUSTER
, the cluster does not terminate.