CreateDataSource - Amazon QuickSight
AnforderungssyntaxURI-AnfrageparameterAnforderungstextAntwortsyntaxAntwortelementeFehlerBeispieleWeitere Informationen finden Sie unter:

Die vorliegende Übersetzung wurde maschinell erstellt. Im Falle eines Konflikts oder eines Widerspruchs zwischen dieser übersetzten Fassung und der englischen Fassung (einschließlich infolge von Verzögerungen bei der Übersetzung) ist die englische Fassung maßgeblich.

CreateDataSource

Erstellt eine Datenquelle.

Anforderungssyntax

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"
   }
}

URI-Anfrageparameter

Die Anforderung verwendet die folgenden URI-Parameter.

AwsAccountId

Die AWS-Konto-ID.

Längenbeschränkungen:: Feste Länge von 12.

Pattern: ^[0-9]{12}$

Erforderlich:: Ja

Anforderungstext

Die Anforderung akzeptiert die folgenden Daten im JSON-Format.

DataSourceId

Eine ID der Datenquelle. Diese ID muss eindeutig seinAWS-Regionfür jedenAWSKonto.

Type: String

Erforderlich:: Ja

Name

Ein Anzeigename für die Datenquelle.

Type: String

Längenbeschränkungen:: Mindestlänge 1. Maximale Länge beträgt 128 Zeichen.

Erforderlich:: Ja

Type

Der Typ der Datenquelle. Um eine Liste aller Datenquellen zurückzugeben, verwenden SieListDataSources.

Verwenden vonAMAZON_ELASTICSEARCHfür Amazon OpenSearch Service.

Type: String

Zulässige Werte: 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

Erforderlich:: Ja

Credentials

Die Anmeldeinformationen Amazon QuickSight das verwendet, um eine Verbindung zu Ihrer zugrunde liegenden Quelle herzustellen. Derzeit werden nur Anmeldeinformationen unterstützt, die auf dem Benutzernamen und dem Kennwort basieren.

Typ: DataSourceCredentials Objekt

Erforderlich:: Nein

DataSourceParameters

Die Parameter, die Amazon QuickSight verwendet, um eine Verbindung zu Ihrer zugrunde liegenden Quelle herzustellen.

Typ: DataSourceParameters Objekt

Erforderlich:: Nein

Permissions

Eine Liste der Ressourcenberechtigungen für die Datenquelle.

Type: Array derResourcePermissionObjekte

Array Mitglieder:: Die Mindestanzahl beträgt 1 Element. Maximale Anzahl der Elemente = 64 Elemente.

Erforderlich:: Nein

SslProperties

Secure-Socket-Layer (SSL) -Eigenschaften, die bei Amazon gelten QuickSight verbindet sich mit Ihrer zugrunde liegenden Quelle.

Typ: SslProperties Objekt

Erforderlich:: Nein

Tags

Enthält eine Zuordnung der Schlüssel-Wert-Paare für das oder die Ressourcen-Tags, die der Datenquelle zugewiesen sind.

Type: Array derTagObjekte

Array Mitglieder:: Die Mindestanzahl beträgt 1 Element. Maximale Anzahl der Elemente = 200 Elemente.

Erforderlich:: Nein

VpcConnectionProperties

Verwenden Sie diesen Parameter nur, wenn Sie Amazon möchten. QuickSight um eine VPC-Verbindung zu Ihrer zugrunde liegenden Quelle zu verwenden.

Typ: VpcConnectionProperties Objekt

Erforderlich:: Nein

Antwortsyntax

HTTP/1.1 Status
Content-type: application/json

{
   "Arn": "string",
   "CreationStatus": "string",
   "DataSourceId": "string",
   "RequestId": "string"
}

Antwortelemente

Wenn die Aktion erfolgreich ist, sendet der Dienst die folgende HTTP-Antwort zurück.

Status

Der HTTP-Status der Anforderung.

Die folgenden Daten werden vom Service im JSON-Format zurückgegeben.

Arn

Der Amazon-Ressourcenname (ARN) der Datenquelle.

Type: String

CreationStatus

Der Status der Erstellung der Datenquelle.

Type: String

Zulässige Werte: CREATION_IN_PROGRESS | CREATION_SUCCESSFUL | CREATION_FAILED | UPDATE_IN_PROGRESS | UPDATE_SUCCESSFUL | UPDATE_FAILED | DELETED

DataSourceId

Die ID der Datenquelle. Diese ID muss eindeutig seinAWS-Regionfür jedenAWSKonto.

Type: String

RequestId

DieAWSdie ID der Anforderung für diese Operation.

Type: String

Fehler

Hinweise zu den Fehlern, die bei allen Aktionen auftreten, finden Sie unterHäufige Fehler.

AccessDeniedException

Sie haben keinen Zugriff auf dieses Element. Die bereitgestellten Anmeldeinformationen konnten nicht überprüft werden. Sie sind möglicherweise nicht berechtigt, die Anforderung auszuführen. Stellen Sie sicher, dass Ihr Konto für die Nutzung von Amazon autorisiert ist QuickSight -Service, dass Ihre Richtlinien die korrekten Berechtigungen besitzen und dass Sie die richtigen Zugriffsschlüssel verwenden.

HTTP Status Code::: 401

ConflictException

Das Aktualisieren oder Löschen einer Ressource kann zu einem inkonsistenten Zustand führen.

HTTP Status Code::: 409

InternalFailureException

Es ist ein interner Fehler aufgetreten.

HTTP Status Code::: 500

InvalidParameterValueException

Ein oder mehrere Parameter haben einen Wert, der nicht gültig ist.

HTTP Status Code::: 400

LimitExceededException

Ein Limit wurde überschritten.

HTTP Status Code::: 409

ResourceExistsException

Die angegebene Ressource ist bereits vorhanden.

HTTP Status Code::: 409

ResourceNotFoundException

Mindestens eine Ressource kann nicht gefunden werden.

HTTP Status Code::: 404

ThrottlingException

Der Zugriff wird gedrosselt

HTTP Status Code::: 429

Beispiele

Beispiel

Dieses Beispiel zeigt eine Verwendung von CreateDataSource.

Beispielanforderung

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

Weitere Informationen finden Sie unter:

Weitere Informationen zur Verwendung dieser API in einem der sprachspezifischen AWS-SDKs finden Sie unter: