delete-ota-update¶

Description¶

Delete an OTA update.

Synopsis¶

  delete-ota-update
--ota-update-id <value>
[--delete-stream | --no-delete-stream]
[--force-delete-aws-job | --no-force-delete-aws-job]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options¶

--ota-update-id (string)

The ID of the OTA update to delete.

--delete-stream | --no-delete-stream (boolean)

Specifies if the stream associated with an OTA update should be deleted when the OTA update is deleted.

--force-delete-aws-job | --no-force-delete-aws-job (boolean)

Specifies if the AWS Job associated with the OTA update should be deleted when the OTA update is deleted.

--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 an OTA update

The following delete-ota-update example deletes the specified OTA update.

aws iot delete-ota-update \
    --ota-update-id ota12345 \
    --delete-stream \
    --force-delete-aws-job

This command produces no output.

For more information, see DeleteOTAUpdate in the AWS IoT API Reference.

Output¶

None

Table of Contents

Feedback

User Guide