aws-sdk-quicksight 1.76.0 → 1.78.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 235c2032b1b289879d4c3eee4e624bc04f5535a598e014909f0dafb753f75b69
4
- data.tar.gz: 3f6f857c42b2a2b6ab87cb9322d850ed158b928fb2c1fbbef63c4423897a36d8
3
+ metadata.gz: 2cb85f00b56f24761049a73d242def4d3a645aeba42425f4784784bb84fc59d4
4
+ data.tar.gz: f6e8825d6599d95f7a8ec2358876960e360f4d313e659190dd8f4ef54c2dc537
5
5
  SHA512:
6
- metadata.gz: 600c7340719aa8f0820935880f17159a108f8ab2f9a4f85b7038127d0af7d9fcbd36a689644af06a56f9715a3b6943a3d2db6a48b80ec5fde9f6ca686a79658a
7
- data.tar.gz: c60dd3605a0a7255f6869ded3f9433ba9553e6188ffd35c4fb0aed921925a5f9a0acf1f06c13a35cd4acafda857b93b6078c1aab7724d00be2c3d45d6aabbd8e
6
+ metadata.gz: a3a554397fed4cab6da6c82158fc1d135a06f1a5a725c217f1d717eb5fbdb97eb8907b28ee6dbca4ac9e4ccd94dde5f0041d28efccf408835c9829aa46062950
7
+ data.tar.gz: 9708925137a392f48e3c70d69fc592d9d36d217d1013b2ca537f2e8de7dee53b3358f41a988bc6eb47135ef35e7169bb1c88dd525de02e9adaffa36cc14df991
data/CHANGELOG.md CHANGED
@@ -1,6 +1,16 @@
1
1
  Unreleased Changes
2
2
  ------------------
3
3
 
4
+ 1.78.0 (2023-04-07)
5
+ ------------------
6
+
7
+ * Feature - This release has two changes: adding the OR condition to tag-based RLS rules in CreateDataSet and UpdateDataSet; adding RefreshSchedule and Incremental RefreshProperties operations for users to programmatically configure SPICE dataset ingestions.
8
+
9
+ 1.77.0 (2023-03-09)
10
+ ------------------
11
+
12
+ * Feature - This release has two changes: add state persistence feature for embedded dashboard and console in GenerateEmbedUrlForRegisteredUser API; add properties for hidden collapsed row dimensions in PivotTableOptions.
13
+
4
14
  1.76.0 (2023-02-21)
5
15
  ------------------
6
16
 
data/VERSION CHANGED
@@ -1 +1 @@
1
- 1.76.0
1
+ 1.78.0
@@ -1114,6 +1114,9 @@ module Aws::QuickSight
1114
1114
  # match_all_value: "SessionTagValue",
1115
1115
  # },
1116
1116
  # ],
1117
+ # tag_rule_configurations: [
1118
+ # ["SessionTagKey"],
1119
+ # ],
1117
1120
  # },
1118
1121
  # column_level_permission_rules: [
1119
1122
  # {
@@ -1906,6 +1909,63 @@ module Aws::QuickSight
1906
1909
  req.send_request(options)
1907
1910
  end
1908
1911
 
