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

filter: Statementstmt 0.0% 0 / 21 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 2 Podpod n/a totaltotal 0.0% 0 / 23 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
BEGIN
2.0
CRAP 2.0
1  
2 package Paws::SageMaker::CreateModelPackage;
3 use Moose;
4 has CertifyForMarketplace => (is => 'ro', isa => 'Bool');
5 has ClientToken => (is => 'ro', isa => 'Str');
6 has InferenceSpecification => (is => 'ro', isa => 'Paws::SageMaker::InferenceSpecification');
7 has MetadataProperties => (is => 'ro', isa => 'Paws::SageMaker::MetadataProperties');
8 has ModelApprovalStatus => (is => 'ro', isa => 'Str');
9 has ModelMetrics => (is => 'ro', isa => 'Paws::SageMaker::ModelMetrics');
10 has ModelPackageDescription => (is => 'ro', isa => 'Str');
11 has ModelPackageGroupName => (is => 'ro', isa => 'Str');
12 has ModelPackageName => (is => 'ro', isa => 'Str');
13 has SourceAlgorithmSpecification => (is => 'ro', isa => 'Paws::SageMaker::SourceAlgorithmSpecification');
14 has Tags => (is => 'ro', isa => 'ArrayRef[Paws::SageMaker::Tag]');
15 has ValidationSpecification => (is => 'ro', isa => 'Paws::SageMaker::ModelPackageValidationSpecification');
16  
17 use MooseX::ClassAttribute;
18  
19 class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateModelPackage');
20 class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::SageMaker::CreateModelPackageOutput');
21 class_has _result_key => (isa => 'Str', is => 'ro');
22 1;
23  
24 ### main pod documentation begin ###
25  
26 =head1 NAME
27  
28 Paws::SageMaker::CreateModelPackage - Arguments for method CreateModelPackage on L<Paws::SageMaker>
29  
30 =head1 DESCRIPTION
31  
32 This class represents the parameters used for calling the method CreateModelPackage on the
33 L<Amazon SageMaker Service|Paws::SageMaker> service. Use the attributes of this class
34 as arguments to method CreateModelPackage.
35  
36 You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateModelPackage.
37  
38 =head1 SYNOPSIS
39  
40 my $api.sagemaker = Paws->service('SageMaker');
41 my $CreateModelPackageOutput = $api . sagemaker->CreateModelPackage(
42 CertifyForMarketplace => 1, # OPTIONAL
43 ClientToken => 'MyClientToken', # OPTIONAL
44 InferenceSpecification => {
45 Containers => [
46 {
47 Image => 'MyContainerImage', # max: 255
48 ContainerHostname => 'MyContainerHostname', # max: 63; OPTIONAL
49 Environment => {
50 'MyEnvironmentKey' =>
51 'MyEnvironmentValue', # key: max: 1024, value: max: 1024
52 }, # max: 16; OPTIONAL
53 ImageDigest => 'MyImageDigest', # max: 72; OPTIONAL
54 ModelDataUrl => 'MyUrl', # max: 1024; OPTIONAL
55 ProductId => 'MyProductId', # max: 256; OPTIONAL
56 },
57 ...
58 ], # min: 1, max: 5
59 SupportedContentTypes => [
60 'MyContentType', ... # max: 256
61 ],
62 SupportedResponseMIMETypes => [
63 'MyResponseMIMEType', ... # max: 1024
64 ],
65 SupportedRealtimeInferenceInstanceTypes => [
66 'ml.t2.medium',
67 ... # values: ml.t2.medium, ml.t2.large, ml.t2.xlarge, ml.t2.2xlarge, ml.m4.xlarge, ml.m4.2xlarge, ml.m4.4xlarge, ml.m4.10xlarge, ml.m4.16xlarge, ml.m5.large, ml.m5.xlarge, ml.m5.2xlarge, ml.m5.4xlarge, ml.m5.12xlarge, ml.m5.24xlarge, ml.m5d.large, ml.m5d.xlarge, ml.m5d.2xlarge, ml.m5d.4xlarge, ml.m5d.12xlarge, ml.m5d.24xlarge, ml.c4.large, 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.large, ml.c5.xlarge, ml.c5.2xlarge, ml.c5.4xlarge, ml.c5.9xlarge, ml.c5.18xlarge, ml.c5d.large, ml.c5d.xlarge, ml.c5d.2xlarge, ml.c5d.4xlarge, ml.c5d.9xlarge, ml.c5d.18xlarge, ml.g4dn.xlarge, ml.g4dn.2xlarge, ml.g4dn.4xlarge, ml.g4dn.8xlarge, ml.g4dn.12xlarge, ml.g4dn.16xlarge, ml.r5.large, ml.r5.xlarge, ml.r5.2xlarge, ml.r5.4xlarge, ml.r5.12xlarge, ml.r5.24xlarge, ml.r5d.large, ml.r5d.xlarge, ml.r5d.2xlarge, ml.r5d.4xlarge, ml.r5d.12xlarge, ml.r5d.24xlarge, ml.inf1.xlarge, ml.inf1.2xlarge, ml.inf1.6xlarge, ml.inf1.24xlarge
68 ], # OPTIONAL
69 SupportedTransformInstanceTypes => [
70 'ml.m4.xlarge',
71 ... # values: 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.g4dn.xlarge, ml.g4dn.2xlarge, ml.g4dn.4xlarge, ml.g4dn.8xlarge, ml.g4dn.12xlarge, ml.g4dn.16xlarge
72 ], # min: 1; OPTIONAL
73 }, # OPTIONAL
74 MetadataProperties => {
75 CommitId => 'MyMetadataPropertyValue', # max: 1024; OPTIONAL
76 GeneratedBy => 'MyMetadataPropertyValue', # max: 1024; OPTIONAL
77 ProjectId => 'MyMetadataPropertyValue', # max: 1024; OPTIONAL
78 Repository => 'MyMetadataPropertyValue', # max: 1024; OPTIONAL
79 }, # OPTIONAL
80 ModelApprovalStatus => 'Approved', # OPTIONAL
81 ModelMetrics => {
82 Bias => {
83 Report => {
84 ContentType => 'MyContentType', # max: 256
85 S3Uri => 'MyS3Uri', # max: 1024
86 ContentDigest => 'MyContentDigest', # max: 72; OPTIONAL
87 }, # OPTIONAL
88 }, # OPTIONAL
89 Explainability => {
90 Report => {
91 ContentType => 'MyContentType', # max: 256
92 S3Uri => 'MyS3Uri', # max: 1024
93 ContentDigest => 'MyContentDigest', # max: 72; OPTIONAL
94 }, # OPTIONAL
95 }, # OPTIONAL
96 ModelDataQuality => {
97 Constraints => {
98 ContentType => 'MyContentType', # max: 256
99 S3Uri => 'MyS3Uri', # max: 1024
100 ContentDigest => 'MyContentDigest', # max: 72; OPTIONAL
101 }, # OPTIONAL
102 Statistics => {
103 ContentType => 'MyContentType', # max: 256
104 S3Uri => 'MyS3Uri', # max: 1024
105 ContentDigest => 'MyContentDigest', # max: 72; OPTIONAL
106 }, # OPTIONAL
107 }, # OPTIONAL
108 ModelQuality => {
109 Constraints => {
110 ContentType => 'MyContentType', # max: 256
111 S3Uri => 'MyS3Uri', # max: 1024
112 ContentDigest => 'MyContentDigest', # max: 72; OPTIONAL
113 }, # OPTIONAL
114 Statistics => {
115 ContentType => 'MyContentType', # max: 256
116 S3Uri => 'MyS3Uri', # max: 1024
117 ContentDigest => 'MyContentDigest', # max: 72; OPTIONAL
118 }, # OPTIONAL
119 }, # OPTIONAL
120 }, # OPTIONAL
121 ModelPackageDescription => 'MyEntityDescription', # OPTIONAL
122 ModelPackageGroupName => 'MyEntityName', # OPTIONAL
123 ModelPackageName => 'MyEntityName', # OPTIONAL
124 SourceAlgorithmSpecification => {
125 SourceAlgorithms => [
126 {
127 AlgorithmName => 'MyArnOrName', # min: 1, max: 170
128 ModelDataUrl => 'MyUrl', # max: 1024; OPTIONAL
129 },
130 ...
131 ], # min: 1, max: 1
132  
133 }, # OPTIONAL
134 Tags => [
135 {
136 Key => 'MyTagKey', # min: 1, max: 128
137 Value => 'MyTagValue', # max: 256
138  
139 },
140 ...
141 ], # OPTIONAL
142 ValidationSpecification => {
143 ValidationProfiles => [
144 {
145 ProfileName => 'MyEntityName', # min: 1, max: 63
146 TransformJobDefinition => {
147 TransformInput => {
148 DataSource => {
149 S3DataSource => {
150 S3DataType => 'ManifestFile'
151 , # values: ManifestFile, S3Prefix, AugmentedManifestFile
152 S3Uri => 'MyS3Uri', # max: 1024
153  
154 },
155  
156 },
157 CompressionType => 'None', # values: None, Gzip; OPTIONAL
158 ContentType => 'MyContentType', # max: 256
159 SplitType =>
160 'None', # values: None, Line, RecordIO, TFRecord; OPTIONAL
161 },
162 TransformOutput => {
163 S3OutputPath => 'MyS3Uri', # max: 1024
164 Accept => 'MyAccept', # max: 256; OPTIONAL
165 AssembleWith => 'None', # values: None, Line; OPTIONAL
166 KmsKeyId => 'MyKmsKeyId', # max: 2048; OPTIONAL
167 },
168 TransformResources => {
169 InstanceCount => 1, # min: 1
170 InstanceType => 'ml.m4.xlarge'
171 , # values: 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.g4dn.xlarge, ml.g4dn.2xlarge, ml.g4dn.4xlarge, ml.g4dn.8xlarge, ml.g4dn.12xlarge, ml.g4dn.16xlarge
172 VolumeKmsKeyId => 'MyKmsKeyId', # max: 2048; OPTIONAL
173 },
174 BatchStrategy =>
175 'MultiRecord', # values: MultiRecord, SingleRecord; OPTIONAL
176 Environment => {
177 'MyTransformEnvironmentKey' => 'MyTransformEnvironmentValue'
178 , # key: max: 1024, value: max: 10240
179 }, # max: 16; OPTIONAL
180 MaxConcurrentTransforms => 1, # OPTIONAL
181 MaxPayloadInMB => 1, # OPTIONAL
182 },
183  
184 },
185 ...
186 ], # min: 1, max: 1
187 ValidationRole => 'MyRoleArn', # min: 20, max: 2048
188  
189 }, # OPTIONAL
190 );
191  
192 # Results:
193 my $ModelPackageArn = $CreateModelPackageOutput->ModelPackageArn;
194  
195 # Returns a L<Paws::SageMaker::CreateModelPackageOutput> object.
196  
197 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.
198 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/api.sagemaker/CreateModelPackage>
199  
200 =head1 ATTRIBUTES
201  
202  
203 =head2 CertifyForMarketplace => Bool
204  
205 Whether to certify the model package for listing on Amazon Web Services
206 Marketplace.
207  
208 This parameter is optional for unversioned models, and does not apply
209 to versioned models.
210  
211  
212  
213 =head2 ClientToken => Str
214  
215 A unique token that guarantees that the call to this API is idempotent.
216  
217  
218  
219 =head2 InferenceSpecification => L<Paws::SageMaker::InferenceSpecification>
220  
221 Specifies details about inference jobs that can be run with models
222 based on this model package, including the following:
223  
224 =over
225  
226 =item *
227  
228 The Amazon ECR paths of containers that contain the inference code and
229 model artifacts.
230  
231 =item *
232  
233 The instance types that the model package supports for transform jobs
234 and real-time endpoints used for inference.
235  
236 =item *
237  
238 The input and output content formats that the model package supports
239 for inference.
240  
241 =back
242  
243  
244  
245  
246 =head2 MetadataProperties => L<Paws::SageMaker::MetadataProperties>
247  
248  
249  
250  
251  
252 =head2 ModelApprovalStatus => Str
253  
254 Whether the model is approved for deployment.
255  
256 This parameter is optional for versioned models, and does not apply to
257 unversioned models.
258  
259 For versioned models, the value of this parameter must be set to
260 C<Approved> to deploy the model.
261  
262 Valid values are: C<"Approved">, C<"Rejected">, C<"PendingManualApproval">
263  
264 =head2 ModelMetrics => L<Paws::SageMaker::ModelMetrics>
265  
266 A structure that contains model metrics reports.
267  
268  
269  
270 =head2 ModelPackageDescription => Str
271  
272 A description of the model package.
273  
274  
275  
276 =head2 ModelPackageGroupName => Str
277  
278 The name of the model group that this model version belongs to.
279  
280 This parameter is required for versioned models, and does not apply to
281 unversioned models.
282  
283  
284  
285 =head2 ModelPackageName => Str
286  
287 The name of the model package. The name must have 1 to 63 characters.
288 Valid characters are a-z, A-Z, 0-9, and - (hyphen).
289  
290 This parameter is required for unversioned models. It is not applicable
291 to versioned models.
292  
293  
294  
295 =head2 SourceAlgorithmSpecification => L<Paws::SageMaker::SourceAlgorithmSpecification>
296  
297 Details about the algorithm that was used to create the model package.
298  
299  
300  
301 =head2 Tags => ArrayRef[L<Paws::SageMaker::Tag>]
302  
303 A list of key value pairs associated with the model. For more
304 information, see Tagging Amazon Web Services resources
305 (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) in the
306 I<Amazon Web Services General Reference Guide>.
307  
308  
309  
310 =head2 ValidationSpecification => L<Paws::SageMaker::ModelPackageValidationSpecification>
311  
312 Specifies configurations for one or more transform jobs that Amazon
313 SageMaker runs to test the model package.
314  
315  
316  
317  
318 =head1 SEE ALSO
319  
320 This class forms part of L<Paws>, documenting arguments for method CreateModelPackage in L<Paws::SageMaker>
321  
322 =head1 BUGS and CONTRIBUTIONS
323  
324 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
325  
326 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
327  
328 =cut
329