Class: AWS.CloudTrail

var params = {
  QueryId: 'STRING_VALUE', /* required */
  EventDataStore: 'STRING_VALUE'
};
cloudtrail.cancelQuery(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • EventDataStore — (String)

    The ARN (or the ID suffix of the ARN) of an event data store on which the specified query is running.

  • QueryId — (String)

    The ID of the query that you want to cancel. The QueryId comes from the response of a StartQuery operation.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • QueryId — (String)

      The ID of the canceled query.

    • QueryStatus — (String)

      Shows the status of a query after a CancelQuery request. Typically, the values shown are either RUNNING or CANCELLED.

      Possible values include:
      • "QUEUED"
      • "RUNNING"
      • "FINISHED"
      • "FAILED"
      • "CANCELLED"
      • "TIMED_OUT"

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  Destinations: [ /* required */
    {
      Location: 'STRING_VALUE', /* required */
      Type: EVENT_DATA_STORE | AWS_SERVICE /* required */
    },
    /* more items */
  ],
  Name: 'STRING_VALUE', /* required */
  Source: 'STRING_VALUE', /* required */
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE'
    },
    /* more items */
  ]
};
cloudtrail.createChannel(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • Name — (String)

    The name of the channel.

  • Source — (String)

    The name of the partner or external event source. You cannot change this name after you create the channel. A maximum of one channel is allowed per source.

    A source can be either Custom for all valid non-Amazon Web Services events, or the name of a partner event source. For information about the source names for available partners, see Additional information about integration partners in the CloudTrail User Guide.

  • Destinations — (Array<map>)

    One or more event data stores to which events arriving through a channel will be logged.

    • Type — required — (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.

      Possible values include:
      • "EVENT_DATA_STORE"
      • "AWS_SERVICE"
    • Location — required — (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.

  • Tags — (Array<map>)

    A list of tags.

    • Key — required — (String)

      The key in a key-value pair. The key must be must be no longer than 128 Unicode characters. The key must be unique for the resource to which it applies.

    • Value — (String)

      The value in a key-value pair of a tag. The value must be no longer than 256 Unicode characters.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • ChannelArn — (String)

      The Amazon Resource Name (ARN) of the new channel.

    • Name — (String)

      The name of the new channel.

    • Source — (String)

      The partner or external event source name.

    • Destinations — (Array<map>)

      The event data stores that log the events arriving through the channel.

      • Type — required — (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.

        Possible values include:
        • "EVENT_DATA_STORE"
        • "AWS_SERVICE"
      • Location — required — (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.

    • Tags — (Array<map>)

      A list of tags.

      • Key — required — (String)

        The key in a key-value pair. The key must be must be no longer than 128 Unicode characters. The key must be unique for the resource to which it applies.

      • Value — (String)

        The value in a key-value pair of a tag. The value must be no longer than 256 Unicode characters.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  Name: 'STRING_VALUE', /* required */
  AdvancedEventSelectors: [
    {
      FieldSelectors: [ /* required */
        {
          Field: 'STRING_VALUE', /* required */
          EndsWith: [
            'STRING_VALUE',
            /* more items */
          ],
          Equals: [
            'STRING_VALUE',
            /* more items */
          ],
          NotEndsWith: [
            'STRING_VALUE',
            /* more items */
          ],
          NotEquals: [
            'STRING_VALUE',
            /* more items */
          ],
          NotStartsWith: [
            'STRING_VALUE',
            /* more items */
          ],
          StartsWith: [
            'STRING_VALUE',
            /* more items */
          ]
        },
        /* more items */
      ],
      Name: 'STRING_VALUE'
    },
    /* more items */
  ],
  BillingMode: EXTENDABLE_RETENTION_PRICING | FIXED_RETENTION_PRICING,
  KmsKeyId: 'STRING_VALUE',
  MultiRegionEnabled: true || false,
  OrganizationEnabled: true || false,
  RetentionPeriod: 'NUMBER_VALUE',
  StartIngestion: true || false,
  TagsList: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE'
    },
    /* more items */
  ],
  TerminationProtectionEnabled: true || false
};
cloudtrail.createEventDataStore(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • Name — (String)

    The name of the event data store.

  • AdvancedEventSelectors — (Array<map>)

    The advanced event selectors to use to select the events for the data store. You can configure up to five advanced event selectors for each event data store.

    For more information about how to use advanced event selectors to log CloudTrail events, see Log events by using advanced event selectors in the CloudTrail User Guide.

    For more information about how to use advanced event selectors to include Config configuration items in your event data store, see Create an event data store for Config configuration items in the CloudTrail User Guide.

    For more information about how to use advanced event selectors to include events outside of Amazon Web Services events in your event data store, see Create an integration to log events from outside Amazon Web Services in the CloudTrail User Guide.

    • Name — (String)

      An optional, descriptive name for an advanced event selector, such as "Log data events for only two S3 buckets".

    • FieldSelectors — required — (Array<map>)

      Contains all selector statements in an advanced event selector.

      • Field — required — (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 readOnly, eventCategory, and eventSource.

        For CloudTrail data events, supported fields include readOnly, eventCategory, eventName, resources.type, and resources.ARN.

        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 - 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 to NotEquals kms.amazonaws.com or NotEquals rdsdata.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 management events, the value must be Management.

          • For CloudTrail data events, the value must be Data.

          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.

        • 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::AppConfig::Configuration

          • AWS::B2BI::Transformer

          • AWS::Bedrock::AgentAlias

          • AWS::Bedrock::KnowledgeBase

          • AWS::Cassandra::Table

          • AWS::CloudFront::KeyValueStore

          • AWS::CloudTrail::Channel

          • AWS::CodeWhisperer::Customization

          • AWS::CodeWhisperer::Profile

          • AWS::Cognito::IdentityPool

          • AWS::DynamoDB::Stream

          • 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::KinesisVideo::Stream

          • AWS::ManagedBlockchain::Network

          • AWS::ManagedBlockchain::Node

          • AWS::MedicalImaging::Datastore

          • AWS::NeptuneGraph::Graph

          • AWS::PCAConnectorAD::Connector

          • AWS::QApps:QApp

          • AWS::QBusiness::Application

          • AWS::QBusiness::DataSource

          • AWS::QBusiness::Index

          • AWS::QBusiness::WebExperience

          • AWS::RDS::DBCluster

          • AWS::S3::AccessPoint

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

          Note: You can't use the resources.ARN field to filter resource types that do not have ARNs.

          The resources.ARN field can be set one of the following.

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

          • arn:<partition>:appconfig:<region>:<account_ID>:application/<application_ID>/environment/<environment_ID>/configuration/<configuration_profile_ID>

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

          • arn:<partition>:b2bi:<region>:<account_ID>:transformer/<transformer_ID>

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

          • arn:<partition>:bedrock:<region>:<account_ID>:agent-alias/<agent_ID>/<alias_ID>

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

          • arn:<partition>:bedrock:<region>:<account_ID>:knowledge-base/<knowledge_base_ID>

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

          • arn:<partition>:cassandra:<region>:<account_ID>:/keyspace/<keyspace_name>/table/<table_name>

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

          • arn:<partition>:cloudfront:<region>:<account_ID>:key-value-store/<KVS_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::Customization, and the operator is set to Equals or NotEquals, the ARN must be in the following format:

          • arn:<partition>:codewhisperer:<region>:<account_ID>:customization/<customization_ID>

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

          • arn:<partition>:greengrass:<region>:<account_ID>:components/<component_name>

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

          • arn:<partition>:greengrass:<region>:<account_ID>:deployments/<deployment_ID

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

          • arn:<partition>:iot:<region>:<account_ID>:cert/<certificate_ID>

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

          • arn:<partition>:iot:<region>:<account_ID>:thing/<thing_ID>

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

          • arn:<partition>:iotsitewise:<region>:<account_ID>:asset/<asset_ID>

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

          • arn:<partition>:iotsitewise:<region>:<account_ID>:timeseries/<timeseries_ID>

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

          • arn:<partition>:iottwinmaker:<region>:<account_ID>:workspace/<workspace_ID>/entity/<entity_ID>

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

          • arn:<partition>:iottwinmaker:<region>:<account_ID>:workspace/<workspace_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::KinesisVideo::Stream, and the operator is set to Equals or NotEquals, the ARN must be in the following format:

          • arn:<partition>:kinesisvideo:<region>:<account_ID>:stream/<stream_name>/<creation_time>

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

          • arn:<partition>:managedblockchain:::networks/<network_name>

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

          • arn:<partition>:medical-imaging:<region>:<account_ID>:datastore/<data_store_ID>

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

          • arn:<partition>:neptune-graph:<region>:<account_ID>:graph/<graph_ID>

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

          • arn:<partition>:pca-connector-ad:<region>:<account_ID>:connector/<connector_ID>

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

          • arn:<partition>:qapps:<region>:<account_ID>:application/<application_UUID>/qapp/<qapp_UUID>

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

          • arn:<partition>:qbusiness:<region>:<account_ID>:application/<application_ID>

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

          • arn:<partition>:qbusiness:<region>:<account_ID>:application/<application_ID>/index/<index_ID>/data-source/<datasource_ID>

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

          • arn:<partition>:qbusiness:<region>:<account_ID>:application/<application_ID>/index/<index_ID>

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

          • arn:<partition>:qbusiness:<region>:<account_ID>:application/<application_ID>/web-experience/<web_experience_ID>

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

          • arn:<partition>:rds:<region>:<account_ID>:cluster/<cluster_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>

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

          • arn:<partition>:sagemaker:<region>:<account_ID>:endpoint/<endpoint_name>

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

          • arn:<partition>:scn:<region>:<account_ID>:instance/<instance_ID>

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

          • arn:<partition>:servicediscovery:<region>:<account_ID>:namespace/<namespace_ID>

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

          • arn:<partition>:servicediscovery:<region>:<account_ID>:service/<service_ID>

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

          • arn:<partition>:sns:<region>:<account_ID>:endpoint/<endpoint_type>/<endpoint_name>/<endpoint_ID>

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

          • arn:<partition>:sns:<region>:<account_ID>:<topic_name>

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

          • arn:<partition>:sqs:<region>:<account_ID>:<queue_name>

          When resources.type equals AWS::SSM::ManagedNode, and the operator is set to Equals or NotEquals, the ARN must be in one of the following formats:

          • arn:<partition>:ssm:<region>:<account_ID>:managed-instance/<instance_ID>

          • arn:<partition>:ec2:<region>:<account_ID>:instance/<instance_ID>

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

          • arn:<partition>:ssmmessages:<region>:<account_ID>:control-channel/<channel_ID>

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

          • arn:<partition>:swf:<region>:<account_ID>:domain/<domain_name>

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

          • arn:<partition>:thinclient:<region>:<account_ID>:device/<device_ID>

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

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

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

          • arn:<partition>:timestream:<region>:<account_ID>:database/<database_name>

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

          • arn:<partition>:timestream:<region>:<account_ID>:database/<database_name>/table/<table_name>

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

          • arn:<partition>:verifiedpermissions:<region>:<account_ID>:policy-store/<policy_store_UUID>

      • Equals — (Array<String>)

        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.

      • StartsWith — (Array<String>)

        An operator that includes events that match the first few characters of the event record field specified as the value of Field.

      • EndsWith — (Array<String>)

        An operator that includes events that match the last few characters of the event record field specified as the value of Field.

      • NotEquals — (Array<String>)

        An operator that excludes events that match the exact value of the event record field specified as the value of Field.

      • NotStartsWith — (Array<String>)

        An operator that excludes events that match the first few characters of the event record field specified as the value of Field.

      • NotEndsWith — (Array<String>)

        An operator that excludes events that match the last few characters of the event record field specified as the value of Field.

  • MultiRegionEnabled — (Boolean)

    Specifies whether the event data store includes events from all Regions, or only from the Region in which the event data store is created.

  • OrganizationEnabled — (Boolean)

    Specifies whether an event data store collects events logged for an organization in Organizations.

  • RetentionPeriod — (Integer)

    The retention period of the event data store, in days. If BillingMode is set to EXTENDABLE_RETENTION_PRICING, you can set a retention period of up to 3653 days, the equivalent of 10 years. If BillingMode is set to FIXED_RETENTION_PRICING, you can set a retention period of up to 2557 days, the equivalent of seven years.

    CloudTrail Lake determines whether to retain an event by checking if the eventTime of the event is within the specified retention period. For example, if you set a retention period of 90 days, CloudTrail will remove events when the eventTime is older than 90 days.

    Note: If you plan to copy trail events to this event data store, we recommend that you consider both the age of the events that you want to copy as well as how long you want to keep the copied events in your event data store. For example, if you copy trail events that are 5 years old and specify a retention period of 7 years, the event data store will retain those events for two years.
  • TerminationProtectionEnabled — (Boolean)

    Specifies whether termination protection is enabled for the event data store. If termination protection is enabled, you cannot delete the event data store until termination protection is disabled.

  • TagsList — (Array<map>)

    A list of tags.

    • Key — required — (String)

      The key in a key-value pair. The key must be must be no longer than 128 Unicode characters. The key must be unique for the resource to which it applies.

    • Value — (String)

      The value in a key-value pair of a tag. The value must be no longer than 256 Unicode characters.

  • KmsKeyId — (String)

    Specifies the KMS key ID to use to encrypt the events delivered by CloudTrail. The value can be an alias name prefixed by alias/, a fully specified ARN to an alias, a fully specified ARN to a key, or a globally unique identifier.

    Disabling or deleting the KMS key, or removing CloudTrail permissions on the key, prevents CloudTrail from logging events to the event data store, and prevents users from querying the data in the event data store that was encrypted with the key. After you associate an event data store with a KMS key, the KMS key cannot be removed or changed. Before you disable or delete a KMS key that you are using with an event data store, delete or back up your event data store.

    CloudTrail also supports KMS multi-Region keys. For more information about multi-Region keys, see Using multi-Region keys in the Key Management Service Developer Guide.

    Examples:

    • alias/MyAliasName

    • arn:aws:kms:us-east-2:123456789012:alias/MyAliasName

    • arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012

    • 12345678-1234-1234-1234-123456789012

  • StartIngestion — (Boolean)

    Specifies whether the event data store should start ingesting live events. The default is true.

  • BillingMode — (String)

    The billing mode for the event data store determines the cost for ingesting events and the default and maximum retention period for the event data store.

    The following are the possible values:

    • EXTENDABLE_RETENTION_PRICING - This billing mode is generally recommended if you want a flexible retention period of up to 3653 days (about 10 years). The default retention period for this billing mode is 366 days.

    • FIXED_RETENTION_PRICING - This billing mode is recommended if you expect to ingest more than 25 TB of event data per month and need a retention period of up to 2557 days (about 7 years). The default retention period for this billing mode is 2557 days.

    The default value is EXTENDABLE_RETENTION_PRICING.

    For more information about CloudTrail pricing, see CloudTrail Pricing and Managing CloudTrail Lake costs.

    Possible values include:
    • "EXTENDABLE_RETENTION_PRICING"
    • "FIXED_RETENTION_PRICING"

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • EventDataStoreArn — (String)

      The ARN of the event data store.

    • Name — (String)

      The name of the event data store.

    • Status — (String)

      The status of event data store creation.

      Possible values include:
      • "CREATED"
      • "ENABLED"
      • "PENDING_DELETION"
      • "STARTING_INGESTION"
      • "STOPPING_INGESTION"
      • "STOPPED_INGESTION"
    • AdvancedEventSelectors — (Array<map>)

      The advanced event selectors that were used to select the events for the data store.

      • Name — (String)

        An optional, descriptive name for an advanced event selector, such as "Log data events for only two S3 buckets".

      • FieldSelectors — required — (Array<map>)

        Contains all selector statements in an advanced event selector.

        • Field — required — (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 readOnly, eventCategory, and eventSource.

          For CloudTrail data events, supported fields include readOnly, eventCategory, eventName, resources.type, and resources.ARN.

          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 - 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 to NotEquals kms.amazonaws.com or NotEquals rdsdata.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 management events, the value must be Management.

            • For CloudTrail data events, the value must be Data.

            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.

          • 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::AppConfig::Configuration

            • AWS::B2BI::Transformer

            • AWS::Bedrock::AgentAlias

            • AWS::Bedrock::KnowledgeBase

            • AWS::Cassandra::Table

            • AWS::CloudFront::KeyValueStore

            • AWS::CloudTrail::Channel

            • AWS::CodeWhisperer::Customization

            • AWS::CodeWhisperer::Profile

            • AWS::Cognito::IdentityPool

            • AWS::DynamoDB::Stream

            • 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::KinesisVideo::Stream

            • AWS::ManagedBlockchain::Network

            • AWS::ManagedBlockchain::Node

            • AWS::MedicalImaging::Datastore

            • AWS::NeptuneGraph::Graph

            • AWS::PCAConnectorAD::Connector

            • AWS::QApps:QApp

            • AWS::QBusiness::Application

            • AWS::QBusiness::DataSource

            • AWS::QBusiness::Index

            • AWS::QBusiness::WebExperience

            • AWS::RDS::DBCluster

            • AWS::S3::AccessPoint

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

            Note: You can't use the resources.ARN field to filter resource types that do not have ARNs.

            The resources.ARN field can be set one of the following.

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

            • arn:<partition>:appconfig:<region>:<account_ID>:application/<application_ID>/environment/<environment_ID>/configuration/<configuration_profile_ID>

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

            • arn:<partition>:b2bi:<region>:<account_ID>:transformer/<transformer_ID>

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

            • arn:<partition>:bedrock:<region>:<account_ID>:agent-alias/<agent_ID>/<alias_ID>

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

            • arn:<partition>:bedrock:<region>:<account_ID>:knowledge-base/<knowledge_base_ID>

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

            • arn:<partition>:cassandra:<region>:<account_ID>:/keyspace/<keyspace_name>/table/<table_name>

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

            • arn:<partition>:cloudfront:<region>:<account_ID>:key-value-store/<KVS_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::Customization, and the operator is set to Equals or NotEquals, the ARN must be in the following format:

            • arn:<partition>:codewhisperer:<region>:<account_ID>:customization/<customization_ID>

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

            • arn:<partition>:greengrass:<region>:<account_ID>:components/<component_name>

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

            • arn:<partition>:greengrass:<region>:<account_ID>:deployments/<deployment_ID

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

            • arn:<partition>:iot:<region>:<account_ID>:cert/<certificate_ID>

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

            • arn:<partition>:iot:<region>:<account_ID>:thing/<thing_ID>

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

            • arn:<partition>:iotsitewise:<region>:<account_ID>:asset/<asset_ID>

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

            • arn:<partition>:iotsitewise:<region>:<account_ID>:timeseries/<timeseries_ID>

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

            • arn:<partition>:iottwinmaker:<region>:<account_ID>:workspace/<workspace_ID>/entity/<entity_ID>

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

            • arn:<partition>:iottwinmaker:<region>:<account_ID>:workspace/<workspace_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::KinesisVideo::Stream, and the operator is set to Equals or NotEquals, the ARN must be in the following format:

            • arn:<partition>:kinesisvideo:<region>:<account_ID>:stream/<stream_name>/<creation_time>

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

            • arn:<partition>:managedblockchain:::networks/<network_name>

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

            • arn:<partition>:medical-imaging:<region>:<account_ID>:datastore/<data_store_ID>

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

            • arn:<partition>:neptune-graph:<region>:<account_ID>:graph/<graph_ID>

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

            • arn:<partition>:pca-connector-ad:<region>:<account_ID>:connector/<connector_ID>

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

            • arn:<partition>:qapps:<region>:<account_ID>:application/<application_UUID>/qapp/<qapp_UUID>

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

            • arn:<partition>:qbusiness:<region>:<account_ID>:application/<application_ID>

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

            • arn:<partition>:qbusiness:<region>:<account_ID>:application/<application_ID>/index/<index_ID>/data-source/<datasource_ID>

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

            • arn:<partition>:qbusiness:<region>:<account_ID>:application/<application_ID>/index/<index_ID>

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

            • arn:<partition>:qbusiness:<region>:<account_ID>:application/<application_ID>/web-experience/<web_experience_ID>

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

            • arn:<partition>:rds:<region>:<account_ID>:cluster/<cluster_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>

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

            • arn:<partition>:sagemaker:<region>:<account_ID>:endpoint/<endpoint_name>

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

            • arn:<partition>:scn:<region>:<account_ID>:instance/<instance_ID>

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

            • arn:<partition>:servicediscovery:<region>:<account_ID>:namespace/<namespace_ID>

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

            • arn:<partition>:servicediscovery:<region>:<account_ID>:service/<service_ID>

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

            • arn:<partition>:sns:<region>:<account_ID>:endpoint/<endpoint_type>/<endpoint_name>/<endpoint_ID>

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

            • arn:<partition>:sns:<region>:<account_ID>:<topic_name>

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

            • arn:<partition>:sqs:<region>:<account_ID>:<queue_name>

            When resources.type equals AWS::SSM::ManagedNode, and the operator is set to Equals or NotEquals, the ARN must be in one of the following formats:

            • arn:<partition>:ssm:<region>:<account_ID>:managed-instance/<instance_ID>

            • arn:<partition>:ec2:<region>:<account_ID>:instance/<instance_ID>

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

            • arn:<partition>:ssmmessages:<region>:<account_ID>:control-channel/<channel_ID>

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

            • arn:<partition>:swf:<region>:<account_ID>:domain/<domain_name>

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

            • arn:<partition>:thinclient:<region>:<account_ID>:device/<device_ID>

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

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

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

            • arn:<partition>:timestream:<region>:<account_ID>:database/<database_name>

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

            • arn:<partition>:timestream:<region>:<account_ID>:database/<database_name>/table/<table_name>

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

            • arn:<partition>:verifiedpermissions:<region>:<account_ID>:policy-store/<policy_store_UUID>

        • Equals — (Array<String>)

          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.

        • StartsWith — (Array<String>)

          An operator that includes events that match the first few characters of the event record field specified as the value of Field.

        • EndsWith — (Array<String>)

          An operator that includes events that match the last few characters of the event record field specified as the value of Field.

        • NotEquals — (Array<String>)

          An operator that excludes events that match the exact value of the event record field specified as the value of Field.

        • NotStartsWith — (Array<String>)

          An operator that excludes events that match the first few characters of the event record field specified as the value of Field.

        • NotEndsWith — (Array<String>)

          An operator that excludes events that match the last few characters of the event record field specified as the value of Field.

    • MultiRegionEnabled — (Boolean)

      Indicates whether the event data store collects events from all Regions, or only from the Region in which it was created.

    • OrganizationEnabled — (Boolean)

      Indicates whether an event data store is collecting logged events for an organization in Organizations.

    • RetentionPeriod — (Integer)

      The retention period of an event data store, in days.

    • TerminationProtectionEnabled — (Boolean)

      Indicates whether termination protection is enabled for the event data store.

    • TagsList — (Array<map>)

      A list of tags.

      • Key — required — (String)

        The key in a key-value pair. The key must be must be no longer than 128 Unicode characters. The key must be unique for the resource to which it applies.

      • Value — (String)

        The value in a key-value pair of a tag. The value must be no longer than 256 Unicode characters.

    • CreatedTimestamp — (Date)

      The timestamp that shows when the event data store was created.

    • UpdatedTimestamp — (Date)

      The timestamp that shows when an event data store was updated, if applicable. UpdatedTimestamp is always either the same or newer than the time shown in CreatedTimestamp.

    • KmsKeyId — (String)

      Specifies the KMS key ID that encrypts the events 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

    • BillingMode — (String)

      The billing mode for the event data store.

      Possible values include:
      • "EXTENDABLE_RETENTION_PRICING"
      • "FIXED_RETENTION_PRICING"

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  Name: 'STRING_VALUE', /* required */
  S3BucketName: 'STRING_VALUE', /* required */
  CloudWatchLogsLogGroupArn: 'STRING_VALUE',
  CloudWatchLogsRoleArn: 'STRING_VALUE',
  EnableLogFileValidation: true || false,
  IncludeGlobalServiceEvents: true || false,
  IsMultiRegionTrail: true || false,
  IsOrganizationTrail: true || false,
  KmsKeyId: 'STRING_VALUE',
  S3KeyPrefix: 'STRING_VALUE',
  SnsTopicName: 'STRING_VALUE',
  TagsList: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE'
    },
    /* more items */
  ]
};
cloudtrail.createTrail(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • Name — (String)

    Specifies the name of the trail. The name 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)

  • S3BucketName — (String)

    Specifies the name of the Amazon S3 bucket designated for publishing log files. For information about bucket naming rules, see Bucket naming rules in the Amazon Simple Storage Service User Guide.

  • 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. The maximum length is 200 characters.

  • SnsTopicName — (String)

    Specifies the name of the Amazon SNS topic defined for notification of log file delivery. The maximum length is 256 characters.

  • IncludeGlobalServiceEvents — (Boolean)

    Specifies whether the trail is publishing events from global services such as IAM to the log files.

  • IsMultiRegionTrail — (Boolean)

    Specifies whether the trail is created in the current Region or in all Regions. The default is false, which creates a trail only in the Region where you are signed in. As a best practice, consider creating trails that log events in all Regions.

  • EnableLogFileValidation — (Boolean)

    Specifies whether log file integrity validation is enabled. The default is false.

    Note: When you disable log file integrity validation, the chain of digest files is broken after one hour. CloudTrail does not create digest files for log files that were delivered during a period in which log file integrity validation was disabled. For example, if you enable log file integrity validation at noon on January 1, disable it at noon on January 2, and re-enable it at noon on January 10, digest files will not be created for the log files delivered from noon on January 2 to noon on January 10. The same applies whenever you stop CloudTrail logging or delete a trail.
  • CloudWatchLogsLogGroupArn — (String)

    Specifies a log group name using an Amazon Resource Name (ARN), a unique identifier that represents the log group to which CloudTrail logs will be delivered. You must use a log group that exists in your account.

    Not required unless you specify CloudWatchLogsRoleArn.

  • CloudWatchLogsRoleArn — (String)

    Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's log group. You must use a role that exists in your account.

  • KmsKeyId — (String)

    Specifies the KMS key ID to use to encrypt the logs delivered by CloudTrail. The value can be an alias name prefixed by alias/, a fully specified ARN to an alias, a fully specified ARN to a key, or a globally unique identifier.

    CloudTrail also supports KMS multi-Region keys. For more information about multi-Region keys, see Using multi-Region keys in the Key Management Service Developer Guide.

    Examples:

    • alias/MyAliasName

    • arn:aws:kms:us-east-2:123456789012:alias/MyAliasName

    • arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012

    • 12345678-1234-1234-1234-123456789012

  • IsOrganizationTrail — (Boolean)

    Specifies whether the trail is created for all accounts in an organization in Organizations, or only for the current Amazon Web Services account. The default is false, and cannot be true unless the call is made on behalf of an Amazon Web Services account that is the management account or delegated administrator account for an organization in Organizations.

  • TagsList — (Array<map>)

    A list of tags.

    • Key — required — (String)

      The key in a key-value pair. The key must be must be no longer than 128 Unicode characters. The key must be unique for the resource to which it applies.

    • Value — (String)

      The value in a key-value pair of a tag. The value must be no longer than 256 Unicode characters.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • Name — (String)

      Specifies the name of the trail.

    • S3BucketName — (String)

      Specifies the name of the Amazon S3 bucket designated for publishing log files.

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

    • 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 format of a topic ARN is:

      arn:aws:sns:us-east-2:123456789012:MyTopic

    • IncludeGlobalServiceEvents — (Boolean)

      Specifies whether the trail is publishing events from global services such as IAM to the log files.

    • IsMultiRegionTrail — (Boolean)

      Specifies whether the trail exists in one Region or in all Regions.

    • TrailARN — (String)

      Specifies the ARN of the trail that was created. The format of a trail ARN is:

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

    • LogFileValidationEnabled — (Boolean)

      Specifies whether log file integrity validation is enabled.

    • CloudWatchLogsLogGroupArn — (String)

      Specifies the Amazon Resource Name (ARN) of 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 events 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

    • IsOrganizationTrail — (Boolean)

      Specifies whether the trail is an organization trail.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  Channel: 'STRING_VALUE' /* required */
};
cloudtrail.deleteChannel(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • Channel — (String)

    The ARN or the UUID value of the channel that you want to delete.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  EventDataStore: 'STRING_VALUE' /* required */
};
cloudtrail.deleteEventDataStore(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • EventDataStore — (String)

    The ARN (or the ID suffix of the ARN) of the event data store to delete.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  ResourceArn: 'STRING_VALUE' /* required */
};
cloudtrail.deleteResourcePolicy(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • ResourceArn — (String)

    The Amazon Resource Name (ARN) of the CloudTrail channel you're deleting the resource-based policy from. The following is the format of a resource ARN: arn:aws:cloudtrail:us-east-2:123456789012:channel/MyChannel.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  Name: 'STRING_VALUE' /* required */
};
cloudtrail.deleteTrail(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • Name — (String)

    Specifies the name or the CloudTrail ARN of the trail to be deleted. The following is the format of a trail ARN. arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  DelegatedAdminAccountId: 'STRING_VALUE' /* required */
};
cloudtrail.deregisterOrganizationDelegatedAdmin(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • DelegatedAdminAccountId — (String)

    A delegated administrator account ID. This is a member account in an organization that is currently designated as a delegated administrator.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  EventDataStore: 'STRING_VALUE',
  QueryAlias: 'STRING_VALUE',
  QueryId: 'STRING_VALUE'
};
cloudtrail.describeQuery(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • EventDataStore — (String)

    The ARN (or the ID suffix of the ARN) of an event data store on which the specified query was run.

  • QueryId — (String)

    The query ID.

  • QueryAlias — (String)

    The alias that identifies a query template.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • QueryId — (String)

      The ID of the query.

    • QueryString — (String)

      The SQL code of a query.

    • QueryStatus — (String)

      The status of a query. Values for QueryStatus include QUEUED, RUNNING, FINISHED, FAILED, TIMED_OUT, or CANCELLED

      Possible values include:
      • "QUEUED"
      • "RUNNING"
      • "FINISHED"
      • "FAILED"
      • "CANCELLED"
      • "TIMED_OUT"
    • QueryStatistics — (map)

      Metadata about a query, including the number of events that were matched, the total number of events scanned, the query run time in milliseconds, and the query's creation time.

      • EventsMatched — (Integer)

        The number of events that matched a query.

      • EventsScanned — (Integer)

        The number of events that the query scanned in the event data store.

      • BytesScanned — (Integer)

        The total bytes that the query scanned in the event data store. This value matches the number of bytes for which your account is billed for the query, unless the query is still running.

      • ExecutionTimeInMillis — (Integer)

        The query's run time, in milliseconds.

      • CreationTime — (Date)

        The creation time of the query.

    • ErrorMessage — (String)

      The error message returned if a query failed.

    • DeliveryS3Uri — (String)

      The URI for the S3 bucket where CloudTrail delivered query results, if applicable.

    • DeliveryStatus — (String)

      The delivery status.

      Possible values include:
      • "SUCCESS"
      • "FAILED"
      • "FAILED_SIGNING_FILE"
      • "PENDING"
      • "RESOURCE_NOT_FOUND"
      • "ACCESS_DENIED"
      • "ACCESS_DENIED_SIGNING_FILE"
      • "CANCELLED"
      • "UNKNOWN"

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  includeShadowTrails: true || false,
  trailNameList: [
    'STRING_VALUE',
    /* more items */
  ]
};
cloudtrail.describeTrails(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • trailNameList — (Array<String>)

    Specifies a list of trail names, trail ARNs, or both, of the trails to describe. The format of a trail ARN is:

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

    If an empty list is specified, information for the trail in the current Region is returned.

    • If an empty list is specified and IncludeShadowTrails is false, then information for all trails in the current Region is returned.

    • If an empty list is specified and IncludeShadowTrails is null or true, then information for all trails in the current Region and any associated shadow trails in other Regions is returned.

    Note: If one or more trail names are specified, information is returned only if the names match the names of trails belonging only to the current Region and current account. To return information about a trail in another Region, you must specify its trail ARN.
  • includeShadowTrails — (Boolean)

    Specifies whether to include shadow trails in the response. A shadow trail is the replication in a Region of a trail that was created in a different Region, or in the case of an organization trail, the replication of an organization trail in member accounts. If you do not include shadow trails, organization trails in a member account and Region replication trails will not be returned. The default is true.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • trailList — (Array<map>)

      The list of trail objects. Trail objects with string values are only returned if values for the objects exist in a trail's configuration. For example, SNSTopicName and SNSTopicARN are only returned in results if a trail is configured to send SNS notifications. Similarly, KMSKeyId only appears in results if a trail's log files are encrypted with KMS customer managed keys.

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

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

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  EventDataStore: 'STRING_VALUE' /* required */
};
cloudtrail.disableFederation(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • EventDataStore — (String)

    The ARN (or ID suffix of the ARN) of the event data store for which you want to disable Lake query federation.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • EventDataStoreArn — (String)

      The ARN of the event data store for which you disabled Lake query federation.

    • FederationStatus — (String)

      The federation status.

      Possible values include:
      • "ENABLING"
      • "ENABLED"
      • "DISABLING"
      • "DISABLED"

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  EventDataStore: 'STRING_VALUE', /* required */
  FederationRoleArn: 'STRING_VALUE' /* required */
};
cloudtrail.enableFederation(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • EventDataStore — (String)

    The ARN (or ID suffix of the ARN) of the event data store for which you want to enable Lake query federation.

  • FederationRoleArn — (String)

    The ARN of the federation role to use for the event data store. Amazon Web Services services like Lake Formation use this federation role to access data for the federated event data store. The federation role must exist in your account and provide the required minimum permissions.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • EventDataStoreArn — (String)

      The ARN of the event data store for which you enabled Lake query federation.

    • FederationStatus — (String)

      The federation status.

      Possible values include:
      • "ENABLING"
      • "ENABLED"
      • "DISABLING"
      • "DISABLED"
    • FederationRoleArn — (String)

      The ARN of the federation role.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  Channel: 'STRING_VALUE' /* required */
};
cloudtrail.getChannel(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • Channel — (String)

    The ARN or UUID of a channel.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • 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 — (map)

      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 — (Array<map>)

        The advanced event selectors that are configured for the channel.

        • Name — (String)

          An optional, descriptive name for an advanced event selector, such as "Log data events for only two S3 buckets".

        • FieldSelectors — required — (Array<map>)

          Contains all selector statements in an advanced event selector.

          • Field — required — (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 readOnly, eventCategory, and eventSource.

            For CloudTrail data events, supported fields include readOnly, eventCategory, eventName, resources.type, and resources.ARN.

            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 - 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 to NotEquals kms.amazonaws.com or NotEquals rdsdata.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 management events, the value must be Management.

              • For CloudTrail data events, the value must be Data.

              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.

            • 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::AppConfig::Configuration

              • AWS::B2BI::Transformer

              • AWS::Bedrock::AgentAlias

              • AWS::Bedrock::KnowledgeBase

              • AWS::Cassandra::Table

              • AWS::CloudFront::KeyValueStore

              • AWS::CloudTrail::Channel

              • AWS::CodeWhisperer::Customization

              • AWS::CodeWhisperer::Profile

              • AWS::Cognito::IdentityPool

              • AWS::DynamoDB::Stream

              • 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::KinesisVideo::Stream

              • AWS::ManagedBlockchain::Network

              • AWS::ManagedBlockchain::Node

              • AWS::MedicalImaging::Datastore

              • AWS::NeptuneGraph::Graph

              • AWS::PCAConnectorAD::Connector

              • AWS::QApps:QApp

              • AWS::QBusiness::Application

              • AWS::QBusiness::DataSource

              • AWS::QBusiness::Index

              • AWS::QBusiness::WebExperience

              • AWS::RDS::DBCluster

              • AWS::S3::AccessPoint

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

              Note: You can't use the resources.ARN field to filter resource types that do not have ARNs.

              The resources.ARN field can be set one of the following.

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

              • arn:<partition>:appconfig:<region>:<account_ID>:application/<application_ID>/environment/<environment_ID>/configuration/<configuration_profile_ID>

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

              • arn:<partition>:b2bi:<region>:<account_ID>:transformer/<transformer_ID>

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

              • arn:<partition>:bedrock:<region>:<account_ID>:agent-alias/<agent_ID>/<alias_ID>

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

              • arn:<partition>:bedrock:<region>:<account_ID>:knowledge-base/<knowledge_base_ID>

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

              • arn:<partition>:cassandra:<region>:<account_ID>:/keyspace/<keyspace_name>/table/<table_name>

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

              • arn:<partition>:cloudfront:<region>:<account_ID>:key-value-store/<KVS_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::Customization, and the operator is set to Equals or NotEquals, the ARN must be in the following format:

              • arn:<partition>:codewhisperer:<region>:<account_ID>:customization/<customization_ID>

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

              • arn:<partition>:greengrass:<region>:<account_ID>:components/<component_name>

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

              • arn:<partition>:greengrass:<region>:<account_ID>:deployments/<deployment_ID

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

              • arn:<partition>:iot:<region>:<account_ID>:cert/<certificate_ID>

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

              • arn:<partition>:iot:<region>:<account_ID>:thing/<thing_ID>

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

              • arn:<partition>:iotsitewise:<region>:<account_ID>:asset/<asset_ID>

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

              • arn:<partition>:iotsitewise:<region>:<account_ID>:timeseries/<timeseries_ID>

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

              • arn:<partition>:iottwinmaker:<region>:<account_ID>:workspace/<workspace_ID>/entity/<entity_ID>

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

              • arn:<partition>:iottwinmaker:<region>:<account_ID>:workspace/<workspace_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::KinesisVideo::Stream, and the operator is set to Equals or NotEquals, the ARN must be in the following format:

              • arn:<partition>:kinesisvideo:<region>:<account_ID>:stream/<stream_name>/<creation_time>

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

              • arn:<partition>:managedblockchain:::networks/<network_name>

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

              • arn:<partition>:medical-imaging:<region>:<account_ID>:datastore/<data_store_ID>

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

              • arn:<partition>:neptune-graph:<region>:<account_ID>:graph/<graph_ID>

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

              • arn:<partition>:pca-connector-ad:<region>:<account_ID>:connector/<connector_ID>

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

              • arn:<partition>:qapps:<region>:<account_ID>:application/<application_UUID>/qapp/<qapp_UUID>

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

              • arn:<partition>:qbusiness:<region>:<account_ID>:application/<application_ID>

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

              • arn:<partition>:qbusiness:<region>:<account_ID>:application/<application_ID>/index/<index_ID>/data-source/<datasource_ID>

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

              • arn:<partition>:qbusiness:<region>:<account_ID>:application/<application_ID>/index/<index_ID>

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

              • arn:<partition>:qbusiness:<region>:<account_ID>:application/<application_ID>/web-experience/<web_experience_ID>

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

              • arn:<partition>:rds:<region>:<account_ID>:cluster/<cluster_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>

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

              • arn:<partition>:sagemaker:<region>:<account_ID>:endpoint/<endpoint_name>

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

              • arn:<partition>:scn:<region>:<account_ID>:instance/<instance_ID>

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

              • arn:<partition>:servicediscovery:<region>:<account_ID>:namespace/<namespace_ID>

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

              • arn:<partition>:servicediscovery:<region>:<account_ID>:service/<service_ID>

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

              • arn:<partition>:sns:<region>:<account_ID>:endpoint/<endpoint_type>/<endpoint_name>/<endpoint_ID>

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

              • arn:<partition>:sns:<region>:<account_ID>:<topic_name>

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

              • arn:<partition>:sqs:<region>:<account_ID>:<queue_name>

              When resources.type equals AWS::SSM::ManagedNode, and the operator is set to Equals or NotEquals, the ARN must be in one of the following formats:

              • arn:<partition>:ssm:<region>:<account_ID>:managed-instance/<instance_ID>

              • arn:<partition>:ec2:<region>:<account_ID>:instance/<instance_ID>

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

              • arn:<partition>:ssmmessages:<region>:<account_ID>:control-channel/<channel_ID>

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

              • arn:<partition>:swf:<region>:<account_ID>:domain/<domain_name>

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

              • arn:<partition>:thinclient:<region>:<account_ID>:device/<device_ID>

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

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

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

              • arn:<partition>:timestream:<region>:<account_ID>:database/<database_name>

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

              • arn:<partition>:timestream:<region>:<account_ID>:database/<database_name>/table/<table_name>

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

              • arn:<partition>:verifiedpermissions:<region>:<account_ID>:policy-store/<policy_store_UUID>

          • Equals — (Array<String>)

            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.

          • StartsWith — (Array<String>)

            An operator that includes events that match the first few characters of the event record field specified as the value of Field.

          • EndsWith — (Array<String>)

            An operator that includes events that match the last few characters of the event record field specified as the value of Field.

          • NotEquals — (Array<String>)

            An operator that excludes events that match the exact value of the event record field specified as the value of Field.

          • NotStartsWith — (Array<String>)

            An operator that excludes events that match the first few characters of the event record field specified as the value of Field.

          • NotEndsWith — (Array<String>)

            An operator that excludes events that match the last few characters of the event record field specified as the value of Field.

    • Destinations — (Array<map>)

      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.

      • Type — required — (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.

        Possible values include:
        • "EVENT_DATA_STORE"
        • "AWS_SERVICE"
      • Location — required — (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 — (map)

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

      • LatestIngestionSuccessTime — (Date)

        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 — (Date)

        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.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  EventDataStore: 'STRING_VALUE' /* required */
};
cloudtrail.getEventDataStore(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • EventDataStore — (String)

    The ARN (or ID suffix of the ARN) of the event data store about which you want information.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • EventDataStoreArn — (String)

      The event data store Amazon Resource Number (ARN).

    • Name — (String)

      The name of the event data store.

    • Status — (String)

      The status of an event data store.

      Possible values include:
      • "CREATED"
      • "ENABLED"
      • "PENDING_DELETION"
      • "STARTING_INGESTION"
      • "STOPPING_INGESTION"
      • "STOPPED_INGESTION"
    • AdvancedEventSelectors — (Array<map>)

      The advanced event selectors used to select events for the data store.

      • Name — (String)

        An optional, descriptive name for an advanced event selector, such as "Log data events for only two S3 buckets".

      • FieldSelectors — required — (Array<map>)

        Contains all selector statements in an advanced event selector.

        • Field — required — (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 readOnly, eventCategory, and eventSource.

          For CloudTrail data events, supported fields include readOnly, eventCategory, eventName, resources.type, and resources.ARN.

          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 - 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 to NotEquals kms.amazonaws.com or NotEquals rdsdata.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 management events, the value must be Management.

            • For CloudTrail data events, the value must be Data.

            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.

          • 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::AppConfig::Configuration

            • AWS::B2BI::Transformer

            • AWS::Bedrock::AgentAlias

            • AWS::Bedrock::KnowledgeBase

            • AWS::Cassandra::Table

            • AWS::CloudFront::KeyValueStore

            • AWS::CloudTrail::Channel

            • AWS::CodeWhisperer::Customization

            • AWS::CodeWhisperer::Profile

            • AWS::Cognito::IdentityPool

            • AWS::DynamoDB::Stream

            • 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::KinesisVideo::Stream

            • AWS::ManagedBlockchain::Network

            • AWS::ManagedBlockchain::Node

            • AWS::MedicalImaging::Datastore

            • AWS::NeptuneGraph::Graph

            • AWS::PCAConnectorAD::Connector

            • AWS::QApps:QApp

            • AWS::QBusiness::Application

            • AWS::QBusiness::DataSource

            • AWS::QBusiness::Index

            • AWS::QBusiness::WebExperience

            • AWS::RDS::DBCluster

            • AWS::S3::AccessPoint

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

            Note: You can't use the resources.ARN field to filter resource types that do not have ARNs.

            The resources.ARN field can be set one of the following.

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

            • arn:<partition>:appconfig:<region>:<account_ID>:application/<application_ID>/environment/<environment_ID>/configuration/<configuration_profile_ID>

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

            • arn:<partition>:b2bi:<region>:<account_ID>:transformer/<transformer_ID>

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

            • arn:<partition>:bedrock:<region>:<account_ID>:agent-alias/<agent_ID>/<alias_ID>

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

            • arn:<partition>:bedrock:<region>:<account_ID>:knowledge-base/<knowledge_base_ID>

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

            • arn:<partition>:cassandra:<region>:<account_ID>:/keyspace/<keyspace_name>/table/<table_name>

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

            • arn:<partition>:cloudfront:<region>:<account_ID>:key-value-store/<KVS_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::Customization, and the operator is set to Equals or NotEquals, the ARN must be in the following format:

            • arn:<partition>:codewhisperer:<region>:<account_ID>:customization/<customization_ID>

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

            • arn:<partition>:greengrass:<region>:<account_ID>:components/<component_name>

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

            • arn:<partition>:greengrass:<region>:<account_ID>:deployments/<deployment_ID

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

            • arn:<partition>:iot:<region>:<account_ID>:cert/<certificate_ID>

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

            • arn:<partition>:iot:<region>:<account_ID>:thing/<thing_ID>

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

            • arn:<partition>:iotsitewise:<region>:<account_ID>:asset/<asset_ID>

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

            • arn:<partition>:iotsitewise:<region>:<account_ID>:timeseries/<timeseries_ID>

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

            • arn:<partition>:iottwinmaker:<region>:<account_ID>:workspace/<workspace_ID>/entity/<entity_ID>

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

            • arn:<partition>:iottwinmaker:<region>:<account_ID>:workspace/<workspace_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::KinesisVideo::Stream, and the operator is set to Equals or NotEquals, the ARN must be in the following format:

            • arn:<partition>:kinesisvideo:<region>:<account_ID>:stream/<stream_name>/<creation_time>

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

            • arn:<partition>:managedblockchain:::networks/<network_name>

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

            • arn:<partition>:medical-imaging:<region>:<account_ID>:datastore/<data_store_ID>

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

            • arn:<partition>:neptune-graph:<region>:<account_ID>:graph/<graph_ID>

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

            • arn:<partition>:pca-connector-ad:<region>:<account_ID>:connector/<connector_ID>

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

            • arn:<partition>:qapps:<region>:<account_ID>:application/<application_UUID>/qapp/<qapp_UUID>

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

            • arn:<partition>:qbusiness:<region>:<account_ID>:application/<application_ID>

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

            • arn:<partition>:qbusiness:<region>:<account_ID>:application/<application_ID>/index/<index_ID>/data-source/<datasource_ID>

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

            • arn:<partition>:qbusiness:<region>:<account_ID>:application/<application_ID>/index/<index_ID>

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

            • arn:<partition>:qbusiness:<region>:<account_ID>:application/<application_ID>/web-experience/<web_experience_ID>

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

            • arn:<partition>:rds:<region>:<account_ID>:cluster/<cluster_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>

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

            • arn:<partition>:sagemaker:<region>:<account_ID>:endpoint/<endpoint_name>

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

            • arn:<partition>:scn:<region>:<account_ID>:instance/<instance_ID>

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

            • arn:<partition>:servicediscovery:<region>:<account_ID>:namespace/<namespace_ID>

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

            • arn:<partition>:servicediscovery:<region>:<account_ID>:service/<service_ID>

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

            • arn:<partition>:sns:<region>:<account_ID>:endpoint/<endpoint_type>/<endpoint_name>/<endpoint_ID>

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

            • arn:<partition>:sns:<region>:<account_ID>:<topic_name>

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

            • arn:<partition>:sqs:<region>:<account_ID>:<queue_name>

            When resources.type equals AWS::SSM::ManagedNode, and the operator is set to Equals or NotEquals, the ARN must be in one of the following formats:

            • arn:<partition>:ssm:<region>:<account_ID>:managed-instance/<instance_ID>

            • arn:<partition>:ec2:<region>:<account_ID>:instance/<instance_ID>

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

            • arn:<partition>:ssmmessages:<region>:<account_ID>:control-channel/<channel_ID>

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

            • arn:<partition>:swf:<region>:<account_ID>:domain/<domain_name>

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

            • arn:<partition>:thinclient:<region>:<account_ID>:device/<device_ID>

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

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

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

            • arn:<partition>:timestream:<region>:<account_ID>:database/<database_name>

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

            • arn:<partition>:timestream:<region>:<account_ID>:database/<database_name>/table/<table_name>

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

            • arn:<partition>:verifiedpermissions:<region>:<account_ID>:policy-store/<policy_store_UUID>

        • Equals — (Array<String>)

          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.

        • StartsWith — (Array<String>)

          An operator that includes events that match the first few characters of the event record field specified as the value of Field.

        • EndsWith — (Array<String>)

          An operator that includes events that match the last few characters of the event record field specified as the value of Field.

        • NotEquals — (Array<String>)

          An operator that excludes events that match the exact value of the event record field specified as the value of Field.

        • NotStartsWith — (Array<String>)

          An operator that excludes events that match the first few characters of the event record field specified as the value of Field.

        • NotEndsWith — (Array<String>)

          An operator that excludes events that match the last few characters of the event record field specified as the value of Field.

    • MultiRegionEnabled — (Boolean)

      Indicates whether the event data store includes events from all Regions, or only from the Region in which it was created.

    • OrganizationEnabled — (Boolean)

      Indicates whether an event data store is collecting logged events for an organization in Organizations.

    • RetentionPeriod — (Integer)

      The retention period of the event data store, in days.

    • TerminationProtectionEnabled — (Boolean)

      Indicates that termination protection is enabled.

    • CreatedTimestamp — (Date)

      The timestamp of the event data store's creation.

    • UpdatedTimestamp — (Date)

      Shows the time that an event data store was updated, if applicable. UpdatedTimestamp is always either the same or newer than the time shown in CreatedTimestamp.

    • KmsKeyId — (String)

      Specifies the KMS key ID that encrypts the events 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

    • BillingMode — (String)

      The billing mode for the event data store.

      Possible values include:
      • "EXTENDABLE_RETENTION_PRICING"
      • "FIXED_RETENTION_PRICING"
    • FederationStatus — (String)

      Indicates the Lake query federation status. The status is ENABLED if Lake query federation is enabled, or DISABLED if Lake query federation is disabled. You cannot delete an event data store if the FederationStatus is ENABLED.

      Possible values include:
      • "ENABLING"
      • "ENABLED"
      • "DISABLING"
      • "DISABLED"
    • FederationRoleArn — (String)

      If Lake query federation is enabled, provides the ARN of the federation role used to access the resources for the federated event data store.

    • PartitionKeys — (Array<map>)

      The partition keys for the event data store. To improve query performance and efficiency, CloudTrail Lake organizes event data into partitions based on values derived from partition keys.

      • Name — required — (String)

        The name of the partition key.

      • Type — required — (String)

        The data type of the partition key. For example, bigint or string.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  TrailName: 'STRING_VALUE' /* required */
};
cloudtrail.getEventSelectors(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • TrailName — (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

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • TrailARN — (String)

      The specified trail ARN that has the event selectors.

    • EventSelectors — (Array<map>)

      The event selectors that are configured for the 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.

        Possible values include:
        • "ReadOnly"
        • "WriteOnly"
        • "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 — (Array<map>)

        CloudTrail supports data event logging for Amazon S3 objects, 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.

        • 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 about these additional resource types, see AdvancedFieldSelector.

        • Values — (Array<String>)

          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:::bucket-1/. 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:::bucket-1/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.

      • ExcludeManagementEventSources — (Array<String>)

        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.

    • AdvancedEventSelectors — (Array<map>)

      The advanced event selectors that are configured for the trail.

      • Name — (String)

        An optional, descriptive name for an advanced event selector, such as "Log data events for only two S3 buckets".

      • FieldSelectors — required — (Array<map>)

        Contains all selector statements in an advanced event selector.

        • Field — required — (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 readOnly, eventCategory, and eventSource.

          For CloudTrail data events, supported fields include readOnly, eventCategory, eventName, resources.type, and resources.ARN.

          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 - 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 to NotEquals kms.amazonaws.com or NotEquals rdsdata.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 management events, the value must be Management.

            • For CloudTrail data events, the value must be Data.

            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.

          • 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::AppConfig::Configuration

            • AWS::B2BI::Transformer

            • AWS::Bedrock::AgentAlias

            • AWS::Bedrock::KnowledgeBase

            • AWS::Cassandra::Table

            • AWS::CloudFront::KeyValueStore

            • AWS::CloudTrail::Channel

            • AWS::CodeWhisperer::Customization

            • AWS::CodeWhisperer::Profile

            • AWS::Cognito::IdentityPool

            • AWS::DynamoDB::Stream

            • 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::KinesisVideo::Stream

            • AWS::ManagedBlockchain::Network

            • AWS::ManagedBlockchain::Node

            • AWS::MedicalImaging::Datastore

            • AWS::NeptuneGraph::Graph

            • AWS::PCAConnectorAD::Connector

            • AWS::QApps:QApp

            • AWS::QBusiness::Application

            • AWS::QBusiness::DataSource

            • AWS::QBusiness::Index

            • AWS::QBusiness::WebExperience

            • AWS::RDS::DBCluster

            • AWS::S3::AccessPoint

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

            Note: You can't use the resources.ARN field to filter resource types that do not have ARNs.

            The resources.ARN field can be set one of the following.

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

            • arn:<partition>:appconfig:<region>:<account_ID>:application/<application_ID>/environment/<environment_ID>/configuration/<configuration_profile_ID>

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

            • arn:<partition>:b2bi:<region>:<account_ID>:transformer/<transformer_ID>

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

            • arn:<partition>:bedrock:<region>:<account_ID>:agent-alias/<agent_ID>/<alias_ID>

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

            • arn:<partition>:bedrock:<region>:<account_ID>:knowledge-base/<knowledge_base_ID>

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

            • arn:<partition>:cassandra:<region>:<account_ID>:/keyspace/<keyspace_name>/table/<table_name>

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

            • arn:<partition>:cloudfront:<region>:<account_ID>:key-value-store/<KVS_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::Customization, and the operator is set to Equals or NotEquals, the ARN must be in the following format:

            • arn:<partition>:codewhisperer:<region>:<account_ID>:customization/<customization_ID>

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

            • arn:<partition>:greengrass:<region>:<account_ID>:components/<component_name>

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

            • arn:<partition>:greengrass:<region>:<account_ID>:deployments/<deployment_ID

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

            • arn:<partition>:iot:<region>:<account_ID>:cert/<certificate_ID>

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

            • arn:<partition>:iot:<region>:<account_ID>:thing/<thing_ID>

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

            • arn:<partition>:iotsitewise:<region>:<account_ID>:asset/<asset_ID>

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

            • arn:<partition>:iotsitewise:<region>:<account_ID>:timeseries/<timeseries_ID>

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

            • arn:<partition>:iottwinmaker:<region>:<account_ID>:workspace/<workspace_ID>/entity/<entity_ID>

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

            • arn:<partition>:iottwinmaker:<region>:<account_ID>:workspace/<workspace_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::KinesisVideo::Stream, and the operator is set to Equals or NotEquals, the ARN must be in the following format:

            • arn:<partition>:kinesisvideo:<region>:<account_ID>:stream/<stream_name>/<creation_time>

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

            • arn:<partition>:managedblockchain:::networks/<network_name>

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

            • arn:<partition>:medical-imaging:<region>:<account_ID>:datastore/<data_store_ID>

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

            • arn:<partition>:neptune-graph:<region>:<account_ID>:graph/<graph_ID>

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

            • arn:<partition>:pca-connector-ad:<region>:<account_ID>:connector/<connector_ID>

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

            • arn:<partition>:qapps:<region>:<account_ID>:application/<application_UUID>/qapp/<qapp_UUID>

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

            • arn:<partition>:qbusiness:<region>:<account_ID>:application/<application_ID>

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

            • arn:<partition>:qbusiness:<region>:<account_ID>:application/<application_ID>/index/<index_ID>/data-source/<datasource_ID>

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

            • arn:<partition>:qbusiness:<region>:<account_ID>:application/<application_ID>/index/<index_ID>

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

            • arn:<partition>:qbusiness:<region>:<account_ID>:application/<application_ID>/web-experience/<web_experience_ID>

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

            • arn:<partition>:rds:<region>:<account_ID>:cluster/<cluster_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>

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

            • arn:<partition>:sagemaker:<region>:<account_ID>:endpoint/<endpoint_name>

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

            • arn:<partition>:scn:<region>:<account_ID>:instance/<instance_ID>

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

            • arn:<partition>:servicediscovery:<region>:<account_ID>:namespace/<namespace_ID>

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

            • arn:<partition>:servicediscovery:<region>:<account_ID>:service/<service_ID>

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

            • arn:<partition>:sns:<region>:<account_ID>:endpoint/<endpoint_type>/<endpoint_name>/<endpoint_ID>

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

            • arn:<partition>:sns:<region>:<account_ID>:<topic_name>

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

            • arn:<partition>:sqs:<region>:<account_ID>:<queue_name>

            When resources.type equals AWS::SSM::ManagedNode, and the operator is set to Equals or NotEquals, the ARN must be in one of the following formats:

            • arn:<partition>:ssm:<region>:<account_ID>:managed-instance/<instance_ID>

            • arn:<partition>:ec2:<region>:<account_ID>:instance/<instance_ID>

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

            • arn:<partition>:ssmmessages:<region>:<account_ID>:control-channel/<channel_ID>

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

            • arn:<partition>:swf:<region>:<account_ID>:domain/<domain_name>

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

            • arn:<partition>:thinclient:<region>:<account_ID>:device/<device_ID>

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

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

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

            • arn:<partition>:timestream:<region>:<account_ID>:database/<database_name>

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

            • arn:<partition>:timestream:<region>:<account_ID>:database/<database_name>/table/<table_name>

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

            • arn:<partition>:verifiedpermissions:<region>:<account_ID>:policy-store/<policy_store_UUID>

        • Equals — (Array<String>)

          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.

        • StartsWith — (Array<String>)

          An operator that includes events that match the first few characters of the event record field specified as the value of Field.

        • EndsWith — (Array<String>)

          An operator that includes events that match the last few characters of the event record field specified as the value of Field.

        • NotEquals — (Array<String>)

          An operator that excludes events that match the exact value of the event record field specified as the value of Field.

        • NotStartsWith — (Array<String>)

          An operator that excludes events that match the first few characters of the event record field specified as the value of Field.

        • NotEndsWith — (Array<String>)

          An operator that excludes events that match the last few characters of the event record field specified as the value of Field.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  ImportId: 'STRING_VALUE' /* required */
};
cloudtrail.getImport(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • ImportId — (String)

    The ID for the import.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • ImportId — (String)

      The ID of the import.

    • Destinations — (Array<String>)

      The ARN of the destination event data store.

    • ImportSource — (map)

      The source S3 bucket.

      • S3 — required — (map)

        The source S3 bucket.

        • S3LocationUri — required — (String)

          The URI for the source S3 bucket.

        • S3BucketRegion — required — (String)

          The Region associated with the source S3 bucket.

        • S3BucketAccessRoleArn — required — (String)

          The IAM ARN role used to access the source S3 bucket.

    • StartEventTime — (Date)

      Used with EndEventTime to bound a StartImport request, and limit imported trail events to only those events logged within a specified time period.

    • EndEventTime — (Date)

      Used with StartEventTime to bound a StartImport request, and limit imported trail events to only those events logged within a specified time period.

    • ImportStatus — (String)

      The status of the import.

      Possible values include:
      • "INITIALIZING"
      • "IN_PROGRESS"
      • "FAILED"
      • "STOPPED"
      • "COMPLETED"
    • CreatedTimestamp — (Date)

      The timestamp of the import's creation.

    • UpdatedTimestamp — (Date)

      The timestamp of when the import was updated.

    • ImportStatistics — (map)

      Provides statistics for the import. CloudTrail does not update import statistics in real-time. Returned values for parameters such as EventsCompleted may be lower than the actual value, because CloudTrail updates statistics incrementally over the course of the import.

      • PrefixesFound — (Integer)

        The number of S3 prefixes found for the import.

      • PrefixesCompleted — (Integer)

        The number of S3 prefixes that completed import.

      • FilesCompleted — (Integer)

        The number of log files that completed import.

      • EventsCompleted — (Integer)

        The number of trail events imported into the event data store.

      • FailedEntries — (Integer)

        The number of failed entries.