As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.
CreateDataSource
Cria uma fonte de dados.
Sintaxe da solicitação
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 da solicitação de URI
A solicitação usa os parâmetros de URI a seguir.
- AwsAccountId
-
O ID da conta da AWS.
Restrições de tamanho: Comprimento fixo de 12.
Padrão:
^[0-9]{12}$
Obrigatório Sim
Corpo da solicitação
A solicitação aceita os dados a seguir no formato JSON.
- DataSourceId
-
Uma ID para a fonte de dados. Esse ID é único porRegião da AWSparaAWSconta.
Type: String
Obrigatório Sim
- Name
-
Um nome de exibição para a fonte de dados.
Type: String
Restrições de tamanho: Tamanho mínimo de 1. Tamanho máximo de 128.
Obrigatório Sim
- Type
-
O tipo da fonte de dados. Para retornar uma lista de todas as fontes de dados, use
ListDataSources
.Usar o
AMAZON_ELASTICSEARCH
para a Amazon OpenSearch Serviço.Type: String
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
Obrigatório Sim
- Credentials
-
As credenciais da Amazon QuickSight que usa para se conectar à sua origem subjacente. Atualmente, somente credenciais baseadas em nome de usuário e senha são suportadas.
Tipo: objeto DataSourceCredentials
Obrigatório Não
- DataSourceParameters
-
Os parâmetros que a Amazon QuickSight usa para se conectar à sua origem subjacente.
Tipo: objeto DataSourceParameters
Obrigatório Não
- Permissions
-
Uma lista de permissões de recursos na fonte de dados.
Type: Matriz deResourcePermissionobjetos
Membros da matriz Número mínimo de 1 item Número máximo de 64 itens
Obrigatório Não
- SslProperties
-
Propriedades SSL (Secure Socket Layer) que se aplicam quando QuickSight conecta-se à sua fonte subjacente.
Tipo: objeto SslProperties
Obrigatório Não
- Tags
-
Contém um mapa dos pares de chave-valor para a tag de recurso ou tags atribuídas à fonte de dados.
Type: Matriz deTagobjetos
Membros da matriz Número mínimo de 1 item Número máximo de 200 itens
Obrigatório Não
- VpcConnectionProperties
-
Use esse parâmetro somente quando quiser QuickSight para usar uma conexão de VPC ao se conectar à sua origem subjacente.
Tipo: objeto VpcConnectionProperties
Obrigatório Não
Sintaxe da resposta
HTTP/1.1 Status
Content-type: application/json
{
"Arn": "string",
"CreationStatus": "string",
"DataSourceId": "string",
"RequestId": "string"
}
Elementos de resposta
Se a ação for bem-sucedida, o serviço retornará a resposta HTTP a seguir.
- Status
-
O status HTTP da solicitação.
Os seguintes dados são retornados no formato JSON pelo serviço.
- Arn
-
O nome de recurso da Amazon (ARN) da fonte de dados.
Type: String
- CreationStatus
-
O status da criação da fonte de dados.
Type: String
Valores válidos:
CREATION_IN_PROGRESS | CREATION_SUCCESSFUL | CREATION_FAILED | UPDATE_IN_PROGRESS | UPDATE_SUCCESSFUL | UPDATE_FAILED | DELETED
- DataSourceId
-
O ID da fonte de dados. Esse ID é único porRegião da AWSparaAWSconta.
Type: String
- RequestId
-
OAWSID da
Type: String
Erros
Para obter informações sobre os erros que são comuns a todas as ações, consulteErros comuns.
- AccessDeniedException
-
Você não tem acesso a esse item. Não foi possível validar as credenciais fornecidas. Talvez você não tenha permissão para executar a solicitação. Verifique se sua conta está autorizada a usar a Amazon QuickSight , se as suas políticas têm as permissões corretas e se você está usando as chaves de acesso corretas.
Código de status HTTP: 401
- ConflictException
-
Atualizar ou excluir um recurso pode causar um estado inconsistente.
Código de status HTTP: 409
- InternalFailureException
-
Ocorreu um erro interno.
Código de status HTTP: 500
- InvalidParameterValueException
-
Um ou mais parâmetros têm um valor que não é válido.
Código de status HTTP: 400
- LimitExceededException
-
Um limite foi excedido.
Código de status HTTP: 409
- ResourceExistsException
-
O recurso especificado já existe.
Código de status HTTP: 409
- ResourceNotFoundException
-
Não foi possível encontrar um ou mais recursos.
Código de status HTTP: 404
- ThrottlingException
-
O acesso é limitado.
Código de status HTTP: 429
Exemplos
Exemplo
Este exemplo ilustra um uso de CreateDataSource.
Exemplo de solicitação
POST /accounts/{AwsAccountId}/data-sources HTTP/1.1 Content-type: application/json
Consulte também
Para obter mais informações sobre como usar essa API em um dos AWS SDKs específicos de linguagem, consulte o seguinte: