CreateNotificationSubscription - Amazon WorkDocs (original) (raw)

Configure Amazon WorkDocs to use Amazon SNS notifications. The endpoint receives a confirmation message, and must confirm the subscription.

For more information, see Setting up notifications for an IAM user or role in the Amazon WorkDocs Developer Guide.

Request Syntax

POST /api/v1/organizations/OrganizationId/subscriptions HTTP/1.1
Content-type: application/json

{
   "Endpoint": "string",
   "Protocol": "string",
   "SubscriptionType": "string"
}

URI Request Parameters

The request uses the following URI parameters.

OrganizationId

The ID of the organization.

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: [&\w+-.@]+

Required: Yes

Request Body

The request accepts the following data in JSON format.

Endpoint

The endpoint to receive the notifications. If the protocol is HTTPS, the endpoint is a URL that begins with https.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Required: Yes

Protocol

The protocol to use. The supported value is https, which delivers JSON-encoded messages using HTTPS POST.

Type: String

Valid Values: HTTPS | SQS

Required: Yes

SubscriptionType

The notification type.

Type: String

Valid Values: ALL

Required: Yes

Response Syntax

HTTP/1.1 200
Content-type: application/json

{
   "Subscription": { 
      "EndPoint": "string",
      "Protocol": "string",
      "SubscriptionId": "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.

Errors

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

InvalidArgumentException

The pagination marker or limit fields are not valid.

HTTP Status Code: 400

ServiceUnavailableException

One or more of the dependencies is unavailable.

HTTP Status Code: 503

TooManySubscriptionsException

You've reached the limit on the number of subscriptions for the WorkDocs instance.

HTTP Status Code: 429

UnauthorizedResourceAccessException

The caller does not have access to perform the action on the resource.

HTTP Status Code: 404

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: