CreateFolder - Amazon QuickSight
Syntaxe de la demandeParamètres de demande URICorps de la demandeSyntaxe de la réponseEléments de réponseErreursVoir 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.

CreateFolder

Crée un dossier partagé vide.

Syntaxe de la demande

POST /accounts/AwsAccountId/folders/FolderId HTTP/1.1
Content-type: application/json

{
   "FolderType": "string",
   "Name": "string",
   "ParentFolderArn": "string",
   "Permissions": [ 
      { 
         "Actions": [ "string" ],
         "Principal": "string"
      }
   ],
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ]
}

Paramètres de demande URI

La demande utilise les paramètres URI suivants.

AwsAccountId

ID duAWScompte dans lequel vous souhaitez créer le dossier.

Contraintes de longueur : Longueur fixe de 12.

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

Obligatoire : Oui

FolderId

L'ID du dossier.

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

Modèle : [\w\-]+

Obligatoire : Oui

Corps de la demande

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

FolderType

Type de dossier. Par défaut, folderType est SHARED.

Type : Chaîne

Valeurs valides : SHARED

Obligatoire : Non

Name

Nom du dossier.

Type : Chaîne

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

Obligatoire : Non

ParentFolderArn

ARN (Amazon Resource Name) du dossier parent.

ParentFolderArnpeut être « null ». Un videparentFolderArncrée un dossier de niveau racine.

Type : Chaîne

Obligatoire : Non

Permissions

Structure qui décrit les principaux et les autorisations au niveau des ressources d'un dossier.

Pour ne spécifier aucune autorisation, omettezPermissions.

Type : Tableau deResourcePermissionobjets

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

Obligatoire : Non

Tags

Balises pour le dossier.

Type : Tableau deTagobjets

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

Obligatoire : Non

Syntaxe de la réponse

HTTP/1.1 Status
Content-type: application/json

{
   "Arn": "string",
   "FolderId": "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

ARN (Amazon Resource Name) du dossier nouvellement créé.

Type : Chaîne

FolderId

ID de dossier pour le nouveau dossier créé.

Type : Chaîne

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

Modèle : [\w\-]+

RequestId

ID de demande pour le dossier nouvellement créé.

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

ResourceExistsException

La ressource spécifiée existe déjà.

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 QuickSight Les éditions actuellement disponibles pour 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

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 :