Class: AWS.QuickSight

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

Overview

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

Service Description

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

Sending a Request Using QuickSight

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

Locking the API Version

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

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

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

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

var quicksight = new AWS.QuickSight();

Version:

  • 2018-04-01

Constructor Summary collapse

Property Summary collapse

Properties inherited from AWS.Service

apiVersions

Method Summary collapse

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService

Constructor Details

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

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

Examples:

Constructing a QuickSight object

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

Options Hash (options):

  • params (map)

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

  • endpoint (String)

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

  • accessKeyId (String)

    your AWS access key ID.

  • secretAccessKey (String)

    your AWS secret access key.

  • sessionToken (AWS.Credentials)

    the optional AWS session token to sign requests with.

  • credentials (AWS.Credentials)

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

  • credentialProvider (AWS.CredentialProviderChain)

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

  • region (String)

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

  • maxRetries (Integer)

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

  • maxRedirects (Integer)

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

  • sslEnabled (Boolean)

    whether to enable SSL for requests.

  • paramValidation (Boolean|map)

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

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

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

  • convertResponseTypes (Boolean)

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

  • correctClockSkew (Boolean)

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

  • s3ForcePathStyle (Boolean)

    whether to force path style URLs for S3 objects.

  • s3BucketEndpoint (Boolean)

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

  • s3DisableBodySigning (Boolean)

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

  • retryDelayOptions (map)

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

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

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

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

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

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

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

  • logger (#write, #log)

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

  • systemClockOffset (Number)

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

  • signatureVersion (String)

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

  • signatureCache (Boolean)

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

  • dynamoDbCrc32 (Boolean)

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

  • useAccelerateEndpoint (Boolean)

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

  • clientSideMonitoring (Boolean)

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

  • endpointDiscoveryEnabled (Boolean)

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

  • endpointCacheSize (Number)

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

  • hostPrefixEnabled (Boolean)

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

Property Details

endpointAWS.Endpoint (readwrite)

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

Returns:

  • (AWS.Endpoint)

    an Endpoint object representing the endpoint URL for service requests.

Method Details

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

Creates an Amazon QuickSight group.

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

The response is a group object.

CLI Sample:

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

Service Reference:

Examples:

Calling the createGroup operation

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

Parameters:

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

      A name for the group that you want to create.

    • Description — (String)

      A description for the group that you want to create.

    • AwsAccountId — (String)

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

    • Namespace — (String)

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

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

    • data (Object)

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

      • Group — (map)

        The name of the group.

        • Arn — (String)

          The Amazon Resource Name (ARN) for the group.

        • GroupName — (String)

          The name of the group.

        • Description — (String)

          The group description.

        • PrincipalId — (String)

          The principal ID of the group.

      • RequestId — (String)

        The AWS request ID for this operation.

      • Status — (Integer)

        The http status of the request.

Returns:

  • (AWS.Request)

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

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

Adds an Amazon QuickSight user to an Amazon QuickSight group.

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

The condition resource is the user name.

The condition key is quicksight:UserName.

The response is the group member object.

CLI Sample:

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

Service Reference:

Examples:

Calling the createGroupMembership operation

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

Parameters:

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

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

    • GroupName — (String)

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

    • AwsAccountId — (String)

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

    • Namespace — (String)

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

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

    • data (Object)

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

      • GroupMember — (map)

        The group member.

        • Arn — (String)

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

        • MemberName — (String)

          The name of the group member (user).

      • RequestId — (String)

        The AWS request ID for this operation.

      • Status — (Integer)

        The http status of the request.

Returns:

  • (AWS.Request)

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

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

Removes a user group from Amazon QuickSight.

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

CLI Sample:

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

Service Reference:

Examples:

Calling the deleteGroup operation

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

Parameters:

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

      The name of the group that you want to delete.

    • AwsAccountId — (String)

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

    • Namespace — (String)

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

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

    • data (Object)

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

      • RequestId — (String)

        The AWS request ID for this operation.

      • Status — (Integer)

        The http status of the request.

Returns:

  • (AWS.Request)

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

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

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

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

The condition resource is the user name.

The condition key is quicksight:UserName.

CLI Sample:

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

Service Reference:

Examples:

Calling the deleteGroupMembership operation

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

Parameters:

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

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

    • GroupName — (String)

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

    • AwsAccountId — (String)

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

    • Namespace — (String)

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

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

    • data (Object)

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

      • RequestId — (String)

        The AWS request ID for this operation.

      • Status — (Integer)

        The http status of the request.

Returns:

  • (AWS.Request)

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

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

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

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

CLI Sample:

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

Service Reference:

Examples:

Calling the deleteUser operation

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

Parameters:

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

      The name of the user that you want to delete.

    • AwsAccountId — (String)

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

    • Namespace — (String)

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

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

    • data (Object)

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

      • RequestId — (String)

        The AWS request ID for this operation.

      • Status — (Integer)

        The http status of the request.

Returns:

  • (AWS.Request)

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

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

Deletes a user after locating the user 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 AWS account that the user is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.

    • Namespace — (String)

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

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

    • data (Object)

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

      • RequestId — (String)

        The AWS request ID for this operation.

      • Status — (Integer)

        The http status of the request.

Returns:

  • (AWS.Request)

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

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

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

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

The response is the group object.

CLI Sample:

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

Service Reference:

Examples:

Calling the describeGroup operation

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

Parameters:

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

      The name of the group that you want to describe.

    • AwsAccountId — (String)

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

    • Namespace — (String)

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

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

    • data (Object)

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

      • Group — (map)

        The name of the group.

        • Arn — (String)

          The Amazon Resource Name (ARN) for the group.

        • GroupName — (String)

          The name of the group.

        • Description — (String)

          The group description.

        • PrincipalId — (String)

          The principal ID of the group.

      • RequestId — (String)

        The AWS request ID for this operation.

      • Status — (Integer)

        The http status of the request.

Returns:

  • (AWS.Request)

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

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

Returns information about a user, given the user name.

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

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

CLI Sample:

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

Service Reference:

Examples:

Calling the describeUser operation

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

Parameters:

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

      The name of the user that you want to describe.

    • AwsAccountId — (String)

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

    • Namespace — (String)

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

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

    • data (Object)

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

      • User — (map)

        The user name.

        • Arn — (String)

          The Amazon Resource Name (ARN) for the user.

        • UserName — (String)

          The user's user name.

        • Email — (String)

          The user's email address.

        • Role — (String)

          The Amazon QuickSight role for the user.

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

          The type of identity authentication used by the user.

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

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

        • PrincipalId — (String)

          The principal ID of the user.

      • RequestId — (String)

        The AWS request ID for this operation.

      • Status — (Integer)

        The http status of the request.

Returns:

  • (AWS.Request)

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

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

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

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

CLI Sample:

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

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

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

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

Get the URL for the embedded dashboard

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

Service Reference:

Examples:

Calling the getDashboardEmbedUrl operation

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

Parameters:

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

      AWS account ID that contains the dashboard you are embedding.

    • DashboardId — (String)

      The ID for the dashboard, also added to IAM policy

    • IdentityType — (String)

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

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

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

    • UndoRedoDisabled — (Boolean)

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

    • ResetDisabled — (Boolean)

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

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

    • data (Object)

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

      • EmbedUrl — (String)

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

      • Status — (Integer)

        The http status of the request.

      • RequestId — (String)

        The AWS request ID for this operation.

Returns:

  • (AWS.Request)

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

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

Lists member users in a group.

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

The response is a list of group member objects.

CLI Sample:

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

Service Reference:

Examples:

Calling the listGroupMemberships operation

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

Parameters:

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

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

    • NextToken — (String)

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

    • MaxResults — (Integer)

      The maximum number of results to return from this request.

    • AwsAccountId — (String)

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

    • Namespace — (String)

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

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

    • data (Object)

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

      • GroupMemberList — (Array<map>)

        The list of the members of the group.

        • Arn — (String)

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

        • MemberName — (String)

          The name of the group member (user).

      • NextToken — (String)

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

      • RequestId — (String)

        The AWS request ID for this operation.

      • Status — (Integer)

        The http status of the request.

Returns:

  • (AWS.Request)

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

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

Lists all user groups in Amazon QuickSight.

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

The response is a list of group objects.

CLI Sample:

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

Service Reference:

Examples:

Calling the listGroups operation

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

Parameters:

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

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

    • NextToken — (String)

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

    • MaxResults — (Integer)

      The maximum number of results to return.

    • Namespace — (String)

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

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

    • data (Object)

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

      • GroupList — (Array<map>)

        The list of the groups.

        • Arn — (String)

          The Amazon Resource Name (ARN) for the group.

        • GroupName — (String)

          The name of the group.

        • Description — (String)

          The group description.

        • PrincipalId — (String)

          The principal ID of the group.

      • NextToken — (String)

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

      • RequestId — (String)

        The AWS request ID for this operation.

      • Status — (Integer)

        The http status of the request.

Returns:

  • (AWS.Request)

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

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

Lists the Amazon QuickSight groups that an Amazon QuickSight user is a member of.

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

The response is a one or more group objects.

CLI Sample:

aws quicksight list-user-groups --user-name=Pat --aws-account-id=111122223333 --namespace=default --region=us-east-1

Service Reference:

Examples:

Calling the listUserGroups operation

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

Parameters:

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

      The Amazon QuickSight user name that you want to list group memberships for.

    • AwsAccountId — (String)

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

    • Namespace — (String)

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

    • NextToken — (String)

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

    • MaxResults — (Integer)

      The maximum number of results to return from this request.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

    • data (Object)

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

      • GroupList — (Array<map>)

        The list of groups the user is a member of.

        • Arn — (String)

          The Amazon Resource Name (ARN) for the group.

        • GroupName — (String)

          The name of the group.

        • Description — (String)

          The group description.

        • PrincipalId — (String)

          The principal ID of the group.

      • NextToken — (String)

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

      • RequestId — (String)

        The AWS request ID for this operation.

      • Status — (Integer)

        The HTTP status of the request.

Returns:

  • (AWS.Request)

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

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

Returns a list of all of the Amazon QuickSight users belonging to this account.

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

The response is a list of user objects, containing each user's Amazon Resource Name (ARN), AWS Identity and Access Management (IAM) role, and email address.

CLI Sample:

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

Service Reference:

Examples:

Calling the listUsers operation

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

Parameters:

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

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

    • NextToken — (String)

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

    • MaxResults — (Integer)

      The maximum number of results to return from this request.

    • Namespace — (String)

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

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

    • data (Object)

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

      • UserList — (Array<map>)

        The list of users.

        • Arn — (String)

          The Amazon Resource Name (ARN) for the user.

        • UserName — (String)

          The user's user name.

        • Email — (String)

          The user's email address.

        • Role — (String)

          The Amazon QuickSight role for the user.

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

          The type of identity authentication used by the user.

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

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

        • PrincipalId — (String)

          The principal ID of the user.

      • NextToken — (String)

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

      • RequestId — (String)

        The AWS request ID for this operation.

      • Status — (Integer)

        The http status of the request.

Returns:

  • (AWS.Request)

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

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

Creates an Amazon QuickSight user, whose identity is associated with the AWS Identity and Access Management (IAM) identity or role specified in the request.

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

The condition resource is the Amazon Resource Name (ARN) for the IAM user or role, and the session name.

The condition keys are quicksight:IamArn and quicksight:SessionName.

CLI Sample:

aws quicksight register-user --aws-account-id=111122223333 --namespace=default --email=pat@example.com --identity-type=IAM --user-role=AUTHOR --iam-arn=arn:aws:iam::111122223333:user/Pat

Service Reference:

Examples:

Calling the registerUser operation

var params = {
  AwsAccountId: 'STRING_VALUE', /* required */
  Email: 'STRING_VALUE', /* required */
  IdentityType: IAM | QUICKSIGHT, /* required */
  Namespace: 'STRING_VALUE', /* required */
  UserRole: ADMIN | AUTHOR | READER | RESTRICTED_AUTHOR | RESTRICTED_READER, /* required */
  IamArn: 'STRING_VALUE',
  SessionName: 'STRING_VALUE',
  UserName: 'STRING_VALUE'
};
quicksight.registerUser(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

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

      Amazon QuickSight supports several ways of managing the identity of users. This parameter accepts two values:

      • IAM: A user whose identity maps to an existing IAM user or role.

      • QUICKSIGHT: A user whose identity is owned and managed internally by Amazon QuickSight.

      Possible values include:
      • "IAM"
      • "QUICKSIGHT"
    • Email — (String)

      The email address of the user that you want to register.

    • UserRole — (String)

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

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

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

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

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

      The ARN of the IAM user or role that you are registering with Amazon QuickSight.

    • SessionName — (String)

      The name of the session with the assumed IAM role. By using this parameter, you can register multiple users with the same IAM role, provided that each has a different session name. For more information on assuming IAM roles, see assume-role in the AWS CLI Reference.

    • AwsAccountId — (String)

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

    • Namespace — (String)

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

    • UserName — (String)

      The Amazon QuickSight user name that you want to create for the user you are registering.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

    • data (Object)

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

      • User — (map)

        The user name.

        • Arn — (String)

          The Amazon Resource Name (ARN) for the user.

        • UserName — (String)

          The user's user name.

        • Email — (String)

          The user's email address.

        • Role — (String)

          The Amazon QuickSight role for the user.

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

          The type of identity authentication used by the user.

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

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

        • PrincipalId — (String)

          The principal ID of the user.

      • UserInvitationUrl — (String)

        The URL the user visits to complete registration and provide a password. This is returned only for users with an identity type of QUICKSIGHT.

      • RequestId — (String)

        The AWS request ID for this operation.

      • Status — (Integer)

        The http status of the request.

Returns:

  • (AWS.Request)

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

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

Changes a group description.

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

The response is a group object.

CLI Sample:

aws quicksight update-group --aws-account-id=111122223333 --namespace=default --group-name=Sales --description="Sales BI Dashboards"

Service Reference:

Examples:

Calling the updateGroup operation

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

Parameters:

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

      The name of the group that you want to update.

    • Description — (String)

      The description for the group that you want to update.

    • AwsAccountId — (String)

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

    • Namespace — (String)

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

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

    • data (Object)

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

      • Group — (map)

        The name of the group.

        • Arn — (String)

          The Amazon Resource Name (ARN) for the group.

        • GroupName — (String)

          The name of the group.

        • Description — (String)

          The group description.

        • PrincipalId — (String)

          The principal ID of the group.

      • RequestId — (String)

        The AWS request ID for this operation.

      • Status — (Integer)

        The http status of the request.

Returns:

  • (AWS.Request)

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

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

Updates an Amazon QuickSight user.

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

The response is a user object that contains the user's Amazon QuickSight user name, email address, active or inactive status in Amazon QuickSight, Amazon QuickSight role, and Amazon Resource Name (ARN).

CLI Sample:

aws quicksight update-user --user-name=Pat --role=ADMIN --email=new_address@amazon.com --aws-account-id=111122223333 --namespace=default --region=us-east-1

Service Reference:

Examples:

Calling the updateUser operation

var params = {
  AwsAccountId: 'STRING_VALUE', /* required */
  Email: 'STRING_VALUE', /* required */
  Namespace: 'STRING_VALUE', /* required */
  Role: ADMIN | AUTHOR | READER | RESTRICTED_AUTHOR | RESTRICTED_READER, /* required */
  UserName: 'STRING_VALUE' /* required */
};
quicksight.updateUser(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

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

      The Amazon QuickSight user name that you want to update.

    • AwsAccountId — (String)

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

    • Namespace — (String)

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

    • Email — (String)

      The email address of the user that you want to update.

    • Role — (String)

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

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

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

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

      Possible values include:
      • "ADMIN"
      • "AUTHOR"
      • "READER"
      • "RESTRICTED_AUTHOR"
      • "RESTRICTED_READER"

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

    • data (Object)

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

      • User — (map)

        The Amazon QuickSight user.

        • Arn — (String)

          The Amazon Resource Name (ARN) for the user.

        • UserName — (String)

          The user's user name.

        • Email — (String)

          The user's email address.

        • Role — (String)

          The Amazon QuickSight role for the user.

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

          The type of identity authentication used by the user.

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

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

        • PrincipalId — (String)

          The principal ID of the user.

      • RequestId — (String)

        The AWS request ID for this operation.

      • Status — (Integer)

        The http status of the request.

Returns:

  • (AWS.Request)

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