find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/amazon-emr:amazon-emr-notebook-execution-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Amazon EMR Notebook Execution API
  version: '2009-03-31'
  description: Generated from AWS's published Smithy model for Amazon EMR. 4 operation(s).
  contact:
    name: Amazon Web Services
    url: https://aws.amazon.com/contact-us/
  license:
    name: Apache 2.0
    identifier: Apache-2.0
    url: https://github.com/aws/api-models-aws/blob/main/LICENSE
servers:
- url: https://elasticmapreduce.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
tags:
- name: Notebook Execution
paths:
  /#DescribeNotebookExecution:
    post:
      operationId: DescribeNotebookExecution
      summary: Describe Notebook Execution
      description: Provides details of a notebook execution.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DescribeNotebookExecutionOutput'
        '500':
          description: InternalServerError
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InternalServerError'
        '400':
          description: InvalidRequestException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InvalidRequestException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - ElasticMapReduce.DescribeNotebookExecution
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DescribeNotebookExecutionInput'
      tags:
      - Notebook Execution
  /#ListNotebookExecutions:
    post:
      operationId: ListNotebookExecutions
      summary: List Notebook Executions
      description: Provides summaries of all notebook executions. You can filter the list based on multiple criteria such as status, time range, and editor id. Returns a maximum of 50 notebook executions and a marker to track the paging of a longer notebook execution list across multiple ListNotebookExecutions calls.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ListNotebookExecutionsOutput'
        '500':
          description: InternalServerError
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InternalServerError'
        '400':
          description: InvalidRequestException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InvalidRequestException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - ElasticMapReduce.ListNotebookExecutions
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/ListNotebookExecutionsInput'
      tags:
      - Notebook Execution
  /#StartNotebookExecution:
    post:
      operationId: StartNotebookExecution
      summary: Start Notebook Execution
      description: Starts a notebook execution.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/StartNotebookExecutionOutput'
        '500':
          description: InternalServerException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '400':
          description: InvalidRequestException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InvalidRequestException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - ElasticMapReduce.StartNotebookExecution
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/StartNotebookExecutionInput'
      tags:
      - Notebook Execution
  /#StopNotebookExecution:
    post:
      operationId: StopNotebookExecution
      summary: Stop Notebook Execution
      description: Stops a notebook execution.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                type: string
        '500':
          description: InternalServerError
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InternalServerError'
        '400':
          description: InvalidRequestException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InvalidRequestException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - ElasticMapReduce.StopNotebookExecution
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/StopNotebookExecutionInput'
      tags:
      - Notebook Execution
