GSP
Quick Navigator
Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages
Paws::IoTSiteWise::ListAssociatedAssets(3) User Contributed Perl Documentation Paws::IoTSiteWise::ListAssociatedAssets(3)

Paws::IoTSiteWise::ListAssociatedAssets - Arguments for method ListAssociatedAssets on Paws::IoTSiteWise

This class represents the parameters used for calling the method ListAssociatedAssets on the AWS IoT SiteWise service. Use the attributes of this class as arguments to method ListAssociatedAssets.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ListAssociatedAssets.

    my $iotsitewise = Paws->service('IoTSiteWise');
    my $ListAssociatedAssetsResponse = $iotsitewise->ListAssociatedAssets(
      AssetId            => 'MyID',
      HierarchyId        => 'MyID',           # OPTIONAL
      MaxResults         => 1,                # OPTIONAL
      NextToken          => 'MyNextToken',    # OPTIONAL
      TraversalDirection => 'PARENT',         # OPTIONAL
    );
    # Results:
    my $AssetSummaries = $ListAssociatedAssetsResponse->AssetSummaries;
    my $NextToken      = $ListAssociatedAssetsResponse->NextToken;
    # Returns a L<Paws::IoTSiteWise::ListAssociatedAssetsResponse> object.

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. For the AWS API documentation, see <https://docs.aws.amazon.com/goto/WebAPI/iotsitewise/ListAssociatedAssets>

REQUIRED AssetId => Str

The ID of the asset to query.

The ID of the hierarchy by which child assets are associated to the asset. To find a hierarchy ID, use the DescribeAsset (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_DescribeAsset.html) or DescribeAssetModel (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_DescribeAssetModel.html) operations. This parameter is required if you choose "CHILD" for "traversalDirection".

For more information, see Asset hierarchies (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-hierarchies.html) in the AWS IoT SiteWise User Guide.

The maximum number of results to be returned per paginated request.

Default: 50

The token to be used for the next set of paginated results.

The direction to list associated assets. Choose one of the following options:

  • "CHILD" – The list includes all child assets associated to the asset. The "hierarchyId" parameter is required if you choose "CHILD".
  • "PARENT" – The list includes the asset's parent asset.

Default: "CHILD"

Valid values are: "PARENT", "CHILD"

This class forms part of Paws, documenting arguments for method ListAssociatedAssets in Paws::IoTSiteWise

The source code is located here: <https://github.com/pplu/aws-sdk-perl>

Please report bugs to: <https://github.com/pplu/aws-sdk-perl/issues>

2022-06-01 perl v5.40.2
Search for    or go to Top of page |  Section 3 |  Main Index

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with ManDoc.