このページでは、ワークフロー自動化アクションカタログで利用可能なAWS Lambdaアクションのリファレンスを提供します。これらのアクションを使用して、ワークフロー定義の一部としてLambda関数を管理および呼び出します。
前提条件
前提条件と認証情報のセットアップについては、AWS認証情報のセットアップをご覧ください。
Lambda関数を呼び出す
アクション識別子はaws.lambda.invokeです。
Lambda関数を同期的またはオプションのペイロードを使用して非同期的に呼び出します。
次の表に、このアクションの入力フィールドについて説明します。
入力 | タイプ | 説明 | 例 |
|---|---|---|---|
| 弦 | オプション。 AWS APIコール用に引き受けるIAMロールARN。 |
|
| 弦 | オプション。 AWSアクセスキーID。シークレットとして渡します。 |
|
| 弦 | オプション。 AWSシークレットアクセスキー。シークレットとして渡します。 |
|
| 弦 | オプション。 STS認証用の一時的なセッショントークンです。シークレットとして渡してください。 |
|
| 弦 | 必須。 関数が配置されているAWSリージョン。 |
|
| 弦 | 必須。 呼び出すLambda関数の名前。 |
|
| 地図 | オプション。 関数に渡す入力ペイロードです。 |
|
| リスト | オプション。 アクションの出力から特定のフィールドを抽出するためのJQセレクター。 |
|
次の表は、このアクションの出力フィールドについて説明しています。
出力 | タイプ | 例 |
|---|---|---|
| 地図 |
|
| Int |
|
| 弦 |
|
| 弦 |
|
| ブール値 |
または
|
| 弦 | 失敗時のエラーメッセージ。 |
Lambda関数の設定を更新する
アクション識別子はaws.lambda.updateFunctionConfigurationです。
Lambda関数の設定を変更します。変更するパラメーターのみを指定してください。
次の表に、このアクションの入力フィールドについて説明します。
入力 | タイプ | 説明 | 例 |
|---|---|---|---|
| 弦 | オプション。 AWS APIコール用に引き受けるIAMロールARN。 |
|
| 弦 | オプション。 AWSアクセスキーID。シークレットとして渡します。 |
|
| 弦 | オプション。 AWSシークレットアクセスキー。シークレットとして渡します。 |
|
| 弦 | オプション。 STS認証用の一時的なセッショントークンです。シークレットとして渡してください。 |
|
| 弦 | 必須。 関数が配置されているAWSリージョン。 |
|
| 弦 | 必須。 更新するLambda関数の名前。 |
|
| 弦 | オプション。 関数に割り当てるIAMロールのARN。 |
|
| 弦 | オプション。 関数の更新されたハンドラー。 |
|
| 弦 | オプション。 関数の更新された説明。 |
|
| 地図 | オプション。 他ではモデル化されていない追加のboto3フィールド。APIからの任意のオプション引数を受け付けます。 |
|
| リスト | オプション。 アクションの出力から特定のフィールドを抽出するためのJQセレクター。 |
|
次の表は、このアクションの出力フィールドについて説明しています。
出力 | タイプ | 例 |
|---|---|---|
| オブジェクト |
|
| ブール値 |
または
|
| 弦 |
|
Lambda関数の説明
アクション識別子はaws.lambda.getFunctionです。
特定のLambda関数の設定の詳細、コードの場所、およびその他のメタデータを取得します。
次の表に、このアクションの入力フィールドについて説明します。
入力 | タイプ | 説明 | 例 |
|---|---|---|---|
| 弦 | オプション。 AWS APIコール用に引き受けるIAMロールARN。 |
|
| 弦 | オプション。 AWSアクセスキーID。シークレットとして渡します。 |
|
| 弦 | オプション。 AWSシークレットアクセスキー。シークレットとして渡します。 |
|
| 弦 | オプション。 STS認証用の一時的なセッショントークンです。シークレットとして渡してください。 |
|
| 弦 | 必須。 関数が配置されているAWSリージョン。 |
|
| 弦 | 必須。 Lambda関数の名前。 |
|
| 地図 | オプション。 他ではモデル化されていない追加のboto3フィールド。APIからの任意のオプション引数を受け付けます。 |
|
| リスト | オプション。 アクションの出力から特定のフィールドを抽出するためのJQセレクター。 |
|
次の表は、このアクションの出力フィールドについて説明しています。
出力 | タイプ | 例 |
|---|---|---|
| オブジェクト | 完全なAPIレスポンス。 を参照してください。 |
| ブール値 |
または
|
| 弦 |
|
Lambda関数のエイリアスを一覧表示する
アクション識別子はaws.lambda.listAliasesです。
Lambda関数のエイリアスのリストを返します。エイリアスは、関数のバージョンへの名前付きポインターです。大きな結果セットをページ分割するには、markerとmaxItemsを使用します。
次の表に、このアクションの入力フィールドについて説明します。
入力 | タイプ | 説明 | 例 |
|---|---|---|---|
| 弦 | オプション。 AWS APIコール用に引き受けるIAMロールARN。 |
|
| 弦 | オプション。 AWSアクセスキーID。シークレットとして渡します。 |
|
| 弦 | オプション。 AWSシークレットアクセスキー。シークレットとして渡します。 |
|
| 弦 | オプション。 STS認証用の一時的なセッショントークンです。シークレットとして渡してください。 |
|
| 弦 | 必須。 関数が配置されているAWSリージョン。 |
|
| 弦 | 必須。 Lambda関数の名前。 |
|
| 弦 | オプション。 ページ付けトークン。次のページを取得するには、前のレスポンスから
の値を渡します。 |
|
| Int | オプション。 返すエイリアスの最大数。 |
|
| 地図 | オプション。 他ではモデル化されていない追加のboto3フィールド。APIからの任意のオプション引数を受け付けます。 |
|
| リスト | オプション。 アクションの出力から特定のフィールドを抽出するためのJQセレクター。 |
|
次の表は、このアクションの出力フィールドについて説明しています。
出力 | タイプ | 例 |
|---|---|---|
| オブジェクト | 完全なAPIレスポンス。 をご覧ください。 |
| ブール値 |
または
|
| 弦 |
|
Lambda関数の一覧
アクション識別子はaws.lambda.listFunctionsです。
リージョン内のLambda関数のリストと、それぞれのバージョン固有の設定を返します。AWSは1回の呼び出しにつき最大50個の関数を返します — 大規模な結果セットをページ分割するには、markerとmaxItemsを使用してください。
このアクションは、FunctionConfigurationフィールドのサブセットを返します。State、StateReasonCode、LastUpdateStatus、およびRuntimeVersionConfigを含む完全なセットを取得するには、代わりにaws.lambda.getFunctionを使用してください。
次の表に、このアクションの入力フィールドについて説明します。
入力 | タイプ | 説明 | 例 |
|---|---|---|---|
| 弦 | オプション。 AWS APIコール用に引き受けるIAMロールARN。 |
|
| 弦 | オプション。 AWSアクセスキーID。シークレットとして渡します。 |
|
| 弦 | オプション。 AWSシークレットアクセスキー。シークレットとして渡します。 |
|
| 弦 | オプション。 STS認証用の一時的なセッショントークンです。シークレットとして渡してください。 |
|
| 弦 | 必須。 関数を一覧表示するAWSリージョン。 |
|
| 弦 | オプション。 未公開バージョンに加えて、各関数の公開されているすべてのバージョンを含めるには、
に設定します。 |
|
| 弦 | オプション。 ページ付けトークン。次のページを取得するには、前のレスポンスから
の値を渡します。 |
|
| Int | オプション。 1回の呼び出しで返す関数の最大数。より高い値に関係なく、AWSはこれを50に制限します。 |
|
| 地図 | オプション。 他ではモデル化されていない追加のboto3フィールド。
はLambda@Edge関数にのみ関連しており、設定する場合は
が必要です。 |
|
| リスト | オプション。 アクションの出力から特定のフィールドを抽出するためのJQセレクター。 |
|
次の表は、このアクションの出力フィールドについて説明しています。
出力 | タイプ | 例 |
|---|---|---|
| オブジェクト |
|
| ブール値 |
または
|
| 弦 |
|
Lambdaの永続的な実行履歴を取得
アクション識別子はaws.lambda.getDurableExecutionHistoryです。
Lambda durable executionの実行履歴を取得し、発生したすべてのステップ、コールバック、およびイベントを表示します。このアクションはLambda durable executionにのみ適用されます — 通常のLambda関数の呼び出し履歴を取得することはできません。履歴は、実行中、および完了後の設定可能な保持期間(1~90日、デフォルトは30日)にわたって利用できます。
多くのステップやコールバックを伴う長時間の実行において、完全なペイロードではなくイベントタイプとタイムスタンプのみが必要な場合は、includeExecutionDataをfalseに設定してください — これにより、よりコンパクトなレスポンスが生成されます。
次の表に、このアクションの入力フィールドについて説明します。
入力 | タイプ | 説明 | 例 |
|---|---|---|---|
| 弦 | オプション。 AWS APIコール用に引き受けるIAMロールARN。 |
|
| 弦 | オプション。 AWSアクセスキーID。シークレットとして渡します。 |
|
| 弦 | オプション。 AWSシークレットアクセスキー。シークレットとして渡します。 |
|
| 弦 | オプション。 STS認証用の一時的なセッショントークンです。シークレットとして渡してください。 |
|
| 弦 | 必須。 永続的実行が配置されているAWSリージョンです。 |
|
| 弦 | 必須。 履歴を取得する永続的な実行のARNです。 |
|
| ブール値 | オプション。 履歴イベントにステップ結果とコールバックペイロードを含めます。よりコンパクトなレスポンスにするには、
に設定します。デフォルトは
です。 |
|
| Int | オプション。 1回の呼び出しにつき返す履歴イベントの最大数です。デフォルトは100、最大は1,000です。デフォルトを使用するには、
に設定してください。 |
|
| 弦 | オプション。 ページ付けトークン。以前のレスポンスから
の値を渡してください。トークンは24時間後に期限切れになります。 |
|
| ブール値 | オプション。 イベントを新しい順(逆時系列)で返します。デフォルト設定:
(古い順)。 |
|
| 地図 | オプション。 他ではモデル化されていない追加のboto3フィールド。 | |
| リスト | オプション。 アクションの出力から特定のフィールドを抽出するためのJQセレクター。 |
|
次の表は、このアクションの出力フィールドについて説明しています。
出力 | タイプ | 例 |
|---|---|---|
| オブジェクト |
|
| ブール値 |
または
|
| 弦 |
|
Lambda関数の同時実行数を設定する
アクション識別子はaws.lambda.putFunctionConcurrencyです。
Lambda関数の予約済み同時実行数(同時実行の最大数)を設定します。同時実行数を予約することで、関数がその数の同時実行に対応できる容量を確保すると同時に、そのレベルを超えてスケーリングすることを防ぎます。同時実行数の設定は、公開されているすべてのバージョンと未公開のバージョンに適用されます。reservedConcurrentExecutionsを0に設定すると、関数を削除せずに無効化します。
次の表に、このアクションの入力フィールドについて説明します。
入力 | タイプ | 説明 | 例 |
|---|---|---|---|
| 弦 | オプション。 AWS APIコール用に引き受けるIAMロールARN。 |
|
| 弦 | オプション。 AWSアクセスキーID。シークレットとして渡します。 |
|
| 弦 | オプション。 AWSシークレットアクセスキー。シークレットとして渡します。 |
|
| 弦 | オプション。 STS認証用の一時的なセッショントークンです。シークレットとして渡してください。 |
|
| 弦 | 必須。 関数が配置されているAWSリージョン。 |
|
| 弦 | 必須。 関数の名前、
、またはARN。64文字の長さ制限は、名前のみを指定する場合(完全なARNではない場合)にのみ適用されます。 |
|
| Int | 必須。 予約する同時実行数です。最小値は
です(機能を無効にします)。実質的な最大値は、アカウントの予約されていない同時実行プールです。関数ごとの制限がない関数のために、少なくとも100の予約されていない実行を残しておく必要があります。 |
|
| 地図 | オプション。 他ではモデル化されていない追加のboto3フィールド。 | |
| リスト | オプション。 アクションの出力から特定のフィールドを抽出するためのJQセレクター。 |
|
次の表は、このアクションの出力フィールドについて説明しています。
出力 | タイプ | 例 |
|---|---|---|
| オブジェクト |
|
| ブール値 |
または
|
| 弦 |
|