Skip to content

Configure Amazon WorkDocs to use Amazon SNS notifications

Description

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.

Usage

workdocs_create_notification_subscription(OrganizationId, Endpoint,
  Protocol, SubscriptionType)

Arguments

  • OrganizationId

    [required] The ID of the organization.

  • Endpoint

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

  • Protocol

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

  • SubscriptionType

    [required] The notification type.

Value

A list with the following syntax:

list(
  Subscription = list(
    SubscriptionId = "string",
    EndPoint = "string",
    Protocol = "HTTPS"|"SQS"
  )
)

Request syntax

svc$create_notification_subscription(
  OrganizationId = "string",
  Endpoint = "string",
  Protocol = "HTTPS"|"SQS",
  SubscriptionType = "ALL"
)