LinuxCommandLibrary

aws-quicksight

Manage AWS QuickSight resources

TLDR

List datasets

$ aws quicksight list-data-sets --aws-account-id [aws_account_id]
copy

List users
$ aws quicksight list-users --aws-account-id [aws_account_id] --namespace default
copy

List groups
$ aws quicksight list-groups --aws-account-id [aws_account_id] --namespace default
copy

List dashboards
$ aws quicksight list-dashboards --aws-account-id [aws_account_id]
copy

Display detailed information about a dataset
$ aws quicksight describe-data-set --aws-account-id [aws_account_id] --data-set-id [data_set_id]
copy

Display who has access to the dataset and what kind of actions they can perform on the dataset
$ aws quicksight describe-data-set-permissions --aws-account-id [aws_account_id] --data-set-id [data_set_id]
copy

SYNOPSIS

aws-quicksight COMMAND [--region <value>] [--profile <value>] [--output <value>] [--query <value>] [GLOBAL OPTIONS]

PARAMETERS

--aws-access-key-id <value>
    The AWS access key ID

--aws-secret-access-key <value>
    The AWS secret access key

--aws-session-token <value>
    The AWS session token (for temporary creds)

--ca-bundle <value>
    Path to custom CA bundle

--cli-auto-prompt
    Automatically prompt for CLI inputs

--cli-binary-format <value>
    The formatting style for binary blobs (raw|base64|base64-auto)

--cli-connect-timeout <value>
    Connection timeout in seconds

--cli-read-timeout <value>
    Client-side read timeout per socket read

--debug
    Turn on debug logging

--endpoint-url <value>
    Override default endpoint URL

--help
    Show help for a command

--no-verify-ssl
    Disable SSL certificate verification

--output <text|json|table>
    Output format

--profile <value>
    Use a specific named profile from credentials file

--query <value>
    JMESPath expression to filter output

--region <value>
    AWS region (critical for QuickSight)

--version
    Show version

--cli-input-json <value>
    Perform operation using JSON input

--generate-cli-skeleton
    Prints JSON skeleton for input parameters

--no-paginate
    Disable automatic pagination

DESCRIPTION

aws-quicksight is the command-line interface for Amazon QuickSight, AWS's fully managed BI service for creating interactive dashboards and visualizations.

It enables programmatic control over QuickSight resources including users, groups, namespaces, data sources, datasets, themes, analyses, dashboards, and embeds. Automate tasks like user registration, dataset imports from S3/Redshift/Athena, dashboard publishing, and subscription management.

Prior to use, install AWS CLI v2, run aws configure for credentials, and select a supported region (e.g., us-east-1). IAM roles must grant QuickSight permissions like quicksight:CreateUser.

Output formats include JSON, text, table; use --query with JMESPath for filtering. Ideal for DevOps, scripting, and integration with CI/CD pipelines.

QuickSight features ML insights, paginated reports, and enterprise features like VPC connections.

CAVEATS

QuickSight is regional and account-specific; mismatches cause errors. Admin privileges required for many ops. High-volume calls may hit API throttling. Not all features (e.g., SPICE capacity) fully CLI-exposed.

COMMON SUBCOMMANDS

list-users, create-user, describe-dashboard, list-data-sets, create-theme, search-analyses. Run aws-quicksight help for full list.

EXAMPLE USAGE

aws-quicksight list-users --aws-account-id 123456789012 --namespace default --region us-east-1 --output table
aws-quicksight create-dashboard --aws-account-id 123456789012 --dashboard-id mydash --name MyDashboard ...

HISTORY

Introduced in AWS CLI v1.11.200+ (2017) post-QuickSight launch (2016). Enhanced in CLI v2 (2020+) with better streaming, binary support, and full API parity. Tracks QuickSight evolutions like Enterprise edition and ML Insights.

SEE ALSO

aws(1), jq(1)

Copied to clipboard