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

  • :plugins (Array<Seahorse::Client::Plugin>) — default: []] —

    A list of plugins to apply to the client. Each plugin is either a class name or an instance of a plugin class.

  • :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::SharedCredentials - Used for loading static credentials from a shared file, such as ~/.aws/config.

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

    • Aws::AssumeRoleWebIdentityCredentials - Used when you need to assume a role after providing credentials via the web.

    • Aws::SSOCredentials - Used for loading credentials from AWS SSO using an access token generated from aws login.

    • Aws::ProcessCredentials - Used for loading credentials from a process that outputs to stdout.

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

    • Aws::ECSCredentials - Used for loading credentials from instances running in ECS.

    • Aws::CognitoIdentityCredentials - Used for loading credentials from the Cognito Identity service.

    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/ECS IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of Aws::InstanceProfileCredentails or Aws::ECSCredentials to enable retries and extended timeouts. Instance profile credential fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED'] to true.
  • :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.

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

    See DefaultsModeConfiguration for a list of the accepted modes and the configuration defaults that are included.

  • :disable_host_prefix_injection (Boolean) — default: false —

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

  • :disable_request_compression (Boolean) — default: false —

    When set to 'true' the request body will not be compressed for supported operations.

  • :endpoint (String, URI::HTTPS, URI::HTTP) —

    Normally you should not configure the :endpoint option directly. This is normally constructed from the :region option. Configuring :endpoint is normally reserved for connecting to test or custom endpoints. The endpoint should be a URI formatted like:

    'http://example.com'
'https://example.com'
'http://example.com:123'
  • :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.

  • :ignore_configured_endpoint_urls (Boolean) —

    Setting to true disables use of endpoint URLs provided via environment variables and the shared configuration file.

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

  • :request_min_compression_size_bytes (Integer) — default: 10240 —

    The minimum size in bytes that triggers compression for request bodies. The value must be non-negative integer value between 0 and 10485780 bytes inclusive.

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

  • :sdk_ua_app_id (String) —

    A unique and opaque application ID that is appended to the User-Agent header as app/sdk_ua_app_id. It should have a maximum length of 50. This variable is sourced from environment variable AWS_SDK_UA_APP_ID or the shared config profile attribute sdk_ua_app_id.

  • :secret_access_key (String)
  • :session_token (String)
  • :sigv4a_signing_region_set (Array) —

    A list of regions that should be signed with SigV4a signing. When not passed, a default :sigv4a_signing_region_set is searched for in the following locations:

    • Aws.config[:sigv4a_signing_region_set]
    • ENV['AWS_SIGV4A_SIGNING_REGION_SET']
    • ~/.aws/config
  • :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.

  • :telemetry_provider (Aws::Telemetry::TelemetryProviderBase) — default: Aws::Telemetry::NoOpTelemetryProvider —

    Allows you to provide a telemetry provider, which is used to emit telemetry data. By default, uses NoOpTelemetryProvider which will not record or emit any telemetry data. The SDK supports the following telemetry providers:

    • OpenTelemetry (OTel) - To use the OTel provider, install and require the opentelemetry-sdk gem and then, pass in an instance of a Aws::Telemetry::OTelProvider for telemetry provider.
  • :token_provider (Aws::TokenProvider) —

    A Bearer Token Provider. This can be an instance of any one of the following classes:

    • Aws::StaticTokenProvider - Used for configuring static, non-refreshing tokens.

    • Aws::SSOTokenProvider - Used for loading tokens from AWS SSO using an access token generated from aws login.

    When :token_provider is not configured directly, the Aws::TokenProviderChain will be used to search for tokens configured for your profile in shared configuration files.

  • :use_dualstack_endpoint (Boolean) —

    When set to true, dualstack enabled endpoints (with .aws TLD) will be used if available.

  • :use_fips_endpoint (Boolean) —

    When set to true, fips compatible endpoints will be used if available. When a fips region is used, the region is normalized and this config is set to true.

  • :validate_params (Boolean) — default: true —

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

  • :endpoint_provider (Aws::QuickSight::EndpointProvider) —

    The endpoint provider used to resolve endpoints. Any object that responds to #resolve_endpoint(parameters) where parameters is a Struct similar to Aws::QuickSight::EndpointParameters

  • :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_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_open_timeout (Float) — default: 15 —

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

  • :http_proxy (URI::HTTP, String) —

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

  • :http_read_timeout (Float) — default: 60 —

    The default number of seconds to wait for response data. 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.

  • :on_chunk_received (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the response body is received. It provides three arguments: the chunk, the number of bytes received, and the total number of bytes in the response (or nil if the server did not send a content-length).

  • :on_chunk_sent (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the request body is sent. It provides three arguments: the chunk, the number of bytes read from the body, and the total number of bytes in the body.

  • :raise_response_errors (Boolean) — default: true —

    When true, response errors are raised.

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

  • :ssl_ca_store (String) —

    Sets the X509::Store to verify peer certificate.

  • :ssl_cert (OpenSSL::X509::Certificate) —

    Sets a client certificate when creating http connections.

  • :ssl_key (OpenSSL::PKey) —

    Sets a client key when creating http connections.

  • :ssl_timeout (Float) —

    Sets the SSL timeout in seconds

  • :ssl_verify_peer (Boolean) — default: true —

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



440
441
442
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 440

def initialize(*args)
  super
end

Instance Method Details

#batch_create_topic_reviewed_answer(params = {}) ⇒ Types::BatchCreateTopicReviewedAnswerResponse

Creates new reviewed answers for a Q Topic.

Examples:

Request syntax with placeholder values


resp = client.batch_create_topic_reviewed_answer({
  aws_account_id: "AwsAccountId", # required
  topic_id: "TopicId", # required
  answers: [ # required
    {
      answer_id: "AnswerId", # required
      dataset_arn: "Arn", # required
      question: "LimitedString", # required
      mir: {
        metrics: [
          {
            metric_id: {
              identity: "LimitedString", # required
            },
            function: {
              aggregation: "SUM", # accepts SUM, MIN, MAX, COUNT, AVERAGE, DISTINCT_COUNT, STDEV, STDEVP, VAR, VARP, PERCENTILE, MEDIAN, PTD_SUM, PTD_MIN, PTD_MAX, PTD_COUNT, PTD_DISTINCT_COUNT, PTD_AVERAGE, COLUMN, CUSTOM
              aggregation_function_parameters: {
                "AggFunctionParamKey" => "AggFunctionParamValue",
              },
              period: "SECOND", # accepts SECOND, MINUTE, HOUR, DAY, WEEK, MONTH, QUARTER, YEAR
              period_field: "LimitedString",
            },
            operands: [
              {
                identity: "LimitedString", # required
              },
            ],
            comparison_method: {
              type: "DIFF", # accepts DIFF, PERC_DIFF, DIFF_AS_PERC, POP_CURRENT_DIFF_AS_PERC, POP_CURRENT_DIFF, POP_OVERTIME_DIFF_AS_PERC, POP_OVERTIME_DIFF, PERCENT_OF_TOTAL, RUNNING_SUM, MOVING_AVERAGE
              period: "SECOND", # accepts SECOND, MINUTE, HOUR, DAY, WEEK, MONTH, QUARTER, YEAR
              window_size: 1,
            },
            expression: "Expression",
            calculated_field_references: [
              {
                identity: "LimitedString", # required
              },
            ],
            display_format: "AUTO", # accepts AUTO, PERCENT, CURRENCY, NUMBER, DATE, STRING
            display_format_options: {
              use_blank_cell_format: false,
              blank_cell_format: "LimitedString",
              date_format: "LimitedString",
              decimal_separator: "COMMA", # accepts COMMA, DOT
              grouping_separator: "LimitedString",
              use_grouping: false,
              fraction_digits: 1,
              prefix: "LimitedString",
              suffix: "LimitedString",
              unit_scaler: "NONE", # accepts NONE, AUTO, THOUSANDS, MILLIONS, BILLIONS, TRILLIONS
              negative_format: {
                prefix: "LimitedString",
                suffix: "LimitedString",
              },
              currency_symbol: "LimitedString",
            },
            named_entity: {
              named_entity_name: "LimitedString",
            },
          },
        ],
        group_by_list: [
          {
            field_name: {
              identity: "LimitedString", # required
            },
            time_granularity: "SECOND", # accepts SECOND, MINUTE, HOUR, DAY, WEEK, MONTH, QUARTER, YEAR
            sort: {
              operand: {
                identity: "LimitedString", # required
              },
              sort_direction: "ASCENDING", # accepts ASCENDING, DESCENDING
            },
            display_format: "AUTO", # accepts AUTO, PERCENT, CURRENCY, NUMBER, DATE, STRING
            display_format_options: {
              use_blank_cell_format: false,
              blank_cell_format: "LimitedString",
              date_format: "LimitedString",
              decimal_separator: "COMMA", # accepts COMMA, DOT
              grouping_separator: "LimitedString",
              use_grouping: false,
              fraction_digits: 1,
              prefix: "LimitedString",
              suffix: "LimitedString",
              unit_scaler: "NONE", # accepts NONE, AUTO, THOUSANDS, MILLIONS, BILLIONS, TRILLIONS
              negative_format: {
                prefix: "LimitedString",
                suffix: "LimitedString",
              },
              currency_symbol: "LimitedString",
            },
            named_entity: {
              named_entity_name: "LimitedString",
            },
          },
        ],
        filters: [
          [
            {
              filter_type: "CATEGORY_FILTER", # accepts CATEGORY_FILTER, NUMERIC_EQUALITY_FILTER, NUMERIC_RANGE_FILTER, DATE_RANGE_FILTER, RELATIVE_DATE_FILTER, TOP_BOTTOM_FILTER, EQUALS, RANK_LIMIT_FILTER, ACCEPT_ALL_FILTER
              filter_class: "ENFORCED_VALUE_FILTER", # accepts ENFORCED_VALUE_FILTER, CONDITIONAL_VALUE_FILTER, NAMED_VALUE_FILTER
              operand_field: {
                identity: "LimitedString", # required
              },
              function: "CONTAINS", # accepts CONTAINS, EXACT, STARTS_WITH, ENDS_WITH, CONTAINS_STRING, PREVIOUS, THIS, LAST, NEXT, NOW
              constant: {
                constant_type: "SINGULAR", # accepts SINGULAR, RANGE, COLLECTIVE
                value: "ConstantValueString",
                minimum: "ConstantValueString",
                maximum: "ConstantValueString",
                value_list: [
                  {
                    constant_type: "SINGULAR", # accepts SINGULAR, RANGE, COLLECTIVE
                    value: "ConstantValueString",
                  },
                ],
              },
              inverse: false,
              null_filter: "ALL_VALUES", # accepts ALL_VALUES, NON_NULLS_ONLY, NULLS_ONLY
              aggregation: "SUM", # accepts SUM, MIN, MAX, COUNT, AVERAGE, DISTINCT_COUNT, STDEV, STDEVP, VAR, VARP, PERCENTILE, MEDIAN, PTD_SUM, PTD_MIN, PTD_MAX, PTD_COUNT, PTD_DISTINCT_COUNT, PTD_AVERAGE, COLUMN, CUSTOM
              aggregation_function_parameters: {
                "AggFunctionParamKey" => "AggFunctionParamValue",
              },
              aggregation_partition_by: [
                {
                  field_name: "LimitedString",
                  time_granularity: "YEAR", # accepts YEAR, QUARTER, MONTH, WEEK, DAY, HOUR, MINUTE, SECOND, MILLISECOND
                },
              ],
              range: {
                constant_type: "SINGULAR", # accepts SINGULAR, RANGE, COLLECTIVE
                value: "ConstantValueString",
                minimum: "ConstantValueString",
                maximum: "ConstantValueString",
                value_list: [
                  {
                    constant_type: "SINGULAR", # accepts SINGULAR, RANGE, COLLECTIVE
                    value: "ConstantValueString",
                  },
                ],
              },
              inclusive: false,
              time_granularity: "YEAR", # accepts YEAR, QUARTER, MONTH, WEEK, DAY, HOUR, MINUTE, SECOND, MILLISECOND
              last_next_offset: {
                constant_type: "SINGULAR", # accepts SINGULAR, RANGE, COLLECTIVE
                value: "ConstantValueString",
                minimum: "ConstantValueString",
                maximum: "ConstantValueString",
                value_list: [
                  {
                    constant_type: "SINGULAR", # accepts SINGULAR, RANGE, COLLECTIVE
                    value: "ConstantValueString",
                  },
                ],
              },
              agg_metrics: [
                {
                  metric_operand: {
                    identity: "LimitedString", # required
                  },
                  function: "SUM", # accepts SUM, MIN, MAX, COUNT, AVERAGE, DISTINCT_COUNT, STDEV, STDEVP, VAR, VARP, PERCENTILE, MEDIAN, PTD_SUM, PTD_MIN, PTD_MAX, PTD_COUNT, PTD_DISTINCT_COUNT, PTD_AVERAGE, COLUMN, CUSTOM
                  sort_direction: "ASCENDING", # accepts ASCENDING, DESCENDING
                },
              ],
              top_bottom_limit: {
                constant_type: "SINGULAR", # accepts SINGULAR, RANGE, COLLECTIVE
                value: "ConstantValueString",
                minimum: "ConstantValueString",
                maximum: "ConstantValueString",
                value_list: [
                  {
                    constant_type: "SINGULAR", # accepts SINGULAR, RANGE, COLLECTIVE
                    value: "ConstantValueString",
                  },
                ],
              },
              sort_direction: "ASCENDING", # accepts ASCENDING, DESCENDING
              anchor: {
                anchor_type: "TODAY", # accepts TODAY
                time_granularity: "YEAR", # accepts YEAR, QUARTER, MONTH, WEEK, DAY, HOUR, MINUTE, SECOND, MILLISECOND
                offset: 1,
              },
            },
          ],
        ],
        sort: {
          operand: {
            identity: "LimitedString", # required
          },
          sort_direction: "ASCENDING", # accepts ASCENDING, DESCENDING
        },
        contribution_analysis: {
          factors: [
            {
              field_name: "LimitedString",
            },
          ],
          time_ranges: {
            start_range: {
              filter_type: "CATEGORY_FILTER", # accepts CATEGORY_FILTER, NUMERIC_EQUALITY_FILTER, NUMERIC_RANGE_FILTER, DATE_RANGE_FILTER, RELATIVE_DATE_FILTER, TOP_BOTTOM_FILTER, EQUALS, RANK_LIMIT_FILTER, ACCEPT_ALL_FILTER
              filter_class: "ENFORCED_VALUE_FILTER", # accepts ENFORCED_VALUE_FILTER, CONDITIONAL_VALUE_FILTER, NAMED_VALUE_FILTER
              operand_field: {
                identity: "LimitedString", # required
              },
              function: "CONTAINS", # accepts CONTAINS, EXACT, STARTS_WITH, ENDS_WITH, CONTAINS_STRING, PREVIOUS, THIS, LAST, NEXT, NOW
              constant: {
                constant_type: "SINGULAR", # accepts SINGULAR, RANGE, COLLECTIVE
                value: "ConstantValueString",
                minimum: "ConstantValueString",
                maximum: "ConstantValueString",
                value_list: [
                  {
                    constant_type: "SINGULAR", # accepts SINGULAR, RANGE, COLLECTIVE
                    value: "ConstantValueString",
                  },
                ],
              },
              inverse: false,
              null_filter: "ALL_VALUES", # accepts ALL_VALUES, NON_NULLS_ONLY, NULLS_ONLY
              aggregation: "SUM", # accepts SUM, MIN, MAX, COUNT, AVERAGE, DISTINCT_COUNT, STDEV, STDEVP, VAR, VARP, PERCENTILE, MEDIAN, PTD_SUM, PTD_MIN, PTD_MAX, PTD_COUNT, PTD_DISTINCT_COUNT, PTD_AVERAGE, COLUMN, CUSTOM
              aggregation_function_parameters: {
                "AggFunctionParamKey" => "AggFunctionParamValue",
              },
              aggregation_partition_by: [
                {
                  field_name: "LimitedString",
                  time_granularity: "YEAR", # accepts YEAR, QUARTER, MONTH, WEEK, DAY, HOUR, MINUTE, SECOND, MILLISECOND
                },
              ],
              range: {
                constant_type: "SINGULAR", # accepts SINGULAR, RANGE, COLLECTIVE
                value: "ConstantValueString",
                minimum: "ConstantValueString",
                maximum: "ConstantValueString",
                value_list: [
                  {
                    constant_type: "SINGULAR", # accepts SINGULAR, RANGE, COLLECTIVE
                    value: "ConstantValueString",
                  },
                ],
              },
              inclusive: false,
              time_granularity: "YEAR", # accepts YEAR, QUARTER, MONTH, WEEK, DAY, HOUR, MINUTE, SECOND, MILLISECOND
              last_next_offset: {
                constant_type: "SINGULAR", # accepts SINGULAR, RANGE, COLLECTIVE
                value: "ConstantValueString",
                minimum: "ConstantValueString",
                maximum: "ConstantValueString",
                value_list: [
                  {
                    constant_type: "SINGULAR", # accepts SINGULAR, RANGE, COLLECTIVE
                    value: "ConstantValueString",
                  },
                ],
              },
              agg_metrics: [
                {
                  metric_operand: {
                    identity: "LimitedString", # required
                  },
                  function: "SUM", # accepts SUM, MIN, MAX, COUNT, AVERAGE, DISTINCT_COUNT, STDEV, STDEVP, VAR, VARP, PERCENTILE, MEDIAN, PTD_SUM, PTD_MIN, PTD_MAX, PTD_COUNT, PTD_DISTINCT_COUNT, PTD_AVERAGE, COLUMN, CUSTOM
                  sort_direction: "ASCENDING", # accepts ASCENDING, DESCENDING
                },
              ],
              top_bottom_limit: {
                constant_type: "SINGULAR", # accepts SINGULAR, RANGE, COLLECTIVE
                value: "ConstantValueString",
                minimum: "ConstantValueString",
                maximum: "ConstantValueString",
                value_list: [
                  {
                    constant_type: "SINGULAR", # accepts SINGULAR, RANGE, COLLECTIVE
                    value: "ConstantValueString",
                  },
                ],
              },
              sort_direction: "ASCENDING", # accepts ASCENDING, DESCENDING
              anchor: {
                anchor_type: "TODAY", # accepts TODAY
                time_granularity: "YEAR", # accepts YEAR, QUARTER, MONTH, WEEK, DAY, HOUR, MINUTE, SECOND, MILLISECOND
                offset: 1,
              },
            },
            end_range: {
              filter_type: "CATEGORY_FILTER", # accepts CATEGORY_FILTER, NUMERIC_EQUALITY_FILTER, NUMERIC_RANGE_FILTER, DATE_RANGE_FILTER, RELATIVE_DATE_FILTER, TOP_BOTTOM_FILTER, EQUALS, RANK_LIMIT_FILTER, ACCEPT_ALL_FILTER
              filter_class: "ENFORCED_VALUE_FILTER", # accepts ENFORCED_VALUE_FILTER, CONDITIONAL_VALUE_FILTER, NAMED_VALUE_FILTER
              operand_field: {
                identity: "LimitedString", # required
              },
              function: "CONTAINS", # accepts CONTAINS, EXACT, STARTS_WITH, ENDS_WITH, CONTAINS_STRING, PREVIOUS, THIS, LAST, NEXT, NOW
              constant: {
                constant_type: "SINGULAR", # accepts SINGULAR, RANGE, COLLECTIVE
                value: "ConstantValueString",
                minimum: "ConstantValueString",
                maximum: "ConstantValueString",
                value_list: [
                  {
                    constant_type: "SINGULAR", # accepts SINGULAR, RANGE, COLLECTIVE
                    value: "ConstantValueString",
                  },
                ],
              },
              inverse: false,
              null_filter: "ALL_VALUES", # accepts ALL_VALUES, NON_NULLS_ONLY, NULLS_ONLY
              aggregation: "SUM", # accepts SUM, MIN, MAX, COUNT, AVERAGE, DISTINCT_COUNT, STDEV, STDEVP, VAR, VARP, PERCENTILE, MEDIAN, PTD_SUM, PTD_MIN, PTD_MAX, PTD_COUNT, PTD_DISTINCT_COUNT, PTD_AVERAGE, COLUMN, CUSTOM
              aggregation_function_parameters: {
                "AggFunctionParamKey" => "AggFunctionParamValue",
              },
              aggregation_partition_by: [
                {
                  field_name: "LimitedString",
                  time_granularity: "YEAR", # accepts YEAR, QUARTER, MONTH, WEEK, DAY, HOUR, MINUTE, SECOND, MILLISECOND
                },
              ],
              range: {
                constant_type: "SINGULAR", # accepts SINGULAR, RANGE, COLLECTIVE
                value: "ConstantValueString",
                minimum: "ConstantValueString",
                maximum: "ConstantValueString",
                value_list: [
                  {
                    constant_type: "SINGULAR", # accepts SINGULAR, RANGE, COLLECTIVE
                    value: "ConstantValueString",
                  },
                ],
              },
              inclusive: false,
              time_granularity: "YEAR", # accepts YEAR, QUARTER, MONTH, WEEK, DAY, HOUR, MINUTE, SECOND, MILLISECOND
              last_next_offset: {
                constant_type: "SINGULAR", # accepts SINGULAR, RANGE, COLLECTIVE
                value: "ConstantValueString",
                minimum: "ConstantValueString",
                maximum: "ConstantValueString",
                value_list: [
                  {
                    constant_type: "SINGULAR", # accepts SINGULAR, RANGE, COLLECTIVE
                    value: "ConstantValueString",
                  },
                ],
              },
              agg_metrics: [
                {
                  metric_operand: {
                    identity: "LimitedString", # required
                  },
                  function: "SUM", # accepts SUM, MIN, MAX, COUNT, AVERAGE, DISTINCT_COUNT, STDEV, STDEVP, VAR, VARP, PERCENTILE, MEDIAN, PTD_SUM, PTD_MIN, PTD_MAX, PTD_COUNT, PTD_DISTINCT_COUNT, PTD_AVERAGE, COLUMN, CUSTOM
                  sort_direction: "ASCENDING", # accepts ASCENDING, DESCENDING
                },
              ],
              top_bottom_limit: {
                constant_type: "SINGULAR", # accepts SINGULAR, RANGE, COLLECTIVE
                value: "ConstantValueString",
                minimum: "ConstantValueString",
                maximum: "ConstantValueString",
                value_list: [
                  {
                    constant_type: "SINGULAR", # accepts SINGULAR, RANGE, COLLECTIVE
                    value: "ConstantValueString",
                  },
                ],
              },
              sort_direction: "ASCENDING", # accepts ASCENDING, DESCENDING
              anchor: {
                anchor_type: "TODAY", # accepts TODAY
                time_granularity: "YEAR", # accepts YEAR, QUARTER, MONTH, WEEK, DAY, HOUR, MINUTE, SECOND, MILLISECOND
                offset: 1,
              },
            },
          },
          direction: "INCREASE", # accepts INCREASE, DECREASE, NEUTRAL
          sort_type: "ABSOLUTE_DIFFERENCE", # accepts ABSOLUTE_DIFFERENCE, CONTRIBUTION_PERCENTAGE, DEVIATION_FROM_EXPECTED, PERCENTAGE_DIFFERENCE
        },
        visual: {
          type: "LimitedString",
        },
      },
      primary_visual: {
        visual_id: "LimitedString",
        role: "PRIMARY", # accepts PRIMARY, COMPLIMENTARY, MULTI_INTENT, FALLBACK, FRAGMENT
        ir: {
          metrics: [
            {
              metric_id: {
                identity: "LimitedString", # required
              },
              function: {
                aggregation: "SUM", # accepts SUM, MIN, MAX, COUNT, AVERAGE, DISTINCT_COUNT, STDEV, STDEVP, VAR, VARP, PERCENTILE, MEDIAN, PTD_SUM, PTD_MIN, PTD_MAX, PTD_COUNT, PTD_DISTINCT_COUNT, PTD_AVERAGE, COLUMN, CUSTOM
                aggregation_function_parameters: {
                  "AggFunctionParamKey" => "AggFunctionParamValue",
                },
                period: "SECOND", # accepts SECOND, MINUTE, HOUR, DAY, WEEK, MONTH, QUARTER, YEAR
                period_field: "LimitedString",
              },
              operands: [
                {
                  identity: "LimitedString", # required
                },
              ],
              comparison_method: {
                type: "DIFF", # accepts DIFF, PERC_DIFF, DIFF_AS_PERC, POP_CURRENT_DIFF_AS_PERC, POP_CURRENT_DIFF, POP_OVERTIME_DIFF_AS_PERC, POP_OVERTIME_DIFF, PERCENT_OF_TOTAL, RUNNING_SUM, MOVING_AVERAGE
                period: "SECOND", # accepts SECOND, MINUTE, HOUR, DAY, WEEK, MONTH, QUARTER, YEAR
                window_size: 1,
              },
              expression: "Expression",
              calculated_field_references: [
                {
                  identity: "LimitedString", # required
                },
              ],
              display_format: "AUTO", # accepts AUTO, PERCENT, CURRENCY, NUMBER, DATE, STRING
              display_format_options: {
                use_blank_cell_format: false,
                blank_cell_format: "LimitedString",
                date_format: "LimitedString",
                decimal_separator: "COMMA", # accepts COMMA, DOT
                grouping_separator: "LimitedString",
                use_grouping: false,
                fraction_digits: 1,
                prefix: "LimitedString",
                suffix: "LimitedString",
                unit_scaler: "NONE", # accepts NONE, AUTO, THOUSANDS, MILLIONS, BILLIONS, TRILLIONS
                negative_format: {
                  prefix: "LimitedString",
                  suffix: "LimitedString",
                },
                currency_symbol: "LimitedString",
              },
              named_entity: {
                named_entity_name: "LimitedString",
              },
            },
          ],
          group_by_list: [
            {
              field_name: {
                identity: "LimitedString", # required
              },
              time_granularity: "SECOND", # accepts SECOND, MINUTE, HOUR, DAY, WEEK, MONTH, QUARTER, YEAR
              sort: {
                operand: {
                  identity: "LimitedString", # required
                },
                sort_direction: "ASCENDING", # accepts ASCENDING, DESCENDING
              },
              display_format: "AUTO", # accepts AUTO, PERCENT, CURRENCY, NUMBER, DATE, STRING
              display_format_options: {
                use_blank_cell_format: false,
                blank_cell_format: "LimitedString",
                date_format: "LimitedString",
                decimal_separator: "COMMA", # accepts COMMA, DOT
                grouping_separator: "LimitedString",
                use_grouping: false,
                fraction_digits: 1,
                prefix: "LimitedString",
                suffix: "LimitedString",
                unit_scaler: "NONE", # accepts NONE, AUTO, THOUSANDS, MILLIONS, BILLIONS, TRILLIONS
                negative_format: {
                  prefix: "LimitedString",
                  suffix: "LimitedString",
                },
                currency_symbol: "LimitedString",
              },
              named_entity: {
                named_entity_name: "LimitedString",
              },
            },
          ],
          filters: [
            [
              {
                filter_type: "CATEGORY_FILTER", # accepts CATEGORY_FILTER, NUMERIC_EQUALITY_FILTER, NUMERIC_RANGE_FILTER, DATE_RANGE_FILTER, RELATIVE_DATE_FILTER, TOP_BOTTOM_FILTER, EQUALS, RANK_LIMIT_FILTER, ACCEPT_ALL_FILTER
                filter_class: "ENFORCED_VALUE_FILTER", # accepts ENFORCED_VALUE_FILTER, CONDITIONAL_VALUE_FILTER, NAMED_VALUE_FILTER
                operand_field: {
                  identity: "LimitedString", # required
                },
                function: "CONTAINS", # accepts CONTAINS, EXACT, STARTS_WITH, ENDS_WITH, CONTAINS_STRING, PREVIOUS, THIS, LAST, NEXT, NOW
                constant: {
                  constant_type: "SINGULAR", # accepts SINGULAR, RANGE, COLLECTIVE
                  value: "ConstantValueString",
                  minimum: "ConstantValueString",
                  maximum: "ConstantValueString",
                  value_list: [
                    {
                      constant_type: "SINGULAR", # accepts SINGULAR, RANGE, COLLECTIVE
                      value: "ConstantValueString",
                    },
                  ],
                },
                inverse: false,
                null_filter: "ALL_VALUES", # accepts ALL_VALUES, NON_NULLS_ONLY, NULLS_ONLY
                aggregation: "SUM", # accepts SUM, MIN, MAX, COUNT, AVERAGE, DISTINCT_COUNT, STDEV, STDEVP, VAR, VARP, PERCENTILE, MEDIAN, PTD_SUM, PTD_MIN, PTD_MAX, PTD_COUNT, PTD_DISTINCT_COUNT, PTD_AVERAGE, COLUMN, CUSTOM
                aggregation_function_parameters: {
                  "AggFunctionParamKey" => "AggFunctionParamValue",
                },
                aggregation_partition_by: [
                  {
                    field_name: "LimitedString",
                    time_granularity: "YEAR", # accepts YEAR, QUARTER, MONTH, WEEK, DAY, HOUR, MINUTE, SECOND, MILLISECOND
                  },
                ],
                range: {
                  constant_type: "SINGULAR", # accepts SINGULAR, RANGE, COLLECTIVE
                  value: "ConstantValueString",
                  minimum: "ConstantValueString",
                  maximum: "ConstantValueString",
                  value_list: [
                    {
                      constant_type: "SINGULAR", # accepts SINGULAR, RANGE, COLLECTIVE
                      value: "ConstantValueString",
                    },
                  ],
                },
                inclusive: false,
                time_granularity: "YEAR", # accepts YEAR, QUARTER, MONTH, WEEK, DAY, HOUR, MINUTE, SECOND, MILLISECOND
                last_next_offset: {
                  constant_type: "SINGULAR", # accepts SINGULAR, RANGE, COLLECTIVE
                  value: "ConstantValueString",
                  minimum: "ConstantValueString",
                  maximum: "ConstantValueString",
                  value_list: [
                    {
                      constant_type: "SINGULAR", # accepts SINGULAR, RANGE, COLLECTIVE
                      value: "ConstantValueString",
                    },
                  ],
                },
                agg_metrics: [
                  {
                    metric_operand: {
                      identity: "LimitedString", # required
                    },
                    function: "SUM", # accepts SUM, MIN, MAX, COUNT, AVERAGE, DISTINCT_COUNT, STDEV, STDEVP, VAR, VARP, PERCENTILE, MEDIAN, PTD_SUM, PTD_MIN, PTD_MAX, PTD_COUNT, PTD_DISTINCT_COUNT, PTD_AVERAGE, COLUMN, CUSTOM
                    sort_direction: "ASCENDING", # accepts ASCENDING, DESCENDING
                  },
                ],
                top_bottom_limit: {
                  constant_type: "SINGULAR", # accepts SINGULAR, RANGE, COLLECTIVE
                  value: "ConstantValueString",
                  minimum: "ConstantValueString",
                  maximum: "ConstantValueString",
                  value_list: [
                    {
                      constant_type: "SINGULAR", # accepts SINGULAR, RANGE, COLLECTIVE
                      value: "ConstantValueString",
                    },
                  ],
                },
                sort_direction: "ASCENDING", # accepts ASCENDING, DESCENDING
                anchor: {
                  anchor_type: "TODAY", # accepts TODAY
                  time_granularity: "YEAR", # accepts YEAR, QUARTER, MONTH, WEEK, DAY, HOUR, MINUTE, SECOND, MILLISECOND
                  offset: 1,
                },
              },
            ],
          ],
          sort: {
            operand: {
              identity: "LimitedString", # required
            },
            sort_direction: "ASCENDING", # accepts ASCENDING, DESCENDING
          },
          contribution_analysis: {
            factors: [
              {
                field_name: "LimitedString",
              },
            ],
            time_ranges: {
              start_range: {
                filter_type: "CATEGORY_FILTER", # accepts CATEGORY_FILTER, NUMERIC_EQUALITY_FILTER, NUMERIC_RANGE_FILTER, DATE_RANGE_FILTER, RELATIVE_DATE_FILTER, TOP_BOTTOM_FILTER, EQUALS, RANK_LIMIT_FILTER, ACCEPT_ALL_FILTER
                filter_class: "ENFORCED_VALUE_FILTER", # accepts ENFORCED_VALUE_FILTER, CONDITIONAL_VALUE_FILTER, NAMED_VALUE_FILTER
                operand_field: {
                  identity: "LimitedString", # required
                },
                function: "CONTAINS", # accepts CONTAINS, EXACT, STARTS_WITH, ENDS_WITH, CONTAINS_STRING, PREVIOUS, THIS, LAST, NEXT, NOW
                constant: {
                  constant_type: "SINGULAR", # accepts SINGULAR, RANGE, COLLECTIVE
                  value: "ConstantValueString",
                  minimum: "ConstantValueString",
                  maximum: "ConstantValueString",
                  value_list: [
                    {
                      constant_type: "SINGULAR", # accepts SINGULAR, RANGE, COLLECTIVE
                      value: "ConstantValueString",
                    },
                  ],
                },
                inverse: false,
                null_filter: "ALL_VALUES", # accepts ALL_VALUES, NON_NULLS_ONLY, NULLS_ONLY
                aggregation: "SUM", # accepts SUM, MIN, MAX, COUNT, AVERAGE, DISTINCT_COUNT, STDEV, STDEVP, VAR, VARP, PERCENTILE, MEDIAN, PTD_SUM, PTD_MIN, PTD_MAX, PTD_COUNT, PTD_DISTINCT_COUNT, PTD_AVERAGE, COLUMN, CUSTOM
                aggregation_function_parameters: {
                  "AggFunctionParamKey" => "AggFunctionParamValue",
                },
                aggregation_partition_by: [
                  {
                    field_name: "LimitedString",
                    time_granularity: "YEAR", # accepts YEAR, QUARTER, MONTH, WEEK, DAY, HOUR, MINUTE, SECOND, MILLISECOND
                  },
                ],
                range: {
                  constant_type: "SINGULAR", # accepts SINGULAR, RANGE, COLLECTIVE
                  value: "ConstantValueString",
                  minimum: "ConstantValueString",
                  maximum: "ConstantValueString",
                  value_list: [
                    {
                      constant_type: "SINGULAR", # accepts SINGULAR, RANGE, COLLECTIVE
                      value: "ConstantValueString",
                    },
                  ],
                },
                inclusive: false,
                time_granularity: "YEAR", # accepts YEAR, QUARTER, MONTH, WEEK, DAY, HOUR, MINUTE, SECOND, MILLISECOND
                last_next_offset: {
                  constant_type: "SINGULAR", # accepts SINGULAR, RANGE, COLLECTIVE
                  value: "ConstantValueString",
                  minimum: "ConstantValueString",
                  maximum: "ConstantValueString",
                  value_list: [
                    {
                      constant_type: "SINGULAR", # accepts SINGULAR, RANGE, COLLECTIVE
                      value: "ConstantValueString",
                    },
                  ],
                },
                agg_metrics: [
                  {
                    metric_operand: {
                      identity: "LimitedString", # required
                    },
                    function: "SUM", # accepts SUM, MIN, MAX, COUNT, AVERAGE, DISTINCT_COUNT, STDEV, STDEVP, VAR, VARP, PERCENTILE, MEDIAN, PTD_SUM, PTD_MIN, PTD_MAX, PTD_COUNT, PTD_DISTINCT_COUNT, PTD_AVERAGE, COLUMN, CUSTOM
                    sort_direction: "ASCENDING", # accepts ASCENDING, DESCENDING
                  },
                ],
                top_bottom_limit: {
                  constant_type: "SINGULAR", # accepts SINGULAR, RANGE, COLLECTIVE
                  value: "ConstantValueString",
                  minimum: "ConstantValueString",
                  maximum: "ConstantValueString",
                  value_list: [
                    {
                      constant_type: "SINGULAR", # accepts SINGULAR, RANGE, COLLECTIVE
                      value: "ConstantValueString",
                    },
                  ],
                },
                sort_direction: "ASCENDING", # accepts ASCENDING, DESCENDING
                anchor: {
                  anchor_type: "TODAY", # accepts TODAY
                  time_granularity: "YEAR", # accepts YEAR, QUARTER, MONTH, WEEK, DAY, HOUR, MINUTE, SECOND, MILLISECOND
                  offset: 1,
                },
              },
              end_range: {
                filter_type: "CATEGORY_FILTER", # accepts CATEGORY_FILTER, NUMERIC_EQUALITY_FILTER, NUMERIC_RANGE_FILTER, DATE_RANGE_FILTER, RELATIVE_DATE_FILTER, TOP_BOTTOM_FILTER, EQUALS, RANK_LIMIT_FILTER, ACCEPT_ALL_FILTER
                filter_class: "ENFORCED_VALUE_FILTER", # accepts ENFORCED_VALUE_FILTER, CONDITIONAL_VALUE_FILTER, NAMED_VALUE_FILTER
                operand_field: {
                  identity: "LimitedString", # required
                },
                function: "CONTAINS", # accepts CONTAINS, EXACT, STARTS_WITH, ENDS_WITH, CONTAINS_STRING, PREVIOUS, THIS, LAST, NEXT, NOW
                constant: {
                  constant_type: "SINGULAR", # accepts SINGULAR, RANGE, COLLECTIVE
                  value: "ConstantValueString",
                  minimum: "ConstantValueString",
                  maximum: "ConstantValueString",
                  value_list: [
                    {
                      constant_type: "SINGULAR", # accepts SINGULAR, RANGE, COLLECTIVE
                      value: "ConstantValueString",
                    },
                  ],
                },
                inverse: false,
                null_filter: "ALL_VALUES", # accepts ALL_VALUES, NON_NULLS_ONLY, NULLS_ONLY
                aggregation: "SUM", # accepts SUM, MIN, MAX, COUNT, AVERAGE, DISTINCT_COUNT, STDEV, STDEVP, VAR, VARP, PERCENTILE, MEDIAN, PTD_SUM, PTD_MIN, PTD_MAX, PTD_COUNT, PTD_DISTINCT_COUNT, PTD_AVERAGE, COLUMN, CUSTOM
                aggregation_function_parameters: {
                  "AggFunctionParamKey" => "AggFunctionParamValue",
                },
                aggregation_partition_by: [
                  {
                    field_name: "LimitedString",
                    time_granularity: "YEAR", # accepts YEAR, QUARTER, MONTH, WEEK, DAY, HOUR, MINUTE, SECOND, MILLISECOND
                  },
                ],
                range: {
                  constant_type: "SINGULAR", # accepts SINGULAR, RANGE, COLLECTIVE
                  value: "ConstantValueString",
                  minimum: "ConstantValueString",
                  maximum: "ConstantValueString",
                  value_list: [
                    {
                      constant_type: "SINGULAR", # accepts SINGULAR, RANGE, COLLECTIVE
                      value: "ConstantValueString",
                    },
                  ],
                },
                inclusive: false,
                time_granularity: "YEAR", # accepts YEAR, QUARTER, MONTH, WEEK, DAY, HOUR, MINUTE, SECOND, MILLISECOND
                last_next_offset: {
                  constant_type: "SINGULAR", # accepts SINGULAR, RANGE, COLLECTIVE
                  value: "ConstantValueString",
                  minimum: "ConstantValueString",
                  maximum: "ConstantValueString",
                  value_list: [
                    {
                      constant_type: "SINGULAR", # accepts SINGULAR, RANGE, COLLECTIVE
                      value: "ConstantValueString",
                    },
                  ],
                },
                agg_metrics: [
                  {
                    metric_operand: {
                      identity: "LimitedString", # required
                    },
                    function: "SUM", # accepts SUM, MIN, MAX, COUNT, AVERAGE, DISTINCT_COUNT, STDEV, STDEVP, VAR, VARP, PERCENTILE, MEDIAN, PTD_SUM, PTD_MIN, PTD_MAX, PTD_COUNT, PTD_DISTINCT_COUNT, PTD_AVERAGE, COLUMN, CUSTOM
                    sort_direction: "ASCENDING", # accepts ASCENDING, DESCENDING
                  },
                ],
                top_bottom_limit: {
                  constant_type: "SINGULAR", # accepts SINGULAR, RANGE, COLLECTIVE
                  value: "ConstantValueString",
                  minimum: "ConstantValueString",
                  maximum: "ConstantValueString",
                  value_list: [
                    {
                      constant_type: "SINGULAR", # accepts SINGULAR, RANGE, COLLECTIVE
                      value: "ConstantValueString",
                    },
                  ],
                },
                sort_direction: "ASCENDING", # accepts ASCENDING, DESCENDING
                anchor: {
                  anchor_type: "TODAY", # accepts TODAY
                  time_granularity: "YEAR", # accepts YEAR, QUARTER, MONTH, WEEK, DAY, HOUR, MINUTE, SECOND, MILLISECOND
                  offset: 1,
                },
              },
            },
            direction: "INCREASE", # accepts INCREASE, DECREASE, NEUTRAL
            sort_type: "ABSOLUTE_DIFFERENCE", # accepts ABSOLUTE_DIFFERENCE, CONTRIBUTION_PERCENTAGE, DEVIATION_FROM_EXPECTED, PERCENTAGE_DIFFERENCE
          },
          visual: {
            type: "LimitedString",
          },
        },
        supporting_visuals: [
          {
            # recursive TopicVisual
          },
        ],
      },
      template: {
        template_type: "LimitedString",
        slots: [
          {
            slot_id: "LimitedString",
            visual_id: "LimitedString",
          },
        ],
      },
    },
  ],
})

Response structure


resp.topic_id #=> String
resp.topic_arn #=> String
resp.succeeded_answers #=> Array
resp.succeeded_answers[0].answer_id #=> String
resp.invalid_answers #=> Array
resp.invalid_answers[0].answer_id #=> String
resp.invalid_answers[0].error #=> String, one of "INTERNAL_ERROR", "MISSING_ANSWER", "DATASET_DOES_NOT_EXIST", "INVALID_DATASET_ARN", "DUPLICATED_ANSWER", "INVALID_DATA", "MISSING_REQUIRED_FIELDS"
resp.status #=> Integer
resp.request_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :aws_account_id (required, String) —

    The ID of the Amazon Web Services account that you want to create a reviewed answer in.

  • :topic_id (required, String) —

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

  • :answers (required, Array<Types::CreateTopicReviewedAnswer>) —

    The definition of the Answers to be created.

Returns:

See Also:



1253
1254
1255
1256
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 1253

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

#batch_delete_topic_reviewed_answer(params = {}) ⇒ Types::BatchDeleteTopicReviewedAnswerResponse

Deletes reviewed answers for Q Topic.

Examples:

Request syntax with placeholder values


resp = client.batch_delete_topic_reviewed_answer({
  aws_account_id: "AwsAccountId", # required
  topic_id: "TopicId", # required
  answer_ids: ["AnswerId"],
})

Response structure


resp.topic_id #=> String
resp.topic_arn #=> String
resp.succeeded_answers #=> Array
resp.succeeded_answers[0].answer_id #=> String
resp.invalid_answers #=> Array
resp.invalid_answers[0].answer_id #=> String
resp.invalid_answers[0].error #=> String, one of "INTERNAL_ERROR", "MISSING_ANSWER", "DATASET_DOES_NOT_EXIST", "INVALID_DATASET_ARN", "DUPLICATED_ANSWER", "INVALID_DATA", "MISSING_REQUIRED_FIELDS"
resp.request_id #=> String
resp.status #=> Integer

Parameters:

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

    ({})

Options Hash (params):

  • :aws_account_id (required, String) —

    The ID of the Amazon Web Services account that you want to delete a reviewed answers in.

  • :topic_id (required, String) —

    The ID for the topic reviewed answer that you want to delete. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

  • :answer_ids (Array<String>) —

    The Answer IDs of the Answers to be deleted.

Returns:

See Also:



1305
1306
1307
1308
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 1305

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

#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 Amazon Web Services 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:



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

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

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

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

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

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

Examples:

Request syntax with placeholder values


resp = client.({
  aws_account_id: "AwsAccountId", # required
  namespace: "Namespace",
  account_customization: { # required
    default_theme: "Arn",
    default_email_customization_template: "Arn",
  },
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
})

Response structure


resp.arn #=> String
resp. #=> String
resp.namespace #=> String
resp..default_theme #=> String
resp..default_email_customization_template #=> 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 Amazon Web Services account that you want to customize Amazon QuickSight for.

  • :namespace (String) —

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

  • :account_customization (required, Types::AccountCustomization) —

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

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

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

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

Returns:

See Also:



1444
1445
1446
1447
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 1444

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

#create_account_subscription(params = {}) ⇒ Types::CreateAccountSubscriptionResponse

Creates an Amazon QuickSight account, or subscribes to Amazon QuickSight Q.

The Amazon Web Services Region for the account is derived from what is configured in the CLI or SDK.

Before you use this operation, make sure that you can connect to an existing Amazon Web Services account. If you don't have an Amazon Web Services account, see Sign up for Amazon Web Services in the Amazon QuickSight User Guide. The person who signs up for Amazon QuickSight needs to have the correct Identity and Access Management (IAM) permissions. For more information, see IAM Policy Examples for Amazon QuickSight in the Amazon QuickSight User Guide.

If your IAM policy includes both the Subscribe and CreateAccountSubscription actions, make sure that both actions are set to Allow. If either action is set to Deny, the Deny action prevails and your API call fails.

You can't pass an existing IAM role to access other Amazon Web Services services using this API operation. To pass your existing IAM role to Amazon QuickSight, see Passing IAM roles to Amazon QuickSight in the Amazon QuickSight User Guide.

You can't set default resource access on the new account from the Amazon QuickSight API. Instead, add default resource access from the Amazon QuickSight console. For more information about setting default resource access to Amazon Web Services services, see Setting default resource access to Amazon Web Services services in the Amazon QuickSight User Guide.

Examples:

Request syntax with placeholder values


resp = client.({
  edition: "STANDARD", # accepts STANDARD, ENTERPRISE, ENTERPRISE_AND_Q
  authentication_method: "IAM_AND_QUICKSIGHT", # required, accepts IAM_AND_QUICKSIGHT, IAM_ONLY, ACTIVE_DIRECTORY, IAM_IDENTITY_CENTER
  aws_account_id: "AwsAccountId", # required
  account_name: "AccountName", # required
  notification_email: "String", # required
  active_directory_name: "String",
  realm: "String",
  directory_id: "String",
  admin_group: ["String"],
  author_group: ["String"],
  reader_group: ["String"],
  admin_pro_group: ["String"],
  author_pro_group: ["String"],
  reader_pro_group: ["String"],
  first_name: "String",
  last_name: "String",
  email_address: "String",
  contact_number: "String",
  iam_identity_center_instance_arn: "String",
})

Response structure


resp..iam_user #=> Boolean
resp.. #=> String
resp.. #=> String
resp..directory_type #=> String
resp.status #=> Integer
resp.request_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :edition (String) —

    The edition of Amazon QuickSight that you want your account to have. Currently, you can choose from ENTERPRISE or ENTERPRISE_AND_Q.

    If you choose ENTERPRISE_AND_Q, the following parameters are required:

    • FirstName

    • LastName

    • EmailAddress

    • ContactNumber

  • :authentication_method (required, String) —

    The method that you want to use to authenticate your Amazon QuickSight account.

    If you choose ACTIVE_DIRECTORY, provide an ActiveDirectoryName and an AdminGroup associated with your Active Directory.

    If you choose IAM_IDENTITY_CENTER, provide an AdminGroup associated with your IAM Identity Center account.

  • :aws_account_id (required, String) —

    The Amazon Web Services account ID of the account that you're using to create your Amazon QuickSight account.

  • :account_name (required, String) —

    The name of your Amazon QuickSight account. This name is unique over all of Amazon Web Services, and it appears only when users sign in. You can't change AccountName value after the Amazon QuickSight account is created.

  • :notification_email (required, String) —

    The email address that you want Amazon QuickSight to send notifications to regarding your Amazon QuickSight account or Amazon QuickSight subscription.

  • :active_directory_name (String) —

    The name of your Active Directory. This field is required if ACTIVE_DIRECTORY is the selected authentication method of the new Amazon QuickSight account.

  • :realm (String) —

    The realm of the Active Directory that is associated with your Amazon QuickSight account. This field is required if ACTIVE_DIRECTORY is the selected authentication method of the new Amazon QuickSight account.

  • :directory_id (String) —

    The ID of the Active Directory that is associated with your Amazon QuickSight account.

  • :admin_group (Array<String>) —

    The admin group associated with your Active Directory or IAM Identity Center account. Either this field or the AdminProGroup field is required if ACTIVE_DIRECTORY or IAM_IDENTITY_CENTER is the selected authentication method of the new Amazon QuickSight account.

    For more information about using IAM Identity Center in Amazon QuickSight, see Using IAM Identity Center with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide. For more information about using Active Directory in Amazon QuickSight, see Using Active Directory with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide.

  • :author_group (Array<String>) —

    The author group associated with your Active Directory or IAM Identity Center account.

    For more information about using IAM Identity Center in Amazon QuickSight, see Using IAM Identity Center with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide. For more information about using Active Directory in Amazon QuickSight, see Using Active Directory with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide.

  • :reader_group (Array<String>) —

    The reader group associated with your Active Directory or IAM Identity Center account.

    For more information about using IAM Identity Center in Amazon QuickSight, see Using IAM Identity Center with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide. For more information about using Active Directory in Amazon QuickSight, see Using Active Directory with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide.

  • :admin_pro_group (Array<String>) —

    The admin pro group associated with your Active Directory or IAM Identity Center account. Either this field or the AdminGroup field is required if ACTIVE_DIRECTORY or IAM_IDENTITY_CENTER is the selected authentication method of the new Amazon QuickSight account.

    For more information about using IAM Identity Center in Amazon QuickSight, see Using IAM Identity Center with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide. For more information about using Active Directory in Amazon QuickSight, see Using Active Directory with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide.

  • :author_pro_group (Array<String>) —

    The author pro group associated with your Active Directory or IAM Identity Center account.

    For more information about using IAM Identity Center in Amazon QuickSight, see Using IAM Identity Center with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide. For more information about using Active Directory in Amazon QuickSight, see Using Active Directory with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide.

  • :reader_pro_group (Array<String>) —

    The reader pro group associated with your Active Directory or IAM Identity Center account.

    For more information about using IAM Identity Center in Amazon QuickSight, see Using IAM Identity Center with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide. For more information about using Active Directory in Amazon QuickSight, see Using Active Directory with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide.

  • :first_name (String) —

    The first name of the author of the Amazon QuickSight account to use for future communications. This field is required if ENTERPPRISE_AND_Q is the selected edition of the new Amazon QuickSight account.

  • :last_name (String) —

    The last name of the author of the Amazon QuickSight account to use for future communications. This field is required if ENTERPPRISE_AND_Q is the selected edition of the new Amazon QuickSight account.

  • :email_address (String) —

    The email address of the author of the Amazon QuickSight account to use for future communications. This field is required if ENTERPPRISE_AND_Q is the selected edition of the new Amazon QuickSight account.

  • :contact_number (String) —

    A 10-digit phone number for the author of the Amazon QuickSight account to use for future communications. This field is required if ENTERPPRISE_AND_Q is the selected edition of the new Amazon QuickSight account.

  • :iam_identity_center_instance_arn (String) —

    The Amazon Resource Name (ARN) for the IAM Identity Center instance.

Returns:

See Also:



1712
1713
1714
1715
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 1712

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

#create_analysis(params = {}) ⇒ Types::CreateAnalysisResponse

Creates an analysis in Amazon QuickSight. Analyses can be created either from a template or from an AnalysisDefinition.

Examples:

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :aws_account_id (required, String) —

    The ID of the Amazon Web Services account where you are creating an analysis.

  • :analysis_id (required, String) —

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

  • :name (required, String) —

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

  • :parameters (Types::Parameters) —

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

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

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

    To specify no permissions, omit Permissions.

  • :source_entity (Types::AnalysisSourceEntity) —

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

    Either a SourceEntity or a Definition must be provided in order for the request to be valid.

  • :theme_arn (String) —

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

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

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

  • :definition (Types::AnalysisDefinition) —

    The definition of an analysis.

    A definition is the data model of all features in a Dashboard, Template, or Analysis.

    Either a SourceEntity or a Definition must be provided in order for the request to be valid.

  • :validation_strategy (Types::ValidationStrategy) —

    The option to relax the validation needed to create an analysis with definition objects. This skips the validation step for specific errors.

  • :folder_arns (Array<String>) —

    When you create the analysis, Amazon QuickSight adds the analysis to these folders.

Returns:

See Also:



1801
1802
1803
1804
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 1801

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

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

Creates a dashboard from either a template or directly with a DashboardDefinition. To first create a template, see the CreateTemplate API operation.

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

Examples:

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", "DELETED"
resp.status #=> Integer
resp.request_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :aws_account_id (required, String) —

    The ID of the Amazon Web Services 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 by providing a list of IAM action information for each principal ARN.

    To specify no permissions, omit the permissions list.

  • :source_entity (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 Amazon Web Services account and any Amazon QuickSight-supported Amazon Web Services Region.

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

    Either a SourceEntity or a Definition must be provided in order for the request to be valid.

  • :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, Amazon QuickSight disables the left filter pane on the published dashboard, which can be used for ad hoc (one-time) filtering. This option is ENABLED by default.

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

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

  • :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 Amazon Web Services account where you create the dashboard.

  • :definition (Types::DashboardVersionDefinition) —

    The definition of a dashboard.

    A definition is the data model of all features in a Dashboard, Template, or Analysis.

    Either a SourceEntity or a Definition must be provided in order for the request to be valid.

  • :validation_strategy (Types::ValidationStrategy) —

    The option to relax the validation needed to create a dashboard with definition objects. This option skips the validation step for specific errors.

  • :folder_arns (Array<String>) —

    When you create the dashboard, Amazon QuickSight adds the dashboard to these folders.

  • :link_sharing_configuration (Types::LinkSharingConfiguration) —

    A structure that contains the permissions of a shareable link to the dashboard.

  • :link_entities (Array<String>) —

    A list of analysis Amazon Resource Names (ARNs) to be linked to the dashboard.

Returns:

See Also:



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

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. This operation doesn't support datasets that include uploaded files as a source.

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
        catalog: "RelationalTableCatalog",
        schema: "RelationalTableSchema",
        name: "RelationalTableName", # required
        input_columns: [ # required
          {
            name: "ColumnName", # required
            type: "STRING", # required, accepts STRING, INTEGER, DECIMAL, DATETIME, BIT, BOOLEAN, JSON
            sub_type: "FLOAT", # accepts FLOAT, FIXED
          },
        ],
      },
      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
            sub_type: "FLOAT", # accepts FLOAT, FIXED
          },
        ],
      },
      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
            sub_type: "FLOAT", # accepts FLOAT, FIXED
          },
        ],
      },
    },
  },
  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: "DataSetCalculatedFieldExpression", # 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
            sub_type: "FLOAT", # accepts FLOAT, FIXED
            format: "TypeCastFormat",
          },
          tag_column_operation: {
            column_name: "ColumnName", # required
            tags: [ # required
              {
                column_geographic_role: "COUNTRY", # accepts COUNTRY, STATE, COUNTY, CITY, POSTCODE, LONGITUDE, LATITUDE
                column_description: {
                  text: "ColumnDescriptiveText",
                },
              },
            ],
          },
          untag_column_operation: {
            column_name: "ColumnName", # required
            tag_names: ["COLUMN_GEOGRAPHIC_ROLE"], # required, accepts COLUMN_GEOGRAPHIC_ROLE, COLUMN_DESCRIPTION
          },
          override_dataset_parameter_operation: {
            parameter_name: "DatasetParameterName", # required
            new_parameter_name: "DatasetParameterName",
            new_default_values: {
              string_static_values: ["StringDatasetParameterDefaultValue"],
              decimal_static_values: [1.0],
              date_time_static_values: [Time.now],
              integer_static_values: [1],
            },
          },
        },
      ],
      source: { # required
        join_instruction: {
          left_operand: "LogicalTableId", # required
          right_operand: "LogicalTableId", # required
          left_join_key_properties: {
            unique_key: false,
          },
          right_join_key_properties: {
            unique_key: false,
          },
          type: "INNER", # required, accepts INNER, OUTER, LEFT, RIGHT
          on_clause: "OnClause", # required
        },
        physical_table_id: "PhysicalTableId",
        data_set_arn: "Arn",
      },
    },
  },
  import_mode: "SPICE", # required, accepts SPICE, DIRECT_QUERY
  column_groups: [
    {
      geo_spatial_column_group: {
        name: "ColumnGroupName", # required
        country_code: "US", # accepts US
        columns: ["ColumnName"], # required
      },
    },
  ],
  field_folders: {
    "FieldFolderPath" => {
      description: "FieldFolderDescription",
      columns: ["String"],
    },
  },
  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
    format_version: "VERSION_1", # accepts VERSION_1, VERSION_2
    status: "ENABLED", # accepts ENABLED, DISABLED
  },
  row_level_permission_tag_configuration: {
    status: "ENABLED", # accepts ENABLED, DISABLED
    tag_rules: [ # required
      {
        tag_key: "SessionTagKey", # required
        column_name: "String", # required
        tag_multi_value_delimiter: "RowLevelPermissionTagDelimiter",
        match_all_value: "SessionTagValue",
      },
    ],
    tag_rule_configurations: [
      ["SessionTagKey"],
    ],
  },
  column_level_permission_rules: [
    {
      principals: ["String"],
      column_names: ["String"],
    },
  ],
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
  data_set_usage_configuration: {
    disable_use_as_direct_query_source: false,
    disable_use_as_imported_source: false,
  },
  dataset_parameters: [
    {
      string_dataset_parameter: {
        id: "DatasetParameterId", # required
        name: "DatasetParameterName", # required
        value_type: "MULTI_VALUED", # required, accepts MULTI_VALUED, SINGLE_VALUED
        default_values: {
          static_values: ["StringDatasetParameterDefaultValue"],
        },
      },
      decimal_dataset_parameter: {
        id: "DatasetParameterId", # required
        name: "DatasetParameterName", # required
        value_type: "MULTI_VALUED", # required, accepts MULTI_VALUED, SINGLE_VALUED
        default_values: {
          static_values: [1.0],
        },
      },
      integer_dataset_parameter: {
        id: "DatasetParameterId", # required
        name: "DatasetParameterName", # required
        value_type: "MULTI_VALUED", # required, accepts MULTI_VALUED, SINGLE_VALUED
        default_values: {
          static_values: [1],
        },
      },
      date_time_dataset_parameter: {
        id: "DatasetParameterId", # required
        name: "DatasetParameterName", # required
        value_type: "MULTI_VALUED", # required, accepts MULTI_VALUED, SINGLE_VALUED
        time_granularity: "YEAR", # accepts YEAR, QUARTER, MONTH, WEEK, DAY, HOUR, MINUTE, SECOND, MILLISECOND
        default_values: {
          static_values: [Time.now],
        },
      },
    },
  ],
  folder_arns: ["Arn"],
})

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

  • :data_set_id (required, String) —

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

  • :name (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 Amazon QuickSight features. Currently, only geospatial hierarchy is supported.

  • :field_folders (Hash<String,Types::FieldFolder>) —

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

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

  • :row_level_permission_tag_configuration (Types::RowLevelPermissionTagConfiguration) —

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

  • :column_level_permission_rules (Array<Types::ColumnLevelPermissionRule>) —

    A set of one or more definitions of a ColumnLevelPermissionRule.

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

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

  • :data_set_usage_configuration (Types::DataSetUsageConfiguration) —

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

  • :dataset_parameters (Array<Types::DatasetParameter>) —

    The parameter declarations of the dataset.

  • :folder_arns (Array<String>) —

    When you create the dataset, Amazon QuickSight adds the dataset to these folders.

Returns:

See Also:



2251
2252
2253
2254
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 2251

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, ORACLE, POSTGRESQL, PRESTO, REDSHIFT, S3, SALESFORCE, SERVICENOW, SNOWFLAKE, SPARK, SQLSERVER, TERADATA, TWITTER, TIMESTREAM, AMAZON_OPENSEARCH, EXASOL, DATABRICKS, STARBURST, TRINO, BIGQUERY
  data_source_parameters: {
    amazon_elasticsearch_parameters: {
      domain: "Domain", # required
    },
    athena_parameters: {
      work_group: "WorkGroup",
      role_arn: "RoleArn",
    },
    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
    },
    oracle_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",
      iam_parameters: {
        role_arn: "RoleArn", # required
        database_user: "DatabaseUser",
        database_groups: ["DatabaseGroup"],
        auto_create_database_user: false,
      },
      identity_center_configuration: {
        enable_identity_propagation: false,
      },
    },
    s3_parameters: {
      manifest_file_location: { # required
        bucket: "S3Bucket", # required
        key: "S3Key", # required
      },
      role_arn: "RoleArn",
    },
    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
    },
    amazon_open_search_parameters: {
      domain: "Domain", # required
    },
    exasol_parameters: {
      host: "Host", # required
      port: 1, # required
    },
    databricks_parameters: {
      host: "Host", # required
      port: 1, # required
      sql_endpoint_path: "SqlEndpointPath", # required
    },
    starburst_parameters: {
      host: "Host", # required
      port: 1, # required
      catalog: "Catalog", # required
      product_type: "GALAXY", # accepts GALAXY, ENTERPRISE
    },
    trino_parameters: {
      host: "Host", # required
      port: 1, # required
      catalog: "Catalog", # required
    },
    big_query_parameters: {
      project_id: "ProjectId", # required
      data_set_region: "DataSetRegion",
    },
  },
  credentials: {
    credential_pair: {
      username: "DbUsername", # required
      password: "Password", # required
      alternate_data_source_parameters: [
        {
          amazon_elasticsearch_parameters: {
            domain: "Domain", # required
          },
          athena_parameters: {
            work_group: "WorkGroup",
            role_arn: "RoleArn",
          },
          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
          },
          oracle_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",
            iam_parameters: {
              role_arn: "RoleArn", # required
              database_user: "DatabaseUser",
              database_groups: ["DatabaseGroup"],
              auto_create_database_user: false,
            },
            identity_center_configuration: {
              enable_identity_propagation: false,
            },
          },
          s3_parameters: {
            manifest_file_location: { # required
              bucket: "S3Bucket", # required
              key: "S3Key", # required
            },
            role_arn: "RoleArn",
          },
          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
          },
          amazon_open_search_parameters: {
            domain: "Domain", # required
          },
          exasol_parameters: {
            host: "Host", # required
            port: 1, # required
          },
          databricks_parameters: {
            host: "Host", # required
            port: 1, # required
            sql_endpoint_path: "SqlEndpointPath", # required
          },
          starburst_parameters: {
            host: "Host", # required
            port: 1, # required
            catalog: "Catalog", # required
            product_type: "GALAXY", # accepts GALAXY, ENTERPRISE
          },
          trino_parameters: {
            host: "Host", # required
            port: 1, # required
            catalog: "Catalog", # required
          },
          big_query_parameters: {
            project_id: "ProjectId", # required
            data_set_region: "DataSetRegion",
          },
        },
      ],
    },
    copy_source_arn: "CopySourceArn",
    secret_arn: "SecretArn",
  },
  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
    },
  ],
  folder_arns: ["Arn"],
})

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", "DELETED"
resp.request_id #=> String
resp.status #=> Integer

Parameters:

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

    ({})

Options Hash (params):

  • :aws_account_id (required, String) —

    The Amazon Web Services account ID.

  • :data_source_id (required, String) —

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

  • :name (required, String) —

    A display name for the data source.

  • :type (required, String) —

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

    Use AMAZON_ELASTICSEARCH for Amazon OpenSearch Service.

  • :data_source_parameters (Types::DataSourceParameters) —

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

  • :credentials (Types::DataSourceCredentials) —

    The credentials Amazon 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 Amazon QuickSight to use a VPC connection when connecting to your underlying source.

  • :ssl_properties (Types::SslProperties) —

    Secure Socket Layer (SSL) properties that apply when Amazon 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.

  • :folder_arns (Array<String>) —

    When you create the data source, Amazon QuickSight adds the data source to these folders.

Returns:

See Also:



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

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

#create_folder(params = {}) ⇒ Types::CreateFolderResponse

Creates an empty shared folder.

Examples:

Request syntax with placeholder values


resp = client.create_folder({
  aws_account_id: "AwsAccountId", # required
  folder_id: "RestrictiveResourceId", # required
  name: "FolderName",
  folder_type: "SHARED", # accepts SHARED, RESTRICTED
  parent_folder_arn: "Arn",
  permissions: [
    {
      principal: "Principal", # required
      actions: ["String"], # required
    },
  ],
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
  sharing_model: "ACCOUNT", # accepts ACCOUNT, NAMESPACE
})

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :aws_account_id (required, String) —

    The ID for the Amazon Web Services account where you want to create the folder.

  • :folder_id (required, String) —

    The ID of the folder.

  • :name (String) —

    The name of the folder.

  • :folder_type (String) —

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

  • :parent_folder_arn (String) —

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

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

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

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

    To specify no permissions, omit Permissions.

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

    Tags for the folder.

  • :sharing_model (String) —

    An optional parameter that determines the sharing scope of the folder. The default value for this parameter is ACCOUNT.

Returns:

See Also:



2698
2699
2700
2701
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 2698

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

#create_folder_membership(params = {}) ⇒ Types::CreateFolderMembershipResponse

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

Examples:

Request syntax with placeholder values


resp = client.create_folder_membership({
  aws_account_id: "AwsAccountId", # required
  folder_id: "RestrictiveResourceId", # required
  member_id: "RestrictiveResourceId", # required
  member_type: "DASHBOARD", # required, accepts DASHBOARD, ANALYSIS, DATASET, DATASOURCE, TOPIC
})

Response structure


resp.status #=> Integer
resp.folder_member.member_id #=> String
resp.folder_member.member_type #=> String, one of "DASHBOARD", "ANALYSIS", "DATASET", "DATASOURCE", "TOPIC"
resp.request_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :aws_account_id (required, String) —

    The ID for the Amazon Web Services account that contains the folder.

  • :folder_id (required, String) —

    The ID of the folder.

  • :member_id (required, String) —

    The ID of the asset that you want to add to the folder.

  • :member_type (required, String) —

    The member type of the asset that you want to add to a folder.

Returns:

See Also:



2744
2745
2746
2747
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 2744

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

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

Use the CreateGroup operation to create a group in Amazon QuickSight. You can create up to 10,000 groups in a namespace. If you want to create more than 10,000 groups in a namespace, contact Amazon Web Services Support.

The permissions resource is arn:aws:quicksight:<your-region>:<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 Amazon Web Services account that the group is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon QuickSight account.

  • :namespace (required, String) —

    The namespace that you want the group to be a part of.

Returns:

See Also:



2802
2803
2804
2805
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 2802

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

  • :namespace (required, String) —

    The namespace that you want the user to be a part of.

Returns:

See Also:



2849
2850
2851
2852
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 2849

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 assignment is attached to the specified groups or users of Amazon QuickSight. Assignment names are unique per Amazon Web Services account. To avoid overwriting rules in other namespaces, use assignment names that are unique.

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 Amazon Web Services account where you want to assign an IAM policy to Amazon QuickSight users or groups.

  • :assignment_name (required, String) —

    The name of the assignment, also called a rule. The name must be unique within the Amazon Web Services 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 Amazon QuickSight users and groups specified in this assignment.

  • :identities (Hash<String,Array>) —

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



2930
2931
2932
2933
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 2930

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 for a dataset. You can manually refresh datasets in an Enterprise edition account 32 times in a 24-hour period. You can manually refresh datasets in a Standard edition account 8 times in a 24-hour period. Each 24-hour period is measured starting 24 hours before the current date and time.

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

Examples:

Request syntax with placeholder values


resp = client.create_ingestion({
  data_set_id: "String", # required
  ingestion_id: "IngestionId", # required
  aws_account_id: "AwsAccountId", # required
  ingestion_type: "INCREMENTAL_REFRESH", # accepts INCREMENTAL_REFRESH, FULL_REFRESH
})

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

  • :ingestion_type (String) —

    The type of ingestion that you want to create.

Returns:

See Also:



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

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

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 Amazon Web Services account that you want to create the Amazon 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:



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

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

#create_refresh_schedule(params = {}) ⇒ Types::CreateRefreshScheduleResponse

Creates a refresh schedule for a dataset. You can create up to 5 different schedules for a single dataset.

Examples:

Request syntax with placeholder values


resp = client.create_refresh_schedule({
  data_set_id: "ResourceId", # required
  aws_account_id: "AwsAccountId", # required
  schedule: { # required
    schedule_id: "String", # required
    schedule_frequency: { # required
      interval: "MINUTE15", # required, accepts MINUTE15, MINUTE30, HOURLY, DAILY, WEEKLY, MONTHLY
      refresh_on_day: {
        day_of_week: "SUNDAY", # accepts SUNDAY, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY
        day_of_month: "DayOfMonth",
      },
      timezone: "String",
      time_of_the_day: "String",
    },
    start_after_date_time: Time.now,
    refresh_type: "INCREMENTAL_REFRESH", # required, accepts INCREMENTAL_REFRESH, FULL_REFRESH
    arn: "Arn",
  },
})

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :data_set_id (required, String) —

    The ID of the dataset.

  • :aws_account_id (required, String) —

    The Amazon Web Services account ID.

  • :schedule (required, Types::RefreshSchedule) —

    The refresh schedule.

Returns:

See Also:



3120
3121
3122
3123
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 3120

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

#create_role_membership(params = {}) ⇒ Types::CreateRoleMembershipResponse

Use CreateRoleMembership to add an existing Amazon QuickSight group to an existing role.

Examples:

Request syntax with placeholder values


resp = client.create_role_membership({
  member_name: "GroupName", # required
  aws_account_id: "AwsAccountId", # required
  namespace: "Namespace", # required
  role: "ADMIN", # required, accepts ADMIN, AUTHOR, READER, ADMIN_PRO, AUTHOR_PRO, READER_PRO
})

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 group that you want to add to the role.

  • :aws_account_id (required, String) —

    The ID for the Amazon Web Services account that you want to create a group in. The Amazon Web Services account ID that you provide must be the same Amazon Web Services account that contains your Amazon QuickSight account.

  • :namespace (required, String) —

    The namespace that the role belongs to.

  • :role (required, String) —

    The role that you want to add a group to.

Returns:

See Also:



3166
3167
3168
3169
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 3166

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

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

Creates a template either from a TemplateDefinition or from an existing Amazon QuickSight analysis or template. You can use the resulting template to create additional dashboards, templates, or analyses.

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

Examples:

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", "DELETED"
resp.status #=> Integer
resp.request_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :aws_account_id (required, String) —

    The ID for the Amazon Web Services account that the group is in. You use the ID for the Amazon Web Services account that contains your Amazon QuickSight account.

  • :template_id (required, String) —

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

  • :name (String) —

    A display name for the template.

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

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

  • :source_entity (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 Amazon Web Services account and any Amazon QuickSight-supported Amazon Web Services Region.

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

    Either a SourceEntity or a Definition must be provided in order for the request to be valid.

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

  • :definition (Types::TemplateVersionDefinition) —

    The definition of a template.

    A definition is the data model of all features in a Dashboard, Template, or Analysis.

    Either a SourceEntity or a Definition must be provided in order for the request to be valid.

  • :validation_strategy (Types::ValidationStrategy) —

    TThe option to relax the validation needed to create a template with definition objects. This skips the validation step for specific errors.

Returns:

See Also:



3265
3266
3267
3268
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 3265

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: "ShortRestrictiveResourceId", # 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 Amazon Web Services 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 Amazon QuickSight.

  • :template_version_number (required, Integer) —

    The version number of the template.

Returns:

See Also:



3314
3315
3316
3317
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 3314

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: "ShortRestrictiveResourceId", # required
  name: "ThemeName", # required
  base_theme_id: "ShortRestrictiveResourceId", # 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,
        },
      },
    },
    typography: {
      font_families: [
        {
          font_family: "String",
        },
      ],
    },
  },
  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", "DELETED"
resp.status #=> Integer
resp.request_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :aws_account_id (required, String) —

    The ID of the Amazon Web Services 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 Amazon Web Services Region in each Amazon Web Services 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 an 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:



3453
3454
3455
3456
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 3453

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: "ShortRestrictiveResourceId", # 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 Amazon Web Services 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:



3502
3503
3504
3505
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 3502

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

#create_topic(params = {}) ⇒ Types::CreateTopicResponse

Creates a new Q topic.

Examples:

Request syntax with placeholder values


resp = client.create_topic({
  aws_account_id: "AwsAccountId", # required
  topic_id: "TopicId", # required
  topic: { # required
    name: "ResourceName",
    description: "LimitedString",
    user_experience_version: "LEGACY", # accepts LEGACY, NEW_READER_EXPERIENCE
    data_sets: [
      {
        dataset_arn: "Arn", # required
        dataset_name: "LimitedString",
        dataset_description: "LimitedString",
        data_aggregation: {
          dataset_row_date_granularity: "SECOND", # accepts SECOND, MINUTE, HOUR, DAY, WEEK, MONTH, QUARTER, YEAR
          default_date_column_name: "LimitedString",
        },
        filters: [
          {
            filter_description: "LimitedString",
            filter_class: "ENFORCED_VALUE_FILTER", # accepts ENFORCED_VALUE_FILTER, CONDITIONAL_VALUE_FILTER, NAMED_VALUE_FILTER
            filter_name: "LimitedString", # required
            filter_synonyms: ["LimitedString"],
            operand_field_name: "LimitedString", # required
            filter_type: "CATEGORY_FILTER", # accepts CATEGORY_FILTER, NUMERIC_EQUALITY_FILTER, NUMERIC_RANGE_FILTER, DATE_RANGE_FILTER, RELATIVE_DATE_FILTER
            category_filter: {
              category_filter_function: "EXACT", # accepts EXACT, CONTAINS
              category_filter_type: "CUSTOM_FILTER", # accepts CUSTOM_FILTER, CUSTOM_FILTER_LIST, FILTER_LIST
              constant: {
                constant_type: "SINGULAR", # accepts SINGULAR, RANGE, COLLECTIVE
                singular_constant: "LimitedString",
                collective_constant: {
                  value_list: ["String"],
                },
              },
              inverse: false,
            },
            numeric_equality_filter: {
              constant: {
                constant_type: "SINGULAR", # accepts SINGULAR, RANGE, COLLECTIVE
                singular_constant: "LimitedString",
              },
              aggregation: "NO_AGGREGATION", # accepts NO_AGGREGATION, SUM, AVERAGE, COUNT, DISTINCT_COUNT, MAX, MEDIAN, MIN, STDEV, STDEVP, VAR, VARP
            },
            numeric_range_filter: {
              inclusive: false,
              constant: {
                constant_type: "SINGULAR", # accepts SINGULAR, RANGE, COLLECTIVE
                range_constant: {
                  minimum: "LimitedString",
                  maximum: "LimitedString",
                },
              },
              aggregation: "NO_AGGREGATION", # accepts NO_AGGREGATION, SUM, AVERAGE, COUNT, DISTINCT_COUNT, MAX, MEDIAN, MIN, STDEV, STDEVP, VAR, VARP
            },
            date_range_filter: {
              inclusive: false,
              constant: {
                constant_type: "SINGULAR", # accepts SINGULAR, RANGE, COLLECTIVE
                range_constant: {
                  minimum: "LimitedString",
                  maximum: "LimitedString",
                },
              },
            },
            relative_date_filter: {
              time_granularity: "SECOND", # accepts SECOND, MINUTE, HOUR, DAY, WEEK, MONTH, QUARTER, YEAR
              relative_date_filter_function: "PREVIOUS", # accepts PREVIOUS, THIS, LAST, NEXT, NOW
              constant: {
                constant_type: "SINGULAR", # accepts SINGULAR, RANGE, COLLECTIVE
                singular_constant: "LimitedString",
              },
            },
          },
        ],
        columns: [
          {
            column_name: "LimitedString", # required
            column_friendly_name: "LimitedString",
            column_description: "LimitedString",
            column_synonyms: ["LimitedString"],
            column_data_role: "DIMENSION", # accepts DIMENSION, MEASURE
            aggregation: "SUM", # accepts SUM, MAX, MIN, COUNT, DISTINCT_COUNT, AVERAGE, MEDIAN, STDEV, STDEVP, VAR, VARP
            is_included_in_topic: false,
            disable_indexing: false,
            comparative_order: {
              use_ordering: "GREATER_IS_BETTER", # accepts GREATER_IS_BETTER, LESSER_IS_BETTER, SPECIFIED
              specifed_order: ["String"],
              treat_undefined_specified_values: "LEAST", # accepts LEAST, MOST
            },
            semantic_type: {
              type_name: "LimitedString",
              sub_type_name: "LimitedString",
              type_parameters: {
                "LimitedString" => "LimitedString",
              },
              truthy_cell_value: "SensitiveString",
              truthy_cell_value_synonyms: ["SensitiveString"],
              falsey_cell_value: "SensitiveString",
              falsey_cell_value_synonyms: ["SensitiveString"],
            },
            time_granularity: "SECOND", # accepts SECOND, MINUTE, HOUR, DAY, WEEK, MONTH, QUARTER, YEAR
            allowed_aggregations: ["COUNT"], # accepts COUNT, DISTINCT_COUNT, MIN, MAX, MEDIAN, SUM, AVERAGE, STDEV, STDEVP, VAR, VARP, PERCENTILE
            not_allowed_aggregations: ["COUNT"], # accepts COUNT, DISTINCT_COUNT, MIN, MAX, MEDIAN, SUM, AVERAGE, STDEV, STDEVP, VAR, VARP, PERCENTILE
            default_formatting: {
              display_format: "AUTO", # accepts AUTO, PERCENT, CURRENCY, NUMBER, DATE, STRING
              display_format_options: {
                use_blank_cell_format: false,
                blank_cell_format: "LimitedString",
                date_format: "LimitedString",
                decimal_separator: "COMMA", # accepts COMMA, DOT
                grouping_separator: "LimitedString",
                use_grouping: false,
                fraction_digits: 1,
                prefix: "LimitedString",
                suffix: "LimitedString",
                unit_scaler: "NONE", # accepts NONE, AUTO, THOUSANDS, MILLIONS, BILLIONS, TRILLIONS
                negative_format: {
                  prefix: "LimitedString",
                  suffix: "LimitedString",
                },
                currency_symbol: "LimitedString",
              },
            },
            never_aggregate_in_filter: false,
            cell_value_synonyms: [
              {
                cell_value: "LimitedString",
                synonyms: ["String"],
              },
            ],
            non_additive: false,
          },
        ],
        calculated_fields: [
          {
            calculated_field_name: "LimitedString", # required
            calculated_field_description: "LimitedString",
            expression: "Expression", # required
            calculated_field_synonyms: ["LimitedString"],
            is_included_in_topic: false,
            disable_indexing: false,
            column_data_role: "DIMENSION", # accepts DIMENSION, MEASURE
            time_granularity: "SECOND", # accepts SECOND, MINUTE, HOUR, DAY, WEEK, MONTH, QUARTER, YEAR
            default_formatting: {
              display_format: "AUTO", # accepts AUTO, PERCENT, CURRENCY, NUMBER, DATE, STRING
              display_format_options: {
                use_blank_cell_format: false,
                blank_cell_format: "LimitedString",
                date_format: "LimitedString",
                decimal_separator: "COMMA", # accepts COMMA, DOT
                grouping_separator: "LimitedString",
                use_grouping: false,
                fraction_digits: 1,
                prefix: "LimitedString",
                suffix: "LimitedString",
                unit_scaler: "NONE", # accepts NONE, AUTO, THOUSANDS, MILLIONS, BILLIONS, TRILLIONS
                negative_format: {
                  prefix: "LimitedString",
                  suffix: "LimitedString",
                },
                currency_symbol: "LimitedString",
              },
            },
            aggregation: "SUM", # accepts SUM, MAX, MIN, COUNT, DISTINCT_COUNT, AVERAGE, MEDIAN, STDEV, STDEVP, VAR, VARP
            comparative_order: {
              use_ordering: "GREATER_IS_BETTER", # accepts GREATER_IS_BETTER, LESSER_IS_BETTER, SPECIFIED
              specifed_order: ["String"],
              treat_undefined_specified_values: "LEAST", # accepts LEAST, MOST
            },
            semantic_type: {
              type_name: "LimitedString",
              sub_type_name: "LimitedString",
              type_parameters: {
                "LimitedString" => "LimitedString",
              },
              truthy_cell_value: "SensitiveString",
              truthy_cell_value_synonyms: ["SensitiveString"],
              falsey_cell_value: "SensitiveString",
              falsey_cell_value_synonyms: ["SensitiveString"],
            },
            allowed_aggregations: ["COUNT"], # accepts COUNT, DISTINCT_COUNT, MIN, MAX, MEDIAN, SUM, AVERAGE, STDEV, STDEVP, VAR, VARP, PERCENTILE
            not_allowed_aggregations: ["COUNT"], # accepts COUNT, DISTINCT_COUNT, MIN, MAX, MEDIAN, SUM, AVERAGE, STDEV, STDEVP, VAR, VARP, PERCENTILE
            never_aggregate_in_filter: false,
            cell_value_synonyms: [
              {
                cell_value: "LimitedString",
                synonyms: ["String"],
              },
            ],
            non_additive: false,
          },
        ],
        named_entities: [
          {
            entity_name: "LimitedString", # required
            entity_description: "LimitedString",
            entity_synonyms: ["LimitedString"],
            semantic_entity_type: {
              type_name: "LimitedString",
              sub_type_name: "LimitedString",
              type_parameters: {
                "LimitedString" => "LimitedString",
              },
            },
            definition: [
              {
                field_name: "LimitedString",
                property_name: "LimitedString",
                property_role: "PRIMARY", # accepts PRIMARY, ID
                property_usage: "INHERIT", # accepts INHERIT, DIMENSION, MEASURE
                metric: {
                  aggregation: "SUM", # accepts SUM, MIN, MAX, COUNT, AVERAGE, DISTINCT_COUNT, STDEV, STDEVP, VAR, VARP, PERCENTILE, MEDIAN, CUSTOM
                  aggregation_function_parameters: {
                    "LimitedString" => "LimitedString",
                  },
                },
              },
            ],
          },
        ],
      },
    ],
  },
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
})

Response structure


resp.arn #=> String
resp.topic_id #=> String
resp.refresh_arn #=> 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 Amazon Web Services account that you want to create a topic in.

  • :topic_id (required, String) —

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

  • :topic (required, Types::TopicDetails) —

    The definition of a topic to create.

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

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

Returns:

See Also:



3777
3778
3779
3780
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 3777

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

#create_topic_refresh_schedule(params = {}) ⇒ Types::CreateTopicRefreshScheduleResponse

Creates a topic refresh schedule.

Examples:

Request syntax with placeholder values


resp = client.create_topic_refresh_schedule({
  aws_account_id: "AwsAccountId", # required
  topic_id: "TopicId", # required
  dataset_arn: "Arn", # required
  dataset_name: "String",
  refresh_schedule: { # required
    is_enabled: false, # required
    based_on_spice_schedule: false, # required
    starting_at: Time.now,
    timezone: "LimitedString",
    repeat_at: "LimitedString",
    topic_schedule_type: "HOURLY", # accepts HOURLY, DAILY, WEEKLY, MONTHLY
  },
})

Response structure


resp.topic_id #=> String
resp.topic_arn #=> String
resp.dataset_arn #=> 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 Amazon Web Services account that contains the topic you're creating a refresh schedule for.

  • :topic_id (required, String) —

    The ID of the topic that you want to modify. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

  • :dataset_arn (required, String) —

    The Amazon Resource Name (ARN) of the dataset.

  • :dataset_name (String) —

    The name of the dataset.

  • :refresh_schedule (required, Types::TopicRefreshSchedule) —

    The definition of a refresh schedule.

Returns:

See Also:



3838
3839
3840
3841
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 3838

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

#create_vpc_connection(params = {}) ⇒ Types::CreateVPCConnectionResponse

Creates a new VPC connection.

Examples:

Request syntax with placeholder values


resp = client.create_vpc_connection({
  aws_account_id: "AwsAccountId", # required
  vpc_connection_id: "VPCConnectionResourceIdRestricted", # required
  name: "ResourceName", # required
  subnet_ids: ["SubnetId"], # required
  security_group_ids: ["SecurityGroupId"], # required
  dns_resolvers: ["IPv4Address"],
  role_arn: "RoleArn", # required
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
})

Response structure


resp.arn #=> String
resp.vpc_connection_id #=> String
resp.creation_status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED", "DELETION_IN_PROGRESS", "DELETION_FAILED", "DELETED"
resp.availability_status #=> String, one of "AVAILABLE", "UNAVAILABLE", "PARTIALLY_AVAILABLE"
resp.request_id #=> String
resp.status #=> Integer

Parameters:

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

    ({})

Options Hash (params):

  • :aws_account_id (required, String) —

    The Amazon Web Services account ID of the account where you want to create a new VPC connection.

  • :vpc_connection_id (required, String) —

    The ID of the VPC connection that you're creating. This ID is a unique identifier for each Amazon Web Services Region in an Amazon Web Services account.

  • :name (required, String) —

    The display name for the VPC connection.

  • :subnet_ids (required, Array<String>) —

    A list of subnet IDs for the VPC connection.

  • :security_group_ids (required, Array<String>) —

    A list of security group IDs for the VPC connection.

  • :dns_resolvers (Array<String>) —

    A list of IP addresses of DNS resolver endpoints for the VPC connection.

  • :role_arn (required, String) —

    The IAM role to associate with the VPC connection.

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

    A map of the key-value pairs for the resource tag or tags assigned to the VPC connection.

Returns:

See Also:



3914
3915
3916
3917
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 3914

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

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

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

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 Amazon Web Services account that you want to delete Amazon QuickSight customizations from in this Amazon Web Services Region.

  • :namespace (String) —

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

Returns:

See Also:



3953
3954
3955
3956
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 3953

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

#delete_account_subscription(params = {}) ⇒ Types::DeleteAccountSubscriptionResponse

Use the DeleteAccountSubscription operation to delete an Amazon QuickSight account. This operation will result in an error message if you have configured your account termination protection settings to True. To change this setting and delete your account, call the UpdateAccountSettings API and set the value of the TerminationProtectionEnabled parameter to False, then make another call to the DeleteAccountSubscription API.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :aws_account_id (required, String) —

    The Amazon Web Services account ID of the account that you want to delete.

Returns:

See Also:



3990
3991
3992
3993
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 3990

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

#delete_analysis(params = {}) ⇒ Types::DeleteAnalysisResponse

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

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

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

Examples:

Request syntax with placeholder values


resp = client.delete_analysis({
  aws_account_id: "AwsAccountId", # required
  analysis_id: "ShortRestrictiveResourceId", # required
  recovery_window_in_days: 1,
  force_delete_without_recovery: false,
})

Response structure


resp.status #=> Integer
resp.arn #=> String
resp.analysis_id #=> String
resp.deletion_time #=> Time
resp.request_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :aws_account_id (required, String) —

    The ID of the Amazon Web Services account where you want to delete an analysis.

  • :analysis_id (required, String) —

    The ID of the analysis that you're deleting.

  • :recovery_window_in_days (Integer) —

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

  • :force_delete_without_recovery (Boolean) —

    This option defaults to the value NoForceDeleteWithoutRecovery. To immediately delete the analysis, add the ForceDeleteWithoutRecovery option. You can't restore an analysis after it's deleted.

Returns:

See Also:



4061
4062
4063
4064
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 4061

def delete_analysis(params = {}, options = {})
  req = build_request(:delete_analysis, 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: "ShortRestrictiveResourceId", # 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 Amazon Web Services 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:



4105
4106
4107
4108
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 4105

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

  • :data_set_id (required, String) —

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

Returns:

See Also:



4144
4145
4146
4147
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 4144

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

#delete_data_set_refresh_properties(params = {}) ⇒ Types::DeleteDataSetRefreshPropertiesResponse

Deletes the dataset refresh properties of the dataset.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :aws_account_id (required, String) —

    The Amazon Web Services account ID.

  • :data_set_id (required, String) —

    The ID of the dataset.

Returns:

See Also:



4178
4179
4180
4181
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 4178

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

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

Deletes the data source permanently. This operation 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 Amazon Web Services account ID.

  • :data_source_id (required, String) —

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

Returns:

See Also:



4218
4219
4220
4221
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 4218

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

#delete_folder(params = {}) ⇒ Types::DeleteFolderResponse

Deletes an empty folder.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :aws_account_id (required, String) —

    The ID for the Amazon Web Services account that contains the folder.

  • :folder_id (required, String) —

    The ID of the folder.

Returns:

See Also:



4256
4257
4258
4259
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 4256

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

#delete_folder_membership(params = {}) ⇒ Types::DeleteFolderMembershipResponse

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

Examples:

Request syntax with placeholder values


resp = client.delete_folder_membership({
  aws_account_id: "AwsAccountId", # required
  folder_id: "RestrictiveResourceId", # required
  member_id: "RestrictiveResourceId", # required
  member_type: "DASHBOARD", # required, accepts DASHBOARD, ANALYSIS, DATASET, DATASOURCE, TOPIC
})

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :aws_account_id (required, String) —

    The ID for the Amazon Web Services account that contains the folder.

  • :folder_id (required, String) —

    The Folder ID.

  • :member_id (required, String) —

    The ID of the asset that you want to delete.

  • :member_type (required, String) —

    The member type of the asset that you want to delete from a folder.

Returns:

See Also:



4299
4300
4301
4302
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 4299

def delete_folder_membership(params = {}, options = {})
  req = build_request(:delete_folder_membership, 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 Amazon Web Services account that the group is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon QuickSight account.

  • :namespace (required, String) —

    The namespace of the group that you want to delete.

Returns:

See Also:



4339
4340
4341
4342
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 4339

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

  • :namespace (required, String) —

    The namespace of the group that you want to remove a user from.

Returns:

See Also:



4385
4386
4387
4388
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 4385

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



4426
4427
4428
4429
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 4426

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

#delete_identity_propagation_config(params = {}) ⇒ Types::DeleteIdentityPropagationConfigResponse

Deletes all access scopes and authorized targets that are associated with a service from the Amazon QuickSight IAM Identity Center application.

This operation is only supported for Amazon QuickSight accounts that use IAM Identity Center.

Examples:

Request syntax with placeholder values


resp = client.delete_identity_propagation_config({
  aws_account_id: "AwsAccountId", # required
  service: "REDSHIFT", # required, accepts REDSHIFT
})

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :aws_account_id (required, String) —

    The ID of the Amazon Web Services account that you want to delete an identity propagation configuration from.

  • :service (required, String) —

    The name of the Amazon Web Services service that you want to delete the associated access scopes and authorized targets from.

Returns:

See Also:



4467
4468
4469
4470
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 4467

def delete_identity_propagation_config(params = {}, options = {})
  req = build_request(:delete_identity_propagation_config, 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 API operations 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 Amazon Web Services account that you want to delete the Amazon QuickSight namespace from.

  • :namespace (required, String) —

    The namespace that you want to delete.

Returns:

See Also:



4506
4507
4508
4509
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 4506

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

#delete_refresh_schedule(params = {}) ⇒ Types::DeleteRefreshScheduleResponse

Deletes a refresh schedule from a dataset.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :data_set_id (required, String) —

    The ID of the dataset.

  • :aws_account_id (required, String) —

    The Amazon Web Services account ID.

  • :schedule_id (required, String) —

    The ID of the refresh schedule.

Returns:

See Also:



4548
4549
4550
4551
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 4548

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

#delete_role_custom_permission(params = {}) ⇒ Types::DeleteRoleCustomPermissionResponse

Removes custom permissions from the role.

Examples:

Request syntax with placeholder values


resp = client.delete_role_custom_permission({
  role: "ADMIN", # required, accepts ADMIN, AUTHOR, READER, ADMIN_PRO, AUTHOR_PRO, READER_PRO
  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):

  • :role (required, String) —

    The role that you want to remove permissions from.

  • :aws_account_id (required, String) —

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

  • :namespace (required, String) —

    The namespace that includes the role.

Returns:

See Also:



4588
4589
4590
4591
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 4588

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

#delete_role_membership(params = {}) ⇒ Types::DeleteRoleMembershipResponse

Removes a group from a role.

Examples:

Request syntax with placeholder values


resp = client.delete_role_membership({
  member_name: "GroupName", # required
  role: "ADMIN", # required, accepts ADMIN, AUTHOR, READER, ADMIN_PRO, AUTHOR_PRO, READER_PRO
  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 group.

  • :role (required, String) —

    The role that you want to remove permissions from.

  • :aws_account_id (required, String) —

    The ID for the Amazon Web Services account that you want to create a group in. The Amazon Web Services account ID that you provide must be the same Amazon Web Services account that contains your Amazon QuickSight account.

  • :namespace (required, String) —

    The namespace that contains the role.

Returns:

See Also:



4633
4634
4635
4636
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 4633

def delete_role_membership(params = {}, options = {})
  req = build_request(:delete_role_membership, 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: "ShortRestrictiveResourceId", # 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 Amazon Web Services 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:



4678
4679
4680
4681
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 4678

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: "ShortRestrictiveResourceId", # 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 Amazon Web Services 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:



4728
4729
4730
4731
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 4728

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: "ShortRestrictiveResourceId", # 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 Amazon Web Services 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:



4774
4775
4776
4777
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 4774

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: "ShortRestrictiveResourceId", # 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 Amazon Web Services 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:



4821
4822
4823
4824
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 4821

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

#delete_topic(params = {}) ⇒ Types::DeleteTopicResponse

Deletes a topic.

Examples:

Request syntax with placeholder values


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

Response structure


resp.arn #=> String
resp.topic_id #=> 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 Amazon Web Services account that contains the topic that you want to delete.

  • :topic_id (required, String) —

    The ID of the topic that you want to delete. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

Returns:

See Also:



4861
4862
4863
4864
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 4861

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

#delete_topic_refresh_schedule(params = {}) ⇒ Types::DeleteTopicRefreshScheduleResponse

Deletes a topic refresh schedule.

Examples:

Request syntax with placeholder values


resp = client.delete_topic_refresh_schedule({
  aws_account_id: "AwsAccountId", # required
  topic_id: "TopicId", # required
  dataset_id: "String", # required
})

Response structure


resp.topic_id #=> String
resp.topic_arn #=> String
resp.dataset_arn #=> String
resp.status #=> Integer
resp.request_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :aws_account_id (required, String) —

    The Amazon Web Services account ID.

  • :topic_id (required, String) —

    The ID of the topic that you want to modify. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

  • :dataset_id (required, String) —

    The ID of the dataset.

Returns:

See Also:



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

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

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

Deletes the Amazon QuickSight user that is associated with the identity of the 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 Amazon Web Services account that the user is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon QuickSight account.

  • :namespace (required, String) —

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

Returns:

See Also:



4948
4949
4950
4951
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 4948

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

  • :namespace (required, String) —

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

Returns:

See Also:



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

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

#delete_vpc_connection(params = {}) ⇒ Types::DeleteVPCConnectionResponse

Deletes a VPC connection.

Examples:

Request syntax with placeholder values


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

Response structure


resp.arn #=> String
resp.vpc_connection_id #=> String
resp.deletion_status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED", "DELETION_IN_PROGRESS", "DELETION_FAILED", "DELETED"
resp.availability_status #=> String, one of "AVAILABLE", "UNAVAILABLE", "PARTIALLY_AVAILABLE"
resp.request_id #=> String
resp.status #=> Integer

Parameters:

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

    ({})

Options Hash (params):

  • :aws_account_id (required, String) —

    The Amazon Web Services account ID of the account where you want to delete a VPC connection.

  • :vpc_connection_id (required, String) —

    The ID of the VPC connection that you're creating. This ID is a unique identifier for each Amazon Web Services Region in an Amazon Web Services account.

Returns:

See Also:



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

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

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

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

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

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

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

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

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

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

Examples:

Request syntax with placeholder values


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

Response structure


resp.arn #=> String
resp. #=> String
resp.namespace #=> String
resp..default_theme #=> String
resp..default_email_customization_template #=> 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 Amazon Web Services account that you want to describe Amazon QuickSight customizations for.

  • :namespace (String) —

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

  • :resolved (Boolean) —

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

Returns:

See Also:



5145
5146
5147
5148
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 5145

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 Amazon QuickSight subscription was first created in this Amazon Web Services 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", "ENTERPRISE_AND_Q"
resp..default_namespace #=> String
resp..notification_email #=> String
resp..public_sharing_enabled #=> Boolean
resp..termination_protection_enabled #=> Boolean
resp.request_id #=> String
resp.status #=> Integer

Parameters:

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

    ({})

Options Hash (params):

  • :aws_account_id (required, String) —

    The ID for the Amazon Web Services account that contains the settings that you want to list.

Returns:

See Also:



5184
5185
5186
5187
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 5184

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

#describe_account_subscription(params = {}) ⇒ Types::DescribeAccountSubscriptionResponse

Use the DescribeAccountSubscription operation to receive a description of an Amazon QuickSight account's subscription. A successful API call returns an AccountInfo object that includes an account's name, subscription status, authentication type, edition, and notification email address.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :aws_account_id (required, String) —

    The Amazon Web Services account ID associated with your Amazon QuickSight account.

Returns:

See Also:



5226
5227
5228
5229
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 5226

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

#describe_analysis(params = {}) ⇒ Types::DescribeAnalysisResponse

Provides a summary of the metadata for an analysis.

Examples:

Request syntax with placeholder values


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

Response structure


resp.analysis.analysis_id #=> String
resp.analysis.arn #=> String
resp.analysis.name #=> String
resp.analysis.status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED", "DELETED"
resp.analysis.errors #=> Array
resp.analysis.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.analysis.errors[0].message #=> String
resp.analysis.errors[0].violated_entities #=> Array
resp.analysis.errors[0].violated_entities[0].path #=> String
resp.analysis.data_set_arns #=> Array
resp.analysis.data_set_arns[0] #=> String
resp.analysis.theme_arn #=> String
resp.analysis.created_time #=> Time
resp.analysis.last_updated_time #=> Time
resp.analysis.sheets #=> Array
resp.analysis.sheets[0].sheet_id #=> String
resp.analysis.sheets[0].name #=> 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 Amazon Web Services account that contains the analysis. You must be using the Amazon Web Services account that the analysis is in.

  • :analysis_id (required, String) —

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

Returns:

See Also:



5281
5282
5283
5284
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 5281

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

#describe_analysis_definition(params = {}) ⇒ Types::DescribeAnalysisDefinitionResponse

Provides a detailed description of the definition of an analysis.

If you do not need to know details about the content of an Analysis, for instance if you are trying to check the status of a recently created or updated Analysis, use the DescribeAnalysis instead.

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :aws_account_id (required, String) —

    The ID of the Amazon Web Services account that contains the analysis. You must be using the Amazon Web Services account that the analysis is in.

  • :analysis_id (required, String) —

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

Returns:

See Also:



5330
5331
5332
5333
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 5330

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

#describe_analysis_permissions(params = {}) ⇒ Types::DescribeAnalysisPermissionsResponse

Provides the read and write permissions for an analysis.

Examples:

Request syntax with placeholder values


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

Response structure


resp.analysis_id #=> String
resp.analysis_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 Amazon Web Services account that contains the analysis whose permissions you're describing. You must be using the Amazon Web Services account that the analysis is in.

  • :analysis_id (required, String) —

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

Returns:

See Also:



5376
5377
5378
5379
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 5376

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

#describe_asset_bundle_export_job(params = {}) ⇒ Types::DescribeAssetBundleExportJobResponse

Describes an existing export job.

Poll job descriptions after a job starts to know the status of the job. When a job succeeds, a URL is provided to download the exported assets' data from. Download URLs are valid for five minutes after they are generated. You can call the DescribeAssetBundleExportJob API for a new download URL as needed.

Job descriptions are available for 14 days after the job starts.

Examples:

Request syntax with placeholder values


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

Response structure


resp.job_status #=> String, one of "QUEUED_FOR_IMMEDIATE_EXECUTION", "IN_PROGRESS", "SUCCESSFUL", "FAILED"
resp.download_url #=> String
resp.errors #=> Array
resp.errors[0].arn #=> String
resp.errors[0].type #=> String
resp.errors[0].message #=> String
resp.arn #=> String
resp.created_time #=> Time
resp.asset_bundle_export_job_id #=> String
resp. #=> String
resp.resource_arns #=> Array
resp.resource_arns[0] #=> String
resp.include_all_dependencies #=> Boolean
resp.export_format #=> String, one of "CLOUDFORMATION_JSON", "QUICKSIGHT_JSON"
resp.cloud_formation_override_property_configuration.resource_id_override_configuration.prefix_for_all_resources #=> Boolean
resp.cloud_formation_override_property_configuration.vpc_connections #=> Array
resp.cloud_formation_override_property_configuration.vpc_connections[0].arn #=> String
resp.cloud_formation_override_property_configuration.vpc_connections[0].properties #=> Array
resp.cloud_formation_override_property_configuration.vpc_connections[0].properties[0] #=> String, one of "Name", "DnsResolvers", "RoleArn"
resp.cloud_formation_override_property_configuration.refresh_schedules #=> Array
resp.cloud_formation_override_property_configuration.refresh_schedules[0].arn #=> String
resp.cloud_formation_override_property_configuration.refresh_schedules[0].properties #=> Array
resp.cloud_formation_override_property_configuration.refresh_schedules[0].properties[0] #=> String, one of "StartAfterDateTime"
resp.cloud_formation_override_property_configuration.data_sources #=> Array
resp.cloud_formation_override_property_configuration.data_sources[0].arn #=> String
resp.cloud_formation_override_property_configuration.data_sources[0].properties #=> Array
resp.cloud_formation_override_property_configuration.data_sources[0].properties[0] #=> String, one of "Name", "DisableSsl", "SecretArn", "Username", "Password", "Domain", "WorkGroup", "Host", "Port", "Database", "DataSetName", "Catalog", "InstanceId", "ClusterId", "ManifestFileLocation", "Warehouse", "RoleArn", "ProductType"
resp.cloud_formation_override_property_configuration.data_sets #=> Array
resp.cloud_formation_override_property_configuration.data_sets[0].arn #=> String
resp.cloud_formation_override_property_configuration.data_sets[0].properties #=> Array
resp.cloud_formation_override_property_configuration.data_sets[0].properties[0] #=> String, one of "Name"
resp.cloud_formation_override_property_configuration.themes #=> Array
resp.cloud_formation_override_property_configuration.themes[0].arn #=> String
resp.cloud_formation_override_property_configuration.themes[0].properties #=> Array
resp.cloud_formation_override_property_configuration.themes[0].properties[0] #=> String, one of "Name"
resp.cloud_formation_override_property_configuration.analyses #=> Array
resp.cloud_formation_override_property_configuration.analyses[0].arn #=> String
resp.cloud_formation_override_property_configuration.analyses[0].properties #=> Array
resp.cloud_formation_override_property_configuration.analyses[0].properties[0] #=> String, one of "Name"
resp.cloud_formation_override_property_configuration.dashboards #=> Array
resp.cloud_formation_override_property_configuration.dashboards[0].arn #=> String
resp.cloud_formation_override_property_configuration.dashboards[0].properties #=> Array
resp.cloud_formation_override_property_configuration.dashboards[0].properties[0] #=> String, one of "Name"
resp.request_id #=> String
resp.status #=> Integer
resp.include_permissions #=> Boolean
resp.include_tags #=> Boolean
resp.validation_strategy.strict_mode_for_all_resources #=> Boolean
resp.warnings #=> Array
resp.warnings[0].arn #=> String
resp.warnings[0].message #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :aws_account_id (required, String) —

    The ID of the Amazon Web Services account the export job is executed in.

  • :asset_bundle_export_job_id (required, String) —

    The ID of the job that you want described. The job ID is set when you start a new job with a StartAssetBundleExportJob API call.

Returns:

See Also:



5484
5485
5486
5487
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 5484

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

#describe_asset_bundle_import_job(params = {}) ⇒ Types::DescribeAssetBundleImportJobResponse

Describes an existing import job.

Poll job descriptions after starting a job to know when it has succeeded or failed. Job descriptions are available for 14 days after job starts.

Examples:

Request syntax with placeholder values


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

Response structure


resp.job_status #=> String, one of "QUEUED_FOR_IMMEDIATE_EXECUTION", "IN_PROGRESS", "SUCCESSFUL", "FAILED", "FAILED_ROLLBACK_IN_PROGRESS", "FAILED_ROLLBACK_COMPLETED", "FAILED_ROLLBACK_ERROR"
resp.errors #=> Array
resp.errors[0].arn #=> String
resp.errors[0].type #=> String
resp.errors[0].message #=> String
resp.rollback_errors #=> Array
resp.rollback_errors[0].arn #=> String
resp.rollback_errors[0].type #=> String
resp.rollback_errors[0].message #=> String
resp.arn #=> String
resp.created_time #=> Time
resp.asset_bundle_import_job_id #=> String
resp. #=> String
resp.asset_bundle_import_source.body #=> String
resp.asset_bundle_import_source.s3_uri #=> String
resp.override_parameters.resource_id_override_configuration.prefix_for_all_resources #=> String
resp.override_parameters.vpc_connections #=> Array
resp.override_parameters.vpc_connections[0].vpc_connection_id #=> String
resp.override_parameters.vpc_connections[0].name #=> String
resp.override_parameters.vpc_connections[0].subnet_ids #=> Array
resp.override_parameters.vpc_connections[0].subnet_ids[0] #=> String
resp.override_parameters.vpc_connections[0].security_group_ids #=> Array
resp.override_parameters.vpc_connections[0].security_group_ids[0] #=> String
resp.override_parameters.vpc_connections[0].dns_resolvers #=> Array
resp.override_parameters.vpc_connections[0].dns_resolvers[0] #=> String
resp.override_parameters.vpc_connections[0].role_arn #=> String
resp.override_parameters.refresh_schedules #=> Array
resp.override_parameters.refresh_schedules[0].data_set_id #=> String
resp.override_parameters.refresh_schedules[0].schedule_id #=> String
resp.override_parameters.refresh_schedules[0].start_after_date_time #=> Time
resp.override_parameters.data_sources #=> Array
resp.override_parameters.data_sources[0].data_source_id #=> String
resp.override_parameters.data_sources[0].name #=> String
resp.override_parameters.data_sources[0].data_source_parameters.amazon_elasticsearch_parameters.domain #=> String
resp.override_parameters.data_sources[0].data_source_parameters.athena_parameters.work_group #=> String
resp.override_parameters.data_sources[0].data_source_parameters.athena_parameters.role_arn #=> String
resp.override_parameters.data_sources[0].data_source_parameters.aurora_parameters.host #=> String
resp.override_parameters.data_sources[0].data_source_parameters.aurora_parameters.port #=> Integer
resp.override_parameters.data_sources[0].data_source_parameters.aurora_parameters.database #=> String
resp.override_parameters.data_sources[0].data_source_parameters.aurora_postgre_sql_parameters.host #=> String
resp.override_parameters.data_sources[0].data_source_parameters.aurora_postgre_sql_parameters.port #=> Integer
resp.override_parameters.data_sources[0].data_source_parameters.aurora_postgre_sql_parameters.database #=> String
resp.override_parameters.data_sources[0].data_source_parameters.aws_iot_analytics_parameters.data_set_name #=> String
resp.override_parameters.data_sources[0].data_source_parameters.jira_parameters.site_base_url #=> String
resp.override_parameters.data_sources[0].data_source_parameters.maria_db_parameters.host #=> String
resp.override_parameters.data_sources[0].data_source_parameters.maria_db_parameters.port #=> Integer
resp.override_parameters.data_sources[0].data_source_parameters.maria_db_parameters.database #=> String
resp.override_parameters.data_sources[0].data_source_parameters.my_sql_parameters.host #=> String
resp.override_parameters.data_sources[0].data_source_parameters.my_sql_parameters.port #=> Integer
resp.override_parameters.data_sources[0].data_source_parameters.my_sql_parameters.database #=> String
resp.override_parameters.data_sources[0].data_source_parameters.oracle_parameters.host #=> String
resp.override_parameters.data_sources[0].data_source_parameters.oracle_parameters.port #=> Integer
resp.override_parameters.data_sources[0].data_source_parameters.oracle_parameters.database #=> String
resp.override_parameters.data_sources[0].data_source_parameters.postgre_sql_parameters.host #=> String
resp.override_parameters.data_sources[0].data_source_parameters.postgre_sql_parameters.port #=> Integer
resp.override_parameters.data_sources[0].data_source_parameters.postgre_sql_parameters.database #=> String
resp.override_parameters.data_sources[0].data_source_parameters.presto_parameters.host #=> String
resp.override_parameters.data_sources[0].data_source_parameters.presto_parameters.port #=> Integer
resp.override_parameters.data_sources[0].data_source_parameters.presto_parameters.catalog #=> String
resp.override_parameters.data_sources[0].data_source_parameters.rds_parameters.instance_id #=> String
resp.override_parameters.data_sources[0].data_source_parameters.rds_parameters.database #=> String
resp.override_parameters.data_sources[0].data_source_parameters.redshift_parameters.host #=> String
resp.override_parameters.data_sources[0].data_source_parameters.redshift_parameters.port #=> Integer
resp.override_parameters.data_sources[0].data_source_parameters.redshift_parameters.database #=> String
resp.override_parameters.data_sources[0].data_source_parameters.redshift_parameters.cluster_id #=> String
resp.override_parameters.data_sources[0].data_source_parameters.redshift_parameters.iam_parameters.role_arn #=> String
resp.override_parameters.data_sources[0].data_source_parameters.redshift_parameters.iam_parameters.database_user #=> String
resp.override_parameters.data_sources[0].data_source_parameters.redshift_parameters.iam_parameters.database_groups #=> Array
resp.override_parameters.data_sources[0].data_source_parameters.redshift_parameters.iam_parameters.database_groups[0] #=> String
resp.override_parameters.data_sources[0].data_source_parameters.redshift_parameters.iam_parameters.auto_create_database_user #=> Boolean
resp.override_parameters.data_sources[0].data_source_parameters.redshift_parameters.identity_center_configuration.enable_identity_propagation #=> Boolean
resp.override_parameters.data_sources[0].data_source_parameters.s3_parameters.manifest_file_location.bucket #=> String
resp.override_parameters.data_sources[0].data_source_parameters.s3_parameters.manifest_file_location.key #=> String
resp.override_parameters.data_sources[0].data_source_parameters.s3_parameters.role_arn #=> String
resp.override_parameters.data_sources[0].data_source_parameters.service_now_parameters.site_base_url #=> String
resp.override_parameters.data_sources[0].data_source_parameters.snowflake_parameters.host #=> String
resp.override_parameters.data_sources[0].data_source_parameters.snowflake_parameters.database #=> String
resp.override_parameters.data_sources[0].data_source_parameters.snowflake_parameters.warehouse #=> String
resp.override_parameters.data_sources[0].data_source_parameters.spark_parameters.host #=> String
resp.override_parameters.data_sources[0].data_source_parameters.spark_parameters.port #=> Integer
resp.override_parameters.data_sources[0].data_source_parameters.sql_server_parameters.host #=> String
resp.override_parameters.data_sources[0].data_source_parameters.sql_server_parameters.port #=> Integer
resp.override_parameters.data_sources[0].data_source_parameters.sql_server_parameters.database #=> String
resp.override_parameters.data_sources[0].data_source_parameters.teradata_parameters.host #=> String
resp.override_parameters.data_sources[0].data_source_parameters.teradata_parameters.port #=> Integer
resp.override_parameters.data_sources[0].data_source_parameters.teradata_parameters.database #=> String
resp.override_parameters.data_sources[0].data_source_parameters.twitter_parameters.query #=> String
resp.override_parameters.data_sources[0].data_source_parameters.twitter_parameters.max_rows #=> Integer
resp.override_parameters.data_sources[0].data_source_parameters.amazon_open_search_parameters.domain #=> String
resp.override_parameters.data_sources[0].data_source_parameters.exasol_parameters.host #=> String
resp.override_parameters.data_sources[0].data_source_parameters.exasol_parameters.port #=> Integer
resp.override_parameters.data_sources[0].data_source_parameters.databricks_parameters.host #=> String
resp.override_parameters.data_sources[0].data_source_parameters.databricks_parameters.port #=> Integer
resp.override_parameters.data_sources[0].data_source_parameters.databricks_parameters.sql_endpoint_path #=> String
resp.override_parameters.data_sources[0].data_source_parameters.starburst_parameters.host #=> String
resp.override_parameters.data_sources[0].data_source_parameters.starburst_parameters.port #=> Integer
resp.override_parameters.data_sources[0].data_source_parameters.starburst_parameters.catalog #=> String
resp.override_parameters.data_sources[0].data_source_parameters.starburst_parameters.product_type #=> String, one of "GALAXY", "ENTERPRISE"
resp.override_parameters.data_sources[0].data_source_parameters.trino_parameters.host #=> String
resp.override_parameters.data_sources[0].data_source_parameters.trino_parameters.port #=> Integer
resp.override_parameters.data_sources[0].data_source_parameters.trino_parameters.catalog #=> String
resp.override_parameters.data_sources[0].data_source_parameters.big_query_parameters.project_id #=> String
resp.override_parameters.data_sources[0].data_source_parameters.big_query_parameters.data_set_region #=> String
resp.override_parameters.data_sources[0].vpc_connection_properties.vpc_connection_arn #=> String
resp.override_parameters.data_sources[0].ssl_properties.disable_ssl #=> Boolean
resp.override_parameters.data_sources[0].credentials.credential_pair.username #=> String
resp.override_parameters.data_sources[0].credentials.credential_pair.password #=> String
resp.override_parameters.data_sources[0].credentials.secret_arn #=> String
resp.override_parameters.data_sets #=> Array
resp.override_parameters.data_sets[0].data_set_id #=> String
resp.override_parameters.data_sets[0].name #=> String
resp.override_parameters.themes #=> Array
resp.override_parameters.themes[0].theme_id #=> String
resp.override_parameters.themes[0].name #=> String
resp.override_parameters.analyses #=> Array
resp.override_parameters.analyses[0].analysis_id #=> String
resp.override_parameters.analyses[0].name #=> String
resp.override_parameters.dashboards #=> Array
resp.override_parameters.dashboards[0].dashboard_id #=> String
resp.override_parameters.dashboards[0].name #=> String
resp.failure_action #=> String, one of "DO_NOTHING", "ROLLBACK"
resp.request_id #=> String
resp.status #=> Integer
resp.override_permissions.data_sources #=> Array
resp.override_permissions.data_sources[0].data_source_ids #=> Array
resp.override_permissions.data_sources[0].data_source_ids[0] #=> String
resp.override_permissions.data_sources[0].permissions.principals #=> Array
resp.override_permissions.data_sources[0].permissions.principals[0] #=> String
resp.override_permissions.data_sources[0].permissions.actions #=> Array
resp.override_permissions.data_sources[0].permissions.actions[0] #=> String
resp.override_permissions.data_sets #=> Array
resp.override_permissions.data_sets[0].data_set_ids #=> Array
resp.override_permissions.data_sets[0].data_set_ids[0] #=> String
resp.override_permissions.data_sets[0].permissions.principals #=> Array
resp.override_permissions.data_sets[0].permissions.principals[0] #=> String
resp.override_permissions.data_sets[0].permissions.actions #=> Array
resp.override_permissions.data_sets[0].permissions.actions[0] #=> String
resp.override_permissions.themes #=> Array
resp.override_permissions.themes[0].theme_ids #=> Array
resp.override_permissions.themes[0].theme_ids[0] #=> String
resp.override_permissions.themes[0].permissions.principals #=> Array
resp.override_permissions.themes[0].permissions.principals[0] #=> String
resp.override_permissions.themes[0].permissions.actions #=> Array
resp.override_permissions.themes[0].permissions.actions[0] #=> String
resp.override_permissions.analyses #=> Array
resp.override_permissions.analyses[0].analysis_ids #=> Array
resp.override_permissions.analyses[0].analysis_ids[0] #=> String
resp.override_permissions.analyses[0].permissions.principals #=> Array
resp.override_permissions.analyses[0].permissions.principals[0] #=> String
resp.override_permissions.analyses[0].permissions.actions #=> Array
resp.override_permissions.analyses[0].permissions.actions[0] #=> String
resp.override_permissions.dashboards #=> Array
resp.override_permissions.dashboards[0].dashboard_ids #=> Array
resp.override_permissions.dashboards[0].dashboard_ids[0] #=> String
resp.override_permissions.dashboards[0].permissions.principals #=> Array
resp.override_permissions.dashboards[0].permissions.principals[0] #=> String
resp.override_permissions.dashboards[0].permissions.actions #=> Array
resp.override_permissions.dashboards[0].permissions.actions[0] #=> String
resp.override_permissions.dashboards[0].link_sharing_configuration.permissions.principals #=> Array
resp.override_permissions.dashboards[0].link_sharing_configuration.permissions.principals[0] #=> String
resp.override_permissions.dashboards[0].link_sharing_configuration.permissions.actions #=> Array
resp.override_permissions.dashboards[0].link_sharing_configuration.permissions.actions[0] #=> String
resp.override_tags.vpc_connections #=> Array
resp.override_tags.vpc_connections[0].vpc_connection_ids #=> Array
resp.override_tags.vpc_connections[0].vpc_connection_ids[0] #=> String
resp.override_tags.vpc_connections[0].tags #=> Array
resp.override_tags.vpc_connections[0].tags[0].key #=> String
resp.override_tags.vpc_connections[0].tags[0].value #=> String
resp.override_tags.data_sources #=> Array
resp.override_tags.data_sources[0].data_source_ids #=> Array
resp.override_tags.data_sources[0].data_source_ids[0] #=> String
resp.override_tags.data_sources[0].tags #=> Array
resp.override_tags.data_sources[0].tags[0].key #=> String
resp.override_tags.data_sources[0].tags[0].value #=> String
resp.override_tags.data_sets #=> Array
resp.override_tags.data_sets[0].data_set_ids #=> Array
resp.override_tags.data_sets[0].data_set_ids[0] #=> String
resp.override_tags.data_sets[0].tags #=> Array
resp.override_tags.data_sets[0].tags[0].key #=> String
resp.override_tags.data_sets[0].tags[0].value #=> String
resp.override_tags.themes #=> Array
resp.override_tags.themes[0].theme_ids #=> Array
resp.override_tags.themes[0].theme_ids[0] #=> String
resp.override_tags.themes[0].tags #=> Array
resp.override_tags.themes[0].tags[0].key #=> String
resp.override_tags.themes[0].tags[0].value #=> String
resp.override_tags.analyses #=> Array
resp.override_tags.analyses[0].analysis_ids #=> Array
resp.override_tags.analyses[0].analysis_ids[0] #=> String
resp.override_tags.analyses[0].tags #=> Array
resp.override_tags.analyses[0].tags[0].key #=> String
resp.override_tags.analyses[0].tags[0].value #=> String
resp.override_tags.dashboards #=> Array
resp.override_tags.dashboards[0].dashboard_ids #=> Array
resp.override_tags.dashboards[0].dashboard_ids[0] #=> String
resp.override_tags.dashboards[0].tags #=> Array
resp.override_tags.dashboards[0].tags[0].key #=> String
resp.override_tags.dashboards[0].tags[0].value #=> String
resp.override_validation_strategy.strict_mode_for_all_resources #=> Boolean
resp.warnings #=> Array
resp.warnings[0].arn #=> String
resp.warnings[0].message #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :aws_account_id (required, String) —

    The ID of the Amazon Web Services account the import job was executed in.

  • :asset_bundle_import_job_id (required, String) —

    The ID of the job. The job ID is set when you start a new job with a StartAssetBundleImportJob API call.

Returns:

See Also:



5738
5739
5740
5741
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 5738

def describe_asset_bundle_import_job(params = {}, options = {})
  req = build_request(:describe_asset_bundle_import_job, 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: "ShortRestrictiveResourceId", # 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.errors[0].violated_entities #=> Array
resp.dashboard.version.errors[0].violated_entities[0].path #=> 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", "DELETED"
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.version.theme_arn #=> String
resp.dashboard.version.sheets #=> Array
resp.dashboard.version.sheets[0].sheet_id #=> String
resp.dashboard.version.sheets[0].name #=> String
resp.dashboard.created_time #=> Time
resp.dashboard.last_published_time #=> Time
resp.dashboard.last_updated_time #=> Time
resp.dashboard.link_entities #=> Array
resp.dashboard.link_entities[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 Amazon Web Services 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:



5808
5809
5810
5811
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 5808

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

#describe_dashboard_definition(params = {}) ⇒ Types::DescribeDashboardDefinitionResponse

Provides a detailed description of the definition of a dashboard.

If you do not need to know details about the content of a dashboard, for instance if you are trying to check the status of a recently created or updated dashboard, use the DescribeDashboard instead.

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :aws_account_id (required, String) —

    The ID of the Amazon Web Services 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:



5865
5866
5867
5868
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 5865

def describe_dashboard_definition(params = {}, options = {})
  req = build_request(:describe_dashboard_definition, 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: "ShortRestrictiveResourceId", # 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
resp.link_sharing_configuration.permissions #=> Array
resp.link_sharing_configuration.permissions[0].principal #=> String
resp.link_sharing_configuration.permissions[0].actions #=> Array
resp.link_sharing_configuration.permissions[0].actions[0] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :aws_account_id (required, String) —

    The ID of the Amazon Web Services 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:



5914
5915
5916
5917
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 5914

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

#describe_dashboard_snapshot_job(params = {}) ⇒ Types::DescribeDashboardSnapshotJobResponse

Describes an existing snapshot job.

Poll job descriptions after a job starts to know the status of the job. For information on available status codes, see JobStatus.

Examples:

Request syntax with placeholder values


resp = client.describe_dashboard_snapshot_job({
  aws_account_id: "AwsAccountId", # required
  dashboard_id: "ShortRestrictiveResourceId", # required
  snapshot_job_id: "ShortRestrictiveResourceId", # required
})

Response structure


resp. #=> String
resp.dashboard_id #=> String
resp.snapshot_job_id #=> String
resp.user_configuration.anonymous_users #=> Array
resp.user_configuration.anonymous_users[0].row_level_permission_tag_keys #=> Array
resp.user_configuration.anonymous_users[0].row_level_permission_tag_keys[0] #=> String
resp.snapshot_configuration.file_groups #=> Array
resp.snapshot_configuration.file_groups[0].files #=> Array
resp.snapshot_configuration.file_groups[0].files[0].sheet_selections #=> Array
resp.snapshot_configuration.file_groups[0].files[0].sheet_selections[0].sheet_id #=> String
resp.snapshot_configuration.file_groups[0].files[0].sheet_selections[0].selection_scope #=> String, one of "ALL_VISUALS", "SELECTED_VISUALS"
resp.snapshot_configuration.file_groups[0].files[0].sheet_selections[0].visual_ids #=> Array
resp.snapshot_configuration.file_groups[0].files[0].sheet_selections[0].visual_ids[0] #=> String
resp.snapshot_configuration.file_groups[0].files[0].format_type #=> String, one of "CSV", "PDF", "EXCEL"
resp.snapshot_configuration.destination_configuration.s3_destinations #=> Array
resp.snapshot_configuration.destination_configuration.s3_destinations[0].bucket_configuration.bucket_name #=> String
resp.snapshot_configuration.destination_configuration.s3_destinations[0].bucket_configuration.bucket_prefix #=> String
resp.snapshot_configuration.destination_configuration.s3_destinations[0].bucket_configuration.bucket_region #=> String
resp.snapshot_configuration.parameters.string_parameters #=> Array
resp.snapshot_configuration.parameters.string_parameters[0].name #=> String
resp.snapshot_configuration.parameters.string_parameters[0].values #=> Array
resp.snapshot_configuration.parameters.string_parameters[0].values[0] #=> String
resp.snapshot_configuration.parameters.integer_parameters #=> Array
resp.snapshot_configuration.parameters.integer_parameters[0].name #=> String
resp.snapshot_configuration.parameters.integer_parameters[0].values #=> Array
resp.snapshot_configuration.parameters.integer_parameters[0].values[0] #=> Integer
resp.snapshot_configuration.parameters.decimal_parameters #=> Array
resp.snapshot_configuration.parameters.decimal_parameters[0].name #=> String
resp.snapshot_configuration.parameters.decimal_parameters[0].values #=> Array
resp.snapshot_configuration.parameters.decimal_parameters[0].values[0] #=> Float
resp.snapshot_configuration.parameters.date_time_parameters #=> Array
resp.snapshot_configuration.parameters.date_time_parameters[0].name #=> String
resp.snapshot_configuration.parameters.date_time_parameters[0].values #=> Array
resp.snapshot_configuration.parameters.date_time_parameters[0].values[0] #=> Time
resp.arn #=> String
resp.job_status #=> String, one of "QUEUED", "RUNNING", "COMPLETED", "FAILED"
resp.created_time #=> Time
resp.last_updated_time #=> Time
resp.request_id #=> String
resp.status #=> Integer

Parameters:

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

    ({})

Options Hash (params):

  • :aws_account_id (required, String) —

    The ID of the Amazon Web Services account that the dashboard snapshot job is executed in.

  • :dashboard_id (required, String) —

    The ID of the dashboard that you have started a snapshot job for.

  • :snapshot_job_id (required, String) —

    The ID of the job to be described. The job ID is set when you start a new job with a StartDashboardSnapshotJob API call.

Returns:

See Also:



6004
6005
6006
6007
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 6004

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

#describe_dashboard_snapshot_job_result(params = {}) ⇒ Types::DescribeDashboardSnapshotJobResultResponse

Describes the result of an existing snapshot job that has finished running.

A finished snapshot job will return a COMPLETED or FAILED status when you poll the job with a DescribeDashboardSnapshotJob API call.

If the job has not finished running, this operation returns a message that says Dashboard Snapshot Job with id <SnapshotjobId> has not reached a terminal state..

Examples:

Request syntax with placeholder values


resp = client.describe_dashboard_snapshot_job_result({
  aws_account_id: "AwsAccountId", # required
  dashboard_id: "ShortRestrictiveResourceId", # required
  snapshot_job_id: "ShortRestrictiveResourceId", # required
})

Response structure


resp.arn #=> String
resp.job_status #=> String, one of "QUEUED", "RUNNING", "COMPLETED", "FAILED"
resp.created_time #=> Time
resp.last_updated_time #=> Time
resp.result.anonymous_users #=> Array
resp.result.anonymous_users[0].file_groups #=> Array
resp.result.anonymous_users[0].file_groups[0].files #=> Array
resp.result.anonymous_users[0].file_groups[0].files[0].sheet_selections #=> Array
resp.result.anonymous_users[0].file_groups[0].files[0].sheet_selections[0].sheet_id #=> String
resp.result.anonymous_users[0].file_groups[0].files[0].sheet_selections[0].selection_scope #=> String, one of "ALL_VISUALS", "SELECTED_VISUALS"
resp.result.anonymous_users[0].file_groups[0].files[0].sheet_selections[0].visual_ids #=> Array
resp.result.anonymous_users[0].file_groups[0].files[0].sheet_selections[0].visual_ids[0] #=> String
resp.result.anonymous_users[0].file_groups[0].files[0].format_type #=> String, one of "CSV", "PDF", "EXCEL"
resp.result.anonymous_users[0].file_groups[0].s3_results #=> Array
resp.result.anonymous_users[0].file_groups[0].s3_results[0].s3_destination_configuration.bucket_configuration.bucket_name #=> String
resp.result.anonymous_users[0].file_groups[0].s3_results[0].s3_destination_configuration.bucket_configuration.bucket_prefix #=> String
resp.result.anonymous_users[0].file_groups[0].s3_results[0].s3_destination_configuration.bucket_configuration.bucket_region #=> String
resp.result.anonymous_users[0].file_groups[0].s3_results[0].s3_uri #=> String
resp.result.anonymous_users[0].file_groups[0].s3_results[0].error_info #=> Array
resp.result.anonymous_users[0].file_groups[0].s3_results[0].error_info[0].error_message #=> String
resp.result.anonymous_users[0].file_groups[0].s3_results[0].error_info[0].error_type #=> String
resp.error_info.error_message #=> String
resp.error_info.error_type #=> 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 Amazon Web Services account that the dashboard snapshot job is executed in.

  • :dashboard_id (required, String) —

    The ID of the dashboard that you have started a snapshot job for.

  • :snapshot_job_id (required, String) —

    The ID of the job to be described. The job ID is set when you start a new job with a StartDashboardSnapshotJob API call.

Returns:

See Also:



6081
6082
6083
6084
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 6081

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

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

Describes a dataset. This operation doesn't support datasets that include uploaded files as a source.

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.catalog #=> 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"].relational_table.input_columns[0].sub_type #=> String, one of "FLOAT", "FIXED"
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"].custom_sql.columns[0].sub_type #=> String, one of "FLOAT", "FIXED"
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.physical_table_map["PhysicalTableId"].s3_source.input_columns[0].sub_type #=> String, one of "FLOAT", "FIXED"
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.sub_type #=> String, one of "FLOAT", "FIXED"
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"].data_transforms[0].tag_column_operation.tags[0].column_description.text #=> String
resp.data_set.logical_table_map["LogicalTableId"].data_transforms[0].untag_column_operation.column_name #=> String
resp.data_set.logical_table_map["LogicalTableId"].data_transforms[0].untag_column_operation.tag_names #=> Array
resp.data_set.logical_table_map["LogicalTableId"].data_transforms[0].untag_column_operation.tag_names[0] #=> String, one of "COLUMN_GEOGRAPHIC_ROLE", "COLUMN_DESCRIPTION"
resp.data_set.logical_table_map["LogicalTableId"].data_transforms[0].override_dataset_parameter_operation.parameter_name #=> String
resp.data_set.logical_table_map["LogicalTableId"].data_transforms[0].override_dataset_parameter_operation.new_parameter_name #=> String
resp.data_set.logical_table_map["LogicalTableId"].data_transforms[0].override_dataset_parameter_operation.new_default_values.string_static_values #=> Array
resp.data_set.logical_table_map["LogicalTableId"].data_transforms[0].override_dataset_parameter_operation.new_default_values.string_static_values[0] #=> String
resp.data_set.logical_table_map["LogicalTableId"].data_transforms[0].override_dataset_parameter_operation.new_default_values.decimal_static_values #=> Array
resp.data_set.logical_table_map["LogicalTableId"].data_transforms[0].override_dataset_parameter_operation.new_default_values.decimal_static_values[0] #=> Float
resp.data_set.logical_table_map["LogicalTableId"].data_transforms[0].override_dataset_parameter_operation.new_default_values.date_time_static_values #=> Array
resp.data_set.logical_table_map["LogicalTableId"].data_transforms[0].override_dataset_parameter_operation.new_default_values.date_time_static_values[0] #=> Time
resp.data_set.logical_table_map["LogicalTableId"].data_transforms[0].override_dataset_parameter_operation.new_default_values.integer_static_values #=> Array
resp.data_set.logical_table_map["LogicalTableId"].data_transforms[0].override_dataset_parameter_operation.new_default_values.integer_static_values[0] #=> Integer
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.left_join_key_properties.unique_key #=> Boolean
resp.data_set.logical_table_map["LogicalTableId"].source.join_instruction.right_join_key_properties.unique_key #=> Boolean
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.logical_table_map["LogicalTableId"].source.data_set_arn #=> String
resp.data_set.output_columns #=> Array
resp.data_set.output_columns[0].name #=> String
resp.data_set.output_columns[0].description #=> String
resp.data_set.output_columns[0].type #=> String, one of "STRING", "INTEGER", "DECIMAL", "DATETIME"
resp.data_set.output_columns[0].sub_type #=> String, one of "FLOAT", "FIXED"
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.field_folders #=> Hash
resp.data_set.field_folders["FieldFolderPath"].description #=> String
resp.data_set.field_folders["FieldFolderPath"].columns #=> Array
resp.data_set.field_folders["FieldFolderPath"].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.data_set.row_level_permission_data_set.format_version #=> String, one of "VERSION_1", "VERSION_2"
resp.data_set.row_level_permission_data_set.status #=> String, one of "ENABLED", "DISABLED"
resp.data_set.row_level_permission_tag_configuration.status #=> String, one of "ENABLED", "DISABLED"
resp.data_set.row_level_permission_tag_configuration.tag_rules #=> Array
resp.data_set.row_level_permission_tag_configuration.tag_rules[0].tag_key #=> String
resp.data_set.row_level_permission_tag_configuration.tag_rules[0].column_name #=> String
resp.data_set.row_level_permission_tag_configuration.tag_rules[0].tag_multi_value_delimiter #=> String
resp.data_set.row_level_permission_tag_configuration.tag_rules[0].match_all_value #=> String
resp.data_set.row_level_permission_tag_configuration.tag_rule_configurations #=> Array
resp.data_set.row_level_permission_tag_configuration.tag_rule_configurations[0] #=> Array
resp.data_set.row_level_permission_tag_configuration.tag_rule_configurations[0][0] #=> String
resp.data_set.column_level_permission_rules #=> Array
resp.data_set.column_level_permission_rules[0].principals #=> Array
resp.data_set.column_level_permission_rules[0].principals[0] #=> String
resp.data_set.column_level_permission_rules[0].column_names #=> Array
resp.data_set.column_level_permission_rules[0].column_names[0] #=> String
resp.data_set.data_set_usage_configuration.disable_use_as_direct_query_source #=> Boolean
resp.data_set.data_set_usage_configuration.disable_use_as_imported_source #=> Boolean
resp.data_set.dataset_parameters #=> Array
resp.data_set.dataset_parameters[0].string_dataset_parameter.id #=> String
resp.data_set.dataset_parameters[0].string_dataset_parameter.name #=> String
resp.data_set.dataset_parameters[0].string_dataset_parameter.value_type #=> String, one of "MULTI_VALUED", "SINGLE_VALUED"
resp.data_set.dataset_parameters[0].string_dataset_parameter.default_values.static_values #=> Array
resp.data_set.dataset_parameters[0].string_dataset_parameter.default_values.static_values[0] #=> String
resp.data_set.dataset_parameters[0].decimal_dataset_parameter.id #=> String
resp.data_set.dataset_parameters[0].decimal_dataset_parameter.name #=> String
resp.data_set.dataset_parameters[0].decimal_dataset_parameter.value_type #=> String, one of "MULTI_VALUED", "SINGLE_VALUED"
resp.data_set.dataset_parameters[0].decimal_dataset_parameter.default_values.static_values #=> Array
resp.data_set.dataset_parameters[0].decimal_dataset_parameter.default_values.static_values[0] #=> Float
resp.data_set.dataset_parameters[0].integer_dataset_parameter.id #=> String
resp.data_set.dataset_parameters[0].integer_dataset_parameter.name #=> String
resp.data_set.dataset_parameters[0].integer_dataset_parameter.value_type #=> String, one of "MULTI_VALUED", "SINGLE_VALUED"
resp.data_set.dataset_parameters[0].integer_dataset_parameter.default_values.static_values #=> Array
resp.data_set.dataset_parameters[0].integer_dataset_parameter.default_values.static_values[0] #=> Integer
resp.data_set.dataset_parameters[0].date_time_dataset_parameter.id #=> String
resp.data_set.dataset_parameters[0].date_time_dataset_parameter.name #=> String
resp.data_set.dataset_parameters[0].date_time_dataset_parameter.value_type #=> String, one of "MULTI_VALUED", "SINGLE_VALUED"
resp.data_set.dataset_parameters[0].date_time_dataset_parameter.time_granularity #=> String, one of "YEAR", "QUARTER", "MONTH", "WEEK", "DAY", "HOUR", "MINUTE", "SECOND", "MILLISECOND"
resp.data_set.dataset_parameters[0].date_time_dataset_parameter.default_values.static_values #=> Array
resp.data_set.dataset_parameters[0].date_time_dataset_parameter.default_values.static_values[0] #=> Time
resp.request_id #=> String
resp.status #=> Integer

Parameters:

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

    ({})

Options Hash (params):

  • :aws_account_id (required, String) —

    The Amazon Web Services account ID.

  • :data_set_id (required, String) —

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

Returns:

See Also:



6249
6250
6251
6252
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 6249

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

  • :data_set_id (required, String) —

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

Returns:

See Also:



6296
6297
6298
6299
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 6296

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

#describe_data_set_refresh_properties(params = {}) ⇒ Types::DescribeDataSetRefreshPropertiesResponse

Describes the refresh properties of a dataset.

Examples:

Request syntax with placeholder values


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

Response structure


resp.request_id #=> String
resp.status #=> Integer
resp.data_set_refresh_properties.refresh_configuration.incremental_refresh.lookback_window.column_name #=> String
resp.data_set_refresh_properties.refresh_configuration.incremental_refresh.lookback_window.size #=> Integer
resp.data_set_refresh_properties.refresh_configuration.incremental_refresh.lookback_window.size_unit #=> String, one of "HOUR", "DAY", "WEEK"

Parameters:

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

    ({})

Options Hash (params):

  • :aws_account_id (required, String) —

    The Amazon Web Services account ID.

  • :data_set_id (required, String) —

    The ID of the dataset.

Returns:

See Also:



6334
6335
6336
6337
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 6334

def describe_data_set_refresh_properties(params = {}, options = {})
  req = build_request(:describe_data_set_refresh_properties, 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", "ORACLE", "POSTGRESQL", "PRESTO", "REDSHIFT", "S3", "SALESFORCE", "SERVICENOW", "SNOWFLAKE", "SPARK", "SQLSERVER", "TERADATA", "TWITTER", "TIMESTREAM", "AMAZON_OPENSEARCH", "EXASOL", "DATABRICKS", "STARBURST", "TRINO", "BIGQUERY"
resp.data_source.status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED", "DELETED"
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.athena_parameters.role_arn #=> 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.oracle_parameters.host #=> String
resp.data_source.data_source_parameters.oracle_parameters.port #=> Integer
resp.data_source.data_source_parameters.oracle_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.redshift_parameters.iam_parameters.role_arn #=> String
resp.data_source.data_source_parameters.redshift_parameters.iam_parameters.database_user #=> String
resp.data_source.data_source_parameters.redshift_parameters.iam_parameters.database_groups #=> Array
resp.data_source.data_source_parameters.redshift_parameters.iam_parameters.database_groups[0] #=> String
resp.data_source.data_source_parameters.redshift_parameters.iam_parameters.auto_create_database_user #=> Boolean
resp.data_source.data_source_parameters.redshift_parameters.identity_center_configuration.enable_identity_propagation #=> Boolean
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.s3_parameters.role_arn #=> 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.data_source_parameters.amazon_open_search_parameters.domain #=> String
resp.data_source.data_source_parameters.exasol_parameters.host #=> String
resp.data_source.data_source_parameters.exasol_parameters.port #=> Integer
resp.data_source.data_source_parameters.databricks_parameters.host #=> String
resp.data_source.data_source_parameters.databricks_parameters.port #=> Integer
resp.data_source.data_source_parameters.databricks_parameters.sql_endpoint_path #=> String
resp.data_source.data_source_parameters.starburst_parameters.host #=> String
resp.data_source.data_source_parameters.starburst_parameters.port #=> Integer
resp.data_source.data_source_parameters.starburst_parameters.catalog #=> String
resp.data_source.data_source_parameters.starburst_parameters.product_type #=> String, one of "GALAXY", "ENTERPRISE"
resp.data_source.data_source_parameters.trino_parameters.host #=> String
resp.data_source.data_source_parameters.trino_parameters.port #=> Integer
resp.data_source.data_source_parameters.trino_parameters.catalog #=> String
resp.data_source.data_source_parameters.big_query_parameters.project_id #=> String
resp.data_source.data_source_parameters.big_query_parameters.data_set_region #=> String
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].athena_parameters.role_arn #=> 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].oracle_parameters.host #=> String
resp.data_source.alternate_data_source_parameters[0].oracle_parameters.port #=> Integer
resp.data_source.alternate_data_source_parameters[0].oracle_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].redshift_parameters.iam_parameters.role_arn #=> String
resp.data_source.alternate_data_source_parameters[0].redshift_parameters.iam_parameters.database_user #=> String
resp.data_source.alternate_data_source_parameters[0].redshift_parameters.iam_parameters.database_groups #=> Array
resp.data_source.alternate_data_source_parameters[0].redshift_parameters.iam_parameters.database_groups[0] #=> String
resp.data_source.alternate_data_source_parameters[0].redshift_parameters.iam_parameters.auto_create_database_user #=> Boolean
resp.data_source.alternate_data_source_parameters[0].redshift_parameters.identity_center_configuration.enable_identity_propagation #=> Boolean
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].s3_parameters.role_arn #=> 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.alternate_data_source_parameters[0].amazon_open_search_parameters.domain #=> String
resp.data_source.alternate_data_source_parameters[0].exasol_parameters.host #=> String
resp.data_source.alternate_data_source_parameters[0].exasol_parameters.port #=> Integer
resp.data_source.alternate_data_source_parameters[0].databricks_parameters.host #=> String
resp.data_source.alternate_data_source_parameters[0].databricks_parameters.port #=> Integer
resp.data_source.alternate_data_source_parameters[0].databricks_parameters.sql_endpoint_path #=> String
resp.data_source.alternate_data_source_parameters[0].starburst_parameters.host #=> String
resp.data_source.alternate_data_source_parameters[0].starburst_parameters.port #=> Integer
resp.data_source.alternate_data_source_parameters[0].starburst_parameters.catalog #=> String
resp.data_source.alternate_data_source_parameters[0].starburst_parameters.product_type #=> String, one of "GALAXY", "ENTERPRISE"
resp.data_source.alternate_data_source_parameters[0].trino_parameters.host #=> String
resp.data_source.alternate_data_source_parameters[0].trino_parameters.port #=> Integer
resp.data_source.alternate_data_source_parameters[0].trino_parameters.catalog #=> String
resp.data_source.alternate_data_source_parameters[0].big_query_parameters.project_id #=> String
resp.data_source.alternate_data_source_parameters[0].big_query_parameters.data_set_region #=> String
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.data_source.secret_arn #=> String
resp.request_id #=> String
resp.status #=> Integer

Parameters:

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

    ({})

Options Hash (params):

  • :aws_account_id (required, String) —

    The Amazon Web Services account ID.

  • :data_source_id (required, String) —

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

Returns:

See Also:



6523
6524
6525
6526
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 6523

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

  • :data_source_id (required, String) —

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

Returns:

See Also:



6567
6568
6569
6570
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 6567

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

#describe_folder(params = {}) ⇒ Types::DescribeFolderResponse

Describes a folder.

Examples:

Request syntax with placeholder values


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

Response structure


resp.status #=> Integer
resp.folder.folder_id #=> String
resp.folder.arn #=> String
resp.folder.name #=> String
resp.folder.folder_type #=> String, one of "SHARED", "RESTRICTED"
resp.folder.folder_path #=> Array
resp.folder.folder_path[0] #=> String
resp.folder.created_time #=> Time
resp.folder.last_updated_time #=> Time
resp.folder.sharing_model #=> String, one of "ACCOUNT", "NAMESPACE"
resp.request_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :aws_account_id (required, String) —

    The ID for the Amazon Web Services account that contains the folder.

  • :folder_id (required, String) —

    The ID of the folder.

Returns:

See Also:



6611
6612
6613
6614
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 6611

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

#describe_folder_permissions(params = {}) ⇒ Types::DescribeFolderPermissionsResponse

Describes permissions for a folder.

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

Examples:

Request syntax with placeholder values


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

Response structure


resp.status #=> Integer
resp.folder_id #=> String
resp.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.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :aws_account_id (required, String) —

    The ID for the Amazon Web Services account that contains the folder.

  • :folder_id (required, String) —

    The ID of the folder.

  • :namespace (String) —

    The namespace of the folder whose permissions you want described.

  • :max_results (Integer) —

    The maximum number of results to be returned per request.

  • :next_token (String) —

    A pagination token for the next set of results.

Returns:

See Also:



6670
6671
6672
6673
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 6670

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

#describe_folder_resolved_permissions(params = {}) ⇒ Types::DescribeFolderResolvedPermissionsResponse

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

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

Examples:

Request syntax with placeholder values


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

Response structure


resp.status #=> Integer
resp.folder_id #=> String
resp.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.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :aws_account_id (required, String) —

    The ID for the Amazon Web Services account that contains the folder.

  • :folder_id (required, String) —

    The ID of the folder.

  • :namespace (String) —

    The namespace of the folder whose permissions you want described.

  • :max_results (Integer) —

    The maximum number of results to be returned per request.

  • :next_token (String) —

    A pagination token for the next set of results.

Returns:

See Also:



6731
6732
6733
6734
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 6731

def describe_folder_resolved_permissions(params = {}, options = {})
  req = build_request(:describe_folder_resolved_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 Amazon Web Services account that the group is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon QuickSight account.

  • :namespace (required, String) —

    The namespace of the group that you want described.

Returns:

See Also:



6777
6778
6779
6780
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 6777

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

#describe_group_membership(params = {}) ⇒ Types::DescribeGroupMembershipResponse

Use the DescribeGroupMembership operation to determine if a user is a member of the specified group. If the user exists and is a member of the specified group, an associated GroupMember object is returned.

Examples:

Request syntax with placeholder values


resp = client.describe_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 user name of the user that you want to search for.

  • :group_name (required, String) —

    The name of the group that you want to search.

  • :aws_account_id (required, String) —

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

  • :namespace (required, String) —

    The namespace that includes the group you are searching within.

Returns:

See Also:



6826
6827
6828
6829
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 6826

def describe_group_membership(params = {}, options = {})
  req = build_request(:describe_group_membership, 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 Amazon Web Services account that contains the assignment that you want to describe.

  • :assignment_name (required, String) —

    The name of the assignment, also called a rule.

  • :namespace (required, String) —

    The namespace that contains the assignment.

Returns:

See Also:



6875
6876
6877
6878
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 6875

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", "REFRESH_SUPPRESSED_BY_EDIT", "PERMISSION_NOT_FOUND", "ELASTICSEARCH_CURSOR_NOT_ENABLED", "CURSOR_NOT_ENABLED", "DUPLICATE_COLUMN_NAMES_FOUND"
resp.ingestion.error_info.message #=> String
resp.ingestion.row_info.rows_ingested #=> Integer
resp.ingestion.row_info.rows_dropped #=> Integer
resp.ingestion.row_info.total_rows_in_dataset #=> 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 Amazon Web Services 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:



6929
6930
6931
6932
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 6929

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

#describe_ip_restriction(params = {}) ⇒ Types::DescribeIpRestrictionResponse

Provides a summary and status of IP rules.

Examples:

Request syntax with placeholder values


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

Response structure


resp. #=> String
resp.ip_restriction_rule_map #=> Hash
resp.ip_restriction_rule_map["CIDR"] #=> String
resp.vpc_id_restriction_rule_map #=> Hash
resp.vpc_id_restriction_rule_map["VpcId"] #=> String
resp.vpc_endpoint_id_restriction_rule_map #=> Hash
resp.vpc_endpoint_id_restriction_rule_map["VpcEndpointId"] #=> String
resp.enabled #=> Boolean
resp.request_id #=> String
resp.status #=> Integer

Parameters:

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

    ({})

Options Hash (params):

  • :aws_account_id (required, String) —

    The ID of the Amazon Web Services account that contains the IP rules.

Returns:

See Also:



6972
6973
6974
6975
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 6972

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

#describe_key_registration(params = {}) ⇒ Types::DescribeKeyRegistrationResponse

Describes all customer managed key registrations in a Amazon QuickSight account.

Examples:

Request syntax with placeholder values


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

Response structure


resp. #=> String
resp.key_registration #=> Array
resp.key_registration[0].key_arn #=> String
resp.key_registration[0].default_key #=> Boolean
resp.request_id #=> String
resp.status #=> Integer

Parameters:

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

    ({})

Options Hash (params):

  • :aws_account_id (required, String) —

    The ID of the Amazon Web Services account that contains the customer managed key registration that you want to describe.

  • :default_key_only (Boolean) —

    Determines whether the request returns the default key only.

Returns:

See Also:



7014
7015
7016
7017
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 7014

def describe_key_registration(params = {}, options = {})
  req = build_request(:describe_key_registration, 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 Amazon Web Services account that contains the Amazon QuickSight namespace that you want to describe.

  • :namespace (required, String) —

    The namespace that you want to describe.

Returns:

See Also:



7057
7058
7059
7060
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 7057

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

#describe_refresh_schedule(params = {}) ⇒ Types::DescribeRefreshScheduleResponse

Provides a summary of a refresh schedule.

Examples:

Request syntax with placeholder values


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

Response structure


resp.refresh_schedule.schedule_id #=> String
resp.refresh_schedule.schedule_frequency.interval #=> String, one of "MINUTE15", "MINUTE30", "HOURLY", "DAILY", "WEEKLY", "MONTHLY"
resp.refresh_schedule.schedule_frequency.refresh_on_day.day_of_week #=> String, one of "SUNDAY", "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY"
resp.refresh_schedule.schedule_frequency.refresh_on_day.day_of_month #=> String
resp.refresh_schedule.schedule_frequency.timezone #=> String
resp.refresh_schedule.schedule_frequency.time_of_the_day #=> String
resp.refresh_schedule.start_after_date_time #=> Time
resp.refresh_schedule.refresh_type #=> String, one of "INCREMENTAL_REFRESH", "FULL_REFRESH"
resp.refresh_schedule.arn #=> String
resp.status #=> Integer
resp.request_id #=> String
resp.arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :aws_account_id (required, String) —

    The Amazon Web Services account ID.

  • :data_set_id (required, String) —

    The ID of the dataset.

  • :schedule_id (required, String) —

    The ID of the refresh schedule.

Returns:

See Also:



7107
7108
7109
7110
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 7107

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

#describe_role_custom_permission(params = {}) ⇒ Types::DescribeRoleCustomPermissionResponse

Describes all custom permissions that are mapped to a role.

Examples:

Request syntax with placeholder values


resp = client.describe_role_custom_permission({
  role: "ADMIN", # required, accepts ADMIN, AUTHOR, READER, ADMIN_PRO, AUTHOR_PRO, READER_PRO
  aws_account_id: "AwsAccountId", # required
  namespace: "Namespace", # required
})

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :role (required, String) —

    The name of the role whose permissions you want described.

  • :aws_account_id (required, String) —

    The ID for the Amazon Web Services account that you want to create a group in. The Amazon Web Services account ID that you provide must be the same Amazon Web Services account that contains your Amazon QuickSight account.

  • :namespace (required, String) —

    The namespace that contains the role.

Returns:

See Also:



7150
7151
7152
7153
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 7150

def describe_role_custom_permission(params = {}, options = {})
  req = build_request(:describe_role_custom_permission, 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: "ShortRestrictiveResourceId", # 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", "ACCESS_DENIED"
resp.template.version.errors[0].message #=> String
resp.template.version.errors[0].violated_entities #=> Array
resp.template.version.errors[0].violated_entities[0].path #=> 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", "DELETED"
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.version.theme_arn #=> String
resp.template.version.sheets #=> Array
resp.template.version.sheets[0].sheet_id #=> String
resp.template.version.sheets[0].name #=> 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 Amazon Web Services 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:



7229
7230
7231
7232
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 7229

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: "ShortRestrictiveResourceId", # 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 Amazon Web Services 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:



7276
7277
7278
7279
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 7276

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

#describe_template_definition(params = {}) ⇒ Types::DescribeTemplateDefinitionResponse

Provides a detailed description of the definition of a template.

If you do not need to know details about the content of a template, for instance if you are trying to check the status of a recently created or updated template, use the DescribeTemplate instead.

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :aws_account_id (required, String) —

    The ID of the Amazon Web Services account that contains the template. You must be using the Amazon Web Services account that the template is in.

  • :template_id (required, String) —

    The ID of the template that you're describing.

  • :version_number (Integer) —

    The version number of the template.

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



7336
7337
7338
7339
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 7336

def describe_template_definition(params = {}, options = {})
  req = build_request(:describe_template_definition, 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: "ShortRestrictiveResourceId", # 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 Amazon Web Services account that contains the template that you're describing.

  • :template_id (required, String) —

    The ID for the template.

Returns:

See Also:



7380
7381
7382
7383
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 7380

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: "ShortRestrictiveResourceId", # 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.configuration.typography.font_families #=> Array
resp.theme.version.configuration.typography.font_families[0].font_family #=> String
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", "DELETED"
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 Amazon Web Services 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:



7471
7472
7473
7474
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 7471

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: "ShortRestrictiveResourceId", # 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 Amazon Web Services 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:



7514
7515
7516
7517
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 7514

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: "ShortRestrictiveResourceId", # 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 Amazon Web Services 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:



7558
7559
7560
7561
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 7558

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

#describe_topic(params = {}) ⇒ Types::DescribeTopicResponse

Describes a topic.

Examples:

Request syntax with placeholder values


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

Response structure


resp.arn #=> String
resp.topic_id #=> String
resp.topic.name #=> String
resp.topic.description #=> String
resp.topic.user_experience_version #=> String, one of "LEGACY", "NEW_READER_EXPERIENCE"
resp.topic.data_sets #=> Array
resp.topic.data_sets[0].dataset_arn #=> String
resp.topic.data_sets[0].dataset_name #=> String
resp.topic.data_sets[0].dataset_description #=> String
resp.topic.data_sets[0].data_aggregation.dataset_row_date_granularity #=> String, one of "SECOND", "MINUTE", "HOUR", "DAY", "WEEK", "MONTH", "QUARTER", "YEAR"
resp.topic.data_sets[0].data_aggregation.default_date_column_name #=> String
resp.topic.data_sets[0].filters #=> Array
resp.topic.data_sets[0].filters[0].filter_description #=> String
resp.topic.data_sets[0].filters[0].filter_class #=> String, one of "ENFORCED_VALUE_FILTER", "CONDITIONAL_VALUE_FILTER", "NAMED_VALUE_FILTER"
resp.topic.data_sets[0].filters[0].filter_name #=> String
resp.topic.data_sets[0].filters[0].filter_synonyms #=> Array
resp.topic.data_sets[0].filters[0].filter_synonyms[0] #=> String
resp.topic.data_sets[0].filters[0].operand_field_name #=> String
resp.topic.data_sets[0].filters[0].filter_type #=> String, one of "CATEGORY_FILTER", "NUMERIC_EQUALITY_FILTER", "NUMERIC_RANGE_FILTER", "DATE_RANGE_FILTER", "RELATIVE_DATE_FILTER"
resp.topic.data_sets[0].filters[0].category_filter.category_filter_function #=> String, one of "EXACT", "CONTAINS"
resp.topic.data_sets[0].filters[0].category_filter.category_filter_type #=> String, one of "CUSTOM_FILTER", "CUSTOM_FILTER_LIST", "FILTER_LIST"
resp.topic.data_sets[0].filters[0].category_filter.constant.constant_type #=> String, one of "SINGULAR", "RANGE", "COLLECTIVE"
resp.topic.data_sets[0].filters[0].category_filter.constant.singular_constant #=> String
resp.topic.data_sets[0].filters[0].category_filter.constant.collective_constant.value_list #=> Array
resp.topic.data_sets[0].filters[0].category_filter.constant.collective_constant.value_list[0] #=> String
resp.topic.data_sets[0].filters[0].category_filter.inverse #=> Boolean
resp.topic.data_sets[0].filters[0].numeric_equality_filter.constant.constant_type #=> String, one of "SINGULAR", "RANGE", "COLLECTIVE"
resp.topic.data_sets[0].filters[0].numeric_equality_filter.constant.singular_constant #=> String
resp.topic.data_sets[0].filters[0].numeric_equality_filter.aggregation #=> String, one of "NO_AGGREGATION", "SUM", "AVERAGE", "COUNT", "DISTINCT_COUNT", "MAX", "MEDIAN", "MIN", "STDEV", "STDEVP", "VAR", "VARP"
resp.topic.data_sets[0].filters[0].numeric_range_filter.inclusive #=> Boolean
resp.topic.data_sets[0].filters[0].numeric_range_filter.constant.constant_type #=> String, one of "SINGULAR", "RANGE", "COLLECTIVE"
resp.topic.data_sets[0].filters[0].numeric_range_filter.constant.range_constant.minimum #=> String
resp.topic.data_sets[0].filters[0].numeric_range_filter.constant.range_constant.maximum #=> String
resp.topic.data_sets[0].filters[0].numeric_range_filter.aggregation #=> String, one of "NO_AGGREGATION", "SUM", "AVERAGE", "COUNT", "DISTINCT_COUNT", "MAX", "MEDIAN", "MIN", "STDEV", "STDEVP", "VAR", "VARP"
resp.topic.data_sets[0].filters[0].date_range_filter.inclusive #=> Boolean
resp.topic.data_sets[0].filters[0].date_range_filter.constant.constant_type #=> String, one of "SINGULAR", "RANGE", "COLLECTIVE"
resp.topic.data_sets[0].filters[0].date_range_filter.constant.range_constant.minimum #=> String
resp.topic.data_sets[0].filters[0].date_range_filter.constant.range_constant.maximum #=> String
resp.topic.data_sets[0].filters[0].relative_date_filter.time_granularity #=> String, one of "SECOND", "MINUTE", "HOUR", "DAY", "WEEK", "MONTH", "QUARTER", "YEAR"
resp.topic.data_sets[0].filters[0].relative_date_filter.relative_date_filter_function #=> String, one of "PREVIOUS", "THIS", "LAST", "NEXT", "NOW"
resp.topic.data_sets[0].filters[0].relative_date_filter.constant.constant_type #=> String, one of "SINGULAR", "RANGE", "COLLECTIVE"
resp.topic.data_sets[0].filters[0].relative_date_filter.constant.singular_constant #=> String
resp.topic.data_sets[0].columns #=> Array
resp.topic.data_sets[0].columns[0].column_name #=> String
resp.topic.data_sets[0].columns[0].column_friendly_name #=> String
resp.topic.data_sets[0].columns[0].column_description #=> String
resp.topic.data_sets[0].columns[0].column_synonyms #=> Array
resp.topic.data_sets[0].columns[0].column_synonyms[0] #=> String
resp.topic.data_sets[0].columns[0].column_data_role #=> String, one of "DIMENSION", "MEASURE"
resp.topic.data_sets[0].columns[0].aggregation #=> String, one of "SUM", "MAX", "MIN", "COUNT", "DISTINCT_COUNT", "AVERAGE", "MEDIAN", "STDEV", "STDEVP", "VAR", "VARP"
resp.topic.data_sets[0].columns[0].is_included_in_topic #=> Boolean
resp.topic.data_sets[0].columns[0].disable_indexing #=> Boolean
resp.topic.data_sets[0].columns[0].comparative_order.use_ordering #=> String, one of "GREATER_IS_BETTER", "LESSER_IS_BETTER", "SPECIFIED"
resp.topic.data_sets[0].columns[0].comparative_order.specifed_order #=> Array
resp.topic.data_sets[0].columns[0].comparative_order.specifed_order[0] #=> String
resp.topic.data_sets[0].columns[0].comparative_order.treat_undefined_specified_values #=> String, one of "LEAST", "MOST"
resp.topic.data_sets[0].columns[0].semantic_type.type_name #=> String
resp.topic.data_sets[0].columns[0].semantic_type.sub_type_name #=> String
resp.topic.data_sets[0].columns[0].semantic_type.type_parameters #=> Hash
resp.topic.data_sets[0].columns[0].semantic_type.type_parameters["LimitedString"] #=> String
resp.topic.data_sets[0].columns[0].semantic_type.truthy_cell_value #=> String
resp.topic.data_sets[0].columns[0].semantic_type.truthy_cell_value_synonyms #=> Array
resp.topic.data_sets[0].columns[0].semantic_type.truthy_cell_value_synonyms[0] #=> String
resp.topic.data_sets[0].columns[0].semantic_type.falsey_cell_value #=> String
resp.topic.data_sets[0].columns[0].semantic_type.falsey_cell_value_synonyms #=> Array
resp.topic.data_sets[0].columns[0].semantic_type.falsey_cell_value_synonyms[0] #=> String
resp.topic.data_sets[0].columns[0].time_granularity #=> String, one of "SECOND", "MINUTE", "HOUR", "DAY", "WEEK", "MONTH", "QUARTER", "YEAR"
resp.topic.data_sets[0].columns[0].allowed_aggregations #=> Array
resp.topic.data_sets[0].columns[0].allowed_aggregations[0] #=> String, one of "COUNT", "DISTINCT_COUNT", "MIN", "MAX", "MEDIAN", "SUM", "AVERAGE", "STDEV", "STDEVP", "VAR", "VARP", "PERCENTILE"
resp.topic.data_sets[0].columns[0].not_allowed_aggregations #=> Array
resp.topic.data_sets[0].columns[0].not_allowed_aggregations[0] #=> String, one of "COUNT", "DISTINCT_COUNT", "MIN", "MAX", "MEDIAN", "SUM", "AVERAGE", "STDEV", "STDEVP", "VAR", "VARP", "PERCENTILE"
resp.topic.data_sets[0].columns[0].default_formatting.display_format #=> String, one of "AUTO", "PERCENT", "CURRENCY", "NUMBER", "DATE", "STRING"
resp.topic.data_sets[0].columns[0].default_formatting.display_format_options.use_blank_cell_format #=> Boolean
resp.topic.data_sets[0].columns[0].default_formatting.display_format_options.blank_cell_format #=> String
resp.topic.data_sets[0].columns[0].default_formatting.display_format_options.date_format #=> String
resp.topic.data_sets[0].columns[0].default_formatting.display_format_options.decimal_separator #=> String, one of "COMMA", "DOT"
resp.topic.data_sets[0].columns[0].default_formatting.display_format_options.grouping_separator #=> String
resp.topic.data_sets[0].columns[0].default_formatting.display_format_options.use_grouping #=> Boolean
resp.topic.data_sets[0].columns[0].default_formatting.display_format_options.fraction_digits #=> Integer
resp.topic.data_sets[0].columns[0].default_formatting.display_format_options.prefix #=> String
resp.topic.data_sets[0].columns[0].default_formatting.display_format_options.suffix #=> String
resp.topic.data_sets[0].columns[0].default_formatting.display_format_options.unit_scaler #=> String, one of "NONE", "AUTO", "THOUSANDS", "MILLIONS", "BILLIONS", "TRILLIONS"
resp.topic.data_sets[0].columns[0].default_formatting.display_format_options.negative_format.prefix #=> String
resp.topic.data_sets[0].columns[0].default_formatting.display_format_options.negative_format.suffix #=> String
resp.topic.data_sets[0].columns[0].default_formatting.display_format_options.currency_symbol #=> String
resp.topic.data_sets[0].columns[0].never_aggregate_in_filter #=> Boolean
resp.topic.data_sets[0].columns[0].cell_value_synonyms #=> Array
resp.topic.data_sets[0].columns[0].cell_value_synonyms[0].cell_value #=> String
resp.topic.data_sets[0].columns[0].cell_value_synonyms[0].synonyms #=> Array
resp.topic.data_sets[0].columns[0].cell_value_synonyms[0].synonyms[0] #=> String
resp.topic.data_sets[0].columns[0].non_additive #=> Boolean
resp.topic.data_sets[0].calculated_fields #=> Array
resp.topic.data_sets[0].calculated_fields[0].calculated_field_name #=> String
resp.topic.data_sets[0].calculated_fields[0].calculated_field_description #=> String
resp.topic.data_sets[0].calculated_fields[0].expression #=> String
resp.topic.data_sets[0].calculated_fields[0].calculated_field_synonyms #=> Array
resp.topic.data_sets[0].calculated_fields[0].calculated_field_synonyms[0] #=> String
resp.topic.data_sets[0].calculated_fields[0].is_included_in_topic #=> Boolean
resp.topic.data_sets[0].calculated_fields[0].disable_indexing #=> Boolean
resp.topic.data_sets[0].calculated_fields[0].column_data_role #=> String, one of "DIMENSION", "MEASURE"
resp.topic.data_sets[0].calculated_fields[0].time_granularity #=> String, one of "SECOND", "MINUTE", "HOUR", "DAY", "WEEK", "MONTH", "QUARTER", "YEAR"
resp.topic.data_sets[0].calculated_fields[0].default_formatting.display_format #=> String, one of "AUTO", "PERCENT", "CURRENCY", "NUMBER", "DATE", "STRING"
resp.topic.data_sets[0].calculated_fields[0].default_formatting.display_format_options.use_blank_cell_format #=> Boolean
resp.topic.data_sets[0].calculated_fields[0].default_formatting.display_format_options.blank_cell_format #=> String
resp.topic.data_sets[0].calculated_fields[0].default_formatting.display_format_options.date_format #=> String
resp.topic.data_sets[0].calculated_fields[0].default_formatting.display_format_options.decimal_separator #=> String, one of "COMMA", "DOT"
resp.topic.data_sets[0].calculated_fields[0].default_formatting.display_format_options.grouping_separator #=> String
resp.topic.data_sets[0].calculated_fields[0].default_formatting.display_format_options.use_grouping #=> Boolean
resp.topic.data_sets[0].calculated_fields[0].default_formatting.display_format_options.fraction_digits #=> Integer
resp.topic.data_sets[0].calculated_fields[0].default_formatting.display_format_options.prefix #=> String
resp.topic.data_sets[0].calculated_fields[0].default_formatting.display_format_options.suffix #=> String
resp.topic.data_sets[0].calculated_fields[0].default_formatting.display_format_options.unit_scaler #=> String, one of "NONE", "AUTO", "THOUSANDS", "MILLIONS", "BILLIONS", "TRILLIONS"
resp.topic.data_sets[0].calculated_fields[0].default_formatting.display_format_options.negative_format.prefix #=> String
resp.topic.data_sets[0].calculated_fields[0].default_formatting.display_format_options.negative_format.suffix #=> String
resp.topic.data_sets[0].calculated_fields[0].default_formatting.display_format_options.currency_symbol #=> String
resp.topic.data_sets[0].calculated_fields[0].aggregation #=> String, one of "SUM", "MAX", "MIN", "COUNT", "DISTINCT_COUNT", "AVERAGE", "MEDIAN", "STDEV", "STDEVP", "VAR", "VARP"
resp.topic.data_sets[0].calculated_fields[0].comparative_order.use_ordering #=> String, one of "GREATER_IS_BETTER", "LESSER_IS_BETTER", "SPECIFIED"
resp.topic.data_sets[0].calculated_fields[0].comparative_order.specifed_order #=> Array
resp.topic.data_sets[0].calculated_fields[0].comparative_order.specifed_order[0] #=> String
resp.topic.data_sets[0].calculated_fields[0].comparative_order.treat_undefined_specified_values #=> String, one of "LEAST", "MOST"
resp.topic.data_sets[0].calculated_fields[0].semantic_type.type_name #=> String
resp.topic.data_sets[0].calculated_fields[0].semantic_type.sub_type_name #=> String
resp.topic.data_sets[0].calculated_fields[0].semantic_type.type_parameters #=> Hash
resp.topic.data_sets[0].calculated_fields[0].semantic_type.type_parameters["LimitedString"] #=> String
resp.topic.data_sets[0].calculated_fields[0].semantic_type.truthy_cell_value #=> String
resp.topic.data_sets[0].calculated_fields[0].semantic_type.truthy_cell_value_synonyms #=> Array
resp.topic.data_sets[0].calculated_fields[0].semantic_type.truthy_cell_value_synonyms[0] #=> String
resp.topic.data_sets[0].calculated_fields[0].semantic_type.falsey_cell_value #=> String
resp.topic.data_sets[0].calculated_fields[0].semantic_type.falsey_cell_value_synonyms #=> Array
resp.topic.data_sets[0].calculated_fields[0].semantic_type.falsey_cell_value_synonyms[0] #=> String
resp.topic.data_sets[0].calculated_fields[0].allowed_aggregations #=> Array
resp.topic.data_sets[0].calculated_fields[0].allowed_aggregations[0] #=> String, one of "COUNT", "DISTINCT_COUNT", "MIN", "MAX", "MEDIAN", "SUM", "AVERAGE", "STDEV", "STDEVP", "VAR", "VARP", "PERCENTILE"
resp.topic.data_sets[0].calculated_fields[0].not_allowed_aggregations #=> Array
resp.topic.data_sets[0].calculated_fields[0].not_allowed_aggregations[0] #=> String, one of "COUNT", "DISTINCT_COUNT", "MIN", "MAX", "MEDIAN", "SUM", "AVERAGE", "STDEV", "STDEVP", "VAR", "VARP", "PERCENTILE"
resp.topic.data_sets[0].calculated_fields[0].never_aggregate_in_filter #=> Boolean
resp.topic.data_sets[0].calculated_fields[0].cell_value_synonyms #=> Array
resp.topic.data_sets[0].calculated_fields[0].cell_value_synonyms[0].cell_value #=> String
resp.topic.data_sets[0].calculated_fields[0].cell_value_synonyms[0].synonyms #=> Array
resp.topic.data_sets[0].calculated_fields[0].cell_value_synonyms[0].synonyms[0] #=> String
resp.topic.data_sets[0].calculated_fields[0].non_additive #=> Boolean
resp.topic.data_sets[0].named_entities #=> Array
resp.topic.data_sets[0].named_entities[0].entity_name #=> String
resp.topic.data_sets[0].named_entities[0].entity_description #=> String
resp.topic.data_sets[0].named_entities[0].entity_synonyms #=> Array
resp.topic.data_sets[0].named_entities[0].entity_synonyms[0] #=> String
resp.topic.data_sets[0].named_entities[0].semantic_entity_type.type_name #=> String
resp.topic.data_sets[0].named_entities[0].semantic_entity_type.sub_type_name #=> String
resp.topic.data_sets[0].named_entities[0].semantic_entity_type.type_parameters #=> Hash
resp.topic.data_sets[0].named_entities[0].semantic_entity_type.type_parameters["LimitedString"] #=> String
resp.topic.data_sets[0].named_entities[0].definition #=> Array
resp.topic.data_sets[0].named_entities[0].definition[0].field_name #=> String
resp.topic.data_sets[0].named_entities[0].definition[0].property_name #=> String
resp.topic.data_sets[0].named_entities[0].definition[0].property_role #=> String, one of "PRIMARY", "ID"
resp.topic.data_sets[0].named_entities[0].definition[0].property_usage #=> String, one of "INHERIT", "DIMENSION", "MEASURE"
resp.topic.data_sets[0].named_entities[0].definition[0].metric.aggregation #=> String, one of "SUM", "MIN", "MAX", "COUNT", "AVERAGE", "DISTINCT_COUNT", "STDEV", "STDEVP", "VAR", "VARP", "PERCENTILE", "MEDIAN", "CUSTOM"
resp.topic.data_sets[0].named_entities[0].definition[0].metric.aggregation_function_parameters #=> Hash
resp.topic.data_sets[0].named_entities[0].definition[0].metric.aggregation_function_parameters["LimitedString"] #=> String
resp.request_id #=> String
resp.status #=> Integer

Parameters:

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

    ({})

Options Hash (params):

  • :aws_account_id (required, String) —

    The Amazon Web Services account ID.

  • :topic_id (required, String) —

    The ID of the topic that you want to describe. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

Returns:

See Also:



7753
7754
7755
7756
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 7753

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

#describe_topic_permissions(params = {}) ⇒ Types::DescribeTopicPermissionsResponse

Describes the permissions of a topic.

Examples:

Request syntax with placeholder values


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

Response structure


resp.topic_id #=> String
resp.topic_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 Amazon Web Services account that contains the topic that you want described.

  • :topic_id (required, String) —

    The ID of the topic that you want to describe. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

Returns:

See Also:



7798
7799
7800
7801
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 7798

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

#describe_topic_refresh(params = {}) ⇒ Types::DescribeTopicRefreshResponse

Describes the status of a topic refresh.

Examples:

Request syntax with placeholder values


resp = client.describe_topic_refresh({
  aws_account_id: "AwsAccountId", # required
  topic_id: "TopicId", # required
  refresh_id: "ResourceId", # required
})

Response structure


resp.refresh_details.refresh_arn #=> String
resp.refresh_details.refresh_id #=> String
resp.refresh_details.refresh_status #=> String, one of "INITIALIZED", "RUNNING", "FAILED", "COMPLETED", "CANCELLED"
resp.request_id #=> String
resp.status #=> Integer

Parameters:

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

    ({})

Options Hash (params):

  • :aws_account_id (required, String) —

    The ID of the Amazon Web Services account that contains the topic whose refresh you want to describe.

  • :topic_id (required, String) —

    The ID of the topic that you want to describe. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

  • :refresh_id (required, String) —

    The ID of the refresh, which is performed when the topic is created or updated.

Returns:

See Also:



7843
7844
7845
7846
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 7843

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

#describe_topic_refresh_schedule(params = {}) ⇒ Types::DescribeTopicRefreshScheduleResponse

Deletes a topic refresh schedule.

Examples:

Request syntax with placeholder values


resp = client.describe_topic_refresh_schedule({
  aws_account_id: "AwsAccountId", # required
  topic_id: "TopicId", # required
  dataset_id: "String", # required
})

Response structure


resp.topic_id #=> String
resp.topic_arn #=> String
resp.dataset_arn #=> String
resp.refresh_schedule.is_enabled #=> Boolean
resp.refresh_schedule.based_on_spice_schedule #=> Boolean
resp.refresh_schedule.starting_at #=> Time
resp.refresh_schedule.timezone #=> String
resp.refresh_schedule.repeat_at #=> String
resp.refresh_schedule.topic_schedule_type #=> String, one of "HOURLY", "DAILY", "WEEKLY", "MONTHLY"
resp.status #=> Integer
resp.request_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :aws_account_id (required, String) —

    The Amazon Web Services account ID.

  • :topic_id (required, String) —

    The ID of the topic that contains the refresh schedule that you want to describe. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

  • :dataset_id (required, String) —

    The ID of the dataset.

Returns:

See Also:



7896
7897
7898
7899
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 7896

def describe_topic_refresh_schedule(params = {}, options = {})
  req = build_request(:describe_topic_refresh_schedule, 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", "ADMIN_PRO", "AUTHOR_PRO", "READER_PRO"
resp.user.identity_type #=> String, one of "IAM", "QUICKSIGHT", "IAM_IDENTITY_CENTER"
resp.user.active #=> Boolean
resp.user.principal_id #=> String
resp.user.custom_permissions_name #=> String
resp.user. #=> String
resp.user. #=> String
resp.user. #=> 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 Amazon Web Services account that the user is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon QuickSight account.

  • :namespace (required, String) —

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

Returns:

See Also:



7948
7949
7950
7951
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 7948

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

#describe_vpc_connection(params = {}) ⇒ Types::DescribeVPCConnectionResponse

Describes a VPC connection.

Examples:

Request syntax with placeholder values


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

Response structure


resp.vpc_connection.vpc_connection_id #=> String
resp.vpc_connection.arn #=> String
resp.vpc_connection.name #=> String
resp.vpc_connection.vpc_id #=> String
resp.vpc_connection.security_group_ids #=> Array
resp.vpc_connection.security_group_ids[0] #=> String
resp.vpc_connection.dns_resolvers #=> Array
resp.vpc_connection.dns_resolvers[0] #=> String
resp.vpc_connection.status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED", "DELETION_IN_PROGRESS", "DELETION_FAILED", "DELETED"
resp.vpc_connection.availability_status #=> String, one of "AVAILABLE", "UNAVAILABLE", "PARTIALLY_AVAILABLE"
resp.vpc_connection.network_interfaces #=> Array
resp.vpc_connection.network_interfaces[0].subnet_id #=> String
resp.vpc_connection.network_interfaces[0].availability_zone #=> String
resp.vpc_connection.network_interfaces[0].error_message #=> String
resp.vpc_connection.network_interfaces[0].status #=> String, one of "CREATING", "AVAILABLE", "CREATION_FAILED", "UPDATING", "UPDATE_FAILED", "DELETING", "DELETED", "DELETION_FAILED", "DELETION_SCHEDULED", "ATTACHMENT_FAILED_ROLLBACK_FAILED"
resp.vpc_connection.network_interfaces[0].network_interface_id #=> String
resp.vpc_connection.role_arn #=> String
resp.vpc_connection.created_time #=> Time
resp.vpc_connection.last_updated_time #=> Time
resp.request_id #=> String
resp.status #=> Integer

Parameters:

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

    ({})

Options Hash (params):

  • :aws_account_id (required, String) —

    The Amazon Web Services account ID of the account that contains the VPC connection that you want described.

  • :vpc_connection_id (required, String) —

    The ID of the VPC connection that you're creating. This ID is a unique identifier for each Amazon Web Services Region in an Amazon Web Services account.

Returns:

See Also:



8005
8006
8007
8008
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 8005

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

#generate_embed_url_for_anonymous_user(params = {}) ⇒ Types::GenerateEmbedUrlForAnonymousUserResponse

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

The following rules apply to the generated URL:

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

  • The URL validity period should not be confused with the actual session lifetime that can be customized using the SessionLifetimeInMinutes parameter. The resulting user session is valid for 15 minutes (minimum) to 10 hours (maximum). The default session duration is 10 hours.

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

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

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

Examples:

Request syntax with placeholder values


resp = client.generate_embed_url_for_anonymous_user({
  aws_account_id: "AwsAccountId", # required
  session_lifetime_in_minutes: 1,
  namespace: "Namespace", # required
  session_tags: [
    {
      key: "SessionTagKey", # required
      value: "SessionTagValue", # required
    },
  ],
  authorized_resource_arns: ["Arn"], # required
  experience_configuration: { # required
    dashboard: {
      initial_dashboard_id: "ShortRestrictiveResourceId", # required
      enabled_features: ["SHARED_VIEW"], # accepts SHARED_VIEW
      disabled_features: ["SHARED_VIEW"], # accepts SHARED_VIEW
      feature_configurations: {
        shared_view: {
          enabled: false, # required
        },
      },
    },
    dashboard_visual: {
      initial_dashboard_visual_id: { # required
        dashboard_id: "ShortRestrictiveResourceId", # required
        sheet_id: "ShortRestrictiveResourceId", # required
        visual_id: "ShortRestrictiveResourceId", # required
      },
    },
    q_search_bar: {
      initial_topic_id: "RestrictiveResourceId", # required
    },
    generative_qn_a: {
      initial_topic_id: "RestrictiveResourceId", # required
    },
  },
  allowed_domains: ["String"],
})

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :aws_account_id (required, String) —

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

  • :session_lifetime_in_minutes (Integer) —

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

  • :namespace (required, String) —

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

  • :session_tags (Array<Types::SessionTag>) —

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

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

  • :authorized_resource_arns (required, Array<String>) —

    The Amazon Resource Names (ARNs) for the Amazon QuickSight resources that the user is authorized to access during the lifetime of the session.

    If you choose Dashboard embedding experience, pass the list of dashboard ARNs in the account that you want the user to be able to view.

    If you want to make changes to the theme of your embedded content, pass a list of theme ARNs that the anonymous users need access to.

    Currently, you can pass up to 25 theme ARNs in each API call.

  • :experience_configuration (required, Types::AnonymousUserEmbeddingExperienceConfiguration) —

    The configuration of the experience that you are embedding.

  • :allowed_domains (Array<String>) —

    The domains that you want to add to the allow list for access to the generated URL that is then embedded. This optional parameter overrides the static domains that are configured in the Manage QuickSight menu in the Amazon QuickSight console. Instead, it allows only the domains that you include in this parameter. You can list up to three domains or subdomains in each API call.

    To include all subdomains under a specific domain to the allow list, use *. For example, https://*.sapp.amazon.com includes all subdomains under https://sapp.amazon.com.

Returns:

See Also:



8157
8158
8159
8160
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 8157

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

#generate_embed_url_for_registered_user(params = {}) ⇒ Types::GenerateEmbedUrlForRegisteredUserResponse

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

The following rules apply to the generated URL:

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

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

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

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

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

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

Examples:

Request syntax with placeholder values


resp = client.generate_embed_url_for_registered_user({
  aws_account_id: "AwsAccountId", # required
  session_lifetime_in_minutes: 1,
  user_arn: "Arn", # required
  experience_configuration: { # required
    dashboard: {
      initial_dashboard_id: "ShortRestrictiveResourceId", # required
      feature_configurations: {
        state_persistence: {
          enabled: false, # required
        },
        shared_view: {
          enabled: false, # required
        },
        bookmarks: {
          enabled: false, # required
        },
      },
    },
    quick_sight_console: {
      initial_path: "EntryPath",
      feature_configurations: {
        state_persistence: {
          enabled: false, # required
        },
        shared_view: {
          enabled: false, # required
        },
      },
    },
    q_search_bar: {
      initial_topic_id: "RestrictiveResourceId",
    },
    dashboard_visual: {
      initial_dashboard_visual_id: { # required
        dashboard_id: "ShortRestrictiveResourceId", # required
        sheet_id: "ShortRestrictiveResourceId", # required
        visual_id: "ShortRestrictiveResourceId", # required
      },
    },
    generative_qn_a: {
      initial_topic_id: "RestrictiveResourceId",
    },
  },
  allowed_domains: ["String"],
})

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 Amazon Web Services account that contains the dashboard that you're embedding.

  • :session_lifetime_in_minutes (Integer) —

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

  • :user_arn (required, String) —

    The Amazon Resource Name for the registered user.

  • :experience_configuration (required, Types::RegisteredUserEmbeddingExperienceConfiguration) —

    The experience that you want to embed. For registered users, you can embed Amazon QuickSight dashboards, Amazon QuickSight visuals, the Amazon QuickSight Q search bar, the Amazon QuickSight Generative Q&A experience, or the entire Amazon QuickSight console.

  • :allowed_domains (Array<String>) —

    The domains that you want to add to the allow list for access to the generated URL that is then embedded. This optional parameter overrides the static domains that are configured in the Manage QuickSight menu in the Amazon QuickSight console. Instead, it allows only the domains that you include in this parameter. You can list up to three domains or subdomains in each API call.

    To include all subdomains under a specific domain to the allow list, use *. For example, https://*.sapp.amazon.com includes all subdomains under https://sapp.amazon.com.

Returns:

See Also:



8290
8291
8292
8293
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 8290

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

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

Generates a temporary session URL and authorization code(bearer token) that you can use to embed an Amazon QuickSight read-only dashboard in your website or application. 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 generated URL:

  • They must be used together.

  • They can be used one time only.

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

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

  • The resulting user session is valid for 15 minutes (default) up to 10 hours (maximum). You can use the optional SessionLifetimeInMinutes parameter to customize session duration.

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

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

Examples:

Request syntax with placeholder values


resp = client.get_dashboard_embed_url({
  aws_account_id: "AwsAccountId", # required
  dashboard_id: "ShortRestrictiveResourceId", # required
  identity_type: "IAM", # required, accepts IAM, QUICKSIGHT, ANONYMOUS
  session_lifetime_in_minutes: 1,
  undo_redo_disabled: false,
  reset_disabled: false,
  state_persistence_enabled: false,
  user_arn: "Arn",
  namespace: "Namespace",
  additional_dashboard_ids: ["ShortRestrictiveResourceId"],
})

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 Amazon Web Services account that contains the dashboard that you're embedding.

  • :dashboard_id (required, String) —

    The ID for the dashboard, also added to the Identity and Access Management (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.

  • :state_persistence_enabled (Boolean) —

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

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

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

  • :namespace (String) —

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

  • :additional_dashboard_ids (Array<String>) —

    A list of one or more dashboard IDs that you want anonymous users to have tempporary access to. Currently, the IdentityType parameter must be set to ANONYMOUS because other identity types authenticate as Amazon QuickSight or IAM users. For example, if you set "--dashboard-id dash_id1 --dashboard-id dash_id2 dash_id3 identity-type ANONYMOUS", the session can access all three dashboards.

Returns:

See Also:



8424
8425
8426
8427
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 8424

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

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 Amazon Web Services account associated with your Amazon QuickSight subscription.

  • :entry_point (String) —

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

    • /start

    • /start/analyses

    • /start/dashboards

    • /start/favorites

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

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

  • :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 type of Amazon QuickSight users in your account (readers, authors, or admins). They need to be authenticated as one of the following:

    1. Active Directory (AD) users or group members

    2. Invited nonfederated users

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

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

Returns:

See Also:



8518
8519
8520
8521
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 8518

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

#list_analyses(params = {}) ⇒ Types::ListAnalysesResponse

Lists Amazon QuickSight analyses that exist in the specified Amazon Web Services 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_analyses({
  aws_account_id: "AwsAccountId", # required
  next_token: "String",
  max_results: 1,
})

Response structure


resp.analysis_summary_list #=> Array
resp.analysis_summary_list[0].arn #=> String
resp.analysis_summary_list[0].analysis_id #=> String
resp.analysis_summary_list[0].name #=> String
resp.analysis_summary_list[0].status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED", "DELETED"
resp.analysis_summary_list[0].created_time #=> Time
resp.analysis_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 Amazon Web Services account that contains the analyses.

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



8569
8570
8571
8572
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 8569

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

#list_asset_bundle_export_jobs(params = {}) ⇒ Types::ListAssetBundleExportJobsResponse

Lists all asset bundle export jobs that have been taken place in the last 14 days. Jobs created more than 14 days ago are deleted forever and are not returned. If you are using the same job ID for multiple jobs, ListAssetBundleExportJobs only returns the most recent job that uses the repeated job ID.

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_asset_bundle_export_jobs({
  aws_account_id: "AwsAccountId", # required
  next_token: "String",
  max_results: 1,
})

Response structure


resp.asset_bundle_export_job_summary_list #=> Array
resp.asset_bundle_export_job_summary_list[0].job_status #=> String, one of "QUEUED_FOR_IMMEDIATE_EXECUTION", "IN_PROGRESS", "SUCCESSFUL", "FAILED"
resp.asset_bundle_export_job_summary_list[0].arn #=> String
resp.asset_bundle_export_job_summary_list[0].created_time #=> Time
resp.asset_bundle_export_job_summary_list[0].asset_bundle_export_job_id #=> String
resp.asset_bundle_export_job_summary_list[0].include_all_dependencies #=> Boolean
resp.asset_bundle_export_job_summary_list[0].export_format #=> String, one of "CLOUDFORMATION_JSON", "QUICKSIGHT_JSON"
resp.asset_bundle_export_job_summary_list[0].include_permissions #=> Boolean
resp.asset_bundle_export_job_summary_list[0].include_tags #=> Boolean
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 Amazon Web Services account that the export jobs were executed in.

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



8627
8628
8629
8630
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 8627

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

#list_asset_bundle_import_jobs(params = {}) ⇒ Types::ListAssetBundleImportJobsResponse

Lists all asset bundle import jobs that have taken place in the last 14 days. Jobs created more than 14 days ago are deleted forever and are not returned. If you are using the same job ID for multiple jobs, ListAssetBundleImportJobs only returns the most recent job that uses the repeated job ID.

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_asset_bundle_import_jobs({
  aws_account_id: "AwsAccountId", # required
  next_token: "String",
  max_results: 1,
})

Response structure


resp.asset_bundle_import_job_summary_list #=> Array
resp.asset_bundle_import_job_summary_list[0].job_status #=> String, one of "QUEUED_FOR_IMMEDIATE_EXECUTION", "IN_PROGRESS", "SUCCESSFUL", "FAILED", "FAILED_ROLLBACK_IN_PROGRESS", "FAILED_ROLLBACK_COMPLETED", "FAILED_ROLLBACK_ERROR"
resp.asset_bundle_import_job_summary_list[0].arn #=> String
resp.asset_bundle_import_job_summary_list[0].created_time #=> Time
resp.asset_bundle_import_job_summary_list[0].asset_bundle_import_job_id #=> String
resp.asset_bundle_import_job_summary_list[0].failure_action #=> String, one of "DO_NOTHING", "ROLLBACK"
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 Amazon Web Services account that the import jobs were executed in.

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



8682
8683
8684
8685
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 8682

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

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

Lists all the versions of the dashboards in the Amazon 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: "ShortRestrictiveResourceId", # 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", "DELETED"
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 Amazon Web Services 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:



8739
8740
8741
8742
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 8739

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



8792
8793
8794
8795
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 8792

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 Amazon Web Services account in an Amazon Web Services 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.data_set_summaries[0].row_level_permission_data_set.format_version #=> String, one of "VERSION_1", "VERSION_2"
resp.data_set_summaries[0].row_level_permission_data_set.status #=> String, one of "ENABLED", "DISABLED"
resp.data_set_summaries[0].row_level_permission_tag_configuration_applied #=> Boolean
resp.data_set_summaries[0].column_level_permission_rules_applied #=> Boolean
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 Amazon Web Services 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:



8854
8855
8856
8857
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 8854

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 Amazon Web Services Region that belong to this Amazon Web Services 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", "ORACLE", "POSTGRESQL", "PRESTO", "REDSHIFT", "S3", "SALESFORCE", "SERVICENOW", "SNOWFLAKE", "SPARK", "SQLSERVER", "TERADATA", "TWITTER", "TIMESTREAM", "AMAZON_OPENSEARCH", "EXASOL", "DATABRICKS", "STARBURST", "TRINO", "BIGQUERY"
resp.data_sources[0].status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED", "DELETED"
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.athena_parameters.role_arn #=> 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.oracle_parameters.host #=> String
resp.data_sources[0].data_source_parameters.oracle_parameters.port #=> Integer
resp.data_sources[0].data_source_parameters.oracle_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.redshift_parameters.iam_parameters.role_arn #=> String
resp.data_sources[0].data_source_parameters.redshift_parameters.iam_parameters.database_user #=> String
resp.data_sources[0].data_source_parameters.redshift_parameters.iam_parameters.database_groups #=> Array
resp.data_sources[0].data_source_parameters.redshift_parameters.iam_parameters.database_groups[0] #=> String
resp.data_sources[0].data_source_parameters.redshift_parameters.iam_parameters.auto_create_database_user #=> Boolean
resp.data_sources[0].data_source_parameters.redshift_parameters.identity_center_configuration.enable_identity_propagation #=> Boolean
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.s3_parameters.role_arn #=> 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].data_source_parameters.amazon_open_search_parameters.domain #=> String
resp.data_sources[0].data_source_parameters.exasol_parameters.host #=> String
resp.data_sources[0].data_source_parameters.exasol_parameters.port #=> Integer
resp.data_sources[0].data_source_parameters.databricks_parameters.host #=> String
resp.data_sources[0].data_source_parameters.databricks_parameters.port #=> Integer
resp.data_sources[0].data_source_parameters.databricks_parameters.sql_endpoint_path #=> String
resp.data_sources[0].data_source_parameters.starburst_parameters.host #=> String
resp.data_sources[0].data_source_parameters.starburst_parameters.port #=> Integer
resp.data_sources[0].data_source_parameters.starburst_parameters.catalog #=> String
resp.data_sources[0].data_source_parameters.starburst_parameters.product_type #=> String, one of "GALAXY", "ENTERPRISE"
resp.data_sources[0].data_source_parameters.trino_parameters.host #=> String
resp.data_sources[0].data_source_parameters.trino_parameters.port #=> Integer
resp.data_sources[0].data_source_parameters.trino_parameters.catalog #=> String
resp.data_sources[0].data_source_parameters.big_query_parameters.project_id #=> String
resp.data_sources[0].data_source_parameters.big_query_parameters.data_set_region #=> String
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].athena_parameters.role_arn #=> 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].oracle_parameters.host #=> String
resp.data_sources[0].alternate_data_source_parameters[0].oracle_parameters.port #=> Integer
resp.data_sources[0].alternate_data_source_parameters[0].oracle_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].redshift_parameters.iam_parameters.role_arn #=> String
resp.data_sources[0].alternate_data_source_parameters[0].redshift_parameters.iam_parameters.database_user #=> String
resp.data_sources[0].alternate_data_source_parameters[0].redshift_parameters.iam_parameters.database_groups #=> Array
resp.data_sources[0].alternate_data_source_parameters[0].redshift_parameters.iam_parameters.database_groups[0] #=> String
resp.data_sources[0].alternate_data_source_parameters[0].redshift_parameters.iam_parameters.auto_create_database_user #=> Boolean
resp.data_sources[0].alternate_data_source_parameters[0].redshift_parameters.identity_center_configuration.enable_identity_propagation #=> Boolean
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].s3_parameters.role_arn #=> 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].alternate_data_source_parameters[0].amazon_open_search_parameters.domain #=> String
resp.data_sources[0].alternate_data_source_parameters[0].exasol_parameters.host #=> String
resp.data_sources[0].alternate_data_source_parameters[0].exasol_parameters.port #=> Integer
resp.data_sources[0].alternate_data_source_parameters[0].databricks_parameters.host #=> String
resp.data_sources[0].alternate_data_source_parameters[0].databricks_parameters.port #=> Integer
resp.data_sources[0].alternate_data_source_parameters[0].databricks_parameters.sql_endpoint_path #=> String
resp.data_sources[0].alternate_data_source_parameters[0].starburst_parameters.host #=> String
resp.data_sources[0].alternate_data_source_parameters[0].starburst_parameters.port #=> Integer
resp.data_sources[0].alternate_data_source_parameters[0].starburst_parameters.catalog #=> String
resp.data_sources[0].alternate_data_source_parameters[0].starburst_parameters.product_type #=> String, one of "GALAXY", "ENTERPRISE"
resp.data_sources[0].alternate_data_source_parameters[0].trino_parameters.host #=> String
resp.data_sources[0].alternate_data_source_parameters[0].trino_parameters.port #=> Integer
resp.data_sources[0].alternate_data_source_parameters[0].trino_parameters.catalog #=> String
resp.data_sources[0].alternate_data_source_parameters[0].big_query_parameters.project_id #=> String
resp.data_sources[0].alternate_data_source_parameters[0].big_query_parameters.data_set_region #=> String
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.data_sources[0].secret_arn #=> 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 Amazon Web Services 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:



9053
9054
9055
9056
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 9053

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

#list_folder_members(params = {}) ⇒ Types::ListFolderMembersResponse

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

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_folder_members({
  aws_account_id: "AwsAccountId", # required
  folder_id: "RestrictiveResourceId", # required
  next_token: "String",
  max_results: 1,
})

Response structure


resp.status #=> Integer
resp.folder_member_list #=> Array
resp.folder_member_list[0].member_id #=> String
resp.folder_member_list[0].member_arn #=> String
resp.next_token #=> String
resp.request_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :aws_account_id (required, String) —

    The ID for the Amazon Web Services account that contains the folder.

  • :folder_id (required, String) —

    The ID of the folder.

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



9104
9105
9106
9107
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 9104

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

#list_folders(params = {}) ⇒ Types::ListFoldersResponse

Lists all folders in an 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_folders({
  aws_account_id: "AwsAccountId", # required
  next_token: "String",
  max_results: 1,
})

Response structure


resp.status #=> Integer
resp.folder_summary_list #=> Array
resp.folder_summary_list[0].arn #=> String
resp.folder_summary_list[0].folder_id #=> String
resp.folder_summary_list[0].name #=> String
resp.folder_summary_list[0].folder_type #=> String, one of "SHARED", "RESTRICTED"
resp.folder_summary_list[0].created_time #=> Time
resp.folder_summary_list[0].last_updated_time #=> Time
resp.folder_summary_list[0].sharing_model #=> String, one of "ACCOUNT", "NAMESPACE"
resp.next_token #=> String
resp.request_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :aws_account_id (required, String) —

    The ID for the Amazon Web Services account that contains the folder.

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



9156
9157
9158
9159
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 9156

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

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

Lists member users in a group.

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

  • :namespace (required, String) —

    The namespace of the group that you want a list of users from.

Returns:

See Also:



9212
9213
9214
9215
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 9212

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.

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

  • :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 that you want a list of groups from.

Returns:

See Also:



9266
9267
9268
9269
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 9266

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

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

Lists the IAM policy assignments 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_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 Amazon Web Services 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:



9323
9324
9325
9326
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 9323

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

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_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 Amazon Web Services 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:



9381
9382
9383
9384
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 9381

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_identity_propagation_configs(params = {}) ⇒ Types::ListIdentityPropagationConfigsResponse

Lists all services and authorized targets that the Amazon QuickSight IAM Identity Center application can access.

This operation is only supported for Amazon QuickSight accounts that use IAM Identity Center.

Examples:

Request syntax with placeholder values


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

Response structure


resp.services #=> Array
resp.services[0].service #=> String, one of "REDSHIFT"
resp.services[0].authorized_targets #=> Array
resp.services[0].authorized_targets[0] #=> 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 Amazon Web Services account that contain the identity propagation configurations of.

  • :max_results (Integer) —

    The maximum number of results to be returned.

  • :next_token (String) —

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

Returns:

See Also:



9432
9433
9434
9435
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 9432

def list_identity_propagation_configs(params = {}, options = {})
  req = build_request(:list_identity_propagation_configs, 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", "REFRESH_SUPPRESSED_BY_EDIT", "PERMISSION_NOT_FOUND", "ELASTICSEARCH_CURSOR_NOT_ENABLED", "CURSOR_NOT_ENABLED", "DUPLICATE_COLUMN_NAMES_FOUND"
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].row_info.total_rows_in_dataset #=> 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 Amazon Web Services account ID.

  • :max_results (Integer) —

    The maximum number of results to be returned per request.

Returns:

See Also:



9496
9497
9498
9499
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 9496

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 Amazon Web Services account. This operation doesn't list deleted namespaces.

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 Amazon Web Services account that contains the Amazon QuickSight namespaces that you want to list.

  • :next_token (String) —

    A unique pagination token that can be used in a subsequent request. You will receive a pagination token in the response body of a previous ListNameSpaces API call if there is more data that can be returned. To receive the data, make another ListNamespaces API call with the returned token to retrieve the next page of data. Each token is valid for 24 hours. If you try to make a ListNamespaces API call with an expired token, you will receive a HTTP 400 InvalidNextTokenException error.

  • :max_results (Integer) —

    The maximum number of results to return.

Returns:

See Also:



9556
9557
9558
9559
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 9556

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

#list_refresh_schedules(params = {}) ⇒ Types::ListRefreshSchedulesResponse

Lists the refresh schedules of a dataset. Each dataset can have up to 5 schedules.

Examples:

Request syntax with placeholder values


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

Response structure


resp.refresh_schedules #=> Array
resp.refresh_schedules[0].schedule_id #=> String
resp.refresh_schedules[0].schedule_frequency.interval #=> String, one of "MINUTE15", "MINUTE30", "HOURLY", "DAILY", "WEEKLY", "MONTHLY"
resp.refresh_schedules[0].schedule_frequency.refresh_on_day.day_of_week #=> String, one of "SUNDAY", "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY"
resp.refresh_schedules[0].schedule_frequency.refresh_on_day.day_of_month #=> String
resp.refresh_schedules[0].schedule_frequency.timezone #=> String
resp.refresh_schedules[0].schedule_frequency.time_of_the_day #=> String
resp.refresh_schedules[0].start_after_date_time #=> Time
resp.refresh_schedules[0].refresh_type #=> String, one of "INCREMENTAL_REFRESH", "FULL_REFRESH"
resp.refresh_schedules[0].arn #=> String
resp.status #=> Integer
resp.request_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :aws_account_id (required, String) —

    The Amazon Web Services account ID.

  • :data_set_id (required, String) —

    The ID of the dataset.

Returns:

See Also:



9602
9603
9604
9605
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 9602

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

#list_role_memberships(params = {}) ⇒ Types::ListRoleMembershipsResponse

Lists all groups that are associated with a role.

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_role_memberships({
  role: "ADMIN", # required, accepts ADMIN, AUTHOR, READER, ADMIN_PRO, AUTHOR_PRO, READER_PRO
  next_token: "String",
  max_results: 1,
  aws_account_id: "AwsAccountId", # required
  namespace: "Namespace", # required
})

Response structure


resp.members_list #=> Array
resp.members_list[0] #=> String
resp.next_token #=> String
resp.request_id #=> String
resp.status #=> Integer

Parameters:

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

    ({})

Options Hash (params):

  • :role (required, String) —

    The name of the role.

  • :next_token (String) —

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

  • :max_results (Integer) —

    The maximum number of results to return.

  • :aws_account_id (required, String) —

    The ID for the Amazon Web Services account that you want to create a group in. The Amazon Web Services account ID that you provide must be the same Amazon Web Services account that contains your Amazon QuickSight account.

  • :namespace (required, String) —

    The namespace that includes the role.

Returns:

See Also:



9658
9659
9660
9661
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 9658

def list_role_memberships(params = {}, options = {})
  req = build_request(:list_role_memberships, 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:



9693
9694
9695
9696
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 9693

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: "ShortRestrictiveResourceId", # 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 Amazon Web Services 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:



9746
9747
9748
9749
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 9746

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: "ShortRestrictiveResourceId", # 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", "DELETED"
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 Amazon Web Services 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:



9802
9803
9804
9805
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 9802

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



9854
9855
9856
9857
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 9854

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: "ShortRestrictiveResourceId", # 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 Amazon Web Services 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:



9905
9906
9907
9908
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 9905

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 Amazon Web Services 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_theme_versions({
  aws_account_id: "AwsAccountId", # required
  theme_id: "ShortRestrictiveResourceId", # 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", "DELETED"
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 Amazon Web Services 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:



9961
9962
9963
9964
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 9961

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

Returns:

See Also:



10026
10027
10028
10029
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 10026

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

#list_topic_refresh_schedules(params = {}) ⇒ Types::ListTopicRefreshSchedulesResponse

Lists all of the refresh schedules for a topic.

Examples:

Request syntax with placeholder values


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

Response structure


resp.topic_id #=> String
resp.topic_arn #=> String
resp.refresh_schedules #=> Array
resp.refresh_schedules[0].dataset_id #=> String
resp.refresh_schedules[0].dataset_arn #=> String
resp.refresh_schedules[0].dataset_name #=> String
resp.refresh_schedules[0].refresh_schedule.is_enabled #=> Boolean
resp.refresh_schedules[0].refresh_schedule.based_on_spice_schedule #=> Boolean
resp.refresh_schedules[0].refresh_schedule.starting_at #=> Time
resp.refresh_schedules[0].refresh_schedule.timezone #=> String
resp.refresh_schedules[0].refresh_schedule.repeat_at #=> String
resp.refresh_schedules[0].refresh_schedule.topic_schedule_type #=> String, one of "HOURLY", "DAILY", "WEEKLY", "MONTHLY"
resp.status #=> Integer
resp.request_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :aws_account_id (required, String) —

    The ID of the Amazon Web Services account that contains the topic whose refresh schedule you want described.

  • :topic_id (required, String) —

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

Returns:

See Also:



10077
10078
10079
10080
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 10077

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

#list_topic_reviewed_answers(params = {}) ⇒ Types::ListTopicReviewedAnswersResponse

Lists all reviewed answers for a Q Topic.

Examples:

Request syntax with placeholder values


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

Response structure


resp.topic_id #=> String
resp.topic_arn #=> String
resp.answers #=> Array
resp.answers[0].arn #=> String
resp.answers[0].answer_id #=> String
resp.answers[0].dataset_arn #=> String
resp.answers[0].question #=> String
resp.answers[0].mir.metrics #=> Array
resp.answers[0].mir.metrics[0].metric_id.identity #=> String
resp.answers[0].mir.metrics[0].function.aggregation #=> String, one of "SUM", "MIN", "MAX", "COUNT", "AVERAGE", "DISTINCT_COUNT", "STDEV", "STDEVP", "VAR", "VARP", "PERCENTILE", "MEDIAN", "PTD_SUM", "PTD_MIN", "PTD_MAX", "PTD_COUNT", "PTD_DISTINCT_COUNT", "PTD_AVERAGE", "COLUMN", "CUSTOM"
resp.answers[0].mir.metrics[0].function.aggregation_function_parameters #=> Hash
resp.answers[0].mir.metrics[0].function.aggregation_function_parameters["AggFunctionParamKey"] #=> String
resp.answers[0].mir.metrics[0].function.period #=> String, one of "SECOND", "MINUTE", "HOUR", "DAY", "WEEK", "MONTH", "QUARTER", "YEAR"
resp.answers[0].mir.metrics[0].function.period_field #=> String
resp.answers[0].mir.metrics[0].operands #=> Array
resp.answers[0].mir.metrics[0].operands[0].identity #=> String
resp.answers[0].mir.metrics[0].comparison_method.type #=> String, one of "DIFF", "PERC_DIFF", "DIFF_AS_PERC", "POP_CURRENT_DIFF_AS_PERC", "POP_CURRENT_DIFF", "POP_OVERTIME_DIFF_AS_PERC", "POP_OVERTIME_DIFF", "PERCENT_OF_TOTAL", "RUNNING_SUM", "MOVING_AVERAGE"
resp.answers[0].mir.metrics[0].comparison_method.period #=> String, one of "SECOND", "MINUTE", "HOUR", "DAY", "WEEK", "MONTH", "QUARTER", "YEAR"
resp.answers[0].mir.metrics[0].comparison_method.window_size #=> Integer
resp.answers[0].mir.metrics[0].expression #=> String
resp.answers[0].mir.metrics[0].calculated_field_references #=> Array
resp.answers[0].mir.metrics[0].calculated_field_references[0].identity #=> String
resp.answers[0].mir.metrics[0].display_format #=> String, one of "AUTO", "PERCENT", "CURRENCY", "NUMBER", "DATE", "STRING"
resp.answers[0].mir.metrics[0].display_format_options.use_blank_cell_format #=> Boolean
resp.answers[0].mir.metrics[0].display_format_options.blank_cell_format #=> String
resp.answers[0].mir.metrics[0].display_format_options.date_format #=> String
resp.answers[0].mir.metrics[0].display_format_options.decimal_separator #=> String, one of "COMMA", "DOT"
resp.answers[0].mir.metrics[0].display_format_options.grouping_separator #=> String
resp.answers[0].mir.metrics[0].display_format_options.use_grouping #=> Boolean
resp.answers[0].mir.metrics[0].display_format_options.fraction_digits #=> Integer
resp.answers[0].mir.metrics[0].display_format_options.prefix #=> String
resp.answers[0].mir.metrics[0].display_format_options.suffix #=> String
resp.answers[0].mir.metrics[0].display_format_options.unit_scaler #=> String, one of "NONE", "AUTO", "THOUSANDS", "MILLIONS", "BILLIONS", "TRILLIONS"
resp.answers[0].mir.metrics[0].display_format_options.negative_format.prefix #=> String
resp.answers[0].mir.metrics[0].display_format_options.negative_format.suffix #=> String
resp.answers[0].mir.metrics[0].display_format_options.currency_symbol #=> String
resp.answers[0].mir.metrics[0].named_entity.named_entity_name #=> String
resp.answers[0].mir.group_by_list #=> Array
resp.answers[0].mir.group_by_list[0].field_name.identity #=> String
resp.answers[0].mir.group_by_list[0].time_granularity #=> String, one of "SECOND", "MINUTE", "HOUR", "DAY", "WEEK", "MONTH", "QUARTER", "YEAR"
resp.answers[0].mir.group_by_list[0].sort.operand.identity #=> String
resp.answers[0].mir.group_by_list[0].sort.sort_direction #=> String, one of "ASCENDING", "DESCENDING"
resp.answers[0].mir.group_by_list[0].display_format #=> String, one of "AUTO", "PERCENT", "CURRENCY", "NUMBER", "DATE", "STRING"
resp.answers[0].mir.group_by_list[0].display_format_options.use_blank_cell_format #=> Boolean
resp.answers[0].mir.group_by_list[0].display_format_options.blank_cell_format #=> String
resp.answers[0].mir.group_by_list[0].display_format_options.date_format #=> String
resp.answers[0].mir.group_by_list[0].display_format_options.decimal_separator #=> String, one of "COMMA", "DOT"
resp.answers[0].mir.group_by_list[0].display_format_options.grouping_separator #=> String
resp.answers[0].mir.group_by_list[0].display_format_options.use_grouping #=> Boolean
resp.answers[0].mir.group_by_list[0].display_format_options.fraction_digits #=> Integer
resp.answers[0].mir.group_by_list[0].display_format_options.prefix #=> String
resp.answers[0].mir.group_by_list[0].display_format_options.suffix #=> String
resp.answers[0].mir.group_by_list[0].display_format_options.unit_scaler #=> String, one of "NONE", "AUTO", "THOUSANDS", "MILLIONS", "BILLIONS", "TRILLIONS"
resp.answers[0].mir.group_by_list[0].display_format_options.negative_format.prefix #=> String
resp.answers[0].mir.group_by_list[0].display_format_options.negative_format.suffix #=> String
resp.answers[0].mir.group_by_list[0].display_format_options.currency_symbol #=> String
resp.answers[0].mir.group_by_list[0].named_entity.named_entity_name #=> String
resp.answers[0].mir.filters #=> Array
resp.answers[0].mir.filters[0] #=> Array
resp.answers[0].mir.filters[0][0].filter_type #=> String, one of "CATEGORY_FILTER", "NUMERIC_EQUALITY_FILTER", "NUMERIC_RANGE_FILTER", "DATE_RANGE_FILTER", "RELATIVE_DATE_FILTER", "TOP_BOTTOM_FILTER", "EQUALS", "RANK_LIMIT_FILTER", "ACCEPT_ALL_FILTER"
resp.answers[0].mir.filters[0][0].filter_class #=> String, one of "ENFORCED_VALUE_FILTER", "CONDITIONAL_VALUE_FILTER", "NAMED_VALUE_FILTER"
resp.answers[0].mir.filters[0][0].operand_field.identity #=> String
resp.answers[0].mir.filters[0][0].function #=> String, one of "CONTAINS", "EXACT", "STARTS_WITH", "ENDS_WITH", "CONTAINS_STRING", "PREVIOUS", "THIS", "LAST", "NEXT", "NOW"
resp.answers[0].mir.filters[0][0].constant.constant_type #=> String, one of "SINGULAR", "RANGE", "COLLECTIVE"
resp.answers[0].mir.filters[0][0].constant.value #=> String
resp.answers[0].mir.filters[0][0].constant.minimum #=> String
resp.answers[0].mir.filters[0][0].constant.maximum #=> String
resp.answers[0].mir.filters[0][0].constant.value_list #=> Array
resp.answers[0].mir.filters[0][0].constant.value_list[0].constant_type #=> String, one of "SINGULAR", "RANGE", "COLLECTIVE"
resp.answers[0].mir.filters[0][0].constant.value_list[0].value #=> String
resp.answers[0].mir.filters[0][0].inverse #=> Boolean
resp.answers[0].mir.filters[0][0].null_filter #=> String, one of "ALL_VALUES", "NON_NULLS_ONLY", "NULLS_ONLY"
resp.answers[0].mir.filters[0][0].aggregation #=> String, one of "SUM", "MIN", "MAX", "COUNT", "AVERAGE", "DISTINCT_COUNT", "STDEV", "STDEVP", "VAR", "VARP", "PERCENTILE", "MEDIAN", "PTD_SUM", "PTD_MIN", "PTD_MAX", "PTD_COUNT", "PTD_DISTINCT_COUNT", "PTD_AVERAGE", "COLUMN", "CUSTOM"
resp.answers[0].mir.filters[0][0].aggregation_function_parameters #=> Hash
resp.answers[0].mir.filters[0][0].aggregation_function_parameters["AggFunctionParamKey"] #=> String
resp.answers[0].mir.filters[0][0].aggregation_partition_by #=> Array
resp.answers[0].mir.filters[0][0].aggregation_partition_by[0].field_name #=> String
resp.answers[0].mir.filters[0][0].aggregation_partition_by[0].time_granularity #=> String, one of "YEAR", "QUARTER", "MONTH", "WEEK", "DAY", "HOUR", "MINUTE", "SECOND", "MILLISECOND"
resp.answers[0].mir.filters[0][0].range.constant_type #=> String, one of "SINGULAR", "RANGE", "COLLECTIVE"
resp.answers[0].mir.filters[0][0].range.value #=> String
resp.answers[0].mir.filters[0][0].range.minimum #=> String
resp.answers[0].mir.filters[0][0].range.maximum #=> String
resp.answers[0].mir.filters[0][0].range.value_list #=> Array
resp.answers[0].mir.filters[0][0].range.value_list[0].constant_type #=> String, one of "SINGULAR", "RANGE", "COLLECTIVE"
resp.answers[0].mir.filters[0][0].range.value_list[0].value #=> String
resp.answers[0].mir.filters[0][0].inclusive #=> Boolean
resp.answers[0].mir.filters[0][0].time_granularity #=> String, one of "YEAR", "QUARTER", "MONTH", "WEEK", "DAY", "HOUR", "MINUTE", "SECOND", "MILLISECOND"
resp.answers[0].mir.filters[0][0].last_next_offset.constant_type #=> String, one of "SINGULAR", "RANGE", "COLLECTIVE"
resp.answers[0].mir.filters[0][0].last_next_offset.value #=> String
resp.answers[0].mir.filters[0][0].last_next_offset.minimum #=> String
resp.answers[0].mir.filters[0][0].last_next_offset.maximum #=> String
resp.answers[0].mir.filters[0][0].last_next_offset.value_list #=> Array
resp.answers[0].mir.filters[0][0].last_next_offset.value_list[0].constant_type #=> String, one of "SINGULAR", "RANGE", "COLLECTIVE"
resp.answers[0].mir.filters[0][0].last_next_offset.value_list[0].value #=> String
resp.answers[0].mir.filters[0][0].agg_metrics #=> Array
resp.answers[0].mir.filters[0][0].agg_metrics[0].metric_operand.identity #=> String
resp.answers[0].mir.filters[0][0].agg_metrics[0].function #=> String, one of "SUM", "MIN", "MAX", "COUNT", "AVERAGE", "DISTINCT_COUNT", "STDEV", "STDEVP", "VAR", "VARP", "PERCENTILE", "MEDIAN", "PTD_SUM", "PTD_MIN", "PTD_MAX", "PTD_COUNT", "PTD_DISTINCT_COUNT", "PTD_AVERAGE", "COLUMN", "CUSTOM"
resp.answers[0].mir.filters[0][0].agg_metrics[0].sort_direction #=> String, one of "ASCENDING", "DESCENDING"
resp.answers[0].mir.filters[0][0].top_bottom_limit.constant_type #=> String, one of "SINGULAR", "RANGE", "COLLECTIVE"
resp.answers[0].mir.filters[0][0].top_bottom_limit.value #=> String
resp.answers[0].mir.filters[0][0].top_bottom_limit.minimum #=> String
resp.answers[0].mir.filters[0][0].top_bottom_limit.maximum #=> String
resp.answers[0].mir.filters[0][0].top_bottom_limit.value_list #=> Array
resp.answers[0].mir.filters[0][0].top_bottom_limit.value_list[0].constant_type #=> String, one of "SINGULAR", "RANGE", "COLLECTIVE"
resp.answers[0].mir.filters[0][0].top_bottom_limit.value_list[0].value #=> String
resp.answers[0].mir.filters[0][0].sort_direction #=> String, one of "ASCENDING", "DESCENDING"
resp.answers[0].mir.filters[0][0].anchor.anchor_type #=> String, one of "TODAY"
resp.answers[0].mir.filters[0][0].anchor.time_granularity #=> String, one of "YEAR", "QUARTER", "MONTH", "WEEK", "DAY", "HOUR", "MINUTE", "SECOND", "MILLISECOND"
resp.answers[0].mir.filters[0][0].anchor.offset #=> Integer
resp.answers[0].mir.sort.operand.identity #=> String
resp.answers[0].mir.sort.sort_direction #=> String, one of "ASCENDING", "DESCENDING"
resp.answers[0].mir.contribution_analysis.factors #=> Array
resp.answers[0].mir.contribution_analysis.factors[0].field_name #=> String
resp.answers[0].mir.contribution_analysis.time_ranges.start_range.filter_type #=> String, one of "CATEGORY_FILTER", "NUMERIC_EQUALITY_FILTER", "NUMERIC_RANGE_FILTER", "DATE_RANGE_FILTER", "RELATIVE_DATE_FILTER", "TOP_BOTTOM_FILTER", "EQUALS", "RANK_LIMIT_FILTER", "ACCEPT_ALL_FILTER"
resp.answers[0].mir.contribution_analysis.time_ranges.start_range.filter_class #=> String, one of "ENFORCED_VALUE_FILTER", "CONDITIONAL_VALUE_FILTER", "NAMED_VALUE_FILTER"
resp.answers[0].mir.contribution_analysis.time_ranges.start_range.operand_field.identity #=> String
resp.answers[0].mir.contribution_analysis.time_ranges.start_range.function #=> String, one of "CONTAINS", "EXACT", "STARTS_WITH", "ENDS_WITH", "CONTAINS_STRING", "PREVIOUS", "THIS", "LAST", "NEXT", "NOW"
resp.answers[0].mir.contribution_analysis.time_ranges.start_range.constant.constant_type #=> String, one of "SINGULAR", "RANGE", "COLLECTIVE"
resp.answers[0].mir.contribution_analysis.time_ranges.start_range.constant.value #=> String
resp.answers[0].mir.contribution_analysis.time_ranges.start_range.constant.minimum #=> String
resp.answers[0].mir.contribution_analysis.time_ranges.start_range.constant.maximum #=> String
resp.answers[0].mir.contribution_analysis.time_ranges.start_range.constant.value_list #=> Array
resp.answers[0].mir.contribution_analysis.time_ranges.start_range.constant.value_list[0].constant_type #=> String, one of "SINGULAR", "RANGE", "COLLECTIVE"
resp.answers[0].mir.contribution_analysis.time_ranges.start_range.constant.value_list[0].value #=> String
resp.answers[0].mir.contribution_analysis.time_ranges.start_range.inverse #=> Boolean
resp.answers[0].mir.contribution_analysis.time_ranges.start_range.null_filter #=> String, one of "ALL_VALUES", "NON_NULLS_ONLY", "NULLS_ONLY"
resp.answers[0].mir.contribution_analysis.time_ranges.start_range.aggregation #=> String, one of "SUM", "MIN", "MAX", "COUNT", "AVERAGE", "DISTINCT_COUNT", "STDEV", "STDEVP", "VAR", "VARP", "PERCENTILE", "MEDIAN", "PTD_SUM", "PTD_MIN", "PTD_MAX", "PTD_COUNT", "PTD_DISTINCT_COUNT", "PTD_AVERAGE", "COLUMN", "CUSTOM"
resp.answers[0].mir.contribution_analysis.time_ranges.start_range.aggregation_function_parameters #=> Hash
resp.answers[0].mir.contribution_analysis.time_ranges.start_range.aggregation_function_parameters["AggFunctionParamKey"] #=> String
resp.answers[0].mir.contribution_analysis.time_ranges.start_range.aggregation_partition_by #=> Array
resp.answers[0].mir.contribution_analysis.time_ranges.start_range.aggregation_partition_by[0].field_name #=> String
resp.answers[0].mir.contribution_analysis.time_ranges.start_range.aggregation_partition_by[0].time_granularity #=> String, one of "YEAR", "QUARTER", "MONTH", "WEEK", "DAY", "HOUR", "MINUTE", "SECOND", "MILLISECOND"
resp.answers[0].mir.contribution_analysis.time_ranges.start_range.range.constant_type #=> String, one of "SINGULAR", "RANGE", "COLLECTIVE"
resp.answers[0].mir.contribution_analysis.time_ranges.start_range.range.value #=> String
resp.answers[0].mir.contribution_analysis.time_ranges.start_range.range.minimum #=> String
resp.answers[0].mir.contribution_analysis.time_ranges.start_range.range.maximum #=> String
resp.answers[0].mir.contribution_analysis.time_ranges.start_range.range.value_list #=> Array
resp.answers[0].mir.contribution_analysis.time_ranges.start_range.range.value_list[0].constant_type #=> String, one of "SINGULAR", "RANGE", "COLLECTIVE"
resp.answers[0].mir.contribution_analysis.time_ranges.start_range.range.value_list[0].value #=> String
resp.answers[0].mir.contribution_analysis.time_ranges.start_range.inclusive #=> Boolean
resp.answers[0].mir.contribution_analysis.time_ranges.start_range.time_granularity #=> String, one of "YEAR", "QUARTER", "MONTH", "WEEK", "DAY", "HOUR", "MINUTE", "SECOND", "MILLISECOND"
resp.answers[0].mir.contribution_analysis.time_ranges.start_range.last_next_offset.constant_type #=> String, one of "SINGULAR", "RANGE", "COLLECTIVE"
resp.answers[0].mir.contribution_analysis.time_ranges.start_range.last_next_offset.value #=> String
resp.answers[0].mir.contribution_analysis.time_ranges.start_range.last_next_offset.minimum #=> String
resp.answers[0].mir.contribution_analysis.time_ranges.start_range.last_next_offset.maximum #=> String
resp.answers[0].mir.contribution_analysis.time_ranges.start_range.last_next_offset.value_list #=> Array
resp.answers[0].mir.contribution_analysis.time_ranges.start_range.last_next_offset.value_list[0].constant_type #=> String, one of "SINGULAR", "RANGE", "COLLECTIVE"
resp.answers[0].mir.contribution_analysis.time_ranges.start_range.last_next_offset.value_list[0].value #=> String
resp.answers[0].mir.contribution_analysis.time_ranges.start_range.agg_metrics #=> Array
resp.answers[0].mir.contribution_analysis.time_ranges.start_range.agg_metrics[0].metric_operand.identity #=> String
resp.answers[0].mir.contribution_analysis.time_ranges.start_range.agg_metrics[0].function #=> String, one of "SUM", "MIN", "MAX", "COUNT", "AVERAGE", "DISTINCT_COUNT", "STDEV", "STDEVP", "VAR", "VARP", "PERCENTILE", "MEDIAN", "PTD_SUM", "PTD_MIN", "PTD_MAX", "PTD_COUNT", "PTD_DISTINCT_COUNT", "PTD_AVERAGE", "COLUMN", "CUSTOM"
resp.answers[0].mir.contribution_analysis.time_ranges.start_range.agg_metrics[0].sort_direction #=> String, one of "ASCENDING", "DESCENDING"
resp.answers[0].mir.contribution_analysis.time_ranges.start_range.top_bottom_limit.constant_type #=> String, one of "SINGULAR", "RANGE", "COLLECTIVE"
resp.answers[0].mir.contribution_analysis.time_ranges.start_range.top_bottom_limit.value #=> String
resp.answers[0].mir.contribution_analysis.time_ranges.start_range.top_bottom_limit.minimum #=> String
resp.answers[0].mir.contribution_analysis.time_ranges.start_range.top_bottom_limit.maximum #=> String
resp.answers[0].mir.contribution_analysis.time_ranges.start_range.top_bottom_limit.value_list #=> Array
resp.answers[0].mir.contribution_analysis.time_ranges.start_range.top_bottom_limit.value_list[0].constant_type #=> String, one of "SINGULAR", "RANGE", "COLLECTIVE"
resp.answers[0].mir.contribution_analysis.time_ranges.start_range.top_bottom_limit.value_list[0].value #=> String
resp.answers[0].mir.contribution_analysis.time_ranges.start_range.sort_direction #=> String, one of "ASCENDING", "DESCENDING"
resp.answers[0].mir.contribution_analysis.time_ranges.start_range.anchor.anchor_type #=> String, one of "TODAY"
resp.answers[0].mir.contribution_analysis.time_ranges.start_range.anchor.time_granularity #=> String, one of "YEAR", "QUARTER", "MONTH", "WEEK", "DAY", "HOUR", "MINUTE", "SECOND", "MILLISECOND"
resp.answers[0].mir.contribution_analysis.time_ranges.start_range.anchor.offset #=> Integer
resp.answers[0].mir.contribution_analysis.time_ranges.end_range.filter_type #=> String, one of "CATEGORY_FILTER", "NUMERIC_EQUALITY_FILTER", "NUMERIC_RANGE_FILTER", "DATE_RANGE_FILTER", "RELATIVE_DATE_FILTER", "TOP_BOTTOM_FILTER", "EQUALS", "RANK_LIMIT_FILTER", "ACCEPT_ALL_FILTER"
resp.answers[0].mir.contribution_analysis.time_ranges.end_range.filter_class #=> String, one of "ENFORCED_VALUE_FILTER", "CONDITIONAL_VALUE_FILTER", "NAMED_VALUE_FILTER"
resp.answers[0].mir.contribution_analysis.time_ranges.end_range.operand_field.identity #=> String
resp.answers[0].mir.contribution_analysis.time_ranges.end_range.function #=> String, one of "CONTAINS", "EXACT", "STARTS_WITH", "ENDS_WITH", "CONTAINS_STRING", "PREVIOUS", "THIS", "LAST", "NEXT", "NOW"
resp.answers[0].mir.contribution_analysis.time_ranges.end_range.constant.constant_type #=> String, one of "SINGULAR", "RANGE", "COLLECTIVE"
resp.answers[0].mir.contribution_analysis.time_ranges.end_range.constant.value #=> String
resp.answers[0].mir.contribution_analysis.time_ranges.end_range.constant.minimum #=> String
resp.answers[0].mir.contribution_analysis.time_ranges.end_range.constant.maximum #=> String
resp.answers[0].mir.contribution_analysis.time_ranges.end_range.constant.value_list #=> Array
resp.answers[0].mir.contribution_analysis.time_ranges.end_range.constant.value_list[0].constant_type #=> String, one of "SINGULAR", "RANGE", "COLLECTIVE"
resp.answers[0].mir.contribution_analysis.time_ranges.end_range.constant.value_list[0].value #=> String
resp.answers[0].mir.contribution_analysis.time_ranges.end_range.inverse #=> Boolean
resp.answers[0].mir.contribution_analysis.time_ranges.end_range.null_filter #=> String, one of "ALL_VALUES", "NON_NULLS_ONLY", "NULLS_ONLY"
resp.answers[0].mir.contribution_analysis.time_ranges.end_range.aggregation #=> String, one of "SUM", "MIN", "MAX", "COUNT", "AVERAGE", "DISTINCT_COUNT", "STDEV", "STDEVP", "VAR", "VARP", "PERCENTILE", "MEDIAN", "PTD_SUM", "PTD_MIN", "PTD_MAX", "PTD_COUNT", "PTD_DISTINCT_COUNT", "PTD_AVERAGE", "COLUMN", "CUSTOM"
resp.answers[0].mir.contribution_analysis.time_ranges.end_range.aggregation_function_parameters #=> Hash
resp.answers[0].mir.contribution_analysis.time_ranges.end_range.aggregation_function_parameters["AggFunctionParamKey"] #=> String
resp.answers[0].mir.contribution_analysis.time_ranges.end_range.aggregation_partition_by #=> Array
resp.answers[0].mir.contribution_analysis.time_ranges.end_range.aggregation_partition_by[0].field_name #=> String
resp.answers[0].mir.contribution_analysis.time_ranges.end_range.aggregation_partition_by[0].time_granularity #=> String, one of "YEAR", "QUARTER", "MONTH", "WEEK", "DAY", "HOUR", "MINUTE", "SECOND", "MILLISECOND"
resp.answers[0].mir.contribution_analysis.time_ranges.end_range.range.constant_type #=> String, one of "SINGULAR", "RANGE", "COLLECTIVE"
resp.answers[0].mir.contribution_analysis.time_ranges.end_range.range.value #=> String
resp.answers[0].mir.contribution_analysis.time_ranges.end_range.range.minimum #=> String
resp.answers[0].mir.contribution_analysis.time_ranges.end_range.range.maximum #=> String
resp.answers[0].mir.contribution_analysis.time_ranges.end_range.range.value_list #=> Array
resp.answers[0].mir.contribution_analysis.time_ranges.end_range.range.value_list[0].constant_type #=> String, one of "SINGULAR", "RANGE", "COLLECTIVE"
resp.answers[0].mir.contribution_analysis.time_ranges.end_range.range.value_list[0].value #=> String
resp.answers[0].mir.contribution_analysis.time_ranges.end_range.inclusive #=> Boolean
resp.answers[0].mir.contribution_analysis.time_ranges.end_range.time_granularity #=> String, one of "YEAR", "QUARTER", "MONTH", "WEEK", "DAY", "HOUR", "MINUTE", "SECOND", "MILLISECOND"
resp.answers[0].mir.contribution_analysis.time_ranges.end_range.last_next_offset.constant_type #=> String, one of "SINGULAR", "RANGE", "COLLECTIVE"
resp.answers[0].mir.contribution_analysis.time_ranges.end_range.last_next_offset.value #=> String
resp.answers[0].mir.contribution_analysis.time_ranges.end_range.last_next_offset.minimum #=> String
resp.answers[0].mir.contribution_analysis.time_ranges.end_range.last_next_offset.maximum #=> String
resp.answers[0].mir.contribution_analysis.time_ranges.end_range.last_next_offset.value_list #=> Array
resp.answers[0].mir.contribution_analysis.time_ranges.end_range.last_next_offset.value_list[0].constant_type #=> String, one of "SINGULAR", "RANGE", "COLLECTIVE"
resp.answers[0].mir.contribution_analysis.time_ranges.end_range.last_next_offset.value_list[0].value #=> String
resp.answers[0].mir.contribution_analysis.time_ranges.end_range.agg_metrics #=> Array
resp.answers[0].mir.contribution_analysis.time_ranges.end_range.agg_metrics[0].metric_operand.identity #=> String
resp.answers[0].mir.contribution_analysis.time_ranges.end_range.agg_metrics[0].function #=> String, one of "SUM", "MIN", "MAX", "COUNT", "AVERAGE", "DISTINCT_COUNT", "STDEV", "STDEVP", "VAR", "VARP", "PERCENTILE", "MEDIAN", "PTD_SUM", "PTD_MIN", "PTD_MAX", "PTD_COUNT", "PTD_DISTINCT_COUNT", "PTD_AVERAGE", "COLUMN", "CUSTOM"
resp.answers[0].mir.contribution_analysis.time_ranges.end_range.agg_metrics[0].sort_direction #=> String, one of "ASCENDING", "DESCENDING"
resp.answers[0].mir.contribution_analysis.time_ranges.end_range.top_bottom_limit.constant_type #=> String, one of "SINGULAR", "RANGE", "COLLECTIVE"
resp.answers[0].mir.contribution_analysis.time_ranges.end_range.top_bottom_limit.value #=> String
resp.answers[0].mir.contribution_analysis.time_ranges.end_range.top_bottom_limit.minimum #=> String
resp.answers[0].mir.contribution_analysis.time_ranges.end_range.top_bottom_limit.maximum #=> String
resp.answers[0].mir.contribution_analysis.time_ranges.end_range.top_bottom_limit.value_list #=> Array
resp.answers[0].mir.contribution_analysis.time_ranges.end_range.top_bottom_limit.value_list[0].constant_type #=> String, one of "SINGULAR", "RANGE", "COLLECTIVE"
resp.answers[0].mir.contribution_analysis.time_ranges.end_range.top_bottom_limit.value_list[0].value #=> String
resp.answers[0].mir.contribution_analysis.time_ranges.end_range.sort_direction #=> String, one of "ASCENDING", "DESCENDING"
resp.answers[0].mir.contribution_analysis.time_ranges.end_range.anchor.anchor_type #=> String, one of "TODAY"
resp.answers[0].mir.contribution_analysis.time_ranges.end_range.anchor.time_granularity #=> String, one of "YEAR", "QUARTER", "MONTH", "WEEK", "DAY", "HOUR", "MINUTE", "SECOND", "MILLISECOND"
resp.answers[0].mir.contribution_analysis.time_ranges.end_range.anchor.offset #=> Integer
resp.answers[0].mir.contribution_analysis.direction #=> String, one of "INCREASE", "DECREASE", "NEUTRAL"
resp.answers[0].mir.contribution_analysis.sort_type #=> String, one of "ABSOLUTE_DIFFERENCE", "CONTRIBUTION_PERCENTAGE", "DEVIATION_FROM_EXPECTED", "PERCENTAGE_DIFFERENCE"
resp.answers[0].mir.visual.type #=> String
resp.answers[0].primary_visual.visual_id #=> String
resp.answers[0].primary_visual.role #=> String, one of "PRIMARY", "COMPLIMENTARY", "MULTI_INTENT", "FALLBACK", "FRAGMENT"
resp.answers[0].primary_visual.ir.metrics #=> Array
resp.answers[0].primary_visual.ir.metrics[0].metric_id.identity #=> String
resp.answers[0].primary_visual.ir.metrics[0].function.aggregation #=> String, one of "SUM", "MIN", "MAX", "COUNT", "AVERAGE", "DISTINCT_COUNT", "STDEV", "STDEVP", "VAR", "VARP", "PERCENTILE", "MEDIAN", "PTD_SUM", "PTD_MIN", "PTD_MAX", "PTD_COUNT", "PTD_DISTINCT_COUNT", "PTD_AVERAGE", "COLUMN", "CUSTOM"
resp.answers[0].primary_visual.ir.metrics[0].function.aggregation_function_parameters #=> Hash
resp.answers[0].primary_visual.ir.metrics[0].function.aggregation_function_parameters["AggFunctionParamKey"] #=> String
resp.answers[0].primary_visual.ir.metrics[0].function.period #=> String, one of "SECOND", "MINUTE", "HOUR", "DAY", "WEEK", "MONTH", "QUARTER", "YEAR"
resp.answers[0].primary_visual.ir.metrics[0].function.period_field #=> String
resp.answers[0].primary_visual.ir.metrics[0].operands #=> Array
resp.answers[0].primary_visual.ir.metrics[0].operands[0].identity #=> String
resp.answers[0].primary_visual.ir.metrics[0].comparison_method.type #=> String, one of "DIFF", "PERC_DIFF", "DIFF_AS_PERC", "POP_CURRENT_DIFF_AS_PERC", "POP_CURRENT_DIFF", "POP_OVERTIME_DIFF_AS_PERC", "POP_OVERTIME_DIFF", "PERCENT_OF_TOTAL", "RUNNING_SUM", "MOVING_AVERAGE"
resp.answers[0].primary_visual.ir.metrics[0].comparison_method.period #=> String, one of "SECOND", "MINUTE", "HOUR", "DAY", "WEEK", "MONTH", "QUARTER", "YEAR"
resp.answers[0].primary_visual.ir.metrics[0].comparison_method.window_size #=> Integer
resp.answers[0].primary_visual.ir.metrics[0].expression #=> String
resp.answers[0].primary_visual.ir.metrics[0].calculated_field_references #=> Array
resp.answers[0].primary_visual.ir.metrics[0].calculated_field_references[0].identity #=> String
resp.answers[0].primary_visual.ir.metrics[0].display_format #=> String, one of "AUTO", "PERCENT", "CURRENCY", "NUMBER", "DATE", "STRING"
resp.answers[0].primary_visual.ir.metrics[0].display_format_options.use_blank_cell_format #=> Boolean
resp.answers[0].primary_visual.ir.metrics[0].display_format_options.blank_cell_format #=> String
resp.answers[0].primary_visual.ir.metrics[0].display_format_options.date_format #=> String
resp.answers[0].primary_visual.ir.metrics[0].display_format_options.decimal_separator #=> String, one of "COMMA", "DOT"
resp.answers[0].primary_visual.ir.metrics[0].display_format_options.grouping_separator #=> String
resp.answers[0].primary_visual.ir.metrics[0].display_format_options.use_grouping #=> Boolean
resp.answers[0].primary_visual.ir.metrics[0].display_format_options.fraction_digits #=> Integer
resp.answers[0].primary_visual.ir.metrics[0].display_format_options.prefix #=> String
resp.answers[0].primary_visual.ir.metrics[0].display_format_options.suffix #=> String
resp.answers[0].primary_visual.ir.metrics[0].display_format_options.unit_scaler #=> String, one of "NONE", "AUTO", "THOUSANDS", "MILLIONS", "BILLIONS", "TRILLIONS"
resp.answers[0].primary_visual.ir.metrics[0].display_format_options.negative_format.prefix #=> String
resp.answers[0].primary_visual.ir.metrics[0].display_format_options.negative_format.suffix #=> String
resp.answers[0].primary_visual.ir.metrics[0].display_format_options.currency_symbol #=> String
resp.answers[0].primary_visual.ir.metrics[0].named_entity.named_entity_name #=> String
resp.answers[0].primary_visual.ir.group_by_list #=> Array
resp.answers[0].primary_visual.ir.group_by_list[0].field_name.identity #=> String
resp.answers[0].primary_visual.ir.group_by_list[0].time_granularity #=> String, one of "SECOND", "MINUTE", "HOUR", "DAY", "WEEK", "MONTH", "QUARTER", "YEAR"
resp.answers[0].primary_visual.ir.group_by_list[0].sort.operand.identity #=> String
resp.answers[0].primary_visual.ir.group_by_list[0].sort.sort_direction #=> String, one of "ASCENDING", "DESCENDING"
resp.answers[0].primary_visual.ir.group_by_list[0].display_format #=> String, one of "AUTO", "PERCENT", "CURRENCY", "NUMBER", "DATE", "STRING"
resp.answers[0].primary_visual.ir.group_by_list[0].display_format_options.use_blank_cell_format #=> Boolean
resp.answers[0].primary_visual.ir.group_by_list[0].display_format_options.blank_cell_format #=> String
resp.answers[0].primary_visual.ir.group_by_list[0].display_format_options.date_format #=> String
resp.answers[0].primary_visual.ir.group_by_list[0].display_format_options.decimal_separator #=> String, one of "COMMA", "DOT"
resp.answers[0].primary_visual.ir.group_by_list[0].display_format_options.grouping_separator #=> String
resp.answers[0].primary_visual.ir.group_by_list[0].display_format_options.use_grouping #=> Boolean
resp.answers[0].primary_visual.ir.group_by_list[0].display_format_options.fraction_digits #=> Integer
resp.answers[0].primary_visual.ir.group_by_list[0].display_format_options.prefix #=> String
resp.answers[0].primary_visual.ir.group_by_list[0].display_format_options.suffix #=> String
resp.answers[0].primary_visual.ir.group_by_list[0].display_format_options.unit_scaler #=> String, one of "NONE", "AUTO", "THOUSANDS", "MILLIONS", "BILLIONS", "TRILLIONS"
resp.answers[0].primary_visual.ir.group_by_list[0].display_format_options.negative_format.prefix #=> String
resp.answers[0].primary_visual.ir.group_by_list[0].display_format_options.negative_format.suffix #=> String
resp.answers[0].primary_visual.ir.group_by_list[0].display_format_options.currency_symbol #=> String
resp.answers[0].primary_visual.ir.group_by_list[0].named_entity.named_entity_name #=> String
resp.answers[0].primary_visual.ir.filters #=> Array
resp.answers[0].primary_visual.ir.filters[0] #=> Array
resp.answers[0].primary_visual.ir.filters[0][0].filter_type #=> String, one of "CATEGORY_FILTER", "NUMERIC_EQUALITY_FILTER", "NUMERIC_RANGE_FILTER", "DATE_RANGE_FILTER", "RELATIVE_DATE_FILTER", "TOP_BOTTOM_FILTER", "EQUALS", "RANK_LIMIT_FILTER", "ACCEPT_ALL_FILTER"
resp.answers[0].primary_visual.ir.filters[0][0].filter_class #=> String, one of "ENFORCED_VALUE_FILTER", "CONDITIONAL_VALUE_FILTER", "NAMED_VALUE_FILTER"
resp.answers[0].primary_visual.ir.filters[0][0].operand_field.identity #=> String
resp.answers[0].primary_visual.ir.filters[0][0].function #=> String, one of "CONTAINS", "EXACT", "STARTS_WITH", "ENDS_WITH", "CONTAINS_STRING", "PREVIOUS", "THIS", "LAST", "NEXT", "NOW"
resp.answers[0].primary_visual.ir.filters[0][0].constant.constant_type #=> String, one of "SINGULAR", "RANGE", "COLLECTIVE"
resp.answers[0].primary_visual.ir.filters[0][0].constant.value #=> String
resp.answers[0].primary_visual.ir.filters[0][0].constant.minimum #=> String
resp.answers[0].primary_visual.ir.filters[0][0].constant.maximum #=> String
resp.answers[0].primary_visual.ir.filters[0][0].constant.value_list #=> Array
resp.answers[0].primary_visual.ir.filters[0][0].constant.value_list[0].constant_type #=> String, one of "SINGULAR", "RANGE", "COLLECTIVE"
resp.answers[0].primary_visual.ir.filters[0][0].constant.value_list[0].value #=> String
resp.answers[0].primary_visual.ir.filters[0][0].inverse #=> Boolean
resp.answers[0].primary_visual.ir.filters[0][0].null_filter #=> String, one of "ALL_VALUES", "NON_NULLS_ONLY", "NULLS_ONLY"
resp.answers[0].primary_visual.ir.filters[0][0].aggregation #=> String, one of "SUM", "MIN", "MAX", "COUNT", "AVERAGE", "DISTINCT_COUNT", "STDEV", "STDEVP", "VAR", "VARP", "PERCENTILE", "MEDIAN", "PTD_SUM", "PTD_MIN", "PTD_MAX", "PTD_COUNT", "PTD_DISTINCT_COUNT", "PTD_AVERAGE", "COLUMN", "CUSTOM"
resp.answers[0].primary_visual.ir.filters[0][0].aggregation_function_parameters #=> Hash
resp.answers[0].primary_visual.ir.filters[0][0].aggregation_function_parameters["AggFunctionParamKey"] #=> String
resp.answers[0].primary_visual.ir.filters[0][0].aggregation_partition_by #=> Array
resp.answers[0].primary_visual.ir.filters[0][0].aggregation_partition_by[0].field_name #=> String
resp.answers[0].primary_visual.ir.filters[0][0].aggregation_partition_by[0].time_granularity #=> String, one of "YEAR", "QUARTER", "MONTH", "WEEK", "DAY", "HOUR", "MINUTE", "SECOND", "MILLISECOND"
resp.answers[0].primary_visual.ir.filters[0][0].range.constant_type #=> String, one of "SINGULAR", "RANGE", "COLLECTIVE"
resp.answers[0].primary_visual.ir.filters[0][0].range.value #=> String
resp.answers[0].primary_visual.ir.filters[0][0].range.minimum #=> String
resp.answers[0].primary_visual.ir.filters[0][0].range.maximum #=> String
resp.answers[0].primary_visual.ir.filters[0][0].range.value_list #=> Array
resp.answers[0].primary_visual.ir.filters[0][0].range.value_list[0].constant_type #=> String, one of "SINGULAR", "RANGE", "COLLECTIVE"
resp.answers[0].primary_visual.ir.filters[0][0].range.value_list[0].value #=> String
resp.answers[0].primary_visual.ir.filters[0][0].inclusive #=> Boolean
resp.answers[0].primary_visual.ir.filters[0][0].time_granularity #=> String, one of "YEAR", "QUARTER", "MONTH", "WEEK", "DAY", "HOUR", "MINUTE", "SECOND", "MILLISECOND"
resp.answers[0].primary_visual.ir.filters[0][0].last_next_offset.constant_type #=> String, one of "SINGULAR", "RANGE", "COLLECTIVE"
resp.answers[0].primary_visual.ir.filters[0][0].last_next_offset.value #=> String
resp.answers[0].primary_visual.ir.filters[0][0].last_next_offset.minimum #=> String
resp.answers[0].primary_visual.ir.filters[0][0].last_next_offset.maximum #=> String
resp.answers[0].primary_visual.ir.filters[0][0].last_next_offset.value_list #=> Array
resp.answers[0].primary_visual.ir.filters[0][0].last_next_offset.value_list[0].constant_type #=> String, one of "SINGULAR", "RANGE", "COLLECTIVE"
resp.answers[0].primary_visual.ir.filters[0][0].last_next_offset.value_list[0].value #=> String
resp.answers[0].primary_visual.ir.filters[0][0].agg_metrics #=> Array
resp.answers[0].primary_visual.ir.filters[0][0].agg_metrics[0].metric_operand.identity #=> String
resp.answers[0].primary_visual.ir.filters[0][0].agg_metrics[0].function #=> String, one of "SUM", "MIN", "MAX", "COUNT", "AVERAGE", "DISTINCT_COUNT", "STDEV", "STDEVP", "VAR", "VARP", "PERCENTILE", "MEDIAN", "PTD_SUM", "PTD_MIN", "PTD_MAX", "PTD_COUNT", "PTD_DISTINCT_COUNT", "PTD_AVERAGE", "COLUMN", "CUSTOM"
resp.answers[0].primary_visual.ir.filters[0][0].agg_metrics[0].sort_direction #=> String, one of "ASCENDING", "DESCENDING"
resp.answers[0].primary_visual.ir.filters[0][0].top_bottom_limit.constant_type #=> String, one of "SINGULAR", "RANGE", "COLLECTIVE"
resp.answers[0].primary_visual.ir.filters[0][0].top_bottom_limit.value #=> String
resp.answers[0].primary_visual.ir.filters[0][0].top_bottom_limit.minimum #=> String
resp.answers[0].primary_visual.ir.filters[0][0].top_bottom_limit.maximum #=> String
resp.answers[0].primary_visual.ir.filters[0][0].top_bottom_limit.value_list #=> Array
resp.answers[0].primary_visual.ir.filters[0][0].top_bottom_limit.value_list[0].constant_type #=> String, one of "SINGULAR", "RANGE", "COLLECTIVE"
resp.answers[0].primary_visual.ir.filters[0][0].top_bottom_limit.value_list[0].value #=> String
resp.answers[0].primary_visual.ir.filters[0][0].sort_direction #=> String, one of "ASCENDING", "DESCENDING"
resp.answers[0].primary_visual.ir.filters[0][0].anchor.anchor_type #=> String, one of "TODAY"
resp.answers[0].primary_visual.ir.filters[0][0].anchor.time_granularity #=> String, one of "YEAR", "QUARTER", "MONTH", "WEEK", "DAY", "HOUR", "MINUTE", "SECOND", "MILLISECOND"
resp.answers[0].primary_visual.ir.filters[0][0].anchor.offset #=> Integer
resp.answers[0].primary_visual.ir.sort.operand.identity #=> String
resp.answers[0].primary_visual.ir.sort.sort_direction #=> String, one of "ASCENDING", "DESCENDING"
resp.answers[0].primary_visual.ir.contribution_analysis.factors #=> Array
resp.answers[0].primary_visual.ir.contribution_analysis.factors[0].field_name #=> String
resp.answers[0].primary_visual.ir.contribution_analysis.time_ranges.start_range.filter_type #=> String, one of "CATEGORY_FILTER", "NUMERIC_EQUALITY_FILTER", "NUMERIC_RANGE_FILTER", "DATE_RANGE_FILTER", "RELATIVE_DATE_FILTER", "TOP_BOTTOM_FILTER", "EQUALS", "RANK_LIMIT_FILTER", "ACCEPT_ALL_FILTER"
resp.answers[0].primary_visual.ir.contribution_analysis.time_ranges.start_range.filter_class #=> String, one of "ENFORCED_VALUE_FILTER", "CONDITIONAL_VALUE_FILTER", "NAMED_VALUE_FILTER"
resp.answers[0].primary_visual.ir.contribution_analysis.time_ranges.start_range.operand_field.identity #=> String
resp.answers[0].primary_visual.ir.contribution_analysis.time_ranges.start_range.function #=> String, one of "CONTAINS", "EXACT", "STARTS_WITH", "ENDS_WITH", "CONTAINS_STRING", "PREVIOUS", "THIS", "LAST", "NEXT", "NOW"
resp.answers[0].primary_visual.ir.contribution_analysis.time_ranges.start_range.constant.constant_type #=> String, one of "SINGULAR", "RANGE", "COLLECTIVE"
resp.answers[0].primary_visual.ir.contribution_analysis.time_ranges.start_range.constant.value #=> String
resp.answers[0].primary_visual.ir.contribution_analysis.time_ranges.start_range.constant.minimum #=> String
resp.answers[0].primary_visual.ir.contribution_analysis.time_ranges.start_range.constant.maximum #=> String
resp.answers[0].primary_visual.ir.contribution_analysis.time_ranges.start_range.constant.value_list #=> Array
resp.answers[0].primary_visual.ir.contribution_analysis.time_ranges.start_range.constant.value_list[0].constant_type #=> String, one of "SINGULAR", "RANGE", "COLLECTIVE"
resp.answers[0].primary_visual.ir.contribution_analysis.time_ranges.start_range.constant.value_list[0].value #=> String
resp.answers[0].primary_visual.ir.contribution_analysis.time_ranges.start_range.inverse #=> Boolean
resp.answers[0].primary_visual.ir.contribution_analysis.time_ranges.start_range.null_filter #=> String, one of "ALL_VALUES", "NON_NULLS_ONLY", "NULLS_ONLY"
resp.answers[0].primary_visual.ir.contribution_analysis.time_ranges.start_range.aggregation #=> String, one of "SUM", "MIN", "MAX", "COUNT", "AVERAGE", "DISTINCT_COUNT", "STDEV", "STDEVP", "VAR", "VARP", "PERCENTILE", "MEDIAN", "PTD_SUM", "PTD_MIN", "PTD_MAX", "PTD_COUNT", "PTD_DISTINCT_COUNT", "PTD_AVERAGE", "COLUMN", "CUSTOM"
resp.answers[0].primary_visual.ir.contribution_analysis.time_ranges.start_range.aggregation_function_parameters #=> Hash
resp.answers[0].primary_visual.ir.contribution_analysis.time_ranges.start_range.aggregation_function_parameters["AggFunctionParamKey"] #=> String
resp.answers[0].primary_visual.ir.contribution_analysis.time_ranges.start_range.aggregation_partition_by #=> Array
resp.answers[0].primary_visual.ir.contribution_analysis.time_ranges.start_range.aggregation_partition_by[0].field_name #=> String
resp.answers[0].primary_visual.ir.contribution_analysis.time_ranges.start_range.aggregation_partition_by[0].time_granularity #=> String, one of "YEAR", "QUARTER", "MONTH", "WEEK", "DAY", "HOUR", "MINUTE", "SECOND", "MILLISECOND"
resp.answers[0].primary_visual.ir.contribution_analysis.time_ranges.start_range.range.constant_type #=> String, one of "SINGULAR", "RANGE", "COLLECTIVE"
resp.answers[0].primary_visual.ir.contribution_analysis.time_ranges.start_range.range.value #=> String
resp.answers[0].primary_visual.ir.contribution_analysis.time_ranges.start_range.range.minimum #=> String
resp.answers[0].primary_visual.ir.contribution_analysis.time_ranges.start_range.range.maximum #=> String
resp.answers[0].primary_visual.ir.contribution_analysis.time_ranges.start_range.range.value_list #=> Array
resp.answers[0].primary_visual.ir.contribution_analysis.time_ranges.start_range.range.value_list[0].constant_type #=> String, one of "SINGULAR", "RANGE", "COLLECTIVE"
resp.answers[0].primary_visual.ir.contribution_analysis.time_ranges.start_range.range.value_list[0].value #=> String
resp.answers[0].primary_visual.ir.contribution_analysis.time_ranges.start_range.inclusive #=> Boolean
resp.answers[0].primary_visual.ir.contribution_analysis.time_ranges.start_range.time_granularity #=> String, one of "YEAR", "QUARTER", "MONTH", "WEEK", "DAY", "HOUR", "MINUTE", "SECOND", "MILLISECOND"
resp.answers[0].primary_visual.ir.contribution_analysis.time_ranges.start_range.last_next_offset.constant_type #=> String, one of "SINGULAR", "RANGE", "COLLECTIVE"
resp.answers[0].primary_visual.ir.contribution_analysis.time_ranges.start_range.last_next_offset.value #=> String
resp.answers[0].primary_visual.ir.contribution_analysis.time_ranges.start_range.last_next_offset.minimum #=> String
resp.answers[0].primary_visual.ir.contribution_analysis.time_ranges.start_range.last_next_offset.maximum #=> String
resp.answers[0].primary_visual.ir.contribution_analysis.time_ranges.start_range.last_next_offset.value_list #=> Array
resp.answers[0].primary_visual.ir.contribution_analysis.time_ranges.start_range.last_next_offset.value_list[0].constant_type #=> String, one of "SINGULAR", "RANGE", "COLLECTIVE"
resp.answers[0].primary_visual.ir.contribution_analysis.time_ranges.start_range.last_next_offset.value_list[0].value #=> String
resp.answers[0].primary_visual.ir.contribution_analysis.time_ranges.start_range.agg_metrics #=> Array
resp.answers[0].primary_visual.ir.contribution_analysis.time_ranges.start_range.agg_metrics[0].metric_operand.identity #=> String
resp.answers[0].primary_visual.ir.contribution_analysis.time_ranges.start_range.agg_metrics[0].function #=> String, one of "SUM", "MIN", "MAX", "COUNT", "AVERAGE", "DISTINCT_COUNT", "STDEV", "STDEVP", "VAR", "VARP", "PERCENTILE", "MEDIAN", "PTD_SUM", "PTD_MIN", "PTD_MAX", "PTD_COUNT", "PTD_DISTINCT_COUNT", "PTD_AVERAGE", "COLUMN", "CUSTOM"
resp.answers[0].primary_visual.ir.contribution_analysis.time_ranges.start_range.agg_metrics[0].sort_direction #=> String, one of "ASCENDING", "DESCENDING"
resp.answers[0].primary_visual.ir.contribution_analysis.time_ranges.start_range.top_bottom_limit.constant_type #=> String, one of "SINGULAR", "RANGE", "COLLECTIVE"
resp.answers[0].primary_visual.ir.contribution_analysis.time_ranges.start_range.top_bottom_limit.value #=> String
resp.answers[0].primary_visual.ir.contribution_analysis.time_ranges.start_range.top_bottom_limit.minimum #=> String
resp.answers[0].primary_visual.ir.contribution_analysis.time_ranges.start_range.top_bottom_limit.maximum #=> String
resp.answers[0].primary_visual.ir.contribution_analysis.time_ranges.start_range.top_bottom_limit.value_list #=> Array
resp.answers[0].primary_visual.ir.contribution_analysis.time_ranges.start_range.top_bottom_limit.value_list[0].constant_type #=> String, one of "SINGULAR", "RANGE", "COLLECTIVE"
resp.answers[0].primary_visual.ir.contribution_analysis.time_ranges.start_range.top_bottom_limit.value_list[0].value #=> String
resp.answers[0].primary_visual.ir.contribution_analysis.time_ranges.start_range.sort_direction #=> String, one of "ASCENDING", "DESCENDING"
resp.answers[0].primary_visual.ir.contribution_analysis.time_ranges.start_range.anchor.anchor_type #=> String, one of "TODAY"
resp.answers[0].primary_visual.ir.contribution_analysis.time_ranges.start_range.anchor.time_granularity #=> String, one of "YEAR", "QUARTER", "MONTH", "WEEK", "DAY", "HOUR", "MINUTE", "SECOND", "MILLISECOND"
resp.answers[0].primary_visual.ir.contribution_analysis.time_ranges.start_range.anchor.offset #=> Integer
resp.answers[0].primary_visual.ir.contribution_analysis.time_ranges.end_range.filter_type #=> String, one of "CATEGORY_FILTER", "NUMERIC_EQUALITY_FILTER", "NUMERIC_RANGE_FILTER", "DATE_RANGE_FILTER", "RELATIVE_DATE_FILTER", "TOP_BOTTOM_FILTER", "EQUALS", "RANK_LIMIT_FILTER", "ACCEPT_ALL_FILTER"
resp.answers[0].primary_visual.ir.contribution_analysis.time_ranges.end_range.filter_class #=> String, one of "ENFORCED_VALUE_FILTER", "CONDITIONAL_VALUE_FILTER", "NAMED_VALUE_FILTER"
resp.answers[0].primary_visual.ir.contribution_analysis.time_ranges.end_range.operand_field.identity #=> String
resp.answers[0].primary_visual.ir.contribution_analysis.time_ranges.end_range.function #=> String, one of "CONTAINS", "EXACT", "STARTS_WITH", "ENDS_WITH", "CONTAINS_STRING", "PREVIOUS", "THIS", "LAST", "NEXT", "NOW"
resp.answers[0].primary_visual.ir.contribution_analysis.time_ranges.end_range.constant.constant_type #=> String, one of "SINGULAR", "RANGE", "COLLECTIVE"
resp.answers[0].primary_visual.ir.contribution_analysis.time_ranges.end_range.constant.value #=> String
resp.answers[0].primary_visual.ir.contribution_analysis.time_ranges.end_range.constant.minimum #=> String
resp.answers[0].primary_visual.ir.contribution_analysis.time_ranges.end_range.constant.maximum #=> String
resp.answers[0].primary_visual.ir.contribution_analysis.time_ranges.end_range.constant.value_list #=> Array
resp.answers[0].primary_visual.ir.contribution_analysis.time_ranges.end_range.constant.value_list[0].constant_type #=> String, one of "SINGULAR", "RANGE", "COLLECTIVE"
resp.answers[0].primary_visual.ir.contribution_analysis.time_ranges.end_range.constant.value_list[0].value #=> String
resp.answers[0].primary_visual.ir.contribution_analysis.time_ranges.end_range.inverse #=> Boolean
resp.answers[0].primary_visual.ir.contribution_analysis.time_ranges.end_range.null_filter #=> String, one of "ALL_VALUES", "NON_NULLS_ONLY", "NULLS_ONLY"
resp.answers[0].primary_visual.ir.contribution_analysis.time_ranges.end_range.aggregation #=> String, one of "SUM", "MIN", "MAX", "COUNT", "AVERAGE", "DISTINCT_COUNT", "STDEV", "STDEVP", "VAR", "VARP", "PERCENTILE", "MEDIAN", "PTD_SUM", "PTD_MIN", "PTD_MAX", "PTD_COUNT", "PTD_DISTINCT_COUNT", "PTD_AVERAGE", "COLUMN", "CUSTOM"
resp.answers[0].primary_visual.ir.contribution_analysis.time_ranges.end_range.aggregation_function_parameters #=> Hash
resp.answers[0].primary_visual.ir.contribution_analysis.time_ranges.end_range.aggregation_function_parameters["AggFunctionParamKey"] #=> String
resp.answers[0].primary_visual.ir.contribution_analysis.time_ranges.end_range.aggregation_partition_by #=> Array
resp.answers[0].primary_visual.ir.contribution_analysis.time_ranges.end_range.aggregation_partition_by[0].field_name #=> String
resp.answers[0].primary_visual.ir.contribution_analysis.time_ranges.end_range.aggregation_partition_by[0].time_granularity #=> String, one of "YEAR", "QUARTER", "MONTH", "WEEK", "DAY", "HOUR", "MINUTE", "SECOND", "MILLISECOND"
resp.answers[0].primary_visual.ir.contribution_analysis.time_ranges.end_range.range.constant_type #=> String, one of "SINGULAR", "RANGE", "COLLECTIVE"
resp.answers[0].primary_visual.ir.contribution_analysis.time_ranges.end_range.range.value #=> String
resp.answers[0].primary_visual.ir.contribution_analysis.time_ranges.end_range.range.minimum #=> String
resp.answers[0].primary_visual.ir.contribution_analysis.time_ranges.end_range.range.maximum #=> String
resp.answers[0].primary_visual.ir.contribution_analysis.time_ranges.end_range.range.value_list #=> Array
resp.answers[0].primary_visual.ir.contribution_analysis.time_ranges.end_range.range.value_list[0].constant_type #=> String, one of "SINGULAR", "RANGE", "COLLECTIVE"
resp.answers[0].primary_visual.ir.contribution_analysis.time_ranges.end_range.range.value_list[0].value #=> String
resp.answers[0].primary_visual.ir.contribution_analysis.time_ranges.end_range.inclusive #=> Boolean
resp.answers[0].primary_visual.ir.contribution_analysis.time_ranges.end_range.time_granularity #=> String, one of "YEAR", "QUARTER", "MONTH", "WEEK", "DAY", "HOUR", "MINUTE", "SECOND", "MILLISECOND"
resp.answers[0].primary_visual.ir.contribution_analysis.time_ranges.end_range.last_next_offset.constant_type #=> String, one of "SINGULAR", "RANGE", "COLLECTIVE"
resp.answers[0].primary_visual.ir.contribution_analysis.time_ranges.end_range.last_next_offset.value #=> String
resp.answers[0].primary_visual.ir.contribution_analysis.time_ranges.end_range.last_next_offset.minimum #=> String
resp.answers[0].primary_visual.ir.contribution_analysis.time_ranges.end_range.last_next_offset.maximum #=> String
resp.answers[0].primary_visual.ir.contribution_analysis.time_ranges.end_range.last_next_offset.value_list #=> Array
resp.answers[0].primary_visual.ir.contribution_analysis.time_ranges.end_range.last_next_offset.value_list[0].constant_type #=> String, one of "SINGULAR", "RANGE", "COLLECTIVE"
resp.answers[0].primary_visual.ir.contribution_analysis.time_ranges.end_range.last_next_offset.value_list[0].value #=> String
resp.answers[0].primary_visual.ir.contribution_analysis.time_ranges.end_range.agg_metrics #=> Array
resp.answers[0].primary_visual.ir.contribution_analysis.time_ranges.end_range.agg_metrics[0].metric_operand.identity #=> String
resp.answers[0].primary_visual.ir.contribution_analysis.time_ranges.end_range.agg_metrics[0].function #=> String, one of "SUM", "MIN", "MAX", "COUNT", "AVERAGE", "DISTINCT_COUNT", "STDEV", "STDEVP", "VAR", "VARP", "PERCENTILE", "MEDIAN", "PTD_SUM", "PTD_MIN", "PTD_MAX", "PTD_COUNT", "PTD_DISTINCT_COUNT", "PTD_AVERAGE", "COLUMN", "CUSTOM"
resp.answers[0].primary_visual.ir.contribution_analysis.time_ranges.end_range.agg_metrics[0].sort_direction #=> String, one of "ASCENDING", "DESCENDING"
resp.answers[0].primary_visual.ir.contribution_analysis.time_ranges.end_range.top_bottom_limit.constant_type #=> String, one of "SINGULAR", "RANGE", "COLLECTIVE"
resp.answers[0].primary_visual.ir.contribution_analysis.time_ranges.end_range.top_bottom_limit.value #=> String
resp.answers[0].primary_visual.ir.contribution_analysis.time_ranges.end_range.top_bottom_limit.minimum #=> String
resp.answers[0].primary_visual.ir.contribution_analysis.time_ranges.end_range.top_bottom_limit.maximum #=> String
resp.answers[0].primary_visual.ir.contribution_analysis.time_ranges.end_range.top_bottom_limit.value_list #=> Array
resp.answers[0].primary_visual.ir.contribution_analysis.time_ranges.end_range.top_bottom_limit.value_list[0].constant_type #=> String, one of "SINGULAR", "RANGE", "COLLECTIVE"
resp.answers[0].primary_visual.ir.contribution_analysis.time_ranges.end_range.top_bottom_limit.value_list[0].value #=> String
resp.answers[0].primary_visual.ir.contribution_analysis.time_ranges.end_range.sort_direction #=> String, one of "ASCENDING", "DESCENDING"
resp.answers[0].primary_visual.ir.contribution_analysis.time_ranges.end_range.anchor.anchor_type #=> String, one of "TODAY"
resp.answers[0].primary_visual.ir.contribution_analysis.time_ranges.end_range.anchor.time_granularity #=> String, one of "YEAR", "QUARTER", "MONTH", "WEEK", "DAY", "HOUR", "MINUTE", "SECOND", "MILLISECOND"
resp.answers[0].primary_visual.ir.contribution_analysis.time_ranges.end_range.anchor.offset #=> Integer
resp.answers[0].primary_visual.ir.contribution_analysis.direction #=> String, one of "INCREASE", "DECREASE", "NEUTRAL"
resp.answers[0].primary_visual.ir.contribution_analysis.sort_type #=> String, one of "ABSOLUTE_DIFFERENCE", "CONTRIBUTION_PERCENTAGE", "DEVIATION_FROM_EXPECTED", "PERCENTAGE_DIFFERENCE"
resp.answers[0].primary_visual.ir.visual.type #=> String
resp.answers[0].primary_visual.supporting_visuals #=> Array
resp.answers[0].primary_visual.supporting_visuals[0] #=> Types::TopicVisual
resp.answers[0].template.template_type #=> String
resp.answers[0].template.slots #=> Array
resp.answers[0].template.slots[0].slot_id #=> String
resp.answers[0].template.slots[0].visual_id #=> 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 Amazon Web Services account that containd the reviewed answers that you want listed.

  • :topic_id (required, String) —

    The ID for the topic that contains the reviewed answer that you want to list. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

Returns:

See Also:



10550
10551
10552
10553
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 10550

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

#list_topics(params = {}) ⇒ Types::ListTopicsResponse

Lists all of the topics within an 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_topics({
  aws_account_id: "AwsAccountId", # required
  next_token: "String",
  max_results: 1,
})

Response structure


resp.topics_summaries #=> Array
resp.topics_summaries[0].arn #=> String
resp.topics_summaries[0].topic_id #=> String
resp.topics_summaries[0].name #=> String
resp.topics_summaries[0].user_experience_version #=> String, one of "LEGACY", "NEW_READER_EXPERIENCE"
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 Amazon Web Services account that contains the topics that you want to list.

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



10600
10601
10602
10603
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 10600

def list_topics(params = {}, options = {})
  req = build_request(:list_topics, 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.

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

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



10660
10661
10662
10663
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 10660

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.

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_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", "ADMIN_PRO", "AUTHOR_PRO", "READER_PRO"
resp.user_list[0].identity_type #=> String, one of "IAM", "QUICKSIGHT", "IAM_IDENTITY_CENTER"
resp.user_list[0].active #=> Boolean
resp.user_list[0].principal_id #=> String
resp.user_list[0].custom_permissions_name #=> String
resp.user_list[0]. #=> String
resp.user_list[0]. #=> String
resp.user_list[0]. #=> 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 Amazon Web Services account that the user is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon QuickSight account.

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



10722
10723
10724
10725
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 10722

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

#list_vpc_connections(params = {}) ⇒ Types::ListVPCConnectionsResponse

Lists all of the VPC connections in the current set Amazon Web Services Region of an Amazon Web Services 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_vpc_connections({
  aws_account_id: "AwsAccountId", # required
  next_token: "String",
  max_results: 1,
})

Response structure


resp.vpc_connection_summaries #=> Array
resp.vpc_connection_summaries[0].vpc_connection_id #=> String
resp.vpc_connection_summaries[0].arn #=> String
resp.vpc_connection_summaries[0].name #=> String
resp.vpc_connection_summaries[0].vpc_id #=> String
resp.vpc_connection_summaries[0].security_group_ids #=> Array
resp.vpc_connection_summaries[0].security_group_ids[0] #=> String
resp.vpc_connection_summaries[0].dns_resolvers #=> Array
resp.vpc_connection_summaries[0].dns_resolvers[0] #=> String
resp.vpc_connection_summaries[0].status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED", "DELETION_IN_PROGRESS", "DELETION_FAILED", "DELETED"
resp.vpc_connection_summaries[0].availability_status #=> String, one of "AVAILABLE", "UNAVAILABLE", "PARTIALLY_AVAILABLE"
resp.vpc_connection_summaries[0].network_interfaces #=> Array
resp.vpc_connection_summaries[0].network_interfaces[0].subnet_id #=> String
resp.vpc_connection_summaries[0].network_interfaces[0].availability_zone #=> String
resp.vpc_connection_summaries[0].network_interfaces[0].error_message #=> String
resp.vpc_connection_summaries[0].network_interfaces[0].status #=> String, one of "CREATING", "AVAILABLE", "CREATION_FAILED", "UPDATING", "UPDATE_FAILED", "DELETING", "DELETED", "DELETION_FAILED", "DELETION_SCHEDULED", "ATTACHMENT_FAILED_ROLLBACK_FAILED"
resp.vpc_connection_summaries[0].network_interfaces[0].network_interface_id #=> String
resp.vpc_connection_summaries[0].role_arn #=> String
resp.vpc_connection_summaries[0].created_time #=> Time
resp.vpc_connection_summaries[0].last_updated_time #=> Time
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 Amazon Web Services account ID of the account that contains the VPC connections that you want to list.

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



10788
10789
10790
10791
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 10788

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

#put_data_set_refresh_properties(params = {}) ⇒ Types::PutDataSetRefreshPropertiesResponse

Creates or updates the dataset refresh properties for the dataset.

Examples:

Request syntax with placeholder values


resp = client.put_data_set_refresh_properties({
  aws_account_id: "AwsAccountId", # required
  data_set_id: "ResourceId", # required
  data_set_refresh_properties: { # required
    refresh_configuration: { # required
      incremental_refresh: { # required
        lookback_window: { # required
          column_name: "String", # required
          size: 1, # required
          size_unit: "HOUR", # required, accepts HOUR, DAY, WEEK
        },
      },
    },
  },
})

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :aws_account_id (required, String) —

    The Amazon Web Services account ID.

  • :data_set_id (required, String) —

    The ID of the dataset.

  • :data_set_refresh_properties (required, Types::DataSetRefreshProperties) —

    The dataset refresh properties.

Returns:

See Also:



10836
10837
10838
10839
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 10836

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

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

Creates an Amazon QuickSight user whose identity is associated with the Identity and Access Management (IAM) identity or role specified in the request. When you register a new user from the Amazon QuickSight API, Amazon QuickSight generates a registration URL. The user accesses this registration URL to create their account. Amazon QuickSight doesn't send a registration email to users who are registered from the Amazon QuickSight API. If you want new users to receive a registration email, then add those users in the Amazon QuickSight console. For more information on registering a new user in the Amazon QuickSight console, see Inviting users to access Amazon QuickSight.

Examples:

Request syntax with placeholder values


resp = client.register_user({
  identity_type: "IAM", # required, accepts IAM, QUICKSIGHT, IAM_IDENTITY_CENTER
  email: "String", # required
  user_role: "ADMIN", # required, accepts ADMIN, AUTHOR, READER, RESTRICTED_AUTHOR, RESTRICTED_READER, ADMIN_PRO, AUTHOR_PRO, READER_PRO
  iam_arn: "String",
  session_name: "RoleSessionName",
  aws_account_id: "AwsAccountId", # required
  namespace: "Namespace", # required
  user_name: "UserName",
  custom_permissions_name: "RoleName",
  external_login_federation_provider_type: "String",
  custom_federation_provider_url: "String",
  external_login_id: "String",
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # 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", "ADMIN_PRO", "AUTHOR_PRO", "READER_PRO"
resp.user.identity_type #=> String, one of "IAM", "QUICKSIGHT", "IAM_IDENTITY_CENTER"
resp.user.active #=> Boolean
resp.user.principal_id #=> String
resp.user.custom_permissions_name #=> String
resp.user. #=> String
resp.user. #=> String
resp.user. #=> 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) —

    The identity type that your Amazon QuickSight account uses to manage the identity of users.

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

    • READER_PRO: Reader Pro adds Generative BI capabilities to the Reader role. Reader Pros have access to Amazon Q in Amazon QuickSight, can build stories with Amazon Q, and can generate executive summaries from dashboards.

    • AUTHOR_PRO: Author Pro adds Generative BI capabilities to the Author role. Author Pros can author dashboards with natural language with Amazon Q, build stories with Amazon Q, create Topics for Q&A, and generate executive summaries from dashboards.

    • ADMIN_PRO: Admin Pros are Author Pros who can also manage Amazon QuickSight administrative settings. Admin Pro users are billed at Author Pro pricing.

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

  • :aws_account_id (required, String) —

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

  • :namespace (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. Customized permissions allows you to control a user's access by restricting access the following operations:

    • Create and update data sources

    • Create and update datasets

    • Create and update email reports

    • Subscribe to email reports

    To add custom permissions to an existing user, use UpdateUser instead.

    A set of custom permissions includes any combination of these restrictions. Currently, you need to create the profile names for custom permission sets by using the Amazon QuickSight console. Then, you use the RegisterUser API operation to assign the named set of permissions to a Amazon QuickSight user.

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

    This feature is available only to Amazon QuickSight Enterprise edition subscriptions.

  • :external_login_federation_provider_type (String) —

    The type of supported external login provider that provides identity to let a user federate into Amazon QuickSight with an associated Identity and Access Management(IAM) role. The type of supported external login provider can be one of the following.

    • COGNITO: Amazon Cognito. The provider URL is cognito-identity.amazonaws.com. When choosing the COGNITO provider type, don’t use the "CustomFederationProviderUrl" parameter which is only needed when the external provider is custom.

    • CUSTOM_OIDC: Custom OpenID Connect (OIDC) provider. When choosing CUSTOM_OIDC type, use the CustomFederationProviderUrl parameter to provide the custom OIDC provider URL.

  • :custom_federation_provider_url (String) —

    The URL of the custom OpenID Connect (OIDC) provider that provides identity to let a user federate into Amazon QuickSight with an associated Identity and Access Management(IAM) role. This parameter should only be used when ExternalLoginFederationProviderType parameter is set to CUSTOM_OIDC.

  • :external_login_id (String) —

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

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

    The tags to associate with the user.

Returns:

See Also:



11034
11035
11036
11037
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 11034

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

#restore_analysis(params = {}) ⇒ Types::RestoreAnalysisResponse

Restores an analysis.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :aws_account_id (required, String) —

    The ID of the Amazon Web Services account that contains the analysis.

  • :analysis_id (required, String) —

    The ID of the analysis that you're restoring.

Returns:

See Also:



11072
11073
11074
11075
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 11072

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

#search_analyses(params = {}) ⇒ Types::SearchAnalysesResponse

Searches for analyses that belong to the user specified in the filter.

This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.

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_analyses({
  aws_account_id: "AwsAccountId", # required
  filters: [ # required
    {
      operator: "StringEquals", # accepts StringEquals, StringLike
      name: "QUICKSIGHT_USER", # accepts QUICKSIGHT_USER, QUICKSIGHT_VIEWER_OR_OWNER, DIRECT_QUICKSIGHT_VIEWER_OR_OWNER, QUICKSIGHT_OWNER, DIRECT_QUICKSIGHT_OWNER, DIRECT_QUICKSIGHT_SOLE_OWNER, ANALYSIS_NAME
      value: "String",
    },
  ],
  next_token: "String",
  max_results: 1,
})

Response structure


resp.analysis_summary_list #=> Array
resp.analysis_summary_list[0].arn #=> String
resp.analysis_summary_list[0].analysis_id #=> String
resp.analysis_summary_list[0].name #=> String
resp.analysis_summary_list[0].status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED", "DELETED"
resp.analysis_summary_list[0].created_time #=> Time
resp.analysis_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 Amazon Web Services account that contains the analyses that you're searching for.

  • :filters (required, Array<Types::AnalysisSearchFilter>) —

    The structure for the search filters that you want to apply to your search.

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



11139
11140
11141
11142
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 11139

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

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

Searches for dashboards that belong to a user.

This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.

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, StringLike
      name: "QUICKSIGHT_USER", # accepts QUICKSIGHT_USER, QUICKSIGHT_VIEWER_OR_OWNER, DIRECT_QUICKSIGHT_VIEWER_OR_OWNER, QUICKSIGHT_OWNER, DIRECT_QUICKSIGHT_OWNER, DIRECT_QUICKSIGHT_SOLE_OWNER, DASHBOARD_NAME
      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 Amazon Web Services 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:



11210
11211
11212
11213
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 11210

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

#search_data_sets(params = {}) ⇒ Types::SearchDataSetsResponse

Use the SearchDataSets operation to search for datasets that belong to an 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.search_data_sets({
  aws_account_id: "AwsAccountId", # required
  filters: [ # required
    {
      operator: "StringEquals", # required, accepts StringEquals, StringLike
      name: "QUICKSIGHT_VIEWER_OR_OWNER", # required, accepts QUICKSIGHT_VIEWER_OR_OWNER, QUICKSIGHT_OWNER, DIRECT_QUICKSIGHT_VIEWER_OR_OWNER, DIRECT_QUICKSIGHT_OWNER, DIRECT_QUICKSIGHT_SOLE_OWNER, DATASET_NAME
      value: "String", # 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.data_set_summaries[0].row_level_permission_data_set.format_version #=> String, one of "VERSION_1", "VERSION_2"
resp.data_set_summaries[0].row_level_permission_data_set.status #=> String, one of "ENABLED", "DISABLED"
resp.data_set_summaries[0].row_level_permission_tag_configuration_applied #=> Boolean
resp.data_set_summaries[0].column_level_permission_rules_applied #=> Boolean
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 Amazon Web Services account ID.

  • :filters (required, Array<Types::DataSetSearchFilter>) —

    The filters to apply to the search.

  • :next_token (String) —

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

  • :max_results (Integer) —

    The maximum number of results to be returned per request.

Returns:

See Also:



11278
11279
11280
11281
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 11278

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

#search_data_sources(params = {}) ⇒ Types::SearchDataSourcesResponse

Use the SearchDataSources operation to search for data sources that belong to an 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.search_data_sources({
  aws_account_id: "AwsAccountId", # required
  filters: [ # required
    {
      operator: "StringEquals", # required, accepts StringEquals, StringLike
      name: "DIRECT_QUICKSIGHT_VIEWER_OR_OWNER", # required, accepts DIRECT_QUICKSIGHT_VIEWER_OR_OWNER, DIRECT_QUICKSIGHT_OWNER, DIRECT_QUICKSIGHT_SOLE_OWNER, DATASOURCE_NAME
      value: "String", # required
    },
  ],
  next_token: "String",
  max_results: 1,
})

Response structure


resp.data_source_summaries #=> Array
resp.data_source_summaries[0].arn #=> String
resp.data_source_summaries[0].data_source_id #=> String
resp.data_source_summaries[0].name #=> String
resp.data_source_summaries[0].type #=> String, one of "ADOBE_ANALYTICS", "AMAZON_ELASTICSEARCH", "ATHENA", "AURORA", "AURORA_POSTGRESQL", "AWS_IOT_ANALYTICS", "GITHUB", "JIRA", "MARIADB", "MYSQL", "ORACLE", "POSTGRESQL", "PRESTO", "REDSHIFT", "S3", "SALESFORCE", "SERVICENOW", "SNOWFLAKE", "SPARK", "SQLSERVER", "TERADATA", "TWITTER", "TIMESTREAM", "AMAZON_OPENSEARCH", "EXASOL", "DATABRICKS", "STARBURST", "TRINO", "BIGQUERY"
resp.data_source_summaries[0].created_time #=> Time
resp.data_source_summaries[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 Amazon Web Services account ID.

  • :filters (required, Array<Types::DataSourceSearchFilter>) —

    The filters to apply to the search.

  • :next_token (String) —

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

  • :max_results (Integer) —

    The maximum number of results to be returned per request.

Returns:

See Also:



11339
11340
11341
11342
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 11339

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

#search_folders(params = {}) ⇒ Types::SearchFoldersResponse

Searches the subfolders in a folder.

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_folders({
  aws_account_id: "AwsAccountId", # required
  filters: [ # required
    {
      operator: "StringEquals", # accepts StringEquals, StringLike
      name: "PARENT_FOLDER_ARN", # accepts PARENT_FOLDER_ARN, DIRECT_QUICKSIGHT_OWNER, DIRECT_QUICKSIGHT_SOLE_OWNER, DIRECT_QUICKSIGHT_VIEWER_OR_OWNER, QUICKSIGHT_OWNER, QUICKSIGHT_VIEWER_OR_OWNER, FOLDER_NAME
      value: "String",
    },
  ],
  next_token: "String",
  max_results: 1,
})

Response structure


resp.status #=> Integer
resp.folder_summary_list #=> Array
resp.folder_summary_list[0].arn #=> String
resp.folder_summary_list[0].folder_id #=> String
resp.folder_summary_list[0].name #=> String
resp.folder_summary_list[0].folder_type #=> String, one of "SHARED", "RESTRICTED"
resp.folder_summary_list[0].created_time #=> Time
resp.folder_summary_list[0].last_updated_time #=> Time
resp.folder_summary_list[0].sharing_model #=> String, one of "ACCOUNT", "NAMESPACE"
resp.next_token #=> String
resp.request_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :aws_account_id (required, String) —

    The ID for the Amazon Web Services account that contains the folder.

  • :filters (required, Array<Types::FolderSearchFilter>) —

    The filters to apply to the search. Currently, you can search only by the parent folder ARN. For example, "Filters": [ \{ "Name": "PARENT_FOLDER_ARN", "Operator": "StringEquals", "Value": "arn:aws:quicksight:us-east-1:1:folder/folderId" \} ].

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



11404
11405
11406
11407
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 11404

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

#search_groups(params = {}) ⇒ Types::SearchGroupsResponse

Use the SearchGroups operation to search groups in a specified Amazon QuickSight namespace using the supplied filters.

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_groups({
  aws_account_id: "AwsAccountId", # required
  next_token: "String",
  max_results: 1,
  namespace: "Namespace", # required
  filters: [ # required
    {
      operator: "StartsWith", # required, accepts StartsWith
      name: "GROUP_NAME", # required, accepts GROUP_NAME
      value: "String", # 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 Amazon Web Services account that the group is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon QuickSight account.

  • :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 that you want to search.

  • :filters (required, Array<Types::GroupSearchFilter>) —

    The structure for the search filters that you want to apply to your search.

Returns:

See Also:



11470
11471
11472
11473
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 11470

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

#start_asset_bundle_export_job(params = {}) ⇒ Types::StartAssetBundleExportJobResponse

Starts an Asset Bundle export job.

An Asset Bundle export job exports specified Amazon QuickSight assets. You can also choose to export any asset dependencies in the same job. Export jobs run asynchronously and can be polled with a DescribeAssetBundleExportJob API call. When a job is successfully completed, a download URL that contains the exported assets is returned. The URL is valid for 5 minutes and can be refreshed with a DescribeAssetBundleExportJob API call. Each Amazon QuickSight account can run up to 5 export jobs concurrently.

The API caller must have the necessary permissions in their IAM role to access each resource before the resources can be exported.

Examples:

Request syntax with placeholder values


resp = client.start_asset_bundle_export_job({
  aws_account_id: "AwsAccountId", # required
  asset_bundle_export_job_id: "ShortRestrictiveResourceId", # required
  resource_arns: ["Arn"], # required
  include_all_dependencies: false,
  export_format: "CLOUDFORMATION_JSON", # required, accepts CLOUDFORMATION_JSON, QUICKSIGHT_JSON
  cloud_formation_override_property_configuration: {
    resource_id_override_configuration: {
      prefix_for_all_resources: false,
    },
    vpc_connections: [
      {
        arn: "Arn", # required
        properties: ["Name"], # required, accepts Name, DnsResolvers, RoleArn
      },
    ],
    refresh_schedules: [
      {
        arn: "Arn", # required
        properties: ["StartAfterDateTime"], # required, accepts StartAfterDateTime
      },
    ],
    data_sources: [
      {
        arn: "Arn", # required
        properties: ["Name"], # required, accepts Name, DisableSsl, SecretArn, Username, Password, Domain, WorkGroup, Host, Port, Database, DataSetName, Catalog, InstanceId, ClusterId, ManifestFileLocation, Warehouse, RoleArn, ProductType
      },
    ],
    data_sets: [
      {
        arn: "Arn", # required
        properties: ["Name"], # required, accepts Name
      },
    ],
    themes: [
      {
        arn: "Arn", # required
        properties: ["Name"], # required, accepts Name
      },
    ],
    analyses: [
      {
        arn: "Arn", # required
        properties: ["Name"], # required, accepts Name
      },
    ],
    dashboards: [
      {
        arn: "Arn", # required
        properties: ["Name"], # required, accepts Name
      },
    ],
  },
  include_permissions: false,
  include_tags: false,
  validation_strategy: {
    strict_mode_for_all_resources: false,
  },
})

Response structure


resp.arn #=> String
resp.asset_bundle_export_job_id #=> 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 Amazon Web Services account to export assets from.

  • :asset_bundle_export_job_id (required, String) —

    The ID of the job. This ID is unique while the job is running. After the job is completed, you can reuse this ID for another job.

  • :resource_arns (required, Array<String>) —

    An array of resource ARNs to export. The following resources are supported.

    • Analysis

    • Dashboard

    • DataSet

    • DataSource

    • RefreshSchedule

    • Theme

    • VPCConnection

    The API caller must have the necessary permissions in their IAM role to access each resource before the resources can be exported.

  • :include_all_dependencies (Boolean) —

    A Boolean that determines whether all dependencies of each resource ARN are recursively exported with the job. For example, say you provided a Dashboard ARN to the ResourceArns parameter. If you set IncludeAllDependencies to TRUE, any theme, dataset, and data source resource that is a dependency of the dashboard is also exported.

  • :export_format (required, String) —

    The export data format.

  • :cloud_formation_override_property_configuration (Types::AssetBundleCloudFormationOverridePropertyConfiguration) —

    An optional collection of structures that generate CloudFormation parameters to override the existing resource property values when the resource is exported to a new CloudFormation template.

    Use this field if the ExportFormat field of a StartAssetBundleExportJobRequest API call is set to CLOUDFORMATION_JSON.

  • :include_permissions (Boolean) —

    A Boolean that determines whether all permissions for each resource ARN are exported with the job. If you set IncludePermissions to TRUE, any permissions associated with each resource are exported.

  • :include_tags (Boolean) —

    A Boolean that determines whether all tags for each resource ARN are exported with the job. If you set IncludeTags to TRUE, any tags associated with each resource are exported.

  • :validation_strategy (Types::AssetBundleExportJobValidationStrategy) —

    An optional parameter that determines which validation strategy to use for the export job. If StrictModeForAllResources is set to TRUE, strict validation for every error is enforced. If it is set to FALSE, validation is skipped for specific UI errors that are shown as warnings. The default value for StrictModeForAllResources is FALSE.

Returns:

See Also:



11635
11636
11637
11638
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 11635

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

#start_asset_bundle_import_job(params = {}) ⇒ Types::StartAssetBundleImportJobResponse

Starts an Asset Bundle import job.

An Asset Bundle import job imports specified Amazon QuickSight assets into an Amazon QuickSight account. You can also choose to import a naming prefix and specified configuration overrides. The assets that are contained in the bundle file that you provide are used to create or update a new or existing asset in your Amazon QuickSight account. Each Amazon QuickSight account can run up to 5 import jobs concurrently.

The API caller must have the necessary "create", "describe", and "update" permissions in their IAM role to access each resource type that is contained in the bundle file before the resources can be imported.

Examples:

Request syntax with placeholder values


resp = client.start_asset_bundle_import_job({
  aws_account_id: "AwsAccountId", # required
  asset_bundle_import_job_id: "ShortRestrictiveResourceId", # required
  asset_bundle_import_source: { # required
    body: "data",
    s3_uri: "S3Uri",
  },
  override_parameters: {
    resource_id_override_configuration: {
      prefix_for_all_resources: "String",
    },
    vpc_connections: [
      {
        vpc_connection_id: "VPCConnectionResourceIdUnrestricted", # required
        name: "ResourceName",
        subnet_ids: ["SubnetId"],
        security_group_ids: ["SecurityGroupId"],
        dns_resolvers: ["IPv4Address"],
        role_arn: "RoleArn",
      },
    ],
    refresh_schedules: [
      {
        data_set_id: "ResourceId", # required
        schedule_id: "String", # required
        start_after_date_time: Time.now,
      },
    ],
    data_sources: [
      {
        data_source_id: "ResourceId", # required
        name: "ResourceName",
        data_source_parameters: {
          amazon_elasticsearch_parameters: {
            domain: "Domain", # required
          },
          athena_parameters: {
            work_group: "WorkGroup",
            role_arn: "RoleArn",
          },
          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
          },
          oracle_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",
            iam_parameters: {
              role_arn: "RoleArn", # required
              database_user: "DatabaseUser",
              database_groups: ["DatabaseGroup"],
              auto_create_database_user: false,
            },
            identity_center_configuration: {
              enable_identity_propagation: false,
            },
          },
          s3_parameters: {
            manifest_file_location: { # required
              bucket: "S3Bucket", # required
              key: "S3Key", # required
            },
            role_arn: "RoleArn",
          },
          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
          },
          amazon_open_search_parameters: {
            domain: "Domain", # required
          },
          exasol_parameters: {
            host: "Host", # required
            port: 1, # required
          },
          databricks_parameters: {
            host: "Host", # required
            port: 1, # required
            sql_endpoint_path: "SqlEndpointPath", # required
          },
          starburst_parameters: {
            host: "Host", # required
            port: 1, # required
            catalog: "Catalog", # required
            product_type: "GALAXY", # accepts GALAXY, ENTERPRISE
          },
          trino_parameters: {
            host: "Host", # required
            port: 1, # required
            catalog: "Catalog", # required
          },
          big_query_parameters: {
            project_id: "ProjectId", # required
            data_set_region: "DataSetRegion",
          },
        },
        vpc_connection_properties: {
          vpc_connection_arn: "Arn", # required
        },
        ssl_properties: {
          disable_ssl: false,
        },
        credentials: {
          credential_pair: {
            username: "DbUsername", # required
            password: "Password", # required
          },
          secret_arn: "SecretArn",
        },
      },
    ],
    data_sets: [
      {
        data_set_id: "ResourceId", # required
        name: "ResourceName",
      },
    ],
    themes: [
      {
        theme_id: "ResourceId", # required
        name: "ResourceName",
      },
    ],
    analyses: [
      {
        analysis_id: "ResourceId", # required
        name: "ResourceName",
      },
    ],
    dashboards: [
      {
        dashboard_id: "ResourceId", # required
        name: "ResourceName",
      },
    ],
  },
  failure_action: "DO_NOTHING", # accepts DO_NOTHING, ROLLBACK
  override_permissions: {
    data_sources: [
      {
        data_source_ids: ["AssetBundleRestrictiveResourceId"], # required
        permissions: { # required
          principals: ["Principal"], # required
          actions: ["String"], # required
        },
      },
    ],
    data_sets: [
      {
        data_set_ids: ["AssetBundleRestrictiveResourceId"], # required
        permissions: { # required
          principals: ["Principal"], # required
          actions: ["String"], # required
        },
      },
    ],
    themes: [
      {
        theme_ids: ["AssetBundleRestrictiveResourceId"], # required
        permissions: { # required
          principals: ["Principal"], # required
          actions: ["String"], # required
        },
      },
    ],
    analyses: [
      {
        analysis_ids: ["AssetBundleRestrictiveResourceId"], # required
        permissions: { # required
          principals: ["Principal"], # required
          actions: ["String"], # required
        },
      },
    ],
    dashboards: [
      {
        dashboard_ids: ["AssetBundleRestrictiveResourceId"], # required
        permissions: {
          principals: ["Principal"], # required
          actions: ["String"], # required
        },
        link_sharing_configuration: {
          permissions: {
            principals: ["Principal"], # required
            actions: ["String"], # required
          },
        },
      },
    ],
  },
  override_tags: {
    vpc_connections: [
      {
        vpc_connection_ids: ["AssetBundleRestrictiveResourceId"], # required
        tags: [ # required
          {
            key: "TagKey", # required
            value: "TagValue", # required
          },
        ],
      },
    ],
    data_sources: [
      {
        data_source_ids: ["AssetBundleRestrictiveResourceId"], # required
        tags: [ # required
          {
            key: "TagKey", # required
            value: "TagValue", # required
          },
        ],
      },
    ],
    data_sets: [
      {
        data_set_ids: ["AssetBundleRestrictiveResourceId"], # required
        tags: [ # required
          {
            key: "TagKey", # required
            value: "TagValue", # required
          },
        ],
      },
    ],
    themes: [
      {
        theme_ids: ["AssetBundleRestrictiveResourceId"], # required
        tags: [ # required
          {
            key: "TagKey", # required
            value: "TagValue", # required
          },
        ],
      },
    ],
    analyses: [
      {
        analysis_ids: ["AssetBundleRestrictiveResourceId"], # required
        tags: [ # required
          {
            key: "TagKey", # required
            value: "TagValue", # required
          },
        ],
      },
    ],
    dashboards: [
      {
        dashboard_ids: ["AssetBundleRestrictiveResourceId"], # required
        tags: [ # required
          {
            key: "TagKey", # required
            value: "TagValue", # required
          },
        ],
      },
    ],
  },
  override_validation_strategy: {
    strict_mode_for_all_resources: false,
  },
})

Response structure


resp.arn #=> String
resp.asset_bundle_import_job_id #=> 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 Amazon Web Services account to import assets into.

  • :asset_bundle_import_job_id (required, String) —

    The ID of the job. This ID is unique while the job is running. After the job is completed, you can reuse this ID for another job.

  • :asset_bundle_import_source (required, Types::AssetBundleImportSource) —

    The source of the asset bundle zip file that contains the data that you want to import. The file must be in QUICKSIGHT_JSON format.

  • :override_parameters (Types::AssetBundleImportJobOverrideParameters) —

    Optional overrides that are applied to the resource configuration before import.

  • :failure_action (String) —

    The failure action for the import job.

    If you choose ROLLBACK, failed import jobs will attempt to undo any asset changes caused by the failed job.

    If you choose DO_NOTHING, failed import jobs will not attempt to roll back any asset changes caused by the failed job, possibly keeping the Amazon QuickSight account in an inconsistent state.

  • :override_permissions (Types::AssetBundleImportJobOverridePermissions) —

    Optional permission overrides that are applied to the resource configuration before import.

  • :override_tags (Types::AssetBundleImportJobOverrideTags) —

    Optional tag overrides that are applied to the resource configuration before import.

  • :override_validation_strategy (Types::AssetBundleImportJobOverrideValidationStrategy) —

    An optional validation strategy override for all analyses and dashboards that is applied to the resource configuration before import.

Returns:

See Also:



12041
12042
12043
12044
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 12041

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

#start_dashboard_snapshot_job(params = {}) ⇒ Types::StartDashboardSnapshotJobResponse

Starts an asynchronous job that generates a snapshot of a dashboard's output. You can request one or several of the following format configurations in each API call.

  • 1 Paginated PDF

  • 1 Excel workbook that includes up to 5 table or pivot table visuals

  • 5 CSVs from table or pivot table visuals

The status of a submitted job can be polled with the DescribeDashboardSnapshotJob API. When you call the DescribeDashboardSnapshotJob API, check the JobStatus field in the response. Once the job reaches a COMPLETED or FAILED status, use the DescribeDashboardSnapshotJobResult API to obtain the URLs for the generated files. If the job fails, the DescribeDashboardSnapshotJobResult API returns detailed information about the error that occurred.

StartDashboardSnapshotJob API throttling

Amazon QuickSight utilizes API throttling to create a more consistent user experience within a time span for customers when they call the StartDashboardSnapshotJob. By default, 12 jobs can run simlutaneously in one Amazon Web Services account and users can submit up 10 API requests per second before an account is throttled. If an overwhelming number of API requests are made by the same user in a short period of time, Amazon QuickSight throttles the API calls to maintin an optimal experience and reliability for all Amazon QuickSight users.

Common throttling scenarios

The following list provides information about the most commin throttling scenarios that can occur.

  • A large number of SnapshotExport API jobs are running simultaneously on an Amazon Web Services account. When a new StartDashboardSnapshotJob is created and there are already 12 jobs with the RUNNING status, the new job request fails and returns a LimitExceededException error. Wait for a current job to comlpete before you resubmit the new job.

  • A large number of API requests are submitted on an Amazon Web Services account. When a user makes more than 10 API calls to the Amazon QuickSight API in one second, a ThrottlingException is returned.

If your use case requires a higher throttling limit, contact your account admin or Amazon Web ServicesSupport to explore options to tailor a more optimal expereince for your account.

Best practices to handle throttling

If your use case projects high levels of API traffic, try to reduce the degree of frequency and parallelism of API calls as much as you can to avoid throttling. You can also perform a timing test to calculate an estimate for the total processing time of your projected load that stays within the throttling limits of the Amazon QuickSight APIs. For example, if your projected traffic is 100 snapshot jobs before 12:00 PM per day, start 12 jobs in parallel and measure the amount of time it takes to proccess all 12 jobs. Once you obtain the result, multiply the duration by 9, for example (12 minutes * 9 = 108 minutes). Use the new result to determine the latest time at which the jobs need to be started to meet your target deadline.

The time that it takes to process a job can be impacted by the following factors:

  • The dataset type (Direct Query or SPICE).

  • The size of the dataset.

  • The complexity of the calculated fields that are used in the dashboard.

  • The number of visuals that are on a sheet.

  • The types of visuals that are on the sheet.

  • The number of formats and snapshots that are requested in the job configuration.

  • The size of the generated snapshots.

Examples:

Request syntax with placeholder values


resp = client.start_dashboard_snapshot_job({
  aws_account_id: "AwsAccountId", # required
  dashboard_id: "ShortRestrictiveResourceId", # required
  snapshot_job_id: "ShortRestrictiveResourceId", # required
  user_configuration: { # required
    anonymous_users: [
      {
        row_level_permission_tags: [
          {
            key: "SessionTagKey", # required
            value: "SessionTagValue", # required
          },
        ],
      },
    ],
  },
  snapshot_configuration: { # required
    file_groups: [ # required
      {
        files: [
          {
            sheet_selections: [ # required
              {
                sheet_id: "ShortRestrictiveResourceId", # required
                selection_scope: "ALL_VISUALS", # required, accepts ALL_VISUALS, SELECTED_VISUALS
                visual_ids: ["ShortRestrictiveResourceId"],
              },
            ],
            format_type: "CSV", # required, accepts CSV, PDF, EXCEL
          },
        ],
      },
    ],
    destination_configuration: {
      s3_destinations: [
        {
          bucket_configuration: { # required
            bucket_name: "NonEmptyString", # required
            bucket_prefix: "NonEmptyString", # required
            bucket_region: "NonEmptyString", # required
          },
        },
      ],
    },
    parameters: {
      string_parameters: [
        {
          name: "NonEmptyString", # required
          values: ["SensitiveString"], # 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
        },
      ],
    },
  },
})

Response structure


resp.arn #=> String
resp.snapshot_job_id #=> 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 Amazon Web Services account that the dashboard snapshot job is executed in.

  • :dashboard_id (required, String) —

    The ID of the dashboard that you want to start a snapshot job for.

  • :snapshot_job_id (required, String) —

    An ID for the dashboard snapshot job. This ID is unique to the dashboard while the job is running. This ID can be used to poll the status of a job with a DescribeDashboardSnapshotJob while the job runs. You can reuse this ID for another job 24 hours after the current job is completed.

  • :user_configuration (required, Types::SnapshotUserConfiguration) —

    A structure that contains information about the anonymous users that the generated snapshot is for. This API will not return information about registered Amazon QuickSight.

  • :snapshot_configuration (required, Types::SnapshotConfiguration) —

    A structure that describes the configuration of the dashboard snapshot.

Returns:

See Also:



12251
12252
12253
12254
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 12251

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

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

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

Tags can help you organize and categorize your resources. You can also use them to scope user permissions, by granting a user permission to access or change only resources with certain tag values. You can use the TagResource operation with a resource that already has tags. If you specify a new tag key for the resource, this tag is appended to the list of tags associated with the resource. If you specify a tag key that is already associated with the resource, the new tag value that you specify replaces the previous value for that tag.

You can associate as many as 50 tags with a resource. Amazon QuickSight supports tagging on data set, data source, dashboard, template, topic, and user.

Tagging for Amazon QuickSight works in a similar way to tagging for other Amazon Web Services services, except for the following:

  • Tags are used to track costs for users in Amazon QuickSight. You can't tag other resources that Amazon QuickSight costs are based on, such as storage capacoty (SPICE), session usage, alert consumption, or reporting units.

  • Amazon QuickSight doesn't currently support the tag editor for 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:



12316
12317
12318
12319
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 12316

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:



12351
12352
12353
12354
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 12351

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

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

Updates Amazon QuickSight customizations for the current Amazon Web Services Region. Currently, the only customization that you can use is a theme.

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

Examples:

Request syntax with placeholder values


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

Response structure


resp.arn #=> String
resp. #=> String
resp.namespace #=> String
resp..default_theme #=> String
resp..default_email_customization_template #=> 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 Amazon Web Services account that you want to update Amazon QuickSight customizations for.

  • :namespace (String) —

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

  • :account_customization (required, Types::AccountCustomization) —

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

Returns:

See Also:



12413
12414
12415
12416
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 12413

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

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

Updates the Amazon QuickSight settings in your Amazon Web Services account.

Examples:

Request syntax with placeholder values


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

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 Amazon Web Services account that contains the Amazon QuickSight settings that you want to list.

  • :default_namespace (required, String) —

    The default namespace for this Amazon Web Services account. Currently, the default is default. IAM users that register for the first time with Amazon QuickSight provide an email address that becomes associated with the default namespace.

  • :notification_email (String) —

    The email address that you want Amazon QuickSight to send notifications to regarding your Amazon Web Services account or Amazon QuickSight subscription.

  • :termination_protection_enabled (Boolean) —

    A boolean value that determines whether or not an Amazon QuickSight account can be deleted. A True value doesn't allow the account to be deleted and results in an error message if a user tries to make a DeleteAccountSubscription request. A False value will allow the account to be deleted.

Returns:

See Also:



12466
12467
12468
12469
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 12466

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

#update_analysis(params = {}) ⇒ Types::UpdateAnalysisResponse

Updates an analysis in Amazon QuickSight

Examples:

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :aws_account_id (required, String) —

    The ID of the Amazon Web Services account that contains the analysis that you're updating.

  • :analysis_id (required, String) —

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

  • :name (required, String) —

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

  • :parameters (Types::Parameters) —

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

  • :source_entity (Types::AnalysisSourceEntity) —

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

  • :theme_arn (String) —

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

  • :definition (Types::AnalysisDefinition) —

    The definition of an analysis.

    A definition is the data model of all features in a Dashboard, Template, or Analysis.

  • :validation_strategy (Types::ValidationStrategy) —

    The option to relax the validation needed to update an analysis with definition objects. This skips the validation step for specific errors.

Returns:

See Also:



12531
12532
12533
12534
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 12531

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

#update_analysis_permissions(params = {}) ⇒ Types::UpdateAnalysisPermissionsResponse

Updates the read and write permissions for an analysis.

Examples:

Request syntax with placeholder values


resp = client.update_analysis_permissions({
  aws_account_id: "AwsAccountId", # required
  analysis_id: "ShortRestrictiveResourceId", # required
  grant_permissions: [
    {
      principal: "Principal", # required
      actions: ["String"], # required
    },
  ],
  revoke_permissions: [
    {
      principal: "Principal", # required
      actions: ["String"], # required
    },
  ],
})

Response structure


resp.analysis_arn #=> String
resp.analysis_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 Amazon Web Services account that contains the analysis whose permissions you're updating. You must be using the Amazon Web Services account that the analysis is in.

  • :analysis_id (required, String) —

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

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

    A structure that describes the permissions to add and the principal to add them to.

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

    A structure that describes the permissions to remove and the principal to remove them from.

Returns:

See Also:



12597
12598
12599
12600
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 12597

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

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

Updates a dashboard in an Amazon Web Services account.

Updating a Dashboard creates a new dashboard version but does not immediately publish the new version. You can update the published version of a dashboard by using the UpdateDashboardPublishedVersion API operation.

Examples:

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", "DELETED"
resp.status #=> Integer
resp.request_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :aws_account_id (required, String) —

    The ID of the Amazon Web Services 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 (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 Amazon Web Services account and any Amazon QuickSight-supported Amazon Web Services Region.

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

  • :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, Amazon QuickSight disables the left filter pane on the published dashboard, which can be used for ad hoc (one-time) filtering. This option is ENABLED by default.

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

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

  • :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 Amazon Web Services account where you create the dashboard.

  • :definition (Types::DashboardVersionDefinition) —

    The definition of a dashboard.

    A definition is the data model of all features in a Dashboard, Template, or Analysis.

  • :validation_strategy (Types::ValidationStrategy) —

    The option to relax the validation needed to update a dashboard with definition objects. This skips the validation step for specific errors.

Returns:

See Also:



12702
12703
12704
12705
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 12702

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

#update_dashboard_links(params = {}) ⇒ Types::UpdateDashboardLinksResponse

Updates the linked analyses on a dashboard.

Examples:

Request syntax with placeholder values


resp = client.update_dashboard_links({
  aws_account_id: "AwsAccountId", # required
  dashboard_id: "ShortRestrictiveResourceId", # required
  link_entities: ["LinkEntityArn"], # required
})

Response structure


resp.request_id #=> String
resp.status #=> Integer
resp.dashboard_arn #=> String
resp.link_entities #=> Array
resp.link_entities[0] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :aws_account_id (required, String) —

    The ID of the Amazon Web Services account that contains the dashboard whose links you want to update.

  • :dashboard_id (required, String) —

    The ID for the dashboard.

  • :link_entities (required, Array<String>) —

    list of analysis Amazon Resource Names (ARNs) to be linked to the dashboard.

Returns:

See Also:



12747
12748
12749
12750
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 12747

def update_dashboard_links(params = {}, options = {})
  req = build_request(:update_dashboard_links, 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: "ShortRestrictiveResourceId", # required
  grant_permissions: [
    {
      principal: "Principal", # required
      actions: ["String"], # required
    },
  ],
  revoke_permissions: [
    {
      principal: "Principal", # required
      actions: ["String"], # required
    },
  ],
  grant_link_permissions: [
    {
      principal: "Principal", # required
      actions: ["String"], # required
    },
  ],
  revoke_link_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
resp.link_sharing_configuration.permissions #=> Array
resp.link_sharing_configuration.permissions[0].principal #=> String
resp.link_sharing_configuration.permissions[0].actions #=> Array
resp.link_sharing_configuration.permissions[0].actions[0] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :aws_account_id (required, String) —

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

  • :grant_link_permissions (Array<Types::ResourcePermission>) —

    Grants link permissions to all users in a defined namespace.

  • :revoke_link_permissions (Array<Types::ResourcePermission>) —

    Revokes link permissions from all users in a defined namespace.

Returns:

See Also:



12832
12833
12834
12835
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 12832

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

#update_dashboard_published_version(params = {}) ⇒ Types::UpdateDashboardPublishedVersionResponse

Updates the published version of a dashboard.

Examples:

Request syntax with placeholder values


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

Response structure


resp.dashboard_id #=> String
resp.dashboard_arn #=> 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 Amazon Web Services account that contains the dashboard that you're updating.

  • :dashboard_id (required, String) —

    The ID for the dashboard.

  • :version_number (required, Integer) —

    The version number of the dashboard.

Returns:

See Also:



12875
12876
12877
12878
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 12875

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

#update_data_set(params = {}) ⇒ Types::UpdateDataSetResponse

Updates a dataset. This operation doesn't support datasets that include uploaded files as a source. Partial updates are not supported by this operation.

Examples:

Request syntax with placeholder values


resp = client.update_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
        catalog: "RelationalTableCatalog",
        schema: "RelationalTableSchema",
        name: "RelationalTableName", # required
        input_columns: [ # required
          {
            name: "ColumnName", # required
            type: "STRING", # required, accepts STRING, INTEGER, DECIMAL, DATETIME, BIT, BOOLEAN, JSON
            sub_type: "FLOAT", # accepts FLOAT, FIXED
          },
        ],
      },
      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
            sub_type: "FLOAT", # accepts FLOAT, FIXED
          },
        ],
      },
      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
            sub_type: "FLOAT", # accepts FLOAT, FIXED
          },
        ],
      },
    },
  },
  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: "DataSetCalculatedFieldExpression", # 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
            sub_type: "FLOAT", # accepts FLOAT, FIXED
            format: "TypeCastFormat",
          },
          tag_column_operation: {
            column_name: "ColumnName", # required
            tags: [ # required
              {
                column_geographic_role: "COUNTRY", # accepts COUNTRY, STATE, COUNTY, CITY, POSTCODE, LONGITUDE, LATITUDE
                column_description: {
                  text: "ColumnDescriptiveText",
                },
              },
            ],
          },
          untag_column_operation: {
            column_name: "ColumnName", # required
            tag_names: ["COLUMN_GEOGRAPHIC_ROLE"], # required, accepts COLUMN_GEOGRAPHIC_ROLE, COLUMN_DESCRIPTION
          },
          override_dataset_parameter_operation: {
            parameter_name: "DatasetParameterName", # required
            new_parameter_name: "DatasetParameterName",
            new_default_values: {
              string_static_values: ["StringDatasetParameterDefaultValue"],
              decimal_static_values: [1.0],
              date_time_static_values: [Time.now],
              integer_static_values: [1],
            },
          },
        },
      ],
      source: { # required
        join_instruction: {
          left_operand: "LogicalTableId", # required
          right_operand: "LogicalTableId", # required
          left_join_key_properties: {
            unique_key: false,
          },
          right_join_key_properties: {
            unique_key: false,
          },
          type: "INNER", # required, accepts INNER, OUTER, LEFT, RIGHT
          on_clause: "OnClause", # required
        },
        physical_table_id: "PhysicalTableId",
        data_set_arn: "Arn",
      },
    },
  },
  import_mode: "SPICE", # required, accepts SPICE, DIRECT_QUERY
  column_groups: [
    {
      geo_spatial_column_group: {
        name: "ColumnGroupName", # required
        country_code: "US", # accepts US
        columns: ["ColumnName"], # required
      },
    },
  ],
  field_folders: {
    "FieldFolderPath" => {
      description: "FieldFolderDescription",
      columns: ["String"],
    },
  },
  row_level_permission_data_set: {
    namespace: "Namespace",
    arn: "Arn", # required
    permission_policy: "GRANT_ACCESS", # required, accepts GRANT_ACCESS, DENY_ACCESS
    format_version: "VERSION_1", # accepts VERSION_1, VERSION_2
    status: "ENABLED", # accepts ENABLED, DISABLED
  },
  row_level_permission_tag_configuration: {
    status: "ENABLED", # accepts ENABLED, DISABLED
    tag_rules: [ # required
      {
        tag_key: "SessionTagKey", # required
        column_name: "String", # required
        tag_multi_value_delimiter: "RowLevelPermissionTagDelimiter",
        match_all_value: "SessionTagValue",
      },
    ],
    tag_rule_configurations: [
      ["SessionTagKey"],
    ],
  },
  column_level_permission_rules: [
    {
      principals: ["String"],
      column_names: ["String"],
    },
  ],
  data_set_usage_configuration: {
    disable_use_as_direct_query_source: false,
    disable_use_as_imported_source: false,
  },
  dataset_parameters: [
    {
      string_dataset_parameter: {
        id: "DatasetParameterId", # required
        name: "DatasetParameterName", # required
        value_type: "MULTI_VALUED", # required, accepts MULTI_VALUED, SINGLE_VALUED
        default_values: {
          static_values: ["StringDatasetParameterDefaultValue"],
        },
      },
      decimal_dataset_parameter: {
        id: "DatasetParameterId", # required
        name: "DatasetParameterName", # required
        value_type: "MULTI_VALUED", # required, accepts MULTI_VALUED, SINGLE_VALUED
        default_values: {
          static_values: [1.0],
        },
      },
      integer_dataset_parameter: {
        id: "DatasetParameterId", # required
        name: "DatasetParameterName", # required
        value_type: "MULTI_VALUED", # required, accepts MULTI_VALUED, SINGLE_VALUED
        default_values: {
          static_values: [1],
        },
      },
      date_time_dataset_parameter: {
        id: "DatasetParameterId", # required
        name: "DatasetParameterName", # required
        value_type: "MULTI_VALUED", # required, accepts MULTI_VALUED, SINGLE_VALUED
        time_granularity: "YEAR", # accepts YEAR, QUARTER, MONTH, WEEK, DAY, HOUR, MINUTE, SECOND, MILLISECOND
        default_values: {
          static_values: [Time.now],
        },
      },
    },
  ],
})

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

  • :data_set_id (required, String) —

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

  • :name (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 Amazon QuickSight features. Currently, only geospatial hierarchy is supported.

  • :field_folders (Hash<String,Types::FieldFolder>) —

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

  • :row_level_permission_data_set (Types::RowLevelPermissionDataSet) —

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

  • :row_level_permission_tag_configuration (Types::RowLevelPermissionTagConfiguration) —

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

  • :column_level_permission_rules (Array<Types::ColumnLevelPermissionRule>) —

    A set of one or more definitions of a ColumnLevelPermissionRule.

  • :data_set_usage_configuration (Types::DataSetUsageConfiguration) —

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

  • :dataset_parameters (Array<Types::DatasetParameter>) —

    The parameter declarations of the dataset.

Returns:

See Also:



13166
13167
13168
13169
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 13166

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

#update_data_set_permissions(params = {}) ⇒ Types::UpdateDataSetPermissionsResponse

Updates 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.update_data_set_permissions({
  aws_account_id: "AwsAccountId", # required
  data_set_id: "ResourceId", # required
  grant_permissions: [
    {
      principal: "Principal", # required
      actions: ["String"], # required
    },
  ],
  revoke_permissions: [
    {
      principal: "Principal", # required
      actions: ["String"], # required
    },
  ],
})

Response structure


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

  • :data_set_id (required, String) —

    The ID for the dataset whose permissions you want to update. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

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

    The resource permissions that you want to grant to the dataset.

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

    The resource permissions that you want to revoke from the dataset.

Returns:

See Also:



13227
13228
13229
13230
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 13227

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

#update_data_source(params = {}) ⇒ Types::UpdateDataSourceResponse

Updates a data source.

Examples:

Request syntax with placeholder values


resp = client.update_data_source({
  aws_account_id: "AwsAccountId", # required
  data_source_id: "ResourceId", # required
  name: "ResourceName", # required
  data_source_parameters: {
    amazon_elasticsearch_parameters: {
      domain: "Domain", # required
    },
    athena_parameters: {
      work_group: "WorkGroup",
      role_arn: "RoleArn",
    },
    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
    },
    oracle_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",
      iam_parameters: {
        role_arn: "RoleArn", # required
        database_user: "DatabaseUser",
        database_groups: ["DatabaseGroup"],
        auto_create_database_user: false,
      },
      identity_center_configuration: {
        enable_identity_propagation: false,
      },
    },
    s3_parameters: {
      manifest_file_location: { # required
        bucket: "S3Bucket", # required
        key: "S3Key", # required
      },
      role_arn: "RoleArn",
    },
    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
    },
    amazon_open_search_parameters: {
      domain: "Domain", # required
    },
    exasol_parameters: {
      host: "Host", # required
      port: 1, # required
    },
    databricks_parameters: {
      host: "Host", # required
      port: 1, # required
      sql_endpoint_path: "SqlEndpointPath", # required
    },
    starburst_parameters: {
      host: "Host", # required
      port: 1, # required
      catalog: "Catalog", # required
      product_type: "GALAXY", # accepts GALAXY, ENTERPRISE
    },
    trino_parameters: {
      host: "Host", # required
      port: 1, # required
      catalog: "Catalog", # required
    },
    big_query_parameters: {
      project_id: "ProjectId", # required
      data_set_region: "DataSetRegion",
    },
  },
  credentials: {
    credential_pair: {
      username: "DbUsername", # required
      password: "Password", # required
      alternate_data_source_parameters: [
        {
          amazon_elasticsearch_parameters: {
            domain: "Domain", # required
          },
          athena_parameters: {
            work_group: "WorkGroup",
            role_arn: "RoleArn",
          },
          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
          },
          oracle_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",
            iam_parameters: {
              role_arn: "RoleArn", # required
              database_user: "DatabaseUser",
              database_groups: ["DatabaseGroup"],
              auto_create_database_user: false,
            },
            identity_center_configuration: {
              enable_identity_propagation: false,
            },
          },
          s3_parameters: {
            manifest_file_location: { # required
              bucket: "S3Bucket", # required
              key: "S3Key", # required
            },
            role_arn: "RoleArn",
          },
          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
          },
          amazon_open_search_parameters: {
            domain: "Domain", # required
          },
          exasol_parameters: {
            host: "Host", # required
            port: 1, # required
          },
          databricks_parameters: {
            host: "Host", # required
            port: 1, # required
            sql_endpoint_path: "SqlEndpointPath", # required
          },
          starburst_parameters: {
            host: "Host", # required
            port: 1, # required
            catalog: "Catalog", # required
            product_type: "GALAXY", # accepts GALAXY, ENTERPRISE
          },
          trino_parameters: {
            host: "Host", # required
            port: 1, # required
            catalog: "Catalog", # required
          },
          big_query_parameters: {
            project_id: "ProjectId", # required
            data_set_region: "DataSetRegion",
          },
        },
      ],
    },
    copy_source_arn: "CopySourceArn",
    secret_arn: "SecretArn",
  },
  vpc_connection_properties: {
    vpc_connection_arn: "Arn", # required
  },
  ssl_properties: {
    disable_ssl: false,
  },
})

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :aws_account_id (required, String) —

    The Amazon Web Services account ID.

  • :data_source_id (required, String) —

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

  • :name (required, String) —

    A display name for the data source.

  • :data_source_parameters (Types::DataSourceParameters) —

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

  • :credentials (Types::DataSourceCredentials) —

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

  • :vpc_connection_properties (Types::VpcConnectionProperties) —

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

  • :ssl_properties (Types::SslProperties) —

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

Returns:

See Also:



13563
13564
13565
13566
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 13563

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

#update_data_source_permissions(params = {}) ⇒ Types::UpdateDataSourcePermissionsResponse

Updates the permissions to a data source.

Examples:

Request syntax with placeholder values


resp = client.update_data_source_permissions({
  aws_account_id: "AwsAccountId", # required
  data_source_id: "ResourceId", # required
  grant_permissions: [
    {
      principal: "Principal", # required
      actions: ["String"], # required
    },
  ],
  revoke_permissions: [
    {
      principal: "Principal", # required
      actions: ["String"], # required
    },
  ],
})

Response structure


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

  • :data_source_id (required, String) —

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

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

    A list of resource permissions that you want to grant on the data source.

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

    A list of resource permissions that you want to revoke on the data source.

Returns:

See Also:



13622
13623
13624
13625
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 13622

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

#update_folder(params = {}) ⇒ Types::UpdateFolderResponse

Updates the name of a folder.

Examples:

Request syntax with placeholder values


resp = client.update_folder({
  aws_account_id: "AwsAccountId", # required
  folder_id: "RestrictiveResourceId", # required
  name: "FolderName", # required
})

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :aws_account_id (required, String) —

    The ID for the Amazon Web Services account that contains the folder to update.

  • :folder_id (required, String) —

    The ID of the folder.

  • :name (required, String) —

    The name of the folder.

Returns:

See Also:



13665
13666
13667
13668
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 13665

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

#update_folder_permissions(params = {}) ⇒ Types::UpdateFolderPermissionsResponse

Updates permissions of a folder.

Examples:

Request syntax with placeholder values


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

Response structure


resp.status #=> Integer
resp.arn #=> String
resp.folder_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

Parameters:

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

    ({})

Options Hash (params):

  • :aws_account_id (required, String) —

    The ID for the Amazon Web Services account that contains the folder to update.

  • :folder_id (required, String) —

    The ID of the folder.

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

    The permissions that you want to grant on a resource. Namespace ARNs are not supported Principal values for folder permissions.

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

    The permissions that you want to revoke from a resource. Namespace ARNs are not supported Principal values for folder permissions.

Returns:

See Also:



13729
13730
13731
13732
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 13729

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

#update_group(params = {}) ⇒ Types::UpdateGroupResponse

Changes a group description.

Examples:

Request syntax with placeholder values


resp = client.update_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) —

    The name of the group that you want to update.

  • :description (String) —

    The description for the group that you want to update.

  • :aws_account_id (required, String) —

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

  • :namespace (required, String) —

    The namespace of the group that you want to update.

Returns:

See Also:



13778
13779
13780
13781
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 13778

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

#update_iam_policy_assignment(params = {}) ⇒ Types::UpdateIAMPolicyAssignmentResponse

Updates an existing IAM policy assignment. This operation updates only the optional parameter or parameters that are specified in the request. This overwrites all of the users included in Identities.

Examples:

Request syntax with placeholder values


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

Response structure


resp.assignment_name #=> String
resp.assignment_id #=> String
resp.policy_arn #=> String
resp.identities #=> Hash
resp.identities["String"] #=> Array
resp.identities["String"][0] #=> String
resp.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 Amazon Web Services account that contains the IAM policy assignment.

  • :assignment_name (required, String) —

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

  • :namespace (required, String) —

    The namespace of the assignment.

  • :assignment_status (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 Amazon QuickSight users and groups specified in this assignment.

  • :identities (Hash<String,Array>) —

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

Returns:

See Also:



13857
13858
13859
13860
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 13857

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

#update_identity_propagation_config(params = {}) ⇒ Types::UpdateIdentityPropagationConfigResponse

Adds or updates services and authorized targets to configure what the Amazon QuickSight IAM Identity Center application can access.

This operation is only supported for Amazon QuickSight accounts using IAM Identity Center

Examples:

Request syntax with placeholder values


resp = client.update_identity_propagation_config({
  aws_account_id: "AwsAccountId", # required
  service: "REDSHIFT", # required, accepts REDSHIFT
  authorized_targets: ["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 of the Amazon Web Services account that contains the identity propagation configuration that you want to update.

  • :service (required, String) —

    The name of the Amazon Web Services service that contains the authorized targets that you want to add or update.

  • :authorized_targets (Array<String>) —

    Specifies a list of application ARNs that represent the authorized targets for a service.

Returns:

See Also:



13902
13903
13904
13905
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 13902

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

#update_ip_restriction(params = {}) ⇒ Types::UpdateIpRestrictionResponse

Updates the content and status of IP rules. Traffic from a source is allowed when the source satisfies either the IpRestrictionRule, VpcIdRestrictionRule, or VpcEndpointIdRestrictionRule. To use this operation, you must provide the entire map of rules. You can use the DescribeIpRestriction operation to get the current rule map.

Examples:

Request syntax with placeholder values


resp = client.update_ip_restriction({
  aws_account_id: "AwsAccountId", # required
  ip_restriction_rule_map: {
    "CIDR" => "IpRestrictionRuleDescription",
  },
  vpc_id_restriction_rule_map: {
    "VpcId" => "VpcIdRestrictionRuleDescription",
  },
  vpc_endpoint_id_restriction_rule_map: {
    "VpcEndpointId" => "VpcEndpointIdRestrictionRuleDescription",
  },
  enabled: false,
})

Response structure


resp. #=> 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 Amazon Web Services account that contains the IP rules.

  • :ip_restriction_rule_map (Hash<String,String>) —

    A map that describes the updated IP rules with CIDR ranges and descriptions.

  • :vpc_id_restriction_rule_map (Hash<String,String>) —

    A map of VPC IDs and their corresponding rules. When you configure this parameter, traffic from all VPC endpoints that are present in the specified VPC is allowed.

  • :vpc_endpoint_id_restriction_rule_map (Hash<String,String>) —

    A map of allowed VPC endpoint IDs and their corresponding rule descriptions.

  • :enabled (Boolean) —

    A value that specifies whether IP rules are turned on.

Returns:

See Also:



13964
13965
13966
13967
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 13964

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

#update_key_registration(params = {}) ⇒ Types::UpdateKeyRegistrationResponse

Updates a customer managed key in a Amazon QuickSight account.

Examples:

Request syntax with placeholder values


resp = client.update_key_registration({
  aws_account_id: "AwsAccountId", # required
  key_registration: [ # required
    {
      key_arn: "String",
      default_key: false,
    },
  ],
})

Response structure


resp.failed_key_registration #=> Array
resp.failed_key_registration[0].key_arn #=> String
resp.failed_key_registration[0].message #=> String
resp.failed_key_registration[0].status_code #=> Integer
resp.failed_key_registration[0].sender_fault #=> Boolean
resp.successful_key_registration #=> Array
resp.successful_key_registration[0].key_arn #=> String
resp.successful_key_registration[0].status_code #=> Integer
resp.request_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :aws_account_id (required, String) —

    The ID of the Amazon Web Services account that contains the customer managed key registration that you want to update.

  • :key_registration (required, Array<Types::RegisteredCustomerManagedKey>) —

    A list of RegisteredCustomerManagedKey objects to be updated to the Amazon QuickSight account.

Returns:

See Also:



14013
14014
14015
14016
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 14013

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

#update_public_sharing_settings(params = {}) ⇒ Types::UpdatePublicSharingSettingsResponse

Use the UpdatePublicSharingSettings operation to turn on or turn off the public sharing settings of an Amazon QuickSight dashboard.

To use this operation, turn on session capacity pricing for your Amazon QuickSight account.

Before you can turn on public sharing on your account, make sure to give public sharing permissions to an administrative user in the Identity and Access Management (IAM) console. For more information on using IAM with Amazon QuickSight, see Using Amazon QuickSight with IAM in the Amazon QuickSight User Guide.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :aws_account_id (required, String) —

    The Amazon Web Services account ID associated with your Amazon QuickSight subscription.

  • :public_sharing_enabled (Boolean) —

    A Boolean value that indicates whether public sharing is turned on for an Amazon QuickSight account.

Returns:

See Also:



14063
14064
14065
14066
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 14063

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

#update_refresh_schedule(params = {}) ⇒ Types::UpdateRefreshScheduleResponse

Updates a refresh schedule for a dataset.

Examples:

Request syntax with placeholder values


resp = client.update_refresh_schedule({
  data_set_id: "ResourceId", # required
  aws_account_id: "AwsAccountId", # required
  schedule: { # required
    schedule_id: "String", # required
    schedule_frequency: { # required
      interval: "MINUTE15", # required, accepts MINUTE15, MINUTE30, HOURLY, DAILY, WEEKLY, MONTHLY
      refresh_on_day: {
        day_of_week: "SUNDAY", # accepts SUNDAY, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY
        day_of_month: "DayOfMonth",
      },
      timezone: "String",
      time_of_the_day: "String",
    },
    start_after_date_time: Time.now,
    refresh_type: "INCREMENTAL_REFRESH", # required, accepts INCREMENTAL_REFRESH, FULL_REFRESH
    arn: "Arn",
  },
})

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :data_set_id (required, String) —

    The ID of the dataset.

  • :aws_account_id (required, String) —

    The Amazon Web Services account ID.

  • :schedule (required, Types::RefreshSchedule) —

    The refresh schedule.

Returns:

See Also:



14119
14120
14121
14122
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 14119

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

#update_role_custom_permission(params = {}) ⇒ Types::UpdateRoleCustomPermissionResponse

Updates the custom permissions that are associated with a role.

Examples:

Request syntax with placeholder values


resp = client.update_role_custom_permission({
  custom_permissions_name: "RoleName", # required
  role: "ADMIN", # required, accepts ADMIN, AUTHOR, READER, ADMIN_PRO, AUTHOR_PRO, READER_PRO
  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):

  • :custom_permissions_name (required, String) —

    The name of the custom permission that you want to update the role with.

  • :role (required, String) —

    The name of role tht you want to update.

  • :aws_account_id (required, String) —

    The ID for the Amazon Web Services account that you want to create a group in. The Amazon Web Services account ID that you provide must be the same Amazon Web Services account that contains your Amazon QuickSight account.

  • :namespace (required, String) —

    The namespace that contains the role that you want to update.

Returns:

See Also:



14165
14166
14167
14168
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 14165

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

#update_spice_capacity_configuration(params = {}) ⇒ Types::UpdateSPICECapacityConfigurationResponse

Updates the SPICE capacity configuration for a Amazon QuickSight account.

Examples:

Request syntax with placeholder values


resp = client.update_spice_capacity_configuration({
  aws_account_id: "AwsAccountId", # required
  purchase_mode: "MANUAL", # required, accepts MANUAL, AUTO_PURCHASE
})

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :aws_account_id (required, String) —

    The ID of the Amazon Web Services account that contains the SPICE configuration that you want to update.

  • :purchase_mode (required, String) —

    Determines how SPICE capacity can be purchased. The following options are available.

    • MANUAL: SPICE capacity can only be purchased manually.

    • AUTO_PURCHASE: Extra SPICE capacity is automatically purchased on your behalf as needed. SPICE capacity can also be purchased manually with this option.

Returns:

See Also:



14208
14209
14210
14211
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 14208

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

#update_template(params = {}) ⇒ Types::UpdateTemplateResponse

Updates a template from an existing Amazon QuickSight analysis or another template.

Examples:

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :aws_account_id (required, String) —

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

  • :template_id (required, String) —

    The ID for the template.

  • :source_entity (Types::TemplateSourceEntity) —

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

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

  • :version_description (String) —

    A description of the current template version that is being updated. Every time you call UpdateTemplate, you create a new version of the template. Each version of the template maintains a description of the version in the VersionDescription field.

  • :name (String) —

    The name for the template.

  • :definition (Types::TemplateVersionDefinition) —

    The definition of a template.

    A definition is the data model of all features in a Dashboard, Template, or Analysis.

  • :validation_strategy (Types::ValidationStrategy) —

    The option to relax the validation needed to update a template with definition objects. This skips the validation step for specific errors.

Returns:

See Also:



14280
14281
14282
14283
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 14280

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

#update_template_alias(params = {}) ⇒ Types::UpdateTemplateAliasResponse

Updates the template alias of a template.

Examples:

Request syntax with placeholder values


resp = client.update_template_alias({
  aws_account_id: "AwsAccountId", # required
  template_id: "ShortRestrictiveResourceId", # 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 Amazon Web Services account that contains the template alias that you're updating.

  • :template_id (required, String) —

    The ID for the template.

  • :alias_name (required, String) —

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

  • :template_version_number (required, Integer) —

    The version number of the template.

Returns:

See Also:



14331
14332
14333
14334
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 14331

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

#update_template_permissions(params = {}) ⇒ Types::UpdateTemplatePermissionsResponse

Updates the resource permissions for a template.

Examples:

Request syntax with placeholder values


resp = client.update_template_permissions({
  aws_account_id: "AwsAccountId", # required
  template_id: "ShortRestrictiveResourceId", # required
  grant_permissions: [
    {
      principal: "Principal", # required
      actions: ["String"], # required
    },
  ],
  revoke_permissions: [
    {
      principal: "Principal", # required
      actions: ["String"], # 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 Amazon Web Services account that contains the template.

  • :template_id (required, String) —

    The ID for the template.

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

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

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

    A list of resource permissions to be revoked from the template.

Returns:

See Also:



14392
14393
14394
14395
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 14392

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

#update_theme(params = {}) ⇒ Types::UpdateThemeResponse

Updates a theme.

Examples:

Request syntax with placeholder values


resp = client.update_theme({
  aws_account_id: "AwsAccountId", # required
  theme_id: "ShortRestrictiveResourceId", # required
  name: "ThemeName",
  base_theme_id: "ShortRestrictiveResourceId", # required
  version_description: "VersionDescription",
  configuration: {
    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,
        },
      },
    },
    typography: {
      font_families: [
        {
          font_family: "String",
        },
      ],
    },
  },
})

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :aws_account_id (required, String) —

    The ID of the Amazon Web Services account that contains the theme that you're updating.

  • :theme_id (required, String) —

    The ID for the theme.

  • :name (String) —

    The name for the theme.

  • :base_theme_id (required, String) —

    The theme ID, defined by Amazon QuickSight, that a custom theme inherits from. All themes initially inherit from a default Amazon QuickSight theme.

  • :version_description (String) —

    A description of the theme version that you're updating Every time that you call UpdateTheme, you create a new version of the theme. Each version of the theme maintains a description of the version in VersionDescription.

  • :configuration (Types::ThemeConfiguration) —

    The theme configuration, which contains the theme display properties.

Returns:

See Also:



14502
14503
14504
14505
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 14502

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

#update_theme_alias(params = {}) ⇒ Types::UpdateThemeAliasResponse

Updates an alias of a theme.

Examples:

Request syntax with placeholder values


resp = client.update_theme_alias({
  aws_account_id: "AwsAccountId", # required
  theme_id: "ShortRestrictiveResourceId", # 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 Amazon Web Services account that contains the theme alias that you're updating.

  • :theme_id (required, String) —

    The ID for the theme.

  • :alias_name (required, String) —

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

  • :theme_version_number (required, Integer) —

    The version number of the theme that the alias should reference.

Returns:

See Also:



14549
14550
14551
14552
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 14549

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

#update_theme_permissions(params = {}) ⇒ Types::UpdateThemePermissionsResponse

Updates the resource permissions for a theme. Permissions apply to the action to grant or revoke permissions on, for example "quicksight:DescribeTheme".

Theme permissions apply in groupings. Valid groupings include the following for the three levels of permissions, which are user, owner, or no permissions:

  • User

    • "quicksight:DescribeTheme"

    • "quicksight:DescribeThemeAlias"

    • "quicksight:ListThemeAliases"

    • "quicksight:ListThemeVersions"

  • Owner

    • "quicksight:DescribeTheme"

    • "quicksight:DescribeThemeAlias"

    • "quicksight:ListThemeAliases"

    • "quicksight:ListThemeVersions"

    • "quicksight:DeleteTheme"

    • "quicksight:UpdateTheme"

    • "quicksight:CreateThemeAlias"

    • "quicksight:DeleteThemeAlias"

    • "quicksight:UpdateThemeAlias"

    • "quicksight:UpdateThemePermissions"

    • "quicksight:DescribeThemePermissions"

  • To specify no permissions, omit the permissions list.

Examples:

Request syntax with placeholder values


resp = client.update_theme_permissions({
  aws_account_id: "AwsAccountId", # required
  theme_id: "ShortRestrictiveResourceId", # required
  grant_permissions: [
    {
      principal: "Principal", # required
      actions: ["String"], # required
    },
  ],
  revoke_permissions: [
    {
      principal: "Principal", # required
      actions: ["String"], # 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 Amazon Web Services account that contains the theme.

  • :theme_id (required, String) —

    The ID for the theme.

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

    A list of resource permissions to be granted for the theme.

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

    A list of resource permissions to be revoked from the theme.

Returns:

See Also:



14652
14653
14654
14655
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 14652

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

#update_topic(params = {}) ⇒ Types::UpdateTopicResponse

Updates a topic.

Examples:

Request syntax with placeholder values


resp = client.update_topic({
  aws_account_id: "AwsAccountId", # required
  topic_id: "TopicId", # required
  topic: { # required
    name: "ResourceName",
    description: "LimitedString",
    user_experience_version: "LEGACY", # accepts LEGACY, NEW_READER_EXPERIENCE
    data_sets: [
      {
        dataset_arn: "Arn", # required
        dataset_name: "LimitedString",
        dataset_description: "LimitedString",
        data_aggregation: {
          dataset_row_date_granularity: "SECOND", # accepts SECOND, MINUTE, HOUR, DAY, WEEK, MONTH, QUARTER, YEAR
          default_date_column_name: "LimitedString",
        },
        filters: [
          {
            filter_description: "LimitedString",
            filter_class: "ENFORCED_VALUE_FILTER", # accepts ENFORCED_VALUE_FILTER, CONDITIONAL_VALUE_FILTER, NAMED_VALUE_FILTER
            filter_name: "LimitedString", # required
            filter_synonyms: ["LimitedString"],
            operand_field_name: "LimitedString", # required
            filter_type: "CATEGORY_FILTER", # accepts CATEGORY_FILTER, NUMERIC_EQUALITY_FILTER, NUMERIC_RANGE_FILTER, DATE_RANGE_FILTER, RELATIVE_DATE_FILTER
            category_filter: {
              category_filter_function: "EXACT", # accepts EXACT, CONTAINS
              category_filter_type: "CUSTOM_FILTER", # accepts CUSTOM_FILTER, CUSTOM_FILTER_LIST, FILTER_LIST
              constant: {
                constant_type: "SINGULAR", # accepts SINGULAR, RANGE, COLLECTIVE
                singular_constant: "LimitedString",
                collective_constant: {
                  value_list: ["String"],
                },
              },
              inverse: false,
            },
            numeric_equality_filter: {
              constant: {
                constant_type: "SINGULAR", # accepts SINGULAR, RANGE, COLLECTIVE
                singular_constant: "LimitedString",
              },
              aggregation: "NO_AGGREGATION", # accepts NO_AGGREGATION, SUM, AVERAGE, COUNT, DISTINCT_COUNT, MAX, MEDIAN, MIN, STDEV, STDEVP, VAR, VARP
            },
            numeric_range_filter: {
              inclusive: false,
              constant: {
                constant_type: "SINGULAR", # accepts SINGULAR, RANGE, COLLECTIVE
                range_constant: {
                  minimum: "LimitedString",
                  maximum: "LimitedString",
                },
              },
              aggregation: "NO_AGGREGATION", # accepts NO_AGGREGATION, SUM, AVERAGE, COUNT, DISTINCT_COUNT, MAX, MEDIAN, MIN, STDEV, STDEVP, VAR, VARP
            },
            date_range_filter: {
              inclusive: false,
              constant: {
                constant_type: "SINGULAR", # accepts SINGULAR, RANGE, COLLECTIVE
                range_constant: {
                  minimum: "LimitedString",
                  maximum: "LimitedString",
                },
              },
            },
            relative_date_filter: {
              time_granularity: "SECOND", # accepts SECOND, MINUTE, HOUR, DAY, WEEK, MONTH, QUARTER, YEAR
              relative_date_filter_function: "PREVIOUS", # accepts PREVIOUS, THIS, LAST, NEXT, NOW
              constant: {
                constant_type: "SINGULAR", # accepts SINGULAR, RANGE, COLLECTIVE
                singular_constant: "LimitedString",
              },
            },
          },
        ],
        columns: [
          {
            column_name: "LimitedString", # required
            column_friendly_name: "LimitedString",
            column_description: "LimitedString",
            column_synonyms: ["LimitedString"],
            column_data_role: "DIMENSION", # accepts DIMENSION, MEASURE
            aggregation: "SUM", # accepts SUM, MAX, MIN, COUNT, DISTINCT_COUNT, AVERAGE, MEDIAN, STDEV, STDEVP, VAR, VARP
            is_included_in_topic: false,
            disable_indexing: false,
            comparative_order: {
              use_ordering: "GREATER_IS_BETTER", # accepts GREATER_IS_BETTER, LESSER_IS_BETTER, SPECIFIED
              specifed_order: ["String"],
              treat_undefined_specified_values: "LEAST", # accepts LEAST, MOST
            },
            semantic_type: {
              type_name: "LimitedString",
              sub_type_name: "LimitedString",
              type_parameters: {
                "LimitedString" => "LimitedString",
              },
              truthy_cell_value: "SensitiveString",
              truthy_cell_value_synonyms: ["SensitiveString"],
              falsey_cell_value: "SensitiveString",
              falsey_cell_value_synonyms: ["SensitiveString"],
            },
            time_granularity: "SECOND", # accepts SECOND, MINUTE, HOUR, DAY, WEEK, MONTH, QUARTER, YEAR
            allowed_aggregations: ["COUNT"], # accepts COUNT, DISTINCT_COUNT, MIN, MAX, MEDIAN, SUM, AVERAGE, STDEV, STDEVP, VAR, VARP, PERCENTILE
            not_allowed_aggregations: ["COUNT"], # accepts COUNT, DISTINCT_COUNT, MIN, MAX, MEDIAN, SUM, AVERAGE, STDEV, STDEVP, VAR, VARP, PERCENTILE
            default_formatting: {
              display_format: "AUTO", # accepts AUTO, PERCENT, CURRENCY, NUMBER, DATE, STRING
              display_format_options: {
                use_blank_cell_format: false,
                blank_cell_format: "LimitedString",
                date_format: "LimitedString",
                decimal_separator: "COMMA", # accepts COMMA, DOT
                grouping_separator: "LimitedString",
                use_grouping: false,
                fraction_digits: 1,
                prefix: "LimitedString",
                suffix: "LimitedString",
                unit_scaler: "NONE", # accepts NONE, AUTO, THOUSANDS, MILLIONS, BILLIONS, TRILLIONS
                negative_format: {
                  prefix: "LimitedString",
                  suffix: "LimitedString",
                },
                currency_symbol: "LimitedString",
              },
            },
            never_aggregate_in_filter: false,
            cell_value_synonyms: [
              {
                cell_value: "LimitedString",
                synonyms: ["String"],
              },
            ],
            non_additive: false,
          },
        ],
        calculated_fields: [
          {
            calculated_field_name: "LimitedString", # required
            calculated_field_description: "LimitedString",
            expression: "Expression", # required
            calculated_field_synonyms: ["LimitedString"],
            is_included_in_topic: false,
            disable_indexing: false,
            column_data_role: "DIMENSION", # accepts DIMENSION, MEASURE
            time_granularity: "SECOND", # accepts SECOND, MINUTE, HOUR, DAY, WEEK, MONTH, QUARTER, YEAR
            default_formatting: {
              display_format: "AUTO", # accepts AUTO, PERCENT, CURRENCY, NUMBER, DATE, STRING
              display_format_options: {
                use_blank_cell_format: false,
                blank_cell_format: "LimitedString",
                date_format: "LimitedString",
                decimal_separator: "COMMA", # accepts COMMA, DOT
                grouping_separator: "LimitedString",
                use_grouping: false,
                fraction_digits: 1,
                prefix: "LimitedString",
                suffix: "LimitedString",
                unit_scaler: "NONE", # accepts NONE, AUTO, THOUSANDS, MILLIONS, BILLIONS, TRILLIONS
                negative_format: {
                  prefix: "LimitedString",
                  suffix: "LimitedString",
                },
                currency_symbol: "LimitedString",
              },
            },
            aggregation: "SUM", # accepts SUM, MAX, MIN, COUNT, DISTINCT_COUNT, AVERAGE, MEDIAN, STDEV, STDEVP, VAR, VARP
            comparative_order: {
              use_ordering: "GREATER_IS_BETTER", # accepts GREATER_IS_BETTER, LESSER_IS_BETTER, SPECIFIED
              specifed_order: ["String"],
              treat_undefined_specified_values: "LEAST", # accepts LEAST, MOST
            },
            semantic_type: {
              type_name: "LimitedString",
              sub_type_name: "LimitedString",
              type_parameters: {
                "LimitedString" => "LimitedString",
              },
              truthy_cell_value: "SensitiveString",
              truthy_cell_value_synonyms: ["SensitiveString"],
              falsey_cell_value: "SensitiveString",
              falsey_cell_value_synonyms: ["SensitiveString"],
            },
            allowed_aggregations: ["COUNT"], # accepts COUNT, DISTINCT_COUNT, MIN, MAX, MEDIAN, SUM, AVERAGE, STDEV, STDEVP, VAR, VARP, PERCENTILE
            not_allowed_aggregations: ["COUNT"], # accepts COUNT, DISTINCT_COUNT, MIN, MAX, MEDIAN, SUM, AVERAGE, STDEV, STDEVP, VAR, VARP, PERCENTILE
            never_aggregate_in_filter: false,
            cell_value_synonyms: [
              {
                cell_value: "LimitedString",
                synonyms: ["String"],
              },
            ],
            non_additive: false,
          },
        ],
        named_entities: [
          {
            entity_name: "LimitedString", # required
            entity_description: "LimitedString",
            entity_synonyms: ["LimitedString"],
            semantic_entity_type: {
              type_name: "LimitedString",
              sub_type_name: "LimitedString",
              type_parameters: {
                "LimitedString" => "LimitedString",
              },
            },
            definition: [
              {
                field_name: "LimitedString",
                property_name: "LimitedString",
                property_role: "PRIMARY", # accepts PRIMARY, ID
                property_usage: "INHERIT", # accepts INHERIT, DIMENSION, MEASURE
                metric: {
                  aggregation: "SUM", # accepts SUM, MIN, MAX, COUNT, AVERAGE, DISTINCT_COUNT, STDEV, STDEVP, VAR, VARP, PERCENTILE, MEDIAN, CUSTOM
                  aggregation_function_parameters: {
                    "LimitedString" => "LimitedString",
                  },
                },
              },
            ],
          },
        ],
      },
    ],
  },
})

Response structure


resp.topic_id #=> String
resp.arn #=> String
resp.refresh_arn #=> 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 Amazon Web Services account that contains the topic that you want to update.

  • :topic_id (required, String) —

    The ID of the topic that you want to modify. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

  • :topic (required, Types::TopicDetails) —

    The definition of the topic that you want to update.

Returns:

See Also:



14917
14918
14919
14920
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 14917

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

#update_topic_permissions(params = {}) ⇒ Types::UpdateTopicPermissionsResponse

Updates the permissions of a topic.

Examples:

Request syntax with placeholder values


resp = client.update_topic_permissions({
  aws_account_id: "AwsAccountId", # required
  topic_id: "TopicId", # required
  grant_permissions: [
    {
      principal: "Principal", # required
      actions: ["String"], # required
    },
  ],
  revoke_permissions: [
    {
      principal: "Principal", # required
      actions: ["String"], # required
    },
  ],
})

Response structure


resp.topic_id #=> String
resp.topic_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 Amazon Web Services account that contains the topic that you want to update the permissions for.

  • :topic_id (required, String) —

    The ID of the topic that you want to modify. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

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

    The resource permissions that you want to grant to the topic.

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

    The resource permissions that you want to revoke from the topic.

Returns:

See Also:



14980
14981
14982
14983
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 14980

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

#update_topic_refresh_schedule(params = {}) ⇒ Types::UpdateTopicRefreshScheduleResponse

Updates a topic refresh schedule.

Examples:

Request syntax with placeholder values


resp = client.update_topic_refresh_schedule({
  aws_account_id: "AwsAccountId", # required
  topic_id: "TopicId", # required
  dataset_id: "String", # required
  refresh_schedule: { # required
    is_enabled: false, # required
    based_on_spice_schedule: false, # required
    starting_at: Time.now,
    timezone: "LimitedString",
    repeat_at: "LimitedString",
    topic_schedule_type: "HOURLY", # accepts HOURLY, DAILY, WEEKLY, MONTHLY
  },
})

Response structure


resp.topic_id #=> String
resp.topic_arn #=> String
resp.dataset_arn #=> 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 Amazon Web Services account that contains the topic whose refresh schedule you want to update.

  • :topic_id (required, String) —

    The ID of the topic that you want to modify. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

  • :dataset_id (required, String) —

    The ID of the dataset.

  • :refresh_schedule (required, Types::TopicRefreshSchedule) —

    The definition of a refresh schedule.

Returns:

See Also:



15037
15038
15039
15040
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 15037

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

#update_user(params = {}) ⇒ Types::UpdateUserResponse

Updates an Amazon QuickSight user.

Examples:

Request syntax with placeholder values


resp = client.update_user({
  user_name: "UserName", # required
  aws_account_id: "AwsAccountId", # required
  namespace: "Namespace", # required
  email: "String", # required
  role: "ADMIN", # required, accepts ADMIN, AUTHOR, READER, RESTRICTED_AUTHOR, RESTRICTED_READER, ADMIN_PRO, AUTHOR_PRO, READER_PRO
  custom_permissions_name: "RoleName",
  unapply_custom_permissions: false,
  external_login_federation_provider_type: "String",
  custom_federation_provider_url: "String",
  external_login_id: "String",
})

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", "ADMIN_PRO", "AUTHOR_PRO", "READER_PRO"
resp.user.identity_type #=> String, one of "IAM", "QUICKSIGHT", "IAM_IDENTITY_CENTER"
resp.user.active #=> Boolean
resp.user.principal_id #=> String
resp.user.custom_permissions_name #=> String
resp.user. #=> String
resp.user. #=> String
resp.user. #=> 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 update.

  • :aws_account_id (required, String) —

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

  • :namespace (required, String) —

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

  • :email (required, String) —

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

  • :role (required, String) —

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

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

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

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

    • READER_PRO: Reader Pro adds Generative BI capabilities to the Reader role. Reader Pros have access to Amazon Q in Amazon QuickSight, can build stories with Amazon Q, and can generate executive summaries from dashboards.

    • AUTHOR_PRO: Author Pro adds Generative BI capabilities to the Author role. Author Pros can author dashboards with natural language with Amazon Q, build stories with Amazon Q, create Topics for Q&A, and generate executive summaries from dashboards.

    • ADMIN_PRO: Admin Pros are Author Pros who can also manage Amazon QuickSight administrative settings. Admin Pro users are billed at Author Pro pricing.

    The name of the Amazon QuickSight role is invisible to the user except for the console screens dealing with permissions.

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

    The name of the custom permissions profile that you want to assign to this user. Customized permissions allows you to control a user's access by restricting access the following operations:

    • Create and update data sources

    • Create and update datasets

    • Create and update email reports

    • Subscribe to email reports

    A set of custom permissions includes any combination of these restrictions. Currently, you need to create the profile names for custom permission sets by using the Amazon QuickSight console. Then, you use the RegisterUser API operation to assign the named set of permissions to a Amazon QuickSight user.

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

    This feature is available only to Amazon QuickSight Enterprise edition subscriptions.

  • :unapply_custom_permissions (Boolean) —

    A flag that you use to indicate that you want to remove all custom permissions from this user. Using this parameter resets the user to the state it was in before a custom permissions profile was applied. This parameter defaults to NULL and it doesn't accept any other value.

  • :external_login_federation_provider_type (String) —

    The type of supported external login provider that provides identity to let a user federate into Amazon QuickSight with an associated Identity and Access Management(IAM) role. The type of supported external login provider can be one of the following.

    • COGNITO: Amazon Cognito. The provider URL is cognito-identity.amazonaws.com. When choosing the COGNITO provider type, don’t use the "CustomFederationProviderUrl" parameter which is only needed when the external provider is custom.

    • CUSTOM_OIDC: Custom OpenID Connect (OIDC) provider. When choosing CUSTOM_OIDC type, use the CustomFederationProviderUrl parameter to provide the custom OIDC provider URL.

    • NONE: This clears all the previously saved external login information for a user. Use the DescribeUser API operation to check the external login information.

  • :custom_federation_provider_url (String) —

    The URL of the custom OpenID Connect (OIDC) provider that provides identity to let a user federate into Amazon QuickSight with an associated Identity and Access Management(IAM) role. This parameter should only be used when ExternalLoginFederationProviderType parameter is set to CUSTOM_OIDC.

  • :external_login_id (String) —

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

Returns:

See Also:



15192
15193
15194
15195
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 15192

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

#update_vpc_connection(params = {}) ⇒ Types::UpdateVPCConnectionResponse

Updates a VPC connection.

Examples:

Request syntax with placeholder values


resp = client.update_vpc_connection({
  aws_account_id: "AwsAccountId", # required
  vpc_connection_id: "VPCConnectionResourceIdUnrestricted", # required
  name: "ResourceName", # required
  subnet_ids: ["SubnetId"], # required
  security_group_ids: ["SecurityGroupId"], # required
  dns_resolvers: ["IPv4Address"],
  role_arn: "RoleArn", # required
})

Response structure


resp.arn #=> String
resp.vpc_connection_id #=> String
resp.update_status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED", "DELETION_IN_PROGRESS", "DELETION_FAILED", "DELETED"
resp.availability_status #=> String, one of "AVAILABLE", "UNAVAILABLE", "PARTIALLY_AVAILABLE"
resp.request_id #=> String
resp.status #=> Integer

Parameters:

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

    ({})

Options Hash (params):

  • :aws_account_id (required, String) —

    The Amazon Web Services account ID of the account that contains the VPC connection that you want to update.

  • :vpc_connection_id (required, String) —

    The ID of the VPC connection that you're updating. This ID is a unique identifier for each Amazon Web Services Region in an Amazon Web Services account.

  • :name (required, String) —

    The display name for the VPC connection.

  • :subnet_ids (required, Array<String>) —

    A list of subnet IDs for the VPC connection.

  • :security_group_ids (required, Array<String>) —

    A list of security group IDs for the VPC connection.

  • :dns_resolvers (Array<String>) —

    A list of IP addresses of DNS resolver endpoints for the VPC connection.

  • :role_arn (required, String) —

    An IAM role associated with the VPC connection.

Returns:

See Also:



15258
15259
15260
15261
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 15258

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