Amazon SageMaker Sagemaker Edge Packaging Job API

openapi: 3.1.0
info:
  title: Amazon SageMaker Service Edge Packaging Job 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:
  /#CreateEdgePackagingJob:
    post:
      operationId: CreateEdgePackagingJob
      summary: Create Edge Packaging Job
      description: Starts a SageMaker Edge Manager model packaging job. Edge Manager will use the model artifacts from the
        Amazon Simple Storage Service bucket that you specify. After the model has been packaged, Amazon SageMaker saves the
        resulting artifacts to an S3 bucket that you specify.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                type: string
        '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.CreateEdgePackagingJob
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/CreateEdgePackagingJobRequest'
      tags:
      - Edge Packaging Job
  /#DescribeEdgePackagingJob:
    post:
      operationId: DescribeEdgePackagingJob
      summary: Describe Edge Packaging Job
      description: A description of edge packaging jobs.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DescribeEdgePackagingJobResponse'
        '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.DescribeEdgePackagingJob
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DescribeEdgePackagingJobRequest'
      tags:
      - Edge Packaging Job
  /#ListEdgePackagingJobs:
    post:
      operationId: ListEdgePackagingJobs
      summary: List Edge Packaging Jobs
      description: Returns a list of edge packaging jobs.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ListEdgePackagingJobsResponse'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - SageMaker.ListEdgePackagingJobs
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/ListEdgePackagingJobsRequest'
      tags:
      - Edge Packaging Job
  /#StopEdgePackagingJob:
    post:
      operationId: StopEdgePackagingJob
      summary: Stop Edge Packaging Job
      description: Request to stop an edge packaging job.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                type: string
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - SageMaker.StopEdgePackagingJob
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/StopEdgePackagingJobRequest'
      tags:
      - Edge Packaging 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:
    CreateEdgePackagingJobRequest:
      type: object
      properties:
        EdgePackagingJobName:
          type: string
          description: The name of the edge packaging job.
        CompilationJobName:
          type: string
          description: The name of the SageMaker Neo compilation job that will be used to locate model artifacts for packaging.
        ModelName:
          type: string
          description: The name of the model.
        ModelVersion:
          type: string
          description: The version of the model.
        RoleArn:
          type: string
          description: The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to download and upload
            the model, and to contact SageMaker Neo.
        OutputConfig:
          $ref: '#/components/schemas/EdgeOutputConfig'
        ResourceKey:
          type: string
          description: The Amazon Web Services KMS key to use when encrypting the EBS volume the edge packaging job runs on.
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: Creates tags for the packaging job.
      required:
      - EdgePackagingJobName
      - CompilationJobName
      - ModelName
      - ModelVersion
      - RoleArn
      - OutputConfig
    DescribeEdgePackagingJobRequest:
      type: object
      properties:
        EdgePackagingJobName:
          type: string
          description: The name of the edge packaging job.
      required:
      - EdgePackagingJobName
    DescribeEdgePackagingJobResponse:
      type: object
      properties:
        EdgePackagingJobArn:
          type: string
          description: The Amazon Resource Name (ARN) of the edge packaging job.
        EdgePackagingJobName:
          type: string
          description: The name of the edge packaging job.
        CompilationJobName:
          type: string
          description: The name of the SageMaker Neo compilation job that is used to locate model artifacts that are being
            packaged.
        ModelName:
          type: string
          description: The name of the model.
        ModelVersion:
          type: string
          description: The version of the model.
        RoleArn:
          type: string
          description: The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to download and upload
            the model, and to contact Neo.
        OutputConfig:
          $ref: '#/components/schemas/EdgeOutputConfig'
        ResourceKey:
          type: string
          description: The Amazon Web Services KMS key to use when encrypting the EBS volume the job run on.
        EdgePackagingJobStatus:
          type: string
          enum:
          - STARTING
          - INPROGRESS
          - COMPLETED
          - FAILED
          - STOPPING
          - STOPPED
          description: The current status of the packaging job.
        EdgePackagingJobStatusMessage:
          type: string
          description: Returns a message describing the job status and error messages.
        CreationTime:
          type: string
          format: date-time
          description: The timestamp of when the packaging job was created.
        LastModifiedTime:
          type: string
          format: date-time
          description: The timestamp of when the job was last updated.
        ModelArtifact:
          type: string
          description: The Amazon Simple Storage (S3) URI where model artifacts ares stored.
        ModelSignature:
          type: string
          description: The signature document of files in the model artifact.
        PresetDeploymentOutput:
          $ref: '#/components/schemas/EdgePresetDeploymentOutput'
      required:
      - EdgePackagingJobArn
      - EdgePackagingJobName
      - EdgePackagingJobStatus
    EdgeOutputConfig:
      type: object
      properties:
        S3OutputLocation:
          type: string
          description: The Amazon Simple Storage (S3) bucker URI.
        KmsKeyId:
          type: string
          description: The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker
            uses to encrypt data on the storage volume after compilation job. If you don't provide a KMS key ID, Amazon SageMaker
            uses the default KMS key for Amazon S3 for your role's account.
        PresetDeploymentType:
          type: string
          enum:
          - GreengrassV2Component
          description: The deployment type SageMaker Edge Manager will create. Currently only supports Amazon Web Services
            IoT Greengrass Version 2 components.
        PresetDeploymentConfig:
          type: string
          description: 'The configuration used to create deployment artifacts. Specify configuration options with a JSON string.
            The available configuration options for each type are: ComponentName (optional) - Name of the GreenGrass V2 component.
            If not specified, the default name generated consists of "SagemakerEdgeManager" and the name of your SageMaker
            Edge Manager packaging job. ComponentDescription (optional) - Description of the component. ComponentVersion (optional)
            - The version of the component. Amazon Web Services IoT Greengrass uses semantic versions for components. Semantic
            versions follow a major.minor.'
      required:
      - S3OutputLocation
    EdgePackagingJobSummary:
      type: object
      properties:
        EdgePackagingJobArn:
          type: string
          description: The Amazon Resource Name (ARN) of the edge packaging job.
        EdgePackagingJobName:
          type: string
          description: The name of the edge packaging job.
        EdgePackagingJobStatus:
          type: string
          enum:
          - STARTING
          - INPROGRESS
          - COMPLETED
          - FAILED
          - STOPPING
          - STOPPED
          description: The status of the edge packaging job.
        CompilationJobName:
          type: string
          description: The name of the SageMaker Neo compilation job.
        ModelName:
          type: string
          description: The name of the model.
        ModelVersion:
          type: string
          description: The version of the model.
        CreationTime:
          type: string
          format: date-time
          description: The timestamp of when the job was created.
        LastModifiedTime:
          type: string
          format: date-time
          description: The timestamp of when the edge packaging job was last updated.
      required:
      - EdgePackagingJobArn
      - EdgePackagingJobName
      - EdgePackagingJobStatus
    EdgePresetDeploymentOutput:
      type: object
      properties:
        Type:
          type: string
          enum:
          - GreengrassV2Component
          description: The deployment type created by SageMaker Edge Manager. Currently only supports Amazon Web Services
            IoT Greengrass Version 2 components.
        Artifact:
          type: string
          description: The Amazon Resource Name (ARN) of the generated deployable resource.
        Status:
          type: string
          enum:
          - COMPLETED
          - FAILED
          description: The status of the deployable resource.
        StatusMessage:
          type: string
          description: Returns a message describing the status of the deployed resource.
      required:
      - Type
    ListEdgePackagingJobsRequest:
      type: object
      properties:
        NextToken:
          type: string
          description: The response from the last list when returning a list large enough to need tokening.
        MaxResults:
          type: integer
          description: Maximum number of results to select.
        CreationTimeAfter:
          type: string
          format: date-time
          description: Select jobs where the job was created after specified time.
        CreationTimeBefore:
          type: string
          format: date-time
          description: Select jobs where the job was created before specified time.
        LastModifiedTimeAfter:
          type: string
          format: date-time
          description: Select jobs where the job was updated after specified time.
        LastModifiedTimeBefore:
          type: string
          format: date-time
          description: Select jobs where the job was updated before specified time.
        NameContains:
          type: string
          description: Filter for jobs containing this name in their packaging job name.
        ModelNameContains:
          type: string
          description: Filter for jobs where the model name contains this string.
        StatusEquals:
          type: string
          enum:
          - STARTING
          - INPROGRESS
          - COMPLETED
          - FAILED
          - STOPPING
          - STOPPED
          description: The job status to filter for.
        SortBy:
          type: string
          enum:
          - NAME
          - MODEL_NAME
          - CREATION_TIME
          - LAST_MODIFIED_TIME
          - STATUS
          description: Use to specify what column to sort by.
        SortOrder:
          type: string
          enum:
          - Ascending
          - Descending
          description: What direction to sort by.
    ListEdgePackagingJobsResponse:
      type: object
      properties:
        EdgePackagingJobSummaries:
          type: array
          items:
            $ref: '#/components/schemas/EdgePackagingJobSummary'
          description: Summaries of edge packaging jobs.
        NextToken:
          type: string
          description: Token to use when calling the next page of results.
      required:
      - EdgePackagingJobSummaries
    ResourceLimitExceeded:
      type: object
      properties:
        Message:
          type: string
    ResourceNotFound:
      type: object
      properties:
        Message:
          type: string
    StopEdgePackagingJobRequest:
      type: object
      properties:
        EdgePackagingJobName:
          type: string
          description: The name of the edge packaging job.
      required:
      - EdgePackagingJobName
    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
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)