« blib/lib/Paws/IoTSiteWise/ListAssetsResponse.pm
↑ Summary
blib/lib/Paws/IoTSiteWise/ListAssociatedAssetsResponse.pm »
| 1 | |||
| 2 | package Paws::IoTSiteWise::ListAssociatedAssets; | ||
| 3 | use Moose; | ||
| 4 | has AssetId => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'assetId', required => 1); | ||
| 5 | has HierarchyId => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'hierarchyId'); | ||
| 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 TraversalDirection => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'traversalDirection'); | ||
| 9 | |||
| 10 | use MooseX::ClassAttribute; | ||
| 11 | |||
| 12 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'ListAssociatedAssets'); | ||
| 13 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/assets/{assetId}/hierarchies'); | ||
| 14 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'GET'); | ||
| 15 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::IoTSiteWise::ListAssociatedAssetsResponse'); | ||
| 16 | 1; | ||
| 17 | |||
| 18 | ### main pod documentation begin ### | ||
| 19 | |||
| 20 | =head1 NAME | ||
| 21 | |||
| 22 | Paws::IoTSiteWise::ListAssociatedAssets - Arguments for method ListAssociatedAssets on L<Paws::IoTSiteWise> | ||
| 23 | |||
| 24 | =head1 DESCRIPTION | ||
| 25 | |||
| 26 | This class represents the parameters used for calling the method ListAssociatedAssets on the | ||
| 27 | L<AWS IoT SiteWise|Paws::IoTSiteWise> service. Use the attributes of this class | ||
| 28 | as arguments to method ListAssociatedAssets. | ||
| 29 | |||
| 30 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ListAssociatedAssets. | ||
| 31 | |||
| 32 | =head1 SYNOPSIS | ||
| 33 | |||
| 34 | my $iotsitewise = Paws->service('IoTSiteWise'); | ||
| 35 | my $ListAssociatedAssetsResponse = $iotsitewise->ListAssociatedAssets( | ||
| 36 | AssetId => 'MyID', | ||
| 37 | HierarchyId => 'MyID', # OPTIONAL | ||
| 38 | MaxResults => 1, # OPTIONAL | ||
| 39 | NextToken => 'MyNextToken', # OPTIONAL | ||
| 40 | TraversalDirection => 'PARENT', # OPTIONAL | ||
| 41 | ); | ||
| 42 | |||
| 43 | # Results: | ||
| 44 | my $AssetSummaries = $ListAssociatedAssetsResponse->AssetSummaries; | ||
| 45 | my $NextToken = $ListAssociatedAssetsResponse->NextToken; | ||
| 46 | |||
| 47 | # Returns a L<Paws::IoTSiteWise::ListAssociatedAssetsResponse> object. | ||
| 48 | |||
| 49 | 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. | ||
| 50 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/iotsitewise/ListAssociatedAssets> | ||
| 51 | |||
| 52 | =head1 ATTRIBUTES | ||
| 53 | |||
| 54 | |||
| 55 | =head2 B<REQUIRED> AssetId => Str | ||
| 56 | |||
| 57 | The ID of the asset to query. | ||
| 58 | |||
| 59 | |||
| 60 | |||
| 61 | =head2 HierarchyId => Str | ||
| 62 | |||
| 63 | The ID of the hierarchy by which child assets are associated to the | ||
| 64 | asset. To find a hierarchy ID, use the DescribeAsset | ||
| 65 | (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_DescribeAsset.html) | ||
| 66 | or DescribeAssetModel | ||
| 67 | (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_DescribeAssetModel.html) | ||
| 68 | operations. This parameter is required if you choose C<CHILD> for | ||
| 69 | C<traversalDirection>. | ||
| 70 | |||
| 71 | For more information, see Asset hierarchies | ||
| 72 | (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-hierarchies.html) | ||
| 73 | in the I<AWS IoT SiteWise User Guide>. | ||
| 74 | |||
| 75 | |||
| 76 | |||
| 77 | =head2 MaxResults => Int | ||
| 78 | |||
| 79 | The maximum number of results to be returned per paginated request. | ||
| 80 | |||
| 81 | Default: 50 | ||
| 82 | |||
| 83 | |||
| 84 | |||
| 85 | =head2 NextToken => Str | ||
| 86 | |||
| 87 | The token to be used for the next set of paginated results. | ||
| 88 | |||
| 89 | |||
| 90 | |||
| 91 | =head2 TraversalDirection => Str | ||
| 92 | |||
| 93 | The direction to list associated assets. Choose one of the following | ||
| 94 | options: | ||
| 95 | |||
| 96 | =over | ||
| 97 | |||
| 98 | =item * | ||
| 99 | |||
| 100 | C<CHILD> E<ndash> The list includes all child assets associated to the | ||
| 101 | asset. The C<hierarchyId> parameter is required if you choose C<CHILD>. | ||
| 102 | |||
| 103 | =item * | ||
| 104 | |||
| 105 | C<PARENT> E<ndash> The list includes the asset's parent asset. | ||
| 106 | |||
| 107 | =back | ||
| 108 | |||
| 109 | Default: C<CHILD> | ||
| 110 | |||
| 111 | Valid values are: C<"PARENT">, C<"CHILD"> | ||
| 112 | |||
| 113 | |||
| 114 | =head1 SEE ALSO | ||
| 115 | |||
| 116 | This class forms part of L<Paws>, documenting arguments for method ListAssociatedAssets in L<Paws::IoTSiteWise> | ||
| 117 | |||
| 118 | =head1 BUGS and CONTRIBUTIONS | ||
| 119 | |||
| 120 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 121 | |||
| 122 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 123 | |||
| 124 | =cut | ||
| 125 |