Class: Aws::CloudTrail::Client

resp = client.cancel_query({
  event_data_store: "EventDataStoreArn",
  query_id: "UUID", # required
  event_data_store_owner_account_id: "AccountId",
})

resp.query_id #=> String
resp.query_status #=> String, one of "QUEUED", "RUNNING", "FINISHED", "FAILED", "CANCELLED", "TIMED_OUT"
resp.event_data_store_owner_account_id #=> String

Parameters:

• params (Hash) (defaults to: {}) —

  ({})

Options Hash (params):

• :event_data_store (String) —

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

• :query_id (required, String) —

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

• :event_data_store_owner_account_id (String) —

  The account ID of the event data store owner.

Returns:

• (Types::CancelQueryResponse) —

  Returns a response object which responds to the following methods:

  • #query_id => String
  • #query_status => String
  • #event_data_store_owner_account_id => String

See Also:

• AWS API Documentation

resp = client.create_channel({
  name: "ChannelName", # required
  source: "Source", # required
  destinations: [ # required
    {
      type: "EVENT_DATA_STORE", # required, accepts EVENT_DATA_STORE, AWS_SERVICE
      location: "Location", # required
    },
  ],
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue",
    },
  ],
})

resp.channel_arn #=> String
resp.name #=> String
resp.source #=> String
resp.destinations #=> Array
resp.destinations[0].type #=> String, one of "EVENT_DATA_STORE", "AWS_SERVICE"
resp.destinations[0].location #=> String
resp.tags #=> Array
resp.tags[0].key #=> String
resp.tags[0].value #=> String

Parameters:

• params (Hash) (defaults to: {}) —

  ({})

Options Hash (params):

• :name (required, String) —

  The name of the channel.