1912
+ # Creates a refresh schedule for a dataset. You can create up to 5
1913
+ # different schedules for a single dataset.
1914
+ #
1915
+ # @option params [required, String] :data_set_id
1916
+ # The ID of the dataset.
1917
+ #
1918
+ # @option params [required, String] :aws_account_id
1919
+ # The Amazon Web Services account ID.
1920
+ #
1921
+ # @option params [required, Types::RefreshSchedule] :schedule
1922
+ # The refresh schedule.
1923
+ #
1924
+ # @return [Types::CreateRefreshScheduleResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1925
+ #
1926
+ # * {Types::CreateRefreshScheduleResponse#status #status} => Integer
1927
+ # * {Types::CreateRefreshScheduleResponse#request_id #request_id} => String
1928
+ # * {Types::CreateRefreshScheduleResponse#schedule_id #schedule_id} => String
1929
+ # * {Types::CreateRefreshScheduleResponse#arn #arn} => String
1930
+ #
1931
+ # @example Request syntax with placeholder values
1932
+ #
1933
+ # resp = client.create_refresh_schedule({
1934
+ # data_set_id: "ResourceId", # required
1935
+ # aws_account_id: "AwsAccountId", # required
1936
+ # schedule: { # required
1937
+ # schedule_id: "String", # required
1938
+ # schedule_frequency: { # required
1939
+ # interval: "MINUTE15", # required, accepts MINUTE15, MINUTE30, HOURLY, DAILY, WEEKLY, MONTHLY
1940
+ # refresh_on_day: {
1941
+ # day_of_week: "SUNDAY", # accepts SUNDAY, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY
1942
+ # day_of_month: "DayOfMonth",
1943
+ # },
1944
+ # timezone: "String",
1945
+ # time_of_the_day: "String",
1946
+ # },
1947
+ # start_after_date_time: Time.now,
1948
+ # refresh_type: "INCREMENTAL_REFRESH", # required, accepts INCREMENTAL_REFRESH, FULL_REFRESH
1949
+ # arn: "Arn",
1950
+ # },
1951
+ # })
1952
+ #
1953
+ # @example Response structure
1954
+ #
1955
+ # resp.status #=> Integer
1956
+ # resp.request_id #=> String
1957
+ # resp.schedule_id #=> String
1958
+ # resp.arn #=> String
1959
+ #
1960
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CreateRefreshSchedule AWS API Documentation
1961
+ #
1962
+ # @overload create_refresh_schedule(params = {})
1963
+ # @param [Hash] params ({})
1964
+ def create_refresh_schedule(params = {}, options = {})
1965
+ req = build_request(:create_refresh_schedule, params)
1966
+ req.send_request(options)
1967
+ end
1968
+
1909
1969
  # Creates a template either from a `TemplateDefinition` or from an
1910
1970
  # existing Amazon QuickSight analysis or template. You can use the
1911
1971
  # resulting template to create additional dashboards, templates, or
@@ -2467,6 +2527,40 @@ module Aws::QuickSight
2467
2527
  req.send_request(options)
2468
2528
  end
2469
2529
 
2530
+ # Deletes the dataset refresh properties of the dataset.
2531
+ #
2532
+ # @option params [required, String] :aws_account_id
2533
+ # The Amazon Web Services account ID.
2534
+ #
2535
+ # @option params [required, String] :data_set_id
2536
+ # The ID of the dataset.
2537
+ #
2538
+ # @return [Types::DeleteDataSetRefreshPropertiesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2539
+ #
2540
+ # * {Types::DeleteDataSetRefreshPropertiesResponse#request_id #request_id} => String
2541
+ # * {Types::DeleteDataSetRefreshPropertiesResponse#status #status} => Integer
2542
+ #
2543
+ # @example Request syntax with placeholder values
2544
+ #
2545
+ # resp = client.delete_data_set_refresh_properties({
2546
+ # aws_account_id: "AwsAccountId", # required
2547
+ # data_set_id: "ResourceId", # required
2548
+ # })
2549
+ #
2550
+ # @example Response structure
2551
+ #
2552
+ # resp.request_id #=> String
2553
+ # resp.status #=> Integer
2554
+ #
2555
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DeleteDataSetRefreshProperties AWS API Documentation
2556
+ #
2557
+ # @overload delete_data_set_refresh_properties(params = {})
2558
+ # @param [Hash] params ({})
2559
+ def delete_data_set_refresh_properties(params = {}, options = {})
2560
+ req = build_request(:delete_data_set_refresh_properties, params)
2561
+ req.send_request(options)
2562
+ end
2563
+
2470
2564
  # Deletes the data source permanently. This operation breaks all the
2471
2565
  # datasets that reference the deleted data source.
2472
2566
  #
@@ -2756,6 +2850,48 @@ module Aws::QuickSight
2756
2850
  req.send_request(options)
2757
2851
  end
2758
2852
 
2853
+ # Deletes a refresh schedule from a dataset.
2854
+ #
2855
+ # @option params [required, String] :data_set_id
2856
+ # The ID of the dataset.
2857
+ #
2858
+ # @option params [required, String] :aws_account_id
2859
+ # The Amazon Web Services account ID.
2860
+ #
2861
+ # @option params [required, String] :schedule_id
2862
+ # The ID of the refresh schedule.
2863
+ #
2864
+ # @return [Types::DeleteRefreshScheduleResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2865
+ #
2866
+ # * {Types::DeleteRefreshScheduleResponse#status #status} => Integer
2867
+ # * {Types::DeleteRefreshScheduleResponse#request_id #request_id} => String
2868
+ # * {Types::DeleteRefreshScheduleResponse#schedule_id #schedule_id} => String
2869
+ # * {Types::DeleteRefreshScheduleResponse#arn #arn} => String
2870
+ #
2871
+ # @example Request syntax with placeholder values
2872
+ #
2873
+ # resp = client.delete_refresh_schedule({
2874
+ # data_set_id: "ResourceId", # required
2875
+ # aws_account_id: "AwsAccountId", # required
2876
+ # schedule_id: "String", # required
2877
+ # })
2878
+ #
2879
+ # @example Response structure
2880
+ #
2881
+ # resp.status #=> Integer
2882
+ # resp.request_id #=> String
2883
+ # resp.schedule_id #=> String
2884
+ # resp.arn #=> String
2885
+ #
2886
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DeleteRefreshSchedule AWS API Documentation
2887
+ #
2888
+ # @overload delete_refresh_schedule(params = {})
2889
+ # @param [Hash] params ({})
2890
+ def delete_refresh_schedule(params = {}, options = {})
2891
+ req = build_request(:delete_refresh_schedule, params)
2892
+ req.send_request(options)
2893
+ end
2894
+
2759
2895
  # Deletes a template.
2760
2896
  #
2761
2897
  # @option params [required, String] :aws_account_id
@@ -2945,9 +3081,8 @@ module Aws::QuickSight
2945
3081
  end
2946
3082
 
2947
3083
  # Deletes the Amazon QuickSight user that is associated with the
2948
- # identity of the Identity and Access Management (IAM) user or role
2949
- # that's making the call. The IAM user isn't deleted as a result of
2950
- # this call.
3084
+ # identity of the IAM user or role that's making the call. The IAM user
3085
+ # isn't deleted as a result of this call.
2951
3086
  #
2952
3087
  # @option params [required, String] :user_name
2953
3088
  # The name of the user that you want to delete.
@@ -3652,6 +3787,9 @@ module Aws::QuickSight
3652
3787
  # resp.data_set.row_level_permission_tag_configuration.tag_rules[0].column_name #=> String
3653
3788
  # resp.data_set.row_level_permission_tag_configuration.tag_rules[0].tag_multi_value_delimiter #=> String
3654
3789
  # resp.data_set.row_level_permission_tag_configuration.tag_rules[0].match_all_value #=> String
3790
+ # resp.data_set.row_level_permission_tag_configuration.tag_rule_configurations #=> Array
3791
+ # resp.data_set.row_level_permission_tag_configuration.tag_rule_configurations[0] #=> Array
3792
+ # resp.data_set.row_level_permission_tag_configuration.tag_rule_configurations[0][0] #=> String
3655
3793
  # resp.data_set.column_level_permission_rules #=> Array
3656
3794
  # resp.data_set.column_level_permission_rules[0].principals #=> Array
3657
3795
  # resp.data_set.column_level_permission_rules[0].principals[0] #=> String
@@ -3718,6 +3856,44 @@ module Aws::QuickSight
3718
3856
  req.send_request(options)
3719
3857
  end
3720
3858
 
3859
+ # Describes the refresh properties of a dataset.
3860
+ #
3861
+ # @option params [required, String] :aws_account_id
3862
+ # The Amazon Web Services account ID.
3863
+ #
3864
+ # @option params [required, String] :data_set_id
3865
+ # The ID of the dataset.
3866
+ #
3867
+ # @return [Types::DescribeDataSetRefreshPropertiesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3868
+ #
3869
+ # * {Types::DescribeDataSetRefreshPropertiesResponse#request_id #request_id} => String
3870
+ # * {Types::DescribeDataSetRefreshPropertiesResponse#status #status} => Integer
3871
+ # * {Types::DescribeDataSetRefreshPropertiesResponse#data_set_refresh_properties #data_set_refresh_properties} => Types::DataSetRefreshProperties
3872
+ #
3873
+ # @example Request syntax with placeholder values
3874
+ #
3875
+ # resp = client.describe_data_set_refresh_properties({
3876
+ # aws_account_id: "AwsAccountId", # required
3877
+ # data_set_id: "ResourceId", # required
3878
+ # })
3879
+ #
3880
+ # @example Response structure
3881
+ #
3882
+ # resp.request_id #=> String
3883
+ # resp.status #=> Integer
3884
+ # resp.data_set_refresh_properties.refresh_configuration.incremental_refresh.lookback_window.column_name #=> String
3885
+ # resp.data_set_refresh_properties.refresh_configuration.incremental_refresh.lookback_window.size #=> Integer
3886
+ # resp.data_set_refresh_properties.refresh_configuration.incremental_refresh.lookback_window.size_unit #=> String, one of "HOUR", "DAY", "WEEK"
3887
+ #
3888
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeDataSetRefreshProperties AWS API Documentation
3889
+ #
3890
+ # @overload describe_data_set_refresh_properties(params = {})
3891
+ # @param [Hash] params ({})
3892
+ def describe_data_set_refresh_properties(params = {}, options = {})
3893
+ req = build_request(:describe_data_set_refresh_properties, params)
3894
+ req.send_request(options)
3895
+ end
3896
+
3721
3897
  # Describes a data source.
3722
3898
  #
3723
3899
  # @option params [required, String] :aws_account_id
@@ -4226,7 +4402,7 @@ module Aws::QuickSight
4226
4402
  # resp.ingestion.arn #=> String
4227
4403
  # resp.ingestion.ingestion_id #=> String
4228
4404
  # resp.ingestion.ingestion_status #=> String, one of "INITIALIZED", "QUEUED", "RUNNING", "FAILED", "COMPLETED", "CANCELLED"
4229
- # 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"
4405
+ # 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"
4230
4406
  # resp.ingestion.error_info.message #=> String
4231
4407
  # resp.ingestion.row_info.rows_ingested #=> Integer
4232
4408
  # resp.ingestion.row_info.rows_dropped #=> Integer
@@ -4330,6 +4506,56 @@ module Aws::QuickSight
4330
4506
  req.send_request(options)
4331
4507
  end
4332
4508
 
4509
+ # Provides a summary of a refresh schedule.
4510
+ #
4511
+ # @option params [required, String] :aws_account_id
4512
+ # The Amazon Web Services account ID.
4513
+ #
4514
+ # @option params [required, String] :data_set_id
4515
+ # The ID of the dataset.
4516
+ #
4517
+ # @option params [required, String] :schedule_id
4518
+ # The ID of the refresh schedule.
4519
+ #
4520
+ # @return [Types::DescribeRefreshScheduleResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
4521
+ #
4522
+ # * {Types::DescribeRefreshScheduleResponse#refresh_schedule #refresh_schedule} => Types::RefreshSchedule
4523
+ # * {Types::DescribeRefreshScheduleResponse#status #status} => Integer
4524
+ # * {Types::DescribeRefreshScheduleResponse#request_id #request_id} => String
4525
+ # * {Types::DescribeRefreshScheduleResponse#arn #arn} => String
4526
+ #
4527
+ # @example Request syntax with placeholder values
4528
+ #
4529
+ # resp = client.describe_refresh_schedule({
4530
+ # aws_account_id: "AwsAccountId", # required
4531
+ # data_set_id: "ResourceId", # required
4532
+ # schedule_id: "String", # required
4533
+ # })
4534
+ #
4535
+ # @example Response structure
4536
+ #
4537
+ # resp.refresh_schedule.schedule_id #=> String
4538
+ # resp.refresh_schedule.schedule_frequency.interval #=> String, one of "MINUTE15", "MINUTE30", "HOURLY", "DAILY", "WEEKLY", "MONTHLY"
4539
+ # resp.refresh_schedule.schedule_frequency.refresh_on_day.day_of_week #=> String, one of "SUNDAY", "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY"
4540
+ # resp.refresh_schedule.schedule_frequency.refresh_on_day.day_of_month #=> String
4541
+ # resp.refresh_schedule.schedule_frequency.timezone #=> String
4542
+ # resp.refresh_schedule.schedule_frequency.time_of_the_day #=> String
4543
+ # resp.refresh_schedule.start_after_date_time #=> Time
4544
+ # resp.refresh_schedule.refresh_type #=> String, one of "INCREMENTAL_REFRESH", "FULL_REFRESH"
4545
+ # resp.refresh_schedule.arn #=> String
4546
+ # resp.status #=> Integer
4547
+ # resp.request_id #=> String
4548
+ # resp.arn #=> String
4549
+ #
4550
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeRefreshSchedule AWS API Documentation
4551
+ #
4552
+ # @overload describe_refresh_schedule(params = {})
4553
+ # @param [Hash] params ({})
4554
+ def describe_refresh_schedule(params = {}, options = {})
4555
+ req = build_request(:describe_refresh_schedule, params)
4556
+ req.send_request(options)
4557
+ end
4558
+
4333
4559
  # Describes a template's metadata.
4334
4560
  #
4335
4561
  # @option params [required, String] :aws_account_id
@@ -5003,9 +5229,19 @@ module Aws::QuickSight
5003
5229
  # experience_configuration: { # required
5004
5230
  # dashboard: {
5005
5231
  # initial_dashboard_id: "ShortRestrictiveResourceId", # required
5232
+ # feature_configurations: {
5233
+ # state_persistence: {
5234
+ # enabled: false, # required
5235
+ # },
5236
+ # },
5006
5237
  # },
5007
5238
  # quick_sight_console: {
5008
5239
  # initial_path: "EntryPath",
5240
+ # feature_configurations: {
5241
+ # state_persistence: {
5242
+ # enabled: false, # required
5243
+ # },
5244
+ # },
5009
5245
  # },
5010
5246
  # q_search_bar: {
5011
5247
  # initial_topic_id: "RestrictiveResourceId",
@@ -5180,7 +5416,7 @@ module Aws::QuickSight
5180
5416
  # permissions profile to the user with the ` UpdateUser ` API operation.
5181
5417
  # Use ` RegisterUser ` API operation to add a new user with a custom
5182
5418
  # permission profile attached. For more information, see the following
5183
- # sections in the *Amazon QuickSight User Guide*\:
5419
+ # sections in the *Amazon QuickSight User Guide*:
5184
5420
  #
5185
5421
  # * [Embedding Analytics][1]
5186
5422
  #
@@ -5227,9 +5463,9 @@ module Aws::QuickSight
5227
5463
  #
5228
5464
  # 2. Invited nonfederated users
5229
5465
  #
5230
- # 3. Identity and Access Management (IAM) users and IAM role-based
5231
- # sessions authenticated through Federated Single Sign-On using
5232
- # SAML, OpenID Connect, or IAM federation
5466
+ # 3. IAM users and IAM role-based sessions authenticated through
5467
+ # Federated Single Sign-On using SAML, OpenID Connect, or IAM
5468
+ # federation
5233
5469
  #
5234
5470
  # Omit this parameter for users in the third group, IAM users and IAM
5235
5471
  # role-based sessions.
@@ -6009,7 +6245,7 @@ module Aws::QuickSight
6009
6245
  # resp.ingestions[0].arn #=> String
6010
6246
  # resp.ingestions[0].ingestion_id #=> String
6011
6247
  # resp.ingestions[0].ingestion_status #=> String, one of "INITIALIZED", "QUEUED", "RUNNING", "FAILED", "COMPLETED", "CANCELLED"
6012
- # 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"
6248
+ # 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"
6013
6249
  # resp.ingestions[0].error_info.message #=> String
6014
6250
  # resp.ingestions[0].row_info.rows_ingested #=> Integer
6015
6251
  # resp.ingestions[0].row_info.rows_dropped #=> Integer
@@ -6094,6 +6330,52 @@ module Aws::QuickSight
6094
6330
  req.send_request(options)
6095
6331
  end
6096
6332
 
6333
+ # Lists the refresh schedules of a dataset. Each dataset can have up to
6334
+ # 5 schedules.
6335
+ #
6336
+ # @option params [required, String] :aws_account_id
6337
+ # The Amazon Web Services account ID.
6338
+ #
6339
+ # @option params [required, String] :data_set_id
6340
+ # The ID of the dataset.
6341
+ #
6342
+ # @return [Types::ListRefreshSchedulesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
6343
+ #
6344
+ # * {Types::ListRefreshSchedulesResponse#refresh_schedules #refresh_schedules} => Array<Types::RefreshSchedule>
6345
+ # * {Types::ListRefreshSchedulesResponse#status #status} => Integer
6346
+ # * {Types::ListRefreshSchedulesResponse#request_id #request_id} => String
6347
+ #
6348
+ # @example Request syntax with placeholder values
6349
+ #
6350
+ # resp = client.list_refresh_schedules({
6351
+ # aws_account_id: "AwsAccountId", # required
6352
+ # data_set_id: "ResourceId", # required
6353
+ # })
6354
+ #
6355
+ # @example Response structure
6356
+ #
6357
+ # resp.refresh_schedules #=> Array
6358
+ # resp.refresh_schedules[0].schedule_id #=> String
6359
+ # resp.refresh_schedules[0].schedule_frequency.interval #=> String, one of "MINUTE15", "MINUTE30", "HOURLY", "DAILY", "WEEKLY", "MONTHLY"
6360
+ # resp.refresh_schedules[0].schedule_frequency.refresh_on_day.day_of_week #=> String, one of "SUNDAY", "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY"
6361
+ # resp.refresh_schedules[0].schedule_frequency.refresh_on_day.day_of_month #=> String
6362
+ # resp.refresh_schedules[0].schedule_frequency.timezone #=> String
6363
+ # resp.refresh_schedules[0].schedule_frequency.time_of_the_day #=> String
6364
+ # resp.refresh_schedules[0].start_after_date_time #=> Time
6365
+ # resp.refresh_schedules[0].refresh_type #=> String, one of "INCREMENTAL_REFRESH", "FULL_REFRESH"
6366
+ # resp.refresh_schedules[0].arn #=> String
6367
+ # resp.status #=> Integer
6368
+ # resp.request_id #=> String
6369
+ #
6370
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListRefreshSchedules AWS API Documentation
6371
+ #
6372
+ # @overload list_refresh_schedules(params = {})
6373
+ # @param [Hash] params ({})
6374
+ def list_refresh_schedules(params = {}, options = {})
6375
+ req = build_request(:list_refresh_schedules, params)
6376
+ req.send_request(options)
6377
+ end
6378
+
6097
6379
  # Lists the tags assigned to a resource.
