NAME

Paws::SageMaker::CreateModelExplainabilityJobDefinition - Arguments for method CreateModelExplainabilityJobDefinition on Paws::SageMaker

DESCRIPTION

This class represents the parameters used for calling the method CreateModelExplainabilityJobDefinition on the Amazon SageMaker Service service. Use the attributes of this class as arguments to method CreateModelExplainabilityJobDefinition.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateModelExplainabilityJobDefinition.

SYNOPSIS

my $api.sagemaker = Paws->service('SageMaker');
my $CreateModelExplainabilityJobDefinitionResponse =
  $api . sagemaker->CreateModelExplainabilityJobDefinition(
  JobDefinitionName => 'MyMonitoringJobDefinitionName',
  JobResources      => {
    ClusterConfig => {
      InstanceCount => 1,                # min: 1, max: 100
      InstanceType  => 'ml.t3.medium'
      , # values: ml.t3.medium, ml.t3.large, ml.t3.xlarge, ml.t3.2xlarge, ml.m4.xlarge, ml.m4.2xlarge, ml.m4.4xlarge, ml.m4.10xlarge, ml.m4.16xlarge, ml.c4.xlarge, ml.c4.2xlarge, ml.c4.4xlarge, ml.c4.8xlarge, ml.p2.xlarge, ml.p2.8xlarge, ml.p2.16xlarge, ml.p3.2xlarge, ml.p3.8xlarge, ml.p3.16xlarge, ml.c5.xlarge, ml.c5.2xlarge, ml.c5.4xlarge, ml.c5.9xlarge, ml.c5.18xlarge, ml.m5.large, ml.m5.xlarge, ml.m5.2xlarge, ml.m5.4xlarge, ml.m5.12xlarge, ml.m5.24xlarge, ml.r5.large, ml.r5.xlarge, ml.r5.2xlarge, ml.r5.4xlarge, ml.r5.8xlarge, ml.r5.12xlarge, ml.r5.16xlarge, ml.r5.24xlarge, ml.g4dn.xlarge, ml.g4dn.2xlarge, ml.g4dn.4xlarge, ml.g4dn.8xlarge, ml.g4dn.12xlarge, ml.g4dn.16xlarge
      VolumeSizeInGB => 1,               # min: 1, max: 16384
      VolumeKmsKeyId => 'MyKmsKeyId',    # max: 2048; OPTIONAL
    },

  },
  ModelExplainabilityAppSpecification => {
    ConfigUri   => 'MyS3Uri',       # max: 1024
    ImageUri    => 'MyImageUri',    # max: 255
    Environment => {
      'MyProcessingEnvironmentKey' =>
        'MyProcessingEnvironmentValue',    # key: max: 256, value: max: 256
    },    # max: 50; OPTIONAL
  },
  ModelExplainabilityJobInput => {
    EndpointInput => {
      EndpointName  => 'MyEndpointName',           # max: 63
      LocalPath     => 'MyProcessingLocalPath',    # max: 256
      EndTimeOffset =>
        'MyMonitoringTimeOffsetString',    # min: 1, max: 15; OPTIONAL
      FeaturesAttribute             => 'MyString',         # OPTIONAL
      InferenceAttribute            => 'MyString',         # OPTIONAL
      ProbabilityAttribute          => 'MyString',         # OPTIONAL
      ProbabilityThresholdAttribute => 1,                  # OPTIONAL
      S3DataDistributionType        => 'FullyReplicated'
      ,    # values: FullyReplicated, ShardedByS3Key; OPTIONAL
      S3InputMode     => 'Pipe',    # values: Pipe, File; OPTIONAL
      StartTimeOffset =>
        'MyMonitoringTimeOffsetString',    # min: 1, max: 15; OPTIONAL
    },

  },
  ModelExplainabilityJobOutputConfig => {
    MonitoringOutputs => [
      {
        S3Output => {
          LocalPath    => 'MyProcessingLocalPath',    # max: 256
          S3Uri        => 'MyMonitoringS3Uri',        # max: 512
          S3UploadMode =>
            'Continuous',    # values: Continuous, EndOfJob; OPTIONAL
        },

      },
      ...
    ],    # min: 1, max: 1
    KmsKeyId => 'MyKmsKeyId',    # max: 2048; OPTIONAL
  },
  RoleArn                           => 'MyRoleArn',
  ModelExplainabilityBaselineConfig => {
    BaseliningJobName => 'MyProcessingJobName',  # min: 1, max: 63; OPTIONAL
    ConstraintsResource => {
      S3Uri => 'MyS3Uri',                        # max: 1024
    },    # OPTIONAL
  },    # OPTIONAL
  NetworkConfig => {
    EnableInterContainerTrafficEncryption => 1,    # OPTIONAL
    EnableNetworkIsolation                => 1,    # OPTIONAL
    VpcConfig                             => {
      SecurityGroupIds => [
        'MySecurityGroupId', ...                   # max: 32
      ],    # min: 1, max: 5
      Subnets => [
        'MySubnetId', ...    # max: 32
      ],    # min: 1, max: 16

    },    # OPTIONAL
  },    # OPTIONAL
  StoppingCondition => {
    MaxRuntimeInSeconds => 1,    # min: 1, max: 86400

  },    # OPTIONAL
  Tags => [
    {
      Key   => 'MyTagKey',      # min: 1, max: 128
      Value => 'MyTagValue',    # max: 256

    },
    ...
  ],    # OPTIONAL
  );

# Results:
my $JobDefinitionArn =
  $CreateModelExplainabilityJobDefinitionResponse->JobDefinitionArn;

# Returns a Paws::SageMaker::CreateModelExplainabilityJobDefinitionResponse object.

Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/api.sagemaker/CreateModelExplainabilityJobDefinition

ATTRIBUTES

REQUIRED JobDefinitionName => Str

The name of the model explainability job definition. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.

REQUIRED JobResources => Paws::SageMaker::MonitoringResources

REQUIRED ModelExplainabilityAppSpecification => Paws::SageMaker::ModelExplainabilityAppSpecification

Configures the model explainability job to run a specified Docker container image.

ModelExplainabilityBaselineConfig => Paws::SageMaker::ModelExplainabilityBaselineConfig

The baseline configuration for a model explainability job.

REQUIRED ModelExplainabilityJobInput => Paws::SageMaker::ModelExplainabilityJobInput

Inputs for the model explainability job.

REQUIRED ModelExplainabilityJobOutputConfig => Paws::SageMaker::MonitoringOutputConfig

NetworkConfig => Paws::SageMaker::MonitoringNetworkConfig

Networking options for a model explainability job.

REQUIRED RoleArn => Str

The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.

StoppingCondition => Paws::SageMaker::MonitoringStoppingCondition

Tags => ArrayRef[Paws::SageMaker::Tag]

(Optional) An array of key-value pairs. For more information, see Using Cost Allocation Tags (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html#allocation-whatURL) in the Amazon Web Services Billing and Cost Management User Guide.

SEE ALSO

This class forms part of Paws, documenting arguments for method CreateModelExplainabilityJobDefinition in Paws::SageMaker

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues