CreateDataSource - 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.

CreateDataSource

Crée une source de données.

Syntaxe de la demande

POST /accounts/AwsAccountId/data-sources HTTP/1.1
Content-type: application/json

{
   "Credentials": { 
      "CopySourceArn": "string",
      "CredentialPair": { 
         "AlternateDataSourceParameters": [ 
            { 
               "AmazonElasticsearchParameters": { 
                  "Domain": "string"
               },
               "AmazonOpenSearchParameters": { 
                  "Domain": "string"
               },
               "AthenaParameters": { 
                  "WorkGroup": "string"
               },
               "AuroraParameters": { 
                  "Database": "string",
                  "Host": "string",
                  "Port": number
               },
               "AuroraPostgreSqlParameters": { 
                  "Database": "string",
                  "Host": "string",
                  "Port": number
               },
               "AwsIotAnalyticsParameters": { 
                  "DataSetName": "string"
               },
               "ExasolParameters": { 
                  "Host": "string",
                  "Port": number
               },
               "JiraParameters": { 
                  "SiteBaseUrl": "string"
               },
               "MariaDbParameters": { 
                  "Database": "string",
                  "Host": "string",
                  "Port": number
               },
               "MySqlParameters": { 
                  "Database": "string",
                  "Host": "string",
                  "Port": number
               },
               "OracleParameters": { 
                  "Database": "string",
                  "Host": "string",
                  "Port": number
               },
               "PostgreSqlParameters": { 
                  "Database": "string",
                  "Host": "string",
                  "Port": number
               },
               "PrestoParameters": { 
                  "Catalog": "string",
                  "Host": "string",
                  "Port": number
               },
               "RdsParameters": { 
                  "Database": "string",
                  "InstanceId": "string"
               },
               "RedshiftParameters": { 
                  "ClusterId": "string",
                  "Database": "string",
                  "Host": "string",
                  "Port": number
               },
               "S3Parameters": { 
                  "ManifestFileLocation": { 
                     "Bucket": "string",
                     "Key": "string"
                  }
               },
               "ServiceNowParameters": { 
                  "SiteBaseUrl": "string"
               },
               "SnowflakeParameters": { 
                  "Database": "string",
                  "Host": "string",
                  "Warehouse": "string"
               },
               "SparkParameters": { 
                  "Host": "string",
                  "Port": number
               },
               "SqlServerParameters": { 
                  "Database": "string",
                  "Host": "string",
                  "Port": number
               },
               "TeradataParameters": { 
                  "Database": "string",
                  "Host": "string",
                  "Port": number
               },
               "TwitterParameters": { 
                  "MaxRows": number,
                  "Query": "string"
               }
            }
         ],
         "Password": "string",
         "Username": "string"
      }
   },
   "DataSourceId": "string",
   "DataSourceParameters": { 
      "AmazonElasticsearchParameters": { 
         "Domain": "string"
      },
      "AmazonOpenSearchParameters": { 
         "Domain": "string"
      },
      "AthenaParameters": { 
         "WorkGroup": "string"
      },
      "AuroraParameters": { 
         "Database": "string",
         "Host": "string",
         "Port": number
      },
      "AuroraPostgreSqlParameters": { 
         "Database": "string",
         "Host": "string",
         "Port": number
      },
      "AwsIotAnalyticsParameters": { 
         "DataSetName": "string"
      },
      "ExasolParameters": { 
         "Host": "string",
         "Port": number
      },
      "JiraParameters": { 
         "SiteBaseUrl": "string"
      },
      "MariaDbParameters": { 
         "Database": "string",
         "Host": "string",
         "Port": number
      },
      "MySqlParameters": { 
         "Database": "string",
         "Host": "string",
         "Port": number
      },
      "OracleParameters": { 
         "Database": "string",
         "Host": "string",
         "Port": number
      },
      "PostgreSqlParameters": { 
         "Database": "string",
         "Host": "string",
         "Port": number
      },
      "PrestoParameters": { 
         "Catalog": "string",
         "Host": "string",
         "Port": number
      },
      "RdsParameters": { 
         "Database": "string",
         "InstanceId": "string"
      },
      "RedshiftParameters": { 
         "ClusterId": "string",
         "Database": "string",
         "Host": "string",
         "Port": number
      },
      "S3Parameters": { 
         "ManifestFileLocation": { 
            "Bucket": "string",
            "Key": "string"
         }
      },
      "ServiceNowParameters": { 
         "SiteBaseUrl": "string"
      },
      "SnowflakeParameters": { 
         "Database": "string",
         "Host": "string",
         "Warehouse": "string"
      },
      "SparkParameters": { 
         "Host": "string",
         "Port": number
      },
      "SqlServerParameters": { 
         "Database": "string",
         "Host": "string",
         "Port": number
      },
      "TeradataParameters": { 
         "Database": "string",
         "Host": "string",
         "Port": number
      },
      "TwitterParameters": { 
         "MaxRows": number,
         "Query": "string"
      }
   },
   "Name": "string",
   "Permissions": [ 
      { 
         "Actions": [ "string" ],
         "Principal": "string"
      }
   ],
   "SslProperties": { 
      "DisableSsl": boolean
   },
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ],
   "Type": "string",
   "VpcConnectionProperties": { 
      "VpcConnectionArn": "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

Corps de la demande

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

DataSourceId

ID de la source de données. Cet ID est unique parRégion AWSpour chaqueAWS.

Type : Chaîne

Obligatoire : Oui

Name

Nom d'affichage de la source de données.

Type : Chaîne

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

Obligatoire : Oui

Type

Type de la source de données. Pour renvoyer une liste de toutes les sources de données, utilisezListDataSources.

UtiliserAMAZON_ELASTICSEARCHpour Amazon OpenSearch Service.

Type : Chaîne

Valeurs valides : ADOBE_ANALYTICS | AMAZON_ELASTICSEARCH | ATHENA | AURORA | AURORA_POSTGRESQL | AWS_IOT_ANALYTICS | GITHUB | JIRA | MARIADB | MYSQL | ORACLE | POSTGRESQL | PRESTO | REDSHIFT | S3 | SALESFORCE | SERVICENOW | SNOWFLAKE | SPARK | SQLSERVER | TERADATA | TWITTER | TIMESTREAM | AMAZON_OPENSEARCH | EXASOL

Obligatoire : Oui

Credentials

Les informations d'identification Amazon QuickSight qui utilise pour se connecter à votre source sous-jacente. Actuellement, seules les informations d'identification basées sur le nom d'utilisateur et le mot de passe sont prises

Type : objet DataSourceCredentials

Obligatoire : Non

DataSourceParameters

Les paramètres qu'Amazon QuickSight utilise pour se connecter à votre source sous-jacente.

Type : objet DataSourceParameters

Obligatoire : Non

Permissions

Liste des autorisations de ressources sur la source de données.

Type : Tableau deResourcePermissionobjets

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

Obligatoire : Non

SslProperties

Propriétés SSL (Secure Socket Layer) qui s'appliquent lorsqu'Amazon QuickSight se connecte à votre source sous-jacente.

Type : objet SslProperties

Obligatoire : Non

Tags

Contient une carte des paires clé-valeur pour la ou les balises de ressource attribuées à la source de données.

Type : Tableau deTagobjets

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

Obligatoire : Non

VpcConnectionProperties

Utilisez uniquement ce paramètre lorsque vous souhaitez utiliser Amazon QuickSight pour utiliser une connexion VPC lorsque vous connectez à votre source sous-jacente.

Type : objet VpcConnectionProperties

Obligatoire : Non

Syntaxe de la réponse

HTTP/1.1 Status
Content-type: application/json

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

Nom de ressource Amazon (ARN) de la source de données.

Type : Chaîne

CreationStatus

État de la création de la source de données.

Type : Chaîne

Valeurs valides : CREATION_IN_PROGRESS | CREATION_SUCCESSFUL | CREATION_FAILED | UPDATE_IN_PROGRESS | UPDATE_SUCCESSFUL | UPDATE_FAILED | DELETED

DataSourceId

ID de la source de données. Cet ID est unique parRégion AWSpour chaqueAWS.

Type : Chaîne

RequestId

LeAWSID de 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 service, que vos stratégies ont les autorisations appropriées et que vous utilisez les bonnes clés d'accès.

Code d'état Code : 401

ConflictException

La mise à jour ou la suppression d'une ressource peut entraîner un état incohérent.

Code d'état Code : 409

InternalFailureException

Une défaillance interne s'est produite.

Code d'état Code : 500

InvalidParameterValueException

La valeur d'un ou de plusieurs paramètres n'est pas valide.

Code d'état Code : 400

LimitExceededException

Une limite est dépassée.

Code d'état Code : 409

ResourceExistsException

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

Code d'état Code : 409

ResourceNotFoundException

Une ou plusieurs ressources n'ont pas pu être trouvées.

Code d'état Code : 404

ThrottlingException

L'accès est limité.

Code d'état Code : 429

Exemples

Exemple

Cet exemple illustre une utilisation de CreateDataSource.

Exemple de demande

POST /accounts/{AwsAccountId}/data-sources 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 :