Table Of Contents

Feedback

User Guide

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

[ aws . quicksight ]

list-data-sources

Description

Lists data sources in current AWS Region that belong to this AWS account.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  list-data-sources
--aws-account-id <value>
[--next-token <value>]
[--max-results <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--aws-account-id (string)

The AWS account ID.

--next-token (string)

The token for the next set of results, or null if there are no more results.

--max-results (integer)

The maximum number of results to be returned per request.

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

DataSources -> (list)

A list of data sources.

(structure)

The structure of a data source.

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.

Name -> (string)

A display name for the data source.

Type -> (string)

The type of the data source. This type indicates which database engine the data source connects to.

Status -> (string)

The HTTP status of the request.

CreatedTime -> (timestamp)

The time that this data source was created.

LastUpdatedTime -> (timestamp)

The last time that this data source was updated.

DataSourceParameters -> (structure)

The parameters that Amazon QuickSight uses to connect to your underlying 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.

VpcConnectionProperties -> (structure)

The VPC connection information. You need to 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.

SslProperties -> (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.

ErrorInfo -> (structure)

Error information from the last update or the creation of the data source.

Type -> (string)

Error type.

Message -> (string)

Error message.

NextToken -> (string)

The token for the next set of results, or null if there are no more results.

RequestId -> (string)

The AWS request ID for this operation.

Status -> (integer)

The HTTP status of the request.