[ aws . iot ]

update-event-configurations

Description

Updates the event configurations.

Requires permission to access the UpdateEventConfigurations action.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  update-event-configurations
[--event-configurations <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--event-configurations (map)

The new event configuration values.

key -> (string)

value -> (structure)

Configuration.

Enabled -> (boolean)

True to enable the configuration.

Shorthand Syntax:

  KeyName1=Enabled=boolean,KeyName2=Enabled=boolean

Where valid key names are:
  THING
  THING_GROUP
  THING_TYPE
  THING_GROUP_MEMBERSHIP
  THING_GROUP_HIERARCHY
  THING_TYPE_ASSOCIATION
  JOB
  JOB_EXECUTION
  POLICY
  CERTIFICATE
  CA_CERTIFICATE

JSON Syntax:

{"THING"|"THING_GROUP"|"THING_TYPE"|"THING_GROUP_MEMBERSHIP"|"THING_GROUP_HIERARCHY"|"THING_TYPE_ASSOCIATION"|"JOB"|"JOB_EXECUTION"|"POLICY"|"CERTIFICATE"|"CA_CERTIFICATE": {
      "Enabled": true|false
    }
  ...}

--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 show which event types are published

The following update-event-configurations example updates the configuration to enable messages when the CA certificate is added, updated, or deleted.

aws iot update-event-configurations \
    --event-configurations "{\"CA_CERTIFICATE\":{\"Enabled\":true}}"

This command produces no output.

For more information, see Event Messages in the AWS IoT Developer Guide.

Output

None