CloudTrail / Client / describe_trails

describe_trails#

CloudTrail.Client.describe_trails(**kwargs)#

Retrieves settings for one or more trails associated with the current Region for your account.

See also: AWS API Documentation

Request Syntax

response = client.describe_trails(
    trailNameList=[
        'string',
    ],
    includeShadowTrails=True|False
)
Parameters:

  • trailNameList (list) –

    Specifies a list of trail names, trail ARNs, or both, of the trails to describe. The format of a trail ARN is:

    arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail

    If an empty list is specified, information for the trail in the current Region is returned.

    • If an empty list is specified and IncludeShadowTrails is false, then information for all trails in the current Region is returned.

    • If an empty list is specified and IncludeShadowTrails is null or true, then information for all trails in the current Region and any associated shadow trails in other Regions is returned.

    Note

    If one or more trail names are specified, information is returned only if the names match the names of trails belonging only to the current Region and current account. To return information about a trail in another Region, you must specify its trail ARN.

    • (string) –

  • includeShadowTrails (boolean) – Specifies whether to include shadow trails in the response. A shadow trail is the replication in a Region of a trail that was created in a different Region, or in the case of an organization trail, the replication of an organization trail in member accounts. If you do not include shadow trails, organization trails in a member account and Region replication trails will not be returned. The default is true.

Return type:

dict

Returns:

Response Syntax

{
    'trailList': [
        {
            'Name': 'string',
            'S3BucketName': 'string',
            'S3KeyPrefix': 'string',
            'SnsTopicName': 'string',
            'SnsTopicARN': 'string',
            'IncludeGlobalServiceEvents': True|False,
            'IsMultiRegionTrail': True|False,
            'HomeRegion': 'string',
            'TrailARN': 'string',
            'LogFileValidationEnabled': True|False,
            'CloudWatchLogsLogGroupArn': 'string',
            'CloudWatchLogsRoleArn': 'string',
            'KmsKeyId': 'string',
            'HasCustomEventSelectors': True|False,
            'HasInsightSelectors': True|False,
            'IsOrganizationTrail': True|False
        },
    ]
}

Response Structure

  • (dict) –

    Returns the objects or data listed below if successful. Otherwise, returns an error.

    • trailList (list) –

      The list of trail objects. Trail objects with string values are only returned if values for the objects exist in a trail’s configuration. For example, SNSTopicName and SNSTopicARN are only returned in results if a trail is configured to send SNS notifications. Similarly, KMSKeyId only appears in results if a trail’s log files are encrypted with KMS customer managed keys.

      • (dict) –

        The settings for a trail.

        • Name (string) –

          Name of the trail set by calling CreateTrail. The maximum length is 128 characters.

        • S3BucketName (string) –

          Name of the Amazon S3 bucket into which CloudTrail delivers your trail files. See Amazon S3 Bucket naming rules.

        • S3KeyPrefix (string) –

          Specifies the Amazon S3 key prefix that comes after the name of the bucket you have designated for log file delivery. For more information, see Finding Your CloudTrail Log Files. The maximum length is 200 characters.

        • SnsTopicName (string) –

          This field is no longer in use. Use SnsTopicARN.

        • SnsTopicARN (string) –

          Specifies the ARN of the Amazon SNS topic that CloudTrail uses to send notifications when log files are delivered. The following is the format of a topic ARN.

          arn:aws:sns:us-east-2:123456789012:MyTopic

        • IncludeGlobalServiceEvents (boolean) –

          Set to True to include Amazon Web Services API calls from Amazon Web Services global services such as IAM. Otherwise, False.

        • IsMultiRegionTrail (boolean) –

          Specifies whether the trail exists only in one Region or exists in all Regions.

        • HomeRegion (string) –

          The Region in which the trail was created.

        • TrailARN (string) –

          Specifies the ARN of the trail. The following is the format of a trail ARN.

          arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail

        • LogFileValidationEnabled (boolean) –

          Specifies whether log file validation is enabled.

        • CloudWatchLogsLogGroupArn (string) –

          Specifies an Amazon Resource Name (ARN), a unique identifier that represents the log group to which CloudTrail logs will be delivered.

        • CloudWatchLogsRoleArn (string) –

          Specifies the role for the CloudWatch Logs endpoint to assume to write to a user’s log group.

        • KmsKeyId (string) –

          Specifies the KMS key ID that encrypts the logs delivered by CloudTrail. The value is a fully specified ARN to a KMS key in the following format.

          arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012

        • HasCustomEventSelectors (boolean) –

          Specifies if the trail has custom event selectors.

        • HasInsightSelectors (boolean) –

          Specifies whether a trail has insight types specified in an InsightSelector list.

        • IsOrganizationTrail (boolean) –

          Specifies whether the trail is an organization trail.

Exceptions