

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.

# UpdateDashboard
<a name="API_UpdateDashboard"></a>

Met à jour un tableau de bord dansAWS.

**Note**  
La mise à jour d'un tableau de bord crée une nouvelle version du tableau de bord mais ne publie pas immédiatement la nouvelle version. Vous pouvez mettre à jour la version publiée d'un tableau de bord en utilisant la` [UpdateDashboardPublishedVersion](https://docs.aws.amazon.com/quicksight/latest/APIReference/API_UpdateDashboardPublishedVersion.html) `Opération d'API.

## Syntaxe de la demande
<a name="API_UpdateDashboard_RequestSyntax"></a>

```
PUT /accounts/AwsAccountId/dashboards/DashboardId HTTP/1.1
Content-type: application/json

{
   "DashboardPublishOptions": { 
      "AdHocFilteringOption": { 
         "AvailabilityStatus": "string"
      },
      "ExportToCSVOption": { 
         "AvailabilityStatus": "string"
      },
      "SheetControlsOption": { 
         "VisibilityState": "string"
      }
   },
   "Name": "string",
   "Parameters": { 
      "DateTimeParameters": [ 
         { 
            "Name": "string",
            "Values": [ number ]
         }
      ],
      "DecimalParameters": [ 
         { 
            "Name": "string",
            "Values": [ number ]
         }
      ],
      "IntegerParameters": [ 
         { 
            "Name": "string",
            "Values": [ number ]
         }
      ],
      "StringParameters": [ 
         { 
            "Name": "string",
            "Values": [ "string" ]
         }
      ]
   },
   "SourceEntity": { 
      "SourceTemplate": { 
         "Arn": "string",
         "DataSetReferences": [ 
            { 
               "DataSetArn": "string",
               "DataSetPlaceholder": "string"
            }
         ]
      }
   },
   "ThemeArn": "string",
   "VersionDescription": "string"
}
```

## Paramètres de demande URI
<a name="API_UpdateDashboard_RequestParameters"></a>

