オートメーションアクションのリファレンス

App Studio で使用されるオートメーションアクションのリファレンスドキュメントを次に示します。

一般的にアクションと呼ばれるオートメーションアクションは、オートメーションを構成するロジックの個々のステップです。各アクションは、E メールの送信、データレコードの作成、Lambda 関数の呼び出し、APIs呼び出しなど、特定のタスクを実行します。アクションはアクションライブラリのオートメーションに追加され、条件ステートメントまたはループにグループ化できます。

オートメーションとそのアクションの作成と設定については、「」のトピックを参照してください自動化とアクション: アプリのビジネスロジックを定義する。

API を呼び出す

HTTP REST API リクエストを呼び出します。ビルダーはこのアクションを使用して、APIs を使用して App Studio から他のシステムまたはサービスにリクエストを送信できます。例えば、サードパーティーのシステムや自社開発のアプリケーションに接続してビジネスクリティカルなデータにアクセスしたり、専用の App Studio アクションでは呼び出せない API エンドポイントを呼び出すことができます。

REST APIsRESTful API とは」を参照してください。

プロパティ

コネクタ

このアクションによって行われた API リクエストに使用するコネクタ。コネクタドロップダウンには、 API Connectorおよびタイプのコネクタのみが含まれますOpenAPI Connector。コネクタの設定方法に応じて、認証情報やデフォルトのヘッダー、クエリパラメータなどの重要な情報を含めることができます。

API Connector との使用の比較など、API コネクタの詳細についてはOpenAPI Connector、「」を参照してくださいサードパーティーのサービスに接続する。

API リクエスト設定プロパティ

プロパティパネルから API リクエストの設定を選択し、リクエスト設定ダイアログボックスを開きます。API コネクタが選択されている場合、ダイアログボックスにはコネクタ情報が含まれます。

メソッド: API コールのメソッド。可能な値は以下のとおりです。

DELETE: 指定されたリソースを削除します。
GET: 情報またはデータを取得します。
HEAD: 本文のないレスポンスのヘッダーのみを取得します。
POST: 処理するデータを送信します。
PUSH: 処理するデータを送信します。
PATCH: 指定されたリソースを部分的に更新します。

パス: リソースへの相対パス。

ヘッダー: API リクエストで送信されるキーと値のペアの形式のヘッダー。コネクタが選択されている場合、その設定済みヘッダーは自動的に追加され、削除することはできません。設定されたヘッダーは編集できませんが、同じ名前の別のヘッダーを追加して上書きできます。

クエリパラメータ: API リクエストで送信されるキーと値のペアの形式のクエリパラメータ。コネクタが選択されている場合、設定されたクエリパラメータは自動的に追加され、編集または削除することはできません。

本文: API リクエストとともに JSON 形式で送信される情報。GET リクエストの本文はありません。

モック出力

アクションは、プレビュー環境の外部サービスまたはリソースとやり取りしません。モック出力フィールドは、テスト目的でプレビュー環境のコネクタの動作をシミュレートする JSON 式を提供するために使用されます。このスニペットは、ライブ環境で公開されたアプリのコネクタレスポンスと同様に、アクションのresultsマップに保存されます。

このフィールドを使用すると、コネクタを介して外部サービスと通信することなく、さまざまな結果値、エラーシナリオ、エッジケース、不満のあるパスのシミュレートなど、オートメーション内の他のアクションに対するさまざまなシナリオとその影響をテストできます。

呼び出し AWS

AWS サービスからオペレーションを呼び出します。これはサービス AWS またはオペレーションを呼び出すための一般的なアクションであり、目的の AWS サービスまたはオペレーション専用のアクションがない場合に使用する必要があります。

プロパティ

サービス

実行するオペレーションを含む AWS サービス。

運用

実行するオペレーション。

コネクタ

このアクションによって実行されるオペレーションに使用されるコネクタ。設定済みコネクタは、オペレーションを実行するための適切な認証情報と、オペレーションで参照されるリソースを含む AWS リージョンなどのその他の設定情報を使用して設定する必要があります。

設定

指定されたオペレーションを実行するときの JSON 入力。 AWS オペレーションの入力の設定の詳細については、「」を参照してくださいAWS SDK for JavaScript。

Lambda を呼び出す

既存の Lambda 関数を呼び出します。

