[ aws . iotwireless ]

list-event-configurations

Description

List event configurations where at least one event topic has been enabled.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  list-event-configurations
--resource-type <value>
[--max-results <value>]
[--next-token <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--resource-type (string)

Resource type to filter event configurations.

Possible values:

  • SidewalkAccount

  • WirelessDevice

  • WirelessGateway

--max-results (integer)

The maximum number of results to return in this operation.

--next-token (string)

To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.

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

NextToken -> (string)

To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.

EventConfigurationsList -> (list)

Event configurations of all events for a single resource.

(structure)

Event configuration object for a single resource.

Identifier -> (string)

Resource identifier opted in for event messaging.

IdentifierType -> (string)

Identifier type of the particular resource identifier for event configuration.

PartnerType -> (string)

Partner type of the resource if the identifier type is PartnerAccountId.

Events -> (structure)

Object of all event configurations and the status of the event topics.

DeviceRegistrationState -> (structure)

Device registration state event configuration for an event configuration item.

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.

Proximity -> (structure)

Proximity event configuration for an event configuration item.

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.

Join -> (structure)

Join event configuration for an event configuration item.

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.

ConnectionStatus -> (structure)

Connection status event configuration for an event configuration item.

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 .