amazonka-iotsitewise-2.0: Amazon IoT SiteWise SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.IoTSiteWise.ListAssetRelationships

Description

Retrieves a paginated list of asset relationships for an asset. You can use this operation to identify an asset's root asset and all associated assets between that asset and its root.

This operation returns paginated results.

Synopsis

Creating a Request

data ListAssetRelationships Source #

See: newListAssetRelationships smart constructor.

Constructors

ListAssetRelationships' 

Fields

  • maxResults :: Maybe Natural

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

  • nextToken :: Maybe Text

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

  • assetId :: Text

    The ID of the asset.

  • traversalType :: TraversalType

    The type of traversal to use to identify asset relationships. Choose the following option:

    • PATH_TO_ROOT – Identify the asset's parent assets up to the root asset. The asset that you specify in assetId is the first result in the list of assetRelationshipSummaries, and the root asset is the last result.

Instances

Instances details
ToHeaders ListAssetRelationships Source # 
Instance details

Defined in Amazonka.IoTSiteWise.ListAssetRelationships

Methods

toHeaders :: ListAssetRelationships -> [Header] #

ToPath ListAssetRelationships Source # 
Instance details

Defined in Amazonka.IoTSiteWise.ListAssetRelationships

Methods

toPath :: ListAssetRelationships -> ByteString #

ToQuery ListAssetRelationships Source # 
Instance details

Defined in Amazonka.IoTSiteWise.ListAssetRelationships

Methods

toQuery :: ListAssetRelationships -> QueryString #

AWSPager ListAssetRelationships Source # 
Instance details

Defined in Amazonka.IoTSiteWise.ListAssetRelationships

Methods

page :: ListAssetRelationships -> AWSResponse ListAssetRelationships -> Maybe ListAssetRelationships #

AWSRequest ListAssetRelationships Source # 
Instance details

Defined in Amazonka.IoTSiteWise.ListAssetRelationships

Associated Types

type AWSResponse ListAssetRelationships #

Methods

request :: (Service -> Service) -> ListAssetRelationships -> Request ListAssetRelationships #

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListAssetRelationships -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListAssetRelationships))) #

Generic ListAssetRelationships Source # 
Instance details

Defined in Amazonka.IoTSiteWise.ListAssetRelationships

Associated Types

type Rep ListAssetRelationships :: Type -> Type #

Methods

from :: ListAssetRelationships -> Rep ListAssetRelationships x #

to :: Rep ListAssetRelationships x -> ListAssetRelationships #

Read ListAssetRelationships Source # 
Instance details

Defined in Amazonka.IoTSiteWise.ListAssetRelationships

Methods

readsPrec :: Int -> ReadS ListAssetRelationships #

readList :: ReadS [ListAssetRelationships] #

readPrec :: ReadPrec ListAssetRelationships #

readListPrec :: ReadPrec [ListAssetRelationships] #

Show ListAssetRelationships Source # 
Instance details

Defined in Amazonka.IoTSiteWise.ListAssetRelationships

Methods

showsPrec :: Int -> ListAssetRelationships -> ShowS #

show :: ListAssetRelationships -> String #

showList :: [ListAssetRelationships] -> ShowS #

NFData ListAssetRelationships Source # 
Instance details

Defined in Amazonka.IoTSiteWise.ListAssetRelationships

Methods

rnf :: ListAssetRelationships -> () #

Eq ListAssetRelationships Source # 
Instance details

Defined in Amazonka.IoTSiteWise.ListAssetRelationships

Methods

(==) :: ListAssetRelationships -> ListAssetRelationships -> Bool #

(/=) :: ListAssetRelationships -> ListAssetRelationships -> Bool #

Hashable ListAssetRelationships Source # 
Instance details

Defined in Amazonka.IoTSiteWise.ListAssetRelationships

Methods

hashWithSalt :: Int -> ListAssetRelationships -> Int #

hash :: ListAssetRelationships -> Int #

type AWSResponse ListAssetRelationships Source # 
Instance details

Defined in Amazonka.IoTSiteWise.ListAssetRelationships

type AWSResponse ListAssetRelationships = ListAssetRelationshipsResponse
type Rep ListAssetRelationships Source # 
Instance details

Defined in Amazonka.IoTSiteWise.ListAssetRelationships

type Rep ListAssetRelationships = D1 ('MetaData "ListAssetRelationships" "Amazonka.IoTSiteWise.ListAssetRelationships" "amazonka-iotsitewise-2.0-AK8rDlpQ5oPJsrLUUxJgY" 'False) (C1 ('MetaCons "ListAssetRelationships'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "assetId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "traversalType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 TraversalType))))

newListAssetRelationships Source #

Arguments

:: Text

ListAssetRelationships

-> TraversalType

$sel:traversalType:ListAssetRelationships'

-> ListAssetRelationships 