プロパティ

コネクタ

このアクションによって実行される Lambda 関数に使用されるコネクタ。設定済みコネクタは、Lambda 関数にアクセスするための適切な認証情報と、Lambda 関数を含む AWS リージョンなどのその他の設定情報を使用して設定する必要があります。Lambda のコネクタの設定の詳細については、「」を参照してくださいステップ 3: Lambda コネクタを作成する。

関数名

実行する Lambda 関数の名前。これは関数名であり、関数 ARN (Amazon リソースネーム) ではないことに注意してください。

関数イベント

イベントペイロードとして Lambda 関数に渡されるキーと値のペア。

モック出力

ループ

ネストされたアクションを繰り返し実行して、項目のリストを一度に 1 つずつ繰り返します。たとえば、レコードの作成アクションをループアクションに追加して、複数のレコードを作成します。

ループアクションは、他のループまたは条件アクション内にネストできます。ループアクションは、並列ではなく順番に実行されます。ループ内の各アクションの結果は、同じループ反復内の後続のアクションにのみアクセスできます。ループの外部またはループの異なる反復でアクセスすることはできません。

プロパティ

ソース

反復処理する項目のリスト。一度に 1 つの項目。ソースは、前のアクションの結果、または JavaScript 式を使用して指定できる文字列、数値、またはオブジェクトの静的リストの結果です。

例

次のリストには、ソース入力の例が含まれています。

前のアクションの結果: {{results.actionName.data}}
数値のリスト: {{[1, 2, 3, 4, 5, 6, 7, 8, 9, 10]}}
文字列のリスト: {{["apple", "banana", "orange", "grape", "kiwi"]}}
計算された値: {{params.actionName.split("\n")}}

現在の項目名

反復する現在の項目を参照するために使用できる変数の名前。現在の項目名は、2 つ以上のループをネストし、各ループから変数にアクセスできるように設定できます。たとえば、2 つのループを持つ国と都市をループする場合は、とを設定currentCountryして参照できますcurrentCity。

Condition

オートメーションの実行時に評価される 1 つ以上の指定された論理条件の結果に基づいてアクションを実行します。条件アクションは、次のコンポーネントで構成されます。

またはと評価される JavaScript true 式を提供するために使用される条件フィールドfalse。
条件がに評価された場合に実行されるアクションを含む true ブランチtrue。
条件がに評価された場合に実行されるアクションを含む false ブランチfalse。

条件アクションにドラッグして、アクションを true ブランチと false ブランチに追加します。

プロパティ

Condition

アクションの実行時に評価される JavaScript 式。

レコードの作成

既存の App Studio エンティティに 1 つのレコードを作成します。

プロパティ

エンティティ

レコードを作成するエンティティ。エンティティを選択したら、レコードを作成するエンティティのフィールドに値を追加する必要があります。フィールドのタイプ、およびフィールドが必須かオプションかは、エンティティで定義されます。

レコードの更新

App Studio エンティティの既存のレコードを更新します。

プロパティ

エンティティ

更新するレコードを含むエンティティ。

条件

アクションによって更新されるレコードを定義する基準。条件をグループ化して、1 つの論理ステートメントを作成できます。グループまたは条件を ANDまたは ORステートメントと組み合わせることができます。

フィールド

条件によって指定されたレコードで更新されるフィールド。

値

指定されたフィールドで更新する値。

レコードを削除する

App Studio エンティティからレコードを削除します。

プロパティ

エンティティ

削除するレコードを含むエンティティ。

条件

アクションによって削除するレコードを定義する基準。条件をグループ化して、1 つのロジックステートメントを作成できます。グループまたは条件を ANDまたは ORステートメントと組み合わせることができます。

データアクションを呼び出す

オプションのパラメータを使用してデータアクションを実行します。

プロパティ

データアクション

アクションによって実行されるデータアクション。

パラメータ

データアクションで使用されるデータアクションパラメータ。データアクションパラメータは、データアクションの入力として使用される値を送信するために使用されます。データアクションパラメータは、オートメーションアクションを設定するときに追加できますが、データタブで編集する必要があります。

詳細設定

Invoke data action アクションには、次の詳細設定が含まれます。

