| 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.SageMakerMetrics
Description
Derived from API version 2022-09-30 of the AWS service descriptions, licensed under Apache 2.0.
Contains all data plane API operations and data types for Amazon SageMaker Metrics. Use these APIs to put and retrieve (get) features related to your training run.
Synopsis
- defaultService :: Service
- data BatchPutMetrics = BatchPutMetrics' Text (NonEmpty RawMetricData)
- newBatchPutMetrics :: Text -> NonEmpty RawMetricData -> BatchPutMetrics
- data BatchPutMetricsResponse = BatchPutMetricsResponse' (Maybe (NonEmpty BatchPutMetricsError)) Int
- newBatchPutMetricsResponse :: Int -> BatchPutMetricsResponse
- newtype PutMetricsErrorCode where
- data BatchPutMetricsError = BatchPutMetricsError' (Maybe PutMetricsErrorCode) (Maybe Int)
- newBatchPutMetricsError :: BatchPutMetricsError
- data RawMetricData = RawMetricData' (Maybe Natural) Text POSIX Double
- newRawMetricData :: Text -> UTCTime -> Double -> RawMetricData
Service Configuration
defaultService :: Service Source #
API version 2022-09-30 of the Amazon SageMaker Metrics Service 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 SageMakerMetrics.
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.
BatchPutMetrics
data BatchPutMetrics Source #
See: newBatchPutMetrics smart constructor.
Constructors
| BatchPutMetrics' Text (NonEmpty RawMetricData) |
Instances
Arguments
| :: Text | |
| -> NonEmpty RawMetricData | |
| -> BatchPutMetrics |
Create a value of BatchPutMetrics 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:trialComponentName:BatchPutMetrics', batchPutMetrics_trialComponentName - The name of the Trial Component to associate with the metrics.
$sel:metricData:BatchPutMetrics', batchPutMetrics_metricData - A list of raw metric values to put.
data BatchPutMetricsResponse Source #
See: newBatchPutMetricsResponse smart constructor.
Constructors
| BatchPutMetricsResponse' (Maybe (NonEmpty BatchPutMetricsError)) Int |
Instances
newBatchPutMetricsResponse Source #
Create a value of BatchPutMetricsResponse 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:errors:BatchPutMetricsResponse', batchPutMetricsResponse_errors - Lists any errors that occur when inserting metric data.
$sel:httpStatus:BatchPutMetricsResponse', batchPutMetricsResponse_httpStatus - The response's http status code.
Types
PutMetricsErrorCode
newtype PutMetricsErrorCode Source #
Constructors
| PutMetricsErrorCode' | |
Fields | |
Bundled Patterns
Instances
BatchPutMetricsError
data BatchPutMetricsError Source #
An error that occured when putting the metric data.
See: newBatchPutMetricsError smart constructor.
Constructors
| BatchPutMetricsError' (Maybe PutMetricsErrorCode) (Maybe Int) |
Instances
newBatchPutMetricsError :: BatchPutMetricsError Source #
Create a value of BatchPutMetricsError 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:code:BatchPutMetricsError', batchPutMetricsError_code - The error code of an error that occured when attempting to put metrics.
METRIC_LIMIT_EXCEEDED: The maximum amount of metrics per resource is exceeded.INTERNAL_ERROR: An internal error occured.VALIDATION_ERROR: The metric data failed validation.CONFLICT_ERROR: Multiple requests attempted to modify the same data simultaneously.
$sel:metricIndex:BatchPutMetricsError', batchPutMetricsError_metricIndex - An index that corresponds to the metric in the request.
RawMetricData
data RawMetricData Source #
The raw metric data to associate with the resource.
See: newRawMetricData smart constructor.
Instances
Arguments
| :: Text | |
| -> UTCTime | |
| -> Double | |
| -> RawMetricData |
Create a value of RawMetricData 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:step:RawMetricData', rawMetricData_step - The metric step (epoch).
$sel:metricName:RawMetricData', rawMetricData_metricName - The name of the metric.
$sel:timestamp:RawMetricData', rawMetricData_timestamp - The time that the metric was recorded.
$sel:value:RawMetricData', rawMetricData_value - The metric value.