Cloudtrail

This page documents function available when using the Cloudtrail module, created with @service Cloudtrail.

Index

Documentation

Main.Cloudtrail.add_tagsMethod
add_tags(resource_id, tags_list)
add_tags(resource_id, tags_list, params::Dict{String,<:Any})

Adds one or more tags to a trail or event data store, up to a limit of 50. Overwrites an existing tag's value when a new value is specified for an existing tag key. Tag key names must be unique for a trail; you cannot have two keys with the same name but different values. If you specify a key without a value, the tag will be created with the specified key and a value of null. You can tag a trail or event data store that applies to all Amazon Web Services Regions only from the Region in which the trail or event data store was created (also known as its home region).

Arguments

  • resource_id: Specifies the ARN of the trail or event data store to which one or more tags will be added. The format of a trail ARN is: arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail
  • tags_list: Contains a list of tags, up to a limit of 50
source
Main.Cloudtrail.cancel_queryMethod
cancel_query(query_id)
cancel_query(query_id, params::Dict{String,<:Any})

Cancels a query if the query is not in a terminated state, such as CANCELLED, FAILED, TIMED_OUT, or FINISHED. You must specify an ARN value for EventDataStore. The ID of the query that you want to cancel is also required. When you run CancelQuery, the query status might show as CANCELLED even if the operation is not yet finished.

Arguments

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

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "EventDataStore": The ARN (or the ID suffix of the ARN) of an event data store on which the specified query is running.
source
Main.Cloudtrail.create_event_data_storeMethod
create_event_data_store(name)
create_event_data_store(name, params::Dict{String,<:Any})

Creates a new event data store.

Arguments

  • name: The name of the event data store.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "AdvancedEventSelectors": The advanced event selectors to use to select the events for the data store. For more information about how to use advanced event selectors, see Log events by using advanced event selectors in the CloudTrail User Guide.
  • "KmsKeyId": 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
  • "MultiRegionEnabled": 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": Specifies whether an event data store collects events logged for an organization in Organizations.
  • "RetentionPeriod": The retention period of the event data store, in days. You can set a retention period of up to 2557 days, the equivalent of seven years.
  • "TagsList":
  • "TerminationProtectionEnabled": 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.
source
Main.Cloudtrail.create_trailMethod
create_trail(name, s3_bucket_name)
create_trail(name, s3_bucket_name, params::Dict{String,<:Any})

Creates a trail that specifies the settings for delivery of log data to an Amazon S3 bucket.

Arguments

  • name: 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: Specifies the name of the Amazon S3 bucket designated for publishing log files. See Amazon S3 Bucket Naming Requirements.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "CloudWatchLogsLogGroupArn": 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. Not required unless you specify CloudWatchLogsRoleArn.
  • "CloudWatchLogsRoleArn": Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's log group.
  • "EnableLogFileValidation": 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.
  • "IncludeGlobalServiceEvents": Specifies whether the trail is publishing events from global services such as IAM to the log files.
  • "IsMultiRegionTrail": 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.
  • "IsOrganizationTrail": 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 for an organization in Organizations.
  • "KmsKeyId": 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
  • "S3KeyPrefix": 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": Specifies the name of the Amazon SNS topic defined for notification of log file delivery. The maximum length is 256 characters.
  • "TagsList":
source
Main.Cloudtrail.delete_event_data_storeMethod
delete_event_data_store(event_data_store)
delete_event_data_store(event_data_store, params::Dict{String,<:Any})

Disables the event data store specified by EventDataStore, which accepts an event data store ARN. After you run DeleteEventDataStore, the event data store enters a PENDINGDELETION state, and is automatically deleted after a wait period of seven days. TerminationProtectionEnabled must be set to False on the event data store; this operation cannot work if TerminationProtectionEnabled is True. After you run DeleteEventDataStore on an event data store, you cannot run ListQueries, DescribeQuery, or GetQueryResults on queries that are using an event data store in a PENDINGDELETION state. An event data store in the PENDING_DELETION state does not incur costs.

Arguments

  • event_data_store: The ARN (or the ID suffix of the ARN) of the event data store to delete.
source
Main.Cloudtrail.delete_trailMethod
delete_trail(name)
delete_trail(name, params::Dict{String,<:Any})

Deletes a trail. This operation must be called from the region in which the trail was created. DeleteTrail cannot be called on the shadow trails (replicated trails in other regions) of a trail that is enabled in all regions.

Arguments

  • name: 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
