Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.IoTSiteWise.ListAssociatedAssets

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Retrieves a paginated list of associated assets.

You can use this operation to do the following:

List child assets associated to a parent asset by a hierarchy that you specify.
List an asset's parent asset.

This operation returns paginated results.

Synopsis

Creating a Request

data ListAssociatedAssets Source #

See: newListAssociatedAssets smart constructor.

Constructors

ListAssociatedAssets'

Fields

hierarchyId :: Maybe Text
The ID of the hierarchy by which child assets are associated to the asset. To find a hierarchy ID, use the DescribeAsset or DescribeAssetModel operations. This parameter is required if you choose CHILD for traversalDirection.
For more information, see Asset hierarchies in the IoT SiteWise User Guide.
maxResults :: Maybe Natural
The maximum number of results to return for each paginated request.
Default: 50
nextToken :: Maybe Text
The token to be used for the next set of paginated results.
traversalDirection :: Maybe TraversalDirection
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
assetId :: Text
The ID of the asset to query.

Instances

Instances details

ToHeaders ListAssociatedAssets Source #
Instance details Defined in Amazonka.IoTSiteWise.ListAssociatedAssets Methods toHeaders :: ListAssociatedAssets -> [Header] #
ToPath ListAssociatedAssets Source #
Instance details Defined in Amazonka.IoTSiteWise.ListAssociatedAssets Methods toPath :: ListAssociatedAssets -> ByteString #
ToQuery ListAssociatedAssets Source #
Instance details Defined in Amazonka.IoTSiteWise.ListAssociatedAssets Methods toQuery :: ListAssociatedAssets -> QueryString #
AWSPager ListAssociatedAssets Source #
Instance details Defined in Amazonka.IoTSiteWise.ListAssociatedAssets Methods page :: ListAssociatedAssets -> AWSResponse ListAssociatedAssets -> Maybe ListAssociatedAssets #
AWSRequest ListAssociatedAssets Source #
Instance details Defined in Amazonka.IoTSiteWise.ListAssociatedAssets Associated Types type AWSResponse ListAssociatedAssets # Methods request :: (Service -> Service) -> ListAssociatedAssets -> Request ListAssociatedAssets # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListAssociatedAssets -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListAssociatedAssets))) #
Generic ListAssociatedAssets Source #
Instance details Defined in Amazonka.IoTSiteWise.ListAssociatedAssets Associated Types type Rep ListAssociatedAssets :: Type -> Type # Methods from :: ListAssociatedAssets -> Rep ListAssociatedAssets x # to :: Rep ListAssociatedAssets x -> ListAssociatedAssets #
Read ListAssociatedAssets Source #
Instance details Defined in Amazonka.IoTSiteWise.ListAssociatedAssets Methods readsPrec :: Int -> ReadS ListAssociatedAssets # readList :: ReadS [ListAssociatedAssets] # readPrec :: ReadPrec ListAssociatedAssets # readListPrec :: ReadPrec [ListAssociatedAssets] #
Show ListAssociatedAssets Source #
Instance details Defined in Amazonka.IoTSiteWise.ListAssociatedAssets Methods showsPrec :: Int -> ListAssociatedAssets -> ShowS # show :: ListAssociatedAssets -> String # showList :: [ListAssociatedAssets] -> ShowS #
NFData ListAssociatedAssets Source #
Instance details Defined in Amazonka.IoTSiteWise.ListAssociatedAssets Methods rnf :: ListAssociatedAssets -> () #
Eq ListAssociatedAssets Source #
Instance details Defined in Amazonka.IoTSiteWise.ListAssociatedAssets Methods (==) :: ListAssociatedAssets -> ListAssociatedAssets -> Bool # (/=) :: ListAssociatedAssets -> ListAssociatedAssets -> Bool #
Hashable ListAssociatedAssets Source #
Instance details Defined in Amazonka.IoTSiteWise.ListAssociatedAssets Methods hashWithSalt :: Int -> ListAssociatedAssets -> Int # hash :: ListAssociatedAssets -> Int #
type AWSResponse ListAssociatedAssets Source #
Instance details Defined in Amazonka.IoTSiteWise.ListAssociatedAssets type AWSResponse ListAssociatedAssets = ListAssociatedAssetsResponse
type Rep ListAssociatedAssets Source #
Instance details Defined in Amazonka.IoTSiteWise.ListAssociatedAssets type Rep ListAssociatedAssets = D1 ('MetaData "ListAssociatedAssets" "Amazonka.IoTSiteWise.ListAssociatedAssets" "amazonka-iotsitewise-2.0-AK8rDlpQ5oPJsrLUUxJgY" 'False) (C1 ('MetaCons "ListAssociatedAssets'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "hierarchyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "traversalDirection") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TraversalDirection)) :: S1 ('MetaSel ('Just "assetId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newListAssociatedAssets Source #

Arguments

:: Text	`ListAssociatedAssets`
-> ListAssociatedAssets

Create a value of ListAssociatedAssets with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

ListAssociatedAssets, listAssociatedAssets_hierarchyId - The ID of the hierarchy by which child assets are associated to the asset. To find a hierarchy ID, use the DescribeAsset or DescribeAssetModel operations. This parameter is required if you choose CHILD for traversalDirection.

For more information, see Asset hierarchies in the IoT SiteWise User Guide.

$sel:maxResults:ListAssociatedAssets', listAssociatedAssets_maxResults - The maximum number of results to return for each paginated request.

Default: 50

ListAssociatedAssets, listAssociatedAssets_nextToken - The token to be used for the next set of paginated results.

$sel:traversalDirection:ListAssociatedAssets', listAssociatedAssets_traversalDirection - 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

ListAssociatedAssets, listAssociatedAssets_assetId - The ID of the asset to query.

Request Lenses

listAssociatedAssets_hierarchyId :: Lens' ListAssociatedAssets (Maybe Text) Source #

The ID of the hierarchy by which child assets are associated to the asset. To find a hierarchy ID, use the DescribeAsset or DescribeAssetModel operations. This parameter is required if you choose CHILD for traversalDirection.

For more information, see Asset hierarchies in the IoT SiteWise User Guide.

listAssociatedAssets_maxResults :: Lens' ListAssociatedAssets (Maybe Natural) Source #

The maximum number of results to return for each paginated request.

Default: 50

listAssociatedAssets_nextToken :: Lens' ListAssociatedAssets (Maybe Text) Source #

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

listAssociatedAssets_traversalDirection :: Lens' ListAssociatedAssets (Maybe TraversalDirection) Source #

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

listAssociatedAssets_assetId :: Lens' ListAssociatedAssets Text Source #

The ID of the asset to query.

Destructuring the Response

data ListAssociatedAssetsResponse Source #

See: newListAssociatedAssetsResponse smart constructor.

Constructors

ListAssociatedAssetsResponse'
Fields nextToken :: Maybe Text The token for the next set of results, or null if there are no additional results. httpStatus :: Int The response's http status code. assetSummaries :: [AssociatedAssetsSummary] A list that summarizes the associated assets.

Instances

Instances details

Generic ListAssociatedAssetsResponse Source #
Instance details Defined in Amazonka.IoTSiteWise.ListAssociatedAssets Associated Types type Rep ListAssociatedAssetsResponse :: Type -> Type # Methods from :: ListAssociatedAssetsResponse -> Rep ListAssociatedAssetsResponse x # to :: Rep ListAssociatedAssetsResponse x -> ListAssociatedAssetsResponse #
Read ListAssociatedAssetsResponse Source #
Instance details Defined in Amazonka.IoTSiteWise.ListAssociatedAssets Methods readsPrec :: Int -> ReadS ListAssociatedAssetsResponse # readList :: ReadS [ListAssociatedAssetsResponse] # readPrec :: ReadPrec ListAssociatedAssetsResponse # readListPrec :: ReadPrec [ListAssociatedAssetsResponse] #
Show ListAssociatedAssetsResponse Source #
Instance details Defined in Amazonka.IoTSiteWise.ListAssociatedAssets Methods showsPrec :: Int -> ListAssociatedAssetsResponse -> ShowS # show :: ListAssociatedAssetsResponse -> String # showList :: [ListAssociatedAssetsResponse] -> ShowS #
NFData ListAssociatedAssetsResponse Source #
Instance details Defined in Amazonka.IoTSiteWise.ListAssociatedAssets Methods rnf :: ListAssociatedAssetsResponse -> () #
Eq ListAssociatedAssetsResponse Source #
Instance details Defined in Amazonka.IoTSiteWise.ListAssociatedAssets Methods (==) :: ListAssociatedAssetsResponse -> ListAssociatedAssetsResponse -> Bool # (/=) :: ListAssociatedAssetsResponse -> ListAssociatedAssetsResponse -> Bool #
type Rep ListAssociatedAssetsResponse Source #
Instance details Defined in Amazonka.IoTSiteWise.ListAssociatedAssets type Rep ListAssociatedAssetsResponse = D1 ('MetaData "ListAssociatedAssetsResponse" "Amazonka.IoTSiteWise.ListAssociatedAssets" "amazonka-iotsitewise-2.0-AK8rDlpQ5oPJsrLUUxJgY" 'False) (C1 ('MetaCons "ListAssociatedAssetsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :: S1 ('MetaSel ('Just "assetSummaries") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [AssociatedAssetsSummary]))))

newListAssociatedAssetsResponse Source #

Arguments

:: Int	`$sel:httpStatus:ListAssociatedAssetsResponse'`
-> ListAssociatedAssetsResponse

Create a value of ListAssociatedAssetsResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

ListAssociatedAssets, listAssociatedAssetsResponse_nextToken - The token for the next set of results, or null if there are no additional results.

$sel:httpStatus:ListAssociatedAssetsResponse', listAssociatedAssetsResponse_httpStatus - The response's http status code.

$sel:assetSummaries:ListAssociatedAssetsResponse', listAssociatedAssetsResponse_assetSummaries - A list that summarizes the associated assets.

Response Lenses

listAssociatedAssetsResponse_nextToken :: Lens' ListAssociatedAssetsResponse (Maybe Text) Source #

The token for the next set of results, or null if there are no additional results.

listAssociatedAssetsResponse_httpStatus :: Lens' ListAssociatedAssetsResponse Int Source #

The response's http status code.

listAssociatedAssetsResponse_assetSummaries :: Lens' ListAssociatedAssetsResponse [AssociatedAssetsSummary] Source #

A list that summarizes the associated assets.