CloudTrail

Client

class CloudTrail.Client

A low-level client representing AWS CloudTrail

This is the CloudTrail API Reference. It provides descriptions of actions, data types, common parameters, and common errors for CloudTrail.

CloudTrail is a web service that records Amazon Web Services API calls for your Amazon Web Services account and delivers log files to an Amazon S3 bucket. The recorded information includes the identity of the user, the start time of the Amazon Web Services API call, the source IP address, the request parameters, and the response elements returned by the service.

Note

As an alternative to the API, you can use one of the Amazon Web Services SDKs, which consist of libraries and sample code for various programming languages and platforms (Java, Ruby, .NET, iOS, Android, etc.). The SDKs provide programmatic access to CloudTrail. For example, the SDKs handle cryptographically signing requests, managing errors, and retrying requests automatically. For more information about the Amazon Web Services SDKs, including how to download and install them, see Tools to Build on Amazon Web Services .

See the CloudTrail User Guide for information about the data that is included with each Amazon Web Services API call listed in the log files.

client = session.create_client('cloudtrail')

These are the available methods:

add_tags(**kwargs)

Adds one or more tags to a trail or event data store, up to a limit of 50. Overwrites an existing tag's value when a new value is specified for an existing tag key. Tag key names must be unique for a trail; you cannot have two keys with the same name but different values. If you specify a key without a value, the tag will be created with the specified key and a value of null. You can tag a trail or event data store that applies to all Amazon Web Services Regions only from the Region in which the trail or event data store was created (also known as its home region).

See also: AWS API Documentation

Request Syntax

response = client.add_tags(
    ResourceId='string',
    TagsList=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)
Parameters
  • ResourceId (string) --

    [REQUIRED]

    Specifies the ARN of the trail or event data store to which one or more tags will be added. The format of a trail ARN is:

    arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail
  • TagsList (list) --

    [REQUIRED]

    Contains a list of tags, up to a limit of 50

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

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

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

Exceptions

can_paginate(operation_name)

Check if an operation can be paginated.

Parameters
operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Returns
True if the operation can be paginated, False otherwise.
cancel_query(**kwargs)

Cancels a query if the query is not in a terminated state, such as CANCELLED , FAILED , TIMED_OUT , or FINISHED . You must specify an ARN value for EventDataStore . The ID of the query that you want to cancel is also required. When you run CancelQuery , the query status might show as CANCELLED even if the operation is not yet finished.

See also: AWS API Documentation

Request Syntax

response = client.cancel_query(
    EventDataStore='string',
    QueryId='string'
)
Parameters
  • EventDataStore (string) --

    [REQUIRED]

    The ARN (or the ID suffix of the ARN) of an event data store on which the specified query is running.

  • QueryId (string) --

    [REQUIRED]

    The ID of the query that you want to cancel. The QueryId comes from the response of a StartQuery operation.

Return type

dict

Returns

Response Syntax

{
    'QueryId': 'string',
    'QueryStatus': 'QUEUED'|'RUNNING'|'FINISHED'|'FAILED'|'CANCELLED'|'TIMED_OUT'
}

Response Structure

  • (dict) --

    • QueryId (string) --

      The ID of the canceled query.

    • QueryStatus (string) --

      Shows the status of a query after a CancelQuery request. Typically, the values shown are either RUNNING or CANCELLED .

Exceptions

close()

Closes underlying endpoint connections.

create_event_data_store(**kwargs)

Creates a new event data store.

See also: AWS API Documentation

Request Syntax

response = client.create_event_data_store(
    Name='string',
    AdvancedEventSelectors=[
        {
            'Name': 'string',
            'FieldSelectors': [
                {
                    'Field': 'string',
                    'Equals': [
                        'string',
                    ],
                    'StartsWith': [
                        'string',
                    ],
                    'EndsWith': [
                        'string',
                    ],
                    'NotEquals': [
                        'string',
                    ],
                    'NotStartsWith': [
                        'string',
                    ],
                    'NotEndsWith': [
                        'string',
                    ]
                },
            ]
        },
    ],
    MultiRegionEnabled=True|False,
    OrganizationEnabled=True|False,
    RetentionPeriod=123,
    TerminationProtectionEnabled=True|False,
    TagsList=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)
Parameters
  • Name (string) --

    [REQUIRED]

    The name of the event data store.

  • AdvancedEventSelectors (list) --

    The advanced event selectors to use to select the events for the data store. For more information about how to use advanced event selectors, see Log events by using advanced event selectors in the CloudTrail User Guide.

    • (dict) --

      Advanced event selectors let you create fine-grained selectors for the following CloudTrail event record fields. They help you control costs by logging only those events that are important to you. For more information about advanced event selectors, see Logging data events for trails in the CloudTrail User Guide .

      • readOnly
      • eventSource
      • eventName
      • eventCategory
      • resources.type
      • resources.ARN

      You cannot apply both event selectors and advanced event selectors to a trail.

      • Name (string) --

        An optional, descriptive name for an advanced event selector, such as "Log data events for only two S3 buckets".

      • FieldSelectors (list) -- [REQUIRED]

        Contains all selector statements in an advanced event selector.

        • (dict) --

          A single selector statement in an advanced event selector.

          • Field (string) -- [REQUIRED]

            A field in an event record on which to filter events to be logged. Supported fields include readOnly , eventCategory , eventSource (for management events), eventName , resources.type , and resources.ARN .

            • **readOnly ** - Optional. Can be set to Equals a value of true or false . If you do not add this field, CloudTrail logs both both read and write events. A value of true logs only read events. A value of false logs only write events.
            • **eventSource ** - For filtering management events only. This can be set only to NotEquals kms.amazonaws.com .
            • **eventName ** - Can use any operator. You can use it to filter in or filter out any data event logged to CloudTrail, such as PutBucket or GetSnapshotBlock . You can have multiple values for this field, separated by commas.
            • **eventCategory ** - This is required. It must be set to Equals , and the value must be Management or Data .
            • **resources.type ** - This field is required. resources.type can only use the Equals operator, and the value can be one of the following:
              • AWS::S3::Object
              • AWS::Lambda::Function
              • AWS::DynamoDB::Table
              • AWS::S3Outposts::Object
              • AWS::ManagedBlockchain::Node
              • AWS::S3ObjectLambda::AccessPoint
              • AWS::EC2::Snapshot
              • AWS::S3::AccessPoint
              • AWS::DynamoDB::Stream
              • AWS::Glue::Table

            You can have only one resources.type field per selector. To log data events on more than one resource type, add another selector.

            • **resources.ARN ** - You can use any operator with resources.ARN , but if you use Equals or NotEquals , the value must exactly match the ARN of a valid resource of the type you've specified in the template as the value of resources.type. For example, if resources.type equals AWS::S3::Object , the ARN must be in one of the following formats. To log all data events for all objects in a specific S3 bucket, use the StartsWith operator, and include only the bucket ARN as the matching value. The trailing slash is intentional; do not exclude it. Replace the text between less than and greater than symbols (<>) with resource-specific information.
              • arn:<partition>:s3:::<bucket_name>/
              • arn:<partition>:s3:::<bucket_name>/<object_path>/

            When resources.type equals AWS::S3::AccessPoint , and the operator is set to Equals or NotEquals , the ARN must be in one of the following formats. To log events on all objects in an S3 access point, we recommend that you use only the access point ARN, don’t include the object path, and use the StartsWith or NotStartsWith operators.

            • arn:<partition>:s3:<region>:<account_ID>:accesspoint/<access_point_name>
            • arn:<partition>:s3:<region>:<account_ID>:accesspoint/<access_point_name>/object/<object_path>

            When resources.type equals AWS::Lambda::Function , and the operator is set to Equals or NotEquals , the ARN must be in the following format:

            • arn:<partition>:lambda:<region>:<account_ID>:function:<function_name>

            When resources.type equals AWS::DynamoDB::Table , and the operator is set to Equals or NotEquals , the ARN must be in the following format:

            • arn:<partition>:dynamodb:<region>:<account_ID>:table/<table_name>

            When resources.type equals AWS::S3Outposts::Object , and the operator is set to Equals or NotEquals , the ARN must be in the following format:

            • arn:<partition>:s3-outposts:<region>:<account_ID>:<object_path>

            When resources.type equals AWS::ManagedBlockchain::Node , and the operator is set to Equals or NotEquals , the ARN must be in the following format:

            • arn:<partition>:managedblockchain:<region>:<account_ID>:nodes/<node_ID>

            When resources.type equals AWS::S3ObjectLambda::AccessPoint , and the operator is set to Equals or NotEquals , the ARN must be in the following format:

            • arn:<partition>:s3-object-lambda:<region>:<account_ID>:accesspoint/<access_point_name>

            When resources.type equals AWS::EC2::Snapshot , and the operator is set to Equals or NotEquals , the ARN must be in the following format:

            • arn:<partition>:ec2:<region>::snapshot/<snapshot_ID>

            When resources.type equals AWS::DynamoDB::Stream , and the operator is set to Equals or NotEquals , the ARN must be in the following format:

            • arn:<partition>:dynamodb:<region>:<account_ID>:table/<table_name>/stream/<date_time>

            When resources.type equals AWS::Glue::Table , and the operator is set to Equals or NotEquals , the ARN must be in the following format:

            • arn:<partition>:glue:<region>:<account_ID>:table/<database_name>/<table_name>
          • Equals (list) --

            An operator that includes events that match the exact value of the event record field specified as the value of Field . This is the only valid operator that you can use with the readOnly , eventCategory , and resources.type fields.

            • (string) --
          • StartsWith (list) --

            An operator that includes events that match the first few characters of the event record field specified as the value of Field .

            • (string) --
          • EndsWith (list) --

            An operator that includes events that match the last few characters of the event record field specified as the value of Field .

            • (string) --
          • NotEquals (list) --

            An operator that excludes events that match the exact value of the event record field specified as the value of Field .

            • (string) --
          • NotStartsWith (list) --

            An operator that excludes events that match the first few characters of the event record field specified as the value of Field .

            • (string) --
          • NotEndsWith (list) --

            An operator that excludes events that match the last few characters of the event record field specified as the value of Field .

            • (string) --
  • MultiRegionEnabled (boolean) -- Specifies whether the event data store includes events from all regions, or only from the region in which the event data store is created.
  • OrganizationEnabled (boolean) -- Specifies whether an event data store collects events logged for an organization in Organizations.
  • RetentionPeriod (integer) -- The retention period of the event data store, in days. You can set a retention period of up to 2555 days, the equivalent of seven years.
  • TerminationProtectionEnabled (boolean) -- Specifies whether termination protection is enabled for the event data store. If termination protection is enabled, you cannot delete the event data store until termination protection is disabled.
  • TagsList (list) --

    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.

Return type

dict

Returns

Response Syntax

{
    'EventDataStoreArn': 'string',
    'Name': 'string',
    'Status': 'CREATED'|'ENABLED'|'PENDING_DELETION',
    'AdvancedEventSelectors': [
        {
            'Name': 'string',
            'FieldSelectors': [
                {
                    'Field': 'string',
                    'Equals': [
                        'string',
                    ],
                    'StartsWith': [
                        'string',
                    ],
                    'EndsWith': [
                        'string',
                    ],
                    'NotEquals': [
                        'string',
                    ],
                    'NotStartsWith': [
                        'string',
                    ],
                    'NotEndsWith': [
                        'string',
                    ]
                },
            ]
        },
    ],
    'MultiRegionEnabled': True|False,
    'OrganizationEnabled': True|False,
    'RetentionPeriod': 123,
    'TerminationProtectionEnabled': True|False,
    'TagsList': [
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    'CreatedTimestamp': datetime(2015, 1, 1),
    'UpdatedTimestamp': datetime(2015, 1, 1)
}

Response Structure

  • (dict) --

    • EventDataStoreArn (string) --

      The ARN of the event data store.

    • Name (string) --

      The name of the event data store.

    • Status (string) --

      The status of event data store creation.

    • AdvancedEventSelectors (list) --

      The advanced event selectors that were used to select the events for the data store.

      • (dict) --

        Advanced event selectors let you create fine-grained selectors for the following CloudTrail event record fields. They help you control costs by logging only those events that are important to you. For more information about advanced event selectors, see Logging data events for trails in the CloudTrail User Guide .

        • readOnly
        • eventSource
        • eventName
        • eventCategory
        • resources.type
        • resources.ARN

        You cannot apply both event selectors and advanced event selectors to a trail.

        • Name (string) --

          An optional, descriptive name for an advanced event selector, such as "Log data events for only two S3 buckets".

        • FieldSelectors (list) --

          Contains all selector statements in an advanced event selector.

          • (dict) --

            A single selector statement in an advanced event selector.

            • Field (string) --

              A field in an event record on which to filter events to be logged. Supported fields include readOnly , eventCategory , eventSource (for management events), eventName , resources.type , and resources.ARN .

              • **readOnly ** - Optional. Can be set to Equals a value of true or false . If you do not add this field, CloudTrail logs both both read and write events. A value of true logs only read events. A value of false logs only write events.
              • **eventSource ** - For filtering management events only. This can be set only to NotEquals kms.amazonaws.com .
              • **eventName ** - Can use any operator. You can use it to filter in or filter out any data event logged to CloudTrail, such as PutBucket or GetSnapshotBlock . You can have multiple values for this field, separated by commas.
              • **eventCategory ** - This is required. It must be set to Equals , and the value must be Management or Data .
              • **resources.type ** - This field is required. resources.type can only use the Equals operator, and the value can be one of the following:
                • AWS::S3::Object
                • AWS::Lambda::Function
                • AWS::DynamoDB::Table
                • AWS::S3Outposts::Object
                • AWS::ManagedBlockchain::Node
                • AWS::S3ObjectLambda::AccessPoint
                • AWS::EC2::Snapshot
                • AWS::S3::AccessPoint
                • AWS::DynamoDB::Stream
                • AWS::Glue::Table

              You can have only one resources.type field per selector. To log data events on more than one resource type, add another selector.

              • **resources.ARN ** - You can use any operator with resources.ARN , but if you use Equals or NotEquals , the value must exactly match the ARN of a valid resource of the type you've specified in the template as the value of resources.type. For example, if resources.type equals AWS::S3::Object , the ARN must be in one of the following formats. To log all data events for all objects in a specific S3 bucket, use the StartsWith operator, and include only the bucket ARN as the matching value. The trailing slash is intentional; do not exclude it. Replace the text between less than and greater than symbols (<>) with resource-specific information.
                • arn:<partition>:s3:::<bucket_name>/
                • arn:<partition>:s3:::<bucket_name>/<object_path>/

              When resources.type equals AWS::S3::AccessPoint , and the operator is set to Equals or NotEquals , the ARN must be in one of the following formats. To log events on all objects in an S3 access point, we recommend that you use only the access point ARN, don’t include the object path, and use the StartsWith or NotStartsWith operators.

              • arn:<partition>:s3:<region>:<account_ID>:accesspoint/<access_point_name>
              • arn:<partition>:s3:<region>:<account_ID>:accesspoint/<access_point_name>/object/<object_path>

              When resources.type equals AWS::Lambda::Function , and the operator is set to Equals or NotEquals , the ARN must be in the following format:

              • arn:<partition>:lambda:<region>:<account_ID>:function:<function_name>

              When resources.type equals AWS::DynamoDB::Table , and the operator is set to Equals or NotEquals , the ARN must be in the following format:

              • arn:<partition>:dynamodb:<region>:<account_ID>:table/<table_name>

              When resources.type equals AWS::S3Outposts::Object , and the operator is set to Equals or NotEquals , the ARN must be in the following format:

              • arn:<partition>:s3-outposts:<region>:<account_ID>:<object_path>

              When resources.type equals AWS::ManagedBlockchain::Node , and the operator is set to Equals or NotEquals , the ARN must be in the following format:

              • arn:<partition>:managedblockchain:<region>:<account_ID>:nodes/<node_ID>

              When resources.type equals AWS::S3ObjectLambda::AccessPoint , and the operator is set to Equals or NotEquals , the ARN must be in the following format:

              • arn:<partition>:s3-object-lambda:<region>:<account_ID>:accesspoint/<access_point_name>

              When resources.type equals AWS::EC2::Snapshot , and the operator is set to Equals or NotEquals , the ARN must be in the following format:

              • arn:<partition>:ec2:<region>::snapshot/<snapshot_ID>

              When resources.type equals AWS::DynamoDB::Stream , and the operator is set to Equals or NotEquals , the ARN must be in the following format:

              • arn:<partition>:dynamodb:<region>:<account_ID>:table/<table_name>/stream/<date_time>

              When resources.type equals AWS::Glue::Table , and the operator is set to Equals or NotEquals , the ARN must be in the following format:

              • arn:<partition>:glue:<region>:<account_ID>:table/<database_name>/<table_name>
            • Equals (list) --

              An operator that includes events that match the exact value of the event record field specified as the value of Field . This is the only valid operator that you can use with the readOnly , eventCategory , and resources.type fields.

              • (string) --
            • StartsWith (list) --

              An operator that includes events that match the first few characters of the event record field specified as the value of Field .

              • (string) --
            • EndsWith (list) --

              An operator that includes events that match the last few characters of the event record field specified as the value of Field .

              • (string) --
            • NotEquals (list) --

              An operator that excludes events that match the exact value of the event record field specified as the value of Field .

              • (string) --
            • NotStartsWith (list) --

              An operator that excludes events that match the first few characters of the event record field specified as the value of Field .

              • (string) --
            • NotEndsWith (list) --

              An operator that excludes events that match the last few characters of the event record field specified as the value of Field .

              • (string) --
    • MultiRegionEnabled (boolean) --

      Indicates whether the event data store collects events from all regions, or only from the region in which it was created.

    • OrganizationEnabled (boolean) --

      Indicates whether an event data store is collecting logged events for an organization in Organizations.

    • RetentionPeriod (integer) --

      The retention period of an event data store, in days.

    • TerminationProtectionEnabled (boolean) --

      Indicates whether termination protection is enabled for the event data store.

    • TagsList (list) --

      A list of tags.

      • (dict) --

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

        • Key (string) --

          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.

    • CreatedTimestamp (datetime) --

      The timestamp that shows when the event data store was created.

    • UpdatedTimestamp (datetime) --

      The timestamp that shows when an event data store was updated, if applicable. UpdatedTimestamp is always either the same or newer than the time shown in CreatedTimestamp .

Exceptions

create_trail(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = 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'
        },
    ]
)
Parameters
  • Name (string) --

    [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 not valid.
    • Not be in IP address format (for example, 192.168.5.4)
  • S3BucketName (string) --

    [REQUIRED]

    Specifies the name of the Amazon S3 bucket designated for publishing log 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) -- Specifies the name of the Amazon SNS topic defined for notification of log file delivery. The maximum length is 256 characters.
  • 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 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.
  • EnableLogFileValidation (boolean) --

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

  • CloudWatchLogsLogGroupArn (string) -- 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 .
  • 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 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.

    CloudTrail also supports KMS multi-Region keys. For more information about multi-Region keys, see Using multi-Region keys in the Key Management Service Developer Guide .

    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
  • IsOrganizationTrail (boolean) -- Specifies whether the trail is created for all accounts in an organization in Organizations, or only for the current Amazon Web Services account. The default is false, and cannot be true unless the call is made on behalf of an Amazon Web Services account that is the management account for an organization in Organizations.
  • TagsList (list) --

    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.

Return type

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 following format.

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

    • IsOrganizationTrail (boolean) --

      Specifies whether the trail is an organization trail.

Exceptions

delete_event_data_store(**kwargs)

Disables the event data store specified by EventDataStore , which accepts an event data store ARN. After you run DeleteEventDataStore , the event data store enters a PENDING_DELETION state, and is automatically deleted after a wait period of seven days. TerminationProtectionEnabled must be set to False on the event data store; this operation cannot work if TerminationProtectionEnabled is True .

