aws-sdk-quicksight 1.86.0 → 1.87.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ae5efe48752e5be70040e1627f380571f959f64d981ce8dcca64214d09fed41b
-  data.tar.gz: 651c93b90ed807f78346892f1ad86da1855dcfe35c34fbd1a1da72e693694514
+  metadata.gz: 49baa9aa30186ff7a046ecc329d61fa648609a3a28ea5c975e0397854c8677f8
+  data.tar.gz: 1d31e7de0e550ede3a60339a8178c057301077a825fda6548d0b71e47cd05f22
 SHA512:
-  metadata.gz: 46efa9095d383f48c3149136dd06cc37f8ed08bfbaf80f5a76474363d452d691054a6b194e6bc6c51528cc06cf1c2ebd3fd5c9b4cb287f80e7834e5a80af6726
-  data.tar.gz: c83981c06714cbac05d1ac48b10f05e7434d6c539fcdd308e2ea44175fd060e49388f3b9691627178891a68aa22a51f1c92bb7994d276a9fcb3d2968fc1e6373
+  metadata.gz: f4ed099bb1f69490cb3e7142c86c42456565b236d85386341d3125f1a027cd7d1c55dc8ede788f2c2ca9cebc567ff8d1d1daf3d46ad54de65aa6cbcbc1c4b557
+  data.tar.gz: 4bd13ada5ac8570a49db280ba1cba17f1bcb1ec4fd88306e72340344b17c39a0ec02e687bb181ef3b723444f9fea9dc42ee41aa44430a99219da55bb4278e08f

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 Unreleased Changes
 ------------------
 
+1.87.0 (2023-07-24)
+------------------
+
+* Feature - This release launches new Snapshot APIs for CSV and PDF exports, adds support for info icon for filters and parameters in Exploration APIs, adds modeled exception to the DeleteAccountCustomization API, and introduces AttributeAggregationFunction's ability to add UNIQUE_VALUE aggregation in tooltips.
+
 1.86.0 (2023-07-11)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.86.0
+1.87.0

data/lib/aws-sdk-quicksight/client.rb

@@ -4541,6 +4541,173 @@ module Aws::QuickSight
       req.send_request(options)
     end
 
