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

filter: Statementstmt 0.0% 0 / 22 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 2 Podpod n/a totaltotal 0.0% 0 / 24 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
BEGIN
2.0
CRAP 2.0
1  
2 package Paws::SageMaker::CreateTransformJob;
3 use Moose;
4 has BatchStrategy => (is => 'ro', isa => 'Str');
5 has DataProcessing => (is => 'ro', isa => 'Paws::SageMaker::DataProcessing');
6 has Environment => (is => 'ro', isa => 'Paws::SageMaker::TransformEnvironmentMap');
7 has ExperimentConfig => (is => 'ro', isa => 'Paws::SageMaker::ExperimentConfig');
8 has MaxConcurrentTransforms => (is => 'ro', isa => 'Int');
9 has MaxPayloadInMB => (is => 'ro', isa => 'Int');
10 has ModelClientConfig => (is => 'ro', isa => 'Paws::SageMaker::ModelClientConfig');
11 has ModelName => (is => 'ro', isa => 'Str', required => 1);
12 has Tags => (is => 'ro', isa => 'ArrayRef[Paws::SageMaker::Tag]');
13 has TransformInput => (is => 'ro', isa => 'Paws::SageMaker::TransformInput', required => 1);
14 has TransformJobName => (is => 'ro', isa => 'Str', required => 1);
15 has TransformOutput => (is => 'ro', isa => 'Paws::SageMaker::TransformOutput', required => 1);
16 has TransformResources => (is => 'ro', isa => 'Paws::SageMaker::TransformResources', required => 1);
17  
18 use MooseX::ClassAttribute;
19  
20 class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateTransformJob');
21 class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::SageMaker::CreateTransformJobResponse');
22 class_has _result_key => (isa => 'Str', is => 'ro');
23 1;
24  
25 ### main pod documentation begin ###
26  
27 =head1 NAME
28  
29 Paws::SageMaker::CreateTransformJob - Arguments for method CreateTransformJob on L<Paws::SageMaker>
30  
31 =head1 DESCRIPTION
32  
33 This class represents the parameters used for calling the method CreateTransformJob on the
34 L<Amazon SageMaker Service|Paws::SageMaker> service. Use the attributes of this class
35 as arguments to method CreateTransformJob.
36  
37 You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateTransformJob.
38  
39 =head1 SYNOPSIS
40  
41 my $api.sagemaker = Paws->service('SageMaker');
42 my $CreateTransformJobResponse = $api . sagemaker->CreateTransformJob(
43 ModelName => 'MyModelName',
44 TransformInput => {
45 DataSource => {
46 S3DataSource => {
47 S3DataType => 'ManifestFile'
48 , # values: ManifestFile, S3Prefix, AugmentedManifestFile
49 S3Uri => 'MyS3Uri', # max: 1024
50  
51 },
52  
53 },
54 CompressionType => 'None', # values: None, Gzip; OPTIONAL
55 ContentType => 'MyContentType', # max: 256; OPTIONAL
56 SplitType => 'None', # values: None, Line, RecordIO, TFRecord; OPTIONAL
57 },
58 TransformJobName => 'MyTransformJobName',
59 TransformOutput => {
60 S3OutputPath => 'MyS3Uri', # max: 1024
61 Accept => 'MyAccept', # max: 256; OPTIONAL
62 AssembleWith => 'None', # values: None, Line; OPTIONAL
63 KmsKeyId => 'MyKmsKeyId', # max: 2048; OPTIONAL
64 },
65 TransformResources => {
66 InstanceCount => 1, # min: 1
67 InstanceType => 'ml.m4.xlarge'
68 , # 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
69 VolumeKmsKeyId => 'MyKmsKeyId', # max: 2048; OPTIONAL
70 },
71 BatchStrategy => 'MultiRecord', # OPTIONAL
72 DataProcessing => {
73 InputFilter => 'MyJsonPath', # max: 63; OPTIONAL
74 JoinSource => 'Input', # values: Input, None; OPTIONAL
75 OutputFilter => 'MyJsonPath', # max: 63; OPTIONAL
76 }, # OPTIONAL
77 Environment => {
78 'MyTransformEnvironmentKey' =>
79 'MyTransformEnvironmentValue', # key: max: 1024, value: max: 10240
80 }, # OPTIONAL
81 ExperimentConfig => {
82 ExperimentName => 'MyExperimentEntityName', # min: 1, max: 120; OPTIONAL
83 TrialComponentDisplayName =>
84 'MyExperimentEntityName', # min: 1, max: 120; OPTIONAL
85 TrialName => 'MyExperimentEntityName', # min: 1, max: 120; OPTIONAL
86 }, # OPTIONAL
87 MaxConcurrentTransforms => 1, # OPTIONAL
88 MaxPayloadInMB => 1, # OPTIONAL
89 ModelClientConfig => {
90 InvocationsMaxRetries => 1, # max: 3; OPTIONAL
91 InvocationsTimeoutInSeconds => 1, # min: 1, max: 3600; OPTIONAL
92 }, # OPTIONAL
93 Tags => [
94 {
95 Key => 'MyTagKey', # min: 1, max: 128
96 Value => 'MyTagValue', # max: 256
97  
98 },
99 ...
100 ], # OPTIONAL
101 );
102  
103 # Results:
104 my $TransformJobArn = $CreateTransformJobResponse->TransformJobArn;
105  
106 # Returns a L<Paws::SageMaker::CreateTransformJobResponse> object.
107  
108 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.
109 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/api.sagemaker/CreateTransformJob>
110  
111 =head1 ATTRIBUTES
112  
113  
114 =head2 BatchStrategy => Str
115  
116 Specifies the number of records to include in a mini-batch for an HTTP
117 inference request. A I<record> I< is a single unit of input data that
118 inference can be made on. For example, a single line in a CSV file is a
119 record.>
120  
121 To enable the batch strategy, you must set the C<SplitType> property to
122 C<Line>, C<RecordIO>, or C<TFRecord>.
123  
124 To use only one record when making an HTTP invocation request to a
125 container, set C<BatchStrategy> to C<SingleRecord> and C<SplitType> to
126 C<Line>.
127  
128 To fit as many records in a mini-batch as can fit within the
129 C<MaxPayloadInMB> limit, set C<BatchStrategy> to C<MultiRecord> and
130 C<SplitType> to C<Line>.
131  
132 Valid values are: C<"MultiRecord">, C<"SingleRecord">
133  
134 =head2 DataProcessing => L<Paws::SageMaker::DataProcessing>
135  
136 The data structure used to specify the data to be used for inference in
137 a batch transform job and to associate the data that is relevant to the
138 prediction results in the output. The input filter provided allows you
139 to exclude input data that is not needed for inference in a batch
140 transform job. The output filter provided allows you to include input
141 data relevant to interpreting the predictions in the output from the
142 job. For more information, see Associate Prediction Results with their
143 Corresponding Input Records
144 (https://docs.aws.amazon.com/sagemaker/latest/dg/batch-transform-data-processing.html).
145  
146  
147  
148 =head2 Environment => L<Paws::SageMaker::TransformEnvironmentMap>
149  
150 The environment variables to set in the Docker container. We support up
151 to 16 key and values entries in the map.
152  
153  
154  
155 =head2 ExperimentConfig => L<Paws::SageMaker::ExperimentConfig>
156  
157  
158  
159  
160  
161 =head2 MaxConcurrentTransforms => Int
162  
163 The maximum number of parallel requests that can be sent to each
164 instance in a transform job. If C<MaxConcurrentTransforms> is set to
165 C<0> or left unset, Amazon SageMaker checks the optional
166 execution-parameters to determine the settings for your chosen
167 algorithm. If the execution-parameters endpoint is not enabled, the
168 default value is C<1>. For more information on execution-parameters,
169 see How Containers Serve Requests
170 (https://docs.aws.amazon.com/sagemaker/latest/dg/your-algorithms-batch-code.html#your-algorithms-batch-code-how-containe-serves-requests).
171 For built-in algorithms, you don't need to set a value for
172 C<MaxConcurrentTransforms>.
173  
174  
175  
176 =head2 MaxPayloadInMB => Int
177  
178 The maximum allowed size of the payload, in MB. A I<payload> is the
179 data portion of a record (without metadata). The value in
180 C<MaxPayloadInMB> must be greater than, or equal to, the size of a
181 single record. To estimate the size of a record in MB, divide the size
182 of your dataset by the number of records. To ensure that the records
183 fit within the maximum payload size, we recommend using a slightly
184 larger value. The default value is C<6> MB.
185  
186 For cases where the payload might be arbitrarily large and is
187 transmitted using HTTP chunked encoding, set the value to C<0>. This
188 feature works only in supported algorithms. Currently, Amazon SageMaker
189 built-in algorithms do not support HTTP chunked encoding.
190  
191  
192  
193 =head2 ModelClientConfig => L<Paws::SageMaker::ModelClientConfig>
194  
195 Configures the timeout and maximum number of retries for processing a
196 transform job invocation.
197  
198  
199  
200 =head2 B<REQUIRED> ModelName => Str
201  
202 The name of the model that you want to use for the transform job.
203 C<ModelName> must be the name of an existing Amazon SageMaker model
204 within an Amazon Web Services Region in an Amazon Web Services account.
205  
206  
207  
208 =head2 Tags => ArrayRef[L<Paws::SageMaker::Tag>]
209  
210 (Optional) An array of key-value pairs. For more information, see Using
211 Cost Allocation Tags
212 (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html#allocation-what)
213 in the I<Amazon Web Services Billing and Cost Management User Guide>.
214  
215  
216  
217 =head2 B<REQUIRED> TransformInput => L<Paws::SageMaker::TransformInput>
218  
219 Describes the input source and the way the transform job consumes it.
220  
221  
222  
223 =head2 B<REQUIRED> TransformJobName => Str
224  
225 The name of the transform job. The name must be unique within an Amazon
226 Web Services Region in an Amazon Web Services account.
227  
228  
229  
230 =head2 B<REQUIRED> TransformOutput => L<Paws::SageMaker::TransformOutput>
231  
232 Describes the results of the transform job.
233  
234  
235  
236 =head2 B<REQUIRED> TransformResources => L<Paws::SageMaker::TransformResources>
237  
238 Describes the resources, including ML instance types and ML instance
239 count, to use for the transform job.
240  
241  
242  
243  
244 =head1 SEE ALSO
245  
246 This class forms part of L<Paws>, documenting arguments for method CreateTransformJob in L<Paws::SageMaker>
247  
248 =head1 BUGS and CONTRIBUTIONS
249  
250 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
251  
252 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
253  
254 =cut
255