After you run DeleteEventDataStore on an event data store, you cannot run ListQueries , DescribeQuery , or GetQueryResults on queries that are using an event data store in a PENDING_DELETION state. An event data store in the PENDING_DELETION state does not incur costs.

See also: AWS API Documentation

Request Syntax

response = client.delete_event_data_store(
    EventDataStore='string'
)
Parameters
EventDataStore (string) --

[REQUIRED]

The ARN (or the ID suffix of the ARN) of the event data store to delete.

Return type
dict
Returns
Response Syntax
{}

Response Structure

  • (dict) --

Exceptions

delete_trail(**kwargs)

Deletes a trail. This operation must be called from the region in which the trail was created. DeleteTrail cannot be called on the shadow trails (replicated trails in other regions) of a trail that is enabled in all regions.

See also: AWS API Documentation

Request Syntax

response = client.delete_trail(
    Name='string'
)
Parameters
Name (string) --

[REQUIRED]

Specifies the name or the CloudTrail ARN of the trail to be deleted. The following is the format of a trail ARN. arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail

Return type
dict
Returns
Response Syntax
{}

Response Structure

  • (dict) --

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

Exceptions

describe_query(**kwargs)

Returns metadata about a query, including query run time in milliseconds, number of events scanned and matched, and query status. You must specify an ARN for EventDataStore , and a value for QueryID .

See also: AWS API Documentation

Request Syntax

response = client.describe_query(
    EventDataStore='string',
    QueryId='string'
)
Parameters
  • EventDataStore (string) --

    [REQUIRED]

    The ARN (or the ID suffix of the ARN) of an event data store on which the specified query was run.

  • QueryId (string) --

    [REQUIRED]

    The query ID.

Return type

dict

Returns

Response Syntax

{
    'QueryId': 'string',
    'QueryString': 'string',
    'QueryStatus': 'QUEUED'|'RUNNING'|'FINISHED'|'FAILED'|'CANCELLED'|'TIMED_OUT',
    'QueryStatistics': {
        'EventsMatched': 123,
        'EventsScanned': 123,
        'BytesScanned': 123,
        'ExecutionTimeInMillis': 123,
        'CreationTime': datetime(2015, 1, 1)
    },
    'ErrorMessage': 'string'
}

Response Structure

  • (dict) --

    • QueryId (string) --

      The ID of the query.

    • QueryString (string) --

      The SQL code of a query.

    • QueryStatus (string) --

      The status of a query. Values for QueryStatus include QUEUED , RUNNING , FINISHED , FAILED , TIMED_OUT , or CANCELLED

    • QueryStatistics (dict) --

      Metadata about a query, including the number of events that were matched, the total number of events scanned, the query run time in milliseconds, and the query's creation time.

      • EventsMatched (integer) --

        The number of events that matched a query.

      • EventsScanned (integer) --

        The number of events that the query scanned in the event data store.

      • BytesScanned (integer) --

        The total bytes that the query scanned in the event data store. This value matches the number of bytes for which your account is billed for the query, unless the query is still running.

      • ExecutionTimeInMillis (integer) --

        The query's run time, in milliseconds.

      • CreationTime (datetime) --

        The creation time of the query.

    • ErrorMessage (string) --

      The error message returned if a query failed.

Exceptions

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

get_event_data_store(**kwargs)

Returns information about an event data store specified as either an ARN or the ID portion of the ARN.

See also: AWS API Documentation

Request Syntax

response = client.get_event_data_store(
    EventDataStore='string'
)
Parameters
EventDataStore (string) --

[REQUIRED]

The ARN (or ID suffix of the ARN) of the event data store about which you want information.

Return type
dict
Returns
Response Syntax
{
    'EventDataStoreArn': 'string',
    'Name': 'string',
    'Status': 'CREATED'|'ENABLED'|'PENDING_DELETION',
    'AdvancedEventSelectors': [
        {
            'Name': 'string',
            'FieldSelectors': [
                {
                    'Field': 'string',
                    'Equals': [
                        'string',
                    ],
                    'StartsWith': [
                        'string',
                    ],
                    'EndsWith': [
                        'string',
                    ],
                    'NotEquals': [
                        'string',
                    ],
                    'NotStartsWith': [
                        'string',
                    ],
                    'NotEndsWith': [
                        'string',
                    ]
                },
            ]
        },
    ],
    'MultiRegionEnabled': True|False,
    'OrganizationEnabled': True|False,
    'RetentionPeriod': 123,
    'TerminationProtectionEnabled': True|False,
    'CreatedTimestamp': datetime(2015, 1, 1),
    'UpdatedTimestamp': datetime(2015, 1, 1)
}

Response Structure

  • (dict) --
    • EventDataStoreArn (string) --

      The event data store Amazon Resource Number (ARN).

    • Name (string) --

      The name of the event data store.

    • Status (string) --

      The status of an event data store. Values can be ENABLED and PENDING_DELETION .

    • AdvancedEventSelectors (list) --

      The advanced event selectors used to select events for the data store.

      • (dict) --

        Advanced event selectors let you create fine-grained selectors for the following CloudTrail event record fields. They help you control costs by logging only those events that are important to you. For more information about advanced event selectors, see Logging data events for trails in the CloudTrail User Guide .

        • readOnly
        • eventSource
        • eventName
        • eventCategory
        • resources.type
        • resources.ARN

        You cannot apply both event selectors and advanced event selectors to a trail.

        • Name (string) --

          An optional, descriptive name for an advanced event selector, such as "Log data events for only two S3 buckets".

        • FieldSelectors (list) --

          Contains all selector statements in an advanced event selector.

          • (dict) --

            A single selector statement in an advanced event selector.

            • Field (string) --

              A field in an event record on which to filter events to be logged. Supported fields include readOnly , eventCategory , eventSource (for management events), eventName , resources.type , and resources.ARN .

              • **readOnly ** - Optional. Can be set to Equals a value of true or false . If you do not add this field, CloudTrail logs both both read and write events. A value of true logs only read events. A value of false logs only write events.
              • **eventSource ** - For filtering management events only. This can be set only to NotEquals kms.amazonaws.com .
              • **eventName ** - Can use any operator. You can use it to filter in or filter out any data event logged to CloudTrail, such as PutBucket or GetSnapshotBlock . You can have multiple values for this field, separated by commas.
              • **eventCategory ** - This is required. It must be set to Equals , and the value must be Management or Data .
              • **resources.type ** - This field is required. resources.type can only use the Equals operator, and the value can be one of the following:
                • AWS::S3::Object
                • AWS::Lambda::Function
                • AWS::DynamoDB::Table
                • AWS::S3Outposts::Object
                • AWS::ManagedBlockchain::Node
                • AWS::S3ObjectLambda::AccessPoint
                • AWS::EC2::Snapshot
                • AWS::S3::AccessPoint
                • AWS::DynamoDB::Stream
                • AWS::Glue::Table

              You can have only one resources.type field per selector. To log data events on more than one resource type, add another selector.

              • **resources.ARN ** - You can use any operator with resources.ARN , but if you use Equals or NotEquals , the value must exactly match the ARN of a valid resource of the type you've specified in the template as the value of resources.type. For example, if resources.type equals AWS::S3::Object , the ARN must be in one of the following formats. To log all data events for all objects in a specific S3 bucket, use the StartsWith operator, and include only the bucket ARN as the matching value. The trailing slash is intentional; do not exclude it. Replace the text between less than and greater than symbols (<>) with resource-specific information.
                • arn:<partition>:s3:::<bucket_name>/
                • arn:<partition>:s3:::<bucket_name>/<object_path>/

              When resources.type equals AWS::S3::AccessPoint , and the operator is set to Equals or NotEquals , the ARN must be in one of the following formats. To log events on all objects in an S3 access point, we recommend that you use only the access point ARN, don’t include the object path, and use the StartsWith or NotStartsWith operators.

              • arn:<partition>:s3:<region>:<account_ID>:accesspoint/<access_point_name>
              • arn:<partition>:s3:<region>:<account_ID>:accesspoint/<access_point_name>/object/<object_path>

              When resources.type equals AWS::Lambda::Function , and the operator is set to Equals or NotEquals , the ARN must be in the following format:

              • arn:<partition>:lambda:<region>:<account_ID>:function:<function_name>

              When resources.type equals AWS::DynamoDB::Table , and the operator is set to Equals or NotEquals , the ARN must be in the following format:

              • arn:<partition>:dynamodb:<region>:<account_ID>:table/<table_name>

              When resources.type equals AWS::S3Outposts::Object , and the operator is set to Equals or NotEquals , the ARN must be in the following format:

              • arn:<partition>:s3-outposts:<region>:<account_ID>:<object_path>

              When resources.type equals AWS::ManagedBlockchain::Node , and the operator is set to Equals or NotEquals , the ARN must be in the following format:

              • arn:<partition>:managedblockchain:<region>:<account_ID>:nodes/<node_ID>

              When resources.type equals AWS::S3ObjectLambda::AccessPoint , and the operator is set to Equals or NotEquals , the ARN must be in the following format:

              • arn:<partition>:s3-object-lambda:<region>:<account_ID>:accesspoint/<access_point_name>

              When resources.type equals AWS::EC2::Snapshot , and the operator is set to Equals or NotEquals , the ARN must be in the following format:

              • arn:<partition>:ec2:<region>::snapshot/<snapshot_ID>

              When resources.type equals AWS::DynamoDB::Stream , and the operator is set to Equals or NotEquals , the ARN must be in the following format:

              • arn:<partition>:dynamodb:<region>:<account_ID>:table/<table_name>/stream/<date_time>

              When resources.type equals AWS::Glue::Table , and the operator is set to Equals or NotEquals , the ARN must be in the following format:

              • arn:<partition>:glue:<region>:<account_ID>:table/<database_name>/<table_name>
            • Equals (list) --

              An operator that includes events that match the exact value of the event record field specified as the value of Field . This is the only valid operator that you can use with the readOnly , eventCategory , and resources.type fields.

              • (string) --
            • StartsWith (list) --

              An operator that includes events that match the first few characters of the event record field specified as the value of Field .

              • (string) --
            • EndsWith (list) --

              An operator that includes events that match the last few characters of the event record field specified as the value of Field .

              • (string) --
            • NotEquals (list) --

              An operator that excludes events that match the exact value of the event record field specified as the value of Field .

              • (string) --
            • NotStartsWith (list) --

              An operator that excludes events that match the first few characters of the event record field specified as the value of Field .

              • (string) --
            • NotEndsWith (list) --

              An operator that excludes events that match the last few characters of the event record field specified as the value of Field .

              • (string) --
    • MultiRegionEnabled (boolean) --

      Indicates whether the event data store includes events from all regions, or only from the region in which it was created.

    • OrganizationEnabled (boolean) --

      Indicates whether an event data store is collecting logged events for an organization in Organizations.

    • RetentionPeriod (integer) --

      The retention period of the event data store, in days.

    • TerminationProtectionEnabled (boolean) --

      Indicates that termination protection is enabled.

    • CreatedTimestamp (datetime) --

      The timestamp of the event data store's creation.

    • UpdatedTimestamp (datetime) --

      Shows the time that an event data store was updated, if applicable. UpdatedTimestamp is always either the same or newer than the time shown in CreatedTimestamp .

Exceptions

get_event_selectors(**kwargs)

Describes the settings for the event selectors that you configured for your trail. The information returned for your event selectors includes the following:

  • If your event selector includes read-only events, write-only events, or all events. This applies to both management events and data events.
  • If your event selector includes management events.
  • If your event selector includes data events, the resources on which you are logging data events.

For more information, see Logging Data and Management Events for Trails in the CloudTrail User Guide .

See also: AWS API Documentation

Request Syntax

response = client.get_event_selectors(
    TrailName='string'
)
Parameters
TrailName (string) --

[REQUIRED]

Specifies the name of the trail or trail ARN. If you specify a trail name, the string 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 not valid.
  • Not be in IP address format (for example, 192.168.5.4)

If you specify a trail ARN, it must be in the format:

arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail
Return type
dict
Returns
Response Syntax
{
    'TrailARN': 'string',
    'EventSelectors': [
        {
            'ReadWriteType': 'ReadOnly'|'WriteOnly'|'All',
            'IncludeManagementEvents': True|False,
            'DataResources': [
                {
                    'Type': 'string',
                    'Values': [
                        'string',
                    ]
                },
            ],
            'ExcludeManagementEventSources': [
                'string',
            ]
        },
    ],
    'AdvancedEventSelectors': [
        {
            'Name': 'string',
            'FieldSelectors': [
                {
                    'Field': 'string',
                    'Equals': [
                        'string',
                    ],
                    'StartsWith': [
                        'string',
                    ],
                    'EndsWith': [
                        'string',
                    ],
                    'NotEquals': [
                        'string',
                    ],
                    'NotStartsWith': [
                        'string',
                    ],
                    'NotEndsWith': [
                        'string',
                    ]
                },
            ]
        },
    ]
}

Response Structure

  • (dict) --
    • TrailARN (string) --

      The specified trail ARN that has the event selectors.

    • EventSelectors (list) --

      The event selectors that are configured for the trail.

      • (dict) --

        Use event selectors to further specify the management and data event settings for your trail. By default, trails created without specific event selectors will be configured to log all read and write management events, and no data events. When an event occurs in your account, CloudTrail evaluates the event selector for all trails. For each trail, if the event matches any event selector, the trail processes and logs the event. If the event doesn't match any event selector, the trail doesn't log the event.

        You can configure up to five event selectors for a trail.

        You cannot apply both event selectors and advanced event selectors to a trail.

        • ReadWriteType (string) --

          Specify if you want your trail to log read-only events, write-only events, or all. For example, the EC2 GetConsoleOutput is a read-only API operation and RunInstances is a write-only API operation.

          By default, the value is All .

        • IncludeManagementEvents (boolean) --

          Specify if you want your event selector to include management events for your trail.

          For more information, see Management Events in the CloudTrail User Guide .

          By default, the value is true .

          The first copy of management events is free. You are charged for additional copies of management events that you are logging on any subsequent trail in the same region. For more information about CloudTrail pricing, see CloudTrail Pricing .

        • DataResources (list) --

          CloudTrail supports data event logging for Amazon S3 objects, Lambda functions, and Amazon DynamoDB tables with basic event selectors. You can specify up to 250 resources for an individual event selector, but the total number of data resources cannot exceed 250 across all event selectors in a trail. This limit does not apply if you configure resource logging for all data events.

          For more information, see Data Events and Limits in CloudTrail in the CloudTrail User Guide .

          • (dict) --

            The Amazon S3 buckets, Lambda functions, or Amazon DynamoDB tables that you specify in your event selectors for your trail to log data events. Data events provide information about the resource operations performed on or within a resource itself. These are also known as data plane operations. You can specify up to 250 data resources for a trail.

            Note

            The total number of allowed data resources is 250. This number can be distributed between 1 and 5 event selectors, but the total cannot exceed 250 across all selectors.

            If you are using advanced event selectors, the maximum total number of values for all conditions, across all advanced event selectors for the trail, is 500.

            The following example demonstrates how logging works when you configure logging of all data events for an S3 bucket named bucket-1 . In this example, the CloudTrail user specified an empty prefix, and the option to log both Read and Write data events.

            • A user uploads an image file to bucket-1 .
            • The PutObject API operation is an Amazon S3 object-level API. It is recorded as a data event in CloudTrail. Because the CloudTrail user specified an S3 bucket with an empty prefix, events that occur on any object in that bucket are logged. The trail processes and logs the event.
            • A user uploads an object to an Amazon S3 bucket named arn:aws:s3:::bucket-2 .
            • The PutObject API operation occurred for an object in an S3 bucket that the CloudTrail user didn't specify for the trail. The trail doesn’t log the event.

            The following example demonstrates how logging works when you configure logging of Lambda data events for a Lambda function named MyLambdaFunction , but not for all Lambda functions.

            • A user runs a script that includes a call to the MyLambdaFunction function and the MyOtherLambdaFunction function.
            • The Invoke API operation on MyLambdaFunction is an Lambda API. It is recorded as a data event in CloudTrail. Because the CloudTrail user specified logging data events for MyLambdaFunction , any invocations of that function are logged. The trail processes and logs the event.
            • The Invoke API operation on MyOtherLambdaFunction is an Lambda API. Because the CloudTrail user did not specify logging data events for all Lambda functions, the Invoke operation for MyOtherLambdaFunction does not match the function specified for the trail. The trail doesn’t log the event.
            • Type (string) --

              The resource type in which you want to log data events. You can specify the following basic event selector resource types:

              • AWS::S3::Object
              • AWS::Lambda::Function
              • AWS::DynamoDB::Table

              The following resource types are also availble through advanced event selectors. Basic event selector resource types are valid in advanced event selectors, but advanced event selector resource types are not valid in basic event selectors. For more information, see AdvancedFieldSelector$Field .

              • AWS::S3Outposts::Object
              • AWS::ManagedBlockchain::Node
              • AWS::S3ObjectLambda::AccessPoint
              • AWS::EC2::Snapshot
              • AWS::S3::AccessPoint
              • AWS::DynamoDB::Stream
              • AWS::Glue::Table
            • Values (list) --

              An array of Amazon Resource Name (ARN) strings or partial ARN strings for the specified objects.

              • To log data events for all objects in all S3 buckets in your Amazon Web Services account, specify the prefix as arn:aws:s3::: .

              Note

              This also enables logging of data event activity performed by any user or role in your Amazon Web Services account, even if that activity is performed on a bucket that belongs to another Amazon Web Services account.

              • To log data events for all objects in an S3 bucket, specify the bucket and an empty object prefix such as arn:aws:s3:::bucket-1/ . The trail logs data events for all objects in this S3 bucket.
              • To log data events for specific objects, specify the S3 bucket and object prefix such as arn:aws:s3:::bucket-1/example-images . The trail logs data events for objects in this S3 bucket that match the prefix.
              • To log data events for all Lambda functions in your Amazon Web Services account, specify the prefix as arn:aws:lambda .

              Note

              This also enables logging of Invoke activity performed by any user or role in your Amazon Web Services account, even if that activity is performed on a function that belongs to another Amazon Web Services account.

              • To log data events for a specific Lambda function, specify the function ARN.

              Note

              Lambda function ARNs are exact. For example, if you specify a function ARN arn:aws:lambda:us-west-2:111111111111:function:helloworld , data events will only be logged for arn:aws:lambda:us-west-2:111111111111:function:helloworld . They will not be logged for arn:aws:lambda:us-west-2:111111111111:function:helloworld2 .

              • To log data events for all DynamoDB tables in your Amazon Web Services account, specify the prefix as arn:aws:dynamodb .
              • (string) --
        • ExcludeManagementEventSources (list) --

          An optional list of service event sources from which you do not want management events to be logged on your trail. In this release, the list can be empty (disables the filter), or it can filter out Key Management Service or Amazon RDS Data API events by containing kms.amazonaws.com or rdsdata.amazonaws.com . By default, ExcludeManagementEventSources is empty, and KMS and Amazon RDS Data API events are logged to your trail. You can exclude management event sources only in regions that support the event source.

          • (string) --
    • AdvancedEventSelectors (list) --

      The advanced event selectors that are configured for the trail.

      • (dict) --

        Advanced event selectors let you create fine-grained selectors for the following CloudTrail event record fields. They help you control costs by logging only those events that are important to you. For more information about advanced event selectors, see Logging data events for trails in the CloudTrail User Guide .

        • readOnly
        • eventSource
        • eventName
        • eventCategory
        • resources.type
        • resources.ARN

        You cannot apply both event selectors and advanced event selectors to a trail.

        • Name (string) --

          An optional, descriptive name for an advanced event selector, such as "Log data events for only two S3 buckets".

        • FieldSelectors (list) --

          Contains all selector statements in an advanced event selector.

          • (dict) --

            A single selector statement in an advanced event selector.

            • Field (string) --

              A field in an event record on which to filter events to be logged. Supported fields include readOnly , eventCategory , eventSource (for management events), eventName , resources.type , and resources.ARN .

              • **readOnly ** - Optional. Can be set to Equals a value of true or false . If you do not add this field, CloudTrail logs both both read and write events. A value of true logs only read events. A value of false logs only write events.
              • **eventSource ** - For filtering management events only. This can be set only to NotEquals kms.amazonaws.com .
              • **eventName ** - Can use any operator. You can use it to filter in or filter out any data event logged to CloudTrail, such as PutBucket or GetSnapshotBlock . You can have multiple values for this field, separated by commas.
              • **eventCategory ** - This is required. It must be set to Equals , and the value must be Management or Data .
              • **resources.type ** - This field is required. resources.type can only use the Equals operator, and the value can be one of the following:
                • AWS::S3::Object
                • AWS::Lambda::Function
                • AWS::DynamoDB::Table
                • AWS::S3Outposts::Object
                • AWS::ManagedBlockchain::Node
                • AWS::S3ObjectLambda::AccessPoint
                • AWS::EC2::Snapshot
                • AWS::S3::AccessPoint
                • AWS::DynamoDB::Stream
                • AWS::Glue::Table

              You can have only one resources.type field per selector. To log data events on more than one resource type, add another selector.

              • **resources.ARN ** - You can use any operator with resources.ARN , but if you use Equals or NotEquals , the value must exactly match the ARN of a valid resource of the type you've specified in the template as the value of resources.type. For example, if resources.type equals AWS::S3::Object , the ARN must be in one of the following formats. To log all data events for all objects in a specific S3 bucket, use the StartsWith operator, and include only the bucket ARN as the matching value. The trailing slash is intentional; do not exclude it. Replace the text between less than and greater than symbols (<>) with resource-specific information.
                • arn:<partition>:s3:::<bucket_name>/
                • arn:<partition>:s3:::<bucket_name>/<object_path>/

              When resources.type equals AWS::S3::AccessPoint , and the operator is set to Equals or NotEquals , the ARN must be in one of the following formats. To log events on all objects in an S3 access point, we recommend that you use only the access point ARN, don’t include the object path, and use the StartsWith or NotStartsWith operators.

              • arn:<partition>:s3:<region>:<account_ID>:accesspoint/<access_point_name>
              • arn:<partition>:s3:<region>:<account_ID>:accesspoint/<access_point_name>/object/<object_path>

              When resources.type equals AWS::Lambda::Function , and the operator is set to Equals or NotEquals , the ARN must be in the following format:

              • arn:<partition>:lambda:<region>:<account_ID>:function:<function_name>

              When resources.type equals AWS::DynamoDB::Table , and the operator is set to Equals or NotEquals , the ARN must be in the following format:

              • arn:<partition>:dynamodb:<region>:<account_ID>:table/<table_name>

              When resources.type equals AWS::S3Outposts::Object , and the operator is set to Equals or NotEquals , the ARN must be in the following format:

              • arn:<partition>:s3-outposts:<region>:<account_ID>:<object_path>

              When resources.type equals AWS::ManagedBlockchain::Node , and the operator is set to Equals or NotEquals , the ARN must be in the following format:

              • arn:<partition>:managedblockchain:<region>:<account_ID>:nodes/<node_ID>

              When resources.type equals AWS::S3ObjectLambda::AccessPoint , and the operator is set to Equals or NotEquals , the ARN must be in the following format:

              • arn:<partition>:s3-object-lambda:<region>:<account_ID>:accesspoint/<access_point_name>

              When resources.type equals AWS::EC2::Snapshot , and the operator is set to Equals or NotEquals , the ARN must be in the following format:

              • arn:<partition>:ec2:<region>::snapshot/<snapshot_ID>

              When resources.type equals AWS::DynamoDB::Stream , and the operator is set to Equals or NotEquals , the ARN must be in the following format:

              • arn:<partition>:dynamodb:<region>:<account_ID>:table/<table_name>/stream/<date_time>

              When resources.type equals AWS::Glue::Table , and the operator is set to Equals or NotEquals , the ARN must be in the following format:

              • arn:<partition>:glue:<region>:<account_ID>:table/<database_name>/<table_name>
            • Equals (list) --

              An operator that includes events that match the exact value of the event record field specified as the value of Field . This is the only valid operator that you can use with the readOnly , eventCategory , and resources.type fields.

              • (string) --
            • StartsWith (list) --

              An operator that includes events that match the first few characters of the event record field specified as the value of Field .

              • (string) --
            • EndsWith (list) --

              An operator that includes events that match the last few characters of the event record field specified as the value of Field .

              • (string) --
            • NotEquals (list) --

              An operator that excludes events that match the exact value of the event record field specified as the value of Field .

              • (string) --
            • NotStartsWith (list) --

              An operator that excludes events that match the first few characters of the event record field specified as the value of Field .

              • (string) --
            • NotEndsWith (list) --

              An operator that excludes events that match the last few characters of the event record field specified as the value of Field .

              • (string) --

