Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . quicksight ]

create-data-source

Description

Creates a data source.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  create-data-source
--aws-account-id <value>
--data-source-id <value>
--name <value>
--type <value>
[--data-source-parameters <value>]
[--credentials <value>]
[--permissions <value>]
[--vpc-connection-properties <value>]
[--ssl-properties <value>]
[--tags <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--aws-account-id (string)

The AWS account ID.

--data-source-id (string)

An ID for the data source. This ID is unique per AWS Region for each AWS account.

--name (string)

A display name for the data source.

--type (string)

The type of the data source. Currently, the supported types for this operation are: ATHENA, AURORA, AURORA_POSTGRESQL, MARIADB, MYSQL, POSTGRESQL, PRESTO, REDSHIFT, S3, SNOWFLAKE, SPARK, SQLSERVER, TERADATA . Use ListDataSources to return a list of all data sources.

Possible values:

  • ADOBE_ANALYTICS
  • AMAZON_ELASTICSEARCH
  • ATHENA
  • AURORA
  • AURORA_POSTGRESQL
  • AWS_IOT_ANALYTICS
  • GITHUB
  • JIRA
  • MARIADB
  • MYSQL
  • POSTGRESQL
  • PRESTO
  • REDSHIFT
  • S3
  • SALESFORCE
  • SERVICENOW
  • SNOWFLAKE
  • SPARK
  • SQLSERVER
  • TERADATA
  • TWITTER

--data-source-parameters (structure)

The parameters that QuickSight uses to connect to your underlying source.

AmazonElasticsearchParameters -> (structure)

Amazon Elasticsearch Service parameters.

Domain -> (string)

The Amazon Elasticsearch Service domain.

AthenaParameters -> (structure)

Amazon Athena parameters.

WorkGroup -> (string)

The workgroup that Amazon Athena uses.

AuroraParameters -> (structure)

Amazon Aurora MySQL parameters.

Host -> (string)

Host.

Port -> (integer)

Port.

Database -> (string)

Database.

AuroraPostgreSqlParameters -> (structure)

Aurora PostgreSQL parameters.

Host -> (string)

Host.

Port -> (integer)

Port.

Database -> (string)

Database.

AwsIotAnalyticsParameters -> (structure)

AWS IoT Analytics parameters.

DataSetName -> (string)

Dataset name.

JiraParameters -> (structure)

Jira parameters.

SiteBaseUrl -> (string)

The base URL of the Jira site.

MariaDbParameters -> (structure)

MariaDB parameters.

Host -> (string)

Host.

Port -> (integer)

Port.

Database -> (string)

Database.

MySqlParameters -> (structure)

MySQL parameters.

Host -> (string)

Host.

Port -> (integer)

Port.

Database -> (string)

Database.

PostgreSqlParameters -> (structure)

PostgreSQL parameters.

Host -> (string)

Host.

Port -> (integer)

Port.

Database -> (string)

Database.

PrestoParameters -> (structure)

Presto parameters.

Host -> (string)

Host.

Port -> (integer)

Port.

Catalog -> (string)

Catalog.

RdsParameters -> (structure)

Amazon RDS parameters.

InstanceId -> (string)

Instance ID.

Database -> (string)

Database.

RedshiftParameters -> (structure)

Amazon Redshift parameters.

Host -> (string)

Host. This field can be blank if ClusterId is provided.

Port -> (integer)

Port. This field can be blank if the ClusterId is provided.

Database -> (string)

Database.

ClusterId -> (string)

Cluster ID. This field can be blank if the Host and Port are provided.

S3Parameters -> (structure)

S3 parameters.

ManifestFileLocation -> (structure)

Location of the Amazon S3 manifest file. This is NULL if the manifest file was uploaded in the console.

Bucket -> (string)

Amazon S3 bucket.

Key -> (string)

Amazon S3 key that identifies an object.

ServiceNowParameters -> (structure)

ServiceNow parameters.

SiteBaseUrl -> (string)

URL of the base site.

SnowflakeParameters -> (structure)

Snowflake parameters.

Host -> (string)

Host.

Database -> (string)

Database.

Warehouse -> (string)

Warehouse.

SparkParameters -> (structure)

Spark parameters.

Host -> (string)

Host.

Port -> (integer)

Port.

SqlServerParameters -> (structure)

SQL Server parameters.

Host -> (string)

Host.

Port -> (integer)

Port.

Database -> (string)

Database.

TeradataParameters -> (structure)

Teradata parameters.

Host -> (string)

Host.

Port -> (integer)

Port.

Database -> (string)

Database.

TwitterParameters -> (structure)

Twitter parameters.

Query -> (string)

Twitter query string.

MaxRows -> (integer)

Maximum number of rows to query Twitter.

Shorthand Syntax:

AmazonElasticsearchParameters={Domain=string},AthenaParameters={WorkGroup=string},AuroraParameters={Host=string,Port=integer,Database=string},AuroraPostgreSqlParameters={Host=string,Port=integer,Database=string},AwsIotAnalyticsParameters={DataSetName=string},JiraParameters={SiteBaseUrl=string},MariaDbParameters={Host=string,Port=integer,Database=string},MySqlParameters={Host=string,Port=integer,Database=string},PostgreSqlParameters={Host=string,Port=integer,Database=string},PrestoParameters={Host=string,Port=integer,Catalog=string},RdsParameters={InstanceId=string,Database=string},RedshiftParameters={Host=string,Port=integer,Database=string,ClusterId=string},S3Parameters={ManifestFileLocation={Bucket=string,Key=string}},ServiceNowParameters={SiteBaseUrl=string},SnowflakeParameters={Host=string,Database=string,Warehouse=string},SparkParameters={Host=string,Port=integer},SqlServerParameters={Host=string,Port=integer,Database=string},TeradataParameters={Host=string,Port=integer,Database=string},TwitterParameters={Query=string,MaxRows=integer}

JSON Syntax:

{
  "AmazonElasticsearchParameters": {
    "Domain": "string"
  },
  "AthenaParameters": {
    "WorkGroup": "string"
  },
  "AuroraParameters": {
    "Host": "string",
    "Port": integer,
    "Database": "string"
  },
  "AuroraPostgreSqlParameters": {
    "Host": "string",
    "Port": integer,
    "Database": "string"
  },
  "AwsIotAnalyticsParameters": {
    "DataSetName": "string"
  },
  "JiraParameters": {
    "SiteBaseUrl": "string"
  },
  "MariaDbParameters": {
    "Host": "string",
    "Port": integer,
    "Database": "string"
  },
  "MySqlParameters": {
    "Host": "string",
    "Port": integer,
    "Database": "string"
  },
  "PostgreSqlParameters": {
    "Host": "string",
    "Port": integer,
    "Database": "string"
  },
  "PrestoParameters": {
    "Host": "string",
    "Port": integer,
    "Catalog": "string"
  },
  "RdsParameters": {
    "InstanceId": "string",
    "Database": "string"
  },
  "RedshiftParameters": {
    "Host": "string",
    "Port": integer,
    "Database": "string",
    "ClusterId": "string"
  },
  "S3Parameters": {
    "ManifestFileLocation": {
      "Bucket": "string",
      "Key": "string"
    }
  },
  "ServiceNowParameters": {
    "SiteBaseUrl": "string"
  },
  "SnowflakeParameters": {
    "Host": "string",
    "Database": "string",
    "Warehouse": "string"
  },
  "SparkParameters": {
    "Host": "string",
    "Port": integer
  },
  "SqlServerParameters": {
    "Host": "string",
    "Port": integer,
    "Database": "string"
  },
  "TeradataParameters": {
    "Host": "string",
    "Port": integer,
    "Database": "string"
  },
  "TwitterParameters": {
    "Query": "string",
    "MaxRows": integer
  }
}

--credentials (structure)

The credentials QuickSight that uses to connect to your underlying source. Currently, only credentials based on user name and password are supported.

CredentialPair -> (structure)

Credential pair. For more information, see CredentialPair .

Username -> (string)

User name.

Password -> (string)

Password.

AlternateDataSourceParameters -> (list)

A set of alternate data source parameters that you want to share for these credentials. The credentials are applied in tandem with the data source parameters when you copy a data source by using a create or update request. The API compares the DataSourceParameters structure that's in the request with the structures in the AlternateDataSourceParameters allowlist. If the structures are an exact match, the request is allowed to use the new data source with the existing credentials. If the AlternateDataSourceParameters list is null, the DataSourceParameters originally used with these Credentials is automatically allowed.

(structure)

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.

AmazonElasticsearchParameters -> (structure)

Amazon Elasticsearch Service parameters.

Domain -> (string)

The Amazon Elasticsearch Service domain.

AthenaParameters -> (structure)

Amazon Athena parameters.

WorkGroup -> (string)

The workgroup that Amazon Athena uses.

AuroraParameters -> (structure)

Amazon Aurora MySQL parameters.

Host -> (string)

Host.

Port -> (integer)

Port.

Database -> (string)

Database.

AuroraPostgreSqlParameters -> (structure)

Aurora PostgreSQL parameters.

Host -> (string)

Host.

Port -> (integer)

Port.

Database -> (string)

Database.

AwsIotAnalyticsParameters -> (structure)

AWS IoT Analytics parameters.

DataSetName -> (string)

Dataset name.

JiraParameters -> (structure)

Jira parameters.

SiteBaseUrl -> (string)

The base URL of the Jira site.

MariaDbParameters -> (structure)

MariaDB parameters.

Host -> (string)

Host.

Port -> (integer)

Port.

Database -> (string)

Database.

MySqlParameters -> (structure)

MySQL parameters.

Host -> (string)

Host.

Port -> (integer)

Port.

Database -> (string)

Database.

PostgreSqlParameters -> (structure)

PostgreSQL parameters.

Host -> (string)

Host.

Port -> (integer)

Port.

Database -> (string)

Database.

PrestoParameters -> (structure)

Presto parameters.

Host -> (string)

Host.

Port -> (integer)

Port.

Catalog -> (string)

Catalog.

RdsParameters -> (structure)

Amazon RDS parameters.

InstanceId -> (string)

Instance ID.

Database -> (string)

Database.

RedshiftParameters -> (structure)

Amazon Redshift parameters.

Host -> (string)

Host. This field can be blank if ClusterId is provided.

Port -> (integer)

Port. This field can be blank if the ClusterId is provided.

Database -> (string)

Database.

ClusterId -> (string)

Cluster ID. This field can be blank if the Host and Port are provided.

S3Parameters -> (structure)

S3 parameters.

ManifestFileLocation -> (structure)

Location of the Amazon S3 manifest file. This is NULL if the manifest file was uploaded in the console.

Bucket -> (string)

Amazon S3 bucket.

Key -> (string)

Amazon S3 key that identifies an object.

ServiceNowParameters -> (structure)

ServiceNow parameters.

SiteBaseUrl -> (string)

URL of the base site.

SnowflakeParameters -> (structure)

Snowflake parameters.

Host -> (string)

Host.

Database -> (string)

Database.

Warehouse -> (string)

Warehouse.

SparkParameters -> (structure)

Spark parameters.

Host -> (string)

Host.

Port -> (integer)

Port.

SqlServerParameters -> (structure)

SQL Server parameters.

Host -> (string)

Host.

Port -> (integer)

Port.

Database -> (string)

Database.

TeradataParameters -> (structure)

Teradata parameters.

Host -> (string)

Host.

Port -> (integer)

Port.

Database -> (string)

Database.

TwitterParameters -> (structure)

Twitter parameters.

Query -> (string)

Twitter query string.

MaxRows -> (integer)

Maximum number of rows to query Twitter.

CopySourceArn -> (string)

The Amazon Resource Name (ARN) of a data source that has the credential pair that you want to use. When CopySourceArn is not null, the credential pair from the data source in the ARN is used as the credentials for the DataSourceCredentials structure.

JSON Syntax:

{
  "CredentialPair": {
    "Username": "string",
    "Password": "string",
    "AlternateDataSourceParameters": [
      {
        "AmazonElasticsearchParameters": {
          "Domain": "string"
        },
        "AthenaParameters": {
          "WorkGroup": "string"
        },
        "AuroraParameters": {
          "Host": "string",
          "Port": integer,
          "Database": "string"
        },
        "AuroraPostgreSqlParameters": {
          "Host": "string",
          "Port": integer,
          "Database": "string"
        },
        "AwsIotAnalyticsParameters": {
          "DataSetName": "string"
        },
        "JiraParameters": {
          "SiteBaseUrl": "string"
        },
        "MariaDbParameters": {
          "Host": "string",
          "Port": integer,
          "Database": "string"
        },
        "MySqlParameters": {
          "Host": "string",
          "Port": integer,
          "Database": "string"
        },
        "PostgreSqlParameters": {
          "Host": "string",
          "Port": integer,
          "Database": "string"
        },
        "PrestoParameters": {
          "Host": "string",
          "Port": integer,
          "Catalog": "string"
        },
        "RdsParameters": {
          "InstanceId": "string",
          "Database": "string"
        },
        "RedshiftParameters": {
          "Host": "string",
          "Port": integer,
          "Database": "string",
          "ClusterId": "string"
        },
        "S3Parameters": {
          "ManifestFileLocation": {
            "Bucket": "string",
            "Key": "string"
          }
        },
        "ServiceNowParameters": {
          "SiteBaseUrl": "string"
        },
        "SnowflakeParameters": {
          "Host": "string",
          "Database": "string",
          "Warehouse": "string"
        },
        "SparkParameters": {
          "Host": "string",
          "Port": integer
        },
        "SqlServerParameters": {
          "Host": "string",
          "Port": integer,
          "Database": "string"
        },
        "TeradataParameters": {
          "Host": "string",
          "Port": integer,
          "Database": "string"
        },
        "TwitterParameters": {
          "Query": "string",
          "MaxRows": integer
        }
      }
      ...
    ]
  },
  "CopySourceArn": "string"
}

--permissions (list)

A list of resource permissions on the data source.

(structure)

Permission for the resource.

Principal -> (string)

The Amazon Resource Name (ARN) of the principal. This can be one of the following:

  • The ARN of an Amazon QuickSight user, group, or namespace. (This is most common.)
  • The ARN of an AWS account root: This is an IAM ARN rather than a QuickSight ARN. Use this option only to share resources (templates) across AWS accounts. (This is less common.)

Actions -> (list)

The action to grant or revoke permissions on, for example "quicksight:DescribeDashboard" .

(string)

Shorthand Syntax:

Principal=string,Actions=string,string ...

JSON Syntax:

[
  {
    "Principal": "string",
    "Actions": ["string", ...]
  }
  ...
]

--vpc-connection-properties (structure)

Use this parameter only when you want QuickSight to use a VPC connection when connecting to your underlying source.

VpcConnectionArn -> (string)

The Amazon Resource Name (ARN) for the VPC connection.

Shorthand Syntax:

VpcConnectionArn=string

JSON Syntax:

{
  "VpcConnectionArn": "string"
}

--ssl-properties (structure)

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

DisableSsl -> (boolean)

A Boolean option to control whether SSL should be disabled.

Shorthand Syntax:

DisableSsl=boolean

JSON Syntax:

{
  "DisableSsl": true|false
}

--tags (list)

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

(structure)

The key or keys of the key-value pairs for the resource tag or tags assigned to the resource.

Key -> (string)

Tag key.

Value -> (string)

Tag value.

Shorthand Syntax:

Key=string,Value=string ...

JSON Syntax:

[
  {
    "Key": "string",
    "Value": "string"
  }
  ...
]

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Output

Arn -> (string)

The Amazon Resource Name (ARN) of the data source.

DataSourceId -> (string)

The ID of the data source. This ID is unique per AWS Region for each AWS account.

CreationStatus -> (string)

The status of creating the data source.

RequestId -> (string)

The AWS request ID for this operation.

Status -> (integer)

The HTTP status of the request.