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.AssociateAssets

Description

Associates a child asset with the given parent asset through a hierarchy defined in the parent asset's model. For more information, see Associating assets in the IoT SiteWise User Guide.

Synopsis

Creating a Request

data AssociateAssets Source #

See: newAssociateAssets smart constructor.

Constructors

AssociateAssets' 

Fields

  • clientToken :: Maybe Text

    A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.

  • assetId :: Text

    The ID of the parent asset.

  • hierarchyId :: Text

    The ID of a hierarchy in the parent asset's model. Hierarchies allow different groupings of assets to be formed that all come from the same asset model. For more information, see Asset hierarchies in the IoT SiteWise User Guide.

  • childAssetId :: Text

    The ID of the child asset to be associated.

Instances

Instances details
ToJSON AssociateAssets Source # 
Instance details

Defined in Amazonka.IoTSiteWise.AssociateAssets

ToHeaders AssociateAssets Source # 
Instance details

Defined in Amazonka.IoTSiteWise.AssociateAssets

ToPath AssociateAssets Source # 
Instance details

Defined in Amazonka.IoTSiteWise.AssociateAssets

ToQuery AssociateAssets Source # 
Instance details

Defined in Amazonka.IoTSiteWise.AssociateAssets

AWSRequest AssociateAssets Source # 
Instance details

Defined in Amazonka.IoTSiteWise.AssociateAssets

Associated Types

type AWSResponse AssociateAssets #

Generic AssociateAssets Source # 
Instance details

Defined in Amazonka.IoTSiteWise.AssociateAssets

Associated Types

type Rep AssociateAssets :: Type -> Type #

Read AssociateAssets Source # 
Instance details

Defined in Amazonka.IoTSiteWise.AssociateAssets

Show AssociateAssets Source # 
Instance details

Defined in Amazonka.IoTSiteWise.AssociateAssets

NFData AssociateAssets Source # 
Instance details

Defined in Amazonka.IoTSiteWise.AssociateAssets

Methods

rnf :: AssociateAssets -> () #

Eq AssociateAssets Source # 
Instance details

Defined in Amazonka.IoTSiteWise.AssociateAssets

Hashable AssociateAssets Source # 
Instance details

Defined in Amazonka.IoTSiteWise.AssociateAssets

type AWSResponse AssociateAssets Source # 
Instance details

Defined in Amazonka.IoTSiteWise.AssociateAssets

type Rep AssociateAssets Source # 
Instance details

Defined in Amazonka.IoTSiteWise.AssociateAssets

type Rep AssociateAssets = D1 ('MetaData "AssociateAssets" "Amazonka.IoTSiteWise.AssociateAssets" "amazonka-iotsitewise-2.0-AK8rDlpQ5oPJsrLUUxJgY" 'False) (C1 ('MetaCons "AssociateAssets'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "clientToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "assetId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "hierarchyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "childAssetId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newAssociateAssets Source #

Create a value of AssociateAssets 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:clientToken:AssociateAssets', associateAssets_clientToken - A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.

AssociateAssets, associateAssets_assetId - The ID of the parent asset.

AssociateAssets, associateAssets_hierarchyId - The ID of a hierarchy in the parent asset's model. Hierarchies allow different groupings of assets to be formed that all come from the same asset model. For more information, see Asset hierarchies in the IoT SiteWise User Guide.

AssociateAssets, associateAssets_childAssetId - The ID of the child asset to be associated.

Request Lenses

associateAssets_clientToken :: Lens' AssociateAssets (Maybe Text) Source #

A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.

associateAssets_hierarchyId :: Lens' AssociateAssets Text Source #

The ID of a hierarchy in the parent asset's model. Hierarchies allow different groupings of assets to be formed that all come from the same asset model. For more information, see Asset hierarchies in the IoT SiteWise User Guide.

associateAssets_childAssetId :: Lens' AssociateAssets Text Source #

The ID of the child asset to be associated.

Destructuring the Response

data AssociateAssetsResponse Source #

See: newAssociateAssetsResponse smart constructor.

Instances

Instances details
Generic AssociateAssetsResponse Source # 
Instance details

Defined in Amazonka.IoTSiteWise.AssociateAssets

Associated Types

type Rep AssociateAssetsResponse :: Type -> Type #

Read AssociateAssetsResponse Source # 
Instance details

Defined in Amazonka.IoTSiteWise.AssociateAssets

Show AssociateAssetsResponse Source # 
Instance details

Defined in Amazonka.IoTSiteWise.AssociateAssets

NFData AssociateAssetsResponse Source # 
Instance details

Defined in Amazonka.IoTSiteWise.AssociateAssets

Methods

rnf :: AssociateAssetsResponse -> () #

Eq AssociateAssetsResponse Source # 
Instance details

Defined in Amazonka.IoTSiteWise.AssociateAssets

type Rep AssociateAssetsResponse Source # 
Instance details

Defined in Amazonka.IoTSiteWise.AssociateAssets

type Rep AssociateAssetsResponse = D1 ('MetaData "AssociateAssetsResponse" "Amazonka.IoTSiteWise.AssociateAssets" "amazonka-iotsitewise-2.0-AK8rDlpQ5oPJsrLUUxJgY" 'False) (C1 ('MetaCons "AssociateAssetsResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newAssociateAssetsResponse :: AssociateAssetsResponse Source #

Create a value of AssociateAssetsResponse with all optional fields omitted.

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