• :source (required, 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 (required, Array<Types::Destination>) —

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

• :tags (Array<Types::Tag>) —

  A list of tags.

Returns:

• (Types::CreateChannelResponse) —

  Returns a response object which responds to the following methods:

  • #channel_arn => String
  • #name => String
  • #source => String
  • #destinations => Array<Types::Destination>
  • #tags => Array<Types::Tag>

See Also:

• AWS API Documentation

resp = client.create_dashboard({
  name: "DashboardName", # required
  refresh_schedule: {
    frequency: {
      unit: "HOURS", # accepts HOURS, DAYS
      value: 1,
    },
    status: "ENABLED", # accepts ENABLED, DISABLED
    time_of_day: "TimeOfDay",
  },
  tags_list: [
    {
      key: "TagKey", # required
      value: "TagValue",
    },
  ],
  termination_protection_enabled: false,
  widgets: [
    {
      query_statement: "QueryStatement", # required
      query_parameters: ["QueryParameter"],
      view_properties: { # required
        "ViewPropertiesKey" => "ViewPropertiesValue",
      },
    },
  ],
})

resp.dashboard_arn #=> String
resp.name #=> String
resp.type #=> String, one of "MANAGED", "CUSTOM"
resp.widgets #=> Array
resp.widgets[0].query_alias #=> String
resp.widgets[0].query_statement #=> String
resp.widgets[0].query_parameters #=> Array
resp.widgets[0].query_parameters[0] #=> String
resp.widgets[0].view_properties #=> Hash
resp.widgets[0].view_properties["ViewPropertiesKey"] #=> String
resp.tags_list #=> Array
resp.tags_list[0].key #=> String
resp.tags_list[0].value #=> String
resp.refresh_schedule.frequency.unit #=> String, one of "HOURS", "DAYS"
resp.refresh_schedule.frequency.value #=> Integer
resp.refresh_schedule.status #=> String, one of "ENABLED", "DISABLED"
resp.refresh_schedule.time_of_day #=> String
resp.termination_protection_enabled #=> Boolean

Parameters:

• params (Hash) (defaults to: {}) —

  ({})

Options Hash (params):

• :name (required, String) —

  The name of the dashboard. The name must be unique to your account.

  To create the Highlights dashboard, the name must be AWSCloudTrail-Highlights.

• :refresh_schedule (Types::RefreshSchedule) —

  The refresh schedule configuration for the dashboard.

  To create the Highlights dashboard, you must set a refresh schedule and set the Status to ENABLED. The Unit for the refresh schedule must be HOURS and the Value must be 6.

• :tags_list (Array<Types::Tag>) —

  A list of tags.

• :termination_protection_enabled (Boolean) —

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

• :widgets (Array<Types::RequestWidget>) —

  An array of widgets for a custom dashboard. A custom dashboard can have a maximum of ten widgets.

  You do not need to specify widgets for the Highlights dashboard.

Returns:

• (Types::CreateDashboardResponse) —

  Returns a response object which responds to the following methods:

  • #dashboard_arn => String
  • #name => String
  • #type => String
  • #widgets => Array<Types::Widget>
  • #tags_list => Array<Types::Tag>
  • #refresh_schedule => Types::RefreshSchedule
  • #termination_protection_enabled => Boolean

See Also:

• AWS API Documentation

resp = client.create_event_data_store({
  name: "EventDataStoreName", # required
  advanced_event_selectors: [
    {
      name: "SelectorName",
      field_selectors: [ # required
        {
          field: "SelectorField", # required
          equals: ["OperatorValue"],
          starts_with: ["OperatorValue"],
          ends_with: ["OperatorValue"],
          not_equals: ["OperatorValue"],
          not_starts_with: ["OperatorValue"],
          not_ends_with: ["OperatorValue"],
        },
      ],
    },
  ],
  multi_region_enabled: false,
  organization_enabled: false,
  retention_period: 1,
  termination_protection_enabled: false,
  tags_list: [
    {
      key: "TagKey", # required
      value: "TagValue",
    },
  ],
  kms_key_id: "EventDataStoreKmsKeyId",
  start_ingestion: false,
  billing_mode: "EXTENDABLE_RETENTION_PRICING", # accepts EXTENDABLE_RETENTION_PRICING, FIXED_RETENTION_PRICING
})

resp.event_data_store_arn #=> String
resp.name #=> String
resp.status #=> String, one of "CREATED", "ENABLED", "PENDING_DELETION", "STARTING_INGESTION", "STOPPING_INGESTION", "STOPPED_INGESTION"
resp.advanced_event_selectors #=> Array
resp.advanced_event_selectors[0].name #=> String
resp.advanced_event_selectors[0].field_selectors #=> Array
resp.advanced_event_selectors[0].field_selectors[0].field #=> String
resp.advanced_event_selectors[0].field_selectors[0].equals #=> Array
resp.advanced_event_selectors[0].field_selectors[0].equals[0] #=> String
resp.advanced_event_selectors[0].field_selectors[0].starts_with #=> Array
resp.advanced_event_selectors[0].field_selectors[0].starts_with[0] #=> String
resp.advanced_event_selectors[0].field_selectors[0].ends_with #=> Array
resp.advanced_event_selectors[0].field_selectors[0].ends_with[0] #=> String
resp.advanced_event_selectors[0].field_selectors[0].not_equals #=> Array
resp.advanced_event_selectors[0].field_selectors[0].not_equals[0] #=> String
resp.advanced_event_selectors[0].field_selectors[0].not_starts_with #=> Array
resp.advanced_event_selectors[0].field_selectors[0].not_starts_with[0] #=> String
resp.advanced_event_selectors[0].field_selectors[0].not_ends_with #=> Array
resp.advanced_event_selectors[0].field_selectors[0].not_ends_with[0] #=> String
resp.multi_region_enabled #=> Boolean
resp.organization_enabled #=> Boolean
resp.retention_period #=> Integer
resp.termination_protection_enabled #=> Boolean
resp.tags_list #=> Array
resp.tags_list[0].key #=> String
resp.tags_list[0].value #=> String
resp.created_timestamp #=> Time
resp.updated_timestamp #=> Time
resp.kms_key_id #=> String
resp.billing_mode #=> String, one of "EXTENDABLE_RETENTION_PRICING", "FIXED_RETENTION_PRICING"

Parameters:

• params (Hash) (defaults to: {}) —

  ({})

Options Hash (params):

• :name (required, String) —

  The name of the event data store.

• :advanced_event_selectors (Array<Types::AdvancedEventSelector>) —

  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.

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

• :organization_enabled (Boolean) —

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

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

  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.

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

• :tags_list (Array<Types::Tag>) —

  A list of tags.

• :kms_key_id (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

• :start_ingestion (Boolean) —

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

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

Returns:

• (Types::CreateEventDataStoreResponse) —

  Returns a response object which responds to the following methods:

  • #event_data_store_arn => String
  • #name => String
  • #status => String
  • #advanced_event_selectors => Array<Types::AdvancedEventSelector>
  • #multi_region_enabled => Boolean
  • #organization_enabled => Boolean
  • #retention_period => Integer
  • #termination_protection_enabled => Boolean
  • #tags_list => Array<Types::Tag>
  • #created_timestamp => Time
  • #updated_timestamp => Time
  • #kms_key_id => String
  • #billing_mode => String

See Also:

• AWS API Documentation

resp = client.create_trail({
  name: "String", # required
  s3_bucket_name: "String", # required
  s3_key_prefix: "String",
  sns_topic_name: "String",
  include_global_service_events: false,
  is_multi_region_trail: false,
  enable_log_file_validation: false,
  cloud_watch_logs_log_group_arn: "String",
  cloud_watch_logs_role_arn: "String",
  kms_key_id: "String",
  is_organization_trail: false,
  tags_list: [
    {
      key: "TagKey", # required
      value: "TagValue",
    },
  ],
})

resp.name #=> String
resp.s3_bucket_name #=> String
resp.s3_key_prefix #=> String
resp.sns_topic_name #=> String
resp.sns_topic_arn #=> String
resp.include_global_service_events #=> Boolean
resp.is_multi_region_trail #=> Boolean
resp.trail_arn #=> String
resp.log_file_validation_enabled #=> Boolean
resp.cloud_watch_logs_log_group_arn #=> String
resp.cloud_watch_logs_role_arn #=> String
resp.kms_key_id #=> String
resp.is_organization_trail #=> Boolean

Parameters:

• params (Hash) (defaults to: {}) —

  ({})

Options Hash (params):

• :name (required, 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)

• :s3_bucket_name (required, 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.

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

• :sns_topic_name (String) —

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

• :include_global_service_events (Boolean) —

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

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

• :enable_log_file_validation (Boolean) —

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

  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.

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

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

• :kms_key_id (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

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

• :tags_list (Array<Types::Tag>) —

  A list of tags.

Returns:

• (Types::CreateTrailResponse) —

  Returns a response object which responds to the following methods:

  • #name => String
  • #s3_bucket_name => String
  • #s3_key_prefix => String
  • #sns_topic_name => String
  • #sns_topic_arn => String
  • #include_global_service_events => Boolean
  • #is_multi_region_trail => Boolean
  • #trail_arn => String
  • #log_file_validation_enabled => Boolean
  • #cloud_watch_logs_log_group_arn => String
  • #cloud_watch_logs_role_arn => String
  • #kms_key_id => String
  • #is_organization_trail => Boolean

See Also:

• AWS API Documentation

resp = client.delete_channel({
  channel: "ChannelArn", # required
})

Parameters:

• params (Hash) (defaults to: {}) —

  ({})

Options Hash (params):

• :channel (required, String) —

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

Returns:

• (Struct) —

  Returns an empty response.

See Also:

• AWS API Documentation

resp = client.delete_dashboard({
  dashboard_id: "DashboardArn", # required
})

Parameters:

• params (Hash) (defaults to: {}) —

  ({})

Options Hash (params):

• :dashboard_id (required, String) —

  The name or ARN for the dashboard.

Returns:

• (Struct) —

  Returns an empty response.

See Also:

• AWS API Documentation

resp = client.delete_event_data_store({
  event_data_store: "EventDataStoreArn", # required
})

Parameters:

• params (Hash) (defaults to: {}) —

  ({})

Options Hash (params):

• :event_data_store (required, String) —

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

Returns:

• (Struct) —

  Returns an empty response.

See Also:

• AWS API Documentation

resp = client.delete_resource_policy({
  resource_arn: "ResourceArn", # required
})

Parameters:

• params (Hash) (defaults to: {}) —

  ({})

Options Hash (params):

• :resource_arn (required, String) —

  The Amazon Resource Name (ARN) of the CloudTrail event data store, dashboard, or channel you're deleting the resource-based policy from.

  Example event data store ARN format: arn:aws:cloudtrail:us-east-2:123456789012:eventdatastore/EXAMPLE-f852-4e8f-8bd1-bcf6cEXAMPLE

  Example dashboard ARN format: arn:aws:cloudtrail:us-east-1:123456789012:dashboard/exampleDash

  Example channel ARN format: arn:aws:cloudtrail:us-east-2:123456789012:channel/01234567890

Returns:

• (Struct) —

  Returns an empty response.

See Also:

• AWS API Documentation

resp = client.delete_trail({
  name: "String", # required
})

Parameters:

• params (Hash) (defaults to: {}) —

  ({})

Options Hash (params):

• :name (required, 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

Returns:

• (Struct) —

  Returns an empty response.

See Also:

• AWS API Documentation

resp = client.deregister_organization_delegated_admin({
  delegated_admin_account_id: "AccountId", # required
})

Parameters:

• params (Hash) (defaults to: {}) —

  ({})

Options Hash (params):

• :delegated_admin_account_id (required, String) —

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

Returns:

• (Struct) —

  Returns an empty response.

See Also:

• AWS API Documentation

resp = client.describe_query({
  event_data_store: "EventDataStoreArn",
  query_id: "UUID",
  query_alias: "QueryAlias",
  refresh_id: "RefreshId",
  event_data_store_owner_account_id: "AccountId",
})

resp.query_id #=> String
resp.query_string #=> String
resp.query_status #=> String, one of "QUEUED", "RUNNING", "FINISHED", "FAILED", "CANCELLED", "TIMED_OUT"
resp.query_statistics.events_matched #=> Integer
resp.query_statistics.events_scanned #=> Integer
resp.query_statistics.bytes_scanned #=> Integer
resp.query_statistics.execution_time_in_millis #=> Integer
resp.query_statistics.creation_time #=> Time
resp.error_message #=> String
resp.delivery_s3_uri #=> String
resp.delivery_status #=> String, one of "SUCCESS", "FAILED", "FAILED_SIGNING_FILE", "PENDING", "RESOURCE_NOT_FOUND", "ACCESS_DENIED", "ACCESS_DENIED_SIGNING_FILE", "CANCELLED", "UNKNOWN"
resp.prompt #=> String
resp.event_data_store_owner_account_id #=> String

Parameters:

• params (Hash) (defaults to: {}) —

  ({})

Options Hash (params):

• :event_data_store (String) —

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

• :query_id (String) —

  The query ID.

• :query_alias (String) —

  The alias that identifies a query template.

• :refresh_id (String) —

  The ID of the dashboard refresh.

• :event_data_store_owner_account_id (String) —

  The account ID of the event data store owner.

Returns:

• (Types::DescribeQueryResponse) —

  Returns a response object which responds to the following methods:

  • #query_id => String
  • #query_string => String
  • #query_status => String
  • #query_statistics => Types::QueryStatisticsForDescribeQuery
  • #error_message => String
  • #delivery_s3_uri => String
  • #delivery_status => String
  • #prompt => String
  • #event_data_store_owner_account_id => String

See Also:

• AWS API Documentation

resp = client.describe_trails({
  trail_name_list: ["String"],
  include_shadow_trails: false,
})

resp.trail_list #=> Array
resp.trail_list[0].name #=> String
resp.trail_list[0].s3_bucket_name #=> String
resp.trail_list[0].s3_key_prefix #=> String
resp.trail_list[0].sns_topic_name #=> String
resp.trail_list[0].sns_topic_arn #=> String
resp.trail_list[0].include_global_service_events #=> Boolean
resp.trail_list[0].is_multi_region_trail #=> Boolean
resp.trail_list[0].home_region #=> String
resp.trail_list[0].trail_arn #=> String
resp.trail_list[0].log_file_validation_enabled #=> Boolean
resp.trail_list[0].cloud_watch_logs_log_group_arn #=> String
resp.trail_list[0].cloud_watch_logs_role_arn #=> String
resp.trail_list[0].kms_key_id #=> String
resp.trail_list[0].has_custom_event_selectors #=> Boolean
resp.trail_list[0].has_insight_selectors #=> Boolean
resp.trail_list[0].is_organization_trail #=> Boolean

Parameters:

• params (Hash) (defaults to: {}) —

  ({})

Options Hash (params):

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

  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.

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

Returns:

• (Types::DescribeTrailsResponse) —

  Returns a response object which responds to the following methods:

  • #trail_list => Array<Types::Trail>

See Also:

• AWS API Documentation

resp = client.disable_federation({
  event_data_store: "EventDataStoreArn", # required
})

resp.event_data_store_arn #=> String
resp.federation_status #=> String, one of "ENABLING", "ENABLED", "DISABLING", "DISABLED"

Parameters:

• params (Hash) (defaults to: {}) —

  ({})

Options Hash (params):

• :event_data_store (required, String) —

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

Returns:

• (Types::DisableFederationResponse) —

  Returns a response object which responds to the following methods:

  • #event_data_store_arn => String
  • #federation_status => String

See Also:

• AWS API Documentation

resp = client.enable_federation({
  event_data_store: "EventDataStoreArn", # required
  federation_role_arn: "FederationRoleArn", # required
})

resp.event_data_store_arn #=> String
resp.federation_status #=> String, one of "ENABLING", "ENABLED", "DISABLING", "DISABLED"
resp.federation_role_arn #=> String

Parameters:

• params (Hash) (defaults to: {}) —

  ({})

Options Hash (params):

• :event_data_store (required, String) —

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

• :federation_role_arn (required, 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.

Returns:

• (Types::EnableFederationResponse) —

  Returns a response object which responds to the following methods:

  • #event_data_store_arn => String
  • #federation_status => String
  • #federation_role_arn => String

See Also:

• AWS API Documentation

resp = client.generate_query({
  event_data_stores: ["EventDataStoreArn"], # required
  prompt: "Prompt", # required
})

resp.query_statement #=> String
resp.query_alias #=> String
resp.event_data_store_owner_account_id #=> String

Parameters:

• params (Hash) (defaults to: {}) —

  ({})

Options Hash (params):

• :event_data_stores (required, Array<String>) —

  The ARN (or ID suffix of the ARN) of the event data store that you want to query. You can only specify one event data store.

• :prompt (required, String) —

  The prompt that you want to use to generate the query. The prompt must be in English. For example prompts, see Example prompts in the CloudTrail user guide.

Returns:

• (Types::GenerateQueryResponse) —

  Returns a response object which responds to the following methods:

  • #query_statement => String
  • #query_alias => String
  • #event_data_store_owner_account_id => String

See Also:

• AWS API Documentation

resp = client.get_channel({
  channel: "ChannelArn", # required
})

resp.channel_arn #=> String
resp.name #=> String
resp.source #=> String
resp.source_config.apply_to_all_regions #=> Boolean
resp.source_config.advanced_event_selectors #=> Array
resp.source_config.advanced_event_selectors[0].name #=> String
resp.source_config.advanced_event_selectors[0].field_selectors #=> Array
resp.source_config.advanced_event_selectors[0].field_selectors[0].field #=> String
resp.source_config.advanced_event_selectors[0].field_selectors[0].equals #=> Array
resp.source_config.advanced_event_selectors[0].field_selectors[0].equals[0] #=> String
resp.source_config.advanced_event_selectors[0].field_selectors[0].starts_with #=> Array
resp.source_config.advanced_event_selectors[0].field_selectors[0].starts_with[0] #=> String
resp.source_config.advanced_event_selectors[0].field_selectors[0].ends_with #=> Array
resp.source_config.advanced_event_selectors[0].field_selectors[0].ends_with[0] #=> String
resp.source_config.advanced_event_selectors[0].field_selectors[0].not_equals #=> Array
resp.source_config.advanced_event_selectors[0].field_selectors[0].not_equals[0] #=> String
resp.source_config.advanced_event_selectors[0].field_selectors[0].not_starts_with #=> Array
resp.source_config.advanced_event_selectors[0].field_selectors[0].not_starts_with[0] #=> String
resp.source_config.advanced_event_selectors[0].field_selectors[0].not_ends_with #=> Array
resp.source_config.advanced_event_selectors[0].field_selectors[0].not_ends_with[0] #=> String
resp.destinations #=> Array
resp.destinations[0].type #=> String, one of "EVENT_DATA_STORE", "AWS_SERVICE"
resp.destinations[0].location #=> String
resp.ingestion_status.latest_ingestion_success_time #=> Time
resp.ingestion_status.latest_ingestion_success_event_id #=> String
resp.ingestion_status.latest_ingestion_error_code #=> String
resp.ingestion_status.latest_ingestion_attempt_time #=> Time
resp.ingestion_status.latest_ingestion_attempt_event_id #=> String

Parameters:

• params (Hash) (defaults to: {}) —

  ({})

Options Hash (params):

• :channel (required, String) —

  The ARN or UUID of a channel.

Returns:

• (Types::GetChannelResponse) —

  Returns a response object which responds to the following methods:

  • #channel_arn => String
  • #name => String
  • #source => String
  • #source_config => Types::SourceConfig
  • #destinations => Array<Types::Destination>
  • #ingestion_status => Types::IngestionStatus

See Also:

• AWS API Documentation

resp = client.get_dashboard({
  dashboard_id: "DashboardArn", # required
})

resp.dashboard_arn #=> String
resp.type #=> String, one of "MANAGED", "CUSTOM"
resp.status #=> String, one of "CREATING", "CREATED", "UPDATING", "UPDATED", "DELETING"
resp.widgets #=> Array
resp.widgets[0].query_alias #=> String
resp.widgets[0].query_statement #=> String
resp.widgets[0].query_parameters #=> Array
resp.widgets[0].query_parameters[0] #=> String
resp.widgets[0].view_properties #=> Hash
resp.widgets[0].view_properties["ViewPropertiesKey"] #=> String
resp.refresh_schedule.frequency.unit #=> String, one of "HOURS", "DAYS"
resp.refresh_schedule.frequency.value #=> Integer
resp.refresh_schedule.status #=> String, one of "ENABLED", "DISABLED"
resp.refresh_schedule.time_of_day #=> String
resp.created_timestamp #=> Time
resp.updated_timestamp #=> Time
resp.last_refresh_id #=> String
resp.last_refresh_failure_reason #=> String
resp.termination_protection_enabled #=> Boolean

Parameters:

• params (Hash) (defaults to: {}) —

  ({})

Options Hash (params):

• :dashboard_id (required, String) —

  The name or ARN for the dashboard.

Returns:

• (Types::GetDashboardResponse) —

  Returns a response object which responds to the following methods:

  • #dashboard_arn => String
  • #type => String
  • #status => String
  • #widgets => Array<Types::Widget>
  • #refresh_schedule => Types::RefreshSchedule
  • #created_timestamp => Time
  • #updated_timestamp => Time
  • #last_refresh_id => String
  • #last_refresh_failure_reason => String
  • #termination_protection_enabled => Boolean

See Also:

• AWS API Documentation

resp = client.get_event_configuration({
  event_data_store: "String",
})

resp.event_data_store_arn #=> String
resp.max_event_size #=> String, one of "Standard", "Large"
resp.context_key_selectors #=> Array
resp.context_key_selectors[0].type #=> String, one of "TagContext", "RequestContext"
resp.context_key_selectors[0].equals #=> Array
resp.context_key_selectors[0].equals[0] #=> String

Parameters:

• params (Hash) (defaults to: {}) —

  ({})

Options Hash (params):

• :event_data_store (String) —

  The Amazon Resource Name (ARN) or ID suffix of the ARN of the event data store for which you want to retrieve event configuration settings.

Returns:

• (Types::GetEventConfigurationResponse) —

  Returns a response object which responds to the following methods:

  • #event_data_store_arn => String
  • #max_event_size => String
  • #context_key_selectors => Array<Types::ContextKeySelector>

See Also:

• AWS API Documentation

resp = client.get_event_data_store({
  event_data_store: "EventDataStoreArn", # required
})

resp.event_data_store_arn #=> String
resp.name #=> String
resp.status #=> String, one of "CREATED", "ENABLED", "PENDING_DELETION", "STARTING_INGESTION", "STOPPING_INGESTION", "STOPPED_INGESTION"
resp.advanced_event_selectors #=> Array
resp.advanced_event_selectors[0].name #=> String
resp.advanced_event_selectors[0].field_selectors #=> Array
resp.advanced_event_selectors[0].field_selectors[0].field #=> String
resp.advanced_event_selectors[0].field_selectors[0].equals #=> Array
resp.advanced_event_selectors[0].field_selectors[0].equals[0] #=> String
resp.advanced_event_selectors[0].field_selectors[0].starts_with #=> Array
resp.advanced_event_selectors[0].field_selectors[0].starts_with[0] #=> String
resp.advanced_event_selectors[0].field_selectors[0].ends_with #=> Array
resp.advanced_event_selectors[0].field_selectors[0].ends_with[0] #=> String
resp.advanced_event_selectors[0].field_selectors[0].not_equals #=> Array
resp.advanced_event_selectors[0].field_selectors[0].not_equals[0] #=> String
resp.advanced_event_selectors[0].field_selectors[0].not_starts_with #=> Array
resp.advanced_event_selectors[0].field_selectors[0].not_starts_with[0] #=> String
resp.advanced_event_selectors[0].field_selectors[0].not_ends_with #=> Array
resp.advanced_event_selectors[0].field_selectors[0].not_ends_with[0] #=> String
resp.multi_region_enabled #=> Boolean
resp.organization_enabled #=> Boolean
resp.retention_period #=> Integer
resp.termination_protection_enabled #=> Boolean
resp.created_timestamp #=> Time
resp.updated_timestamp #=> Time
resp.kms_key_id #=> String
resp.billing_mode #=> String, one of "EXTENDABLE_RETENTION_PRICING", "FIXED_RETENTION_PRICING"
resp.federation_status #=> String, one of "ENABLING", "ENABLED", "DISABLING", "DISABLED"
resp.federation_role_arn #=> String
resp.partition_keys #=> Array
resp.partition_keys[0].name #=> String
resp.partition_keys[0].type #=> String

Parameters:

• params (Hash) (defaults to: {}) —

  ({})

Options Hash (params):

• :event_data_store (required, String) —

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

Returns:

• (Types::GetEventDataStoreResponse) —

  Returns a response object which responds to the following methods:

  • #event_data_store_arn => String
  • #name => String
  • #status => String
  • #advanced_event_selectors => Array<Types::AdvancedEventSelector>
  • #multi_region_enabled => Boolean
  • #organization_enabled => Boolean
  • #retention_period => Integer
  • #termination_protection_enabled => Boolean
  • #created_timestamp => Time
  • #updated_timestamp => Time
  • #kms_key_id => String
  • #billing_mode => String
  • #federation_status => String
  • #federation_role_arn => String
  • #partition_keys => Array<Types::PartitionKey>

See Also:

• AWS API Documentation

resp = client.get_event_selectors({
  trail_name: "String", # required
})

resp.trail_arn #=> String
resp.event_selectors #=> Array
resp.event_selectors[0].read_write_type #=> String, one of "ReadOnly", "WriteOnly", "All"
resp.event_selectors[0].include_management_events #=> Boolean
resp.event_selectors[0].data_resources #=> Array
resp.event_selectors[0].data_resources[0].type #=> String
resp.event_selectors[0].data_resources[0].values #=> Array
resp.event_selectors[0].data_resources[0].values[0] #=> String
resp.event_selectors[0].exclude_management_event_sources #=> Array
resp.event_selectors[0].exclude_management_event_sources[0] #=> String
resp.advanced_event_selectors #=> Array
resp.advanced_event_selectors[0].name #=> String
resp.advanced_event_selectors[0].field_selectors #=> Array
resp.advanced_event_selectors[0].field_selectors[0].field #=> String
resp.advanced_event_selectors[0].field_selectors[0].equals #=> Array
resp.advanced_event_selectors[0].field_selectors[0].equals[0] #=> String
resp.advanced_event_selectors[0].field_selectors[0].starts_with #=> Array
resp.advanced_event_selectors[0].field_selectors[0].starts_with[0] #=> String
resp.advanced_event_selectors[0].field_selectors[0].ends_with #=> Array
resp.advanced_event_selectors[0].field_selectors[0].ends_with[0] #=> String
resp.advanced_event_selectors[0].field_selectors[0].not_equals #=> Array
resp.advanced_event_selectors[0].field_selectors[0].not_equals[0] #=> String
resp.advanced_event_selectors[0].field_selectors[0].not_starts_with #=> Array
resp.advanced_event_selectors[0].field_selectors[0].not_starts_with[0] #=> String
resp.advanced_event_selectors[0].field_selectors[0].not_ends_with #=> Array
resp.advanced_event_selectors[0].field_selectors[0].not_ends_with[0] #=> String

Parameters:

• params (Hash) (defaults to: {}) —

  ({})

Options Hash (params):

• :trail_name (required, 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

Returns:

• (Types::GetEventSelectorsResponse) —

  Returns a response object which responds to the following methods:

  • #trail_arn => String
  • #event_selectors => Array<Types::EventSelector>
  • #advanced_event_selectors => Array<Types::AdvancedEventSelector>

See Also:

• AWS API Documentation

resp = client.get_import({
  import_id: "UUID", # required
})

resp.import_id #=> String
resp.destinations #=> Array
resp.destinations[0] #=> String
resp.import_source.s3.s3_location_uri #=> String
resp.import_source.s3.s3_bucket_region #=> String
resp.import_source.s3.s3_bucket_access_role_arn #=> String
resp.start_event_time #=> Time
resp.end_event_time #=> Time
resp.import_status #=> String, one of "INITIALIZING", "IN_PROGRESS", "FAILED", "STOPPED", "COMPLETED"
resp.created_timestamp #=> Time
resp.updated_timestamp #=> Time
resp.import_statistics.prefixes_found #=> Integer
resp.import_statistics.prefixes_completed #=> Integer
resp.import_statistics.files_completed #=> Integer
resp.import_statistics.events_completed #=> Integer
resp.import_statistics.failed_entries #=> Integer

Parameters:

• params (Hash) (defaults to: {}) —

  ({})

Options Hash (params):

• :import_id (required, String) —

  The ID for the import.

Returns:

• (Types::GetImportResponse) —

  Returns a response object which responds to the following methods:

  • #import_id => String
  • #destinations => Array<String>
  • #import_source => Types::ImportSource
  • #start_event_time => Time
  • #end_event_time => Time
  • #import_status => String
  • #created_timestamp => Time
  • #updated_timestamp => Time
  • #import_statistics => Types::ImportStatistics

See Also:

• AWS API Documentation

resp = client.get_insight_selectors({
  trail_name: "String",
  event_data_store: "EventDataStoreArn",
})

resp.trail_arn #=> String
resp.insight_selectors #=> Array
resp.insight_selectors[0].insight_type #=> String, one of "ApiCallRateInsight", "ApiErrorRateInsight"
resp.event_data_store_arn #=> String
resp.insights_destination #=> String

Parameters:

• params (Hash) (defaults to: {}) —

  ({})

Options Hash (params):

• :trail_name (String) —

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

  • Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-)

  • Start with a letter or number, and end with a letter or number

  • Be between 3 and 128 characters

  • Have no adjacent periods, underscores or dashes. Names like my-_namespace and my--namespace are not valid.

  • Not be in IP address format (for example, 192.168.5.4)

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

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

  You cannot use this parameter with the EventDataStore parameter.

• :event_data_store (String) —

  Specifies the ARN (or ID suffix of the ARN) of the event data store for which you want to get Insights selectors.

  You cannot use this parameter with the TrailName parameter.

Returns:

• (Types::GetInsightSelectorsResponse) —

  Returns a response object which responds to the following methods:

  • #trail_arn => String
  • #insight_selectors => Array<Types::InsightSelector>
  • #event_data_store_arn => String
  • #insights_destination => String

See Also:

• AWS API Documentation