« blib/lib/Paws/SageMaker/CreateModelPackageOutput.pm
↑ Summary
blib/lib/Paws/SageMaker/CreateModelQualityJobDefinitionResponse.pm »
| 1 | |||
| 2 | package Paws::SageMaker::CreateModelQualityJobDefinition; | ||
| 3 | use Moose; | ||
| 4 | has JobDefinitionName => (is => 'ro', isa => 'Str', required => 1); | ||
| 5 | has JobResources => (is => 'ro', isa => 'Paws::SageMaker::MonitoringResources', required => 1); | ||
| 6 | has ModelQualityAppSpecification => (is => 'ro', isa => 'Paws::SageMaker::ModelQualityAppSpecification', required => 1); | ||
| 7 | has ModelQualityBaselineConfig => (is => 'ro', isa => 'Paws::SageMaker::ModelQualityBaselineConfig'); | ||
| 8 | has ModelQualityJobInput => (is => 'ro', isa => 'Paws::SageMaker::ModelQualityJobInput', required => 1); | ||
| 9 | has ModelQualityJobOutputConfig => (is => 'ro', isa => 'Paws::SageMaker::MonitoringOutputConfig', required => 1); | ||
| 10 | has NetworkConfig => (is => 'ro', isa => 'Paws::SageMaker::MonitoringNetworkConfig'); | ||
| 11 | has RoleArn => (is => 'ro', isa => 'Str', required => 1); | ||
| 12 | has StoppingCondition => (is => 'ro', isa => 'Paws::SageMaker::MonitoringStoppingCondition'); | ||
| 13 | has Tags => (is => 'ro', isa => 'ArrayRef[Paws::SageMaker::Tag]'); | ||
| 14 | |||
| 15 | use MooseX::ClassAttribute; | ||
| 16 | |||
| 17 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateModelQualityJobDefinition'); | ||
| 18 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::SageMaker::CreateModelQualityJobDefinitionResponse'); | ||
| 19 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 20 | 1; | ||
| 21 | |||
| 22 | ### main pod documentation begin ### | ||
| 23 | |||
| 24 | =head1 NAME | ||
| 25 | |||
| 26 | Paws::SageMaker::CreateModelQualityJobDefinition - Arguments for method CreateModelQualityJobDefinition on L<Paws::SageMaker> | ||
| 27 | |||
| 28 | =head1 DESCRIPTION | ||
| 29 | |||
| 30 | This class represents the parameters used for calling the method CreateModelQualityJobDefinition on the | ||
| 31 | L<Amazon SageMaker Service|Paws::SageMaker> service. Use the attributes of this class | ||
| 32 | as arguments to method CreateModelQualityJobDefinition. | ||
| 33 | |||
| 34 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateModelQualityJobDefinition. | ||
| 35 | |||
| 36 | =head1 SYNOPSIS | ||
| 37 | |||
| 38 | my $api.sagemaker = Paws->service('SageMaker'); | ||
| 39 | my $CreateModelQualityJobDefinitionResponse = | ||
| 40 | $api . sagemaker->CreateModelQualityJobDefinition( | ||
| 41 | JobDefinitionName => 'MyMonitoringJobDefinitionName', | ||
| 42 | JobResources => { | ||
| 43 | ClusterConfig => { | ||
| 44 | InstanceCount => 1, # min: 1, max: 100 | ||
| 45 | InstanceType => 'ml.t3.medium' | ||
| 46 | , # 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 | ||
| 47 | VolumeSizeInGB => 1, # min: 1, max: 16384 | ||
| 48 | VolumeKmsKeyId => 'MyKmsKeyId', # max: 2048; OPTIONAL | ||
| 49 | }, | ||
| 50 | |||
| 51 | }, | ||
| 52 | ModelQualityAppSpecification => { | ||
| 53 | ImageUri => 'MyImageUri', # max: 255 | ||
| 54 | ContainerArguments => [ | ||
| 55 | 'MyContainerArgument', ... # max: 256 | ||
| 56 | ], # min: 1, max: 50; OPTIONAL | ||
| 57 | ContainerEntrypoint => [ | ||
| 58 | 'MyContainerEntrypointString', ... # max: 256 | ||
| 59 | ], # min: 1, max: 100; OPTIONAL | ||
| 60 | Environment => { | ||
| 61 | 'MyProcessingEnvironmentKey' => | ||
| 62 | 'MyProcessingEnvironmentValue', # key: max: 256, value: max: 256 | ||
| 63 | }, # max: 50; OPTIONAL | ||
| 64 | PostAnalyticsProcessorSourceUri => 'MyS3Uri', # max: 1024; OPTIONAL | ||
| 65 | ProblemType => 'BinaryClassification' | ||
| 66 | , # values: BinaryClassification, MulticlassClassification, Regression; OPTIONAL | ||
| 67 | RecordPreprocessorSourceUri => 'MyS3Uri', # max: 1024; OPTIONAL | ||
| 68 | }, | ||
| 69 | ModelQualityJobInput => { | ||
| 70 | EndpointInput => { | ||
| 71 | EndpointName => 'MyEndpointName', # max: 63 | ||
| 72 | LocalPath => 'MyProcessingLocalPath', # max: 256 | ||
| 73 | EndTimeOffset => | ||
| 74 | 'MyMonitoringTimeOffsetString', # min: 1, max: 15; OPTIONAL | ||
| 75 | FeaturesAttribute => 'MyString', # OPTIONAL | ||
| 76 | InferenceAttribute => 'MyString', # OPTIONAL | ||
| 77 | ProbabilityAttribute => 'MyString', # OPTIONAL | ||
| 78 | ProbabilityThresholdAttribute => 1, # OPTIONAL | ||
| 79 | S3DataDistributionType => 'FullyReplicated' | ||
| 80 | , # values: FullyReplicated, ShardedByS3Key; OPTIONAL | ||
| 81 | S3InputMode => 'Pipe', # values: Pipe, File; OPTIONAL | ||
| 82 | StartTimeOffset => | ||
| 83 | 'MyMonitoringTimeOffsetString', # min: 1, max: 15; OPTIONAL | ||
| 84 | }, | ||
| 85 | GroundTruthS3Input => { | ||
| 86 | S3Uri => 'MyMonitoringS3Uri', # max: 512; OPTIONAL | ||
| 87 | }, | ||
| 88 | |||
| 89 | }, | ||
| 90 | ModelQualityJobOutputConfig => { | ||
| 91 | MonitoringOutputs => [ | ||
| 92 | { | ||
| 93 | S3Output => { | ||
| 94 | LocalPath => 'MyProcessingLocalPath', # max: 256 | ||
| 95 | S3Uri => 'MyMonitoringS3Uri', # max: 512; OPTIONAL | ||
| 96 | S3UploadMode => | ||
| 97 | 'Continuous', # values: Continuous, EndOfJob; OPTIONAL | ||
| 98 | }, | ||
| 99 | |||
| 100 | }, | ||
| 101 | ... | ||
| 102 | ], # min: 1, max: 1 | ||
| 103 | KmsKeyId => 'MyKmsKeyId', # max: 2048; OPTIONAL | ||
| 104 | }, | ||
| 105 | RoleArn => 'MyRoleArn', | ||
| 106 | ModelQualityBaselineConfig => { | ||
| 107 | BaseliningJobName => 'MyProcessingJobName', # min: 1, max: 63; OPTIONAL | ||
| 108 | ConstraintsResource => { | ||
| 109 | S3Uri => 'MyS3Uri', # max: 1024; OPTIONAL | ||
| 110 | }, # OPTIONAL | ||
| 111 | }, # OPTIONAL | ||
| 112 | NetworkConfig => { | ||
| 113 | EnableInterContainerTrafficEncryption => 1, # OPTIONAL | ||
| 114 | EnableNetworkIsolation => 1, # OPTIONAL | ||
| 115 | VpcConfig => { | ||
| 116 | SecurityGroupIds => [ | ||
| 117 | 'MySecurityGroupId', ... # max: 32 | ||
| 118 | ], # min: 1, max: 5 | ||
| 119 | Subnets => [ | ||
| 120 | 'MySubnetId', ... # max: 32 | ||
| 121 | ], # min: 1, max: 16 | ||
| 122 | |||
| 123 | }, # OPTIONAL | ||
| 124 | }, # OPTIONAL | ||
| 125 | StoppingCondition => { | ||
| 126 | MaxRuntimeInSeconds => 1, # min: 1, max: 86400 | ||
| 127 | |||
| 128 | }, # OPTIONAL | ||
| 129 | Tags => [ | ||
| 130 | { | ||
| 131 | Key => 'MyTagKey', # min: 1, max: 128 | ||
| 132 | Value => 'MyTagValue', # max: 256 | ||
| 133 | |||
| 134 | }, | ||
| 135 | ... | ||
| 136 | ], # OPTIONAL | ||
| 137 | ); | ||
| 138 | |||
| 139 | # Results: | ||
| 140 | my $JobDefinitionArn = | ||
| 141 | $CreateModelQualityJobDefinitionResponse->JobDefinitionArn; | ||
| 142 | |||
| 143 | # Returns a L<Paws::SageMaker::CreateModelQualityJobDefinitionResponse> object. | ||
| 144 | |||
| 145 | 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. | ||
| 146 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/api.sagemaker/CreateModelQualityJobDefinition> | ||
| 147 | |||
| 148 | =head1 ATTRIBUTES | ||
| 149 | |||
| 150 | |||
| 151 | =head2 B<REQUIRED> JobDefinitionName => Str | ||
| 152 | |||
| 153 | The name of the monitoring job definition. | ||
| 154 | |||
| 155 | |||
| 156 | |||
| 157 | =head2 B<REQUIRED> JobResources => L<Paws::SageMaker::MonitoringResources> | ||
| 158 | |||
| 159 | |||
| 160 | |||
| 161 | |||
| 162 | |||
| 163 | =head2 B<REQUIRED> ModelQualityAppSpecification => L<Paws::SageMaker::ModelQualityAppSpecification> | ||
| 164 | |||
| 165 | The container that runs the monitoring job. | ||
| 166 | |||
| 167 | |||
| 168 | |||
| 169 | =head2 ModelQualityBaselineConfig => L<Paws::SageMaker::ModelQualityBaselineConfig> | ||
| 170 | |||
| 171 | Specifies the constraints and baselines for the monitoring job. | ||
| 172 | |||
| 173 | |||
| 174 | |||
| 175 | =head2 B<REQUIRED> ModelQualityJobInput => L<Paws::SageMaker::ModelQualityJobInput> | ||
| 176 | |||
| 177 | A list of the inputs that are monitored. Currently endpoints are | ||
| 178 | supported. | ||
| 179 | |||
| 180 | |||
| 181 | |||
| 182 | =head2 B<REQUIRED> ModelQualityJobOutputConfig => L<Paws::SageMaker::MonitoringOutputConfig> | ||
| 183 | |||
| 184 | |||
| 185 | |||
| 186 | |||
| 187 | |||
| 188 | =head2 NetworkConfig => L<Paws::SageMaker::MonitoringNetworkConfig> | ||
| 189 | |||
| 190 | Specifies the network configuration for the monitoring job. | ||
| 191 | |||
| 192 | |||
| 193 | |||
| 194 | =head2 B<REQUIRED> RoleArn => Str | ||
| 195 | |||
| 196 | The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can | ||
| 197 | assume to perform tasks on your behalf. | ||
| 198 | |||
| 199 | |||
| 200 | |||
| 201 | =head2 StoppingCondition => L<Paws::SageMaker::MonitoringStoppingCondition> | ||
| 202 | |||
| 203 | |||
| 204 | |||
| 205 | |||
| 206 | |||
| 207 | =head2 Tags => ArrayRef[L<Paws::SageMaker::Tag>] | ||
| 208 | |||
| 209 | (Optional) An array of key-value pairs. For more information, see Using | ||
| 210 | Cost Allocation Tags | ||
| 211 | (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html#allocation-whatURL) | ||
| 212 | in the I<Amazon Web Services Billing and Cost Management User Guide>. | ||
| 213 | |||
| 214 | |||
| 215 | |||
| 216 | |||
| 217 | =head1 SEE ALSO | ||
| 218 | |||
| 219 | This class forms part of L<Paws>, documenting arguments for method CreateModelQualityJobDefinition in L<Paws::SageMaker> | ||
| 220 | |||
| 221 | =head1 BUGS and CONTRIBUTIONS | ||
| 222 | |||
| 223 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 224 | |||
| 225 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 226 | |||
| 227 | =cut | ||
| 228 |