[ aws . iotsitewise ]

batch-associate-project-assets

Description

Associates a group (batch) of assets with an AWS IoT SiteWise Monitor project.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  batch-associate-project-assets
--project-id <value>
--asset-ids <value>
[--client-token <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]

Options

--project-id (string)

The ID of the project to which to associate the assets.

--asset-ids (list)

The IDs of the assets to be associated to the project.

(string)

Syntax:

"string" "string" ...

--client-token (string)

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.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

--cli-auto-prompt (boolean) Automatically prompt for CLI input parameters.

See ‘aws help’ for descriptions of global parameters.

Examples

To associate an asset to a project

The following batch-associate-project-assets example associates a wind farm asset to a project.

aws iotsitewise batch-associate-project-assets \
    --project-id a1b2c3d4-5678-90ab-cdef-eeeeeEXAMPLE \
    --asset-ids a1b2c3d4-5678-90ab-cdef-44444EXAMPLE

This command produces no output.

For more information, see Adding assets to projects in the AWS IoT SiteWise Monitor Application Guide.

Output

errors -> (list)

A list of associated error information, if any.

(structure)

Contains error details for the requested associate project asset action.

assetId -> (string)

The ID of the asset.

code -> (string)

The error code.

message -> (string)

The error message.