6098
6380
  #
6099
6381
  # @option params [required, String] :resource_arn
@@ -6580,6 +6862,54 @@ module Aws::QuickSight
6580
6862
  req.send_request(options)
6581
6863
  end
6582
6864
 
6865
+ # Creates or updates the dataset refresh properties for the dataset.
6866
+ #
6867
+ # @option params [required, String] :aws_account_id
6868
+ # The Amazon Web Services account ID.
6869
+ #
6870
+ # @option params [required, String] :data_set_id
6871
+ # The ID of the dataset.
6872
+ #
6873
+ # @option params [required, Types::DataSetRefreshProperties] :data_set_refresh_properties
6874
+ # The dataset refresh properties.
6875
+ #
6876
+ # @return [Types::PutDataSetRefreshPropertiesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
6877
+ #
6878
+ # * {Types::PutDataSetRefreshPropertiesResponse#request_id #request_id} => String
6879
+ # * {Types::PutDataSetRefreshPropertiesResponse#status #status} => Integer
6880
+ #
6881
+ # @example Request syntax with placeholder values
6882
+ #
6883
+ # resp = client.put_data_set_refresh_properties({
6884
+ # aws_account_id: "AwsAccountId", # required
6885
+ # data_set_id: "ResourceId", # required
6886
+ # data_set_refresh_properties: { # required
6887
+ # refresh_configuration: { # required
6888
+ # incremental_refresh: { # required
6889
+ # lookback_window: { # required
6890
+ # column_name: "String", # required
6891
+ # size: 1, # required
6892
+ # size_unit: "HOUR", # required, accepts HOUR, DAY, WEEK
6893
+ # },
6894
+ # },
6895
+ # },
6896
+ # },
6897
+ # })
6898
+ #
6899
+ # @example Response structure
6900
+ #
6901
+ # resp.request_id #=> String
6902
+ # resp.status #=> Integer
6903
+ #
6904
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/PutDataSetRefreshProperties AWS API Documentation
6905
+ #
6906
+ # @overload put_data_set_refresh_properties(params = {})
6907
+ # @param [Hash] params ({})
6908
+ def put_data_set_refresh_properties(params = {}, options = {})
6909
+ req = build_request(:put_data_set_refresh_properties, params)
6910
+ req.send_request(options)
6911
+ end
6912
+
6583
6913
  # Creates an Amazon QuickSight user whose identity is associated with
6584
6914
  # the Identity and Access Management (IAM) identity or role specified in
6585
6915
  # the request. When you register a new user from the Amazon QuickSight
@@ -6600,9 +6930,9 @@ module Aws::QuickSight
6600
6930
  # Amazon QuickSight supports several ways of managing the identity of
6601
6931
  # users. This parameter accepts two values:
6602
6932
  #
6603
- # * `IAM`\: A user whose identity maps to an existing IAM user or role.
6933
+ # * `IAM`: A user whose identity maps to an existing IAM user or role.
6604
6934
  #
6605
- # * `QUICKSIGHT`\: A user whose identity is owned and managed internally
6935
+ # * `QUICKSIGHT`: A user whose identity is owned and managed internally
6606
6936
  # by Amazon QuickSight.
6607
6937
  #
6608
6938
  # @option params [required, String] :email
@@ -6612,17 +6942,17 @@ module Aws::QuickSight
6612
6942
  # The Amazon QuickSight role for the user. The user role can be one of
