UpdateDataSet - Amazon QuickSight
Syntaxe de la demandeParamètres de demande URICorps de la demandeSyntaxe de la réponseEléments de réponseErreursExemplesVoir aussi

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.

UpdateDataSet

Met un ensemble de données. Cette opération ne prend pas en charge les jeux de données qui incluent des fichiers téléchargés en tant que source.

Syntaxe de la demande

PUT /accounts/AwsAccountId/data-sets/DataSetId HTTP/1.1
Content-type: application/json

{
   "ColumnGroups": [ 
      { 
         "GeoSpatialColumnGroup": { 
            "Columns": [ "string" ],
            "CountryCode": "string",
            "Name": "string"
         }
      }
   ],
   "ColumnLevelPermissionRules": [ 
      { 
         "ColumnNames": [ "string" ],
         "Principals": [ "string" ]
      }
   ],
   "DataSetUsageConfiguration": { 
      "DisableUseAsDirectQuerySource": boolean,
      "DisableUseAsImportedSource": boolean
   },
   "FieldFolders": { 
      "string" : { 
         "columns": [ "string" ],
         "description": "string"
      }
   },
   "ImportMode": "string",
   "LogicalTableMap": { 
      "string" : { 
         "Alias": "string",
         "DataTransforms": [ 
            { 
               "CastColumnTypeOperation": { 
                  "ColumnName": "string",
                  "Format": "string",
                  "NewColumnType": "string"
               },
               "CreateColumnsOperation": { 
                  "Columns": [ 
                     { 
                        "ColumnId": "string",
                        "ColumnName": "string",
                        "Expression": "string"
                     }
                  ]
               },
               "FilterOperation": { 
                  "ConditionExpression": "string"
               },
               "ProjectOperation": { 
                  "ProjectedColumns": [ "string" ]
               },
               "RenameColumnOperation": { 
                  "ColumnName": "string",
                  "NewColumnName": "string"
               },
               "TagColumnOperation": { 
                  "ColumnName": "string",
                  "Tags": [ 
                     { 
                        "ColumnDescription": { 
                           "Text": "string"
                        },
                        "ColumnGeographicRole": "string"
                     }
                  ]
               },
               "UntagColumnOperation": { 
                  "ColumnName": "string",
                  "TagNames": [ "string" ]
               }
            }
         ],
         "Source": { 
            "DataSetArn": "string",
            "JoinInstruction": { 
               "LeftJoinKeyProperties": { 
                  "UniqueKey": boolean
               },
               "LeftOperand": "string",
               "OnClause": "string",
               "RightJoinKeyProperties": { 
                  "UniqueKey": boolean
               },
               "RightOperand": "string",
               "Type": "string"
            },
            "PhysicalTableId": "string"
         }
      }
   },
   "Name": "string",
   "PhysicalTableMap": { 
      "string" : { 
         "CustomSql": { 
            "Columns": [ 
               { 
                  "Name": "string",
                  "Type": "string"
               }
            ],
            "DataSourceArn": "string",
            "Name": "string",
            "SqlQuery": "string"
         },
         "RelationalTable": { 
            "Catalog": "string",
            "DataSourceArn": "string",
            "InputColumns": [ 
               { 
                  "Name": "string",
                  "Type": "string"
               }
            ],
            "Name": "string",
            "Schema": "string"
         },
         "S3Source": { 
            "DataSourceArn": "string",
            "InputColumns": [ 
               { 
                  "Name": "string",
                  "Type": "string"
               }
            ],
            "UploadSettings": { 
               "ContainsHeader": boolean,
               "Delimiter": "string",
               "Format": "string",
               "StartFromRow": number,
               "TextQualifier": "string"
            }
         }
      }
   },
   "RowLevelPermissionDataSet": { 
      "Arn": "string",
      "FormatVersion": "string",
      "Namespace": "string",
      "PermissionPolicy": "string",
      "Status": "string"
   },
   "RowLevelPermissionTagConfiguration": { 
      "Status": "string",
      "TagRules": [ 
         { 
            "ColumnName": "string",
            "MatchAllValue": "string",
            "TagKey": "string",
            "TagMultiValueDelimiter": "string"
         }
      ]
   }
}

Paramètres de demande URI

La demande utilise les paramètres URI suivants.

AwsAccountId

L'ID de compte AWS.

Contraintes de longueur : Longueur fixe de 12.

Modèle : ^[0-9]{12}$

Obligatoire : Oui

DataSetId

ID de l'ensemble de données que vous souhaitez mettre à jour. Cet ID est unique parRégion AWSpour chaqueAWS.

Obligatoire : Oui

Corps de la demande

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

ImportMode

Indique si vous souhaitez importer les données dans SPICE.

Type : Chaîne

Valeurs valides : SPICE | DIRECT_QUERY

Obligatoire : Oui

Name

Nom d'affichage de l'ensemble de données.

