« blib/lib/Paws/LookoutVision/S3Location.pm
↑ Summary
blib/lib/Paws/LookoutVision/StartModelResponse.pm »
| 1 | |||
| 2 | package Paws::LookoutVision::StartModel; | ||
| 3 | use Moose; | ||
| 4 | has ClientToken => (is => 'ro', isa => 'Str', traits => ['ParamInHeader'], header_name => 'X-Amzn-Client-Token'); | ||
| 5 | has MinInferenceUnits => (is => 'ro', isa => 'Int', required => 1); | ||
| 6 | has ModelVersion => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'modelVersion', required => 1); | ||
| 7 | has ProjectName => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'projectName', required => 1); | ||
| 8 | |||
| 9 | use MooseX::ClassAttribute; | ||
| 10 | |||
| 11 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'StartModel'); | ||
| 12 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/2020-11-20/projects/{projectName}/models/{modelVersion}/start'); | ||
| 13 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'POST'); | ||
| 14 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::LookoutVision::StartModelResponse'); | ||
| 15 | 1; | ||
| 16 | |||
| 17 | ### main pod documentation begin ### | ||
| 18 | |||
| 19 | =head1 NAME | ||
| 20 | |||
| 21 | Paws::LookoutVision::StartModel - Arguments for method StartModel on L<Paws::LookoutVision> | ||
| 22 | |||
| 23 | =head1 DESCRIPTION | ||
| 24 | |||
| 25 | This class represents the parameters used for calling the method StartModel on the | ||
| 26 | L<Amazon Lookout for Vision|Paws::LookoutVision> service. Use the attributes of this class | ||
| 27 | as arguments to method StartModel. | ||
| 28 | |||
| 29 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to StartModel. | ||
| 30 | |||
| 31 | =head1 SYNOPSIS | ||
| 32 | |||
| 33 | my $lookoutvision = Paws->service('LookoutVision'); | ||
| 34 | my $StartModelResponse = $lookoutvision->StartModel( | ||
| 35 | MinInferenceUnits => 1, | ||
| 36 | ModelVersion => 'MyModelVersion', | ||
| 37 | ProjectName => 'MyProjectName', | ||
| 38 | ClientToken => 'MyClientToken', # OPTIONAL | ||
| 39 | ); | ||
| 40 | |||
| 41 | # Results: | ||
| 42 | my $Status = $StartModelResponse->Status; | ||
| 43 | |||
| 44 | # Returns a L<Paws::LookoutVision::StartModelResponse> object. | ||
| 45 | |||
| 46 | 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. | ||
| 47 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/lookoutvision/StartModel> | ||
| 48 | |||
| 49 | =head1 ATTRIBUTES | ||
| 50 | |||
| 51 | |||
| 52 | =head2 ClientToken => Str | ||
| 53 | |||
| 54 | ClientToken is an idempotency token that ensures a call to | ||
| 55 | C<StartModel> completes only once. You choose the value to pass. For | ||
| 56 | example, An issue, such as an network outage, might prevent you from | ||
| 57 | getting a response from C<StartModel>. In this case, safely retry your | ||
| 58 | call to C<StartModel> by using the same C<ClientToken> parameter value. | ||
| 59 | An error occurs if the other input parameters are not the same as in | ||
| 60 | the first request. Using a different value for C<ClientToken> is | ||
| 61 | considered a new call to C<StartModel>. An idempotency token is active | ||
| 62 | for 8 hours. | ||
| 63 | |||
| 64 | |||
| 65 | |||
| 66 | =head2 B<REQUIRED> MinInferenceUnits => Int | ||
| 67 | |||
| 68 | The minimum number of inference units to use. A single inference unit | ||
| 69 | represents 1 hour of processing and can support up to 5 Transaction | ||
| 70 | Pers Second (TPS). Use a higher number to increase the TPS throughput | ||
| 71 | of your model. You are charged for the number of inference units that | ||
| 72 | you use. | ||
| 73 | |||
| 74 | |||
| 75 | |||
| 76 | =head2 B<REQUIRED> ModelVersion => Str | ||
| 77 | |||
| 78 | The version of the model that you want to start. | ||
| 79 | |||
| 80 | |||
| 81 | |||
| 82 | =head2 B<REQUIRED> ProjectName => Str | ||
| 83 | |||
| 84 | The name of the project that contains the model that you want to start. | ||
| 85 | |||
| 86 | |||
| 87 | |||
| 88 | |||
| 89 | =head1 SEE ALSO | ||
| 90 | |||
| 91 | This class forms part of L<Paws>, documenting arguments for method StartModel in L<Paws::LookoutVision> | ||
| 92 | |||
| 93 | =head1 BUGS and CONTRIBUTIONS | ||
| 94 | |||
| 95 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 96 | |||
| 97 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 98 | |||
| 99 | =cut | ||
| 100 |