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