Learn R Programming

paws (version 0.1.12)

cloudwatchlogs: Amazon CloudWatch Logs

Description

You can use Amazon CloudWatch Logs to monitor, store, and access your log files from EC2 instances, AWS CloudTrail, or other sources. You can then retrieve the associated log data from CloudWatch Logs using the CloudWatch console, CloudWatch Logs commands in the AWS CLI, CloudWatch Logs API, or CloudWatch Logs SDK.

You can use CloudWatch Logs to:

  • Monitor logs from EC2 instances in real-time: You can use CloudWatch Logs to monitor applications and systems using log data. For example, CloudWatch Logs can track the number of errors that occur in your application logs and send you a notification whenever the rate of errors exceeds a threshold that you specify. CloudWatch Logs uses your log data for monitoring so no code changes are required. For example, you can monitor application logs for specific literal terms (such as "NullReferenceException") or count the number of occurrences of a literal term at a particular position in log data (such as "404" status codes in an Apache access log). When the term you are searching for is found, CloudWatch Logs reports the data to a CloudWatch metric that you specify.

  • Monitor AWS CloudTrail logged events: You can create alarms in CloudWatch and receive notifications of particular API activity as captured by CloudTrail. You can use the notification to perform troubleshooting.

  • Archive log data: You can use CloudWatch Logs to store your log data in highly durable storage. You can change the log retention setting so that any log events older than this setting are automatically deleted. The CloudWatch Logs agent makes it easy to quickly send both rotated and non-rotated log data off of a host and into the log service. You can then access the raw log data when you need it.

Usage

cloudwatchlogs(config = list())

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.

Arguments

config

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

Service syntax

svc <- cloudwatchlogs(
  config = list(
    credentials = list(
      creds = list(
        access_key_id = "string",
        secret_access_key = "string",
        session_token = "string"
      ),
      profile = "string"
    ),
    endpoint = "string",
    region = "string"
  )
)

Operations

associate_kms_keyAssociates the specified AWS Key Management Service (AWS KMS) customer master key (CMK) with the specified log group
cancel_export_taskCancels the specified export task
create_export_taskCreates an export task, which allows you to efficiently export data from a log group to an Amazon S3 bucket
create_log_groupCreates a log group with the specified name
create_log_streamCreates a log stream for the specified log group
delete_destinationDeletes the specified destination, and eventually disables all the subscription filters that publish to it
delete_log_groupDeletes the specified log group and permanently deletes all the archived log events associated with the log group
delete_log_streamDeletes the specified log stream and permanently deletes all the archived log events associated with the log stream
delete_metric_filterDeletes the specified metric filter
delete_query_definitionDeletes a saved CloudWatch Logs Insights query definition
delete_resource_policyDeletes a resource policy from this account
delete_retention_policyDeletes the specified retention policy
delete_subscription_filterDeletes the specified subscription filter
describe_destinationsLists all your destinations
describe_export_tasksLists the specified export tasks
describe_log_groupsLists the specified log groups
describe_log_streamsLists the log streams for the specified log group
describe_metric_filtersLists the specified metric filters
describe_queriesReturns a list of CloudWatch Logs Insights queries that are scheduled, executing, or have been executed recently in this account
describe_query_definitionsThis operation returns a paginated list of your saved CloudWatch Logs Insights query definitions
describe_resource_policiesLists the resource policies in this account
describe_subscription_filtersLists the subscription filters for the specified log group
disassociate_kms_keyDisassociates the associated AWS Key Management Service (AWS KMS) customer master key (CMK) from the specified log group
filter_log_eventsLists log events from the specified log group
get_log_eventsLists log events from the specified log stream
get_log_group_fieldsReturns a list of the fields that are included in log events in the specified log group, along with the percentage of log events that contain each field
get_log_recordRetrieves all of the fields and values of a single log event
get_query_resultsReturns the results from the specified query
list_tags_log_groupLists the tags for the specified log group
put_destinationCreates or updates a destination
put_destination_policyCreates or updates an access policy associated with an existing destination
put_log_eventsUploads a batch of log events to the specified log stream
put_metric_filterCreates or updates a metric filter and associates it with the specified log group
put_query_definitionCreates or updates a query definition for CloudWatch Logs Insights
put_resource_policyCreates or updates a resource policy allowing other AWS services to put log events to this account, such as Amazon Route 53
put_retention_policySets the retention of the specified log group
put_subscription_filterCreates or updates a subscription filter and associates it with the specified log group
start_querySchedules a query of a log group using CloudWatch Logs Insights
stop_queryStops a CloudWatch Logs Insights query that is in progress
tag_log_groupAdds or updates the specified tags for the specified log group
test_metric_filterTests the filter pattern of a metric filter against a sample of log event messages
untag_log_groupRemoves the specified tags from the specified log group

Examples

Run this code
if (FALSE) {
svc <- cloudwatchlogs()
svc$associate_kms_key(
  Foo = 123
)
}

Run the code above in your browser using DataLab