Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1444236171.7 KB

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.

post/api/v1/organizations/{OrganizationId}/subscriptions

Path parameters

OrganizationIdstring required

The ID of the organization.

Request body

Endpointstring required

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

Protocol'HTTPS' | 'SQS' required

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

SubscriptionType'ALL' required

The notification type.

Response

Success