Create a value of ListAssetRelationships 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:

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

ListAssetRelationships, listAssetRelationships_nextToken - The token to be used for the next set of paginated results.

ListAssetRelationships, listAssetRelationships_assetId - The ID of the asset.

$sel:traversalType:ListAssetRelationships', listAssetRelationships_traversalType - The type of traversal to use to identify asset relationships. Choose the following option:

  • PATH_TO_ROOT – Identify the asset's parent assets up to the root asset. The asset that you specify in assetId is the first result in the list of assetRelationshipSummaries, and the root asset is the last result.

Request Lenses

listAssetRelationships_maxResults :: Lens' ListAssetRelationships (Maybe Natural) Source #

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

listAssetRelationships_nextToken :: Lens' ListAssetRelationships (Maybe Text) Source #

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

listAssetRelationships_assetId :: Lens' ListAssetRelationships Text Source #

The ID of the asset.

listAssetRelationships_traversalType :: Lens' ListAssetRelationships TraversalType Source #

The type of traversal to use to identify asset relationships. Choose the following option:

  • PATH_TO_ROOT – Identify the asset's parent assets up to the root asset. The asset that you specify in assetId is the first result in the list of assetRelationshipSummaries, and the root asset is the last result.

Destructuring the Response

data ListAssetRelationshipsResponse Source #

See: newListAssetRelationshipsResponse smart constructor.

Constructors

ListAssetRelationshipsResponse' 

Fields

Instances

Instances details
Generic ListAssetRelationshipsResponse Source # 
Instance details

Defined in Amazonka.IoTSiteWise.ListAssetRelationships

Associated Types

type Rep ListAssetRelationshipsResponse :: Type -> Type #

Methods

from :: ListAssetRelationshipsResponse -> Rep ListAssetRelationshipsResponse x #

to :: Rep ListAssetRelationshipsResponse x -> ListAssetRelationshipsResponse #

Read ListAssetRelationshipsResponse Source # 
Instance details

Defined in Amazonka.IoTSiteWise.ListAssetRelationships

Methods

readsPrec :: Int -> ReadS ListAssetRelationshipsResponse #

readList :: ReadS [ListAssetRelationshipsResponse] #

readPrec :: ReadPrec ListAssetRelationshipsResponse #

readListPrec :: ReadPrec [ListAssetRelationshipsResponse] #

Show ListAssetRelationshipsResponse Source # 
Instance details

Defined in Amazonka.IoTSiteWise.ListAssetRelationships

Methods

showsPrec :: Int -> ListAssetRelationshipsResponse -> ShowS #

show :: ListAssetRelationshipsResponse -> String #

showList :: [ListAssetRelationshipsResponse] -> ShowS #

NFData ListAssetRelationshipsResponse Source # 
Instance details

Defined in Amazonka.IoTSiteWise.ListAssetRelationships

Methods

rnf :: ListAssetRelationshipsResponse -> () #

Eq ListAssetRelationshipsResponse Source # 
Instance details

Defined in Amazonka.IoTSiteWise.ListAssetRelationships

Methods

(==) :: ListAssetRelationshipsResponse -> ListAssetRelationshipsResponse -> Bool #

(/=) :: ListAssetRelationshipsResponse -> ListAssetRelationshipsResponse -> Bool #

type Rep ListAssetRelationshipsResponse Source # 
Instance details

Defined in Amazonka.IoTSiteWise.ListAssetRelationships

type Rep ListAssetRelationshipsResponse = D1 ('MetaData "ListAssetRelationshipsResponse" "Amazonka.IoTSiteWise.ListAssetRelationships" "amazonka-iotsitewise-2.0-AK8rDlpQ5oPJsrLUUxJgY" 'False) (C1 ('MetaCons "ListAssetRelationshipsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "assetRelationshipSummaries") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [AssetRelationshipSummary]))))

newListAssetRelationshipsResponse Source #

Arguments

:: Int

$sel:httpStatus:ListAssetRelationshipsResponse'

-> ListAssetRelationshipsResponse 

Create a value of ListAssetRelationshipsResponse 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:

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

$sel:httpStatus:ListAssetRelationshipsResponse', listAssetRelationshipsResponse_httpStatus - The response's http status code.

$sel:assetRelationshipSummaries:ListAssetRelationshipsResponse', listAssetRelationshipsResponse_assetRelationshipSummaries - A list that summarizes each asset relationship.

Response Lenses

listAssetRelationshipsResponse_nextToken :: Lens' ListAssetRelationshipsResponse (Maybe Text) Source #

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

listAssetRelationshipsResponse_httpStatus :: Lens' ListAssetRelationshipsResponse Int Source #

The response's http status code.

listAssetRelationshipsResponse_assetRelationshipSummaries :: Lens' ListAssetRelationshipsResponse [AssetRelationshipSummary] Source #

A list that summarizes each asset relationship.