AWS CLI Command Reference

Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . cloudtrail ]

get-event-selectors

Description

Describes the settings for the event selectors that you configured for your trail. The information returned for your event selectors includes the following:

  • If your event selector includes read-only events, write-only events, or all events. This applies to management events, data events, and network activity events.
  • If your event selector includes management events.
  • If your event selector includes network activity events, the event sources for which you are logging network activity events.
  • If your event selector includes data events, the resources on which you are logging data events.

For more information about logging management, data, and network activity events, see the following topics in the CloudTrail User Guide :

See also: AWS API Documentation

Synopsis

  get-event-selectors
--trail-name <value>
[--cli-input-json <value>]
[--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>]

Options

--trail-name (string)

Specifies the name of the trail or trail ARN. If you specify a trail name, the string must meet the following requirements:

  • Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-)
  • Start with a letter or number, and end with a letter or number
  • Be between 3 and 128 characters
  • Have no adjacent periods, underscores or dashes. Names like my-_namespace and my--namespace are not valid.
  • Not be in IP address format (for example, 192.168.5.4)

If you specify a trail ARN, it must be in the format:

arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

--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. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

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. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

  • json
  • text
  • table

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

Examples

Note

To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.

Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal's quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .

To view the event selector settings for a trail

The following get-event-selectors command returns the settings for Trail1:

aws cloudtrail get-event-selectors --trail-name Trail1

Output:

{
  "EventSelectors": [
      {
          "IncludeManagementEvents": true,
          "DataResources": [],
          "ReadWriteType": "All"
      }
  ],
  "TrailARN": "arn:aws:cloudtrail:us-east-1:123456789012:trail/Trail1"
}

Output

TrailARN -> (string)

The specified trail ARN that has the event selectors.

EventSelectors -> (list)

The event selectors that are configured for the trail.

(structure)

Use event selectors to further specify the management and data event settings for your trail. By default, trails created without specific event selectors will be configured to log all read and write management events, and no data events. When an event occurs in your account, CloudTrail evaluates the event selector for all trails. For each trail, if the event matches any event selector, the trail processes and logs the event. If the event doesn't match any event selector, the trail doesn't log the event.

You can configure up to five event selectors for a trail.

You cannot apply both event selectors and advanced event selectors to a trail.

ReadWriteType -> (string)

Specify if you want your trail to log read-only events, write-only events, or all. For example, the EC2 GetConsoleOutput is a read-only API operation and RunInstances is a write-only API operation.

By default, the value is All .

IncludeManagementEvents -> (boolean)

Specify if you want your event selector to include management events for your trail.

For more information, see Management Events in the CloudTrail User Guide .

By default, the value is true .

The first copy of management events is free. You are charged for additional copies of management events that you are logging on any subsequent trail in the same Region. For more information about CloudTrail pricing, see CloudTrail Pricing .

DataResources -> (list)

CloudTrail supports data event logging for Amazon S3 objects in standard S3 buckets, Lambda functions, and Amazon DynamoDB tables with basic event selectors. You can specify up to 250 resources for an individual event selector, but the total number of data resources cannot exceed 250 across all event selectors in a trail. This limit does not apply if you configure resource logging for all data events.

For more information, see Data Events and Limits in CloudTrail in the CloudTrail User Guide .

Note

To log data events for all other resource types including objects stored in directory buckets , you must use AdvancedEventSelectors . You must also use AdvancedEventSelectors if you want to filter on the eventName field.

(structure)

You can configure the DataResource in an EventSelector to log data events for the following three resource types:

  • AWS::DynamoDB::Table
  • AWS::Lambda::Function
  • AWS::S3::Object

To log data events for all other resource types including objects stored in directory buckets , you must use AdvancedEventSelectors . You must also use AdvancedEventSelectors if you want to filter on the eventName field.

Configure the DataResource to specify the resource type and resource ARNs for which you want to log data events.

Note

The total number of allowed data resources is 250. This number can be distributed between 1 and 5 event selectors, but the total cannot exceed 250 across all selectors for the trail.

The following example demonstrates how logging works when you configure logging of all data events for a general purpose bucket named amzn-s3-demo-bucket1 . In this example, the CloudTrail user specified an empty prefix, and the option to log both Read and Write data events.

  • A user uploads an image file to amzn-s3-demo-bucket1 .
  • The PutObject API operation is an Amazon S3 object-level API. It is recorded as a data event in CloudTrail. Because the CloudTrail user specified an S3 bucket with an empty prefix, events that occur on any object in that bucket are logged. The trail processes and logs the event.
  • A user uploads an object to an Amazon S3 bucket named arn:aws:s3:::amzn-s3-demo-bucket1 .
  • The PutObject API operation occurred for an object in an S3 bucket that the CloudTrail user didn't specify for the trail. The trail doesn’t log the event.

