DescribeNotificationSubscriptionsCommand

Suggest an Edit

Lists the specified notification subscriptions.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { WorkDocsClient, DescribeNotificationSubscriptionsCommand } from "@aws-sdk/client-workdocs"; // ES Modules import
// const { WorkDocsClient, DescribeNotificationSubscriptionsCommand } = require("@aws-sdk/client-workdocs"); // CommonJS import
const client = new WorkDocsClient(config);
const input = { // DescribeNotificationSubscriptionsRequest
  OrganizationId: "STRING_VALUE", // required
  Marker: "STRING_VALUE",
  Limit: Number("int"),
};
const command = new DescribeNotificationSubscriptionsCommand(input);
const response = await client.send(command);
// { // DescribeNotificationSubscriptionsResponse
//   Subscriptions: [ // SubscriptionList
//     { // Subscription
//       SubscriptionId: "STRING_VALUE",
//       EndPoint: "STRING_VALUE",
//       Protocol: "HTTPS" || "SQS",
//     },
//   ],
//   Marker: "STRING_VALUE",
// };

DescribeNotificationSubscriptionsCommand Input

See DescribeNotificationSubscriptionsCommandInput for more details

Parameter
Type
Description
OrganizationId
Required
string | undefined

The ID of the organization.

Limit
number | undefined

The maximum number of items to return with this call.

Marker
string | undefined

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

DescribeNotificationSubscriptionsCommand Output

See DescribeNotificationSubscriptionsCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
Marker
string | undefined

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

Subscriptions
Subscription[] | undefined

The subscriptions.

Throws

Name
Fault
Details
EntityNotExistsException
client

The resource does not exist.

ServiceUnavailableException
server

One or more of the dependencies is unavailable.

UnauthorizedResourceAccessException
client

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

WorkDocsServiceException
Base exception class for all service exceptions from WorkDocs service.