Amazon DataZone Datazone Notebook Runs API

openapi: 3.2.0
info:
  title: Amazon DataZone Notebook Runs API
  version: '2018-05-10'
  description: Generated from AWS's published Smithy model for Amazon DataZone. 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://datazone.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
tags:
- name: Notebook Runs
paths:
  /v2/domains/{domainIdentifier}/notebook-runs:
    post:
      operationId: StartNotebookRun
      summary: Start Notebook Run
      description: Starts a notebook run in Amazon SageMaker Unified Studio. A notebook run represents the execution of an Amazon SageMaker notebook within a project. You can configure compute, network, timeout, and environment settings for the run.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StartNotebookRunOutput'
        '403':
          description: AccessDeniedException; AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '409':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '402':
          description: ServiceQuotaExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceQuotaExceededException'
        '429':
          description: ThrottlingException; ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
        '401':
          description: UnauthorizedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/StartNotebookRunInput'
      tags:
      - Notebook Runs
    get:
      operationId: ListNotebookRuns
      summary: List Notebook Runs
      description: Lists notebook runs in Amazon SageMaker Unified Studio.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListNotebookRunsOutput'
        '403':
          description: AccessDeniedException; AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '429':
          description: ThrottlingException; ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
        '401':
          description: UnauthorizedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListNotebookRunsInput'
      tags:
      - Notebook Runs
  /v2/domains/{domainIdentifier}/notebook-runs/{identifier}:
    get:
      operationId: GetNotebookRun
      summary: Get Notebook Run
      description: Gets the details of a notebook run in Amazon SageMaker Unified Studio.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetNotebookRunOutput'
        '403':
          description: AccessDeniedException; AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '429':
          description: ThrottlingException; ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
        '401':
          description: UnauthorizedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetNotebookRunInput'
      tags:
      - Notebook Runs
