paws.management: cloudtrail_get_trail_status – R documentation

Become an expert in R — Interactive courses, Cheat Sheets, certificates and more!

cloudtrail_get_trail_status

Returns a JSON-formatted list of information about the specified trail

Description

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.

Usage

cloudtrail_get_trail_status(Name)

Arguments

Name

[required] 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 format of a trail ARN is:

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

Value

A list with the following syntax:

list(
  IsLogging = TRUE|FALSE,
  LatestDeliveryError = "string",
  LatestNotificationError = "string",
  LatestDeliveryTime = as.POSIXct(
    "2015-01-01"
  ),
  LatestNotificationTime = as.POSIXct(
    "2015-01-01"
  ),
  StartLoggingTime = as.POSIXct(
    "2015-01-01"
  ),
  StopLoggingTime = as.POSIXct(
    "2015-01-01"
  ),
  LatestCloudWatchLogsDeliveryError = "string",
  LatestCloudWatchLogsDeliveryTime = as.POSIXct(
    "2015-01-01"
  ),
  LatestDigestDeliveryTime = as.POSIXct(
    "2015-01-01"
  ),
  LatestDigestDeliveryError = "string",
  LatestDeliveryAttemptTime = "string",
  LatestNotificationAttemptTime = "string",
  LatestNotificationAttemptSucceeded = "string",
  LatestDeliveryAttemptSucceeded = "string",
  TimeLoggingStarted = "string",
  TimeLoggingStopped = "string"
)

Request syntax

svc$get_trail_status(
  Name = "string"
)

paws.management

Amazon Web Services Management & Governance Services

v0.1.11

Apache License (>= 2.0)

Authors

David Kretch [aut, cre], Adam Banker [aut], Amazon.com, Inc. [cph]

Initial release