AWS Directory Service
API Reference

ListLogSubscriptions

Lists the active log subscriptions for the AWS account.

Request Syntax

{ "DirectoryId": "string", "Limit": number, "NextToken": "string" }

Request Parameters

The request accepts the following data in JSON format.

DirectoryId

If a DirectoryID is provided, lists only the log subscription associated with that directory. If no DirectoryId is provided, lists all log subscriptions associated with your AWS account. If there are no log subscriptions for the AWS account or the directory, an empty list will be returned.

Type: String

Pattern: ^d-[0-9a-f]{10}$

Required: No

Limit

The maximum number of items returned.

Type: Integer

Valid Range: Minimum value of 0.

Required: No

NextToken

The token for the next set of items to return.

Type: String

Required: No

Response Syntax

{ "LogSubscriptions": [ { "DirectoryId": "string", "LogGroupName": "string", "SubscriptionCreatedDateTime": number } ], "NextToken": "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.

LogSubscriptions

A list of active LogSubscription objects for calling the AWS account.

Type: Array of LogSubscription objects

NextToken

The token for the next set of items to return.

Type: String

Errors

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

ClientException

A client exception has occurred.

HTTP Status Code: 400

EntityDoesNotExistException

The specified entity could not be found.

HTTP Status Code: 400

InvalidNextTokenException

The NextToken value is not valid.

HTTP Status Code: 400

ServiceException

An exception has occurred in AWS Directory Service.

HTTP Status Code: 500

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: