| Copyright | (c) 2013-2023 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
Amazonka.SageMakerEdge
Description
Derived from API version 2020-09-23 of the AWS service descriptions, licensed under Apache 2.0.
SageMaker Edge Manager dataplane service for communicating with active agents.
Synopsis
- defaultService :: Service
- _InternalServiceException :: AsError a => Fold a ServiceError
- data GetDeployments = GetDeployments' Text Text
- newGetDeployments :: Text -> Text -> GetDeployments
- data GetDeploymentsResponse = GetDeploymentsResponse' (Maybe [EdgeDeployment]) Int
- newGetDeploymentsResponse :: Int -> GetDeploymentsResponse
- data GetDeviceRegistration = GetDeviceRegistration' Text Text
- newGetDeviceRegistration :: Text -> Text -> GetDeviceRegistration
- data GetDeviceRegistrationResponse = GetDeviceRegistrationResponse' (Maybe Text) (Maybe Text) Int
- newGetDeviceRegistrationResponse :: Int -> GetDeviceRegistrationResponse
- data SendHeartbeat = SendHeartbeat' (Maybe [EdgeMetric]) (Maybe DeploymentResult) (Maybe [Model]) Text Text Text
- newSendHeartbeat :: Text -> Text -> Text -> SendHeartbeat
- data SendHeartbeatResponse = SendHeartbeatResponse' {
- newSendHeartbeatResponse :: SendHeartbeatResponse
- newtype ChecksumType where
- ChecksumType' { }
- pattern ChecksumType_SHA1 :: ChecksumType
- newtype DeploymentStatus where
- DeploymentStatus' { }
- pattern DeploymentStatus_FAIL :: DeploymentStatus
- pattern DeploymentStatus_SUCCESS :: DeploymentStatus
- newtype DeploymentType where
- DeploymentType' { }
- pattern DeploymentType_Model :: DeploymentType
- newtype FailureHandlingPolicy where
- newtype ModelState where
- ModelState' { }
- pattern ModelState_DEPLOY :: ModelState
- pattern ModelState_UNDEPLOY :: ModelState
- data Checksum = Checksum' (Maybe Text) (Maybe ChecksumType)
- newChecksum :: Checksum
- data Definition = Definition' (Maybe Checksum) (Maybe Text) (Maybe Text) (Maybe ModelState)
- newDefinition :: Definition
- data DeploymentModel = DeploymentModel' (Maybe ModelState) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe ModelState) (Maybe DeploymentStatus) (Maybe Text)
- newDeploymentModel :: DeploymentModel
- data DeploymentResult = DeploymentResult' (Maybe POSIX) (Maybe [DeploymentModel]) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text)
- newDeploymentResult :: DeploymentResult
- data EdgeDeployment = EdgeDeployment' (Maybe [Definition]) (Maybe Text) (Maybe FailureHandlingPolicy) (Maybe DeploymentType)
- newEdgeDeployment :: EdgeDeployment
- data EdgeMetric = EdgeMetric' (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Double)
- newEdgeMetric :: EdgeMetric
- data Model = Model' (Maybe POSIX) (Maybe POSIX) (Maybe [EdgeMetric]) (Maybe Text) (Maybe Text)
- newModel :: Model
Service Configuration
defaultService :: Service Source #
API version 2020-09-23 of the Amazon Sagemaker Edge Manager SDK configuration.
Errors
Error matchers are designed for use with the functions provided by
Control.Exception.Lens.
This allows catching (and rethrowing) service specific errors returned
by SageMakerEdge.
InternalServiceException
_InternalServiceException :: AsError a => Fold a ServiceError Source #
An internal failure occurred. Try your request again. If the problem persists, contact Amazon Web Services customer support.
Waiters
Waiters poll by repeatedly sending a request until some remote success condition
configured by the Wait specification is fulfilled. The Wait specification
determines how many attempts should be made, in addition to delay and retry strategies.
Operations
Some AWS operations return results that are incomplete and require subsequent
requests in order to obtain the entire result set. The process of sending
subsequent requests to continue where a previous request left off is called
pagination. For example, the ListObjects operation of Amazon S3 returns up to
1000 objects at a time, and you must send subsequent requests with the
appropriate Marker in order to retrieve the next page of results.
Operations that have an AWSPager instance can transparently perform subsequent
requests, correctly setting Markers and other request facets to iterate through
the entire result set of a truncated API operation. Operations which support
this have an additional note in the documentation.
Many operations have the ability to filter results on the server side. See the individual operation parameters for details.
GetDeployments
data GetDeployments Source #
See: newGetDeployments smart constructor.
Constructors
| GetDeployments' Text Text |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> GetDeployments |
Create a value of GetDeployments with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:deviceName:GetDeployments', getDeployments_deviceName - The unique name of the device you want to get the configuration of
active deployments from.
$sel:deviceFleetName:GetDeployments', getDeployments_deviceFleetName - The name of the fleet that the device belongs to.
data GetDeploymentsResponse Source #
See: newGetDeploymentsResponse smart constructor.
Constructors
| GetDeploymentsResponse' (Maybe [EdgeDeployment]) Int |
Instances
newGetDeploymentsResponse Source #
Create a value of GetDeploymentsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:deployments:GetDeploymentsResponse', getDeploymentsResponse_deployments - Returns a list of the configurations of the active deployments on the
device.
$sel:httpStatus:GetDeploymentsResponse', getDeploymentsResponse_httpStatus - The response's http status code.
GetDeviceRegistration
data GetDeviceRegistration Source #
See: newGetDeviceRegistration smart constructor.
Constructors
| GetDeviceRegistration' Text Text |
Instances
newGetDeviceRegistration Source #
Arguments
| :: Text | |
| -> Text | |
| -> GetDeviceRegistration |
Create a value of GetDeviceRegistration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:deviceName:GetDeviceRegistration', getDeviceRegistration_deviceName - The unique name of the device you want to get the registration status
from.
$sel:deviceFleetName:GetDeviceRegistration', getDeviceRegistration_deviceFleetName - The name of the fleet that the device belongs to.
data GetDeviceRegistrationResponse Source #
See: newGetDeviceRegistrationResponse smart constructor.
Instances
newGetDeviceRegistrationResponse Source #
Create a value of GetDeviceRegistrationResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:cacheTTL:GetDeviceRegistrationResponse', getDeviceRegistrationResponse_cacheTTL - The amount of time, in seconds, that the registration status is stored
on the device’s cache before it is refreshed.
$sel:deviceRegistration:GetDeviceRegistrationResponse', getDeviceRegistrationResponse_deviceRegistration - Describes if the device is currently registered with SageMaker Edge
Manager.
$sel:httpStatus:GetDeviceRegistrationResponse', getDeviceRegistrationResponse_httpStatus - The response's http status code.
SendHeartbeat
data SendHeartbeat Source #
See: newSendHeartbeat smart constructor.
Constructors
| SendHeartbeat' (Maybe [EdgeMetric]) (Maybe DeploymentResult) (Maybe [Model]) Text Text Text |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> SendHeartbeat |
Create a value of SendHeartbeat with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:agentMetrics:SendHeartbeat', sendHeartbeat_agentMetrics - For internal use. Returns a list of SageMaker Edge Manager agent
operating metrics.
$sel:deploymentResult:SendHeartbeat', sendHeartbeat_deploymentResult - Returns the result of a deployment on the device.
$sel:models:SendHeartbeat', sendHeartbeat_models - Returns a list of models deployed on the the device.
$sel:agentVersion:SendHeartbeat', sendHeartbeat_agentVersion - Returns the version of the agent.
$sel:deviceName:SendHeartbeat', sendHeartbeat_deviceName - The unique name of the device.
$sel:deviceFleetName:SendHeartbeat', sendHeartbeat_deviceFleetName - The name of the fleet that the device belongs to.
data SendHeartbeatResponse Source #
See: newSendHeartbeatResponse smart constructor.
Constructors
| SendHeartbeatResponse' | |
Instances
newSendHeartbeatResponse :: SendHeartbeatResponse Source #
Create a value of SendHeartbeatResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
Types
ChecksumType
newtype ChecksumType Source #
Constructors
| ChecksumType' | |
Fields | |
Bundled Patterns
| pattern ChecksumType_SHA1 :: ChecksumType |
Instances
DeploymentStatus
newtype DeploymentStatus Source #
Constructors
| DeploymentStatus' | |
Fields | |
Bundled Patterns
| pattern DeploymentStatus_FAIL :: DeploymentStatus | |
| pattern DeploymentStatus_SUCCESS :: DeploymentStatus |
Instances
DeploymentType
newtype DeploymentType Source #
Constructors
| DeploymentType' | |
Fields | |
Bundled Patterns
| pattern DeploymentType_Model :: DeploymentType |
Instances
FailureHandlingPolicy
newtype FailureHandlingPolicy Source #
Constructors
| FailureHandlingPolicy' | |
Fields | |
Bundled Patterns
| pattern FailureHandlingPolicy_DO_NOTHING :: FailureHandlingPolicy | |
| pattern FailureHandlingPolicy_ROLLBACK_ON_FAILURE :: FailureHandlingPolicy |
Instances
ModelState
newtype ModelState Source #
Constructors
| ModelState' | |
Fields | |
Bundled Patterns
| pattern ModelState_DEPLOY :: ModelState | |
| pattern ModelState_UNDEPLOY :: ModelState |
Instances
Checksum
Information about the checksum of a model deployed on a device.
See: newChecksum smart constructor.
Constructors
| Checksum' (Maybe Text) (Maybe ChecksumType) |
Instances
| FromJSON Checksum Source # | |
| Generic Checksum Source # | |
| Read Checksum Source # | |
| Show Checksum Source # | |
| NFData Checksum Source # | |
Defined in Amazonka.SageMakerEdge.Types.Checksum | |
| Eq Checksum Source # | |
| Hashable Checksum Source # | |
Defined in Amazonka.SageMakerEdge.Types.Checksum | |
| type Rep Checksum Source # | |
Defined in Amazonka.SageMakerEdge.Types.Checksum type Rep Checksum = D1 ('MetaData "Checksum" "Amazonka.SageMakerEdge.Types.Checksum" "amazonka-sagemaker-edge-2.0-6w4LluEpi0R1S8SkusTG8r" 'False) (C1 ('MetaCons "Checksum'" 'PrefixI 'True) (S1 ('MetaSel ('Just "sum") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ChecksumType)))) | |
newChecksum :: Checksum Source #
Create a value of Checksum with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:sum:Checksum', checksum_sum - The checksum of the model.
$sel:type':Checksum', checksum_type - The type of the checksum.
Definition
data Definition Source #
See: newDefinition smart constructor.
Constructors
| Definition' (Maybe Checksum) (Maybe Text) (Maybe Text) (Maybe ModelState) |
Instances
newDefinition :: Definition Source #
Create a value of Definition with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:checksum:Definition', definition_checksum - The checksum information of the model.
$sel:modelHandle:Definition', definition_modelHandle - The unique model handle.
$sel:s3Url:Definition', definition_s3Url - The absolute S3 location of the model.
$sel:state:Definition', definition_state - The desired state of the model.
DeploymentModel
data DeploymentModel Source #
See: newDeploymentModel smart constructor.
Constructors
| DeploymentModel' (Maybe ModelState) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe ModelState) (Maybe DeploymentStatus) (Maybe Text) |
Instances
newDeploymentModel :: DeploymentModel Source #
Create a value of DeploymentModel with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:desiredState:DeploymentModel', deploymentModel_desiredState - The desired state of the model.
$sel:modelHandle:DeploymentModel', deploymentModel_modelHandle - The unique handle of the model.
$sel:modelName:DeploymentModel', deploymentModel_modelName - The name of the model.
$sel:modelVersion:DeploymentModel', deploymentModel_modelVersion - The version of the model.
$sel:rollbackFailureReason:DeploymentModel', deploymentModel_rollbackFailureReason - Returns the error message if there is a rollback.
$sel:state:DeploymentModel', deploymentModel_state - Returns the current state of the model.
$sel:status:DeploymentModel', deploymentModel_status - Returns the deployment status of the model.
$sel:statusReason:DeploymentModel', deploymentModel_statusReason - Returns the error message for the deployment status result.
DeploymentResult
data DeploymentResult Source #
Information about the result of a deployment on an edge device that is registered with SageMaker Edge Manager.
See: newDeploymentResult smart constructor.
Constructors
| DeploymentResult' (Maybe POSIX) (Maybe [DeploymentModel]) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text) |
Instances
newDeploymentResult :: DeploymentResult Source #
Create a value of DeploymentResult with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:deploymentEndTime:DeploymentResult', deploymentResult_deploymentEndTime - The timestamp of when the deployment was ended, and the agent got the
deployment results.
$sel:deploymentModels:DeploymentResult', deploymentResult_deploymentModels - Returns a list of models deployed on the agent.
$sel:deploymentName:DeploymentResult', deploymentResult_deploymentName - The name and unique ID of the deployment.
$sel:deploymentStartTime:DeploymentResult', deploymentResult_deploymentStartTime - The timestamp of when the deployment was started on the agent.
$sel:deploymentStatus:DeploymentResult', deploymentResult_deploymentStatus - Returns the bucket error code.
$sel:deploymentStatusMessage:DeploymentResult', deploymentResult_deploymentStatusMessage - Returns the detailed error message.
EdgeDeployment
data EdgeDeployment Source #
Information about a deployment on an edge device that is registered with SageMaker Edge Manager.
See: newEdgeDeployment smart constructor.
Constructors
| EdgeDeployment' (Maybe [Definition]) (Maybe Text) (Maybe FailureHandlingPolicy) (Maybe DeploymentType) |
Instances
newEdgeDeployment :: EdgeDeployment Source #
Create a value of EdgeDeployment with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:definitions:EdgeDeployment', edgeDeployment_definitions - Returns a list of Definition objects.
$sel:deploymentName:EdgeDeployment', edgeDeployment_deploymentName - The name and unique ID of the deployment.
$sel:failureHandlingPolicy:EdgeDeployment', edgeDeployment_failureHandlingPolicy - Determines whether to rollback to previous configuration if deployment
fails.
$sel:type':EdgeDeployment', edgeDeployment_type - The type of the deployment.
EdgeMetric
data EdgeMetric Source #
Information required for edge device metrics.
See: newEdgeMetric smart constructor.
Instances
newEdgeMetric :: EdgeMetric Source #
Create a value of EdgeMetric with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dimension:EdgeMetric', edgeMetric_dimension - The dimension of metrics published.
$sel:metricName:EdgeMetric', edgeMetric_metricName - Returns the name of the metric.
$sel:timestamp:EdgeMetric', edgeMetric_timestamp - Timestamp of when the metric was requested.
$sel:value:EdgeMetric', edgeMetric_value - Returns the value of the metric.
Model
Information about a model deployed on an edge device that is registered with SageMaker Edge Manager.
See: newModel smart constructor.
Instances
Create a value of Model with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:latestInference:Model', model_latestInference - The timestamp of the last inference that was made.
$sel:latestSampleTime:Model', model_latestSampleTime - The timestamp of the last data sample taken.
$sel:modelMetrics:Model', model_modelMetrics - Information required for model metrics.
$sel:modelName:Model', model_modelName - The name of the model.
$sel:modelVersion:Model', model_modelVersion - The version of the model.