GetResourceEventConfiguration - AWS IoT Wireless

GetResourceEventConfiguration

Get the event configuration for a particular resource identifier.

Request Syntax

GET /event-configurations/Identifier?identifierType=IdentifierType&partnerType=PartnerType HTTP/1.1

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

Required: Yes

PartnerType

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

Valid Values: Sidewalk

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "DeviceRegistrationState": { "Sidewalk": { "AmazonIdEventTopic": "string" } }, "Proximity": { "Sidewalk": { "AmazonIdEventTopic": "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.

DeviceRegistrationState

Event configuration for the device registration state event

Type: DeviceRegistrationStateEventConfiguration object

Proximity

Event configuration for the Proximity event

Type: ProximityEventConfiguration object

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

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: