Amazon SageMaker Sagemaker Mlflow App API

openapi: 3.1.0
info:
  title: Amazon SageMaker Service Mlflow App 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:
  /#CreateMlflowApp:
    post:
      operationId: CreateMlflowApp
      summary: Create Mlflow App
      description: Creates an MLflow Tracking Server using a general purpose Amazon S3 bucket as the artifact store.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/CreateMlflowAppResponse'
        '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.CreateMlflowApp
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/CreateMlflowAppRequest'
      tags:
      - Mlflow App
  /#DeleteMlflowApp:
    post:
      operationId: DeleteMlflowApp
      summary: Delete Mlflow App
      description: Deletes an MLflow App.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DeleteMlflowAppResponse'
        '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.DeleteMlflowApp
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DeleteMlflowAppRequest'
      tags:
      - Mlflow App
  /#DescribeMlflowApp:
    post:
      operationId: DescribeMlflowApp
      summary: Describe Mlflow App
      description: Returns information about an MLflow App.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DescribeMlflowAppResponse'
        '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.DescribeMlflowApp
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DescribeMlflowAppRequest'
      tags:
      - Mlflow App
  /#ListMlflowApps:
    post:
      operationId: ListMlflowApps
      summary: List Mlflow Apps
      description: Lists all MLflow Apps
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ListMlflowAppsResponse'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - SageMaker.ListMlflowApps
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/ListMlflowAppsRequest'
      tags:
      - Mlflow App
  /#UpdateMlflowApp:
    post:
      operationId: UpdateMlflowApp
      summary: Update Mlflow App
      description: Updates an MLflow App.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/UpdateMlflowAppResponse'
        '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.UpdateMlflowApp
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/UpdateMlflowAppRequest'
      tags:
      - Mlflow App
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
    CreateMlflowAppRequest:
      type: object
      properties:
        Name:
          type: string
          description: A string identifying the MLflow app name. This string is not part of the tracking server ARN.
        ArtifactStoreUri:
          type: string
          description: The S3 URI for a general purpose bucket to use as the MLflow App artifact store.
        RoleArn:
          type: string
          description: The Amazon Resource Name (ARN) for an IAM role in your account that the MLflow App uses to access the
            artifact store in Amazon S3. The role should have the AmazonS3FullAccess permission.
        KmsKeyId:
          type: string
          description: The ID of the Amazon Web Services KMS key used to encrypt the data at rest associated with the MLflow
            App. If you don't specify a value, the MLflow App is not encrypted with a customer-managed key.
        ModelRegistrationMode:
          type: string
          enum:
          - AutoModelRegistrationEnabled
          - AutoModelRegistrationDisabled
          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 AutoModelRegistrationEnabled. To disable automatic model
            registration, set this value to AutoModelRegistrationDisabled. If not specified, AutomaticModelRegistration defaults
            to AutoModelRegistrationDisabled.
        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.'
        AccountDefaultStatus:
          type: string
          enum:
          - ENABLED
          - DISABLED
          description: Indicates whether this MLflow app is the default for the entire account.
        DefaultDomainIdList:
          type: array
          items:
            type: string
          description: List of SageMaker domain IDs for which this MLflow App is used as the default.
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: Tags consisting of key-value pairs used to manage metadata for the MLflow App.
      required:
      - Name
      - ArtifactStoreUri
      - RoleArn
    CreateMlflowAppResponse:
      type: object
      properties:
        Arn:
          type: string
          description: The ARN of the MLflow App.
    DeleteMlflowAppRequest:
      type: object
      properties:
        Arn:
          type: string
          description: The ARN of the MLflow App to delete.
      required:
      - Arn
    DeleteMlflowAppResponse:
      type: object
      properties:
        Arn:
          type: string
          description: The ARN of the deleted MLflow App.
    DescribeMlflowAppRequest:
      type: object
      properties:
        Arn:
          type: string
          description: The ARN of the MLflow App for which to get information.
      required:
      - Arn
    DescribeMlflowAppResponse:
      type: object
      properties:
        Arn:
          type: string
          description: The ARN of the MLflow App.
        Name:
          type: string
          description: The name of the MLflow App.
        ArtifactStoreUri:
          type: string
          description: The S3 URI of the general purpose bucket used as the MLflow App artifact store.
        MlflowVersion:
          type: string
          description: The MLflow version used.
        RoleArn:
          type: string
          description: The Amazon Resource Name (ARN) for an IAM role in your account that the MLflow App uses to access the
            artifact store in Amazon S3.
        KmsKeyId:
          type: string
          description: The ID of the Amazon Web Services KMS key used to encrypt the data at rest associated with the MLflow
            App. This field is absent if the MLflow App is not encrypted with a customer-managed key.
        Status:
          type: string
          enum:
          - Creating
          - Created
          - CreateFailed
          - Updating
          - Updated
          - UpdateFailed
          - Deleting
          - DeleteFailed
          - Deleted
          description: The current creation status of the described MLflow App.
        ModelRegistrationMode:
          type: string
          enum:
          - AutoModelRegistrationEnabled
          - AutoModelRegistrationDisabled
          description: Whether automatic registration of new MLflow models to the SageMaker Model Registry is enabled.
        AccountDefaultStatus:
          type: string
          enum:
          - ENABLED
          - DISABLED
          description: Indicates whether this MLflow app is the default for the entire account.
        DefaultDomainIdList:
          type: array
          items:
            type: string
          description: List of SageMaker Domain IDs for which this MLflow App is the default.
        CreationTime:
          type: string
          format: date-time
          description: The timestamp when the MLflow App was created.
        CreatedBy:
          $ref: '#/components/schemas/UserContext'
        LastModifiedTime:
          type: string
          format: date-time
          description: The timestamp when the MLflow App was last modified.
        LastModifiedBy:
          $ref: '#/components/schemas/UserContext'
        WeeklyMaintenanceWindowStart:
          type: string
          description: The day and time of the week when weekly maintenance occurs.
        MaintenanceStatus:
          type: string
          enum:
          - MaintenanceInProgress
          - MaintenanceComplete
          - MaintenanceFailed
          description: Current maintenance status of the MLflow App.
    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.
    ListMlflowAppsRequest:
      type: object
      properties:
        CreatedAfter:
          type: string
          format: date-time
          description: Use the CreatedAfter filter to only list MLflow Apps created after a specific date and time. Listed
            MLflow Apps are shown with a date and time such as "2024-03-16T01:46:56+00:00". The CreatedAfter parameter takes
            in a Unix timestamp.
        CreatedBefore:
          type: string
          format: date-time
          description: Use the CreatedBefore filter to only list MLflow Apps created before a specific date and time. Listed
            MLflow Apps are shown with a date and time such as "2024-03-16T01:46:56+00:00". The CreatedAfter parameter takes
            in a Unix timestamp.
        Status:
          type: string
          enum:
          - Creating
          - Created
          - CreateFailed
          - Updating
          - Updated
          - UpdateFailed
          - Deleting
          - DeleteFailed
          - Deleted
          description: Filter for Mlflow apps with a specific creation status.
        MlflowVersion:
          type: string
          description: Filter for Mlflow Apps with the specified version.
        DefaultForDomainId:
          type: string
          description: Filter for MLflow Apps with the specified default SageMaker Domain ID.
        AccountDefaultStatus:
          type: string
          enum:
          - ENABLED
          - DISABLED
          description: Filter for MLflow Apps with the specified AccountDefaultStatus.
        SortBy:
          type: string
          enum:
          - Name
          - CreationTime
          - Status
          description: Filter for MLflow Apps sorting by name, creation time, or creation status.
        SortOrder:
          type: string
          enum:
          - Ascending
          - Descending
          description: Change the order of the listed MLflow Apps. By default, MLflow Apps are listed in Descending order
            by creation time. To change the list order, specify SortOrder to be Ascending.
        NextToken:
          type: string
          description: If the previous response was truncated, use this token in your next request to receive the next set
            of results.
        MaxResults:
          type: integer
          description: The maximum number of MLflow Apps to list.
    ListMlflowAppsResponse:
      type: object
      properties:
        Summaries:
          type: array
          items:
            $ref: '#/components/schemas/MlflowAppSummary'
          description: A list of MLflow Apps 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.
    MlflowAppSummary:
      type: object
      properties:
        Arn:
          type: string
          description: The ARN of a listed MLflow App.
        Name:
          type: string
          description: The name of the MLflow App.
        Status:
          type: string
          enum:
          - Creating
          - Created
          - CreateFailed
          - Updating
          - Updated
          - UpdateFailed
          - Deleting
          - DeleteFailed
          - Deleted
          description: The status of the MLflow App.
        CreationTime:
          type: string
          format: date-time
          description: The creation time of a listed MLflow App.
        LastModifiedTime:
          type: string
          format: date-time
          description: The last modified time of a listed MLflow App.
        MlflowVersion:
          type: string
          description: The version of a listed MLflow App.
    ResourceLimitExceeded:
      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
    UpdateMlflowAppRequest:
      type: object
      properties:
        Arn:
          type: string
          description: The ARN of the MLflow App to update.
        Name:
          type: string
          description: The name of the MLflow App to update.
        ArtifactStoreUri:
          type: string
          description: The new S3 URI for the general purpose bucket to use as the artifact store for the MLflow App.
        ModelRegistrationMode:
          type: string
          enum:
          - AutoModelRegistrationEnabled
          - AutoModelRegistrationDisabled
          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 AutoModelRegistrationEnabled. To disable automatic model
            registration, set this value to AutoModelRegistrationDisabled. If not specified, AutomaticModelRegistration defaults
            to AutoModelRegistrationEnabled
        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.'
        DefaultDomainIdList:
          type: array
          items:
            type: string
          description: List of SageMaker Domain IDs for which this MLflow App is the default.
        AccountDefaultStatus:
          type: string
          enum:
          - ENABLED
          - DISABLED
          description: Indicates whether this this MLflow App is the default for the account.
      required:
      - Arn
    UpdateMlflowAppResponse:
      type: object
      properties:
        Arn:
          type: string
          description: The ARN of the updated MLflow App.
    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)