Exceptions

get_insight_selectors(**kwargs)

Describes the settings for the Insights event selectors that you configured for your trail. GetInsightSelectors shows if CloudTrail Insights event logging is enabled on the trail, and if it is, which insight types are enabled. If you run GetInsightSelectors on a trail that does not have Insights events enabled, the operation throws the exception InsightNotEnabledException

For more information, see Logging CloudTrail Insights Events for Trails in the CloudTrail User Guide .

See also: AWS API Documentation

Request Syntax

response = client.get_insight_selectors(
    TrailName='string'
)
Parameters
TrailName (string) --

[REQUIRED]

Specifies the name of the trail or trail ARN. If you specify a trail name, the string 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 not valid.
  • Not be in IP address format (for example, 192.168.5.4)

If you specify a trail ARN, it must be in the format:

arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail
Return type
dict
Returns
Response Syntax
{
    'TrailARN': 'string',
    'InsightSelectors': [
        {
            'InsightType': 'ApiCallRateInsight'|'ApiErrorRateInsight'
        },
    ]
}

Response Structure

  • (dict) --
    • TrailARN (string) --

      The Amazon Resource Name (ARN) of a trail for which you want to get Insights selectors.

    • InsightSelectors (list) --

      A JSON string that contains the insight types you want to log on a trail. In this release, ApiErrorRateInsight and ApiCallRateInsight are supported as insight types.

      • (dict) --

        A JSON string that contains a list of insight types that are logged on a trail.

        • InsightType (string) --

          The type of insights to log on a trail. ApiCallRateInsight and ApiErrorRateInsight are valid insight types.

Exceptions

get_paginator(operation_name)

Create a paginator for an operation.

Parameters
operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Raises OperationNotPageableError
Raised if the operation is not pageable. You can use the client.can_paginate method to check if an operation is pageable.
Return type
L{botocore.paginate.Paginator}
Returns
A paginator object.
get_query_results(**kwargs)

Gets event data results of a query. You must specify the QueryID value returned by the StartQuery operation, and an ARN for EventDataStore .

See also: AWS API Documentation

Request Syntax

response = client.get_query_results(
    EventDataStore='string',
    QueryId='string',
    NextToken='string',
    MaxQueryResults=123
)
Parameters
  • EventDataStore (string) --

    [REQUIRED]

    The ARN (or ID suffix of the ARN) of the event data store against which the query was run.

  • QueryId (string) --

    [REQUIRED]

    The ID of the query for which you want to get results.

  • NextToken (string) -- A token you can use to get the next page of query results.
  • MaxQueryResults (integer) -- The maximum number of query results to display on a single page.
Return type

dict

Returns

Response Syntax

{
    'QueryStatus': 'QUEUED'|'RUNNING'|'FINISHED'|'FAILED'|'CANCELLED'|'TIMED_OUT',
    'QueryStatistics': {
        'ResultsCount': 123,
        'TotalResultsCount': 123,
        'BytesScanned': 123
    },
    'QueryResultRows': [
        [
            {
                'string': 'string'
            },
        ],
    ],
    'NextToken': 'string',
    'ErrorMessage': 'string'
}

Response Structure

  • (dict) --

    • QueryStatus (string) --

      The status of the query. Values include QUEUED , RUNNING , FINISHED , FAILED , TIMED_OUT , or CANCELLED .

    • QueryStatistics (dict) --

      Shows the count of query results.

      • ResultsCount (integer) --

        The number of results returned.

      • TotalResultsCount (integer) --

        The total number of results returned by a query.

      • BytesScanned (integer) --

        The total bytes that the query scanned in the event data store. This value matches the number of bytes for which your account is billed for the query, unless the query is still running.

    • QueryResultRows (list) --

      Contains the individual event results of the query.

      • (list) --
        • (dict) --
          • (string) --
            • (string) --
    • NextToken (string) --

      A token you can use to get the next page of query results.

    • ErrorMessage (string) --

      The error message returned if a query failed.

Exceptions

get_trail(**kwargs)

Returns settings information for a specified trail.

See also: AWS API Documentation

Request Syntax

response = client.get_trail(
    Name='string'
)
Parameters
Name (string) --

[REQUIRED]

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

Return type
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,
        'HasInsightSelectors': 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 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

get_trail_status(**kwargs)

Returns a JSON-formatted list of information about the specified trail. Fields include information on delivery errors, Amazon SNS and Amazon S3 errors, and start and stop logging times for each trail. This operation returns trail status from a single region. To return trail status from all regions, you must call the operation on each region.

See also: AWS API Documentation

Request Syntax

response = client.get_trail_status(
    Name='string'
)
Parameters
Name (string) --

[REQUIRED]

Specifies the name or the CloudTrail ARN of the trail for which you are requesting status. To get the status of a shadow trail (a replication of the trail in another region), you must specify its ARN. The following is the format of a trail ARN.

arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail
Return type
dict
Returns
Response Syntax
{
    'IsLogging': True|False,
    'LatestDeliveryError': 'string',
    'LatestNotificationError': 'string',
    'LatestDeliveryTime': datetime(2015, 1, 1),
    'LatestNotificationTime': datetime(2015, 1, 1),
    'StartLoggingTime': datetime(2015, 1, 1),
    'StopLoggingTime': datetime(2015, 1, 1),
    'LatestCloudWatchLogsDeliveryError': 'string',
    'LatestCloudWatchLogsDeliveryTime': datetime(2015, 1, 1),
    'LatestDigestDeliveryTime': datetime(2015, 1, 1),
    'LatestDigestDeliveryError': 'string',
    'LatestDeliveryAttemptTime': 'string',
    'LatestNotificationAttemptTime': 'string',
    'LatestNotificationAttemptSucceeded': 'string',
    'LatestDeliveryAttemptSucceeded': 'string',
    'TimeLoggingStarted': 'string',
    'TimeLoggingStopped': 'string'
}

Response Structure

  • (dict) --

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

    • IsLogging (boolean) --

      Whether the CloudTrail trail is currently logging Amazon Web Services API calls.

    • LatestDeliveryError (string) --

      Displays any Amazon S3 error that CloudTrail encountered when attempting to deliver log files to the designated bucket. For more information, see Error Responses in the Amazon S3 API Reference.

      Note

      This error occurs only when there is a problem with the destination S3 bucket, and does not occur for requests that time out. To resolve the issue, create a new bucket, and then call UpdateTrail to specify the new bucket; or fix the existing objects so that CloudTrail can again write to the bucket.

    • LatestNotificationError (string) --

      Displays any Amazon SNS error that CloudTrail encountered when attempting to send a notification. For more information about Amazon SNS errors, see the Amazon SNS Developer Guide .

    • LatestDeliveryTime (datetime) --

      Specifies the date and time that CloudTrail last delivered log files to an account's Amazon S3 bucket.

    • LatestNotificationTime (datetime) --

      Specifies the date and time of the most recent Amazon SNS notification that CloudTrail has written a new log file to an account's Amazon S3 bucket.

    • StartLoggingTime (datetime) --

      Specifies the most recent date and time when CloudTrail started recording API calls for an Amazon Web Services account.

    • StopLoggingTime (datetime) --

      Specifies the most recent date and time when CloudTrail stopped recording API calls for an Amazon Web Services account.

    • LatestCloudWatchLogsDeliveryError (string) --

      Displays any CloudWatch Logs error that CloudTrail encountered when attempting to deliver logs to CloudWatch Logs.

    • LatestCloudWatchLogsDeliveryTime (datetime) --

      Displays the most recent date and time when CloudTrail delivered logs to CloudWatch Logs.

    • LatestDigestDeliveryTime (datetime) --

      Specifies the date and time that CloudTrail last delivered a digest file to an account's Amazon S3 bucket.

    • LatestDigestDeliveryError (string) --

      Displays any Amazon S3 error that CloudTrail encountered when attempting to deliver a digest file to the designated bucket. For more information, see Error Responses in the Amazon S3 API Reference.

      Note

      This error occurs only when there is a problem with the destination S3 bucket, and does not occur for requests that time out. To resolve the issue, create a new bucket, and then call UpdateTrail to specify the new bucket; or fix the existing objects so that CloudTrail can again write to the bucket.

    • LatestDeliveryAttemptTime (string) --

      This field is no longer in use.

    • LatestNotificationAttemptTime (string) --

      This field is no longer in use.

    • LatestNotificationAttemptSucceeded (string) --

      This field is no longer in use.

    • LatestDeliveryAttemptSucceeded (string) --

      This field is no longer in use.

    • TimeLoggingStarted (string) --

      This field is no longer in use.

    • TimeLoggingStopped (string) --

      This field is no longer in use.

Exceptions

get_waiter(waiter_name)

Returns an object that can wait for some condition.

Parameters
waiter_name (str) -- The name of the waiter to get. See the waiters section of the service docs for a list of available waiters.
Returns
The specified waiter object.
Return type
botocore.waiter.Waiter
list_event_data_stores(**kwargs)

Returns information about all event data stores in the account, in the current region.

See also: AWS API Documentation

Request Syntax

response = client.list_event_data_stores(
    NextToken='string',
    MaxResults=123
)
Parameters
  • NextToken (string) -- A token you can use to get the next page of event data store results.
  • MaxResults (integer) -- The maximum number of event data stores to display on a single page.
Return type

dict

Returns

Response Syntax

