Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.
# Actions d'API AppFabric pour améliorer la productivité (version préliminaire)
| |
| --- |
| La fonctionnalité AWS AppFabric de productivité est en cours d'aperçu et est sujette à modification. |
Les actions suivantes sont prises en charge AppFabric pour les fonctionnalités de productivité.
Pour toutes les autres actions d' AppFabric API, consultez les [actions AWS AppFabric d'API](https://docs.aws.amazon.com/appfabric/latest/api/API_Operations.html).
**Topics**
+ [Autoriser](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)
+ [Jeton](API_Token.md)
+ [UpdateAppClient](API_UpdateAppClient.md)
# Autoriser
| |
| --- |
| La fonctionnalité AWS AppFabric de productivité est en cours d'aperçu et est sujette à modification. |
Autorise un AppClient.
**Topics**
+ [Corps de la demande](#API_Authorize_request)
## Corps de la demande
Cette demande accepte les données suivantes au format JSON.
| Paramètre | Description |
| --- | --- |
| **ID du client de l'application** | L'ID du AppClient à autoriser. |
| **redirect\$1uri** | L'URI vers lequel rediriger les utilisateurs finaux après autorisation. |
| **state** | Une valeur unique pour maintenir l'état entre la demande et le rappel. |
# CreateAppClient
| |
| --- |
| La fonctionnalité AWS AppFabric de productivité est en cours d'aperçu et est sujette à modification. |
Crée un AppClient.
**Topics**
+ [Corps de la demande](#API_CreateAppClient_request)
+ [Éléments de réponse](#API_CreateAppClient_response)
## Corps de la demande
Cette demande accepte les données suivantes au format JSON.
| Paramètre | Description |
| --- | --- |
| **Nom de l'application** | Nom de l'application. Type : Chaîne Contraintes de longueur : longueur minimum de 1. Longueur maximale de 255 caractères. Obligatoire : oui |
| **ClientToken** | Spécifie un identifiant unique distinguant majuscules et minuscules que vous fournissez pour garantir l'idempuissance de la demande. Cela vous permet de réessayer la demande en toute sécurité sans effectuer accidentellement la même opération une deuxième fois. Pour transmettre la même valeur à un appel ultérieur à une opération, vous devez également transmettre la même valeur pour tous les autres paramètres. Nous vous recommandons d'utiliser une valeur de [type UUID](https://wikipedia.org/wiki/Universally_unique_identifier). Si vous ne fournissez pas cette valeur, il en AWS génère une au hasard pour vous. Si vous réessayez l'opération avec les mêmes paramètres`ClientToken`, mais avec des paramètres différents, la nouvelle tentative échoue avec une `IdempotentParameterMismatch` erreur. Type : Chaîne Modèle : `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}` Obligatoire : non |
| **customerManagedKeyIdentifiant** | L'ARN du clé gérée par le client produit généré par AWS Key Management Service. La clé est utilisée pour chiffrer les données. Si aucune clé n'est spécifiée, une Clé gérée par AWS est utilisée. Carte des paires clé-valeur de la balise ou des balises à attribuer à la ressource. Pour plus d'informations sur Clés détenues par AWS les clés gérées par le client, consultez la section [Clés et AWS clés client](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-mgmt) dans le *guide du AWS Key Management Service développeur*. Type : Chaîne Contraintes de longueur : longueur minimum de 1. Longueur maximale de 1011. Modèle : `arn:.+$\|^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}` Obligatoire : non |
| **description** | Description de l'application. Type : Chaîne Obligatoire : oui |
| **URL de l'icône** | URL de l'icône ou du logo du AppClient. Type : chaîne Obligatoire : non |
| **URL de redirection** | L'URI vers lequel rediriger les utilisateurs finaux après autorisation. Vous pouvez ajouter jusqu'à 5 URL de redirection. Par exemple, `https://localhost:8080`. Type : tableau de chaînes Membres du tableau : Nombre minimum de 1 élément. Nombre maximum de 5 éléments. Contraintes de longueur : longueur minimale de 1 caractère. Longueur maximale de 2048. Modèle : `(http\|https):\/\/[-a-zA-Z0-9_:.\/]+` Obligatoire : oui |
| **starterUserEmails** | Adresses e-mail de démarrage pour les utilisateurs autorisés à recevoir des informations jusqu'à ce qu'elles soient vérifiées. AppClient Type : tableau de chaînes Membres du tableau : nombre fixe de 1 élément. Contraintes de longueur : longueur minimale de 0. Longueur maximale de 320 Modèle : `[a-zA-Z0-9.!#$%&’*+/=?^_`{\|}~-]+@[a-zA-Z0-9-]+(?:\.[a-zA-Z0-9-]+)*` Obligatoire : oui |
| **tags** | Carte des paires clé-valeur de la balise ou des balises à attribuer à la ressource. Type : Tableau d'objets Tag Membres du tableau : nombre minimum de 0 élément. Nombre maximal de 50 éléments. Obligatoire : non |
## Éléments de réponse
Si l’action aboutit, le service renvoie une réponse HTTP 201.
Les données suivantes sont renvoyées au format JSON par le service.
| Paramètre | Description |
| --- | --- |
| **appClientSummary** | Contient un résumé du AppClient. Type : objet [AppClientSummary](API_AppClientSummary.md) |
# DeleteAppClient
| |
| --- |
| La fonctionnalité AWS AppFabric de productivité est en cours d'aperçu et est sujette à modification. |
Supprime un client d'application.
**Topics**
+ [Corps de la demande](#API_DeleteAppClient_request)
+ [Éléments de réponse](#API_DeleteAppClient_response)
## Corps de la demande
Cette demande accepte les données suivantes au format JSON.
| Paramètre | Description |
| --- | --- |
| **appClientIdentifier** | Le nom de ressource Amazon (ARN) ou l'identifiant unique universel (UUID) AppClient à utiliser pour la demande. Contraintes de longueur : longueur minimale de 1 caractère. Longueur maximale de 1011. Modèle : `arn:.+$\|^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}` Obligatoire : oui |
## Éléments de réponse
Si l’action aboutit, le service renvoie une réponse HTTP 204 avec un corps HTTP vide.
# GetAppClient
| |
| --- |
| La fonctionnalité AWS AppFabric de productivité est en cours d'aperçu et est sujette à modification. |
Renvoie des informations sur un AppClient.
**Topics**
+ [Corps de la demande](#API_GetAppClient_request)
+ [Éléments de réponse](#API_GetAppClient_response)
## Corps de la demande
Cette demande accepte les données suivantes au format JSON.
| Paramètre | Description |
| --- | --- |
| **appClientIdentifier** | Le nom de ressource Amazon (ARN) ou l'identifiant unique universel (UUID) AppClient à utiliser pour la demande. Contraintes de longueur : longueur minimale de 1 caractère. Longueur maximale de 1011. Modèle : `arn:.+$\|^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}` Obligatoire : oui |
## Éléments de réponse
Si l’action aboutit, le service renvoie une réponse HTTP 200.
Les données suivantes sont renvoyées au format JSON par le service.
| Paramètre | Description |
| --- | --- |
| **Client de l'application** | Contient des informations sur un AppClient. Type : objet [AppClient](API_AppClient.md) |
# ListActionableInsights
| |
| --- |
| La fonctionnalité AWS AppFabric de productivité est en cours d'aperçu et est sujette à modification. |
Répertorie les messages électroniques, les tâches et les autres mises à jour exploitables les plus importants.
**Topics**
+ [Corps de la demande](#API_ListActionableInsights_request)
+ [Éléments de réponse](#API_ListActionableInsights_response)
## Corps de la demande
Cette demande accepte les données suivantes au format JSON.
| Paramètre | Description |
| --- | --- |
| **nextToken** | S'il `nextToken` est renvoyé, d'autres résultats sont disponibles. La valeur de `nextToken` est un jeton de pagination unique pour chaque page. Effectuez l'appel à nouveau en utilisant le jeton renvoyé pour récupérer la page suivante. Gardez tous les autres arguments inchangés. Chaque jeton de pagination expire au bout de 24 heures. L'utilisation d'un jeton de pagination expiré renverra une * InvalidToken erreur HTTP 400*. |
## Éléments de réponse
Si l’action aboutit, le service renvoie une réponse HTTP 201.
Les données suivantes sont renvoyées au format JSON par le service.
| Paramètre | Description |
| --- | --- |
| **ActionableInsightsList** | Répertorie les informations exploitables, y compris le titre, la description, les actions et l'horodatage créé. Pour de plus amples informations, veuillez consulter [ActionableInsights](API_ActionableInsights.md). |
| **nextToken** | S'il `nextToken` est renvoyé, d'autres résultats sont disponibles. La valeur de `nextToken` est un jeton de pagination unique pour chaque page. Effectuez l'appel à nouveau en utilisant le jeton renvoyé pour récupérer la page suivante. Gardez tous les autres arguments inchangés. Chaque jeton de pagination expire au bout de 24 heures. L'utilisation d'un jeton de pagination expiré renverra une * InvalidToken erreur HTTP 400*. Type : Chaîne |
# ListAppClients
| |
| --- |
| La fonctionnalité AWS AppFabric de productivité est en cours d'aperçu et est sujette à modification. |
Renvoie une liste de tous les éléments AppClients.
**Topics**
+ [Corps de la demande](#API_ListAppClients_request)
+ [Éléments de réponse](#API_ListAppClients_response)
## Corps de la demande
Cette demande accepte les données suivantes au format JSON.
| Paramètre | Description |
| --- | --- |
| **maxResults** | Le nombre maximum de résultats renvoyés par appel. Vous pouvez l'utiliser `nextToken` pour obtenir d'autres pages de résultats. Il ne s'agit que d'une limite supérieure. Le nombre réel de résultats renvoyés par appel peut être inférieur au maximum spécifié. Plage valide : valeur minimum de 1. Valeur maximale fixée à 100. |
| **nextToken** | S'il `nextToken` est renvoyé, d'autres résultats sont disponibles. La valeur de `nextToken` est un jeton de pagination unique pour chaque page. Effectuez l'appel à nouveau en utilisant le jeton renvoyé pour récupérer la page suivante. Gardez tous les autres arguments inchangés. Chaque jeton de pagination expire au bout de 24 heures. L'utilisation d'un jeton de pagination expiré renverra une * InvalidToken erreur HTTP 400*. |
## Éléments de réponse
Si l’action aboutit, le service renvoie une réponse HTTP 200.
Les données suivantes sont renvoyées au format JSON par le service.
| Paramètre | Description |
| --- | --- |
| **appClientList** | Contient une liste de AppClient résultats. Type : tableau d’objets [AppClientSummary](API_AppClientSummary.md) |
| **nextToken** | S'il `nextToken` est renvoyé, d'autres résultats sont disponibles. La valeur de `nextToken` est un jeton de pagination unique pour chaque page. Effectuez l'appel à nouveau en utilisant le jeton renvoyé pour récupérer la page suivante. Gardez tous les autres arguments inchangés. Chaque jeton de pagination expire au bout de 24 heures. L'utilisation d'un jeton de pagination expiré renverra une * InvalidToken erreur HTTP 400*. Type : Chaîne |
# ListMeetingInsights
| |
| --- |
| La fonctionnalité AWS AppFabric de productivité est en cours d'aperçu et est sujette à modification. |
Répertorie les événements du calendrier actionnables les plus importants.
**Topics**
+ [Corps de la demande](#API_ListMeetingInsights_request)
+ [Éléments de réponse](#API_ListMeetingInsights_response)
## Corps de la demande
Cette demande accepte les données suivantes au format JSON.
| Paramètre | Description |
| --- | --- |
| **nextToken** | S'il `nextToken` est renvoyé, d'autres résultats sont disponibles. La valeur de `nextToken` est un jeton de pagination unique pour chaque page. Effectuez l'appel à nouveau en utilisant le jeton renvoyé pour récupérer la page suivante. Gardez tous les autres arguments inchangés. Chaque jeton de pagination expire au bout de 24 heures. L'utilisation d'un jeton de pagination expiré renverra une * InvalidToken erreur HTTP 400*. |
## Éléments de réponse
Si l’action aboutit, le service renvoie une réponse HTTP 201.
Les données suivantes sont renvoyées au format JSON par le service.
| Paramètre | Description |
| --- | --- |
| **MeetingInsightList** | Répertorie les informations exploitables sur les réunions. Pour de plus amples informations, veuillez consulter [MeetingInsights](API_MeetingInsights.md). |
| **nextToken** | S'il `nextToken` est renvoyé, d'autres résultats sont disponibles. La valeur de `nextToken` est un jeton de pagination unique pour chaque page. Effectuez l'appel à nouveau en utilisant le jeton renvoyé pour récupérer la page suivante. Gardez tous les autres arguments inchangés. Chaque jeton de pagination expire au bout de 24 heures. L'utilisation d'un jeton de pagination expiré renverra une * InvalidToken erreur HTTP 400*. Type : Chaîne |
# PutFeedback
| |
| --- |
| La fonctionnalité AWS AppFabric de productivité est en cours d'aperçu et est sujette à modification. |
Permet aux utilisateurs de soumettre des commentaires pour une idée ou une action donnée.
**Topics**
+ [Corps de la demande](#API_PutFeedback_request)
+ [Éléments de réponse](#API_PutFeedback_response)
## Corps de la demande
Cette demande accepte les données suivantes au format JSON.
| Paramètre | Description |
| --- | --- |
| **id** | ID de l'objet pour lequel le commentaire est envoyé. Cela peut être le InsightId ou le ActionId. |
| **Feedback pour** | Type d'aperçu pour lequel le commentaire est soumis. Valeurs possibles : `ACTIONABLE_INSIGHT \| MEETING_INSIGHT \| ACTION` |
| **Évaluation des commentaires** | Évaluation des commentaires de `1` à`5`. Plus la note est élevée, mieux c'est. |
## Éléments de réponse
Si l'action aboutit, le service renvoie une réponse HTTP 201 avec un corps HTTP vide.
# Jeton
| |
| --- |
| La fonctionnalité AWS AppFabric de productivité est en cours d'aperçu et est sujette à modification. |
Contient des informations permettant d' AppClients échanger un code d'autorisation contre un jeton d'accès.
**Topics**
+ [Corps de la demande](#API_Token_request)
+ [Éléments de réponse](#API_Token_response)
## Corps de la demande
Cette demande accepte les données suivantes au format JSON.
| Paramètre | Description |
| --- | --- |
| **code** | Le code d'autorisation reçu du point de terminaison d'autorisation. Type : Chaîne Contraintes de longueur : longueur minimum de 1. Longueur maximale de 2048. Obligatoire : non |
| **type de subvention** | Type de subvention pour le jeton. Doit être `authorization_code` ou `refresh_token`. Type : Chaîne Obligatoire : oui |
| **ID du client de l'application** | ID du AppClient. Type : Chaîne Modèle : `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}` Obligatoire : oui |
| **redirect\$1uri** | L'URI de redirection transmis au point de terminaison d'autorisation. Type : chaîne Obligatoire : non |
| **jeton de rafraîchissement** | Le jeton d'actualisation reçu suite à la demande de jeton initiale. Type : Chaîne Contraintes de longueur : longueur minimum de 1. Longueur maximum de 4096. Obligatoire : non |
## Éléments de réponse
Si l’action aboutit, le service renvoie une réponse HTTP 200.
Les données suivantes sont renvoyées au format JSON par le service.
| Paramètre | Description |
| --- | --- |
| **ID utilisateur d'appfabric\$1** | L'ID de l'utilisateur pour le jeton. Ceci n'est renvoyé que pour les demandes utilisant le type de `authorization_code` subvention. Type : Chaîne |
| **expirer\$1in** | Le nombre de secondes avant l'expiration du jeton. Type : Long |
| **jeton de rafraîchissement** | Le jeton d'actualisation à utiliser pour une demande ultérieure. Type : Chaîne Contraintes de longueur : longueur minimum de 1. Longueur maximale de 2048. |
| ****token | Le jeton d'accès. Type : Chaîne Contraintes de longueur : longueur minimum de 1. Longueur maximale de 2048. |
| **type\$1jeton** | Le type de jeton. Type : Chaîne |
# UpdateAppClient
| |
| --- |
| La fonctionnalité AWS AppFabric de productivité est en cours d'aperçu et est sujette à modification. |
Met à jour un AppClient.
**Topics**
+ [Corps de la demande](#API_UpdateAppClient_request)
+ [Éléments de réponse](#API_UpdateAppClient_response)
## Corps de la demande
Cette demande accepte les données suivantes au format JSON.
| Paramètre | Description |
| --- | --- |
| **appClientIdentifier** | Le nom de ressource Amazon (ARN) ou l'identifiant unique universel (UUID) AppClient à utiliser pour la demande. Contraintes de longueur : longueur minimale de 1 caractère. Longueur maximale de 1011. Modèle : `arn:.+$\|^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}` Obligatoire : oui |
| **URL de redirection** | L'URI vers lequel rediriger les utilisateurs finaux après autorisation. Vous pouvez ajouter jusqu'à 5 URL de redirection. Par exemple, `https://localhost:8080`. Type : tableau de chaînes Membres du tableau : Nombre minimum de 1 élément. Nombre maximum de 5 éléments. Contraintes de longueur : longueur minimale de 1 caractère. Longueur maximale de 2048. Modèle : `(http\|https):\/\/[-a-zA-Z0-9_:.\/]+` |
## Éléments de réponse
Si l’action aboutit, le service renvoie une réponse HTTP 200.
Les données suivantes sont renvoyées au format JSON par le service.
| Paramètre | Description |
| --- | --- |
| **Client de l'application** | Contient des informations sur un AppClient. Type : objet [AppClient](API_AppClient.md) |