AWS CLI Command Reference

[ 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 | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--aws-account-id (string)

The Amazon Web Services account ID.

--data-source-id (string)

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

--name (string)

A display name for the data source.

--type (string)

The type of the data source. To return a list of all data sources, use ListDataSources .

Use AMAZON_ELASTICSEARCH for Amazon OpenSearch Service.

Possible values:

  • 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

--data-source-parameters (structure)

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

AmazonElasticsearchParameters -> (structure)

The parameters for OpenSearch.

Domain -> (string)

The OpenSearch domain.

AthenaParameters -> (structure)

The parameters for Amazon Athena.

WorkGroup -> (string)

The workgroup that Amazon Athena uses.

AuroraParameters -> (structure)

The parameters for Amazon Aurora MySQL.

Host -> (string)

Host.

Port -> (integer)

Port.

Database -> (string)

Database.

AuroraPostgreSqlParameters -> (structure)

The parameters for Amazon Aurora.

Host -> (string)

The Amazon Aurora PostgreSQL-Compatible host to connect to.

Port -> (integer)

The port that Amazon Aurora PostgreSQL is listening on.

Database -> (string)

The Amazon Aurora PostgreSQL database to connect to.

AwsIotAnalyticsParameters -> (structure)

The parameters for IoT Analytics.

DataSetName -> (string)

Dataset name.

JiraParameters -> (structure)

The parameters for Jira.

SiteBaseUrl -> (string)

The base URL of the Jira site.

MariaDbParameters -> (structure)

The parameters for MariaDB.

Host -> (string)

Host.

Port -> (integer)

Port.

Database -> (string)

Database.

MySqlParameters -> (structure)

The parameters for MySQL.

Host -> (string)

Host.

Port -> (integer)

Port.

Database -> (string)

Database.

OracleParameters -> (structure)

The parameters for Oracle.

Host -> (string)

An Oracle host.

Port -> (integer)

Port.

Database -> (string)

Database.

PostgreSqlParameters -> (structure)

The parameters for PostgreSQL.

Host -> (string)

Host.

Port -> (integer)

Port.

Database -> (string)

Database.

PrestoParameters -> (structure)

The parameters for Presto.

Host -> (string)

Host.

Port -> (integer)

Port.

Catalog -> (string)

Catalog.

RdsParameters -> (structure)

The parameters for Amazon RDS.

InstanceId -> (string)

Instance ID.

Database -> (string)

Database.

RedshiftParameters -> (structure)

The parameters for Amazon Redshift.

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)

The parameters for S3.

ManifestFileLocation -> (structure)

Location of the Amazon S3 manifest file. This is NULL if the manifest file was uploaded into Amazon QuickSight.

Bucket -> (string)

Amazon S3 bucket.

Key -> (string)

Amazon S3 key that identifies an object.

ServiceNowParameters -> (structure)

The parameters for ServiceNow.

SiteBaseUrl -> (string)

URL of the base site.

SnowflakeParameters -> (structure)

The parameters for Snowflake.

Host -> (string)

Host.

Database -> (string)

Database.

Warehouse -> (string)

Warehouse.

SparkParameters -> (structure)

The parameters for Spark.

Host -> (string)

Host.

Port -> (integer)

Port.

SqlServerParameters -> (structure)

The parameters for SQL Server.

Host -> (string)

Host.

Port -> (integer)

Port.

Database -> (string)

Database.

TeradataParameters -> (structure)

The parameters for Teradata.

Host -> (string)

Host.

Port -> (integer)

Port.

Database -> (string)

Database.

TwitterParameters -> (structure)

The parameters for Twitter.

Query -> (string)

Twitter query string.

MaxRows -> (integer)

Maximum number of rows to query Twitter.

AmazonOpenSearchParameters -> (structure)

The parameters for OpenSearch.

Domain -> (string)

The OpenSearch domain.

ExasolParameters -> (structure)

The parameters for Exasol.

Host -> (string)

The hostname or IP address of the Exasol data source.

Port -> (integer)

The port for the Exasol data source.

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},OracleParameters={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},AmazonOpenSearchParameters={Domain=string},ExasolParameters={Host=string,Port=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"
  },
  "OracleParameters": {
    "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
  },
  "AmazonOpenSearchParameters": {
    "Domain": "string"
  },
  "ExasolParameters": {
    "Host": "string",
    "Port": integer
  }
}

--credentials (structure)

The credentials Amazon 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 operation compares the DataSourceParameters structure that’s in the request with the structures in the AlternateDataSourceParameters allow list. 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)

The parameters for OpenSearch.

