Class: Aws::QuickSight::Client

Inherits:
Seahorse::Client::Base show all
Includes:
ClientStubs
Defined in:
gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb

Overview

An API client for QuickSight. To construct a client, you need to configure a :region and :credentials.

client = Aws::QuickSight::Client.new(
  region: region_name,
  credentials: credentials,
  # ...
)

For details on configuring region and credentials see the developer guide.

See #initialize for a full list of supported configuration options.

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

#config, #handlers

API Operations collapse

Instance Method Summary collapse

Methods included from ClientStubs

#api_requests, #stub_data, #stub_responses

Methods inherited from Seahorse::Client::Base

add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins

Methods included from Seahorse::Client::HandlerBuilder

#handle, #handle_request, #handle_response

Constructor Details

#initialize(options) ⇒ Client

Returns a new instance of Client.

Parameters:

  • options (Hash)

Options Hash (options):

  • :credentials (required, Aws::CredentialProvider)

    Your AWS credentials. This can be an instance of any one of the following classes:

    • Aws::Credentials - Used for configuring static, non-refreshing credentials.

    • Aws::InstanceProfileCredentials - Used for loading credentials from an EC2 IMDS on an EC2 instance.

    • Aws::SharedCredentials - Used for loading credentials from a shared file, such as ~/.aws/config.

    • Aws::AssumeRoleCredentials - Used when you need to assume a role.

    When :credentials are not configured directly, the following locations will be searched for credentials:

    • Aws.config[:credentials]
    • The :access_key_id, :secret_access_key, and :session_token options.
    • ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
    • ~/.aws/credentials
    • ~/.aws/config
    • EC2 IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of Aws::InstanceProfileCredentails to enable retries and extended timeouts.
  • :region (required, String)

    The AWS region to connect to. The configured :region is used to determine the service :endpoint. When not passed, a default :region is searched for in the following locations:

    • Aws.config[:region]
    • ENV['AWS_REGION']
    • ENV['AMAZON_REGION']
    • ENV['AWS_DEFAULT_REGION']
    • ~/.aws/credentials
    • ~/.aws/config
  • :access_key_id (String)
  • :active_endpoint_cache (Boolean) — default: false

    When set to true, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to false.

  • :adaptive_retry_wait_to_fill (Boolean) — default: true

    Used only in adaptive retry mode. When true, the request will sleep until there is sufficent client side capacity to retry the request. When false, the request will raise a RetryCapacityNotAvailableError and will not retry instead of sleeping.

  • :client_side_monitoring (Boolean) — default: false

    When true, client-side metrics will be collected for all API requests from this client.

  • :client_side_monitoring_client_id (String) — default: ""

    Allows you to provide an identifier for this client which will be attached to all generated client side metrics. Defaults to an empty string.

  • :client_side_monitoring_host (String) — default: "127.0.0.1"

    Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_port (Integer) — default: 31000

    Required for publishing client metrics. The port that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher) — default: Aws::ClientSideMonitoring::Publisher

    Allows you to provide a custom client-side monitoring publisher class. By default, will use the Client Side Monitoring Agent Publisher.

  • :convert_params (Boolean) — default: true

    When true, an attempt is made to coerce request parameters into the required types.

  • :correct_clock_skew (Boolean) — default: true

    Used only in standard and adaptive retry modes. Specifies whether to apply a clock skew correction and retry requests with skewed client clocks.

  • :disable_host_prefix_injection (Boolean) — default: false

    Set to true to disable SDK automatically adding host prefix to default service endpoint when available.

  • :endpoint (String)

    The client endpoint is normally constructed from the :region option. You should only configure an :endpoint when connecting to test or custom endpoints. This should be a valid HTTP(S) URI.

  • :endpoint_cache_max_entries (Integer) — default: 1000

    Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000.

  • :endpoint_cache_max_threads (Integer) — default: 10

    Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.

  • :endpoint_cache_poll_interval (Integer) — default: 60

    When :endpoint_discovery and :active_endpoint_cache is enabled, Use this option to config the time interval in seconds for making requests fetching endpoints information. Defaults to 60 sec.

  • :endpoint_discovery (Boolean) — default: false

    When set to true, endpoint discovery will be enabled for operations when available.

  • :log_formatter (Aws::Log::Formatter) — default: Aws::Log::Formatter.default

    The log formatter.

  • :log_level (Symbol) — default: :info

    The log level to send messages to the :logger at.

  • :logger (Logger)

    The Logger instance to send log messages to. If this option is not set, logging will be disabled.

  • :max_attempts (Integer) — default: 3

    An integer representing the maximum number attempts that will be made for a single request, including the initial attempt. For example, setting this value to 5 will result in a request being retried up to 4 times. Used in standard and adaptive retry modes.

  • :profile (String) — default: "default"

    Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, 'default' is used.

  • :retry_backoff (Proc)

    A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay. This option is only used in the legacy retry mode.

  • :retry_base_delay (Float) — default: 0.3

    The base delay in seconds used by the default backoff function. This option is only used in the legacy retry mode.

  • :retry_jitter (Symbol) — default: :none

    A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number. This option is only used in the legacy retry mode.

    @see https://www.awsarchitectureblog.com/2015/03/backoff.html

  • :retry_limit (Integer) — default: 3

    The maximum number of times to retry failed requests. Only ~ 500 level server errors and certain ~ 400 level client errors are retried. Generally, these are throttling errors, data checksum errors, networking errors, timeout errors, auth errors, endpoint discovery, and errors from expired credentials. This option is only used in the legacy retry mode.

  • :retry_max_delay (Integer) — default: 0

    The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function. This option is only used in the legacy retry mode.

  • :retry_mode (String) — default: "legacy"

    Specifies which retry algorithm to use. Values are:

    • legacy - The pre-existing retry behavior. This is default value if no retry mode is provided.

    • standard - A standardized set of retry rules across the AWS SDKs. This includes support for retry quotas, which limit the number of unsuccessful retries a client can make.

    • adaptive - An experimental retry mode that includes all the functionality of standard mode along with automatic client side throttling. This is a provisional mode that may change behavior in the future.

  • :secret_access_key (String)
  • :session_token (String)
  • :stub_responses (Boolean) — default: false

    Causes the client to return stubbed responses. By default fake responses are generated and returned. You can specify the response data to return or errors to raise by calling ClientStubs#stub_responses. See ClientStubs for more information.

    Please note When response stubbing is enabled, no HTTP requests are made, and retries are disabled.

  • :validate_params (Boolean) — default: true

    When true, request parameters are validated before sending the request.

  • :http_proxy (URI::HTTP, String)

    A proxy to send requests through. Formatted like 'http://proxy.com:123'.

  • :http_open_timeout (Float) — default: 15

    The number of seconds to wait when opening a HTTP session before raising a Timeout::Error.

  • :http_read_timeout (Integer) — default: 60

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_idle_timeout (Float) — default: 5

    The number of seconds a connection is allowed to sit idle before it is considered stale. Stale connections are closed and removed from the pool before making a request.

  • :http_continue_timeout (Float) — default: 1

    The number of seconds to wait for a 100-continue response before sending the request body. This option has no effect unless the request has "Expect" header set to "100-continue". Defaults to nil which disables this behaviour. This value can safely be set per request on the session.

  • :http_wire_trace (Boolean) — default: false

    When true, HTTP debug output will be sent to the :logger.

  • :ssl_verify_peer (Boolean) — default: true

    When true, SSL peer certificates are verified when establishing a connection.

  • :ssl_ca_bundle (String)

    Full path to the SSL certificate authority bundle file that should be used when verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.

  • :ssl_ca_directory (String)

    Full path of the directory that contains the unbundled SSL certificate authority files for verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.



309
310
311
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 309

def initialize(*args)
  super
end

Instance Method Details

#cancel_ingestion(params = {}) ⇒ Types::CancelIngestionResponse

Cancels an ongoing ingestion of data into SPICE.

Examples:

Request syntax with placeholder values


resp = client.cancel_ingestion({
  aws_account_id: "AwsAccountId", # required
  data_set_id: "string", # required
  ingestion_id: "IngestionId", # required
})

Response structure


resp.arn #=> String
resp.ingestion_id #=> String
resp.request_id #=> String
resp.status #=> Integer

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :aws_account_id (required, String)

    The AWS account ID.

  • :data_set_id (required, String)

    The ID of the dataset used in the ingestion.

  • :ingestion_id (required, String)

    An ID for the ingestion.

Returns:

See Also:



352
353
354
355
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 352

def cancel_ingestion(params = {}, options = {})
  req = build_request(:cancel_ingestion, params)
  req.send_request(options)
end

#create_account_customization(params = {}) ⇒ Types::CreateAccountCustomizationResponse

Creates a customization for the Amazon QuickSight subscription associated with your AWS account.

Examples:

Request syntax with placeholder values


resp = client.({
  aws_account_id: "AwsAccountId", # required
  namespace: "Namespace",
  account_customization: { # required
    default_theme: "Arn",
  },
})

Response structure


resp. #=> String
resp.namespace #=> String
resp..default_theme #=> String
resp.request_id #=> String
resp.status #=> Integer

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :aws_account_id (required, String)

    The ID for the AWS account that you want to customize QuickSight for.

  • :namespace (String)

    The namespace associated with the customization that you're creating.

  • :account_customization (required, Types::AccountCustomization)

    The customizations you're adding to the QuickSight subscription for the AWS account. For example, you could add a default theme by setting AccountCustomization to the midnight theme (DefaultTheme="arn:aws:quicksight::aws:theme/MIDNIGHT") or to a custom theme (DefaultTheme="arn:aws:quicksight:us-west-2:111122223333:theme/bdb844d0-0fe9-4d9d-b520-0fe602d93639").

Returns:

See Also:



404
405
406
407
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 404

def (params = {}, options = {})
  req = build_request(:create_account_customization, params)
  req.send_request(options)
end

#create_dashboard(params = {}) ⇒ Types::CreateDashboardResponse

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

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

Examples:

Request syntax with placeholder values


resp = client.create_dashboard({
  aws_account_id: "AwsAccountId", # required
  dashboard_id: "RestrictiveResourceId", # required
  name: "DashboardName", # required
  parameters: {
    string_parameters: [
      {
        name: "NonEmptyString", # required
        values: ["String"], # required
      },
    ],
    integer_parameters: [
      {
        name: "NonEmptyString", # required
        values: [1], # required
      },
    ],
    decimal_parameters: [
      {
        name: "NonEmptyString", # required
        values: [1.0], # required
      },
    ],
    date_time_parameters: [
      {
        name: "NonEmptyString", # required
        values: [Time.now], # required
      },
    ],
  },
  permissions: [
    {
      principal: "Principal", # required
      actions: ["String"], # required
    },
  ],
  source_entity: { # required
    source_template: {
      data_set_references: [ # required
        {
          data_set_placeholder: "NonEmptyString", # required
          data_set_arn: "Arn", # required
        },
      ],
      arn: "Arn", # required
    },
  },
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
  version_description: "VersionDescription",
  dashboard_publish_options: {
    ad_hoc_filtering_option: {
      availability_status: "ENABLED", # accepts ENABLED, DISABLED
    },
    export_to_csv_option: {
      availability_status: "ENABLED", # accepts ENABLED, DISABLED
    },
    sheet_controls_option: {
      visibility_state: "EXPANDED", # accepts EXPANDED, COLLAPSED
    },
  },
  theme_arn: "Arn",
})

Response structure