The following example demonstrates how logging works when you configure logging of Lambda data events for a Lambda function named MyLambdaFunction , but not for all Lambda functions.

  • A user runs a script that includes a call to the MyLambdaFunction function and the MyOtherLambdaFunction function.
  • The Invoke API operation on MyLambdaFunction is an Lambda API. It is recorded as a data event in CloudTrail. Because the CloudTrail user specified logging data events for MyLambdaFunction , any invocations of that function are logged. The trail processes and logs the event.
  • The Invoke API operation on MyOtherLambdaFunction is an Lambda API. Because the CloudTrail user did not specify logging data events for all Lambda functions, the Invoke operation for MyOtherLambdaFunction does not match the function specified for the trail. The trail doesn’t log the event.

Type -> (string)

The resource type in which you want to log data events. You can specify the following basic event selector resource types:

  • AWS::DynamoDB::Table
  • AWS::Lambda::Function
  • AWS::S3::Object

Additional resource types are available through advanced event selectors. For more information, see AdvancedEventSelector .

Values -> (list)

An array of Amazon Resource Name (ARN) strings or partial ARN strings for the specified resource type.

  • To log data events for all objects in all S3 buckets in your Amazon Web Services account, specify the prefix as arn:aws:s3 .

Note

This also enables logging of data event activity performed by any user or role in your Amazon Web Services account, even if that activity is performed on a bucket that belongs to another Amazon Web Services account.
  • To log data events for all objects in an S3 bucket, specify the bucket and an empty object prefix such as arn:aws:s3:::amzn-s3-demo-bucket1/ . The trail logs data events for all objects in this S3 bucket.
  • To log data events for specific objects, specify the S3 bucket and object prefix such as arn:aws:s3:::amzn-s3-demo-bucket1/example-images . The trail logs data events for objects in this S3 bucket that match the prefix.
  • To log data events for all Lambda functions in your Amazon Web Services account, specify the prefix as arn:aws:lambda .

Note

This also enables logging of Invoke activity performed by any user or role in your Amazon Web Services account, even if that activity is performed on a function that belongs to another Amazon Web Services account.
  • To log data events for a specific Lambda function, specify the function ARN.

Note

Lambda function ARNs are exact. For example, if you specify a function ARN arn:aws:lambda:us-west-2:111111111111:function:helloworld , data events will only be logged for arn:aws:lambda:us-west-2:111111111111:function:helloworld . They will not be logged for arn:aws:lambda:us-west-2:111111111111:function:helloworld2 .
  • To log data events for all DynamoDB tables in your Amazon Web Services account, specify the prefix as arn:aws:dynamodb .

(string)

ExcludeManagementEventSources -> (list)

An optional list of service event sources from which you do not want management events to be logged on your trail. In this release, the list can be empty (disables the filter), or it can filter out Key Management Service or Amazon RDS Data API events by containing kms.amazonaws.com or rdsdata.amazonaws.com . By default, ExcludeManagementEventSources is empty, and KMS and Amazon RDS Data API events are logged to your trail. You can exclude management event sources only in Regions that support the event source.

(string)

AdvancedEventSelectors -> (list)

The advanced event selectors that are configured for the trail.

(structure)

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

The following additional fields are available for event data stores:

  • eventName
  • eventType
  • sessionCredentialFromConsole
  • userIdentity.arn
Supported CloudTrail event record fields for data events
  • eventCategory (required)
  • resources.type (required)
  • readOnly
  • eventName
  • resources.ARN

The following additional fields are available for event data stores:

  • eventSource
  • eventType
  • sessionCredentialFromConsole
  • userIdentity.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.

(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 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 . The following additional fields are available for event data stores: eventName , eventType , sessionCredentialFromConsole , and userIdentity.arn .

For CloudTrail data events, supported fields include eventCategory (required), resources.type (required), eventName , readOnly , and resources.ARN . The following additional fields are available for event data stores: eventSource , eventType , sessionCredentialFromConsole , and userIdentity.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, data events (for event data stores only), and network activity events. For management events for trails, 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 management and data events for event data stores, you can use it to include or exclude any event source and can use any operator. 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, management events (for event data stores only), and network activity events. You can use any operator with eventName . You can use it to filter in or filter out specific events. You can have multiple values for this field, 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 events outside of Amazon Web Services, the value must be ActivityAuditLog .
  • **eventType ** - This is an optional field available only for event data stores, which is used to filter management and data events on the event type. For information about available event types, see CloudTrail record contents in the CloudTrail user guide .
  • **errorCode ** - This field 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.
  • **sessionCredentialFromConsole ** - This is an optional field available only for event data stores, which is used to filter management and data events based on whether the events originated from an Amazon Web Services Management Console session. sessionCredentialFromConsole can only use the Equals and NotEquals operators.
  • **resources.type ** - This field is required for CloudTrail data events. resources.type can only use the Equals operator. For a list of available resource types for data events, see Data events in the CloudTrail User Guide . You can have only one resources.type field 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 specified 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.
  • **userIdentity.arn ** - This is an optional field available only for event data stores, which is used to filter management and data events on the userIdentity ARN. You can use any operator with userIdentity.arn . For more information on the userIdentity element, see CloudTrail userIdentity element in the CloudTrail User Guide .
  • **vpcEndpointId ** - This field 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)