AWS CloudTrail

2019/11/01 - AWS CloudTrail - 2 new 1 updated api methods

Changes  This release adds two new APIs, GetTrail and ListTrails, and support for adding tags when you create a trail by using a new TagsList parameter on CreateTrail operations.

ListTrails (new) Link ¶

Lists trails that are in the current account.

See also: AWS API Documentation

Request Syntax

client.list_trails(
    NextToken='string'
)
type NextToken

string

param NextToken

rtype

dict

returns

Response Syntax

{
    'Trails': [
        {
            'TrailARN': 'string',
            'Name': 'string',
            'HomeRegion': 'string'
        },
    ],
    'NextToken': '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 AWS region in which a trail was created.

    • NextToken (string) --

GetTrail (new) Link ¶

Returns settings information for a specified trail.

See also: AWS API Documentation

Request Syntax

client.get_trail(
    Name='string'
)
type Name

string

param Name

[REQUIRED]

The name or the Amazon Resource Name (ARN) of the trail for which you want to retrieve settings information.

rtype

dict

returns

Response Syntax

{
    'Trail': {
        '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,
        'IsOrganizationTrail': True|False
    }
}

Response Structure

  • (dict) --

    • Trail (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 Requirements .

      • 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 format of a topic ARN is:

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

      • IncludeGlobalServiceEvents (boolean) --

        Set to True to include AWS API calls from AWS 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 format of a trail ARN is:

        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 format:

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

      • HasCustomEventSelectors (boolean) --

        Specifies if the trail has custom event selectors.

      • IsOrganizationTrail (boolean) --

        Specifies whether the trail is an organization trail.

CreateTrail (updated) Link ¶
Changes (request) 
{'TagsList': [{'Key': 'string', 'Value': 'string'}]}

Creates a trail that specifies the settings for delivery of log data to an Amazon S3 bucket.

See also: AWS API Documentation

Request Syntax

client.create_trail(
    Name='string',
    S3BucketName='string',
    S3KeyPrefix='string',
    SnsTopicName='string',
    IncludeGlobalServiceEvents=True|False,
    IsMultiRegionTrail=True|False,
    EnableLogFileValidation=True|False,
    CloudWatchLogsLogGroupArn='string',
    CloudWatchLogsRoleArn='string',
    KmsKeyId='string',
    IsOrganizationTrail=True|False,
    TagsList=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)
type Name

string

param Name

[REQUIRED]

Specifies the name of the trail. The name must meet the following requirements:

  • Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-)

  • Start with a letter or number, and end with a letter or number

  • Be between 3 and 128 characters

  • Have no adjacent periods, underscores or dashes. Names like my-_namespace and my--namespace are invalid.

  • Not be in IP address format (for example, 192.168.5.4)

type S3BucketName

string

param S3BucketName

[REQUIRED]

Specifies the name of the Amazon S3 bucket designated for publishing log files. See Amazon S3 Bucket Naming Requirements .

type S3KeyPrefix

string

param S3KeyPrefix

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.

type SnsTopicName

string

param SnsTopicName

Specifies the name of the Amazon SNS topic defined for notification of log file delivery. The maximum length is 256 characters.

type IncludeGlobalServiceEvents

boolean

param IncludeGlobalServiceEvents

Specifies whether the trail is publishing events from global services such as IAM to the log files.

type IsMultiRegionTrail

boolean

param IsMultiRegionTrail

Specifies whether the trail is created in the current region or in all regions. The default is false, which creates a trail only in the region where you are signed in. As a best practice, consider creating trails that log events in all regions.

type EnableLogFileValidation

boolean

param EnableLogFileValidation

Specifies whether log file integrity validation is enabled. The default is false.

Note

When you disable log file integrity validation, the chain of digest files is broken after one hour. CloudTrail will not create digest files for log files that were delivered during a period in which log file integrity validation was disabled. For example, if you enable log file integrity validation at noon on January 1, disable it at noon on January 2, and re-enable it at noon on January 10, digest files will not be created for the log files delivered from noon on January 2 to noon on January 10. The same applies whenever you stop CloudTrail logging or delete a trail.

type CloudWatchLogsLogGroupArn

string

param CloudWatchLogsLogGroupArn

Specifies a log group name using an Amazon Resource Name (ARN), a unique identifier that represents the log group to which CloudTrail logs will be delivered. Not required unless you specify CloudWatchLogsRoleArn.

type CloudWatchLogsRoleArn

string

param CloudWatchLogsRoleArn

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

type KmsKeyId

string

param KmsKeyId

Specifies the KMS key ID to use to encrypt the logs delivered by CloudTrail. The value can be an alias name prefixed by "alias/", a fully specified ARN to an alias, a fully specified ARN to a key, or a globally unique identifier.

Examples:

  • alias/MyAliasName

  • arn:aws:kms:us-east-2:123456789012:alias/MyAliasName

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

  • 12345678-1234-1234-1234-123456789012

type IsOrganizationTrail

boolean

param IsOrganizationTrail

Specifies whether the trail is created for all accounts in an organization in AWS Organizations, or only for the current AWS account. The default is false, and cannot be true unless the call is made on behalf of an AWS account that is the master account for an organization in AWS Organizations.

type TagsList

list

param TagsList

A list of tags.

  • (dict) --

    A custom key-value pair associated with a resource such as a CloudTrail trail.

    • Key (string) -- [REQUIRED]

      The key in a key-value pair. The key must be must be no longer than 128 Unicode characters. The key must be unique for the resource to which it applies.

    • Value (string) --

      The value in a key-value pair of a tag. The value must be no longer than 256 Unicode characters.

rtype

dict

returns

Response Syntax

{
    'Name': 'string',
    'S3BucketName': 'string',
    'S3KeyPrefix': 'string',
    'SnsTopicName': 'string',
    'SnsTopicARN': 'string',
    'IncludeGlobalServiceEvents': True|False,
    'IsMultiRegionTrail': True|False,
    'TrailARN': 'string',
    'LogFileValidationEnabled': True|False,
    'CloudWatchLogsLogGroupArn': 'string',
    'CloudWatchLogsRoleArn': 'string',
    'KmsKeyId': 'string',
    'IsOrganizationTrail': True|False
}

Response Structure

  • (dict) --

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

    • Name (string) --

      Specifies the name of the trail.

    • S3BucketName (string) --

      Specifies the name of the Amazon S3 bucket designated for publishing log files.

    • 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 .

    • 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 format of a topic ARN is:

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

    • IncludeGlobalServiceEvents (boolean) --

      Specifies whether the trail is publishing events from global services such as IAM to the log files.

    • IsMultiRegionTrail (boolean) --

      Specifies whether the trail exists in one region or in all regions.

    • TrailARN (string) --

      Specifies the ARN of the trail that was created. The format of a trail ARN is:

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

    • LogFileValidationEnabled (boolean) --

      Specifies whether log file integrity validation is enabled.

    • CloudWatchLogsLogGroupArn (string) --

      Specifies the Amazon Resource Name (ARN) of 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 format:

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

    • IsOrganizationTrail (boolean) --

      Specifies whether the trail is an organization trail.