ページサイズ: 各クエリで取得するレコードの最大数。デフォルト値は 500 で、最大値は 3000 です。
ページ分割トークン: クエリから追加のレコードを取得するために使用されるトークン。たとえば、 Page sizeが 500 に設定されている場合、500 を超えるレコードがある場合、ページ分割トークンを後続のクエリに渡すと、次の 500 が取得されます。これ以上レコードやページが存在しない場合、トークンは未定義になります。

Amazon S3: オブジェクトを配置する

Amazon S3 PutObject オペレーションを使用して、キー (ファイルパス) によって識別されるオブジェクトを指定された Amazon S3 バケットに追加します。

プロパティ

コネクタ

設定

PutObject コマンドで使用する必須オプション。オプションは以下のとおりです:

注記

Amazon S3 PutObject オペレーションの詳細については、Amazon Simple Storage Service API リファレンスのPutObject」を参照してください。

バケット: オブジェクトを配置する Amazon S3 バケットの名前。
キー: Amazon S3 バケットに入れるオブジェクトの一意の名前。
本文: Amazon S3 バケットに入れるオブジェクトの内容。

モック出力

Amazon S3: オブジェクトを削除する

Amazon S3 DeleteObject オペレーションを使用して、指定された Amazon S3 バケットからキー (ファイルパス) によって識別されるオブジェクトを削除します。

プロパティ

コネクタ

設定

DeleteObject コマンドで使用する必須オプション。オプションは以下のとおりです:

注記

Amazon S3 DeleteObject オペレーションの詳細については、Amazon Simple Storage Service API リファレンスのDeleteObject」を参照してください。

バケット: オブジェクトを削除する Amazon S3 バケットの名前。
キー: Amazon S3 バケットから削除するオブジェクトの一意の名前。

モック出力

Amazon S3: オブジェクトの取得

Amazon S3 GetObject オペレーションを使用して、指定された Amazon S3 バケットからキー (ファイルパス) によって識別されるオブジェクトを取得します。

プロパティ

コネクタ

設定

GetObject コマンドで使用する必須オプション。オプションは以下のとおりです:

注記

Amazon S3 GetObject オペレーションの詳細については、Amazon Simple Storage Service API リファレンスのGetObject」を参照してください。

バケット: オブジェクトを取得する Amazon S3 バケットの名前。
キー: Amazon S3 バケットから取得するオブジェクトの一意の名前。

モック出力

Amazon S3: オブジェクトを一覧表示する

Amazon S3 ListObjects オペレーションを使用して、指定された Amazon S3 バケット内のオブジェクトを一覧表示します。

プロパティ

コネクタ

設定

ListObjects コマンドで使用する必須オプション。オプションは以下のとおりです:

注記

Amazon S3 ListObjects オペレーションの詳細については、Amazon Simple Storage Service API リファレンスのListObjects」を参照してください。

バケット: オブジェクトを一覧表示する Amazon S3 バケットの名前。

モック出力

Amazon Textract: ドキュメントを分析する

Amazon Textract AnalyzeDocument オペレーションを使用して、検出された項目間の関係について入力ドキュメントを分析します。

プロパティ

コネクタ

設定

AnalyzeDocument コマンドで使用するリクエストの内容。オプションは以下のとおりです:

注記

Amazon Textract AnalyzeDocument オペレーションの詳細については、「Amazon Textract デベロッパーガイド」のAnalyzeDocument」を参照してください。

ドキュメント/S3Object/バケット: Amazon S3 バケットの名前。S3 アップロードコンポーネントを使用してアクションにファイルが渡された場合、このパラメータは空のままにすることができます。
Document / S3Object / Name: 入力ドキュメントのファイル名。S3 アップロードコンポーネントを使用してアクションにファイルが渡された場合、このパラメータは空のままにすることができます。
ドキュメント/S3Object/バージョン: Amazon S3 バケットでバージョニングが有効になっている場合は、オブジェクトのバージョンを指定できます。S3 アップロードコンポーネントを使用してアクションにファイルが渡された場合、このパラメータは空のままにすることができます。
FeatureTypes: 実行する分析のタイプのリスト。有効な値は、TABLES、FORMS、QUERIES、SIGNATURES、LAYOUT です。

モック出力

Amazon Textract: 経費を分析する

Amazon Textract AnalyzeExpense オペレーションを使用して、テキスト間の財務関係について入力ドキュメントを分析します。

プロパティ

