Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

RegisterNotificationHub

Registers a NotificationConfiguration in the specified Region.

There is a maximum of one NotificationConfiguration per Region. You can have a maximum of 3 NotificationHub resources at a time.

Request Syntax


POST /notification-hubs HTTP/1.1
Content-type: application/json

{
   "notificationHubRegion": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

notificationHubRegion

The Region of the NotificationHub.

Type: String

Length Constraints: Minimum length of 2. Maximum length of 25.

Pattern: ([a-z]{1,2})-([a-z]{1,15}-)+([0-9])

Required: Yes

Response Syntax


HTTP/1.1 201
Content-type: application/json

{
   "creationTime": "string",
   "lastActivationTime": "string",
   "notificationHubRegion": "string",
   "statusSummary": { 
      "reason": "string",
      "status": "string"
   }
}

Response Elements

If the action is successful, the service sends back an HTTP 201 response.

The following data is returned in JSON format by the service.

creationTime

The date the resource was created.

Type: Timestamp

lastActivationTime

The date the resource was last activated.

Type: Timestamp

notificationHubRegion

The Region of the NotificationHub.

Type: String

Length Constraints: Minimum length of 2. Maximum length of 25.

Pattern: ([a-z]{1,2})-([a-z]{1,15}-)+([0-9])

statusSummary

Provides additional information about the current NotificationConfiguration status information.

Type: NotificationHubStatusSummary object

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

User does not have sufficient access to perform this action.

HTTP Status Code: 403

ConflictException

Updating or deleting a resource can cause an inconsistent state.

resourceId: The resource ID that prompted the conflict error.

HTTP Status Code: 409

InternalServerException

Unexpected error during processing of request.

HTTP Status Code: 500

ServiceQuotaExceededException

Request would cause a service quota to be exceeded.

quotaCode: The code for the service quota in Service Quotas.
resourceId: The ID of the resource that exceeds the service quota.
resourceType: The type of the resource that exceeds the service quota.
serviceCode: The code for the service quota exceeded in Service Quotas.

HTTP Status Code: 402

ThrottlingException

Request was denied due to request throttling.

quotaCode: Identifies the quota that is being throttled.
retryAfterSeconds: The number of seconds a client should wait before retrying the request.
serviceCode: Identifies the service being throttled.

HTTP Status Code: 429

ValidationException

This exception is thrown when the notification event fails validation.

fieldList: The list of input fields that are invalid.
reason: The reason why your input is considered invalid.

HTTP Status Code: 400