Amazon SageMaker Sagemaker Studio Lifecycle Config API

openapi: 3.1.0
info:
  title: Amazon SageMaker Service Studio Lifecycle Config API
  version: '2017-07-24'
  description: Generated from AWS's published Smithy model for Amazon SageMaker Service. 4 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:
  /#CreateStudioLifecycleConfig:
    post:
      operationId: CreateStudioLifecycleConfig
      summary: Create Studio Lifecycle Config
      description: Creates a new Amazon SageMaker AI Studio Lifecycle Configuration.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/CreateStudioLifecycleConfigResponse'
        '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.CreateStudioLifecycleConfig
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/CreateStudioLifecycleConfigRequest'
      tags:
      - Studio Lifecycle Config
  /#DeleteStudioLifecycleConfig:
    post:
      operationId: DeleteStudioLifecycleConfig
      summary: Delete Studio Lifecycle Config
      description: Deletes the Amazon SageMaker AI Studio Lifecycle Configuration. In order to delete the Lifecycle Configuration,
        there must be no running apps using the Lifecycle Configuration. You must also remove the Lifecycle Configuration
        from UserSettings in all Domains and UserProfiles.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                type: string
        '400':
          description: ResourceInUse; ResourceNotFound
          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.DeleteStudioLifecycleConfig
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DeleteStudioLifecycleConfigRequest'
      tags:
      - Studio Lifecycle Config
  /#DescribeStudioLifecycleConfig:
    post:
      operationId: DescribeStudioLifecycleConfig
      summary: Describe Studio Lifecycle Config
      description: Describes the Amazon SageMaker AI Studio Lifecycle Configuration.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DescribeStudioLifecycleConfigResponse'
        '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.DescribeStudioLifecycleConfig
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DescribeStudioLifecycleConfigRequest'
      tags:
      - Studio Lifecycle Config
  /#ListStudioLifecycleConfigs:
    post:
      operationId: ListStudioLifecycleConfigs
      summary: List Studio Lifecycle Configs
      description: Lists the Amazon SageMaker AI Studio Lifecycle Configurations in your Amazon Web Services Account.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ListStudioLifecycleConfigsResponse'
        '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.ListStudioLifecycleConfigs
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/ListStudioLifecycleConfigsRequest'
      tags:
      - Studio 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:
    CreateStudioLifecycleConfigRequest:
      type: object
      properties:
        StudioLifecycleConfigName:
          type: string
          description: The name of the Amazon SageMaker AI Studio Lifecycle Configuration to create.
        StudioLifecycleConfigContent:
          type: string
          description: The content of your Amazon SageMaker AI Studio Lifecycle Configuration script. This content must be
            base64 encoded.
        StudioLifecycleConfigAppType:
          type: string
          enum:
          - JupyterServer
          - KernelGateway
          - CodeEditor
          - JupyterLab
          description: The App type that the Lifecycle Configuration is attached to.
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: Tags to be associated with the Lifecycle Configuration. Each tag consists of a key and an optional
            value. Tag keys must be unique per resource. Tags are searchable using the Search API.
      required:
      - StudioLifecycleConfigName
      - StudioLifecycleConfigContent
      - StudioLifecycleConfigAppType
    CreateStudioLifecycleConfigResponse:
      type: object
      properties:
        StudioLifecycleConfigArn:
          type: string
          description: The ARN of your created Lifecycle Configuration.
    DeleteStudioLifecycleConfigRequest:
      type: object
      properties:
        StudioLifecycleConfigName:
          type: string
          description: The name of the Amazon SageMaker AI Studio Lifecycle Configuration to delete.
      required:
      - StudioLifecycleConfigName
    DescribeStudioLifecycleConfigRequest:
      type: object
      properties:
        StudioLifecycleConfigName:
          type: string
          description: The name of the Amazon SageMaker AI Studio Lifecycle Configuration to describe.
      required:
      - StudioLifecycleConfigName
    DescribeStudioLifecycleConfigResponse:
      type: object
      properties:
        StudioLifecycleConfigArn:
          type: string
          description: The ARN of the Lifecycle Configuration to describe.
        StudioLifecycleConfigName:
          type: string
          description: The name of the Amazon SageMaker AI Studio Lifecycle Configuration that is described.
        CreationTime:
          type: string
          format: date-time
          description: The creation time of the Amazon SageMaker AI Studio Lifecycle Configuration.
        LastModifiedTime:
          type: string
          format: date-time
          description: This value is equivalent to CreationTime because Amazon SageMaker AI Studio Lifecycle Configurations
            are immutable.
        StudioLifecycleConfigContent:
          type: string
          description: The content of your Amazon SageMaker AI Studio Lifecycle Configuration script.
        StudioLifecycleConfigAppType:
          type: string
          enum:
          - JupyterServer
          - KernelGateway
          - CodeEditor
          - JupyterLab
          description: The App type that the Lifecycle Configuration is attached to.
    ListStudioLifecycleConfigsRequest:
      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 ListStudioLifecycleConfigs didn't return the full set of Lifecycle Configurations,
            the call returns a token for getting the next set of Lifecycle Configurations.
        NameContains:
          type: string
          description: A string in the Lifecycle Configuration name. This filter returns only Lifecycle Configurations whose
            name contains the specified string.
        AppTypeEquals:
          type: string
          enum:
          - JupyterServer
          - KernelGateway
          - CodeEditor
          - JupyterLab
          description: A parameter to search for the App Type to which the Lifecycle Configuration is attached.
        CreationTimeBefore:
          type: string
          format: date-time
          description: A filter that returns only Lifecycle Configurations created on or before the specified time.
        CreationTimeAfter:
          type: string
          format: date-time
          description: A filter that returns only Lifecycle Configurations created on or after the specified time.
        ModifiedTimeBefore:
          type: string
          format: date-time
          description: A filter that returns only Lifecycle Configurations modified before the specified time.
        ModifiedTimeAfter:
          type: string
          format: date-time
          description: A filter that returns only Lifecycle Configurations modified 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.
    ListStudioLifecycleConfigsResponse:
      type: object
      properties:
        NextToken:
          type: string
          description: If the previous response was truncated, you will receive this token. Use it in your next request to
            receive the next set of results.
        StudioLifecycleConfigs:
          type: array
          items:
            $ref: '#/components/schemas/StudioLifecycleConfigDetails'
          description: A list of Lifecycle Configurations and their properties.
    ResourceInUse:
      type: object
      properties:
        Message:
          type: string
    ResourceNotFound:
      type: object
      properties:
        Message:
          type: string
    StudioLifecycleConfigDetails:
      type: object
      properties:
        StudioLifecycleConfigArn:
          type: string
          description: The Amazon Resource Name (ARN) of the Lifecycle Configuration.
        StudioLifecycleConfigName:
          type: string
          description: The name of the Amazon SageMaker AI Studio Lifecycle Configuration.
        CreationTime:
          type: string
          format: date-time
          description: The creation time of the Amazon SageMaker AI Studio Lifecycle Configuration.
        LastModifiedTime:
          type: string
          format: date-time
          description: This value is equivalent to CreationTime because Amazon SageMaker AI Studio Lifecycle Configurations
            are immutable.
        StudioLifecycleConfigAppType:
          type: string
          enum:
          - JupyterServer
          - KernelGateway
          - CodeEditor
          - JupyterLab
          description: The App type to which the Lifecycle Configuration is attached.
    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
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)