source
Main.Cloudtrail.deregister_organization_delegated_adminMethod
deregister_organization_delegated_admin(delegated_admin_account_id)
deregister_organization_delegated_admin(delegated_admin_account_id, params::Dict{String,<:Any})

Removes CloudTrail delegated administrator permissions from a member account in an organization.

Arguments

  • delegated_admin_account_id: A delegated administrator account ID. This is a member account in an organization that is currently designated as a delegated administrator.
source
Main.Cloudtrail.describe_queryMethod
describe_query(query_id)
describe_query(query_id, params::Dict{String,<:Any})

Returns metadata about a query, including query run time in milliseconds, number of events scanned and matched, and query status. You must specify an ARN for EventDataStore, and a value for QueryID.

Arguments

  • query_id: The query ID.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "EventDataStore": The ARN (or the ID suffix of the ARN) of an event data store on which the specified query was run.
source
Main.Cloudtrail.describe_trailsMethod
describe_trails()
describe_trails(params::Dict{String,<:Any})

Retrieves settings for one or more trails associated with the current region for your account.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "includeShadowTrails": 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.
  • "trailNameList": 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. To return information about a trail in another region, you must specify its trail ARN.
source
Main.Cloudtrail.get_channelMethod
get_channel(channel)
get_channel(channel, params::Dict{String,<:Any})

Returns information about a specific channel. Amazon Web Services services create service-linked channels to get information about CloudTrail events on your behalf. For more information about service-linked channels, see Viewing service-linked channels for CloudTrail by using the CLI.

Arguments

  • channel: The ARN or UUID of a channel.
source
Main.Cloudtrail.get_event_data_storeMethod
get_event_data_store(event_data_store)
get_event_data_store(event_data_store, params::Dict{String,<:Any})

Returns information about an event data store specified as either an ARN or the ID portion of the ARN.

Arguments

  • event_data_store: The ARN (or ID suffix of the ARN) of the event data store about which you want information.
source
Main.Cloudtrail.get_event_selectorsMethod
get_event_selectors(trail_name)
get_event_selectors(trail_name, params::Dict{String,<:Any})

Describes the settings for the event selectors that you configured for your trail. The information returned for your event selectors includes the following: If your event selector includes read-only events, write-only events, or all events. This applies to both management events and data events. If your event selector includes management events. If your event selector includes data events, the resources on which you are logging data events. For more information about logging management and data events, see the following topics in the CloudTrail User Guide: Logging management events for trails Logging data events for trails

Arguments

  • trail_name: 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
source
Main.Cloudtrail.get_importMethod
get_import(import_id)
get_import(import_id, params::Dict{String,<:Any})

Returns information about a specific import.

Arguments

  • import_id: The ID for the import.
source
Main.Cloudtrail.get_insight_selectorsMethod
get_insight_selectors(trail_name)
get_insight_selectors(trail_name, params::Dict{String,<:Any})

Describes the settings for the Insights event selectors that you configured for your trail. GetInsightSelectors shows if CloudTrail Insights event logging is enabled on the trail, and if it is, which insight types are enabled. If you run GetInsightSelectors on a trail that does not have Insights events enabled, the operation throws the exception InsightNotEnabledException For more information, see Logging CloudTrail Insights Events for Trails in the CloudTrail User Guide.

Arguments

  • trail_name: 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
source
Main.Cloudtrail.get_query_resultsMethod
get_query_results(query_id)
get_query_results(query_id, params::Dict{String,<:Any})

Gets event data results of a query. You must specify the QueryID value returned by the StartQuery operation, and an ARN for EventDataStore.

Arguments

  • query_id: The ID of the query for which you want to get results.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "EventDataStore": The ARN (or ID suffix of the ARN) of the event data store against which the query was run.
  • "MaxQueryResults": The maximum number of query results to display on a single page.
  • "NextToken": A token you can use to get the next page of query results.
source
Main.Cloudtrail.get_trailMethod
get_trail(name)
get_trail(name, params::Dict{String,<:Any})

Returns settings information for a specified trail.

Arguments

  • name: The name or the Amazon Resource Name (ARN) of the trail for which you want to retrieve settings information.
source
Main.Cloudtrail.get_trail_statusMethod
get_trail_status(name)
get_trail_status(name, params::Dict{String,<:Any})

Returns a JSON-formatted list of information about the specified trail. Fields include information on delivery errors, Amazon SNS and Amazon S3 errors, and start and stop logging times for each trail. This operation returns trail status from a single region. To return trail status from all regions, you must call the operation on each region.

