Class: Aws::QuickSight::Client

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

Overview

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

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

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

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

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

#config, #handlers

API Operations collapse

Instance Method Summary collapse

Methods included from ClientStubs

#api_requests, #stub_data, #stub_responses

Methods inherited from Seahorse::Client::Base

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

Methods included from Seahorse::Client::HandlerBuilder

#handle, #handle_request, #handle_response

Constructor Details

#initialize(options) ⇒ Client

Returns a new instance of Client.

Parameters:

  • options (Hash)

Options Hash (options):

  • :credentials (required, Aws::CredentialProvider)

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

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

    • Aws::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.
  • :region (required, String)

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

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

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

  • :adaptive_retry_wait_to_fill (Boolean) — default: true

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

  • :client_side_monitoring (Boolean) — default: false

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

  • :client_side_monitoring_client_id (String) — default: ""

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

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

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

  • :client_side_monitoring_port (Integer) — default: 31000

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

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

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

  • :convert_params (Boolean) — default: true

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

  • :correct_clock_skew (Boolean) — default: true

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

  • :disable_host_prefix_injection (Boolean) — default: false

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

  • :endpoint (String)

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

  • :endpoint_cache_max_entries (Integer) — default: 1000

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

  • :endpoint_cache_max_threads (Integer) — default: 10

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

  • :endpoint_cache_poll_interval (Integer) — default: 60

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

  • :endpoint_discovery (Boolean) — default: false

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

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

    The log formatter.

  • :log_level (Symbol) — default: :info

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

  • :logger (Logger)

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

  • :max_attempts (Integer) — default: 3

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

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

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

  • :retry_backoff (Proc)

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

  • :retry_base_delay (Float) — default: 0.3

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

  • :retry_jitter (Symbol) — default: :none

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

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

  • :retry_limit (Integer) — default: 3

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

  • :retry_max_delay (Integer) — default: 0

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

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

    Specifies which retry algorithm to use. Values are:

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

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

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

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

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

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

  • :validate_params (Boolean) — default: true

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

  • :http_proxy (URI::HTTP, String)

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

  • :http_open_timeout (Float) — default: 15

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

  • :http_read_timeout (Integer) — default: 60

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

  • :http_idle_timeout (Float) — default: 5

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

  • :http_continue_timeout (Float) — default: 1

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

  • :http_wire_trace (Boolean) — default: false

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

  • :ssl_verify_peer (Boolean) — default: true

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

  • :ssl_ca_bundle (String)

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

  • :ssl_ca_directory (String)

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



324
325
326
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 324

def initialize(*args)
  super
end

Instance Method Details

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

Cancels an ongoing ingestion of data into SPICE.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :aws_account_id (required, String)

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



367
368
369
370
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 367

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 the current Amazon Web Services Region;. Currently, you can add a custom default theme by using the CreateAccountCustomization or UpdateAccountCustomization API operation. To further customize Amazon QuickSight by removing Amazon QuickSight sample assets and videos for all new users, see Customizing Amazon QuickSight in the Amazon QuickSight User Guide.

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

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

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :aws_account_id (required, String)

    The ID for the 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 Amazon QuickSight namespace.

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

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

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

Returns:

See Also:



462
463
464
465
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 462

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

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

Creates an analysis in Amazon QuickSight.

Examples:

Request syntax with placeholder values


resp = client.create_analysis({
  aws_account_id: "AwsAccountId", # required
  analysis_id: "RestrictiveResourceId", # required
  name: "AnalysisName", # required
  parameters: {
    string_parameters: [
      {
        name: "NonEmptyString", # required
        values: ["String"], # required
      },
    ],
    integer_parameters: [
      {
        name: "NonEmptyString", # required
        values: [1], # required
      },
    ],
    decimal_parameters: [
      {
        name: "NonEmptyString", # required
        values: [1.0], # required
      },
    ],
    date_time_parameters: [
      {
        name: "NonEmptyString", # required
        values: [Time.now], # required
      },
    ],
  },
  permissions: [
    {
      principal: "Principal", # required
      actions: ["String"], # required
    },
  ],
  source_entity: { # required
    source_template: {
      data_set_references: [ # required
        {
          data_set_placeholder: "NonEmptyString", # required
          data_set_arn: "Arn", # required
        },
      ],
      arn: "Arn", # required
    },
  },
  theme_arn: "Arn",
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
})

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

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

Returns:

See Also:



587
588
589
590
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 587

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 a template. To first create a template, see the CreateTemplate API operation.

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

Examples:

Request syntax with placeholder values


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

Response structure


resp.arn #=> String
resp.version_arn #=> String
resp.dashboard_id #=> String
resp.creation_status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED", "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 IAMpolicy.

  • :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 IAMaction information for each principal ARN.

    To specify no permissions, omit the permissions list.

  • :source_entity (required, Types::DashboardSourceEntity)

    The entity that you are using as a source when you create the dashboard. In SourceEntity, you specify the type of object you're using as source. You can only create a dashboard from a template, so you use a SourceTemplate entity. If you need to create a dashboard from an analysis, first convert the analysis to a template by using the CreateTemplate API operation. For SourceTemplate, specify the Amazon Resource Name (ARN) of the source template. The SourceTemplateARN can contain any 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.

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

