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.
      
      Supported CloudTrail event record fields for management events
      - eventCategory (required)
      - eventSource
      - readOnly
      Supported CloudTrail event record fields for data events
      - eventCategory (required)
      - resources.type (required)
      - readOnly
      - eventName
      - resources.ARN
      Supported CloudTrail event record fields for network activity events
      
      Note
      Network activity events is in preview release for CloudTrail and is subject to change.
      - eventCategory (required)
      - eventSource (required)
      - eventName
      - errorCode - The only valid value for errorCode is VpceAccessDenied.
      - vpcEndpointId
      Note
      For event data stores for CloudTrail Insights events, Config configuration items, Audit Manager evidence, or events outside of Amazon Web Services, the only supported field is eventCategory.
      - 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 CloudTrail management events, supported fields include eventCategory (required), eventSource, and readOnly.
        
        For CloudTrail data events, supported fields include eventCategory (required), resources.type (required), eventName, readOnly, and resources.ARN.
        
        For CloudTrail network activity events, supported fields include eventCategory (required), eventSource (required), eventName, errorCode, and vpcEndpointId.
        
        For event data stores for CloudTrail Insights events, Config configuration items, Audit Manager evidence, or events outside of Amazon Web Services, the only supported field is eventCategory.
        
        readOnly - This is an optional field that is only used for management events and data events. This field can be set to Equals with a value of true or false. If you do not add this field, CloudTrail logs both read and write events. A value of true logs only read events. A value of false logs only write events.
        
        eventSource - This field is only used for management events and network activity events. For management events, this is an optional field that can be set to NotEquals kms.amazonaws.com to exclude KMS management events, or NotEquals rdsdata.amazonaws.com to exclude RDS management events. For network activity events, this is a required field that only uses the Equals operator. Set this field to the event source for which you want to log network activity events. If you want to log network activity events for multiple event sources, you must create a separate field selector for each event source. The following are valid values for network activity events:
        
        cloudtrail.amazonaws.com
        
        ec2.amazonaws.com
        
        kms.amazonaws.com
        
        secretsmanager.amazonaws.com
        
        eventName - This is an optional field that is only used for data events and network activity events. You can use any operator with eventName. You can use it to ﬁlter in or ﬁlter out specific events. You can have multiple values for this ﬁeld, separated by commas.
        
        eventCategory - This field is required and must be set to Equals.
        
        For CloudTrail management events, the value must be Management.
        
        For CloudTrail data events, the value must be Data.
        
        For CloudTrail network activity events, the value must be NetworkActivity.
        
        The following are used only for event data stores:
        
        For CloudTrail Insights events, the value must be Insight.
        
        For Config configuration items, the value must be ConfigurationItem.
        
        For Audit Manager evidence, the value must be Evidence.
        
        For non-Amazon Web Services events, the value must be ActivityAuditLog.
        
        errorCode - This ﬁeld is only used to filter CloudTrail network activity events and is optional. This is the error code to filter on. Currently, the only valid errorCode is VpceAccessDenied. errorCode can only use the Equals operator.
        
        resources.type - This ﬁeld is required for CloudTrail data events. resources.type can only use the Equals operator. The value can be one of the following:
        
        AWS::AppConfig::Configuration
        
        AWS::B2BI::Transformer
        
        AWS::Bedrock::AgentAlias
        
        AWS::Bedrock::FlowAlias
        
        AWS::Bedrock::Guardrail
        
        AWS::Bedrock::KnowledgeBase
        
        AWS::Cassandra::Table
        
        AWS::CloudFront::KeyValueStore
        
        AWS::CloudTrail::Channel
        
        AWS::CloudWatch::Metric
        
        AWS::CodeWhisperer::Customization
        
        AWS::CodeWhisperer::Profile
        
        AWS::Cognito::IdentityPool
        
        AWS::DynamoDB::Stream
        
        AWS::DynamoDB::Table
        
        AWS::EC2::Snapshot
        
        AWS::EMRWAL::Workspace
        
        AWS::FinSpace::Environment
        
        AWS::Glue::Table
        
        AWS::GreengrassV2::ComponentVersion
        
        AWS::GreengrassV2::Deployment
        
        AWS::GuardDuty::Detector
        
        AWS::IoT::Certificate
        
        AWS::IoT::Thing
        
        AWS::IoTSiteWise::Asset
        
        AWS::IoTSiteWise::TimeSeries
        
        AWS::IoTTwinMaker::Entity
        
        AWS::IoTTwinMaker::Workspace
        
        AWS::KendraRanking::ExecutionPlan
        
        AWS::Kinesis::Stream
        
        AWS::Kinesis::StreamConsumer
        
        AWS::KinesisVideo::Stream
        
        AWS::Lambda::Function
        
        AWS::MachineLearning::MlModel
        
        AWS::ManagedBlockchain::Network
        
        AWS::ManagedBlockchain::Node
        
        AWS::MedicalImaging::Datastore
        
        AWS::NeptuneGraph::Graph
        
        AWS::One::UKey
        
        AWS::One::User
        
        AWS::PaymentCryptography::Alias
        
        AWS::PaymentCryptography::Key
        
        AWS::PCAConnectorAD::Connector
        
        AWS::PCAConnectorSCEP::Connector
        
        AWS::QApps:QApp
        
        AWS::QBusiness::Application
        
        AWS::QBusiness::DataSource
        
        AWS::QBusiness::Index
        
        AWS::QBusiness::WebExperience
        
        AWS::RDS::DBCluster
        
        AWS::RUM::AppMonitor
        
        AWS::S3::AccessPoint
        
        AWS::S3::Object
        
        AWS::S3Express::Object
        
        AWS::S3ObjectLambda::AccessPoint
        
        AWS::S3Outposts::Object
        
        AWS::SageMaker::Endpoint
        
        AWS::SageMaker::ExperimentTrialComponent
        
        AWS::SageMaker::FeatureGroup
        
        AWS::ServiceDiscovery::Namespace
        
        AWS::ServiceDiscovery::Service
        
        AWS::SCN::Instance
        
        AWS::SNS::PlatformEndpoint
        
        AWS::SNS::Topic
        
        AWS::SQS::Queue
        
        AWS::SSM::ManagedNode
        
        AWS::SSMMessages::ControlChannel
        
        AWS::StepFunctions::StateMachine
        
        AWS::SWF::Domain
        
        AWS::ThinClient::Device
        
        AWS::ThinClient::Environment
        
        AWS::Timestream::Database
        
        AWS::Timestream::Table
        
        AWS::VerifiedPermissions::PolicyStore
        
        AWS::XRay::Trace
        
        You can have only one resources.type ﬁeld per selector. To log events on more than one resource type, add another selector.
        
        resources.ARN - The resources.ARN is an optional field for data events. 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 speciﬁed in the template as the value of resources.type. 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. For information about filtering data events on the resources.ARN field, see Filtering data events by resources.ARN in the CloudTrail User Guide.
        
        Note
        You can’t use the resources.ARN field to filter resource types that do not have ARNs.
        
        vpcEndpointId - This ﬁeld is only used to filter CloudTrail network activity events and is optional. This field identifies the VPC endpoint that the request passed through. You can use any operator with vpcEndpointId.
        
        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

get_channel#

Request Syntax

Response Syntax

Response Structure

Supported CloudTrail event record fields for management events

Supported CloudTrail event record fields for data events

Supported CloudTrail event record fields for network activity events

Note

Note

Note

Exceptions