« blib/lib/Paws/LookoutVision/CreateDatasetResponse.pm
↑ Summary
blib/lib/Paws/LookoutVision/CreateModelResponse.pm »
| 1 | |||
| 2 | package Paws::LookoutVision::CreateModel; | ||
| 3 | use Moose; | ||
| 4 | has ClientToken => (is => 'ro', isa => 'Str', traits => ['ParamInHeader'], header_name => 'X-Amzn-Client-Token'); | ||
| 5 | has Description => (is => 'ro', isa => 'Str'); | ||
| 6 | has KmsKeyId => (is => 'ro', isa => 'Str'); | ||
| 7 | has OutputConfig => (is => 'ro', isa => 'Paws::LookoutVision::OutputConfig', required => 1); | ||
| 8 | has ProjectName => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'projectName', required => 1); | ||
| 9 | has Tags => (is => 'ro', isa => 'ArrayRef[Paws::LookoutVision::Tag]'); | ||
| 10 | |||
| 11 | use MooseX::ClassAttribute; | ||
| 12 | |||
| 13 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateModel'); | ||
| 14 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/2020-11-20/projects/{projectName}/models'); | ||
| 15 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'POST'); | ||
| 16 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::LookoutVision::CreateModelResponse'); | ||
| 17 | 1; | ||
| 18 | |||
| 19 | ### main pod documentation begin ### | ||
| 20 | |||
| 21 | =head1 NAME | ||
| 22 | |||
| 23 | Paws::LookoutVision::CreateModel - Arguments for method CreateModel on L<Paws::LookoutVision> | ||
| 24 | |||
| 25 | =head1 DESCRIPTION | ||
| 26 | |||
| 27 | This class represents the parameters used for calling the method CreateModel on the | ||
| 28 | L<Amazon Lookout for Vision|Paws::LookoutVision> service. Use the attributes of this class | ||
| 29 | as arguments to method CreateModel. | ||
| 30 | |||
| 31 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateModel. | ||
| 32 | |||
| 33 | =head1 SYNOPSIS | ||
| 34 | |||
| 35 | my $lookoutvision = Paws->service('LookoutVision'); | ||
| 36 | my $CreateModelResponse = $lookoutvision->CreateModel( | ||
| 37 | OutputConfig => { | ||
| 38 | S3Location => { | ||
| 39 | Bucket => 'MyS3BucketName', # min: 3, max: 63 | ||
| 40 | Prefix => 'MyS3KeyPrefix', # max: 1024; OPTIONAL | ||
| 41 | }, | ||
| 42 | |||
| 43 | }, | ||
| 44 | ProjectName => 'MyProjectName', | ||
| 45 | ClientToken => 'MyClientToken', # OPTIONAL | ||
| 46 | Description => 'MyModelDescriptionMessage', # OPTIONAL | ||
| 47 | KmsKeyId => 'MyKmsKeyId', # OPTIONAL | ||
| 48 | Tags => [ | ||
| 49 | { | ||
| 50 | Key => 'MyTagKey', # min: 1, max: 128 | ||
| 51 | Value => 'MyTagValue', # max: 256 | ||
| 52 | |||
| 53 | }, | ||
| 54 | ... | ||
| 55 | ], # OPTIONAL | ||
| 56 | ); | ||
| 57 | |||
| 58 | # Results: | ||
| 59 | my $ModelMetadata = $CreateModelResponse->ModelMetadata; | ||
| 60 | |||
| 61 | # Returns a L<Paws::LookoutVision::CreateModelResponse> object. | ||
| 62 | |||
| 63 | 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. | ||
| 64 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/lookoutvision/CreateModel> | ||
| 65 | |||
| 66 | =head1 ATTRIBUTES | ||
| 67 | |||
| 68 | |||
| 69 | =head2 ClientToken => Str | ||
| 70 | |||
| 71 | ClientToken is an idempotency token that ensures a call to | ||
| 72 | C<CreateModel> completes only once. You choose the value to pass. For | ||
| 73 | example, An issue, such as an network outage, might prevent you from | ||
| 74 | getting a response from C<CreateModel>. In this case, safely retry your | ||
| 75 | call to C<CreateModel> by using the same C<ClientToken> parameter | ||
| 76 | value. An error occurs if the other input parameters are not the same | ||
| 77 | as in the first request. Using a different value for C<ClientToken> is | ||
| 78 | considered a new call to C<CreateModel>. An idempotency token is active | ||
| 79 | for 8 hours. | ||
| 80 | |||
| 81 | |||
| 82 | |||
| 83 | =head2 Description => Str | ||
| 84 | |||
| 85 | A description for the version of the model. | ||
| 86 | |||
| 87 | |||
| 88 | |||
| 89 | =head2 KmsKeyId => Str | ||
| 90 | |||
| 91 | The identifier for your AWS Key Management Service (AWS KMS) customer | ||
| 92 | master key (CMK). The key is used to encrypt training and test images | ||
| 93 | copied into the service for model training. Your source images are | ||
| 94 | unaffected. If this parameter is not specified, the copied images are | ||
| 95 | encrypted by a key that AWS owns and manages. | ||
| 96 | |||
| 97 | |||
| 98 | |||
| 99 | =head2 B<REQUIRED> OutputConfig => L<Paws::LookoutVision::OutputConfig> | ||
| 100 | |||
| 101 | The location where Amazon Lookout for Vision saves the training | ||
| 102 | results. | ||
| 103 | |||
| 104 | |||
| 105 | |||
| 106 | =head2 B<REQUIRED> ProjectName => Str | ||
| 107 | |||
| 108 | The name of the project in which you want to create a model version. | ||
| 109 | |||
| 110 | |||
| 111 | |||
| 112 | =head2 Tags => ArrayRef[L<Paws::LookoutVision::Tag>] | ||
| 113 | |||
| 114 | A set of tags (key-value pairs) that you want to attach to the model. | ||
| 115 | |||
| 116 | |||
| 117 | |||
| 118 | |||
| 119 | =head1 SEE ALSO | ||
| 120 | |||
| 121 | This class forms part of L<Paws>, documenting arguments for method CreateModel in L<Paws::LookoutVision> | ||
| 122 | |||
| 123 | =head1 BUGS and CONTRIBUTIONS | ||
| 124 | |||
| 125 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 126 | |||
| 127 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 128 | |||
| 129 | =cut | ||
| 130 |