Returns:

See Also:



762
763
764
765
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 762

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

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

Creates a dataset.

Examples:

Request syntax with placeholder values


resp = client.create_data_set({
  aws_account_id: "AwsAccountId", # required
  data_set_id: "ResourceId", # required
  name: "ResourceName", # required
  physical_table_map: { # required
    "PhysicalTableId" => {
      relational_table: {
        data_source_arn: "Arn", # required
        catalog: "RelationalTableCatalog",
        schema: "RelationalTableSchema",
        name: "RelationalTableName", # required
        input_columns: [ # required
          {
            name: "ColumnName", # required
            type: "STRING", # required, accepts STRING, INTEGER, DECIMAL, DATETIME, BIT, BOOLEAN, JSON
          },
        ],
      },
      custom_sql: {
        data_source_arn: "Arn", # required
        name: "CustomSqlName", # required
        sql_query: "SqlQuery", # required
        columns: [
          {
            name: "ColumnName", # required
            type: "STRING", # required, accepts STRING, INTEGER, DECIMAL, DATETIME, BIT, BOOLEAN, JSON
          },
        ],
      },
      s3_source: {
        data_source_arn: "Arn", # required
        upload_settings: {
          format: "CSV", # accepts CSV, TSV, CLF, ELF, XLSX, JSON
          start_from_row: 1,
          contains_header: false,
          text_qualifier: "DOUBLE_QUOTE", # accepts DOUBLE_QUOTE, SINGLE_QUOTE
          delimiter: "Delimiter",
        },
        input_columns: [ # required
          {
            name: "ColumnName", # required
            type: "STRING", # required, accepts STRING, INTEGER, DECIMAL, DATETIME, BIT, BOOLEAN, JSON
          },
        ],
      },
    },
  },
  logical_table_map: {
    "LogicalTableId" => {
      alias: "LogicalTableAlias", # required
      data_transforms: [
        {
          project_operation: {
            projected_columns: ["String"], # required
          },
          filter_operation: {
            condition_expression: "Expression", # required
          },
          create_columns_operation: {
            columns: [ # required
              {
                column_name: "ColumnName", # required
                column_id: "ColumnId", # required
                expression: "Expression", # required
              },
            ],
          },
          rename_column_operation: {
            column_name: "ColumnName", # required
            new_column_name: "ColumnName", # required
          },
          cast_column_type_operation: {
            column_name: "ColumnName", # required
            new_column_type: "STRING", # required, accepts STRING, INTEGER, DECIMAL, DATETIME
            format: "TypeCastFormat",
          },
          tag_column_operation: {
            column_name: "ColumnName", # required
            tags: [ # required
              {
                column_geographic_role: "COUNTRY", # accepts COUNTRY, STATE, COUNTY, CITY, POSTCODE, LONGITUDE, LATITUDE
                column_description: {
                  text: "ColumnDescriptiveText",
                },
              },
            ],
          },
          untag_column_operation: {
            column_name: "ColumnName", # required
            tag_names: ["COLUMN_GEOGRAPHIC_ROLE"], # required, accepts COLUMN_GEOGRAPHIC_ROLE, COLUMN_DESCRIPTION
          },
        },
      ],
      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", # required, 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",
      },
    ],
  },
  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,
  },
})

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.

Returns:

See Also:



