You are viewing the documentation for an older major version of the AWS SDK for JavaScript.
The modular AWS SDK for JavaScript (v3), the latest major version of AWS SDK for JavaScript, is now stable and recommended for general use. For more information, see the Migration Guide and API Reference.

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 business intelligence service for the Amazon Web Services Cloud that makes it easy to extend data and insights to every user in your organization. This API 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|AWS.Endpoint) —

    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' or an Endpoint object.

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

  • s3UsEast1RegionalEndpoint ('legacy'|'regional') —

    when region is set to 'us-east-1', whether to send s3 request to global endpoints or 'us-east-1' regional endpoints. This config is only applicable to S3 client. Defaults to legacy

  • s3UseArnRegion (Boolean) —

    whether to override the request region with the region inferred from requested resource's ARN. Only available for S3 buckets 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. The function is only called for retryable errors.
  • 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|undefined) —

    whether to call operations with endpoints given by service dynamically. Setting this

  • 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

endpoint ⇒ AWS.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 ongoing 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 Amazon Web Services 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 Amazon Web Services 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.

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

Creates Amazon QuickSight customizations the current Amazon Web Services Region. Currently, you can add a custom default theme by using the CreateAccountCustomization or UpdateAccountCustomization API operation. To further customize Amazon QuickSight by removing Amazon QuickSight sample assets and videos for all new users, see Customizing Amazon QuickSight in the Amazon QuickSight User Guide.

You can create customizations for your Amazon Web Services account or, if you specify a namespace, for a Amazon QuickSight namespace instead. Customizations that apply to a namespace always override customizations that apply to an Amazon Web Services account. To find out which customizations apply, use the DescribeAccountCustomization API operation.

Before you use the CreateAccountCustomization API operation to add a theme as the namespace default, make sure that you first share the theme with the namespace. If you don't share it with the namespace, the theme isn't visible to your users even if you make it the default theme. To check if the theme is shared, view the current permissions by using the DescribeThemePermissions API operation. To share the theme, grant permissions by using the UpdateThemePermissions API operation.

Service Reference:

Examples:

Calling the createAccountCustomization operation