6613
6943
  # the following:
6614
6944
  #
6615
- # * `READER`\: A user who has read-only access to dashboards.
6945
+ # * `READER`: A user who has read-only access to dashboards.
6616
6946
  #
6617
- # * `AUTHOR`\: A user who can create data sources, datasets, analyses,
6947
+ # * `AUTHOR`: A user who can create data sources, datasets, analyses,
6618
6948
  # and dashboards.
6619
6949
  #
6620
- # * `ADMIN`\: A user who is an author, who can also manage Amazon
6950
+ # * `ADMIN`: A user who is an author, who can also manage Amazon
6621
6951
  # QuickSight settings.
6622
6952
  #
6623
- # * `RESTRICTED_READER`\: This role isn't currently available for use.
6953
+ # * `RESTRICTED_READER`: This role isn't currently available for use.
6624
6954
  #
6625
- # * `RESTRICTED_AUTHOR`\: This role isn't currently available for use.
6955
+ # * `RESTRICTED_AUTHOR`: This role isn't currently available for use.
6626
6956
  #
6627
6957
  # @option params [String] :iam_arn
6628
6958
  # The ARN of the IAM user or role that you are registering with Amazon
@@ -6690,12 +7020,12 @@ module Aws::QuickSight
6690
7020
  # Identity and Access Management(IAM) role. The type of supported
6691
7021
  # external login provider can be one of the following.
6692
7022
  #
6693
- # * `COGNITO`\: Amazon Cognito. The provider URL is
7023
+ # * `COGNITO`: Amazon Cognito. The provider URL is
6694
7024
  # cognito-identity.amazonaws.com. When choosing the `COGNITO` provider
6695
7025
  # type, don’t use the "CustomFederationProviderUrl" parameter which
6696
7026
  # is only needed when the external provider is custom.
6697
7027
  #
6698
- # * `CUSTOM_OIDC`\: Custom OpenID Connect (OIDC) provider. When choosing
7028
+ # * `CUSTOM_OIDC`: Custom OpenID Connect (OIDC) provider. When choosing
6699
7029
  # `CUSTOM_OIDC` type, use the `CustomFederationProviderUrl` parameter
6700
7030
  # to provide the custom OIDC provider URL.
6701
7031
  #
@@ -7361,9 +7691,9 @@ module Aws::QuickSight
7361
7691
  #
7362
7692
  # @option params [required, String] :default_namespace
7363
7693
  # The default namespace for this Amazon Web Services account. Currently,
7364
- # the default is `default`. Identity and Access Management (IAM) users
7365
- # that register for the first time with Amazon QuickSight provide an
7366
- # email address that becomes associated with the default namespace.
7694
+ # the default is `default`. IAM users that register for the first time
7695
+ # with Amazon QuickSight provide an email address that becomes
7696
+ # associated with the default namespace.
7367
7697
  #
7368
7698
  # @option params [String] :notification_email
7369
7699
  # The email address that you want Amazon QuickSight to send
@@ -7962,6 +8292,9 @@ module Aws::QuickSight
7962
8292
  # match_all_value: "SessionTagValue",
7963
8293
  # },
7964
8294
  # ],
8295
+ # tag_rule_configurations: [
8296
+ # ["SessionTagKey"],
8297
+ # ],
7965
8298
  # },
7966
8299
  # column_level_permission_rules: [
7967
8300
  # {
@@ -8729,6 +9062,62 @@ module Aws::QuickSight
8729
9062
  req.send_request(options)
8730
9063
  end
8731
9064
 