1014
1015
1016
1017
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 1014

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
  data_source_parameters: {
    amazon_elasticsearch_parameters: {
      domain: "Domain", # required
    },
    athena_parameters: {
      work_group: "WorkGroup",
    },
    aurora_parameters: {
      host: "Host", # required
      port: 1, # required
      database: "Database", # required
    },
    aurora_postgre_sql_parameters: {
      host: "Host", # required
      port: 1, # required
      database: "Database", # required
    },
    aws_iot_analytics_parameters: {
      data_set_name: "DataSetName", # required
    },
    jira_parameters: {
      site_base_url: "SiteBaseUrl", # required
    },
    maria_db_parameters: {
      host: "Host", # required
      port: 1, # required
      database: "Database", # required
    },
    my_sql_parameters: {
      host: "Host", # required
      port: 1, # required
      database: "Database", # required
    },
    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",
    },
    s3_parameters: {
      manifest_file_location: { # required
        bucket: "S3Bucket", # required
        key: "S3Key", # required
      },
    },
    service_now_parameters: {
      site_base_url: "SiteBaseUrl", # required
    },
    snowflake_parameters: {
      host: "Host", # required
      database: "Database", # required
      warehouse: "Warehouse", # required
    },
    spark_parameters: {
      host: "Host", # required
      port: 1, # required
    },
    sql_server_parameters: {
      host: "Host", # required
      port: 1, # required
      database: "Database", # required
    },
    teradata_parameters: {
      host: "Host", # required
      port: 1, # required
      database: "Database", # required
    },
    twitter_parameters: {
      query: "Query", # required
      max_rows: 1, # required
    },
    amazon_open_search_parameters: {
      domain: "Domain", # required
    },
  },
  credentials: {
    credential_pair: {
      username: "Username", # required
      password: "Password", # required
      alternate_data_source_parameters: [
        {
          amazon_elasticsearch_parameters: {
            domain: "Domain", # required
          },
          athena_parameters: {
            work_group: "WorkGroup",
          },
          aurora_parameters: {
            host: "Host", # required
            port: 1, # required
            database: "Database", # required
          },
          aurora_postgre_sql_parameters: {
            host: "Host", # required
            port: 1, # required
            database: "Database", # required
          },
          aws_iot_analytics_parameters: {
            data_set_name: "DataSetName", # required
          },
          jira_parameters: {
            site_base_url: "SiteBaseUrl", # required
          },
          maria_db_parameters: {
            host: "Host", # required
            port: 1, # required
            database: "Database", # required
          },
          my_sql_parameters: {
            host: "Host", # required
            port: 1, # required
            database: "Database", # required
          },
          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",
          },
          s3_parameters: {
            manifest_file_location: { # required
              bucket: "S3Bucket", # required
              key: "S3Key", # required
            },
          },
          service_now_parameters: {
            site_base_url: "SiteBaseUrl", # required
          },
          snowflake_parameters: {
            host: "Host", # required
            database: "Database", # required
            warehouse: "Warehouse", # required
          },
          spark_parameters: {
            host: "Host", # required
            port: 1, # required
          },
          sql_server_parameters: {
            host: "Host", # required
            port: 1, # required
            database: "Database", # required
          },
          teradata_parameters: {
            host: "Host", # required
            port: 1, # required
            database: "Database", # required
          },
          twitter_parameters: {
            query: "Query", # required
            max_rows: 1, # required
          },
          amazon_open_search_parameters: {
            domain: "Domain", # required
          },
        },
      ],
    },
    copy_source_arn: "CopySourceArn",
  },
  permissions: [
    {
      principal: "Principal", # required
      actions: ["String"], # required
    },
  ],
  vpc_connection_properties: {
    vpc_connection_arn: "Arn", # required
  },
  ssl_properties: {
    disable_ssl: false,
  },
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
})

Response structure


resp.arn #=> String
resp.data_source_id #=> String
resp.creation_status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED", "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 Elasticsearch 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.

Returns:

See Also:



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

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
  parent_folder_arn: "Arn",
  permissions: [
    {
      principal: "Principal", # required
      actions: ["String"], # required
    },
  ],
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # 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 AWS Account ID.

  • :folder_id (required, String)

    The folder ID.

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

Returns:

See Also:



1379
1380
1381
1382
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 1379

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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :aws_account_id (required, String)

    The AWS Account ID.

  • :folder_id (required, String)

    The folder ID.

  • :member_id (required, String)

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

  • :member_type (required, String)

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

Returns:

See Also:



1426
1427
1428
1429
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 1426

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

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

Creates an Amazon QuickSight group.

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

The response is a group object.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :group_name (required, String)

    A name for the group that you want to create.

  • :description (String)

    A description for the group that you want to create.

  • :aws_account_id (required, String)

    The ID for the 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. Currently, you should set this to default.

Returns:

See Also:



1481
1482
1483
1484
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 1481

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. Currently, you should set this to default.

Returns:

See Also:



1528
1529
1530
1531
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 1528

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

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 IAMpolicy to Amazon QuickSight users or groups.

  • :assignment_name (required, String)

    The name of the assignment, also called a rule. It must be unique within an 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 IAMpolicy 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:



1609
1610
1611
1612
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 1609

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

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

Creates and starts a new SPICE ingestion on a dataset

Any ingestions operating on tagged datasets inherit the same tags automatically for use in access control. For an example, see How do I create an IAM policy to control access to Amazon EC2 resources using tags? in the 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
})

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.

Returns:

See Also:



1663
1664
1665
1666
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 1663

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:



1734
1735
1736
1737
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 1734

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

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

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

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

Examples:

Request syntax with placeholder values


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

Response structure


resp.arn #=> String
resp.version_arn #=> String
resp.template_id #=> String
resp.creation_status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED", "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 (required, Types::TemplateSourceEntity)

    The entity that you are using as a source when you create the template. In SourceEntity, you specify the type of object you're using as source: SourceTemplate for a template or SourceAnalysis for an analysis. Both of these require an Amazon Resource Name (ARN). For SourceTemplate, specify the ARN of the source template. For SourceAnalysis, specify the ARN of the source analysis. The SourceTemplate ARN can contain any 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.

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

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

  • :version_description (String)

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

Returns:

See Also:



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

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

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

Creates a template alias for a template.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :aws_account_id (required, String)

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



1898
1899
1900
1901
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 1898

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

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

Creates a theme.

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

Examples:

Request syntax with placeholder values


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

Response structure


resp.arn #=> String
resp.version_arn #=> String
resp.theme_id #=> String
resp.creation_status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED", "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 a Amazon QuickSight analysis.

  • :version_description (String)

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

  • :configuration (required, Types::ThemeConfiguration)

    The theme configuration, which contains the theme display properties.

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

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

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

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

Returns:

See Also:



2030
2031
2032
2033
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 2030

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

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

