

翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

# アクションコネクタ
<a name="action-integrations"></a>

アクションコネクタは、外部サービスへの安全な接続を使用し、認証レベルとアクセス許可に基づいてアクションを実行します。

# アクションコネクタの仕組み
<a name="int-actions-how-it-works"></a>

Amazon Quick のアクションコネクタは、Amazon Quick と外部サービス間の安全な接続を作成します。これらの統合を設定すると、認証レベルとアクセス許可に基づいてアクションを実行できます。

## コアコンポーネント
<a name="qbs-actions-how-it-works-qbs-actions-core-components"></a>

**アクションコネクタ**  
外部サービスと統合する基本リソース。Amazon Quick は、15 のサードパーティー統合と 5 AWS のサービス統合をサポートしています。組み込みサービスアクションコネクタの設定については、 AWS 「」を参照してください[AWS サービスアクションコネクタ](builtin-services-integration.md)。

**認証方法**  
アクションコネクタは、マネージド (3LO)、カスタムユーザーベース、API キー、2LO など、複数の認証方法をサポートします。各認証方法の詳細については、「」を参照してください[認証方法](action-connector-apis.md#action-connector-apis-authentication)。

**実装タイプ**  
+ **ユーザーによってトリガーされた即時オペレーションのオンデマンドアクション** - トリガーされた直後に実行されるリアルタイムオペレーション。チャットインターフェイス、ダッシュボード、または Amazon Q Apps を使用してアクションを開始できます。例としては、チケットの作成、メッセージの送信、データのクエリなどがあります。
+ **スケジュールされたタスクまたはシステムトリガーされたタスクの自動ワークフロー** - スケジュールまたはトリガーに基づいて実行されるシステムマネージドオペレーション。これらは、ユーザーの介入なしでバックグラウンドで実行されます。例としては、データの同期、レポート生成、システムメンテナンスなどがあります。

**アクセス許可モデル**  
+ **3LO を介した個人用アクセス許可** - 3 レッグ OAuth を介して Amazon Quick に特定のアクセス許可を付与し、サービスアクセスの制御を維持できます。アクセス許可は、ターゲットサービスのアイデンティティと認証情報に関連付けられます。
+ **自動ワークフローのサービスレベルのアクセス許可** - 自動ワークフローに適用され、これらのアクセス許可は、ユーザーが関与することなくsystem-to-systemやり取りをサポートします。これらはサービスレベルで設定され、通常は API キーまたはサービスアカウントの認証情報を使用します。
+ **エンティティレベルのアクセスコントロール** - Amazon Quick 内のアクションへのアクセスを管理し、特定のアクションを実行できるユーザーまたはグループを決定します。これらのコントロールは、Amazon Quick のより広範なアクセス許可システムと統合され、プラットフォーム全体で一貫したアクセス管理を行います。

# アクションのタイプ
<a name="int-actions-types"></a>

Amazon Quick は、アクションを呼び出す 2 つの方法をサポートし、それぞれが異なるユースケースと認証モデルを提供します。

## オンデマンドアクション
<a name="qbs-actions-types-qbs-actions-on-demand"></a>

オンデマンドアクションは、トリガーするとすぐに実行されます。これらのアクションは、リアルタイムのレスポンスを必要とするインタラクティブなオペレーションをサポートします。

**主な特性:**
+ ユーザー主導の実行 - チャットインターフェイスで自然言語を使用してアクションをトリガーします。
+ インタラクティブフォーム補完 - アクションを実行する前に、必須パラメータを含むフォームに入力します。
+ 即時対応 - アクションはリアルタイムで実行され、成功または失敗に関するフィードバックを即座に提供します。
+ 個人認証 (3LO) - ターゲットサービスからの個々の認証情報とアクセス許可を使用します。

**一般的なユースケース:**
+ Jira でのチケットの作成。
+ Slack でのメッセージの送信。
+ Salesforce レコードの更新。
+ SharePoint から情報を取得します。

## 自動化ワークフロー
<a name="qbs-actions-types-qbs-actions-automated-workflows"></a>

自動ワークフローは、スケジュールに従って、または特定のトリガーに応じてアクションを実行します。これらは、バックグラウンドおよびシステムレベルのオペレーションに役立ちます。

**主な特性:**
+ システムレベルの実行 - アクションは、事前定義されたトリガーに基づいてユーザーの介入なしで自動的に実行されます。
+ スケジュール済みまたはイベントトリガー済み - 時間ベースのスケジュールで、または特定のシステムイベントに応じて実行します。
+ 非インタラクティブオペレーション - ユーザー入力やフォーム入力を必要とせずにバックグラウンドで実行します。
+ サービスレベルの認証 - 個々のユーザー認証ではなく、システム認証情報を使用します。

**一般的なユースケース:**
+ 定期的なデータ同期。
+ スケジュールされたレポート生成。
+ チケットの自動更新。
+ システムヘルスチェック。

# 境界付きエージェントと境界なしエージェント
<a name="int-actions-bounded-unbounded"></a>

Amazon Quick には、さまざまなレベルのアクセスと機能を提供する 2 種類のエージェントが用意されています。境界付きエージェントと無制限エージェントです。これらのエージェントタイプの違いを理解することで、ユースケースに適したソリューションを実装できます。

## 境界エージェント
<a name="qbs-actions-bounded-unbounded-qbs-actions-bounded-agents"></a>

境界エージェントは、Amazon Quick 内の 1 つ以上のスペースに特にリンクされた、定義されたパラメータ内で動作します。これらのエージェントは、割り当てられたスペースに明示的に接続されているリソースにのみアクセスしてアクションを実行できます。たとえば、HR スペース用に設定された境界付きエージェントは、HR 関連のドキュメント、データセットにのみアクセスでき、HR 関連のアクションを実行できます。

境界付きエージェントを以下に使用します。
+ 部門固有のワークフロー (人事、財務、IT)。
+ プロジェクトチームのコラボレーション。
+ 機密データの処理。
+ コンプライアンスに重点を置いたオペレーション。

境界付きの性質は、エージェントが指定されたスペース外のリソースにアクセスできないようにすることで、セキュリティを強化します。これにより、データの分離が重要なシナリオに最適です。

## 無制限のエージェント
<a name="qbs-actions-bounded-unbounded-qbs-actions-unbounded-agents"></a>

無制限のエージェントは、より広範なアクセス機能を持ち、Amazon Quick 環境内で設定されたすべてのアクションとリソースを操作できます。これらのエージェントは特定のスペースに制限されず、システムで使用可能な適切に設定されたアクションコネクタにアクセスできます。

無制限のエージェントを以下に使用します。
+ 組織全体の支援。
+ 部門間のワークフロー。
+ 汎用アクション。
+ 複数のシステムへのアクセスを必要とするシナリオ。

# 前提条件
<a name="int-actions-prerequisites"></a>

Amazon Quick でアクションを使用する前に、以下があることを確認してください。

## ライセンス要件
<a name="qbs-actions-prerequisites-qbs-actions-license-requirements"></a>

次のいずれかの Amazon Quick ライセンス:
+ Reader Pro - データへの読み取りアクセスと、接続されたサービスでアクションを実行する機能を提供します。
+ 作成者 - Reader Pro の機能に加えて、コンテンツと設定を作成および変更する機能が含まれています。
+ Author Pro - 高度なアクション設定と管理機能を含むフル機能アクセス。

## サービス要件
<a name="qbs-actions-prerequisites-qbs-actions-service-requirements"></a>

サードパーティーサービス (Jira や Salesforce など) の場合は、以下があることを確認します。
+ ターゲットサービスへの適切なアクセス許可。
+ 各サービスの認証認証情報。

 AWS アクションコネクタの場合は、関連するサービスへの管理者アクセスが必要です。

## AWS アカウントの要件
<a name="qbs-actions-prerequisites-qbs-actions-aws-account-requirements"></a>
+ アクティブな AWS アカウント - 請求が有効で良好な状態にある有効な AWS アカウント。
+ 適切な IAM アクセス許可 - Amazon Quick が必要な AWS サービスにアクセスできるようにする IAM ロールとポリシー。
+ 必要なサービスクォータ - アクションと統合する予定の AWS サービスの十分なサービス制限。

# サポートされているアクションコネクタタイプと使用可能なアクション
<a name="action-connector-apis-supported-types"></a>

Amazon Quick は複数のコネクタタイプをサポートし、それぞれに特定のアクションを使用できます。

## 外部サービスコネクタ
<a name="action-connector-apis-external-services"></a>
+ **Salesforce** - レコードの作成、機会の更新、アカウントの検索、リードの管理を行います。
+ **JIRA** - 問題の作成、チケットの更新、プロジェクトの検索、ワークフローの管理を行います。
+ **Microsoft Outlook** - E メールの送信、カレンダーイベントの管理、連絡先へのアクセス。
+ **Slack** - メッセージの送信、チャネルの作成、通知の管理を行います。
+ **ServiceNow** - インシデントの作成、リクエストの更新、ワークフローの管理。
+ **Zendesk** - チケットの作成、ケースの更新、ナレッジベースの検索。
+ **PagerDuty** - インシデントの作成、エスカレーションの管理、オンコールスケジュールの更新を行います。
+ **Asana** - アクションの作成、プロジェクトの更新、チームワークフローの管理を行います。
+ **BambooHR** - 従業員データにアクセスし、休暇申請を管理します。
+ **ボックス** - ファイル、フォルダを管理し、ドキュメントでコラボレーションします。
+ **Canva** - 設計の作成と編集、テンプレートとアセットの管理を行います。
+ **FactSet** - 財務データにアクセスし、レポートを生成します。
+ **GitHub** - リポジトリ、問題、プルリクエスト、コードコラボレーションを管理します。
+ **HuggingFace** - AI モデル、データセット、機械学習ワークフローにアクセスします。
+ **HubSpot** - 連絡先、取引、マーケティングキャンペーン、CRM データを管理します。
+ **インターコム** - 顧客との会話、サポートチケット、メッセージングを管理します。
+ **線形** - 問題、プロジェクト、開発ワークフローを作成および管理します。
+ **Monday** - プロジェクト、タスク、チームコラボレーションワークフローを管理します。
+ **概念** - ページ、データベース、コラボレーションワークスペースを作成および管理します。
+ **Smartsheet** - シートを更新し、プロジェクトデータを管理します。
+ **Confluence** - ページ、スペース、その他の Confluence オブジェクトを作成、更新、管理します。
+ **SharePoint** - SharePoint コンテンツを作成、更新、削除、取得するための 19 のアクションを使用して、SharePoint リスト、項目、および Excel ファイルに対してアクションを実行します。
+ **OneDrive** - OneDrive ファイルとフォルダを作成、更新、削除、管理します。
+ **SAP** - SAP S/4HANA システムにアクセスして、エンタープライズデータに対して読み取り専用オペレーションを実行します。

## AWS サービスコネクタ
<a name="action-connector-apis-aws-services"></a>
+ **Amazon S3** - ファイルのアップロード、バケットの管理、オブジェクトの取得。
+ **Amazon Bedrock** - コンテンツの生成、データの分析、リクエストの処理を行います。
+ **Amazon Textract** - ドキュメントからテキストとデータを抽出します。
+ **Amazon Comprehend** - 自然言語処理と感情分析。
+ **Amazon Comprehend Medical** - 医療テキスト分析とエンティティ抽出。

## アクションコネクタの互換性マトリックス
<a name="action-connector-compatibility-matrix"></a>

次の表は、各アクションコネクタタイプがサポートする Amazon Quick の機能を示しています。


**Action Connector 機能の互換性**  

| アクションコネクタ | チャットエージェント | フロー | ダッシュボードビジュアル | ダッシュボードアラート | 自動化 | コンパニオン | 
| --- | --- | --- | --- | --- | --- | --- | 
| AWS 組み込みサービス | 
| AWS Bedrock エージェントランタイム | — | — | — | — | ✓ | — | 
| AWS Bedrock データ自動化ランタイム | — | — | — | — | ✓ | — | 
| AWS Bedrock ランタイム | — | — | — | — | ✓ | — | 
| Amazon Comprehend | — | — | — | — | ✓ | — | 
| Amazon Comprehend Medical | — | — | — | — | — | — | 
| Amazon S3 | — | — | — | — | ✓ | — | 
| Amazon Textract | — | — | — | — | ✓ | — | 
| 外部サービスコネクタ | 
| Asana | ✓ | ✓ | — | — | — | ✓ | 
| Atlassian Confluence クラウド | ✓ | ✓ | — | — | ✓ | ✓ | 
| アトラシアン Jira クラウド | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | 
| BambooHR | ✓ | ✓ | — | — | — | ✓ | 
| Box | ✓ | ✓ | — | — | — | — | 
| Canva | ✓ | ✓ | — | — | — | — | 
| FactSet | ✓ | ✓ | — | — | — | — | 
| GitHub | ✓ | ✓ | — | — | — | — | 
| HuggingFace | ✓ | ✓ | — | — | — | — | 
| HubSpot | ✓ | ✓ | — | — | — | — | 
| Intercom | ✓ | ✓ | — | — | — | — | 
| [線形] | ✓ | ✓ | — | — | — | — | 
| Monday | ✓ | ✓ | — | — | — | — | 
| 概念 | ✓ | ✓ | — | — | — | — | 
| Microsoft OneDrive | ✓ | ✓ | — | — | ✓ | ✓ | 
| Microsoft Outlook | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | 
| Microsoft SharePoint | ✓ | ✓ | — | — | ✓ | ✓ | 
| Microsoft Teams | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | 
| PagerDuty | ✓ | ✓ | — | — | ✓ | ✓ | 
| Salesforce | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | 
| SAP | ✓ | — | — | — | ✓ | ✓ | 
| ServiceNow | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | 
| Slack | ✓ | ✓ | ✓ | — | — | ✓ | 
| Smartsheet | ✓ | ✓ | — | — | — | ✓ | 
| Zendesk | ✓ | ✓ | — | — | — | ✓ | 
| カスタムコネクタタイプ | 
| モデルコンテキストプロトコル (MCP) | ✓ | ✓ | — | — | ✓ | — | 
| OpenAPI | ✓ | ✓ | — | — | — | — | 
| REST API | — | — | — | — | ✓ | — | 

**認証サポート:**
+ **チャットエージェントとコンパニオン** - ユーザー認証のサポート (3LO、ベーシック)
+ **ダッシュボードビジュアル** - ユーザー認証 (3LO) をサポート
+ **ダッシュボードアラート** - システム認証のサポート (2LO または API キー)
+ **自動化** - サポートシステム認証 (2LO)

# アクションコネクタ APIs
<a name="action-connector-apis"></a>

アクションコネクタ APIsを使用すると、Amazon Quick と外部サービス間の接続をプログラムで作成および管理できます。これらの APIs、ユーザーが Amazon Quick Chat Interface と自動ワークフローから直接サードパーティーアプリケーションでアクションを実行できるようにするアクション統合機能をサポートしています。

## アクションコネクタ APIs
<a name="action-connector-apis-overview"></a>

アクションコネクタは、ファーストパーティおよびサードパーティーアプリケーションとの統合を可能にする基本的なリソースとして機能します。これらの APIs を使用して、アプリケーションへの認証、アクセス許可の管理、Amazon Quick アプリケーション内のユーザーが使用できるアクションの制御を行うことができます。

### アクションコネクタ APIsアクション統合をサポートする方法
<a name="action-connector-apis-task-integrations"></a>

アクションコネクタ APIs、Amazon Quick アクション統合のバックエンドインフラストラクチャを提供します。API を使用してアクションコネクタを作成する場合、以下を可能にする安全な接続を確立します。
+ チャットインターフェイスを介して外部サービスでアクションを実行します。
+ バックグラウンドプロセスで自動ワークフローを実行します。
+ サードパーティーサービスと Amazon Quick アプリケーションを統合します。
+ サービスアクセスの認証とアクセス許可を管理します。

APIs、Amazon Quick を外部サービスに安全に接続するために必要な複雑な認証フロー、認証情報管理、およびアクセス許可コントロールを処理します。

## 認証方法
<a name="action-connector-apis-authentication"></a>

アクションコネクタ APIs、さまざまなユースケースとセキュリティ要件に対応するために、複数の認証方法をサポートしています。

### マネージド認証 (3LO)
<a name="qbs-action-connector-apis-managed-auth"></a>

Three-Legged OAuth は、サードパーティーのサービスへの個人アクセスのための最も簡単なセットアップを提供します。
+ 初期設定は必要ありません。
+ サービスプロバイダーログインによるユーザー固有の認証。
+ 90 日間のライフサイクルによるトークンの自動更新。
+ Amazon Quick によって管理される安全な認証情報ストレージ。

### Service-to-service認証 (2LO)
<a name="qbs-action-connector-apis-service-auth"></a>

複雑なエンタープライズ統合の場合:
+ クライアント認証情報の OAuth フローをサポートします。
+ system-to-systemインタラクションを有効にします。
+ クライアント ID、クライアントシークレット、トークン URL の設定が必要です。
+ 高度なセキュリティを必要とする自動ワークフローに適しています。
+ OAuth - 動的クライアント登録 (DCR - 一部の MCP サーバーにのみ適用されます）。

### API キー認証
<a name="qbs-action-connector-apis-api-key"></a>

自動ワークフローの認証が簡素化されました。
+ 単一トークンベースの認証。
+ サービスレベルのアクセス許可。
+ バックグラウンドプロセスやスケジュールされたアクションに最適です。
+ ターゲットサービスから有効な API キーが必要です。

### 基本的な認証
<a name="qbs-action-connector-apis-basic-auth"></a>

基本認証は、シンプルなユーザー名/パスワード認証方法を提供します。
+ 標準の HTTP 基本認証ヘッダーを使用します。
+ 認証情報は base64 でエンコードされます。
+ OAuth キーまたは API キーをサポートしていないサービスに適しています。
+ 安全な HTTPS 接続が必要です。
+ パブリックサービスにはお勧めしません。

### なし
<a name="qbs-action-connector-apis-no-auth"></a>

認証は必要ありません。
+ パブリック APIs とサービスに使用されます。
+ 認証情報やトークンは必要ありません。
+ 読み取り専用またはパブリックオペレーションに制限されます。
+ 通常、パブリックデータフィードとドキュメントに使用されます。
+ 機密性の高いオペレーションには使用しないでください。

## アクセス許可とアクセスコントロール
<a name="qbs-action-connector-apis-permissions"></a>

アクションコネクタ APIs、アクセスコントロールリスト (ACLs。

### リソースレベルのアクセス許可
<a name="qbs-action-connector-apis-resource-permissions"></a>
+ **所有者** - 削除とアクセス許可の管理を含む完全なコントロール。
+ **Contributor** - コネクタ設定を使用および変更できます。
+ **ビューワー** - コネクタの詳細を表示し、有効なアクションを使用できます。

### アクセス許可管理のための API オペレーション
<a name="qbs-action-connector-apis-permission-operations"></a>
+ `DescribeActionConnectorPermissions` - 現在のアクセス許可設定を取得します。
+ `UpdateActionConnectorPermissions` - ユーザーアクセス許可を付与または取り消します。

## サポートされているコネクタカテゴリ
<a name="qbs-action-connector-apis-categories"></a>

### 多目的コネクタ
<a name="qbs-action-connector-apis-dual-purpose"></a>

これらのコネクタは、アクション統合とナレッジベースの作成の両方をサポートします。
+ **Amazon S3** - 管理コンソールを使用してファイルオペレーションのアクションを作成し、ウェブアプリを使用して S3 コンテンツからナレッジベースを作成します。
+ **Microsoft SharePoint** - ドキュメント管理アクション、コンテンツインデックス作成。
+ **OneDrive** - ファイルオペレーション、ドキュメント検索機能。
+ **Confluence** - コンテンツ作成アクション、ナレッジベース統合。

### アクションのみのコネクタ
<a name="qbs-action-connector-apis-task-only"></a>

ナレッジベース機能のないアクション実行に特化:
+ **Salesforce** - アカウントと問い合わせオペレーション、カスタムオブジェクト CRUD オペレーション、販売プロセスの自動化をサポートするエンタープライズ CRM 統合。
+ **JIRA** - 問題の追跡とプロジェクト管理。
+ **Microsoft Outlook** - E メールの送信、カレンダーイベントの管理、連絡先へのアクセス。
+ **Slack** - 通信および通知ワークフロー。
+ **ServiceNow** - IT サービス管理オペレーション。
+ **Zendesk** - チケットの作成、ケースの更新、ナレッジベースの検索。
+ **PagerDuty** - インシデントの作成、エスカレーションの管理、オンコールスケジュールの更新を行います。
+ **Asana** - アクションの作成、プロジェクトの更新、チームワークフローの管理を行います。
+ **BambooHR** - 従業員データにアクセスし、休暇申請を管理します。
+ **Smartsheet** - シートを更新し、プロジェクトデータを管理します。
+ **FactSet** - 財務データにアクセスし、レポートを生成します。
+ **SAP** - SAP システムにアクセスし、ビジネス機能を実行し、エンタープライズデータを管理します。

### ナレッジベース専用コネクタ
<a name="qbs-action-connector-apis-data-only"></a>

アクション機能のないナレッジベースの統合に焦点を当てます。
+ **Google Drive** - ドキュメントのインデックス作成と検索。
+ **Web Crawler** - コンテンツの検出とインデックス作成。

## API ライフサイクル管理
<a name="qbs-action-connector-apis-lifecycle"></a>

### 認証情報管理
<a name="qbs-action-connector-apis-credential-management"></a>
+ OAuth アクションコネクタの自動更新トークン処理。
+ を使用した認証情報の安全なストレージ AWS KMS。
+ 認証情報のローテーションと更新のサポート。
+ Amazon S3 コネクタのクロスアカウントアクセス。

### 接続の更新
<a name="qbs-action-connector-apis-connection-updates"></a>

`UpdateActionConnector` API を使用して以下を行います。
+ 認証情報を変更します。
+ サービス設定パラメータを更新します。
+ アクションコネクタのメタデータを変更します。

### モニタリングとトラブルシューティング
<a name="qbs-action-connector-apis-monitoring"></a>
+ CloudWatch メトリクスを使用して API の使用状況を追跡します。
+ 接続の正常性と認証ステータスをモニタリングします。
+ 一般的な障害シナリオのエラー処理を実装します。
+ 検証 APIsを使用して設定の問題を診断します。

## レート制限とクォータ
<a name="qbs-action-connector-apis-rate-limiting"></a>

アクションコネクタ APIs、標準の AWS API レート制限を実装します。
+ 標準 AWS API スロットリングはすべてのオペレーションに適用されます。
+ 接続の検証には追加の制限がある場合があります。
+ アクションの実行レートは、ターゲットサービス機能によって異なります。
+ 再試行ロジックにエクスポネンシャルバックオフを実装します。

## クロスアカウントのサポート
<a name="qbs-action-connector-apis-cross-account"></a>

Amazon S3 コネクタの場合、APIsクロスアカウントアクセスをサポートします。
+ コネクタの作成時に異なる AWS アカウント IDsを指定します。
+ クロスアカウントアクセスに適切な IAM アクセス許可を設定します。
+ アカウント間の安全な認証情報管理 AWS KMS に を使用します。
+ クロスアカウント接続を有効にする前に、アクセス許可を検証します。

## エラー処理とトラブルシューティング
<a name="qbs-action-connector-apis-error-handling"></a>

アクションコネクタ APIs、標準 AWS エラーレスポンスを返します。

### 一般的なエラータイプ
<a name="qbs-action-connector-apis-common-errors"></a>
+ `AccessDeniedException` - オペレーションのアクセス許可が不十分です。
+ `InvalidParameterValueException` - オペレーションに 1 つ以上のパラメータ値が無効です。
+ 無効な設定パラメータ - サービス固有の設定値が正しくないか、見つかりません。
+ `ResourceNotFoundException` - コネクタまたはリソースが見つかりません。
+ `ThrottlingException` - レート制限を超えました。
+ `ConflictException` - リソースの競合または重複した名前。
+ `InternalFailureException` - リクエスト処理中に内部サービスエラーが発生しました。
+ `ResourceExistsException` - 既に存在するリソースを作成しようとします。
+ `InvalidNextTokenException` - 指定されたページ分割トークンが無効または期限切れです。
+ `AccessTokenNotFoundException` - ユーザーは接続を承認する必要があります (つまり、署名ボタン）。この例外は、UX がユーザーに認可を求めるために使用されます。
+ `TokenResponseException` - アクションの設定が無効です。

アプリケーションに適切なエラー処理を実装して、これらのシナリオを適切に管理し、ユーザーに有意義なフィードバックを提供します。

## CLI での Action Connector APIs AWS
<a name="qbs-action-connector-apis-cli-examples"></a>

 AWS CLI を使用して、アクションコネクタをプログラムで管理できます。次の例は、汎用プレースホルダー値を使用した一般的なオペレーションを示しています。

### アクションコネクタの作成
<a name="create-action-connector-cli"></a>

`create-action-connector` コマンドを使用して、外部サービスと統合するための新しいアクションコネクタを作成します。

```
aws quicksight create-action-connector \
  --aws-account-id "123456789012" \
  --name "MyS3Connector" \
  --action-connector-id "my-s3-connector-id" \
  --type "AMAZON_S3" \
  --authentication-config '{
    "AuthenticationType": "IAM",
    "AuthenticationMetadata": {
      "IamConnectionMetadata": {
        "RoleArn": "arn:aws:iam::123456789012:role/MyConnectorRole"
      }
    }
  }' \
  --enabled-actions "CreateBucket" "ListBuckets" \
  --description "S3 connector for automation workflows" \
  --region "us-east-1"
```

### アクションコネクタの一覧表示
<a name="list-action-connectors-cli"></a>

`list-action-connectors` コマンドを使用して、アカウント内のすべてのアクションコネクタを取得します。

```
aws quicksight list-action-connectors \
  --aws-account-id "123456789012" \
  --max-results 10 \
  --region "us-east-1"
```

### アクションコネクタの説明
<a name="describe-action-connector-cli"></a>

`describe-action-connector` コマンドを使用して、特定のアクションコネクタに関する詳細情報を取得します。

```
aws quicksight describe-action-connector \
  --aws-account-id "123456789012" \
  --action-connector-id "my-s3-connector-id" \
  --region "us-east-1"
```

### アクションコネクタの更新
<a name="update-action-connector-cli"></a>

`update-action-connector` コマンドを使用して、既存のアクションコネクタの設定を変更します。

```
aws quicksight update-action-connector \
  --aws-account-id "123456789012" \
  --action-connector-id "my-s3-connector-id" \
  --name "UpdatedS3Connector" \
  --authentication-config '{
    "AuthenticationType": "IAM",
    "AuthenticationMetadata": {
      "IamConnectionMetadata": {
        "RoleArn": "arn:aws:iam::123456789012:role/UpdatedConnectorRole"
      }
    }
  }' \
  --enabled-actions "CreateBucket" "ListBuckets" "DeleteBucket" \
  --region "us-east-1"
```

### アクションコネクタの検索
<a name="search-action-connectors-cli"></a>

`search-action-connectors` コマンドを使用して、特定の条件に基づいてアクションコネクタを検索します。

```
aws quicksight search-action-connectors \
  --aws-account-id "123456789012" \
  --max-results 5 \
  --filters '[{
    "Name": "ACTION_CONNECTOR_NAME",
    "Operator": "StringLike",
    "Value": "S3"
  }]' \
  --region "us-east-1"
```

### アクションコネクタのアクセス許可の管理
<a name="update-action-connector-permissions-cli"></a>

`update-action-connector-permissions` コマンドを使用して、アクションコネクタのアクセス許可を付与または取り消します。

```
aws quicksight update-action-connector-permissions \
  --aws-account-id "123456789012" \
  --action-connector-id "my-s3-connector-id" \
  --grant-permissions '[{
    "Actions": [
      "quicksight:DescribeActionConnector",
      "quicksight:UpdateActionConnector",
      "quicksight:DeleteActionConnector"
    ],
    "Principal": "arn:aws:quicksight:us-east-1:123456789012:user/default/myuser"
  }]' \
  --region "us-east-1"
```

### アクションコネクタのアクセス許可の表示
<a name="describe-action-connector-permissions-cli"></a>

`describe-action-connector-permissions` コマンドを使用して、アクションコネクタの現在のアクセス許可を表示します。

```
aws quicksight describe-action-connector-permissions \
  --aws-account-id "123456789012" \
  --action-connector-id "my-s3-connector-id" \
  --region "us-east-1"
```

### アクションコネクタの削除
<a name="delete-action-connector-cli"></a>

`delete-action-connector` コマンドを使用して、アカウントからアクションコネクタを削除します。

```
aws quicksight delete-action-connector \
  --aws-account-id "123456789012" \
  --action-connector-id "my-s3-connector-id" \
  --region "us-east-1"
```

## 次の手順
<a name="qbs-action-connector-apis-next-steps"></a>

アクションコネクタ APIsを理解したら、次のことができます。
+ 詳細なパラメータ仕様については、API リファレンスドキュメントを参照してください。
+ ターゲットサービスの特定のコネクタセットアップガイドをご覧ください。
+ ユースケースに適した認証フローを実装します。
+ 本番デプロイのモニタリングとエラー処理を設定します。
+ 組織のアクセス許可とアクセスコントロールを設定します。

# 認証方法
<a name="quick-action-auth"></a>

Amazon Quick は複数の認証方法をサポートし、それぞれが特定のユースケースとセキュリティ要件向けに設計されています。

## マネージド認証 (3LO)
<a name="quick-managed-auth"></a>

3 レッグ OAuth (3LO) は、サードパーティーのサービスへの個人アクセスに推奨される認証方法です。

**3LO の主な機能:**
+ 初期設定は必要ありません。
+ ユーザー固有の認証。
+ 安全な認証情報ストレージ。
+ 自動トークン更新。
+ 90 日間の更新トークンのライフサイクル。

**3LO セットアッププロセス:**

1. コネクタを選択します。

1. マネージド認証を選択します。

1. サービスプロバイダーのログインを完了します。

1. リクエストされたアクセス許可を付与します。

1. 接続を確認します。

## カスタムユーザーベースの認証
<a name="quick-custom-user-auth"></a>

特定の組織管理またはカスタム設定を必要とするシナリオの場合。

**必要な情報:**
+ クライアント ID。
+ クライアントシークレット。
+ ドメイン URL。
+ 認可 URL。
+ トークン URL。
+ リダイレクト URL。

**設定手順:**

1. サービスプロバイダーから認証情報を取得します。

1. 認証設定を構成します。

1. 接続を検証します。

1. アクセス許可をテストします。

Amazon Quick コンソールでユーザーベースの認証を設定するときは、サービスプロバイダーから適切な認証情報を取得し、認証設定を構成します。次に、接続を検証し、アクセス許可をテストします。

## API キー認証
<a name="quick-actions-api-key-auth"></a>

主に自動化されたワークフローとシステムレベルのアクセスに使用されます。

**主な機能:**
+ シンプルなトークンベースの認証。
+ 単一の認証情報管理。
+ サービスレベルのアクセス許可。
+ 自動プロセスに適しています。

**セットアップ要件:**

API キー認証を設定するときは、以下があることを確認してください。
+ サービスからの有効な API キー。
+ 適切なサービスアクセス許可。
+ シークレットストレージ設定。

## Service-to-service認証
<a name="quick-actions-service-to-service-auth"></a>

複雑な認証を必要とする自動ワークフロー用。

**設定要件:**
+ クライアント ID。
+ クライアントシークレット。
+ ドメイン URL。
+ トークン URL。
+ サービス固有のパラメータ。

# アクションの実行方法
<a name="int-actions-execution"></a>

Amazon Quick は、さまざまなユースケースやインタラクション設定に対応して、アクションを実行する複数の方法を提供します。

## チャットインターフェイス
<a name="qbs-actions-execution-qbs-actions-chat-interface"></a>

Amazon Quick Chat で暗黙的なアクションを実行できます。

### 暗黙的なアクション
<a name="qbs-actions-execution-qbs-actions-implicit-actions"></a>

Amazon Quick は、エージェントとの自然な会話による暗黙的なアクションの実行もサポートしています。高度な自然言語処理を使用すると、システムは会話が特定のアクションの必要性を示しているタイミングを特定できます。会話を分析して、リクエストを満たすために必要なアクションを決定します。

1 つのリクエストを完了するには、複数のアクションが必要になる場合があります。この場合、システムはこれらのアクションを順番に処理し、各ステップを案内します。特定されたアクションごとに、システムは入力する適切なフォームを表示します。各アクションが完了すると、シーケンスの次のアクションに進む前に確認メッセージが表示されます。

たとえば、「この問題の Jira チケットを作成し、Slack のチームに通知する」と尋ねると、システムは次のようになります。

1. まず、Jira チケット作成フォームを提示します。

1. チケットの作成が完了したら、Slack メッセージフォームを表示します。

1. 両方のアクションを順番に完了します。

プロセス全体で、複数のアクションを通じて進捗状況を追跡できます。すべてのアクションが完了すると、システムは実行されたすべてのアクションとその結果を示す包括的な概要を提供します。必要に応じて関連ドキュメントにアクセスし、プロセス中に発生した可能性のあるエラー状態を確認できます。

# モニタリングとメンテナンス
<a name="int-actions-monitoring"></a>

アクションコネクタのモニタリングは、信頼性の高いパフォーマンスを確保し、ユーザーに影響を与える前に問題を特定するのに役立ちます。定期的なモニタリングにより、使用状況パターンを追跡し、パフォーマンスを最適化し、外部サービスへの正常な接続を維持できます。

## パフォーマンスのモニタリング
<a name="qbs-actions-monitoring-qbs-actions-performance-monitoring"></a>

アクションコネクタのパフォーマンスは、次のメトリクスと分析を使用して評価できます。

### CloudWatch メトリクス
<a name="qbs-actions-monitoring-qbs-actions-cloudwatch-metrics"></a>
+ アクション実行の成功率 - 成功したアクション実行の割合を追跡して、信頼性の問題を特定します。
+ 応答時間 - アクションの完了にかかる時間をモニタリングし、パフォーマンスのボトルネックを特定します。
+ エラー頻度 - エラーパターンを追跡して、一般的な障害ポイントと改善すべき領域を特定します。
+ API クォータの使用 - サービス制限に対する使用状況をモニタリングして、スロットリングを防ぎ、容量を計画します。

### 使用状況分析
<a name="qbs-actions-monitoring-qbs-actions-usage-analytics"></a>

アクションコネクタでは、次の使用状況分析が収集されます。
+ アクティブユーザー - アクションコネクタをアクティブに使用しているユーザーの数を追跡して、導入パターンと使用パターンを理解します。
+ 一般的なアクション - 最適化作業の優先順位付けに最も頻繁に使用されるアクションを特定します。
+ 実行パターン - アクションが実行されるタイミングと頻度を分析して、リソースの割り当てを最適化します。
+ エラーの傾向 - エラーパターンを経時的にモニタリングして、体系的な問題と改善の機会を特定します。

## 接続の正常性
<a name="qbs-actions-monitoring-qbs-actions-connection-health"></a>

次の接続ヘルスツールを使用して、アクションコネクタのヘルスを評価できます。

### ステータスのモニタリング
<a name="qbs-actions-monitoring-qbs-actions-status-monitoring"></a>
+ 接続状態 - コネクタがアクティブに接続され、正常に機能しているかどうかをモニタリングします。
+ 認証の有効性 - アクセスの失敗を防ぐため、認証トークンと認証情報のステータスを追跡します。
+ トークンの有効期限追跡 - 認証トークンの有効期限が切れて更新が必要なタイミングをモニタリングします。
+ サービスの可用性 - 接続された外部サービスの可用性と応答ステータスを追跡します。

### 自動メンテナンス
<a name="qbs-actions-monitoring-qbs-actions-automated-maintenance"></a>
+ トークンの更新処理。
+ 接続復旧。
+ エラー再試行ロジック。
+ パフォーマンスの最適化。

## CloudWatch メトリクスリファレンス
<a name="qbs-actions-monitoring-qbs-actions-cloudwatch-metrics-table"></a>


**使用可能な CloudWatch メトリクス**  

| メトリクス | 説明 | Unit | 
| --- | --- | --- | 
| ActionSuccess | 成功した実行 | カウント | 
| ActionLatency | 実行時間 | ミリ秒 | 
| AuthFailures | 失敗した認証 | カウント | 
| APIThrottling | API スロットリングイベント | Count (カウント) | 

# ベストプラクティス
<a name="int-actions-best-practices"></a>

アクションコネクタのベストプラクティスに従うことで、安全で信頼性が高く、効率的なオペレーションを確保できます。これらのプラクティスは、最適なパフォーマンスを維持し、機密データを保護し、運用上の問題を最小限に抑えるのに役立ちます。

## セキュリティ
<a name="qbs-actions-best-practices-qbs-actions-security-best-practices"></a>

### 認証管理
<a name="qbs-actions-best-practices-qbs-actions-authentication-management"></a>
+ 認証情報の定期的なローテーション - セキュリティを維持するために、API キーと OAuth トークンをスケジュールに基づいて更新します。
+ 定期的なアクセス許可のレビュー - ユーザーおよびサービスのアクセス許可を四半期ごとに監査し、最小特権のアクセスを確保します。
+ トークンライフサイクルモニタリング - トークンの有効期限を追跡し、認証情報の有効期限が切れる前にアラートを設定します。
+ 監査ログ記録へのアクセス - 包括的なログ記録を有効にして、誰がどのサービスにいつアクセスしたかを追跡します。

### アクセスコントロール
<a name="qbs-actions-best-practices-qbs-actions-access-control"></a>
+ 最小特権アクセスを実装する - 各アクションが適切に機能するために必要な最小限のアクセス許可のみを付与します。
+ 定期的なアクセス許可監査 - 現在のアクセス許可が実際の使用パターンとビジネスニーズと一致していることを確認して検証します。
+ ドキュメントアクセスパターン - 誰がどのコネクタにアクセスできるかとその理由を明確に文書化します。
+ 使用状況の異常のモニタリング - セキュリティ上の問題を示す可能性のある異常なアクセスパターンのアラートを設定します。

## パフォーマンス
<a name="qbs-actions-best-practices-qbs-actions-performance-best-practices"></a>

### アクション設定
<a name="qbs-actions-best-practices-qbs-actions-action-configuration"></a>
+ フォームのデフォルトを最適化する - 一般的に使用される値を事前に入力して、ユーザーの入力時間とエラーを減らします。
+ 適切なタイムアウトを設定する - 各サービスの一般的な応答時間に基づいて、現実的なタイムアウト値を設定します。
+ エラー処理の設定 - クリアなユーザーメッセージを使用して堅牢なエラー処理を実装し、必要に応じてロジックを再試行します。
+ ドキュメントの依存関係 - さまざまなアクション間の前提条件や依存関係を明確に文書化します。

### リソース管理
<a name="qbs-actions-best-practices-qbs-actions-resource-management"></a>
+ API クォータをモニタリングします。
+ 使用パターンを追跡します。
+ 更新スケジュールを最適化します。
+ 未使用のコネクタの定期的なクリーンアップ。

## メンテナンス
<a name="qbs-actions-best-practices-qbs-actions-maintenance-best-practices"></a>

### 通常のアクション
<a name="qbs-actions-best-practices-qbs-actions-regular-tasks"></a>
+ コネクタのステータスを確認します。
+ 設定を更新します。
+ 接続を検証します。
+ ドキュメントの変更。

### トラブルシューティング
<a name="qbs-actions-best-practices-qbs-actions-troubleshooting-tasks"></a>
+ エラーパターンをモニタリングします。
+ CloudWatch ログを確認します。
+ 解決時間を追跡します。
+ ソリューションを文書化します。

# トラブルシューティング
<a name="int-actions-troubleshooting"></a>

アクションコネクタで問題が発生した場合、体系的なトラブルシューティングを行うことで、問題をすばやく特定して解決できます。このガイダンスでは、ダウンタイムを最小限に抑え、機能を復元するための一般的な問題とその解決策について説明します。

## 一般的な の問題と解決策
<a name="qbs-actions-troubleshooting-qbs-actions-common-issues"></a>

### 認証の問題
<a name="qbs-actions-troubleshooting-qbs-actions-authentication-problems"></a>

#### トークンの有効期限
<a name="qbs-actions-troubleshooting-qbs-actions-token-expiration"></a>

```
Symptom: "Authentication token expired" error
Resolution:
```

1. コンソールで「再接続」を選択します。

1. 認証フローを完了します。

1. アクションを再試行します。

#### アクセス許可エラー
<a name="qbs-actions-troubleshooting-qbs-actions-permission-errors"></a>

```
Symptom: "Insufficient permissions" message
Resolution:
```

1. サービスのアクセス許可を確認します。

1. コネクタの設定を確認します。

1. アクションの要件を確認します。

#### 接続の失敗
<a name="qbs-actions-troubleshooting-qbs-actions-connection-failures"></a>

```
Symptom: "Unable to connect to service" error
Resolution:
```

1. サービスの可用性を確認します。

1. ネットワーク接続を確認します。

1. 認証情報を検証します。

1.  サービスのクォータを確認します。

### アクション固有の問題
<a name="qbs-actions-troubleshooting-qbs-actions-action-specific-issues"></a>

#### フォーム送信の失敗
<a name="qbs-actions-troubleshooting-qbs-actions-form-submission-failures"></a>

##### 検証エラー
<a name="qbs-actions-troubleshooting-qbs-actions-validation-errors"></a>
+ 必須フィールドを確認します。
+ データ形式を確認します。
+ フィールドの制限を確認します。
+ 特殊文字を確認します。

##### タイムアウトの問題
<a name="qbs-actions-troubleshooting-qbs-actions-timeout-issues"></a>
+ フォームの複雑さを軽減します。
+ ネットワークレイテンシーを確認します。
+ サービスの応答時間を確認します。
+ 複数のアクションに分割することを検討してください。

#### 同期とパフォーマンスの問題
<a name="qbs-actions-troubleshooting-qbs-actions-sync-performance-issues"></a>

##### 応答時間が遅い
<a name="qbs-actions-troubleshooting-qbs-actions-slow-response-times"></a>

```
Resolution:
```

1. API レート制限を確認します。

1. 同時実行を確認します。

1. サービスの状態をモニタリングします。

1. アクション設定を最適化します。

##### 失敗した実行
<a name="qbs-actions-troubleshooting-qbs-actions-failed-executions"></a>

```
Resolution:
```

1. CloudWatch ログを確認します。

1. エラーメッセージを確認します。

1. サービスのステータスを確認します。

1. 接続の状態をテストします。

## 一般的なエラーメッセージ
<a name="qbs-actions-troubleshooting-qbs-actions-error-messages"></a>


**エラーコードと解決方法**  

| エラーコード | 説明 | 解決策 | 
| --- | --- | --- | 
| AUTH\$1001 | 認証に失敗しました | 認証情報を確認して再試行する | 
| CONN\$1002 | 接続タイムアウト | ネットワークとサービスのステータスを確認する | 
| PERM\$1003 | アクセス権限の不足 | 必要なアクセス許可を確認する | 
| TOKEN\$1004 | トークンの有効期限が切れました | 認証を再開する | 