update-project¶

Description¶

Updates a project associated with your AWS account and region. With the exception of device template names, you can pass just the values that need to be updated because the update request will change only the values that are provided. To clear a value, pass the empty string (i.e., "" ).

Synopsis¶

  update-project
--project-name <value>
[--description <value>]
[--placement-template <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options¶

--project-name (string)

The name of the project to be updated.

--description (string)

An optional user-defined description for the project.

--placement-template (structure)

An object defining the project update. Once a project has been created, you cannot add device template names to the project. However, for a given placementTemplate , you can update the associated callbackOverrides for the device definition using this API.

defaultAttributes -> (map)

The default attributes (key/value pairs) to be applied to all placements using this template.

key -> (string)

value -> (string)

deviceTemplates -> (map)

An object specifying the DeviceTemplate for all placements using this ( PlacementTemplate ) template.

key -> (string)

value -> (structure)

An object representing a device for a placement template (see PlacementTemplate ).

deviceType -> (string)

The device type, which currently must be "button" .

callbackOverrides -> (map)

An optional Lambda function to invoke instead of the default Lambda function provided by the placement template.

key -> (string)

value -> (string)

Shorthand Syntax:

defaultAttributes={KeyName1=string,KeyName2=string},deviceTemplates={KeyName1={deviceType=string,callbackOverrides={KeyName1=string,KeyName2=string}},KeyName2={deviceType=string,callbackOverrides={KeyName1=string,KeyName2=string}}}

JSON Syntax:

{
  "defaultAttributes": {"string": "string"
    ...},
  "deviceTemplates": {"string": {
        "deviceType": "string",
        "callbackOverrides": {"string": "string"
          ...}
      }
    ...}
}

--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. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

See ‘aws help’ for descriptions of global parameters.

Examples¶

Note

To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.

Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal’s quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .

To update settings for a project

The following update-project example updates the description for a project.

aws iot1click-projects update-project \
    --project-name AnytownDumpsters \
    --description "All dumpsters (yard waste, recycling, garbage) in the Anytown region."

This command produces no output.

For more information, see Using AWS IoT 1-Click with the AWS CLI in the AWS IoT 1-Click Developer Guide.

Output¶

None

Table of Contents

Feedback

User Guide