Amazon SageMaker Sagemaker Model Card Export Job API

openapi: 3.1.0
info:
  title: Amazon SageMaker Service Model Card Export Job API
  version: '2017-07-24'
  description: Generated from AWS's published Smithy model for Amazon SageMaker Service. 3 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:
  /#CreateModelCardExportJob:
    post:
      operationId: CreateModelCardExportJob
      summary: Create Model Card Export Job
      description: Creates an Amazon SageMaker Model Card export job.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/CreateModelCardExportJobResponse'
        '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.CreateModelCardExportJob
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/CreateModelCardExportJobRequest'
      tags:
      - Model Card Export Job
  /#DescribeModelCardExportJob:
    post:
      operationId: DescribeModelCardExportJob
      summary: Describe Model Card Export Job
      description: Describes an Amazon SageMaker Model Card export job.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DescribeModelCardExportJobResponse'
        '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.DescribeModelCardExportJob
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DescribeModelCardExportJobRequest'
      tags:
      - Model Card Export Job
  /#ListModelCardExportJobs:
    post:
      operationId: ListModelCardExportJobs
      summary: List Model Card Export Jobs
      description: List the export jobs for the Amazon SageMaker Model Card.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ListModelCardExportJobsResponse'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - SageMaker.ListModelCardExportJobs
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/ListModelCardExportJobsRequest'
      tags:
      - Model Card Export Job
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
    CreateModelCardExportJobRequest:
      type: object
      properties:
        ModelCardName:
          type: string
          description: The name or Amazon Resource Name (ARN) of the model card to export.
        ModelCardVersion:
          type: integer
          description: The version of the model card to export. If a version is not provided, then the latest version of the
            model card is exported.
        ModelCardExportJobName:
          type: string
          description: The name of the model card export job.
        OutputConfig:
          $ref: '#/components/schemas/ModelCardExportOutputConfig'
      required:
      - ModelCardName
      - ModelCardExportJobName
      - OutputConfig
    CreateModelCardExportJobResponse:
      type: object
      properties:
        ModelCardExportJobArn:
          type: string
          description: The Amazon Resource Name (ARN) of the model card export job.
      required:
      - ModelCardExportJobArn
    DescribeModelCardExportJobRequest:
      type: object
      properties:
        ModelCardExportJobArn:
          type: string
          description: The Amazon Resource Name (ARN) of the model card export job to describe.
      required:
      - ModelCardExportJobArn
    DescribeModelCardExportJobResponse:
      type: object
      properties:
        ModelCardExportJobName:
          type: string
          description: The name of the model card export job to describe.
        ModelCardExportJobArn:
          type: string
          description: The Amazon Resource Name (ARN) of the model card export job.
        Status:
          type: string
          enum:
          - InProgress
          - Completed
          - Failed
          description: 'The completion status of the model card export job. InProgress: The model card export job is in progress.
            Completed: The model card export job is complete. Failed: The model card export job failed. To see the reason
            for the failure, see the FailureReason field in the response to a DescribeModelCardExportJob call.'
        ModelCardName:
          type: string
          description: The name or Amazon Resource Name (ARN) of the model card that the model export job exports.
        ModelCardVersion:
          type: integer
          description: The version of the model card that the model export job exports.
        OutputConfig:
          $ref: '#/components/schemas/ModelCardExportOutputConfig'
        CreatedAt:
          type: string
          format: date-time
          description: The date and time that the model export job was created.
        LastModifiedAt:
          type: string
          format: date-time
          description: The date and time that the model export job was last modified.
        FailureReason:
          type: string
          description: The failure reason if the model export job fails.
        ExportArtifacts:
          $ref: '#/components/schemas/ModelCardExportArtifacts'
      required:
      - ModelCardExportJobName
      - ModelCardExportJobArn
      - Status
      - ModelCardName
      - ModelCardVersion
      - OutputConfig
      - CreatedAt
      - LastModifiedAt
    ListModelCardExportJobsRequest:
      type: object
      properties:
        ModelCardName:
          type: string
          description: List export jobs for the model card with the specified name.
        ModelCardVersion:
          type: integer
          description: List export jobs for the model card with the specified version.
        CreationTimeAfter:
          type: string
          format: date-time
          description: Only list model card export jobs that were created after the time specified.
        CreationTimeBefore:
          type: string
          format: date-time
          description: Only list model card export jobs that were created before the time specified.
        ModelCardExportJobNameContains:
          type: string
          description: Only list model card export jobs with names that contain the specified string.
        StatusEquals:
          type: string
          enum:
          - InProgress
          - Completed
          - Failed
          description: Only list model card export jobs with the specified status.
        SortBy:
          type: string
          enum:
          - Name
          - CreationTime
          - Status
          description: Sort model card export jobs by either name or creation time. Sorts by creation time by default.
        SortOrder:
          type: string
          enum:
          - Ascending
          - Descending
          description: Sort model card export jobs by ascending or descending order.
        NextToken:
          type: string
          description: If the response to a previous ListModelCardExportJobs request was truncated, the response includes
            a NextToken. To retrieve the next set of model card export jobs, use the token in the next request.
        MaxResults:
          type: integer
          description: The maximum number of model card export jobs to list.
      required:
      - ModelCardName
    ListModelCardExportJobsResponse:
      type: object
      properties:
        ModelCardExportJobSummaries:
          type: array
          items:
            $ref: '#/components/schemas/ModelCardExportJobSummary'
          description: The summaries of the listed model card export jobs.
        NextToken:
          type: string
          description: If the response is truncated, SageMaker returns this token. To retrieve the next set of model card
            export jobs, use it in the subsequent request.
      required:
      - ModelCardExportJobSummaries
    ModelCardExportArtifacts:
      type: object
      properties:
        S3ExportArtifacts:
          type: string
          description: The Amazon S3 URI of the exported model artifacts.
      required:
      - S3ExportArtifacts
    ModelCardExportJobSummary:
      type: object
      properties:
        ModelCardExportJobName:
          type: string
          description: The name of the model card export job.
        ModelCardExportJobArn:
          type: string
          description: The Amazon Resource Name (ARN) of the model card export job.
        Status:
          type: string
          enum:
          - InProgress
          - Completed
          - Failed
          description: The completion status of the model card export job.
        ModelCardName:
          type: string
          description: The name of the model card that the export job exports.
        ModelCardVersion:
          type: integer
          description: The version of the model card that the export job exports.
        CreatedAt:
          type: string
          format: date-time
          description: The date and time that the model card export job was created.
        LastModifiedAt:
          type: string
          format: date-time
          description: The date and time that the model card export job was last modified..
      required:
      - ModelCardExportJobName
      - ModelCardExportJobArn
      - Status
      - ModelCardName
      - ModelCardVersion
      - CreatedAt
      - LastModifiedAt
    ModelCardExportOutputConfig:
      type: object
      properties:
        S3OutputPath:
          type: string
          description: The Amazon S3 output path to export your model card PDF.
      required:
      - S3OutputPath
    ResourceNotFound:
      type: object
      properties:
        Message:
          type: string
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)