La demande utilise les paramètres URI suivants.

 ** [AwsAccountId](#API_UpdateDashboard_RequestSyntax) **   <a name="QS-UpdateDashboard-request-AwsAccountId"></a>
ID duAWSqui contient le tableau de bord que vous mettez à jour.  
Contraintes : Longueur fixe de 12.  
Modèle : `^[0-9]{12}$`   
Obligatoire : Oui

 ** [DashboardId](#API_UpdateDashboard_RequestSyntax) **   <a name="QS-UpdateDashboard-request-DashboardId"></a>
ID pour le tableau de bord.  
Contraintes : Longueur minimale de 1. Longueur maximale de 2048.  
Modèle : `[\w\-]+`   
Obligatoire : Oui

## Corps de la demande
<a name="API_UpdateDashboard_RequestBody"></a>

Cette demande accepte les données suivantes au format JSON.

 ** [Name](#API_UpdateDashboard_RequestSyntax) **   <a name="QS-UpdateDashboard-request-Name"></a>
Nom d'affichage du tableau de bord.  
Type : Chaîne  
Contraintes : Longueur minimale de 1. Longueur maximale de 2048.  
Obligatoire : Oui

 ** [SourceEntity](#API_UpdateDashboard_RequestSyntax) **   <a name="QS-UpdateDashboard-request-SourceEntity"></a>
Entité que vous utilisez comme source lorsque vous mettez à jour le tableau de bord. Dans`SourceEntity`, vous spécifiez le type d'objet que vous utilisez comme source. Vous ne pouvez mettre à jour un tableau de bord qu'à partir d'un modèle. Vous pouvez donc utiliser un`SourceTemplate`Entité. Si vous avez besoin de mettre à jour un tableau de bord à partir d'une analyse, convertissez d'abord l'analyse en modèle à l'aide du` [CreateTemplate](https://docs.aws.amazon.com/quicksight/latest/APIReference/API_CreateTemplate.html) `Opération d'API. Pour`SourceTemplate`, spécifiez l'ARN (Amazon Resource Name) du modèle source. Le`SourceTemplate`L'ARN peut contenir n'importe quelAWScompte et n'importe quel compte Amazon QuickSight-pris en chargeRégion AWS.   
Utilisation de l'`DataSetReferences`entité au sein`SourceTemplate`pour répertorier les jeux de données de remplacement pour les espaces réservés répertoriés dans l'original. Le schéma de chaque jeu de données doit correspondre à son espace réservé.   
Type : objet [DashboardSourceEntity](API_DashboardSourceEntity.md)  
Obligatoire : Oui

 ** [DashboardPublishOptions](#API_UpdateDashboard_RequestSyntax) **   <a name="QS-UpdateDashboard-request-DashboardPublishOptions"></a>
Options de publication du tableau de bord lors de sa création :  
+  `AvailabilityStatus`pour`AdHocFilteringOption`- Ce statut peut être l'un ou l'autre`ENABLED`ou`DISABLED`. Lorsque cela est défini sur`DISABLED`, Amazon QuickSight désactive le volet de filtre de gauche sur le tableau de bord publié, qui peut être utilisé pour le filtrage ad hoc (ponctuel). Cette option est`ENABLED`par défaut. 
+  `AvailabilityStatus`pour`ExportToCSVOption`- Ce statut peut être l'un ou l'autre`ENABLED`ou`DISABLED`. L'option visuelle permettant d'exporter des données au format .CSV n'est pas activée lorsque cette option est définie sur`DISABLED`. Cette option est`ENABLED`par défaut. 
+  `VisibilityState`pour`SheetControlsOption`- Cet état de visibilité peut être soit`COLLAPSED`ou`EXPANDED`. Cette option est`COLLAPSED`par défaut. 
Type : objet [DashboardPublishOptions](API_DashboardPublishOptions.md)  
Obligatoire : Non

 ** [Parameters](#API_UpdateDashboard_RequestSyntax) **   <a name="QS-UpdateDashboard-request-Parameters"></a>
Structure contenant les paramètres du tableau de bord. Il s'agit de remplacements de paramètres pour un tableau de bord. Un tableau de bord peut comporter n'importe quel type de paramètres, et certains paramètres peuvent accepter plusieurs valeurs.  
Type : objet [Parameters](API_Parameters.md)  
Obligatoire : Non

 ** [ThemeArn](#API_UpdateDashboard_RequestSyntax) **   <a name="QS-UpdateDashboard-request-ThemeArn"></a>
Amazon Resource Name (ARN) du thème utilisé pour ce tableau de bord. Si vous ajoutez une valeur pour ce champ, elle remplace la valeur initialement associée à l'entité. L'ARN du thème doit exister dans le même.AWScompte sur lequel vous créez le tableau de bord.  
Type : Chaîne  
Obligatoire : Non

 ** [VersionDescription](#API_UpdateDashboard_RequestSyntax) **   <a name="QS-UpdateDashboard-request-VersionDescription"></a>
Une description pour la première version du tableau de bord en cours de création.  
Type : Chaîne  
Contraintes : Longueur minimale de 1. Longueur maximale de 512.  
Obligatoire : Non

## Syntaxe de la réponse
<a name="API_UpdateDashboard_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "Arn": "string",
   "CreationStatus": "string",
   "DashboardId": "string",
   "RequestId": "string",
   "Status": number,
   "VersionArn": "string"
}
```

## Eléments de réponse
<a name="API_UpdateDashboard_ResponseElements"></a>

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.

 ** [Arn](#API_UpdateDashboard_ResponseSyntax) **   <a name="QS-UpdateDashboard-response-Arn"></a>
ARN (Amazon Resource Name) de la ressource.  
Type : Chaîne

 ** [CreationStatus](#API_UpdateDashboard_ResponseSyntax) **   <a name="QS-UpdateDashboard-response-CreationStatus"></a>
Le statut d'une demande.  
Type : Chaîne  
Valeurs valides :` CREATION_IN_PROGRESS | CREATION_SUCCESSFUL | CREATION_FAILED | UPDATE_IN_PROGRESS | UPDATE_SUCCESSFUL | UPDATE_FAILED | DELETED` 

 ** [DashboardId](#API_UpdateDashboard_ResponseSyntax) **   <a name="QS-UpdateDashboard-response-DashboardId"></a>
ID pour le tableau de bord.  
Type : Chaîne  
Contraintes : Longueur minimale de 1. Longueur maximale de 2048.  
Modèle : `[\w\-]+` 

 ** [RequestId](#API_UpdateDashboard_ResponseSyntax) **   <a name="QS-UpdateDashboard-response-RequestId"></a>
LeAWSID de demande pour cette opération.  
Type : Chaîne

 ** [Status](#API_UpdateDashboard_ResponseSyntax) **   <a name="QS-UpdateDashboard-response-Status"></a>
Le statut HTTP de la requête.  
Type : Entier

 ** [VersionArn](#API_UpdateDashboard_ResponseSyntax) **   <a name="QS-UpdateDashboard-response-VersionArn"></a>
L'ARN du tableau de bord, y compris le numéro de version.  
Type : Chaîne

## Erreurs
<a name="API_UpdateDashboard_Errors"></a>

Pour plus d'informations sur les erreurs communes à toutes les actions, consultez[Erreurs courantes](CommonErrors.md).

 ** ConflictException **   
La mise à jour ou la suppression d'une ressource peut entraîner un état incohérent.  
HTTP Status Code : 409

 ** InternalFailureException **   
Une défaillance interne s'est produite.  
HTTP Status Code : 500

 ** InvalidParameterValueException **   
La valeur d'un ou de plusieurs paramètres n'est pas valide.  
HTTP Status Code : 400

 ** LimitExceededException **   
Une limite est dépassée.  
HTTP Status Code : 409

 ** ResourceNotFoundException **   
Une ou plusieurs ressources n'ont pas pu être trouvées.  
HTTP Status Code : 404

 ** ThrottlingException **   
L'accès est limité.  
HTTP Status Code : 429

 ** UnsupportedUserEditionException **   
Cette erreur indique que vous appelez une opération portant sur Amazon QuickSightabonnement dont l'édition n'inclut pas la prise en charge de cette opération. Amazon Amazon QuickSight possède actuellement Standard Edition et Enterprise Edition. Toutes les opérations et fonctionnalités ne sont pas disponibles dans chaque édition.  
HTTP Status Code : 403

## Voir aussi
<a name="API_UpdateDashboard_SeeAlso"></a>

Pour plus d'informations sur l'utilisation de cette API dans l'un des kits SDK AWS spécifiques au langage, consultez les ressources suivantes :
+  [Interface de ligne de commande AWS](https://docs.aws.amazon.com/goto/aws-cli/quicksight-2018-04-01/UpdateDashboard) 
+  [AWS SDK pour .NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/quicksight-2018-04-01/UpdateDashboard) 
+  [Kit AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/quicksight-2018-04-01/UpdateDashboard) 
+  [Kit AWS SDK pour Go](https://docs.aws.amazon.com/goto/SdkForGoV1/quicksight-2018-04-01/UpdateDashboard) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/quicksight-2018-04-01/UpdateDashboard) 
+  [AWSKits SDK pour JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/quicksight-2018-04-01/UpdateDashboard) 
+  [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/quicksight-2018-04-01/UpdateDashboard) 
+  [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/quicksight-2018-04-01/UpdateDashboard) 
+  [Kit SDK AWS pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/quicksight-2018-04-01/UpdateDashboard) 