Amazon SageMaker Sagemaker Edge Deployment Plan API

openapi: 3.1.0
info:
  title: Amazon SageMaker Service Edge Deployment Plan 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:
  /#CreateEdgeDeploymentPlan:
    post:
      operationId: CreateEdgeDeploymentPlan
      summary: Create Edge Deployment Plan
      description: Creates an edge deployment plan, consisting of multiple stages. Each stage may have a different deployment
        configuration and devices.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/CreateEdgeDeploymentPlanResponse'
        '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.CreateEdgeDeploymentPlan
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/CreateEdgeDeploymentPlanRequest'
      tags:
      - Edge Deployment Plan
  /#DeleteEdgeDeploymentPlan:
    post:
      operationId: DeleteEdgeDeploymentPlan
      summary: Delete Edge Deployment Plan
      description: Deletes an edge deployment plan if (and only if) all the stages in the plan are inactive or there are no
        stages in the plan.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                type: string
        '400':
          description: ResourceInUse
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ResourceInUse'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - SageMaker.DeleteEdgeDeploymentPlan
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DeleteEdgeDeploymentPlanRequest'
      tags:
      - Edge Deployment Plan
  /#DescribeEdgeDeploymentPlan:
    post:
      operationId: DescribeEdgeDeploymentPlan
      summary: Describe Edge Deployment Plan
      description: Describes an edge deployment plan with deployment status per stage.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DescribeEdgeDeploymentPlanResponse'
        '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.DescribeEdgeDeploymentPlan
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DescribeEdgeDeploymentPlanRequest'
      tags:
      - Edge Deployment Plan
  /#ListEdgeDeploymentPlans:
    post:
      operationId: ListEdgeDeploymentPlans
      summary: List Edge Deployment Plans
      description: Lists all edge deployment plans.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ListEdgeDeploymentPlansResponse'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - SageMaker.ListEdgeDeploymentPlans
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/ListEdgeDeploymentPlansRequest'
      tags:
      - Edge Deployment Plan
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:
    CreateEdgeDeploymentPlanRequest:
      type: object
      properties:
        EdgeDeploymentPlanName:
          type: string
          description: The name of the edge deployment plan.
        ModelConfigs:
          type: array
          items:
            $ref: '#/components/schemas/EdgeDeploymentModelConfig'
          description: List of models associated with the edge deployment plan.
        DeviceFleetName:
          type: string
          description: The device fleet used for this edge deployment plan.
        Stages:
          type: array
          items:
            $ref: '#/components/schemas/DeploymentStage'
          description: List of stages of the edge deployment plan. The number of stages is limited to 10 per deployment.
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: List of tags with which to tag the edge deployment plan.
      required:
      - EdgeDeploymentPlanName
      - ModelConfigs
      - DeviceFleetName
    CreateEdgeDeploymentPlanResponse:
      type: object
      properties:
        EdgeDeploymentPlanArn:
          type: string
          description: The ARN of the edge deployment plan.
      required:
      - EdgeDeploymentPlanArn
    DeleteEdgeDeploymentPlanRequest:
      type: object
      properties:
        EdgeDeploymentPlanName:
          type: string
          description: The name of the edge deployment plan to delete.
      required:
      - EdgeDeploymentPlanName
    DeploymentStage:
      type: object
      properties:
        StageName:
          type: string
          description: The name of the stage.
        DeviceSelectionConfig:
          $ref: '#/components/schemas/DeviceSelectionConfig'
        DeploymentConfig:
          $ref: '#/components/schemas/EdgeDeploymentConfig'
      required:
      - StageName
      - DeviceSelectionConfig
    DeploymentStageStatusSummary:
      type: object
      properties:
        StageName:
          type: string
          description: The name of the stage.
        DeviceSelectionConfig:
          $ref: '#/components/schemas/DeviceSelectionConfig'
        DeploymentConfig:
          $ref: '#/components/schemas/EdgeDeploymentConfig'
        DeploymentStatus:
          $ref: '#/components/schemas/EdgeDeploymentStatus'
      required:
      - StageName
      - DeviceSelectionConfig
      - DeploymentConfig
      - DeploymentStatus
    DescribeEdgeDeploymentPlanRequest:
      type: object
      properties:
        EdgeDeploymentPlanName:
          type: string
          description: The name of the deployment plan to describe.
        NextToken:
          type: string
          description: If the edge deployment plan has enough stages to require tokening, then this is the response from the
            last list of stages returned.
        MaxResults:
          type: integer
          description: The maximum number of results to select (50 by default).
      required:
      - EdgeDeploymentPlanName
    DescribeEdgeDeploymentPlanResponse:
      type: object
      properties:
        EdgeDeploymentPlanArn:
          type: string
          description: The ARN of edge deployment plan.
        EdgeDeploymentPlanName:
          type: string
          description: The name of the edge deployment plan.
        ModelConfigs:
          type: array
          items:
            $ref: '#/components/schemas/EdgeDeploymentModelConfig'
          description: List of models associated with the edge deployment plan.
        DeviceFleetName:
          type: string
          description: The device fleet used for this edge deployment plan.
        EdgeDeploymentSuccess:
          type: integer
          description: The number of edge devices with the successful deployment.
        EdgeDeploymentPending:
          type: integer
          description: The number of edge devices yet to pick up deployment, or in progress.
        EdgeDeploymentFailed:
          type: integer
          description: The number of edge devices that failed the deployment.
        Stages:
          type: array
          items:
            $ref: '#/components/schemas/DeploymentStageStatusSummary'
          description: List of stages in the edge deployment plan.
        NextToken:
          type: string
          description: Token to use when calling the next set of stages in the edge deployment plan.
        CreationTime:
          type: string
          format: date-time
          description: The time when the edge deployment plan was created.
        LastModifiedTime:
          type: string
          format: date-time
          description: The time when the edge deployment plan was last updated.
      required:
      - EdgeDeploymentPlanArn
      - EdgeDeploymentPlanName
      - ModelConfigs
      - DeviceFleetName
      - Stages
    DeviceSelectionConfig:
      type: object
      properties:
        DeviceSubsetType:
          type: string
          enum:
          - PERCENTAGE
          - SELECTION
          - NAMECONTAINS
          description: Type of device subsets to deploy to the current stage.
        Percentage:
          type: integer
          description: Percentage of devices in the fleet to deploy to the current stage.
        DeviceNames:
          type: array
          items:
            type: string
          description: List of devices chosen to deploy.
        DeviceNameContains:
          type: string
          description: A filter to select devices with names containing this name.
      required:
      - DeviceSubsetType
    EdgeDeploymentConfig:
      type: object
      properties:
        FailureHandlingPolicy:
          type: string
          enum:
          - ROLLBACK_ON_FAILURE
          - DO_NOTHING
          description: Toggle that determines whether to rollback to previous configuration if the current deployment fails.
            By default this is turned on. You may turn this off if you want to investigate the errors yourself.
      required:
      - FailureHandlingPolicy
    EdgeDeploymentModelConfig:
      type: object
      properties:
        ModelHandle:
          type: string
          description: The name the device application uses to reference this model.
        EdgePackagingJobName:
          type: string
          description: The edge packaging job associated with this deployment.
      required:
      - ModelHandle
      - EdgePackagingJobName
    EdgeDeploymentPlanSummary:
      type: object
      properties:
        EdgeDeploymentPlanArn:
          type: string
          description: The ARN of the edge deployment plan.
        EdgeDeploymentPlanName:
          type: string
          description: The name of the edge deployment plan.
        DeviceFleetName:
          type: string
          description: The name of the device fleet used for the deployment.
        EdgeDeploymentSuccess:
          type: integer
          description: The number of edge devices with the successful deployment.
        EdgeDeploymentPending:
          type: integer
          description: The number of edge devices yet to pick up the deployment, or in progress.
        EdgeDeploymentFailed:
          type: integer
          description: The number of edge devices that failed the deployment.
        CreationTime:
          type: string
          format: date-time
          description: The time when the edge deployment plan was created.
        LastModifiedTime:
          type: string
          format: date-time
          description: The time when the edge deployment plan was last updated.
      required:
      - EdgeDeploymentPlanArn
      - EdgeDeploymentPlanName
      - DeviceFleetName
      - EdgeDeploymentSuccess
      - EdgeDeploymentPending
      - EdgeDeploymentFailed
    EdgeDeploymentStatus:
      type: object
      properties:
        StageStatus:
          type: string
          enum:
          - CREATING
          - READYTODEPLOY
          - STARTING
          - INPROGRESS
          - DEPLOYED
          - FAILED
          - STOPPING
          - STOPPED
          description: The general status of the current stage.
        EdgeDeploymentSuccessInStage:
          type: integer
          description: The number of edge devices with the successful deployment in the current stage.
        EdgeDeploymentPendingInStage:
          type: integer
          description: The number of edge devices yet to pick up the deployment in current stage, or in progress.
        EdgeDeploymentFailedInStage:
          type: integer
          description: The number of edge devices that failed the deployment in current stage.
        EdgeDeploymentStatusMessage:
          type: string
          description: A detailed message about deployment status in current stage.
        EdgeDeploymentStageStartTime:
          type: string
          format: date-time
          description: The time when the deployment API started.
      required:
      - StageStatus
      - EdgeDeploymentSuccessInStage
      - EdgeDeploymentPendingInStage
      - EdgeDeploymentFailedInStage
    ListEdgeDeploymentPlansRequest:
      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: The maximum number of results to select (50 by default).
        CreationTimeAfter:
          type: string
          format: date-time
          description: Selects edge deployment plans created after this time.
        CreationTimeBefore:
          type: string
          format: date-time
          description: Selects edge deployment plans created before this time.
        LastModifiedTimeAfter:
          type: string
          format: date-time
          description: Selects edge deployment plans that were last updated after this time.
        LastModifiedTimeBefore:
          type: string
          format: date-time
          description: Selects edge deployment plans that were last updated before this time.
        NameContains:
          type: string
          description: Selects edge deployment plans with names containing this name.
        DeviceFleetNameContains:
          type: string
          description: Selects edge deployment plans with a device fleet name containing this name.
        SortBy:
          type: string
          enum:
          - NAME
          - DEVICE_FLEET_NAME
          - CREATION_TIME
          - LAST_MODIFIED_TIME
          description: The column by which to sort the edge deployment plans. Can be one of NAME, DEVICEFLEETNAME, CREATIONTIME,
            LASTMODIFIEDTIME.
        SortOrder:
          type: string
          enum:
          - Ascending
          - Descending
          description: The direction of the sorting (ascending or descending).
    ListEdgeDeploymentPlansResponse:
      type: object
      properties:
        EdgeDeploymentPlanSummaries:
          type: array
          items:
            $ref: '#/components/schemas/EdgeDeploymentPlanSummary'
          description: List of summaries of edge deployment plans.
        NextToken:
          type: string
          description: The token to use when calling the next page of results.
      required:
      - EdgeDeploymentPlanSummaries
    ResourceInUse:
      type: object
      properties:
        Message:
          type: string
    ResourceLimitExceeded:
      type: object
      properties:
        Message:
          type: string
    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
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)