9065
+ # Updates a refresh schedule for a dataset.
9066
+ #
9067
+ # @option params [required, String] :data_set_id
9068
+ # The ID of the dataset.
9069
+ #
9070
+ # @option params [required, String] :aws_account_id
9071
+ # The Amazon Web Services account ID.
9072
+ #
9073
+ # @option params [required, Types::RefreshSchedule] :schedule
9074
+ # The refresh schedule.
9075
+ #
9076
+ # @return [Types::UpdateRefreshScheduleResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
9077
+ #
9078
+ # * {Types::UpdateRefreshScheduleResponse#status #status} => Integer
9079
+ # * {Types::UpdateRefreshScheduleResponse#request_id #request_id} => String
9080
+ # * {Types::UpdateRefreshScheduleResponse#schedule_id #schedule_id} => String
9081
+ # * {Types::UpdateRefreshScheduleResponse#arn #arn} => String
9082
+ #
9083
+ # @example Request syntax with placeholder values
9084
+ #
9085
+ # resp = client.update_refresh_schedule({
9086
+ # data_set_id: "ResourceId", # required
9087
+ # aws_account_id: "AwsAccountId", # required
9088
+ # schedule: { # required
9089
+ # schedule_id: "String", # required
9090
+ # schedule_frequency: { # required
9091
+ # interval: "MINUTE15", # required, accepts MINUTE15, MINUTE30, HOURLY, DAILY, WEEKLY, MONTHLY
9092
+ # refresh_on_day: {
9093
+ # day_of_week: "SUNDAY", # accepts SUNDAY, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY
9094
+ # day_of_month: "DayOfMonth",
9095
+ # },
9096
+ # timezone: "String",
9097
+ # time_of_the_day: "String",
9098
+ # },
9099
+ # start_after_date_time: Time.now,
9100
+ # refresh_type: "INCREMENTAL_REFRESH", # required, accepts INCREMENTAL_REFRESH, FULL_REFRESH
9101
+ # arn: "Arn",
9102
+ # },
9103
+ # })
9104
+ #
9105
+ # @example Response structure
9106
+ #
9107
+ # resp.status #=> Integer
9108
+ # resp.request_id #=> String
9109
+ # resp.schedule_id #=> String
9110
+ # resp.arn #=> String
9111
+ #
9112
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateRefreshSchedule AWS API Documentation
9113
+ #
9114
+ # @overload update_refresh_schedule(params = {})
9115
+ # @param [Hash] params ({})
9116
+ def update_refresh_schedule(params = {}, options = {})
9117
+ req = build_request(:update_refresh_schedule, params)
9118
+ req.send_request(options)
9119
+ end
9120
+
8732
9121
  # Updates a template from an existing Amazon QuickSight analysis or
8733
9122
  # another template.
8734
9123
  #
@@ -9188,12 +9577,12 @@ module Aws::QuickSight
9188
9577
  # The Amazon QuickSight role of the user. The role can be one of the
9189
9578
  # following default security cohorts:
9190
9579
  #
9191
- # * `READER`\: A user who has read-only access to dashboards.
9580
+ # * `READER`: A user who has read-only access to dashboards.
9192
9581
  #
9193
- # * `AUTHOR`\: A user who can create data sources, datasets, analyses,
9582
+ # * `AUTHOR`: A user who can create data sources, datasets, analyses,
9194
9583
  # and dashboards.
9195
9584
  #
9196
- # * `ADMIN`\: A user who is an author, who can also manage Amazon
9585
+ # * `ADMIN`: A user who is an author, who can also manage Amazon
9197
9586
  # QuickSight settings.
9198
9587
  #
9199
9588
  # The name of the Amazon QuickSight role is invisible to the user except
@@ -9240,16 +9629,16 @@ module Aws::QuickSight
9240
9629
  # Identity and Access Management(IAM) role. The type of supported
9241
9630
  # external login provider can be one of the following.
9242
9631
  #
9243
- # * `COGNITO`\: Amazon Cognito. The provider URL is
9632
+ # * `COGNITO`: Amazon Cognito. The provider URL is
9244
9633
  # cognito-identity.amazonaws.com. When choosing the `COGNITO` provider
9245
9634
  # type, don’t use the "CustomFederationProviderUrl" parameter which
9246
9635
  # is only needed when the external provider is custom.
9247
9636
  #
9248
- # * `CUSTOM_OIDC`\: Custom OpenID Connect (OIDC) provider. When choosing
9637
+ # * `CUSTOM_OIDC`: Custom OpenID Connect (OIDC) provider. When choosing
9249
9638
  # `CUSTOM_OIDC` type, use the `CustomFederationProviderUrl` parameter
9250
9639
  # to provide the custom OIDC provider URL.
9251
9640
  #
9252
- # * `NONE`\: This clears all the previously saved external login
9641
+ # * `NONE`: This clears all the previously saved external login
9253
9642
  # information for a user. Use the ` DescribeUser ` API operation to
9254
9643
  # check the external login information.
9255
9644
  #
@@ -9322,7 +9711,7 @@ module Aws::QuickSight
9322
9711
  params: params,
9323
9712
  config: config)
9324
9713
  context[:gem_name] = 'aws-sdk-quicksight'
9325
- context[:gem_version] = '1.76.0'
9714
+ context[:gem_version] = '1.78.0'
9326
9715
  Seahorse::Client::Request.new(handlers, context)
9327
9716
  end
9328
9717