var params = {
  AccountCustomization: { /* required */
    DefaultTheme: 'STRING_VALUE'
  },
  AwsAccountId: 'STRING_VALUE', /* required */
  Namespace: 'STRING_VALUE',
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
quicksight.createAccountCustomization(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 Amazon Web Services account that you want to customize Amazon QuickSight for.

    • Namespace — (String)

      The Amazon QuickSight namespace that you want to add customizations to.

    • AccountCustomization — (map)

      The Amazon QuickSight customizations you're adding in the current Amazon Web Services Region. You can add these to an Amazon Web Services account and a Amazon QuickSight namespace.

      For example, you can add a default theme by setting AccountCustomization to the midnight theme: "AccountCustomization": { "DefaultTheme": "arn:aws:quicksight::aws:theme/MIDNIGHT" }. Or, you can add a custom theme by specifying "AccountCustomization": { "DefaultTheme": "arn:aws:quicksight:us-west-2:111122223333:theme/bdb844d0-0fe9-4d9d-b520-0fe602d93639" }.

      • DefaultTheme — (String)

        The default theme for this Amazon QuickSight subscription.

    • Tags — (Array<map>)

      A list of the tags that you want to attach to this resource.

      • Key — required — (String)

        Tag key.

      • Value — required — (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 Amazon Resource Name (ARN) for the customization that you created for this Amazon Web Services account.

      • AwsAccountId — (String)

        The ID for the Amazon Web Services account that you want to customize Amazon QuickSight for.

      • Namespace — (String)

        The namespace associated with the customization you're creating.

      • AccountCustomization — (map)

        The Amazon QuickSight customizations you're adding in the current Amazon Web Services Region.

        • DefaultTheme — (String)

          The default theme for this Amazon QuickSight subscription.

      • RequestId — (String)

        The Amazon Web Services 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.

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

Creates an analysis in Amazon QuickSight.

Service Reference:

Examples:

Calling the createAnalysis operation

var params = {
  AnalysisId: 'STRING_VALUE', /* required */
  AwsAccountId: '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 */
      ]
    }
  },
  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 */
  ],
  ThemeArn: 'STRING_VALUE'
};
quicksight.createAnalysis(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 of the Amazon Web Services account where you are creating an analysis.

    • AnalysisId — (String)

      The ID for the analysis that you're creating. This ID displays in the URL of the analysis.

    • Name — (String)

      A descriptive name for the analysis that you're creating. This name displays for the analysis in the Amazon QuickSight console.

    • Parameters — (map)

      The parameter names and override values that you want to use. An analysis can have any parameter type, and some parameters might accept multiple values.

      • StringParameters — (Array<map>)

        The parameters that have a data type of string.

        • Name — required — (String)

          A display name for a string parameter.

        • Values — required — (Array<String>)

          The values of a string parameter.

      • IntegerParameters — (Array<map>)

        The parameters that have a data type of integer.

        • Name — required — (String)

          The name of the integer parameter.

        • Values — required — (Array<Integer>)

          The values for the integer parameter.

      • DecimalParameters — (Array<map>)

        The parameters that have a data type of decimal.

        • Name — required — (String)

          A display name for the decimal parameter.

        • Values — required — (Array<Float>)

          The values for the decimal parameter.

      • DateTimeParameters — (Array<map>)

        The parameters that have a data type of date-time.

        • Name — required — (String)

          A display name for the date-time parameter.

        • Values — required — (Array<Date>)

          The values for the date-time parameter.

    • Permissions — (Array<map>)

      A structure that describes the principals and the resource-level permissions on an analysis. You can use the Permissions structure to grant permissions by providing a list of Identity and Access Management (IAM) action information for each principal listed by Amazon Resource Name (ARN).

      To specify no permissions, omit Permissions.

      • Principal — required — (String)

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

        • The ARN of an Amazon QuickSight user or group associated with a data source or dataset. (This is common.)

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

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

      • Actions — required — (Array<String>)

        The IAMaction to grant or revoke permissions on.

    • SourceEntity — (map)

      A source entity to use for the analysis that you're creating. This metadata structure contains details that describe a source template and one or more datasets.

      • SourceTemplate — (map)

        The source template for the source entity of the analysis.

        • DataSetReferences — required — (Array<map>)

          The dataset references of the source template of an analysis.

          • DataSetPlaceholder — required — (String)

            Dataset placeholder.

          • DataSetArn — required — (String)

            Dataset Amazon Resource Name (ARN).

        • Arn — required — (String)

          The Amazon Resource Name (ARN) of the source template of an analysis.

    • ThemeArn — (String)

      The ARN for the theme to apply to the analysis that you're creating. To see the theme in the Amazon QuickSight console, make sure that you have access to it.

    • Tags — (Array<map>)

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

      • Key — required — (String)

        Tag key.

      • Value — required — (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 for the analysis.

      • AnalysisId — (String)

        The ID of the analysis.

      • CreationStatus — (String)

        The status of the creation of the analysis.

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

        The HTTP status of the request.

      • RequestId — (String)

        The Amazon Web Services request ID for this operation.

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

A dashboard is an entity in Amazon QuickSight that identifies Amazon QuickSight reports, created from analyses. You can share Amazon QuickSight dashboards. With the right permissions, you can create scheduled email reports from them. If you have the correct permissions, you can create a dashboard from a template that exists in a different Amazon Web Services account.

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 */
  ],
  ThemeArn: 'STRING_VALUE',
  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)

      The ID of the Amazon Web Services account where you want to create the dashboard.

    • DashboardId — (String)

      The ID for the dashboard, also added to the IAMpolicy.

    • Name — (String)

      The display name of the dashboard.

    • Parameters — (map)

      The parameters for the creation of the dashboard, which you want to use to override the default settings. A dashboard can have any type of parameters, and some parameters might accept multiple values.

      • StringParameters — (Array<map>)

        The parameters that have a data type of string.

        • Name — required — (String)

          A display name for a string parameter.

        • Values — required — (Array<String>)

          The values of a string parameter.

      • IntegerParameters — (Array<map>)

        The parameters that have a data type of integer.

        • Name — required — (String)

          The name of the integer parameter.

        • Values — required — (Array<Integer>)

          The values for the integer parameter.

      • DecimalParameters — (Array<map>)

        The parameters that have a data type of decimal.

        • Name — required — (String)

          A display name for the decimal parameter.

        • Values — required — (Array<Float>)

          The values for the decimal parameter.

      • DateTimeParameters — (Array<map>)

        The parameters that have a data type of date-time.

        • Name — required — (String)

          A display name for the date-time parameter.

        • Values — required — (Array<Date>)

          The values for the date-time parameter.

    • Permissions — (Array<map>)

      A structure that contains the permissions of the dashboard. You can use this structure for granting permissions by providing a list of IAMaction information for each principal ARN.

      To specify no permissions, omit the permissions list.

      • Principal — required — (String)

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

        • The ARN of an Amazon QuickSight user or group associated with a data source or dataset. (This is common.)

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

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

      • Actions — required — (Array<String>)

        The IAMaction to grant or revoke permissions on.

    • SourceEntity — (map)

      The entity that you are using as a source when you create the dashboard. In SourceEntity, you specify the type of object you're using as source. You can only create a dashboard from a template, so you use a SourceTemplate entity. If you need to create a dashboard from an analysis, first convert the analysis to a template by using the CreateTemplate API operation. For SourceTemplate, specify the Amazon Resource Name (ARN) of the source template. The SourceTemplateARN can contain any Amazon Web Services account and any Amazon QuickSight-supported Amazon Web Services Region.

      Use the DataSetReferences entity within SourceTemplate to list the replacement datasets for the placeholders listed in the original. The schema in each dataset must match its placeholder.

      • SourceTemplate — (map)

        Source template.

        • DataSetReferences — required — (Array<map>)

          Dataset references.

          • DataSetPlaceholder — required — (String)

            Dataset placeholder.

          • DataSetArn — required — (String)

            Dataset Amazon Resource Name (ARN).

        • Arn — required — (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.

      • Key — required — (String)

        Tag key.

      • Value — required — (String)

        Tag value.

    • VersionDescription — (String)

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

    • DashboardPublishOptions — (map)

      Options for publishing the dashboard when you create it:

      • AvailabilityStatus for AdHocFilteringOption - This status can be either ENABLED or DISABLED. When this is set to DISABLED, Amazon QuickSight disables the left filter pane on the published dashboard, which can be used for ad hoc (one-time) filtering. This option is ENABLED by default.

      • AvailabilityStatus for ExportToCSVOption - This status can be either ENABLED or DISABLED. The visual option to export data to .CSV format isn't enabled when this is set to DISABLED. This option is ENABLED by default.

      • VisibilityState for SheetControlsOption - This visibility state can be either COLLAPSED or EXPANDED. This option is COLLAPSED by default.

      • AdHocFilteringOption — (map)

        Ad hoc (one-time) 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"
    • ThemeArn — (String)

      The Amazon Resource Name (ARN) of the theme that is being used for this dashboard. If you add a value for this field, it overrides the value that is used in the source entity. The theme ARN must exist in the same Amazon Web Services account where you create 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:

      • 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 status of the dashboard creation request.

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

        The HTTP status of the request.

      • RequestId — (String)

        The Amazon Web Services 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.

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 */
        Catalog: 'STRING_VALUE',
        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 */
  ],
  ColumnLevelPermissionRules: [
    {
      ColumnNames: [
        'STRING_VALUE',
        /* more items */
      ],
      Principals: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  DataSetUsageConfiguration: {
    DisableUseAsDirectQuerySource: true || false,
    DisableUseAsImportedSource: true || false
  },
  FieldFolders: {
    '<FieldFolderPath>': {
      columns: [
        'STRING_VALUE',
        /* more items */
      ],
      description: 'STRING_VALUE'
    },
    /* '<FieldFolderPath>': ... */
  },
  LogicalTableMap: {
    '<LogicalTableId>': {
      Alias: 'STRING_VALUE', /* required */
      Source: { /* required */
        DataSetArn: 'STRING_VALUE',
        JoinInstruction: {
          LeftOperand: 'STRING_VALUE', /* required */
          OnClause: 'STRING_VALUE', /* required */
          RightOperand: 'STRING_VALUE', /* required */
          Type: INNER | OUTER | LEFT | RIGHT, /* required */
          LeftJoinKeyProperties: {
            UniqueKey: true || false
          },
          RightJoinKeyProperties: {
            UniqueKey: true || false
          }
        },
        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 */
              {
                ColumnDescription: {
                  Text: 'STRING_VALUE'
                },
                ColumnGeographicRole: COUNTRY | STATE | COUNTY | CITY | POSTCODE | LONGITUDE | LATITUDE
              },
              /* more items */
            ]
          },
          UntagColumnOperation: {
            ColumnName: 'STRING_VALUE', /* required */
            TagNames: [ /* required */
              COLUMN_GEOGRAPHIC_ROLE | COLUMN_DESCRIPTION,
              /* 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 */
    FormatVersion: VERSION_1 | VERSION_2,
    Namespace: 'STRING_VALUE',
    Status: ENABLED | DISABLED
  },
  RowLevelPermissionTagConfiguration: {
    TagRules: [ /* required */
      {
        ColumnName: 'STRING_VALUE', /* required */
        TagKey: 'STRING_VALUE', /* required */
        MatchAllValue: 'STRING_VALUE',
        TagMultiValueDelimiter: 'STRING_VALUE'
      },
      /* more items */
    ],
    Status: ENABLED | DISABLED
  },
  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 Amazon Web Services account ID.

    • DataSetId — (String)

      An ID for the dataset that you want to create. This ID is unique per Amazon Web Services Region for each Amazon Web Services 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.

        • DataSourceArn — required — (String)

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

        • Catalog — (String)

          The catalog associated with a table.

        • Schema — (String)

          The schema name. This name applies to certain relational database engines.

        • Name — required — (String)

          The name of the relational table.

        • InputColumns — required — (Array<map>)

          The column schema of the table.

          • Name — required — (String)

            The name of this column in the underlying data source.

          • Type — required — (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.

        • DataSourceArn — required — (String)

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

        • Name — required — (String)

          A display name for the SQL query result.

        • SqlQuery — required — (String)

          The SQL query.

        • Columns — (Array<map>)

          The column schema from the SQL query result set.

          • Name — required — (String)

            The name of this column in the underlying data source.

          • Type — required — (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.

        • DataSourceArn — required — (String)

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

        • UploadSettings — (map)

          Information about the format for the S3 source file or files.

          • 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 the file has a header row, or the files each have a header row.

          • TextQualifier — (String)

            Text qualifier.

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

            The delimiter between values in the file.

        • InputColumns — required — (Array<map>)

          A physical table type for an S3 data source.

          Note: For files that aren't JSON, only STRING data types are supported in input columns.
          • Name — required — (String)

            The name of this column in the underlying data source.

          • Type — required — (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.

      • Alias — required — (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.

          • ProjectedColumns — required — (Array<String>)

            Projected columns.

        • FilterOperation — (map)

          An operation that filters rows based on some condition.

          • ConditionExpression — required — (String)

            An expression that must evaluate to a Boolean value. Rows for which the expression evaluates 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.

          • Columns — required — (Array<map>)

            Calculated columns to create.

            • ColumnName — required — (String)

              Column name.

            • ColumnId — required — (String)

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

            • Expression — required — (String)

              An expression that defines the calculated column.

        • RenameColumnOperation — (map)

          An operation that renames a column.

          • ColumnName — required — (String)

            The name of the column to be renamed.

          • NewColumnName — required — (String)

            The new name for the column.

        • CastColumnTypeOperation — (map)

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

          • ColumnName — required — (String)

            Column name.

          • NewColumnType — required — (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 string in a format supported by Amazon QuickSight to denote the source data format.

        • TagColumnOperation — (map)

          An operation that tags a column with additional information.

          • ColumnName — required — (String)

            The column that this operation acts on.

          • Tags — required — (Array<map>)

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

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

              A geospatial role for a column.

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

              A description for a column.

              • Text — (String)

                The text of a description for a column.

        • UntagColumnOperation — (map)

          A transform operation that removes tags associated with a column.

          • ColumnName — required — (String)

            The column that this operation acts on.

          • TagNames — required — (Array<String>)

            The column tags to remove from this column.

      • Source — required — (map)

        Source of this logical table.

        • JoinInstruction — (map)

          Specifies the result of a join of two logical tables.

          • LeftOperand — required — (String)

            The operand on the left side of a join.

          • RightOperand — required — (String)

            The operand on the right side of a join.

          • LeftJoinKeyProperties — (map)

            Join key properties of the left operand.

            • UniqueKey — (Boolean)

              A value that indicates that a row in a table is uniquely identified by the columns in a join key. This is used by Amazon QuickSight to optimize query performance.

          • RightJoinKeyProperties — (map)

            Join key properties of the right operand.

            • UniqueKey — (Boolean)

              A value that indicates that a row in a table is uniquely identified by the columns in a join key. This is used by Amazon QuickSight to optimize query performance.

          • Type — required — (String)

            The type of join that it is.

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

            The join instructions provided in the ON clause of a join.

        • PhysicalTableId — (String)

          Physical table ID.

        • DataSetArn — (String)

          The Amazon Resource Number (ARN) of the parent dataset.

    • ImportMode — (String)

      Indicates whether 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 Amazon QuickSight features. Currently, only geospatial hierarchy is supported.

      • GeoSpatialColumnGroup — (map)

        Geospatial column group that denotes a hierarchy.

        • Name — required — (String)

          A display name for the hierarchy.

        • CountryCode — required — (String)

          Country code.

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

          Columns in this hierarchy.

    • FieldFolders — (map<map>)

      The folder that contains fields and nested subfolders for your dataset.

      • description — (String)

        The description for a field folder.

      • columns — (Array<String>)

        A folder has a list of columns. A column can only be in one folder.

    • Permissions — (Array<map>)

      A list of resource permissions on the dataset.

      • Principal — required — (String)

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

        • The ARN of an Amazon QuickSight user or group associated with a data source or dataset. (This is common.)

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

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

      • Actions — required — (Array<String>)

        The IAMaction to grant or revoke permissions on.

    • RowLevelPermissionDataSet — (map)

      The row-level security configuration for the data that you want to create.

      • Namespace — (String)

        The namespace associated with the dataset that contains permissions for RLS.

      • Arn — required — (String)

        The Amazon Resource Name (ARN) of the dataset that contains permissions for RLS.

      • PermissionPolicy — required — (String)

        The type of permissions to use when interpreting the permissions for RLS. DENY_ACCESS is included for backward compatibility only.

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

        The user or group rules associated with the dataset that contains permissions for RLS.

        By default, FormatVersion is VERSION_1. When FormatVersion is VERSION_1, UserName and GroupName are required. When FormatVersion is VERSION_2, UserARN and GroupARN are required, and Namespace must not exist.

        Possible values include:
        • "VERSION_1"
        • "VERSION_2"
      • Status — (String)

        The status of the row-level security permission dataset. If enabled, the status is ENABLED. If disabled, the status is DISABLED.

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

      The configuration of tags on a dataset to set row-level security. Row-level security tags are currently supported for anonymous embedding only.

      • Status — (String)

        The status of row-level security tags. If enabled, the status is ENABLED. If disabled, the status is DISABLED.

        Possible values include:
        • "ENABLED"
        • "DISABLED"
      • TagRules — required — (Array<map>)

        A set of rules associated with row-level security, such as the tag names and columns that they are assigned to.

        • TagKey — required — (String)

          The unique key for a tag.

        • ColumnName — required — (String)

          The column name that a tag key is assigned to.

        • TagMultiValueDelimiter — (String)

          A string that you want to use to delimit the values when you pass the values at run time. For example, you can delimit the values with a comma.

        • MatchAllValue — (String)

          A string that you want to use to filter by all the values in a column in the dataset and don’t want to list the values one by one. For example, you can use an asterisk as your match all value.

    • ColumnLevelPermissionRules — (Array<map>)

      A set of one or more definitions of a ColumnLevelPermissionRule .

      • Principals — (Array<String>)

        An array of Amazon Resource Names (ARNs) for Amazon QuickSight users or groups.

      • ColumnNames — (Array<String>)

        An array of column names.

    • Tags — (Array<map>)

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

      • Key — required — (String)

        Tag key.

      • Value — required — (String)

        Tag value.

    • DataSetUsageConfiguration — (map)

      The usage configuration to apply to child datasets that reference this dataset as a source.

      • DisableUseAsDirectQuerySource — (Boolean)

        An option that controls whether a child dataset of a direct query can use this dataset as a source.

      • DisableUseAsImportedSource — (Boolean)

        An option that controls whether a child dataset that's stored in QuickSight can use this dataset as a source.

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) of the dataset.

      • DataSetId — (String)

        The ID for the dataset that you want to create. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

      • IngestionArn — (String)

        The 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 Amazon Web Services 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.

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 | ORACLE | POSTGRESQL | PRESTO | REDSHIFT | S3 | SALESFORCE | SERVICENOW | SNOWFLAKE | SPARK | SQLSERVER | TERADATA | TWITTER | TIMESTREAM | AMAZON_OPENSEARCH, /* required */
  Credentials: {
    CopySourceArn: 'STRING_VALUE',
    CredentialPair: {
      Password: 'STRING_VALUE', /* required */
      Username: 'STRING_VALUE', /* required */
      AlternateDataSourceParameters: [
        {
          AmazonElasticsearchParameters: {
            Domain: 'STRING_VALUE' /* required */
          },
          AmazonOpenSearchParameters: {
            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 */
          },
          OracleParameters: {
            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 */
          }
        },
        /* more items */
      ]
    }
  },
  DataSourceParameters: {
    AmazonElasticsearchParameters: {
      Domain: 'STRING_VALUE' /* required */
    },
    AmazonOpenSearchParameters: {
      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 */
    },
    OracleParameters: {
      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 Amazon Web Services account ID.

    • DataSourceId — (String)

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

    • Name — (String)

      A display name for the data source.

    • Type — (String)

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

      Use AMAZON_ELASTICSEARCH for Amazon OpenSearch Service.

      Possible values include:
      • "ADOBE_ANALYTICS"
      • "AMAZON_ELASTICSEARCH"
      • "ATHENA"
      • "AURORA"
      • "AURORA_POSTGRESQL"
      • "AWS_IOT_ANALYTICS"
      • "GITHUB"
      • "JIRA"
      • "MARIADB"
      • "MYSQL"
      • "ORACLE"
      • "POSTGRESQL"
      • "PRESTO"
      • "REDSHIFT"
      • "S3"
      • "SALESFORCE"
      • "SERVICENOW"
      • "SNOWFLAKE"
      • "SPARK"
      • "SQLSERVER"
      • "TERADATA"
      • "TWITTER"
      • "TIMESTREAM"
      • "AMAZON_OPENSEARCH"
    • DataSourceParameters — (map)

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

      • AmazonElasticsearchParameters — (map)

        The parameters for OpenSearch.

        • Domain — required — (String)

          The OpenSearch domain.

      • AthenaParameters — (map)

        The parameters for Amazon Athena.

        • WorkGroup — (String)

          The workgroup that Amazon Athena uses.

      • AuroraParameters — (map)

        The parameters for Amazon Aurora MySQL.

        • Host — required — (String)

          Host.

        • Port — required — (Integer)

          Port.

        • Database — required — (String)

          Database.

      • AuroraPostgreSqlParameters — (map)

        The parameters for Amazon Aurora.

        • Host — required — (String)

          The Amazon Aurora PostgreSQL-Compatible host to connect to.

        • Port — required — (Integer)

          The port that Amazon Aurora PostgreSQL is listening on.

        • Database — required — (String)

          The Amazon Aurora PostgreSQL database to connect to.

      • AwsIotAnalyticsParameters — (map)

        The parameters for IoT Analytics.

        • DataSetName — required — (String)

          Dataset name.

      • JiraParameters — (map)

        The parameters for Jira.

        • SiteBaseUrl — required — (String)

          The base URL of the Jira site.

      • MariaDbParameters — (map)

        The parameters for MariaDB.

        • Host — required — (String)

          Host.

        • Port — required — (Integer)

          Port.

        • Database — required — (String)

          Database.

      • MySqlParameters — (map)

        The parameters for MySQL.

        • Host — required — (String)

          Host.

        • Port — required — (Integer)

          Port.

        • Database — required — (String)

          Database.

      • OracleParameters — (map)

        The parameters for Oracle.

        • Host — required — (String)

          An Oracle host.

        • Port — required — (Integer)

          Port.

        • Database — required — (String)

          Database.

      • PostgreSqlParameters — (map)

        The parameters for PostgreSQL.

        • Host — required — (String)

          Host.

        • Port — required — (Integer)

          Port.

        • Database — required — (String)

          Database.

      • PrestoParameters — (map)

        The parameters for Presto.

        • Host — required — (String)

          Host.

        • Port — required — (Integer)

          Port.

        • Catalog — required — (String)

          Catalog.

      • RdsParameters — (map)

        The parameters for Amazon RDS.

        • InstanceId — required — (String)

          Instance ID.

        • Database — required — (String)

          Database.

      • RedshiftParameters — (map)

        The parameters for Amazon Redshift.

        • Host — (String)

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

        • Port — (Integer)

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

        • Database — required — (String)

          Database.

        • ClusterId — (String)

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

      • S3Parameters — (map)

        The parameters for S3.

        • ManifestFileLocation — required — (map)

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

          • Bucket — required — (String)

            Amazon S3 bucket.

          • Key — required — (String)

            Amazon S3 key that identifies an object.

      • ServiceNowParameters — (map)

        The parameters for ServiceNow.

        • SiteBaseUrl — required — (String)

          URL of the base site.

      • SnowflakeParameters — (map)

        The parameters for Snowflake.

        • Host — required — (String)

          Host.

        • Database — required — (String)

          Database.

        • Warehouse — required — (String)

          Warehouse.

      • SparkParameters — (map)

        The parameters for Spark.

        • Host — required — (String)

          Host.

        • Port — required — (Integer)

          Port.

      • SqlServerParameters — (map)

        The parameters for SQL Server.

        • Host — required — (String)

          Host.

        • Port — required — (Integer)

          Port.

        • Database — required — (String)

          Database.

      • TeradataParameters — (map)

        The parameters for Teradata.

        • Host — required — (String)

          Host.

        • Port — required — (Integer)

          Port.

        • Database — required — (String)

          Database.

      • TwitterParameters — (map)

        The parameters for Twitter.

        • Query — required — (String)

          Twitter query string.

        • MaxRows — required — (Integer)

          Maximum number of rows to query Twitter.

      • AmazonOpenSearchParameters — (map)
        • Domain — required — (String)
    • Credentials — (map)

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

      • CredentialPair — (map)

        Credential pair. For more information, see CredentialPair.

        • Username — required — (String)

          User name.

        • Password — required — (String)

          Password.

        • AlternateDataSourceParameters — (Array<map>)

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

          • AmazonElasticsearchParameters — (map)

            The parameters for OpenSearch.

            • Domain — required — (String)

              The OpenSearch domain.

          • AthenaParameters — (map)

            The parameters for Amazon Athena.

            • WorkGroup — (String)

              The workgroup that Amazon Athena uses.

          • AuroraParameters — (map)

            The parameters for Amazon Aurora MySQL.

            • Host — required — (String)

              Host.

            • Port — required — (Integer)

              Port.

            • Database — required — (String)

              Database.

          • AuroraPostgreSqlParameters — (map)

            The parameters for Amazon Aurora.

            • Host — required — (String)

              The Amazon Aurora PostgreSQL-Compatible host to connect to.

            • Port — required — (Integer)

              The port that Amazon Aurora PostgreSQL is listening on.

            • Database — required — (String)

              The Amazon Aurora PostgreSQL database to connect to.

          • AwsIotAnalyticsParameters — (map)

            The parameters for IoT Analytics.

            • DataSetName — required — (String)

              Dataset name.

          • JiraParameters — (map)

            The parameters for Jira.

            • SiteBaseUrl — required — (String)

              The base URL of the Jira site.

          • MariaDbParameters — (map)

            The parameters for MariaDB.

            • Host — required — (String)

              Host.

            • Port — required — (Integer)

              Port.

            • Database — required — (String)

              Database.

          • MySqlParameters — (map)

            The parameters for MySQL.

            • Host — required — (String)

              Host.

            • Port — required — (Integer)

              Port.

            • Database — required — (String)

              Database.

          • OracleParameters — (map)

            The parameters for Oracle.

            • Host — required — (String)

              An Oracle host.

            • Port — required — (Integer)

              Port.

            • Database — required — (String)

              Database.

          • PostgreSqlParameters — (map)

            The parameters for PostgreSQL.

            • Host — required — (String)

              Host.

            • Port — required — (Integer)

              Port.

            • Database — required — (String)

              Database.

          • PrestoParameters — (map)

            The parameters for Presto.

            • Host — required — (String)

              Host.

            • Port — required — (Integer)

              Port.

            • Catalog — required — (String)

              Catalog.

          • RdsParameters — (map)

            The parameters for Amazon RDS.

            • InstanceId — required — (String)

              Instance ID.

            • Database — required — (String)

              Database.

          • RedshiftParameters — (map)

            The parameters for Amazon Redshift.

            • Host — (String)

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

            • Port — (Integer)

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

            • Database — required — (String)

              Database.

            • ClusterId — (String)

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

          • S3Parameters — (map)

            The parameters for S3.

            • ManifestFileLocation — required — (map)

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

              • Bucket — required — (String)

                Amazon S3 bucket.

              • Key — required — (String)

                Amazon S3 key that identifies an object.

          • ServiceNowParameters — (map)

            The parameters for ServiceNow.

            • SiteBaseUrl — required — (String)

              URL of the base site.

          • SnowflakeParameters — (map)

            The parameters for Snowflake.

            • Host — required — (String)

              Host.

            • Database — required — (String)

              Database.

            • Warehouse — required — (String)

              Warehouse.

          • SparkParameters — (map)

            The parameters for Spark.

            • Host — required — (String)

              Host.

            • Port — required — (Integer)

              Port.

          • SqlServerParameters — (map)

            The parameters for SQL Server.

            • Host — required — (String)

              Host.

            • Port — required — (Integer)

              Port.

            • Database — required — (String)

              Database.

          • TeradataParameters — (map)

            The parameters for Teradata.

            • Host — required — (String)

              Host.

            • Port — required — (Integer)

              Port.

            • Database — required — (String)

              Database.

          • TwitterParameters — (map)

            The parameters for Twitter.

            • Query — required — (String)

              Twitter query string.

            • MaxRows — required — (Integer)

              Maximum number of rows to query Twitter.

          • AmazonOpenSearchParameters — (map)
            • Domain — required — (String)
      • CopySourceArn — (String)

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

    • Permissions — (Array<map>)

      A list of resource permissions on the data source.

      • Principal — required — (String)

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

        • The ARN of an Amazon QuickSight user or group associated with a data source or dataset. (This is common.)

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

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

      • Actions — required — (Array<String>)

        The IAMaction to grant or revoke permissions on.

    • VpcConnectionProperties — (map)

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

      • VpcConnectionArn — required — (String)

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

    • SslProperties — (map)

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

      • DisableSsl — (Boolean)

        A Boolean option to control whether SSL should be disabled.

    • Tags — (Array<map>)

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

      • Key — required — (String)

        Tag key.

      • Value — required — (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 Amazon Resource Name (ARN) of the data source.

      • DataSourceId — (String)

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

      • CreationStatus — (String)

        The status of creating the data source.

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

        The Amazon Web Services 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.

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

Creates an empty shared folder.

Service Reference:

Examples:

Calling the createFolder operation

var params = {
  AwsAccountId: 'STRING_VALUE', /* required */
  FolderId: 'STRING_VALUE', /* required */
  FolderType: SHARED,
  Name: 'STRING_VALUE',
  ParentFolderArn: '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 */
  ]
};
quicksight.createFolder(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.

    • FolderId — (String)

      The folder ID.

    • Name — (String)

      The name of the folder.

    • FolderType — (String)

      The type of folder. By default, folderType is SHARED.

      Possible values include:
      • "SHARED"
    • ParentFolderArn — (String)

      The Amazon Resource Name (ARN) for the parent folder.

      ParentFolderArn can be null. An empty parentFolderArn creates a root-level folder.

    • Permissions — (Array<map>)

      A structure that describes the principals and the resource-level permissions of a folder.

      To specify no permissions, omit Permissions.

      • Principal — required — (String)

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

        • The ARN of an Amazon QuickSight user or group associated with a data source or dataset. (This is common.)

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

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

      • Actions — required — (Array<String>)

        The IAMaction to grant or revoke permissions on.

    • Tags — (Array<map>)

      Tags for the folder.

      • Key — required — (String)

        Tag key.

      • Value — required — (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:

      • Status — (Integer)

        The status of the newly created folder. If succeeded, the status is SC_OK (200).

      • Arn — (String)

        The Amazon Resource Name (ARN) for the newly created folder.

      • FolderId — (String)

        The folder ID for the newly created folder.

      • RequestId — (String)

        The request ID for the newly created folder.

Returns:

  • (AWS.Request) —

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

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

Adds an asset, such as a dashboard, analysis, or dataset into a folder.

Service Reference:

Examples:

Calling the createFolderMembership operation

var params = {
  AwsAccountId: 'STRING_VALUE', /* required */
  FolderId: 'STRING_VALUE', /* required */
  MemberId: 'STRING_VALUE', /* required */
  MemberType: DASHBOARD | ANALYSIS | DATASET /* required */
};
quicksight.createFolderMembership(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.

    • FolderId — (String)

      The folder ID.

    • MemberId — (String)

      The ID of the asset (the dashboard, analysis, or dataset).

    • MemberType — (String)

      The type of the member, including DASHBOARD, ANALYSIS, and DATASET.

      Possible values include:
      • "DASHBOARD"
      • "ANALYSIS"
      • "DATASET"

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 status of the folder membership. If succeeded, the status is SC_OK (200).

      • FolderMember — (map)

        Information about the member in the folder.

        • MemberId — (String)

          The ID of the asset.

        • MemberType — (String)

          The type of the asset.

          Possible values include:
          • "DASHBOARD"
          • "ANALYSIS"
          • "DATASET"
      • RequestId — (String)

        The request ID.

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.

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 Amazon Web Services account that the group is in. Currently, you use the ID for the Amazon Web Services 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 Amazon Web Services 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.

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 Amazon Web Services account that the group is in. Currently, you use the ID for the Amazon Web Services 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 Amazon Web Services 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 IAMpolicy, identified by its Amazon Resource Name (ARN). This policy assignment is attached to the specified groups or users of Amazon QuickSight. Assignment names are unique per Amazon Web Services account. To avoid overwriting rules in other namespaces, use assignment names that are unique.

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 ID of the Amazon Web Services account where you want to assign an IAMpolicy to Amazon QuickSight users or groups.

    • AssignmentName — (String)

      The name of the assignment, also called a rule. It must be unique within an Amazon Web Services account.

    • AssignmentStatus — (String)

      The status of the assignment. Possible values are as follows:

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

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

      • DRAFT - This assignment is an unfinished draft and isn't used when creating the data source.

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

      The ARN for the IAMpolicy to apply to the Amazon QuickSight users and groups specified in this assignment.

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

      The Amazon QuickSight users, groups, or both 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. This name must be unique within the Amazon Web Services account.

      • AssignmentId — (String)

        The ID for the assignment.

      • AssignmentStatus — (String)

        The status of the assignment. Possible values are as follows:

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

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

        • DRAFT - This assignment is an unfinished draft and isn't used when creating the data source.

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

        The ARN for the IAMpolicy that is applied to the Amazon QuickSight users and groups specified in this assignment.

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

        The Amazon QuickSight users, groups, or both that the IAMpolicy is assigned to.

      • RequestId — (String)

        The Amazon Web Services 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? in the Amazon Web Services Knowledge Center. Tags are 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 */
  IngestionType: INCREMENTAL_REFRESH | FULL_REFRESH
};
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 Amazon Web Services account ID.

    • IngestionType — (String)

      The type of ingestion that you want to create.

      Possible values include:
      • "INCREMENTAL_REFRESH"
      • "FULL_REFRESH"

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 Amazon Web Services 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.

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

(Enterprise edition only) Creates a new namespace for you to use with Amazon QuickSight.

A namespace allows you to isolate the Amazon QuickSight users and groups that are registered for that namespace. Users that access the namespace can share assets only with other users or groups in the same namespace. They can't see users and groups in other namespaces. You can create a namespace after your Amazon Web Services account is subscribed to Amazon QuickSight. The namespace must be unique within the Amazon Web Services account. By default, there is a limit of 100 namespaces per Amazon Web Services account. To increase your limit, create a ticket with Amazon Web Services Support.

Service Reference:

Examples:

Calling the createNamespace operation

var params = {
  AwsAccountId: 'STRING_VALUE', /* required */
  IdentityStore: QUICKSIGHT, /* required */
  Namespace: 'STRING_VALUE', /* required */
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
quicksight.createNamespace(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 Amazon Web Services account that you want to create the Amazon QuickSight namespace in.

    • Namespace — (String)

      The name that you want to use to describe the new namespace.

    • IdentityStore — (String)

      Specifies the type of your user identity directory. Currently, this supports users with an identity type of QUICKSIGHT.

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

      The tags that you want to associate with the namespace that you're creating.

      • Key — required — (String)

        Tag key.

      • Value — required — (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 Amazon QuickSight namespace you created.

      • Name — (String)

        The name of the new namespace that you created.

      • CapacityRegion — (String)

        The Amazon Web Services Region; that you want to use for the free SPICE capacity for the new namespace. This is set to the region that you run CreateNamespace in.

      • CreationStatus — (String)

        The status of the creation of the namespace. This is an asynchronous process. A status of CREATED means that your namespace is ready to use. If an error occurs, it indicates if the process is retryable or non-retryable. In the case of a non-retryable error, refer to the error message for follow-up tasks.

        Possible values include:
        • "CREATED"
        • "CREATING"
        • "DELETING"
        • "RETRYABLE_FAILURE"
        • "NON_RETRYABLE_FAILURE"
      • IdentityStore — (String)

        Specifies the type of your user identity directory. Currently, this supports users with an identity type of QUICKSIGHT.

        Possible values include:
        • "QUICKSIGHT"
      • RequestId — (String)

        The Amazon Web Services 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 Amazon QuickSight analysis or template. You can use the resulting template to create a dashboard.

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

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 Amazon Web Services account that the group is in. You use the ID for the Amazon Web Services account that contains your Amazon QuickSight account.

    • TemplateId — (String)

      An ID for the template that you want to create. This template is unique per Amazon Web Services Region; in each Amazon Web Services account.

    • Name — (String)

      A display name for the template.

    • Permissions — (Array<map>)

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

      • Principal — required — (String)

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

        • The ARN of an Amazon QuickSight user or group associated with a data source or dataset. (This is common.)

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

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

      • Actions — required — (Array<String>)

        The IAMaction to grant or revoke permissions on.

    • SourceEntity — (map)

      The entity that you are using as a source when you create the template. In SourceEntity, you specify the type of object you're using as source: SourceTemplate for a template or SourceAnalysis for an analysis. Both of these require an Amazon Resource Name (ARN). For SourceTemplate, specify the ARN of the source template. For SourceAnalysis, specify the ARN of the source analysis. The SourceTemplate ARN can contain any Amazon Web Services account and any Amazon QuickSight-supported Amazon Web Services Region.

      Use the DataSetReferences entity within SourceTemplate or SourceAnalysis to list the replacement datasets for the placeholders listed in the original. The schema in each dataset must match its placeholder.

      • SourceAnalysis — (map)

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

        • Arn — required — (String)

          The Amazon Resource Name (ARN) of the resource.

        • DataSetReferences — required — (Array<map>)

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

          • DataSetPlaceholder — required — (String)

            Dataset placeholder.

          • DataSetArn — required — (String)

            Dataset Amazon Resource Name (ARN).

      • SourceTemplate — (map)

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

        • Arn — required — (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.

      • Key — required — (String)

        Tag key.

      • Value — required — (String)

        Tag value.

    • VersionDescription — (String)

      A description of the current template version being created. This API operation creates 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 ARN for the template.

      • VersionArn — (String)

        The 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"
        • "DELETED"
      • Status — (Integer)

        The HTTP status of the request.

      • RequestId — (String)

        The Amazon Web Services 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.

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)

      The ID of the Amazon Web Services account that contains the template that you creating an alias for.

    • TemplateId — (String)

      An ID for the template.

    • AliasName — (String)

      The name that you want to give to the template alias that you're creating. Don't start the alias name with the $ character. Alias names that start with $ are reserved by Amazon QuickSight.

    • 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 about the template alias.

        • AliasName — (String)

          The display name of the template alias.

        • Arn — (String)

          The Amazon Resource Name (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 Amazon Web Services request ID for this operation.

Returns:

  • (AWS.Request) —

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

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

Creates a theme.

A theme is set of configuration options for color and layout. Themes apply to analyses and dashboards. For more information, see Using Themes in Amazon QuickSight in the Amazon QuickSight User Guide.

Service Reference:

Examples:

Calling the createTheme operation

var params = {
  AwsAccountId: 'STRING_VALUE', /* required */
  BaseThemeId: 'STRING_VALUE', /* required */
  Configuration: { /* required */
    DataColorPalette: {
      Colors: [
        'STRING_VALUE',
        /* more items */
      ],
      EmptyFillColor: 'STRING_VALUE',
      MinMaxGradient: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    Sheet: {
      Tile: {
        Border: {
          Show: true || false
        }
      },
      TileLayout: {
        Gutter: {
          Show: true || false
        },
        Margin: {
          Show: true || false
        }
      }
    },
    UIColorPalette: {
      Accent: 'STRING_VALUE',
      AccentForeground: 'STRING_VALUE',
      Danger: 'STRING_VALUE',
      DangerForeground: 'STRING_VALUE',
      Dimension: 'STRING_VALUE',
      DimensionForeground: 'STRING_VALUE',
      Measure: 'STRING_VALUE',
      MeasureForeground: 'STRING_VALUE',
      PrimaryBackground: 'STRING_VALUE',
      PrimaryForeground: 'STRING_VALUE',
      SecondaryBackground: 'STRING_VALUE',
      SecondaryForeground: 'STRING_VALUE',
      Success: 'STRING_VALUE',
      SuccessForeground: 'STRING_VALUE',
      Warning: 'STRING_VALUE',
      WarningForeground: 'STRING_VALUE'
    }
  },
  Name: 'STRING_VALUE', /* required */
  ThemeId: 'STRING_VALUE', /* required */
  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.createTheme(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 of the Amazon Web Services account where you want to store the new theme.

    • ThemeId — (String)

      An ID for the theme that you want to create. The theme ID is unique per Amazon Web Services Region in each Amazon Web Services account.

    • Name — (String)

      A display name for the theme.

    • BaseThemeId — (String)

      The ID of the theme that a custom theme will inherit from. All themes inherit from one of the starting themes defined by Amazon QuickSight. For a list of the starting themes, use ListThemes or choose Themes from within a Amazon QuickSight analysis.

    • VersionDescription — (String)

      A description of the first version of the theme that you're creating. Every time UpdateTheme is called, a new version is created. Each version of the theme has a description of the version in the VersionDescription field.

    • Configuration — (map)

      The theme configuration, which contains the theme display properties.

      • DataColorPalette — (map)

        Color properties that apply to chart data colors.

        • Colors — (Array<String>)

          The hexadecimal codes for the colors.

        • MinMaxGradient — (Array<String>)

          The minimum and maximum hexadecimal codes that describe a color gradient.

        • EmptyFillColor — (String)

          The hexadecimal code of a color that applies to charts where a lack of data is highlighted.

      • UIColorPalette — (map)

        Color properties that apply to the UI and to charts, excluding the colors that apply to data.

        • PrimaryForeground — (String)

          The color of text and other foreground elements that appear over the primary background regions, such as grid lines, borders, table banding, icons, and so on.

        • PrimaryBackground — (String)

          The background color that applies to visuals and other high emphasis UI.

        • SecondaryForeground — (String)

          The foreground color that applies to any sheet title, sheet control text, or UI that appears over the secondary background.

        • SecondaryBackground — (String)

          The background color that applies to the sheet background and sheet controls.

        • Accent — (String)

          This color is that applies to selected states and buttons.

        • AccentForeground — (String)

          The foreground color that applies to any text or other elements that appear over the accent color.

        • Danger — (String)

          The color that applies to error messages.

        • DangerForeground — (String)

          The foreground color that applies to any text or other elements that appear over the error color.

        • Warning — (String)

          This color that applies to warning and informational messages.

        • WarningForeground — (String)

          The foreground color that applies to any text or other elements that appear over the warning color.

        • Success — (String)

          The color that applies to success messages, for example the check mark for a successful download.

        • SuccessForeground — (String)

          The foreground color that applies to any text or other elements that appear over the success color.

        • Dimension — (String)

          The color that applies to the names of fields that are identified as dimensions.

        • DimensionForeground — (String)

          The foreground color that applies to any text or other elements that appear over the dimension color.

        • Measure — (String)

          The color that applies to the names of fields that are identified as measures.

        • MeasureForeground — (String)

          The foreground color that applies to any text or other elements that appear over the measure color.

      • Sheet — (map)

        Display options related to sheets.

        • Tile — (map)

          The display options for tiles.

          • Border — (map)

            The border around a tile.

            • Show — (Boolean)

              The option to enable display of borders for visuals.

        • TileLayout — (map)

          The layout options for tiles.

          • Gutter — (map)

            The gutter settings that apply between tiles.

            • Show — (Boolean)

              This Boolean value controls whether to display a gutter space between sheet tiles.

          • Margin — (map)

            The margin settings that apply around the outside edge of sheets.

            • Show — (Boolean)

              This Boolean value controls whether to display sheet margins.

    • Permissions — (Array<map>)

      A valid grouping of resource permissions to apply to the new theme.

      • Principal — required — (String)

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

        • The ARN of an Amazon QuickSight user or group associated with a data source or dataset. (This is common.)

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

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

      • Actions — required — (Array<String>)

        The IAMaction to grant or revoke permissions on.

    • Tags — (Array<map>)

      A map of the key-value pairs for the resource tag or tags that you want to add to the resource.

      • Key — required — (String)

        Tag key.

      • Value — required — (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 Amazon Resource Name (ARN) for the theme.

      • VersionArn — (String)

        The Amazon Resource Name (ARN) for the new theme.

      • ThemeId — (String)

        The ID of the theme.

      • CreationStatus — (String)

        The theme creation status.

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

        The HTTP status of the request.

      • RequestId — (String)

        The Amazon Web Services request ID for this operation.

Returns:

  • (AWS.Request) —

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

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

Creates a theme alias for a theme.

Service Reference:

Examples:

Calling the createThemeAlias operation

var params = {
  AliasName: 'STRING_VALUE', /* required */
  AwsAccountId: 'STRING_VALUE', /* required */
  ThemeId: 'STRING_VALUE', /* required */
  ThemeVersionNumber: 'NUMBER_VALUE' /* required */
};
quicksight.createThemeAlias(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 of the Amazon Web Services account that contains the theme for the new theme alias.

    • ThemeId — (String)

      An ID for the theme alias.

    • AliasName — (String)

      The name that you want to give to the theme alias that you are creating. The alias name can't begin with a $. Alias names that start with $ are reserved by Amazon QuickSight.

    • ThemeVersionNumber — (Integer)

      The version number of the theme.

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:

      • ThemeAlias — (map)

        Information about the theme alias.

        • Arn — (String)

          The Amazon Resource Name (ARN) of the theme alias.

        • AliasName — (String)

          The display name of the theme alias.

        • ThemeVersionNumber — (Integer)

          The version number of the theme alias.

      • Status — (Integer)

        The HTTP status of the request.

      • RequestId — (String)

        The Amazon Web Services request ID for this operation.

Returns:

  • (AWS.Request) —

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

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

Deletes all Amazon QuickSight customizations in this Amazon Web Services Region for the specified Amazon Web Services account and Amazon QuickSight namespace.

Service Reference:

Examples:

Calling the deleteAccountCustomization operation

var params = {
  AwsAccountId: 'STRING_VALUE', /* required */
  Namespace: 'STRING_VALUE'
};
quicksight.deleteAccountCustomization(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 Amazon Web Services account that you want to delete Amazon QuickSight customizations from in this Amazon Web Services Region.

    • Namespace — (String)

      The Amazon QuickSight namespace that you're deleting the customizations from.

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 Amazon Web Services 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.

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

Deletes an analysis from Amazon QuickSight. You can optionally include a recovery window during which you can restore the analysis. If you don't specify a recovery window value, the operation defaults to 30 days. Amazon QuickSight attaches a DeletionTime stamp to the response that specifies the end of the recovery window. At the end of the recovery window, Amazon QuickSight deletes the analysis permanently.

At any time before recovery window ends, you can use the RestoreAnalysis API operation to remove the DeletionTime stamp and cancel the deletion of the analysis. The analysis remains visible in the API until it's deleted, so you can describe it but you can't make a template from it.

An analysis that's scheduled for deletion isn't accessible in the Amazon QuickSight console. To access it in the console, restore it. Deleting an analysis doesn't delete the dashboards that you publish from it.

Service Reference:

Examples:

Calling the deleteAnalysis operation

var params = {
  AnalysisId: 'STRING_VALUE', /* required */
  AwsAccountId: 'STRING_VALUE', /* required */
  ForceDeleteWithoutRecovery: true || false,
  RecoveryWindowInDays: 'NUMBER_VALUE'
};
quicksight.deleteAnalysis(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 of the Amazon Web Services account where you want to delete an analysis.

    • AnalysisId — (String)

      The ID of the analysis that you're deleting.

    • RecoveryWindowInDays — (Integer)

      A value that specifies the number of days that Amazon QuickSight waits before it deletes the analysis. You can't use this parameter with the ForceDeleteWithoutRecovery option in the same API call. The default value is 30.

    • ForceDeleteWithoutRecovery — (Boolean)

      This option defaults to the value NoForceDeleteWithoutRecovery. To immediately delete the analysis, add the ForceDeleteWithoutRecovery option. You can't restore an analysis after it's 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 Amazon Resource Name (ARN) of the deleted analysis.

      • AnalysisId — (String)

        The ID of the deleted analysis.

      • DeletionTime — (Date)

        The date and time that the analysis is scheduled to be deleted.

      • RequestId — (String)

        The Amazon Web Services 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.

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)

      The ID of the Amazon Web Services account that contains the dashboard that you're deleting.

    • DashboardId — (String)

      The ID for the dashboard.

    • VersionNumber — (Integer)

      The version number of the dashboard. If the 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 Secure Socket Layer (SSL) properties that apply for the resource.

      • DashboardId — (String)

        The ID of the dashboard.

      • RequestId — (String)

        The Amazon Web Services 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.

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 Amazon Web Services account ID.

    • DataSetId — (String)

      The ID for the dataset that you want to create. This ID is unique per Amazon Web Services Region for each Amazon Web Services 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 Amazon Resource Name (ARN) of the dataset.

      • DataSetId — (String)

        The ID for the dataset that you want to create. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

      • RequestId — (String)

        The Amazon Web Services 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 operation breaks all the datasets that reference the deleted data source.

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 Amazon Web Services account ID.

    • DataSourceId — (String)

      The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services 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 Amazon Resource Name (ARN) of the data source that you deleted.

      • DataSourceId — (String)

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

      • RequestId — (String)

        The Amazon Web Services 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.

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

Deletes an empty folder.

Service Reference:

Examples:

Calling the deleteFolder operation

var params = {
  AwsAccountId: 'STRING_VALUE', /* required */
  FolderId: 'STRING_VALUE' /* required */
};
quicksight.deleteFolder(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 for the folder.

    • FolderId — (String)

      The folder 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:

      • Status — (Integer)

        The status of deleting the folder. If succeeded, the status is SC_OK (200).

      • Arn — (String)

        The Amazon Resource Name of the deleted folder.

      • FolderId — (String)

        The folder ID.

      • RequestId — (String)

        The request ID.

Returns:

  • (AWS.Request) —

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

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

Removes an asset, such as a dashboard, analysis, or dataset, from a folder.

Service Reference:

Examples:

Calling the deleteFolderMembership operation

var params = {
  AwsAccountId: 'STRING_VALUE', /* required */
  FolderId: 'STRING_VALUE', /* required */
  MemberId: 'STRING_VALUE', /* required */
  MemberType: DASHBOARD | ANALYSIS | DATASET /* required */
};
quicksight.deleteFolderMembership(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.

    • FolderId — (String)

      The Folder ID.

    • MemberId — (String)

      The ID of the asset (the dashboard, analysis, or dataset) that you want to delete.

    • MemberType — (String)

      The type of the member, including DASHBOARD, ANALYSIS, and DATASET

      Possible values include:
      • "DASHBOARD"
      • "ANALYSIS"
      • "DATASET"

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 status of deleting the asset. If succeeded, the status is SC_OK (200).

      • RequestId — (String)

        The request ID.

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.

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 Amazon Web Services account that the group is in. Currently, you use the ID for the Amazon Web Services 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 Amazon Web Services 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.

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 Amazon Web Services account that the group is in. Currently, you use the ID for the Amazon Web Services 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 Amazon Web Services 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 IAMpolicy assignment.

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 Amazon Web Services account ID where you want to delete the IAMpolicy 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 Amazon Web Services 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.

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

Deletes a namespace and the users and groups that are associated with the namespace. This is an asynchronous process. Assets including dashboards, analyses, datasets and data sources are not deleted. To delete these assets, you use the API operations for the relevant asset.

Service Reference:

Examples:

Calling the deleteNamespace operation

var params = {
  AwsAccountId: 'STRING_VALUE', /* required */
  Namespace: 'STRING_VALUE' /* required */
};
quicksight.deleteNamespace(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 Amazon Web Services account that you want to delete the Amazon QuickSight namespace from.

    • Namespace — (String)

      The namespace that you want to delete.

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 Amazon Web Services 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.

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)

      The ID of the Amazon Web Services account that contains the template that you're deleting.

    • TemplateId — (String)

      An ID for the template you want to delete.

    • VersionNumber — (Integer)

      Specifies the version of the template that you want to delete. If you don't provide a version number, DeleteTemplate deletes all versions 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:

      • RequestId — (String)

        The Amazon Web Services request ID for this operation.

      • Arn — (String)

        The Amazon Resource Name (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

Deletes the item that the specified template alias points to. If you provide a specific alias, you delete the version of the template that the alias points to.

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)

      The ID of the Amazon Web Services account that contains the item to delete.

    • TemplateId — (String)

      The ID for the template that the specified alias is for.

    • AliasName — (String)

      The name for the template alias. To delete a specific alias, you delete the version that the alias points to. You can specify the alias name, or specify the latest version of the template by providing the keyword $LATEST in the AliasName parameter.

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 associated with the deletion.

      • AliasName — (String)

        The name for the template alias.

      • Arn — (String)

        The Amazon Resource Name (ARN) of the template you want to delete.

      • RequestId — (String)

        The Amazon Web Services request ID for this operation.

Returns:

  • (AWS.Request) —

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

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

Deletes a theme.

Service Reference:

Examples:

Calling the deleteTheme operation

var params = {
  AwsAccountId: 'STRING_VALUE', /* required */
  ThemeId: 'STRING_VALUE', /* required */
  VersionNumber: 'NUMBER_VALUE'
};
quicksight.deleteTheme(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 of the Amazon Web Services account that contains the theme that you're deleting.

    • ThemeId — (String)

      An ID for the theme that you want to delete.

    • VersionNumber — (Integer)

      The version of the theme that you want to delete.

      Note: If you don't provide a version number, you're using this call to DeleteTheme to delete all versions of the theme.

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) of the resource.

      • RequestId — (String)

        The Amazon Web Services request ID for this operation.

      • Status — (Integer)

        The HTTP status of the request.

      • ThemeId — (String)

        An ID for the theme.

Returns:

  • (AWS.Request) —

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

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

Deletes the version of the theme that the specified theme alias points to. If you provide a specific alias, you delete the version of the theme that the alias points to.

Service Reference:

Examples:

Calling the deleteThemeAlias operation

var params = {
  AliasName: 'STRING_VALUE', /* required */
  AwsAccountId: 'STRING_VALUE', /* required */
  ThemeId: 'STRING_VALUE' /* required */
};
quicksight.deleteThemeAlias(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 of the Amazon Web Services account that contains the theme alias to delete.

    • ThemeId — (String)

      The ID for the theme that the specified alias is for.

    • AliasName — (String)

      The unique name for the theme alias to delete.

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:

      • AliasName — (String)

        The name for the theme alias.

      • Arn — (String)

        The Amazon Resource Name (ARN) of the theme resource using the deleted alias.

      • RequestId — (String)

        The Amazon Web Services request ID for this operation.

      • Status — (Integer)

        The HTTP status of the request.

      • ThemeId — (String)

        An ID for the theme associated with the deletion.

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

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 Amazon Web Services account that the user is in. Currently, you use the ID for the Amazon Web Services 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 Amazon Web Services 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.

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 Amazon Web Services account that the user is in. Currently, you use the ID for the Amazon Web Services 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 Amazon Web Services 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.

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

Describes the customizations associated with the provided Amazon Web Services account and Amazon Amazon QuickSight namespace in an Amazon Web Services Region. The Amazon QuickSight console evaluates which customizations to apply by running this API operation with the Resolved flag included.

To determine what customizations display when you run this command, it can help to visualize the relationship of the entities involved.

  • Amazon Web Services account - The Amazon Web Services account exists at the top of the hierarchy. It has the potential to use all of the Amazon Web Services Regions and AWS Services. When you subscribe to Amazon QuickSight, you choose one Amazon Web Services Region to use as your home Region. That's where your free SPICE capacity is located. You can use Amazon QuickSight in any supported Amazon Web Services Region.

  • Amazon Web Services Region - In each Amazon Web Services Region where you sign in to Amazon QuickSight at least once, Amazon QuickSight acts as a separate instance of the same service. If you have a user directory, it resides in us-east-1, which is the US East (N. Virginia). Generally speaking, these users have access to Amazon QuickSight in any Amazon Web Services Region, unless they are constrained to a namespace.

    To run the command in a different Amazon Web Services Region, you change your Region settings. If you're using the AWS CLI, you can use one of the following options:

  • Namespace - A Amazon QuickSight namespace is a partition that contains users and assets (data sources, datasets, dashboards, and so on). To access assets that are in a specific namespace, users and groups must also be part of the same namespace. People who share a namespace are completely isolated from users and assets in other namespaces, even if they are in the same Amazon Web Services account and Amazon Web Services Region.

  • Applied customizations - Within an Amazon Web Services Region, a set of Amazon QuickSight customizations can apply to an Amazon Web Services account or to a namespace. Settings that you apply to a namespace override settings that you apply to an Amazon Web Services account. All settings are isolated to a single Amazon Web Services Region. To apply them in other Amazon Web Services Regions, run the CreateAccountCustomization command in each Amazon Web Services Region where you want to apply the same customizations.

Service Reference:

Examples:

Calling the describeAccountCustomization operation

var params = {
  AwsAccountId: 'STRING_VALUE', /* required */
  Namespace: 'STRING_VALUE',
  Resolved: true || false
};
quicksight.describeAccountCustomization(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 Amazon Web Services account that you want to describe Amazon QuickSight customizations for.

    • Namespace — (String)

      The Amazon QuickSight namespace that you want to describe Amazon QuickSight customizations for.

    • Resolved — (Boolean)

      The Resolved flag works with the other parameters to determine which view of Amazon QuickSight customizations is returned. You can add this flag to your command to use the same view that Amazon QuickSight uses to identify which customizations to apply to the console. Omit this flag, or set it to no-resolved, to reveal customizations that are configured at different levels.

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) of the customization that's associated with this Amazon Web Services account.

      • AwsAccountId — (String)

        The ID for the Amazon Web Services account that you're describing.

      • Namespace — (String)

        The Amazon QuickSight namespace that you're describing.

      • AccountCustomization — (map)

        The Amazon QuickSight customizations that exist in the current Amazon Web Services Region.

        • DefaultTheme — (String)

          The default theme for this Amazon QuickSight subscription.

      • RequestId — (String)

        The Amazon Web Services 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.

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

Describes the settings that were used when your Amazon QuickSight subscription was first created in this Amazon Web Services account.

Service Reference:

Examples:

Calling the describeAccountSettings operation

var params = {
  AwsAccountId: 'STRING_VALUE' /* required */
};
quicksight.describeAccountSettings(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 Amazon Web Services account that contains the settings that you want to list.

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:

      • AccountSettings — (map)

        The Amazon QuickSight settings for this Amazon Web Services account. This information includes the edition of Amazon Amazon QuickSight that you subscribed to (Standard or Enterprise) and the notification email for the Amazon QuickSight subscription. In the Amazon QuickSight console, the Amazon QuickSight subscription is sometimes referred to as a Amazon QuickSight "account" even though it's technically not an account by itself. Instead, it's a subscription to the Amazon QuickSight service for your Amazon Web Services account. The edition that you subscribe to applies to Amazon QuickSight in every Amazon Web Services Region where you use it.

        • AccountName — (String)

          The "account name" you provided for the Amazon QuickSight subscription in your Amazon Web Services account. You create this name when you sign up for Amazon QuickSight. It is unique in all of Amazon Web Services and it appears only when users sign in.

        • Edition — (String)

          The edition of Amazon QuickSight that you're currently subscribed to: Enterprise edition or Standard edition.

          Possible values include:
          • "STANDARD"
          • "ENTERPRISE"
        • DefaultNamespace — (String)

          The default Amazon QuickSight namespace for your Amazon Web Services account.

        • NotificationEmail — (String)

          The main notification email for your Amazon QuickSight subscription.

      • RequestId — (String)

        The Amazon Web Services 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.

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

Provides a summary of the metadata for an analysis.

Service Reference:

Examples:

Calling the describeAnalysis operation

var params = {
  AnalysisId: 'STRING_VALUE', /* required */
  AwsAccountId: 'STRING_VALUE' /* required */
};
quicksight.describeAnalysis(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 of the Amazon Web Services account that contains the analysis. You must be using the Amazon Web Services account that the analysis is in.

    • AnalysisId — (String)

      The ID of the analysis that you're describing. The ID is part of the URL of the analysis.

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:

      • Analysis — (map)

        A metadata structure that contains summary information for the analysis that you're describing.

        • AnalysisId — (String)

          The ID of the analysis.

        • Arn — (String)

          The Amazon Resource Name (ARN) of the analysis.

        • Name — (String)

          The descriptive name of the analysis.

        • Status — (String)

          Status associated with the analysis.

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

          Errors associated with the analysis.

          • Type — (String)

            The type of the analysis error.

            Possible values include:
            • "ACCESS_DENIED"
            • "SOURCE_NOT_FOUND"
            • "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)

            The message associated with the analysis error.

        • DataSetArns — (Array<String>)

          The ARNs of the datasets of the analysis.

        • ThemeArn — (String)

          The ARN of the theme of the analysis.

        • CreatedTime — (Date)

          The time that the analysis was created.

        • LastUpdatedTime — (Date)

          The time that the analysis was last updated.

        • Sheets — (Array<map>)

          A list of the associated sheets with the unique identifier and name of each sheet.

          • SheetId — (String)

            The unique identifier associated with a sheet.

          • Name — (String)

            The name of a sheet. This name is displayed on the sheet's tab in the Amazon QuickSight console.

      • Status — (Integer)

        The HTTP status of the request.

      • RequestId — (String)

        The Amazon Web Services request ID for this operation.

Returns:

  • (AWS.Request) —

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

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

Provides the read and write permissions for an analysis.

Service Reference:

Examples:

Calling the describeAnalysisPermissions operation

var params = {
  AnalysisId: 'STRING_VALUE', /* required */
  AwsAccountId: 'STRING_VALUE' /* required */
};
quicksight.describeAnalysisPermissions(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 of the Amazon Web Services account that contains the analysis whose permissions you're describing. You must be using the Amazon Web Services account that the analysis is in.

    • AnalysisId — (String)

      The ID of the analysis whose permissions you're describing. The ID is part of the analysis URL.

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:

      • AnalysisId — (String)

        The ID of the analysis whose permissions you're describing.

      • AnalysisArn — (String)

        The Amazon Resource Name (ARN) of the analysis whose permissions you're describing.

      • Permissions — (Array<map>)

        A structure that describes the principals and the resource-level permissions on an analysis.

        • Principal — required — (String)

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

          • The ARN of an Amazon QuickSight user or group associated with a data source or dataset. (This is common.)

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

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

        • Actions — required — (Array<String>)

          The IAMaction to grant or revoke permissions on.

      • Status — (Integer)

        The HTTP status of the request.

      • RequestId — (String)

        The Amazon Web Services request ID for this operation.

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.

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)

      The ID of the Amazon Web Services account that contains the dashboard that you're describing.

    • DashboardId — (String)

      The ID for the dashboard.

    • VersionNumber — (Integer)

      The version number for the dashboard. If a 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 dashboard.

        • Version — (map)

          Version.

          • CreatedTime — (Date)

            The time that this dashboard version was created.

          • Errors — (Array<map>)

            Errors associated with this dashboard version.

            • Type — (String)

              Type.

              Possible values include:
              • "ACCESS_DENIED"
              • "SOURCE_NOT_FOUND"
              • "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 for this version of the dashboard.

          • 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"
            • "DELETED"
          • Arn — (String)

            The Amazon Resource Name (ARN) of the resource.

          • SourceEntityArn — (String)

            Source entity ARN.

          • DataSetArns — (Array<String>)

            The Amazon Resource Numbers (ARNs) for the datasets that are associated with this version of the dashboard.

          • Description — (String)

            Description.

          • ThemeArn — (String)

            The ARN of the theme associated with a version of the dashboard.

          • Sheets — (Array<map>)

            A list of the associated sheets with the unique identifier and name of each sheet.

            • SheetId — (String)

              The unique identifier associated with a sheet.

            • Name — (String)

              The name of a sheet. This name is displayed on the sheet's tab in the Amazon QuickSight console.

        • CreatedTime — (Date)

          The time that this dataset was created.

        • LastPublishedTime — (Date)

          The last time that this dataset was published.

        • LastUpdatedTime — (Date)

          The last time that this dataset was updated.

      • Status — (Integer)

        The HTTP status of this request.

      • RequestId — (String)

        The Amazon Web Services 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 for a dashboard.

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)

      The ID of the Amazon Web Services account that contains the dashboard that you're describing permissions for.

    • DashboardId — (String)

      The ID for the dashboard, also added to the IAMpolicy.

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 Amazon Resource Name (ARN) of the dashboard.

      • Permissions — (Array<map>)

        A structure that contains the permissions for the dashboard.

        • Principal — required — (String)

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

          • The ARN of an Amazon QuickSight user or group associated with a data source or dataset. (This is common.)

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

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

        • Actions — required — (Array<String>)

          The IAMaction to grant or revoke permissions on.

      • Status — (Integer)

        The HTTP status of the request.

      • RequestId — (String)

        The Amazon Web Services 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.

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 Amazon Web Services account ID.

    • DataSetId — (String)

      The ID for the dataset that you want to create. This ID is unique per Amazon Web Services Region for each Amazon Web Services 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 that this dataset was created.

        • LastUpdatedTime — (Date)

          The last time that this dataset 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.

            • DataSourceArn — required — (String)

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

            • Catalog — (String)

              The catalog associated with a table.

            • Schema — (String)

              The schema name. This name applies to certain relational database engines.

            • Name — required — (String)

              The name of the relational table.

            • InputColumns — required — (Array<map>)

              The column schema of the table.

              • Name — required — (String)

                The name of this column in the underlying data source.

              • Type — required — (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.

            • DataSourceArn — required — (String)

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

            • Name — required — (String)

              A display name for the SQL query result.

            • SqlQuery — required — (String)

              The SQL query.

            • Columns — (Array<map>)

              The column schema from the SQL query result set.

              • Name — required — (String)

                The name of this column in the underlying data source.

              • Type — required — (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.

            • DataSourceArn — required — (String)

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

            • UploadSettings — (map)

              Information about the format for the S3 source file or files.

              • 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 the file has a header row, or the files each have a header row.

              • TextQualifier — (String)

                Text qualifier.

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

                The delimiter between values in the file.

            • InputColumns — required — (Array<map>)

              A physical table type for an S3 data source.

              Note: For files that aren't JSON, only STRING data types are supported in input columns.
              • Name — required — (String)

                The name of this column in the underlying data source.

              • Type — required — (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.

          • Alias — required — (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.

              • ProjectedColumns — required — (Array<String>)

                Projected columns.

            • FilterOperation — (map)

              An operation that filters rows based on some condition.

              • ConditionExpression — required — (String)

                An expression that must evaluate to a Boolean value. Rows for which the expression evaluates 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.

              • Columns — required — (Array<map>)

                Calculated columns to create.

                • ColumnName — required — (String)

                  Column name.

                • ColumnId — required — (String)

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

                • Expression — required — (String)

                  An expression that defines the calculated column.

            • RenameColumnOperation — (map)

              An operation that renames a column.

              • ColumnName — required — (String)

                The name of the column to be renamed.

              • NewColumnName — required — (String)

                The new name for the column.

            • CastColumnTypeOperation — (map)

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

              • ColumnName — required — (String)

                Column name.

              • NewColumnType — required — (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 string in a format supported by Amazon QuickSight to denote the source data format.

            • TagColumnOperation — (map)

              An operation that tags a column with additional information.

              • ColumnName — required — (String)

                The column that this operation acts on.

              • Tags — required — (Array<map>)

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

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

                  A geospatial role for a column.

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

                  A description for a column.

                  • Text — (String)

                    The text of a description for a column.

            • UntagColumnOperation — (map)

              A transform operation that removes tags associated with a column.

              • ColumnName — required — (String)

                The column that this operation acts on.

              • TagNames — required — (Array<String>)

                The column tags to remove from this column.

          • Source — required — (map)

            Source of this logical table.

            • JoinInstruction — (map)

              Specifies the result of a join of two logical tables.

              • LeftOperand — required — (String)

                The operand on the left side of a join.

              • RightOperand — required — (String)

                The operand on the right side of a join.

              • LeftJoinKeyProperties — (map)

                Join key properties of the left operand.

                • UniqueKey — (Boolean)

                  A value that indicates that a row in a table is uniquely identified by the columns in a join key. This is used by Amazon QuickSight to optimize query performance.

              • RightJoinKeyProperties — (map)

                Join key properties of the right operand.

                • UniqueKey — (Boolean)

                  A value that indicates that a row in a table is uniquely identified by the columns in a join key. This is used by Amazon QuickSight to optimize query performance.

              • Type — required — (String)

                The type of join that it is.

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

                The join instructions provided in the ON clause of a join.

            • PhysicalTableId — (String)

              Physical table ID.

            • DataSetArn — (String)

              The Amazon Resource Number (ARN) of the parent dataset.

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

          • Description — (String)

            A description for a column.

          • Type — (String)

            Type.

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

          A value that indicates whether 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 Amazon QuickSight features. Currently, only geospatial hierarchy is supported.

          • GeoSpatialColumnGroup — (map)

            Geospatial column group that denotes a hierarchy.

            • Name — required — (String)

              A display name for the hierarchy.

            • CountryCode — required — (String)

              Country code.

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

              Columns in this hierarchy.

        • FieldFolders — (map<map>)

          The folder that contains fields and nested subfolders for your dataset.

          • description — (String)

            The description for a field folder.

          • columns — (Array<String>)

            A folder has a list of columns. A column can only be in one folder.

        • RowLevelPermissionDataSet — (map)

          The row-level security configuration for the dataset.

          • Namespace — (String)

            The namespace associated with the dataset that contains permissions for RLS.

          • Arn — required — (String)

            The Amazon Resource Name (ARN) of the dataset that contains permissions for RLS.

          • PermissionPolicy — required — (String)

            The type of permissions to use when interpreting the permissions for RLS. DENY_ACCESS is included for backward compatibility only.

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

            The user or group rules associated with the dataset that contains permissions for RLS.

            By default, FormatVersion is VERSION_1. When FormatVersion is VERSION_1, UserName and GroupName are required. When FormatVersion is VERSION_2, UserARN and GroupARN are required, and Namespace must not exist.

            Possible values include:
            • "VERSION_1"
            • "VERSION_2"
          • Status — (String)

            The status of the row-level security permission dataset. If enabled, the status is ENABLED. If disabled, the status is DISABLED.

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

          The element you can use to define tags for row-level security.

          • Status — (String)

            The status of row-level security tags. If enabled, the status is ENABLED. If disabled, the status is DISABLED.

            Possible values include:
            • "ENABLED"
            • "DISABLED"
          • TagRules — required — (Array<map>)

            A set of rules associated with row-level security, such as the tag names and columns that they are assigned to.

            • TagKey — required — (String)

              The unique key for a tag.

            • ColumnName — required — (String)

              The column name that a tag key is assigned to.

            • TagMultiValueDelimiter — (String)

              A string that you want to use to delimit the values when you pass the values at run time. For example, you can delimit the values with a comma.

            • MatchAllValue — (String)

              A string that you want to use to filter by all the values in a column in the dataset and don’t want to list the values one by one. For example, you can use an asterisk as your match all value.

        • ColumnLevelPermissionRules — (Array<map>)

          A set of one or more definitions of a ColumnLevelPermissionRule .

          • Principals — (Array<String>)

            An array of Amazon Resource Names (ARNs) for Amazon QuickSight users or groups.

          • ColumnNames — (Array<String>)

            An array of column names.

        • DataSetUsageConfiguration — (map)

          The usage configuration to apply to child datasets that reference this dataset as a source.

          • DisableUseAsDirectQuerySource — (Boolean)

            An option that controls whether a child dataset of a direct query can use this dataset as a source.

          • DisableUseAsImportedSource — (Boolean)

            An option that controls whether a child dataset that's stored in QuickSight can use this dataset as a source.

      • RequestId — (String)

        The Amazon Web Services 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.

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 Amazon Web Services account ID.

    • DataSetId — (String)

      The ID for the dataset that you want to create. This ID is unique per Amazon Web Services Region for each Amazon Web Services 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 Amazon Resource Name (ARN) of the dataset.

      • DataSetId — (String)

        The ID for the dataset that you want to create. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

      • Permissions — (Array<map>)

        A list of resource permissions on the dataset.

        • Principal — required — (String)

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

          • The ARN of an Amazon QuickSight user or group associated with a data source or dataset. (This is common.)

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

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

        • Actions — required — (Array<String>)

          The IAMaction to grant or revoke permissions on.

      • RequestId — (String)

        The Amazon Web Services 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.

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 Amazon Web Services account ID.

    • DataSourceId — (String)

      The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services 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 ID is unique per Amazon Web Services Region for each Amazon Web Services account.

        • Name — (String)

          A display name for the data source.

        • Type — (String)

          The type of the data source. This type 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"
          • "ORACLE"
          • "POSTGRESQL"
          • "PRESTO"
          • "REDSHIFT"
          • "S3"
          • "SALESFORCE"
          • "SERVICENOW"
          • "SNOWFLAKE"
          • "SPARK"
          • "SQLSERVER"
          • "TERADATA"
          • "TWITTER"
          • "TIMESTREAM"
          • "AMAZON_OPENSEARCH"
        • 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"
          • "DELETED"
        • CreatedTime — (Date)

          The time that this data source was created.

        • LastUpdatedTime — (Date)

          The last time that this data source was updated.

        • DataSourceParameters — (map)

          The parameters that Amazon QuickSight uses to connect to your underlying source. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.

          • AmazonElasticsearchParameters — (map)

            The parameters for OpenSearch.

            • Domain — required — (String)

              The OpenSearch domain.

          • AthenaParameters — (map)

            The parameters for Amazon Athena.

            • WorkGroup — (String)

              The workgroup that Amazon Athena uses.

          • AuroraParameters — (map)

            The parameters for Amazon Aurora MySQL.

            • Host — required — (String)

              Host.

            • Port — required — (Integer)

              Port.

            • Database — required — (String)

              Database.

          • AuroraPostgreSqlParameters — (map)

            The parameters for Amazon Aurora.

            • Host — required — (String)

              The Amazon Aurora PostgreSQL-Compatible host to connect to.

            • Port — required — (Integer)

              The port that Amazon Aurora PostgreSQL is listening on.

            • Database — required — (String)

              The Amazon Aurora PostgreSQL database to connect to.

          • AwsIotAnalyticsParameters — (map)

            The parameters for IoT Analytics.

            • DataSetName — required — (String)

              Dataset name.

          • JiraParameters — (map)

            The parameters for Jira.

            • SiteBaseUrl — required — (String)

              The base URL of the Jira site.

          • MariaDbParameters — (map)

            The parameters for MariaDB.

            • Host — required — (String)

              Host.

            • Port — required — (Integer)

              Port.

            • Database — required — (String)

              Database.

          • MySqlParameters — (map)

            The parameters for MySQL.

            • Host — required — (String)

              Host.

            • Port — required — (Integer)

              Port.

            • Database — required — (String)

              Database.

          • OracleParameters — (map)

            The parameters for Oracle.

            • Host — required — (String)

              An Oracle host.

            • Port — required — (Integer)

              Port.

            • Database — required — (String)

              Database.

          • PostgreSqlParameters — (map)

            The parameters for PostgreSQL.

            • Host — required — (String)

              Host.

            • Port — required — (Integer)

              Port.

            • Database — required — (String)

              Database.

          • PrestoParameters — (map)

            The parameters for Presto.

            • Host — required — (String)

              Host.

            • Port — required — (Integer)

              Port.

            • Catalog — required — (String)

              Catalog.

          • RdsParameters — (map)

            The parameters for Amazon RDS.

            • InstanceId — required — (String)

              Instance ID.

            • Database — required — (String)

              Database.

          • RedshiftParameters — (map)

            The parameters for Amazon Redshift.

            • Host — (String)

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

            • Port — (Integer)

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

            • Database — required — (String)

              Database.

            • ClusterId — (String)

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

          • S3Parameters — (map)

            The parameters for S3.

            • ManifestFileLocation — required — (map)

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

              • Bucket — required — (String)

                Amazon S3 bucket.

              • Key — required — (String)

                Amazon S3 key that identifies an object.

          • ServiceNowParameters — (map)

            The parameters for ServiceNow.

            • SiteBaseUrl — required — (String)

              URL of the base site.

          • SnowflakeParameters — (map)

            The parameters for Snowflake.

            • Host — required — (String)

              Host.

            • Database — required — (String)

              Database.

            • Warehouse — required — (String)

              Warehouse.

          • SparkParameters — (map)

            The parameters for Spark.

            • Host — required — (String)

              Host.

            • Port — required — (Integer)

              Port.

          • SqlServerParameters — (map)

            The parameters for SQL Server.

            • Host — required — (String)

              Host.

            • Port — required — (Integer)

              Port.

            • Database — required — (String)

              Database.

          • TeradataParameters — (map)

            The parameters for Teradata.

            • Host — required — (String)

              Host.

            • Port — required — (Integer)

              Port.

            • Database — required — (String)

              Database.

          • TwitterParameters — (map)

            The parameters for Twitter.

            • Query — required — (String)

              Twitter query string.

            • MaxRows — required — (Integer)

              Maximum number of rows to query Twitter.

          • AmazonOpenSearchParameters — (map)
            • Domain — required — (String)
        • AlternateDataSourceParameters — (Array<map>)

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

          • AmazonElasticsearchParameters — (map)

            The parameters for OpenSearch.

            • Domain — required — (String)

              The OpenSearch domain.

          • AthenaParameters — (map)

            The parameters for Amazon Athena.

            • WorkGroup — (String)

              The workgroup that Amazon Athena uses.

          • AuroraParameters — (map)

            The parameters for Amazon Aurora MySQL.

            • Host — required — (String)

              Host.

            • Port — required — (Integer)

              Port.

            • Database — required — (String)

              Database.

          • AuroraPostgreSqlParameters — (map)

            The parameters for Amazon Aurora.

            • Host — required — (String)

              The Amazon Aurora PostgreSQL-Compatible host to connect to.

            • Port — required — (Integer)

              The port that Amazon Aurora PostgreSQL is listening on.

            • Database — required — (String)

              The Amazon Aurora PostgreSQL database to connect to.

          • AwsIotAnalyticsParameters — (map)

            The parameters for IoT Analytics.

            • DataSetName — required — (String)

              Dataset name.

          • JiraParameters — (map)

            The parameters for Jira.

            • SiteBaseUrl — required — (String)

              The base URL of the Jira site.

          • MariaDbParameters — (map)

            The parameters for MariaDB.

            • Host — required — (String)

              Host.

            • Port — required — (Integer)

              Port.

            • Database — required — (String)

              Database.

          • MySqlParameters — (map)

            The parameters for MySQL.

            • Host — required — (String)

              Host.

            • Port — required — (Integer)

              Port.

            • Database — required — (String)

              Database.

          • OracleParameters — (map)

            The parameters for Oracle.

            • Host — required — (String)

              An Oracle host.

            • Port — required — (Integer)

              Port.

            • Database — required — (String)

              Database.

          • PostgreSqlParameters — (map)

            The parameters for PostgreSQL.

            • Host — required — (String)

              Host.

            • Port — required — (Integer)

              Port.

            • Database — required — (String)

              Database.

          • PrestoParameters — (map)

            The parameters for Presto.

            • Host — required — (String)

              Host.

            • Port — required — (Integer)

              Port.

            • Catalog — required — (String)

              Catalog.

          • RdsParameters — (map)

            The parameters for Amazon RDS.

            • InstanceId — required — (String)

              Instance ID.

            • Database — required — (String)

              Database.

          • RedshiftParameters — (map)

            The parameters for Amazon Redshift.

            • Host — (String)

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

            • Port — (Integer)

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

            • Database — required — (String)

              Database.

            • ClusterId — (String)

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

          • S3Parameters — (map)

            The parameters for S3.

            • ManifestFileLocation — required — (map)

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

              • Bucket — required — (String)

                Amazon S3 bucket.

              • Key — required — (String)

                Amazon S3 key that identifies an object.

          • ServiceNowParameters — (map)

            The parameters for ServiceNow.

            • SiteBaseUrl — required — (String)

              URL of the base site.

          • SnowflakeParameters — (map)

            The parameters for Snowflake.

            • Host — required — (String)

              Host.

            • Database — required — (String)

              Database.

            • Warehouse — required — (String)

              Warehouse.

          • SparkParameters — (map)

            The parameters for Spark.

            • Host — required — (String)

              Host.

            • Port — required — (Integer)

              Port.

          • SqlServerParameters — (map)

            The parameters for SQL Server.

            • Host — required — (String)

              Host.

            • Port — required — (Integer)

              Port.

            • Database — required — (String)

              Database.

          • TeradataParameters — (map)

            The parameters for Teradata.

            • Host — required — (String)

              Host.

            • Port — required — (Integer)

              Port.

            • Database — required — (String)

              Database.

          • TwitterParameters — (map)

            The parameters for Twitter.

            • Query — required — (String)

              Twitter query string.

            • MaxRows — required — (Integer)

              Maximum number of rows to query Twitter.

          • AmazonOpenSearchParameters — (map)
            • Domain — required — (String)
        • VpcConnectionProperties — (map)

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

          • VpcConnectionArn — required — (String)

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

        • SslProperties — (map)

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

          • DisableSsl — (Boolean)

            A Boolean option to control whether SSL should be disabled.

        • ErrorInfo — (map)

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

          • Type — (String)

            Error type.

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

            Error message.

      • RequestId — (String)

        The Amazon Web Services 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.

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 Amazon Web Services account ID.

    • DataSourceId — (String)

      The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services 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 Amazon Resource Name (ARN) of the data source.

      • DataSourceId — (String)

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

      • Permissions — (Array<map>)

        A list of resource permissions on the data source.

        • Principal — required — (String)

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

          • The ARN of an Amazon QuickSight user or group associated with a data source or dataset. (This is common.)

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

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

        • Actions — required — (Array<String>)

          The IAMaction to grant or revoke permissions on.

      • RequestId — (String)

        The Amazon Web Services 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.

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

Describes a folder.

Service Reference:

Examples:

Calling the describeFolder operation

var params = {
  AwsAccountId: 'STRING_VALUE', /* required */
  FolderId: 'STRING_VALUE' /* required */
};
quicksight.describeFolder(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.

    • FolderId — (String)

      The folder 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:

      • Status — (Integer)

        The status. If succeeded, the status is SC_OK (200).

      • Folder — (map)

        Information about the folder.

        • FolderId — (String)

          The folder ID.

        • Arn — (String)

          The folder Amazon Resource Name (ARN).

        • Name — (String)

          A display name for the folder.

        • FolderType — (String)

          The type of the folder.

          Possible values include:
          • "SHARED"
        • FolderPath — (Array<String>)

          An array of ancestor folder ARN strings.

        • CreatedTime — (Date)

          The time that the folder was created.

        • LastUpdatedTime — (Date)

          The time that the folder was last updated.

      • RequestId — (String)

        The request ID.

Returns:

  • (AWS.Request) —

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

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

Describes permissions for a folder.

Service Reference:

Examples:

Calling the describeFolderPermissions operation

var params = {
  AwsAccountId: 'STRING_VALUE', /* required */
  FolderId: 'STRING_VALUE' /* required */
};
quicksight.describeFolderPermissions(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.

    • FolderId — (String)

      The folder 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:

      • Status — (Integer)

        The status. If succeeded, the status is SC_OK.

      • FolderId — (String)

        The folder ID.

      • Arn — (String)

        The Amazon Resource Name (ARN) for the folder.

      • Permissions — (Array<map>)

        Information about the permissions on the folder.

        • Principal — required — (String)

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

          • The ARN of an Amazon QuickSight user or group associated with a data source or dataset. (This is common.)

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

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

        • Actions — required — (Array<String>)

          The IAMaction to grant or revoke permissions on.

      • RequestId — (String)

        The request ID.

Returns:

  • (AWS.Request) —

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

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

Describes the folder resolved permissions. Permissions consists of both folder direct permissions and the inherited permissions from the ancestor folders.

Service Reference:

Examples:

Calling the describeFolderResolvedPermissions operation

var params = {
  AwsAccountId: 'STRING_VALUE', /* required */
  FolderId: 'STRING_VALUE' /* required */
};
quicksight.describeFolderResolvedPermissions(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.

    • FolderId — (String)

      The folder 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:

      • Status — (Integer)

        The status. If succeeded, the status is SC_OK

      • FolderId — (String)

        The folder ID.

      • Arn — (String)

        The Amazon Resource Name (ARN).

      • Permissions — (Array<map>)

        Information about the permissions on the dashboard.

        • Principal — required — (String)

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

          • The ARN of an Amazon QuickSight user or group associated with a data source or dataset. (This is common.)

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

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

        • Actions — required — (Array<String>)

          The IAMaction to grant or revoke permissions on.

      • RequestId — (String)

        The request ID.

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

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 Amazon Web Services account that the group is in. Currently, you use the ID for the Amazon Web Services 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 Amazon Web Services 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, as specified by the assignment name.

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 ID of the Amazon Web Services account that contains the assignment that you want to describe.

    • AssignmentName — (String)

      The name of the assignment, also called a rule.

    • 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 IAMpolicy assignment.

        • AwsAccountId — (String)

          The Amazon Web Services account ID.

        • AssignmentId — (String)

          Assignment ID.

        • AssignmentName — (String)

          Assignment name.

        • PolicyArn — (String)

          The Amazon Resource Name (ARN) for the IAMpolicy.

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

          Identities.

        • AssignmentStatus — (String)

          Assignment status.

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

        The Amazon Web Services 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 Amazon Web Services 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.

        • Arn — required — (String)

          The Amazon Resource Name (ARN) of the resource.

        • IngestionId — (String)

          Ingestion ID.

        • IngestionStatus — required — (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"
            • "REFRESH_SUPPRESSED_BY_EDIT"
            • "PERMISSION_NOT_FOUND"
            • "ELASTICSEARCH_CURSOR_NOT_ENABLED"
            • "CURSOR_NOT_ENABLED"
          • Message — (String)

            Error message.

        • RowInfo — (map)

          Information about rows for a data set SPICE ingestion.

          • RowsIngested — (Integer)

            The number of rows that were ingested.

          • RowsDropped — (Integer)

            The number of rows that were not ingested.

          • TotalRowsInDataset — (Integer)

            The total number of rows in the dataset.

        • QueueInfo — (map)

          Information about a queued dataset SPICE ingestion.

          • WaitingOnIngestion — required — (String)

            The ID of the queued ingestion.

          • QueuedIngestion — required — (String)

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

        • CreatedTime — required — (Date)

          The time that this ingestion started.

        • IngestionTimeInSeconds — (Integer)

          The time that this ingestion took, measured in seconds.

        • IngestionSizeInBytes — (Integer)

          The 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 Amazon Web Services 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.

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

Provides a summary and status of IP Rules.

Service Reference:

Examples:

Calling the describeIpRestriction operation

var params = {
  AwsAccountId: 'STRING_VALUE' /* required */
};
quicksight.describeIpRestriction(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)

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

      • AwsAccountId — (String)

        Your AWS account ID.

      • IpRestrictionRuleMap — (map<String>)

        Describes the IP rules with CIDR range and description.

      • Enabled — (Boolean)

        Whether or not IP rules are enabled.

      • RequestId — (String)

        The ID of the describe request.

      • Status — (Integer)

        The status of a set of IP restrictions. A successful request returns a 200 status code.

Returns:

  • (AWS.Request) —

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

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

Describes the current namespace.

Service Reference:

Examples:

Calling the describeNamespace operation

var params = {
  AwsAccountId: 'STRING_VALUE', /* required */
  Namespace: 'STRING_VALUE' /* required */
};
quicksight.describeNamespace(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 Amazon Web Services account that contains the Amazon QuickSight namespace that you want to describe.

    • Namespace — (String)

      The namespace that you want to describe.

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:

      • Namespace — (map)

        The information about the namespace that you're describing. The response includes the namespace ARN, name, Amazon Web Services Region, creation status, and identity store. DescribeNamespace also works for namespaces that are in the process of being created. For incomplete namespaces, this API operation lists the namespace error types and messages associated with the creation process.

        • Name — (String)

          The name of the error.

        • Arn — (String)

          The namespace ARN.

        • CapacityRegion — (String)

          The namespace Amazon Web Services Region.

        • CreationStatus — (String)

          The creation status of a namespace that is not yet completely created.

          Possible values include:
          • "CREATED"
          • "CREATING"
          • "DELETING"
          • "RETRYABLE_FAILURE"
          • "NON_RETRYABLE_FAILURE"
        • IdentityStore — (String)

          The identity store used for the namespace.

          Possible values include:
          • "QUICKSIGHT"
        • NamespaceError — (map)

          An error that occurred when the namespace was created.

          • Type — (String)

            The error type.

            Possible values include:
            • "PERMISSION_DENIED"
            • "INTERNAL_SERVICE_ERROR"
          • Message — (String)

            The message for the error.

      • RequestId — (String)

        The Amazon Web Services 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.

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)

      The ID of the Amazon Web Services account that contains the template that you're describing.

    • TemplateId — (String)

      The ID for the template.

    • VersionNumber — (Integer)

      (Optional) The number for the version to describe. If a VersionNumber parameter value isn't provided, the latest version of the template is described.

    • AliasName — (String)

      The alias of the template that you want to describe. If you name a specific alias, you describe the version that the alias points to. You can specify the latest version of the template by providing the keyword $LATEST in the AliasName parameter. The keyword $PUBLISHED doesn't apply to templates.

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 for the object you want to describe.

        • Arn — (String)

          The Amazon Resource Name (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 that this template version was created.

          • Errors — (Array<map>)

            Errors associated with this template version.

            • Type — (String)

              Type of error.

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

              Description of the error type.

          • VersionNumber — (Integer)

            The version number of the template version.

          • 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"
            • "DELETED"
          • DataSetConfigurations — (Array<map>)

            Schema of the dataset identified by the placeholder. Any dashboard created from this template should be bound to new datasets matching the same schema described through this API operation.

            • 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 schemas for column group columns.

                • Name — (String)

                  The name of the column group's column schema.

          • Description — (String)

            The description of the template.

          • SourceEntityArn — (String)

            The Amazon Resource Name (ARN) of an analysis or template that was used to create this template.

          • ThemeArn — (String)

            The ARN of the theme associated with this version of the template.

          • Sheets — (Array<map>)

            A list of the associated sheets with the unique identifier and name of each sheet.

            • SheetId — (String)

              The unique identifier associated with a sheet.

            • Name — (String)

              The name of a sheet. This name is displayed on the sheet's tab in the Amazon QuickSight console.

        • TemplateId — (String)

          The ID for the template. This is unique per Amazon Web Services Region for each Amazon Web Services account.

        • LastUpdatedTime — (Date)

          Time when this was last updated.

        • CreatedTime — (Date)

          Time when this was created.

      • Status — (Integer)

        The HTTP status of the request.

      • RequestId — (String)

        The Amazon Web Services request ID for this operation.

Returns:

  • (AWS.Request) —

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

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

Describes the template alias for a template.

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)

      The ID of the Amazon Web Services account that contains the template alias that you're describing.

    • TemplateId — (String)

      The ID for the template.

    • AliasName — (String)

      The name of the template alias that you want to describe. If you name a specific alias, you describe the version that the alias points to. You can specify the latest version of the template by providing the keyword $LATEST in the AliasName parameter. The keyword $PUBLISHED doesn't apply to templates.

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 Amazon Resource Name (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 Amazon Web Services 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.

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)

      The ID of the Amazon Web Services account that contains the template that you're 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 Amazon Resource Name (ARN) of the template.

      • Permissions — (Array<map>)

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

        • Principal — required — (String)

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

          • The ARN of an Amazon QuickSight user or group associated with a data source or dataset. (This is common.)

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

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

        • Actions — required — (Array<String>)

          The IAMaction to grant or revoke permissions on.

      • RequestId — (String)

        The Amazon Web Services 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.

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

Describes a theme.

Service Reference:

Examples:

Calling the describeTheme operation

var params = {
  AwsAccountId: 'STRING_VALUE', /* required */
  ThemeId: 'STRING_VALUE', /* required */
  AliasName: 'STRING_VALUE',
  VersionNumber: 'NUMBER_VALUE'
};
quicksight.describeTheme(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 of the Amazon Web Services account that contains the theme that you're describing.

    • ThemeId — (String)

      The ID for the theme.

    • VersionNumber — (Integer)

      The version number for the version to describe. If a VersionNumber parameter value isn't provided, the latest version of the theme is described.

    • AliasName — (String)

      The alias of the theme that you want to describe. If you name a specific alias, you describe the version that the alias points to. You can specify the latest version of the theme by providing the keyword $LATEST in the AliasName parameter. The keyword $PUBLISHED doesn't apply to themes.

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:

      • Theme — (map)

        The information about the theme that you are describing.

        • Arn — (String)

          The Amazon Resource Name (ARN) of the theme.

        • Name — (String)

          The name that the user gives to the theme.

        • ThemeId — (String)

          The identifier that the user gives to the theme.

        • Version — (map)

          A version of a theme.

          • VersionNumber — (Integer)

            The version number of the theme.

          • Arn — (String)

            The Amazon Resource Name (ARN) of the resource.

          • Description — (String)

            The description of the theme.

          • BaseThemeId — (String)

            The Amazon QuickSight-defined ID of the theme that a custom theme inherits from. All themes initially inherit from a default Amazon QuickSight theme.

          • CreatedTime — (Date)

            The date and time that this theme version was created.

          • Configuration — (map)

            The theme configuration, which contains all the theme display properties.

            • DataColorPalette — (map)

              Color properties that apply to chart data colors.

              • Colors — (Array<String>)

                The hexadecimal codes for the colors.

              • MinMaxGradient — (Array<String>)

                The minimum and maximum hexadecimal codes that describe a color gradient.

              • EmptyFillColor — (String)

                The hexadecimal code of a color that applies to charts where a lack of data is highlighted.

            • UIColorPalette — (map)

              Color properties that apply to the UI and to charts, excluding the colors that apply to data.

              • PrimaryForeground — (String)

                The color of text and other foreground elements that appear over the primary background regions, such as grid lines, borders, table banding, icons, and so on.

              • PrimaryBackground — (String)

                The background color that applies to visuals and other high emphasis UI.

              • SecondaryForeground — (String)

                The foreground color that applies to any sheet title, sheet control text, or UI that appears over the secondary background.

              • SecondaryBackground — (String)

                The background color that applies to the sheet background and sheet controls.

              • Accent — (String)

                This color is that applies to selected states and buttons.

              • AccentForeground — (String)

                The foreground color that applies to any text or other elements that appear over the accent color.

              • Danger — (String)

                The color that applies to error messages.

              • DangerForeground — (String)

                The foreground color that applies to any text or other elements that appear over the error color.

              • Warning — (String)

                This color that applies to warning and informational messages.

              • WarningForeground — (String)

                The foreground color that applies to any text or other elements that appear over the warning color.

              • Success — (String)

                The color that applies to success messages, for example the check mark for a successful download.

              • SuccessForeground — (String)

                The foreground color that applies to any text or other elements that appear over the success color.

              • Dimension — (String)

                The color that applies to the names of fields that are identified as dimensions.

              • DimensionForeground — (String)

                The foreground color that applies to any text or other elements that appear over the dimension color.

              • Measure — (String)

                The color that applies to the names of fields that are identified as measures.

              • MeasureForeground — (String)

                The foreground color that applies to any text or other elements that appear over the measure color.

            • Sheet — (map)

              Display options related to sheets.

              • Tile — (map)

                The display options for tiles.

                • Border — (map)

                  The border around a tile.

                  • Show — (Boolean)

                    The option to enable display of borders for visuals.

              • TileLayout — (map)

                The layout options for tiles.

                • Gutter — (map)

                  The gutter settings that apply between tiles.

                  • Show — (Boolean)

                    This Boolean value controls whether to display a gutter space between sheet tiles.

                • Margin — (map)

                  The margin settings that apply around the outside edge of sheets.

                  • Show — (Boolean)

                    This Boolean value controls whether to display sheet margins.

          • Errors — (Array<map>)

            Errors associated with the theme.

            • Type — (String)

              The type of error.

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

              The error message.

          • Status — (String)

            The status of the theme version.

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

          The date and time that the theme was created.

        • LastUpdatedTime — (Date)

          The date and time that the theme was last updated.

        • Type — (String)

          The type of theme, based on how it was created. Valid values include: QUICKSIGHT and CUSTOM.

          Possible values include:
          • "QUICKSIGHT"
          • "CUSTOM"
          • "ALL"
      • Status — (Integer)

        The HTTP status of the request.

      • RequestId — (String)

        The Amazon Web Services request ID for this operation.

Returns:

  • (AWS.Request) —

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

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

Describes the alias for a theme.

Service Reference:

Examples:

Calling the describeThemeAlias operation

var params = {
  AliasName: 'STRING_VALUE', /* required */
  AwsAccountId: 'STRING_VALUE', /* required */
  ThemeId: 'STRING_VALUE' /* required */
};
quicksight.describeThemeAlias(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 of the Amazon Web Services account that contains the theme alias that you're describing.

    • ThemeId — (String)

      The ID for the theme.

    • AliasName — (String)

      The name of the theme alias that you want to describe.

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:

      • ThemeAlias — (map)

        Information about the theme alias.

        • Arn — (String)

          The Amazon Resource Name (ARN) of the theme alias.

        • AliasName — (String)

          The display name of the theme alias.

        • ThemeVersionNumber — (Integer)

          The version number of the theme alias.

      • Status — (Integer)

        The HTTP status of the request.

      • RequestId — (String)

        The Amazon Web Services request ID for this operation.

Returns:

  • (AWS.Request) —

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

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

Describes the read and write permissions for a theme.

Service Reference:

Examples:

Calling the describeThemePermissions operation

var params = {
  AwsAccountId: 'STRING_VALUE', /* required */
  ThemeId: 'STRING_VALUE' /* required */
};
quicksight.describeThemePermissions(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 of the Amazon Web Services account that contains the theme that you're describing.

    • ThemeId — (String)

      The ID for the theme that you want to describe permissions 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:

      • ThemeId — (String)

        The ID for the theme.

      • ThemeArn — (String)

        The Amazon Resource Name (ARN) of the theme.

      • Permissions — (Array<map>)

        A list of resource permissions set on the theme.

        • Principal — required — (String)

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

          • The ARN of an Amazon QuickSight user or group associated with a data source or dataset. (This is common.)

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

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

        • Actions — required — (Array<String>)

          The IAMaction to grant or revoke permissions on.

      • RequestId — (String)

        The Amazon Web Services 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.

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 Amazon Web Services account that the user is in. Currently, you use the ID for the Amazon Web Services 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 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)

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

        • PrincipalId — (String)

          The principal ID of the user.

        • CustomPermissionsName — (String)

          The custom permissions profile associated with this user.

        • ExternalLoginFederationProviderType — (String)

          The type of supported external login provider that provides identity to let the user federate into Amazon QuickSight with an associated IAMrole. The type can be one of the following.

          • COGNITO: Amazon Cognito. The provider URL is cognito-identity.amazonaws.com.

          • CUSTOM_OIDC: Custom OpenID Connect (OIDC) provider.

        • ExternalLoginFederationProviderUrl — (String)

          The URL of the external login provider.

        • ExternalLoginId — (String)

          The identity ID for the user in the external login provider.

      • RequestId — (String)

        The Amazon Web Services 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.

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

Generates an embed URL that you can use to embed an Amazon QuickSight dashboard in your website, without having to register any reader users. Before you use this action, make sure that you have configured the dashboards and permissions.

The following rules apply to the generated URL:

  • It contains a temporary bearer token. It is valid for 5 minutes after it is generated. Once redeemed within this period, it cannot be re-used again.

  • The URL validity period should not be confused with the actual session lifetime that can be customized using the SessionLifetimeInMinutes parameter.

    The resulting user session is valid for 15 minutes (default) to 10 hours (maximum).

  • You are charged only when the URL is used or there is interaction with Amazon QuickSight.

For more information, see Embedded Analytics in the Amazon QuickSight User Guide.

For more information about the high-level steps for embedding and for an interactive demo of the ways you can customize embedding, visit the Amazon QuickSight Developer Portal.

Service Reference:

Examples:

Calling the generateEmbedUrlForAnonymousUser operation

var params = {
  AuthorizedResourceArns: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  AwsAccountId: 'STRING_VALUE', /* required */
  ExperienceConfiguration: { /* required */
    Dashboard: {
      InitialDashboardId: 'STRING_VALUE' /* required */
    }
  },
  Namespace: 'STRING_VALUE', /* required */
  SessionLifetimeInMinutes: 'NUMBER_VALUE',
  SessionTags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
quicksight.generateEmbedUrlForAnonymousUser(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 Amazon Web Services account that contains the dashboard that you're embedding.

    • SessionLifetimeInMinutes — (Integer)

      How many minutes the session is valid. The session lifetime must be in [15-600] minutes range.

    • Namespace — (String)

      The Amazon QuickSight namespace that the anonymous user virtually belongs to. If you are not using an Amazon QuickSight custom namespace, set this to default.

    • SessionTags — (Array<map>)

      The session tags used for row-level security. Before you use this parameter, make sure that you have configured the relevant datasets using the DataSet$RowLevelPermissionTagConfiguration parameter so that session tags can be used to provide row-level security.

      These are not the tags used for the Amazon Web Services resource tagging feature. For more information, see Using Row-Level Security (RLS) with Tags.

      • Key — required — (String)

        The key for the tag.

      • Value — required — (String)

        The value that you want to assign the tag.

    • AuthorizedResourceArns — (Array<String>)

      The Amazon Resource Names for the Amazon QuickSight resources that the user is authorized to access during the lifetime of the session. If you choose Dashboard embedding experience, pass the list of dashboard ARNs in the account that you want the user to be able to view.

    • ExperienceConfiguration — (map)

      The configuration of the experience you are embedding.

      • Dashboard — (map)

        The type of embedding experience. In this case, an Amazon QuickSight dashboard.

        • InitialDashboardId — required — (String)

          The dashboard ID for the dashboard that you want the user to see first. This ID is included in the output URL. When the URL in response is accessed, Amazon QuickSight renders this dashboard.

          The Amazon Resource Name (ARN) of this dashboard must be included in the AuthorizedResourceArns parameter. Otherwise, the request will fail with InvalidParameterValueException.

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)

        The embed URL for the dashboard.

      • Status — (Integer)

        The HTTP status of the request.

      • RequestId — (String)

        The Amazon Web Services request ID for this operation.

Returns:

  • (AWS.Request) —

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

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

Generates an embed URL that you can use to embed an Amazon QuickSight experience in your website. This action can be used for any type of user registered in an Amazon QuickSight account. Before you use this action, make sure that you have configured the relevant Amazon QuickSight resource and permissions.

The following rules apply to the generated URL:

  • It contains a temporary bearer token. It is valid for 5 minutes after it is generated. Once redeemed within this period, it cannot be re-used again.

  • The URL validity period should not be confused with the actual session lifetime that can be customized using the SessionLifetimeInMinutes parameter.

    The resulting user session is valid for 15 minutes (default) to 10 hours (maximum).

  • You are charged only when the URL is used or there is interaction with Amazon QuickSight.

For more information, see Embedded Analytics in the Amazon QuickSight User Guide.

For more information about the high-level steps for embedding and for an interactive demo of the ways you can customize embedding, visit the Amazon QuickSight Developer Portal.

Service Reference:

Examples:

Calling the generateEmbedUrlForRegisteredUser operation

var params = {
  AwsAccountId: 'STRING_VALUE', /* required */
  ExperienceConfiguration: { /* required */
    Dashboard: {
      InitialDashboardId: 'STRING_VALUE' /* required */
    },
    QSearchBar: {
      InitialTopicId: 'STRING_VALUE'
    },
    QuickSightConsole: {
      InitialPath: 'STRING_VALUE'
    }
  },
  UserArn: 'STRING_VALUE', /* required */
  SessionLifetimeInMinutes: 'NUMBER_VALUE'
};
quicksight.generateEmbedUrlForRegisteredUser(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 Amazon Web Services account that contains the dashboard that you're embedding.

    • SessionLifetimeInMinutes — (Integer)

      How many minutes the session is valid. The session lifetime must be in [15-600] minutes range.

    • UserArn — (String)

      The Amazon Resource Name for the registered user.

    • ExperienceConfiguration — (map)

      The experience you are embedding. For registered users, you can embed Amazon QuickSight dashboards, the entire Amazon QuickSight console, or the Amazon QuickSight Q search bar.

      • Dashboard — (map)

        The configuration details for providing a dashboard embedding experience.

        • InitialDashboardId — required — (String)

          The dashboard ID for the dashboard that you want the user to see first. This ID is included in the output URL. When the URL in response is accessed, Amazon QuickSight renders this dashboard if the user has permissions to view it.

          If the user does not have permission to view this dashboard, they see a permissions error message.

      • QuickSightConsole — (map)

        The configuration details for providing an Amazon QuickSight console embedding experience. This can be used along with custom permissions to restrict access to certain features. For more information, see Customizing Access to the Amazon QuickSight Console in the Amazon QuickSight User Guide.

        Use GenerateEmbedUrlForRegisteredUser where you want to provide an authoring portal that allows users to create data sources, datasets, analyses, and dashboards. The users who accesses an embedded Amazon QuickSight console needs to belong to the author or admin security cohort. If you want to restrict permissions to some of these features, add a custom permissions profile to the user with the UpdateUser API operation. Use RegisterUser API operation to add a new user with a custom permission profile attached. For more information, see the following sections in the Amazon QuickSight User Guide:

        For more information about the high-level steps for embedding and for an interactive demo of the ways you can customize embedding, visit the Amazon QuickSight Developer Portal.

        • InitialPath — (String)

          The initial URL path for the Amazon QuickSight console. InitialPath is required.

          The entry point URL is constrained to the following paths:

          • /start

          • /start/analyses

          • /start/dashboards

          • /start/favorites

          • /dashboards/DashboardId. DashboardId is the actual ID key from the Amazon QuickSight console URL of the dashboard.

          • /analyses/AnalysisId. AnalysisId is the actual ID key from the Amazon QuickSight console URL of the analysis.

      • QSearchBar — (map)

        The configuration details for embedding the Q search bar.

        For more information about embedding the Q search bar, see Embedding Overview.

        • InitialTopicId — (String)

          The ID of the Q topic that you want to make the starting topic in the Q search bar. You can find a topic ID by navigating to the Topics pane in the Amazon QuickSight application and opening a topic. The ID is in the URL for the topic that you open.

          If you don't specify an initial topic, a list of all shared topics is shown in the Q bar for your readers. When you select an initial topic, you can specify whether or not readers are allowed to select other topics from the available ones in the list.

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)

        The embed URL for the Amazon QuickSight dashboard, console, or Q search bar.

      • Status — (Integer)

        The HTTP status of the request.

      • RequestId — (String)

        The Amazon Web Services request ID for this operation.

Returns:

  • (AWS.Request) —

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

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

Generates a session URL and authorization code that you can use to embed an Amazon Amazon QuickSight read-only dashboard in your web server code. Before you use this command, make sure that you have configured the dashboards and permissions.

Currently, you can use GetDashboardEmbedURL only from the server, not from the user's browser. The following rules apply to the combination of URL and authorization code:

  • They must be used together.

  • They can be used one time only.

  • They are valid for 5 minutes after you run this command.

  • The resulting user session is valid for 10 hours.

For more information, see Embedding Analytics Using GetDashboardEmbedUrl in the Amazon QuickSight User Guide.

For more information about the high-level steps for embedding and for an interactive demo of the ways you can customize embedding, visit the Amazon QuickSight Developer Portal.

Service Reference:

Examples:

Calling the getDashboardEmbedUrl operation

var params = {
  AwsAccountId: 'STRING_VALUE', /* required */
  DashboardId: 'STRING_VALUE', /* required */
  IdentityType: IAM | QUICKSIGHT | ANONYMOUS, /* required */
  AdditionalDashboardIds: [
    'STRING_VALUE',
    /* more items */
  ],
  Namespace: 'STRING_VALUE',
  ResetDisabled: true || false,
  SessionLifetimeInMinutes: 'NUMBER_VALUE',
  StatePersistenceEnabled: true || false,
  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)

      The ID for the Amazon Web Services account that contains the dashboard that you're embedding.

    • DashboardId — (String)

      The ID for the dashboard, also added to the Identity and Access Management (IAM) policy.

    • IdentityType — (String)

      The authentication method that the user uses to sign in.

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

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

    • UndoRedoDisabled — (Boolean)

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

    • ResetDisabled — (Boolean)

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

    • StatePersistenceEnabled — (Boolean)

      Adds persistence of state for the user session in an embedded dashboard. Persistence applies to the sheet and the parameter settings. These are control settings that the dashboard subscriber (Amazon QuickSight reader) chooses while viewing the dashboard. If this is set to TRUE, the settings are the same when the subscriber reopens the same dashboard URL. The state is stored in Amazon QuickSight, not in a browser cookie. If this is set to FALSE, the state of the user session is not persisted. The default is FALSE.

    • UserArn — (String)

      The Amazon QuickSight user's Amazon Resource Name (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 nonfederated users

      • IAMusers and IAMrole-based sessions authenticated through Federated Single Sign-On using SAML, OpenID Connect, or IAMfederation.

      Omit this parameter for users in the third group – IAMusers and IAM role-based sessions.

    • Namespace — (String)

      The Amazon QuickSight namespace that contains the dashboard IDs in this request. If you're not using a custom namespace, set Namespace = default.

    • AdditionalDashboardIds — (Array<String>)

      A list of one or more dashboard IDs that you want to add to a session that includes anonymous users. The IdentityType parameter must be set to ANONYMOUS for this to work, because other identity types authenticate as Amazon QuickSight or IAMusers. For example, if you set "--dashboard-id dash_id1 --dashboard-id dash_id2 dash_id3 identity-type ANONYMOUS", the session can access all three dashboards.

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)

        A single-use URL that you can put into your server-side webpage to embed your dashboard. This URL is valid for 5 minutes. The API operation provides the URL with an auth_code value that enables one (and only one) sign-on to a user session that is valid for 10 hours.

      • Status — (Integer)

        The HTTP status of the request.

      • RequestId — (String)

        The Amazon Web Services request ID for this operation.

Returns:

  • (AWS.Request) —

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

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

Generates a session URL and authorization code that you can use to embed the Amazon Amazon QuickSight console in your web server code. Use GetSessionEmbedUrl where you want to provide an authoring portal that allows users to create data sources, datasets, analyses, and dashboards. The users who access an embedded Amazon QuickSight console need belong to the author or admin security cohort. If you want to restrict permissions to some of these features, add a custom permissions profile to the user with the UpdateUser API operation. Use RegisterUser API operation to add a new user with a custom permission profile attached. For more information, see the following sections in the Amazon QuickSight User Guide:

Service Reference:

Examples:

Calling the getSessionEmbedUrl operation

var params = {
  AwsAccountId: 'STRING_VALUE', /* required */
  EntryPoint: 'STRING_VALUE',
  SessionLifetimeInMinutes: 'NUMBER_VALUE',
  UserArn: 'STRING_VALUE'
};
quicksight.getSessionEmbedUrl(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 Amazon Web Services account associated with your Amazon QuickSight subscription.

    • EntryPoint — (String)

      The URL you use to access the embedded session. The entry point URL is constrained to the following paths:

      • /start

      • /start/analyses

      • /start/dashboards

      • /start/favorites

      • /dashboards/DashboardId - where DashboardId is the actual ID key from the Amazon QuickSight console URL of the dashboard

      • /analyses/AnalysisId - where AnalysisId is the actual ID key from the Amazon QuickSight console URL of the analysis

    • SessionLifetimeInMinutes — (Integer)

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

    • UserArn — (String)

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

      1. Active Directory (AD) users or group members

      2. Invited nonfederated users

      3. Identity and Access Management (IAM) users and IAM role-based sessions authenticated through Federated Single Sign-On using SAML, OpenID Connect, or IAM federation

      Omit this parameter for users in the third group, IAM users and IAM role-based sessions.

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)

        A single-use URL that you can put into your server-side web page to embed your Amazon QuickSight session. This URL is valid for 5 minutes. The API operation provides the URL with an auth_code value that enables one (and only one) sign-on to a user session that is valid for 10 hours.

      • Status — (Integer)

        The HTTP status of the request.

      • RequestId — (String)

        The Amazon Web Services request ID for this operation.

Returns:

  • (AWS.Request) —

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

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

Lists Amazon QuickSight analyses that exist in the specified Amazon Web Services account.

Service Reference:

Examples:

Calling the listAnalyses operation

var params = {
  AwsAccountId: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
quicksight.listAnalyses(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 of the Amazon Web Services account that contains the analyses.

    • NextToken — (String)

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

    • MaxResults — (Integer)

      The maximum number of results to return.

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:

      • AnalysisSummaryList — (Array<map>)

        Metadata describing each of the analyses that are listed.

        • Arn — (String)

          The Amazon Resource Name (ARN) for the analysis.

        • AnalysisId — (String)

          The ID of the analysis. This ID displays in the URL.

        • Name — (String)

          The name of the analysis. This name is displayed in the Amazon QuickSight console.

        • Status — (String)

          The last known status for the analysis.

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

          The time that the analysis was created.

        • LastUpdatedTime — (Date)

          The time that the analysis was last updated.

      • NextToken — (String)

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

      • Status — (Integer)

        The HTTP status of the request.

      • RequestId — (String)

        The Amazon Web Services 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 an Amazon Web Services account.

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)

      The ID of the Amazon Web Services account that contains the dashboards that you're 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 in your Amazon Web Services account. This structure 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 dashboard.

        • CreatedTime — (Date)

          The time that this dashboard was created.

        • LastUpdatedTime — (Date)

          The last time that this dashboard was updated.

        • PublishedVersionNumber — (Integer)

          Published version number.

        • LastPublishedTime — (Date)

          The last time that this dashboard 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 Amazon Web Services 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 Amazon QuickSight subscription.

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)

      The ID of the Amazon Web Services account that contains the dashboard that you're listing versions for.

    • 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 that this dashboard version 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"
          • "DELETED"
        • 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 Amazon Web Services 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 the current Amazon Web Services account in an Amazon Web Services Region.

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

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 Amazon Web Services 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 that this dataset was created.

        • LastUpdatedTime — (Date)

          The last time that this dataset was updated.

        • ImportMode — (String)

          A value that indicates whether you want to import the data into SPICE.

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

          The row-level security configuration for the dataset.

          • Namespace — (String)

            The namespace associated with the dataset that contains permissions for RLS.

          • Arn — required — (String)

            The Amazon Resource Name (ARN) of the dataset that contains permissions for RLS.

          • PermissionPolicy — required — (String)

            The type of permissions to use when interpreting the permissions for RLS. DENY_ACCESS is included for backward compatibility only.

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

            The user or group rules associated with the dataset that contains permissions for RLS.

            By default, FormatVersion is VERSION_1. When FormatVersion is VERSION_1, UserName and GroupName are required. When FormatVersion is VERSION_2, UserARN and GroupARN are required, and Namespace must not exist.

            Possible values include:
            • "VERSION_1"
            • "VERSION_2"
          • Status — (String)

            The status of the row-level security permission dataset. If enabled, the status is ENABLED. If disabled, the status is DISABLED.

            Possible values include:
            • "ENABLED"
            • "DISABLED"
        • RowLevelPermissionTagConfigurationApplied — (Boolean)

          Whether or not the row level permission tags are applied.

        • ColumnLevelPermissionRulesApplied — (Boolean)

          A value that indicates if the dataset has column level permission configured.

      • NextToken — (String)

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

      • RequestId — (String)

        The Amazon Web Services 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 Amazon Web Services Region that belong to this Amazon Web Services account.

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 Amazon Web Services 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 ID is unique per Amazon Web Services Region for each Amazon Web Services account.

        • Name — (String)

          A display name for the data source.

        • Type — (String)

          The type of the data source. This type 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"
          • "ORACLE"
          • "POSTGRESQL"
          • "PRESTO"
          • "REDSHIFT"
          • "S3"
          • "SALESFORCE"
          • "SERVICENOW"
          • "SNOWFLAKE"
          • "SPARK"
          • "SQLSERVER"
          • "TERADATA"
          • "TWITTER"
          • "TIMESTREAM"
          • "AMAZON_OPENSEARCH"
        • 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"
          • "DELETED"
        • CreatedTime — (Date)

          The time that this data source was created.

        • LastUpdatedTime — (Date)

          The last time that this data source was updated.

        • DataSourceParameters — (map)

          The parameters that Amazon QuickSight uses to connect to your underlying source. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.

          • AmazonElasticsearchParameters — (map)

            The parameters for OpenSearch.

            • Domain — required — (String)

              The OpenSearch domain.

          • AthenaParameters — (map)

            The parameters for Amazon Athena.

            • WorkGroup — (String)

              The workgroup that Amazon Athena uses.

          • AuroraParameters — (map)

            The parameters for Amazon Aurora MySQL.

            • Host — required — (String)

              Host.

            • Port — required — (Integer)

              Port.

            • Database — required — (String)

              Database.

          • AuroraPostgreSqlParameters — (map)

            The parameters for Amazon Aurora.

            • Host — required — (String)

              The Amazon Aurora PostgreSQL-Compatible host to connect to.

            • Port — required — (Integer)

              The port that Amazon Aurora PostgreSQL is listening on.

            • Database — required — (String)

              The Amazon Aurora PostgreSQL database to connect to.

          • AwsIotAnalyticsParameters — (map)

            The parameters for IoT Analytics.

            • DataSetName — required — (String)

              Dataset name.

          • JiraParameters — (map)

            The parameters for Jira.

            • SiteBaseUrl — required — (String)

              The base URL of the Jira site.

          • MariaDbParameters — (map)

            The parameters for MariaDB.

            • Host — required — (String)

              Host.

            • Port — required — (Integer)

              Port.

            • Database — required — (String)

              Database.

          • MySqlParameters — (map)

            The parameters for MySQL.

            • Host — required — (String)

              Host.

            • Port — required — (Integer)

              Port.

            • Database — required — (String)

              Database.

          • OracleParameters — (map)

            The parameters for Oracle.

            • Host — required — (String)

              An Oracle host.

            • Port — required — (Integer)

              Port.

            • Database — required — (String)

              Database.

          • PostgreSqlParameters — (map)

            The parameters for PostgreSQL.

            • Host — required — (String)

              Host.

            • Port — required — (Integer)

              Port.

            • Database — required — (String)

              Database.

          • PrestoParameters — (map)

            The parameters for Presto.

            • Host — required — (String)

              Host.

            • Port — required — (Integer)

              Port.

            • Catalog — required — (String)

              Catalog.

          • RdsParameters — (map)

            The parameters for Amazon RDS.

            • InstanceId — required — (String)

              Instance ID.

            • Database — required — (String)

              Database.

          • RedshiftParameters — (map)

            The parameters for Amazon Redshift.

            • Host — (String)

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

            • Port — (Integer)

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

            • Database — required — (String)

              Database.

            • ClusterId — (String)

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

          • S3Parameters — (map)

            The parameters for S3.

            • ManifestFileLocation — required — (map)

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

              • Bucket — required — (String)

                Amazon S3 bucket.

              • Key — required — (String)

                Amazon S3 key that identifies an object.

          • ServiceNowParameters — (map)

            The parameters for ServiceNow.

            • SiteBaseUrl — required — (String)

              URL of the base site.

          • SnowflakeParameters — (map)

            The parameters for Snowflake.

            • Host — required — (String)

              Host.

            • Database — required — (String)

              Database.

            • Warehouse — required — (String)

              Warehouse.

          • SparkParameters — (map)

            The parameters for Spark.

            • Host — required — (String)

              Host.

            • Port — required — (Integer)

              Port.

          • SqlServerParameters — (map)

            The parameters for SQL Server.

            • Host — required — (String)

              Host.

            • Port — required — (Integer)

              Port.

            • Database — required — (String)

              Database.

          • TeradataParameters — (map)

            The parameters for Teradata.

            • Host — required — (String)

              Host.

            • Port — required — (Integer)

              Port.

            • Database — required — (String)

              Database.

          • TwitterParameters — (map)

            The parameters for Twitter.

            • Query — required — (String)

              Twitter query string.

            • MaxRows — required — (Integer)

              Maximum number of rows to query Twitter.

          • AmazonOpenSearchParameters — (map)
            • Domain — required — (String)
        • AlternateDataSourceParameters — (Array<map>)

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

          • AmazonElasticsearchParameters — (map)

            The parameters for OpenSearch.

            • Domain — required — (String)

              The OpenSearch domain.

          • AthenaParameters — (map)

            The parameters for Amazon Athena.

            • WorkGroup — (String)

              The workgroup that Amazon Athena uses.

          • AuroraParameters — (map)

            The parameters for Amazon Aurora MySQL.

            • Host — required — (String)

              Host.

            • Port — required — (Integer)

              Port.

            • Database — required — (String)

              Database.

          • AuroraPostgreSqlParameters — (map)

            The parameters for Amazon Aurora.

            • Host — required — (String)

              The Amazon Aurora PostgreSQL-Compatible host to connect to.

            • Port — required — (Integer)

              The port that Amazon Aurora PostgreSQL is listening on.

            • Database — required — (String)

              The Amazon Aurora PostgreSQL database to connect to.

          • AwsIotAnalyticsParameters — (map)

            The parameters for IoT Analytics.

            • DataSetName — required — (String)

              Dataset name.

          • JiraParameters — (map)

            The parameters for Jira.

            • SiteBaseUrl — required — (String)

              The base URL of the Jira site.

          • MariaDbParameters — (map)

            The parameters for MariaDB.

            • Host — required — (String)

              Host.

            • Port — required — (Integer)

              Port.

            • Database — required — (String)

              Database.

          • MySqlParameters — (map)

            The parameters for MySQL.

            • Host — required — (String)

              Host.

            • Port — required — (Integer)

              Port.

            • Database — required — (String)

              Database.

          • OracleParameters — (map)

            The parameters for Oracle.

            • Host — required — (String)

              An Oracle host.

            • Port — required — (Integer)

              Port.

            • Database — required — (String)

              Database.

          • PostgreSqlParameters — (map)

            The parameters for PostgreSQL.

            • Host — required — (String)

              Host.

            • Port — required — (Integer)

              Port.

            • Database — required — (String)

              Database.

          • PrestoParameters — (map)

            The parameters for Presto.

            • Host — required — (String)

              Host.

            • Port — required — (Integer)

              Port.

            • Catalog — required — (String)

              Catalog.

          • RdsParameters — (map)

            The parameters for Amazon RDS.

            • InstanceId — required — (String)

              Instance ID.

            • Database — required — (String)

              Database.

          • RedshiftParameters — (map)

            The parameters for Amazon Redshift.

            • Host — (String)

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

            • Port — (Integer)

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

            • Database — required — (String)

              Database.

            • ClusterId — (String)

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

          • S3Parameters — (map)

            The parameters for S3.

            • ManifestFileLocation — required — (map)

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

              • Bucket — required — (String)

                Amazon S3 bucket.

              • Key — required — (String)

                Amazon S3 key that identifies an object.

          • ServiceNowParameters — (map)

            The parameters for ServiceNow.

            • SiteBaseUrl — required — (String)

              URL of the base site.

          • SnowflakeParameters — (map)

            The parameters for Snowflake.

            • Host — required — (String)

              Host.

            • Database — required — (String)

              Database.

            • Warehouse — required — (String)

              Warehouse.

          • SparkParameters — (map)

            The parameters for Spark.

            • Host — required — (String)

              Host.

            • Port — required — (Integer)

              Port.

          • SqlServerParameters — (map)

            The parameters for SQL Server.

            • Host — required — (String)

              Host.

            • Port — required — (Integer)

              Port.

            • Database — required — (String)

              Database.

          • TeradataParameters — (map)

            The parameters for Teradata.

            • Host — required — (String)

              Host.

            • Port — required — (Integer)

              Port.

            • Database — required — (String)

              Database.

          • TwitterParameters — (map)

            The parameters for Twitter.

            • Query — required — (String)

              Twitter query string.

            • MaxRows — required — (Integer)

              Maximum number of rows to query Twitter.

          • AmazonOpenSearchParameters — (map)
            • Domain — required — (String)
        • VpcConnectionProperties — (map)

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

          • VpcConnectionArn — required — (String)

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

        • SslProperties — (map)

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

          • DisableSsl — (Boolean)

            A Boolean option to control whether SSL should be disabled.

        • ErrorInfo — (map)

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

          • Type — (String)

            Error type.

            Possible values include:
            • "ACCESS_DENIED"
            • "COPY_SOURCE_NOT_FOUND"
            • "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 Amazon Web Services 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.

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

List all assets (DASHBOARD, ANALYSIS, and DATASET) in a folder.

Service Reference:

Examples:

Calling the listFolderMembers operation

var params = {
  AwsAccountId: 'STRING_VALUE', /* required */
  FolderId: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
quicksight.listFolderMembers(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.

    • FolderId — (String)

      The folder 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:

      • Status — (Integer)

        The status. If succeeded, the status is SC_OK

      • FolderMemberList — (Array<map>)

        A structure that contains all of the folder members (dashboards, analyses, and datasets) in the folder.

        • MemberId — (String)

          The ID of the member.

        • MemberArn — (String)

          The Amazon Resource Name (ARN) of the member.

      • NextToken — (String)

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

      • RequestId — (String)

        The request ID.

Returns:

  • (AWS.Request) —

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

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

Lists all folders in an account.

Service Reference:

Examples:

Calling the listFolders operation

var params = {
  AwsAccountId: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
quicksight.listFolders(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:

      • Status — (Integer)

        The status. If succeeded, the status is SC_OK

      • FolderSummaryList — (Array<map>)

        A structure that contains all of the folders in your AWS account. This structure provides basic information about the folders.

        • Arn — (String)

          The Amazon Resource Name (ARN).

        • FolderId — (String)

          The folder ID.

        • Name — (String)

          The display name of the folder.

        • FolderType — (String)

          The type of folder.

          Possible values include:
          • "SHARED"
        • CreatedTime — (Date)

          The time that the folder was created.

        • LastUpdatedTime — (Date)

          The time that the folder was last updated.

      • NextToken — (String)

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

      • RequestId — (String)

        The request ID.

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.

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 Amazon Web Services account that the group is in. Currently, you use the ID for the Amazon Web Services 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 Amazon Web Services 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.

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 Amazon Web Services account that the group is in. Currently, you use the ID for the Amazon Web Services 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 Amazon Web Services 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 IAMpolicy assignments in the current Amazon QuickSight account.

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 ID of the Amazon Web Services account that contains these IAMpolicy assignments.

    • AssignmentStatus — (String)

      The status of the assignments.

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

      The namespace for the assignments.

    • 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 IAMpolicy 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 Amazon Web Services 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 IAMpolicy assignments, including the Amazon Resource Names (ARNs) for the IAM policies assigned to the specified user and group or groups that the user belongs to.

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 ID of the Amazon Web Services account that contains the assignments.

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

        The active assignments for this user.

        • AssignmentName — (String)

          A name for the IAMpolicy assignment.

        • PolicyArn — (String)

          The Amazon Resource Name (ARN) of the resource.

      • RequestId — (String)

        The Amazon Web Services 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 Amazon Web Services 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.

        • Arn — required — (String)

          The Amazon Resource Name (ARN) of the resource.

        • IngestionId — (String)

          Ingestion ID.

        • IngestionStatus — required — (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"
            • "REFRESH_SUPPRESSED_BY_EDIT"
            • "PERMISSION_NOT_FOUND"
            • "ELASTICSEARCH_CURSOR_NOT_ENABLED"
            • "CURSOR_NOT_ENABLED"
          • Message — (String)

            Error message.

        • RowInfo — (map)

          Information about rows for a data set SPICE ingestion.

          • RowsIngested — (Integer)

            The number of rows that were ingested.

          • RowsDropped — (Integer)

            The number of rows that were not ingested.

          • TotalRowsInDataset — (Integer)

            The total number of rows in the dataset.

        • QueueInfo — (map)

          Information about a queued dataset SPICE ingestion.

          • WaitingOnIngestion — required — (String)

            The ID of the queued ingestion.

          • QueuedIngestion — required — (String)

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

        • CreatedTime — required — (Date)

          The time that this ingestion started.

        • IngestionTimeInSeconds — (Integer)

          The time that this ingestion took, measured in seconds.

        • IngestionSizeInBytes — (Integer)

          The 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 Amazon Web Services 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.

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

Lists the namespaces for the specified Amazon Web Services account.

Service Reference:

Examples:

Calling the listNamespaces operation

var params = {
  AwsAccountId: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
quicksight.listNamespaces(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 Amazon Web Services account that contains the Amazon QuickSight namespaces that you want to list.

    • NextToken — (String)

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

    • MaxResults — (Integer)

      The maximum number of results to return.

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:

      • Namespaces — (Array<map>)

        The information about the namespaces in this Amazon Web Services account. The response includes the namespace ARN, name, Amazon Web Services Region, notification email address, creation status, and identity store.

        • Name — (String)

          The name of the error.

        • Arn — (String)

          The namespace ARN.

        • CapacityRegion — (String)

          The namespace Amazon Web Services Region.

        • CreationStatus — (String)

          The creation status of a namespace that is not yet completely created.

          Possible values include:
          • "CREATED"
          • "CREATING"
          • "DELETING"
          • "RETRYABLE_FAILURE"
          • "NON_RETRYABLE_FAILURE"
        • IdentityStore — (String)

          The identity store used for the namespace.

          Possible values include:
          • "QUICKSIGHT"
        • NamespaceError — (map)

          An error that occurred when the namespace was created.

          • Type — (String)

            The error type.

            Possible values include:
            • "PERMISSION_DENIED"
            • "INTERNAL_SERVICE_ERROR"
          • Message — (String)

            The message for the error.

      • NextToken — (String)

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

      • RequestId — (String)

        The Amazon Web Services 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.

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 Amazon Resource Name (ARN) of the resource that 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.

        • Key — required — (String)

          Tag key.

        • Value — required — (String)

          Tag value.

      • RequestId — (String)

        The Amazon Web Services 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.

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)

      The ID of the Amazon Web Services account that contains the template aliases that you're 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 the template's aliases.

        • AliasName — (String)

          The display name of the template alias.

        • Arn — (String)

          The Amazon Resource Name (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 Amazon Web Services 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 current Amazon QuickSight account.

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)

      The ID of the Amazon Web Services account that contains the templates that you're 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 ID is unique per Amazon Web Services Region for each Amazon Web Services 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 that this template was created.

        • LastUpdatedTime — (Date)

          The last time that this template 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 Amazon Web Services 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 current Amazon QuickSight account.

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)

      The ID of the Amazon Web Services account that contains the templates that you're 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 Amazon Resource Name (ARN) of the template version.

        • VersionNumber — (Integer)

          The version number of the template version.

        • CreatedTime — (Date)

          The time that this template version 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"
          • "DELETED"
        • Description — (String)

          The description 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 Amazon Web Services request ID for this operation.

Returns:

  • (AWS.Request) —

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

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

Lists all the aliases of a theme.

Service Reference:

Examples:

Calling the listThemeAliases operation

var params = {
  AwsAccountId: 'STRING_VALUE', /* required */
  ThemeId: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
quicksight.listThemeAliases(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 of the Amazon Web Services account that contains the theme aliases that you're listing.

    • ThemeId — (String)

      The ID for the theme.

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

      • ThemeAliasList — (Array<map>)

        A structure containing the list of the theme's aliases.

        • Arn — (String)

          The Amazon Resource Name (ARN) of the theme alias.

        • AliasName — (String)

          The display name of the theme alias.

        • ThemeVersionNumber — (Integer)

          The version number of the theme alias.

      • Status — (Integer)

        The HTTP status of the request.

      • RequestId — (String)

        The Amazon Web Services 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.

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

Lists all the themes in the current Amazon Web Services account.

Service Reference:

Examples:

Calling the listThemes operation

var params = {
  AwsAccountId: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  Type: QUICKSIGHT | CUSTOM | ALL
};
quicksight.listThemes(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 of the Amazon Web Services account that contains the themes that you're 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.

    • Type — (String)

      The type of themes that you want to list. Valid options include the following:

      • ALL (default)- Display all existing themes.

      • CUSTOM - Display only the themes created by people using Amazon QuickSight.

      • QUICKSIGHT - Display only the starting themes defined by Amazon QuickSight.

      Possible values include:
      • "QUICKSIGHT"
      • "CUSTOM"
      • "ALL"

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:

      • ThemeSummaryList — (Array<map>)

        Information about the themes in the list.

        • Arn — (String)

          The Amazon Resource Name (ARN) of the resource.

        • Name — (String)

          the display name for the theme.

        • ThemeId — (String)

          The ID of the theme. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

        • LatestVersionNumber — (Integer)

          The latest version number for the theme.

        • CreatedTime — (Date)

          The date and time that this theme was created.

        • LastUpdatedTime — (Date)

          The last date and time that this theme 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 Amazon Web Services request ID for this operation.

Returns:

  • (AWS.Request) —

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

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

Lists all the versions of the themes in the current Amazon Web Services account.

Service Reference:

Examples:

Calling the listThemeVersions operation

var params = {
  AwsAccountId: 'STRING_VALUE', /* required */
  ThemeId: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
quicksight.listThemeVersions(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 of the Amazon Web Services account that contains the themes that you're listing.

    • ThemeId — (String)

      The ID for the theme.

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

      • ThemeVersionSummaryList — (Array<map>)

        A structure containing a list of all the versions of the specified theme.

        • VersionNumber — (Integer)

          The version number of the theme version.

        • Arn — (String)

          The Amazon Resource Name (ARN) of the theme version.

        • Description — (String)

          The description of the theme version.

        • CreatedTime — (Date)

          The date and time that this theme version was created.

        • Status — (String)

          The status of the theme version.

          Possible values include:
          • "CREATION_IN_PROGRESS"
          • "CREATION_SUCCESSFUL"
          • "CREATION_FAILED"
          • "UPDATE_IN_PROGRESS"
          • "UPDATE_SUCCESSFUL"
          • "UPDATE_FAILED"
          • "DELETED"
      • 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 Amazon Web Services 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.

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 Amazon Web Services account ID that the user is in. Currently, you use the ID for the Amazon Web Services 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 Amazon Web Services 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.

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 Amazon Web Services account that the user is in. Currently, you use the ID for the Amazon Web Services 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 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)

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

        • PrincipalId — (String)

          The principal ID of the user.

        • CustomPermissionsName — (String)

          The custom permissions profile associated with this user.

        • ExternalLoginFederationProviderType — (String)

          The type of supported external login provider that provides identity to let the user federate into Amazon QuickSight with an associated IAMrole. The type can be one of the following.

          • COGNITO: Amazon Cognito. The provider URL is cognito-identity.amazonaws.com.

          • CUSTOM_OIDC: Custom OpenID Connect (OIDC) provider.

        • ExternalLoginFederationProviderUrl — (String)

          The URL of the external login provider.

        • ExternalLoginId — (String)

          The identity ID for the user in the external login provider.

      • NextToken — (String)

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

      • RequestId — (String)

        The Amazon Web Services 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.

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 */
  CustomFederationProviderUrl: 'STRING_VALUE',
  CustomPermissionsName: 'STRING_VALUE',
  ExternalLoginFederationProviderType: 'STRING_VALUE',
  ExternalLoginId: 'STRING_VALUE',
  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 IAMuser 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 IAMuser 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 IAMrole. You don't need to provide the session name for other scenarios, for example when you are registering an IAMuser or an Amazon QuickSight user. You can register multiple users using the same IAMrole if each user has a different session name. For more information on assuming IAMroles, see assume-role in the AWS CLI Reference.

    • AwsAccountId — (String)

      The ID for the Amazon Web Services account that the user is in. Currently, you use the ID for the Amazon Web Services 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.

    • CustomPermissionsName — (String)

      (Enterprise edition only) The name of the custom permissions profile that you want to assign to this user. Customized permissions allows you to control a user's access by restricting access the following operations:

      • Create and update data sources

      • Create and update datasets

      • Create and update email reports

      • Subscribe to email reports

      To add custom permissions to an existing user, use UpdateUser instead.

      A set of custom permissions includes any combination of these restrictions. Currently, you need to create the profile names for custom permission sets by using the Amazon QuickSight console. Then, you use the RegisterUser API operation to assign the named set of permissions to a Amazon QuickSight user.

      Amazon QuickSight custom permissions are applied through IAMpolicies. Therefore, they override the permissions typically granted by assigning Amazon QuickSight users to one of the default security cohorts in Amazon QuickSight (admin, author, reader).

      This feature is available only to Amazon QuickSight Enterprise edition subscriptions.

    • ExternalLoginFederationProviderType — (String)

      The type of supported external login provider that provides identity to let a user federate into Amazon QuickSight with an associated Identity and Access Management(IAM) role. The type of supported external login provider can be one of the following.

      • COGNITO: Amazon Cognito. The provider URL is cognito-identity.amazonaws.com. When choosing the COGNITO provider type, don’t use the "CustomFederationProviderUrl" parameter which is only needed when the external provider is custom.

      • CUSTOM_OIDC: Custom OpenID Connect (OIDC) provider. When choosing CUSTOM_OIDC type, use the CustomFederationProviderUrl parameter to provide the custom OIDC provider URL.

    • CustomFederationProviderUrl — (String)

      The URL of the custom OpenID Connect (OIDC) provider that provides identity to let a user federate into Amazon QuickSight with an associated Identity and Access Management(IAM) role. This parameter should only be used when ExternalLoginFederationProviderType parameter is set to CUSTOM_OIDC.

    • ExternalLoginId — (String)

      The identity ID for a user in the external login provider.

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's 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 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)

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

        • PrincipalId — (String)

          The principal ID of the user.

        • CustomPermissionsName — (String)

          The custom permissions profile associated with this user.

        • ExternalLoginFederationProviderType — (String)

          The type of supported external login provider that provides identity to let the user federate into Amazon QuickSight with an associated IAMrole. The type can be one of the following.

          • COGNITO: Amazon Cognito. The provider URL is cognito-identity.amazonaws.com.

          • CUSTOM_OIDC: Custom OpenID Connect (OIDC) provider.

        • ExternalLoginFederationProviderUrl — (String)

          The URL of the external login provider.

        • ExternalLoginId — (String)

          The identity ID for the user in the external login provider.

      • 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 Amazon Web Services 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.

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

Restores an analysis.

Service Reference:

Examples:

Calling the restoreAnalysis operation

var params = {
  AnalysisId: 'STRING_VALUE', /* required */
  AwsAccountId: 'STRING_VALUE' /* required */
};
quicksight.restoreAnalysis(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 of the Amazon Web Services account that contains the analysis.

    • AnalysisId — (String)

      The ID of the analysis that you're restoring.

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 Amazon Resource Name (ARN) of the analysis that you're restoring.

      • AnalysisId — (String)

        The ID of the analysis that you're restoring.

      • RequestId — (String)

        The Amazon Web Services request ID for this operation.

Returns:

  • (AWS.Request) —

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

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

Searches for analyses that belong to the user specified in the filter.

Note: This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.

Service Reference:

Examples:

Calling the searchAnalyses operation

var params = {
  AwsAccountId: 'STRING_VALUE', /* required */
  Filters: [ /* required */
    {
      Name: QUICKSIGHT_USER,
      Operator: StringEquals,
      Value: 'STRING_VALUE'
    },
    /* more items */
  ],
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
quicksight.searchAnalyses(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 of the Amazon Web Services account that contains the analyses that you're searching for.

    • Filters — (Array<map>)

      The structure for the search filters that you want to apply to your search.

      • Operator — (String)

        The comparison operator that you want to use as a filter, for example "Operator": "StringEquals".

        Possible values include:
        • "StringEquals"
      • Name — (String)

        The name of the value that you want to use as a filter, for example "Name": "QUICKSIGHT_USER".

        Possible values include:
        • "QUICKSIGHT_USER"
      • Value — (String)

        The value of the named item, in this case QUICKSIGHT_USER, that you want to use as a filter, for example "Value". An example is "arn:aws:quicksight:us-east-1:1:user/default/UserName1".

    • NextToken — (String)

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

    • MaxResults — (Integer)

      The maximum number of results to return.

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:

      • AnalysisSummaryList — (Array<map>)

        Metadata describing the analyses that you searched for.

        • Arn — (String)

          The Amazon Resource Name (ARN) for the analysis.

        • AnalysisId — (String)

          The ID of the analysis. This ID displays in the URL.

        • Name — (String)

          The name of the analysis. This name is displayed in the Amazon QuickSight console.

        • Status — (String)

          The last known status for the analysis.

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

          The time that the analysis was created.

        • LastUpdatedTime — (Date)

          The time that the analysis was last updated.

      • NextToken — (String)

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

      • Status — (Integer)

        The HTTP status of the request.

      • RequestId — (String)

        The Amazon Web Services request ID for this operation.

Returns:

  • (AWS.Request) —

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

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

Searches for dashboards that belong to a user.

Note: This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.

Service Reference:

Examples:

Calling the searchDashboards operation

var params = {
  AwsAccountId: 'STRING_VALUE', /* required */
  Filters: [ /* required */
    {
      Operator: StringEquals, /* required */
      Name: QUICKSIGHT_USER,
      Value: 'STRING_VALUE'
    },
    /* more items */
  ],
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
quicksight.searchDashboards(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 of the Amazon Web Services account that contains the user whose dashboards you're searching for.

    • Filters — (Array<map>)

      The filters to apply to the search. Currently, you can search only by user name, for example, "Filters": [ { "Name": "QUICKSIGHT_USER", "Operator": "StringEquals", "Value": "arn:aws:quicksight:us-east-1:1:user/default/UserName1" } ]

      • Operator — required — (String)

        The comparison operator that you want to use as a filter, for example, "Operator": "StringEquals".

        Possible values include:
        • "StringEquals"
      • Name — (String)

        The name of the value that you want to use as a filter, for example, "Name": "QUICKSIGHT_USER".

        Possible values include:
        • "QUICKSIGHT_USER"
      • Value — (String)

        The value of the named item, in this case QUICKSIGHT_USER, that you want to use as a filter, for example, "Value": "arn:aws:quicksight:us-east-1:1:user/default/UserName1".

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

        The list of dashboards owned by the user specified in Filters in your request.

        • Arn — (String)

          The Amazon Resource Name (ARN) of the resource.

        • DashboardId — (String)

          Dashboard ID.

        • Name — (String)

          A display name for the dashboard.

        • CreatedTime — (Date)

          The time that this dashboard was created.

        • LastUpdatedTime — (Date)

          The last time that this dashboard was updated.

        • PublishedVersionNumber — (Integer)

          Published version number.

        • LastPublishedTime — (Date)

          The last time that this dashboard 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 Amazon Web Services request ID for this operation.

Returns:

  • (AWS.Request) —

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

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

Searches the subfolders in a folder.

Service Reference:

Examples:

Calling the searchFolders operation

var params = {
  AwsAccountId: 'STRING_VALUE', /* required */
  Filters: [ /* required */
    {
      Name: PARENT_FOLDER_ARN,
      Operator: StringEquals,
      Value: 'STRING_VALUE'
    },
    /* more items */
  ],
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
quicksight.searchFolders(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.

    • Filters — (Array<map>)

      The filters to apply to the search. Currently, you can search only by the parent folder ARN. For example, "Filters": [ { "Name": "PARENT_FOLDER_ARN", "Operator": "StringEquals", "Value": "arn:aws:quicksight:us-east-1:1:folder/folderId" } ].

      • Operator — (String)

        The comparison operator that you want to use as a filter. For example, "Operator": "StringEquals".

        Possible values include:
        • "StringEquals"
      • Name — (String)

        The name of the value that you want to use as a filter. For example, "Name": "PARENT_FOLDER_ARN".

        Possible values include:
        • "PARENT_FOLDER_ARN"
      • Value — (String)

        The value of the named item (in this example, PARENT_FOLDER_ARN), that you want to use as a filter. For example, "Value": "arn:aws:quicksight:us-east-1:1:folder/folderId".

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

      • Status — (Integer)

        The status. If succeeded, the status is SC_OK.

      • FolderSummaryList — (Array<map>)

        A structure that contains all of the folders in your AWS account. This structure provides basic information about the folders.

        • Arn — (String)

          The Amazon Resource Name (ARN).

        • FolderId — (String)

          The folder ID.

        • Name — (String)

          The display name of the folder.

        • FolderType — (String)

          The type of folder.

          Possible values include:
          • "SHARED"
        • CreatedTime — (Date)

          The time that the folder was created.

        • LastUpdatedTime — (Date)

          The time that the folder was last updated.

      • NextToken — (String)

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

      • RequestId — (String)

        The request ID.

Returns:

  • (AWS.Request) —

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

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

Assigns one or more tags (key-value pairs) to the specified Amazon 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 operation 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. Amazon QuickSight supports tagging on data set, data source, dashboard, and template.

Tagging for Amazon QuickSight works in a similar way to tagging for other AWS services, except for the following:

  • You can't use tags to track AWS costs for Amazon QuickSight. This restriction is because Amazon QuickSight costs are based on users and SPICE capacity, which aren't taggable resources.

  • Amazon QuickSight doesn't currently support the Tag Editor for Resource Groups.

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 Amazon Resource Name (ARN) of the resource that 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.

      • Key — required — (String)

        Tag key.

      • Value — required — (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 Amazon Web Services 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.

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 Amazon Resource Name (ARN) of the resource that you want 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 Amazon Web Services 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.

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

Updates Amazon QuickSight customizations the current Amazon Web Services Region. Currently, the only customization you can use is a theme.

You can use customizations for your Amazon Web Services account or, if you specify a namespace, for a Amazon QuickSight namespace instead. Customizations that apply to a namespace override customizations that apply to an Amazon Web Services account. To find out which customizations apply, use the DescribeAccountCustomization API operation.

Service Reference:

Examples:

Calling the updateAccountCustomization operation

var params = {
  AccountCustomization: { /* required */
    DefaultTheme: 'STRING_VALUE'
  },
  AwsAccountId: 'STRING_VALUE', /* required */
  Namespace: 'STRING_VALUE'
};
quicksight.updateAccountCustomization(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 Amazon Web Services account that you want to update Amazon QuickSight customizations for.

    • Namespace — (String)

      The namespace that you want to update Amazon QuickSight customizations for.

    • AccountCustomization — (map)

      The Amazon QuickSight customizations you're updating in the current Amazon Web Services Region.

      • DefaultTheme — (String)

        The default theme for this Amazon QuickSight subscription.

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 updated customization for this Amazon Web Services account.

      • AwsAccountId — (String)

        The ID for the Amazon Web Services account that you want to update Amazon QuickSight customizations for.

      • Namespace — (String)

        The namespace associated with the customization that you're updating.

      • AccountCustomization — (map)

        The Amazon QuickSight customizations you're updating in the current Amazon Web Services Region.

        • DefaultTheme — (String)

          The default theme for this Amazon QuickSight subscription.

      • RequestId — (String)

        The Amazon Web Services 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.

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

Updates the Amazon QuickSight settings in your Amazon Web Services account.

Service Reference:

Examples:

Calling the updateAccountSettings operation

var params = {
  AwsAccountId: 'STRING_VALUE', /* required */
  DefaultNamespace: 'STRING_VALUE', /* required */
  NotificationEmail: 'STRING_VALUE'
};
quicksight.updateAccountSettings(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 Amazon Web Services account that contains the Amazon QuickSight settings that you want to list.

    • DefaultNamespace — (String)

      The default namespace for this Amazon Web Services account. Currently, the default is default. Identity and Access Management (IAM) users that register for the first time with Amazon QuickSight provide an email that becomes associated with the default namespace.

    • NotificationEmail — (String)

      The email address that you want Amazon QuickSight to send notifications to regarding your Amazon Web Services account or Amazon QuickSight subscription.

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 Amazon Web Services 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.

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

Updates an analysis in Amazon QuickSight

Service Reference:

Examples:

Calling the updateAnalysis operation

var params = {
  AnalysisId: 'STRING_VALUE', /* required */
  AwsAccountId: '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 */
      ]
    }
  },
  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 */
    ]
  },
  ThemeArn: 'STRING_VALUE'
};
quicksight.updateAnalysis(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 of the Amazon Web Services account that contains the analysis that you're updating.

    • AnalysisId — (String)

      The ID for the analysis that you're updating. This ID displays in the URL of the analysis.

    • Name — (String)

      A descriptive name for the analysis that you're updating. This name displays for the analysis in the Amazon QuickSight console.

    • Parameters — (map)

      The parameter names and override values that you want to use. An analysis can have any parameter type, and some parameters might accept multiple values.

      • StringParameters — (Array<map>)

        The parameters that have a data type of string.

        • Name — required — (String)

          A display name for a string parameter.

        • Values — required — (Array<String>)

          The values of a string parameter.

      • IntegerParameters — (Array<map>)

        The parameters that have a data type of integer.

        • Name — required — (String)

          The name of the integer parameter.

        • Values — required — (Array<Integer>)

          The values for the integer parameter.

      • DecimalParameters — (Array<map>)

        The parameters that have a data type of decimal.

        • Name — required — (String)

          A display name for the decimal parameter.

        • Values — required — (Array<Float>)

          The values for the decimal parameter.

      • DateTimeParameters — (Array<map>)

        The parameters that have a data type of date-time.

        • Name — required — (String)

          A display name for the date-time parameter.

        • Values — required — (Array<Date>)

          The values for the date-time parameter.

    • SourceEntity — (map)

      A source entity to use for the analysis that you're updating. This metadata structure contains details that describe a source template and one or more datasets.

      • SourceTemplate — (map)

        The source template for the source entity of the analysis.

        • DataSetReferences — required — (Array<map>)

          The dataset references of the source template of an analysis.

          • DataSetPlaceholder — required — (String)

            Dataset placeholder.

          • DataSetArn — required — (String)

            Dataset Amazon Resource Name (ARN).

        • Arn — required — (String)

          The Amazon Resource Name (ARN) of the source template of an analysis.

    • ThemeArn — (String)

      The Amazon Resource Name (ARN) for the theme to apply to the analysis that you're creating. To see the theme in the Amazon QuickSight console, make sure that you have access to it.

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 analysis that you're updating.

      • AnalysisId — (String)

        The ID of the analysis.

      • UpdateStatus — (String)

        The update status of the last update that was made to the analysis.

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

        The HTTP status of the request.

      • RequestId — (String)

        The Amazon Web Services request ID for this operation.

Returns:

  • (AWS.Request) —

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

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

Updates the read and write permissions for an analysis.

Service Reference:

Examples:

Calling the updateAnalysisPermissions operation

var params = {
  AnalysisId: 'STRING_VALUE', /* required */
  AwsAccountId: '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.updateAnalysisPermissions(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 of the Amazon Web Services account that contains the analysis whose permissions you're updating. You must be using the Amazon Web Services account that the analysis is in.

    • AnalysisId — (String)

      The ID of the analysis whose permissions you're updating. The ID is part of the analysis URL.

    • GrantPermissions — (Array<map>)

      A structure that describes the permissions to add and the principal to add them to.

      • Principal — required — (String)

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

        • The ARN of an Amazon QuickSight user or group associated with a data source or dataset. (This is common.)

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

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

      • Actions — required — (Array<String>)

        The IAMaction to grant or revoke permissions on.

    • RevokePermissions — (Array<map>)

      A structure that describes the permissions to remove and the principal to remove them from.

      • Principal — required — (String)

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

        • The ARN of an Amazon QuickSight user or group associated with a data source or dataset. (This is common.)

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

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

      • Actions — required — (Array<String>)

        The IAMaction to grant or revoke permissions on.

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:

      • AnalysisArn — (String)

        The Amazon Resource Name (ARN) of the analysis that you updated.

      • AnalysisId — (String)

        The ID of the analysis that you updated permissions for.

      • Permissions — (Array<map>)

        A structure that describes the principals and the resource-level permissions on an analysis.

        • Principal — required — (String)

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

          • The ARN of an Amazon QuickSight user or group associated with a data source or dataset. (This is common.)

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

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

        • Actions — required — (Array<String>)

          The IAMaction to grant or revoke permissions on.

      • RequestId — (String)

        The Amazon Web Services 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 an Amazon Web Services account.

Note: Updating a Dashboard creates a new dashboard version but does not immediately publish the new version. You can update the published version of a dashboard by using the UpdateDashboardPublishedVersion API operation.

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 */
    ]
  },
  ThemeArn: 'STRING_VALUE',
  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)

      The ID of the Amazon Web Services account that contains the dashboard that you're updating.

    • DashboardId — (String)

      The ID for the dashboard.

    • Name — (String)

      The display name of the dashboard.

    • SourceEntity — (map)

      The entity that you are using as a source when you update the dashboard. In SourceEntity, you specify the type of object you're using as source. You can only update a dashboard from a template, so you use a SourceTemplate entity. If you need to update a dashboard from an analysis, first convert the analysis to a template by using the CreateTemplate API operation. For SourceTemplate, specify the Amazon Resource Name (ARN) of the source template. The SourceTemplate ARN can contain any Amazon Web Services account and any Amazon QuickSight-supported Amazon Web Services Region.

      Use the DataSetReferences entity within SourceTemplate to list the replacement datasets for the placeholders listed in the original. The schema in each dataset must match its placeholder.

      • SourceTemplate — (map)

        Source template.

        • DataSetReferences — required — (Array<map>)

          Dataset references.

          • DataSetPlaceholder — required — (String)

            Dataset placeholder.

          • DataSetArn — required — (String)

            Dataset Amazon Resource Name (ARN).

        • Arn — required — (String)

          The Amazon Resource Name (ARN) of the resource.

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

      • StringParameters — (Array<map>)

        The parameters that have a data type of string.

        • Name — required — (String)

          A display name for a string parameter.

        • Values — required — (Array<String>)

          The values of a string parameter.

      • IntegerParameters — (Array<map>)

        The parameters that have a data type of integer.

        • Name — required — (String)

          The name of the integer parameter.

        • Values — required — (Array<Integer>)

          The values for the integer parameter.

      • DecimalParameters — (Array<map>)

        The parameters that have a data type of decimal.

        • Name — required — (String)

          A display name for the decimal parameter.

        • Values — required — (Array<Float>)

          The values for the decimal parameter.

      • DateTimeParameters — (Array<map>)

        The parameters that have a data type of date-time.

        • Name — required — (String)

          A display name for the date-time parameter.

        • Values — required — (Array<Date>)

          The values for the date-time parameter.

    • VersionDescription — (String)

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

    • DashboardPublishOptions — (map)

      Options for publishing the dashboard when you create it:

      • AvailabilityStatus for AdHocFilteringOption - This status can be either ENABLED or DISABLED. When this is set to DISABLED, Amazon QuickSight disables the left filter pane on the published dashboard, which can be used for ad hoc (one-time) filtering. This option is ENABLED by default.

      • AvailabilityStatus for ExportToCSVOption - This status can be either ENABLED or DISABLED. The visual option to export data to .CSV format isn't enabled when this is set to DISABLED. This option is ENABLED by default.

      • VisibilityState for SheetControlsOption - This visibility state can be either COLLAPSED or EXPANDED. This option is COLLAPSED by default.

      • AdHocFilteringOption — (map)

        Ad hoc (one-time) 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"
    • ThemeArn — (String)

      The Amazon Resource Name (ARN) of the theme that is being used for this dashboard. If you add a value for this field, it overrides the value that was originally associated with the entity. The theme ARN must exist in the same Amazon Web Services account where you create 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:

      • Arn — (String)

        The Amazon Resource Name (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"
        • "DELETED"
      • Status — (Integer)

        The HTTP status of the request.

      • RequestId — (String)

        The Amazon Web Services 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.

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)

      The ID of the Amazon Web Services account that contains the dashboard whose permissions you're updating.

    • DashboardId — (String)

      The ID for the dashboard.

    • GrantPermissions — (Array<map>)

      The permissions that you want to grant on this resource.

      • Principal — required — (String)

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

        • The ARN of an Amazon QuickSight user or group associated with a data source or dataset. (This is common.)

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

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

      • Actions — required — (Array<String>)

        The IAMaction to grant or revoke permissions on.

    • RevokePermissions — (Array<map>)

      The permissions that you want to revoke from this resource.

      • Principal — required — (String)

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

        • The ARN of an Amazon QuickSight user or group associated with a data source or dataset. (This is common.)

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

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

      • Actions — required — (Array<String>)

        The IAMaction to grant or revoke permissions on.

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 Amazon Resource Name (ARN) of the dashboard.

      • DashboardId — (String)

        The ID for the dashboard.

      • Permissions — (Array<map>)

        Information about the permissions on the dashboard.

        • Principal — required — (String)

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

          • The ARN of an Amazon QuickSight user or group associated with a data source or dataset. (This is common.)

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

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

        • Actions — required — (Array<String>)

          The IAMaction to grant or revoke permissions on.

      • RequestId — (String)

        The Amazon Web Services 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.

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)

      The ID of the Amazon Web Services account that contains the dashboard that you're 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 Amazon Resource Name (ARN) of the dashboard.

      • Status — (Integer)

        The HTTP status of the request.

      • RequestId — (String)

        The Amazon Web Services 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.

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 */
        Catalog: 'STRING_VALUE',
        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 */
  ],
  ColumnLevelPermissionRules: [
    {
      ColumnNames: [
        'STRING_VALUE',
        /* more items */
      ],
      Principals: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  DataSetUsageConfiguration: {
    DisableUseAsDirectQuerySource: true || false,
    DisableUseAsImportedSource: true || false
  },
  FieldFolders: {
    '<FieldFolderPath>': {
      columns: [
        'STRING_VALUE',
        /* more items */
      ],
      description: 'STRING_VALUE'
    },
    /* '<FieldFolderPath>': ... */
  },
  LogicalTableMap: {
    '<LogicalTableId>': {
      Alias: 'STRING_VALUE', /* required */
      Source: { /* required */
        DataSetArn: 'STRING_VALUE',
        JoinInstruction: {
          LeftOperand: 'STRING_VALUE', /* required */
          OnClause: 'STRING_VALUE', /* required */
          RightOperand: 'STRING_VALUE', /* required */
          Type: INNER | OUTER | LEFT | RIGHT, /* required */
          LeftJoinKeyProperties: {
            UniqueKey: true || false
          },
          RightJoinKeyProperties: {
            UniqueKey: true || false
          }
        },
        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 */
              {
                ColumnDescription: {
                  Text: 'STRING_VALUE'
                },
                ColumnGeographicRole: COUNTRY | STATE | COUNTY | CITY | POSTCODE | LONGITUDE | LATITUDE
              },
              /* more items */
            ]
          },
          UntagColumnOperation: {
            ColumnName: 'STRING_VALUE', /* required */
            TagNames: [ /* required */
              COLUMN_GEOGRAPHIC_ROLE | COLUMN_DESCRIPTION,
              /* more items */
            ]
          }
        },
        /* more items */
      ]
    },
    /* '<LogicalTableId>': ... */
  },
  RowLevelPermissionDataSet: {
    Arn: 'STRING_VALUE', /* required */
    PermissionPolicy: GRANT_ACCESS | DENY_ACCESS, /* required */
    FormatVersion: VERSION_1 | VERSION_2,
    Namespace: 'STRING_VALUE',
    Status: ENABLED | DISABLED
  },
  RowLevelPermissionTagConfiguration: {
    TagRules: [ /* required */
      {
        ColumnName: 'STRING_VALUE', /* required */
        TagKey: 'STRING_VALUE', /* required */
        MatchAllValue: 'STRING_VALUE',
        TagMultiValueDelimiter: 'STRING_VALUE'
      },
      /* more items */
    ],
    Status: ENABLED | DISABLED
  }
};
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 Amazon Web Services account ID.

    • DataSetId — (String)

      The ID for the dataset that you want to update. This ID is unique per Amazon Web Services Region for each Amazon Web Services 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.

        • DataSourceArn — required — (String)

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

        • Catalog — (String)

          The catalog associated with a table.

        • Schema — (String)

          The schema name. This name applies to certain relational database engines.

        • Name — required — (String)

          The name of the relational table.

        • InputColumns — required — (Array<map>)

          The column schema of the table.

          • Name — required — (String)

            The name of this column in the underlying data source.

          • Type — required — (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.

        • DataSourceArn — required — (String)

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

        • Name — required — (String)

          A display name for the SQL query result.

        • SqlQuery — required — (String)

          The SQL query.

        • Columns — (Array<map>)

          The column schema from the SQL query result set.

          • Name — required — (String)

            The name of this column in the underlying data source.

          • Type — required — (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.

        • DataSourceArn — required — (String)

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

        • UploadSettings — (map)

          Information about the format for the S3 source file or files.

          • 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 the file has a header row, or the files each have a header row.

          • TextQualifier — (String)

            Text qualifier.

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

            The delimiter between values in the file.

        • InputColumns — required — (Array<map>)

          A physical table type for an S3 data source.

          Note: For files that aren't JSON, only STRING data types are supported in input columns.
          • Name — required — (String)

            The name of this column in the underlying data source.

          • Type — required — (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.

      • Alias — required — (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.

          • ProjectedColumns — required — (Array<String>)

            Projected columns.

        • FilterOperation — (map)

          An operation that filters rows based on some condition.

          • ConditionExpression — required — (String)

            An expression that must evaluate to a Boolean value. Rows for which the expression evaluates 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.

          • Columns — required — (Array<map>)

            Calculated columns to create.

            • ColumnName — required — (String)

              Column name.

            • ColumnId — required — (String)

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

            • Expression — required — (String)

              An expression that defines the calculated column.

        • RenameColumnOperation — (map)

          An operation that renames a column.

          • ColumnName — required — (String)

            The name of the column to be renamed.

          • NewColumnName — required — (String)

            The new name for the column.

        • CastColumnTypeOperation — (map)

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

          • ColumnName — required — (String)

            Column name.

          • NewColumnType — required — (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 string in a format supported by Amazon QuickSight to denote the source data format.

        • TagColumnOperation — (map)

          An operation that tags a column with additional information.

          • ColumnName — required — (String)

            The column that this operation acts on.

          • Tags — required — (Array<map>)

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

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

              A geospatial role for a column.

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

              A description for a column.

              • Text — (String)

                The text of a description for a column.

        • UntagColumnOperation — (map)

          A transform operation that removes tags associated with a column.

          • ColumnName — required — (String)

            The column that this operation acts on.

          • TagNames — required — (Array<String>)

            The column tags to remove from this column.

      • Source — required — (map)

        Source of this logical table.

        • JoinInstruction — (map)

          Specifies the result of a join of two logical tables.

          • LeftOperand — required — (String)

            The operand on the left side of a join.

          • RightOperand — required — (String)

            The operand on the right side of a join.

          • LeftJoinKeyProperties — (map)

            Join key properties of the left operand.

            • UniqueKey — (Boolean)

              A value that indicates that a row in a table is uniquely identified by the columns in a join key. This is used by Amazon QuickSight to optimize query performance.

          • RightJoinKeyProperties — (map)

            Join key properties of the right operand.

            • UniqueKey — (Boolean)

              A value that indicates that a row in a table is uniquely identified by the columns in a join key. This is used by Amazon QuickSight to optimize query performance.

          • Type — required — (String)

            The type of join that it is.

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

            The join instructions provided in the ON clause of a join.

        • PhysicalTableId — (String)

          Physical table ID.

        • DataSetArn — (String)

          The Amazon Resource Number (ARN) of the parent dataset.

    • ImportMode — (String)

      Indicates whether 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 Amazon QuickSight features. Currently, only geospatial hierarchy is supported.

      • GeoSpatialColumnGroup — (map)

        Geospatial column group that denotes a hierarchy.

        • Name — required — (String)

          A display name for the hierarchy.

        • CountryCode — required — (String)

          Country code.

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

          Columns in this hierarchy.

    • FieldFolders — (map<map>)

      The folder that contains fields and nested subfolders for your dataset.

      • description — (String)

        The description for a field folder.

      • columns — (Array<String>)

        A folder has a list of columns. A column can only be in one folder.

    • RowLevelPermissionDataSet — (map)

      The row-level security configuration for the data you want to create.

      • Namespace — (String)

        The namespace associated with the dataset that contains permissions for RLS.

      • Arn — required — (String)

        The Amazon Resource Name (ARN) of the dataset that contains permissions for RLS.

      • PermissionPolicy — required — (String)

        The type of permissions to use when interpreting the permissions for RLS. DENY_ACCESS is included for backward compatibility only.

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

        The user or group rules associated with the dataset that contains permissions for RLS.

        By default, FormatVersion is VERSION_1. When FormatVersion is VERSION_1, UserName and GroupName are required. When FormatVersion is VERSION_2, UserARN and GroupARN are required, and Namespace must not exist.

        Possible values include:
        • "VERSION_1"
        • "VERSION_2"
      • Status — (String)

        The status of the row-level security permission dataset. If enabled, the status is ENABLED. If disabled, the status is DISABLED.

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

      The configuration of tags on a dataset to set row-level security. Row-level security tags are currently supported for anonymous embedding only.

      • Status — (String)

        The status of row-level security tags. If enabled, the status is ENABLED. If disabled, the status is DISABLED.

        Possible values include:
        • "ENABLED"
        • "DISABLED"
      • TagRules — required — (Array<map>)

        A set of rules associated with row-level security, such as the tag names and columns that they are assigned to.

        • TagKey — required — (String)

          The unique key for a tag.

        • ColumnName — required — (String)

          The column name that a tag key is assigned to.

        • TagMultiValueDelimiter — (String)

          A string that you want to use to delimit the values when you pass the values at run time. For example, you can delimit the values with a comma.

        • MatchAllValue — (String)

          A string that you want to use to filter by all the values in a column in the dataset and don’t want to list the values one by one. For example, you can use an asterisk as your match all value.

    • ColumnLevelPermissionRules — (Array<map>)

      A set of one or more definitions of a ColumnLevelPermissionRule .

      • Principals — (Array<String>)

        An array of Amazon Resource Names (ARNs) for Amazon QuickSight users or groups.

      • ColumnNames — (Array<String>)

        An array of column names.

    • DataSetUsageConfiguration — (map)

      The usage configuration to apply to child datasets that reference this dataset as a source.

      • DisableUseAsDirectQuerySource — (Boolean)

        An option that controls whether a child dataset of a direct query can use this dataset as a source.

      • DisableUseAsImportedSource — (Boolean)

        An option that controls whether a child dataset that's stored in QuickSight can use this dataset as a source.

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) of the dataset.

      • DataSetId — (String)

        The ID for the dataset that you want to create. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

      • IngestionArn — (String)

        The 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 Amazon Web Services 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.

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 Amazon Web Services account ID.

    • DataSetId — (String)

      The ID for the dataset whose permissions you want to update. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

    • GrantPermissions — (Array<map>)

      The resource permissions that you want to grant to the dataset.

      • Principal — required — (String)

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

        • The ARN of an Amazon QuickSight user or group associated with a data source or dataset. (This is common.)

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

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

      • Actions — required — (Array<String>)

        The IAMaction to grant or revoke permissions on.

    • RevokePermissions — (Array<map>)

      The resource permissions that you want to revoke from the dataset.

      • Principal — required — (String)

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

        • The ARN of an Amazon QuickSight user or group associated with a data source or dataset. (This is common.)

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

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

      • Actions — required — (Array<String>)

        The IAMaction to grant or revoke permissions on.

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 Amazon Resource Name (ARN) of the dataset.

      • DataSetId — (String)

        The ID for the dataset whose permissions you want to update. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

      • RequestId — (String)

        The Amazon Web Services 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.

Service Reference:

Examples:

Calling the updateDataSource operation

var params = {
  AwsAccountId: 'STRING_VALUE', /* required */
  DataSourceId: 'STRING_VALUE', /* required */
  Name: 'STRING_VALUE', /* required */
  Credentials: {
    CopySourceArn: 'STRING_VALUE',
    CredentialPair: {
      Password: 'STRING_VALUE', /* required */
      Username: 'STRING_VALUE', /* required */
      AlternateDataSourceParameters: [
        {
          AmazonElasticsearchParameters: {
            Domain: 'STRING_VALUE' /* required */
          },
          AmazonOpenSearchParameters: {
            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 */
          },
          OracleParameters: {
            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 */
          }
        },
        /* more items */
      ]
    }
  },
  DataSourceParameters: {
    AmazonElasticsearchParameters: {
      Domain: 'STRING_VALUE' /* required */
    },
    AmazonOpenSearchParameters: {
      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 */
    },
    OracleParameters: {
      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 Amazon Web Services account ID.

    • DataSourceId — (String)

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

    • Name — (String)

      A display name for the data source.

    • DataSourceParameters — (map)

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

      • AmazonElasticsearchParameters — (map)

        The parameters for OpenSearch.

        • Domain — required — (String)

          The OpenSearch domain.

      • AthenaParameters — (map)

        The parameters for Amazon Athena.

        • WorkGroup — (String)

          The workgroup that Amazon Athena uses.

      • AuroraParameters — (map)

        The parameters for Amazon Aurora MySQL.

        • Host — required — (String)

          Host.

        • Port — required — (Integer)

          Port.

        • Database — required — (String)

          Database.

      • AuroraPostgreSqlParameters — (map)

        The parameters for Amazon Aurora.

        • Host — required — (String)

          The Amazon Aurora PostgreSQL-Compatible host to connect to.

        • Port — required — (Integer)

          The port that Amazon Aurora PostgreSQL is listening on.

        • Database — required — (String)

          The Amazon Aurora PostgreSQL database to connect to.

      • AwsIotAnalyticsParameters — (map)

        The parameters for IoT Analytics.

        • DataSetName — required — (String)

          Dataset name.

      • JiraParameters — (map)

        The parameters for Jira.

        • SiteBaseUrl — required — (String)

          The base URL of the Jira site.

      • MariaDbParameters — (map)

        The parameters for MariaDB.

        • Host — required — (String)

          Host.

        • Port — required — (Integer)

          Port.

        • Database — required — (String)

          Database.

      • MySqlParameters — (map)

        The parameters for MySQL.

        • Host — required — (String)

          Host.

        • Port — required — (Integer)

          Port.

        • Database — required — (String)

          Database.

      • OracleParameters — (map)

        The parameters for Oracle.

        • Host — required — (String)

          An Oracle host.

        • Port — required — (Integer)

          Port.

        • Database — required — (String)

          Database.

      • PostgreSqlParameters — (map)

        The parameters for PostgreSQL.

        • Host — required — (String)

          Host.

        • Port — required — (Integer)

          Port.

        • Database — required — (String)

          Database.

      • PrestoParameters — (map)

        The parameters for Presto.

        • Host — required — (String)

          Host.

        • Port — required — (Integer)

          Port.

        • Catalog — required — (String)

          Catalog.

      • RdsParameters — (map)

        The parameters for Amazon RDS.

        • InstanceId — required — (String)

          Instance ID.

        • Database — required — (String)

          Database.

      • RedshiftParameters — (map)

        The parameters for Amazon Redshift.

        • Host — (String)

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

        • Port — (Integer)

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

        • Database — required — (String)

          Database.

        • ClusterId — (String)

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

      • S3Parameters — (map)

        The parameters for S3.

        • ManifestFileLocation — required — (map)

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

          • Bucket — required — (String)

            Amazon S3 bucket.

          • Key — required — (String)

            Amazon S3 key that identifies an object.

      • ServiceNowParameters — (map)

        The parameters for ServiceNow.

        • SiteBaseUrl — required — (String)

          URL of the base site.

      • SnowflakeParameters — (map)

        The parameters for Snowflake.

        • Host — required — (String)

          Host.

        • Database — required — (String)

          Database.

        • Warehouse — required — (String)

          Warehouse.

      • SparkParameters — (map)

        The parameters for Spark.

        • Host — required — (String)

          Host.

        • Port — required — (Integer)

          Port.

      • SqlServerParameters — (map)

        The parameters for SQL Server.

        • Host — required — (String)

          Host.

        • Port — required — (Integer)

          Port.

        • Database — required — (String)

          Database.

      • TeradataParameters — (map)

        The parameters for Teradata.

        • Host — required — (String)

          Host.

        • Port — required — (Integer)

          Port.

        • Database — required — (String)

          Database.

      • TwitterParameters — (map)

        The parameters for Twitter.

        • Query — required — (String)

          Twitter query string.

        • MaxRows — required — (Integer)

          Maximum number of rows to query Twitter.

      • AmazonOpenSearchParameters — (map)
        • Domain — required — (String)
    • Credentials — (map)

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

      • CredentialPair — (map)

        Credential pair. For more information, see CredentialPair.

        • Username — required — (String)

          User name.

        • Password — required — (String)

          Password.

        • AlternateDataSourceParameters — (Array<map>)

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

          • AmazonElasticsearchParameters — (map)

            The parameters for OpenSearch.

            • Domain — required — (String)

              The OpenSearch domain.

          • AthenaParameters — (map)

            The parameters for Amazon Athena.

            • WorkGroup — (String)

              The workgroup that Amazon Athena uses.

          • AuroraParameters — (map)

            The parameters for Amazon Aurora MySQL.

            • Host — required — (String)

              Host.

            • Port — required — (Integer)

              Port.

            • Database — required — (String)

              Database.

          • AuroraPostgreSqlParameters — (map)

            The parameters for Amazon Aurora.

            • Host — required — (String)

              The Amazon Aurora PostgreSQL-Compatible host to connect to.

            • Port — required — (Integer)

              The port that Amazon Aurora PostgreSQL is listening on.

            • Database — required — (String)

              The Amazon Aurora PostgreSQL database to connect to.

          • AwsIotAnalyticsParameters — (map)

            The parameters for IoT Analytics.

            • DataSetName — required — (String)

              Dataset name.

          • JiraParameters — (map)

            The parameters for Jira.

            • SiteBaseUrl — required — (String)

              The base URL of the Jira site.

          • MariaDbParameters — (map)

            The parameters for MariaDB.

            • Host — required — (String)

              Host.

            • Port — required — (Integer)

              Port.

            • Database — required — (String)

              Database.

          • MySqlParameters — (map)

            The parameters for MySQL.

            • Host — required — (String)

              Host.

            • Port — required — (Integer)

              Port.

            • Database — required — (String)

              Database.

          • OracleParameters — (map)

            The parameters for Oracle.

            • Host — required — (String)

              An Oracle host.

            • Port — required — (Integer)

              Port.

            • Database — required — (String)

              Database.

          • PostgreSqlParameters — (map)

            The parameters for PostgreSQL.

            • Host — required — (String)

              Host.

            • Port — required — (Integer)

              Port.

            • Database — required — (String)

              Database.

          • PrestoParameters — (map)

            The parameters for Presto.

            • Host — required — (String)

              Host.

            • Port — required — (Integer)

              Port.

            • Catalog — required — (String)

              Catalog.

          • RdsParameters — (map)

            The parameters for Amazon RDS.

            • InstanceId — required — (String)

              Instance ID.

            • Database — required — (String)

              Database.

          • RedshiftParameters — (map)

            The parameters for Amazon Redshift.

            • Host — (String)

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

            • Port — (Integer)

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

            • Database — required — (String)

              Database.

            • ClusterId — (String)

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

          • S3Parameters — (map)

            The parameters for S3.

            • ManifestFileLocation — required — (map)

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

              • Bucket — required — (String)

                Amazon S3 bucket.

              • Key — required — (String)

                Amazon S3 key that identifies an object.

          • ServiceNowParameters — (map)

            The parameters for ServiceNow.

            • SiteBaseUrl — required — (String)

              URL of the base site.

          • SnowflakeParameters — (map)

            The parameters for Snowflake.

            • Host — required — (String)

              Host.

            • Database — required — (String)

              Database.

            • Warehouse — required — (String)

              Warehouse.

          • SparkParameters — (map)

            The parameters for Spark.

            • Host — required — (String)

              Host.

            • Port — required — (Integer)

              Port.

          • SqlServerParameters — (map)

            The parameters for SQL Server.

            • Host — required — (String)

              Host.

            • Port — required — (Integer)

              Port.

            • Database — required — (String)

              Database.

          • TeradataParameters — (map)

            The parameters for Teradata.

            • Host — required — (String)

              Host.

            • Port — required — (Integer)

              Port.

            • Database — required — (String)

              Database.

          • TwitterParameters — (map)

            The parameters for Twitter.

            • Query — required — (String)

              Twitter query string.

            • MaxRows — required — (Integer)

              Maximum number of rows to query Twitter.

          • AmazonOpenSearchParameters — (map)
            • Domain — required — (String)
      • CopySourceArn — (String)

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

    • VpcConnectionProperties — (map)

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

      • VpcConnectionArn — required — (String)

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

    • SslProperties — (map)

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

      • DisableSsl — (Boolean)

        A Boolean option to control whether SSL should be disabled.

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) of the data source.

      • DataSourceId — (String)

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

      • 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"
        • "DELETED"
      • RequestId — (String)

        The Amazon Web Services 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.

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 Amazon Web Services account ID.

    • DataSourceId — (String)

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

    • GrantPermissions — (Array<map>)

      A list of resource permissions that you want to grant on the data source.

      • Principal — required — (String)

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

        • The ARN of an Amazon QuickSight user or group associated with a data source or dataset. (This is common.)

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

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

      • Actions — required — (Array<String>)

        The IAMaction to grant or revoke permissions on.

    • RevokePermissions — (Array<map>)

      A list of resource permissions that you want to revoke on the data source.

      • Principal — required — (String)

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

        • The ARN of an Amazon QuickSight user or group associated with a data source or dataset. (This is common.)

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

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

      • Actions — required — (Array<String>)

        The IAMaction to grant or revoke permissions on.

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 Amazon Resource Name (ARN) of the data source.

      • DataSourceId — (String)

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

      • RequestId — (String)

        The Amazon Web Services 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.

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

Updates the name of a folder.

Service Reference:

Examples:

Calling the updateFolder operation

var params = {
  AwsAccountId: 'STRING_VALUE', /* required */
  FolderId: 'STRING_VALUE', /* required */
  Name: 'STRING_VALUE' /* required */
};
quicksight.updateFolder(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.

    • FolderId — (String)

      The folder ID.

    • Name — (String)

      The name of the folder.

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 status. If succeeded, the status is SC_OK.

      • Arn — (String)

        The Amazon Resource Name (ARN).

      • FolderId — (String)

        The folder ID.

      • RequestId — (String)

        The request ID.

Returns:

  • (AWS.Request) —

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

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

Updates permissions of a folder.

Service Reference:

Examples:

Calling the updateFolderPermissions operation

var params = {
  AwsAccountId: 'STRING_VALUE', /* required */
  FolderId: '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.updateFolderPermissions(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.

    • FolderId — (String)

      The folder ID.

    • GrantPermissions — (Array<map>)

      The permissions that you want to grant on a resource.

      • Principal — required — (String)

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

        • The ARN of an Amazon QuickSight user or group associated with a data source or dataset. (This is common.)

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

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

      • Actions — required — (Array<String>)

        The IAMaction to grant or revoke permissions on.

    • RevokePermissions — (Array<map>)

      The permissions that you want to revoke from a resource.

      • Principal — required — (String)

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

        • The ARN of an Amazon QuickSight user or group associated with a data source or dataset. (This is common.)

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

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

      • Actions — required — (Array<String>)

        The IAMaction to grant or revoke permissions on.

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 status. If succeeded, the status is SC_OK.

      • Arn — (String)

        The Amazon Resource Name (ARN).

      • FolderId — (String)

        The folder ID.

      • Permissions — (Array<map>)

        Information about the permissions on the dashboard.

        • Principal — required — (String)

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

          • The ARN of an Amazon QuickSight user or group associated with a data source or dataset. (This is common.)

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

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

        • Actions — required — (Array<String>)

          The IAMaction to grant or revoke permissions on.

      • RequestId — (String)

        The request ID.

Returns:

  • (AWS.Request) —

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

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

Changes a group description.

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 Amazon Web Services account that the group is in. Currently, you use the ID for the Amazon Web Services 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 Amazon Web Services 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 IAMpolicy assignment. This operation updates only the optional parameter or parameters that are specified in the request. This overwrites all of the users included in Identities.

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 ID of the Amazon Web Services account that contains the IAMpolicy assignment.

    • AssignmentName — (String)

      The name of the assignment, also called a rule. This name must be unique within an Amazon Web Services account.

    • Namespace — (String)

      The namespace of the assignment.

    • AssignmentStatus — (String)

      The status of the assignment. Possible values are as follows:

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

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

      • DRAFT - This assignment is an unfinished draft and isn't used when creating the data source.

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

      The ARN for the IAMpolicy to apply to the Amazon QuickSight users and groups specified in this assignment.

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

      The Amazon QuickSight users, groups, or both that you want to assign the policy to.

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 or rule.

      • AssignmentId — (String)

        The ID of the assignment.

      • PolicyArn — (String)

        The ARN for the IAMpolicy applied to the Amazon QuickSight users and groups specified in this assignment.

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

        The Amazon QuickSight users, groups, or both that the IAMpolicy is assigned to.

      • AssignmentStatus — (String)

        The status of the assignment. Possible values are as follows:

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

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

        • DRAFT - This assignment is an unfinished draft and isn't used when creating the data source.

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

        The Amazon Web Services 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.

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

Updates content and status of IP Rules.

Service Reference:

Examples:

Calling the updateIpRestriction operation

var params = {
  AwsAccountId: 'STRING_VALUE', /* required */
  Enabled: true || false,
  IpRestrictionRuleMap: {
    '<CIDR>': 'STRING_VALUE',
    /* '<CIDR>': ... */
  }
};
quicksight.updateIpRestriction(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)

      Your AWS account ID.

    • IpRestrictionRuleMap — (map<String>)

      Describes updated IP rules.

    • Enabled — (Boolean)

      Whether or not IP rules are enabled.

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:

      • AwsAccountId — (String)

        Your AWS account ID.

      • RequestId — (String)

        The ID of the update request.

      • Status — (Integer)

        The status of the updated IP rules. A successful request returns a 200 code.

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 Amazon QuickSight analysis or another template.

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)

      The ID of the Amazon Web Services account that contains the template that you're updating.

    • TemplateId — (String)

      The ID for the template.

    • SourceEntity — (map)

      The entity that you are using as a source when you update the template. In SourceEntity, you specify the type of object you're using as source: SourceTemplate for a template or SourceAnalysis for an analysis. Both of these require an Amazon Resource Name (ARN). For SourceTemplate, specify the ARN of the source template. For SourceAnalysis, specify the ARN of the source analysis. The SourceTemplate ARN can contain any Amazon Web Services account and any Amazon QuickSight-supported Amazon Web Services Region;.

      Use the DataSetReferences entity within SourceTemplate or SourceAnalysis to list the replacement datasets for the placeholders listed in the original. The schema in each dataset must match its placeholder.

      • SourceAnalysis — (map)

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

        • Arn — required — (String)

          The Amazon Resource Name (ARN) of the resource.

        • DataSetReferences — required — (Array<map>)

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

          • DataSetPlaceholder — required — (String)

            Dataset placeholder.

          • DataSetArn — required — (String)

            Dataset Amazon Resource Name (ARN).

      • SourceTemplate — (map)

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

        • Arn — required — (String)

          The Amazon Resource Name (ARN) of the resource.

    • VersionDescription — (String)

      A description of the current template version that is being updated. Every time you call UpdateTemplate, you create a new version of the template. 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 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"
        • "DELETED"
      • Status — (Integer)

        The HTTP status of the request.

      • RequestId — (String)

        The Amazon Web Services 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.

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)

      The ID of the Amazon Web Services account that contains the template alias that you're updating.

    • TemplateId — (String)

      The ID for the template.

    • AliasName — (String)

      The alias of the template that you want to update. If you name a specific alias, you update the version that the alias points to. You can specify the latest version of the template by providing the keyword $LATEST in the AliasName parameter. The keyword $PUBLISHED doesn't apply to templates.

    • 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 Amazon Resource Name (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 Amazon Web Services 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 resource permissions for a template.

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)

      The ID of the Amazon Web Services account 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.

      • Principal — required — (String)

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

        • The ARN of an Amazon QuickSight user or group associated with a data source or dataset. (This is common.)

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

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

      • Actions — required — (Array<String>)

        The IAMaction to grant or revoke permissions on.

    • RevokePermissions — (Array<map>)

      A list of resource permissions to be revoked from the template.

      • Principal — required — (String)

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

        • The ARN of an Amazon QuickSight user or group associated with a data source or dataset. (This is common.)

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

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

      • Actions — required — (Array<String>)

        The IAMaction to grant or revoke permissions on.

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 Amazon Resource Name (ARN) of the template.

      • Permissions — (Array<map>)

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

        • Principal — required — (String)

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

          • The ARN of an Amazon QuickSight user or group associated with a data source or dataset. (This is common.)

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

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

        • Actions — required — (Array<String>)

          The IAMaction to grant or revoke permissions on.

      • RequestId — (String)

        The Amazon Web Services 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.

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

Updates a theme.

Service Reference:

Examples:

Calling the updateTheme operation

var params = {
  AwsAccountId: 'STRING_VALUE', /* required */
  BaseThemeId: 'STRING_VALUE', /* required */
  ThemeId: 'STRING_VALUE', /* required */
  Configuration: {
    DataColorPalette: {
      Colors: [
        'STRING_VALUE',
        /* more items */
      ],
      EmptyFillColor: 'STRING_VALUE',
      MinMaxGradient: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    Sheet: {
      Tile: {
        Border: {
          Show: true || false
        }
      },
      TileLayout: {
        Gutter: {
          Show: true || false
        },
        Margin: {
          Show: true || false
        }
      }
    },
    UIColorPalette: {
      Accent: 'STRING_VALUE',
      AccentForeground: 'STRING_VALUE',
      Danger: 'STRING_VALUE',
      DangerForeground: 'STRING_VALUE',
      Dimension: 'STRING_VALUE',
      DimensionForeground: 'STRING_VALUE',
      Measure: 'STRING_VALUE',
      MeasureForeground: 'STRING_VALUE',
      PrimaryBackground: 'STRING_VALUE',
      PrimaryForeground: 'STRING_VALUE',
      SecondaryBackground: 'STRING_VALUE',
      SecondaryForeground: 'STRING_VALUE',
      Success: 'STRING_VALUE',
      SuccessForeground: 'STRING_VALUE',
      Warning: 'STRING_VALUE',
      WarningForeground: 'STRING_VALUE'
    }
  },
  Name: 'STRING_VALUE',
  VersionDescription: 'STRING_VALUE'
};
quicksight.updateTheme(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 of the Amazon Web Services account that contains the theme that you're updating.

    • ThemeId — (String)

      The ID for the theme.

    • Name — (String)

      The name for the theme.

    • BaseThemeId — (String)

      The theme ID, defined by Amazon QuickSight, that a custom theme inherits from. All themes initially inherit from a default Amazon QuickSight theme.

    • VersionDescription — (String)

      A description of the theme version that you're updating Every time that you call UpdateTheme, you create a new version of the theme. Each version of the theme maintains a description of the version in VersionDescription.

    • Configuration — (map)

      The theme configuration, which contains the theme display properties.

      • DataColorPalette — (map)

        Color properties that apply to chart data colors.

        • Colors — (Array<String>)

          The hexadecimal codes for the colors.

        • MinMaxGradient — (Array<String>)

          The minimum and maximum hexadecimal codes that describe a color gradient.

        • EmptyFillColor — (String)

          The hexadecimal code of a color that applies to charts where a lack of data is highlighted.

      • UIColorPalette — (map)

        Color properties that apply to the UI and to charts, excluding the colors that apply to data.

        • PrimaryForeground — (String)

          The color of text and other foreground elements that appear over the primary background regions, such as grid lines, borders, table banding, icons, and so on.

        • PrimaryBackground — (String)

          The background color that applies to visuals and other high emphasis UI.

        • SecondaryForeground — (String)

          The foreground color that applies to any sheet title, sheet control text, or UI that appears over the secondary background.

        • SecondaryBackground — (String)

          The background color that applies to the sheet background and sheet controls.

        • Accent — (String)

          This color is that applies to selected states and buttons.

        • AccentForeground — (String)

          The foreground color that applies to any text or other elements that appear over the accent color.

        • Danger — (String)

          The color that applies to error messages.

        • DangerForeground — (String)

          The foreground color that applies to any text or other elements that appear over the error color.

        • Warning — (String)

          This color that applies to warning and informational messages.

        • WarningForeground — (String)

          The foreground color that applies to any text or other elements that appear over the warning color.

        • Success — (String)

          The color that applies to success messages, for example the check mark for a successful download.

        • SuccessForeground — (String)

          The foreground color that applies to any text or other elements that appear over the success color.

        • Dimension — (String)

          The color that applies to the names of fields that are identified as dimensions.

        • DimensionForeground — (String)

          The foreground color that applies to any text or other elements that appear over the dimension color.

        • Measure — (String)

          The color that applies to the names of fields that are identified as measures.

        • MeasureForeground — (String)

          The foreground color that applies to any text or other elements that appear over the measure color.

      • Sheet — (map)

        Display options related to sheets.

        • Tile — (map)

          The display options for tiles.

          • Border — (map)

            The border around a tile.

            • Show — (Boolean)

              The option to enable display of borders for visuals.

        • TileLayout — (map)

          The layout options for tiles.

          • Gutter — (map)

            The gutter settings that apply between tiles.

            • Show — (Boolean)

              This Boolean value controls whether to display a gutter space between sheet tiles.

          • Margin — (map)

            The margin settings that apply around the outside edge of sheets.

            • Show — (Boolean)

              This Boolean value controls whether to display sheet margins.

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:

      • ThemeId — (String)

        The ID for the theme.

      • Arn — (String)

        The Amazon Resource Name (ARN) for the theme.

      • VersionArn — (String)

        The Amazon Resource Name (ARN) for the new version of the theme.

      • CreationStatus — (String)

        The creation status of the theme.

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

        The HTTP status of the request.

      • RequestId — (String)

        The Amazon Web Services request ID for this operation.

Returns:

  • (AWS.Request) —

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

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

Updates an alias of a theme.

Service Reference:

Examples:

Calling the updateThemeAlias operation

var params = {
  AliasName: 'STRING_VALUE', /* required */
  AwsAccountId: 'STRING_VALUE', /* required */
  ThemeId: 'STRING_VALUE', /* required */
  ThemeVersionNumber: 'NUMBER_VALUE' /* required */
};
quicksight.updateThemeAlias(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 of the Amazon Web Services account that contains the theme alias that you're updating.

    • ThemeId — (String)

      The ID for the theme.

    • AliasName — (String)

      The name of the theme alias that you want to update.

    • ThemeVersionNumber — (Integer)

      The version number of the theme that the alias should reference.

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:

      • ThemeAlias — (map)

        Information about the theme alias.

        • Arn — (String)

          The Amazon Resource Name (ARN) of the theme alias.

        • AliasName — (String)

          The display name of the theme alias.

        • ThemeVersionNumber — (Integer)

          The version number of the theme alias.

      • Status — (Integer)

        The HTTP status of the request.

      • RequestId — (String)

        The Amazon Web Services request ID for this operation.

Returns:

  • (AWS.Request) —

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

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

Updates the resource permissions for a theme. Permissions apply to the action to grant or revoke permissions on, for example "quicksight:DescribeTheme".

Theme permissions apply in groupings. Valid groupings include the following for the three levels of permissions, which are user, owner, or no permissions:

  • User

    • "quicksight:DescribeTheme"

    • "quicksight:DescribeThemeAlias"

    • "quicksight:ListThemeAliases"

    • "quicksight:ListThemeVersions"

  • Owner

    • "quicksight:DescribeTheme"

    • "quicksight:DescribeThemeAlias"

    • "quicksight:ListThemeAliases"

    • "quicksight:ListThemeVersions"

    • "quicksight:DeleteTheme"

    • "quicksight:UpdateTheme"

    • "quicksight:CreateThemeAlias"

    • "quicksight:DeleteThemeAlias"

    • "quicksight:UpdateThemeAlias"

    • "quicksight:UpdateThemePermissions"

    • "quicksight:DescribeThemePermissions"

  • To specify no permissions, omit the permissions list.

Service Reference:

Examples:

Calling the updateThemePermissions operation

var params = {
  AwsAccountId: 'STRING_VALUE', /* required */
  ThemeId: '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.updateThemePermissions(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 of the Amazon Web Services account that contains the theme.

    • ThemeId — (String)

      The ID for the theme.

    • GrantPermissions — (Array<map>)

      A list of resource permissions to be granted for the theme.

      • Principal — required — (String)

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

        • The ARN of an Amazon QuickSight user or group associated with a data source or dataset. (This is common.)

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

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

      • Actions — required — (Array<String>)

        The IAMaction to grant or revoke permissions on.

    • RevokePermissions — (Array<map>)

      A list of resource permissions to be revoked from the theme.

      • Principal — required — (String)

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

        • The ARN of an Amazon QuickSight user or group associated with a data source or dataset. (This is common.)

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

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

      • Actions — required — (Array<String>)

        The IAMaction to grant or revoke permissions on.

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:

      • ThemeId — (String)

        The ID for the theme.

      • ThemeArn — (String)

        The Amazon Resource Name (ARN) of the theme.

      • Permissions — (Array<map>)

        The resulting list of resource permissions for the theme.

        • Principal — required — (String)

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

          • The ARN of an Amazon QuickSight user or group associated with a data source or dataset. (This is common.)

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

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

        • Actions — required — (Array<String>)

          The IAMaction to grant or revoke permissions on.

      • RequestId — (String)

        The Amazon Web Services 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.

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 */
  CustomFederationProviderUrl: 'STRING_VALUE',
  CustomPermissionsName: 'STRING_VALUE',
  ExternalLoginFederationProviderType: 'STRING_VALUE',
  ExternalLoginId: 'STRING_VALUE',
  UnapplyCustomPermissions: true || false
};
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 Amazon Web Services account that the user is in. Currently, you use the ID for the Amazon Web Services 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 role can be one of the following default security cohorts:

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

      The name of the Amazon QuickSight role is invisible to the user except for the console screens dealing with permissions.

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

      (Enterprise edition only) The name of the custom permissions profile that you want to assign to this user. Customized permissions allows you to control a user's access by restricting access the following operations:

      • Create and update data sources

      • Create and update datasets

      • Create and update email reports

      • Subscribe to email reports

      A set of custom permissions includes any combination of these restrictions. Currently, you need to create the profile names for custom permission sets by using the Amazon QuickSight console. Then, you use the RegisterUser API operation to assign the named set of permissions to a Amazon QuickSight user.

      Amazon QuickSight custom permissions are applied through IAMpolicies. Therefore, they override the permissions typically granted by assigning Amazon QuickSight users to one of the default security cohorts in Amazon QuickSight (admin, author, reader).

      This feature is available only to Amazon QuickSight Enterprise edition subscriptions.

    • UnapplyCustomPermissions — (Boolean)

      A flag that you use to indicate that you want to remove all custom permissions from this user. Using this parameter resets the user to the state it was in before a custom permissions profile was applied. This parameter defaults to NULL and it doesn't accept any other value.

    • ExternalLoginFederationProviderType — (String)

      The type of supported external login provider that provides identity to let a user federate into Amazon QuickSight with an associated Identity and Access Management(IAM) role. The type of supported external login provider can be one of the following.

      • COGNITO: Amazon Cognito. The provider URL is cognito-identity.amazonaws.com. When choosing the COGNITO provider type, don’t use the "CustomFederationProviderUrl" parameter which is only needed when the external provider is custom.

      • CUSTOM_OIDC: Custom OpenID Connect (OIDC) provider. When choosing CUSTOM_OIDC type, use the CustomFederationProviderUrl parameter to provide the custom OIDC provider URL.

      • NONE: This clears all the previously saved external login information for a user. Use DescribeUser API to check the external login information.

    • CustomFederationProviderUrl — (String)

      The URL of the custom OpenID Connect (OIDC) provider that provides identity to let a user federate into Amazon QuickSight with an associated Identity and Access Management(IAM) role. This parameter should only be used when ExternalLoginFederationProviderType parameter is set to CUSTOM_OIDC.

    • ExternalLoginId — (String)

      The identity ID for a user in the external login provider.

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

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

        • PrincipalId — (String)

          The principal ID of the user.

        • CustomPermissionsName — (String)

          The custom permissions profile associated with this user.

        • ExternalLoginFederationProviderType — (String)

          The type of supported external login provider that provides identity to let the user federate into Amazon QuickSight with an associated IAMrole. The type can be one of the following.

          • COGNITO: Amazon Cognito. The provider URL is cognito-identity.amazonaws.com.

          • CUSTOM_OIDC: Custom OpenID Connect (OIDC) provider.

        • ExternalLoginFederationProviderUrl — (String)

          The URL of the external login provider.

        • ExternalLoginId — (String)

          The identity ID for the user in the external login provider.

      • RequestId — (String)

        The Amazon Web Services 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.