[ aws . iotwireless ]

update-resource-event-configuration

Description

Update the event configuration for a particular resource identifier.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  update-resource-event-configuration
--identifier <value>
--identifier-type <value>
[--partner-type <value>]
[--device-registration-state <value>]
[--proximity <value>]
[--join <value>]
[--connection-status <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--identifier (string)

Resource identifier to opt in for event messaging.

--identifier-type (string)

Identifier type of the particular resource identifier for event configuration.

Possible values:

• PartnerAccountId

• DevEui

• GatewayEui

• WirelessDeviceId

• WirelessGatewayId

--partner-type (string)

Partner type of the resource if the identifier type is PartnerAccountId

Possible values:

• Sidewalk

--device-registration-state (structure)

Event configuration for the device registration state event

Sidewalk -> (structure)

Device registration state event configuration object for enabling or disabling Sidewalk related event topics.

AmazonIdEventTopic -> (string)

Enum to denote whether amazon id event topic is enabled or disabled.

WirelessDeviceIdEventTopic -> (string)

Enum to denote whether the wireless device id device registration state event topic is enabled or disabled.

Shorthand Syntax:

Sidewalk={AmazonIdEventTopic=string},WirelessDeviceIdEventTopic=string

JSON Syntax:

{
  "Sidewalk": {
    "AmazonIdEventTopic": "Enabled"|"Disabled"
  },
  "WirelessDeviceIdEventTopic": "Enabled"|"Disabled"
}

--proximity (structure)

Event configuration for the Proximity event

Sidewalk -> (structure)

Proximity event configuration object for enabling or disabling Sidewalk related event topics.

AmazonIdEventTopic -> (string)

Enum to denote whether amazon id event topic is enabled or disabled.

WirelessDeviceIdEventTopic -> (string)

Enum to denote whether the wireless device id proximity event topic is enabled or disabled.

Shorthand Syntax:

Sidewalk={AmazonIdEventTopic=string},WirelessDeviceIdEventTopic=string

JSON Syntax:

{
  "Sidewalk": {
    "AmazonIdEventTopic": "Enabled"|"Disabled"
  },
  "WirelessDeviceIdEventTopic": "Enabled"|"Disabled"
}

--join (structure)

Event configuration for the join event

LoRaWAN -> (structure)

Join event configuration object for enabling or disabling LoRaWAN related event topics.

DevEuiEventTopic -> (string)

Enum to denote whether the dev eui join event topic is enabled or disabled.

WirelessDeviceIdEventTopic -> (string)

Enum to denote whether the wireless device id join event topic is enabled or disabled.

Shorthand Syntax:

LoRaWAN={DevEuiEventTopic=string},WirelessDeviceIdEventTopic=string

JSON Syntax:

{
  "LoRaWAN": {
    "DevEuiEventTopic": "Enabled"|"Disabled"
  },
  "WirelessDeviceIdEventTopic": "Enabled"|"Disabled"
}

--connection-status (structure)

Event configuration for the connection status event

LoRaWAN -> (structure)

Connection status event configuration object for enabling or disabling LoRaWAN related event topics.

GatewayEuiEventTopic -> (string)

Enum to denote whether the gateway eui connection status event topic is enabled or disabled.

WirelessGatewayIdEventTopic -> (string)

Enum to denote whether the wireless gateway id connection status event topic is enabled or disabled .

Shorthand Syntax:

LoRaWAN={GatewayEuiEventTopic=string},WirelessGatewayIdEventTopic=string

JSON Syntax:

{
  "LoRaWAN": {
    "GatewayEuiEventTopic": "Enabled"|"Disabled"
  },
  "WirelessGatewayIdEventTopic": "Enabled"|"Disabled"
}

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

Output

None