ListEventConfigurations
List event configurations where at least one event topic has been enabled.
Request Syntax
GET /event-configurations?maxResults=MaxResults&nextToken=NextToken&resourceType=ResourceType HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- MaxResults
-
The maximum number of results to return in this operation.
Valid Range: Minimum value of 0. Maximum value of 250.
- NextToken
-
To retrieve the next set of results, the
nextTokenvalue from a previous response; otherwise null to receive the first set of results.Length Constraints: Maximum length of 4096.
- ResourceType
-
Resource type to filter event configurations.
Valid Values:
FuotaTask | SidewalkAccount | WirelessDevice | WirelessGatewayRequired: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"EventConfigurationsList": [
{
"Events": {
"ConnectionStatus": {
"LoRaWAN": {
"GatewayEuiEventTopic": "string"
},
"WirelessGatewayIdEventTopic": "string"
},
"DeviceRegistrationState": {
"Sidewalk": {
"AmazonIdEventTopic": "string"
},
"WirelessDeviceIdEventTopic": "string"
},
"Join": {
"LoRaWAN": {
"DevEuiEventTopic": "string"
},
"WirelessDeviceIdEventTopic": "string"
},
"MessageDeliveryStatus": {
"Sidewalk": {
"AmazonIdEventTopic": "string"
},
"WirelessDeviceIdEventTopic": "string"
},
"Proximity": {
"Sidewalk": {
"AmazonIdEventTopic": "string"
},
"WirelessDeviceIdEventTopic": "string"
}
},
"Identifier": "string",
"IdentifierType": "string",
"PartnerType": "string"
}
],
"NextToken": "string"
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- EventConfigurationsList
-
Event configurations of all events for a single resource.
Type: Array of EventConfigurationItem objects
- NextToken
-
To retrieve the next set of results, the
nextTokenvalue from a previous response; otherwise null to receive the first set of results.Type: String
Length Constraints: Maximum length of 4096.
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
User does not have permission to perform this action.
HTTP Status Code: 403
- InternalServerException
-
An unexpected error occurred while processing a request.
HTTP Status Code: 500
- ThrottlingException
-
The request was denied because it exceeded the allowed API request rate.
HTTP Status Code: 429
- ValidationException
-
The input did not meet the specified constraints.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