Type : Chaîne

Contraintes de longueur : Longueur minimale de 1. Longueur maximum de 128.

Obligatoire : Oui

PhysicalTableMap

Déclare les tables physiques disponibles dans les sources de données sous-jacentes.

Type : StringPhysicalTablecarte d'objets

Entrées de la carte : Nombre minimal de 0 éléments. Nombre maximal de 32 éléments.

Contraintes de longueur : Longueur minimale de 1. Longueur maximale de 64.

Modèle de clé :[0-9a-zA-Z-]*

Obligatoire : Oui

ColumnGroups

Regroupements de colonnes qui fonctionnent ensemble dans certains Amazon QuickSight Fonctions. Actuellement, seule la hiérarchie géospatiale est prise en charge.

Type : Grappe deColumnGroupobjets

Membres du tableau : Nombre minimum de 1 élément. Nombre maximal de 8 éléments.

Obligatoire : Non

ColumnLevelPermissionRules

Ensemble d'une ou de plusieurs définitions d'une ColumnLevelPermissionRule .

Type : Grappe deColumnLevelPermissionRuleobjets

Membres du tableau : Nombre minimum de 1 élément.

Obligatoire : Non

DataSetUsageConfiguration

Configuration d'utilisation à appliquer aux jeux de données enfants qui font référence à cet ensemble de données en tant que source.

Type : objet DataSetUsageConfiguration

Obligatoire : Non

FieldFolders

Dossier contenant des champs et des sous-dossiers imbriqués pour votre jeu de données.

Type : StringFieldFoldercarte d'objets

Contraintes de longueur : Longueur minimale de 1. Longueur maximum de 1 000.

Obligatoire : Non

LogicalTableMap

Configure la combinaison et la transformation des données des tables physiques.

Type : StringLogicalTablecarte d'objets

Entrées de la carte : Nombre maximal de 64 éléments.

Contraintes de longueur : Longueur minimale de 1. Longueur maximale de 64.

Modèle de clé :[0-9a-zA-Z-]*

Obligatoire : Non

RowLevelPermissionDataSet

Configuration de sécurité au niveau des lignes pour les données que vous souhaitez créer.

Type : objet RowLevelPermissionDataSet

Obligatoire : Non

RowLevelPermissionTagConfiguration

Configuration des balises sur un jeu de données pour définir la sécurité au niveau des lignes. Les balises de sécurité au niveau des lignes ne sont actuellement prises en charge que pour l'intégration anonyme.

Type : objet RowLevelPermissionTagConfiguration

Obligatoire : Non

Syntaxe de la réponse

HTTP/1.1 Status
Content-type: application/json

{
   "Arn": "string",
   "DataSetId": "string",
   "IngestionArn": "string",
   "IngestionId": "string",
   "RequestId": "string"
}

Eléments de réponse

Si l'action aboutit, le service renvoie la réponse HTTP suivante.

Status

Le statut HTTP de la requête.

Les données suivantes sont renvoyées au format JSON par le service.

Arn

Amazon Resource Name (ARN) de l'ensemble de données.

Type : Chaîne

DataSetId

ID de l'ensemble de données que vous souhaitez créer. Cet ID est unique parRégion AWSpour chaqueAWS.

Type : Chaîne

IngestionArn

ARN pour l'ingestion, qui est déclenchée suite à la création du jeu de données si le mode d'importation est SPICE.

Type : Chaîne

IngestionId

ID de l'ingestion, qui est déclenchée suite à la création du jeu de données si le mode d'importation est SPICE.

Type : Chaîne

RequestId

LeAWSID de la demande pour cette opération.

Type : Chaîne

Erreurs

Pour plus d'informations sur les erreurs communes à toutes les actions, consultezErreurs courantes.

AccessDeniedException

Vous n'avez pas accès à cet élément. Les informations d'identification fournies n'ont pas pu être validées. Il est possible que vous ne soyez pas autorisé à effectuer la demande. Assurez-vous que votre compte est autorisé à utiliser Amazon QuickSight , que vos stratégies ont les autorisations appropriées et que vous utilisez les bonnes clés d'accès.

HTTP Status Code : 401

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 sont introuvables.

HTTP Status Code : 404

ThrottlingException

L'accès est limité.

HTTP Status Code : 429

UnsupportedUserEditionException

Cette erreur indique que vous appelez une opération sur Amazon QuickSightabonnement dont l'édition n'inclut pas la prise en charge de cette opération. Amazon QuickSight est Standard Edition et Enterprise Edition. Toutes les opérations et fonctionnalités ne sont pas disponibles dans chaque édition.

HTTP Status Code : 403

Exemples

Exemple

Cet exemple illustre une utilisation de UpdateDataSet.

Exemple de demande

POST /accounts/{AwsAccountId}/data-sets/{DataSetId} HTTP/1.1
Content-type: application/json

Voir aussi

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 :