Class: AWS.QuickSight

Inherits:
AWS.Service show all
Identifier:
quicksight
API Version:
2018-04-01
Defined in:
(unknown)

Overview

Constructs a service interface object. Each API operation is exposed as a function on service.

Service Description

Amazon QuickSight is a fully managed, serverless, cloud business intelligence service that makes it easy to extend data and insights to every user in your organization. This API interface reference contains documentation for a programming interface that you can use to manage Amazon QuickSight.

Sending a Request Using QuickSight

var quicksight = new AWS.QuickSight();
quicksight.cancelIngestion(params, function (err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Locking the API Version

In order to ensure that the QuickSight object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var quicksight = new AWS.QuickSight({apiVersion: '2018-04-01'});

You can also set the API version globally in AWS.config.apiVersions using the quicksight service identifier:

AWS.config.apiVersions = {
  quicksight: '2018-04-01',
  // other service API versions
};

var quicksight = new AWS.QuickSight();

Version:

  • 2018-04-01

Constructor Summary collapse

Property Summary collapse

Properties inherited from AWS.Service

apiVersions

Method Summary collapse

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService

Constructor Details

new AWS.QuickSight(options = {}) ⇒ Object

Constructs a service object. This object has one method for each API operation.

Examples:

Constructing a QuickSight object

var quicksight = new AWS.QuickSight({apiVersion: '2018-04-01'});

Options Hash (options):

  • params (map)

    An optional map of parameters to bind to every request sent by this service object. For more information on bound parameters, see "Working with Services" in the Getting Started Guide.

  • endpoint (String)

    The endpoint URI to send requests to. The default endpoint is built from the configured region. The endpoint should be a string like 'https://{service}.{region}.amazonaws.com'.

  • accessKeyId (String)

    your AWS access key ID.

  • secretAccessKey (String)

    your AWS secret access key.

  • sessionToken (AWS.Credentials)

    the optional AWS session token to sign requests with.

  • credentials (AWS.Credentials)

    the AWS credentials to sign requests with. You can either specify this object, or specify the accessKeyId and secretAccessKey options directly.

  • credentialProvider (AWS.CredentialProviderChain)

    the provider chain used to resolve credentials if no static credentials property is set.

  • region (String)

    the region to send service requests to. See AWS.QuickSight.region for more information.

  • maxRetries (Integer)

    the maximum amount of retries to attempt with a request. See AWS.QuickSight.maxRetries for more information.

  • maxRedirects (Integer)

    the maximum amount of redirects to follow with a request. See AWS.QuickSight.maxRedirects for more information.

  • sslEnabled (Boolean)

    whether to enable SSL for requests.

  • paramValidation (Boolean|map)

    whether input parameters should be validated against the operation description before sending the request. Defaults to true. Pass a map to enable any of the following specific validation features:

    • min [Boolean] — Validates that a value meets the min constraint. This is enabled by default when paramValidation is set to true.
    • max [Boolean] — Validates that a value meets the max constraint.
    • pattern [Boolean] — Validates that a string value matches a regular expression.
    • enum [Boolean] — Validates that a string value matches one of the allowable enum values.
  • computeChecksums (Boolean)

    whether to compute checksums for payload bodies when the service accepts it (currently supported in S3 only)

  • convertResponseTypes (Boolean)

    whether types are converted when parsing response data. Currently only supported for JSON based services. Turning this off may improve performance on large response payloads. Defaults to true.

  • correctClockSkew (Boolean)

    whether to apply a clock skew correction and retry requests that fail because of an skewed client clock. Defaults to false.

  • s3ForcePathStyle (Boolean)

    whether to force path style URLs for S3 objects.

  • s3BucketEndpoint (Boolean)

    whether the provided endpoint addresses an individual bucket (false if it addresses the root API endpoint). Note that setting this configuration option requires an endpoint to be provided explicitly to the service constructor.

  • s3DisableBodySigning (Boolean)

    whether S3 body signing should be disabled when using signature version v4. Body signing can only be disabled when using https. Defaults to true.

  • retryDelayOptions (map)

    A set of options to configure the retry delay on retryable errors. Currently supported options are:

    • base [Integer] — The base number of milliseconds to use in the exponential backoff for operation retries. Defaults to 100 ms for all services except DynamoDB, where it defaults to 50ms.
    • customBackoff [function] — A custom function that accepts a retry count and error and returns the amount of time to delay in milliseconds. If the result is a non-zero negative value, no further retry attempts will be made. The base option will be ignored if this option is supplied.
  • httpOptions (map)

    A set of options to pass to the low-level HTTP request. Currently supported options are:

    • proxy [String] — the URL to proxy requests through
    • agent [http.Agent, https.Agent] — the Agent object to perform HTTP requests with. Used for connection pooling. Defaults to the global agent (http.globalAgent) for non-SSL connections. Note that for SSL connections, a special Agent object is used in order to enable peer certificate verification. This feature is only available in the Node.js environment.
    • connectTimeout [Integer] — Sets the socket to timeout after failing to establish a connection with the server after connectTimeout milliseconds. This timeout has no effect once a socket connection has been established.
    • timeout [Integer] — Sets the socket to timeout after timeout milliseconds of inactivity on the socket. Defaults to two minutes (120000).
    • xhrAsync [Boolean] — Whether the SDK will send asynchronous HTTP requests. Used in the browser environment only. Set to false to send requests synchronously. Defaults to true (async on).
    • xhrWithCredentials [Boolean] — Sets the "withCredentials" property of an XMLHttpRequest object. Used in the browser environment only. Defaults to false.
  • apiVersion (String, Date)

    a String in YYYY-MM-DD format (or a date) that represents the latest possible API version that can be used in all services (unless overridden by apiVersions). Specify 'latest' to use the latest possible version.

  • apiVersions (map<String, String|Date>)

    a map of service identifiers (the lowercase service class name) with the API version to use when instantiating a service. Specify 'latest' for each individual that can use the latest available version.

  • logger (#write, #log)

    an object that responds to .write() (like a stream) or .log() (like the console object) in order to log information about requests

  • systemClockOffset (Number)

    an offset value in milliseconds to apply to all signing times. Use this to compensate for clock skew when your system may be out of sync with the service time. Note that this configuration option can only be applied to the global AWS.config object and cannot be overridden in service-specific configuration. Defaults to 0 milliseconds.

  • signatureVersion (String)

    the signature version to sign requests with (overriding the API configuration). Possible values are: 'v2', 'v3', 'v4'.

  • signatureCache (Boolean)

    whether the signature to sign requests with (overriding the API configuration) is cached. Only applies to the signature version 'v4'. Defaults to true.

  • dynamoDbCrc32 (Boolean)

    whether to validate the CRC32 checksum of HTTP response bodies returned by DynamoDB. Default: true.

  • useAccelerateEndpoint (Boolean)

    Whether to use the S3 Transfer Acceleration endpoint with the S3 service. Default: false.

  • clientSideMonitoring (Boolean)

    whether to collect and publish this client's performance metrics of all its API requests.

  • endpointDiscoveryEnabled (Boolean)

    whether to enable endpoint discovery for operations that allow optionally using an endpoint returned by the service. Defaults to 'false'

  • endpointCacheSize (Number)

    the size of the global cache storing endpoints from endpoint discovery operations. Once endpoint cache is created, updating this setting cannot change existing cache size. Defaults to 1000

  • hostPrefixEnabled (Boolean)

    whether to marshal request parameters to the prefix of hostname. Defaults to true.

  • stsRegionalEndpoints ('legacy'|'regional')

    whether to send sts request to global endpoints or regional endpoints. Defaults to 'legacy'.

Property Details

endpointAWS.Endpoint (readwrite)

Returns an Endpoint object representing the endpoint URL for service requests.

Returns:

  • (AWS.Endpoint)

    an Endpoint object representing the endpoint URL for service requests.

Method Details

cancelIngestion(params = {}, callback) ⇒ AWS.Request

Cancels an on-going ingestion of data into SPICE.

Service Reference:

Examples:

Calling the cancelIngestion operation

var params = {
  AwsAccountId: 'STRING_VALUE', /* required */
  DataSetId: 'STRING_VALUE', /* required */
  IngestionId: 'STRING_VALUE' /* required */
};
quicksight.cancelIngestion(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • AwsAccountId — (String)

      The AWS account ID.

    • DataSetId — (String)

      The ID of the dataset used in the ingestion.

    • IngestionId — (String)

      An ID for the ingestion.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Arn — (String)

        The Amazon Resource Name (ARN) for the data ingestion.

      • IngestionId — (String)

        An ID for the ingestion.

      • RequestId — (String)

        The AWS request ID for this operation.

      • Status — (Integer)

        The http status of the request.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

createDashboard(params = {}, callback) ⇒ AWS.Request

Creates a dashboard from a template. To first create a template, see the CreateTemplate API.

A dashboard is an entity in QuickSight which identifies Quicksight reports, created from analyses. QuickSight dashboards are sharable. With the right permissions, you can create scheduled email reports from them. The CreateDashboard, DescribeDashboard and ListDashboardsByUser APIs act on the dashboard entity. If you have the correct permissions, you can create a dashboard from a template that exists in a different AWS account.

CLI syntax:

aws quicksight create-dashboard --cli-input-json file://create-dashboard.json

Service Reference:

Examples:

Calling the createDashboard operation

var params = {
  AwsAccountId: 'STRING_VALUE', /* required */
  DashboardId: 'STRING_VALUE', /* required */
  Name: 'STRING_VALUE', /* required */
  SourceEntity: { /* required */
    SourceTemplate: {
      Arn: 'STRING_VALUE', /* required */
      DataSetReferences: [ /* required */
        {
          DataSetArn: 'STRING_VALUE', /* required */
          DataSetPlaceholder: 'STRING_VALUE' /* required */
        },
        /* more items */
      ]
    }
  },
  DashboardPublishOptions: {
    AdHocFilteringOption: {
      AvailabilityStatus: ENABLED | DISABLED
    },
    ExportToCSVOption: {
      AvailabilityStatus: ENABLED | DISABLED
    },
    SheetControlsOption: {
      VisibilityState: EXPANDED | COLLAPSED
    }
  },
  Parameters: {
    DateTimeParameters: [
      {
        Name: 'STRING_VALUE', /* required */
        Values: [ /* required */
          new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
          /* more items */
        ]
      },
      /* more items */
    ],
    DecimalParameters: [
      {
        Name: 'STRING_VALUE', /* required */
        Values: [ /* required */
          'NUMBER_VALUE',
          /* more items */
        ]
      },
      /* more items */
    ],
    IntegerParameters: [
      {
        Name: 'STRING_VALUE', /* required */
        Values: [ /* required */
          'NUMBER_VALUE',
          /* more items */
        ]
      },
      /* more items */
    ],
    StringParameters: [
      {
        Name: 'STRING_VALUE', /* required */
        Values: [ /* required */
          'STRING_VALUE',
          /* more items */
        ]
      },
      /* more items */
    ]
  },
  Permissions: [
    {
      Actions: [ /* required */
        'STRING_VALUE',
        /* more items */
      ],
      Principal: 'STRING_VALUE' /* required */
    },
    /* more items */
  ],
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ],
  VersionDescription: 'STRING_VALUE'
};
quicksight.createDashboard(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • AwsAccountId — (String)

      AWS account ID where you want to create the dashboard.

    • DashboardId — (String)

      The ID for the dashboard, also added to IAM policy.

    • Name — (String)

      The display name of the dashboard.

    • Parameters — (map)

      A structure that contains the parameters of the dashboard. These are parameter overrides for a dashboard. A dashboard can have any type of parameters and some parameters might accept multiple values. You could use the following structure to override two string parameters that accept multiple values:

      • StringParameters — (Array<map>)

        String parameters.

        • Namerequired — (String)

          A display name for the dataset.

        • Valuesrequired — (Array<String>)

          Values.

      • IntegerParameters — (Array<map>)

        Integer parameters.

        • Namerequired — (String)

          A display name for the dataset.

        • Valuesrequired — (Array<Integer>)

          Values.

      • DecimalParameters — (Array<map>)

        Decimal parameters.

        • Namerequired — (String)

          A display name for the dataset.

        • Valuesrequired — (Array<Float>)

          Values.

      • DateTimeParameters — (Array<map>)

        DateTime parameters.

        • Namerequired — (String)

          A display name for the dataset.

        • Valuesrequired — (Array<Date>)

          Values.

    • Permissions — (Array<map>)

      A structure that contains the permissions of the dashboard. You can use this for granting permissions with principal and action information.

      • Principalrequired — (String)

        The ARN of a QuickSight user or group, or an IAM ARN. If you are using cross-account resource sharing, this is the IAM ARN of an account root. Otherwise, it is the ARN of a QuickSight user or group. .

      • Actionsrequired — (Array<String>)

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

    • SourceEntity — (map)

      Source entity from which the dashboard is created. The souce entity accepts the ARN of the source template or analysis and also references the replacement datasets for the placeholders set when creating the template. The replacement datasets need to follow the same schema as the datasets for which placeholders were created when creating the template.

      If you are creating a dashboard from a source entity in a different AWS account, use the ARN of the source template.

      • SourceTemplate — (map)

        Source template.

        • DataSetReferencesrequired — (Array<map>)

          Dataset references.

          • DataSetPlaceholderrequired — (String)

            Dataset placeholder.

          • DataSetArnrequired — (String)

            Dataset ARN.

        • Arnrequired — (String)

          The Amazon Resource name (ARN) of the resource.

    • Tags — (Array<map>)

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

      • Keyrequired — (String)

        Tag key.

      • Valuerequired — (String)

        Tag value.

    • VersionDescription — (String)

      A description for the first version of the dashboard being created.

    • DashboardPublishOptions — (map)

      Publishing options when creating dashboard.

      • AvailabilityStatus for AdHocFilteringOption - This can be either ENABLED or DISABLED. When This is set to set to DISABLED, QuickSight disables the left filter pane on the published dashboard, which can be used for AdHoc filtering. Enabled by default.

      • AvailabilityStatus for ExportToCSVOption - This can be either ENABLED or DISABLED. The visual option to export data to CSV is disabled when this is set to DISABLED. Enabled by default.

      • VisibilityState for SheetControlsOption - This can be either COLLAPSED or EXPANDED. The sheet controls pane is collapsed by default when set to true. Collapsed by default.

      Shorthand Syntax:

      AdHocFilteringDisabled=boolean,ExportToCSVDisabled=boolean,SheetControlsCollapsed=boolean

      • AdHocFilteringOption — (map)

        Ad hoc filtering option.

        • AvailabilityStatus — (String)

          Availability status.

          Possible values include:
          • "ENABLED"
          • "DISABLED"
      • ExportToCSVOption — (map)

        Export to CSV option.

        • AvailabilityStatus — (String)

          Availability status.

          Possible values include:
          • "ENABLED"
          • "DISABLED"
      • SheetControlsOption — (map)

        Sheet controls option.

        • VisibilityState — (String)

          Visibility state.

          Possible values include:
          • "EXPANDED"
          • "COLLAPSED"

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Arn — (String)

        The ARN of the dashboard.

      • VersionArn — (String)

        The ARN of the dashboard, including the version number of the first version that is created.

      • DashboardId — (String)

        The ID for the dashboard.

      • CreationStatus — (String)

        The creation status of the dashboard create request.

        Possible values include:
        • "CREATION_IN_PROGRESS"
        • "CREATION_SUCCESSFUL"
        • "CREATION_FAILED"
        • "UPDATE_IN_PROGRESS"
        • "UPDATE_SUCCESSFUL"
        • "UPDATE_FAILED"
      • Status — (Integer)

        The http status of the request.

      • RequestId — (String)

        The AWS request ID for this operation.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

createDataSet(params = {}, callback) ⇒ AWS.Request

Creates a dataset.

CLI syntax:

aws quicksight create-data-set \

--aws-account-id=111122223333 \

--data-set-id=unique-data-set-id \

--name='My dataset' \

--import-mode=SPICE \

--physical-table-map='{

"physical-table-id": {

"RelationalTable": {

"DataSourceArn": "arn:aws:quicksight:us-west-2:111111111111:datasource/data-source-id",

"Name": "table1",

"InputColumns": [

{

"Name": "column1",

"Type": "STRING"

}

]

}

}'

Service Reference:

Examples:

Calling the createDataSet operation

var params = {
  AwsAccountId: 'STRING_VALUE', /* required */
  DataSetId: 'STRING_VALUE', /* required */
  ImportMode: SPICE | DIRECT_QUERY, /* required */
  Name: 'STRING_VALUE', /* required */
  PhysicalTableMap: { /* required */
    '<PhysicalTableId>': {
      CustomSql: {
        DataSourceArn: 'STRING_VALUE', /* required */
        Name: 'STRING_VALUE', /* required */
        SqlQuery: 'STRING_VALUE', /* required */
        Columns: [
          {
            Name: 'STRING_VALUE', /* required */
            Type: STRING | INTEGER | DECIMAL | DATETIME | BIT | BOOLEAN | JSON /* required */
          },
          /* more items */
        ]
      },
      RelationalTable: {
        DataSourceArn: 'STRING_VALUE', /* required */
        InputColumns: [ /* required */
          {
            Name: 'STRING_VALUE', /* required */
            Type: STRING | INTEGER | DECIMAL | DATETIME | BIT | BOOLEAN | JSON /* required */
          },
          /* more items */
        ],
        Name: 'STRING_VALUE', /* required */
        Schema: 'STRING_VALUE'
      },
      S3Source: {
        DataSourceArn: 'STRING_VALUE', /* required */
        InputColumns: [ /* required */
          {
            Name: 'STRING_VALUE', /* required */
            Type: STRING | INTEGER | DECIMAL | DATETIME | BIT | BOOLEAN | JSON /* required */
          },
          /* more items */
        ],
        UploadSettings: {
          ContainsHeader: true || false,
          Delimiter: 'STRING_VALUE',
          Format: CSV | TSV | CLF | ELF | XLSX | JSON,
          StartFromRow: 'NUMBER_VALUE',
          TextQualifier: DOUBLE_QUOTE | SINGLE_QUOTE
        }
      }
    },
    /* '<PhysicalTableId>': ... */
  },
  ColumnGroups: [
    {
      GeoSpatialColumnGroup: {
        Columns: [ /* required */
          'STRING_VALUE',
          /* more items */
        ],
        CountryCode: US, /* required */
        Name: 'STRING_VALUE' /* required */
      }
    },
    /* more items */
  ],
  LogicalTableMap: {
    '<LogicalTableId>': {
      Alias: 'STRING_VALUE', /* required */
      Source: { /* required */
        JoinInstruction: {
          LeftOperand: 'STRING_VALUE', /* required */
          OnClause: 'STRING_VALUE', /* required */
          RightOperand: 'STRING_VALUE', /* required */
          Type: INNER | OUTER | LEFT | RIGHT /* required */
        },
        PhysicalTableId: 'STRING_VALUE'
      },
      DataTransforms: [
        {
          CastColumnTypeOperation: {
            ColumnName: 'STRING_VALUE', /* required */
            NewColumnType: STRING | INTEGER | DECIMAL | DATETIME, /* required */
            Format: 'STRING_VALUE'
          },
          CreateColumnsOperation: {
            Columns: [ /* required */
              {
                ColumnId: 'STRING_VALUE', /* required */
                ColumnName: 'STRING_VALUE', /* required */
                Expression: 'STRING_VALUE' /* required */
              },
              /* more items */
            ]
          },
          FilterOperation: {
            ConditionExpression: 'STRING_VALUE' /* required */
          },
          ProjectOperation: {
            ProjectedColumns: [ /* required */
              'STRING_VALUE',
              /* more items */
            ]
          },
          RenameColumnOperation: {
            ColumnName: 'STRING_VALUE', /* required */
            NewColumnName: 'STRING_VALUE' /* required */
          },
          TagColumnOperation: {
            ColumnName: 'STRING_VALUE', /* required */
            Tags: [ /* required */
              {
                ColumnGeographicRole: COUNTRY | STATE | COUNTY | CITY | POSTCODE | LONGITUDE | LATITUDE
              },
              /* more items */
            ]
          }
        },
        /* more items */
      ]
    },
    /* '<LogicalTableId>': ... */
  },
  Permissions: [
    {
      Actions: [ /* required */
        'STRING_VALUE',
        /* more items */
      ],
      Principal: 'STRING_VALUE' /* required */
    },
    /* more items */
  ],
  RowLevelPermissionDataSet: {
    Arn: 'STRING_VALUE', /* required */
    PermissionPolicy: GRANT_ACCESS | DENY_ACCESS /* required */
  },
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
quicksight.createDataSet(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • AwsAccountId — (String)

      The AWS Account ID.

    • DataSetId — (String)

      An ID for the dataset you want to create. This is unique per region per AWS account.

    • Name — (String)

      The display name for the dataset.

    • PhysicalTableMap — (map<map>)

      Declares the physical tables that are available in the underlying data sources.

      • RelationalTable — (map)

        A physical table type for relational data sources.

        • DataSourceArnrequired — (String)

          Data source ARN.

        • Schema — (String)

          The schema name. Applies to certain relational database engines.

        • Namerequired — (String)

          Name of the relational table.

        • InputColumnsrequired — (Array<map>)

          The column schema of the table.

          • Namerequired — (String)

            The name of this column in the underlying data source.

          • Typerequired — (String)

            The data type of the column.

            Possible values include:
            • "STRING"
            • "INTEGER"
            • "DECIMAL"
            • "DATETIME"
            • "BIT"
            • "BOOLEAN"
            • "JSON"
      • CustomSql — (map)

        A physical table type built from the results of the custom SQL query.

        • DataSourceArnrequired — (String)

          The ARN of the data source.

        • Namerequired — (String)

          A display name for the SQL query result.

        • SqlQueryrequired — (String)

          The SQL query.

        • Columns — (Array<map>)

          The column schema from the SQL query result set.

          • Namerequired — (String)

            The name of this column in the underlying data source.

          • Typerequired — (String)

            The data type of the column.

            Possible values include:
            • "STRING"
            • "INTEGER"
            • "DECIMAL"
            • "DATETIME"
            • "BIT"
            • "BOOLEAN"
            • "JSON"
      • S3Source — (map)

        A physical table type for as S3 data source.

        • DataSourceArnrequired — (String)

          Data source ARN.

        • UploadSettings — (map)

          Information on the S3 source file(s) format.

          • Format — (String)

            File format.

            Possible values include:
            • "CSV"
            • "TSV"
            • "CLF"
            • "ELF"
            • "XLSX"
            • "JSON"
          • StartFromRow — (Integer)

            A row number to start reading data from.

          • ContainsHeader — (Boolean)

            Whether or not the file(s) has a header row.

          • TextQualifier — (String)

            Text qualifier.

            Possible values include:
            • "DOUBLE_QUOTE"
            • "SINGLE_QUOTE"
          • Delimiter — (String)

            The delimiter between values in the file.

        • InputColumnsrequired — (Array<map>)

          A physical table type for as S3 data source.

          • Namerequired — (String)

            The name of this column in the underlying data source.

          • Typerequired — (String)

            The data type of the column.

            Possible values include:
            • "STRING"
            • "INTEGER"
            • "DECIMAL"
            • "DATETIME"
            • "BIT"
            • "BOOLEAN"
            • "JSON"
    • LogicalTableMap — (map<map>)

      Configures the combination and transformation of the data from the physical tables.

      • Aliasrequired — (String)

        A display name for the logical table.

      • DataTransforms — (Array<map>)

        Transform operations that act on this logical table.

        • ProjectOperation — (map)

          An operation that projects columns. Operations that come after a projection can only refer to projected columns.

          • ProjectedColumnsrequired — (Array<String>)

            Projected columns.

        • FilterOperation — (map)

          An operation that filters rows based on some condition.

          • ConditionExpressionrequired — (String)

            An expression that must evaluate to a boolean value. Rows for which the expression is evaluated to true are kept in the dataset.

        • CreateColumnsOperation — (map)

          An operation that creates calculated columns. Columns created in one such operation form a lexical closure.

          • Columnsrequired — (Array<map>)

            Calculated columns to create.

            • ColumnNamerequired — (String)

              Column name.

            • ColumnIdrequired — (String)

              A unique ID to identify a calculated column. During dataset update, if the column ID of a calculated column matches that of an existing calculated column, QuickSight preserves the existing calculated column.

            • Expressionrequired — (String)

              An expression that defines the calculated column.

        • RenameColumnOperation — (map)

          An operation that renames a column.

          • ColumnNamerequired — (String)

            Name of the column to be renamed.

          • NewColumnNamerequired — (String)

            New name for the column.

        • CastColumnTypeOperation — (map)

          A transform operation that casts a column to a different type.

          • ColumnNamerequired — (String)

            Column name.

          • NewColumnTyperequired — (String)

            New column data type.

            Possible values include:
            • "STRING"
            • "INTEGER"
            • "DECIMAL"
            • "DATETIME"
          • Format — (String)

            When casting a column from string to datetime type, you can supply a QuickSight supported format string to denote the source data format.

        • TagColumnOperation — (map)

          An operation that tags a column with additional information.

          • ColumnNamerequired — (String)

            The column that this operation acts on.

          • Tagsrequired — (Array<map>)

            The dataset column tag, currently only used for geospatial type tagging. .

            Note: This is not tags for the AWS tagging feature. .
            • ColumnGeographicRole — (String)

              A geospatial role for a column.

              Possible values include:
              • "COUNTRY"
              • "STATE"
              • "COUNTY"
              • "CITY"
              • "POSTCODE"
              • "LONGITUDE"
              • "LATITUDE"
      • Sourcerequired — (map)

        Source of this logical table.

        • JoinInstruction — (map)

          Specifies the result of a join of two logical tables.

          • LeftOperandrequired — (String)

            Left operand.

          • RightOperandrequired — (String)

            Right operand.

          • Typerequired — (String)

            Type.

            Possible values include:
            • "INNER"
            • "OUTER"
            • "LEFT"
            • "RIGHT"
          • OnClauserequired — (String)

            On Clause.

        • PhysicalTableId — (String)

          Physical table ID.

    • ImportMode — (String)

      Indicates whether or not you want to import the data into SPICE.

      Possible values include:
      • "SPICE"
      • "DIRECT_QUERY"
    • ColumnGroups — (Array<map>)

      Groupings of columns that work together in certain QuickSight features. Currently only geospatial hierarchy is supported.

      • GeoSpatialColumnGroup — (map)

        Geospatial column group that denotes a hierarchy.

        • Namerequired — (String)

          A display name for the hierarchy.

        • CountryCoderequired — (String)

          Country code.

          Possible values include:
          • "US"
        • Columnsrequired — (Array<String>)

          Columns in this hierarchy.

    • Permissions — (Array<map>)

      A list of resource permissions on the dataset.

      • Principalrequired — (String)

        The ARN of a QuickSight user or group, or an IAM ARN. If you are using cross-account resource sharing, this is the IAM ARN of an account root. Otherwise, it is the ARN of a QuickSight user or group. .

      • Actionsrequired — (Array<String>)

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

    • RowLevelPermissionDataSet — (map)

      Row-level security configuration on the data you want to create.

      • Arnrequired — (String)

        The Amazon Resource name (ARN) of the permission dataset.

      • PermissionPolicyrequired — (String)

        Permission policy.

        Possible values include:
        • "GRANT_ACCESS"
        • "DENY_ACCESS"
    • Tags — (Array<map>)

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

      • Keyrequired — (String)

        Tag key.

      • Valuerequired — (String)

        Tag value.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Arn — (String)

        The ARN of the dataset.

      • DataSetId — (String)

        The ID for the dataset you want to create. This is unique per region per AWS account.

      • IngestionArn — (String)

        The Amazon Resource Name (ARN) for the ingestion, which is triggered as a result of dataset creation if the import mode is SPICE

      • IngestionId — (String)

        The ID of the ingestion, which is triggered as a result of dataset creation if the import mode is SPICE

      • RequestId — (String)

        The AWS request ID for this operation.

      • Status — (Integer)

        The http status of the request.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

createDataSource(params = {}, callback) ⇒ AWS.Request

Creates a data source.

The permissions resource is arn:aws:quicksight:region:aws-account-id:datasource/data-source-id

CLI syntax:

aws quicksight create-data-source \

--aws-account-id=111122223333 \

--data-source-id=unique-data-source-id \

--name='My Data Source' \

--type=POSTGRESQL \

--data-source-parameters='{ "PostgreSqlParameters": {

"Host": "my-db-host.example.com",

"Port": 1234,

"Database": "my-db" } }' \

--credentials='{ "CredentialPair": {

"Username": "username",

"Password": "password" } }'

Service Reference:

Examples:

Calling the createDataSource operation

var params = {
  AwsAccountId: 'STRING_VALUE', /* required */
  DataSourceId: 'STRING_VALUE', /* required */
  Name: 'STRING_VALUE', /* required */
  Type: 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, /* required */
  Credentials: {
    CredentialPair: {
      Password: 'STRING_VALUE', /* required */
      Username: 'STRING_VALUE' /* required */
    }
  },
  DataSourceParameters: {
    AmazonElasticsearchParameters: {
      Domain: 'STRING_VALUE' /* required */
    },
    AthenaParameters: {
      WorkGroup: 'STRING_VALUE'
    },
    AuroraParameters: {
      Database: 'STRING_VALUE', /* required */
      Host: 'STRING_VALUE', /* required */
      Port: 'NUMBER_VALUE' /* required */
    },
    AuroraPostgreSqlParameters: {
      Database: 'STRING_VALUE', /* required */
      Host: 'STRING_VALUE', /* required */
      Port: 'NUMBER_VALUE' /* required */
    },
    AwsIotAnalyticsParameters: {
      DataSetName: 'STRING_VALUE' /* required */
    },
    JiraParameters: {
      SiteBaseUrl: 'STRING_VALUE' /* required */
    },
    MariaDbParameters: {
      Database: 'STRING_VALUE', /* required */
      Host: 'STRING_VALUE', /* required */
      Port: 'NUMBER_VALUE' /* required */
    },
    MySqlParameters: {
      Database: 'STRING_VALUE', /* required */
      Host: 'STRING_VALUE', /* required */
      Port: 'NUMBER_VALUE' /* required */
    },
    PostgreSqlParameters: {
      Database: 'STRING_VALUE', /* required */
      Host: 'STRING_VALUE', /* required */
      Port: 'NUMBER_VALUE' /* required */
    },
    PrestoParameters: {
      Catalog: 'STRING_VALUE', /* required */
      Host: 'STRING_VALUE', /* required */
      Port: 'NUMBER_VALUE' /* required */
    },
    RdsParameters: {
      Database: 'STRING_VALUE', /* required */
      InstanceId: 'STRING_VALUE' /* required */
    },
    RedshiftParameters: {
      Database: 'STRING_VALUE', /* required */
      ClusterId: 'STRING_VALUE',
      Host: 'STRING_VALUE',
      Port: 'NUMBER_VALUE'
    },
    S3Parameters: {
      ManifestFileLocation: { /* required */
        Bucket: 'STRING_VALUE', /* required */
        Key: 'STRING_VALUE' /* required */
      }
    },
    ServiceNowParameters: {
      SiteBaseUrl: 'STRING_VALUE' /* required */
    },
    SnowflakeParameters: {
      Database: 'STRING_VALUE', /* required */
      Host: 'STRING_VALUE', /* required */
      Warehouse: 'STRING_VALUE' /* required */
    },
    SparkParameters: {
      Host: 'STRING_VALUE', /* required */
      Port: 'NUMBER_VALUE' /* required */
    },
    SqlServerParameters: {
      Database: 'STRING_VALUE', /* required */
      Host: 'STRING_VALUE', /* required */
      Port: 'NUMBER_VALUE' /* required */
    },
    TeradataParameters: {
      Database: 'STRING_VALUE', /* required */
      Host: 'STRING_VALUE', /* required */
      Port: 'NUMBER_VALUE' /* required */
    },
    TwitterParameters: {
      MaxRows: 'NUMBER_VALUE', /* required */
      Query: 'STRING_VALUE' /* required */
    }
  },
  Permissions: [
    {
      Actions: [ /* required */
        'STRING_VALUE',
        /* more items */
      ],
      Principal: 'STRING_VALUE' /* required */
    },
    /* more items */
  ],
  SslProperties: {
    DisableSsl: true || false
  },
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ],
  VpcConnectionProperties: {
    VpcConnectionArn: 'STRING_VALUE' /* required */
  }
};
quicksight.createDataSource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • AwsAccountId — (String)

      The AWS account ID.

    • DataSourceId — (String)

      An ID for the data source. This is unique per AWS Region per 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 include:
      • "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"
    • DataSourceParameters — (map)

      The parameters QuickSight uses to connect to your underlying source.

      • AmazonElasticsearchParameters — (map)

        Amazon Elasticsearch parameters.

        • Domainrequired — (String)

          The Amazon Elasticsearch domain.

      • AthenaParameters — (map)

        Athena parameters.

        • WorkGroup — (String)

          The workgroup that Athena uses.

      • AuroraParameters — (map)

        Aurora MySQL parameters.

        • Hostrequired — (String)

          Host.

        • Portrequired — (Integer)

          Port.

        • Databaserequired — (String)

          Database.

      • AuroraPostgreSqlParameters — (map)

        Aurora PostgreSQL parameters.

        • Hostrequired — (String)

          Host.

        • Portrequired — (Integer)

          Port.

        • Databaserequired — (String)

          Database.

      • AwsIotAnalyticsParameters — (map)

        AWS IoT Analytics parameters.

        • DataSetNamerequired — (String)

          Dataset name.

      • JiraParameters — (map)

        Jira parameters.

        • SiteBaseUrlrequired — (String)

          The base URL of the Jira site.

      • MariaDbParameters — (map)

        MariaDB parameters.

        • Hostrequired — (String)

          Host.

        • Portrequired — (Integer)

          Port.

        • Databaserequired — (String)

          Database.

      • MySqlParameters — (map)

        MySQL parameters.

        • Hostrequired — (String)

          Host.

        • Portrequired — (Integer)

          Port.

        • Databaserequired — (String)

          Database.

      • PostgreSqlParameters — (map)

        PostgreSQL parameters.

        • Hostrequired — (String)

          Host.

        • Portrequired — (Integer)

          Port.

        • Databaserequired — (String)

          Database.

      • PrestoParameters — (map)

        Presto parameters.

        • Hostrequired — (String)

          Host.

        • Portrequired — (Integer)

          Port.

        • Catalogrequired — (String)

          Catalog.

      • RdsParameters — (map)

        RDS parameters.

        • InstanceIdrequired — (String)

          Instance ID.

        • Databaserequired — (String)

          Database.

      • RedshiftParameters — (map)

        Redshift parameters.

        • Host — (String)

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

        • Port — (Integer)

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

        • Databaserequired — (String)

          Database.

        • ClusterId — (String)

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

      • S3Parameters — (map)

        S3 parameters.

        • ManifestFileLocationrequired — (map)

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

          • Bucketrequired — (String)

            Amazon S3 bucket.

          • Keyrequired — (String)

            Amazon S3 key that identifies an object.

      • ServiceNowParameters — (map)

        ServiceNow parameters.

        • SiteBaseUrlrequired — (String)

          URL of the base site.

      • SnowflakeParameters — (map)

        Snowflake parameters.

        • Hostrequired — (String)

          Host.

        • Databaserequired — (String)

          Database.

        • Warehouserequired — (String)

          Warehouse.

      • SparkParameters — (map)

        Spark parameters.

        • Hostrequired — (String)

          Host.

        • Portrequired — (Integer)

          Port.

      • SqlServerParameters — (map)

        SQL Server parameters.

        • Hostrequired — (String)

          Host.

        • Portrequired — (Integer)

          Port.

        • Databaserequired — (String)

          Database.

      • TeradataParameters — (map)

        Teradata parameters.

        • Hostrequired — (String)

          Host.

        • Portrequired — (Integer)

          Port.

        • Databaserequired — (String)

          Database.

      • TwitterParameters — (map)

        Twitter parameters.

        • Queryrequired — (String)

          Twitter query string.

        • MaxRowsrequired — (Integer)

          Maximum number of rows to query Twitter.

    • Credentials — (map)

      The credentials QuickSight uses to connect to your underlying source. Currently only username/password based credentials are supported.

      • CredentialPair — (map)

        Credential pair.

        • Usernamerequired — (String)

          Username.

        • Passwordrequired — (String)

          Password.

    • Permissions — (Array<map>)

      A list of resource permissions on the data source.

      • Principalrequired — (String)

        The ARN of a QuickSight user or group, or an IAM ARN. If you are using cross-account resource sharing, this is the IAM ARN of an account root. Otherwise, it is the ARN of a QuickSight user or group. .

      • Actionsrequired — (Array<String>)

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

    • VpcConnectionProperties — (map)

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

      • VpcConnectionArnrequired — (String)

        VPC connection ARN.

    • SslProperties — (map)

      SSL properties that apply when QuickSight connects to your underlying source.

      • DisableSsl — (Boolean)

        A boolean flag to control whether SSL should be disabled.

    • Tags — (Array<map>)

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

      • Keyrequired — (String)

        Tag key.

      • Valuerequired — (String)

        Tag value.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Arn — (String)

        The ARN of the data source.

      • DataSourceId — (String)

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

      • CreationStatus — (String)

        The status of creating the data source.

        Possible values include:
        • "CREATION_IN_PROGRESS"
        • "CREATION_SUCCESSFUL"
        • "CREATION_FAILED"
        • "UPDATE_IN_PROGRESS"
        • "UPDATE_SUCCESSFUL"
        • "UPDATE_FAILED"
      • RequestId — (String)

        The AWS request ID for this operation.

      • Status — (Integer)

        The http status of the request.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

createGroup(params = {}, callback) ⇒ AWS.Request

Creates an Amazon QuickSight group.

The permissions resource is arn:aws:quicksight:us-east-1:<relevant-aws-account-id>:group/default/<group-name> .

The response is a group object.

CLI Sample:

aws quicksight create-group --aws-account-id=111122223333 --namespace=default --group-name="Sales-Management" --description="Sales Management - Forecasting"

Service Reference:

Examples:

Calling the createGroup operation

var params = {
  AwsAccountId: 'STRING_VALUE', /* required */
  GroupName: 'STRING_VALUE', /* required */
  Namespace: 'STRING_VALUE', /* required */
  Description: 'STRING_VALUE'
};
quicksight.createGroup(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • GroupName — (String)

      A name for the group that you want to create.

    • Description — (String)

      A description for the group that you want to create.

    • AwsAccountId — (String)

      The ID for the AWS account that the group is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.

    • Namespace — (String)

      The namespace. Currently, you should set this to default.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Group — (map)

        The name of the group.

        • Arn — (String)

          The Amazon Resource name (ARN) for the group.

        • GroupName — (String)

          The name of the group.

        • Description — (String)

          The group description.

        • PrincipalId — (String)

          The principal ID of the group.

      • RequestId — (String)

        The AWS request ID for this operation.

      • Status — (Integer)

        The http status of the request.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

createGroupMembership(params = {}, callback) ⇒ AWS.Request

Adds an Amazon QuickSight user to an Amazon QuickSight group.

The permissions resource is arn:aws:quicksight:us-east-1:<aws-account-id>:group/default/<group-name> .

The condition resource is the user name.

The condition key is quicksight:UserName.

The response is the group member object.

CLI Sample:

aws quicksight create-group-membership --aws-account-id=111122223333 --namespace=default --group-name=Sales --member-name=Pat

Service Reference:

Examples:

Calling the createGroupMembership operation

var params = {
  AwsAccountId: 'STRING_VALUE', /* required */
  GroupName: 'STRING_VALUE', /* required */
  MemberName: 'STRING_VALUE', /* required */
  Namespace: 'STRING_VALUE' /* required */
};
quicksight.createGroupMembership(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • MemberName — (String)

      The name of the user that you want to add to the group membership.

    • GroupName — (String)

      The name of the group that you want to add the user to.

    • AwsAccountId — (String)

      The ID for the AWS account that the group is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.

    • Namespace — (String)

      The namespace. Currently, you should set this to default.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • GroupMember — (map)

        The group member.

        • Arn — (String)

          The Amazon Resource name (ARN) for the group member (user).

        • MemberName — (String)

          The name of the group member (user).

      • RequestId — (String)

        The AWS request ID for this operation.

      • Status — (Integer)

        The http status of the request.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

createIAMPolicyAssignment(params = {}, callback) ⇒ AWS.Request

Creates an assignment with one specified IAM policy ARN and will assigned to specified groups or users of QuickSight. Users and groups need to be in the same namespace.

CLI syntax:

aws quicksight create-iam-policy-assignment --aws-account-id=111122223333 --assignment-name=helpAssignment --policy-arn=arn:aws:iam::aws:policy/AdministratorAccess --identities="user=user5,engineer123,group=QS-Admin" --namespace=default --region=us-west-2

Service Reference:

Examples:

Calling the createIAMPolicyAssignment operation

var params = {
  AssignmentName: 'STRING_VALUE', /* required */
  AssignmentStatus: ENABLED | DRAFT | DISABLED, /* required */
  AwsAccountId: 'STRING_VALUE', /* required */
  Namespace: 'STRING_VALUE', /* required */
  Identities: {
    '<String>': [
      'STRING_VALUE',
      /* more items */
    ],
    /* '<String>': ... */
  },
  PolicyArn: 'STRING_VALUE'
};
quicksight.createIAMPolicyAssignment(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • AwsAccountId — (String)

      The AWS Account ID where you want to assign QuickSight users or groups to an IAM policy.

    • AssignmentName — (String)

      The name of the assignment. It must be unique within an AWS account.

    • AssignmentStatus — (String)

      The status of an assignment:

      • ENABLED - Anything specified in this assignment is used while creating the data source.

      • DISABLED - This assignment isn't used while creating the data source.

      • DRAFT - Assignment is an unfinished draft and isn't used while creating the data source.

      Possible values include:
      • "ENABLED"
      • "DRAFT"
      • "DISABLED"
    • PolicyArn — (String)

      An IAM policy ARN that you want to apply to the QuickSight users and groups specified in this assignment.

    • Identities — (map<Array<String>>)

      QuickSight users and/or groups that you want to assign the policy to.

    • Namespace — (String)

      The namespace that contains the assignment.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • AssignmentName — (String)

        The name of the assignment. Must be unique within an AWS account.

      • AssignmentId — (String)

        An ID for the assignment.

      • AssignmentStatus — (String)

        The status of an assignment:

        • ENABLED - Anything specified in this assignment is used while creating the data source.

        • DISABLED - This assignment isn't used while creating the data source.

        • DRAFT - Assignment is an unfinished draft and isn't used while creating the data source.

        Possible values include:
        • "ENABLED"
        • "DRAFT"
        • "DISABLED"
      • PolicyArn — (String)

        An IAM policy ARN that is applied to the QuickSight users and groups specified in this assignment.

      • Identities — (map<Array<String>>)

        QuickSight users and/or groups that are assigned to the IAM policy.

      • RequestId — (String)

        The AWS request ID for this operation.

      • Status — (Integer)

        The http status of the request.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

createIngestion(params = {}, callback) ⇒ AWS.Request

Creates and starts a new SPICE ingestion on a dataset

Any ingestions operating on tagged datasets inherit the same tags automatically for use in access-control. For an example, see How do I create an IAM policy to control access to Amazon EC2 resources using tags?. Tags will be visible on the tagged dataset, but not on the ingestion resource.

Service Reference:

Examples:

Calling the createIngestion operation

var params = {
  AwsAccountId: 'STRING_VALUE', /* required */
  DataSetId: 'STRING_VALUE', /* required */
  IngestionId: 'STRING_VALUE' /* required */
};
quicksight.createIngestion(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • DataSetId — (String)

      The ID of the dataset used in the ingestion.

    • IngestionId — (String)

      An ID for the ingestion.

    • AwsAccountId — (String)

      The AWS account ID.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Arn — (String)

        The Amazon Resource Name (ARN) for the data ingestion.

      • IngestionId — (String)

        An ID for the ingestion.

      • IngestionStatus — (String)

        The ingestion status.

        Possible values include:
        • "INITIALIZED"
        • "QUEUED"
        • "RUNNING"
        • "FAILED"
        • "COMPLETED"
        • "CANCELLED"
      • RequestId — (String)

        The AWS request ID for this operation.

      • Status — (Integer)

        The http status of the request.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

createTemplate(params = {}, callback) ⇒ AWS.Request

Creates a template from an existing QuickSight analysis or template. The resulting template can be used to create a dashboard.

A template is an entity in QuickSight which encapsulates the metadata required to create an analysis that can be used to create dashboard. It adds a layer of abstraction by use placeholders to replace the dataset associated with the analysis. You can use templates to create dashboards by replacing dataset placeholders with datasets which follow the same schema that was used to create the source analysis and template.

To create a template from an existing analysis, use the analysis's ARN, aws-account-id, template-id, source-entity, and data-set-references.

CLI syntax to create a template:

aws quicksight create-template —cli-input-json file://create-template.json

CLI syntax to create a template from another template in the same AWS account:

aws quicksight create-template --aws-account-id 111122223333 --template-id reports_test_template --data-set-references DataSetPlaceholder=reports,DataSetArn=arn:aws:quicksight:us-west-2:111122223333:dataset/0dfc789c-81f6-4f4f-b9ac-7db2453eefc8 DataSetPlaceholder=Elblogs,DataSetArn=arn:aws:quicksight:us-west-2:111122223333:dataset/f60da323-af68-45db-9016-08e0d1d7ded5 --source-entity SourceAnalysis='{Arn=arn:aws:quicksight:us-west-2:111122223333:analysis/7fb74527-c36d-4be8-8139-ac1be4c97365}'

To create template from another account’s template, you need to grant cross account resource permission for DescribeTemplate the account that contains the template.

You can use a file to pass JSON to the function if you prefer.

Service Reference:

Examples:

Calling the createTemplate operation

var params = {
  AwsAccountId: 'STRING_VALUE', /* required */
  SourceEntity: { /* required */
    SourceAnalysis: {
      Arn: 'STRING_VALUE', /* required */
      DataSetReferences: [ /* required */
        {
          DataSetArn: 'STRING_VALUE', /* required */
          DataSetPlaceholder: 'STRING_VALUE' /* required */
        },
        /* more items */
      ]
    },
    SourceTemplate: {
      Arn: 'STRING_VALUE' /* required */
    }
  },
  TemplateId: 'STRING_VALUE', /* required */
  Name: 'STRING_VALUE',
  Permissions: [
    {
      Actions: [ /* required */
        'STRING_VALUE',
        /* more items */
      ],
      Principal: 'STRING_VALUE' /* required */
    },
    /* more items */
  ],
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ],
  VersionDescription: 'STRING_VALUE'
};
quicksight.createTemplate(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • AwsAccountId — (String)

      The ID for the AWS account that the group is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.

    • TemplateId — (String)

      An ID for the template you want to create. This is unique per AWS region per AWS account.

    • Name — (String)

      A display name for the template.

    • Permissions — (Array<map>)

      A list of resource permissions to be set on the template. The shorthand syntax should look similar to this: Shorthand Syntax: Principal=string,Actions=string,string ...

      • Principalrequired — (String)

        The ARN of a QuickSight user or group, or an IAM ARN. If you are using cross-account resource sharing, this is the IAM ARN of an account root. Otherwise, it is the ARN of a QuickSight user or group. .

      • Actionsrequired — (Array<String>)

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

    • SourceEntity — (map)

      The ARN of the source entity from which this template is being created. Templates can be currently created from an analysis or another template. If the ARN is for an analysis, you must include its dataset references.

      • SourceAnalysis — (map)

        The source analysis, if it is based on an analysis.

        • Arnrequired — (String)

          The Amazon Resource name (ARN) of the resource.

        • DataSetReferencesrequired — (Array<map>)

          A structure containing information about the dataset references used as placeholders in the template.

          • DataSetPlaceholderrequired — (String)

            Dataset placeholder.

          • DataSetArnrequired — (String)

            Dataset ARN.

      • SourceTemplate — (map)

        The source template, if it is based on an template.

        • Arnrequired — (String)

          The Amazon Resource name (ARN) of the resource.

    • Tags — (Array<map>)

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

      • Keyrequired — (String)

        Tag key.

      • Valuerequired — (String)

        Tag value.

    • VersionDescription — (String)

      A description of the current template version being created. This API created the first version of the template. Every time UpdateTemplate is called a new version is created. Each version of the template maintains a description of the version in the VersionDescription field.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Arn — (String)

        The Amazon Resource Name (ARN) for the template.

      • VersionArn — (String)

        The Amazon Resource Name (ARN) for the template, including the version information of the first version.

      • TemplateId — (String)

        The ID of the template.

      • CreationStatus — (String)

        The template creation status.

        Possible values include:
        • "CREATION_IN_PROGRESS"
        • "CREATION_SUCCESSFUL"
        • "CREATION_FAILED"
        • "UPDATE_IN_PROGRESS"
        • "UPDATE_SUCCESSFUL"
        • "UPDATE_FAILED"
      • Status — (Integer)

        The http status of the request.

      • RequestId — (String)

        The AWS request ID for this operation.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

createTemplateAlias(params = {}, callback) ⇒ AWS.Request

Creates a template alias for a template.

CLI syntax:

aws quicksight create-template-alias --aws-account-id 111122223333 --template-id 'reports_test_template' --alias-name PROD —version-number 1

Service Reference:

Examples:

Calling the createTemplateAlias operation

var params = {
  AliasName: 'STRING_VALUE', /* required */
  AwsAccountId: 'STRING_VALUE', /* required */
  TemplateId: 'STRING_VALUE', /* required */
  TemplateVersionNumber: 'NUMBER_VALUE' /* required */
};
quicksight.createTemplateAlias(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • AwsAccountId — (String)

      AWS account ID that contains the template you are aliasing.

    • TemplateId — (String)

      An ID for the template.

    • AliasName — (String)

      The name you want to give the template's alias. Alias names can't begin with a $, which is reserved by QuickSight. Alias names that start with ‘$’ sign are QuickSight reserved naming and can't be deleted.

    • TemplateVersionNumber — (Integer)

      The version number of the template.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • TemplateAlias — (map)

        Information on the template alias.

        • AliasName — (String)

          The display name of the template alias.

        • Arn — (String)

          The ARN of the template alias.

        • TemplateVersionNumber — (Integer)

          The version number of the template alias.

      • Status — (Integer)

        The http status of the request.

      • RequestId — (String)

        The AWS request ID for this operation.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

deleteDashboard(params = {}, callback) ⇒ AWS.Request

Deletes a dashboard.

CLI syntax:

aws quicksight delete-dashboard --aws-account-id 111122223333 —dashboard-id 123123123

aws quicksight delete-dashboard --aws-account-id 111122223333 —dashboard-id 123123123 —version-number 3

Service Reference:

Examples:

Calling the deleteDashboard operation

var params = {
  AwsAccountId: 'STRING_VALUE', /* required */
  DashboardId: 'STRING_VALUE', /* required */
  VersionNumber: 'NUMBER_VALUE'
};
quicksight.deleteDashboard(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • AwsAccountId — (String)

      AWS account ID that contains the dashboard you are deleting.

    • DashboardId — (String)

      The ID for the dashboard.

    • VersionNumber — (Integer)

      The version number of the dashboard. If version number property is provided, only the specified version of the dashboard is deleted.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Status — (Integer)

        The http status of the request.

      • Arn — (String)

        The ARN of the resource.

      • DashboardId — (String)

        The ID of the dashboard.

      • RequestId — (String)

        The AWS request ID for this operation.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

deleteDataSet(params = {}, callback) ⇒ AWS.Request

Deletes a dataset.

CLI syntax:

aws quicksight delete-data-set \

--aws-account-id=111111111111 \

--data-set-id=unique-data-set-id

Service Reference:

Examples:

Calling the deleteDataSet operation

var params = {
  AwsAccountId: 'STRING_VALUE', /* required */
  DataSetId: 'STRING_VALUE' /* required */
};
quicksight.deleteDataSet(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • AwsAccountId — (String)

      The AWS Account ID.

    • DataSetId — (String)

      The ID for the dataset you want to create. This is unique per region per AWS account.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Arn — (String)

        The ARN of the dataset.

      • DataSetId — (String)

        The ID for the dataset you want to create. This is unique per region per AWS account.

      • RequestId — (String)

        The AWS request ID for this operation.

      • Status — (Integer)

        The http status of the request.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

deleteDataSource(params = {}, callback) ⇒ AWS.Request

Deletes the data source permanently. This action breaks all the datasets that reference the deleted data source.

CLI syntax:

aws quicksight delete-data-source \

--aws-account-id=111122223333 \

--data-source-id=unique-data-source-id

Service Reference:

Examples:

Calling the deleteDataSource operation

var params = {
  AwsAccountId: 'STRING_VALUE', /* required */
  DataSourceId: 'STRING_VALUE' /* required */
};
quicksight.deleteDataSource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • AwsAccountId — (String)

      The AWS account ID.

    • DataSourceId — (String)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Arn — (String)

        The ARN of the data source you deleted.

      • DataSourceId — (String)

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

      • RequestId — (String)

        The AWS request ID for this operation.

      • Status — (Integer)

        The http status of the request.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

deleteGroup(params = {}, callback) ⇒ AWS.Request

Removes a user group from Amazon QuickSight.

The permissions resource is arn:aws:quicksight:us-east-1:<aws-account-id>:group/default/<group-name> .

CLI Sample:

aws quicksight delete-group --aws-account-id=111122223333 --namespace=default --group-name=Sales-Management

Service Reference:

Examples:

Calling the deleteGroup operation

var params = {
  AwsAccountId: 'STRING_VALUE', /* required */
  GroupName: 'STRING_VALUE', /* required */
  Namespace: 'STRING_VALUE' /* required */
};
quicksight.deleteGroup(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • GroupName — (String)

      The name of the group that you want to delete.

    • AwsAccountId — (String)

      The ID for the AWS account that the group is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.

    • Namespace — (String)

      The namespace. Currently, you should set this to default.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • RequestId — (String)

        The AWS request ID for this operation.

      • Status — (Integer)

        The http status of the request.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

deleteGroupMembership(params = {}, callback) ⇒ AWS.Request

Removes a user from a group so that the user is no longer a member of the group.

The permissions resource is arn:aws:quicksight:us-east-1:<aws-account-id>:group/default/<group-name> .

The condition resource is the user name.

The condition key is quicksight:UserName.

CLI Sample:

aws quicksight delete-group-membership --aws-account-id=111122223333 --namespace=default --group-name=Sales-Management --member-name=Charlie

Service Reference:

Examples:

Calling the deleteGroupMembership operation

var params = {
  AwsAccountId: 'STRING_VALUE', /* required */
  GroupName: 'STRING_VALUE', /* required */
  MemberName: 'STRING_VALUE', /* required */
  Namespace: 'STRING_VALUE' /* required */
};
quicksight.deleteGroupMembership(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • MemberName — (String)

      The name of the user that you want to delete from the group membership.

    • GroupName — (String)

      The name of the group that you want to delete the user from.

    • AwsAccountId — (String)

      The ID for the AWS account that the group is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.

    • Namespace — (String)

      The namespace. Currently, you should set this to default.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • RequestId — (String)

        The AWS request ID for this operation.

      • Status — (Integer)

        The http status of the request.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

deleteIAMPolicyAssignment(params = {}, callback) ⇒ AWS.Request

Deletes an existing assignment.

CLI syntax:

aws quicksight delete-iam-policy-assignment --aws-account-id=111122223333 --assignment-name=testtest --region=us-east-1 --namespace=default

Service Reference:

Examples:

Calling the deleteIAMPolicyAssignment operation

var params = {
  AssignmentName: 'STRING_VALUE', /* required */
  AwsAccountId: 'STRING_VALUE', /* required */
  Namespace: 'STRING_VALUE' /* required */
};
quicksight.deleteIAMPolicyAssignment(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • AwsAccountId — (String)

      The AWS account ID where you want to delete an IAM policy assignment.

    • AssignmentName — (String)

      The name of the assignment.

    • Namespace — (String)

      The namespace that contains the assignment.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • AssignmentName — (String)

        The name of the assignment.

      • RequestId — (String)

        The AWS request ID for this operation.

      • Status — (Integer)

        The http status of the request.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

deleteTemplate(params = {}, callback) ⇒ AWS.Request

Deletes a template.

CLI syntax:

  • aws quicksight delete-template --aws-account-id 111122223333 —-template-id reports_test_template --version-number 2

  • aws quicksight delete-template —aws-account-id 111122223333 —template-id reports_test_template —alias-name STAGING

  • aws quicksight delete-template —aws-account-id 111122223333 —template-id reports_test_template —alias-name ‘\$LATEST’

  • aws quicksight delete-template --aws-account-id 111122223333 —-template-id reports_test_template

If version number which is an optional field is not passed the template (including all the versions) is deleted by the API, if version number is provided, the specific template version is deleted by the API.

Users can explicitly describe the latest version of the template by passing $LATEST to the alias-name parameter. $LATEST is an internally supported alias, which points to the latest version of the template.

Service Reference:

Examples:

Calling the deleteTemplate operation

var params = {
  AwsAccountId: 'STRING_VALUE', /* required */
  TemplateId: 'STRING_VALUE', /* required */
  VersionNumber: 'NUMBER_VALUE'
};
quicksight.deleteTemplate(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • AwsAccountId — (String)

      AWS account ID that contains the template you are deleting.

    • TemplateId — (String)

      An ID for the template you want to delete.

    • VersionNumber — (Integer)

      The version number

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • RequestId — (String)

        The AWS request ID for this operation.

      • Arn — (String)

        The ARN of the resource.

      • TemplateId — (String)

        An ID for the template.

      • Status — (Integer)

        The http status of the request.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

deleteTemplateAlias(params = {}, callback) ⇒ AWS.Request

Update template alias of given template.

CLI syntax:

aws quicksight delete-template-alias --aws-account-id 111122223333 --template-id 'reports_test_template' --alias-name 'STAGING'

Service Reference:

Examples:

Calling the deleteTemplateAlias operation

var params = {
  AliasName: 'STRING_VALUE', /* required */
  AwsAccountId: 'STRING_VALUE', /* required */
  TemplateId: 'STRING_VALUE' /* required */
};
quicksight.deleteTemplateAlias(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • AwsAccountId — (String)

      AWS account ID that contains the template alias you are deleting.

    • TemplateId — (String)

      An ID for the template.

    • AliasName — (String)

      The alias of the template. If alias-name is provided, the version that the alias-name points to is deleted. Alias names that start with $ are reserved by QuickSight and can't be deleted.”

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Status — (Integer)

        The http status of the request.

      • TemplateId — (String)

        An ID for the template.

      • AliasName — (String)

        The name of the alias.

      • Arn — (String)

        The ARN of the resource.

      • RequestId — (String)

        The AWS request ID for this operation.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

deleteUser(params = {}, callback) ⇒ AWS.Request

Deletes the Amazon QuickSight user that is associated with the identity of the AWS Identity and Access Management (IAM) user or role that's making the call. The IAM user isn't deleted as a result of this call.

CLI Sample:

aws quicksight delete-user --aws-account-id=111122223333 --namespace=default --user-name=Pat

Service Reference:

Examples:

Calling the deleteUser operation

var params = {
  AwsAccountId: 'STRING_VALUE', /* required */
  Namespace: 'STRING_VALUE', /* required */
  UserName: 'STRING_VALUE' /* required */
};
quicksight.deleteUser(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • UserName — (String)

      The name of the user that you want to delete.

    • AwsAccountId — (String)

      The ID for the AWS account that the user is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.

    • Namespace — (String)

      The namespace. Currently, you should set this to default.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • RequestId — (String)

        The AWS request ID for this operation.

      • Status — (Integer)

        The http status of the request.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

deleteUserByPrincipalId(params = {}, callback) ⇒ AWS.Request

Deletes a user identified by its principal ID.

CLI Sample:

aws quicksight delete-user-by-principal-id --aws-account-id=111122223333 --namespace=default --principal-id=ABCDEFJA26JLI7EUUOEHS

Service Reference:

Examples:

Calling the deleteUserByPrincipalId operation

var params = {
  AwsAccountId: 'STRING_VALUE', /* required */
  Namespace: 'STRING_VALUE', /* required */
  PrincipalId: 'STRING_VALUE' /* required */
};
quicksight.deleteUserByPrincipalId(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • PrincipalId — (String)

      The principal ID of the user.

    • AwsAccountId — (String)

      The ID for the AWS account that the user is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.

    • Namespace — (String)

      The namespace. Currently, you should set this to default.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • RequestId — (String)

        The AWS request ID for this operation.

      • Status — (Integer)

        The http status of the request.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

describeDashboard(params = {}, callback) ⇒ AWS.Request

Provides a summary for a dashboard.

CLI syntax:

  • aws quicksight describe-dashboard --aws-account-id 111122223333 —dashboard-id reports_test_report -version-number 2

  • aws quicksight describe-dashboard --aws-account-id 111122223333 —dashboard-id reports_test_report -alias-name ‘$PUBLISHED’

Service Reference:

Examples:

Calling the describeDashboard operation

var params = {
  AwsAccountId: 'STRING_VALUE', /* required */
  DashboardId: 'STRING_VALUE', /* required */
  AliasName: 'STRING_VALUE',
  VersionNumber: 'NUMBER_VALUE'
};
quicksight.describeDashboard(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • AwsAccountId — (String)

      AWS account ID that contains the dashboard you are describing.

    • DashboardId — (String)

      The ID for the dashboard.

    • VersionNumber — (Integer)

      The version number for the dashboard. If version number isn’t passed the latest published dashboard version is described.

    • AliasName — (String)

      The alias name.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Dashboard — (map)

        Information about the dashboard.

        • DashboardId — (String)

          Dashboard ID.

        • Arn — (String)

          The Amazon Resource name (ARN) of the resource.

        • Name — (String)

          A display name for the dataset.

        • Version — (map)

          Version.

          • CreatedTime — (Date)

            The time this was created.

          • Errors — (Array<map>)

            Errors.

            • Type — (String)

              Type.

              Possible values include:
              • "DATA_SET_NOT_FOUND"
              • "INTERNAL_FAILURE"
              • "PARAMETER_VALUE_INCOMPATIBLE"
              • "PARAMETER_TYPE_INVALID"
              • "PARAMETER_NOT_FOUND"
              • "COLUMN_TYPE_MISMATCH"
              • "COLUMN_GEOGRAPHIC_ROLE_MISMATCH"
              • "COLUMN_REPLACEMENT_MISSING"
            • Message — (String)

              Message.

          • VersionNumber — (Integer)

            Version number.

          • Status — (String)

            The http status of the request.

            Possible values include:
            • "CREATION_IN_PROGRESS"
            • "CREATION_SUCCESSFUL"
            • "CREATION_FAILED"
            • "UPDATE_IN_PROGRESS"
            • "UPDATE_SUCCESSFUL"
            • "UPDATE_FAILED"
          • Arn — (String)

            The Amazon Resource name (ARN) of the resource.

          • SourceEntityArn — (String)

            Source entity ARN.

          • Description — (String)

            Description.

        • CreatedTime — (Date)

          The time this was created.

        • LastPublishedTime — (Date)

          The last time this was published.

        • LastUpdatedTime — (Date)

          The last time this was updated.

      • Status — (Integer)

        The http status of this request.

      • RequestId — (String)

        The AWS request ID for this operation.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

describeDashboardPermissions(params = {}, callback) ⇒ AWS.Request

Describes read and write permissions on a dashboard.

CLI syntax:

aws quicksight describe-dashboard-permissions --aws-account-id 735340738645 —dashboard-id reports_test_bob_report

Service Reference:

Examples:

Calling the describeDashboardPermissions operation

var params = {
  AwsAccountId: 'STRING_VALUE', /* required */
  DashboardId: 'STRING_VALUE' /* required */
};
quicksight.describeDashboardPermissions(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • AwsAccountId — (String)

      AWS account ID that contains the dashboard you are describing permissions of.

    • DashboardId — (String)

      The ID for the dashboard, also added to IAM policy.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • DashboardId — (String)

        The ID for the dashboard.

      • DashboardArn — (String)

        The ARN of the dashboard.

      • Permissions — (Array<map>)

        A structure that contains the permissions of the dashboard.

        • Principalrequired — (String)

          The ARN of a QuickSight user or group, or an IAM ARN. If you are using cross-account resource sharing, this is the IAM ARN of an account root. Otherwise, it is the ARN of a QuickSight user or group. .

        • Actionsrequired — (Array<String>)

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

      • Status — (Integer)

        The http status of the request.

      • RequestId — (String)

        The AWS request ID for this operation.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

describeDataSet(params = {}, callback) ⇒ AWS.Request

Describes a dataset.

CLI syntax:

aws quicksight describe-data-set \

--aws-account-id=111111111111 \

--data-set-id=unique-data-set-id

Service Reference:

Examples:

Calling the describeDataSet operation

var params = {
  AwsAccountId: 'STRING_VALUE', /* required */
  DataSetId: 'STRING_VALUE' /* required */
};
quicksight.describeDataSet(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • AwsAccountId — (String)

      The AWS Account ID.

    • DataSetId — (String)

      The ID for the dataset you want to create. This is unique per region per AWS account.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • DataSet — (map)

        Information on the dataset.

        • Arn — (String)

          The Amazon Resource name (ARN) of the resource.

        • DataSetId — (String)

          The ID of the dataset.

        • Name — (String)

          A display name for the dataset.

        • CreatedTime — (Date)

          The time this was created.

        • LastUpdatedTime — (Date)

          The last time this was updated.

        • PhysicalTableMap — (map<map>)

          Declares the physical tables that are available in the underlying data sources.

          • RelationalTable — (map)

            A physical table type for relational data sources.

            • DataSourceArnrequired — (String)

              Data source ARN.

            • Schema — (String)

              The schema name. Applies to certain relational database engines.

            • Namerequired — (String)

              Name of the relational table.

            • InputColumnsrequired — (Array<map>)

              The column schema of the table.

              • Namerequired — (String)

                The name of this column in the underlying data source.

              • Typerequired — (String)

                The data type of the column.

                Possible values include:
                • "STRING"
                • "INTEGER"
                • "DECIMAL"
                • "DATETIME"
                • "BIT"
                • "BOOLEAN"
                • "JSON"
          • CustomSql — (map)

            A physical table type built from the results of the custom SQL query.

            • DataSourceArnrequired — (String)

              The ARN of the data source.

            • Namerequired — (String)

              A display name for the SQL query result.

            • SqlQueryrequired — (String)

              The SQL query.

            • Columns — (Array<map>)

              The column schema from the SQL query result set.

              • Namerequired — (String)

                The name of this column in the underlying data source.

              • Typerequired — (String)

                The data type of the column.

                Possible values include:
                • "STRING"
                • "INTEGER"
                • "DECIMAL"
                • "DATETIME"
                • "BIT"
                • "BOOLEAN"
                • "JSON"
          • S3Source — (map)

            A physical table type for as S3 data source.

            • DataSourceArnrequired — (String)

              Data source ARN.

            • UploadSettings — (map)

              Information on the S3 source file(s) format.

              • Format — (String)

                File format.

                Possible values include:
                • "CSV"
                • "TSV"
                • "CLF"
                • "ELF"
                • "XLSX"
                • "JSON"
              • StartFromRow — (Integer)

                A row number to start reading data from.

              • ContainsHeader — (Boolean)

                Whether or not the file(s) has a header row.

              • TextQualifier — (String)

                Text qualifier.

                Possible values include:
                • "DOUBLE_QUOTE"
                • "SINGLE_QUOTE"
              • Delimiter — (String)

                The delimiter between values in the file.

            • InputColumnsrequired — (Array<map>)

              A physical table type for as S3 data source.

              • Namerequired — (String)

                The name of this column in the underlying data source.

              • Typerequired — (String)

                The data type of the column.

                Possible values include:
                • "STRING"
                • "INTEGER"
                • "DECIMAL"
                • "DATETIME"
                • "BIT"
                • "BOOLEAN"
                • "JSON"
        • LogicalTableMap — (map<map>)

          Configures the combination and transformation of the data from the physical tables.

          • Aliasrequired — (String)

            A display name for the logical table.

          • DataTransforms — (Array<map>)

            Transform operations that act on this logical table.

            • ProjectOperation — (map)

              An operation that projects columns. Operations that come after a projection can only refer to projected columns.

              • ProjectedColumnsrequired — (Array<String>)

                Projected columns.

            • FilterOperation — (map)

              An operation that filters rows based on some condition.

              • ConditionExpressionrequired — (String)

                An expression that must evaluate to a boolean value. Rows for which the expression is evaluated to true are kept in the dataset.

            • CreateColumnsOperation — (map)

              An operation that creates calculated columns. Columns created in one such operation form a lexical closure.

              • Columnsrequired — (Array<map>)

                Calculated columns to create.

                • ColumnNamerequired — (String)

                  Column name.

                • ColumnIdrequired — (String)

                  A unique ID to identify a calculated column. During dataset update, if the column ID of a calculated column matches that of an existing calculated column, QuickSight preserves the existing calculated column.

                • Expressionrequired — (String)

                  An expression that defines the calculated column.

            • RenameColumnOperation — (map)

              An operation that renames a column.

              • ColumnNamerequired — (String)

                Name of the column to be renamed.

              • NewColumnNamerequired — (String)

                New name for the column.

            • CastColumnTypeOperation — (map)

              A transform operation that casts a column to a different type.

              • ColumnNamerequired — (String)

                Column name.

              • NewColumnTyperequired — (String)

                New column data type.

                Possible values include:
                • "STRING"
                • "INTEGER"
                • "DECIMAL"
                • "DATETIME"
              • Format — (String)

                When casting a column from string to datetime type, you can supply a QuickSight supported format string to denote the source data format.

            • TagColumnOperation — (map)

              An operation that tags a column with additional information.

              • ColumnNamerequired — (String)

                The column that this operation acts on.

              • Tagsrequired — (Array<map>)

                The dataset column tag, currently only used for geospatial type tagging. .

                Note: This is not tags for the AWS tagging feature. .
                • ColumnGeographicRole — (String)

                  A geospatial role for a column.

                  Possible values include:
                  • "COUNTRY"
                  • "STATE"
                  • "COUNTY"
                  • "CITY"
                  • "POSTCODE"
                  • "LONGITUDE"
                  • "LATITUDE"
          • Sourcerequired — (map)

            Source of this logical table.

            • JoinInstruction — (map)

              Specifies the result of a join of two logical tables.

              • LeftOperandrequired — (String)

                Left operand.

              • RightOperandrequired — (String)

                Right operand.

              • Typerequired — (String)

                Type.

                Possible values include:
                • "INNER"
                • "OUTER"
                • "LEFT"
                • "RIGHT"
              • OnClauserequired — (String)

                On Clause.

            • PhysicalTableId — (String)

              Physical table ID.

        • OutputColumns — (Array<map>)

          The list of columns after all transforms. These columns are available in templates, analyses, and dashboards.

          • Name — (String)

            A display name for the dataset.

          • Type — (String)

            Type.

            Possible values include:
            • "STRING"
            • "INTEGER"
            • "DECIMAL"
            • "DATETIME"
        • ImportMode — (String)

          Indicates whether or not you want to import the data into SPICE.

          Possible values include:
          • "SPICE"
          • "DIRECT_QUERY"
        • ConsumedSpiceCapacityInBytes — (Integer)

          The amount of SPICE capacity used by this dataset. This is 0 if the dataset isn't imported into SPICE.

        • ColumnGroups — (Array<map>)

          Groupings of columns that work together in certain QuickSight features. Currently only geospatial hierarchy is supported.

          • GeoSpatialColumnGroup — (map)

            Geospatial column group that denotes a hierarchy.

            • Namerequired — (String)

              A display name for the hierarchy.

            • CountryCoderequired — (String)

              Country code.

              Possible values include:
              • "US"
            • Columnsrequired — (Array<String>)

              Columns in this hierarchy.

        • RowLevelPermissionDataSet — (map)

          Row-level security configuration on the dataset.

          • Arnrequired — (String)

            The Amazon Resource name (ARN) of the permission dataset.

          • PermissionPolicyrequired — (String)

            Permission policy.

            Possible values include:
            • "GRANT_ACCESS"
            • "DENY_ACCESS"
      • RequestId — (String)

        The AWS request ID for this operation.

      • Status — (Integer)

        The http status of the request.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

describeDataSetPermissions(params = {}, callback) ⇒ AWS.Request

Describes the permissions on a dataset.

The permissions resource is arn:aws:quicksight:region:aws-account-id:dataset/data-set-id

CLI syntax:

aws quicksight describe-data-set-permissions \

--aws-account-id=111122223333 \

--data-set-id=unique-data-set-id \

Service Reference:

Examples:

Calling the describeDataSetPermissions operation

var params = {
  AwsAccountId: 'STRING_VALUE', /* required */
  DataSetId: 'STRING_VALUE' /* required */
};
quicksight.describeDataSetPermissions(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • AwsAccountId — (String)

      The AWS Account ID.

    • DataSetId — (String)

      The ID for the dataset you want to create. This is unique per region per AWS account.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • DataSetArn — (String)

        The ARN of the dataset.

      • DataSetId — (String)

        The ID for the dataset you want to create. This is unique per region per AWS account.

      • Permissions — (Array<map>)

        A list of resource permissions on the dataset.

        • Principalrequired — (String)

          The ARN of a QuickSight user or group, or an IAM ARN. If you are using cross-account resource sharing, this is the IAM ARN of an account root. Otherwise, it is the ARN of a QuickSight user or group. .

        • Actionsrequired — (Array<String>)

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

      • RequestId — (String)

        The AWS request ID for this operation.

      • Status — (Integer)

        The http status of the request.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

describeDataSource(params = {}, callback) ⇒ AWS.Request

Describes a data source.

The permissions resource is arn:aws:quicksight:region:aws-account-id:datasource/data-source-id

Service Reference:

Examples:

Calling the describeDataSource operation

var params = {
  AwsAccountId: 'STRING_VALUE', /* required */
  DataSourceId: 'STRING_VALUE' /* required */
};
quicksight.describeDataSource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • AwsAccountId — (String)

      The AWS account ID.

    • DataSourceId — (String)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • DataSource — (map)

        The information on the data source.

        • Arn — (String)

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

        • DataSourceId — (String)

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

        • Name — (String)

          A display name for the data source.

        • Type — (String)

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

          Possible values include:
          • "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"
        • Status — (String)

          The http status of the request.

          Possible values include:
          • "CREATION_IN_PROGRESS"
          • "CREATION_SUCCESSFUL"
          • "CREATION_FAILED"
          • "UPDATE_IN_PROGRESS"
          • "UPDATE_SUCCESSFUL"
          • "UPDATE_FAILED"
        • CreatedTime — (Date)

          The time this was created.

        • LastUpdatedTime — (Date)

          The last time this was updated.

        • DataSourceParameters — (map)

          The parameters QuickSight uses to connect to your underlying source. This is a variant type structure. At most one of the attributes should be non-null for this structure to be valid.

          • AmazonElasticsearchParameters — (map)

            Amazon Elasticsearch parameters.

            • Domainrequired — (String)

              The Amazon Elasticsearch domain.

          • AthenaParameters — (map)

            Athena parameters.

            • WorkGroup — (String)

              The workgroup that Athena uses.

          • AuroraParameters — (map)

            Aurora MySQL parameters.

            • Hostrequired — (String)

              Host.

            • Portrequired — (Integer)

              Port.

            • Databaserequired — (String)

              Database.

          • AuroraPostgreSqlParameters — (map)

            Aurora PostgreSQL parameters.

            • Hostrequired — (String)

              Host.

            • Portrequired — (Integer)

              Port.

            • Databaserequired — (String)

              Database.

          • AwsIotAnalyticsParameters — (map)

            AWS IoT Analytics parameters.

            • DataSetNamerequired — (String)

              Dataset name.

          • JiraParameters — (map)

            Jira parameters.

            • SiteBaseUrlrequired — (String)

              The base URL of the Jira site.

          • MariaDbParameters — (map)

            MariaDB parameters.

            • Hostrequired — (String)

              Host.

            • Portrequired — (Integer)

              Port.

            • Databaserequired — (String)

              Database.

          • MySqlParameters — (map)

            MySQL parameters.

            • Hostrequired — (String)

              Host.

            • Portrequired — (Integer)

              Port.

            • Databaserequired — (String)

              Database.

          • PostgreSqlParameters — (map)

            PostgreSQL parameters.

            • Hostrequired — (String)

              Host.

            • Portrequired — (Integer)

              Port.

            • Databaserequired — (String)

              Database.

          • PrestoParameters — (map)

            Presto parameters.

            • Hostrequired — (String)

              Host.

            • Portrequired — (Integer)

              Port.

            • Catalogrequired — (String)

              Catalog.

          • RdsParameters — (map)

            RDS parameters.

            • InstanceIdrequired — (String)

              Instance ID.

            • Databaserequired — (String)

              Database.

          • RedshiftParameters — (map)

            Redshift parameters.

            • Host — (String)

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

            • Port — (Integer)

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

            • Databaserequired — (String)

              Database.

            • ClusterId — (String)

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

          • S3Parameters — (map)

            S3 parameters.

            • ManifestFileLocationrequired — (map)

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

              • Bucketrequired — (String)

                Amazon S3 bucket.

              • Keyrequired — (String)

                Amazon S3 key that identifies an object.

          • ServiceNowParameters — (map)

            ServiceNow parameters.

            • SiteBaseUrlrequired — (String)

              URL of the base site.

          • SnowflakeParameters — (map)

            Snowflake parameters.

            • Hostrequired — (String)

              Host.

            • Databaserequired — (String)

              Database.

            • Warehouserequired — (String)

              Warehouse.

          • SparkParameters — (map)

            Spark parameters.

            • Hostrequired — (String)

              Host.

            • Portrequired — (Integer)

              Port.

          • SqlServerParameters — (map)

            SQL Server parameters.

            • Hostrequired — (String)

              Host.

            • Portrequired — (Integer)

              Port.

            • Databaserequired — (String)

              Database.

          • TeradataParameters — (map)

            Teradata parameters.

            • Hostrequired — (String)

              Host.

            • Portrequired — (Integer)

              Port.

            • Databaserequired — (String)

              Database.

          • TwitterParameters — (map)

            Twitter parameters.

            • Queryrequired — (String)

              Twitter query string.

            • MaxRowsrequired — (Integer)

              Maximum number of rows to query Twitter.

        • VpcConnectionProperties — (map)

          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.

          • VpcConnectionArnrequired — (String)

            VPC connection ARN.

        • SslProperties — (map)

          SSL properties that apply when QuickSight connects to your underlying source.

          • DisableSsl — (Boolean)

            A boolean flag to control whether SSL should be disabled.

        • ErrorInfo — (map)

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

          • Type — (String)

            Error type.

            Possible values include:
            • "TIMEOUT"
            • "ENGINE_VERSION_NOT_SUPPORTED"
            • "UNKNOWN_HOST"
            • "GENERIC_SQL_FAILURE"
            • "CONFLICT"
            • "UNKNOWN"
          • Message — (String)

            Error message.

      • RequestId — (String)

        The AWS request ID for this operation.

      • Status — (Integer)

        The http status of the request.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

describeDataSourcePermissions(params = {}, callback) ⇒ AWS.Request

Describes the resource permissions for a data source.

The permissions resource is aws:quicksight:region:aws-account-id:datasource/data-source-id

Service Reference:

Examples:

Calling the describeDataSourcePermissions operation

var params = {
  AwsAccountId: 'STRING_VALUE', /* required */
  DataSourceId: 'STRING_VALUE' /* required */
};
quicksight.describeDataSourcePermissions(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • AwsAccountId — (String)

      The AWS account ID.

    • DataSourceId — (String)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • DataSourceArn — (String)

        The ARN of the data source.

      • DataSourceId — (String)

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

      • Permissions — (Array<map>)

        A list of resource permissions on the data source.

        • Principalrequired — (String)

          The ARN of a QuickSight user or group, or an IAM ARN. If you are using cross-account resource sharing, this is the IAM ARN of an account root. Otherwise, it is the ARN of a QuickSight user or group. .

        • Actionsrequired — (Array<String>)

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

      • RequestId — (String)

        The AWS request ID for this operation.

      • Status — (Integer)

        The http status of the request.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

describeGroup(params = {}, callback) ⇒ AWS.Request

Returns an Amazon QuickSight group's description and Amazon Resource Name (ARN).

The permissions resource is arn:aws:quicksight:us-east-1:<relevant-aws-account-id>:group/default/<group-name> .

The response is the group object.

CLI Sample:

aws quicksight describe-group --aws-account-id=11112222333 --namespace=default --group-name=Sales

Service Reference:

Examples:

Calling the describeGroup operation

var params = {
  AwsAccountId: 'STRING_VALUE', /* required */
  GroupName: 'STRING_VALUE', /* required */
  Namespace: 'STRING_VALUE' /* required */
};
quicksight.describeGroup(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • GroupName — (String)

      The name of the group that you want to describe.

    • AwsAccountId — (String)

      The ID for the AWS account that the group is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.

    • Namespace — (String)

      The namespace. Currently, you should set this to default.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Group — (map)

        The name of the group.

        • Arn — (String)

          The Amazon Resource name (ARN) for the group.

        • GroupName — (String)

          The name of the group.

        • Description — (String)

          The group description.

        • PrincipalId — (String)

          The principal ID of the group.

      • RequestId — (String)

        The AWS request ID for this operation.

      • Status — (Integer)

        The http status of the request.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

describeIAMPolicyAssignment(params = {}, callback) ⇒ AWS.Request

Describes an existing IAMPolicy Assignment by specified assignment name.

CLI syntax:

aws quicksight describe-iam-policy-assignment --aws-account-id=111122223333 --assignment-name=testtest --namespace=default --region=us-east-1

Service Reference:

Examples:

Calling the describeIAMPolicyAssignment operation

var params = {
  AssignmentName: 'STRING_VALUE', /* required */
  AwsAccountId: 'STRING_VALUE', /* required */
  Namespace: 'STRING_VALUE' /* required */
};
quicksight.describeIAMPolicyAssignment(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • AwsAccountId — (String)

      The AWS account ID that contains the assignment you want to describe.

    • AssignmentName — (String)

      The name of the assignment.

    • Namespace — (String)

      The namespace that contains the assignment.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • IAMPolicyAssignment — (map)

        Information describing the IAM policy assignment.

        • AwsAccountId — (String)

          AWS account ID.

        • AssignmentId — (String)

          Assignment ID.

        • AssignmentName — (String)

          Assignment name.

        • PolicyArn — (String)

          Policy ARN.

        • Identities — (map<Array<String>>)

          Identities.

        • AssignmentStatus — (String)

          Assignment status.

          Possible values include:
          • "ENABLED"
          • "DRAFT"
          • "DISABLED"
      • RequestId — (String)

        The AWS request ID for this operation.

      • Status — (Integer)

        The http status of the request.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

describeIngestion(params = {}, callback) ⇒ AWS.Request

Describes a SPICE ingestion.

Service Reference:

Examples:

Calling the describeIngestion operation

var params = {
  AwsAccountId: 'STRING_VALUE', /* required */
  DataSetId: 'STRING_VALUE', /* required */
  IngestionId: 'STRING_VALUE' /* required */
};
quicksight.describeIngestion(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • AwsAccountId — (String)

      The AWS account ID.

    • DataSetId — (String)

      The ID of the dataset used in the ingestion.

    • IngestionId — (String)

      An ID for the ingestion.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Ingestion — (map)

        Information about the ingestion.

        • Arnrequired — (String)

          The Amazon Resource name (ARN) of the resource.

        • IngestionId — (String)

          Ingestion ID.

        • IngestionStatusrequired — (String)

          Ingestion status.

          Possible values include:
          • "INITIALIZED"
          • "QUEUED"
          • "RUNNING"
          • "FAILED"
          • "COMPLETED"
          • "CANCELLED"
        • ErrorInfo — (map)

          Error information for this ingestion.

          • Type — (String)

            Error type.

            Possible values include:
            • "FAILURE_TO_ASSUME_ROLE"
            • "INGESTION_SUPERSEDED"
            • "INGESTION_CANCELED"
            • "DATA_SET_DELETED"
            • "DATA_SET_NOT_SPICE"
            • "S3_UPLOADED_FILE_DELETED"
            • "S3_MANIFEST_ERROR"
            • "DATA_TOLERANCE_EXCEPTION"
            • "SPICE_TABLE_NOT_FOUND"
            • "DATA_SET_SIZE_LIMIT_EXCEEDED"
            • "ROW_SIZE_LIMIT_EXCEEDED"
            • "ACCOUNT_CAPACITY_LIMIT_EXCEEDED"
            • "CUSTOMER_ERROR"
            • "DATA_SOURCE_NOT_FOUND"
            • "IAM_ROLE_NOT_AVAILABLE"
            • "CONNECTION_FAILURE"
            • "SQL_TABLE_NOT_FOUND"
            • "PERMISSION_DENIED"
            • "SSL_CERTIFICATE_VALIDATION_FAILURE"
            • "OAUTH_TOKEN_FAILURE"
            • "SOURCE_API_LIMIT_EXCEEDED_FAILURE"
            • "PASSWORD_AUTHENTICATION_FAILURE"
            • "SQL_SCHEMA_MISMATCH_ERROR"
            • "INVALID_DATE_FORMAT"
            • "INVALID_DATAPREP_SYNTAX"
            • "SOURCE_RESOURCE_LIMIT_EXCEEDED"
            • "SQL_INVALID_PARAMETER_VALUE"
            • "QUERY_TIMEOUT"
            • "SQL_NUMERIC_OVERFLOW"
            • "UNRESOLVABLE_HOST"
            • "UNROUTABLE_HOST"
            • "SQL_EXCEPTION"
            • "S3_FILE_INACCESSIBLE"
            • "IOT_FILE_NOT_FOUND"
            • "IOT_DATA_SET_FILE_EMPTY"
            • "INVALID_DATA_SOURCE_CONFIG"
            • "DATA_SOURCE_AUTH_FAILED"
            • "DATA_SOURCE_CONNECTION_FAILED"
            • "FAILURE_TO_PROCESS_JSON_FILE"
            • "INTERNAL_SERVICE_ERROR"
          • Message — (String)

            Error essage.

        • RowInfo — (map)

          Information on rows during a data set SPICE ingestion.

          • RowsIngested — (Integer)

            The number of rows that were ingested.

          • RowsDropped — (Integer)

            The number of rows that were not ingested.

        • QueueInfo — (map)

          Information on queued dataset SPICE ingestion.

          • WaitingOnIngestionrequired — (String)

            The ID of the queued ingestion.

          • QueuedIngestionrequired — (String)

            The ID of the ongoing ingestion. The queued ingestion is waiting for the ongoing ingestion to complete.

        • CreatedTimerequired — (Date)

          The time this ingestion started.

        • IngestionTimeInSeconds — (Integer)

          The time this ingestion took, measured in seconds.

        • IngestionSizeInBytes — (Integer)

          Size of the data ingested in bytes.

        • RequestSource — (String)

          Event source for this ingestion.

          Possible values include:
          • "MANUAL"
          • "SCHEDULED"
        • RequestType — (String)

          Type of this ingestion.

          Possible values include:
          • "INITIAL_INGESTION"
          • "EDIT"
          • "INCREMENTAL_REFRESH"
          • "FULL_REFRESH"
      • RequestId — (String)

        The AWS request ID for this operation.

      • Status — (Integer)

        The http status of the request.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

describeTemplate(params = {}, callback) ⇒ AWS.Request

Describes a template's metadata.

CLI syntax:

aws quicksight describe-template --aws-account-id 111122223333 --template-id reports_test_template

aws quicksight describe-template --aws-account-id 111122223333 --template-id reports_test_template --version-number-2

aws quicksight describe-template --aws-account-id 111122223333 --template-id reports_test_template --alias-name '\$LATEST'

Users can explicitly describe the latest version of the dashboard by passing $LATEST to the alias-name parameter. $LATEST is an internally supported alias, which points to the latest version of the dashboard.

Service Reference:

Examples:

Calling the describeTemplate operation

var params = {
  AwsAccountId: 'STRING_VALUE', /* required */
  TemplateId: 'STRING_VALUE', /* required */
  AliasName: 'STRING_VALUE',
  VersionNumber: 'NUMBER_VALUE'
};
quicksight.describeTemplate(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • AwsAccountId — (String)

      AWS account ID that contains the template you are describing.

    • TemplateId — (String)

      An ID for the template.

    • VersionNumber — (Integer)

      This is an optional field, when a version number is provided the corresponding version is describe, if it's not provided the latest version of the template is described.

    • AliasName — (String)

      This is an optional field, when an alias name is provided, the version referenced by the alias is described. Refer to CreateTemplateAlias to create a template alias. $PUBLISHED is not supported for template.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Template — (map)

        The template structure of the object you want to describe.

        • Arn — (String)

          The ARN of the template.

        • Name — (String)

          The display name of the template.

        • Version — (map)

          A structure describing the versions of the template.

          • CreatedTime — (Date)

            The time this was created.

          • Errors — (Array<map>)

            Errors associated with the template.

            • Type — (String)

              Type of error.

              Possible values include:
              • "DATA_SET_NOT_FOUND"
              • "INTERNAL_FAILURE"
            • Message — (String)

              Description of the error type.

          • VersionNumber — (Integer)

            The version number of the template.

          • Status — (String)

            The http status of the request.

            Possible values include:
            • "CREATION_IN_PROGRESS"
            • "CREATION_SUCCESSFUL"
            • "CREATION_FAILED"
            • "UPDATE_IN_PROGRESS"
            • "UPDATE_SUCCESSFUL"
            • "UPDATE_FAILED"
          • DataSetConfigurations — (Array<map>)

            Schema of the dataset identified by the placeholder. The idea is that any dashboard created from the template should be bound to new datasets matching the same schema described through this API. .

            • Placeholder — (String)

              Placeholder.

            • DataSetSchema — (map)

              Dataset schema.

              • ColumnSchemaList — (Array<map>)

                A structure containing the list of column schemas.

                • Name — (String)

                  The name of the column schema.

                • DataType — (String)

                  The data type of the column schema.

                • GeographicRole — (String)

                  The geographic role of the column schema.

            • ColumnGroupSchemaList — (Array<map>)

              A structure containing the list of column group schemas.

              • Name — (String)

                The name of the column group schema.

              • ColumnGroupColumnSchemaList — (Array<map>)

                A structure containing the list of column group column schemas.

                • Name — (String)

                  The name of the column group's column schema.

          • Description — (String)

            The description of the template.

          • SourceEntityArn — (String)

            The ARN of the analysis or template which was used to create this template.

        • TemplateId — (String)

          The ID for the template. This is unique per region per AWS account.

        • LastUpdatedTime — (Date)

          Time when this was last updated.

        • CreatedTime — (Date)

          Time when this was created.

      • Status — (Integer)

        The http status of the request.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

describeTemplateAlias(params = {}, callback) ⇒ AWS.Request

Describes the template aliases of a template.

CLI syntax:

aws quicksight describe-template-alias --aws-account-id 111122223333 --template-id 'reports_test_template' --alias-name 'STAGING'

Service Reference:

Examples:

Calling the describeTemplateAlias operation

var params = {
  AliasName: 'STRING_VALUE', /* required */
  AwsAccountId: 'STRING_VALUE', /* required */
  TemplateId: 'STRING_VALUE' /* required */
};
quicksight.describeTemplateAlias(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • AwsAccountId — (String)

      AWS account ID that contains the template alias you are describing.

    • TemplateId — (String)

      An ID for the template.

    • AliasName — (String)

      The alias name. $PUBLISHED is not supported for template.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • TemplateAlias — (map)

        Information about the template alias.

        • AliasName — (String)

          The display name of the template alias.

        • Arn — (String)

          The ARN of the template alias.

        • TemplateVersionNumber — (Integer)

          The version number of the template alias.

      • Status — (Integer)

        The http status of the request.

      • RequestId — (String)

        The AWS request ID for this operation.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

describeTemplatePermissions(params = {}, callback) ⇒ AWS.Request

Describes read and write permissions on a template.

CLI syntax:

aws quicksight describe-template-permissions —aws-account-id 735340738645 —template-id reports_test_template

Service Reference:

Examples:

Calling the describeTemplatePermissions operation

var params = {
  AwsAccountId: 'STRING_VALUE', /* required */
  TemplateId: 'STRING_VALUE' /* required */
};
quicksight.describeTemplatePermissions(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • AwsAccountId — (String)

      AWS account ID that contains the template you are describing.

    • TemplateId — (String)

      The ID for the template.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • TemplateId — (String)

        The ID for the template.

      • TemplateArn — (String)

        The ARN of the template.

      • Permissions — (Array<map>)

        A list of resource permissions to be set on the template.

        • Principalrequired — (String)

          The ARN of a QuickSight user or group, or an IAM ARN. If you are using cross-account resource sharing, this is the IAM ARN of an account root. Otherwise, it is the ARN of a QuickSight user or group. .

        • Actionsrequired — (Array<String>)

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

      • RequestId — (String)

        The AWS request ID for this operation.

      • Status — (Integer)

        The http status of the request.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

describeUser(params = {}, callback) ⇒ AWS.Request

Returns information about a user, given the user name.

The response is a user object that contains the user's Amazon Resource Name (ARN), AWS Identity and Access Management (IAM) role, and email address.

CLI Sample:

aws quicksight describe-user --aws-account-id=111122223333 --namespace=default --user-name=Pat

Service Reference:

Examples:

Calling the describeUser operation

var params = {
  AwsAccountId: 'STRING_VALUE', /* required */
  Namespace: 'STRING_VALUE', /* required */
  UserName: 'STRING_VALUE' /* required */
};
quicksight.describeUser(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • UserName — (String)

      The name of the user that you want to describe.

    • AwsAccountId — (String)

      The ID for the AWS account that the user is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.

    • Namespace — (String)

      The namespace. Currently, you should set this to default.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • User — (map)

        The user name.

        • Arn — (String)

          The Amazon Resource name (ARN) for the user.

        • UserName — (String)

          The user's user name.

        • Email — (String)

          The user's email address.

        • Role — (String)

          The Amazon QuickSight role for the user. The user role can be one of the following:.

          • READER: A user who has read-only access to dashboards.

          • AUTHOR: A user who can create data sources, datasets, analyses, and dashboards.

          • ADMIN: A user who is an author, who can also manage Amazon QuickSight settings.

          • RESTRICTED_READER: This role isn't currently available for use.

          • RESTRICTED_AUTHOR: This role isn't currently available for use.

          Possible values include:
          • "ADMIN"
          • "AUTHOR"
          • "READER"
          • "RESTRICTED_AUTHOR"
          • "RESTRICTED_READER"
        • IdentityType — (String)

          The type of identity authentication used by the user.

          Possible values include:
          • "IAM"
          • "QUICKSIGHT"
        • Active — (Boolean)

          Active status of user. When you create an Amazon QuickSight user that’s not an IAM user or an AD user, that user is inactive until they sign in and provide a password.

        • PrincipalId — (String)

          The principal ID of the user.

      • RequestId — (String)

        The AWS request ID for this operation.

      • Status — (Integer)

        The http status of the request.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getDashboardEmbedUrl(params = {}, callback) ⇒ AWS.Request

Generates a server-side embeddable URL and authorization code. Before this can work properly, first you need to configure the dashboards and user permissions. For more information, see Embedding Amazon QuickSight Dashboards.

Currently, you can use GetDashboardEmbedURL only from the server, not from the user’s browser.

CLI Sample:

Assume the role with permissions enabled for actions: quickSight:RegisterUser and quicksight:GetDashboardEmbedURL. You can use assume-role, assume-role-with-web-identity, or assume-role-with-saml.

aws sts assume-role --role-arn "arn:aws:iam::111122223333:role/embedding_quicksight_dashboard_role" --role-session-name embeddingsession

If the user does not exist in QuickSight, register the user:

aws quicksight register-user --aws-account-id 111122223333 --namespace default --identity-type IAM --iam-arn "arn:aws:iam::111122223333:role/embedding_quicksight_dashboard_role" --user-role READER --session-name "embeddingsession" --email user123@example.com --region us-east-1

Get the URL for the embedded dashboard (IAM identity authentication):

aws quicksight get-dashboard-embed-url --aws-account-id 111122223333 --dashboard-id 1a1ac2b2-3fc3-4b44-5e5d-c6db6778df89 --identity-type IAM

Get the URL for the embedded dashboard (QUICKSIGHT identity authentication):

aws quicksight get-dashboard-embed-url --aws-account-id 111122223333 --dashboard-id 1a1ac2b2-3fc3-4b44-5e5d-c6db6778df89 --identity-type QUICKSIGHT --user-arn arn:aws:quicksight:us-east-1:111122223333:user/default/embedding_quicksight_dashboard_role/embeddingsession

Service Reference:

Examples:

Calling the getDashboardEmbedUrl operation

var params = {
  AwsAccountId: 'STRING_VALUE', /* required */
  DashboardId: 'STRING_VALUE', /* required */
  IdentityType: IAM | QUICKSIGHT, /* required */
  ResetDisabled: true || false,
  SessionLifetimeInMinutes: 'NUMBER_VALUE',
  UndoRedoDisabled: true || false,
  UserArn: 'STRING_VALUE'
};
quicksight.getDashboardEmbedUrl(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • AwsAccountId — (String)

      AWS account ID that contains the dashboard you are embedding.

    • DashboardId — (String)

      The ID for the dashboard, also added to IAM policy

    • IdentityType — (String)

      The authentication method the user uses to sign in (IAM only).

      Possible values include:
      • "IAM"
      • "QUICKSIGHT"
    • SessionLifetimeInMinutes — (Integer)

      How many minutes the session is valid. The session lifetime must be between 15 and 600 minutes.

    • UndoRedoDisabled — (Boolean)

      Remove the undo/redo button on embedded dashboard. The default is FALSE, which enables the undo/redo button.

    • ResetDisabled — (Boolean)

      Remove the reset button on embedded dashboard. The default is FALSE, which allows the reset button.

    • UserArn — (String)

      The Amazon QuickSight user's ARN, for use with QUICKSIGHT identity type. You can use this for any Amazon QuickSight users in your account (readers, authors, or admins) authenticated as one of the following:

      • Active Directory (AD) users or group members

      • Invited non-federated users

      • IAM users and IAM role-based sessions authenticated through Federated Single Sign-On using SAML, OpenID Connect, or IAM Federation

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • EmbedUrl — (String)

        URL that you can put into your server-side webpage to embed your dashboard. This URL is valid for 5 minutes, and the resulting session is valid for 10 hours. The API provides the URL with an auth_code that enables a single-signon session.

      • Status — (Integer)

        The http status of the request.

      • RequestId — (String)

        The AWS request ID for this operation.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listDashboards(params = {}, callback) ⇒ AWS.Request

Lists dashboards in the AWS account.

CLI syntax:

aws quicksight list-dashboards --aws-account-id 111122223333 --max-results 5 —next-token 'next-10'

Service Reference:

Examples:

Calling the listDashboards operation

var params = {
  AwsAccountId: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
quicksight.listDashboards(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • AwsAccountId — (String)

      AWS account ID that contains the dashboards you are listing.

    • NextToken — (String)

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

    • MaxResults — (Integer)

      The maximum number of results to be returned per request.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • DashboardSummaryList — (Array<map>)

        A structure that contains all of the dashboards shared with the user. Provides basic information about the dashboards.

        • Arn — (String)

          The Amazon Resource name (ARN) of the resource.

        • DashboardId — (String)

          Dashboard ID.

        • Name — (String)

          A display name for the dataset.

        • CreatedTime — (Date)

          The time this was created.

        • LastUpdatedTime — (Date)

          The last time this was updated.

        • PublishedVersionNumber — (Integer)

          Published version number.

        • LastPublishedTime — (Date)

          The last time this was published.

      • NextToken — (String)

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

      • Status — (Integer)

        The http status of the request.

      • RequestId — (String)

        The AWS request ID for this operation.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listDashboardVersions(params = {}, callback) ⇒ AWS.Request

Lists all the versions of the dashboards in the Quicksight subscription.

CLI syntax:

aws quicksight list-template-versions —aws-account-id 111122223333 —template-id reports-test-template

Service Reference:

Examples:

Calling the listDashboardVersions operation

var params = {
  AwsAccountId: 'STRING_VALUE', /* required */
  DashboardId: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
quicksight.listDashboardVersions(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • AwsAccountId — (String)

      AWS account ID that contains the dashboard you are listing.

    • DashboardId — (String)

      The ID for the dashboard.

    • NextToken — (String)

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

    • MaxResults — (Integer)

      The maximum number of results to be returned per request.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • DashboardVersionSummaryList — (Array<map>)

        A structure that contains information about each version of the dashboard.

        • Arn — (String)

          The Amazon Resource name (ARN) of the resource.

        • CreatedTime — (Date)

          The time this was created.

        • VersionNumber — (Integer)

          Version number.

        • Status — (String)

          The http status of the request.

          Possible values include:
          • "CREATION_IN_PROGRESS"
          • "CREATION_SUCCESSFUL"
          • "CREATION_FAILED"
          • "UPDATE_IN_PROGRESS"
          • "UPDATE_SUCCESSFUL"
          • "UPDATE_FAILED"
        • SourceEntityArn — (String)

          Source entity ARN.

        • Description — (String)

          Description.

      • NextToken — (String)

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

      • Status — (Integer)

        The http status of the request.

      • RequestId — (String)

        The AWS request ID for this operation.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listDataSets(params = {}, callback) ⇒ AWS.Request

Lists all of the datasets belonging to this account in an AWS region.

The permissions resource is arn:aws:quicksight:region:aws-account-id:dataset/*

CLI syntax: aws quicksight list-data-sets --aws-account-id=111111111111

Service Reference:

Examples:

Calling the listDataSets operation

var params = {
  AwsAccountId: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
quicksight.listDataSets(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • AwsAccountId — (String)

      The AWS Account ID.

    • NextToken — (String)

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

    • MaxResults — (Integer)

      The maximum number of results to be returned per request.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • DataSetSummaries — (Array<map>)

        The list of dataset summaries.

        • Arn — (String)

          The Amazon Resource name (ARN) of the dataset.

        • DataSetId — (String)

          The ID of the dataset.

        • Name — (String)

          A display name for the dataset.

        • CreatedTime — (Date)

          The time this was created.

        • LastUpdatedTime — (Date)

          The last time this was updated.

        • ImportMode — (String)

          Indicates whether or not you want to import the data into SPICE.

          Possible values include:
          • "SPICE"
          • "DIRECT_QUERY"
        • RowLevelPermissionDataSet — (map)

          Row-level security configuration on the dataset.

          • Arnrequired — (String)

            The Amazon Resource name (ARN) of the permission dataset.

          • PermissionPolicyrequired — (String)

            Permission policy.

            Possible values include:
            • "GRANT_ACCESS"
            • "DENY_ACCESS"
      • 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.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listDataSources(params = {}, callback) ⇒ AWS.Request

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

The permissions resource is: arn:aws:quicksight:region:aws-account-id:datasource/*

CLI syntax: aws quicksight list-data-sources --aws-account-id=111122223333

Service Reference:

Examples:

Calling the listDataSources operation

var params = {
  AwsAccountId: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
quicksight.listDataSources(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • AwsAccountId — (String)

      The AWS account ID.

    • NextToken — (String)

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

    • MaxResults — (Integer)

      The maximum number of results to be returned per request.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • DataSources — (Array<map>)

        A list of data sources.

        • Arn — (String)

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

        • DataSourceId — (String)

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

        • Name — (String)

          A display name for the data source.

        • Type — (String)

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

          Possible values include:
          • "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"
        • Status — (String)

          The http status of the request.

          Possible values include:
          • "CREATION_IN_PROGRESS"
          • "CREATION_SUCCESSFUL"
          • "CREATION_FAILED"
          • "UPDATE_IN_PROGRESS"
          • "UPDATE_SUCCESSFUL"
          • "UPDATE_FAILED"
        • CreatedTime — (Date)

          The time this was created.

        • LastUpdatedTime — (Date)

          The last time this was updated.

        • DataSourceParameters — (map)

          The parameters QuickSight uses to connect to your underlying source. This is a variant type structure. At most one of the attributes should be non-null for this structure to be valid.

          • AmazonElasticsearchParameters — (map)

            Amazon Elasticsearch parameters.

            • Domainrequired — (String)

              The Amazon Elasticsearch domain.

          • AthenaParameters — (map)

            Athena parameters.

            • WorkGroup — (String)

              The workgroup that Athena uses.

          • AuroraParameters — (map)

            Aurora MySQL parameters.

            • Hostrequired — (String)

              Host.

            • Portrequired — (Integer)

              Port.

            • Databaserequired — (String)

              Database.

          • AuroraPostgreSqlParameters — (map)

            Aurora PostgreSQL parameters.

            • Hostrequired — (String)

              Host.

            • Portrequired — (Integer)

              Port.

            • Databaserequired — (String)

              Database.

          • AwsIotAnalyticsParameters — (map)

            AWS IoT Analytics parameters.

            • DataSetNamerequired — (String)

              Dataset name.

          • JiraParameters — (map)

            Jira parameters.

            • SiteBaseUrlrequired — (String)

              The base URL of the Jira site.

          • MariaDbParameters — (map)

            MariaDB parameters.

            • Hostrequired — (String)

              Host.

            • Portrequired — (Integer)

              Port.

            • Databaserequired — (String)

              Database.

          • MySqlParameters — (map)

            MySQL parameters.

            • Hostrequired — (String)

              Host.

            • Portrequired — (Integer)

              Port.

            • Databaserequired — (String)

              Database.

          • PostgreSqlParameters — (map)

            PostgreSQL parameters.

            • Hostrequired — (String)

              Host.

            • Portrequired — (Integer)

              Port.

            • Databaserequired — (String)

              Database.

          • PrestoParameters — (map)

            Presto parameters.

            • Hostrequired — (String)

              Host.

            • Portrequired — (Integer)

              Port.

            • Catalogrequired — (String)

              Catalog.

          • RdsParameters — (map)

            RDS parameters.

            • InstanceIdrequired — (String)

              Instance ID.

            • Databaserequired — (String)

              Database.

          • RedshiftParameters — (map)

            Redshift parameters.

            • Host — (String)

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

            • Port — (Integer)

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

            • Databaserequired — (String)

              Database.

            • ClusterId — (String)

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

          • S3Parameters — (map)

            S3 parameters.

            • ManifestFileLocationrequired — (map)

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

              • Bucketrequired — (String)

                Amazon S3 bucket.

              • Keyrequired — (String)

                Amazon S3 key that identifies an object.

          • ServiceNowParameters — (map)

            ServiceNow parameters.

            • SiteBaseUrlrequired — (String)

              URL of the base site.

          • SnowflakeParameters — (map)

            Snowflake parameters.

            • Hostrequired — (String)

              Host.

            • Databaserequired — (String)

              Database.

            • Warehouserequired — (String)

              Warehouse.

          • SparkParameters — (map)

            Spark parameters.

            • Hostrequired — (String)

              Host.

            • Portrequired — (Integer)

              Port.

          • SqlServerParameters — (map)

            SQL Server parameters.

            • Hostrequired — (String)

              Host.

            • Portrequired — (Integer)

              Port.

            • Databaserequired — (String)

              Database.

          • TeradataParameters — (map)

            Teradata parameters.

            • Hostrequired — (String)

              Host.

            • Portrequired — (Integer)

              Port.

            • Databaserequired — (String)

              Database.

          • TwitterParameters — (map)

            Twitter parameters.

            • Queryrequired — (String)

              Twitter query string.

            • MaxRowsrequired — (Integer)

              Maximum number of rows to query Twitter.

        • VpcConnectionProperties — (map)

          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.

          • VpcConnectionArnrequired — (String)

            VPC connection ARN.

        • SslProperties — (map)

          SSL properties that apply when QuickSight connects to your underlying source.

          • DisableSsl — (Boolean)

            A boolean flag to control whether SSL should be disabled.

        • ErrorInfo — (map)

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

          • Type — (String)

            Error type.

            Possible values include:
            • "TIMEOUT"
            • "ENGINE_VERSION_NOT_SUPPORTED"
            • "UNKNOWN_HOST"
            • "GENERIC_SQL_FAILURE"
            • "CONFLICT"
            • "UNKNOWN"
          • 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.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listGroupMemberships(params = {}, callback) ⇒ AWS.Request

Lists member users in a group.

The permissions resource is arn:aws:quicksight:us-east-1:<aws-account-id>:group/default/<group-name> .

The response is a list of group member objects.

CLI Sample:

aws quicksight list-group-memberships --aws-account-id=111122223333 --namespace=default

Service Reference:

Examples:

Calling the listGroupMemberships operation

var params = {
  AwsAccountId: 'STRING_VALUE', /* required */
  GroupName: 'STRING_VALUE', /* required */
  Namespace: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
quicksight.listGroupMemberships(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • GroupName — (String)

      The name of the group that you want to see a membership list of.

    • NextToken — (String)

      A pagination token that can be used in a subsequent request.

    • MaxResults — (Integer)

      The maximum number of results to return from this request.

    • AwsAccountId — (String)

      The ID for the AWS account that the group is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.

    • Namespace — (String)

      The namespace. Currently, you should set this to default.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • GroupMemberList — (Array<map>)

        The list of the members of the group.

        • Arn — (String)

          The Amazon Resource name (ARN) for the group member (user).

        • MemberName — (String)

          The name of the group member (user).

      • NextToken — (String)

        A pagination token that can be used in a subsequent request.

      • RequestId — (String)

        The AWS request ID for this operation.

      • Status — (Integer)

        The http status of the request.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listGroups(params = {}, callback) ⇒ AWS.Request

Lists all user groups in Amazon QuickSight.

The permissions resource is arn:aws:quicksight:us-east-1:<aws-account-id>:group/default/*.

The response is a list of group objects.

CLI Sample:

aws quicksight list-groups --aws-account-id=111122223333 --namespace=default

Service Reference:

Examples:

Calling the listGroups operation

var params = {
  AwsAccountId: 'STRING_VALUE', /* required */
  Namespace: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
quicksight.listGroups(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • AwsAccountId — (String)

      The ID for the AWS account that the group is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.

    • NextToken — (String)

      A pagination token that can be used in a subsequent request.

    • MaxResults — (Integer)

      The maximum number of results to return.

    • Namespace — (String)

      The namespace. Currently, you should set this to default.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • GroupList — (Array<map>)

        The list of the groups.

        • Arn — (String)

          The Amazon Resource name (ARN) for the group.

        • GroupName — (String)

          The name of the group.

        • Description — (String)

          The group description.

        • PrincipalId — (String)

          The principal ID of the group.

      • NextToken — (String)

        A pagination token that can be used in a subsequent request.

      • RequestId — (String)

        The AWS request ID for this operation.

      • Status — (Integer)

        The http status of the request.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listIAMPolicyAssignments(params = {}, callback) ⇒ AWS.Request

Lists assignments in current QuickSight account.

CLI syntax:

aws quicksight list-iam-policy-assignments --aws-account-id=111122223333 --max-result=5 --assignment-status=ENABLED --namespace=default --region=us-east-1 --next-token=3

Service Reference:

Examples:

Calling the listIAMPolicyAssignments operation

var params = {
  AwsAccountId: 'STRING_VALUE', /* required */
  Namespace: 'STRING_VALUE', /* required */
  AssignmentStatus: ENABLED | DRAFT | DISABLED,
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
quicksight.listIAMPolicyAssignments(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • AwsAccountId — (String)

      The AWS account ID that contains this IAM policy assignment.

    • AssignmentStatus — (String)

      The status of the assignment.

      Possible values include:
      • "ENABLED"
      • "DRAFT"
      • "DISABLED"
    • Namespace — (String)

      The namespace for this assignment.

    • NextToken — (String)

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

    • MaxResults — (Integer)

      The maximum number of results to be returned per request.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • IAMPolicyAssignments — (Array<map>)

        Information describing the IAM policy assignments.

        • AssignmentName — (String)

          Assignment name.

        • AssignmentStatus — (String)

          Assignment status.

          Possible values include:
          • "ENABLED"
          • "DRAFT"
          • "DISABLED"
      • 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.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listIAMPolicyAssignmentsForUser(params = {}, callback) ⇒ AWS.Request

Lists all the assignments and the ARNs for the associated IAM policies assigned to the specified user and the group or groups that the user belongs to.

CLI syntax:

aws quicksight list-iam-policy-assignments-for-user --aws-account-id=111122223333 --user-name=user5 --namespace=default --max-result=6 --region=us-east-1

Service Reference:

Examples:

Calling the listIAMPolicyAssignmentsForUser operation

var params = {
  AwsAccountId: 'STRING_VALUE', /* required */
  Namespace: 'STRING_VALUE', /* required */
  UserName: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
quicksight.listIAMPolicyAssignmentsForUser(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • AwsAccountId — (String)

      The AWS account ID that contains the assignment.

    • UserName — (String)

      The name of the user.

    • NextToken — (String)

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

    • MaxResults — (Integer)

      The maximum number of results to be returned per request.

    • Namespace — (String)

      The namespace of the assignment.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ActiveAssignments — (Array<map>)

        Active assignments for this user.

        • AssignmentName — (String)

          A name for the IAM policy assignment.

        • PolicyArn — (String)

          The ARN of the resource.

      • RequestId — (String)

        The AWS request ID for this operation.

      • NextToken — (String)

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

      • Status — (Integer)

        The http status of the request.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listIngestions(params = {}, callback) ⇒ AWS.Request

Lists the history of SPICE ingestions for a dataset.

Service Reference:

Examples:

Calling the listIngestions operation

var params = {
  AwsAccountId: 'STRING_VALUE', /* required */
  DataSetId: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
quicksight.listIngestions(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • DataSetId — (String)

      The ID of the dataset used in the ingestion.

    • NextToken — (String)

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

    • AwsAccountId — (String)

      The AWS account ID.

    • MaxResults — (Integer)

      The maximum number of results to be returned per request.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Ingestions — (Array<map>)

        A list of the ingestions.

        • Arnrequired — (String)

          The Amazon Resource name (ARN) of the resource.

        • IngestionId — (String)

          Ingestion ID.

        • IngestionStatusrequired — (String)

          Ingestion status.

          Possible values include:
          • "INITIALIZED"
          • "QUEUED"
          • "RUNNING"
          • "FAILED"
          • "COMPLETED"
          • "CANCELLED"
        • ErrorInfo — (map)

          Error information for this ingestion.

          • Type — (String)

            Error type.

            Possible values include:
            • "FAILURE_TO_ASSUME_ROLE"
            • "INGESTION_SUPERSEDED"
            • "INGESTION_CANCELED"
            • "DATA_SET_DELETED"
            • "DATA_SET_NOT_SPICE"
            • "S3_UPLOADED_FILE_DELETED"
            • "S3_MANIFEST_ERROR"
            • "DATA_TOLERANCE_EXCEPTION"
            • "SPICE_TABLE_NOT_FOUND"
            • "DATA_SET_SIZE_LIMIT_EXCEEDED"
            • "ROW_SIZE_LIMIT_EXCEEDED"
            • "ACCOUNT_CAPACITY_LIMIT_EXCEEDED"
            • "CUSTOMER_ERROR"
            • "DATA_SOURCE_NOT_FOUND"
            • "IAM_ROLE_NOT_AVAILABLE"
            • "CONNECTION_FAILURE"
            • "SQL_TABLE_NOT_FOUND"
            • "PERMISSION_DENIED"
            • "SSL_CERTIFICATE_VALIDATION_FAILURE"
            • "OAUTH_TOKEN_FAILURE"
            • "SOURCE_API_LIMIT_EXCEEDED_FAILURE"
            • "PASSWORD_AUTHENTICATION_FAILURE"
            • "SQL_SCHEMA_MISMATCH_ERROR"
            • "INVALID_DATE_FORMAT"
            • "INVALID_DATAPREP_SYNTAX"
            • "SOURCE_RESOURCE_LIMIT_EXCEEDED"
            • "SQL_INVALID_PARAMETER_VALUE"
            • "QUERY_TIMEOUT"
            • "SQL_NUMERIC_OVERFLOW"
            • "UNRESOLVABLE_HOST"
            • "UNROUTABLE_HOST"
            • "SQL_EXCEPTION"
            • "S3_FILE_INACCESSIBLE"
            • "IOT_FILE_NOT_FOUND"
            • "IOT_DATA_SET_FILE_EMPTY"
            • "INVALID_DATA_SOURCE_CONFIG"
            • "DATA_SOURCE_AUTH_FAILED"
            • "DATA_SOURCE_CONNECTION_FAILED"
            • "FAILURE_TO_PROCESS_JSON_FILE"
            • "INTERNAL_SERVICE_ERROR"
          • Message — (String)

            Error essage.

        • RowInfo — (map)

          Information on rows during a data set SPICE ingestion.

          • RowsIngested — (Integer)

            The number of rows that were ingested.

          • RowsDropped — (Integer)

            The number of rows that were not ingested.

        • QueueInfo — (map)

          Information on queued dataset SPICE ingestion.

          • WaitingOnIngestionrequired — (String)

            The ID of the queued ingestion.

          • QueuedIngestionrequired — (String)

            The ID of the ongoing ingestion. The queued ingestion is waiting for the ongoing ingestion to complete.

        • CreatedTimerequired — (Date)

          The time this ingestion started.

        • IngestionTimeInSeconds — (Integer)

          The time this ingestion took, measured in seconds.

        • IngestionSizeInBytes — (Integer)

          Size of the data ingested in bytes.

        • RequestSource — (String)

          Event source for this ingestion.

          Possible values include:
          • "MANUAL"
          • "SCHEDULED"
        • RequestType — (String)

          Type of this ingestion.

          Possible values include:
          • "INITIAL_INGESTION"
          • "EDIT"
          • "INCREMENTAL_REFRESH"
          • "FULL_REFRESH"
      • 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.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listTagsForResource(params = {}, callback) ⇒ AWS.Request

Lists the tags assigned to a resource.

CLI syntax:

  • aws quicksight list-tags-for-resource --resource-arn arn:aws:quicksight:us-east-1:111111111111:dataset/dataset1 --region us-east-1

Service Reference:

Examples:

Calling the listTagsForResource operation

var params = {
  ResourceArn: 'STRING_VALUE' /* required */
};
quicksight.listTagsForResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ResourceArn — (String)

      The ARN of the resource you want a list of tags for.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Tags — (Array<map>)

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

        • Keyrequired — (String)

          Tag key.

        • Valuerequired — (String)

          Tag value.

      • RequestId — (String)

        The AWS request ID for this operation.

      • Status — (Integer)

        The http status of the request.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listTemplateAliases(params = {}, callback) ⇒ AWS.Request

Lists all the aliases of a template.

CLI syntax:

aws quicksight list-template-aliases --aws-account-id 111122223333 —template-id 'reports_test_template'

Service Reference:

Examples:

Calling the listTemplateAliases operation

var params = {
  AwsAccountId: 'STRING_VALUE', /* required */
  TemplateId: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
quicksight.listTemplateAliases(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • AwsAccountId — (String)

      AWS account ID that contains the template aliases you are listing.

    • TemplateId — (String)

      The ID for the template.

    • NextToken — (String)

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

    • MaxResults — (Integer)

      The maximum number of results to be returned per request.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • TemplateAliasList — (Array<map>)

        A structure containing the list of template aliases.

        • AliasName — (String)

          The display name of the template alias.

        • Arn — (String)

          The ARN of the template alias.

        • TemplateVersionNumber — (Integer)

          The version number of the template alias.

      • Status — (Integer)

        The http status of the request.

      • RequestId — (String)

        The AWS request ID for this operation.

      • NextToken — (String)

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

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listTemplates(params = {}, callback) ⇒ AWS.Request

Lists all the templates in the QuickSight account.

CLI syntax:

aws quicksight list-templates --aws-account-id 111122223333 --max-results 1 —next-token AYADeJuxwOypAndSoOn

Service Reference:

Examples:

Calling the listTemplates operation

var params = {
  AwsAccountId: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
quicksight.listTemplates(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • AwsAccountId — (String)

      AWS account ID that contains the templates you are listing.

    • NextToken — (String)

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

    • MaxResults — (Integer)

      The maximum number of results to be returned per request.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • TemplateSummaryList — (Array<map>)

        A structure containing information about the templates in the list.

        • Arn — (String)

          A summary of a template.

        • TemplateId — (String)

          The ID of the template. This is unique per region per AWS account.

        • Name — (String)

          A display name for the template.

        • LatestVersionNumber — (Integer)

          A structure containing a list of version numbers for the template summary.

        • CreatedTime — (Date)

          The last time this was created.

        • LastUpdatedTime — (Date)

          The last time this was updated.

      • NextToken — (String)

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

      • Status — (Integer)

        The http status of the request.

      • RequestId — (String)

        The AWS request ID for this operation.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listTemplateVersions(params = {}, callback) ⇒ AWS.Request

Lists all the versions of the templates in the Quicksight account.

CLI syntax:

aws quicksight list-template-versions --aws-account-id 111122223333 --aws-account-id 196359894473 --template-id reports-test-template

Service Reference:

Examples:

Calling the listTemplateVersions operation

var params = {
  AwsAccountId: 'STRING_VALUE', /* required */
  TemplateId: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
quicksight.listTemplateVersions(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • AwsAccountId — (String)

      AWS account ID that contains the templates you are listing.

    • TemplateId — (String)

      The ID for the template.

    • NextToken — (String)

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

    • MaxResults — (Integer)

      The maximum number of results to be returned per request.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • TemplateVersionSummaryList — (Array<map>)

        A structure containing a list of all the versions of the specified template.

        • Arn — (String)

          The ARN of the template version.

        • VersionNumber — (Integer)

          The version number of the template version.

        • CreatedTime — (Date)

          The time this was created.

        • Status — (String)

          The status of the template version.

          Possible values include:
          • "CREATION_IN_PROGRESS"
          • "CREATION_SUCCESSFUL"
          • "CREATION_FAILED"
          • "UPDATE_IN_PROGRESS"
          • "UPDATE_SUCCESSFUL"
          • "UPDATE_FAILED"
        • Description — (String)

          The desription of the template version.

      • NextToken — (String)

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

      • Status — (Integer)

        The http status of the request.

      • RequestId — (String)

        The AWS request ID for this operation.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listUserGroups(params = {}, callback) ⇒ AWS.Request

Lists the Amazon QuickSight groups that an Amazon QuickSight user is a member of.

The response is a one or more group objects.

CLI Sample:

aws quicksight list-user-groups --user-name=Pat --aws-account-id=111122223333 --namespace=default --region=us-east-1

Service Reference:

Examples:

Calling the listUserGroups operation

var params = {
  AwsAccountId: 'STRING_VALUE', /* required */
  Namespace: 'STRING_VALUE', /* required */
  UserName: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
quicksight.listUserGroups(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • UserName — (String)

      The Amazon QuickSight user name that you want to list group memberships for.

    • AwsAccountId — (String)

      The AWS Account ID that the user is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.

    • Namespace — (String)

      The namespace. Currently, you should set this to default.

    • NextToken — (String)

      A pagination token that can be used in a subsequent request.

    • MaxResults — (Integer)

      The maximum number of results to return from this request.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • GroupList — (Array<map>)

        The list of groups the user is a member of.

        • Arn — (String)

          The Amazon Resource name (ARN) for the group.

        • GroupName — (String)

          The name of the group.

        • Description — (String)

          The group description.

        • PrincipalId — (String)

          The principal ID of the group.

      • NextToken — (String)

        A pagination token that can be used in a subsequent request.

      • RequestId — (String)

        The AWS request ID for this operation.

      • Status — (Integer)

        The HTTP status of the request.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listUsers(params = {}, callback) ⇒ AWS.Request

Returns a list of all of the Amazon QuickSight users belonging to this account.

The response is a list of user objects, containing each user's Amazon Resource Name (ARN), AWS Identity and Access Management (IAM) role, and email address.

CLI Sample:

aws quicksight list-users --aws-account-id=111122223333 --namespace=default

Service Reference:

Examples:

Calling the listUsers operation

var params = {
  AwsAccountId: 'STRING_VALUE', /* required */
  Namespace: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
quicksight.listUsers(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • AwsAccountId — (String)

      The ID for the AWS account that the user is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.

    • NextToken — (String)

      A pagination token that can be used in a subsequent request.

    • MaxResults — (Integer)

      The maximum number of results to return from this request.

    • Namespace — (String)

      The namespace. Currently, you should set this to default.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • UserList — (Array<map>)

        The list of users.

        • Arn — (String)

          The Amazon Resource name (ARN) for the user.

        • UserName — (String)

          The user's user name.

        • Email — (String)

          The user's email address.

        • Role — (String)

          The Amazon QuickSight role for the user. The user role can be one of the following:.

          • READER: A user who has read-only access to dashboards.

          • AUTHOR: A user who can create data sources, datasets, analyses, and dashboards.

          • ADMIN: A user who is an author, who can also manage Amazon QuickSight settings.

          • RESTRICTED_READER: This role isn't currently available for use.

          • RESTRICTED_AUTHOR: This role isn't currently available for use.

          Possible values include:
          • "ADMIN"
          • "AUTHOR"
          • "READER"
          • "RESTRICTED_AUTHOR"
          • "RESTRICTED_READER"
        • IdentityType — (String)

          The type of identity authentication used by the user.

          Possible values include:
          • "IAM"
          • "QUICKSIGHT"
        • Active — (Boolean)

          Active status of user. When you create an Amazon QuickSight user that’s not an IAM user or an AD user, that user is inactive until they sign in and provide a password.

        • PrincipalId — (String)

          The principal ID of the user.

      • NextToken — (String)

        A pagination token that can be used in a subsequent request.

      • RequestId — (String)

        The AWS request ID for this operation.

      • Status — (Integer)

        The http status of the request.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

registerUser(params = {}, callback) ⇒ AWS.Request

Creates an Amazon QuickSight user, whose identity is associated with the AWS Identity and Access Management (IAM) identity or role specified in the request.

CLI Sample:

aws quicksight register-user --aws-account-id=111122223333 --namespace=default --email=pat@example.com --identity-type=IAM --user-role=AUTHOR --iam-arn=arn:aws:iam::111122223333:user/Pat

Service Reference:

Examples:

Calling the registerUser operation

var params = {
  AwsAccountId: 'STRING_VALUE', /* required */
  Email: 'STRING_VALUE', /* required */
  IdentityType: IAM | QUICKSIGHT, /* required */
  Namespace: 'STRING_VALUE', /* required */
  UserRole: ADMIN | AUTHOR | READER | RESTRICTED_AUTHOR | RESTRICTED_READER, /* required */
  IamArn: 'STRING_VALUE',
  SessionName: 'STRING_VALUE',
  UserName: 'STRING_VALUE'
};
quicksight.registerUser(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • IdentityType — (String)

      Amazon QuickSight supports several ways of managing the identity of users. This parameter accepts two values:

      • IAM: A user whose identity maps to an existing IAM user or role.

      • QUICKSIGHT: A user whose identity is owned and managed internally by Amazon QuickSight.

      Possible values include:
      • "IAM"
      • "QUICKSIGHT"
    • Email — (String)

      The email address of the user that you want to register.

    • UserRole — (String)

      The Amazon QuickSight role for the user. The user role can be one of the following:

      • READER: A user who has read-only access to dashboards.

      • AUTHOR: A user who can create data sources, datasets, analyses, and dashboards.

      • ADMIN: A user who is an author, who can also manage Amazon QuickSight settings.

      • RESTRICTED_READER: This role isn't currently available for use.

      • RESTRICTED_AUTHOR: This role isn't currently available for use.

      Possible values include:
      • "ADMIN"
      • "AUTHOR"
      • "READER"
      • "RESTRICTED_AUTHOR"
      • "RESTRICTED_READER"
    • IamArn — (String)

      The ARN of the IAM user or role that you are registering with Amazon QuickSight.

    • SessionName — (String)

      You need to use this parameter only when you register one or more users using an assumed IAM role. You don't need to provide the session name for other scenarios, for example when you are registering an IAM user or an Amazon QuickSight user. You can register multiple users using the same IAM role if each user has a different session name. For more information on assuming IAM roles, see assume-role in the AWS CLI Reference.

    • AwsAccountId — (String)

      The ID for the AWS account that the user is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.

    • Namespace — (String)

      The namespace. Currently, you should set this to default.

    • UserName — (String)

      The Amazon QuickSight user name that you want to create for the user you are registering.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • User — (map)

        The user name.

        • Arn — (String)

          The Amazon Resource name (ARN) for the user.

        • UserName — (String)

          The user's user name.

        • Email — (String)

          The user's email address.

        • Role — (String)

          The Amazon QuickSight role for the user. The user role can be one of the following:.

          • READER: A user who has read-only access to dashboards.

          • AUTHOR: A user who can create data sources, datasets, analyses, and dashboards.

          • ADMIN: A user who is an author, who can also manage Amazon QuickSight settings.

          • RESTRICTED_READER: This role isn't currently available for use.

          • RESTRICTED_AUTHOR: This role isn't currently available for use.

          Possible values include:
          • "ADMIN"
          • "AUTHOR"
          • "READER"
          • "RESTRICTED_AUTHOR"
          • "RESTRICTED_READER"
        • IdentityType — (String)

          The type of identity authentication used by the user.

          Possible values include:
          • "IAM"
          • "QUICKSIGHT"
        • Active — (Boolean)

          Active status of user. When you create an Amazon QuickSight user that’s not an IAM user or an AD user, that user is inactive until they sign in and provide a password.

        • PrincipalId — (String)

          The principal ID of the user.

      • UserInvitationUrl — (String)

        The URL the user visits to complete registration and provide a password. This is returned only for users with an identity type of QUICKSIGHT.

      • RequestId — (String)

        The AWS request ID for this operation.

      • Status — (Integer)

        The http status of the request.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

tagResource(params = {}, callback) ⇒ AWS.Request

Assigns a tag or tags to a resource.

Assigns one or more tags (key-value pairs) to the specified QuickSight resource. Tags can help you organize and categorize your resources. You can also use them to scope user permissions, by granting a user permission to access or change only resources with certain tag values. You can use the TagResource action with a resource that already has tags. If you specify a new tag key for the resource, this tag is appended to the list of tags associated with the resource. If you specify a tag key that is already associated with the resource, the new tag value that you specify replaces the previous value for that tag.

You can associate as many as 50 tags with a resource. QuickSight supports tagging on data-set, data-source, dashboard, template.

Tagging for QuickSight works in a similar was to tagging for other AWS services, except for the following:

  • You can't use tags to track AWS costs for QuickSight, because QuickSight costs are based on users and SPICE capacity, which aren't taggable resources.

  • QuickSight doesn't currently support the Tag Editor for AWS Resource Groups.

CLI syntax to tag a resource:

  • aws quicksight tag-resource --resource-arn arn:aws:quicksight:us-east-1:111111111111:dataset/dataset1 --tags Key=K1,Value=V1 Key=K2,Value=V2 --region us-east-1

Service Reference:

Examples:

Calling the tagResource operation

var params = {
  ResourceArn: 'STRING_VALUE', /* required */
  Tags: [ /* required */
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
quicksight.tagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ResourceArn — (String)

      The ARN of the resource you want to tag.

    • Tags — (Array<map>)

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

      • Keyrequired — (String)

        Tag key.

      • Valuerequired — (String)

        Tag value.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • RequestId — (String)

        The AWS request ID for this operation.

      • Status — (Integer)

        The http status of the request.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

untagResource(params = {}, callback) ⇒ AWS.Request

Removes a tag or tags from a resource.

CLI syntax:

  • aws quicksight untag-resource --resource-arn arn:aws:quicksight:us-east-1:111111111111:dataset/dataset1 --tag-keys K1 K2 --region us-east-1

Service Reference:

Examples:

Calling the untagResource operation

var params = {
  ResourceArn: 'STRING_VALUE', /* required */
  TagKeys: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
quicksight.untagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ResourceArn — (String)

      The ARN of the resource you to untag.

    • TagKeys — (Array<String>)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • RequestId — (String)

        The AWS request ID for this operation.

      • Status — (Integer)

        The http status of the request.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

updateDashboard(params = {}, callback) ⇒ AWS.Request

Updates a dashboard in the AWS account.

CLI syntax:

aws quicksight update-dashboard --aws-account-id 111122223333 --dashboard-id 123123123 --dashboard-name "test-update102" --source-entity SourceTemplate={Arn=arn:aws:quicksight:us-west-2:111122223333:template/sales-report-template2} --data-set-references DataSetPlaceholder=SalesDataSet,DataSetArn=arn:aws:quicksight:us-west-2:111122223333:dataset/0e251aef-9ebf-46e1-b852-eb4fa33c1d3a

aws quicksight update-dashboard --cli-input-json file://update-dashboard.json

Service Reference:

Examples:

Calling the updateDashboard operation

var params = {
  AwsAccountId: 'STRING_VALUE', /* required */
  DashboardId: 'STRING_VALUE', /* required */
  Name: 'STRING_VALUE', /* required */
  SourceEntity: { /* required */
    SourceTemplate: {
      Arn: 'STRING_VALUE', /* required */
      DataSetReferences: [ /* required */
        {
          DataSetArn: 'STRING_VALUE', /* required */
          DataSetPlaceholder: 'STRING_VALUE' /* required */
        },
        /* more items */
      ]
    }
  },
  DashboardPublishOptions: {
    AdHocFilteringOption: {
      AvailabilityStatus: ENABLED | DISABLED
    },
    ExportToCSVOption: {
      AvailabilityStatus: ENABLED | DISABLED
    },
    SheetControlsOption: {
      VisibilityState: EXPANDED | COLLAPSED
    }
  },
  Parameters: {
    DateTimeParameters: [
      {
        Name: 'STRING_VALUE', /* required */
        Values: [ /* required */
          new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
          /* more items */
        ]
      },
      /* more items */
    ],
    DecimalParameters: [
      {
        Name: 'STRING_VALUE', /* required */
        Values: [ /* required */
          'NUMBER_VALUE',
          /* more items */
        ]
      },
      /* more items */
    ],
    IntegerParameters: [
      {
        Name: 'STRING_VALUE', /* required */
        Values: [ /* required */
          'NUMBER_VALUE',
          /* more items */
        ]
      },
      /* more items */
    ],
    StringParameters: [
      {
        Name: 'STRING_VALUE', /* required */
        Values: [ /* required */
          'STRING_VALUE',
          /* more items */
        ]
      },
      /* more items */
    ]
  },
  VersionDescription: 'STRING_VALUE'
};
quicksight.updateDashboard(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • AwsAccountId — (String)

      AWS account ID that contains the dashboard you are updating.

    • DashboardId — (String)

      The ID for the dashboard.

    • Name — (String)

      The display name of the dashboard.

    • SourceEntity — (map)

      The template or analysis from which the dashboard is created. The SouceTemplate entity accepts the Arn of the template and also references to replacement datasets for the placeholders set when creating the template. The replacement datasets need to follow the same schema as the datasets for which placeholders were created when creating the template.

      • SourceTemplate — (map)

        Source template.

        • DataSetReferencesrequired — (Array<map>)

          Dataset references.

          • DataSetPlaceholderrequired — (String)

            Dataset placeholder.

          • DataSetArnrequired — (String)

            Dataset ARN.

        • Arnrequired — (String)

          The Amazon Resource name (ARN) of the resource.

    • Parameters — (map)

      A structure that contains the parameters of the dashboard.

      • StringParameters — (Array<map>)

        String parameters.

        • Namerequired — (String)

          A display name for the dataset.

        • Valuesrequired — (Array<String>)

          Values.

      • IntegerParameters — (Array<map>)

        Integer parameters.

        • Namerequired — (String)

          A display name for the dataset.

        • Valuesrequired — (Array<Integer>)

          Values.

      • DecimalParameters — (Array<map>)

        Decimal parameters.

        • Namerequired — (String)

          A display name for the dataset.

        • Valuesrequired — (Array<Float>)

          Values.

      • DateTimeParameters — (Array<map>)

        DateTime parameters.

        • Namerequired — (String)

          A display name for the dataset.

        • Valuesrequired — (Array<Date>)

          Values.

    • VersionDescription — (String)

      A description for the first version of the dashboard being created.

    • DashboardPublishOptions — (map)

      Publishing options when creating a dashboard.

      • AvailabilityStatus for AdHocFilteringOption - This can be either ENABLED or DISABLED. When This is set to set to DISABLED, QuickSight disables the left filter pane on the published dashboard, which can be used for AdHoc filtering. Enabled by default.

      • AvailabilityStatus for ExportToCSVOption - This can be either ENABLED or DISABLED. The visual option to export data to CSV is disabled when this is set to DISABLED. Enabled by default.

      • VisibilityState for SheetControlsOption - This can be either COLLAPSED or EXPANDED. The sheet controls pane is collapsed by default when set to true. Collapsed by default.

      • AdHocFilteringOption — (map)

        Ad hoc filtering option.

        • AvailabilityStatus — (String)

          Availability status.

          Possible values include:
          • "ENABLED"
          • "DISABLED"
      • ExportToCSVOption — (map)

        Export to CSV option.

        • AvailabilityStatus — (String)

          Availability status.

          Possible values include:
          • "ENABLED"
          • "DISABLED"
      • SheetControlsOption — (map)

        Sheet controls option.

        • VisibilityState — (String)

          Visibility state.

          Possible values include:
          • "EXPANDED"
          • "COLLAPSED"

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Arn — (String)

        The ARN of the resource.

      • VersionArn — (String)

        The ARN of the dashboard, including the version number.

      • DashboardId — (String)

        The ID for the dashboard.

      • CreationStatus — (String)

        The creation status of the request.

        Possible values include:
        • "CREATION_IN_PROGRESS"
        • "CREATION_SUCCESSFUL"
        • "CREATION_FAILED"
        • "UPDATE_IN_PROGRESS"
        • "UPDATE_SUCCESSFUL"
        • "UPDATE_FAILED"
      • Status — (Integer)

        The http status of the request.

      • RequestId — (String)

        The AWS request ID for this operation.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

updateDashboardPermissions(params = {}, callback) ⇒ AWS.Request

Updates read and write permissions on a dashboard.

CLI syntax:

aws quicksight update-dashboard-permissions —cli-input-json file://update-permission.json

A sample update-permissions.json for granting read only permissions:

{ "AwsAccountId": "111122223333", "DashboardId": "reports_test_report", "GrantPermissions": [ { "Principal": "arn:aws:quicksight:us-east-1:111122223333:user/default/user2", "Actions": [ "quicksight:DescribeDashboard", "quicksight:ListDashboardVersions", "quicksight:DescribeDashboardVersion", "quicksight:QueryDashboard" ] } ] }

A sample update-permissions.json for granting read and write permissions:

{ "AwsAccountId": "111122223333", "DashboardId": "reports_test_report", "GrantPermissions": [ { "Principal": "arn:aws:quicksight:us-east-1:111122223333:user/default/user2", "Actions": [ "quicksight:DescribeDashboard", "quicksight:ListDashboardVersions", "quicksight:DescribeDashboardVersion", "quicksight:QueryDashboard", "quicksight:DescribeDashboardPermissions", "quicksight:UpdateDashboardPermissions", "quicksight:DeleteDashboardVersion", "quicksight:DeleteDashboard", "quicksight:UpdateDashboard", "quicksight:UpdateDashboardPublishedVersion", ] } ] }

A sample update-permissions.json for revoking write permissions:

{ "AwsAccountId": "111122223333", "DashboardId": "reports_test_report", "RevokePermissions": [ { "Principal": "arn:aws:quicksight:us-east-1:111122223333:user/default/user2", "Actions": [ "quicksight:DescribeDashboardPermissions", "quicksight:UpdateDashboardPermissions", "quicksight:DeleteDashboardVersion", "quicksight:DeleteDashboard", "quicksight:UpdateDashboard", "quicksight:UpdateDashboardPublishedVersion", ] } ] }

A sample update-permissions.json for revoking read and write permissions:

{ "AwsAccountId": "111122223333", "DashboardId": "reports_test_report", "RevokePermissions": [ { "Principal": "arn:aws:quicksight:us-east-1:111122223333:user/default/user2", "Actions": [ "quicksight:DescribeDashboard", "quicksight:ListDashboardVersions", "quicksight:DescribeDashboardVersion", "quicksight:QueryDashboard", "quicksight:DescribeDashboardPermissions", "quicksight:UpdateDashboardPermissions", "quicksight:DeleteDashboardVersion", "quicksight:DeleteDashboard", "quicksight:UpdateDashboard", "quicksight:UpdateDashboardPublishedVersion", ] } ] }

To obtain the principal name of a QuickSight user or group, you can use describe-group or describe-user. For example:

aws quicksight describe-user --aws-account-id 111122223333 --namespace default --user-name user2 --region us-east-1 { "User": { "Arn": "arn:aws:quicksight:us-east-1:111122223333:user/default/user2", "Active": true, "Email": "user2@example.com", "Role": "ADMIN", "UserName": "user2", "PrincipalId": "federated/iam/abcd2abcdabcdeabc5ab5" }, "RequestId": "8f74bb31-6291-448a-a71c-a765a44bae31", "Status": 200 }

Service Reference:

Examples:

Calling the updateDashboardPermissions operation

var params = {
  AwsAccountId: 'STRING_VALUE', /* required */
  DashboardId: 'STRING_VALUE', /* required */
  GrantPermissions: [
    {
      Actions: [ /* required */
        'STRING_VALUE',
        /* more items */
      ],
      Principal: 'STRING_VALUE' /* required */
    },
    /* more items */
  ],
  RevokePermissions: [
    {
      Actions: [ /* required */
        'STRING_VALUE',
        /* more items */
      ],
      Principal: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
quicksight.updateDashboardPermissions(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • AwsAccountId — (String)

      AWS account ID that contains the dashboard you are updating.

    • DashboardId — (String)

      The ID for the dashboard.

    • GrantPermissions — (Array<map>)

      The permissions that you want to grant on this resource.

      • Principalrequired — (String)

        The ARN of a QuickSight user or group, or an IAM ARN. If you are using cross-account resource sharing, this is the IAM ARN of an account root. Otherwise, it is the ARN of a QuickSight user or group. .

      • Actionsrequired — (Array<String>)

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

    • RevokePermissions — (Array<map>)

      The permissions that you want to revoke from this resource.

      • Principalrequired — (String)

        The ARN of a QuickSight user or group, or an IAM ARN. If you are using cross-account resource sharing, this is the IAM ARN of an account root. Otherwise, it is the ARN of a QuickSight user or group. .

      • Actionsrequired — (Array<String>)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • DashboardArn — (String)

        The ARN of the dashboard.

      • DashboardId — (String)

        The ID for the dashboard.

      • Permissions — (Array<map>)

        Information about the permissions on the dashboard.

        • Principalrequired — (String)

          The ARN of a QuickSight user or group, or an IAM ARN. If you are using cross-account resource sharing, this is the IAM ARN of an account root. Otherwise, it is the ARN of a QuickSight user or group. .

        • Actionsrequired — (Array<String>)

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

      • RequestId — (String)

        The AWS request ID for this operation.

      • Status — (Integer)

        The http status of the request.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

updateDashboardPublishedVersion(params = {}, callback) ⇒ AWS.Request

Updates the published version of a dashboard.

CLI syntax:

aws quicksight update-dashboard-published-version --aws-account-id 111122223333 --dashboard-id dashboard-w1 ---version-number 2

Service Reference:

Examples:

Calling the updateDashboardPublishedVersion operation

var params = {
  AwsAccountId: 'STRING_VALUE', /* required */
  DashboardId: 'STRING_VALUE', /* required */
  VersionNumber: 'NUMBER_VALUE' /* required */
};
quicksight.updateDashboardPublishedVersion(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • AwsAccountId — (String)

      AWS account ID that contains the dashboard you are updating.

    • DashboardId — (String)

      The ID for the dashboard.

    • VersionNumber — (Integer)

      The version number of the dashboard.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • DashboardId — (String)

        The ID for the dashboard.

      • DashboardArn — (String)

        The ARN of the dashboard.

      • Status — (Integer)

        The http status of the request.

      • RequestId — (String)

        The AWS request ID for this operation.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

updateDataSet(params = {}, callback) ⇒ AWS.Request

Updates a dataset.

CLI syntax:

aws quicksight update-data-set \

--aws-account-id=111122223333 \

--data-set-id=unique-data-set-id \

--name='My dataset' \

--import-mode=SPICE \

--physical-table-map='{

"physical-table-id": {

"RelationalTable": {

"DataSourceArn": "arn:aws:quicksight:us-west-2:111111111111:datasource/data-source-id",

"Name": "table1",

"InputColumns": [

{

"Name": "column1",

"Type": "STRING"

}

]

}

}'

Service Reference:

Examples:

Calling the updateDataSet operation

var params = {
  AwsAccountId: 'STRING_VALUE', /* required */
  DataSetId: 'STRING_VALUE', /* required */
  ImportMode: SPICE | DIRECT_QUERY, /* required */
  Name: 'STRING_VALUE', /* required */
  PhysicalTableMap: { /* required */
    '<PhysicalTableId>': {
      CustomSql: {
        DataSourceArn: 'STRING_VALUE', /* required */
        Name: 'STRING_VALUE', /* required */
        SqlQuery: 'STRING_VALUE', /* required */
        Columns: [
          {
            Name: 'STRING_VALUE', /* required */
            Type: STRING | INTEGER | DECIMAL | DATETIME | BIT | BOOLEAN | JSON /* required */
          },
          /* more items */
        ]
      },
      RelationalTable: {
        DataSourceArn: 'STRING_VALUE', /* required */
        InputColumns: [ /* required */
          {
            Name: 'STRING_VALUE', /* required */
            Type: STRING | INTEGER | DECIMAL | DATETIME | BIT | BOOLEAN | JSON /* required */
          },
          /* more items */
        ],
        Name: 'STRING_VALUE', /* required */
        Schema: 'STRING_VALUE'
      },
      S3Source: {
        DataSourceArn: 'STRING_VALUE', /* required */
        InputColumns: [ /* required */
          {
            Name: 'STRING_VALUE', /* required */
            Type: STRING | INTEGER | DECIMAL | DATETIME | BIT | BOOLEAN | JSON /* required */
          },
          /* more items */
        ],
        UploadSettings: {
          ContainsHeader: true || false,
          Delimiter: 'STRING_VALUE',
          Format: CSV | TSV | CLF | ELF | XLSX | JSON,
          StartFromRow: 'NUMBER_VALUE',
          TextQualifier: DOUBLE_QUOTE | SINGLE_QUOTE
        }
      }
    },
    /* '<PhysicalTableId>': ... */
  },
  ColumnGroups: [
    {
      GeoSpatialColumnGroup: {
        Columns: [ /* required */
          'STRING_VALUE',
          /* more items */
        ],
        CountryCode: US, /* required */
        Name: 'STRING_VALUE' /* required */
      }
    },
    /* more items */
  ],
  LogicalTableMap: {
    '<LogicalTableId>': {
      Alias: 'STRING_VALUE', /* required */
      Source: { /* required */
        JoinInstruction: {
          LeftOperand: 'STRING_VALUE', /* required */
          OnClause: 'STRING_VALUE', /* required */
          RightOperand: 'STRING_VALUE', /* required */
          Type: INNER | OUTER | LEFT | RIGHT /* required */
        },
        PhysicalTableId: 'STRING_VALUE'
      },
      DataTransforms: [
        {
          CastColumnTypeOperation: {
            ColumnName: 'STRING_VALUE', /* required */
            NewColumnType: STRING | INTEGER | DECIMAL | DATETIME, /* required */
            Format: 'STRING_VALUE'
          },
          CreateColumnsOperation: {
            Columns: [ /* required */
              {
                ColumnId: 'STRING_VALUE', /* required */
                ColumnName: 'STRING_VALUE', /* required */
                Expression: 'STRING_VALUE' /* required */
              },
              /* more items */
            ]
          },
          FilterOperation: {
            ConditionExpression: 'STRING_VALUE' /* required */
          },
          ProjectOperation: {
            ProjectedColumns: [ /* required */
              'STRING_VALUE',
              /* more items */
            ]
          },
          RenameColumnOperation: {
            ColumnName: 'STRING_VALUE', /* required */
            NewColumnName: 'STRING_VALUE' /* required */
          },
          TagColumnOperation: {
            ColumnName: 'STRING_VALUE', /* required */
            Tags: [ /* required */
              {
                ColumnGeographicRole: COUNTRY | STATE | COUNTY | CITY | POSTCODE | LONGITUDE | LATITUDE
              },
              /* more items */
            ]
          }
        },
        /* more items */
      ]
    },
    /* '<LogicalTableId>': ... */
  },
  RowLevelPermissionDataSet: {
    Arn: 'STRING_VALUE', /* required */
    PermissionPolicy: GRANT_ACCESS | DENY_ACCESS /* required */
  }
};
quicksight.updateDataSet(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • AwsAccountId — (String)

      The AWS Account ID.

    • DataSetId — (String)

      The ID for the dataset you want to create. This is unique per region per AWS account.

    • Name — (String)

      The display name for the dataset.

    • PhysicalTableMap — (map<map>)

      Declares the physical tables that are available in the underlying data sources.

      • RelationalTable — (map)

        A physical table type for relational data sources.

        • DataSourceArnrequired — (String)

          Data source ARN.

        • Schema — (String)

          The schema name. Applies to certain relational database engines.

        • Namerequired — (String)

          Name of the relational table.

        • InputColumnsrequired — (Array<map>)

          The column schema of the table.

          • Namerequired — (String)

            The name of this column in the underlying data source.

          • Typerequired — (String)

            The data type of the column.

            Possible values include:
            • "STRING"
            • "INTEGER"
            • "DECIMAL"
            • "DATETIME"
            • "BIT"
            • "BOOLEAN"
            • "JSON"
      • CustomSql — (map)

        A physical table type built from the results of the custom SQL query.

        • DataSourceArnrequired — (String)

          The ARN of the data source.

        • Namerequired — (String)

          A display name for the SQL query result.

        • SqlQueryrequired — (String)

          The SQL query.

        • Columns — (Array<map>)

          The column schema from the SQL query result set.

          • Namerequired — (String)

            The name of this column in the underlying data source.

          • Typerequired — (String)

            The data type of the column.

            Possible values include:
            • "STRING"
            • "INTEGER"
            • "DECIMAL"
            • "DATETIME"
            • "BIT"
            • "BOOLEAN"
            • "JSON"
      • S3Source — (map)

        A physical table type for as S3 data source.

        • DataSourceArnrequired — (String)

          Data source ARN.

        • UploadSettings — (map)

          Information on the S3 source file(s) format.

          • Format — (String)

            File format.

            Possible values include:
            • "CSV"
            • "TSV"
            • "CLF"
            • "ELF"
            • "XLSX"
            • "JSON"
          • StartFromRow — (Integer)

            A row number to start reading data from.

          • ContainsHeader — (Boolean)

            Whether or not the file(s) has a header row.

          • TextQualifier — (String)

            Text qualifier.

            Possible values include:
            • "DOUBLE_QUOTE"
            • "SINGLE_QUOTE"
          • Delimiter — (String)

            The delimiter between values in the file.

        • InputColumnsrequired — (Array<map>)

          A physical table type for as S3 data source.

          • Namerequired — (String)

            The name of this column in the underlying data source.

          • Typerequired — (String)

            The data type of the column.

            Possible values include:
            • "STRING"
            • "INTEGER"
            • "DECIMAL"
            • "DATETIME"
            • "BIT"
            • "BOOLEAN"
            • "JSON"
    • LogicalTableMap — (map<map>)

      Configures the combination and transformation of the data from the physical tables.

      • Aliasrequired — (String)

        A display name for the logical table.

      • DataTransforms — (Array<map>)

        Transform operations that act on this logical table.

        • ProjectOperation — (map)

          An operation that projects columns. Operations that come after a projection can only refer to projected columns.

          • ProjectedColumnsrequired — (Array<String>)

            Projected columns.

        • FilterOperation — (map)

          An operation that filters rows based on some condition.

          • ConditionExpressionrequired — (String)

            An expression that must evaluate to a boolean value. Rows for which the expression is evaluated to true are kept in the dataset.

        • CreateColumnsOperation — (map)

          An operation that creates calculated columns. Columns created in one such operation form a lexical closure.

          • Columnsrequired — (Array<map>)

            Calculated columns to create.

            • ColumnNamerequired — (String)

              Column name.

            • ColumnIdrequired — (String)

              A unique ID to identify a calculated column. During dataset update, if the column ID of a calculated column matches that of an existing calculated column, QuickSight preserves the existing calculated column.

            • Expressionrequired — (String)

              An expression that defines the calculated column.

        • RenameColumnOperation — (map)

          An operation that renames a column.

          • ColumnNamerequired — (String)

            Name of the column to be renamed.

          • NewColumnNamerequired — (String)

            New name for the column.

        • CastColumnTypeOperation — (map)

          A transform operation that casts a column to a different type.

          • ColumnNamerequired — (String)

            Column name.

          • NewColumnTyperequired — (String)

            New column data type.

            Possible values include:
            • "STRING"
            • "INTEGER"
            • "DECIMAL"
            • "DATETIME"
          • Format — (String)

            When casting a column from string to datetime type, you can supply a QuickSight supported format string to denote the source data format.

        • TagColumnOperation — (map)

          An operation that tags a column with additional information.

          • ColumnNamerequired — (String)

            The column that this operation acts on.

          • Tagsrequired — (Array<map>)

            The dataset column tag, currently only used for geospatial type tagging. .

            Note: This is not tags for the AWS tagging feature. .
            • ColumnGeographicRole — (String)

              A geospatial role for a column.

              Possible values include:
              • "COUNTRY"
              • "STATE"
              • "COUNTY"
              • "CITY"
              • "POSTCODE"
              • "LONGITUDE"
              • "LATITUDE"
      • Sourcerequired — (map)

        Source of this logical table.

        • JoinInstruction — (map)

          Specifies the result of a join of two logical tables.

          • LeftOperandrequired — (String)

            Left operand.

          • RightOperandrequired — (String)

            Right operand.

          • Typerequired — (String)

            Type.

            Possible values include:
            • "INNER"
            • "OUTER"
            • "LEFT"
            • "RIGHT"
          • OnClauserequired — (String)

            On Clause.

        • PhysicalTableId — (String)

          Physical table ID.

    • ImportMode — (String)

      Indicates whether or not you want to import the data into SPICE.

      Possible values include:
      • "SPICE"
      • "DIRECT_QUERY"
    • ColumnGroups — (Array<map>)

      Groupings of columns that work together in certain QuickSight features. Currently only geospatial hierarchy is supported.

      • GeoSpatialColumnGroup — (map)

        Geospatial column group that denotes a hierarchy.

        • Namerequired — (String)

          A display name for the hierarchy.

        • CountryCoderequired — (String)

          Country code.

          Possible values include:
          • "US"
        • Columnsrequired — (Array<String>)

          Columns in this hierarchy.

    • RowLevelPermissionDataSet — (map)

      Row-level security configuration on the data you want to create.

      • Arnrequired — (String)

        The Amazon Resource name (ARN) of the permission dataset.

      • PermissionPolicyrequired — (String)

        Permission policy.

        Possible values include:
        • "GRANT_ACCESS"
        • "DENY_ACCESS"

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Arn — (String)

        The ARN of the dataset.

      • DataSetId — (String)

        The ID for the dataset you want to create. This is unique per region per AWS account.

      • IngestionArn — (String)

        The Amazon Resource Name (ARN) for the ingestion, which is triggered as a result of dataset creation if the import mode is SPICE

      • IngestionId — (String)

        The ID of the ingestion, which is triggered as a result of dataset creation if the import mode is SPICE

      • RequestId — (String)

        The AWS request ID for this operation.

      • Status — (Integer)

        The http status of the request.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

updateDataSetPermissions(params = {}, callback) ⇒ AWS.Request

Updates the permissions on a dataset.

The permissions resource is arn:aws:quicksight:region:aws-account-id:dataset/data-set-id

CLI syntax:

aws quicksight update-data-set-permissions \

--aws-account-id=111122223333 \

--data-set-id=unique-data-set-id \

--grant-permissions='[{"Principal":"arn:aws:quicksight:us-east-1:111122223333:user/default/user1","Actions":["quicksight:DescribeDataSet","quicksight:DescribeDataSetPermissions","quicksight:PassDataSet","quicksight:ListIngestions","quicksight:DescribeIngestion"]}]' \

--revoke-permissions='[{"Principal":"arn:aws:quicksight:us-east-1:111122223333:user/default/user2","Actions":["quicksight:UpdateDataSet","quicksight:DeleteDataSet","quicksight:UpdateDataSetPermissions","quicksight:CreateIngestion","quicksight:CancelIngestion"]}]'

Service Reference:

Examples:

Calling the updateDataSetPermissions operation

var params = {
  AwsAccountId: 'STRING_VALUE', /* required */
  DataSetId: 'STRING_VALUE', /* required */
  GrantPermissions: [
    {
      Actions: [ /* required */
        'STRING_VALUE',
        /* more items */
      ],
      Principal: 'STRING_VALUE' /* required */
    },
    /* more items */
  ],
  RevokePermissions: [
    {
      Actions: [ /* required */
        'STRING_VALUE',
        /* more items */
      ],
      Principal: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
quicksight.updateDataSetPermissions(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • AwsAccountId — (String)

      The AWS Account ID.

    • DataSetId — (String)

      The ID for the dataset you want to create. This is unique per region per AWS account.

    • GrantPermissions — (Array<map>)

      The resource permissions that you want to grant to the dataset.

      • Principalrequired — (String)

        The ARN of a QuickSight user or group, or an IAM ARN. If you are using cross-account resource sharing, this is the IAM ARN of an account root. Otherwise, it is the ARN of a QuickSight user or group. .

      • Actionsrequired — (Array<String>)

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

    • RevokePermissions — (Array<map>)

      The resource permissions that you want to revoke from the dataset.

      • Principalrequired — (String)

        The ARN of a QuickSight user or group, or an IAM ARN. If you are using cross-account resource sharing, this is the IAM ARN of an account root. Otherwise, it is the ARN of a QuickSight user or group. .

      • Actionsrequired — (Array<String>)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • DataSetArn — (String)

        The ARN of the dataset.

      • DataSetId — (String)

        The ID for the dataset you want to create. This is unique per region per AWS account.

      • RequestId — (String)

        The AWS request ID for this operation.

      • Status — (Integer)

        The http status of the request.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

updateDataSource(params = {}, callback) ⇒ AWS.Request

Updates a data source.

The permissions resource is arn:aws:quicksight:region:aws-account-id:datasource/data-source-id

CLI syntax:

aws quicksight update-data-source \

--aws-account-id=111122223333 \

--data-source-id=unique-data-source-id \

--name='My Data Source' \

--data-source-parameters='{"PostgreSqlParameters":{"Host":"my-db-host.example.com","Port":1234,"Database":"my-db"}}' \

--credentials='{"CredentialPair":{"Username":"username","Password":"password"}}

Service Reference:

Examples:

Calling the updateDataSource operation

var params = {
  AwsAccountId: 'STRING_VALUE', /* required */
  DataSourceId: 'STRING_VALUE', /* required */
  Name: 'STRING_VALUE', /* required */
  Credentials: {
    CredentialPair: {
      Password: 'STRING_VALUE', /* required */
      Username: 'STRING_VALUE' /* required */
    }
  },
  DataSourceParameters: {
    AmazonElasticsearchParameters: {
      Domain: 'STRING_VALUE' /* required */
    },
    AthenaParameters: {
      WorkGroup: 'STRING_VALUE'
    },
    AuroraParameters: {
      Database: 'STRING_VALUE', /* required */
      Host: 'STRING_VALUE', /* required */
      Port: 'NUMBER_VALUE' /* required */
    },
    AuroraPostgreSqlParameters: {
      Database: 'STRING_VALUE', /* required */
      Host: 'STRING_VALUE', /* required */
      Port: 'NUMBER_VALUE' /* required */
    },
    AwsIotAnalyticsParameters: {
      DataSetName: 'STRING_VALUE' /* required */
    },
    JiraParameters: {
      SiteBaseUrl: 'STRING_VALUE' /* required */
    },
    MariaDbParameters: {
      Database: 'STRING_VALUE', /* required */
      Host: 'STRING_VALUE', /* required */
      Port: 'NUMBER_VALUE' /* required */
    },
    MySqlParameters: {
      Database: 'STRING_VALUE', /* required */
      Host: 'STRING_VALUE', /* required */
      Port: 'NUMBER_VALUE' /* required */
    },
    PostgreSqlParameters: {
      Database: 'STRING_VALUE', /* required */
      Host: 'STRING_VALUE', /* required */
      Port: 'NUMBER_VALUE' /* required */
    },
    PrestoParameters: {
      Catalog: 'STRING_VALUE', /* required */
      Host: 'STRING_VALUE', /* required */
      Port: 'NUMBER_VALUE' /* required */
    },
    RdsParameters: {
      Database: 'STRING_VALUE', /* required */
      InstanceId: 'STRING_VALUE' /* required */
    },
    RedshiftParameters: {
      Database: 'STRING_VALUE', /* required */
      ClusterId: 'STRING_VALUE',
      Host: 'STRING_VALUE',
      Port: 'NUMBER_VALUE'
    },
    S3Parameters: {
      ManifestFileLocation: { /* required */
        Bucket: 'STRING_VALUE', /* required */
        Key: 'STRING_VALUE' /* required */
      }
    },
    ServiceNowParameters: {
      SiteBaseUrl: 'STRING_VALUE' /* required */
    },
    SnowflakeParameters: {
      Database: 'STRING_VALUE', /* required */
      Host: 'STRING_VALUE', /* required */
      Warehouse: 'STRING_VALUE' /* required */
    },
    SparkParameters: {
      Host: 'STRING_VALUE', /* required */
      Port: 'NUMBER_VALUE' /* required */
    },
    SqlServerParameters: {
      Database: 'STRING_VALUE', /* required */
      Host: 'STRING_VALUE', /* required */
      Port: 'NUMBER_VALUE' /* required */
    },
    TeradataParameters: {
      Database: 'STRING_VALUE', /* required */
      Host: 'STRING_VALUE', /* required */
      Port: 'NUMBER_VALUE' /* required */
    },
    TwitterParameters: {
      MaxRows: 'NUMBER_VALUE', /* required */
      Query: 'STRING_VALUE' /* required */
    }
  },
  SslProperties: {
    DisableSsl: true || false
  },
  VpcConnectionProperties: {
    VpcConnectionArn: 'STRING_VALUE' /* required */
  }
};
quicksight.updateDataSource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • AwsAccountId — (String)

      The AWS account ID.

    • DataSourceId — (String)

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

    • Name — (String)

      A display name for the data source.

    • DataSourceParameters — (map)

      The parameters QuickSight uses to connect to your underlying source.

      • AmazonElasticsearchParameters — (map)

        Amazon Elasticsearch parameters.

        • Domainrequired — (String)

          The Amazon Elasticsearch domain.

      • AthenaParameters — (map)

        Athena parameters.

        • WorkGroup — (String)

          The workgroup that Athena uses.

      • AuroraParameters — (map)

        Aurora MySQL parameters.

        • Hostrequired — (String)

          Host.

        • Portrequired — (Integer)

          Port.

        • Databaserequired — (String)

          Database.

      • AuroraPostgreSqlParameters — (map)

        Aurora PostgreSQL parameters.

        • Hostrequired — (String)

          Host.

        • Portrequired — (Integer)

          Port.

        • Databaserequired — (String)

          Database.

      • AwsIotAnalyticsParameters — (map)

        AWS IoT Analytics parameters.

        • DataSetNamerequired — (String)

          Dataset name.

      • JiraParameters — (map)

        Jira parameters.

        • SiteBaseUrlrequired — (String)

          The base URL of the Jira site.

      • MariaDbParameters — (map)

        MariaDB parameters.

        • Hostrequired — (String)

          Host.

        • Portrequired — (Integer)

          Port.

        • Databaserequired — (String)

          Database.

      • MySqlParameters — (map)

        MySQL parameters.

        • Hostrequired — (String)

          Host.

        • Portrequired — (Integer)

          Port.

        • Databaserequired — (String)

          Database.

      • PostgreSqlParameters — (map)

        PostgreSQL parameters.

        • Hostrequired — (String)

          Host.

        • Portrequired — (Integer)

          Port.

        • Databaserequired — (String)

          Database.

      • PrestoParameters — (map)

        Presto parameters.

        • Hostrequired — (String)

          Host.

        • Portrequired — (Integer)

          Port.

        • Catalogrequired — (String)

          Catalog.

      • RdsParameters — (map)

        RDS parameters.

        • InstanceIdrequired — (String)

          Instance ID.

        • Databaserequired — (String)

          Database.

      • RedshiftParameters — (map)

        Redshift parameters.

        • Host — (String)

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

        • Port — (Integer)

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

        • Databaserequired — (String)

          Database.

        • ClusterId — (String)

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

      • S3Parameters — (map)

        S3 parameters.

        • ManifestFileLocationrequired — (map)

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

          • Bucketrequired — (String)

            Amazon S3 bucket.

          • Keyrequired — (String)

            Amazon S3 key that identifies an object.

      • ServiceNowParameters — (map)

        ServiceNow parameters.

        • SiteBaseUrlrequired — (String)

          URL of the base site.

      • SnowflakeParameters — (map)

        Snowflake parameters.

        • Hostrequired — (String)

          Host.

        • Databaserequired — (String)

          Database.

        • Warehouserequired — (String)

          Warehouse.

      • SparkParameters — (map)

        Spark parameters.

        • Hostrequired — (String)

          Host.

        • Portrequired — (Integer)

          Port.

      • SqlServerParameters — (map)

        SQL Server parameters.

        • Hostrequired — (String)

          Host.

        • Portrequired — (Integer)

          Port.

        • Databaserequired — (String)

          Database.

      • TeradataParameters — (map)

        Teradata parameters.

        • Hostrequired — (String)

          Host.

        • Portrequired — (Integer)

          Port.

        • Databaserequired — (String)

          Database.

      • TwitterParameters — (map)

        Twitter parameters.

        • Queryrequired — (String)

          Twitter query string.

        • MaxRowsrequired — (Integer)

          Maximum number of rows to query Twitter.

    • Credentials — (map)

      The credentials QuickSight uses to connect to your underlying source. Currently only username/password based credentials are supported.

      • CredentialPair — (map)

        Credential pair.

        • Usernamerequired — (String)

          Username.

        • Passwordrequired — (String)

          Password.

    • VpcConnectionProperties — (map)

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

      • VpcConnectionArnrequired — (String)

        VPC connection ARN.

    • SslProperties — (map)

      SSL properties that apply when QuickSight connects to your underlying source.

      • DisableSsl — (Boolean)

        A boolean flag to control whether SSL should be disabled.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Arn — (String)

        The ARN of the data source.

      • DataSourceId — (String)

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

      • UpdateStatus — (String)

        The update status of the data source's last update.

        Possible values include:
        • "CREATION_IN_PROGRESS"
        • "CREATION_SUCCESSFUL"
        • "CREATION_FAILED"
        • "UPDATE_IN_PROGRESS"
        • "UPDATE_SUCCESSFUL"
        • "UPDATE_FAILED"
      • RequestId — (String)

        The AWS request ID for this operation.

      • Status — (Integer)

        The http status of the request.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

updateDataSourcePermissions(params = {}, callback) ⇒ AWS.Request

Updates the permissions to a data source.

The permissions resource is arn:aws:quicksight:region:aws-account-id:datasource/data-source-id

CLI syntax:

aws quicksight update-data-source-permissions \

--aws-account-id=111122223333 \

--data-source-id=unique-data-source-id \

--name='My Data Source' \

--grant-permissions='[{"Principal":"arn:aws:quicksight:us-east-1:111122223333:user/default/user1","Actions":["quicksight:DescribeDataSource","quicksight:DescribeDataSourcePermissions","quicksight:PassDataSource"]}]' \

--revoke-permissions='[{"Principal":"arn:aws:quicksight:us-east-1:111122223333:user/default/user2","Actions":["quicksight:UpdateDataSource","quicksight:DeleteDataSource","quicksight:UpdateDataSourcePermissions"]}]'

Service Reference:

Examples:

Calling the updateDataSourcePermissions operation

var params = {
  AwsAccountId: 'STRING_VALUE', /* required */
  DataSourceId: 'STRING_VALUE', /* required */
  GrantPermissions: [
    {
      Actions: [ /* required */
        'STRING_VALUE',
        /* more items */
      ],
      Principal: 'STRING_VALUE' /* required */
    },
    /* more items */
  ],
  RevokePermissions: [
    {
      Actions: [ /* required */
        'STRING_VALUE',
        /* more items */
      ],
      Principal: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
quicksight.updateDataSourcePermissions(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • AwsAccountId — (String)

      The AWS account ID.

    • DataSourceId — (String)

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

    • GrantPermissions — (Array<map>)

      A list of resource permissions that you want to grant on the data source.

      • Principalrequired — (String)

        The ARN of a QuickSight user or group, or an IAM ARN. If you are using cross-account resource sharing, this is the IAM ARN of an account root. Otherwise, it is the ARN of a QuickSight user or group. .

      • Actionsrequired — (Array<String>)

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

    • RevokePermissions — (Array<map>)

      A list of resource permissions that you want to revoke on the data source.

      • Principalrequired — (String)

        The ARN of a QuickSight user or group, or an IAM ARN. If you are using cross-account resource sharing, this is the IAM ARN of an account root. Otherwise, it is the ARN of a QuickSight user or group. .

      • Actionsrequired — (Array<String>)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • DataSourceArn — (String)

        The ARN of the data source.

      • DataSourceId — (String)

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

      • RequestId — (String)

        The AWS request ID for this operation.

      • Status — (Integer)

        The http status of the request.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

updateGroup(params = {}, callback) ⇒ AWS.Request

Changes a group description.

The permissions resource is arn:aws:quicksight:us-east-1:<aws-account-id>:group/default/<group-name> .

The response is a group object.

CLI Sample:

aws quicksight update-group --aws-account-id=111122223333 --namespace=default --group-name=Sales --description="Sales BI Dashboards"

Service Reference:

Examples:

Calling the updateGroup operation

var params = {
  AwsAccountId: 'STRING_VALUE', /* required */
  GroupName: 'STRING_VALUE', /* required */
  Namespace: 'STRING_VALUE', /* required */
  Description: 'STRING_VALUE'
};
quicksight.updateGroup(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • GroupName — (String)

      The name of the group that you want to update.

    • Description — (String)

      The description for the group that you want to update.

    • AwsAccountId — (String)

      The ID for the AWS account that the group is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.

    • Namespace — (String)

      The namespace. Currently, you should set this to default.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Group — (map)

        The name of the group.

        • Arn — (String)

          The Amazon Resource name (ARN) for the group.

        • GroupName — (String)

          The name of the group.

        • Description — (String)

          The group description.

        • PrincipalId — (String)

          The principal ID of the group.

      • RequestId — (String)

        The AWS request ID for this operation.

      • Status — (Integer)

        The http status of the request.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

updateIAMPolicyAssignment(params = {}, callback) ⇒ AWS.Request

Updates an existing assignment. This operation updates only the optional parameter or parameters that are specified in the request.

CLI syntax:

aws quicksight update-iam-policy-assignment --aws-account-id=111122223333 --assignment-name=FullAccessAssignment --assignment-status=DRAFT --policy-arns=arn:aws:iam::aws:policy/AdministratorAccess --identities="user=user-1,user-2,group=admin" --namespace=default --region=us-east-1

Service Reference:

Examples:

Calling the updateIAMPolicyAssignment operation

var params = {
  AssignmentName: 'STRING_VALUE', /* required */
  AwsAccountId: 'STRING_VALUE', /* required */
  Namespace: 'STRING_VALUE', /* required */
  AssignmentStatus: ENABLED | DRAFT | DISABLED,
  Identities: {
    '<String>': [
      'STRING_VALUE',
      /* more items */
    ],
    /* '<String>': ... */
  },
  PolicyArn: 'STRING_VALUE'
};
quicksight.updateIAMPolicyAssignment(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • AwsAccountId — (String)

      The AWS account ID that contains the IAM policy assignment.

    • AssignmentName — (String)

      The name of the assignment. It must be unique within an AWS account.

    • Namespace — (String)

      The namespace of the assignment.

    • AssignmentStatus — (String)

      The status of an assignment:

      • ENABLED - Anything specified in this assignment is used while creating the data source.

      • DISABLED - This assignment isn't used while creating the data source.

      • DRAFT - Assignment is an unfinished draft and isn't used while creating the data source.

      Possible values include:
      • "ENABLED"
      • "DRAFT"
      • "DISABLED"
    • PolicyArn — (String)

      An IAM policy ARN that will be applied to specified QuickSight users and groups in this assignment.

    • Identities — (map<Array<String>>)

      QuickSight users and/or groups that you want to assign to the specified IAM policy.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • AssignmentName — (String)

        The name of the assignment.

      • AssignmentId — (String)

        The ID of the assignment.

      • PolicyArn — (String)

        The IAM policy ARN assigned to the QuickSight users and groups specified in this request.

      • Identities — (map<Array<String>>)

        QuickSight users and/or groups that are assigned to this IAM policy.

      • AssignmentStatus — (String)

        The status of the assignment:

        • ENABLED - Anything specified in this assignment is used while creating the data source.

        • DISABLED - This assignment isn't used while creating the data source.

        • DRAFT - Assignment is an unfinished draft and isn't used while creating the data source.

        Possible values include:
        • "ENABLED"
        • "DRAFT"
        • "DISABLED"
      • RequestId — (String)

        The AWS request ID for this operation.

      • Status — (Integer)

        The http status of the request.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

updateTemplate(params = {}, callback) ⇒ AWS.Request

Updates a template from an existing QuickSight analysis.

CLI syntax:

aws quicksight update-template --aws-account-id 111122223333 --template-id reports_test_template --data-set-references DataSetPlaceholder=reports,DataSetArn=arn:aws:quicksight:us-west-2:111122223333:dataset/c684a204-d134-4c53-a63c-451f72c60c28 DataSetPlaceholder=Elblogs,DataSetArn=arn:aws:quicksight:us-west-2:111122223333:dataset/15840b7d-b542-4491-937b-602416b367b3 —source-entity SourceAnalysis=’{Arn=arn:aws:quicksight:us-west-2:111122223333:analysis/c5731fe9-4708-4598-8f6d-cf2a70875b6d}

You can also pass in a json file: aws quicksight update-template —cli-input-json file://create-template.json

Service Reference:

Examples:

Calling the updateTemplate operation

var params = {
  AwsAccountId: 'STRING_VALUE', /* required */
  SourceEntity: { /* required */
    SourceAnalysis: {
      Arn: 'STRING_VALUE', /* required */
      DataSetReferences: [ /* required */
        {
          DataSetArn: 'STRING_VALUE', /* required */
          DataSetPlaceholder: 'STRING_VALUE' /* required */
        },
        /* more items */
      ]
    },
    SourceTemplate: {
      Arn: 'STRING_VALUE' /* required */
    }
  },
  TemplateId: 'STRING_VALUE', /* required */
  Name: 'STRING_VALUE',
  VersionDescription: 'STRING_VALUE'
};
quicksight.updateTemplate(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • AwsAccountId — (String)

      AWS account ID that contains the template you are updating.

    • TemplateId — (String)

      The ID for the template.

    • SourceEntity — (map)

      The source QuickSight entity from which this template is being created. Templates can be currently created from an Analysis or another template.

      • SourceAnalysis — (map)

        The source analysis, if it is based on an analysis.

        • Arnrequired — (String)

          The Amazon Resource name (ARN) of the resource.

        • DataSetReferencesrequired — (Array<map>)

          A structure containing information about the dataset references used as placeholders in the template.

          • DataSetPlaceholderrequired — (String)

            Dataset placeholder.

          • DataSetArnrequired — (String)

            Dataset ARN.

      • SourceTemplate — (map)

        The source template, if it is based on an template.

        • Arnrequired — (String)

          The Amazon Resource name (ARN) of the resource.

    • VersionDescription — (String)

      A description of the current template version being created. This API created the first version of the template. Every time UpdateTemplate is called a new version is created. Each version of the template maintains a description of the version in the VersionDescription field.

    • Name — (String)

      The name for the template.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • TemplateId — (String)

        The ID for the template.

      • Arn — (String)

        The Amazon Resource Name (ARN) for the template.

      • VersionArn — (String)

        The Amazon Resource Name (ARN) for the template, including the version information of the first version.

      • CreationStatus — (String)

        The creation status of the template.

        Possible values include:
        • "CREATION_IN_PROGRESS"
        • "CREATION_SUCCESSFUL"
        • "CREATION_FAILED"
        • "UPDATE_IN_PROGRESS"
        • "UPDATE_SUCCESSFUL"
        • "UPDATE_FAILED"
      • Status — (Integer)

        The http status of the request.

      • RequestId — (String)

        The AWS request ID for this operation.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

updateTemplateAlias(params = {}, callback) ⇒ AWS.Request

Updates the template alias of a template.

CLI syntax:

aws quicksight update-template-alias --aws-account-id 111122223333 --template-id 'reports_test_template' --alias-name STAGING —template-version-number 2

Service Reference:

Examples:

Calling the updateTemplateAlias operation

var params = {
  AliasName: 'STRING_VALUE', /* required */
  AwsAccountId: 'STRING_VALUE', /* required */
  TemplateId: 'STRING_VALUE', /* required */
  TemplateVersionNumber: 'NUMBER_VALUE' /* required */
};
quicksight.updateTemplateAlias(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • AwsAccountId — (String)

      AWS account ID that contains the template aliases you are updating.

    • TemplateId — (String)

      The ID for the template.

    • AliasName — (String)

      The alias name.

    • TemplateVersionNumber — (Integer)

      The version number of the template.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • TemplateAlias — (map)

        The template alias.

        • AliasName — (String)

          The display name of the template alias.

        • Arn — (String)

          The ARN of the template alias.

        • TemplateVersionNumber — (Integer)

          The version number of the template alias.

      • Status — (Integer)

        The http status of the request.

      • RequestId — (String)

        The AWS request ID for this operation.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

updateTemplatePermissions(params = {}, callback) ⇒ AWS.Request

Updates the permissions on a template.

CLI syntax:

  • aws quicksight describe-template-permissions —aws-account-id 111122223333 —template-id reports_test_template

  • aws quicksight update-template-permissions —cli-input-json file://update-permission.json

  • The structure of update-permissions.json to add permissions:

    { "AwsAccountId": "111122223333",

    "DashboardId": "reports_test_template",

    "GrantPermissions": [

    { "Principal": "arn:aws:quicksight:us-east-1:196359894473:user/default/user3",

    "Actions": [

    "quicksight:DescribeTemplate",

    "quicksight:ListTemplateVersions"

    ] } ] }

    The structure of update-permissions.json to add permissions:

    { "AwsAccountId": "111122223333",

    "DashboardId": "reports_test_template",

    "RevokePermissions": [

    { "Principal": "arn:aws:quicksight:us-east-1:196359894473:user/default/user3",

    "Actions": [

    "quicksight:DescribeTemplate",

    "quicksight:ListTemplateVersions"

    ] } ] }

    To obtain the principal name of a QuickSight group or user, use user describe-group or describe-user. For example:

    aws quicksight describe-user

    --aws-account-id 111122223333

    --namespace default

    --user-name user2

    --region us-east-1

    {

    "User": {

    "Arn": "arn:aws:quicksight:us-east-1:111122223333:user/default/user2",

    "Active": true,

    "Email": "user2@example.com",

    "Role": "ADMIN",

    "UserName": "user2",

    "PrincipalId": "federated/iam/abcd2abcdabcdeabc5ab5"

    },

    "RequestId": "8f74bb31-6291-448a-a71c-a765a44bae31",

    "Status": 200

    }

Service Reference:

Examples:

Calling the updateTemplatePermissions operation

var params = {
  AwsAccountId: 'STRING_VALUE', /* required */
  TemplateId: 'STRING_VALUE', /* required */
  GrantPermissions: [
    {
      Actions: [ /* required */
        'STRING_VALUE',
        /* more items */
      ],
      Principal: 'STRING_VALUE' /* required */
    },
    /* more items */
  ],
  RevokePermissions: [
    {
      Actions: [ /* required */
        'STRING_VALUE',
        /* more items */
      ],
      Principal: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
quicksight.updateTemplatePermissions(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • AwsAccountId — (String)

      AWS account ID that contains the template.

    • TemplateId — (String)

      The ID for the template.

    • GrantPermissions — (Array<map>)

      A list of resource permissions to be granted on the template. The following example shows the shorthand syntax:

      Shorthand Syntax: Principal=string,Actions=string,string ...

      • Principalrequired — (String)

        The ARN of a QuickSight user or group, or an IAM ARN. If you are using cross-account resource sharing, this is the IAM ARN of an account root. Otherwise, it is the ARN of a QuickSight user or group. .

      • Actionsrequired — (Array<String>)

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

    • RevokePermissions — (Array<map>)

      A list of resource permissions to be revoked from the template. Shorthand syntax: Shorthand Syntax: Principal=string,Actions=string,string ...

      • Principalrequired — (String)

        The ARN of a QuickSight user or group, or an IAM ARN. If you are using cross-account resource sharing, this is the IAM ARN of an account root. Otherwise, it is the ARN of a QuickSight user or group. .

      • Actionsrequired — (Array<String>)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • TemplateId — (String)

        The ID for the template.

      • TemplateArn — (String)

        The ARN of the template.

      • Permissions — (Array<map>)

        A list of resource permissions to be set on the template.

        • Principalrequired — (String)

          The ARN of a QuickSight user or group, or an IAM ARN. If you are using cross-account resource sharing, this is the IAM ARN of an account root. Otherwise, it is the ARN of a QuickSight user or group. .

        • Actionsrequired — (Array<String>)

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

      • RequestId — (String)

        The AWS request ID for this operation.

      • Status — (Integer)

        The http status of the request.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

updateUser(params = {}, callback) ⇒ AWS.Request

Updates an Amazon QuickSight user.

The response is a user object that contains the user's Amazon QuickSight user name, email address, active or inactive status in Amazon QuickSight, Amazon QuickSight role, and Amazon Resource Name (ARN).

CLI Sample:

aws quicksight update-user --user-name=Pat --role=ADMIN --email=new_address@example.com --aws-account-id=111122223333 --namespace=default --region=us-east-1

Service Reference:

Examples:

Calling the updateUser operation

var params = {
  AwsAccountId: 'STRING_VALUE', /* required */
  Email: 'STRING_VALUE', /* required */
  Namespace: 'STRING_VALUE', /* required */
  Role: ADMIN | AUTHOR | READER | RESTRICTED_AUTHOR | RESTRICTED_READER, /* required */
  UserName: 'STRING_VALUE' /* required */
};
quicksight.updateUser(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • UserName — (String)

      The Amazon QuickSight user name that you want to update.

    • AwsAccountId — (String)

      The ID for the AWS account that the user is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.

    • Namespace — (String)

      The namespace. Currently, you should set this to default.

    • Email — (String)

      The email address of the user that you want to update.

    • Role — (String)

      The Amazon QuickSight role of the user. The user role can be one of the following:

      • READER: A user who has read-only access to dashboards.

      • AUTHOR: A user who can create data sources, datasets, analyses, and dashboards.

      • ADMIN: A user who is an author, who can also manage Amazon QuickSight settings.

      Possible values include:
      • "ADMIN"
      • "AUTHOR"
      • "READER"
      • "RESTRICTED_AUTHOR"
      • "RESTRICTED_READER"

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • User — (map)

        The Amazon QuickSight user.

        • Arn — (String)

          The Amazon Resource name (ARN) for the user.

        • UserName — (String)

          The user's user name.

        • Email — (String)

          The user's email address.

        • Role — (String)

          The Amazon QuickSight role for the user. The user role can be one of the following:.

          • READER: A user who has read-only access to dashboards.

          • AUTHOR: A user who can create data sources, datasets, analyses, and dashboards.

          • ADMIN: A user who is an author, who can also manage Amazon QuickSight settings.

          • RESTRICTED_READER: This role isn't currently available for use.

          • RESTRICTED_AUTHOR: This role isn't currently available for use.

          Possible values include:
          • "ADMIN"
          • "AUTHOR"
          • "READER"
          • "RESTRICTED_AUTHOR"
          • "RESTRICTED_READER"
        • IdentityType — (String)

          The type of identity authentication used by the user.

          Possible values include:
          • "IAM"
          • "QUICKSIGHT"
        • Active — (Boolean)

          Active status of user. When you create an Amazon QuickSight user that’s not an IAM user or an AD user, that user is inactive until they sign in and provide a password.

        • PrincipalId — (String)

          The principal ID of the user.

      • RequestId — (String)

        The AWS request ID for this operation.

      • Status — (Integer)

        The http status of the request.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.