« blib/lib/Paws/IoTSiteWise/ListAssetRelationshipsResponse.pm
↑ Summary
blib/lib/Paws/IoTSiteWise/ListAssetsResponse.pm »
| 1 | |||
| 2 | package Paws::IoTSiteWise::ListAssets; | ||
| 3 | use Moose; | ||
| 4 | has AssetModelId => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'assetModelId'); | ||
| 5 | has Filter => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'filter'); | ||
| 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 | |||
| 9 | use MooseX::ClassAttribute; | ||
| 10 | |||
| 11 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'ListAssets'); | ||
| 12 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/assets'); | ||
| 13 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'GET'); | ||
| 14 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::IoTSiteWise::ListAssetsResponse'); | ||
| 15 | 1; | ||
| 16 | |||
| 17 | ### main pod documentation begin ### | ||
| 18 | |||
| 19 | =head1 NAME | ||
| 20 | |||
| 21 | Paws::IoTSiteWise::ListAssets - Arguments for method ListAssets on L<Paws::IoTSiteWise> | ||
| 22 | |||
| 23 | =head1 DESCRIPTION | ||
| 24 | |||
| 25 | This class represents the parameters used for calling the method ListAssets on the | ||
| 26 | L<AWS IoT SiteWise|Paws::IoTSiteWise> service. Use the attributes of this class | ||
| 27 | as arguments to method ListAssets. | ||
| 28 | |||
| 29 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ListAssets. | ||
| 30 | |||
| 31 | =head1 SYNOPSIS | ||
| 32 | |||
| 33 | my $iotsitewise = Paws->service('IoTSiteWise'); | ||
| 34 | my $ListAssetsResponse = $iotsitewise->ListAssets( | ||
| 35 | AssetModelId => 'MyID', # OPTIONAL | ||
| 36 | Filter => 'ALL', # OPTIONAL | ||
| 37 | MaxResults => 1, # OPTIONAL | ||
| 38 | NextToken => 'MyNextToken', # OPTIONAL | ||
| 39 | ); | ||
| 40 | |||
| 41 | # Results: | ||
| 42 | my $AssetSummaries = $ListAssetsResponse->AssetSummaries; | ||
| 43 | my $NextToken = $ListAssetsResponse->NextToken; | ||
| 44 | |||
| 45 | # Returns a L<Paws::IoTSiteWise::ListAssetsResponse> object. | ||
| 46 | |||
| 47 | 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. | ||
| 48 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/iotsitewise/ListAssets> | ||
| 49 | |||
| 50 | =head1 ATTRIBUTES | ||
| 51 | |||
| 52 | |||
| 53 | =head2 AssetModelId => Str | ||
| 54 | |||
| 55 | The ID of the asset model by which to filter the list of assets. This | ||
| 56 | parameter is required if you choose C<ALL> for C<filter>. | ||
| 57 | |||
| 58 | |||
| 59 | |||
| 60 | =head2 Filter => Str | ||
| 61 | |||
| 62 | The filter for the requested list of assets. Choose one of the | ||
| 63 | following options: | ||
| 64 | |||
| 65 | =over | ||
| 66 | |||
| 67 | =item * | ||
| 68 | |||
| 69 | C<ALL> E<ndash> The list includes all assets for a given asset model | ||
| 70 | ID. The C<assetModelId> parameter is required if you filter by C<ALL>. | ||
| 71 | |||
| 72 | =item * | ||
| 73 | |||
| 74 | C<TOP_LEVEL> E<ndash> The list includes only top-level assets in the | ||
| 75 | asset hierarchy tree. | ||
| 76 | |||
| 77 | =back | ||
| 78 | |||
| 79 | Default: C<ALL> | ||
| 80 | |||
| 81 | Valid values are: C<"ALL">, C<"TOP_LEVEL"> | ||
| 82 | |||
| 83 | =head2 MaxResults => Int | ||
| 84 | |||
| 85 | The maximum number of results to be returned per paginated request. | ||
| 86 | |||
| 87 | Default: 50 | ||
| 88 | |||
| 89 | |||
| 90 | |||
| 91 | =head2 NextToken => Str | ||
| 92 | |||
| 93 | The token to be used for the next set of paginated results. | ||
| 94 | |||
| 95 | |||
| 96 | |||
| 97 | |||
| 98 | =head1 SEE ALSO | ||
| 99 | |||
| 100 | This class forms part of L<Paws>, documenting arguments for method ListAssets in L<Paws::IoTSiteWise> | ||
| 101 | |||
| 102 | =head1 BUGS and CONTRIBUTIONS | ||
| 103 | |||
| 104 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 105 | |||
| 106 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 107 | |||
| 108 | =cut | ||
| 109 |