Arguments

  • name: Specifies the name or the CloudTrail ARN of the trail for which you are requesting status. To get the status of a shadow trail (a replication of the trail in another region), you must specify its ARN. The following is the format of a trail ARN. arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail
source
Main.Cloudtrail.list_channelsMethod
list_channels()
list_channels(params::Dict{String,<:Any})

Lists the channels in the current account, and their source names. Amazon Web Services services create service-linked channels get information about CloudTrail events on your behalf. For more information about service-linked channels, see Viewing service-linked channels for CloudTrail by using the CLI.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "MaxResults": The maximum number of CloudTrail channels to display on a single page.
  • "NextToken": The token to use to get the next page of results after a previous API call. This token must be passed in with the same parameters that were specified in the original call. For example, if the original call specified an AttributeKey of 'Username' with a value of 'root', the call with NextToken should include those same parameters.
source
Main.Cloudtrail.list_event_data_storesMethod
list_event_data_stores()
list_event_data_stores(params::Dict{String,<:Any})

Returns information about all event data stores in the account, in the current region.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "MaxResults": The maximum number of event data stores to display on a single page.
  • "NextToken": A token you can use to get the next page of event data store results.
source
Main.Cloudtrail.list_import_failuresMethod
list_import_failures(import_id)
list_import_failures(import_id, params::Dict{String,<:Any})

Returns a list of failures for the specified import.

Arguments

  • import_id: The ID of the import.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "MaxResults": The maximum number of failures to display on a single page.
  • "NextToken": A token you can use to get the next page of import failures.
source
Main.Cloudtrail.list_importsMethod
list_imports()
list_imports(params::Dict{String,<:Any})

Returns information on all imports, or a select set of imports by ImportStatus or Destination.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "Destination": The ARN of the destination event data store.
  • "ImportStatus": The status of the import.
  • "MaxResults": The maximum number of imports to display on a single page.
  • "NextToken": A token you can use to get the next page of import results.
source
Main.Cloudtrail.list_public_keysMethod
list_public_keys()
list_public_keys(params::Dict{String,<:Any})

Returns all public keys whose private keys were used to sign the digest files within the specified time range. The public key is needed to validate digest files that were signed with its corresponding private key. CloudTrail uses different private and public key pairs per region. Each digest file is signed with a private key unique to its region. When you validate a digest file from a specific region, you must look in the same region for its corresponding public key.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "EndTime": Optionally specifies, in UTC, the end of the time range to look up public keys for CloudTrail digest files. If not specified, the current time is used.
  • "NextToken": Reserved for future use.
  • "StartTime": Optionally specifies, in UTC, the start of the time range to look up public keys for CloudTrail digest files. If not specified, the current time is used, and the current public key is returned.
source
Main.Cloudtrail.list_queriesMethod
list_queries(event_data_store)
list_queries(event_data_store, params::Dict{String,<:Any})

Returns a list of queries and query statuses for the past seven days. You must specify an ARN value for EventDataStore. Optionally, to shorten the list of results, you can specify a time range, formatted as timestamps, by adding StartTime and EndTime parameters, and a QueryStatus value. Valid values for QueryStatus include QUEUED, RUNNING, FINISHED, FAILED, TIMED_OUT, or CANCELLED.

Arguments

  • event_data_store: The ARN (or the ID suffix of the ARN) of an event data store on which queries were run.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "EndTime": Use with StartTime to bound a ListQueries request, and limit its results to only those queries run within a specified time period.
  • "MaxResults": The maximum number of queries to show on a page.
  • "NextToken": A token you can use to get the next page of results.
  • "QueryStatus": The status of queries that you want to return in results. Valid values for QueryStatus include QUEUED, RUNNING, FINISHED, FAILED, TIMED_OUT, or CANCELLED.
  • "StartTime": Use with EndTime to bound a ListQueries request, and limit its results to only those queries run within a specified time period.
source
Main.Cloudtrail.list_tagsMethod
list_tags(resource_id_list)
list_tags(resource_id_list, params::Dict{String,<:Any})

Lists the tags for the trail or event data store in the current region.

Arguments

  • resource_id_list: Specifies a list of trail and event data store ARNs whose tags will be listed. The list has a limit of 20 ARNs.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "NextToken": Reserved for future use.
source
Main.Cloudtrail.list_trailsMethod
list_trails()
list_trails(params::Dict{String,<:Any})