Creates a theme alias for a theme.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :aws_account_id (required, String)

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



2079
2080
2081
2082
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 2079

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

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

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



2118
2119
2120
2121
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 2118

def (params = {}, options = {})
  req = build_request(:delete_account_customization, 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: "RestrictiveResourceId", # 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:



2189
2190
2191
2192
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 2189

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: "RestrictiveResourceId", # required
  version_number: 1,
})

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :aws_account_id (required, String)

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



2233
2234
2235
2236
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 2233

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:



2272
2273
2274
2275
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 2272

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

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

Deletes the data source permanently. This 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:



2312
2313
2314
2315
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 2312

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 AWS Account ID for the folder.

  • :folder_id (required, String)

    The folder ID.

Returns:

See Also:



2350
2351
2352
2353
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 2350

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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :aws_account_id (required, String)

    The AWS Account ID.

  • :folder_id (required, String)

    The Folder ID.

  • :member_id (required, String)

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

  • :member_type (required, String)

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

Returns:

See Also:



2395
2396
2397
2398
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 2395

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. Currently, you should set this to default.

Returns:

See Also:



2435
2436
2437
2438
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 2435

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. Currently, you should set this to default.

Returns:

See Also:



2481
2482
2483
2484
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 2481

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

  • :assignment_name (required, String)

    The name of the assignment.

  • :namespace (required, String)

    The namespace that contains the assignment.

Returns:

See Also:



2522
2523
2524
2525
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 2522

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

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

Deletes a namespace and the users and groups that are associated with the namespace. This is an asynchronous process. Assets including dashboards, analyses, datasets and data sources are not deleted. To delete these assets, you use the 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:



2561
2562
2563
2564
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 2561

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

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

Deletes a template.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :aws_account_id (required, String)

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



2606
2607
2608
2609
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 2606

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

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

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

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :aws_account_id (required, String)

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



2656
2657
2658
2659
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 2656

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

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

Deletes a theme.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :aws_account_id (required, String)

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



2702
2703
2704
2705
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 2702

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

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

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

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :aws_account_id (required, String)

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



2749
2750
2751
2752
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 2749

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

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

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

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :user_name (required, String)

    The name of the user that you want to delete.

  • :aws_account_id (required, String)

    The ID for the 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:



2792
2793
2794
2795
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 2792

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:



2832
2833
2834
2835
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 2832

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

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

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

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

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

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

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

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

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

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



2943
2944
2945
2946
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 2943

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

Parameters:

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

    ({})

Options Hash (params):

  • :aws_account_id (required, String)

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

Returns:

See Also:



2980
2981
2982
2983
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 2980

