Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . workdocs ]



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

For more information, see Subscribe to Notifications in the Amazon WorkDocs Developer Guide .

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.


--organization-id <value>
--protocol <value>
--subscription-type <value>
--notification-endpoint <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]


--organization-id (string)

The ID of the organization.

--protocol (string)

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

Possible values:


--subscription-type (string)

The notification type.

Possible values:

  • ALL

--notification-endpoint (string)

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

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.


To create a notification subscription

The following create-notification-subscription example configures a notification subscription for the specified Amazon WorkDocs organization.

aws workdocs create-notification-subscription \
    --organization-id d-123456789c \
    --protocol HTTPS \
    --subscription-type ALL \
    --notification-endpoint ""


    "Subscription": {
        "SubscriptionId": "123ab4c5-678d-901e-f23g-45h6789j0123",
        "EndPoint": "",
        "Protocol": "HTTPS"

For more information, see Subscribe to Notifications in the Amazon WorkDocs Developer Guide.


Subscription -> (structure)

The subscription.

SubscriptionId -> (string)

The ID of the subscription.

EndPoint -> (string)

The endpoint of the subscription.

Protocol -> (string)

The protocol of the subscription.