Amazon SageMaker Sagemaker App Image Config API

openapi: 3.1.0
info:
  title: Amazon SageMaker Service App Image 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:
  /#CreateAppImageConfig:
    post:
      operationId: CreateAppImageConfig
      summary: Create App Image Config
      description: Creates a configuration for running a SageMaker AI image as a KernelGateway app. The configuration specifies
        the Amazon Elastic File System storage volume on the image, and a list of the kernels in the image.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/CreateAppImageConfigResponse'
        '400':
          description: ResourceInUse
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ResourceInUse'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - SageMaker.CreateAppImageConfig
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/CreateAppImageConfigRequest'
      tags:
      - App Image Config
  /#DeleteAppImageConfig:
    post:
      operationId: DeleteAppImageConfig
      summary: Delete App Image Config
      description: Deletes an AppImageConfig.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                type: string
        '400':
          description: ResourceNotFound
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ResourceNotFound'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - SageMaker.DeleteAppImageConfig
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DeleteAppImageConfigRequest'
      tags:
      - App Image Config
  /#DescribeAppImageConfig:
    post:
      operationId: DescribeAppImageConfig
      summary: Describe App Image Config
      description: Describes an AppImageConfig.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DescribeAppImageConfigResponse'
        '400':
          description: ResourceNotFound
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ResourceNotFound'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - SageMaker.DescribeAppImageConfig
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DescribeAppImageConfigRequest'
      tags:
      - App Image Config
  /#ListAppImageConfigs:
    post:
      operationId: ListAppImageConfigs
      summary: List App Image Configs
      description: Lists the AppImageConfigs in your account and their properties. The list can be filtered by creation time
        or modified time, and whether the AppImageConfig name contains a specified string.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ListAppImageConfigsResponse'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - SageMaker.ListAppImageConfigs
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/ListAppImageConfigsRequest'
      tags:
      - App Image Config
  /#UpdateAppImageConfig:
    post:
      operationId: UpdateAppImageConfig
      summary: Update App Image Config
      description: Updates the properties of an AppImageConfig.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/UpdateAppImageConfigResponse'
        '400':
          description: ResourceNotFound
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ResourceNotFound'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - SageMaker.UpdateAppImageConfig
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/UpdateAppImageConfigRequest'
      tags:
      - App Image 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:
    AppImageConfigDetails:
      type: object
      properties:
        AppImageConfigArn:
          type: string
          description: The ARN of the AppImageConfig.
        AppImageConfigName:
          type: string
          description: The name of the AppImageConfig. Must be unique to your account.
        CreationTime:
          type: string
          format: date-time
          description: When the AppImageConfig was created.
        LastModifiedTime:
          type: string
          format: date-time
          description: When the AppImageConfig was last modified.
        KernelGatewayImageConfig:
          $ref: '#/components/schemas/KernelGatewayImageConfig'
        JupyterLabAppImageConfig:
          $ref: '#/components/schemas/JupyterLabAppImageConfig'
        CodeEditorAppImageConfig:
          $ref: '#/components/schemas/CodeEditorAppImageConfig'
    CodeEditorAppImageConfig:
      type: object
      properties:
        FileSystemConfig:
          $ref: '#/components/schemas/FileSystemConfig'
        ContainerConfig:
          $ref: '#/components/schemas/ContainerConfig'
    ContainerConfig:
      type: object
      properties:
        ContainerArguments:
          type: array
          items:
            type: string
          description: The arguments for the container when you're running the application.
        ContainerEntrypoint:
          type: array
          items:
            type: string
          description: The entrypoint used to run the application in the container.
        ContainerEnvironmentVariables:
          type: object
          additionalProperties:
            type: string
          description: The environment variables to set in the container
    CreateAppImageConfigRequest:
      type: object
      properties:
        AppImageConfigName:
          type: string
          description: The name of the AppImageConfig. Must be unique to your account.
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: A list of tags to apply to the AppImageConfig.
        KernelGatewayImageConfig:
          $ref: '#/components/schemas/KernelGatewayImageConfig'
        JupyterLabAppImageConfig:
          $ref: '#/components/schemas/JupyterLabAppImageConfig'
        CodeEditorAppImageConfig:
          $ref: '#/components/schemas/CodeEditorAppImageConfig'
      required:
      - AppImageConfigName
    CreateAppImageConfigResponse:
      type: object
      properties:
        AppImageConfigArn:
          type: string
          description: The ARN of the AppImageConfig.
    DeleteAppImageConfigRequest:
      type: object
      properties:
        AppImageConfigName:
          type: string
          description: The name of the AppImageConfig to delete.
      required:
      - AppImageConfigName
    DescribeAppImageConfigRequest:
      type: object
      properties:
        AppImageConfigName:
          type: string
          description: The name of the AppImageConfig to describe.
      required:
      - AppImageConfigName
    DescribeAppImageConfigResponse:
      type: object
      properties:
        AppImageConfigArn:
          type: string
          description: The ARN of the AppImageConfig.
        AppImageConfigName:
          type: string
          description: The name of the AppImageConfig.
        CreationTime:
          type: string
          format: date-time
          description: When the AppImageConfig was created.
        LastModifiedTime:
          type: string
          format: date-time
          description: When the AppImageConfig was last modified.
        KernelGatewayImageConfig:
          $ref: '#/components/schemas/KernelGatewayImageConfig'
        JupyterLabAppImageConfig:
          $ref: '#/components/schemas/JupyterLabAppImageConfig'
        CodeEditorAppImageConfig:
          $ref: '#/components/schemas/CodeEditorAppImageConfig'
    FileSystemConfig:
      type: object
      properties:
        MountPath:
          type: string
          description: The path within the image to mount the user's EFS home directory. The directory should be empty. If
            not specified, defaults to /home/sagemaker-user.
        DefaultUid:
          type: integer
          description: The default POSIX user ID (UID). If not specified, defaults to 1000.
        DefaultGid:
          type: integer
          description: The default POSIX group ID (GID). If not specified, defaults to 100.
    JupyterLabAppImageConfig:
      type: object
      properties:
        FileSystemConfig:
          $ref: '#/components/schemas/FileSystemConfig'
        ContainerConfig:
          $ref: '#/components/schemas/ContainerConfig'
    KernelGatewayImageConfig:
      type: object
      properties:
        KernelSpecs:
          type: array
          items:
            $ref: '#/components/schemas/KernelSpec'
          description: The specification of the Jupyter kernels in the image.
        FileSystemConfig:
          $ref: '#/components/schemas/FileSystemConfig'
      required:
      - KernelSpecs
    KernelSpec:
      type: object
      properties:
        Name:
          type: string
          description: The name of the Jupyter kernel in the image. This value is case sensitive.
        DisplayName:
          type: string
          description: The display name of the kernel.
      required:
      - Name
    ListAppImageConfigsRequest:
      type: object
      properties:
        MaxResults:
          type: integer
          description: The total number of items to return in the response. If the total number of items available is more
            than the value specified, a NextToken is provided in the response. To resume pagination, provide the NextToken
            value in the as part of a subsequent call. The default value is 10.
        NextToken:
          type: string
          description: If the previous call to ListImages didn't return the full set of AppImageConfigs, the call returns
            a token for getting the next set of AppImageConfigs.
        NameContains:
          type: string
          description: A filter that returns only AppImageConfigs whose name contains the specified string.
        CreationTimeBefore:
          type: string
          format: date-time
          description: A filter that returns only AppImageConfigs created on or before the specified time.
        CreationTimeAfter:
          type: string
          format: date-time
          description: A filter that returns only AppImageConfigs created on or after the specified time.
        ModifiedTimeBefore:
          type: string
          format: date-time
          description: A filter that returns only AppImageConfigs modified on or before the specified time.
        ModifiedTimeAfter:
          type: string
          format: date-time
          description: A filter that returns only AppImageConfigs modified on or after the specified time.
        SortBy:
          type: string
          enum:
          - CreationTime
          - LastModifiedTime
          - Name
          description: The property used to sort results. The default value is CreationTime.
        SortOrder:
          type: string
          enum:
          - Ascending
          - Descending
          description: The sort order. The default value is Descending.
    ListAppImageConfigsResponse:
      type: object
      properties:
        NextToken:
          type: string
          description: A token for getting the next set of AppImageConfigs, if there are any.
        AppImageConfigs:
          type: array
          items:
            $ref: '#/components/schemas/AppImageConfigDetails'
          description: A list of AppImageConfigs and their properties.
    ResourceInUse:
      type: object
      properties:
        Message:
          type: string
    ResourceNotFound:
      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
    UpdateAppImageConfigRequest:
      type: object
      properties:
        AppImageConfigName:
          type: string
          description: The name of the AppImageConfig to update.
        KernelGatewayImageConfig:
          $ref: '#/components/schemas/KernelGatewayImageConfig'
        JupyterLabAppImageConfig:
          $ref: '#/components/schemas/JupyterLabAppImageConfig'
        CodeEditorAppImageConfig:
          $ref: '#/components/schemas/CodeEditorAppImageConfig'
      required:
      - AppImageConfigName
    UpdateAppImageConfigResponse:
      type: object
      properties:
        AppImageConfigArn:
          type: string
          description: The ARN for the AppImageConfig.
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)