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

# AppFabric for productivity の API アクション (プレビュー)
<a name="productivity-actions"></a>


|  | 
| --- |
|  AWS AppFabric for productivity 機能はプレビュー版であり、変更される可能性があります。 | 

AppFabric for productivity 機能では、次のアクションがサポートされています。

AppFabric API のその他のアクションについては、「[AWS AppFabric API Actions](https://docs.aws.amazon.com/appfabric/latest/api/API_Operations.html)」を参照してください。

**Topics**
+ [承認](API_Authorize.md)
+ [CreateAppClient](API_CreateAppClient.md)
+ [DeleteAppClient](API_DeleteAppClient.md)
+ [GetAppClient](API_GetAppClient.md)
+ [ListActionableInsights](API_ListActionableInsights.md)
+ [ListAppClients](API_ListAppClients.md)
+ [ListMeetingInsights](API_ListMeetingInsights.md)
+ [PutFeedback](API_PutFeedback.md)
+ [トークン](API_Token.md)
+ [UpdateAppClient](API_UpdateAppClient.md)

# 承認
<a name="API_Authorize"></a>


|  | 
| --- |
|  AWS AppFabric for productivity 機能はプレビュー版であり、変更される可能性があります。 | 

AppClient を認証します。

**Topics**
+ [リクエストボディ](#API_Authorize_request)

## リクエストボディ
<a name="API_Authorize_request"></a>

リクエストは以下の JSON 形式のデータを受け入れます。


| パラメータ | 説明 | 
| --- | --- | 
|  **app\$1client\$1id**  |  承認する AppClient の ID です。  | 
|  **redirect\$1uri**  |  承認後にエンドユーザーがリダイレクトされる URI です。  | 
|  **state**  |  リクエストとコールバック間の状態を維持するための一意の値です。  | 

# CreateAppClient
<a name="API_CreateAppClient"></a>


|  | 
| --- |
|  AWS AppFabric for productivity 機能はプレビュー版であり、変更される可能性があります。 | 

AppClient を作成します。

**Topics**
+ [リクエストボディ](#API_CreateAppClient_request)
+ [レスポンス要素](#API_CreateAppClient_response)

## リクエストボディ
<a name="API_CreateAppClient_request"></a>

リクエストは以下の JSON 形式のデータを受け入れます。


| パラメータ | 説明 | 
| --- | --- | 
|  **appName**  |  アプリケーションの名前。 タイプ: 文字列 長さの制約: 最小長は 1 です。最大長は 255 です。 必須: はい  | 
|  **clientToken**  |  リクエストの冪等性のために割り当てる一意の識別子 (大文字と小文字を区別) を指定します。これにより、同じ操作を誤って 2 度実行することなく、リクエストを安全に再試行できます。操作の後半の呼び出しで同じ値を渡す場合は、他のすべてのパラメータにも同じ値を渡す必要があります。[UUID タイプの値](https://wikipedia.org/wiki/Universally_unique_identifier)を使用することが推奨されます。 この値を指定しない場合、 はランダムな値 AWS を生成します。 同じ `ClientToken` を使って、異なるパラメータで操作を再試行すると、再試行は `IdempotentParameterMismatch` のエラーにより失敗します。 タイプ: 文字列 パターン: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}` 必須: いいえ  | 
|  **customerManagedKeyIdentifier**  |  によって カスタマー管理キー 生成された の ARN AWS Key Management Service。このキーはデータの暗号化に使用します。 キーが指定されていない場合は、 AWS マネージドキー が使用されます。リソースに割り当てるタグの、キーと値のペアのマップ。  AWS 所有のキー およびカスタマーマネージドキーの詳細については、「 *AWS Key Management Service デベロッパーガイド*」の[「カスタマーキーと AWS キー](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-mgmt)」を参照してください。 タイプ: 文字列 長さの制約: 最小長は 1 です。最大長は 1,011 です。 パターン: `arn:.+$\|^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}` 必須: いいえ  | 
|  **[ Description]** ( 説明)  |  アプリケーションの説明です。 タイプ: 文字列 必須: はい  | 
|  **iconUrl**  |  AppClient のアイコンまたはロゴの URL です。 タイプ: 文字列 必須: いいえ  | 
|  **redirectUrls**  |  承認後にエンドユーザーがリダイレクトされる URI です。redirectUrls は 5 個まで追加できます。例えば、`https://localhost:8080`。 型: 文字列の配列 配列メンバー: 最小数は 1 項目です。最大数は 5 項目です。 長さの制限：最小長 1、最大長は 2,048 です。 パターン: `(http\|https):\/\/[-a-zA-Z0-9_:.\/]+` 必須: はい  | 
|  **starterUserEmails**  |  AppClient が検証されるまでインサイトを受け取ることが許可されている、ユーザーのためのスターターメールアドレス。 型: 文字列の配列 配列メンバー: 1 項目の定数です。 長さの制約: 最小長は 0 です。最大長は 320 です。 パターン: `[a-zA-Z0-9.!#$%&’*+/=?^_`{\|}~-]+@[a-zA-Z0-9-]+(?:\.[a-zA-Z0-9-]+)*` 必須: はい  | 
|  **[タグ]**  |  リソースに割り当てるタグの、キーと値のペアのマップ。 タイプ: タグオブジェクトの配列 配列メンバー: 最小数は 0 項目です。最大数は 50 項目です。 必須: いいえ  | 

## レスポンス要素
<a name="API_CreateAppClient_response"></a>

アクションが成功すると、HTTP 201 レスポンスが返されます。

サービスから以下のデータが JSON 形式で返されます。


| パラメータ | 説明 | 
| --- | --- | 
|  **appClientSummary**  |  AppClient の概要が含まれています。 タイプ:[AppClientSummary](API_AppClientSummary.md) オブジェクト  | 

# DeleteAppClient
<a name="API_DeleteAppClient"></a>


|  | 
| --- |
|  AWS AppFabric for productivity 機能はプレビュー版であり、変更される可能性があります。 | 

アプリケーションクライアントを削除します。

**Topics**
+ [リクエストボディ](#API_DeleteAppClient_request)
+ [レスポンス要素](#API_DeleteAppClient_response)

## リクエストボディ
<a name="API_DeleteAppClient_request"></a>

リクエストは以下の JSON 形式のデータを受け入れます。


| パラメータ | 説明 | 
| --- | --- | 
|  **appClientIdentifier**  |  リクエストに使用する AppClient の Amazon リソースネーム (ARN) または Universal Unique Identifier (UUID) です。 長さの制限：最小長 1、最大長は 1,011 です。 パターン: `arn:.+$\|^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}` 必須: はい  | 

## レスポンス要素
<a name="API_DeleteAppClient_response"></a>

アクションが成功した場合、サービスは空の HTTP 本文を持つ HTTP 204 レスポンスを返します。

# GetAppClient
<a name="API_GetAppClient"></a>


|  | 
| --- |
|  AWS AppFabric for productivity 機能はプレビュー版であり、変更される可能性があります。 | 

AppClient に関する情報を返します。

**Topics**
+ [リクエストボディ](#API_GetAppClient_request)
+ [レスポンス要素](#API_GetAppClient_response)

## リクエストボディ
<a name="API_GetAppClient_request"></a>

リクエストは以下の JSON 形式のデータを受け入れます。


| パラメータ | 説明 | 
| --- | --- | 
|  **appClientIdentifier**  |  リクエストに使用する AppClient の Amazon リソースネーム (ARN) または Universal Unique Identifier (UUID) です。 長さの制限：最小長 1、最大長は 1,011 です。 パターン: `arn:.+$\|^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}` 必須: はい  | 

## レスポンス要素
<a name="API_GetAppClient_response"></a>

アクションが成功すると、サービスは HTTP 200 レスポンスを返します。

サービスから以下のデータが JSON 形式で返されます。


| パラメータ | 説明 | 
| --- | --- | 
|  **appClient**  |  AppClient に関する情報が含まれます。 タイプ: [AppClient](API_AppClient.md) オブジェクト  | 

# ListActionableInsights
<a name="API_ListActionableInsights"></a>


|  | 
| --- |
|  AWS AppFabric for productivity 機能はプレビュー版であり、変更される可能性があります。 | 

実行可能な E メールメッセージ、タスク、その他の更新の最も重要なものを一覧表示します。

**Topics**
+ [リクエストボディ](#API_ListActionableInsights_request)
+ [レスポンス要素](#API_ListActionableInsights_response)

## リクエストボディ
<a name="API_ListActionableInsights_request"></a>

リクエストは以下の JSON 形式のデータを受け入れます。


| パラメータ | 説明 | 
| --- | --- | 
|  **nextToken**  |  `nextToken` が返された場合、その他にもまだ結果があります。`nextToken` の値は、各ページに固有のページネーショントークンです。後続ページを取得するには、返されたトークンを使用して再度呼び出します。他の引数をすべて維持します。各ページネーショントークンの有効期間は 24 時間です。期限の切れたページネーショントークンを使用すると、HTTP 400 InvalidToken エラーが返されます。  | 

## レスポンス要素
<a name="API_ListActionableInsights_response"></a>

アクションが成功すると、HTTP 201 レスポンスが返されます。

サービスから以下のデータが JSON 形式で返されます。


| パラメータ | 説明 | 
| --- | --- | 
|  **ActionableInsightsList**  |  件名、説明、アクション、作成済みのタイムスタンプなど実行可能なインサイトを一覧表示します。詳細については、「[ActionableInsights](API_ActionableInsights.md)」を参照してください。  | 
|  **nextToken**  |  `nextToken` が返された場合、その他にもまだ結果があります。`nextToken` の値は、各ページに固有のページネーショントークンです。後続ページを取得するには、返されたトークンを使用して再度呼び出します。他の引数をすべて維持します。各ページネーショントークンの有効期間は 24 時間です。期限の切れたページネーショントークンを使用すると、HTTP 400 InvalidToken エラーが返されます。 タイプ: 文字列  | 

# ListAppClients
<a name="API_ListAppClients"></a>


|  | 
| --- |
|  AWS AppFabric for productivity 機能はプレビュー版であり、変更される可能性があります。 | 

すべての AppClients のリストを返します。

**Topics**
+ [リクエストボディ](#API_ListAppClients_request)
+ [レスポンス要素](#API_ListAppClients_response)

## リクエストボディ
<a name="API_ListAppClients_request"></a>

リクエストは以下の JSON 形式のデータを受け入れます。


| パラメータ | 説明 | 
| --- | --- | 
|  **maxResults**  |  コールごとに返される結果の最大数です。`nextToken` を使用すると結果ページをさらに取得できます。 こちらはあくまでも上限です。1 回のコールで返される実際の結果が、指定の最大数より少なくなる場合もあります。 有効範囲: 最小値 1。最大値は 100 です。  | 
|  **nextToken**  |  `nextToken` が返された場合、その他にもまだ結果があります。`nextToken` の値は、各ページに固有のページネーショントークンです。後続ページを取得するには、返されたトークンを使用して再度呼び出します。他の引数をすべて維持します。各ページネーショントークンの有効期間は 24 時間です。期限の切れたページネーショントークンを使用すると、HTTP 400 InvalidToken エラーが返されます。  | 

## レスポンス要素
<a name="API_ListAppClients_response"></a>

アクションが成功すると、サービスは HTTP 200 レスポンスを返します。

サービスから以下のデータが JSON 形式で返されます。


| パラメータ | 説明 | 
| --- | --- | 
|  **appClientList**  |  AppClient の結果のリストが含まれています。 タイプ: [AppClientSummary](API_AppClientSummary.md) オブジェクトの配列。  | 
|  **nextToken**  |  `nextToken` が返された場合、その他にもまだ結果があります。`nextToken` の値は、各ページに固有のページネーショントークンです。後続ページを取得するには、返されたトークンを使用して再度呼び出します。他の引数をすべて維持します。各ページネーショントークンの有効期間は 24 時間です。期限の切れたページネーショントークンを使用すると、HTTP 400 InvalidToken エラーが返されます。 タイプ: 文字列  | 

# ListMeetingInsights
<a name="API_ListMeetingInsights"></a>


|  | 
| --- |
|  AWS AppFabric for productivity 機能はプレビュー版であり、変更される可能性があります。 | 

実行可能なカレンダーイベントの最も重要なものを一覧表示します。

**Topics**
+ [リクエストボディ](#API_ListMeetingInsights_request)
+ [レスポンス要素](#API_ListMeetingInsights_response)

## リクエストボディ
<a name="API_ListMeetingInsights_request"></a>

リクエストは以下の JSON 形式のデータを受け入れます。


| パラメータ | 説明 | 
| --- | --- | 
|  **nextToken**  |  `nextToken` が返された場合、その他にもまだ結果があります。`nextToken` の値は、各ページに固有のページネーショントークンです。後続ページを取得するには、返されたトークンを使用して再度呼び出します。他の引数をすべて維持します。各ページネーショントークンの有効期間は 24 時間です。期限の切れたページネーショントークンを使用すると、HTTP 400 InvalidToken エラーが返されます。  | 

## レスポンス要素
<a name="API_ListMeetingInsights_response"></a>

アクションが成功すると、HTTP 201 レスポンスが返されます。

サービスから以下のデータが JSON 形式で返されます。


| パラメータ | 説明 | 
| --- | --- | 
|  **MeetingInsightList**  |  会議に関する実行可能なインサイトを一覧表示します。詳細については、「[MeetingInsights](API_MeetingInsights.md)」を参照してください。  | 
|  **nextToken**  |  `nextToken` が返された場合、その他にもまだ結果があります。`nextToken` の値は、各ページに固有のページネーショントークンです。後続ページを取得するには、返されたトークンを使用して再度呼び出します。他の引数をすべて維持します。各ページネーショントークンの有効期間は 24 時間です。期限の切れたページネーショントークンを使用すると、HTTP 400 InvalidToken エラーが返されます。 タイプ: 文字列  | 

# PutFeedback
<a name="API_PutFeedback"></a>


|  | 
| --- |
|  AWS AppFabric for productivity 機能はプレビュー版であり、変更される可能性があります。 | 

特定のインサイトまたはアクションに関するフィードバックを送ることをユーザーに許可します。

**Topics**
+ [リクエストボディ](#API_PutFeedback_request)
+ [レスポンス要素](#API_PutFeedback_response)

## リクエストボディ
<a name="API_PutFeedback_request"></a>

リクエストは以下の JSON 形式のデータを受け入れます。


| パラメータ | 説明 | 
| --- | --- | 
|  **id**  |  フィードバックの送信対象となるオブジェクトの ID です。InsightId か ActionId のいずれかになります。  | 
|  **feedbackFor**  |  フィードバックの送信対象となるインサイトのタイプです。 使用できる値: `ACTIONABLE_INSIGHT \| MEETING_INSIGHT \| ACTION`  | 
|  **feedbackRating**  |  `1` から `5` までの評価です。値が大きいほど評価が高いことを意味します。  | 

## レスポンス要素
<a name="API_PutFeedback_response"></a>

アクションが成功した場合、サービスは空の HTTP 本文を持つ HTTP 201 レスポンスを返します。

# トークン
<a name="API_Token"></a>


|  | 
| --- |
|  AWS AppFabric for productivity 機能はプレビュー版であり、変更される可能性があります。 | 

AppClients が認可コードをアクセストークンと交換できるようにする情報が含まれます。

**Topics**
+ [リクエストボディ](#API_Token_request)
+ [レスポンス要素](#API_Token_response)

## リクエストボディ
<a name="API_Token_request"></a>

リクエストは以下の JSON 形式のデータを受け入れます。


| パラメータ | 説明 | 
| --- | --- | 
|  **コード**  |  認可エンドポイントから受信した認可コードです。 タイプ: 文字列 長さの制約: 最小長は 1 です。最大長は 2,048 です。 必須: いいえ  | 
|  **grant\$1type**  |  トークンの付与のタイプ。`authorization_code` または `refresh_token` である必要があります。 タイプ: 文字列 必須: はい  | 
|  **app\$1client\$1id**  |  AppClient の ID です。 タイプ: 文字列 パターン: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}` 必須: はい  | 
|  **redirect\$1uri**  |  認可エンドポイントに渡されたリダイレクト URI。 タイプ: 文字列 必須: いいえ  | 
|  **refresh\$1token**  |  最初のトークンリクエストで受け取った更新トークンです。 タイプ: 文字列 長さの制約: 最小長は 1 です。最大長は 4,096 です。 必須: いいえ  | 

## レスポンス要素
<a name="API_Token_response"></a>

アクションが成功すると、サービスは HTTP 200 レスポンスを返します。

サービスから以下のデータが JSON 形式で返されます。


| パラメータ | 説明 | 
| --- | --- | 
|  **appfabric\$1user\$1id**  |  トークン用のユーザーの ID。この値は、リクエストが `authorization_code` グラントタイプを使用している場合のみ返されます。 タイプ: 文字列  | 
|  **expires\$1in**  |  トークンの有効期限が切れるまでの残りの秒数。 タイプ: Long  | 
|  **refresh\$1token**  |  次のリクエストに使用する更新トークンです。 タイプ: 文字列 長さの制約: 最小長は 1 です。最大長は 2,048 です。  | 
|  **token** (トークン)  |  アクセストークンです。 タイプ: 文字列 長さの制約: 最小長は 1 です。最大長は 2,048 です。  | 
|  **token\$1type**  |  トークンのタイプです。 タイプ: 文字列  | 

# UpdateAppClient
<a name="API_UpdateAppClient"></a>


|  | 
| --- |
|  AWS AppFabric for productivity 機能はプレビュー版であり、変更される可能性があります。 | 

AppClient を更新します。

**Topics**
+ [リクエストボディ](#API_UpdateAppClient_request)
+ [レスポンス要素](#API_UpdateAppClient_response)

## リクエストボディ
<a name="API_UpdateAppClient_request"></a>

リクエストは以下の JSON 形式のデータを受け入れます。


| パラメータ | 説明 | 
| --- | --- | 
|  **appClientIdentifier**  |  リクエストに使用する AppClient の Amazon リソースネーム (ARN) または Universal Unique Identifier (UUID) です。 長さの制限：最小長 1、最大長は 1,011 です。 パターン: `arn:.+$\|^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}` 必須: はい  | 
|  **redirectUrls**  |  承認後にエンドユーザーがリダイレクトされる URI です。redirectUrls は 5 個まで追加できます。例えば、`https://localhost:8080`。 型: 文字列の配列 配列メンバー: 最小数は 1 項目です。最大数は 5 項目です。 長さの制限：最小長 1、最大長は 2,048 です。 パターン: `(http\|https):\/\/[-a-zA-Z0-9_:.\/]+`   | 

## レスポンス要素
<a name="API_UpdateAppClient_response"></a>

アクションが成功すると、サービスは HTTP 200 レスポンスを返します。

サービスから以下のデータが JSON 形式で返されます。


| パラメータ | 説明 | 
| --- | --- | 
|  **appClient**  |  AppClient に関する情報が含まれます。 タイプ: [AppClient](API_AppClient.md) オブジェクト  |