CloudWatchLogs / Paginator / DescribeDestinations
DescribeDestinations#
- class CloudWatchLogs.Paginator.DescribeDestinations#
paginator = client.get_paginator('describe_destinations')
- paginate(**kwargs)#
Creates an iterator that will paginate through responses from
CloudWatchLogs.Client.describe_destinations()
.See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate( DestinationNamePrefix='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } )
- Parameters:
DestinationNamePrefix (string) – The prefix to match. If you don’t specify a value, no prefix filter is applied.
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
{ 'destinations': [ { 'destinationName': 'string', 'targetArn': 'string', 'roleArn': 'string', 'accessPolicy': 'string', 'arn': 'string', 'creationTime': 123 }, ], 'NextToken': 'string' }
Response Structure
(dict) –
destinations (list) –
The destinations.
(dict) –
Represents a cross-account destination that receives subscription log events.
destinationName (string) –
The name of the destination.
targetArn (string) –
The Amazon Resource Name (ARN) of the physical target where the log events are delivered (for example, a Kinesis stream).
roleArn (string) –
A role for impersonation, used when delivering log events to the target.
accessPolicy (string) –
An IAM policy document that governs which Amazon Web Services accounts can create subscription filters against this destination.
arn (string) –
The ARN of this destination.
creationTime (integer) –
The creation time of the destination, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.
NextToken (string) –
A token to resume pagination.