Amazon SageMaker Sagemaker Notebook Instance Lifecycle Config API

openapi: 3.1.0
info:
  title: Amazon SageMaker Service Notebook Instance Lifecycle Config API
  version: '2017-07-24'
  description: Generated from AWS's published Smithy model for Amazon SageMaker Service. 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://api.sagemaker.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
paths:
  /#CreateNotebookInstanceLifecycleConfig:
    post:
      operationId: CreateNotebookInstanceLifecycleConfig
      summary: Create Notebook Instance Lifecycle Config
      description: 'Creates a lifecycle configuration that you can associate with a notebook instance. A lifecycle configuration
        is a collection of shell scripts that run when you create or start a notebook instance. Each lifecycle configuration
        script has a limit of 16384 characters. The value of the $PATH environment variable that is available to both scripts
        is /sbin:bin:/usr/sbin:/usr/bin. View Amazon CloudWatch Logs for notebook instance lifecycle configurations in log
        group /aws/sagemaker/NotebookInstances in log stream [notebook-instance-name]/[LifecycleConfigHook]. Lifecycle configuration
        scripts cannot run for longer than 5 minutes. If a script runs for longer than 5 minutes, it fails and the notebook
        instance is not created or started. For information about notebook instance lifestyle configurations, see Step 2.1:
        (Optional) Customize a Notebook Instance. Lifecycle configuration scripts execute with root access and the notebook
        instance''s IAM execution role privileges. Grant this permission only to trusted principals. See Customize a Notebook
        Instance Using a Lifecycle Configuration Script for security best practices.'
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/CreateNotebookInstanceLifecycleConfigOutput'
        '400':
          description: ResourceLimitExceeded
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ResourceLimitExceeded'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - SageMaker.CreateNotebookInstanceLifecycleConfig
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/CreateNotebookInstanceLifecycleConfigInput'
      tags:
      - Notebook Instance Lifecycle Config
  /#DeleteNotebookInstanceLifecycleConfig:
    post:
      operationId: DeleteNotebookInstanceLifecycleConfig
      summary: Delete Notebook Instance Lifecycle Config
      description: Deletes a notebook instance lifecycle configuration.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                type: string
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - SageMaker.DeleteNotebookInstanceLifecycleConfig
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DeleteNotebookInstanceLifecycleConfigInput'
      tags:
      - Notebook Instance Lifecycle Config
  /#DescribeNotebookInstanceLifecycleConfig:
    post:
      operationId: DescribeNotebookInstanceLifecycleConfig
      summary: Describe Notebook Instance Lifecycle Config
      description: 'Returns a description of a notebook instance lifecycle configuration. For information about notebook instance
        lifestyle configurations, see Step 2.1: (Optional) Customize a Notebook Instance.'
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DescribeNotebookInstanceLifecycleConfigOutput'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - SageMaker.DescribeNotebookInstanceLifecycleConfig
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DescribeNotebookInstanceLifecycleConfigInput'
      tags:
      - Notebook Instance Lifecycle Config
  /#ListNotebookInstanceLifecycleConfigs:
    post:
      operationId: ListNotebookInstanceLifecycleConfigs
      summary: List Notebook Instance Lifecycle Configs
      description: Lists notebook instance lifestyle configurations created with the CreateNotebookInstanceLifecycleConfig
        API.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ListNotebookInstanceLifecycleConfigsOutput'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - SageMaker.ListNotebookInstanceLifecycleConfigs
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/ListNotebookInstanceLifecycleConfigsInput'
      tags:
      - Notebook Instance Lifecycle Config
  /#UpdateNotebookInstanceLifecycleConfig:
    post:
      operationId: UpdateNotebookInstanceLifecycleConfig
      summary: Update Notebook Instance Lifecycle Config
      description: Updates a notebook instance lifecycle configuration created with the CreateNotebookInstanceLifecycleConfig
        API. Updates to lifecycle configurations affect all notebook instances using that configuration upon their next start.
        Lifecycle configuration scripts execute with root access and the notebook instance's IAM execution role privileges.
        Grant this permission only to trusted principals. See Customize a Notebook Instance Using a Lifecycle Configuration
        Script for security best practices.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/UpdateNotebookInstanceLifecycleConfigOutput'
        '400':
          description: ResourceLimitExceeded
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ResourceLimitExceeded'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - SageMaker.UpdateNotebookInstanceLifecycleConfig
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/UpdateNotebookInstanceLifecycleConfigInput'
      tags:
      - Notebook Instance Lifecycle Config
