Amazon SageMaker Sagemaker Cluster Scheduler Config API

openapi: 3.1.0
info:
  title: Amazon SageMaker Service Cluster Scheduler 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:
  /#CreateClusterSchedulerConfig:
    post:
      operationId: CreateClusterSchedulerConfig
      summary: Create Cluster Scheduler Config
      description: Create cluster policy configuration. This policy is used for task prioritization and fair-share allocation
        of idle compute. This helps prioritize critical workloads and distributes idle compute across entities.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/CreateClusterSchedulerConfigResponse'
        '400':
          description: ConflictException; ResourceLimitExceeded
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ConflictException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - SageMaker.CreateClusterSchedulerConfig
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/CreateClusterSchedulerConfigRequest'
      tags:
      - Cluster Scheduler Config
  /#DeleteClusterSchedulerConfig:
    post:
      operationId: DeleteClusterSchedulerConfig
      summary: Delete Cluster Scheduler Config
      description: Deletes the cluster policy of the cluster.
      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.DeleteClusterSchedulerConfig
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DeleteClusterSchedulerConfigRequest'
      tags:
      - Cluster Scheduler Config
  /#DescribeClusterSchedulerConfig:
    post:
      operationId: DescribeClusterSchedulerConfig
      summary: Describe Cluster Scheduler Config
      description: Description of the cluster policy. This policy is used for task prioritization and fair-share allocation.
        This helps prioritize critical workloads and distributes idle compute across entities.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DescribeClusterSchedulerConfigResponse'
        '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.DescribeClusterSchedulerConfig
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DescribeClusterSchedulerConfigRequest'
      tags:
      - Cluster Scheduler Config
  /#ListClusterSchedulerConfigs:
    post:
      operationId: ListClusterSchedulerConfigs
      summary: List Cluster Scheduler Configs
      description: List the cluster policy configurations.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ListClusterSchedulerConfigsResponse'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - SageMaker.ListClusterSchedulerConfigs
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/ListClusterSchedulerConfigsRequest'
      tags:
      - Cluster Scheduler Config
  /#UpdateClusterSchedulerConfig:
    post:
      operationId: UpdateClusterSchedulerConfig
      summary: Update Cluster Scheduler Config
      description: Update the cluster policy configuration.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/UpdateClusterSchedulerConfigResponse'
        '400':
          description: ConflictException; ResourceLimitExceeded; ResourceNotFound
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ConflictException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - SageMaker.UpdateClusterSchedulerConfig
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/UpdateClusterSchedulerConfigRequest'
      tags:
      - Cluster Scheduler 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:
    ClusterSchedulerConfigSummary:
      type: object
      properties:
        ClusterSchedulerConfigArn:
          type: string
          description: ARN of the cluster policy.
        ClusterSchedulerConfigId:
          type: string
          description: ID of the cluster policy.
        ClusterSchedulerConfigVersion:
          type: integer
          description: Version of the cluster policy.
        Name:
          type: string
          description: Name of the cluster policy.
        CreationTime:
          type: string
          format: date-time
          description: Creation time of the cluster policy.
        LastModifiedTime:
          type: string
          format: date-time
          description: Last modified time of the cluster policy.
        Status:
          type: string
          enum:
          - Creating
          - CreateFailed
          - CreateRollbackFailed
          - Created
          - Updating
          - UpdateFailed
          - UpdateRollbackFailed
          - Updated
          - Deleting
          - DeleteFailed
          - DeleteRollbackFailed
          - Deleted
          description: Status of the cluster policy.
        ClusterArn:
          type: string
          description: ARN of the cluster.
      required:
      - ClusterSchedulerConfigArn
      - ClusterSchedulerConfigId
      - Name
      - CreationTime
      - Status
    ConflictException:
      type: object
      properties:
        Message:
          type: string
    CreateClusterSchedulerConfigRequest:
      type: object
      properties:
        Name:
          type: string
          description: The name for the cluster policy. The name must be unique within the SageMaker AI HyperPod cluster specified
            by ClusterArn. You can use the same name in other clusters within a Region or across Regions.
        ClusterArn:
          type: string
          description: ARN of the cluster.
        SchedulerConfig:
          $ref: '#/components/schemas/SchedulerConfig'
        Description:
          type: string
          description: Description of the cluster policy.
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: Tags of the cluster policy.
      required:
      - Name
      - ClusterArn
      - SchedulerConfig
    CreateClusterSchedulerConfigResponse:
      type: object
      properties:
        ClusterSchedulerConfigArn:
          type: string
          description: ARN of the cluster policy.
        ClusterSchedulerConfigId:
          type: string
          description: ID of the cluster policy.
      required:
      - ClusterSchedulerConfigArn
      - ClusterSchedulerConfigId
    DeleteClusterSchedulerConfigRequest:
      type: object
      properties:
        ClusterSchedulerConfigId:
          type: string
          description: ID of the cluster policy.
      required:
      - ClusterSchedulerConfigId
    DescribeClusterSchedulerConfigRequest:
      type: object
      properties:
        ClusterSchedulerConfigId:
          type: string
          description: ID of the cluster policy.
        ClusterSchedulerConfigVersion:
          type: integer
          description: Version of the cluster policy.
      required:
      - ClusterSchedulerConfigId
    DescribeClusterSchedulerConfigResponse:
      type: object
      properties:
        ClusterSchedulerConfigArn:
          type: string
          description: ARN of the cluster policy.
        ClusterSchedulerConfigId:
          type: string
          description: ID of the cluster policy.
        Name:
          type: string
          description: Name of the cluster policy.
        ClusterSchedulerConfigVersion:
          type: integer
          description: Version of the cluster policy.
        Status:
          type: string
          enum:
          - Creating
          - CreateFailed
          - CreateRollbackFailed
          - Created
          - Updating
          - UpdateFailed
          - UpdateRollbackFailed
          - Updated
          - Deleting
          - DeleteFailed
          - DeleteRollbackFailed
          - Deleted
          description: Status of the cluster policy.
        FailureReason:
          type: string
          description: Failure reason of the cluster policy.
        StatusDetails:
          type: object
          additionalProperties:
            type: string
            enum:
            - Creating
            - CreateFailed
            - CreateRollbackFailed
            - Created
            - Updating
            - UpdateFailed
            - UpdateRollbackFailed
            - Updated
            - Deleting
            - DeleteFailed
            - DeleteRollbackFailed
            - Deleted
          description: Additional details about the status of the cluster policy. This field provides context when the policy
            is in a non-active state, such as during creation, updates, or if failures occur.
        ClusterArn:
          type: string
          description: ARN of the cluster where the cluster policy is applied.
        SchedulerConfig:
          $ref: '#/components/schemas/SchedulerConfig'
        Description:
          type: string
          description: Description of the cluster policy.
        CreationTime:
          type: string
          format: date-time
          description: Creation time of the cluster policy.
        CreatedBy:
          $ref: '#/components/schemas/UserContext'
        LastModifiedTime:
          type: string
          format: date-time
          description: Last modified time of the cluster policy.
        LastModifiedBy:
          $ref: '#/components/schemas/UserContext'
      required:
      - ClusterSchedulerConfigArn
      - ClusterSchedulerConfigId
      - Name
      - ClusterSchedulerConfigVersion
      - Status
      - CreationTime
    IamIdentity:
      type: object
      properties:
        Arn:
          type: string
          description: The Amazon Resource Name (ARN) of the IAM identity.
        PrincipalId:
          type: string
          description: The ID of the principal that assumes the IAM identity.
        SourceIdentity:
          type: string
          description: The person or application which assumes the IAM identity.
    ListClusterSchedulerConfigsRequest:
      type: object
      properties:
        CreatedAfter:
          type: string
          format: date-time
          description: Filter for after this creation time. The input for this parameter is a Unix timestamp. To convert a
            date and time into a Unix timestamp, see EpochConverter.
        CreatedBefore:
          type: string
          format: date-time
          description: Filter for before this creation time. The input for this parameter is a Unix timestamp. To convert
            a date and time into a Unix timestamp, see EpochConverter.
        NameContains:
          type: string
          description: Filter for name containing this string.
        ClusterArn:
          type: string
          description: Filter for ARN of the cluster.
        Status:
          type: string
          enum:
          - Creating
          - CreateFailed
          - CreateRollbackFailed
          - Created
          - Updating
          - UpdateFailed
          - UpdateRollbackFailed
          - Updated
          - Deleting
          - DeleteFailed
          - DeleteRollbackFailed
          - Deleted
          description: Filter for status.
        SortBy:
          type: string
          enum:
          - Name
          - CreationTime
          - Status
          description: Filter for sorting the list by a given value. For example, sort by name, creation time, or status.
        SortOrder:
          type: string
          enum:
          - Ascending
          - Descending
          description: The order of the list. By default, listed in Descending order according to by SortBy. To change the
            list order, you can specify SortOrder to be Ascending.
        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.
        MaxResults:
          type: integer
          description: The maximum number of cluster policies to list.
    ListClusterSchedulerConfigsResponse:
      type: object
      properties:
        ClusterSchedulerConfigSummaries:
          type: array
          items:
            $ref: '#/components/schemas/ClusterSchedulerConfigSummary'
          description: Summaries of the cluster policies.
        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.
    PriorityClass:
      type: object
      properties:
        Name:
          type: string
          description: Name of the priority class.
        Weight:
          type: integer
          description: Weight of the priority class. The value is within a range from 0 to 100, where 0 is the default. A
            weight of 0 is the lowest priority and 100 is the highest. Weight 0 is the default.
      required:
      - Name
      - Weight
    ResourceNotFound:
      type: object
      properties:
        Message:
          type: string
    SchedulerConfig:
      type: object
      properties:
        PriorityClasses:
          type: array
          items:
            $ref: '#/components/schemas/PriorityClass'
          description: List of the priority classes, PriorityClass, of the cluster policy. When specified, these class configurations
            define how tasks are queued.
        FairShare:
          type: string
          enum:
          - Enabled
          - Disabled
          description: When enabled, entities borrow idle compute based on their assigned FairShareWeight. When disabled,
            entities borrow idle compute based on a first-come first-serve basis. Default is Enabled.
        IdleResourceSharing:
          type: string
          enum:
          - Enabled
          - Disabled
          description: Configuration for sharing idle compute resources across entities in the cluster. When enabled, unallocated
            resources are automatically calculated and made available for entities to borrow.
    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
    UpdateClusterSchedulerConfigRequest:
      type: object
      properties:
        ClusterSchedulerConfigId:
          type: string
          description: ID of the cluster policy.
        TargetVersion:
          type: integer
          description: Target version.
        SchedulerConfig:
          $ref: '#/components/schemas/SchedulerConfig'
        Description:
          type: string
          description: Description of the cluster policy.
      required:
      - ClusterSchedulerConfigId
      - TargetVersion
    UpdateClusterSchedulerConfigResponse:
      type: object
      properties:
        ClusterSchedulerConfigArn:
          type: string
          description: ARN of the cluster policy.
        ClusterSchedulerConfigVersion:
          type: integer
          description: Version of the cluster policy.
      required:
      - ClusterSchedulerConfigArn
      - ClusterSchedulerConfigVersion
    UserContext:
      type: object
      properties:
        UserProfileArn:
          type: string
          description: The Amazon Resource Name (ARN) of the user's profile.
        UserProfileName:
          type: string
          description: The name of the user's profile.
        DomainId:
          type: string
          description: The domain associated with the user.
        IamIdentity:
          $ref: '#/components/schemas/IamIdentity'
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)