def (params = {}, options = {})
  req = build_request(:describe_account_settings, 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: "RestrictiveResourceId", # 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.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:



3033
3034
3035
3036
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 3033

def describe_analysis(params = {}, options = {})
  req = build_request(:describe_analysis, 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: "RestrictiveResourceId", # 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:



3079
3080
3081
3082
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 3079

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

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

Provides a summary for a dashboard.

Examples:

Request syntax with placeholder values


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

Response structure


resp.dashboard.dashboard_id #=> String
resp.dashboard.arn #=> String
resp.dashboard.name #=> String
resp.dashboard.version.created_time #=> Time
resp.dashboard.version.errors #=> Array
resp.dashboard.version.errors[0].type #=> String, one of "ACCESS_DENIED", "SOURCE_NOT_FOUND", "DATA_SET_NOT_FOUND", "INTERNAL_FAILURE", "PARAMETER_VALUE_INCOMPATIBLE", "PARAMETER_TYPE_INVALID", "PARAMETER_NOT_FOUND", "COLUMN_TYPE_MISMATCH", "COLUMN_GEOGRAPHIC_ROLE_MISMATCH", "COLUMN_REPLACEMENT_MISSING"
resp.dashboard.version.errors[0].message #=> String
resp.dashboard.version.version_number #=> Integer
resp.dashboard.version.status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED", "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.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:



3145
3146
3147
3148
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 3145

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

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

Describes read and write permissions for a dashboard.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :aws_account_id (required, String)

    The ID of the 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 IAMpolicy.

Returns:

See Also:



3189
3190
3191
3192
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 3189

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

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

Describes a dataset.

Examples:

Request syntax with placeholder values


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

Response structure


resp.data_set.arn #=> String
resp.data_set.data_set_id #=> String
resp.data_set.name #=> String
resp.data_set.created_time #=> Time
resp.data_set.last_updated_time #=> Time
resp.data_set.physical_table_map #=> Hash
resp.data_set.physical_table_map["PhysicalTableId"].relational_table.data_source_arn #=> String
resp.data_set.physical_table_map["PhysicalTableId"].relational_table.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"].custom_sql.data_source_arn #=> String
resp.data_set.physical_table_map["PhysicalTableId"].custom_sql.name #=> String
resp.data_set.physical_table_map["PhysicalTableId"].custom_sql.sql_query #=> String
resp.data_set.physical_table_map["PhysicalTableId"].custom_sql.columns #=> Array
resp.data_set.physical_table_map["PhysicalTableId"].custom_sql.columns[0].name #=> String
resp.data_set.physical_table_map["PhysicalTableId"].custom_sql.columns[0].type #=> String, one of "STRING", "INTEGER", "DECIMAL", "DATETIME", "BIT", "BOOLEAN", "JSON"
resp.data_set.physical_table_map["PhysicalTableId"].s3_source.data_source_arn #=> String
resp.data_set.physical_table_map["PhysicalTableId"].s3_source.upload_settings.format #=> String, one of "CSV", "TSV", "CLF", "ELF", "XLSX", "JSON"
resp.data_set.physical_table_map["PhysicalTableId"].s3_source.upload_settings.start_from_row #=> Integer
resp.data_set.physical_table_map["PhysicalTableId"].s3_source.upload_settings.contains_header #=> Boolean
resp.data_set.physical_table_map["PhysicalTableId"].s3_source.upload_settings.text_qualifier #=> String, one of "DOUBLE_QUOTE", "SINGLE_QUOTE"
resp.data_set.physical_table_map["PhysicalTableId"].s3_source.upload_settings.delimiter #=> String
resp.data_set.physical_table_map["PhysicalTableId"].s3_source.input_columns #=> Array
resp.data_set.physical_table_map["PhysicalTableId"].s3_source.input_columns[0].name #=> String
resp.data_set.physical_table_map["PhysicalTableId"].s3_source.input_columns[0].type #=> String, one of "STRING", "INTEGER", "DECIMAL", "DATETIME", "BIT", "BOOLEAN", "JSON"
resp.data_set.logical_table_map #=> Hash
resp.data_set.logical_table_map["LogicalTableId"].alias #=> String
resp.data_set.logical_table_map["LogicalTableId"].data_transforms #=> Array
resp.data_set.logical_table_map["LogicalTableId"].data_transforms[0].project_operation.projected_columns #=> Array
resp.data_set.logical_table_map["LogicalTableId"].data_transforms[0].project_operation.projected_columns[0] #=> String
resp.data_set.logical_table_map["LogicalTableId"].data_transforms[0].filter_operation.condition_expression #=> String
resp.data_set.logical_table_map["LogicalTableId"].data_transforms[0].create_columns_operation.columns #=> Array
resp.data_set.logical_table_map["LogicalTableId"].data_transforms[0].create_columns_operation.columns[0].column_name #=> String
resp.data_set.logical_table_map["LogicalTableId"].data_transforms[0].create_columns_operation.columns[0].column_id #=> String
resp.data_set.logical_table_map["LogicalTableId"].data_transforms[0].create_columns_operation.columns[0].expression #=> String
resp.data_set.logical_table_map["LogicalTableId"].data_transforms[0].rename_column_operation.column_name #=> String
resp.data_set.logical_table_map["LogicalTableId"].data_transforms[0].rename_column_operation.new_column_name #=> String
resp.data_set.logical_table_map["LogicalTableId"].data_transforms[0].cast_column_type_operation.column_name #=> String
resp.data_set.logical_table_map["LogicalTableId"].data_transforms[0].cast_column_type_operation.new_column_type #=> String, one of "STRING", "INTEGER", "DECIMAL", "DATETIME"
resp.data_set.logical_table_map["LogicalTableId"].data_transforms[0].cast_column_type_operation.format #=> String
resp.data_set.logical_table_map["LogicalTableId"].data_transforms[0].tag_column_operation.column_name #=> String
resp.data_set.logical_table_map["LogicalTableId"].data_transforms[0].tag_column_operation.tags #=> Array
resp.data_set.logical_table_map["LogicalTableId"].data_transforms[0].tag_column_operation.tags[0].column_geographic_role #=> String, one of "COUNTRY", "STATE", "COUNTY", "CITY", "POSTCODE", "LONGITUDE", "LATITUDE"
resp.data_set.logical_table_map["LogicalTableId"].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"].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.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.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.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:



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

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:



3363
3364
3365
3366
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 3363

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

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

Describes a data source.

Examples:

Request syntax with placeholder values


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

Response structure


resp.data_source.arn #=> String
resp.data_source.data_source_id #=> String
resp.data_source.name #=> String
resp.data_source.type #=> String, one of "ADOBE_ANALYTICS", "AMAZON_ELASTICSEARCH", "ATHENA", "AURORA", "AURORA_POSTGRESQL", "AWS_IOT_ANALYTICS", "GITHUB", "JIRA", "MARIADB", "MYSQL", "ORACLE", "POSTGRESQL", "PRESTO", "REDSHIFT", "S3", "SALESFORCE", "SERVICENOW", "SNOWFLAKE", "SPARK", "SQLSERVER", "TERADATA", "TWITTER", "TIMESTREAM", "AMAZON_OPENSEARCH"
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.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.s3_parameters.manifest_file_location.bucket #=> String
resp.data_source.data_source_parameters.s3_parameters.manifest_file_location.key #=> String
resp.data_source.data_source_parameters.service_now_parameters.site_base_url #=> String
resp.data_source.data_source_parameters.snowflake_parameters.host #=> String
resp.data_source.data_source_parameters.snowflake_parameters.database #=> String
resp.data_source.data_source_parameters.snowflake_parameters.warehouse #=> String
resp.data_source.data_source_parameters.spark_parameters.host #=> String
resp.data_source.data_source_parameters.spark_parameters.port #=> Integer
resp.data_source.data_source_parameters.sql_server_parameters.host #=> String
resp.data_source.data_source_parameters.sql_server_parameters.port #=> Integer
resp.data_source.data_source_parameters.sql_server_parameters.database #=> String
resp.data_source.data_source_parameters.teradata_parameters.host #=> String
resp.data_source.data_source_parameters.teradata_parameters.port #=> Integer
resp.data_source.data_source_parameters.teradata_parameters.database #=> String
resp.data_source.data_source_parameters.twitter_parameters.query #=> String
resp.data_source.data_source_parameters.twitter_parameters.max_rows #=> Integer
resp.data_source.data_source_parameters.amazon_open_search_parameters.domain #=> 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].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].s3_parameters.manifest_file_location.bucket #=> String
resp.data_source.alternate_data_source_parameters[0].s3_parameters.manifest_file_location.key #=> String
resp.data_source.alternate_data_source_parameters[0].service_now_parameters.site_base_url #=> String
resp.data_source.alternate_data_source_parameters[0].snowflake_parameters.host #=> String
resp.data_source.alternate_data_source_parameters[0].snowflake_parameters.database #=> String
resp.data_source.alternate_data_source_parameters[0].snowflake_parameters.warehouse #=> String
resp.data_source.alternate_data_source_parameters[0].spark_parameters.host #=> String
resp.data_source.alternate_data_source_parameters[0].spark_parameters.port #=> Integer
resp.data_source.alternate_data_source_parameters[0].sql_server_parameters.host #=> String
resp.data_source.alternate_data_source_parameters[0].sql_server_parameters.port #=> Integer
resp.data_source.alternate_data_source_parameters[0].sql_server_parameters.database #=> String
resp.data_source.alternate_data_source_parameters[0].teradata_parameters.host #=> String
resp.data_source.alternate_data_source_parameters[0].teradata_parameters.port #=> Integer
resp.data_source.alternate_data_source_parameters[0].teradata_parameters.database #=> String
resp.data_source.alternate_data_source_parameters[0].twitter_parameters.query #=> String
resp.data_source.alternate_data_source_parameters[0].twitter_parameters.max_rows #=> Integer
resp.data_source.alternate_data_source_parameters[0].amazon_open_search_parameters.domain #=> 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.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:



3507
3508
3509
3510
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 3507

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:



3551
3552
3553
3554
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 3551

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"
resp.folder.folder_path #=> Array
resp.folder.folder_path[0] #=> String
resp.folder.created_time #=> Time
resp.folder.last_updated_time #=> Time
resp.request_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :aws_account_id (required, String)

    The AWS account ID.

  • :folder_id (required, String)

    The folder ID.

Returns:

See Also:



3594
3595
3596
3597
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 3594

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.

Examples:

Request syntax with placeholder values


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

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

Parameters:

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

    ({})

Options Hash (params):

  • :aws_account_id (required, String)

    The AWS Account ID.

  • :folder_id (required, String)

    The folder ID.

Returns:

See Also:



3637
3638
3639
3640
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 3637

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.

Examples:

Request syntax with placeholder values


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

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

Parameters:

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

    ({})

Options Hash (params):

  • :aws_account_id (required, String)

    The AWS account ID.

  • :folder_id (required, String)

    The folder ID.

Returns:

See Also:



3682
3683
3684
3685
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 3682

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. Currently, you should set this to default.

Returns:

See Also:



3728
3729
3730
3731
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 3728

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

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

Describes an existing IAMpolicy 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:



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

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

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

Describes a SPICE ingestion.

Examples:

Request syntax with placeholder values


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

Response structure


resp.ingestion.arn #=> String
resp.ingestion.ingestion_id #=> String
resp.ingestion.ingestion_status #=> String, one of "INITIALIZED", "QUEUED", "RUNNING", "FAILED", "COMPLETED", "CANCELLED"
resp.ingestion.error_info.type #=> String, one of "FAILURE_TO_ASSUME_ROLE", "INGESTION_SUPERSEDED", "INGESTION_CANCELED", "DATA_SET_DELETED", "DATA_SET_NOT_SPICE", "S3_UPLOADED_FILE_DELETED", "S3_MANIFEST_ERROR", "DATA_TOLERANCE_EXCEPTION", "SPICE_TABLE_NOT_FOUND", "DATA_SET_SIZE_LIMIT_EXCEEDED", "ROW_SIZE_LIMIT_EXCEEDED", "ACCOUNT_CAPACITY_LIMIT_EXCEEDED", "CUSTOMER_ERROR", "DATA_SOURCE_NOT_FOUND", "IAM_ROLE_NOT_AVAILABLE", "CONNECTION_FAILURE", "SQL_TABLE_NOT_FOUND", "PERMISSION_DENIED", "SSL_CERTIFICATE_VALIDATION_FAILURE", "OAUTH_TOKEN_FAILURE", "SOURCE_API_LIMIT_EXCEEDED_FAILURE", "PASSWORD_AUTHENTICATION_FAILURE", "SQL_SCHEMA_MISMATCH_ERROR", "INVALID_DATE_FORMAT", "INVALID_DATAPREP_SYNTAX", "SOURCE_RESOURCE_LIMIT_EXCEEDED", "SQL_INVALID_PARAMETER_VALUE", "QUERY_TIMEOUT", "SQL_NUMERIC_OVERFLOW", "UNRESOLVABLE_HOST", "UNROUTABLE_HOST", "SQL_EXCEPTION", "S3_FILE_INACCESSIBLE", "IOT_FILE_NOT_FOUND", "IOT_DATA_SET_FILE_EMPTY", "INVALID_DATA_SOURCE_CONFIG", "DATA_SOURCE_AUTH_FAILED", "DATA_SOURCE_CONNECTION_FAILED", "FAILURE_TO_PROCESS_JSON_FILE", "INTERNAL_SERVICE_ERROR"
resp.ingestion.error_info.message #=> String
resp.ingestion.row_info.rows_ingested #=> Integer
resp.ingestion.row_info.rows_dropped #=> Integer
resp.ingestion.queue_info.waiting_on_ingestion #=> String
resp.ingestion.queue_info.queued_ingestion #=> String
resp.ingestion.created_time #=> Time
resp.ingestion.ingestion_time_in_seconds #=> Integer
resp.ingestion.ingestion_size_in_bytes #=> Integer
resp.ingestion.request_source #=> String, one of "MANUAL", "SCHEDULED"
resp.ingestion.request_type #=> String, one of "INITIAL_INGESTION", "EDIT", "INCREMENTAL_REFRESH", "FULL_REFRESH"
resp.request_id #=> String
resp.status #=> Integer

Parameters:

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

    ({})

Options Hash (params):

  • :aws_account_id (required, String)

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



3830
3831
3832
3833
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 3830

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

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

Describes the current namespace.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :aws_account_id (required, String)

    The ID for the 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:



3873
3874
3875
3876
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 3873

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

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

Describes a template's metadata.

Examples:

Request syntax with placeholder values


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

Response structure


resp.template.arn #=> String
resp.template.name #=> String
resp.template.version.created_time #=> Time
resp.template.version.errors #=> Array
resp.template.version.errors[0].type #=> String, one of "SOURCE_NOT_FOUND", "DATA_SET_NOT_FOUND", "INTERNAL_FAILURE", "ACCESS_DENIED"
resp.template.version.errors[0].message #=> String
resp.template.version.version_number #=> Integer
resp.template.version.status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED", "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:



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

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

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

Describes the template alias for a template.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :aws_account_id (required, String)

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



3997
3998
3999
4000
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 3997

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

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

Describes read and write permissions on a template.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :aws_account_id (required, String)

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

  • :template_id (required, String)

    The ID for the template.

Returns:

See Also:



4041
4042
4043
4044
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 4041

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

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

Describes a theme.

Examples:

Request syntax with placeholder values


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

Response structure


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



4130
4131
4132
4133
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 4130

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

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

Describes the alias for a theme.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :aws_account_id (required, String)

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



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

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

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

Describes the read and write permissions for a theme.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :aws_account_id (required, String)

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



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

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

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

Returns information about a user, given the user name.

Examples:

Request syntax with placeholder values


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

Response structure


resp.user.arn #=> String
resp.user.user_name #=> String
resp.user.email #=> String
resp.user.role #=> String, one of "ADMIN", "AUTHOR", "READER", "RESTRICTED_AUTHOR", "RESTRICTED_READER"
resp.user.identity_type #=> String, one of "IAM", "QUICKSIGHT"
resp.user.active #=> Boolean
resp.user.principal_id #=> String
resp.user.custom_permissions_name #=> String
resp.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:



4269
4270
4271
4272
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 4269

def describe_user(params = {}, options = {})
  req = build_request(:describe_user, 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 in your website, without having to register any reader users. Before you use this action, make sure that you have configured the dashboards and permissions.

The following rules apply to the generated URL:

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

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

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

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

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

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

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: "RestrictiveResourceId", # required
    },
  },
})

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.

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

  • :authorized_resource_arns (required, Array<String>)

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

  • :experience_configuration (required, Types::AnonymousUserEmbeddingExperienceConfiguration)

    The configuration of the experience you are embedding.

