Amazon SageMaker Sagemaker Partner App API

openapi: 3.1.0
info:
  title: Amazon SageMaker Service Partner 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:
  /#CreatePartnerApp:
    post:
      operationId: CreatePartnerApp
      summary: Create Partner App
      description: Creates an Amazon SageMaker Partner AI App.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/CreatePartnerAppResponse'
        '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.CreatePartnerApp
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/CreatePartnerAppRequest'
      tags:
      - Partner App
  /#DeletePartnerApp:
    post:
      operationId: DeletePartnerApp
      summary: Delete Partner App
      description: Deletes a SageMaker Partner AI App.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DeletePartnerAppResponse'
        '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.DeletePartnerApp
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DeletePartnerAppRequest'
      tags:
      - Partner App
  /#DescribePartnerApp:
    post:
      operationId: DescribePartnerApp
      summary: Describe Partner App
      description: Gets information about a SageMaker Partner AI App.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DescribePartnerAppResponse'
        '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.DescribePartnerApp
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DescribePartnerAppRequest'
      tags:
      - Partner App
  /#ListPartnerApps:
    post:
      operationId: ListPartnerApps
      summary: List Partner Apps
      description: Lists all of the SageMaker Partner AI Apps in an account.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ListPartnerAppsResponse'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - SageMaker.ListPartnerApps
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/ListPartnerAppsRequest'
      tags:
      - Partner App
  /#UpdatePartnerApp:
    post:
      operationId: UpdatePartnerApp
      summary: Update Partner App
      description: Updates all of the SageMaker Partner AI Apps in an account.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/UpdatePartnerAppResponse'
        '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.UpdatePartnerApp
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/UpdatePartnerAppRequest'
      tags:
      - Partner 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:
    AvailableUpgrade:
      type: object
      properties:
        Version:
          type: string
          description: The semantic version number of the available upgrade for the SageMaker Partner AI App.
        ReleaseNotes:
          type: array
          items:
            type: string
          description: A list of release notes describing the changes and improvements included in the available upgrade version.
    ConflictException:
      type: object
      properties:
        Message:
          type: string
    CreatePartnerAppRequest:
      type: object
      properties:
        Name:
          type: string
          description: The name to give the SageMaker Partner AI App.
        Type:
          type: string
          enum:
          - lakera-guard
          - comet
          - deepchecks-llm-evaluation
          - fiddler
          description: 'The type of SageMaker Partner AI App to create. Must be one of the following: lakera-guard, comet,
            deepchecks-llm-evaluation, or fiddler.'
        ExecutionRoleArn:
          type: string
          description: The ARN of the IAM role that the partner application uses.
        KmsKeyId:
          type: string
          description: SageMaker Partner AI Apps uses Amazon Web Services KMS to encrypt data at rest using an Amazon Web
            Services managed key by default. For more control, specify a customer managed key.
        MaintenanceConfig:
          $ref: '#/components/schemas/PartnerAppMaintenanceConfig'
        Tier:
          type: string
          description: Indicates the instance type and size of the cluster attached to the SageMaker Partner AI App.
        ApplicationConfig:
          $ref: '#/components/schemas/PartnerAppConfig'
        IdcConfig:
          $ref: '#/components/schemas/IdcConfigInput'
        AuthType:
          type: string
          enum:
          - IAM
          - IDC
          description: 'The authorization type that users use to access the SageMaker Partner AI App. Valid values: IAM: Users
            access the SageMaker Partner AI App with their Amazon Web Services IAM identity. IDC: Users access the SageMaker
            Partner AI App with their Amazon Web Services IAM Identity Center identity. Specify the Identity Center instance
            to use in IdcConfig.'
        EnableIamSessionBasedIdentity:
          type: boolean
          description: When set to TRUE, the SageMaker Partner AI App sets the Amazon Web Services IAM session name or the
            authenticated IAM user as the identity of the SageMaker Partner AI App user.
        EnableAutoMinorVersionUpgrade:
          type: boolean
          description: When set to TRUE, the SageMaker Partner AI App is automatically upgraded to the latest minor version
            during the next scheduled maintenance window, if one is available. Default is FALSE.
        ClientToken:
          type: string
          description: A unique token that guarantees that the call to this API is idempotent.
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: Each tag consists of a key and an optional value. Tag keys must be unique per resource.
      required:
      - Name
      - Type
      - ExecutionRoleArn
      - Tier
      - AuthType
    CreatePartnerAppResponse:
      type: object
      properties:
        Arn:
          type: string
          description: The ARN of the SageMaker Partner AI App.
    DeletePartnerAppRequest:
      type: object
      properties:
        Arn:
          type: string
          description: The ARN of the SageMaker Partner AI App to delete.
        ClientToken:
          type: string
          description: A unique token that guarantees that the call to this API is idempotent.
      required:
      - Arn
    DeletePartnerAppResponse:
      type: object
      properties:
        Arn:
          type: string
          description: The ARN of the SageMaker Partner AI App that was deleted.
    DescribePartnerAppRequest:
      type: object
      properties:
        Arn:
          type: string
          description: The ARN of the SageMaker Partner AI App to describe.
        IncludeAvailableUpgrade:
          type: boolean
          description: When set to TRUE, the response includes available upgrade information for the SageMaker Partner AI
            App. Default is FALSE.
      required:
      - Arn
    DescribePartnerAppResponse:
      type: object
      properties:
        Arn:
          type: string
          description: The ARN of the SageMaker Partner AI App that was described.
        Name:
          type: string
          description: The name of the SageMaker Partner AI App.
        Type:
          type: string
          enum:
          - lakera-guard
          - comet
          - deepchecks-llm-evaluation
          - fiddler
          description: 'The type of SageMaker Partner AI App. Must be one of the following: lakera-guard, comet, deepchecks-llm-evaluation,
            or fiddler.'
        Status:
          type: string
          enum:
          - Creating
          - Updating
          - Deleting
          - Available
          - Failed
          - UpdateFailed
          - Deleted
          description: 'The status of the SageMaker Partner AI App. Creating: SageMaker AI is creating the partner AI app.
            The partner AI app is not available during creation. Updating: SageMaker AI is updating the partner AI app. The
            partner AI app is not available when updating. Deleting: SageMaker AI is deleting the partner AI app. The partner
            AI app is not available during deletion. Available: The partner AI app is provisioned and accessible. Failed:
            The partner AI app is in a failed state and isn''t available. SageMaker AI is investigating the issue. For further
            guidance, contact Amazon Web Services Support. Upda'
        CreationTime:
          type: string
          format: date-time
          description: The time that the SageMaker Partner AI App was created.
        LastModifiedTime:
          type: string
          format: date-time
          description: The time that the SageMaker Partner AI App was last modified.
        ExecutionRoleArn:
          type: string
          description: The ARN of the IAM role associated with the SageMaker Partner AI App.
        KmsKeyId:
          type: string
          description: The Amazon Web Services KMS customer managed key used to encrypt the data at rest associated with SageMaker
            Partner AI Apps.
        BaseUrl:
          type: string
          description: The URL of the SageMaker Partner AI App that the Application SDK uses to support in-app calls for the
            user.
        MaintenanceConfig:
          $ref: '#/components/schemas/PartnerAppMaintenanceConfig'
        Tier:
          type: string
          description: The instance type and size of the cluster attached to the SageMaker Partner AI App.
        Version:
          type: string
          description: The version of the SageMaker Partner AI App.
        ApplicationConfig:
          $ref: '#/components/schemas/PartnerAppConfig'
        AuthType:
          type: string
          enum:
          - IAM
          - IDC
          description: 'The authorization type that users use to access the SageMaker Partner AI App. Valid values: IAM: Users
            access the SageMaker Partner AI App with their Amazon Web Services IAM identity. IDC: Users access the SageMaker
            Partner AI App with their Amazon Web Services IAM Identity Center identity.'
        EnableIamSessionBasedIdentity:
          type: boolean
          description: When set to TRUE, the SageMaker Partner AI App sets the Amazon Web Services IAM session name or the
            authenticated IAM user as the identity of the SageMaker Partner AI App user.
        Error:
          $ref: '#/components/schemas/ErrorInfo'
        EnableAutoMinorVersionUpgrade:
          type: boolean
          description: Indicates whether the SageMaker Partner AI App is configured for automatic minor version upgrades during
            scheduled maintenance windows.
        CurrentVersionEolDate:
          type: string
          format: date-time
          description: The end-of-life date for the current version of the SageMaker Partner AI App.
        AvailableUpgrade:
          $ref: '#/components/schemas/AvailableUpgrade'
        IdcConfig:
          $ref: '#/components/schemas/IdcConfigOutput'
    ErrorInfo:
      type: object
      properties:
        Code:
          type: string
          description: The error code for an invalid or failed operation.
        Reason:
          type: string
          description: The failure reason for the operation.
    IdcConfigInput:
      type: object
      properties:
        InstanceArn:
          type: string
          description: The ARN of the Amazon Web Services IAM Identity Center instance that the SageMaker Partner AI App uses
            to authenticate users.
      required:
      - InstanceArn
    IdcConfigOutput:
      type: object
      properties:
        InstanceArn:
          type: string
          description: The ARN of the Amazon Web Services IAM Identity Center instance that the SageMaker Partner AI App uses
            to authenticate users.
        ApplicationArn:
          type: string
          description: The ARN of the Amazon Web Services IAM Identity Center application that SageMaker creates for the SageMaker
            Partner AI App.
      required:
      - InstanceArn
    ListPartnerAppsRequest:
      type: object
      properties:
        MaxResults:
          type: integer
          description: This parameter defines the maximum number of results that can be returned in a single response. The
            MaxResults parameter is an upper bound, not a target. If there are more results available than the value specified,
            a NextToken is provided in the response. The NextToken indicates that the user should get the next set of results
            by providing this token as a part of a subsequent call. The default value for MaxResults is 10.
        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.
    ListPartnerAppsResponse:
      type: object
      properties:
        Summaries:
          type: array
          items:
            $ref: '#/components/schemas/PartnerAppSummary'
          description: The information related to each of the SageMaker Partner AI Apps in an account.
        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.
    PartnerAppConfig:
      type: object
      properties:
        AdminUsers:
          type: array
          items:
            type: string
          description: The list of users that are given admin access to the SageMaker Partner AI App.
        Arguments:
          type: object
          additionalProperties:
            type: string
          description: This is a map of required inputs for a SageMaker Partner AI App. Based on the application type, the
            map is populated with a key and value pair that is specific to the user and application.
        AssignedGroupPatterns:
          type: array
          items:
            type: string
          description: A list of Amazon Web Services IAM Identity Center group patterns that can access the SageMaker Partner
            AI App. Group names support wildcard matching using *. An empty list indicates the app will not use Identity Center
            group features. All groups specified in RoleGroupAssignments must match patterns in this list.
        RoleGroupAssignments:
          type: array
          items:
            $ref: '#/components/schemas/RoleGroupAssignment'
          description: 'A map of in-app roles to Amazon Web Services IAM Identity Center group patterns. Groups assigned to
            specific roles receive those permissions, while groups in AssignedGroupPatterns but not in this map receive default
            in-app role depending on app type. Group patterns support wildcard matching using *. Currently supported by Fiddler
            version 1.3 and later with roles: ORG_MEMBER (default) and ORG_ADMIN.'
    PartnerAppMaintenanceConfig:
      type: object
      properties:
        MaintenanceWindowStart:
          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. This value must take the following format: 3-letter-day:24-h-hour:minute. For
            example: TUE:03:30.'
    PartnerAppSummary:
      type: object
      properties:
        Arn:
          type: string
          description: The ARN of the SageMaker Partner AI App.
        Name:
          type: string
          description: The name of the SageMaker Partner AI App.
        Type:
          type: string
          enum:
          - lakera-guard
          - comet
          - deepchecks-llm-evaluation
          - fiddler
          description: 'The type of SageMaker Partner AI App to create. Must be one of the following: lakera-guard, comet,
            deepchecks-llm-evaluation, or fiddler.'
        Status:
          type: string
          enum:
          - Creating
          - Updating
          - Deleting
          - Available
          - Failed
          - UpdateFailed
          - Deleted
          description: The status of the SageMaker Partner AI App.
        CreationTime:
          type: string
          format: date-time
          description: The creation time of the SageMaker Partner AI App.
    ResourceNotFound:
      type: object
      properties:
        Message:
          type: string
    RoleGroupAssignment:
      type: object
      properties:
        RoleName:
          type: string
          description: The name of the in-app role within the SageMaker Partner AI App. The specific roles available depend
            on the app type and version.
        GroupPatterns:
          type: array
          items:
            type: string
          description: A list of Amazon Web Services IAM Identity Center group patterns that should be assigned to the specified
            role. Group patterns support wildcard matching using *.
      required:
      - RoleName
      - GroupPatterns
    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
    UpdatePartnerAppRequest:
      type: object
      properties:
        Arn:
          type: string
          description: The ARN of the SageMaker Partner AI App to update.
        MaintenanceConfig:
          $ref: '#/components/schemas/PartnerAppMaintenanceConfig'
        Tier:
          type: string
          description: Indicates the instance type and size of the cluster attached to the SageMaker Partner AI App.
        ApplicationConfig:
          $ref: '#/components/schemas/PartnerAppConfig'
        IdcConfig:
          $ref: '#/components/schemas/IdcConfigInput'
        AuthType:
          type: string
          enum:
          - IAM
          - IDC
          description: 'The authorization type that users use to access the SageMaker Partner AI App. Use this parameter to
            migrate an existing SageMaker Partner AI App from IAM authorization to IDC authorization. Valid values: IAM: Users
            access the SageMaker Partner AI App with their Amazon Web Services IAM identity. IDC: Users access the SageMaker
            Partner AI App with their Amazon Web Services IAM Identity Center identity. Specify the Identity Center instance
            to use in IdcConfig.'
        EnableIamSessionBasedIdentity:
          type: boolean
          description: When set to TRUE, the SageMaker Partner AI App sets the Amazon Web Services IAM session name or the
            authenticated IAM user as the identity of the SageMaker Partner AI App user.
        EnableAutoMinorVersionUpgrade:
          type: boolean
          description: When set to TRUE, the SageMaker Partner AI App is automatically upgraded to the latest minor version
            during the next scheduled maintenance window, if one is available.
        AppVersion:
          type: string
          description: The semantic version to upgrade the SageMaker Partner AI App to. Must be the same semantic version
            returned in the AvailableUpgrade field from DescribePartnerApp. Version skipping and downgrades are not supported.
        ClientToken:
          type: string
          description: A unique token that guarantees that the call to this API is idempotent.
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: Each tag consists of a key and an optional value. Tag keys must be unique per resource.
      required:
      - Arn
    UpdatePartnerAppResponse:
      type: object
      properties:
        Arn:
          type: string
          description: The ARN of the SageMaker Partner AI App that was updated.
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)