{
    'EventDataStores': [
        {
            'EventDataStoreArn': 'string',
            'Name': 'string',
            'TerminationProtectionEnabled': True|False,
            'Status': 'CREATED'|'ENABLED'|'PENDING_DELETION',
            'AdvancedEventSelectors': [
                {
                    'Name': 'string',
                    'FieldSelectors': [
                        {
                            'Field': 'string',
                            'Equals': [
                                'string',
                            ],
                            'StartsWith': [
                                'string',
                            ],
                            'EndsWith': [
                                'string',
                            ],
                            'NotEquals': [
                                'string',
                            ],
                            'NotStartsWith': [
                                'string',
                            ],
                            'NotEndsWith': [
                                'string',
                            ]
                        },
                    ]
                },
            ],
            'MultiRegionEnabled': True|False,
            'OrganizationEnabled': True|False,
            'RetentionPeriod': 123,
            'CreatedTimestamp': datetime(2015, 1, 1),
            'UpdatedTimestamp': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • EventDataStores (list) --

      Contains information about event data stores in the account, in the current region.

      • (dict) --

        A storage lake of event data against which you can run complex SQL-based queries. An event data store can include events that you have logged on your account from the last 90 to 2555 days (about three months to up to seven years). To select events for an event data store, use advanced event selectors .

        • EventDataStoreArn (string) --

          The ARN of the event data store.

        • Name (string) --

          The name of the event data store.

        • TerminationProtectionEnabled (boolean) --

          This field is being deprecated. Indicates whether the event data store is protected from termination.

        • Status (string) --

          This field is being deprecated. The status of an event data store. Values are ENABLED and PENDING_DELETION .

        • AdvancedEventSelectors (list) --

          This field is being deprecated. The advanced event selectors that were used to select events for the data store.

          • (dict) --

            Advanced event selectors let you create fine-grained selectors for the following CloudTrail event record fields. They help you control costs by logging only those events that are important to you. For more information about advanced event selectors, see Logging data events for trails in the CloudTrail User Guide .

            • readOnly
            • eventSource
            • eventName
            • eventCategory
            • resources.type
            • resources.ARN

            You cannot apply both event selectors and advanced event selectors to a trail.

            • Name (string) --

              An optional, descriptive name for an advanced event selector, such as "Log data events for only two S3 buckets".

            • FieldSelectors (list) --

              Contains all selector statements in an advanced event selector.

              • (dict) --

                A single selector statement in an advanced event selector.

                • Field (string) --

                  A field in an event record on which to filter events to be logged. Supported fields include readOnly , eventCategory , eventSource (for management events), eventName , resources.type , and resources.ARN .

                  • **readOnly ** - Optional. Can be set to Equals a value of true or false . If you do not add this field, CloudTrail logs both both read and write events. A value of true logs only read events. A value of false logs only write events.
                  • **eventSource ** - For filtering management events only. This can be set only to NotEquals kms.amazonaws.com .
                  • **eventName ** - Can use any operator. You can use it to filter in or filter out any data event logged to CloudTrail, such as PutBucket or GetSnapshotBlock . You can have multiple values for this field, separated by commas.
                  • **eventCategory ** - This is required. It must be set to Equals , and the value must be Management or Data .
                  • **resources.type ** - This field is required. resources.type can only use the Equals operator, and the value can be one of the following:
                    • AWS::S3::Object
                    • AWS::Lambda::Function
                    • AWS::DynamoDB::Table
                    • AWS::S3Outposts::Object
                    • AWS::ManagedBlockchain::Node
                    • AWS::S3ObjectLambda::AccessPoint
                    • AWS::EC2::Snapshot
                    • AWS::S3::AccessPoint
                    • AWS::DynamoDB::Stream
                    • AWS::Glue::Table

                  You can have only one resources.type field per selector. To log data events on more than one resource type, add another selector.

                  • **resources.ARN ** - You can use any operator with resources.ARN , but if you use Equals or NotEquals , the value must exactly match the ARN of a valid resource of the type you've specified in the template as the value of resources.type. For example, if resources.type equals AWS::S3::Object , the ARN must be in one of the following formats. To log all data events for all objects in a specific S3 bucket, use the StartsWith operator, and include only the bucket ARN as the matching value. The trailing slash is intentional; do not exclude it. Replace the text between less than and greater than symbols (<>) with resource-specific information.
                    • arn:<partition>:s3:::<bucket_name>/
                    • arn:<partition>:s3:::<bucket_name>/<object_path>/

                  When resources.type equals AWS::S3::AccessPoint , and the operator is set to Equals or NotEquals , the ARN must be in one of the following formats. To log events on all objects in an S3 access point, we recommend that you use only the access point ARN, don’t include the object path, and use the StartsWith or NotStartsWith operators.

                  • arn:<partition>:s3:<region>:<account_ID>:accesspoint/<access_point_name>
                  • arn:<partition>:s3:<region>:<account_ID>:accesspoint/<access_point_name>/object/<object_path>

                  When resources.type equals AWS::Lambda::Function , and the operator is set to Equals or NotEquals , the ARN must be in the following format:

                  • arn:<partition>:lambda:<region>:<account_ID>:function:<function_name>

                  When resources.type equals AWS::DynamoDB::Table , and the operator is set to Equals or NotEquals , the ARN must be in the following format:

                  • arn:<partition>:dynamodb:<region>:<account_ID>:table/<table_name>

                  When resources.type equals AWS::S3Outposts::Object , and the operator is set to Equals or NotEquals , the ARN must be in the following format:

                  • arn:<partition>:s3-outposts:<region>:<account_ID>:<object_path>

                  When resources.type equals AWS::ManagedBlockchain::Node , and the operator is set to Equals or NotEquals , the ARN must be in the following format:

                  • arn:<partition>:managedblockchain:<region>:<account_ID>:nodes/<node_ID>

                  When resources.type equals AWS::S3ObjectLambda::AccessPoint , and the operator is set to Equals or NotEquals , the ARN must be in the following format:

                  • arn:<partition>:s3-object-lambda:<region>:<account_ID>:accesspoint/<access_point_name>

                  When resources.type equals AWS::EC2::Snapshot , and the operator is set to Equals or NotEquals , the ARN must be in the following format:

                  • arn:<partition>:ec2:<region>::snapshot/<snapshot_ID>

                  When resources.type equals AWS::DynamoDB::Stream , and the operator is set to Equals or NotEquals , the ARN must be in the following format:

                  • arn:<partition>:dynamodb:<region>:<account_ID>:table/<table_name>/stream/<date_time>

                  When resources.type equals AWS::Glue::Table , and the operator is set to Equals or NotEquals , the ARN must be in the following format:

                  • arn:<partition>:glue:<region>:<account_ID>:table/<database_name>/<table_name>
                • Equals (list) --

                  An operator that includes events that match the exact value of the event record field specified as the value of Field . This is the only valid operator that you can use with the readOnly , eventCategory , and resources.type fields.

                  • (string) --
                • StartsWith (list) --

                  An operator that includes events that match the first few characters of the event record field specified as the value of Field .

                  • (string) --
                • EndsWith (list) --

                  An operator that includes events that match the last few characters of the event record field specified as the value of Field .

                  • (string) --
                • NotEquals (list) --

                  An operator that excludes events that match the exact value of the event record field specified as the value of Field .

                  • (string) --
                • NotStartsWith (list) --

                  An operator that excludes events that match the first few characters of the event record field specified as the value of Field .

                  • (string) --
                • NotEndsWith (list) --

                  An operator that excludes events that match the last few characters of the event record field specified as the value of Field .

                  • (string) --
        • MultiRegionEnabled (boolean) --

          This field is being deprecated. Indicates whether the event data store includes events from all regions, or only from the region in which it was created.

        • OrganizationEnabled (boolean) --

          This field is being deprecated. Indicates that an event data store is collecting logged events for an organization.

        • RetentionPeriod (integer) --

          This field is being deprecated. The retention period, in days.

        • CreatedTimestamp (datetime) --

          This field is being deprecated. The timestamp of the event data store's creation.

        • UpdatedTimestamp (datetime) --

          This field is being deprecated. The timestamp showing when an event data store was updated, if applicable. UpdatedTimestamp is always either the same or newer than the time shown in CreatedTimestamp .

    • NextToken (string) --

      A token you can use to get the next page of results.

Exceptions

list_public_keys(**kwargs)

Returns all public keys whose private keys were used to sign the digest files within the specified time range. The public key is needed to validate digest files that were signed with its corresponding private key.

Note

CloudTrail uses different private and public key pairs per region. Each digest file is signed with a private key unique to its region. When you validate a digest file from a specific region, you must look in the same region for its corresponding public key.

See also: AWS API Documentation

Request Syntax

response = client.list_public_keys(
    StartTime=datetime(2015, 1, 1),
    EndTime=datetime(2015, 1, 1),
    NextToken='string'
)
Parameters
  • StartTime (datetime) -- Optionally specifies, in UTC, the start of the time range to look up public keys for CloudTrail digest files. If not specified, the current time is used, and the current public key is returned.
  • EndTime (datetime) -- Optionally specifies, in UTC, the end of the time range to look up public keys for CloudTrail digest files. If not specified, the current time is used.
  • NextToken (string) -- Reserved for future use.
Return type

dict

Returns

Response Syntax

{
    'PublicKeyList': [
        {
            'Value': b'bytes',
            'ValidityStartTime': datetime(2015, 1, 1),
            'ValidityEndTime': datetime(2015, 1, 1),
            'Fingerprint': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

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

    • PublicKeyList (list) --

      Contains an array of PublicKey objects.

      Note

      The returned public keys may have validity time ranges that overlap.

      • (dict) --

        Contains information about a returned public key.

        • Value (bytes) --

          The DER encoded public key value in PKCS#1 format.

        • ValidityStartTime (datetime) --

          The starting time of validity of the public key.

        • ValidityEndTime (datetime) --

          The ending time of validity of the public key.

        • Fingerprint (string) --

          The fingerprint of the public key.

    • NextToken (string) --

      Reserved for future use.

Exceptions

list_queries(**kwargs)

Returns a list of queries and query statuses for the past seven days. You must specify an ARN value for EventDataStore . Optionally, to shorten the list of results, you can specify a time range, formatted as timestamps, by adding StartTime and EndTime parameters, and a QueryStatus value. Valid values for QueryStatus include QUEUED , RUNNING , FINISHED , FAILED , TIMED_OUT , or CANCELLED .

See also: AWS API Documentation

Request Syntax

response = client.list_queries(
    EventDataStore='string',
    NextToken='string',
    MaxResults=123,
    StartTime=datetime(2015, 1, 1),
    EndTime=datetime(2015, 1, 1),
    QueryStatus='QUEUED'|'RUNNING'|'FINISHED'|'FAILED'|'CANCELLED'|'TIMED_OUT'
)
Parameters
  • EventDataStore (string) --

    [REQUIRED]

    The ARN (or the ID suffix of the ARN) of an event data store on which queries were run.

  • NextToken (string) -- A token you can use to get the next page of results.
  • MaxResults (integer) -- The maximum number of queries to show on a page.
  • StartTime (datetime) -- Use with EndTime to bound a ListQueries request, and limit its results to only those queries run within a specified time period.
  • EndTime (datetime) -- Use with StartTime to bound a ListQueries request, and limit its results to only those queries run within a specified time period.
  • QueryStatus (string) -- The status of queries that you want to return in results. Valid values for QueryStatus include QUEUED , RUNNING , FINISHED , FAILED , TIMED_OUT , or CANCELLED .
Return type

dict

Returns

Response Syntax

{
    'Queries': [
        {
            'QueryId': 'string',
            'QueryStatus': 'QUEUED'|'RUNNING'|'FINISHED'|'FAILED'|'CANCELLED'|'TIMED_OUT',
            'CreationTime': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • Queries (list) --

      Lists matching query results, and shows query ID, status, and creation time of each query.

      • (dict) --

        A SQL string of criteria about events that you want to collect in an event data store.

        • QueryId (string) --

          The ID of a query.

        • QueryStatus (string) --

          The status of the query. This can be QUEUED , RUNNING , FINISHED , FAILED , TIMED_OUT , or CANCELLED .

        • CreationTime (datetime) --

          The creation time of a query.

    • NextToken (string) --

      A token you can use to get the next page of results.

Exceptions

list_tags(**kwargs)

Lists the tags for the trail or event data store in the current region.

See also: AWS API Documentation

Request Syntax

response = client.list_tags(
    ResourceIdList=[
        'string',
    ],
    NextToken='string'
)
Parameters
  • ResourceIdList (list) --

    [REQUIRED]

    Specifies a list of trail and event data store ARNs whose tags will be listed. The list has a limit of 20 ARNs.

    • (string) --
  • NextToken (string) -- Reserved for future use.
Return type

dict

Returns

Response Syntax

{
    'ResourceTagList': [
        {
            'ResourceId': 'string',
            'TagsList': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ]
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

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

    • ResourceTagList (list) --

      A list of resource tags.

      • (dict) --

        A resource tag.

        • ResourceId (string) --

          Specifies the ARN of the resource.

        • TagsList (list) --

          A list of tags.

          • (dict) --

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

            • Key (string) --

              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.

    • NextToken (string) --

      Reserved for future use.

Exceptions

list_trails(**kwargs)

Lists trails that are in the current account.

See also: AWS API Documentation

Request Syntax

response = client.list_trails(
    NextToken='string'
)
Parameters
NextToken (string) -- The token to use to get the next page of results after a previous API call. This token must be passed in with the same parameters that were specified in the the original call. For example, if the original call specified an AttributeKey of 'Username' with a value of 'root', the call with NextToken should include those same parameters.
Return type
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 Amazon Web Services Region in which a trail was created.

    • NextToken (string) --

      The token to use to get the next page of results after a previous API call. If the token does not appear, there are no more results to return. The token must be passed in with the same parameters as the previous call. For example, if the original call specified an AttributeKey of 'Username' with a value of 'root', the call with NextToken should include those same parameters.

Exceptions

lookup_events(**kwargs)

Looks up management events or CloudTrail Insights events that are captured by CloudTrail. You can look up events that occurred in a region within the last 90 days. Lookup supports the following attributes for management events:

  • Amazon Web Services access key
  • Event ID
  • Event name
  • Event source
  • Read only
  • Resource name
  • Resource type
  • User name

Lookup supports the following attributes for Insights events:

  • Event ID
  • Event name
  • Event source

All attributes are optional. The default number of results returned is 50, with a maximum of 50 possible. The response includes a token that you can use to get the next page of results.

Warning

The rate of lookup requests is limited to two per second, per account, per region. If this limit is exceeded, a throttling error occurs.

See also: AWS API Documentation

Request Syntax

response = client.lookup_events(
    LookupAttributes=[
        {
            'AttributeKey': 'EventId'|'EventName'|'ReadOnly'|'Username'|'ResourceType'|'ResourceName'|'EventSource'|'AccessKeyId',
            'AttributeValue': 'string'
        },
    ],
    StartTime=datetime(2015, 1, 1),
    EndTime=datetime(2015, 1, 1),
    EventCategory='insight',
    MaxResults=123,
    NextToken='string'
)
Parameters
  • LookupAttributes (list) --

    Contains a list of lookup attributes. Currently the list can contain only one item.

    • (dict) --

      Specifies an attribute and value that filter the events returned.

      • AttributeKey (string) -- [REQUIRED]

        Specifies an attribute on which to filter the events returned.

      • AttributeValue (string) -- [REQUIRED]

        Specifies a value for the specified AttributeKey.

  • StartTime (datetime) -- Specifies that only events that occur after or at the specified time are returned. If the specified start time is after the specified end time, an error is returned.
  • EndTime (datetime) -- Specifies that only events that occur before or at the specified time are returned. If the specified end time is before the specified start time, an error is returned.
  • EventCategory (string) -- Specifies the event category. If you do not specify an event category, events of the category are not returned in the response. For example, if you do not specify insight as the value of EventCategory , no Insights events are returned.
  • MaxResults (integer) -- The number of events to return. Possible values are 1 through 50. The default is 50.
  • NextToken (string) -- The token to use to get the next page of results after a previous API call. This token must be passed in with the same parameters that were specified in the the original call. For example, if the original call specified an AttributeKey of 'Username' with a value of 'root', the call with NextToken should include those same parameters.
Return type

dict

Returns

Response Syntax

{
    'Events': [
        {
            'EventId': 'string',
            'EventName': 'string',
            'ReadOnly': 'string',
            'AccessKeyId': 'string',
            'EventTime': datetime(2015, 1, 1),
            'EventSource': 'string',
            'Username': 'string',
            'Resources': [
                {
                    'ResourceType': 'string',
                    'ResourceName': 'string'
                },
            ],
            'CloudTrailEvent': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    Contains a response to a LookupEvents action.

    • Events (list) --

      A list of events returned based on the lookup attributes specified and the CloudTrail event. The events list is sorted by time. The most recent event is listed first.

      • (dict) --

        Contains information about an event that was returned by a lookup request. The result includes a representation of a CloudTrail event.

        • EventId (string) --

          The CloudTrail ID of the event returned.

        • EventName (string) --

          The name of the event returned.

        • ReadOnly (string) --

          Information about whether the event is a write event or a read event.

        • AccessKeyId (string) --

          The Amazon Web Services access key ID that was used to sign the request. If the request was made with temporary security credentials, this is the access key ID of the temporary credentials.

        • EventTime (datetime) --

          The date and time of the event returned.

        • EventSource (string) --

          The Amazon Web Services service to which the request was made.

        • Username (string) --

          A user name or role name of the requester that called the API in the event returned.

        • Resources (list) --

          A list of resources referenced by the event returned.

          • (dict) --

            Specifies the type and name of a resource referenced by an event.

            • ResourceType (string) --

              The type of a resource referenced by the event returned. When the resource type cannot be determined, null is returned. Some examples of resource types are: Instance for EC2, Trail for CloudTrail, DBInstance for Amazon RDS, and AccessKey for IAM. To learn more about how to look up and filter events by the resource types supported for a service, see Filtering CloudTrail Events .

            • ResourceName (string) --

              The name of the resource referenced by the event returned. These are user-created names whose values will depend on the environment. For example, the resource name might be "auto-scaling-test-group" for an Auto Scaling Group or "i-1234567" for an EC2 Instance.

        • CloudTrailEvent (string) --

          A JSON string that contains a representation of the event returned.

    • NextToken (string) --

      The token to use to get the next page of results after a previous API call. If the token does not appear, there are no more results to return. The token must be passed in with the same parameters as the previous call. For example, if the original call specified an AttributeKey of 'Username' with a value of 'root', the call with NextToken should include those same parameters.

Exceptions

put_event_selectors(**kwargs)

Configures an event selector or advanced event selectors for your trail. Use event selectors or advanced event selectors to specify management and data event settings for your trail. By default, trails created without specific event selectors are configured to log all read and write management events, and no data events.

When an event occurs in your account, CloudTrail evaluates the event selectors or advanced event selectors in all trails. For each trail, if the event matches any event selector, the trail processes and logs the event. If the event doesn't match any event selector, the trail doesn't log the event.

Example

  • You create an event selector for a trail and specify that you want write-only events.
  • The EC2 GetConsoleOutput and RunInstances API operations occur in your account.
  • CloudTrail evaluates whether the events match your event selectors.
  • The RunInstances is a write-only event and it matches your event selector. The trail logs the event.
  • The GetConsoleOutput is a read-only event that doesn't match your event selector. The trail doesn't log the event.

The PutEventSelectors operation must be called from the region in which the trail was created; otherwise, an InvalidHomeRegionException exception is thrown.

You can configure up to five event selectors for each trail. For more information, see Logging data and management events for trails and Quotas in CloudTrail in the CloudTrail User Guide .

You can add advanced event selectors, and conditions for your advanced event selectors, up to a maximum of 500 values for all conditions and selectors on a trail. You can use either AdvancedEventSelectors or EventSelectors , but not both. If you apply AdvancedEventSelectors to a trail, any existing EventSelectors are overwritten. For more information about advanced event selectors, see Logging data events for trails in the CloudTrail User Guide .

See also: AWS API Documentation

Request Syntax

response = client.put_event_selectors(
    TrailName='string',
    EventSelectors=[
        {
            'ReadWriteType': 'ReadOnly'|'WriteOnly'|'All',
            'IncludeManagementEvents': True|False,
            'DataResources': [
                {
                    'Type': 'string',
                    'Values': [
                        'string',
                    ]
                },
            ],
            'ExcludeManagementEventSources': [
                'string',
            ]
        },
    ],
    AdvancedEventSelectors=[
        {
            'Name': 'string',
            'FieldSelectors': [
                {
                    'Field': 'string',
                    'Equals': [
                        'string',
                    ],
                    'StartsWith': [
                        'string',
                    ],
                    'EndsWith': [
                        'string',
                    ],
                    'NotEquals': [
                        'string',
                    ],
                    'NotStartsWith': [
                        'string',
                    ],
                    'NotEndsWith': [
                        'string',
                    ]
                },
            ]
        },
    ]
)
Parameters
  • TrailName (string) --

    [REQUIRED]

    Specifies the name of the trail or trail ARN. If you specify a trail name, the string 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 not valid.
    • Not be in IP address format (for example, 192.168.5.4)

    If you specify a trail ARN, it must be in the following format.

    arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail
  • EventSelectors (list) --

    Specifies the settings for your event selectors. You can configure up to five event selectors for a trail. You can use either EventSelectors or AdvancedEventSelectors in a PutEventSelectors request, but not both. If you apply EventSelectors to a trail, any existing AdvancedEventSelectors are overwritten.

    • (dict) --

      Use event selectors to further specify the management and data event settings for your trail. By default, trails created without specific event selectors will be configured to log all read and write management events, and no data events. When an event occurs in your account, CloudTrail evaluates the event selector for all trails. For each trail, if the event matches any event selector, the trail processes and logs the event. If the event doesn't match any event selector, the trail doesn't log the event.

      You can configure up to five event selectors for a trail.

      You cannot apply both event selectors and advanced event selectors to a trail.

      • ReadWriteType (string) --

        Specify if you want your trail to log read-only events, write-only events, or all. For example, the EC2 GetConsoleOutput is a read-only API operation and RunInstances is a write-only API operation.

        By default, the value is All .

      • IncludeManagementEvents (boolean) --

        Specify if you want your event selector to include management events for your trail.

        For more information, see Management Events in the CloudTrail User Guide .

        By default, the value is true .

        The first copy of management events is free. You are charged for additional copies of management events that you are logging on any subsequent trail in the same region. For more information about CloudTrail pricing, see CloudTrail Pricing .

      • DataResources (list) --

        CloudTrail supports data event logging for Amazon S3 objects, Lambda functions, and Amazon DynamoDB tables with basic event selectors. You can specify up to 250 resources for an individual event selector, but the total number of data resources cannot exceed 250 across all event selectors in a trail. This limit does not apply if you configure resource logging for all data events.

        For more information, see Data Events and Limits in CloudTrail in the CloudTrail User Guide .

        • (dict) --

          The Amazon S3 buckets, Lambda functions, or Amazon DynamoDB tables that you specify in your event selectors for your trail to log data events. Data events provide information about the resource operations performed on or within a resource itself. These are also known as data plane operations. You can specify up to 250 data resources for a trail.

          Note

          The total number of allowed data resources is 250. This number can be distributed between 1 and 5 event selectors, but the total cannot exceed 250 across all selectors.

          If you are using advanced event selectors, the maximum total number of values for all conditions, across all advanced event selectors for the trail, is 500.

          The following example demonstrates how logging works when you configure logging of all data events for an S3 bucket named bucket-1 . In this example, the CloudTrail user specified an empty prefix, and the option to log both Read and Write data events.

          • A user uploads an image file to bucket-1 .
          • The PutObject API operation is an Amazon S3 object-level API. It is recorded as a data event in CloudTrail. Because the CloudTrail user specified an S3 bucket with an empty prefix, events that occur on any object in that bucket are logged. The trail processes and logs the event.
          • A user uploads an object to an Amazon S3 bucket named arn:aws:s3:::bucket-2 .
          • The PutObject API operation occurred for an object in an S3 bucket that the CloudTrail user didn't specify for the trail. The trail doesn’t log the event.

          The following example demonstrates how logging works when you configure logging of Lambda data events for a Lambda function named MyLambdaFunction , but not for all Lambda functions.

          • A user runs a script that includes a call to the MyLambdaFunction function and the MyOtherLambdaFunction function.
          • The Invoke API operation on MyLambdaFunction is an Lambda API. It is recorded as a data event in CloudTrail. Because the CloudTrail user specified logging data events for MyLambdaFunction , any invocations of that function are logged. The trail processes and logs the event.
          • The Invoke API operation on MyOtherLambdaFunction is an Lambda API. Because the CloudTrail user did not specify logging data events for all Lambda functions, the Invoke operation for MyOtherLambdaFunction does not match the function specified for the trail. The trail doesn’t log the event.
          • Type (string) --

            The resource type in which you want to log data events. You can specify the following basic event selector resource types:

            • AWS::S3::Object
            • AWS::Lambda::Function
            • AWS::DynamoDB::Table

            The following resource types are also availble through advanced event selectors. Basic event selector resource types are valid in advanced event selectors, but advanced event selector resource types are not valid in basic event selectors. For more information, see AdvancedFieldSelector$Field .

            • AWS::S3Outposts::Object
            • AWS::ManagedBlockchain::Node
            • AWS::S3ObjectLambda::AccessPoint
            • AWS::EC2::Snapshot
            • AWS::S3::AccessPoint
            • AWS::DynamoDB::Stream
            • AWS::Glue::Table
          • Values (list) --

            An array of Amazon Resource Name (ARN) strings or partial ARN strings for the specified objects.

            • To log data events for all objects in all S3 buckets in your Amazon Web Services account, specify the prefix as arn:aws:s3::: .

            Note

            This also enables logging of data event activity performed by any user or role in your Amazon Web Services account, even if that activity is performed on a bucket that belongs to another Amazon Web Services account.

            • To log data events for all objects in an S3 bucket, specify the bucket and an empty object prefix such as arn:aws:s3:::bucket-1/ . The trail logs data events for all objects in this S3 bucket.
            • To log data events for specific objects, specify the S3 bucket and object prefix such as arn:aws:s3:::bucket-1/example-images . The trail logs data events for objects in this S3 bucket that match the prefix.
            • To log data events for all Lambda functions in your Amazon Web Services account, specify the prefix as arn:aws:lambda .

            Note

            This also enables logging of Invoke activity performed by any user or role in your Amazon Web Services account, even if that activity is performed on a function that belongs to another Amazon Web Services account.

            • To log data events for a specific Lambda function, specify the function ARN.

            Note

            Lambda function ARNs are exact. For example, if you specify a function ARN arn:aws:lambda:us-west-2:111111111111:function:helloworld , data events will only be logged for arn:aws:lambda:us-west-2:111111111111:function:helloworld . They will not be logged for arn:aws:lambda:us-west-2:111111111111:function:helloworld2 .

            • To log data events for all DynamoDB tables in your Amazon Web Services account, specify the prefix as arn:aws:dynamodb .
            • (string) --
      • ExcludeManagementEventSources (list) --

        An optional list of service event sources from which you do not want management events to be logged on your trail. In this release, the list can be empty (disables the filter), or it can filter out Key Management Service or Amazon RDS Data API events by containing kms.amazonaws.com or rdsdata.amazonaws.com . By default, ExcludeManagementEventSources is empty, and KMS and Amazon RDS Data API events are logged to your trail. You can exclude management event sources only in regions that support the event source.

        • (string) --
  • AdvancedEventSelectors (list) --

    Specifies the settings for advanced event selectors. You can add advanced event selectors, and conditions for your advanced event selectors, up to a maximum of 500 values for all conditions and selectors on a trail. You can use either AdvancedEventSelectors or EventSelectors , but not both. If you apply AdvancedEventSelectors to a trail, any existing EventSelectors are overwritten. For more information about advanced event selectors, see Logging data events for trails in the CloudTrail User Guide .

    • (dict) --

      Advanced event selectors let you create fine-grained selectors for the following CloudTrail event record fields. They help you control costs by logging only those events that are important to you. For more information about advanced event selectors, see Logging data events for trails in the CloudTrail User Guide .

      • readOnly
      • eventSource
      • eventName
      • eventCategory
      • resources.type
      • resources.ARN

      You cannot apply both event selectors and advanced event selectors to a trail.

      • Name (string) --

        An optional, descriptive name for an advanced event selector, such as "Log data events for only two S3 buckets".

      • FieldSelectors (list) -- [REQUIRED]

        Contains all selector statements in an advanced event selector.

        • (dict) --

          A single selector statement in an advanced event selector.

          • Field (string) -- [REQUIRED]

            A field in an event record on which to filter events to be logged. Supported fields include readOnly , eventCategory , eventSource (for management events), eventName , resources.type , and resources.ARN .

            • **readOnly ** - Optional. Can be set to Equals a value of true or false . If you do not add this field, CloudTrail logs both both read and write events. A value of true logs only read events. A value of false logs only write events.
            • **eventSource ** - For filtering management events only. This can be set only to NotEquals kms.amazonaws.com .
            • **eventName ** - Can use any operator. You can use it to filter in or filter out any data event logged to CloudTrail, such as PutBucket or GetSnapshotBlock . You can have multiple values for this field, separated by commas.
            • **eventCategory ** - This is required. It must be set to Equals , and the value must be Management or Data .
            • **resources.type ** - This field is required. resources.type can only use the Equals operator, and the value can be one of the following:
              • AWS::S3::Object
              • AWS::Lambda::Function
              • AWS::DynamoDB::Table
              • AWS::S3Outposts::Object
              • AWS::ManagedBlockchain::Node
              • AWS::S3ObjectLambda::AccessPoint
              • AWS::EC2::Snapshot
              • AWS::S3::AccessPoint
              • AWS::DynamoDB::Stream
              • AWS::Glue::Table

            You can have only one resources.type field per selector. To log data events on more than one resource type, add another selector.

            • **resources.ARN ** - You can use any operator with resources.ARN , but if you use Equals or NotEquals , the value must exactly match the ARN of a valid resource of the type you've specified in the template as the value of resources.type. For example, if resources.type equals AWS::S3::Object , the ARN must be in one of the following formats. To log all data events for all objects in a specific S3 bucket, use the StartsWith operator, and include only the bucket ARN as the matching value. The trailing slash is intentional; do not exclude it. Replace the text between less than and greater than symbols (<>) with resource-specific information.
              • arn:<partition>:s3:::<bucket_name>/
              • arn:<partition>:s3:::<bucket_name>/<object_path>/

            When resources.type equals AWS::S3::AccessPoint , and the operator is set to Equals or NotEquals , the ARN must be in one of the following formats. To log events on all objects in an S3 access point, we recommend that you use only the access point ARN, don’t include the object path, and use the StartsWith or NotStartsWith operators.

            • arn:<partition>:s3:<region>:<account_ID>:accesspoint/<access_point_name>
            • arn:<partition>:s3:<region>:<account_ID>:accesspoint/<access_point_name>/object/<object_path>

            When resources.type equals AWS::Lambda::Function , and the operator is set to Equals or NotEquals , the ARN must be in the following format:

            • arn:<partition>:lambda:<region>:<account_ID>:function:<function_name>

            When resources.type equals AWS::DynamoDB::Table , and the operator is set to Equals or NotEquals , the ARN must be in the following format:

            • arn:<partition>:dynamodb:<region>:<account_ID>:table/<table_name>

            When resources.type equals AWS::S3Outposts::Object , and the operator is set to Equals or NotEquals , the ARN must be in the following format:

            • arn:<partition>:s3-outposts:<region>:<account_ID>:<object_path>

            When resources.type equals AWS::ManagedBlockchain::Node , and the operator is set to Equals or NotEquals , the ARN must be in the following format:

            • arn:<partition>:managedblockchain:<region>:<account_ID>:nodes/<node_ID>

            When resources.type equals AWS::S3ObjectLambda::AccessPoint , and the operator is set to Equals or NotEquals , the ARN must be in the following format:

            • arn:<partition>:s3-object-lambda:<region>:<account_ID>:accesspoint/<access_point_name>

            When resources.type equals AWS::EC2::Snapshot , and the operator is set to Equals or NotEquals , the ARN must be in the following format:

            • arn:<partition>:ec2:<region>::snapshot/<snapshot_ID>

            When resources.type equals AWS::DynamoDB::Stream , and the operator is set to Equals or NotEquals , the ARN must be in the following format:

            • arn:<partition>:dynamodb:<region>:<account_ID>:table/<table_name>/stream/<date_time>

            When resources.type equals AWS::Glue::Table , and the operator is set to Equals or NotEquals , the ARN must be in the following format:

            • arn:<partition>:glue:<region>:<account_ID>:table/<database_name>/<table_name>
          • Equals (list) --

            An operator that includes events that match the exact value of the event record field specified as the value of Field . This is the only valid operator that you can use with the readOnly , eventCategory , and resources.type fields.

            • (string) --
          • StartsWith (list) --

            An operator that includes events that match the first few characters of the event record field specified as the value of Field .

            • (string) --
          • EndsWith (list) --

            An operator that includes events that match the last few characters of the event record field specified as the value of Field .

            • (string) --
          • NotEquals (list) --

            An operator that excludes events that match the exact value of the event record field specified as the value of Field .

            • (string) --
          • NotStartsWith (list) --

            An operator that excludes events that match the first few characters of the event record field specified as the value of Field .

            • (string) --
          • NotEndsWith (list) --

            An operator that excludes events that match the last few characters of the event record field specified as the value of Field .

            • (string) --
Return type

dict

Returns

Response Syntax

{
    'TrailARN': 'string',
    'EventSelectors': [
        {
            'ReadWriteType': 'ReadOnly'|'WriteOnly'|'All',
            'IncludeManagementEvents': True|False,
            'DataResources': [
                {
                    'Type': 'string',
                    'Values': [
                        'string',
                    ]
                },
            ],
            'ExcludeManagementEventSources': [
                'string',
            ]
        },
    ],
    'AdvancedEventSelectors': [
        {
            'Name': 'string',
            'FieldSelectors': [
                {
                    'Field': 'string',
                    'Equals': [
                        'string',
                    ],
                    'StartsWith': [
                        'string',
                    ],
                    'EndsWith': [
                        'string',
                    ],
                    'NotEquals': [
                        'string',
                    ],
                    'NotStartsWith': [
                        'string',
                    ],
                    'NotEndsWith': [
                        'string',
                    ]
                },
            ]
        },
    ]
}

Response Structure

  • (dict) --

    • TrailARN (string) --

      Specifies the ARN of the trail that was updated with event selectors. The following is the format of a trail ARN.

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

    • EventSelectors (list) --

      Specifies the event selectors configured for your trail.

      • (dict) --

        Use event selectors to further specify the management and data event settings for your trail. By default, trails created without specific event selectors will be configured to log all read and write management events, and no data events. When an event occurs in your account, CloudTrail evaluates the event selector for all trails. For each trail, if the event matches any event selector, the trail processes and logs the event. If the event doesn't match any event selector, the trail doesn't log the event.

        You can configure up to five event selectors for a trail.

        You cannot apply both event selectors and advanced event selectors to a trail.

        • ReadWriteType (string) --

          Specify if you want your trail to log read-only events, write-only events, or all. For example, the EC2 GetConsoleOutput is a read-only API operation and RunInstances is a write-only API operation.

          By default, the value is All .

        • IncludeManagementEvents (boolean) --

          Specify if you want your event selector to include management events for your trail.

          For more information, see Management Events in the CloudTrail User Guide .

          By default, the value is true .

          The first copy of management events is free. You are charged for additional copies of management events that you are logging on any subsequent trail in the same region. For more information about CloudTrail pricing, see CloudTrail Pricing .

        • DataResources (list) --

          CloudTrail supports data event logging for Amazon S3 objects, Lambda functions, and Amazon DynamoDB tables with basic event selectors. You can specify up to 250 resources for an individual event selector, but the total number of data resources cannot exceed 250 across all event selectors in a trail. This limit does not apply if you configure resource logging for all data events.

          For more information, see Data Events and Limits in CloudTrail in the CloudTrail User Guide .

          • (dict) --

            The Amazon S3 buckets, Lambda functions, or Amazon DynamoDB tables that you specify in your event selectors for your trail to log data events. Data events provide information about the resource operations performed on or within a resource itself. These are also known as data plane operations. You can specify up to 250 data resources for a trail.

            Note

            The total number of allowed data resources is 250. This number can be distributed between 1 and 5 event selectors, but the total cannot exceed 250 across all selectors.

            If you are using advanced event selectors, the maximum total number of values for all conditions, across all advanced event selectors for the trail, is 500.

            The following example demonstrates how logging works when you configure logging of all data events for an S3 bucket named bucket-1 . In this example, the CloudTrail user specified an empty prefix, and the option to log both Read and Write data events.

            • A user uploads an image file to bucket-1 .
            • The PutObject API operation is an Amazon S3 object-level API. It is recorded as a data event in CloudTrail. Because the CloudTrail user specified an S3 bucket with an empty prefix, events that occur on any object in that bucket are logged. The trail processes and logs the event.
            • A user uploads an object to an Amazon S3 bucket named arn:aws:s3:::bucket-2 .
            • The PutObject API operation occurred for an object in an S3 bucket that the CloudTrail user didn't specify for the trail. The trail doesn’t log the event.

            The following example demonstrates how logging works when you configure logging of Lambda data events for a Lambda function named MyLambdaFunction , but not for all Lambda functions.

            • A user runs a script that includes a call to the MyLambdaFunction function and the MyOtherLambdaFunction function.
            • The Invoke API operation on MyLambdaFunction is an Lambda API. It is recorded as a data event in CloudTrail. Because the CloudTrail user specified logging data events for MyLambdaFunction , any invocations of that function are logged. The trail processes and logs the event.
            • The Invoke API operation on MyOtherLambdaFunction is an Lambda API. Because the CloudTrail user did not specify logging data events for all Lambda functions, the Invoke operation for MyOtherLambdaFunction does not match the function specified for the trail. The trail doesn’t log the event.
            • Type (string) --

              The resource type in which you want to log data events. You can specify the following basic event selector resource types:

              • AWS::S3::Object
              • AWS::Lambda::Function
              • AWS::DynamoDB::Table

              The following resource types are also availble through advanced event selectors. Basic event selector resource types are valid in advanced event selectors, but advanced event selector resource types are not valid in basic event selectors. For more information, see AdvancedFieldSelector$Field .

              • AWS::S3Outposts::Object
              • AWS::ManagedBlockchain::Node
              • AWS::S3ObjectLambda::AccessPoint
              • AWS::EC2::Snapshot
              • AWS::S3::AccessPoint
              • AWS::DynamoDB::Stream
              • AWS::Glue::Table
            • Values (list) --

              An array of Amazon Resource Name (ARN) strings or partial ARN strings for the specified objects.

              • To log data events for all objects in all S3 buckets in your Amazon Web Services account, specify the prefix as arn:aws:s3::: .

              Note

              This also enables logging of data event activity performed by any user or role in your Amazon Web Services account, even if that activity is performed on a bucket that belongs to another Amazon Web Services account.

              • To log data events for all objects in an S3 bucket, specify the bucket and an empty object prefix such as arn:aws:s3:::bucket-1/ . The trail logs data events for all objects in this S3 bucket.
              • To log data events for specific objects, specify the S3 bucket and object prefix such as arn:aws:s3:::bucket-1/example-images . The trail logs data events for objects in this S3 bucket that match the prefix.
              • To log data events for all Lambda functions in your Amazon Web Services account, specify the prefix as arn:aws:lambda .

              Note

              This also enables logging of Invoke activity performed by any user or role in your Amazon Web Services account, even if that activity is performed on a function that belongs to another Amazon Web Services account.

              • To log data events for a specific Lambda function, specify the function ARN.

              Note

              Lambda function ARNs are exact. For example, if you specify a function ARN arn:aws:lambda:us-west-2:111111111111:function:helloworld , data events will only be logged for arn:aws:lambda:us-west-2:111111111111:function:helloworld . They will not be logged for arn:aws:lambda:us-west-2:111111111111:function:helloworld2 .

              • To log data events for all DynamoDB tables in your Amazon Web Services account, specify the prefix as arn:aws:dynamodb .
              • (string) --
        • ExcludeManagementEventSources (list) --

          An optional list of service event sources from which you do not want management events to be logged on your trail. In this release, the list can be empty (disables the filter), or it can filter out Key Management Service or Amazon RDS Data API events by containing kms.amazonaws.com or rdsdata.amazonaws.com . By default, ExcludeManagementEventSources is empty, and KMS and Amazon RDS Data API events are logged to your trail. You can exclude management event sources only in regions that support the event source.

          • (string) --
    • AdvancedEventSelectors (list) --

      Specifies the advanced event selectors configured for your trail.

      • (dict) --

        Advanced event selectors let you create fine-grained selectors for the following CloudTrail event record fields. They help you control costs by logging only those events that are important to you. For more information about advanced event selectors, see Logging data events for trails in the CloudTrail User Guide .

        • readOnly
        • eventSource
        • eventName
        • eventCategory
        • resources.type
        • resources.ARN

        You cannot apply both event selectors and advanced event selectors to a trail.

        • Name (string) --

          An optional, descriptive name for an advanced event selector, such as "Log data events for only two S3 buckets".

        • FieldSelectors (list) --

          Contains all selector statements in an advanced event selector.

          • (dict) --

            A single selector statement in an advanced event selector.

            • Field (string) --

              A field in an event record on which to filter events to be logged. Supported fields include readOnly , eventCategory , eventSource (for management events), eventName , resources.type , and resources.ARN .

              • **readOnly ** - Optional. Can be set to Equals a value of true or false . If you do not add this field, CloudTrail logs both both read and write events. A value of true logs only read events. A value of false logs only write events.
              • **eventSource ** - For filtering management events only. This can be set only to NotEquals kms.amazonaws.com .
              • **eventName ** - Can use any operator. You can use it to filter in or filter out any data event logged to CloudTrail, such as PutBucket or GetSnapshotBlock . You can have multiple values for this field, separated by commas.
              • **eventCategory ** - This is required. It must be set to Equals , and the value must be Management or Data .
              • **resources.type ** - This field is required. resources.type can only use the Equals operator, and the value can be one of the following:
                • AWS::S3::Object
                • AWS::Lambda::Function
                • AWS::DynamoDB::Table
                • AWS::S3Outposts::Object
                • AWS::ManagedBlockchain::Node
                • AWS::S3ObjectLambda::AccessPoint
                • AWS::EC2::Snapshot
                • AWS::S3::AccessPoint
                • AWS::DynamoDB::Stream
                • AWS::Glue::Table

              You can have only one resources.type field per selector. To log data events on more than one resource type, add another selector.

              • **resources.ARN ** - You can use any operator with resources.ARN , but if you use Equals or NotEquals , the value must exactly match the ARN of a valid resource of the type you've specified in the template as the value of resources.type. For example, if resources.type equals AWS::S3::Object , the ARN must be in one of the following formats. To log all data events for all objects in a specific S3 bucket, use the StartsWith operator, and include only the bucket ARN as the matching value. The trailing slash is intentional; do not exclude it. Replace the text between less than and greater than symbols (<>) with resource-specific information.
                • arn:<partition>:s3:::<bucket_name>/
                • arn:<partition>:s3:::<bucket_name>/<object_path>/

              When resources.type equals AWS::S3::AccessPoint , and the operator is set to Equals or NotEquals , the ARN must be in one of the following formats. To log events on all objects in an S3 access point, we recommend that you use only the access point ARN, don’t include the object path, and use the StartsWith or NotStartsWith operators.

              • arn:<partition>:s3:<region>:<account_ID>:accesspoint/<access_point_name>
              • arn:<partition>:s3:<region>:<account_ID>:accesspoint/<access_point_name>/object/<object_path>

              When resources.type equals AWS::Lambda::Function , and the operator is set to Equals or NotEquals , the ARN must be in the following format:

              • arn:<partition>:lambda:<region>:<account_ID>:function:<function_name>

              When resources.type equals AWS::DynamoDB::Table , and the operator is set to Equals or NotEquals , the ARN must be in the following format:

              • arn:<partition>:dynamodb:<region>:<account_ID>:table/<table_name>

              When resources.type equals AWS::S3Outposts::Object , and the operator is set to Equals or NotEquals , the ARN must be in the following format:

              • arn:<partition>:s3-outposts:<region>:<account_ID>:<object_path>

              When resources.type equals AWS::ManagedBlockchain::Node , and the operator is set to Equals or NotEquals , the ARN must be in the following format:

              • arn:<partition>:managedblockchain:<region>:<account_ID>:nodes/<node_ID>

              When resources.type equals AWS::S3ObjectLambda::AccessPoint , and the operator is set to Equals or NotEquals , the ARN must be in the following format:

              • arn:<partition>:s3-object-lambda:<region>:<account_ID>:accesspoint/<access_point_name>

              When resources.type equals AWS::EC2::Snapshot , and the operator is set to Equals or NotEquals , the ARN must be in the following format:

              • arn:<partition>:ec2:<region>::snapshot/<snapshot_ID>

              When resources.type equals AWS::DynamoDB::Stream , and the operator is set to Equals or NotEquals , the ARN must be in the following format:

              • arn:<partition>:dynamodb:<region>:<account_ID>:table/<table_name>/stream/<date_time>

              When resources.type equals AWS::Glue::Table , and the operator is set to Equals or NotEquals , the ARN must be in the following format:

              • arn:<partition>:glue:<region>:<account_ID>:table/<database_name>/<table_name>
            • Equals (list) --

              An operator that includes events that match the exact value of the event record field specified as the value of Field . This is the only valid operator that you can use with the readOnly , eventCategory , and resources.type fields.

              • (string) --
            • StartsWith (list) --

              An operator that includes events that match the first few characters of the event record field specified as the value of Field .

              • (string) --
            • EndsWith (list) --

              An operator that includes events that match the last few characters of the event record field specified as the value of Field .

              • (string) --
            • NotEquals (list) --

              An operator that excludes events that match the exact value of the event record field specified as the value of Field .

              • (string) --
            • NotStartsWith (list) --

              An operator that excludes events that match the first few characters of the event record field specified as the value of Field .

              • (string) --
            • NotEndsWith (list) --

              An operator that excludes events that match the last few characters of the event record field specified as the value of Field .

              • (string) --

Exceptions

put_insight_selectors(**kwargs)

Lets you enable Insights event logging by specifying the Insights selectors that you want to enable on an existing trail. You also use PutInsightSelectors to turn off Insights event logging, by passing an empty list of insight types. The valid Insights event types in this release are ApiErrorRateInsight and ApiCallRateInsight .

See also: AWS API Documentation

Request Syntax

response = client.put_insight_selectors(
    TrailName='string',
    InsightSelectors=[
        {
            'InsightType': 'ApiCallRateInsight'|'ApiErrorRateInsight'
        },
    ]
)
Parameters
  • TrailName (string) --

    [REQUIRED]

    The name of the CloudTrail trail for which you want to change or add Insights selectors.

  • InsightSelectors (list) --

    [REQUIRED]

    A JSON string that contains the insight types you want to log on a trail. ApiCallRateInsight and ApiErrorRateInsight are valid insight types.

    • (dict) --

      A JSON string that contains a list of insight types that are logged on a trail.

      • InsightType (string) --

        The type of insights to log on a trail. ApiCallRateInsight and ApiErrorRateInsight are valid insight types.

Return type

dict

Returns

Response Syntax

{
    'TrailARN': 'string',
    'InsightSelectors': [
        {
            'InsightType': 'ApiCallRateInsight'|'ApiErrorRateInsight'
        },
    ]
}

Response Structure

  • (dict) --

    • TrailARN (string) --

      The Amazon Resource Name (ARN) of a trail for which you want to change or add Insights selectors.

    • InsightSelectors (list) --

      A JSON string that contains the Insights event types that you want to log on a trail. The valid Insights types in this release are ApiErrorRateInsight and ApiCallRateInsight .

      • (dict) --

        A JSON string that contains a list of insight types that are logged on a trail.

        • InsightType (string) --

          The type of insights to log on a trail. ApiCallRateInsight and ApiErrorRateInsight are valid insight types.

Exceptions

remove_tags(**kwargs)

Removes the specified tags from a trail or event data store.

See also: AWS API Documentation

Request Syntax

response = client.remove_tags(
    ResourceId='string',
    TagsList=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)
Parameters
  • ResourceId (string) --

    [REQUIRED]

    Specifies the ARN of the trail or event data store from which tags should be removed.

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

    Example event data store ARN format: arn:aws:cloudtrail:us-east-2:12345678910:eventdatastore/EXAMPLE-f852-4e8f-8bd1-bcf6cEXAMPLE

  • TagsList (list) --

    [REQUIRED]

    Specifies a list of tags to be removed.

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

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

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

Exceptions

restore_event_data_store(**kwargs)

Restores a deleted event data store specified by EventDataStore , which accepts an event data store ARN. You can only restore a deleted event data store within the seven-day wait period after deletion. Restoring an event data store can take several minutes, depending on the size of the event data store.

See also: AWS API Documentation

Request Syntax

response = client.restore_event_data_store(
    EventDataStore='string'
)
Parameters
EventDataStore (string) --

[REQUIRED]

The ARN (or the ID suffix of the ARN) of the event data store that you want to restore.

Return type
dict
Returns
Response Syntax
{
    'EventDataStoreArn': 'string',
    'Name': 'string',
    'Status': 'CREATED'|'ENABLED'|'PENDING_DELETION',
    'AdvancedEventSelectors': [
        {
            'Name': 'string',
            'FieldSelectors': [
                {
                    'Field': 'string',
                    'Equals': [
                        'string',
                    ],
                    'StartsWith': [
                        'string',
                    ],
                    'EndsWith': [
                        'string',
                    ],
                    'NotEquals': [
                        'string',
                    ],
                    'NotStartsWith': [
                        'string',
                    ],
                    'NotEndsWith': [
                        'string',
                    ]
                },
            ]
        },
    ],
    'MultiRegionEnabled': True|False,
    'OrganizationEnabled': True|False,
    'RetentionPeriod': 123,
    'TerminationProtectionEnabled': True|False,
    'CreatedTimestamp': datetime(2015, 1, 1),
    'UpdatedTimestamp': datetime(2015, 1, 1)
}

Response Structure

  • (dict) --
    • EventDataStoreArn (string) --

      The event data store ARN.

    • Name (string) --

      The name of the event data store.

    • Status (string) --

      The status of the event data store.

    • AdvancedEventSelectors (list) --

      The advanced event selectors that were used to select events.

      • (dict) --

        Advanced event selectors let you create fine-grained selectors for the following CloudTrail event record fields. They help you control costs by logging only those events that are important to you. For more information about advanced event selectors, see Logging data events for trails in the CloudTrail User Guide .

        • readOnly
        • eventSource
        • eventName
        • eventCategory
        • resources.type
        • resources.ARN

        You cannot apply both event selectors and advanced event selectors to a trail.

        • Name (string) --

          An optional, descriptive name for an advanced event selector, such as "Log data events for only two S3 buckets".

        • FieldSelectors (list) --

          Contains all selector statements in an advanced event selector.

          • (dict) --

            A single selector statement in an advanced event selector.

            • Field (string) --

              A field in an event record on which to filter events to be logged. Supported fields include readOnly , eventCategory , eventSource (for management events), eventName , resources.type , and resources.ARN .

              • **readOnly ** - Optional. Can be set to Equals a value of true or false . If you do not add this field, CloudTrail logs both both read and write events. A value of true logs only read events. A value of false logs only write events.
              • **eventSource ** - For filtering management events only. This can be set only to NotEquals kms.amazonaws.com .
              • **eventName ** - Can use any operator. You can use it to filter in or filter out any data event logged to CloudTrail, such as PutBucket or GetSnapshotBlock . You can have multiple values for this field, separated by commas.
              • **eventCategory ** - This is required. It must be set to Equals , and the value must be Management or Data .
              • **resources.type ** - This field is required. resources.type can only use the Equals operator, and the value can be one of the following:
                • AWS::S3::Object
                • AWS::Lambda::Function
                • AWS::DynamoDB::Table
                • AWS::S3Outposts::Object
                • AWS::ManagedBlockchain::Node
                • AWS::S3ObjectLambda::AccessPoint
                • AWS::EC2::Snapshot
                • AWS::S3::AccessPoint
                • AWS::DynamoDB::Stream
                • AWS::Glue::Table

              You can have only one resources.type field per selector. To log data events on more than one resource type, add another selector.

              • **resources.ARN ** - You can use any operator with resources.ARN , but if you use Equals or NotEquals , the value must exactly match the ARN of a valid resource of the type you've specified in the template as the value of resources.type. For example, if resources.type equals AWS::S3::Object , the ARN must be in one of the following formats. To log all data events for all objects in a specific S3 bucket, use the StartsWith operator, and include only the bucket ARN as the matching value. The trailing slash is intentional; do not exclude it. Replace the text between less than and greater than symbols (<>) with resource-specific information.
                • arn:<partition>:s3:::<bucket_name>/
                • arn:<partition>:s3:::<bucket_name>/<object_path>/

              When resources.type equals AWS::S3::AccessPoint , and the operator is set to Equals or NotEquals , the ARN must be in one of the following formats. To log events on all objects in an S3 access point, we recommend that you use only the access point ARN, don’t include the object path, and use the StartsWith or NotStartsWith operators.

              • arn:<partition>:s3:<region>:<account_ID>:accesspoint/<access_point_name>
              • arn:<partition>:s3:<region>:<account_ID>:accesspoint/<access_point_name>/object/<object_path>

              When resources.type equals AWS::Lambda::Function , and the operator is set to Equals or NotEquals , the ARN must be in the following format:

              • arn:<partition>:lambda:<region>:<account_ID>:function:<function_name>

              When resources.type equals AWS::DynamoDB::Table , and the operator is set to Equals or NotEquals , the ARN must be in the following format:

              • arn:<partition>:dynamodb:<region>:<account_ID>:table/<table_name>

              When resources.type equals AWS::S3Outposts::Object , and the operator is set to Equals or NotEquals , the ARN must be in the following format:

              • arn:<partition>:s3-outposts:<region>:<account_ID>:<object_path>

              When resources.type equals AWS::ManagedBlockchain::Node , and the operator is set to Equals or NotEquals , the ARN must be in the following format:

              • arn:<partition>:managedblockchain:<region>:<account_ID>:nodes/<node_ID>

              When resources.type equals AWS::S3ObjectLambda::AccessPoint , and the operator is set to Equals or NotEquals , the ARN must be in the following format:

              • arn:<partition>:s3-object-lambda:<region>:<account_ID>:accesspoint/<access_point_name>

              When resources.type equals AWS::EC2::Snapshot , and the operator is set to Equals or NotEquals , the ARN must be in the following format:

              • arn:<partition>:ec2:<region>::snapshot/<snapshot_ID>

              When resources.type equals AWS::DynamoDB::Stream , and the operator is set to Equals or NotEquals , the ARN must be in the following format:

              • arn:<partition>:dynamodb:<region>:<account_ID>:table/<table_name>/stream/<date_time>

              When resources.type equals AWS::Glue::Table , and the operator is set to Equals or NotEquals , the ARN must be in the following format:

              • arn:<partition>:glue:<region>:<account_ID>:table/<database_name>/<table_name>
            • Equals (list) --

              An operator that includes events that match the exact value of the event record field specified as the value of Field . This is the only valid operator that you can use with the readOnly , eventCategory , and resources.type fields.

              • (string) --
            • StartsWith (list) --

              An operator that includes events that match the first few characters of the event record field specified as the value of Field .

              • (string) --
            • EndsWith (list) --

              An operator that includes events that match the last few characters of the event record field specified as the value of Field .

              • (string) --
            • NotEquals (list) --

              An operator that excludes events that match the exact value of the event record field specified as the value of Field .

              • (string) --
            • NotStartsWith (list) --

              An operator that excludes events that match the first few characters of the event record field specified as the value of Field .

              • (string) --
            • NotEndsWith (list) --

              An operator that excludes events that match the last few characters of the event record field specified as the value of Field .

              • (string) --
    • MultiRegionEnabled (boolean) --

      Indicates whether the event data store is collecting events from all regions, or only from the region in which the event data store was created.

    • OrganizationEnabled (boolean) --

      Indicates whether an event data store is collecting logged events for an organization in Organizations.

    • RetentionPeriod (integer) --

      The retention period, in days.

    • TerminationProtectionEnabled (boolean) --

      Indicates that termination protection is enabled and the event data store cannot be automatically deleted.

    • CreatedTimestamp (datetime) --

      The timestamp of an event data store's creation.

    • UpdatedTimestamp (datetime) --

      The timestamp that shows when an event data store was updated, if applicable. UpdatedTimestamp is always either the same or newer than the time shown in CreatedTimestamp .

Exceptions

start_logging(**kwargs)

Starts the recording of Amazon Web Services API calls and log file delivery for a trail. For a trail that is enabled in all regions, this operation must be called from the region in which the trail was created. This operation cannot be called on the shadow trails (replicated trails in other regions) of a trail that is enabled in all regions.

See also: AWS API Documentation

Request Syntax

response = client.start_logging(
    Name='string'
)
Parameters
Name (string) --

[REQUIRED]

Specifies the name or the CloudTrail ARN of the trail for which CloudTrail logs Amazon Web Services API calls. The following is the format of a trail ARN.

arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail
Return type
dict
Returns
Response Syntax
{}

Response Structure

  • (dict) --

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

Exceptions

start_query(**kwargs)

Starts a CloudTrail Lake query. The required QueryStatement parameter provides your SQL query, enclosed in single quotation marks.

See also: AWS API Documentation

Request Syntax

response = client.start_query(
    QueryStatement='string'
)
Parameters
QueryStatement (string) --

[REQUIRED]

The SQL code of your query.

Return type
dict
Returns
Response Syntax
{
    'QueryId': 'string'
}

Response Structure

  • (dict) --
    • QueryId (string) --

      The ID of the started query.

Exceptions

stop_logging(**kwargs)

Suspends the recording of Amazon Web Services API calls and log file delivery for the specified trail. Under most circumstances, there is no need to use this action. You can update a trail without stopping it first. This action is the only way to stop recording. For a trail enabled in all regions, this operation must be called from the region in which the trail was created, or an InvalidHomeRegionException will occur. This operation cannot be called on the shadow trails (replicated trails in other regions) of a trail enabled in all regions.

See also: AWS API Documentation

Request Syntax

response = client.stop_logging(
    Name='string'
)
Parameters
Name (string) --

[REQUIRED]

Specifies the name or the CloudTrail ARN of the trail for which CloudTrail will stop logging Amazon Web Services API calls. The following is the format of a trail ARN.

arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail
Return type
dict
Returns
Response Syntax
{}

Response Structure

  • (dict) --

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

Exceptions

update_event_data_store(**kwargs)

Updates an event data store. The required EventDataStore value is an ARN or the ID portion of the ARN. Other parameters are optional, but at least one optional parameter must be specified, or CloudTrail throws an error. RetentionPeriod is in days, and valid values are integers between 90 and 2555. By default, TerminationProtection is enabled. AdvancedEventSelectors includes or excludes management and data events in your event data store; for more information about AdvancedEventSelectors , see PutEventSelectorsRequest$AdvancedEventSelectors .

See also: AWS API Documentation

Request Syntax

response = client.update_event_data_store(
    EventDataStore='string',
    Name='string',
    AdvancedEventSelectors=[
        {
            'Name': 'string',
            'FieldSelectors': [
                {
                    'Field': 'string',
                    'Equals': [
                        'string',
                    ],
                    'StartsWith': [
                        'string',
                    ],
                    'EndsWith': [
                        'string',
                    ],
                    'NotEquals': [
                        'string',
                    ],
                    'NotStartsWith': [
                        'string',
                    ],
                    'NotEndsWith': [
                        'string',
                    ]
                },
            ]
        },
    ],
    MultiRegionEnabled=True|False,
    OrganizationEnabled=True|False,
    RetentionPeriod=123,
    TerminationProtectionEnabled=True|False
)
Parameters
  • EventDataStore (string) --

    [REQUIRED]

    The ARN (or the ID suffix of the ARN) of the event data store that you want to update.

  • Name (string) -- The event data store name.
  • AdvancedEventSelectors (list) --

    The advanced event selectors used to select events for the event data store.

    • (dict) --

      Advanced event selectors let you create fine-grained selectors for the following CloudTrail event record fields. They help you control costs by logging only those events that are important to you. For more information about advanced event selectors, see Logging data events for trails in the CloudTrail User Guide .

      • readOnly
      • eventSource
      • eventName
      • eventCategory
      • resources.type
      • resources.ARN

      You cannot apply both event selectors and advanced event selectors to a trail.

      • Name (string) --

        An optional, descriptive name for an advanced event selector, such as "Log data events for only two S3 buckets".

      • FieldSelectors (list) -- [REQUIRED]

        Contains all selector statements in an advanced event selector.

        • (dict) --

          A single selector statement in an advanced event selector.

          • Field (string) -- [REQUIRED]

            A field in an event record on which to filter events to be logged. Supported fields include readOnly , eventCategory , eventSource (for management events), eventName , resources.type , and resources.ARN .

            • **readOnly ** - Optional. Can be set to Equals a value of true or false . If you do not add this field, CloudTrail logs both both read and write events. A value of true logs only read events. A value of false logs only write events.
            • **eventSource ** - For filtering management events only. This can be set only to NotEquals kms.amazonaws.com .
            • **eventName ** - Can use any operator. You can use it to filter in or filter out any data event logged to CloudTrail, such as PutBucket or GetSnapshotBlock . You can have multiple values for this field, separated by commas.
            • **eventCategory ** - This is required. It must be set to Equals , and the value must be Management or Data .
            • **resources.type ** - This field is required. resources.type can only use the Equals operator, and the value can be one of the following:
              • AWS::S3::Object
              • AWS::Lambda::Function
              • AWS::DynamoDB::Table
              • AWS::S3Outposts::Object
              • AWS::ManagedBlockchain::Node
              • AWS::S3ObjectLambda::AccessPoint
              • AWS::EC2::Snapshot
              • AWS::S3::AccessPoint
              • AWS::DynamoDB::Stream
              • AWS::Glue::Table

            You can have only one resources.type field per selector. To log data events on more than one resource type, add another selector.

            • **resources.ARN ** - You can use any operator with resources.ARN , but if you use Equals or NotEquals , the value must exactly match the ARN of a valid resource of the type you've specified in the template as the value of resources.type. For example, if resources.type equals AWS::S3::Object , the ARN must be in one of the following formats. To log all data events for all objects in a specific S3 bucket, use the StartsWith operator, and include only the bucket ARN as the matching value. The trailing slash is intentional; do not exclude it. Replace the text between less than and greater than symbols (<>) with resource-specific information.
              • arn:<partition>:s3:::<bucket_name>/
              • arn:<partition>:s3:::<bucket_name>/<object_path>/

            When resources.type equals AWS::S3::AccessPoint , and the operator is set to Equals or NotEquals , the ARN must be in one of the following formats. To log events on all objects in an S3 access point, we recommend that you use only the access point ARN, don’t include the object path, and use the StartsWith or NotStartsWith operators.

            • arn:<partition>:s3:<region>:<account_ID>:accesspoint/<access_point_name>
            • arn:<partition>:s3:<region>:<account_ID>:accesspoint/<access_point_name>/object/<object_path>

            When resources.type equals AWS::Lambda::Function , and the operator is set to Equals or NotEquals , the ARN must be in the following format:

            • arn:<partition>:lambda:<region>:<account_ID>:function:<function_name>

            When resources.type equals AWS::DynamoDB::Table , and the operator is set to Equals or NotEquals , the ARN must be in the following format:

            • arn:<partition>:dynamodb:<region>:<account_ID>:table/<table_name>

            When resources.type equals AWS::S3Outposts::Object , and the operator is set to Equals or NotEquals , the ARN must be in the following format:

            • arn:<partition>:s3-outposts:<region>:<account_ID>:<object_path>

            When resources.type equals AWS::ManagedBlockchain::Node , and the operator is set to Equals or NotEquals , the ARN must be in the following format:

            • arn:<partition>:managedblockchain:<region>:<account_ID>:nodes/<node_ID>

            When resources.type equals AWS::S3ObjectLambda::AccessPoint , and the operator is set to Equals or NotEquals , the ARN must be in the following format:

            • arn:<partition>:s3-object-lambda:<region>:<account_ID>:accesspoint/<access_point_name>

            When resources.type equals AWS::EC2::Snapshot , and the operator is set to Equals or NotEquals , the ARN must be in the following format:

            • arn:<partition>:ec2:<region>::snapshot/<snapshot_ID>

            When resources.type equals AWS::DynamoDB::Stream , and the operator is set to Equals or NotEquals , the ARN must be in the following format:

            • arn:<partition>:dynamodb:<region>:<account_ID>:table/<table_name>/stream/<date_time>

            When resources.type equals AWS::Glue::Table , and the operator is set to Equals or NotEquals , the ARN must be in the following format:

            • arn:<partition>:glue:<region>:<account_ID>:table/<database_name>/<table_name>
          • Equals (list) --

            An operator that includes events that match the exact value of the event record field specified as the value of Field . This is the only valid operator that you can use with the readOnly , eventCategory , and resources.type fields.

            • (string) --
          • StartsWith (list) --

            An operator that includes events that match the first few characters of the event record field specified as the value of Field .

            • (string) --
          • EndsWith (list) --

            An operator that includes events that match the last few characters of the event record field specified as the value of Field .

            • (string) --
          • NotEquals (list) --

            An operator that excludes events that match the exact value of the event record field specified as the value of Field .

            • (string) --
          • NotStartsWith (list) --

            An operator that excludes events that match the first few characters of the event record field specified as the value of Field .

            • (string) --
          • NotEndsWith (list) --

            An operator that excludes events that match the last few characters of the event record field specified as the value of Field .

            • (string) --
  • MultiRegionEnabled (boolean) -- Specifies whether an event data store collects events from all regions, or only from the region in which it was created.
  • OrganizationEnabled (boolean) -- Specifies whether an event data store collects events logged for an organization in Organizations.
  • RetentionPeriod (integer) -- The retention period, in days.
  • TerminationProtectionEnabled (boolean) -- Indicates that termination protection is enabled and the event data store cannot be automatically deleted.
Return type

dict

Returns

Response Syntax

{
    'EventDataStoreArn': 'string',
    'Name': 'string',
    'Status': 'CREATED'|'ENABLED'|'PENDING_DELETION',
    'AdvancedEventSelectors': [
        {
            'Name': 'string',
            'FieldSelectors': [
                {
                    'Field': 'string',
                    'Equals': [
                        'string',
                    ],
                    'StartsWith': [
                        'string',
                    ],
                    'EndsWith': [
                        'string',
                    ],
                    'NotEquals': [
                        'string',
                    ],
                    'NotStartsWith': [
                        'string',
                    ],
                    'NotEndsWith': [
                        'string',
                    ]
                },
            ]
        },
    ],
    'MultiRegionEnabled': True|False,
    'OrganizationEnabled': True|False,
    'RetentionPeriod': 123,
    'TerminationProtectionEnabled': True|False,
    'CreatedTimestamp': datetime(2015, 1, 1),
    'UpdatedTimestamp': datetime(2015, 1, 1)
}

Response Structure

  • (dict) --

    • EventDataStoreArn (string) --

      The ARN of the event data store.

    • Name (string) --

      The name of the event data store.

    • Status (string) --

      The status of an event data store. Values can be ENABLED and PENDING_DELETION .

    • AdvancedEventSelectors (list) --

      The advanced event selectors that are applied to the event data store.

      • (dict) --

        Advanced event selectors let you create fine-grained selectors for the following CloudTrail event record fields. They help you control costs by logging only those events that are important to you. For more information about advanced event selectors, see Logging data events for trails in the CloudTrail User Guide .

        • readOnly
        • eventSource
        • eventName
        • eventCategory
        • resources.type
        • resources.ARN

        You cannot apply both event selectors and advanced event selectors to a trail.

        • Name (string) --

          An optional, descriptive name for an advanced event selector, such as "Log data events for only two S3 buckets".

        • FieldSelectors (list) --

          Contains all selector statements in an advanced event selector.

          • (dict) --

            A single selector statement in an advanced event selector.

            • Field (string) --

              A field in an event record on which to filter events to be logged. Supported fields include readOnly , eventCategory , eventSource (for management events), eventName , resources.type , and resources.ARN .

              • **readOnly ** - Optional. Can be set to Equals a value of true or false . If you do not add this field, CloudTrail logs both both read and write events. A value of true logs only read events. A value of false logs only write events.
              • **eventSource ** - For filtering management events only. This can be set only to NotEquals kms.amazonaws.com .
              • **eventName ** - Can use any operator. You can use it to filter in or filter out any data event logged to CloudTrail, such as PutBucket or GetSnapshotBlock . You can have multiple values for this field, separated by commas.
              • **eventCategory ** - This is required. It must be set to Equals , and the value must be Management or Data .
              • **resources.type ** - This field is required. resources.type can only use the Equals operator, and the value can be one of the following:
                • AWS::S3::Object
                • AWS::Lambda::Function
                • AWS::DynamoDB::Table
                • AWS::S3Outposts::Object
                • AWS::ManagedBlockchain::Node
                • AWS::S3ObjectLambda::AccessPoint
                • AWS::EC2::Snapshot
                • AWS::S3::AccessPoint
                • AWS::DynamoDB::Stream
                • AWS::Glue::Table

              You can have only one resources.type field per selector. To log data events on more than one resource type, add another selector.

              • **resources.ARN ** - You can use any operator with resources.ARN , but if you use Equals or NotEquals , the value must exactly match the ARN of a valid resource of the type you've specified in the template as the value of resources.type. For example, if resources.type equals AWS::S3::Object , the ARN must be in one of the following formats. To log all data events for all objects in a specific S3 bucket, use the StartsWith operator, and include only the bucket ARN as the matching value. The trailing slash is intentional; do not exclude it. Replace the text between less than and greater than symbols (<>) with resource-specific information.
                • arn:<partition>:s3:::<bucket_name>/
                • arn:<partition>:s3:::<bucket_name>/<object_path>/

              When resources.type equals AWS::S3::AccessPoint , and the operator is set to Equals or NotEquals , the ARN must be in one of the following formats. To log events on all objects in an S3 access point, we recommend that you use only the access point ARN, don’t include the object path, and use the StartsWith or NotStartsWith operators.

              • arn:<partition>:s3:<region>:<account_ID>:accesspoint/<access_point_name>
              • arn:<partition>:s3:<region>:<account_ID>:accesspoint/<access_point_name>/object/<object_path>

              When resources.type equals AWS::Lambda::Function , and the operator is set to Equals or NotEquals , the ARN must be in the following format:

              • arn:<partition>:lambda:<region>:<account_ID>:function:<function_name>

              When resources.type equals AWS::DynamoDB::Table , and the operator is set to Equals or NotEquals , the ARN must be in the following format:

              • arn:<partition>:dynamodb:<region>:<account_ID>:table/<table_name>

              When resources.type equals AWS::S3Outposts::Object , and the operator is set to Equals or NotEquals , the ARN must be in the following format:

              • arn:<partition>:s3-outposts:<region>:<account_ID>:<object_path>

              When resources.type equals AWS::ManagedBlockchain::Node , and the operator is set to Equals or NotEquals , the ARN must be in the following format:

              • arn:<partition>:managedblockchain:<region>:<account_ID>:nodes/<node_ID>

              When resources.type equals AWS::S3ObjectLambda::AccessPoint , and the operator is set to Equals or NotEquals , the ARN must be in the following format:

              • arn:<partition>:s3-object-lambda:<region>:<account_ID>:accesspoint/<access_point_name>

              When resources.type equals AWS::EC2::Snapshot , and the operator is set to Equals or NotEquals , the ARN must be in the following format:

              • arn:<partition>:ec2:<region>::snapshot/<snapshot_ID>

              When resources.type equals AWS::DynamoDB::Stream , and the operator is set to Equals or NotEquals , the ARN must be in the following format:

              • arn:<partition>:dynamodb:<region>:<account_ID>:table/<table_name>/stream/<date_time>

              When resources.type equals AWS::Glue::Table , and the operator is set to Equals or NotEquals , the ARN must be in the following format:

              • arn:<partition>:glue:<region>:<account_ID>:table/<database_name>/<table_name>
            • Equals (list) --

              An operator that includes events that match the exact value of the event record field specified as the value of Field . This is the only valid operator that you can use with the readOnly , eventCategory , and resources.type fields.

              • (string) --
            • StartsWith (list) --

              An operator that includes events that match the first few characters of the event record field specified as the value of Field .

              • (string) --
            • EndsWith (list) --

              An operator that includes events that match the last few characters of the event record field specified as the value of Field .

              • (string) --
            • NotEquals (list) --

              An operator that excludes events that match the exact value of the event record field specified as the value of Field .

              • (string) --
            • NotStartsWith (list) --

              An operator that excludes events that match the first few characters of the event record field specified as the value of Field .

              • (string) --
            • NotEndsWith (list) --

              An operator that excludes events that match the last few characters of the event record field specified as the value of Field .

              • (string) --
    • MultiRegionEnabled (boolean) --

      Indicates whether the event data store includes events from all regions, or only from the region in which it was created.

    • OrganizationEnabled (boolean) --

      Indicates whether an event data store is collecting logged events for an organization in Organizations.

    • RetentionPeriod (integer) --

      The retention period, in days.

    • TerminationProtectionEnabled (boolean) --

      Indicates whether termination protection is enabled for the event data store.

    • CreatedTimestamp (datetime) --

      The timestamp that shows when an event data store was first created.

    • UpdatedTimestamp (datetime) --

      The timestamp that shows when the event data store was last updated. UpdatedTimestamp is always either the same or newer than the time shown in CreatedTimestamp .

Exceptions

update_trail(**kwargs)

Updates trail settings that control what events you are logging, and how to handle log files. Changes to a trail do not require stopping the CloudTrail service. Use this action to designate an existing bucket for log delivery. If the existing bucket has previously been a target for CloudTrail log files, an IAM policy exists for the bucket. UpdateTrail must be called from the region in which the trail was created; otherwise, an InvalidHomeRegionException is thrown.

See also: AWS API Documentation

Request Syntax

response = client.update_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
)
Parameters
  • Name (string) --

    [REQUIRED]

    Specifies the name of the trail or trail ARN. If Name is a trail name, the string 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 not valid.
    • Not be in IP address format (for example, 192.168.5.4)

    If Name is a trail ARN, it must be in the following format.

    arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail
  • S3BucketName (string) -- Specifies the name of the Amazon S3 bucket designated for publishing log 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) -- Specifies the name of the Amazon SNS topic defined for notification of log file delivery. The maximum length is 256 characters.
  • 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 applies only to the current region or to all regions. The default is false. If the trail exists only in the current region and this value is set to true, shadow trails (replications of the trail) will be created in the other regions. If the trail exists in all regions and this value is set to false, the trail will remain in the region where it was created, and its shadow trails in other regions will be deleted. As a best practice, consider using trails that log events in all regions.
  • EnableLogFileValidation (boolean) --

    Specifies whether log file 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 does 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.

  • CloudWatchLogsLogGroupArn (string) -- Specifies a log group name using an Amazon Resource Name (ARN), a unique identifier that represents the log group to which CloudTrail logs are delivered. Not required unless you specify CloudWatchLogsRoleArn .
  • 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 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.

    CloudTrail also supports KMS multi-Region keys. For more information about multi-Region keys, see Using multi-Region keys in the Key Management Service Developer Guide .

    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
  • IsOrganizationTrail (boolean) -- Specifies whether the trail is applied to all accounts in an organization in Organizations, or only for the current Amazon Web Services account. The default is false, and cannot be true unless the call is made on behalf of an Amazon Web Services account that is the management account for an organization in Organizations. If the trail is not an organization trail and this is set to true , the trail will be created in all Amazon Web Services accounts that belong to the organization. If the trail is an organization trail and this is set to false , the trail will remain in the current Amazon Web Services account but be deleted from all member accounts in the organization.
Return type

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 IAM Log Files .

    • SnsTopicName (string) --

      This field is no longer in use. Use UpdateTrailResponse$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) --

      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 updated. The following is the format of a trail ARN.

      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 are 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

    • IsOrganizationTrail (boolean) --

      Specifies whether the trail is an organization trail.

Exceptions

Client Exceptions

Client exceptions are available on a client instance via the exceptions property. For more detailed instructions and examples on the exact usage of client exceptions, see the error handling user guide.

The available client exceptions are:

class CloudTrail.Client.exceptions.CloudTrailARNInvalidException

This exception is thrown when an operation is called with a trail ARN that is not valid. The following is the format of a trail ARN.

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

Example

try:
  ...
except client.exceptions.CloudTrailARNInvalidException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{}

Structure

  • (dict) --

    This exception is thrown when an operation is called with a trail ARN that is not valid. The following is the format of a trail ARN.

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

    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class CloudTrail.Client.exceptions.CloudTrailAccessNotEnabledException

This exception is thrown when trusted access has not been enabled between CloudTrail and Organizations. For more information, see Enabling Trusted Access with Other Amazon Web Services Services and Prepare For Creating a Trail For Your Organization .

Example

try:
  ...
except client.exceptions.CloudTrailAccessNotEnabledException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{}

Structure

class CloudTrail.Client.exceptions.CloudTrailInvalidClientTokenIdException

This exception is thrown when a call results in the InvalidClientTokenId error code. This can occur when you are creating or updating a trail to send notifications to an Amazon SNS topic that is in a suspended Amazon Web Services account.

Example

try:
  ...
except client.exceptions.CloudTrailInvalidClientTokenIdException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{}

Structure

  • (dict) --

    This exception is thrown when a call results in the InvalidClientTokenId error code. This can occur when you are creating or updating a trail to send notifications to an Amazon SNS topic that is in a suspended Amazon Web Services account.

    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class CloudTrail.Client.exceptions.CloudWatchLogsDeliveryUnavailableException

Cannot set a CloudWatch Logs delivery for this region.

Example

try:
  ...
except client.exceptions.CloudWatchLogsDeliveryUnavailableException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{}

Structure

  • (dict) --

    Cannot set a CloudWatch Logs delivery for this region.

    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class CloudTrail.Client.exceptions.ConflictException

This exception is thrown when the specified resource is not ready for an operation. This can occur when you try to run an operation on a resource before CloudTrail has time to fully load the resource. If this exception occurs, wait a few minutes, and then try the operation again.

Example

try:
  ...
except client.exceptions.ConflictException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{}

Structure

  • (dict) --

    This exception is thrown when the specified resource is not ready for an operation. This can occur when you try to run an operation on a resource before CloudTrail has time to fully load the resource. If this exception occurs, wait a few minutes, and then try the operation again.

    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class CloudTrail.Client.exceptions.EventDataStoreARNInvalidException

The specified event data store ARN is not valid or does not map to an event data store in your account.

Example

try:
  ...
except client.exceptions.EventDataStoreARNInvalidException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{}

Structure

  • (dict) --

    The specified event data store ARN is not valid or does not map to an event data store in your account.

    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class CloudTrail.Client.exceptions.EventDataStoreAlreadyExistsException

An event data store with that name already exists.

Example

try:
  ...
except client.exceptions.EventDataStoreAlreadyExistsException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{}

Structure

  • (dict) --

    An event data store with that name already exists.

    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class CloudTrail.Client.exceptions.EventDataStoreMaxLimitExceededException

Your account has used the maximum number of event data stores.

Example

try:
  ...
except client.exceptions.EventDataStoreMaxLimitExceededException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{}

Structure

  • (dict) --

    Your account has used the maximum number of event data stores.

    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class CloudTrail.Client.exceptions.EventDataStoreNotFoundException

The specified event data store was not found.

Example

try:
  ...
except client.exceptions.EventDataStoreNotFoundException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{}

Structure

  • (dict) --

    The specified event data store was not found.

    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class CloudTrail.Client.exceptions.EventDataStoreTerminationProtectedException

The event data store cannot be deleted because termination protection is enabled for it.

Example

try:
  ...
except client.exceptions.EventDataStoreTerminationProtectedException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{}

Structure

  • (dict) --

    The event data store cannot be deleted because termination protection is enabled for it.

    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class CloudTrail.Client.exceptions.InactiveEventDataStoreException

The event data store is inactive.

Example

try:
  ...
except client.exceptions.InactiveEventDataStoreException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{}

Structure

  • (dict) --

    The event data store is inactive.

    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class CloudTrail.Client.exceptions.InactiveQueryException

The specified query cannot be canceled because it is in the FINISHED , FAILED , TIMED_OUT , or CANCELLED state.

Example

try:
  ...
except client.exceptions.InactiveQueryException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{}

Structure

  • (dict) --

    The specified query cannot be canceled because it is in the FINISHED , FAILED , TIMED_OUT , or CANCELLED state.

    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class CloudTrail.Client.exceptions.InsightNotEnabledException

If you run GetInsightSelectors on a trail that does not have Insights events enabled, the operation throws the exception InsightNotEnabledException .

Example

try:
  ...
except client.exceptions.InsightNotEnabledException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{}

Structure

  • (dict) --

    If you run GetInsightSelectors on a trail that does not have Insights events enabled, the operation throws the exception InsightNotEnabledException .

    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class CloudTrail.Client.exceptions.InsufficientDependencyServiceAccessPermissionException

This exception is thrown when the IAM user or role that is used to create the organization resource lacks one or more required permissions for creating an organization resource in a required service.

Example

try:
  ...
except client.exceptions.InsufficientDependencyServiceAccessPermissionException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{}

Structure

  • (dict) --

    This exception is thrown when the IAM user or role that is used to create the organization resource lacks one or more required permissions for creating an organization resource in a required service.

    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class CloudTrail.Client.exceptions.InsufficientEncryptionPolicyException

This exception is thrown when the policy on the S3 bucket or KMS key is not sufficient.

Example

try:
  ...
except client.exceptions.InsufficientEncryptionPolicyException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{}

Structure

  • (dict) --

    This exception is thrown when the policy on the S3 bucket or KMS key is not sufficient.

    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class CloudTrail.Client.exceptions.InsufficientS3BucketPolicyException

This exception is thrown when the policy on the S3 bucket is not sufficient.

Example

try:
  ...
except client.exceptions.InsufficientS3BucketPolicyException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{}

Structure

  • (dict) --

    This exception is thrown when the policy on the S3 bucket is not sufficient.

    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class CloudTrail.Client.exceptions.InsufficientSnsTopicPolicyException

This exception is thrown when the policy on the Amazon SNS topic is not sufficient.

Example

try:
  ...
except client.exceptions.InsufficientSnsTopicPolicyException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{}

Structure

  • (dict) --

    This exception is thrown when the policy on the Amazon SNS topic is not sufficient.

    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class CloudTrail.Client.exceptions.InvalidCloudWatchLogsLogGroupArnException

This exception is thrown when the provided CloudWatch Logs log group is not valid.

Example

try:
  ...
except client.exceptions.InvalidCloudWatchLogsLogGroupArnException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{}

Structure

  • (dict) --

    This exception is thrown when the provided CloudWatch Logs log group is not valid.

    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class CloudTrail.Client.exceptions.InvalidCloudWatchLogsRoleArnException

This exception is thrown when the provided role is not valid.

Example

try:
  ...
except client.exceptions.InvalidCloudWatchLogsRoleArnException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{}

Structure

  • (dict) --

    This exception is thrown when the provided role is not valid.

    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class CloudTrail.Client.exceptions.InvalidDateRangeException

A date range for the query was specified that is not valid. Be sure that the start time is chronologically before the end time. For more information about writing a query, see Create or edit a query in the CloudTrail User Guide .

Example

try:
  ...
except client.exceptions.InvalidDateRangeException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{}

Structure

  • (dict) --

    A date range for the query was specified that is not valid. Be sure that the start time is chronologically before the end time. For more information about writing a query, see Create or edit a query in the CloudTrail User Guide .

    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class CloudTrail.Client.exceptions.InvalidEventCategoryException

Occurs if an event category that is not valid is specified as a value of EventCategory .

Example

try:
  ...
except client.exceptions.InvalidEventCategoryException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{}

Structure

  • (dict) --

    Occurs if an event category that is not valid is specified as a value of EventCategory .

    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class CloudTrail.Client.exceptions.InvalidEventDataStoreStatusException

The event data store is not in a status that supports the operation.

Example

try:
  ...
except client.exceptions.InvalidEventDataStoreStatusException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{}

Structure

  • (dict) --

    The event data store is not in a status that supports the operation.

    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class CloudTrail.Client.exceptions.InvalidEventSelectorsException

This exception is thrown when the PutEventSelectors operation is called with a number of event selectors, advanced event selectors, or data resources that is not valid. The combination of event selectors or advanced event selectors and data resources is not valid. A trail can have up to 5 event selectors. If a trail uses advanced event selectors, a maximum of 500 total values for all conditions in all advanced event selectors is allowed. A trail is limited to 250 data resources. These data resources can be distributed across event selectors, but the overall total cannot exceed 250.

You can:

  • Specify a valid number of event selectors (1 to 5) for a trail.
  • Specify a valid number of data resources (1 to 250) for an event selector. The limit of number of resources on an individual event selector is configurable up to 250. However, this upper limit is allowed only if the total number of data resources does not exceed 250 across all event selectors for a trail.
  • Specify up to 500 values for all conditions in all advanced event selectors for a trail.
  • Specify a valid value for a parameter. For example, specifying the ReadWriteType parameter with a value of read-only is not valid.

Example

try:
  ...
except client.exceptions.InvalidEventSelectorsException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{}

Structure

  • (dict) --

    This exception is thrown when the PutEventSelectors operation is called with a number of event selectors, advanced event selectors, or data resources that is not valid. The combination of event selectors or advanced event selectors and data resources is not valid. A trail can have up to 5 event selectors. If a trail uses advanced event selectors, a maximum of 500 total values for all conditions in all advanced event selectors is allowed. A trail is limited to 250 data resources. These data resources can be distributed across event selectors, but the overall total cannot exceed 250.

    You can:

    • Specify a valid number of event selectors (1 to 5) for a trail.
    • Specify a valid number of data resources (1 to 250) for an event selector. The limit of number of resources on an individual event selector is configurable up to 250. However, this upper limit is allowed only if the total number of data resources does not exceed 250 across all event selectors for a trail.
    • Specify up to 500 values for all conditions in all advanced event selectors for a trail.
    • Specify a valid value for a parameter. For example, specifying the ReadWriteType parameter with a value of read-only is not valid.
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class CloudTrail.Client.exceptions.InvalidHomeRegionException

This exception is thrown when an operation is called on a trail from a region other than the region in which the trail was created.

Example

try:
  ...
except client.exceptions.InvalidHomeRegionException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{}

Structure

  • (dict) --

    This exception is thrown when an operation is called on a trail from a region other than the region in which the trail was created.

    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class CloudTrail.Client.exceptions.InvalidInsightSelectorsException

The formatting or syntax of the InsightSelectors JSON statement in your PutInsightSelectors or GetInsightSelectors request is not valid, or the specified insight type in the InsightSelectors statement is not a valid insight type.

Example

try:
  ...
except client.exceptions.InvalidInsightSelectorsException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{}

Structure

  • (dict) --

    The formatting or syntax of the InsightSelectors JSON statement in your PutInsightSelectors or GetInsightSelectors request is not valid, or the specified insight type in the InsightSelectors statement is not a valid insight type.

    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class CloudTrail.Client.exceptions.InvalidKmsKeyIdException

This exception is thrown when the KMS key ARN is not valid.

Example

try:
  ...
except client.exceptions.InvalidKmsKeyIdException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{}

Structure

  • (dict) --

    This exception is thrown when the KMS key ARN is not valid.

    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class CloudTrail.Client.exceptions.InvalidLookupAttributesException

Occurs when a lookup attribute is specified that is not valid.

Example

try:
  ...
except client.exceptions.InvalidLookupAttributesException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{}

Structure

  • (dict) --

    Occurs when a lookup attribute is specified that is not valid.

    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class CloudTrail.Client.exceptions.InvalidMaxResultsException

This exception is thrown if the limit specified is not valid.

Example

try:
  ...
except client.exceptions.InvalidMaxResultsException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{}

Structure

  • (dict) --

    This exception is thrown if the limit specified is not valid.

    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class CloudTrail.Client.exceptions.InvalidNextTokenException

A token that is not valid, or a token that was previously used in a request with different parameters. This exception is thrown if the token is not valid.

Example

try:
  ...
except client.exceptions.InvalidNextTokenException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{}

Structure

  • (dict) --

    A token that is not valid, or a token that was previously used in a request with different parameters. This exception is thrown if the token is not valid.

    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class CloudTrail.Client.exceptions.InvalidParameterCombinationException

This exception is thrown when the combination of parameters provided is not valid.

Example

try:
  ...
except client.exceptions.InvalidParameterCombinationException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{}

Structure

  • (dict) --

    This exception is thrown when the combination of parameters provided is not valid.

    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class CloudTrail.Client.exceptions.InvalidParameterException

The request includes a parameter that is not valid.

Example

try:
  ...
except client.exceptions.InvalidParameterException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{}

Structure

  • (dict) --

    The request includes a parameter that is not valid.

    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class CloudTrail.Client.exceptions.InvalidQueryStatementException

The query that was submitted has validation errors, or uses incorrect syntax or unsupported keywords. For more information about writing a query, see Create or edit a query in the CloudTrail User Guide .

Example

try:
  ...
except client.exceptions.InvalidQueryStatementException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{}

Structure

  • (dict) --

    The query that was submitted has validation errors, or uses incorrect syntax or unsupported keywords. For more information about writing a query, see Create or edit a query in the CloudTrail User Guide .

    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class CloudTrail.Client.exceptions.InvalidQueryStatusException

The query status is not valid for the operation.

Example

try:
  ...
except client.exceptions.InvalidQueryStatusException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{}

Structure

  • (dict) --

    The query status is not valid for the operation.

    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class CloudTrail.Client.exceptions.InvalidS3BucketNameException

This exception is thrown when the provided S3 bucket name is not valid.

Example

try:
  ...
except client.exceptions.InvalidS3BucketNameException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{}

Structure

  • (dict) --

    This exception is thrown when the provided S3 bucket name is not valid.

    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class CloudTrail.Client.exceptions.InvalidS3PrefixException

This exception is thrown when the provided S3 prefix is not valid.

Example

try:
  ...
except client.exceptions.InvalidS3PrefixException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{}

Structure

  • (dict) --

    This exception is thrown when the provided S3 prefix is not valid.

    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class CloudTrail.Client.exceptions.InvalidSnsTopicNameException

This exception is thrown when the provided SNS topic name is not valid.

Example

try:
  ...
except client.exceptions.InvalidSnsTopicNameException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{}

Structure

  • (dict) --

    This exception is thrown when the provided SNS topic name is not valid.

    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class CloudTrail.Client.exceptions.InvalidTagParameterException

This exception is thrown when the specified tag key or values are not valid. It can also occur if there are duplicate tags or too many tags on the resource.

Example

try:
  ...
except client.exceptions.InvalidTagParameterException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{}

Structure

  • (dict) --

    This exception is thrown when the specified tag key or values are not valid. It can also occur if there are duplicate tags or too many tags on the resource.

    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class CloudTrail.Client.exceptions.InvalidTimeRangeException

Occurs if the timestamp values are not valid. Either the start time occurs after the end time, or the time range is outside the range of possible values.

Example

try:
  ...
except client.exceptions.InvalidTimeRangeException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{}

Structure

  • (dict) --

    Occurs if the timestamp values are not valid. Either the start time occurs after the end time, or the time range is outside the range of possible values.

    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class CloudTrail.Client.exceptions.InvalidTokenException

Reserved for future use.

Example

try:
  ...
except client.exceptions.InvalidTokenException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{}

Structure

  • (dict) --

    Reserved for future use.

    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class CloudTrail.Client.exceptions.InvalidTrailNameException

This exception is thrown when the provided trail name is not valid. Trail names 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 not valid.
  • Not be in IP address format (for example, 192.168.5.4)

Example

try:
  ...
except client.exceptions.InvalidTrailNameException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{}

Structure

  • (dict) --

    This exception is thrown when the provided trail name is not valid. Trail names 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 not valid.
    • Not be in IP address format (for example, 192.168.5.4)
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class CloudTrail.Client.exceptions.KmsException

This exception is thrown when there is an issue with the specified KMS key and the trail can’t be updated.

Example

try:
  ...
except client.exceptions.KmsException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{}

Structure

  • (dict) --

    This exception is thrown when there is an issue with the specified KMS key and the trail can’t be updated.

    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class CloudTrail.Client.exceptions.KmsKeyDisabledException

This exception is no longer in use.

Example

try:
  ...
except client.exceptions.KmsKeyDisabledException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{}

Structure

  • (dict) --

    This exception is no longer in use.

    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class CloudTrail.Client.exceptions.KmsKeyNotFoundException

This exception is thrown when the KMS key does not exist, when the S3 bucket and the KMS key are not in the same region, or when the KMS key associated with the Amazon SNS topic either does not exist or is not in the same region.

Example

try:
  ...
except client.exceptions.KmsKeyNotFoundException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{}

Structure

  • (dict) --

    This exception is thrown when the KMS key does not exist, when the S3 bucket and the KMS key are not in the same region, or when the KMS key associated with the Amazon SNS topic either does not exist or is not in the same region.

    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class CloudTrail.Client.exceptions.MaxConcurrentQueriesException

You are already running the maximum number of concurrent queries. Wait a minute for some queries to finish, and then run the query again.

Example

try:
  ...
except client.exceptions.MaxConcurrentQueriesException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{}

Structure

  • (dict) --

    You are already running the maximum number of concurrent queries. Wait a minute for some queries to finish, and then run the query again.

    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class CloudTrail.Client.exceptions.MaximumNumberOfTrailsExceededException

This exception is thrown when the maximum number of trails is reached.

Example

try:
  ...
except client.exceptions.MaximumNumberOfTrailsExceededException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{}

Structure

  • (dict) --

    This exception is thrown when the maximum number of trails is reached.

    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class CloudTrail.Client.exceptions.NotOrganizationMasterAccountException

This exception is thrown when the Amazon Web Services account making the request to create or update an organization trail or event data store is not the management account for an organization in Organizations. For more information, see Prepare For Creating a Trail For Your Organization or Create an event data store .

Example

try:
  ...
except client.exceptions.NotOrganizationMasterAccountException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{}

Structure

  • (dict) --

    This exception is thrown when the Amazon Web Services account making the request to create or update an organization trail or event data store is not the management account for an organization in Organizations. For more information, see Prepare For Creating a Trail For Your Organization or Create an event data store .

    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class CloudTrail.Client.exceptions.OperationNotPermittedException

This exception is thrown when the requested operation is not permitted.

Example

try:
  ...
except client.exceptions.OperationNotPermittedException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{}

Structure

  • (dict) --

    This exception is thrown when the requested operation is not permitted.

    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class CloudTrail.Client.exceptions.OrganizationNotInAllFeaturesModeException

This exception is thrown when Organizations is not configured to support all features. All features must be enabled in Organizations to support creating an organization trail or event data store.

Example

try:
  ...
except client.exceptions.OrganizationNotInAllFeaturesModeException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{}

Structure

  • (dict) --

    This exception is thrown when Organizations is not configured to support all features. All features must be enabled in Organizations to support creating an organization trail or event data store.

    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class CloudTrail.Client.exceptions.OrganizationsNotInUseException

This exception is thrown when the request is made from an Amazon Web Services account that is not a member of an organization. To make this request, sign in using the credentials of an account that belongs to an organization.

Example

try:
  ...
except client.exceptions.OrganizationsNotInUseException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{}

Structure

  • (dict) --

    This exception is thrown when the request is made from an Amazon Web Services account that is not a member of an organization. To make this request, sign in using the credentials of an account that belongs to an organization.

    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class CloudTrail.Client.exceptions.QueryIdNotFoundException

The query ID does not exist or does not map to a query.

Example

try:
  ...
except client.exceptions.QueryIdNotFoundException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{}

Structure

  • (dict) --

    The query ID does not exist or does not map to a query.

    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class CloudTrail.Client.exceptions.ResourceNotFoundException

This exception is thrown when the specified resource is not found.

Example

try:
  ...
except client.exceptions.ResourceNotFoundException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{}

Structure

  • (dict) --

    This exception is thrown when the specified resource is not found.

    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class CloudTrail.Client.exceptions.ResourceTypeNotSupportedException

This exception is thrown when the specified resource type is not supported by CloudTrail.

Example

try:
  ...
except client.exceptions.ResourceTypeNotSupportedException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{}

Structure

  • (dict) --

    This exception is thrown when the specified resource type is not supported by CloudTrail.

    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class CloudTrail.Client.exceptions.S3BucketDoesNotExistException

This exception is thrown when the specified S3 bucket does not exist.

Example

try:
  ...
except client.exceptions.S3BucketDoesNotExistException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{}

Structure

  • (dict) --

    This exception is thrown when the specified S3 bucket does not exist.

    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class CloudTrail.Client.exceptions.TagsLimitExceededException

The number of tags per trail has exceeded the permitted amount. Currently, the limit is 50.

Example

try:
  ...
except client.exceptions.TagsLimitExceededException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{}

Structure

  • (dict) --

    The number of tags per trail has exceeded the permitted amount. Currently, the limit is 50.

    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class CloudTrail.Client.exceptions.TrailAlreadyExistsException

This exception is thrown when the specified trail already exists.

Example

try:
  ...
except client.exceptions.TrailAlreadyExistsException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{}

Structure

  • (dict) --

    This exception is thrown when the specified trail already exists.

    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class CloudTrail.Client.exceptions.TrailNotFoundException

This exception is thrown when the trail with the given name is not found.

Example

try:
  ...
except client.exceptions.TrailNotFoundException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{}

Structure

  • (dict) --

    This exception is thrown when the trail with the given name is not found.

    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class CloudTrail.Client.exceptions.TrailNotProvidedException

This exception is no longer in use.

Example

try:
  ...
except client.exceptions.TrailNotProvidedException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{}

Structure

  • (dict) --

    This exception is no longer in use.

    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class CloudTrail.Client.exceptions.UnsupportedOperationException

This exception is thrown when the requested operation is not supported.

Example

try:
  ...
except client.exceptions.UnsupportedOperationException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{}

Structure

  • (dict) --

    This exception is thrown when the requested operation is not supported.

    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.

Paginators

The available paginators are:

class CloudTrail.Paginator.ListPublicKeys
paginator = client.get_paginator('list_public_keys')
paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    StartTime=datetime(2015, 1, 1),
    EndTime=datetime(2015, 1, 1),
    PaginationConfig={
        'MaxItems': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • StartTime (datetime) -- Optionally specifies, in UTC, the start of the time range to look up public keys for CloudTrail digest files. If not specified, the current time is used, and the current public key is returned.
  • EndTime (datetime) -- Optionally specifies, in UTC, the end of the time range to look up public keys for CloudTrail digest files. If not specified, the current time is used.
  • 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

dict

Returns

Response Syntax

{
    'PublicKeyList': [
        {
            'Value': b'bytes',
            'ValidityStartTime': datetime(2015, 1, 1),
            'ValidityEndTime': datetime(2015, 1, 1),
            'Fingerprint': 'string'
        },
    ],

}

Response Structure

  • (dict) --

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

    • PublicKeyList (list) --

      Contains an array of PublicKey objects.

      Note

      The returned public keys may have validity time ranges that overlap.

      • (dict) --

        Contains information about a returned public key.

        • Value (bytes) --

          The DER encoded public key value in PKCS#1 format.

        • ValidityStartTime (datetime) --

          The starting time of validity of the public key.

        • ValidityEndTime (datetime) --

          The ending time of validity of the public key.

        • Fingerprint (string) --

          The fingerprint of the public key.

class CloudTrail.Paginator.ListTags
paginator = client.get_paginator('list_tags')
paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    ResourceIdList=[
        'string',
    ],
    PaginationConfig={
        'MaxItems': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • ResourceIdList (list) --

    [REQUIRED]

    Specifies a list of trail and event data store ARNs whose tags will be listed. The list has a limit of 20 ARNs.

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

dict

Returns

Response Syntax

{
    'ResourceTagList': [
        {
            'ResourceId': 'string',
            'TagsList': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ]
        },
    ],

}

Response Structure

  • (dict) --

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

    • ResourceTagList (list) --

      A list of resource tags.

      • (dict) --

        A resource tag.

        • ResourceId (string) --

          Specifies the ARN of the resource.

        • TagsList (list) --

          A list of tags.

          • (dict) --

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

            • Key (string) --

              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.

class CloudTrail.Paginator.ListTrails
paginator = client.get_paginator('list_trails')
paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    PaginationConfig={
        'MaxItems': 123,
        'StartingToken': 'string'
    }
)
Parameters
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
dict
Returns
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.

class CloudTrail.Paginator.LookupEvents
paginator = client.get_paginator('lookup_events')
paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    LookupAttributes=[
        {
            'AttributeKey': 'EventId'|'EventName'|'ReadOnly'|'Username'|'ResourceType'|'ResourceName'|'EventSource'|'AccessKeyId',
            'AttributeValue': 'string'
        },
    ],
    StartTime=datetime(2015, 1, 1),
    EndTime=datetime(2015, 1, 1),
    EventCategory='insight',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • LookupAttributes (list) --

    Contains a list of lookup attributes. Currently the list can contain only one item.

    • (dict) --

      Specifies an attribute and value that filter the events returned.

      • AttributeKey (string) -- [REQUIRED]

        Specifies an attribute on which to filter the events returned.

      • AttributeValue (string) -- [REQUIRED]

        Specifies a value for the specified AttributeKey.

  • StartTime (datetime) -- Specifies that only events that occur after or at the specified time are returned. If the specified start time is after the specified end time, an error is returned.
  • EndTime (datetime) -- Specifies that only events that occur before or at the specified time are returned. If the specified end time is before the specified start time, an error is returned.
  • EventCategory (string) -- Specifies the event category. If you do not specify an event category, events of the category are not returned in the response. For example, if you do not specify insight as the value of EventCategory , no Insights events are 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

{
    'Events': [
        {
            'EventId': 'string',
            'EventName': 'string',
            'ReadOnly': 'string',
            'AccessKeyId': 'string',
            'EventTime': datetime(2015, 1, 1),
            'EventSource': 'string',
            'Username': 'string',
            'Resources': [
                {
                    'ResourceType': 'string',
                    'ResourceName': 'string'
                },
            ],
            'CloudTrailEvent': 'string'
        },
    ],

}

Response Structure

  • (dict) --

    Contains a response to a LookupEvents action.

    • Events (list) --

      A list of events returned based on the lookup attributes specified and the CloudTrail event. The events list is sorted by time. The most recent event is listed first.

      • (dict) --

        Contains information about an event that was returned by a lookup request. The result includes a representation of a CloudTrail event.

        • EventId (string) --

          The CloudTrail ID of the event returned.

        • EventName (string) --

          The name of the event returned.

        • ReadOnly (string) --

          Information about whether the event is a write event or a read event.

        • AccessKeyId (string) --

          The Amazon Web Services access key ID that was used to sign the request. If the request was made with temporary security credentials, this is the access key ID of the temporary credentials.

        • EventTime (datetime) --

          The date and time of the event returned.

        • EventSource (string) --

          The Amazon Web Services service to which the request was made.

        • Username (string) --

          A user name or role name of the requester that called the API in the event returned.

        • Resources (list) --

          A list of resources referenced by the event returned.

          • (dict) --

            Specifies the type and name of a resource referenced by an event.

            • ResourceType (string) --

              The type of a resource referenced by the event returned. When the resource type cannot be determined, null is returned. Some examples of resource types are: Instance for EC2, Trail for CloudTrail, DBInstance for Amazon RDS, and AccessKey for IAM. To learn more about how to look up and filter events by the resource types supported for a service, see Filtering CloudTrail Events .

            • ResourceName (string) --

              The name of the resource referenced by the event returned. These are user-created names whose values will depend on the environment. For example, the resource name might be "auto-scaling-test-group" for an Auto Scaling Group or "i-1234567" for an EC2 Instance.

        • CloudTrailEvent (string) --

          A JSON string that contains a representation of the event returned.