components:
  schemas:
    NotebookRunSummary:
      type: object
      properties:
        id:
          type: string
          description: The identifier of the notebook run.
        domainId:
          type: string
          description: The identifier of the Amazon SageMaker Unified Studio domain.
        owningProjectId:
          type: string
          description: The identifier of the project that owns the notebook run.
        notebookId:
          type: string
          description: The identifier of the notebook.
        scheduleId:
          type: string
          description: The identifier of the schedule associated with the notebook run.
        status:
          type: string
          enum:
          - QUEUED
          - STARTING
          - RUNNING
          - STOPPING
          - STOPPED
          - SUCCEEDED
          - FAILED
          description: The status of the notebook run.
        triggerSource:
          $ref: '#/components/schemas/TriggerSource'
        createdAt:
          type: string
          format: date-time
          description: The timestamp of when the notebook run was created.
        createdBy:
          type: string
          description: The identifier of the user who created the notebook run.
        updatedAt:
          type: string
          format: date-time
          description: The timestamp of when the notebook run was last updated.
        updatedBy:
          type: string
          description: The identifier of the user who last updated the notebook run.
        startedAt:
          type: string
          description: The timestamp of when the notebook run started executing.
        completedAt:
          type: string
          description: The timestamp of when the notebook run completed.
      required:
      - id
      - domainId
      - owningProjectId
      - notebookId
      - status
    ValidationException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    StartNotebookRunInput:
      type: object
      properties:
        domainIdentifier:
          type: string
          description: The identifier of the Amazon SageMaker Unified Studio domain in which the notebook run is started.
        owningProjectIdentifier:
          type: string
          description: The identifier of the project that owns the notebook run.
        notebookIdentifier:
          type: string
          description: The identifier of the notebook to run.
        scheduleIdentifier:
          type: string
          description: The identifier of the schedule associated with the notebook run.
        computeConfiguration:
          $ref: '#/components/schemas/ComputeConfig'
        networkConfiguration:
          $ref: '#/components/schemas/NetworkConfig'
        timeoutConfiguration:
          $ref: '#/components/schemas/TimeoutConfig'
        notificationConfiguration:
          $ref: '#/components/schemas/NotificationConfig'
        triggerSource:
          $ref: '#/components/schemas/TriggerSource'
        metadata:
          type: object
          additionalProperties:
            type: string
          description: The metadata for the notebook run, specified as key-value pairs. You can specify up to 50 entries, with keys up to 128 characters and values up to 1024 characters.
        parameters:
          type: object
          additionalProperties:
            type: string
          description: The sensitive parameters for the notebook run, specified as key-value pairs. You can specify up to 50 entries, with keys up to 128 characters and values up to 1024 characters.
        clientToken:
          type: string
          description: A unique, case-sensitive identifier to ensure idempotency of the request. This field is automatically populated if not provided.
      required:
      - domainIdentifier
      - owningProjectIdentifier
      - notebookIdentifier
    StorageConfig:
      type: object
      properties:
        projectS3Path:
          type: string
          description: The Amazon Simple Storage Service path for the project storage.
        kmsKeyArn:
          type: string
          description: The ARN of the KMS key used for encryption.
    UnauthorizedException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    GetNotebookRunOutput:
      type: object
      properties:
        id:
          type: string
          description: The identifier of the notebook run.
        domainId:
          type: string
          description: The identifier of the Amazon SageMaker Unified Studio domain.
        owningProjectId:
          type: string
          description: The identifier of the project that owns the notebook run.
        notebookId:
          type: string
          description: The identifier of the notebook.
        scheduleId:
          type: string
          description: The identifier of the schedule associated with the notebook run.
        status:
          type: string
          enum:
          - QUEUED
          - STARTING
          - RUNNING
          - STOPPING
          - STOPPED
          - SUCCEEDED
          - FAILED
          description: The status of the notebook run.
        cellOrder:
          type: array
          items:
            $ref: '#/components/schemas/CellInformation'
          description: The ordered list of cells in the notebook run.
        metadata:
          type: object
          additionalProperties:
            type: string
          description: The metadata of the notebook run.
        parameters:
          type: object
          additionalProperties:
            type: string
          description: The sensitive parameters of the notebook run.
        computeConfiguration:
          $ref: '#/components/schemas/ComputeConfig'
        networkConfiguration:
          $ref: '#/components/schemas/NetworkConfig'
        timeoutConfiguration:
          $ref: '#/components/schemas/TimeoutConfig'
        environmentConfiguration:
          $ref: '#/components/schemas/EnvironmentConfig'
        storageConfiguration:
          $ref: '#/components/schemas/StorageConfig'
        notificationConfiguration:
          $ref: '#/components/schemas/NotificationConfig'
        triggerSource:
          $ref: '#/components/schemas/TriggerSource'
        error:
          $ref: '#/components/schemas/NotebookRunError'
        createdAt:
          type: string
          format: date-time
          description: The timestamp of when the notebook run was created.
        createdBy:
          type: string
          description: The identifier of the user who created the notebook run.
        updatedAt:
          type: string
          format: date-time
          description: The timestamp of when the notebook run was last updated.
        updatedBy:
          type: string
          description: The identifier of the user who last updated the notebook run.
        startedAt:
          type: string
          description: The timestamp of when the notebook run started executing.
        completedAt:
          type: string
          description: The timestamp of when the notebook run completed.
      required:
      - id
      - domainId
      - owningProjectId
      - notebookId
      - status
    EnvironmentConfig:
      type: object
      properties:
        imageVersion:
          type: string
          description: The image version for the notebook run environment.
        packageConfig:
          $ref: '#/components/schemas/PackageConfig'
    ThrottlingException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    CellInformation:
      type: object
      properties: {}
    NotebookRunError:
      type: object
      properties:
        message:
          type: string
          description: The error message. The maximum length is 1024 characters.
      required:
      - message
    StartNotebookRunOutput:
      type: object
      properties:
        id:
          type: string
          description: The identifier of the notebook run.
        domainId:
          type: string
          description: The identifier of the Amazon SageMaker Unified Studio domain.
        owningProjectId:
          type: string
          description: The identifier of the project that owns the notebook run.
        notebookId:
          type: string
          description: The identifier of the notebook.
        scheduleId:
          type: string
          description: The identifier of the schedule associated with the notebook run.
        status:
          type: string
          enum:
          - QUEUED
          - STARTING
          - RUNNING
          - STOPPING
          - STOPPED
          - SUCCEEDED
          - FAILED
          description: The status of the notebook run.
        cellOrder:
          type: array
          items:
            $ref: '#/components/schemas/CellInformation'
          description: The ordered list of cells in the notebook run.
        metadata:
          type: object
          additionalProperties:
            type: string
          description: The metadata of the notebook run.
        parameters:
          type: object
          additionalProperties:
            type: string
          description: The sensitive parameters of the notebook run.
        computeConfiguration:
          $ref: '#/components/schemas/ComputeConfig'
        networkConfiguration:
          $ref: '#/components/schemas/NetworkConfig'
        timeoutConfiguration:
          $ref: '#/components/schemas/TimeoutConfig'
        environmentConfiguration:
          $ref: '#/components/schemas/EnvironmentConfig'
        storageConfiguration:
          $ref: '#/components/schemas/StorageConfig'
        notificationConfiguration:
          $ref: '#/components/schemas/NotificationConfig'
        triggerSource:
          $ref: '#/components/schemas/TriggerSource'
        error:
          $ref: '#/components/schemas/NotebookRunError'
        createdAt:
          type: string
          format: date-time
          description: The timestamp of when the notebook run was created.
        createdBy:
          type: string
          description: The identifier of the user who created the notebook run.
        updatedAt:
          type: string
          format: date-time
          description: The timestamp of when the notebook run was last updated.
        updatedBy:
          type: string
          description: The identifier of the user who last updated the notebook run.
        startedAt:
          type: string
          description: The timestamp of when the notebook run started executing.
        completedAt:
          type: string
          description: The timestamp of when the notebook run completed.
      required:
      - id
      - domainId
      - owningProjectId
      - notebookId
      - status
    ListNotebookRunsOutput:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/NotebookRunSummary'
          description: The results of the ListNotebookRuns action.
        nextToken:
          type: string
          description: When the number of notebook runs is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of notebook runs, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListNotebookRuns to list the next set of notebook runs.
    GetNotebookRunInput:
      type: object
      properties:
        domainIdentifier:
          type: string
          description: The identifier of the Amazon SageMaker Unified Studio domain in which the notebook run exists.
        identifier:
          type: string
          description: The identifier of the notebook run.
      required:
      - domainIdentifier
      - identifier
    ListNotebookRunsInput:
      type: object
      properties:
        domainIdentifier:
          type: string
          description: The identifier of the Amazon SageMaker Unified Studio domain in which to list notebook runs.
        owningProjectIdentifier:
          type: string
          description: The identifier of the project that owns the notebook runs.
        notebookIdentifier:
          type: string
          description: The identifier of the notebook to filter runs by.
        status:
          type: string
          enum:
          - QUEUED
          - STARTING
          - RUNNING
          - STOPPING
          - STOPPED
          - SUCCEEDED
          - FAILED
          description: The status to filter notebook runs by.
        scheduleIdentifier:
          type: string
          description: The identifier of the schedule to filter notebook runs by.
        maxResults:
          type: integer
          description: The maximum number of notebook runs to return in a single call. When the number of notebook runs exceeds the value of MaxResults, the response contains a NextToken value.
        sortOrder:
          type: string
          enum:
          - ASCENDING
          - DESCENDING
          description: The sort order for the results.
        nextToken:
          type: string
          description: When the number of notebook runs is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of notebook runs, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListNotebookRuns to list the next set of notebook runs.
      required:
      - domainIdentifier
      - owningProjectIdentifier
    AccessDeniedException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    NetworkConfig:
      type: object
      properties:
        networkAccessType:
          type: string
          enum:
          - PUBLIC_INTERNET_ONLY
          - VPC_ONLY
          description: The network access type for the notebook run. Valid values are PUBLIC_INTERNET_ONLY and VPC_ONLY.
        vpcId:
          type: string
          description: The identifier of the VPC for the notebook run. This is required when the network access type is VPC_ONLY.
        subnetIds:
          type: array
          items:
            type: string
          description: The identifiers of the subnets for the notebook run. You can specify up to 10 subnets.
        securityGroupIds:
          type: array
          items:
            type: string
          description: The identifiers of the security groups for the notebook run. You can specify up to 5 security groups.
      required:
      - networkAccessType
    NotificationConfig:
      type: object
      properties:
        notifyOn:
          type: array
          items:
            type: string
            enum:
            - SUCCEEDED
            - FAILED
            - STOPPED
            - QUEUED
            - STARTING
            - RUNNING
            - STOPPING
          description: The notebook run states that trigger notifications. You can specify up to 7 states, and the ordering of the states is not significant.
      required:
      - notifyOn
    TriggerSource:
      type: object
      properties:
        type:
          type: string
          enum:
          - MANUAL
          - SCHEDULED
          - WORKFLOW
          description: The type of the trigger source. Valid values are MANUAL, SCHEDULED, and WORKFLOW.
        name:
          type: string
          description: The name of the trigger source.
    TimeoutConfig:
      type: object
      properties:
        runTimeoutInMinutes:
          type: integer
          description: The timeout for the notebook run, in minutes. The minimum value is 60 minutes (1 hour), the maximum value is 1440 minutes (24 hours), and the default value is 720 minutes (12 hours).
    InternalServerException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    ResourceNotFoundException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    PackageConfig:
      type: object
      properties:
        packageManager:
          type: string
          enum:
          - UV
          description: The package manager for the notebook run environment. The default value is UV.
        packageSpecification:
          type: string
          description: The package specification content for the notebook run environment. The maximum length is 10240 characters.
      required:
      - packageManager
    ServiceQuotaExceededException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    ComputeConfig:
      type: object
      properties:
        instanceType:
          type: string
          description: The instance type for the notebook run compute.
        environmentVersion:
          type: string
          description: The environment version for the notebook run compute.
    ConflictException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
  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: datazone
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/datazone/service/2018-05-10/datazone-2018-05-10.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)