components:
  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: sagemaker
  schemas:
    CreateNotebookInstanceLifecycleConfigInput:
      type: object
      properties:
        NotebookInstanceLifecycleConfigName:
          type: string
          description: The name of the lifecycle configuration.
        OnCreate:
          type: array
          items:
            $ref: '#/components/schemas/NotebookInstanceLifecycleHook'
          description: A shell script that runs only once, when you create a notebook instance. The shell script must be a
            base64-encoded string.
        OnStart:
          type: array
          items:
            $ref: '#/components/schemas/NotebookInstanceLifecycleHook'
          description: A shell script that runs every time you start a notebook instance, including when you create the notebook
            instance. The shell script must be a base64-encoded string.
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different
            ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web Services Resources.
      required:
      - NotebookInstanceLifecycleConfigName
    CreateNotebookInstanceLifecycleConfigOutput:
      type: object
      properties:
        NotebookInstanceLifecycleConfigArn:
          type: string
          description: The Amazon Resource Name (ARN) of the lifecycle configuration.
    DeleteNotebookInstanceLifecycleConfigInput:
      type: object
      properties:
        NotebookInstanceLifecycleConfigName:
          type: string
          description: The name of the lifecycle configuration to delete.
      required:
      - NotebookInstanceLifecycleConfigName
    DescribeNotebookInstanceLifecycleConfigInput:
      type: object
      properties:
        NotebookInstanceLifecycleConfigName:
          type: string
          description: The name of the lifecycle configuration to describe.
      required:
      - NotebookInstanceLifecycleConfigName
    DescribeNotebookInstanceLifecycleConfigOutput:
      type: object
      properties:
        NotebookInstanceLifecycleConfigArn:
          type: string
          description: The Amazon Resource Name (ARN) of the lifecycle configuration.
        NotebookInstanceLifecycleConfigName:
          type: string
          description: The name of the lifecycle configuration.
        OnCreate:
          type: array
          items:
            $ref: '#/components/schemas/NotebookInstanceLifecycleHook'
          description: The shell script that runs only once, when you create a notebook instance.
        OnStart:
          type: array
          items:
            $ref: '#/components/schemas/NotebookInstanceLifecycleHook'
          description: The shell script that runs every time you start a notebook instance, including when you create the
            notebook instance.
        LastModifiedTime:
          type: string
          format: date-time
          description: A timestamp that tells when the lifecycle configuration was last modified.
        CreationTime:
          type: string
          format: date-time
          description: A timestamp that tells when the lifecycle configuration was created.
    ListNotebookInstanceLifecycleConfigsInput:
      type: object
      properties:
        NextToken:
          type: string
          description: If the result of a ListNotebookInstanceLifecycleConfigs request was truncated, the response includes
            a NextToken. To get the next set of lifecycle configurations, use the token in the next request.
        MaxResults:
          type: integer
          description: The maximum number of lifecycle configurations to return in the response.
        SortBy:
          type: string
          enum:
          - Name
          - CreationTime
          - LastModifiedTime
          description: Sorts the list of results. The default is CreationTime.
        SortOrder:
          type: string
          enum:
          - Ascending
          - Descending
          description: The sort order for results.
        NameContains:
          type: string
          description: A string in the lifecycle configuration name. This filter returns only lifecycle configurations whose
            name contains the specified string.
        CreationTimeBefore:
          type: string
          format: date-time
          description: A filter that returns only lifecycle configurations that were created before the specified time (timestamp).
        CreationTimeAfter:
          type: string
          format: date-time
          description: A filter that returns only lifecycle configurations that were created after the specified time (timestamp).
        LastModifiedTimeBefore:
          type: string
          format: date-time
          description: A filter that returns only lifecycle configurations that were modified before the specified time (timestamp).
        LastModifiedTimeAfter:
          type: string
          format: date-time
          description: A filter that returns only lifecycle configurations that were modified after the specified time (timestamp).
    ListNotebookInstanceLifecycleConfigsOutput:
      type: object
      properties:
        NextToken:
          type: string
          description: If the response is truncated, SageMaker AI returns this token. To get the next set of lifecycle configurations,
            use it in the next request.
        NotebookInstanceLifecycleConfigs:
          type: array
          items:
            $ref: '#/components/schemas/NotebookInstanceLifecycleConfigSummary'
          description: An array of NotebookInstanceLifecycleConfiguration objects, each listing a lifecycle configuration.
    NotebookInstanceLifecycleConfigSummary:
      type: object
      properties:
        NotebookInstanceLifecycleConfigName:
          type: string
          description: The name of the lifecycle configuration.
        NotebookInstanceLifecycleConfigArn:
          type: string
          description: The Amazon Resource Name (ARN) of the lifecycle configuration.
        CreationTime:
          type: string
          format: date-time
          description: A timestamp that tells when the lifecycle configuration was created.
        LastModifiedTime:
          type: string
          format: date-time
          description: A timestamp that tells when the lifecycle configuration was last modified.
      required:
      - NotebookInstanceLifecycleConfigName
      - NotebookInstanceLifecycleConfigArn
    NotebookInstanceLifecycleHook:
      type: object
      properties:
        Content:
          type: string
          description: A base64-encoded string that contains a shell script for a notebook instance lifecycle configuration.
    ResourceLimitExceeded:
      type: object
      properties:
        Message:
          type: string
    Tag:
      type: object
      properties:
        Key:
          type: string
          description: The tag key. Tag keys must be unique per resource.
        Value:
          type: string
          description: The tag value.
      required:
      - Key
      - Value
    UpdateNotebookInstanceLifecycleConfigInput:
      type: object
      properties:
        NotebookInstanceLifecycleConfigName:
          type: string
          description: The name of the lifecycle configuration.
        OnCreate:
          type: array
          items:
            $ref: '#/components/schemas/NotebookInstanceLifecycleHook'
          description: The shell script that runs only once, when you create a notebook instance. The shell script must be
            a base64-encoded string.
        OnStart:
          type: array
          items:
            $ref: '#/components/schemas/NotebookInstanceLifecycleHook'
          description: The shell script that runs every time you start a notebook instance, including when you create the
            notebook instance. The shell script must be a base64-encoded string.
      required:
      - NotebookInstanceLifecycleConfigName
    UpdateNotebookInstanceLifecycleConfigOutput:
      type: object
      properties: {}
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/sagemaker/service/2017-07-24/sagemaker-2017-07-24.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)