+    # 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`.
+    #
+    # @option params [required, String] :aws_account_id
+    #   The ID of the Amazon Web Services account that the dashboard snapshot
+    #   job is executed in.
+    #
+    # @option params [required, String] :dashboard_id
+    #   The ID of the dashboard that you have started a snapshot job for.
+    #
+    # @option params [required, String] :snapshot_job_id
+    #   The ID of the job to be described. The job ID is set when you start a
+    #   new job with a `StartDashboardSnapshotJob` API call.
+    #
+    # @return [Types::DescribeDashboardSnapshotJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::DescribeDashboardSnapshotJobResponse#aws_account_id #aws_account_id} => String
+    #   * {Types::DescribeDashboardSnapshotJobResponse#dashboard_id #dashboard_id} => String
+    #   * {Types::DescribeDashboardSnapshotJobResponse#snapshot_job_id #snapshot_job_id} => String
+    #   * {Types::DescribeDashboardSnapshotJobResponse#user_configuration #user_configuration} => Types::SnapshotUserConfigurationRedacted
+    #   * {Types::DescribeDashboardSnapshotJobResponse#snapshot_configuration #snapshot_configuration} => Types::SnapshotConfiguration
+    #   * {Types::DescribeDashboardSnapshotJobResponse#arn #arn} => String
+    #   * {Types::DescribeDashboardSnapshotJobResponse#job_status #job_status} => String
+    #   * {Types::DescribeDashboardSnapshotJobResponse#created_time #created_time} => Time
+    #   * {Types::DescribeDashboardSnapshotJobResponse#last_updated_time #last_updated_time} => Time
+    #   * {Types::DescribeDashboardSnapshotJobResponse#request_id #request_id} => String
+    #   * {Types::DescribeDashboardSnapshotJobResponse#status #status} => Integer
+    #
+    # @example 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
+    #   })
+    #
+    # @example 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"
+    #   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
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeDashboardSnapshotJob AWS API Documentation
+    #
+    # @overload describe_dashboard_snapshot_job(params = {})
+    # @param [Hash] params ({})
+    def describe_dashboard_snapshot_job(params = {}, options = {})
+      req = build_request(:describe_dashboard_snapshot_job, params)
+      req.send_request(options)
+    end
+
+    # 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.`.
+    #
+    # @option params [required, String] :aws_account_id
+    #   The ID of the Amazon Web Services account that the dashboard snapshot
+    #   job is executed in.
+    #
+    # @option params [required, String] :dashboard_id
+    #   The ID of the dashboard that you have started a snapshot job for.
+    #
+    # @option params [required, String] :snapshot_job_id
+    #   The ID of the job to be described. The job ID is set when you start a
+    #   new job with a `StartDashboardSnapshotJob` API call.
+    #
+    # @return [Types::DescribeDashboardSnapshotJobResultResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::DescribeDashboardSnapshotJobResultResponse#arn #arn} => String
+    #   * {Types::DescribeDashboardSnapshotJobResultResponse#job_status #job_status} => String
+    #   * {Types::DescribeDashboardSnapshotJobResultResponse#created_time #created_time} => Time
+    #   * {Types::DescribeDashboardSnapshotJobResultResponse#last_updated_time #last_updated_time} => Time
+    #   * {Types::DescribeDashboardSnapshotJobResultResponse#result #result} => Types::SnapshotJobResult
+    #   * {Types::DescribeDashboardSnapshotJobResultResponse#error_info #error_info} => Types::SnapshotJobErrorInfo
+    #   * {Types::DescribeDashboardSnapshotJobResultResponse#request_id #request_id} => String
+    #   * {Types::DescribeDashboardSnapshotJobResultResponse#status #status} => Integer
+    #
+    # @example 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
+    #   })
+    #
+    # @example 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"
+    #   resp.result.anonymous_users[0].file_groups[0].s3_results #=> Array
+    #   resp.result.anonymous_users[0].file_groups[0].s3_results[0].s3_destination_configuration.bucket_configuration.bucket_name #=> String
+    #   resp.result.anonymous_users[0].file_groups[0].s3_results[0].s3_destination_configuration.bucket_configuration.bucket_prefix #=> String
+    #   resp.result.anonymous_users[0].file_groups[0].s3_results[0].s3_destination_configuration.bucket_configuration.bucket_region #=> String
+    #   resp.result.anonymous_users[0].file_groups[0].s3_results[0].s3_uri #=> String
+    #   resp.result.anonymous_users[0].file_groups[0].s3_results[0].error_info #=> Array
+    #   resp.result.anonymous_users[0].file_groups[0].s3_results[0].error_info[0].error_message #=> String
+    #   resp.result.anonymous_users[0].file_groups[0].s3_results[0].error_info[0].error_type #=> String
+    #   resp.error_info.error_message #=> String
+    #   resp.error_info.error_type #=> String
+    #   resp.request_id #=> String
+    #   resp.status #=> Integer
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeDashboardSnapshotJobResult AWS API Documentation
+    #
+    # @overload describe_dashboard_snapshot_job_result(params = {})
+    # @param [Hash] params ({})
+    def describe_dashboard_snapshot_job_result(params = {}, options = {})
+      req = build_request(:describe_dashboard_snapshot_job_result, params)
+      req.send_request(options)
+    end
+
     # Describes a dataset. This operation doesn't support datasets that
     # include uploaded files as a source.
     #
@@ -7417,6 +7584,8 @@ module Aws::QuickSight
     #   * {Types::ListGroupMembershipsResponse#request_id #request_id} => String
     #   * {Types::ListGroupMembershipsResponse#status #status} => Integer
     #
+    # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
+    #
     # @example Request syntax with placeholder values
     #
     #   resp = client.list_group_memberships({
@@ -7468,6 +7637,8 @@ module Aws::QuickSight
     #   * {Types::ListGroupsResponse#request_id #request_id} => String
     #   * {Types::ListGroupsResponse#status #status} => Integer
     #
+    # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
+    #
     # @example Request syntax with placeholder values
     #
     #   resp = client.list_groups({
@@ -7524,6 +7695,8 @@ module Aws::QuickSight
     #   * {Types::ListIAMPolicyAssignmentsResponse#request_id #request_id} => String
     #   * {Types::ListIAMPolicyAssignmentsResponse#status #status} => Integer
     #
+    # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
+    #
     # @example Request syntax with placeholder values
     #
     #   resp = client.list_iam_policy_assignments({
@@ -7580,6 +7753,8 @@ module Aws::QuickSight
     #   * {Types::ListIAMPolicyAssignmentsForUserResponse#next_token #next_token} => String
     #   * {Types::ListIAMPolicyAssignmentsForUserResponse#status #status} => Integer
     #
+    # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
+    #
     # @example Request syntax with placeholder values
     #
     #   resp = client.list_iam_policy_assignments_for_user({
@@ -8274,6 +8449,8 @@ module Aws::QuickSight
     #   * {Types::ListUserGroupsResponse#request_id #request_id} => String
     #   * {Types::ListUserGroupsResponse#status #status} => Integer
     #
