CreateDataSource - Amazon QuickSight

Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.

CreateDataSource

Crea un origen de datos.

Sintaxis de la solicitud

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

Parámetros de solicitud del URI

La solicitud utiliza los siguientes parámetros URI.

AwsAccountId

El ID de la cuenta de AWS.

Restricciones de longitud Longitud fija de 12.

Patrón: ^[0-9]{12}$

Obligatorio Sí

Cuerpo de la solicitud

La solicitud acepta los siguientes datos en formato JSON.

DataSourceId

Un ID del origen de datos. Este ID es único porRegión de AWSpara eachAWSaccount.

Type: Cadena

Obligatorio Sí

Name

Un nombre para mostrar en el origen de datos.

Type: Cadena

Restricciones de longitud Longitud mínima de 1. La longitud máxima es de 128 caracteres.

Obligatorio Sí

Type

El tipo del origen de datos. Para devolver una lista de todas las fuentes de datos, utiliceListDataSources.

UsarAMAZON_ELASTICSEARCHpara Amazon OpenSearch Servicio

Type: Cadena

Valores válidos: 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

Obligatorio Sí

Credentials

Las credenciales de Amazon QuickSight que se utiliza para conectarse al origen subyacente. Actualmente, solo se admiten las credenciales basadas en el nombre de usuario y la contraseña.

Tipo: objeto DataSourceCredentials

Obligatorio No

DataSourceParameters

Los parámetros que Amazon QuickSight utiliza para conectarse al origen subyacente.

Tipo: objeto DataSourceParameters

Obligatorio No

Permissions

Lista de permisos de recursos en el origen de datos.

Type: Matriz deResourcePermissionobjects

Miembros de la matriz: Número mínimo de 1 elemento. Número máximo de 64 elementos.

Obligatorio No

SslProperties

Propiedades de la capa de conexión segura (SSL) que se aplican cuando Amazon QuickSight se conecta a la fuente subyacente.

Tipo: objeto SslProperties

Obligatorio No

Tags

Contiene un mapa de los pares clave-valor para la etiqueta o etiquetas de recursos asignadas a la fuente de datos.

Type: Matriz deTagobjects

Miembros de la matriz: Número mínimo de 1 elemento. Número máximo de 200 elementos.

Obligatorio No

VpcConnectionProperties

Utilice este parámetro solo para QuickSight para utilizar una conexión de VPC al origen subyacente.

Tipo: objeto VpcConnectionProperties

Obligatorio No

Sintaxis de la respuesta

HTTP/1.1 Status Content-type: application/json { "Arn": "string", "CreationStatus": "string", "DataSourceId": "string", "RequestId": "string" }

Elementos de respuesta

Si la acción se realiza correctamente, el servicio devuelve la siguiente respuesta HTTP.

Status

El estado HTTP de la solicitud.

El servicio devuelve los datos siguientes en formato JSON.

Arn

El nombre de recurso de Amazon (ARN) del origen de datos.

Type: Cadena

CreationStatus

El estado de creación de la fuente de datos.

Type: Cadena

Valores válidos: CREATION_IN_PROGRESS | CREATION_SUCCESSFUL | CREATION_FAILED | UPDATE_IN_PROGRESS | UPDATE_SUCCESSFUL | UPDATE_FAILED | DELETED

DataSourceId

El ID del origen de datos. Este ID es único porRegión de AWSpara eachAWSaccount.

Type: Cadena

RequestId

LaAWSID de solicitud de esta operación.

Type: Cadena

Errores

Para obtener información sobre los errores que son comunes a todas las acciones, consulteErrores comunes.

AccessDeniedException

No tiene permiso de acceso. La credenciales proporcionadas no se pudieron validar. Es posible que no tenga autorización para realizar la solicitud. Asegúrese de que su cuenta esté autorizada para usar Amazon QuickSight , que las políticas tienen los permisos correctos.

Código de estado HTTP: 401

ConflictException

La actualización o eliminación de un recurso puede provocar un estado incoherente.

Código de estado HTTP: 409

InternalFailureException

Se produjo un error interno.

Código de estado HTTP: 500

InvalidParameterValueException

Uno o más parámetros tienen un valor que no es válido.

Código de estado HTTP: 400

LimitExceededException

Se superó un límite.

Código de estado HTTP: 409

ResourceExistsException

El recurso especificado ya existe.

Código de estado HTTP: 409

ResourceNotFoundException

No se encontraron uno o varios recursos.

Código de estado HTTP: 404

ThrottlingException

El acceso está limitado.

Código de estado HTTP: 429

Ejemplos

Ejemplo

Este ejemplo ilustra un uso de CreateDataSource.

Solicitud de muestra

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

Véase también

Para obtener más información sobre el uso de esta API en un SDK de AWS de un lenguaje específico, consulte: