Amazon SageMaker Sagemaker Mlflow Tracking Server API

openapi: 3.1.0
info:
  title: Amazon SageMaker Service Mlflow Tracking Server API
  version: '2017-07-24'
  description: Generated from AWS's published Smithy model for Amazon SageMaker Service. 7 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:
  /#CreateMlflowTrackingServer:
    post:
      operationId: CreateMlflowTrackingServer
      summary: Create Mlflow Tracking Server
      description: Creates an MLflow Tracking Server using a general purpose Amazon S3 bucket as the artifact store. For more
        information, see Create an MLflow Tracking Server.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/CreateMlflowTrackingServerResponse'
        '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.CreateMlflowTrackingServer
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/CreateMlflowTrackingServerRequest'
      tags:
      - Mlflow Tracking Server
  /#DeleteMlflowTrackingServer:
    post:
      operationId: DeleteMlflowTrackingServer
      summary: Delete Mlflow Tracking Server
      description: Deletes an MLflow Tracking Server. For more information, see Clean up MLflow resources.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DeleteMlflowTrackingServerResponse'
        '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.DeleteMlflowTrackingServer
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DeleteMlflowTrackingServerRequest'
      tags:
      - Mlflow Tracking Server
  /#DescribeMlflowTrackingServer:
    post:
      operationId: DescribeMlflowTrackingServer
      summary: Describe Mlflow Tracking Server
      description: Returns information about an MLflow Tracking Server.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DescribeMlflowTrackingServerResponse'
        '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.DescribeMlflowTrackingServer
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DescribeMlflowTrackingServerRequest'
      tags:
      - Mlflow Tracking Server
  /#ListMlflowTrackingServers:
    post:
      operationId: ListMlflowTrackingServers
      summary: List Mlflow Tracking Servers
      description: Lists all MLflow Tracking Servers.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ListMlflowTrackingServersResponse'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - SageMaker.ListMlflowTrackingServers
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/ListMlflowTrackingServersRequest'
      tags:
      - Mlflow Tracking Server
  /#StartMlflowTrackingServer:
    post:
      operationId: StartMlflowTrackingServer
      summary: Start Mlflow Tracking Server
      description: Programmatically start an MLflow Tracking Server.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/StartMlflowTrackingServerResponse'
        '400':
          description: ConflictException; 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.StartMlflowTrackingServer
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/StartMlflowTrackingServerRequest'
      tags:
      - Mlflow Tracking Server
  /#StopMlflowTrackingServer:
    post:
      operationId: StopMlflowTrackingServer
      summary: Stop Mlflow Tracking Server
      description: Programmatically stop an MLflow Tracking Server.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/StopMlflowTrackingServerResponse'
        '400':
          description: ConflictException; 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.StopMlflowTrackingServer
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/StopMlflowTrackingServerRequest'
      tags:
      - Mlflow Tracking Server
  /#UpdateMlflowTrackingServer:
    post:
      operationId: UpdateMlflowTrackingServer
      summary: Update Mlflow Tracking Server
      description: Updates properties of an existing MLflow Tracking Server.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/UpdateMlflowTrackingServerResponse'
        '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.UpdateMlflowTrackingServer
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/UpdateMlflowTrackingServerRequest'
      tags:
      - Mlflow Tracking Server
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:
    ConflictException:
      type: object
      properties:
        Message:
          type: string
    CreateMlflowTrackingServerRequest:
      type: object
      properties:
        TrackingServerName:
          type: string
          description: A unique string identifying the tracking server name. This string is part of the tracking server ARN.
        ArtifactStoreUri:
          type: string
          description: The S3 URI for a general purpose bucket to use as the MLflow Tracking Server artifact store.
        TrackingServerSize:
          type: string
          enum:
          - Small
          - Medium
          - Large
          description: The size of the tracking server you want to create. You can choose between "Small", "Medium", and "Large".
            The default MLflow Tracking Server configuration size is "Small". You can choose a size depending on the projected
            use of the tracking server such as the volume of data logged, number of users, and frequency of use. We recommend
            using a small tracking server for teams of up to 25 users, a medium tracking server for teams of up to 50 users,
            and a large tracking server for teams of up to 100 users.
        MlflowVersion:
          type: string
          description: The version of MLflow that the tracking server uses. To see which MLflow versions are available to
            use, see How it works.
        RoleArn:
          type: string
          description: The Amazon Resource Name (ARN) for an IAM role in your account that the MLflow Tracking Server uses
            to access the artifact store in Amazon S3. The role should have AmazonS3FullAccess permissions. For more information
            on IAM permissions for tracking server creation, see Set up IAM permissions for MLflow.
        AutomaticModelRegistration:
          type: boolean
          description: Whether to enable or disable automatic registration of new MLflow models to the SageMaker Model Registry.
            To enable automatic model registration, set this value to True. To disable automatic model registration, set this
            value to False. If not specified, AutomaticModelRegistration defaults to False.
        WeeklyMaintenanceWindowStart:
          type: string
          description: 'The day and time of the week in Coordinated Universal Time (UTC) 24-hour standard time that weekly
            maintenance updates are scheduled. For example: TUE:03:30.'
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: Tags consisting of key-value pairs used to manage metadata for the tracking server.
        S3BucketOwnerAccountId:
          type: string
          description: Expected Amazon Web Services account ID that owns the Amazon S3 bucket for artifact storage. Defaults
            to caller's account ID if not provided.
        S3BucketOwnerVerification:
          type: boolean
          description: Enable Amazon S3 Ownership checks when interacting with Amazon S3 buckets from a SageMaker Managed
            MLflow Tracking Server. Defaults to True if not provided.
      required:
      - TrackingServerName
      - ArtifactStoreUri
      - RoleArn
    CreateMlflowTrackingServerResponse:
      type: object
      properties:
        TrackingServerArn:
          type: string
          description: The ARN of the tracking server.
    DeleteMlflowTrackingServerRequest:
      type: object
      properties:
        TrackingServerName:
          type: string
          description: The name of the the tracking server to delete.
      required:
      - TrackingServerName
    DeleteMlflowTrackingServerResponse:
      type: object
      properties:
        TrackingServerArn:
          type: string
          description: A TrackingServerArn object, the ARN of the tracking server that is deleted if successfully found.
    DescribeMlflowTrackingServerRequest:
      type: object
      properties:
        TrackingServerName:
          type: string
          description: The name of the MLflow Tracking Server to describe.
      required:
      - TrackingServerName
    DescribeMlflowTrackingServerResponse:
      type: object
      properties:
        TrackingServerArn:
          type: string
          description: The ARN of the described tracking server.
        TrackingServerName:
          type: string
          description: The name of the described tracking server.
        ArtifactStoreUri:
          type: string
          description: The S3 URI of the general purpose bucket used as the MLflow Tracking Server artifact store.
        TrackingServerSize:
          type: string
          enum:
          - Small
          - Medium
          - Large
          description: The size of the described tracking server.
        MlflowVersion:
          type: string
          description: The MLflow version used for the described tracking server.
        RoleArn:
          type: string
          description: The Amazon Resource Name (ARN) for an IAM role in your account that the described MLflow Tracking Server
            uses to access the artifact store in Amazon S3.
        TrackingServerStatus:
          type: string
          enum:
          - Creating
          - Created
          - CreateFailed
          - Updating
          - Updated
          - UpdateFailed
          - Deleting
          - DeleteFailed
          - Stopping
          - Stopped
          - StopFailed
          - Starting
          - Started
          - StartFailed
          - MaintenanceInProgress
          - MaintenanceComplete
          - MaintenanceFailed
          description: The current creation status of the described MLflow Tracking Server.
        TrackingServerMaintenanceStatus:
          type: string
          enum:
          - MaintenanceInProgress
          - MaintenanceComplete
          - MaintenanceFailed
          description: The current maintenance status of the described MLflow Tracking Server.
        IsActive:
          type: string
          enum:
          - Active
          - Inactive
          description: Whether the described MLflow Tracking Server is currently active.
        TrackingServerUrl:
          type: string
          description: The URL to connect to the MLflow user interface for the described tracking server.
        WeeklyMaintenanceWindowStart:
          type: string
          description: The day and time of the week when weekly maintenance occurs on the described tracking server.
        AutomaticModelRegistration:
          type: boolean
          description: Whether automatic registration of new MLflow models to the SageMaker Model Registry is enabled.
        CreationTime:
          type: string
          format: date-time
          description: The timestamp of when the described MLflow Tracking Server was created.
        CreatedBy:
          $ref: '#/components/schemas/UserContext'
        LastModifiedTime:
          type: string
          format: date-time
          description: The timestamp of when the described MLflow Tracking Server was last modified.
        LastModifiedBy:
          $ref: '#/components/schemas/UserContext'
        S3BucketOwnerAccountId:
          type: string
          description: Expected Amazon Web Services account ID that owns the Amazon S3 bucket for artifact storage.
        S3BucketOwnerVerification:
          type: boolean
          description: Whether Amazon S3 Bucket Ownership checks are enabled whenever the tracking server interacts with Amazon
            Amazon S3.
    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.
    ListMlflowTrackingServersRequest:
      type: object
      properties:
        CreatedAfter:
          type: string
          format: date-time
          description: Use the CreatedAfter filter to only list tracking servers created after a specific date and time. Listed
            tracking servers are shown with a date and time such as "2024-03-16T01:46:56+00:00". The CreatedAfter parameter
            takes in a Unix timestamp. To convert a date and time into a Unix timestamp, see EpochConverter.
        CreatedBefore:
          type: string
          format: date-time
          description: Use the CreatedBefore filter to only list tracking servers created before a specific date and time.
            Listed tracking servers are shown with a date and time such as "2024-03-16T01:46:56+00:00". The CreatedBefore
            parameter takes in a Unix timestamp. To convert a date and time into a Unix timestamp, see EpochConverter.
        TrackingServerStatus:
          type: string
          enum:
          - Creating
          - Created
          - CreateFailed
          - Updating
          - Updated
          - UpdateFailed
          - Deleting
          - DeleteFailed
          - Stopping
          - Stopped
          - StopFailed
          - Starting
          - Started
          - StartFailed
          - MaintenanceInProgress
          - MaintenanceComplete
          - MaintenanceFailed
          description: Filter for tracking servers with a specified creation status.
        MlflowVersion:
          type: string
          description: Filter for tracking servers using the specified MLflow version.
        SortBy:
          type: string
          enum:
          - Name
          - CreationTime
          - Status
          description: Filter for trackings servers sorting by name, creation time, or creation status.
        SortOrder:
          type: string
          enum:
          - Ascending
          - Descending
          description: Change the order of the listed tracking servers. By default, tracking servers are listed in Descending
            order by creation time. 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 tracking servers to list.
    ListMlflowTrackingServersResponse:
      type: object
      properties:
        TrackingServerSummaries:
          type: array
          items:
            $ref: '#/components/schemas/TrackingServerSummary'
          description: A list of tracking servers according to chosen filters.
        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.
    ResourceLimitExceeded:
      type: object
      properties:
        Message:
          type: string
    ResourceNotFound:
      type: object
      properties:
        Message:
          type: string
    StartMlflowTrackingServerRequest:
      type: object
      properties:
        TrackingServerName:
          type: string
          description: The name of the tracking server to start.
      required:
      - TrackingServerName
    StartMlflowTrackingServerResponse:
      type: object
      properties:
        TrackingServerArn:
          type: string
          description: The ARN of the started tracking server.
    StopMlflowTrackingServerRequest:
      type: object
      properties:
        TrackingServerName:
          type: string
          description: The name of the tracking server to stop.
      required:
      - TrackingServerName
    StopMlflowTrackingServerResponse:
      type: object
      properties:
        TrackingServerArn:
          type: string
          description: The ARN of the stopped tracking server.
    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
    TrackingServerSummary:
      type: object
      properties:
        TrackingServerArn:
          type: string
          description: The ARN of a listed tracking server.
        TrackingServerName:
          type: string
          description: The name of a listed tracking server.
        CreationTime:
          type: string
          format: date-time
          description: The creation time of a listed tracking server.
        LastModifiedTime:
          type: string
          format: date-time
          description: The last modified time of a listed tracking server.
        TrackingServerStatus:
          type: string
          enum:
          - Creating
          - Created
          - CreateFailed
          - Updating
          - Updated
          - UpdateFailed
          - Deleting
          - DeleteFailed
          - Stopping
          - Stopped
          - StopFailed
          - Starting
          - Started
          - StartFailed
          - MaintenanceInProgress
          - MaintenanceComplete
          - MaintenanceFailed
          description: The creation status of a listed tracking server.
        IsActive:
          type: string
          enum:
          - Active
          - Inactive
          description: The activity status of a listed tracking server.
        MlflowVersion:
          type: string
          description: The MLflow version used for a listed tracking server.
    UpdateMlflowTrackingServerRequest:
      type: object
      properties:
        TrackingServerName:
          type: string
          description: The name of the MLflow Tracking Server to update.
        ArtifactStoreUri:
          type: string
          description: The new S3 URI for the general purpose bucket to use as the artifact store for the MLflow Tracking
            Server.
        TrackingServerSize:
          type: string
          enum:
          - Small
          - Medium
          - Large
          description: The new size for the MLflow Tracking Server.
        AutomaticModelRegistration:
          type: boolean
          description: Whether to enable or disable automatic registration of new MLflow models to the SageMaker Model Registry.
            To enable automatic model registration, set this value to True. To disable automatic model registration, set this
            value to False. If not specified, AutomaticModelRegistration defaults to False
        WeeklyMaintenanceWindowStart:
          type: string
          description: 'The new weekly maintenance window start day and time to update. The maintenance window day and time
            should be in Coordinated Universal Time (UTC) 24-hour standard time. For example: TUE:03:30.'
        S3BucketOwnerAccountId:
          type: string
          description: The new expected Amazon Web Services account ID that owns the Amazon S3 bucket for artifact storage.
        S3BucketOwnerVerification:
          type: boolean
          description: Whether to enable or disable Amazon S3 Bucket Owenrship Verifaction whenever the MLflow Tracking Server
            interacts with Amazon Amazon S3.
      required:
      - TrackingServerName
    UpdateMlflowTrackingServerResponse:
      type: object
      properties:
        TrackingServerArn:
          type: string
          description: The ARN of the updated MLflow Tracking Server.
    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)