DirectoryService / Client / list_log_subscriptions

list_log_subscriptions#

DirectoryService.Client.list_log_subscriptions(**kwargs)#

Lists the active log subscriptions for the Amazon Web Services account.

Request Syntax

response = client.list_log_subscriptions(
    DirectoryId='string',
    NextToken='string',
    Limit=123
)

Parameters:

DirectoryId (string) – 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 Amazon Web Services account. If there are no log subscriptions for the Amazon Web Services account or the directory, an empty list will be returned.
NextToken (string) – The token for the next set of items to return.
Limit (integer) – The maximum number of items returned.

Return type:

dict

Returns:

Response Syntax

{
    'LogSubscriptions': [
        {
            'DirectoryId': 'string',
            'LogGroupName': 'string',
            'SubscriptionCreatedDateTime': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) –
- LogSubscriptions (list) –
  
  A list of active LogSubscription objects for calling the Amazon Web Services account.
  - (dict) –
    
    Represents a log subscription, which tracks real-time data from a chosen log group to a specified destination.
    - DirectoryId (string) –
      
      Identifier (ID) of the directory that you want to associate with the log subscription.
    - LogGroupName (string) –
      
      The name of the log group.
    - SubscriptionCreatedDateTime (datetime) –
      
      The date and time that the log subscription was created.
- NextToken (string) –
  
  The token for the next set of items to return.

Exceptions

DirectoryService.Client.exceptions.EntityDoesNotExistException
DirectoryService.Client.exceptions.InvalidNextTokenException
DirectoryService.Client.exceptions.ClientException
DirectoryService.Client.exceptions.ServiceException