

本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。

# 提高生產力的 AppFabric API 動作 （預覽）
<a name="productivity-actions"></a>


|  | 
| --- |
| 生產力的 The AWS AppFabric 功能處於預覽狀態，可能會有所變更。 | 

AppFabric 的生產力功能支援下列動作。

如需所有其他 AppFabric API 動作，請參閱 [AWS AppFabric API 動作](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>


|  | 
| --- |
| 生產力的 The AWS AppFabric 功能處於預覽狀態，可能會有所變更。 | 

授權 AppClient。

**Topics**
+ [請求內文](#API_Authorize_request)

## 請求內文
<a name="API_Authorize_request"></a>

請求接受採用 JSON 格式的下列資料。


| 參數 | Description | 
| --- | --- | 
|  **app\$1client\$1id**  |  要授權的 AppClient ID。  | 
|  **redirect\$1uri**  |  授權後將最終使用者重新導向至 的 URI。  | 
|  **state**  |  用來維護請求與回呼之間狀態的唯一值。  | 

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


|  | 
| --- |
| 生產力的 The AWS AppFabric 功能處於預覽狀態，可能會有所變更。 | 

建立 AppClient。

**Topics**
+ [請求內文](#API_CreateAppClient_request)
+ [回應元素](#API_CreateAppClient_response)

## 請求內文
<a name="API_CreateAppClient_request"></a>

請求接受採用 JSON 格式的下列資料。


| 參數 | Description | 
| --- | --- | 
|  **appName**  |  應用程式的名稱。 類型：字串 長度限制：長度下限為 1。長度上限為 255。 必要：是  | 
|  **clientToken**  |  指定您提供的唯一、區分大小寫的識別符，以確保請求的冪等性。這可讓您安全地重試請求，而不會意外再次執行相同的操作。將相同的值傳遞給稍後的 操作呼叫，也需要您為所有其他參數傳遞相同的值。我們建議您使用 [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。長度上限為 1011。 模式：`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。您最多可以新增 5 個 redirectUrls。例如 `https://localhost:8080`。 類型：字串陣列 陣列成員：項目數下限為 1。項目數上限為 5。 長度限制：長度下限為 1。長度上限為 2048。 模式：`(http\|https):\/\/[-a-zA-Z0-9_:.\/]+` 必要：是  | 
|  **starterUserEmails**  |  允許存取以接收洞見的使用者的入門電子郵件地址，直到 AppClient 驗證為止。 類型：字串陣列 陣列成員：固定項目數為 1。 長度限制：長度下限為 0。長度上限為 320。 模式：`[a-zA-Z0-9.!#$%&’*+/=?^_`{\|}~-]+@[a-zA-Z0-9-]+(?:\.[a-zA-Z0-9-]+)*` 必要：是  | 
|  **tags**  |  要指派給資源之標籤或標籤的鍵值對映射。 類型：標籤物件陣列 陣列成員：項目數下限為 0。項目數上限為 50。 必要：否  | 

## 回應元素
<a name="API_CreateAppClient_response"></a>

如果動作成功，則服務傳回 HTTP 201 回應。

服務會傳回下列 JSON 格式的資料。


| 參數 | Description | 
| --- | --- | 
|  **appClientSummary**  |  包含 AppClient 的摘要。 類型：[AppClientSummary](API_AppClientSummary.md) 物件  | 

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


|  | 
| --- |
| 生產力的 The AWS AppFabric 功能處於預覽狀態，可能會有所變更。 | 

刪除應用程式用戶端。

**Topics**
+ [請求內文](#API_DeleteAppClient_request)
+ [回應元素](#API_DeleteAppClient_response)

## 請求內文
<a name="API_DeleteAppClient_request"></a>

請求接受採用 JSON 格式的下列資料。


| 參數 | Description | 
| --- | --- | 
|  **appClientIdentifier**  |  要用於請求之 AppClient 的 Amazon Resource Name (ARN) 或 Universal Unique Identifier (UUID)。 長度限制：長度下限為 1。長度上限為 1011。 模式：`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>


|  | 
| --- |
| 生產力的 The AWS AppFabric 功能處於預覽狀態，可能會有所變更。 | 

傳回 AppClient 的相關資訊。

**Topics**
+ [請求內文](#API_GetAppClient_request)
+ [回應元素](#API_GetAppClient_response)

## 請求內文
<a name="API_GetAppClient_request"></a>

請求接受採用 JSON 格式的下列資料。


| 參數 | Description | 
| --- | --- | 
|  **appClientIdentifier**  |  要用於請求之 AppClient 的 Amazon Resource Name (ARN) 或 Universal Unique Identifier (UUID)。 長度限制：長度下限為 1。長度上限為 1011。 模式：`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 格式的資料。


| 參數 | Description | 
| --- | --- | 
|  **appClient**  |  包含 AppClient 的相關資訊。 類型：[AppClient](API_AppClient.md) 物件  | 

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


|  | 
| --- |
| 生產力的 The AWS AppFabric 功能處於預覽狀態，可能會有所變更。 | 

列出最重要的可行電子郵件訊息、任務和其他更新。

**Topics**
+ [請求內文](#API_ListActionableInsights_request)
+ [回應元素](#API_ListActionableInsights_response)

## 請求內文
<a name="API_ListActionableInsights_request"></a>

請求接受採用 JSON 格式的下列資料。


| 參數 | Description | 
| --- | --- | 
|  **nextToken**  |  如果傳回 `nextToken` ，則有更多結果可用。的值`nextToken`是每個頁面的唯一分頁字符。使用傳回的字符再次進行呼叫，以擷取下一頁。讓所有其他引數保持不變。每個分頁字符會在 24 小時後過期。使用過期的分頁字符將傳回 *HTTP 400 InvalidToken 錯誤*。  | 

## 回應元素
<a name="API_ListActionableInsights_response"></a>

如果動作成功，則服務傳回 HTTP 201 回應。

服務會傳回下列 JSON 格式的資料。


| 參數 | Description | 
| --- | --- | 
|  **ActionableInsightsList**  |  列出可行的洞見，包括標題、描述、動作和建立的時間戳記。如需詳細資訊，請參閱[ActionableInsights](API_ActionableInsights.md)。  | 
|  **nextToken**  |  如果傳回 `nextToken` ，則有更多結果可用。的值`nextToken`是每個頁面的唯一分頁字符。使用傳回的字符再次進行呼叫，以擷取下一頁。讓所有其他引數保持不變。每個分頁字符會在 24 小時後過期。使用過期的分頁字符將傳回 *HTTP 400 InvalidToken 錯誤*。 類型：字串  | 

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


|  | 
| --- |
| 生產力的 The AWS AppFabric 功能處於預覽狀態，可能會有所變更。 | 

傳回所有 AppClients 的清單。

**Topics**
+ [請求內文](#API_ListAppClients_request)
+ [回應元素](#API_ListAppClients_response)

## 請求內文
<a name="API_ListAppClients_request"></a>

請求接受採用 JSON 格式的下列資料。


| 參數 | Description | 
| --- | --- | 
|  **maxResults**  |  每次呼叫傳回的結果數目上限。您可以使用 `nextToken` 取得進一步的結果頁面。 這只是上限。每次呼叫傳回的實際結果數量可能少於指定的最大值。 有效範圍：最小值為 1。最大值為 100。  | 
|  **nextToken**  |  如果傳回 `nextToken` ，則有更多結果可用。的值`nextToken`是每個頁面的唯一分頁字符。使用傳回的字符再次進行呼叫，以擷取下一頁。讓所有其他引數保持不變。每個分頁字符會在 24 小時後過期。使用過期的分頁字符將傳回 *HTTP 400 InvalidToken 錯誤*。  | 

## 回應元素
<a name="API_ListAppClients_response"></a>

如果動作成功，則服務傳回 HTTP 200 回應。

服務會傳回下列 JSON 格式的資料。


| 參數 | Description | 
| --- | --- | 
|  **appClientList**  |  包含 AppClient 結果的清單。 類型：[AppClientSummary](API_AppClientSummary.md) 物件的陣列  | 
|  **nextToken**  |  如果傳回 `nextToken` ，則有更多結果可用。的值`nextToken`是每個頁面的唯一分頁字符。使用傳回的字符再次進行呼叫，以擷取下一頁。讓所有其他引數保持不變。每個分頁字符會在 24 小時後過期。使用過期的分頁字符將傳回 *HTTP 400 InvalidToken 錯誤*。 類型：字串  | 

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


|  | 
| --- |
| 生產力的 The AWS AppFabric 功能處於預覽狀態，可能會有所變更。 | 

列出最重要的可行行事曆事件。

**Topics**
+ [請求內文](#API_ListMeetingInsights_request)
+ [回應元素](#API_ListMeetingInsights_response)

## 請求內文
<a name="API_ListMeetingInsights_request"></a>

請求接受採用 JSON 格式的下列資料。


| 參數 | Description | 
| --- | --- | 
|  **nextToken**  |  如果傳回 `nextToken` ，則有更多結果可用。的值`nextToken`是每個頁面的唯一分頁字符。使用傳回的字符再次進行呼叫，以擷取下一頁。讓所有其他引數保持不變。每個分頁字符會在 24 小時後過期。使用過期的分頁字符將傳回 *HTTP 400 InvalidToken 錯誤*。  | 

## 回應元素
<a name="API_ListMeetingInsights_response"></a>

如果動作成功，則服務傳回 HTTP 201 回應。

服務會傳回下列 JSON 格式的資料。


| 參數 | Description | 
| --- | --- | 
|  **MeetingInsightList**  |  列出可行的會議洞見。如需詳細資訊，請參閱[MeetingInsights](API_MeetingInsights.md)。  | 
|  **nextToken**  |  如果傳回 `nextToken` ，則有更多結果可用。的值`nextToken`是每個頁面的唯一分頁字符。使用傳回的字符再次進行呼叫，以擷取下一頁。讓所有其他引數保持不變。每個分頁字符會在 24 小時後過期。使用過期的分頁字符將傳回 *HTTP 400 InvalidToken 錯誤*。 類型：字串  | 

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


|  | 
| --- |
| 生產力的 The AWS AppFabric 功能處於預覽狀態，可能會有所變更。 | 

允許使用者提交特定洞見或動作的意見回饋。

**Topics**
+ [請求內文](#API_PutFeedback_request)
+ [回應元素](#API_PutFeedback_response)

## 請求內文
<a name="API_PutFeedback_request"></a>

請求接受採用 JSON 格式的下列資料。


| 參數 | Description | 
| --- | --- | 
|  **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>


|  | 
| --- |
| 生產力的 The AWS AppFabric 功能處於預覽狀態，可能會有所變更。 | 

包含的資訊可讓 AppClients 交換存取字符的授權碼。

**Topics**
+ [請求內文](#API_Token_request)
+ [回應元素](#API_Token_response)

## 請求內文
<a name="API_Token_request"></a>

請求接受採用 JSON 格式的下列資料。


| 參數 | Description | 
| --- | --- | 
|  **code**  |  從授權端點收到的授權碼。 類型：字串 長度限制：長度下限為 1。長度上限為 2048。 必要：否  | 
|  **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。長度上限為 4096。 必要：否  | 

## 回應元素
<a name="API_Token_response"></a>

如果動作成功，則服務傳回 HTTP 200 回應。

服務會傳回下列 JSON 格式的資料。


| 參數 | Description | 
| --- | --- | 
|  **appfabric\$1user\$1id**  |  字符的使用者 ID。這只會針對使用 `authorization_code`授予類型的請求傳回。 類型：字串  | 
|  **expires\$1in**  |  直到字符過期的秒數。 類型：Long  | 
|  **refresh\$1token**  |  用於後續請求的重新整理字符。 類型：字串 長度限制：長度下限為 1。長度上限為 2048。  | 
|  **t**oken  |  存取字符。 類型：字串 長度限制：長度下限為 1。長度上限為 2048。  | 
|  **token\$1type**  |  字符類型。 類型：字串  | 

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


|  | 
| --- |
| 生產力的 The AWS AppFabric 功能處於預覽狀態，可能會有所變更。 | 

更新 AppClient。

**Topics**
+ [請求內文](#API_UpdateAppClient_request)
+ [回應元素](#API_UpdateAppClient_response)

## 請求內文
<a name="API_UpdateAppClient_request"></a>

請求接受採用 JSON 格式的下列資料。


| 參數 | Description | 
| --- | --- | 
|  **appClientIdentifier**  |  要用於請求之 AppClient 的 Amazon Resource Name (ARN) 或 Universal Unique Identifier (UUID)。 長度限制：長度下限為 1。長度上限為 1011。 模式：`arn:.+$\|^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}` 必要：是  | 
|  **redirectUrls**  |  授權後要將最終使用者重新導向至 的 URI。您最多可以新增 5 個 redirectUrls。例如 `https://localhost:8080`。 類型：字串陣列 陣列成員：項目數下限為 1。項目數上限為 5。 長度限制：長度下限為 1。長度上限為 2048。 模式：`(http\|https):\/\/[-a-zA-Z0-9_:.\/]+`   | 

## 回應元素
<a name="API_UpdateAppClient_response"></a>

如果動作成功，則服務傳回 HTTP 200 回應。

服務會傳回下列 JSON 格式的資料。


| 參數 | Description | 
| --- | --- | 
|  **appClient**  |  包含 AppClient 的相關資訊。 類型：[AppClient](API_AppClient.md) 物件  | 