« blib/lib/Paws/Braket/QuantumTaskSummary.pm
↑ Summary
blib/lib/Paws/Braket/SearchDevicesFilter.pm »
| 1 | |||
| 2 | package Paws::Braket::SearchDevices; | ||
| 3 | use Moose; | ||
| 4 | has Filters => (is => 'ro', isa => 'ArrayRef[Paws::Braket::SearchDevicesFilter]', traits => ['NameInRequest'], request_name => 'filters', required => 1); | ||
| 5 | has MaxResults => (is => 'ro', isa => 'Int', traits => ['NameInRequest'], request_name => 'maxResults'); | ||
| 6 | has NextToken => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'nextToken'); | ||
| 7 | |||
| 8 | use MooseX::ClassAttribute; | ||
| 9 | |||
| 10 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'SearchDevices'); | ||
| 11 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/devices'); | ||
| 12 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'POST'); | ||
| 13 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Braket::SearchDevicesResponse'); | ||
| 14 | 1; | ||
| 15 | |||
| 16 | ### main pod documentation begin ### | ||
| 17 | |||
| 18 | =head1 NAME | ||
| 19 | |||
| 20 | Paws::Braket::SearchDevices - Arguments for method SearchDevices on L<Paws::Braket> | ||
| 21 | |||
| 22 | =head1 DESCRIPTION | ||
| 23 | |||
| 24 | This class represents the parameters used for calling the method SearchDevices on the | ||
| 25 | L<Braket|Paws::Braket> service. Use the attributes of this class | ||
| 26 | as arguments to method SearchDevices. | ||
| 27 | |||
| 28 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to SearchDevices. | ||
| 29 | |||
| 30 | =head1 SYNOPSIS | ||
| 31 | |||
| 32 | my $braket = Paws->service('Braket'); | ||
| 33 | my $SearchDevicesResponse = $braket->SearchDevices( | ||
| 34 | Filters => [ | ||
| 35 | { | ||
| 36 | Name => 'MySearchDevicesFilterNameString', # min: 1, max: 64 | ||
| 37 | Values => [ | ||
| 38 | 'MyString256', ... # min: 1, max: 256 | ||
| 39 | ], # min: 1, max: 10 | ||
| 40 | |||
| 41 | }, | ||
| 42 | ... | ||
| 43 | ], | ||
| 44 | MaxResults => 1, # OPTIONAL | ||
| 45 | NextToken => 'MyString', # OPTIONAL | ||
| 46 | ); | ||
| 47 | |||
| 48 | # Results: | ||
| 49 | my $Devices = $SearchDevicesResponse->Devices; | ||
| 50 | my $NextToken = $SearchDevicesResponse->NextToken; | ||
| 51 | |||
| 52 | # Returns a L<Paws::Braket::SearchDevicesResponse> 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/braket/SearchDevices> | ||
| 56 | |||
| 57 | =head1 ATTRIBUTES | ||
| 58 | |||
| 59 | |||
| 60 | =head2 B<REQUIRED> Filters => ArrayRef[L<Paws::Braket::SearchDevicesFilter>] | ||
| 61 | |||
| 62 | The filter values to use to search for a device. | ||
| 63 | |||
| 64 | |||
| 65 | |||
| 66 | =head2 MaxResults => Int | ||
| 67 | |||
| 68 | The maximum number of results to return in the response. | ||
| 69 | |||
| 70 | |||
| 71 | |||
| 72 | =head2 NextToken => Str | ||
| 73 | |||
| 74 | A token used for pagination of results returned in the response. Use | ||
| 75 | the token returned from the previous request continue results where the | ||
| 76 | previous request ended. | ||
| 77 | |||
| 78 | |||
| 79 | |||
| 80 | |||
| 81 | =head1 SEE ALSO | ||
| 82 | |||
| 83 | This class forms part of L<Paws>, documenting arguments for method SearchDevices in L<Paws::Braket> | ||
| 84 | |||
| 85 | =head1 BUGS and CONTRIBUTIONS | ||
| 86 | |||
| 87 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 88 | |||
| 89 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 90 | |||
| 91 | =cut | ||
| 92 |