« blib/lib/Paws/Personalize/ContinuousHyperParameterRange.pm
↑ Summary
blib/lib/Paws/Personalize/CreateBatchInferenceJobResponse.pm »
| 1 | |||
| 2 | package Paws::Personalize::CreateBatchInferenceJob; | ||
| 3 | use Moose; | ||
| 4 | has BatchInferenceJobConfig => (is => 'ro', isa => 'Paws::Personalize::BatchInferenceJobConfig', traits => ['NameInRequest'], request_name => 'batchInferenceJobConfig' ); | ||
| 5 | has FilterArn => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'filterArn' ); | ||
| 6 | has JobInput => (is => 'ro', isa => 'Paws::Personalize::BatchInferenceJobInput', traits => ['NameInRequest'], request_name => 'jobInput' , required => 1); | ||
| 7 | has JobName => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'jobName' , required => 1); | ||
| 8 | has JobOutput => (is => 'ro', isa => 'Paws::Personalize::BatchInferenceJobOutput', traits => ['NameInRequest'], request_name => 'jobOutput' , required => 1); | ||
| 9 | has NumResults => (is => 'ro', isa => 'Int', traits => ['NameInRequest'], request_name => 'numResults' ); | ||
| 10 | has RoleArn => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'roleArn' , required => 1); | ||
| 11 | has SolutionVersionArn => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'solutionVersionArn' , required => 1); | ||
| 12 | |||
| 13 | use MooseX::ClassAttribute; | ||
| 14 | |||
| 15 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateBatchInferenceJob'); | ||
| 16 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Personalize::CreateBatchInferenceJobResponse'); | ||
| 17 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 18 | 1; | ||
| 19 | |||
| 20 | ### main pod documentation begin ### | ||
| 21 | |||
| 22 | =head1 NAME | ||
| 23 | |||
| 24 | Paws::Personalize::CreateBatchInferenceJob - Arguments for method CreateBatchInferenceJob on L<Paws::Personalize> | ||
| 25 | |||
| 26 | =head1 DESCRIPTION | ||
| 27 | |||
| 28 | This class represents the parameters used for calling the method CreateBatchInferenceJob on the | ||
| 29 | L<Amazon Personalize|Paws::Personalize> service. Use the attributes of this class | ||
| 30 | as arguments to method CreateBatchInferenceJob. | ||
| 31 | |||
| 32 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateBatchInferenceJob. | ||
| 33 | |||
| 34 | =head1 SYNOPSIS | ||
| 35 | |||
| 36 | my $personalize = Paws->service('Personalize'); | ||
| 37 | my $CreateBatchInferenceJobResponse = $personalize->CreateBatchInferenceJob( | ||
| 38 | JobInput => { | ||
| 39 | S3DataSource => { | ||
| 40 | Path => 'MyS3Location', # max: 256 | ||
| 41 | KmsKeyArn => 'MyKmsKeyArn', # OPTIONAL | ||
| 42 | }, | ||
| 43 | |||
| 44 | }, | ||
| 45 | JobName => 'MyName', | ||
| 46 | JobOutput => { | ||
| 47 | S3DataDestination => { | ||
| 48 | Path => 'MyS3Location', # max: 256 | ||
| 49 | KmsKeyArn => 'MyKmsKeyArn', # OPTIONAL | ||
| 50 | }, | ||
| 51 | |||
| 52 | }, | ||
| 53 | RoleArn => 'MyRoleArn', | ||
| 54 | SolutionVersionArn => 'MyArn', | ||
| 55 | BatchInferenceJobConfig => { | ||
| 56 | ItemExplorationConfig => { | ||
| 57 | 'MyParameterName' => | ||
| 58 | 'MyParameterValue', # key: max: 256, value: max: 1000 | ||
| 59 | }, # max: 100; OPTIONAL | ||
| 60 | }, # OPTIONAL | ||
| 61 | FilterArn => 'MyArn', # OPTIONAL | ||
| 62 | NumResults => 1, # OPTIONAL | ||
| 63 | ); | ||
| 64 | |||
| 65 | # Results: | ||
| 66 | my $BatchInferenceJobArn = | ||
| 67 | $CreateBatchInferenceJobResponse->BatchInferenceJobArn; | ||
| 68 | |||
| 69 | # Returns a L<Paws::Personalize::CreateBatchInferenceJobResponse> object. | ||
| 70 | |||
| 71 | 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. | ||
| 72 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/personalize/CreateBatchInferenceJob> | ||
| 73 | |||
| 74 | =head1 ATTRIBUTES | ||
| 75 | |||
| 76 | |||
| 77 | =head2 BatchInferenceJobConfig => L<Paws::Personalize::BatchInferenceJobConfig> | ||
| 78 | |||
| 79 | The configuration details of a batch inference job. | ||
| 80 | |||
| 81 | |||
| 82 | |||
| 83 | =head2 FilterArn => Str | ||
| 84 | |||
| 85 | The ARN of the filter to apply to the batch inference job. For more | ||
| 86 | information on using filters, see Filtering Batch Recommendations | ||
| 87 | (https://docs.aws.amazon.com/personalize/latest/dg/filter-batch.html).. | ||
| 88 | |||
| 89 | |||
| 90 | |||
| 91 | =head2 B<REQUIRED> JobInput => L<Paws::Personalize::BatchInferenceJobInput> | ||
| 92 | |||
| 93 | The Amazon S3 path that leads to the input file to base your | ||
| 94 | recommendations on. The input material must be in JSON format. | ||
| 95 | |||
| 96 | |||
| 97 | |||
| 98 | =head2 B<REQUIRED> JobName => Str | ||
| 99 | |||
| 100 | The name of the batch inference job to create. | ||
| 101 | |||
| 102 | |||
| 103 | |||
| 104 | =head2 B<REQUIRED> JobOutput => L<Paws::Personalize::BatchInferenceJobOutput> | ||
| 105 | |||
| 106 | The path to the Amazon S3 bucket where the job's output will be stored. | ||
| 107 | |||
| 108 | |||
| 109 | |||
| 110 | =head2 NumResults => Int | ||
| 111 | |||
| 112 | The number of recommendations to retreive. | ||
| 113 | |||
| 114 | |||
| 115 | |||
| 116 | =head2 B<REQUIRED> RoleArn => Str | ||
| 117 | |||
| 118 | The ARN of the Amazon Identity and Access Management role that has | ||
| 119 | permissions to read and write to your input and output Amazon S3 | ||
| 120 | buckets respectively. | ||
| 121 | |||
| 122 | |||
| 123 | |||
| 124 | =head2 B<REQUIRED> SolutionVersionArn => Str | ||
| 125 | |||
| 126 | The Amazon Resource Name (ARN) of the solution version that will be | ||
| 127 | used to generate the batch inference recommendations. | ||
| 128 | |||
| 129 | |||
| 130 | |||
| 131 | |||
| 132 | =head1 SEE ALSO | ||
| 133 | |||
| 134 | This class forms part of L<Paws>, documenting arguments for method CreateBatchInferenceJob in L<Paws::Personalize> | ||
| 135 | |||
| 136 | =head1 BUGS and CONTRIBUTIONS | ||
| 137 | |||
| 138 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 139 | |||
| 140 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 141 | |||
| 142 | =cut | ||
| 143 |