CloudWatch Logs examples using Amazon CLI - Amazon Command Line Interface
Actions
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

CloudWatch Logs examples using Amazon CLI

The following code examples show you how to perform actions and implement common scenarios by using the Amazon Command Line Interface with CloudWatch Logs.

Actions are code excerpts from larger programs and must be run in context. While actions show you how to call individual service functions, you can see actions in context in their related scenarios and cross-service examples.

Scenarios are code examples that show you how to accomplish a specific task by calling multiple functions within the same service.

Each example includes a link to GitHub, where you can find instructions on how to set up and run the code in context.

Topics

Actions

The following code example shows how to use create-log-group.

Amazon CLI

The following command creates a log group named my-logs:

aws logs create-log-group --log-group-name my-logs

  • For API details, see CreateLogGroup in Amazon CLI Command Reference.

The following code example shows how to use create-log-stream.

Amazon CLI

The following command creates a log stream named 20150601 in the log group my-logs:

aws logs create-log-stream --log-group-name my-logs --log-stream-name 20150601

The following code example shows how to use delete-log-group.

Amazon CLI

The following command deletes a log group named my-logs:

aws logs delete-log-group --log-group-name my-logs

  • For API details, see DeleteLogGroup in Amazon CLI Command Reference.

The following code example shows how to use delete-log-stream.

Amazon CLI

The following command deletes a log stream named 20150531 from a log group named my-logs:

aws logs delete-log-stream --log-group-name my-logs --log-stream-name 20150531

The following code example shows how to use delete-retention-policy.

Amazon CLI

The following command removes the retention policy that has previously been applied to a log group named my-logs:

aws logs delete-retention-policy --log-group-name my-logs

The following code example shows how to use describe-log-groups.

Amazon CLI

The following command describes a log group named my-logs:

aws logs describe-log-groups --log-group-name-prefix my-logs

Output:

{
    "logGroups": [
        {
            "storedBytes": 0,
            "metricFilterCount": 0,
            "creationTime": 1433189500783,
            "logGroupName": "my-logs",
            "retentionInDays": 5,
            "arn": "arn:aws:logs:us-west-2:0123456789012:log-group:my-logs:*"
        }
    ]
}

The following code example shows how to use describe-log-streams.

Amazon CLI

The following command shows all log streams starting with the prefix 2015 in the log group my-logs:

aws logs describe-log-streams --log-group-name my-logs --log-stream-name-prefix 2015

Output:

{
    "logStreams": [
        {
            "creationTime": 1433189871774,
            "arn": "arn:aws:logs:us-west-2:0123456789012:log-group:my-logs:log-stream:20150531",
            "logStreamName": "20150531",
            "storedBytes": 0
        },
        {
            "creationTime": 1433189873898,
            "arn": "arn:aws:logs:us-west-2:0123456789012:log-group:my-logs:log-stream:20150601",
            "logStreamName": "20150601",
            "storedBytes": 0
        }
    ]
}

The following code example shows how to use get-log-events.

Amazon CLI

The following command retrieves log events from a log stream named 20150601 in the log group my-logs:

aws logs get-log-events --log-group-name my-logs --log-stream-name 20150601

Output:

{
    "nextForwardToken": "f/31961209122447488583055879464742346735121166569214640130",
    "events": [
        {
            "ingestionTime": 1433190494190,
            "timestamp": 1433190184356,
            "message": "Example Event 1"
        },
        {
            "ingestionTime": 1433190516679,
            "timestamp": 1433190184356,
            "message": "Example Event 1"
        },
        {
            "ingestionTime": 1433190494190,
            "timestamp": 1433190184358,
            "message": "Example Event 2"
        }
    ],
    "nextBackwardToken": "b/31961209122358285602261756944988674324553373268216709120"
}

  • For API details, see GetLogEvents in Amazon CLI Command Reference.

The following code example shows how to use put-log-events.

Amazon CLI

The following command puts log events to a log stream named 20150601 in the log group my-logs:

aws logs put-log-events --log-group-name my-logs --log-stream-name 20150601 --log-events file://events

Output:

{
    "nextSequenceToken": "49542672486831074009579604567656788214806863282469607346"
}

The above example reads a JSON array of events from a file named events in the current directory:

[
  {
    "timestamp": 1433190184356,
    "message": "Example Event 1"
  },
  {
    "timestamp": 1433190184358,
    "message": "Example Event 2"
  },
  {
    "timestamp": 1433190184360,
    "message": "Example Event 3"
  }
]

Each subsequent call requires the next sequence token provided by the previous call to be specified with the sequence token option:

aws logs put-log-events --log-group-name my-logs --log-stream-name 20150601 --log-events file://events2 --sequence-token "49542672486831074009579604567656788214806863282469607346"

Output:

{
    "nextSequenceToken": "49542672486831074009579604567900991230369019956308219826"
}

  • For API details, see PutLogEvents in Amazon CLI Command Reference.

The following code example shows how to use put-retention-policy.

Amazon CLI

The following command adds a 5 day retention policy to a log group named my-logs:

aws logs put-retention-policy --log-group-name my-logs --retention-in-days 5