As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.
# Ações de API AppFabric para aumentar a produtividade (versão prévia)
| |
| --- |
| O recurso AWS AppFabric de produtividade está em versão prévia e está sujeito a alterações. |
As ações a seguir são compatíveis com AppFabric os recursos de produtividade.
Para todas as outras ações de AppFabric API, consulte as [Ações de AWS AppFabric API](https://docs.aws.amazon.com/appfabric/latest/api/API_Operations.html).
**Topics**
+ [Autorizar](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)
+ [Token](API_Token.md)
+ [UpdateAppClient](API_UpdateAppClient.md)
# Autorizar
| |
| --- |
| O recurso AWS AppFabric de produtividade está em versão prévia e está sujeito a alterações. |
Autoriza um AppClient.
**Topics**
+ [Corpo da solicitação](#API_Authorize_request)
## Corpo da solicitação
A solicitação aceita os dados a seguir no formato JSON.
| Parâmetro | Description |
| --- | --- |
| **app\$1client\$1id** | O ID do a AppClient ser autorizado. |
| **redirect\$1uri** | O URI para o qual redirecionar os usuários finais após a autorização. |
| **estado** | Um valor exclusivo para manter o estado entre a solicitação e o retorno de chamada. |
# CreateAppClient
| |
| --- |
| O recurso AWS AppFabric de produtividade está em versão prévia e está sujeito a alterações. |
Cria um AppClient.
**Topics**
+ [Corpo da solicitação](#API_CreateAppClient_request)
+ [Elementos de resposta](#API_CreateAppClient_response)
## Corpo da solicitação
A solicitação aceita os dados a seguir no formato JSON.
| Parâmetro | Description |
| --- | --- |
| **appName** | O nome do app. Tipo: string Restrições de comprimento: tamanho mínimo de 1. Comprimento máximo de 255. Obrigatório: Sim |
| **clientToken** | Especifica um identificador exclusivo que diferencia maiúsculas e minúsculas fornecido para garantir a idempotência da solicitação. Isso permite que você repita a solicitação com segurança sem executar acidentalmente a mesma operação pela segunda vez. Passar o mesmo valor para uma chamada posterior para uma operação exige que você também passe o mesmo valor para todos os outros parâmetros. Recomendamos que você use um [tipo de valor UUID](https://wikipedia.org/wiki/Universally_unique_identifier). Se você não fornecer esse valor, AWS gerará um valor aleatório para você. Se você repetir a operação com o mesmo `ClientToken`, mas com parâmetros diferentes, a nova tentativa falhará com um erro `IdempotentParameterMismatch`. Tipo: sequência Padrão: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}` Obrigatório: não |
| **customerManagedKeyIdentifier** | O ARN do chave gerenciada pelo cliente gerado por. AWS Key Management Service A chave é usada para criptografar os dados. Se nenhuma chave for especificada, um Chave gerenciada pela AWS será usado. Um mapa dos pares de chave-valor para a tag ou tags a atribuir ao recurso. Para obter mais informações sobre Chaves pertencentes à AWS chaves gerenciadas pelo cliente, consulte [Chaves e AWS chaves do cliente](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-mgmt) no *Guia do AWS Key Management Service desenvolvedor*. Tipo: string Restrições de comprimento: tamanho mínimo de 1. O comprimento máximo é 1011. Padrão: `arn:.+$\|^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}` Obrigatório: não |
| **descrição** | Uma descrição para a aplicação. Tipo: String Obrigatório: Sim |
| **iconUrl** | O URL do ícone ou logotipo do AppClient. Tipo: string Obrigatório: não |
| **redirectUrls** | O URI para o qual redirecionar os usuários finais após a autorização. É possível adicionar até 5 redirectUrls. Por exemplo, .`https://localhost:8080` Tipo: matriz de strings Membros da Matriz: número mínimo de 1 item. Número máximo de 5 itens. Restrições de comprimento: tamanho mínimo de 1. Tamanho máximo de 2.048. Padrão: `(http\|https):\/\/[-a-zA-Z0-9_:.\/]+` Obrigatório: Sim |
| **starterUserEmails** | Endereços de e-mail iniciais para usuários que têm permissão para receber insights até que sejam verificados. AppClient Tipo: matriz de strings Membros da matriz: número fixo de 1 item. Restrições de tamanho: tamanho mínimo 0. Tamanho máximo de 320. Padrão: `[a-zA-Z0-9.!#$%&’*+/=?^_`{\|}~-]+@[a-zA-Z0-9-]+(?:\.[a-zA-Z0-9-]+)*` Obrigatório: Sim |
| **tags** | Um mapa dos pares de chave-valor para a tag ou tags a atribuir ao recurso. Tipo: matriz de objetos Tag Membros da Matriz: número mínimo de 0 itens. Número máximo de 50 itens. Obrigatório: não |
## Elementos de resposta
Se a ação for bem-sucedida, o serviço retornará uma resposta HTTP 201.
Os dados a seguir são retornados no formato JSON pelo serviço.
| Parâmetro | Description |
| --- | --- |
| **appClientSummary** | Contém um resumo do AppClient. Tipo: objeto [AppClientSummary](API_AppClientSummary.md) |
# DeleteAppClient
| |
| --- |
| O recurso AWS AppFabric de produtividade está em versão prévia e está sujeito a alterações. |
Exclui um cliente de aplicação.
**Topics**
+ [Corpo da solicitação](#API_DeleteAppClient_request)
+ [Elementos de resposta](#API_DeleteAppClient_response)
## Corpo da solicitação
A solicitação aceita os dados a seguir no formato JSON.
| Parâmetro | Description |
| --- | --- |
| **appClientIdentifier** | O Amazon Resource Name (ARN) ou o Universal Unique Identifier (UUID) do a AppClient ser usado para a solicitação. Restrições de Tamanho: tamanho mínimo 1. O comprimento máximo é 1011. Padrão: `arn:.+$\|^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}` Obrigatório: sim |
## Elementos de resposta
Se a ação for bem-sucedida, o serviço retornará uma resposta HTTP 204 com um corpo HTTP vazio.
# GetAppClient
| |
| --- |
| O recurso AWS AppFabric de produtividade está em versão prévia e está sujeito a alterações. |
Retorna informações sobre um AppClient.
**Topics**
+ [Corpo da solicitação](#API_GetAppClient_request)
+ [Elementos de resposta](#API_GetAppClient_response)
## Corpo da solicitação
A solicitação aceita os dados a seguir no formato JSON.
| Parâmetro | Description |
| --- | --- |
| **appClientIdentifier** | O Amazon Resource Name (ARN) ou o Universal Unique Identifier (UUID) do a AppClient ser usado para a solicitação. Restrições de Tamanho: tamanho mínimo 1. O comprimento máximo é 1011. Padrão: `arn:.+$\|^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}` Obrigatório: sim |
## Elementos de resposta
Se a ação for bem-sucedida, o serviço retornará uma resposta HTTP 200.
Os dados a seguir são retornados no formato JSON pelo serviço.
| Parâmetro | Description |
| --- | --- |
| **appClient** | Contém informações sobre um AppClient. Tipo: objeto [AppClient](API_AppClient.md) |
# ListActionableInsights
| |
| --- |
| O recurso AWS AppFabric de produtividade está em versão prévia e está sujeito a alterações. |
Lista as mensagens de email, tarefas e outras atualizações acionáveis mais importantes.
**Topics**
+ [Corpo da solicitação](#API_ListActionableInsights_request)
+ [Elementos de resposta](#API_ListActionableInsights_response)
## Corpo da solicitação
A solicitação aceita os dados a seguir no formato JSON.
| Parâmetro | Description |
| --- | --- |
| **nextToken** | Se o `nextToken` for retornado, haverá mais resultados disponíveis. O valor de `nextToken` é um token de paginação exclusivo para cada página. Faça a chamada novamente usando o token retornado para recuperar a próxima página. Mantenha todos os outros argumentos inalterados. Cada token de paginação expira após 24 horas. Usar um token de paginação expirado retornará um erro *HTTP* 400. InvalidToken |
## Elementos de resposta
Se a ação for bem-sucedida, o serviço retornará uma resposta HTTP 201.
Os dados a seguir são retornados no formato JSON pelo serviço.
| Parâmetro | Description |
| --- | --- |
| **ActionableInsightsList** | Lista as informações acionáveis, incluindo título, descrição, ações e timestamp de criação. Para obter mais informações, consulte [ActionableInsights](API_ActionableInsights.md). |
| **nextToken** | Se o `nextToken` for retornado, haverá mais resultados disponíveis. O valor de `nextToken` é um token de paginação exclusivo para cada página. Faça a chamada novamente usando o token retornado para recuperar a próxima página. Mantenha todos os outros argumentos inalterados. Cada token de paginação expira após 24 horas. Usar um token de paginação expirado retornará um erro *HTTP* 400. InvalidToken Tipo: string |
# ListAppClients
| |
| --- |
| O recurso AWS AppFabric de produtividade está em versão prévia e está sujeito a alterações. |
Retorna uma lista de todos AppClients.
**Topics**
+ [Corpo da solicitação](#API_ListAppClients_request)
+ [Elementos de resposta](#API_ListAppClients_response)
## Corpo da solicitação
A solicitação aceita os dados a seguir no formato JSON.
| Parâmetro | Description |
| --- | --- |
| **maxResults** | O número máximo de resultados a serem retornados por chamada. É possível usar `nextToken` para obter páginas de resultados adicionais. Esse é apenas um limite superior. O número real de resultados retornados por chamada pode ser menor que o máximo especificado. Faixa válida: valor mínimo de 1. Valor máximo de 100. |
| **nextToken** | Se o `nextToken` for retornado, haverá mais resultados disponíveis. O valor de `nextToken` é um token de paginação exclusivo para cada página. Faça a chamada novamente usando o token retornado para recuperar a próxima página. Mantenha todos os outros argumentos inalterados. Cada token de paginação expira após 24 horas. Usar um token de paginação expirado retornará um erro *HTTP* 400. InvalidToken |
## Elementos de resposta
Se a ação for bem-sucedida, o serviço retornará uma resposta HTTP 200.
Os dados a seguir são retornados no formato JSON pelo serviço.
| Parâmetro | Description |
| --- | --- |
| **appClientList** | Contém uma lista de AppClient resultados. Tipo: matriz de objetos [AppClientSummary](API_AppClientSummary.md) |
| **nextToken** | Se o `nextToken` for retornado, haverá mais resultados disponíveis. O valor de `nextToken` é um token de paginação exclusivo para cada página. Faça a chamada novamente usando o token retornado para recuperar a próxima página. Mantenha todos os outros argumentos inalterados. Cada token de paginação expira após 24 horas. Usar um token de paginação expirado retornará um erro *HTTP* 400. InvalidToken Tipo: string |
# ListMeetingInsights
| |
| --- |
| O recurso AWS AppFabric de produtividade está em versão prévia e está sujeito a alterações. |
Lista os eventos acionáveis mais importantes do calendário.
**Topics**
+ [Corpo da solicitação](#API_ListMeetingInsights_request)
+ [Elementos de resposta](#API_ListMeetingInsights_response)
## Corpo da solicitação
A solicitação aceita os dados a seguir no formato JSON.
| Parâmetro | Description |
| --- | --- |
| **nextToken** | Se o `nextToken` for retornado, haverá mais resultados disponíveis. O valor de `nextToken` é um token de paginação exclusivo para cada página. Faça a chamada novamente usando o token retornado para recuperar a próxima página. Mantenha todos os outros argumentos inalterados. Cada token de paginação expira após 24 horas. Usar um token de paginação expirado retornará um erro *HTTP* 400. InvalidToken |
## Elementos de resposta
Se a ação for bem-sucedida, o serviço retornará uma resposta HTTP 201.
Os dados a seguir são retornados no formato JSON pelo serviço.
| Parâmetro | Description |
| --- | --- |
| **MeetingInsightList** | Lista as informações acionáveis da reunião. Para obter mais informações, consulte [MeetingInsights](API_MeetingInsights.md). |
| **nextToken** | Se o `nextToken` for retornado, haverá mais resultados disponíveis. O valor de `nextToken` é um token de paginação exclusivo para cada página. Faça a chamada novamente usando o token retornado para recuperar a próxima página. Mantenha todos os outros argumentos inalterados. Cada token de paginação expira após 24 horas. Usar um token de paginação expirado retornará um erro *HTTP* 400. InvalidToken Tipo: string |
# PutFeedback
| |
| --- |
| O recurso AWS AppFabric de produtividade está em versão prévia e está sujeito a alterações. |
Permite que os usuários enviem comentários sobre determinada informação ou ação.
**Topics**
+ [Corpo da solicitação](#API_PutFeedback_request)
+ [Elementos de resposta](#API_PutFeedback_response)
## Corpo da solicitação
A solicitação aceita os dados a seguir no formato JSON.
| Parâmetro | Description |
| --- | --- |
| **id** | O ID do objeto para o qual o comentário está sendo enviado. Isso pode ser o InsightId ou ActionId o. |
| **feedbackFor** | O tipo de informação para o qual o comentário está sendo enviado. Valores possíveis: `ACTIONABLE_INSIGHT \| MEETING_INSIGHT \| ACTION` |
| **feedbackRating** | Classificação do comentário de `1` a `5`. Quanto maior a classificação, melhor. |
## Elementos de resposta
Se a ação tiver êxito, o serviço enviará de volta uma resposta HTTP 201 com um corpo HTTP vazio.
# Token
| |
| --- |
| O recurso AWS AppFabric de produtividade está em versão prévia e está sujeito a alterações. |
Contém informações que permitem AppClients trocar um código de autorização por um token de acesso.
**Topics**
+ [Corpo da solicitação](#API_Token_request)
+ [Elementos de resposta](#API_Token_response)
## Corpo da solicitação
A solicitação aceita os dados a seguir no formato JSON.
| Parâmetro | Description |
| --- | --- |
| **Código ** | O código de autorização recebido do endpoint de autorização. Tipo: string Restrições de tamanho: tamanho mínimo 1. O comprimento máximo é 2.048. Obrigatório: não |
| **grant\$1type** | O tipo de concessão do token. Deve ser `authorization_code` ou `refresh_token`. Tipo: String Obrigatório: Sim |
| **app\$1client\$1id** | O ID da AppClient. Tipo: sequência Padrão: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}` Obrigatório: Sim |
| **redirect\$1uri** | A URI de redirecionamento passada para o endpoint de autorização. Tipo: string Obrigatório: não |
| **refresh\$1token** | O token de atualização recebido da solicitação inicial do token. Tipo: string Restrições de comprimento: tamanho mínimo de 1. O tamanho máximo é 4.096. Obrigatório: não |
## Elementos de resposta
Se a ação for bem-sucedida, o serviço retornará uma resposta HTTP 200.
Os dados a seguir são retornados no formato JSON pelo serviço.
| Parâmetro | Description |
| --- | --- |
| **appfabric\$1user\$1id** | O ID do usuário para o token. Isso é retornado somente para solicitações que usem o tipo de concessão `authorization_code`. Tipo: string |
| **expires\$1in** | O número de segundos até a expiração do token. Tipo: longo |
| **refresh\$1token** | O token de atualização a ser usado em uma solicitação subsequente. Tipo: string Restrições de tamanho: tamanho mínimo 1. O comprimento máximo é 2.048. |
| **token** | O token de acesso. Tipo: string Restrições de tamanho: tamanho mínimo 1. O comprimento máximo é 2.048. |
| **token\$1type** | O tipo de token. Tipo: string |
# UpdateAppClient
| |
| --- |
| O recurso AWS AppFabric de produtividade está em versão prévia e está sujeito a alterações. |
Atualiza um AppClient.
**Topics**
+ [Corpo da solicitação](#API_UpdateAppClient_request)
+ [Elementos de resposta](#API_UpdateAppClient_response)
## Corpo da solicitação
A solicitação aceita os dados a seguir no formato JSON.
| Parâmetro | Description |
| --- | --- |
| **appClientIdentifier** | O Amazon Resource Name (ARN) ou o Universal Unique Identifier (UUID) do a AppClient ser usado para a solicitação. Restrições de Tamanho: tamanho mínimo 1. O comprimento máximo é 1011. Padrão: `arn:.+$\|^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}` Obrigatório: Sim |
| **redirectUrls** | O URI para o qual redirecionar os usuários finais após a autorização. É possível adicionar até 5 redirectUrls. Por exemplo, .`https://localhost:8080` Tipo: matriz de strings Membros da Matriz: número mínimo de 1 item. Número máximo de 5 itens. Restrições de comprimento: tamanho mínimo de 1. Tamanho máximo de 2.048. Padrão: `(http\|https):\/\/[-a-zA-Z0-9_:.\/]+` |
## Elementos de resposta
Se a ação for bem-sucedida, o serviço retornará uma resposta HTTP 200.
Os dados a seguir são retornados no formato JSON pelo serviço.
| Parâmetro | Description |
| --- | --- |
| **appClient** | Contém informações sobre um AppClient. Tipo: objeto [AppClient](API_AppClient.md) |