openapi-directory/api/amazonaws.com/sagemaker-edge.json

Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS

{"openapi":"3.0.0","info":{"version":"2020-09-23","x-release":"v4","title":"Amazon Sagemaker Edge Manager","description":"SageMaker Edge Manager dataplane service for communicating with active agents.","x-logo":{"url":"https://twitter.com/awscloud/profile_image?size=original","backgroundColor":"#FFFFFF"},"termsOfService":"https://aws.amazon.com/service-terms/","contact":{"name":"Mike Ralphson","email":"mike.ralphson@gmail.com","url":"https://github.com/mermade/aws2openapi","x-twitter":"PermittedSoc"},"license":{"name":"Apache 2.0 License","url":"http://www.apache.org/licenses/"},"x-providerName":"amazonaws.com","x-serviceName":"sagemaker-edge","x-aws-signingName":"sagemaker","x-origin":[{"contentType":"application/json","url":"https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/sagemaker-edge-2020-09-23.normal.json","converter":{"url":"https://github.com/mermade/aws2openapi","version":"1.0.0"},"x-apisguru-driver":"external"}],"x-apiClientRegistration":{"url":"https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct"},"x-apisguru-categories":["cloud"],"x-preferred":true},"externalDocs":{"description":"Amazon Web Services documentation","url":"https://docs.aws.amazon.com/sagemaker/"},"servers":[{"url":"http://edge.sagemaker.{region}.amazonaws.com","variables":{"region":{"description":"The AWS region","enum":["us-east-1","us-east-2","us-west-1","us-west-2","us-gov-west-1","us-gov-east-1","ca-central-1","eu-north-1","eu-west-1","eu-west-2","eu-west-3","eu-central-1","eu-south-1","af-south-1","ap-northeast-1","ap-northeast-2","ap-northeast-3","ap-southeast-1","ap-southeast-2","ap-east-1","ap-south-1","sa-east-1","me-south-1"],"default":"us-east-1"}},"description":"The Amazon Sagemaker Edge Manager multi-region endpoint"},{"url":"https://edge.sagemaker.{region}.amazonaws.com","variables":{"region":{"description":"The AWS region","enum":["us-east-1","us-east-2","us-west-1","us-west-2","us-gov-west-1","us-gov-east-1","ca-central-1","eu-north-1","eu-west-1","eu-west-2","eu-west-3","eu-central-1","eu-south-1","af-south-1","ap-northeast-1","ap-northeast-2","ap-northeast-3","ap-southeast-1","ap-southeast-2","ap-east-1","ap-south-1","sa-east-1","me-south-1"],"default":"us-east-1"}},"description":"The Amazon Sagemaker Edge Manager multi-region endpoint"},{"url":"http://edge.sagemaker.{region}.amazonaws.com.cn","variables":{"region":{"description":"The AWS region","enum":["cn-north-1","cn-northwest-1"],"default":"cn-north-1"}},"description":"The Amazon Sagemaker Edge Manager endpoint for China (Beijing) and China (Ningxia)"},{"url":"https://edge.sagemaker.{region}.amazonaws.com.cn","variables":{"region":{"description":"The AWS region","enum":["cn-north-1","cn-northwest-1"],"default":"cn-north-1"}},"description":"The Amazon Sagemaker Edge Manager endpoint for China (Beijing) and China (Ningxia)"}],"paths":{"/GetDeployments":{"post":{"operationId":"GetDeployments","description":"Use to get the active deployments from a device.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetDeploymentsResult"}}}},"480":{"description":"InternalServiceException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServiceException"}}}}},"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["DeviceName","DeviceFleetName"],"properties":{"DeviceName":{"description":"The unique name of the device you want to get the configuration of active deployments from.","type":"string","pattern":"^[a-zA-Z0-9](-*_*[a-zA-Z0-9])*$","minLength":1,"maxLength":63},"DeviceFleetName":{"description":"The name of the fleet that the device belongs to.","type":"string","pattern":"^[a-zA-Z0-9](-*_*[a-zA-Z0-9])*$","minLength":1,"maxLength":63}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/GetDeviceRegistration":{"post":{"operationId":"GetDeviceRegistration","description":"Use to check if a device is registered with SageMaker Edge Manager.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetDeviceRegistrationResult"}}}},"480":{"description":"InternalServiceException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServiceException"}}}}},"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["DeviceName","DeviceFleetName"],"properties":{"DeviceName":{"description":"The unique name of the device you want to get the registration status from.","type":"string","pattern":"^[a-zA-Z0-9](-*_*[a-zA-Z0-9])*$","minLength":1,"maxLength":63},"DeviceFleetName":{"description":"The name of the fleet that the device belongs to.","type":"string","pattern":"^[a-zA-Z0-9](-*_*[a-zA-Z0-9])*$","minLength":1,"maxLength":63}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/SendHeartbeat":{"post":{"operationId":"SendHeartbeat","description":"Use to get the current status of devices registered on SageMaker Edge Manager.","responses":{"200":{"description":"Success"},"480":{"description":"InternalServiceException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServiceException"}}}}},"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AgentVersion","DeviceName","DeviceFleetName"],"properties":{"AgentMetrics":{"description":"For internal use. Returns a list of SageMaker Edge Manager agent operating metrics.","type":"array","items":{"$ref":"#/components/schemas/EdgeMetric"}},"Models":{"description":"Returns a list of models deployed on the the device.","type":"array","items":{"$ref":"#/components/schemas/Model"}},"AgentVersion":{"description":"Returns the version of the agent.","type":"string","pattern":"[a-zA-Z0-9\\ \\_\\.]+","minLength":1,"maxLength":64},"DeviceName":{"description":"The unique name of the device.","type":"string","pattern":"^[a-zA-Z0-9](-*_*[a-zA-Z0-9])*$","minLength":1,"maxLength":63},"DeviceFleetName":{"description":"The name of the fleet that the device belongs to.","type":"string","pattern":"^[a-zA-Z0-9](-*_*[a-zA-Z0-9])*$","minLength":1,"maxLength":63},"DeploymentResult":{"description":"Information about the result of a deployment on an edge device that is registered with SageMaker Edge Manager.","type":"object","properties":{"DeploymentName":{"allOf":[{"$ref":"#/components/schemas/EntityName"},{"description":"The name and unique ID of the deployment."}]},"DeploymentStatus":{"allOf":[{"$ref":"#/components/schemas/EntityName"},{"description":"Returns the bucket error code."}]},"DeploymentStatusMessage":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"Returns the detailed error message."}]},"DeploymentStartTime":{"allOf":[{"$ref":"#/components/schemas/Timestamp"},{"description":"The timestamp of when the deployment was started on the agent."}]},"DeploymentEndTime":{"allOf":[{"$ref":"#/components/schemas/Timestamp"},{"description":"The timestamp of when the deployment was ended, and the agent got the deployment results."}]},"DeploymentModels":{"allOf":[{"$ref":"#/components/schemas/DeploymentModels"},{"description":"Returns a list of models deployed on the agent."}]}}}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]}},"components":{"parameters":{"X-Amz-Content-Sha256":{"name":"X-Amz-Content-Sha256","in":"header","schema":{"type":"string"},"required":false},"X-Amz-Date":{"name":"X-Amz-Date","in":"header","schema":{"type":"string"},"required":false},"X-Amz-Algorithm":{"name":"X-Amz-Algorithm","in":"header","schema":{"type":"string"},"required":false},"X-Amz-Credential":{"name":"X-Amz-Credential","in":"header","schema":{"type":"string"},"required":false},"X-Amz-Security-Token":{"name":"X-Amz-Security-Token","in":"header","schema":{"type":"string"},"required":false},"X-Amz-Signature":{"name":"X-Amz-Signature","in":"header","schema":{"type":"string"},"required":false},"X-Amz-SignedHeaders":{"name":"X-Amz-SignedHeaders","in":"header","schema":{"type":"string"},"required":false}},"securitySchemes":{"hmac":{"type":"apiKey","name":"Authorization","in":"header","description":"Amazon Signature authorization v4","x-amazon-apigateway-authtype":"awsSigv4"}},"schemas":{"GetDeploymentsResult":{"type":"object","properties":{"Deployments":{"allOf":[{"$ref":"#/components/schemas/EdgeDeployments"},{"description":"Returns a list of the configurations of the active deployments on the device."}]}}},"InternalServiceException":{},"GetDeviceRegistrationResult":{"type":"object","properties":{"DeviceRegistration":{"allOf":[{"$ref":"#/components/schemas/DeviceRegistration"},{"description":"Describes if the device is currently registered with SageMaker Edge Manager."}]},"CacheTTL":{"allOf":[{"$ref":"#/components/schemas/CacheTTLSeconds"},{"description":"The amount of time, in seconds, that the registration status is stored on the device’s cache before it is refreshed."}]}}},"EdgeMetric":{"type":"object","properties":{"Dimension":{"allOf":[{"$ref":"#/components/schemas/Dimension"},{"description":"The dimension of metrics published."}]},"MetricName":{"allOf":[{"$ref":"#/components/schemas/Metric"},{"description":"Returns the name of the metric."}]},"Value":{"allOf":[{"$ref":"#/components/schemas/Value"},{"description":"Returns the value of the metric."}]},"Timestamp":{"allOf":[{"$ref":"#/components/schemas/Timestamp"},{"description":"Timestamp of when the metric was requested."}]}},"description":"Information required for edge device metrics."},"Model":{"type":"object","properties":{"ModelName":{"allOf":[{"$ref":"#/components/schemas/ModelName"},{"description":"The name of the model."}]},"ModelVersion":{"allOf":[{"$ref":"#/components/schemas/Version"},{"description":"The version of the model."}]},"LatestSampleTime":{"allOf":[{"$ref":"#/components/schemas/Timestamp"},{"description":"The timestamp of the last data sample taken."}]},"LatestInference":{"allOf":[{"$ref":"#/components/schemas/Timestamp"},{"description":"The timestamp of the last inference that was made."}]},"ModelMetrics":{"allOf":[{"$ref":"#/components/schemas/EdgeMetrics"},{"description":"Information required for model metrics."}]}},"description":"Information about a model deployed on an edge device that is registered with SageMaker Edge Manager."},"EntityName":{"type":"string","pattern":"^[a-zA-Z0-9](-*[a-zA-Z0-9])*$","minLength":1,"maxLength":63},"String":{"type":"string"},"Timestamp":{"type":"string","format":"date-time"},"DeploymentModels":{"type":"array","items":{"$ref":"#/components/schemas/DeploymentModel"}},"CacheTTLSeconds":{"type":"string","minLength":1,"maxLength":1000},"ChecksumType":{"type":"string","enum":["SHA1"]},"ChecksumString":{"type":"string","pattern":"^[a-z0-9](-*[a-z0-9])*$","minLength":1,"maxLength":63},"Checksum":{"type":"object","properties":{"Type":{"allOf":[{"$ref":"#/components/schemas/ChecksumType"},{"description":"The type of the checksum."}]},"Sum":{"allOf":[{"$ref":"#/components/schemas/ChecksumString"},{"description":"The checksum of the model."}]}},"description":"Information about the checksum of a model deployed on a device."},"S3Uri":{"type":"string","pattern":"^s3://([^/]+)/?(.*)$","maxLength":1024},"ModelState":{"type":"string","enum":["DEPLOY","UNDEPLOY"]},"Definition":{"type":"object","properties":{"ModelHandle":{"allOf":[{"$ref":"#/components/schemas/EntityName"},{"description":"The unique model handle."}]},"S3Url":{"allOf":[{"$ref":"#/components/schemas/S3Uri"},{"description":"The absolute S3 location of the model."}]},"Checksum":{"allOf":[{"$ref":"#/components/schemas/Checksum"},{"description":"The checksum information of the model."}]},"State":{"allOf":[{"$ref":"#/components/schemas/ModelState"},{"description":"The desired state of the model."}]}},"description":"<p/>"},"Definitions":{"type":"array","items":{"$ref":"#/components/schemas/Definition"}},"ModelName":{"type":"string","pattern":"^[a-zA-Z0-9](-*[a-zA-Z0-9])*$","minLength":4,"maxLength":255},"Version":{"type":"string","pattern":"[a-zA-Z0-9\\ \\_\\.]+","minLength":1,"maxLength":64},"DeploymentStatus":{"type":"string","enum":["SUCCESS","FAIL"]},"DeploymentModel":{"type":"object","properties":{"ModelHandle":{"allOf":[{"$ref":"#/components/schemas/EntityName"},{"description":"The unique handle of the model."}]},"ModelName":{"allOf":[{"$ref":"#/components/schemas/ModelName"},{"description":"The name of the model."}]},"ModelVersion":{"allOf":[{"$ref":"#/components/schemas/Version"},{"description":"The version of the model."}]},"DesiredState":{"allOf":[{"$ref":"#/components/schemas/ModelState"},{"description":"The desired state of the model."}]},"State":{"allOf":[{"$ref":"#/components/schemas/ModelState"},{"description":"Returns the current state of the model."}]},"Status":{"allOf":[{"$ref":"#/components/schemas/DeploymentStatus"},{"description":"Returns the deployment status of the model."}]},"StatusReason":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"Returns the error message for the deployment status result."}]},"RollbackFailureReason":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"Returns the error message if there is a rollback."}]}},"description":"<p/>"},"DeploymentResult":{"type":"object","properties":{"DeploymentName":{"allOf":[{"$ref":"#/components/schemas/EntityName"},{"description":"The name and unique ID of the deployment."}]},"DeploymentStatus":{"allOf":[{"$ref":"#/components/schemas/EntityName"},{"description":"Returns the bucket error code."}]},"DeploymentStatusMessage":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"Returns the detailed error message."}]},"DeploymentStartTime":{"allOf":[{"$ref":"#/components/schemas/Timestamp"},{"description":"The timestamp of when the deployment was started on the agent."}]},"DeploymentEndTime":{"allOf":[{"$ref":"#/components/schemas/Timestamp"},{"description":"The timestamp of when the deployment was ended, and the agent got the deployment results."}]},"DeploymentModels":{"allOf":[{"$ref":"#/components/schemas/DeploymentModels"},{"description":"Returns a list of models deployed on the agent."}]}},"description":"Information about the result of a deployment on an edge device that is registered with SageMaker Edge Manager."},"DeploymentType":{"type":"string","enum":["Model"]},"DeviceFleetName":{"type":"string","pattern":"^[a-zA-Z0-9](-*_*[a-zA-Z0-9])*$","minLength":1,"maxLength":63},"DeviceName":{"type":"string","pattern":"^[a-zA-Z0-9](-*_*[a-zA-Z0-9])*$","minLength":1,"maxLength":63},"DeviceRegistration":{"type":"string","minLength":1,"maxLength":1000},"Dimension":{"type":"string","pattern":"^[a-zA-Z0-9](-*[a-zA-Z0-9\\/])*$","minLength":1,"maxLength":1000},"FailureHandlingPolicy":{"type":"string","enum":["ROLLBACK_ON_FAILURE","DO_NOTHING"]},"EdgeDeployment":{"type":"object","properties":{"DeploymentName":{"allOf":[{"$ref":"#/components/schemas/EntityName"},{"description":"The name and unique ID of the deployment."}]},"Type":{"allOf":[{"$ref":"#/components/schemas/DeploymentType"},{"description":"The type of the deployment."}]},"FailureHandlingPolicy":{"allOf":[{"$ref":"#/components/schemas/FailureHandlingPolicy"},{"description":"Determines whether to rollback to previous configuration if deployment fails."}]},"Definitions":{"allOf":[{"$ref":"#/components/schemas/Definitions"},{"description":"Returns a list of Definition objects."}]}},"description":"Information about a deployment on an edge device that is registered with SageMaker Edge Manager."},"EdgeDeployments":{"type":"array","items":{"$ref":"#/components/schemas/EdgeDeployment"}},"Metric":{"type":"string","pattern":"^[a-zA-Z0-9](-*[a-zA-Z0-9])*$","minLength":4,"maxLength":100},"Value":{"type":"number","format":"double"},"EdgeMetrics":{"type":"array","items":{"$ref":"#/components/schemas/EdgeMetric"}},"GetDeploymentsRequest":{"type":"object","required":["DeviceName","DeviceFleetName"],"title":"GetDeploymentsRequest","properties":{"DeviceName":{"allOf":[{"$ref":"#/components/schemas/DeviceName"},{"description":"The unique name of the device you want to get the configuration of active deployments from."}]},"DeviceFleetName":{"allOf":[{"$ref":"#/components/schemas/DeviceFleetName"},{"description":"The name of the fleet that the device belongs to."}]}}},"GetDeviceRegistrationRequest":{"type":"object","required":["DeviceName","DeviceFleetName"],"title":"GetDeviceRegistrationRequest","properties":{"DeviceName":{"allOf":[{"$ref":"#/components/schemas/DeviceName"},{"description":"The unique name of the device you want to get the registration status from."}]},"DeviceFleetName":{"allOf":[{"$ref":"#/components/schemas/DeviceFleetName"},{"description":"The name of the fleet that the device belongs to."}]}}},"Models":{"type":"array","items":{"$ref":"#/components/schemas/Model"}},"SendHeartbeatRequest":{"type":"object","required":["AgentVersion","DeviceName","DeviceFleetName"],"title":"SendHeartbeatRequest","properties":{"AgentMetrics":{"allOf":[{"$ref":"#/components/schemas/EdgeMetrics"},{"description":"For internal use. Returns a list of SageMaker Edge Manager agent operating metrics."}]},"Models":{"allOf":[{"$ref":"#/components/schemas/Models"},{"description":"Returns a list of models deployed on the the device."}]},"AgentVersion":{"allOf":[{"$ref":"#/components/schemas/Version"},{"description":"Returns the version of the agent."}]},"DeviceName":{"allOf":[{"$ref":"#/components/schemas/DeviceName"},{"description":"The unique name of the device."}]},"DeviceFleetName":{"allOf":[{"$ref":"#/components/schemas/DeviceFleetName"},{"description":"The name of the fleet that the device belongs to."}]},"DeploymentResult":{"allOf":[{"$ref":"#/components/schemas/DeploymentResult"},{"description":"Returns the result of a deployment on the device."}]}}}}},"security":[{"hmac":[]}]}