Returns:

See Also:



4380
4381
4382
4383
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 4380

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 (default) to 10 hours (maximum).

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

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

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

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: "RestrictiveResourceId", # required
    },
    quick_sight_console: {
      initial_path: "EntryPath",
    },
  },
})

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 you are embedding. For registered users, you can embed Amazon QuickSight dashboards or the entire Amazon QuickSight console.

Returns:

See Also:



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

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 session URL and authorization code that you can use to embed an Amazon Amazon QuickSight read-only dashboard in your web server code. Before you use this command, make sure that you have configured the dashboards and permissions.

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

  • They must be used together.

  • They can be used one time only.

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

  • The resulting user session is valid for 10 hours.

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

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

Examples:

Request syntax with placeholder values


resp = client.get_dashboard_embed_url({
  aws_account_id: "AwsAccountId", # required
  dashboard_id: "RestrictiveResourceId", # required
  identity_type: "IAM", # required, accepts IAM, QUICKSIGHT, 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: ["RestrictiveResourceId"],
})

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

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

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

  • :namespace (String)

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

  • :additional_dashboard_ids (Array<String>)

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

Returns:

See Also:



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

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. Identity and Access Management (IAM) users and IAM role-based sessions authenticated through Federated Single Sign-On using SAML, OpenID Connect, or IAM federation

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

