CloudTrail / Paginator / ListTrails


class CloudTrail.Paginator.ListTrails#
paginator = client.get_paginator('list_trails')

Creates an iterator that will paginate through responses from CloudTrail.Client.list_trails().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
        'MaxItems': 123,
        'StartingToken': 'string'

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.

  • StartingToken (string) –

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

Return type:



Response Syntax

    'Trails': [
            'TrailARN': 'string',
            'Name': 'string',
            'HomeRegion': 'string'


Response Structure

  • (dict) –

    • Trails (list) –

      Returns the name, ARN, and home Region of trails in the current account.

      • (dict) –

        Information about a CloudTrail trail, including the trail’s name, home Region, and Amazon Resource Name (ARN).

        • TrailARN (string) –

          The ARN of a trail.

        • Name (string) –

          The name of a trail.

        • HomeRegion (string) –

          The Amazon Web Services Region in which a trail was created.