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-metadata-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 Metadata API
  version: '2017-05-18'
  description: Generated from AWS's published Smithy model for Amazon Athena. 3 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 Metadata
paths:
  /#GetNotebookMetadata:
    post:
      operationId: GetNotebookMetadata
      summary: Get Notebook Metadata
      description: Retrieves notebook metadata for the specified notebook ID.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/GetNotebookMetadataOutput'
        '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.GetNotebookMetadata
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/GetNotebookMetadataInput'
      tags:
      - Notebook Metadata
  /#ListNotebookMetadata:
    post:
      operationId: ListNotebookMetadata
      summary: List Notebook Metadata
      description: Displays the notebook files for the specified workgroup in paginated format.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ListNotebookMetadataOutput'
        '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.ListNotebookMetadata
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/ListNotebookMetadataInput'
      tags:
      - Notebook Metadata
  /#UpdateNotebookMetadata:
    post:
      operationId: UpdateNotebookMetadata
      summary: Update Notebook Metadata
      description: Updates the metadata for a notebook.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/UpdateNotebookMetadataOutput'
        '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.UpdateNotebookMetadata
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/UpdateNotebookMetadataInput'
      tags:
      - Notebook Metadata
components:
  schemas:
    GetNotebookMetadataInput:
      type: object
      properties:
        NotebookId:
          type: string
          description: The ID of the notebook whose metadata is to be retrieved.
      required:
      - NotebookId
    UpdateNotebookMetadataOutput:
      type: object
      properties: {}
    GetNotebookMetadataOutput:
      type: object
      properties:
        NotebookMetadata:
          $ref: '#/components/schemas/NotebookMetadata'
    UpdateNotebookMetadataInput:
      type: object
      properties:
        NotebookId:
          type: string
          description: The ID of the notebook to update the metadata for.
        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.
        Name:
          type: string
          description: The name to update the notebook to.
      required:
      - NotebookId
      - Name
    InvalidRequestException:
      type: object
      properties:
        AthenaErrorCode:
          type: string
        Message:
          type: string
    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.
    FilterDefinition:
      type: object
      properties:
        Name:
          type: string
          description: The name of the notebook to search for.
    InternalServerException:
      type: object
      properties:
        Message:
          type: string
    ListNotebookMetadataOutput:
      type: object
      properties:
        NextToken:
          type: string
          description: A token generated by the Athena service that specifies where to continue pagination if a previous request was truncated. To obtain the next set of pages, pass in the NextToken from the response object of the previous page call.
        NotebookMetadataList:
          type: array
          items:
            $ref: '#/components/schemas/NotebookMetadata'
          description: The list of notebook metadata for the specified workgroup.
    ListNotebookMetadataInput:
      type: object
      properties:
        Filters:
          $ref: '#/components/schemas/FilterDefinition'
        NextToken:
          type: string
          description: A token generated by the Athena service that specifies where to continue pagination if a previous request was truncated.
        MaxResults:
          type: integer
          description: Specifies the maximum number of results to return.
        WorkGroup:
          type: string
          description: The name of the Spark enabled workgroup to retrieve notebook metadata for.
      required:
      - WorkGroup
  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)