« blib/lib/Paws/LookoutMetrics/VpcConfiguration.pm
↑ Summary
blib/lib/Paws/LookoutVision/CreateDatasetResponse.pm »
| 1 | |||
| 2 | package Paws::LookoutVision::CreateDataset; | ||
| 3 | use Moose; | ||
| 4 | has ClientToken => (is => 'ro', isa => 'Str', traits => ['ParamInHeader'], header_name => 'X-Amzn-Client-Token'); | ||
| 5 | has DatasetSource => (is => 'ro', isa => 'Paws::LookoutVision::DatasetSource'); | ||
| 6 | has DatasetType => (is => 'ro', isa => 'Str', 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 => 'CreateDataset'); | ||
| 12 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/2020-11-20/projects/{projectName}/datasets'); | ||
| 13 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'POST'); | ||
| 14 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::LookoutVision::CreateDatasetResponse'); | ||
| 15 | 1; | ||
| 16 | |||
| 17 | ### main pod documentation begin ### | ||
| 18 | |||
| 19 | =head1 NAME | ||
| 20 | |||
| 21 | Paws::LookoutVision::CreateDataset - Arguments for method CreateDataset on L<Paws::LookoutVision> | ||
| 22 | |||
| 23 | =head1 DESCRIPTION | ||
| 24 | |||
| 25 | This class represents the parameters used for calling the method CreateDataset on the | ||
| 26 | L<Amazon Lookout for Vision|Paws::LookoutVision> service. Use the attributes of this class | ||
| 27 | as arguments to method CreateDataset. | ||
| 28 | |||
| 29 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateDataset. | ||
| 30 | |||
| 31 | =head1 SYNOPSIS | ||
| 32 | |||
| 33 | my $lookoutvision = Paws->service('LookoutVision'); | ||
| 34 | my $CreateDatasetResponse = $lookoutvision->CreateDataset( | ||
| 35 | DatasetType => 'MyDatasetType', | ||
| 36 | ProjectName => 'MyProjectName', | ||
| 37 | ClientToken => 'MyClientToken', # OPTIONAL | ||
| 38 | DatasetSource => { | ||
| 39 | GroundTruthManifest => { | ||
| 40 | S3Object => { | ||
| 41 | Bucket => 'MyS3BucketName', # min: 3, max: 63 | ||
| 42 | Key => 'MyS3ObjectKey', # min: 1, max: 1024 | ||
| 43 | VersionId => 'MyS3ObjectVersion', # min: 1, max: 1024; OPTIONAL | ||
| 44 | }, # OPTIONAL | ||
| 45 | }, # OPTIONAL | ||
| 46 | }, # OPTIONAL | ||
| 47 | ); | ||
| 48 | |||
| 49 | # Results: | ||
| 50 | my $DatasetMetadata = $CreateDatasetResponse->DatasetMetadata; | ||
| 51 | |||
| 52 | # Returns a L<Paws::LookoutVision::CreateDatasetResponse> object. | ||
| 53 | |||
| 54 | 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. | ||
| 55 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/lookoutvision/CreateDataset> | ||
| 56 | |||
| 57 | =head1 ATTRIBUTES | ||
| 58 | |||
| 59 | |||
| 60 | =head2 ClientToken => Str | ||
| 61 | |||
| 62 | ClientToken is an idempotency token that ensures a call to | ||
| 63 | C<CreateDataset> completes only once. You choose the value to pass. For | ||
| 64 | example, An issue, such as an network outage, might prevent you from | ||
| 65 | getting a response from C<CreateDataset>. In this case, safely retry | ||
| 66 | your call to C<CreateDataset> by using the same C<ClientToken> | ||
| 67 | parameter value. An error occurs if the other input parameters are not | ||
| 68 | the same as in the first request. Using a different value for | ||
| 69 | C<ClientToken> is considered a new call to C<CreateDataset>. An | ||
| 70 | idempotency token is active for 8 hours. | ||
| 71 | |||
| 72 | |||
| 73 | |||
| 74 | =head2 DatasetSource => L<Paws::LookoutVision::DatasetSource> | ||
| 75 | |||
| 76 | The location of the manifest file that Amazon Lookout for Vision uses | ||
| 77 | to create the dataset. | ||
| 78 | |||
| 79 | If you don't specify C<DatasetSource>, an empty dataset is created and | ||
| 80 | the operation synchronously returns. Later, you can add JSON Lines by | ||
| 81 | calling UpdateDatasetEntries. | ||
| 82 | |||
| 83 | If you specify a value for C<DataSource>, the manifest at the S3 | ||
| 84 | location is validated and used to create the dataset. The call to | ||
| 85 | C<CreateDataset> is asynchronous and might take a while to complete. To | ||
| 86 | find out the current status, Check the value of C<Status> returned in a | ||
| 87 | call to DescribeDataset. | ||
| 88 | |||
| 89 | |||
| 90 | |||
| 91 | =head2 B<REQUIRED> DatasetType => Str | ||
| 92 | |||
| 93 | The type of the dataset. Specify C<train> for a training dataset. | ||
| 94 | Specify C<test> for a test dataset. | ||
| 95 | |||
| 96 | |||
| 97 | |||
| 98 | =head2 B<REQUIRED> ProjectName => Str | ||
| 99 | |||
| 100 | The name of the project in which you want to create a dataset. | ||
| 101 | |||
| 102 | |||
| 103 | |||
| 104 | |||
| 105 | =head1 SEE ALSO | ||
| 106 | |||
| 107 | This class forms part of L<Paws>, documenting arguments for method CreateDataset in L<Paws::LookoutVision> | ||
| 108 | |||
| 109 | =head1 BUGS and CONTRIBUTIONS | ||
| 110 | |||
| 111 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 112 | |||
| 113 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 114 | |||
| 115 | =cut | ||
| 116 |