« blib/lib/Paws/LookoutEquipment/CreateInferenceSchedulerResponse.pm
↑ Summary
blib/lib/Paws/LookoutEquipment/CreateModelResponse.pm »
| 1 | |||
| 2 | package Paws::LookoutEquipment::CreateModel; | ||
| 3 | use Moose; | ||
| 4 | has ClientToken => (is => 'ro', isa => 'Str', required => 1); | ||
| 5 | has DataPreProcessingConfiguration => (is => 'ro', isa => 'Paws::LookoutEquipment::DataPreProcessingConfiguration'); | ||
| 6 | has DatasetName => (is => 'ro', isa => 'Str', required => 1); | ||
| 7 | has DatasetSchema => (is => 'ro', isa => 'Paws::LookoutEquipment::DatasetSchema'); | ||
| 8 | has EvaluationDataEndTime => (is => 'ro', isa => 'Str'); | ||
| 9 | has EvaluationDataStartTime => (is => 'ro', isa => 'Str'); | ||
| 10 | has LabelsInputConfiguration => (is => 'ro', isa => 'Paws::LookoutEquipment::LabelsInputConfiguration'); | ||
| 11 | has ModelName => (is => 'ro', isa => 'Str', required => 1); | ||
| 12 | has RoleArn => (is => 'ro', isa => 'Str'); | ||
| 13 | has ServerSideKmsKeyId => (is => 'ro', isa => 'Str'); | ||
| 14 | has Tags => (is => 'ro', isa => 'ArrayRef[Paws::LookoutEquipment::Tag]'); | ||
| 15 | has TrainingDataEndTime => (is => 'ro', isa => 'Str'); | ||
| 16 | has TrainingDataStartTime => (is => 'ro', isa => 'Str'); | ||
| 17 | |||
| 18 | use MooseX::ClassAttribute; | ||
| 19 | |||
| 20 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateModel'); | ||
| 21 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::LookoutEquipment::CreateModelResponse'); | ||
| 22 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 23 | 1; | ||
| 24 | |||
| 25 | ### main pod documentation begin ### | ||
| 26 | |||
| 27 | =head1 NAME | ||
| 28 | |||
| 29 | Paws::LookoutEquipment::CreateModel - Arguments for method CreateModel on L<Paws::LookoutEquipment> | ||
| 30 | |||
| 31 | =head1 DESCRIPTION | ||
| 32 | |||
| 33 | This class represents the parameters used for calling the method CreateModel on the | ||
| 34 | L<Amazon Lookout for Equipment|Paws::LookoutEquipment> service. Use the attributes of this class | ||
| 35 | as arguments to method CreateModel. | ||
| 36 | |||
| 37 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateModel. | ||
| 38 | |||
| 39 | =head1 SYNOPSIS | ||
| 40 | |||
| 41 | my $lookoutequipment = Paws->service('LookoutEquipment'); | ||
| 42 | my $CreateModelResponse = $lookoutequipment->CreateModel( | ||
| 43 | ClientToken => 'MyIdempotenceToken', | ||
| 44 | DatasetName => 'MyDatasetIdentifier', | ||
| 45 | ModelName => 'MyModelName', | ||
| 46 | DataPreProcessingConfiguration => { | ||
| 47 | TargetSamplingRate => 'PT1S' | ||
| 48 | , # values: PT1S, PT5S, PT10S, PT15S, PT30S, PT1M, PT5M, PT10M, PT15M, PT30M, PT1H; OPTIONAL | ||
| 49 | }, # OPTIONAL | ||
| 50 | DatasetSchema => { | ||
| 51 | InlineDataSchema => | ||
| 52 | 'MyInlineDataSchema', # min: 1, max: 1000000; OPTIONAL | ||
| 53 | }, # OPTIONAL | ||
| 54 | EvaluationDataEndTime => '1970-01-01T01:00:00', # OPTIONAL | ||
| 55 | EvaluationDataStartTime => '1970-01-01T01:00:00', # OPTIONAL | ||
| 56 | LabelsInputConfiguration => { | ||
| 57 | S3InputConfiguration => { | ||
| 58 | Bucket => 'MyS3Bucket', # min: 3, max: 63 | ||
| 59 | Prefix => 'MyS3Prefix', # max: 1024; OPTIONAL | ||
| 60 | }, | ||
| 61 | |||
| 62 | }, # OPTIONAL | ||
| 63 | RoleArn => 'MyIamRoleArn', # OPTIONAL | ||
| 64 | ServerSideKmsKeyId => 'MyNameOrArn', # OPTIONAL | ||
| 65 | Tags => [ | ||
| 66 | { | ||
| 67 | Key => 'MyTagKey', # min: 1, max: 128 | ||
| 68 | Value => 'MyTagValue', # max: 256 | ||
| 69 | |||
| 70 | }, | ||
| 71 | ... | ||
| 72 | ], # OPTIONAL | ||
| 73 | TrainingDataEndTime => '1970-01-01T01:00:00', # OPTIONAL | ||
| 74 | TrainingDataStartTime => '1970-01-01T01:00:00', # OPTIONAL | ||
| 75 | ); | ||
| 76 | |||
| 77 | # Results: | ||
| 78 | my $ModelArn = $CreateModelResponse->ModelArn; | ||
| 79 | my $Status = $CreateModelResponse->Status; | ||
| 80 | |||
| 81 | # Returns a L<Paws::LookoutEquipment::CreateModelResponse> object. | ||
| 82 | |||
| 83 | 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. | ||
| 84 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/lookoutequipment/CreateModel> | ||
| 85 | |||
| 86 | =head1 ATTRIBUTES | ||
| 87 | |||
| 88 | |||
| 89 | =head2 B<REQUIRED> ClientToken => Str | ||
| 90 | |||
| 91 | A unique identifier for the request. If you do not set the client | ||
| 92 | request token, Amazon Lookout for Equipment generates one. | ||
| 93 | |||
| 94 | |||
| 95 | |||
| 96 | =head2 DataPreProcessingConfiguration => L<Paws::LookoutEquipment::DataPreProcessingConfiguration> | ||
| 97 | |||
| 98 | The configuration is the C<TargetSamplingRate>, which is the sampling | ||
| 99 | rate of the data after post processing by Amazon Lookout for Equipment. | ||
| 100 | For example, if you provide data that has been collected at a 1 second | ||
| 101 | level and you want the system to resample the data at a 1 minute rate | ||
| 102 | before training, the C<TargetSamplingRate> is 1 minute. | ||
| 103 | |||
| 104 | When providing a value for the C<TargetSamplingRate>, you must attach | ||
| 105 | the prefix "PT" to the rate you want. The value for a 1 second rate is | ||
| 106 | therefore I<PT1S>, the value for a 15 minute rate is I<PT15M>, and the | ||
| 107 | value for a 1 hour rate is I<PT1H> | ||
| 108 | |||
| 109 | |||
| 110 | |||
| 111 | =head2 B<REQUIRED> DatasetName => Str | ||
| 112 | |||
| 113 | The name of the dataset for the ML model being created. | ||
| 114 | |||
| 115 | |||
| 116 | |||
| 117 | =head2 DatasetSchema => L<Paws::LookoutEquipment::DatasetSchema> | ||
| 118 | |||
| 119 | The data schema for the ML model being created. | ||
| 120 | |||
| 121 | |||
| 122 | |||
| 123 | =head2 EvaluationDataEndTime => Str | ||
| 124 | |||
| 125 | Indicates the time reference in the dataset that should be used to end | ||
| 126 | the subset of evaluation data for the ML model. | ||
| 127 | |||
| 128 | |||
| 129 | |||
| 130 | =head2 EvaluationDataStartTime => Str | ||
| 131 | |||
| 132 | Indicates the time reference in the dataset that should be used to | ||
| 133 | begin the subset of evaluation data for the ML model. | ||
| 134 | |||
| 135 | |||
| 136 | |||
| 137 | =head2 LabelsInputConfiguration => L<Paws::LookoutEquipment::LabelsInputConfiguration> | ||
| 138 | |||
| 139 | The input configuration for the labels being used for the ML model | ||
| 140 | that's being created. | ||
| 141 | |||
| 142 | |||
| 143 | |||
| 144 | =head2 B<REQUIRED> ModelName => Str | ||
| 145 | |||
| 146 | The name for the ML model to be created. | ||
| 147 | |||
| 148 | |||
| 149 | |||
| 150 | =head2 RoleArn => Str | ||
| 151 | |||
| 152 | The Amazon Resource Name (ARN) of a role with permission to access the | ||
| 153 | data source being used to create the ML model. | ||
| 154 | |||
| 155 | |||
| 156 | |||
| 157 | =head2 ServerSideKmsKeyId => Str | ||
| 158 | |||
| 159 | Provides the identifier of the AWS KMS customer master key (CMK) used | ||
| 160 | to encrypt model data by Amazon Lookout for Equipment. | ||
| 161 | |||
| 162 | |||
| 163 | |||
| 164 | =head2 Tags => ArrayRef[L<Paws::LookoutEquipment::Tag>] | ||
| 165 | |||
| 166 | Any tags associated with the ML model being created. | ||
| 167 | |||
| 168 | |||
| 169 | |||
| 170 | =head2 TrainingDataEndTime => Str | ||
| 171 | |||
| 172 | Indicates the time reference in the dataset that should be used to end | ||
| 173 | the subset of training data for the ML model. | ||
| 174 | |||
| 175 | |||
| 176 | |||
| 177 | =head2 TrainingDataStartTime => Str | ||
| 178 | |||
| 179 | Indicates the time reference in the dataset that should be used to | ||
| 180 | begin the subset of training data for the ML model. | ||
| 181 | |||
| 182 | |||
| 183 | |||
| 184 | |||
| 185 | =head1 SEE ALSO | ||
| 186 | |||
| 187 | This class forms part of L<Paws>, documenting arguments for method CreateModel in L<Paws::LookoutEquipment> | ||
| 188 | |||
| 189 | =head1 BUGS and CONTRIBUTIONS | ||
| 190 | |||
| 191 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 192 | |||
| 193 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 194 | |||
| 195 | =cut | ||
| 196 |