« blib/lib/Paws/SageMaker/TransformInput.pm
↑ Summary
blib/lib/Paws/SageMaker/TransformJobDefinition.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::SageMaker::TransformJob; | ||
| 3 | use Moose; | ||
| 4 | has AutoMLJobArn => (is => 'ro', isa => 'Str'); | ||
| 5 | has BatchStrategy => (is => 'ro', isa => 'Str'); | ||
| 6 | has CreationTime => (is => 'ro', isa => 'Str'); | ||
| 7 | has DataProcessing => (is => 'ro', isa => 'Paws::SageMaker::DataProcessing'); | ||
| 8 | has Environment => (is => 'ro', isa => 'Paws::SageMaker::TransformEnvironmentMap'); | ||
| 9 | has ExperimentConfig => (is => 'ro', isa => 'Paws::SageMaker::ExperimentConfig'); | ||
| 10 | has FailureReason => (is => 'ro', isa => 'Str'); | ||
| 11 | has LabelingJobArn => (is => 'ro', isa => 'Str'); | ||
| 12 | has MaxConcurrentTransforms => (is => 'ro', isa => 'Int'); | ||
| 13 | has MaxPayloadInMB => (is => 'ro', isa => 'Int'); | ||
| 14 | has ModelClientConfig => (is => 'ro', isa => 'Paws::SageMaker::ModelClientConfig'); | ||
| 15 | has ModelName => (is => 'ro', isa => 'Str'); | ||
| 16 | has Tags => (is => 'ro', isa => 'ArrayRef[Paws::SageMaker::Tag]'); | ||
| 17 | has TransformEndTime => (is => 'ro', isa => 'Str'); | ||
| 18 | has TransformInput => (is => 'ro', isa => 'Paws::SageMaker::TransformInput'); | ||
| 19 | has TransformJobArn => (is => 'ro', isa => 'Str'); | ||
| 20 | has TransformJobName => (is => 'ro', isa => 'Str'); | ||
| 21 | has TransformJobStatus => (is => 'ro', isa => 'Str'); | ||
| 22 | has TransformOutput => (is => 'ro', isa => 'Paws::SageMaker::TransformOutput'); | ||
| 23 | has TransformResources => (is => 'ro', isa => 'Paws::SageMaker::TransformResources'); | ||
| 24 | has TransformStartTime => (is => 'ro', isa => 'Str'); | ||
| 25 | |||
| 26 | 1; | ||
| 27 | |||
| 28 | ### main pod documentation begin ### | ||
| 29 | |||
| 30 | =head1 NAME | ||
| 31 | |||
| 32 | Paws::SageMaker::TransformJob | ||
| 33 | |||
| 34 | =head1 USAGE | ||
| 35 | |||
| 36 | This class represents one of two things: | ||
| 37 | |||
| 38 | =head3 Arguments in a call to a service | ||
| 39 | |||
| 40 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 41 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 42 | |||
| 43 | As an example, if Att1 is expected to be a Paws::SageMaker::TransformJob object: | ||
| 44 | |||
| 45 | $service_obj->Method(Att1 => { AutoMLJobArn => $value, ..., TransformStartTime => $value }); | ||
| 46 | |||
| 47 | =head3 Results returned from an API call | ||
| 48 | |||
| 49 | Use accessors for each attribute. If Att1 is expected to be an Paws::SageMaker::TransformJob object: | ||
| 50 | |||
| 51 | $result = $service_obj->Method(...); | ||
| 52 | $result->Att1->AutoMLJobArn | ||
| 53 | |||
| 54 | =head1 DESCRIPTION | ||
| 55 | |||
| 56 | A batch transform job. For information about SageMaker batch transform, | ||
| 57 | see Use Batch Transform | ||
| 58 | (https://docs.aws.amazon.com/sagemaker/latest/dg/batch-transform.html). | ||
| 59 | |||
| 60 | =head1 ATTRIBUTES | ||
| 61 | |||
| 62 | |||
| 63 | =head2 AutoMLJobArn => Str | ||
| 64 | |||
| 65 | The Amazon Resource Name (ARN) of the AutoML job that created the | ||
| 66 | transform job. | ||
| 67 | |||
| 68 | |||
| 69 | =head2 BatchStrategy => Str | ||
| 70 | |||
| 71 | Specifies the number of records to include in a mini-batch for an HTTP | ||
| 72 | inference request. A record is a single unit of input data that | ||
| 73 | inference can be made on. For example, a single line in a CSV file is a | ||
| 74 | record. | ||
| 75 | |||
| 76 | |||
| 77 | =head2 CreationTime => Str | ||
| 78 | |||
| 79 | A timestamp that shows when the transform Job was created. | ||
| 80 | |||
| 81 | |||
| 82 | =head2 DataProcessing => L<Paws::SageMaker::DataProcessing> | ||
| 83 | |||
| 84 | |||
| 85 | |||
| 86 | |||
| 87 | =head2 Environment => L<Paws::SageMaker::TransformEnvironmentMap> | ||
| 88 | |||
| 89 | The environment variables to set in the Docker container. We support up | ||
| 90 | to 16 key and values entries in the map. | ||
| 91 | |||
| 92 | |||
| 93 | =head2 ExperimentConfig => L<Paws::SageMaker::ExperimentConfig> | ||
| 94 | |||
| 95 | |||
| 96 | |||
| 97 | |||
| 98 | =head2 FailureReason => Str | ||
| 99 | |||
| 100 | If the transform job failed, the reason it failed. | ||
| 101 | |||
| 102 | |||
| 103 | =head2 LabelingJobArn => Str | ||
| 104 | |||
| 105 | The Amazon Resource Name (ARN) of the labeling job that created the | ||
| 106 | transform job. | ||
| 107 | |||
| 108 | |||
| 109 | =head2 MaxConcurrentTransforms => Int | ||
| 110 | |||
| 111 | The maximum number of parallel requests that can be sent to each | ||
| 112 | instance in a transform job. If C<MaxConcurrentTransforms> is set to 0 | ||
| 113 | or left unset, SageMaker checks the optional execution-parameters to | ||
| 114 | determine the settings for your chosen algorithm. If the | ||
| 115 | execution-parameters endpoint is not enabled, the default value is 1. | ||
| 116 | For built-in algorithms, you don't need to set a value for | ||
| 117 | C<MaxConcurrentTransforms>. | ||
| 118 | |||
| 119 | |||
| 120 | =head2 MaxPayloadInMB => Int | ||
| 121 | |||
| 122 | The maximum allowed size of the payload, in MB. A payload is the data | ||
| 123 | portion of a record (without metadata). The value in C<MaxPayloadInMB> | ||
| 124 | must be greater than, or equal to, the size of a single record. To | ||
| 125 | estimate the size of a record in MB, divide the size of your dataset by | ||
| 126 | the number of records. To ensure that the records fit within the | ||
| 127 | maximum payload size, we recommend using a slightly larger value. The | ||
| 128 | default value is 6 MB. For cases where the payload might be arbitrarily | ||
| 129 | large and is transmitted using HTTP chunked encoding, set the value to | ||
| 130 | 0. This feature works only in supported algorithms. Currently, | ||
| 131 | SageMaker built-in algorithms do not support HTTP chunked encoding. | ||
| 132 | |||
| 133 | |||
| 134 | =head2 ModelClientConfig => L<Paws::SageMaker::ModelClientConfig> | ||
| 135 | |||
| 136 | |||
| 137 | |||
| 138 | |||
| 139 | =head2 ModelName => Str | ||
| 140 | |||
| 141 | The name of the model associated with the transform job. | ||
| 142 | |||
| 143 | |||
| 144 | =head2 Tags => ArrayRef[L<Paws::SageMaker::Tag>] | ||
| 145 | |||
| 146 | A list of tags associated with the transform job. | ||
| 147 | |||
| 148 | |||
| 149 | =head2 TransformEndTime => Str | ||
| 150 | |||
| 151 | Indicates when the transform job has been completed, or has stopped or | ||
| 152 | failed. You are billed for the time interval between this time and the | ||
| 153 | value of C<TransformStartTime>. | ||
| 154 | |||
| 155 | |||
| 156 | =head2 TransformInput => L<Paws::SageMaker::TransformInput> | ||
| 157 | |||
| 158 | |||
| 159 | |||
| 160 | |||
| 161 | =head2 TransformJobArn => Str | ||
| 162 | |||
| 163 | The Amazon Resource Name (ARN) of the transform job. | ||
| 164 | |||
| 165 | |||
| 166 | =head2 TransformJobName => Str | ||
| 167 | |||
| 168 | The name of the transform job. | ||
| 169 | |||
| 170 | |||
| 171 | =head2 TransformJobStatus => Str | ||
| 172 | |||
| 173 | The status of the transform job. | ||
| 174 | |||
| 175 | Transform job statuses are: | ||
| 176 | |||
| 177 | =over | ||
| 178 | |||
| 179 | =item * | ||
| 180 | |||
| 181 | C<InProgress> - The job is in progress. | ||
| 182 | |||
| 183 | =item * | ||
| 184 | |||
| 185 | C<Completed> - The job has completed. | ||
| 186 | |||
| 187 | =item * | ||
| 188 | |||
| 189 | C<Failed> - The transform job has failed. To see the reason for the | ||
| 190 | failure, see the C<FailureReason> field in the response to a | ||
| 191 | C<DescribeTransformJob> call. | ||
| 192 | |||
| 193 | =item * | ||
| 194 | |||
| 195 | C<Stopping> - The transform job is stopping. | ||
| 196 | |||
| 197 | =item * | ||
| 198 | |||
| 199 | C<Stopped> - The transform job has stopped. | ||
| 200 | |||
| 201 | =back | ||
| 202 | |||
| 203 | |||
| 204 | |||
| 205 | =head2 TransformOutput => L<Paws::SageMaker::TransformOutput> | ||
| 206 | |||
| 207 | |||
| 208 | |||
| 209 | |||
| 210 | =head2 TransformResources => L<Paws::SageMaker::TransformResources> | ||
| 211 | |||
| 212 | |||
| 213 | |||
| 214 | |||
| 215 | =head2 TransformStartTime => Str | ||
| 216 | |||
| 217 | Indicates when the transform job starts on ML instances. You are billed | ||
| 218 | for the time interval between this time and the value of | ||
| 219 | C<TransformEndTime>. | ||
| 220 | |||
| 221 | |||
| 222 | |||
| 223 | =head1 SEE ALSO | ||
| 224 | |||
| 225 | This class forms part of L<Paws>, describing an object used in L<Paws::SageMaker> | ||
| 226 | |||
| 227 | =head1 BUGS and CONTRIBUTIONS | ||
| 228 | |||
| 229 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 230 | |||
| 231 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 232 | |||
| 233 | =cut | ||
| 234 |