Lists trails that are in the current account.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "NextToken": The token to use to get the next page of results after a previous API call. This token must be passed in with the same parameters that were specified in the original call. For example, if the original call specified an AttributeKey of 'Username' with a value of 'root', the call with NextToken should include those same parameters.
source
Main.Cloudtrail.lookup_eventsMethod
lookup_events()
lookup_events(params::Dict{String,<:Any})

Looks up management events or CloudTrail Insights events that are captured by CloudTrail. You can look up events that occurred in a region within the last 90 days. Lookup supports the following attributes for management events: Amazon Web Services access key Event ID Event name Event source Read only Resource name Resource type User name Lookup supports the following attributes for Insights events: Event ID Event name Event source All attributes are optional. The default number of results returned is 50, with a maximum of 50 possible. The response includes a token that you can use to get the next page of results. The rate of lookup requests is limited to two per second, per account, per region. If this limit is exceeded, a throttling error occurs.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "EndTime": Specifies that only events that occur before or at the specified time are returned. If the specified end time is before the specified start time, an error is returned.
  • "EventCategory": Specifies the event category. If you do not specify an event category, events of the category are not returned in the response. For example, if you do not specify insight as the value of EventCategory, no Insights events are returned.
  • "LookupAttributes": Contains a list of lookup attributes. Currently the list can contain only one item.
  • "MaxResults": The number of events to return. Possible values are 1 through 50. The default is 50.
  • "NextToken": The token to use to get the next page of results after a previous API call. This token must be passed in with the same parameters that were specified in the original call. For example, if the original call specified an AttributeKey of 'Username' with a value of 'root', the call with NextToken should include those same parameters.
  • "StartTime": Specifies that only events that occur after or at the specified time are returned. If the specified start time is after the specified end time, an error is returned.
source
Main.Cloudtrail.put_event_selectorsMethod
put_event_selectors(trail_name)
put_event_selectors(trail_name, params::Dict{String,<:Any})

Configures an event selector or advanced event selectors for your trail. Use event selectors or advanced event selectors to specify management and data event settings for your trail. By default, trails created without specific event selectors are configured to log all read and write management events, and no data events. When an event occurs in your account, CloudTrail evaluates the event selectors or advanced event selectors in all trails. For each trail, if the event matches any event selector, the trail processes and logs the event. If the event doesn't match any event selector, the trail doesn't log the event. Example You create an event selector for a trail and specify that you want write-only events. The EC2 GetConsoleOutput and RunInstances API operations occur in your account. CloudTrail evaluates whether the events match your event selectors. The RunInstances is a write-only event and it matches your event selector. The trail logs the event. The GetConsoleOutput is a read-only event that doesn't match your event selector. The trail doesn't log the event. The PutEventSelectors operation must be called from the region in which the trail was created; otherwise, an InvalidHomeRegionException exception is thrown. You can configure up to five event selectors for each trail. For more information, see Logging management events for trails , Logging data events for trails , and Quotas in CloudTrail in the CloudTrail User Guide. You can add advanced event selectors, and conditions for your advanced event selectors, up to a maximum of 500 values for all conditions and selectors on a trail. You can use either AdvancedEventSelectors or EventSelectors, but not both. If you apply AdvancedEventSelectors to a trail, any existing EventSelectors are overwritten. For more information about advanced event selectors, see Logging data events for trails in the CloudTrail User Guide.

Arguments

  • trail_name: 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 following format. arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "AdvancedEventSelectors": Specifies the settings for advanced event selectors. You can add advanced event selectors, and conditions for your advanced event selectors, up to a maximum of 500 values for all conditions and selectors on a trail. You can use either AdvancedEventSelectors or EventSelectors, but not both. If you apply AdvancedEventSelectors to a trail, any existing EventSelectors are overwritten. For more information about advanced event selectors, see Logging data events for trails in the CloudTrail User Guide.
  • "EventSelectors": Specifies the settings for your event selectors. You can configure up to five event selectors for a trail. You can use either EventSelectors or AdvancedEventSelectors in a PutEventSelectors request, but not both. If you apply EventSelectors to a trail, any existing AdvancedEventSelectors are overwritten.
source
Main.Cloudtrail.put_insight_selectorsMethod
put_insight_selectors(insight_selectors, trail_name)
put_insight_selectors(insight_selectors, trail_name, params::Dict{String,<:Any})

