[ aws . iot1click-projects ]

update-placement

Description

Updates a placement with the given attributes. To clear an attribute, pass an empty value (i.e., “”).

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  update-placement
--placement-name <value>
--project-name <value>
[--attributes <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]

Options

--placement-name (string)

The name of the placement to update.

--project-name (string)

The name of the project containing the placement to be updated.

--attributes (map)

The user-defined object of attributes used to update the placement. The maximum number of key/value pairs is 50.

key -> (string)

value -> (string)

Shorthand Syntax:

KeyName1=string,KeyName2=string

JSON Syntax:

{"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.

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

See ‘aws help’ for descriptions of global parameters.

Examples

To update the “attributes” key-value pairs of a placement

The following update-placement example update the “attributes” key-value pairs of a placement.

aws iot1click-projects update-placement \
    --cli-input-json file://update-placement.json

Contents of update-placement.json:

{
    "projectName": "AnytownDumpsters",
    "placementName": "customer217",
    "attributes": {
        "phone": "123-456-7890",
        "location": "123 Any Street Anytown, USA 10001"
    }
}

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