Amazon SageMaker Sagemaker Model Package Group API

openapi: 3.1.0
info:
  title: Amazon SageMaker Service Model Package Group 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:
  /#CreateModelPackageGroup:
    post:
      operationId: CreateModelPackageGroup
      summary: Create Model Package Group
      description: Creates a model group. A model group contains a group of model versions.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/CreateModelPackageGroupOutput'
        '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.CreateModelPackageGroup
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/CreateModelPackageGroupInput'
      tags:
      - Model Package Group
  /#DeleteModelPackageGroup:
    post:
      operationId: DeleteModelPackageGroup
      summary: Delete Model Package Group
      description: Deletes the specified model group.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                type: string
        '400':
          description: ConflictException
          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.DeleteModelPackageGroup
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DeleteModelPackageGroupInput'
      tags:
      - Model Package Group
  /#DescribeModelPackageGroup:
    post:
      operationId: DescribeModelPackageGroup
      summary: Describe Model Package Group
      description: Gets a description for the specified model group.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DescribeModelPackageGroupOutput'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - SageMaker.DescribeModelPackageGroup
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DescribeModelPackageGroupInput'
      tags:
      - Model Package Group
  /#ListModelPackageGroups:
    post:
      operationId: ListModelPackageGroups
      summary: List Model Package Groups
      description: Gets a list of the model groups in your Amazon Web Services account.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ListModelPackageGroupsOutput'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - SageMaker.ListModelPackageGroups
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/ListModelPackageGroupsInput'
      tags:
      - Model Package Group
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
    CreateModelPackageGroupInput:
      type: object
      properties:
        ModelPackageGroupName:
          type: string
          description: The name of the model group.
        ModelPackageGroupDescription:
          type: string
          description: A description for the model group.
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: A list of key value pairs associated with the model group. For more information, see Tagging Amazon
            Web Services resources in the Amazon Web Services General Reference Guide.
        ManagedConfiguration:
          $ref: '#/components/schemas/ManagedConfiguration'
      required:
      - ModelPackageGroupName
    CreateModelPackageGroupOutput:
      type: object
      properties:
        ModelPackageGroupArn:
          type: string
          description: The Amazon Resource Name (ARN) of the model group.
      required:
      - ModelPackageGroupArn
    DeleteModelPackageGroupInput:
      type: object
      properties:
        ModelPackageGroupName:
          type: string
          description: The name of the model group to delete.
      required:
      - ModelPackageGroupName
    DescribeModelPackageGroupInput:
      type: object
      properties:
        ModelPackageGroupName:
          type: string
          description: The name of the model group to describe.
      required:
      - ModelPackageGroupName
    DescribeModelPackageGroupOutput:
      type: object
      properties:
        ModelPackageGroupName:
          type: string
          description: The name of the model group.
        ModelPackageGroupArn:
          type: string
          description: The Amazon Resource Name (ARN) of the model group.
        ModelPackageGroupDescription:
          type: string
          description: A description of the model group.
        CreationTime:
          type: string
          format: date-time
          description: The time that the model group was created.
        CreatedBy:
          $ref: '#/components/schemas/UserContext'
        ModelPackageGroupStatus:
          type: string
          enum:
          - Pending
          - InProgress
          - Completed
          - Failed
          - Deleting
          - DeleteFailed
          description: The status of the model group.
        ManagedConfiguration:
          $ref: '#/components/schemas/ManagedConfiguration'
      required:
      - ModelPackageGroupName
      - ModelPackageGroupArn
      - CreationTime
      - CreatedBy
      - ModelPackageGroupStatus
    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.
    ListModelPackageGroupsInput:
      type: object
      properties:
        CreationTimeAfter:
          type: string
          format: date-time
          description: A filter that returns only model groups created after the specified time.
        CreationTimeBefore:
          type: string
          format: date-time
          description: A filter that returns only model groups created before the specified time.
        MaxResults:
          type: integer
          description: The maximum number of results to return in the response.
        NameContains:
          type: string
          description: A string in the model group name. This filter returns only model groups whose name contains the specified
            string.
        NextToken:
          type: string
          description: If the result of the previous ListModelPackageGroups request was truncated, the response includes a
            NextToken. To retrieve the next set of model groups, use the token in the next request.
        SortBy:
          type: string
          enum:
          - Name
          - CreationTime
          description: The field to sort results by. The default is CreationTime.
        SortOrder:
          type: string
          enum:
          - Ascending
          - Descending
          description: The sort order for results. The default is Ascending.
        CrossAccountFilterOption:
          type: string
          enum:
          - SameAccount
          - CrossAccount
          description: A filter that returns either model groups shared with you or model groups in your own account. When
            the value is CrossAccount, the results show the resources made discoverable to you from other accounts. When the
            value is SameAccount or null, the results show resources from your account. The default is SameAccount.
    ListModelPackageGroupsOutput:
      type: object
      properties:
        ModelPackageGroupSummaryList:
          type: array
          items:
            $ref: '#/components/schemas/ModelPackageGroupSummary'
          description: A list of summaries of the model groups in your Amazon Web Services account.
        NextToken:
          type: string
          description: If the response is truncated, SageMaker returns this token. To retrieve the next set of model groups,
            use it in the subsequent request.
      required:
      - ModelPackageGroupSummaryList
    ManagedConfiguration:
      type: object
      properties:
        ManagedStorageType:
          type: string
          enum:
          - Restricted
          description: The storage type of the model package.
    ModelPackageGroupSummary:
      type: object
      properties:
        ModelPackageGroupName:
          type: string
          description: The name of the model group.
        ModelPackageGroupArn:
          type: string
          description: The Amazon Resource Name (ARN) of the model group.
        ModelPackageGroupDescription:
          type: string
          description: A description of the model group.
        CreationTime:
          type: string
          format: date-time
          description: The time that the model group was created.
        ModelPackageGroupStatus:
          type: string
          enum:
          - Pending
          - InProgress
          - Completed
          - Failed
          - Deleting
          - DeleteFailed
          description: The status of the model group.
        ManagedConfiguration:
          $ref: '#/components/schemas/ManagedConfiguration'
      required:
      - ModelPackageGroupName
      - ModelPackageGroupArn
      - CreationTime
      - ModelPackageGroupStatus
    ResourceLimitExceeded:
      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
    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)