AWS CloudWatchアクション

このページでは、ワークフロー自動化アクションカタログで利用可能なAWS CloudWatchアクションのリファレンスを提供します。これらのアクションを使用して、AWS CloudWatchでログデータを取得およびアップロードします。

前提条件

前提条件と認証情報のセットアップについては、AWS認証情報のセットアップをご覧ください。

ログイベントを取得する

アクション識別子はaws.cloudwatch.getLogEventsです。

AWS CloudWatchログの指定されたログストリームからログイベントのバッチを取得します。

次の表に、このアクションの入力フィールドについて説明します。

入力	タイプ	説明	例
`awsRoleArn`	弦	オプション。 AWS APIコール用に引き受けるIAMロールARN。	`arn:aws:iam::123456789012:role/my-workflow-role`
`awsAccessKeyId`	弦	オプション。 AWSアクセスキーID。シークレットとして渡します。	`${{ :secrets:awsAccessKeyId }}`
`awsSecretAccessKey`	弦	オプション。 AWSシークレットアクセスキー。シークレットとして渡します。	`${{ :secrets:awsSecretAccessKey }}`
`awsSessionToken`	弦	オプション。 STS認証用の一時的なセッショントークンです。シークレットとして渡してください。	`${{ :secrets:awsSessionToken }}`
`region`	弦	必須。ターゲットロググループのAWSリージョン。	`us-east-2`
`logStreamName`	弦	必須。イベントを取得するログストリームの名前です。	`2023/10/27/[$LATEST]abcdef123456`
`logGroupName`	弦	オプション。ログストリームを含むロググループの名前です。	`/aws/lambda/my-function`
`logGroupIdentifier`	弦	オプション。ロググループのARNまたは名前。ロググループをARNで参照する場合は、 `logGroupName` の代わりに使用します。	`arn:partition:service:region:account-id:resource`
`startTime`	Int	オプション。ミリ秒単位のUnixタイムスタンプとして表される、時間範囲の開始。	`1759296000000`
`endTime`	Int	オプション。ミリ秒単位のUnixタイムスタンプとして表される、時間範囲の終了です。	`1759296000000`
`limit`	Int	オプション。返すログイベントの最大数。	`50`
`startFromHead`	ブール値	オプション。 `true` の場合、最も古いログイベントを最初に返します。デフォルトは `false` です。	`true`
`unmask`	ブール値	オプション。 `true` の場合、マスクされていないログイベントデータを返します。デフォルトは `false` です。	`false`
`nextToken`	弦	オプション。次のページの結果を取得するための、前回のレスポンスのページネーショントークンです。	`f/39218833627378687642013305455131706539523449361490509828/s`

次の表は、このアクションの出力フィールドについて説明しています。

出力	タイプ	例
`response`	オブジェクト	`{"events": [{"timestamp": 123, "message": "string", "ingestionTime": 123}], "nextForwardToken": "string", "nextBackwardToken": "string"}`
`success`	ブール値	`true` または `false`
`errorMessage`	弦	`"An error occurred (ExpiredTokenException) when calling the GetLogEvents operation: The security token included in the request is expired"`

出力

タイプ

例

response

オブジェクト

{"events": [{"timestamp": 123, "message": "string", "ingestionTime": 123}], "nextForwardToken": "string", "nextBackwardToken": "string"}

success

ブール値

true

または

false

errorMessage

弦

"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.getLogEvents
    version: '1'
    inputs:
      region: ${{ .workflowInputs.region }}
      logGroupName: ${{ .workflowInputs.logGroupName }}
      logStreamName: ${{ .workflowInputs.logStreamName }}
      limit: 100
    next: end

ログイベントをアップロードする

アクション識別子はaws.cloudwatch.putLogEventsです。

AWS CloudWatch Logs の指定されたログストリームにログイベントのバッチをアップロードします。