# WARNING ABOUT GENERATED CODE # # This file is generated. See the contributing guide for more information: # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md # # WARNING ABOUT GENERATED CODE require 'seahorse/client/plugins/content_length.rb' require 'aws-sdk-core/plugins/credentials_configuration.rb' require 'aws-sdk-core/plugins/logging.rb' require 'aws-sdk-core/plugins/param_converter.rb' require 'aws-sdk-core/plugins/param_validator.rb' require 'aws-sdk-core/plugins/user_agent.rb' require 'aws-sdk-core/plugins/helpful_socket_errors.rb' require 'aws-sdk-core/plugins/retry_errors.rb' require 'aws-sdk-core/plugins/global_configuration.rb' require 'aws-sdk-core/plugins/regional_endpoint.rb' require 'aws-sdk-core/plugins/endpoint_discovery.rb' require 'aws-sdk-core/plugins/endpoint_pattern.rb' require 'aws-sdk-core/plugins/response_paging.rb' require 'aws-sdk-core/plugins/stub_responses.rb' require 'aws-sdk-core/plugins/idempotency_token.rb' require 'aws-sdk-core/plugins/jsonvalue_converter.rb' require 'aws-sdk-core/plugins/client_metrics_plugin.rb' require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb' require 'aws-sdk-core/plugins/transfer_encoding.rb' require 'aws-sdk-core/plugins/signature_v4.rb' require 'aws-sdk-core/plugins/protocols/rest_json.rb' Aws::Plugins::GlobalConfiguration.add_identifier(:quicksight) module Aws::QuickSight class Client < Seahorse::Client::Base include Aws::ClientStubs @identifier = :quicksight set_api(ClientApi::API) add_plugin(Seahorse::Client::Plugins::ContentLength) add_plugin(Aws::Plugins::CredentialsConfiguration) add_plugin(Aws::Plugins::Logging) add_plugin(Aws::Plugins::ParamConverter) add_plugin(Aws::Plugins::ParamValidator) add_plugin(Aws::Plugins::UserAgent) add_plugin(Aws::Plugins::HelpfulSocketErrors) add_plugin(Aws::Plugins::RetryErrors) add_plugin(Aws::Plugins::GlobalConfiguration) add_plugin(Aws::Plugins::RegionalEndpoint) add_plugin(Aws::Plugins::EndpointDiscovery) add_plugin(Aws::Plugins::EndpointPattern) add_plugin(Aws::Plugins::ResponsePaging) add_plugin(Aws::Plugins::StubResponses) add_plugin(Aws::Plugins::IdempotencyToken) add_plugin(Aws::Plugins::JsonvalueConverter) add_plugin(Aws::Plugins::ClientMetricsPlugin) add_plugin(Aws::Plugins::ClientMetricsSendPlugin) add_plugin(Aws::Plugins::TransferEncoding) add_plugin(Aws::Plugins::SignatureV4) add_plugin(Aws::Plugins::Protocols::RestJson) # @overload initialize(options) # @param [Hash] options # @option options [required, Aws::CredentialProvider] :credentials # Your AWS credentials. This can be an instance of any one of the # following classes: # # * `Aws::Credentials` - Used for configuring static, non-refreshing # credentials. # # * `Aws::InstanceProfileCredentials` - Used for loading credentials # from an EC2 IMDS on an EC2 instance. # # * `Aws::SharedCredentials` - Used for loading credentials from a # shared file, such as `~/.aws/config`. # # * `Aws::AssumeRoleCredentials` - Used when you need to assume a role. # # When `:credentials` are not configured directly, the following # locations will be searched for credentials: # # * `Aws.config[:credentials]` # * The `:access_key_id`, `:secret_access_key`, and `:session_token` options. # * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY'] # * `~/.aws/credentials` # * `~/.aws/config` # * EC2 IMDS instance profile - When used by default, the timeouts are # very aggressive. Construct and pass an instance of # `Aws::InstanceProfileCredentails` to enable retries and extended # timeouts. # # @option options [required, String] :region # The AWS region to connect to. The configured `:region` is # used to determine the service `:endpoint`. When not passed, # a default `:region` is search for in the following locations: # # * `Aws.config[:region]` # * `ENV['AWS_REGION']` # * `ENV['AMAZON_REGION']` # * `ENV['AWS_DEFAULT_REGION']` # * `~/.aws/credentials` # * `~/.aws/config` # # @option options [String] :access_key_id # # @option options [Boolean] :active_endpoint_cache (false) # When set to `true`, a thread polling for endpoints will be running in # the background every 60 secs (default). Defaults to `false`. # # @option options [Boolean] :client_side_monitoring (false) # When `true`, client-side metrics will be collected for all API requests from # this client. # # @option options [String] :client_side_monitoring_client_id ("") # Allows you to provide an identifier for this client which will be attached to # all generated client side metrics. Defaults to an empty string. # # @option options [String] :client_side_monitoring_host ("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. # # @option options [Integer] :client_side_monitoring_port (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. # # @option options [Aws::ClientSideMonitoring::Publisher] :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher) # Allows you to provide a custom client-side monitoring publisher class. By default, # will use the Client Side Monitoring Agent Publisher. # # @option options [Boolean] :convert_params (true) # When `true`, an attempt is made to coerce request parameters into # the required types. # # @option options [Boolean] :disable_host_prefix_injection (false) # Set to true to disable SDK automatically adding host prefix # to default service endpoint when available. # # @option options [String] :endpoint # The client endpoint is normally constructed from the `:region` # option. You should only configure an `:endpoint` when connecting # to test endpoints. This should be avalid HTTP(S) URI. # # @option options [Integer] :endpoint_cache_max_entries (1000) # Used for the maximum size limit of the LRU cache storing endpoints data # for endpoint discovery enabled operations. Defaults to 1000. # # @option options [Integer] :endpoint_cache_max_threads (10) # Used for the maximum threads in use for polling endpoints to be cached, defaults to 10. # # @option options [Integer] :endpoint_cache_poll_interval (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. # # @option options [Boolean] :endpoint_discovery (false) # When set to `true`, endpoint discovery will be enabled for operations when available. Defaults to `false`. # # @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default) # The log formatter. # # @option options [Symbol] :log_level (:info) # The log level to send messages to the `:logger` at. # # @option options [Logger] :logger # The Logger instance to send log messages to. If this option # is not set, logging will be disabled. # # @option options [String] :profile ("default") # Used when loading credentials from the shared credentials file # at HOME/.aws/credentials. When not specified, 'default' is used. # # @option options [Float] :retry_base_delay (0.3) # The base delay in seconds used by the default backoff function. # # @option options [Symbol] :retry_jitter (: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. # # @see https://www.awsarchitectureblog.com/2015/03/backoff.html # # @option options [Integer] :retry_limit (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 and auth # errors from expired credentials. # # @option options [Integer] :retry_max_delay (0) # The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function. # # @option options [String] :secret_access_key # # @option options [String] :session_token # # @option options [Boolean] :stub_responses (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. # # @option options [Boolean] :validate_params (true) # When `true`, request parameters are validated before # sending the request. # # @option options [URI::HTTP,String] :http_proxy A proxy to send # requests through. Formatted like 'http://proxy.com:123'. # # @option options [Float] :http_open_timeout (15) The number of # seconds to wait when opening a HTTP session before rasing a # `Timeout::Error`. # # @option options [Integer] :http_read_timeout (60) The default # number of seconds to wait for response data. This value can # safely be set # per-request on the session yeidled by {#session_for}. # # @option options [Float] :http_idle_timeout (5) The number of # seconds a connection is allowed to sit idble before it is # considered stale. Stale connections are closed and removed # from the pool before making a request. # # @option options [Float] :http_continue_timeout (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 yeidled by {#session_for}. # # @option options [Boolean] :http_wire_trace (false) When `true`, # HTTP debug output will be sent to the `:logger`. # # @option options [Boolean] :ssl_verify_peer (true) When `true`, # SSL peer certificates are verified when establishing a # connection. # # @option options [String] :ssl_ca_bundle 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. # # @option options [String] :ssl_ca_directory 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. # def initialize(*args) super end # @!group API Operations # Cancels an ongoing ingestion of data into SPICE. # # @option params [required, String] :aws_account_id # The AWS account ID. # # @option params [required, String] :data_set_id # The ID of the dataset used in the ingestion. # # @option params [required, String] :ingestion_id # An ID for the ingestion. # # @return [Types::CancelIngestionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::CancelIngestionResponse#arn #arn} => String # * {Types::CancelIngestionResponse#ingestion_id #ingestion_id} => String # * {Types::CancelIngestionResponse#request_id #request_id} => String # * {Types::CancelIngestionResponse#status #status} => Integer # # @example Request syntax with placeholder values # # resp = client.cancel_ingestion({ # aws_account_id: "AwsAccountId", # required # data_set_id: "string", # required # ingestion_id: "IngestionId", # required # }) # # @example Response structure # # resp.arn #=> String # resp.ingestion_id #=> String # resp.request_id #=> String # resp.status #=> Integer # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CancelIngestion AWS API Documentation # # @overload cancel_ingestion(params = {}) # @param [Hash] params ({}) def cancel_ingestion(params = {}, options = {}) req = build_request(:cancel_ingestion, params) req.send_request(options) end # Creates a dashboard from a template. To first create a template, see # the CreateTemplate API operation. # # A dashboard is an entity in QuickSight that identifies QuickSight # reports, created from analyses. You can share QuickSight dashboards. # With the right permissions, you can create scheduled email reports # from them. The `CreateDashboard`, `DescribeDashboard`, and # `ListDashboardsByUser` API operations act on the dashboard entity. If # you have the correct permissions, you can create a dashboard from a # template that exists in a different AWS account. # # @option params [required, String] :aws_account_id # The ID of the AWS account where you want to create the dashboard. # # @option params [required, String] :dashboard_id # The ID for the dashboard, also added to the IAM policy. # # @option params [required, String] :name # The display name of the dashboard. # # @option params [Types::Parameters] :parameters # A structure that contains the parameters of the dashboard. These are # parameter overrides for a dashboard. A dashboard can have any type of # parameters, and some parameters might accept multiple values. You can # use the dashboard permissions structure described following to # override two string parameters that accept multiple values. # # @option params [Array] :permissions # A structure that contains the permissions of the dashboard. You can # use this structure for granting permissions with principal and action # information. # # @option params [required, Types::DashboardSourceEntity] :source_entity # The source entity from which the dashboard is created. The source # entity accepts the Amazon Resource Name (ARN) of the source template # or analysis and also references the replacement datasets for the # placeholders set when creating the template. The replacement datasets # need to follow the same schema as the datasets for which placeholders # were created when creating the template. # # If you are creating a dashboard from a source entity in a different # AWS account, use the ARN of the source template. # # @option params [Array] :tags # Contains a map of the key-value pairs for the resource tag or tags # assigned to the dashboard. # # @option params [String] :version_description # A description for the first version of the dashboard being created. # # @option params [Types::DashboardPublishOptions] :dashboard_publish_options # Options for publishing the dashboard when you create it: # # * `AvailabilityStatus` for `AdHocFilteringOption` - This status can be # either `ENABLED` or `DISABLED`. When this is set to `DISABLED`, # QuickSight disables the left filter pane on the published dashboard, # which can be used for ad hoc (one-time) filtering. This option is # `ENABLED` by default. # # * `AvailabilityStatus` for `ExportToCSVOption` - This status can be # either `ENABLED` or `DISABLED`. The visual option to export data to # .csv format isn't enabled when this is set to `DISABLED`. This # option is `ENABLED` by default. # # * `VisibilityState` for `SheetControlsOption` - This visibility state # can be either `COLLAPSED` or `EXPANDED`. The sheet controls pane is # collapsed by default when set to true. This option is `COLLAPSED` by # default. # # @return [Types::CreateDashboardResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::CreateDashboardResponse#arn #arn} => String # * {Types::CreateDashboardResponse#version_arn #version_arn} => String # * {Types::CreateDashboardResponse#dashboard_id #dashboard_id} => String # * {Types::CreateDashboardResponse#creation_status #creation_status} => String # * {Types::CreateDashboardResponse#status #status} => Integer # * {Types::CreateDashboardResponse#request_id #request_id} => String # # @example 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 # }, # }, # }) # # @example Response structure # # resp.arn #=> String # resp.version_arn #=> String # resp.dashboard_id #=> String # resp.creation_status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED" # resp.status #=> Integer # resp.request_id #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CreateDashboard AWS API Documentation # # @overload create_dashboard(params = {}) # @param [Hash] params ({}) def create_dashboard(params = {}, options = {}) req = build_request(:create_dashboard, params) req.send_request(options) end # Creates a dataset. # # @option params [required, String] :aws_account_id # The AWS account ID. # # @option params [required, String] :data_set_id # An ID for the dataset that you want to create. This ID is unique per # AWS Region for each AWS account. # # @option params [required, String] :name # The display name for the dataset. # # @option params [required, Hash] :physical_table_map # Declares the physical tables that are available in the underlying data # sources. # # @option params [Hash] :logical_table_map # Configures the combination and transformation of the data from the # physical tables. # # @option params [required, String] :import_mode # Indicates whether you want to import the data into SPICE. # # @option params [Array] :column_groups # Groupings of columns that work together in certain QuickSight # features. Currently, only geospatial hierarchy is supported. # # @option params [Array] :permissions # A list of resource permissions on the dataset. # # @option params [Types::RowLevelPermissionDataSet] :row_level_permission_data_set # The row-level security configuration for the data that you want to # create. # # @option params [Array] :tags # Contains a map of the key-value pairs for the resource tag or tags # assigned to the dataset. # # @return [Types::CreateDataSetResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::CreateDataSetResponse#arn #arn} => String # * {Types::CreateDataSetResponse#data_set_id #data_set_id} => String # * {Types::CreateDataSetResponse#ingestion_arn #ingestion_arn} => String # * {Types::CreateDataSetResponse#ingestion_id #ingestion_id} => String # * {Types::CreateDataSetResponse#request_id #request_id} => String # * {Types::CreateDataSetResponse#status #status} => Integer # # @example Request syntax with placeholder values # # resp = client.create_data_set({ # aws_account_id: "AwsAccountId", # required # data_set_id: "ResourceId", # required # name: "ResourceName", # required # physical_table_map: { # required # "PhysicalTableId" => { # relational_table: { # data_source_arn: "Arn", # required # schema: "RelationalTableSchema", # name: "RelationalTableName", # required # input_columns: [ # required # { # name: "ColumnName", # required # type: "STRING", # required, accepts STRING, INTEGER, DECIMAL, DATETIME, BIT, BOOLEAN, JSON # }, # ], # }, # custom_sql: { # data_source_arn: "Arn", # required # name: "CustomSqlName", # required # sql_query: "SqlQuery", # required # columns: [ # { # name: "ColumnName", # required # type: "STRING", # required, accepts STRING, INTEGER, DECIMAL, DATETIME, BIT, BOOLEAN, JSON # }, # ], # }, # s3_source: { # data_source_arn: "Arn", # required # upload_settings: { # format: "CSV", # accepts CSV, TSV, CLF, ELF, XLSX, JSON # start_from_row: 1, # contains_header: false, # text_qualifier: "DOUBLE_QUOTE", # accepts DOUBLE_QUOTE, SINGLE_QUOTE # delimiter: "Delimiter", # }, # input_columns: [ # required # { # name: "ColumnName", # required # type: "STRING", # required, accepts STRING, INTEGER, DECIMAL, DATETIME, BIT, BOOLEAN, JSON # }, # ], # }, # }, # }, # logical_table_map: { # "LogicalTableId" => { # alias: "LogicalTableAlias", # required # data_transforms: [ # { # project_operation: { # projected_columns: ["String"], # required # }, # filter_operation: { # condition_expression: "Expression", # required # }, # create_columns_operation: { # columns: [ # required # { # column_name: "ColumnName", # required # column_id: "ColumnId", # required # expression: "Expression", # required # }, # ], # }, # rename_column_operation: { # column_name: "ColumnName", # required # new_column_name: "ColumnName", # required # }, # cast_column_type_operation: { # column_name: "ColumnName", # required # new_column_type: "STRING", # required, accepts STRING, INTEGER, DECIMAL, DATETIME # format: "TypeCastFormat", # }, # tag_column_operation: { # column_name: "ColumnName", # required # tags: [ # required # { # column_geographic_role: "COUNTRY", # accepts COUNTRY, STATE, COUNTY, CITY, POSTCODE, LONGITUDE, LATITUDE # }, # ], # }, # }, # ], # source: { # required # join_instruction: { # left_operand: "LogicalTableId", # required # right_operand: "LogicalTableId", # required # type: "INNER", # required, accepts INNER, OUTER, LEFT, RIGHT # on_clause: "OnClause", # required # }, # physical_table_id: "PhysicalTableId", # }, # }, # }, # import_mode: "SPICE", # required, accepts SPICE, DIRECT_QUERY # column_groups: [ # { # geo_spatial_column_group: { # name: "ColumnGroupName", # required # country_code: "US", # required, accepts US # columns: ["ColumnName"], # required # }, # }, # ], # permissions: [ # { # principal: "Principal", # required # actions: ["String"], # required # }, # ], # row_level_permission_data_set: { # arn: "Arn", # required # permission_policy: "GRANT_ACCESS", # required, accepts GRANT_ACCESS, DENY_ACCESS # }, # tags: [ # { # key: "TagKey", # required # value: "TagValue", # required # }, # ], # }) # # @example 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 # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CreateDataSet AWS API Documentation # # @overload create_data_set(params = {}) # @param [Hash] params ({}) def create_data_set(params = {}, options = {}) req = build_request(:create_data_set, params) req.send_request(options) end # Creates a data source. # # @option params [required, String] :aws_account_id # The AWS account ID. # # @option params [required, String] :data_source_id # An ID for the data source. This ID is unique per AWS Region for each # AWS account. # # @option params [required, String] :name # A display name for the data source. # # @option params [required, String] :type # The type of the data source. Currently, the supported types for this # operation are: `ATHENA, AURORA, AURORA_POSTGRESQL, MARIADB, MYSQL, # POSTGRESQL, PRESTO, REDSHIFT, S3, SNOWFLAKE, SPARK, SQLSERVER, # TERADATA`. Use `ListDataSources` to return a list of all data sources. # # @option params [Types::DataSourceParameters] :data_source_parameters # The parameters that QuickSight uses to connect to your underlying # source. # # @option params [Types::DataSourceCredentials] :credentials # The credentials QuickSight that uses to connect to your underlying # source. Currently, only credentials based on user name and password # are supported. # # @option params [Array] :permissions # A list of resource permissions on the data source. # # @option params [Types::VpcConnectionProperties] :vpc_connection_properties # Use this parameter only when you want QuickSight to use a VPC # connection when connecting to your underlying source. # # @option params [Types::SslProperties] :ssl_properties # Secure Socket Layer (SSL) properties that apply when QuickSight # connects to your underlying source. # # @option params [Array] :tags # Contains a map of the key-value pairs for the resource tag or tags # assigned to the data source. # # @return [Types::CreateDataSourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::CreateDataSourceResponse#arn #arn} => String # * {Types::CreateDataSourceResponse#data_source_id #data_source_id} => String # * {Types::CreateDataSourceResponse#creation_status #creation_status} => String # * {Types::CreateDataSourceResponse#request_id #request_id} => String # * {Types::CreateDataSourceResponse#status #status} => Integer # # @example Request syntax with placeholder values # # resp = client.create_data_source({ # aws_account_id: "AwsAccountId", # required # data_source_id: "ResourceId", # required # name: "ResourceName", # required # type: "ADOBE_ANALYTICS", # required, accepts ADOBE_ANALYTICS, AMAZON_ELASTICSEARCH, ATHENA, AURORA, AURORA_POSTGRESQL, AWS_IOT_ANALYTICS, GITHUB, JIRA, MARIADB, MYSQL, POSTGRESQL, PRESTO, REDSHIFT, S3, SALESFORCE, SERVICENOW, SNOWFLAKE, SPARK, SQLSERVER, TERADATA, TWITTER # data_source_parameters: { # amazon_elasticsearch_parameters: { # domain: "Domain", # required # }, # athena_parameters: { # work_group: "WorkGroup", # }, # aurora_parameters: { # host: "Host", # required # port: 1, # required # database: "Database", # required # }, # aurora_postgre_sql_parameters: { # host: "Host", # required # port: 1, # required # database: "Database", # required # }, # aws_iot_analytics_parameters: { # data_set_name: "DataSetName", # required # }, # jira_parameters: { # site_base_url: "SiteBaseUrl", # required # }, # maria_db_parameters: { # host: "Host", # required # port: 1, # required # database: "Database", # required # }, # my_sql_parameters: { # host: "Host", # required # port: 1, # required # database: "Database", # required # }, # postgre_sql_parameters: { # host: "Host", # required # port: 1, # required # database: "Database", # required # }, # presto_parameters: { # host: "Host", # required # port: 1, # required # catalog: "Catalog", # required # }, # rds_parameters: { # instance_id: "InstanceId", # required # database: "Database", # required # }, # redshift_parameters: { # host: "Host", # port: 1, # database: "Database", # required # cluster_id: "ClusterId", # }, # s3_parameters: { # manifest_file_location: { # required # bucket: "S3Bucket", # required # key: "S3Key", # required # }, # }, # service_now_parameters: { # site_base_url: "SiteBaseUrl", # required # }, # snowflake_parameters: { # host: "Host", # required # database: "Database", # required # warehouse: "Warehouse", # required # }, # spark_parameters: { # host: "Host", # required # port: 1, # required # }, # sql_server_parameters: { # host: "Host", # required # port: 1, # required # database: "Database", # required # }, # teradata_parameters: { # host: "Host", # required # port: 1, # required # database: "Database", # required # }, # twitter_parameters: { # query: "Query", # required # max_rows: 1, # required # }, # }, # credentials: { # credential_pair: { # username: "Username", # required # password: "Password", # required # }, # }, # 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 # }, # ], # }) # # @example Response structure # # resp.arn #=> String # resp.data_source_id #=> String # resp.creation_status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED" # resp.request_id #=> String # resp.status #=> Integer # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CreateDataSource AWS API Documentation # # @overload create_data_source(params = {}) # @param [Hash] params ({}) def create_data_source(params = {}, options = {}) req = build_request(:create_data_source, params) req.send_request(options) end # Creates an Amazon QuickSight group. # # The permissions resource is # `arn:aws:quicksight:us-east-1::group/default/ # `. # # The response is a group object. # # @option params [required, String] :group_name # A name for the group that you want to create. # # @option params [String] :description # A description for the group that you want to create. # # @option params [required, String] :aws_account_id # The ID for the AWS account that the group is in. Currently, you use # the ID for the AWS account that contains your Amazon QuickSight # account. # # @option params [required, String] :namespace # The namespace. Currently, you should set this to `default`. # # @return [Types::CreateGroupResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::CreateGroupResponse#group #group} => Types::Group # * {Types::CreateGroupResponse#request_id #request_id} => String # * {Types::CreateGroupResponse#status #status} => Integer # # @example Request syntax with placeholder values # # resp = client.create_group({ # group_name: "GroupName", # required # description: "GroupDescription", # aws_account_id: "AwsAccountId", # required # namespace: "Namespace", # required # }) # # @example 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 # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CreateGroup AWS API Documentation # # @overload create_group(params = {}) # @param [Hash] params ({}) def create_group(params = {}, options = {}) req = build_request(:create_group, params) req.send_request(options) end # Adds an Amazon QuickSight user to an Amazon QuickSight group. # # @option params [required, String] :member_name # The name of the user that you want to add to the group membership. # # @option params [required, String] :group_name # The name of the group that you want to add the user to. # # @option params [required, String] :aws_account_id # The ID for the AWS account that the group is in. Currently, you use # the ID for the AWS account that contains your Amazon QuickSight # account. # # @option params [required, String] :namespace # The namespace. Currently, you should set this to `default`. # # @return [Types::CreateGroupMembershipResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::CreateGroupMembershipResponse#group_member #group_member} => Types::GroupMember # * {Types::CreateGroupMembershipResponse#request_id #request_id} => String # * {Types::CreateGroupMembershipResponse#status #status} => Integer # # @example 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 # }) # # @example Response structure # # resp.group_member.arn #=> String # resp.group_member.member_name #=> String # resp.request_id #=> String # resp.status #=> Integer # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CreateGroupMembership AWS API Documentation # # @overload create_group_membership(params = {}) # @param [Hash] params ({}) def create_group_membership(params = {}, options = {}) req = build_request(:create_group_membership, params) req.send_request(options) end # Creates an assignment with one specified IAM policy, identified by its # Amazon Resource Name (ARN). This policy will be assigned to specified # groups or users of Amazon QuickSight. The users and groups need to be # in the same namespace. # # @option params [required, String] :aws_account_id # The ID of the AWS account where you want to assign an IAM policy to # QuickSight users or groups. # # @option params [required, String] :assignment_name # The name of the assignment. It must be unique within an AWS account. # # @option params [required, String] :assignment_status # 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. # # @option params [String] :policy_arn # The ARN for the IAM policy to apply to the QuickSight users and groups # specified in this assignment. # # @option params [Hash] :identities # The QuickSight users, groups, or both that you want to assign the # policy to. # # @option params [required, String] :namespace # The namespace that contains the assignment. # # @return [Types::CreateIAMPolicyAssignmentResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::CreateIAMPolicyAssignmentResponse#assignment_name #assignment_name} => String # * {Types::CreateIAMPolicyAssignmentResponse#assignment_id #assignment_id} => String # * {Types::CreateIAMPolicyAssignmentResponse#assignment_status #assignment_status} => String # * {Types::CreateIAMPolicyAssignmentResponse#policy_arn #policy_arn} => String # * {Types::CreateIAMPolicyAssignmentResponse#identities #identities} => Hash<String,Array<String>> # * {Types::CreateIAMPolicyAssignmentResponse#request_id #request_id} => String # * {Types::CreateIAMPolicyAssignmentResponse#status #status} => Integer # # @example 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 # }) # # @example 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 # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CreateIAMPolicyAssignment AWS API Documentation # # @overload create_iam_policy_assignment(params = {}) # @param [Hash] params ({}) def create_iam_policy_assignment(params = {}, options = {}) req = build_request(:create_iam_policy_assignment, params) req.send_request(options) end # 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?][1] in the AWS Knowledge Center. Tags are visible on the tagged # dataset, but not on the ingestion resource. # # # # [1]: https://aws.example.com/premiumsupport/knowledge-center/iam-ec2-resource-tags/ # # @option params [required, String] :data_set_id # The ID of the dataset used in the ingestion. # # @option params [required, String] :ingestion_id # An ID for the ingestion. # # @option params [required, String] :aws_account_id # The AWS account ID. # # @return [Types::CreateIngestionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::CreateIngestionResponse#arn #arn} => String # * {Types::CreateIngestionResponse#ingestion_id #ingestion_id} => String # * {Types::CreateIngestionResponse#ingestion_status #ingestion_status} => String # * {Types::CreateIngestionResponse#request_id #request_id} => String # * {Types::CreateIngestionResponse#status #status} => Integer # # @example Request syntax with placeholder values # # resp = client.create_ingestion({ # data_set_id: "string", # required # ingestion_id: "IngestionId", # required # aws_account_id: "AwsAccountId", # required # }) # # @example 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 # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CreateIngestion AWS API Documentation # # @overload create_ingestion(params = {}) # @param [Hash] params ({}) def create_ingestion(params = {}, options = {}) req = build_request(:create_ingestion, params) req.send_request(options) end # Creates a template from an existing QuickSight analysis or template. # You can use the resulting template to create a dashboard. # # A *template* is an entity in QuickSight that encapsulates the metadata # required to create an analysis and that you can use to create s # dashboard. A template adds a layer of abstraction by using # placeholders to replace the dataset associated with the analysis. You # can use templates to create dashboards by replacing dataset # placeholders with datasets that follow the same schema that was used # to create the source analysis and template. # # @option params [required, String] :aws_account_id # The ID for the AWS account that the group is in. Currently, you use # the ID for the AWS account that contains your Amazon QuickSight # account. # # @option params [required, String] :template_id # An ID for the template that you want to create. This template is # unique per AWS Region in each AWS account. # # @option params [String] :name # A display name for the template. # # @option params [Array] :permissions # A list of resource permissions to be set on the template. # # @option params [required, Types::TemplateSourceEntity] :source_entity # The Amazon Resource Name (ARN) of the source entity from which this # template is being created. Currently, you can create a template from # an analysis or another template. If the ARN is for an analysis, # include its dataset references. # # @option params [Array] :tags # Contains a map of the key-value pairs for the resource tag or tags # assigned to the resource. # # @option params [String] :version_description # 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. # # @return [Types::CreateTemplateResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::CreateTemplateResponse#arn #arn} => String # * {Types::CreateTemplateResponse#version_arn #version_arn} => String # * {Types::CreateTemplateResponse#template_id #template_id} => String # * {Types::CreateTemplateResponse#creation_status #creation_status} => String # * {Types::CreateTemplateResponse#status #status} => Integer # * {Types::CreateTemplateResponse#request_id #request_id} => String # # @example 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", # }) # # @example Response structure # # resp.arn #=> String # resp.version_arn #=> String # resp.template_id #=> String # resp.creation_status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED" # resp.status #=> Integer # resp.request_id #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CreateTemplate AWS API Documentation # # @overload create_template(params = {}) # @param [Hash] params ({}) def create_template(params = {}, options = {}) req = build_request(:create_template, params) req.send_request(options) end # Creates a template alias for a template. # # @option params [required, String] :aws_account_id # The ID of the AWS account that contains the template that you creating # an alias for. # # @option params [required, String] :template_id # An ID for the template. # # @option params [required, String] :alias_name # The name that you want to give to the template alias that you're # creating. Don't start the alias name with the `$` character. Alias # names that start with `$` are reserved by QuickSight. # # @option params [required, Integer] :template_version_number # The version number of the template. # # @return [Types::CreateTemplateAliasResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::CreateTemplateAliasResponse#template_alias #template_alias} => Types::TemplateAlias # * {Types::CreateTemplateAliasResponse#status #status} => Integer # * {Types::CreateTemplateAliasResponse#request_id #request_id} => String # # @example 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 # }) # # @example 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 # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CreateTemplateAlias AWS API Documentation # # @overload create_template_alias(params = {}) # @param [Hash] params ({}) def create_template_alias(params = {}, options = {}) req = build_request(:create_template_alias, params) req.send_request(options) end # Deletes a dashboard. # # @option params [required, String] :aws_account_id # The ID of the AWS account that contains the dashboard that you're # deleting. # # @option params [required, String] :dashboard_id # The ID for the dashboard. # # @option params [Integer] :version_number # The version number of the dashboard. If the version number property is # provided, only the specified version of the dashboard is deleted. # # @return [Types::DeleteDashboardResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::DeleteDashboardResponse#status #status} => Integer # * {Types::DeleteDashboardResponse#arn #arn} => String # * {Types::DeleteDashboardResponse#dashboard_id #dashboard_id} => String # * {Types::DeleteDashboardResponse#request_id #request_id} => String # # @example Request syntax with placeholder values # # resp = client.delete_dashboard({ # aws_account_id: "AwsAccountId", # required # dashboard_id: "RestrictiveResourceId", # required # version_number: 1, # }) # # @example Response structure # # resp.status #=> Integer # resp.arn #=> String # resp.dashboard_id #=> String # resp.request_id #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DeleteDashboard AWS API Documentation # # @overload delete_dashboard(params = {}) # @param [Hash] params ({}) def delete_dashboard(params = {}, options = {}) req = build_request(:delete_dashboard, params) req.send_request(options) end # Deletes a dataset. # # @option params [required, String] :aws_account_id # The AWS account ID. # # @option params [required, String] :data_set_id # The ID for the dataset that you want to create. This ID is unique per # AWS Region for each AWS account. # # @return [Types::DeleteDataSetResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::DeleteDataSetResponse#arn #arn} => String # * {Types::DeleteDataSetResponse#data_set_id #data_set_id} => String # * {Types::DeleteDataSetResponse#request_id #request_id} => String # * {Types::DeleteDataSetResponse#status #status} => Integer # # @example Request syntax with placeholder values # # resp = client.delete_data_set({ # aws_account_id: "AwsAccountId", # required # data_set_id: "ResourceId", # required # }) # # @example Response structure # # resp.arn #=> String # resp.data_set_id #=> String # resp.request_id #=> String # resp.status #=> Integer # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DeleteDataSet AWS API Documentation # # @overload delete_data_set(params = {}) # @param [Hash] params ({}) def delete_data_set(params = {}, options = {}) req = build_request(:delete_data_set, params) req.send_request(options) end # Deletes the data source permanently. This action breaks all the # datasets that reference the deleted data source. # # @option params [required, String] :aws_account_id # The AWS account ID. # # @option params [required, String] :data_source_id # The ID of the data source. This ID is unique per AWS Region for each # AWS account. # # @return [Types::DeleteDataSourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::DeleteDataSourceResponse#arn #arn} => String # * {Types::DeleteDataSourceResponse#data_source_id #data_source_id} => String # * {Types::DeleteDataSourceResponse#request_id #request_id} => String # * {Types::DeleteDataSourceResponse#status #status} => Integer # # @example Request syntax with placeholder values # # resp = client.delete_data_source({ # aws_account_id: "AwsAccountId", # required # data_source_id: "ResourceId", # required # }) # # @example Response structure # # resp.arn #=> String # resp.data_source_id #=> String # resp.request_id #=> String # resp.status #=> Integer # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DeleteDataSource AWS API Documentation # # @overload delete_data_source(params = {}) # @param [Hash] params ({}) def delete_data_source(params = {}, options = {}) req = build_request(:delete_data_source, params) req.send_request(options) end # Removes a user group from Amazon QuickSight. # # @option params [required, String] :group_name # The name of the group that you want to delete. # # @option params [required, String] :aws_account_id # The ID for the AWS account that the group is in. Currently, you use # the ID for the AWS account that contains your Amazon QuickSight # account. # # @option params [required, String] :namespace # The namespace. Currently, you should set this to `default`. # # @return [Types::DeleteGroupResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::DeleteGroupResponse#request_id #request_id} => String # * {Types::DeleteGroupResponse#status #status} => Integer # # @example Request syntax with placeholder values # # resp = client.delete_group({ # group_name: "GroupName", # required # aws_account_id: "AwsAccountId", # required # namespace: "Namespace", # required # }) # # @example Response structure # # resp.request_id #=> String # resp.status #=> Integer # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DeleteGroup AWS API Documentation # # @overload delete_group(params = {}) # @param [Hash] params ({}) def delete_group(params = {}, options = {}) req = build_request(:delete_group, params) req.send_request(options) end # Removes a user from a group so that the user is no longer a member of # the group. # # @option params [required, String] :member_name # The name of the user that you want to delete from the group # membership. # # @option params [required, String] :group_name # The name of the group that you want to delete the user from. # # @option params [required, String] :aws_account_id # The ID for the AWS account that the group is in. Currently, you use # the ID for the AWS account that contains your Amazon QuickSight # account. # # @option params [required, String] :namespace # The namespace. Currently, you should set this to `default`. # # @return [Types::DeleteGroupMembershipResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::DeleteGroupMembershipResponse#request_id #request_id} => String # * {Types::DeleteGroupMembershipResponse#status #status} => Integer # # @example 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 # }) # # @example Response structure # # resp.request_id #=> String # resp.status #=> Integer # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DeleteGroupMembership AWS API Documentation # # @overload delete_group_membership(params = {}) # @param [Hash] params ({}) def delete_group_membership(params = {}, options = {}) req = build_request(:delete_group_membership, params) req.send_request(options) end # Deletes an existing IAM policy assignment. # # @option params [required, String] :aws_account_id # The AWS account ID where you want to delete the IAM policy assignment. # # @option params [required, String] :assignment_name # The name of the assignment. # # @option params [required, String] :namespace # The namespace that contains the assignment. # # @return [Types::DeleteIAMPolicyAssignmentResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::DeleteIAMPolicyAssignmentResponse#assignment_name #assignment_name} => String # * {Types::DeleteIAMPolicyAssignmentResponse#request_id #request_id} => String # * {Types::DeleteIAMPolicyAssignmentResponse#status #status} => Integer # # @example Request syntax with placeholder values # # resp = client.delete_iam_policy_assignment({ # aws_account_id: "AwsAccountId", # required # assignment_name: "IAMPolicyAssignmentName", # required # namespace: "Namespace", # required # }) # # @example Response structure # # resp.assignment_name #=> String # resp.request_id #=> String # resp.status #=> Integer # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DeleteIAMPolicyAssignment AWS API Documentation # # @overload delete_iam_policy_assignment(params = {}) # @param [Hash] params ({}) def delete_iam_policy_assignment(params = {}, options = {}) req = build_request(:delete_iam_policy_assignment, params) req.send_request(options) end # Deletes a template. # # @option params [required, String] :aws_account_id # The ID of the AWS account that contains the template that you're # deleting. # # @option params [required, String] :template_id # An ID for the template you want to delete. # # @option params [Integer] :version_number # 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. # # @return [Types::DeleteTemplateResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::DeleteTemplateResponse#request_id #request_id} => String # * {Types::DeleteTemplateResponse#arn #arn} => String # * {Types::DeleteTemplateResponse#template_id #template_id} => String # * {Types::DeleteTemplateResponse#status #status} => Integer # # @example Request syntax with placeholder values # # resp = client.delete_template({ # aws_account_id: "AwsAccountId", # required # template_id: "RestrictiveResourceId", # required # version_number: 1, # }) # # @example Response structure # # resp.request_id #=> String # resp.arn #=> String # resp.template_id #=> String # resp.status #=> Integer # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DeleteTemplate AWS API Documentation # # @overload delete_template(params = {}) # @param [Hash] params ({}) def delete_template(params = {}, options = {}) req = build_request(:delete_template, params) req.send_request(options) end # 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. # # @option params [required, String] :aws_account_id # The ID of the AWS account that contains the item to delete. # # @option params [required, String] :template_id # The ID for the template that the specified alias is for. # # @option params [required, String] :alias_name # The name for the template alias. If you name a specific alias, you # delete 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. # # @return [Types::DeleteTemplateAliasResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::DeleteTemplateAliasResponse#status #status} => Integer # * {Types::DeleteTemplateAliasResponse#template_id #template_id} => String # * {Types::DeleteTemplateAliasResponse#alias_name #alias_name} => String # * {Types::DeleteTemplateAliasResponse#arn #arn} => String # * {Types::DeleteTemplateAliasResponse#request_id #request_id} => String # # @example Request syntax with placeholder values # # resp = client.delete_template_alias({ # aws_account_id: "AwsAccountId", # required # template_id: "RestrictiveResourceId", # required # alias_name: "AliasName", # required # }) # # @example Response structure # # resp.status #=> Integer # resp.template_id #=> String # resp.alias_name #=> String # resp.arn #=> String # resp.request_id #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DeleteTemplateAlias AWS API Documentation # # @overload delete_template_alias(params = {}) # @param [Hash] params ({}) def delete_template_alias(params = {}, options = {}) req = build_request(:delete_template_alias, params) req.send_request(options) end # Deletes the Amazon QuickSight user that is associated with the # identity of the AWS Identity and Access Management (IAM) user or role # that's making the call. The IAM user isn't deleted as a result of # this call. # # @option params [required, String] :user_name # The name of the user that you want to delete. # # @option params [required, String] :aws_account_id # The ID for the AWS account that the user is in. Currently, you use the # ID for the AWS account that contains your Amazon QuickSight account. # # @option params [required, String] :namespace # The namespace. Currently, you should set this to `default`. # # @return [Types::DeleteUserResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::DeleteUserResponse#request_id #request_id} => String # * {Types::DeleteUserResponse#status #status} => Integer # # @example Request syntax with placeholder values # # resp = client.delete_user({ # user_name: "UserName", # required # aws_account_id: "AwsAccountId", # required # namespace: "Namespace", # required # }) # # @example Response structure # # resp.request_id #=> String # resp.status #=> Integer # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DeleteUser AWS API Documentation # # @overload delete_user(params = {}) # @param [Hash] params ({}) def delete_user(params = {}, options = {}) req = build_request(:delete_user, params) req.send_request(options) end # Deletes a user identified by its principal ID. # # @option params [required, String] :principal_id # The principal ID of the user. # # @option params [required, String] :aws_account_id # The ID for the AWS account that the user is in. Currently, you use the # ID for the AWS account that contains your Amazon QuickSight account. # # @option params [required, String] :namespace # The namespace. Currently, you should set this to `default`. # # @return [Types::DeleteUserByPrincipalIdResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::DeleteUserByPrincipalIdResponse#request_id #request_id} => String # * {Types::DeleteUserByPrincipalIdResponse#status #status} => Integer # # @example Request syntax with placeholder values # # resp = client.delete_user_by_principal_id({ # principal_id: "String", # required # aws_account_id: "AwsAccountId", # required # namespace: "Namespace", # required # }) # # @example Response structure # # resp.request_id #=> String # resp.status #=> Integer # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DeleteUserByPrincipalId AWS API Documentation # # @overload delete_user_by_principal_id(params = {}) # @param [Hash] params ({}) def delete_user_by_principal_id(params = {}, options = {}) req = build_request(:delete_user_by_principal_id, params) req.send_request(options) end # Provides a summary for a dashboard. # # @option params [required, String] :aws_account_id # The ID of the AWS account that contains the dashboard that you're # describing. # # @option params [required, String] :dashboard_id # The ID for the dashboard. # # @option params [Integer] :version_number # The version number for the dashboard. If a version number isn't # passed, the latest published dashboard version is described. # # @option params [String] :alias_name # The alias name. # # @return [Types::DescribeDashboardResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::DescribeDashboardResponse#dashboard #dashboard} => Types::Dashboard # * {Types::DescribeDashboardResponse#status #status} => Integer # * {Types::DescribeDashboardResponse#request_id #request_id} => String # # @example Request syntax with placeholder values # # resp = client.describe_dashboard({ # aws_account_id: "AwsAccountId", # required # dashboard_id: "RestrictiveResourceId", # required # version_number: 1, # alias_name: "AliasName", # }) # # @example 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 "DATA_SET_NOT_FOUND", "INTERNAL_FAILURE", "PARAMETER_VALUE_INCOMPATIBLE", "PARAMETER_TYPE_INVALID", "PARAMETER_NOT_FOUND", "COLUMN_TYPE_MISMATCH", "COLUMN_GEOGRAPHIC_ROLE_MISMATCH", "COLUMN_REPLACEMENT_MISSING" # resp.dashboard.version.errors[0].message #=> String # resp.dashboard.version.version_number #=> Integer # resp.dashboard.version.status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED" # resp.dashboard.version.arn #=> String # resp.dashboard.version.source_entity_arn #=> String # resp.dashboard.version.description #=> String # resp.dashboard.created_time #=> Time # resp.dashboard.last_published_time #=> Time # resp.dashboard.last_updated_time #=> Time # resp.status #=> Integer # resp.request_id #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeDashboard AWS API Documentation # # @overload describe_dashboard(params = {}) # @param [Hash] params ({}) def describe_dashboard(params = {}, options = {}) req = build_request(:describe_dashboard, params) req.send_request(options) end # Describes read and write permissions for a dashboard. # # @option params [required, String] :aws_account_id # The ID of the AWS account that contains the dashboard that you're # describing permissions for. # # @option params [required, String] :dashboard_id # The ID for the dashboard, also added to the IAM policy. # # @return [Types::DescribeDashboardPermissionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::DescribeDashboardPermissionsResponse#dashboard_id #dashboard_id} => String # * {Types::DescribeDashboardPermissionsResponse#dashboard_arn #dashboard_arn} => String # * {Types::DescribeDashboardPermissionsResponse#permissions #permissions} => Array<Types::ResourcePermission> # * {Types::DescribeDashboardPermissionsResponse#status #status} => Integer # * {Types::DescribeDashboardPermissionsResponse#request_id #request_id} => String # # @example Request syntax with placeholder values # # resp = client.describe_dashboard_permissions({ # aws_account_id: "AwsAccountId", # required # dashboard_id: "RestrictiveResourceId", # required # }) # # @example 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 # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeDashboardPermissions AWS API Documentation # # @overload describe_dashboard_permissions(params = {}) # @param [Hash] params ({}) def describe_dashboard_permissions(params = {}, options = {}) req = build_request(:describe_dashboard_permissions, params) req.send_request(options) end # Describes a dataset. # # @option params [required, String] :aws_account_id # The AWS account ID. # # @option params [required, String] :data_set_id # The ID for the dataset that you want to create. This ID is unique per # AWS Region for each AWS account. # # @return [Types::DescribeDataSetResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::DescribeDataSetResponse#data_set #data_set} => Types::DataSet # * {Types::DescribeDataSetResponse#request_id #request_id} => String # * {Types::DescribeDataSetResponse#status #status} => Integer # # @example Request syntax with placeholder values # # resp = client.describe_data_set({ # aws_account_id: "AwsAccountId", # required # data_set_id: "ResourceId", # required # }) # # @example Response structure # # resp.data_set.arn #=> String # resp.data_set.data_set_id #=> String # resp.data_set.name #=> String # resp.data_set.created_time #=> Time # resp.data_set.last_updated_time #=> Time # resp.data_set.physical_table_map #=> Hash # resp.data_set.physical_table_map["PhysicalTableId"].relational_table.data_source_arn #=> String # resp.data_set.physical_table_map["PhysicalTableId"].relational_table.schema #=> String # resp.data_set.physical_table_map["PhysicalTableId"].relational_table.name #=> String # resp.data_set.physical_table_map["PhysicalTableId"].relational_table.input_columns #=> Array # resp.data_set.physical_table_map["PhysicalTableId"].relational_table.input_columns[0].name #=> String # resp.data_set.physical_table_map["PhysicalTableId"].relational_table.input_columns[0].type #=> String, one of "STRING", "INTEGER", "DECIMAL", "DATETIME", "BIT", "BOOLEAN", "JSON" # resp.data_set.physical_table_map["PhysicalTableId"].custom_sql.data_source_arn #=> String # resp.data_set.physical_table_map["PhysicalTableId"].custom_sql.name #=> String # resp.data_set.physical_table_map["PhysicalTableId"].custom_sql.sql_query #=> String # resp.data_set.physical_table_map["PhysicalTableId"].custom_sql.columns #=> Array # resp.data_set.physical_table_map["PhysicalTableId"].custom_sql.columns[0].name #=> String # resp.data_set.physical_table_map["PhysicalTableId"].custom_sql.columns[0].type #=> String, one of "STRING", "INTEGER", "DECIMAL", "DATETIME", "BIT", "BOOLEAN", "JSON" # resp.data_set.physical_table_map["PhysicalTableId"].s3_source.data_source_arn #=> String # resp.data_set.physical_table_map["PhysicalTableId"].s3_source.upload_settings.format #=> String, one of "CSV", "TSV", "CLF", "ELF", "XLSX", "JSON" # resp.data_set.physical_table_map["PhysicalTableId"].s3_source.upload_settings.start_from_row #=> Integer # resp.data_set.physical_table_map["PhysicalTableId"].s3_source.upload_settings.contains_header #=> Boolean # resp.data_set.physical_table_map["PhysicalTableId"].s3_source.upload_settings.text_qualifier #=> String, one of "DOUBLE_QUOTE", "SINGLE_QUOTE" # resp.data_set.physical_table_map["PhysicalTableId"].s3_source.upload_settings.delimiter #=> String # resp.data_set.physical_table_map["PhysicalTableId"].s3_source.input_columns #=> Array # resp.data_set.physical_table_map["PhysicalTableId"].s3_source.input_columns[0].name #=> String # resp.data_set.physical_table_map["PhysicalTableId"].s3_source.input_columns[0].type #=> String, one of "STRING", "INTEGER", "DECIMAL", "DATETIME", "BIT", "BOOLEAN", "JSON" # resp.data_set.logical_table_map #=> Hash # resp.data_set.logical_table_map["LogicalTableId"].alias #=> String # resp.data_set.logical_table_map["LogicalTableId"].data_transforms #=> Array # resp.data_set.logical_table_map["LogicalTableId"].data_transforms[0].project_operation.projected_columns #=> Array # resp.data_set.logical_table_map["LogicalTableId"].data_transforms[0].project_operation.projected_columns[0] #=> String # resp.data_set.logical_table_map["LogicalTableId"].data_transforms[0].filter_operation.condition_expression #=> String # resp.data_set.logical_table_map["LogicalTableId"].data_transforms[0].create_columns_operation.columns #=> Array # resp.data_set.logical_table_map["LogicalTableId"].data_transforms[0].create_columns_operation.columns[0].column_name #=> String # resp.data_set.logical_table_map["LogicalTableId"].data_transforms[0].create_columns_operation.columns[0].column_id #=> String # resp.data_set.logical_table_map["LogicalTableId"].data_transforms[0].create_columns_operation.columns[0].expression #=> String # resp.data_set.logical_table_map["LogicalTableId"].data_transforms[0].rename_column_operation.column_name #=> String # resp.data_set.logical_table_map["LogicalTableId"].data_transforms[0].rename_column_operation.new_column_name #=> String # resp.data_set.logical_table_map["LogicalTableId"].data_transforms[0].cast_column_type_operation.column_name #=> String # resp.data_set.logical_table_map["LogicalTableId"].data_transforms[0].cast_column_type_operation.new_column_type #=> String, one of "STRING", "INTEGER", "DECIMAL", "DATETIME" # resp.data_set.logical_table_map["LogicalTableId"].data_transforms[0].cast_column_type_operation.format #=> String # resp.data_set.logical_table_map["LogicalTableId"].data_transforms[0].tag_column_operation.column_name #=> String # resp.data_set.logical_table_map["LogicalTableId"].data_transforms[0].tag_column_operation.tags #=> Array # resp.data_set.logical_table_map["LogicalTableId"].data_transforms[0].tag_column_operation.tags[0].column_geographic_role #=> String, one of "COUNTRY", "STATE", "COUNTY", "CITY", "POSTCODE", "LONGITUDE", "LATITUDE" # resp.data_set.logical_table_map["LogicalTableId"].source.join_instruction.left_operand #=> String # resp.data_set.logical_table_map["LogicalTableId"].source.join_instruction.right_operand #=> String # resp.data_set.logical_table_map["LogicalTableId"].source.join_instruction.type #=> String, one of "INNER", "OUTER", "LEFT", "RIGHT" # resp.data_set.logical_table_map["LogicalTableId"].source.join_instruction.on_clause #=> String # resp.data_set.logical_table_map["LogicalTableId"].source.physical_table_id #=> String # resp.data_set.output_columns #=> Array # resp.data_set.output_columns[0].name #=> String # resp.data_set.output_columns[0].type #=> String, one of "STRING", "INTEGER", "DECIMAL", "DATETIME" # resp.data_set.import_mode #=> String, one of "SPICE", "DIRECT_QUERY" # resp.data_set.consumed_spice_capacity_in_bytes #=> Integer # resp.data_set.column_groups #=> Array # resp.data_set.column_groups[0].geo_spatial_column_group.name #=> String # resp.data_set.column_groups[0].geo_spatial_column_group.country_code #=> String, one of "US" # resp.data_set.column_groups[0].geo_spatial_column_group.columns #=> Array # resp.data_set.column_groups[0].geo_spatial_column_group.columns[0] #=> String # resp.data_set.row_level_permission_data_set.arn #=> String # resp.data_set.row_level_permission_data_set.permission_policy #=> String, one of "GRANT_ACCESS", "DENY_ACCESS" # resp.request_id #=> String # resp.status #=> Integer # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeDataSet AWS API Documentation # # @overload describe_data_set(params = {}) # @param [Hash] params ({}) def describe_data_set(params = {}, options = {}) req = build_request(:describe_data_set, params) req.send_request(options) end # Describes the permissions on a dataset. # # The permissions resource is # `arn:aws:quicksight:region:aws-account-id:dataset/data-set-id`. # # @option params [required, String] :aws_account_id # The AWS account ID. # # @option params [required, String] :data_set_id # The ID for the dataset that you want to create. This ID is unique per # AWS Region for each AWS account. # # @return [Types::DescribeDataSetPermissionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::DescribeDataSetPermissionsResponse#data_set_arn #data_set_arn} => String # * {Types::DescribeDataSetPermissionsResponse#data_set_id #data_set_id} => String # * {Types::DescribeDataSetPermissionsResponse#permissions #permissions} => Array<Types::ResourcePermission> # * {Types::DescribeDataSetPermissionsResponse#request_id #request_id} => String # * {Types::DescribeDataSetPermissionsResponse#status #status} => Integer # # @example Request syntax with placeholder values # # resp = client.describe_data_set_permissions({ # aws_account_id: "AwsAccountId", # required # data_set_id: "ResourceId", # required # }) # # @example 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 # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeDataSetPermissions AWS API Documentation # # @overload describe_data_set_permissions(params = {}) # @param [Hash] params ({}) def describe_data_set_permissions(params = {}, options = {}) req = build_request(:describe_data_set_permissions, params) req.send_request(options) end # Describes a data source. # # @option params [required, String] :aws_account_id # The AWS account ID. # # @option params [required, String] :data_source_id # The ID of the data source. This ID is unique per AWS Region for each # AWS account. # # @return [Types::DescribeDataSourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::DescribeDataSourceResponse#data_source #data_source} => Types::DataSource # * {Types::DescribeDataSourceResponse#request_id #request_id} => String # * {Types::DescribeDataSourceResponse#status #status} => Integer # # @example Request syntax with placeholder values # # resp = client.describe_data_source({ # aws_account_id: "AwsAccountId", # required # data_source_id: "ResourceId", # required # }) # # @example Response structure # # resp.data_source.arn #=> String # resp.data_source.data_source_id #=> String # resp.data_source.name #=> String # resp.data_source.type #=> String, one of "ADOBE_ANALYTICS", "AMAZON_ELASTICSEARCH", "ATHENA", "AURORA", "AURORA_POSTGRESQL", "AWS_IOT_ANALYTICS", "GITHUB", "JIRA", "MARIADB", "MYSQL", "POSTGRESQL", "PRESTO", "REDSHIFT", "S3", "SALESFORCE", "SERVICENOW", "SNOWFLAKE", "SPARK", "SQLSERVER", "TERADATA", "TWITTER" # resp.data_source.status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED" # resp.data_source.created_time #=> Time # resp.data_source.last_updated_time #=> Time # resp.data_source.data_source_parameters.amazon_elasticsearch_parameters.domain #=> String # resp.data_source.data_source_parameters.athena_parameters.work_group #=> String # resp.data_source.data_source_parameters.aurora_parameters.host #=> String # resp.data_source.data_source_parameters.aurora_parameters.port #=> Integer # resp.data_source.data_source_parameters.aurora_parameters.database #=> String # resp.data_source.data_source_parameters.aurora_postgre_sql_parameters.host #=> String # resp.data_source.data_source_parameters.aurora_postgre_sql_parameters.port #=> Integer # resp.data_source.data_source_parameters.aurora_postgre_sql_parameters.database #=> String # resp.data_source.data_source_parameters.aws_iot_analytics_parameters.data_set_name #=> String # resp.data_source.data_source_parameters.jira_parameters.site_base_url #=> String # resp.data_source.data_source_parameters.maria_db_parameters.host #=> String # resp.data_source.data_source_parameters.maria_db_parameters.port #=> Integer # resp.data_source.data_source_parameters.maria_db_parameters.database #=> String # resp.data_source.data_source_parameters.my_sql_parameters.host #=> String # resp.data_source.data_source_parameters.my_sql_parameters.port #=> Integer # resp.data_source.data_source_parameters.my_sql_parameters.database #=> String # resp.data_source.data_source_parameters.postgre_sql_parameters.host #=> String # resp.data_source.data_source_parameters.postgre_sql_parameters.port #=> Integer # resp.data_source.data_source_parameters.postgre_sql_parameters.database #=> String # resp.data_source.data_source_parameters.presto_parameters.host #=> String # resp.data_source.data_source_parameters.presto_parameters.port #=> Integer # resp.data_source.data_source_parameters.presto_parameters.catalog #=> String # resp.data_source.data_source_parameters.rds_parameters.instance_id #=> String # resp.data_source.data_source_parameters.rds_parameters.database #=> String # resp.data_source.data_source_parameters.redshift_parameters.host #=> String # resp.data_source.data_source_parameters.redshift_parameters.port #=> Integer # resp.data_source.data_source_parameters.redshift_parameters.database #=> String # resp.data_source.data_source_parameters.redshift_parameters.cluster_id #=> String # resp.data_source.data_source_parameters.s3_parameters.manifest_file_location.bucket #=> String # resp.data_source.data_source_parameters.s3_parameters.manifest_file_location.key #=> String # resp.data_source.data_source_parameters.service_now_parameters.site_base_url #=> String # resp.data_source.data_source_parameters.snowflake_parameters.host #=> String # resp.data_source.data_source_parameters.snowflake_parameters.database #=> String # resp.data_source.data_source_parameters.snowflake_parameters.warehouse #=> String # resp.data_source.data_source_parameters.spark_parameters.host #=> String # resp.data_source.data_source_parameters.spark_parameters.port #=> Integer # resp.data_source.data_source_parameters.sql_server_parameters.host #=> String # resp.data_source.data_source_parameters.sql_server_parameters.port #=> Integer # resp.data_source.data_source_parameters.sql_server_parameters.database #=> String # resp.data_source.data_source_parameters.teradata_parameters.host #=> String # resp.data_source.data_source_parameters.teradata_parameters.port #=> Integer # resp.data_source.data_source_parameters.teradata_parameters.database #=> String # resp.data_source.data_source_parameters.twitter_parameters.query #=> String # resp.data_source.data_source_parameters.twitter_parameters.max_rows #=> Integer # resp.data_source.vpc_connection_properties.vpc_connection_arn #=> String # resp.data_source.ssl_properties.disable_ssl #=> Boolean # resp.data_source.error_info.type #=> String, one of "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 # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeDataSource AWS API Documentation # # @overload describe_data_source(params = {}) # @param [Hash] params ({}) def describe_data_source(params = {}, options = {}) req = build_request(:describe_data_source, params) req.send_request(options) end # Describes the resource permissions for a data source. # # @option params [required, String] :aws_account_id # The AWS account ID. # # @option params [required, String] :data_source_id # The ID of the data source. This ID is unique per AWS Region for each # AWS account. # # @return [Types::DescribeDataSourcePermissionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::DescribeDataSourcePermissionsResponse#data_source_arn #data_source_arn} => String # * {Types::DescribeDataSourcePermissionsResponse#data_source_id #data_source_id} => String # * {Types::DescribeDataSourcePermissionsResponse#permissions #permissions} => Array<Types::ResourcePermission> # * {Types::DescribeDataSourcePermissionsResponse#request_id #request_id} => String # * {Types::DescribeDataSourcePermissionsResponse#status #status} => Integer # # @example Request syntax with placeholder values # # resp = client.describe_data_source_permissions({ # aws_account_id: "AwsAccountId", # required # data_source_id: "ResourceId", # required # }) # # @example 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 # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeDataSourcePermissions AWS API Documentation # # @overload describe_data_source_permissions(params = {}) # @param [Hash] params ({}) def describe_data_source_permissions(params = {}, options = {}) req = build_request(:describe_data_source_permissions, params) req.send_request(options) end # Returns an Amazon QuickSight group's description and Amazon Resource # Name (ARN). # # @option params [required, String] :group_name # The name of the group that you want to describe. # # @option params [required, String] :aws_account_id # The ID for the AWS account that the group is in. Currently, you use # the ID for the AWS account that contains your Amazon QuickSight # account. # # @option params [required, String] :namespace # The namespace. Currently, you should set this to `default`. # # @return [Types::DescribeGroupResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::DescribeGroupResponse#group #group} => Types::Group # * {Types::DescribeGroupResponse#request_id #request_id} => String # * {Types::DescribeGroupResponse#status #status} => Integer # # @example Request syntax with placeholder values # # resp = client.describe_group({ # group_name: "GroupName", # required # aws_account_id: "AwsAccountId", # required # namespace: "Namespace", # required # }) # # @example 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 # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeGroup AWS API Documentation # # @overload describe_group(params = {}) # @param [Hash] params ({}) def describe_group(params = {}, options = {}) req = build_request(:describe_group, params) req.send_request(options) end # Describes an existing IAM policy assignment, as specified by the # assignment name. # # @option params [required, String] :aws_account_id # The ID of the AWS account that contains the assignment that you want # to describe. # # @option params [required, String] :assignment_name # The name of the assignment. # # @option params [required, String] :namespace # The namespace that contains the assignment. # # @return [Types::DescribeIAMPolicyAssignmentResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::DescribeIAMPolicyAssignmentResponse#iam_policy_assignment #iam_policy_assignment} => Types::IAMPolicyAssignment # * {Types::DescribeIAMPolicyAssignmentResponse#request_id #request_id} => String # * {Types::DescribeIAMPolicyAssignmentResponse#status #status} => Integer # # @example Request syntax with placeholder values # # resp = client.describe_iam_policy_assignment({ # aws_account_id: "AwsAccountId", # required # assignment_name: "IAMPolicyAssignmentName", # required # namespace: "Namespace", # required # }) # # @example Response structure # # resp.iam_policy_assignment.aws_account_id #=> 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 # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeIAMPolicyAssignment AWS API Documentation # # @overload describe_iam_policy_assignment(params = {}) # @param [Hash] params ({}) def describe_iam_policy_assignment(params = {}, options = {}) req = build_request(:describe_iam_policy_assignment, params) req.send_request(options) end # Describes a SPICE ingestion. # # @option params [required, String] :aws_account_id # The AWS account ID. # # @option params [required, String] :data_set_id # The ID of the dataset used in the ingestion. # # @option params [required, String] :ingestion_id # An ID for the ingestion. # # @return [Types::DescribeIngestionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::DescribeIngestionResponse#ingestion #ingestion} => Types::Ingestion # * {Types::DescribeIngestionResponse#request_id #request_id} => String # * {Types::DescribeIngestionResponse#status #status} => Integer # # @example Request syntax with placeholder values # # resp = client.describe_ingestion({ # aws_account_id: "AwsAccountId", # required # data_set_id: "string", # required # ingestion_id: "IngestionId", # required # }) # # @example 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 # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeIngestion AWS API Documentation # # @overload describe_ingestion(params = {}) # @param [Hash] params ({}) def describe_ingestion(params = {}, options = {}) req = build_request(:describe_ingestion, params) req.send_request(options) end # Describes a template's metadata. # # @option params [required, String] :aws_account_id # The ID of the AWS account that contains the template that you're # describing. # # @option params [required, String] :template_id # The ID for the template. # # @option params [Integer] :version_number # (Optional) The number for the version to describe. If a # `VersionNumber` parameter value isn't provided, the latest version of # the template is described. # # @option params [String] :alias_name # 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. # # @return [Types::DescribeTemplateResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::DescribeTemplateResponse#template #template} => Types::Template # * {Types::DescribeTemplateResponse#status #status} => Integer # # @example Request syntax with placeholder values # # resp = client.describe_template({ # aws_account_id: "AwsAccountId", # required # template_id: "RestrictiveResourceId", # required # version_number: 1, # alias_name: "AliasName", # }) # # @example 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 "DATA_SET_NOT_FOUND", "INTERNAL_FAILURE" # resp.template.version.errors[0].message #=> String # resp.template.version.version_number #=> Integer # resp.template.version.status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED" # resp.template.version.data_set_configurations #=> Array # resp.template.version.data_set_configurations[0].placeholder #=> String # resp.template.version.data_set_configurations[0].data_set_schema.column_schema_list #=> Array # resp.template.version.data_set_configurations[0].data_set_schema.column_schema_list[0].name #=> String # resp.template.version.data_set_configurations[0].data_set_schema.column_schema_list[0].data_type #=> String # resp.template.version.data_set_configurations[0].data_set_schema.column_schema_list[0].geographic_role #=> String # resp.template.version.data_set_configurations[0].column_group_schema_list #=> Array # resp.template.version.data_set_configurations[0].column_group_schema_list[0].name #=> String # resp.template.version.data_set_configurations[0].column_group_schema_list[0].column_group_column_schema_list #=> Array # resp.template.version.data_set_configurations[0].column_group_schema_list[0].column_group_column_schema_list[0].name #=> String # resp.template.version.description #=> String # resp.template.version.source_entity_arn #=> String # resp.template.template_id #=> String # resp.template.last_updated_time #=> Time # resp.template.created_time #=> Time # resp.status #=> Integer # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeTemplate AWS API Documentation # # @overload describe_template(params = {}) # @param [Hash] params ({}) def describe_template(params = {}, options = {}) req = build_request(:describe_template, params) req.send_request(options) end # Describes the template alias for a template. # # @option params [required, String] :aws_account_id # The ID of the AWS account that contains the template alias that # you're describing. # # @option params [required, String] :template_id # The ID for the template. # # @option params [required, String] :alias_name # 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. # # @return [Types::DescribeTemplateAliasResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::DescribeTemplateAliasResponse#template_alias #template_alias} => Types::TemplateAlias # * {Types::DescribeTemplateAliasResponse#status #status} => Integer # * {Types::DescribeTemplateAliasResponse#request_id #request_id} => String # # @example Request syntax with placeholder values # # resp = client.describe_template_alias({ # aws_account_id: "AwsAccountId", # required # template_id: "RestrictiveResourceId", # required # alias_name: "AliasName", # required # }) # # @example 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 # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeTemplateAlias AWS API Documentation # # @overload describe_template_alias(params = {}) # @param [Hash] params ({}) def describe_template_alias(params = {}, options = {}) req = build_request(:describe_template_alias, params) req.send_request(options) end # Describes read and write permissions on a template. # # @option params [required, String] :aws_account_id # The ID of the AWS account that contains the template that you're # describing. # # @option params [required, String] :template_id # The ID for the template. # # @return [Types::DescribeTemplatePermissionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::DescribeTemplatePermissionsResponse#template_id #template_id} => String # * {Types::DescribeTemplatePermissionsResponse#template_arn #template_arn} => String # * {Types::DescribeTemplatePermissionsResponse#permissions #permissions} => Array<Types::ResourcePermission> # * {Types::DescribeTemplatePermissionsResponse#request_id #request_id} => String # * {Types::DescribeTemplatePermissionsResponse#status #status} => Integer # # @example Request syntax with placeholder values # # resp = client.describe_template_permissions({ # aws_account_id: "AwsAccountId", # required # template_id: "RestrictiveResourceId", # required # }) # # @example 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 # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeTemplatePermissions AWS API Documentation # # @overload describe_template_permissions(params = {}) # @param [Hash] params ({}) def describe_template_permissions(params = {}, options = {}) req = build_request(:describe_template_permissions, params) req.send_request(options) end # Returns information about a user, given the user name. # # @option params [required, String] :user_name # The name of the user that you want to describe. # # @option params [required, String] :aws_account_id # The ID for the AWS account that the user is in. Currently, you use the # ID for the AWS account that contains your Amazon QuickSight account. # # @option params [required, String] :namespace # The namespace. Currently, you should set this to `default`. # # @return [Types::DescribeUserResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::DescribeUserResponse#user #user} => Types::User # * {Types::DescribeUserResponse#request_id #request_id} => String # * {Types::DescribeUserResponse#status #status} => Integer # # @example Request syntax with placeholder values # # resp = client.describe_user({ # user_name: "UserName", # required # aws_account_id: "AwsAccountId", # required # namespace: "Namespace", # required # }) # # @example 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.request_id #=> String # resp.status #=> Integer # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeUser AWS API Documentation # # @overload describe_user(params = {}) # @param [Hash] params ({}) def describe_user(params = {}, options = {}) req = build_request(:describe_user, params) req.send_request(options) end # Generates a server-side embeddable URL and authorization code. For # this process to work properly, first configure the dashboards and user # permissions. For more information, see [Embedding Amazon QuickSight # Dashboards][1] in the *Amazon QuickSight User Guide* or [Embedding # Amazon QuickSight Dashboards][2] in the *Amazon QuickSight API # Reference*. # # Currently, you can use `GetDashboardEmbedURL` only from the server, # not from the user’s browser. # # # # [1]: https://docs.aws.amazon.com/quicksight/latest/user/embedding-dashboards.html # [2]: https://docs.aws.amazon.com/quicksight/latest/APIReference/qs-dev-embedded-dashboards.html # # @option params [required, String] :aws_account_id # The ID for the AWS account that contains the dashboard that you're # embedding. # # @option params [required, String] :dashboard_id # The ID for the dashboard, also added to the IAM policy. # # @option params [required, String] :identity_type # The authentication method that the user uses to sign in. # # @option params [Integer] :session_lifetime_in_minutes # How many minutes the session is valid. The session lifetime must be # 15-600 minutes. # # @option params [Boolean] :undo_redo_disabled # Remove the undo/redo button on the embedded dashboard. The default is # FALSE, which enables the undo/redo button. # # @option params [Boolean] :reset_disabled # Remove the reset button on the embedded dashboard. The default is # FALSE, which enables the reset button. # # @option params [String] :user_arn # The Amazon QuickSight user's Amazon Resource Name (ARN), for use with # `QUICKSIGHT` identity type. You can use this for any Amazon QuickSight # users in your account (readers, authors, or admins) authenticated as # one of the following: # # * Active Directory (AD) users or group members # # * Invited nonfederated users # # * IAM users and IAM role-based sessions authenticated through # Federated Single Sign-On using SAML, OpenID Connect, or IAM # federation. # # @return [Types::GetDashboardEmbedUrlResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::GetDashboardEmbedUrlResponse#embed_url #embed_url} => String # * {Types::GetDashboardEmbedUrlResponse#status #status} => Integer # * {Types::GetDashboardEmbedUrlResponse#request_id #request_id} => String # # @example Request syntax with placeholder values # # resp = client.get_dashboard_embed_url({ # aws_account_id: "AwsAccountId", # required # dashboard_id: "RestrictiveResourceId", # required # identity_type: "IAM", # required, accepts IAM, QUICKSIGHT # session_lifetime_in_minutes: 1, # undo_redo_disabled: false, # reset_disabled: false, # user_arn: "Arn", # }) # # @example Response structure # # resp.embed_url #=> String # resp.status #=> Integer # resp.request_id #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/GetDashboardEmbedUrl AWS API Documentation # # @overload get_dashboard_embed_url(params = {}) # @param [Hash] params ({}) def get_dashboard_embed_url(params = {}, options = {}) req = build_request(:get_dashboard_embed_url, params) req.send_request(options) end # Lists all the versions of the dashboards in the QuickSight # subscription. # # @option params [required, String] :aws_account_id # The ID of the AWS account that contains the dashboard that you're # listing versions for. # # @option params [required, String] :dashboard_id # The ID for the dashboard. # # @option params [String] :next_token # The token for the next set of results, or null if there are no more # results. # # @option params [Integer] :max_results # The maximum number of results to be returned per request. # # @return [Types::ListDashboardVersionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::ListDashboardVersionsResponse#dashboard_version_summary_list #dashboard_version_summary_list} => Array<Types::DashboardVersionSummary> # * {Types::ListDashboardVersionsResponse#next_token #next_token} => String # * {Types::ListDashboardVersionsResponse#status #status} => Integer # * {Types::ListDashboardVersionsResponse#request_id #request_id} => String # # @example 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, # }) # # @example Response structure # # resp.dashboard_version_summary_list #=> Array # resp.dashboard_version_summary_list[0].arn #=> String # resp.dashboard_version_summary_list[0].created_time #=> Time # resp.dashboard_version_summary_list[0].version_number #=> Integer # resp.dashboard_version_summary_list[0].status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED" # resp.dashboard_version_summary_list[0].source_entity_arn #=> String # resp.dashboard_version_summary_list[0].description #=> String # resp.next_token #=> String # resp.status #=> Integer # resp.request_id #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListDashboardVersions AWS API Documentation # # @overload list_dashboard_versions(params = {}) # @param [Hash] params ({}) def list_dashboard_versions(params = {}, options = {}) req = build_request(:list_dashboard_versions, params) req.send_request(options) end # Lists dashboards in an AWS account. # # @option params [required, String] :aws_account_id # The ID of the AWS account that contains the dashboards that you're # listing. # # @option params [String] :next_token # The token for the next set of results, or null if there are no more # results. # # @option params [Integer] :max_results # The maximum number of results to be returned per request. # # @return [Types::ListDashboardsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::ListDashboardsResponse#dashboard_summary_list #dashboard_summary_list} => Array<Types::DashboardSummary> # * {Types::ListDashboardsResponse#next_token #next_token} => String # * {Types::ListDashboardsResponse#status #status} => Integer # * {Types::ListDashboardsResponse#request_id #request_id} => String # # @example Request syntax with placeholder values # # resp = client.list_dashboards({ # aws_account_id: "AwsAccountId", # required # next_token: "String", # max_results: 1, # }) # # @example 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 # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListDashboards AWS API Documentation # # @overload list_dashboards(params = {}) # @param [Hash] params ({}) def list_dashboards(params = {}, options = {}) req = build_request(:list_dashboards, params) req.send_request(options) end # Lists all of the datasets belonging to the current AWS account in an # AWS Region. # # The permissions resource is # `arn:aws:quicksight:region:aws-account-id:dataset/*`. # # @option params [required, String] :aws_account_id # The AWS account ID. # # @option params [String] :next_token # The token for the next set of results, or null if there are no more # results. # # @option params [Integer] :max_results # The maximum number of results to be returned per request. # # @return [Types::ListDataSetsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::ListDataSetsResponse#data_set_summaries #data_set_summaries} => Array<Types::DataSetSummary> # * {Types::ListDataSetsResponse#next_token #next_token} => String # * {Types::ListDataSetsResponse#request_id #request_id} => String # * {Types::ListDataSetsResponse#status #status} => Integer # # @example Request syntax with placeholder values # # resp = client.list_data_sets({ # aws_account_id: "AwsAccountId", # required # next_token: "String", # max_results: 1, # }) # # @example 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.arn #=> String # resp.data_set_summaries[0].row_level_permission_data_set.permission_policy #=> String, one of "GRANT_ACCESS", "DENY_ACCESS" # resp.next_token #=> String # resp.request_id #=> String # resp.status #=> Integer # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListDataSets AWS API Documentation # # @overload list_data_sets(params = {}) # @param [Hash] params ({}) def list_data_sets(params = {}, options = {}) req = build_request(:list_data_sets, params) req.send_request(options) end # Lists data sources in current AWS Region that belong to this AWS # account. # # @option params [required, String] :aws_account_id # The AWS account ID. # # @option params [String] :next_token # The token for the next set of results, or null if there are no more # results. # # @option params [Integer] :max_results # The maximum number of results to be returned per request. # # @return [Types::ListDataSourcesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::ListDataSourcesResponse#data_sources #data_sources} => Array<Types::DataSource> # * {Types::ListDataSourcesResponse#next_token #next_token} => String # * {Types::ListDataSourcesResponse#request_id #request_id} => String # * {Types::ListDataSourcesResponse#status #status} => Integer # # @example Request syntax with placeholder values # # resp = client.list_data_sources({ # aws_account_id: "AwsAccountId", # required # next_token: "String", # max_results: 1, # }) # # @example Response structure # # resp.data_sources #=> Array # resp.data_sources[0].arn #=> String # resp.data_sources[0].data_source_id #=> String # resp.data_sources[0].name #=> String # resp.data_sources[0].type #=> String, one of "ADOBE_ANALYTICS", "AMAZON_ELASTICSEARCH", "ATHENA", "AURORA", "AURORA_POSTGRESQL", "AWS_IOT_ANALYTICS", "GITHUB", "JIRA", "MARIADB", "MYSQL", "POSTGRESQL", "PRESTO", "REDSHIFT", "S3", "SALESFORCE", "SERVICENOW", "SNOWFLAKE", "SPARK", "SQLSERVER", "TERADATA", "TWITTER" # resp.data_sources[0].status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED" # resp.data_sources[0].created_time #=> Time # resp.data_sources[0].last_updated_time #=> Time # resp.data_sources[0].data_source_parameters.amazon_elasticsearch_parameters.domain #=> String # resp.data_sources[0].data_source_parameters.athena_parameters.work_group #=> String # resp.data_sources[0].data_source_parameters.aurora_parameters.host #=> String # resp.data_sources[0].data_source_parameters.aurora_parameters.port #=> Integer # resp.data_sources[0].data_source_parameters.aurora_parameters.database #=> String # resp.data_sources[0].data_source_parameters.aurora_postgre_sql_parameters.host #=> String # resp.data_sources[0].data_source_parameters.aurora_postgre_sql_parameters.port #=> Integer # resp.data_sources[0].data_source_parameters.aurora_postgre_sql_parameters.database #=> String # resp.data_sources[0].data_source_parameters.aws_iot_analytics_parameters.data_set_name #=> String # resp.data_sources[0].data_source_parameters.jira_parameters.site_base_url #=> String # resp.data_sources[0].data_source_parameters.maria_db_parameters.host #=> String # resp.data_sources[0].data_source_parameters.maria_db_parameters.port #=> Integer # resp.data_sources[0].data_source_parameters.maria_db_parameters.database #=> String # resp.data_sources[0].data_source_parameters.my_sql_parameters.host #=> String # resp.data_sources[0].data_source_parameters.my_sql_parameters.port #=> Integer # resp.data_sources[0].data_source_parameters.my_sql_parameters.database #=> String # resp.data_sources[0].data_source_parameters.postgre_sql_parameters.host #=> String # resp.data_sources[0].data_source_parameters.postgre_sql_parameters.port #=> Integer # resp.data_sources[0].data_source_parameters.postgre_sql_parameters.database #=> String # resp.data_sources[0].data_source_parameters.presto_parameters.host #=> String # resp.data_sources[0].data_source_parameters.presto_parameters.port #=> Integer # resp.data_sources[0].data_source_parameters.presto_parameters.catalog #=> String # resp.data_sources[0].data_source_parameters.rds_parameters.instance_id #=> String # resp.data_sources[0].data_source_parameters.rds_parameters.database #=> String # resp.data_sources[0].data_source_parameters.redshift_parameters.host #=> String # resp.data_sources[0].data_source_parameters.redshift_parameters.port #=> Integer # resp.data_sources[0].data_source_parameters.redshift_parameters.database #=> String # resp.data_sources[0].data_source_parameters.redshift_parameters.cluster_id #=> String # resp.data_sources[0].data_source_parameters.s3_parameters.manifest_file_location.bucket #=> String # resp.data_sources[0].data_source_parameters.s3_parameters.manifest_file_location.key #=> String # resp.data_sources[0].data_source_parameters.service_now_parameters.site_base_url #=> String # resp.data_sources[0].data_source_parameters.snowflake_parameters.host #=> String # resp.data_sources[0].data_source_parameters.snowflake_parameters.database #=> String # resp.data_sources[0].data_source_parameters.snowflake_parameters.warehouse #=> String # resp.data_sources[0].data_source_parameters.spark_parameters.host #=> String # resp.data_sources[0].data_source_parameters.spark_parameters.port #=> Integer # resp.data_sources[0].data_source_parameters.sql_server_parameters.host #=> String # resp.data_sources[0].data_source_parameters.sql_server_parameters.port #=> Integer # resp.data_sources[0].data_source_parameters.sql_server_parameters.database #=> String # resp.data_sources[0].data_source_parameters.teradata_parameters.host #=> String # resp.data_sources[0].data_source_parameters.teradata_parameters.port #=> Integer # resp.data_sources[0].data_source_parameters.teradata_parameters.database #=> String # resp.data_sources[0].data_source_parameters.twitter_parameters.query #=> String # resp.data_sources[0].data_source_parameters.twitter_parameters.max_rows #=> Integer # resp.data_sources[0].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 "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 # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListDataSources AWS API Documentation # # @overload list_data_sources(params = {}) # @param [Hash] params ({}) def list_data_sources(params = {}, options = {}) req = build_request(:list_data_sources, params) req.send_request(options) end # Lists member users in a group. # # @option params [required, String] :group_name # The name of the group that you want to see a membership list of. # # @option params [String] :next_token # A pagination token that can be used in a subsequent request. # # @option params [Integer] :max_results # The maximum number of results to return from this request. # # @option params [required, String] :aws_account_id # The ID for the AWS account that the group is in. Currently, you use # the ID for the AWS account that contains your Amazon QuickSight # account. # # @option params [required, String] :namespace # The namespace. Currently, you should set this to `default`. # # @return [Types::ListGroupMembershipsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::ListGroupMembershipsResponse#group_member_list #group_member_list} => Array<Types::GroupMember> # * {Types::ListGroupMembershipsResponse#next_token #next_token} => String # * {Types::ListGroupMembershipsResponse#request_id #request_id} => String # * {Types::ListGroupMembershipsResponse#status #status} => Integer # # @example 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 # }) # # @example 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 # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListGroupMemberships AWS API Documentation # # @overload list_group_memberships(params = {}) # @param [Hash] params ({}) def list_group_memberships(params = {}, options = {}) req = build_request(:list_group_memberships, params) req.send_request(options) end # Lists all user groups in Amazon QuickSight. # # @option params [required, String] :aws_account_id # The ID for the AWS account that the group is in. Currently, you use # the ID for the AWS account that contains your Amazon QuickSight # account. # # @option params [String] :next_token # A pagination token that can be used in a subsequent request. # # @option params [Integer] :max_results # The maximum number of results to return. # # @option params [required, String] :namespace # The namespace. Currently, you should set this to `default`. # # @return [Types::ListGroupsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::ListGroupsResponse#group_list #group_list} => Array<Types::Group> # * {Types::ListGroupsResponse#next_token #next_token} => String # * {Types::ListGroupsResponse#request_id #request_id} => String # * {Types::ListGroupsResponse#status #status} => Integer # # @example Request syntax with placeholder values # # resp = client.list_groups({ # aws_account_id: "AwsAccountId", # required # next_token: "String", # max_results: 1, # namespace: "Namespace", # required # }) # # @example Response structure # # resp.group_list #=> Array # resp.group_list[0].arn #=> String # resp.group_list[0].group_name #=> String # resp.group_list[0].description #=> String # resp.group_list[0].principal_id #=> String # resp.next_token #=> String # resp.request_id #=> String # resp.status #=> Integer # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListGroups AWS API Documentation # # @overload list_groups(params = {}) # @param [Hash] params ({}) def list_groups(params = {}, options = {}) req = build_request(:list_groups, params) req.send_request(options) end # Lists IAM policy assignments in the current Amazon QuickSight account. # # @option params [required, String] :aws_account_id # The ID of the AWS account that contains these IAM policy assignments. # # @option params [String] :assignment_status # The status of the assignments. # # @option params [required, String] :namespace # The namespace for the assignments. # # @option params [String] :next_token # The token for the next set of results, or null if there are no more # results. # # @option params [Integer] :max_results # The maximum number of results to be returned per request. # # @return [Types::ListIAMPolicyAssignmentsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::ListIAMPolicyAssignmentsResponse#iam_policy_assignments #iam_policy_assignments} => Array<Types::IAMPolicyAssignmentSummary> # * {Types::ListIAMPolicyAssignmentsResponse#next_token #next_token} => String # * {Types::ListIAMPolicyAssignmentsResponse#request_id #request_id} => String # * {Types::ListIAMPolicyAssignmentsResponse#status #status} => Integer # # @example Request syntax with placeholder values # # resp = client.list_iam_policy_assignments({ # aws_account_id: "AwsAccountId", # required # assignment_status: "ENABLED", # accepts ENABLED, DRAFT, DISABLED # namespace: "Namespace", # required # next_token: "String", # max_results: 1, # }) # # @example Response structure # # resp.iam_policy_assignments #=> Array # resp.iam_policy_assignments[0].assignment_name #=> String # resp.iam_policy_assignments[0].assignment_status #=> String, one of "ENABLED", "DRAFT", "DISABLED" # resp.next_token #=> String # resp.request_id #=> String # resp.status #=> Integer # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListIAMPolicyAssignments AWS API Documentation # # @overload list_iam_policy_assignments(params = {}) # @param [Hash] params ({}) def list_iam_policy_assignments(params = {}, options = {}) req = build_request(:list_iam_policy_assignments, params) req.send_request(options) end # Lists all the IAM policy assignments, including the Amazon Resource # Names (ARNs) for the IAM policies assigned to the specified user and # group or groups that the user belongs to. # # @option params [required, String] :aws_account_id # The ID of the AWS account that contains the assignments. # # @option params [required, String] :user_name # The name of the user. # # @option params [String] :next_token # The token for the next set of results, or null if there are no more # results. # # @option params [Integer] :max_results # The maximum number of results to be returned per request. # # @option params [required, String] :namespace # The namespace of the assignment. # # @return [Types::ListIAMPolicyAssignmentsForUserResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::ListIAMPolicyAssignmentsForUserResponse#active_assignments #active_assignments} => Array<Types::ActiveIAMPolicyAssignment> # * {Types::ListIAMPolicyAssignmentsForUserResponse#request_id #request_id} => String # * {Types::ListIAMPolicyAssignmentsForUserResponse#next_token #next_token} => String # * {Types::ListIAMPolicyAssignmentsForUserResponse#status #status} => Integer # # @example Request syntax with placeholder values # # resp = client.list_iam_policy_assignments_for_user({ # aws_account_id: "AwsAccountId", # required # user_name: "UserName", # required # next_token: "String", # max_results: 1, # namespace: "Namespace", # required # }) # # @example Response structure # # resp.active_assignments #=> Array # resp.active_assignments[0].assignment_name #=> String # resp.active_assignments[0].policy_arn #=> String # resp.request_id #=> String # resp.next_token #=> String # resp.status #=> Integer # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListIAMPolicyAssignmentsForUser AWS API Documentation # # @overload list_iam_policy_assignments_for_user(params = {}) # @param [Hash] params ({}) def list_iam_policy_assignments_for_user(params = {}, options = {}) req = build_request(:list_iam_policy_assignments_for_user, params) req.send_request(options) end # Lists the history of SPICE ingestions for a dataset. # # @option params [required, String] :data_set_id # The ID of the dataset used in the ingestion. # # @option params [String] :next_token # The token for the next set of results, or null if there are no more # results. # # @option params [required, String] :aws_account_id # The AWS account ID. # # @option params [Integer] :max_results # The maximum number of results to be returned per request. # # @return [Types::ListIngestionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::ListIngestionsResponse#ingestions #ingestions} => Array<Types::Ingestion> # * {Types::ListIngestionsResponse#next_token #next_token} => String # * {Types::ListIngestionsResponse#request_id #request_id} => String # * {Types::ListIngestionsResponse#status #status} => Integer # # @example Request syntax with placeholder values # # resp = client.list_ingestions({ # data_set_id: "string", # required # next_token: "string", # aws_account_id: "AwsAccountId", # required # max_results: 1, # }) # # @example Response structure # # resp.ingestions #=> Array # resp.ingestions[0].arn #=> String # resp.ingestions[0].ingestion_id #=> String # resp.ingestions[0].ingestion_status #=> String, one of "INITIALIZED", "QUEUED", "RUNNING", "FAILED", "COMPLETED", "CANCELLED" # resp.ingestions[0].error_info.type #=> String, one of "FAILURE_TO_ASSUME_ROLE", "INGESTION_SUPERSEDED", "INGESTION_CANCELED", "DATA_SET_DELETED", "DATA_SET_NOT_SPICE", "S3_UPLOADED_FILE_DELETED", "S3_MANIFEST_ERROR", "DATA_TOLERANCE_EXCEPTION", "SPICE_TABLE_NOT_FOUND", "DATA_SET_SIZE_LIMIT_EXCEEDED", "ROW_SIZE_LIMIT_EXCEEDED", "ACCOUNT_CAPACITY_LIMIT_EXCEEDED", "CUSTOMER_ERROR", "DATA_SOURCE_NOT_FOUND", "IAM_ROLE_NOT_AVAILABLE", "CONNECTION_FAILURE", "SQL_TABLE_NOT_FOUND", "PERMISSION_DENIED", "SSL_CERTIFICATE_VALIDATION_FAILURE", "OAUTH_TOKEN_FAILURE", "SOURCE_API_LIMIT_EXCEEDED_FAILURE", "PASSWORD_AUTHENTICATION_FAILURE", "SQL_SCHEMA_MISMATCH_ERROR", "INVALID_DATE_FORMAT", "INVALID_DATAPREP_SYNTAX", "SOURCE_RESOURCE_LIMIT_EXCEEDED", "SQL_INVALID_PARAMETER_VALUE", "QUERY_TIMEOUT", "SQL_NUMERIC_OVERFLOW", "UNRESOLVABLE_HOST", "UNROUTABLE_HOST", "SQL_EXCEPTION", "S3_FILE_INACCESSIBLE", "IOT_FILE_NOT_FOUND", "IOT_DATA_SET_FILE_EMPTY", "INVALID_DATA_SOURCE_CONFIG", "DATA_SOURCE_AUTH_FAILED", "DATA_SOURCE_CONNECTION_FAILED", "FAILURE_TO_PROCESS_JSON_FILE", "INTERNAL_SERVICE_ERROR" # resp.ingestions[0].error_info.message #=> String # resp.ingestions[0].row_info.rows_ingested #=> Integer # resp.ingestions[0].row_info.rows_dropped #=> Integer # resp.ingestions[0].queue_info.waiting_on_ingestion #=> String # resp.ingestions[0].queue_info.queued_ingestion #=> String # resp.ingestions[0].created_time #=> Time # resp.ingestions[0].ingestion_time_in_seconds #=> Integer # resp.ingestions[0].ingestion_size_in_bytes #=> Integer # resp.ingestions[0].request_source #=> String, one of "MANUAL", "SCHEDULED" # resp.ingestions[0].request_type #=> String, one of "INITIAL_INGESTION", "EDIT", "INCREMENTAL_REFRESH", "FULL_REFRESH" # resp.next_token #=> String # resp.request_id #=> String # resp.status #=> Integer # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListIngestions AWS API Documentation # # @overload list_ingestions(params = {}) # @param [Hash] params ({}) def list_ingestions(params = {}, options = {}) req = build_request(:list_ingestions, params) req.send_request(options) end # Lists the tags assigned to a resource. # # @option params [required, String] :resource_arn # The Amazon Resource Name (ARN) of the resource that you want a list of # tags for. # # @return [Types::ListTagsForResourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::ListTagsForResourceResponse#tags #tags} => Array<Types::Tag> # * {Types::ListTagsForResourceResponse#request_id #request_id} => String # * {Types::ListTagsForResourceResponse#status #status} => Integer # # @example Request syntax with placeholder values # # resp = client.list_tags_for_resource({ # resource_arn: "Arn", # required # }) # # @example Response structure # # resp.tags #=> Array # resp.tags[0].key #=> String # resp.tags[0].value #=> String # resp.request_id #=> String # resp.status #=> Integer # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListTagsForResource AWS API Documentation # # @overload list_tags_for_resource(params = {}) # @param [Hash] params ({}) def list_tags_for_resource(params = {}, options = {}) req = build_request(:list_tags_for_resource, params) req.send_request(options) end # Lists all the aliases of a template. # # @option params [required, String] :aws_account_id # The ID of the AWS account that contains the template aliases that # you're listing. # # @option params [required, String] :template_id # The ID for the template. # # @option params [String] :next_token # The token for the next set of results, or null if there are no more # results. # # @option params [Integer] :max_results # The maximum number of results to be returned per request. # # @return [Types::ListTemplateAliasesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::ListTemplateAliasesResponse#template_alias_list #template_alias_list} => Array<Types::TemplateAlias> # * {Types::ListTemplateAliasesResponse#status #status} => Integer # * {Types::ListTemplateAliasesResponse#request_id #request_id} => String # * {Types::ListTemplateAliasesResponse#next_token #next_token} => String # # @example Request syntax with placeholder values # # resp = client.list_template_aliases({ # aws_account_id: "AwsAccountId", # required # template_id: "RestrictiveResourceId", # required # next_token: "String", # max_results: 1, # }) # # @example Response structure # # resp.template_alias_list #=> Array # resp.template_alias_list[0].alias_name #=> String # resp.template_alias_list[0].arn #=> String # resp.template_alias_list[0].template_version_number #=> Integer # resp.status #=> Integer # resp.request_id #=> String # resp.next_token #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListTemplateAliases AWS API Documentation # # @overload list_template_aliases(params = {}) # @param [Hash] params ({}) def list_template_aliases(params = {}, options = {}) req = build_request(:list_template_aliases, params) req.send_request(options) end # Lists all the versions of the templates in the current Amazon # QuickSight account. # # @option params [required, String] :aws_account_id # The ID of the AWS account that contains the templates that you're # listing. # # @option params [required, String] :template_id # The ID for the template. # # @option params [String] :next_token # The token for the next set of results, or null if there are no more # results. # # @option params [Integer] :max_results # The maximum number of results to be returned per request. # # @return [Types::ListTemplateVersionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::ListTemplateVersionsResponse#template_version_summary_list #template_version_summary_list} => Array<Types::TemplateVersionSummary> # * {Types::ListTemplateVersionsResponse#next_token #next_token} => String # * {Types::ListTemplateVersionsResponse#status #status} => Integer # * {Types::ListTemplateVersionsResponse#request_id #request_id} => String # # @example Request syntax with placeholder values # # resp = client.list_template_versions({ # aws_account_id: "AwsAccountId", # required # template_id: "RestrictiveResourceId", # required # next_token: "String", # max_results: 1, # }) # # @example Response structure # # resp.template_version_summary_list #=> Array # resp.template_version_summary_list[0].arn #=> String # resp.template_version_summary_list[0].version_number #=> Integer # resp.template_version_summary_list[0].created_time #=> Time # resp.template_version_summary_list[0].status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED" # resp.template_version_summary_list[0].description #=> String # resp.next_token #=> String # resp.status #=> Integer # resp.request_id #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListTemplateVersions AWS API Documentation # # @overload list_template_versions(params = {}) # @param [Hash] params ({}) def list_template_versions(params = {}, options = {}) req = build_request(:list_template_versions, params) req.send_request(options) end # Lists all the templates in the current Amazon QuickSight account. # # @option params [required, String] :aws_account_id # The ID of the AWS account that contains the templates that you're # listing. # # @option params [String] :next_token # The token for the next set of results, or null if there are no more # results. # # @option params [Integer] :max_results # The maximum number of results to be returned per request. # # @return [Types::ListTemplatesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::ListTemplatesResponse#template_summary_list #template_summary_list} => Array<Types::TemplateSummary> # * {Types::ListTemplatesResponse#next_token #next_token} => String # * {Types::ListTemplatesResponse#status #status} => Integer # * {Types::ListTemplatesResponse#request_id #request_id} => String # # @example Request syntax with placeholder values # # resp = client.list_templates({ # aws_account_id: "AwsAccountId", # required # next_token: "String", # max_results: 1, # }) # # @example Response structure # # resp.template_summary_list #=> Array # resp.template_summary_list[0].arn #=> String # resp.template_summary_list[0].template_id #=> String # resp.template_summary_list[0].name #=> String # resp.template_summary_list[0].latest_version_number #=> Integer # resp.template_summary_list[0].created_time #=> Time # resp.template_summary_list[0].last_updated_time #=> Time # resp.next_token #=> String # resp.status #=> Integer # resp.request_id #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListTemplates AWS API Documentation # # @overload list_templates(params = {}) # @param [Hash] params ({}) def list_templates(params = {}, options = {}) req = build_request(:list_templates, params) req.send_request(options) end # Lists the Amazon QuickSight groups that an Amazon QuickSight user is a # member of. # # @option params [required, String] :user_name # The Amazon QuickSight user name that you want to list group # memberships for. # # @option params [required, String] :aws_account_id # The AWS account ID that the user is in. Currently, you use the ID for # the AWS account that contains your Amazon QuickSight account. # # @option params [required, String] :namespace # The namespace. Currently, you should set this to `default`. # # @option params [String] :next_token # A pagination token that can be used in a subsequent request. # # @option params [Integer] :max_results # The maximum number of results to return from this request. # # @return [Types::ListUserGroupsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::ListUserGroupsResponse#group_list #group_list} => Array<Types::Group> # * {Types::ListUserGroupsResponse#next_token #next_token} => String # * {Types::ListUserGroupsResponse#request_id #request_id} => String # * {Types::ListUserGroupsResponse#status #status} => Integer # # @example Request syntax with placeholder values # # resp = client.list_user_groups({ # user_name: "UserName", # required # aws_account_id: "AwsAccountId", # required # namespace: "Namespace", # required # next_token: "String", # max_results: 1, # }) # # @example Response structure # # resp.group_list #=> Array # resp.group_list[0].arn #=> String # resp.group_list[0].group_name #=> String # resp.group_list[0].description #=> String # resp.group_list[0].principal_id #=> String # resp.next_token #=> String # resp.request_id #=> String # resp.status #=> Integer # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListUserGroups AWS API Documentation # # @overload list_user_groups(params = {}) # @param [Hash] params ({}) def list_user_groups(params = {}, options = {}) req = build_request(:list_user_groups, params) req.send_request(options) end # Returns a list of all of the Amazon QuickSight users belonging to this # account. # # @option params [required, String] :aws_account_id # The ID for the AWS account that the user is in. Currently, you use the # ID for the AWS account that contains your Amazon QuickSight account. # # @option params [String] :next_token # A pagination token that can be used in a subsequent request. # # @option params [Integer] :max_results # The maximum number of results to return from this request. # # @option params [required, String] :namespace # The namespace. Currently, you should set this to `default`. # # @return [Types::ListUsersResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::ListUsersResponse#user_list #user_list} => Array<Types::User> # * {Types::ListUsersResponse#next_token #next_token} => String # * {Types::ListUsersResponse#request_id #request_id} => String # * {Types::ListUsersResponse#status #status} => Integer # # @example Request syntax with placeholder values # # resp = client.list_users({ # aws_account_id: "AwsAccountId", # required # next_token: "String", # max_results: 1, # namespace: "Namespace", # required # }) # # @example Response structure # # resp.user_list #=> Array # resp.user_list[0].arn #=> String # resp.user_list[0].user_name #=> String # resp.user_list[0].email #=> String # resp.user_list[0].role #=> String, one of "ADMIN", "AUTHOR", "READER", "RESTRICTED_AUTHOR", "RESTRICTED_READER" # resp.user_list[0].identity_type #=> String, one of "IAM", "QUICKSIGHT" # resp.user_list[0].active #=> Boolean # resp.user_list[0].principal_id #=> String # resp.next_token #=> String # resp.request_id #=> String # resp.status #=> Integer # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListUsers AWS API Documentation # # @overload list_users(params = {}) # @param [Hash] params ({}) def list_users(params = {}, options = {}) req = build_request(:list_users, params) req.send_request(options) end # Creates an Amazon QuickSight user, whose identity is associated with # the AWS Identity and Access Management (IAM) identity or role # specified in the request. # # @option params [required, String] :identity_type # Amazon QuickSight supports several ways of managing the identity of # users. This parameter accepts two values: # # * `IAM`\: A user whose identity maps to an existing IAM user or role. # # * `QUICKSIGHT`\: A user whose identity is owned and managed internally # by Amazon QuickSight. # # @option params [required, String] :email # The email address of the user that you want to register. # # @option params [required, String] :user_role # The Amazon QuickSight role for the user. The user role can be one of # the following: # # * `READER`\: A user who has read-only access to dashboards. # # * `AUTHOR`\: A user who can create data sources, datasets, analyses, # and dashboards. # # * `ADMIN`\: A user who is an author, who can also manage Amazon # QuickSight settings. # # * `RESTRICTED_READER`\: This role isn't currently available for use. # # * `RESTRICTED_AUTHOR`\: This role isn't currently available for use. # # @option params [String] :iam_arn # The ARN of the IAM user or role that you are registering with Amazon # QuickSight. # # @option params [String] :session_name # You need to use this parameter only when you register one or more # users using an assumed IAM role. You don't need to provide the # session name for other scenarios, for example when you are registering # an IAM user or an Amazon QuickSight user. You can register multiple # users using the same IAM role if each user has a different session # name. For more information on assuming IAM roles, see [ `assume-role` # ][1] in the *AWS CLI Reference.* # # # # [1]: https://docs.aws.example.com/cli/latest/reference/sts/assume-role.html # # @option params [required, String] :aws_account_id # The ID for the AWS account that the user is in. Currently, you use the # ID for the AWS account that contains your Amazon QuickSight account. # # @option params [required, String] :namespace # The namespace. Currently, you should set this to `default`. # # @option params [String] :user_name # The Amazon QuickSight user name that you want to create for the user # you are registering. # # @return [Types::RegisterUserResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::RegisterUserResponse#user #user} => Types::User # * {Types::RegisterUserResponse#user_invitation_url #user_invitation_url} => String # * {Types::RegisterUserResponse#request_id #request_id} => String # * {Types::RegisterUserResponse#status #status} => Integer # # @example Request syntax with placeholder values # # resp = client.register_user({ # identity_type: "IAM", # required, accepts IAM, QUICKSIGHT # email: "String", # required # user_role: "ADMIN", # required, accepts ADMIN, AUTHOR, READER, RESTRICTED_AUTHOR, RESTRICTED_READER # iam_arn: "String", # session_name: "RoleSessionName", # aws_account_id: "AwsAccountId", # required # namespace: "Namespace", # required # user_name: "UserName", # }) # # @example 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_invitation_url #=> String # resp.request_id #=> String # resp.status #=> Integer # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/RegisterUser AWS API Documentation # # @overload register_user(params = {}) # @param [Hash] params ({}) def register_user(params = {}, options = {}) req = build_request(:register_user, params) req.send_request(options) end # Searchs for dashboards that belong to a user. # # @option params [required, String] :aws_account_id # The ID of the AWS account that contains the user whose dashboards # you're searching for. # # @option params [required, Array] :filters # The filters to apply to the search. Currently, you can search only by # user name. For example, `"Filters": [ \{ "Name": "QUICKSIGHT_USER", # "Operator": "StringEquals", "Value": # "arn:aws:quicksight:us-east-1:1:user/default/UserName1" \} ]` # # @option params [String] :next_token # The token for the next set of results, or null if there are no more # results. # # @option params [Integer] :max_results # The maximum number of results to be returned per request. # # @return [Types::SearchDashboardsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::SearchDashboardsResponse#dashboard_summary_list #dashboard_summary_list} => Array<Types::DashboardSummary> # * {Types::SearchDashboardsResponse#next_token #next_token} => String # * {Types::SearchDashboardsResponse#status #status} => Integer # * {Types::SearchDashboardsResponse#request_id #request_id} => String # # @example Request syntax with placeholder values # # resp = client.search_dashboards({ # aws_account_id: "AwsAccountId", # required # filters: [ # required # { # operator: "StringEquals", # required, accepts StringEquals # name: "QUICKSIGHT_USER", # accepts QUICKSIGHT_USER # value: "String", # }, # ], # next_token: "String", # max_results: 1, # }) # # @example 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 # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/SearchDashboards AWS API Documentation # # @overload search_dashboards(params = {}) # @param [Hash] params ({}) def search_dashboards(params = {}, options = {}) req = build_request(:search_dashboards, params) req.send_request(options) end # Assigns one or more tags (key-value pairs) to the specified QuickSight # resource. # # Tags can help you organize and categorize your resources. You can also # use them to scope user permissions, by granting a user permission to # access or change only resources with certain tag values. You can use # the `TagResource` operation with a resource that already has tags. If # you specify a new tag key for the resource, this tag is appended to # the list of tags associated with the resource. If you specify a tag # key that is already associated with the resource, the new tag value # that you specify replaces the previous value for that tag. # # You can associate as many as 50 tags with a resource. QuickSight # supports tagging on data set, data source, dashboard, and template. # # Tagging for QuickSight works in a similar way to tagging for other AWS # services, except for the following: # # * You can't use tags to track AWS costs for QuickSight. This # restriction is because QuickSight costs are based on users and SPICE # capacity, which aren't taggable resources. # # * QuickSight doesn't currently support the Tag Editor for AWS # Resource Groups. # # @option params [required, String] :resource_arn # The Amazon Resource Name (ARN) of the resource that you want to tag. # # @option params [required, Array] :tags # Contains a map of the key-value pairs for the resource tag or tags # assigned to the resource. # # @return [Types::TagResourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::TagResourceResponse#request_id #request_id} => String # * {Types::TagResourceResponse#status #status} => Integer # # @example Request syntax with placeholder values # # resp = client.tag_resource({ # resource_arn: "Arn", # required # tags: [ # required # { # key: "TagKey", # required # value: "TagValue", # required # }, # ], # }) # # @example Response structure # # resp.request_id #=> String # resp.status #=> Integer # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/TagResource AWS API Documentation # # @overload tag_resource(params = {}) # @param [Hash] params ({}) def tag_resource(params = {}, options = {}) req = build_request(:tag_resource, params) req.send_request(options) end # Removes a tag or tags from a resource. # # @option params [required, String] :resource_arn # The Amazon Resource Name (ARN) of the resource that you want to untag. # # @option params [required, Array] :tag_keys # The keys of the key-value pairs for the resource tag or tags assigned # to the resource. # # @return [Types::UntagResourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::UntagResourceResponse#request_id #request_id} => String # * {Types::UntagResourceResponse#status #status} => Integer # # @example Request syntax with placeholder values # # resp = client.untag_resource({ # resource_arn: "Arn", # required # tag_keys: ["TagKey"], # required # }) # # @example Response structure # # resp.request_id #=> String # resp.status #=> Integer # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UntagResource AWS API Documentation # # @overload untag_resource(params = {}) # @param [Hash] params ({}) def untag_resource(params = {}, options = {}) req = build_request(:untag_resource, params) req.send_request(options) end # Updates a dashboard in an AWS account. # # @option params [required, String] :aws_account_id # The ID of the AWS account that contains the dashboard that you're # updating. # # @option params [required, String] :dashboard_id # The ID for the dashboard. # # @option params [required, String] :name # The display name of the dashboard. # # @option params [required, Types::DashboardSourceEntity] :source_entity # The template or analysis from which the dashboard is created. The # `SouceTemplate` entity accepts the Amazon Resource Name (ARN) of the # template and also references to replacement datasets for the # placeholders set when creating the template. The replacement datasets # need to follow the same schema as the datasets for which placeholders # were created when creating the template. # # @option params [Types::Parameters] :parameters # A structure that contains the parameters of the dashboard. # # @option params [String] :version_description # A description for the first version of the dashboard being created. # # @option params [Types::DashboardPublishOptions] :dashboard_publish_options # Options for publishing the dashboard when you create it: # # * `AvailabilityStatus` for `AdHocFilteringOption` - This status can be # either `ENABLED` or `DISABLED`. When this is set to `DISABLED`, # QuickSight disables the left filter pane on the published dashboard, # which can be used for ad hoc (one-time) filtering. This option is # `ENABLED` by default. # # * `AvailabilityStatus` for `ExportToCSVOption` - This status can be # either `ENABLED` or `DISABLED`. The visual option to export data to # .csv format isn't enabled when this is set to `DISABLED`. This # option is `ENABLED` by default. # # * `VisibilityState` for `SheetControlsOption` - This visibility state # can be either `COLLAPSED` or `EXPANDED`. The sheet controls pane is # collapsed by default when set to true. This option is `COLLAPSED` by # default. # # @return [Types::UpdateDashboardResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::UpdateDashboardResponse#arn #arn} => String # * {Types::UpdateDashboardResponse#version_arn #version_arn} => String # * {Types::UpdateDashboardResponse#dashboard_id #dashboard_id} => String # * {Types::UpdateDashboardResponse#creation_status #creation_status} => String # * {Types::UpdateDashboardResponse#status #status} => Integer # * {Types::UpdateDashboardResponse#request_id #request_id} => String # # @example Request syntax with placeholder values # # resp = client.update_dashboard({ # aws_account_id: "AwsAccountId", # required # dashboard_id: "RestrictiveResourceId", # required # name: "DashboardName", # required # source_entity: { # required # source_template: { # data_set_references: [ # required # { # data_set_placeholder: "NonEmptyString", # required # data_set_arn: "Arn", # required # }, # ], # arn: "Arn", # required # }, # }, # parameters: { # string_parameters: [ # { # name: "NonEmptyString", # required # values: ["String"], # required # }, # ], # integer_parameters: [ # { # name: "NonEmptyString", # required # values: [1], # required # }, # ], # decimal_parameters: [ # { # name: "NonEmptyString", # required # values: [1.0], # required # }, # ], # date_time_parameters: [ # { # name: "NonEmptyString", # required # values: [Time.now], # required # }, # ], # }, # version_description: "VersionDescription", # dashboard_publish_options: { # ad_hoc_filtering_option: { # availability_status: "ENABLED", # accepts ENABLED, DISABLED # }, # export_to_csv_option: { # availability_status: "ENABLED", # accepts ENABLED, DISABLED # }, # sheet_controls_option: { # visibility_state: "EXPANDED", # accepts EXPANDED, COLLAPSED # }, # }, # }) # # @example Response structure # # resp.arn #=> String # resp.version_arn #=> String # resp.dashboard_id #=> String # resp.creation_status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED" # resp.status #=> Integer # resp.request_id #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateDashboard AWS API Documentation # # @overload update_dashboard(params = {}) # @param [Hash] params ({}) def update_dashboard(params = {}, options = {}) req = build_request(:update_dashboard, params) req.send_request(options) end # Updates read and write permissions on a dashboard. # # @option params [required, String] :aws_account_id # The ID of the AWS account that contains the dashboard whose # permissions you're updating. # # @option params [required, String] :dashboard_id # The ID for the dashboard. # # @option params [Array] :grant_permissions # The permissions that you want to grant on this resource. # # @option params [Array] :revoke_permissions # The permissions that you want to revoke from this resource. # # @return [Types::UpdateDashboardPermissionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::UpdateDashboardPermissionsResponse#dashboard_arn #dashboard_arn} => String # * {Types::UpdateDashboardPermissionsResponse#dashboard_id #dashboard_id} => String # * {Types::UpdateDashboardPermissionsResponse#permissions #permissions} => Array<Types::ResourcePermission> # * {Types::UpdateDashboardPermissionsResponse#request_id #request_id} => String # * {Types::UpdateDashboardPermissionsResponse#status #status} => Integer # # @example Request syntax with placeholder values # # resp = client.update_dashboard_permissions({ # aws_account_id: "AwsAccountId", # required # dashboard_id: "RestrictiveResourceId", # required # grant_permissions: [ # { # principal: "Principal", # required # actions: ["String"], # required # }, # ], # revoke_permissions: [ # { # principal: "Principal", # required # actions: ["String"], # required # }, # ], # }) # # @example Response structure # # resp.dashboard_arn #=> String # resp.dashboard_id #=> String # resp.permissions #=> Array # resp.permissions[0].principal #=> String # resp.permissions[0].actions #=> Array # resp.permissions[0].actions[0] #=> String # resp.request_id #=> String # resp.status #=> Integer # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateDashboardPermissions AWS API Documentation # # @overload update_dashboard_permissions(params = {}) # @param [Hash] params ({}) def update_dashboard_permissions(params = {}, options = {}) req = build_request(:update_dashboard_permissions, params) req.send_request(options) end # Updates the published version of a dashboard. # # @option params [required, String] :aws_account_id # The ID of the AWS account that contains the dashboard that you're # updating. # # @option params [required, String] :dashboard_id # The ID for the dashboard. # # @option params [required, Integer] :version_number # The version number of the dashboard. # # @return [Types::UpdateDashboardPublishedVersionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::UpdateDashboardPublishedVersionResponse#dashboard_id #dashboard_id} => String # * {Types::UpdateDashboardPublishedVersionResponse#dashboard_arn #dashboard_arn} => String # * {Types::UpdateDashboardPublishedVersionResponse#status #status} => Integer # * {Types::UpdateDashboardPublishedVersionResponse#request_id #request_id} => String # # @example Request syntax with placeholder values # # resp = client.update_dashboard_published_version({ # aws_account_id: "AwsAccountId", # required # dashboard_id: "RestrictiveResourceId", # required # version_number: 1, # required # }) # # @example Response structure # # resp.dashboard_id #=> String # resp.dashboard_arn #=> String # resp.status #=> Integer # resp.request_id #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateDashboardPublishedVersion AWS API Documentation # # @overload update_dashboard_published_version(params = {}) # @param [Hash] params ({}) def update_dashboard_published_version(params = {}, options = {}) req = build_request(:update_dashboard_published_version, params) req.send_request(options) end # Updates a dataset. # # @option params [required, String] :aws_account_id # The AWS account ID. # # @option params [required, String] :data_set_id # The ID for the dataset that you want to update. This ID is unique per # AWS Region for each AWS account. # # @option params [required, String] :name # The display name for the dataset. # # @option params [required, Hash] :physical_table_map # Declares the physical tables that are available in the underlying data # sources. # # @option params [Hash] :logical_table_map # Configures the combination and transformation of the data from the # physical tables. # # @option params [required, String] :import_mode # Indicates whether you want to import the data into SPICE. # # @option params [Array] :column_groups # Groupings of columns that work together in certain QuickSight # features. Currently, only geospatial hierarchy is supported. # # @option params [Types::RowLevelPermissionDataSet] :row_level_permission_data_set # The row-level security configuration for the data you want to create. # # @return [Types::UpdateDataSetResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::UpdateDataSetResponse#arn #arn} => String # * {Types::UpdateDataSetResponse#data_set_id #data_set_id} => String # * {Types::UpdateDataSetResponse#ingestion_arn #ingestion_arn} => String # * {Types::UpdateDataSetResponse#ingestion_id #ingestion_id} => String # * {Types::UpdateDataSetResponse#request_id #request_id} => String # * {Types::UpdateDataSetResponse#status #status} => Integer # # @example Request syntax with placeholder values # # resp = client.update_data_set({ # aws_account_id: "AwsAccountId", # required # data_set_id: "ResourceId", # required # name: "ResourceName", # required # physical_table_map: { # required # "PhysicalTableId" => { # relational_table: { # data_source_arn: "Arn", # required # schema: "RelationalTableSchema", # name: "RelationalTableName", # required # input_columns: [ # required # { # name: "ColumnName", # required # type: "STRING", # required, accepts STRING, INTEGER, DECIMAL, DATETIME, BIT, BOOLEAN, JSON # }, # ], # }, # custom_sql: { # data_source_arn: "Arn", # required # name: "CustomSqlName", # required # sql_query: "SqlQuery", # required # columns: [ # { # name: "ColumnName", # required # type: "STRING", # required, accepts STRING, INTEGER, DECIMAL, DATETIME, BIT, BOOLEAN, JSON # }, # ], # }, # s3_source: { # data_source_arn: "Arn", # required # upload_settings: { # format: "CSV", # accepts CSV, TSV, CLF, ELF, XLSX, JSON # start_from_row: 1, # contains_header: false, # text_qualifier: "DOUBLE_QUOTE", # accepts DOUBLE_QUOTE, SINGLE_QUOTE # delimiter: "Delimiter", # }, # input_columns: [ # required # { # name: "ColumnName", # required # type: "STRING", # required, accepts STRING, INTEGER, DECIMAL, DATETIME, BIT, BOOLEAN, JSON # }, # ], # }, # }, # }, # logical_table_map: { # "LogicalTableId" => { # alias: "LogicalTableAlias", # required # data_transforms: [ # { # project_operation: { # projected_columns: ["String"], # required # }, # filter_operation: { # condition_expression: "Expression", # required # }, # create_columns_operation: { # columns: [ # required # { # column_name: "ColumnName", # required # column_id: "ColumnId", # required # expression: "Expression", # required # }, # ], # }, # rename_column_operation: { # column_name: "ColumnName", # required # new_column_name: "ColumnName", # required # }, # cast_column_type_operation: { # column_name: "ColumnName", # required # new_column_type: "STRING", # required, accepts STRING, INTEGER, DECIMAL, DATETIME # format: "TypeCastFormat", # }, # tag_column_operation: { # column_name: "ColumnName", # required # tags: [ # required # { # column_geographic_role: "COUNTRY", # accepts COUNTRY, STATE, COUNTY, CITY, POSTCODE, LONGITUDE, LATITUDE # }, # ], # }, # }, # ], # source: { # required # join_instruction: { # left_operand: "LogicalTableId", # required # right_operand: "LogicalTableId", # required # type: "INNER", # required, accepts INNER, OUTER, LEFT, RIGHT # on_clause: "OnClause", # required # }, # physical_table_id: "PhysicalTableId", # }, # }, # }, # import_mode: "SPICE", # required, accepts SPICE, DIRECT_QUERY # column_groups: [ # { # geo_spatial_column_group: { # name: "ColumnGroupName", # required # country_code: "US", # required, accepts US # columns: ["ColumnName"], # required # }, # }, # ], # row_level_permission_data_set: { # arn: "Arn", # required # permission_policy: "GRANT_ACCESS", # required, accepts GRANT_ACCESS, DENY_ACCESS # }, # }) # # @example 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 # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateDataSet AWS API Documentation # # @overload update_data_set(params = {}) # @param [Hash] params ({}) def update_data_set(params = {}, options = {}) req = build_request(:update_data_set, params) req.send_request(options) end # Updates the permissions on a dataset. # # The permissions resource is # `arn:aws:quicksight:region:aws-account-id:dataset/data-set-id`. # # @option params [required, String] :aws_account_id # The AWS account ID. # # @option params [required, String] :data_set_id # The ID for the dataset whose permissions you want to update. This ID # is unique per AWS Region for each AWS account. # # @option params [Array] :grant_permissions # The resource permissions that you want to grant to the dataset. # # @option params [Array] :revoke_permissions # The resource permissions that you want to revoke from the dataset. # # @return [Types::UpdateDataSetPermissionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::UpdateDataSetPermissionsResponse#data_set_arn #data_set_arn} => String # * {Types::UpdateDataSetPermissionsResponse#data_set_id #data_set_id} => String # * {Types::UpdateDataSetPermissionsResponse#request_id #request_id} => String # * {Types::UpdateDataSetPermissionsResponse#status #status} => Integer # # @example Request syntax with placeholder values # # resp = client.update_data_set_permissions({ # aws_account_id: "AwsAccountId", # required # data_set_id: "ResourceId", # required # grant_permissions: [ # { # principal: "Principal", # required # actions: ["String"], # required # }, # ], # revoke_permissions: [ # { # principal: "Principal", # required # actions: ["String"], # required # }, # ], # }) # # @example Response structure # # resp.data_set_arn #=> String # resp.data_set_id #=> String # resp.request_id #=> String # resp.status #=> Integer # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateDataSetPermissions AWS API Documentation # # @overload update_data_set_permissions(params = {}) # @param [Hash] params ({}) def update_data_set_permissions(params = {}, options = {}) req = build_request(:update_data_set_permissions, params) req.send_request(options) end # Updates a data source. # # @option params [required, String] :aws_account_id # The AWS account ID. # # @option params [required, String] :data_source_id # The ID of the data source. This ID is unique per AWS Region for each # AWS account. # # @option params [required, String] :name # A display name for the data source. # # @option params [Types::DataSourceParameters] :data_source_parameters # The parameters that QuickSight uses to connect to your underlying # source. # # @option params [Types::DataSourceCredentials] :credentials # The credentials that QuickSight that uses to connect to your # underlying source. Currently, only credentials based on user name and # password are supported. # # @option params [Types::VpcConnectionProperties] :vpc_connection_properties # Use this parameter only when you want QuickSight to use a VPC # connection when connecting to your underlying source. # # @option params [Types::SslProperties] :ssl_properties # Secure Socket Layer (SSL) properties that apply when QuickSight # connects to your underlying source. # # @return [Types::UpdateDataSourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::UpdateDataSourceResponse#arn #arn} => String # * {Types::UpdateDataSourceResponse#data_source_id #data_source_id} => String # * {Types::UpdateDataSourceResponse#update_status #update_status} => String # * {Types::UpdateDataSourceResponse#request_id #request_id} => String # * {Types::UpdateDataSourceResponse#status #status} => Integer # # @example Request syntax with placeholder values # # resp = client.update_data_source({ # aws_account_id: "AwsAccountId", # required # data_source_id: "ResourceId", # required # name: "ResourceName", # required # data_source_parameters: { # amazon_elasticsearch_parameters: { # domain: "Domain", # required # }, # athena_parameters: { # work_group: "WorkGroup", # }, # aurora_parameters: { # host: "Host", # required # port: 1, # required # database: "Database", # required # }, # aurora_postgre_sql_parameters: { # host: "Host", # required # port: 1, # required # database: "Database", # required # }, # aws_iot_analytics_parameters: { # data_set_name: "DataSetName", # required # }, # jira_parameters: { # site_base_url: "SiteBaseUrl", # required # }, # maria_db_parameters: { # host: "Host", # required # port: 1, # required # database: "Database", # required # }, # my_sql_parameters: { # host: "Host", # required # port: 1, # required # database: "Database", # required # }, # postgre_sql_parameters: { # host: "Host", # required # port: 1, # required # database: "Database", # required # }, # presto_parameters: { # host: "Host", # required # port: 1, # required # catalog: "Catalog", # required # }, # rds_parameters: { # instance_id: "InstanceId", # required # database: "Database", # required # }, # redshift_parameters: { # host: "Host", # port: 1, # database: "Database", # required # cluster_id: "ClusterId", # }, # s3_parameters: { # manifest_file_location: { # required # bucket: "S3Bucket", # required # key: "S3Key", # required # }, # }, # service_now_parameters: { # site_base_url: "SiteBaseUrl", # required # }, # snowflake_parameters: { # host: "Host", # required # database: "Database", # required # warehouse: "Warehouse", # required # }, # spark_parameters: { # host: "Host", # required # port: 1, # required # }, # sql_server_parameters: { # host: "Host", # required # port: 1, # required # database: "Database", # required # }, # teradata_parameters: { # host: "Host", # required # port: 1, # required # database: "Database", # required # }, # twitter_parameters: { # query: "Query", # required # max_rows: 1, # required # }, # }, # credentials: { # credential_pair: { # username: "Username", # required # password: "Password", # required # }, # }, # vpc_connection_properties: { # vpc_connection_arn: "Arn", # required # }, # ssl_properties: { # disable_ssl: false, # }, # }) # # @example Response structure # # resp.arn #=> String # resp.data_source_id #=> String # resp.update_status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED" # resp.request_id #=> String # resp.status #=> Integer # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateDataSource AWS API Documentation # # @overload update_data_source(params = {}) # @param [Hash] params ({}) def update_data_source(params = {}, options = {}) req = build_request(:update_data_source, params) req.send_request(options) end # Updates the permissions to a data source. # # @option params [required, String] :aws_account_id # The AWS account ID. # # @option params [required, String] :data_source_id # The ID of the data source. This ID is unique per AWS Region for each # AWS account. # # @option params [Array] :grant_permissions # A list of resource permissions that you want to grant on the data # source. # # @option params [Array] :revoke_permissions # A list of resource permissions that you want to revoke on the data # source. # # @return [Types::UpdateDataSourcePermissionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::UpdateDataSourcePermissionsResponse#data_source_arn #data_source_arn} => String # * {Types::UpdateDataSourcePermissionsResponse#data_source_id #data_source_id} => String # * {Types::UpdateDataSourcePermissionsResponse#request_id #request_id} => String # * {Types::UpdateDataSourcePermissionsResponse#status #status} => Integer # # @example Request syntax with placeholder values # # resp = client.update_data_source_permissions({ # aws_account_id: "AwsAccountId", # required # data_source_id: "ResourceId", # required # grant_permissions: [ # { # principal: "Principal", # required # actions: ["String"], # required # }, # ], # revoke_permissions: [ # { # principal: "Principal", # required # actions: ["String"], # required # }, # ], # }) # # @example Response structure # # resp.data_source_arn #=> String # resp.data_source_id #=> String # resp.request_id #=> String # resp.status #=> Integer # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateDataSourcePermissions AWS API Documentation # # @overload update_data_source_permissions(params = {}) # @param [Hash] params ({}) def update_data_source_permissions(params = {}, options = {}) req = build_request(:update_data_source_permissions, params) req.send_request(options) end # Changes a group description. # # @option params [required, String] :group_name # The name of the group that you want to update. # # @option params [String] :description # The description for the group that you want to update. # # @option params [required, String] :aws_account_id # The ID for the AWS account that the group is in. Currently, you use # the ID for the AWS account that contains your Amazon QuickSight # account. # # @option params [required, String] :namespace # The namespace. Currently, you should set this to `default`. # # @return [Types::UpdateGroupResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::UpdateGroupResponse#group #group} => Types::Group # * {Types::UpdateGroupResponse#request_id #request_id} => String # * {Types::UpdateGroupResponse#status #status} => Integer # # @example Request syntax with placeholder values # # resp = client.update_group({ # group_name: "GroupName", # required # description: "GroupDescription", # aws_account_id: "AwsAccountId", # required # namespace: "Namespace", # required # }) # # @example 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 # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateGroup AWS API Documentation # # @overload update_group(params = {}) # @param [Hash] params ({}) def update_group(params = {}, options = {}) req = build_request(:update_group, params) req.send_request(options) end # Updates an existing IAM policy assignment. This operation updates only # the optional parameter or parameters that are specified in the # request. # # @option params [required, String] :aws_account_id # The ID of the AWS account that contains the IAM policy assignment. # # @option params [required, String] :assignment_name # The name of the assignment. This name must be unique within an AWS # account. # # @option params [required, String] :namespace # The namespace of the assignment. # # @option params [String] :assignment_status # 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. # # @option params [String] :policy_arn # The ARN for the IAM policy to apply to the QuickSight users and groups # specified in this assignment. # # @option params [Hash] :identities # The QuickSight users, groups, or both that you want to assign the # policy to. # # @return [Types::UpdateIAMPolicyAssignmentResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::UpdateIAMPolicyAssignmentResponse#assignment_name #assignment_name} => String # * {Types::UpdateIAMPolicyAssignmentResponse#assignment_id #assignment_id} => String # * {Types::UpdateIAMPolicyAssignmentResponse#policy_arn #policy_arn} => String # * {Types::UpdateIAMPolicyAssignmentResponse#identities #identities} => Hash<String,Array<String>> # * {Types::UpdateIAMPolicyAssignmentResponse#assignment_status #assignment_status} => String # * {Types::UpdateIAMPolicyAssignmentResponse#request_id #request_id} => String # * {Types::UpdateIAMPolicyAssignmentResponse#status #status} => Integer # # @example Request syntax with placeholder values # # resp = client.update_iam_policy_assignment({ # aws_account_id: "AwsAccountId", # required # assignment_name: "IAMPolicyAssignmentName", # required # namespace: "Namespace", # required # assignment_status: "ENABLED", # accepts ENABLED, DRAFT, DISABLED # policy_arn: "Arn", # identities: { # "String" => ["IdentityName"], # }, # }) # # @example Response structure # # resp.assignment_name #=> String # resp.assignment_id #=> String # resp.policy_arn #=> String # resp.identities #=> Hash # resp.identities["String"] #=> Array # resp.identities["String"][0] #=> String # resp.assignment_status #=> String, one of "ENABLED", "DRAFT", "DISABLED" # resp.request_id #=> String # resp.status #=> Integer # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateIAMPolicyAssignment AWS API Documentation # # @overload update_iam_policy_assignment(params = {}) # @param [Hash] params ({}) def update_iam_policy_assignment(params = {}, options = {}) req = build_request(:update_iam_policy_assignment, params) req.send_request(options) end # Updates a template from an existing Amazon QuickSight analysis or # another template. # # @option params [required, String] :aws_account_id # The ID of the AWS account that contains the template that you're # updating. # # @option params [required, String] :template_id # The ID for the template. # # @option params [required, Types::TemplateSourceEntity] :source_entity # The source QuickSight entity from which this template is being # updated. You can currently update templates from an Analysis or # another template. # # @option params [String] :version_description # A description of the current template version that is being updated. # Every time you call `UpdateTemplate`, you create a new version of the # template. Each version of the template maintains a description of the # version in the `VersionDescription` field. # # @option params [String] :name # The name for the template. # # @return [Types::UpdateTemplateResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::UpdateTemplateResponse#template_id #template_id} => String # * {Types::UpdateTemplateResponse#arn #arn} => String # * {Types::UpdateTemplateResponse#version_arn #version_arn} => String # * {Types::UpdateTemplateResponse#creation_status #creation_status} => String # * {Types::UpdateTemplateResponse#status #status} => Integer # * {Types::UpdateTemplateResponse#request_id #request_id} => String # # @example Request syntax with placeholder values # # resp = client.update_template({ # aws_account_id: "AwsAccountId", # required # template_id: "RestrictiveResourceId", # 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 # }, # }, # version_description: "VersionDescription", # name: "TemplateName", # }) # # @example Response structure # # resp.template_id #=> String # resp.arn #=> String # resp.version_arn #=> String # resp.creation_status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED" # resp.status #=> Integer # resp.request_id #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateTemplate AWS API Documentation # # @overload update_template(params = {}) # @param [Hash] params ({}) def update_template(params = {}, options = {}) req = build_request(:update_template, params) req.send_request(options) end # Updates the template alias of a template. # # @option params [required, String] :aws_account_id # The ID of the AWS account that contains the template alias that # you're updating. # # @option params [required, String] :template_id # The ID for the template. # # @option params [required, String] :alias_name # The alias of the template that you want to update. If you name a # specific alias, you update the version that the alias points to. You # can specify the latest version of the template by providing the # keyword `$LATEST` in the `AliasName` parameter. The keyword # `$PUBLISHED` doesn't apply to templates. # # @option params [required, Integer] :template_version_number # The version number of the template. # # @return [Types::UpdateTemplateAliasResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::UpdateTemplateAliasResponse#template_alias #template_alias} => Types::TemplateAlias # * {Types::UpdateTemplateAliasResponse#status #status} => Integer # * {Types::UpdateTemplateAliasResponse#request_id #request_id} => String # # @example Request syntax with placeholder values # # resp = client.update_template_alias({ # aws_account_id: "AwsAccountId", # required # template_id: "RestrictiveResourceId", # required # alias_name: "AliasName", # required # template_version_number: 1, # required # }) # # @example 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 # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateTemplateAlias AWS API Documentation # # @overload update_template_alias(params = {}) # @param [Hash] params ({}) def update_template_alias(params = {}, options = {}) req = build_request(:update_template_alias, params) req.send_request(options) end # Updates the resource permissions for a template. # # @option params [required, String] :aws_account_id # The ID of the AWS account that contains the template. # # @option params [required, String] :template_id # The ID for the template. # # @option params [Array] :grant_permissions # A list of resource permissions to be granted on the template. # # @option params [Array] :revoke_permissions # A list of resource permissions to be revoked from the template. # # @return [Types::UpdateTemplatePermissionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::UpdateTemplatePermissionsResponse#template_id #template_id} => String # * {Types::UpdateTemplatePermissionsResponse#template_arn #template_arn} => String # * {Types::UpdateTemplatePermissionsResponse#permissions #permissions} => Array<Types::ResourcePermission> # * {Types::UpdateTemplatePermissionsResponse#request_id #request_id} => String # * {Types::UpdateTemplatePermissionsResponse#status #status} => Integer # # @example Request syntax with placeholder values # # resp = client.update_template_permissions({ # aws_account_id: "AwsAccountId", # required # template_id: "RestrictiveResourceId", # required # grant_permissions: [ # { # principal: "Principal", # required # actions: ["String"], # required # }, # ], # revoke_permissions: [ # { # principal: "Principal", # required # actions: ["String"], # required # }, # ], # }) # # @example 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 # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateTemplatePermissions AWS API Documentation # # @overload update_template_permissions(params = {}) # @param [Hash] params ({}) def update_template_permissions(params = {}, options = {}) req = build_request(:update_template_permissions, params) req.send_request(options) end # Updates an Amazon QuickSight user. # # @option params [required, String] :user_name # The Amazon QuickSight user name that you want to update. # # @option params [required, String] :aws_account_id # The ID for the AWS account that the user is in. Currently, you use the # ID for the AWS account that contains your Amazon QuickSight account. # # @option params [required, String] :namespace # The namespace. Currently, you should set this to `default`. # # @option params [required, String] :email # The email address of the user that you want to update. # # @option params [required, String] :role # The Amazon QuickSight role of the user. The user role can be one of # the following: # # * `READER`\: A user who has read-only access to dashboards. # # * `AUTHOR`\: A user who can create data sources, datasets, analyses, # and dashboards. # # * `ADMIN`\: A user who is an author, who can also manage Amazon # QuickSight settings. # # @return [Types::UpdateUserResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::UpdateUserResponse#user #user} => Types::User # * {Types::UpdateUserResponse#request_id #request_id} => String # * {Types::UpdateUserResponse#status #status} => Integer # # @example Request syntax with placeholder values # # resp = client.update_user({ # user_name: "UserName", # required # aws_account_id: "AwsAccountId", # required # namespace: "Namespace", # required # email: "String", # required # role: "ADMIN", # required, accepts ADMIN, AUTHOR, READER, RESTRICTED_AUTHOR, RESTRICTED_READER # }) # # @example 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.request_id #=> String # resp.status #=> Integer # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateUser AWS API Documentation # # @overload update_user(params = {}) # @param [Hash] params ({}) def update_user(params = {}, options = {}) req = build_request(:update_user, params) req.send_request(options) end # @!endgroup # @param params ({}) # @api private def build_request(operation_name, params = {}) handlers = @handlers.for(operation_name) context = Seahorse::Client::RequestContext.new( operation_name: operation_name, operation: config.api.operation(operation_name), client: self, params: params, config: config) context[:gem_name] = 'aws-sdk-quicksight' context[:gem_version] = '1.17.1' Seahorse::Client::Request.new(handlers, context) end # @api private # @deprecated def waiter_names [] end class << self # @api private attr_reader :identifier # @api private def errors_module Errors end end end end