CloudTrail / Client / get_trail

get_trail#

CloudTrail.Client.get_trail(**kwargs)#

Returns settings information for a specified trail.

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

CloudTrail.Client.exceptions.CloudTrailARNInvalidException
CloudTrail.Client.exceptions.TrailNotFoundException
CloudTrail.Client.exceptions.InvalidTrailNameException
CloudTrail.Client.exceptions.UnsupportedOperationException
CloudTrail.Client.exceptions.OperationNotPermittedException