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-athena:amazon-athena-notebook-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 Athena Notebook API
  version: '2017-05-18'
  description: Generated from AWS's published Smithy model for Amazon Athena. 5 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://athena.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
tags:
- name: Notebook
paths:
  /#CreateNotebook:
    post:
      operationId: CreateNotebook
      summary: Create Notebook
      description: Creates an empty ipynb file in the specified Apache Spark enabled workgroup. Throws an error if a file in the workgroup with the same name already exists.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/CreateNotebookOutput'
        '500':
          description: InternalServerException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '400':
          description: InvalidRequestException; TooManyRequestsException
          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:
          - AmazonAthena.CreateNotebook
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/CreateNotebookInput'
      tags:
      - Notebook
  /#DeleteNotebook:
    post:
      operationId: DeleteNotebook
      summary: Delete Notebook
      description: Deletes the specified notebook.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DeleteNotebookOutput'
        '500':
          description: InternalServerException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '400':
          description: InvalidRequestException; TooManyRequestsException
          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:
          - AmazonAthena.DeleteNotebook
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DeleteNotebookInput'
      tags:
      - Notebook
  /#ExportNotebook:
    post:
      operationId: ExportNotebook
      summary: Export Notebook
      description: Exports the specified notebook and its metadata.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ExportNotebookOutput'
        '500':
          description: InternalServerException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '400':
          description: InvalidRequestException; TooManyRequestsException
          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:
          - AmazonAthena.ExportNotebook
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/ExportNotebookInput'
      tags:
      - Notebook
  /#ImportNotebook:
    post:
      operationId: ImportNotebook
      summary: Import Notebook
      description: Imports a single ipynb file to a Spark enabled workgroup. To import the notebook, the request must specify a value for either Payload or NoteBookS3LocationUri. If neither is specified or both are specified, an InvalidRequestException occurs. The maximum file size that can be imported is 10 megabytes. If an ipynb file with the same name already exists in the workgroup, throws an error.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ImportNotebookOutput'
        '500':
          description: InternalServerException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '400':
          description: InvalidRequestException; TooManyRequestsException
          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:
          - AmazonAthena.ImportNotebook
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/ImportNotebookInput'
      tags:
      - Notebook
  /#UpdateNotebook:
    post:
      operationId: UpdateNotebook
      summary: Update Notebook
      description: Updates the contents of a Spark notebook.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/UpdateNotebookOutput'
        '500':
          description: InternalServerException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '400':
          description: InvalidRequestException; TooManyRequestsException
          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:
          - AmazonAthena.UpdateNotebook
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/UpdateNotebookInput'
      tags:
      - Notebook
components:
  schemas:
    UpdateNotebookOutput:
      type: object
      properties: {}
    UpdateNotebookInput:
      type: object
      properties:
        NotebookId:
          type: string
          description: The ID of the notebook to update.
        Payload:
          type: string
          description: The updated content for the notebook.
        Type:
          type: string
          enum:
          - IPYNB
          description: The notebook content type. Currently, the only valid type is IPYNB.
        SessionId:
          type: string
          description: The active notebook session ID. Required if the notebook has an active session.
        ClientRequestToken:
          type: string
          description: A unique case-sensitive string used to ensure the request to create the notebook is idempotent (executes only once). This token is listed as not required because Amazon Web Services SDKs (for example the Amazon Web Services SDK for Java) auto-generate the token for you. If you are not using the Amazon Web Services SDK or the Amazon Web Services CLI, you must provide this token or the action will fail.
      required:
      - NotebookId
      - Payload
      - Type
    InvalidRequestException:
      type: object
      properties:
        AthenaErrorCode:
          type: string
        Message:
          type: string
    ImportNotebookInput:
      type: object
      properties:
        WorkGroup:
          type: string
          description: The name of the Spark enabled workgroup to import the notebook to.
        Name:
          type: string
          description: The name of the notebook to import.
        Payload:
          type: string
          description: The notebook content to be imported. The payload must be in ipynb format.
        Type:
          type: string
          enum:
          - IPYNB
          description: The notebook content type. Currently, the only valid type is IPYNB.
        NotebookS3LocationUri:
          type: string
          description: A URI that specifies the Amazon S3 location of a notebook file in ipynb format.
        ClientRequestToken:
          type: string
          description: A unique case-sensitive string used to ensure the request to import the notebook is idempotent (executes only once). This token is listed as not required because Amazon Web Services SDKs (for example the Amazon Web Services SDK for Java) auto-generate the token for you. If you are not using the Amazon Web Services SDK or the Amazon Web Services CLI, you must provide this token or the action will fail.
      required:
      - WorkGroup
      - Name
      - Type
    ImportNotebookOutput:
      type: object
      properties:
        NotebookId:
          type: string
          description: The ID assigned to the imported notebook.
    ExportNotebookOutput:
      type: object
      properties:
        NotebookMetadata:
          $ref: '#/components/schemas/NotebookMetadata'
        Payload:
          type: string
          description: The content of the exported notebook.
    DeleteNotebookInput:
      type: object
      properties:
        NotebookId:
          type: string
          description: The ID of the notebook to delete.
      required:
      - NotebookId
    NotebookMetadata:
      type: object
      properties:
        NotebookId:
          type: string
          description: The notebook ID.
        Name:
          type: string
          description: The name of the notebook.
        WorkGroup:
          type: string
          description: The name of the Spark enabled workgroup to which the notebook belongs.
        CreationTime:
          type: string
          format: date-time
          description: The time when the notebook was created.
        Type:
          type: string
          enum:
          - IPYNB
          description: The type of notebook. Currently, the only valid type is IPYNB.
        LastModifiedTime:
          type: string
          format: date-time
          description: The time when the notebook was last modified.
    CreateNotebookInput:
      type: object
      properties:
        WorkGroup:
          type: string
          description: The name of the Spark enabled workgroup in which the notebook will be created.
        Name:
          type: string
          description: The name of the ipynb file to be created in the Spark workgroup, without the .ipynb extension.
        ClientRequestToken:
          type: string
          description: A unique case-sensitive string used to ensure the request to create the notebook is idempotent (executes only once). This token is listed as not required because Amazon Web Services SDKs (for example the Amazon Web Services SDK for Java) auto-generate the token for you. If you are not using the Amazon Web Services SDK or the Amazon Web Services CLI, you must provide this token or the action will fail.
      required:
      - WorkGroup
      - Name
    ExportNotebookInput:
      type: object
      properties:
        NotebookId:
          type: string
          description: The ID of the notebook to export.
      required:
      - NotebookId
    InternalServerException:
      type: object
      properties:
        Message:
          type: string
    CreateNotebookOutput:
      type: object
      properties:
        NotebookId:
          type: string
          description: A unique identifier for the notebook.
    DeleteNotebookOutput:
      type: object
      properties: {}
  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: athena
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/athena/service/2017-05-18/athena-2017-05-18.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)