« blib/lib/Paws/MachineLearning/BatchPrediction.pm
↑ Summary
blib/lib/Paws/MachineLearning/CreateBatchPredictionOutput.pm »
| 1 | |||
| 2 | package Paws::MachineLearning::CreateBatchPrediction; | ||
| 3 | use Moose; | ||
| 4 | has BatchPredictionDataSourceId => (is => 'ro', isa => 'Str', required => 1); | ||
| 5 | has BatchPredictionId => (is => 'ro', isa => 'Str', required => 1); | ||
| 6 | has BatchPredictionName => (is => 'ro', isa => 'Str'); | ||
| 7 | has MLModelId => (is => 'ro', isa => 'Str', required => 1); | ||
| 8 | has OutputUri => (is => 'ro', isa => 'Str', required => 1); | ||
| 9 | |||
| 10 | use MooseX::ClassAttribute; | ||
| 11 | |||
| 12 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateBatchPrediction'); | ||
| 13 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::MachineLearning::CreateBatchPredictionOutput'); | ||
| 14 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 15 | 1; | ||
| 16 | |||
| 17 | ### main pod documentation begin ### | ||
| 18 | |||
| 19 | =head1 NAME | ||
| 20 | |||
| 21 | Paws::MachineLearning::CreateBatchPrediction - Arguments for method CreateBatchPrediction on L<Paws::MachineLearning> | ||
| 22 | |||
| 23 | =head1 DESCRIPTION | ||
| 24 | |||
| 25 | This class represents the parameters used for calling the method CreateBatchPrediction on the | ||
| 26 | L<Amazon Machine Learning|Paws::MachineLearning> service. Use the attributes of this class | ||
| 27 | as arguments to method CreateBatchPrediction. | ||
| 28 | |||
| 29 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateBatchPrediction. | ||
| 30 | |||
| 31 | =head1 SYNOPSIS | ||
| 32 | |||
| 33 | my $machinelearning = Paws->service('MachineLearning'); | ||
| 34 | my $CreateBatchPredictionOutput = $machinelearning->CreateBatchPrediction( | ||
| 35 | BatchPredictionDataSourceId => 'MyEntityId', | ||
| 36 | BatchPredictionId => 'MyEntityId', | ||
| 37 | MLModelId => 'MyEntityId', | ||
| 38 | OutputUri => 'MyS3Url', | ||
| 39 | BatchPredictionName => 'MyEntityName', # OPTIONAL | ||
| 40 | ); | ||
| 41 | |||
| 42 | # Results: | ||
| 43 | my $BatchPredictionId = $CreateBatchPredictionOutput->BatchPredictionId; | ||
| 44 | |||
| 45 | # Returns a L<Paws::MachineLearning::CreateBatchPredictionOutput> object. | ||
| 46 | |||
| 47 | 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. | ||
| 48 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/machinelearning/CreateBatchPrediction> | ||
| 49 | |||
| 50 | =head1 ATTRIBUTES | ||
| 51 | |||
| 52 | |||
| 53 | =head2 B<REQUIRED> BatchPredictionDataSourceId => Str | ||
| 54 | |||
| 55 | The ID of the C<DataSource> that points to the group of observations to | ||
| 56 | predict. | ||
| 57 | |||
| 58 | |||
| 59 | |||
| 60 | =head2 B<REQUIRED> BatchPredictionId => Str | ||
| 61 | |||
| 62 | A user-supplied ID that uniquely identifies the C<BatchPrediction>. | ||
| 63 | |||
| 64 | |||
| 65 | |||
| 66 | =head2 BatchPredictionName => Str | ||
| 67 | |||
| 68 | A user-supplied name or description of the C<BatchPrediction>. | ||
| 69 | C<BatchPredictionName> can only use the UTF-8 character set. | ||
| 70 | |||
| 71 | |||
| 72 | |||
| 73 | =head2 B<REQUIRED> MLModelId => Str | ||
| 74 | |||
| 75 | The ID of the C<MLModel> that will generate predictions for the group | ||
| 76 | of observations. | ||
| 77 | |||
| 78 | |||
| 79 | |||
| 80 | =head2 B<REQUIRED> OutputUri => Str | ||
| 81 | |||
| 82 | The location of an Amazon Simple Storage Service (Amazon S3) bucket or | ||
| 83 | directory to store the batch prediction results. The following | ||
| 84 | substrings are not allowed in the C<s3 key> portion of the C<outputURI> | ||
| 85 | field: ':', '//', '/./', '/../'. | ||
| 86 | |||
| 87 | Amazon ML needs permissions to store and retrieve the logs on your | ||
| 88 | behalf. For information about how to set permissions, see the Amazon | ||
| 89 | Machine Learning Developer Guide | ||
| 90 | (https://docs.aws.amazon.com/machine-learning/latest/dg). | ||
| 91 | |||
| 92 | |||
| 93 | |||
| 94 | |||
| 95 | =head1 SEE ALSO | ||
| 96 | |||
| 97 | This class forms part of L<Paws>, documenting arguments for method CreateBatchPrediction in L<Paws::MachineLearning> | ||
| 98 | |||
| 99 | =head1 BUGS and CONTRIBUTIONS | ||
| 100 | |||
| 101 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 102 | |||
| 103 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 104 | |||
| 105 | =cut | ||
| 106 |