« blib/lib/Paws/LookoutVision/InputS3Object.pm
↑ Summary
blib/lib/Paws/LookoutVision/ListDatasetEntriesResponse.pm »
| 1 | |||
| 2 | package Paws::LookoutVision::ListDatasetEntries; | ||
| 3 | use Moose; | ||
| 4 | has AfterCreationDate => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'createdAfter'); | ||
| 5 | has AnomalyClass => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'anomalyClass'); | ||
| 6 | has BeforeCreationDate => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'createdBefore'); | ||
| 7 | has DatasetType => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'datasetType', required => 1); | ||
| 8 | has Labeled => (is => 'ro', isa => 'Bool', traits => ['ParamInQuery'], query_name => 'labeled'); | ||
| 9 | has MaxResults => (is => 'ro', isa => 'Int', traits => ['ParamInQuery'], query_name => 'maxResults'); | ||
| 10 | has NextToken => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'nextToken'); | ||
| 11 | has ProjectName => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'projectName', required => 1); | ||
| 12 | has SourceRefContains => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'sourceRefContains'); | ||
| 13 | |||
| 14 | use MooseX::ClassAttribute; | ||
| 15 | |||
| 16 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'ListDatasetEntries'); | ||
| 17 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/2020-11-20/projects/{projectName}/datasets/{datasetType}/entries'); | ||
| 18 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'GET'); | ||
| 19 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::LookoutVision::ListDatasetEntriesResponse'); | ||
| 20 | 1; | ||
| 21 | |||
| 22 | ### main pod documentation begin ### | ||
| 23 | |||
| 24 | =head1 NAME | ||
| 25 | |||
| 26 | Paws::LookoutVision::ListDatasetEntries - Arguments for method ListDatasetEntries on L<Paws::LookoutVision> | ||
| 27 | |||
| 28 | =head1 DESCRIPTION | ||
| 29 | |||
| 30 | This class represents the parameters used for calling the method ListDatasetEntries on the | ||
| 31 | L<Amazon Lookout for Vision|Paws::LookoutVision> service. Use the attributes of this class | ||
| 32 | as arguments to method ListDatasetEntries. | ||
| 33 | |||
| 34 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ListDatasetEntries. | ||
| 35 | |||
| 36 | =head1 SYNOPSIS | ||
| 37 | |||
| 38 | my $lookoutvision = Paws->service('LookoutVision'); | ||
| 39 | my $ListDatasetEntriesResponse = $lookoutvision->ListDatasetEntries( | ||
| 40 | DatasetType => 'MyDatasetType', | ||
| 41 | ProjectName => 'MyProjectName', | ||
| 42 | AfterCreationDate => '1970-01-01T01:00:00', # OPTIONAL | ||
| 43 | AnomalyClass => 'MyAnomalyClassFilter', # OPTIONAL | ||
| 44 | BeforeCreationDate => '1970-01-01T01:00:00', # OPTIONAL | ||
| 45 | Labeled => 1, # OPTIONAL | ||
| 46 | MaxResults => 1, # OPTIONAL | ||
| 47 | NextToken => 'MyPaginationToken', # OPTIONAL | ||
| 48 | SourceRefContains => 'MyQueryString', # OPTIONAL | ||
| 49 | ); | ||
| 50 | |||
| 51 | # Results: | ||
| 52 | my $DatasetEntries = $ListDatasetEntriesResponse->DatasetEntries; | ||
| 53 | my $NextToken = $ListDatasetEntriesResponse->NextToken; | ||
| 54 | |||
| 55 | # Returns a L<Paws::LookoutVision::ListDatasetEntriesResponse> object. | ||
| 56 | |||
| 57 | 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. | ||
| 58 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/lookoutvision/ListDatasetEntries> | ||
| 59 | |||
| 60 | =head1 ATTRIBUTES | ||
| 61 | |||
| 62 | |||
| 63 | =head2 AfterCreationDate => Str | ||
| 64 | |||
| 65 | Only includes entries after the specified date in the response. For | ||
| 66 | example, C<2020-06-23T00:00:00>. | ||
| 67 | |||
| 68 | |||
| 69 | |||
| 70 | =head2 AnomalyClass => Str | ||
| 71 | |||
| 72 | Specify C<normal> to include only normal images. Specify C<anomaly> to | ||
| 73 | only include anomalous entries. If you don't specify a value, Amazon | ||
| 74 | Lookout for Vision returns normal and anomalous images. | ||
| 75 | |||
| 76 | |||
| 77 | |||
| 78 | =head2 BeforeCreationDate => Str | ||
| 79 | |||
| 80 | Only includes entries before the specified date in the response. For | ||
| 81 | example, C<2020-06-23T00:00:00>. | ||
| 82 | |||
| 83 | |||
| 84 | |||
| 85 | =head2 B<REQUIRED> DatasetType => Str | ||
| 86 | |||
| 87 | The type of the dataset that you want to list. Specify C<train> to list | ||
| 88 | the training dataset. Specify C<test> to list the test dataset. If you | ||
| 89 | have a single dataset project, specify C<train>. | ||
| 90 | |||
| 91 | |||
| 92 | |||
| 93 | =head2 Labeled => Bool | ||
| 94 | |||
| 95 | Specify C<true> to include labeled entries, otherwise specify C<false>. | ||
| 96 | If you don't specify a value, Lookout for Vision returns all entries. | ||
| 97 | |||
| 98 | |||
| 99 | |||
| 100 | =head2 MaxResults => Int | ||
| 101 | |||
| 102 | The maximum number of results to return per paginated call. The largest | ||
| 103 | value you can specify is 100. If you specify a value greater than 100, | ||
| 104 | a ValidationException error occurs. The default value is 100. | ||
| 105 | |||
| 106 | |||
| 107 | |||
| 108 | =head2 NextToken => Str | ||
| 109 | |||
| 110 | If the previous response was incomplete (because there is more data to | ||
| 111 | retrieve), Amazon Lookout for Vision returns a pagination token in the | ||
| 112 | response. You can use this pagination token to retrieve the next set of | ||
| 113 | dataset entries. | ||
| 114 | |||
| 115 | |||
| 116 | |||
| 117 | =head2 B<REQUIRED> ProjectName => Str | ||
| 118 | |||
| 119 | The name of the project that contains the dataset that you want to | ||
| 120 | list. | ||
| 121 | |||
| 122 | |||
| 123 | |||
| 124 | =head2 SourceRefContains => Str | ||
| 125 | |||
| 126 | Perform a "contains" search on the values of the C<source-ref> key | ||
| 127 | within the dataset. For example a value of "IMG_17" returns all JSON | ||
| 128 | Lines where the C<source-ref> key value matches I<*IMG_17*>. | ||
| 129 | |||
| 130 | |||
| 131 | |||
| 132 | |||
| 133 | =head1 SEE ALSO | ||
| 134 | |||
| 135 | This class forms part of L<Paws>, documenting arguments for method ListDatasetEntries in L<Paws::LookoutVision> | ||
| 136 | |||
| 137 | =head1 BUGS and CONTRIBUTIONS | ||
| 138 | |||
| 139 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 140 | |||
| 141 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 142 | |||
| 143 | =cut | ||
| 144 |