Menu
Amazon WorkDocs
API Reference (API Version 2016-05-01)

DescribeNotificationSubscriptions

Lists the specified notification subscriptions.

Request Syntax

GET /api/v1/organizations/OrganizationId/subscriptions?limit=Limit&marker=Marker HTTP/1.1

URI Request Parameters

The request requires the following URI parameters.

Limit

The maximum number of items to return with this call.

Valid Range: Minimum value of 1. Maximum value of 999.

Marker

The marker for the next set of results. (You received this marker from a previous call.)

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

OrganizationId

The ID of the organization.

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

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

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200
Content-type: application/json

{
   "Marker": "string",
   "Subscriptions": [ 
      { 
         "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.

Marker

The marker to use when requesting the next set of results. If there are no additional results, the string is empty.

Type: String

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

Subscriptions

The subscriptions.

Type: Array of Subscription objects

Array Members: Maximum number of 256 items.

Errors

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

EntityNotExistsException

The resource does not exist.

HTTP Status Code: 404

ServiceUnavailableException

One or more of the dependencies is unavailable.

HTTP Status Code: 503

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: