cloudtrail: AWS CloudTrail

Description Usage Arguments Value Service syntax Operations Examples

View source: R/cloudtrail_service.R

Description

This is the CloudTrail API Reference. It provides descriptions of actions, data types, common parameters, and common errors for CloudTrail.

CloudTrail is a web service that records AWS API calls for your AWS account and delivers log files to an Amazon S3 bucket. The recorded information includes the identity of the user, the start time of the AWS API call, the source IP address, the request parameters, and the response elements returned by the service.

As an alternative to the API, you can use one of the AWS SDKs, which consist of libraries and sample code for various programming languages and platforms (Java, Ruby, .NET, iOS, Android, etc.). The SDKs provide a convenient way to create programmatic access to AWSCloudTrail. For example, the SDKs take care of cryptographically signing requests, managing errors, and retrying requests automatically. For information about the AWS SDKs, including how to download and install them, see the Tools for Amazon Web Services page.

See the AWS CloudTrail User Guide for information about the data that is included with each AWS API call listed in the log files.

Usage

1
cloudtrail(config = list())

Arguments

config

Optional configuration of credentials, endpoint, and/or region.

Value

A client for the service. You can call the service's operations using syntax like svc$operation(...), where svc is the name you've assigned to the client. The available operations are listed in the Operations section.

Service syntax

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
svc <- cloudtrail(
  config = list(
    credentials = list(
      creds = list(
        access_key_id = "string",
        secret_access_key = "string",
        session_token = "string"
      ),
      profile = "string"
    ),
    endpoint = "string",
    region = "string"
  )
)

Operations

add_tags Adds one or more tags to a trail, up to a limit of 50
create_trail Creates a trail that specifies the settings for delivery of log data to an Amazon S3 bucket
delete_trail Deletes a trail
describe_trails Retrieves settings for one or more trails associated with the current region for your account
get_event_selectors Describes the settings for the event selectors that you configured for your trail
get_insight_selectors Describes the settings for the Insights event selectors that you configured for your trail
get_trail Returns settings information for a specified trail
get_trail_status Returns a JSON-formatted list of information about the specified trail
list_public_keys Returns all public keys whose private keys were used to sign the digest files within the specified time range
list_tags Lists the tags for the trail in the current region
list_trails Lists trails that are in the current account
lookup_events Looks up management events or CloudTrail Insights events that are captured by CloudTrail
put_event_selectors Configures an event selector or advanced event selectors for your trail
put_insight_selectors Lets you enable Insights event logging by specifying the Insights selectors that you want to enable on an existing trail
remove_tags Removes the specified tags from a trail
start_logging Starts the recording of AWS API calls and log file delivery for a trail
stop_logging Suspends the recording of AWS API calls and log file delivery for the specified trail
update_trail Updates the settings that specify delivery of log files

Examples

1
2
3
4
5
6
7
## Not run: 
svc <- cloudtrail()
svc$add_tags(
  Foo = 123
)

## End(Not run)

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