components:
  schemas:
    DescribeNotebookExecutionOutput:
      type: object
      properties:
        NotebookExecution:
          $ref: '#/components/schemas/NotebookExecution'
    ExecutionEngineConfig:
      type: object
      properties:
        Id:
          type: string
          description: The unique identifier of the execution engine. For an Amazon EMR cluster, this is the cluster ID.
        Type:
          type: string
          enum:
          - EMR
          description: The type of execution engine. A value of EMR specifies an Amazon EMR cluster.
        MasterInstanceSecurityGroupId:
          type: string
          description: An optional unique ID of an Amazon EC2 security group to associate with the master instance of the Amazon EMR cluster for this notebook execution. For more information see Specifying Amazon EC2 Security Groups for Amazon EMR Notebooks in the EMR Management Guide.
        ExecutionRoleArn:
          type: string
          description: The execution role ARN required for the notebook execution.
      required:
      - Id
    ListNotebookExecutionsOutput:
      type: object
      properties:
        NotebookExecutions:
          type: array
          items:
            $ref: '#/components/schemas/NotebookExecutionSummary'
          description: A list of notebook executions.
        Marker:
          type: string
          description: A pagination token that a subsequent ListNotebookExecutions can use to determine the next set of results to retrieve.
    NotebookExecutionSummary:
      type: object
      properties:
        NotebookExecutionId:
          type: string
          description: The unique identifier of the notebook execution.
        EditorId:
          type: string
          description: The unique identifier of the editor associated with the notebook execution.
        NotebookExecutionName:
          type: string
          description: The name of the notebook execution.
        Status:
          type: string
          enum:
          - START_PENDING
          - STARTING
          - RUNNING
          - FINISHING
          - FINISHED
          - FAILING
          - FAILED
          - STOP_PENDING
          - STOPPING
          - STOPPED
          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 S
        StartTime:
          type: string
          format: date-time
          description: The timestamp when notebook execution started.
        EndTime:
          type: string
          format: date-time
          description: The timestamp when notebook execution started.
        NotebookS3Location:
          $ref: '#/components/schemas/NotebookS3LocationForOutput'
        ExecutionEngineId:
          type: string
          description: The unique ID of the execution engine for the notebook execution.
    ListNotebookExecutionsInput:
      type: object
      properties:
        EditorId:
          type: string
          description: The unique ID of the editor associated with the notebook execution.
        Status:
          type: string
          enum:
          - START_PENDING
          - STARTING
          - RUNNING
          - FINISHING
          - FINISHED
          - FAILING
          - FAILED
          - STOP_PENDING
          - STOPPING
          - STOPPED
          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
        From:
          type: string
          format: date-time
          description: The beginning of time range filter for listing notebook executions. The default is the timestamp of 30 days ago.
        To:
          type: string
          format: date-time
          description: The end of time range filter for listing notebook executions. The default is the current timestamp.
        Marker:
          type: string
          description: The pagination token, returned by a previous ListNotebookExecutions call, that indicates the start of the list for this ListNotebookExecutions call.
        ExecutionEngineId:
          type: string
          description: The unique ID of the execution engine.
    OutputNotebookS3LocationFromInput:
      type: object
      properties:
        Bucket:
          type: string
          description: The Amazon S3 bucket that stores the notebook execution output.
        Key:
          type: string
          description: The key to the Amazon S3 location that stores the notebook execution output.
    DescribeNotebookExecutionInput:
      type: object
      properties:
        NotebookExecutionId:
          type: string
          description: The unique identifier of the notebook execution.
      required:
      - NotebookExecutionId
    InternalServerException:
      type: object
      properties:
        Message:
          type: string
          description: The message associated with the exception.
    StartNotebookExecutionInput:
      type: object
      properties:
        EditorId:
          type: string
          description: The unique identifier of the Amazon EMR Notebook to use for notebook execution.
        RelativePath:
          type: string
          description: The path and file name of the notebook file for this execution, relative to the path specified for the Amazon EMR Notebook. For example, if you specify a path of s3://MyBucket/MyNotebooks when you create an Amazon 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:
          type: string
          description: An optional name for the notebook execution.
        NotebookParams:
          type: string
          description: Input parameters in JSON format passed to the Amazon EMR Notebook at runtime for execution.
        ExecutionEngine:
          $ref: '#/components/schemas/ExecutionEngineConfig'
        ServiceRole:
          type: string
          description: The name or ARN of the IAM role that is used as the service role for Amazon EMR (the Amazon EMR role) for the notebook execution.
        NotebookInstanceSecurityGroupId:
          type: string
          description: The unique identifier of the Amazon EC2 security group to associate with the Amazon EMR Notebook for this notebook execution.
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          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.
        NotebookS3Location:
          $ref: '#/components/schemas/NotebookS3LocationFromInput'
        OutputNotebookS3Location:
          $ref: '#/components/schemas/OutputNotebookS3LocationFromInput'
        OutputNotebookFormat:
          type: string
          enum:
          - HTML
          description: The output format for the notebook execution.
        EnvironmentVariables:
          type: object
          additionalProperties:
            type: string
          description: The environment variables associated with the notebook execution.
      required:
      - ExecutionEngine
      - ServiceRole
    StartNotebookExecutionOutput:
      type: object
      properties:
        NotebookExecutionId:
          type: string
          description: The unique identifier of the notebook execution.
    NotebookS3LocationFromInput:
      type: object
      properties:
        Bucket:
          type: string
          description: The Amazon S3 bucket that stores the notebook execution input.
        Key:
          type: string
          description: The key to the Amazon S3 location that stores the notebook execution input.
    StopNotebookExecutionInput:
      type: object
      properties:
        NotebookExecutionId:
          type: string
          description: The unique identifier of the notebook execution.
      required:
      - NotebookExecutionId
    Tag:
      type: object
      properties:
        Key:
          type: string
          description: A user-defined key, which is the minimum required information for a valid tag. For more information, see Tag.
        Value:
          type: string
          description: A user-defined value, which is optional in a tag. For more information, see Tag Clusters.
    InvalidRequestException:
      type: object
      properties:
        ErrorCode:
          type: string
          description: The error code associated with the exception.
        Message:
          type: string
          description: The message associated with the exception.
    OutputNotebookS3LocationForOutput:
      type: object
      properties:
        Bucket:
          type: string
          description: The Amazon S3 bucket that stores the notebook execution output.
        Key:
          type: string
          description: The key to the Amazon S3 location that stores the notebook execution output.
    InternalServerError:
      type: object
      properties: {}
    NotebookExecution:
      type: object
      properties:
        NotebookExecutionId:
          type: string
          description: The unique identifier of a notebook execution.
        EditorId:
          type: string
          description: The unique identifier of the Amazon EMR Notebook that is used for the notebook execution.
        ExecutionEngine:
          $ref: '#/components/schemas/ExecutionEngineConfig'
        NotebookExecutionName:
          type: string
          description: A name for the notebook execution.
        NotebookParams:
          type: string
          description: Input parameters in JSON format passed to the Amazon EMR Notebook at runtime for execution.
        Status:
          type: string
          enum:
          - START_PENDING
          - STARTING
          - RUNNING
          - FINISHING
          - FINISHED
          - FAILING
          - FAILED
          - STOP_PENDING
          - STOPPING
          - STOPPED
          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 S
        StartTime:
          type: string
          format: date-time
          description: The timestamp when notebook execution started.
        EndTime:
          type: string
          format: date-time
          description: The timestamp when notebook execution ended.
        Arn:
          type: string
          description: The Amazon Resource Name (ARN) of the notebook execution.
        OutputNotebookURI:
          type: string
          description: The location of the notebook execution's output file in Amazon S3.
        LastStateChangeReason:
          type: string
          description: The reason for the latest status change of the notebook execution.
        NotebookInstanceSecurityGroupId:
          type: string
          description: The unique identifier of the Amazon EC2 security group associated with the Amazon EMR Notebook instance. For more information see Specifying Amazon EC2 Security Groups for Amazon EMR Notebooks in the Amazon EMR Management Guide.
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          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.
        NotebookS3Location:
          $ref: '#/components/schemas/NotebookS3LocationForOutput'
        OutputNotebookS3Location:
          $ref: '#/components/schemas/OutputNotebookS3LocationForOutput'
        OutputNotebookFormat:
          type: string
          enum:
          - HTML
          description: The output format for the notebook execution.
        EnvironmentVariables:
          type: object
          additionalProperties:
            type: string
          description: The environment variables associated with the notebook execution.
    NotebookS3LocationForOutput:
      type: object
      properties:
        Bucket:
          type: string
          description: The Amazon S3 bucket that stores the notebook execution input.
        Key:
          type: string
          description: The key to the Amazon S3 location that stores the notebook execution input.
  securitySchemes:
    sigv4:
      type: apiKey
      in: header
      name: Authorization
      description: AWS Signature Version 4. The Authorization header carries an AWS4-HMAC-SHA256 signature over the canonical request, with X-Amz-Date (and X-Amz-Security-Token for temporary credentials). Not a bearer token.
      x-aws-sigv4:
        signingName: elasticmapreduce
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/emr/service/2009-03-31/emr-2009-03-31.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)