« blib/lib/Paws/LookoutVision/DeleteProjectResponse.pm
↑ Summary
blib/lib/Paws/LookoutVision/DescribeDatasetResponse.pm »
| 1 | |||
| 2 | package Paws::LookoutVision::DescribeDataset; | ||
| 3 | use Moose; | ||
| 4 | has DatasetType => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'datasetType', required => 1); | ||
| 5 | has ProjectName => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'projectName', required => 1); | ||
| 6 | |||
| 7 | use MooseX::ClassAttribute; | ||
| 8 | |||
| 9 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'DescribeDataset'); | ||
| 10 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/2020-11-20/projects/{projectName}/datasets/{datasetType}'); | ||
| 11 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'GET'); | ||
| 12 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::LookoutVision::DescribeDatasetResponse'); | ||
| 13 | 1; | ||
| 14 | |||
| 15 | ### main pod documentation begin ### | ||
| 16 | |||
| 17 | =head1 NAME | ||
| 18 | |||
| 19 | Paws::LookoutVision::DescribeDataset - Arguments for method DescribeDataset on L<Paws::LookoutVision> | ||
| 20 | |||
| 21 | =head1 DESCRIPTION | ||
| 22 | |||
| 23 | This class represents the parameters used for calling the method DescribeDataset on the | ||
| 24 | L<Amazon Lookout for Vision|Paws::LookoutVision> service. Use the attributes of this class | ||
| 25 | as arguments to method DescribeDataset. | ||
| 26 | |||
| 27 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DescribeDataset. | ||
| 28 | |||
| 29 | =head1 SYNOPSIS | ||
| 30 | |||
| 31 | my $lookoutvision = Paws->service('LookoutVision'); | ||
| 32 | my $DescribeDatasetResponse = $lookoutvision->DescribeDataset( | ||
| 33 | DatasetType => 'MyDatasetType', | ||
| 34 | ProjectName => 'MyProjectName', | ||
| 35 | |||
| 36 | ); | ||
| 37 | |||
| 38 | # Results: | ||
| 39 | my $DatasetDescription = $DescribeDatasetResponse->DatasetDescription; | ||
| 40 | |||
| 41 | # Returns a L<Paws::LookoutVision::DescribeDatasetResponse> object. | ||
| 42 | |||
| 43 | 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. | ||
| 44 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/lookoutvision/DescribeDataset> | ||
| 45 | |||
| 46 | =head1 ATTRIBUTES | ||
| 47 | |||
| 48 | |||
| 49 | =head2 B<REQUIRED> DatasetType => Str | ||
| 50 | |||
| 51 | The type of the dataset to describe. Specify C<train> to describe the | ||
| 52 | training dataset. Specify C<test> to describe the test dataset. If you | ||
| 53 | have a single dataset project, specify C<train> | ||
| 54 | |||
| 55 | |||
| 56 | |||
| 57 | =head2 B<REQUIRED> ProjectName => Str | ||
| 58 | |||
| 59 | The name of the project that contains the dataset that you want to | ||
| 60 | describe. | ||
| 61 | |||
| 62 | |||
| 63 | |||
| 64 | |||
| 65 | =head1 SEE ALSO | ||
| 66 | |||
| 67 | This class forms part of L<Paws>, documenting arguments for method DescribeDataset in L<Paws::LookoutVision> | ||
| 68 | |||
| 69 | =head1 BUGS and CONTRIBUTIONS | ||
| 70 | |||
| 71 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 72 | |||
| 73 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 74 | |||
| 75 | =cut | ||
| 76 |