UpdateResourceEventConfiguration - AWS IoT Wireless
Request SyntaxURI Request ParametersRequest BodyResponse SyntaxResponse ElementsErrorsSee Also

UpdateResourceEventConfiguration

Update the event configuration for a particular resource identifier.

Request Syntax

PATCH /event-configurations/Identifier?identifierType=IdentifierType&partnerType=PartnerType HTTP/1.1
Content-type: application/json

{
   "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"
   }
}

URI Request Parameters

The request uses the following URI parameters.

Identifier

Resource identifier to opt in for event messaging.

Length Constraints: Maximum length of 256.

Required: Yes

IdentifierType

Identifier type of the particular resource identifier for event configuration.

Valid Values: PartnerAccountId | DevEui | FuotaTaskId | GatewayEui | WirelessDeviceId | WirelessGatewayId

Required: Yes

PartnerType

Partner type of the resource if the identifier type is PartnerAccountId

Valid Values: Sidewalk

Request Body

The request accepts the following data in JSON format.

ConnectionStatus

Event configuration for the connection status event.

Type: ConnectionStatusEventConfiguration object

Required: No

DeviceRegistrationState

Event configuration for the device registration state event.

Type: DeviceRegistrationStateEventConfiguration object

Required: No

Join

Event configuration for the join event.

Type: JoinEventConfiguration object

Required: No

MessageDeliveryStatus

Event configuration for the message delivery status event.

Type: MessageDeliveryStatusEventConfiguration object

Required: No

Proximity

Event configuration for the proximity event.

Type: ProximityEventConfiguration object

Required: No

Response Syntax

HTTP/1.1 204

Response Elements

If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

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

ConflictException

Adding, updating, or deleting the resource can cause an inconsistent state.

HTTP Status Code: 409

InternalServerException

An unexpected error occurred while processing a request.

HTTP Status Code: 500

ResourceNotFoundException

Resource does not exist.

HTTP Status Code: 404

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: