Skip to content
v2.278.0

MetricGroupProperty Struct ​

A group of metric data that you use to initialize a metric group object.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_sagemaker as sagemaker } from 'aws-cdk-lib';

declare const value: any;
const metricGroupProperty: sagemaker.CfnModelCard.MetricGroupProperty = {
  metricData: [{
    name: 'name',
    type: 'type',
    value: value,

    // the properties below are optional
    notes: 'notes',
    xAxisName: ['xAxisName'],
    yAxisName: ['yAxisName'],
  }],
  name: 'name',
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_sagemaker as sagemaker

# value: Any

metric_group_property = sagemaker.CfnModelCard.MetricGroupProperty(
    metric_data=[sagemaker.CfnModelCard.MetricDataItemsProperty(
        name="name",
        type="type",
        value=value,

        # the properties below are optional
        notes="notes",
        x_axis_name=["xAxisName"],
        y_axis_name=["yAxisName"]
    )],
    name="name"
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.sagemaker.*;

Object value;

MetricGroupProperty metricGroupProperty = MetricGroupProperty.builder()
        .metricData(List.of(MetricDataItemsProperty.builder()
                .name("name")
                .type("type")
                .value(value)

                // the properties below are optional
                .notes("notes")
                .xAxisName(List.of("xAxisName"))
                .yAxisName(List.of("yAxisName"))
                .build()))
        .name("name")
        .build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Sagemaker;

var value;

var metricGroupProperty = new MetricGroupProperty {
    MetricData = new [] { new MetricDataItemsProperty {
        Name = "name",
        Type = "type",
        Value = value,

        // the properties below are optional
        Notes = "notes",
        XAxisName = new [] { "xAxisName" },
        YAxisName = new [] { "yAxisName" }
    } },
    Name = "name"
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

var value interface{}

metricGroupProperty := &MetricGroupProperty{
	MetricData: []interface{}{
		&MetricDataItemsProperty{
			Name: jsii.String("name"),
			Type: jsii.String("type"),
			Value: value,

			// the properties below are optional
			Notes: jsii.String("notes"),
			XAxisName: []*string{
				jsii.String("xAxisName"),
			},
			YAxisName: []*string{
				jsii.String("yAxisName"),
			},
		},
	},
	Name: jsii.String("name"),
}

Properties ​

metricDataIResolvable | IResolvable | CfnModelCard.MetricDataItemsProperty[]metric_datatyping.Union[IResolvable, typing.List[typing.Union[IResolvable, MetricDataItemsProperty]]]metricDataIResolvableMetricDataIResolvableMetricDatainterface{} required #
A list of metric objects. The `MetricDataItems` list can have one of the following values:.
notes
  • bar_chart_metric
  • matrix_metric
  • simple_metric
  • linear_graph_metric

For more information about the metric schema, see the definition section of the model card JSON schema .

namestringnamestrnameStringNamestringName*string required #
The metric group name.