CloudTrail / Client / get_channel

get_channel#

CloudTrail.Client.get_channel(**kwargs)#

Returns information about a specific channel.

Request Syntax

response = client.get_channel(
    Channel='string'
)

Parameters:

Channel (string) –

[REQUIRED]

The ARN or UUID of a channel.

Return type:

dict

Returns:

Response Syntax

{
    'ChannelArn': 'string',
    'Name': 'string',
    'Source': 'string',
    'SourceConfig': {
        'ApplyToAllRegions': True|False,
        'AdvancedEventSelectors': [
            {
                'Name': 'string',
                'FieldSelectors': [
                    {
                        'Field': 'string',
                        'Equals': [
                            'string',
                        ],
                        'StartsWith': [
                            'string',
                        ],
                        'EndsWith': [
                            'string',
                        ],
                        'NotEquals': [
                            'string',
                        ],
                        'NotStartsWith': [
                            'string',
                        ],
                        'NotEndsWith': [
                            'string',
                        ]
                    },
                ]
            },
        ]
    },
    'Destinations': [
        {
            'Type': 'EVENT_DATA_STORE'|'AWS_SERVICE',
            'Location': 'string'
        },
    ],
    'IngestionStatus': {
        'LatestIngestionSuccessTime': datetime(2015, 1, 1),
        'LatestIngestionSuccessEventID': 'string',
        'LatestIngestionErrorCode': 'string',
        'LatestIngestionAttemptTime': datetime(2015, 1, 1),
        'LatestIngestionAttemptEventID': 'string'
    }
}

Response Structure

(dict) –
- ChannelArn (string) –
  
  The ARN of an channel returned by a GetChannel request.
- Name (string) –
  
  The name of the CloudTrail channel. For service-linked channels, the name is aws-service-channel/service-name/custom-suffix where service-name represents the name of the Amazon Web Services service that created the channel and custom-suffix represents the suffix generated by the Amazon Web Services service.
- Source (string) –
  
  The source for the CloudTrail channel.
- SourceConfig (dict) –
  
  Provides information about the advanced event selectors configured for the channel, and whether the channel applies to all Regions or a single Region.
  - ApplyToAllRegions (boolean) –
    
    Specifies whether the channel applies to a single Region or to all Regions.
  - AdvancedEventSelectors (list) –
    
    The advanced event selectors that are configured for the channel.
    - (dict) –
      
      Advanced event selectors let you create fine-grained selectors for CloudTrail management, data, and network activity events. They help you control costs by logging only those events that are important to you. For more information about configuring advanced event selectors, see the Logging data events, Logging network activity events, and Logging management events topics in the CloudTrail User Guide.
      
      You cannot apply both event selectors and advanced event selectors to a trail.
      
      For information about configurable advanced event selector fields, see AdvancedEventSelector in the CloudTrailUser Guide.
      - 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 a CloudTrail event record on which to filter events to be logged. For event data stores for CloudTrail Insights events, Config configuration items, Audit Manager evidence, or events outside of Amazon Web Services, the field is used only for selecting events as filtering is not supported.
        
        For more information, see AdvancedFieldSelector in the CloudTrailUser Guide.
        
        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) –
- Destinations (list) –
  
  The destinations for the channel. For channels created for integrations, the destinations are the event data stores that log events arriving through the channel. For service-linked channels, the destination is the Amazon Web Services service that created the service-linked channel to receive events.
  - (dict) –
    
    Contains information about the destination receiving events.
    - Type (string) –
      
      The type of destination for events arriving from a channel. For channels used for a CloudTrail Lake integration, the value is EVENT_DATA_STORE. For service-linked channels, the value is AWS_SERVICE.
    - Location (string) –
      
      For channels used for a CloudTrail Lake integration, the location is the ARN of an event data store that receives events from a channel. For service-linked channels, the location is the name of the Amazon Web Services service.
- IngestionStatus (dict) –
  
  A table showing information about the most recent successful and failed attempts to ingest events.
  - LatestIngestionSuccessTime (datetime) –
    
    The time stamp of the most recent successful ingestion of events for the channel.
  - LatestIngestionSuccessEventID (string) –
    
    The event ID of the most recent successful ingestion of events.
  - LatestIngestionErrorCode (string) –
    
    The error code for the most recent failure to ingest events.
  - LatestIngestionAttemptTime (datetime) –
    
    The time stamp of the most recent attempt to ingest events on the channel.
  - LatestIngestionAttemptEventID (string) –
    
    The event ID of the most recent attempt to ingest events.

Exceptions

CloudTrail.Client.exceptions.ChannelARNInvalidException
CloudTrail.Client.exceptions.ChannelNotFoundException
CloudTrail.Client.exceptions.OperationNotPermittedException
CloudTrail.Client.exceptions.UnsupportedOperationException