Returns:

See Also:



4688
4689
4690
4691
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 4688

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:



4739
4740
4741
4742
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 4739

def list_analyses(params = {}, options = {})
  req = build_request(:list_analyses, 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: "RestrictiveResourceId", # required
  next_token: "String",
  max_results: 1,
})

Response structure


resp.dashboard_version_summary_list #=> Array
resp.dashboard_version_summary_list[0].arn #=> String
resp.dashboard_version_summary_list[0].created_time #=> Time
resp.dashboard_version_summary_list[0].version_number #=> Integer
resp.dashboard_version_summary_list[0].status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED", "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:



4796
4797
4798
4799
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 4796

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:



4849
4850
4851
4852
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 4849

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:



4911
4912
4913
4914
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 4911

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"
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.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.s3_parameters.manifest_file_location.bucket #=> String
resp.data_sources[0].data_source_parameters.s3_parameters.manifest_file_location.key #=> String
resp.data_sources[0].data_source_parameters.service_now_parameters.site_base_url #=> String
resp.data_sources[0].data_source_parameters.snowflake_parameters.host #=> String
resp.data_sources[0].data_source_parameters.snowflake_parameters.database #=> String
resp.data_sources[0].data_source_parameters.snowflake_parameters.warehouse #=> String
resp.data_sources[0].data_source_parameters.spark_parameters.host #=> String
resp.data_sources[0].data_source_parameters.spark_parameters.port #=> Integer
resp.data_sources[0].data_source_parameters.sql_server_parameters.host #=> String
resp.data_sources[0].data_source_parameters.sql_server_parameters.port #=> Integer
resp.data_sources[0].data_source_parameters.sql_server_parameters.database #=> String
resp.data_sources[0].data_source_parameters.teradata_parameters.host #=> String
resp.data_sources[0].data_source_parameters.teradata_parameters.port #=> Integer
resp.data_sources[0].data_source_parameters.teradata_parameters.database #=> String
resp.data_sources[0].data_source_parameters.twitter_parameters.query #=> String
resp.data_sources[0].data_source_parameters.twitter_parameters.max_rows #=> Integer
resp.data_sources[0].data_source_parameters.amazon_open_search_parameters.domain #=> 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].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].s3_parameters.manifest_file_location.bucket #=> String
resp.data_sources[0].alternate_data_source_parameters[0].s3_parameters.manifest_file_location.key #=> String
resp.data_sources[0].alternate_data_source_parameters[0].service_now_parameters.site_base_url #=> String
resp.data_sources[0].alternate_data_source_parameters[0].snowflake_parameters.host #=> String
resp.data_sources[0].alternate_data_source_parameters[0].snowflake_parameters.database #=> String
resp.data_sources[0].alternate_data_source_parameters[0].snowflake_parameters.warehouse #=> String
resp.data_sources[0].alternate_data_source_parameters[0].spark_parameters.host #=> String
resp.data_sources[0].alternate_data_source_parameters[0].spark_parameters.port #=> Integer
resp.data_sources[0].alternate_data_source_parameters[0].sql_server_parameters.host #=> String
resp.data_sources[0].alternate_data_source_parameters[0].sql_server_parameters.port #=> Integer
resp.data_sources[0].alternate_data_source_parameters[0].sql_server_parameters.database #=> String
resp.data_sources[0].alternate_data_source_parameters[0].teradata_parameters.host #=> String
resp.data_sources[0].alternate_data_source_parameters[0].teradata_parameters.port #=> Integer
resp.data_sources[0].alternate_data_source_parameters[0].teradata_parameters.database #=> String
resp.data_sources[0].alternate_data_source_parameters[0].twitter_parameters.query #=> String
resp.data_sources[0].alternate_data_source_parameters[0].twitter_parameters.max_rows #=> Integer
resp.data_sources[0].alternate_data_source_parameters[0].amazon_open_search_parameters.domain #=> 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.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:



5065
5066
5067
5068
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 5065

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.

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 AWS account ID.

  • :folder_id (required, String)

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



5114
5115
5116
5117
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 5114

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.

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"
resp.folder_summary_list[0].created_time #=> Time
resp.folder_summary_list[0].last_updated_time #=> Time
resp.next_token #=> String
resp.request_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :aws_account_id (required, String)

    The AWS account ID.

  • :next_token (String)

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

  • :max_results (Integer)

    The maximum number of results to be returned per request.

Returns:

See Also:



5163
5164
5165
5166
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 5163

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.

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. Currently, you should set this to default.

Returns:

See Also:



5217
5218
5219
5220
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 5217

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

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

Lists all user groups in Amazon QuickSight.

Examples:

Request syntax with placeholder values


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