[ aws . cloudtrail ]

get-channel

Description

Returns information about a specific channel.

See also: AWS API Documentation

Synopsis

  get-channel
--channel <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Options

--channel (string)

The ARN or UUID of a channel.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination.

--output (string)

The formatting style for command output.

• json
• text
• table
• yaml
• yaml-stream

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

• on
• off
• auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

• base64
• raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

Output

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 -> (structure)

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.

(structure)

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

(structure)

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 Config configuration items, Audit Manager evidence, or non-Amazon Web Services events, the field is used only for selecting events as filtering is not supported.

For CloudTrail event records, supported fields include readOnly , eventCategory , eventSource (for management events), eventName , resources.type , and resources.ARN .

For event data stores for Config configuration items, Audit Manager evidence, or non-Amazon Web Services events, the only supported field is eventCategory .

• **readOnly ** - Optional. Can be set to Equals 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 ** - 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 and must be set to Equals .
  • For CloudTrail event records, the value must be Management or Data .
  • 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 .
• **resources.type ** - This field is required for CloudTrail data events. resources.type can only use the Equals operator, and the value can be one of the following:
  • AWS::DynamoDB::Table
  • AWS::Lambda::Function
  • AWS::S3::Object
  • AWS::CloudTrail::Channel
  • AWS::CodeWhisperer::Profile
  • AWS::Cognito::IdentityPool
  • AWS::DynamoDB::Stream
  • AWS::EC2::Snapshot
  • AWS::EMRWAL::Workspace
  • AWS::FinSpace::Environment
  • AWS::Glue::Table
  • AWS::GuardDuty::Detector
  • AWS::KendraRanking::ExecutionPlan
  • AWS::ManagedBlockchain::Node
  • AWS::SageMaker::ExperimentTrialComponent
  • AWS::SageMaker::FeatureGroup
  • AWS::S3::AccessPoint
  • AWS::S3ObjectLambda::AccessPoint
  • AWS::S3Outposts::Object

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::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::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::CloudTrail::Channel , and the operator is set to Equals or NotEquals , the ARN must be in the following format:

• arn:<partition>:cloudtrail:<region>:<account_ID>:channel/<channel_UUID>

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

• arn:<partition>:codewhisperer:<region>:<account_ID>:profile/<profile_ID>

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

• arn:<partition>:cognito-identity:<region>:<account_ID>:identitypool/<identity_pool_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::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::EMRWAL::Workspace , and the operator is set to Equals or NotEquals , the ARN must be in the following format:

• arn:<partition>:emrwal:<region>::workspace/<workspace_name>

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

• arn:<partition>:finspace:<region>:<account_ID>:environment/<environment_ID>

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>

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

• arn:<partition>:guardduty:<region>:<account_ID>:detector/<detector_ID>

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

• arn:<partition>:kendra-ranking:<region>:<account_ID>:rescore-execution-plan/<rescore_execution_plan_ID>

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::SageMaker::ExperimentTrialComponent , and the operator is set to Equals or NotEquals , the ARN must be in the following format:

• arn:<partition>:sagemaker:<region>:<account_ID>:experiment-trial-component/<experiment_trial_component_name>

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

• arn:<partition>:sagemaker:<region>:<account_ID>:feature-group/<feature_group_name>

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

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.

(structure)

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 EventDataStore . 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 -> (structure)

A table showing information about the most recent successful and failed attempts to ingest events.

LatestIngestionSuccessTime -> (timestamp)

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 -> (timestamp)

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.