Amazonka.IoTSiteWise.AssociateAssets

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.

Creating a Request

data AssociateAssets

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

ToJSON AssociateAssets

Defined in Amazonka.IoTSiteWise.AssociateAssets

Methods

toJSON :: AssociateAssets -> Value

toEncoding :: AssociateAssets -> Encoding

toJSONList :: [AssociateAssets] -> Value

toEncodingList :: [AssociateAssets] -> Encoding

ToHeaders AssociateAssets

Defined in Amazonka.IoTSiteWise.AssociateAssets

Methods

toHeaders :: AssociateAssets -> [Header]

ToPath AssociateAssets

Defined in Amazonka.IoTSiteWise.AssociateAssets

Methods

toPath :: AssociateAssets -> ByteString

ToQuery AssociateAssets

Defined in Amazonka.IoTSiteWise.AssociateAssets

Methods

toQuery :: AssociateAssets -> QueryString

AWSRequest AssociateAssets

Defined in Amazonka.IoTSiteWise.AssociateAssets

Associated Types

type AWSResponse AssociateAssets

Methods

request :: (Service -> Service) -> AssociateAssets -> Request AssociateAssets

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

Generic AssociateAssets

Defined in Amazonka.IoTSiteWise.AssociateAssets

Associated Types

type Rep AssociateAssets :: Type -> Type

Methods

from :: AssociateAssets -> Rep AssociateAssets x

to :: Rep AssociateAssets x -> AssociateAssets

Read AssociateAssets

Defined in Amazonka.IoTSiteWise.AssociateAssets

Methods

readsPrec :: Int -> ReadS AssociateAssets

readList :: ReadS [AssociateAssets]

readPrec :: ReadPrec AssociateAssets

readListPrec :: ReadPrec [AssociateAssets]

Show AssociateAssets

Defined in Amazonka.IoTSiteWise.AssociateAssets

Methods

showsPrec :: Int -> AssociateAssets -> ShowS

show :: AssociateAssets -> String

showList :: [AssociateAssets] -> ShowS

NFData AssociateAssets

Defined in Amazonka.IoTSiteWise.AssociateAssets

Methods

rnf :: AssociateAssets -> ()

Eq AssociateAssets

Defined in Amazonka.IoTSiteWise.AssociateAssets

Methods

(==) :: AssociateAssets -> AssociateAssets -> Bool

(/=) :: AssociateAssets -> AssociateAssets -> Bool

Hashable AssociateAssets

Defined in Amazonka.IoTSiteWise.AssociateAssets

Methods

hashWithSalt :: Int -> AssociateAssets -> Int

hash :: AssociateAssets -> Int

type AWSResponse AssociateAssets

Defined in Amazonka.IoTSiteWise.AssociateAssets

type AWSResponse AssociateAssets = AssociateAssetsResponse

type Rep AssociateAssets

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

Arguments

:: Text

AssociateAssets

-> Text

AssociateAssets

-> Text

AssociateAssets

-> AssociateAssets

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)

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_assetId :: Lens' AssociateAssets Text

The ID of the parent asset.

associateAssets_hierarchyId :: Lens' AssociateAssets 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.

associateAssets_childAssetId :: Lens' AssociateAssets Text

The ID of the child asset to be associated.

Destructuring the Response

data AssociateAssetsResponse

See: newAssociateAssetsResponse smart constructor.

Constructors

AssociateAssetsResponse'

Instances

Generic AssociateAssetsResponse

Defined in Amazonka.IoTSiteWise.AssociateAssets

Associated Types

type Rep AssociateAssetsResponse :: Type -> Type

Methods

from :: AssociateAssetsResponse -> Rep AssociateAssetsResponse x

to :: Rep AssociateAssetsResponse x -> AssociateAssetsResponse

Read AssociateAssetsResponse

Defined in Amazonka.IoTSiteWise.AssociateAssets

Methods

readsPrec :: Int -> ReadS AssociateAssetsResponse

readList :: ReadS [AssociateAssetsResponse]

readPrec :: ReadPrec AssociateAssetsResponse

readListPrec :: ReadPrec [AssociateAssetsResponse]

Show AssociateAssetsResponse

Defined in Amazonka.IoTSiteWise.AssociateAssets

Methods

showsPrec :: Int -> AssociateAssetsResponse -> ShowS

show :: AssociateAssetsResponse -> String

showList :: [AssociateAssetsResponse] -> ShowS

NFData AssociateAssetsResponse

Defined in Amazonka.IoTSiteWise.AssociateAssets

Methods

rnf :: AssociateAssetsResponse -> ()

Eq AssociateAssetsResponse

Defined in Amazonka.IoTSiteWise.AssociateAssets

Methods

(==) :: AssociateAssetsResponse -> AssociateAssetsResponse -> Bool

(/=) :: AssociateAssetsResponse -> AssociateAssetsResponse -> Bool

type Rep AssociateAssetsResponse

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

Create a value of AssociateAssetsResponse with all optional fields omitted.

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