コネクタ

設定

AnalyzeExpense コマンドで使用するリクエストの内容。オプションは以下のとおりです:

注記

Amazon Textract AnalyzeExpense オペレーションの詳細については、「Amazon Textract デベロッパーガイド」のAnalyzeExpense」を参照してください。

ドキュメント/S3Object/バケット: Amazon S3 バケットの名前。S3 アップロードコンポーネントを使用してアクションにファイルが渡された場合、このパラメータは空のままにすることができます。
Document / S3Object / Name: 入力ドキュメントのファイル名。S3 アップロードコンポーネントを使用してアクションにファイルが渡された場合、このパラメータは空のままにすることができます。
ドキュメント/S3Object/バージョン: Amazon S3 バケットでバージョニングが有効になっている場合は、オブジェクトのバージョンを指定できます。S3 アップロードコンポーネントを使用してアクションにファイルが渡された場合、このパラメータは空のままにすることができます。

モック出力

Amazon Textract: ID を分析する

Amazon Textract AnalyzeID オペレーションを使用して、ID ドキュメントの関連情報を分析します。

プロパティ

コネクタ

設定

AnalyzeID コマンドで使用するリクエストの内容。オプションは以下のとおりです:

注記

Amazon Textract AnalyzeID オペレーションの詳細については、「Amazon Textract デベロッパーガイド」のAnalyzeID」を参照してください。

ドキュメント/S3Object/バケット: Amazon S3 バケットの名前。S3 アップロードコンポーネントを使用してアクションにファイルが渡された場合、このパラメータは空のままにすることができます。
Document / S3Object / Name: 入力ドキュメントのファイル名。S3 アップロードコンポーネントを使用してアクションにファイルが渡された場合、このパラメータは空のままにすることができます。
ドキュメント/S3Object/バージョン: Amazon S3 バケットでバージョニングが有効になっている場合は、オブジェクトのバージョンを指定できます。S3 アップロードコンポーネントを使用してアクションにファイルが渡された場合、このパラメータは空のままにすることができます。

モック出力

Amazon Textract: ドキュメントテキストを検出する

Amazon Textract DetectDocumentText オペレーションを使用して、入力ドキュメント内のテキスト行とテキスト行を構成する単語を検出します。

プロパティ

コネクタ

設定

DetectDocumentText コマンドで使用するリクエストの内容。オプションは以下のとおりです:

注記

Amazon Textract DetectDocumentText オペレーションの詳細については、Amazon Textract DetectDocumentText」を参照してください。

ドキュメント/S3Object/バケット: Amazon S3 バケットの名前。S3 アップロードコンポーネントを使用してアクションにファイルが渡された場合、このパラメータは空のままにすることができます。
Document / S3Object / Name: 入力ドキュメントのファイル名。S3 アップロードコンポーネントを使用してアクションにファイルが渡された場合、このパラメータは空のままにすることができます。
ドキュメント/S3Object/バージョン: Amazon S3 バケットでバージョニングが有効になっている場合は、オブジェクトのバージョンを指定できます。S3 アップロードコンポーネントを使用してアクションにファイルが渡された場合、このパラメータは空のままにすることができます。

モック出力

Amazon Bedrock: GenAI プロンプト

Amazon Bedrock InvokeModel オペレーションを使用して、アクションプロパティで指定されたプロンプトパラメータと推論パラメータを使用して推論を実行します。アクションは、テキスト、イメージ、埋め込みを生成できます。

プロパティ

コネクタ

このアクションによって実行されるオペレーションに使用されるコネクタ。このアクションを正常に使用するには、Amazon Bedrock ランタイムをサービスとしてコネクタを設定する必要があります。設定済みコネクタは、オペレーションを実行するための適切な認証情報と、オペレーションで参照されるリソースを含む AWS リージョンなどのその他の設定情報を使用して設定する必要があります。

モデル

Amazon Bedrock がリクエストを処理するために使用される基盤モデル。Amazon Bedrock のモデルの詳細については、「Amazon Bedrock ユーザーガイド」の「Amazon Bedrock 基盤モデル情報」を参照してください。

入力タイプ

Amazon Bedrock モデルに送信する入力の入力タイプ。指定できる値は、テキスト、ドキュメント、イメージです。入力タイプを選択できない場合は、設定されたモデルでサポートされていない可能性があります。

