« blib/lib/Paws/SageMaker/CreateModelQualityJobDefinitionResponse.pm
↑ Summary
blib/lib/Paws/SageMaker/CreateMonitoringScheduleResponse.pm »
| 1 | |||
| 2 | package Paws::SageMaker::CreateMonitoringSchedule; | ||
| 3 | use Moose; | ||
| 4 | has MonitoringScheduleConfig => (is => 'ro', isa => 'Paws::SageMaker::MonitoringScheduleConfig', required => 1); | ||
| 5 | has MonitoringScheduleName => (is => 'ro', isa => 'Str', required => 1); | ||
| 6 | has Tags => (is => 'ro', isa => 'ArrayRef[Paws::SageMaker::Tag]'); | ||
| 7 | |||
| 8 | use MooseX::ClassAttribute; | ||
| 9 | |||
| 10 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateMonitoringSchedule'); | ||
| 11 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::SageMaker::CreateMonitoringScheduleResponse'); | ||
| 12 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 13 | 1; | ||
| 14 | |||
| 15 | ### main pod documentation begin ### | ||
| 16 | |||
| 17 | =head1 NAME | ||
| 18 | |||
| 19 | Paws::SageMaker::CreateMonitoringSchedule - Arguments for method CreateMonitoringSchedule on L<Paws::SageMaker> | ||
| 20 | |||
| 21 | =head1 DESCRIPTION | ||
| 22 | |||
| 23 | This class represents the parameters used for calling the method CreateMonitoringSchedule on the | ||
| 24 | L<Amazon SageMaker Service|Paws::SageMaker> service. Use the attributes of this class | ||
| 25 | as arguments to method CreateMonitoringSchedule. | ||
| 26 | |||
| 27 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateMonitoringSchedule. | ||
| 28 | |||
| 29 | =head1 SYNOPSIS | ||
| 30 | |||
| 31 | my $api.sagemaker = Paws->service('SageMaker'); | ||
| 32 | my $CreateMonitoringScheduleResponse = | ||
| 33 | $api . sagemaker->CreateMonitoringSchedule( | ||
| 34 | MonitoringScheduleConfig => { | ||
| 35 | MonitoringJobDefinition => { | ||
| 36 | MonitoringAppSpecification => { | ||
| 37 | ImageUri => 'MyImageUri', # max: 255 | ||
| 38 | ContainerArguments => [ | ||
| 39 | 'MyContainerArgument', ... # max: 256 | ||
| 40 | ], # min: 1, max: 50; OPTIONAL | ||
| 41 | ContainerEntrypoint => [ | ||
| 42 | 'MyContainerEntrypointString', ... # max: 256 | ||
| 43 | ], # min: 1, max: 100; OPTIONAL | ||
| 44 | PostAnalyticsProcessorSourceUri => 'MyS3Uri', # max: 1024; OPTIONAL | ||
| 45 | RecordPreprocessorSourceUri => 'MyS3Uri', # max: 1024; OPTIONAL | ||
| 46 | }, | ||
| 47 | MonitoringInputs => [ | ||
| 48 | { | ||
| 49 | EndpointInput => { | ||
| 50 | EndpointName => 'MyEndpointName', # max: 63 | ||
| 51 | LocalPath => 'MyProcessingLocalPath', # max: 256 | ||
| 52 | EndTimeOffset => | ||
| 53 | 'MyMonitoringTimeOffsetString', # min: 1, max: 15; OPTIONAL | ||
| 54 | FeaturesAttribute => 'MyString', # OPTIONAL | ||
| 55 | InferenceAttribute => 'MyString', # OPTIONAL | ||
| 56 | ProbabilityAttribute => 'MyString', # OPTIONAL | ||
| 57 | ProbabilityThresholdAttribute => 1, # OPTIONAL | ||
| 58 | S3DataDistributionType => 'FullyReplicated' | ||
| 59 | , # values: FullyReplicated, ShardedByS3Key; OPTIONAL | ||
| 60 | S3InputMode => 'Pipe', # values: Pipe, File; OPTIONAL | ||
| 61 | StartTimeOffset => | ||
| 62 | 'MyMonitoringTimeOffsetString', # min: 1, max: 15; OPTIONAL | ||
| 63 | }, | ||
| 64 | |||
| 65 | }, | ||
| 66 | ... | ||
| 67 | ], # min: 1, max: 1 | ||
| 68 | MonitoringOutputConfig => { | ||
| 69 | MonitoringOutputs => [ | ||
| 70 | { | ||
| 71 | S3Output => { | ||
| 72 | LocalPath => 'MyProcessingLocalPath', # max: 256 | ||
| 73 | S3Uri => 'MyMonitoringS3Uri', # max: 512 | ||
| 74 | S3UploadMode => | ||
| 75 | 'Continuous', # values: Continuous, EndOfJob; OPTIONAL | ||
| 76 | }, | ||
| 77 | |||
| 78 | }, | ||
| 79 | ... | ||
| 80 | ], # min: 1, max: 1 | ||
| 81 | KmsKeyId => 'MyKmsKeyId', # max: 2048; OPTIONAL | ||
| 82 | }, | ||
| 83 | MonitoringResources => { | ||
| 84 | ClusterConfig => { | ||
| 85 | InstanceCount => 1, # min: 1, max: 100 | ||
| 86 | InstanceType => 'ml.t3.medium' | ||
| 87 | , # 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 | ||
| 88 | VolumeSizeInGB => 1, # min: 1, max: 16384 | ||
| 89 | VolumeKmsKeyId => 'MyKmsKeyId', # max: 2048; OPTIONAL | ||
| 90 | }, | ||
| 91 | |||
| 92 | }, | ||
| 93 | RoleArn => 'MyRoleArn', # min: 20, max: 2048 | ||
| 94 | BaselineConfig => { | ||
| 95 | BaseliningJobName => | ||
| 96 | 'MyProcessingJobName', # min: 1, max: 63; OPTIONAL | ||
| 97 | ConstraintsResource => { | ||
| 98 | S3Uri => 'MyS3Uri', # max: 1024; OPTIONAL | ||
| 99 | }, # OPTIONAL | ||
| 100 | StatisticsResource => { | ||
| 101 | S3Uri => 'MyS3Uri', # max: 1024; OPTIONAL | ||
| 102 | }, # OPTIONAL | ||
| 103 | }, # OPTIONAL | ||
| 104 | Environment => { | ||
| 105 | 'MyProcessingEnvironmentKey' => | ||
| 106 | 'MyProcessingEnvironmentValue', # key: max: 256, value: max: 256 | ||
| 107 | }, # max: 50; OPTIONAL | ||
| 108 | NetworkConfig => { | ||
| 109 | EnableInterContainerTrafficEncryption => 1, # OPTIONAL | ||
| 110 | EnableNetworkIsolation => 1, # OPTIONAL | ||
| 111 | VpcConfig => { | ||
| 112 | SecurityGroupIds => [ | ||
| 113 | 'MySecurityGroupId', ... # max: 32 | ||
| 114 | ], # min: 1, max: 5 | ||
| 115 | Subnets => [ | ||
| 116 | 'MySubnetId', ... # max: 32 | ||
| 117 | ], # min: 1, max: 16 | ||
| 118 | |||
| 119 | }, # OPTIONAL | ||
| 120 | }, # OPTIONAL | ||
| 121 | StoppingCondition => { | ||
| 122 | MaxRuntimeInSeconds => 1, # min: 1, max: 86400 | ||
| 123 | |||
| 124 | }, # OPTIONAL | ||
| 125 | }, # OPTIONAL | ||
| 126 | MonitoringJobDefinitionName => | ||
| 127 | 'MyMonitoringJobDefinitionName', # min: 1, max: 63; OPTIONAL | ||
| 128 | MonitoringType => 'DataQuality' | ||
| 129 | , # values: DataQuality, ModelQuality, ModelBias, ModelExplainability; OPTIONAL | ||
| 130 | ScheduleConfig => { | ||
| 131 | ScheduleExpression => 'MyScheduleExpression', # min: 1, max: 256 | ||
| 132 | |||
| 133 | }, # OPTIONAL | ||
| 134 | }, | ||
| 135 | MonitoringScheduleName => 'MyMonitoringScheduleName', | ||
| 136 | Tags => [ | ||
| 137 | { | ||
| 138 | Key => 'MyTagKey', # min: 1, max: 128 | ||
| 139 | Value => 'MyTagValue', # max: 256 | ||
| 140 | |||
| 141 | }, | ||
| 142 | ... | ||
| 143 | ], # OPTIONAL | ||
| 144 | ); | ||
| 145 | |||
| 146 | # Results: | ||
| 147 | my $MonitoringScheduleArn = | ||
| 148 | $CreateMonitoringScheduleResponse->MonitoringScheduleArn; | ||
| 149 | |||
| 150 | # Returns a L<Paws::SageMaker::CreateMonitoringScheduleResponse> object. | ||
| 151 | |||
| 152 | 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. | ||
| 153 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/api.sagemaker/CreateMonitoringSchedule> | ||
| 154 | |||
| 155 | =head1 ATTRIBUTES | ||
| 156 | |||
| 157 | |||
| 158 | =head2 B<REQUIRED> MonitoringScheduleConfig => L<Paws::SageMaker::MonitoringScheduleConfig> | ||
| 159 | |||
| 160 | The configuration object that specifies the monitoring schedule and | ||
| 161 | defines the monitoring job. | ||
| 162 | |||
| 163 | |||
| 164 | |||
| 165 | =head2 B<REQUIRED> MonitoringScheduleName => Str | ||
| 166 | |||
| 167 | The name of the monitoring schedule. The name must be unique within an | ||
| 168 | Amazon Web Services Region within an Amazon Web Services account. | ||
| 169 | |||
| 170 | |||
| 171 | |||
| 172 | =head2 Tags => ArrayRef[L<Paws::SageMaker::Tag>] | ||
| 173 | |||
| 174 | (Optional) An array of key-value pairs. For more information, see Using | ||
| 175 | Cost Allocation Tags in the I<Amazon Web Services Billing and Cost | ||
| 176 | Management User Guide>. | ||
| 177 | |||
| 178 | |||
| 179 | |||
| 180 | |||
| 181 | =head1 SEE ALSO | ||
| 182 | |||
| 183 | This class forms part of L<Paws>, documenting arguments for method CreateMonitoringSchedule in L<Paws::SageMaker> | ||
| 184 | |||
| 185 | =head1 BUGS and CONTRIBUTIONS | ||
| 186 | |||
| 187 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 188 | |||
| 189 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 190 | |||
| 191 | =cut | ||
| 192 |