Amazon SageMaker Sagemaker Model Card API

openapi: 3.1.0
info:
  title: Amazon SageMaker Service Model Card 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:
  /#CreateModelCard:
    post:
      operationId: CreateModelCard
      summary: Create Model Card
      description: Creates an Amazon SageMaker Model Card. For information about how to use model cards, see Amazon SageMaker
        Model Card.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/CreateModelCardResponse'
        '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.CreateModelCard
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/CreateModelCardRequest'
      tags:
      - Model Card
  /#DeleteModelCard:
    post:
      operationId: DeleteModelCard
      summary: Delete Model Card
      description: Deletes an Amazon SageMaker Model Card.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                type: string
        '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.DeleteModelCard
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DeleteModelCardRequest'
      tags:
      - Model Card
  /#DescribeModelCard:
    post:
      operationId: DescribeModelCard
      summary: Describe Model Card
      description: Describes the content, creation time, and security configuration of an Amazon SageMaker Model Card. To
        retrieve only metadata about a model card without requiring kms:Decrypt permission on the associated customer-managed
        Amazon Web Services KMS key, set IncludedData to MetadataOnly. The default is AllData, which returns the full model
        card Content and requires kms:Decrypt permission when a customer-managed key is configured.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DescribeModelCardResponse'
        '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.DescribeModelCard
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DescribeModelCardRequest'
      tags:
      - Model Card
  /#ListModelCards:
    post:
      operationId: ListModelCards
      summary: List Model Cards
      description: List existing model cards.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ListModelCardsResponse'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - SageMaker.ListModelCards
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/ListModelCardsRequest'
      tags:
      - Model Card
  /#UpdateModelCard:
    post:
      operationId: UpdateModelCard
      summary: Update Model Card
      description: Update an Amazon SageMaker Model Card. You cannot update both model card content and model card status
        in a single call.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/UpdateModelCardResponse'
        '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.UpdateModelCard
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/UpdateModelCardRequest'
      tags:
      - Model Card
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
    CreateModelCardRequest:
      type: object
      properties:
        ModelCardName:
          type: string
          description: The unique name of the model card.
        SecurityConfig:
          $ref: '#/components/schemas/ModelCardSecurityConfig'
        Content:
          type: string
          description: The content of the model card. Content must be in model card JSON schema and provided as a string.
        ModelCardStatus:
          type: string
          enum:
          - Draft
          - PendingReview
          - Approved
          - Archived
          description: 'The approval status of the model card within your organization. Different organizations might have
            different criteria for model card review and approval. Draft: The model card is a work in progress. PendingReview:
            The model card is pending review. Approved: The model card is approved. Archived: The model card is archived.
            No more updates should be made to the model card, but it can still be exported.'
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: Key-value pairs used to manage metadata for model cards.
      required:
      - ModelCardName
      - Content
      - ModelCardStatus
    CreateModelCardResponse:
      type: object
      properties:
        ModelCardArn:
          type: string
          description: The Amazon Resource Name (ARN) of the successfully created model card.
      required:
      - ModelCardArn
    DeleteModelCardRequest:
      type: object
      properties:
        ModelCardName:
          type: string
          description: The name of the model card to delete.
      required:
      - ModelCardName
    DescribeModelCardRequest:
      type: object
      properties:
        ModelCardName:
          type: string
          description: The name or Amazon Resource Name (ARN) of the model card to describe.
        ModelCardVersion:
          type: integer
          description: The version of the model card to describe. If a version is not provided, then the latest version of
            the model card is described.
        IncludedData:
          type: string
          enum:
          - AllData
          - MetadataOnly
          description: 'Specifies the level of model card data to include in the response. Use this parameter to call DescribeModelCard
            without requiring kms:Decrypt permission on the customer-managed Amazon Web Services KMS key. AllData: Returns
            the full model card Content. This option requires kms:Decrypt permission on the customer-managed key, if one is
            associated with the model card. This is the default. MetadataOnly: Returns the model card with sanitized Content
            that includes only a small set of unencrypted metadata fields. This option does not require kms:Decrypt permission.
            For the list of fields preserved in '
      required:
      - ModelCardName
    DescribeModelCardResponse:
      type: object
      properties:
        ModelCardArn:
          type: string
          description: The Amazon Resource Name (ARN) of the model card.
        ModelCardName:
          type: string
          description: The name of the model card.
        ModelCardVersion:
          type: integer
          description: The version of the model card.
        Content:
          type: string
          description: 'The content of the model card. Content is provided as a string in the model card JSON schema. When
            you set IncludedData to MetadataOnly in the request, SageMaker returns a sanitized version of Content that includes
            only the following JSON paths, when present in the model card: model_overview.model_id model_overview.model_name
            intended_uses.risk_rating model_package_details.model_package_group_name model_package_details.model_package_arn
            All other fields are removed from Content when IncludedData is MetadataOnly, including model description, training
            details, evaluation details, business detail'
        ModelCardStatus:
          type: string
          enum:
          - Draft
          - PendingReview
          - Approved
          - Archived
          description: 'The approval status of the model card within your organization. Different organizations might have
            different criteria for model card review and approval. Draft: The model card is a work in progress. PendingReview:
            The model card is pending review. Approved: The model card is approved. Archived: The model card is archived.
            No more updates should be made to the model card, but it can still be exported.'
        SecurityConfig:
          $ref: '#/components/schemas/ModelCardSecurityConfig'
        CreationTime:
          type: string
          format: date-time
          description: The date and time the model card was created.
        CreatedBy:
          $ref: '#/components/schemas/UserContext'
        LastModifiedTime:
          type: string
          format: date-time
          description: The date and time the model card was last modified.
        LastModifiedBy:
          $ref: '#/components/schemas/UserContext'
        ModelCardProcessingStatus:
          type: string
          enum:
          - DeleteInProgress
          - DeletePending
          - ContentDeleted
          - ExportJobsDeleted
          - DeleteCompleted
          - DeleteFailed
          description: 'The processing status of model card deletion. The ModelCardProcessingStatus updates throughout the
            different deletion steps. DeletePending: Model card deletion request received. DeleteInProgress: Model card deletion
            is in progress. ContentDeleted: Deleted model card content. ExportJobsDeleted: Deleted all export jobs associated
            with the model card. DeleteCompleted: Successfully deleted the model card. DeleteFailed: The model card failed
            to delete.'
      required:
      - ModelCardArn
      - ModelCardName
      - ModelCardVersion
      - Content
      - ModelCardStatus
      - CreationTime
      - CreatedBy
    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.
    ListModelCardsRequest:
      type: object
      properties:
        CreationTimeAfter:
          type: string
          format: date-time
          description: Only list model cards that were created after the time specified.
        CreationTimeBefore:
          type: string
          format: date-time
          description: Only list model cards that were created before the time specified.
        MaxResults:
          type: integer
          description: The maximum number of model cards to list.
        NameContains:
          type: string
          description: Only list model cards with names that contain the specified string.
        ModelCardStatus:
          type: string
          enum:
          - Draft
          - PendingReview
          - Approved
          - Archived
          description: Only list model cards with the specified approval status.
        NextToken:
          type: string
          description: If the response to a previous ListModelCards request was truncated, the response includes a NextToken.
            To retrieve the next set of model cards, use the token in the next request.
        SortBy:
          type: string
          enum:
          - Name
          - CreationTime
          description: Sort model cards by either name or creation time. Sorts by creation time by default.
        SortOrder:
          type: string
          enum:
          - Ascending
          - Descending
          description: Sort model cards by ascending or descending order.
    ListModelCardsResponse:
      type: object
      properties:
        ModelCardSummaries:
          type: array
          items:
            $ref: '#/components/schemas/ModelCardSummary'
          description: The summaries of the listed model cards.
        NextToken:
          type: string
          description: If the response is truncated, SageMaker returns this token. To retrieve the next set of model cards,
            use it in the subsequent request.
      required:
      - ModelCardSummaries
    ModelCardSecurityConfig:
      type: object
      properties:
        KmsKeyId:
          type: string
          description: A Key Management Service key ID to use for encrypting a model card.
    ModelCardSummary:
      type: object
      properties:
        ModelCardName:
          type: string
          description: The name of the model card.
        ModelCardArn:
          type: string
          description: The Amazon Resource Name (ARN) of the model card.
        ModelCardStatus:
          type: string
          enum:
          - Draft
          - PendingReview
          - Approved
          - Archived
          description: 'The approval status of the model card within your organization. Different organizations might have
            different criteria for model card review and approval. Draft: The model card is a work in progress. PendingReview:
            The model card is pending review. Approved: The model card is approved. Archived: The model card is archived.
            No more updates should be made to the model card, but it can still be exported.'
        CreationTime:
          type: string
          format: date-time
          description: The date and time that the model card was created.
        LastModifiedTime:
          type: string
          format: date-time
          description: The date and time that the model card was last modified.
      required:
      - ModelCardName
      - ModelCardArn
      - ModelCardStatus
      - CreationTime
    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
    UpdateModelCardRequest:
      type: object
      properties:
        ModelCardName:
          type: string
          description: The name or Amazon Resource Name (ARN) of the model card to update.
        Content:
          type: string
          description: The updated model card content. Content must be in model card JSON schema and provided as a string.
            When updating model card content, be sure to include the full content and not just updated content.
        ModelCardStatus:
          type: string
          enum:
          - Draft
          - PendingReview
          - Approved
          - Archived
          description: 'The approval status of the model card within your organization. Different organizations might have
            different criteria for model card review and approval. Draft: The model card is a work in progress. PendingReview:
            The model card is pending review. Approved: The model card is approved. Archived: The model card is archived.
            No more updates should be made to the model card, but it can still be exported.'
      required:
      - ModelCardName
    UpdateModelCardResponse:
      type: object
      properties:
        ModelCardArn:
          type: string
          description: The Amazon Resource Name (ARN) of the updated model card.
      required:
      - ModelCardArn
    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)