« blib/lib/Paws/LookoutEquipment/CreateDatasetResponse.pm
↑ Summary
blib/lib/Paws/LookoutEquipment/CreateInferenceSchedulerResponse.pm »
| 1 | |||
| 2 | package Paws::LookoutEquipment::CreateInferenceScheduler; | ||
| 3 | use Moose; | ||
| 4 | has ClientToken => (is => 'ro', isa => 'Str', required => 1); | ||
| 5 | has DataDelayOffsetInMinutes => (is => 'ro', isa => 'Int'); | ||
| 6 | has DataInputConfiguration => (is => 'ro', isa => 'Paws::LookoutEquipment::InferenceInputConfiguration', required => 1); | ||
| 7 | has DataOutputConfiguration => (is => 'ro', isa => 'Paws::LookoutEquipment::InferenceOutputConfiguration', required => 1); | ||
| 8 | has DataUploadFrequency => (is => 'ro', isa => 'Str', required => 1); | ||
| 9 | has InferenceSchedulerName => (is => 'ro', isa => 'Str', required => 1); | ||
| 10 | has ModelName => (is => 'ro', isa => 'Str', required => 1); | ||
| 11 | has RoleArn => (is => 'ro', isa => 'Str', required => 1); | ||
| 12 | has ServerSideKmsKeyId => (is => 'ro', isa => 'Str'); | ||
| 13 | has Tags => (is => 'ro', isa => 'ArrayRef[Paws::LookoutEquipment::Tag]'); | ||
| 14 | |||
| 15 | use MooseX::ClassAttribute; | ||
| 16 | |||
| 17 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateInferenceScheduler'); | ||
| 18 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::LookoutEquipment::CreateInferenceSchedulerResponse'); | ||
| 19 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 20 | 1; | ||
| 21 | |||
| 22 | ### main pod documentation begin ### | ||
| 23 | |||
| 24 | =head1 NAME | ||
| 25 | |||
| 26 | Paws::LookoutEquipment::CreateInferenceScheduler - Arguments for method CreateInferenceScheduler on L<Paws::LookoutEquipment> | ||
| 27 | |||
| 28 | =head1 DESCRIPTION | ||
| 29 | |||
| 30 | This class represents the parameters used for calling the method CreateInferenceScheduler on the | ||
| 31 | L<Amazon Lookout for Equipment|Paws::LookoutEquipment> service. Use the attributes of this class | ||
| 32 | as arguments to method CreateInferenceScheduler. | ||
| 33 | |||
| 34 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateInferenceScheduler. | ||
| 35 | |||
| 36 | =head1 SYNOPSIS | ||
| 37 | |||
| 38 | my $lookoutequipment = Paws->service('LookoutEquipment'); | ||
| 39 | my $CreateInferenceSchedulerResponse = | ||
| 40 | $lookoutequipment->CreateInferenceScheduler( | ||
| 41 | ClientToken => 'MyIdempotenceToken', | ||
| 42 | DataInputConfiguration => { | ||
| 43 | InferenceInputNameConfiguration => { | ||
| 44 | ComponentTimestampDelimiter => | ||
| 45 | 'MyComponentTimestampDelimiter', # max: 1; OPTIONAL | ||
| 46 | TimestampFormat => 'MyFileNameTimestampFormat', # OPTIONAL | ||
| 47 | }, # OPTIONAL | ||
| 48 | InputTimeZoneOffset => 'MyTimeZoneOffset', # OPTIONAL | ||
| 49 | S3InputConfiguration => { | ||
| 50 | Bucket => 'MyS3Bucket', # min: 3, max: 63 | ||
| 51 | Prefix => 'MyS3Prefix', # max: 1024; OPTIONAL | ||
| 52 | }, # OPTIONAL | ||
| 53 | }, | ||
| 54 | DataOutputConfiguration => { | ||
| 55 | S3OutputConfiguration => { | ||
| 56 | Bucket => 'MyS3Bucket', # min: 3, max: 63 | ||
| 57 | Prefix => 'MyS3Prefix', # max: 1024; OPTIONAL | ||
| 58 | }, | ||
| 59 | KmsKeyId => 'MyNameOrArn', # min: 1, max: 2048; OPTIONAL | ||
| 60 | }, | ||
| 61 | DataUploadFrequency => 'PT5M', | ||
| 62 | InferenceSchedulerName => 'MyInferenceSchedulerName', | ||
| 63 | ModelName => 'MyModelName', | ||
| 64 | RoleArn => 'MyIamRoleArn', | ||
| 65 | DataDelayOffsetInMinutes => 1, # OPTIONAL | ||
| 66 | ServerSideKmsKeyId => 'MyNameOrArn', # OPTIONAL | ||
| 67 | Tags => [ | ||
| 68 | { | ||
| 69 | Key => 'MyTagKey', # min: 1, max: 128 | ||
| 70 | Value => 'MyTagValue', # max: 256 | ||
| 71 | |||
| 72 | }, | ||
| 73 | ... | ||
| 74 | ], # OPTIONAL | ||
| 75 | ); | ||
| 76 | |||
| 77 | # Results: | ||
| 78 | my $InferenceSchedulerArn = | ||
| 79 | $CreateInferenceSchedulerResponse->InferenceSchedulerArn; | ||
| 80 | my $InferenceSchedulerName = | ||
| 81 | $CreateInferenceSchedulerResponse->InferenceSchedulerName; | ||
| 82 | my $Status = $CreateInferenceSchedulerResponse->Status; | ||
| 83 | |||
| 84 | # Returns a L<Paws::LookoutEquipment::CreateInferenceSchedulerResponse> object. | ||
| 85 | |||
| 86 | 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. | ||
| 87 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/lookoutequipment/CreateInferenceScheduler> | ||
| 88 | |||
| 89 | =head1 ATTRIBUTES | ||
| 90 | |||
| 91 | |||
| 92 | =head2 B<REQUIRED> ClientToken => Str | ||
| 93 | |||
| 94 | A unique identifier for the request. If you do not set the client | ||
| 95 | request token, Amazon Lookout for Equipment generates one. | ||
| 96 | |||
| 97 | |||
| 98 | |||
| 99 | =head2 DataDelayOffsetInMinutes => Int | ||
| 100 | |||
| 101 | A period of time (in minutes) by which inference on the data is delayed | ||
| 102 | after the data starts. For instance, if you select an offset delay time | ||
| 103 | of five minutes, inference will not begin on the data until the first | ||
| 104 | data measurement after the five minute mark. For example, if five | ||
| 105 | minutes is selected, the inference scheduler will wake up at the | ||
| 106 | configured frequency with the additional five minute delay time to | ||
| 107 | check the customer S3 bucket. The customer can upload data at the same | ||
| 108 | frequency and they don't need to stop and restart the scheduler when | ||
| 109 | uploading new data. | ||
| 110 | |||
| 111 | |||
| 112 | |||
| 113 | =head2 B<REQUIRED> DataInputConfiguration => L<Paws::LookoutEquipment::InferenceInputConfiguration> | ||
| 114 | |||
| 115 | Specifies configuration information for the input data for the | ||
| 116 | inference scheduler, including delimiter, format, and dataset location. | ||
| 117 | |||
| 118 | |||
| 119 | |||
| 120 | =head2 B<REQUIRED> DataOutputConfiguration => L<Paws::LookoutEquipment::InferenceOutputConfiguration> | ||
| 121 | |||
| 122 | Specifies configuration information for the output results for the | ||
| 123 | inference scheduler, including the S3 location for the output. | ||
| 124 | |||
| 125 | |||
| 126 | |||
| 127 | =head2 B<REQUIRED> DataUploadFrequency => Str | ||
| 128 | |||
| 129 | How often data is uploaded to the source S3 bucket for the input data. | ||
| 130 | The value chosen is the length of time between data uploads. For | ||
| 131 | instance, if you select 5 minutes, Amazon Lookout for Equipment will | ||
| 132 | upload the real-time data to the source bucket once every 5 minutes. | ||
| 133 | This frequency also determines how often Amazon Lookout for Equipment | ||
| 134 | starts a scheduled inference on your data. In this example, it starts | ||
| 135 | once every 5 minutes. | ||
| 136 | |||
| 137 | Valid values are: C<"PT5M">, C<"PT10M">, C<"PT15M">, C<"PT30M">, C<"PT1H"> | ||
| 138 | |||
| 139 | =head2 B<REQUIRED> InferenceSchedulerName => Str | ||
| 140 | |||
| 141 | The name of the inference scheduler being created. | ||
| 142 | |||
| 143 | |||
| 144 | |||
| 145 | =head2 B<REQUIRED> ModelName => Str | ||
| 146 | |||
| 147 | The name of the previously trained ML model being used to create the | ||
| 148 | inference scheduler. | ||
| 149 | |||
| 150 | |||
| 151 | |||
| 152 | =head2 B<REQUIRED> RoleArn => Str | ||
| 153 | |||
| 154 | The Amazon Resource Name (ARN) of a role with permission to access the | ||
| 155 | data source being used for the inference. | ||
| 156 | |||
| 157 | |||
| 158 | |||
| 159 | =head2 ServerSideKmsKeyId => Str | ||
| 160 | |||
| 161 | Provides the identifier of the AWS KMS customer master key (CMK) used | ||
| 162 | to encrypt inference scheduler data by Amazon Lookout for Equipment. | ||
| 163 | |||
| 164 | |||
| 165 | |||
| 166 | =head2 Tags => ArrayRef[L<Paws::LookoutEquipment::Tag>] | ||
| 167 | |||
| 168 | Any tags associated with the inference scheduler. | ||
| 169 | |||
| 170 | |||
| 171 | |||
| 172 | |||
| 173 | =head1 SEE ALSO | ||
| 174 | |||
| 175 | This class forms part of L<Paws>, documenting arguments for method CreateInferenceScheduler in L<Paws::LookoutEquipment> | ||
| 176 | |||
| 177 | =head1 BUGS and CONTRIBUTIONS | ||
| 178 | |||
| 179 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 180 | |||
| 181 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 182 | |||
| 183 | =cut | ||
| 184 |