Skip to content
v2.278.0

ModelQualityAppSpecificationProperty Struct ​

Container image configuration object for the monitoring job.

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';
const modelQualityAppSpecificationProperty: sagemaker.CfnModelQualityJobDefinition.ModelQualityAppSpecificationProperty = {
  imageUri: 'imageUri',
  problemType: 'problemType',

  // the properties below are optional
  containerArguments: ['containerArguments'],
  containerEntrypoint: ['containerEntrypoint'],
  environment: {
    environmentKey: 'environment',
  },
  postAnalyticsProcessorSourceUri: 'postAnalyticsProcessorSourceUri',
  recordPreprocessorSourceUri: 'recordPreprocessorSourceUri',
};
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

model_quality_app_specification_property = sagemaker.CfnModelQualityJobDefinition.ModelQualityAppSpecificationProperty(
    image_uri="imageUri",
    problem_type="problemType",

    # the properties below are optional
    container_arguments=["containerArguments"],
    container_entrypoint=["containerEntrypoint"],
    environment={
        "environment_key": "environment"
    },
    post_analytics_processor_source_uri="postAnalyticsProcessorSourceUri",
    record_preprocessor_source_uri="recordPreprocessorSourceUri"
)
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.*;

ModelQualityAppSpecificationProperty modelQualityAppSpecificationProperty = ModelQualityAppSpecificationProperty.builder()
        .imageUri("imageUri")
        .problemType("problemType")

        // the properties below are optional
        .containerArguments(List.of("containerArguments"))
        .containerEntrypoint(List.of("containerEntrypoint"))
        .environment(Map.of(
                "environmentKey", "environment"))
        .postAnalyticsProcessorSourceUri("postAnalyticsProcessorSourceUri")
        .recordPreprocessorSourceUri("recordPreprocessorSourceUri")
        .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 modelQualityAppSpecificationProperty = new ModelQualityAppSpecificationProperty {
    ImageUri = "imageUri",
    ProblemType = "problemType",

    // the properties below are optional
    ContainerArguments = new [] { "containerArguments" },
    ContainerEntrypoint = new [] { "containerEntrypoint" },
    Environment = new Dictionary<string, string> {
        { "environmentKey", "environment" }
    },
    PostAnalyticsProcessorSourceUri = "postAnalyticsProcessorSourceUri",
    RecordPreprocessorSourceUri = "recordPreprocessorSourceUri"
};
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"

modelQualityAppSpecificationProperty := &ModelQualityAppSpecificationProperty{
	ImageUri: jsii.String("imageUri"),
	ProblemType: jsii.String("problemType"),

	// the properties below are optional
	ContainerArguments: []*string{
		jsii.String("containerArguments"),
	},
	ContainerEntrypoint: []*string{
		jsii.String("containerEntrypoint"),
	},
	Environment: map[string]*string{
		"environmentKey": jsii.String("environment"),
	},
	PostAnalyticsProcessorSourceUri: jsii.String("postAnalyticsProcessorSourceUri"),
	RecordPreprocessorSourceUri: jsii.String("recordPreprocessorSourceUri"),
}

Properties ​

containerArgumentsoptionalstring[]container_argumentsoptionaltyping.List[str]containerArgumentsoptionalList<String>ContainerArgumentsoptionalstring[]ContainerArgumentsoptional*[]*string #
An array of arguments for the container used to run the monitoring job.
containerEntrypointoptionalstring[]container_entrypointoptionaltyping.List[str]containerEntrypointoptionalList<String>ContainerEntrypointoptionalstring[]ContainerEntrypointoptional*[]*string #
Specifies the entrypoint for a container that the monitoring job runs.
environmentoptionalIResolvable | { [key: string]: string }environmentoptionaltyping.Union[IResolvable, typing.Mapping[str, str]]environmentoptionalIResolvableEnvironmentoptionalIResolvableEnvironmentoptionalinterface{} #
Sets the environment variables in the container that the monitoring job runs.
imageUristringimage_uristrimageUriStringImageUristringImageUri*string required #
The address of the container image that the monitoring job runs.
postAnalyticsProcessorSourceUrioptionalstringpost_analytics_processor_source_urioptionalstrpostAnalyticsProcessorSourceUrioptionalStringPostAnalyticsProcessorSourceUrioptionalstringPostAnalyticsProcessorSourceUrioptional*string #
An Amazon S3 URI to a script that is called after analysis has been performed.

Applicable only for the built-in (first party) containers.

problemTypestringproblem_typestrproblemTypeStringProblemTypestringProblemType*string required #
The machine learning problem type of the model that the monitoring job monitors.
recordPreprocessorSourceUrioptionalstringrecord_preprocessor_source_urioptionalstrrecordPreprocessorSourceUrioptionalStringRecordPreprocessorSourceUrioptionalstringRecordPreprocessorSourceUrioptional*string #
An Amazon S3 URI to a script that is called per row prior to running analysis.

It can base64 decode the payload and convert it into a flattened JSON so that the built-in container can use the converted data. Applicable only for the built-in (first party) containers.