blib/lib/Paws/SageMaker/CreateModelExplainabilityJobDefinition.pm untested

filter: Statementstmt 0.0% 0 / 19 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 2 Podpod n/a totaltotal 0.0% 0 / 21 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
BEGIN
2.0
CRAP 2.0
1  
2 package Paws::SageMaker::CreateModelExplainabilityJobDefinition;
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 ModelExplainabilityAppSpecification => (is => 'ro', isa => 'Paws::SageMaker::ModelExplainabilityAppSpecification', required => 1);
7 has ModelExplainabilityBaselineConfig => (is => 'ro', isa => 'Paws::SageMaker::ModelExplainabilityBaselineConfig');
8 has ModelExplainabilityJobInput => (is => 'ro', isa => 'Paws::SageMaker::ModelExplainabilityJobInput', required => 1);
9 has ModelExplainabilityJobOutputConfig => (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 => 'CreateModelExplainabilityJobDefinition');
18 class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::SageMaker::CreateModelExplainabilityJobDefinitionResponse');
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::CreateModelExplainabilityJobDefinition - Arguments for method CreateModelExplainabilityJobDefinition on L<Paws::SageMaker>
27  
28 =head1 DESCRIPTION
29  
30 This class represents the parameters used for calling the method CreateModelExplainabilityJobDefinition on the
31 L<Amazon SageMaker Service|Paws::SageMaker> service. Use the attributes of this class
32 as arguments to method CreateModelExplainabilityJobDefinition.
33  
34 You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateModelExplainabilityJobDefinition.
35  
36 =head1 SYNOPSIS
37  
38 my $api.sagemaker = Paws->service('SageMaker');
39 my $CreateModelExplainabilityJobDefinitionResponse =
40 $api . sagemaker->CreateModelExplainabilityJobDefinition(
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 ModelExplainabilityAppSpecification => {
53 ConfigUri => 'MyS3Uri', # max: 1024
54 ImageUri => 'MyImageUri', # max: 255
55 Environment => {
56 'MyProcessingEnvironmentKey' =>
57 'MyProcessingEnvironmentValue', # key: max: 256, value: max: 256
58 }, # max: 50; OPTIONAL
59 },
60 ModelExplainabilityJobInput => {
61 EndpointInput => {
62 EndpointName => 'MyEndpointName', # max: 63
63 LocalPath => 'MyProcessingLocalPath', # max: 256
64 EndTimeOffset =>
65 'MyMonitoringTimeOffsetString', # min: 1, max: 15; OPTIONAL
66 FeaturesAttribute => 'MyString', # OPTIONAL
67 InferenceAttribute => 'MyString', # OPTIONAL
68 ProbabilityAttribute => 'MyString', # OPTIONAL
69 ProbabilityThresholdAttribute => 1, # OPTIONAL
70 S3DataDistributionType => 'FullyReplicated'
71 , # values: FullyReplicated, ShardedByS3Key; OPTIONAL
72 S3InputMode => 'Pipe', # values: Pipe, File; OPTIONAL
73 StartTimeOffset =>
74 'MyMonitoringTimeOffsetString', # min: 1, max: 15; OPTIONAL
75 },
76  
77 },
78 ModelExplainabilityJobOutputConfig => {
79 MonitoringOutputs => [
80 {
81 S3Output => {
82 LocalPath => 'MyProcessingLocalPath', # max: 256
83 S3Uri => 'MyMonitoringS3Uri', # max: 512
84 S3UploadMode =>
85 'Continuous', # values: Continuous, EndOfJob; OPTIONAL
86 },
87  
88 },
89 ...
90 ], # min: 1, max: 1
91 KmsKeyId => 'MyKmsKeyId', # max: 2048; OPTIONAL
92 },
93 RoleArn => 'MyRoleArn',
94 ModelExplainabilityBaselineConfig => {
95 BaseliningJobName => 'MyProcessingJobName', # min: 1, max: 63; OPTIONAL
96 ConstraintsResource => {
97 S3Uri => 'MyS3Uri', # max: 1024
98 }, # OPTIONAL
99 }, # OPTIONAL
100 NetworkConfig => {
101 EnableInterContainerTrafficEncryption => 1, # OPTIONAL
102 EnableNetworkIsolation => 1, # OPTIONAL
103 VpcConfig => {
104 SecurityGroupIds => [
105 'MySecurityGroupId', ... # max: 32
106 ], # min: 1, max: 5
107 Subnets => [
108 'MySubnetId', ... # max: 32
109 ], # min: 1, max: 16
110  
111 }, # OPTIONAL
112 }, # OPTIONAL
113 StoppingCondition => {
114 MaxRuntimeInSeconds => 1, # min: 1, max: 86400
115  
116 }, # OPTIONAL
117 Tags => [
118 {
119 Key => 'MyTagKey', # min: 1, max: 128
120 Value => 'MyTagValue', # max: 256
121  
122 },
123 ...
124 ], # OPTIONAL
125 );
126  
127 # Results:
128 my $JobDefinitionArn =
129 $CreateModelExplainabilityJobDefinitionResponse->JobDefinitionArn;
130  
131 # Returns a L<Paws::SageMaker::CreateModelExplainabilityJobDefinitionResponse> object.
132  
133 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.
134 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/api.sagemaker/CreateModelExplainabilityJobDefinition>
135  
136 =head1 ATTRIBUTES
137  
138  
139 =head2 B<REQUIRED> JobDefinitionName => Str
140  
141 The name of the model explainability job definition. The name must be
142 unique within an Amazon Web Services Region in the Amazon Web Services
143 account.
144  
145  
146  
147 =head2 B<REQUIRED> JobResources => L<Paws::SageMaker::MonitoringResources>
148  
149  
150  
151  
152  
153 =head2 B<REQUIRED> ModelExplainabilityAppSpecification => L<Paws::SageMaker::ModelExplainabilityAppSpecification>
154  
155 Configures the model explainability job to run a specified Docker
156 container image.
157  
158  
159  
160 =head2 ModelExplainabilityBaselineConfig => L<Paws::SageMaker::ModelExplainabilityBaselineConfig>
161  
162 The baseline configuration for a model explainability job.
163  
164  
165  
166 =head2 B<REQUIRED> ModelExplainabilityJobInput => L<Paws::SageMaker::ModelExplainabilityJobInput>
167  
168 Inputs for the model explainability job.
169  
170  
171  
172 =head2 B<REQUIRED> ModelExplainabilityJobOutputConfig => L<Paws::SageMaker::MonitoringOutputConfig>
173  
174  
175  
176  
177  
178 =head2 NetworkConfig => L<Paws::SageMaker::MonitoringNetworkConfig>
179  
180 Networking options for a model explainability job.
181  
182  
183  
184 =head2 B<REQUIRED> RoleArn => Str
185  
186 The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can
187 assume to perform tasks on your behalf.
188  
189  
190  
191 =head2 StoppingCondition => L<Paws::SageMaker::MonitoringStoppingCondition>
192  
193  
194  
195  
196  
197 =head2 Tags => ArrayRef[L<Paws::SageMaker::Tag>]
198  
199 (Optional) An array of key-value pairs. For more information, see Using
200 Cost Allocation Tags
201 (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html#allocation-whatURL)
202 in the I<Amazon Web Services Billing and Cost Management User Guide>.
203  
204  
205  
206  
207 =head1 SEE ALSO
208  
209 This class forms part of L<Paws>, documenting arguments for method CreateModelExplainabilityJobDefinition in L<Paws::SageMaker>
210  
211 =head1 BUGS and CONTRIBUTIONS
212  
213 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
214  
215 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
216  
217 =cut
218