POST

/accounts/{AwsAccountId}/data-sources

http://quicksight.{region}.amazonaws.com/accounts/{AwsAccountId}/data-sources

Creates a data source.

Access Token Required: API Key

Path Parameters

AwsAccountIdstringrequired

The Amazon Web Services account ID.

Body Params

Namestringrequired

A display name for the data source.

Tagsarray

Contains a map of the key-value pairs for the resource tag or tags assigned to the data source.

Typestringrequired

<p>The type of the data source. To return a list of all data sources, use <code>ListDataSources</code>.</p> <p>Use <code>AMAZON_ELASTICSEARCH</code> for Amazon OpenSearch Service.</p>

Credentialsobject

Data source credentials. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.

Permissionsarray

A list of resource permissions on the data source.

DataSourceIdstringrequired

An ID for the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

SslPropertiesobject

Secure Socket Layer (SSL) properties that apply when Amazon QuickSight connects to your underlying data source.

DataSourceParametersobject

The parameters that Amazon QuickSight uses to connect to your underlying data source. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.

VpcConnectionPropertiesobject

VPC connection properties.

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request POST \
2     --url 'http://quicksight.{region}.amazonaws.com/accounts/{AwsAccountId}/data-sources' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}