ユーザープロンプト

レスポンスを生成するために処理する Amazon Bedrock モデルに送信するプロンプト。静的テキストを入力するか、パラメータを使用したコンポーネントからの入力、オートメーションの以前のアクション、または別のオートメーションなど、アプリケーションの別の部分から入力を渡すことができます。次の例は、コンポーネントまたは以前のアクションから値を渡す方法を示しています。

パラメータを使用してコンポーネントから値を渡すには: {{params.paramName}}
前のアクションから値を渡すには: {{results.actionName}}

システムプロンプト (Claude モデル)

リクエストの処理時に Amazon Bedrock モデルで使用されるシステムプロンプト。システムプロンプトは、Claude モデルにコンテキスト、手順、またはガイドラインを提供するために使用されます。

リクエスト設定

さまざまなリクエスト設定とモデル推論パラメータを設定します。以下の設定を設定できます。

温度: リクエストの処理時に Amazon Bedrock モデルで使用される温度。温度によって、Bedrock モデルの出力のランダム性または創造性が決まります。温度が高いほど、レスポンスはよりクリエイティブで分析性が低くなります。指定できる値はです[0-10]。
最大トークン: Amazon Bedrock モデルの出力の長さを制限します。
TopP: nucleus サンプリングでは、モデルは後続の各トークンのすべてのオプションに対する累積分布を低い確率順で計算し、TopP で指定された特定の確率に達すると切り捨てます。温度または TopP のいずれかを変更する必要がありますが、両方を変更することはできません
Stop Sequences: モデルがリクエストの処理と出力の生成を停止するシーケンス。

詳細については、「Amazon Bedrock ユーザーガイド」の「基盤モデルの推論リクエストパラメータとレスポンスフィールド」を参照してください。

停止シーケンス

Amazon Bedrock ガードレール ID とバージョンを入力します。ガードレールは、ユースケースと責任ある AI ポリシーに基づいて保護を実装するために使用されます。詳細については、「Amazon Bedrock ユーザーガイド」の「Amazon Bedrock ガードレールを使用したモデルの有害なコンテンツの停止」を参照してください。

モック出力

Amazon Bedrock: モデルを呼び出す

Amazon Bedrock InvokeModel オペレーションを使用して、リクエスト本文で指定されたプロンプトパラメータと推論パラメータを使用して推論を実行します。モデル推論を使用して、テキスト、イメージ、埋め込みを生成します。

プロパティ

コネクタ

設定

InvokeModel コマンドで使用するリクエストの内容。

注記

コマンドの例を含む Amazon Bedrock InvokeModelオペレーションの詳細については、「Amazon Bedrock API InvokeModel」を参照してください。

モック出力

JavaScript

カスタム JavaScript 関数を実行して、指定された値を返します。

重要

App Studio は、サードパーティーまたはカスタム JavaScript ライブラリの使用をサポートしていません。

プロパティ

ソースコード

アクションによって実行される JavaScript コードスニペット。

ヒント

AI を使用して、次の手順を実行して JavaScript を生成できます。

展開アイコンを選択して、展開された JavaScript エディタを開きます。
(オプション): コードの変更トグルを有効にして、既存の JavaScript を変更します。それ以外の場合、AI は既存の JavaScript を置き換えます。
JavaScript 「JavaScript の生成」で、JavaScript で何をするかを記述します。例: Add two numbers。
送信アイコンを選択して JavaScript を生成します。

オートメーションを呼び出す

指定されたオートメーションを実行します。

プロパティ

オートメーションを呼び出す

アクションによって実行されるオートメーション。

E メールの送信

Amazon SES SendEmail オペレーションを使用して E メールを送信します。

プロパティ

コネクタ

設定

SendEmail コマンドで使用するリクエストの内容。オプションは以下のとおりです:

注記

Amazon SES SendEmail オペレーションの詳細については、Amazon Simple Email Service API リファレンスの「SendEmail」を参照してください。

モック出力

ブラウザで JavaScript が無効になっているか、使用できません。

AWS ドキュメントを使用するには、JavaScript を有効にする必要があります。手順については、使用するブラウザのヘルプページを参照してください。

ドキュメントの表記規則

自動化アクションの追加、編集、削除

エンティティとデータアクション: アプリのデータモデルを設定する