func PutMetricsErrorCode_Values() []string
PutMetricsErrorCode_Values returns all elements of the PutMetricsErrorCode enum
type BatchPutMetricsError struct {
// 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.
Code *string `type:"string" enum:"PutMetricsErrorCode"`
// An index that corresponds to the metric in the request.
MetricIndex *int64 `type:"integer"`
// contains filtered or unexported fields
}
An error that occured when putting the metric data.
func (s BatchPutMetricsError) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *BatchPutMetricsError) SetCode(v string) *BatchPutMetricsError
SetCode sets the Code field's value.
func (s *BatchPutMetricsError) SetMetricIndex(v int64) *BatchPutMetricsError
SetMetricIndex sets the MetricIndex field's value.
func (s BatchPutMetricsError) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type BatchPutMetricsInput struct {
// A list of raw metric values to put.
//
// MetricData is a required field
MetricData []*RawMetricData `min:"1" type:"list" required:"true"`
// The name of the Trial Component to associate with the metrics.
//
// TrialComponentName is a required field
TrialComponentName *string `min:"1" type:"string" required:"true"`
// contains filtered or unexported fields
}
func (s BatchPutMetricsInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *BatchPutMetricsInput) SetMetricData(v []*RawMetricData) *BatchPutMetricsInput
SetMetricData sets the MetricData field's value.
func (s *BatchPutMetricsInput) SetTrialComponentName(v string) *BatchPutMetricsInput
SetTrialComponentName sets the TrialComponentName field's value.
func (s BatchPutMetricsInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *BatchPutMetricsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type BatchPutMetricsOutput struct {
// Lists any errors that occur when inserting metric data.
Errors []*BatchPutMetricsError `min:"1" type:"list"`
// contains filtered or unexported fields
}
func (s BatchPutMetricsOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *BatchPutMetricsOutput) SetErrors(v []*BatchPutMetricsError) *BatchPutMetricsOutput
SetErrors sets the Errors field's value.
func (s BatchPutMetricsOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type RawMetricData struct {
// The name of the metric.
//
// MetricName is a required field
MetricName *string `min:"1" type:"string" required:"true"`
// The metric step (epoch).
Step *int64 `type:"integer"`
// The time that the metric was recorded.
//
// Timestamp is a required field
Timestamp *time.Time `type:"timestamp" required:"true"`
// The metric value.
//
// Value is a required field
Value *float64 `type:"double" required:"true"`
// contains filtered or unexported fields
}
The raw metric data to associate with the resource.
func (s RawMetricData) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *RawMetricData) SetMetricName(v string) *RawMetricData
SetMetricName sets the MetricName field's value.
func (s *RawMetricData) SetStep(v int64) *RawMetricData
SetStep sets the Step field's value.
func (s *RawMetricData) SetTimestamp(v time.Time) *RawMetricData
SetTimestamp sets the Timestamp field's value.
func (s *RawMetricData) SetValue(v float64) *RawMetricData
SetValue sets the Value field's value.
func (s RawMetricData) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *RawMetricData) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type SageMakerMetrics struct {
*client.Client
}
SageMakerMetrics provides the API operation methods for making requests to Amazon SageMaker Metrics Service. See this package's package overview docs for details on the service.
SageMakerMetrics methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.
func New(p client.ConfigProvider, cfgs ...*aws.Config) *SageMakerMetrics
New creates a new instance of the SageMakerMetrics client with a session. If additional configuration is needed for the client instance use the optional aws.Config parameter to add your extra config.
Example:
mySession := session.Must(session.NewSession())
// Create a SageMakerMetrics client from just a session.
svc := sagemakermetrics.New(mySession)
// Create a SageMakerMetrics client with additional configuration
svc := sagemakermetrics.New(mySession, aws.NewConfig().WithRegion("us-west-2"))
func (c *SageMakerMetrics) BatchPutMetrics(input *BatchPutMetricsInput) (*BatchPutMetricsOutput, error)
BatchPutMetrics API operation for Amazon SageMaker Metrics Service.
Used to ingest training metrics into SageMaker. These metrics can be visualized in SageMaker Studio and retrieved with the GetMetrics API.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon SageMaker Metrics Service's API operation BatchPutMetrics for usage and error information. See also, https://docs.aws.amazon.com/goto/WebAPI/sagemaker-metrics-2022-09-30/BatchPutMetrics
func (c *SageMakerMetrics) BatchPutMetricsRequest(input *BatchPutMetricsInput) (req *request.Request, output *BatchPutMetricsOutput)
BatchPutMetricsRequest generates a "aws/request.Request" representing the client's request for the BatchPutMetrics operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See BatchPutMetrics for more information on using the BatchPutMetrics API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the BatchPutMetricsRequest method.
req, resp := client.BatchPutMetricsRequest(params)
err := req.Send()
if err == nil { // resp is now filled
fmt.Println(resp)
}
func (c *SageMakerMetrics) BatchPutMetricsWithContext(ctx aws.Context, input *BatchPutMetricsInput, opts ...request.Option) (*BatchPutMetricsOutput, error)
BatchPutMetricsWithContext is the same as BatchPutMetrics with the addition of the ability to pass a context and additional request options.
See BatchPutMetrics for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.