[ aws . iotsitewise ]
Updates an IoT SiteWise Monitor project.
See also: AWS API Documentation
See ‘aws help’ for descriptions of global parameters.
update-project
--project-id <value>
--project-name <value>
[--project-description <value>]
[--client-token <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
--project-id
(string)
The ID of the project to update.
--project-name
(string)
A new friendly name for the project.
--project-description
(string)
A new description for the project.
--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.
See ‘aws help’ for descriptions of global parameters.
To update a project’s details
The following update-project
example updates a wind farm project.
aws iotsitewise update-project \
--project-id a1b2c3d4-5678-90ab-cdef-eeeeeEXAMPLE \
--project-name "Wind Farm 1" \
--project-description "Contains asset visualizations for Wind Farm #1 for Example Corp."
This command produces no output.
For more information, see Changing project details in the AWS IoT SiteWise Monitor Application Guide.
None