resp.arn #=> String
resp.version_arn #=> String
resp.dashboard_id #=> String
resp.creation_status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED"
resp.status #=> Integer
resp.request_id #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :aws_account_id (required, String)

    The ID of the AWS account where you want to create the dashboard.

  • :dashboard_id (required, String)

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

  • :name (required, String)

    The display name of the dashboard.

  • :parameters (Types::Parameters)

    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.

  • :permissions (Array<Types::ResourcePermission>)

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

  • :source_entity (required, Types::DashboardSourceEntity)

    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 AWS Account and any QuickSight-supported AWS 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.

  • :tags (Array<Types::Tag>)

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

  • :version_description (String)

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

  • :dashboard_publish_options (Types::DashboardPublishOptions)

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

  • :theme_arn (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 AWS account where you create the dashboard.

Returns:

See Also:



577
578
579
580
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 577

def create_dashboard(params = {}, options = {})
  req = build_request(:create_dashboard, params)
  req.send_request(options)
end

#create_data_set(params = {}) ⇒ Types::CreateDataSetResponse

Creates a dataset.

Examples:

Request syntax with placeholder values


resp = client.create_data_set({
  aws_account_id: "AwsAccountId", # required
  data_set_id: "ResourceId", # required
  name: "ResourceName", # required
  physical_table_map: { # required
    "PhysicalTableId" => {
      relational_table: {
        data_source_arn: "Arn", # required
        schema: "RelationalTableSchema",
        name: "RelationalTableName", # required
        input_columns: [ # required
          {
            name: "ColumnName", # required
            type: "STRING", # required, accepts STRING, INTEGER, DECIMAL, DATETIME, BIT, BOOLEAN, JSON
          },
        ],
      },
      custom_sql: {
        data_source_arn: "Arn", # required
        name: "CustomSqlName", # required
        sql_query: "SqlQuery", # required
        columns: [
          {
            name: "ColumnName", # required
            type: "STRING", # required, accepts STRING, INTEGER, DECIMAL, DATETIME, BIT, BOOLEAN, JSON
          },
        ],
      },
      s3_source: {
        data_source_arn: "Arn", # required
        upload_settings: {
          format: "CSV", # accepts CSV, TSV, CLF, ELF, XLSX, JSON
          start_from_row: 1,
          contains_header: false,
          text_qualifier: "DOUBLE_QUOTE", # accepts DOUBLE_QUOTE, SINGLE_QUOTE
          delimiter: "Delimiter",
        },
        input_columns: [ # required
          {
            name: "ColumnName", # required
            type: "STRING", # required, accepts STRING, INTEGER, DECIMAL, DATETIME, BIT, BOOLEAN, JSON
          },
        ],
      },
    },
  },
  logical_table_map: {
    "LogicalTableId" => {
      alias: "LogicalTableAlias", # required
      data_transforms: [
        {
          project_operation: {
            projected_columns: ["String"], # required
          },
          filter_operation: {
            condition_expression: "Expression", # required
          },
          create_columns_operation: {
            columns: [ # required
              {
                column_name: "ColumnName", # required
                column_id: "ColumnId", # required
                expression: "Expression", # required
              },
            ],
          },
          rename_column_operation: {
            column_name: "ColumnName", # required
            new_column_name: "ColumnName", # required
          },
          cast_column_type_operation: {
            column_name: "ColumnName", # required
            new_column_type: "STRING", # required, accepts STRING, INTEGER, DECIMAL, DATETIME
            format: "TypeCastFormat",
          },
          tag_column_operation: {
            column_name: "ColumnName", # required
            tags: [ # required
              {
                column_geographic_role: "COUNTRY", # accepts COUNTRY, STATE, COUNTY, CITY, POSTCODE, LONGITUDE, LATITUDE
              },
            ],
          },
        },
      ],
      source: { # required
        join_instruction: {
          left_operand: "LogicalTableId", # required
          right_operand: "LogicalTableId", # required
          type: "INNER", # required, accepts INNER, OUTER, LEFT, RIGHT
          on_clause: "OnClause", # required
        },
        physical_table_id: "PhysicalTableId",
      },
    },
  },
  import_mode: "SPICE", # required, accepts SPICE, DIRECT_QUERY
  column_groups: [
    {
      geo_spatial_column_group: {
        name: "ColumnGroupName", # required
        country_code: "US", # required, accepts US
        columns: ["ColumnName"], # required
      },
    },
  ],
  permissions: [
    {
      principal: "Principal", # required
      actions: ["String"], # required
    },
  ],
  row_level_permission_data_set: {
    namespace: "Namespace",
    arn: "Arn", # required
    permission_policy: "GRANT_ACCESS", # required, accepts GRANT_ACCESS, DENY_ACCESS
  },
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
})

Response structure


resp.arn #=> String
resp.data_set_id #=> String
resp.ingestion_arn #=> String
resp.ingestion_id #=> String
resp.request_id #=> String
resp.status #=> Integer

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :aws_account_id (required, String)

    The AWS account ID.

  • :data_set_id (required, String)

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

  • :name (required, String)

    The display name for the dataset.

  • :physical_table_map (required, Hash<String,Types::PhysicalTable>)

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

  • :logical_table_map (Hash<String,Types::LogicalTable>)

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

  • :import_mode (required, String)

    Indicates whether you want to import the data into SPICE.

  • :column_groups (Array<Types::ColumnGroup>)

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

  • :permissions (Array<Types::ResourcePermission>)

    A list of resource permissions on the dataset.

  • :row_level_permission_data_set (Types::RowLevelPermissionDataSet)

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

  • :tags (Array<Types::Tag>)

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

Returns:

See Also:



769
770
771
772
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 769

def create_data_set(params = {}, options = {})
  req = build_request(:create_data_set, params)
  req.send_request(options)
end

#create_data_source(params = {}) ⇒ Types::CreateDataSourceResponse

Creates a data source.

Examples:

Request syntax with placeholder values


resp = client.create_data_source({
  aws_account_id: "AwsAccountId", # required
  data_source_id: "ResourceId", # required
  name: "ResourceName", # required
  type: "ADOBE_ANALYTICS", # required, accepts ADOBE_ANALYTICS, AMAZON_ELASTICSEARCH, ATHENA, AURORA, AURORA_POSTGRESQL, AWS_IOT_ANALYTICS, GITHUB, JIRA, MARIADB, MYSQL, POSTGRESQL, PRESTO, REDSHIFT, S3, SALESFORCE, SERVICENOW, SNOWFLAKE, SPARK, SQLSERVER, TERADATA, TWITTER
  data_source_parameters: {
    amazon_elasticsearch_parameters: {
      domain: "Domain", # required
    },
    athena_parameters: {
      work_group: "WorkGroup",
    },
    aurora_parameters: {
      host: "Host", # required
      port: 1, # required
      database: "Database", # required
    },
    aurora_postgre_sql_parameters: {
      host: "Host", # required
      port: 1, # required
      database: "Database", # required
    },
    aws_iot_analytics_parameters: {
      data_set_name: "DataSetName", # required
    },
    jira_parameters: {
      site_base_url: "SiteBaseUrl", # required
    },
    maria_db_parameters: {
      host: "Host", # required
      port: 1, # required
      database: "Database", # required
    },
    my_sql_parameters: {
      host: "Host", # required
      port: 1, # required
      database: "Database", # required
    },
    postgre_sql_parameters: {
      host: "Host", # required
      port: 1, # required
      database: "Database", # required
    },
    presto_parameters: {
      host: "Host", # required
      port: 1, # required
      catalog: "Catalog", # required
    },
    rds_parameters: {
      instance_id: "InstanceId", # required
      database: "Database", # required
    },
    redshift_parameters: {
      host: "Host",
      port: 1,
      database: "Database", # required
      cluster_id: "ClusterId",
    },
    s3_parameters: {
      manifest_file_location: { # required
        bucket: "S3Bucket", # required
        key: "S3Key", # required
      },
    },
    service_now_parameters: {
      site_base_url: "SiteBaseUrl", # required
    },
    snowflake_parameters: {
      host: "Host", # required
      database: "Database", # required
      warehouse: "Warehouse", # required
    },
    spark_parameters: {
      host: "Host", # required
      port: 1, # required
    },
    sql_server_parameters: {
      host: "Host", # required
      port: 1, # required
      database: "Database", # required
    },
    teradata_parameters: {
      host: "Host", # required
      port: 1, # required
      database: "Database", # required
    },
    twitter_parameters: {
      query: "Query", # required
      max_rows: 1, # required
    },
  },
  credentials: {
    credential_pair: {
      username: "Username", # required
      password: "Password", # required
      alternate_data_source_parameters: [
        {
          amazon_elasticsearch_parameters: {
            domain: "Domain", # required
          },
          athena_parameters: {
            work_group: "WorkGroup",
          },
          aurora_parameters: {
            host: "Host", # required
            port: 1, # required
            database: "Database", # required
          },
          aurora_postgre_sql_parameters: {
            host: "Host", # required
            port: 1, # required
            database: "Database", # required
          },
          aws_iot_analytics_parameters: {
            data_set_name: "DataSetName", # required
          },
          jira_parameters: {
            site_base_url: "SiteBaseUrl", # required
          },
          maria_db_parameters: {
            host: "Host", # required
            port: 1, # required
            database: "Database", # required
          },
          my_sql_parameters: {
            host: "Host", # required
            port: 1, # required
            database: "Database", # required
          },
          postgre_sql_parameters: {
            host: "Host", # required
            port: 1, # required
            database: "Database", # required
          },
          presto_parameters: {
            host: "Host", # required
            port: 1, # required
            catalog: "Catalog", # required
          },
          rds_parameters: {
            instance_id: "InstanceId", # required
            database: "Database", # required
          },
          redshift_parameters: {
            host: "Host",
            port: 1,
            database: "Database", # required
            cluster_id: "ClusterId",
          },
          s3_parameters: {
            manifest_file_location: { # required
              bucket: "S3Bucket", # required
              key: "S3Key", # required
            },
          },
          service_now_parameters: {
            site_base_url: "SiteBaseUrl", # required
          },
          snowflake_parameters: {
            host: "Host", # required
            database: "Database", # required
            warehouse: "Warehouse", # required
          },
          spark_parameters: {
            host: "Host", # required
            port: 1, # required
          },
          sql_server_parameters: {
            host: "Host", # required
            port: 1, # required
            database: "Database", # required
          },
          teradata_parameters: {
            host: "Host", # required
            port: 1, # required
            database: "Database", # required
          },
          twitter_parameters: {
            query: "Query", # required
            max_rows: 1, # required
          },
        },
      ],
    },
    copy_source_arn: "CopySourceArn",
  },
  permissions: [
    {
      principal: "Principal", # required
      actions: ["String"], # required
    },
  ],
  vpc_connection_properties: {
    vpc_connection_arn: "Arn", # required
  },
  ssl_properties: {
    disable_ssl: false,
  },
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
})

Response structure


resp.arn #=> String
resp.data_source_id #=> String
resp.creation_status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED"
resp.request_id #=> String
resp.status #=> Integer

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :aws_account_id (required, String)

    The AWS account ID.

  • :data_source_id (required, String)

    An ID for the data source. This ID is unique per AWS Region for each AWS account.

  • :name (required, String)

    A display name for the data source.

  • :type (required, String)

    The type of the data source. Currently, the supported types for this operation are: ATHENA, AURORA, AURORA_POSTGRESQL, MARIADB, MYSQL, POSTGRESQL, PRESTO, REDSHIFT, S3, SNOWFLAKE, SPARK, SQLSERVER, TERADATA. Use ListDataSources to return a list of all data sources.

  • :data_source_parameters (Types::DataSourceParameters)

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

  • :credentials (Types::DataSourceCredentials)

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

  • :permissions (Array<Types::ResourcePermission>)

    A list of resource permissions on the data source.

  • :vpc_connection_properties (Types::VpcConnectionProperties)

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

  • :ssl_properties (Types::SslProperties)

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

  • :tags (Array<Types::Tag>)

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

Returns:

See Also:



1044
1045
1046
1047
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 1044

def create_data_source(params = {}, options = {})
  req = build_request(:create_data_source, params)
  req.send_request(options)
end

#create_group(params = {}) ⇒ Types::CreateGroupResponse

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.

Examples:

Request syntax with placeholder values


resp = client.create_group({
  group_name: "GroupName", # required
  description: "GroupDescription",
  aws_account_id: "AwsAccountId", # required
  namespace: "Namespace", # required
})

Response structure


resp.group.arn #=> String
resp.group.group_name #=> String
resp.group.description #=> String
resp.group.principal_id #=> String
resp.request_id #=> String
resp.status #=> Integer

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :group_name (required, String)

    A name for the group that you want to create.

  • :description (String)

    A description for the group that you want to create.

  • :aws_account_id (required, 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 (required, String)

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

Returns:

See Also:



1099
1100
1101
1102
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 1099

def create_group(params = {}, options = {})
  req = build_request(:create_group, params)
  req.send_request(options)
end

#create_group_membership(params = {}) ⇒ Types::CreateGroupMembershipResponse

Adds an Amazon QuickSight user to an Amazon QuickSight group.

Examples:

Request syntax with placeholder values


resp = client.create_group_membership({
  member_name: "GroupMemberName", # required
  group_name: "GroupName", # required
  aws_account_id: "AwsAccountId", # required
  namespace: "Namespace", # required
})

Response structure


resp.group_member.arn #=> String
resp.group_member.member_name #=> String
resp.request_id #=> String
resp.status #=> Integer

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :member_name (required, String)

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

  • :group_name (required, String)

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

  • :aws_account_id (required, 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 (required, String)

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

Returns:

See Also:



1146
1147
1148
1149
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 1146

def create_group_membership(params = {}, options = {})
  req = build_request(:create_group_membership, params)
  req.send_request(options)
end

#create_iam_policy_assignment(params = {}) ⇒ Types::CreateIAMPolicyAssignmentResponse

Creates an assignment with one specified IAM policy, identified by its Amazon Resource Name (ARN). This policy will be assigned to specified groups or users of Amazon QuickSight. The users and groups need to be in the same namespace.

Examples:

Request syntax with placeholder values


resp = client.create_iam_policy_assignment({
  aws_account_id: "AwsAccountId", # required
  assignment_name: "IAMPolicyAssignmentName", # required
  assignment_status: "ENABLED", # required, accepts ENABLED, DRAFT, DISABLED
  policy_arn: "Arn",
  identities: {
    "String" => ["IdentityName"],
  },
  namespace: "Namespace", # required
})

Response structure


resp.assignment_name #=> String
resp.assignment_id #=> String
resp.assignment_status #=> String, one of "ENABLED", "DRAFT", "DISABLED"
resp.policy_arn #=> String
resp.identities #=> Hash
resp.identities["String"] #=> Array
resp.identities["String"][0] #=> String
resp.request_id #=> String
resp.status #=> Integer

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :aws_account_id (required, String)

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

  • :assignment_name (required, String)

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

  • :assignment_status (required, 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.

  • :policy_arn (String)

    The ARN for the IAM policy to apply to the QuickSight users and groups specified in this assignment.

  • :identities (Hash<String,Array>)

    The QuickSight users, groups, or both that you want to assign the policy to.

  • :namespace (required, String)

    The namespace that contains the assignment.

Returns:

See Also:



1225
1226
1227
1228
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 1225

def create_iam_policy_assignment(params = {}, options = {})
  req = build_request(:create_iam_policy_assignment, params)
  req.send_request(options)
end

#create_ingestion(params = {}) ⇒ Types::CreateIngestionResponse

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 AWS Knowledge Center. Tags are visible on the tagged dataset, but not on the ingestion resource.

Examples:

Request syntax with placeholder values


resp = client.create_ingestion({
  data_set_id: "string", # required
  ingestion_id: "IngestionId", # required
  aws_account_id: "AwsAccountId", # required
})

Response structure


resp.arn #=> String
resp.ingestion_id #=> String
resp.ingestion_status #=> String, one of "INITIALIZED", "QUEUED", "RUNNING", "FAILED", "COMPLETED", "CANCELLED"
resp.request_id #=> String
resp.status #=> Integer

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :data_set_id (required, String)

    The ID of the dataset used in the ingestion.

  • :ingestion_id (required, String)

    An ID for the ingestion.

  • :aws_account_id (required, String)

    The AWS account ID.

Returns:

See Also:



1279
1280
1281
1282
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 1279

def create_ingestion(params = {}, options = {})
  req = build_request(:create_ingestion, params)
  req.send_request(options)
end

#create_namespace(params = {}) ⇒ Types::CreateNamespaceResponse

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

A namespace allows you to isolate the 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 AWS account is subscribed to QuickSight. The namespace must be unique within the AWS account. By default, there is a limit of 100 namespaces per AWS account. To increase your limit, create a ticket with AWS Support.

Examples:

Request syntax with placeholder values


resp = client.create_namespace({
  aws_account_id: "AwsAccountId", # required
  namespace: "Namespace", # required
  identity_store: "QUICKSIGHT", # required, accepts QUICKSIGHT
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
})

Response structure


resp.arn #=> String
resp.name #=> String
resp.capacity_region #=> String
resp.creation_status #=> String, one of "CREATED", "CREATING", "DELETING", "RETRYABLE_FAILURE", "NON_RETRYABLE_FAILURE"
resp.identity_store #=> String, one of "QUICKSIGHT"
resp.request_id #=> String
resp.status #=> Integer

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :aws_account_id (required, String)

    The ID for the AWS account that you want to create the QuickSight namespace in.

  • :namespace (required, String)

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

  • :identity_store (required, String)

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

  • :tags (Array<Types::Tag>)

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

Returns:

See Also:



1349
1350
1351
1352
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 1349

def create_namespace(params = {}, options = {})
  req = build_request(:create_namespace, params)
  req.send_request(options)
end

#create_template(params = {}) ⇒ Types::CreateTemplateResponse

Creates a template from an existing QuickSight analysis or template. You can use the resulting template to create a dashboard.

A template is an entity in 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.

Examples:

Request syntax with placeholder values


resp = client.create_template({
  aws_account_id: "AwsAccountId", # required
  template_id: "RestrictiveResourceId", # required
  name: "TemplateName",
  permissions: [
    {
      principal: "Principal", # required
      actions: ["String"], # required
    },
  ],
  source_entity: { # required
    source_analysis: {
      arn: "Arn", # required
      data_set_references: [ # required
        {
          data_set_placeholder: "NonEmptyString", # required
          data_set_arn: "Arn", # required
        },
      ],
    },
    source_template: {
      arn: "Arn", # required
    },
  },
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
  version_description: "VersionDescription",
})

Response structure


resp.arn #=> String
resp.version_arn #=> String
resp.template_id #=> String
resp.creation_status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED"
resp.status #=> Integer
resp.request_id #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :aws_account_id (required, 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.

  • :template_id (required, String)

    An ID for the template that you want to create. This template is unique per AWS Region in each AWS account.

  • :name (String)

    A display name for the template.

  • :permissions (Array<Types::ResourcePermission>)

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

  • :source_entity (required, Types::TemplateSourceEntity)

    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 AWS Account and any QuickSight-supported AWS 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.

  • :tags (Array<Types::Tag>)

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

  • :version_description (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.

Returns:

See Also:



1463
1464
1465
1466
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 1463

def create_template(params = {}, options = {})
  req = build_request(:create_template, params)
  req.send_request(options)
end

#create_template_alias(params = {}) ⇒ Types::CreateTemplateAliasResponse

Creates a template alias for a template.

Examples:

Request syntax with placeholder values


resp = client.create_template_alias({
  aws_account_id: "AwsAccountId", # required
  template_id: "RestrictiveResourceId", # required
  alias_name: "AliasName", # required
  template_version_number: 1, # required
})

Response structure


resp.template_alias.alias_name #=> String
resp.template_alias.arn #=> String
resp.template_alias.template_version_number #=> Integer
resp.status #=> Integer
resp.request_id #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :aws_account_id (required, String)

    The ID of the AWS account that contains the template that you creating an alias for.

  • :template_id (required, String)

    An ID for the template.

  • :alias_name (required, 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 QuickSight.

  • :template_version_number (required, Integer)

    The version number of the template.

Returns:

See Also:



1512
1513
1514
1515
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 1512

def create_template_alias(params = {}, options = {})
  req = build_request(:create_template_alias, params)
  req.send_request(options)
end

#create_theme(params = {}) ⇒ Types::CreateThemeResponse

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.

Examples:

Request syntax with placeholder values


resp = client.create_theme({
  aws_account_id: "AwsAccountId", # required
  theme_id: "RestrictiveResourceId", # required
  name: "ThemeName", # required
  base_theme_id: "RestrictiveResourceId", # required
  version_description: "VersionDescription",
  configuration: { # required
    data_color_palette: {
      colors: ["HexColor"],
      min_max_gradient: ["HexColor"],
      empty_fill_color: "HexColor",
    },
    ui_color_palette: {
      primary_foreground: "HexColor",
      primary_background: "HexColor",
      secondary_foreground: "HexColor",
      secondary_background: "HexColor",
      accent: "HexColor",
      accent_foreground: "HexColor",
      danger: "HexColor",
      danger_foreground: "HexColor",
      warning: "HexColor",
      warning_foreground: "HexColor",
      success: "HexColor",
      success_foreground: "HexColor",
      dimension: "HexColor",
      dimension_foreground: "HexColor",
      measure: "HexColor",
      measure_foreground: "HexColor",
    },
    sheet: {
      tile: {
        border: {
          show: false,
        },
      },
      tile_layout: {
        gutter: {
          show: false,
        },
        margin: {
          show: false,
        },
      },
    },
  },
  permissions: [
    {
      principal: "Principal", # required
      actions: ["String"], # required
    },
  ],
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
})

Response structure


resp.arn #=> String
resp.version_arn #=> String
resp.theme_id #=> String
resp.creation_status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED"
resp.status #=> Integer
resp.request_id #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :aws_account_id (required, String)

    The ID of the AWS account where you want to store the new theme.

  • :theme_id (required, String)

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

  • :name (required, String)

    A display name for the theme.

  • :base_theme_id (required, 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 QuickSight analysis.

  • :version_description (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 (required, Types::ThemeConfiguration)

    The theme configuration, which contains the theme display properties.

  • :permissions (Array<Types::ResourcePermission>)

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

  • :tags (Array<Types::Tag>)

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

Returns:

See Also:



1643
1644
1645
1646
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 1643

def create_theme(params = {}, options = {})
  req = build_request(:create_theme, params)
  req.send_request(options)
end

#create_theme_alias(params = {}) ⇒ Types::CreateThemeAliasResponse

Creates a theme alias for a theme.

Examples:

Request syntax with placeholder values


resp = client.create_theme_alias({
  aws_account_id: "AwsAccountId", # required
  theme_id: "RestrictiveResourceId", # required
  alias_name: "AliasName", # required
  theme_version_number: 1, # required
})

Response structure


resp.theme_alias.arn #=> String
resp.theme_alias.alias_name #=> String
resp.theme_alias.theme_version_number #=> Integer
resp.status #=> Integer
resp.request_id #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :aws_account_id (required, String)

    The ID of the AWS account that contains the theme for the new theme alias.

  • :theme_id (required, String)

    An ID for the theme alias.

  • :alias_name (required, 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.

  • :theme_version_number (required, Integer)

    The version number of the theme.

Returns:

See Also:



1692
1693
1694
1695
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 1692

def create_theme_alias(params = {}, options = {})
  req = build_request(:create_theme_alias, params)
  req.send_request(options)
end

#delete_account_customization(params = {}) ⇒ Types::DeleteAccountCustomizationResponse

Deletes customizations for the QuickSight subscription on your AWS account.

Examples:

Request syntax with placeholder values


resp = client.({
  aws_account_id: "AwsAccountId", # required
  namespace: "Namespace",
})

Response structure


resp.request_id #=> String
resp.status #=> Integer

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :aws_account_id (required, String)

    The ID for the AWS account that you want to delete QuickSight customizations from.

  • :namespace (String)

    The namespace associated with the customization that you're deleting.

Returns:

See Also:



1728
1729
1730
1731
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 1728

def (params = {}, options = {})
  req = build_request(:delete_account_customization, params)
  req.send_request(options)
end

#delete_dashboard(params = {}) ⇒ Types::DeleteDashboardResponse

Deletes a dashboard.

Examples:

Request syntax with placeholder values


resp = client.delete_dashboard({
  aws_account_id: "AwsAccountId", # required
  dashboard_id: "RestrictiveResourceId", # required
  version_number: 1,
})

Response structure


resp.status #=> Integer
resp.arn #=> String
resp.dashboard_id #=> String
resp.request_id #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :aws_account_id (required, String)

    The ID of the AWS account that contains the dashboard that you're deleting.

  • :dashboard_id (required, String)

    The ID for the dashboard.

  • :version_number (Integer)

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

Returns:

See Also:



1772
1773
1774
1775
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 1772

def delete_dashboard(params = {}, options = {})
  req = build_request(:delete_dashboard, params)
  req.send_request(options)
end

#delete_data_set(params = {}) ⇒ Types::DeleteDataSetResponse

Deletes a dataset.

Examples:

Request syntax with placeholder values


resp = client.delete_data_set({
  aws_account_id: "AwsAccountId", # required
  data_set_id: "ResourceId", # required
})

Response structure


resp.arn #=> String
resp.data_set_id #=> String
resp.request_id #=> String
resp.status #=> Integer

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :aws_account_id (required, String)

    The AWS account ID.

  • :data_set_id (required, String)

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

Returns:

See Also:



1811
1812
1813
1814
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 1811

def delete_data_set(params = {}, options = {})
  req = build_request(:delete_data_set, params)
  req.send_request(options)
end

#delete_data_source(params = {}) ⇒ Types::DeleteDataSourceResponse

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

Examples:

Request syntax with placeholder values


resp = client.delete_data_source({
  aws_account_id: "AwsAccountId", # required
  data_source_id: "ResourceId", # required
})

Response structure


resp.arn #=> String
resp.data_source_id #=> String
resp.request_id #=> String
resp.status #=> Integer

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :aws_account_id (required, String)

    The AWS account ID.

  • :data_source_id (required, String)

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

Returns:

See Also:



1851
1852
1853
1854
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 1851

def delete_data_source(params = {}, options = {})
  req = build_request(:delete_data_source, params)
  req.send_request(options)
end

#delete_group(params = {}) ⇒ Types::DeleteGroupResponse

Removes a user group from Amazon QuickSight.

Examples:

Request syntax with placeholder values


resp = client.delete_group({
  group_name: "GroupName", # required
  aws_account_id: "AwsAccountId", # required
  namespace: "Namespace", # required
})

Response structure


resp.request_id #=> String
resp.status #=> Integer

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :group_name (required, String)

    The name of the group that you want to delete.

  • :aws_account_id (required, 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 (required, String)

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

Returns:

See Also:



1891
1892
1893
1894
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 1891

def delete_group(params = {}, options = {})
  req = build_request(:delete_group, params)
  req.send_request(options)
end

#delete_group_membership(params = {}) ⇒ Types::DeleteGroupMembershipResponse

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

Examples:

Request syntax with placeholder values


resp = client.delete_group_membership({
  member_name: "GroupMemberName", # required
  group_name: "GroupName", # required
  aws_account_id: "AwsAccountId", # required
  namespace: "Namespace", # required
})

Response structure


resp.request_id #=> String
resp.status #=> Integer

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :member_name (required, String)

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

  • :group_name (required, String)

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

  • :aws_account_id (required, 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 (required, String)

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

Returns:

See Also:



1937
1938
1939
1940
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 1937

def delete_group_membership(params = {}, options = {})
  req = build_request(:delete_group_membership, params)
  req.send_request(options)
end

#delete_iam_policy_assignment(params = {}) ⇒ Types::DeleteIAMPolicyAssignmentResponse

Deletes an existing IAM policy assignment.

Examples:

Request syntax with placeholder values


resp = client.delete_iam_policy_assignment({
  aws_account_id: "AwsAccountId", # required
  assignment_name: "IAMPolicyAssignmentName", # required
  namespace: "Namespace", # required
})

Response structure


resp.assignment_name #=> String
resp.request_id #=> String
resp.status #=> Integer

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :aws_account_id (required, String)

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

  • :assignment_name (required, String)

    The name of the assignment.

  • :namespace (required, String)

    The namespace that contains the assignment.

Returns:

See Also:



1977
1978
1979
1980
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 1977

def delete_iam_policy_assignment(params = {}, options = {})
  req = build_request(:delete_iam_policy_assignment, params)
  req.send_request(options)
end

#delete_namespace(params = {}) ⇒ Types::DeleteNamespaceResponse

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 APIs for the relevant asset.

Examples:

Request syntax with placeholder values


resp = client.delete_namespace({
  aws_account_id: "AwsAccountId", # required
  namespace: "Namespace", # required
})

Response structure


resp.request_id #=> String
resp.status #=> Integer

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :aws_account_id (required, String)

    The ID for the AWS account that you want to delete the QuickSight namespace from.

  • :namespace (required, String)

    The namespace that you want to delete.

Returns:

See Also:



2015
2016
2017
2018
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 2015

def delete_namespace(params = {}, options = {})
  req = build_request(:delete_namespace, params)
  req.send_request(options)
end

#delete_template(params = {}) ⇒ Types::DeleteTemplateResponse

Deletes a template.

Examples:

Request syntax with placeholder values


resp = client.delete_template({
  aws_account_id: "AwsAccountId", # required
  template_id: "RestrictiveResourceId", # required
  version_number: 1,
})

Response structure


resp.request_id #=> String
resp.arn #=> String
resp.template_id #=> String
resp.status #=> Integer

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :aws_account_id (required, String)

    The ID of the AWS account that contains the template that you're deleting.

  • :template_id (required, String)

    An ID for the template you want to delete.

  • :version_number (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.

Returns:

See Also:



2060
2061
2062
2063
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 2060

def delete_template(params = {}, options = {})
  req = build_request(:delete_template, params)
  req.send_request(options)
end

#delete_template_alias(params = {}) ⇒ Types::DeleteTemplateAliasResponse

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.

Examples:

Request syntax with placeholder values


resp = client.delete_template_alias({
  aws_account_id: "AwsAccountId", # required
  template_id: "RestrictiveResourceId", # required
  alias_name: "AliasName", # required
})

Response structure


resp.status #=> Integer
resp.template_id #=> String
resp.alias_name #=> String
resp.arn #=> String
resp.request_id #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :aws_account_id (required, String)

    The ID of the AWS account that contains the item to delete.

  • :template_id (required, String)

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

  • :alias_name (required, 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.

Returns:

See Also:



2109
2110
2111
2112
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 2109

def delete_template_alias(params = {}, options = {})
  req = build_request(:delete_template_alias, params)
  req.send_request(options)
end

#delete_theme(params = {}) ⇒ Types::DeleteThemeResponse

Deletes a theme.

Examples:

Request syntax with placeholder values


resp = client.delete_theme({
  aws_account_id: "AwsAccountId", # required
  theme_id: "RestrictiveResourceId", # required
  version_number: 1,
})

Response structure


resp.arn #=> String
resp.request_id #=> String
resp.status #=> Integer
resp.theme_id #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :aws_account_id (required, String)

    The ID of the AWS account that contains the theme that you're deleting.

  • :theme_id (required, String)

    An ID for the theme that you want to delete.

  • :version_number (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.

Returns:

See Also:



2155
2156
2157
2158
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 2155

def delete_theme(params = {}, options = {})
  req = build_request(:delete_theme, params)
  req.send_request(options)
end

#delete_theme_alias(params = {}) ⇒ Types::DeleteThemeAliasResponse

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.

Examples:

Request syntax with placeholder values


resp = client.delete_theme_alias({
  aws_account_id: "AwsAccountId", # required
  theme_id: "RestrictiveResourceId", # required
  alias_name: "AliasName", # required
})

Response structure


resp.alias_name #=> String
resp.arn #=> String
resp.request_id #=> String
resp.status #=> Integer
resp.theme_id #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :aws_account_id (required, String)

    The ID of the AWS account that contains the theme alias to delete.

  • :theme_id (required, String)

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

  • :alias_name (required, String)

    The unique name for the theme alias to delete.

Returns:

See Also:



2201
2202
2203
2204
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 2201

def delete_theme_alias(params = {}, options = {})
  req = build_request(:delete_theme_alias, params)
  req.send_request(options)
end

#delete_user(params = {}) ⇒ Types::DeleteUserResponse

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.

Examples:

Request syntax with placeholder values


resp = client.delete_user({
  user_name: "UserName", # required
  aws_account_id: "AwsAccountId", # required
  namespace: "Namespace", # required
})

Response structure


resp.request_id #=> String
resp.status #=> Integer

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :user_name (required, String)

    The name of the user that you want to delete.

  • :aws_account_id (required, 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 (required, String)

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

Returns:

See Also:



2243
2244
2245
2246
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 2243

def delete_user(params = {}, options = {})
  req = build_request(:delete_user, params)
  req.send_request(options)
end

#delete_user_by_principal_id(params = {}) ⇒ Types::DeleteUserByPrincipalIdResponse

Deletes a user identified by its principal ID.

Examples:

Request syntax with placeholder values


resp = client.delete_user_by_principal_id({
  principal_id: "String", # required
  aws_account_id: "AwsAccountId", # required
  namespace: "Namespace", # required
})

Response structure


resp.request_id #=> String
resp.status #=> Integer

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :principal_id (required, String)

    The principal ID of the user.

  • :aws_account_id (required, 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 (required, String)

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

Returns:

See Also:



2282
2283
2284
2285
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 2282

def delete_user_by_principal_id(params = {}, options = {})
  req = build_request(:delete_user_by_principal_id, params)
  req.send_request(options)
end

#describe_account_customization(params = {}) ⇒ Types::DescribeAccountCustomizationResponse

Describes the customizations associated with your AWS account.

Examples:

Request syntax with placeholder values


resp = client.({
  aws_account_id: "AwsAccountId", # required
  namespace: "Namespace",
  resolved: false,
})

Response structure


resp. #=> String
resp.namespace #=> String
resp..default_theme #=> String
resp.request_id #=> String
resp.status #=> Integer

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :aws_account_id (required, String)

    The ID for the AWS account that you want to describe QuickSight customizations for.

  • :namespace (String)

    The namespace associated with the customization that you're describing.

  • :resolved (Boolean)

    The status of the creation of the customization. This is an asynchronous process. A status of CREATED means that your customization is ready to use.

Returns:

See Also:



2330
2331
2332
2333
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 2330

def (params = {}, options = {})
  req = build_request(:describe_account_customization, params)
  req.send_request(options)
end

#describe_account_settings(params = {}) ⇒ Types::DescribeAccountSettingsResponse

Describes the settings that were used when your QuickSight subscription was first created in this AWS Account.

Examples:

Request syntax with placeholder values


resp = client.({
  aws_account_id: "AwsAccountId", # required
})

Response structure


resp.. #=> String
resp..edition #=> String, one of "STANDARD", "ENTERPRISE"
resp..default_namespace #=> String
resp..notification_email #=> String
resp.request_id #=> String
resp.status #=> Integer

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :aws_account_id (required, String)

    The ID for the AWS account that contains the QuickSight namespaces that you want to list.

Returns:

See Also:



2367
2368
2369
2370
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 2367

def (params = {}, options = {})
  req = build_request(:describe_account_settings, params)
  req.send_request(options)
end

#describe_dashboard(params = {}) ⇒ Types::DescribeDashboardResponse

Provides a summary for a dashboard.

Examples:

Request syntax with placeholder values


resp = client.describe_dashboard({
  aws_account_id: "AwsAccountId", # required
  dashboard_id: "RestrictiveResourceId", # required
  version_number: 1,
  alias_name: "AliasName",
})

Response structure


resp.dashboard.dashboard_id #=> String
resp.dashboard.arn #=> String
resp.dashboard.name #=> String
resp.dashboard.version.created_time #=> Time
resp.dashboard.version.errors #=> Array
resp.dashboard.version.errors[0].type #=> String, one of "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"
resp.dashboard.version.errors[0].message #=> String
resp.dashboard.version.version_number #=> Integer
resp.dashboard.version.status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED"
resp.dashboard.version.arn #=> String
resp.dashboard.version.source_entity_arn #=> String
resp.dashboard.version.data_set_arns #=> Array
resp.dashboard.version.data_set_arns[0] #=> String
resp.dashboard.version.description #=> String
resp.dashboard.created_time #=> Time
resp.dashboard.last_published_time #=> Time
resp.dashboard.last_updated_time #=> Time
resp.status #=> Integer
resp.request_id #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :aws_account_id (required, String)

    The ID of the AWS account that contains the dashboard that you're describing.

  • :dashboard_id (required, String)

    The ID for the dashboard.

  • :version_number (Integer)

    The version number for the dashboard. If a version number isn't passed, the latest published dashboard version is described.

  • :alias_name (String)

    The alias name.

Returns:

See Also:



2429
2430
2431
2432
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 2429

def describe_dashboard(params = {}, options = {})
  req = build_request(:describe_dashboard, params)
  req.send_request(options)
end

#describe_dashboard_permissions(params = {}) ⇒ Types::DescribeDashboardPermissionsResponse

Describes read and write permissions for a dashboard.

Examples:

Request syntax with placeholder values


resp = client.describe_dashboard_permissions({
  aws_account_id: "AwsAccountId", # required
  dashboard_id: "RestrictiveResourceId", # required
})

Response structure


resp.dashboard_id #=> String
resp.dashboard_arn #=> String
resp.permissions #=> Array
resp.permissions[0].principal #=> String
resp.permissions[0].actions #=> Array
resp.permissions[0].actions[0] #=> String
resp.status #=> Integer
resp.request_id #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :aws_account_id (required, String)

    The ID of the AWS account that contains the dashboard that you're describing permissions for.

  • :dashboard_id (required, String)

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

Returns:

See Also:



2473
2474
2475
2476
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 2473

def describe_dashboard_permissions(params = {}, options = {})
  req = build_request(:describe_dashboard_permissions, params)
  req.send_request(options)
end

#describe_data_set(params = {}) ⇒ Types::DescribeDataSetResponse

Describes a dataset.

Examples:

Request syntax with placeholder values


resp = client.describe_data_set({
  aws_account_id: "AwsAccountId", # required
  data_set_id: "ResourceId", # required
})

Response structure


resp.data_set.arn #=> String
resp.data_set.data_set_id #=> String
resp.data_set.name #=> String
resp.data_set.created_time #=> Time
resp.data_set.last_updated_time #=> Time
resp.data_set.physical_table_map #=> Hash
resp.data_set.physical_table_map["PhysicalTableId"].relational_table.data_source_arn #=> String
resp.data_set.physical_table_map["PhysicalTableId"].relational_table.schema #=> String
resp.data_set.physical_table_map["PhysicalTableId"].relational_table.name #=> String
resp.data_set.physical_table_map["PhysicalTableId"].relational_table.input_columns #=> Array
resp.data_set.physical_table_map["PhysicalTableId"].relational_table.input_columns[0].name #=> String
resp.data_set.physical_table_map["PhysicalTableId"].relational_table.input_columns[0].type #=> String, one of "STRING", "INTEGER", "DECIMAL", "DATETIME", "BIT", "BOOLEAN", "JSON"
resp.data_set.physical_table_map["PhysicalTableId"].custom_sql.data_source_arn #=> String
resp.data_set.physical_table_map["PhysicalTableId"].custom_sql.name #=> String
resp.data_set.physical_table_map["PhysicalTableId"].custom_sql.sql_query #=> String
resp.data_set.physical_table_map["PhysicalTableId"].custom_sql.columns #=> Array
resp.data_set.physical_table_map["PhysicalTableId"].custom_sql.columns[0].name #=> String
resp.data_set.physical_table_map["PhysicalTableId"].custom_sql.columns[0].type #=> String, one of "STRING", "INTEGER", "DECIMAL", "DATETIME", "BIT", "BOOLEAN", "JSON"
resp.data_set.physical_table_map["PhysicalTableId"].s3_source.data_source_arn #=> String
resp.data_set.physical_table_map["PhysicalTableId"].s3_source.upload_settings.format #=> String, one of "CSV", "TSV", "CLF", "ELF", "XLSX", "JSON"
resp.data_set.physical_table_map["PhysicalTableId"].s3_source.upload_settings.start_from_row #=> Integer
resp.data_set.physical_table_map["PhysicalTableId"].s3_source.upload_settings.contains_header #=> Boolean
resp.data_set.physical_table_map["PhysicalTableId"].s3_source.upload_settings.text_qualifier #=> String, one of "DOUBLE_QUOTE", "SINGLE_QUOTE"
resp.data_set.physical_table_map["PhysicalTableId"].s3_source.upload_settings.delimiter #=> String
resp.data_set.physical_table_map["PhysicalTableId"].s3_source.input_columns #=> Array
resp.data_set.physical_table_map["PhysicalTableId"].s3_source.input_columns[0].name #=> String
resp.data_set.physical_table_map["PhysicalTableId"].s3_source.input_columns[0].type #=> String, one of "STRING", "INTEGER", "DECIMAL", "DATETIME", "BIT", "BOOLEAN", "JSON"
resp.data_set.logical_table_map #=> Hash
resp.data_set.logical_table_map["LogicalTableId"].alias #=> String
resp.data_set.logical_table_map["LogicalTableId"].data_transforms #=> Array
resp.data_set.logical_table_map["LogicalTableId"].data_transforms[0].project_operation.projected_columns #=> Array
resp.data_set.logical_table_map["LogicalTableId"].data_transforms[0].project_operation.projected_columns[0] #=> String
resp.data_set.logical_table_map["LogicalTableId"].data_transforms[0].filter_operation.condition_expression #=> String
resp.data_set.logical_table_map["LogicalTableId"].data_transforms[0].create_columns_operation.columns #=> Array
resp.data_set.logical_table_map["LogicalTableId"].data_transforms[0].create_columns_operation.columns[0].column_name #=> String
resp.data_set.logical_table_map["LogicalTableId"].data_transforms[0].create_columns_operation.columns[0].column_id #=> String
resp.data_set.logical_table_map["LogicalTableId"].data_transforms[0].create_columns_operation.columns[0].expression #=> String
resp.data_set.logical_table_map["LogicalTableId"].data_transforms[0].rename_column_operation.column_name #=> String
resp.data_set.logical_table_map["LogicalTableId"].data_transforms[0].rename_column_operation.new_column_name #=> String
resp.data_set.logical_table_map["LogicalTableId"].data_transforms[0].cast_column_type_operation.column_name #=> String
resp.data_set.logical_table_map["LogicalTableId"].data_transforms[0].cast_column_type_operation.new_column_type #=> String, one of "STRING", "INTEGER", "DECIMAL", "DATETIME"
resp.data_set.logical_table_map["LogicalTableId"].data_transforms[0].cast_column_type_operation.format #=> String
resp.data_set.logical_table_map["LogicalTableId"].data_transforms[0].tag_column_operation.column_name #=> String
resp.data_set.logical_table_map["LogicalTableId"].data_transforms[0].tag_column_operation.tags #=> Array
resp.data_set.logical_table_map["LogicalTableId"].data_transforms[0].tag_column_operation.tags[0].column_geographic_role #=> String, one of "COUNTRY", "STATE", "COUNTY", "CITY", "POSTCODE", "LONGITUDE", "LATITUDE"
resp.data_set.logical_table_map["LogicalTableId"].source.join_instruction.left_operand #=> String
resp.data_set.logical_table_map["LogicalTableId"].source.join_instruction.right_operand #=> String
resp.data_set.logical_table_map["LogicalTableId"].source.join_instruction.type #=> String, one of "INNER", "OUTER", "LEFT", "RIGHT"
resp.data_set.logical_table_map["LogicalTableId"].source.join_instruction.on_clause #=> String
resp.data_set.logical_table_map["LogicalTableId"].source.physical_table_id #=> String
resp.data_set.output_columns #=> Array
resp.data_set.output_columns[0].name #=> String
resp.data_set.output_columns[0].type #=> String, one of "STRING", "INTEGER", "DECIMAL", "DATETIME"
resp.data_set.import_mode #=> String, one of "SPICE", "DIRECT_QUERY"
resp.data_set.consumed_spice_capacity_in_bytes #=> Integer
resp.data_set.column_groups #=> Array
resp.data_set.column_groups[0].geo_spatial_column_group.name #=> String
resp.data_set.column_groups[0].geo_spatial_column_group.country_code #=> String, one of "US"
resp.data_set.column_groups[0].geo_spatial_column_group.columns #=> Array
resp.data_set.column_groups[0].geo_spatial_column_group.columns[0] #=> String
resp.data_set.row_level_permission_data_set.namespace #=> String
resp.data_set.row_level_permission_data_set.arn #=> String
resp.data_set.row_level_permission_data_set.permission_policy #=> String, one of "GRANT_ACCESS", "DENY_ACCESS"
resp.request_id #=> String
resp.status #=> Integer

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :aws_account_id (required, String)

    The AWS account ID.

  • :data_set_id (required, String)

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

Returns:

See Also:



2572
2573
2574
2575
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 2572

def describe_data_set(params = {}, options = {})
  req = build_request(:describe_data_set, params)
  req.send_request(options)
end

#describe_data_set_permissions(params = {}) ⇒ Types::DescribeDataSetPermissionsResponse

Describes the permissions on a dataset.

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

Examples:

Request syntax with placeholder values


resp = client.describe_data_set_permissions({
  aws_account_id: "AwsAccountId", # required
  data_set_id: "ResourceId", # required
})

Response structure


resp.data_set_arn #=> String
resp.data_set_id #=> String
resp.permissions #=> Array
resp.permissions[0].principal #=> String
resp.permissions[0].actions #=> Array
resp.permissions[0].actions[0] #=> String
resp.request_id #=> String
resp.status #=> Integer

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :aws_account_id (required, String)

    The AWS account ID.

  • :data_set_id (required, String)

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

Returns:

See Also:



2619
2620
2621
2622
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 2619

def describe_data_set_permissions(params = {}, options = {})
  req = build_request(:describe_data_set_permissions, params)
  req.send_request(options)
end

#describe_data_source(params = {}) ⇒ Types::DescribeDataSourceResponse

Describes a data source.

Examples:

Request syntax with placeholder values


resp = client.describe_data_source({
  aws_account_id: "AwsAccountId", # required
  data_source_id: "ResourceId", # required
})

Response structure


resp.data_source.arn #=> String
resp.data_source.data_source_id #=> String
resp.data_source.name #=> String
resp.data_source.type #=> String, one of "ADOBE_ANALYTICS", "AMAZON_ELASTICSEARCH", "ATHENA", "AURORA", "AURORA_POSTGRESQL", "AWS_IOT_ANALYTICS", "GITHUB", "JIRA", "MARIADB", "MYSQL", "POSTGRESQL", "PRESTO", "REDSHIFT", "S3", "SALESFORCE", "SERVICENOW", "SNOWFLAKE", "SPARK", "SQLSERVER", "TERADATA", "TWITTER"
resp.data_source.status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED"
resp.data_source.created_time #=> Time
resp.data_source.last_updated_time #=> Time
resp.data_source.data_source_parameters.amazon_elasticsearch_parameters.domain #=> String
resp.data_source.data_source_parameters.athena_parameters.work_group #=> String
resp.data_source.data_source_parameters.aurora_parameters.host #=> String
resp.data_source.data_source_parameters.aurora_parameters.port #=> Integer
resp.data_source.data_source_parameters.aurora_parameters.database #=> String
resp.data_source.data_source_parameters.aurora_postgre_sql_parameters.host #=> String
resp.data_source.data_source_parameters.aurora_postgre_sql_parameters.port #=> Integer
resp.data_source.data_source_parameters.aurora_postgre_sql_parameters.database #=> String
resp.data_source.data_source_parameters.aws_iot_analytics_parameters.data_set_name #=> String
resp.data_source.data_source_parameters.jira_parameters.site_base_url #=> String
resp.data_source.data_source_parameters.maria_db_parameters.host #=> String
resp.data_source.data_source_parameters.maria_db_parameters.port #=> Integer
resp.data_source.data_source_parameters.maria_db_parameters.database #=> String
resp.data_source.data_source_parameters.my_sql_parameters.host #=> String
resp.data_source.data_source_parameters.my_sql_parameters.port #=> Integer
resp.data_source.data_source_parameters.my_sql_parameters.database #=> String
resp.data_source.data_source_parameters.postgre_sql_parameters.host #=> String
resp.data_source.data_source_parameters.postgre_sql_parameters.port #=> Integer
resp.data_source.data_source_parameters.postgre_sql_parameters.database #=> String
resp.data_source.data_source_parameters.presto_parameters.host #=> String
resp.data_source.data_source_parameters.presto_parameters.port #=> Integer
resp.data_source.data_source_parameters.presto_parameters.catalog #=> String
resp.data_source.data_source_parameters.rds_parameters.instance_id #=> String
resp.data_source.data_source_parameters.rds_parameters.database #=> String
resp.data_source.data_source_parameters.redshift_parameters.host #=> String
resp.data_source.data_source_parameters.redshift_parameters.port #=> Integer
resp.data_source.data_source_parameters.redshift_parameters.database #=> String
resp.data_source.data_source_parameters.redshift_parameters.cluster_id #=> String
resp.data_source.data_source_parameters.s3_parameters.manifest_file_location.bucket #=> String
resp.data_source.data_source_parameters.s3_parameters.manifest_file_location.key #=> String
resp.data_source.data_source_parameters.service_now_parameters.site_base_url #=> String
resp.data_source.data_source_parameters.snowflake_parameters.host #=> String
resp.data_source.data_source_parameters.snowflake_parameters.database #=> String
resp.data_source.data_source_parameters.snowflake_parameters.warehouse #=> String
resp.data_source.data_source_parameters.spark_parameters.host #=> String
resp.data_source.data_source_parameters.spark_parameters.port #=> Integer
resp.data_source.data_source_parameters.sql_server_parameters.host #=> String
resp.data_source.data_source_parameters.sql_server_parameters.port #=> Integer
resp.data_source.data_source_parameters.sql_server_parameters.database #=> String
resp.data_source.data_source_parameters.teradata_parameters.host #=> String
resp.data_source.data_source_parameters.teradata_parameters.port #=> Integer
resp.data_source.data_source_parameters.teradata_parameters.database #=> String
resp.data_source.data_source_parameters.twitter_parameters.query #=> String
resp.data_source.data_source_parameters.twitter_parameters.max_rows #=> Integer
resp.data_source.alternate_data_source_parameters #=> Array
resp.data_source.alternate_data_source_parameters[0].amazon_elasticsearch_parameters.domain #=> String
resp.data_source.alternate_data_source_parameters[0].athena_parameters.work_group #=> String
resp.data_source.alternate_data_source_parameters[0].aurora_parameters.host #=> String
resp.data_source.alternate_data_source_parameters[0].aurora_parameters.port #=> Integer
resp.data_source.alternate_data_source_parameters[0].aurora_parameters.database #=> String
resp.data_source.alternate_data_source_parameters[0].aurora_postgre_sql_parameters.host #=> String
resp.data_source.alternate_data_source_parameters[0].aurora_postgre_sql_parameters.port #=> Integer
resp.data_source.alternate_data_source_parameters[0].aurora_postgre_sql_parameters.database #=> String
resp.data_source.alternate_data_source_parameters[0].aws_iot_analytics_parameters.data_set_name #=> String
resp.data_source.alternate_data_source_parameters[0].jira_parameters.site_base_url #=> String
resp.data_source.alternate_data_source_parameters[0].maria_db_parameters.host #=> String
resp.data_source.alternate_data_source_parameters[0].maria_db_parameters.port #=> Integer
resp.data_source.alternate_data_source_parameters[0].maria_db_parameters.database #=> String
resp.data_source.alternate_data_source_parameters[0].my_sql_parameters.host #=> String
resp.data_source.alternate_data_source_parameters[0].my_sql_parameters.port #=> Integer
resp.data_source.alternate_data_source_parameters[0].my_sql_parameters.database #=> String
resp.data_source.alternate_data_source_parameters[0].postgre_sql_parameters.host #=> String
resp.data_source.alternate_data_source_parameters[0].postgre_sql_parameters.port #=> Integer
resp.data_source.alternate_data_source_parameters[0].postgre_sql_parameters.database #=> String
resp.data_source.alternate_data_source_parameters[0].presto_parameters.host #=> String
resp.data_source.alternate_data_source_parameters[0].presto_parameters.port #=> Integer
resp.data_source.alternate_data_source_parameters[0].presto_parameters.catalog #=> String
resp.data_source.alternate_data_source_parameters[0].rds_parameters.instance_id #=> String
resp.data_source.alternate_data_source_parameters[0].rds_parameters.database #=> String
resp.data_source.alternate_data_source_parameters[0].redshift_parameters.host #=> String
resp.data_source.alternate_data_source_parameters[0].redshift_parameters.port #=> Integer
resp.data_source.alternate_data_source_parameters[0].redshift_parameters.database #=> String
resp.data_source.alternate_data_source_parameters[0].redshift_parameters.cluster_id #=> String
resp.data_source.alternate_data_source_parameters[0].s3_parameters.manifest_file_location.bucket #=> String
resp.data_source.alternate_data_source_parameters[0].s3_parameters.manifest_file_location.key #=> String
resp.data_source.alternate_data_source_parameters[0].service_now_parameters.site_base_url #=> String
resp.data_source.alternate_data_source_parameters[0].snowflake_parameters.host #=> String
resp.data_source.alternate_data_source_parameters[0].snowflake_parameters.database #=> String
resp.data_source.alternate_data_source_parameters[0].snowflake_parameters.warehouse #=> String
resp.data_source.alternate_data_source_parameters[0].spark_parameters.host #=> String
resp.data_source.alternate_data_source_parameters[0].spark_parameters.port #=> Integer
resp.data_source.alternate_data_source_parameters[0].sql_server_parameters.host #=> String
resp.data_source.alternate_data_source_parameters[0].sql_server_parameters.port #=> Integer
resp.data_source.alternate_data_source_parameters[0].sql_server_parameters.database #=> String
resp.data_source.alternate_data_source_parameters[0].teradata_parameters.host #=> String
resp.data_source.alternate_data_source_parameters[0].teradata_parameters.port #=> Integer
resp.data_source.alternate_data_source_parameters[0].teradata_parameters.database #=> String
resp.data_source.alternate_data_source_parameters[0].twitter_parameters.query #=> String
resp.data_source.alternate_data_source_parameters[0].twitter_parameters.max_rows #=> Integer
resp.data_source.vpc_connection_properties.vpc_connection_arn #=> String
resp.data_source.ssl_properties.disable_ssl #=> Boolean
resp.data_source.error_info.type #=> String, one of "ACCESS_DENIED", "COPY_SOURCE_NOT_FOUND", "TIMEOUT", "ENGINE_VERSION_NOT_SUPPORTED", "UNKNOWN_HOST", "GENERIC_SQL_FAILURE", "CONFLICT", "UNKNOWN"
resp.data_source.error_info.message #=> String
resp.request_id #=> String
resp.status #=> Integer

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :aws_account_id (required, String)

    The AWS account ID.

  • :data_source_id (required, String)

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

Returns:

See Also:



2755
2756
2757
2758
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 2755

def describe_data_source(params = {}, options = {})
  req = build_request(:describe_data_source, params)
  req.send_request(options)
end

#describe_data_source_permissions(params = {}) ⇒ Types::DescribeDataSourcePermissionsResponse

Describes the resource permissions for a data source.

Examples:

Request syntax with placeholder values


resp = client.describe_data_source_permissions({
  aws_account_id: "AwsAccountId", # required
  data_source_id: "ResourceId", # required
})

Response structure


resp.data_source_arn #=> String
resp.data_source_id #=> String
resp.permissions #=> Array
resp.permissions[0].principal #=> String
resp.permissions[0].actions #=> Array
resp.permissions[0].actions[0] #=> String
resp.request_id #=> String
resp.status #=> Integer

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :aws_account_id (required, String)

    The AWS account ID.

  • :data_source_id (required, String)

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

Returns:

See Also:



2799
2800
2801
2802
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 2799

def describe_data_source_permissions(params = {}, options = {})
  req = build_request(:describe_data_source_permissions, params)
  req.send_request(options)
end

#describe_group(params = {}) ⇒ Types::DescribeGroupResponse

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

Examples:

Request syntax with placeholder values


resp = client.describe_group({
  group_name: "GroupName", # required
  aws_account_id: "AwsAccountId", # required
  namespace: "Namespace", # required
})

Response structure


resp.group.arn #=> String
resp.group.group_name #=> String
resp.group.description #=> String
resp.group.principal_id #=> String
resp.request_id #=> String
resp.status #=> Integer

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :group_name (required, String)

    The name of the group that you want to describe.

  • :aws_account_id (required, 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 (required, String)

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

Returns:

See Also:



2845
2846
2847
2848
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 2845

def describe_group(params = {}, options = {})
  req = build_request(:describe_group, params)
  req.send_request(options)
end

#describe_iam_policy_assignment(params = {}) ⇒ Types::DescribeIAMPolicyAssignmentResponse

Describes an existing IAM policy assignment, as specified by the assignment name.

Examples:

Request syntax with placeholder values


resp = client.describe_iam_policy_assignment({
  aws_account_id: "AwsAccountId", # required
  assignment_name: "IAMPolicyAssignmentName", # required
  namespace: "Namespace", # required
})

Response structure


resp.iam_policy_assignment. #=> String
resp.iam_policy_assignment.assignment_id #=> String
resp.iam_policy_assignment.assignment_name #=> String
resp.iam_policy_assignment.policy_arn #=> String
resp.iam_policy_assignment.identities #=> Hash
resp.iam_policy_assignment.identities["String"] #=> Array
resp.iam_policy_assignment.identities["String"][0] #=> String
resp.iam_policy_assignment.assignment_status #=> String, one of "ENABLED", "DRAFT", "DISABLED"
resp.request_id #=> String
resp.status #=> Integer

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :aws_account_id (required, String)

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

  • :assignment_name (required, String)

    The name of the assignment.

  • :namespace (required, String)

    The namespace that contains the assignment.

Returns:

See Also:



2894
2895
2896
2897
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 2894

def describe_iam_policy_assignment(params = {}, options = {})
  req = build_request(:describe_iam_policy_assignment, params)
  req.send_request(options)
end

#describe_ingestion(params = {}) ⇒ Types::DescribeIngestionResponse

Describes a SPICE ingestion.

Examples:

Request syntax with placeholder values


resp = client.describe_ingestion({
  aws_account_id: "AwsAccountId", # required
  data_set_id: "string", # required
  ingestion_id: "IngestionId", # required
})

Response structure


resp.ingestion.arn #=> String
resp.ingestion.ingestion_id #=> String
resp.ingestion.ingestion_status #=> String, one of "INITIALIZED", "QUEUED", "RUNNING", "FAILED", "COMPLETED", "CANCELLED"
resp.ingestion.error_info.type #=> String, one of "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"
resp.ingestion.error_info.message #=> String
resp.ingestion.row_info.rows_ingested #=> Integer
resp.ingestion.row_info.rows_dropped #=> Integer
resp.ingestion.queue_info.waiting_on_ingestion #=> String
resp.ingestion.queue_info.queued_ingestion #=> String
resp.ingestion.created_time #=> Time
resp.ingestion.ingestion_time_in_seconds #=> Integer
resp.ingestion.ingestion_size_in_bytes #=> Integer
resp.ingestion.request_source #=> String, one of "MANUAL", "SCHEDULED"
resp.ingestion.request_type #=> String, one of "INITIAL_INGESTION", "EDIT", "INCREMENTAL_REFRESH", "FULL_REFRESH"
resp.request_id #=> String
resp.status #=> Integer

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :aws_account_id (required, String)

    The AWS account ID.

  • :data_set_id (required, String)

    The ID of the dataset used in the ingestion.

  • :ingestion_id (required, String)

    An ID for the ingestion.

Returns:

See Also:



2947
2948
2949
2950
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 2947

def describe_ingestion(params = {}, options = {})
  req = build_request(:describe_ingestion, params)
  req.send_request(options)
end

#describe_namespace(params = {}) ⇒ Types::DescribeNamespaceResponse

Describes the current namespace.

Examples:

Request syntax with placeholder values


resp = client.describe_namespace({
  aws_account_id: "AwsAccountId", # required
  namespace: "Namespace", # required
})

Response structure


resp.namespace.name #=> String
resp.namespace.arn #=> String
resp.namespace.capacity_region #=> String
resp.namespace.creation_status #=> String, one of "CREATED", "CREATING", "DELETING", "RETRYABLE_FAILURE", "NON_RETRYABLE_FAILURE"
resp.namespace.identity_store #=> String, one of "QUICKSIGHT"
resp.namespace.namespace_error.type #=> String, one of "PERMISSION_DENIED", "INTERNAL_SERVICE_ERROR"
resp.namespace.namespace_error.message #=> String
resp.request_id #=> String
resp.status #=> Integer

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :aws_account_id (required, String)

    The ID for the AWS account that contains the QuickSight namespace that you want to describe.

  • :namespace (required, String)

    The namespace that you want to describe.

Returns:

See Also:



2990
2991
2992
2993
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 2990

def describe_namespace(params = {}, options = {})
  req = build_request(:describe_namespace, params)
  req.send_request(options)
end

#describe_template(params = {}) ⇒ Types::DescribeTemplateResponse

Describes a template's metadata.

Examples:

Request syntax with placeholder values


resp = client.describe_template({
  aws_account_id: "AwsAccountId", # required
  template_id: "RestrictiveResourceId", # required
  version_number: 1,
  alias_name: "AliasName",
})

Response structure


resp.template.arn #=> String
resp.template.name #=> String
resp.template.version.created_time #=> Time
resp.template.version.errors #=> Array
resp.template.version.errors[0].type #=> String, one of "SOURCE_NOT_FOUND", "DATA_SET_NOT_FOUND", "INTERNAL_FAILURE"
resp.template.version.errors[0].message #=> String
resp.template.version.version_number #=> Integer
resp.template.version.status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED"
resp.template.version.data_set_configurations #=> Array
resp.template.version.data_set_configurations[0].placeholder #=> String
resp.template.version.data_set_configurations[0].data_set_schema.column_schema_list #=> Array
resp.template.version.data_set_configurations[0].data_set_schema.column_schema_list[0].name #=> String
resp.template.version.data_set_configurations[0].data_set_schema.column_schema_list[0].data_type #=> String
resp.template.version.data_set_configurations[0].data_set_schema.column_schema_list[0].geographic_role #=> String
resp.template.version.data_set_configurations[0].column_group_schema_list #=> Array
resp.template.version.data_set_configurations[0].column_group_schema_list[0].name #=> String
resp.template.version.data_set_configurations[0].column_group_schema_list[0].column_group_column_schema_list #=> Array
resp.template.version.data_set_configurations[0].column_group_schema_list[0].column_group_column_schema_list[0].name #=> String
resp.template.version.description #=> String
resp.template.version.source_entity_arn #=> String
resp.template.template_id #=> String
resp.template.last_updated_time #=> Time
resp.template.created_time #=> Time
resp.status #=> Integer
resp.request_id #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :aws_account_id (required, String)

    The ID of the AWS account that contains the template that you're describing.

  • :template_id (required, String)

    The ID for the template.

  • :version_number (Integer) — default: Optional

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

  • :alias_name (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.

Returns:

See Also:



3063
3064
3065
3066
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 3063

def describe_template(params = {}, options = {})
  req = build_request(:describe_template, params)
  req.send_request(options)
end

#describe_template_alias(params = {}) ⇒ Types::DescribeTemplateAliasResponse

Describes the template alias for a template.

Examples:

Request syntax with placeholder values


resp = client.describe_template_alias({
  aws_account_id: "AwsAccountId", # required
  template_id: "RestrictiveResourceId", # required
  alias_name: "AliasName", # required
})

Response structure


resp.template_alias.alias_name #=> String
resp.template_alias.arn #=> String
resp.template_alias.template_version_number #=> Integer
resp.status #=> Integer
resp.request_id #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :aws_account_id (required, String)

    The ID of the AWS account that contains the template alias that you're describing.

  • :template_id (required, String)

    The ID for the template.

  • :alias_name (required, 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.

Returns:

See Also:



3110
3111
3112
3113
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 3110

def describe_template_alias(params = {}, options = {})
  req = build_request(:describe_template_alias, params)
  req.send_request(options)
end

#describe_template_permissions(params = {}) ⇒ Types::DescribeTemplatePermissionsResponse

Describes read and write permissions on a template.

Examples:

Request syntax with placeholder values


resp = client.describe_template_permissions({
  aws_account_id: "AwsAccountId", # required
  template_id: "RestrictiveResourceId", # required
})

Response structure


resp.template_id #=> String
resp.template_arn #=> String
resp.permissions #=> Array
resp.permissions[0].principal #=> String
resp.permissions[0].actions #=> Array
resp.permissions[0].actions[0] #=> String
resp.request_id #=> String
resp.status #=> Integer

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :aws_account_id (required, String)

    The ID of the AWS account that contains the template that you're describing.

  • :template_id (required, String)

    The ID for the template.

Returns:

See Also:



3154
3155
3156
3157
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 3154

def describe_template_permissions(params = {}, options = {})
  req = build_request(:describe_template_permissions, params)
  req.send_request(options)
end

#describe_theme(params = {}) ⇒ Types::DescribeThemeResponse

Describes a theme.

Examples:

Request syntax with placeholder values


resp = client.describe_theme({
  aws_account_id: "AwsAndAccountId", # required
  theme_id: "RestrictiveResourceId", # required
  version_number: 1,
  alias_name: "AliasName",
})

Response structure


resp.theme.arn #=> String
resp.theme.name #=> String
resp.theme.theme_id #=> String
resp.theme.version.version_number #=> Integer
resp.theme.version.arn #=> String
resp.theme.version.description #=> String
resp.theme.version.base_theme_id #=> String
resp.theme.version.created_time #=> Time
resp.theme.version.configuration.data_color_palette.colors #=> Array
resp.theme.version.configuration.data_color_palette.colors[0] #=> String
resp.theme.version.configuration.data_color_palette.min_max_gradient #=> Array
resp.theme.version.configuration.data_color_palette.min_max_gradient[0] #=> String
resp.theme.version.configuration.data_color_palette.empty_fill_color #=> String
resp.theme.version.configuration.ui_color_palette.primary_foreground #=> String
resp.theme.version.configuration.ui_color_palette.primary_background #=> String
resp.theme.version.configuration.ui_color_palette.secondary_foreground #=> String
resp.theme.version.configuration.ui_color_palette.secondary_background #=> String
resp.theme.version.configuration.ui_color_palette.accent #=> String
resp.theme.version.configuration.ui_color_palette.accent_foreground #=> String
resp.theme.version.configuration.ui_color_palette.danger #=> String
resp.theme.version.configuration.ui_color_palette.danger_foreground #=> String
resp.theme.version.configuration.ui_color_palette.warning #=> String
resp.theme.version.configuration.ui_color_palette.warning_foreground #=> String
resp.theme.version.configuration.ui_color_palette.success #=> String
resp.theme.version.configuration.ui_color_palette.success_foreground #=> String
resp.theme.version.configuration.ui_color_palette.dimension #=> String
resp.theme.version.configuration.ui_color_palette.dimension_foreground #=> String
resp.theme.version.configuration.ui_color_palette.measure #=> String
resp.theme.version.configuration.ui_color_palette.measure_foreground #=> String
resp.theme.version.configuration.sheet.tile.border.show #=> Boolean
resp.theme.version.configuration.sheet.tile_layout.gutter.show #=> Boolean
resp.theme.version.configuration.sheet.tile_layout.margin.show #=> Boolean
resp.theme.version.errors #=> Array
resp.theme.version.errors[0].type #=> String, one of "INTERNAL_FAILURE"
resp.theme.version.errors[0].message #=> String
resp.theme.version.status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED"
resp.theme.created_time #=> Time
resp.theme.last_updated_time #=> Time
resp.theme.type #=> String, one of "QUICKSIGHT", "CUSTOM", "ALL"
resp.status #=> Integer
resp.request_id #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :aws_account_id (required, String)

    The ID of the AWS account that contains the theme that you're describing.

  • :theme_id (required, String)

    The ID for the theme.

  • :version_number (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.

  • :alias_name (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.

Returns:

See Also:



3243
3244
3245
3246
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 3243

def describe_theme(params = {}, options = {})
  req = build_request(:describe_theme, params)
  req.send_request(options)
end

#describe_theme_alias(params = {}) ⇒ Types::DescribeThemeAliasResponse

Describes the alias for a theme.

Examples:

Request syntax with placeholder values


resp = client.describe_theme_alias({
  aws_account_id: "AwsAccountId", # required
  theme_id: "RestrictiveResourceId", # required
  alias_name: "AliasName", # required
})

Response structure


resp.theme_alias.arn #=> String
resp.theme_alias.alias_name #=> String
resp.theme_alias.theme_version_number #=> Integer
resp.status #=> Integer
resp.request_id #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :aws_account_id (required, String)

    The ID of the AWS account that contains the theme alias that you're describing.

  • :theme_id (required, String)

    The ID for the theme.

  • :alias_name (required, String)

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

Returns:

See Also:



3286
3287
3288
3289
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 3286

def describe_theme_alias(params = {}, options = {})
  req = build_request(:describe_theme_alias, params)
  req.send_request(options)
end

#describe_theme_permissions(params = {}) ⇒ Types::DescribeThemePermissionsResponse

Describes the read and write permissions for a theme.

Examples:

Request syntax with placeholder values


resp = client.describe_theme_permissions({
  aws_account_id: "AwsAccountId", # required
  theme_id: "RestrictiveResourceId", # required
})

Response structure


resp.theme_id #=> String
resp.theme_arn #=> String
resp.permissions #=> Array
resp.permissions[0].principal #=> String
resp.permissions[0].actions #=> Array
resp.permissions[0].actions[0] #=> String
resp.request_id #=> String
resp.status #=> Integer

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :aws_account_id (required, String)

    The ID of the AWS account that contains the theme that you're describing.

  • :theme_id (required, String)

    The ID for the theme that you want to describe permissions for.

Returns:

See Also:



3330
3331
3332
3333
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 3330

def describe_theme_permissions(params = {}, options = {})
  req = build_request(:describe_theme_permissions, params)
  req.send_request(options)
end

#describe_user(params = {}) ⇒ Types::DescribeUserResponse

Returns information about a user, given the user name.

Examples:

Request syntax with placeholder values


resp = client.describe_user({
  user_name: "UserName", # required
  aws_account_id: "AwsAccountId", # required
  namespace: "Namespace", # required
})

Response structure


resp.user.arn #=> String
resp.user.user_name #=> String
resp.user.email #=> String
resp.user.role #=> String, one of "ADMIN", "AUTHOR", "READER", "RESTRICTED_AUTHOR", "RESTRICTED_READER"
resp.user.identity_type #=> String, one of "IAM", "QUICKSIGHT"
resp.user.active #=> Boolean
resp.user.principal_id #=> String
resp.user.custom_permissions_name #=> String
resp.request_id #=> String
resp.status #=> Integer

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :user_name (required, String)

    The name of the user that you want to describe.

  • :aws_account_id (required, 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 (required, String)

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

Returns:

See Also:



3378
3379
3380
3381
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 3378

def describe_user(params = {}, options = {})
  req = build_request(:describe_user, params)
  req.send_request(options)
end

#get_dashboard_embed_url(params = {}) ⇒ Types::GetDashboardEmbedUrlResponse

Generates a URL and authorization code that you can embed 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 Amazon QuickSight Dashboards in the Amazon QuickSight User Guide or Embedding Amazon QuickSight Dashboards in the Amazon QuickSight API Reference.

Examples:

Request syntax with placeholder values


resp = client.get_dashboard_embed_url({
  aws_account_id: "AwsAccountId", # required
  dashboard_id: "RestrictiveResourceId", # required
  identity_type: "IAM", # required, accepts IAM, QUICKSIGHT
  session_lifetime_in_minutes: 1,
  undo_redo_disabled: false,
  reset_disabled: false,
  user_arn: "Arn",
})

Response structure


resp.embed_url #=> String
resp.status #=> Integer
resp.request_id #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :aws_account_id (required, String)

    The ID for the AWS account that contains the dashboard that you're embedding.

  • :dashboard_id (required, String)

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

  • :identity_type (required, String)

    The authentication method that the user uses to sign in.

  • :session_lifetime_in_minutes (Integer)

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

  • :undo_redo_disabled (Boolean)

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

  • :reset_disabled (Boolean)

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

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

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

Returns:

See Also:



3472
3473
3474
3475
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 3472

def get_dashboard_embed_url(params = {}, options = {})
  req = build_request(:get_dashboard_embed_url, params)
  req.send_request(options)
end

#get_session_embed_url(params = {}) ⇒ Types::GetSessionEmbedUrlResponse

Generates a session URL and authorization code that you can embed in your web server code.

Examples:

Request syntax with placeholder values


resp = client.get_session_embed_url({
  aws_account_id: "AwsAccountId", # required
  entry_point: "EntryPoint",
  session_lifetime_in_minutes: 1,
  user_arn: "Arn",
})

Response structure


resp.embed_url #=> String
resp.status #=> Integer
resp.request_id #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :aws_account_id (required, String)

    The ID for the AWS account that contains the QuickSight session that you're embedding.

  • :entry_point (String)

    The entry point for the embedded session.

  • :session_lifetime_in_minutes (Integer)

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

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

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

Returns:

See Also:



3530
3531
3532
3533
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 3530

def get_session_embed_url(params = {}, options = {})
  req = build_request(:get_session_embed_url, params)
  req.send_request(options)
end

#list_dashboard_versions(params = {}) ⇒ Types::ListDashboardVersionsResponse

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

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_dashboard_versions({
  aws_account_id: "AwsAccountId", # required
  dashboard_id: "RestrictiveResourceId", # required
  next_token: "String",
  max_results: 1,
})

Response structure


resp.dashboard_version_summary_list #=> Array
resp.dashboard_version_summary_list[0].arn #=> String
resp.dashboard_version_summary_list[0].created_time #=> Time
resp.dashboard_version_summary_list[0].version_number #=> Integer
resp.dashboard_version_summary_list[0].status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED"
resp.dashboard_version_summary_list[0].source_entity_arn #=> String
resp.dashboard_version_summary_list[0].description #=> String
resp.next_token #=> String
resp.status #=> Integer
resp.request_id #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :aws_account_id (required, String)

    The ID of the AWS account that contains the dashboard that you're listing versions for.

  • :dashboard_id (required, String)

    The ID for the dashboard.

  • :next_token (String)

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

  • :max_results (Integer)

    The maximum number of results to be returned per request.

Returns:

See Also:



3587
3588
3589
3590
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 3587

def list_dashboard_versions(params = {}, options = {})
  req = build_request(:list_dashboard_versions, params)
  req.send_request(options)
end

#list_dashboards(params = {}) ⇒ Types::ListDashboardsResponse

Lists dashboards in an AWS account.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_dashboards({
  aws_account_id: "AwsAccountId", # required
  next_token: "String",
  max_results: 1,
})

Response structure


resp.dashboard_summary_list #=> Array
resp.dashboard_summary_list[0].arn #=> String
resp.dashboard_summary_list[0].dashboard_id #=> String
resp.dashboard_summary_list[0].name #=> String
resp.dashboard_summary_list[0].created_time #=> Time
resp.dashboard_summary_list[0].last_updated_time #=> Time
resp.dashboard_summary_list[0].published_version_number #=> Integer
resp.dashboard_summary_list[0].last_published_time #=> Time
resp.next_token #=> String
resp.status #=> Integer
resp.request_id #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :aws_account_id (required, String)

    The ID of the AWS account that contains the dashboards that you're listing.

  • :next_token (String)

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

  • :max_results (Integer)

    The maximum number of results to be returned per request.

Returns:

See Also:



3640
3641
3642
3643
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 3640

def list_dashboards(params = {}, options = {})
  req = build_request(:list_dashboards, params)
  req.send_request(options)
end

#list_data_sets(params = {}) ⇒ Types::ListDataSetsResponse

Lists all of the datasets belonging to the current AWS account in an AWS Region.

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

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_data_sets({
  aws_account_id: "AwsAccountId", # required
  next_token: "String",
  max_results: 1,
})

Response structure


resp.data_set_summaries #=> Array
resp.data_set_summaries[0].arn #=> String
resp.data_set_summaries[0].data_set_id #=> String
resp.data_set_summaries[0].name #=> String
resp.data_set_summaries[0].created_time #=> Time
resp.data_set_summaries[0].last_updated_time #=> Time
resp.data_set_summaries[0].import_mode #=> String, one of "SPICE", "DIRECT_QUERY"
resp.data_set_summaries[0].row_level_permission_data_set.namespace #=> String
resp.data_set_summaries[0].row_level_permission_data_set.arn #=> String
resp.data_set_summaries[0].row_level_permission_data_set.permission_policy #=> String, one of "GRANT_ACCESS", "DENY_ACCESS"
resp.next_token #=> String
resp.request_id #=> String
resp.status #=> Integer

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :aws_account_id (required, String)

    The AWS account ID.

  • :next_token (String)

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

  • :max_results (Integer)

    The maximum number of results to be returned per request.

Returns:

See Also:



3698
3699
3700
3701
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 3698

def list_data_sets(params = {}, options = {})
  req = build_request(:list_data_sets, params)
  req.send_request(options)
end

#list_data_sources(params = {}) ⇒ Types::ListDataSourcesResponse

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

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_data_sources({
  aws_account_id: "AwsAccountId", # required
  next_token: "String",
  max_results: 1,
})

Response structure


resp.data_sources #=> Array
resp.data_sources[0].arn #=> String
resp.data_sources[0].data_source_id #=> String
resp.data_sources[0].name #=> String
resp.data_sources[0].type #=> String, one of "ADOBE_ANALYTICS", "AMAZON_ELASTICSEARCH", "ATHENA", "AURORA", "AURORA_POSTGRESQL", "AWS_IOT_ANALYTICS", "GITHUB", "JIRA", "MARIADB", "MYSQL", "POSTGRESQL", "PRESTO", "REDSHIFT", "S3", "SALESFORCE", "SERVICENOW", "SNOWFLAKE", "SPARK", "SQLSERVER", "TERADATA", "TWITTER"
resp.data_sources[0].status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED"
resp.data_sources[0].created_time #=> Time
resp.data_sources[0].last_updated_time #=> Time
resp.data_sources[0].data_source_parameters.amazon_elasticsearch_parameters.domain #=> String
resp.data_sources[0].data_source_parameters.athena_parameters.work_group #=> String
resp.data_sources[0].data_source_parameters.aurora_parameters.host #=> String
resp.data_sources[0].data_source_parameters.aurora_parameters.port #=> Integer
resp.data_sources[0].data_source_parameters.aurora_parameters.database #=> String
resp.data_sources[0].data_source_parameters.aurora_postgre_sql_parameters.host #=> String
resp.data_sources[0].data_source_parameters.aurora_postgre_sql_parameters.port #=> Integer
resp.data_sources[0].data_source_parameters.aurora_postgre_sql_parameters.database #=> String
resp.data_sources[0].data_source_parameters.aws_iot_analytics_parameters.data_set_name #=> String
resp.data_sources[0].data_source_parameters.jira_parameters.site_base_url #=> String
resp.data_sources[0].data_source_parameters.maria_db_parameters.host #=> String
resp.data_sources[0].data_source_parameters.maria_db_parameters.port #=> Integer
resp.data_sources[0].data_source_parameters.maria_db_parameters.database #=> String
resp.data_sources[0].data_source_parameters.my_sql_parameters.host #=> String
resp.data_sources[0].data_source_parameters.my_sql_parameters.port #=> Integer
resp.data_sources[0].data_source_parameters.my_sql_parameters.database #=> String
resp.data_sources[0].data_source_parameters.postgre_sql_parameters.host #=> String
resp.data_sources[0].data_source_parameters.postgre_sql_parameters.port #=> Integer
resp.data_sources[0].data_source_parameters.postgre_sql_parameters.database #=> String
resp.data_sources[0].data_source_parameters.presto_parameters.host #=> String
resp.data_sources[0].data_source_parameters.presto_parameters.port #=> Integer
resp.data_sources[0].data_source_parameters.presto_parameters.catalog #=> String
resp.data_sources[0].data_source_parameters.rds_parameters.instance_id #=> String
resp.data_sources[0].data_source_parameters.rds_parameters.database #=> String
resp.data_sources[0].data_source_parameters.redshift_parameters.host #=> String
resp.data_sources[0].data_source_parameters.redshift_parameters.port #=> Integer
resp.data_sources[0].data_source_parameters.redshift_parameters.database #=> String
resp.data_sources[0].data_source_parameters.redshift_parameters.cluster_id #=> String
resp.data_sources[0].data_source_parameters.s3_parameters.manifest_file_location.bucket #=> String
resp.data_sources[0].data_source_parameters.s3_parameters.manifest_file_location.key #=> String
resp.data_sources[0].data_source_parameters.service_now_parameters.site_base_url #=> String
resp.data_sources[0].data_source_parameters.snowflake_parameters.host #=> String
resp.data_sources[0].data_source_parameters.snowflake_parameters.database #=> String
resp.data_sources[0].data_source_parameters.snowflake_parameters.warehouse #=> String
resp.data_sources[0].data_source_parameters.spark_parameters.host #=> String
resp.data_sources[0].data_source_parameters.spark_parameters.port #=> Integer
resp.data_sources[0].data_source_parameters.sql_server_parameters.host #=> String
resp.data_sources[0].data_source_parameters.sql_server_parameters.port #=> Integer
resp.data_sources[0].data_source_parameters.sql_server_parameters.database #=> String
resp.data_sources[0].data_source_parameters.teradata_parameters.host #=> String
resp.data_sources[0].data_source_parameters.teradata_parameters.port #=> Integer
resp.data_sources[0].data_source_parameters.teradata_parameters.database #=> String
resp.data_sources[0].data_source_parameters.twitter_parameters.query #=> String
resp.data_sources[0].data_source_parameters.twitter_parameters.max_rows #=> Integer
resp.data_sources[0].alternate_data_source_parameters #=> Array
resp.data_sources[0].alternate_data_source_parameters[0].amazon_elasticsearch_parameters.domain #=> String
resp.data_sources[0].alternate_data_source_parameters[0].athena_parameters.work_group #=> String
resp.data_sources[0].alternate_data_source_parameters[0].aurora_parameters.host #=> String
resp.data_sources[0].alternate_data_source_parameters[0].aurora_parameters.port #=> Integer
resp.data_sources[0].alternate_data_source_parameters[0].aurora_parameters.database #=> String
resp.data_sources[0].alternate_data_source_parameters[0].aurora_postgre_sql_parameters.host #=> String
resp.data_sources[0].alternate_data_source_parameters[0].aurora_postgre_sql_parameters.port #=> Integer
resp.data_sources[0].alternate_data_source_parameters[0].aurora_postgre_sql_parameters.database #=> String
resp.data_sources[0].alternate_data_source_parameters[0].aws_iot_analytics_parameters.data_set_name #=> String
resp.data_sources[0].alternate_data_source_parameters[0].jira_parameters.site_base_url #=> String
resp.data_sources[0].alternate_data_source_parameters[0].maria_db_parameters.host #=> String
resp.data_sources[0].alternate_data_source_parameters[0].maria_db_parameters.port #=> Integer
resp.data_sources[0].alternate_data_source_parameters[0].maria_db_parameters.database #=> String
resp.data_sources[0].alternate_data_source_parameters[0].my_sql_parameters.host #=> String
resp.data_sources[0].alternate_data_source_parameters[0].my_sql_parameters.port #=> Integer
resp.data_sources[0].alternate_data_source_parameters[0].my_sql_parameters.database #=> String
resp.data_sources[0].alternate_data_source_parameters[0].postgre_sql_parameters.host #=> String
resp.data_sources[0].alternate_data_source_parameters[0].postgre_sql_parameters.port #=> Integer
resp.data_sources[0].alternate_data_source_parameters[0].postgre_sql_parameters.database #=> String
resp.data_sources[0].alternate_data_source_parameters[0].presto_parameters.host #=> String
resp.data_sources[0].alternate_data_source_parameters[0].presto_parameters.port #=> Integer
resp.data_sources[0].alternate_data_source_parameters[0].presto_parameters.catalog #=> String
resp.data_sources[0].alternate_data_source_parameters[0].rds_parameters.instance_id #=> String
resp.data_sources[0].alternate_data_source_parameters[0].rds_parameters.database #=> String
resp.data_sources[0].alternate_data_source_parameters[0].redshift_parameters.host #=> String
resp.data_sources[0].alternate_data_source_parameters[0].redshift_parameters.port #=> Integer
resp.data_sources[0].alternate_data_source_parameters[0].redshift_parameters.database #=> String
resp.data_sources[0].alternate_data_source_parameters[0].redshift_parameters.cluster_id #=> String
resp.data_sources[0].alternate_data_source_parameters[0].s3_parameters.manifest_file_location.bucket #=> String
resp.data_sources[0].alternate_data_source_parameters[0].s3_parameters.manifest_file_location.key #=> String
resp.data_sources[0].alternate_data_source_parameters[0].service_now_parameters.site_base_url #=> String
resp.data_sources[0].alternate_data_source_parameters[0].snowflake_parameters.host #=> String
resp.data_sources[0].alternate_data_source_parameters[0].snowflake_parameters.database #=> String
resp.data_sources[0].alternate_data_source_parameters[0].snowflake_parameters.warehouse #=> String
resp.data_sources[0].alternate_data_source_parameters[0].spark_parameters.host #=> String
resp.data_sources[0].alternate_data_source_parameters[0].spark_parameters.port #=> Integer
resp.data_sources[0].alternate_data_source_parameters[0].sql_server_parameters.host #=> String
resp.data_sources[0].alternate_data_source_parameters[0].sql_server_parameters.port #=> Integer
resp.data_sources[0].alternate_data_source_parameters[0].sql_server_parameters.database #=> String
resp.data_sources[0].alternate_data_source_parameters[0].teradata_parameters.host #=> String
resp.data_sources[0].alternate_data_source_parameters[0].teradata_parameters.port #=> Integer
resp.data_sources[0].alternate_data_source_parameters[0].teradata_parameters.database #=> String
resp.data_sources[0].alternate_data_source_parameters[0].twitter_parameters.query #=> String
resp.data_sources[0].alternate_data_source_parameters[0].twitter_parameters.max_rows #=> Integer
resp.data_sources[0].vpc_connection_properties.vpc_connection_arn #=> String
resp.data_sources[0].ssl_properties.disable_ssl #=> Boolean
resp.data_sources[0].error_info.type #=> String, one of "ACCESS_DENIED", "COPY_SOURCE_NOT_FOUND", "TIMEOUT", "ENGINE_VERSION_NOT_SUPPORTED", "UNKNOWN_HOST", "GENERIC_SQL_FAILURE", "CONFLICT", "UNKNOWN"
resp.data_sources[0].error_info.message #=> String
resp.next_token #=> String
resp.request_id #=> String
resp.status #=> Integer

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :aws_account_id (required, String)

    The AWS account ID.

  • :next_token (String)

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

  • :max_results (Integer)

    The maximum number of results to be returned per request.

Returns:

See Also:



3844
3845
3846
3847
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 3844

def list_data_sources(params = {}, options = {})
  req = build_request(:list_data_sources, params)
  req.send_request(options)
end

#list_group_memberships(params = {}) ⇒ Types::ListGroupMembershipsResponse

Lists member users in a group.

Examples:

Request syntax with placeholder values


resp = client.list_group_memberships({
  group_name: "GroupName", # required
  next_token: "String",
  max_results: 1,
  aws_account_id: "AwsAccountId", # required
  namespace: "Namespace", # required
})

Response structure


resp.group_member_list #=> Array
resp.group_member_list[0].arn #=> String
resp.group_member_list[0].member_name #=> String
resp.next_token #=> String
resp.request_id #=> String
resp.status #=> Integer

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :group_name (required, String)

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

  • :next_token (String)

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

  • :max_results (Integer)

    The maximum number of results to return from this request.

  • :aws_account_id (required, 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 (required, String)

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

Returns:

See Also:



3898
3899
3900
3901
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 3898

def list_group_memberships(params = {}, options = {})
  req = build_request(:list_group_memberships, params)
  req.send_request(options)
end

#list_groups(params = {}) ⇒ Types::ListGroupsResponse

Lists all user groups in Amazon QuickSight.

Examples:

Request syntax with placeholder values


resp = client.list_groups({
  aws_account_id: "AwsAccountId", # required
  next_token: "String",
  max_results: 1,
  namespace: "Namespace", # required
})

Response structure


resp.group_list #=> Array
resp.group_list[0].arn #=> String
resp.group_list[0].group_name #=> String
resp.group_list[0].description #=> String
resp.group_list[0].principal_id #=> String
resp.next_token #=> String
resp.request_id #=> String
resp.status #=> Integer

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :aws_account_id (required, 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.

  • :next_token (String)

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

  • :max_results (Integer)

    The maximum number of results to return.

  • :namespace (required, String)

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

Returns:

See Also:



3950
3951
3952
3953
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 3950

def list_groups(params = {}, options = {})
  req = build_request(:list_groups, params)
  req.send_request(options)
end

#list_iam_policy_assignments(params = {}) ⇒ Types::ListIAMPolicyAssignmentsResponse

Lists IAM policy assignments in the current Amazon QuickSight account.

Examples:

Request syntax with placeholder values


resp = client.list_iam_policy_assignments({
  aws_account_id: "AwsAccountId", # required
  assignment_status: "ENABLED", # accepts ENABLED, DRAFT, DISABLED
  namespace: "Namespace", # required
  next_token: "String",
  max_results: 1,
})

Response structure


resp.iam_policy_assignments #=> Array
resp.iam_policy_assignments[0].assignment_name #=> String
resp.iam_policy_assignments[0].assignment_status #=> String, one of "ENABLED", "DRAFT", "DISABLED"
resp.next_token #=> String
resp.request_id #=> String
resp.status #=> Integer

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :aws_account_id (required, String)

    The ID of the AWS account that contains these IAM policy assignments.

  • :assignment_status (String)

    The status of the assignments.

  • :namespace (required, String)

    The namespace for the assignments.

  • :next_token (String)

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

  • :max_results (Integer)

    The maximum number of results to be returned per request.

Returns:

See Also:



4003
4004
4005
4006
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 4003

def list_iam_policy_assignments(params = {}, options = {})
  req = build_request(:list_iam_policy_assignments, params)
  req.send_request(options)
end

#list_iam_policy_assignments_for_user(params = {}) ⇒ Types::ListIAMPolicyAssignmentsForUserResponse

Lists all the IAM policy 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.

Examples:

Request syntax with placeholder values


resp = client.list_iam_policy_assignments_for_user({
  aws_account_id: "AwsAccountId", # required
  user_name: "UserName", # required
  next_token: "String",
  max_results: 1,
  namespace: "Namespace", # required
})

Response structure


resp.active_assignments #=> Array
resp.active_assignments[0].assignment_name #=> String
resp.active_assignments[0].policy_arn #=> String
resp.request_id #=> String
resp.next_token #=> String
resp.status #=> Integer

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :aws_account_id (required, String)

    The ID of the AWS account that contains the assignments.

  • :user_name (required, String)

    The name of the user.

  • :next_token (String)

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

  • :max_results (Integer)

    The maximum number of results to be returned per request.

  • :namespace (required, String)

    The namespace of the assignment.

Returns:

See Also:



4058
4059
4060
4061
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 4058

def list_iam_policy_assignments_for_user(params = {}, options = {})
  req = build_request(:list_iam_policy_assignments_for_user, params)
  req.send_request(options)
end

#list_ingestions(params = {}) ⇒ Types::ListIngestionsResponse

Lists the history of SPICE ingestions for a dataset.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_ingestions({
  data_set_id: "string", # required
  next_token: "string",
  aws_account_id: "AwsAccountId", # required
  max_results: 1,
})

Response structure


resp.ingestions #=> Array
resp.ingestions[0].arn #=> String
resp.ingestions[0].ingestion_id #=> String
resp.ingestions[0].ingestion_status #=> String, one of "INITIALIZED", "QUEUED", "RUNNING", "FAILED", "COMPLETED", "CANCELLED"
resp.ingestions[0].error_info.type #=> String, one of "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"
resp.ingestions[0].error_info.message #=> String
resp.ingestions[0].row_info.rows_ingested #=> Integer
resp.ingestions[0].row_info.rows_dropped #=> Integer
resp.ingestions[0].queue_info.waiting_on_ingestion #=> String
resp.ingestions[0].queue_info.queued_ingestion #=> String
resp.ingestions[0].created_time #=> Time
resp.ingestions[0].ingestion_time_in_seconds #=> Integer
resp.ingestions[0].ingestion_size_in_bytes #=> Integer
resp.ingestions[0].request_source #=> String, one of "MANUAL", "SCHEDULED"
resp.ingestions[0].request_type #=> String, one of "INITIAL_INGESTION", "EDIT", "INCREMENTAL_REFRESH", "FULL_REFRESH"
resp.next_token #=> String
resp.request_id #=> String
resp.status #=> Integer

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :data_set_id (required, String)

    The ID of the dataset used in the ingestion.

  • :next_token (String)

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

  • :aws_account_id (required, String)

    The AWS account ID.

  • :max_results (Integer)

    The maximum number of results to be returned per request.

Returns:

See Also:



4121
4122
4123
4124
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 4121

def list_ingestions(params = {}, options = {})
  req = build_request(:list_ingestions, params)
  req.send_request(options)
end

#list_namespaces(params = {}) ⇒ Types::ListNamespacesResponse

Lists the namespaces for the specified AWS account.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_namespaces({
  aws_account_id: "AwsAccountId", # required
  next_token: "String",
  max_results: 1,
})

Response structure


resp.namespaces #=> Array
resp.namespaces[0].name #=> String
resp.namespaces[0].arn #=> String
resp.namespaces[0].capacity_region #=> String
resp.namespaces[0].creation_status #=> String, one of "CREATED", "CREATING", "DELETING", "RETRYABLE_FAILURE", "NON_RETRYABLE_FAILURE"
resp.namespaces[0].identity_store #=> String, one of "QUICKSIGHT"
resp.namespaces[0].namespace_error.type #=> String, one of "PERMISSION_DENIED", "INTERNAL_SERVICE_ERROR"
resp.namespaces[0].namespace_error.message #=> String
resp.next_token #=> String
resp.request_id #=> String
resp.status #=> Integer

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :aws_account_id (required, String)

    The ID for the AWS account that contains the QuickSight namespaces that you want to list.

  • :next_token (String)

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

  • :max_results (Integer)

    The maximum number of results to return.

Returns:

See Also:



4173
4174
4175
4176
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 4173

def list_namespaces(params = {}, options = {})
  req = build_request(:list_namespaces, params)
  req.send_request(options)
end

#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse

Lists the tags assigned to a resource.

Examples:

Request syntax with placeholder values


resp = client.list_tags_for_resource({
  resource_arn: "Arn", # required
})

Response structure


resp.tags #=> Array
resp.tags[0].key #=> String
resp.tags[0].value #=> String
resp.request_id #=> String
resp.status #=> Integer

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :resource_arn (required, String)

    The Amazon Resource Name (ARN) of the resource that you want a list of tags for.

Returns:

See Also:



4208
4209
4210
4211
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 4208

def list_tags_for_resource(params = {}, options = {})
  req = build_request(:list_tags_for_resource, params)
  req.send_request(options)
end

#list_template_aliases(params = {}) ⇒ Types::ListTemplateAliasesResponse

Lists all the aliases of a template.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_template_aliases({
  aws_account_id: "AwsAccountId", # required
  template_id: "RestrictiveResourceId", # required
  next_token: "String",
  max_results: 1,
})

Response structure


resp.template_alias_list #=> Array
resp.template_alias_list[0].alias_name #=> String
resp.template_alias_list[0].arn #=> String
resp.template_alias_list[0].template_version_number #=> Integer
resp.status #=> Integer
resp.request_id #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :aws_account_id (required, String)

    The ID of the AWS account that contains the template aliases that you're listing.

  • :template_id (required, String)

    The ID for the template.

  • :next_token (String)

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

  • :max_results (Integer)

    The maximum number of results to be returned per request.

Returns:

See Also:



4261
4262
4263
4264
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 4261

def list_template_aliases(params = {}, options = {})
  req = build_request(:list_template_aliases, params)
  req.send_request(options)
end

#list_template_versions(params = {}) ⇒ Types::ListTemplateVersionsResponse

Lists all the versions of the templates in the current Amazon QuickSight account.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_template_versions({
  aws_account_id: "AwsAccountId", # required
  template_id: "RestrictiveResourceId", # required
  next_token: "String",
  max_results: 1,
})

Response structure


resp.template_version_summary_list #=> Array
resp.template_version_summary_list[0].arn #=> String
resp.template_version_summary_list[0].version_number #=> Integer
resp.template_version_summary_list[0].created_time #=> Time
resp.template_version_summary_list[0].status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED"
resp.template_version_summary_list[0].description #=> String
resp.next_token #=> String
resp.status #=> Integer
resp.request_id #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :aws_account_id (required, String)

    The ID of the AWS account that contains the templates that you're listing.

  • :template_id (required, String)

    The ID for the template.

  • :next_token (String)

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

  • :max_results (Integer)

    The maximum number of results to be returned per request.

Returns:

See Also:



4317
4318
4319
4320
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 4317

def list_template_versions(params = {}, options = {})
  req = build_request(:list_template_versions, params)
  req.send_request(options)
end

#list_templates(params = {}) ⇒ Types::ListTemplatesResponse

Lists all the templates in the current Amazon QuickSight account.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_templates({
  aws_account_id: "AwsAccountId", # required
  next_token: "String",
  max_results: 1,
})

Response structure


resp.template_summary_list #=> Array
resp.template_summary_list[0].arn #=> String
resp.template_summary_list[0].template_id #=> String
resp.template_summary_list[0].name #=> String
resp.template_summary_list[0].latest_version_number #=> Integer
resp.template_summary_list[0].created_time #=> Time
resp.template_summary_list[0].last_updated_time #=> Time
resp.next_token #=> String
resp.status #=> Integer
resp.request_id #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :aws_account_id (required, String)

    The ID of the AWS account that contains the templates that you're listing.

  • :next_token (String)

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

  • :max_results (Integer)

    The maximum number of results to be returned per request.

Returns:

See Also:



4369
4370
4371
4372
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 4369

def list_templates(params = {}, options = {})
  req = build_request(:list_templates, params)
  req.send_request(options)
end

#list_theme_aliases(params = {}) ⇒ Types::ListThemeAliasesResponse

Lists all the aliases of a theme.

Examples:

Request syntax with placeholder values


resp = client.list_theme_aliases({
  aws_account_id: "AwsAccountId", # required
  theme_id: "RestrictiveResourceId", # required
  next_token: "String",
  max_results: 1,
})

Response structure


resp.theme_alias_list #=> Array
resp.theme_alias_list[0].arn #=> String
resp.theme_alias_list[0].alias_name #=> String
resp.theme_alias_list[0].theme_version_number #=> Integer
resp.status #=> Integer
resp.request_id #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :aws_account_id (required, String)

    The ID of the AWS account that contains the theme aliases that you're listing.

  • :theme_id (required, String)

    The ID for the theme.

  • :next_token (String)

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

  • :max_results (Integer)

    The maximum number of results to be returned per request.

Returns:

See Also:



4420
4421
4422
4423
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 4420

def list_theme_aliases(params = {}, options = {})
  req = build_request(:list_theme_aliases, params)
  req.send_request(options)
end

#list_theme_versions(params = {}) ⇒ Types::ListThemeVersionsResponse

Lists all the versions of the themes in the current AWS account.

Examples:

Request syntax with placeholder values


resp = client.list_theme_versions({
  aws_account_id: "AwsAccountId", # required
  theme_id: "RestrictiveResourceId", # required
  next_token: "String",
  max_results: 1,
})

Response structure


resp.theme_version_summary_list #=> Array
resp.theme_version_summary_list[0].version_number #=> Integer
resp.theme_version_summary_list[0].arn #=> String
resp.theme_version_summary_list[0].description #=> String
resp.theme_version_summary_list[0].created_time #=> Time
resp.theme_version_summary_list[0].status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED"
resp.next_token #=> String
resp.status #=> Integer
resp.request_id #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :aws_account_id (required, String)

    The ID of the AWS account that contains the themes that you're listing.

  • :theme_id (required, String)

    The ID for the theme.

  • :next_token (String)

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

  • :max_results (Integer)

    The maximum number of results to be returned per request.

Returns:

See Also:



4473
4474
4475
4476
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 4473

def list_theme_versions(params = {}, options = {})
  req = build_request(:list_theme_versions, params)
  req.send_request(options)
end

#list_themes(params = {}) ⇒ Types::ListThemesResponse

Lists all the themes in the current AWS account.

Examples:

Request syntax with placeholder values


resp = client.list_themes({
  aws_account_id: "AwsAccountId", # required
  next_token: "String",
  max_results: 1,
  type: "QUICKSIGHT", # accepts QUICKSIGHT, CUSTOM, ALL
})

Response structure


resp.theme_summary_list #=> Array
resp.theme_summary_list[0].arn #=> String
resp.theme_summary_list[0].name #=> String
resp.theme_summary_list[0].theme_id #=> String
resp.theme_summary_list[0].latest_version_number #=> Integer
resp.theme_summary_list[0].created_time #=> Time
resp.theme_summary_list[0].last_updated_time #=> Time
resp.next_token #=> String
resp.status #=> Integer
resp.request_id #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :aws_account_id (required, String)

    The ID of the AWS account that contains the themes that you're listing.

  • :next_token (String)

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

  • :max_results (Integer)

    The maximum number of results to be returned per request.

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

Returns:

See Also:



4536
4537
4538
4539
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 4536

def list_themes(params = {}, options = {})
  req = build_request(:list_themes, params)
  req.send_request(options)
end

#list_user_groups(params = {}) ⇒ Types::ListUserGroupsResponse

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

Examples:

Request syntax with placeholder values


resp = client.list_user_groups({
  user_name: "UserName", # required
  aws_account_id: "AwsAccountId", # required
  namespace: "Namespace", # required
  next_token: "String",
  max_results: 1,
})

Response structure


resp.group_list #=> Array
resp.group_list[0].arn #=> String
resp.group_list[0].group_name #=> String
resp.group_list[0].description #=> String
resp.group_list[0].principal_id #=> String
resp.next_token #=> String
resp.request_id #=> String
resp.status #=> Integer

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :user_name (required, String)

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

  • :aws_account_id (required, 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 (required, String)

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

  • :next_token (String)

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

  • :max_results (Integer)

    The maximum number of results to return from this request.

Returns:

See Also:



4593
4594
4595
4596
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 4593

def list_user_groups(params = {}, options = {})
  req = build_request(:list_user_groups, params)
  req.send_request(options)
end

#list_users(params = {}) ⇒ Types::ListUsersResponse

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

Examples:

Request syntax with placeholder values


resp = client.list_users({
  aws_account_id: "AwsAccountId", # required
  next_token: "String",
  max_results: 1,
  namespace: "Namespace", # required
})

Response structure


resp.user_list #=> Array
resp.user_list[0].arn #=> String
resp.user_list[0].user_name #=> String
resp.user_list[0].email #=> String
resp.user_list[0].role #=> String, one of "ADMIN", "AUTHOR", "READER", "RESTRICTED_AUTHOR", "RESTRICTED_READER"
resp.user_list[0].identity_type #=> String, one of "IAM", "QUICKSIGHT"
resp.user_list[0].active #=> Boolean
resp.user_list[0].principal_id #=> String
resp.user_list[0].custom_permissions_name #=> String
resp.next_token #=> String
resp.request_id #=> String
resp.status #=> Integer

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :aws_account_id (required, 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.

  • :next_token (String)

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

  • :max_results (Integer)

    The maximum number of results to return from this request.

  • :namespace (required, String)

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

Returns:

See Also:



4649
4650
4651
4652
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 4649

def list_users(params = {}, options = {})
  req = build_request(:list_users, params)
  req.send_request(options)
end

#register_user(params = {}) ⇒ Types::RegisterUserResponse

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

Examples:

Request syntax with placeholder values


resp = client.register_user({
  identity_type: "IAM", # required, accepts IAM, QUICKSIGHT
  email: "String", # required
  user_role: "ADMIN", # required, accepts ADMIN, AUTHOR, READER, RESTRICTED_AUTHOR, RESTRICTED_READER
  iam_arn: "String",
  session_name: "RoleSessionName",
  aws_account_id: "AwsAccountId", # required
  namespace: "Namespace", # required
  user_name: "UserName",
  custom_permissions_name: "RoleName",
})

Response structure


resp.user.arn #=> String
resp.user.user_name #=> String
resp.user.email #=> String
resp.user.role #=> String, one of "ADMIN", "AUTHOR", "READER", "RESTRICTED_AUTHOR", "RESTRICTED_READER"
resp.user.identity_type #=> String, one of "IAM", "QUICKSIGHT"
resp.user.active #=> Boolean
resp.user.principal_id #=> String
resp.user.custom_permissions_name #=> String
resp.user_invitation_url #=> String
resp.request_id #=> String
resp.status #=> Integer

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :identity_type (required, 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.

  • :email (required, String)

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

  • :user_role (required, 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.

  • :iam_arn (String)

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

  • :session_name (String)

    You need to use this parameter only when you register one or more users using an assumed IAM role. You don't need to provide the session name for other scenarios, for example when you are registering an IAM user or an Amazon QuickSight user. You can register multiple users using the same IAM role if each user has a different session name. For more information on assuming IAM roles, see assume-role in the AWS CLI Reference.

  • :aws_account_id (required, 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 (required, String)

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

  • :user_name (String)

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

  • :custom_permissions_name (String) — default: Enterprise edition only

    The name of the custom permissions profile that you want to assign to this user. Currently, custom permissions profile names are assigned to permissions profiles in the QuickSight console. You use this API to assign the named set of permissions to a QuickSight user.

    Customizing permissions in the QuickSight UI allows you to control a user's access to the following operations:

    * * * *

    QuickSight custom permissions are applied through IAM policies. Therefore, they override the permissions typically granted by assigning QuickSight users to one of the default security cohorts (admin, author, reader) in QuickSight.

    This feature is available only to QuickSight Enterprise edition subscriptions that use SAML 2.0-Based Federation for Single Sign-On (SSO).

Returns:

See Also:



4777
4778
4779
4780
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 4777

def register_user(params = {}, options = {})
  req = build_request(:register_user, params)
  req.send_request(options)
end

#search_dashboards(params = {}) ⇒ Types::SearchDashboardsResponse

Searchs for dashboards that belong to a user.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.search_dashboards({
  aws_account_id: "AwsAccountId", # required
  filters: [ # required
    {
      operator: "StringEquals", # required, accepts StringEquals
      name: "QUICKSIGHT_USER", # accepts QUICKSIGHT_USER
      value: "String",
    },
  ],
  next_token: "String",
  max_results: 1,
})

Response structure


resp.dashboard_summary_list #=> Array
resp.dashboard_summary_list[0].arn #=> String
resp.dashboard_summary_list[0].dashboard_id #=> String
resp.dashboard_summary_list[0].name #=> String
resp.dashboard_summary_list[0].created_time #=> Time
resp.dashboard_summary_list[0].last_updated_time #=> Time
resp.dashboard_summary_list[0].published_version_number #=> Integer
resp.dashboard_summary_list[0].last_published_time #=> Time
resp.next_token #=> String
resp.status #=> Integer
resp.request_id #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :aws_account_id (required, String)

    The ID of the AWS account that contains the user whose dashboards you're searching for.

  • :filters (required, Array<Types::DashboardSearchFilter>)

    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" \} ]

  • :next_token (String)

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

  • :max_results (Integer)

    The maximum number of results to be returned per request.

Returns:

See Also:



4843
4844
4845
4846
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 4843

def search_dashboards(params = {}, options = {})
  req = build_request(:search_dashboards, params)
  req.send_request(options)
end

#tag_resource(params = {}) ⇒ Types::TagResourceResponse

Assigns one or more tags (key-value pairs) to the specified QuickSight resource.

Tags can help you organize and categorize your resources. You can also use them to scope user permissions, by granting a user permission to access or change only resources with certain tag values. You can use the TagResource 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. QuickSight supports tagging on data set, data source, dashboard, and template.

Tagging for 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 QuickSight. This restriction is because QuickSight costs are based on users and SPICE capacity, which aren't taggable resources.

  • QuickSight doesn't currently support the Tag Editor for AWS Resource Groups.

Examples:

Request syntax with placeholder values


resp = client.tag_resource({
  resource_arn: "Arn", # required
  tags: [ # required
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
})

Response structure


resp.request_id #=> String
resp.status #=> Integer

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :resource_arn (required, String)

    The Amazon Resource Name (ARN) of the resource that you want to tag.

  • :tags (required, Array<Types::Tag>)

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

Returns:

See Also:



4906
4907
4908
4909
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 4906

def tag_resource(params = {}, options = {})
  req = build_request(:tag_resource, params)
  req.send_request(options)
end

#untag_resource(params = {}) ⇒ Types::UntagResourceResponse

Removes a tag or tags from a resource.

Examples:

Request syntax with placeholder values


resp = client.untag_resource({
  resource_arn: "Arn", # required
  tag_keys: ["TagKey"], # required
})

Response structure


resp.request_id #=> String
resp.status #=> Integer

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :resource_arn (required, String)

    The Amazon Resource Name (ARN) of the resource that you want to untag.

  • :tag_keys (required, Array<String>)

    The keys of the key-value pairs for the resource tag or tags assigned to the resource.

Returns:

See Also:



4941
4942
4943
4944
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 4941

def untag_resource(params = {}, options = {})
  req = build_request(:untag_resource, params)
  req.send_request(options)
end

#update_account_customization(params = {}) ⇒ Types::UpdateAccountCustomizationResponse

Updates customizations associated with the QuickSight subscription on your AWS account.

Examples:

Request syntax with placeholder values


resp = client.({
  aws_account_id: "AwsAccountId", # required
  namespace: "Namespace",
  account_customization: { # required
    default_theme: "Arn",
  },
})

Response structure


resp. #=> String
resp.namespace #=> String
resp..default_theme #=> String
resp.request_id #=> String
resp.status #=> Integer

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :aws_account_id (required, String)

    The ID for the AWS account that you want to update QuickSight customizations for.

  • :namespace (String)

    The namespace associated with the customization that you're updating.

  • :account_customization (required, Types::AccountCustomization)

    The customizations you want to update in QuickSight.

Returns:

See Also:



4989
4990
4991
4992
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 4989

def (params = {}, options = {})
  req = build_request(:update_account_customization, params)
  req.send_request(options)
end

#update_account_settings(params = {}) ⇒ Types::UpdateAccountSettingsResponse

Updates the settings for the Amazon QuickSight subscription in your AWS Account.

Examples:

Request syntax with placeholder values


resp = client.({
  aws_account_id: "AwsAccountId", # required
  default_namespace: "Namespace", # required
  notification_email: "String",
})

Response structure


resp.request_id #=> String
resp.status #=> Integer

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :aws_account_id (required, String)

    The ID for the AWS account that contains the QuickSight namespaces that you want to list.

  • :default_namespace (required, String)

    The default namespace for this AWS Account. Currently, the default is default. IAM users who register for the first time with QuickSight provide an email that becomes associated with the default namespace.

  • :notification_email (String)

    Email address used to send notifications regarding administration of QuickSight.

Returns:

See Also:



5032
5033
5034
5035
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 5032

def (params = {}, options = {})
  req = build_request(:update_account_settings, params)
  req.send_request(options)
end

#update_dashboard(params = {}) ⇒ Types::UpdateDashboardResponse

Updates a dashboard in an AWS account.

Examples:

Request syntax with placeholder values


resp = client.update_dashboard({
  aws_account_id: "AwsAccountId", # required
  dashboard_id: "RestrictiveResourceId", # required
  name: "DashboardName", # required
  source_entity: { # required
    source_template: {
      data_set_references: [ # required
        {
          data_set_placeholder: "NonEmptyString", # required
          data_set_arn: "Arn", # required
        },
      ],
      arn: "Arn", # required
    },
  },
  parameters: {
    string_parameters: [
      {
        name: "NonEmptyString", # required
        values: ["String"], # required
      },
    ],
    integer_parameters: [
      {
        name: "NonEmptyString", # required
        values: [1], # required
      },
    ],
    decimal_parameters: [
      {
        name: "NonEmptyString", # required
        values: [1.0], # required
      },
    ],
    date_time_parameters: [
      {
        name: "NonEmptyString", # required
        values: [Time.now], # required
      },
    ],
  },
  version_description: "VersionDescription",
  dashboard_publish_options: {
    ad_hoc_filtering_option: {
      availability_status: "ENABLED", # accepts ENABLED, DISABLED
    },
    export_to_csv_option: {
      availability_status: "ENABLED", # accepts ENABLED, DISABLED
    },
    sheet_controls_option: {
      visibility_state: "EXPANDED", # accepts EXPANDED, COLLAPSED
    },
  },
  theme_arn: "Arn",
})

Response structure


resp.arn #=> String
resp.version_arn #=> String
resp.dashboard_id #=> String
resp.creation_status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED"
resp.status #=> Integer
resp.request_id #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :aws_account_id (required, String)

    The ID of the AWS account that contains the dashboard that you're updating.

  • :dashboard_id (required, String)

    The ID for the dashboard.

  • :name (required, String)

    The display name of the dashboard.

  • :source_entity (required, Types::DashboardSourceEntity)

    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 AWS Account and any QuickSight-supported AWS 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.

  • :parameters (Types::Parameters)

    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.

  • :version_description (String)

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

  • :dashboard_publish_options (Types::DashboardPublishOptions)

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

  • :theme_arn (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 AWS account where you create the dashboard.

Returns:

See Also:



5176
5177
5178
5179
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 5176

def update_dashboard(params = {}, options = {})
  req = build_request(:update_dashboard, params)
  req.send_request(options)
end

#update_dashboard_permissions(params = {}) ⇒ Types::UpdateDashboardPermissionsResponse

Updates read and write permissions on a dashboard.

Examples:

Request syntax with placeholder values


resp = client.update_dashboard_permissions({
  aws_account_id: "AwsAccountId", # required
  dashboard_id: "RestrictiveResourceId", # required
  grant_permissions: [
    {
      principal: "Principal", # required
      actions: ["String"], # required
    },
  ],
  revoke_permissions: [
    {
      principal: "Principal", # required
      actions: ["String"], # required
    },
  ],
})

Response structure


resp.dashboard_arn #=> String
resp.dashboard_id #=> String
resp.permissions #=> Array
resp.permissions[0].principal #=> String
resp.permissions[0].actions #=> Array
resp.permissions[0].actions[0] #=> String
resp.request_id #=> String
resp.status #=> Integer

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :aws_account_id (required, String)

    The ID of the AWS account that contains the dashboard whose permissions you're updating.

  • :dashboard_id (required, String)

    The ID for the dashboard.

  • :grant_permissions (Array<Types::ResourcePermission>)

    The permissions that you want to grant on this resource.

  • :revoke_permissions (Array<Types::ResourcePermission>)

    The permissions that you want to revoke from this resource.

Returns:

See Also:



5238
5239
5240
5241
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 5238

def update_dashboard_permissions(params = {}, options = {})
  req = build_request(:update_dashboard_permissions, params)
  req.send_request(options)
end
<