« blib/lib/Paws/IoT/ListThingTypesResponse.pm
↑ Summary
blib/lib/Paws/IoT/ListThingsInBillingGroup.pm »
| 1 | |||
| 2 | package Paws::IoT::ListThings; | ||
| 3 | use Moose; | ||
| 4 | has AttributeName => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'attributeName'); | ||
| 5 | has AttributeValue => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'attributeValue'); | ||
| 6 | has MaxResults => (is => 'ro', isa => 'Int', traits => ['ParamInQuery'], query_name => 'maxResults'); | ||
| 7 | has NextToken => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'nextToken'); | ||
| 8 | has ThingTypeName => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'thingTypeName'); | ||
| 9 | has UsePrefixAttributeValue => (is => 'ro', isa => 'Bool', traits => ['ParamInQuery'], query_name => 'usePrefixAttributeValue'); | ||
| 10 | |||
| 11 | use MooseX::ClassAttribute; | ||
| 12 | |||
| 13 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'ListThings'); | ||
| 14 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/things'); | ||
| 15 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'GET'); | ||
| 16 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::IoT::ListThingsResponse'); | ||
| 17 | 1; | ||
| 18 | |||
| 19 | ### main pod documentation begin ### | ||
| 20 | |||
| 21 | =head1 NAME | ||
| 22 | |||
| 23 | Paws::IoT::ListThings - Arguments for method ListThings on L<Paws::IoT> | ||
| 24 | |||
| 25 | =head1 DESCRIPTION | ||
| 26 | |||
| 27 | This class represents the parameters used for calling the method ListThings on the | ||
| 28 | L<AWS IoT|Paws::IoT> service. Use the attributes of this class | ||
| 29 | as arguments to method ListThings. | ||
| 30 | |||
| 31 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ListThings. | ||
| 32 | |||
| 33 | =head1 SYNOPSIS | ||
| 34 | |||
| 35 | my $iot = Paws->service('IoT'); | ||
| 36 | my $ListThingsResponse = $iot->ListThings( | ||
| 37 | AttributeName => 'MyAttributeName', # OPTIONAL | ||
| 38 | AttributeValue => 'MyAttributeValue', # OPTIONAL | ||
| 39 | MaxResults => 1, # OPTIONAL | ||
| 40 | NextToken => 'MyNextToken', # OPTIONAL | ||
| 41 | ThingTypeName => 'MyThingTypeName', # OPTIONAL | ||
| 42 | UsePrefixAttributeValue => 1, # OPTIONAL | ||
| 43 | ); | ||
| 44 | |||
| 45 | # Results: | ||
| 46 | my $NextToken = $ListThingsResponse->NextToken; | ||
| 47 | my $Things = $ListThingsResponse->Things; | ||
| 48 | |||
| 49 | # Returns a L<Paws::IoT::ListThingsResponse> object. | ||
| 50 | |||
| 51 | 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. | ||
| 52 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/iot/ListThings> | ||
| 53 | |||
| 54 | =head1 ATTRIBUTES | ||
| 55 | |||
| 56 | |||
| 57 | =head2 AttributeName => Str | ||
| 58 | |||
| 59 | The attribute name used to search for things. | ||
| 60 | |||
| 61 | |||
| 62 | |||
| 63 | =head2 AttributeValue => Str | ||
| 64 | |||
| 65 | The attribute value used to search for things. | ||
| 66 | |||
| 67 | |||
| 68 | |||
| 69 | =head2 MaxResults => Int | ||
| 70 | |||
| 71 | The maximum number of results to return in this operation. | ||
| 72 | |||
| 73 | |||
| 74 | |||
| 75 | =head2 NextToken => Str | ||
| 76 | |||
| 77 | To retrieve the next set of results, the C<nextToken> value from a | ||
| 78 | previous response; otherwise B<null> to receive the first set of | ||
| 79 | results. | ||
| 80 | |||
| 81 | |||
| 82 | |||
| 83 | =head2 ThingTypeName => Str | ||
| 84 | |||
| 85 | The name of the thing type used to search for things. | ||
| 86 | |||
| 87 | |||
| 88 | |||
| 89 | =head2 UsePrefixAttributeValue => Bool | ||
| 90 | |||
| 91 | When C<true>, the action returns the thing resources with attribute | ||
| 92 | values that start with the C<attributeValue> provided. | ||
| 93 | |||
| 94 | When C<false>, or not present, the action returns only the thing | ||
| 95 | resources with attribute values that match the entire C<attributeValue> | ||
| 96 | provided. | ||
| 97 | |||
| 98 | |||
| 99 | |||
| 100 | |||
| 101 | =head1 SEE ALSO | ||
| 102 | |||
| 103 | This class forms part of L<Paws>, documenting arguments for method ListThings in L<Paws::IoT> | ||
| 104 | |||
| 105 | =head1 BUGS and CONTRIBUTIONS | ||
| 106 | |||
| 107 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 108 | |||
| 109 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 110 | |||
| 111 | =cut | ||
| 112 |