cloudtrail_describe_trails: Retrieves settings for one or more trails associated with the...

Description Usage Arguments Value Request syntax

View source: R/cloudtrail_operations.R

Description

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

Usage

1
cloudtrail_describe_trails(trailNameList, includeShadowTrails)

Arguments

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.

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.

Value

A list with the following syntax:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
list(
  trailList = list(
    list(
      Name = "string",
      S3BucketName = "string",
      S3KeyPrefix = "string",
      SnsTopicName = "string",
      SnsTopicARN = "string",
      IncludeGlobalServiceEvents = TRUE|FALSE,
      IsMultiRegionTrail = TRUE|FALSE,
      HomeRegion = "string",
      TrailARN = "string",
      LogFileValidationEnabled = TRUE|FALSE,
      CloudWatchLogsLogGroupArn = "string",
      CloudWatchLogsRoleArn = "string",
      KmsKeyId = "string",
      HasCustomEventSelectors = TRUE|FALSE,
      HasInsightSelectors = TRUE|FALSE,
      IsOrganizationTrail = TRUE|FALSE
    )
  )
)

Request syntax

1
2
3
4
5
6
svc$describe_trails(
  trailNameList = list(
    "string"
  ),
  includeShadowTrails = TRUE|FALSE
)

paws.management documentation built on Aug. 23, 2021, 9:11 a.m.