:doc:`CloudTrail <../../cloudtrail>` / Client / get_trail

*********
get_trail
*********



.. py:method:: CloudTrail.Client.get_trail(**kwargs)

  

  Returns settings information for a specified trail.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/GetTrail>`_  


  **Request Syntax**
  ::

    response = client.get_trail(
        Name='string'
    )
    
  :type Name: string
  :param Name: **[REQUIRED]** 

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

    

  
  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {
          'Trail': {
              'Name': 'string',
              'S3BucketName': 'string',
              'S3KeyPrefix': 'string',
              'SnsTopicName': 'string',
              'SnsTopicARN': 'string',
              'IncludeGlobalServiceEvents': True|False,
              'IsMultiRegionTrail': True|False,
              'HomeRegion': 'string',
              'TrailARN': 'string',
              'LogFileValidationEnabled': True|False,
              'CloudWatchLogsLogGroupArn': 'string',
              'CloudWatchLogsRoleArn': 'string',
              'KmsKeyId': 'string',
              'HasCustomEventSelectors': True|False,
              '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 rules <https://docs.aws.amazon.com/AmazonS3/latest/userguide/bucketnamingrules.html>`__.

          
        

        - **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 <https://docs.aws.amazon.com/awscloudtrail/latest/userguide/get-and-view-cloudtrail-log-files.html#cloudtrail-find-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 and digest files 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**
  
  *   :py:class:`CloudTrail.Client.exceptions.CloudTrailARNInvalidException`

  
  *   :py:class:`CloudTrail.Client.exceptions.TrailNotFoundException`

  
  *   :py:class:`CloudTrail.Client.exceptions.InvalidTrailNameException`

  
  *   :py:class:`CloudTrail.Client.exceptions.UnsupportedOperationException`

  
  *   :py:class:`CloudTrail.Client.exceptions.OperationNotPermittedException`

  