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

filter: Statementstmt 0.0% 0 / 20 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 2 Podpod n/a totaltotal 0.0% 0 / 22 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
BEGIN
2.0
CRAP 2.0
1  
2 package Paws::SageMaker::CreateProcessingJob;
3 use Moose;
4 has AppSpecification => (is => 'ro', isa => 'Paws::SageMaker::AppSpecification', required => 1);
5 has Environment => (is => 'ro', isa => 'Paws::SageMaker::ProcessingEnvironmentMap');
6 has ExperimentConfig => (is => 'ro', isa => 'Paws::SageMaker::ExperimentConfig');
7 has NetworkConfig => (is => 'ro', isa => 'Paws::SageMaker::NetworkConfig');
8 has ProcessingInputs => (is => 'ro', isa => 'ArrayRef[Paws::SageMaker::ProcessingInput]');
9 has ProcessingJobName => (is => 'ro', isa => 'Str', required => 1);
10 has ProcessingOutputConfig => (is => 'ro', isa => 'Paws::SageMaker::ProcessingOutputConfig');
11 has ProcessingResources => (is => 'ro', isa => 'Paws::SageMaker::ProcessingResources', required => 1);
12 has RoleArn => (is => 'ro', isa => 'Str', required => 1);
13 has StoppingCondition => (is => 'ro', isa => 'Paws::SageMaker::ProcessingStoppingCondition');
14 has Tags => (is => 'ro', isa => 'ArrayRef[Paws::SageMaker::Tag]');
15  
16 use MooseX::ClassAttribute;
17  
18 class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateProcessingJob');
19 class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::SageMaker::CreateProcessingJobResponse');
20 class_has _result_key => (isa => 'Str', is => 'ro');
21 1;
22  
23 ### main pod documentation begin ###
24  
25 =head1 NAME
26  
27 Paws::SageMaker::CreateProcessingJob - Arguments for method CreateProcessingJob on L<Paws::SageMaker>
28  
29 =head1 DESCRIPTION
30  
31 This class represents the parameters used for calling the method CreateProcessingJob on the
32 L<Amazon SageMaker Service|Paws::SageMaker> service. Use the attributes of this class
33 as arguments to method CreateProcessingJob.
34  
35 You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateProcessingJob.
36  
37 =head1 SYNOPSIS
38  
39 my $api.sagemaker = Paws->service('SageMaker');
40 my $CreateProcessingJobResponse = $api . sagemaker->CreateProcessingJob(
41 AppSpecification => {
42 ImageUri => 'MyImageUri', # max: 255
43 ContainerArguments => [
44 'MyContainerArgument', ... # max: 256
45 ], # min: 1, max: 100; OPTIONAL
46 ContainerEntrypoint => [
47 'MyContainerEntrypointString', ... # max: 256
48 ], # min: 1, max: 100; OPTIONAL
49 },
50 ProcessingJobName => 'MyProcessingJobName',
51 ProcessingResources => {
52 ClusterConfig => {
53 InstanceCount => 1, # min: 1, max: 100
54 InstanceType => 'ml.t3.medium'
55 , # 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
56 VolumeSizeInGB => 1, # min: 1, max: 16384
57 VolumeKmsKeyId => 'MyKmsKeyId', # max: 2048; OPTIONAL
58 },
59  
60 },
61 RoleArn => 'MyRoleArn',
62 Environment => {
63 'MyProcessingEnvironmentKey' =>
64 'MyProcessingEnvironmentValue', # key: max: 256, value: max: 256
65 }, # OPTIONAL
66 ExperimentConfig => {
67 ExperimentName => 'MyExperimentEntityName', # min: 1, max: 120; OPTIONAL
68 TrialComponentDisplayName =>
69 'MyExperimentEntityName', # min: 1, max: 120; OPTIONAL
70 TrialName => 'MyExperimentEntityName', # min: 1, max: 120; OPTIONAL
71 }, # OPTIONAL
72 NetworkConfig => {
73 EnableInterContainerTrafficEncryption => 1, # OPTIONAL
74 EnableNetworkIsolation => 1, # OPTIONAL
75 VpcConfig => {
76 SecurityGroupIds => [
77 'MySecurityGroupId', ... # max: 32
78 ], # min: 1, max: 5
79 Subnets => [
80 'MySubnetId', ... # max: 32
81 ], # min: 1, max: 16
82  
83 }, # OPTIONAL
84 }, # OPTIONAL
85 ProcessingInputs => [
86 {
87 InputName => 'MyString',
88 AppManaged => 1, # OPTIONAL
89 DatasetDefinition => {
90 AthenaDatasetDefinition => {
91 Catalog => 'MyAthenaCatalog', # min: 1, max: 256
92 Database => 'MyAthenaDatabase', # min: 1, max: 255
93 OutputFormat =>
94 'PARQUET', # values: PARQUET, ORC, AVRO, JSON, TEXTFILE
95 OutputS3Uri => 'MyS3Uri', # max: 1024
96 QueryString => 'MyAthenaQueryString', # min: 1, max: 4096
97 KmsKeyId => 'MyKmsKeyId', # max: 2048; OPTIONAL
98 OutputCompression =>
99 'GZIP', # values: GZIP, SNAPPY, ZLIB; OPTIONAL
100 WorkGroup => 'MyAthenaWorkGroup', # min: 1, max: 128; OPTIONAL
101 }, # OPTIONAL
102 DataDistributionType => 'FullyReplicated'
103 , # values: FullyReplicated, ShardedByS3Key; OPTIONAL
104 InputMode => 'Pipe', # values: Pipe, File; OPTIONAL
105 LocalPath => 'MyProcessingLocalPath', # max: 256; OPTIONAL
106 RedshiftDatasetDefinition => {
107 ClusterId => 'MyRedshiftClusterId', # min: 1, max: 63
108 ClusterRoleArn => 'MyRoleArn', # min: 20, max: 2048
109 Database => 'MyRedshiftDatabase', # min: 1, max: 64
110 DbUser => 'MyRedshiftUserName', # min: 1, max: 128
111 OutputFormat => 'PARQUET', # values: PARQUET, CSV
112 OutputS3Uri => 'MyS3Uri', # max: 1024
113 QueryString => 'MyRedshiftQueryString', # min: 1, max: 4096
114 KmsKeyId => 'MyKmsKeyId', # max: 2048; OPTIONAL
115 OutputCompression =>
116 'None', # values: None, GZIP, BZIP2, ZSTD, SNAPPY; OPTIONAL
117 }, # OPTIONAL
118 }, # OPTIONAL
119 S3Input => {
120 S3DataType => 'ManifestFile', # values: ManifestFile, S3Prefix
121 S3Uri => 'MyS3Uri', # max: 1024
122 LocalPath => 'MyProcessingLocalPath', # max: 256; OPTIONAL
123 S3CompressionType => 'None', # values: None, Gzip; OPTIONAL
124 S3DataDistributionType => 'FullyReplicated'
125 , # values: FullyReplicated, ShardedByS3Key; OPTIONAL
126 S3InputMode => 'Pipe', # values: Pipe, File; OPTIONAL
127 }, # OPTIONAL
128 },
129 ...
130 ], # OPTIONAL
131 ProcessingOutputConfig => {
132 Outputs => [
133 {
134 OutputName => 'MyString',
135 AppManaged => 1, # OPTIONAL
136 FeatureStoreOutput => {
137 FeatureGroupName => 'MyFeatureGroupName', # min: 1, max: 64
138  
139 }, # OPTIONAL
140 S3Output => {
141 LocalPath => 'MyProcessingLocalPath', # max: 256; OPTIONAL
142 S3UploadMode => 'Continuous', # values: Continuous, EndOfJob
143 S3Uri => 'MyS3Uri', # max: 1024
144  
145 }, # OPTIONAL
146 },
147 ...
148 ], # max: 10
149 KmsKeyId => 'MyKmsKeyId', # max: 2048; OPTIONAL
150 }, # OPTIONAL
151 StoppingCondition => {
152 MaxRuntimeInSeconds => 1, # min: 1, max: 604800
153  
154 }, # OPTIONAL
155 Tags => [
156 {
157 Key => 'MyTagKey', # min: 1, max: 128
158 Value => 'MyTagValue', # max: 256
159  
160 },
161 ...
162 ], # OPTIONAL
163 );
164  
165 # Results:
166 my $ProcessingJobArn = $CreateProcessingJobResponse->ProcessingJobArn;
167  
168 # Returns a L<Paws::SageMaker::CreateProcessingJobResponse> object.
169  
170 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.
171 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/api.sagemaker/CreateProcessingJob>
172  
173 =head1 ATTRIBUTES
174  
175  
176 =head2 B<REQUIRED> AppSpecification => L<Paws::SageMaker::AppSpecification>
177  
178 Configures the processing job to run a specified Docker container
179 image.
180  
181  
182  
183 =head2 Environment => L<Paws::SageMaker::ProcessingEnvironmentMap>
184  
185 The environment variables to set in the Docker container. Up to 100 key
186 and values entries in the map are supported.
187  
188  
189  
190 =head2 ExperimentConfig => L<Paws::SageMaker::ExperimentConfig>
191  
192  
193  
194  
195  
196 =head2 NetworkConfig => L<Paws::SageMaker::NetworkConfig>
197  
198 Networking options for a processing job, such as whether to allow
199 inbound and outbound network calls to and from processing containers,
200 and the VPC subnets and security groups to use for VPC-enabled
201 processing jobs.
202  
203  
204  
205 =head2 ProcessingInputs => ArrayRef[L<Paws::SageMaker::ProcessingInput>]
206  
207 An array of inputs configuring the data to download into the processing
208 container.
209  
210  
211  
212 =head2 B<REQUIRED> ProcessingJobName => Str
213  
214 The name of the processing job. The name must be unique within an
215 Amazon Web Services Region in the Amazon Web Services account.
216  
217  
218  
219 =head2 ProcessingOutputConfig => L<Paws::SageMaker::ProcessingOutputConfig>
220  
221 Output configuration for the processing job.
222  
223  
224  
225 =head2 B<REQUIRED> ProcessingResources => L<Paws::SageMaker::ProcessingResources>
226  
227 Identifies the resources, ML compute instances, and ML storage volumes
228 to deploy for a processing job. In distributed training, you specify
229 more than one instance.
230  
231  
232  
233 =head2 B<REQUIRED> RoleArn => Str
234  
235 The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can
236 assume to perform tasks on your behalf.
237  
238  
239  
240 =head2 StoppingCondition => L<Paws::SageMaker::ProcessingStoppingCondition>
241  
242 The time limit for how long the processing job is allowed to run.
243  
244  
245  
246 =head2 Tags => ArrayRef[L<Paws::SageMaker::Tag>]
247  
248 (Optional) An array of key-value pairs. For more information, see Using
249 Cost Allocation Tags
250 (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html#allocation-whatURL)
251 in the I<Amazon Web Services Billing and Cost Management User Guide>.
252  
253  
254  
255  
256 =head1 SEE ALSO
257  
258 This class forms part of L<Paws>, documenting arguments for method CreateProcessingJob in L<Paws::SageMaker>
259  
260 =head1 BUGS and CONTRIBUTIONS
261  
262 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
263  
264 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
265  
266 =cut
267