Domain -> (string)

The OpenSearch domain.

AthenaParameters -> (structure)

The parameters for Amazon Athena.

WorkGroup -> (string)

The workgroup that Amazon Athena uses.

AuroraParameters -> (structure)

The parameters for Amazon Aurora MySQL.

Host -> (string)

Host.

Port -> (integer)

Port.

Database -> (string)

Database.

AuroraPostgreSqlParameters -> (structure)

The parameters for Amazon Aurora.

Host -> (string)

The Amazon Aurora PostgreSQL-Compatible host to connect to.

Port -> (integer)

The port that Amazon Aurora PostgreSQL is listening on.

Database -> (string)

The Amazon Aurora PostgreSQL database to connect to.

AwsIotAnalyticsParameters -> (structure)

The parameters for IoT Analytics.

DataSetName -> (string)

Dataset name.

JiraParameters -> (structure)

The parameters for Jira.

SiteBaseUrl -> (string)

The base URL of the Jira site.

MariaDbParameters -> (structure)

The parameters for MariaDB.

Host -> (string)

Host.

Port -> (integer)

Port.

Database -> (string)

Database.

MySqlParameters -> (structure)

The parameters for MySQL.

Host -> (string)

Host.

Port -> (integer)

Port.

Database -> (string)

Database.

OracleParameters -> (structure)

The parameters for Oracle.

Host -> (string)

An Oracle host.

Port -> (integer)

Port.

Database -> (string)

Database.

PostgreSqlParameters -> (structure)

The parameters for PostgreSQL.

Host -> (string)

Host.

Port -> (integer)

Port.

Database -> (string)

Database.

PrestoParameters -> (structure)

The parameters for Presto.

Host -> (string)

Host.

Port -> (integer)

Port.

Catalog -> (string)

Catalog.

RdsParameters -> (structure)

The parameters for Amazon RDS.

InstanceId -> (string)

Instance ID.

Database -> (string)

Database.

RedshiftParameters -> (structure)

The parameters for Amazon Redshift.

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)

The parameters for S3.

ManifestFileLocation -> (structure)

Location of the Amazon S3 manifest file. This is NULL if the manifest file was uploaded into Amazon QuickSight.

Bucket -> (string)

Amazon S3 bucket.

Key -> (string)

Amazon S3 key that identifies an object.

ServiceNowParameters -> (structure)

The parameters for ServiceNow.

SiteBaseUrl -> (string)

URL of the base site.

SnowflakeParameters -> (structure)

The parameters for Snowflake.

Host -> (string)

Host.

Database -> (string)

Database.

Warehouse -> (string)

Warehouse.

SparkParameters -> (structure)

The parameters for Spark.

Host -> (string)

Host.

Port -> (integer)

Port.

SqlServerParameters -> (structure)

The parameters for SQL Server.

Host -> (string)

Host.

Port -> (integer)

Port.

Database -> (string)

Database.

TeradataParameters -> (structure)

The parameters for Teradata.

Host -> (string)

Host.

Port -> (integer)

Port.

Database -> (string)

Database.

TwitterParameters -> (structure)

The parameters for Twitter.

Query -> (string)

Twitter query string.

MaxRows -> (integer)

Maximum number of rows to query Twitter.

AmazonOpenSearchParameters -> (structure)

The parameters for OpenSearch.

Domain -> (string)

The OpenSearch domain.

ExasolParameters -> (structure)

The parameters for Exasol.

Host -> (string)

The hostname or IP address of the Exasol data source.

Port -> (integer)

The port for the Exasol data source.

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"
        },
        "OracleParameters": {
          "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
        },
        "AmazonOpenSearchParameters": {
          "Domain": "string"
        },
        "ExasolParameters": {
          "Host": "string",
          "Port": 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 or group associated with a data source or dataset. (This is common.)

  • The ARN of an Amazon QuickSight user, group, or namespace associated with an analysis, dashboard, template, or theme. (This is common.)

  • The ARN of an Amazon Web Services account root: This is an IAM ARN rather than a QuickSight ARN. Use this option only to share resources (templates) across Amazon Web Services accounts. (This is less common.)

Actions -> (list)

The IAM action to grant or revoke permissions on.

(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 Amazon 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 Amazon 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 | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml.

--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. 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 Amazon Web Services Region for each Amazon Web Services account.

CreationStatus -> (string)

The status of creating the data source.

RequestId -> (string)

The Amazon Web Services request ID for this operation.

Status -> (integer)

The HTTP status of the request.

© Copyright 2018, Amazon Web Services. Created using Sphinx.