Class: Aws::QuickSight::Client

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

Creates new reviewed answers for a Q Topic.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

Options Hash (params):

:aws_account_id (required, String) —
The ID of the Amazon Web Services account that you want to create a reviewed answer in.
:topic_id (required, String) —
The ID for the topic reviewed answer that you want to create. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
:answers (required, Array<Types::CreateTopicReviewedAnswer>) —
The definition of the Answers to be created.

Returns:

(Types::BatchCreateTopicReviewedAnswerResponse) —
Returns a response object which responds to the following methods:
- #topic_id => String
- #topic_arn => String
- #succeeded_answers => Array<Types::SucceededTopicReviewedAnswer>
- #invalid_answers => Array<Types::InvalidTopicReviewedAnswer>
- #status => Integer
- #request_id => String

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 1284

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

#batch_delete_knowledge_base(params = {}) ⇒ `Types::BatchDeleteKnowledgeBaseResponse`

Deletes one or more knowledge bases.

Examples:

Request syntax with placeholder values


resp = client.batch_delete_knowledge_base({
  aws_account_id: "KbAwsAccountId", # required
  knowledge_base_ids: ["KnowledgeBaseId"], # required
})

Response structure


resp.deleted #=> Array
resp.deleted[0].knowledge_base_id #=> String
resp.deleted[0].knowledge_base_arn #=> String
resp.errors #=> Array
resp.errors[0].knowledge_base_id #=> String
resp.errors[0].error_code #=> String
resp.errors[0].error_message #=> String
resp.request_id #=> String
resp.status #=> Integer

Parameters:

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

Options Hash (params):

:aws_account_id (required, String) —
The ID of the Amazon Web Services account that contains the knowledge base.
:knowledge_base_ids (required, Array<String>) —
A list of knowledge base identifiers to delete.

Returns:

(Types::BatchDeleteKnowledgeBaseResponse) —
Returns a response object which responds to the following methods:
- #deleted => Array<Types::BatchDeleteKnowledgeBaseSuccess>
- #errors => Array<Types::BatchDeleteKnowledgeBaseFailure>
- #request_id => String
- #status => Integer

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 1328

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

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

Deletes reviewed answers for Q Topic.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

Options Hash (params):

:aws_account_id (required, String) —
The ID of the Amazon Web Services account that you want to delete a reviewed answers in.
:topic_id (required, String) —
The ID for the topic reviewed answer that you want to delete. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
:answer_ids (Array<String>) —
The Answer IDs of the Answers to be deleted.

Returns:

(Types::BatchDeleteTopicReviewedAnswerResponse) —
Returns a response object which responds to the following methods:
- #topic_id => String
- #topic_arn => String
- #succeeded_answers => Array<Types::SucceededTopicReviewedAnswer>
- #invalid_answers => Array<Types::InvalidTopicReviewedAnswer>
- #request_id => String
- #status => Integer

See Also:

AWS API Documentation

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

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

#batch_describe_user_limits(params = {}) ⇒ `Types::BatchDescribeUserLimitsResponse`

Describes the effective resource limits for one or more Amazon Quick Sight users, including the limits that apply to each user based on their profile assignments.

Examples:

Request syntax with placeholder values


resp = client.batch_describe_user_limits({
  account_id: "AwsAccountId", # required
  users: [
    {
      user_name: "String", # required
      namespace: "String", # required
    },
  ],
  resource_types: ["INDEX_STORAGE"], # accepts INDEX_STORAGE, AGENT_HOURS
})

Response structure


resp.user_limits #=> Array
resp.user_limits[0].user_name #=> String
resp.user_limits[0].namespace #=> String
resp.user_limits[0].effective_limits #=> Array
resp.user_limits[0].effective_limits[0].resource_type #=> String, one of "INDEX_STORAGE", "AGENT_HOURS"
resp.user_limits[0].effective_limits[0].limit_value #=> Integer
resp.user_limits[0].effective_limits[0].limit_unit #=> String, one of "MB", "GB", "HOURS", "DAYS"
resp.user_limits[0].effective_limits[0].source #=> String, one of "DIRECT_USER", "GROUP", "ROLE", "ACCOUNT", "SYSTEM_DEFAULT"
resp.user_limits[0].effective_limits[0].profile_id #=> String
resp.errors #=> Array
resp.errors[0].user_name #=> String
resp.errors[0].namespace #=> String
resp.errors[0].user_arn #=> String
resp.errors[0].error_code #=> String
resp.errors[0].message #=> String

Parameters:

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

Options Hash (params):

:account_id (required, String) —
The ID of the Amazon Web Services account that contains the users.
:users (Array<Types::UserLimitsEntry>) —
A list of users to describe limits for. Each entry contains a user name and namespace.
:resource_types (Array<String>) —
An optional filter that limits the results to specific resource types. If you don't specify a value, the operation returns limits for all resource types.

Returns:

(Types::BatchDescribeUserLimitsResponse) —
Returns a response object which responds to the following methods:
- #user_limits => Array<Types::UserLimits>
- #errors => Array<Types::BatchDescribeUserLimitsError>

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 1441

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

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

Cancels an ongoing ingestion of data into SPICE.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

Options Hash (params):

:aws_account_id (required, String) —
The Amazon Web Services account ID.
:data_set_id (required, String) —
The ID of the dataset used in the ingestion.
:ingestion_id (required, String) —
An ID for the ingestion.

Returns:

(Types::CancelIngestionResponse) —
Returns a response object which responds to the following methods:
- #arn => String
- #ingestion_id => String
- #request_id => String
- #status => Integer

See Also:

AWS API Documentation

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

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

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

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

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

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

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

Options Hash (params):

:aws_account_id (required, String) —
The ID for the Amazon Web Services account that you want to customize Quick Sight for.
:namespace (String) —
The Quick Sight namespace that you want to add customizations to.
:account_customization (required, Types::AccountCustomization) —
The Quick Sight customizations you're adding. You can add these to an Amazon Web Services account and a QuickSight namespace.

For example, you can add a default theme by setting AccountCustomization to the midnight theme: "AccountCustomization": { "DefaultTheme": "arn:aws:quicksight::aws:theme/MIDNIGHT" }. Or, you can add a custom theme by specifying "AccountCustomization": { "DefaultTheme": "arn:aws:quicksight:us-west-2:111122223333:theme/bdb844d0-0fe9-4d9d-b520-0fe602d93639" }.
:tags (Array<Types::Tag>) —
A list of the tags that you want to attach to this resource.

Returns:

(Types::CreateAccountCustomizationResponse) —
Returns a response object which responds to the following methods:
- #arn => String
- #aws_account_id => String
- #namespace => String
- #account_customization => Types::AccountCustomization
- #request_id => String
- #status => Integer

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 1577

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

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

Creates an Amazon Quick Sight account, or subscribes to Amazon Quick Sight Q.

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

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

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

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

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

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

Options Hash (params):

:edition (String) —
The edition of Amazon Quick Sight that you want your account to have. Currently, you can choose from ENTERPRISE or ENTERPRISE_AND_Q.

If you choose ENTERPRISE_AND_Q, the following parameters are required:
- FirstName
- LastName
- EmailAddress
- ContactNumber
:authentication_method (required, String) —
The method that you want to use to authenticate your Quick Sight account.

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

If you choose IAM_IDENTITY_CENTER, provide an AdminGroup associated with your IAM Identity Center account.
:aws_account_id (required, String) —
The Amazon Web Services account ID of the account that you're using to create your Quick Sight account.
:account_name (required, String) —
The name of your Amazon Quick Sight account. This name is unique over all of Amazon Web Services, and it appears only when users sign in. You can't change AccountName value after the Amazon Quick Sight account is created.
:notification_email (required, String) —
The email address that you want Quick Sight to send notifications to regarding your Quick Sight account or Quick Sight subscription.
:active_directory_name (String) —
The name of your Active Directory. This field is required if ACTIVE_DIRECTORY is the selected authentication method of the new Quick Sight account.
:realm (String) —
The realm of the Active Directory that is associated with your Quick Sight account. This field is required if ACTIVE_DIRECTORY is the selected authentication method of the new Quick Sight account.
:directory_id (String) —
The ID of the Active Directory that is associated with your Quick Sight account.
:admin_group (Array<String>) —
The admin group associated with your Active Directory or IAM Identity Center account. Either this field or the AdminProGroup field is required if ACTIVE_DIRECTORY or IAM_IDENTITY_CENTER is the selected authentication method of the new Quick Sight account.

For more information about using IAM Identity Center in Amazon Quick Sight, see Using IAM Identity Center with Amazon Quick Sight Enterprise Edition in the Amazon Quick Sight User Guide. For more information about using Active Directory in Amazon Quick Sight, see Using Active Directory with Amazon Quick Sight Enterprise Edition in the Amazon Quick Sight User Guide.
:author_group (Array<String>) —
The author group associated with your Active Directory or IAM Identity Center account.

For more information about using IAM Identity Center in Amazon Quick Sight, see Using IAM Identity Center with Amazon Quick Sight Enterprise Edition in the Amazon Quick Sight User Guide. For more information about using Active Directory in Amazon Quick Sight, see Using Active Directory with Amazon Quick Sight Enterprise Edition in the Amazon Quick Sight User Guide.
:reader_group (Array<String>) —
The reader group associated with your Active Directory or IAM Identity Center account.

For more information about using IAM Identity Center in Amazon Quick Sight, see Using IAM Identity Center with Amazon Quick Sight Enterprise Edition in the Amazon Quick Sight User Guide. For more information about using Active Directory in Amazon Quick Sight, see Using Active Directory with Amazon Quick Sight Enterprise Edition in the Amazon Quick Sight User Guide.
:admin_pro_group (Array<String>) —
The admin pro group associated with your Active Directory or IAM Identity Center account. Either this field or the AdminGroup field is required if ACTIVE_DIRECTORY or IAM_IDENTITY_CENTER is the selected authentication method of the new Quick Sight account.

For more information about using IAM Identity Center in Amazon Quick Sight, see Using IAM Identity Center with Amazon Quick Sight Enterprise Edition in the Amazon Quick Sight User Guide. For more information about using Active Directory in Amazon Quick Sight, see Using Active Directory with Amazon Quick Sight Enterprise Edition in the Amazon Quick Sight User Guide.
:author_pro_group (Array<String>) —
The author pro group associated with your Active Directory or IAM Identity Center account.

For more information about using IAM Identity Center in Amazon Quick Sight, see Using IAM Identity Center with Amazon Quick Sight Enterprise Edition in the Amazon Quick Sight User Guide. For more information about using Active Directory in Amazon Quick Sight, see Using Active Directory with Amazon Quick Sight Enterprise Edition in the Amazon Quick Sight User Guide.
:reader_pro_group (Array<String>) —
The reader pro group associated with your Active Directory or IAM Identity Center account.

For more information about using IAM Identity Center in Amazon Quick Sight, see Using IAM Identity Center with Amazon Quick Sight Enterprise Edition in the Amazon Quick Sight User Guide. For more information about using Active Directory in Amazon Quick Sight, see Using Active Directory with Amazon Quick Sight Enterprise Edition in the Amazon Quick Sight User Guide.
:first_name (String) —
The first name of the author of the Amazon Quick Sight account to use for future communications. This field is required if ENTERPPRISE_AND_Q is the selected edition of the new Amazon Quick Sight account.
:last_name (String) —
The last name of the author of the Amazon Quick Sight account to use for future communications. This field is required if ENTERPPRISE_AND_Q is the selected edition of the new Amazon Quick Sight account.
:email_address (String) —
The email address of the author of the Amazon Quick Sight account to use for future communications. This field is required if ENTERPPRISE_AND_Q is the selected edition of the new Amazon Quick Sight account.
:contact_number (String) —
A 10-digit phone number for the author of the Amazon Quick Sight account to use for future communications. This field is required if ENTERPPRISE_AND_Q is the selected edition of the new Amazon Quick Sight account.
:iam_identity_center_instance_arn (String) —
The Amazon Resource Name (ARN) for the IAM Identity Center instance.

Returns:

(Types::CreateAccountSubscriptionResponse) —
Returns a response object which responds to the following methods:
- #signup_response => Types::SignupResponse
- #status => Integer
- #request_id => String

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 1843

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

#create_action_connector(params = {}) ⇒ `Types::CreateActionConnectorResponse`

Creates an action connector that enables Amazon Quick Sight to connect to external services and perform actions. Action connectors support various authentication methods and can be configured with specific actions from supported connector types like Amazon S3, Salesforce, JIRA.

Examples:

Request syntax with placeholder values


resp = client.create_action_connector({
  aws_account_id: "AwsAccountId", # required
  action_connector_id: "ShortRestrictiveResourceId", # required
  name: "ActionConnectorName", # required
  type: "GENERIC_HTTP", # required, accepts GENERIC_HTTP, SERVICENOW_NOW_PLATFORM, SALESFORCE_CRM, MICROSOFT_OUTLOOK, PAGERDUTY_ADVANCE, JIRA_CLOUD, ATLASSIAN_CONFLUENCE, AMAZON_S3, AMAZON_BEDROCK_AGENT_RUNTIME, AMAZON_BEDROCK_RUNTIME, AMAZON_BEDROCK_DATA_AUTOMATION_RUNTIME, AMAZON_TEXTRACT, AMAZON_COMPREHEND, AMAZON_COMPREHEND_MEDICAL, MICROSOFT_ONEDRIVE, MICROSOFT_SHAREPOINT, MICROSOFT_TEAMS, SAP_BUSINESSPARTNER, SAP_PRODUCTMASTERDATA, SAP_PHYSICALINVENTORY, SAP_BILLOFMATERIALS, SAP_MATERIALSTOCK, ZENDESK_SUITE, SMARTSHEET, SLACK, ASANA, BAMBOO_HR
  authentication_config: { # required
    authentication_type: "BASIC", # required, accepts BASIC, API_KEY, OAUTH2_CLIENT_CREDENTIALS, NONE, IAM, OAUTH2_AUTHORIZATION_CODE
    authentication_metadata: { # required
      authorization_code_grant_metadata: {
        base_endpoint: "Endpoint", # required
        redirect_url: "Endpoint", # required
        authorization_code_grant_credentials_source: "PLAIN_CREDENTIALS", # accepts PLAIN_CREDENTIALS
        authorization_code_grant_credentials_details: {
          authorization_code_grant_details: {
            client_id: "ClientId", # required
            client_secret: "ClientSecret", # required
            token_endpoint: "Endpoint", # required
            authorization_endpoint: "Endpoint", # required
          },
        },
      },
      client_credentials_grant_metadata: {
        base_endpoint: "Endpoint", # required
        client_credentials_source: "PLAIN_CREDENTIALS", # accepts PLAIN_CREDENTIALS
        client_credentials_details: {
          client_credentials_grant_details: {
            client_id: "ClientId", # required
            client_secret: "ClientSecret", # required
            token_endpoint: "Endpoint", # required
          },
        },
      },
      basic_auth_connection_metadata: {
        base_endpoint: "Endpoint", # required
        username: "ActionUserName", # required
        password: "ActionPassword", # required
      },
      api_key_connection_metadata: {
        base_endpoint: "Endpoint", # required
        api_key: "APIKey", # required
        email: "Email",
      },
      none_connection_metadata: {
        base_endpoint: "Endpoint", # required
      },
      iam_connection_metadata: {
        role_arn: "RoleArn", # required
      },
    },
  },
  description: "ActionConnectorDescription",
  permissions: [
    {
      principal: "Principal", # required
      actions: ["String"], # required
    },
  ],
  vpc_connection_arn: "Arn",
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
})

Response structure


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

Parameters:

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

Options Hash (params):

:aws_account_id (required, String) —
The Amazon Web Services account ID associated with the action connector.
:action_connector_id (required, String) —
A unique identifier for the action connector. This ID must be unique within the Amazon Web Services account. The ActionConnectorId must not start with the prefix quicksuite-
:name (required, String) —
A descriptive name for the action connector.
:type (required, String) —
The type of action connector.
:authentication_config (required, Types::AuthConfig) —
The authentication configuration for connecting to the external service. This includes the authentication type, base URL, and authentication metadata such as client credentials or API keys.
:description (String) —
An optional description of the action connector.
:permissions (Array<Types::ResourcePermission>) —
The permissions configuration that defines which users, groups, or namespaces can access this action connector and what operations they can perform.
:vpc_connection_arn (String) —
The ARN of the VPC connection to use for secure connectivity to the external service.
:tags (Array<Types::Tag>) —
A list of tags to apply to the action connector for resource management and organization.

Returns:

(Types::CreateActionConnectorResponse) —
Returns a response object which responds to the following methods:
- #arn => String
- #creation_status => String
- #action_connector_id => String
- #request_id => String
- #status => Integer

See Also:

AWS API Documentation

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

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

#create_agent(params = {}) ⇒ `Types::CreateAgentResponse`

Creates an agent in Amazon QuickSight.

Examples:

Request syntax with placeholder values


resp = client.create_agent({
  spaces: ["Arn"],
  action_connectors: ["Arn"],
  aws_account_id: "AwsAccountId", # required
  agent_id: "AgentId", # required
  name: "AgentName", # required
  description: "AgentDescription",
  icon_id: "IconId",
  starter_prompts: ["StarterPrompt"],
  welcome_message: "WelcomeMessage",
  agent_lifecycle: "PREVIEW", # accepts PREVIEW, PUBLISHED
  custom_prompt_input: {
    existing_prompt: {
      model_profile_id: "ModelProfileId", # required
      subscription_id: "SubscriptionId", # required
      qbs_aws_account_id: "QbsAwsAccountId", # required
    },
    new_prompt: {
      response_length: "StyleDescription",
      output_style: "StyleDescription",
      identity: "StyleDescription",
      tone: "StyleDescription",
      custom_instructions: "StyleDescription",
    },
  },
})

Response structure


resp.arn #=> String
resp.agent_id #=> String
resp.agent_status #=> String, one of "ACTIVE", "UPDATING", "FAILED", "CREATING"
resp.agent_name #=> String
resp.request_id #=> String

Parameters:

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

Options Hash (params):

:spaces (Array<String>) —
The Amazon Resource Names (ARNs) of the spaces to attach to the agent.
:action_connectors (Array<String>) —
The Amazon Resource Names (ARNs) of the action connectors to attach to the agent.
:aws_account_id (required, String) —
The ID of the Amazon Web Services account that contains the agent.
:agent_id (required, String) —
A unique identifier for the agent.
:name (required, String) —
The name of the agent.
:description (String) —
A description of the agent.
:icon_id (String) —
The icon identifier for the agent.
:starter_prompts (Array<String>) —
A list of starter prompts that are displayed to users when they begin interacting with the agent.
:welcome_message (String) —
The welcome message that is displayed when a user starts a conversation with the agent.
:agent_lifecycle (String) —
The lifecycle state of the agent. Valid values are PREVIEW and PUBLISHED.
:custom_prompt_input (Types::CustomPromptInput) —
The custom prompt configuration for the agent.

Returns:

(Types::CreateAgentResponse) —
Returns a response object which responds to the following methods:
- #arn => String
- #agent_id => String
- #agent_status => String
- #agent_name => String
- #request_id => String

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 2071

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

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

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

Examples:

Response structure


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

Parameters:

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

Options Hash (params):

:aws_account_id (required, String) —
The ID of the Amazon Web Services account where you are creating an analysis.
:analysis_id (required, String) —
The ID for the analysis that you're creating. This ID displays in the URL of the analysis.
:name (required, String) —
A descriptive name for the analysis that you're creating. This name displays for the analysis in the Amazon Quick Sight console.
:parameters (Types::Parameters) —
The parameter names and override values that you want to use. An analysis can have any parameter type, and some parameters might accept multiple values.
:permissions (Array<Types::ResourcePermission>) —
A structure that describes the principals and the resource-level permissions on an analysis. You can use the Permissions structure to grant permissions by providing a list of Identity and Access Management (IAM) action information for each principal listed by Amazon Resource Name (ARN).

To specify no permissions, omit Permissions.
:source_entity (Types::AnalysisSourceEntity) —
A source entity to use for the analysis that you're creating. This metadata structure contains details that describe a source template and one or more datasets or topics.

Either a SourceEntity or a Definition must be provided in order for the request to be valid.
:theme_arn (String) —
The ARN for the theme to apply to the analysis that you're creating. To see the theme in the Amazon Quick Sight console, make sure that you have access to it.
:tags (Array<Types::Tag>) —
Contains a map of the key-value pairs for the resource tag or tags assigned to the analysis.
:definition (Types::AnalysisDefinition) —
The definition of an analysis.

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

Either a SourceEntity or a Definition must be provided in order for the request to be valid.
:validation_strategy (Types::ValidationStrategy) —
The option to relax the validation needed to create an analysis with definition objects. This skips the validation step for specific errors.
:folder_arns (Array<String>) —
When you create the analysis, Amazon Quick Sight adds the analysis to these folders.

Returns:

(Types::CreateAnalysisResponse) —
Returns a response object which responds to the following methods:
- #arn => String
- #analysis_id => String
- #creation_status => String
- #status => Integer
- #request_id => String

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 2160

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

#create_approval_policy(params = {}) ⇒ `Types::CreateApprovalPolicyResponse`

Creates an approval policy in Quick Sight.

Examples:

Request syntax with placeholder values


resp = client.create_approval_policy({
  policy_id: "PolicyId", # required
  name: "PolicyName", # required
  description: "PolicyDescription",
  actions: ["SHARE"], # required, accepts SHARE
  asset_types: ["AGENT"], # required, accepts AGENT, SPACE, KNOWLEDGE_BASE
  applicable_to: { # required
    type: "GROUP", # required, accepts GROUP
    group_arns: ["Arn"],
  },
  approval_groups: ["Arn"], # required
})

Response structure


resp.policy.policy_id #=> String
resp.policy.policy_arn #=> String
resp.policy.name #=> String
resp.policy.description #=> String
resp.policy.actions #=> Array
resp.policy.actions[0] #=> String, one of "SHARE"
resp.policy.asset_types #=> Array
resp.policy.asset_types[0] #=> String, one of "AGENT", "SPACE", "KNOWLEDGE_BASE"
resp.policy.applicable_to.type #=> String, one of "GROUP"
resp.policy.applicable_to.group_arns #=> Array
resp.policy.applicable_to.group_arns[0] #=> String
resp.policy.approval_groups #=> Array
resp.policy.approval_groups[0] #=> String
resp.policy.created_at #=> Time
resp.policy.updated_at #=> Time

Parameters:

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

Options Hash (params):

:policy_id (required, String) —
The unique identifier to assign to the approval policy. You cannot change this value after you create the policy.
:name (required, String) —
The name of the approval policy.
:description (String) —
A description of the approval policy.
:actions (required, Array<String>) —
The list of governed actions that trigger the approval workflow.
:asset_types (required, Array<String>) —
The list of asset types that the approval policy applies to.
:applicable_to (required, Types::ApplicableTo) —
The scoping configuration that determines who the approval policy applies to.
:approval_groups (required, Array<String>) —
The list of group ARNs whose members can approve requests.

Returns:

(Types::CreateApprovalPolicyResponse) —
Returns a response object which responds to the following methods:
- #policy => Types::ApprovalPolicy

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 2231

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

#create_brand(params = {}) ⇒ `Types::CreateBrandResponse`

Creates an Quick Sight brand.

Examples:

Request syntax with placeholder values


resp = client.create_brand({
  aws_account_id: "AwsAccountId", # required
  brand_id: "ShortRestrictiveResourceId", # required
  brand_definition: {
    brand_name: "Name", # required
    description: "Description",
    application_theme: {
      brand_color_palette: {
        primary: {
          foreground: "HexColor",
          background: "HexColor",
        },
        secondary: {
          foreground: "HexColor",
          background: "HexColor",
        },
        accent: {
          foreground: "HexColor",
          background: "HexColor",
        },
        measure: {
          foreground: "HexColor",
          background: "HexColor",
        },
        dimension: {
          foreground: "HexColor",
          background: "HexColor",
        },
        success: {
          foreground: "HexColor",
          background: "HexColor",
        },
        info: {
          foreground: "HexColor",
          background: "HexColor",
        },
        warning: {
          foreground: "HexColor",
          background: "HexColor",
        },
        danger: {
          foreground: "HexColor",
          background: "HexColor",
        },
      },
      contextual_accent_palette: {
        connection: {
          foreground: "HexColor",
          background: "HexColor",
        },
        visualization: {
          foreground: "HexColor",
          background: "HexColor",
        },
        insight: {
          foreground: "HexColor",
          background: "HexColor",
        },
        automation: {
          foreground: "HexColor",
          background: "HexColor",
        },
      },
      brand_element_style: {
        navbar_style: {
          global_navbar: {
            foreground: "HexColor",
            background: "HexColor",
          },
          contextual_navbar: {
            foreground: "HexColor",
            background: "HexColor",
          },
        },
      },
    },
    logo_configuration: {
      alt_text: "String", # required
      logo_set: { # required
        primary: { # required
          original: { # required
            source: {
              public_url: "String",
              s3_uri: "String",
            },
          },
        },
        favicon: {
          original: { # required
            source: {
              public_url: "String",
              s3_uri: "String",
            },
          },
        },
      },
    },
  },
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
})

Response structure


resp.request_id #=> String
resp.brand_detail.brand_id #=> String
resp.brand_detail.arn #=> String
resp.brand_detail.brand_status #=> String, one of "CREATE_IN_PROGRESS", "CREATE_SUCCEEDED", "CREATE_FAILED", "DELETE_IN_PROGRESS", "DELETE_FAILED"
resp.brand_detail.created_time #=> Time
resp.brand_detail.last_updated_time #=> Time
resp.brand_detail.version_id #=> String
resp.brand_detail.version_status #=> String, one of "CREATE_IN_PROGRESS", "CREATE_SUCCEEDED", "CREATE_FAILED"
resp.brand_detail.errors #=> Array
resp.brand_detail.errors[0] #=> String
resp.brand_detail.logo.alt_text #=> String
resp.brand_detail.logo.logo_set.primary.original.source.public_url #=> String
resp.brand_detail.logo.logo_set.primary.original.source.s3_uri #=> String
resp.brand_detail.logo.logo_set.primary.original.generated_image_url #=> String
resp.brand_detail.logo.logo_set.primary.height_64.source.public_url #=> String
resp.brand_detail.logo.logo_set.primary.height_64.source.s3_uri #=> String
resp.brand_detail.logo.logo_set.primary.height_64.generated_image_url #=> String
resp.brand_detail.logo.logo_set.primary.height_32.source.public_url #=> String
resp.brand_detail.logo.logo_set.primary.height_32.source.s3_uri #=> String
resp.brand_detail.logo.logo_set.primary.height_32.generated_image_url #=> String
resp.brand_detail.logo.logo_set.favicon.original.source.public_url #=> String
resp.brand_detail.logo.logo_set.favicon.original.source.s3_uri #=> String
resp.brand_detail.logo.logo_set.favicon.original.generated_image_url #=> String
resp.brand_detail.logo.logo_set.favicon.height_64.source.public_url #=> String
resp.brand_detail.logo.logo_set.favicon.height_64.source.s3_uri #=> String
resp.brand_detail.logo.logo_set.favicon.height_64.generated_image_url #=> String
resp.brand_detail.logo.logo_set.favicon.height_32.source.public_url #=> String
resp.brand_detail.logo.logo_set.favicon.height_32.source.s3_uri #=> String
resp.brand_detail.logo.logo_set.favicon.height_32.generated_image_url #=> String
resp.brand_definition.brand_name #=> String
resp.brand_definition.description #=> String
resp.brand_definition.application_theme.brand_color_palette.primary.foreground #=> String
resp.brand_definition.application_theme.brand_color_palette.primary.background #=> String
resp.brand_definition.application_theme.brand_color_palette.secondary.foreground #=> String
resp.brand_definition.application_theme.brand_color_palette.secondary.background #=> String
resp.brand_definition.application_theme.brand_color_palette.accent.foreground #=> String
resp.brand_definition.application_theme.brand_color_palette.accent.background #=> String
resp.brand_definition.application_theme.brand_color_palette.measure.foreground #=> String
resp.brand_definition.application_theme.brand_color_palette.measure.background #=> String
resp.brand_definition.application_theme.brand_color_palette.dimension.foreground #=> String
resp.brand_definition.application_theme.brand_color_palette.dimension.background #=> String
resp.brand_definition.application_theme.brand_color_palette.success.foreground #=> String
resp.brand_definition.application_theme.brand_color_palette.success.background #=> String
resp.brand_definition.application_theme.brand_color_palette.info.foreground #=> String
resp.brand_definition.application_theme.brand_color_palette.info.background #=> String
resp.brand_definition.application_theme.brand_color_palette.warning.foreground #=> String
resp.brand_definition.application_theme.brand_color_palette.warning.background #=> String
resp.brand_definition.application_theme.brand_color_palette.danger.foreground #=> String
resp.brand_definition.application_theme.brand_color_palette.danger.background #=> String
resp.brand_definition.application_theme.contextual_accent_palette.connection.foreground #=> String
resp.brand_definition.application_theme.contextual_accent_palette.connection.background #=> String
resp.brand_definition.application_theme.contextual_accent_palette.visualization.foreground #=> String
resp.brand_definition.application_theme.contextual_accent_palette.visualization.background #=> String
resp.brand_definition.application_theme.contextual_accent_palette.insight.foreground #=> String
resp.brand_definition.application_theme.contextual_accent_palette.insight.background #=> String
resp.brand_definition.application_theme.contextual_accent_palette.automation.foreground #=> String
resp.brand_definition.application_theme.contextual_accent_palette.automation.background #=> String
resp.brand_definition.application_theme.brand_element_style.navbar_style.global_navbar.foreground #=> String
resp.brand_definition.application_theme.brand_element_style.navbar_style.global_navbar.background #=> String
resp.brand_definition.application_theme.brand_element_style.navbar_style.contextual_navbar.foreground #=> String
resp.brand_definition.application_theme.brand_element_style.navbar_style.contextual_navbar.background #=> String
resp.brand_definition.logo_configuration.alt_text #=> String
resp.brand_definition.logo_configuration.logo_set.primary.original.source.public_url #=> String
resp.brand_definition.logo_configuration.logo_set.primary.original.source.s3_uri #=> String
resp.brand_definition.logo_configuration.logo_set.favicon.original.source.public_url #=> String
resp.brand_definition.logo_configuration.logo_set.favicon.original.source.s3_uri #=> String

Parameters:

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

Options Hash (params):

:aws_account_id (required, String) —
The ID of the Amazon Web Services account that owns the brand.
:brand_id (required, String) —
The ID of the Quick brand.
:brand_definition (Types::BrandDefinition) —
The definition of the brand.
:tags (Array<Types::Tag>) —
A map of the key-value pairs that are assigned to the brand.

Returns:

(Types::CreateBrandResponse) —
Returns a response object which responds to the following methods:
- #request_id => String
- #brand_detail => Types::BrandDetail
- #brand_definition => Types::BrandDefinition

See Also:

AWS API Documentation

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

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

#create_custom_permissions(params = {}) ⇒ `Types::CreateCustomPermissionsResponse`

Creates a custom permissions profile.

Examples:

Request syntax with placeholder values


resp = client.create_custom_permissions({
  aws_account_id: "AwsAccountId", # required
  custom_permissions_name: "CustomPermissionsName", # required
  capabilities: {
    export_to_csv: "DENY", # accepts DENY, ALLOW
    export_to_excel: "DENY", # accepts DENY, ALLOW
    export_to_pdf: "DENY", # accepts DENY, ALLOW
    print_reports: "DENY", # accepts DENY, ALLOW
    create_and_update_themes: "DENY", # accepts DENY, ALLOW
    add_or_run_anomaly_detection_for_analyses: "DENY", # accepts DENY, ALLOW
    share_analyses: "DENY", # accepts DENY, ALLOW
    create_and_update_datasets: "DENY", # accepts DENY, ALLOW
    share_datasets: "DENY", # accepts DENY, ALLOW
    subscribe_dashboard_email_reports: "DENY", # accepts DENY, ALLOW
    create_and_update_dashboard_email_reports: "DENY", # accepts DENY, ALLOW
    share_dashboards: "DENY", # accepts DENY, ALLOW
    create_and_update_threshold_alerts: "DENY", # accepts DENY, ALLOW
    rename_shared_folders: "DENY", # accepts DENY, ALLOW
    create_shared_folders: "DENY", # accepts DENY, ALLOW
    create_and_update_data_sources: "DENY", # accepts DENY, ALLOW
    share_data_sources: "DENY", # accepts DENY, ALLOW
    view_account_spice_capacity: "DENY", # accepts DENY, ALLOW
    create_spice_dataset: "DENY", # accepts DENY, ALLOW
    export_to_pdf_in_scheduled_reports: "DENY", # accepts DENY, ALLOW
    export_to_csv_in_scheduled_reports: "DENY", # accepts DENY, ALLOW
    export_to_excel_in_scheduled_reports: "DENY", # accepts DENY, ALLOW
    include_content_in_scheduled_reports_email: "DENY", # accepts DENY, ALLOW
    dashboard: "DENY", # accepts DENY, ALLOW
    analysis: "DENY", # accepts DENY, ALLOW
    automate: "DENY", # accepts DENY, ALLOW
    flow: "DENY", # accepts DENY, ALLOW
    apps: "DENY", # accepts DENY, ALLOW
    create_and_update_apps: "DENY", # accepts DENY, ALLOW
    share_apps: "DENY", # accepts DENY, ALLOW
    invoke_apps_ai_inference: "DENY", # accepts DENY, ALLOW
    access_apps_native_data_store: "DENY", # accepts DENY, ALLOW
    publish_without_approval: "DENY", # accepts DENY, ALLOW
    use_bedrock_models: "DENY", # accepts DENY, ALLOW
    perform_flow_ui_task: "DENY", # accepts DENY, ALLOW
    approve_flow_share_requests: "DENY", # accepts DENY, ALLOW
    use_agent_web_search: "DENY", # accepts DENY, ALLOW
    knowledge_base: "DENY", # accepts DENY, ALLOW
    create_and_update_knowledge_bases: "DENY", # accepts DENY, ALLOW
    share_knowledge_bases: "DENY", # accepts DENY, ALLOW
    share_point_knowledge_base: "DENY", # accepts DENY, ALLOW
    create_and_update_share_point_knowledge_base: "DENY", # accepts DENY, ALLOW
    share_share_point_knowledge_base: "DENY", # accepts DENY, ALLOW
    use_share_point_knowledge_base: "DENY", # accepts DENY, ALLOW
    google_drive_knowledge_base: "DENY", # accepts DENY, ALLOW
    create_and_update_google_drive_knowledge_base: "DENY", # accepts DENY, ALLOW
    share_google_drive_knowledge_base: "DENY", # accepts DENY, ALLOW
    use_google_drive_knowledge_base: "DENY", # accepts DENY, ALLOW
    web_crawler_knowledge_base: "DENY", # accepts DENY, ALLOW
    create_and_update_web_crawler_knowledge_base: "DENY", # accepts DENY, ALLOW
    share_web_crawler_knowledge_base: "DENY", # accepts DENY, ALLOW
    use_web_crawler_knowledge_base: "DENY", # accepts DENY, ALLOW
    s3_knowledge_base: "DENY", # accepts DENY, ALLOW
    create_and_update_s3_knowledge_base: "DENY", # accepts DENY, ALLOW
    share_s3_knowledge_base: "DENY", # accepts DENY, ALLOW
    use_s3_knowledge_base: "DENY", # accepts DENY, ALLOW
    confluence_knowledge_base: "DENY", # accepts DENY, ALLOW
    create_and_update_confluence_knowledge_base: "DENY", # accepts DENY, ALLOW
    share_confluence_knowledge_base: "DENY", # accepts DENY, ALLOW
    use_confluence_knowledge_base: "DENY", # accepts DENY, ALLOW
    one_drive_knowledge_base: "DENY", # accepts DENY, ALLOW
    create_and_update_one_drive_knowledge_base: "DENY", # accepts DENY, ALLOW
    share_one_drive_knowledge_base: "DENY", # accepts DENY, ALLOW
    use_one_drive_knowledge_base: "DENY", # accepts DENY, ALLOW
    q_business_knowledge_base: "DENY", # accepts DENY, ALLOW
    create_and_update_q_business_knowledge_base: "DENY", # accepts DENY, ALLOW
    share_q_business_knowledge_base: "DENY", # accepts DENY, ALLOW
    use_q_business_knowledge_base: "DENY", # accepts DENY, ALLOW
    bedrock_managed_knowledge_base: "DENY", # accepts DENY, ALLOW
    create_and_update_bedrock_managed_knowledge_base: "DENY", # accepts DENY, ALLOW
    share_bedrock_managed_knowledge_base: "DENY", # accepts DENY, ALLOW
    use_bedrock_managed_knowledge_base: "DENY", # accepts DENY, ALLOW
    box_knowledge_base: "DENY", # accepts DENY, ALLOW
    create_and_update_box_knowledge_base: "DENY", # accepts DENY, ALLOW
    share_box_knowledge_base: "DENY", # accepts DENY, ALLOW
    use_box_knowledge_base: "DENY", # accepts DENY, ALLOW
    idc_knowledge_base: "DENY", # accepts DENY, ALLOW
    create_and_update_idc_knowledge_base: "DENY", # accepts DENY, ALLOW
    share_idc_knowledge_base: "DENY", # accepts DENY, ALLOW
    use_idc_knowledge_base: "DENY", # accepts DENY, ALLOW
    action: "DENY", # accepts DENY, ALLOW
    generic_http_action: "DENY", # accepts DENY, ALLOW
    create_and_update_generic_http_action: "DENY", # accepts DENY, ALLOW
    share_generic_http_action: "DENY", # accepts DENY, ALLOW
    use_generic_http_action: "DENY", # accepts DENY, ALLOW
    asana_action: "DENY", # accepts DENY, ALLOW
    create_and_update_asana_action: "DENY", # accepts DENY, ALLOW
    share_asana_action: "DENY", # accepts DENY, ALLOW
    use_asana_action: "DENY", # accepts DENY, ALLOW
    slack_action: "DENY", # accepts DENY, ALLOW
    create_and_update_slack_action: "DENY", # accepts DENY, ALLOW
    share_slack_action: "DENY", # accepts DENY, ALLOW
    use_slack_action: "DENY", # accepts DENY, ALLOW
    service_now_action: "DENY", # accepts DENY, ALLOW
    create_and_update_service_now_action: "DENY", # accepts DENY, ALLOW
    share_service_now_action: "DENY", # accepts DENY, ALLOW
    use_service_now_action: "DENY", # accepts DENY, ALLOW
    salesforce_action: "DENY", # accepts DENY, ALLOW
    create_and_update_salesforce_action: "DENY", # accepts DENY, ALLOW
    share_salesforce_action: "DENY", # accepts DENY, ALLOW
    use_salesforce_action: "DENY", # accepts DENY, ALLOW
    ms_exchange_action: "DENY", # accepts DENY, ALLOW
    create_and_update_ms_exchange_action: "DENY", # accepts DENY, ALLOW
    share_ms_exchange_action: "DENY", # accepts DENY, ALLOW
    use_ms_exchange_action: "DENY", # accepts DENY, ALLOW
    pager_duty_action: "DENY", # accepts DENY, ALLOW
    create_and_update_pager_duty_action: "DENY", # accepts DENY, ALLOW
    share_pager_duty_action: "DENY", # accepts DENY, ALLOW
    use_pager_duty_action: "DENY", # accepts DENY, ALLOW
    jira_action: "DENY", # accepts DENY, ALLOW
    create_and_update_jira_action: "DENY", # accepts DENY, ALLOW
    share_jira_action: "DENY", # accepts DENY, ALLOW
    use_jira_action: "DENY", # accepts DENY, ALLOW
    confluence_action: "DENY", # accepts DENY, ALLOW
    create_and_update_confluence_action: "DENY", # accepts DENY, ALLOW
    share_confluence_action: "DENY", # accepts DENY, ALLOW
    use_confluence_action: "DENY", # accepts DENY, ALLOW
    one_drive_action: "DENY", # accepts DENY, ALLOW
    create_and_update_one_drive_action: "DENY", # accepts DENY, ALLOW
    share_one_drive_action: "DENY", # accepts DENY, ALLOW
    use_one_drive_action: "DENY", # accepts DENY, ALLOW
    share_point_action: "DENY", # accepts DENY, ALLOW
    create_and_update_share_point_action: "DENY", # accepts DENY, ALLOW
    share_share_point_action: "DENY", # accepts DENY, ALLOW
    use_share_point_action: "DENY", # accepts DENY, ALLOW
    ms_teams_action: "DENY", # accepts DENY, ALLOW
    create_and_update_ms_teams_action: "DENY", # accepts DENY, ALLOW
    share_ms_teams_action: "DENY", # accepts DENY, ALLOW
    use_ms_teams_action: "DENY", # accepts DENY, ALLOW
    google_calendar_action: "DENY", # accepts DENY, ALLOW
    create_and_update_google_calendar_action: "DENY", # accepts DENY, ALLOW
    share_google_calendar_action: "DENY", # accepts DENY, ALLOW
    use_google_calendar_action: "DENY", # accepts DENY, ALLOW
    zendesk_action: "DENY", # accepts DENY, ALLOW
    create_and_update_zendesk_action: "DENY", # accepts DENY, ALLOW
    share_zendesk_action: "DENY", # accepts DENY, ALLOW
    use_zendesk_action: "DENY", # accepts DENY, ALLOW
    smartsheet_action: "DENY", # accepts DENY, ALLOW
    create_and_update_smartsheet_action: "DENY", # accepts DENY, ALLOW
    share_smartsheet_action: "DENY", # accepts DENY, ALLOW
    use_smartsheet_action: "DENY", # accepts DENY, ALLOW
    sap_business_partner_action: "DENY", # accepts DENY, ALLOW
    create_and_update_sap_business_partner_action: "DENY", # accepts DENY, ALLOW
    share_sap_business_partner_action: "DENY", # accepts DENY, ALLOW
    use_sap_business_partner_action: "DENY", # accepts DENY, ALLOW
    sap_product_master_data_action: "DENY", # accepts DENY, ALLOW
    create_and_update_sap_product_master_data_action: "DENY", # accepts DENY, ALLOW
    share_sap_product_master_data_action: "DENY", # accepts DENY, ALLOW
    use_sap_product_master_data_action: "DENY", # accepts DENY, ALLOW
    sap_physical_inventory_action: "DENY", # accepts DENY, ALLOW
    create_and_update_sap_physical_inventory_action: "DENY", # accepts DENY, ALLOW
    share_sap_physical_inventory_action: "DENY", # accepts DENY, ALLOW
    use_sap_physical_inventory_action: "DENY", # accepts DENY, ALLOW
    sap_bill_of_material_action: "DENY", # accepts DENY, ALLOW
    create_and_update_sap_bill_of_material_action: "DENY", # accepts DENY, ALLOW
    share_sap_bill_of_material_action: "DENY", # accepts DENY, ALLOW
    use_sap_bill_of_material_action: "DENY", # accepts DENY, ALLOW
    sap_material_stock_action: "DENY", # accepts DENY, ALLOW
    create_and_update_sap_material_stock_action: "DENY", # accepts DENY, ALLOW
    share_sap_material_stock_action: "DENY", # accepts DENY, ALLOW
    use_sap_material_stock_action: "DENY", # accepts DENY, ALLOW
    fact_set_action: "DENY", # accepts DENY, ALLOW
    create_and_update_fact_set_action: "DENY", # accepts DENY, ALLOW
    share_fact_set_action: "DENY", # accepts DENY, ALLOW
    use_fact_set_action: "DENY", # accepts DENY, ALLOW
    amazon_s_three_action: "DENY", # accepts DENY, ALLOW
    create_and_update_amazon_s_three_action: "DENY", # accepts DENY, ALLOW
    share_amazon_s_three_action: "DENY", # accepts DENY, ALLOW
    use_amazon_s_three_action: "DENY", # accepts DENY, ALLOW
    textract_action: "DENY", # accepts DENY, ALLOW
    create_and_update_textract_action: "DENY", # accepts DENY, ALLOW
    share_textract_action: "DENY", # accepts DENY, ALLOW
    use_textract_action: "DENY", # accepts DENY, ALLOW
    comprehend_action: "DENY", # accepts DENY, ALLOW
    create_and_update_comprehend_action: "DENY", # accepts DENY, ALLOW
    share_comprehend_action: "DENY", # accepts DENY, ALLOW
    use_comprehend_action: "DENY", # accepts DENY, ALLOW
    comprehend_medical_action: "DENY", # accepts DENY, ALLOW
    create_and_update_comprehend_medical_action: "DENY", # accepts DENY, ALLOW
    share_comprehend_medical_action: "DENY", # accepts DENY, ALLOW
    use_comprehend_medical_action: "DENY", # accepts DENY, ALLOW
    amazon_bedrock_ars_action: "DENY", # accepts DENY, ALLOW
    create_and_update_amazon_bedrock_ars_action: "DENY", # accepts DENY, ALLOW
    share_amazon_bedrock_ars_action: "DENY", # accepts DENY, ALLOW
    use_amazon_bedrock_ars_action: "DENY", # accepts DENY, ALLOW
    amazon_bedrock_fs_action: "DENY", # accepts DENY, ALLOW
    create_and_update_amazon_bedrock_fs_action: "DENY", # accepts DENY, ALLOW
    share_amazon_bedrock_fs_action: "DENY", # accepts DENY, ALLOW
    use_amazon_bedrock_fs_action: "DENY", # accepts DENY, ALLOW
    amazon_bedrock_krs_action: "DENY", # accepts DENY, ALLOW
    create_and_update_amazon_bedrock_krs_action: "DENY", # accepts DENY, ALLOW
    share_amazon_bedrock_krs_action: "DENY", # accepts DENY, ALLOW
    use_amazon_bedrock_krs_action: "DENY", # accepts DENY, ALLOW
    mcp_action: "DENY", # accepts DENY, ALLOW
    create_and_update_mcp_action: "DENY", # accepts DENY, ALLOW
    share_mcp_action: "DENY", # accepts DENY, ALLOW
    use_mcp_action: "DENY", # accepts DENY, ALLOW
    open_api_action: "DENY", # accepts DENY, ALLOW
    create_and_update_open_api_action: "DENY", # accepts DENY, ALLOW
    share_open_api_action: "DENY", # accepts DENY, ALLOW
    use_open_api_action: "DENY", # accepts DENY, ALLOW
    sand_pgmi_action: "DENY", # accepts DENY, ALLOW
    create_and_update_sand_pgmi_action: "DENY", # accepts DENY, ALLOW
    share_sand_pgmi_action: "DENY", # accepts DENY, ALLOW
    use_sand_pgmi_action: "DENY", # accepts DENY, ALLOW
    sand_p_global_energy_action: "DENY", # accepts DENY, ALLOW
    create_and_update_sand_p_global_energy_action: "DENY", # accepts DENY, ALLOW
    share_sand_p_global_energy_action: "DENY", # accepts DENY, ALLOW
    use_sand_p_global_energy_action: "DENY", # accepts DENY, ALLOW
    bamboo_hr_action: "DENY", # accepts DENY, ALLOW
    create_and_update_bamboo_hr_action: "DENY", # accepts DENY, ALLOW
    share_bamboo_hr_action: "DENY", # accepts DENY, ALLOW
    use_bamboo_hr_action: "DENY", # accepts DENY, ALLOW
    box_agent_action: "DENY", # accepts DENY, ALLOW
    create_and_update_box_agent_action: "DENY", # accepts DENY, ALLOW
    share_box_agent_action: "DENY", # accepts DENY, ALLOW
    use_box_agent_action: "DENY", # accepts DENY, ALLOW
    canva_agent_action: "DENY", # accepts DENY, ALLOW
    create_and_update_canva_agent_action: "DENY", # accepts DENY, ALLOW
    share_canva_agent_action: "DENY", # accepts DENY, ALLOW
    use_canva_agent_action: "DENY", # accepts DENY, ALLOW
    github_action: "DENY", # accepts DENY, ALLOW
    create_and_update_github_action: "DENY", # accepts DENY, ALLOW
    share_github_action: "DENY", # accepts DENY, ALLOW
    use_github_action: "DENY", # accepts DENY, ALLOW
    notion_action: "DENY", # accepts DENY, ALLOW
    create_and_update_notion_action: "DENY", # accepts DENY, ALLOW
    share_notion_action: "DENY", # accepts DENY, ALLOW
    use_notion_action: "DENY", # accepts DENY, ALLOW
    linear_action: "DENY", # accepts DENY, ALLOW
    create_and_update_linear_action: "DENY", # accepts DENY, ALLOW
    share_linear_action: "DENY", # accepts DENY, ALLOW
    use_linear_action: "DENY", # accepts DENY, ALLOW
    hugging_face_action: "DENY", # accepts DENY, ALLOW
    create_and_update_hugging_face_action: "DENY", # accepts DENY, ALLOW
    share_hugging_face_action: "DENY", # accepts DENY, ALLOW
    use_hugging_face_action: "DENY", # accepts DENY, ALLOW
    monday_action: "DENY", # accepts DENY, ALLOW
    create_and_update_monday_action: "DENY", # accepts DENY, ALLOW
    share_monday_action: "DENY", # accepts DENY, ALLOW
    use_monday_action: "DENY", # accepts DENY, ALLOW
    hubspot_action: "DENY", # accepts DENY, ALLOW
    create_and_update_hubspot_action: "DENY", # accepts DENY, ALLOW
    share_hubspot_action: "DENY", # accepts DENY, ALLOW
    use_hubspot_action: "DENY", # accepts DENY, ALLOW
    intercom_action: "DENY", # accepts DENY, ALLOW
    create_and_update_intercom_action: "DENY", # accepts DENY, ALLOW
    share_intercom_action: "DENY", # accepts DENY, ALLOW
    use_intercom_action: "DENY", # accepts DENY, ALLOW
    new_relic_action: "DENY", # accepts DENY, ALLOW
    create_and_update_new_relic_action: "DENY", # accepts DENY, ALLOW
    share_new_relic_action: "DENY", # accepts DENY, ALLOW
    use_new_relic_action: "DENY", # accepts DENY, ALLOW
    topic: "DENY", # accepts DENY, ALLOW
    edit_visual_with_q: "DENY", # accepts DENY, ALLOW
    build_calculated_field_with_q: "DENY", # accepts DENY, ALLOW
    create_dashboard_executive_summary_with_q: "DENY", # accepts DENY, ALLOW
    space: "DENY", # accepts DENY, ALLOW
    create_spaces: "DENY", # accepts DENY, ALLOW
    share_spaces: "DENY", # accepts DENY, ALLOW
    chat_agent: "DENY", # accepts DENY, ALLOW
    create_chat_agents: "DENY", # accepts DENY, ALLOW
    share_chat_agents: "DENY", # accepts DENY, ALLOW
    research: "DENY", # accepts DENY, ALLOW
    self_upgrade_user_role: "DENY", # accepts DENY, ALLOW
    extension: "DENY", # accepts DENY, ALLOW
    use_browser_extension: "DENY", # accepts DENY, ALLOW
    use_word_add_in_extension: "DENY", # accepts DENY, ALLOW
    use_outlook_add_in_extension: "DENY", # accepts DENY, ALLOW
    use_excel_add_in_extension: "DENY", # accepts DENY, ALLOW
    use_powerpoint_add_in_extension: "DENY", # accepts DENY, ALLOW
    manage_shared_folders: "DENY", # accepts DENY, ALLOW
    generate_analyses: "DENY", # accepts DENY, ALLOW
    story: "DENY", # accepts DENY, ALLOW
    scenario: "DENY", # accepts DENY, ALLOW
    trigger: "DENY", # accepts DENY, ALLOW
    schedule_trigger: "DENY", # accepts DENY, ALLOW
    inbound_email_trigger: "DENY", # accepts DENY, ALLOW
    quick_event_trigger: "DENY", # accepts DENY, ALLOW
  },
  governance: {
    default_category_effects: {
      "GovernanceCategoryName" => "DENY_BY_DEFAULT", # accepts DENY_BY_DEFAULT
    },
  },
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
})

Response structure


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

Parameters:

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

Options Hash (params):

:aws_account_id (required, String) —
The ID of the Amazon Web Services account that you want to create the custom permissions profile in.
:custom_permissions_name (required, String) —
The name of the custom permissions profile that you want to create.
:capabilities (Types::Capabilities) —
A set of actions to include in the custom permissions profile.
:governance (Types::Governance) —
The governance configuration for the custom permissions profile. When governance controls are defined for a category, any capabilities in that category not explicitly set to ALLOW in Capabilities are denied. Even newly added capabilities in the category are implicitly disabled when Amazon Quick releases them.
:tags (Array<Types::Tag>) —
The tags to associate with the custom permissions profile.

Returns:

(Types::CreateCustomPermissionsResponse) —
Returns a response object which responds to the following methods:
- #status => Integer
- #arn => String
- #request_id => String

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 2779

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

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

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

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

Examples:

Response structure


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

Parameters:

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

Options Hash (params):

:aws_account_id (required, String) —
The ID of the Amazon Web Services account where you want to create the dashboard.
:dashboard_id (required, String) —
The ID for the dashboard, also added to the IAM policy.
:name (required, String) —
The display name of the dashboard.
:parameters (Types::Parameters) —
The parameters for the creation of the dashboard, which you want to use to override the default settings. A dashboard can have any type of parameters, and some parameters might accept multiple values.
:permissions (Array<Types::ResourcePermission>) —
A structure that contains the permissions of the dashboard. You can use this structure for granting permissions by providing a list of IAM action information for each principal ARN.

To specify no permissions, omit the permissions list.
:source_entity (Types::DashboardSourceEntity) —
The entity that you are using as a source when you create the dashboard. In SourceEntity, you specify the type of object you're using as source. You can only create a dashboard from a template, so you use a SourceTemplate entity. If you need to create a dashboard from an analysis, first convert the analysis to a template by using the CreateTemplate API operation. For SourceTemplate, specify the Amazon Resource Name (ARN) of the source template. The SourceTemplateARN can contain any Amazon Web Services account and any Amazon Quick Sight-supported Amazon Web Services Region.

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

Either a SourceEntity or a Definition must be provided in order for the request to be valid.
:tags (Array<Types::Tag>) —
Contains a map of the key-value pairs for the resource tag or tags assigned to the dashboard.
:version_description (String) —
A description for the first version of the dashboard being created.
:dashboard_publish_options (Types::DashboardPublishOptions) —
Options for publishing the dashboard when you create it:
- AvailabilityStatus for AdHocFilteringOption - This status can be either ENABLED or DISABLED. When this is set to DISABLED, Amazon Quick Sight disables the left filter pane on the published dashboard, which can be used for ad hoc (one-time) filtering. This option is ENABLED by default.
- AvailabilityStatus for ExportToCSVOption - This status can be either ENABLED or DISABLED. The visual option to export data to .CSV format isn't enabled when this is set to DISABLED. This option is ENABLED by default.
- VisibilityState for SheetControlsOption - This visibility state can be either COLLAPSED or EXPANDED. This option is COLLAPSED by default.
- AvailabilityStatus for QuickSuiteActionsOption - This status can be either ENABLED or DISABLED. Features related to Actions in Amazon Quick Suite on dashboards are disabled when this is set to DISABLED. This option is DISABLED by default.
- AvailabilityStatus for ExecutiveSummaryOption - This status can be either ENABLED or DISABLED. The option to build an executive summary is disabled when this is set to DISABLED. This option is ENABLED by default.
- AvailabilityStatus for DataStoriesSharingOption - This status can be either ENABLED or DISABLED. The option to share a data story is disabled when this is set to DISABLED. This option is ENABLED by default.
:theme_arn (String) —
The Amazon Resource Name (ARN) of the theme that is being used for this dashboard. If you add a value for this field, it overrides the value that is used in the source entity. The theme ARN must exist in the same Amazon Web Services account where you create the dashboard.
:definition (Types::DashboardVersionDefinition) —
The definition of a dashboard.

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

Either a SourceEntity or a Definition must be provided in order for the request to be valid.
:validation_strategy (Types::ValidationStrategy) —
The option to relax the validation needed to create a dashboard with definition objects. This option skips the validation step for specific errors.
:folder_arns (Array<String>) —
When you create the dashboard, Amazon Quick Sight adds the dashboard to these folders.
:link_sharing_configuration (Types::LinkSharingConfiguration) —
A structure that contains the permissions of a shareable link to the dashboard.
:link_entities (Array<String>) —
A list of analysis Amazon Resource Names (ARNs) to be linked to the dashboard.

Returns:

(Types::CreateDashboardResponse) —
Returns a response object which responds to the following methods:
- #arn => String
- #version_arn => String
- #dashboard_id => String
- #creation_status => String
- #status => Integer
- #request_id => String

See Also:

AWS API Documentation

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

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

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

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

Examples:

Request syntax with placeholder values


resp = client.create_data_set({
  aws_account_id: "AwsAccountId", # required
  data_set_id: "ResourceId", # required
  name: "ResourceName", # required
  physical_table_map: { # required
    "PhysicalTableId" => {
      relational_table: {
        data_source_arn: "Arn", # required
        catalog: "RelationalTableCatalog",
        schema: "RelationalTableSchema",
        name: "RelationalTableName", # required
        input_columns: [ # required
          {
            name: "ColumnName", # required
            id: "ColumnId",
            type: "STRING", # required, accepts STRING, INTEGER, DECIMAL, DATETIME, BIT, BOOLEAN, JSON, SEMISTRUCT
            sub_type: "FLOAT", # accepts FLOAT, FIXED
          },
        ],
      },
      custom_sql: {
        data_source_arn: "Arn", # required
        name: "CustomSqlName", # required
        sql_query: "SqlQuery", # required
        columns: [
          {
            name: "ColumnName", # required
            id: "ColumnId",
            type: "STRING", # required, accepts STRING, INTEGER, DECIMAL, DATETIME, BIT, BOOLEAN, JSON, SEMISTRUCT
            sub_type: "FLOAT", # accepts FLOAT, FIXED
          },
        ],
      },
      s3_source: {
        data_source_arn: "Arn", # required
        upload_settings: {
          format: "CSV", # accepts CSV, TSV, CLF, ELF, XLSX, JSON
          start_from_row: 1,
          contains_header: false,
          text_qualifier: "DOUBLE_QUOTE", # accepts DOUBLE_QUOTE, SINGLE_QUOTE
          delimiter: "Delimiter",
          custom_cell_address_range: "String",
        },
        input_columns: [ # required
          {
            name: "ColumnName", # required
            id: "ColumnId",
            type: "STRING", # required, accepts STRING, INTEGER, DECIMAL, DATETIME, BIT, BOOLEAN, JSON, SEMISTRUCT
            sub_type: "FLOAT", # accepts FLOAT, FIXED
          },
        ],
      },
      saa_s_table: {
        data_source_arn: "Arn", # required
        table_path: [ # required
          {
            name: "TablePathElementName",
            id: "TablePathElementId",
          },
        ],
        input_columns: [ # required
          {
            name: "ColumnName", # required
            id: "ColumnId",
            type: "STRING", # required, accepts STRING, INTEGER, DECIMAL, DATETIME, BIT, BOOLEAN, JSON, SEMISTRUCT
            sub_type: "FLOAT", # accepts FLOAT, FIXED
          },
        ],
      },
      file_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",
          custom_cell_address_range: "String",
        },
        sheet_index: 1, # required
        input_columns: [ # required
          {
            name: "ColumnName", # required
            id: "ColumnId",
            type: "STRING", # required, accepts STRING, INTEGER, DECIMAL, DATETIME, BIT, BOOLEAN, JSON, SEMISTRUCT
            sub_type: "FLOAT", # accepts FLOAT, FIXED
          },
        ],
      },
    },
  },
  logical_table_map: {
    "LogicalTableId" => {
      alias: "LogicalTableAlias", # required
      data_transforms: [
        {
          project_operation: {
            alias: "TransformOperationAlias",
            source: {
              transform_operation_id: "DataSetEntityResourceId", # required
              column_id_mappings: [
                {
                  source_column_id: "ColumnId", # required
                  target_column_id: "ColumnId", # required
                },
              ],
            },
            projected_columns: ["String"], # required
          },
          filter_operation: {
            condition_expression: "Expression",
            string_filter_condition: {
              column_name: "ColumnName",
              comparison_filter_condition: {
                operator: "EQUALS", # required, accepts EQUALS, DOES_NOT_EQUAL, CONTAINS, DOES_NOT_CONTAIN, STARTS_WITH, ENDS_WITH
                value: {
                  static_value: "DataSetStringFilterStaticValue",
                },
              },
              list_filter_condition: {
                operator: "INCLUDE", # required, accepts INCLUDE, EXCLUDE
                values: {
                  static_values: ["DataSetStringFilterStaticValue"],
                },
              },
            },
            numeric_filter_condition: {
              column_name: "ColumnName",
              comparison_filter_condition: {
                operator: "EQUALS", # required, accepts EQUALS, DOES_NOT_EQUAL, GREATER_THAN, GREATER_THAN_OR_EQUALS_TO, LESS_THAN, LESS_THAN_OR_EQUALS_TO
                value: {
                  static_value: 1.0,
                },
              },
              range_filter_condition: {
                range_minimum: {
                  static_value: 1.0,
                },
                range_maximum: {
                  static_value: 1.0,
                },
                include_minimum: false,
                include_maximum: false,
              },
            },
            date_filter_condition: {
              column_name: "ColumnName",
              comparison_filter_condition: {
                operator: "BEFORE", # required, accepts BEFORE, BEFORE_OR_EQUALS_TO, AFTER, AFTER_OR_EQUALS_TO
                value: {
                  static_value: Time.now,
                },
              },
              range_filter_condition: {
                range_minimum: {
                  static_value: Time.now,
                },
                range_maximum: {
                  static_value: Time.now,
                },
                include_minimum: false,
                include_maximum: false,
              },
            },
          },
          create_columns_operation: {
            alias: "TransformOperationAlias",
            source: {
              transform_operation_id: "DataSetEntityResourceId", # required
              column_id_mappings: [
                {
                  source_column_id: "ColumnId", # required
                  target_column_id: "ColumnId", # required
                },
              ],
            },
            columns: [ # required
              {
                column_name: "ColumnName", # required
                column_id: "ColumnId", # required
                expression: "DataSetCalculatedFieldExpression", # required
              },
            ],
          },
          rename_column_operation: {
            column_name: "ColumnName", # required
            new_column_name: "ColumnName", # required
          },
          cast_column_type_operation: {
            column_name: "ColumnName", # required
            new_column_type: "STRING", # required, accepts STRING, INTEGER, DECIMAL, DATETIME
            sub_type: "FLOAT", # accepts FLOAT, FIXED
            format: "TypeCastFormat",
          },
          tag_column_operation: {
            column_name: "ColumnName", # required
            tags: [ # required
              {
                column_geographic_role: "COUNTRY", # accepts COUNTRY, STATE, COUNTY, CITY, POSTCODE, LONGITUDE, LATITUDE
                column_description: {
                  text: "ColumnDescriptiveText",
                },
              },
            ],
          },
          untag_column_operation: {
            column_name: "ColumnName", # required
            tag_names: ["COLUMN_GEOGRAPHIC_ROLE"], # required, accepts COLUMN_GEOGRAPHIC_ROLE, COLUMN_DESCRIPTION
          },
          override_dataset_parameter_operation: {
            parameter_name: "DatasetParameterName", # required
            new_parameter_name: "DatasetParameterName",
            new_default_values: {
              string_static_values: ["StringDatasetParameterDefaultValue"],
              decimal_static_values: [1.0],
              date_time_static_values: [Time.now],
              integer_static_values: [1],
            },
          },
        },
      ],
      source: { # required
        join_instruction: {
          left_operand: "LogicalTableId", # required
          right_operand: "LogicalTableId", # required
          left_join_key_properties: {
            unique_key: false,
          },
          right_join_key_properties: {
            unique_key: false,
          },
          type: "INNER", # required, accepts INNER, OUTER, LEFT, RIGHT
          on_clause: "OnClause", # required
        },
        physical_table_id: "PhysicalTableId",
        data_set_arn: "Arn",
      },
    },
  },
  import_mode: "SPICE", # required, accepts SPICE, DIRECT_QUERY
  column_groups: [
    {
      geo_spatial_column_group: {
        name: "ColumnGroupName", # required
        country_code: "US", # accepts US
        columns: ["ColumnName"], # required
      },
    },
  ],
  field_folders: {
    "FieldFolderPath" => {
      description: "FieldFolderDescription",
      columns: ["String"],
    },
  },
  permissions: [
    {
      principal: "Principal", # required
      actions: ["String"], # required
    },
  ],
  row_level_permission_data_set: {
    namespace: "Namespace",
    arn: "Arn", # required
    permission_policy: "GRANT_ACCESS", # required, accepts GRANT_ACCESS, DENY_ACCESS
    format_version: "VERSION_1", # accepts VERSION_1, VERSION_2
    status: "ENABLED", # accepts ENABLED, DISABLED
  },
  row_level_permission_tag_configuration: {
    status: "ENABLED", # accepts ENABLED, DISABLED
    tag_rules: [ # required
      {
        tag_key: "SessionTagKey", # required
        column_name: "String", # required
        tag_multi_value_delimiter: "RowLevelPermissionTagDelimiter",
        match_all_value: "SessionTagValue",
      },
    ],
    tag_rule_configurations: [
      ["SessionTagKey"],
    ],
  },
  column_level_permission_rules: [
    {
      principals: ["String"],
      column_names: ["String"],
    },
  ],
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
  data_set_usage_configuration: {
    disable_use_as_direct_query_source: false,
    disable_use_as_imported_source: false,
  },
  dataset_parameters: [
    {
      string_dataset_parameter: {
        id: "DatasetParameterId", # required
        name: "DatasetParameterName", # required
        value_type: "MULTI_VALUED", # required, accepts MULTI_VALUED, SINGLE_VALUED
        default_values: {
          static_values: ["StringDatasetParameterDefaultValue"],
        },
      },
      decimal_dataset_parameter: {
        id: "DatasetParameterId", # required
        name: "DatasetParameterName", # required
        value_type: "MULTI_VALUED", # required, accepts MULTI_VALUED, SINGLE_VALUED
        default_values: {
          static_values: [1.0],
        },
      },
      integer_dataset_parameter: {
        id: "DatasetParameterId", # required
        name: "DatasetParameterName", # required
        value_type: "MULTI_VALUED", # required, accepts MULTI_VALUED, SINGLE_VALUED
        default_values: {
          static_values: [1],
        },
      },
      date_time_dataset_parameter: {
        id: "DatasetParameterId", # required
        name: "DatasetParameterName", # required
        value_type: "MULTI_VALUED", # required, accepts MULTI_VALUED, SINGLE_VALUED
        time_granularity: "YEAR", # accepts YEAR, QUARTER, MONTH, WEEK, DAY, HOUR, MINUTE, SECOND, MILLISECOND
        default_values: {
          static_values: [Time.now],
        },
      },
    },
  ],
  folder_arns: ["Arn"],
  performance_configuration: {
    unique_keys: [
      {
        column_names: ["ColumnName"], # required
      },
    ],
  },
  use_as: "RLS_RULES", # accepts RLS_RULES
  data_prep_configuration: {
    source_table_map: { # required
      "DataSetEntityResourceId" => {
        physical_table_id: "DataSetEntityResourceId",
        data_set: {
          data_set_arn: "Arn", # required
          input_columns: [ # required
            {
              name: "ColumnName", # required
              id: "ColumnId",
              type: "STRING", # required, accepts STRING, INTEGER, DECIMAL, DATETIME, BIT, BOOLEAN, JSON, SEMISTRUCT
              sub_type: "FLOAT", # accepts FLOAT, FIXED
            },
          ],
        },
      },
    },
    transform_step_map: { # required
      "DataSetEntityResourceId" => {
        import_table_step: {
          alias: "TransformOperationAlias", # required
          source: { # required
            source_table_id: "DataSetEntityResourceId", # required
            column_id_mappings: [
              {
                source_column_id: "ColumnId", # required
                target_column_id: "ColumnId", # required
              },
            ],
          },
        },
        project_step: {
          alias: "TransformOperationAlias",
          source: {
            transform_operation_id: "DataSetEntityResourceId", # required
            column_id_mappings: [
              {
                source_column_id: "ColumnId", # required
                target_column_id: "ColumnId", # required
              },
            ],
          },
          projected_columns: ["String"], # required
        },
        filters_step: {
          alias: "TransformOperationAlias", # required
          source: { # required
            transform_operation_id: "DataSetEntityResourceId", # required
            column_id_mappings: [
              {
                source_column_id: "ColumnId", # required
                target_column_id: "ColumnId", # required
              },
            ],
          },
          filter_operations: [ # required
            {
              condition_expression: "Expression",
              string_filter_condition: {
                column_name: "ColumnName",
                comparison_filter_condition: {
                  operator: "EQUALS", # required, accepts EQUALS, DOES_NOT_EQUAL, CONTAINS, DOES_NOT_CONTAIN, STARTS_WITH, ENDS_WITH
                  value: {
                    static_value: "DataSetStringFilterStaticValue",
                  },
                },
                list_filter_condition: {
                  operator: "INCLUDE", # required, accepts INCLUDE, EXCLUDE
                  values: {
                    static_values: ["DataSetStringFilterStaticValue"],
                  },
                },
              },
              numeric_filter_condition: {
                column_name: "ColumnName",
                comparison_filter_condition: {
                  operator: "EQUALS", # required, accepts EQUALS, DOES_NOT_EQUAL, GREATER_THAN, GREATER_THAN_OR_EQUALS_TO, LESS_THAN, LESS_THAN_OR_EQUALS_TO
                  value: {
                    static_value: 1.0,
                  },
                },
                range_filter_condition: {
                  range_minimum: {
                    static_value: 1.0,
                  },
                  range_maximum: {
                    static_value: 1.0,
                  },
                  include_minimum: false,
                  include_maximum: false,
                },
              },
              date_filter_condition: {
                column_name: "ColumnName",
                comparison_filter_condition: {
                  operator: "BEFORE", # required, accepts BEFORE, BEFORE_OR_EQUALS_TO, AFTER, AFTER_OR_EQUALS_TO
                  value: {
                    static_value: Time.now,
                  },
                },
                range_filter_condition: {
                  range_minimum: {
                    static_value: Time.now,
                  },
                  range_maximum: {
                    static_value: Time.now,
                  },
                  include_minimum: false,
                  include_maximum: false,
                },
              },
            },
          ],
        },
        create_columns_step: {
          alias: "TransformOperationAlias",
          source: {
            transform_operation_id: "DataSetEntityResourceId", # required
            column_id_mappings: [
              {
                source_column_id: "ColumnId", # required
                target_column_id: "ColumnId", # required
              },
            ],
          },
          columns: [ # required
            {
              column_name: "ColumnName", # required
              column_id: "ColumnId", # required
              expression: "DataSetCalculatedFieldExpression", # required
            },
          ],
        },
        rename_columns_step: {
          alias: "TransformOperationAlias", # required
          source: { # required
            transform_operation_id: "DataSetEntityResourceId", # required
            column_id_mappings: [
              {
                source_column_id: "ColumnId", # required
                target_column_id: "ColumnId", # required
              },
            ],
          },
          rename_column_operations: [ # required
            {
              column_name: "ColumnName", # required
              new_column_name: "ColumnName", # required
            },
          ],
        },
        cast_column_types_step: {
          alias: "TransformOperationAlias", # required
          source: { # required
            transform_operation_id: "DataSetEntityResourceId", # required
            column_id_mappings: [
              {
                source_column_id: "ColumnId", # required
                target_column_id: "ColumnId", # required
              },
            ],
          },
          cast_column_type_operations: [ # required
            {
              column_name: "ColumnName", # required
              new_column_type: "STRING", # required, accepts STRING, INTEGER, DECIMAL, DATETIME
              sub_type: "FLOAT", # accepts FLOAT, FIXED
              format: "TypeCastFormat",
            },
          ],
        },
        join_step: {
          alias: "TransformOperationAlias", # required
          left_operand: { # required
            transform_operation_id: "DataSetEntityResourceId", # required
            column_id_mappings: [
              {
                source_column_id: "ColumnId", # required
                target_column_id: "ColumnId", # required
              },
            ],
          },
          right_operand: { # required
            transform_operation_id: "DataSetEntityResourceId", # required
            column_id_mappings: [
              {
                source_column_id: "ColumnId", # required
                target_column_id: "ColumnId", # required
              },
            ],
          },
          type: "INNER", # required, accepts INNER, OUTER, LEFT, RIGHT
          on_clause: "JoinOperationOnClause", # required
          left_operand_properties: {
            output_column_name_overrides: [ # required
              {
                source_column_name: "ColumnName",
                output_column_name: "ColumnName", # required
              },
            ],
          },
          right_operand_properties: {
            output_column_name_overrides: [ # required
              {
                source_column_name: "ColumnName",
                output_column_name: "ColumnName", # required
              },
            ],
          },
        },
        aggregate_step: {
          alias: "TransformOperationAlias", # required
          source: { # required
            transform_operation_id: "DataSetEntityResourceId", # required
            column_id_mappings: [
              {
                source_column_id: "ColumnId", # required
                target_column_id: "ColumnId", # required
              },
            ],
          },
          group_by_column_names: ["ColumnName"],
          aggregations: [ # required
            {
              aggregation_function: { # required
                simple_aggregation: {
                  input_column_name: "ColumnName",
                  function_type: "COUNT", # required, accepts COUNT, DISTINCT_COUNT, SUM, AVERAGE, MAX, MIN
                },
                list_aggregation: {
                  input_column_name: "ColumnName",
                  separator: "Separator", # required
                  distinct: false, # required
                },
              },
              new_column_name: "ColumnName", # required
              new_column_id: "ColumnId", # required
            },
          ],
        },
        pivot_step: {
          alias: "TransformOperationAlias", # required
          source: { # required
            transform_operation_id: "DataSetEntityResourceId", # required
            column_id_mappings: [
              {
                source_column_id: "ColumnId", # required
                target_column_id: "ColumnId", # required
              },
            ],
          },
          group_by_column_names: ["ColumnName"],
          value_column_configuration: { # required
            aggregation_function: {
              simple_aggregation: {
                input_column_name: "ColumnName",
                function_type: "COUNT", # required, accepts COUNT, DISTINCT_COUNT, SUM, AVERAGE, MAX, MIN
              },
              list_aggregation: {
                input_column_name: "ColumnName",
                separator: "Separator", # required
                distinct: false, # required
              },
            },
          },
          pivot_configuration: { # required
            label_column_name: "ColumnName",
            pivoted_labels: [ # required
              {
                label_name: "CellValue", # required
                new_column_name: "ColumnName", # required
                new_column_id: "ColumnId", # required
              },
            ],
          },
        },
        unpivot_step: {
          alias: "TransformOperationAlias", # required
          source: { # required
            transform_operation_id: "DataSetEntityResourceId", # required
            column_id_mappings: [
              {
                source_column_id: "ColumnId", # required
                target_column_id: "ColumnId", # required
              },
            ],
          },
          columns_to_unpivot: [ # required
            {
              column_name: "ColumnName",
              new_value: "CellValue",
            },
          ],
          unpivoted_label_column_name: "ColumnName", # required
          unpivoted_label_column_id: "ColumnId", # required
          unpivoted_value_column_name: "ColumnName", # required
          unpivoted_value_column_id: "ColumnId", # required
        },
        append_step: {
          alias: "TransformOperationAlias", # required
          first_source: {
            transform_operation_id: "DataSetEntityResourceId", # required
            column_id_mappings: [
              {
                source_column_id: "ColumnId", # required
                target_column_id: "ColumnId", # required
              },
            ],
          },
          second_source: {
            transform_operation_id: "DataSetEntityResourceId", # required
            column_id_mappings: [
              {
                source_column_id: "ColumnId", # required
                target_column_id: "ColumnId", # required
              },
            ],
          },
          appended_columns: [ # required
            {
              column_name: "ColumnName", # required
              new_column_id: "ColumnId", # required
            },
          ],
        },
      },
    },
    destination_table_map: { # required
      "DataSetEntityResourceId" => {
        alias: "DestinationTableAlias", # required
        source: { # required
          transform_operation_id: "DataSetEntityResourceId", # required
        },
      },
    },
  },
  semantic_model_configuration: {
    table_map: {
      "DataSetEntityResourceId" => {
        alias: "SemanticTableAlias", # required
        destination_table_id: "DataSetEntityResourceId", # required
        row_level_permission_configuration: {
          tag_configuration: {
            status: "ENABLED", # accepts ENABLED, DISABLED
            tag_rules: [ # required
              {
                tag_key: "SessionTagKey", # required
                column_name: "String", # required
                tag_multi_value_delimiter: "RowLevelPermissionTagDelimiter",
                match_all_value: "SessionTagValue",
              },
            ],
            tag_rule_configurations: [
              ["SessionTagKey"],
            ],
          },
          row_level_permission_data_set: {
            namespace: "Namespace",
            arn: "Arn", # required
            permission_policy: "GRANT_ACCESS", # required, accepts GRANT_ACCESS, DENY_ACCESS
            format_version: "VERSION_1", # accepts VERSION_1, VERSION_2
            status: "ENABLED", # accepts ENABLED, DISABLED
          },
        },
        semantic_metadata: {
          column_metadata: [
            {
              column_names: ["ColumnName"],
              column_properties: [ # required
                {
                  description: {
                    text: "ColumnDescriptiveText",
                  },
                  additional_notes: {
                    text: "AdditionalNotesText",
                  },
                  semantic_type: {
                    geographical_role: "COUNTRY", # accepts COUNTRY, STATE, COUNTY, CITY, POSTCODE, LONGITUDE, LATITUDE
                  },
                },
              ],
            },
          ],
        },
      },
    },
    semantic_metadata: [
      {
        description: {
          text: "DataSetDescriptiveText", # required
        },
        custom_instructions: [
          {
            inline_custom_instruction: {
              instruction_text: "InlineCustomInstructionText", # required
              uploaded_document_metadata: {
                name: "UploadedDocumentName",
              },
            },
          },
        ],
      },
    ],
  },
})

Response structure


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

Parameters:

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

Options Hash (params):

:aws_account_id (required, String) —
The Amazon Web Services account ID.
:data_set_id (required, String) —
An ID for the dataset that you want to create. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
:name (required, String) —
The display name for the dataset.
:physical_table_map (required, Hash<String,Types::PhysicalTable>) —
Declares the physical tables that are available in the underlying data sources.
:logical_table_map (Hash<String,Types::LogicalTable>) —
Configures the combination and transformation of the data from the physical tables. This parameter is used with the legacy data preparation experience.
:import_mode (required, String) —
Indicates whether you want to import the data into SPICE.
:column_groups (Array<Types::ColumnGroup>) —
Groupings of columns that work together in certain Amazon Quick Sight features. Currently, only geospatial hierarchy is supported.
:field_folders (Hash<String,Types::FieldFolder>) —
The folder that contains fields and nested subfolders for your dataset.
:permissions (Array<Types::ResourcePermission>) —
A list of resource permissions on the dataset.
:row_level_permission_data_set (Types::RowLevelPermissionDataSet) —
The row-level security configuration for the data that you want to create. This parameter is used with the legacy data preparation experience.
:row_level_permission_tag_configuration (Types::RowLevelPermissionTagConfiguration) —
The configuration of tags on a dataset to set row-level security. Row-level security tags are currently supported for anonymous embedding only. This parameter is used with the legacy data preparation experience.
:column_level_permission_rules (Array<Types::ColumnLevelPermissionRule>) —
A set of one or more definitions of a ColumnLevelPermissionRule.
:tags (Array<Types::Tag>) —
Contains a map of the key-value pairs for the resource tag or tags assigned to the dataset.
:data_set_usage_configuration (Types::DataSetUsageConfiguration) —
The usage configuration to apply to child datasets that reference this dataset as a source.
:dataset_parameters (Array<Types::DatasetParameter>) —
The parameter declarations of the dataset.
:folder_arns (Array<String>) —
When you create the dataset, Amazon Quick Sight adds the dataset to these folders.
:performance_configuration (Types::PerformanceConfiguration) —
The configuration for the performance optimization of the dataset that contains a UniqueKey configuration.
:use_as (String) —
The usage of the dataset. RLS_RULES must be specified for RLS permission datasets.
:data_prep_configuration (Types::DataPrepConfiguration) —
The data preparation configuration for the dataset. This configuration defines the source tables, transformation steps, and destination tables used to prepare the data. Required when using the new data preparation experience.
:semantic_model_configuration (Types::SemanticModelConfiguration) —
The semantic model configuration for the dataset. This configuration defines how the prepared data is structured for an analysis, including table mappings and row-level security configurations. Required when using the new data preparation experience.

Returns:

(Types::CreateDataSetResponse) —
Returns a response object which responds to the following methods:
- #arn => String
- #data_set_id => String
- #ingestion_arn => String
- #ingestion_id => String
- #request_id => String
- #status => Integer

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 3796

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

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

Creates a data source.

Examples:

Request syntax with placeholder values


resp = client.create_data_source({
  aws_account_id: "AwsAccountId", # required
  data_source_id: "ResourceId", # required
  name: "ResourceName", # required
  type: "ADOBE_ANALYTICS", # required, accepts ADOBE_ANALYTICS, AMAZON_ELASTICSEARCH, ATHENA, AURORA, AURORA_POSTGRESQL, AWS_IOT_ANALYTICS, GITHUB, JIRA, MARIADB, MYSQL, ORACLE, POSTGRESQL, PRESTO, REDSHIFT, S3, S3_TABLES, SALESFORCE, SERVICENOW, SNOWFLAKE, SPARK, SQLSERVER, TERADATA, TWITTER, TIMESTREAM, AMAZON_OPENSEARCH, EXASOL, DATABRICKS, STARBURST, TRINO, BIGQUERY, GOOGLESHEETS, GOOGLE_DRIVE, CONFLUENCE, SHAREPOINT, ONE_DRIVE, WEB_CRAWLER, S3_KNOWLEDGE_BASE, QBUSINESS
  data_source_parameters: {
    amazon_elasticsearch_parameters: {
      domain: "Domain", # required
    },
    athena_parameters: {
      work_group: "WorkGroup",
      role_arn: "RoleArn",
      consumer_account_role_arn: "RoleArn",
      identity_center_configuration: {
        enable_identity_propagation: false,
      },
    },
    aurora_parameters: {
      host: "Host", # required
      port: 1, # required
      database: "Database", # required
    },
    aurora_postgre_sql_parameters: {
      host: "Host", # required
      port: 1, # required
      database: "Database", # required
    },
    aws_iot_analytics_parameters: {
      data_set_name: "DataSetName", # required
    },
    jira_parameters: {
      site_base_url: "SiteBaseUrl", # required
    },
    maria_db_parameters: {
      host: "Host", # required
      port: 1, # required
      database: "Database", # required
    },
    my_sql_parameters: {
      host: "Host", # required
      port: 1, # required
      database: "Database", # required
    },
    oracle_parameters: {
      host: "Host", # required
      port: 1, # required
      database: "Database", # required
      use_service_name: false,
    },
    postgre_sql_parameters: {
      host: "Host", # required
      port: 1, # required
      database: "Database", # required
    },
    presto_parameters: {
      host: "Host", # required
      port: 1, # required
      catalog: "Catalog", # required
    },
    rds_parameters: {
      instance_id: "InstanceId", # required
      database: "Database", # required
    },
    redshift_parameters: {
      host: "Host",
      port: 1,
      database: "Database", # required
      cluster_id: "ClusterId",
      iam_parameters: {
        role_arn: "RoleArn", # required
        database_user: "DatabaseUser",
        database_groups: ["DatabaseGroup"],
        auto_create_database_user: false,
      },
      identity_center_configuration: {
        enable_identity_propagation: false,
      },
    },
    s3_parameters: {
      manifest_file_location: { # required
        bucket: "S3Bucket", # required
        key: "S3Key", # required
      },
      role_arn: "RoleArn",
    },
    s3_tables_parameters: {
      table_bucket_arn: "S3TableBucketArn",
    },
    s3_knowledge_base_parameters: {
      role_arn: "RoleArn",
      bucket_url: "S3Bucket", # required
      metadata_files_location: "MetadataFilesLocation",
    },
    service_now_parameters: {
      site_base_url: "SiteBaseUrl", # required
    },
    snowflake_parameters: {
      host: "Host", # required
      database: "Database", # required
      warehouse: "Warehouse", # required
      authentication_type: "PASSWORD", # accepts PASSWORD, KEYPAIR, TOKEN, X509
      database_access_control_role: "DatabaseAccessControlRole",
      o_auth_parameters: {
        token_provider_url: "TokenProviderUrl", # required
        o_auth_scope: "OAuthScope",
        identity_provider_vpc_connection_properties: {
          vpc_connection_arn: "Arn", # required
        },
        identity_provider_resource_uri: "IdentityProviderResourceUri",
        identity_provider_ca_certificates_bundle_s3_uri: "CACertificatesBundleS3Uri",
      },
    },
    spark_parameters: {
      host: "Host", # required
      port: 1, # required
    },
    sql_server_parameters: {
      host: "Host", # required
      port: 1, # required
      database: "Database", # required
    },
    teradata_parameters: {
      host: "Host", # required
      port: 1, # required
      database: "Database", # required
    },
    twitter_parameters: {
      query: "Query", # required
      max_rows: 1, # required
    },
    amazon_open_search_parameters: {
      domain: "Domain", # required
    },
    exasol_parameters: {
      host: "Host", # required
      port: 1, # required
    },
    databricks_parameters: {
      host: "Host", # required
      port: 1, # required
      sql_endpoint_path: "SqlEndpointPath", # required
    },
    starburst_parameters: {
      host: "Host", # required
      port: 1, # required
      catalog: "Catalog", # required
      product_type: "GALAXY", # accepts GALAXY, ENTERPRISE
      database_access_control_role: "DatabaseAccessControlRole",
      authentication_type: "PASSWORD", # accepts PASSWORD, KEYPAIR, TOKEN, X509
      o_auth_parameters: {
        token_provider_url: "TokenProviderUrl", # required
        o_auth_scope: "OAuthScope",
        identity_provider_vpc_connection_properties: {
          vpc_connection_arn: "Arn", # required
        },
        identity_provider_resource_uri: "IdentityProviderResourceUri",
        identity_provider_ca_certificates_bundle_s3_uri: "CACertificatesBundleS3Uri",
      },
    },
    trino_parameters: {
      host: "Host", # required
      port: 1, # required
      catalog: "Catalog", # required
    },
    big_query_parameters: {
      project_id: "ProjectId", # required
      data_set_region: "DataSetRegion",
    },
    impala_parameters: {
      host: "Host", # required
      port: 1, # required
      database: "Database",
      sql_endpoint_path: "SqlEndpointPath", # required
    },
    custom_connection_parameters: {
      connection_type: "String",
    },
    web_crawler_parameters: {
      web_crawler_auth_type: "NO_AUTH", # required, accepts NO_AUTH, BASIC_AUTH, FORM, SAML
      username_field_xpath: "XpathFields",
      password_field_xpath: "XpathFields",
      username_button_xpath: "XpathFields",
      password_button_xpath: "XpathFields",
      login_page_url: "SiteBaseUrl",
      web_proxy_host_name: "Host",
      web_proxy_port_number: 1,
    },
    confluence_parameters: {
      confluence_url: "SiteBaseUrl", # required
    },
    q_business_parameters: {
      application_arn: "ApplicationArn", # required
    },
    share_point_parameters: {
      share_point_domain: "SharePointDomain", # required
      tenant_id: "SharePointTenantId",
      client_id: "SharePointClientId",
      auth_type: "THREE_LEGGED_OAUTH", # accepts THREE_LEGGED_OAUTH, TWO_LEGGED_OAUTH, SERVICE_ACCOUNT
    },
    google_drive_parameters: {
      auth_type: "THREE_LEGGED_OAUTH", # accepts THREE_LEGGED_OAUTH, TWO_LEGGED_OAUTH, SERVICE_ACCOUNT
    },
    one_drive_parameters: {
      tenant_id: "OneDriveTenantId",
      client_id: "OneDriveClientId",
      auth_type: "THREE_LEGGED_OAUTH", # accepts THREE_LEGGED_OAUTH, TWO_LEGGED_OAUTH, SERVICE_ACCOUNT
    },
    fmkb_parameters: {
      knowledge_base_arn: "FMKBKnowledgeBaseArn", # required
      linked_data_source_ids: ["LinkedDataSourceId"],
    },
  },
  credentials: {
    credential_pair: {
      username: "DbUsername", # required
      password: "Password", # required
      alternate_data_source_parameters: [
        {
          amazon_elasticsearch_parameters: {
            domain: "Domain", # required
          },
          athena_parameters: {
            work_group: "WorkGroup",
            role_arn: "RoleArn",
            consumer_account_role_arn: "RoleArn",
            identity_center_configuration: {
              enable_identity_propagation: false,
            },
          },
          aurora_parameters: {
            host: "Host", # required
            port: 1, # required
            database: "Database", # required
          },
          aurora_postgre_sql_parameters: {
            host: "Host", # required
            port: 1, # required
            database: "Database", # required
          },
          aws_iot_analytics_parameters: {
            data_set_name: "DataSetName", # required
          },
          jira_parameters: {
            site_base_url: "SiteBaseUrl", # required
          },
          maria_db_parameters: {
            host: "Host", # required
            port: 1, # required
            database: "Database", # required
          },
          my_sql_parameters: {
            host: "Host", # required
            port: 1, # required
            database: "Database", # required
          },
          oracle_parameters: {
            host: "Host", # required
            port: 1, # required
            database: "Database", # required
            use_service_name: false,
          },
          postgre_sql_parameters: {
            host: "Host", # required
            port: 1, # required
            database: "Database", # required
          },
          presto_parameters: {
            host: "Host", # required
            port: 1, # required
            catalog: "Catalog", # required
          },
          rds_parameters: {
            instance_id: "InstanceId", # required
            database: "Database", # required
          },
          redshift_parameters: {
            host: "Host",
            port: 1,
            database: "Database", # required
            cluster_id: "ClusterId",
            iam_parameters: {
              role_arn: "RoleArn", # required
              database_user: "DatabaseUser",
              database_groups: ["DatabaseGroup"],
              auto_create_database_user: false,
            },
            identity_center_configuration: {
              enable_identity_propagation: false,
            },
          },
          s3_parameters: {
            manifest_file_location: { # required
              bucket: "S3Bucket", # required
              key: "S3Key", # required
            },
            role_arn: "RoleArn",
          },
          s3_tables_parameters: {
            table_bucket_arn: "S3TableBucketArn",
          },
          s3_knowledge_base_parameters: {
            role_arn: "RoleArn",
            bucket_url: "S3Bucket", # required
            metadata_files_location: "MetadataFilesLocation",
          },
          service_now_parameters: {
            site_base_url: "SiteBaseUrl", # required
          },
          snowflake_parameters: {
            host: "Host", # required
            database: "Database", # required
            warehouse: "Warehouse", # required
            authentication_type: "PASSWORD", # accepts PASSWORD, KEYPAIR, TOKEN, X509
            database_access_control_role: "DatabaseAccessControlRole",
            o_auth_parameters: {
              token_provider_url: "TokenProviderUrl", # required
              o_auth_scope: "OAuthScope",
              identity_provider_vpc_connection_properties: {
                vpc_connection_arn: "Arn", # required
              },
              identity_provider_resource_uri: "IdentityProviderResourceUri",
              identity_provider_ca_certificates_bundle_s3_uri: "CACertificatesBundleS3Uri",
            },
          },
          spark_parameters: {
            host: "Host", # required
            port: 1, # required
          },
          sql_server_parameters: {
            host: "Host", # required
            port: 1, # required
            database: "Database", # required
          },
          teradata_parameters: {
            host: "Host", # required
            port: 1, # required
            database: "Database", # required
          },
          twitter_parameters: {
            query: "Query", # required
            max_rows: 1, # required
          },
          amazon_open_search_parameters: {
            domain: "Domain", # required
          },
          exasol_parameters: {
            host: "Host", # required
            port: 1, # required
          },
          databricks_parameters: {
            host: "Host", # required
            port: 1, # required
            sql_endpoint_path: "SqlEndpointPath", # required
          },
          starburst_parameters: {
            host: "Host", # required
            port: 1, # required
            catalog: "Catalog", # required
            product_type: "GALAXY", # accepts GALAXY, ENTERPRISE
            database_access_control_role: "DatabaseAccessControlRole",
            authentication_type: "PASSWORD", # accepts PASSWORD, KEYPAIR, TOKEN, X509
            o_auth_parameters: {
              token_provider_url: "TokenProviderUrl", # required
              o_auth_scope: "OAuthScope",
              identity_provider_vpc_connection_properties: {
                vpc_connection_arn: "Arn", # required
              },
              identity_provider_resource_uri: "IdentityProviderResourceUri",
              identity_provider_ca_certificates_bundle_s3_uri: "CACertificatesBundleS3Uri",
            },
          },
          trino_parameters: {
            host: "Host", # required
            port: 1, # required
            catalog: "Catalog", # required
          },
          big_query_parameters: {
            project_id: "ProjectId", # required
            data_set_region: "DataSetRegion",
          },
          impala_parameters: {
            host: "Host", # required
            port: 1, # required
            database: "Database",
            sql_endpoint_path: "SqlEndpointPath", # required
          },
          custom_connection_parameters: {
            connection_type: "String",
          },
          web_crawler_parameters: {
            web_crawler_auth_type: "NO_AUTH", # required, accepts NO_AUTH, BASIC_AUTH, FORM, SAML
            username_field_xpath: "XpathFields",
            password_field_xpath: "XpathFields",
            username_button_xpath: "XpathFields",
            password_button_xpath: "XpathFields",
            login_page_url: "SiteBaseUrl",
            web_proxy_host_name: "Host",
            web_proxy_port_number: 1,
          },
          confluence_parameters: {
            confluence_url: "SiteBaseUrl", # required
          },
          q_business_parameters: {
            application_arn: "ApplicationArn", # required
          },
          share_point_parameters: {
            share_point_domain: "SharePointDomain", # required
            tenant_id: "SharePointTenantId",
            client_id: "SharePointClientId",
            auth_type: "THREE_LEGGED_OAUTH", # accepts THREE_LEGGED_OAUTH, TWO_LEGGED_OAUTH, SERVICE_ACCOUNT
          },
          google_drive_parameters: {
            auth_type: "THREE_LEGGED_OAUTH", # accepts THREE_LEGGED_OAUTH, TWO_LEGGED_OAUTH, SERVICE_ACCOUNT
          },
          one_drive_parameters: {
            tenant_id: "OneDriveTenantId",
            client_id: "OneDriveClientId",
            auth_type: "THREE_LEGGED_OAUTH", # accepts THREE_LEGGED_OAUTH, TWO_LEGGED_OAUTH, SERVICE_ACCOUNT
          },
          fmkb_parameters: {
            knowledge_base_arn: "FMKBKnowledgeBaseArn", # required
            linked_data_source_ids: ["LinkedDataSourceId"],
          },
        },
      ],
    },
    copy_source_arn: "CopySourceArn",
    secret_arn: "SecretArn",
    key_pair_credentials: {
      key_pair_username: "DbUsername", # required
      private_key: "PrivateKey", # required
      private_key_passphrase: "PrivateKeyPassphrase",
    },
    web_proxy_credentials: {
      web_proxy_username: "DbUsername", # required
      web_proxy_password: "Password", # required
    },
    o_auth_client_credentials: {
      client_id: "OAuthClientId",
      client_secret: "OAuthClientSecret",
      username: "OAuthUsername",
    },
  },
  permissions: [
    {
      principal: "Principal", # required
      actions: ["String"], # required
    },
  ],
  vpc_connection_properties: {
    vpc_connection_arn: "Arn", # required
  },
  ssl_properties: {
    disable_ssl: false,
  },
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
  folder_arns: ["Arn"],
})

Response structure


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

Parameters:

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

Options Hash (params):

:aws_account_id (required, String) —
The Amazon Web Services account ID.
:data_source_id (required, String) —
An ID for the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
:name (required, String) —
A display name for the data source.
:type (required, String) —
The type of the data source. To return a list of all data sources, use ListDataSources.

Use AMAZON_ELASTICSEARCH for Amazon OpenSearch Service.
:data_source_parameters (Types::DataSourceParameters) —
The parameters that Amazon Quick Sight uses to connect to your underlying source.
:credentials (Types::DataSourceCredentials) —
The credentials Amazon Quick Sight that uses to connect to your underlying source. Currently, only credentials based on user name and password are supported.
:permissions (Array<Types::ResourcePermission>) —
A list of resource permissions on the data source.
:vpc_connection_properties (Types::VpcConnectionProperties) —
Use this parameter only when you want Amazon Quick Sight to use a VPC connection when connecting to your underlying source.
:ssl_properties (Types::SslProperties) —
Secure Socket Layer (SSL) properties that apply when Amazon Quick Sight connects to your underlying source.
:tags (Array<Types::Tag>) —
Contains a map of the key-value pairs for the resource tag or tags assigned to the data source.
:folder_arns (Array<String>) —
When you create the data source, Amazon Quick Sight adds the data source to these folders.

Returns:

(Types::CreateDataSourceResponse) —
Returns a response object which responds to the following methods:
- #arn => String
- #data_source_id => String
- #creation_status => String
- #request_id => String
- #status => Integer

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 4333

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

#create_dlp_setting(params = {}) ⇒ `Types::CreateDlpSettingResponse`

Creates a data loss prevention (DLP) setting configuration for an Amazon Web Services account. A DLP setting defines the DLP provider, the enforcement behavior, and the Quick capabilities that the setting applies to.

Examples:

Request syntax with placeholder values


resp = client.create_dlp_setting({
  aws_account_id: "AwsAccountId", # required
  dlp_setting_id: "DlpSettingId", # required
  name: "DlpSettingName", # required
  provider_type: "MICROSOFT_PURVIEW", # required, accepts MICROSOFT_PURVIEW
  provider_config: { # required
    microsoft_purview: {
      credentials: { # required
        secret_arn: "SecretManagerArn", # required
      },
      label_action_mappings: [ # required
        {
          label_id: "LabelId", # required
          label_name: "LabelName", # required
          action: "ALLOW", # required, accepts ALLOW, WARN, BLOCK
        },
      ],
      unmapped_action: "ALLOW", # required, accepts ALLOW, WARN, BLOCK
    },
  },
  provider_outage_action: "ALLOW", # required, accepts ALLOW, WARN, BLOCK
  enabled: false, # required
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
})

Response structure


resp.arn #=> String
resp.dlp_setting_id #=> String
resp.request_id #=> String

Parameters:

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

Options Hash (params):

:aws_account_id (required, String) —
The ID of the Amazon Web Services account in which to create the DLP setting.
:dlp_setting_id (required, String) —
A unique identifier for the DLP setting.
:name (required, String) —
A human-readable display name for the DLP setting.
:provider_type (required, String) —
The type of external DLP provider to use for sensitivity label classification. Currently, the only supported value is MICROSOFT_PURVIEW.
:provider_config (required, Types::ProviderConfig) —
The provider-specific configuration for the DLP integration. This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
:provider_outage_action (required, String) —
The behavior to apply when the DLP provider is unreachable. Valid values are ALLOW, WARN, and BLOCK.
:enabled (required, Boolean) —
Specifies whether DLP enforcement is active for this setting. Set to true to enable enforcement, or false to disable it at time of setting creation.
:tags (Array<Types::Tag>) —
A list of resource tags to apply to the DLP setting. You can use tags to manage access to your Amazon Web Services resources.

Returns:

(Types::CreateDlpSettingResponse) —
Returns a response object which responds to the following methods:
- #arn => String
- #dlp_setting_id => String
- #request_id => String

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 4424

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

#create_flow(params = {}) ⇒ `Types::CreateFlowResponse`

Creates a new flow in the specified Amazon Web Services account. Creates both a DRAFT and PUBLISHED (auto-published) version.

This operation is idempotent. Supply a ClientToken to safely retry without creating duplicate resources.

Examples:

Request syntax with placeholder values


resp = client.create_flow({
  aws_account_id: "AccountId", # required
  name: "TitleInput", # required
  description: "FlowDescriptionInput",
  flow_definition: { # required
  },
  permissions: [
    {
      actions: ["ActionsListMemberString"], # required
      principal: "PermissionPrincipalString", # required
    },
  ],
  client_token: "CreateFlowRequestClientTokenString",
})

Response structure


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

Parameters:

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

Options Hash (params):

:aws_account_id (required, String) —
The ID of the Amazon Web Services account where you want to create the flow.
:name (required, String) —
The display name for the flow.
:description (String) —
The description for the flow.
:flow_definition (required, Hash, Array, String, Numeric, Boolean) —
The definition of the flow, specifying the steps and configurations. This is the flow definition in Quick Flow's internal format. The format is subject to change.

Always derive or depend on the flow definition from the DescribeFlow operation to ensure you are working with the latest format.

Document type used to carry open content (Hash,Array,String,Numeric,Boolean). A document type value is serialized using the same format as its surroundings and requires no additional encoding or escaping.
:permissions (Array<Types::Permission>) —
Initial permissions for the flow. If omitted, the flow is created without any permissions.
:client_token (String) —
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

A suitable default value is auto-generated. You should normally not need to pass this option.**

Returns:

(Types::CreateFlowResponse) —
Returns a response object which responds to the following methods:
- #arn => String
- #flow_id => String
- #request_id => String
- #status => Integer

See Also:

AWS API Documentation

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

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

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

Creates an empty shared folder.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

Options Hash (params):

:aws_account_id (required, String) —
The ID for the Amazon Web Services account where you want to create the folder.
:folder_id (required, String) —
The ID of the folder.
:name (String) —
The name of the folder.
:folder_type (String) —
The type of folder. By default, folderType is SHARED.
:parent_folder_arn (String) —
The Amazon Resource Name (ARN) for the parent folder.

ParentFolderArn can be null. An empty parentFolderArn creates a root-level folder.
:permissions (Array<Types::ResourcePermission>) —
A structure that describes the principals and the resource-level permissions of a folder.

To specify no permissions, omit Permissions.
:tags (Array<Types::Tag>) —
Tags for the folder.
:sharing_model (String) —
An optional parameter that determines the sharing scope of the folder. The default value for this parameter is ACCOUNT.

Returns:

(Types::CreateFolderResponse) —
Returns a response object which responds to the following methods:
- #status => Integer
- #arn => String
- #folder_id => String
- #request_id => String

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 4586

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

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

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

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

Options Hash (params):

:aws_account_id (required, String) —
The ID for the Amazon Web Services account that contains the folder.
:folder_id (required, String) —
The ID of the folder.
:member_id (required, String) —
The ID of the asset that you want to add to the folder.
:member_type (required, String) —
The member type of the asset that you want to add to a folder.

Returns:

(Types::CreateFolderMembershipResponse) —
Returns a response object which responds to the following methods:
- #status => Integer
- #folder_member => Types::FolderMember
- #request_id => String

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 4632

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

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

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

The permissions resource is arn:aws:quicksight:<your-region>:<relevant-aws-account-id>:group/default/<group-name>.

The response is a group object.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

Options Hash (params):

:group_name (required, String) —
A name for the group that you want to create.
:description (String) —
A description for the group that you want to create.
:aws_account_id (required, String) —
The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon Quick Sight account.
:namespace (required, String) —
The namespace that you want the group to be a part of.

Returns:

(Types::CreateGroupResponse) —
Returns a response object which responds to the following methods:
- #group => Types::Group
- #request_id => String
- #status => Integer

See Also:

AWS API Documentation

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

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

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

Adds an Amazon Quick Sight user to an Amazon Quick Sight group.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

Options Hash (params):

:member_name (required, String) —
The name of the user that you want to add to the group membership.
:group_name (required, String) —
The name of the group that you want to add the user to.
:aws_account_id (required, String) —
The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon Quick Sight account.
:namespace (required, String) —
The namespace that you want the user to be a part of.

Returns:

(Types::CreateGroupMembershipResponse) —
Returns a response object which responds to the following methods:
- #group_member => Types::GroupMember
- #request_id => String
- #status => Integer

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 4737

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

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

Creates an assignment with one specified IAM policy, identified by its Amazon Resource Name (ARN). This policy assignment is attached to the specified groups or users of Amazon Quick Sight. Assignment names are unique per Amazon Web Services account. To avoid overwriting rules in other namespaces, use assignment names that are unique.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

Options Hash (params):

:aws_account_id (required, String) —
The ID of the Amazon Web Services account where you want to assign an IAM policy to Amazon Quick Sight users or groups.
:assignment_name (required, String) —
The name of the assignment, also called a rule. The name must be unique within the Amazon Web Services account.
:assignment_status (required, String) —
The status of the assignment. Possible values are as follows:
- ENABLED - Anything specified in this assignment is used when creating the data source.
- DISABLED - This assignment isn't used when creating the data source.
- DRAFT - This assignment is an unfinished draft and isn't used when creating the data source.
:policy_arn (String) —
The ARN for the IAM policy to apply to the Amazon Quick Sight users and groups specified in this assignment.
:identities (Hash<String,Array>) —
The Amazon Quick Sight users, groups, or both that you want to assign the policy to.
:namespace (required, String) —
The namespace that contains the assignment.

Returns:

(Types::CreateIAMPolicyAssignmentResponse) —
Returns a response object which responds to the following methods:
- #assignment_name => String
- #assignment_id => String
- #assignment_status => String
- #policy_arn => String
- #identities => Hash<String,Array<String>>
- #request_id => String
- #status => Integer

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 4818

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

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

Creates and starts a new SPICE ingestion for a dataset. You can manually refresh datasets in an Enterprise edition account 32 times in a 24-hour period. You can manually refresh datasets in a Standard edition account 8 times in a 24-hour period. Each 24-hour period is measured starting 24 hours before the current date and time.

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

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

Options Hash (params):

:data_set_id (required, String) —
The ID of the dataset used in the ingestion.
:ingestion_id (required, String) —
An ID for the ingestion.
:aws_account_id (required, String) —
The Amazon Web Services account ID.
:ingestion_type (String) —
The type of ingestion that you want to create.

Returns:

(Types::CreateIngestionResponse) —
Returns a response object which responds to the following methods:
- #arn => String
- #ingestion_id => String
- #ingestion_status => String
- #request_id => String
- #status => Integer

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 4880

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

#create_knowledge_base(params = {}) ⇒ `Types::CreateKnowledgeBaseResponse`

Creates a knowledge base from a specified data source. Supported data source connector types include:

S3_KNOWLEDGE_BASE – Uses an Amazon S3 bucket as the data source.
WEB_CRAWLER – Uses web pages indexed by the built-in web crawler as the data source.
GOOGLE_DRIVE – Uses Google Drive as the data source. Supports service account authentication only.
SHAREPOINT – Uses SharePoint as the data source. Supports two-legged OAuth only.
ONE_DRIVE – Uses OneDrive as the data source. Supports two-legged OAuth only.

Examples:

Request syntax with placeholder values


resp = client.create_knowledge_base({
  aws_account_id: "KbAwsAccountId", # required
  knowledge_base_id: "KnowledgeBaseId", # required
  name: "KnowledgeBaseName", # required
  data_source_arn: "DataSourceArn", # required
  knowledge_base_configuration: { # required
    template_configuration: {
      template: {
      },
    },
  },
  description: "KnowledgeBaseDescription",
  permissions: [
    {
      principal: "Principal", # required
      actions: ["String"], # required
    },
  ],
  media_extraction_configuration: {
    image_extraction_configuration: {
      image_extraction_status: "ENABLED", # required, accepts ENABLED, DISABLED
    },
    audio_extraction_configuration: {
      audio_extraction_status: "ENABLED", # required, accepts ENABLED, DISABLED
    },
    video_extraction_configuration: {
      video_extraction_status: "ENABLED", # required, accepts ENABLED, DISABLED
      video_extraction_type: "AUDIO_TRANSCRIPTION_ONLY", # accepts AUDIO_TRANSCRIPTION_ONLY, VISUAL_CONTENT_AND_AUDIO_TRANSCRIPTION
    },
  },
  access_control_configuration: {
    is_acl_enabled: false,
  },
  primary_owner_arn: "String",
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
})

Response structure


resp.knowledge_base_arn #=> String
resp.knowledge_base_id #=> String
resp.creation_status #=> String, one of "CREATING", "UPDATING", "ACTIVE", "FAILED", "DELETING"
resp.request_id #=> String
resp.status #=> Integer

Parameters:

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

Options Hash (params):

:aws_account_id (required, String) —
The ID of the Amazon Web Services account that contains the knowledge base.
:knowledge_base_id (required, String) —
The unique identifier for the knowledge base.
:name (required, String) —
The name of the knowledge base.
:data_source_arn (required, String) —
The Amazon Resource Name (ARN) of the data source for the knowledge base.
:knowledge_base_configuration (required, Types::KnowledgeBaseConfiguration) —
The configuration settings for a knowledge base.
:description (String) —
A description for the knowledge base. If you don't specify a description, the knowledge base is created without one.
:permissions (Array<Types::ResourcePermission>) —
A list of resource permissions on the knowledge base. Each entry grants a specified Amazon QuickSight principal either owner or viewer access. If you don't specify permissions, only the primary owner (if provided) receives owner access.
:media_extraction_configuration (Types::MediaExtractionConfiguration) —
The configuration for media extraction from knowledge base documents.
:access_control_configuration (Types::AccessControlConfiguration) —
The access control configuration for the knowledge base. If you don't specify this parameter, document-level ACLs are disabled.
:primary_owner_arn (String) —
The Amazon Resource Name (ARN) of the primary owner for the knowledge base. The specified user is always granted owner access, regardless of what is specified in the Permissions field. If you don't specify a primary owner, the knowledge base is created without one.
:tags (Array<Types::Tag>) —
The tags to assign to the knowledge base. If you don't specify tags, the knowledge base is created without tags.

Returns:

(Types::CreateKnowledgeBaseResponse) —
Returns a response object which responds to the following methods:
- #knowledge_base_arn => String
- #knowledge_base_id => String
- #creation_status => String
- #request_id => String
- #status => Integer

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 5010

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

#create_limits_profile(params = {}) ⇒ `Types::CreateLimitsProfileResponse`

Creates a limits profile that defines resource usage limits for Amazon Quick Sight users.

Examples:

Request syntax with placeholder values


resp = client.create_limits_profile({
  account_id: "AwsAccountId", # required
  profile_name: "ProfileName", # required
  description: "ProfileDescription",
  resource_limits: { # required
    "INDEX_STORAGE" => {
      max_value: 1, # required
      unit: "MB", # required, accepts MB, GB, HOURS, DAYS
    },
  },
  client_token: "CreateLimitsProfileRequestClientTokenString", # required
})

Response structure


resp.arn #=> String
resp.profile_id #=> String

Parameters:

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

Options Hash (params):

:account_id (required, String) —
The ID of the Amazon Web Services account that contains the limits profile.
:profile_name (required, String) —
A display name for the limits profile.
:description (String) —
A description for the limits profile.
:resource_limits (required, Hash<String,Types::ProfileLimitValue>) —
A map of resource types to their limit values for this profile.
:client_token (required, String) —
A unique, case-sensitive identifier to ensure that the operation completes no more than one time. If this token matches a previous request, the service ignores the request, but does not return an error.

Returns:

(Types::CreateLimitsProfileResponse) —
Returns a response object which responds to the following methods:
- #arn => String
- #profile_id => String

See Also:

AWS API Documentation

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

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

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

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

A namespace allows you to isolate the Quick Sight users and groups that are registered for that namespace. Users that access the namespace can share assets only with other users or groups in the same namespace. They can't see users and groups in other namespaces. You can create a namespace after your Amazon Web Services account is subscribed to Quick Sight. The namespace must be unique within the Amazon Web Services account. By default, there is a limit of 100 namespaces per Amazon Web Services account. To increase your limit, create a ticket with Amazon Web Services Support.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

Options Hash (params):

:aws_account_id (required, String) —
The ID for the Amazon Web Services account that you want to create the Quick Sight namespace in.
:namespace (required, String) —
The name that you want to use to describe the new namespace.
:identity_store (required, String) —
Specifies the type of your user identity directory. Currently, this supports users with an identity type of QUICKSIGHT.
:tags (Array<Types::Tag>) —
The tags that you want to associate with the namespace that you're creating.

Returns:

(Types::CreateNamespaceResponse) —
Returns a response object which responds to the following methods:
- #arn => String
- #name => String
- #capacity_region => String
- #creation_status => String
- #identity_store => String
- #request_id => String
- #status => Integer

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 5137

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

#create_o_auth_client_application(params = {}) ⇒ `Types::CreateOAuthClientApplicationResponse`

Creates an OAuthClientApplication.

Examples:

Request syntax with placeholder values


resp = client.create_o_auth_client_application({
  aws_account_id: "AwsAccountId", # required
  o_auth_client_application_id: "OAuthClientApplicationId", # required
  name: "ResourceName", # required
  o_auth_client_authentication_type: "TOKEN", # required, accepts TOKEN
  client_id: "OAuthClientId", # required
  client_secret: "OAuthClientSecret", # required
  o_auth_token_endpoint_url: "OAuthTokenEndpointUrl", # required
  o_auth_authorization_endpoint_url: "OAuthAuthorizationEndpointUrl",
  o_auth_scopes: "OAuthScopesString",
  data_source_type: "ADOBE_ANALYTICS", # accepts ADOBE_ANALYTICS, AMAZON_ELASTICSEARCH, ATHENA, AURORA, AURORA_POSTGRESQL, AWS_IOT_ANALYTICS, GITHUB, JIRA, MARIADB, MYSQL, ORACLE, POSTGRESQL, PRESTO, REDSHIFT, S3, S3_TABLES, SALESFORCE, SERVICENOW, SNOWFLAKE, SPARK, SQLSERVER, TERADATA, TWITTER, TIMESTREAM, AMAZON_OPENSEARCH, EXASOL, DATABRICKS, STARBURST, TRINO, BIGQUERY, GOOGLESHEETS, GOOGLE_DRIVE, CONFLUENCE, SHAREPOINT, ONE_DRIVE, WEB_CRAWLER, S3_KNOWLEDGE_BASE, QBUSINESS
  identity_provider_vpc_connection_properties: {
    vpc_connection_arn: "Arn", # required
  },
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
})

Response structure


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

Parameters:

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

Options Hash (params):

:aws_account_id (required, String) —
The Amazon Web Services account ID.
:o_auth_client_application_id (required, String) —
An ID for the OAuthClientApplication that you want to create. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
:name (required, String) —
The display name for the OAuthClientApplication.
:o_auth_client_authentication_type (required, String) —
The authentication type to use for the OAuthClientApplication. This determines the OAuth 2.0 grant flow that is used when the data source connects to the identity provider. Valid values are TOKEN.
:client_id (required, String) —
The client ID of the OAuth application that is registered with the identity provider.
:client_secret (required, String) —
The client secret of the OAuth application that is registered with the identity provider.
:o_auth_token_endpoint_url (required, String) —
The token endpoint URL of the identity provider that is used to obtain access tokens.
:o_auth_authorization_endpoint_url (String) —
The authorization endpoint URL of the identity provider that is used to obtain authorization codes.
:o_auth_scopes (String) —
The OAuth scopes that are requested when the OAuthClientApplication obtains an access token from the identity provider.
:data_source_type (String) —
The type of data source that the OAuthClientApplication is used with. Valid values are SNOWFLAKE.
:identity_provider_vpc_connection_properties (Types::VpcConnectionProperties) —
VPC connection properties.
:tags (Array<Types::Tag>) —
Contains a map of the key-value pairs for the resource tag or tags assigned to the OAuthClientApplication.

Returns:

(Types::CreateOAuthClientApplicationResponse) —
Returns a response object which responds to the following methods:
- #arn => String
- #o_auth_client_application_id => String
- #creation_status => String
- #request_id => String
- #status => Integer

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 5235

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

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

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

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

Options Hash (params):

:data_set_id (required, String) —
The ID of the dataset.
:aws_account_id (required, String) —
The Amazon Web Services account ID.
:schedule (required, Types::RefreshSchedule) —
The refresh schedule.

Returns:

(Types::CreateRefreshScheduleResponse) —
Returns a response object which responds to the following methods:
- #status => Integer
- #request_id => String
- #schedule_id => String
- #arn => String

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 5292

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

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

Use CreateRoleMembership to add an existing Quick Sight group to an existing role.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

Options Hash (params):

:member_name (required, String) —
The name of the group that you want to add to the role.
:aws_account_id (required, String) —
The ID for the Amazon Web Services account that you want to create a group in. The Amazon Web Services account ID that you provide must be the same Amazon Web Services account that contains your Amazon Quick Sight account.
:namespace (required, String) —
The namespace that the role belongs to.
:role (required, String) —
The role that you want to add a group to.

Returns:

(Types::CreateRoleMembershipResponse) —
Returns a response object which responds to the following methods:
- #request_id => String
- #status => Integer

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 5338

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

#create_space(params = {}) ⇒ `Types::CreateSpaceResponse`

Creates a new Amazon QuickSight space. A space is a collection of resources that can be used to organize and manage QuickSight assets.

Examples:

Request syntax with placeholder values


resp = client.create_space({
  aws_account_id: "AwsAccountId", # required
  space_id: "PublicSpaceId", # required
  name: "SpaceName", # required
  description: "SpaceDescription",
})

Response structure


resp.space_id #=> String
resp.space_arn #=> String
resp.request_id #=> String

Parameters:

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

Options Hash (params):

:aws_account_id (required, String) —
The ID of the Amazon Web Services account that contains the space.
:space_id (required, String) —
The ID of the space. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
:name (required, String) —
A display name for the space.
:description (String) —
A description of the space.

Returns:

(Types::CreateSpaceResponse) —
Returns a response object which responds to the following methods:
- #space_id => String
- #space_arn => String
- #request_id => String

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 5384

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

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

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

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

Examples:

Response structure


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

Parameters:

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

Options Hash (params):

:aws_account_id (required, String) —
The ID for the Amazon Web Services account that the group is in. You use the ID for the Amazon Web Services account that contains your Amazon Quick Sight account.
:template_id (required, String) —
An ID for the template that you want to create. This template is unique per Amazon Web Services Region; in each Amazon Web Services account.
:name (String) —
A display name for the template.
:permissions (Array<Types::ResourcePermission>) —
A list of resource permissions to be set on the template.
:source_entity (Types::TemplateSourceEntity) —
The entity that you are using as a source when you create the template. In SourceEntity, you specify the type of object you're using as source: SourceTemplate for a template or SourceAnalysis for an analysis. Both of these require an Amazon Resource Name (ARN). For SourceTemplate, specify the ARN of the source template. For SourceAnalysis, specify the ARN of the source analysis. The SourceTemplate ARN can contain any Amazon Web Services account and any Quick Sight-supported Amazon Web Services Region.

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

Either a SourceEntity or a Definition must be provided in order for the request to be valid.
:tags (Array<Types::Tag>) —
Contains a map of the key-value pairs for the resource tag or tags assigned to the resource.
:version_description (String) —
A description of the current template version being created. This API operation creates the first version of the template. Every time UpdateTemplate is called, a new version is created. Each version of the template maintains a description of the version in the VersionDescription field.
:definition (Types::TemplateVersionDefinition) —
The definition of a template.

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

Either a SourceEntity or a Definition must be provided in order for the request to be valid.
:validation_strategy (Types::ValidationStrategy) —
TThe option to relax the validation needed to create a template with definition objects. This skips the validation step for specific errors.

Returns:

(Types::CreateTemplateResponse) —
Returns a response object which responds to the following methods:
- #arn => String
- #version_arn => String
- #template_id => String
- #creation_status => String
- #status => Integer
- #request_id => String

See Also:

AWS API Documentation

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

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

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

Creates a template alias for a template.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

Options Hash (params):

:aws_account_id (required, String) —
The ID of the Amazon Web Services account that contains the template that you creating an alias for.
:template_id (required, String) —
An ID for the template.
:alias_name (required, String) —
The name that you want to give to the template alias that you're creating. Don't start the alias name with the $ character. Alias names that start with $ are reserved by Quick Sight.
:template_version_number (required, Integer) —
The version number of the template.

Returns:

(Types::CreateTemplateAliasResponse) —
Returns a response object which responds to the following methods:
- #template_alias => Types::TemplateAlias
- #status => Integer
- #request_id => String

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 5533

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

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

Creates a theme.

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

Examples:

Request syntax with placeholder values


resp = client.create_theme({
  aws_account_id: "AwsAccountId", # required
  theme_id: "ShortRestrictiveResourceId", # required
  name: "ThemeName", # required
  base_theme_id: "ShortRestrictiveResourceId", # required
  version_description: "VersionDescription",
  configuration: { # required
    data_color_palette: {
      colors: ["HexColor"],
      min_max_gradient: ["HexColor"],
      empty_fill_color: "HexColor",
    },
    ui_color_palette: {
      primary_foreground: "HexColor",
      primary_background: "HexColor",
      secondary_foreground: "HexColor",
      secondary_background: "HexColor",
      accent: "HexColor",
      accent_foreground: "HexColor",
      danger: "HexColor",
      danger_foreground: "HexColor",
      warning: "HexColor",
      warning_foreground: "HexColor",
      success: "HexColor",
      success_foreground: "HexColor",
      dimension: "HexColor",
      dimension_foreground: "HexColor",
      measure: "HexColor",
      measure_foreground: "HexColor",
    },
    sheet: {
      tile: {
        background_color: "Color",
        border: {
          color: "Color",
          show: false,
          width: "Width",
        },
        border_radius: "BorderRadius",
        padding: "Padding",
      },
      tile_layout: {
        gutter: {
          show: false,
        },
        margin: {
          show: false,
        },
      },
      background: {
        color: "Color",
        gradient: "String",
      },
    },
    typography: {
      font_families: [
        {
          font_family: "LimitedString",
        },
      ],
      axis_title_font_configuration: {
        font_size: {
          relative: "EXTRA_SMALL", # accepts EXTRA_SMALL, SMALL, MEDIUM, LARGE, EXTRA_LARGE
          absolute: "PixelLength",
        },
        font_decoration: "UNDERLINE", # accepts UNDERLINE, NONE
        font_color: "HexColor",
        font_weight: {
          name: "NORMAL", # accepts NORMAL, BOLD
        },
        font_style: "NORMAL", # accepts NORMAL, ITALIC
        font_family: "LimitedString",
      },
      axis_label_font_configuration: {
        font_size: {
          relative: "EXTRA_SMALL", # accepts EXTRA_SMALL, SMALL, MEDIUM, LARGE, EXTRA_LARGE
          absolute: "PixelLength",
        },
        font_decoration: "UNDERLINE", # accepts UNDERLINE, NONE
        font_color: "HexColor",
        font_weight: {
          name: "NORMAL", # accepts NORMAL, BOLD
        },
        font_style: "NORMAL", # accepts NORMAL, ITALIC
        font_family: "LimitedString",
      },
      legend_title_font_configuration: {
        font_size: {
          relative: "EXTRA_SMALL", # accepts EXTRA_SMALL, SMALL, MEDIUM, LARGE, EXTRA_LARGE
          absolute: "PixelLength",
        },
        font_decoration: "UNDERLINE", # accepts UNDERLINE, NONE
        font_color: "HexColor",
        font_weight: {
          name: "NORMAL", # accepts NORMAL, BOLD
        },
        font_style: "NORMAL", # accepts NORMAL, ITALIC
        font_family: "LimitedString",
      },
      legend_value_font_configuration: {
        font_size: {
          relative: "EXTRA_SMALL", # accepts EXTRA_SMALL, SMALL, MEDIUM, LARGE, EXTRA_LARGE
          absolute: "PixelLength",
        },
        font_decoration: "UNDERLINE", # accepts UNDERLINE, NONE
        font_color: "HexColor",
        font_weight: {
          name: "NORMAL", # accepts NORMAL, BOLD
        },
        font_style: "NORMAL", # accepts NORMAL, ITALIC
        font_family: "LimitedString",
      },
      data_label_font_configuration: {
        font_size: {
          relative: "EXTRA_SMALL", # accepts EXTRA_SMALL, SMALL, MEDIUM, LARGE, EXTRA_LARGE
          absolute: "PixelLength",
        },
        font_decoration: "UNDERLINE", # accepts UNDERLINE, NONE
        font_color: "HexColor",
        font_weight: {
          name: "NORMAL", # accepts NORMAL, BOLD
        },
        font_style: "NORMAL", # accepts NORMAL, ITALIC
        font_family: "LimitedString",
      },
      visual_title_font_configuration: {
        font_configuration: {
          font_size: {
            relative: "EXTRA_SMALL", # accepts EXTRA_SMALL, SMALL, MEDIUM, LARGE, EXTRA_LARGE
            absolute: "PixelLength",
          },
          font_decoration: "UNDERLINE", # accepts UNDERLINE, NONE
          font_color: "HexColor",
          font_weight: {
            name: "NORMAL", # accepts NORMAL, BOLD
          },
          font_style: "NORMAL", # accepts NORMAL, ITALIC
          font_family: "LimitedString",
        },
        text_alignment: "LEFT", # accepts LEFT, CENTER, RIGHT, AUTO
        text_transform: "CAPITALIZE", # accepts CAPITALIZE
      },
      visual_subtitle_font_configuration: {
        font_configuration: {
          font_size: {
            relative: "EXTRA_SMALL", # accepts EXTRA_SMALL, SMALL, MEDIUM, LARGE, EXTRA_LARGE
            absolute: "PixelLength",
          },
          font_decoration: "UNDERLINE", # accepts UNDERLINE, NONE
          font_color: "HexColor",
          font_weight: {
            name: "NORMAL", # accepts NORMAL, BOLD
          },
          font_style: "NORMAL", # accepts NORMAL, ITALIC
          font_family: "LimitedString",
        },
        text_alignment: "LEFT", # accepts LEFT, CENTER, RIGHT, AUTO
        text_transform: "CAPITALIZE", # accepts CAPITALIZE
      },
      control_title_font_configuration: {
        font_configuration: {
          font_size: {
            relative: "EXTRA_SMALL", # accepts EXTRA_SMALL, SMALL, MEDIUM, LARGE, EXTRA_LARGE
            absolute: "PixelLength",
          },
          font_decoration: "UNDERLINE", # accepts UNDERLINE, NONE
          font_color: "HexColor",
          font_weight: {
            name: "NORMAL", # accepts NORMAL, BOLD
          },
          font_style: "NORMAL", # accepts NORMAL, ITALIC
          font_family: "LimitedString",
        },
        text_alignment: "LEFT", # accepts LEFT, CENTER, RIGHT, AUTO
      },
    },
  },
  permissions: [
    {
      principal: "Principal", # required
      actions: ["String"], # required
    },
  ],
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
})

Response structure


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

Parameters:

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

Options Hash (params):

:aws_account_id (required, String) —
The ID of the Amazon Web Services account where you want to store the new theme.
:theme_id (required, String) —
An ID for the theme that you want to create. The theme ID is unique per Amazon Web Services Region in each Amazon Web Services account.
:name (required, String) —
A display name for the theme.
:base_theme_id (required, String) —
The ID of the theme that a custom theme will inherit from. All themes inherit from one of the starting themes defined by Amazon Quick Sight. For a list of the starting themes, use ListThemes or choose Themes from within an analysis.
:version_description (String) —
A description of the first version of the theme that you're creating. Every time UpdateTheme is called, a new version is created. Each version of the theme has a description of the version in the VersionDescription field.
:configuration (required, Types::ThemeConfiguration) —
The theme configuration, which contains the theme display properties.
:permissions (Array<Types::ResourcePermission>) —
A valid grouping of resource permissions to apply to the new theme.
:tags (Array<Types::Tag>) —
A map of the key-value pairs for the resource tag or tags that you want to add to the resource.

Returns:

(Types::CreateThemeResponse) —
Returns a response object which responds to the following methods:
- #arn => String
- #version_arn => String
- #theme_id => String
- #creation_status => String
- #status => Integer
- #request_id => String

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 5797

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

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

Creates a theme alias for a theme.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

Options Hash (params):

:aws_account_id (required, String) —
The ID of the Amazon Web Services account that contains the theme for the new theme alias.
:theme_id (required, String) —
An ID for the theme alias.
:alias_name (required, String) —
The name that you want to give to the theme alias that you are creating. The alias name can't begin with a $. Alias names that start with $ are reserved by Amazon Quick Sight.
:theme_version_number (required, Integer) —
The version number of the theme.

Returns:

(Types::CreateThemeAliasResponse) —
Returns a response object which responds to the following methods:
- #theme_alias => Types::ThemeAlias
- #status => Integer
- #request_id => String

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 5846

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

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

Creates a new Q topic.

Examples:

Request syntax with placeholder values


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

Response structure


resp.arn #=> String
resp.topic_id #=> String
resp.refresh_arn #=> String
resp.request_id #=> String
resp.status #=> Integer

Parameters:

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

Options Hash (params):

:aws_account_id (required, String) —
The ID of the Amazon Web Services account that you want to create a topic in.
:topic_id (required, String) —
The ID for the topic that you want to create. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
:topic (required, Types::TopicDetails) —
The definition of a topic to create.
:tags (Array<Types::Tag>) —
Contains a map of the key-value pairs for the resource tag or tags that are assigned to the dataset.
:folder_arns (Array<String>) —
The Folder ARN of the folder that you want the topic to reside in.
:custom_instructions (Types::CustomInstructions) —
Custom instructions for the topic.

Returns:

(Types::CreateTopicResponse) —
Returns a response object which responds to the following methods:
- #arn => String
- #topic_id => String
- #refresh_arn => String
- #request_id => String
- #status => Integer

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 6160

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

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

Creates a topic refresh schedule.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

Options Hash (params):

:aws_account_id (required, String) —
The ID of the Amazon Web Services account that contains the topic you're creating a refresh schedule for.
:topic_id (required, String) —
The ID of the topic that you want to modify. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
:dataset_arn (required, String) —
The Amazon Resource Name (ARN) of the dataset.
:dataset_name (String) —
The name of the dataset.
:refresh_schedule (required, Types::TopicRefreshSchedule) —
The definition of a refresh schedule.

Returns:

(Types::CreateTopicRefreshScheduleResponse) —
Returns a response object which responds to the following methods:
- #topic_id => String
- #topic_arn => String
- #dataset_arn => String
- #status => Integer
- #request_id => String

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 6221

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

#create_topic_v2(params = {}) ⇒ `Types::CreateTopicV2Response`

Creates a new Q topic.

Examples:

Request syntax with placeholder values


resp = client.create_topic_v2({
  aws_account_id: "AwsAccountId", # required
  topic_id: "TopicId", # required
  topic: { # required
    name: "ResourceName", # required
    description: "LimitedString",
    data_sets: [
      {
        data_set_arn: "Arn", # required
        data_set_name: "LimitedString",
      },
    ],
    data_set_relations: [
      {
        left: { # required
          data_set_arn: "Arn", # required
          column_names: ["String"], # required
        },
        right: { # required
          data_set_arn: "Arn", # required
          column_names: ["String"], # required
        },
      },
    ],
  },
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
  folder_arns: ["Arn"],
  custom_instructions: {
    custom_instructions_string: "CustomInstructionsString", # required
  },
})

Response structure


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

Parameters:

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

Options Hash (params):

:aws_account_id (required, String) —
The ID of the Amazon Web Services account that you want to create a topic in.
:topic_id (required, String) —
The ID for the topic that you want to create. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
:topic (required, Types::TopicV2Details) —
The definition of a topic to create.
:tags (Array<Types::Tag>) —
Contains a map of the key-value pairs for the resource tag or tags that are assigned to the topic.
:folder_arns (Array<String>) —
The Amazon Resource Names (ARNs) of the folders that you want the topic to reside in.
:custom_instructions (Types::CustomInstructions) —
Instructions that provide additional guidance and context for response generation.

Returns:

(Types::CreateTopicV2Response) —
Returns a response object which responds to the following methods:
- #arn => String
- #topic_id => String
- #request_id => String
- #status => Integer

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 6308

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

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

Creates a new VPC connection.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

Options Hash (params):

:aws_account_id (required, String) —
The Amazon Web Services account ID of the account where you want to create a new VPC connection.
:vpc_connection_id (required, String) —
The ID of the VPC connection that you're creating. This ID is a unique identifier for each Amazon Web Services Region in an Amazon Web Services account.
:name (required, String) —
The display name for the VPC connection.
:subnet_ids (required, Array<String>) —
A list of subnet IDs for the VPC connection.
:security_group_ids (required, Array<String>) —
A list of security group IDs for the VPC connection.
:dns_resolvers (Array<String>) —
A list of IP addresses of DNS resolver endpoints for the VPC connection.
:role_arn (required, String) —
The IAM role to associate with the VPC connection.
:tags (Array<Types::Tag>) —
A map of the key-value pairs for the resource tag or tags assigned to the VPC connection.

Returns:

(Types::CreateVPCConnectionResponse) —
Returns a response object which responds to the following methods:
- #arn => String
- #vpc_connection_id => String
- #creation_status => String
- #availability_status => String
- #request_id => String
- #status => Integer

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 6384

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

#delete_account_custom_permission(params = {}) ⇒ `Types::DeleteAccountCustomPermissionResponse`

Unapplies a custom permissions profile from an account.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

Options Hash (params):

:aws_account_id (required, String) —
The ID of the Amazon Web Services account from which you want to unapply the custom permissions profile.

Returns:

(Types::DeleteAccountCustomPermissionResponse) —
Returns a response object which responds to the following methods:
- #request_id => String
- #status => Integer

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 6415

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

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

This API permanently deletes all Quick Sight customizations for the specified Amazon Web Services account and namespace. When you delete account customizations:

All customizations are removed including themes, branding, and visual settings
This action cannot be undone through the API
Users will see default Quick Sight styling after customizations are deleted

Before proceeding: Ensure you have backups of any custom themes or branding elements you may want to recreate.

Deletes all Amazon Quick Sight customizations for the specified Amazon Web Services account and Quick Sight namespace.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

Options Hash (params):

:aws_account_id (required, String) —
The ID for the Amazon Web Services account that you want to delete Quick Sight customizations from.
:namespace (String) —
The Quick Sight namespace that you're deleting the customizations from.

Returns:

(Types::DeleteAccountCustomizationResponse) —
Returns a response object which responds to the following methods:
- #request_id => String
- #status => Integer

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 6468

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

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

Deleting your Quick Sight account subscription has permanent, irreversible consequences across all Amazon Web Services regions:

Global deletion – Running this operation from any single region will delete your Quick Sight account and all data in every Amazon Web Services region where you have Quick Sight resources.
Complete data loss – All dashboards, analyses, datasets, data sources, and custom visuals will be permanently deleted across all regions.
Embedded content failure – All embedded dashboards and visuals in your applications will immediately stop working and display errors to end users.
Shared resources removed – All shared dashboards, folders, and resources will become inaccessible to other users and external recipients.
User access terminated – All Quick Sight users in your account will lose access immediately, including authors, readers, and administrators.
No recovery possible – Once deleted, your Quick Sight account and all associated data cannot be restored.

Consider exporting critical dashboards and data before proceeding with account deletion.

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

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

Options Hash (params):

:aws_account_id (required, String) —
The Amazon Web Services account ID of the account that you want to delete.

Returns:

(Types::DeleteAccountSubscriptionResponse) —
Returns a response object which responds to the following methods:
- #request_id => String
- #status => Integer

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 6536

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

#delete_action_connector(params = {}) ⇒ `Types::DeleteActionConnectorResponse`

Hard deletes an action connector, making it unrecoverable. This operation removes the connector and all its associated configurations. Any resources currently using this action connector will no longer be able to perform actions through it.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

Options Hash (params):

:aws_account_id (required, String) —
The Amazon Web Services account ID that contains the action connector to delete.
:action_connector_id (required, String) —
The unique identifier of the action connector to delete.

Returns:

(Types::DeleteActionConnectorResponse) —
Returns a response object which responds to the following methods:
- #arn => String
- #action_connector_id => String
- #request_id => String
- #status => Integer

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 6578

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

#delete_agent(params = {}) ⇒ `Types::DeleteAgentResponse`

Deletes an agent.

Examples:

Request syntax with placeholder values


resp = client.delete_agent({
  agent_id: "String", # required
  aws_account_id: "String", # required
})

Response structure


resp.request_id #=> String

Parameters:

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

Options Hash (params):

:agent_id (required, String) —
The unique identifier for the agent to delete.
:aws_account_id (required, String) —
The ID of the Amazon Web Services account that contains the agent.

Returns:

(Types::DeleteAgentResponse) —
Returns a response object which responds to the following methods:
- #request_id => String

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 6610

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

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

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

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

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

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

Options Hash (params):

:aws_account_id (required, String) —
The ID of the Amazon Web Services account where you want to delete an analysis.
:analysis_id (required, String) —
The ID of the analysis that you're deleting.
:recovery_window_in_days (Integer) —
A value that specifies the number of days that Amazon Quick Sight waits before it deletes the analysis. You can't use this parameter with the ForceDeleteWithoutRecovery option in the same API call. The default value is 30.
:force_delete_without_recovery (Boolean) —
This option defaults to the value NoForceDeleteWithoutRecovery. To immediately delete the analysis, add the ForceDeleteWithoutRecovery option. You can't restore an analysis after it's deleted.

Returns:

(Types::DeleteAnalysisResponse) —
Returns a response object which responds to the following methods:
- #status => Integer
- #arn => String
- #analysis_id => String
- #deletion_time => Time
- #request_id => String

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 6681

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

#delete_approval_policy(params = {}) ⇒ `Struct`

Deletes an approval policy in Quick Sight.

Examples:

Request syntax with placeholder values


resp = client.delete_approval_policy({
  policy_id: "PolicyId", # required
})

Parameters:

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

Options Hash (params):

:policy_id (required, String) —
The unique identifier of the approval policy to delete.

Returns:

(Struct) —
Returns an empty response.

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 6703

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

#delete_brand(params = {}) ⇒ `Types::DeleteBrandResponse`

This API permanently deletes the specified Quick Sight brand. When you delete a brand:

The brand and all its associated branding elements are permanently removed
Any applications or dashboards using this brand will revert to default styling
This action cannot be undone through the API

Before proceeding: Verify that the brand is no longer needed and consider the impact on any applications currently using this brand.

Deletes an Quick Sight brand.

Examples:

Request syntax with placeholder values


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

Response structure


resp.request_id #=> String

Parameters:

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

Options Hash (params):

:aws_account_id (required, String) —
The ID of the Amazon Web Services account that owns the brand.
:brand_id (required, String) —
The ID of the Quick brand.

Returns:

(Types::DeleteBrandResponse) —
Returns a response object which responds to the following methods:
- #request_id => String

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 6749

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

#delete_brand_assignment(params = {}) ⇒ `Types::DeleteBrandAssignmentResponse`

Deletes a brand assignment.

Examples:

Request syntax with placeholder values


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

Response structure


resp.request_id #=> String

Parameters:

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

Options Hash (params):

:aws_account_id (required, String) —
The ID of the Amazon Web Services account that owns the brand assignment.

Returns:

(Types::DeleteBrandAssignmentResponse) —
Returns a response object which responds to the following methods:
- #request_id => String

See Also:

AWS API Documentation

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

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

#delete_custom_permissions(params = {}) ⇒ `Types::DeleteCustomPermissionsResponse`

Deletes a custom permissions profile.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

Options Hash (params):

:aws_account_id (required, String) —
The ID of the Amazon Web Services account that contains the custom permissions profile that you want to delete.
:custom_permissions_name (required, String) —
The name of the custom permissions profile that you want to delete.

Returns:

(Types::DeleteCustomPermissionsResponse) —
Returns a response object which responds to the following methods:
- #status => Integer
- #arn => String
- #request_id => String

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 6815

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

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

Deletes a dashboard.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

Options Hash (params):

:aws_account_id (required, String) —
The ID of the Amazon Web Services account that contains the dashboard that you're deleting.
:dashboard_id (required, String) —
The ID for the dashboard.
:version_number (Integer) —
The version number of the dashboard. If the version number property is provided, only the specified version of the dashboard is deleted.

Returns:

(Types::DeleteDashboardResponse) —
Returns a response object which responds to the following methods:
- #status => Integer
- #arn => String
- #dashboard_id => String
- #request_id => String

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 6859

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

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

Deletes a dataset.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

Options Hash (params):

:aws_account_id (required, String) —
The Amazon Web Services account ID.
:data_set_id (required, String) —
The ID for the dataset that you want to delete. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

Returns:

(Types::DeleteDataSetResponse) —
Returns a response object which responds to the following methods:
- #arn => String
- #data_set_id => String
- #request_id => String
- #status => Integer

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 6898

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

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

Deletes the dataset refresh properties of the dataset.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

Options Hash (params):

:aws_account_id (required, String) —
The Amazon Web Services account ID.
:data_set_id (required, String) —
The ID of the dataset.

Returns:

(Types::DeleteDataSetRefreshPropertiesResponse) —
Returns a response object which responds to the following methods:
- #request_id => String
- #status => Integer

See Also:

AWS API Documentation

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

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

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

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

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

Options Hash (params):

:aws_account_id (required, String) —
The Amazon Web Services account ID.
:data_source_id (required, String) —
The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

Returns:

(Types::DeleteDataSourceResponse) —
Returns a response object which responds to the following methods:
- #arn => String
- #data_source_id => String
- #request_id => String
- #status => Integer

See Also:

AWS API Documentation

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

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

#delete_default_q_business_application(params = {}) ⇒ `Types::DeleteDefaultQBusinessApplicationResponse`

Deletes a linked Amazon Q Business application from an Quick Sight account

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

Options Hash (params):

:aws_account_id (required, String) —
The ID of the Quick Sight account that you want to disconnect from a Amazon Q Business application.
:namespace (String) —
The Quick Sight namespace that you want to delete a linked Amazon Q Business application from. If this field is left blank, the Amazon Q Business application is deleted from the default namespace. Currently, the default namespace is the only valid value for this parameter.

Returns:

(Types::DeleteDefaultQBusinessApplicationResponse) —
Returns a response object which responds to the following methods:
- #request_id => String
- #status => Integer

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 7011

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

#delete_dlp_setting(params = {}) ⇒ `Types::DeleteDlpSettingResponse`

Deletes a DLP setting configuration from an Amazon Web Services account.

Examples:

Request syntax with placeholder values


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

Response structure


resp.arn #=> String
resp.dlp_setting_id #=> String
resp.request_id #=> String

Parameters:

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

Options Hash (params):

:aws_account_id (required, String) —
The ID of the Amazon Web Services account that contains the DLP setting that you want to delete.
:dlp_setting_id (required, String) —
The ID of the DLP setting that you want to delete.

Returns:

(Types::DeleteDlpSettingResponse) —
Returns a response object which responds to the following methods:
- #arn => String
- #dlp_setting_id => String
- #request_id => String

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 7049

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

#delete_flow(params = {}) ⇒ `Types::DeleteFlowResponse`

Permanently deletes a flow from the specified Amazon Web Services account. This operation cannot be undone.

Examples:

Request syntax with placeholder values


resp = client.delete_flow({
  aws_account_id: "AccountId", # required
  flow_id: "FlowId", # required
})

Response structure


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

Parameters:

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

Options Hash (params):

:aws_account_id (required, String) —
The ID of the Amazon Web Services account that contains the flow that you are deleting.
:flow_id (required, String) —
The unique identifier of the flow to delete.

Returns:

(Types::DeleteFlowResponse) —
Returns a response object which responds to the following methods:
- #request_id => String
- #status => Integer

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 7085

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

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

Deletes an empty folder.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

Options Hash (params):

:aws_account_id (required, String) —
The ID for the Amazon Web Services account that contains the folder.
:folder_id (required, String) —
The ID of the folder.

Returns:

(Types::DeleteFolderResponse) —
Returns a response object which responds to the following methods:
- #status => Integer
- #arn => String
- #folder_id => String
- #request_id => String

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 7123

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

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

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

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

Options Hash (params):

:aws_account_id (required, String) —
The ID for the Amazon Web Services account that contains the folder.
:folder_id (required, String) —
The Folder ID.
:member_id (required, String) —
The ID of the asset that you want to delete.
:member_type (required, String) —
The member type of the asset that you want to delete from a folder.

Returns:

(Types::DeleteFolderMembershipResponse) —
Returns a response object which responds to the following methods:
- #status => Integer
- #request_id => String

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 7166

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

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

Removes a user group from Amazon Quick Sight.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

Options Hash (params):

:group_name (required, String) —
The name of the group that you want to delete.
:aws_account_id (required, String) —
The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon Quick Sight account.
:namespace (required, String) —
The namespace of the group that you want to delete.

Returns:

(Types::DeleteGroupResponse) —
Returns a response object which responds to the following methods:
- #request_id => String
- #status => Integer

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 7206

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

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

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

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

Options Hash (params):

:member_name (required, String) —
The name of the user that you want to delete from the group membership.
:group_name (required, String) —
The name of the group that you want to delete the user from.
:aws_account_id (required, String) —
The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon Quick Sight account.
:namespace (required, String) —
The namespace of the group that you want to remove a user from.

Returns:

(Types::DeleteGroupMembershipResponse) —
Returns a response object which responds to the following methods:
- #request_id => String
- #status => Integer

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 7252

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

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

Deletes an existing IAM policy assignment.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

Options Hash (params):

:aws_account_id (required, String) —
The Amazon Web Services account ID where you want to delete the IAM policy assignment.
:assignment_name (required, String) —
The name of the assignment.
:namespace (required, String) —
The namespace that contains the assignment.

Returns:

(Types::DeleteIAMPolicyAssignmentResponse) —
Returns a response object which responds to the following methods:
- #assignment_name => String
- #request_id => String
- #status => Integer

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 7293

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

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

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

This operation is only supported for Quick Sight accounts that use IAM Identity Center.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

Options Hash (params):

:aws_account_id (required, String) —
The ID of the Amazon Web Services account that you want to delete an identity propagation configuration from.
:service (required, String) —
The name of the Amazon Web Services service that you want to delete the associated access scopes and authorized targets from.

Returns:

(Types::DeleteIdentityPropagationConfigResponse) —
Returns a response object which responds to the following methods:
- #request_id => String
- #status => Integer

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 7333

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

#delete_knowledge_base(params = {}) ⇒ `Types::DeleteKnowledgeBaseResponse`

Deletes a knowledge base.

Examples:

Request syntax with placeholder values


resp = client.delete_knowledge_base({
  aws_account_id: "KbAwsAccountId", # required
  knowledge_base_id: "KnowledgeBaseId", # required
})

Response structure


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

Parameters:

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

Options Hash (params):

:aws_account_id (required, String) —
The ID of the Amazon Web Services account that contains the knowledge base.
:knowledge_base_id (required, String) —
The unique identifier for the knowledge base.

Returns:

(Types::DeleteKnowledgeBaseResponse) —
Returns a response object which responds to the following methods:
- #knowledge_base_arn => String
- #knowledge_base_id => String
- #request_id => String
- #status => Integer

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 7372

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

#delete_limits_profile(params = {}) ⇒ `Types::DeleteLimitsProfileResponse`

Deletes a limits profile.

Examples:

Request syntax with placeholder values


resp = client.delete_limits_profile({
  profile_id: "ProfileId", # required
  account_id: "AwsAccountId", # required
})

Response structure


resp.arn #=> String

Parameters:

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

Options Hash (params):

:profile_id (required, String) —
The unique identifier for the limits profile to delete.
:account_id (required, String) —
The ID of the Amazon Web Services account that contains the limits profile.

Returns:

(Types::DeleteLimitsProfileResponse) —
Returns a response object which responds to the following methods:
- #arn => String

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 7405

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

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

Deletes a namespace and the users and groups that are associated with the namespace. This is an asynchronous process. Assets including dashboards, analyses, datasets and data sources are not deleted. To delete these assets, you use the API operations for the relevant asset.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

Options Hash (params):

:aws_account_id (required, String) —
The ID for the Amazon Web Services account that you want to delete the Quick Sight namespace from.
:namespace (required, String) —
The namespace that you want to delete.

Returns:

(Types::DeleteNamespaceResponse) —
Returns a response object which responds to the following methods:
- #request_id => String
- #status => Integer

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 7444

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

#delete_o_auth_client_application(params = {}) ⇒ `Types::DeleteOAuthClientApplicationResponse`

Deletes an OAuthClientApplication.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

Options Hash (params):

:aws_account_id (required, String) —
The Amazon Web Services account ID.
:o_auth_client_application_id (required, String) —
The ID of the OAuthClientApplication that you want to delete.

Returns:

(Types::DeleteOAuthClientApplicationResponse) —
Returns a response object which responds to the following methods:
- #arn => String
- #o_auth_client_application_id => String
- #request_id => String
- #status => Integer

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 7482

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

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

Deletes a refresh schedule from a dataset.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

Options Hash (params):

:data_set_id (required, String) —
The ID of the dataset.
:aws_account_id (required, String) —
The Amazon Web Services account ID.
:schedule_id (required, String) —
The ID of the refresh schedule.

Returns:

(Types::DeleteRefreshScheduleResponse) —
Returns a response object which responds to the following methods:
- #status => Integer
- #request_id => String
- #schedule_id => String
- #arn => String

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 7524

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

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

Removes custom permissions from the role.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

Options Hash (params):

:role (required, String) —
The role that you want to remove permissions from.
:aws_account_id (required, String) —
The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon Quick Sight account.
:namespace (required, String) —
The namespace that includes the role.

Returns:

(Types::DeleteRoleCustomPermissionResponse) —
Returns a response object which responds to the following methods:
- #request_id => String
- #status => Integer

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 7564

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

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

Removes a group from a role.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

Options Hash (params):

:member_name (required, String) —
The name of the group.
:role (required, String) —
The role that you want to remove permissions from.
:aws_account_id (required, String) —
The ID for the Amazon Web Services account that you want to create a group in. The Amazon Web Services account ID that you provide must be the same Amazon Web Services account that contains your Amazon Quick Sight account.
:namespace (required, String) —
The namespace that contains the role.

Returns:

(Types::DeleteRoleMembershipResponse) —
Returns a response object which responds to the following methods:
- #request_id => String
- #status => Integer

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 7609

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

#delete_space(params = {}) ⇒ `Types::DeleteSpaceResponse`

Deletes an Amazon QuickSight space.

Examples:

Request syntax with placeholder values


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

Response structure


resp.space_id #=> String
resp.space_arn #=> String
resp.request_id #=> String

Parameters:

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

Options Hash (params):

:aws_account_id (required, String) —
The ID of the Amazon Web Services account that contains the space.
:space_id (required, String) —
The ID of the space that you want to delete.

Returns:

(Types::DeleteSpaceResponse) —
Returns a response object which responds to the following methods:
- #space_id => String
- #space_arn => String
- #request_id => String

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 7645

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

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

Deletes a template.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

Options Hash (params):

:aws_account_id (required, String) —
The ID of the Amazon Web Services account that contains the template that you're deleting.
:template_id (required, String) —
An ID for the template you want to delete.
:version_number (Integer) —
Specifies the version of the template that you want to delete. If you don't provide a version number, DeleteTemplate deletes all versions of the template.

Returns:

(Types::DeleteTemplateResponse) —
Returns a response object which responds to the following methods:
- #request_id => String
- #arn => String
- #template_id => String
- #status => Integer

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 7690

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

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

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

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

Options Hash (params):

:aws_account_id (required, String) —
The ID of the Amazon Web Services account that contains the item to delete.
:template_id (required, String) —
The ID for the template that the specified alias is for.
:alias_name (required, String) —
The name for the template alias. To delete a specific alias, you delete the version that the alias points to. You can specify the alias name, or specify the latest version of the template by providing the keyword $LATEST in the AliasName parameter.

Returns:

(Types::DeleteTemplateAliasResponse) —
Returns a response object which responds to the following methods:
- #status => Integer
- #template_id => String
- #alias_name => String
- #arn => String
- #request_id => String

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 7740

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

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

Deletes a theme.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

Options Hash (params):

:aws_account_id (required, String) —
The ID of the Amazon Web Services account that contains the theme that you're deleting.
:theme_id (required, String) —
An ID for the theme that you want to delete.
:version_number (Integer) —
The version of the theme that you want to delete.

Note: If you don't provide a version number, you're using this call to DeleteTheme to delete all versions of the theme.

Returns:

(Types::DeleteThemeResponse) —
Returns a response object which responds to the following methods:
- #arn => String
- #request_id => String
- #status => Integer
- #theme_id => String

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 7786

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

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

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

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

Options Hash (params):

:aws_account_id (required, String) —
The ID of the Amazon Web Services account that contains the theme alias to delete.
:theme_id (required, String) —
The ID for the theme that the specified alias is for.
:alias_name (required, String) —
The unique name for the theme alias to delete.

Returns:

(Types::DeleteThemeAliasResponse) —
Returns a response object which responds to the following methods:
- #alias_name => String
- #arn => String
- #request_id => String
- #status => Integer
- #theme_id => String

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 7833

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

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

Deletes a topic.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

Options Hash (params):

:aws_account_id (required, String) —
The ID of the Amazon Web Services account that contains the topic that you want to delete.
:topic_id (required, String) —
The ID of the topic that you want to delete. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

Returns:

(Types::DeleteTopicResponse) —
Returns a response object which responds to the following methods:
- #arn => String
- #topic_id => String
- #request_id => String
- #status => Integer

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 7873

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

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

Deletes a topic refresh schedule.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

Options Hash (params):

:aws_account_id (required, String) —
The Amazon Web Services account ID.
:topic_id (required, String) —
The ID of the topic that you want to modify. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
:dataset_id (required, String) —
The ID of the dataset.

Returns:

(Types::DeleteTopicRefreshScheduleResponse) —
Returns a response object which responds to the following methods:
- #topic_id => String
- #topic_arn => String
- #dataset_arn => String
- #status => Integer
- #request_id => String

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 7918

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

#delete_topic_v2(params = {}) ⇒ `Types::DeleteTopicV2Response`

Deletes a Q topic.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

Options Hash (params):

:aws_account_id (required, String) —
The ID of the Amazon Web Services account that contains the topic that you want to delete.
:topic_id (required, String) —
The ID of the topic that you want to delete. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

Returns:

(Types::DeleteTopicV2Response) —
Returns a response object which responds to the following methods:
- #arn => String
- #topic_id => String
- #request_id => String
- #status => Integer

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 7958

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

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

Deletes the Amazon Quick Sight user that is associated with the identity of the IAM user or role that's making the call. The IAM user isn't deleted as a result of this call.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

Options Hash (params):

:user_name (required, String) —
The name of the user that you want to delete.
:aws_account_id (required, String) —
The ID for the Amazon Web Services account that the user is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon Quick Sight account.
:namespace (required, String) —
The namespace. Currently, you should set this to default.

Returns:

(Types::DeleteUserResponse) —
Returns a response object which responds to the following methods:
- #request_id => String
- #status => Integer

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 8000

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

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

Deletes a user identified by its principal ID.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

Options Hash (params):

:principal_id (required, String) —
The principal ID of the user.
:aws_account_id (required, String) —
The ID for the Amazon Web Services account that the user is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon Quick Sight account.
:namespace (required, String) —
The namespace. Currently, you should set this to default.

Returns:

(Types::DeleteUserByPrincipalIdResponse) —
Returns a response object which responds to the following methods:
- #request_id => String
- #status => Integer

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 8040

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

#delete_user_custom_permission(params = {}) ⇒ `Types::DeleteUserCustomPermissionResponse`

Deletes a custom permissions profile from a user.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

Options Hash (params):

:user_name (required, String) —
The username of the user that you want to remove custom permissions from.
:aws_account_id (required, String) —
The ID of the Amazon Web Services account that contains the custom permission configuration that you want to delete.
:namespace (required, String) —
The namespace that the user belongs to.

Returns:

(Types::DeleteUserCustomPermissionResponse) —
Returns a response object which responds to the following methods:
- #request_id => String
- #status => Integer

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 8080

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

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

Deletes a VPC connection.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

Options Hash (params):

:aws_account_id (required, String) —
The Amazon Web Services account ID of the account where you want to delete a VPC connection.
:vpc_connection_id (required, String) —
The ID of the VPC connection that you're creating. This ID is a unique identifier for each Amazon Web Services Region in an Amazon Web Services account.

Returns:

(Types::DeleteVPCConnectionResponse) —
Returns a response object which responds to the following methods:
- #arn => String
- #vpc_connection_id => String
- #deletion_status => String
- #availability_status => String
- #request_id => String
- #status => Integer

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 8125

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

#describe_account_custom_permission(params = {}) ⇒ `Types::DescribeAccountCustomPermissionResponse`

Describes the custom permissions profile that is applied to an account.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

Options Hash (params):

:aws_account_id (required, String) —
The ID of the Amazon Web Services account for which you want to describe the applied custom permissions profile.

Returns:

(Types::DescribeAccountCustomPermissionResponse) —
Returns a response object which responds to the following methods:
- #custom_permissions_name => String
- #request_id => String
- #status => Integer

See Also:

AWS API Documentation

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

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

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

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

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

Amazon Web Services account - The Amazon Web Services account exists at the top of the hierarchy. It has the potential to use all of the Amazon Web Services Regions and Amazon Web Services Services. When you subscribe to Quick Sight, you choose one Amazon Web Services Region to use as your home Region. That's where your free SPICE capacity is located. You can use Quick Sight in any supported Amazon Web Services Region.
Amazon Web Services Region - You can sign in to Quick Sight in any Amazon Web Services Region. If you have a user directory, it resides in us-east-1, which is US East (N. Virginia). Generally speaking, these users have access to Quick Sight in any Amazon Web Services Region, unless they are constrained to a namespace.

To run the command in a different Amazon Web Services Region, you change your Region settings. If you're using the CLI, you can use one of the following options:
- Use command line options.
- Use named profiles.
- Run aws configure to change your default Amazon Web Services Region. Use Enter to key the same settings for your keys. For more information, see Configuring the CLI.
Namespace - A Quick Sight namespace is a partition that contains users and assets (data sources, datasets, dashboards, and so on). To access assets that are in a specific namespace, users and groups must also be part of the same namespace. People who share a namespace are completely isolated from users and assets in other namespaces, even if they are in the same Amazon Web Services account and Amazon Web Services Region.
Applied customizations - Quick Sight customizations can apply to an Amazon Web Services account or to a namespace. Settings that you apply to a namespace override settings that you apply to an Amazon Web Services account.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

Options Hash (params):

:aws_account_id (required, String) —
The ID for the Amazon Web Services account that you want to describe Quick Sight customizations for.
:namespace (String) —
The Quick Sight namespace that you want to describe Quick Sight customizations for.
:resolved (Boolean) —
The Resolved flag works with the other parameters to determine which view of Quick Sight customizations is returned. You can add this flag to your command to use the same view that Quick Sight uses to identify which customizations to apply to the console. Omit this flag, or set it to no-resolved, to reveal customizations that are configured at different levels.

Returns:

(Types::DescribeAccountCustomizationResponse) —
Returns a response object which responds to the following methods:
- #arn => String
- #aws_account_id => String
- #namespace => String
- #account_customization => Types::AccountCustomization
- #request_id => String
- #status => Integer

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 8263

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

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

Describes the settings that were used when your Quick Sight subscription was first created in this Amazon Web Services account.

Examples:

Request syntax with placeholder values


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

Response structure


resp.account_settings.account_name #=> String
resp.account_settings.edition #=> String, one of "STANDARD", "ENTERPRISE", "ENTERPRISE_AND_Q"
resp.account_settings.default_namespace #=> String
resp.account_settings.notification_email #=> String
resp.account_settings.public_sharing_enabled #=> Boolean
resp.account_settings.termination_protection_enabled #=> Boolean
resp.request_id #=> String
resp.status #=> Integer

Parameters:

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

Options Hash (params):

:aws_account_id (required, String) —
The ID for the Amazon Web Services account that contains the settings that you want to list.

Returns:

(Types::DescribeAccountSettingsResponse) —
Returns a response object which responds to the following methods:
- #account_settings => Types::AccountSettings
- #request_id => String
- #status => Integer

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 8302

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

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

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

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

Options Hash (params):

:aws_account_id (required, String) —
The Amazon Web Services account ID associated with your Quick Sight account.

Returns:

(Types::DescribeAccountSubscriptionResponse) —
Returns a response object which responds to the following methods:
- #account_info => Types::AccountInfo
- #status => Integer
- #request_id => String

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 8344

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

#describe_action_connector(params = {}) ⇒ `Types::DescribeActionConnectorResponse`

Retrieves detailed information about an action connector, including its configuration, authentication settings, enabled actions, and current status.

Examples:

Request syntax with placeholder values


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

Response structure


resp.action_connector.arn #=> String
resp.action_connector.action_connector_id #=> String
resp.action_connector.type #=> String, one of "GENERIC_HTTP", "SERVICENOW_NOW_PLATFORM", "SALESFORCE_CRM", "MICROSOFT_OUTLOOK", "PAGERDUTY_ADVANCE", "JIRA_CLOUD", "ATLASSIAN_CONFLUENCE", "AMAZON_S3", "AMAZON_BEDROCK_AGENT_RUNTIME", "AMAZON_BEDROCK_RUNTIME", "AMAZON_BEDROCK_DATA_AUTOMATION_RUNTIME", "AMAZON_TEXTRACT", "AMAZON_COMPREHEND", "AMAZON_COMPREHEND_MEDICAL", "MICROSOFT_ONEDRIVE", "MICROSOFT_SHAREPOINT", "MICROSOFT_TEAMS", "SAP_BUSINESSPARTNER", "SAP_PRODUCTMASTERDATA", "SAP_PHYSICALINVENTORY", "SAP_BILLOFMATERIALS", "SAP_MATERIALSTOCK", "ZENDESK_SUITE", "SMARTSHEET", "SLACK", "ASANA", "BAMBOO_HR"
resp.action_connector.name #=> String
resp.action_connector.created_time #=> Time
resp.action_connector.last_updated_time #=> Time
resp.action_connector.status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED", "DELETED"
resp.action_connector.error.message #=> String
resp.action_connector.error.type #=> String, one of "INTERNAL_FAILURE"
resp.action_connector.description #=> String
resp.action_connector.authentication_config.authentication_type #=> String, one of "BASIC", "API_KEY", "OAUTH2_CLIENT_CREDENTIALS", "NONE", "IAM", "OAUTH2_AUTHORIZATION_CODE"
resp.action_connector.authentication_config.authentication_metadata.authorization_code_grant_metadata.base_endpoint #=> String
resp.action_connector.authentication_config.authentication_metadata.authorization_code_grant_metadata.redirect_url #=> String
resp.action_connector.authentication_config.authentication_metadata.authorization_code_grant_metadata.read_authorization_code_grant_credentials_details.read_authorization_code_grant_details.client_id #=> String
resp.action_connector.authentication_config.authentication_metadata.authorization_code_grant_metadata.read_authorization_code_grant_credentials_details.read_authorization_code_grant_details.token_endpoint #=> String
resp.action_connector.authentication_config.authentication_metadata.authorization_code_grant_metadata.read_authorization_code_grant_credentials_details.read_authorization_code_grant_details.authorization_endpoint #=> String
resp.action_connector.authentication_config.authentication_metadata.authorization_code_grant_metadata.authorization_code_grant_credentials_source #=> String, one of "PLAIN_CREDENTIALS"
resp.action_connector.authentication_config.authentication_metadata.client_credentials_grant_metadata.base_endpoint #=> String
resp.action_connector.authentication_config.authentication_metadata.client_credentials_grant_metadata.read_client_credentials_details.read_client_credentials_grant_details.client_id #=> String
resp.action_connector.authentication_config.authentication_metadata.client_credentials_grant_metadata.read_client_credentials_details.read_client_credentials_grant_details.token_endpoint #=> String
resp.action_connector.authentication_config.authentication_metadata.client_credentials_grant_metadata.client_credentials_source #=> String, one of "PLAIN_CREDENTIALS"
resp.action_connector.authentication_config.authentication_metadata.basic_auth_connection_metadata.base_endpoint #=> String
resp.action_connector.authentication_config.authentication_metadata.basic_auth_connection_metadata.username #=> String
resp.action_connector.authentication_config.authentication_metadata.api_key_connection_metadata.base_endpoint #=> String
resp.action_connector.authentication_config.authentication_metadata.api_key_connection_metadata.email #=> String
resp.action_connector.authentication_config.authentication_metadata.none_connection_metadata.base_endpoint #=> String
resp.action_connector.authentication_config.authentication_metadata.iam_connection_metadata.role_arn #=> String
resp.action_connector.authentication_config.authentication_metadata.iam_connection_metadata.source_arn #=> String
resp.action_connector.enabled_actions #=> Array
resp.action_connector.enabled_actions[0] #=> String
resp.action_connector.vpc_connection_arn #=> String
resp.request_id #=> String
resp.status #=> Integer

Parameters:

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

Options Hash (params):

:aws_account_id (required, String) —
The Amazon Web Services account ID that contains the action connector.
:action_connector_id (required, String) —
The unique identifier of the action connector to describe.

Returns:

(Types::DescribeActionConnectorResponse) —
Returns a response object which responds to the following methods:
- #action_connector => Types::ActionConnector
- #request_id => String
- #status => Integer

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 8412

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

#describe_action_connector_permissions(params = {}) ⇒ `Types::DescribeActionConnectorPermissionsResponse`

Retrieves the permissions configuration for an action connector, showing which users, groups, and namespaces have access and what operations they can perform.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

Options Hash (params):

:aws_account_id (required, String) —
The Amazon Web Services account ID that contains the action connector.
:action_connector_id (required, String) —
The unique identifier of the action connector whose permissions you want to describe.

Returns:

(Types::DescribeActionConnectorPermissionsResponse) —
Returns a response object which responds to the following methods:
- #arn => String
- #action_connector_id => String
- #permissions => Array<Types::ResourcePermission>
- #request_id => String
- #status => Integer

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 8458

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

#describe_agent(params = {}) ⇒ `Types::DescribeAgentResponse`

Describes an agent.

Examples:

Request syntax with placeholder values


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

Response structure


resp.agent.spaces #=> Array
resp.agent.spaces[0] #=> String
resp.agent.action_connectors #=> Array
resp.agent.action_connectors[0] #=> String
resp.agent.description #=> String
resp.agent.icon_id #=> String
resp.agent.name #=> String
resp.agent.starter_prompts #=> Array
resp.agent.starter_prompts[0] #=> String
resp.agent.welcome_message #=> String
resp.agent.arn #=> String
resp.agent.agent_id #=> String
resp.agent.agent_lifecycle #=> String, one of "PREVIEW", "PUBLISHED"
resp.agent.agent_status #=> String, one of "ACTIVE", "UPDATING", "FAILED", "CREATING"
resp.agent.created_at #=> Time
resp.agent.creator #=> String
resp.agent.custom_prompt_interface.model_profile_id #=> String
resp.agent.custom_prompt_interface.subscription_id #=> String
resp.agent.custom_prompt_interface.qbs_aws_account_id #=> String
resp.agent.custom_prompt_interface.response_length #=> String
resp.agent.custom_prompt_interface.output_style #=> String
resp.agent.custom_prompt_interface.identity #=> String
resp.agent.custom_prompt_interface.tone #=> String
resp.agent.custom_prompt_interface.custom_instructions #=> String
resp.agent.custom_prompt_interface.prompt_summary #=> String
resp.agent.error_message #=> String
resp.agent.updated_at #=> Time
resp.request_id #=> String

Parameters:

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

Options Hash (params):

:agent_id (required, String) —
The unique identifier for the agent.
:aws_account_id (required, String) —
The ID of the Amazon Web Services account that contains the agent.

Returns:

(Types::DescribeAgentResponse) —
Returns a response object which responds to the following methods:
- #agent => Types::Agent
- #request_id => String

See Also:

AWS API Documentation

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

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

#describe_agent_permissions(params = {}) ⇒ `Types::DescribeAgentPermissionsResponse`

Describes the resource permissions for an agent.

Examples:

Request syntax with placeholder values


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

Response structure


resp.arn #=> String
resp.agent_id #=> String
resp.permissions #=> Array
resp.permissions[0].principal #=> String
resp.permissions[0].actions #=> Array
resp.permissions[0].actions[0] #=> String
resp.request_id #=> String

Parameters:

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

Options Hash (params):

:agent_id (required, String) —
The unique identifier for the agent.
:aws_account_id (required, String) —
The ID of the Amazon Web Services account that contains the agent.

Returns:

(Types::DescribeAgentPermissionsResponse) —
Returns a response object which responds to the following methods:
- #arn => String
- #agent_id => String
- #permissions => Array<Types::ResourcePermission>
- #request_id => String

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 8559

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

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

Provides a summary of the metadata for an analysis.

Examples:

Request syntax with placeholder values


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

Response structure


resp.analysis.analysis_id #=> String
resp.analysis.arn #=> String
resp.analysis.name #=> String
resp.analysis.status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED", "DELETED"
resp.analysis.errors #=> Array
resp.analysis.errors[0].type #=> String, one of "ACCESS_DENIED", "SOURCE_NOT_FOUND", "DATA_SET_NOT_FOUND", "INTERNAL_FAILURE", "PARAMETER_VALUE_INCOMPATIBLE", "PARAMETER_TYPE_INVALID", "PARAMETER_NOT_FOUND", "COLUMN_TYPE_MISMATCH", "COLUMN_GEOGRAPHIC_ROLE_MISMATCH", "COLUMN_REPLACEMENT_MISSING"
resp.analysis.errors[0].message #=> String
resp.analysis.errors[0].violated_entities #=> Array
resp.analysis.errors[0].violated_entities[0].path #=> String
resp.analysis.data_set_arns #=> Array
resp.analysis.data_set_arns[0] #=> String
resp.analysis.topic_arns #=> Array
resp.analysis.topic_arns[0] #=> String
resp.analysis.theme_arn #=> String
resp.analysis.created_time #=> Time
resp.analysis.last_updated_time #=> Time
resp.analysis.sheets #=> Array
resp.analysis.sheets[0].sheet_id #=> String
resp.analysis.sheets[0].name #=> String
resp.analysis.sheets[0].images #=> Array
resp.analysis.sheets[0].images[0].sheet_image_id #=> String
resp.analysis.sheets[0].images[0].source.sheet_image_static_file_source.static_file_id #=> String
resp.analysis.sheets[0].images[0].scaling.scaling_type #=> String, one of "SCALE_TO_WIDTH", "SCALE_TO_HEIGHT", "SCALE_TO_CONTAINER", "SCALE_NONE"
resp.analysis.sheets[0].images[0].tooltip.tooltip_text.plain_text #=> String
resp.analysis.sheets[0].images[0].tooltip.visibility #=> String, one of "HIDDEN", "VISIBLE"
resp.analysis.sheets[0].images[0].image_content_alt_text #=> String
resp.analysis.sheets[0].images[0].interactions.image_menu_option.availability_status #=> String, one of "ENABLED", "DISABLED"
resp.analysis.sheets[0].images[0].actions #=> Array
resp.analysis.sheets[0].images[0].actions[0].custom_action_id #=> String
resp.analysis.sheets[0].images[0].actions[0].name #=> String
resp.analysis.sheets[0].images[0].actions[0].status #=> String, one of "ENABLED", "DISABLED"
resp.analysis.sheets[0].images[0].actions[0].trigger #=> String, one of "CLICK", "MENU"
resp.analysis.sheets[0].images[0].actions[0].action_operations #=> Array
resp.analysis.sheets[0].images[0].actions[0].action_operations[0].navigation_operation.local_navigation_configuration.target_sheet_id #=> String
resp.analysis.sheets[0].images[0].actions[0].action_operations[0].url_operation.url_template #=> String
resp.analysis.sheets[0].images[0].actions[0].action_operations[0].url_operation.url_target #=> String, one of "NEW_TAB", "NEW_WINDOW", "SAME_TAB"
resp.analysis.sheets[0].images[0].actions[0].action_operations[0].set_parameters_operation.parameter_value_configurations #=> Array
resp.analysis.sheets[0].images[0].actions[0].action_operations[0].set_parameters_operation.parameter_value_configurations[0].destination_parameter_name #=> String
resp.analysis.sheets[0].images[0].actions[0].action_operations[0].set_parameters_operation.parameter_value_configurations[0].value.custom_values_configuration.include_null_value #=> Boolean
resp.analysis.sheets[0].images[0].actions[0].action_operations[0].set_parameters_operation.parameter_value_configurations[0].value.custom_values_configuration.custom_values.string_values #=> Array
resp.analysis.sheets[0].images[0].actions[0].action_operations[0].set_parameters_operation.parameter_value_configurations[0].value.custom_values_configuration.custom_values.string_values[0] #=> String
resp.analysis.sheets[0].images[0].actions[0].action_operations[0].set_parameters_operation.parameter_value_configurations[0].value.custom_values_configuration.custom_values.integer_values #=> Array
resp.analysis.sheets[0].images[0].actions[0].action_operations[0].set_parameters_operation.parameter_value_configurations[0].value.custom_values_configuration.custom_values.integer_values[0] #=> Integer
resp.analysis.sheets[0].images[0].actions[0].action_operations[0].set_parameters_operation.parameter_value_configurations[0].value.custom_values_configuration.custom_values.decimal_values #=> Array
resp.analysis.sheets[0].images[0].actions[0].action_operations[0].set_parameters_operation.parameter_value_configurations[0].value.custom_values_configuration.custom_values.decimal_values[0] #=> Float
resp.analysis.sheets[0].images[0].actions[0].action_operations[0].set_parameters_operation.parameter_value_configurations[0].value.custom_values_configuration.custom_values.date_time_values #=> Array
resp.analysis.sheets[0].images[0].actions[0].action_operations[0].set_parameters_operation.parameter_value_configurations[0].value.custom_values_configuration.custom_values.date_time_values[0] #=> Time
resp.analysis.sheets[0].images[0].actions[0].action_operations[0].set_parameters_operation.parameter_value_configurations[0].value.select_all_value_options #=> String, one of "ALL_VALUES"
resp.analysis.sheets[0].images[0].actions[0].action_operations[0].set_parameters_operation.parameter_value_configurations[0].value.source_parameter_name #=> String
resp.analysis.sheets[0].images[0].actions[0].action_operations[0].set_parameters_operation.parameter_value_configurations[0].value.source_field #=> String
resp.analysis.sheets[0].images[0].actions[0].action_operations[0].set_parameters_operation.parameter_value_configurations[0].value.source_column.data_set_identifier #=> String
resp.analysis.sheets[0].images[0].actions[0].action_operations[0].set_parameters_operation.parameter_value_configurations[0].value.source_column.topic_identifier #=> String
resp.analysis.sheets[0].images[0].actions[0].action_operations[0].set_parameters_operation.parameter_value_configurations[0].value.source_column.column_name #=> String
resp.status #=> Integer
resp.request_id #=> String

Parameters:

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

Options Hash (params):

:aws_account_id (required, String) —
The ID of the Amazon Web Services account that contains the analysis. You must be using the Amazon Web Services account that the analysis is in.
:analysis_id (required, String) —
The ID of the analysis that you're describing. The ID is part of the URL of the analysis.

Returns:

(Types::DescribeAnalysisResponse) —
Returns a response object which responds to the following methods:
- #analysis => Types::Analysis
- #status => Integer
- #request_id => String

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 8650

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

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

Provides a detailed description of the definition of an analysis.

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

Examples:

Request syntax with placeholder values


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

Parameters:

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

Options Hash (params):

:aws_account_id (required, String) —
The ID of the Amazon Web Services account that contains the analysis. You must be using the Amazon Web Services account that the analysis is in.
:analysis_id (required, String) —
The ID of the analysis that you're describing. The ID is part of the URL of the analysis.

Returns:

(Types::DescribeAnalysisDefinitionResponse) —
Returns a response object which responds to the following methods:
- #analysis_id => String
- #name => String
- #errors => Array<Types::AnalysisError>
- #resource_status => String
- #theme_arn => String
- #definition => Types::AnalysisDefinition
- #status => Integer
- #request_id => String

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 8699

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

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

Provides the read and write permissions for an analysis.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

Options Hash (params):

:aws_account_id (required, String) —
The ID of the Amazon Web Services account that contains the analysis whose permissions you're describing. You must be using the Amazon Web Services account that the analysis is in.
:analysis_id (required, String) —
The ID of the analysis whose permissions you're describing. The ID is part of the analysis URL.

Returns:

(Types::DescribeAnalysisPermissionsResponse) —
Returns a response object which responds to the following methods:
- #analysis_id => String
- #analysis_arn => String
- #permissions => Array<Types::ResourcePermission>
- #status => Integer
- #request_id => String

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 8745

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

#describe_approval_policy(params = {}) ⇒ `Types::DescribeApprovalPolicyResponse`

Describes an approval policy in Quick Sight.

Examples:

Request syntax with placeholder values


resp = client.describe_approval_policy({
  policy_id: "PolicyId", # required
})

Response structure


resp.policy.policy_id #=> String
resp.policy.policy_arn #=> String
resp.policy.name #=> String
resp.policy.description #=> String
resp.policy.actions #=> Array
resp.policy.actions[0] #=> String, one of "SHARE"
resp.policy.asset_types #=> Array
resp.policy.asset_types[0] #=> String, one of "AGENT", "SPACE", "KNOWLEDGE_BASE"
resp.policy.applicable_to.type #=> String, one of "GROUP"
resp.policy.applicable_to.group_arns #=> Array
resp.policy.applicable_to.group_arns[0] #=> String
resp.policy.approval_groups #=> Array
resp.policy.approval_groups[0] #=> String
resp.policy.created_at #=> Time
resp.policy.updated_at #=> Time

Parameters:

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

Options Hash (params):

:policy_id (required, String) —
The unique identifier of the approval policy to describe.

Returns:

(Types::DescribeApprovalPolicyResponse) —
Returns a response object which responds to the following methods:
- #policy => Types::ApprovalPolicy

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 8787

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

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

Describes an existing export job.

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

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

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

Options Hash (params):

:aws_account_id (required, String) —
The ID of the Amazon Web Services account the export job is executed in.
:asset_bundle_export_job_id (required, String) —
The ID of the job that you want described. The job ID is set when you start a new job with a StartAssetBundleExportJob API call.

Returns:

(Types::DescribeAssetBundleExportJobResponse) —
Returns a response object which responds to the following methods:
- #job_status => String
- #download_url => String
- #errors => Array<Types::AssetBundleExportJobError>
- #arn => String
- #created_time => Time
- #asset_bundle_export_job_id => String
- #aws_account_id => String
- #resource_arns => Array<String>
- #include_all_dependencies => Boolean
- #export_format => String
- #cloud_formation_override_property_configuration => Types::AssetBundleCloudFormationOverridePropertyConfiguration
- #request_id => String
- #status => Integer
- #include_permissions => Boolean
- #include_tags => Boolean
- #validation_strategy => Types::AssetBundleExportJobValidationStrategy
- #warnings => Array<Types::AssetBundleExportJobWarning>
- #include_folder_memberships => Boolean
- #include_folder_members => String

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 8907

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

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

Describes an existing import job.

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

Examples:

Request syntax with placeholder values


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

Response structure


resp.job_status #=> String, one of "QUEUED_FOR_IMMEDIATE_EXECUTION", "IN_PROGRESS", "SUCCESSFUL", "FAILED", "FAILED_ROLLBACK_IN_PROGRESS", "FAILED_ROLLBACK_COMPLETED", "FAILED_ROLLBACK_ERROR"
resp.errors #=> Array
resp.errors[0].arn #=> String
resp.errors[0].type #=> String
resp.errors[0].message #=> String
resp.rollback_errors #=> Array
resp.rollback_errors[0].arn #=> String
resp.rollback_errors[0].type #=> String
resp.rollback_errors[0].message #=> String
resp.arn #=> String
resp.created_time #=> Time
resp.asset_bundle_import_job_id #=> String
resp.aws_account_id #=> String
resp.asset_bundle_import_source.body #=> String
resp.asset_bundle_import_source.s3_uri #=> String
resp.override_parameters.resource_id_override_configuration.prefix_for_all_resources #=> String
resp.override_parameters.vpc_connections #=> Array
resp.override_parameters.vpc_connections[0].vpc_connection_id #=> String
resp.override_parameters.vpc_connections[0].name #=> String
resp.override_parameters.vpc_connections[0].subnet_ids #=> Array
resp.override_parameters.vpc_connections[0].subnet_ids[0] #=> String
resp.override_parameters.vpc_connections[0].security_group_ids #=> Array
resp.override_parameters.vpc_connections[0].security_group_ids[0] #=> String
resp.override_parameters.vpc_connections[0].dns_resolvers #=> Array
resp.override_parameters.vpc_connections[0].dns_resolvers[0] #=> String
resp.override_parameters.vpc_connections[0].role_arn #=> String
resp.override_parameters.refresh_schedules #=> Array
resp.override_parameters.refresh_schedules[0].data_set_id #=> String
resp.override_parameters.refresh_schedules[0].schedule_id #=> String
resp.override_parameters.refresh_schedules[0].start_after_date_time #=> Time
resp.override_parameters.data_sources #=> Array
resp.override_parameters.data_sources[0].data_source_id #=> String
resp.override_parameters.data_sources[0].name #=> String
resp.override_parameters.data_sources[0].data_source_parameters.amazon_elasticsearch_parameters.domain #=> String
resp.override_parameters.data_sources[0].data_source_parameters.athena_parameters.work_group #=> String
resp.override_parameters.data_sources[0].data_source_parameters.athena_parameters.role_arn #=> String
resp.override_parameters.data_sources[0].data_source_parameters.athena_parameters.consumer_account_role_arn #=> String
resp.override_parameters.data_sources[0].data_source_parameters.athena_parameters.identity_center_configuration.enable_identity_propagation #=> Boolean
resp.override_parameters.data_sources[0].data_source_parameters.aurora_parameters.host #=> String
resp.override_parameters.data_sources[0].data_source_parameters.aurora_parameters.port #=> Integer
resp.override_parameters.data_sources[0].data_source_parameters.aurora_parameters.database #=> String
resp.override_parameters.data_sources[0].data_source_parameters.aurora_postgre_sql_parameters.host #=> String
resp.override_parameters.data_sources[0].data_source_parameters.aurora_postgre_sql_parameters.port #=> Integer
resp.override_parameters.data_sources[0].data_source_parameters.aurora_postgre_sql_parameters.database #=> String
resp.override_parameters.data_sources[0].data_source_parameters.aws_iot_analytics_parameters.data_set_name #=> String
resp.override_parameters.data_sources[0].data_source_parameters.jira_parameters.site_base_url #=> String
resp.override_parameters.data_sources[0].data_source_parameters.maria_db_parameters.host #=> String
resp.override_parameters.data_sources[0].data_source_parameters.maria_db_parameters.port #=> Integer
resp.override_parameters.data_sources[0].data_source_parameters.maria_db_parameters.database #=> String
resp.override_parameters.data_sources[0].data_source_parameters.my_sql_parameters.host #=> String
resp.override_parameters.data_sources[0].data_source_parameters.my_sql_parameters.port #=> Integer
resp.override_parameters.data_sources[0].data_source_parameters.my_sql_parameters.database #=> String
resp.override_parameters.data_sources[0].data_source_parameters.oracle_parameters.host #=> String
resp.override_parameters.data_sources[0].data_source_parameters.oracle_parameters.port #=> Integer
resp.override_parameters.data_sources[0].data_source_parameters.oracle_parameters.database #=> String
resp.override_parameters.data_sources[0].data_source_parameters.oracle_parameters.use_service_name #=> Boolean
resp.override_parameters.data_sources[0].data_source_parameters.postgre_sql_parameters.host #=> String
resp.override_parameters.data_sources[0].data_source_parameters.postgre_sql_parameters.port #=> Integer
resp.override_parameters.data_sources[0].data_source_parameters.postgre_sql_parameters.database #=> String
resp.override_parameters.data_sources[0].data_source_parameters.presto_parameters.host #=> String
resp.override_parameters.data_sources[0].data_source_parameters.presto_parameters.port #=> Integer
resp.override_parameters.data_sources[0].data_source_parameters.presto_parameters.catalog #=> String
resp.override_parameters.data_sources[0].data_source_parameters.rds_parameters.instance_id #=> String
resp.override_parameters.data_sources[0].data_source_parameters.rds_parameters.database #=> String
resp.override_parameters.data_sources[0].data_source_parameters.redshift_parameters.host #=> String
resp.override_parameters.data_sources[0].data_source_parameters.redshift_parameters.port #=> Integer
resp.override_parameters.data_sources[0].data_source_parameters.redshift_parameters.database #=> String
resp.override_parameters.data_sources[0].data_source_parameters.redshift_parameters.cluster_id #=> String
resp.override_parameters.data_sources[0].data_source_parameters.redshift_parameters.iam_parameters.role_arn #=> String
resp.override_parameters.data_sources[0].data_source_parameters.redshift_parameters.iam_parameters.database_user #=> String
resp.override_parameters.data_sources[0].data_source_parameters.redshift_parameters.iam_parameters.database_groups #=> Array
resp.override_parameters.data_sources[0].data_source_parameters.redshift_parameters.iam_parameters.database_groups[0] #=> String
resp.override_parameters.data_sources[0].data_source_parameters.redshift_parameters.iam_parameters.auto_create_database_user #=> Boolean
resp.override_parameters.data_sources[0].data_source_parameters.redshift_parameters.identity_center_configuration.enable_identity_propagation #=> Boolean
resp.override_parameters.data_sources[0].data_source_parameters.s3_parameters.manifest_file_location.bucket #=> String
resp.override_parameters.data_sources[0].data_source_parameters.s3_parameters.manifest_file_location.key #=> String
resp.override_parameters.data_sources[0].data_source_parameters.s3_parameters.role_arn #=> String
resp.override_parameters.data_sources[0].data_source_parameters.s3_tables_parameters.table_bucket_arn #=> String
resp.override_parameters.data_sources[0].data_source_parameters.s3_knowledge_base_parameters.role_arn #=> String
resp.override_parameters.data_sources[0].data_source_parameters.s3_knowledge_base_parameters.bucket_url #=> String
resp.override_parameters.data_sources[0].data_source_parameters.s3_knowledge_base_parameters.metadata_files_location #=> String
resp.override_parameters.data_sources[0].data_source_parameters.service_now_parameters.site_base_url #=> String
resp.override_parameters.data_sources[0].data_source_parameters.snowflake_parameters.host #=> String
resp.override_parameters.data_sources[0].data_source_parameters.snowflake_parameters.database #=> String
resp.override_parameters.data_sources[0].data_source_parameters.snowflake_parameters.warehouse #=> String
resp.override_parameters.data_sources[0].data_source_parameters.snowflake_parameters.authentication_type #=> String, one of "PASSWORD", "KEYPAIR", "TOKEN", "X509"
resp.override_parameters.data_sources[0].data_source_parameters.snowflake_parameters.database_access_control_role #=> String
resp.override_parameters.data_sources[0].data_source_parameters.snowflake_parameters.o_auth_parameters.token_provider_url #=> String
resp.override_parameters.data_sources[0].data_source_parameters.snowflake_parameters.o_auth_parameters.o_auth_scope #=> String
resp.override_parameters.data_sources[0].data_source_parameters.snowflake_parameters.o_auth_parameters.identity_provider_vpc_connection_properties.vpc_connection_arn #=> String
resp.override_parameters.data_sources[0].data_source_parameters.snowflake_parameters.o_auth_parameters.identity_provider_resource_uri #=> String
resp.override_parameters.data_sources[0].data_source_parameters.snowflake_parameters.o_auth_parameters.identity_provider_ca_certificates_bundle_s3_uri #=> String
resp.override_parameters.data_sources[0].data_source_parameters.spark_parameters.host #=> String
resp.override_parameters.data_sources[0].data_source_parameters.spark_parameters.port #=> Integer
resp.override_parameters.data_sources[0].data_source_parameters.sql_server_parameters.host #=> String
resp.override_parameters.data_sources[0].data_source_parameters.sql_server_parameters.port #=> Integer
resp.override_parameters.data_sources[0].data_source_parameters.sql_server_parameters.database #=> String
resp.override_parameters.data_sources[0].data_source_parameters.teradata_parameters.host #=> String
resp.override_parameters.data_sources[0].data_source_parameters.teradata_parameters.port #=> Integer
resp.override_parameters.data_sources[0].data_source_parameters.teradata_parameters.database #=> String
resp.override_parameters.data_sources[0].data_source_parameters.twitter_parameters.query #=> String
resp.override_parameters.data_sources[0].data_source_parameters.twitter_parameters.max_rows #=> Integer
resp.override_parameters.data_sources[0].data_source_parameters.amazon_open_search_parameters.domain #=> String
resp.override_parameters.data_sources[0].data_source_parameters.exasol_parameters.host #=> String
resp.override_parameters.data_sources[0].data_source_parameters.exasol_parameters.port #=> Integer
resp.override_parameters.data_sources[0].data_source_parameters.databricks_parameters.host #=> String
resp.override_parameters.data_sources[0].data_source_parameters.databricks_parameters.port #=> Integer
resp.override_parameters.data_sources[0].data_source_parameters.databricks_parameters.sql_endpoint_path #=> String
resp.override_parameters.data_sources[0].data_source_parameters.starburst_parameters.host #=> String
resp.override_parameters.data_sources[0].data_source_parameters.starburst_parameters.port #=> Integer
resp.override_parameters.data_sources[0].data_source_parameters.starburst_parameters.catalog #=> String
resp.override_parameters.data_sources[0].data_source_parameters.starburst_parameters.product_type #=> String, one of "GALAXY", "ENTERPRISE"
resp.override_parameters.data_sources[0].data_source_parameters.starburst_parameters.database_access_control_role #=> String
resp.override_parameters.data_sources[0].data_source_parameters.starburst_parameters.authentication_type #=> String, one of "PASSWORD", "KEYPAIR", "TOKEN", "X509"
resp.override_parameters.data_sources[0].data_source_parameters.starburst_parameters.o_auth_parameters.token_provider_url #=> String
resp.override_parameters.data_sources[0].data_source_parameters.starburst_parameters.o_auth_parameters.o_auth_scope #=> String
resp.override_parameters.data_sources[0].data_source_parameters.starburst_parameters.o_auth_parameters.identity_provider_vpc_connection_properties.vpc_connection_arn #=> String
resp.override_parameters.data_sources[0].data_source_parameters.starburst_parameters.o_auth_parameters.identity_provider_resource_uri #=> String
resp.override_parameters.data_sources[0].data_source_parameters.starburst_parameters.o_auth_parameters.identity_provider_ca_certificates_bundle_s3_uri #=> String
resp.override_parameters.data_sources[0].data_source_parameters.trino_parameters.host #=> String
resp.override_parameters.data_sources[0].data_source_parameters.trino_parameters.port #=> Integer
resp.override_parameters.data_sources[0].data_source_parameters.trino_parameters.catalog #=> String
resp.override_parameters.data_sources[0].data_source_parameters.big_query_parameters.project_id #=> String
resp.override_parameters.data_sources[0].data_source_parameters.big_query_parameters.data_set_region #=> String
resp.override_parameters.data_sources[0].data_source_parameters.impala_parameters.host #=> String
resp.override_parameters.data_sources[0].data_source_parameters.impala_parameters.port #=> Integer
resp.override_parameters.data_sources[0].data_source_parameters.impala_parameters.database #=> String
resp.override_parameters.data_sources[0].data_source_parameters.impala_parameters.sql_endpoint_path #=> String
resp.override_parameters.data_sources[0].data_source_parameters.custom_connection_parameters.connection_type #=> String
resp.override_parameters.data_sources[0].data_source_parameters.web_crawler_parameters.web_crawler_auth_type #=> String, one of "NO_AUTH", "BASIC_AUTH", "FORM", "SAML"
resp.override_parameters.data_sources[0].data_source_parameters.web_crawler_parameters.username_field_xpath #=> String
resp.override_parameters.data_sources[0].data_source_parameters.web_crawler_parameters.password_field_xpath #=> String
resp.override_parameters.data_sources[0].data_source_parameters.web_crawler_parameters.username_button_xpath #=> String
resp.override_parameters.data_sources[0].data_source_parameters.web_crawler_parameters.password_button_xpath #=> String
resp.override_parameters.data_sources[0].data_source_parameters.web_crawler_parameters.login_page_url #=> String
resp.override_parameters.data_sources[0].data_source_parameters.web_crawler_parameters.web_proxy_host_name #=> String
resp.override_parameters.data_sources[0].data_source_parameters.web_crawler_parameters.web_proxy_port_number #=> Integer
resp.override_parameters.data_sources[0].data_source_parameters.confluence_parameters.confluence_url #=> String
resp.override_parameters.data_sources[0].data_source_parameters.q_business_parameters.application_arn #=> String
resp.override_parameters.data_sources[0].data_source_parameters.share_point_parameters.share_point_domain #=> String
resp.override_parameters.data_sources[0].data_source_parameters.share_point_parameters.tenant_id #=> String
resp.override_parameters.data_sources[0].data_source_parameters.share_point_parameters.client_id #=> String
resp.override_parameters.data_sources[0].data_source_parameters.share_point_parameters.auth_type #=> String, one of "THREE_LEGGED_OAUTH", "TWO_LEGGED_OAUTH", "SERVICE_ACCOUNT"
resp.override_parameters.data_sources[0].data_source_parameters.google_drive_parameters.auth_type #=> String, one of "THREE_LEGGED_OAUTH", "TWO_LEGGED_OAUTH", "SERVICE_ACCOUNT"
resp.override_parameters.data_sources[0].data_source_parameters.one_drive_parameters.tenant_id #=> String
resp.override_parameters.data_sources[0].data_source_parameters.one_drive_parameters.client_id #=> String
resp.override_parameters.data_sources[0].data_source_parameters.one_drive_parameters.auth_type #=> String, one of "THREE_LEGGED_OAUTH", "TWO_LEGGED_OAUTH", "SERVICE_ACCOUNT"
resp.override_parameters.data_sources[0].data_source_parameters.fmkb_parameters.knowledge_base_arn #=> String
resp.override_parameters.data_sources[0].data_source_parameters.fmkb_parameters.linked_data_source_ids #=> Array
resp.override_parameters.data_sources[0].data_source_parameters.fmkb_parameters.linked_data_source_ids[0] #=> String
resp.override_parameters.data_sources[0].vpc_connection_properties.vpc_connection_arn #=> String
resp.override_parameters.data_sources[0].ssl_properties.disable_ssl #=> Boolean
resp.override_parameters.data_sources[0].credentials.credential_pair.username #=> String
resp.override_parameters.data_sources[0].credentials.credential_pair.password #=> String
resp.override_parameters.data_sources[0].credentials.secret_arn #=> String
resp.override_parameters.data_sets #=> Array
resp.override_parameters.data_sets[0].data_set_id #=> String
resp.override_parameters.data_sets[0].name #=> String
resp.override_parameters.data_sets[0].data_set_refresh_properties.refresh_configuration.incremental_refresh.lookback_window.column_name #=> String
resp.override_parameters.data_sets[0].data_set_refresh_properties.refresh_configuration.incremental_refresh.lookback_window.size #=> Integer
resp.override_parameters.data_sets[0].data_set_refresh_properties.refresh_configuration.incremental_refresh.lookback_window.size_unit #=> String, one of "HOUR", "DAY", "WEEK"
resp.override_parameters.data_sets[0].data_set_refresh_properties.failure_configuration.email_alert.alert_status #=> String, one of "ENABLED", "DISABLED"
resp.override_parameters.themes #=> Array
resp.override_parameters.themes[0].theme_id #=> String
resp.override_parameters.themes[0].name #=> String
resp.override_parameters.analyses #=> Array
resp.override_parameters.analyses[0].analysis_id #=> String
resp.override_parameters.analyses[0].name #=> String
resp.override_parameters.dashboards #=> Array
resp.override_parameters.dashboards[0].dashboard_id #=> String
resp.override_parameters.dashboards[0].name #=> String
resp.override_parameters.folders #=> Array
resp.override_parameters.folders[0].folder_id #=> String
resp.override_parameters.folders[0].name #=> String
resp.override_parameters.folders[0].parent_folder_arn #=> String
resp.override_parameters.topics_v2 #=> Array
resp.override_parameters.topics_v2[0].topic_id #=> String
resp.override_parameters.topics_v2[0].name #=> String
resp.override_parameters.topics_v2[0].description #=> String
resp.failure_action #=> String, one of "DO_NOTHING", "ROLLBACK"
resp.request_id #=> String
resp.status #=> Integer
resp.override_permissions.data_sources #=> Array
resp.override_permissions.data_sources[0].data_source_ids #=> Array
resp.override_permissions.data_sources[0].data_source_ids[0] #=> String
resp.override_permissions.data_sources[0].permissions.principals #=> Array
resp.override_permissions.data_sources[0].permissions.principals[0] #=> String
resp.override_permissions.data_sources[0].permissions.actions #=> Array
resp.override_permissions.data_sources[0].permissions.actions[0] #=> String
resp.override_permissions.data_sets #=> Array
resp.override_permissions.data_sets[0].data_set_ids #=> Array
resp.override_permissions.data_sets[0].data_set_ids[0] #=> String
resp.override_permissions.data_sets[0].permissions.principals #=> Array
resp.override_permissions.data_sets[0].permissions.principals[0] #=> String
resp.override_permissions.data_sets[0].permissions.actions #=> Array
resp.override_permissions.data_sets[0].permissions.actions[0] #=> String
resp.override_permissions.themes #=> Array
resp.override_permissions.themes[0].theme_ids #=> Array
resp.override_permissions.themes[0].theme_ids[0] #=> String
resp.override_permissions.themes[0].permissions.principals #=> Array
resp.override_permissions.themes[0].permissions.principals[0] #=> String
resp.override_permissions.themes[0].permissions.actions #=> Array
resp.override_permissions.themes[0].permissions.actions[0] #=> String
resp.override_permissions.analyses #=> Array
resp.override_permissions.analyses[0].analysis_ids #=> Array
resp.override_permissions.analyses[0].analysis_ids[0] #=> String
resp.override_permissions.analyses[0].permissions.principals #=> Array
resp.override_permissions.analyses[0].permissions.principals[0] #=> String
resp.override_permissions.analyses[0].permissions.actions #=> Array
resp.override_permissions.analyses[0].permissions.actions[0] #=> String
resp.override_permissions.dashboards #=> Array
resp.override_permissions.dashboards[0].dashboard_ids #=> Array
resp.override_permissions.dashboards[0].dashboard_ids[0] #=> String
resp.override_permissions.dashboards[0].permissions.principals #=> Array
resp.override_permissions.dashboards[0].permissions.principals[0] #=> String
resp.override_permissions.dashboards[0].permissions.actions #=> Array
resp.override_permissions.dashboards[0].permissions.actions[0] #=> String
resp.override_permissions.dashboards[0].link_sharing_configuration.permissions.principals #=> Array
resp.override_permissions.dashboards[0].link_sharing_configuration.permissions.principals[0] #=> String
resp.override_permissions.dashboards[0].link_sharing_configuration.permissions.actions #=> Array
resp.override_permissions.dashboards[0].link_sharing_configuration.permissions.actions[0] #=> String
resp.override_permissions.folders #=> Array
resp.override_permissions.folders[0].folder_ids #=> Array
resp.override_permissions.folders[0].folder_ids[0] #=> String
resp.override_permissions.folders[0].permissions.principals #=> Array
resp.override_permissions.folders[0].permissions.principals[0] #=> String
resp.override_permissions.folders[0].permissions.actions #=> Array
resp.override_permissions.folders[0].permissions.actions[0] #=> String
resp.override_permissions.topics_v2 #=> Array
resp.override_permissions.topics_v2[0].topic_ids #=> Array
resp.override_permissions.topics_v2[0].topic_ids[0] #=> String
resp.override_permissions.topics_v2[0].permissions.principals #=> Array
resp.override_permissions.topics_v2[0].permissions.principals[0] #=> String
resp.override_permissions.topics_v2[0].permissions.actions #=> Array
resp.override_permissions.topics_v2[0].permissions.actions[0] #=> String
resp.override_tags.vpc_connections #=> Array
resp.override_tags.vpc_connections[0].vpc_connection_ids #=> Array
resp.override_tags.vpc_connections[0].vpc_connection_ids[0] #=> String
resp.override_tags.vpc_connections[0].tags #=> Array
resp.override_tags.vpc_connections[0].tags[0].key #=> String
resp.override_tags.vpc_connections[0].tags[0].value #=> String
resp.override_tags.data_sources #=> Array
resp.override_tags.data_sources[0].data_source_ids #=> Array
resp.override_tags.data_sources[0].data_source_ids[0] #=> String
resp.override_tags.data_sources[0].tags #=> Array
resp.override_tags.data_sources[0].tags[0].key #=> String
resp.override_tags.data_sources[0].tags[0].value #=> String
resp.override_tags.data_sets #=> Array
resp.override_tags.data_sets[0].data_set_ids #=> Array
resp.override_tags.data_sets[0].data_set_ids[0] #=> String
resp.override_tags.data_sets[0].tags #=> Array
resp.override_tags.data_sets[0].tags[0].key #=> String
resp.override_tags.data_sets[0].tags[0].value #=> String
resp.override_tags.themes #=> Array
resp.override_tags.themes[0].theme_ids #=> Array
resp.override_tags.themes[0].theme_ids[0] #=> String
resp.override_tags.themes[0].tags #=> Array
resp.override_tags.themes[0].tags[0].key #=> String
resp.override_tags.themes[0].tags[0].value #=> String
resp.override_tags.analyses #=> Array
resp.override_tags.analyses[0].analysis_ids #=> Array
resp.override_tags.analyses[0].analysis_ids[0] #=> String
resp.override_tags.analyses[0].tags #=> Array
resp.override_tags.analyses[0].tags[0].key #=> String
resp.override_tags.analyses[0].tags[0].value #=> String
resp.override_tags.dashboards #=> Array
resp.override_tags.dashboards[0].dashboard_ids #=> Array
resp.override_tags.dashboards[0].dashboard_ids[0] #=> String
resp.override_tags.dashboards[0].tags #=> Array
resp.override_tags.dashboards[0].tags[0].key #=> String
resp.override_tags.dashboards[0].tags[0].value #=> String
resp.override_tags.folders #=> Array
resp.override_tags.folders[0].folder_ids #=> Array
resp.override_tags.folders[0].folder_ids[0] #=> String
resp.override_tags.folders[0].tags #=> Array
resp.override_tags.folders[0].tags[0].key #=> String
resp.override_tags.folders[0].tags[0].value #=> String
resp.override_tags.topics_v2 #=> Array
resp.override_tags.topics_v2[0].topic_ids #=> Array
resp.override_tags.topics_v2[0].topic_ids[0] #=> String
resp.override_tags.topics_v2[0].tags #=> Array
resp.override_tags.topics_v2[0].tags[0].key #=> String
resp.override_tags.topics_v2[0].tags[0].value #=> String
resp.override_validation_strategy.strict_mode_for_all_resources #=> Boolean
resp.warnings #=> Array
resp.warnings[0].arn #=> String
resp.warnings[0].message #=> String

Parameters:

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

Options Hash (params):

:aws_account_id (required, String) —
The ID of the Amazon Web Services account the import job was executed in.
:asset_bundle_import_job_id (required, String) —
The ID of the job. The job ID is set when you start a new job with a StartAssetBundleImportJob API call.

Returns:

(Types::DescribeAssetBundleImportJobResponse) —
Returns a response object which responds to the following methods:
- #job_status => String
- #errors => Array<Types::AssetBundleImportJobError>
- #rollback_errors => Array<Types::AssetBundleImportJobError>
- #arn => String
- #created_time => Time
- #asset_bundle_import_job_id => String
- #aws_account_id => String
- #asset_bundle_import_source => Types::AssetBundleImportSourceDescription
- #override_parameters => Types::AssetBundleImportJobOverrideParameters
- #failure_action => String
- #request_id => String
- #status => Integer
- #override_permissions => Types::AssetBundleImportJobOverridePermissions
- #override_tags => Types::AssetBundleImportJobOverrideTags
- #override_validation_strategy => Types::AssetBundleImportJobOverrideValidationStrategy
- #warnings => Array<Types::AssetBundleImportJobWarning>

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 9246

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

#describe_automation_job(params = {}) ⇒ `Types::DescribeAutomationJobResponse`

Retrieves the status and details of a specified automation job, including its status and outputs.

Examples:

Request syntax with placeholder values


resp = client.describe_automation_job({
  aws_account_id: "AwsAccountId", # required
  automation_group_id: "AutomateId", # required
  automation_id: "AutomateId", # required
  include_input_payload: false,
  include_output_payload: false,
  job_id: "AutomateId", # required
})

Response structure


resp.arn #=> String
resp.created_at #=> Time
resp.started_at #=> Time
resp.ended_at #=> Time
resp.job_status #=> String, one of "FAILED", "RUNNING", "SUCCEEDED", "QUEUED", "STOPPED"
resp.input_payload #=> String
resp.output_payload #=> String
resp.request_id #=> String

Parameters:

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

Options Hash (params):

:aws_account_id (required, String) —
The ID of the Amazon Web Services account that contains the automation job.
:automation_group_id (required, String) —
The ID of the automation group that contains the automation.
:automation_id (required, String) —
The ID of the automation that the job belongs to.
:include_input_payload (Boolean) —
A Boolean value that indicates whether to include the input payload in the response. If set to true, the input payload will be included. If set to false, the input payload will be returned as null.
:include_output_payload (Boolean) —
A Boolean value that indicates whether to include the output payload in the response. If set to true, the output payload will be included. If set to false, the output payload will be returned as null.
:job_id (required, String) —
The ID of the automation job to describe.

Returns:

(Types::DescribeAutomationJobResponse) —
Returns a response object which responds to the following methods:
- #arn => String
- #created_at => Time
- #started_at => Time
- #ended_at => Time
- #job_status => String
- #input_payload => String
- #output_payload => String
- #request_id => String

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 9315

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

#describe_brand(params = {}) ⇒ `Types::DescribeBrandResponse`

Describes a brand.

Examples:

Request syntax with placeholder values


resp = client.describe_brand({
  aws_account_id: "AwsAccountId", # required
  brand_id: "ShortRestrictiveResourceId", # required
  version_id: "ShortRestrictiveResourceId",
})

Response structure


resp.request_id #=> String
resp.brand_detail.brand_id #=> String
resp.brand_detail.arn #=> String
resp.brand_detail.brand_status #=> String, one of "CREATE_IN_PROGRESS", "CREATE_SUCCEEDED", "CREATE_FAILED", "DELETE_IN_PROGRESS", "DELETE_FAILED"
resp.brand_detail.created_time #=> Time
resp.brand_detail.last_updated_time #=> Time
resp.brand_detail.version_id #=> String
resp.brand_detail.version_status #=> String, one of "CREATE_IN_PROGRESS", "CREATE_SUCCEEDED", "CREATE_FAILED"
resp.brand_detail.errors #=> Array
resp.brand_detail.errors[0] #=> String
resp.brand_detail.logo.alt_text #=> String
resp.brand_detail.logo.logo_set.primary.original.source.public_url #=> String
resp.brand_detail.logo.logo_set.primary.original.source.s3_uri #=> String
resp.brand_detail.logo.logo_set.primary.original.generated_image_url #=> String
resp.brand_detail.logo.logo_set.primary.height_64.source.public_url #=> String
resp.brand_detail.logo.logo_set.primary.height_64.source.s3_uri #=> String
resp.brand_detail.logo.logo_set.primary.height_64.generated_image_url #=> String
resp.brand_detail.logo.logo_set.primary.height_32.source.public_url #=> String
resp.brand_detail.logo.logo_set.primary.height_32.source.s3_uri #=> String
resp.brand_detail.logo.logo_set.primary.height_32.generated_image_url #=> String
resp.brand_detail.logo.logo_set.favicon.original.source.public_url #=> String
resp.brand_detail.logo.logo_set.favicon.original.source.s3_uri #=> String
resp.brand_detail.logo.logo_set.favicon.original.generated_image_url #=> String
resp.brand_detail.logo.logo_set.favicon.height_64.source.public_url #=> String
resp.brand_detail.logo.logo_set.favicon.height_64.source.s3_uri #=> String
resp.brand_detail.logo.logo_set.favicon.height_64.generated_image_url #=> String
resp.brand_detail.logo.logo_set.favicon.height_32.source.public_url #=> String
resp.brand_detail.logo.logo_set.favicon.height_32.source.s3_uri #=> String
resp.brand_detail.logo.logo_set.favicon.height_32.generated_image_url #=> String
resp.brand_definition.brand_name #=> String
resp.brand_definition.description #=> String
resp.brand_definition.application_theme.brand_color_palette.primary.foreground #=> String
resp.brand_definition.application_theme.brand_color_palette.primary.background #=> String
resp.brand_definition.application_theme.brand_color_palette.secondary.foreground #=> String
resp.brand_definition.application_theme.brand_color_palette.secondary.background #=> String
resp.brand_definition.application_theme.brand_color_palette.accent.foreground #=> String
resp.brand_definition.application_theme.brand_color_palette.accent.background #=> String
resp.brand_definition.application_theme.brand_color_palette.measure.foreground #=> String
resp.brand_definition.application_theme.brand_color_palette.measure.background #=> String
resp.brand_definition.application_theme.brand_color_palette.dimension.foreground #=> String
resp.brand_definition.application_theme.brand_color_palette.dimension.background #=> String
resp.brand_definition.application_theme.brand_color_palette.success.foreground #=> String
resp.brand_definition.application_theme.brand_color_palette.success.background #=> String
resp.brand_definition.application_theme.brand_color_palette.info.foreground #=> String
resp.brand_definition.application_theme.brand_color_palette.info.background #=> String
resp.brand_definition.application_theme.brand_color_palette.warning.foreground #=> String
resp.brand_definition.application_theme.brand_color_palette.warning.background #=> String
resp.brand_definition.application_theme.brand_color_palette.danger.foreground #=> String
resp.brand_definition.application_theme.brand_color_palette.danger.background #=> String
resp.brand_definition.application_theme.contextual_accent_palette.connection.foreground #=> String
resp.brand_definition.application_theme.contextual_accent_palette.connection.background #=> String
resp.brand_definition.application_theme.contextual_accent_palette.visualization.foreground #=> String
resp.brand_definition.application_theme.contextual_accent_palette.visualization.background #=> String
resp.brand_definition.application_theme.contextual_accent_palette.insight.foreground #=> String
resp.brand_definition.application_theme.contextual_accent_palette.insight.background #=> String
resp.brand_definition.application_theme.contextual_accent_palette.automation.foreground #=> String
resp.brand_definition.application_theme.contextual_accent_palette.automation.background #=> String
resp.brand_definition.application_theme.brand_element_style.navbar_style.global_navbar.foreground #=> String
resp.brand_definition.application_theme.brand_element_style.navbar_style.global_navbar.background #=> String
resp.brand_definition.application_theme.brand_element_style.navbar_style.contextual_navbar.foreground #=> String
resp.brand_definition.application_theme.brand_element_style.navbar_style.contextual_navbar.background #=> String
resp.brand_definition.logo_configuration.alt_text #=> String
resp.brand_definition.logo_configuration.logo_set.primary.original.source.public_url #=> String
resp.brand_definition.logo_configuration.logo_set.primary.original.source.s3_uri #=> String
resp.brand_definition.logo_configuration.logo_set.favicon.original.source.public_url #=> String
resp.brand_definition.logo_configuration.logo_set.favicon.original.source.s3_uri #=> String

Parameters:

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

Options Hash (params):

:aws_account_id (required, String) —
The ID of the Amazon Web Services account that owns the brand.
:brand_id (required, String) —
The ID of the Quick brand.
:version_id (String) —
The ID of the specific version. The default value is the latest version.

Returns:

(Types::DescribeBrandResponse) —
Returns a response object which responds to the following methods:
- #request_id => String
- #brand_detail => Types::BrandDetail
- #brand_definition => Types::BrandDefinition

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 9419

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

#describe_brand_assignment(params = {}) ⇒ `Types::DescribeBrandAssignmentResponse`

Describes a brand assignment.

Examples:

Request syntax with placeholder values


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

Response structure


resp.request_id #=> String
resp.brand_arn #=> String

Parameters:

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

Options Hash (params):

:aws_account_id (required, String) —
The ID of the Amazon Web Services account that owns the brand assignment.

Returns:

(Types::DescribeBrandAssignmentResponse) —
Returns a response object which responds to the following methods:
- #request_id => String
- #brand_arn => String

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 9450

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

#describe_brand_published_version(params = {}) ⇒ `Types::DescribeBrandPublishedVersionResponse`

Describes the published version of the brand.

Examples:

Request syntax with placeholder values


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

Response structure


resp.request_id #=> String
resp.brand_detail.brand_id #=> String
resp.brand_detail.arn #=> String
resp.brand_detail.brand_status #=> String, one of "CREATE_IN_PROGRESS", "CREATE_SUCCEEDED", "CREATE_FAILED", "DELETE_IN_PROGRESS", "DELETE_FAILED"
resp.brand_detail.created_time #=> Time
resp.brand_detail.last_updated_time #=> Time
resp.brand_detail.version_id #=> String
resp.brand_detail.version_status #=> String, one of "CREATE_IN_PROGRESS", "CREATE_SUCCEEDED", "CREATE_FAILED"
resp.brand_detail.errors #=> Array
resp.brand_detail.errors[0] #=> String
resp.brand_detail.logo.alt_text #=> String
resp.brand_detail.logo.logo_set.primary.original.source.public_url #=> String
resp.brand_detail.logo.logo_set.primary.original.source.s3_uri #=> String
resp.brand_detail.logo.logo_set.primary.original.generated_image_url #=> String
resp.brand_detail.logo.logo_set.primary.height_64.source.public_url #=> String
resp.brand_detail.logo.logo_set.primary.height_64.source.s3_uri #=> String
resp.brand_detail.logo.logo_set.primary.height_64.generated_image_url #=> String
resp.brand_detail.logo.logo_set.primary.height_32.source.public_url #=> String
resp.brand_detail.logo.logo_set.primary.height_32.source.s3_uri #=> String
resp.brand_detail.logo.logo_set.primary.height_32.generated_image_url #=> String
resp.brand_detail.logo.logo_set.favicon.original.source.public_url #=> String
resp.brand_detail.logo.logo_set.favicon.original.source.s3_uri #=> String
resp.brand_detail.logo.logo_set.favicon.original.generated_image_url #=> String
resp.brand_detail.logo.logo_set.favicon.height_64.source.public_url #=> String
resp.brand_detail.logo.logo_set.favicon.height_64.source.s3_uri #=> String
resp.brand_detail.logo.logo_set.favicon.height_64.generated_image_url #=> String
resp.brand_detail.logo.logo_set.favicon.height_32.source.public_url #=> String
resp.brand_detail.logo.logo_set.favicon.height_32.source.s3_uri #=> String
resp.brand_detail.logo.logo_set.favicon.height_32.generated_image_url #=> String
resp.brand_definition.brand_name #=> String
resp.brand_definition.description #=> String
resp.brand_definition.application_theme.brand_color_palette.primary.foreground #=> String
resp.brand_definition.application_theme.brand_color_palette.primary.background #=> String
resp.brand_definition.application_theme.brand_color_palette.secondary.foreground #=> String
resp.brand_definition.application_theme.brand_color_palette.secondary.background #=> String
resp.brand_definition.application_theme.brand_color_palette.accent.foreground #=> String
resp.brand_definition.application_theme.brand_color_palette.accent.background #=> String
resp.brand_definition.application_theme.brand_color_palette.measure.foreground #=> String
resp.brand_definition.application_theme.brand_color_palette.measure.background #=> String
resp.brand_definition.application_theme.brand_color_palette.dimension.foreground #=> String
resp.brand_definition.application_theme.brand_color_palette.dimension.background #=> String
resp.brand_definition.application_theme.brand_color_palette.success.foreground #=> String
resp.brand_definition.application_theme.brand_color_palette.success.background #=> String
resp.brand_definition.application_theme.brand_color_palette.info.foreground #=> String
resp.brand_definition.application_theme.brand_color_palette.info.background #=> String
resp.brand_definition.application_theme.brand_color_palette.warning.foreground #=> String
resp.brand_definition.application_theme.brand_color_palette.warning.background #=> String
resp.brand_definition.application_theme.brand_color_palette.danger.foreground #=> String
resp.brand_definition.application_theme.brand_color_palette.danger.background #=> String
resp.brand_definition.application_theme.contextual_accent_palette.connection.foreground #=> String
resp.brand_definition.application_theme.contextual_accent_palette.connection.background #=> String
resp.brand_definition.application_theme.contextual_accent_palette.visualization.foreground #=> String
resp.brand_definition.application_theme.contextual_accent_palette.visualization.background #=> String
resp.brand_definition.application_theme.contextual_accent_palette.insight.foreground #=> String
resp.brand_definition.application_theme.contextual_accent_palette.insight.background #=> String
resp.brand_definition.application_theme.contextual_accent_palette.automation.foreground #=> String
resp.brand_definition.application_theme.contextual_accent_palette.automation.background #=> String
resp.brand_definition.application_theme.brand_element_style.navbar_style.global_navbar.foreground #=> String
resp.brand_definition.application_theme.brand_element_style.navbar_style.global_navbar.background #=> String
resp.brand_definition.application_theme.brand_element_style.navbar_style.contextual_navbar.foreground #=> String
resp.brand_definition.application_theme.brand_element_style.navbar_style.contextual_navbar.background #=> String
resp.brand_definition.logo_configuration.alt_text #=> String
resp.brand_definition.logo_configuration.logo_set.primary.original.source.public_url #=> String
resp.brand_definition.logo_configuration.logo_set.primary.original.source.s3_uri #=> String
resp.brand_definition.logo_configuration.logo_set.favicon.original.source.public_url #=> String
resp.brand_definition.logo_configuration.logo_set.favicon.original.source.s3_uri #=> String

Parameters:

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

Options Hash (params):

:aws_account_id (required, String) —
The ID of the Amazon Web Services account that owns the brand.
:brand_id (required, String) —
The ID of the Quick brand.

Returns:

(Types::DescribeBrandPublishedVersionResponse) —
Returns a response object which responds to the following methods:
- #request_id => String
- #brand_detail => Types::BrandDetail
- #brand_definition => Types::BrandDefinition

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 9549

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

#describe_custom_permissions(params = {}) ⇒ `Types::DescribeCustomPermissionsResponse`

Describes a custom permissions profile.

Examples:

Request syntax with placeholder values


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

Response structure


resp.status #=> Integer
resp.custom_permissions.arn #=> String
resp.custom_permissions.custom_permissions_name #=> String
resp.custom_permissions.capabilities.export_to_csv #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.export_to_excel #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.export_to_pdf #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.print_reports #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.create_and_update_themes #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.add_or_run_anomaly_detection_for_analyses #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.share_analyses #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.create_and_update_datasets #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.share_datasets #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.subscribe_dashboard_email_reports #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.create_and_update_dashboard_email_reports #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.share_dashboards #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.create_and_update_threshold_alerts #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.rename_shared_folders #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.create_shared_folders #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.create_and_update_data_sources #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.share_data_sources #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.view_account_spice_capacity #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.create_spice_dataset #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.export_to_pdf_in_scheduled_reports #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.export_to_csv_in_scheduled_reports #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.export_to_excel_in_scheduled_reports #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.include_content_in_scheduled_reports_email #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.dashboard #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.analysis #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.automate #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.flow #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.apps #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.create_and_update_apps #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.share_apps #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.invoke_apps_ai_inference #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.access_apps_native_data_store #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.publish_without_approval #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.use_bedrock_models #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.perform_flow_ui_task #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.approve_flow_share_requests #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.use_agent_web_search #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.knowledge_base #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.create_and_update_knowledge_bases #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.share_knowledge_bases #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.share_point_knowledge_base #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.create_and_update_share_point_knowledge_base #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.share_share_point_knowledge_base #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.use_share_point_knowledge_base #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.google_drive_knowledge_base #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.create_and_update_google_drive_knowledge_base #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.share_google_drive_knowledge_base #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.use_google_drive_knowledge_base #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.web_crawler_knowledge_base #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.create_and_update_web_crawler_knowledge_base #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.share_web_crawler_knowledge_base #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.use_web_crawler_knowledge_base #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.s3_knowledge_base #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.create_and_update_s3_knowledge_base #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.share_s3_knowledge_base #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.use_s3_knowledge_base #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.confluence_knowledge_base #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.create_and_update_confluence_knowledge_base #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.share_confluence_knowledge_base #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.use_confluence_knowledge_base #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.one_drive_knowledge_base #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.create_and_update_one_drive_knowledge_base #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.share_one_drive_knowledge_base #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.use_one_drive_knowledge_base #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.q_business_knowledge_base #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.create_and_update_q_business_knowledge_base #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.share_q_business_knowledge_base #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.use_q_business_knowledge_base #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.bedrock_managed_knowledge_base #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.create_and_update_bedrock_managed_knowledge_base #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.share_bedrock_managed_knowledge_base #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.use_bedrock_managed_knowledge_base #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.box_knowledge_base #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.create_and_update_box_knowledge_base #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.share_box_knowledge_base #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.use_box_knowledge_base #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.idc_knowledge_base #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.create_and_update_idc_knowledge_base #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.share_idc_knowledge_base #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.use_idc_knowledge_base #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.generic_http_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.create_and_update_generic_http_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.share_generic_http_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.use_generic_http_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.asana_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.create_and_update_asana_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.share_asana_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.use_asana_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.slack_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.create_and_update_slack_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.share_slack_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.use_slack_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.service_now_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.create_and_update_service_now_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.share_service_now_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.use_service_now_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.salesforce_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.create_and_update_salesforce_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.share_salesforce_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.use_salesforce_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.ms_exchange_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.create_and_update_ms_exchange_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.share_ms_exchange_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.use_ms_exchange_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.pager_duty_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.create_and_update_pager_duty_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.share_pager_duty_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.use_pager_duty_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.jira_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.create_and_update_jira_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.share_jira_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.use_jira_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.confluence_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.create_and_update_confluence_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.share_confluence_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.use_confluence_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.one_drive_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.create_and_update_one_drive_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.share_one_drive_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.use_one_drive_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.share_point_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.create_and_update_share_point_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.share_share_point_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.use_share_point_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.ms_teams_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.create_and_update_ms_teams_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.share_ms_teams_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.use_ms_teams_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.google_calendar_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.create_and_update_google_calendar_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.share_google_calendar_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.use_google_calendar_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.zendesk_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.create_and_update_zendesk_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.share_zendesk_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.use_zendesk_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.smartsheet_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.create_and_update_smartsheet_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.share_smartsheet_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.use_smartsheet_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.sap_business_partner_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.create_and_update_sap_business_partner_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.share_sap_business_partner_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.use_sap_business_partner_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.sap_product_master_data_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.create_and_update_sap_product_master_data_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.share_sap_product_master_data_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.use_sap_product_master_data_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.sap_physical_inventory_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.create_and_update_sap_physical_inventory_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.share_sap_physical_inventory_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.use_sap_physical_inventory_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.sap_bill_of_material_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.create_and_update_sap_bill_of_material_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.share_sap_bill_of_material_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.use_sap_bill_of_material_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.sap_material_stock_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.create_and_update_sap_material_stock_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.share_sap_material_stock_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.use_sap_material_stock_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.fact_set_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.create_and_update_fact_set_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.share_fact_set_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.use_fact_set_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.amazon_s_three_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.create_and_update_amazon_s_three_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.share_amazon_s_three_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.use_amazon_s_three_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.textract_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.create_and_update_textract_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.share_textract_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.use_textract_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.comprehend_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.create_and_update_comprehend_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.share_comprehend_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.use_comprehend_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.comprehend_medical_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.create_and_update_comprehend_medical_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.share_comprehend_medical_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.use_comprehend_medical_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.amazon_bedrock_ars_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.create_and_update_amazon_bedrock_ars_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.share_amazon_bedrock_ars_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.use_amazon_bedrock_ars_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.amazon_bedrock_fs_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.create_and_update_amazon_bedrock_fs_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.share_amazon_bedrock_fs_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.use_amazon_bedrock_fs_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.amazon_bedrock_krs_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.create_and_update_amazon_bedrock_krs_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.share_amazon_bedrock_krs_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.use_amazon_bedrock_krs_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.mcp_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.create_and_update_mcp_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.share_mcp_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.use_mcp_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.open_api_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.create_and_update_open_api_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.share_open_api_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.use_open_api_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.sand_pgmi_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.create_and_update_sand_pgmi_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.share_sand_pgmi_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.use_sand_pgmi_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.sand_p_global_energy_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.create_and_update_sand_p_global_energy_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.share_sand_p_global_energy_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.use_sand_p_global_energy_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.bamboo_hr_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.create_and_update_bamboo_hr_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.share_bamboo_hr_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.use_bamboo_hr_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.box_agent_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.create_and_update_box_agent_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.share_box_agent_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.use_box_agent_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.canva_agent_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.create_and_update_canva_agent_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.share_canva_agent_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.use_canva_agent_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.github_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.create_and_update_github_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.share_github_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.use_github_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.notion_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.create_and_update_notion_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.share_notion_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.use_notion_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.linear_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.create_and_update_linear_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.share_linear_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.use_linear_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.hugging_face_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.create_and_update_hugging_face_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.share_hugging_face_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.use_hugging_face_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.monday_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.create_and_update_monday_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.share_monday_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.use_monday_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.hubspot_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.create_and_update_hubspot_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.share_hubspot_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.use_hubspot_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.intercom_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.create_and_update_intercom_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.share_intercom_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.use_intercom_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.new_relic_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.create_and_update_new_relic_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.share_new_relic_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.use_new_relic_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.topic #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.edit_visual_with_q #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.build_calculated_field_with_q #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.create_dashboard_executive_summary_with_q #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.space #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.create_spaces #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.share_spaces #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.chat_agent #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.create_chat_agents #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.share_chat_agents #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.research #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.self_upgrade_user_role #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.extension #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.use_browser_extension #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.use_word_add_in_extension #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.use_outlook_add_in_extension #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.use_excel_add_in_extension #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.use_powerpoint_add_in_extension #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.manage_shared_folders #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.generate_analyses #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.story #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.scenario #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.trigger #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.schedule_trigger #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.inbound_email_trigger #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.capabilities.quick_event_trigger #=> String, one of "DENY", "ALLOW"
resp.custom_permissions.governance.default_category_effects #=> Hash
resp.custom_permissions.governance.default_category_effects["GovernanceCategoryName"] #=> String, one of "DENY_BY_DEFAULT"
resp.request_id #=> String

Parameters:

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

Options Hash (params):

:aws_account_id (required, String) —
The ID of the Amazon Web Services account that contains the custom permissions profile that you want described.
:custom_permissions_name (required, String) —
The name of the custom permissions profile to describe.

Returns:

(Types::DescribeCustomPermissionsResponse) —
Returns a response object which responds to the following methods:
- #status => Integer
- #custom_permissions => Types::CustomPermissions
- #request_id => String

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 9868

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

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

Provides a summary for a dashboard.

Examples:

Request syntax with placeholder values


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

Response structure


resp.dashboard.dashboard_id #=> String
resp.dashboard.arn #=> String
resp.dashboard.name #=> String
resp.dashboard.version.created_time #=> Time
resp.dashboard.version.errors #=> Array
resp.dashboard.version.errors[0].type #=> String, one of "ACCESS_DENIED", "SOURCE_NOT_FOUND", "DATA_SET_NOT_FOUND", "INTERNAL_FAILURE", "PARAMETER_VALUE_INCOMPATIBLE", "PARAMETER_TYPE_INVALID", "PARAMETER_NOT_FOUND", "COLUMN_TYPE_MISMATCH", "COLUMN_GEOGRAPHIC_ROLE_MISMATCH", "COLUMN_REPLACEMENT_MISSING"
resp.dashboard.version.errors[0].message #=> String
resp.dashboard.version.errors[0].violated_entities #=> Array
resp.dashboard.version.errors[0].violated_entities[0].path #=> String
resp.dashboard.version.version_number #=> Integer
resp.dashboard.version.status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED", "DELETED"
resp.dashboard.version.arn #=> String
resp.dashboard.version.source_entity_arn #=> String
resp.dashboard.version.data_set_arns #=> Array
resp.dashboard.version.data_set_arns[0] #=> String
resp.dashboard.version.topic_arns #=> Array
resp.dashboard.version.topic_arns[0] #=> String
resp.dashboard.version.description #=> String
resp.dashboard.version.theme_arn #=> String
resp.dashboard.version.sheets #=> Array
resp.dashboard.version.sheets[0].sheet_id #=> String
resp.dashboard.version.sheets[0].name #=> String
resp.dashboard.version.sheets[0].images #=> Array
resp.dashboard.version.sheets[0].images[0].sheet_image_id #=> String
resp.dashboard.version.sheets[0].images[0].source.sheet_image_static_file_source.static_file_id #=> String
resp.dashboard.version.sheets[0].images[0].scaling.scaling_type #=> String, one of "SCALE_TO_WIDTH", "SCALE_TO_HEIGHT", "SCALE_TO_CONTAINER", "SCALE_NONE"
resp.dashboard.version.sheets[0].images[0].tooltip.tooltip_text.plain_text #=> String
resp.dashboard.version.sheets[0].images[0].tooltip.visibility #=> String, one of "HIDDEN", "VISIBLE"
resp.dashboard.version.sheets[0].images[0].image_content_alt_text #=> String
resp.dashboard.version.sheets[0].images[0].interactions.image_menu_option.availability_status #=> String, one of "ENABLED", "DISABLED"
resp.dashboard.version.sheets[0].images[0].actions #=> Array
resp.dashboard.version.sheets[0].images[0].actions[0].custom_action_id #=> String
resp.dashboard.version.sheets[0].images[0].actions[0].name #=> String
resp.dashboard.version.sheets[0].images[0].actions[0].status #=> String, one of "ENABLED", "DISABLED"
resp.dashboard.version.sheets[0].images[0].actions[0].trigger #=> String, one of "CLICK", "MENU"
resp.dashboard.version.sheets[0].images[0].actions[0].action_operations #=> Array
resp.dashboard.version.sheets[0].images[0].actions[0].action_operations[0].navigation_operation.local_navigation_configuration.target_sheet_id #=> String
resp.dashboard.version.sheets[0].images[0].actions[0].action_operations[0].url_operation.url_template #=> String
resp.dashboard.version.sheets[0].images[0].actions[0].action_operations[0].url_operation.url_target #=> String, one of "NEW_TAB", "NEW_WINDOW", "SAME_TAB"
resp.dashboard.version.sheets[0].images[0].actions[0].action_operations[0].set_parameters_operation.parameter_value_configurations #=> Array
resp.dashboard.version.sheets[0].images[0].actions[0].action_operations[0].set_parameters_operation.parameter_value_configurations[0].destination_parameter_name #=> String
resp.dashboard.version.sheets[0].images[0].actions[0].action_operations[0].set_parameters_operation.parameter_value_configurations[0].value.custom_values_configuration.include_null_value #=> Boolean
resp.dashboard.version.sheets[0].images[0].actions[0].action_operations[0].set_parameters_operation.parameter_value_configurations[0].value.custom_values_configuration.custom_values.string_values #=> Array
resp.dashboard.version.sheets[0].images[0].actions[0].action_operations[0].set_parameters_operation.parameter_value_configurations[0].value.custom_values_configuration.custom_values.string_values[0] #=> String
resp.dashboard.version.sheets[0].images[0].actions[0].action_operations[0].set_parameters_operation.parameter_value_configurations[0].value.custom_values_configuration.custom_values.integer_values #=> Array
resp.dashboard.version.sheets[0].images[0].actions[0].action_operations[0].set_parameters_operation.parameter_value_configurations[0].value.custom_values_configuration.custom_values.integer_values[0] #=> Integer
resp.dashboard.version.sheets[0].images[0].actions[0].action_operations[0].set_parameters_operation.parameter_value_configurations[0].value.custom_values_configuration.custom_values.decimal_values #=> Array
resp.dashboard.version.sheets[0].images[0].actions[0].action_operations[0].set_parameters_operation.parameter_value_configurations[0].value.custom_values_configuration.custom_values.decimal_values[0] #=> Float
resp.dashboard.version.sheets[0].images[0].actions[0].action_operations[0].set_parameters_operation.parameter_value_configurations[0].value.custom_values_configuration.custom_values.date_time_values #=> Array
resp.dashboard.version.sheets[0].images[0].actions[0].action_operations[0].set_parameters_operation.parameter_value_configurations[0].value.custom_values_configuration.custom_values.date_time_values[0] #=> Time
resp.dashboard.version.sheets[0].images[0].actions[0].action_operations[0].set_parameters_operation.parameter_value_configurations[0].value.select_all_value_options #=> String, one of "ALL_VALUES"
resp.dashboard.version.sheets[0].images[0].actions[0].action_operations[0].set_parameters_operation.parameter_value_configurations[0].value.source_parameter_name #=> String
resp.dashboard.version.sheets[0].images[0].actions[0].action_operations[0].set_parameters_operation.parameter_value_configurations[0].value.source_field #=> String
resp.dashboard.version.sheets[0].images[0].actions[0].action_operations[0].set_parameters_operation.parameter_value_configurations[0].value.source_column.data_set_identifier #=> String
resp.dashboard.version.sheets[0].images[0].actions[0].action_operations[0].set_parameters_operation.parameter_value_configurations[0].value.source_column.topic_identifier #=> String
resp.dashboard.version.sheets[0].images[0].actions[0].action_operations[0].set_parameters_operation.parameter_value_configurations[0].value.source_column.column_name #=> String
resp.dashboard.created_time #=> Time
resp.dashboard.last_published_time #=> Time
resp.dashboard.last_updated_time #=> Time
resp.dashboard.link_entities #=> Array
resp.dashboard.link_entities[0] #=> String
resp.status #=> Integer
resp.request_id #=> String

Parameters:

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

Options Hash (params):

:aws_account_id (required, String) —
The ID of the Amazon Web Services account that contains the dashboard that you're describing.
:dashboard_id (required, String) —
The ID for the dashboard.
:version_number (Integer) —
The version number for the dashboard. If a version number isn't passed, the latest published dashboard version is described.
:alias_name (String) —
The alias name.

Returns:

(Types::DescribeDashboardResponse) —
Returns a response object which responds to the following methods:
- #dashboard => Types::Dashboard
- #status => Integer
- #request_id => String

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 9974

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

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

Provides a detailed description of the definition of a dashboard.

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

Examples:

Request syntax with placeholder values


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

Parameters:

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

Options Hash (params):

:aws_account_id (required, String) —
The ID of the Amazon Web Services account that contains the dashboard that you're describing.
:dashboard_id (required, String) —
The ID for the dashboard.
:version_number (Integer) —
The version number for the dashboard. If a version number isn't passed, the latest published dashboard version is described.
:alias_name (String) —
The alias name.

Returns:

(Types::DescribeDashboardDefinitionResponse) —
Returns a response object which responds to the following methods:
- #dashboard_id => String
- #errors => Array<Types::DashboardError>
- #name => String
- #resource_status => String
- #theme_arn => String
- #definition => Types::DashboardVersionDefinition
- #status => Integer
- #request_id => String
- #dashboard_publish_options => Types::DashboardPublishOptions

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 10031

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

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

Describes read and write permissions for a dashboard.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

Options Hash (params):

:aws_account_id (required, String) —
The ID of the Amazon Web Services account that contains the dashboard that you're describing permissions for.
:dashboard_id (required, String) —
The ID for the dashboard, also added to the IAM policy.

Returns:

(Types::DescribeDashboardPermissionsResponse) —
Returns a response object which responds to the following methods:
- #dashboard_id => String
- #dashboard_arn => String
- #permissions => Array<Types::ResourcePermission>
- #status => Integer
- #request_id => String
- #link_sharing_configuration => Types::LinkSharingConfiguration

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 10080

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

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

Describes an existing snapshot job.

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

Registered user support

This API can be called as before to get status of a job started by the same Quick Sight user.

Possible error scenarios

Request will fail with an Access Denied error in the following scenarios:

The credentials have expired.
Job has been started by a different user.
Impersonated Quick Sight user doesn't have access to the specified dashboard in the job.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

Options Hash (params):

:aws_account_id (required, String) —
The ID of the Amazon Web Services account that the dashboard snapshot job is executed in.
:dashboard_id (required, String) —
The ID of the dashboard that you have started a snapshot job for.
:snapshot_job_id (required, String) —
The ID of the job to be described. The job ID is set when you start a new job with a StartDashboardSnapshotJob API call.

Returns:

(Types::DescribeDashboardSnapshotJobResponse) —
Returns a response object which responds to the following methods:
- #aws_account_id => String
- #dashboard_id => String
- #snapshot_job_id => String
- #user_configuration => Types::SnapshotUserConfigurationRedacted
- #snapshot_configuration => Types::SnapshotConfiguration
- #arn => String
- #job_status => String
- #created_time => Time
- #last_updated_time => Time
- #request_id => String
- #status => Integer

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 10187

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

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

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

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

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

Registered user support

This API can be called as before to get the result of a job started by the same Quick Sight user. The result for the user will be returned in RegisteredUsers response attribute. The attribute will contain a list with at most one object in it.

Possible error scenarios

The request fails with an Access Denied error in the following scenarios:

The credentials have expired.
The job was started by a different user.
The registered user doesn't have access to the specified dashboard.

The request succeeds but the job fails in the following scenarios:

DASHBOARD_ACCESS_DENIED - The registered user lost access to the dashboard.
CAPABILITY_RESTRICTED - The registered user is restricted from exporting data in all selected formats.

The request succeeds but the response contains an error code in the following scenarios:

CAPABILITY_RESTRICTED - The registered user is restricted from exporting data in some selected formats.
RLS_CHANGED - Row-level security settings have changed. Re-run the job with current settings.
CLS_CHANGED - Column-level security settings have changed. Re-run the job with current settings.
DATASET_DELETED - The dataset has been deleted. Verify the dataset exists before re-running the job.

Examples:

Request syntax with placeholder values


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

Response structure


resp.arn #=> String
resp.job_status #=> String, one of "QUEUED", "RUNNING", "COMPLETED", "FAILED"
resp.created_time #=> Time
resp.last_updated_time #=> Time
resp.result.anonymous_users #=> Array
resp.result.anonymous_users[0].file_groups #=> Array
resp.result.anonymous_users[0].file_groups[0].files #=> Array
resp.result.anonymous_users[0].file_groups[0].files[0].sheet_selections #=> Array
resp.result.anonymous_users[0].file_groups[0].files[0].sheet_selections[0].sheet_id #=> String
resp.result.anonymous_users[0].file_groups[0].files[0].sheet_selections[0].selection_scope #=> String, one of "ALL_VISUALS", "SELECTED_VISUALS"
resp.result.anonymous_users[0].file_groups[0].files[0].sheet_selections[0].visual_ids #=> Array
resp.result.anonymous_users[0].file_groups[0].files[0].sheet_selections[0].visual_ids[0] #=> String
resp.result.anonymous_users[0].file_groups[0].files[0].format_type #=> String, one of "CSV", "PDF", "EXCEL"
resp.result.anonymous_users[0].file_groups[0].s3_results #=> Array
resp.result.anonymous_users[0].file_groups[0].s3_results[0].s3_destination_configuration.bucket_configuration.bucket_name #=> String
resp.result.anonymous_users[0].file_groups[0].s3_results[0].s3_destination_configuration.bucket_configuration.bucket_prefix #=> String
resp.result.anonymous_users[0].file_groups[0].s3_results[0].s3_destination_configuration.bucket_configuration.bucket_region #=> String
resp.result.anonymous_users[0].file_groups[0].s3_results[0].s3_uri #=> String
resp.result.anonymous_users[0].file_groups[0].s3_results[0].error_info #=> Array
resp.result.anonymous_users[0].file_groups[0].s3_results[0].error_info[0].error_message #=> String
resp.result.anonymous_users[0].file_groups[0].s3_results[0].error_info[0].error_type #=> String
resp.result.registered_users #=> Array
resp.result.registered_users[0].file_groups #=> Array
resp.result.registered_users[0].file_groups[0].files #=> Array
resp.result.registered_users[0].file_groups[0].files[0].sheet_selections #=> Array
resp.result.registered_users[0].file_groups[0].files[0].sheet_selections[0].sheet_id #=> String
resp.result.registered_users[0].file_groups[0].files[0].sheet_selections[0].selection_scope #=> String, one of "ALL_VISUALS", "SELECTED_VISUALS"
resp.result.registered_users[0].file_groups[0].files[0].sheet_selections[0].visual_ids #=> Array
resp.result.registered_users[0].file_groups[0].files[0].sheet_selections[0].visual_ids[0] #=> String
resp.result.registered_users[0].file_groups[0].files[0].format_type #=> String, one of "CSV", "PDF", "EXCEL"
resp.result.registered_users[0].file_groups[0].s3_results #=> Array
resp.result.registered_users[0].file_groups[0].s3_results[0].s3_destination_configuration.bucket_configuration.bucket_name #=> String
resp.result.registered_users[0].file_groups[0].s3_results[0].s3_destination_configuration.bucket_configuration.bucket_prefix #=> String
resp.result.registered_users[0].file_groups[0].s3_results[0].s3_destination_configuration.bucket_configuration.bucket_region #=> String
resp.result.registered_users[0].file_groups[0].s3_results[0].s3_uri #=> String
resp.result.registered_users[0].file_groups[0].s3_results[0].error_info #=> Array
resp.result.registered_users[0].file_groups[0].s3_results[0].error_info[0].error_message #=> String
resp.result.registered_users[0].file_groups[0].s3_results[0].error_info[0].error_type #=> String
resp.error_info.error_message #=> String
resp.error_info.error_type #=> String
resp.request_id #=> String
resp.status #=> Integer

Parameters:

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

Options Hash (params):

:aws_account_id (required, String) —
The ID of the Amazon Web Services account that the dashboard snapshot job is executed in.
:dashboard_id (required, String) —
The ID of the dashboard that you have started a snapshot job for.
:snapshot_job_id (required, String) —
The ID of the job to be described. The job ID is set when you start a new job with a StartDashboardSnapshotJob API call.

Returns:

(Types::DescribeDashboardSnapshotJobResultResponse) —
Returns a response object which responds to the following methods:
- #arn => String
- #job_status => String
- #created_time => Time
- #last_updated_time => Time
- #result => Types::SnapshotJobResult
- #error_info => Types::SnapshotJobErrorInfo
- #request_id => String
- #status => Integer

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 10322

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

#describe_dashboards_qa_configuration(params = {}) ⇒ `Types::DescribeDashboardsQAConfigurationResponse`

Describes an existing dashboard QA configuration.

Examples:

Request syntax with placeholder values


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

Response structure


resp.dashboards_qa_status #=> String, one of "ENABLED", "DISABLED"
resp.request_id #=> String
resp.status #=> Integer

Parameters:

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

Options Hash (params):

:aws_account_id (required, String) —
The ID of the Amazon Web Services account that contains the dashboard QA configuration that you want described.

Returns:

(Types::DescribeDashboardsQAConfigurationResponse) —
Returns a response object which responds to the following methods:
- #dashboards_qa_status => String
- #request_id => String
- #status => Integer

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 10355

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

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

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

Examples:

Request syntax with placeholder values


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

Response structure


resp.data_set.arn #=> String
resp.data_set.data_set_id #=> String
resp.data_set.name #=> String
resp.data_set.created_time #=> Time
resp.data_set.last_updated_time #=> Time
resp.data_set.physical_table_map #=> Hash
resp.data_set.physical_table_map["PhysicalTableId"].relational_table.data_source_arn #=> String
resp.data_set.physical_table_map["PhysicalTableId"].relational_table.catalog #=> String
resp.data_set.physical_table_map["PhysicalTableId"].relational_table.schema #=> String
resp.data_set.physical_table_map["PhysicalTableId"].relational_table.name #=> String
resp.data_set.physical_table_map["PhysicalTableId"].relational_table.input_columns #=> Array
resp.data_set.physical_table_map["PhysicalTableId"].relational_table.input_columns[0].name #=> String
resp.data_set.physical_table_map["PhysicalTableId"].relational_table.input_columns[0].id #=> String
resp.data_set.physical_table_map["PhysicalTableId"].relational_table.input_columns[0].type #=> String, one of "STRING", "INTEGER", "DECIMAL", "DATETIME", "BIT", "BOOLEAN", "JSON", "SEMISTRUCT"
resp.data_set.physical_table_map["PhysicalTableId"].relational_table.input_columns[0].sub_type #=> String, one of "FLOAT", "FIXED"
resp.data_set.physical_table_map["PhysicalTableId"].custom_sql.data_source_arn #=> String
resp.data_set.physical_table_map["PhysicalTableId"].custom_sql.name #=> String
resp.data_set.physical_table_map["PhysicalTableId"].custom_sql.sql_query #=> String
resp.data_set.physical_table_map["PhysicalTableId"].custom_sql.columns #=> Array
resp.data_set.physical_table_map["PhysicalTableId"].custom_sql.columns[0].name #=> String
resp.data_set.physical_table_map["PhysicalTableId"].custom_sql.columns[0].id #=> String
resp.data_set.physical_table_map["PhysicalTableId"].custom_sql.columns[0].type #=> String, one of "STRING", "INTEGER", "DECIMAL", "DATETIME", "BIT", "BOOLEAN", "JSON", "SEMISTRUCT"
resp.data_set.physical_table_map["PhysicalTableId"].custom_sql.columns[0].sub_type #=> String, one of "FLOAT", "FIXED"
resp.data_set.physical_table_map["PhysicalTableId"].s3_source.data_source_arn #=> String
resp.data_set.physical_table_map["PhysicalTableId"].s3_source.upload_settings.format #=> String, one of "CSV", "TSV", "CLF", "ELF", "XLSX", "JSON"
resp.data_set.physical_table_map["PhysicalTableId"].s3_source.upload_settings.start_from_row #=> Integer
resp.data_set.physical_table_map["PhysicalTableId"].s3_source.upload_settings.contains_header #=> Boolean
resp.data_set.physical_table_map["PhysicalTableId"].s3_source.upload_settings.text_qualifier #=> String, one of "DOUBLE_QUOTE", "SINGLE_QUOTE"
resp.data_set.physical_table_map["PhysicalTableId"].s3_source.upload_settings.delimiter #=> String
resp.data_set.physical_table_map["PhysicalTableId"].s3_source.upload_settings.custom_cell_address_range #=> 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].id #=> String
resp.data_set.physical_table_map["PhysicalTableId"].s3_source.input_columns[0].type #=> String, one of "STRING", "INTEGER", "DECIMAL", "DATETIME", "BIT", "BOOLEAN", "JSON", "SEMISTRUCT"
resp.data_set.physical_table_map["PhysicalTableId"].s3_source.input_columns[0].sub_type #=> String, one of "FLOAT", "FIXED"
resp.data_set.physical_table_map["PhysicalTableId"].saa_s_table.data_source_arn #=> String
resp.data_set.physical_table_map["PhysicalTableId"].saa_s_table.table_path #=> Array
resp.data_set.physical_table_map["PhysicalTableId"].saa_s_table.table_path[0].name #=> String
resp.data_set.physical_table_map["PhysicalTableId"].saa_s_table.table_path[0].id #=> String
resp.data_set.physical_table_map["PhysicalTableId"].saa_s_table.input_columns #=> Array
resp.data_set.physical_table_map["PhysicalTableId"].saa_s_table.input_columns[0].name #=> String
resp.data_set.physical_table_map["PhysicalTableId"].saa_s_table.input_columns[0].id #=> String
resp.data_set.physical_table_map["PhysicalTableId"].saa_s_table.input_columns[0].type #=> String, one of "STRING", "INTEGER", "DECIMAL", "DATETIME", "BIT", "BOOLEAN", "JSON", "SEMISTRUCT"
resp.data_set.physical_table_map["PhysicalTableId"].saa_s_table.input_columns[0].sub_type #=> String, one of "FLOAT", "FIXED"
resp.data_set.physical_table_map["PhysicalTableId"].file_source.data_source_arn #=> String
resp.data_set.physical_table_map["PhysicalTableId"].file_source.upload_settings.format #=> String, one of "CSV", "TSV", "CLF", "ELF", "XLSX", "JSON"
resp.data_set.physical_table_map["PhysicalTableId"].file_source.upload_settings.start_from_row #=> Integer
resp.data_set.physical_table_map["PhysicalTableId"].file_source.upload_settings.contains_header #=> Boolean
resp.data_set.physical_table_map["PhysicalTableId"].file_source.upload_settings.text_qualifier #=> String, one of "DOUBLE_QUOTE", "SINGLE_QUOTE"
resp.data_set.physical_table_map["PhysicalTableId"].file_source.upload_settings.delimiter #=> String
resp.data_set.physical_table_map["PhysicalTableId"].file_source.upload_settings.custom_cell_address_range #=> String
resp.data_set.physical_table_map["PhysicalTableId"].file_source.sheet_index #=> Integer
resp.data_set.physical_table_map["PhysicalTableId"].file_source.input_columns #=> Array
resp.data_set.physical_table_map["PhysicalTableId"].file_source.input_columns[0].name #=> String
resp.data_set.physical_table_map["PhysicalTableId"].file_source.input_columns[0].id #=> String
resp.data_set.physical_table_map["PhysicalTableId"].file_source.input_columns[0].type #=> String, one of "STRING", "INTEGER", "DECIMAL", "DATETIME", "BIT", "BOOLEAN", "JSON", "SEMISTRUCT"
resp.data_set.physical_table_map["PhysicalTableId"].file_source.input_columns[0].sub_type #=> String, one of "FLOAT", "FIXED"
resp.data_set.logical_table_map #=> Hash
resp.data_set.logical_table_map["LogicalTableId"].alias #=> String
resp.data_set.logical_table_map["LogicalTableId"].data_transforms #=> Array
resp.data_set.logical_table_map["LogicalTableId"].data_transforms[0].project_operation.alias #=> String
resp.data_set.logical_table_map["LogicalTableId"].data_transforms[0].project_operation.source.transform_operation_id #=> String
resp.data_set.logical_table_map["LogicalTableId"].data_transforms[0].project_operation.source.column_id_mappings #=> Array
resp.data_set.logical_table_map["LogicalTableId"].data_transforms[0].project_operation.source.column_id_mappings[0].source_column_id #=> String
resp.data_set.logical_table_map["LogicalTableId"].data_transforms[0].project_operation.source.column_id_mappings[0].target_column_id #=> String
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].filter_operation.string_filter_condition.column_name #=> String
resp.data_set.logical_table_map["LogicalTableId"].data_transforms[0].filter_operation.string_filter_condition.comparison_filter_condition.operator #=> String, one of "EQUALS", "DOES_NOT_EQUAL", "CONTAINS", "DOES_NOT_CONTAIN", "STARTS_WITH", "ENDS_WITH"
resp.data_set.logical_table_map["LogicalTableId"].data_transforms[0].filter_operation.string_filter_condition.comparison_filter_condition.value.static_value #=> String
resp.data_set.logical_table_map["LogicalTableId"].data_transforms[0].filter_operation.string_filter_condition.list_filter_condition.operator #=> String, one of "INCLUDE", "EXCLUDE"
resp.data_set.logical_table_map["LogicalTableId"].data_transforms[0].filter_operation.string_filter_condition.list_filter_condition.values.static_values #=> Array
resp.data_set.logical_table_map["LogicalTableId"].data_transforms[0].filter_operation.string_filter_condition.list_filter_condition.values.static_values[0] #=> String
resp.data_set.logical_table_map["LogicalTableId"].data_transforms[0].filter_operation.numeric_filter_condition.column_name #=> String
resp.data_set.logical_table_map["LogicalTableId"].data_transforms[0].filter_operation.numeric_filter_condition.comparison_filter_condition.operator #=> String, one of "EQUALS", "DOES_NOT_EQUAL", "GREATER_THAN", "GREATER_THAN_OR_EQUALS_TO", "LESS_THAN", "LESS_THAN_OR_EQUALS_TO"
resp.data_set.logical_table_map["LogicalTableId"].data_transforms[0].filter_operation.numeric_filter_condition.comparison_filter_condition.value.static_value #=> Float
resp.data_set.logical_table_map["LogicalTableId"].data_transforms[0].filter_operation.numeric_filter_condition.range_filter_condition.range_minimum.static_value #=> Float
resp.data_set.logical_table_map["LogicalTableId"].data_transforms[0].filter_operation.numeric_filter_condition.range_filter_condition.range_maximum.static_value #=> Float
resp.data_set.logical_table_map["LogicalTableId"].data_transforms[0].filter_operation.numeric_filter_condition.range_filter_condition.include_minimum #=> Boolean
resp.data_set.logical_table_map["LogicalTableId"].data_transforms[0].filter_operation.numeric_filter_condition.range_filter_condition.include_maximum #=> Boolean
resp.data_set.logical_table_map["LogicalTableId"].data_transforms[0].filter_operation.date_filter_condition.column_name #=> String
resp.data_set.logical_table_map["LogicalTableId"].data_transforms[0].filter_operation.date_filter_condition.comparison_filter_condition.operator #=> String, one of "BEFORE", "BEFORE_OR_EQUALS_TO", "AFTER", "AFTER_OR_EQUALS_TO"
resp.data_set.logical_table_map["LogicalTableId"].data_transforms[0].filter_operation.date_filter_condition.comparison_filter_condition.value.static_value #=> Time
resp.data_set.logical_table_map["LogicalTableId"].data_transforms[0].filter_operation.date_filter_condition.range_filter_condition.range_minimum.static_value #=> Time
resp.data_set.logical_table_map["LogicalTableId"].data_transforms[0].filter_operation.date_filter_condition.range_filter_condition.range_maximum.static_value #=> Time
resp.data_set.logical_table_map["LogicalTableId"].data_transforms[0].filter_operation.date_filter_condition.range_filter_condition.include_minimum #=> Boolean
resp.data_set.logical_table_map["LogicalTableId"].data_transforms[0].filter_operation.date_filter_condition.range_filter_condition.include_maximum #=> Boolean
resp.data_set.logical_table_map["LogicalTableId"].data_transforms[0].create_columns_operation.alias #=> String
resp.data_set.logical_table_map["LogicalTableId"].data_transforms[0].create_columns_operation.source.transform_operation_id #=> String
resp.data_set.logical_table_map["LogicalTableId"].data_transforms[0].create_columns_operation.source.column_id_mappings #=> Array
resp.data_set.logical_table_map["LogicalTableId"].data_transforms[0].create_columns_operation.source.column_id_mappings[0].source_column_id #=> String
resp.data_set.logical_table_map["LogicalTableId"].data_transforms[0].create_columns_operation.source.column_id_mappings[0].target_column_id #=> String
resp.data_set.logical_table_map["LogicalTableId"].data_transforms[0].create_columns_operation.columns #=> Array
resp.data_set.logical_table_map["LogicalTableId"].data_transforms[0].create_columns_operation.columns[0].column_name #=> String
resp.data_set.logical_table_map["LogicalTableId"].data_transforms[0].create_columns_operation.columns[0].column_id #=> String
resp.data_set.logical_table_map["LogicalTableId"].data_transforms[0].create_columns_operation.columns[0].expression #=> String
resp.data_set.logical_table_map["LogicalTableId"].data_transforms[0].rename_column_operation.column_name #=> String
resp.data_set.logical_table_map["LogicalTableId"].data_transforms[0].rename_column_operation.new_column_name #=> String
resp.data_set.logical_table_map["LogicalTableId"].data_transforms[0].cast_column_type_operation.column_name #=> String
resp.data_set.logical_table_map["LogicalTableId"].data_transforms[0].cast_column_type_operation.new_column_type #=> String, one of "STRING", "INTEGER", "DECIMAL", "DATETIME"
resp.data_set.logical_table_map["LogicalTableId"].data_transforms[0].cast_column_type_operation.sub_type #=> String, one of "FLOAT", "FIXED"
resp.data_set.logical_table_map["LogicalTableId"].data_transforms[0].cast_column_type_operation.format #=> String
resp.data_set.logical_table_map["LogicalTableId"].data_transforms[0].tag_column_operation.column_name #=> String
resp.data_set.logical_table_map["LogicalTableId"].data_transforms[0].tag_column_operation.tags #=> Array
resp.data_set.logical_table_map["LogicalTableId"].data_transforms[0].tag_column_operation.tags[0].column_geographic_role #=> String, one of "COUNTRY", "STATE", "COUNTY", "CITY", "POSTCODE", "LONGITUDE", "LATITUDE"
resp.data_set.logical_table_map["LogicalTableId"].data_transforms[0].tag_column_operation.tags[0].column_description.text #=> String
resp.data_set.logical_table_map["LogicalTableId"].data_transforms[0].untag_column_operation.column_name #=> String
resp.data_set.logical_table_map["LogicalTableId"].data_transforms[0].untag_column_operation.tag_names #=> Array
resp.data_set.logical_table_map["LogicalTableId"].data_transforms[0].untag_column_operation.tag_names[0] #=> String, one of "COLUMN_GEOGRAPHIC_ROLE", "COLUMN_DESCRIPTION"
resp.data_set.logical_table_map["LogicalTableId"].data_transforms[0].override_dataset_parameter_operation.parameter_name #=> String
resp.data_set.logical_table_map["LogicalTableId"].data_transforms[0].override_dataset_parameter_operation.new_parameter_name #=> String
resp.data_set.logical_table_map["LogicalTableId"].data_transforms[0].override_dataset_parameter_operation.new_default_values.string_static_values #=> Array
resp.data_set.logical_table_map["LogicalTableId"].data_transforms[0].override_dataset_parameter_operation.new_default_values.string_static_values[0] #=> String
resp.data_set.logical_table_map["LogicalTableId"].data_transforms[0].override_dataset_parameter_operation.new_default_values.decimal_static_values #=> Array
resp.data_set.logical_table_map["LogicalTableId"].data_transforms[0].override_dataset_parameter_operation.new_default_values.decimal_static_values[0] #=> Float
resp.data_set.logical_table_map["LogicalTableId"].data_transforms[0].override_dataset_parameter_operation.new_default_values.date_time_static_values #=> Array
resp.data_set.logical_table_map["LogicalTableId"].data_transforms[0].override_dataset_parameter_operation.new_default_values.date_time_static_values[0] #=> Time
resp.data_set.logical_table_map["LogicalTableId"].data_transforms[0].override_dataset_parameter_operation.new_default_values.integer_static_values #=> Array
resp.data_set.logical_table_map["LogicalTableId"].data_transforms[0].override_dataset_parameter_operation.new_default_values.integer_static_values[0] #=> Integer
resp.data_set.logical_table_map["LogicalTableId"].source.join_instruction.left_operand #=> String
resp.data_set.logical_table_map["LogicalTableId"].source.join_instruction.right_operand #=> String
resp.data_set.logical_table_map["LogicalTableId"].source.join_instruction.left_join_key_properties.unique_key #=> Boolean
resp.data_set.logical_table_map["LogicalTableId"].source.join_instruction.right_join_key_properties.unique_key #=> Boolean
resp.data_set.logical_table_map["LogicalTableId"].source.join_instruction.type #=> String, one of "INNER", "OUTER", "LEFT", "RIGHT"
resp.data_set.logical_table_map["LogicalTableId"].source.join_instruction.on_clause #=> String
resp.data_set.logical_table_map["LogicalTableId"].source.physical_table_id #=> String
resp.data_set.logical_table_map["LogicalTableId"].source.data_set_arn #=> String
resp.data_set.output_columns #=> Array
resp.data_set.output_columns[0].name #=> String
resp.data_set.output_columns[0].id #=> String
resp.data_set.output_columns[0].description #=> String
resp.data_set.output_columns[0].type #=> String, one of "STRING", "INTEGER", "DECIMAL", "DATETIME"
resp.data_set.output_columns[0].sub_type #=> String, one of "FLOAT", "FIXED"
resp.data_set.import_mode #=> String, one of "SPICE", "DIRECT_QUERY"
resp.data_set.consumed_spice_capacity_in_bytes #=> Integer
resp.data_set.column_groups #=> Array
resp.data_set.column_groups[0].geo_spatial_column_group.name #=> String
resp.data_set.column_groups[0].geo_spatial_column_group.country_code #=> String, one of "US"
resp.data_set.column_groups[0].geo_spatial_column_group.columns #=> Array
resp.data_set.column_groups[0].geo_spatial_column_group.columns[0] #=> String
resp.data_set.field_folders #=> Hash
resp.data_set.field_folders["FieldFolderPath"].description #=> String
resp.data_set.field_folders["FieldFolderPath"].columns #=> Array
resp.data_set.field_folders["FieldFolderPath"].columns[0] #=> String
resp.data_set.row_level_permission_data_set.namespace #=> String
resp.data_set.row_level_permission_data_set.arn #=> String
resp.data_set.row_level_permission_data_set.permission_policy #=> String, one of "GRANT_ACCESS", "DENY_ACCESS"
resp.data_set.row_level_permission_data_set.format_version #=> String, one of "VERSION_1", "VERSION_2"
resp.data_set.row_level_permission_data_set.status #=> String, one of "ENABLED", "DISABLED"
resp.data_set.row_level_permission_tag_configuration.status #=> String, one of "ENABLED", "DISABLED"
resp.data_set.row_level_permission_tag_configuration.tag_rules #=> Array
resp.data_set.row_level_permission_tag_configuration.tag_rules[0].tag_key #=> String
resp.data_set.row_level_permission_tag_configuration.tag_rules[0].column_name #=> String
resp.data_set.row_level_permission_tag_configuration.tag_rules[0].tag_multi_value_delimiter #=> String
resp.data_set.row_level_permission_tag_configuration.tag_rules[0].match_all_value #=> String
resp.data_set.row_level_permission_tag_configuration.tag_rule_configurations #=> Array
resp.data_set.row_level_permission_tag_configuration.tag_rule_configurations[0] #=> Array
resp.data_set.row_level_permission_tag_configuration.tag_rule_configurations[0][0] #=> String
resp.data_set.column_level_permission_rules #=> Array
resp.data_set.column_level_permission_rules[0].principals #=> Array
resp.data_set.column_level_permission_rules[0].principals[0] #=> String
resp.data_set.column_level_permission_rules[0].column_names #=> Array
resp.data_set.column_level_permission_rules[0].column_names[0] #=> String
resp.data_set.data_set_usage_configuration.disable_use_as_direct_query_source #=> Boolean
resp.data_set.data_set_usage_configuration.disable_use_as_imported_source #=> Boolean
resp.data_set.dataset_parameters #=> Array
resp.data_set.dataset_parameters[0].string_dataset_parameter.id #=> String
resp.data_set.dataset_parameters[0].string_dataset_parameter.name #=> String
resp.data_set.dataset_parameters[0].string_dataset_parameter.value_type #=> String, one of "MULTI_VALUED", "SINGLE_VALUED"
resp.data_set.dataset_parameters[0].string_dataset_parameter.default_values.static_values #=> Array
resp.data_set.dataset_parameters[0].string_dataset_parameter.default_values.static_values[0] #=> String
resp.data_set.dataset_parameters[0].decimal_dataset_parameter.id #=> String
resp.data_set.dataset_parameters[0].decimal_dataset_parameter.name #=> String
resp.data_set.dataset_parameters[0].decimal_dataset_parameter.value_type #=> String, one of "MULTI_VALUED", "SINGLE_VALUED"
resp.data_set.dataset_parameters[0].decimal_dataset_parameter.default_values.static_values #=> Array
resp.data_set.dataset_parameters[0].decimal_dataset_parameter.default_values.static_values[0] #=> Float
resp.data_set.dataset_parameters[0].integer_dataset_parameter.id #=> String
resp.data_set.dataset_parameters[0].integer_dataset_parameter.name #=> String
resp.data_set.dataset_parameters[0].integer_dataset_parameter.value_type #=> String, one of "MULTI_VALUED", "SINGLE_VALUED"
resp.data_set.dataset_parameters[0].integer_dataset_parameter.default_values.static_values #=> Array
resp.data_set.dataset_parameters[0].integer_dataset_parameter.default_values.static_values[0] #=> Integer
resp.data_set.dataset_parameters[0].date_time_dataset_parameter.id #=> String
resp.data_set.dataset_parameters[0].date_time_dataset_parameter.name #=> String
resp.data_set.dataset_parameters[0].date_time_dataset_parameter.value_type #=> String, one of "MULTI_VALUED", "SINGLE_VALUED"
resp.data_set.dataset_parameters[0].date_time_dataset_parameter.time_granularity #=> String, one of "YEAR", "QUARTER", "MONTH", "WEEK", "DAY", "HOUR", "MINUTE", "SECOND", "MILLISECOND"
resp.data_set.dataset_parameters[0].date_time_dataset_parameter.default_values.static_values #=> Array
resp.data_set.dataset_parameters[0].date_time_dataset_parameter.default_values.static_values[0] #=> Time
resp.data_set.performance_configuration.unique_keys #=> Array
resp.data_set.performance_configuration.unique_keys[0].column_names #=> Array
resp.data_set.performance_configuration.unique_keys[0].column_names[0] #=> String
resp.data_set.use_as #=> String, one of "RLS_RULES"
resp.data_set.data_prep_configuration.source_table_map #=> Hash
resp.data_set.data_prep_configuration.source_table_map["DataSetEntityResourceId"].physical_table_id #=> String
resp.data_set.data_prep_configuration.source_table_map["DataSetEntityResourceId"].data_set.data_set_arn #=> String
resp.data_set.data_prep_configuration.source_table_map["DataSetEntityResourceId"].data_set.input_columns #=> Array
resp.data_set.data_prep_configuration.source_table_map["DataSetEntityResourceId"].data_set.input_columns[0].name #=> String
resp.data_set.data_prep_configuration.source_table_map["DataSetEntityResourceId"].data_set.input_columns[0].id #=> String
resp.data_set.data_prep_configuration.source_table_map["DataSetEntityResourceId"].data_set.input_columns[0].type #=> String, one of "STRING", "INTEGER", "DECIMAL", "DATETIME", "BIT", "BOOLEAN", "JSON", "SEMISTRUCT"
resp.data_set.data_prep_configuration.source_table_map["DataSetEntityResourceId"].data_set.input_columns[0].sub_type #=> String, one of "FLOAT", "FIXED"
resp.data_set.data_prep_configuration.transform_step_map #=> Hash
resp.data_set.data_prep_configuration.transform_step_map["DataSetEntityResourceId"].import_table_step.alias #=> String
resp.data_set.data_prep_configuration.transform_step_map["DataSetEntityResourceId"].import_table_step.source.source_table_id #=> String
resp.data_set.data_prep_configuration.transform_step_map["DataSetEntityResourceId"].import_table_step.source.column_id_mappings #=> Array
resp.data_set.data_prep_configuration.transform_step_map["DataSetEntityResourceId"].import_table_step.source.column_id_mappings[0].source_column_id #=> String
resp.data_set.data_prep_configuration.transform_step_map["DataSetEntityResourceId"].import_table_step.source.column_id_mappings[0].target_column_id #=> String
resp.data_set.data_prep_configuration.transform_step_map["DataSetEntityResourceId"].project_step.alias #=> String
resp.data_set.data_prep_configuration.transform_step_map["DataSetEntityResourceId"].project_step.source.transform_operation_id #=> String
resp.data_set.data_prep_configuration.transform_step_map["DataSetEntityResourceId"].project_step.source.column_id_mappings #=> Array
resp.data_set.data_prep_configuration.transform_step_map["DataSetEntityResourceId"].project_step.source.column_id_mappings[0].source_column_id #=> String
resp.data_set.data_prep_configuration.transform_step_map["DataSetEntityResourceId"].project_step.source.column_id_mappings[0].target_column_id #=> String
resp.data_set.data_prep_configuration.transform_step_map["DataSetEntityResourceId"].project_step.projected_columns #=> Array
resp.data_set.data_prep_configuration.transform_step_map["DataSetEntityResourceId"].project_step.projected_columns[0] #=> String
resp.data_set.data_prep_configuration.transform_step_map["DataSetEntityResourceId"].filters_step.alias #=> String
resp.data_set.data_prep_configuration.transform_step_map["DataSetEntityResourceId"].filters_step.source.transform_operation_id #=> String
resp.data_set.data_prep_configuration.transform_step_map["DataSetEntityResourceId"].filters_step.source.column_id_mappings #=> Array
resp.data_set.data_prep_configuration.transform_step_map["DataSetEntityResourceId"].filters_step.source.column_id_mappings[0].source_column_id #=> String
resp.data_set.data_prep_configuration.transform_step_map["DataSetEntityResourceId"].filters_step.source.column_id_mappings[0].target_column_id #=> String
resp.data_set.data_prep_configuration.transform_step_map["DataSetEntityResourceId"].filters_step.filter_operations #=> Array
resp.data_set.data_prep_configuration.transform_step_map["DataSetEntityResourceId"].filters_step.filter_operations[0].condition_expression #=> String
resp.data_set.data_prep_configuration.transform_step_map["DataSetEntityResourceId"].filters_step.filter_operations[0].string_filter_condition.column_name #=> String
resp.data_set.data_prep_configuration.transform_step_map["DataSetEntityResourceId"].filters_step.filter_operations[0].string_filter_condition.comparison_filter_condition.operator #=> String, one of "EQUALS", "DOES_NOT_EQUAL", "CONTAINS", "DOES_NOT_CONTAIN", "STARTS_WITH", "ENDS_WITH"
resp.data_set.data_prep_configuration.transform_step_map["DataSetEntityResourceId"].filters_step.filter_operations[0].string_filter_condition.comparison_filter_condition.value.static_value #=> String
resp.data_set.data_prep_configuration.transform_step_map["DataSetEntityResourceId"].filters_step.filter_operations[0].string_filter_condition.list_filter_condition.operator #=> String, one of "INCLUDE", "EXCLUDE"
resp.data_set.data_prep_configuration.transform_step_map["DataSetEntityResourceId"].filters_step.filter_operations[0].string_filter_condition.list_filter_condition.values.static_values #=> Array
resp.data_set.data_prep_configuration.transform_step_map["DataSetEntityResourceId"].filters_step.filter_operations[0].string_filter_condition.list_filter_condition.values.static_values[0] #=> String
resp.data_set.data_prep_configuration.transform_step_map["DataSetEntityResourceId"].filters_step.filter_operations[0].numeric_filter_condition.column_name #=> String
resp.data_set.data_prep_configuration.transform_step_map["DataSetEntityResourceId"].filters_step.filter_operations[0].numeric_filter_condition.comparison_filter_condition.operator #=> String, one of "EQUALS", "DOES_NOT_EQUAL", "GREATER_THAN", "GREATER_THAN_OR_EQUALS_TO", "LESS_THAN", "LESS_THAN_OR_EQUALS_TO"
resp.data_set.data_prep_configuration.transform_step_map["DataSetEntityResourceId"].filters_step.filter_operations[0].numeric_filter_condition.comparison_filter_condition.value.static_value #=> Float
resp.data_set.data_prep_configuration.transform_step_map["DataSetEntityResourceId"].filters_step.filter_operations[0].numeric_filter_condition.range_filter_condition.range_minimum.static_value #=> Float
resp.data_set.data_prep_configuration.transform_step_map["DataSetEntityResourceId"].filters_step.filter_operations[0].numeric_filter_condition.range_filter_condition.range_maximum.static_value #=> Float
resp.data_set.data_prep_configuration.transform_step_map["DataSetEntityResourceId"].filters_step.filter_operations[0].numeric_filter_condition.range_filter_condition.include_minimum #=> Boolean
resp.data_set.data_prep_configuration.transform_step_map["DataSetEntityResourceId"].filters_step.filter_operations[0].numeric_filter_condition.range_filter_condition.include_maximum #=> Boolean
resp.data_set.data_prep_configuration.transform_step_map["DataSetEntityResourceId"].filters_step.filter_operations[0].date_filter_condition.column_name #=> String
resp.data_set.data_prep_configuration.transform_step_map["DataSetEntityResourceId"].filters_step.filter_operations[0].date_filter_condition.comparison_filter_condition.operator #=> String, one of "BEFORE", "BEFORE_OR_EQUALS_TO", "AFTER", "AFTER_OR_EQUALS_TO"
resp.data_set.data_prep_configuration.transform_step_map["DataSetEntityResourceId"].filters_step.filter_operations[0].date_filter_condition.comparison_filter_condition.value.static_value #=> Time
resp.data_set.data_prep_configuration.transform_step_map["DataSetEntityResourceId"].filters_step.filter_operations[0].date_filter_condition.range_filter_condition.range_minimum.static_value #=> Time
resp.data_set.data_prep_configuration.transform_step_map["DataSetEntityResourceId"].filters_step.filter_operations[0].date_filter_condition.range_filter_condition.range_maximum.static_value #=> Time
resp.data_set.data_prep_configuration.transform_step_map["DataSetEntityResourceId"].filters_step.filter_operations[0].date_filter_condition.range_filter_condition.include_minimum #=> Boolean
resp.data_set.data_prep_configuration.transform_step_map["DataSetEntityResourceId"].filters_step.filter_operations[0].date_filter_condition.range_filter_condition.include_maximum #=> Boolean
resp.data_set.data_prep_configuration.transform_step_map["DataSetEntityResourceId"].create_columns_step.alias #=> String
resp.data_set.data_prep_configuration.transform_step_map["DataSetEntityResourceId"].create_columns_step.source.transform_operation_id #=> String
resp.data_set.data_prep_configuration.transform_step_map["DataSetEntityResourceId"].create_columns_step.source.column_id_mappings #=> Array
resp.data_set.data_prep_configuration.transform_step_map["DataSetEntityResourceId"].create_columns_step.source.column_id_mappings[0].source_column_id #=> String
resp.data_set.data_prep_configuration.transform_step_map["DataSetEntityResourceId"].create_columns_step.source.column_id_mappings[0].target_column_id #=> String
resp.data_set.data_prep_configuration.transform_step_map["DataSetEntityResourceId"].create_columns_step.columns #=> Array
resp.data_set.data_prep_configuration.transform_step_map["DataSetEntityResourceId"].create_columns_step.columns[0].column_name #=> String
resp.data_set.data_prep_configuration.transform_step_map["DataSetEntityResourceId"].create_columns_step.columns[0].column_id #=> String
resp.data_set.data_prep_configuration.transform_step_map["DataSetEntityResourceId"].create_columns_step.columns[0].expression #=> String
resp.data_set.data_prep_configuration.transform_step_map["DataSetEntityResourceId"].rename_columns_step.alias #=> String
resp.data_set.data_prep_configuration.transform_step_map["DataSetEntityResourceId"].rename_columns_step.source.transform_operation_id #=> String
resp.data_set.data_prep_configuration.transform_step_map["DataSetEntityResourceId"].rename_columns_step.source.column_id_mappings #=> Array
resp.data_set.data_prep_configuration.transform_step_map["DataSetEntityResourceId"].rename_columns_step.source.column_id_mappings[0].source_column_id #=> String
resp.data_set.data_prep_configuration.transform_step_map["DataSetEntityResourceId"].rename_columns_step.source.column_id_mappings[0].target_column_id #=> String
resp.data_set.data_prep_configuration.transform_step_map["DataSetEntityResourceId"].rename_columns_step.rename_column_operations #=> Array
resp.data_set.data_prep_configuration.transform_step_map["DataSetEntityResourceId"].rename_columns_step.rename_column_operations[0].column_name #=> String
resp.data_set.data_prep_configuration.transform_step_map["DataSetEntityResourceId"].rename_columns_step.rename_column_operations[0].new_column_name #=> String
resp.data_set.data_prep_configuration.transform_step_map["DataSetEntityResourceId"].cast_column_types_step.alias #=> String
resp.data_set.data_prep_configuration.transform_step_map["DataSetEntityResourceId"].cast_column_types_step.source.transform_operation_id #=> String
resp.data_set.data_prep_configuration.transform_step_map["DataSetEntityResourceId"].cast_column_types_step.source.column_id_mappings #=> Array
resp.data_set.data_prep_configuration.transform_step_map["DataSetEntityResourceId"].cast_column_types_step.source.column_id_mappings[0].source_column_id #=> String
resp.data_set.data_prep_configuration.transform_step_map["DataSetEntityResourceId"].cast_column_types_step.source.column_id_mappings[0].target_column_id #=> String
resp.data_set.data_prep_configuration.transform_step_map["DataSetEntityResourceId"].cast_column_types_step.cast_column_type_operations #=> Array
resp.data_set.data_prep_configuration.transform_step_map["DataSetEntityResourceId"].cast_column_types_step.cast_column_type_operations[0].column_name #=> String
resp.data_set.data_prep_configuration.transform_step_map["DataSetEntityResourceId"].cast_column_types_step.cast_column_type_operations[0].new_column_type #=> String, one of "STRING", "INTEGER", "DECIMAL", "DATETIME"
resp.data_set.data_prep_configuration.transform_step_map["DataSetEntityResourceId"].cast_column_types_step.cast_column_type_operations[0].sub_type #=> String, one of "FLOAT", "FIXED"
resp.data_set.data_prep_configuration.transform_step_map["DataSetEntityResourceId"].cast_column_types_step.cast_column_type_operations[0].format #=> String
resp.data_set.data_prep_configuration.transform_step_map["DataSetEntityResourceId"].join_step.alias #=> String
resp.data_set.data_prep_configuration.transform_step_map["DataSetEntityResourceId"].join_step.left_operand.transform_operation_id #=> String
resp.data_set.data_prep_configuration.transform_step_map["DataSetEntityResourceId"].join_step.left_operand.column_id_mappings #=> Array
resp.data_set.data_prep_configuration.transform_step_map["DataSetEntityResourceId"].join_step.left_operand.column_id_mappings[0].source_column_id #=> String
resp.data_set.data_prep_configuration.transform_step_map["DataSetEntityResourceId"].join_step.left_operand.column_id_mappings[0].target_column_id #=> String
resp.data_set.data_prep_configuration.transform_step_map["DataSetEntityResourceId"].join_step.right_operand.transform_operation_id #=> String
resp.data_set.data_prep_configuration.transform_step_map["DataSetEntityResourceId"].join_step.right_operand.column_id_mappings #=> Array
resp.data_set.data_prep_configuration.transform_step_map["DataSetEntityResourceId"].join_step.right_operand.column_id_mappings[0].source_column_id #=> String
resp.data_set.data_prep_configuration.transform_step_map["DataSetEntityResourceId"].join_step.right_operand.column_id_mappings[0].target_column_id #=> String
resp.data_set.data_prep_configuration.transform_step_map["DataSetEntityResourceId"].join_step.type #=> String, one of "INNER", "OUTER", "LEFT", "RIGHT"
resp.data_set.data_prep_configuration.transform_step_map["DataSetEntityResourceId"].join_step.on_clause #=> String
resp.data_set.data_prep_configuration.transform_step_map["DataSetEntityResourceId"].join_step.left_operand_properties.output_column_name_overrides #=> Array
resp.data_set.data_prep_configuration.transform_step_map["DataSetEntityResourceId"].join_step.left_operand_properties.output_column_name_overrides[0].source_column_name #=> String
resp.data_set.data_prep_configuration.transform_step_map["DataSetEntityResourceId"].join_step.left_operand_properties.output_column_name_overrides[0].output_column_name #=> String
resp.data_set.data_prep_configuration.transform_step_map["DataSetEntityResourceId"].join_step.right_operand_properties.output_column_name_overrides #=> Array
resp.data_set.data_prep_configuration.transform_step_map["DataSetEntityResourceId"].join_step.right_operand_properties.output_column_name_overrides[0].source_column_name #=> String
resp.data_set.data_prep_configuration.transform_step_map["DataSetEntityResourceId"].join_step.right_operand_properties.output_column_name_overrides[0].output_column_name #=> String
resp.data_set.data_prep_configuration.transform_step_map["DataSetEntityResourceId"].aggregate_step.alias #=> String
resp.data_set.data_prep_configuration.transform_step_map["DataSetEntityResourceId"].aggregate_step.source.transform_operation_id #=> String
resp.data_set.data_prep_configuration.transform_step_map["DataSetEntityResourceId"].aggregate_step.source.column_id_mappings #=> Array
resp.data_set.data_prep_configuration.transform_step_map["DataSetEntityResourceId"].aggregate_step.source.column_id_mappings[0].source_column_id #=> String
resp.data_set.data_prep_configuration.transform_step_map["DataSetEntityResourceId"].aggregate_step.source.column_id_mappings[0].target_column_id #=> String
resp.data_set.data_prep_configuration.transform_step_map["DataSetEntityResourceId"].aggregate_step.group_by_column_names #=> Array
resp.data_set.data_prep_configuration.transform_step_map["DataSetEntityResourceId"].aggregate_step.group_by_column_names[0] #=> String
resp.data_set.data_prep_configuration.transform_step_map["DataSetEntityResourceId"].aggregate_step.aggregations #=> Array
resp.data_set.data_prep_configuration.transform_step_map["DataSetEntityResourceId"].aggregate_step.aggregations[0].aggregation_function.simple_aggregation.input_column_name #=> String
resp.data_set.data_prep_configuration.transform_step_map["DataSetEntityResourceId"].aggregate_step.aggregations[0].aggregation_function.simple_aggregation.function_type #=> String, one of "COUNT", "DISTINCT_COUNT", "SUM", "AVERAGE", "MAX", "MIN"
resp.data_set.data_prep_configuration.transform_step_map["DataSetEntityResourceId"].aggregate_step.aggregations[0].aggregation_function.list_aggregation.input_column_name #=> String
resp.data_set.data_prep_configuration.transform_step_map["DataSetEntityResourceId"].aggregate_step.aggregations[0].aggregation_function.list_aggregation.separator #=> String
resp.data_set.data_prep_configuration.transform_step_map["DataSetEntityResourceId"].aggregate_step.aggregations[0].aggregation_function.list_aggregation.distinct #=> Boolean
resp.data_set.data_prep_configuration.transform_step_map["DataSetEntityResourceId"].aggregate_step.aggregations[0].new_column_name #=> String
resp.data_set.data_prep_configuration.transform_step_map["DataSetEntityResourceId"].aggregate_step.aggregations[0].new_column_id #=> String
resp.data_set.data_prep_configuration.transform_step_map["DataSetEntityResourceId"].pivot_step.alias #=> String
resp.data_set.data_prep_configuration.transform_step_map["DataSetEntityResourceId"].pivot_step.source.transform_operation_id #=> String
resp.data_set.data_prep_configuration.transform_step_map["DataSetEntityResourceId"].pivot_step.source.column_id_mappings #=> Array
resp.data_set.data_prep_configuration.transform_step_map["DataSetEntityResourceId"].pivot_step.source.column_id_mappings[0].source_column_id #=> String
resp.data_set.data_prep_configuration.transform_step_map["DataSetEntityResourceId"].pivot_step.source.column_id_mappings[0].target_column_id #=> String
resp.data_set.data_prep_configuration.transform_step_map["DataSetEntityResourceId"].pivot_step.group_by_column_names #=> Array
resp.data_set.data_prep_configuration.transform_step_map["DataSetEntityResourceId"].pivot_step.group_by_column_names[0] #=> String
resp.data_set.data_prep_configuration.transform_step_map["DataSetEntityResourceId"].pivot_step.value_column_configuration.aggregation_function.simple_aggregation.input_column_name #=> String
resp.data_set.data_prep_configuration.transform_step_map["DataSetEntityResourceId"].pivot_step.value_column_configuration.aggregation_function.simple_aggregation.function_type #=> String, one of "COUNT", "DISTINCT_COUNT", "SUM", "AVERAGE", "MAX", "MIN"
resp.data_set.data_prep_configuration.transform_step_map["DataSetEntityResourceId"].pivot_step.value_column_configuration.aggregation_function.list_aggregation.input_column_name #=> String
resp.data_set.data_prep_configuration.transform_step_map["DataSetEntityResourceId"].pivot_step.value_column_configuration.aggregation_function.list_aggregation.separator #=> String
resp.data_set.data_prep_configuration.transform_step_map["DataSetEntityResourceId"].pivot_step.value_column_configuration.aggregation_function.list_aggregation.distinct #=> Boolean
resp.data_set.data_prep_configuration.transform_step_map["DataSetEntityResourceId"].pivot_step.pivot_configuration.label_column_name #=> String
resp.data_set.data_prep_configuration.transform_step_map["DataSetEntityResourceId"].pivot_step.pivot_configuration.pivoted_labels #=> Array
resp.data_set.data_prep_configuration.transform_step_map["DataSetEntityResourceId"].pivot_step.pivot_configuration.pivoted_labels[0].label_name #=> String
resp.data_set.data_prep_configuration.transform_step_map["DataSetEntityResourceId"].pivot_step.pivot_configuration.pivoted_labels[0].new_column_name #=> String
resp.data_set.data_prep_configuration.transform_step_map["DataSetEntityResourceId"].pivot_step.pivot_configuration.pivoted_labels[0].new_column_id #=> String
resp.data_set.data_prep_configuration.transform_step_map["DataSetEntityResourceId"].unpivot_step.alias #=> String
resp.data_set.data_prep_configuration.transform_step_map["DataSetEntityResourceId"].unpivot_step.source.transform_operation_id #=> String
resp.data_set.data_prep_configuration.transform_step_map["DataSetEntityResourceId"].unpivot_step.source.column_id_mappings #=> Array
resp.data_set.data_prep_configuration.transform_step_map["DataSetEntityResourceId"].unpivot_step.source.column_id_mappings[0].source_column_id #=> String
resp.data_set.data_prep_configuration.transform_step_map["DataSetEntityResourceId"].unpivot_step.source.column_id_mappings[0].target_column_id #=> String
resp.data_set.data_prep_configuration.transform_step_map["DataSetEntityResourceId"].unpivot_step.columns_to_unpivot #=> Array
resp.data_set.data_prep_configuration.transform_step_map["DataSetEntityResourceId"].unpivot_step.columns_to_unpivot[0].column_name #=> String
resp.data_set.data_prep_configuration.transform_step_map["DataSetEntityResourceId"].unpivot_step.columns_to_unpivot[0].new_value #=> String
resp.data_set.data_prep_configuration.transform_step_map["DataSetEntityResourceId"].unpivot_step.unpivoted_label_column_name #=> String
resp.data_set.data_prep_configuration.transform_step_map["DataSetEntityResourceId"].unpivot_step.unpivoted_label_column_id #=> String
resp.data_set.data_prep_configuration.transform_step_map["DataSetEntityResourceId"].unpivot_step.unpivoted_value_column_name #=> String
resp.data_set.data_prep_configuration.transform_step_map["DataSetEntityResourceId"].unpivot_step.unpivoted_value_column_id #=> String
resp.data_set.data_prep_configuration.transform_step_map["DataSetEntityResourceId"].append_step.alias #=> String
resp.data_set.data_prep_configuration.transform_step_map["DataSetEntityResourceId"].append_step.first_source.transform_operation_id #=> String
resp.data_set.data_prep_configuration.transform_step_map["DataSetEntityResourceId"].append_step.first_source.column_id_mappings #=> Array
resp.data_set.data_prep_configuration.transform_step_map["DataSetEntityResourceId"].append_step.first_source.column_id_mappings[0].source_column_id #=> String
resp.data_set.data_prep_configuration.transform_step_map["DataSetEntityResourceId"].append_step.first_source.column_id_mappings[0].target_column_id #=> String
resp.data_set.data_prep_configuration.transform_step_map["DataSetEntityResourceId"].append_step.second_source.transform_operation_id #=> String
resp.data_set.data_prep_configuration.transform_step_map["DataSetEntityResourceId"].append_step.second_source.column_id_mappings #=> Array
resp.data_set.data_prep_configuration.transform_step_map["DataSetEntityResourceId"].append_step.second_source.column_id_mappings[0].source_column_id #=> String
resp.data_set.data_prep_configuration.transform_step_map["DataSetEntityResourceId"].append_step.second_source.column_id_mappings[0].target_column_id #=> String
resp.data_set.data_prep_configuration.transform_step_map["DataSetEntityResourceId"].append_step.appended_columns #=> Array
resp.data_set.data_prep_configuration.transform_step_map["DataSetEntityResourceId"].append_step.appended_columns[0].column_name #=> String
resp.data_set.data_prep_configuration.transform_step_map["DataSetEntityResourceId"].append_step.appended_columns[0].new_column_id #=> String
resp.data_set.data_prep_configuration.destination_table_map #=> Hash
resp.data_set.data_prep_configuration.destination_table_map["DataSetEntityResourceId"].alias #=> String
resp.data_set.data_prep_configuration.destination_table_map["DataSetEntityResourceId"].source.transform_operation_id #=> String
resp.data_set.semantic_model_configuration.table_map #=> Hash
resp.data_set.semantic_model_configuration.table_map["DataSetEntityResourceId"].alias #=> String
resp.data_set.semantic_model_configuration.table_map["DataSetEntityResourceId"].destination_table_id #=> String
resp.data_set.semantic_model_configuration.table_map["DataSetEntityResourceId"].row_level_permission_configuration.tag_configuration.status #=> String, one of "ENABLED", "DISABLED"
resp.data_set.semantic_model_configuration.table_map["DataSetEntityResourceId"].row_level_permission_configuration.tag_configuration.tag_rules #=> Array
resp.data_set.semantic_model_configuration.table_map["DataSetEntityResourceId"].row_level_permission_configuration.tag_configuration.tag_rules[0].tag_key #=> String
resp.data_set.semantic_model_configuration.table_map["DataSetEntityResourceId"].row_level_permission_configuration.tag_configuration.tag_rules[0].column_name #=> String
resp.data_set.semantic_model_configuration.table_map["DataSetEntityResourceId"].row_level_permission_configuration.tag_configuration.tag_rules[0].tag_multi_value_delimiter #=> String
resp.data_set.semantic_model_configuration.table_map["DataSetEntityResourceId"].row_level_permission_configuration.tag_configuration.tag_rules[0].match_all_value #=> String
resp.data_set.semantic_model_configuration.table_map["DataSetEntityResourceId"].row_level_permission_configuration.tag_configuration.tag_rule_configurations #=> Array
resp.data_set.semantic_model_configuration.table_map["DataSetEntityResourceId"].row_level_permission_configuration.tag_configuration.tag_rule_configurations[0] #=> Array
resp.data_set.semantic_model_configuration.table_map["DataSetEntityResourceId"].row_level_permission_configuration.tag_configuration.tag_rule_configurations[0][0] #=> String
resp.data_set.semantic_model_configuration.table_map["DataSetEntityResourceId"].row_level_permission_configuration.row_level_permission_data_set.namespace #=> String
resp.data_set.semantic_model_configuration.table_map["DataSetEntityResourceId"].row_level_permission_configuration.row_level_permission_data_set.arn #=> String
resp.data_set.semantic_model_configuration.table_map["DataSetEntityResourceId"].row_level_permission_configuration.row_level_permission_data_set.permission_policy #=> String, one of "GRANT_ACCESS", "DENY_ACCESS"
resp.data_set.semantic_model_configuration.table_map["DataSetEntityResourceId"].row_level_permission_configuration.row_level_permission_data_set.format_version #=> String, one of "VERSION_1", "VERSION_2"
resp.data_set.semantic_model_configuration.table_map["DataSetEntityResourceId"].row_level_permission_configuration.row_level_permission_data_set.status #=> String, one of "ENABLED", "DISABLED"
resp.data_set.semantic_model_configuration.table_map["DataSetEntityResourceId"].semantic_metadata.column_metadata #=> Array
resp.data_set.semantic_model_configuration.table_map["DataSetEntityResourceId"].semantic_metadata.column_metadata[0].column_names #=> Array
resp.data_set.semantic_model_configuration.table_map["DataSetEntityResourceId"].semantic_metadata.column_metadata[0].column_names[0] #=> String
resp.data_set.semantic_model_configuration.table_map["DataSetEntityResourceId"].semantic_metadata.column_metadata[0].column_properties #=> Array
resp.data_set.semantic_model_configuration.table_map["DataSetEntityResourceId"].semantic_metadata.column_metadata[0].column_properties[0].description.text #=> String
resp.data_set.semantic_model_configuration.table_map["DataSetEntityResourceId"].semantic_metadata.column_metadata[0].column_properties[0].additional_notes.text #=> String
resp.data_set.semantic_model_configuration.table_map["DataSetEntityResourceId"].semantic_metadata.column_metadata[0].column_properties[0].semantic_type.geographical_role #=> String, one of "COUNTRY", "STATE", "COUNTY", "CITY", "POSTCODE", "LONGITUDE", "LATITUDE"
resp.data_set.semantic_model_configuration.semantic_metadata #=> Array
resp.data_set.semantic_model_configuration.semantic_metadata[0].description.text #=> String
resp.data_set.semantic_model_configuration.semantic_metadata[0].custom_instructions #=> Array
resp.data_set.semantic_model_configuration.semantic_metadata[0].custom_instructions[0].inline_custom_instruction.instruction_text #=> String
resp.data_set.semantic_model_configuration.semantic_metadata[0].custom_instructions[0].inline_custom_instruction.uploaded_document_metadata.name #=> String
resp.request_id #=> String
resp.status #=> Integer

Parameters:

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

Options Hash (params):

:aws_account_id (required, String) —
The Amazon Web Services account ID.
:data_set_id (required, String) —
The ID for the dataset that you want to describe. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

Returns:

(Types::DescribeDataSetResponse) —
Returns a response object which responds to the following methods:
- #data_set => Types::DataSet
- #request_id => String
- #status => Integer

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 10764

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

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

Describes the permissions on a dataset.

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

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

Options Hash (params):

:aws_account_id (required, String) —
The Amazon Web Services account ID.
:data_set_id (required, String) —
The ID for the dataset that you want to describe. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

Returns:

(Types::DescribeDataSetPermissionsResponse) —
Returns a response object which responds to the following methods:
- #data_set_arn => String
- #data_set_id => String
- #permissions => Array<Types::ResourcePermission>
- #request_id => String
- #status => Integer

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 10811

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

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

Describes the refresh properties of a dataset.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

Options Hash (params):

:aws_account_id (required, String) —
The Amazon Web Services account ID.
:data_set_id (required, String) —
The ID of the dataset.

Returns:

(Types::DescribeDataSetRefreshPropertiesResponse) —
Returns a response object which responds to the following methods:
- #request_id => String
- #status => Integer
- #data_set_refresh_properties => Types::DataSetRefreshProperties

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 10850

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

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

Describes a data source.

Examples:

Request syntax with placeholder values


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

Response structure


resp.data_source.arn #=> String
resp.data_source.data_source_id #=> String
resp.data_source.name #=> String
resp.data_source.type #=> String, one of "ADOBE_ANALYTICS", "AMAZON_ELASTICSEARCH", "ATHENA", "AURORA", "AURORA_POSTGRESQL", "AWS_IOT_ANALYTICS", "GITHUB", "JIRA", "MARIADB", "MYSQL", "ORACLE", "POSTGRESQL", "PRESTO", "REDSHIFT", "S3", "S3_TABLES", "SALESFORCE", "SERVICENOW", "SNOWFLAKE", "SPARK", "SQLSERVER", "TERADATA", "TWITTER", "TIMESTREAM", "AMAZON_OPENSEARCH", "EXASOL", "DATABRICKS", "STARBURST", "TRINO", "BIGQUERY", "GOOGLESHEETS", "GOOGLE_DRIVE", "CONFLUENCE", "SHAREPOINT", "ONE_DRIVE", "WEB_CRAWLER", "S3_KNOWLEDGE_BASE", "QBUSINESS"
resp.data_source.status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED", "DELETED"
resp.data_source.created_time #=> Time
resp.data_source.last_updated_time #=> Time
resp.data_source.data_source_parameters.amazon_elasticsearch_parameters.domain #=> String
resp.data_source.data_source_parameters.athena_parameters.work_group #=> String
resp.data_source.data_source_parameters.athena_parameters.role_arn #=> String
resp.data_source.data_source_parameters.athena_parameters.consumer_account_role_arn #=> String
resp.data_source.data_source_parameters.athena_parameters.identity_center_configuration.enable_identity_propagation #=> Boolean
resp.data_source.data_source_parameters.aurora_parameters.host #=> String
resp.data_source.data_source_parameters.aurora_parameters.port #=> Integer
resp.data_source.data_source_parameters.aurora_parameters.database #=> String
resp.data_source.data_source_parameters.aurora_postgre_sql_parameters.host #=> String
resp.data_source.data_source_parameters.aurora_postgre_sql_parameters.port #=> Integer
resp.data_source.data_source_parameters.aurora_postgre_sql_parameters.database #=> String
resp.data_source.data_source_parameters.aws_iot_analytics_parameters.data_set_name #=> String
resp.data_source.data_source_parameters.jira_parameters.site_base_url #=> String
resp.data_source.data_source_parameters.maria_db_parameters.host #=> String
resp.data_source.data_source_parameters.maria_db_parameters.port #=> Integer
resp.data_source.data_source_parameters.maria_db_parameters.database #=> String
resp.data_source.data_source_parameters.my_sql_parameters.host #=> String
resp.data_source.data_source_parameters.my_sql_parameters.port #=> Integer
resp.data_source.data_source_parameters.my_sql_parameters.database #=> String
resp.data_source.data_source_parameters.oracle_parameters.host #=> String
resp.data_source.data_source_parameters.oracle_parameters.port #=> Integer
resp.data_source.data_source_parameters.oracle_parameters.database #=> String
resp.data_source.data_source_parameters.oracle_parameters.use_service_name #=> Boolean
resp.data_source.data_source_parameters.postgre_sql_parameters.host #=> String
resp.data_source.data_source_parameters.postgre_sql_parameters.port #=> Integer
resp.data_source.data_source_parameters.postgre_sql_parameters.database #=> String
resp.data_source.data_source_parameters.presto_parameters.host #=> String
resp.data_source.data_source_parameters.presto_parameters.port #=> Integer
resp.data_source.data_source_parameters.presto_parameters.catalog #=> String
resp.data_source.data_source_parameters.rds_parameters.instance_id #=> String
resp.data_source.data_source_parameters.rds_parameters.database #=> String
resp.data_source.data_source_parameters.redshift_parameters.host #=> String
resp.data_source.data_source_parameters.redshift_parameters.port #=> Integer
resp.data_source.data_source_parameters.redshift_parameters.database #=> String
resp.data_source.data_source_parameters.redshift_parameters.cluster_id #=> String
resp.data_source.data_source_parameters.redshift_parameters.iam_parameters.role_arn #=> String
resp.data_source.data_source_parameters.redshift_parameters.iam_parameters.database_user #=> String
resp.data_source.data_source_parameters.redshift_parameters.iam_parameters.database_groups #=> Array
resp.data_source.data_source_parameters.redshift_parameters.iam_parameters.database_groups[0] #=> String
resp.data_source.data_source_parameters.redshift_parameters.iam_parameters.auto_create_database_user #=> Boolean
resp.data_source.data_source_parameters.redshift_parameters.identity_center_configuration.enable_identity_propagation #=> Boolean
resp.data_source.data_source_parameters.s3_parameters.manifest_file_location.bucket #=> String
resp.data_source.data_source_parameters.s3_parameters.manifest_file_location.key #=> String
resp.data_source.data_source_parameters.s3_parameters.role_arn #=> String
resp.data_source.data_source_parameters.s3_tables_parameters.table_bucket_arn #=> String
resp.data_source.data_source_parameters.s3_knowledge_base_parameters.role_arn #=> String
resp.data_source.data_source_parameters.s3_knowledge_base_parameters.bucket_url #=> String
resp.data_source.data_source_parameters.s3_knowledge_base_parameters.metadata_files_location #=> 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.snowflake_parameters.authentication_type #=> String, one of "PASSWORD", "KEYPAIR", "TOKEN", "X509"
resp.data_source.data_source_parameters.snowflake_parameters.database_access_control_role #=> String
resp.data_source.data_source_parameters.snowflake_parameters.o_auth_parameters.token_provider_url #=> String
resp.data_source.data_source_parameters.snowflake_parameters.o_auth_parameters.o_auth_scope #=> String
resp.data_source.data_source_parameters.snowflake_parameters.o_auth_parameters.identity_provider_vpc_connection_properties.vpc_connection_arn #=> String
resp.data_source.data_source_parameters.snowflake_parameters.o_auth_parameters.identity_provider_resource_uri #=> String
resp.data_source.data_source_parameters.snowflake_parameters.o_auth_parameters.identity_provider_ca_certificates_bundle_s3_uri #=> String
resp.data_source.data_source_parameters.spark_parameters.host #=> String
resp.data_source.data_source_parameters.spark_parameters.port #=> Integer
resp.data_source.data_source_parameters.sql_server_parameters.host #=> String
resp.data_source.data_source_parameters.sql_server_parameters.port #=> Integer
resp.data_source.data_source_parameters.sql_server_parameters.database #=> String
resp.data_source.data_source_parameters.teradata_parameters.host #=> String
resp.data_source.data_source_parameters.teradata_parameters.port #=> Integer
resp.data_source.data_source_parameters.teradata_parameters.database #=> String
resp.data_source.data_source_parameters.twitter_parameters.query #=> String
resp.data_source.data_source_parameters.twitter_parameters.max_rows #=> Integer
resp.data_source.data_source_parameters.amazon_open_search_parameters.domain #=> String
resp.data_source.data_source_parameters.exasol_parameters.host #=> String
resp.data_source.data_source_parameters.exasol_parameters.port #=> Integer
resp.data_source.data_source_parameters.databricks_parameters.host #=> String
resp.data_source.data_source_parameters.databricks_parameters.port #=> Integer
resp.data_source.data_source_parameters.databricks_parameters.sql_endpoint_path #=> String
resp.data_source.data_source_parameters.starburst_parameters.host #=> String
resp.data_source.data_source_parameters.starburst_parameters.port #=> Integer
resp.data_source.data_source_parameters.starburst_parameters.catalog #=> String
resp.data_source.data_source_parameters.starburst_parameters.product_type #=> String, one of "GALAXY", "ENTERPRISE"
resp.data_source.data_source_parameters.starburst_parameters.database_access_control_role #=> String
resp.data_source.data_source_parameters.starburst_parameters.authentication_type #=> String, one of "PASSWORD", "KEYPAIR", "TOKEN", "X509"
resp.data_source.data_source_parameters.starburst_parameters.o_auth_parameters.token_provider_url #=> String
resp.data_source.data_source_parameters.starburst_parameters.o_auth_parameters.o_auth_scope #=> String
resp.data_source.data_source_parameters.starburst_parameters.o_auth_parameters.identity_provider_vpc_connection_properties.vpc_connection_arn #=> String
resp.data_source.data_source_parameters.starburst_parameters.o_auth_parameters.identity_provider_resource_uri #=> String
resp.data_source.data_source_parameters.starburst_parameters.o_auth_parameters.identity_provider_ca_certificates_bundle_s3_uri #=> String
resp.data_source.data_source_parameters.trino_parameters.host #=> String
resp.data_source.data_source_parameters.trino_parameters.port #=> Integer
resp.data_source.data_source_parameters.trino_parameters.catalog #=> String
resp.data_source.data_source_parameters.big_query_parameters.project_id #=> String
resp.data_source.data_source_parameters.big_query_parameters.data_set_region #=> String
resp.data_source.data_source_parameters.impala_parameters.host #=> String
resp.data_source.data_source_parameters.impala_parameters.port #=> Integer
resp.data_source.data_source_parameters.impala_parameters.database #=> String
resp.data_source.data_source_parameters.impala_parameters.sql_endpoint_path #=> String
resp.data_source.data_source_parameters.custom_connection_parameters.connection_type #=> String
resp.data_source.data_source_parameters.web_crawler_parameters.web_crawler_auth_type #=> String, one of "NO_AUTH", "BASIC_AUTH", "FORM", "SAML"
resp.data_source.data_source_parameters.web_crawler_parameters.username_field_xpath #=> String
resp.data_source.data_source_parameters.web_crawler_parameters.password_field_xpath #=> String
resp.data_source.data_source_parameters.web_crawler_parameters.username_button_xpath #=> String
resp.data_source.data_source_parameters.web_crawler_parameters.password_button_xpath #=> String
resp.data_source.data_source_parameters.web_crawler_parameters.login_page_url #=> String
resp.data_source.data_source_parameters.web_crawler_parameters.web_proxy_host_name #=> String
resp.data_source.data_source_parameters.web_crawler_parameters.web_proxy_port_number #=> Integer
resp.data_source.data_source_parameters.confluence_parameters.confluence_url #=> String
resp.data_source.data_source_parameters.q_business_parameters.application_arn #=> String
resp.data_source.data_source_parameters.share_point_parameters.share_point_domain #=> String
resp.data_source.data_source_parameters.share_point_parameters.tenant_id #=> String
resp.data_source.data_source_parameters.share_point_parameters.client_id #=> String
resp.data_source.data_source_parameters.share_point_parameters.auth_type #=> String, one of "THREE_LEGGED_OAUTH", "TWO_LEGGED_OAUTH", "SERVICE_ACCOUNT"
resp.data_source.data_source_parameters.google_drive_parameters.auth_type #=> String, one of "THREE_LEGGED_OAUTH", "TWO_LEGGED_OAUTH", "SERVICE_ACCOUNT"
resp.data_source.data_source_parameters.one_drive_parameters.tenant_id #=> String
resp.data_source.data_source_parameters.one_drive_parameters.client_id #=> String
resp.data_source.data_source_parameters.one_drive_parameters.auth_type #=> String, one of "THREE_LEGGED_OAUTH", "TWO_LEGGED_OAUTH", "SERVICE_ACCOUNT"
resp.data_source.data_source_parameters.fmkb_parameters.knowledge_base_arn #=> String
resp.data_source.data_source_parameters.fmkb_parameters.linked_data_source_ids #=> Array
resp.data_source.data_source_parameters.fmkb_parameters.linked_data_source_ids[0] #=> String
resp.data_source.alternate_data_source_parameters #=> Array
resp.data_source.alternate_data_source_parameters[0].amazon_elasticsearch_parameters.domain #=> String
resp.data_source.alternate_data_source_parameters[0].athena_parameters.work_group #=> String
resp.data_source.alternate_data_source_parameters[0].athena_parameters.role_arn #=> String
resp.data_source.alternate_data_source_parameters[0].athena_parameters.consumer_account_role_arn #=> String
resp.data_source.alternate_data_source_parameters[0].athena_parameters.identity_center_configuration.enable_identity_propagation #=> Boolean
resp.data_source.alternate_data_source_parameters[0].aurora_parameters.host #=> String
resp.data_source.alternate_data_source_parameters[0].aurora_parameters.port #=> Integer
resp.data_source.alternate_data_source_parameters[0].aurora_parameters.database #=> String
resp.data_source.alternate_data_source_parameters[0].aurora_postgre_sql_parameters.host #=> String
resp.data_source.alternate_data_source_parameters[0].aurora_postgre_sql_parameters.port #=> Integer
resp.data_source.alternate_data_source_parameters[0].aurora_postgre_sql_parameters.database #=> String
resp.data_source.alternate_data_source_parameters[0].aws_iot_analytics_parameters.data_set_name #=> String
resp.data_source.alternate_data_source_parameters[0].jira_parameters.site_base_url #=> String
resp.data_source.alternate_data_source_parameters[0].maria_db_parameters.host #=> String
resp.data_source.alternate_data_source_parameters[0].maria_db_parameters.port #=> Integer
resp.data_source.alternate_data_source_parameters[0].maria_db_parameters.database #=> String
resp.data_source.alternate_data_source_parameters[0].my_sql_parameters.host #=> String
resp.data_source.alternate_data_source_parameters[0].my_sql_parameters.port #=> Integer
resp.data_source.alternate_data_source_parameters[0].my_sql_parameters.database #=> String
resp.data_source.alternate_data_source_parameters[0].oracle_parameters.host #=> String
resp.data_source.alternate_data_source_parameters[0].oracle_parameters.port #=> Integer
resp.data_source.alternate_data_source_parameters[0].oracle_parameters.database #=> String
resp.data_source.alternate_data_source_parameters[0].oracle_parameters.use_service_name #=> Boolean
resp.data_source.alternate_data_source_parameters[0].postgre_sql_parameters.host #=> String
resp.data_source.alternate_data_source_parameters[0].postgre_sql_parameters.port #=> Integer
resp.data_source.alternate_data_source_parameters[0].postgre_sql_parameters.database #=> String
resp.data_source.alternate_data_source_parameters[0].presto_parameters.host #=> String
resp.data_source.alternate_data_source_parameters[0].presto_parameters.port #=> Integer
resp.data_source.alternate_data_source_parameters[0].presto_parameters.catalog #=> String
resp.data_source.alternate_data_source_parameters[0].rds_parameters.instance_id #=> String
resp.data_source.alternate_data_source_parameters[0].rds_parameters.database #=> String
resp.data_source.alternate_data_source_parameters[0].redshift_parameters.host #=> String
resp.data_source.alternate_data_source_parameters[0].redshift_parameters.port #=> Integer
resp.data_source.alternate_data_source_parameters[0].redshift_parameters.database #=> String
resp.data_source.alternate_data_source_parameters[0].redshift_parameters.cluster_id #=> String
resp.data_source.alternate_data_source_parameters[0].redshift_parameters.iam_parameters.role_arn #=> String
resp.data_source.alternate_data_source_parameters[0].redshift_parameters.iam_parameters.database_user #=> String
resp.data_source.alternate_data_source_parameters[0].redshift_parameters.iam_parameters.database_groups #=> Array
resp.data_source.alternate_data_source_parameters[0].redshift_parameters.iam_parameters.database_groups[0] #=> String
resp.data_source.alternate_data_source_parameters[0].redshift_parameters.iam_parameters.auto_create_database_user #=> Boolean
resp.data_source.alternate_data_source_parameters[0].redshift_parameters.identity_center_configuration.enable_identity_propagation #=> Boolean
resp.data_source.alternate_data_source_parameters[0].s3_parameters.manifest_file_location.bucket #=> String
resp.data_source.alternate_data_source_parameters[0].s3_parameters.manifest_file_location.key #=> String
resp.data_source.alternate_data_source_parameters[0].s3_parameters.role_arn #=> String
resp.data_source.alternate_data_source_parameters[0].s3_tables_parameters.table_bucket_arn #=> String
resp.data_source.alternate_data_source_parameters[0].s3_knowledge_base_parameters.role_arn #=> String
resp.data_source.alternate_data_source_parameters[0].s3_knowledge_base_parameters.bucket_url #=> String
resp.data_source.alternate_data_source_parameters[0].s3_knowledge_base_parameters.metadata_files_location #=> String
resp.data_source.alternate_data_source_parameters[0].service_now_parameters.site_base_url #=> String
resp.data_source.alternate_data_source_parameters[0].snowflake_parameters.host #=> String
resp.data_source.alternate_data_source_parameters[0].snowflake_parameters.database #=> String
resp.data_source.alternate_data_source_parameters[0].snowflake_parameters.warehouse #=> String
resp.data_source.alternate_data_source_parameters[0].snowflake_parameters.authentication_type #=> String, one of "PASSWORD", "KEYPAIR", "TOKEN", "X509"
resp.data_source.alternate_data_source_parameters[0].snowflake_parameters.database_access_control_role #=> String
resp.data_source.alternate_data_source_parameters[0].snowflake_parameters.o_auth_parameters.token_provider_url #=> String
resp.data_source.alternate_data_source_parameters[0].snowflake_parameters.o_auth_parameters.o_auth_scope #=> String
resp.data_source.alternate_data_source_parameters[0].snowflake_parameters.o_auth_parameters.identity_provider_vpc_connection_properties.vpc_connection_arn #=> String
resp.data_source.alternate_data_source_parameters[0].snowflake_parameters.o_auth_parameters.identity_provider_resource_uri #=> String
resp.data_source.alternate_data_source_parameters[0].snowflake_parameters.o_auth_parameters.identity_provider_ca_certificates_bundle_s3_uri #=> String
resp.data_source.alternate_data_source_parameters[0].spark_parameters.host #=> String
resp.data_source.alternate_data_source_parameters[0].spark_parameters.port #=> Integer
resp.data_source.alternate_data_source_parameters[0].sql_server_parameters.host #=> String
resp.data_source.alternate_data_source_parameters[0].sql_server_parameters.port #=> Integer
resp.data_source.alternate_data_source_parameters[0].sql_server_parameters.database #=> String
resp.data_source.alternate_data_source_parameters[0].teradata_parameters.host #=> String
resp.data_source.alternate_data_source_parameters[0].teradata_parameters.port #=> Integer
resp.data_source.alternate_data_source_parameters[0].teradata_parameters.database #=> String
resp.data_source.alternate_data_source_parameters[0].twitter_parameters.query #=> String
resp.data_source.alternate_data_source_parameters[0].twitter_parameters.max_rows #=> Integer
resp.data_source.alternate_data_source_parameters[0].amazon_open_search_parameters.domain #=> String
resp.data_source.alternate_data_source_parameters[0].exasol_parameters.host #=> String
resp.data_source.alternate_data_source_parameters[0].exasol_parameters.port #=> Integer
resp.data_source.alternate_data_source_parameters[0].databricks_parameters.host #=> String
resp.data_source.alternate_data_source_parameters[0].databricks_parameters.port #=> Integer
resp.data_source.alternate_data_source_parameters[0].databricks_parameters.sql_endpoint_path #=> String
resp.data_source.alternate_data_source_parameters[0].starburst_parameters.host #=> String
resp.data_source.alternate_data_source_parameters[0].starburst_parameters.port #=> Integer
resp.data_source.alternate_data_source_parameters[0].starburst_parameters.catalog #=> String
resp.data_source.alternate_data_source_parameters[0].starburst_parameters.product_type #=> String, one of "GALAXY", "ENTERPRISE"
resp.data_source.alternate_data_source_parameters[0].starburst_parameters.database_access_control_role #=> String
resp.data_source.alternate_data_source_parameters[0].starburst_parameters.authentication_type #=> String, one of "PASSWORD", "KEYPAIR", "TOKEN", "X509"
resp.data_source.alternate_data_source_parameters[0].starburst_parameters.o_auth_parameters.token_provider_url #=> String
resp.data_source.alternate_data_source_parameters[0].starburst_parameters.o_auth_parameters.o_auth_scope #=> String
resp.data_source.alternate_data_source_parameters[0].starburst_parameters.o_auth_parameters.identity_provider_vpc_connection_properties.vpc_connection_arn #=> String
resp.data_source.alternate_data_source_parameters[0].starburst_parameters.o_auth_parameters.identity_provider_resource_uri #=> String
resp.data_source.alternate_data_source_parameters[0].starburst_parameters.o_auth_parameters.identity_provider_ca_certificates_bundle_s3_uri #=> String
resp.data_source.alternate_data_source_parameters[0].trino_parameters.host #=> String
resp.data_source.alternate_data_source_parameters[0].trino_parameters.port #=> Integer
resp.data_source.alternate_data_source_parameters[0].trino_parameters.catalog #=> String
resp.data_source.alternate_data_source_parameters[0].big_query_parameters.project_id #=> String
resp.data_source.alternate_data_source_parameters[0].big_query_parameters.data_set_region #=> String
resp.data_source.alternate_data_source_parameters[0].impala_parameters.host #=> String
resp.data_source.alternate_data_source_parameters[0].impala_parameters.port #=> Integer
resp.data_source.alternate_data_source_parameters[0].impala_parameters.database #=> String
resp.data_source.alternate_data_source_parameters[0].impala_parameters.sql_endpoint_path #=> String
resp.data_source.alternate_data_source_parameters[0].custom_connection_parameters.connection_type #=> String
resp.data_source.alternate_data_source_parameters[0].web_crawler_parameters.web_crawler_auth_type #=> String, one of "NO_AUTH", "BASIC_AUTH", "FORM", "SAML"
resp.data_source.alternate_data_source_parameters[0].web_crawler_parameters.username_field_xpath #=> String
resp.data_source.alternate_data_source_parameters[0].web_crawler_parameters.password_field_xpath #=> String
resp.data_source.alternate_data_source_parameters[0].web_crawler_parameters.username_button_xpath #=> String
resp.data_source.alternate_data_source_parameters[0].web_crawler_parameters.password_button_xpath #=> String
resp.data_source.alternate_data_source_parameters[0].web_crawler_parameters.login_page_url #=> String
resp.data_source.alternate_data_source_parameters[0].web_crawler_parameters.web_proxy_host_name #=> String
resp.data_source.alternate_data_source_parameters[0].web_crawler_parameters.web_proxy_port_number #=> Integer
resp.data_source.alternate_data_source_parameters[0].confluence_parameters.confluence_url #=> String
resp.data_source.alternate_data_source_parameters[0].q_business_parameters.application_arn #=> String
resp.data_source.alternate_data_source_parameters[0].share_point_parameters.share_point_domain #=> String
resp.data_source.alternate_data_source_parameters[0].share_point_parameters.tenant_id #=> String
resp.data_source.alternate_data_source_parameters[0].share_point_parameters.client_id #=> String
resp.data_source.alternate_data_source_parameters[0].share_point_parameters.auth_type #=> String, one of "THREE_LEGGED_OAUTH", "TWO_LEGGED_OAUTH", "SERVICE_ACCOUNT"
resp.data_source.alternate_data_source_parameters[0].google_drive_parameters.auth_type #=> String, one of "THREE_LEGGED_OAUTH", "TWO_LEGGED_OAUTH", "SERVICE_ACCOUNT"
resp.data_source.alternate_data_source_parameters[0].one_drive_parameters.tenant_id #=> String
resp.data_source.alternate_data_source_parameters[0].one_drive_parameters.client_id #=> String
resp.data_source.alternate_data_source_parameters[0].one_drive_parameters.auth_type #=> String, one of "THREE_LEGGED_OAUTH", "TWO_LEGGED_OAUTH", "SERVICE_ACCOUNT"
resp.data_source.alternate_data_source_parameters[0].fmkb_parameters.knowledge_base_arn #=> String
resp.data_source.alternate_data_source_parameters[0].fmkb_parameters.linked_data_source_ids #=> Array
resp.data_source.alternate_data_source_parameters[0].fmkb_parameters.linked_data_source_ids[0] #=> String
resp.data_source.vpc_connection_properties.vpc_connection_arn #=> String
resp.data_source.ssl_properties.disable_ssl #=> Boolean
resp.data_source.error_info.type #=> String, one of "ACCESS_DENIED", "COPY_SOURCE_NOT_FOUND", "TIMEOUT", "ENGINE_VERSION_NOT_SUPPORTED", "UNKNOWN_HOST", "GENERIC_SQL_FAILURE", "CONFLICT", "UNKNOWN"
resp.data_source.error_info.message #=> String
resp.data_source.secret_arn #=> String
resp.data_source.credential_status #=> String, one of "CONNECTED", "AUTH_FAILED", "NOT_VERIFIED"
resp.data_source.last_credential_verified_at #=> Time
resp.request_id #=> String
resp.status #=> Integer

Parameters:

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

Options Hash (params):

:aws_account_id (required, String) —
The Amazon Web Services account ID.
:data_source_id (required, String) —
The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

Returns:

(Types::DescribeDataSourceResponse) —
Returns a response object which responds to the following methods:
- #data_source => Types::DataSource
- #request_id => String
- #status => Integer

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 11135

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

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

Describes the resource permissions for a data source.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

Options Hash (params):

:aws_account_id (required, String) —
The Amazon Web Services account ID.
:data_source_id (required, String) —
The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

Returns:

(Types::DescribeDataSourcePermissionsResponse) —
Returns a response object which responds to the following methods:
- #data_source_arn => String
- #data_source_id => String
- #permissions => Array<Types::ResourcePermission>
- #request_id => String
- #status => Integer

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 11179

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

#describe_default_q_business_application(params = {}) ⇒ `Types::DescribeDefaultQBusinessApplicationResponse`

Describes a Amazon Q Business application that is linked to an Quick Sight account.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

Options Hash (params):

:aws_account_id (required, String) —
The ID of the Quick Sight account that is linked to the Amazon Q Business application that you want described.
:namespace (String) —
The Quick Sight namespace that contains the linked Amazon Q Business application. If this field is left blank, the default namespace is used. Currently, the default namespace is the only valid value for this parameter.

Returns:

(Types::DescribeDefaultQBusinessApplicationResponse) —
Returns a response object which responds to the following methods:
- #request_id => String
- #status => Integer
- #application_id => String

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 11220

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

#describe_dlp_setting(params = {}) ⇒ `Types::DescribeDlpSettingResponse`

Describes the full configuration of a DLP setting in an Amazon Web Services account.

Examples:

Request syntax with placeholder values


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

Response structure


resp.dlp_setting.dlp_setting_id #=> String
resp.dlp_setting.name #=> String
resp.dlp_setting.arn #=> String
resp.dlp_setting.status #=> String, one of "ACTIVE", "INACTIVE"
resp.dlp_setting.provider_type #=> String, one of "MICROSOFT_PURVIEW"
resp.dlp_setting.provider_config.microsoft_purview.credentials.secret_arn #=> String
resp.dlp_setting.provider_config.microsoft_purview.label_action_mappings #=> Array
resp.dlp_setting.provider_config.microsoft_purview.label_action_mappings[0].label_id #=> String
resp.dlp_setting.provider_config.microsoft_purview.label_action_mappings[0].label_name #=> String
resp.dlp_setting.provider_config.microsoft_purview.label_action_mappings[0].action #=> String, one of "ALLOW", "WARN", "BLOCK"
resp.dlp_setting.provider_config.microsoft_purview.unmapped_action #=> String, one of "ALLOW", "WARN", "BLOCK"
resp.dlp_setting.provider_outage_action #=> String, one of "ALLOW", "WARN", "BLOCK"
resp.dlp_setting.created_at #=> Time
resp.dlp_setting.updated_at #=> Time
resp.request_id #=> String

Parameters:

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

Options Hash (params):

:aws_account_id (required, String) —
The ID of the Amazon Web Services account that contains the DLP setting that you want to describe.
:dlp_setting_id (required, String) —
The ID of the DLP setting that you want to describe.

Returns:

(Types::DescribeDlpSettingResponse) —
Returns a response object which responds to the following methods:
- #dlp_setting => Types::DlpSettingDetails
- #request_id => String

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 11269

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

#describe_flow(params = {}) ⇒ `Types::DescribeFlowResponse`

Returns the full details of a flow for the latest version of the requested publish state.

Examples:

Request syntax with placeholder values


resp = client.describe_flow({
  aws_account_id: "AccountId", # required
  flow_id: "FlowId", # required
  publish_state: "PUBLISHED", # required, accepts PUBLISHED, DRAFT, PENDING_APPROVAL
})

Response structure


resp.flow.arn #=> String
resp.flow.flow_id #=> String
resp.flow.name #=> String
resp.flow.description #=> String
resp.flow.publish_state #=> String, one of "PUBLISHED", "DRAFT", "PENDING_APPROVAL"
resp.flow.created_time #=> Time
resp.flow.created_by #=> String
resp.flow.last_updated_time #=> Time
resp.flow.last_updated_by #=> String
resp.flow.step_aliases #=> Array
resp.flow.step_aliases[0].step_id #=> String
resp.flow.step_aliases[0].step_alias #=> String
resp.request_id #=> String
resp.status #=> Integer

Parameters:

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

Options Hash (params):

:aws_account_id (required, String) —
The ID of the Amazon Web Services account that contains the flow that you are describing.
:flow_id (required, String) —
The unique identifier of the flow.
:publish_state (required, String) —
The publish state of the flow version to describe. Valid values are DRAFT, PUBLISHED, or PENDING_APPROVAL.

Returns:

(Types::DescribeFlowResponse) —
Returns a response object which responds to the following methods:
- #flow => Types::FlowDetail
- #request_id => String
- #status => Integer

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 11323

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

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

Describes a folder.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

Options Hash (params):

:aws_account_id (required, String) —
The ID for the Amazon Web Services account that contains the folder.
:folder_id (required, String) —
The ID of the folder.

Returns:

(Types::DescribeFolderResponse) —
Returns a response object which responds to the following methods:
- #status => Integer
- #folder => Types::Folder
- #request_id => String

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 11367

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

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

Describes permissions for a folder.

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

Examples:

Request syntax with placeholder values


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

Response structure


resp.status #=> Integer
resp.folder_id #=> String
resp.arn #=> String
resp.permissions #=> Array
resp.permissions[0].principal #=> String
resp.permissions[0].actions #=> Array
resp.permissions[0].actions[0] #=> String
resp.request_id #=> String
resp.next_token #=> String

Parameters:

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

Options Hash (params):

:aws_account_id (required, String) —
The ID for the Amazon Web Services account that contains the folder.
:folder_id (required, String) —
The ID of the folder.
:namespace (String) —
The namespace of the folder whose permissions you want described.
:max_results (Integer) —
The maximum number of results to be returned per request.
:next_token (String) —
A pagination token for the next set of results.

Returns:

(Types::DescribeFolderPermissionsResponse) —
Returns a response object which responds to the following methods:
- #status => Integer
- #folder_id => String
- #arn => String
- #permissions => Array<Types::ResourcePermission>
- #request_id => String
- #next_token => String

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 11426

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

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

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

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

Examples:

Request syntax with placeholder values


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

Response structure


resp.status #=> Integer
resp.folder_id #=> String
resp.arn #=> String
resp.permissions #=> Array
resp.permissions[0].principal #=> String
resp.permissions[0].actions #=> Array
resp.permissions[0].actions[0] #=> String
resp.request_id #=> String
resp.next_token #=> String

Parameters:

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

Options Hash (params):

:aws_account_id (required, String) —
The ID for the Amazon Web Services account that contains the folder.
:folder_id (required, String) —
The ID of the folder.
:namespace (String) —
The namespace of the folder whose permissions you want described.
:max_results (Integer) —
The maximum number of results to be returned per request.
:next_token (String) —
A pagination token for the next set of results.

Returns:

(Types::DescribeFolderResolvedPermissionsResponse) —
Returns a response object which responds to the following methods:
- #status => Integer
- #folder_id => String
- #arn => String
- #permissions => Array<Types::ResourcePermission>
- #request_id => String
- #next_token => String

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 11487

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

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

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

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

Options Hash (params):

:group_name (required, String) —
The name of the group that you want to describe.
:aws_account_id (required, String) —
The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon Quick Sight account.
:namespace (required, String) —
The namespace of the group that you want described.

Returns:

(Types::DescribeGroupResponse) —
Returns a response object which responds to the following methods:
- #group => Types::Group
- #request_id => String
- #status => Integer

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 11533

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

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

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

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

Options Hash (params):

:member_name (required, String) —
The user name of the user that you want to search for.
:group_name (required, String) —
The name of the group that you want to search.
:aws_account_id (required, String) —
The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon Quick Sight account.
:namespace (required, String) —
The namespace that includes the group you are searching within.

Returns:

(Types::DescribeGroupMembershipResponse) —
Returns a response object which responds to the following methods:
- #group_member => Types::GroupMember
- #request_id => String
- #status => Integer

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 11582

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

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

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

Examples:

Request syntax with placeholder values


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

Response structure


resp.iam_policy_assignment.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

Parameters:

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

Options Hash (params):

:aws_account_id (required, String) —
The ID of the Amazon Web Services account that contains the assignment that you want to describe.
:assignment_name (required, String) —
The name of the assignment, also called a rule.
:namespace (required, String) —
The namespace that contains the assignment.

Returns:

(Types::DescribeIAMPolicyAssignmentResponse) —
Returns a response object which responds to the following methods:
- #iam_policy_assignment => Types::IAMPolicyAssignment
- #request_id => String
- #status => Integer

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 11631

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

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

Describes a SPICE ingestion.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

Options Hash (params):

:aws_account_id (required, String) —
The Amazon Web Services account ID.
:data_set_id (required, String) —
The ID of the dataset used in the ingestion.
:ingestion_id (required, String) —
An ID for the ingestion.

Returns:

(Types::DescribeIngestionResponse) —
Returns a response object which responds to the following methods:
- #ingestion => Types::Ingestion
- #request_id => String
- #status => Integer

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 11685

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

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

Provides a summary and status of IP rules.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

Options Hash (params):

:aws_account_id (required, String) —
The ID of the Amazon Web Services account that contains the IP rules.

Returns:

(Types::DescribeIpRestrictionResponse) —
Returns a response object which responds to the following methods:
- #aws_account_id => String
- #ip_restriction_rule_map => Hash<String,String>
- #vpc_id_restriction_rule_map => Hash<String,String>
- #vpc_endpoint_id_restriction_rule_map => Hash<String,String>
- #enabled => Boolean
- #request_id => String
- #status => Integer

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 11728

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

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

Describes all customer managed key registrations in a Quick Sight account.

Examples:

Request syntax with placeholder values


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

Response structure


resp.aws_account_id #=> String
resp.key_registration #=> Array
resp.key_registration[0].key_arn #=> String
resp.key_registration[0].default_key #=> Boolean
resp.q_data_key.q_data_key_arn #=> String
resp.q_data_key.q_data_key_type #=> String, one of "AWS_OWNED", "CMK"
resp.request_id #=> String
resp.status #=> Integer

Parameters:

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

Options Hash (params):

:aws_account_id (required, String) —
The ID of the Amazon Web Services account that contains the customer managed key registration that you want to describe.
:default_key_only (Boolean) —
Determines whether the request returns the default key only.

Returns:

(Types::DescribeKeyRegistrationResponse) —
Returns a response object which responds to the following methods:
- #aws_account_id => String
- #key_registration => Array<Types::RegisteredCustomerManagedKey>
- #q_data_key => Types::QDataKey
- #request_id => String
- #status => Integer

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 11773

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

#describe_knowledge_base(params = {}) ⇒ `Types::DescribeKnowledgeBaseResponse`

Describes a knowledge base.

Examples:

Request syntax with placeholder values


resp = client.describe_knowledge_base({
  aws_account_id: "KbAwsAccountId", # required
  knowledge_base_id: "KnowledgeBaseId", # required
})

Response structure


resp.knowledge_base.knowledge_base_arn #=> String
resp.knowledge_base.knowledge_base_id #=> String
resp.knowledge_base.name #=> String
resp.knowledge_base.status #=> String, one of "CREATING", "UPDATING", "ACTIVE", "FAILED", "DELETING"
resp.knowledge_base.data_source_arn #=> String
resp.knowledge_base.media_extraction_configuration.image_extraction_configuration.image_extraction_status #=> String, one of "ENABLED", "DISABLED"
resp.knowledge_base.media_extraction_configuration.audio_extraction_configuration.audio_extraction_status #=> String, one of "ENABLED", "DISABLED"
resp.knowledge_base.media_extraction_configuration.video_extraction_configuration.video_extraction_status #=> String, one of "ENABLED", "DISABLED"
resp.knowledge_base.media_extraction_configuration.video_extraction_configuration.video_extraction_type #=> String, one of "AUDIO_TRANSCRIPTION_ONLY", "VISUAL_CONTENT_AND_AUDIO_TRANSCRIPTION"
resp.knowledge_base.access_control_configuration.is_acl_enabled #=> Boolean
resp.knowledge_base.type #=> String
resp.knowledge_base.created_at #=> Time
resp.knowledge_base.updated_at #=> Time
resp.knowledge_base.description #=> String
resp.knowledge_base.is_email_notification_opted_for_ingestion_failures #=> Boolean
resp.knowledge_base.first_completed_ingestion_summary.ingestion_id #=> String
resp.knowledge_base.first_completed_ingestion_summary.ingestion_status #=> String, one of "QUEUED", "RUNNING", "FAILED", "COMPLETED", "INCOMPLETE", "CANCELLED", "CANCELLING", "TIMEOUT"
resp.knowledge_base.first_completed_ingestion_summary.start_time #=> Time
resp.knowledge_base.first_completed_ingestion_summary.end_time #=> Time
resp.knowledge_base.first_incomplete_ingestion_summary.ingestion_id #=> String
resp.knowledge_base.first_incomplete_ingestion_summary.ingestion_status #=> String, one of "QUEUED", "RUNNING", "FAILED", "COMPLETED", "INCOMPLETE", "CANCELLED", "CANCELLING", "TIMEOUT"
resp.knowledge_base.first_incomplete_ingestion_summary.start_time #=> Time
resp.knowledge_base.first_incomplete_ingestion_summary.end_time #=> Time
resp.knowledge_base.latest_ingestion_summary.ingestion_id #=> String
resp.knowledge_base.latest_ingestion_summary.ingestion_status #=> String, one of "QUEUED", "RUNNING", "FAILED", "COMPLETED", "INCOMPLETE", "CANCELLED", "CANCELLING", "TIMEOUT"
resp.knowledge_base.latest_ingestion_summary.start_time #=> Time
resp.knowledge_base.latest_ingestion_summary.end_time #=> Time
resp.knowledge_base.knowledge_base_size_bytes #=> Integer
resp.knowledge_base.document_count #=> Integer
resp.knowledge_base.primary_owner_arn #=> String
resp.knowledge_base.primary_owner_username #=> String
resp.request_id #=> String
resp.status #=> Integer

Parameters:

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

Options Hash (params):

:aws_account_id (required, String) —
The ID of the Amazon Web Services account that contains the knowledge base.
:knowledge_base_id (required, String) —
The unique identifier for the knowledge base.

Returns:

(Types::DescribeKnowledgeBaseResponse) —
Returns a response object which responds to the following methods:
- #knowledge_base => Types::KnowledgeBase
- #request_id => String
- #status => Integer

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 11840

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

#describe_knowledge_base_permissions(params = {}) ⇒ `Types::DescribeKnowledgeBasePermissionsResponse`

Describes the resource permissions for a knowledge base.

Examples:

Request syntax with placeholder values


resp = client.describe_knowledge_base_permissions({
  aws_account_id: "KbAwsAccountId", # required
  knowledge_base_id: "KnowledgeBaseId", # required
})

Response structure


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

Parameters:

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

Options Hash (params):

:aws_account_id (required, String) —
The ID of the Amazon Web Services account that contains the knowledge base.
:knowledge_base_id (required, String) —
The unique identifier for the knowledge base.

Returns:

(Types::DescribeKnowledgeBasePermissionsResponse) —
Returns a response object which responds to the following methods:
- #knowledge_base_arn => String
- #knowledge_base_id => String
- #permissions => Array<Types::ResourcePermission>
- #request_id => String
- #status => Integer

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 11884

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

#describe_limits_profile(params = {}) ⇒ `Types::DescribeLimitsProfileResponse`

Describes the properties of an existing limits profile.

Examples:

Request syntax with placeholder values


resp = client.describe_limits_profile({
  profile_id: "ProfileId", # required
  account_id: "AwsAccountId", # required
})

Response structure


resp.profile.profile_id #=> String
resp.profile.arn #=> String
resp.profile.account_id #=> String
resp.profile.profile_name #=> String
resp.profile.description #=> String
resp.profile.resource_limits #=> Hash
resp.profile.resource_limits["ResourceType"].max_value #=> Integer
resp.profile.resource_limits["ResourceType"].unit #=> String, one of "MB", "GB", "HOURS", "DAYS"
resp.profile.created_at #=> Time
resp.profile.updated_at #=> Time

Parameters:

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

Options Hash (params):

:profile_id (required, String) —
The unique identifier for the limits profile.
:account_id (required, String) —
The ID of the Amazon Web Services account that contains the limits profile.

Returns:

(Types::DescribeLimitsProfileResponse) —
Returns a response object which responds to the following methods:
- #profile => Types::LimitsProfile

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 11926

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

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

Describes the current namespace.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

Options Hash (params):

:aws_account_id (required, String) —
The ID for the Amazon Web Services account that contains the Quick Sight namespace that you want to describe.
:namespace (required, String) —
The namespace that you want to describe.

Returns:

(Types::DescribeNamespaceResponse) —
Returns a response object which responds to the following methods:
- #namespace => Types::NamespaceInfoV2
- #request_id => String
- #status => Integer

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 11971

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

#describe_o_auth_client_application(params = {}) ⇒ `Types::DescribeOAuthClientApplicationResponse`

Describes an OAuthClientApplication.

Examples:

Request syntax with placeholder values


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

Response structure


resp.o_auth_client_application.o_auth_client_application_id #=> String
resp.o_auth_client_application.name #=> String
resp.o_auth_client_application.o_auth_client_authentication_type #=> String, one of "TOKEN"
resp.o_auth_client_application.o_auth_token_endpoint_url #=> String
resp.o_auth_client_application.o_auth_authorization_endpoint_url #=> String
resp.o_auth_client_application.o_auth_scopes #=> String
resp.o_auth_client_application.data_source_type #=> String, one of "ADOBE_ANALYTICS", "AMAZON_ELASTICSEARCH", "ATHENA", "AURORA", "AURORA_POSTGRESQL", "AWS_IOT_ANALYTICS", "GITHUB", "JIRA", "MARIADB", "MYSQL", "ORACLE", "POSTGRESQL", "PRESTO", "REDSHIFT", "S3", "S3_TABLES", "SALESFORCE", "SERVICENOW", "SNOWFLAKE", "SPARK", "SQLSERVER", "TERADATA", "TWITTER", "TIMESTREAM", "AMAZON_OPENSEARCH", "EXASOL", "DATABRICKS", "STARBURST", "TRINO", "BIGQUERY", "GOOGLESHEETS", "GOOGLE_DRIVE", "CONFLUENCE", "SHAREPOINT", "ONE_DRIVE", "WEB_CRAWLER", "S3_KNOWLEDGE_BASE", "QBUSINESS"
resp.o_auth_client_application.identity_provider_vpc_connection_properties.vpc_connection_arn #=> String
resp.o_auth_client_application.created_time #=> Time
resp.o_auth_client_application.last_updated_time #=> Time
resp.o_auth_client_application.arn #=> String
resp.request_id #=> String
resp.status #=> Integer

Parameters:

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

Options Hash (params):

:aws_account_id (required, String) —
The Amazon Web Services account ID.
:o_auth_client_application_id (required, String) —
The ID of the OAuthClientApplication that you want to describe.

Returns:

(Types::DescribeOAuthClientApplicationResponse) —
Returns a response object which responds to the following methods:
- #o_auth_client_application => Types::OAuthClientApplication
- #request_id => String
- #status => Integer

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 12017

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

#describe_q_personalization_configuration(params = {}) ⇒ `Types::DescribeQPersonalizationConfigurationResponse`

Describes a personalization configuration.

Examples:

Request syntax with placeholder values


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

Response structure


resp.personalization_mode #=> String, one of "ENABLED", "DISABLED"
resp.request_id #=> String
resp.status #=> Integer

Parameters:

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

Options Hash (params):

:aws_account_id (required, String) —
The ID of the Amazon Web Services account that contains the personalization configuration that the user wants described.

Returns:

(Types::DescribeQPersonalizationConfigurationResponse) —
Returns a response object which responds to the following methods:
- #personalization_mode => String
- #request_id => String
- #status => Integer

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 12050

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

#describe_quick_sight_q_search_configuration(params = {}) ⇒ `Types::DescribeQuickSightQSearchConfigurationResponse`

Describes the state of a Quick Sight Q Search configuration.

Examples:

Request syntax with placeholder values


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

Response structure


resp.q_search_status #=> String, one of "ENABLED", "DISABLED"
resp.request_id #=> String
resp.status #=> Integer

Parameters:

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

Options Hash (params):

:aws_account_id (required, String) —
The ID of the Amazon Web Services account that contains the Quick Sight Q Search configuration that the user wants described.

Returns:

(Types::DescribeQuickSightQSearchConfigurationResponse) —
Returns a response object which responds to the following methods:
- #q_search_status => String
- #request_id => String
- #status => Integer

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 12083

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

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

Provides a summary of a refresh schedule.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

Options Hash (params):

:aws_account_id (required, String) —
The Amazon Web Services account ID.
:data_set_id (required, String) —
The ID of the dataset.
:schedule_id (required, String) —
The ID of the refresh schedule.

Returns:

(Types::DescribeRefreshScheduleResponse) —
Returns a response object which responds to the following methods:
- #refresh_schedule => Types::RefreshSchedule
- #status => Integer
- #request_id => String
- #arn => String

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 12133

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

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

Describes all custom permissions that are mapped to a role.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

Options Hash (params):

:role (required, String) —
The name of the role whose permissions you want described.
:aws_account_id (required, String) —
The ID for the Amazon Web Services account that you want to create a group in. The Amazon Web Services account ID that you provide must be the same Amazon Web Services account that contains your Amazon Quick Sight account.
:namespace (required, String) —
The namespace that contains the role.

Returns:

(Types::DescribeRoleCustomPermissionResponse) —
Returns a response object which responds to the following methods:
- #custom_permissions_name => String
- #request_id => String
- #status => Integer

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 12176

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

#describe_self_upgrade_configuration(params = {}) ⇒ `Types::DescribeSelfUpgradeConfigurationResponse`

Describes the self-upgrade configuration for a Quick account.

Examples:

Request syntax with placeholder values


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

Response structure


resp.self_upgrade_configuration.self_upgrade_status #=> String, one of "AUTO_APPROVAL", "ADMIN_APPROVAL"
resp.request_id #=> String
resp.status #=> Integer

Parameters:

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

Options Hash (params):

:aws_account_id (required, String) —
The ID of the Amazon Web Services account that contains the Quick self-upgrade configuration.
:namespace (required, String) —
The Quick namespace that you want to describe the Quick self-upgrade configuration for.

Returns:

(Types::DescribeSelfUpgradeConfigurationResponse) —
Returns a response object which responds to the following methods:
- #self_upgrade_configuration => Types::SelfUpgradeConfiguration
- #request_id => String
- #status => Integer

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 12214

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

#describe_space(params = {}) ⇒ `Types::DescribeSpaceResponse`

Describes an Amazon QuickSight space.

Examples:

Request syntax with placeholder values


resp = client.describe_space({
  aws_account_id: "AwsAccountId", # required
  space_id: "PublicSpaceId", # required
  max_contributors: 1,
})

Response structure


resp.space_id #=> String
resp.space_arn #=> String
resp.space.name #=> String
resp.space.description #=> String
resp.space.resources #=> Array
resp.space.resources[0].resource_type #=> String, one of "TOPIC", "DASHBOARD", "KNOWLEDGE_BASE", "ACTION_CONNECTOR", "DATA_SET"
resp.space.resources[0].resource_details.resource_arn #=> String
resp.space.created_at #=> Time
resp.space.updated_at #=> Time
resp.space.consumed_source_size #=> Integer
resp.space.consumed_source_doc_count #=> Integer
resp.space.created_by #=> String
resp.space.created_by_arn #=> String
resp.contributors #=> Array
resp.contributors[0].user_name #=> String
resp.contributors[0].raw_file_size_bytes #=> Integer
resp.contributors[0].percentage #=> Float
resp.request_id #=> String

Parameters:

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

Options Hash (params):

:aws_account_id (required, String) —
The ID of the Amazon Web Services account that contains the space.
:space_id (required, String) —
The ID of the space that you want to describe.
:max_contributors (Integer) —
The maximum number of contributors to include in the response.

Returns:

(Types::DescribeSpaceResponse) —
Returns a response object which responds to the following methods:
- #space_id => String
- #space_arn => String
- #space => Types::SpaceDetails
- #contributors => Array<Types::SpaceContributor>
- #request_id => String

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 12271

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

#describe_space_permissions(params = {}) ⇒ `Types::DescribeSpacePermissionsResponse`

Describes the permissions for an Amazon QuickSight space.

Examples:

Request syntax with placeholder values


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

Response structure


resp.space_id #=> String
resp.space_arn #=> String
resp.permissions #=> Array
resp.permissions[0].principal #=> String
resp.permissions[0].actions #=> Array
resp.permissions[0].actions[0] #=> String
resp.request_id #=> String

Parameters:

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

Options Hash (params):

:aws_account_id (required, String) —
The ID of the Amazon Web Services account that contains the space.
:space_id (required, String) —
The ID of the space that you want to describe permissions for.

Returns:

(Types::DescribeSpacePermissionsResponse) —
Returns a response object which responds to the following methods:
- #space_id => String
- #space_arn => String
- #permissions => Array<Types::ResourcePermission>
- #request_id => String

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 12312

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

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

Describes a template's metadata.

Examples:

Request syntax with placeholder values


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

Response structure


resp.template.arn #=> String
resp.template.name #=> String
resp.template.version.created_time #=> Time
resp.template.version.errors #=> Array
resp.template.version.errors[0].type #=> String, one of "SOURCE_NOT_FOUND", "DATA_SET_NOT_FOUND", "INTERNAL_FAILURE", "ACCESS_DENIED"
resp.template.version.errors[0].message #=> String
resp.template.version.errors[0].violated_entities #=> Array
resp.template.version.errors[0].violated_entities[0].path #=> String
resp.template.version.version_number #=> Integer
resp.template.version.status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED", "DELETED"
resp.template.version.data_set_configurations #=> Array
resp.template.version.data_set_configurations[0].placeholder #=> String
resp.template.version.data_set_configurations[0].data_set_schema.column_schema_list #=> Array
resp.template.version.data_set_configurations[0].data_set_schema.column_schema_list[0].name #=> String
resp.template.version.data_set_configurations[0].data_set_schema.column_schema_list[0].data_type #=> String
resp.template.version.data_set_configurations[0].data_set_schema.column_schema_list[0].geographic_role #=> String
resp.template.version.data_set_configurations[0].column_group_schema_list #=> Array
resp.template.version.data_set_configurations[0].column_group_schema_list[0].name #=> String
resp.template.version.data_set_configurations[0].column_group_schema_list[0].column_group_column_schema_list #=> Array
resp.template.version.data_set_configurations[0].column_group_schema_list[0].column_group_column_schema_list[0].name #=> String
resp.template.version.topic_configurations #=> Array
resp.template.version.topic_configurations[0].placeholder #=> String
resp.template.version.topic_configurations[0].data_set_schema.column_schema_list #=> Array
resp.template.version.topic_configurations[0].data_set_schema.column_schema_list[0].name #=> String
resp.template.version.topic_configurations[0].data_set_schema.column_schema_list[0].data_type #=> String
resp.template.version.topic_configurations[0].data_set_schema.column_schema_list[0].geographic_role #=> String
resp.template.version.topic_configurations[0].column_group_schema_list #=> Array
resp.template.version.topic_configurations[0].column_group_schema_list[0].name #=> String
resp.template.version.topic_configurations[0].column_group_schema_list[0].column_group_column_schema_list #=> Array
resp.template.version.topic_configurations[0].column_group_schema_list[0].column_group_column_schema_list[0].name #=> String
resp.template.version.description #=> String
resp.template.version.source_entity_arn #=> String
resp.template.version.theme_arn #=> String
resp.template.version.sheets #=> Array
resp.template.version.sheets[0].sheet_id #=> String
resp.template.version.sheets[0].name #=> String
resp.template.version.sheets[0].images #=> Array
resp.template.version.sheets[0].images[0].sheet_image_id #=> String
resp.template.version.sheets[0].images[0].source.sheet_image_static_file_source.static_file_id #=> String
resp.template.version.sheets[0].images[0].scaling.scaling_type #=> String, one of "SCALE_TO_WIDTH", "SCALE_TO_HEIGHT", "SCALE_TO_CONTAINER", "SCALE_NONE"
resp.template.version.sheets[0].images[0].tooltip.tooltip_text.plain_text #=> String
resp.template.version.sheets[0].images[0].tooltip.visibility #=> String, one of "HIDDEN", "VISIBLE"
resp.template.version.sheets[0].images[0].image_content_alt_text #=> String
resp.template.version.sheets[0].images[0].interactions.image_menu_option.availability_status #=> String, one of "ENABLED", "DISABLED"
resp.template.version.sheets[0].images[0].actions #=> Array
resp.template.version.sheets[0].images[0].actions[0].custom_action_id #=> String
resp.template.version.sheets[0].images[0].actions[0].name #=> String
resp.template.version.sheets[0].images[0].actions[0].status #=> String, one of "ENABLED", "DISABLED"
resp.template.version.sheets[0].images[0].actions[0].trigger #=> String, one of "CLICK", "MENU"
resp.template.version.sheets[0].images[0].actions[0].action_operations #=> Array
resp.template.version.sheets[0].images[0].actions[0].action_operations[0].navigation_operation.local_navigation_configuration.target_sheet_id #=> String
resp.template.version.sheets[0].images[0].actions[0].action_operations[0].url_operation.url_template #=> String
resp.template.version.sheets[0].images[0].actions[0].action_operations[0].url_operation.url_target #=> String, one of "NEW_TAB", "NEW_WINDOW", "SAME_TAB"
resp.template.version.sheets[0].images[0].actions[0].action_operations[0].set_parameters_operation.parameter_value_configurations #=> Array
resp.template.version.sheets[0].images[0].actions[0].action_operations[0].set_parameters_operation.parameter_value_configurations[0].destination_parameter_name #=> String
resp.template.version.sheets[0].images[0].actions[0].action_operations[0].set_parameters_operation.parameter_value_configurations[0].value.custom_values_configuration.include_null_value #=> Boolean
resp.template.version.sheets[0].images[0].actions[0].action_operations[0].set_parameters_operation.parameter_value_configurations[0].value.custom_values_configuration.custom_values.string_values #=> Array
resp.template.version.sheets[0].images[0].actions[0].action_operations[0].set_parameters_operation.parameter_value_configurations[0].value.custom_values_configuration.custom_values.string_values[0] #=> String
resp.template.version.sheets[0].images[0].actions[0].action_operations[0].set_parameters_operation.parameter_value_configurations[0].value.custom_values_configuration.custom_values.integer_values #=> Array
resp.template.version.sheets[0].images[0].actions[0].action_operations[0].set_parameters_operation.parameter_value_configurations[0].value.custom_values_configuration.custom_values.integer_values[0] #=> Integer
resp.template.version.sheets[0].images[0].actions[0].action_operations[0].set_parameters_operation.parameter_value_configurations[0].value.custom_values_configuration.custom_values.decimal_values #=> Array
resp.template.version.sheets[0].images[0].actions[0].action_operations[0].set_parameters_operation.parameter_value_configurations[0].value.custom_values_configuration.custom_values.decimal_values[0] #=> Float
resp.template.version.sheets[0].images[0].actions[0].action_operations[0].set_parameters_operation.parameter_value_configurations[0].value.custom_values_configuration.custom_values.date_time_values #=> Array
resp.template.version.sheets[0].images[0].actions[0].action_operations[0].set_parameters_operation.parameter_value_configurations[0].value.custom_values_configuration.custom_values.date_time_values[0] #=> Time
resp.template.version.sheets[0].images[0].actions[0].action_operations[0].set_parameters_operation.parameter_value_configurations[0].value.select_all_value_options #=> String, one of "ALL_VALUES"
resp.template.version.sheets[0].images[0].actions[0].action_operations[0].set_parameters_operation.parameter_value_configurations[0].value.source_parameter_name #=> String
resp.template.version.sheets[0].images[0].actions[0].action_operations[0].set_parameters_operation.parameter_value_configurations[0].value.source_field #=> String
resp.template.version.sheets[0].images[0].actions[0].action_operations[0].set_parameters_operation.parameter_value_configurations[0].value.source_column.data_set_identifier #=> String
resp.template.version.sheets[0].images[0].actions[0].action_operations[0].set_parameters_operation.parameter_value_configurations[0].value.source_column.topic_identifier #=> String
resp.template.version.sheets[0].images[0].actions[0].action_operations[0].set_parameters_operation.parameter_value_configurations[0].value.source_column.column_name #=> String
resp.template.template_id #=> String
resp.template.last_updated_time #=> Time
resp.template.created_time #=> Time
resp.status #=> Integer
resp.request_id #=> String

Parameters:

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

Options Hash (params):

:aws_account_id (required, String) —
The ID of the Amazon Web Services account that contains the template that you're describing.
:template_id (required, String) —
The ID for the template.
:version_number (Integer) — default: Optional —
The number for the version to describe. If a VersionNumber parameter value isn't provided, the latest version of the template is described.
:alias_name (String) —
The alias of the template that you want to describe. If you name a specific alias, you describe the version that the alias points to. You can specify the latest version of the template by providing the keyword $LATEST in the AliasName parameter. The keyword $PUBLISHED doesn't apply to templates.

Returns:

(Types::DescribeTemplateResponse) —
Returns a response object which responds to the following methods:
- #template => Types::Template
- #status => Integer
- #request_id => String

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 12435

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

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

Describes the template alias for a template.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

Options Hash (params):

:aws_account_id (required, String) —
The ID of the Amazon Web Services account that contains the template alias that you're describing.
:template_id (required, String) —
The ID for the template.
:alias_name (required, String) —
The name of the template alias that you want to describe. If you name a specific alias, you describe the version that the alias points to. You can specify the latest version of the template by providing the keyword $LATEST in the AliasName parameter. The keyword $PUBLISHED doesn't apply to templates.

Returns:

(Types::DescribeTemplateAliasResponse) —
Returns a response object which responds to the following methods:
- #template_alias => Types::TemplateAlias
- #status => Integer
- #request_id => String

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 12482

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

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

Provides a detailed description of the definition of a template.

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

Examples:

Request syntax with placeholder values


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

Parameters:

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

Options Hash (params):

:aws_account_id (required, String) —
The ID of the Amazon Web Services account that contains the template. You must be using the Amazon Web Services account that the template is in.
:template_id (required, String) —
The ID of the template that you're describing.
:version_number (Integer) —
The version number of the template.
:alias_name (String) —
The alias of the template that you want to describe. If you name a specific alias, you describe the version that the alias points to. You can specify the latest version of the template by providing the keyword $LATEST in the AliasName parameter. The keyword $PUBLISHED doesn't apply to templates.

Returns:

(Types::DescribeTemplateDefinitionResponse) —
Returns a response object which responds to the following methods:
- #name => String
- #template_id => String
- #errors => Array<Types::TemplateError>
- #resource_status => String
- #theme_arn => String
- #definition => Types::TemplateVersionDefinition
- #status => Integer
- #request_id => String

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 12542

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

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

Describes read and write permissions on a template.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

Options Hash (params):

:aws_account_id (required, String) —
The ID of the Amazon Web Services account that contains the template that you're describing.
:template_id (required, String) —
The ID for the template.

Returns:

(Types::DescribeTemplatePermissionsResponse) —
Returns a response object which responds to the following methods:
- #template_id => String
- #template_arn => String
- #permissions => Array<Types::ResourcePermission>
- #request_id => String
- #status => Integer

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 12586

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

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

Describes a theme.

Examples:

Request syntax with placeholder values


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

Response structure


resp.theme.arn #=> String
resp.theme.name #=> String
resp.theme.theme_id #=> String
resp.theme.version.version_number #=> Integer
resp.theme.version.arn #=> String
resp.theme.version.description #=> String
resp.theme.version.base_theme_id #=> String
resp.theme.version.created_time #=> Time
resp.theme.version.configuration.data_color_palette.colors #=> Array
resp.theme.version.configuration.data_color_palette.colors[0] #=> String
resp.theme.version.configuration.data_color_palette.min_max_gradient #=> Array
resp.theme.version.configuration.data_color_palette.min_max_gradient[0] #=> String
resp.theme.version.configuration.data_color_palette.empty_fill_color #=> String
resp.theme.version.configuration.ui_color_palette.primary_foreground #=> String
resp.theme.version.configuration.ui_color_palette.primary_background #=> String
resp.theme.version.configuration.ui_color_palette.secondary_foreground #=> String
resp.theme.version.configuration.ui_color_palette.secondary_background #=> String
resp.theme.version.configuration.ui_color_palette.accent #=> String
resp.theme.version.configuration.ui_color_palette.accent_foreground #=> String
resp.theme.version.configuration.ui_color_palette.danger #=> String
resp.theme.version.configuration.ui_color_palette.danger_foreground #=> String
resp.theme.version.configuration.ui_color_palette.warning #=> String
resp.theme.version.configuration.ui_color_palette.warning_foreground #=> String
resp.theme.version.configuration.ui_color_palette.success #=> String
resp.theme.version.configuration.ui_color_palette.success_foreground #=> String
resp.theme.version.configuration.ui_color_palette.dimension #=> String
resp.theme.version.configuration.ui_color_palette.dimension_foreground #=> String
resp.theme.version.configuration.ui_color_palette.measure #=> String
resp.theme.version.configuration.ui_color_palette.measure_foreground #=> String
resp.theme.version.configuration.sheet.tile.background_color #=> String
resp.theme.version.configuration.sheet.tile.border.color #=> String
resp.theme.version.configuration.sheet.tile.border.show #=> Boolean
resp.theme.version.configuration.sheet.tile.border.width #=> String
resp.theme.version.configuration.sheet.tile.border_radius #=> String
resp.theme.version.configuration.sheet.tile.padding #=> String
resp.theme.version.configuration.sheet.tile_layout.gutter.show #=> Boolean
resp.theme.version.configuration.sheet.tile_layout.margin.show #=> Boolean
resp.theme.version.configuration.sheet.background.color #=> String
resp.theme.version.configuration.sheet.background.gradient #=> String
resp.theme.version.configuration.typography.font_families #=> Array
resp.theme.version.configuration.typography.font_families[0].font_family #=> String
resp.theme.version.configuration.typography.axis_title_font_configuration.font_size.relative #=> String, one of "EXTRA_SMALL", "SMALL", "MEDIUM", "LARGE", "EXTRA_LARGE"
resp.theme.version.configuration.typography.axis_title_font_configuration.font_size.absolute #=> String
resp.theme.version.configuration.typography.axis_title_font_configuration.font_decoration #=> String, one of "UNDERLINE", "NONE"
resp.theme.version.configuration.typography.axis_title_font_configuration.font_color #=> String
resp.theme.version.configuration.typography.axis_title_font_configuration.font_weight.name #=> String, one of "NORMAL", "BOLD"
resp.theme.version.configuration.typography.axis_title_font_configuration.font_style #=> String, one of "NORMAL", "ITALIC"
resp.theme.version.configuration.typography.axis_title_font_configuration.font_family #=> String
resp.theme.version.configuration.typography.axis_label_font_configuration.font_size.relative #=> String, one of "EXTRA_SMALL", "SMALL", "MEDIUM", "LARGE", "EXTRA_LARGE"
resp.theme.version.configuration.typography.axis_label_font_configuration.font_size.absolute #=> String
resp.theme.version.configuration.typography.axis_label_font_configuration.font_decoration #=> String, one of "UNDERLINE", "NONE"
resp.theme.version.configuration.typography.axis_label_font_configuration.font_color #=> String
resp.theme.version.configuration.typography.axis_label_font_configuration.font_weight.name #=> String, one of "NORMAL", "BOLD"
resp.theme.version.configuration.typography.axis_label_font_configuration.font_style #=> String, one of "NORMAL", "ITALIC"
resp.theme.version.configuration.typography.axis_label_font_configuration.font_family #=> String
resp.theme.version.configuration.typography.legend_title_font_configuration.font_size.relative #=> String, one of "EXTRA_SMALL", "SMALL", "MEDIUM", "LARGE", "EXTRA_LARGE"
resp.theme.version.configuration.typography.legend_title_font_configuration.font_size.absolute #=> String
resp.theme.version.configuration.typography.legend_title_font_configuration.font_decoration #=> String, one of "UNDERLINE", "NONE"
resp.theme.version.configuration.typography.legend_title_font_configuration.font_color #=> String
resp.theme.version.configuration.typography.legend_title_font_configuration.font_weight.name #=> String, one of "NORMAL", "BOLD"
resp.theme.version.configuration.typography.legend_title_font_configuration.font_style #=> String, one of "NORMAL", "ITALIC"
resp.theme.version.configuration.typography.legend_title_font_configuration.font_family #=> String
resp.theme.version.configuration.typography.legend_value_font_configuration.font_size.relative #=> String, one of "EXTRA_SMALL", "SMALL", "MEDIUM", "LARGE", "EXTRA_LARGE"
resp.theme.version.configuration.typography.legend_value_font_configuration.font_size.absolute #=> String
resp.theme.version.configuration.typography.legend_value_font_configuration.font_decoration #=> String, one of "UNDERLINE", "NONE"
resp.theme.version.configuration.typography.legend_value_font_configuration.font_color #=> String
resp.theme.version.configuration.typography.legend_value_font_configuration.font_weight.name #=> String, one of "NORMAL", "BOLD"
resp.theme.version.configuration.typography.legend_value_font_configuration.font_style #=> String, one of "NORMAL", "ITALIC"
resp.theme.version.configuration.typography.legend_value_font_configuration.font_family #=> String
resp.theme.version.configuration.typography.data_label_font_configuration.font_size.relative #=> String, one of "EXTRA_SMALL", "SMALL", "MEDIUM", "LARGE", "EXTRA_LARGE"
resp.theme.version.configuration.typography.data_label_font_configuration.font_size.absolute #=> String
resp.theme.version.configuration.typography.data_label_font_configuration.font_decoration #=> String, one of "UNDERLINE", "NONE"
resp.theme.version.configuration.typography.data_label_font_configuration.font_color #=> String
resp.theme.version.configuration.typography.data_label_font_configuration.font_weight.name #=> String, one of "NORMAL", "BOLD"
resp.theme.version.configuration.typography.data_label_font_configuration.font_style #=> String, one of "NORMAL", "ITALIC"
resp.theme.version.configuration.typography.data_label_font_configuration.font_family #=> String
resp.theme.version.configuration.typography.visual_title_font_configuration.font_configuration.font_size.relative #=> String, one of "EXTRA_SMALL", "SMALL", "MEDIUM", "LARGE", "EXTRA_LARGE"
resp.theme.version.configuration.typography.visual_title_font_configuration.font_configuration.font_size.absolute #=> String
resp.theme.version.configuration.typography.visual_title_font_configuration.font_configuration.font_decoration #=> String, one of "UNDERLINE", "NONE"
resp.theme.version.configuration.typography.visual_title_font_configuration.font_configuration.font_color #=> String
resp.theme.version.configuration.typography.visual_title_font_configuration.font_configuration.font_weight.name #=> String, one of "NORMAL", "BOLD"
resp.theme.version.configuration.typography.visual_title_font_configuration.font_configuration.font_style #=> String, one of "NORMAL", "ITALIC"
resp.theme.version.configuration.typography.visual_title_font_configuration.font_configuration.font_family #=> String
resp.theme.version.configuration.typography.visual_title_font_configuration.text_alignment #=> String, one of "LEFT", "CENTER", "RIGHT", "AUTO"
resp.theme.version.configuration.typography.visual_title_font_configuration.text_transform #=> String, one of "CAPITALIZE"
resp.theme.version.configuration.typography.visual_subtitle_font_configuration.font_configuration.font_size.relative #=> String, one of "EXTRA_SMALL", "SMALL", "MEDIUM", "LARGE", "EXTRA_LARGE"
resp.theme.version.configuration.typography.visual_subtitle_font_configuration.font_configuration.font_size.absolute #=> String
resp.theme.version.configuration.typography.visual_subtitle_font_configuration.font_configuration.font_decoration #=> String, one of "UNDERLINE", "NONE"
resp.theme.version.configuration.typography.visual_subtitle_font_configuration.font_configuration.font_color #=> String
resp.theme.version.configuration.typography.visual_subtitle_font_configuration.font_configuration.font_weight.name #=> String, one of "NORMAL", "BOLD"
resp.theme.version.configuration.typography.visual_subtitle_font_configuration.font_configuration.font_style #=> String, one of "NORMAL", "ITALIC"
resp.theme.version.configuration.typography.visual_subtitle_font_configuration.font_configuration.font_family #=> String
resp.theme.version.configuration.typography.visual_subtitle_font_configuration.text_alignment #=> String, one of "LEFT", "CENTER", "RIGHT", "AUTO"
resp.theme.version.configuration.typography.visual_subtitle_font_configuration.text_transform #=> String, one of "CAPITALIZE"
resp.theme.version.configuration.typography.control_title_font_configuration.font_configuration.font_size.relative #=> String, one of "EXTRA_SMALL", "SMALL", "MEDIUM", "LARGE", "EXTRA_LARGE"
resp.theme.version.configuration.typography.control_title_font_configuration.font_configuration.font_size.absolute #=> String
resp.theme.version.configuration.typography.control_title_font_configuration.font_configuration.font_decoration #=> String, one of "UNDERLINE", "NONE"
resp.theme.version.configuration.typography.control_title_font_configuration.font_configuration.font_color #=> String
resp.theme.version.configuration.typography.control_title_font_configuration.font_configuration.font_weight.name #=> String, one of "NORMAL", "BOLD"
resp.theme.version.configuration.typography.control_title_font_configuration.font_configuration.font_style #=> String, one of "NORMAL", "ITALIC"
resp.theme.version.configuration.typography.control_title_font_configuration.font_configuration.font_family #=> String
resp.theme.version.configuration.typography.control_title_font_configuration.text_alignment #=> String, one of "LEFT", "CENTER", "RIGHT", "AUTO"
resp.theme.version.errors #=> Array
resp.theme.version.errors[0].type #=> String, one of "INTERNAL_FAILURE"
resp.theme.version.errors[0].message #=> String
resp.theme.version.status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED", "DELETED"
resp.theme.created_time #=> Time
resp.theme.last_updated_time #=> Time
resp.theme.type #=> String, one of "QUICKSIGHT", "CUSTOM", "ALL"
resp.status #=> Integer
resp.request_id #=> String

Parameters:

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

Options Hash (params):

:aws_account_id (required, String) —
The ID of the Amazon Web Services account that contains the theme that you're describing.
:theme_id (required, String) —
The ID for the theme.
:version_number (Integer) —
The version number for the version to describe. If a VersionNumber parameter value isn't provided, the latest version of the theme is described.
:alias_name (String) —
The alias of the theme that you want to describe. If you name a specific alias, you describe the version that the alias points to. You can specify the latest version of the theme by providing the keyword $LATEST in the AliasName parameter. The keyword $PUBLISHED doesn't apply to themes.

Returns:

(Types::DescribeThemeResponse) —
Returns a response object which responds to the following methods:
- #theme => Types::Theme
- #status => Integer
- #request_id => String

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 12745

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

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

Describes the alias for a theme.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

Options Hash (params):

:aws_account_id (required, String) —
The ID of the Amazon Web Services account that contains the theme alias that you're describing.
:theme_id (required, String) —
The ID for the theme.
:alias_name (required, String) —
The name of the theme alias that you want to describe.

Returns:

(Types::DescribeThemeAliasResponse) —
Returns a response object which responds to the following methods:
- #theme_alias => Types::ThemeAlias
- #status => Integer
- #request_id => String

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 12788

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

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

Describes the read and write permissions for a theme.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

Options Hash (params):

:aws_account_id (required, String) —
The ID of the Amazon Web Services account that contains the theme that you're describing.
:theme_id (required, String) —
The ID for the theme that you want to describe permissions for.

Returns:

(Types::DescribeThemePermissionsResponse) —
Returns a response object which responds to the following methods:
- #theme_id => String
- #theme_arn => String
- #permissions => Array<Types::ResourcePermission>
- #request_id => String
- #status => Integer

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 12832

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

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

Describes a topic.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

Options Hash (params):

:aws_account_id (required, String) —
The Amazon Web Services account ID.
:topic_id (required, String) —
The ID of the topic that you want to describe. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

Returns:

(Types::DescribeTopicResponse) —
Returns a response object which responds to the following methods:
- #arn => String
- #topic_id => String
- #topic => Types::TopicDetails
- #request_id => String
- #status => Integer
- #custom_instructions => Types::CustomInstructions

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 13049

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

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

Describes the permissions of a topic.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

Options Hash (params):

:aws_account_id (required, String) —
The ID of the Amazon Web Services account that contains the topic that you want described.
:topic_id (required, String) —
The ID of the topic that you want to describe. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

Returns:

(Types::DescribeTopicPermissionsResponse) —
Returns a response object which responds to the following methods:
- #topic_id => String
- #topic_arn => String
- #permissions => Array<Types::ResourcePermission>
- #status => Integer
- #request_id => String

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 13094

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

#describe_topic_permissions_v2(params = {}) ⇒ `Types::DescribeTopicPermissionsV2Response`

Describes the permissions of a topic.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

Options Hash (params):

:aws_account_id (required, String) —
The ID of the Amazon Web Services account that contains the topic that you want described.
:topic_id (required, String) —
The ID of the topic that you want to describe. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

Returns:

(Types::DescribeTopicPermissionsV2Response) —
Returns a response object which responds to the following methods:
- #topic_id => String
- #topic_arn => String
- #permissions => Array<Types::ResourcePermission>
- #status => Integer
- #request_id => String

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 13139

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

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

Describes the status of a topic refresh.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

Options Hash (params):

:aws_account_id (required, String) —
The ID of the Amazon Web Services account that contains the topic whose refresh you want to describe.
:topic_id (required, String) —
The ID of the topic that you want to describe. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
:refresh_id (required, String) —
The ID of the refresh, which is performed when the topic is created or updated.

Returns:

(Types::DescribeTopicRefreshResponse) —
Returns a response object which responds to the following methods:
- #refresh_details => Types::TopicRefreshDetails
- #request_id => String
- #status => Integer

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 13184

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

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

Deletes a topic refresh schedule.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

Options Hash (params):

:aws_account_id (required, String) —
The Amazon Web Services account ID.
:topic_id (required, String) —
The ID of the topic that contains the refresh schedule that you want to describe. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
:dataset_id (required, String) —
The ID of the dataset.

Returns:

(Types::DescribeTopicRefreshScheduleResponse) —
Returns a response object which responds to the following methods:
- #topic_id => String
- #topic_arn => String
- #dataset_arn => String
- #refresh_schedule => Types::TopicRefreshSchedule
- #status => Integer
- #request_id => String

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 13237

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

#describe_topic_v2(params = {}) ⇒ `Types::DescribeTopicV2Response`

Describes a Q topic.

Examples:

Request syntax with placeholder values


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

Response structure


resp.arn #=> String
resp.topic_id #=> String
resp.topic.name #=> String
resp.topic.description #=> String
resp.topic.data_sets #=> Array
resp.topic.data_sets[0].data_set_arn #=> String
resp.topic.data_sets[0].data_set_name #=> String
resp.topic.data_set_relations #=> Array
resp.topic.data_set_relations[0].left.data_set_arn #=> String
resp.topic.data_set_relations[0].left.column_names #=> Array
resp.topic.data_set_relations[0].left.column_names[0] #=> String
resp.topic.data_set_relations[0].right.data_set_arn #=> String
resp.topic.data_set_relations[0].right.column_names #=> Array
resp.topic.data_set_relations[0].right.column_names[0] #=> String
resp.custom_instructions.custom_instructions_string #=> String
resp.status #=> Integer
resp.request_id #=> String

Parameters:

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

Options Hash (params):

:aws_account_id (required, String) —
The ID of the Amazon Web Services account that contains the topic that you want to describe.
:topic_id (required, String) —
The ID of the topic that you want to describe. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

Returns:

(Types::DescribeTopicV2Response) —
Returns a response object which responds to the following methods:
- #arn => String
- #topic_id => String
- #topic => Types::TopicV2Details
- #custom_instructions => Types::CustomInstructions
- #status => Integer
- #request_id => String

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 13292

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

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

Returns information about a user, given the user name.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

Options Hash (params):

:user_name (required, String) —
The name of the user that you want to describe.
:aws_account_id (required, String) —
The ID for the Amazon Web Services account that the user is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon Quick Sight account.
:namespace (required, String) —
The namespace. Currently, you should set this to default.

Returns:

(Types::DescribeUserResponse) —
Returns a response object which responds to the following methods:
- #user => Types::User
- #request_id => String
- #status => Integer

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 13344

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

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

Describes a VPC connection.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

Options Hash (params):

:aws_account_id (required, String) —
The Amazon Web Services account ID of the account that contains the VPC connection that you want described.
:vpc_connection_id (required, String) —
The ID of the VPC connection that you're creating. This ID is a unique identifier for each Amazon Web Services Region in an Amazon Web Services account.

Returns:

(Types::DescribeVPCConnectionResponse) —
Returns a response object which responds to the following methods:
- #vpc_connection => Types::VPCConnection
- #request_id => String
- #status => Integer

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 13401

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

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

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

The following rules apply to the generated URL:

It contains a temporary bearer token. It is valid for 5 minutes after it is generated. Once redeemed within this period, it cannot be re-used again.
The URL validity period should not be confused with the actual session lifetime that can be customized using the SessionLifetimeInMinutes parameter. The resulting user session is valid for 15 minutes (minimum) to 10 hours (maximum). The default session duration is 10 hours.
You are charged only when the URL is used or there is interaction with Amazon Quick.

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

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

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

Options Hash (params):

:aws_account_id (required, String) —
The ID for the Amazon Web Services account that contains the dashboard that you're embedding.
:session_lifetime_in_minutes (Integer) —
How many minutes the session is valid. The session lifetime must be in [15-600] minutes range.
:namespace (required, String) —
The Amazon Quick Sight namespace that the anonymous user virtually belongs to. If you are not using an Amazon Quick custom namespace, set this to default.
:session_tags (Array<Types::SessionTag>) —
Session tags are user-specified strings that identify a session in your application. You can use these tags to implement row-level security (RLS) controls. Before you use the SessionTags parameter, make sure that you have configured the relevant datasets using the DataSet$RowLevelPermissionTagConfiguration parameter so that session tags can be used to provide row-level security.

When using SessionTags in GenerateEmbedUrlForAnonymousUser,
- Treat SessionTags as security credentials. Do not expose SessionTags to end users or client-side code.
- Implement server-side controls. Ensure that SessionTags are set exclusively by your trusted backend services, not by parameters that end users can modify.
- Protect SessionTags from enumeration. Ensure that users in one tenant cannot discover or guess sessionTag values belonging to other tenants.
- Review your architecture. If downstream customers or partners are allowed to call the GenerateEmbedUrlForAnonymousUser API directly, evaluate whether those parties could specify sessionTag values for tenants they should not access.
Besides, these are not the tags used for the Amazon Web Services resource tagging feature. For more information, see Using Row-Level Security (RLS) with Tags in the Amazon Quick User Guide.
:authorized_resource_arns (required, Array<String>) —
The Amazon Resource Names (ARNs) for the Quick Sight resources that the user is authorized to access during the lifetime of the session.

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

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

Currently, you can pass up to 25 theme ARNs in each API call.
:experience_configuration (required, Types::AnonymousUserEmbeddingExperienceConfiguration) —
The configuration of the experience that you are embedding.
:allowed_domains (Array<String>) —
The domains that you want to add to the allow list for access to the generated URL that is then embedded. This optional parameter overrides the static domains that are configured in the Manage Quick Sight menu in the Amazon Quick Sight console. Instead, it allows only the domains that you include in this parameter. You can list up to three domains or subdomains in each API call.

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

Returns:

(Types::GenerateEmbedUrlForAnonymousUserResponse) —
Returns a response object which responds to the following methods:
- #embed_url => String
- #status => Integer
- #request_id => String
- #anonymous_user_arn => String

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 13572

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

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

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

The following rules apply to the generated URL:

It contains a temporary bearer token. It is valid for 5 minutes after it is generated. Once redeemed within this period, it cannot be re-used again.
The URL validity period should not be confused with the actual session lifetime that can be customized using the SessionLifetimeInMinutes parameter.

The resulting user session is valid for 15 minutes (minimum) to 10 hours (maximum). The default session duration is 10 hours.
You are charged only when the URL is used or there is interaction with Amazon Quick.

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

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

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

Options Hash (params):

:aws_account_id (required, String) —
The ID for the Amazon Web Services account that contains the dashboard that you're embedding.
:session_lifetime_in_minutes (Integer) —
How many minutes the session is valid. The session lifetime must be in [15-600] minutes range.
:user_arn (required, String) —
The Amazon Resource Name for the registered user.
:experience_configuration (required, Types::RegisteredUserEmbeddingExperienceConfiguration) —
The experience that you want to embed. For registered users, you can embed Quick dashboards, Amazon Quick Sight visuals, the Amazon Quick Sight Q search bar, the Amazon Quick Sight Generative Q&A experience, or the entire Amazon Quick Sight console.
:allowed_domains (Array<String>) —
The domains that you want to add to the allow list for access to the generated URL that is then embedded. This optional parameter overrides the static domains that are configured in the Manage Quick Sight menu in the Amazon Quick Sight console. Instead, it allows only the domains that you include in this parameter. You can list up to three domains or subdomains in each API call.

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

Returns:

(Types::GenerateEmbedUrlForRegisteredUserResponse) —
Returns a response object which responds to the following methods:
- #embed_url => String
- #status => Integer
- #request_id => String

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 13750

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

#generate_embed_url_for_registered_user_with_identity(params = {}) ⇒ `Types::GenerateEmbedUrlForRegisteredUserWithIdentityResponse`

Generates an embed URL that you can use to embed an Amazon Quick Sight experience in your website. This action can be used for any type of user that is registered in an Amazon Quick Sight account that uses IAM Identity Center for authentication. This API requires identity-enhanced IAM Role sessions for the authenticated user that the API call is being made for.

This API uses trusted identity propagation to ensure that an end user is authenticated and receives the embed URL that is specific to that user. The IAM Identity Center application that the user has logged into needs to have trusted Identity Propagation enabled for Amazon Quick Sight with the scope value set to quicksight:read. Before you use this action, make sure that you have configured the relevant Amazon Quick Sight resource and permissions.

Examples:

Request syntax with placeholder values


resp = client.generate_embed_url_for_registered_user_with_identity({
  aws_account_id: "AwsAccountId", # required
  session_lifetime_in_minutes: 1,
  experience_configuration: { # required
    dashboard: {
      initial_dashboard_id: "ShortRestrictiveResourceId", # required
      feature_configurations: {
        state_persistence: {
          enabled: false, # required
        },
        bookmarks: {
          enabled: false, # required
        },
        shared_view: {
          enabled: false, # required
        },
        amazon_q_in_quick_sight: {
          executive_summary: {
            enabled: false, # required
          },
        },
        schedules: {
          enabled: false, # required
        },
        recent_snapshots: {
          enabled: false, # required
        },
        threshold_alerts: {
          enabled: false, # required
        },
        dashboard_customization_summary: {
          enabled: false, # required
        },
      },
    },
    quick_sight_console: {
      initial_path: "EntryPath",
      feature_configurations: {
        state_persistence: {
          enabled: false, # required
        },
        shared_view: {
          enabled: false, # required
        },
        amazon_q_in_quick_sight: {
          data_qn_a: {
            enabled: false, # required
          },
          generative_authoring: {
            enabled: false, # required
          },
          executive_summary: {
            enabled: false, # required
          },
          data_stories: {
            enabled: false, # required
          },
        },
        schedules: {
          enabled: false, # required
        },
        recent_snapshots: {
          enabled: false, # required
        },
        threshold_alerts: {
          enabled: false, # required
        },
        dashboard_customization_summary: {
          enabled: false, # required
        },
      },
    },
    q_search_bar: {
      initial_topic_id: "RestrictiveResourceId",
    },
    dashboard_visual: {
      initial_dashboard_visual_id: { # required
        dashboard_id: "ShortRestrictiveResourceId", # required
        sheet_id: "ShortRestrictiveResourceId", # required
        visual_id: "ShortRestrictiveResourceId", # required
      },
    },
    generative_qn_a: {
      initial_topic_id: "RestrictiveResourceId",
    },
    quick_chat: {
    },
  },
  allowed_domains: ["String"],
})

Response structure


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

Parameters:

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

Options Hash (params):

:aws_account_id (required, String) —
The ID of the Amazon Web Services registered user.
:session_lifetime_in_minutes (Integer) —
The validity of the session in minutes.
:experience_configuration (required, Types::RegisteredUserEmbeddingExperienceConfiguration) —
The type of experience you want to embed. For registered users, you can embed Quick dashboards or the Amazon Quick Sight console.

Exactly one of the experience configurations is required. You can choose Dashboard or QuickSightConsole. You cannot choose more than one experience configuration.
:allowed_domains (Array<String>) —
A list of domains to be allowed to generate the embed URL.

Returns:

(Types::GenerateEmbedUrlForRegisteredUserWithIdentityResponse) —
Returns a response object which responds to the following methods:
- #embed_url => String
- #status => Integer
- #request_id => String

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 13904

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

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

Generates a temporary session URL and authorization code(bearer token) that you can use to embed an Amazon Quick Sight read-only dashboard in your website or application. Before you use this command, make sure that you have configured the dashboards and permissions.

Currently, you can use GetDashboardEmbedURL only from the server, not from the user's browser. The following rules apply to the generated URL:

They must be used together.
They can be used one time only.
They are valid for 5 minutes after you run this command.
You are charged only when the URL is used or there is interaction with Quick.
The resulting user session is valid for 15 minutes (default) up to 10 hours (maximum). You can use the optional SessionLifetimeInMinutes parameter to customize session duration.

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

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

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

Options Hash (params):

:aws_account_id (required, String) —
The ID for the Amazon Web Services account that contains the dashboard that you're embedding.
:dashboard_id (required, String) —
The ID for the dashboard, also added to the Identity and Access Management (IAM) policy.
:identity_type (required, String) —
The authentication method that the user uses to sign in.
:session_lifetime_in_minutes (Integer) —
How many minutes the session is valid. The session lifetime must be 15-600 minutes.
:undo_redo_disabled (Boolean) —
Remove the undo/redo button on the embedded dashboard. The default is FALSE, which enables the undo/redo button.
:reset_disabled (Boolean) —
Remove the reset button on the embedded dashboard. The default is FALSE, which enables the reset button.
:state_persistence_enabled (Boolean) —
Adds persistence of state for the user session in an embedded dashboard. Persistence applies to the sheet and the parameter settings. These are control settings that the dashboard subscriber (Amazon Quick Sight reader) chooses while viewing the dashboard. If this is set to TRUE, the settings are the same when the subscriber reopens the same dashboard URL. The state is stored in Amazon Quick Sight, not in a browser cookie. If this is set to FALSE, the state of the user session is not persisted. The default is FALSE.
:user_arn (String) —
The Amazon Quick user's Amazon Resource Name (ARN), for use with QUICKSIGHT identity type. You can use this for any Amazon Quick users in your account (readers, authors, or admins) authenticated as one of the following:
- Active Directory (AD) users or group members
- Invited nonfederated users
- IAM users and IAM role-based sessions authenticated through Federated Single Sign-On using SAML, OpenID Connect, or IAM federation.
Omit this parameter for users in the third group – IAM users and IAM role-based sessions.
:namespace (String) —
The Amazon Quick Sight namespace that contains the dashboard IDs in this request. If you're not using a custom namespace, set Namespace = default.
:additional_dashboard_ids (Array<String>) —
A list of one or more dashboard IDs that you want anonymous users to have tempporary access to. Currently, the IdentityType parameter must be set to ANONYMOUS because other identity types authenticate as Quick or IAM users. For example, if you set "--dashboard-id dash_id1 --dashboard-id dash_id2 dash_id3 identity-type ANONYMOUS", the session can access all three dashboards.

Returns:

(Types::GetDashboardEmbedUrlResponse) —
Returns a response object which responds to the following methods:
- #embed_url => String
- #status => Integer
- #request_id => String

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 14037

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

#get_flow_metadata(params = {}) ⇒ `Types::GetFlowMetadataOutput`

Retrieves the metadata of a flow, not including its definition specifying the steps.

Examples:

Request syntax with placeholder values


resp = client.get_flow_metadata({
  aws_account_id: "AccountId", # required
  flow_id: "FlowId", # required
})

Response structure


resp.arn #=> String
resp.flow_id #=> String
resp.name #=> String
resp.description #=> String
resp.publish_state #=> String, one of "PUBLISHED", "DRAFT", "PENDING_APPROVAL"
resp.user_count #=> Integer
resp.run_count #=> Integer
resp.created_time #=> Time
resp.last_updated_time #=> Time
resp.request_id #=> String
resp.status #=> Integer

Parameters:

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

Options Hash (params):

:aws_account_id (required, String) —
The ID of the Amazon Web Services account that contains the flow that you are getting metadata for.
:flow_id (required, String) —
The unique identifier of the flow.

Returns:

(Types::GetFlowMetadataOutput) —
Returns a response object which responds to the following methods:
- #arn => String
- #flow_id => String
- #name => String
- #description => String
- #publish_state => String
- #user_count => Integer
- #run_count => Integer
- #created_time => Time
- #last_updated_time => Time
- #request_id => String
- #status => Integer

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 14091

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

#get_flow_permissions(params = {}) ⇒ `Types::GetFlowPermissionsOutput`

Get permissions for a flow.

Examples:

Request syntax with placeholder values


resp = client.get_flow_permissions({
  aws_account_id: "AccountId", # required
  flow_id: "FlowId", # required
})

Response structure


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

Parameters:

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

Options Hash (params):

:aws_account_id (required, String) —
The ID of the Amazon Web Services account that contains the flow that you are getting permissions for.
:flow_id (required, String) —
The unique identifier of the flow to get permissions from.

Returns:

(Types::GetFlowPermissionsOutput) —
Returns a response object which responds to the following methods:
- #arn => String
- #flow_id => String
- #permissions => Array<Types::Permission>
- #request_id => String
- #status => Integer

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 14135

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

#get_identity_context(params = {}) ⇒ `Types::GetIdentityContextResponse`

Retrieves the identity context for a Quick Sight user in a specified namespace, allowing you to obtain identity tokens that can be used with identity-enhanced IAM role sessions to call identity-aware APIs.

Currently, you can call the following APIs with identity-enhanced Credentials

Supported Authentication Methods

This API supports Quick Sight native users, IAM federated users, and Active Directory users. For Quick Sight users authenticated by Amazon Web Services Identity Center, see Identity Center documentation on identity-enhanced IAM role sessions.

Supported Regions

The GetIdentityContext API works only in regions that support at least one of these identity types:

Amazon Quick Sight native identity
IAM federated identity
Active Directory

To use this API successfully, call it in the same region where your user's identity resides. For example, if your user's identity is in us-east-1, make the API call in us-east-1. For more information about managing identities in Amazon Quick Sight, see Identity and access management in Amazon Quick Sight in the Amazon Quick Sight User Guide.

Getting Identity-Enhanced Credentials

To obtain identity-enhanced credentials, follow these steps:

Call the GetIdentityContext API to retrieve an identity token for the specified user.
Use the identity token with the STS AssumeRole API to obtain identity-enhanced IAM role session credentials.

Usage with STS AssumeRole

The identity token returned by this API should be used with the STS AssumeRole API to obtain credentials for an identity-enhanced IAM role session. When calling AssumeRole, include the identity token in the ProvidedContexts parameter with ProviderArn set to arn:aws:iam::aws:contextProvider/QuickSight and ContextAssertion set to the identity token received from this API.

The assumed role must allow the sts:SetContext action in addition to sts:AssumeRole in its trust relationship policy. The trust policy should include both actions for the principal that will be assuming the role.

Examples:

Request syntax with placeholder values


resp = client.get_identity_context({
  aws_account_id: "AwsAccountId", # required
  user_identifier: { # required
    user_name: "SensitiveString",
    email: "SensitiveString",
    user_arn: "Arn",
  },
  namespace: "Namespace",
  session_expires_at: Time.now,
  context_region: "Region",
})

Response structure


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

Parameters:

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

Options Hash (params):

:aws_account_id (required, String) —
The ID for the Amazon Web Services account that the user whose identity context you want to retrieve is in. Currently, you use the ID for the Amazon Web Services account that contains your Quick Sight account.
:user_identifier (required, Types::UserIdentifier) —
The identifier for the user whose identity context you want to retrieve.
:namespace (String) —
The namespace of the user that you want to get identity context for. This parameter is required when the UserIdentifier is specified using Email or UserName.
:session_expires_at (Time, DateTime, Date, Integer, String) —
The timestamp at which the session will expire.
:context_region (String) —
The region in which the context is to be used. Use this parameter to obtain an identity context for cross-region use.

The specified region must meet the following conditions:
- The region must be in the same Amazon Web Services partition as the region you are calling from. Cross-partition requests are not supported. For example, you cannot specify a region in the aws-cn partition when calling from a region in the aws partition.
- It must be a valid Amazon QuickSight supported region.
- The calling customer account must be enabled in the specified context region.
- This parameter is not supported when calling from an opt-in region.

Returns:

(Types::GetIdentityContextResponse) —
Returns a response object which responds to the following methods:
- #status => Integer
- #request_id => String
- #context => String

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 14277

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

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

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

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

Options Hash (params):

:aws_account_id (required, String) —
The ID for the Amazon Web Services account associated with your Amazon Quick Sight subscription.
:entry_point (String) —
The URL you use to access the embedded session. The entry point URL is constrained to the following paths:
- /start
- /start/analyses
- /start/dashboards
- /start/favorites
- /dashboards/DashboardId - where DashboardId is the actual ID key from the Amazon Quick Sight console URL of the dashboard
- /analyses/AnalysisId - where AnalysisId is the actual ID key from the Amazon Quick Sight console URL of the analysis
:session_lifetime_in_minutes (Integer) —
How many minutes the session is valid. The session lifetime must be 15-600 minutes.
:user_arn (String) —
The Amazon Quick user's Amazon Resource Name (ARN), for use with QUICKSIGHT identity type. You can use this for any type of Amazon Quick users in your account (readers, authors, or admins). They need to be authenticated as one of the following:
1. Active Directory (AD) users or group members
2. Invited nonfederated users
3. IAM users and IAM role-based sessions authenticated through Federated Single Sign-On using SAML, OpenID Connect, or IAM federation
Omit this parameter for users in the third group, IAM users and IAM role-based sessions.

Returns:

(Types::GetSessionEmbedUrlResponse) —
Returns a response object which responds to the following methods:
- #embed_url => String
- #status => Integer
- #request_id => String

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 14371

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

#list_action_connectors(params = {}) ⇒ `Types::ListActionConnectorsResponse`

Lists all action connectors in the specified Amazon Web Services account. Returns summary information for each connector including its name, type, creation time, and status.

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

Examples:

Request syntax with placeholder values


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

Response structure


resp.action_connector_summaries #=> Array
resp.action_connector_summaries[0].arn #=> String
resp.action_connector_summaries[0].action_connector_id #=> String
resp.action_connector_summaries[0].type #=> String, one of "GENERIC_HTTP", "SERVICENOW_NOW_PLATFORM", "SALESFORCE_CRM", "MICROSOFT_OUTLOOK", "PAGERDUTY_ADVANCE", "JIRA_CLOUD", "ATLASSIAN_CONFLUENCE", "AMAZON_S3", "AMAZON_BEDROCK_AGENT_RUNTIME", "AMAZON_BEDROCK_RUNTIME", "AMAZON_BEDROCK_DATA_AUTOMATION_RUNTIME", "AMAZON_TEXTRACT", "AMAZON_COMPREHEND", "AMAZON_COMPREHEND_MEDICAL", "MICROSOFT_ONEDRIVE", "MICROSOFT_SHAREPOINT", "MICROSOFT_TEAMS", "SAP_BUSINESSPARTNER", "SAP_PRODUCTMASTERDATA", "SAP_PHYSICALINVENTORY", "SAP_BILLOFMATERIALS", "SAP_MATERIALSTOCK", "ZENDESK_SUITE", "SMARTSHEET", "SLACK", "ASANA", "BAMBOO_HR"
resp.action_connector_summaries[0].name #=> String
resp.action_connector_summaries[0].created_time #=> Time
resp.action_connector_summaries[0].last_updated_time #=> Time
resp.action_connector_summaries[0].status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED", "DELETED"
resp.action_connector_summaries[0].error.message #=> String
resp.action_connector_summaries[0].error.type #=> String, one of "INTERNAL_FAILURE"
resp.next_token #=> String
resp.request_id #=> String
resp.status #=> Integer

Parameters:

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

Options Hash (params):

:aws_account_id (required, String) —
The Amazon Web Services account ID for which to list action connectors.
:max_results (Integer) —
The maximum number of action connectors to return in a single response. Valid range is 1 to 100.
:next_token (String) —
A pagination token to retrieve the next set of results. Use the token returned from a previous call to continue listing action connectors.

Returns:

(Types::ListActionConnectorsResponse) —
Returns a response object which responds to the following methods:
- #action_connector_summaries => Array<Types::ActionConnectorSummary>
- #next_token => String
- #request_id => String
- #status => Integer

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 14429

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

#list_agents(params = {}) ⇒ `Types::ListAgentsResponse`

Lists all agents in an Amazon QuickSight account.

Examples:

Request syntax with placeholder values


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

Response structure


resp.request_id #=> String
resp.agent_summaries #=> Array
resp.agent_summaries[0].arn #=> String
resp.agent_summaries[0].agent_id #=> String
resp.agent_summaries[0].name #=> String
resp.agent_summaries[0].description #=> String
resp.agent_summaries[0].created_at #=> Time
resp.agent_summaries[0].updated_at #=> Time
resp.agent_summaries[0].icon_id #=> String
resp.next_token #=> String

Parameters:

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

Options Hash (params):

:aws_account_id (required, String) —
The ID of the Amazon Web Services account that contains the agents.
:max_results (Integer) —
The maximum number of results to return.
:next_token (String) —
The token for the next set of results, or null if there are no more results.

Returns:

(Types::ListAgentsResponse) —
Returns a response object which responds to the following methods:
- #request_id => String
- #agent_summaries => Array<Types::AgentSummary>
- #next_token => String

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 14477

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

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

Lists Amazon Quick Sight analyses that exist in the specified Amazon Web Services account.

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

Examples:

Request syntax with placeholder values


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

Response structure


resp.analysis_summary_list #=> Array
resp.analysis_summary_list[0].arn #=> String
resp.analysis_summary_list[0].analysis_id #=> String
resp.analysis_summary_list[0].name #=> String
resp.analysis_summary_list[0].status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED", "DELETED"
resp.analysis_summary_list[0].created_time #=> Time
resp.analysis_summary_list[0].last_updated_time #=> Time
resp.next_token #=> String
resp.status #=> Integer
resp.request_id #=> String

Parameters:

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

Options Hash (params):

:aws_account_id (required, String) —
The ID of the Amazon Web Services account that contains the analyses.
:next_token (String) —
A pagination token that can be used in a subsequent request.
:max_results (Integer) —
The maximum number of results to return.

Returns:

(Types::ListAnalysesResponse) —
Returns a response object which responds to the following methods:
- #analysis_summary_list => Array<Types::AnalysisSummary>
- #next_token => String
- #status => Integer
- #request_id => String

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 14528

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

#list_approval_policies(params = {}) ⇒ `Types::ListApprovalPoliciesResponse`

Lists all approval policies in the specified Quick Sight account. The results are paginated. If the response includes a NextToken value, pass it in a subsequent call to retrieve the next set of results.

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

Examples:

Request syntax with placeholder values


resp = client.list_approval_policies({
  next_token: "PaginationToken",
  max_results: 1,
})

Response structure


resp.policies #=> Array
resp.policies[0].policy_id #=> String
resp.policies[0].policy_arn #=> String
resp.policies[0].name #=> String
resp.policies[0].description #=> String
resp.policies[0].actions #=> Array
resp.policies[0].actions[0] #=> String, one of "SHARE"
resp.policies[0].asset_types #=> Array
resp.policies[0].asset_types[0] #=> String, one of "AGENT", "SPACE", "KNOWLEDGE_BASE"
resp.policies[0].applicable_to.type #=> String, one of "GROUP"
resp.policies[0].applicable_to.group_arns #=> Array
resp.policies[0].applicable_to.group_arns[0] #=> String
resp.policies[0].approval_groups #=> Array
resp.policies[0].approval_groups[0] #=> String
resp.policies[0].created_at #=> Time
resp.policies[0].updated_at #=> Time
resp.next_token #=> String

Parameters:

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

Options Hash (params):

:next_token (String) —
The token for the next set of results, or null if there are no more results.
:max_results (Integer) —
The maximum number of results to return in a single call. If you don't specify a value, the service returns a default number of results. Use the NextToken value in the response to retrieve additional results.

Returns:

(Types::ListApprovalPoliciesResponse) —
Returns a response object which responds to the following methods:
- #policies => Array<Types::ApprovalPolicy>
- #next_token => String

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 14585

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

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

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

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

Examples:

Request syntax with placeholder values


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

Response structure


resp.asset_bundle_export_job_summary_list #=> Array
resp.asset_bundle_export_job_summary_list[0].job_status #=> String, one of "QUEUED_FOR_IMMEDIATE_EXECUTION", "IN_PROGRESS", "SUCCESSFUL", "FAILED"
resp.asset_bundle_export_job_summary_list[0].arn #=> String
resp.asset_bundle_export_job_summary_list[0].created_time #=> Time
resp.asset_bundle_export_job_summary_list[0].asset_bundle_export_job_id #=> String
resp.asset_bundle_export_job_summary_list[0].include_all_dependencies #=> Boolean
resp.asset_bundle_export_job_summary_list[0].export_format #=> String, one of "CLOUDFORMATION_JSON", "QUICKSIGHT_JSON"
resp.asset_bundle_export_job_summary_list[0].include_permissions #=> Boolean
resp.asset_bundle_export_job_summary_list[0].include_tags #=> Boolean
resp.next_token #=> String
resp.request_id #=> String
resp.status #=> Integer

Parameters:

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

Options Hash (params):

:aws_account_id (required, String) —
The ID of the Amazon Web Services account that the export jobs were executed in.
:next_token (String) —
The token for the next set of results, or null if there are no more results.
:max_results (Integer) —
The maximum number of results to be returned per request.

Returns:

(Types::ListAssetBundleExportJobsResponse) —
Returns a response object which responds to the following methods:
- #asset_bundle_export_job_summary_list => Array<Types::AssetBundleExportJobSummary>
- #next_token => String
- #request_id => String
- #status => Integer

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 14643

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

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

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

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

Examples:

Request syntax with placeholder values


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

Response structure


resp.asset_bundle_import_job_summary_list #=> Array
resp.asset_bundle_import_job_summary_list[0].job_status #=> String, one of "QUEUED_FOR_IMMEDIATE_EXECUTION", "IN_PROGRESS", "SUCCESSFUL", "FAILED", "FAILED_ROLLBACK_IN_PROGRESS", "FAILED_ROLLBACK_COMPLETED", "FAILED_ROLLBACK_ERROR"
resp.asset_bundle_import_job_summary_list[0].arn #=> String
resp.asset_bundle_import_job_summary_list[0].created_time #=> Time
resp.asset_bundle_import_job_summary_list[0].asset_bundle_import_job_id #=> String
resp.asset_bundle_import_job_summary_list[0].failure_action #=> String, one of "DO_NOTHING", "ROLLBACK"
resp.next_token #=> String
resp.request_id #=> String
resp.status #=> Integer

Parameters:

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

Options Hash (params):

:aws_account_id (required, String) —
The ID of the Amazon Web Services account that the import jobs were executed in.
:next_token (String) —
The token for the next set of results, or null if there are no more results.
:max_results (Integer) —
The maximum number of results to be returned per request.

Returns:

(Types::ListAssetBundleImportJobsResponse) —
Returns a response object which responds to the following methods:
- #asset_bundle_import_job_summary_list => Array<Types::AssetBundleImportJobSummary>
- #next_token => String
- #request_id => String
- #status => Integer

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 14698

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

#list_brands(params = {}) ⇒ `Types::ListBrandsResponse`

Lists all brands in an Quick Sight account.

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

Examples:

Request syntax with placeholder values


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

Response structure


resp.next_token #=> String
resp.brands #=> Array
resp.brands[0].arn #=> String
resp.brands[0].brand_id #=> String
resp.brands[0].brand_name #=> String
resp.brands[0].description #=> String
resp.brands[0].brand_status #=> String, one of "CREATE_IN_PROGRESS", "CREATE_SUCCEEDED", "CREATE_FAILED", "DELETE_IN_PROGRESS", "DELETE_FAILED"
resp.brands[0].created_time #=> Time
resp.brands[0].last_updated_time #=> Time

Parameters:

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

Options Hash (params):

:aws_account_id (required, String) —
The ID of the Amazon Web Services account that owns the brands that you want to list.
:max_results (Integer) —
The maximum number of results to be returned in a single request.
:next_token (String) —
The token for the next set of results, or null if there are no more results.

Returns:

(Types::ListBrandsResponse) —
Returns a response object which responds to the following methods:
- #next_token => String
- #brands => Array<Types::BrandSummary>

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 14747

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

#list_custom_permissions(params = {}) ⇒ `Types::ListCustomPermissionsResponse`

Returns a list of all the custom permissions profiles.

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

Examples:

Request syntax with placeholder values


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

Response structure


resp.status #=> Integer
resp.custom_permissions_list #=> Array
resp.custom_permissions_list[0].arn #=> String
resp.custom_permissions_list[0].custom_permissions_name #=> String
resp.custom_permissions_list[0].capabilities.export_to_csv #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.export_to_excel #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.export_to_pdf #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.print_reports #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.create_and_update_themes #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.add_or_run_anomaly_detection_for_analyses #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.share_analyses #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.create_and_update_datasets #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.share_datasets #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.subscribe_dashboard_email_reports #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.create_and_update_dashboard_email_reports #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.share_dashboards #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.create_and_update_threshold_alerts #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.rename_shared_folders #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.create_shared_folders #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.create_and_update_data_sources #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.share_data_sources #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.view_account_spice_capacity #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.create_spice_dataset #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.export_to_pdf_in_scheduled_reports #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.export_to_csv_in_scheduled_reports #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.export_to_excel_in_scheduled_reports #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.include_content_in_scheduled_reports_email #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.dashboard #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.analysis #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.automate #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.flow #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.apps #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.create_and_update_apps #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.share_apps #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.invoke_apps_ai_inference #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.access_apps_native_data_store #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.publish_without_approval #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.use_bedrock_models #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.perform_flow_ui_task #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.approve_flow_share_requests #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.use_agent_web_search #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.knowledge_base #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.create_and_update_knowledge_bases #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.share_knowledge_bases #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.share_point_knowledge_base #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.create_and_update_share_point_knowledge_base #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.share_share_point_knowledge_base #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.use_share_point_knowledge_base #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.google_drive_knowledge_base #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.create_and_update_google_drive_knowledge_base #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.share_google_drive_knowledge_base #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.use_google_drive_knowledge_base #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.web_crawler_knowledge_base #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.create_and_update_web_crawler_knowledge_base #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.share_web_crawler_knowledge_base #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.use_web_crawler_knowledge_base #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.s3_knowledge_base #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.create_and_update_s3_knowledge_base #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.share_s3_knowledge_base #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.use_s3_knowledge_base #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.confluence_knowledge_base #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.create_and_update_confluence_knowledge_base #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.share_confluence_knowledge_base #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.use_confluence_knowledge_base #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.one_drive_knowledge_base #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.create_and_update_one_drive_knowledge_base #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.share_one_drive_knowledge_base #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.use_one_drive_knowledge_base #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.q_business_knowledge_base #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.create_and_update_q_business_knowledge_base #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.share_q_business_knowledge_base #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.use_q_business_knowledge_base #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.bedrock_managed_knowledge_base #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.create_and_update_bedrock_managed_knowledge_base #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.share_bedrock_managed_knowledge_base #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.use_bedrock_managed_knowledge_base #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.box_knowledge_base #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.create_and_update_box_knowledge_base #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.share_box_knowledge_base #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.use_box_knowledge_base #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.idc_knowledge_base #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.create_and_update_idc_knowledge_base #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.share_idc_knowledge_base #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.use_idc_knowledge_base #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.generic_http_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.create_and_update_generic_http_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.share_generic_http_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.use_generic_http_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.asana_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.create_and_update_asana_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.share_asana_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.use_asana_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.slack_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.create_and_update_slack_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.share_slack_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.use_slack_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.service_now_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.create_and_update_service_now_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.share_service_now_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.use_service_now_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.salesforce_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.create_and_update_salesforce_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.share_salesforce_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.use_salesforce_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.ms_exchange_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.create_and_update_ms_exchange_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.share_ms_exchange_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.use_ms_exchange_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.pager_duty_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.create_and_update_pager_duty_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.share_pager_duty_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.use_pager_duty_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.jira_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.create_and_update_jira_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.share_jira_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.use_jira_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.confluence_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.create_and_update_confluence_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.share_confluence_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.use_confluence_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.one_drive_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.create_and_update_one_drive_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.share_one_drive_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.use_one_drive_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.share_point_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.create_and_update_share_point_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.share_share_point_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.use_share_point_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.ms_teams_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.create_and_update_ms_teams_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.share_ms_teams_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.use_ms_teams_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.google_calendar_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.create_and_update_google_calendar_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.share_google_calendar_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.use_google_calendar_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.zendesk_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.create_and_update_zendesk_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.share_zendesk_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.use_zendesk_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.smartsheet_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.create_and_update_smartsheet_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.share_smartsheet_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.use_smartsheet_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.sap_business_partner_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.create_and_update_sap_business_partner_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.share_sap_business_partner_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.use_sap_business_partner_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.sap_product_master_data_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.create_and_update_sap_product_master_data_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.share_sap_product_master_data_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.use_sap_product_master_data_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.sap_physical_inventory_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.create_and_update_sap_physical_inventory_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.share_sap_physical_inventory_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.use_sap_physical_inventory_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.sap_bill_of_material_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.create_and_update_sap_bill_of_material_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.share_sap_bill_of_material_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.use_sap_bill_of_material_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.sap_material_stock_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.create_and_update_sap_material_stock_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.share_sap_material_stock_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.use_sap_material_stock_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.fact_set_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.create_and_update_fact_set_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.share_fact_set_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.use_fact_set_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.amazon_s_three_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.create_and_update_amazon_s_three_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.share_amazon_s_three_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.use_amazon_s_three_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.textract_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.create_and_update_textract_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.share_textract_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.use_textract_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.comprehend_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.create_and_update_comprehend_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.share_comprehend_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.use_comprehend_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.comprehend_medical_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.create_and_update_comprehend_medical_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.share_comprehend_medical_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.use_comprehend_medical_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.amazon_bedrock_ars_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.create_and_update_amazon_bedrock_ars_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.share_amazon_bedrock_ars_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.use_amazon_bedrock_ars_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.amazon_bedrock_fs_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.create_and_update_amazon_bedrock_fs_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.share_amazon_bedrock_fs_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.use_amazon_bedrock_fs_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.amazon_bedrock_krs_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.create_and_update_amazon_bedrock_krs_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.share_amazon_bedrock_krs_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.use_amazon_bedrock_krs_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.mcp_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.create_and_update_mcp_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.share_mcp_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.use_mcp_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.open_api_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.create_and_update_open_api_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.share_open_api_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.use_open_api_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.sand_pgmi_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.create_and_update_sand_pgmi_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.share_sand_pgmi_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.use_sand_pgmi_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.sand_p_global_energy_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.create_and_update_sand_p_global_energy_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.share_sand_p_global_energy_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.use_sand_p_global_energy_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.bamboo_hr_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.create_and_update_bamboo_hr_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.share_bamboo_hr_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.use_bamboo_hr_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.box_agent_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.create_and_update_box_agent_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.share_box_agent_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.use_box_agent_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.canva_agent_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.create_and_update_canva_agent_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.share_canva_agent_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.use_canva_agent_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.github_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.create_and_update_github_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.share_github_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.use_github_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.notion_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.create_and_update_notion_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.share_notion_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.use_notion_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.linear_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.create_and_update_linear_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.share_linear_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.use_linear_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.hugging_face_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.create_and_update_hugging_face_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.share_hugging_face_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.use_hugging_face_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.monday_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.create_and_update_monday_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.share_monday_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.use_monday_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.hubspot_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.create_and_update_hubspot_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.share_hubspot_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.use_hubspot_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.intercom_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.create_and_update_intercom_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.share_intercom_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.use_intercom_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.new_relic_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.create_and_update_new_relic_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.share_new_relic_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.use_new_relic_action #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.topic #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.edit_visual_with_q #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.build_calculated_field_with_q #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.create_dashboard_executive_summary_with_q #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.space #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.create_spaces #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.share_spaces #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.chat_agent #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.create_chat_agents #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.share_chat_agents #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.research #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.self_upgrade_user_role #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.extension #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.use_browser_extension #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.use_word_add_in_extension #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.use_outlook_add_in_extension #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.use_excel_add_in_extension #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.use_powerpoint_add_in_extension #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.manage_shared_folders #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.generate_analyses #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.story #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.scenario #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.trigger #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.schedule_trigger #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.inbound_email_trigger #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].capabilities.quick_event_trigger #=> String, one of "DENY", "ALLOW"
resp.custom_permissions_list[0].governance.default_category_effects #=> Hash
resp.custom_permissions_list[0].governance.default_category_effects["GovernanceCategoryName"] #=> String, one of "DENY_BY_DEFAULT"
resp.next_token #=> String
resp.request_id #=> String

Parameters:

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

Options Hash (params):

:aws_account_id (required, String) —
The ID of the Amazon Web Services account that contains the custom permissions profiles that you want to list.
:max_results (Integer) —
The maximum number of results to return.
:next_token (String) —
The token for the next set of results, or null if there are no more results.

Returns:

(Types::ListCustomPermissionsResponse) —
Returns a response object which responds to the following methods:
- #status => Integer
- #custom_permissions_list => Array<Types::CustomPermissions>
- #next_token => String
- #request_id => String

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 15076

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

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

Lists all the versions of the dashboards in the Amazon Quick Sight subscription.

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

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

Options Hash (params):

:aws_account_id (required, String) —
The ID of the Amazon Web Services account that contains the dashboard that you're listing versions for.
:dashboard_id (required, String) —
The ID for the dashboard.
:next_token (String) —
The token for the next set of results, or null if there are no more results.
:max_results (Integer) —
The maximum number of results to be returned per request.

Returns:

(Types::ListDashboardVersionsResponse) —
Returns a response object which responds to the following methods:
- #dashboard_version_summary_list => Array<Types::DashboardVersionSummary>
- #next_token => String
- #status => Integer
- #request_id => String

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 15133

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

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

Lists dashboards in an Amazon Web Services account.

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

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

Options Hash (params):

:aws_account_id (required, String) —
The ID of the Amazon Web Services account that contains the dashboards that you're listing.
:next_token (String) —
The token for the next set of results, or null if there are no more results.
:max_results (Integer) —
The maximum number of results to be returned per request.

Returns:

(Types::ListDashboardsResponse) —
Returns a response object which responds to the following methods:
- #dashboard_summary_list => Array<Types::DashboardSummary>
- #next_token => String
- #status => Integer
- #request_id => String

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 15186

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

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

Lists all of the datasets belonging to the current Amazon Web Services account in an Amazon Web Services Region.

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

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

Examples:

Request syntax with placeholder values


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

Response structure


resp.data_set_summaries #=> Array
resp.data_set_summaries[0].arn #=> String
resp.data_set_summaries[0].data_set_id #=> String
resp.data_set_summaries[0].name #=> String
resp.data_set_summaries[0].created_time #=> Time
resp.data_set_summaries[0].last_updated_time #=> Time
resp.data_set_summaries[0].import_mode #=> String, one of "SPICE", "DIRECT_QUERY"
resp.data_set_summaries[0].row_level_permission_data_set.namespace #=> String
resp.data_set_summaries[0].row_level_permission_data_set.arn #=> String
resp.data_set_summaries[0].row_level_permission_data_set.permission_policy #=> String, one of "GRANT_ACCESS", "DENY_ACCESS"
resp.data_set_summaries[0].row_level_permission_data_set.format_version #=> String, one of "VERSION_1", "VERSION_2"
resp.data_set_summaries[0].row_level_permission_data_set.status #=> String, one of "ENABLED", "DISABLED"
resp.data_set_summaries[0].row_level_permission_data_set_map #=> Hash
resp.data_set_summaries[0].row_level_permission_data_set_map["DataSetEntityResourceId"].namespace #=> String
resp.data_set_summaries[0].row_level_permission_data_set_map["DataSetEntityResourceId"].arn #=> String
resp.data_set_summaries[0].row_level_permission_data_set_map["DataSetEntityResourceId"].permission_policy #=> String, one of "GRANT_ACCESS", "DENY_ACCESS"
resp.data_set_summaries[0].row_level_permission_data_set_map["DataSetEntityResourceId"].format_version #=> String, one of "VERSION_1", "VERSION_2"
resp.data_set_summaries[0].row_level_permission_data_set_map["DataSetEntityResourceId"].status #=> String, one of "ENABLED", "DISABLED"
resp.data_set_summaries[0].row_level_permission_tag_configuration_applied #=> Boolean
resp.data_set_summaries[0].column_level_permission_rules_applied #=> Boolean
resp.data_set_summaries[0].use_as #=> String, one of "RLS_RULES"
resp.next_token #=> String
resp.request_id #=> String
resp.status #=> Integer

Parameters:

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

Options Hash (params):

:aws_account_id (required, String) —
The Amazon Web Services account ID.
:next_token (String) —
The token for the next set of results, or null if there are no more results.
:max_results (Integer) —
The maximum number of results to be returned per request.

Returns:

(Types::ListDataSetsResponse) —
Returns a response object which responds to the following methods:
- #data_set_summaries => Array<Types::DataSetSummary>
- #next_token => String
- #request_id => String
- #status => Integer

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 15255

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

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

Lists data sources in current Amazon Web Services Region that belong to this Amazon Web Services account.

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

Examples:

Request syntax with placeholder values


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

Response structure


resp.data_sources #=> Array
resp.data_sources[0].arn #=> String
resp.data_sources[0].data_source_id #=> String
resp.data_sources[0].name #=> String
resp.data_sources[0].type #=> String, one of "ADOBE_ANALYTICS", "AMAZON_ELASTICSEARCH", "ATHENA", "AURORA", "AURORA_POSTGRESQL", "AWS_IOT_ANALYTICS", "GITHUB", "JIRA", "MARIADB", "MYSQL", "ORACLE", "POSTGRESQL", "PRESTO", "REDSHIFT", "S3", "S3_TABLES", "SALESFORCE", "SERVICENOW", "SNOWFLAKE", "SPARK", "SQLSERVER", "TERADATA", "TWITTER", "TIMESTREAM", "AMAZON_OPENSEARCH", "EXASOL", "DATABRICKS", "STARBURST", "TRINO", "BIGQUERY", "GOOGLESHEETS", "GOOGLE_DRIVE", "CONFLUENCE", "SHAREPOINT", "ONE_DRIVE", "WEB_CRAWLER", "S3_KNOWLEDGE_BASE", "QBUSINESS"
resp.data_sources[0].status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED", "DELETED"
resp.data_sources[0].created_time #=> Time
resp.data_sources[0].last_updated_time #=> Time
resp.data_sources[0].data_source_parameters.amazon_elasticsearch_parameters.domain #=> String
resp.data_sources[0].data_source_parameters.athena_parameters.work_group #=> String
resp.data_sources[0].data_source_parameters.athena_parameters.role_arn #=> String
resp.data_sources[0].data_source_parameters.athena_parameters.consumer_account_role_arn #=> String
resp.data_sources[0].data_source_parameters.athena_parameters.identity_center_configuration.enable_identity_propagation #=> Boolean
resp.data_sources[0].data_source_parameters.aurora_parameters.host #=> String
resp.data_sources[0].data_source_parameters.aurora_parameters.port #=> Integer
resp.data_sources[0].data_source_parameters.aurora_parameters.database #=> String
resp.data_sources[0].data_source_parameters.aurora_postgre_sql_parameters.host #=> String
resp.data_sources[0].data_source_parameters.aurora_postgre_sql_parameters.port #=> Integer
resp.data_sources[0].data_source_parameters.aurora_postgre_sql_parameters.database #=> String
resp.data_sources[0].data_source_parameters.aws_iot_analytics_parameters.data_set_name #=> String
resp.data_sources[0].data_source_parameters.jira_parameters.site_base_url #=> String
resp.data_sources[0].data_source_parameters.maria_db_parameters.host #=> String
resp.data_sources[0].data_source_parameters.maria_db_parameters.port #=> Integer
resp.data_sources[0].data_source_parameters.maria_db_parameters.database #=> String
resp.data_sources[0].data_source_parameters.my_sql_parameters.host #=> String
resp.data_sources[0].data_source_parameters.my_sql_parameters.port #=> Integer
resp.data_sources[0].data_source_parameters.my_sql_parameters.database #=> String
resp.data_sources[0].data_source_parameters.oracle_parameters.host #=> String
resp.data_sources[0].data_source_parameters.oracle_parameters.port #=> Integer
resp.data_sources[0].data_source_parameters.oracle_parameters.database #=> String
resp.data_sources[0].data_source_parameters.oracle_parameters.use_service_name #=> Boolean
resp.data_sources[0].data_source_parameters.postgre_sql_parameters.host #=> String
resp.data_sources[0].data_source_parameters.postgre_sql_parameters.port #=> Integer
resp.data_sources[0].data_source_parameters.postgre_sql_parameters.database #=> String
resp.data_sources[0].data_source_parameters.presto_parameters.host #=> String
resp.data_sources[0].data_source_parameters.presto_parameters.port #=> Integer
resp.data_sources[0].data_source_parameters.presto_parameters.catalog #=> String
resp.data_sources[0].data_source_parameters.rds_parameters.instance_id #=> String
resp.data_sources[0].data_source_parameters.rds_parameters.database #=> String
resp.data_sources[0].data_source_parameters.redshift_parameters.host #=> String
resp.data_sources[0].data_source_parameters.redshift_parameters.port #=> Integer
resp.data_sources[0].data_source_parameters.redshift_parameters.database #=> String
resp.data_sources[0].data_source_parameters.redshift_parameters.cluster_id #=> String
resp.data_sources[0].data_source_parameters.redshift_parameters.iam_parameters.role_arn #=> String
resp.data_sources[0].data_source_parameters.redshift_parameters.iam_parameters.database_user #=> String
resp.data_sources[0].data_source_parameters.redshift_parameters.iam_parameters.database_groups #=> Array
resp.data_sources[0].data_source_parameters.redshift_parameters.iam_parameters.database_groups[0] #=> String
resp.data_sources[0].data_source_parameters.redshift_parameters.iam_parameters.auto_create_database_user #=> Boolean
resp.data_sources[0].data_source_parameters.redshift_parameters.identity_center_configuration.enable_identity_propagation #=> Boolean
resp.data_sources[0].data_source_parameters.s3_parameters.manifest_file_location.bucket #=> String
resp.data_sources[0].data_source_parameters.s3_parameters.manifest_file_location.key #=> String
resp.data_sources[0].data_source_parameters.s3_parameters.role_arn #=> String
resp.data_sources[0].data_source_parameters.s3_tables_parameters.table_bucket_arn #=> String
resp.data_sources[0].data_source_parameters.s3_knowledge_base_parameters.role_arn #=> String
resp.data_sources[0].data_source_parameters.s3_knowledge_base_parameters.bucket_url #=> String
resp.data_sources[0].data_source_parameters.s3_knowledge_base_parameters.metadata_files_location #=> 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.snowflake_parameters.authentication_type #=> String, one of "PASSWORD", "KEYPAIR", "TOKEN", "X509"
resp.data_sources[0].data_source_parameters.snowflake_parameters.database_access_control_role #=> String
resp.data_sources[0].data_source_parameters.snowflake_parameters.o_auth_parameters.token_provider_url #=> String
resp.data_sources[0].data_source_parameters.snowflake_parameters.o_auth_parameters.o_auth_scope #=> String
resp.data_sources[0].data_source_parameters.snowflake_parameters.o_auth_parameters.identity_provider_vpc_connection_properties.vpc_connection_arn #=> String
resp.data_sources[0].data_source_parameters.snowflake_parameters.o_auth_parameters.identity_provider_resource_uri #=> String
resp.data_sources[0].data_source_parameters.snowflake_parameters.o_auth_parameters.identity_provider_ca_certificates_bundle_s3_uri #=> String
resp.data_sources[0].data_source_parameters.spark_parameters.host #=> String
resp.data_sources[0].data_source_parameters.spark_parameters.port #=> Integer
resp.data_sources[0].data_source_parameters.sql_server_parameters.host #=> String
resp.data_sources[0].data_source_parameters.sql_server_parameters.port #=> Integer
resp.data_sources[0].data_source_parameters.sql_server_parameters.database #=> String
resp.data_sources[0].data_source_parameters.teradata_parameters.host #=> String
resp.data_sources[0].data_source_parameters.teradata_parameters.port #=> Integer
resp.data_sources[0].data_source_parameters.teradata_parameters.database #=> String
resp.data_sources[0].data_source_parameters.twitter_parameters.query #=> String
resp.data_sources[0].data_source_parameters.twitter_parameters.max_rows #=> Integer
resp.data_sources[0].data_source_parameters.amazon_open_search_parameters.domain #=> String
resp.data_sources[0].data_source_parameters.exasol_parameters.host #=> String
resp.data_sources[0].data_source_parameters.exasol_parameters.port #=> Integer
resp.data_sources[0].data_source_parameters.databricks_parameters.host #=> String
resp.data_sources[0].data_source_parameters.databricks_parameters.port #=> Integer
resp.data_sources[0].data_source_parameters.databricks_parameters.sql_endpoint_path #=> String
resp.data_sources[0].data_source_parameters.starburst_parameters.host #=> String
resp.data_sources[0].data_source_parameters.starburst_parameters.port #=> Integer
resp.data_sources[0].data_source_parameters.starburst_parameters.catalog #=> String
resp.data_sources[0].data_source_parameters.starburst_parameters.product_type #=> String, one of "GALAXY", "ENTERPRISE"
resp.data_sources[0].data_source_parameters.starburst_parameters.database_access_control_role #=> String
resp.data_sources[0].data_source_parameters.starburst_parameters.authentication_type #=> String, one of "PASSWORD", "KEYPAIR", "TOKEN", "X509"
resp.data_sources[0].data_source_parameters.starburst_parameters.o_auth_parameters.token_provider_url #=> String
resp.data_sources[0].data_source_parameters.starburst_parameters.o_auth_parameters.o_auth_scope #=> String
resp.data_sources[0].data_source_parameters.starburst_parameters.o_auth_parameters.identity_provider_vpc_connection_properties.vpc_connection_arn #=> String
resp.data_sources[0].data_source_parameters.starburst_parameters.o_auth_parameters.identity_provider_resource_uri #=> String
resp.data_sources[0].data_source_parameters.starburst_parameters.o_auth_parameters.identity_provider_ca_certificates_bundle_s3_uri #=> String
resp.data_sources[0].data_source_parameters.trino_parameters.host #=> String
resp.data_sources[0].data_source_parameters.trino_parameters.port #=> Integer
resp.data_sources[0].data_source_parameters.trino_parameters.catalog #=> String
resp.data_sources[0].data_source_parameters.big_query_parameters.project_id #=> String
resp.data_sources[0].data_source_parameters.big_query_parameters.data_set_region #=> String
resp.data_sources[0].data_source_parameters.impala_parameters.host #=> String
resp.data_sources[0].data_source_parameters.impala_parameters.port #=> Integer
resp.data_sources[0].data_source_parameters.impala_parameters.database #=> String
resp.data_sources[0].data_source_parameters.impala_parameters.sql_endpoint_path #=> String
resp.data_sources[0].data_source_parameters.custom_connection_parameters.connection_type #=> String
resp.data_sources[0].data_source_parameters.web_crawler_parameters.web_crawler_auth_type #=> String, one of "NO_AUTH", "BASIC_AUTH", "FORM", "SAML"
resp.data_sources[0].data_source_parameters.web_crawler_parameters.username_field_xpath #=> String
resp.data_sources[0].data_source_parameters.web_crawler_parameters.password_field_xpath #=> String
resp.data_sources[0].data_source_parameters.web_crawler_parameters.username_button_xpath #=> String
resp.data_sources[0].data_source_parameters.web_crawler_parameters.password_button_xpath #=> String
resp.data_sources[0].data_source_parameters.web_crawler_parameters.login_page_url #=> String
resp.data_sources[0].data_source_parameters.web_crawler_parameters.web_proxy_host_name #=> String
resp.data_sources[0].data_source_parameters.web_crawler_parameters.web_proxy_port_number #=> Integer
resp.data_sources[0].data_source_parameters.confluence_parameters.confluence_url #=> String
resp.data_sources[0].data_source_parameters.q_business_parameters.application_arn #=> String
resp.data_sources[0].data_source_parameters.share_point_parameters.share_point_domain #=> String
resp.data_sources[0].data_source_parameters.share_point_parameters.tenant_id #=> String
resp.data_sources[0].data_source_parameters.share_point_parameters.client_id #=> String
resp.data_sources[0].data_source_parameters.share_point_parameters.auth_type #=> String, one of "THREE_LEGGED_OAUTH", "TWO_LEGGED_OAUTH", "SERVICE_ACCOUNT"
resp.data_sources[0].data_source_parameters.google_drive_parameters.auth_type #=> String, one of "THREE_LEGGED_OAUTH", "TWO_LEGGED_OAUTH", "SERVICE_ACCOUNT"
resp.data_sources[0].data_source_parameters.one_drive_parameters.tenant_id #=> String
resp.data_sources[0].data_source_parameters.one_drive_parameters.client_id #=> String
resp.data_sources[0].data_source_parameters.one_drive_parameters.auth_type #=> String, one of "THREE_LEGGED_OAUTH", "TWO_LEGGED_OAUTH", "SERVICE_ACCOUNT"
resp.data_sources[0].data_source_parameters.fmkb_parameters.knowledge_base_arn #=> String
resp.data_sources[0].data_source_parameters.fmkb_parameters.linked_data_source_ids #=> Array
resp.data_sources[0].data_source_parameters.fmkb_parameters.linked_data_source_ids[0] #=> String
resp.data_sources[0].alternate_data_source_parameters #=> Array
resp.data_sources[0].alternate_data_source_parameters[0].amazon_elasticsearch_parameters.domain #=> String
resp.data_sources[0].alternate_data_source_parameters[0].athena_parameters.work_group #=> String
resp.data_sources[0].alternate_data_source_parameters[0].athena_parameters.role_arn #=> String
resp.data_sources[0].alternate_data_source_parameters[0].athena_parameters.consumer_account_role_arn #=> String
resp.data_sources[0].alternate_data_source_parameters[0].athena_parameters.identity_center_configuration.enable_identity_propagation #=> Boolean
resp.data_sources[0].alternate_data_source_parameters[0].aurora_parameters.host #=> String
resp.data_sources[0].alternate_data_source_parameters[0].aurora_parameters.port #=> Integer
resp.data_sources[0].alternate_data_source_parameters[0].aurora_parameters.database #=> String
resp.data_sources[0].alternate_data_source_parameters[0].aurora_postgre_sql_parameters.host #=> String
resp.data_sources[0].alternate_data_source_parameters[0].aurora_postgre_sql_parameters.port #=> Integer
resp.data_sources[0].alternate_data_source_parameters[0].aurora_postgre_sql_parameters.database #=> String
resp.data_sources[0].alternate_data_source_parameters[0].aws_iot_analytics_parameters.data_set_name #=> String
resp.data_sources[0].alternate_data_source_parameters[0].jira_parameters.site_base_url #=> String
resp.data_sources[0].alternate_data_source_parameters[0].maria_db_parameters.host #=> String
resp.data_sources[0].alternate_data_source_parameters[0].maria_db_parameters.port #=> Integer
resp.data_sources[0].alternate_data_source_parameters[0].maria_db_parameters.database #=> String
resp.data_sources[0].alternate_data_source_parameters[0].my_sql_parameters.host #=> String
resp.data_sources[0].alternate_data_source_parameters[0].my_sql_parameters.port #=> Integer
resp.data_sources[0].alternate_data_source_parameters[0].my_sql_parameters.database #=> String
resp.data_sources[0].alternate_data_source_parameters[0].oracle_parameters.host #=> String
resp.data_sources[0].alternate_data_source_parameters[0].oracle_parameters.port #=> Integer
resp.data_sources[0].alternate_data_source_parameters[0].oracle_parameters.database #=> String
resp.data_sources[0].alternate_data_source_parameters[0].oracle_parameters.use_service_name #=> Boolean
resp.data_sources[0].alternate_data_source_parameters[0].postgre_sql_parameters.host #=> String
resp.data_sources[0].alternate_data_source_parameters[0].postgre_sql_parameters.port #=> Integer
resp.data_sources[0].alternate_data_source_parameters[0].postgre_sql_parameters.database #=> String
resp.data_sources[0].alternate_data_source_parameters[0].presto_parameters.host #=> String
resp.data_sources[0].alternate_data_source_parameters[0].presto_parameters.port #=> Integer
resp.data_sources[0].alternate_data_source_parameters[0].presto_parameters.catalog #=> String
resp.data_sources[0].alternate_data_source_parameters[0].rds_parameters.instance_id #=> String
resp.data_sources[0].alternate_data_source_parameters[0].rds_parameters.database #=> String
resp.data_sources[0].alternate_data_source_parameters[0].redshift_parameters.host #=> String
resp.data_sources[0].alternate_data_source_parameters[0].redshift_parameters.port #=> Integer
resp.data_sources[0].alternate_data_source_parameters[0].redshift_parameters.database #=> String
resp.data_sources[0].alternate_data_source_parameters[0].redshift_parameters.cluster_id #=> String
resp.data_sources[0].alternate_data_source_parameters[0].redshift_parameters.iam_parameters.role_arn #=> String
resp.data_sources[0].alternate_data_source_parameters[0].redshift_parameters.iam_parameters.database_user #=> String
resp.data_sources[0].alternate_data_source_parameters[0].redshift_parameters.iam_parameters.database_groups #=> Array
resp.data_sources[0].alternate_data_source_parameters[0].redshift_parameters.iam_parameters.database_groups[0] #=> String
resp.data_sources[0].alternate_data_source_parameters[0].redshift_parameters.iam_parameters.auto_create_database_user #=> Boolean
resp.data_sources[0].alternate_data_source_parameters[0].redshift_parameters.identity_center_configuration.enable_identity_propagation #=> Boolean
resp.data_sources[0].alternate_data_source_parameters[0].s3_parameters.manifest_file_location.bucket #=> String
resp.data_sources[0].alternate_data_source_parameters[0].s3_parameters.manifest_file_location.key #=> String
resp.data_sources[0].alternate_data_source_parameters[0].s3_parameters.role_arn #=> String
resp.data_sources[0].alternate_data_source_parameters[0].s3_tables_parameters.table_bucket_arn #=> String
resp.data_sources[0].alternate_data_source_parameters[0].s3_knowledge_base_parameters.role_arn #=> String
resp.data_sources[0].alternate_data_source_parameters[0].s3_knowledge_base_parameters.bucket_url #=> String
resp.data_sources[0].alternate_data_source_parameters[0].s3_knowledge_base_parameters.metadata_files_location #=> String
resp.data_sources[0].alternate_data_source_parameters[0].service_now_parameters.site_base_url #=> String
resp.data_sources[0].alternate_data_source_parameters[0].snowflake_parameters.host #=> String
resp.data_sources[0].alternate_data_source_parameters[0].snowflake_parameters.database #=> String
resp.data_sources[0].alternate_data_source_parameters[0].snowflake_parameters.warehouse #=> String
resp.data_sources[0].alternate_data_source_parameters[0].snowflake_parameters.authentication_type #=> String, one of "PASSWORD", "KEYPAIR", "TOKEN", "X509"
resp.data_sources[0].alternate_data_source_parameters[0].snowflake_parameters.database_access_control_role #=> String
resp.data_sources[0].alternate_data_source_parameters[0].snowflake_parameters.o_auth_parameters.token_provider_url #=> String
resp.data_sources[0].alternate_data_source_parameters[0].snowflake_parameters.o_auth_parameters.o_auth_scope #=> String
resp.data_sources[0].alternate_data_source_parameters[0].snowflake_parameters.o_auth_parameters.identity_provider_vpc_connection_properties.vpc_connection_arn #=> String
resp.data_sources[0].alternate_data_source_parameters[0].snowflake_parameters.o_auth_parameters.identity_provider_resource_uri #=> String
resp.data_sources[0].alternate_data_source_parameters[0].snowflake_parameters.o_auth_parameters.identity_provider_ca_certificates_bundle_s3_uri #=> String
resp.data_sources[0].alternate_data_source_parameters[0].spark_parameters.host #=> String
resp.data_sources[0].alternate_data_source_parameters[0].spark_parameters.port #=> Integer
resp.data_sources[0].alternate_data_source_parameters[0].sql_server_parameters.host #=> String
resp.data_sources[0].alternate_data_source_parameters[0].sql_server_parameters.port #=> Integer
resp.data_sources[0].alternate_data_source_parameters[0].sql_server_parameters.database #=> String
resp.data_sources[0].alternate_data_source_parameters[0].teradata_parameters.host #=> String
resp.data_sources[0].alternate_data_source_parameters[0].teradata_parameters.port #=> Integer
resp.data_sources[0].alternate_data_source_parameters[0].teradata_parameters.database #=> String
resp.data_sources[0].alternate_data_source_parameters[0].twitter_parameters.query #=> String
resp.data_sources[0].alternate_data_source_parameters[0].twitter_parameters.max_rows #=> Integer
resp.data_sources[0].alternate_data_source_parameters[0].amazon_open_search_parameters.domain #=> String
resp.data_sources[0].alternate_data_source_parameters[0].exasol_parameters.host #=> String
resp.data_sources[0].alternate_data_source_parameters[0].exasol_parameters.port #=> Integer
resp.data_sources[0].alternate_data_source_parameters[0].databricks_parameters.host #=> String
resp.data_sources[0].alternate_data_source_parameters[0].databricks_parameters.port #=> Integer
resp.data_sources[0].alternate_data_source_parameters[0].databricks_parameters.sql_endpoint_path #=> String
resp.data_sources[0].alternate_data_source_parameters[0].starburst_parameters.host #=> String
resp.data_sources[0].alternate_data_source_parameters[0].starburst_parameters.port #=> Integer
resp.data_sources[0].alternate_data_source_parameters[0].starburst_parameters.catalog #=> String
resp.data_sources[0].alternate_data_source_parameters[0].starburst_parameters.product_type #=> String, one of "GALAXY", "ENTERPRISE"
resp.data_sources[0].alternate_data_source_parameters[0].starburst_parameters.database_access_control_role #=> String
resp.data_sources[0].alternate_data_source_parameters[0].starburst_parameters.authentication_type #=> String, one of "PASSWORD", "KEYPAIR", "TOKEN", "X509"
resp.data_sources[0].alternate_data_source_parameters[0].starburst_parameters.o_auth_parameters.token_provider_url #=> String
resp.data_sources[0].alternate_data_source_parameters[0].starburst_parameters.o_auth_parameters.o_auth_scope #=> String
resp.data_sources[0].alternate_data_source_parameters[0].starburst_parameters.o_auth_parameters.identity_provider_vpc_connection_properties.vpc_connection_arn #=> String
resp.data_sources[0].alternate_data_source_parameters[0].starburst_parameters.o_auth_parameters.identity_provider_resource_uri #=> String
resp.data_sources[0].alternate_data_source_parameters[0].starburst_parameters.o_auth_parameters.identity_provider_ca_certificates_bundle_s3_uri #=> String
resp.data_sources[0].alternate_data_source_parameters[0].trino_parameters.host #=> String
resp.data_sources[0].alternate_data_source_parameters[0].trino_parameters.port #=> Integer
resp.data_sources[0].alternate_data_source_parameters[0].trino_parameters.catalog #=> String
resp.data_sources[0].alternate_data_source_parameters[0].big_query_parameters.project_id #=> String
resp.data_sources[0].alternate_data_source_parameters[0].big_query_parameters.data_set_region #=> String
resp.data_sources[0].alternate_data_source_parameters[0].impala_parameters.host #=> String
resp.data_sources[0].alternate_data_source_parameters[0].impala_parameters.port #=> Integer
resp.data_sources[0].alternate_data_source_parameters[0].impala_parameters.database #=> String
resp.data_sources[0].alternate_data_source_parameters[0].impala_parameters.sql_endpoint_path #=> String
resp.data_sources[0].alternate_data_source_parameters[0].custom_connection_parameters.connection_type #=> String
resp.data_sources[0].alternate_data_source_parameters[0].web_crawler_parameters.web_crawler_auth_type #=> String, one of "NO_AUTH", "BASIC_AUTH", "FORM", "SAML"
resp.data_sources[0].alternate_data_source_parameters[0].web_crawler_parameters.username_field_xpath #=> String
resp.data_sources[0].alternate_data_source_parameters[0].web_crawler_parameters.password_field_xpath #=> String
resp.data_sources[0].alternate_data_source_parameters[0].web_crawler_parameters.username_button_xpath #=> String
resp.data_sources[0].alternate_data_source_parameters[0].web_crawler_parameters.password_button_xpath #=> String
resp.data_sources[0].alternate_data_source_parameters[0].web_crawler_parameters.login_page_url #=> String
resp.data_sources[0].alternate_data_source_parameters[0].web_crawler_parameters.web_proxy_host_name #=> String
resp.data_sources[0].alternate_data_source_parameters[0].web_crawler_parameters.web_proxy_port_number #=> Integer
resp.data_sources[0].alternate_data_source_parameters[0].confluence_parameters.confluence_url #=> String
resp.data_sources[0].alternate_data_source_parameters[0].q_business_parameters.application_arn #=> String
resp.data_sources[0].alternate_data_source_parameters[0].share_point_parameters.share_point_domain #=> String
resp.data_sources[0].alternate_data_source_parameters[0].share_point_parameters.tenant_id #=> String
resp.data_sources[0].alternate_data_source_parameters[0].share_point_parameters.client_id #=> String
resp.data_sources[0].alternate_data_source_parameters[0].share_point_parameters.auth_type #=> String, one of "THREE_LEGGED_OAUTH", "TWO_LEGGED_OAUTH", "SERVICE_ACCOUNT"
resp.data_sources[0].alternate_data_source_parameters[0].google_drive_parameters.auth_type #=> String, one of "THREE_LEGGED_OAUTH", "TWO_LEGGED_OAUTH", "SERVICE_ACCOUNT"
resp.data_sources[0].alternate_data_source_parameters[0].one_drive_parameters.tenant_id #=> String
resp.data_sources[0].alternate_data_source_parameters[0].one_drive_parameters.client_id #=> String
resp.data_sources[0].alternate_data_source_parameters[0].one_drive_parameters.auth_type #=> String, one of "THREE_LEGGED_OAUTH", "TWO_LEGGED_OAUTH", "SERVICE_ACCOUNT"
resp.data_sources[0].alternate_data_source_parameters[0].fmkb_parameters.knowledge_base_arn #=> String
resp.data_sources[0].alternate_data_source_parameters[0].fmkb_parameters.linked_data_source_ids #=> Array
resp.data_sources[0].alternate_data_source_parameters[0].fmkb_parameters.linked_data_source_ids[0] #=> String
resp.data_sources[0].vpc_connection_properties.vpc_connection_arn #=> String
resp.data_sources[0].ssl_properties.disable_ssl #=> Boolean
resp.data_sources[0].error_info.type #=> String, one of "ACCESS_DENIED", "COPY_SOURCE_NOT_FOUND", "TIMEOUT", "ENGINE_VERSION_NOT_SUPPORTED", "UNKNOWN_HOST", "GENERIC_SQL_FAILURE", "CONFLICT", "UNKNOWN"
resp.data_sources[0].error_info.message #=> String
resp.data_sources[0].secret_arn #=> String
resp.data_sources[0].credential_status #=> String, one of "CONNECTED", "AUTH_FAILED", "NOT_VERIFIED"
resp.data_sources[0].last_credential_verified_at #=> Time
resp.next_token #=> String
resp.request_id #=> String
resp.status #=> Integer

Parameters:

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

Options Hash (params):

:aws_account_id (required, String) —
The Amazon Web Services account ID.
:next_token (String) —
The token for the next set of results, or null if there are no more results.
:max_results (Integer) —
The maximum number of results to be returned per request.

Returns:

(Types::ListDataSourcesResponse) —
Returns a response object which responds to the following methods:
- #data_sources => Array<Types::DataSource>
- #next_token => String
- #request_id => String
- #status => Integer

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 15550

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

#list_dlp_settings(params = {}) ⇒ `Types::ListDlpSettingsResponse`

Lists all DLP settings in an Amazon Web Services account.

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

Examples:

Request syntax with placeholder values


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

Response structure


resp.dlp_setting_summaries #=> Array
resp.dlp_setting_summaries[0].dlp_setting_id #=> String
resp.dlp_setting_summaries[0].name #=> String
resp.dlp_setting_summaries[0].arn #=> String
resp.dlp_setting_summaries[0].status #=> String, one of "ACTIVE", "INACTIVE"
resp.dlp_setting_summaries[0].provider_type #=> String, one of "MICROSOFT_PURVIEW"
resp.dlp_setting_summaries[0].created_at #=> Time
resp.dlp_setting_summaries[0].updated_at #=> Time
resp.next_token #=> String
resp.request_id #=> String

Parameters:

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

Options Hash (params):

:aws_account_id (required, String) —
The ID of the Amazon Web Services account that contains the DLP settings that you want to list.
:next_token (String) —
The token for the next set of results, or null if there are no more results.
:max_results (Integer) —
The maximum number of results to return per request.

Returns:

(Types::ListDlpSettingsResponse) —
Returns a response object which responds to the following methods:
- #dlp_setting_summaries => Array<Types::DlpSettingSummary>
- #next_token => String
- #request_id => String

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 15601

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

#list_flows(params = {}) ⇒ `Types::ListFlowsOutput`

Lists flows in an Amazon Web Services account.

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

Examples:

Request syntax with placeholder values


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

Response structure


resp.flow_summary_list #=> Array
resp.flow_summary_list[0].arn #=> String
resp.flow_summary_list[0].flow_id #=> String
resp.flow_summary_list[0].name #=> String
resp.flow_summary_list[0].description #=> String
resp.flow_summary_list[0].created_time #=> Time
resp.flow_summary_list[0].created_by #=> String
resp.flow_summary_list[0].last_updated_time #=> Time
resp.flow_summary_list[0].last_updated_by #=> String
resp.flow_summary_list[0].publish_state #=> String, one of "PUBLISHED", "DRAFT", "PENDING_APPROVAL"
resp.flow_summary_list[0].run_count #=> Integer
resp.flow_summary_list[0].user_count #=> Integer
resp.flow_summary_list[0].last_published_by #=> String
resp.flow_summary_list[0].last_published_at #=> Time
resp.next_token #=> String
resp.request_id #=> String
resp.status #=> Integer

Parameters:

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

Options Hash (params):

:aws_account_id (required, String) —
The ID of the Amazon Web Services account that contains the flow list that you are getting.
:next_token (String) —
The token to request the next set of results, or null if you want to retrieve the first set.
:max_results (Integer) —
The maximum number of results to be returned per request.

Returns:

(Types::ListFlowsOutput) —
Returns a response object which responds to the following methods:
- #flow_summary_list => Array<Types::FlowSummary>
- #next_token => String
- #request_id => String
- #status => Integer

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 15660

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

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

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

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

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

Options Hash (params):

:aws_account_id (required, String) —
The ID for the Amazon Web Services account that contains the folder.
:folder_id (required, String) —
The ID of the folder.
:next_token (String) —
The token for the next set of results, or null if there are no more results.
:max_results (Integer) —
The maximum number of results to be returned per request.

Returns:

(Types::ListFolderMembersResponse) —
Returns a response object which responds to the following methods:
- #status => Integer
- #folder_member_list => Array<Types::MemberIdArnPair>
- #next_token => String
- #request_id => String

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 15711

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

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

Lists all folders in an account.

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

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

Options Hash (params):

:aws_account_id (required, String) —
The ID for the Amazon Web Services account that contains the folder.
:next_token (String) —
The token for the next set of results, or null if there are no more results.
:max_results (Integer) —
The maximum number of results to be returned per request.

Returns:

(Types::ListFoldersResponse) —
Returns a response object which responds to the following methods:
- #status => Integer
- #folder_summary_list => Array<Types::FolderSummary>
- #next_token => String
- #request_id => String

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 15763

def list_folders(params = {}, options = {})
  req = build_request(:list_folders, params)
  req.send_request(options)
end

#list_folders_for_resource(params = {}) ⇒ `Types::ListFoldersForResourceResponse`

List all folders that a resource is a member of.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_folders_for_resource({
  aws_account_id: "AwsAccountId", # required
  resource_arn: "Arn", # required
  next_token: "String",
  max_results: 1,
})

Response structure


resp.status #=> Integer
resp.folders #=> Array
resp.folders[0] #=> String
resp.next_token #=> String
resp.request_id #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:aws_account_id (required, String) —
The ID for the Amazon Web Services account that contains the resource.
:resource_arn (required, String) —
The Amazon Resource Name (ARN) the resource whose folders you need to list.
:next_token (String) —
The token for the next set of results, or null if there are no more results.
:max_results (Integer) —
The maximum number of results to be returned per request.

Returns:

(Types::ListFoldersForResourceResponse) —
Returns a response object which responds to the following methods:
- #status => Integer
- #folders => Array<String>
- #next_token => String
- #request_id => String

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 15814

def list_folders_for_resource(params = {}, options = {})
  req = build_request(:list_folders_for_resource, params)
  req.send_request(options)
end

#list_group_memberships(params = {}) ⇒ `Types::ListGroupMembershipsResponse`

Lists member users in a group.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_group_memberships({
  group_name: "GroupName", # required
  next_token: "String",
  max_results: 1,
  aws_account_id: "AwsAccountId", # required
  namespace: "Namespace", # required
})

Response structure


resp.group_member_list #=> Array
resp.group_member_list[0].arn #=> String
resp.group_member_list[0].member_name #=> String
resp.next_token #=> String
resp.request_id #=> String
resp.status #=> Integer

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:group_name (required, String) —
The name of the group that you want to see a membership list of.
:next_token (String) —
A pagination token that can be used in a subsequent request.
:max_results (Integer) —
The maximum number of results to return from this request.
:aws_account_id (required, String) —
The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon Quick Sight account.
:namespace (required, String) —
The namespace of the group that you want a list of users from.

Returns:

(Types::ListGroupMembershipsResponse) —
Returns a response object which responds to the following methods:
- #group_member_list => Array<Types::GroupMember>
- #next_token => String
- #request_id => String
- #status => Integer

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 15870

def list_group_memberships(params = {}, options = {})
  req = build_request(:list_group_memberships, params)
  req.send_request(options)
end

#list_groups(params = {}) ⇒ `Types::ListGroupsResponse`

Lists all user groups in Amazon Quick Sight.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_groups({
  aws_account_id: "AwsAccountId", # required
  next_token: "String",
  max_results: 1,
  namespace: "Namespace", # required
})

Response structure


resp.group_list #=> Array
resp.group_list[0].arn #=> String
resp.group_list[0].group_name #=> String
resp.group_list[0].description #=> String
resp.group_list[0].principal_id #=> String
resp.next_token #=> String
resp.request_id #=> String
resp.status #=> Integer

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:aws_account_id (required, String) —
The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon Quick Sight account.
:next_token (String) —
A pagination token that can be used in a subsequent request.
:max_results (Integer) —
The maximum number of results to return.
:namespace (required, String) —
The namespace that you want a list of groups from.

Returns:

(Types::ListGroupsResponse) —
Returns a response object which responds to the following methods:
- #group_list => Array<Types::Group>
- #next_token => String
- #request_id => String
- #status => Integer

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 15924

def list_groups(params = {}, options = {})
  req = build_request(:list_groups, params)
  req.send_request(options)
end

#list_iam_policy_assignments(params = {}) ⇒ `Types::ListIAMPolicyAssignmentsResponse`

Lists the IAM policy assignments in the current Amazon Quick Sight account.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_iam_policy_assignments({
  aws_account_id: "AwsAccountId", # required
  assignment_status: "ENABLED", # accepts ENABLED, DRAFT, DISABLED
  namespace: "Namespace", # required
  next_token: "String",
  max_results: 1,
})

Response structure


resp.iam_policy_assignments #=> Array
resp.iam_policy_assignments[0].assignment_name #=> String
resp.iam_policy_assignments[0].assignment_status #=> String, one of "ENABLED", "DRAFT", "DISABLED"
resp.next_token #=> String
resp.request_id #=> String
resp.status #=> Integer

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:aws_account_id (required, String) —
The ID of the Amazon Web Services account that contains these IAM policy assignments.
:assignment_status (String) —
The status of the assignments.
:namespace (required, String) —
The namespace for the assignments.
:next_token (String) —
The token for the next set of results, or null if there are no more results.
:max_results (Integer) —
The maximum number of results to be returned per request.

Returns:

(Types::ListIAMPolicyAssignmentsResponse) —
Returns a response object which responds to the following methods:
- #iam_policy_assignments => Array<Types::IAMPolicyAssignmentSummary>
- #next_token => String
- #request_id => String
- #status => Integer

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 15981

def list_iam_policy_assignments(params = {}, options = {})
  req = build_request(:list_iam_policy_assignments, params)
  req.send_request(options)
end

#list_iam_policy_assignments_for_user(params = {}) ⇒ `Types::ListIAMPolicyAssignmentsForUserResponse`

Lists all of the IAM policy assignments, including the Amazon Resource Names (ARNs), for the IAM policies assigned to the specified user and group, or groups that the user belongs to.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_iam_policy_assignments_for_user({
  aws_account_id: "AwsAccountId", # required
  user_name: "UserName", # required
  next_token: "String",
  max_results: 1,
  namespace: "Namespace", # required
})

Response structure


resp.active_assignments #=> Array
resp.active_assignments[0].assignment_name #=> String
resp.active_assignments[0].policy_arn #=> String
resp.request_id #=> String
resp.next_token #=> String
resp.status #=> Integer

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:aws_account_id (required, String) —
The ID of the Amazon Web Services account that contains the assignments.
:user_name (required, String) —
The name of the user.
:next_token (String) —
The token for the next set of results, or null if there are no more results.
:max_results (Integer) —
The maximum number of results to be returned per request.
:namespace (required, String) —
The namespace of the assignment.

Returns:

(Types::ListIAMPolicyAssignmentsForUserResponse) —
Returns a response object which responds to the following methods:
- #active_assignments => Array<Types::ActiveIAMPolicyAssignment>
- #request_id => String
- #next_token => String
- #status => Integer

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 16039

def list_iam_policy_assignments_for_user(params = {}, options = {})
  req = build_request(:list_iam_policy_assignments_for_user, params)
  req.send_request(options)
end

#list_identity_propagation_configs(params = {}) ⇒ `Types::ListIdentityPropagationConfigsResponse`

Lists all services and authorized targets that the Quick Sight IAM Identity Center application can access.

This operation is only supported for Quick Sight accounts that use IAM Identity Center.

Examples:

Request syntax with placeholder values


resp = client.list_identity_propagation_configs({
  aws_account_id: "AwsAccountId", # required
  max_results: 1,
  next_token: "String",
})

Response structure


resp.services #=> Array
resp.services[0].service #=> String, one of "REDSHIFT", "QBUSINESS", "ATHENA", "GLUE_DATA_CATALOG"
resp.services[0].authorized_targets #=> Array
resp.services[0].authorized_targets[0] #=> String
resp.next_token #=> String
resp.status #=> Integer
resp.request_id #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:aws_account_id (required, String) —
The ID of the Amazon Web Services account that contain the identity propagation configurations of.
:max_results (Integer) —
The maximum number of results to be returned.
:next_token (String) —
The token for the next set of results, or null if there are no more results.

Returns:

(Types::ListIdentityPropagationConfigsResponse) —
Returns a response object which responds to the following methods:
- #services => Array<Types::AuthorizedTargetsByService>
- #next_token => String
- #status => Integer
- #request_id => String

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 16090

def list_identity_propagation_configs(params = {}, options = {})
  req = build_request(:list_identity_propagation_configs, params)
  req.send_request(options)
end

#list_ingestions(params = {}) ⇒ `Types::ListIngestionsResponse`

Lists the history of SPICE ingestions for a dataset. Limited to 5 TPS per user and 25 TPS per account.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_ingestions({
  data_set_id: "String", # required
  next_token: "String",
  aws_account_id: "AwsAccountId", # required
  max_results: 1,
})

Response structure


resp.ingestions #=> Array
resp.ingestions[0].arn #=> String
resp.ingestions[0].ingestion_id #=> String
resp.ingestions[0].ingestion_status #=> String, one of "INITIALIZED", "QUEUED", "RUNNING", "FAILED", "COMPLETED", "CANCELLED"
resp.ingestions[0].error_info.type #=> String, one of "FAILURE_TO_ASSUME_ROLE", "INGESTION_SUPERSEDED", "INGESTION_CANCELED", "DATA_SET_DELETED", "DATA_SET_NOT_SPICE", "S3_UPLOADED_FILE_DELETED", "S3_MANIFEST_ERROR", "DATA_TOLERANCE_EXCEPTION", "SPICE_TABLE_NOT_FOUND", "DATA_SET_SIZE_LIMIT_EXCEEDED", "ROW_SIZE_LIMIT_EXCEEDED", "ACCOUNT_CAPACITY_LIMIT_EXCEEDED", "CUSTOMER_ERROR", "DATA_SOURCE_NOT_FOUND", "IAM_ROLE_NOT_AVAILABLE", "CONNECTION_FAILURE", "SQL_TABLE_NOT_FOUND", "PERMISSION_DENIED", "SSL_CERTIFICATE_VALIDATION_FAILURE", "OAUTH_TOKEN_FAILURE", "SOURCE_API_LIMIT_EXCEEDED_FAILURE", "PASSWORD_AUTHENTICATION_FAILURE", "SQL_SCHEMA_MISMATCH_ERROR", "INVALID_DATE_FORMAT", "INVALID_DATAPREP_SYNTAX", "SOURCE_RESOURCE_LIMIT_EXCEEDED", "SQL_INVALID_PARAMETER_VALUE", "QUERY_TIMEOUT", "SQL_NUMERIC_OVERFLOW", "UNRESOLVABLE_HOST", "UNROUTABLE_HOST", "SQL_EXCEPTION", "S3_FILE_INACCESSIBLE", "IOT_FILE_NOT_FOUND", "IOT_DATA_SET_FILE_EMPTY", "INVALID_DATA_SOURCE_CONFIG", "DATA_SOURCE_AUTH_FAILED", "DATA_SOURCE_CONNECTION_FAILED", "FAILURE_TO_PROCESS_JSON_FILE", "INTERNAL_SERVICE_ERROR", "REFRESH_SUPPRESSED_BY_EDIT", "PERMISSION_NOT_FOUND", "ELASTICSEARCH_CURSOR_NOT_ENABLED", "CURSOR_NOT_ENABLED", "DUPLICATE_COLUMN_NAMES_FOUND"
resp.ingestions[0].error_info.message #=> String
resp.ingestions[0].row_info.rows_ingested #=> Integer
resp.ingestions[0].row_info.rows_dropped #=> Integer
resp.ingestions[0].row_info.total_rows_in_dataset #=> Integer
resp.ingestions[0].queue_info.waiting_on_ingestion #=> String
resp.ingestions[0].queue_info.queued_ingestion #=> String
resp.ingestions[0].created_time #=> Time
resp.ingestions[0].ingestion_time_in_seconds #=> Integer
resp.ingestions[0].ingestion_size_in_bytes #=> Integer
resp.ingestions[0].request_source #=> String, one of "MANUAL", "SCHEDULED"
resp.ingestions[0].request_type #=> String, one of "INITIAL_INGESTION", "EDIT", "INCREMENTAL_REFRESH", "FULL_REFRESH"
resp.next_token #=> String
resp.request_id #=> String
resp.status #=> Integer

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:data_set_id (required, String) —
The ID of the dataset used in the ingestion.
:next_token (String) —
The token for the next set of results, or null if there are no more results.
:aws_account_id (required, String) —
The Amazon Web Services account ID.
:max_results (Integer) —
The maximum number of results to be returned per request.

Returns:

(Types::ListIngestionsResponse) —
Returns a response object which responds to the following methods:
- #ingestions => Array<Types::Ingestion>
- #next_token => String
- #request_id => String
- #status => Integer

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 16155

def list_ingestions(params = {}, options = {})
  req = build_request(:list_ingestions, params)
  req.send_request(options)
end

#list_knowledge_bases(params = {}) ⇒ `Types::ListKnowledgeBasesResponse`

Lists all knowledge bases in an Amazon QuickSight account.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_knowledge_bases({
  aws_account_id: "KbAwsAccountId", # required
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.knowledge_base_summaries #=> Array
resp.knowledge_base_summaries[0].knowledge_base_arn #=> String
resp.knowledge_base_summaries[0].knowledge_base_id #=> String
resp.knowledge_base_summaries[0].name #=> String
resp.knowledge_base_summaries[0].status #=> String, one of "CREATING", "UPDATING", "ACTIVE", "FAILED", "DELETING"
resp.knowledge_base_summaries[0].data_source_arn #=> String
resp.knowledge_base_summaries[0].type #=> String
resp.knowledge_base_summaries[0].created_at #=> Time
resp.knowledge_base_summaries[0].updated_at #=> Time
resp.knowledge_base_summaries[0].knowledge_base_size_bytes #=> Integer
resp.knowledge_base_summaries[0].document_count #=> Integer
resp.knowledge_base_summaries[0].primary_owner_arn #=> String
resp.knowledge_base_summaries[0].primary_owner_username #=> String
resp.next_token #=> String
resp.request_id #=> String
resp.status #=> Integer

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:aws_account_id (required, String) —
The ID of the Amazon Web Services account that contains the knowledge base.
:max_results (Integer) —
The maximum number of results to return.
:next_token (String) —
The token for the next set of results, or null if there are no more results.

Returns:

(Types::ListKnowledgeBasesResponse) —
Returns a response object which responds to the following methods:
- #knowledge_base_summaries => Array<Types::KnowledgeBaseSummary>
- #next_token => String
- #request_id => String
- #status => Integer

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 16213

def list_knowledge_bases(params = {}, options = {})
  req = build_request(:list_knowledge_bases, params)
  req.send_request(options)
end

#list_limits_profiles(params = {}) ⇒ `Types::ListLimitsProfilesResponse`

Lists all limits profiles in an Amazon Quick Sight account. Results are paginated. Use the maxResults parameter to limit the number of results returned in a single call, and use the nextToken parameter to retrieve the next page of results.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_limits_profiles({
  account_id: "AwsAccountId", # required
  resource_type: "INDEX_STORAGE", # accepts INDEX_STORAGE, AGENT_HOURS
  max_results: 1,
  next_token: "String",
})

Response structure


resp.profiles #=> Array
resp.profiles[0].profile_id #=> String
resp.profiles[0].arn #=> String
resp.profiles[0].account_id #=> String
resp.profiles[0].profile_name #=> String
resp.profiles[0].description #=> String
resp.profiles[0].resource_limits #=> Hash
resp.profiles[0].resource_limits["ResourceType"].max_value #=> Integer
resp.profiles[0].resource_limits["ResourceType"].unit #=> String, one of "MB", "GB", "HOURS", "DAYS"
resp.profiles[0].created_at #=> Time
resp.profiles[0].updated_at #=> Time
resp.next_token #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:account_id (required, String) —
The ID of the Amazon Web Services account that contains the limits profiles.
:resource_type (String) —
An optional filter that limits the results to profiles that contain the specified resource type. If you don't specify a value, the operation returns all profiles.
:max_results (Integer) —
The maximum number of results to return in a single call. If you don't specify a value, the service uses the default maximum.
:next_token (String) —
The token for the next set of results, or null if there are no more results.

Returns:

(Types::ListLimitsProfilesResponse) —
Returns a response object which responds to the following methods:
- #profiles => Array<Types::LimitsProfile>
- #next_token => String

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 16275

def list_limits_profiles(params = {}, options = {})
  req = build_request(:list_limits_profiles, params)
  req.send_request(options)
end

#list_namespaces(params = {}) ⇒ `Types::ListNamespacesResponse`

Lists the namespaces for the specified Amazon Web Services account. This operation doesn't list deleted namespaces.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_namespaces({
  aws_account_id: "AwsAccountId", # required
  next_token: "String",
  max_results: 1,
})

Response structure


resp.namespaces #=> Array
resp.namespaces[0].name #=> String
resp.namespaces[0].arn #=> String
resp.namespaces[0].capacity_region #=> String
resp.namespaces[0].creation_status #=> String, one of "CREATED", "CREATING", "DELETING", "RETRYABLE_FAILURE", "NON_RETRYABLE_FAILURE"
resp.namespaces[0].identity_store #=> String, one of "QUICKSIGHT"
resp.namespaces[0].namespace_error.type #=> String, one of "PERMISSION_DENIED", "INTERNAL_SERVICE_ERROR"
resp.namespaces[0].namespace_error.message #=> String
resp.namespaces[0].iam_identity_center_application_arn #=> String
resp.namespaces[0].iam_identity_center_instance_arn #=> String
resp.next_token #=> String
resp.request_id #=> String
resp.status #=> Integer

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:aws_account_id (required, String) —
The ID for the Amazon Web Services account that contains the Quick Sight namespaces that you want to list.
:next_token (String) —
A unique pagination token that can be used in a subsequent request. You will receive a pagination token in the response body of a previous ListNameSpaces API call if there is more data that can be returned. To receive the data, make another ListNamespaces API call with the returned token to retrieve the next page of data. Each token is valid for 24 hours. If you try to make a ListNamespaces API call with an expired token, you will receive a HTTP 400 InvalidNextTokenException error.
:max_results (Integer) —
The maximum number of results to return.

Returns:

(Types::ListNamespacesResponse) —
Returns a response object which responds to the following methods:
- #namespaces => Array<Types::NamespaceInfoV2>
- #next_token => String
- #request_id => String
- #status => Integer

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 16337

def list_namespaces(params = {}, options = {})
  req = build_request(:list_namespaces, params)
  req.send_request(options)
end

#list_o_auth_client_applications(params = {}) ⇒ `Types::ListOAuthClientApplicationsResponse`

Lists all OAuthClientApplications in the current Amazon Web Services Region that belong to this Amazon Web Services account.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_o_auth_client_applications({
  aws_account_id: "AwsAccountId", # required
  next_token: "String",
  max_results: 1,
})

Response structure


resp.o_auth_client_applications #=> Array
resp.o_auth_client_applications[0].o_auth_client_application_id #=> String
resp.o_auth_client_applications[0].name #=> String
resp.o_auth_client_applications[0].o_auth_client_authentication_type #=> String, one of "TOKEN"
resp.o_auth_client_applications[0].data_source_type #=> String, one of "ADOBE_ANALYTICS", "AMAZON_ELASTICSEARCH", "ATHENA", "AURORA", "AURORA_POSTGRESQL", "AWS_IOT_ANALYTICS", "GITHUB", "JIRA", "MARIADB", "MYSQL", "ORACLE", "POSTGRESQL", "PRESTO", "REDSHIFT", "S3", "S3_TABLES", "SALESFORCE", "SERVICENOW", "SNOWFLAKE", "SPARK", "SQLSERVER", "TERADATA", "TWITTER", "TIMESTREAM", "AMAZON_OPENSEARCH", "EXASOL", "DATABRICKS", "STARBURST", "TRINO", "BIGQUERY", "GOOGLESHEETS", "GOOGLE_DRIVE", "CONFLUENCE", "SHAREPOINT", "ONE_DRIVE", "WEB_CRAWLER", "S3_KNOWLEDGE_BASE", "QBUSINESS"
resp.o_auth_client_applications[0].identity_provider_vpc_connection_properties.vpc_connection_arn #=> String
resp.o_auth_client_applications[0].created_time #=> Time
resp.o_auth_client_applications[0].last_updated_time #=> Time
resp.o_auth_client_applications[0].arn #=> String
resp.next_token #=> String
resp.request_id #=> String
resp.status #=> Integer

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:aws_account_id (required, String) —
The Amazon Web Services account ID.
:next_token (String) —
A pagination token that can be used in a subsequent request.
:max_results (Integer) —
The maximum number of results to return.

Returns:

(Types::ListOAuthClientApplicationsResponse) —
Returns a response object which responds to the following methods:
- #o_auth_client_applications => Array<Types::OAuthClientApplicationSummary>
- #next_token => String
- #request_id => String
- #status => Integer

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 16390

def list_o_auth_client_applications(params = {}, options = {})
  req = build_request(:list_o_auth_client_applications, params)
  req.send_request(options)
end

#list_refresh_schedules(params = {}) ⇒ `Types::ListRefreshSchedulesResponse`

Lists the refresh schedules of a dataset. Each dataset can have up to 5 schedules.

Examples:

Request syntax with placeholder values


resp = client.list_refresh_schedules({
  aws_account_id: "AwsAccountId", # required
  data_set_id: "ResourceId", # required
})

Response structure


resp.refresh_schedules #=> Array
resp.refresh_schedules[0].schedule_id #=> String
resp.refresh_schedules[0].schedule_frequency.interval #=> String, one of "MINUTE15", "MINUTE30", "HOURLY", "DAILY", "WEEKLY", "MONTHLY"
resp.refresh_schedules[0].schedule_frequency.refresh_on_day.day_of_week #=> String, one of "SUNDAY", "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY"
resp.refresh_schedules[0].schedule_frequency.refresh_on_day.day_of_month #=> String
resp.refresh_schedules[0].schedule_frequency.timezone #=> String
resp.refresh_schedules[0].schedule_frequency.time_of_the_day #=> String
resp.refresh_schedules[0].start_after_date_time #=> Time
resp.refresh_schedules[0].refresh_type #=> String, one of "INCREMENTAL_REFRESH", "FULL_REFRESH"
resp.refresh_schedules[0].arn #=> String
resp.status #=> Integer
resp.request_id #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:aws_account_id (required, String) —
The Amazon Web Services account ID.
:data_set_id (required, String) —
The ID of the dataset.

Returns:

(Types::ListRefreshSchedulesResponse) —
Returns a response object which responds to the following methods:
- #refresh_schedules => Array<Types::RefreshSchedule>
- #status => Integer
- #request_id => String

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 16436

def list_refresh_schedules(params = {}, options = {})
  req = build_request(:list_refresh_schedules, params)
  req.send_request(options)
end

#list_role_memberships(params = {}) ⇒ `Types::ListRoleMembershipsResponse`

Lists all groups that are associated with a role.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_role_memberships({
  role: "ADMIN", # required, accepts ADMIN, AUTHOR, READER, ADMIN_PRO, AUTHOR_PRO, READER_PRO
  next_token: "String",
  max_results: 1,
  aws_account_id: "AwsAccountId", # required
  namespace: "Namespace", # required
})

Response structure


resp.members_list #=> Array
resp.members_list[0] #=> String
resp.next_token #=> String
resp.request_id #=> String
resp.status #=> Integer

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:role (required, String) —
The name of the role.
:next_token (String) —
A pagination token that can be used in a subsequent request.
:max_results (Integer) —
The maximum number of results to return.
:aws_account_id (required, String) —
The ID for the Amazon Web Services account that you want to create a group in. The Amazon Web Services account ID that you provide must be the same Amazon Web Services account that contains your Amazon Quick Sight account.
:namespace (required, String) —
The namespace that includes the role.

Returns:

(Types::ListRoleMembershipsResponse) —
Returns a response object which responds to the following methods:
- #members_list => Array<String>
- #next_token => String
- #request_id => String
- #status => Integer

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 16492

def list_role_memberships(params = {}, options = {})
  req = build_request(:list_role_memberships, params)
  req.send_request(options)
end

#list_self_upgrades(params = {}) ⇒ `Types::ListSelfUpgradesResponse`

Lists all self-upgrade requests for a Quick account.

Examples:

Request syntax with placeholder values


resp = client.list_self_upgrades({
  aws_account_id: "AwsAccountId", # required
  namespace: "Namespace", # required
  next_token: "String",
  max_results: 1,
})

Response structure


resp.self_upgrade_request_details #=> Array
resp.self_upgrade_request_details[0].upgrade_request_id #=> String
resp.self_upgrade_request_details[0].user_name #=> String
resp.self_upgrade_request_details[0].original_role #=> String, one of "ADMIN", "AUTHOR", "READER", "RESTRICTED_AUTHOR", "RESTRICTED_READER", "ADMIN_PRO", "AUTHOR_PRO", "READER_PRO"
resp.self_upgrade_request_details[0].requested_role #=> String, one of "ADMIN", "AUTHOR", "READER", "RESTRICTED_AUTHOR", "RESTRICTED_READER", "ADMIN_PRO", "AUTHOR_PRO", "READER_PRO"
resp.self_upgrade_request_details[0].request_note #=> String
resp.self_upgrade_request_details[0].creation_time #=> Integer
resp.self_upgrade_request_details[0].request_status #=> String, one of "PENDING", "APPROVED", "DENIED", "UPDATE_FAILED", "VERIFY_FAILED"
resp.self_upgrade_request_details[0].last_update_attempt_time #=> Integer
resp.self_upgrade_request_details[0].last_update_failure_reason #=> String
resp.next_token #=> String
resp.request_id #=> String
resp.status #=> Integer

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:aws_account_id (required, String) —
The ID of the Amazon Web Services account that contains the self-upgrade requests.
:namespace (required, String) —
The Quick namespace for the self-upgrade requests.
:next_token (String) —
The token for the next set of results, or null if there are no more results.
:max_results (Integer) —
The maximum number of results to return.

Returns:

(Types::ListSelfUpgradesResponse) —
Returns a response object which responds to the following methods:
- #self_upgrade_request_details => Array<Types::SelfUpgradeRequestDetail>
- #next_token => String
- #request_id => String
- #status => Integer

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 16549

def list_self_upgrades(params = {}, options = {})
  req = build_request(:list_self_upgrades, params)
  req.send_request(options)
end

#list_space_resources(params = {}) ⇒ `Types::ListSpaceResourcesResponse`

Lists the resources in an Amazon QuickSight space.

Examples:

Request syntax with placeholder values


resp = client.list_space_resources({
  aws_account_id: "AwsAccountId", # required
  space_id: "PublicSpaceId", # required
})

Response structure


resp.space_id #=> String
resp.space_arn #=> String
resp.space_resources #=> Array
resp.space_resources[0].resource_type #=> String, one of "TOPIC", "DASHBOARD", "KNOWLEDGE_BASE", "ACTION_CONNECTOR", "DATA_SET"
resp.space_resources[0].resource_details.resource_arn #=> String
resp.space_resources[0].resource_name #=> String
resp.space_resources[0].updated_at #=> Time
resp.request_id #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:aws_account_id (required, String) —
The ID of the Amazon Web Services account that contains the space.
:space_id (required, String) —
The ID of the space that you want to list resources for.

Returns:

(Types::ListSpaceResourcesResponse) —
Returns a response object which responds to the following methods:
- #space_id => String
- #space_arn => String
- #space_resources => Array<Types::SpaceResourceSummary>
- #request_id => String

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 16591

def list_space_resources(params = {}, options = {})
  req = build_request(:list_space_resources, params)
  req.send_request(options)
end

#list_spaces(params = {}) ⇒ `Types::ListSpacesResponse`

Lists all Amazon QuickSight spaces in an Amazon Web Services account.

Examples:

Request syntax with placeholder values


resp = client.list_spaces({
  aws_account_id: "AwsAccountId", # required
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.space_id #=> String
resp.space_arn #=> String
resp.space_summaries #=> Array
resp.space_summaries[0].space_id #=> String
resp.space_summaries[0].space_arn #=> String
resp.space_summaries[0].name #=> String
resp.space_summaries[0].description #=> String
resp.space_summaries[0].updated_at #=> Time
resp.space_summaries[0].consumed_source_size #=> Integer
resp.space_summaries[0].consumed_source_doc_count #=> Integer
resp.space_summaries[0].created_at #=> Time
resp.space_summaries[0].created_by #=> String
resp.space_summaries[0].created_by_arn #=> String
resp.space_summaries[0].resources_count #=> Integer
resp.next_token #=> String
resp.request_id #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:aws_account_id (required, String) —
The ID of the Amazon Web Services account that contains the spaces.
:next_token (String) —
The token for the next set of results, or null if there are no more results.
:max_results (Integer) —
The maximum number of results to return.

Returns:

(Types::ListSpacesResponse) —
Returns a response object which responds to the following methods:
- #space_id => String
- #space_arn => String
- #space_summaries => Array<Types::SpaceSummary>
- #next_token => String
- #request_id => String

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 16647

def list_spaces(params = {}, options = {})
  req = build_request(:list_spaces, params)
  req.send_request(options)
end

#list_tags_for_resource(params = {}) ⇒ `Types::ListTagsForResourceResponse`

Lists the tags assigned to a resource.

Examples:

Request syntax with placeholder values


resp = client.list_tags_for_resource({
  resource_arn: "Arn", # required
})

Response structure


resp.tags #=> Array
resp.tags[0].key #=> String
resp.tags[0].value #=> String
resp.request_id #=> String
resp.status #=> Integer

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:resource_arn (required, String) —
The Amazon Resource Name (ARN) of the resource that you want a list of tags for.

Returns:

(Types::ListTagsForResourceResponse) —
Returns a response object which responds to the following methods:
- #tags => Array<Types::Tag>
- #request_id => String
- #status => Integer

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 16682

def list_tags_for_resource(params = {}, options = {})
  req = build_request(:list_tags_for_resource, params)
  req.send_request(options)
end

#list_template_aliases(params = {}) ⇒ `Types::ListTemplateAliasesResponse`

Lists all the aliases of a template.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_template_aliases({
  aws_account_id: "AwsAccountId", # required
  template_id: "ShortRestrictiveResourceId", # required
  next_token: "String",
  max_results: 1,
})

Response structure


resp.template_alias_list #=> Array
resp.template_alias_list[0].alias_name #=> String
resp.template_alias_list[0].arn #=> String
resp.template_alias_list[0].template_version_number #=> Integer
resp.status #=> Integer
resp.request_id #=> String
resp.next_token #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:aws_account_id (required, String) —
The ID of the Amazon Web Services account that contains the template aliases that you're listing.
:template_id (required, String) —
The ID for the template.
:next_token (String) —
The token for the next set of results, or null if there are no more results.
:max_results (Integer) —
The maximum number of results to be returned per request.

Returns:

(Types::ListTemplateAliasesResponse) —
Returns a response object which responds to the following methods:
- #template_alias_list => Array<Types::TemplateAlias>
- #status => Integer
- #request_id => String
- #next_token => String

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 16735

def list_template_aliases(params = {}, options = {})
  req = build_request(:list_template_aliases, params)
  req.send_request(options)
end

#list_template_versions(params = {}) ⇒ `Types::ListTemplateVersionsResponse`

Lists all the versions of the templates in the current Amazon Quick Sight account.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_template_versions({
  aws_account_id: "AwsAccountId", # required
  template_id: "ShortRestrictiveResourceId", # required
  next_token: "String",
  max_results: 1,
})

Response structure


resp.template_version_summary_list #=> Array
resp.template_version_summary_list[0].arn #=> String
resp.template_version_summary_list[0].version_number #=> Integer
resp.template_version_summary_list[0].created_time #=> Time
resp.template_version_summary_list[0].status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED", "DELETED"
resp.template_version_summary_list[0].description #=> String
resp.next_token #=> String
resp.status #=> Integer
resp.request_id #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:aws_account_id (required, String) —
The ID of the Amazon Web Services account that contains the templates that you're listing.
:template_id (required, String) —
The ID for the template.
:next_token (String) —
The token for the next set of results, or null if there are no more results.
:max_results (Integer) —
The maximum number of results to be returned per request.

Returns:

(Types::ListTemplateVersionsResponse) —
Returns a response object which responds to the following methods:
- #template_version_summary_list => Array<Types::TemplateVersionSummary>
- #next_token => String
- #status => Integer
- #request_id => String

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 16791

def list_template_versions(params = {}, options = {})
  req = build_request(:list_template_versions, params)
  req.send_request(options)
end

#list_templates(params = {}) ⇒ `Types::ListTemplatesResponse`

Lists all the templates in the current Amazon Quick Sight account.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_templates({
  aws_account_id: "AwsAccountId", # required
  next_token: "String",
  max_results: 1,
})

Response structure


resp.template_summary_list #=> Array
resp.template_summary_list[0].arn #=> String
resp.template_summary_list[0].template_id #=> String
resp.template_summary_list[0].name #=> String
resp.template_summary_list[0].latest_version_number #=> Integer
resp.template_summary_list[0].created_time #=> Time
resp.template_summary_list[0].last_updated_time #=> Time
resp.next_token #=> String
resp.status #=> Integer
resp.request_id #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:aws_account_id (required, String) —
The ID of the Amazon Web Services account that contains the templates that you're listing.
:next_token (String) —
The token for the next set of results, or null if there are no more results.
:max_results (Integer) —
The maximum number of results to be returned per request.

Returns:

(Types::ListTemplatesResponse) —
Returns a response object which responds to the following methods:
- #template_summary_list => Array<Types::TemplateSummary>
- #next_token => String
- #status => Integer
- #request_id => String

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 16843

def list_templates(params = {}, options = {})
  req = build_request(:list_templates, params)
  req.send_request(options)
end

#list_theme_aliases(params = {}) ⇒ `Types::ListThemeAliasesResponse`

Lists all the aliases of a theme.

Examples:

Request syntax with placeholder values


resp = client.list_theme_aliases({
  aws_account_id: "AwsAccountId", # required
  theme_id: "ShortRestrictiveResourceId", # required
  next_token: "String",
  max_results: 1,
})

Response structure


resp.theme_alias_list #=> Array
resp.theme_alias_list[0].arn #=> String
resp.theme_alias_list[0].alias_name #=> String
resp.theme_alias_list[0].theme_version_number #=> Integer
resp.status #=> Integer
resp.request_id #=> String
resp.next_token #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:aws_account_id (required, String) —
The ID of the Amazon Web Services account that contains the theme aliases that you're listing.
:theme_id (required, String) —
The ID for the theme.
:next_token (String) —
The token for the next set of results, or null if there are no more results.
:max_results (Integer) —
The maximum number of results to be returned per request.

Returns:

(Types::ListThemeAliasesResponse) —
Returns a response object which responds to the following methods:
- #theme_alias_list => Array<Types::ThemeAlias>
- #status => Integer
- #request_id => String
- #next_token => String

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 16894

def list_theme_aliases(params = {}, options = {})
  req = build_request(:list_theme_aliases, params)
  req.send_request(options)
end

#list_theme_versions(params = {}) ⇒ `Types::ListThemeVersionsResponse`

Lists all the versions of the themes in the current Amazon Web Services account.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_theme_versions({
  aws_account_id: "AwsAccountId", # required
  theme_id: "ShortRestrictiveResourceId", # required
  next_token: "String",
  max_results: 1,
})

Response structure


resp.theme_version_summary_list #=> Array
resp.theme_version_summary_list[0].version_number #=> Integer
resp.theme_version_summary_list[0].arn #=> String
resp.theme_version_summary_list[0].description #=> String
resp.theme_version_summary_list[0].created_time #=> Time
resp.theme_version_summary_list[0].status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED", "DELETED"
resp.next_token #=> String
resp.status #=> Integer
resp.request_id #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:aws_account_id (required, String) —
The ID of the Amazon Web Services account that contains the themes that you're listing.
:theme_id (required, String) —
The ID for the theme.
:next_token (String) —
The token for the next set of results, or null if there are no more results.
:max_results (Integer) —
The maximum number of results to be returned per request.

Returns:

(Types::ListThemeVersionsResponse) —
Returns a response object which responds to the following methods:
- #theme_version_summary_list => Array<Types::ThemeVersionSummary>
- #next_token => String
- #status => Integer
- #request_id => String

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 16950

def list_theme_versions(params = {}, options = {})
  req = build_request(:list_theme_versions, params)
  req.send_request(options)
end

#list_themes(params = {}) ⇒ `Types::ListThemesResponse`

Lists all the themes in the current Amazon Web Services account.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_themes({
  aws_account_id: "AwsAccountId", # required
  next_token: "String",
  max_results: 1,
  type: "QUICKSIGHT", # accepts QUICKSIGHT, CUSTOM, ALL
})

Response structure


resp.theme_summary_list #=> Array
resp.theme_summary_list[0].arn #=> String
resp.theme_summary_list[0].name #=> String
resp.theme_summary_list[0].theme_id #=> String
resp.theme_summary_list[0].latest_version_number #=> Integer
resp.theme_summary_list[0].created_time #=> Time
resp.theme_summary_list[0].last_updated_time #=> Time
resp.next_token #=> String
resp.status #=> Integer
resp.request_id #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:aws_account_id (required, String) —
The ID of the Amazon Web Services account that contains the themes that you're listing.
:next_token (String) —
The token for the next set of results, or null if there are no more results.
:max_results (Integer) —
The maximum number of results to be returned per request.
:type (String) —
The type of themes that you want to list. Valid options include the following:
- ALL (default)- Display all existing themes.
- CUSTOM - Display only the themes created by people using Amazon Quick Sight.
- QUICKSIGHT - Display only the starting themes defined by Quick Sight.

Returns:

(Types::ListThemesResponse) —
Returns a response object which responds to the following methods:
- #theme_summary_list => Array<Types::ThemeSummary>
- #next_token => String
- #status => Integer
- #request_id => String

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 17015

def list_themes(params = {}, options = {})
  req = build_request(:list_themes, params)
  req.send_request(options)
end

#list_topic_refresh_schedules(params = {}) ⇒ `Types::ListTopicRefreshSchedulesResponse`

Lists all of the refresh schedules for a topic.

Examples:

Request syntax with placeholder values


resp = client.list_topic_refresh_schedules({
  aws_account_id: "AwsAccountId", # required
  topic_id: "TopicId", # required
})

Response structure


resp.topic_id #=> String
resp.topic_arn #=> String
resp.refresh_schedules #=> Array
resp.refresh_schedules[0].dataset_id #=> String
resp.refresh_schedules[0].dataset_arn #=> String
resp.refresh_schedules[0].dataset_name #=> String
resp.refresh_schedules[0].refresh_schedule.is_enabled #=> Boolean
resp.refresh_schedules[0].refresh_schedule.based_on_spice_schedule #=> Boolean
resp.refresh_schedules[0].refresh_schedule.starting_at #=> Time
resp.refresh_schedules[0].refresh_schedule.timezone #=> String
resp.refresh_schedules[0].refresh_schedule.repeat_at #=> String
resp.refresh_schedules[0].refresh_schedule.topic_schedule_type #=> String, one of "HOURLY", "DAILY", "WEEKLY", "MONTHLY"
resp.status #=> Integer
resp.request_id #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:aws_account_id (required, String) —
The ID of the Amazon Web Services account that contains the topic whose refresh schedule you want described.
:topic_id (required, String) —
The ID for the topic that you want to describe. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

Returns:

(Types::ListTopicRefreshSchedulesResponse) —
Returns a response object which responds to the following methods:
- #topic_id => String
- #topic_arn => String
- #refresh_schedules => Array<Types::TopicRefreshScheduleSummary>
- #status => Integer
- #request_id => String

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 17066

def list_topic_refresh_schedules(params = {}, options = {})
  req = build_request(:list_topic_refresh_schedules, params)
  req.send_request(options)
end

#list_topic_reviewed_answers(params = {}) ⇒ `Types::ListTopicReviewedAnswersResponse`

Lists all reviewed answers for a Q Topic.

Examples:

Request syntax with placeholder values


resp = client.list_topic_reviewed_answers({
  aws_account_id: "AwsAccountId", # required
  topic_id: "TopicId", # required
})

Response structure


resp.topic_id #=> String
resp.topic_arn #=> String
resp.answers #=> Array
resp.answers[0].arn #=> String
resp.answers[0].answer_id #=> String
resp.answers[0].dataset_arn #=> String
resp.answers[0].question #=> String
resp.answers[0].mir.metrics #=> Array
resp.answers[0].mir.metrics[0].metric_id.identity #=> String
resp.answers[0].mir.metrics[0].function.aggregation #=> String, one of "SUM", "MIN", "MAX", "COUNT", "AVERAGE", "DISTINCT_COUNT", "STDEV", "STDEVP", "VAR", "VARP", "PERCENTILE", "MEDIAN", "PTD_SUM", "PTD_MIN", "PTD_MAX", "PTD_COUNT", "PTD_DISTINCT_COUNT", "PTD_AVERAGE", "COLUMN", "CUSTOM"
resp.answers[0].mir.metrics[0].function.aggregation_function_parameters #=> Hash
resp.answers[0].mir.metrics[0].function.aggregation_function_parameters["AggFunctionParamKey"] #=> String
resp.answers[0].mir.metrics[0].function.period #=> String, one of "SECOND", "MINUTE", "HOUR", "DAY", "WEEK", "MONTH", "QUARTER", "YEAR"
resp.answers[0].mir.metrics[0].function.period_field #=> String
resp.answers[0].mir.metrics[0].operands #=> Array
resp.answers[0].mir.metrics[0].operands[0].identity #=> String
resp.answers[0].mir.metrics[0].comparison_method.type #=> String, one of "DIFF", "PERC_DIFF", "DIFF_AS_PERC", "POP_CURRENT_DIFF_AS_PERC", "POP_CURRENT_DIFF", "POP_OVERTIME_DIFF_AS_PERC", "POP_OVERTIME_DIFF", "PERCENT_OF_TOTAL", "RUNNING_SUM", "MOVING_AVERAGE"
resp.answers[0].mir.metrics[0].comparison_method.period #=> String, one of "SECOND", "MINUTE", "HOUR", "DAY", "WEEK", "MONTH", "QUARTER", "YEAR"
resp.answers[0].mir.metrics[0].comparison_method.window_size #=> Integer
resp.answers[0].mir.metrics[0].expression #=> String
resp.answers[0].mir.metrics[0].calculated_field_references #=> Array
resp.answers[0].mir.metrics[0].calculated_field_references[0].identity #=> String
resp.answers[0].mir.metrics[0].display_format #=> String, one of "AUTO", "PERCENT", "CURRENCY", "NUMBER", "DATE", "STRING"
resp.answers[0].mir.metrics[0].display_format_options.use_blank_cell_format #=> Boolean
resp.answers[0].mir.metrics[0].display_format_options.blank_cell_format #=> String
resp.answers[0].mir.metrics[0].display_format_options.date_format #=> String
resp.answers[0].mir.metrics[0].display_format_options.decimal_separator #=> String, one of "COMMA", "DOT"
resp.answers[0].mir.metrics[0].display_format_options.grouping_separator #=> String
resp.answers[0].mir.metrics[0].display_format_options.use_grouping #=> Boolean
resp.answers[0].mir.metrics[0].display_format_options.fraction_digits #=> Integer
resp.answers[0].mir.metrics[0].display_format_options.prefix #=> String
resp.answers[0].mir.metrics[0].display_format_options.suffix #=> String
resp.answers[0].mir.metrics[0].display_format_options.unit_scaler #=> String, one of "NONE", "AUTO", "THOUSANDS", "MILLIONS", "BILLIONS", "TRILLIONS", "LAKHS", "CRORES"
resp.answers[0].mir.metrics[0].display_format_options.negative_format.prefix #=> String
resp.answers[0].mir.metrics[0].display_format_options.negative_format.suffix #=> String
resp.answers[0].mir.metrics[0].display_format_options.currency_symbol #=> String
resp.answers[0].mir.metrics[0].named_entity.named_entity_name #=> String
resp.answers[0].mir.group_by_list #=> Array
resp.answers[0].mir.group_by_list[0].field_name.identity #=> String
resp.answers[0].mir.group_by_list[0].time_granularity #=> String, one of "SECOND", "MINUTE", "HOUR", "DAY", "WEEK", "MONTH", "QUARTER", "YEAR"
resp.answers[0].mir.group_by_list[0].sort.operand.identity #=> String
resp.answers[0].mir.group_by_list[0].sort.sort_direction #=> String, one of "ASCENDING", "DESCENDING"
resp.answers[0].mir.group_by_list[0].display_format #=> String, one of "AUTO", "PERCENT", "CURRENCY", "NUMBER", "DATE", "STRING"
resp.answers[0].mir.group_by_list[0].display_format_options.use_blank_cell_format #=> Boolean
resp.answers[0].mir.group_by_list[0].display_format_options.blank_cell_format #=> String
resp.answers[0].mir.group_by_list[0].display_format_options.date_format #=> String
resp.answers[0].mir.group_by_list[0].display_format_options.decimal_separator #=> String, one of "COMMA", "DOT"
resp.answers[0].mir.group_by_list[0].display_format_options.grouping_separator #=> String
resp.answers[0].mir.group_by_list[0].display_format_options.use_grouping #=> Boolean
resp.answers[0].mir.group_by_list[0].display_format_options.fraction_digits #=> Integer
resp.answers[0].mir.group_by_list[0].display_format_options.prefix #=> String
resp.answers[0].mir.group_by_list[0].display_format_options.suffix #=> String
resp.answers[0].mir.group_by_list[0].display_format_options.unit_scaler #=> String, one of "NONE", "AUTO", "THOUSANDS", "MILLIONS", "BILLIONS", "TRILLIONS", "LAKHS", "CRORES"
resp.answers[0].mir.group_by_list[0].display_format_options.negative_format.prefix #=> String
resp.answers[0].mir.group_by_list[0].display_format_options.negative_format.suffix #=> String
resp.answers[0].mir.group_by_list[0].display_format_options.currency_symbol #=> String
resp.answers[0].mir.group_by_list[0].named_entity.named_entity_name #=> String
resp.answers[0].mir.filters #=> Array
resp.answers[0].mir.filters[0] #=> Array
resp.answers[0].mir.filters[0][0].filter_type #=> String, one of "CATEGORY_FILTER", "NUMERIC_EQUALITY_FILTER", "NUMERIC_RANGE_FILTER", "DATE_RANGE_FILTER", "RELATIVE_DATE_FILTER", "TOP_BOTTOM_FILTER", "EQUALS", "RANK_LIMIT_FILTER", "ACCEPT_ALL_FILTER"
resp.answers[0].mir.filters[0][0].filter_class #=> String, one of "ENFORCED_VALUE_FILTER", "CONDITIONAL_VALUE_FILTER", "NAMED_VALUE_FILTER", "DASHBOARD_DEFAULT_FILTER"
resp.answers[0].mir.filters[0][0].operand_field.identity #=> String
resp.answers[0].mir.filters[0][0].function #=> String, one of "CONTAINS", "EXACT", "STARTS_WITH", "ENDS_WITH", "CONTAINS_STRING", "PREVIOUS", "THIS", "LAST", "NEXT", "NOW"
resp.answers[0].mir.filters[0][0].constant.constant_type #=> String, one of "SINGULAR", "RANGE", "COLLECTIVE"
resp.answers[0].mir.filters[0][0].constant.value #=> String
resp.answers[0].mir.filters[0][0].constant.minimum #=> String
resp.answers[0].mir.filters[0][0].constant.maximum #=> String
resp.answers[0].mir.filters[0][0].constant.value_list #=> Array
resp.answers[0].mir.filters[0][0].constant.value_list[0].constant_type #=> String, one of "SINGULAR", "RANGE", "COLLECTIVE"
resp.answers[0].mir.filters[0][0].constant.value_list[0].value #=> String
resp.answers[0].mir.filters[0][0].inverse #=> Boolean
resp.answers[0].mir.filters[0][0].null_filter #=> String, one of "ALL_VALUES", "NON_NULLS_ONLY", "NULLS_ONLY"
resp.answers[0].mir.filters[0][0].aggregation #=> String, one of "SUM", "MIN", "MAX", "COUNT", "AVERAGE", "DISTINCT_COUNT", "STDEV", "STDEVP", "VAR", "VARP", "PERCENTILE", "MEDIAN", "PTD_SUM", "PTD_MIN", "PTD_MAX", "PTD_COUNT", "PTD_DISTINCT_COUNT", "PTD_AVERAGE", "COLUMN", "CUSTOM"
resp.answers[0].mir.filters[0][0].aggregation_function_parameters #=> Hash
resp.answers[0].mir.filters[0][0].aggregation_function_parameters["AggFunctionParamKey"] #=> String
resp.answers[0].mir.filters[0][0].aggregation_partition_by #=> Array
resp.answers[0].mir.filters[0][0].aggregation_partition_by[0].field_name #=> String
resp.answers[0].mir.filters[0][0].aggregation_partition_by[0].time_granularity #=> String, one of "YEAR", "QUARTER", "MONTH", "WEEK", "DAY", "HOUR", "MINUTE", "SECOND", "MILLISECOND"
resp.answers[0].mir.filters[0][0].range.constant_type #=> String, one of "SINGULAR", "RANGE", "COLLECTIVE"
resp.answers[0].mir.filters[0][0].range.value #=> String
resp.answers[0].mir.filters[0][0].range.minimum #=> String
resp.answers[0].mir.filters[0][0].range.maximum #=> String
resp.answers[0].mir.filters[0][0].range.value_list #=> Array
resp.answers[0].mir.filters[0][0].range.value_list[0].constant_type #=> String, one of "SINGULAR", "RANGE", "COLLECTIVE"
resp.answers[0].mir.filters[0][0].range.value_list[0].value #=> String
resp.answers[0].mir.filters[0][0].inclusive #=> Boolean
resp.answers[0].mir.filters[0][0].time_granularity #=> String, one of "YEAR", "QUARTER", "MONTH", "WEEK", "DAY", "HOUR", "MINUTE", "SECOND", "MILLISECOND"
resp.answers[0].mir.filters[0][0].last_next_offset.constant_type #=> String, one of "SINGULAR", "RANGE", "COLLECTIVE"
resp.answers[0].mir.filters[0][0].last_next_offset.value #=> String
resp.answers[0].mir.filters[0][0].last_next_offset.minimum #=> String
resp.answers[0].mir.filters[0][0].last_next_offset.maximum #=> String
resp.answers[0].mir.filters[0][0].last_next_offset.value_list #=> Array
resp.answers[0].mir.filters[0][0].last_next_offset.value_list[0].constant_type #=> String, one of "SINGULAR", "RANGE", "COLLECTIVE"
resp.answers[0].mir.filters[0][0].last_next_offset.value_list[0].value #=> String
resp.answers[0].mir.filters[0][0].agg_metrics #=> Array
resp.answers[0].mir.filters[0][0].agg_metrics[0].metric_operand.identity #=> String
resp.answers[0].mir.filters[0][0].agg_metrics[0].function #=> String, one of "SUM", "MIN", "MAX", "COUNT", "AVERAGE", "DISTINCT_COUNT", "STDEV", "STDEVP", "VAR", "VARP", "PERCENTILE", "MEDIAN", "PTD_SUM", "PTD_MIN", "PTD_MAX", "PTD_COUNT", "PTD_DISTINCT_COUNT", "PTD_AVERAGE", "COLUMN", "CUSTOM"
resp.answers[0].mir.filters[0][0].agg_metrics[0].sort_direction #=> String, one of "ASCENDING", "DESCENDING"
resp.answers[0].mir.filters[0][0].top_bottom_limit.constant_type #=> String, one of "SINGULAR", "RANGE", "COLLECTIVE"
resp.answers[0].mir.filters[0][0].top_bottom_limit.value #=> String
resp.answers[0].mir.filters[0][0].top_bottom_limit.minimum #=> String
resp.answers[0].mir.filters[0][0].top_bottom_limit.maximum #=> String
resp.answers[0].mir.filters[0][0].top_bottom_limit.value_list #=> Array
resp.answers[0].mir.filters[0][0].top_bottom_limit.value_list[0].constant_type #=> String, one of "SINGULAR", "RANGE", "COLLECTIVE"
resp.answers[0].mir.filters[0][0].top_bottom_limit.value_list[0].value #=> String
resp.answers[0].mir.filters[0][0].sort_direction #=> String, one of "ASCENDING", "DESCENDING"
resp.answers[0].mir.filters[0][0].anchor.anchor_type #=> String, one of "TODAY"
resp.answers[0].mir.filters[0][0].anchor.time_granularity #=> String, one of "YEAR", "QUARTER", "MONTH", "WEEK", "DAY", "HOUR", "MINUTE", "SECOND", "MILLISECOND"
resp.answers[0].mir.filters[0][0].anchor.offset #=> Integer
resp.answers[0].mir.sort.operand.identity #=> String
resp.answers[0].mir.sort.sort_direction #=> String, one of "ASCENDING", "DESCENDING"
resp.answers[0].mir.contribution_analysis.factors #=> Array
resp.answers[0].mir.contribution_analysis.factors[0].field_name #=> String
resp.answers[0].mir.contribution_analysis.time_ranges.start_range.filter_type #=> String, one of "CATEGORY_FILTER", "NUMERIC_EQUALITY_FILTER", "NUMERIC_RANGE_FILTER", "DATE_RANGE_FILTER", "RELATIVE_DATE_FILTER", "TOP_BOTTOM_FILTER", "EQUALS", "RANK_LIMIT_FILTER", "ACCEPT_ALL_FILTER"
resp.answers[0].mir.contribution_analysis.time_ranges.start_range.filter_class #=> String, one of "ENFORCED_VALUE_FILTER", "CONDITIONAL_VALUE_FILTER", "NAMED_VALUE_FILTER", "DASHBOARD_DEFAULT_FILTER"
resp.answers[0].mir.contribution_analysis.time_ranges.start_range.operand_field.identity #=> String
resp.answers[0].mir.contribution_analysis.time_ranges.start_range.function #=> String, one of "CONTAINS", "EXACT", "STARTS_WITH", "ENDS_WITH", "CONTAINS_STRING", "PREVIOUS", "THIS", "LAST", "NEXT", "NOW"
resp.answers[0].mir.contribution_analysis.time_ranges.start_range.constant.constant_type #=> String, one of "SINGULAR", "RANGE", "COLLECTIVE"
resp.answers[0].mir.contribution_analysis.time_ranges.start_range.constant.value #=> String
resp.answers[0].mir.contribution_analysis.time_ranges.start_range.constant.minimum #=> String
resp.answers[0].mir.contribution_analysis.time_ranges.start_range.constant.maximum #=> String
resp.answers[0].mir.contribution_analysis.time_ranges.start_range.constant.value_list #=> Array
resp.answers[0].mir.contribution_analysis.time_ranges.start_range.constant.value_list[0].constant_type #=> String, one of "SINGULAR", "RANGE", "COLLECTIVE"
resp.answers[0].mir.contribution_analysis.time_ranges.start_range.constant.value_list[0].value #=> String
resp.answers[0].mir.contribution_analysis.time_ranges.start_range.inverse #=> Boolean
resp.answers[0].mir.contribution_analysis.time_ranges.start_range.null_filter #=> String, one of "ALL_VALUES", "NON_NULLS_ONLY", "NULLS_ONLY"
resp.answers[0].mir.contribution_analysis.time_ranges.start_range.aggregation #=> String, one of "SUM", "MIN", "MAX", "COUNT", "AVERAGE", "DISTINCT_COUNT", "STDEV", "STDEVP", "VAR", "VARP", "PERCENTILE", "MEDIAN", "PTD_SUM", "PTD_MIN", "PTD_MAX", "PTD_COUNT", "PTD_DISTINCT_COUNT", "PTD_AVERAGE", "COLUMN", "CUSTOM"
resp.answers[0].mir.contribution_analysis.time_ranges.start_range.aggregation_function_parameters #=> Hash
resp.answers[0].mir.contribution_analysis.time_ranges.start_range.aggregation_function_parameters["AggFunctionParamKey"] #=> String
resp.answers[0].mir.contribution_analysis.time_ranges.start_range.aggregation_partition_by #=> Array
resp.answers[0].mir.contribution_analysis.time_ranges.start_range.aggregation_partition_by[0].field_name #=> String
resp.answers[0].mir.contribution_analysis.time_ranges.start_range.aggregation_partition_by[0].time_granularity #=> String, one of "YEAR", "QUARTER", "MONTH", "WEEK", "DAY", "HOUR", "MINUTE", "SECOND", "MILLISECOND"
resp.answers[0].mir.contribution_analysis.time_ranges.start_range.range.constant_type #=> String, one of "SINGULAR", "RANGE", "COLLECTIVE"
resp.answers[0].mir.contribution_analysis.time_ranges.start_range.range.value #=> String
resp.answers[0].mir.contribution_analysis.time_ranges.start_range.range.minimum #=> String
resp.answers[0].mir.contribution_analysis.time_ranges.start_range.range.maximum #=> String
resp.answers[0].mir.contribution_analysis.time_ranges.start_range.range.value_list #=> Array
resp.answers[0].mir.contribution_analysis.time_ranges.start_range.range.value_list[0].constant_type #=> String, one of "SINGULAR", "RANGE", "COLLECTIVE"
resp.answers[0].mir.contribution_analysis.time_ranges.start_range.range.value_list[0].value #=> String
resp.answers[0].mir.contribution_analysis.time_ranges.start_range.inclusive #=> Boolean
resp.answers[0].mir.contribution_analysis.time_ranges.start_range.time_granularity #=> String, one of "YEAR", "QUARTER", "MONTH", "WEEK", "DAY", "HOUR", "MINUTE", "SECOND", "MILLISECOND"
resp.answers[0].mir.contribution_analysis.time_ranges.start_range.last_next_offset.constant_type #=> String, one of "SINGULAR", "RANGE", "COLLECTIVE"
resp.answers[0].mir.contribution_analysis.time_ranges.start_range.last_next_offset.value #=> String
resp.answers[0].mir.contribution_analysis.time_ranges.start_range.last_next_offset.minimum #=> String
resp.answers[0].mir.contribution_analysis.time_ranges.start_range.last_next_offset.maximum #=> String
resp.answers[0].mir.contribution_analysis.time_ranges.start_range.last_next_offset.value_list #=> Array
resp.answers[0].mir.contribution_analysis.time_ranges.start_range.last_next_offset.value_list[0].constant_type #=> String, one of "SINGULAR", "RANGE", "COLLECTIVE"
resp.answers[0].mir.contribution_analysis.time_ranges.start_range.last_next_offset.value_list[0].value #=> String
resp.answers[0].mir.contribution_analysis.time_ranges.start_range.agg_metrics #=> Array
resp.answers[0].mir.contribution_analysis.time_ranges.start_range.agg_metrics[0].metric_operand.identity #=> String
resp.answers[0].mir.contribution_analysis.time_ranges.start_range.agg_metrics[0].function #=> String, one of "SUM", "MIN", "MAX", "COUNT", "AVERAGE", "DISTINCT_COUNT", "STDEV", "STDEVP", "VAR", "VARP", "PERCENTILE", "MEDIAN", "PTD_SUM", "PTD_MIN", "PTD_MAX", "PTD_COUNT", "PTD_DISTINCT_COUNT", "PTD_AVERAGE", "COLUMN", "CUSTOM"
resp.answers[0].mir.contribution_analysis.time_ranges.start_range.agg_metrics[0].sort_direction #=> String, one of "ASCENDING", "DESCENDING"
resp.answers[0].mir.contribution_analysis.time_ranges.start_range.top_bottom_limit.constant_type #=> String, one of "SINGULAR", "RANGE", "COLLECTIVE"
resp.answers[0].mir.contribution_analysis.time_ranges.start_range.top_bottom_limit.value #=> String
resp.answers[0].mir.contribution_analysis.time_ranges.start_range.top_bottom_limit.minimum #=> String
resp.answers[0].mir.contribution_analysis.time_ranges.start_range.top_bottom_limit.maximum #=> String
resp.answers[0].mir.contribution_analysis.time_ranges.start_range.top_bottom_limit.value_list #=> Array
resp.answers[0].mir.contribution_analysis.time_ranges.start_range.top_bottom_limit.value_list[0].constant_type #=> String, one of "SINGULAR", "RANGE", "COLLECTIVE"
resp.answers[0].mir.contribution_analysis.time_ranges.start_range.top_bottom_limit.value_list[0].value #=> String
resp.answers[0].mir.contribution_analysis.time_ranges.start_range.sort_direction #=> String, one of "ASCENDING", "DESCENDING"
resp.answers[0].mir.contribution_analysis.time_ranges.start_range.anchor.anchor_type #=> String, one of "TODAY"
resp.answers[0].mir.contribution_analysis.time_ranges.start_range.anchor.time_granularity #=> String, one of "YEAR", "QUARTER", "MONTH", "WEEK", "DAY", "HOUR", "MINUTE", "SECOND", "MILLISECOND"
resp.answers[0].mir.contribution_analysis.time_ranges.start_range.anchor.offset #=> Integer
resp.answers[0].mir.contribution_analysis.time_ranges.end_range.filter_type #=> String, one of "CATEGORY_FILTER", "NUMERIC_EQUALITY_FILTER", "NUMERIC_RANGE_FILTER", "DATE_RANGE_FILTER", "RELATIVE_DATE_FILTER", "TOP_BOTTOM_FILTER", "EQUALS", "RANK_LIMIT_FILTER", "ACCEPT_ALL_FILTER"
resp.answers[0].mir.contribution_analysis.time_ranges.end_range.filter_class #=> String, one of "ENFORCED_VALUE_FILTER", "CONDITIONAL_VALUE_FILTER", "NAMED_VALUE_FILTER", "DASHBOARD_DEFAULT_FILTER"
resp.answers[0].mir.contribution_analysis.time_ranges.end_range.operand_field.identity #=> String
resp.answers[0].mir.contribution_analysis.time_ranges.end_range.function #=> String, one of "CONTAINS", "EXACT", "STARTS_WITH", "ENDS_WITH", "CONTAINS_STRING", "PREVIOUS", "THIS", "LAST", "NEXT", "NOW"
resp.answers[0].mir.contribution_analysis.time_ranges.end_range.constant.constant_type #=> String, one of "SINGULAR", "RANGE", "COLLECTIVE"
resp.answers[0].mir.contribution_analysis.time_ranges.end_range.constant.value #=> String
resp.answers[0].mir.contribution_analysis.time_ranges.end_range.constant.minimum #=> String
resp.answers[0].mir.contribution_analysis.time_ranges.end_range.constant.maximum #=> String
resp.answers[0].mir.contribution_analysis.time_ranges.end_range.constant.value_list #=> Array
resp.answers[0].mir.contribution_analysis.time_ranges.end_range.constant.value_list[0].constant_type #=> String, one of "SINGULAR", "RANGE", "COLLECTIVE"
resp.answers[0].mir.contribution_analysis.time_ranges.end_range.constant.value_list[0].value #=> String
resp.answers[0].mir.contribution_analysis.time_ranges.end_range.inverse #=> Boolean
resp.answers[0].mir.contribution_analysis.time_ranges.end_range.null_filter #=> String, one of "ALL_VALUES", "NON_NULLS_ONLY", "NULLS_ONLY"
resp.answers[0].mir.contribution_analysis.time_ranges.end_range.aggregation #=> String, one of "SUM", "MIN", "MAX", "COUNT", "AVERAGE", "DISTINCT_COUNT", "STDEV", "STDEVP", "VAR", "VARP", "PERCENTILE", "MEDIAN", "PTD_SUM", "PTD_MIN", "PTD_MAX", "PTD_COUNT", "PTD_DISTINCT_COUNT", "PTD_AVERAGE", "COLUMN", "CUSTOM"
resp.answers[0].mir.contribution_analysis.time_ranges.end_range.aggregation_function_parameters #=> Hash
resp.answers[0].mir.contribution_analysis.time_ranges.end_range.aggregation_function_parameters["AggFunctionParamKey"] #=> String
resp.answers[0].mir.contribution_analysis.time_ranges.end_range.aggregation_partition_by #=> Array
resp.answers[0].mir.contribution_analysis.time_ranges.end_range.aggregation_partition_by[0].field_name #=> String
resp.answers[0].mir.contribution_analysis.time_ranges.end_range.aggregation_partition_by[0].time_granularity #=> String, one of "YEAR", "QUARTER", "MONTH", "WEEK", "DAY", "HOUR", "MINUTE", "SECOND", "MILLISECOND"
resp.answers[0].mir.contribution_analysis.time_ranges.end_range.range.constant_type #=> String, one of "SINGULAR", "RANGE", "COLLECTIVE"
resp.answers[0].mir.contribution_analysis.time_ranges.end_range.range.value #=> String
resp.answers[0].mir.contribution_analysis.time_ranges.end_range.range.minimum #=> String
resp.answers[0].mir.contribution_analysis.time_ranges.end_range.range.maximum #=> String
resp.answers[0].mir.contribution_analysis.time_ranges.end_range.range.value_list #=> Array
resp.answers[0].mir.contribution_analysis.time_ranges.end_range.range.value_list[0].constant_type #=> String, one of "SINGULAR", "RANGE", "COLLECTIVE"
resp.answers[0].mir.contribution_analysis.time_ranges.end_range.range.value_list[0].value #=> String
resp.answers[0].mir.contribution_analysis.time_ranges.end_range.inclusive #=> Boolean
resp.answers[0].mir.contribution_analysis.time_ranges.end_range.time_granularity #=> String, one of "YEAR", "QUARTER", "MONTH", "WEEK", "DAY", "HOUR", "MINUTE", "SECOND", "MILLISECOND"
resp.answers[0].mir.contribution_analysis.time_ranges.end_range.last_next_offset.constant_type #=> String, one of "SINGULAR", "RANGE", "COLLECTIVE"
resp.answers[0].mir.contribution_analysis.time_ranges.end_range.last_next_offset.value #=> String
resp.answers[0].mir.contribution_analysis.time_ranges.end_range.last_next_offset.minimum #=> String
resp.answers[0].mir.contribution_analysis.time_ranges.end_range.last_next_offset.maximum #=> String
resp.answers[0].mir.contribution_analysis.time_ranges.end_range.last_next_offset.value_list #=> Array
resp.answers[0].mir.contribution_analysis.time_ranges.end_range.last_next_offset.value_list[0].constant_type #=> String, one of "SINGULAR", "RANGE", "COLLECTIVE"
resp.answers[0].mir.contribution_analysis.time_ranges.end_range.last_next_offset.value_list[0].value #=> String
resp.answers[0].mir.contribution_analysis.time_ranges.end_range.agg_metrics #=> Array
resp.answers[0].mir.contribution_analysis.time_ranges.end_range.agg_metrics[0].metric_operand.identity #=> String
resp.answers[0].mir.contribution_analysis.time_ranges.end_range.agg_metrics[0].function #=> String, one of "SUM", "MIN", "MAX", "COUNT", "AVERAGE", "DISTINCT_COUNT", "STDEV", "STDEVP", "VAR", "VARP", "PERCENTILE", "MEDIAN", "PTD_SUM", "PTD_MIN", "PTD_MAX", "PTD_COUNT", "PTD_DISTINCT_COUNT", "PTD_AVERAGE", "COLUMN", "CUSTOM"
resp.answers[0].mir.contribution_analysis.time_ranges.end_range.agg_metrics[0].sort_direction #=> String, one of "ASCENDING", "DESCENDING"
resp.answers[0].mir.contribution_analysis.time_ranges.end_range.top_bottom_limit.constant_type #=> String, one of "SINGULAR", "RANGE", "COLLECTIVE"
resp.answers[0].mir.contribution_analysis.time_ranges.end_range.top_bottom_limit.value #=> String
resp.answers[0].mir.contribution_analysis.time_ranges.end_range.top_bottom_limit.minimum #=> String
resp.answers[0].mir.contribution_analysis.time_ranges.end_range.top_bottom_limit.maximum #=> String
resp.answers[0].mir.contribution_analysis.time_ranges.end_range.top_bottom_limit.value_list #=> Array
resp.answers[0].mir.contribution_analysis.time_ranges.end_range.top_bottom_limit.value_list[0].constant_type #=> String, one of "SINGULAR", "RANGE", "COLLECTIVE"
resp.answers[0].mir.contribution_analysis.time_ranges.end_range.top_bottom_limit.value_list[0].value #=> String
resp.answers[0].mir.contribution_analysis.time_ranges.end_range.sort_direction #=> String, one of "ASCENDING", "DESCENDING"
resp.answers[0].mir.contribution_analysis.time_ranges.end_range.anchor.anchor_type #=> String, one of "TODAY"
resp.answers[0].mir.contribution_analysis.time_ranges.end_range.anchor.time_granularity #=> String, one of "YEAR", "QUARTER", "MONTH", "WEEK", "DAY", "HOUR", "MINUTE", "SECOND", "MILLISECOND"
resp.answers[0].mir.contribution_analysis.time_ranges.end_range.anchor.offset #=> Integer
resp.answers[0].mir.contribution_analysis.direction #=> String, one of "INCREASE", "DECREASE", "NEUTRAL"
resp.answers[0].mir.contribution_analysis.sort_type #=> String, one of "ABSOLUTE_DIFFERENCE", "CONTRIBUTION_PERCENTAGE", "DEVIATION_FROM_EXPECTED", "PERCENTAGE_DIFFERENCE"
resp.answers[0].mir.visual.type #=> String
resp.answers[0].primary_visual.visual_id #=> String
resp.answers[0].primary_visual.role #=> String, one of "PRIMARY", "COMPLIMENTARY", "MULTI_INTENT", "FALLBACK", "FRAGMENT"
resp.answers[0].primary_visual.ir.metrics #=> Array
resp.answers[0].primary_visual.ir.metrics[0].metric_id.identity #=> String
resp.answers[0].primary_visual.ir.metrics[0].function.aggregation #=> String, one of "SUM", "MIN", "MAX", "COUNT", "AVERAGE", "DISTINCT_COUNT", "STDEV", "STDEVP", "VAR", "VARP", "PERCENTILE", "MEDIAN", "PTD_SUM", "PTD_MIN", "PTD_MAX", "PTD_COUNT", "PTD_DISTINCT_COUNT", "PTD_AVERAGE", "COLUMN", "CUSTOM"
resp.answers[0].primary_visual.ir.metrics[0].function.aggregation_function_parameters #=> Hash
resp.answers[0].primary_visual.ir.metrics[0].function.aggregation_function_parameters["AggFunctionParamKey"] #=> String
resp.answers[0].primary_visual.ir.metrics[0].function.period #=> String, one of "SECOND", "MINUTE", "HOUR", "DAY", "WEEK", "MONTH", "QUARTER", "YEAR"
resp.answers[0].primary_visual.ir.metrics[0].function.period_field #=> String
resp.answers[0].primary_visual.ir.metrics[0].operands #=> Array
resp.answers[0].primary_visual.ir.metrics[0].operands[0].identity #=> String
resp.answers[0].primary_visual.ir.metrics[0].comparison_method.type #=> String, one of "DIFF", "PERC_DIFF", "DIFF_AS_PERC", "POP_CURRENT_DIFF_AS_PERC", "POP_CURRENT_DIFF", "POP_OVERTIME_DIFF_AS_PERC", "POP_OVERTIME_DIFF", "PERCENT_OF_TOTAL", "RUNNING_SUM", "MOVING_AVERAGE"
resp.answers[0].primary_visual.ir.metrics[0].comparison_method.period #=> String, one of "SECOND", "MINUTE", "HOUR", "DAY", "WEEK", "MONTH", "QUARTER", "YEAR"
resp.answers[0].primary_visual.ir.metrics[0].comparison_method.window_size #=> Integer
resp.answers[0].primary_visual.ir.metrics[0].expression #=> String
resp.answers[0].primary_visual.ir.metrics[0].calculated_field_references #=> Array
resp.answers[0].primary_visual.ir.metrics[0].calculated_field_references[0].identity #=> String
resp.answers[0].primary_visual.ir.metrics[0].display_format #=> String, one of "AUTO", "PERCENT", "CURRENCY", "NUMBER", "DATE", "STRING"
resp.answers[0].primary_visual.ir.metrics[0].display_format_options.use_blank_cell_format #=> Boolean
resp.answers[0].primary_visual.ir.metrics[0].display_format_options.blank_cell_format #=> String
resp.answers[0].primary_visual.ir.metrics[0].display_format_options.date_format #=> String
resp.answers[0].primary_visual.ir.metrics[0].display_format_options.decimal_separator #=> String, one of "COMMA", "DOT"
resp.answers[0].primary_visual.ir.metrics[0].display_format_options.grouping_separator #=> String
resp.answers[0].primary_visual.ir.metrics[0].display_format_options.use_grouping #=> Boolean
resp.answers[0].primary_visual.ir.metrics[0].display_format_options.fraction_digits #=> Integer
resp.answers[0].primary_visual.ir.metrics[0].display_format_options.prefix #=> String
resp.answers[0].primary_visual.ir.metrics[0].display_format_options.suffix #=> String
resp.answers[0].primary_visual.ir.metrics[0].display_format_options.unit_scaler #=> String, one of "NONE", "AUTO", "THOUSANDS", "MILLIONS", "BILLIONS", "TRILLIONS", "LAKHS", "CRORES"
resp.answers[0].primary_visual.ir.metrics[0].display_format_options.negative_format.prefix #=> String
resp.answers[0].primary_visual.ir.metrics[0].display_format_options.negative_format.suffix #=> String
resp.answers[0].primary_visual.ir.metrics[0].display_format_options.currency_symbol #=> String
resp.answers[0].primary_visual.ir.metrics[0].named_entity.named_entity_name #=> String
resp.answers[0].primary_visual.ir.group_by_list #=> Array
resp.answers[0].primary_visual.ir.group_by_list[0].field_name.identity #=> String
resp.answers[0].primary_visual.ir.group_by_list[0].time_granularity #=> String, one of "SECOND", "MINUTE", "HOUR", "DAY", "WEEK", "MONTH", "QUARTER", "YEAR"
resp.answers[0].primary_visual.ir.group_by_list[0].sort.operand.identity #=> String
resp.answers[0].primary_visual.ir.group_by_list[0].sort.sort_direction #=> String, one of "ASCENDING", "DESCENDING"
resp.answers[0].primary_visual.ir.group_by_list[0].display_format #=> String, one of "AUTO", "PERCENT", "CURRENCY", "NUMBER", "DATE", "STRING"
resp.answers[0].primary_visual.ir.group_by_list[0].display_format_options.use_blank_cell_format #=> Boolean
resp.answers[0].primary_visual.ir.group_by_list[0].display_format_options.blank_cell_format #=> String
resp.answers[0].primary_visual.ir.group_by_list[0].display_format_options.date_format #=> String
resp.answers[0].primary_visual.ir.group_by_list[0].display_format_options.decimal_separator #=> String, one of "COMMA", "DOT"
resp.answers[0].primary_visual.ir.group_by_list[0].display_format_options.grouping_separator #=> String
resp.answers[0].primary_visual.ir.group_by_list[0].display_format_options.use_grouping #=> Boolean
resp.answers[0].primary_visual.ir.group_by_list[0].display_format_options.fraction_digits #=> Integer
resp.answers[0].primary_visual.ir.group_by_list[0].display_format_options.prefix #=> String
resp.answers[0].primary_visual.ir.group_by_list[0].display_format_options.suffix #=> String
resp.answers[0].primary_visual.ir.group_by_list[0].display_format_options.unit_scaler #=> String, one of "NONE", "AUTO", "THOUSANDS", "MILLIONS", "BILLIONS", "TRILLIONS", "LAKHS", "CRORES"
resp.answers[0].primary_visual.ir.group_by_list[0].display_format_options.negative_format.prefix #=> String
resp.answers[0].primary_visual.ir.group_by_list[0].display_format_options.negative_format.suffix #=> String
resp.answers[0].primary_visual.ir.group_by_list[0].display_format_options.currency_symbol #=> String
resp.answers[0].primary_visual.ir.group_by_list[0].named_entity.named_entity_name #=> String
resp.answers[0].primary_visual.ir.filters #=> Array
resp.answers[0].primary_visual.ir.filters[0] #=> Array
resp.answers[0].primary_visual.ir.filters[0][0].filter_type #=> String, one of "CATEGORY_FILTER", "NUMERIC_EQUALITY_FILTER", "NUMERIC_RANGE_FILTER", "DATE_RANGE_FILTER", "RELATIVE_DATE_FILTER", "TOP_BOTTOM_FILTER", "EQUALS", "RANK_LIMIT_FILTER", "ACCEPT_ALL_FILTER"
resp.answers[0].primary_visual.ir.filters[0][0].filter_class #=> String, one of "ENFORCED_VALUE_FILTER", "CONDITIONAL_VALUE_FILTER", "NAMED_VALUE_FILTER", "DASHBOARD_DEFAULT_FILTER"
resp.answers[0].primary_visual.ir.filters[0][0].operand_field.identity #=> String
resp.answers[0].primary_visual.ir.filters[0][0].function #=> String, one of "CONTAINS", "EXACT", "STARTS_WITH", "ENDS_WITH", "CONTAINS_STRING", "PREVIOUS", "THIS", "LAST", "NEXT", "NOW"
resp.answers[0].primary_visual.ir.filters[0][0].constant.constant_type #=> String, one of "SINGULAR", "RANGE", "COLLECTIVE"
resp.answers[0].primary_visual.ir.filters[0][0].constant.value #=> String
resp.answers[0].primary_visual.ir.filters[0][0].constant.minimum #=> String
resp.answers[0].primary_visual.ir.filters[0][0].constant.maximum #=> String
resp.answers[0].primary_visual.ir.filters[0][0].constant.value_list #=> Array
resp.answers[0].primary_visual.ir.filters[0][0].constant.value_list[0].constant_type #=> String, one of "SINGULAR", "RANGE", "COLLECTIVE"
resp.answers[0].primary_visual.ir.filters[0][0].constant.value_list[0].value #=> String
resp.answers[0].primary_visual.ir.filters[0][0].inverse #=> Boolean
resp.answers[0].primary_visual.ir.filters[0][0].null_filter #=> String, one of "ALL_VALUES", "NON_NULLS_ONLY", "NULLS_ONLY"
resp.answers[0].primary_visual.ir.filters[0][0].aggregation #=> String, one of "SUM", "MIN", "MAX", "COUNT", "AVERAGE", "DISTINCT_COUNT", "STDEV", "STDEVP", "VAR", "VARP", "PERCENTILE", "MEDIAN", "PTD_SUM", "PTD_MIN", "PTD_MAX", "PTD_COUNT", "PTD_DISTINCT_COUNT", "PTD_AVERAGE", "COLUMN", "CUSTOM"
resp.answers[0].primary_visual.ir.filters[0][0].aggregation_function_parameters #=> Hash
resp.answers[0].primary_visual.ir.filters[0][0].aggregation_function_parameters["AggFunctionParamKey"] #=> String
resp.answers[0].primary_visual.ir.filters[0][0].aggregation_partition_by #=> Array
resp.answers[0].primary_visual.ir.filters[0][0].aggregation_partition_by[0].field_name #=> String
resp.answers[0].primary_visual.ir.filters[0][0].aggregation_partition_by[0].time_granularity #=> String, one of "YEAR", "QUARTER", "MONTH", "WEEK", "DAY", "HOUR", "MINUTE", "SECOND", "MILLISECOND"
resp.answers[0].primary_visual.ir.filters[0][0].range.constant_type #=> String, one of "SINGULAR", "RANGE", "COLLECTIVE"
resp.answers[0].primary_visual.ir.filters[0][0].range.value #=> String
resp.answers[0].primary_visual.ir.filters[0][0].range.minimum #=> String
resp.answers[0].primary_visual.ir.filters[0][0].range.maximum #=> String
resp.answers[0].primary_visual.ir.filters[0][0].range.value_list #=> Array
resp.answers[0].primary_visual.ir.filters[0][0].range.value_list[0].constant_type #=> String, one of "SINGULAR", "RANGE", "COLLECTIVE"
resp.answers[0].primary_visual.ir.filters[0][0].range.value_list[0].value #=> String
resp.answers[0].primary_visual.ir.filters[0][0].inclusive #=> Boolean
resp.answers[0].primary_visual.ir.filters[0][0].time_granularity #=> String, one of "YEAR", "QUARTER", "MONTH", "WEEK", "DAY", "HOUR", "MINUTE", "SECOND", "MILLISECOND"
resp.answers[0].primary_visual.ir.filters[0][0].last_next_offset.constant_type #=> String, one of "SINGULAR", "RANGE", "COLLECTIVE"
resp.answers[0].primary_visual.ir.filters[0][0].last_next_offset.value #=> String
resp.answers[0].primary_visual.ir.filters[0][0].last_next_offset.minimum #=> String
resp.answers[0].primary_visual.ir.filters[0][0].last_next_offset.maximum #=> String
resp.answers[0].primary_visual.ir.filters[0][0].last_next_offset.value_list #=> Array
resp.answers[0].primary_visual.ir.filters[0][0].last_next_offset.value_list[0].constant_type #=> String, one of "SINGULAR", "RANGE", "COLLECTIVE"
resp.answers[0].primary_visual.ir.filters[0][0].last_next_offset.value_list[0].value #=> String
resp.answers[0].primary_visual.ir.filters[0][0].agg_metrics #=> Array
resp.answers[0].primary_visual.ir.filters[0][0].agg_metrics[0].metric_operand.identity #=> String
resp.answers[0].primary_visual.ir.filters[0][0].agg_metrics[0].function #=> String, one of "SUM", "MIN", "MAX", "COUNT", "AVERAGE", "DISTINCT_COUNT", "STDEV", "STDEVP", "VAR", "VARP", "PERCENTILE", "MEDIAN", "PTD_SUM", "PTD_MIN", "PTD_MAX", "PTD_COUNT", "PTD_DISTINCT_COUNT", "PTD_AVERAGE", "COLUMN", "CUSTOM"
resp.answers[0].primary_visual.ir.filters[0][0].agg_metrics[0].sort_direction #=> String, one of "ASCENDING", "DESCENDING"
resp.answers[0].primary_visual.ir.filters[0][0].top_bottom_limit.constant_type #=> String, one of "SINGULAR", "RANGE", "COLLECTIVE"
resp.answers[0].primary_visual.ir.filters[0][0].top_bottom_limit.value #=> String
resp.answers[0].primary_visual.ir.filters[0][0].top_bottom_limit.minimum #=> String
resp.answers[0].primary_visual.ir.filters[0][0].top_bottom_limit.maximum #=> String
resp.answers[0].primary_visual.ir.filters[0][0].top_bottom_limit.value_list #=> Array
resp.answers[0].primary_visual.ir.filters[0][0].top_bottom_limit.value_list[0].constant_type #=> String, one of "SINGULAR", "RANGE", "COLLECTIVE"
resp.answers[0].primary_visual.ir.filters[0][0].top_bottom_limit.value_list[0].value #=> String
resp.answers[0].primary_visual.ir.filters[0][0].sort_direction #=> String, one of "ASCENDING", "DESCENDING"
resp.answers[0].primary_visual.ir.filters[0][0].anchor.anchor_type #=> String, one of "TODAY"
resp.answers[0].primary_visual.ir.filters[0][0].anchor.time_granularity #=> String, one of "YEAR", "QUARTER", "MONTH", "WEEK", "DAY", "HOUR", "MINUTE", "SECOND", "MILLISECOND"
resp.answers[0].primary_visual.ir.filters[0][0].anchor.offset #=> Integer
resp.answers[0].primary_visual.ir.sort.operand.identity #=> String
resp.answers[0].primary_visual.ir.sort.sort_direction #=> String, one of "ASCENDING", "DESCENDING"
resp.answers[0].primary_visual.ir.contribution_analysis.factors #=> Array
resp.answers[0].primary_visual.ir.contribution_analysis.factors[0].field_name #=> String
resp.answers[0].primary_visual.ir.contribution_analysis.time_ranges.start_range.filter_type #=> String, one of "CATEGORY_FILTER", "NUMERIC_EQUALITY_FILTER", "NUMERIC_RANGE_FILTER", "DATE_RANGE_FILTER", "RELATIVE_DATE_FILTER", "TOP_BOTTOM_FILTER", "EQUALS", "RANK_LIMIT_FILTER", "ACCEPT_ALL_FILTER"
resp.answers[0].primary_visual.ir.contribution_analysis.time_ranges.start_range.filter_class #=> String, one of "ENFORCED_VALUE_FILTER", "CONDITIONAL_VALUE_FILTER", "NAMED_VALUE_FILTER", "DASHBOARD_DEFAULT_FILTER"
resp.answers[0].primary_visual.ir.contribution_analysis.time_ranges.start_range.operand_field.identity #=> String
resp.answers[0].primary_visual.ir.contribution_analysis.time_ranges.start_range.function #=> String, one of "CONTAINS", "EXACT", "STARTS_WITH", "ENDS_WITH", "CONTAINS_STRING", "PREVIOUS", "THIS", "LAST", "NEXT", "NOW"
resp.answers[0].primary_visual.ir.contribution_analysis.time_ranges.start_range.constant.constant_type #=> String, one of "SINGULAR", "RANGE", "COLLECTIVE"
resp.answers[0].primary_visual.ir.contribution_analysis.time_ranges.start_range.constant.value #=> String
resp.answers[0].primary_visual.ir.contribution_analysis.time_ranges.start_range.constant.minimum #=> String
resp.answers[0].primary_visual.ir.contribution_analysis.time_ranges.start_range.constant.maximum #=> String
resp.answers[0].primary_visual.ir.contribution_analysis.time_ranges.start_range.constant.value_list #=> Array
resp.answers[0].primary_visual.ir.contribution_analysis.time_ranges.start_range.constant.value_list[0].constant_type #=> String, one of "SINGULAR", "RANGE", "COLLECTIVE"
resp.answers[0].primary_visual.ir.contribution_analysis.time_ranges.start_range.constant.value_list[0].value #=> String
resp.answers[0].primary_visual.ir.contribution_analysis.time_ranges.start_range.inverse #=> Boolean
resp.answers[0].primary_visual.ir.contribution_analysis.time_ranges.start_range.null_filter #=> String, one of "ALL_VALUES", "NON_NULLS_ONLY", "NULLS_ONLY"
resp.answers[0].primary_visual.ir.contribution_analysis.time_ranges.start_range.aggregation #=> String, one of "SUM", "MIN", "MAX", "COUNT", "AVERAGE", "DISTINCT_COUNT", "STDEV", "STDEVP", "VAR", "VARP", "PERCENTILE", "MEDIAN", "PTD_SUM", "PTD_MIN", "PTD_MAX", "PTD_COUNT", "PTD_DISTINCT_COUNT", "PTD_AVERAGE", "COLUMN", "CUSTOM"
resp.answers[0].primary_visual.ir.contribution_analysis.time_ranges.start_range.aggregation_function_parameters #=> Hash
resp.answers[0].primary_visual.ir.contribution_analysis.time_ranges.start_range.aggregation_function_parameters["AggFunctionParamKey"] #=> String
resp.answers[0].primary_visual.ir.contribution_analysis.time_ranges.start_range.aggregation_partition_by #=> Array
resp.answers[0].primary_visual.ir.contribution_analysis.time_ranges.start_range.aggregation_partition_by[0].field_name #=> String
resp.answers[0].primary_visual.ir.contribution_analysis.time_ranges.start_range.aggregation_partition_by[0].time_granularity #=> String, one of "YEAR", "QUARTER", "MONTH", "WEEK", "DAY", "HOUR", "MINUTE", "SECOND", "MILLISECOND"
resp.answers[0].primary_visual.ir.contribution_analysis.time_ranges.start_range.range.constant_type #=> String, one of "SINGULAR", "RANGE", "COLLECTIVE"
resp.answers[0].primary_visual.ir.contribution_analysis.time_ranges.start_range.range.value #=> String
resp.answers[0].primary_visual.ir.contribution_analysis.time_ranges.start_range.range.minimum #=> String
resp.answers[0].primary_visual.ir.contribution_analysis.time_ranges.start_range.range.maximum #=> String
resp.answers[0].primary_visual.ir.contribution_analysis.time_ranges.start_range.range.value_list #=> Array
resp.answers[0].primary_visual.ir.contribution_analysis.time_ranges.start_range.range.value_list[0].constant_type #=> String, one of "SINGULAR", "RANGE", "COLLECTIVE"
resp.answers[0].primary_visual.ir.contribution_analysis.time_ranges.start_range.range.value_list[0].value #=> String
resp.answers[0].primary_visual.ir.contribution_analysis.time_ranges.start_range.inclusive #=> Boolean
resp.answers[0].primary_visual.ir.contribution_analysis.time_ranges.start_range.time_granularity #=> String, one of "YEAR", "QUARTER", "MONTH", "WEEK", "DAY", "HOUR", "MINUTE", "SECOND", "MILLISECOND"
resp.answers[0].primary_visual.ir.contribution_analysis.time_ranges.start_range.last_next_offset.constant_type #=> String, one of "SINGULAR", "RANGE", "COLLECTIVE"
resp.answers[0].primary_visual.ir.contribution_analysis.time_ranges.start_range.last_next_offset.value #=> String
resp.answers[0].primary_visual.ir.contribution_analysis.time_ranges.start_range.last_next_offset.minimum #=> String
resp.answers[0].primary_visual.ir.contribution_analysis.time_ranges.start_range.last_next_offset.maximum #=> String
resp.answers[0].primary_visual.ir.contribution_analysis.time_ranges.start_range.last_next_offset.value_list #=> Array
resp.answers[0].primary_visual.ir.contribution_analysis.time_ranges.start_range.last_next_offset.value_list[0].constant_type #=> String, one of "SINGULAR", "RANGE", "COLLECTIVE"
resp.answers[0].primary_visual.ir.contribution_analysis.time_ranges.start_range.last_next_offset.value_list[0].value #=> String
resp.answers[0].primary_visual.ir.contribution_analysis.time_ranges.start_range.agg_metrics #=> Array
resp.answers[0].primary_visual.ir.contribution_analysis.time_ranges.start_range.agg_metrics[0].metric_operand.identity #=> String
resp.answers[0].primary_visual.ir.contribution_analysis.time_ranges.start_range.agg_metrics[0].function #=> String, one of "SUM", "MIN", "MAX", "COUNT", "AVERAGE", "DISTINCT_COUNT", "STDEV", "STDEVP", "VAR", "VARP", "PERCENTILE", "MEDIAN", "PTD_SUM", "PTD_MIN", "PTD_MAX", "PTD_COUNT", "PTD_DISTINCT_COUNT", "PTD_AVERAGE", "COLUMN", "CUSTOM"
resp.answers[0].primary_visual.ir.contribution_analysis.time_ranges.start_range.agg_metrics[0].sort_direction #=> String, one of "ASCENDING", "DESCENDING"
resp.answers[0].primary_visual.ir.contribution_analysis.time_ranges.start_range.top_bottom_limit.constant_type #=> String, one of "SINGULAR", "RANGE", "COLLECTIVE"
resp.answers[0].primary_visual.ir.contribution_analysis.time_ranges.start_range.top_bottom_limit.value #=> String
resp.answers[0].primary_visual.ir.contribution_analysis.time_ranges.start_range.top_bottom_limit.minimum #=> String
resp.answers[0].primary_visual.ir.contribution_analysis.time_ranges.start_range.top_bottom_limit.maximum #=> String
resp.answers[0].primary_visual.ir.contribution_analysis.time_ranges.start_range.top_bottom_limit.value_list #=> Array
resp.answers[0].primary_visual.ir.contribution_analysis.time_ranges.start_range.top_bottom_limit.value_list[0].constant_type #=> String, one of "SINGULAR", "RANGE", "COLLECTIVE"
resp.answers[0].primary_visual.ir.contribution_analysis.time_ranges.start_range.top_bottom_limit.value_list[0].value #=> String
resp.answers[0].primary_visual.ir.contribution_analysis.time_ranges.start_range.sort_direction #=> String, one of "ASCENDING", "DESCENDING"
resp.answers[0].primary_visual.ir.contribution_analysis.time_ranges.start_range.anchor.anchor_type #=> String, one of "TODAY"
resp.answers[0].primary_visual.ir.contribution_analysis.time_ranges.start_range.anchor.time_granularity #=> String, one of "YEAR", "QUARTER", "MONTH", "WEEK", "DAY", "HOUR", "MINUTE", "SECOND", "MILLISECOND"
resp.answers[0].primary_visual.ir.contribution_analysis.time_ranges.start_range.anchor.offset #=> Integer
resp.answers[0].primary_visual.ir.contribution_analysis.time_ranges.end_range.filter_type #=> String, one of "CATEGORY_FILTER", "NUMERIC_EQUALITY_FILTER", "NUMERIC_RANGE_FILTER", "DATE_RANGE_FILTER", "RELATIVE_DATE_FILTER", "TOP_BOTTOM_FILTER", "EQUALS", "RANK_LIMIT_FILTER", "ACCEPT_ALL_FILTER"
resp.answers[0].primary_visual.ir.contribution_analysis.time_ranges.end_range.filter_class #=> String, one of "ENFORCED_VALUE_FILTER", "CONDITIONAL_VALUE_FILTER", "NAMED_VALUE_FILTER", "DASHBOARD_DEFAULT_FILTER"
resp.answers[0].primary_visual.ir.contribution_analysis.time_ranges.end_range.operand_field.identity #=> String
resp.answers[0].primary_visual.ir.contribution_analysis.time_ranges.end_range.function #=> String, one of "CONTAINS", "EXACT", "STARTS_WITH", "ENDS_WITH", "CONTAINS_STRING", "PREVIOUS", "THIS", "LAST", "NEXT", "NOW"
resp.answers[0].primary_visual.ir.contribution_analysis.time_ranges.end_range.constant.constant_type #=> String, one of "SINGULAR", "RANGE", "COLLECTIVE"
resp.answers[0].primary_visual.ir.contribution_analysis.time_ranges.end_range.constant.value #=> String
resp.answers[0].primary_visual.ir.contribution_analysis.time_ranges.end_range.constant.minimum #=> String
resp.answers[0].primary_visual.ir.contribution_analysis.time_ranges.end_range.constant.maximum #=> String
resp.answers[0].primary_visual.ir.contribution_analysis.time_ranges.end_range.constant.value_list #=> Array
resp.answers[0].primary_visual.ir.contribution_analysis.time_ranges.end_range.constant.value_list[0].constant_type #=> String, one of "SINGULAR", "RANGE", "COLLECTIVE"
resp.answers[0].primary_visual.ir.contribution_analysis.time_ranges.end_range.constant.value_list[0].value #=> String
resp.answers[0].primary_visual.ir.contribution_analysis.time_ranges.end_range.inverse #=> Boolean
resp.answers[0].primary_visual.ir.contribution_analysis.time_ranges.end_range.null_filter #=> String, one of "ALL_VALUES", "NON_NULLS_ONLY", "NULLS_ONLY"
resp.answers[0].primary_visual.ir.contribution_analysis.time_ranges.end_range.aggregation #=> String, one of "SUM", "MIN", "MAX", "COUNT", "AVERAGE", "DISTINCT_COUNT", "STDEV", "STDEVP", "VAR", "VARP", "PERCENTILE", "MEDIAN", "PTD_SUM", "PTD_MIN", "PTD_MAX", "PTD_COUNT", "PTD_DISTINCT_COUNT", "PTD_AVERAGE", "COLUMN", "CUSTOM"
resp.answers[0].primary_visual.ir.contribution_analysis.time_ranges.end_range.aggregation_function_parameters #=> Hash
resp.answers[0].primary_visual.ir.contribution_analysis.time_ranges.end_range.aggregation_function_parameters["AggFunctionParamKey"] #=> String
resp.answers[0].primary_visual.ir.contribution_analysis.time_ranges.end_range.aggregation_partition_by #=> Array
resp.answers[0].primary_visual.ir.contribution_analysis.time_ranges.end_range.aggregation_partition_by[0].field_name #=> String
resp.answers[0].primary_visual.ir.contribution_analysis.time_ranges.end_range.aggregation_partition_by[0].time_granularity #=> String, one of "YEAR", "QUARTER", "MONTH", "WEEK", "DAY", "HOUR", "MINUTE", "SECOND", "MILLISECOND"
resp.answers[0].primary_visual.ir.contribution_analysis.time_ranges.end_range.range.constant_type #=> String, one of "SINGULAR", "RANGE", "COLLECTIVE"
resp.answers[0].primary_visual.ir.contribution_analysis.time_ranges.end_range.range.value #=> String
resp.answers[0].primary_visual.ir.contribution_analysis.time_ranges.end_range.range.minimum #=> String
resp.answers[0].primary_visual.ir.contribution_analysis.time_ranges.end_range.range.maximum #=> String
resp.answers[0].primary_visual.ir.contribution_analysis.time_ranges.end_range.range.value_list #=> Array
resp.answers[0].primary_visual.ir.contribution_analysis.time_ranges.end_range.range.value_list[0].constant_type #=> String, one of "SINGULAR", "RANGE", "COLLECTIVE"
resp.answers[0].primary_visual.ir.contribution_analysis.time_ranges.end_range.range.value_list[0].value #=> String
resp.answers[0].primary_visual.ir.contribution_analysis.time_ranges.end_range.inclusive #=> Boolean
resp.answers[0].primary_visual.ir.contribution_analysis.time_ranges.end_range.time_granularity #=> String, one of "YEAR", "QUARTER", "MONTH", "WEEK", "DAY", "HOUR", "MINUTE", "SECOND", "MILLISECOND"
resp.answers[0].primary_visual.ir.contribution_analysis.time_ranges.end_range.last_next_offset.constant_type #=> String, one of "SINGULAR", "RANGE", "COLLECTIVE"
resp.answers[0].primary_visual.ir.contribution_analysis.time_ranges.end_range.last_next_offset.value #=> String
resp.answers[0].primary_visual.ir.contribution_analysis.time_ranges.end_range.last_next_offset.minimum #=> String
resp.answers[0].primary_visual.ir.contribution_analysis.time_ranges.end_range.last_next_offset.maximum #=> String
resp.answers[0].primary_visual.ir.contribution_analysis.time_ranges.end_range.last_next_offset.value_list #=> Array
resp.answers[0].primary_visual.ir.contribution_analysis.time_ranges.end_range.last_next_offset.value_list[0].constant_type #=> String, one of "SINGULAR", "RANGE", "COLLECTIVE"
resp.answers[0].primary_visual.ir.contribution_analysis.time_ranges.end_range.last_next_offset.value_list[0].value #=> String
resp.answers[0].primary_visual.ir.contribution_analysis.time_ranges.end_range.agg_metrics #=> Array
resp.answers[0].primary_visual.ir.contribution_analysis.time_ranges.end_range.agg_metrics[0].metric_operand.identity #=> String
resp.answers[0].primary_visual.ir.contribution_analysis.time_ranges.end_range.agg_metrics[0].function #=> String, one of "SUM", "MIN", "MAX", "COUNT", "AVERAGE", "DISTINCT_COUNT", "STDEV", "STDEVP", "VAR", "VARP", "PERCENTILE", "MEDIAN", "PTD_SUM", "PTD_MIN", "PTD_MAX", "PTD_COUNT", "PTD_DISTINCT_COUNT", "PTD_AVERAGE", "COLUMN", "CUSTOM"
resp.answers[0].primary_visual.ir.contribution_analysis.time_ranges.end_range.agg_metrics[0].sort_direction #=> String, one of "ASCENDING", "DESCENDING"
resp.answers[0].primary_visual.ir.contribution_analysis.time_ranges.end_range.top_bottom_limit.constant_type #=> String, one of "SINGULAR", "RANGE", "COLLECTIVE"
resp.answers[0].primary_visual.ir.contribution_analysis.time_ranges.end_range.top_bottom_limit.value #=> String
resp.answers[0].primary_visual.ir.contribution_analysis.time_ranges.end_range.top_bottom_limit.minimum #=> String
resp.answers[0].primary_visual.ir.contribution_analysis.time_ranges.end_range.top_bottom_limit.maximum #=> String
resp.answers[0].primary_visual.ir.contribution_analysis.time_ranges.end_range.top_bottom_limit.value_list #=> Array
resp.answers[0].primary_visual.ir.contribution_analysis.time_ranges.end_range.top_bottom_limit.value_list[0].constant_type #=> String, one of "SINGULAR", "RANGE", "COLLECTIVE"
resp.answers[0].primary_visual.ir.contribution_analysis.time_ranges.end_range.top_bottom_limit.value_list[0].value #=> String
resp.answers[0].primary_visual.ir.contribution_analysis.time_ranges.end_range.sort_direction #=> String, one of "ASCENDING", "DESCENDING"
resp.answers[0].primary_visual.ir.contribution_analysis.time_ranges.end_range.anchor.anchor_type #=> String, one of "TODAY"
resp.answers[0].primary_visual.ir.contribution_analysis.time_ranges.end_range.anchor.time_granularity #=> String, one of "YEAR", "QUARTER", "MONTH", "WEEK", "DAY", "HOUR", "MINUTE", "SECOND", "MILLISECOND"
resp.answers[0].primary_visual.ir.contribution_analysis.time_ranges.end_range.anchor.offset #=> Integer
resp.answers[0].primary_visual.ir.contribution_analysis.direction #=> String, one of "INCREASE", "DECREASE", "NEUTRAL"
resp.answers[0].primary_visual.ir.contribution_analysis.sort_type #=> String, one of "ABSOLUTE_DIFFERENCE", "CONTRIBUTION_PERCENTAGE", "DEVIATION_FROM_EXPECTED", "PERCENTAGE_DIFFERENCE"
resp.answers[0].primary_visual.ir.visual.type #=> String
resp.answers[0].primary_visual.supporting_visuals #=> Array
resp.answers[0].primary_visual.supporting_visuals[0] #=> Types::TopicVisual
resp.answers[0].template.template_type #=> String
resp.answers[0].template.slots #=> Array
resp.answers[0].template.slots[0].slot_id #=> String
resp.answers[0].template.slots[0].visual_id #=> String
resp.status #=> Integer
resp.request_id #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:aws_account_id (required, String) —
The ID of the Amazon Web Services account that containd the reviewed answers that you want listed.
:topic_id (required, String) —
The ID for the topic that contains the reviewed answer that you want to list. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

Returns:

(Types::ListTopicReviewedAnswersResponse) —
Returns a response object which responds to the following methods:
- #topic_id => String
- #topic_arn => String
- #answers => Array<Types::TopicReviewedAnswer>
- #status => Integer
- #request_id => String

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 17539

def list_topic_reviewed_answers(params = {}, options = {})
  req = build_request(:list_topic_reviewed_answers, params)
  req.send_request(options)
end

#list_topics(params = {}) ⇒ `Types::ListTopicsResponse`

Lists all of the topics within an account.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_topics({
  aws_account_id: "AwsAccountId", # required
  next_token: "String",
  max_results: 1,
})

Response structure


resp.topics_summaries #=> Array
resp.topics_summaries[0].arn #=> String
resp.topics_summaries[0].topic_id #=> String
resp.topics_summaries[0].name #=> String
resp.topics_summaries[0].user_experience_version #=> String, one of "LEGACY", "NEW_READER_EXPERIENCE"
resp.next_token #=> String
resp.request_id #=> String
resp.status #=> Integer

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:aws_account_id (required, String) —
The ID of the Amazon Web Services account that contains the topics that you want to list.
:next_token (String) —
The token for the next set of results, or null if there are no more results.
:max_results (Integer) —
The maximum number of results to be returned per request.

Returns:

(Types::ListTopicsResponse) —
Returns a response object which responds to the following methods:
- #topics_summaries => Array<Types::TopicSummary>
- #next_token => String
- #request_id => String
- #status => Integer

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 17589

def list_topics(params = {}, options = {})
  req = build_request(:list_topics, params)
  req.send_request(options)
end

#list_topics_v2(params = {}) ⇒ `Types::ListTopicsV2Response`

Lists all of the Q topics in the specified Amazon Web Services account in an Amazon Web Services Region.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_topics_v2({
  aws_account_id: "AwsAccountId", # required
  next_token: "String",
  max_results: 1,
})

Response structure


resp.topic_summary_list #=> Array
resp.topic_summary_list[0].arn #=> String
resp.topic_summary_list[0].topic_id #=> String
resp.topic_summary_list[0].name #=> String
resp.next_token #=> String
resp.request_id #=> String
resp.status #=> Integer

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:aws_account_id (required, String) —
The ID of the Amazon Web Services account that contains the topics that you want to list.
:next_token (String) —
The token for the next set of results, or null if there are no more results.
:max_results (Integer) —
The maximum number of results to be returned per request.

Returns:

(Types::ListTopicsV2Response) —
Returns a response object which responds to the following methods:
- #topic_summary_list => Array<Types::TopicV2Summary>
- #next_token => String
- #request_id => String
- #status => Integer

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 17639

def list_topics_v2(params = {}, options = {})
  req = build_request(:list_topics_v2, params)
  req.send_request(options)
end

#list_user_groups(params = {}) ⇒ `Types::ListUserGroupsResponse`

Lists the Amazon Quick Sight groups that an Amazon Quick Sight user is a member of.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_user_groups({
  user_name: "UserName", # required
  aws_account_id: "AwsAccountId", # required
  namespace: "Namespace", # required
  next_token: "String",
  max_results: 1,
})

Response structure


resp.group_list #=> Array
resp.group_list[0].arn #=> String
resp.group_list[0].group_name #=> String
resp.group_list[0].description #=> String
resp.group_list[0].principal_id #=> String
resp.next_token #=> String
resp.request_id #=> String
resp.status #=> Integer

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:user_name (required, String) —
The Amazon Quick Sight user name that you want to list group memberships for.
:aws_account_id (required, String) —
The Amazon Web Services account ID that the user is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon Quick Sight account.
:namespace (required, String) —
The namespace. Currently, you should set this to default.
:next_token (String) —
A pagination token that can be used in a subsequent request.
:max_results (Integer) —
The maximum number of results to return from this request.

Returns:

(Types::ListUserGroupsResponse) —
Returns a response object which responds to the following methods:
- #group_list => Array<Types::Group>
- #next_token => String
- #request_id => String
- #status => Integer

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 17699

def list_user_groups(params = {}, options = {})
  req = build_request(:list_user_groups, params)
  req.send_request(options)
end

#list_users(params = {}) ⇒ `Types::ListUsersResponse`

Returns a list of all of the Amazon Quick Sight users belonging to this account.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_users({
  aws_account_id: "AwsAccountId", # required
  next_token: "String",
  max_results: 1,
  namespace: "Namespace", # required
})

Response structure


resp.user_list #=> Array
resp.user_list[0].arn #=> String
resp.user_list[0].user_name #=> String
resp.user_list[0].email #=> String
resp.user_list[0].role #=> String, one of "ADMIN", "AUTHOR", "READER", "RESTRICTED_AUTHOR", "RESTRICTED_READER", "ADMIN_PRO", "AUTHOR_PRO", "READER_PRO"
resp.user_list[0].identity_type #=> String, one of "IAM", "QUICKSIGHT", "IAM_IDENTITY_CENTER"
resp.user_list[0].active #=> Boolean
resp.user_list[0].principal_id #=> String
resp.user_list[0].custom_permissions_name #=> String
resp.user_list[0].external_login_federation_provider_type #=> String
resp.user_list[0].external_login_federation_provider_url #=> String
resp.user_list[0].external_login_id #=> String
resp.next_token #=> String
resp.request_id #=> String
resp.status #=> Integer

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:aws_account_id (required, String) —
The ID for the Amazon Web Services account that the user is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon Quick Sight account.
:next_token (String) —
A pagination token that can be used in a subsequent request.
:max_results (Integer) —
The maximum number of results to return from this request.
:namespace (required, String) —
The namespace. Currently, you should set this to default.

Returns:

(Types::ListUsersResponse) —
Returns a response object which responds to the following methods:
- #user_list => Array<Types::User>
- #next_token => String
- #request_id => String
- #status => Integer

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 17761

def list_users(params = {}, options = {})
  req = build_request(:list_users, params)
  req.send_request(options)
end

#list_users_index_capacity(params = {}) ⇒ `Types::ListUsersIndexCapacityResponse`

Lists per-user index capacity consumption for an account.

Examples:

Request syntax with placeholder values


resp = client.list_users_index_capacity({
  aws_account_id: "AwsAccountId", # required
  namespace: "Namespace",
  filters: [
    {
      user_name_or_email: {
        prefix: "FilterValue", # required
      },
      total_capacity_bytes: {
        min_bytes: 1,
        max_bytes: 1,
      },
    },
  ],
  sort_by: "TOTAL_CAPACITY_BYTES", # accepts TOTAL_CAPACITY_BYTES
  sort_order: "ASC", # accepts ASC, DESC
  max_results: 1,
  next_token: "String",
})

Response structure


resp.users #=> Array
resp.users[0].user_arn #=> String
resp.users[0].user_name #=> String
resp.users[0].email #=> String
resp.users[0].role #=> String
resp.users[0].total_capacity_bytes #=> Integer
resp.users[0].total_kb_capacity_bytes #=> Integer
resp.users[0].total_space_capacity_bytes #=> Integer
resp.users[0].kb_count #=> Integer
resp.users[0].space_count #=> Integer
resp.next_token #=> String
resp.request_id #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:aws_account_id (required, String) —
The ID of the Amazon Web Services account that contains the index capacity data.
:namespace (String) —
The namespace to scope the user search to. Required when the userNameOrEmail filter is present.
:filters (Array<Types::UserIndexCapacityFilter>) —
Filters to apply. Only one filter is supported per request. The userNameOrEmail and totalCapacityBytes filters are mutually exclusive.
:sort_by (String) —
The field to sort results by.
:sort_order (String) —
The sort order for results. Defaults to DESC if not specified.
:max_results (Integer) —
The maximum number of results to return per page.
:next_token (String) —
The token for the next set of results, received from a previous call.

Returns:

(Types::ListUsersIndexCapacityResponse) —
Returns a response object which responds to the following methods:
- #users => Array<Types::UserIndexCapacity>
- #next_token => String
- #request_id => String

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 17839

def list_users_index_capacity(params = {}, options = {})
  req = build_request(:list_users_index_capacity, params)
  req.send_request(options)
end

#list_vpc_connections(params = {}) ⇒ `Types::ListVPCConnectionsResponse`

Lists all of the VPC connections in the current set Amazon Web Services Region of an Amazon Web Services account.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_vpc_connections({
  aws_account_id: "AwsAccountId", # required
  next_token: "String",
  max_results: 1,
})

Response structure


resp.vpc_connection_summaries #=> Array
resp.vpc_connection_summaries[0].vpc_connection_id #=> String
resp.vpc_connection_summaries[0].arn #=> String
resp.vpc_connection_summaries[0].name #=> String
resp.vpc_connection_summaries[0].vpc_id #=> String
resp.vpc_connection_summaries[0].security_group_ids #=> Array
resp.vpc_connection_summaries[0].security_group_ids[0] #=> String
resp.vpc_connection_summaries[0].dns_resolvers #=> Array
resp.vpc_connection_summaries[0].dns_resolvers[0] #=> String
resp.vpc_connection_summaries[0].status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED", "DELETION_IN_PROGRESS", "DELETION_FAILED", "DELETED"
resp.vpc_connection_summaries[0].availability_status #=> String, one of "AVAILABLE", "UNAVAILABLE", "PARTIALLY_AVAILABLE"
resp.vpc_connection_summaries[0].network_interfaces #=> Array
resp.vpc_connection_summaries[0].network_interfaces[0].subnet_id #=> String
resp.vpc_connection_summaries[0].network_interfaces[0].availability_zone #=> String
resp.vpc_connection_summaries[0].network_interfaces[0].error_message #=> String
resp.vpc_connection_summaries[0].network_interfaces[0].status #=> String, one of "CREATING", "AVAILABLE", "CREATION_FAILED", "UPDATING", "UPDATE_FAILED", "DELETING", "DELETED", "DELETION_FAILED", "DELETION_SCHEDULED", "ATTACHMENT_FAILED_ROLLBACK_FAILED"
resp.vpc_connection_summaries[0].network_interfaces[0].network_interface_id #=> String
resp.vpc_connection_summaries[0].role_arn #=> String
resp.vpc_connection_summaries[0].created_time #=> Time
resp.vpc_connection_summaries[0].last_updated_time #=> Time
resp.next_token #=> String
resp.request_id #=> String
resp.status #=> Integer

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:aws_account_id (required, String) —
The Amazon Web Services account ID of the account that contains the VPC connections that you want to list.
:next_token (String) —
The token for the next set of results, or null if there are no more results.
:max_results (Integer) —
The maximum number of results to be returned per request.

Returns:

(Types::ListVPCConnectionsResponse) —
Returns a response object which responds to the following methods:
- #vpc_connection_summaries => Array<Types::VPCConnectionSummary>
- #next_token => String
- #request_id => String
- #status => Integer

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 17905

def list_vpc_connections(params = {}, options = {})
  req = build_request(:list_vpc_connections, params)
  req.send_request(options)
end

#predict_qa_results(params = {}) ⇒ `Types::PredictQAResultsResponse`

Predicts existing visuals or generates new visuals to answer a given query.

This API uses trusted identity propagation to ensure that an end user is authenticated and receives the embed URL that is specific to that user. The IAM Identity Center application that the user has logged into needs to have trusted Identity Propagation enabled for Quick with the scope value set to quicksight:read. Before you use this action, make sure that you have configured the relevant Quick resource and permissions.

We recommend enabling the QSearchStatus API to unlock the full potential of PredictQnA. When QSearchStatus is enabled, it first checks the specified dashboard for any existing visuals that match the question. If no matching visuals are found, PredictQnA uses generative Q&A to provide an answer. To update the QSearchStatus, see UpdateQuickSightQSearchConfiguration.

Examples:

Request syntax with placeholder values


resp = client.predict_qa_results({
  aws_account_id: "AwsAccountId", # required
  query_text: "QAQueryText", # required
  include_quick_sight_q_index: "INCLUDE", # accepts INCLUDE, EXCLUDE
  include_generated_answer: "INCLUDE", # accepts INCLUDE, EXCLUDE
  max_topics_to_consider: 1,
})

Response structure


resp.primary_result.result_type #=> String, one of "DASHBOARD_VISUAL", "GENERATED_ANSWER", "NO_ANSWER"
resp.primary_result.dashboard_visual.dashboard_id #=> String
resp.primary_result.dashboard_visual.dashboard_name #=> String
resp.primary_result.dashboard_visual.sheet_id #=> String
resp.primary_result.dashboard_visual.sheet_name #=> String
resp.primary_result.dashboard_visual.visual_id #=> String
resp.primary_result.dashboard_visual.visual_title #=> String
resp.primary_result.dashboard_visual.visual_subtitle #=> String
resp.primary_result.dashboard_visual.dashboard_url #=> String
resp.primary_result.generated_answer.question_text #=> String
resp.primary_result.generated_answer.answer_status #=> String, one of "ANSWER_GENERATED", "ANSWER_RETRIEVED", "ANSWER_DOWNGRADE"
resp.primary_result.generated_answer.topic_id #=> String
resp.primary_result.generated_answer.topic_name #=> String
resp.primary_result.generated_answer.restatement #=> String
resp.primary_result.generated_answer.question_id #=> String
resp.primary_result.generated_answer.answer_id #=> String
resp.primary_result.generated_answer.question_url #=> String
resp.additional_results #=> Array
resp.additional_results[0].result_type #=> String, one of "DASHBOARD_VISUAL", "GENERATED_ANSWER", "NO_ANSWER"
resp.additional_results[0].dashboard_visual.dashboard_id #=> String
resp.additional_results[0].dashboard_visual.dashboard_name #=> String
resp.additional_results[0].dashboard_visual.sheet_id #=> String
resp.additional_results[0].dashboard_visual.sheet_name #=> String
resp.additional_results[0].dashboard_visual.visual_id #=> String
resp.additional_results[0].dashboard_visual.visual_title #=> String
resp.additional_results[0].dashboard_visual.visual_subtitle #=> String
resp.additional_results[0].dashboard_visual.dashboard_url #=> String
resp.additional_results[0].generated_answer.question_text #=> String
resp.additional_results[0].generated_answer.answer_status #=> String, one of "ANSWER_GENERATED", "ANSWER_RETRIEVED", "ANSWER_DOWNGRADE"
resp.additional_results[0].generated_answer.topic_id #=> String
resp.additional_results[0].generated_answer.topic_name #=> String
resp.additional_results[0].generated_answer.restatement #=> String
resp.additional_results[0].generated_answer.question_id #=> String
resp.additional_results[0].generated_answer.answer_id #=> String
resp.additional_results[0].generated_answer.question_url #=> String
resp.request_id #=> String
resp.status #=> Integer

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:aws_account_id (required, String) —
The ID of the Amazon Web Services account that the user wants to execute Predict QA results in.
:query_text (required, String) —
The query text to be used to predict QA results.
:include_quick_sight_q_index (String) —
Indicates whether Q indicies are included or excluded.
:include_generated_answer (String) —
Indicates whether generated answers are included or excluded.
:max_topics_to_consider (Integer) —
The number of maximum topics to be considered to predict QA results.

Returns:

(Types::PredictQAResultsResponse) —
Returns a response object which responds to the following methods:
- #primary_result => Types::QAResult
- #additional_results => Array<Types::QAResult>
- #request_id => String
- #status => Integer

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 18011

def predict_qa_results(params = {}, options = {})
  req = build_request(:predict_qa_results, params)
  req.send_request(options)
end

#put_data_set_refresh_properties(params = {}) ⇒ `Types::PutDataSetRefreshPropertiesResponse`

Creates or updates the dataset refresh properties for the dataset.

Examples:

Request syntax with placeholder values


resp = client.put_data_set_refresh_properties({
  aws_account_id: "AwsAccountId", # required
  data_set_id: "ResourceId", # required
  data_set_refresh_properties: { # required
    refresh_configuration: {
      incremental_refresh: { # required
        lookback_window: { # required
          column_name: "String", # required
          size: 1, # required
          size_unit: "HOUR", # required, accepts HOUR, DAY, WEEK
        },
      },
    },
    failure_configuration: {
      email_alert: {
        alert_status: "ENABLED", # accepts ENABLED, DISABLED
      },
    },
  },
})

Response structure


resp.request_id #=> String
resp.status #=> Integer

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:aws_account_id (required, String) —
The Amazon Web Services account ID.
:data_set_id (required, String) —
The ID of the dataset.
:data_set_refresh_properties (required, Types::DataSetRefreshProperties) —
The dataset refresh properties.

Returns:

(Types::PutDataSetRefreshPropertiesResponse) —
Returns a response object which responds to the following methods:
- #request_id => String
- #status => Integer

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 18064

def put_data_set_refresh_properties(params = {}, options = {})
  req = build_request(:put_data_set_refresh_properties, params)
  req.send_request(options)
end

#register_user(params = {}) ⇒ `Types::RegisterUserResponse`

Creates an Amazon Quick Sight user whose identity is associated with the Identity and Access Management (IAM) identity or role specified in the request. When you register a new user from the Quick Sight API, Quick Sight generates a registration URL. The user accesses this registration URL to create their account. Quick Sight doesn't send a registration email to users who are registered from the Quick Sight API. If you want new users to receive a registration email, then add those users in the Quick Sight console. For more information on registering a new user in the Quick Sight console, see Inviting users to access Quick Sight.

Examples:

Request syntax with placeholder values


resp = client.register_user({
  identity_type: "IAM", # required, accepts IAM, QUICKSIGHT, IAM_IDENTITY_CENTER
  email: "String", # required
  user_role: "ADMIN", # required, accepts ADMIN, AUTHOR, READER, RESTRICTED_AUTHOR, RESTRICTED_READER, ADMIN_PRO, AUTHOR_PRO, READER_PRO
  iam_arn: "String",
  session_name: "RoleSessionName",
  aws_account_id: "AwsAccountId", # required
  namespace: "Namespace", # required
  user_name: "UserName",
  custom_permissions_name: "RoleName",
  external_login_federation_provider_type: "String",
  custom_federation_provider_url: "String",
  external_login_id: "String",
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
})

Response structure


resp.user.arn #=> String
resp.user.user_name #=> String
resp.user.email #=> String
resp.user.role #=> String, one of "ADMIN", "AUTHOR", "READER", "RESTRICTED_AUTHOR", "RESTRICTED_READER", "ADMIN_PRO", "AUTHOR_PRO", "READER_PRO"
resp.user.identity_type #=> String, one of "IAM", "QUICKSIGHT", "IAM_IDENTITY_CENTER"
resp.user.active #=> Boolean
resp.user.principal_id #=> String
resp.user.custom_permissions_name #=> String
resp.user.external_login_federation_provider_type #=> String
resp.user.external_login_federation_provider_url #=> String
resp.user.external_login_id #=> String
resp.user_invitation_url #=> String
resp.request_id #=> String
resp.status #=> Integer

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:identity_type (required, String) —
The identity type that your Quick Sight account uses to manage the identity of users.
:email (required, String) —
The email address of the user that you want to register.
:user_role (required, String) —
The Amazon Quick Sight 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 Quick Sight settings.
- READER_PRO: Reader Pro adds Generative BI capabilities to the Reader role. Reader Pros have access to Amazon Q in Quick Sight, can build stories with Amazon Q, and can generate executive summaries from dashboards.
- AUTHOR_PRO: Author Pro adds Generative BI capabilities to the Author role. Author Pros can author dashboards with natural language with Amazon Q, build stories with Amazon Q, create Topics for Q&A, and generate executive summaries from dashboards.
- ADMIN_PRO: Admin Pros are Author Pros who can also manage Amazon Quick Sight administrative settings. Admin Pro users are billed at Author Pro pricing.
- RESTRICTED_READER: This role isn't currently available for use.
- RESTRICTED_AUTHOR: This role isn't currently available for use.
:iam_arn (String) —
The ARN of the IAM user or role that you are registering with Amazon Quick Sight.
:session_name (String) —
You need to use this parameter only when you register one or more users using an assumed IAM role. You don't need to provide the session name for other scenarios, for example when you are registering an IAM user or an Amazon Quick Sight user. You can register multiple users using the same IAM role if each user has a different session name. For more information on assuming IAM roles, see assume-role in the CLI Reference.
:aws_account_id (required, String) —
The ID for the Amazon Web Services account that the user is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon Quick Sight account.
:namespace (required, String) —
The namespace. Currently, you should set this to default.
:user_name (String) —
The Amazon Quick Sight user name that you want to create for the user you are registering.
:custom_permissions_name (String) — default: Enterprise edition only —
The name of the custom permissions profile that you want to assign to this user. Customized permissions allows you to control a user's access by restricting access the following operations:
- Create and update data sources
- Create and update datasets
- Create and update email reports
- Subscribe to email reports
To add custom permissions to an existing user, use UpdateUser instead.

A set of custom permissions includes any combination of these restrictions. Currently, you need to create the profile names for custom permission sets by using the Quick Sight console. Then, you use the RegisterUser API operation to assign the named set of permissions to a Quick Sight user.

Quick Sight custom permissions are applied through IAM policies. Therefore, they override the permissions typically granted by assigning Quick Sight users to one of the default security cohorts in Quick Sight (admin, author, reader, admin pro, author pro, reader pro).

This feature is available only to Quick Sight Enterprise edition subscriptions.
:external_login_federation_provider_type (String) —
The type of supported external login provider that provides identity to let a user federate into Amazon Quick Sight with an associated Identity and Access Management(IAM) role. The type of supported external login provider can be one of the following.
- COGNITO: Amazon Cognito. The provider URL is cognito-identity.amazonaws.com. When choosing the COGNITO provider type, don’t use the "CustomFederationProviderUrl" parameter which is only needed when the external provider is custom.
- CUSTOM_OIDC: Custom OpenID Connect (OIDC) provider. When choosing CUSTOM_OIDC type, use the CustomFederationProviderUrl parameter to provide the custom OIDC provider URL.
:custom_federation_provider_url (String) —
The URL of the custom OpenID Connect (OIDC) provider that provides identity to let a user federate into Quick Sight with an associated Identity and Access Management(IAM) role. This parameter should only be used when ExternalLoginFederationProviderType parameter is set to CUSTOM_OIDC.
:external_login_id (String) —
The identity ID for a user in the external login provider.
:tags (Array<Types::Tag>) —
The tags to associate with the user.

Returns:

(Types::RegisterUserResponse) —
Returns a response object which responds to the following methods:
- #user => Types::User
- #user_invitation_url => String
- #request_id => String
- #status => Integer

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 18261

def register_user(params = {}, options = {})
  req = build_request(:register_user, params)
  req.send_request(options)
end

#restore_analysis(params = {}) ⇒ `Types::RestoreAnalysisResponse`

Restores an analysis.

Examples:

Request syntax with placeholder values


resp = client.restore_analysis({
  aws_account_id: "AwsAccountId", # required
  analysis_id: "ShortRestrictiveResourceId", # required
  restore_to_folders: false,
})

Response structure


resp.status #=> Integer
resp.arn #=> String
resp.analysis_id #=> String
resp.request_id #=> String
resp.restoration_failed_folder_arns #=> Array
resp.restoration_failed_folder_arns[0] #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:aws_account_id (required, String) —
The ID of the Amazon Web Services account that contains the analysis.
:analysis_id (required, String) —
The ID of the analysis that you're restoring.
:restore_to_folders (Boolean) —
A boolean value that determines if the analysis will be restored to folders that it previously resided in. A True value restores analysis back to all folders that it previously resided in. A False value restores the analysis but does not restore the analysis back to all previously resided folders. Restoring a restricted analysis requires this parameter to be set to True.

Returns:

(Types::RestoreAnalysisResponse) —
Returns a response object which responds to the following methods:
- #status => Integer
- #arn => String
- #analysis_id => String
- #request_id => String
- #restoration_failed_folder_arns => Array<String>

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 18311

def restore_analysis(params = {}, options = {})
  req = build_request(:restore_analysis, params)
  req.send_request(options)
end

#search_action_connectors(params = {}) ⇒ `Types::SearchActionConnectorsResponse`

Searches for action connectors in the specified Amazon Web Services account using filters. You can search by connector name, type, or user permissions.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.search_action_connectors({
  aws_account_id: "AwsAccountId", # required
  max_results: 1,
  next_token: "String",
  filters: [ # required
    {
      name: "ACTION_CONNECTOR_NAME", # required, accepts ACTION_CONNECTOR_NAME, ACTION_CONNECTOR_TYPE, QUICKSIGHT_OWNER, QUICKSIGHT_VIEWER_OR_OWNER, DIRECT_QUICKSIGHT_SOLE_OWNER, DIRECT_QUICKSIGHT_OWNER, DIRECT_QUICKSIGHT_VIEWER_OR_OWNER
      operator: "StringEquals", # required, accepts StringEquals, StringLike
      value: "String", # required
    },
  ],
})

Response structure


resp.next_token #=> String
resp.request_id #=> String
resp.status #=> Integer
resp.action_connector_summaries #=> Array
resp.action_connector_summaries[0].arn #=> String
resp.action_connector_summaries[0].action_connector_id #=> String
resp.action_connector_summaries[0].type #=> String, one of "GENERIC_HTTP", "SERVICENOW_NOW_PLATFORM", "SALESFORCE_CRM", "MICROSOFT_OUTLOOK", "PAGERDUTY_ADVANCE", "JIRA_CLOUD", "ATLASSIAN_CONFLUENCE", "AMAZON_S3", "AMAZON_BEDROCK_AGENT_RUNTIME", "AMAZON_BEDROCK_RUNTIME", "AMAZON_BEDROCK_DATA_AUTOMATION_RUNTIME", "AMAZON_TEXTRACT", "AMAZON_COMPREHEND", "AMAZON_COMPREHEND_MEDICAL", "MICROSOFT_ONEDRIVE", "MICROSOFT_SHAREPOINT", "MICROSOFT_TEAMS", "SAP_BUSINESSPARTNER", "SAP_PRODUCTMASTERDATA", "SAP_PHYSICALINVENTORY", "SAP_BILLOFMATERIALS", "SAP_MATERIALSTOCK", "ZENDESK_SUITE", "SMARTSHEET", "SLACK", "ASANA", "BAMBOO_HR"
resp.action_connector_summaries[0].name #=> String
resp.action_connector_summaries[0].created_time #=> Time
resp.action_connector_summaries[0].last_updated_time #=> Time
resp.action_connector_summaries[0].status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED", "DELETED"
resp.action_connector_summaries[0].error.message #=> String
resp.action_connector_summaries[0].error.type #=> String, one of "INTERNAL_FAILURE"

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:aws_account_id (required, String) —
The Amazon Web Services account ID in which to search for action connectors.
:max_results (Integer) —
The maximum number of action connectors to return in a single response. Valid range is 1 to 100.
:next_token (String) —
A pagination token to retrieve the next set of results. Use the token returned from a previous call to continue searching.
:filters (required, Array<Types::ActionConnectorSearchFilter>) —
The search filters to apply. You can filter by connector name, type, or user permissions. Maximum of one filter is supported.

Returns:

(Types::SearchActionConnectorsResponse) —
Returns a response object which responds to the following methods:
- #next_token => String
- #request_id => String
- #status => Integer
- #action_connector_summaries => Array<Types::ActionConnectorSummary>

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 18380

def search_action_connectors(params = {}, options = {})
  req = build_request(:search_action_connectors, params)
  req.send_request(options)
end

#search_agents(params = {}) ⇒ `Types::SearchAgentsResponse`

Searches for agents based on specified filters.

Examples:

Request syntax with placeholder values


resp = client.search_agents({
  aws_account_id: "AwsAccountId", # required
  filters: [ # required
    {
      name: "DIRECT_QUICKSIGHT_OWNER", # accepts DIRECT_QUICKSIGHT_OWNER, DIRECT_QUICKSIGHT_VIEWER_OR_OWNER, DIRECT_QUICKSIGHT_SOLE_OWNER, AGENT_NAME
      operator: "StringEquals", # accepts StringEquals, StringLike
      value: "String",
    },
  ],
  max_results: 1,
  next_token: "String",
})

Response structure


resp.agent_summaries #=> Array
resp.agent_summaries[0].arn #=> String
resp.agent_summaries[0].agent_id #=> String
resp.agent_summaries[0].name #=> String
resp.agent_summaries[0].description #=> String
resp.agent_summaries[0].created_at #=> Time
resp.agent_summaries[0].updated_at #=> Time
resp.agent_summaries[0].icon_id #=> String
resp.next_token #=> String
resp.request_id #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:aws_account_id (required, String) —
The ID of the Amazon Web Services account that contains the agents.
:filters (required, Array<Types::AgentSearchFilter>) —
The filters to apply when searching agents.
:max_results (Integer) —
The maximum number of results to return.
:next_token (String) —
The token for the next set of results, or null if there are no more results.

Returns:

(Types::SearchAgentsResponse) —
Returns a response object which responds to the following methods:
- #agent_summaries => Array<Types::AgentSummary>
- #next_token => String
- #request_id => String

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 18438

def search_agents(params = {}, options = {})
  req = build_request(:search_agents, params)
  req.send_request(options)
end

#search_analyses(params = {}) ⇒ `Types::SearchAnalysesResponse`

Searches for analyses that belong to the user specified in the filter.

This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.search_analyses({
  aws_account_id: "AwsAccountId", # required
  filters: [ # required
    {
      operator: "StringEquals", # accepts StringEquals, StringLike
      name: "QUICKSIGHT_USER", # accepts QUICKSIGHT_USER, QUICKSIGHT_VIEWER_OR_OWNER, DIRECT_QUICKSIGHT_VIEWER_OR_OWNER, QUICKSIGHT_OWNER, DIRECT_QUICKSIGHT_OWNER, DIRECT_QUICKSIGHT_SOLE_OWNER, ANALYSIS_NAME
      value: "String",
    },
  ],
  next_token: "String",
  max_results: 1,
})

Response structure


resp.analysis_summary_list #=> Array
resp.analysis_summary_list[0].arn #=> String
resp.analysis_summary_list[0].analysis_id #=> String
resp.analysis_summary_list[0].name #=> String
resp.analysis_summary_list[0].status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED", "DELETED"
resp.analysis_summary_list[0].created_time #=> Time
resp.analysis_summary_list[0].last_updated_time #=> Time
resp.next_token #=> String
resp.status #=> Integer
resp.request_id #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:aws_account_id (required, String) —
The ID of the Amazon Web Services account that contains the analyses that you're searching for.
:filters (required, Array<Types::AnalysisSearchFilter>) —
The structure for the search filters that you want to apply to your search.
:next_token (String) —
A pagination token that can be used in a subsequent request.
:max_results (Integer) —
The maximum number of results to return.

Returns:

(Types::SearchAnalysesResponse) —
Returns a response object which responds to the following methods:
- #analysis_summary_list => Array<Types::AnalysisSummary>
- #next_token => String
- #status => Integer
- #request_id => String

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 18505

def search_analyses(params = {}, options = {})
  req = build_request(:search_analyses, params)
  req.send_request(options)
end

#search_dashboards(params = {}) ⇒ `Types::SearchDashboardsResponse`

Searches for dashboards that belong to a user.

This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.search_dashboards({
  aws_account_id: "AwsAccountId", # required
  filters: [ # required
    {
      operator: "StringEquals", # required, accepts StringEquals, StringLike
      name: "QUICKSIGHT_USER", # accepts QUICKSIGHT_USER, QUICKSIGHT_VIEWER_OR_OWNER, DIRECT_QUICKSIGHT_VIEWER_OR_OWNER, QUICKSIGHT_OWNER, DIRECT_QUICKSIGHT_OWNER, DIRECT_QUICKSIGHT_SOLE_OWNER, DASHBOARD_NAME
      value: "String",
    },
  ],
  next_token: "String",
  max_results: 1,
})

Response structure


resp.dashboard_summary_list #=> Array
resp.dashboard_summary_list[0].arn #=> String
resp.dashboard_summary_list[0].dashboard_id #=> String
resp.dashboard_summary_list[0].name #=> String
resp.dashboard_summary_list[0].created_time #=> Time
resp.dashboard_summary_list[0].last_updated_time #=> Time
resp.dashboard_summary_list[0].published_version_number #=> Integer
resp.dashboard_summary_list[0].last_published_time #=> Time
resp.next_token #=> String
resp.status #=> Integer
resp.request_id #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:aws_account_id (required, String) —
The ID of the Amazon Web Services account that contains the user whose dashboards you're searching for.
:filters (required, Array<Types::DashboardSearchFilter>) —
The filters to apply to the search. Currently, you can search only by user name, for example, "Filters": [ { "Name": "QUICKSIGHT_USER", "Operator": "StringEquals", "Value": "arn:aws:quicksight:us-east-1:1:user/default/UserName1" } ]
:next_token (String) —
The token for the next set of results, or null if there are no more results.
:max_results (Integer) —
The maximum number of results to be returned per request.

Returns:

(Types::SearchDashboardsResponse) —
Returns a response object which responds to the following methods:
- #dashboard_summary_list => Array<Types::DashboardSummary>
- #next_token => String
- #status => Integer
- #request_id => String

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 18576

def search_dashboards(params = {}, options = {})
  req = build_request(:search_dashboards, params)
  req.send_request(options)
end

#search_data_sets(params = {}) ⇒ `Types::SearchDataSetsResponse`

Use the SearchDataSets operation to search for datasets that belong to an account.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.search_data_sets({
  aws_account_id: "AwsAccountId", # required
  filters: [ # required
    {
      operator: "StringEquals", # required, accepts StringEquals, StringLike
      name: "QUICKSIGHT_VIEWER_OR_OWNER", # required, accepts QUICKSIGHT_VIEWER_OR_OWNER, QUICKSIGHT_OWNER, DIRECT_QUICKSIGHT_VIEWER_OR_OWNER, DIRECT_QUICKSIGHT_OWNER, DIRECT_QUICKSIGHT_SOLE_OWNER, DATASET_NAME
      value: "String", # required
    },
  ],
  next_token: "String",
  max_results: 1,
})

Response structure


resp.data_set_summaries #=> Array
resp.data_set_summaries[0].arn #=> String
resp.data_set_summaries[0].data_set_id #=> String
resp.data_set_summaries[0].name #=> String
resp.data_set_summaries[0].created_time #=> Time
resp.data_set_summaries[0].last_updated_time #=> Time
resp.data_set_summaries[0].import_mode #=> String, one of "SPICE", "DIRECT_QUERY"
resp.data_set_summaries[0].row_level_permission_data_set.namespace #=> String
resp.data_set_summaries[0].row_level_permission_data_set.arn #=> String
resp.data_set_summaries[0].row_level_permission_data_set.permission_policy #=> String, one of "GRANT_ACCESS", "DENY_ACCESS"
resp.data_set_summaries[0].row_level_permission_data_set.format_version #=> String, one of "VERSION_1", "VERSION_2"
resp.data_set_summaries[0].row_level_permission_data_set.status #=> String, one of "ENABLED", "DISABLED"
resp.data_set_summaries[0].row_level_permission_data_set_map #=> Hash
resp.data_set_summaries[0].row_level_permission_data_set_map["DataSetEntityResourceId"].namespace #=> String
resp.data_set_summaries[0].row_level_permission_data_set_map["DataSetEntityResourceId"].arn #=> String
resp.data_set_summaries[0].row_level_permission_data_set_map["DataSetEntityResourceId"].permission_policy #=> String, one of "GRANT_ACCESS", "DENY_ACCESS"
resp.data_set_summaries[0].row_level_permission_data_set_map["DataSetEntityResourceId"].format_version #=> String, one of "VERSION_1", "VERSION_2"
resp.data_set_summaries[0].row_level_permission_data_set_map["DataSetEntityResourceId"].status #=> String, one of "ENABLED", "DISABLED"
resp.data_set_summaries[0].row_level_permission_tag_configuration_applied #=> Boolean
resp.data_set_summaries[0].column_level_permission_rules_applied #=> Boolean
resp.data_set_summaries[0].use_as #=> String, one of "RLS_RULES"
resp.next_token #=> String
resp.status #=> Integer
resp.request_id #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:aws_account_id (required, String) —
The Amazon Web Services account ID.
:filters (required, Array<Types::DataSetSearchFilter>) —
The filters to apply to the search.
:next_token (String) —
A pagination token that can be used in a subsequent request.
:max_results (Integer) —
The maximum number of results to be returned per request.

Returns:

(Types::SearchDataSetsResponse) —
Returns a response object which responds to the following methods:
- #data_set_summaries => Array<Types::DataSetSummary>
- #next_token => String
- #status => Integer
- #request_id => String

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 18651

def search_data_sets(params = {}, options = {})
  req = build_request(:search_data_sets, params)
  req.send_request(options)
end

#search_data_sources(params = {}) ⇒ `Types::SearchDataSourcesResponse`

Use the SearchDataSources operation to search for data sources that belong to an account.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.search_data_sources({
  aws_account_id: "AwsAccountId", # required
  filters: [ # required
    {
      operator: "StringEquals", # required, accepts StringEquals, StringLike
      name: "DIRECT_QUICKSIGHT_VIEWER_OR_OWNER", # required, accepts DIRECT_QUICKSIGHT_VIEWER_OR_OWNER, DIRECT_QUICKSIGHT_OWNER, DIRECT_QUICKSIGHT_SOLE_OWNER, DATASOURCE_NAME
      value: "String", # required
    },
  ],
  next_token: "String",
  max_results: 1,
})

Response structure


resp.data_source_summaries #=> Array
resp.data_source_summaries[0].arn #=> String
resp.data_source_summaries[0].data_source_id #=> String
resp.data_source_summaries[0].name #=> String
resp.data_source_summaries[0].type #=> String, one of "ADOBE_ANALYTICS", "AMAZON_ELASTICSEARCH", "ATHENA", "AURORA", "AURORA_POSTGRESQL", "AWS_IOT_ANALYTICS", "GITHUB", "JIRA", "MARIADB", "MYSQL", "ORACLE", "POSTGRESQL", "PRESTO", "REDSHIFT", "S3", "S3_TABLES", "SALESFORCE", "SERVICENOW", "SNOWFLAKE", "SPARK", "SQLSERVER", "TERADATA", "TWITTER", "TIMESTREAM", "AMAZON_OPENSEARCH", "EXASOL", "DATABRICKS", "STARBURST", "TRINO", "BIGQUERY", "GOOGLESHEETS", "GOOGLE_DRIVE", "CONFLUENCE", "SHAREPOINT", "ONE_DRIVE", "WEB_CRAWLER", "S3_KNOWLEDGE_BASE", "QBUSINESS"
resp.data_source_summaries[0].created_time #=> Time
resp.data_source_summaries[0].last_updated_time #=> Time
resp.next_token #=> String
resp.status #=> Integer
resp.request_id #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:aws_account_id (required, String) —
The Amazon Web Services account ID.
:filters (required, Array<Types::DataSourceSearchFilter>) —
The filters to apply to the search.
:next_token (String) —
A pagination token that can be used in a subsequent request.
:max_results (Integer) —
The maximum number of results to be returned per request.

Returns:

(Types::SearchDataSourcesResponse) —
Returns a response object which responds to the following methods:
- #data_source_summaries => Array<Types::DataSourceSummary>
- #next_token => String
- #status => Integer
- #request_id => String

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 18712

def search_data_sources(params = {}, options = {})
  req = build_request(:search_data_sources, params)
  req.send_request(options)
end

#search_flows(params = {}) ⇒ `Types::SearchFlowsOutput`

Search for the flows in an Amazon Web Services account.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.search_flows({
  aws_account_id: "AccountId", # required
  filters: [ # required
    {
      name: "assetName", # required, accepts assetName, assetDescription, DIRECT_QUICKSIGHT_OWNER, DIRECT_QUICKSIGHT_VIEWER_OR_OWNER, DIRECT_QUICKSIGHT_SOLE_OWNER
      operator: "StringEquals", # required, accepts StringEquals, StringLike
      value: "String", # required
    },
  ],
  next_token: "String",
  max_results: 1,
})

Response structure


resp.flow_summary_list #=> Array
resp.flow_summary_list[0].arn #=> String
resp.flow_summary_list[0].flow_id #=> String
resp.flow_summary_list[0].name #=> String
resp.flow_summary_list[0].description #=> String
resp.flow_summary_list[0].created_time #=> Time
resp.flow_summary_list[0].created_by #=> String
resp.flow_summary_list[0].last_updated_time #=> Time
resp.flow_summary_list[0].last_updated_by #=> String
resp.flow_summary_list[0].publish_state #=> String, one of "PUBLISHED", "DRAFT", "PENDING_APPROVAL"
resp.flow_summary_list[0].run_count #=> Integer
resp.flow_summary_list[0].user_count #=> Integer
resp.flow_summary_list[0].last_published_by #=> String
resp.flow_summary_list[0].last_published_at #=> Time
resp.next_token #=> String
resp.request_id #=> String
resp.status #=> Integer

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:aws_account_id (required, String) —
The ID of the Amazon Web Services account where you are searching for flows from.
:filters (required, Array<Types::SearchFlowsFilter>) —
The filters applied to the search when searching for flows in the Amazon Web Services account.
:next_token (String) —
The token to request the next set of results, or null if you want to retrieve the first set.
:max_results (Integer) —
The maximum number of results to be returned per request.

Returns:

(Types::SearchFlowsOutput) —
Returns a response object which responds to the following methods:
- #flow_summary_list => Array<Types::FlowSummary>
- #next_token => String
- #request_id => String
- #status => Integer

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 18782

def search_flows(params = {}, options = {})
  req = build_request(:search_flows, params)
  req.send_request(options)
end

#search_folders(params = {}) ⇒ `Types::SearchFoldersResponse`

Searches the subfolders in a folder.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.search_folders({
  aws_account_id: "AwsAccountId", # required
  filters: [ # required
    {
      operator: "StringEquals", # accepts StringEquals, StringLike
      name: "PARENT_FOLDER_ARN", # accepts PARENT_FOLDER_ARN, DIRECT_QUICKSIGHT_OWNER, DIRECT_QUICKSIGHT_SOLE_OWNER, DIRECT_QUICKSIGHT_VIEWER_OR_OWNER, QUICKSIGHT_OWNER, QUICKSIGHT_VIEWER_OR_OWNER, FOLDER_NAME
      value: "String",
    },
  ],
  next_token: "String",
  max_results: 1,
})

Response structure


resp.status #=> Integer
resp.folder_summary_list #=> Array
resp.folder_summary_list[0].arn #=> String
resp.folder_summary_list[0].folder_id #=> String
resp.folder_summary_list[0].name #=> String
resp.folder_summary_list[0].folder_type #=> String, one of "SHARED", "RESTRICTED"
resp.folder_summary_list[0].created_time #=> Time
resp.folder_summary_list[0].last_updated_time #=> Time
resp.folder_summary_list[0].sharing_model #=> String, one of "ACCOUNT", "NAMESPACE"
resp.next_token #=> String
resp.request_id #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:aws_account_id (required, String) —
The ID for the Amazon Web Services account that contains the folder.
:filters (required, Array<Types::FolderSearchFilter>) —
The filters to apply to the search. Currently, you can search only by the parent folder ARN. For example, "Filters": [ { "Name": "PARENT_FOLDER_ARN", "Operator": "StringEquals", "Value": "arn:aws:quicksight:us-east-1:1:folder/folderId" } ].
:next_token (String) —
The token for the next set of results, or null if there are no more results.
:max_results (Integer) —
The maximum number of results to be returned per request.

Returns:

(Types::SearchFoldersResponse) —
Returns a response object which responds to the following methods:
- #status => Integer
- #folder_summary_list => Array<Types::FolderSummary>
- #next_token => String
- #request_id => String

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 18847

def search_folders(params = {}, options = {})
  req = build_request(:search_folders, params)
  req.send_request(options)
end

#search_groups(params = {}) ⇒ `Types::SearchGroupsResponse`

Use the SearchGroups operation to search groups in a specified Quick Sight namespace using the supplied filters.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.search_groups({
  aws_account_id: "AwsAccountId", # required
  next_token: "String",
  max_results: 1,
  namespace: "Namespace", # required
  filters: [ # required
    {
      operator: "StartsWith", # required, accepts StartsWith
      name: "GROUP_NAME", # required, accepts GROUP_NAME
      value: "String", # required
    },
  ],
})

Response structure


resp.group_list #=> Array
resp.group_list[0].arn #=> String
resp.group_list[0].group_name #=> String
resp.group_list[0].description #=> String
resp.group_list[0].principal_id #=> String
resp.next_token #=> String
resp.request_id #=> String
resp.status #=> Integer

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:aws_account_id (required, String) —
The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon Quick Sight account.
:next_token (String) —
A pagination token that can be used in a subsequent request.
:max_results (Integer) —
The maximum number of results to return from this request.
:namespace (required, String) —
The namespace that you want to search.
:filters (required, Array<Types::GroupSearchFilter>) —
The structure for the search filters that you want to apply to your search.

Returns:

(Types::SearchGroupsResponse) —
Returns a response object which responds to the following methods:
- #group_list => Array<Types::Group>
- #next_token => String
- #request_id => String
- #status => Integer

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 18913

def search_groups(params = {}, options = {})
  req = build_request(:search_groups, params)
  req.send_request(options)
end

#search_knowledge_bases(params = {}) ⇒ `Types::SearchKnowledgeBasesResponse`

Searches for a subset of knowledge bases based on specified filters.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.search_knowledge_bases({
  aws_account_id: "KbAwsAccountId", # required
  next_token: "NextToken",
  max_results: 1,
  filters: [
    {
      name: "KNOWLEDGE_BASE_ID", # required, accepts KNOWLEDGE_BASE_ID, KNOWLEDGE_BASE_NAME, DIRECT_QUICKSIGHT_OWNER, DIRECT_QUICKSIGHT_VIEWER_OR_OWNER, DIRECT_QUICKSIGHT_SOLE_OWNER, KNOWLEDGE_BASE_SIZE_BYTES, PRIMARY_OWNER, DATASOURCE_ARN
      operator: "STRING_EQUALS", # required, accepts STRING_EQUALS, STRING_LIKE, GREATER_THAN_OR_EQUALS, LESS_THAN_OR_EQUALS
      value: "String", # required
    },
  ],
  sort_by: {
    sort_by_field: "KNOWLEDGE_BASE_SIZE_BYTES", # required, accepts KNOWLEDGE_BASE_SIZE_BYTES, CREATED_AT
    sort_order: "ASC", # required, accepts ASC, DESC
  },
})

Response structure


resp.knowledge_base_summaries #=> Array
resp.knowledge_base_summaries[0].knowledge_base_arn #=> String
resp.knowledge_base_summaries[0].knowledge_base_id #=> String
resp.knowledge_base_summaries[0].name #=> String
resp.knowledge_base_summaries[0].status #=> String, one of "CREATING", "UPDATING", "ACTIVE", "FAILED", "DELETING"
resp.knowledge_base_summaries[0].data_source_arn #=> String
resp.knowledge_base_summaries[0].type #=> String
resp.knowledge_base_summaries[0].created_at #=> Time
resp.knowledge_base_summaries[0].updated_at #=> Time
resp.knowledge_base_summaries[0].knowledge_base_size_bytes #=> Integer
resp.knowledge_base_summaries[0].document_count #=> Integer
resp.knowledge_base_summaries[0].primary_owner_arn #=> String
resp.knowledge_base_summaries[0].primary_owner_username #=> String
resp.next_token #=> String
resp.request_id #=> String
resp.status #=> Integer

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:aws_account_id (required, String) —
The ID of the Amazon Web Services account that contains the knowledge base.
:next_token (String) —
The token for the next set of results, or null if there are no more results.
:max_results (Integer) —
The maximum number of results to return.
:filters (Array<Types::KnowledgeBaseSearchFilter>) —
The filters to apply when searching knowledge bases.
:sort_by (Types::KnowledgeBaseSortBy) —
The sort configuration for the search results.

Returns:

(Types::SearchKnowledgeBasesResponse) —
Returns a response object which responds to the following methods:
- #knowledge_base_summaries => Array<Types::KnowledgeBaseSummary>
- #next_token => String
- #request_id => String
- #status => Integer

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 18988

def search_knowledge_bases(params = {}, options = {})
  req = build_request(:search_knowledge_bases, params)
  req.send_request(options)
end

#search_spaces(params = {}) ⇒ `Types::SearchSpacesResponse`

Searches for Amazon QuickSight spaces that match the specified filters.

Examples:

Request syntax with placeholder values


resp = client.search_spaces({
  aws_account_id: "AwsAccountId", # required
  next_token: "NextToken",
  max_results: 1,
  filters: [ # required
    {
      name: "SPACE_ID", # required, accepts SPACE_ID, SPACE_NAME, DIRECT_QUICKSIGHT_OWNER, DIRECT_QUICKSIGHT_VIEWER_OR_OWNER, DIRECT_QUICKSIGHT_SOLE_OWNER, CONTRIBUTED_BY, CONSUMED_SOURCE_SIZE, CREATED_BY
      operator: "STRING_EQUALS", # required, accepts STRING_EQUALS, STRING_LIKE, NUMBER_RANGE
      value: "String", # required
    },
  ],
})

Response structure


resp.space_id #=> String
resp.space_arn #=> String
resp.space_summaries #=> Array
resp.space_summaries[0].space_id #=> String
resp.space_summaries[0].space_arn #=> String
resp.space_summaries[0].name #=> String
resp.space_summaries[0].description #=> String
resp.space_summaries[0].updated_at #=> Time
resp.space_summaries[0].consumed_source_size #=> Integer
resp.space_summaries[0].consumed_source_doc_count #=> Integer
resp.space_summaries[0].created_at #=> Time
resp.space_summaries[0].created_by #=> String
resp.space_summaries[0].created_by_arn #=> String
resp.space_summaries[0].resources_count #=> Integer
resp.next_token #=> String
resp.request_id #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:aws_account_id (required, String) —
The ID of the Amazon Web Services account that contains the spaces.
:next_token (String) —
The token for the next set of results, or null if there are no more results.
:max_results (Integer) —
The maximum number of results to return.
:filters (required, Array<Types::SpaceQuicksightSearchFilter>) —
The filters to apply to the search.

Returns:

(Types::SearchSpacesResponse) —
Returns a response object which responds to the following methods:
- #space_id => String
- #space_arn => String
- #space_summaries => Array<Types::SpaceSummary>
- #next_token => String
- #request_id => String

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 19055

def search_spaces(params = {}, options = {})
  req = build_request(:search_spaces, params)
  req.send_request(options)
end

#search_topics(params = {}) ⇒ `Types::SearchTopicsResponse`

Searches for any Q topic that exists in an Quick account.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.search_topics({
  aws_account_id: "AwsAccountId", # required
  filters: [ # required
    {
      operator: "StringEquals", # required, accepts StringEquals, StringLike
      name: "QUICKSIGHT_USER", # required, accepts QUICKSIGHT_USER, QUICKSIGHT_VIEWER_OR_OWNER, DIRECT_QUICKSIGHT_VIEWER_OR_OWNER, QUICKSIGHT_OWNER, DIRECT_QUICKSIGHT_OWNER, DIRECT_QUICKSIGHT_SOLE_OWNER, TOPIC_NAME
      value: "SensitiveString", # required
    },
  ],
  next_token: "String",
  max_results: 1,
})

Response structure


resp.topic_summary_list #=> Array
resp.topic_summary_list[0].arn #=> String
resp.topic_summary_list[0].topic_id #=> String
resp.topic_summary_list[0].name #=> String
resp.topic_summary_list[0].user_experience_version #=> String, one of "LEGACY", "NEW_READER_EXPERIENCE"
resp.next_token #=> String
resp.status #=> Integer
resp.request_id #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:aws_account_id (required, String) —
The ID of the Amazon Web Services account that contains the topic that you want to find.
:filters (required, Array<Types::TopicSearchFilter>) —
The filters that you want to use to search for the topic.
:next_token (String) —
The token for the next set of results, or null if there are no more results.
:max_results (Integer) —
The maximum number of results to be returned per request.

Returns:

(Types::SearchTopicsResponse) —
Returns a response object which responds to the following methods:
- #topic_summary_list => Array<Types::TopicSummary>
- #next_token => String
- #status => Integer
- #request_id => String

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 19115

def search_topics(params = {}, options = {})
  req = build_request(:search_topics, params)
  req.send_request(options)
end

#search_topics_v2(params = {}) ⇒ `Types::SearchTopicsV2Response`

Searches for any Q topic that exists in an Amazon Web Services account.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.search_topics_v2({
  aws_account_id: "AwsAccountId", # required
  filters: [ # required
    {
      operator: "StringEquals", # required, accepts StringEquals, StringLike
      name: "QUICKSIGHT_USER", # required, accepts QUICKSIGHT_USER, QUICKSIGHT_VIEWER_OR_OWNER, DIRECT_QUICKSIGHT_VIEWER_OR_OWNER, QUICKSIGHT_OWNER, DIRECT_QUICKSIGHT_OWNER, DIRECT_QUICKSIGHT_SOLE_OWNER, TOPIC_NAME
      value: "SensitiveString", # required
    },
  ],
  next_token: "String",
  max_results: 1,
})

Response structure


resp.topic_summary_list #=> Array
resp.topic_summary_list[0].arn #=> String
resp.topic_summary_list[0].topic_id #=> String
resp.topic_summary_list[0].name #=> String
resp.next_token #=> String
resp.status #=> Integer
resp.request_id #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:aws_account_id (required, String) —
The ID of the Amazon Web Services account that contains the topic that you want to search.
:filters (required, Array<Types::TopicSearchFilter>) —
The filters that you want to use to search for the topic.
:next_token (String) —
The token for the next set of results, or null if there are no more results.
:max_results (Integer) —
The maximum number of results to be returned per request.

Returns:

(Types::SearchTopicsV2Response) —
Returns a response object which responds to the following methods:
- #topic_summary_list => Array<Types::TopicV2Summary>
- #next_token => String
- #status => Integer
- #request_id => String

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 19175

def search_topics_v2(params = {}, options = {})
  req = build_request(:search_topics_v2, params)
  req.send_request(options)
end

#start_asset_bundle_export_job(params = {}) ⇒ `Types::StartAssetBundleExportJobResponse`

Starts an Asset Bundle export job.

An Asset Bundle export job exports specified Amazon Quick Sight assets. You can also choose to export any asset dependencies in the same job. Export jobs run asynchronously and can be polled with a DescribeAssetBundleExportJob API call. When a job is successfully completed, a download URL that contains the exported assets is returned. The URL is valid for 5 minutes and can be refreshed with a DescribeAssetBundleExportJob API call. Each Amazon Quick Sight account can run up to 5 export jobs concurrently.

The API caller must have the necessary permissions in their IAM role to access each resource before the resources can be exported.

Examples:

Request syntax with placeholder values


resp = client.start_asset_bundle_export_job({
  aws_account_id: "AwsAccountId", # required
  asset_bundle_export_job_id: "ShortRestrictiveResourceId", # required
  resource_arns: ["Arn"], # required
  include_all_dependencies: false,
  export_format: "CLOUDFORMATION_JSON", # required, accepts CLOUDFORMATION_JSON, QUICKSIGHT_JSON
  cloud_formation_override_property_configuration: {
    resource_id_override_configuration: {
      prefix_for_all_resources: false,
    },
    vpc_connections: [
      {
        arn: "Arn", # required
        properties: ["Name"], # required, accepts Name, DnsResolvers, RoleArn
      },
    ],
    refresh_schedules: [
      {
        arn: "Arn", # required
        properties: ["StartAfterDateTime"], # required, accepts StartAfterDateTime
      },
    ],
    data_sources: [
      {
        arn: "Arn", # required
        properties: ["Name"], # required, accepts Name, DisableSsl, SecretArn, Username, Password, Domain, WorkGroup, Host, Port, Database, DataSetName, Catalog, InstanceId, ClusterId, ManifestFileLocation, Warehouse, RoleArn, ProductType
      },
    ],
    data_sets: [
      {
        arn: "Arn", # required
        properties: ["Name"], # required, accepts Name, RefreshFailureEmailAlertStatus
      },
    ],
    themes: [
      {
        arn: "Arn", # required
        properties: ["Name"], # required, accepts Name
      },
    ],
    analyses: [
      {
        arn: "Arn", # required
        properties: ["Name"], # required, accepts Name
      },
    ],
    dashboards: [
      {
        arn: "Arn", # required
        properties: ["Name"], # required, accepts Name
      },
    ],
    folders: [
      {
        arn: "Arn", # required
        properties: ["Name"], # required, accepts Name, ParentFolderArn
      },
    ],
    topics_v2: [
      {
        arn: "Arn", # required
        properties: ["Name"], # required, accepts Name, Description
      },
    ],
  },
  include_permissions: false,
  include_tags: false,
  validation_strategy: {
    strict_mode_for_all_resources: false,
  },
  include_folder_memberships: false,
  include_folder_members: "RECURSE", # accepts RECURSE, ONE_LEVEL, NONE
})

Response structure


resp.arn #=> String
resp.asset_bundle_export_job_id #=> String
resp.request_id #=> String
resp.status #=> Integer

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:aws_account_id (required, String) —
The ID of the Amazon Web Services account to export assets from.
:asset_bundle_export_job_id (required, String) —
The ID of the job. This ID is unique while the job is running. After the job is completed, you can reuse this ID for another job.
:resource_arns (required, Array<String>) —
An array of resource ARNs to export. The following resources are supported.
- Analysis
- Dashboard
- DataSet
- DataSource
- RefreshSchedule
- Theme
- VPCConnection
The API caller must have the necessary permissions in their IAM role to access each resource before the resources can be exported.
:include_all_dependencies (Boolean) —
A Boolean that determines whether all dependencies of each resource ARN are recursively exported with the job. For example, say you provided a Dashboard ARN to the ResourceArns parameter. If you set IncludeAllDependencies to TRUE, any theme, dataset, and data source resource that is a dependency of the dashboard is also exported.
:export_format (required, String) —
The export data format.
:cloud_formation_override_property_configuration (Types::AssetBundleCloudFormationOverridePropertyConfiguration) —
An optional collection of structures that generate CloudFormation parameters to override the existing resource property values when the resource is exported to a new CloudFormation template.

Use this field if the ExportFormat field of a StartAssetBundleExportJobRequest API call is set to CLOUDFORMATION_JSON.
:include_permissions (Boolean) —
A Boolean that determines whether all permissions for each resource ARN are exported with the job. If you set IncludePermissions to TRUE, any permissions associated with each resource are exported.
:include_tags (Boolean) —
A Boolean that determines whether all tags for each resource ARN are exported with the job. If you set IncludeTags to TRUE, any tags associated with each resource are exported.
:validation_strategy (Types::AssetBundleExportJobValidationStrategy) —
An optional parameter that determines which validation strategy to use for the export job. If StrictModeForAllResources is set to TRUE, strict validation for every error is enforced. If it is set to FALSE, validation is skipped for specific UI errors that are shown as warnings. The default value for StrictModeForAllResources is FALSE.
:include_folder_memberships (Boolean) —
A Boolean that determines if the exported asset carries over information about the folders that the asset is a member of.
:include_folder_members (String) —
A setting that indicates whether you want to include folder assets. You can also use this setting to recusrsively include all subfolders of an exported folder.

Returns:

(Types::StartAssetBundleExportJobResponse) —
Returns a response object which responds to the following methods:
- #arn => String
- #asset_bundle_export_job_id => String
- #request_id => String
- #status => Integer

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 19363

def start_asset_bundle_export_job(params = {}, options = {})
  req = build_request(:start_asset_bundle_export_job, params)
  req.send_request(options)
end

#start_asset_bundle_import_job(params = {}) ⇒ `Types::StartAssetBundleImportJobResponse`

Starts an Asset Bundle import job.

An Asset Bundle import job imports specified Amazon Quick Sight assets into an Amazon Quick Sight account. You can also choose to import a naming prefix and specified configuration overrides. The assets that are contained in the bundle file that you provide are used to create or update a new or existing asset in your Amazon Quick Sight account. Each Amazon Quick Sight account can run up to 5 import jobs concurrently.

The API caller must have the necessary "create", "describe", and "update" permissions in their IAM role to access each resource type that is contained in the bundle file before the resources can be imported.

Examples:

Request syntax with placeholder values


resp = client.start_asset_bundle_import_job({
  aws_account_id: "AwsAccountId", # required
  asset_bundle_import_job_id: "ShortRestrictiveResourceId", # required
  asset_bundle_import_source: { # required
    body: "data",
    s3_uri: "S3Uri",
  },
  override_parameters: {
    resource_id_override_configuration: {
      prefix_for_all_resources: "String",
    },
    vpc_connections: [
      {
        vpc_connection_id: "VPCConnectionResourceIdUnrestricted", # required
        name: "ResourceName",
        subnet_ids: ["SubnetId"],
        security_group_ids: ["SecurityGroupId"],
        dns_resolvers: ["IPv4Address"],
        role_arn: "RoleArn",
      },
    ],
    refresh_schedules: [
      {
        data_set_id: "ResourceId", # required
        schedule_id: "String", # required
        start_after_date_time: Time.now,
      },
    ],
    data_sources: [
      {
        data_source_id: "ResourceId", # required
        name: "ResourceName",
        data_source_parameters: {
          amazon_elasticsearch_parameters: {
            domain: "Domain", # required
          },
          athena_parameters: {
            work_group: "WorkGroup",
            role_arn: "RoleArn",
            consumer_account_role_arn: "RoleArn",
            identity_center_configuration: {
              enable_identity_propagation: false,
            },
          },
          aurora_parameters: {
            host: "Host", # required
            port: 1, # required
            database: "Database", # required
          },
          aurora_postgre_sql_parameters: {
            host: "Host", # required
            port: 1, # required
            database: "Database", # required
          },
          aws_iot_analytics_parameters: {
            data_set_name: "DataSetName", # required
          },
          jira_parameters: {
            site_base_url: "SiteBaseUrl", # required
          },
          maria_db_parameters: {
            host: "Host", # required
            port: 1, # required
            database: "Database", # required
          },
          my_sql_parameters: {
            host: "Host", # required
            port: 1, # required
            database: "Database", # required
          },
          oracle_parameters: {
            host: "Host", # required
            port: 1, # required
            database: "Database", # required
            use_service_name: false,
          },
          postgre_sql_parameters: {
            host: "Host", # required
            port: 1, # required
            database: "Database", # required
          },
          presto_parameters: {
            host: "Host", # required
            port: 1, # required
            catalog: "Catalog", # required
          },
          rds_parameters: {
            instance_id: "InstanceId", # required
            database: "Database", # required
          },
          redshift_parameters: {
            host: "Host",
            port: 1,
            database: "Database", # required
            cluster_id: "ClusterId",
            iam_parameters: {
              role_arn: "RoleArn", # required
              database_user: "DatabaseUser",
              database_groups: ["DatabaseGroup"],
              auto_create_database_user: false,
            },
            identity_center_configuration: {
              enable_identity_propagation: false,
            },
          },
          s3_parameters: {
            manifest_file_location: { # required
              bucket: "S3Bucket", # required
              key: "S3Key", # required
            },
            role_arn: "RoleArn",
          },
          s3_tables_parameters: {
            table_bucket_arn: "S3TableBucketArn",
          },
          s3_knowledge_base_parameters: {
            role_arn: "RoleArn",
            bucket_url: "S3Bucket", # required
            metadata_files_location: "MetadataFilesLocation",
          },
          service_now_parameters: {
            site_base_url: "SiteBaseUrl", # required
          },
          snowflake_parameters: {
            host: "Host", # required
            database: "Database", # required
            warehouse: "Warehouse", # required
            authentication_type: "PASSWORD", # accepts PASSWORD, KEYPAIR, TOKEN, X509
            database_access_control_role: "DatabaseAccessControlRole",
            o_auth_parameters: {
              token_provider_url: "TokenProviderUrl", # required
              o_auth_scope: "OAuthScope",
              identity_provider_vpc_connection_properties: {
                vpc_connection_arn: "Arn", # required
              },
              identity_provider_resource_uri: "IdentityProviderResourceUri",
              identity_provider_ca_certificates_bundle_s3_uri: "CACertificatesBundleS3Uri",
            },
          },
          spark_parameters: {
            host: "Host", # required
            port: 1, # required
          },
          sql_server_parameters: {
            host: "Host", # required
            port: 1, # required
            database: "Database", # required
          },
          teradata_parameters: {
            host: "Host", # required
            port: 1, # required
            database: "Database", # required
          },
          twitter_parameters: {
            query: "Query", # required
            max_rows: 1, # required
          },
          amazon_open_search_parameters: {
            domain: "Domain", # required
          },
          exasol_parameters: {
            host: "Host", # required
            port: 1, # required
          },
          databricks_parameters: {
            host: "Host", # required
            port: 1, # required
            sql_endpoint_path: "SqlEndpointPath", # required
          },
          starburst_parameters: {
            host: "Host", # required
            port: 1, # required
            catalog: "Catalog", # required
            product_type: "GALAXY", # accepts GALAXY, ENTERPRISE
            database_access_control_role: "DatabaseAccessControlRole",
            authentication_type: "PASSWORD", # accepts PASSWORD, KEYPAIR, TOKEN, X509
            o_auth_parameters: {
              token_provider_url: "TokenProviderUrl", # required
              o_auth_scope: "OAuthScope",
              identity_provider_vpc_connection_properties: {
                vpc_connection_arn: "Arn", # required
              },
              identity_provider_resource_uri: "IdentityProviderResourceUri",
              identity_provider_ca_certificates_bundle_s3_uri: "CACertificatesBundleS3Uri",
            },
          },
          trino_parameters: {
            host: "Host", # required
            port: 1, # required
            catalog: "Catalog", # required
          },
          big_query_parameters: {
            project_id: "ProjectId", # required
            data_set_region: "DataSetRegion",
          },
          impala_parameters: {
            host: "Host", # required
            port: 1, # required
            database: "Database",
            sql_endpoint_path: "SqlEndpointPath", # required
          },
          custom_connection_parameters: {
            connection_type: "String",
          },
          web_crawler_parameters: {
            web_crawler_auth_type: "NO_AUTH", # required, accepts NO_AUTH, BASIC_AUTH, FORM, SAML
            username_field_xpath: "XpathFields",
            password_field_xpath: "XpathFields",
            username_button_xpath: "XpathFields",
            password_button_xpath: "XpathFields",
            login_page_url: "SiteBaseUrl",
            web_proxy_host_name: "Host",
            web_proxy_port_number: 1,
          },
          confluence_parameters: {
            confluence_url: "SiteBaseUrl", # required
          },
          q_business_parameters: {
            application_arn: "ApplicationArn", # required
          },
          share_point_parameters: {
            share_point_domain: "SharePointDomain", # required
            tenant_id: "SharePointTenantId",
            client_id: "SharePointClientId",
            auth_type: "THREE_LEGGED_OAUTH", # accepts THREE_LEGGED_OAUTH, TWO_LEGGED_OAUTH, SERVICE_ACCOUNT
          },
          google_drive_parameters: {
            auth_type: "THREE_LEGGED_OAUTH", # accepts THREE_LEGGED_OAUTH, TWO_LEGGED_OAUTH, SERVICE_ACCOUNT
          },
          one_drive_parameters: {
            tenant_id: "OneDriveTenantId",
            client_id: "OneDriveClientId",
            auth_type: "THREE_LEGGED_OAUTH", # accepts THREE_LEGGED_OAUTH, TWO_LEGGED_OAUTH, SERVICE_ACCOUNT
          },
          fmkb_parameters: {
            knowledge_base_arn: "FMKBKnowledgeBaseArn", # required
            linked_data_source_ids: ["LinkedDataSourceId"],
          },
        },
        vpc_connection_properties: {
          vpc_connection_arn: "Arn", # required
        },
        ssl_properties: {
          disable_ssl: false,
        },
        credentials: {
          credential_pair: {
            username: "DbUsername", # required
            password: "Password", # required
          },
          secret_arn: "SecretArn",
        },
      },
    ],
    data_sets: [
      {
        data_set_id: "ResourceId", # required
        name: "ResourceName",
        data_set_refresh_properties: {
          refresh_configuration: {
            incremental_refresh: { # required
              lookback_window: { # required
                column_name: "String", # required
                size: 1, # required
                size_unit: "HOUR", # required, accepts HOUR, DAY, WEEK
              },
            },
          },
          failure_configuration: {
            email_alert: {
              alert_status: "ENABLED", # accepts ENABLED, DISABLED
            },
          },
        },
      },
    ],
    themes: [
      {
        theme_id: "ResourceId", # required
        name: "ResourceName",
      },
    ],
    analyses: [
      {
        analysis_id: "ResourceId", # required
        name: "ResourceName",
      },
    ],
    dashboards: [
      {
        dashboard_id: "ResourceId", # required
        name: "ResourceName",
      },
    ],
    folders: [
      {
        folder_id: "ResourceId", # required
        name: "ResourceName",
        parent_folder_arn: "Arn",
      },
    ],
    topics_v2: [
      {
        topic_id: "ResourceId", # required
        name: "ResourceName",
        description: "TopicDescription",
      },
    ],
  },
  failure_action: "DO_NOTHING", # accepts DO_NOTHING, ROLLBACK
  override_permissions: {
    data_sources: [
      {
        data_source_ids: ["AssetBundleRestrictiveResourceId"], # required
        permissions: { # required
          principals: ["Principal"], # required
          actions: ["String"], # required
        },
      },
    ],
    data_sets: [
      {
        data_set_ids: ["AssetBundleRestrictiveResourceId"], # required
        permissions: { # required
          principals: ["Principal"], # required
          actions: ["String"], # required
        },
      },
    ],
    themes: [
      {
        theme_ids: ["AssetBundleRestrictiveResourceId"], # required
        permissions: { # required
          principals: ["Principal"], # required
          actions: ["String"], # required
        },
      },
    ],
    analyses: [
      {
        analysis_ids: ["AssetBundleRestrictiveResourceId"], # required
        permissions: { # required
          principals: ["Principal"], # required
          actions: ["String"], # required
        },
      },
    ],
    dashboards: [
      {
        dashboard_ids: ["AssetBundleRestrictiveResourceId"], # required
        permissions: {
          principals: ["Principal"], # required
          actions: ["String"], # required
        },
        link_sharing_configuration: {
          permissions: {
            principals: ["Principal"], # required
            actions: ["String"], # required
          },
        },
      },
    ],
    folders: [
      {
        folder_ids: ["AssetBundleRestrictiveResourceId"], # required
        permissions: {
          principals: ["Principal"], # required
          actions: ["String"], # required
        },
      },
    ],
    topics_v2: [
      {
        topic_ids: ["AssetBundleRestrictiveResourceId"], # required
        permissions: { # required
          principals: ["Principal"], # required
          actions: ["String"], # required
        },
      },
    ],
  },
  override_tags: {
    vpc_connections: [
      {
        vpc_connection_ids: ["AssetBundleRestrictiveResourceId"], # required
        tags: [ # required
          {
            key: "TagKey", # required
            value: "TagValue", # required
          },
        ],
      },
    ],
    data_sources: [
      {
        data_source_ids: ["AssetBundleRestrictiveResourceId"], # required
        tags: [ # required
          {
            key: "TagKey", # required
            value: "TagValue", # required
          },
        ],
      },
    ],
    data_sets: [
      {
        data_set_ids: ["AssetBundleRestrictiveResourceId"], # required
        tags: [ # required
          {
            key: "TagKey", # required
            value: "TagValue", # required
          },
        ],
      },
    ],
    themes: [
      {
        theme_ids: ["AssetBundleRestrictiveResourceId"], # required
        tags: [ # required
          {
            key: "TagKey", # required
            value: "TagValue", # required
          },
        ],
      },
    ],
    analyses: [
      {
        analysis_ids: ["AssetBundleRestrictiveResourceId"], # required
        tags: [ # required
          {
            key: "TagKey", # required
            value: "TagValue", # required
          },
        ],
      },
    ],
    dashboards: [
      {
        dashboard_ids: ["AssetBundleRestrictiveResourceId"], # required
        tags: [ # required
          {
            key: "TagKey", # required
            value: "TagValue", # required
          },
        ],
      },
    ],
    folders: [
      {
        folder_ids: ["AssetBundleRestrictiveResourceId"], # required
        tags: [ # required
          {
            key: "TagKey", # required
            value: "TagValue", # required
          },
        ],
      },
    ],
    topics_v2: [
      {
        topic_ids: ["AssetBundleRestrictiveResourceId"], # required
        tags: [ # required
          {
            key: "TagKey", # required
            value: "TagValue", # required
          },
        ],
      },
    ],
  },
  override_validation_strategy: {
    strict_mode_for_all_resources: false,
  },
})

Response structure


resp.arn #=> String
resp.asset_bundle_import_job_id #=> String
resp.request_id #=> String
resp.status #=> Integer

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:aws_account_id (required, String) —
The ID of the Amazon Web Services account to import assets into.
:asset_bundle_import_job_id (required, String) —
The ID of the job. This ID is unique while the job is running. After the job is completed, you can reuse this ID for another job.
:asset_bundle_import_source (required, Types::AssetBundleImportSource) —
The source of the asset bundle zip file that contains the data that you want to import. The file must be in QUICKSIGHT_JSON format.
:override_parameters (Types::AssetBundleImportJobOverrideParameters) —
Optional overrides that are applied to the resource configuration before import.
:failure_action (String) —
The failure action for the import job.

If you choose ROLLBACK, failed import jobs will attempt to undo any asset changes caused by the failed job.

If you choose DO_NOTHING, failed import jobs will not attempt to roll back any asset changes caused by the failed job, possibly keeping the Amazon Quick Sight account in an inconsistent state.
:override_permissions (Types::AssetBundleImportJobOverridePermissions) —
Optional permission overrides that are applied to the resource configuration before import.
:override_tags (Types::AssetBundleImportJobOverrideTags) —
Optional tag overrides that are applied to the resource configuration before import.
:override_validation_strategy (Types::AssetBundleImportJobOverrideValidationStrategy) —
An optional validation strategy override for all analyses and dashboards that is applied to the resource configuration before import.

Returns:

(Types::StartAssetBundleImportJobResponse) —
Returns a response object which responds to the following methods:
- #arn => String
- #asset_bundle_import_job_id => String
- #request_id => String
- #status => Integer

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 19917

def start_asset_bundle_import_job(params = {}, options = {})
  req = build_request(:start_asset_bundle_import_job, params)
  req.send_request(options)
end

#start_automation_job(params = {}) ⇒ `Types::StartAutomationJobResponse`

Starts a new job for a specified automation. The job runs the automation with the provided input payload.

Examples:

Request syntax with placeholder values


resp = client.start_automation_job({
  aws_account_id: "AwsAccountId", # required
  automation_group_id: "AutomateId", # required
  automation_id: "AutomateId", # required
  input_payload: "SensitiveIOPayload",
})

Response structure


resp.arn #=> String
resp.job_id #=> String
resp.status #=> Integer
resp.request_id #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:aws_account_id (required, String) —
The ID of the Amazon Web Services account that contains the automation.
:automation_group_id (required, String) —
The ID of the automation group that contains the automation to run.
:automation_id (required, String) —
The ID of the automation to run.
:input_payload (String) —
The input payload for the automation job, provided as a JSON string.

Returns:

(Types::StartAutomationJobResponse) —
Returns a response object which responds to the following methods:
- #arn => String
- #job_id => String
- #status => Integer
- #request_id => String

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 19965

def start_automation_job(params = {}, options = {})
  req = build_request(:start_automation_job, params)
  req.send_request(options)
end

#start_dashboard_snapshot_job(params = {}) ⇒ `Types::StartDashboardSnapshotJobResponse`

Starts an asynchronous job that generates a snapshot of a dashboard's output. You can request one or several of the following format configurations in each API call.

1 PDF
1 Excel workbook that includes up to 5 table or pivot table visuals
5 CSVs from table or pivot table visuals

Exporting CSV, Excel, or Pixel Perfect PDF reports requires Pixel Perfect Report Add-on.

The status of a submitted job can be polled with the DescribeDashboardSnapshotJob API. When you call the DescribeDashboardSnapshotJob API, check the JobStatus field in the response. Once the job reaches a COMPLETED or FAILED status, use the DescribeDashboardSnapshotJobResult API to obtain the URLs for the generated files. If the job fails, the DescribeDashboardSnapshotJobResult API returns detailed information about the error that occurred.

StartDashboardSnapshotJob API throttling

Quick Sight utilizes API throttling to create a more consistent user experience within a time span for customers when they call the StartDashboardSnapshotJob. By default, 12 jobs can run simlutaneously in one Amazon Web Services account and users can submit up 10 API requests per second before an account is throttled. If an overwhelming number of API requests are made by the same user in a short period of time, Quick Sight throttles the API calls to maintin an optimal experience and reliability for all Quick Sight users.

Common throttling scenarios

The following list provides information about the most commin throttling scenarios that can occur.

A large number of SnapshotExport API jobs are running simultaneously on an Amazon Web Services account. When a new StartDashboardSnapshotJob is created and there are already 12 jobs with the RUNNING status, the new job request fails and returns a LimitExceededException error. Wait for a current job to comlpete before you resubmit the new job.
A large number of API requests are submitted on an Amazon Web Services account. When a user makes more than 10 API calls to the Quick Sight API in one second, a ThrottlingException is returned.

If your use case requires a higher throttling limit, contact your account admin or Amazon Web ServicesSupport to explore options to tailor a more optimal expereince for your account.

Best practices to handle throttling

If your use case projects high levels of API traffic, try to reduce the degree of frequency and parallelism of API calls as much as you can to avoid throttling. You can also perform a timing test to calculate an estimate for the total processing time of your projected load that stays within the throttling limits of the Quick Sight APIs. For example, if your projected traffic is 100 snapshot jobs before 12:00 PM per day, start 12 jobs in parallel and measure the amount of time it takes to proccess all 12 jobs. Once you obtain the result, multiply the duration by 9, for example (12 minutes * 9 = 108 minutes). Use the new result to determine the latest time at which the jobs need to be started to meet your target deadline.

The time that it takes to process a job can be impacted by the following factors:

The dataset type (Direct Query or SPICE).
The size of the dataset.
The complexity of the calculated fields that are used in the dashboard.
The number of visuals that are on a sheet.
The types of visuals that are on the sheet.
The number of formats and snapshots that are requested in the job configuration.
The size of the generated snapshots.

Registered user support

You can generate snapshots for registered Quick Sight users by using the Snapshot Job APIs with identity-enhanced IAM role session credentials. This approach allows you to create snapshots on behalf of specific Quick Sight users while respecting their row-level security (RLS), column-level security (CLS), dynamic default parameters and dashboard parameter/filter settings.

To generate snapshots for registered Quick Sight users, you need to:

Obtain identity-enhanced IAM role session credentials from Amazon Web Services Security Token Service (STS).
Use these credentials to call the Snapshot Job APIs.

Identity-enhanced credentials are credentials that contain information about the end user (e.g., registered Quick Sight user).

If your Quick Sight users are backed by Amazon Web Services Identity Center, then you need to set up a trusted token issuer. Then, getting identity-enhanced IAM credentials for a Quick Sight user will look like the following:

Authenticate user with your OIDC compliant Identity Provider. You should get auth tokens back.
Use the OIDC API, CreateTokenWithIAM, to exchange auth tokens to IAM tokens. One of the resulted tokens will be identity token.
Call STS AssumeRole API as you normally would, but provide an extra ProvidedContexts parameter in the API request. The list of contexts must have a single trusted context assertion. The ProviderArn should be arn:aws:iam::aws:contextProvider/IdentityCenter while ContextAssertion will be the identity token you received in response from CreateTokenWithIAM

For more details, see IdC documentation on Identity-enhanced IAM role sessions.

To obtain Identity-enhanced credentials for Quick Sight native users, IAM federated users, or Active Directory users, follow the steps below:

Call Quick Sight GetIdentityContext API to get identity token.
Call STS AssumeRole API as you normally would, but provide extra ProvidedContexts parameter in the API request. The list of contexts must have a single trusted context assertion. The ProviderArn should be arn:aws:iam::aws:contextProvider/QuickSight while ContextAssertion will be the identity token you received in response from GetIdentityContext

After obtaining the identity-enhanced IAM role session credentials, you can use them to start a job, describe the job and describe job result. You can use the same credentials as long as they haven't expired. All API requests made with these credentials are considered to be made by the impersonated Quick Sight user.

When using identity-enhanced session credentials, set the UserConfiguration request attribute to null. Otherwise, the request will be invalid.

Possible error scenarios

The request fails with an Access Denied error in the following scenarios:

The credentials have expired.
The impersonated Quick Sight user doesn't have access to the specified dashboard.
The impersonated Quick Sight user is restricted from exporting data in the selected formats. For more information about export restrictions, see Customizing access to Amazon Quick Sight capabilities.

Examples:

Request syntax with placeholder values


resp = client.start_dashboard_snapshot_job({
  aws_account_id: "AwsAccountId", # required
  dashboard_id: "ShortRestrictiveResourceId", # required
  snapshot_job_id: "ShortRestrictiveResourceId", # required
  user_configuration: {
    anonymous_users: [
      {
        row_level_permission_tags: [
          {
            key: "SessionTagKey", # required
            value: "SessionTagValue", # required
          },
        ],
      },
    ],
  },
  snapshot_configuration: { # required
    file_groups: [ # required
      {
        files: [
          {
            sheet_selections: [ # required
              {
                sheet_id: "ShortRestrictiveResourceId", # required
                selection_scope: "ALL_VISUALS", # required, accepts ALL_VISUALS, SELECTED_VISUALS
                visual_ids: ["ShortRestrictiveResourceId"],
              },
            ],
            format_type: "CSV", # required, accepts CSV, PDF, EXCEL
          },
        ],
      },
    ],
    destination_configuration: {
      s3_destinations: [
        {
          bucket_configuration: { # required
            bucket_name: "NonEmptyString", # required
            bucket_prefix: "NonEmptyString", # required
            bucket_region: "NonEmptyString", # required
          },
        },
      ],
    },
    parameters: {
      string_parameters: [
        {
          name: "NonEmptyString", # required
          values: ["SensitiveString"], # required
        },
      ],
      integer_parameters: [
        {
          name: "NonEmptyString", # required
          values: [1], # required
        },
      ],
      decimal_parameters: [
        {
          name: "NonEmptyString", # required
          values: [1.0], # required
        },
      ],
      date_time_parameters: [
        {
          name: "NonEmptyString", # required
          values: [Time.now], # required
        },
      ],
    },
  },
})

Response structure


resp.arn #=> String
resp.snapshot_job_id #=> String
resp.request_id #=> String
resp.status #=> Integer

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:aws_account_id (required, String) —
The ID of the Amazon Web Services account that the dashboard snapshot job is executed in.
:dashboard_id (required, String) —
The ID of the dashboard that you want to start a snapshot job for.
:snapshot_job_id (required, String) —
An ID for the dashboard snapshot job. This ID is unique to the dashboard while the job is running. This ID can be used to poll the status of a job with a DescribeDashboardSnapshotJob while the job runs. You can reuse this ID for another job 24 hours after the current job is completed.
:user_configuration (Types::SnapshotUserConfiguration) —
A structure that contains information about the users that the dashboard snapshot is generated for. The users can be either anonymous users or registered users. Anonymous users cannot be used together with registered users.

When using identity-enhanced session credentials, set the UserConfiguration request attribute to null. Otherwise, the request will be invalid.
:snapshot_configuration (required, Types::SnapshotConfiguration) —
A structure that describes the configuration of the dashboard snapshot.

Returns:

(Types::StartDashboardSnapshotJobResponse) —
Returns a response object which responds to the following methods:
- #arn => String
- #snapshot_job_id => String
- #request_id => String
- #status => Integer

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 20269

def start_dashboard_snapshot_job(params = {}, options = {})
  req = build_request(:start_dashboard_snapshot_job, params)
  req.send_request(options)
end

#start_dashboard_snapshot_job_schedule(params = {}) ⇒ `Types::StartDashboardSnapshotJobScheduleResponse`

Starts an asynchronous job that runs an existing dashboard schedule and sends the dashboard snapshot through email.

Only one job can run simultaneously in a given schedule. Repeated requests are skipped with a 202 HTTP status code.

For more information, see Scheduling and sending Amazon Quick Sight reports by email and Configuring email report settings for a Amazon Quick Sight dashboard in the Amazon Quick Sight User Guide.

Examples:

Request syntax with placeholder values


resp = client.start_dashboard_snapshot_job_schedule({
  aws_account_id: "AwsAccountId", # required
  dashboard_id: "ShortRestrictiveResourceId", # required
  schedule_id: "ShortRestrictiveResourceId", # required
})

Response structure


resp.request_id #=> String
resp.status #=> Integer

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:aws_account_id (required, String) —
The ID of the Amazon Web Services account that the dashboard snapshot job is executed in.
:dashboard_id (required, String) —
The ID of the dashboard that you want to start a snapshot job schedule for.
:schedule_id (required, String) —
The ID of the schedule that you want to start a snapshot job schedule for. The schedule ID can be found in the Amazon Quick Sight console in the Schedules pane of the dashboard that the schedule is configured for.

Returns:

(Types::StartDashboardSnapshotJobScheduleResponse) —
Returns a response object which responds to the following methods:
- #request_id => String
- #status => Integer

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 20326

def start_dashboard_snapshot_job_schedule(params = {}, options = {})
  req = build_request(:start_dashboard_snapshot_job_schedule, params)
  req.send_request(options)
end

#tag_resource(params = {}) ⇒ `Types::TagResourceResponse`

Assigns one or more tags (key-value pairs) to the specified Amazon Quick Sight resource.

Tags can help you organize and categorize your resources. You can also use them to scope user permissions, by granting a user permission to access or change only resources with certain tag values. You can use the TagResource operation with a resource that already has tags. If you specify a new tag key for the resource, this tag is appended to the list of tags associated with the resource. If you specify a tag key that is already associated with the resource, the new tag value that you specify replaces the previous value for that tag.

You can associate as many as 50 tags with a resource. Amazon Quick Sight supports tagging on data set, data source, dashboard, template, topic, and user.

Tagging for Amazon Quick Sight works in a similar way to tagging for other Amazon Web Services services, except for the following:

Tags are used to track costs for users in Amazon Quick Sight. You can't tag other resources that Amazon Quick Sight costs are based on, such as storage capacoty (SPICE), session usage, alert consumption, or reporting units.
Amazon Quick Sight doesn't currently support the tag editor for Resource Groups.

Examples:

Request syntax with placeholder values


resp = client.tag_resource({
  resource_arn: "Arn", # required
  tags: [ # required
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
})

Response structure


resp.request_id #=> String
resp.status #=> Integer

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:resource_arn (required, String) —
The Amazon Resource Name (ARN) of the resource that you want to tag.
:tags (required, Array<Types::Tag>) —
Contains a map of the key-value pairs for the resource tag or tags assigned to the resource.

Returns:

(Types::TagResourceResponse) —
Returns a response object which responds to the following methods:
- #request_id => String
- #status => Integer

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 20391

def tag_resource(params = {}, options = {})
  req = build_request(:tag_resource, params)
  req.send_request(options)
end

#untag_resource(params = {}) ⇒ `Types::UntagResourceResponse`

Removes a tag or tags from a resource.

Examples:

Request syntax with placeholder values


resp = client.untag_resource({
  resource_arn: "Arn", # required
  tag_keys: ["TagKey"], # required
})

Response structure


resp.request_id #=> String
resp.status #=> Integer

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:resource_arn (required, String) —
The Amazon Resource Name (ARN) of the resource that you want to untag.
:tag_keys (required, Array<String>) —
The keys of the key-value pairs for the resource tag or tags assigned to the resource.

Returns:

(Types::UntagResourceResponse) —
Returns a response object which responds to the following methods:
- #request_id => String
- #status => Integer

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 20426

def untag_resource(params = {}, options = {})
  req = build_request(:untag_resource, params)
  req.send_request(options)
end

#update_account_custom_permission(params = {}) ⇒ `Types::UpdateAccountCustomPermissionResponse`

Applies a custom permissions profile to an account.

Examples:

Request syntax with placeholder values


resp = client.update_account_custom_permission({
  custom_permissions_name: "CustomPermissionsName", # required
  aws_account_id: "AwsAccountId", # required
})

Response structure


resp.request_id #=> String
resp.status #=> Integer

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:custom_permissions_name (required, String) —
The name of the custom permissions profile that you want to apply to an account.
:aws_account_id (required, String) —
The ID of the Amazon Web Services account for which you want to apply a custom permissions profile.

Returns:

(Types::UpdateAccountCustomPermissionResponse) —
Returns a response object which responds to the following methods:
- #request_id => String
- #status => Integer

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 20462

def update_account_custom_permission(params = {}, options = {})
  req = build_request(:update_account_custom_permission, params)
  req.send_request(options)
end

#update_account_customization(params = {}) ⇒ `Types::UpdateAccountCustomizationResponse`

Updates Amazon Quick Sight customizations. Currently, the only customization that you can use is a theme.

You can use customizations for your Amazon Web Services account or, if you specify a namespace, for a Quick Sight namespace instead. Customizations that apply to a namespace override customizations that apply to an Amazon Web Services account. To find out which customizations apply, use the DescribeAccountCustomization API operation.

Examples:

Request syntax with placeholder values


resp = client.update_account_customization({
  aws_account_id: "AwsAccountId", # required
  namespace: "Namespace",
  account_customization: { # required
    default_theme: "Arn",
    default_email_customization_template: "Arn",
  },
})

Response structure


resp.arn #=> String
resp.aws_account_id #=> String
resp.namespace #=> String
resp.account_customization.default_theme #=> String
resp.account_customization.default_email_customization_template #=> String
resp.request_id #=> String
resp.status #=> Integer

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:aws_account_id (required, String) —
The ID for the Amazon Web Services account that you want to update Quick Sight customizations for.
:namespace (String) —
The namespace that you want to update Quick Sight customizations for.
:account_customization (required, Types::AccountCustomization) —
The Quick Sight customizations you're updating.

Returns:

(Types::UpdateAccountCustomizationResponse) —
Returns a response object which responds to the following methods:
- #arn => String
- #aws_account_id => String
- #namespace => String
- #account_customization => Types::AccountCustomization
- #request_id => String
- #status => Integer

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 20521

def update_account_customization(params = {}, options = {})
  req = build_request(:update_account_customization, params)
  req.send_request(options)
end

#update_account_settings(params = {}) ⇒ `Types::UpdateAccountSettingsResponse`

Updates the Amazon Quick Sight settings in your Amazon Web Services account.

Examples:

Request syntax with placeholder values


resp = client.update_account_settings({
  aws_account_id: "AwsAccountId", # required
  default_namespace: "Namespace", # required
  notification_email: "String",
  termination_protection_enabled: false,
})

Response structure


resp.request_id #=> String
resp.status #=> Integer

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:aws_account_id (required, String) —
The ID for the Amazon Web Services account that contains the Quick Sight settings that you want to list.
:default_namespace (required, String) —
The default namespace for this Amazon Web Services account. Currently, the default is default. IAM users that register for the first time with Amazon Quick Sight provide an email address that becomes associated with the default namespace.
:notification_email (String) —
The email address that you want Quick Sight to send notifications to regarding your Amazon Web Services account or Quick Sight subscription.
:termination_protection_enabled (Boolean) —
A boolean value that determines whether or not an Quick Sight account can be deleted. A True value doesn't allow the account to be deleted and results in an error message if a user tries to make a DeleteAccountSubscription request. A False value will allow the account to be deleted.

Returns:

(Types::UpdateAccountSettingsResponse) —
Returns a response object which responds to the following methods:
- #request_id => String
- #status => Integer

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 20574

def update_account_settings(params = {}, options = {})
  req = build_request(:update_account_settings, params)
  req.send_request(options)
end

#update_action_connector(params = {}) ⇒ `Types::UpdateActionConnectorResponse`

Updates an existing action connector with new configuration details, authentication settings, or enabled actions. You can modify the connector's name, description, authentication configuration, and which actions are enabled. For more information, https://docs.aws.amazon.com/quicksuite/latest/userguide/quick-action-auth.html.

Examples:

Request syntax with placeholder values


resp = client.update_action_connector({
  aws_account_id: "AwsAccountId", # required
  action_connector_id: "ShortRestrictiveResourceId", # required
  name: "ActionConnectorName", # required
  authentication_config: { # required
    authentication_type: "BASIC", # required, accepts BASIC, API_KEY, OAUTH2_CLIENT_CREDENTIALS, NONE, IAM, OAUTH2_AUTHORIZATION_CODE
    authentication_metadata: { # required
      authorization_code_grant_metadata: {
        base_endpoint: "Endpoint", # required
        redirect_url: "Endpoint", # required
        authorization_code_grant_credentials_source: "PLAIN_CREDENTIALS", # accepts PLAIN_CREDENTIALS
        authorization_code_grant_credentials_details: {
          authorization_code_grant_details: {
            client_id: "ClientId", # required
            client_secret: "ClientSecret", # required
            token_endpoint: "Endpoint", # required
            authorization_endpoint: "Endpoint", # required
          },
        },
      },
      client_credentials_grant_metadata: {
        base_endpoint: "Endpoint", # required
        client_credentials_source: "PLAIN_CREDENTIALS", # accepts PLAIN_CREDENTIALS
        client_credentials_details: {
          client_credentials_grant_details: {
            client_id: "ClientId", # required
            client_secret: "ClientSecret", # required
            token_endpoint: "Endpoint", # required
          },
        },
      },
      basic_auth_connection_metadata: {
        base_endpoint: "Endpoint", # required
        username: "ActionUserName", # required
        password: "ActionPassword", # required
      },
      api_key_connection_metadata: {
        base_endpoint: "Endpoint", # required
        api_key: "APIKey", # required
        email: "Email",
      },
      none_connection_metadata: {
        base_endpoint: "Endpoint", # required
      },
      iam_connection_metadata: {
        role_arn: "RoleArn", # required
      },
    },
  },
  description: "ActionConnectorDescription",
  vpc_connection_arn: "Arn",
})

Response structure


resp.arn #=> String
resp.action_connector_id #=> String
resp.request_id #=> String
resp.update_status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED", "DELETED"
resp.status #=> Integer

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:aws_account_id (required, String) —
The Amazon Web Services account ID that contains the action connector to update.
:action_connector_id (required, String) —
The unique identifier of the action connector to update.
:name (required, String) —
The new name for the action connector.
:authentication_config (required, Types::AuthConfig) —
The updated authentication configuration for connecting to the external service.
:description (String) —
The updated description of the action connector.
:vpc_connection_arn (String) —
The updated ARN of the VPC connection to use for secure connectivity.

Returns:

(Types::UpdateActionConnectorResponse) —
Returns a response object which responds to the following methods:
- #arn => String
- #action_connector_id => String
- #request_id => String
- #update_status => String
- #status => Integer

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 20684

def update_action_connector(params = {}, options = {})
  req = build_request(:update_action_connector, params)
  req.send_request(options)
end

#update_action_connector_permissions(params = {}) ⇒ `Types::UpdateActionConnectorPermissionsResponse`

Updates the permissions for an action connector by granting or revoking access for specific users and groups. You can control who can view, use, or manage the action connector.

Examples:

Request syntax with placeholder values


resp = client.update_action_connector_permissions({
  aws_account_id: "AwsAccountId", # required
  action_connector_id: "ShortRestrictiveResourceId", # required
  grant_permissions: [
    {
      principal: "Principal", # required
      actions: ["String"], # required
    },
  ],
  revoke_permissions: [
    {
      principal: "Principal", # required
      actions: ["String"], # required
    },
  ],
})

Response structure


resp.arn #=> String
resp.action_connector_id #=> String
resp.request_id #=> String
resp.status #=> Integer
resp.permissions #=> Array
resp.permissions[0].principal #=> String
resp.permissions[0].actions #=> Array
resp.permissions[0].actions[0] #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:aws_account_id (required, String) —
The Amazon Web Services account ID that contains the action connector.
:action_connector_id (required, String) —
The unique identifier of the action connector whose permissions you want to update.
:grant_permissions (Array<Types::ResourcePermission>) —
The permissions to grant to users and groups for this action connector.
:revoke_permissions (Array<Types::ResourcePermission>) —
The permissions to revoke from users and groups for this action connector.

Returns:

(Types::UpdateActionConnectorPermissionsResponse) —
Returns a response object which responds to the following methods:
- #arn => String
- #action_connector_id => String
- #request_id => String
- #status => Integer
- #permissions => Array<Types::ResourcePermission>

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 20750

def update_action_connector_permissions(params = {}, options = {})
  req = build_request(:update_action_connector_permissions, params)
  req.send_request(options)
end

#update_agent(params = {}) ⇒ `Types::UpdateAgentResponse`

Updates an existing agent.

Examples:

Request syntax with placeholder values


resp = client.update_agent({
  agent_id: "AgentId", # required
  aws_account_id: "AwsAccountId", # required
  name: "AgentName", # required
  description: "AgentDescription",
  icon_id: "IconId",
  starter_prompts: ["StarterPrompt"],
  welcome_message: "WelcomeMessage",
  custom_prompt_input: {
    existing_prompt: {
      model_profile_id: "ModelProfileId", # required
      subscription_id: "SubscriptionId", # required
      qbs_aws_account_id: "QbsAwsAccountId", # required
    },
    new_prompt: {
      response_length: "StyleDescription",
      output_style: "StyleDescription",
      identity: "StyleDescription",
      tone: "StyleDescription",
      custom_instructions: "StyleDescription",
    },
  },
  spaces_to_add: ["Arn"],
  spaces_to_remove: ["Arn"],
  action_connectors_to_add: ["Arn"],
  action_connectors_to_remove: ["Arn"],
})

Response structure


resp.arn #=> String
resp.agent_id #=> String
resp.agent_status #=> String, one of "ACTIVE", "UPDATING", "FAILED", "CREATING"
resp.failed_to_add_spaces #=> Array
resp.failed_to_add_spaces[0].arn #=> String
resp.failed_to_add_spaces[0].error_message #=> String
resp.failed_to_add_spaces[0].error_code #=> String
resp.failed_to_remove_spaces #=> Array
resp.failed_to_remove_spaces[0].arn #=> String
resp.failed_to_remove_spaces[0].error_message #=> String
resp.failed_to_remove_spaces[0].error_code #=> String
resp.failed_to_add_action_connectors #=> Array
resp.failed_to_add_action_connectors[0].arn #=> String
resp.failed_to_add_action_connectors[0].error_message #=> String
resp.failed_to_add_action_connectors[0].error_code #=> String
resp.failed_to_remove_action_connectors #=> Array
resp.failed_to_remove_action_connectors[0].arn #=> String
resp.failed_to_remove_action_connectors[0].error_message #=> String
resp.failed_to_remove_action_connectors[0].error_code #=> String
resp.request_id #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:agent_id (required, String) —
The unique identifier for the agent to update.
:aws_account_id (required, String) —
The ID of the Amazon Web Services account that contains the agent.
:name (required, String) —
The name of the agent.
:description (String) —
A description of the agent.
:icon_id (String) —
The icon identifier for the agent.
:starter_prompts (Array<String>) —
A list of starter prompts that are displayed to users when they begin interacting with the agent.
:welcome_message (String) —
The welcome message that is displayed when a user starts a conversation with the agent.
:custom_prompt_input (Types::CustomPromptInput) —
The custom prompt configuration for the agent.
:spaces_to_add (Array<String>) —
The Amazon Resource Names (ARNs) of the spaces to attach to the agent.
:spaces_to_remove (Array<String>) —
The Amazon Resource Names (ARNs) of the spaces to detach from the agent.
:action_connectors_to_add (Array<String>) —
The Amazon Resource Names (ARNs) of the action connectors to attach to the agent.
:action_connectors_to_remove (Array<String>) —
The Amazon Resource Names (ARNs) of the action connectors to detach from the agent.

Returns:

(Types::UpdateAgentResponse) —
Returns a response object which responds to the following methods:
- #arn => String
- #agent_id => String
- #agent_status => String
- #failed_to_add_spaces => Array<Types::FailedToUpdateAssociation>
- #failed_to_remove_spaces => Array<Types::FailedToUpdateAssociation>
- #failed_to_add_action_connectors => Array<Types::FailedToUpdateAssociation>
- #failed_to_remove_action_connectors => Array<Types::FailedToUpdateAssociation>
- #request_id => String

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 20866

def update_agent(params = {}, options = {})
  req = build_request(:update_agent, params)
  req.send_request(options)
end

#update_agent_permissions(params = {}) ⇒ `Types::UpdateAgentPermissionsResponse`

Updates the resource permissions for an agent.

Examples:

Request syntax with placeholder values


resp = client.update_agent_permissions({
  agent_id: "AgentId", # required
  aws_account_id: "AwsAccountId", # required
  grant_permissions: [
    {
      principal: "Principal", # required
      actions: ["String"], # required
    },
  ],
  revoke_permissions: [
    {
      principal: "Principal", # required
      actions: ["String"], # required
    },
  ],
})

Response structure


resp.arn #=> String
resp.agent_id #=> String
resp.request_id #=> String
resp.permissions #=> Array
resp.permissions[0].principal #=> String
resp.permissions[0].actions #=> Array
resp.permissions[0].actions[0] #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:agent_id (required, String) —
The unique identifier for the agent.
:aws_account_id (required, String) —
The ID of the Amazon Web Services account that contains the agent.
:grant_permissions (Array<Types::ResourcePermission>) —
The resource permissions that you want to grant on the agent.
:revoke_permissions (Array<Types::ResourcePermission>) —
The resource permissions that you want to revoke from the agent.

Returns:

(Types::UpdateAgentPermissionsResponse) —
Returns a response object which responds to the following methods:
- #arn => String
- #agent_id => String
- #request_id => String
- #permissions => Array<Types::ResourcePermission>

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 20925

def update_agent_permissions(params = {}, options = {})
  req = build_request(:update_agent_permissions, params)
  req.send_request(options)
end

#update_analysis(params = {}) ⇒ `Types::UpdateAnalysisResponse`

Updates an analysis in Amazon Quick Sight

Examples:

Response structure


resp.arn #=> String
resp.analysis_id #=> String
resp.update_status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED", "DELETED"
resp.status #=> Integer
resp.request_id #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:aws_account_id (required, String) —
The ID of the Amazon Web Services account that contains the analysis that you're updating.
:analysis_id (required, String) —
The ID for the analysis that you're updating. This ID displays in the URL of the analysis.
:name (required, String) —
A descriptive name for the analysis that you're updating. This name displays for the analysis in the Amazon Quick Sight console.
:parameters (Types::Parameters) —
The parameter names and override values that you want to use. An analysis can have any parameter type, and some parameters might accept multiple values.
:source_entity (Types::AnalysisSourceEntity) —
A source entity to use for the analysis that you're updating. This metadata structure contains details that describe a source template and one or more datasets or topics.
:theme_arn (String) —
The Amazon Resource Name (ARN) for the theme to apply to the analysis that you're creating. To see the theme in the Amazon Quick Sight console, make sure that you have access to it.
:definition (Types::AnalysisDefinition) —
The definition of an analysis.

A definition is the data model of all features in a Dashboard, Template, or Analysis.
:validation_strategy (Types::ValidationStrategy) —
The option to relax the validation needed to update an analysis with definition objects. This skips the validation step for specific errors.

Returns:

(Types::UpdateAnalysisResponse) —
Returns a response object which responds to the following methods:
- #arn => String
- #analysis_id => String
- #update_status => String
- #status => Integer
- #request_id => String

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 20990

def update_analysis(params = {}, options = {})
  req = build_request(:update_analysis, params)
  req.send_request(options)
end

#update_analysis_permissions(params = {}) ⇒ `Types::UpdateAnalysisPermissionsResponse`

Updates the read and write permissions for an analysis.

Examples:

Request syntax with placeholder values


resp = client.update_analysis_permissions({
  aws_account_id: "AwsAccountId", # required
  analysis_id: "ShortRestrictiveResourceId", # required
  grant_permissions: [
    {
      principal: "Principal", # required
      actions: ["String"], # required
    },
  ],
  revoke_permissions: [
    {
      principal: "Principal", # required
      actions: ["String"], # required
    },
  ],
})

Response structure


resp.analysis_arn #=> String
resp.analysis_id #=> String
resp.permissions #=> Array
resp.permissions[0].principal #=> String
resp.permissions[0].actions #=> Array
resp.permissions[0].actions[0] #=> String
resp.request_id #=> String
resp.status #=> Integer

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:aws_account_id (required, String) —
The ID of the Amazon Web Services account that contains the analysis whose permissions you're updating. You must be using the Amazon Web Services account that the analysis is in.
:analysis_id (required, String) —
The ID of the analysis whose permissions you're updating. The ID is part of the analysis URL.
:grant_permissions (Array<Types::ResourcePermission>) —
A structure that describes the permissions to add and the principal to add them to.
:revoke_permissions (Array<Types::ResourcePermission>) —
A structure that describes the permissions to remove and the principal to remove them from.

Returns:

(Types::UpdateAnalysisPermissionsResponse) —
Returns a response object which responds to the following methods:
- #analysis_arn => String
- #analysis_id => String
- #permissions => Array<Types::ResourcePermission>
- #request_id => String
- #status => Integer

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 21056

def update_analysis_permissions(params = {}, options = {})
  req = build_request(:update_analysis_permissions, params)
  req.send_request(options)
end

#update_application_with_token_exchange_grant(params = {}) ⇒ `Types::UpdateApplicationWithTokenExchangeGrantResponse`

Updates an Quick application with a token exchange grant. This operation only supports Quick applications that are registered with IAM Identity Center.

Examples:

Request syntax with placeholder values


resp = client.update_application_with_token_exchange_grant({
  aws_account_id: "AwsAccountId", # required
  namespace: "Namespace", # required
})

Response structure


resp.status #=> Integer
resp.request_id #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:aws_account_id (required, String) —
The ID of the Amazon Web Services account to be updated with a token exchange grant.
:namespace (required, String) —
The namespace of the Quick application.

Returns:

(Types::UpdateApplicationWithTokenExchangeGrantResponse) —
Returns a response object which responds to the following methods:
- #status => Integer
- #request_id => String

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 21093

def update_application_with_token_exchange_grant(params = {}, options = {})
  req = build_request(:update_application_with_token_exchange_grant, params)
  req.send_request(options)
end

#update_approval_policy(params = {}) ⇒ `Types::UpdateApprovalPolicyResponse`

Updates an approval policy in Quick Sight.

Examples:

Request syntax with placeholder values


resp = client.update_approval_policy({
  policy_id: "PolicyId", # required
  name: "PolicyName",
  description: "PolicyDescription",
  actions: ["SHARE"], # accepts SHARE
  asset_types: ["AGENT"], # accepts AGENT, SPACE, KNOWLEDGE_BASE
  applicable_to: {
    type: "GROUP", # required, accepts GROUP
    group_arns: ["Arn"],
  },
  approval_groups: ["Arn"],
})

Response structure


resp.policy.policy_id #=> String
resp.policy.policy_arn #=> String
resp.policy.name #=> String
resp.policy.description #=> String
resp.policy.actions #=> Array
resp.policy.actions[0] #=> String, one of "SHARE"
resp.policy.asset_types #=> Array
resp.policy.asset_types[0] #=> String, one of "AGENT", "SPACE", "KNOWLEDGE_BASE"
resp.policy.applicable_to.type #=> String, one of "GROUP"
resp.policy.applicable_to.group_arns #=> Array
resp.policy.applicable_to.group_arns[0] #=> String
resp.policy.approval_groups #=> Array
resp.policy.approval_groups[0] #=> String
resp.policy.created_at #=> Time
resp.policy.updated_at #=> Time

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:policy_id (required, String) —
The unique identifier of the approval policy to update.
:name (String) —
The name of the approval policy.
:description (String) —
A description of the approval policy.
:actions (Array<String>) —
The list of governed actions that trigger the approval workflow.
:asset_types (Array<String>) —
The list of asset types that the approval policy applies to.
:applicable_to (Types::ApplicableTo) —
The scoping configuration that determines who the approval policy applies to.
:approval_groups (Array<String>) —
The list of group ARNs whose members can approve requests.

Returns:

(Types::UpdateApprovalPolicyResponse) —
Returns a response object which responds to the following methods:
- #policy => Types::ApprovalPolicy

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 21163

def update_approval_policy(params = {}, options = {})
  req = build_request(:update_approval_policy, params)
  req.send_request(options)
end

#update_brand(params = {}) ⇒ `Types::UpdateBrandResponse`

Updates a brand.

Examples:

Request syntax with placeholder values


resp = client.update_brand({
  aws_account_id: "AwsAccountId", # required
  brand_id: "ShortRestrictiveResourceId", # required
  brand_definition: {
    brand_name: "Name", # required
    description: "Description",
    application_theme: {
      brand_color_palette: {
        primary: {
          foreground: "HexColor",
          background: "HexColor",
        },
        secondary: {
          foreground: "HexColor",
          background: "HexColor",
        },
        accent: {
          foreground: "HexColor",
          background: "HexColor",
        },
        measure: {
          foreground: "HexColor",
          background: "HexColor",
        },
        dimension: {
          foreground: "HexColor",
          background: "HexColor",
        },
        success: {
          foreground: "HexColor",
          background: "HexColor",
        },
        info: {
          foreground: "HexColor",
          background: "HexColor",
        },
        warning: {
          foreground: "HexColor",
          background: "HexColor",
        },
        danger: {
          foreground: "HexColor",
          background: "HexColor",
        },
      },
      contextual_accent_palette: {
        connection: {
          foreground: "HexColor",
          background: "HexColor",
        },
        visualization: {
          foreground: "HexColor",
          background: "HexColor",
        },
        insight: {
          foreground: "HexColor",
          background: "HexColor",
        },
        automation: {
          foreground: "HexColor",
          background: "HexColor",
        },
      },
      brand_element_style: {
        navbar_style: {
          global_navbar: {
            foreground: "HexColor",
            background: "HexColor",
          },
          contextual_navbar: {
            foreground: "HexColor",
            background: "HexColor",
          },
        },
      },
    },
    logo_configuration: {
      alt_text: "String", # required
      logo_set: { # required
        primary: { # required
          original: { # required
            source: {
              public_url: "String",
              s3_uri: "String",
            },
          },
        },
        favicon: {
          original: { # required
            source: {
              public_url: "String",
              s3_uri: "String",
            },
          },
        },
      },
    },
  },
})

Response structure


resp.request_id #=> String
resp.brand_detail.brand_id #=> String
resp.brand_detail.arn #=> String
resp.brand_detail.brand_status #=> String, one of "CREATE_IN_PROGRESS", "CREATE_SUCCEEDED", "CREATE_FAILED", "DELETE_IN_PROGRESS", "DELETE_FAILED"
resp.brand_detail.created_time #=> Time
resp.brand_detail.last_updated_time #=> Time
resp.brand_detail.version_id #=> String
resp.brand_detail.version_status #=> String, one of "CREATE_IN_PROGRESS", "CREATE_SUCCEEDED", "CREATE_FAILED"
resp.brand_detail.errors #=> Array
resp.brand_detail.errors[0] #=> String
resp.brand_detail.logo.alt_text #=> String
resp.brand_detail.logo.logo_set.primary.original.source.public_url #=> String
resp.brand_detail.logo.logo_set.primary.original.source.s3_uri #=> String
resp.brand_detail.logo.logo_set.primary.original.generated_image_url #=> String
resp.brand_detail.logo.logo_set.primary.height_64.source.public_url #=> String
resp.brand_detail.logo.logo_set.primary.height_64.source.s3_uri #=> String
resp.brand_detail.logo.logo_set.primary.height_64.generated_image_url #=> String
resp.brand_detail.logo.logo_set.primary.height_32.source.public_url #=> String
resp.brand_detail.logo.logo_set.primary.height_32.source.s3_uri #=> String
resp.brand_detail.logo.logo_set.primary.height_32.generated_image_url #=> String
resp.brand_detail.logo.logo_set.favicon.original.source.public_url #=> String
resp.brand_detail.logo.logo_set.favicon.original.source.s3_uri #=> String
resp.brand_detail.logo.logo_set.favicon.original.generated_image_url #=> String
resp.brand_detail.logo.logo_set.favicon.height_64.source.public_url #=> String
resp.brand_detail.logo.logo_set.favicon.height_64.source.s3_uri #=> String
resp.brand_detail.logo.logo_set.favicon.height_64.generated_image_url #=> String
resp.brand_detail.logo.logo_set.favicon.height_32.source.public_url #=> String
resp.brand_detail.logo.logo_set.favicon.height_32.source.s3_uri #=> String
resp.brand_detail.logo.logo_set.favicon.height_32.generated_image_url #=> String
resp.brand_definition.brand_name #=> String
resp.brand_definition.description #=> String
resp.brand_definition.application_theme.brand_color_palette.primary.foreground #=> String
resp.brand_definition.application_theme.brand_color_palette.primary.background #=> String
resp.brand_definition.application_theme.brand_color_palette.secondary.foreground #=> String
resp.brand_definition.application_theme.brand_color_palette.secondary.background #=> String
resp.brand_definition.application_theme.brand_color_palette.accent.foreground #=> String
resp.brand_definition.application_theme.brand_color_palette.accent.background #=> String
resp.brand_definition.application_theme.brand_color_palette.measure.foreground #=> String
resp.brand_definition.application_theme.brand_color_palette.measure.background #=> String
resp.brand_definition.application_theme.brand_color_palette.dimension.foreground #=> String
resp.brand_definition.application_theme.brand_color_palette.dimension.background #=> String
resp.brand_definition.application_theme.brand_color_palette.success.foreground #=> String
resp.brand_definition.application_theme.brand_color_palette.success.background #=> String
resp.brand_definition.application_theme.brand_color_palette.info.foreground #=> String
resp.brand_definition.application_theme.brand_color_palette.info.background #=> String
resp.brand_definition.application_theme.brand_color_palette.warning.foreground #=> String
resp.brand_definition.application_theme.brand_color_palette.warning.background #=> String
resp.brand_definition.application_theme.brand_color_palette.danger.foreground #=> String
resp.brand_definition.application_theme.brand_color_palette.danger.background #=> String
resp.brand_definition.application_theme.contextual_accent_palette.connection.foreground #=> String
resp.brand_definition.application_theme.contextual_accent_palette.connection.background #=> String
resp.brand_definition.application_theme.contextual_accent_palette.visualization.foreground #=> String
resp.brand_definition.application_theme.contextual_accent_palette.visualization.background #=> String
resp.brand_definition.application_theme.contextual_accent_palette.insight.foreground #=> String
resp.brand_definition.application_theme.contextual_accent_palette.insight.background #=> String
resp.brand_definition.application_theme.contextual_accent_palette.automation.foreground #=> String
resp.brand_definition.application_theme.contextual_accent_palette.automation.background #=> String
resp.brand_definition.application_theme.brand_element_style.navbar_style.global_navbar.foreground #=> String
resp.brand_definition.application_theme.brand_element_style.navbar_style.global_navbar.background #=> String
resp.brand_definition.application_theme.brand_element_style.navbar_style.contextual_navbar.foreground #=> String
resp.brand_definition.application_theme.brand_element_style.navbar_style.contextual_navbar.background #=> String
resp.brand_definition.logo_configuration.alt_text #=> String
resp.brand_definition.logo_configuration.logo_set.primary.original.source.public_url #=> String
resp.brand_definition.logo_configuration.logo_set.primary.original.source.s3_uri #=> String
resp.brand_definition.logo_configuration.logo_set.favicon.original.source.public_url #=> String
resp.brand_definition.logo_configuration.logo_set.favicon.original.source.s3_uri #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:aws_account_id (required, String) —
The ID of the Amazon Web Services account that owns the brand.
:brand_id (required, String) —
The ID of the Quick brand.
:brand_definition (Types::BrandDefinition) —
The definition of the brand.

Returns:

(Types::UpdateBrandResponse) —
Returns a response object which responds to the following methods:
- #request_id => String
- #brand_detail => Types::BrandDetail
- #brand_definition => Types::BrandDefinition

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 21360

def update_brand(params = {}, options = {})
  req = build_request(:update_brand, params)
  req.send_request(options)
end

#update_brand_assignment(params = {}) ⇒ `Types::UpdateBrandAssignmentResponse`

Updates a brand assignment.

Examples:

Request syntax with placeholder values


resp = client.update_brand_assignment({
  aws_account_id: "AwsAccountId", # required
  brand_arn: "Arn", # required
})

Response structure


resp.request_id #=> String
resp.brand_arn #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:aws_account_id (required, String) —
The ID of the Amazon Web Services account that owns the brand assignment.
:brand_arn (required, String) —
The Amazon Resource Name (ARN) of the brand.

Returns:

(Types::UpdateBrandAssignmentResponse) —
Returns a response object which responds to the following methods:
- #request_id => String
- #brand_arn => String

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 21395

def update_brand_assignment(params = {}, options = {})
  req = build_request(:update_brand_assignment, params)
  req.send_request(options)
end

#update_brand_published_version(params = {}) ⇒ `Types::UpdateBrandPublishedVersionResponse`

Updates the published version of a brand.

Examples:

Request syntax with placeholder values


resp = client.update_brand_published_version({
  aws_account_id: "AwsAccountId", # required
  brand_id: "ShortRestrictiveResourceId", # required
  version_id: "ShortRestrictiveResourceId", # required
})

Response structure


resp.request_id #=> String
resp.version_id #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:aws_account_id (required, String) —
The ID of the Amazon Web Services account that owns the brand.
:brand_id (required, String) —
The ID of the Quick brand.
:version_id (required, String) —
The ID of the published version.

Returns:

(Types::UpdateBrandPublishedVersionResponse) —
Returns a response object which responds to the following methods:
- #request_id => String
- #version_id => String

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 21433

def update_brand_published_version(params = {}, options = {})
  req = build_request(:update_brand_published_version, params)
  req.send_request(options)
end

#update_custom_permissions(params = {}) ⇒ `Types::UpdateCustomPermissionsResponse`

Updates a custom permissions profile.

Examples:

Request syntax with placeholder values


resp = client.update_custom_permissions({
  aws_account_id: "AwsAccountId", # required
  custom_permissions_name: "CustomPermissionsName", # required
  capabilities: {
    export_to_csv: "DENY", # accepts DENY, ALLOW
    export_to_excel: "DENY", # accepts DENY, ALLOW
    export_to_pdf: "DENY", # accepts DENY, ALLOW
    print_reports: "DENY", # accepts DENY, ALLOW
    create_and_update_themes: "DENY", # accepts DENY, ALLOW
    add_or_run_anomaly_detection_for_analyses: "DENY", # accepts DENY, ALLOW
    share_analyses: "DENY", # accepts DENY, ALLOW
    create_and_update_datasets: "DENY", # accepts DENY, ALLOW
    share_datasets: "DENY", # accepts DENY, ALLOW
    subscribe_dashboard_email_reports: "DENY", # accepts DENY, ALLOW
    create_and_update_dashboard_email_reports: "DENY", # accepts DENY, ALLOW
    share_dashboards: "DENY", # accepts DENY, ALLOW
    create_and_update_threshold_alerts: "DENY", # accepts DENY, ALLOW
    rename_shared_folders: "DENY", # accepts DENY, ALLOW
    create_shared_folders: "DENY", # accepts DENY, ALLOW
    create_and_update_data_sources: "DENY", # accepts DENY, ALLOW
    share_data_sources: "DENY", # accepts DENY, ALLOW
    view_account_spice_capacity: "DENY", # accepts DENY, ALLOW
    create_spice_dataset: "DENY", # accepts DENY, ALLOW
    export_to_pdf_in_scheduled_reports: "DENY", # accepts DENY, ALLOW
    export_to_csv_in_scheduled_reports: "DENY", # accepts DENY, ALLOW
    export_to_excel_in_scheduled_reports: "DENY", # accepts DENY, ALLOW
    include_content_in_scheduled_reports_email: "DENY", # accepts DENY, ALLOW
    dashboard: "DENY", # accepts DENY, ALLOW
    analysis: "DENY", # accepts DENY, ALLOW
    automate: "DENY", # accepts DENY, ALLOW
    flow: "DENY", # accepts DENY, ALLOW
    apps: "DENY", # accepts DENY, ALLOW
    create_and_update_apps: "DENY", # accepts DENY, ALLOW
    share_apps: "DENY", # accepts DENY, ALLOW
    invoke_apps_ai_inference: "DENY", # accepts DENY, ALLOW
    access_apps_native_data_store: "DENY", # accepts DENY, ALLOW
    publish_without_approval: "DENY", # accepts DENY, ALLOW
    use_bedrock_models: "DENY", # accepts DENY, ALLOW
    perform_flow_ui_task: "DENY", # accepts DENY, ALLOW
    approve_flow_share_requests: "DENY", # accepts DENY, ALLOW
    use_agent_web_search: "DENY", # accepts DENY, ALLOW
    knowledge_base: "DENY", # accepts DENY, ALLOW
    create_and_update_knowledge_bases: "DENY", # accepts DENY, ALLOW
    share_knowledge_bases: "DENY", # accepts DENY, ALLOW
    share_point_knowledge_base: "DENY", # accepts DENY, ALLOW
    create_and_update_share_point_knowledge_base: "DENY", # accepts DENY, ALLOW
    share_share_point_knowledge_base: "DENY", # accepts DENY, ALLOW
    use_share_point_knowledge_base: "DENY", # accepts DENY, ALLOW
    google_drive_knowledge_base: "DENY", # accepts DENY, ALLOW
    create_and_update_google_drive_knowledge_base: "DENY", # accepts DENY, ALLOW
    share_google_drive_knowledge_base: "DENY", # accepts DENY, ALLOW
    use_google_drive_knowledge_base: "DENY", # accepts DENY, ALLOW
    web_crawler_knowledge_base: "DENY", # accepts DENY, ALLOW
    create_and_update_web_crawler_knowledge_base: "DENY", # accepts DENY, ALLOW
    share_web_crawler_knowledge_base: "DENY", # accepts DENY, ALLOW
    use_web_crawler_knowledge_base: "DENY", # accepts DENY, ALLOW
    s3_knowledge_base: "DENY", # accepts DENY, ALLOW
    create_and_update_s3_knowledge_base: "DENY", # accepts DENY, ALLOW
    share_s3_knowledge_base: "DENY", # accepts DENY, ALLOW
    use_s3_knowledge_base: "DENY", # accepts DENY, ALLOW
    confluence_knowledge_base: "DENY", # accepts DENY, ALLOW
    create_and_update_confluence_knowledge_base: "DENY", # accepts DENY, ALLOW
    share_confluence_knowledge_base: "DENY", # accepts DENY, ALLOW
    use_confluence_knowledge_base: "DENY", # accepts DENY, ALLOW
    one_drive_knowledge_base: "DENY", # accepts DENY, ALLOW
    create_and_update_one_drive_knowledge_base: "DENY", # accepts DENY, ALLOW
    share_one_drive_knowledge_base: "DENY", # accepts DENY, ALLOW
    use_one_drive_knowledge_base: "DENY", # accepts DENY, ALLOW
    q_business_knowledge_base: "DENY", # accepts DENY, ALLOW
    create_and_update_q_business_knowledge_base: "DENY", # accepts DENY, ALLOW
    share_q_business_knowledge_base: "DENY", # accepts DENY, ALLOW
    use_q_business_knowledge_base: "DENY", # accepts DENY, ALLOW
    bedrock_managed_knowledge_base: "DENY", # accepts DENY, ALLOW
    create_and_update_bedrock_managed_knowledge_base: "DENY", # accepts DENY, ALLOW
    share_bedrock_managed_knowledge_base: "DENY", # accepts DENY, ALLOW
    use_bedrock_managed_knowledge_base: "DENY", # accepts DENY, ALLOW
    box_knowledge_base: "DENY", # accepts DENY, ALLOW
    create_and_update_box_knowledge_base: "DENY", # accepts DENY, ALLOW
    share_box_knowledge_base: "DENY", # accepts DENY, ALLOW
    use_box_knowledge_base: "DENY", # accepts DENY, ALLOW
    idc_knowledge_base: "DENY", # accepts DENY, ALLOW
    create_and_update_idc_knowledge_base: "DENY", # accepts DENY, ALLOW
    share_idc_knowledge_base: "DENY", # accepts DENY, ALLOW
    use_idc_knowledge_base: "DENY", # accepts DENY, ALLOW
    action: "DENY", # accepts DENY, ALLOW
    generic_http_action: "DENY", # accepts DENY, ALLOW
    create_and_update_generic_http_action: "DENY", # accepts DENY, ALLOW
    share_generic_http_action: "DENY", # accepts DENY, ALLOW
    use_generic_http_action: "DENY", # accepts DENY, ALLOW
    asana_action: "DENY", # accepts DENY, ALLOW
    create_and_update_asana_action: "DENY", # accepts DENY, ALLOW
    share_asana_action: "DENY", # accepts DENY, ALLOW
    use_asana_action: "DENY", # accepts DENY, ALLOW
    slack_action: "DENY", # accepts DENY, ALLOW
    create_and_update_slack_action: "DENY", # accepts DENY, ALLOW
    share_slack_action: "DENY", # accepts DENY, ALLOW
    use_slack_action: "DENY", # accepts DENY, ALLOW
    service_now_action: "DENY", # accepts DENY, ALLOW
    create_and_update_service_now_action: "DENY", # accepts DENY, ALLOW
    share_service_now_action: "DENY", # accepts DENY, ALLOW
    use_service_now_action: "DENY", # accepts DENY, ALLOW
    salesforce_action: "DENY", # accepts DENY, ALLOW
    create_and_update_salesforce_action: "DENY", # accepts DENY, ALLOW
    share_salesforce_action: "DENY", # accepts DENY, ALLOW
    use_salesforce_action: "DENY", # accepts DENY, ALLOW
    ms_exchange_action: "DENY", # accepts DENY, ALLOW
    create_and_update_ms_exchange_action: "DENY", # accepts DENY, ALLOW
    share_ms_exchange_action: "DENY", # accepts DENY, ALLOW
    use_ms_exchange_action: "DENY", # accepts DENY, ALLOW
    pager_duty_action: "DENY", # accepts DENY, ALLOW
    create_and_update_pager_duty_action: "DENY", # accepts DENY, ALLOW
    share_pager_duty_action: "DENY", # accepts DENY, ALLOW
    use_pager_duty_action: "DENY", # accepts DENY, ALLOW
    jira_action: "DENY", # accepts DENY, ALLOW
    create_and_update_jira_action: "DENY", # accepts DENY, ALLOW
    share_jira_action: "DENY", # accepts DENY, ALLOW
    use_jira_action: "DENY", # accepts DENY, ALLOW
    confluence_action: "DENY", # accepts DENY, ALLOW
    create_and_update_confluence_action: "DENY", # accepts DENY, ALLOW
    share_confluence_action: "DENY", # accepts DENY, ALLOW
    use_confluence_action: "DENY", # accepts DENY, ALLOW
    one_drive_action: "DENY", # accepts DENY, ALLOW
    create_and_update_one_drive_action: "DENY", # accepts DENY, ALLOW
    share_one_drive_action: "DENY", # accepts DENY, ALLOW
    use_one_drive_action: "DENY", # accepts DENY, ALLOW
    share_point_action: "DENY", # accepts DENY, ALLOW
    create_and_update_share_point_action: "DENY", # accepts DENY, ALLOW
    share_share_point_action: "DENY", # accepts DENY, ALLOW
    use_share_point_action: "DENY", # accepts DENY, ALLOW
    ms_teams_action: "DENY", # accepts DENY, ALLOW
    create_and_update_ms_teams_action: "DENY", # accepts DENY, ALLOW
    share_ms_teams_action: "DENY", # accepts DENY, ALLOW
    use_ms_teams_action: "DENY", # accepts DENY, ALLOW
    google_calendar_action: "DENY", # accepts DENY, ALLOW
    create_and_update_google_calendar_action: "DENY", # accepts DENY, ALLOW
    share_google_calendar_action: "DENY", # accepts DENY, ALLOW
    use_google_calendar_action: "DENY", # accepts DENY, ALLOW
    zendesk_action: "DENY", # accepts DENY, ALLOW
    create_and_update_zendesk_action: "DENY", # accepts DENY, ALLOW
    share_zendesk_action: "DENY", # accepts DENY, ALLOW
    use_zendesk_action: "DENY", # accepts DENY, ALLOW
    smartsheet_action: "DENY", # accepts DENY, ALLOW
    create_and_update_smartsheet_action: "DENY", # accepts DENY, ALLOW
    share_smartsheet_action: "DENY", # accepts DENY, ALLOW
    use_smartsheet_action: "DENY", # accepts DENY, ALLOW
    sap_business_partner_action: "DENY", # accepts DENY, ALLOW
    create_and_update_sap_business_partner_action: "DENY", # accepts DENY, ALLOW
    share_sap_business_partner_action: "DENY", # accepts DENY, ALLOW
    use_sap_business_partner_action: "DENY", # accepts DENY, ALLOW
    sap_product_master_data_action: "DENY", # accepts DENY, ALLOW
    create_and_update_sap_product_master_data_action: "DENY", # accepts DENY, ALLOW
    share_sap_product_master_data_action: "DENY", # accepts DENY, ALLOW
    use_sap_product_master_data_action: "DENY", # accepts DENY, ALLOW
    sap_physical_inventory_action: "DENY", # accepts DENY, ALLOW
    create_and_update_sap_physical_inventory_action: "DENY", # accepts DENY, ALLOW
    share_sap_physical_inventory_action: "DENY", # accepts DENY, ALLOW
    use_sap_physical_inventory_action: "DENY", # accepts DENY, ALLOW
    sap_bill_of_material_action: "DENY", # accepts DENY, ALLOW
    create_and_update_sap_bill_of_material_action: "DENY", # accepts DENY, ALLOW
    share_sap_bill_of_material_action: "DENY", # accepts DENY, ALLOW
    use_sap_bill_of_material_action: "DENY", # accepts DENY, ALLOW
    sap_material_stock_action: "DENY", # accepts DENY, ALLOW
    create_and_update_sap_material_stock_action: "DENY", # accepts DENY, ALLOW
    share_sap_material_stock_action: "DENY", # accepts DENY, ALLOW
    use_sap_material_stock_action: "DENY", # accepts DENY, ALLOW
    fact_set_action: "DENY", # accepts DENY, ALLOW
    create_and_update_fact_set_action: "DENY", # accepts DENY, ALLOW
    share_fact_set_action: "DENY", # accepts DENY, ALLOW
    use_fact_set_action: "DENY", # accepts DENY, ALLOW
    amazon_s_three_action: "DENY", # accepts DENY, ALLOW
    create_and_update_amazon_s_three_action: "DENY", # accepts DENY, ALLOW
    share_amazon_s_three_action: "DENY", # accepts DENY, ALLOW
    use_amazon_s_three_action: "DENY", # accepts DENY, ALLOW
    textract_action: "DENY", # accepts DENY, ALLOW
    create_and_update_textract_action: "DENY", # accepts DENY, ALLOW
    share_textract_action: "DENY", # accepts DENY, ALLOW
    use_textract_action: "DENY", # accepts DENY, ALLOW
    comprehend_action: "DENY", # accepts DENY, ALLOW
    create_and_update_comprehend_action: "DENY", # accepts DENY, ALLOW
    share_comprehend_action: "DENY", # accepts DENY, ALLOW
    use_comprehend_action: "DENY", # accepts DENY, ALLOW
    comprehend_medical_action: "DENY", # accepts DENY, ALLOW
    create_and_update_comprehend_medical_action: "DENY", # accepts DENY, ALLOW
    share_comprehend_medical_action: "DENY", # accepts DENY, ALLOW
    use_comprehend_medical_action: "DENY", # accepts DENY, ALLOW
    amazon_bedrock_ars_action: "DENY", # accepts DENY, ALLOW
    create_and_update_amazon_bedrock_ars_action: "DENY", # accepts DENY, ALLOW
    share_amazon_bedrock_ars_action: "DENY", # accepts DENY, ALLOW
    use_amazon_bedrock_ars_action: "DENY", # accepts DENY, ALLOW
    amazon_bedrock_fs_action: "DENY", # accepts DENY, ALLOW
    create_and_update_amazon_bedrock_fs_action: "DENY", # accepts DENY, ALLOW
    share_amazon_bedrock_fs_action: "DENY", # accepts DENY, ALLOW
    use_amazon_bedrock_fs_action: "DENY", # accepts DENY, ALLOW
    amazon_bedrock_krs_action: "DENY", # accepts DENY, ALLOW
    create_and_update_amazon_bedrock_krs_action: "DENY", # accepts DENY, ALLOW
    share_amazon_bedrock_krs_action: "DENY", # accepts DENY, ALLOW
    use_amazon_bedrock_krs_action: "DENY", # accepts DENY, ALLOW
    mcp_action: "DENY", # accepts DENY, ALLOW
    create_and_update_mcp_action: "DENY", # accepts DENY, ALLOW
    share_mcp_action: "DENY", # accepts DENY, ALLOW
    use_mcp_action: "DENY", # accepts DENY, ALLOW
    open_api_action: "DENY", # accepts DENY, ALLOW
    create_and_update_open_api_action: "DENY", # accepts DENY, ALLOW
    share_open_api_action: "DENY", # accepts DENY, ALLOW
    use_open_api_action: "DENY", # accepts DENY, ALLOW
    sand_pgmi_action: "DENY", # accepts DENY, ALLOW
    create_and_update_sand_pgmi_action: "DENY", # accepts DENY, ALLOW
    share_sand_pgmi_action: "DENY", # accepts DENY, ALLOW
    use_sand_pgmi_action: "DENY", # accepts DENY, ALLOW
    sand_p_global_energy_action: "DENY", # accepts DENY, ALLOW
    create_and_update_sand_p_global_energy_action: "DENY", # accepts DENY, ALLOW
    share_sand_p_global_energy_action: "DENY", # accepts DENY, ALLOW
    use_sand_p_global_energy_action: "DENY", # accepts DENY, ALLOW
    bamboo_hr_action: "DENY", # accepts DENY, ALLOW
    create_and_update_bamboo_hr_action: "DENY", # accepts DENY, ALLOW
    share_bamboo_hr_action: "DENY", # accepts DENY, ALLOW
    use_bamboo_hr_action: "DENY", # accepts DENY, ALLOW
    box_agent_action: "DENY", # accepts DENY, ALLOW
    create_and_update_box_agent_action: "DENY", # accepts DENY, ALLOW
    share_box_agent_action: "DENY", # accepts DENY, ALLOW
    use_box_agent_action: "DENY", # accepts DENY, ALLOW
    canva_agent_action: "DENY", # accepts DENY, ALLOW
    create_and_update_canva_agent_action: "DENY", # accepts DENY, ALLOW
    share_canva_agent_action: "DENY", # accepts DENY, ALLOW
    use_canva_agent_action: "DENY", # accepts DENY, ALLOW
    github_action: "DENY", # accepts DENY, ALLOW
    create_and_update_github_action: "DENY", # accepts DENY, ALLOW
    share_github_action: "DENY", # accepts DENY, ALLOW
    use_github_action: "DENY", # accepts DENY, ALLOW
    notion_action: "DENY", # accepts DENY, ALLOW
    create_and_update_notion_action: "DENY", # accepts DENY, ALLOW
    share_notion_action: "DENY", # accepts DENY, ALLOW
    use_notion_action: "DENY", # accepts DENY, ALLOW
    linear_action: "DENY", # accepts DENY, ALLOW
    create_and_update_linear_action: "DENY", # accepts DENY, ALLOW
    share_linear_action: "DENY", # accepts DENY, ALLOW
    use_linear_action: "DENY", # accepts DENY, ALLOW
    hugging_face_action: "DENY", # accepts DENY, ALLOW
    create_and_update_hugging_face_action: "DENY", # accepts DENY, ALLOW
    share_hugging_face_action: "DENY", # accepts DENY, ALLOW
    use_hugging_face_action: "DENY", # accepts DENY, ALLOW
    monday_action: "DENY", # accepts DENY, ALLOW
    create_and_update_monday_action: "DENY", # accepts DENY, ALLOW
    share_monday_action: "DENY", # accepts DENY, ALLOW
    use_monday_action: "DENY", # accepts DENY, ALLOW
    hubspot_action: "DENY", # accepts DENY, ALLOW
    create_and_update_hubspot_action: "DENY", # accepts DENY, ALLOW
    share_hubspot_action: "DENY", # accepts DENY, ALLOW
    use_hubspot_action: "DENY", # accepts DENY, ALLOW
    intercom_action: "DENY", # accepts DENY, ALLOW
    create_and_update_intercom_action: "DENY", # accepts DENY, ALLOW
    share_intercom_action: "DENY", # accepts DENY, ALLOW
    use_intercom_action: "DENY", # accepts DENY, ALLOW
    new_relic_action: "DENY", # accepts DENY, ALLOW
    create_and_update_new_relic_action: "DENY", # accepts DENY, ALLOW
    share_new_relic_action: "DENY", # accepts DENY, ALLOW
    use_new_relic_action: "DENY", # accepts DENY, ALLOW
    topic: "DENY", # accepts DENY, ALLOW
    edit_visual_with_q: "DENY", # accepts DENY, ALLOW
    build_calculated_field_with_q: "DENY", # accepts DENY, ALLOW
    create_dashboard_executive_summary_with_q: "DENY", # accepts DENY, ALLOW
    space: "DENY", # accepts DENY, ALLOW
    create_spaces: "DENY", # accepts DENY, ALLOW
    share_spaces: "DENY", # accepts DENY, ALLOW
    chat_agent: "DENY", # accepts DENY, ALLOW
    create_chat_agents: "DENY", # accepts DENY, ALLOW
    share_chat_agents: "DENY", # accepts DENY, ALLOW
    research: "DENY", # accepts DENY, ALLOW
    self_upgrade_user_role: "DENY", # accepts DENY, ALLOW
    extension: "DENY", # accepts DENY, ALLOW
    use_browser_extension: "DENY", # accepts DENY, ALLOW
    use_word_add_in_extension: "DENY", # accepts DENY, ALLOW
    use_outlook_add_in_extension: "DENY", # accepts DENY, ALLOW
    use_excel_add_in_extension: "DENY", # accepts DENY, ALLOW
    use_powerpoint_add_in_extension: "DENY", # accepts DENY, ALLOW
    manage_shared_folders: "DENY", # accepts DENY, ALLOW
    generate_analyses: "DENY", # accepts DENY, ALLOW
    story: "DENY", # accepts DENY, ALLOW
    scenario: "DENY", # accepts DENY, ALLOW
    trigger: "DENY", # accepts DENY, ALLOW
    schedule_trigger: "DENY", # accepts DENY, ALLOW
    inbound_email_trigger: "DENY", # accepts DENY, ALLOW
    quick_event_trigger: "DENY", # accepts DENY, ALLOW
  },
  governance: {
    default_category_effects: {
      "GovernanceCategoryName" => "DENY_BY_DEFAULT", # accepts DENY_BY_DEFAULT
    },
  },
})

Response structure


resp.status #=> Integer
resp.arn #=> String
resp.request_id #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:aws_account_id (required, String) —
The ID of the Amazon Web Services account that contains the custom permissions profile that you want to update.
:custom_permissions_name (required, String) —
The name of the custom permissions profile that you want to update.
:capabilities (Types::Capabilities) —
A set of actions to include in the custom permissions profile.
:governance (Types::Governance) —
The governance configuration for the custom permissions profile. The UpdateCustomPermissions operation replaces all existing Capabilities and Governance values. If you omit this parameter, Amazon Quick removes governance from the profile and the existing custom permission behavior applies.

Returns:

(Types::UpdateCustomPermissionsResponse) —
Returns a response object which responds to the following methods:
- #status => Integer
- #arn => String
- #request_id => String

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 21766

def update_custom_permissions(params = {}, options = {})
  req = build_request(:update_custom_permissions, params)
  req.send_request(options)
end

#update_dashboard(params = {}) ⇒ `Types::UpdateDashboardResponse`

Updates a dashboard in an Amazon Web Services account.

Updating a Dashboard creates a new dashboard version but does not immediately publish the new version. You can update the published version of a dashboard by using the UpdateDashboardPublishedVersion API operation.

Examples:

Response structure


resp.arn #=> String
resp.version_arn #=> String
resp.dashboard_id #=> String
resp.creation_status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED", "DELETED"
resp.status #=> Integer
resp.request_id #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:aws_account_id (required, String) —
The ID of the Amazon Web Services account that contains the dashboard that you're updating.
:dashboard_id (required, String) —
The ID for the dashboard.
:name (required, String) —
The display name of the dashboard.
:source_entity (Types::DashboardSourceEntity) —
The entity that you are using as a source when you update the dashboard. In SourceEntity, you specify the type of object you're using as source. You can only update a dashboard from a template, so you use a SourceTemplate entity. If you need to update a dashboard from an analysis, first convert the analysis to a template by using the CreateTemplate API operation. For SourceTemplate, specify the Amazon Resource Name (ARN) of the source template. The SourceTemplate ARN can contain any Amazon Web Services account and any Amazon Quick Sight-supported Amazon Web Services Region.

Use the DataSetReferences entity within SourceTemplate to list the replacement datasets for the placeholders listed in the original. The schema in each dataset must match its placeholder. Use the TopicReferences entity to list the replacement topics for the topic placeholders listed in the original. The schema in each topic must match its placeholder.
:parameters (Types::Parameters) —
A structure that contains the parameters of the dashboard. These are parameter overrides for a dashboard. A dashboard can have any type of parameters, and some parameters might accept multiple values.
:version_description (String) —
A description for the first version of the dashboard being created.
:dashboard_publish_options (Types::DashboardPublishOptions) —
Options for publishing the dashboard when you create it:
- AvailabilityStatus for AdHocFilteringOption - This status can be either ENABLED or DISABLED. When this is set to DISABLED, Amazon Quick Sight disables the left filter pane on the published dashboard, which can be used for ad hoc (one-time) filtering. This option is ENABLED by default.
- AvailabilityStatus for ExportToCSVOption - This status can be either ENABLED or DISABLED. The visual option to export data to .CSV format isn't enabled when this is set to DISABLED. This option is ENABLED by default.
- VisibilityState for SheetControlsOption - This visibility state can be either COLLAPSED or EXPANDED. This option is COLLAPSED by default.
- AvailabilityStatus for QuickSuiteActionsOption - This status can be either ENABLED or DISABLED. Features related to Actions in Amazon Quick Suite on dashboards are disabled when this is set to DISABLED. This option is DISABLED by default.
- AvailabilityStatus for ExecutiveSummaryOption - This status can be either ENABLED or DISABLED. The option to build an executive summary is disabled when this is set to DISABLED. This option is ENABLED by default.
- AvailabilityStatus for DataStoriesSharingOption - This status can be either ENABLED or DISABLED. The option to share a data story is disabled when this is set to DISABLED. This option is ENABLED by default.
:theme_arn (String) —
The Amazon Resource Name (ARN) of the theme that is being used for this dashboard. If you add a value for this field, it overrides the value that was originally associated with the entity. The theme ARN must exist in the same Amazon Web Services account where you create the dashboard.
:definition (Types::DashboardVersionDefinition) —
The definition of a dashboard.

A definition is the data model of all features in a Dashboard, Template, or Analysis.
:validation_strategy (Types::ValidationStrategy) —
The option to relax the validation needed to update a dashboard with definition objects. This skips the validation step for specific errors.

Returns:

(Types::UpdateDashboardResponse) —
Returns a response object which responds to the following methods:
- #arn => String
- #version_arn => String
- #dashboard_id => String
- #creation_status => String
- #status => Integer
- #request_id => String

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 21889

def update_dashboard(params = {}, options = {})
  req = build_request(:update_dashboard, params)
  req.send_request(options)
end

#update_dashboard_links(params = {}) ⇒ `Types::UpdateDashboardLinksResponse`

Updates the linked analyses on a dashboard.

Examples:

Request syntax with placeholder values


resp = client.update_dashboard_links({
  aws_account_id: "AwsAccountId", # required
  dashboard_id: "ShortRestrictiveResourceId", # required
  link_entities: ["LinkEntityArn"], # required
})

Response structure


resp.request_id #=> String
resp.status #=> Integer
resp.dashboard_arn #=> String
resp.link_entities #=> Array
resp.link_entities[0] #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:aws_account_id (required, String) —
The ID of the Amazon Web Services account that contains the dashboard whose links you want to update.
:dashboard_id (required, String) —
The ID for the dashboard.
:link_entities (required, Array<String>) —
list of analysis Amazon Resource Names (ARNs) to be linked to the dashboard.

Returns:

(Types::UpdateDashboardLinksResponse) —
Returns a response object which responds to the following methods:
- #request_id => String
- #status => Integer
- #dashboard_arn => String
- #link_entities => Array<String>

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 21934

def update_dashboard_links(params = {}, options = {})
  req = build_request(:update_dashboard_links, params)
  req.send_request(options)
end

#update_dashboard_permissions(params = {}) ⇒ `Types::UpdateDashboardPermissionsResponse`

Updates read and write permissions on a dashboard.

Examples:

Request syntax with placeholder values


resp = client.update_dashboard_permissions({
  aws_account_id: "AwsAccountId", # required
  dashboard_id: "ShortRestrictiveResourceId", # required
  grant_permissions: [
    {
      principal: "Principal", # required
      actions: ["String"], # required
    },
  ],
  revoke_permissions: [
    {
      principal: "Principal", # required
      actions: ["String"], # required
    },
  ],
  grant_link_permissions: [
    {
      principal: "Principal", # required
      actions: ["String"], # required
    },
  ],
  revoke_link_permissions: [
    {
      principal: "Principal", # required
      actions: ["String"], # required
    },
  ],
})

Response structure


resp.dashboard_arn #=> String
resp.dashboard_id #=> String
resp.permissions #=> Array
resp.permissions[0].principal #=> String
resp.permissions[0].actions #=> Array
resp.permissions[0].actions[0] #=> String
resp.request_id #=> String
resp.status #=> Integer
resp.link_sharing_configuration.permissions #=> Array
resp.link_sharing_configuration.permissions[0].principal #=> String
resp.link_sharing_configuration.permissions[0].actions #=> Array
resp.link_sharing_configuration.permissions[0].actions[0] #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:aws_account_id (required, String) —
The ID of the Amazon Web Services account that contains the dashboard whose permissions you're updating.
:dashboard_id (required, String) —
The ID for the dashboard.
:grant_permissions (Array<Types::ResourcePermission>) —
The permissions that you want to grant on this resource.
:revoke_permissions (Array<Types::ResourcePermission>) —
The permissions that you want to revoke from this resource.
:grant_link_permissions (Array<Types::ResourcePermission>) —
Grants link permissions to all users in a defined namespace.
:revoke_link_permissions (Array<Types::ResourcePermission>) —
Revokes link permissions from all users in a defined namespace.

Returns:

(Types::UpdateDashboardPermissionsResponse) —
Returns a response object which responds to the following methods:
- #dashboard_arn => String
- #dashboard_id => String
- #permissions => Array<Types::ResourcePermission>
- #request_id => String
- #status => Integer
- #link_sharing_configuration => Types::LinkSharingConfiguration

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 22019

def update_dashboard_permissions(params = {}, options = {})
  req = build_request(:update_dashboard_permissions, params)
  req.send_request(options)
end

#update_dashboard_published_version(params = {}) ⇒ `Types::UpdateDashboardPublishedVersionResponse`

Updates the published version of a dashboard.

Examples:

Request syntax with placeholder values


resp = client.update_dashboard_published_version({
  aws_account_id: "AwsAccountId", # required
  dashboard_id: "ShortRestrictiveResourceId", # required
  version_number: 1, # required
})

Response structure


resp.dashboard_id #=> String
resp.dashboard_arn #=> String
resp.status #=> Integer
resp.request_id #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:aws_account_id (required, String) —
The ID of the Amazon Web Services account that contains the dashboard that you're updating.
:dashboard_id (required, String) —
The ID for the dashboard.
:version_number (required, Integer) —
The version number of the dashboard.

Returns:

(Types::UpdateDashboardPublishedVersionResponse) —
Returns a response object which responds to the following methods:
- #dashboard_id => String
- #dashboard_arn => String
- #status => Integer
- #request_id => String

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 22062

def update_dashboard_published_version(params = {}, options = {})
  req = build_request(:update_dashboard_published_version, params)
  req.send_request(options)
end

#update_dashboards_qa_configuration(params = {}) ⇒ `Types::UpdateDashboardsQAConfigurationResponse`

Updates a Dashboard QA configuration.

Examples:

Request syntax with placeholder values


resp = client.update_dashboards_qa_configuration({
  aws_account_id: "AwsAccountId", # required
  dashboards_qa_status: "ENABLED", # required, accepts ENABLED, DISABLED
})

Response structure


resp.dashboards_qa_status #=> String, one of "ENABLED", "DISABLED"
resp.request_id #=> String
resp.status #=> Integer

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:aws_account_id (required, String) —
The ID of the Amazon Web Services account that contains the dashboard QA configuration that you want to update.
:dashboards_qa_status (required, String) —
The status of dashboards QA configuration that you want to update.

Returns:

(Types::UpdateDashboardsQAConfigurationResponse) —
Returns a response object which responds to the following methods:
- #dashboards_qa_status => String
- #request_id => String
- #status => Integer

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 22099

def update_dashboards_qa_configuration(params = {}, options = {})
  req = build_request(:update_dashboards_qa_configuration, params)
  req.send_request(options)
end

#update_data_set(params = {}) ⇒ `Types::UpdateDataSetResponse`

Updates a dataset. This operation doesn't support datasets that include uploaded files as a source. Partial updates are not supported by this operation.

Examples:

Request syntax with placeholder values


resp = client.update_data_set({
  aws_account_id: "AwsAccountId", # required
  data_set_id: "ResourceId", # required
  name: "ResourceName", # required
  physical_table_map: { # required
    "PhysicalTableId" => {
      relational_table: {
        data_source_arn: "Arn", # required
        catalog: "RelationalTableCatalog",
        schema: "RelationalTableSchema",
        name: "RelationalTableName", # required
        input_columns: [ # required
          {
            name: "ColumnName", # required
            id: "ColumnId",
            type: "STRING", # required, accepts STRING, INTEGER, DECIMAL, DATETIME, BIT, BOOLEAN, JSON, SEMISTRUCT
            sub_type: "FLOAT", # accepts FLOAT, FIXED
          },
        ],
      },
      custom_sql: {
        data_source_arn: "Arn", # required
        name: "CustomSqlName", # required
        sql_query: "SqlQuery", # required
        columns: [
          {
            name: "ColumnName", # required
            id: "ColumnId",
            type: "STRING", # required, accepts STRING, INTEGER, DECIMAL, DATETIME, BIT, BOOLEAN, JSON, SEMISTRUCT
            sub_type: "FLOAT", # accepts FLOAT, FIXED
          },
        ],
      },
      s3_source: {
        data_source_arn: "Arn", # required
        upload_settings: {
          format: "CSV", # accepts CSV, TSV, CLF, ELF, XLSX, JSON
          start_from_row: 1,
          contains_header: false,
          text_qualifier: "DOUBLE_QUOTE", # accepts DOUBLE_QUOTE, SINGLE_QUOTE
          delimiter: "Delimiter",
          custom_cell_address_range: "String",
        },
        input_columns: [ # required
          {
            name: "ColumnName", # required
            id: "ColumnId",
            type: "STRING", # required, accepts STRING, INTEGER, DECIMAL, DATETIME, BIT, BOOLEAN, JSON, SEMISTRUCT
            sub_type: "FLOAT", # accepts FLOAT, FIXED
          },
        ],
      },
      saa_s_table: {
        data_source_arn: "Arn", # required
        table_path: [ # required
          {
            name: "TablePathElementName",
            id: "TablePathElementId",
          },
        ],
        input_columns: [ # required
          {
            name: "ColumnName", # required
            id: "ColumnId",
            type: "STRING", # required, accepts STRING, INTEGER, DECIMAL, DATETIME, BIT, BOOLEAN, JSON, SEMISTRUCT
            sub_type: "FLOAT", # accepts FLOAT, FIXED
          },
        ],
      },
      file_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",
          custom_cell_address_range: "String",
        },
        sheet_index: 1, # required
        input_columns: [ # required
          {
            name: "ColumnName", # required
            id: "ColumnId",
            type: "STRING", # required, accepts STRING, INTEGER, DECIMAL, DATETIME, BIT, BOOLEAN, JSON, SEMISTRUCT
            sub_type: "FLOAT", # accepts FLOAT, FIXED
          },
        ],
      },
    },
  },
  logical_table_map: {
    "LogicalTableId" => {
      alias: "LogicalTableAlias", # required
      data_transforms: [
        {
          project_operation: {
            alias: "TransformOperationAlias",
            source: {
              transform_operation_id: "DataSetEntityResourceId", # required
              column_id_mappings: [
                {
                  source_column_id: "ColumnId", # required
                  target_column_id: "ColumnId", # required
                },
              ],
            },
            projected_columns: ["String"], # required
          },
          filter_operation: {
            condition_expression: "Expression",
            string_filter_condition: {
              column_name: "ColumnName",
              comparison_filter_condition: {
                operator: "EQUALS", # required, accepts EQUALS, DOES_NOT_EQUAL, CONTAINS, DOES_NOT_CONTAIN, STARTS_WITH, ENDS_WITH
                value: {
                  static_value: "DataSetStringFilterStaticValue",
                },
              },
              list_filter_condition: {
                operator: "INCLUDE", # required, accepts INCLUDE, EXCLUDE
                values: {
                  static_values: ["DataSetStringFilterStaticValue"],
                },
              },
            },
            numeric_filter_condition: {
              column_name: "ColumnName",
              comparison_filter_condition: {
                operator: "EQUALS", # required, accepts EQUALS, DOES_NOT_EQUAL, GREATER_THAN, GREATER_THAN_OR_EQUALS_TO, LESS_THAN, LESS_THAN_OR_EQUALS_TO
                value: {
                  static_value: 1.0,
                },
              },
              range_filter_condition: {
                range_minimum: {
                  static_value: 1.0,
                },
                range_maximum: {
                  static_value: 1.0,
                },
                include_minimum: false,
                include_maximum: false,
              },
            },
            date_filter_condition: {
              column_name: "ColumnName",
              comparison_filter_condition: {
                operator: "BEFORE", # required, accepts BEFORE, BEFORE_OR_EQUALS_TO, AFTER, AFTER_OR_EQUALS_TO
                value: {
                  static_value: Time.now,
                },
              },
              range_filter_condition: {
                range_minimum: {
                  static_value: Time.now,
                },
                range_maximum: {
                  static_value: Time.now,
                },
                include_minimum: false,
                include_maximum: false,
              },
            },
          },
          create_columns_operation: {
            alias: "TransformOperationAlias",
            source: {
              transform_operation_id: "DataSetEntityResourceId", # required
              column_id_mappings: [
                {
                  source_column_id: "ColumnId", # required
                  target_column_id: "ColumnId", # required
                },
              ],
            },
            columns: [ # required
              {
                column_name: "ColumnName", # required
                column_id: "ColumnId", # required
                expression: "DataSetCalculatedFieldExpression", # required
              },
            ],
          },
          rename_column_operation: {
            column_name: "ColumnName", # required
            new_column_name: "ColumnName", # required
          },
          cast_column_type_operation: {
            column_name: "ColumnName", # required
            new_column_type: "STRING", # required, accepts STRING, INTEGER, DECIMAL, DATETIME
            sub_type: "FLOAT", # accepts FLOAT, FIXED
            format: "TypeCastFormat",
          },
          tag_column_operation: {
            column_name: "ColumnName", # required
            tags: [ # required
              {
                column_geographic_role: "COUNTRY", # accepts COUNTRY, STATE, COUNTY, CITY, POSTCODE, LONGITUDE, LATITUDE
                column_description: {
                  text: "ColumnDescriptiveText",
                },
              },
            ],
          },
          untag_column_operation: {
            column_name: "ColumnName", # required
            tag_names: ["COLUMN_GEOGRAPHIC_ROLE"], # required, accepts COLUMN_GEOGRAPHIC_ROLE, COLUMN_DESCRIPTION
          },
          override_dataset_parameter_operation: {
            parameter_name: "DatasetParameterName", # required
            new_parameter_name: "DatasetParameterName",
            new_default_values: {
              string_static_values: ["StringDatasetParameterDefaultValue"],
              decimal_static_values: [1.0],
              date_time_static_values: [Time.now],
              integer_static_values: [1],
            },
          },
        },
      ],
      source: { # required
        join_instruction: {
          left_operand: "LogicalTableId", # required
          right_operand: "LogicalTableId", # required
          left_join_key_properties: {
            unique_key: false,
          },
          right_join_key_properties: {
            unique_key: false,
          },
          type: "INNER", # required, accepts INNER, OUTER, LEFT, RIGHT
          on_clause: "OnClause", # required
        },
        physical_table_id: "PhysicalTableId",
        data_set_arn: "Arn",
      },
    },
  },
  import_mode: "SPICE", # required, accepts SPICE, DIRECT_QUERY
  column_groups: [
    {
      geo_spatial_column_group: {
        name: "ColumnGroupName", # required
        country_code: "US", # accepts US
        columns: ["ColumnName"], # required
      },
    },
  ],
  field_folders: {
    "FieldFolderPath" => {
      description: "FieldFolderDescription",
      columns: ["String"],
    },
  },
  row_level_permission_data_set: {
    namespace: "Namespace",
    arn: "Arn", # required
    permission_policy: "GRANT_ACCESS", # required, accepts GRANT_ACCESS, DENY_ACCESS
    format_version: "VERSION_1", # accepts VERSION_1, VERSION_2
    status: "ENABLED", # accepts ENABLED, DISABLED
  },
  row_level_permission_tag_configuration: {
    status: "ENABLED", # accepts ENABLED, DISABLED
    tag_rules: [ # required
      {
        tag_key: "SessionTagKey", # required
        column_name: "String", # required
        tag_multi_value_delimiter: "RowLevelPermissionTagDelimiter",
        match_all_value: "SessionTagValue",
      },
    ],
    tag_rule_configurations: [
      ["SessionTagKey"],
    ],
  },
  column_level_permission_rules: [
    {
      principals: ["String"],
      column_names: ["String"],
    },
  ],
  data_set_usage_configuration: {
    disable_use_as_direct_query_source: false,
    disable_use_as_imported_source: false,
  },
  dataset_parameters: [
    {
      string_dataset_parameter: {
        id: "DatasetParameterId", # required
        name: "DatasetParameterName", # required
        value_type: "MULTI_VALUED", # required, accepts MULTI_VALUED, SINGLE_VALUED
        default_values: {
          static_values: ["StringDatasetParameterDefaultValue"],
        },
      },
      decimal_dataset_parameter: {
        id: "DatasetParameterId", # required
        name: "DatasetParameterName", # required
        value_type: "MULTI_VALUED", # required, accepts MULTI_VALUED, SINGLE_VALUED
        default_values: {
          static_values: [1.0],
        },
      },
      integer_dataset_parameter: {
        id: "DatasetParameterId", # required
        name: "DatasetParameterName", # required
        value_type: "MULTI_VALUED", # required, accepts MULTI_VALUED, SINGLE_VALUED
        default_values: {
          static_values: [1],
        },
      },
      date_time_dataset_parameter: {
        id: "DatasetParameterId", # required
        name: "DatasetParameterName", # required
        value_type: "MULTI_VALUED", # required, accepts MULTI_VALUED, SINGLE_VALUED
        time_granularity: "YEAR", # accepts YEAR, QUARTER, MONTH, WEEK, DAY, HOUR, MINUTE, SECOND, MILLISECOND
        default_values: {
          static_values: [Time.now],
        },
      },
    },
  ],
  performance_configuration: {
    unique_keys: [
      {
        column_names: ["ColumnName"], # required
      },
    ],
  },
  data_prep_configuration: {
    source_table_map: { # required
      "DataSetEntityResourceId" => {
        physical_table_id: "DataSetEntityResourceId",
        data_set: {
          data_set_arn: "Arn", # required
          input_columns: [ # required
            {
              name: "ColumnName", # required
              id: "ColumnId",
              type: "STRING", # required, accepts STRING, INTEGER, DECIMAL, DATETIME, BIT, BOOLEAN, JSON, SEMISTRUCT
              sub_type: "FLOAT", # accepts FLOAT, FIXED
            },
          ],
        },
      },
    },
    transform_step_map: { # required
      "DataSetEntityResourceId" => {
        import_table_step: {
          alias: "TransformOperationAlias", # required
          source: { # required
            source_table_id: "DataSetEntityResourceId", # required
            column_id_mappings: [
              {
                source_column_id: "ColumnId", # required
                target_column_id: "ColumnId", # required
              },
            ],
          },
        },
        project_step: {
          alias: "TransformOperationAlias",
          source: {
            transform_operation_id: "DataSetEntityResourceId", # required
            column_id_mappings: [
              {
                source_column_id: "ColumnId", # required
                target_column_id: "ColumnId", # required
              },
            ],
          },
          projected_columns: ["String"], # required
        },
        filters_step: {
          alias: "TransformOperationAlias", # required
          source: { # required
            transform_operation_id: "DataSetEntityResourceId", # required
            column_id_mappings: [
              {
                source_column_id: "ColumnId", # required
                target_column_id: "ColumnId", # required
              },
            ],
          },
          filter_operations: [ # required
            {
              condition_expression: "Expression",
              string_filter_condition: {
                column_name: "ColumnName",
                comparison_filter_condition: {
                  operator: "EQUALS", # required, accepts EQUALS, DOES_NOT_EQUAL, CONTAINS, DOES_NOT_CONTAIN, STARTS_WITH, ENDS_WITH
                  value: {
                    static_value: "DataSetStringFilterStaticValue",
                  },
                },
                list_filter_condition: {
                  operator: "INCLUDE", # required, accepts INCLUDE, EXCLUDE
                  values: {
                    static_values: ["DataSetStringFilterStaticValue"],
                  },
                },
              },
              numeric_filter_condition: {
                column_name: "ColumnName",
                comparison_filter_condition: {
                  operator: "EQUALS", # required, accepts EQUALS, DOES_NOT_EQUAL, GREATER_THAN, GREATER_THAN_OR_EQUALS_TO, LESS_THAN, LESS_THAN_OR_EQUALS_TO
                  value: {
                    static_value: 1.0,
                  },
                },
                range_filter_condition: {
                  range_minimum: {
                    static_value: 1.0,
                  },
                  range_maximum: {
                    static_value: 1.0,
                  },
                  include_minimum: false,
                  include_maximum: false,
                },
              },
              date_filter_condition: {
                column_name: "ColumnName",
                comparison_filter_condition: {
                  operator: "BEFORE", # required, accepts BEFORE, BEFORE_OR_EQUALS_TO, AFTER, AFTER_OR_EQUALS_TO
                  value: {
                    static_value: Time.now,
                  },
                },
                range_filter_condition: {
                  range_minimum: {
                    static_value: Time.now,
                  },
                  range_maximum: {
                    static_value: Time.now,
                  },
                  include_minimum: false,
                  include_maximum: false,
                },
              },
            },
          ],
        },
        create_columns_step: {
          alias: "TransformOperationAlias",
          source: {
            transform_operation_id: "DataSetEntityResourceId", # required
            column_id_mappings: [
              {
                source_column_id: "ColumnId", # required
                target_column_id: "ColumnId", # required
              },
            ],
          },
          columns: [ # required
            {
              column_name: "ColumnName", # required
              column_id: "ColumnId", # required
              expression: "DataSetCalculatedFieldExpression", # required
            },
          ],
        },
        rename_columns_step: {
          alias: "TransformOperationAlias", # required
          source: { # required
            transform_operation_id: "DataSetEntityResourceId", # required
            column_id_mappings: [
              {
                source_column_id: "ColumnId", # required
                target_column_id: "ColumnId", # required
              },
            ],
          },
          rename_column_operations: [ # required
            {
              column_name: "ColumnName", # required
              new_column_name: "ColumnName", # required
            },
          ],
        },
        cast_column_types_step: {
          alias: "TransformOperationAlias", # required
          source: { # required
            transform_operation_id: "DataSetEntityResourceId", # required
            column_id_mappings: [
              {
                source_column_id: "ColumnId", # required
                target_column_id: "ColumnId", # required
              },
            ],
          },
          cast_column_type_operations: [ # required
            {
              column_name: "ColumnName", # required
              new_column_type: "STRING", # required, accepts STRING, INTEGER, DECIMAL, DATETIME
              sub_type: "FLOAT", # accepts FLOAT, FIXED
              format: "TypeCastFormat",
            },
          ],
        },
        join_step: {
          alias: "TransformOperationAlias", # required
          left_operand: { # required
            transform_operation_id: "DataSetEntityResourceId", # required
            column_id_mappings: [
              {
                source_column_id: "ColumnId", # required
                target_column_id: "ColumnId", # required
              },
            ],
          },
          right_operand: { # required
            transform_operation_id: "DataSetEntityResourceId", # required
            column_id_mappings: [
              {
                source_column_id: "ColumnId", # required
                target_column_id: "ColumnId", # required
              },
            ],
          },
          type: "INNER", # required, accepts INNER, OUTER, LEFT, RIGHT
          on_clause: "JoinOperationOnClause", # required
          left_operand_properties: {
            output_column_name_overrides: [ # required
              {
                source_column_name: "ColumnName",
                output_column_name: "ColumnName", # required
              },
            ],
          },
          right_operand_properties: {
            output_column_name_overrides: [ # required
              {
                source_column_name: "ColumnName",
                output_column_name: "ColumnName", # required
              },
            ],
          },
        },
        aggregate_step: {
          alias: "TransformOperationAlias", # required
          source: { # required
            transform_operation_id: "DataSetEntityResourceId", # required
            column_id_mappings: [
              {
                source_column_id: "ColumnId", # required
                target_column_id: "ColumnId", # required
              },
            ],
          },
          group_by_column_names: ["ColumnName"],
          aggregations: [ # required
            {
              aggregation_function: { # required
                simple_aggregation: {
                  input_column_name: "ColumnName",
                  function_type: "COUNT", # required, accepts COUNT, DISTINCT_COUNT, SUM, AVERAGE, MAX, MIN
                },
                list_aggregation: {
                  input_column_name: "ColumnName",
                  separator: "Separator", # required
                  distinct: false, # required
                },
              },
              new_column_name: "ColumnName", # required
              new_column_id: "ColumnId", # required
            },
          ],
        },
        pivot_step: {
          alias: "TransformOperationAlias", # required
          source: { # required
            transform_operation_id: "DataSetEntityResourceId", # required
            column_id_mappings: [
              {
                source_column_id: "ColumnId", # required
                target_column_id: "ColumnId", # required
              },
            ],
          },
          group_by_column_names: ["ColumnName"],
          value_column_configuration: { # required
            aggregation_function: {
              simple_aggregation: {
                input_column_name: "ColumnName",
                function_type: "COUNT", # required, accepts COUNT, DISTINCT_COUNT, SUM, AVERAGE, MAX, MIN
              },
              list_aggregation: {
                input_column_name: "ColumnName",
                separator: "Separator", # required
                distinct: false, # required
              },
            },
          },
          pivot_configuration: { # required
            label_column_name: "ColumnName",
            pivoted_labels: [ # required
              {
                label_name: "CellValue", # required
                new_column_name: "ColumnName", # required
                new_column_id: "ColumnId", # required
              },
            ],
          },
        },
        unpivot_step: {
          alias: "TransformOperationAlias", # required
          source: { # required
            transform_operation_id: "DataSetEntityResourceId", # required
            column_id_mappings: [
              {
                source_column_id: "ColumnId", # required
                target_column_id: "ColumnId", # required
              },
            ],
          },
          columns_to_unpivot: [ # required
            {
              column_name: "ColumnName",
              new_value: "CellValue",
            },
          ],
          unpivoted_label_column_name: "ColumnName", # required
          unpivoted_label_column_id: "ColumnId", # required
          unpivoted_value_column_name: "ColumnName", # required
          unpivoted_value_column_id: "ColumnId", # required
        },
        append_step: {
          alias: "TransformOperationAlias", # required
          first_source: {
            transform_operation_id: "DataSetEntityResourceId", # required
            column_id_mappings: [
              {
                source_column_id: "ColumnId", # required
                target_column_id: "ColumnId", # required
              },
            ],
          },
          second_source: {
            transform_operation_id: "DataSetEntityResourceId", # required
            column_id_mappings: [
              {
                source_column_id: "ColumnId", # required
                target_column_id: "ColumnId", # required
              },
            ],
          },
          appended_columns: [ # required
            {
              column_name: "ColumnName", # required
              new_column_id: "ColumnId", # required
            },
          ],
        },
      },
    },
    destination_table_map: { # required
      "DataSetEntityResourceId" => {
        alias: "DestinationTableAlias", # required
        source: { # required
          transform_operation_id: "DataSetEntityResourceId", # required
        },
      },
    },
  },
  semantic_model_configuration: {
    table_map: {
      "DataSetEntityResourceId" => {
        alias: "SemanticTableAlias", # required
        destination_table_id: "DataSetEntityResourceId", # required
        row_level_permission_configuration: {
          tag_configuration: {
            status: "ENABLED", # accepts ENABLED, DISABLED
            tag_rules: [ # required
              {
                tag_key: "SessionTagKey", # required
                column_name: "String", # required
                tag_multi_value_delimiter: "RowLevelPermissionTagDelimiter",
                match_all_value: "SessionTagValue",
              },
            ],
            tag_rule_configurations: [
              ["SessionTagKey"],
            ],
          },
          row_level_permission_data_set: {
            namespace: "Namespace",
            arn: "Arn", # required
            permission_policy: "GRANT_ACCESS", # required, accepts GRANT_ACCESS, DENY_ACCESS
            format_version: "VERSION_1", # accepts VERSION_1, VERSION_2
            status: "ENABLED", # accepts ENABLED, DISABLED
          },
        },
        semantic_metadata: {
          column_metadata: [
            {
              column_names: ["ColumnName"],
              column_properties: [ # required
                {
                  description: {
                    text: "ColumnDescriptiveText",
                  },
                  additional_notes: {
                    text: "AdditionalNotesText",
                  },
                  semantic_type: {
                    geographical_role: "COUNTRY", # accepts COUNTRY, STATE, COUNTY, CITY, POSTCODE, LONGITUDE, LATITUDE
                  },
                },
              ],
            },
          ],
        },
      },
    },
    semantic_metadata: [
      {
        description: {
          text: "DataSetDescriptiveText", # required
        },
        custom_instructions: [
          {
            inline_custom_instruction: {
              instruction_text: "InlineCustomInstructionText", # required
              uploaded_document_metadata: {
                name: "UploadedDocumentName",
              },
            },
          },
        ],
      },
    ],
  },
})

Response structure


resp.arn #=> String
resp.data_set_id #=> String
resp.ingestion_arn #=> String
resp.ingestion_id #=> String
resp.request_id #=> String
resp.status #=> Integer

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:aws_account_id (required, String) —
The Amazon Web Services account ID.
:data_set_id (required, String) —
The ID for the dataset that you want to update. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
:name (required, String) —
The display name for the dataset.
:physical_table_map (required, Hash<String,Types::PhysicalTable>) —
Declares the physical tables that are available in the underlying data sources.
:logical_table_map (Hash<String,Types::LogicalTable>) —
Configures the combination and transformation of the data from the physical tables. This parameter is used with the legacy data preparation experience.
:import_mode (required, String) —
Indicates whether you want to import the data into SPICE.
:column_groups (Array<Types::ColumnGroup>) —
Groupings of columns that work together in certain Amazon Quick Sight features. Currently, only geospatial hierarchy is supported.
:field_folders (Hash<String,Types::FieldFolder>) —
The folder that contains fields and nested subfolders for your dataset.
:row_level_permission_data_set (Types::RowLevelPermissionDataSet) —
The row-level security configuration for the data you want to create. This parameter is used with the legacy data preparation experience.
:row_level_permission_tag_configuration (Types::RowLevelPermissionTagConfiguration) —
The configuration of tags on a dataset to set row-level security. Row-level security tags are currently supported for anonymous embedding only. This parameter is used with the legacy data preparation experience.
:column_level_permission_rules (Array<Types::ColumnLevelPermissionRule>) —
A set of one or more definitions of a ColumnLevelPermissionRule.
:data_set_usage_configuration (Types::DataSetUsageConfiguration) —
The usage configuration to apply to child datasets that reference this dataset as a source.
:dataset_parameters (Array<Types::DatasetParameter>) —
The parameter declarations of the dataset.
:performance_configuration (Types::PerformanceConfiguration) —
The configuration for the performance optimization of the dataset that contains a UniqueKey configuration.
:data_prep_configuration (Types::DataPrepConfiguration) —
The data preparation configuration for the dataset. This configuration defines the source tables, transformation steps, and destination tables used to prepare the data. Required when using the new data preparation experience.
:semantic_model_configuration (Types::SemanticModelConfiguration) —
The semantic model configuration for the dataset. This configuration defines how the prepared data is structured for an analysis, including table mappings and row-level security configurations. Required when using the new data preparation experience.

Returns:

(Types::UpdateDataSetResponse) —
Returns a response object which responds to the following methods:
- #arn => String
- #data_set_id => String
- #ingestion_arn => String
- #ingestion_id => String
- #request_id => String
- #status => Integer

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 22934

def update_data_set(params = {}, options = {})
  req = build_request(:update_data_set, params)
  req.send_request(options)
end

#update_data_set_permissions(params = {}) ⇒ `Types::UpdateDataSetPermissionsResponse`

Updates the permissions on a dataset.

The permissions resource is arn:aws:quicksight:region:aws-account-id:dataset/data-set-id.

Examples:

Request syntax with placeholder values


resp = client.update_data_set_permissions({
  aws_account_id: "AwsAccountId", # required
  data_set_id: "ResourceId", # required
  grant_permissions: [
    {
      principal: "Principal", # required
      actions: ["String"], # required
    },
  ],
  revoke_permissions: [
    {
      principal: "Principal", # required
      actions: ["String"], # required
    },
  ],
})

Response structure


resp.data_set_arn #=> String
resp.data_set_id #=> String
resp.request_id #=> String
resp.status #=> Integer

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:aws_account_id (required, String) —
The Amazon Web Services account ID.
:data_set_id (required, String) —
The ID for the dataset whose permissions you want to update. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
:grant_permissions (Array<Types::ResourcePermission>) —
The resource permissions that you want to grant to the dataset.
:revoke_permissions (Array<Types::ResourcePermission>) —
The resource permissions that you want to revoke from the dataset.

Returns:

(Types::UpdateDataSetPermissionsResponse) —
Returns a response object which responds to the following methods:
- #data_set_arn => String
- #data_set_id => String
- #request_id => String
- #status => Integer

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 22995

def update_data_set_permissions(params = {}, options = {})
  req = build_request(:update_data_set_permissions, params)
  req.send_request(options)
end

#update_data_source(params = {}) ⇒ `Types::UpdateDataSourceResponse`

Updates a data source.

Examples:

Request syntax with placeholder values


resp = client.update_data_source({
  aws_account_id: "AwsAccountId", # required
  data_source_id: "ResourceId", # required
  name: "ResourceName", # required
  data_source_parameters: {
    amazon_elasticsearch_parameters: {
      domain: "Domain", # required
    },
    athena_parameters: {
      work_group: "WorkGroup",
      role_arn: "RoleArn",
      consumer_account_role_arn: "RoleArn",
      identity_center_configuration: {
        enable_identity_propagation: false,
      },
    },
    aurora_parameters: {
      host: "Host", # required
      port: 1, # required
      database: "Database", # required
    },
    aurora_postgre_sql_parameters: {
      host: "Host", # required
      port: 1, # required
      database: "Database", # required
    },
    aws_iot_analytics_parameters: {
      data_set_name: "DataSetName", # required
    },
    jira_parameters: {
      site_base_url: "SiteBaseUrl", # required
    },
    maria_db_parameters: {
      host: "Host", # required
      port: 1, # required
      database: "Database", # required
    },
    my_sql_parameters: {
      host: "Host", # required
      port: 1, # required
      database: "Database", # required
    },
    oracle_parameters: {
      host: "Host", # required
      port: 1, # required
      database: "Database", # required
      use_service_name: false,
    },
    postgre_sql_parameters: {
      host: "Host", # required
      port: 1, # required
      database: "Database", # required
    },
    presto_parameters: {
      host: "Host", # required
      port: 1, # required
      catalog: "Catalog", # required
    },
    rds_parameters: {
      instance_id: "InstanceId", # required
      database: "Database", # required
    },
    redshift_parameters: {
      host: "Host",
      port: 1,
      database: "Database", # required
      cluster_id: "ClusterId",
      iam_parameters: {
        role_arn: "RoleArn", # required
        database_user: "DatabaseUser",
        database_groups: ["DatabaseGroup"],
        auto_create_database_user: false,
      },
      identity_center_configuration: {
        enable_identity_propagation: false,
      },
    },
    s3_parameters: {
      manifest_file_location: { # required
        bucket: "S3Bucket", # required
        key: "S3Key", # required
      },
      role_arn: "RoleArn",
    },
    s3_tables_parameters: {
      table_bucket_arn: "S3TableBucketArn",
    },
    s3_knowledge_base_parameters: {
      role_arn: "RoleArn",
      bucket_url: "S3Bucket", # required
      metadata_files_location: "MetadataFilesLocation",
    },
    service_now_parameters: {
      site_base_url: "SiteBaseUrl", # required
    },
    snowflake_parameters: {
      host: "Host", # required
      database: "Database", # required
      warehouse: "Warehouse", # required
      authentication_type: "PASSWORD", # accepts PASSWORD, KEYPAIR, TOKEN, X509
      database_access_control_role: "DatabaseAccessControlRole",
      o_auth_parameters: {
        token_provider_url: "TokenProviderUrl", # required
        o_auth_scope: "OAuthScope",
        identity_provider_vpc_connection_properties: {
          vpc_connection_arn: "Arn", # required
        },
        identity_provider_resource_uri: "IdentityProviderResourceUri",
        identity_provider_ca_certificates_bundle_s3_uri: "CACertificatesBundleS3Uri",
      },
    },
    spark_parameters: {
      host: "Host", # required
      port: 1, # required
    },
    sql_server_parameters: {
      host: "Host", # required
      port: 1, # required
      database: "Database", # required
    },
    teradata_parameters: {
      host: "Host", # required
      port: 1, # required
      database: "Database", # required
    },
    twitter_parameters: {
      query: "Query", # required
      max_rows: 1, # required
    },
    amazon_open_search_parameters: {
      domain: "Domain", # required
    },
    exasol_parameters: {
      host: "Host", # required
      port: 1, # required
    },
    databricks_parameters: {
      host: "Host", # required
      port: 1, # required
      sql_endpoint_path: "SqlEndpointPath", # required
    },
    starburst_parameters: {
      host: "Host", # required
      port: 1, # required
      catalog: "Catalog", # required
      product_type: "GALAXY", # accepts GALAXY, ENTERPRISE
      database_access_control_role: "DatabaseAccessControlRole",
      authentication_type: "PASSWORD", # accepts PASSWORD, KEYPAIR, TOKEN, X509
      o_auth_parameters: {
        token_provider_url: "TokenProviderUrl", # required
        o_auth_scope: "OAuthScope",
        identity_provider_vpc_connection_properties: {
          vpc_connection_arn: "Arn", # required
        },
        identity_provider_resource_uri: "IdentityProviderResourceUri",
        identity_provider_ca_certificates_bundle_s3_uri: "CACertificatesBundleS3Uri",
      },
    },
    trino_parameters: {
      host: "Host", # required
      port: 1, # required
      catalog: "Catalog", # required
    },
    big_query_parameters: {
      project_id: "ProjectId", # required
      data_set_region: "DataSetRegion",
    },
    impala_parameters: {
      host: "Host", # required
      port: 1, # required
      database: "Database",
      sql_endpoint_path: "SqlEndpointPath", # required
    },
    custom_connection_parameters: {
      connection_type: "String",
    },
    web_crawler_parameters: {
      web_crawler_auth_type: "NO_AUTH", # required, accepts NO_AUTH, BASIC_AUTH, FORM, SAML
      username_field_xpath: "XpathFields",
      password_field_xpath: "XpathFields",
      username_button_xpath: "XpathFields",
      password_button_xpath: "XpathFields",
      login_page_url: "SiteBaseUrl",
      web_proxy_host_name: "Host",
      web_proxy_port_number: 1,
    },
    confluence_parameters: {
      confluence_url: "SiteBaseUrl", # required
    },
    q_business_parameters: {
      application_arn: "ApplicationArn", # required
    },
    share_point_parameters: {
      share_point_domain: "SharePointDomain", # required
      tenant_id: "SharePointTenantId",
      client_id: "SharePointClientId",
      auth_type: "THREE_LEGGED_OAUTH", # accepts THREE_LEGGED_OAUTH, TWO_LEGGED_OAUTH, SERVICE_ACCOUNT
    },
    google_drive_parameters: {
      auth_type: "THREE_LEGGED_OAUTH", # accepts THREE_LEGGED_OAUTH, TWO_LEGGED_OAUTH, SERVICE_ACCOUNT
    },
    one_drive_parameters: {
      tenant_id: "OneDriveTenantId",
      client_id: "OneDriveClientId",
      auth_type: "THREE_LEGGED_OAUTH", # accepts THREE_LEGGED_OAUTH, TWO_LEGGED_OAUTH, SERVICE_ACCOUNT
    },
    fmkb_parameters: {
      knowledge_base_arn: "FMKBKnowledgeBaseArn", # required
      linked_data_source_ids: ["LinkedDataSourceId"],
    },
  },
  credentials: {
    credential_pair: {
      username: "DbUsername", # required
      password: "Password", # required
      alternate_data_source_parameters: [
        {
          amazon_elasticsearch_parameters: {
            domain: "Domain", # required
          },
          athena_parameters: {
            work_group: "WorkGroup",
            role_arn: "RoleArn",
            consumer_account_role_arn: "RoleArn",
            identity_center_configuration: {
              enable_identity_propagation: false,
            },
          },
          aurora_parameters: {
            host: "Host", # required
            port: 1, # required
            database: "Database", # required
          },
          aurora_postgre_sql_parameters: {
            host: "Host", # required
            port: 1, # required
            database: "Database", # required
          },
          aws_iot_analytics_parameters: {
            data_set_name: "DataSetName", # required
          },
          jira_parameters: {
            site_base_url: "SiteBaseUrl", # required
          },
          maria_db_parameters: {
            host: "Host", # required
            port: 1, # required
            database: "Database", # required
          },
          my_sql_parameters: {
            host: "Host", # required
            port: 1, # required
            database: "Database", # required
          },
          oracle_parameters: {
            host: "Host", # required
            port: 1, # required
            database: "Database", # required
            use_service_name: false,
          },
          postgre_sql_parameters: {
            host: "Host", # required
            port: 1, # required
            database: "Database", # required
          },
          presto_parameters: {
            host: "Host", # required
            port: 1, # required
            catalog: "Catalog", # required
          },
          rds_parameters: {
            instance_id: "InstanceId", # required
            database: "Database", # required
          },
          redshift_parameters: {
            host: "Host",
            port: 1,
            database: "Database", # required
            cluster_id: "ClusterId",
            iam_parameters: {
              role_arn: "RoleArn", # required
              database_user: "DatabaseUser",
              database_groups: ["DatabaseGroup"],
              auto_create_database_user: false,
            },
            identity_center_configuration: {
              enable_identity_propagation: false,
            },
          },
          s3_parameters: {
            manifest_file_location: { # required
              bucket: "S3Bucket", # required
              key: "S3Key", # required
            },
            role_arn: "RoleArn",
          },
          s3_tables_parameters: {
            table_bucket_arn: "S3TableBucketArn",
          },
          s3_knowledge_base_parameters: {
            role_arn: "RoleArn",
            bucket_url: "S3Bucket", # required
            metadata_files_location: "MetadataFilesLocation",
          },
          service_now_parameters: {
            site_base_url: "SiteBaseUrl", # required
          },
          snowflake_parameters: {
            host: "Host", # required
            database: "Database", # required
            warehouse: "Warehouse", # required
            authentication_type: "PASSWORD", # accepts PASSWORD, KEYPAIR, TOKEN, X509
            database_access_control_role: "DatabaseAccessControlRole",
            o_auth_parameters: {
              token_provider_url: "TokenProviderUrl", # required
              o_auth_scope: "OAuthScope",
              identity_provider_vpc_connection_properties: {
                vpc_connection_arn: "Arn", # required
              },
              identity_provider_resource_uri: "IdentityProviderResourceUri",
              identity_provider_ca_certificates_bundle_s3_uri: "CACertificatesBundleS3Uri",
            },
          },
          spark_parameters: {
            host: "Host", # required
            port: 1, # required
          },
          sql_server_parameters: {
            host: "Host", # required
            port: 1, # required
            database: "Database", # required
          },
          teradata_parameters: {
            host: "Host", # required
            port: 1, # required
            database: "Database", # required
          },
          twitter_parameters: {
            query: "Query", # required
            max_rows: 1, # required
          },
          amazon_open_search_parameters: {
            domain: "Domain", # required
          },
          exasol_parameters: {
            host: "Host", # required
            port: 1, # required
          },
          databricks_parameters: {
            host: "Host", # required
            port: 1, # required
            sql_endpoint_path: "SqlEndpointPath", # required
          },
          starburst_parameters: {
            host: "Host", # required
            port: 1, # required
            catalog: "Catalog", # required
            product_type: "GALAXY", # accepts GALAXY, ENTERPRISE
            database_access_control_role: "DatabaseAccessControlRole",
            authentication_type: "PASSWORD", # accepts PASSWORD, KEYPAIR, TOKEN, X509
            o_auth_parameters: {
              token_provider_url: "TokenProviderUrl", # required
              o_auth_scope: "OAuthScope",
              identity_provider_vpc_connection_properties: {
                vpc_connection_arn: "Arn", # required
              },
              identity_provider_resource_uri: "IdentityProviderResourceUri",
              identity_provider_ca_certificates_bundle_s3_uri: "CACertificatesBundleS3Uri",
            },
          },
          trino_parameters: {
            host: "Host", # required
            port: 1, # required
            catalog: "Catalog", # required
          },
          big_query_parameters: {
            project_id: "ProjectId", # required
            data_set_region: "DataSetRegion",
          },
          impala_parameters: {
            host: "Host", # required
            port: 1, # required
            database: "Database",
            sql_endpoint_path: "SqlEndpointPath", # required
          },
          custom_connection_parameters: {
            connection_type: "String",
          },
          web_crawler_parameters: {
            web_crawler_auth_type: "NO_AUTH", # required, accepts NO_AUTH, BASIC_AUTH, FORM, SAML
            username_field_xpath: "XpathFields",
            password_field_xpath: "XpathFields",
            username_button_xpath: "XpathFields",
            password_button_xpath: "XpathFields",
            login_page_url: "SiteBaseUrl",
            web_proxy_host_name: "Host",
            web_proxy_port_number: 1,
          },
          confluence_parameters: {
            confluence_url: "SiteBaseUrl", # required
          },
          q_business_parameters: {
            application_arn: "ApplicationArn", # required
          },
          share_point_parameters: {
            share_point_domain: "SharePointDomain", # required
            tenant_id: "SharePointTenantId",
            client_id: "SharePointClientId",
            auth_type: "THREE_LEGGED_OAUTH", # accepts THREE_LEGGED_OAUTH, TWO_LEGGED_OAUTH, SERVICE_ACCOUNT
          },
          google_drive_parameters: {
            auth_type: "THREE_LEGGED_OAUTH", # accepts THREE_LEGGED_OAUTH, TWO_LEGGED_OAUTH, SERVICE_ACCOUNT
          },
          one_drive_parameters: {
            tenant_id: "OneDriveTenantId",
            client_id: "OneDriveClientId",
            auth_type: "THREE_LEGGED_OAUTH", # accepts THREE_LEGGED_OAUTH, TWO_LEGGED_OAUTH, SERVICE_ACCOUNT
          },
          fmkb_parameters: {
            knowledge_base_arn: "FMKBKnowledgeBaseArn", # required
            linked_data_source_ids: ["LinkedDataSourceId"],
          },
        },
      ],
    },
    copy_source_arn: "CopySourceArn",
    secret_arn: "SecretArn",
    key_pair_credentials: {
      key_pair_username: "DbUsername", # required
      private_key: "PrivateKey", # required
      private_key_passphrase: "PrivateKeyPassphrase",
    },
    web_proxy_credentials: {
      web_proxy_username: "DbUsername", # required
      web_proxy_password: "Password", # required
    },
    o_auth_client_credentials: {
      client_id: "OAuthClientId",
      client_secret: "OAuthClientSecret",
      username: "OAuthUsername",
    },
  },
  vpc_connection_properties: {
    vpc_connection_arn: "Arn", # required
  },
  ssl_properties: {
    disable_ssl: false,
  },
})

Response structure


resp.arn #=> String
resp.data_source_id #=> String
resp.update_status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED", "DELETED"
resp.request_id #=> String
resp.status #=> Integer

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:aws_account_id (required, String) —
The Amazon Web Services account ID.
:data_source_id (required, String) —
The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
:name (required, String) —
A display name for the data source.
:data_source_parameters (Types::DataSourceParameters) —
The parameters that Amazon Quick Sight uses to connect to your underlying source.
:credentials (Types::DataSourceCredentials) —
The credentials that Amazon Quick Sight that uses to connect to your underlying source. Currently, only credentials based on user name and password are supported.
:vpc_connection_properties (Types::VpcConnectionProperties) —
Use this parameter only when you want Amazon Quick Sight to use a VPC connection when connecting to your underlying source.
:ssl_properties (Types::SslProperties) —
Secure Socket Layer (SSL) properties that apply when Amazon Quick Sight connects to your underlying source.

Returns:

(Types::UpdateDataSourceResponse) —
Returns a response object which responds to the following methods:
- #arn => String
- #data_source_id => String
- #update_status => String
- #request_id => String
- #status => Integer

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 23501

def update_data_source(params = {}, options = {})
  req = build_request(:update_data_source, params)
  req.send_request(options)
end

#update_data_source_permissions(params = {}) ⇒ `Types::UpdateDataSourcePermissionsResponse`

Updates the permissions to a data source.

Examples:

Request syntax with placeholder values


resp = client.update_data_source_permissions({
  aws_account_id: "AwsAccountId", # required
  data_source_id: "ResourceId", # required
  grant_permissions: [
    {
      principal: "Principal", # required
      actions: ["String"], # required
    },
  ],
  revoke_permissions: [
    {
      principal: "Principal", # required
      actions: ["String"], # required
    },
  ],
})

Response structure


resp.data_source_arn #=> String
resp.data_source_id #=> String
resp.request_id #=> String
resp.status #=> Integer

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:aws_account_id (required, String) —
The Amazon Web Services account ID.
:data_source_id (required, String) —
The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
:grant_permissions (Array<Types::ResourcePermission>) —
A list of resource permissions that you want to grant on the data source.
:revoke_permissions (Array<Types::ResourcePermission>) —
A list of resource permissions that you want to revoke on the data source.

Returns:

(Types::UpdateDataSourcePermissionsResponse) —
Returns a response object which responds to the following methods:
- #data_source_arn => String
- #data_source_id => String
- #request_id => String
- #status => Integer

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 23560

def update_data_source_permissions(params = {}, options = {})
  req = build_request(:update_data_source_permissions, params)
  req.send_request(options)
end

#update_default_q_business_application(params = {}) ⇒ `Types::UpdateDefaultQBusinessApplicationResponse`

Updates a Amazon Q Business application that is linked to a Quick Sight account.

Examples:

Request syntax with placeholder values


resp = client.update_default_q_business_application({
  aws_account_id: "AwsAccountId", # required
  namespace: "Namespace",
  application_id: "LimitedString", # required
})

Response structure


resp.request_id #=> String
resp.status #=> Integer

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:aws_account_id (required, String) —
The ID of the Quick Sight account that is connected to the Amazon Q Business application that you want to update.
:namespace (String) —
The Quick Sight namespace that contains the linked Amazon Q Business application. If this field is left blank, the default namespace is used. Currently, the default namespace is the only valid value for this parameter.
:application_id (required, String) —
The ID of the Amazon Q Business application that you want to update.

Returns:

(Types::UpdateDefaultQBusinessApplicationResponse) —
Returns a response object which responds to the following methods:
- #request_id => String
- #status => Integer

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 23603

def update_default_q_business_application(params = {}, options = {})
  req = build_request(:update_default_q_business_application, params)
  req.send_request(options)
end

#update_dlp_setting(params = {}) ⇒ `Types::UpdateDlpSettingResponse`

Updates an existing DLP setting configuration in an Amazon Web Services account. Fields that are omitted from the request retain their current values.

Examples:

Request syntax with placeholder values


resp = client.update_dlp_setting({
  aws_account_id: "AwsAccountId", # required
  dlp_setting_id: "DlpSettingId", # required
  name: "DlpSettingName",
  provider_type: "MICROSOFT_PURVIEW", # accepts MICROSOFT_PURVIEW
  provider_config: {
    microsoft_purview: {
      credentials: { # required
        secret_arn: "SecretManagerArn", # required
      },
      label_action_mappings: [ # required
        {
          label_id: "LabelId", # required
          label_name: "LabelName", # required
          action: "ALLOW", # required, accepts ALLOW, WARN, BLOCK
        },
      ],
      unmapped_action: "ALLOW", # required, accepts ALLOW, WARN, BLOCK
    },
  },
  provider_outage_action: "ALLOW", # accepts ALLOW, WARN, BLOCK
  enabled: false,
})

Response structure


resp.arn #=> String
resp.dlp_setting_id #=> String
resp.request_id #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:aws_account_id (required, String) —
The ID of the Amazon Web Services account that contains the DLP setting that you want to update.
:dlp_setting_id (required, String) —
The ID of the DLP setting that you want to update.
:name (String) —
An updated display name for the DLP setting.
:provider_type (String) —
An updated DLP provider type. Currently, the only supported value is MICROSOFT_PURVIEW.
:provider_config (Types::ProviderConfig) —
An updated provider-specific configuration for the DLP integration. This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
:provider_outage_action (String) —
An updated behavior to apply when the DLP provider is unreachable. Valid values are ALLOW, WARN, and BLOCK.
:enabled (Boolean) —
Specifies whether DLP enforcement is active for this setting. Set to true to enable enforcement, or false to disable it.

Returns:

(Types::UpdateDlpSettingResponse) —
Returns a response object which responds to the following methods:
- #arn => String
- #dlp_setting_id => String
- #request_id => String

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 23681

def update_dlp_setting(params = {}, options = {})
  req = build_request(:update_dlp_setting, params)
  req.send_request(options)
end

#update_flow(params = {}) ⇒ `Types::UpdateFlowResponse`

Updates an existing flow. Supply only the fields you want to change. Updates both DRAFT and PUBLISHED versions. When FlowDefinition is provided, all existing steps are replaced with the new definition.

Examples:

Request syntax with placeholder values


resp = client.update_flow({
  aws_account_id: "AccountId", # required
  flow_id: "FlowId", # required
  name: "TitleInput",
  description: "FlowDescriptionInput",
  flow_definition: {
  },
  client_token: "UpdateFlowRequestClientTokenString",
})

Response structure


resp.arn #=> String
resp.flow_id #=> String
resp.request_id #=> String
resp.status #=> Integer

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:aws_account_id (required, String) —
The ID of the Amazon Web Services account that contains the flow that you are updating.
:flow_id (required, String) —
The unique identifier of the flow to update.
:name (String) —
Updated display name for the flow. Omit to preserve the existing name.
:description (String) —
Updated description for the flow. Omit to preserve the existing description.
:flow_definition (Hash, Array, String, Numeric, Boolean) —
The definition of the flow, specifying the steps and configurations. This is the flow definition in Quick Flow's internal format. The format is subject to change. When provided, all existing steps are replaced. Omit to preserve the existing definition.

Always derive or depend on the flow definition from the DescribeFlow operation to ensure you are working with the latest format.

Document type used to carry open content (Hash,Array,String,Numeric,Boolean). A document type value is serialized using the same format as its surroundings and requires no additional encoding or escaping.
:client_token (String) —
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

A suitable default value is auto-generated. You should normally not need to pass this option.**

Returns:

(Types::UpdateFlowResponse) —
Returns a response object which responds to the following methods:
- #arn => String
- #flow_id => String
- #request_id => String
- #status => Integer

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 23757

def update_flow(params = {}, options = {})
  req = build_request(:update_flow, params)
  req.send_request(options)
end

#update_flow_permissions(params = {}) ⇒ `Types::UpdateFlowPermissionsOutput`

Updates permissions against principals on a flow.

Examples:

Request syntax with placeholder values


resp = client.update_flow_permissions({
  aws_account_id: "AccountId", # required
  flow_id: "FlowId", # required
  grant_permissions: [
    {
      actions: ["ActionsListMemberString"], # required
      principal: "PermissionPrincipalString", # required
    },
  ],
  revoke_permissions: [
    {
      actions: ["ActionsListMemberString"], # required
      principal: "PermissionPrincipalString", # required
    },
  ],
})

Response structure


resp.status #=> Integer
resp.arn #=> String
resp.permissions #=> Array
resp.permissions[0].actions #=> Array
resp.permissions[0].actions[0] #=> String
resp.permissions[0].principal #=> String
resp.request_id #=> String
resp.flow_id #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:aws_account_id (required, String) —
The ID of the Amazon Web Services account that contains the flow you are updating permissions against.
:flow_id (required, String) —
The unique identifier of the flow to update permissions for.
:grant_permissions (Array<Types::Permission>) —
The permissions that you want to grant on this flow.
:revoke_permissions (Array<Types::Permission>) —
The permissions that you want to revoke from this flow.

Returns:

(Types::UpdateFlowPermissionsOutput) —
Returns a response object which responds to the following methods:
- #status => Integer
- #arn => String
- #permissions => Array<Types::Permission>
- #request_id => String
- #flow_id => String

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 23819

def update_flow_permissions(params = {}, options = {})
  req = build_request(:update_flow_permissions, params)
  req.send_request(options)
end

#update_folder(params = {}) ⇒ `Types::UpdateFolderResponse`

Updates the name of a folder.

Examples:

Request syntax with placeholder values


resp = client.update_folder({
  aws_account_id: "AwsAccountId", # required
  folder_id: "RestrictiveResourceId", # required
  name: "FolderName", # required
})

Response structure


resp.status #=> Integer
resp.arn #=> String
resp.folder_id #=> String
resp.request_id #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:aws_account_id (required, String) —
The ID for the Amazon Web Services account that contains the folder to update.
:folder_id (required, String) —
The ID of the folder.
:name (required, String) —
The name of the folder.

Returns:

(Types::UpdateFolderResponse) —
Returns a response object which responds to the following methods:
- #status => Integer
- #arn => String
- #folder_id => String
- #request_id => String

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 23862

def update_folder(params = {}, options = {})
  req = build_request(:update_folder, params)
  req.send_request(options)
end

#update_folder_permissions(params = {}) ⇒ `Types::UpdateFolderPermissionsResponse`

Updates permissions of a folder.

Examples:

Request syntax with placeholder values


resp = client.update_folder_permissions({
  aws_account_id: "AwsAccountId", # required
  folder_id: "RestrictiveResourceId", # required
  grant_permissions: [
    {
      principal: "Principal", # required
      actions: ["String"], # required
    },
  ],
  revoke_permissions: [
    {
      principal: "Principal", # required
      actions: ["String"], # required
    },
  ],
})

Response structure


resp.status #=> Integer
resp.arn #=> String
resp.folder_id #=> String
resp.permissions #=> Array
resp.permissions[0].principal #=> String
resp.permissions[0].actions #=> Array
resp.permissions[0].actions[0] #=> String
resp.request_id #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:aws_account_id (required, String) —
The ID for the Amazon Web Services account that contains the folder to update.
:folder_id (required, String) —
The ID of the folder.
:grant_permissions (Array<Types::ResourcePermission>) —
The permissions that you want to grant on a resource. Namespace ARNs are not supported Principal values for folder permissions.
:revoke_permissions (Array<Types::ResourcePermission>) —
The permissions that you want to revoke from a resource. Namespace ARNs are not supported Principal values for folder permissions.

Returns:

(Types::UpdateFolderPermissionsResponse) —
Returns a response object which responds to the following methods:
- #status => Integer
- #arn => String
- #folder_id => String
- #permissions => Array<Types::ResourcePermission>
- #request_id => String

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 23926

def update_folder_permissions(params = {}, options = {})
  req = build_request(:update_folder_permissions, params)
  req.send_request(options)
end

#update_group(params = {}) ⇒ `Types::UpdateGroupResponse`

Changes a group description.

Examples:

Request syntax with placeholder values


resp = client.update_group({
  group_name: "GroupName", # required
  description: "GroupDescription",
  aws_account_id: "AwsAccountId", # required
  namespace: "Namespace", # required
})

Response structure


resp.group.arn #=> String
resp.group.group_name #=> String
resp.group.description #=> String
resp.group.principal_id #=> String
resp.request_id #=> String
resp.status #=> Integer

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:group_name (required, String) —
The name of the group that you want to update.
:description (String) —
The description for the group that you want to update.
:aws_account_id (required, String) —
The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon Quick Sight account.
:namespace (required, String) —
The namespace of the group that you want to update.

Returns:

(Types::UpdateGroupResponse) —
Returns a response object which responds to the following methods:
- #group => Types::Group
- #request_id => String
- #status => Integer

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 23975

def update_group(params = {}, options = {})
  req = build_request(:update_group, params)
  req.send_request(options)
end

#update_iam_policy_assignment(params = {}) ⇒ `Types::UpdateIAMPolicyAssignmentResponse`

Updates an existing IAM policy assignment. This operation updates only the optional parameter or parameters that are specified in the request. This overwrites all of the users included in Identities.

Examples:

Request syntax with placeholder values


resp = client.update_iam_policy_assignment({
  aws_account_id: "AwsAccountId", # required
  assignment_name: "IAMPolicyAssignmentName", # required
  namespace: "Namespace", # required
  assignment_status: "ENABLED", # accepts ENABLED, DRAFT, DISABLED
  policy_arn: "Arn",
  identities: {
    "String" => ["IdentityName"],
  },
})

Response structure


resp.assignment_name #=> String
resp.assignment_id #=> String
resp.policy_arn #=> String
resp.identities #=> Hash
resp.identities["String"] #=> Array
resp.identities["String"][0] #=> String
resp.assignment_status #=> String, one of "ENABLED", "DRAFT", "DISABLED"
resp.request_id #=> String
resp.status #=> Integer

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:aws_account_id (required, String) —
The ID of the Amazon Web Services account that contains the IAM policy assignment.
:assignment_name (required, String) —
The name of the assignment, also called a rule. The name must be unique within the Amazon Web Services account.
:namespace (required, String) —
The namespace of the assignment.
:assignment_status (String) —
The status of the assignment. Possible values are as follows:
- ENABLED - Anything specified in this assignment is used when creating the data source.
- DISABLED - This assignment isn't used when creating the data source.
- DRAFT - This assignment is an unfinished draft and isn't used when creating the data source.
:policy_arn (String) —
The ARN for the IAM policy to apply to the Amazon Quick Sight users and groups specified in this assignment.
:identities (Hash<String,Array>) —
The Amazon Quick Sight users, groups, or both that you want to assign the policy to.

Returns:

(Types::UpdateIAMPolicyAssignmentResponse) —
Returns a response object which responds to the following methods:
- #assignment_name => String
- #assignment_id => String
- #policy_arn => String
- #identities => Hash<String,Array<String>>
- #assignment_status => String
- #request_id => String
- #status => Integer

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 24054

def update_iam_policy_assignment(params = {}, options = {})
  req = build_request(:update_iam_policy_assignment, params)
  req.send_request(options)
end

#update_identity_propagation_config(params = {}) ⇒ `Types::UpdateIdentityPropagationConfigResponse`

Adds or updates services and authorized targets to configure what the Quick Sight IAM Identity Center application can access.

This operation is only supported for Quick Sight accounts using IAM Identity Center

Examples:

Request syntax with placeholder values


resp = client.update_identity_propagation_config({
  aws_account_id: "AwsAccountId", # required
  service: "REDSHIFT", # required, accepts REDSHIFT, QBUSINESS, ATHENA, GLUE_DATA_CATALOG
  authorized_targets: ["String"],
})

Response structure


resp.request_id #=> String
resp.status #=> Integer

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:aws_account_id (required, String) —
The ID of the Amazon Web Services account that contains the identity propagation configuration that you want to update.
:service (required, String) —
The name of the Amazon Web Services service that contains the authorized targets that you want to add or update.
:authorized_targets (Array<String>) —
Specifies a list of application ARNs that represent the authorized targets for a service.

Returns:

(Types::UpdateIdentityPropagationConfigResponse) —
Returns a response object which responds to the following methods:
- #request_id => String
- #status => Integer

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 24099

def update_identity_propagation_config(params = {}, options = {})
  req = build_request(:update_identity_propagation_config, params)
  req.send_request(options)
end

#update_ip_restriction(params = {}) ⇒ `Types::UpdateIpRestrictionResponse`

Updates the content and status of IP rules. Traffic from a source is allowed when the source satisfies either the IpRestrictionRule, VpcIdRestrictionRule, or VpcEndpointIdRestrictionRule. To use this operation, you must provide the entire map of rules. You can use the DescribeIpRestriction operation to get the current rule map.

Examples:

Request syntax with placeholder values


resp = client.update_ip_restriction({
  aws_account_id: "AwsAccountId", # required
  ip_restriction_rule_map: {
    "CIDR" => "IpRestrictionRuleDescription",
  },
  vpc_id_restriction_rule_map: {
    "VpcId" => "VpcIdRestrictionRuleDescription",
  },
  vpc_endpoint_id_restriction_rule_map: {
    "VpcEndpointId" => "VpcEndpointIdRestrictionRuleDescription",
  },
  enabled: false,
})

Response structure


resp.aws_account_id #=> String
resp.request_id #=> String
resp.status #=> Integer

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:aws_account_id (required, String) —
The ID of the Amazon Web Services account that contains the IP rules.
:ip_restriction_rule_map (Hash<String,String>) —
A map that describes the updated IP rules with CIDR ranges and descriptions.
:vpc_id_restriction_rule_map (Hash<String,String>) —
A map of VPC IDs and their corresponding rules. When you configure this parameter, traffic from all VPC endpoints that are present in the specified VPC is allowed.
:vpc_endpoint_id_restriction_rule_map (Hash<String,String>) —
A map of allowed VPC endpoint IDs and their corresponding rule descriptions.
:enabled (Boolean) —
A value that specifies whether IP rules are turned on.

Returns:

(Types::UpdateIpRestrictionResponse) —
Returns a response object which responds to the following methods:
- #aws_account_id => String
- #request_id => String
- #status => Integer

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 24161

def update_ip_restriction(params = {}, options = {})
  req = build_request(:update_ip_restriction, params)
  req.send_request(options)
end

#update_key_registration(params = {}) ⇒ `Types::UpdateKeyRegistrationResponse`

Updates a customer managed key in a Quick Sight account.

Examples:

Request syntax with placeholder values


resp = client.update_key_registration({
  aws_account_id: "AwsAccountId", # required
  key_registration: [ # required
    {
      key_arn: "String",
      default_key: false,
    },
  ],
})

Response structure


resp.failed_key_registration #=> Array
resp.failed_key_registration[0].key_arn #=> String
resp.failed_key_registration[0].message #=> String
resp.failed_key_registration[0].status_code #=> Integer
resp.failed_key_registration[0].sender_fault #=> Boolean
resp.successful_key_registration #=> Array
resp.successful_key_registration[0].key_arn #=> String
resp.successful_key_registration[0].status_code #=> Integer
resp.request_id #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:aws_account_id (required, String) —
The ID of the Amazon Web Services account that contains the customer managed key registration that you want to update.
:key_registration (required, Array<Types::RegisteredCustomerManagedKey>) —
A list of RegisteredCustomerManagedKey objects to be updated to the Quick Sight account.

Returns:

(Types::UpdateKeyRegistrationResponse) —
Returns a response object which responds to the following methods:
- #failed_key_registration => Array<Types::FailedKeyRegistrationEntry>
- #successful_key_registration => Array<Types::SuccessfulKeyRegistrationEntry>
- #request_id => String

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 24210

def update_key_registration(params = {}, options = {})
  req = build_request(:update_key_registration, params)
  req.send_request(options)
end

#update_knowledge_base(params = {}) ⇒ `Types::UpdateKnowledgeBaseResponse`

Updates the properties of an existing knowledge base.

Examples:

Request syntax with placeholder values


resp = client.update_knowledge_base({
  aws_account_id: "KbAwsAccountId", # required
  knowledge_base_id: "KnowledgeBaseId", # required
  name: "KnowledgeBaseName",
  description: "KnowledgeBaseDescription",
  knowledge_base_configuration: {
    template_configuration: {
      template: {
      },
    },
  },
  media_extraction_configuration: {
    image_extraction_configuration: {
      image_extraction_status: "ENABLED", # required, accepts ENABLED, DISABLED
    },
    audio_extraction_configuration: {
      audio_extraction_status: "ENABLED", # required, accepts ENABLED, DISABLED
    },
    video_extraction_configuration: {
      video_extraction_status: "ENABLED", # required, accepts ENABLED, DISABLED
      video_extraction_type: "AUDIO_TRANSCRIPTION_ONLY", # accepts AUDIO_TRANSCRIPTION_ONLY, VISUAL_CONTENT_AND_AUDIO_TRANSCRIPTION
    },
  },
  is_email_notification_opted_for_ingestion_failures: false,
  access_control_configuration: {
    is_acl_enabled: false,
  },
})

Response structure


resp.knowledge_base_arn #=> String
resp.knowledge_base_id #=> String
resp.request_id #=> String
resp.status #=> Integer

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:aws_account_id (required, String) —
The ID of the Amazon Web Services account that contains the knowledge base.
:knowledge_base_id (required, String) —
The unique identifier for the knowledge base.
:name (String) —
The name of the knowledge base. If you don't specify a name, the existing name is retained.
:description (String) —
A description for the knowledge base. If you don't specify a description, the existing description is retained.
:knowledge_base_configuration (Types::KnowledgeBaseConfiguration) —
The configuration settings for a knowledge base.
:media_extraction_configuration (Types::MediaExtractionConfiguration) —
The configuration for media extraction from knowledge base documents.
:is_email_notification_opted_for_ingestion_failures (Boolean) —
Specifies whether email notifications are enabled for ingestion failures.
:access_control_configuration (Types::AccessControlConfiguration) —
The access control configuration for the knowledge base. If you don't specify this parameter, the existing setting is retained.

Returns:

(Types::UpdateKnowledgeBaseResponse) —
Returns a response object which responds to the following methods:
- #knowledge_base_arn => String
- #knowledge_base_id => String
- #request_id => String
- #status => Integer

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 24295

def update_knowledge_base(params = {}, options = {})
  req = build_request(:update_knowledge_base, params)
  req.send_request(options)
end

#update_knowledge_base_permissions(params = {}) ⇒ `Types::UpdateKnowledgeBasePermissionsResponse`

Updates the resource permissions for a knowledge base.

Examples:

Request syntax with placeholder values


resp = client.update_knowledge_base_permissions({
  aws_account_id: "KbAwsAccountId", # required
  knowledge_base_id: "KnowledgeBaseId", # required
  grant_permissions: [
    {
      principal: "Principal", # required
      actions: ["String"], # required
    },
  ],
  revoke_permissions: [
    {
      principal: "Principal", # required
      actions: ["String"], # required
    },
  ],
})

Response structure


resp.knowledge_base_arn #=> String
resp.knowledge_base_id #=> String
resp.permissions #=> Array
resp.permissions[0].principal #=> String
resp.permissions[0].actions #=> Array
resp.permissions[0].actions[0] #=> String
resp.request_id #=> String
resp.status #=> Integer

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:aws_account_id (required, String) —
The ID of the Amazon Web Services account that contains the knowledge base.
:knowledge_base_id (required, String) —
The unique identifier for the knowledge base.
:grant_permissions (Array<Types::ResourcePermission>) —
The resource permissions that you want to grant on the knowledge base.
:revoke_permissions (Array<Types::ResourcePermission>) —
The resource permissions that you want to revoke from the knowledge base.

Returns:

(Types::UpdateKnowledgeBasePermissionsResponse) —
Returns a response object which responds to the following methods:
- #knowledge_base_arn => String
- #knowledge_base_id => String
- #permissions => Array<Types::ResourcePermission>
- #request_id => String
- #status => Integer

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 24358

def update_knowledge_base_permissions(params = {}, options = {})
  req = build_request(:update_knowledge_base_permissions, params)
  req.send_request(options)
end

#update_limits_profile(params = {}) ⇒ `Types::UpdateLimitsProfileResponse`

Updates the properties of an existing limits profile.

Examples:

Request syntax with placeholder values


resp = client.update_limits_profile({
  profile_id: "ProfileId", # required
  account_id: "AwsAccountId", # required
  profile_name: "ProfileName",
  description: "ProfileDescription",
  resource_limits: {
    "INDEX_STORAGE" => {
      max_value: 1, # required
      unit: "MB", # required, accepts MB, GB, HOURS, DAYS
    },
  },
})

Response structure


resp.arn #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:profile_id (required, String) —
The unique identifier for the limits profile to update.
:account_id (required, String) —
The ID of the Amazon Web Services account that contains the limits profile.
:profile_name (String) —
A new display name for the limits profile.
:description (String) —
A new description for the limits profile.
:resource_limits (Hash<String,Types::ProfileLimitValue>) —
A map of resource types to their updated limit values.

Returns:

(Types::UpdateLimitsProfileResponse) —
Returns a response object which responds to the following methods:
- #arn => String

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 24408

def update_limits_profile(params = {}, options = {})
  req = build_request(:update_limits_profile, params)
  req.send_request(options)
end

#update_o_auth_client_application(params = {}) ⇒ `Types::UpdateOAuthClientApplicationResponse`

Updates an OAuthClientApplication.

Examples:

Request syntax with placeholder values


resp = client.update_o_auth_client_application({
  aws_account_id: "AwsAccountId", # required
  o_auth_client_application_id: "OAuthClientApplicationId", # required
  name: "ResourceName", # required
  client_id: "OAuthClientId",
  client_secret: "OAuthClientSecret",
  o_auth_token_endpoint_url: "OAuthTokenEndpointUrl",
  o_auth_authorization_endpoint_url: "OAuthAuthorizationEndpointUrl",
  o_auth_scopes: "OAuthScopesString",
  data_source_type: "ADOBE_ANALYTICS", # accepts ADOBE_ANALYTICS, AMAZON_ELASTICSEARCH, ATHENA, AURORA, AURORA_POSTGRESQL, AWS_IOT_ANALYTICS, GITHUB, JIRA, MARIADB, MYSQL, ORACLE, POSTGRESQL, PRESTO, REDSHIFT, S3, S3_TABLES, SALESFORCE, SERVICENOW, SNOWFLAKE, SPARK, SQLSERVER, TERADATA, TWITTER, TIMESTREAM, AMAZON_OPENSEARCH, EXASOL, DATABRICKS, STARBURST, TRINO, BIGQUERY, GOOGLESHEETS, GOOGLE_DRIVE, CONFLUENCE, SHAREPOINT, ONE_DRIVE, WEB_CRAWLER, S3_KNOWLEDGE_BASE, QBUSINESS
  identity_provider_vpc_connection_properties: {
    vpc_connection_arn: "Arn", # required
  },
})

Response structure


resp.arn #=> String
resp.o_auth_client_application_id #=> String
resp.update_status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED", "DELETED"
resp.request_id #=> String
resp.status #=> Integer

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:aws_account_id (required, String) —
The Amazon Web Services account ID.
:o_auth_client_application_id (required, String) —
The ID of the OAuthClientApplication that you want to update.
:name (required, String) —
The display name for the OAuthClientApplication.
:client_id (String) —
The client ID of the OAuth application that is registered with the identity provider.
:client_secret (String) —
The client secret of the OAuth application that is registered with the identity provider.
:o_auth_token_endpoint_url (String) —
The token endpoint URL of the identity provider that is used to obtain access tokens.
:o_auth_authorization_endpoint_url (String) —
The authorization endpoint URL of the identity provider that is used to obtain authorization codes.
:o_auth_scopes (String) —
The OAuth scopes that are requested when the OAuthClientApplication obtains an access token from the identity provider.
:data_source_type (String) —
The type of data source that the OAuthClientApplication is used with. Valid values are SNOWFLAKE.
:identity_provider_vpc_connection_properties (Types::VpcConnectionProperties) —
VPC connection properties.

Returns:

(Types::UpdateOAuthClientApplicationResponse) —
Returns a response object which responds to the following methods:
- #arn => String
- #o_auth_client_application_id => String
- #update_status => String
- #request_id => String
- #status => Integer

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 24488

def update_o_auth_client_application(params = {}, options = {})
  req = build_request(:update_o_auth_client_application, params)
  req.send_request(options)
end

#update_public_sharing_settings(params = {}) ⇒ `Types::UpdatePublicSharingSettingsResponse`

This API controls public sharing settings for your entire Quick Sight account, affecting data security and access. When you enable public sharing:

Dashboards can be shared publicly
This setting affects your entire Amazon Web Services account and all Quick Sight users

Before proceeding: Ensure you understand the security implications and have proper IAM permissions configured.

Use the UpdatePublicSharingSettings operation to turn on or turn off the public sharing settings of an Amazon Quick Sight dashboard.

To use this operation, turn on session capacity pricing for your Amazon Quick Sight account.

Before you can turn on public sharing on your account, make sure to give public sharing permissions to an administrative user in the Identity and Access Management (IAM) console. For more information on using IAM with Amazon Quick Sight, see Using Quick with IAM in the Amazon Quick Sight User Guide.

Examples:

Request syntax with placeholder values


resp = client.update_public_sharing_settings({
  aws_account_id: "AwsAccountId", # required
  public_sharing_enabled: false,
})

Response structure


resp.request_id #=> String
resp.status #=> Integer

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:aws_account_id (required, String) —
The Amazon Web Services account ID associated with your Amazon Quick Sight subscription.
:public_sharing_enabled (Boolean) —
A Boolean value that indicates whether public sharing is turned on for an Quick account.

Returns:

(Types::UpdatePublicSharingSettingsResponse) —
Returns a response object which responds to the following methods:
- #request_id => String
- #status => Integer

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 24551

def update_public_sharing_settings(params = {}, options = {})
  req = build_request(:update_public_sharing_settings, params)
  req.send_request(options)
end

#update_q_personalization_configuration(params = {}) ⇒ `Types::UpdateQPersonalizationConfigurationResponse`

Updates a personalization configuration.

Examples:

Request syntax with placeholder values


resp = client.update_q_personalization_configuration({
  aws_account_id: "AwsAccountId", # required
  personalization_mode: "ENABLED", # required, accepts ENABLED, DISABLED
})

Response structure


resp.personalization_mode #=> String, one of "ENABLED", "DISABLED"
resp.request_id #=> String
resp.status #=> Integer

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:aws_account_id (required, String) —
The ID of the Amazon Web Services account account that contains the personalization configuration that the user wants to update.
:personalization_mode (required, String) —
An option to allow Amazon Quick Sight to customize data stories with user specific metadata, specifically location and job information, in your IAM Identity Center instance.

Returns:

(Types::UpdateQPersonalizationConfigurationResponse) —
Returns a response object which responds to the following methods:
- #personalization_mode => String
- #request_id => String
- #status => Integer

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 24590

def update_q_personalization_configuration(params = {}, options = {})
  req = build_request(:update_q_personalization_configuration, params)
  req.send_request(options)
end

#update_quick_sight_q_search_configuration(params = {}) ⇒ `Types::UpdateQuickSightQSearchConfigurationResponse`

Updates the state of a Quick Sight Q Search configuration.

Examples:

Request syntax with placeholder values


resp = client.update_quick_sight_q_search_configuration({
  aws_account_id: "AwsAccountId", # required
  q_search_status: "ENABLED", # required, accepts ENABLED, DISABLED
})

Response structure


resp.q_search_status #=> String, one of "ENABLED", "DISABLED"
resp.request_id #=> String
resp.status #=> Integer

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:aws_account_id (required, String) —
The ID of the Amazon Web Services account that contains the Quick Sight Q Search configuration that you want to update.
:q_search_status (required, String) —
The status of the Quick Sight Q Search configuration that the user wants to update.

Returns:

(Types::UpdateQuickSightQSearchConfigurationResponse) —
Returns a response object which responds to the following methods:
- #q_search_status => String
- #request_id => String
- #status => Integer

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 24628

def update_quick_sight_q_search_configuration(params = {}, options = {})
  req = build_request(:update_quick_sight_q_search_configuration, params)
  req.send_request(options)
end

#update_refresh_schedule(params = {}) ⇒ `Types::UpdateRefreshScheduleResponse`

Updates a refresh schedule for a dataset.

Examples:

Request syntax with placeholder values


resp = client.update_refresh_schedule({
  data_set_id: "ResourceId", # required
  aws_account_id: "AwsAccountId", # required
  schedule: { # required
    schedule_id: "String", # required
    schedule_frequency: { # required
      interval: "MINUTE15", # required, accepts MINUTE15, MINUTE30, HOURLY, DAILY, WEEKLY, MONTHLY
      refresh_on_day: {
        day_of_week: "SUNDAY", # accepts SUNDAY, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY
        day_of_month: "DayOfMonth",
      },
      timezone: "String",
      time_of_the_day: "String",
    },
    start_after_date_time: Time.now,
    refresh_type: "INCREMENTAL_REFRESH", # required, accepts INCREMENTAL_REFRESH, FULL_REFRESH
    arn: "Arn",
  },
})

Response structure


resp.status #=> Integer
resp.request_id #=> String
resp.schedule_id #=> String
resp.arn #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:data_set_id (required, String) —
The ID of the dataset.
:aws_account_id (required, String) —
The Amazon Web Services account ID.
:schedule (required, Types::RefreshSchedule) —
The refresh schedule.

Returns:

(Types::UpdateRefreshScheduleResponse) —
Returns a response object which responds to the following methods:
- #status => Integer
- #request_id => String
- #schedule_id => String
- #arn => String

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 24684

def update_refresh_schedule(params = {}, options = {})
  req = build_request(:update_refresh_schedule, params)
  req.send_request(options)
end

#update_role_custom_permission(params = {}) ⇒ `Types::UpdateRoleCustomPermissionResponse`

Updates the custom permissions that are associated with a role.

Examples:

Request syntax with placeholder values


resp = client.update_role_custom_permission({
  custom_permissions_name: "RoleName", # required
  role: "ADMIN", # required, accepts ADMIN, AUTHOR, READER, ADMIN_PRO, AUTHOR_PRO, READER_PRO
  aws_account_id: "AwsAccountId", # required
  namespace: "Namespace", # required
})

Response structure


resp.request_id #=> String
resp.status #=> Integer

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:custom_permissions_name (required, String) —
The name of the custom permission that you want to update the role with.
:role (required, String) —
The name of role tht you want to update.
:aws_account_id (required, String) —
The ID for the Amazon Web Services account that you want to create a group in. The Amazon Web Services account ID that you provide must be the same Amazon Web Services account that contains your Amazon Quick Sight account.
:namespace (required, String) —
The namespace that contains the role that you want to update.

Returns:

(Types::UpdateRoleCustomPermissionResponse) —
Returns a response object which responds to the following methods:
- #request_id => String
- #status => Integer

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 24730

def update_role_custom_permission(params = {}, options = {})
  req = build_request(:update_role_custom_permission, params)
  req.send_request(options)
end

#update_self_upgrade(params = {}) ⇒ `Types::UpdateSelfUpgradeResponse`

Updates a self-upgrade request for a Quick user by approving, denying, or verifying the request.

Examples:

Request syntax with placeholder values


resp = client.update_self_upgrade({
  aws_account_id: "AwsAccountId", # required
  namespace: "Namespace", # required
  upgrade_request_id: "String", # required
  action: "APPROVE", # required, accepts APPROVE, DENY, VERIFY
})

Response structure


resp.self_upgrade_request_detail.upgrade_request_id #=> String
resp.self_upgrade_request_detail.user_name #=> String
resp.self_upgrade_request_detail.original_role #=> String, one of "ADMIN", "AUTHOR", "READER", "RESTRICTED_AUTHOR", "RESTRICTED_READER", "ADMIN_PRO", "AUTHOR_PRO", "READER_PRO"
resp.self_upgrade_request_detail.requested_role #=> String, one of "ADMIN", "AUTHOR", "READER", "RESTRICTED_AUTHOR", "RESTRICTED_READER", "ADMIN_PRO", "AUTHOR_PRO", "READER_PRO"
resp.self_upgrade_request_detail.request_note #=> String
resp.self_upgrade_request_detail.creation_time #=> Integer
resp.self_upgrade_request_detail.request_status #=> String, one of "PENDING", "APPROVED", "DENIED", "UPDATE_FAILED", "VERIFY_FAILED"
resp.self_upgrade_request_detail.last_update_attempt_time #=> Integer
resp.self_upgrade_request_detail.last_update_failure_reason #=> String
resp.request_id #=> String
resp.status #=> Integer

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:aws_account_id (required, String) —
The ID of the Amazon Web Services account that contains the self-upgrade request.
:namespace (required, String) —
The Quick namespace for the self-upgrade request.
:upgrade_request_id (required, String) —
The ID of the self-upgrade request to update.
:action (required, String) —
The action to perform on the self-upgrade request. Valid values are APPROVE, DENY, or VERIFY.

Returns:

(Types::UpdateSelfUpgradeResponse) —
Returns a response object which responds to the following methods:
- #self_upgrade_request_detail => Types::SelfUpgradeRequestDetail
- #request_id => String
- #status => Integer

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 24827

def update_self_upgrade(params = {}, options = {})
  req = build_request(:update_self_upgrade, params)
  req.send_request(options)
end

#update_self_upgrade_configuration(params = {}) ⇒ `Types::UpdateSelfUpgradeConfigurationResponse`

Updates the self-upgrade configuration for a Quick account.

Examples:

Request syntax with placeholder values


resp = client.update_self_upgrade_configuration({
  aws_account_id: "AwsAccountId", # required
  namespace: "Namespace", # required
  self_upgrade_status: "AUTO_APPROVAL", # required, accepts AUTO_APPROVAL, ADMIN_APPROVAL
})

Response structure


resp.request_id #=> String
resp.status #=> Integer

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:aws_account_id (required, String) —
The ID of the Amazon Web Services account that contains the Quick self-upgrade configuration that you want to update.
:namespace (required, String) —
The Quick namespace that you want to update the Quick self-upgrade configuration for.
:self_upgrade_status (required, String) —
The self-upgrade status that you want to set for the Quick account.

Returns:

(Types::UpdateSelfUpgradeConfigurationResponse) —
Returns a response object which responds to the following methods:
- #request_id => String
- #status => Integer

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 24867

def update_self_upgrade_configuration(params = {}, options = {})
  req = build_request(:update_self_upgrade_configuration, params)
  req.send_request(options)
end

#update_space(params = {}) ⇒ `Types::UpdateSpaceResponse`

Updates the metadata of an Amazon QuickSight space.

Examples:

Request syntax with placeholder values


resp = client.update_space({
  aws_account_id: "AwsAccountId", # required
  space_id: "PublicSpaceId", # required
  name: "SpaceName",
  description: "SpaceDescription",
})

Response structure


resp.space_id #=> String
resp.space_arn #=> String
resp.request_id #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:aws_account_id (required, String) —
The ID of the Amazon Web Services account that contains the space.
:space_id (required, String) —
The ID of the space that you want to update.
:name (String) —
A new display name for the space.
:description (String) —
A new description for the space.

Returns:

(Types::UpdateSpaceResponse) —
Returns a response object which responds to the following methods:
- #space_id => String
- #space_arn => String
- #request_id => String

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 24911

def update_space(params = {}, options = {})
  req = build_request(:update_space, params)
  req.send_request(options)
end

#update_space_permissions(params = {}) ⇒ `Types::UpdateSpacePermissionsResponse`

Updates the permissions for an Amazon QuickSight space.

Examples:

Request syntax with placeholder values


resp = client.update_space_permissions({
  aws_account_id: "AwsAccountId", # required
  space_id: "PublicSpaceId", # required
  grant_permissions: [
    {
      principal: "Principal", # required
      actions: ["String"], # required
    },
  ],
  revoke_permissions: [
    {
      principal: "Principal", # required
      actions: ["String"], # required
    },
  ],
})

Response structure


resp.space_id #=> String
resp.space_arn #=> String
resp.permissions #=> Array
resp.permissions[0].principal #=> String
resp.permissions[0].actions #=> Array
resp.permissions[0].actions[0] #=> String
resp.request_id #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:aws_account_id (required, String) —
The ID of the Amazon Web Services account that contains the space.
:space_id (required, String) —
The ID of the space that you want to update permissions for.
:grant_permissions (Array<Types::ResourcePermission>) —
The permissions that you want to grant on the space.
:revoke_permissions (Array<Types::ResourcePermission>) —
The permissions that you want to revoke from the space.

Returns:

(Types::UpdateSpacePermissionsResponse) —
Returns a response object which responds to the following methods:
- #space_id => String
- #space_arn => String
- #permissions => Array<Types::ResourcePermission>
- #request_id => String

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 24970

def update_space_permissions(params = {}, options = {})
  req = build_request(:update_space_permissions, params)
  req.send_request(options)
end

#update_space_resources(params = {}) ⇒ `Types::UpdateSpaceResourcesResponse`

Adds or removes resources from an Amazon QuickSight space.

Examples:

Request syntax with placeholder values


resp = client.update_space_resources({
  aws_account_id: "AwsAccountId", # required
  space_id: "PublicSpaceId", # required
  add_resources: [
    {
      resource_type: "TOPIC", # required, accepts TOPIC, DASHBOARD, KNOWLEDGE_BASE, ACTION_CONNECTOR, DATA_SET
      resource_details: { # required
        resource_arn: "Arn",
      },
    },
  ],
  remove_resources: [
    {
      resource_type: "TOPIC", # required, accepts TOPIC, DASHBOARD, KNOWLEDGE_BASE, ACTION_CONNECTOR, DATA_SET
      resource_details: { # required
        resource_arn: "Arn",
      },
    },
  ],
})

Response structure


resp.space_id #=> String
resp.space_arn #=> String
resp.failed_resource_operations #=> Array
resp.failed_resource_operations[0].resource_type #=> String, one of "TOPIC", "DASHBOARD", "KNOWLEDGE_BASE", "ACTION_CONNECTOR", "DATA_SET"
resp.failed_resource_operations[0].resource_details.resource_arn #=> String
resp.failed_resource_operations[0].error_message #=> String
resp.request_id #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:aws_account_id (required, String) —
The ID of the Amazon Web Services account that contains the space.
:space_id (required, String) —
The ID of the space that you want to update resources for.
:add_resources (Array<Types::SpaceResourceOperation>) —
A list of resources to add to the space.
:remove_resources (Array<Types::SpaceResourceOperation>) —
A list of resources to remove from the space.

Returns:

(Types::UpdateSpaceResourcesResponse) —
Returns a response object which responds to the following methods:
- #space_id => String
- #space_arn => String
- #failed_resource_operations => Array<Types::FailedSpaceResourceOperation>
- #request_id => String

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 25033

def update_space_resources(params = {}, options = {})
  req = build_request(:update_space_resources, params)
  req.send_request(options)
end

#update_spice_capacity_configuration(params = {}) ⇒ `Types::UpdateSPICECapacityConfigurationResponse`

Updates the SPICE capacity configuration for a Quick Sight account.

Examples:

Request syntax with placeholder values


resp = client.update_spice_capacity_configuration({
  aws_account_id: "AwsAccountId", # required
  purchase_mode: "MANUAL", # required, accepts MANUAL, AUTO_PURCHASE
})

Response structure


resp.request_id #=> String
resp.status #=> Integer

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:aws_account_id (required, String) —
The ID of the Amazon Web Services account that contains the SPICE configuration that you want to update.
:purchase_mode (required, String) —
Determines how SPICE capacity can be purchased. The following options are available.
- MANUAL: SPICE capacity can only be purchased manually.
- AUTO_PURCHASE: Extra SPICE capacity is automatically purchased on your behalf as needed. SPICE capacity can also be purchased manually with this option.

Returns:

(Types::UpdateSPICECapacityConfigurationResponse) —
Returns a response object which responds to the following methods:
- #request_id => String
- #status => Integer

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 24772

def update_spice_capacity_configuration(params = {}, options = {})
  req = build_request(:update_spice_capacity_configuration, params)
  req.send_request(options)
end

#update_template(params = {}) ⇒ `Types::UpdateTemplateResponse`

Updates a template from an existing Amazon Quick Sight analysis or another template.

Examples:

Response structure


resp.template_id #=> String
resp.arn #=> String
resp.version_arn #=> String
resp.creation_status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED", "DELETED"
resp.status #=> Integer
resp.request_id #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:aws_account_id (required, String) —
The ID of the Amazon Web Services account that contains the template that you're updating.
:template_id (required, String) —
The ID for the template.
:source_entity (Types::TemplateSourceEntity) —
The entity that you are using as a source when you update the template. In SourceEntity, you specify the type of object you're using as source: SourceTemplate for a template or SourceAnalysis for an analysis. Both of these require an Amazon Resource Name (ARN). For SourceTemplate, specify the ARN of the source template. For SourceAnalysis, specify the ARN of the source analysis. The SourceTemplate ARN can contain any Amazon Web Services account and any Quick Sight-supported Amazon Web Services Region;.

Use the DataSetReferences entity within SourceTemplate or SourceAnalysis to list the replacement datasets for the placeholders listed in the original. The schema in each dataset must match its placeholder. Use the TopicReferences entity to list the replacement topics for the topic placeholders listed in the original. The schema in each topic must match its placeholder.
:version_description (String) —
A description of the current template version that is being updated. Every time you call UpdateTemplate, you create a new version of the template. Each version of the template maintains a description of the version in the VersionDescription field.
:name (String) —
The name for the template.
:definition (Types::TemplateVersionDefinition) —
The definition of a template.

A definition is the data model of all features in a Dashboard, Template, or Analysis.
:validation_strategy (Types::ValidationStrategy) —
The option to relax the validation needed to update a template with definition objects. This skips the validation step for specific errors.

Returns:

(Types::UpdateTemplateResponse) —
Returns a response object which responds to the following methods:
- #template_id => String
- #arn => String
- #version_arn => String
- #creation_status => String
- #status => Integer
- #request_id => String

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 25107

def update_template(params = {}, options = {})
  req = build_request(:update_template, params)
  req.send_request(options)
end

#update_template_alias(params = {}) ⇒ `Types::UpdateTemplateAliasResponse`

Updates the template alias of a template.

Examples:

Request syntax with placeholder values


resp = client.update_template_alias({
  aws_account_id: "AwsAccountId", # required
  template_id: "ShortRestrictiveResourceId", # required
  alias_name: "AliasName", # required
  template_version_number: 1, # required
})

Response structure


resp.template_alias.alias_name #=> String
resp.template_alias.arn #=> String
resp.template_alias.template_version_number #=> Integer
resp.status #=> Integer
resp.request_id #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:aws_account_id (required, String) —
The ID of the Amazon Web Services account that contains the template alias that you're updating.
:template_id (required, String) —
The ID for the template.
:alias_name (required, String) —
The alias of the template that you want to update. If you name a specific alias, you update the version that the alias points to. You can specify the latest version of the template by providing the keyword $LATEST in the AliasName parameter. The keyword $PUBLISHED doesn't apply to templates.
:template_version_number (required, Integer) —
The version number of the template.

Returns:

(Types::UpdateTemplateAliasResponse) —
Returns a response object which responds to the following methods:
- #template_alias => Types::TemplateAlias
- #status => Integer
- #request_id => String

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 25158

def update_template_alias(params = {}, options = {})
  req = build_request(:update_template_alias, params)
  req.send_request(options)
end

#update_template_permissions(params = {}) ⇒ `Types::UpdateTemplatePermissionsResponse`

Updates the resource permissions for a template.

Examples:

Request syntax with placeholder values


resp = client.update_template_permissions({
  aws_account_id: "AwsAccountId", # required
  template_id: "ShortRestrictiveResourceId", # required
  grant_permissions: [
    {
      principal: "Principal", # required
      actions: ["String"], # required
    },
  ],
  revoke_permissions: [
    {
      principal: "Principal", # required
      actions: ["String"], # required
    },
  ],
})

Response structure


resp.template_id #=> String
resp.template_arn #=> String
resp.permissions #=> Array
resp.permissions[0].principal #=> String
resp.permissions[0].actions #=> Array
resp.permissions[0].actions[0] #=> String
resp.request_id #=> String
resp.status #=> Integer

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:aws_account_id (required, String) —
The ID of the Amazon Web Services account that contains the template.
:template_id (required, String) —
The ID for the template.
:grant_permissions (Array<Types::ResourcePermission>) —
A list of resource permissions to be granted on the template.
:revoke_permissions (Array<Types::ResourcePermission>) —
A list of resource permissions to be revoked from the template.

Returns:

(Types::UpdateTemplatePermissionsResponse) —
Returns a response object which responds to the following methods:
- #template_id => String
- #template_arn => String
- #permissions => Array<Types::ResourcePermission>
- #request_id => String
- #status => Integer

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 25219

def update_template_permissions(params = {}, options = {})
  req = build_request(:update_template_permissions, params)
  req.send_request(options)
end

#update_theme(params = {}) ⇒ `Types::UpdateThemeResponse`

Updates a theme.

Examples:

Request syntax with placeholder values


resp = client.update_theme({
  aws_account_id: "AwsAccountId", # required
  theme_id: "ShortRestrictiveResourceId", # required
  name: "ThemeName",
  base_theme_id: "ShortRestrictiveResourceId", # required
  version_description: "VersionDescription",
  configuration: {
    data_color_palette: {
      colors: ["HexColor"],
      min_max_gradient: ["HexColor"],
      empty_fill_color: "HexColor",
    },
    ui_color_palette: {
      primary_foreground: "HexColor",
      primary_background: "HexColor",
      secondary_foreground: "HexColor",
      secondary_background: "HexColor",
      accent: "HexColor",
      accent_foreground: "HexColor",
      danger: "HexColor",
      danger_foreground: "HexColor",
      warning: "HexColor",
      warning_foreground: "HexColor",
      success: "HexColor",
      success_foreground: "HexColor",
      dimension: "HexColor",
      dimension_foreground: "HexColor",
      measure: "HexColor",
      measure_foreground: "HexColor",
    },
    sheet: {
      tile: {
        background_color: "Color",
        border: {
          color: "Color",
          show: false,
          width: "Width",
        },
        border_radius: "BorderRadius",
        padding: "Padding",
      },
      tile_layout: {
        gutter: {
          show: false,
        },
        margin: {
          show: false,
        },
      },
      background: {
        color: "Color",
        gradient: "String",
      },
    },
    typography: {
      font_families: [
        {
          font_family: "LimitedString",
        },
      ],
      axis_title_font_configuration: {
        font_size: {
          relative: "EXTRA_SMALL", # accepts EXTRA_SMALL, SMALL, MEDIUM, LARGE, EXTRA_LARGE
          absolute: "PixelLength",
        },
        font_decoration: "UNDERLINE", # accepts UNDERLINE, NONE
        font_color: "HexColor",
        font_weight: {
          name: "NORMAL", # accepts NORMAL, BOLD
        },
        font_style: "NORMAL", # accepts NORMAL, ITALIC
        font_family: "LimitedString",
      },
      axis_label_font_configuration: {
        font_size: {
          relative: "EXTRA_SMALL", # accepts EXTRA_SMALL, SMALL, MEDIUM, LARGE, EXTRA_LARGE
          absolute: "PixelLength",
        },
        font_decoration: "UNDERLINE", # accepts UNDERLINE, NONE
        font_color: "HexColor",
        font_weight: {
          name: "NORMAL", # accepts NORMAL, BOLD
        },
        font_style: "NORMAL", # accepts NORMAL, ITALIC
        font_family: "LimitedString",
      },
      legend_title_font_configuration: {
        font_size: {
          relative: "EXTRA_SMALL", # accepts EXTRA_SMALL, SMALL, MEDIUM, LARGE, EXTRA_LARGE
          absolute: "PixelLength",
        },
        font_decoration: "UNDERLINE", # accepts UNDERLINE, NONE
        font_color: "HexColor",
        font_weight: {
          name: "NORMAL", # accepts NORMAL, BOLD
        },
        font_style: "NORMAL", # accepts NORMAL, ITALIC
        font_family: "LimitedString",
      },
      legend_value_font_configuration: {
        font_size: {
          relative: "EXTRA_SMALL", # accepts EXTRA_SMALL, SMALL, MEDIUM, LARGE, EXTRA_LARGE
          absolute: "PixelLength",
        },
        font_decoration: "UNDERLINE", # accepts UNDERLINE, NONE
        font_color: "HexColor",
        font_weight: {
          name: "NORMAL", # accepts NORMAL, BOLD
        },
        font_style: "NORMAL", # accepts NORMAL, ITALIC
        font_family: "LimitedString",
      },
      data_label_font_configuration: {
        font_size: {
          relative: "EXTRA_SMALL", # accepts EXTRA_SMALL, SMALL, MEDIUM, LARGE, EXTRA_LARGE
          absolute: "PixelLength",
        },
        font_decoration: "UNDERLINE", # accepts UNDERLINE, NONE
        font_color: "HexColor",
        font_weight: {
          name: "NORMAL", # accepts NORMAL, BOLD
        },
        font_style: "NORMAL", # accepts NORMAL, ITALIC
        font_family: "LimitedString",
      },
      visual_title_font_configuration: {
        font_configuration: {
          font_size: {
            relative: "EXTRA_SMALL", # accepts EXTRA_SMALL, SMALL, MEDIUM, LARGE, EXTRA_LARGE
            absolute: "PixelLength",
          },
          font_decoration: "UNDERLINE", # accepts UNDERLINE, NONE
          font_color: "HexColor",
          font_weight: {
            name: "NORMAL", # accepts NORMAL, BOLD
          },
          font_style: "NORMAL", # accepts NORMAL, ITALIC
          font_family: "LimitedString",
        },
        text_alignment: "LEFT", # accepts LEFT, CENTER, RIGHT, AUTO
        text_transform: "CAPITALIZE", # accepts CAPITALIZE
      },
      visual_subtitle_font_configuration: {
        font_configuration: {
          font_size: {
            relative: "EXTRA_SMALL", # accepts EXTRA_SMALL, SMALL, MEDIUM, LARGE, EXTRA_LARGE
            absolute: "PixelLength",
          },
          font_decoration: "UNDERLINE", # accepts UNDERLINE, NONE
          font_color: "HexColor",
          font_weight: {
            name: "NORMAL", # accepts NORMAL, BOLD
          },
          font_style: "NORMAL", # accepts NORMAL, ITALIC
          font_family: "LimitedString",
        },
        text_alignment: "LEFT", # accepts LEFT, CENTER, RIGHT, AUTO
        text_transform: "CAPITALIZE", # accepts CAPITALIZE
      },
      control_title_font_configuration: {
        font_configuration: {
          font_size: {
            relative: "EXTRA_SMALL", # accepts EXTRA_SMALL, SMALL, MEDIUM, LARGE, EXTRA_LARGE
            absolute: "PixelLength",
          },
          font_decoration: "UNDERLINE", # accepts UNDERLINE, NONE
          font_color: "HexColor",
          font_weight: {
            name: "NORMAL", # accepts NORMAL, BOLD
          },
          font_style: "NORMAL", # accepts NORMAL, ITALIC
          font_family: "LimitedString",
        },
        text_alignment: "LEFT", # accepts LEFT, CENTER, RIGHT, AUTO
      },
    },
  },
})

Response structure


resp.theme_id #=> String
resp.arn #=> String
resp.version_arn #=> String
resp.creation_status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED", "DELETED"
resp.status #=> Integer
resp.request_id #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:aws_account_id (required, String) —
The ID of the Amazon Web Services account that contains the theme that you're updating.
:theme_id (required, String) —
The ID for the theme.
:name (String) —
The name for the theme.
:base_theme_id (required, String) —
The theme ID, defined by Amazon Quick Sight, that a custom theme inherits from. All themes initially inherit from a default Quick Sight theme.
:version_description (String) —
A description of the theme version that you're updating Every time that you call UpdateTheme, you create a new version of the theme. Each version of the theme maintains a description of the version in VersionDescription.
:configuration (Types::ThemeConfiguration) —
The theme configuration, which contains the theme display properties.

Returns:

(Types::UpdateThemeResponse) —
Returns a response object which responds to the following methods:
- #theme_id => String
- #arn => String
- #version_arn => String
- #creation_status => String
- #status => Integer
- #request_id => String

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 25453

def update_theme(params = {}, options = {})
  req = build_request(:update_theme, params)
  req.send_request(options)
end

#update_theme_alias(params = {}) ⇒ `Types::UpdateThemeAliasResponse`

Updates an alias of a theme.

Examples:

Request syntax with placeholder values


resp = client.update_theme_alias({
  aws_account_id: "AwsAccountId", # required
  theme_id: "ShortRestrictiveResourceId", # required
  alias_name: "AliasName", # required
  theme_version_number: 1, # required
})

Response structure


resp.theme_alias.arn #=> String
resp.theme_alias.alias_name #=> String
resp.theme_alias.theme_version_number #=> Integer
resp.status #=> Integer
resp.request_id #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:aws_account_id (required, String) —
The ID of the Amazon Web Services account that contains the theme alias that you're updating.
:theme_id (required, String) —
The ID for the theme.
:alias_name (required, String) —
The name of the theme alias that you want to update.
:theme_version_number (required, Integer) —
The version number of the theme that the alias should reference.

Returns:

(Types::UpdateThemeAliasResponse) —
Returns a response object which responds to the following methods:
- #theme_alias => Types::ThemeAlias
- #status => Integer
- #request_id => String

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 25500

def update_theme_alias(params = {}, options = {})
  req = build_request(:update_theme_alias, params)
  req.send_request(options)
end

#update_theme_permissions(params = {}) ⇒ `Types::UpdateThemePermissionsResponse`

Updates the resource permissions for a theme. Permissions apply to the action to grant or revoke permissions on, for example "quicksight:DescribeTheme".

Theme permissions apply in groupings. Valid groupings include the following for the three levels of permissions, which are user, owner, or no permissions:

User
- "quicksight:DescribeTheme"
- "quicksight:DescribeThemeAlias"
- "quicksight:ListThemeAliases"
- "quicksight:ListThemeVersions"
Owner
- "quicksight:DescribeTheme"
- "quicksight:DescribeThemeAlias"
- "quicksight:ListThemeAliases"
- "quicksight:ListThemeVersions"
- "quicksight:DeleteTheme"
- "quicksight:UpdateTheme"
- "quicksight:CreateThemeAlias"
- "quicksight:DeleteThemeAlias"
- "quicksight:UpdateThemeAlias"
- "quicksight:UpdateThemePermissions"
- "quicksight:DescribeThemePermissions"
To specify no permissions, omit the permissions list.

Examples:

Request syntax with placeholder values


resp = client.update_theme_permissions({
  aws_account_id: "AwsAccountId", # required
  theme_id: "ShortRestrictiveResourceId", # required
  grant_permissions: [
    {
      principal: "Principal", # required
      actions: ["String"], # required
    },
  ],
  revoke_permissions: [
    {
      principal: "Principal", # required
      actions: ["String"], # required
    },
  ],
})

Response structure


resp.theme_id #=> String
resp.theme_arn #=> String
resp.permissions #=> Array
resp.permissions[0].principal #=> String
resp.permissions[0].actions #=> Array
resp.permissions[0].actions[0] #=> String
resp.request_id #=> String
resp.status #=> Integer

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:aws_account_id (required, String) —
The ID of the Amazon Web Services account that contains the theme.
:theme_id (required, String) —
The ID for the theme.
:grant_permissions (Array<Types::ResourcePermission>) —
A list of resource permissions to be granted for the theme.
:revoke_permissions (Array<Types::ResourcePermission>) —
A list of resource permissions to be revoked from the theme.

Returns:

(Types::UpdateThemePermissionsResponse) —
Returns a response object which responds to the following methods:
- #theme_id => String
- #theme_arn => String
- #permissions => Array<Types::ResourcePermission>
- #request_id => String
- #status => Integer

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 25601

def update_theme_permissions(params = {}, options = {})
  req = build_request(:update_theme_permissions, params)
  req.send_request(options)
end

#update_topic(params = {}) ⇒ `Types::UpdateTopicResponse`

Updates a topic.

Examples:

Request syntax with placeholder values


resp = client.update_topic({
  aws_account_id: "AwsAccountId", # required
  topic_id: "TopicId", # required
  topic: { # required
    name: "ResourceName",
    description: "LimitedString",
    user_experience_version: "LEGACY", # accepts LEGACY, NEW_READER_EXPERIENCE
    data_sets: [
      {
        dataset_arn: "Arn", # required
        dataset_name: "LimitedString",
        dataset_description: "LimitedString",
        data_aggregation: {
          dataset_row_date_granularity: "SECOND", # accepts SECOND, MINUTE, HOUR, DAY, WEEK, MONTH, QUARTER, YEAR
          default_date_column_name: "LimitedString",
        },
        filters: [
          {
            filter_description: "DescriptionSensitiveString",
            filter_class: "ENFORCED_VALUE_FILTER", # accepts ENFORCED_VALUE_FILTER, CONDITIONAL_VALUE_FILTER, NAMED_VALUE_FILTER, DASHBOARD_DEFAULT_FILTER
            filter_name: "LimitedString", # required
            filter_synonyms: ["SynonymString"],
            operand_field_name: "LimitedString", # required
            filter_type: "CATEGORY_FILTER", # accepts CATEGORY_FILTER, NUMERIC_EQUALITY_FILTER, NUMERIC_RANGE_FILTER, DATE_RANGE_FILTER, RELATIVE_DATE_FILTER, NULL_FILTER
            category_filter: {
              category_filter_function: "EXACT", # accepts EXACT, CONTAINS
              category_filter_type: "CUSTOM_FILTER", # accepts CUSTOM_FILTER, CUSTOM_FILTER_LIST, FILTER_LIST
              constant: {
                constant_type: "SINGULAR", # accepts SINGULAR, RANGE, COLLECTIVE
                singular_constant: "LimitedSensitiveString",
                collective_constant: {
                  value_list: ["String"],
                },
              },
              inverse: false,
              null_filter: "ALL_VALUES", # accepts ALL_VALUES, NON_NULLS_ONLY, NULLS_ONLY
            },
            numeric_equality_filter: {
              constant: {
                constant_type: "SINGULAR", # accepts SINGULAR, RANGE, COLLECTIVE
                singular_constant: "LimitedSensitiveString",
              },
              aggregation: "NO_AGGREGATION", # accepts NO_AGGREGATION, SUM, AVERAGE, COUNT, DISTINCT_COUNT, MAX, MEDIAN, MIN, STDEV, STDEVP, VAR, VARP
              inverse: false,
              null_filter: "ALL_VALUES", # accepts ALL_VALUES, NON_NULLS_ONLY, NULLS_ONLY
            },
            numeric_range_filter: {
              inclusive: false,
              constant: {
                constant_type: "SINGULAR", # accepts SINGULAR, RANGE, COLLECTIVE
                range_constant: {
                  minimum: "LimitedSensitiveString",
                  maximum: "LimitedSensitiveString",
                },
              },
              aggregation: "NO_AGGREGATION", # accepts NO_AGGREGATION, SUM, AVERAGE, COUNT, DISTINCT_COUNT, MAX, MEDIAN, MIN, STDEV, STDEVP, VAR, VARP
              inverse: false,
              null_filter: "ALL_VALUES", # accepts ALL_VALUES, NON_NULLS_ONLY, NULLS_ONLY
            },
            date_range_filter: {
              inclusive: false,
              constant: {
                constant_type: "SINGULAR", # accepts SINGULAR, RANGE, COLLECTIVE
                range_constant: {
                  minimum: "LimitedSensitiveString",
                  maximum: "LimitedSensitiveString",
                },
              },
              null_filter: "ALL_VALUES", # accepts ALL_VALUES, NON_NULLS_ONLY, NULLS_ONLY
            },
            relative_date_filter: {
              time_granularity: "SECOND", # accepts SECOND, MINUTE, HOUR, DAY, WEEK, MONTH, QUARTER, YEAR
              relative_date_filter_function: "PREVIOUS", # accepts PREVIOUS, THIS, LAST, NEXT, NOW
              constant: {
                constant_type: "SINGULAR", # accepts SINGULAR, RANGE, COLLECTIVE
                singular_constant: "LimitedSensitiveString",
              },
              null_filter: "ALL_VALUES", # accepts ALL_VALUES, NON_NULLS_ONLY, NULLS_ONLY
            },
            null_filter: {
              null_filter_type: "ALL_VALUES", # accepts ALL_VALUES, NON_NULLS_ONLY, NULLS_ONLY
              constant: {
                constant_type: "SINGULAR", # accepts SINGULAR, RANGE, COLLECTIVE
                singular_constant: "LimitedSensitiveString",
              },
              inverse: false,
            },
          },
        ],
        columns: [
          {
            column_name: "LimitedString", # required
            column_friendly_name: "LimitedSensitiveString",
            column_description: "DescriptionSensitiveString",
            column_synonyms: ["SynonymString"],
            column_data_role: "DIMENSION", # accepts DIMENSION, MEASURE
            aggregation: "SUM", # accepts SUM, MAX, MIN, COUNT, DISTINCT_COUNT, AVERAGE, MEDIAN, STDEV, STDEVP, VAR, VARP
            is_included_in_topic: false,
            disable_indexing: false,
            comparative_order: {
              use_ordering: "GREATER_IS_BETTER", # accepts GREATER_IS_BETTER, LESSER_IS_BETTER, SPECIFIED
              specifed_order: ["String"],
              treat_undefined_specified_values: "LEAST", # accepts LEAST, MOST
            },
            semantic_type: {
              type_name: "LimitedString",
              sub_type_name: "LimitedString",
              type_parameters: {
                "LimitedString" => "LimitedString",
              },
              truthy_cell_value: "SensitiveString",
              truthy_cell_value_synonyms: ["SensitiveString"],
              falsey_cell_value: "SensitiveString",
              falsey_cell_value_synonyms: ["SensitiveString"],
            },
            time_granularity: "SECOND", # accepts SECOND, MINUTE, HOUR, DAY, WEEK, MONTH, QUARTER, YEAR
            allowed_aggregations: ["COUNT"], # accepts COUNT, DISTINCT_COUNT, MIN, MAX, MEDIAN, SUM, AVERAGE, STDEV, STDEVP, VAR, VARP, PERCENTILE
            not_allowed_aggregations: ["COUNT"], # accepts COUNT, DISTINCT_COUNT, MIN, MAX, MEDIAN, SUM, AVERAGE, STDEV, STDEVP, VAR, VARP, PERCENTILE
            default_formatting: {
              display_format: "AUTO", # accepts AUTO, PERCENT, CURRENCY, NUMBER, DATE, STRING
              display_format_options: {
                use_blank_cell_format: false,
                blank_cell_format: "LimitedString",
                date_format: "LimitedString",
                decimal_separator: "COMMA", # accepts COMMA, DOT
                grouping_separator: "LimitedString",
                use_grouping: false,
                fraction_digits: 1,
                prefix: "LimitedString",
                suffix: "LimitedString",
                unit_scaler: "NONE", # accepts NONE, AUTO, THOUSANDS, MILLIONS, BILLIONS, TRILLIONS, LAKHS, CRORES
                negative_format: {
                  prefix: "LimitedString",
                  suffix: "LimitedString",
                },
                currency_symbol: "LimitedString",
              },
            },
            never_aggregate_in_filter: false,
            cell_value_synonyms: [
              {
                cell_value: "SynonymString",
                synonyms: ["SensitiveString"],
              },
            ],
            non_additive: false,
          },
        ],
        calculated_fields: [
          {
            calculated_field_name: "LimitedSensitiveString", # required
            calculated_field_description: "DescriptionSensitiveString",
            expression: "Expression", # required
            calculated_field_synonyms: ["SynonymString"],
            is_included_in_topic: false,
            disable_indexing: false,
            column_data_role: "DIMENSION", # accepts DIMENSION, MEASURE
            time_granularity: "SECOND", # accepts SECOND, MINUTE, HOUR, DAY, WEEK, MONTH, QUARTER, YEAR
            default_formatting: {
              display_format: "AUTO", # accepts AUTO, PERCENT, CURRENCY, NUMBER, DATE, STRING
              display_format_options: {
                use_blank_cell_format: false,
                blank_cell_format: "LimitedString",
                date_format: "LimitedString",
                decimal_separator: "COMMA", # accepts COMMA, DOT
                grouping_separator: "LimitedString",
                use_grouping: false,
                fraction_digits: 1,
                prefix: "LimitedString",
                suffix: "LimitedString",
                unit_scaler: "NONE", # accepts NONE, AUTO, THOUSANDS, MILLIONS, BILLIONS, TRILLIONS, LAKHS, CRORES
                negative_format: {
                  prefix: "LimitedString",
                  suffix: "LimitedString",
                },
                currency_symbol: "LimitedString",
              },
            },
            aggregation: "SUM", # accepts SUM, MAX, MIN, COUNT, DISTINCT_COUNT, AVERAGE, MEDIAN, STDEV, STDEVP, VAR, VARP
            comparative_order: {
              use_ordering: "GREATER_IS_BETTER", # accepts GREATER_IS_BETTER, LESSER_IS_BETTER, SPECIFIED
              specifed_order: ["String"],
              treat_undefined_specified_values: "LEAST", # accepts LEAST, MOST
            },
            semantic_type: {
              type_name: "LimitedString",
              sub_type_name: "LimitedString",
              type_parameters: {
                "LimitedString" => "LimitedString",
              },
              truthy_cell_value: "SensitiveString",
              truthy_cell_value_synonyms: ["SensitiveString"],
              falsey_cell_value: "SensitiveString",
              falsey_cell_value_synonyms: ["SensitiveString"],
            },
            allowed_aggregations: ["COUNT"], # accepts COUNT, DISTINCT_COUNT, MIN, MAX, MEDIAN, SUM, AVERAGE, STDEV, STDEVP, VAR, VARP, PERCENTILE
            not_allowed_aggregations: ["COUNT"], # accepts COUNT, DISTINCT_COUNT, MIN, MAX, MEDIAN, SUM, AVERAGE, STDEV, STDEVP, VAR, VARP, PERCENTILE
            never_aggregate_in_filter: false,
            cell_value_synonyms: [
              {
                cell_value: "SynonymString",
                synonyms: ["SensitiveString"],
              },
            ],
            non_additive: false,
          },
        ],
        named_entities: [
          {
            entity_name: "LimitedString", # required
            entity_description: "DescriptionSensitiveString",
            entity_synonyms: ["SynonymString"],
            semantic_entity_type: {
              type_name: "LimitedString",
              sub_type_name: "LimitedString",
              type_parameters: {
                "LimitedString" => "LimitedString",
              },
            },
            definition: [
              {
                field_name: "LimitedString",
                property_name: "LimitedString",
                property_role: "PRIMARY", # accepts PRIMARY, ID
                property_usage: "INHERIT", # accepts INHERIT, DIMENSION, MEASURE
                metric: {
                  aggregation: "SUM", # accepts SUM, MIN, MAX, COUNT, AVERAGE, DISTINCT_COUNT, STDEV, STDEVP, VAR, VARP, PERCENTILE, MEDIAN, CUSTOM
                  aggregation_function_parameters: {
                    "LimitedString" => "LimitedString",
                  },
                },
                rank_order: 1,
                presentation_order: 1,
                is_hidden: false,
              },
            ],
            sort: [
              {
                field_name: "LimitedString", # required
                direction: "ASCENDING", # required, accepts ASCENDING, DESCENDING
              },
            ],
            rank_order: 1,
            presentation_order: 1,
          },
        ],
      },
    ],
    config_options: {
      q_business_insights_enabled: false,
    },
  },
  custom_instructions: {
    custom_instructions_string: "CustomInstructionsString", # required
  },
})

Response structure


resp.topic_id #=> String
resp.arn #=> String
resp.refresh_arn #=> String
resp.request_id #=> String
resp.status #=> Integer

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:aws_account_id (required, String) —
The ID of the Amazon Web Services account that contains the topic that you want to update.
:topic_id (required, String) —
The ID of the topic that you want to modify. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
:topic (required, Types::TopicDetails) —
The definition of the topic that you want to update.
:custom_instructions (Types::CustomInstructions) —
Custom instructions for the topic.

Returns:

(Types::UpdateTopicResponse) —
Returns a response object which responds to the following methods:
- #topic_id => String
- #arn => String
- #refresh_arn => String
- #request_id => String
- #status => Integer

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 25901

def update_topic(params = {}, options = {})
  req = build_request(:update_topic, params)
  req.send_request(options)
end

#update_topic_permissions(params = {}) ⇒ `Types::UpdateTopicPermissionsResponse`

Updates the permissions of a topic.

Examples:

Request syntax with placeholder values


resp = client.update_topic_permissions({
  aws_account_id: "AwsAccountId", # required
  topic_id: "TopicId", # required
  grant_permissions: [
    {
      principal: "Principal", # required
      actions: ["String"], # required
    },
  ],
  revoke_permissions: [
    {
      principal: "Principal", # required
      actions: ["String"], # required
    },
  ],
})

Response structure


resp.topic_id #=> String
resp.topic_arn #=> String
resp.permissions #=> Array
resp.permissions[0].principal #=> String
resp.permissions[0].actions #=> Array
resp.permissions[0].actions[0] #=> String
resp.status #=> Integer
resp.request_id #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:aws_account_id (required, String) —
The ID of the Amazon Web Services account that contains the topic that you want to update the permissions for.
:topic_id (required, String) —
The ID of the topic that you want to modify. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
:grant_permissions (Array<Types::ResourcePermission>) —
The resource permissions that you want to grant to the topic.
:revoke_permissions (Array<Types::ResourcePermission>) —
The resource permissions that you want to revoke from the topic.

Returns:

(Types::UpdateTopicPermissionsResponse) —
Returns a response object which responds to the following methods:
- #topic_id => String
- #topic_arn => String
- #permissions => Array<Types::ResourcePermission>
- #status => Integer
- #request_id => String

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 25964

def update_topic_permissions(params = {}, options = {})
  req = build_request(:update_topic_permissions, params)
  req.send_request(options)
end

#update_topic_permissions_v2(params = {}) ⇒ `Types::UpdateTopicPermissionsV2Response`

Updates the permissions of a topic.

Examples:

Request syntax with placeholder values


resp = client.update_topic_permissions_v2({
  aws_account_id: "AwsAccountId", # required
  topic_id: "TopicId", # required
  grant_permissions: [
    {
      principal: "Principal", # required
      actions: ["String"], # required
    },
  ],
  revoke_permissions: [
    {
      principal: "Principal", # required
      actions: ["String"], # required
    },
  ],
})

Response structure


resp.topic_id #=> String
resp.topic_arn #=> String
resp.permissions #=> Array
resp.permissions[0].principal #=> String
resp.permissions[0].actions #=> Array
resp.permissions[0].actions[0] #=> String
resp.status #=> Integer
resp.request_id #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:aws_account_id (required, String) —
The ID of the Amazon Web Services account that contains the topic that you want to update the permissions for.
:topic_id (required, String) —
The ID of the topic that you want to modify. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
:grant_permissions (Array<Types::ResourcePermission>) —
The resource permissions that you want to grant to the topic.
:revoke_permissions (Array<Types::ResourcePermission>) —
The resource permissions that you want to revoke from the topic.

Returns:

(Types::UpdateTopicPermissionsV2Response) —
Returns a response object which responds to the following methods:
- #topic_id => String
- #topic_arn => String
- #permissions => Array<Types::ResourcePermission>
- #status => Integer
- #request_id => String

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 26027

def update_topic_permissions_v2(params = {}, options = {})
  req = build_request(:update_topic_permissions_v2, params)
  req.send_request(options)
end

#update_topic_refresh_schedule(params = {}) ⇒ `Types::UpdateTopicRefreshScheduleResponse`

Updates a topic refresh schedule.

Examples:

Request syntax with placeholder values


resp = client.update_topic_refresh_schedule({
  aws_account_id: "AwsAccountId", # required
  topic_id: "TopicId", # required
  dataset_id: "String", # required
  refresh_schedule: { # required
    is_enabled: false, # required
    based_on_spice_schedule: false, # required
    starting_at: Time.now,
    timezone: "LimitedString",
    repeat_at: "LimitedString",
    topic_schedule_type: "HOURLY", # accepts HOURLY, DAILY, WEEKLY, MONTHLY
  },
})

Response structure


resp.topic_id #=> String
resp.topic_arn #=> String
resp.dataset_arn #=> String
resp.status #=> Integer
resp.request_id #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:aws_account_id (required, String) —
The ID of the Amazon Web Services account that contains the topic whose refresh schedule you want to update.
:topic_id (required, String) —
The ID of the topic that you want to modify. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
:dataset_id (required, String) —
The ID of the dataset.
:refresh_schedule (required, Types::TopicRefreshSchedule) —
The definition of a refresh schedule.

Returns:

(Types::UpdateTopicRefreshScheduleResponse) —
Returns a response object which responds to the following methods:
- #topic_id => String
- #topic_arn => String
- #dataset_arn => String
- #status => Integer
- #request_id => String

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 26084

def update_topic_refresh_schedule(params = {}, options = {})
  req = build_request(:update_topic_refresh_schedule, params)
  req.send_request(options)
end

#update_topic_v2(params = {}) ⇒ `Types::UpdateTopicV2Response`

Updates the definition of a Q topic.

Examples:

Request syntax with placeholder values


resp = client.update_topic_v2({
  aws_account_id: "AwsAccountId", # required
  topic_id: "TopicId", # required
  topic: { # required
    name: "ResourceName", # required
    description: "LimitedString",
    data_sets: [
      {
        data_set_arn: "Arn", # required
        data_set_name: "LimitedString",
      },
    ],
    data_set_relations: [
      {
        left: { # required
          data_set_arn: "Arn", # required
          column_names: ["String"], # required
        },
        right: { # required
          data_set_arn: "Arn", # required
          column_names: ["String"], # required
        },
      },
    ],
  },
  custom_instructions: {
    custom_instructions_string: "CustomInstructionsString", # required
  },
  publish_option: "DRAFT", # accepts DRAFT, PUBLISH
})

Response structure


resp.arn #=> String
resp.topic_id #=> String
resp.request_id #=> String
resp.status #=> Integer

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:aws_account_id (required, String) —
The ID of the Amazon Web Services account that contains the topic that you want to update.
:topic_id (required, String) —
The ID of the topic that you want to modify. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
:topic (required, Types::TopicV2Details) —
The definition of the topic that you want to update.
:custom_instructions (Types::CustomInstructions) —
Instructions that provide additional guidance and context for response generation.
:publish_option (String) —
The publish option for the topic that you want to update.

Returns:

(Types::UpdateTopicV2Response) —
Returns a response object which responds to the following methods:
- #arn => String
- #topic_id => String
- #request_id => String
- #status => Integer

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 26160

def update_topic_v2(params = {}, options = {})
  req = build_request(:update_topic_v2, params)
  req.send_request(options)
end

#update_user(params = {}) ⇒ `Types::UpdateUserResponse`

Updates an Amazon Quick Sight user.

Examples:

Request syntax with placeholder values


resp = client.update_user({
  user_name: "UserName", # required
  aws_account_id: "AwsAccountId", # required
  namespace: "Namespace", # required
  email: "String", # required
  role: "ADMIN", # required, accepts ADMIN, AUTHOR, READER, RESTRICTED_AUTHOR, RESTRICTED_READER, ADMIN_PRO, AUTHOR_PRO, READER_PRO
  custom_permissions_name: "RoleName",
  unapply_custom_permissions: false,
  external_login_federation_provider_type: "String",
  custom_federation_provider_url: "String",
  external_login_id: "String",
})

Response structure


resp.user.arn #=> String
resp.user.user_name #=> String
resp.user.email #=> String
resp.user.role #=> String, one of "ADMIN", "AUTHOR", "READER", "RESTRICTED_AUTHOR", "RESTRICTED_READER", "ADMIN_PRO", "AUTHOR_PRO", "READER_PRO"
resp.user.identity_type #=> String, one of "IAM", "QUICKSIGHT", "IAM_IDENTITY_CENTER"
resp.user.active #=> Boolean
resp.user.principal_id #=> String
resp.user.custom_permissions_name #=> String
resp.user.external_login_federation_provider_type #=> String
resp.user.external_login_federation_provider_url #=> String
resp.user.external_login_id #=> String
resp.request_id #=> String
resp.status #=> Integer

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:user_name (required, String) —
The Amazon Quick Sight user name that you want to update.
:aws_account_id (required, String) —
The ID for the Amazon Web Services account that the user is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon Quick Sight account.
:namespace (required, String) —
The namespace. Currently, you should set this to default.
:email (required, String) —
The email address of the user that you want to update.
:role (required, String) —
The Amazon Quick Sight role of the user. The role can be one of the following default security cohorts:
- READER: A user who has read-only access to dashboards.
- AUTHOR: A user who can create data sources, datasets, analyses, and dashboards.
- ADMIN: A user who is an author, who can also manage Amazon Quick Sight settings.
- READER_PRO: Reader Pro adds Generative BI capabilities to the Reader role. Reader Pros have access to Amazon Q in Quick Sight, can build stories with Amazon Q, and can generate executive summaries from dashboards.
- AUTHOR_PRO: Author Pro adds Generative BI capabilities to the Author role. Author Pros can author dashboards with natural language with Amazon Q, build stories with Amazon Q, create Topics for Q&A, and generate executive summaries from dashboards.
- ADMIN_PRO: Admin Pros are Author Pros who can also manage Amazon Quick Sight administrative settings. Admin Pro users are billed at Author Pro pricing.
The name of the Quick Sight role is invisible to the user except for the console screens dealing with permissions.
:custom_permissions_name (String) — default: Enterprise edition only —
The name of the custom permissions profile that you want to assign to this user. Customized permissions allows you to control a user's access by restricting access the following operations:
- Create and update data sources
- Create and update datasets
- Create and update email reports
- Subscribe to email reports
A set of custom permissions includes any combination of these restrictions. Currently, you need to create the profile names for custom permission sets by using the Quick Sight console. Then, you use the RegisterUser API operation to assign the named set of permissions to a Quick Sight user.

Quick Sight custom permissions are applied through IAM policies. Therefore, they override the permissions typically granted by assigning Quick Sight users to one of the default security cohorts in Quick Sight (admin, author, reader).

This feature is available only to Quick Sight Enterprise edition subscriptions.
:unapply_custom_permissions (Boolean) —
A flag that you use to indicate that you want to remove all custom permissions from this user. Using this parameter resets the user to the state it was in before a custom permissions profile was applied. This parameter defaults to NULL and it doesn't accept any other value.
:external_login_federation_provider_type (String) —
The type of supported external login provider that provides identity to let a user federate into Quick Sight with an associated Identity and Access Management(IAM) role. The type of supported external login provider can be one of the following.
- COGNITO: Amazon Cognito. The provider URL is cognito-identity.amazonaws.com. When choosing the COGNITO provider type, don’t use the "CustomFederationProviderUrl" parameter which is only needed when the external provider is custom.
- CUSTOM_OIDC: Custom OpenID Connect (OIDC) provider. When choosing CUSTOM_OIDC type, use the CustomFederationProviderUrl parameter to provide the custom OIDC provider URL.
- NONE: This clears all the previously saved external login information for a user. Use the DescribeUser API operation to check the external login information.
:custom_federation_provider_url (String) —
The URL of the custom OpenID Connect (OIDC) provider that provides identity to let a user federate into Quick Sight with an associated Identity and Access Management(IAM) role. This parameter should only be used when ExternalLoginFederationProviderType parameter is set to CUSTOM_OIDC.
:external_login_id (String) —
The identity ID for a user in the external login provider.

Returns:

(Types::UpdateUserResponse) —
Returns a response object which responds to the following methods:
- #user => Types::User
- #request_id => String
- #status => Integer

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 26315

def update_user(params = {}, options = {})
  req = build_request(:update_user, params)
  req.send_request(options)
end

#update_user_custom_permission(params = {}) ⇒ `Types::UpdateUserCustomPermissionResponse`

Updates a custom permissions profile for a user.

Examples:

Request syntax with placeholder values


resp = client.update_user_custom_permission({
  user_name: "UserName", # required
  aws_account_id: "AwsAccountId", # required
  namespace: "Namespace", # required
  custom_permissions_name: "CustomPermissionsName", # required
})

Response structure


resp.request_id #=> String
resp.status #=> Integer

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:user_name (required, String) —
The username of the user that you want to update custom permissions for.
:aws_account_id (required, String) —
The ID of the Amazon Web Services account that contains the custom permission configuration that you want to update.
:namespace (required, String) —
The namespace that the user belongs to.
:custom_permissions_name (required, String) —
The name of the custom permissions that you want to update.

Returns:

(Types::UpdateUserCustomPermissionResponse) —
Returns a response object which responds to the following methods:
- #request_id => String
- #status => Integer

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 26359

def update_user_custom_permission(params = {}, options = {})
  req = build_request(:update_user_custom_permission, params)
  req.send_request(options)
end

#update_vpc_connection(params = {}) ⇒ `Types::UpdateVPCConnectionResponse`

Updates a VPC connection.

Examples:

Request syntax with placeholder values


resp = client.update_vpc_connection({
  aws_account_id: "AwsAccountId", # required
  vpc_connection_id: "VPCConnectionResourceIdUnrestricted", # required
  name: "ResourceName", # required
  subnet_ids: ["SubnetId"], # required
  security_group_ids: ["SecurityGroupId"], # required
  dns_resolvers: ["IPv4Address"],
  role_arn: "RoleArn", # required
})

Response structure


resp.arn #=> String
resp.vpc_connection_id #=> String
resp.update_status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED", "DELETION_IN_PROGRESS", "DELETION_FAILED", "DELETED"
resp.availability_status #=> String, one of "AVAILABLE", "UNAVAILABLE", "PARTIALLY_AVAILABLE"
resp.request_id #=> String
resp.status #=> Integer

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:aws_account_id (required, String) —
The Amazon Web Services account ID of the account that contains the VPC connection that you want to update.
:vpc_connection_id (required, String) —
The ID of the VPC connection that you're updating. This ID is a unique identifier for each Amazon Web Services Region in an Amazon Web Services account.
:name (required, String) —
The display name for the VPC connection.
:subnet_ids (required, Array<String>) —
A list of subnet IDs for the VPC connection.
:security_group_ids (required, Array<String>) —
A list of security group IDs for the VPC connection.
:dns_resolvers (Array<String>) —
A list of IP addresses of DNS resolver endpoints for the VPC connection.
:role_arn (required, String) —
An IAM role associated with the VPC connection.

Returns:

(Types::UpdateVPCConnectionResponse) —
Returns a response object which responds to the following methods:
- #arn => String
- #vpc_connection_id => String
- #update_status => String
- #availability_status => String
- #request_id => String
- #status => Integer

See Also:

AWS API Documentation

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 26425

def update_vpc_connection(params = {}, options = {})
  req = build_request(:update_vpc_connection, params)
  req.send_request(options)
end

Overview

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

API Operations collapse

Instance Method Summary collapse

Methods included from ClientStubs

Methods inherited from Seahorse::Client::Base

Methods included from Seahorse::Client::HandlerBuilder

Constructor Details

#initialize(options) ⇒ Client

Instance Method Details

#batch_create_topic_reviewed_answer(params = {}) ⇒ Types::BatchCreateTopicReviewedAnswerResponse

Examples:

Request syntax with placeholder values

Response structure

#batch_delete_knowledge_base(params = {}) ⇒ Types::BatchDeleteKnowledgeBaseResponse

Examples:

Request syntax with placeholder values

Response structure

#batch_delete_topic_reviewed_answer(params = {}) ⇒ Types::BatchDeleteTopicReviewedAnswerResponse

Examples:

Request syntax with placeholder values

Response structure

#batch_describe_user_limits(params = {}) ⇒ Types::BatchDescribeUserLimitsResponse

Examples:

Request syntax with placeholder values

Response structure

#cancel_ingestion(params = {}) ⇒ Types::CancelIngestionResponse

Examples:

Request syntax with placeholder values

Response structure

#create_account_customization(params = {}) ⇒ Types::CreateAccountCustomizationResponse

Examples:

Request syntax with placeholder values

Response structure

#create_account_subscription(params = {}) ⇒ Types::CreateAccountSubscriptionResponse

Examples:

Request syntax with placeholder values

Response structure

#create_action_connector(params = {}) ⇒ Types::CreateActionConnectorResponse

Examples:

Request syntax with placeholder values

Response structure

#create_agent(params = {}) ⇒ Types::CreateAgentResponse

Examples:

Request syntax with placeholder values

Response structure

#create_analysis(params = {}) ⇒ Types::CreateAnalysisResponse

Examples:

Response structure

#create_approval_policy(params = {}) ⇒ Types::CreateApprovalPolicyResponse

Examples:

Request syntax with placeholder values

Response structure

#create_brand(params = {}) ⇒ Types::CreateBrandResponse

Examples:

Request syntax with placeholder values

Response structure

#create_custom_permissions(params = {}) ⇒ Types::CreateCustomPermissionsResponse

Examples:

Request syntax with placeholder values

Response structure

#create_dashboard(params = {}) ⇒ Types::CreateDashboardResponse

Examples:

Response structure

#create_data_set(params = {}) ⇒ Types::CreateDataSetResponse

Examples:

Request syntax with placeholder values

Response structure

#create_data_source(params = {}) ⇒ Types::CreateDataSourceResponse

Examples:

Request syntax with placeholder values

Response structure

#create_dlp_setting(params = {}) ⇒ Types::CreateDlpSettingResponse

Examples:

Request syntax with placeholder values

Response structure

#create_flow(params = {}) ⇒ Types::CreateFlowResponse

Examples:

#initialize(options) ⇒ `Client`

#batch_create_topic_reviewed_answer(params = {}) ⇒ `Types::BatchCreateTopicReviewedAnswerResponse`

#batch_delete_knowledge_base(params = {}) ⇒ `Types::BatchDeleteKnowledgeBaseResponse`

#batch_delete_topic_reviewed_answer(params = {}) ⇒ `Types::BatchDeleteTopicReviewedAnswerResponse`

#batch_describe_user_limits(params = {}) ⇒ `Types::BatchDescribeUserLimitsResponse`

#cancel_ingestion(params = {}) ⇒ `Types::CancelIngestionResponse`

#create_account_customization(params = {}) ⇒ `Types::CreateAccountCustomizationResponse`

#create_account_subscription(params = {}) ⇒ `Types::CreateAccountSubscriptionResponse`

#create_action_connector(params = {}) ⇒ `Types::CreateActionConnectorResponse`

#create_agent(params = {}) ⇒ `Types::CreateAgentResponse`

#create_analysis(params = {}) ⇒ `Types::CreateAnalysisResponse`

#create_approval_policy(params = {}) ⇒ `Types::CreateApprovalPolicyResponse`

#create_brand(params = {}) ⇒ `Types::CreateBrandResponse`

#create_custom_permissions(params = {}) ⇒ `Types::CreateCustomPermissionsResponse`

#create_dashboard(params = {}) ⇒ `Types::CreateDashboardResponse`

#create_data_set(params = {}) ⇒ `Types::CreateDataSetResponse`

#create_data_source(params = {}) ⇒ `Types::CreateDataSourceResponse`

#create_dlp_setting(params = {}) ⇒ `Types::CreateDlpSettingResponse`

#create_flow(params = {}) ⇒ `Types::CreateFlowResponse`

#create_folder(params = {}) ⇒ `Types::CreateFolderResponse`

#create_folder_membership(params = {}) ⇒ `Types::CreateFolderMembershipResponse`

#create_group(params = {}) ⇒ `Types::CreateGroupResponse`

#create_group_membership(params = {}) ⇒ `Types::CreateGroupMembershipResponse`

#create_iam_policy_assignment(params = {}) ⇒ `Types::CreateIAMPolicyAssignmentResponse`

#create_ingestion(params = {}) ⇒ `Types::CreateIngestionResponse`

#create_knowledge_base(params = {}) ⇒ `Types::CreateKnowledgeBaseResponse`

#create_limits_profile(params = {}) ⇒ `Types::CreateLimitsProfileResponse`

#create_namespace(params = {}) ⇒ `Types::CreateNamespaceResponse`

#create_o_auth_client_application(params = {}) ⇒ `Types::CreateOAuthClientApplicationResponse`

#create_refresh_schedule(params = {}) ⇒ `Types::CreateRefreshScheduleResponse`

#create_role_membership(params = {}) ⇒ `Types::CreateRoleMembershipResponse`

#create_space(params = {}) ⇒ `Types::CreateSpaceResponse`

#create_template(params = {}) ⇒ `Types::CreateTemplateResponse`

#create_template_alias(params = {}) ⇒ `Types::CreateTemplateAliasResponse`

#create_theme(params = {}) ⇒ `Types::CreateThemeResponse`

#create_theme_alias(params = {}) ⇒ `Types::CreateThemeAliasResponse`

#create_topic(params = {}) ⇒ `Types::CreateTopicResponse`