AWS CloudWatch actions

This page provides a comprehensive reference for aws cloudwatch actions available in the workflow automation actions catalog. These actions enable you to cloudwatch logs operations.

Prerequisites

Before using AWS actions in workflow automation, ensure you have:

An AWS account with appropriate permissions.
AWS credentials configured (IAM user credentials, IAM role ARN, or session credentials).
The necessary IAM permissions for the specific AWS services you plan to use.

See Set up AWS credentials for information on how to create IAM users and IAM roles, and set up static and session AWS credentials for integration with workflow automation AWS actions.

Retrieves a batch of log events from a specified log stream in AWS CloudWatch Logs. It's essential for monitoring, auditing, and troubleshooting applications by programmatically fetching log data.

Input Field	Optionality	Type	Example
awsRoleArn	Optional	String	`arn:aws:iam::123456789012:role/my-workflow-role`
awsAccessKeyId	Optional	String	`${{ :secrets:<awsAccessKeyId> }}`
awsSecretAccessKey	Optional	String	`${{ :secrets:<awsSecretAccessKey> }}`
awsSessionToken	Optional	String	`${{ :secrets:<awsSessionToken> }}`
region	Required	String	`"us-east-2"`
logStreamName	Required	String	`"2023/10/27/[$LATEST]abcdef123456"`
logGroupName	Optional	String	`"/aws/lambda/my-function"`
logGroupIdentifier	Optional	String	`"arn:partition:service:region:account-id:resource"`
startTime	Optional	Int	`1759296000000`
endTime	Optional	Int	`1759296000000`
limit	Optional	Int	`50`
startFromHead	Optional	Boolean	`true`
unmask	Optional	Boolean	`false`
nextToken	Optional	String	`"f/39218833627378687642013305455131706539523449361490509828/s"`

Output Field	Type	Example
response	Object	`{ 'events': [ { 'timestamp': 123, 'message': 'string', 'ingestionTime': 123 }, ], 'nextForwardToken': 'string', 'nextBackwardToken': 'string' }`
success	Boolean	`success: true \| false`
errorMessage	String	`"An error occurred (ExpiredTokenException) when calling the GetLogEvents operation: The security token included in the request is expired"`

name: get-lambda-logs
description: 'Retrieve log events from an AWS Lambda function'
workflowInputs:
  region:
    type: String
    defaultValue: us-east-2
  logGroupName:
    type: String
    defaultValue: /aws/lambda/my-function
  logStreamName:
    type: String
    defaultValue: 2023/10/27/[$LATEST]abcdef123456
steps:
  name: get_events_step
  type: action
  action: aws.cloudwatch.get_log_events
  version: '1'
  inputs:
    region: ${{ .workflowInputs.region }}
    logGroupName: ${{ .workflowInputs.logGroupName }}
    logStreamName: ${{ .workflowInputs.logStreamName }}
    limit: 100

This uploads a batch of log events to the specified log stream in AWS CloudWatch Logs. It is used for programmatically sending log data from applications or services to CloudWatch for monitoring and analysis.

Input Field	Optionality	Type	Example
awsRoleArn	Optional	String	`arn:aws:iam::123456789012:role/my-workflow-role`
awsAccessKeyId	Optional	String	`${{ :secrets:<awsAccessKeyId> }}`
awsSecretAccessKey	Optional	String	`${{ :secrets:<awsSecretAccessKey> }}`
awsSessionToken	Optional	String	`${{ :secrets:<awsSessionToken> }}`
region	Required	String	`"us-east-2"`
logGroupName	Required	String	`"/aws/lambda/hello-you"`
logStreamName	Required	String	`"2025/09/24/[$LATEST]09f7ca9e9ab044f389419ce60305f594"`
logEvents	Required	List	`[ { "timestamp": 1698384000000, "message": "Workflow task started." }, { "timestamp": 1698384000015, "message": "Data validated successfully." } ]`
entity	Optional	Dict	`{ "entity": { "keyAttributes": { "ResourceType": "AWS::ElasticLoadBalancingV2::LoadBalancer", "Identifier": "app/my-web-lb/12345", "Environment": "Production" }, "attributes": { "MonitoringTier": "Gold", "OwnerTeam": "Networking", "MaintenanceWindow": "Sat: 0200-0400" } } }`

Output Field	Type	Description	Example
response	Object	The raw JSON response, which includes the `nextSequenceToken`.	`{ 'nextSequenceToken': 'string', 'rejectedLogEventsInfo': { 'tooNewLogEventStartIndex': 123, 'tooOldLogEventEndIndex': 123, 'expiredLogEventEndIndex': 123 }, 'rejectedEntityInfo': { 'errorType': 'InvalidEntity'\|'InvalidTypeValue'\|'InvalidKeyAttributes'\|'InvalidAttributes'\|'EntitySizeTooLarge'\|'UnsupportedLogGroupType'\|'MissingRequiredFields' } }`
success	Boolean	Indicates whether the log events were successfully uploaded.	`true`
errorMessage	String	A descriptive error message if the action failed.	`"An error occurred (ExpiredTokenException) when calling the PutLogEvents operation: The security token included in the request is expired"`

Workflow example
name: put-custom-logs description: 'Upload a batch of custom log events to CloudWatch' workflowInputs: region: type: String defaultValue: us-east-2 logGroupName: type: String defaultValue: my-custom-app-logs logStreamName: type: String defaultValue: instance-01-thread-01 steps: - name: upload_logs type: action action: aws.cloudwatch.put_log_events version: '1' inputs: region: ${{ .workflowInputs.region }} logGroupName: ${{ .workflowInputs.logGroupName }} logStreamName: ${{ .workflowInputs.logStreamName }} logEvents: - timestamp: 1698384000000 message: "Workflow started successfully" - timestamp: 1698384005000 message: "Step 1 completed" next: end

Workflow example

name: put-custom-logs
description: 'Upload a batch of custom log events to CloudWatch'

workflowInputs:
  region:
    type: String
    defaultValue: us-east-2
  logGroupName:
    type: String
    defaultValue: my-custom-app-logs
  logStreamName:
    type: String
    defaultValue: instance-01-thread-01
  
steps:
  - name: upload_logs
    type: action
    action: aws.cloudwatch.put_log_events
    version: '1'
    inputs:
      region: ${{ .workflowInputs.region }}
      logGroupName: ${{ .workflowInputs.logGroupName }}
      logStreamName: ${{ .workflowInputs.logStreamName }}
      logEvents:
        - timestamp: 1698384000000
          message: "Workflow started successfully"
        - timestamp: 1698384005000
          message: "Step 1 completed"
    next: end

Prerequisites

Get CloudWatch log events

Put log events

AWS CloudWatch actions

Prerequisites.css-21sua1{background:none;border:none;width:0;padding:0;}

Put log events

Prerequisites