NAME
Paws::IoTSiteWise::ListAssociatedAssets - Arguments for method ListAssociatedAssets on Paws::IoTSiteWise
DESCRIPTION
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.
SYNOPSIS
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
ATTRIBUTES
REQUIRED AssetId => Str
The ID of the asset to query.
HierarchyId => Str
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.
MaxResults => Int
The maximum number of results to be returned per paginated request.
Default: 50
NextToken => Str
The token to be used for the next set of paginated results.
TraversalDirection => Str
The direction to list associated assets. Choose one of the following options:
CHILD
– The list includes all child assets associated to the asset. ThehierarchyId
parameter is required if you chooseCHILD
.PARENT
– The list includes the asset's parent asset.
Default: CHILD
Valid values are: "PARENT"
, "CHILD"
SEE ALSO
This class forms part of Paws, documenting arguments for method ListAssociatedAssets in Paws::IoTSiteWise
BUGS and CONTRIBUTIONS
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