{ "smithy": "2.0", "metadata": { "suppressions": [ { "id": "HttpMethodSemantics", "namespace": "*" }, { "id": "HttpResponseCodeSemantics", "namespace": "*" }, { "id": "PaginatedTrait", "namespace": "*" }, { "id": "HttpHeaderTrait", "namespace": "*" }, { "id": "HttpUriConflict", "namespace": "*" }, { "id": "Service", "namespace": "*" } ] }, "shapes": { "com.amazonaws.sagemakeredge#AmazonSageMakerEdge": { "type": "service", "version": "2020-09-23", "operations": [ { "target": "com.amazonaws.sagemakeredge#GetDeployments" }, { "target": "com.amazonaws.sagemakeredge#GetDeviceRegistration" }, { "target": "com.amazonaws.sagemakeredge#SendHeartbeat" } ], "traits": { "aws.api#service": { "sdkId": "Sagemaker Edge", "arnNamespace": "sagemaker", "cloudFormationName": "SagemakerEdge", "cloudTrailEventSource": "sagemakeredge.amazonaws.com", "endpointPrefix": "edge.sagemaker" }, "aws.auth#sigv4": { "name": "sagemaker" }, "aws.protocols#restJson1": {}, "smithy.api#documentation": "
SageMaker Edge Manager dataplane service for communicating with active agents.
", "smithy.api#title": "Amazon Sagemaker Edge Manager", "smithy.rules#endpointBdd": { "version": "1.1", "parameters": { "Region": { "builtIn": "AWS::Region", "required": false, "documentation": "The AWS region used to dispatch the request.", "type": "string" }, "UseDualStack": { "builtIn": "AWS::UseDualStack", "required": true, "default": false, "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", "type": "boolean" }, "UseFIPS": { "builtIn": "AWS::UseFIPS", "required": true, "default": false, "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", "type": "boolean" }, "Endpoint": { "builtIn": "SDK::Endpoint", "required": false, "documentation": "Override the endpoint used to send this request", "type": "string" } }, "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Endpoint" } ] }, { "fn": "isSet", "argv": [ { "ref": "Region" } ] }, { "fn": "aws.partition", "argv": [ { "ref": "Region" } ], "assign": "PartitionResult" }, { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] }, { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] }, true ] }, { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] }, true ] } ], "results": [ { "conditions": [], "error": "Invalid Configuration: FIPS and custom endpoint are not supported", "type": "error" }, { "conditions": [], "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", "type": "error" }, { "conditions": [], "endpoint": { "url": { "ref": "Endpoint" }, "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://edge.sagemaker-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "FIPS and DualStack are enabled, but this partition does not support one or both", "type": "error" }, { "conditions": [], "endpoint": { "url": "https://edge.sagemaker-fips.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "FIPS is enabled but this partition does not support FIPS", "type": "error" }, { "conditions": [], "endpoint": { "url": "https://edge.sagemaker.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "DualStack is enabled but this partition does not support DualStack", "type": "error" }, { "conditions": [], "endpoint": { "url": "https://edge.sagemaker.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "Invalid Configuration: Missing Region", "type": "error" } ], "root": 2, "nodeCount": 13, "nodes": "/////wAAAAH/////AAAAAAAAAAwAAAADAAAAAQAAAAQF9eELAAAAAgAAAAUF9eELAAAAAwAAAAgAAAAGAAAABAAAAAcF9eEKAAAABQX14QgF9eEJAAAABAAAAAoAAAAJAAAABgX14QYF9eEHAAAABQAAAAsF9eEFAAAABgX14QQF9eEFAAAAAwX14QEAAAANAAAABAX14QIF9eED" }, "smithy.rules#endpointRuleSet": { "version": "1.0", "parameters": { "Region": { "builtIn": "AWS::Region", "required": false, "documentation": "The AWS region used to dispatch the request.", "type": "string" }, "UseDualStack": { "builtIn": "AWS::UseDualStack", "required": true, "default": false, "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", "type": "boolean" }, "UseFIPS": { "builtIn": "AWS::UseFIPS", "required": true, "default": false, "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", "type": "boolean" }, "Endpoint": { "builtIn": "SDK::Endpoint", "required": false, "documentation": "Override the endpoint used to send this request", "type": "string" } }, "rules": [ { "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Endpoint" } ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] } ], "error": "Invalid Configuration: FIPS and custom endpoint are not supported", "type": "error" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", "type": "error" }, { "conditions": [], "endpoint": { "url": { "ref": "Endpoint" }, "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Region" } ] } ], "rules": [ { "conditions": [ { "fn": "aws.partition", "argv": [ { "ref": "Region" } ], "assign": "PartitionResult" } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ true, { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] } ] }, { "fn": "booleanEquals", "argv": [ true, { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] } ] } ], "rules": [ { "conditions": [], "endpoint": { "url": "https://edge.sagemaker-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "error": "FIPS and DualStack are enabled, but this partition does not support one or both", "type": "error" } ], "type": "tree" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] }, true ] } ], "rules": [ { "conditions": [], "endpoint": { "url": "https://edge.sagemaker-fips.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "error": "FIPS is enabled but this partition does not support FIPS", "type": "error" } ], "type": "tree" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ true, { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] } ] } ], "rules": [ { "conditions": [], "endpoint": { "url": "https://edge.sagemaker.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "error": "DualStack is enabled but this partition does not support DualStack", "type": "error" } ], "type": "tree" }, { "conditions": [], "endpoint": { "url": "https://edge.sagemaker.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" } ], "type": "tree" }, { "conditions": [], "error": "Invalid Configuration: Missing Region", "type": "error" } ] }, "smithy.rules#endpointTests": { "testCases": [ { "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://edge.sagemaker.ap-northeast-1.amazonaws.com" } }, "params": { "Region": "ap-northeast-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region eu-central-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://edge.sagemaker.eu-central-1.amazonaws.com" } }, "params": { "Region": "eu-central-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region eu-west-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://edge.sagemaker.eu-west-1.amazonaws.com" } }, "params": { "Region": "eu-west-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://edge.sagemaker.us-east-1.amazonaws.com" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-east-2 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://edge.sagemaker.us-east-2.amazonaws.com" } }, "params": { "Region": "us-east-2", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-west-2 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://edge.sagemaker.us-west-2.amazonaws.com" } }, "params": { "Region": "us-west-2", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://edge.sagemaker-fips.us-east-1.api.aws" } }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": true } }, { "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://edge.sagemaker-fips.us-east-1.amazonaws.com" } }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://edge.sagemaker.us-east-1.api.aws" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://edge.sagemaker-fips.cn-north-1.api.amazonwebservices.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": true, "UseDualStack": true } }, { "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://edge.sagemaker-fips.cn-north-1.amazonaws.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://edge.sagemaker.cn-north-1.api.amazonwebservices.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://edge.sagemaker.cn-north-1.amazonaws.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://edge.sagemaker-fips.us-gov-east-1.api.aws" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": true, "UseDualStack": true } }, { "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://edge.sagemaker-fips.us-gov-east-1.amazonaws.com" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://edge.sagemaker.us-gov-east-1.api.aws" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://edge.sagemaker.us-gov-east-1.amazonaws.com" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://edge.sagemaker-fips.us-iso-east-1.c2s.ic.gov" } }, "params": { "Region": "us-iso-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://edge.sagemaker.us-iso-east-1.c2s.ic.gov" } }, "params": { "Region": "us-iso-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://edge.sagemaker-fips.us-isob-east-1.sc2s.sgov.gov" } }, "params": { "Region": "us-isob-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://edge.sagemaker.us-isob-east-1.sc2s.sgov.gov" } }, "params": { "Region": "us-isob-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", "expect": { "endpoint": { "url": "https://example.com" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false, "Endpoint": "https://example.com" } }, { "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", "expect": { "endpoint": { "url": "https://example.com" } }, "params": { "UseFIPS": false, "UseDualStack": false, "Endpoint": "https://example.com" } }, { "documentation": "For custom endpoint with fips enabled and dualstack disabled", "expect": { "error": "Invalid Configuration: FIPS and custom endpoint are not supported" }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": false, "Endpoint": "https://example.com" } }, { "documentation": "For custom endpoint with fips disabled and dualstack enabled", "expect": { "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": true, "Endpoint": "https://example.com" } }, { "documentation": "Missing region", "expect": { "error": "Invalid Configuration: Missing Region" } } ], "version": "1.0" } } }, "com.amazonaws.sagemakeredge#CacheTTLSeconds": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 1000 } } }, "com.amazonaws.sagemakeredge#Checksum": { "type": "structure", "members": { "Type": { "target": "com.amazonaws.sagemakeredge#ChecksumType", "traits": { "smithy.api#documentation": "The type of the checksum.
" } }, "Sum": { "target": "com.amazonaws.sagemakeredge#ChecksumString", "traits": { "smithy.api#documentation": "The checksum of the model.
" } } }, "traits": { "smithy.api#documentation": "Information about the checksum of a model deployed on a device.
" } }, "com.amazonaws.sagemakeredge#ChecksumString": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 63 }, "smithy.api#pattern": "^[a-z0-9](-*[a-z0-9])*$" } }, "com.amazonaws.sagemakeredge#ChecksumType": { "type": "enum", "members": { "Sha1": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SHA1" } } } }, "com.amazonaws.sagemakeredge#Definition": { "type": "structure", "members": { "ModelHandle": { "target": "com.amazonaws.sagemakeredge#EntityName", "traits": { "smithy.api#documentation": "The unique model handle.
" } }, "S3Url": { "target": "com.amazonaws.sagemakeredge#S3Uri", "traits": { "smithy.api#documentation": "The absolute S3 location of the model.
" } }, "Checksum": { "target": "com.amazonaws.sagemakeredge#Checksum", "traits": { "smithy.api#documentation": "The checksum information of the model.
" } }, "State": { "target": "com.amazonaws.sagemakeredge#ModelState", "traits": { "smithy.api#documentation": "The desired state of the model.
" } } }, "traits": { "smithy.api#documentation": "" } }, "com.amazonaws.sagemakeredge#Definitions": { "type": "list", "member": { "target": "com.amazonaws.sagemakeredge#Definition" } }, "com.amazonaws.sagemakeredge#DeploymentModel": { "type": "structure", "members": { "ModelHandle": { "target": "com.amazonaws.sagemakeredge#EntityName", "traits": { "smithy.api#documentation": "The unique handle of the model.
" } }, "ModelName": { "target": "com.amazonaws.sagemakeredge#ModelName", "traits": { "smithy.api#documentation": "The name of the model.
" } }, "ModelVersion": { "target": "com.amazonaws.sagemakeredge#Version", "traits": { "smithy.api#documentation": "The version of the model.
" } }, "DesiredState": { "target": "com.amazonaws.sagemakeredge#ModelState", "traits": { "smithy.api#documentation": "The desired state of the model.
" } }, "State": { "target": "com.amazonaws.sagemakeredge#ModelState", "traits": { "smithy.api#documentation": "Returns the current state of the model.
" } }, "Status": { "target": "com.amazonaws.sagemakeredge#DeploymentStatus", "traits": { "smithy.api#documentation": "Returns the deployment status of the model.
" } }, "StatusReason": { "target": "com.amazonaws.sagemakeredge#String", "traits": { "smithy.api#documentation": "Returns the error message for the deployment status result.
" } }, "RollbackFailureReason": { "target": "com.amazonaws.sagemakeredge#String", "traits": { "smithy.api#documentation": "Returns the error message if there is a rollback.
" } } }, "traits": { "smithy.api#documentation": "" } }, "com.amazonaws.sagemakeredge#DeploymentModels": { "type": "list", "member": { "target": "com.amazonaws.sagemakeredge#DeploymentModel" } }, "com.amazonaws.sagemakeredge#DeploymentResult": { "type": "structure", "members": { "DeploymentName": { "target": "com.amazonaws.sagemakeredge#EntityName", "traits": { "smithy.api#documentation": "The name and unique ID of the deployment.
" } }, "DeploymentStatus": { "target": "com.amazonaws.sagemakeredge#EntityName", "traits": { "smithy.api#documentation": "Returns the bucket error code.
" } }, "DeploymentStatusMessage": { "target": "com.amazonaws.sagemakeredge#String", "traits": { "smithy.api#documentation": "Returns the detailed error message.
" } }, "DeploymentStartTime": { "target": "com.amazonaws.sagemakeredge#Timestamp", "traits": { "smithy.api#documentation": "The timestamp of when the deployment was started on the agent.
" } }, "DeploymentEndTime": { "target": "com.amazonaws.sagemakeredge#Timestamp", "traits": { "smithy.api#documentation": "The timestamp of when the deployment was ended, and the agent got the deployment results.
" } }, "DeploymentModels": { "target": "com.amazonaws.sagemakeredge#DeploymentModels", "traits": { "smithy.api#documentation": "Returns a list of models deployed on the agent.
" } } }, "traits": { "smithy.api#documentation": "Information about the result of a deployment on an edge device that is registered with SageMaker Edge Manager.
" } }, "com.amazonaws.sagemakeredge#DeploymentStatus": { "type": "enum", "members": { "Success": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SUCCESS" } }, "Fail": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "FAIL" } } } }, "com.amazonaws.sagemakeredge#DeploymentType": { "type": "enum", "members": { "Model": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Model" } } } }, "com.amazonaws.sagemakeredge#DeviceFleetName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 63 }, "smithy.api#pattern": "^[a-zA-Z0-9](-*_*[a-zA-Z0-9])*$" } }, "com.amazonaws.sagemakeredge#DeviceName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 63 }, "smithy.api#pattern": "^[a-zA-Z0-9](-*_*[a-zA-Z0-9])*$" } }, "com.amazonaws.sagemakeredge#DeviceRegistration": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 1000 } } }, "com.amazonaws.sagemakeredge#Dimension": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 1000 }, "smithy.api#pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9\\/])*$" } }, "com.amazonaws.sagemakeredge#EdgeDeployment": { "type": "structure", "members": { "DeploymentName": { "target": "com.amazonaws.sagemakeredge#EntityName", "traits": { "smithy.api#documentation": "The name and unique ID of the deployment.
" } }, "Type": { "target": "com.amazonaws.sagemakeredge#DeploymentType", "traits": { "smithy.api#documentation": "The type of the deployment.
" } }, "FailureHandlingPolicy": { "target": "com.amazonaws.sagemakeredge#FailureHandlingPolicy", "traits": { "smithy.api#documentation": "Determines whether to rollback to previous configuration if deployment fails.
" } }, "Definitions": { "target": "com.amazonaws.sagemakeredge#Definitions", "traits": { "smithy.api#documentation": "Returns a list of Definition objects.
" } } }, "traits": { "smithy.api#documentation": "Information about a deployment on an edge device that is registered with SageMaker Edge Manager.
" } }, "com.amazonaws.sagemakeredge#EdgeDeployments": { "type": "list", "member": { "target": "com.amazonaws.sagemakeredge#EdgeDeployment" } }, "com.amazonaws.sagemakeredge#EdgeMetric": { "type": "structure", "members": { "Dimension": { "target": "com.amazonaws.sagemakeredge#Dimension", "traits": { "smithy.api#documentation": "The dimension of metrics published.
" } }, "MetricName": { "target": "com.amazonaws.sagemakeredge#Metric", "traits": { "smithy.api#documentation": "Returns the name of the metric.
" } }, "Value": { "target": "com.amazonaws.sagemakeredge#Value", "traits": { "smithy.api#documentation": "Returns the value of the metric.
" } }, "Timestamp": { "target": "com.amazonaws.sagemakeredge#Timestamp", "traits": { "smithy.api#documentation": "Timestamp of when the metric was requested.
" } } }, "traits": { "smithy.api#documentation": "Information required for edge device metrics.
" } }, "com.amazonaws.sagemakeredge#EdgeMetrics": { "type": "list", "member": { "target": "com.amazonaws.sagemakeredge#EdgeMetric" } }, "com.amazonaws.sagemakeredge#EntityName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 63 }, "smithy.api#pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9])*$" } }, "com.amazonaws.sagemakeredge#ErrorMessage": { "type": "string" }, "com.amazonaws.sagemakeredge#FailureHandlingPolicy": { "type": "enum", "members": { "RollbackOnFailure": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ROLLBACK_ON_FAILURE" } }, "DoNothing": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DO_NOTHING" } } } }, "com.amazonaws.sagemakeredge#GetDeployments": { "type": "operation", "input": { "target": "com.amazonaws.sagemakeredge#GetDeploymentsRequest" }, "output": { "target": "com.amazonaws.sagemakeredge#GetDeploymentsResult" }, "errors": [ { "target": "com.amazonaws.sagemakeredge#InternalServiceException" } ], "traits": { "smithy.api#documentation": "Use to get the active deployments from a device.
", "smithy.api#http": { "method": "POST", "uri": "/GetDeployments", "code": 200 } } }, "com.amazonaws.sagemakeredge#GetDeploymentsRequest": { "type": "structure", "members": { "DeviceName": { "target": "com.amazonaws.sagemakeredge#DeviceName", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The unique name of the device you want to get the configuration of active deployments from.
", "smithy.api#required": {} } }, "DeviceFleetName": { "target": "com.amazonaws.sagemakeredge#DeviceFleetName", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The name of the fleet that the device belongs to.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.sagemakeredge#GetDeploymentsResult": { "type": "structure", "members": { "Deployments": { "target": "com.amazonaws.sagemakeredge#EdgeDeployments", "traits": { "smithy.api#documentation": "Returns a list of the configurations of the active deployments on the device.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.sagemakeredge#GetDeviceRegistration": { "type": "operation", "input": { "target": "com.amazonaws.sagemakeredge#GetDeviceRegistrationRequest" }, "output": { "target": "com.amazonaws.sagemakeredge#GetDeviceRegistrationResult" }, "errors": [ { "target": "com.amazonaws.sagemakeredge#InternalServiceException" } ], "traits": { "smithy.api#documentation": "Use to check if a device is registered with SageMaker Edge Manager.
", "smithy.api#http": { "method": "POST", "uri": "/GetDeviceRegistration", "code": 200 } } }, "com.amazonaws.sagemakeredge#GetDeviceRegistrationRequest": { "type": "structure", "members": { "DeviceName": { "target": "com.amazonaws.sagemakeredge#DeviceName", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The unique name of the device you want to get the registration status from.
", "smithy.api#required": {} } }, "DeviceFleetName": { "target": "com.amazonaws.sagemakeredge#DeviceFleetName", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The name of the fleet that the device belongs to.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.sagemakeredge#GetDeviceRegistrationResult": { "type": "structure", "members": { "DeviceRegistration": { "target": "com.amazonaws.sagemakeredge#DeviceRegistration", "traits": { "smithy.api#documentation": "Describes if the device is currently registered with SageMaker Edge Manager.
" } }, "CacheTTL": { "target": "com.amazonaws.sagemakeredge#CacheTTLSeconds", "traits": { "smithy.api#documentation": "The amount of time, in seconds, that the registration status is stored on the device\u2019s cache before it is refreshed.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.sagemakeredge#InternalServiceException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.sagemakeredge#ErrorMessage" } }, "traits": { "smithy.api#documentation": "An internal failure occurred. Try your request again. If the problem \n persists, contact Amazon Web Services customer support.
", "smithy.api#error": "client" } }, "com.amazonaws.sagemakeredge#Metric": { "type": "string", "traits": { "smithy.api#length": { "min": 4, "max": 100 }, "smithy.api#pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9])*$" } }, "com.amazonaws.sagemakeredge#Model": { "type": "structure", "members": { "ModelName": { "target": "com.amazonaws.sagemakeredge#ModelName", "traits": { "smithy.api#documentation": "The name of the model.
" } }, "ModelVersion": { "target": "com.amazonaws.sagemakeredge#Version", "traits": { "smithy.api#documentation": "The version of the model.
" } }, "LatestSampleTime": { "target": "com.amazonaws.sagemakeredge#Timestamp", "traits": { "smithy.api#documentation": "The timestamp of the last data sample taken.
" } }, "LatestInference": { "target": "com.amazonaws.sagemakeredge#Timestamp", "traits": { "smithy.api#documentation": "The timestamp of the last inference that was made.
" } }, "ModelMetrics": { "target": "com.amazonaws.sagemakeredge#EdgeMetrics", "traits": { "smithy.api#documentation": "Information required for model metrics.
" } } }, "traits": { "smithy.api#documentation": "Information about a model deployed on an edge device that is registered with SageMaker Edge Manager.
" } }, "com.amazonaws.sagemakeredge#ModelName": { "type": "string", "traits": { "smithy.api#length": { "min": 4, "max": 255 }, "smithy.api#pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9])*$" } }, "com.amazonaws.sagemakeredge#ModelState": { "type": "enum", "members": { "Deploy": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DEPLOY" } }, "Undeploy": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "UNDEPLOY" } } } }, "com.amazonaws.sagemakeredge#Models": { "type": "list", "member": { "target": "com.amazonaws.sagemakeredge#Model" } }, "com.amazonaws.sagemakeredge#S3Uri": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 1024 }, "smithy.api#pattern": "^s3://([^/]+)/?(.*)$" } }, "com.amazonaws.sagemakeredge#SendHeartbeat": { "type": "operation", "input": { "target": "com.amazonaws.sagemakeredge#SendHeartbeatRequest" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.sagemakeredge#InternalServiceException" } ], "traits": { "smithy.api#documentation": "Use to get the current status of devices registered on SageMaker Edge Manager.
", "smithy.api#http": { "method": "POST", "uri": "/SendHeartbeat", "code": 200 } } }, "com.amazonaws.sagemakeredge#SendHeartbeatRequest": { "type": "structure", "members": { "AgentMetrics": { "target": "com.amazonaws.sagemakeredge#EdgeMetrics", "traits": { "smithy.api#documentation": "For internal use. Returns a list of SageMaker Edge Manager agent operating metrics.
" } }, "Models": { "target": "com.amazonaws.sagemakeredge#Models", "traits": { "smithy.api#documentation": "Returns a list of models deployed on the the device.
" } }, "AgentVersion": { "target": "com.amazonaws.sagemakeredge#Version", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "Returns the version of the agent.
", "smithy.api#required": {} } }, "DeviceName": { "target": "com.amazonaws.sagemakeredge#DeviceName", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The unique name of the device.
", "smithy.api#required": {} } }, "DeviceFleetName": { "target": "com.amazonaws.sagemakeredge#DeviceFleetName", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The name of the fleet that the device belongs to.
", "smithy.api#required": {} } }, "DeploymentResult": { "target": "com.amazonaws.sagemakeredge#DeploymentResult", "traits": { "smithy.api#documentation": "Returns the result of a deployment on the device.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.sagemakeredge#String": { "type": "string" }, "com.amazonaws.sagemakeredge#Timestamp": { "type": "timestamp" }, "com.amazonaws.sagemakeredge#Value": { "type": "double" }, "com.amazonaws.sagemakeredge#Version": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 64 }, "smithy.api#pattern": "^[a-zA-Z0-9\\ \\_\\.]+$" } } } }