+    # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
+    #
     # @example Request syntax with placeholder values
     #
     #   resp = client.list_user_groups({
@@ -8328,6 +8505,8 @@ module Aws::QuickSight
     #   * {Types::ListUsersResponse#request_id #request_id} => String
     #   * {Types::ListUsersResponse#status #status} => Integer
     #
+    # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
+    #
     # @example Request syntax with placeholder values
     #
     #   resp = client.list_users({
@@ -9052,6 +9231,8 @@ module Aws::QuickSight
     #   * {Types::SearchGroupsResponse#request_id #request_id} => String
     #   * {Types::SearchGroupsResponse#status #status} => Integer
     #
+    # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
+    #
     # @example Request syntax with placeholder values
     #
     #   resp = client.search_groups({
@@ -9475,6 +9656,134 @@ module Aws::QuickSight
       req.send_request(options)
     end
 
+    # Starts an asynchronous job that generates a dashboard snapshot. You
+    # can request up to one paginated PDF and up to five CSVs per API call.
+    #
+    # Poll job descriptions with a `DescribeDashboardSnapshotJob` API call.
+    # Once the job succeeds, use the `DescribeDashboardSnapshotJobResult`
+    # API to obtain the download URIs that the job generates.
+    #
+    # @option params [required, String] :aws_account_id
+    #   The ID of the Amazon Web Services account that the dashboard snapshot
+    #   job is executed in.
+    #
+    # @option params [required, String] :dashboard_id
+    #   The ID of the dashboard that you want to start a snapshot job for.
+    #
+    # @option params [required, String] :snapshot_job_id
+    #   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.
+    #
+    # @option params [required, Types::SnapshotUserConfiguration] :user_configuration
+    #   A structure that contains information about the anonymous users that
+    #   the generated snapshot is for. This API will not return information
+    #   about registered Amazon QuickSight.
+    #
+    # @option params [required, Types::SnapshotConfiguration] :snapshot_configuration
+    #   A structure that describes the configuration of the dashboard
+    #   snapshot.
+    #
+    # @return [Types::StartDashboardSnapshotJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::StartDashboardSnapshotJobResponse#arn #arn} => String
+    #   * {Types::StartDashboardSnapshotJobResponse#snapshot_job_id #snapshot_job_id} => String
+    #   * {Types::StartDashboardSnapshotJobResponse#request_id #request_id} => String
+    #   * {Types::StartDashboardSnapshotJobResponse#status #status} => Integer
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.start_dashboard_snapshot_job({
+    #     aws_account_id: "AwsAccountId", # required
+    #     dashboard_id: "ShortRestrictiveResourceId", # required
+    #     snapshot_job_id: "ShortRestrictiveResourceId", # required
+    #     user_configuration: { # required
+    #       anonymous_users: [
+    #         {
+    #           row_level_permission_tags: [
+    #             {
+    #               key: "SessionTagKey", # required
+    #               value: "SessionTagValue", # required
+    #             },
+    #           ],
+    #         },
+    #       ],
+    #     },
+    #     snapshot_configuration: { # required
+    #       file_groups: [ # required
+    #         {
+    #           files: [
+    #             {
+    #               sheet_selections: [ # required
+    #                 {
+    #                   sheet_id: "ShortRestrictiveResourceId", # required
+    #                   selection_scope: "ALL_VISUALS", # required, accepts ALL_VISUALS, SELECTED_VISUALS
+    #                   visual_ids: ["ShortRestrictiveResourceId"],
+    #                 },
+    #               ],
+    #               format_type: "CSV", # required, accepts CSV, PDF
+    #             },
+    #           ],
+    #         },
+    #       ],
+    #       destination_configuration: {
+    #         s3_destinations: [
+    #           {
+    #             bucket_configuration: {
+    #               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
+    #           },
+    #         ],
+    #       },
+    #     },
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.arn #=> String
+    #   resp.snapshot_job_id #=> String
+    #   resp.request_id #=> String
+    #   resp.status #=> Integer
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/StartDashboardSnapshotJob AWS API Documentation
+    #
+    # @overload start_dashboard_snapshot_job(params = {})
+    # @param [Hash] params ({})
+    def start_dashboard_snapshot_job(params = {}, options = {})
+      req = build_request(:start_dashboard_snapshot_job, params)
+      req.send_request(options)
+    end
+
     # Assigns one or more tags (key-value pairs) to the specified Amazon
     # QuickSight resource.
     #
@@ -12164,7 +12473,7 @@ module Aws::QuickSight
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-quicksight'
-      context[:gem_version] = '1.86.0'
+      context[:gem_version] = '1.87.0'
       Seahorse::Client::Request.new(handlers, context)
     end