« blib/lib/Paws/SageMaker/TransformOutput.pm
↑ Summary
blib/lib/Paws/SageMaker/TransformS3DataSource.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::SageMaker::TransformResources; | ||
| 3 | use Moose; | ||
| 4 | has InstanceCount => (is => 'ro', isa => 'Int', required => 1); | ||
| 5 | has InstanceType => (is => 'ro', isa => 'Str', required => 1); | ||
| 6 | has VolumeKmsKeyId => (is => 'ro', isa => 'Str'); | ||
| 7 | |||
| 8 | 1; | ||
| 9 | |||
| 10 | ### main pod documentation begin ### | ||
| 11 | |||
| 12 | =head1 NAME | ||
| 13 | |||
| 14 | Paws::SageMaker::TransformResources | ||
| 15 | |||
| 16 | =head1 USAGE | ||
| 17 | |||
| 18 | This class represents one of two things: | ||
| 19 | |||
| 20 | =head3 Arguments in a call to a service | ||
| 21 | |||
| 22 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 23 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 24 | |||
| 25 | As an example, if Att1 is expected to be a Paws::SageMaker::TransformResources object: | ||
| 26 | |||
| 27 | $service_obj->Method(Att1 => { InstanceCount => $value, ..., VolumeKmsKeyId => $value }); | ||
| 28 | |||
| 29 | =head3 Results returned from an API call | ||
| 30 | |||
| 31 | Use accessors for each attribute. If Att1 is expected to be an Paws::SageMaker::TransformResources object: | ||
| 32 | |||
| 33 | $result = $service_obj->Method(...); | ||
| 34 | $result->Att1->InstanceCount | ||
| 35 | |||
| 36 | =head1 DESCRIPTION | ||
| 37 | |||
| 38 | Describes the resources, including ML instance types and ML instance | ||
| 39 | count, to use for transform job. | ||
| 40 | |||
| 41 | =head1 ATTRIBUTES | ||
| 42 | |||
| 43 | |||
| 44 | =head2 B<REQUIRED> InstanceCount => Int | ||
| 45 | |||
| 46 | The number of ML compute instances to use in the transform job. For | ||
| 47 | distributed transform jobs, specify a value greater than 1. The default | ||
| 48 | value is C<1>. | ||
| 49 | |||
| 50 | |||
| 51 | =head2 B<REQUIRED> InstanceType => Str | ||
| 52 | |||
| 53 | The ML compute instance type for the transform job. If you are using | ||
| 54 | built-in algorithms to transform moderately sized datasets, we | ||
| 55 | recommend using ml.m4.xlarge or C<ml.m5.large>instance types. | ||
| 56 | |||
| 57 | |||
| 58 | =head2 VolumeKmsKeyId => Str | ||
| 59 | |||
| 60 | The Amazon Web Services Key Management Service (Amazon Web Services | ||
| 61 | KMS) key that Amazon SageMaker uses to encrypt model data on the | ||
| 62 | storage volume attached to the ML compute instance(s) that run the | ||
| 63 | batch transform job. | ||
| 64 | |||
| 65 | Certain Nitro-based instances include local storage, dependent on the | ||
| 66 | instance type. Local storage volumes are encrypted using a hardware | ||
| 67 | module on the instance. You can't request a C<VolumeKmsKeyId> when | ||
| 68 | using an instance type with local storage. | ||
| 69 | |||
| 70 | For a list of instance types that support local instance storage, see | ||
| 71 | Instance Store Volumes | ||
| 72 | (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/InstanceStorage.html#instance-store-volumes). | ||
| 73 | |||
| 74 | For more information about local instance storage encryption, see SSD | ||
| 75 | Instance Store Volumes | ||
| 76 | (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ssd-instance-store.html). | ||
| 77 | |||
| 78 | The C<VolumeKmsKeyId> can be any of the following formats: | ||
| 79 | |||
| 80 | =over | ||
| 81 | |||
| 82 | =item * | ||
| 83 | |||
| 84 | Key ID: C<1234abcd-12ab-34cd-56ef-1234567890ab> | ||
| 85 | |||
| 86 | =item * | ||
| 87 | |||
| 88 | Key ARN: | ||
| 89 | C<arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab> | ||
| 90 | |||
| 91 | =item * | ||
| 92 | |||
| 93 | Alias name: C<alias/ExampleAlias> | ||
| 94 | |||
| 95 | =item * | ||
| 96 | |||
| 97 | Alias name ARN: | ||
| 98 | C<arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias> | ||
| 99 | |||
| 100 | =back | ||
| 101 | |||
| 102 | |||
| 103 | |||
| 104 | |||
| 105 | =head1 SEE ALSO | ||
| 106 | |||
| 107 | This class forms part of L<Paws>, describing an object used in L<Paws::SageMaker> | ||
| 108 | |||
| 109 | =head1 BUGS and CONTRIBUTIONS | ||
| 110 | |||
| 111 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 112 | |||
| 113 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 114 | |||
| 115 | =cut | ||
| 116 |