Lets you enable Insights event logging by specifying the Insights selectors that you want to enable on an existing trail. You also use PutInsightSelectors to turn off Insights event logging, by passing an empty list of insight types. The valid Insights event types in this release are ApiErrorRateInsight and ApiCallRateInsight.

Arguments

  • insight_selectors: A JSON string that contains the insight types you want to log on a trail. ApiCallRateInsight and ApiErrorRateInsight are valid insight types.
  • trail_name: The name of the CloudTrail trail for which you want to change or add Insights selectors.
source
Main.Cloudtrail.register_organization_delegated_adminMethod
register_organization_delegated_admin(member_account_id)
register_organization_delegated_admin(member_account_id, params::Dict{String,<:Any})

Registers an organization’s member account as the CloudTrail delegated administrator.

Arguments

  • member_account_id: An organization member account ID that you want to designate as a delegated administrator.
source
Main.Cloudtrail.remove_tagsMethod
remove_tags(resource_id, tags_list)
remove_tags(resource_id, tags_list, params::Dict{String,<:Any})

Removes the specified tags from a trail or event data store.

Arguments

  • resource_id: Specifies the ARN of the trail or event data store from which tags should be removed. Example trail ARN format: arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail Example event data store ARN format: arn:aws:cloudtrail:us-east-2:12345678910:eventdatastore/EXAMPLE-f852-4e8f-8bd1-bcf6cEXAMPLE
  • tags_list: Specifies a list of tags to be removed.
source
Main.Cloudtrail.restore_event_data_storeMethod
restore_event_data_store(event_data_store)
restore_event_data_store(event_data_store, params::Dict{String,<:Any})

Restores a deleted event data store specified by EventDataStore, which accepts an event data store ARN. You can only restore a deleted event data store within the seven-day wait period after deletion. Restoring an event data store can take several minutes, depending on the size of the event data store.

Arguments

  • event_data_store: The ARN (or the ID suffix of the ARN) of the event data store that you want to restore.
source
Main.Cloudtrail.start_importMethod
start_import()
start_import(params::Dict{String,<:Any})

Starts an import of logged trail events from a source S3 bucket to a destination event data store. By default, CloudTrail only imports events contained in the S3 bucket's CloudTrail prefix and the prefixes inside the CloudTrail prefix, and does not check prefixes for other Amazon Web Services services. If you want to import CloudTrail events contained in another prefix, you must include the prefix in the S3LocationUri. For more considerations about importing trail events, see Considerations. When you start a new import, the Destinations and ImportSource parameters are required. Before starting a new import, disable any access control lists (ACLs) attached to the source S3 bucket. For more information about disabling ACLs, see Controlling ownership of objects and disabling ACLs for your bucket. When you retry an import, the ImportID parameter is required.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "Destinations": The ARN of the destination event data store. Use this parameter for a new import.
  • "EndEventTime": Use with StartEventTime to bound a StartImport request, and limit imported trail events to only those events logged within a specified time period. When you specify a time range, CloudTrail checks the prefix and log file names to verify the names contain a date between the specified StartEventTime and EndEventTime before attempting to import events.
  • "ImportId": The ID of the import. Use this parameter when you are retrying an import.
  • "ImportSource": The source S3 bucket for the import. Use this parameter for a new import.
  • "StartEventTime": Use with EndEventTime to bound a StartImport request, and limit imported trail events to only those events logged within a specified time period. When you specify a time range, CloudTrail checks the prefix and log file names to verify the names contain a date between the specified StartEventTime and EndEventTime before attempting to import events.
source
Main.Cloudtrail.start_loggingMethod
start_logging(name)
start_logging(name, params::Dict{String,<:Any})

Starts the recording of Amazon Web Services API calls and log file delivery for a trail. For a trail that is enabled in all regions, this operation must be called from the region in which the trail was created. This operation cannot be called on the shadow trails (replicated trails in other regions) of a trail that is enabled in all regions.

Arguments

  • name: Specifies the name or the CloudTrail ARN of the trail for which CloudTrail logs Amazon Web Services API calls. The following is the format of a trail ARN. arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail
source
Main.Cloudtrail.start_queryMethod
start_query(query_statement)
start_query(query_statement, params::Dict{String,<:Any})

Starts a CloudTrail Lake query. The required QueryStatement parameter provides your SQL query, enclosed in single quotation marks. Use the optional DeliveryS3Uri parameter to deliver the query results to an S3 bucket.

Arguments

  • query_statement: The SQL code of your query.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "DeliveryS3Uri": The URI for the S3 bucket where CloudTrail delivers the query results.
