DirectoryService / Paginator / ListLogSubscriptions

ListLogSubscriptions

class DirectoryService.Paginator.ListLogSubscriptions

paginator = client.get_paginator('list_log_subscriptions')

paginate(**kwargs)

Creates an iterator that will paginate through responses from DirectoryService.Client.list_log_subscriptions().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    DirectoryId='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

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.

• PaginationConfig (dict) –

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

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

}

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.