delete-placement¶

Description¶

Deletes a placement. To delete a placement, it must not have any devices associated with it.

Note

When you delete a placement, all associated data becomes irretrievable.

Synopsis¶

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

Options¶

--placement-name (string)

The name of the empty placement to delete.

--project-name (string)

The project containing the empty placement to delete.

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

Examples¶

To delete a placement from a project

The following delete-placement example deletes the specified placement from a project.

aws iot1click-projects delete-placement \
    --project-name AnytownDumpsters \
    --placement-name customer217

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