source
Main.Cloudtrail.stop_importMethod
stop_import(import_id)
stop_import(import_id, params::Dict{String,<:Any})

Stops a specified import.

Arguments

  • import_id: The ID of the import.
source
Main.Cloudtrail.stop_loggingMethod
stop_logging(name)
stop_logging(name, params::Dict{String,<:Any})

Suspends the recording of Amazon Web Services API calls and log file delivery for the specified trail. Under most circumstances, there is no need to use this action. You can update a trail without stopping it first. This action is the only way to stop recording. For a trail enabled in all regions, this operation must be called from the region in which the trail was created, or an InvalidHomeRegionException will occur. This operation cannot be called on the shadow trails (replicated trails in other regions) of a trail enabled in all regions.

Arguments

  • name: Specifies the name or the CloudTrail ARN of the trail for which CloudTrail will stop logging Amazon Web Services API calls. The following is the format of a trail ARN. arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail
source
Main.Cloudtrail.update_event_data_storeMethod
update_event_data_store(event_data_store)
update_event_data_store(event_data_store, params::Dict{String,<:Any})

Updates an event data store. The required EventDataStore value is an ARN or the ID portion of the ARN. Other parameters are optional, but at least one optional parameter must be specified, or CloudTrail throws an error. RetentionPeriod is in days, and valid values are integers between 90 and 2557. By default, TerminationProtection is enabled. AdvancedEventSelectors includes or excludes management and data events in your event data store; for more information about AdvancedEventSelectors, see PutEventSelectorsRequestAdvancedEventSelectors.

Arguments

  • event_data_store: The ARN (or the ID suffix of the ARN) of the event data store that you want to update.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "AdvancedEventSelectors": The advanced event selectors used to select events for the event data store. You can configure up to five advanced event selectors for each event data store.
  • "KmsKeyId": 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
  • "MultiRegionEnabled": Specifies whether an event data store collects events from all regions, or only from the region in which it was created.
  • "Name": The event data store name.
  • "OrganizationEnabled": Specifies whether an event data store collects events logged for an organization in Organizations.
  • "RetentionPeriod": The retention period, in days.
  • "TerminationProtectionEnabled": Indicates that termination protection is enabled and the event data store cannot be automatically deleted.
source
Main.Cloudtrail.update_trailMethod
update_trail(name)
update_trail(name, params::Dict{String,<:Any})

Updates trail settings that control what events you are logging, and how to handle log files. Changes to a trail do not require stopping the CloudTrail service. Use this action to designate an existing bucket for log delivery. If the existing bucket has previously been a target for CloudTrail log files, an IAM policy exists for the bucket. UpdateTrail must be called from the region in which the trail was created; otherwise, an InvalidHomeRegionException is thrown.

Arguments

  • name: Specifies the name of the trail or trail ARN. If Name is 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 Name is a trail ARN, it must be in the following format. arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "CloudWatchLogsLogGroupArn": Specifies a log group name using an Amazon Resource Name (ARN), a unique identifier that represents the log group to which CloudTrail logs are delivered. Not required unless you specify CloudWatchLogsRoleArn.
  • "CloudWatchLogsRoleArn": Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's log group.
  • "EnableLogFileValidation": Specifies whether log file 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.
  • "IncludeGlobalServiceEvents": Specifies whether the trail is publishing events from global services such as IAM to the log files.
  • "IsMultiRegionTrail": Specifies whether the trail applies only to the current region or to all regions. The default is false. If the trail exists only in the current region and this value is set to true, shadow trails (replications of the trail) will be created in the other regions. If the trail exists in all regions and this value is set to false, the trail will remain in the region where it was created, and its shadow trails in other regions will be deleted. As a best practice, consider using trails that log events in all regions.
  • "IsOrganizationTrail": Specifies whether the trail is applied to 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 for an organization in Organizations. If the trail is not an organization trail and this is set to true, the trail will be created in all Amazon Web Services accounts that belong to the organization. If the trail is an organization trail and this is set to false, the trail will remain in the current Amazon Web Services account but be deleted from all member accounts in the organization.
  • "KmsKeyId": 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
  • "S3BucketName": Specifies the name of the Amazon S3 bucket designated for publishing log files. See Amazon S3 Bucket Naming Requirements.
  • "S3KeyPrefix": 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": Specifies the name of the Amazon SNS topic defined for notification of log file delivery. The maximum length is 256 characters.
source