aws-sdk-quicksight 1.79.0 → 1.80.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.
@@ -788,6 +788,729 @@ module Aws::QuickSight
788
788
  include Aws::Structure
789
789
  end
790
790
 
791
+ # An optional collection of CloudFormation property configurations that
792
+ # control how the export job is generated.
793
+ #
794
+ # @!attribute [rw] resource_id_override_configuration
795
+ # An optional list of structures that control how resource IDs are
796
+ # parameterized in the returned CloudFormation template.
797
+ # @return [Types::AssetBundleExportJobResourceIdOverrideConfiguration]
798
+ #
799
+ # @!attribute [rw] vpc_connections
800
+ # An optional list of structures that control how `VPCConnection`
801
+ # resources are parameterized in the returned CloudFormation template.
802
+ # @return [Array<Types::AssetBundleExportJobVPCConnectionOverrideProperties>]
803
+ #
804
+ # @!attribute [rw] refresh_schedules
805
+ # An optional list of structures that control how `RefreshSchedule`
806
+ # resources are parameterized in the returned CloudFormation template.
807
+ # @return [Array<Types::AssetBundleExportJobRefreshScheduleOverrideProperties>]
808
+ #
809
+ # @!attribute [rw] data_sources
810
+ # An optional list of structures that control how `DataSource`
811
+ # resources are parameterized in the returned CloudFormation template.
812
+ # @return [Array<Types::AssetBundleExportJobDataSourceOverrideProperties>]
813
+ #
814
+ # @!attribute [rw] data_sets
815
+ # An optional list of structures that control how `DataSet` resources
816
+ # are parameterized in the returned CloudFormation template.
817
+ # @return [Array<Types::AssetBundleExportJobDataSetOverrideProperties>]
818
+ #
819
+ # @!attribute [rw] themes
820
+ # An optional list of structures that control how `Theme` resources
821
+ # are parameterized in the returned CloudFormation template.
822
+ # @return [Array<Types::AssetBundleExportJobThemeOverrideProperties>]
823
+ #
824
+ # @!attribute [rw] analyses
825
+ # An optional list of structures that control how `Analysis` resources
826
+ # are parameterized in the returned CloudFormation template.
827
+ # @return [Array<Types::AssetBundleExportJobAnalysisOverrideProperties>]
828
+ #
829
+ # @!attribute [rw] dashboards
830
+ # An optional list of structures that control how `Dashboard`
831
+ # resources are parameterized in the returned CloudFormation template.
832
+ # @return [Array<Types::AssetBundleExportJobDashboardOverrideProperties>]
833
+ #
834
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/AssetBundleCloudFormationOverridePropertyConfiguration AWS API Documentation
835
+ #
836
+ class AssetBundleCloudFormationOverridePropertyConfiguration < Struct.new(
837
+ :resource_id_override_configuration,
838
+ :vpc_connections,
839
+ :refresh_schedules,
840
+ :data_sources,
841
+ :data_sets,
842
+ :themes,
843
+ :analyses,
844
+ :dashboards)
845
+ SENSITIVE = []
846
+ include Aws::Structure
847
+ end
848
+
849
+ # Controls how a specific `Analysis` resource is parameterized in the
850
+ # returned CloudFormation template.
851
+ #
852
+ # @!attribute [rw] arn
853
+ # The ARN of the specific `Analysis` resource whose override
854
+ # properties are configured in this structure.
855
+ # @return [String]
856
+ #
857
+ # @!attribute [rw] properties
858
+ # A list of `Analysis` resource properties to generate variables for
859
+ # in the returned CloudFormation template.
860
+ # @return [Array<String>]
861
+ #
862
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/AssetBundleExportJobAnalysisOverrideProperties AWS API Documentation
863
+ #
864
+ class AssetBundleExportJobAnalysisOverrideProperties < Struct.new(
865
+ :arn,
866
+ :properties)
867
+ SENSITIVE = []
868
+ include Aws::Structure
869
+ end
870
+
871
+ # Controls how a specific `Dashboard` resource is parameterized in the
872
+ # returned CloudFormation template.
873
+ #
874
+ # @!attribute [rw] arn
875
+ # The ARN of the specific `Dashboard` resource whose override
876
+ # properties are configured in this structure.
877
+ # @return [String]
878
+ #
879
+ # @!attribute [rw] properties
880
+ # A list of `Dashboard` resource properties to generate variables for
881
+ # in the returned CloudFormation template.
882
+ # @return [Array<String>]
883
+ #
884
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/AssetBundleExportJobDashboardOverrideProperties AWS API Documentation
885
+ #
886
+ class AssetBundleExportJobDashboardOverrideProperties < Struct.new(
887
+ :arn,
888
+ :properties)
889
+ SENSITIVE = []
890
+ include Aws::Structure
891
+ end
892
+
893
+ # Controls how a specific `DataSet` resource is parameterized in the
894
+ # returned CloudFormation template.
895
+ #
896
+ # @!attribute [rw] arn
897
+ # The ARN of the specific `DataSet` resource whose override properties
898
+ # are configured in this structure.
899
+ # @return [String]
900
+ #
901
+ # @!attribute [rw] properties
902
+ # A list of `DataSet` resource properties to generate variables for in
903
+ # the returned CloudFormation template.
904
+ # @return [Array<String>]
905
+ #
906
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/AssetBundleExportJobDataSetOverrideProperties AWS API Documentation
907
+ #
908
+ class AssetBundleExportJobDataSetOverrideProperties < Struct.new(
909
+ :arn,
910
+ :properties)
911
+ SENSITIVE = []
912
+ include Aws::Structure
913
+ end
914
+
915
+ # Controls how a specific `DataSource` resource is parameterized in the
916
+ # returned CloudFormation template.
917
+ #
918
+ # @!attribute [rw] arn
919
+ # The ARN of the specific `DataSource` resource whose override
920
+ # properties are configured in this structure.
921
+ # @return [String]
922
+ #
923
+ # @!attribute [rw] properties
924
+ # A list of `DataSource` resource properties to generate variables for
925
+ # in the returned CloudFormation template.
926
+ # @return [Array<String>]
927
+ #
928
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/AssetBundleExportJobDataSourceOverrideProperties AWS API Documentation
929
+ #
930
+ class AssetBundleExportJobDataSourceOverrideProperties < Struct.new(
931
+ :arn,
932
+ :properties)
933
+ SENSITIVE = []
934
+ include Aws::Structure
935
+ end
936
+
937
+ # Describes an error that occurred during an Asset Bundle export job.
938
+ #
939
+ # @!attribute [rw] arn
940
+ # The ARN of the resource whose processing caused an error.
941
+ # @return [String]
942
+ #
943
+ # @!attribute [rw] type
944
+ # The specific error type of the error that occurred.
945
+ # @return [String]
946
+ #
947
+ # @!attribute [rw] message
948
+ # A description of the error.
949
+ # @return [String]
950
+ #
951
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/AssetBundleExportJobError AWS API Documentation
952
+ #
953
+ class AssetBundleExportJobError < Struct.new(
954
+ :arn,
955
+ :type,
956
+ :message)
957
+ SENSITIVE = []
958
+ include Aws::Structure
959
+ end
960
+
961
+ # Controls how a specific `RefreshSchedule` resource is parameterized in
962
+ # the returned CloudFormation template.
963
+ #
964
+ # @!attribute [rw] arn
965
+ # The ARN of the specific `RefreshSchedule` resource whose override
966
+ # properties are configured in this structure.
967
+ # @return [String]
968
+ #
969
+ # @!attribute [rw] properties
970
+ # A list of `RefreshSchedule` resource properties to generate
971
+ # variables for in the returned CloudFormation template.
972
+ # @return [Array<String>]
973
+ #
974
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/AssetBundleExportJobRefreshScheduleOverrideProperties AWS API Documentation
975
+ #
976
+ class AssetBundleExportJobRefreshScheduleOverrideProperties < Struct.new(
977
+ :arn,
978
+ :properties)
979
+ SENSITIVE = []
980
+ include Aws::Structure
981
+ end
982
+
983
+ # An optional structure that configures resource ID overrides for the
984
+ # export job.
985
+ #
986
+ # @!attribute [rw] prefix_for_all_resources
987
+ # An option to request a CloudFormation variable for a prefix to be
988
+ # prepended to each resource's ID before import. The prefix is only
989
+ # added to the asset IDs and does not change the name of the asset.
990
+ # @return [Boolean]
991
+ #
992
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/AssetBundleExportJobResourceIdOverrideConfiguration AWS API Documentation
993
+ #
994
+ class AssetBundleExportJobResourceIdOverrideConfiguration < Struct.new(
995
+ :prefix_for_all_resources)
996
+ SENSITIVE = []
997
+ include Aws::Structure
998
+ end
999
+
1000
+ # A summary of the export job that includes details of the job's
1001
+ # configuration and its current status.
1002
+ #
1003
+ # @!attribute [rw] job_status
1004
+ # The current status of the export job.
1005
+ # @return [String]
1006
+ #
1007
+ # @!attribute [rw] arn
1008
+ # The ARN of the export job.
1009
+ # @return [String]
1010
+ #
1011
+ # @!attribute [rw] created_time
1012
+ # The time that the export job was created.
1013
+ # @return [Time]
1014
+ #
1015
+ # @!attribute [rw] asset_bundle_export_job_id
1016
+ # The ID of the export job.
1017
+ # @return [String]
1018
+ #
1019
+ # @!attribute [rw] include_all_dependencies
1020
+ # The flag that determines the inclusion of resource dependencies in
1021
+ # the returned asset bundle.
1022
+ # @return [Boolean]
1023
+ #
1024
+ # @!attribute [rw] export_format
1025
+ # The format for the export job.
1026
+ # @return [String]
1027
+ #
1028
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/AssetBundleExportJobSummary AWS API Documentation
1029
+ #
1030
+ class AssetBundleExportJobSummary < Struct.new(
1031
+ :job_status,
1032
+ :arn,
1033
+ :created_time,
1034
+ :asset_bundle_export_job_id,
1035
+ :include_all_dependencies,
1036
+ :export_format)
1037
+ SENSITIVE = []
1038
+ include Aws::Structure
1039
+ end
1040
+
1041
+ # Controls how a specific `Theme` resource is parameterized in the
1042
+ # returned CloudFormation template.
1043
+ #
1044
+ # @!attribute [rw] arn
1045
+ # The ARN of the specific `Theme` resource whose override properties
1046
+ # are configured in this structure.
1047
+ # @return [String]
1048
+ #
1049
+ # @!attribute [rw] properties
1050
+ # A list of `Theme` resource properties to generate variables for in
1051
+ # the returned CloudFormation template.
1052
+ # @return [Array<String>]
1053
+ #
1054
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/AssetBundleExportJobThemeOverrideProperties AWS API Documentation
1055
+ #
1056
+ class AssetBundleExportJobThemeOverrideProperties < Struct.new(
1057
+ :arn,
1058
+ :properties)
1059
+ SENSITIVE = []
1060
+ include Aws::Structure
1061
+ end
1062
+
1063
+ # Controls how a specific `VPCConnection` resource is parameterized in
1064
+ # the outputted CloudFormation template.
1065
+ #
1066
+ # @!attribute [rw] arn
1067
+ # The ARN of the specific `VPCConnection` resource whose override
1068
+ # properties are configured in this structure.
1069
+ # @return [String]
1070
+ #
1071
+ # @!attribute [rw] properties
1072
+ # A list of `VPCConnection` resource properties to generate variables
1073
+ # for in the returned CloudFormation template.
1074
+ # @return [Array<String>]
1075
+ #
1076
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/AssetBundleExportJobVPCConnectionOverrideProperties AWS API Documentation
1077
+ #
1078
+ class AssetBundleExportJobVPCConnectionOverrideProperties < Struct.new(
1079
+ :arn,
1080
+ :properties)
1081
+ SENSITIVE = []
1082
+ include Aws::Structure
1083
+ end
1084
+
1085
+ # The override parameters for a single analysis that is being imported.
1086
+ #
1087
+ # @!attribute [rw] analysis_id
1088
+ # The ID of the analysis that you ant to apply overrides to.
1089
+ # @return [String]
1090
+ #
1091
+ # @!attribute [rw] name
1092
+ # A new name for the analysis.
1093
+ # @return [String]
1094
+ #
1095
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/AssetBundleImportJobAnalysisOverrideParameters AWS API Documentation
1096
+ #
1097
+ class AssetBundleImportJobAnalysisOverrideParameters < Struct.new(
1098
+ :analysis_id,
1099
+ :name)
1100
+ SENSITIVE = []
1101
+ include Aws::Structure
1102
+ end
1103
+
1104
+ # The override parameters for a single dashboard that is being imported.
1105
+ #
1106
+ # @!attribute [rw] dashboard_id
1107
+ # The ID of the dashboard that you want to apply overrides to.
1108
+ # @return [String]
1109
+ #
1110
+ # @!attribute [rw] name
1111
+ # A new name for the dashboard.
1112
+ # @return [String]
1113
+ #
1114
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/AssetBundleImportJobDashboardOverrideParameters AWS API Documentation
1115
+ #
1116
+ class AssetBundleImportJobDashboardOverrideParameters < Struct.new(
1117
+ :dashboard_id,
1118
+ :name)
1119
+ SENSITIVE = []
1120
+ include Aws::Structure
1121
+ end
1122
+
1123
+ # The override parameters for a single dataset that is being imported.
1124
+ #
1125
+ # @!attribute [rw] data_set_id
1126
+ # The ID of the dataset to apply overrides to.
1127
+ # @return [String]
1128
+ #
1129
+ # @!attribute [rw] name
1130
+ # A new name for the dataset.
1131
+ # @return [String]
1132
+ #
1133
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/AssetBundleImportJobDataSetOverrideParameters AWS API Documentation
1134
+ #
1135
+ class AssetBundleImportJobDataSetOverrideParameters < Struct.new(
1136
+ :data_set_id,
1137
+ :name)
1138
+ SENSITIVE = []
1139
+ include Aws::Structure
1140
+ end
1141
+
1142
+ # A username and password credential pair to use to import a data source
1143
+ # resource.
1144
+ #
1145
+ # @!attribute [rw] username
1146
+ # The username for the data source connection.
1147
+ # @return [String]
1148
+ #
1149
+ # @!attribute [rw] password
1150
+ # The password for the data source connection.
1151
+ # @return [String]
1152
+ #
1153
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/AssetBundleImportJobDataSourceCredentialPair AWS API Documentation
1154
+ #
1155
+ class AssetBundleImportJobDataSourceCredentialPair < Struct.new(
1156
+ :username,
1157
+ :password)
1158
+ SENSITIVE = []
1159
+ include Aws::Structure
1160
+ end
1161
+
1162
+ # The login credentials to use to import a data source resource.
1163
+ #
1164
+ # @!attribute [rw] credential_pair
1165
+ # A username and password credential pair to be used to create the
1166
+ # imported data source. Leave this field blank if you are using an
1167
+ # Secrets Manager Secret to provide credentials.
1168
+ # @return [Types::AssetBundleImportJobDataSourceCredentialPair]
1169
+ #
1170
+ # @!attribute [rw] secret_arn
1171
+ # The ARN of the Secrets Manager Secret to be used to create the
1172
+ # imported data source leave this field blank if you aren't using a
1173
+ # Secret in place of a credential pair.
1174
+ # @return [String]
1175
+ #
1176
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/AssetBundleImportJobDataSourceCredentials AWS API Documentation
1177
+ #
1178
+ class AssetBundleImportJobDataSourceCredentials < Struct.new(
1179
+ :credential_pair,
1180
+ :secret_arn)
1181
+ SENSITIVE = [:credential_pair]
1182
+ include Aws::Structure
1183
+ end
1184
+
1185
+ # The override parameters for a single data source that is being
1186
+ # imported.
1187
+ #
1188
+ # @!attribute [rw] data_source_id
1189
+ # The ID of the data source to apply overrides to.
1190
+ # @return [String]
1191
+ #
1192
+ # @!attribute [rw] name
1193
+ # A new name for the data source.
1194
+ # @return [String]
1195
+ #
1196
+ # @!attribute [rw] data_source_parameters
1197
+ # The parameters that Amazon QuickSight uses to connect to your
1198
+ # underlying data source. This is a variant type structure. For this
1199
+ # structure to be valid, only one of the attributes can be non-null.
1200
+ # @return [Types::DataSourceParameters]
1201
+ #
1202
+ # @!attribute [rw] vpc_connection_properties
1203
+ # VPC connection properties.
1204
+ # @return [Types::VpcConnectionProperties]
1205
+ #
1206
+ # @!attribute [rw] ssl_properties
1207
+ # Secure Socket Layer (SSL) properties that apply when Amazon
1208
+ # QuickSight connects to your underlying data source.
1209
+ # @return [Types::SslProperties]
1210
+ #
1211
+ # @!attribute [rw] credentials
1212
+ # An optional structure that provides the credentials to be used to
1213
+ # create the imported data source.
1214
+ # @return [Types::AssetBundleImportJobDataSourceCredentials]
1215
+ #
1216
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/AssetBundleImportJobDataSourceOverrideParameters AWS API Documentation
1217
+ #
1218
+ class AssetBundleImportJobDataSourceOverrideParameters < Struct.new(
1219
+ :data_source_id,
1220
+ :name,
1221
+ :data_source_parameters,
1222
+ :vpc_connection_properties,
1223
+ :ssl_properties,
1224
+ :credentials)
1225
+ SENSITIVE = []
1226
+ include Aws::Structure
1227
+ end
1228
+
1229
+ # Describes an error that occurred within an Asset Bundle import
1230
+ # execution.
1231
+ #
1232
+ # @!attribute [rw] arn
1233
+ # The ARN of the resource whose processing caused an error.
1234
+ # @return [String]
1235
+ #
1236
+ # @!attribute [rw] type
1237
+ # The specific error type or the error that occurred.
1238
+ # @return [String]
1239
+ #
1240
+ # @!attribute [rw] message
1241
+ # A description of the error.
1242
+ # @return [String]
1243
+ #
1244
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/AssetBundleImportJobError AWS API Documentation
1245
+ #
1246
+ class AssetBundleImportJobError < Struct.new(
1247
+ :arn,
1248
+ :type,
1249
+ :message)
1250
+ SENSITIVE = []
1251
+ include Aws::Structure
1252
+ end
1253
+
1254
+ # A list of overrides that modify the asset bundle resource
1255
+ # configuration before the resource is imported.
1256
+ #
1257
+ # @!attribute [rw] resource_id_override_configuration
1258
+ # An optional structure that configures resource ID overrides to be
1259
+ # applied within the import job.
1260
+ # @return [Types::AssetBundleImportJobResourceIdOverrideConfiguration]
1261
+ #
1262
+ # @!attribute [rw] vpc_connections
1263
+ # A list of overrides for any `VPCConnection` resources that are
1264
+ # present in the asset bundle that is imported.
1265
+ # @return [Array<Types::AssetBundleImportJobVPCConnectionOverrideParameters>]
1266
+ #
1267
+ # @!attribute [rw] refresh_schedules
1268
+ # A list of overrides for any `RefreshSchedule` resources that are
1269
+ # present in the asset bundle that is imported.
1270
+ # @return [Array<Types::AssetBundleImportJobRefreshScheduleOverrideParameters>]
1271
+ #
1272
+ # @!attribute [rw] data_sources
1273
+ # A list of overrides for any `DataSource` resources that are present
1274
+ # in the asset bundle that is imported.
1275
+ # @return [Array<Types::AssetBundleImportJobDataSourceOverrideParameters>]
1276
+ #
1277
+ # @!attribute [rw] data_sets
1278
+ # A list of overrides for any `DataSet` resources that are present in
1279
+ # the asset bundle that is imported.
1280
+ # @return [Array<Types::AssetBundleImportJobDataSetOverrideParameters>]
1281
+ #
1282
+ # @!attribute [rw] themes
1283
+ # A list of overrides for any `Theme` resources that are present in
1284
+ # the asset bundle that is imported.
1285
+ # @return [Array<Types::AssetBundleImportJobThemeOverrideParameters>]
1286
+ #
1287
+ # @!attribute [rw] analyses
1288
+ # A list of overrides for any `Analysis` resources that are present in
1289
+ # the asset bundle that is imported.
1290
+ # @return [Array<Types::AssetBundleImportJobAnalysisOverrideParameters>]
1291
+ #
1292
+ # @!attribute [rw] dashboards
1293
+ # A list of overrides for any `Dashboard` resources that are present
1294
+ # in the asset bundle that is imported.
1295
+ # @return [Array<Types::AssetBundleImportJobDashboardOverrideParameters>]
1296
+ #
1297
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/AssetBundleImportJobOverrideParameters AWS API Documentation
1298
+ #
1299
+ class AssetBundleImportJobOverrideParameters < Struct.new(
1300
+ :resource_id_override_configuration,
1301
+ :vpc_connections,
1302
+ :refresh_schedules,
1303
+ :data_sources,
1304
+ :data_sets,
1305
+ :themes,
1306
+ :analyses,
1307
+ :dashboards)
1308
+ SENSITIVE = []
1309
+ include Aws::Structure
1310
+ end
1311
+
1312
+ # A list of overrides for a specific `RefreshsSchedule` resource that is
1313
+ # present in the asset bundle that is imported.
1314
+ #
1315
+ # @!attribute [rw] data_set_id
1316
+ # A partial identifier for the specific `RefreshSchedule` resource
1317
+ # that is being overridden. This structure is used together with the
1318
+ # `ScheduleID` structure.
1319
+ # @return [String]
1320
+ #
1321
+ # @!attribute [rw] schedule_id
1322
+ # A partial identifier for the specific `RefreshSchedule` resource
1323
+ # being overridden. This structure is used together with the
1324
+ # `DataSetId` structure.
1325
+ # @return [String]
1326
+ #
1327
+ # @!attribute [rw] start_after_date_time
1328
+ # An override for the `StartAfterDateTime` of a `RefreshSchedule` to
1329
+ # ensure that the `StartAfterDateTime` is set to a time that takes
1330
+ # place in the future.
1331
+ # @return [Time]
1332
+ #
1333
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/AssetBundleImportJobRefreshScheduleOverrideParameters AWS API Documentation
1334
+ #
1335
+ class AssetBundleImportJobRefreshScheduleOverrideParameters < Struct.new(
1336
+ :data_set_id,
1337
+ :schedule_id,
1338
+ :start_after_date_time)
1339
+ SENSITIVE = []
1340
+ include Aws::Structure
1341
+ end
1342
+
1343
+ # An optional structure that configures resource ID overrides for the
1344
+ # import job
1345
+ #
1346
+ # @!attribute [rw] prefix_for_all_resources
1347
+ # An option to request a CloudFormation variable for a prefix to be
1348
+ # prepended to each resource's ID before import. The prefix is only
1349
+ # added to the asset IDs and does not change the name of the asset.
1350
+ # @return [String]
1351
+ #
1352
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/AssetBundleImportJobResourceIdOverrideConfiguration AWS API Documentation
1353
+ #
1354
+ class AssetBundleImportJobResourceIdOverrideConfiguration < Struct.new(
1355
+ :prefix_for_all_resources)
1356
+ SENSITIVE = []
1357
+ include Aws::Structure
1358
+ end
1359
+
1360
+ # A summary of the import job that includes details of the requested
1361
+ # job's configuration and its current status.
1362
+ #
1363
+ # @!attribute [rw] job_status
1364
+ # The current status of the import job.
1365
+ # @return [String]
1366
+ #
1367
+ # @!attribute [rw] arn
1368
+ # The ARN of the import job.
1369
+ # @return [String]
1370
+ #
1371
+ # @!attribute [rw] created_time
1372
+ # The time that the import job was created.
1373
+ # @return [Time]
1374
+ #
1375
+ # @!attribute [rw] asset_bundle_import_job_id
1376
+ # The ID of the job. This ID is unique while the job is running. After
1377
+ # the job is completed, you can reuse this ID for another job.
1378
+ # @return [String]
1379
+ #
1380
+ # @!attribute [rw] failure_action
1381
+ # The failure action for the import job.
1382
+ # @return [String]
1383
+ #
1384
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/AssetBundleImportJobSummary AWS API Documentation
1385
+ #
1386
+ class AssetBundleImportJobSummary < Struct.new(
1387
+ :job_status,
1388
+ :arn,
1389
+ :created_time,
1390
+ :asset_bundle_import_job_id,
1391
+ :failure_action)
1392
+ SENSITIVE = []
1393
+ include Aws::Structure
1394
+ end
1395
+
1396
+ # The override parameters for a single theme that is imported.
1397
+ #
1398
+ # @!attribute [rw] theme_id
1399
+ # The ID of the theme to apply overrides to.
1400
+ # @return [String]
1401
+ #
1402
+ # @!attribute [rw] name
1403
+ # A new name for the theme.
1404
+ # @return [String]
1405
+ #
1406
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/AssetBundleImportJobThemeOverrideParameters AWS API Documentation
1407
+ #
1408
+ class AssetBundleImportJobThemeOverrideParameters < Struct.new(
1409
+ :theme_id,
1410
+ :name)
1411
+ SENSITIVE = []
1412
+ include Aws::Structure
1413
+ end
1414
+
1415
+ # The override parameters for a single VPC connection that is imported.
1416
+ #
1417
+ # @!attribute [rw] vpc_connection_id
1418
+ # The ID of the VPC Connection to apply overrides to.
1419
+ # @return [String]
1420
+ #
1421
+ # @!attribute [rw] name
1422
+ # A new name for the VPC connection.
1423
+ # @return [String]
1424
+ #
1425
+ # @!attribute [rw] subnet_ids
1426
+ # A list of new subnet IDs for the VPC connection you are importing.
1427
+ # This field is required if you are importing the VPC connection from
1428
+ # another Amazon Web Services account or region.
1429
+ # @return [Array<String>]
1430
+ #
1431
+ # @!attribute [rw] security_group_ids
1432
+ # A new security group ID for the VPC connection you are importing.
1433
+ # This field is required if you are importing the VPC connection from
1434
+ # another Amazon Web Services account or region.
1435
+ # @return [Array<String>]
1436
+ #
1437
+ # @!attribute [rw] dns_resolvers
1438
+ # An optional override of dns resolvers to be used by the VPC
1439
+ # connection.
1440
+ # @return [Array<String>]
1441
+ #
1442
+ # @!attribute [rw] role_arn
1443
+ # An optional override of the role ARN to be used by the VPC
1444
+ # connection.
1445
+ # @return [String]
1446
+ #
1447
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/AssetBundleImportJobVPCConnectionOverrideParameters AWS API Documentation
1448
+ #
1449
+ class AssetBundleImportJobVPCConnectionOverrideParameters < Struct.new(
1450
+ :vpc_connection_id,
1451
+ :name,
1452
+ :subnet_ids,
1453
+ :security_group_ids,
1454
+ :dns_resolvers,
1455
+ :role_arn)
1456
+ SENSITIVE = []
1457
+ include Aws::Structure
1458
+ end
1459
+
1460
+ # The source of the asset bundle zip file that contains the data that
1461
+ # you want to import.
1462
+ #
1463
+ # @!attribute [rw] body
1464
+ # The bytes of the Base64 encoded asset bundle import zip file. This
1465
+ # file can't exceed 20MB.
1466
+ #
1467
+ # If you are calling the APIs from the Amazon Web Services Java,
1468
+ # JavaScript, Python, or PHP SDKs, the SDK encodes Base64
1469
+ # automatically to allow the direct setting of the zip file's bytes.
1470
+ # If you are using a SDK of a different language or are receiving
1471
+ # related errors, try to Base64 encode your data.
1472
+ # @return [String]
1473
+ #
1474
+ # @!attribute [rw] s3_uri
1475
+ # The Amazon S3 uri for an asset bundle import file that exists in an
1476
+ # Amazon S3 bucket that the caller has read access to. The file must
1477
+ # be a zip format file and can't exceed 20MB.
1478
+ # @return [String]
1479
+ #
1480
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/AssetBundleImportSource AWS API Documentation
1481
+ #
1482
+ class AssetBundleImportSource < Struct.new(
1483
+ :body,
1484
+ :s3_uri)
1485
+ SENSITIVE = [:body]
1486
+ include Aws::Structure
1487
+ end
1488
+
1489
+ # A description of the import source that you provide at the start of an
1490
+ # import job. This value is set to either `Body` or `S3Uri` depending on
1491
+ # how the `StartAssetBundleImportJobRequest` is configured.
1492
+ #
1493
+ # @!attribute [rw] body
1494
+ # A HTTPS download URL for the provided asset bundle that you
1495
+ # optionally provided at the start of the import job. This URL is
1496
+ # valid for 5 minutes after issuance. Call
1497
+ # `DescribeAssetBundleExportJob` again for a fresh URL if needed. The
1498
+ # downloaded asset bundle is a `.qs` zip file.
1499
+ # @return [String]
1500
+ #
1501
+ # @!attribute [rw] s3_uri
1502
+ # The Amazon S3 uri that you provided at the start of the import job.
1503
+ # @return [String]
1504
+ #
1505
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/AssetBundleImportSourceDescription AWS API Documentation
1506
+ #
1507
+ class AssetBundleImportSourceDescription < Struct.new(
1508
+ :body,
1509
+ :s3_uri)
1510
+ SENSITIVE = []
1511
+ include Aws::Structure
1512
+ end
1513
+
791
1514
  # Parameters for Amazon Athena.
792
1515
  #
793
1516
  # @!attribute [rw] work_group
@@ -2073,7 +2796,7 @@ module Aws::QuickSight
2073
2796
  #
2074
2797
  # @!attribute [rw] cluster_marker
2075
2798
  # The cluster marker that is a part of the cluster marker
2076
- # configuration
2799
+ # configuration.
2077
2800
  # @return [Types::ClusterMarker]
2078
2801
  #
2079
2802
  # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ClusterMarkerConfiguration AWS API Documentation
@@ -8876,44 +9599,266 @@ module Aws::QuickSight
8876
9599
  end
8877
9600
 
8878
9601
  # @!attribute [rw] aws_account_id
8879
- # The ID of the Amazon Web Services account that contains the
8880
- # analysis. You must be using the Amazon Web Services account that the
8881
- # analysis is in.
9602
+ # The ID of the Amazon Web Services account that contains the
9603
+ # analysis. You must be using the Amazon Web Services account that the
9604
+ # analysis is in.
9605
+ # @return [String]
9606
+ #
9607
+ # @!attribute [rw] analysis_id
9608
+ # The ID of the analysis that you're describing. The ID is part of
9609
+ # the URL of the analysis.
9610
+ # @return [String]
9611
+ #
9612
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeAnalysisRequest AWS API Documentation
9613
+ #
9614
+ class DescribeAnalysisRequest < Struct.new(
9615
+ :aws_account_id,
9616
+ :analysis_id)
9617
+ SENSITIVE = []
9618
+ include Aws::Structure
9619
+ end
9620
+
9621
+ # @!attribute [rw] analysis
9622
+ # A metadata structure that contains summary information for the
9623
+ # analysis that you're describing.
9624
+ # @return [Types::Analysis]
9625
+ #
9626
+ # @!attribute [rw] status
9627
+ # The HTTP status of the request.
9628
+ # @return [Integer]
9629
+ #
9630
+ # @!attribute [rw] request_id
9631
+ # The Amazon Web Services request ID for this operation.
9632
+ # @return [String]
9633
+ #
9634
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeAnalysisResponse AWS API Documentation
9635
+ #
9636
+ class DescribeAnalysisResponse < Struct.new(
9637
+ :analysis,
9638
+ :status,
9639
+ :request_id)
9640
+ SENSITIVE = []
9641
+ include Aws::Structure
9642
+ end
9643
+
9644
+ # @!attribute [rw] aws_account_id
9645
+ # The ID of the Amazon Web Services account the export job is executed
9646
+ # in.
9647
+ # @return [String]
9648
+ #
9649
+ # @!attribute [rw] asset_bundle_export_job_id
9650
+ # The ID of the job that you want described. The job ID is set when
9651
+ # you start a new job with a `StartAssetBundleExportJob` API call.
9652
+ # @return [String]
9653
+ #
9654
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeAssetBundleExportJobRequest AWS API Documentation
9655
+ #
9656
+ class DescribeAssetBundleExportJobRequest < Struct.new(
9657
+ :aws_account_id,
9658
+ :asset_bundle_export_job_id)
9659
+ SENSITIVE = []
9660
+ include Aws::Structure
9661
+ end
9662
+
9663
+ # @!attribute [rw] job_status
9664
+ # Indicates tha status of a job through its queueing and execution.
9665
+ #
9666
+ # Poll this `DescribeAssetBundleExportApi` until `JobStatus` is either
9667
+ # `SUCCESSFUL` or `FAILED`.
9668
+ # @return [String]
9669
+ #
9670
+ # @!attribute [rw] download_url
9671
+ # The URL to download the exported asset bundle data from.
9672
+ #
9673
+ # This URL is available only after the job has succeeded. This URL is
9674
+ # valid for 5 minutes after issuance. Call
9675
+ # `DescribeAssetBundleExportJob` again for a fresh URL if needed.
9676
+ #
9677
+ # The downloaded asset bundle is a zip file named
9678
+ # `assetbundle-\{jobId\}.qs`. The file has a `.qs` extension.
9679
+ #
9680
+ # This URL can't be used in a `StartAssetBundleImportJob` API call
9681
+ # and should only be used for download purposes.
9682
+ # @return [String]
9683
+ #
9684
+ # @!attribute [rw] errors
9685
+ # An array of error records that describes any failures that occurred
9686
+ # during the export job processing.
9687
+ #
9688
+ # Error records accumulate while the job runs. The complete set of
9689
+ # error records is available after the job has completed and failed.
9690
+ # @return [Array<Types::AssetBundleExportJobError>]
9691
+ #
9692
+ # @!attribute [rw] arn
9693
+ # The Amazon Resource Name (ARN) for the export job.
9694
+ # @return [String]
9695
+ #
9696
+ # @!attribute [rw] created_time
9697
+ # The time that the export job was created.
9698
+ # @return [Time]
9699
+ #
9700
+ # @!attribute [rw] asset_bundle_export_job_id
9701
+ # The ID of the job. The job ID is set when you start a new job with a
9702
+ # `StartAssetBundleExportJob` API call.
9703
+ # @return [String]
9704
+ #
9705
+ # @!attribute [rw] aws_account_id
9706
+ # The ID of the Amazon Web Services account that the export job was
9707
+ # executed in.
9708
+ # @return [String]
9709
+ #
9710
+ # @!attribute [rw] resource_arns
9711
+ # A list of resource ARNs that exported with the job.
9712
+ # @return [Array<String>]
9713
+ #
9714
+ # @!attribute [rw] include_all_dependencies
9715
+ # The include dependencies flag.
9716
+ # @return [Boolean]
9717
+ #
9718
+ # @!attribute [rw] export_format
9719
+ # The format of the export.
9720
+ # @return [String]
9721
+ #
9722
+ # @!attribute [rw] cloud_formation_override_property_configuration
9723
+ # The CloudFormation override property configuration for the export
9724
+ # job.
9725
+ # @return [Types::AssetBundleCloudFormationOverridePropertyConfiguration]
9726
+ #
9727
+ # @!attribute [rw] request_id
9728
+ # The Amazon Web Services request ID for this operation.
9729
+ # @return [String]
9730
+ #
9731
+ # @!attribute [rw] status
9732
+ # The HTTP status of the response.
9733
+ # @return [Integer]
9734
+ #
9735
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeAssetBundleExportJobResponse AWS API Documentation
9736
+ #
9737
+ class DescribeAssetBundleExportJobResponse < Struct.new(
9738
+ :job_status,
9739
+ :download_url,
9740
+ :errors,
9741
+ :arn,
9742
+ :created_time,
9743
+ :asset_bundle_export_job_id,
9744
+ :aws_account_id,
9745
+ :resource_arns,
9746
+ :include_all_dependencies,
9747
+ :export_format,
9748
+ :cloud_formation_override_property_configuration,
9749
+ :request_id,
9750
+ :status)
9751
+ SENSITIVE = []
9752
+ include Aws::Structure
9753
+ end
9754
+
9755
+ # @!attribute [rw] aws_account_id
9756
+ # The ID of the Amazon Web Services account the import job was
9757
+ # executed in.
8882
9758
  # @return [String]
8883
9759
  #
8884
- # @!attribute [rw] analysis_id
8885
- # The ID of the analysis that you're describing. The ID is part of
8886
- # the URL of the analysis.
9760
+ # @!attribute [rw] asset_bundle_import_job_id
9761
+ # The ID of the job. The job ID is set when you start a new job with a
9762
+ # `StartAssetBundleImportJob` API call.
8887
9763
  # @return [String]
8888
9764
  #
8889
- # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeAnalysisRequest AWS API Documentation
9765
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeAssetBundleImportJobRequest AWS API Documentation
8890
9766
  #
8891
- class DescribeAnalysisRequest < Struct.new(
9767
+ class DescribeAssetBundleImportJobRequest < Struct.new(
8892
9768
  :aws_account_id,
8893
- :analysis_id)
9769
+ :asset_bundle_import_job_id)
8894
9770
  SENSITIVE = []
8895
9771
  include Aws::Structure
8896
9772
  end
8897
9773
 
8898
- # @!attribute [rw] analysis
8899
- # A metadata structure that contains summary information for the
8900
- # analysis that you're describing.
8901
- # @return [Types::Analysis]
9774
+ # @!attribute [rw] job_status
9775
+ # Indicates tha status of a job through its queueing and execution.
8902
9776
  #
8903
- # @!attribute [rw] status
8904
- # The HTTP status of the request.
8905
- # @return [Integer]
9777
+ # Poll this `DescribeAssetBundleImport` API until `JobStatus` returns
9778
+ # one of the following values.
9779
+ #
9780
+ # * `SUCCESSFUL`
9781
+ #
9782
+ # * `FAILED`
9783
+ #
9784
+ # * `FAILED_ROLLBACK_COMPLETED`
9785
+ #
9786
+ # * `FAILED_ROLLBACK_ERROR`
9787
+ # @return [String]
9788
+ #
9789
+ # @!attribute [rw] errors
9790
+ # An array of error records that describes any failures that occurred
9791
+ # during the export job processing.
9792
+ #
9793
+ # Error records accumulate while the job is still running. The
9794
+ # complete set of error records is available after the job has
9795
+ # completed and failed.
9796
+ # @return [Array<Types::AssetBundleImportJobError>]
9797
+ #
9798
+ # @!attribute [rw] rollback_errors
9799
+ # An array of error records that describes any failures that occurred
9800
+ # while an import job was attempting a rollback.
9801
+ #
9802
+ # Error records accumulate while the job is still running. The
9803
+ # complete set of error records is available after the job has
9804
+ # completed and failed.
9805
+ # @return [Array<Types::AssetBundleImportJobError>]
9806
+ #
9807
+ # @!attribute [rw] arn
9808
+ # The Amazon Resource Name (ARN) for the import job.
9809
+ # @return [String]
9810
+ #
9811
+ # @!attribute [rw] created_time
9812
+ # The time that the import job was created.
9813
+ # @return [Time]
9814
+ #
9815
+ # @!attribute [rw] asset_bundle_import_job_id
9816
+ # The ID of the job. The job ID is set when you start a new job with a
9817
+ # `StartAssetBundleImportJob` API call.
9818
+ # @return [String]
9819
+ #
9820
+ # @!attribute [rw] aws_account_id
9821
+ # The ID of the Amazon Web Services account the import job was
9822
+ # executed in.
9823
+ # @return [String]
9824
+ #
9825
+ # @!attribute [rw] asset_bundle_import_source
9826
+ # The source of the asset bundle zip file that contains the data that
9827
+ # is imported by the job.
9828
+ # @return [Types::AssetBundleImportSourceDescription]
9829
+ #
9830
+ # @!attribute [rw] override_parameters
9831
+ # Optional overrides to be applied to the resource configuration
9832
+ # before import.
9833
+ # @return [Types::AssetBundleImportJobOverrideParameters]
9834
+ #
9835
+ # @!attribute [rw] failure_action
9836
+ # The failure action for the import job.
9837
+ # @return [String]
8906
9838
  #
8907
9839
  # @!attribute [rw] request_id
8908
9840
  # The Amazon Web Services request ID for this operation.
8909
9841
  # @return [String]
8910
9842
  #
8911
- # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeAnalysisResponse AWS API Documentation
9843
+ # @!attribute [rw] status
9844
+ # The HTTP status of the response.
9845
+ # @return [Integer]
8912
9846
  #
8913
- class DescribeAnalysisResponse < Struct.new(
8914
- :analysis,
8915
- :status,
8916
- :request_id)
9847
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeAssetBundleImportJobResponse AWS API Documentation
9848
+ #
9849
+ class DescribeAssetBundleImportJobResponse < Struct.new(
9850
+ :job_status,
9851
+ :errors,
9852
+ :rollback_errors,
9853
+ :arn,
9854
+ :created_time,
9855
+ :asset_bundle_import_job_id,
9856
+ :aws_account_id,
9857
+ :asset_bundle_import_source,
9858
+ :override_parameters,
9859
+ :failure_action,
9860
+ :request_id,
9861
+ :status)
8917
9862
  SENSITIVE = []
8918
9863
  include Aws::Structure
8919
9864
  end
@@ -13130,6 +14075,48 @@ module Aws::QuickSight
13130
14075
  include Aws::Structure
13131
14076
  end
13132
14077
 
14078
+ # The color scale specification for the heatmap point style.
14079
+ #
14080
+ # @!attribute [rw] colors
14081
+ # The list of colors to be used in heatmap point style.
14082
+ # @return [Array<Types::GeospatialHeatmapDataColor>]
14083
+ #
14084
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/GeospatialHeatmapColorScale AWS API Documentation
14085
+ #
14086
+ class GeospatialHeatmapColorScale < Struct.new(
14087
+ :colors)
14088
+ SENSITIVE = []
14089
+ include Aws::Structure
14090
+ end
14091
+
14092
+ # The heatmap configuration of the geospatial point style.
14093
+ #
14094
+ # @!attribute [rw] heatmap_color
14095
+ # The color scale specification for the heatmap point style.
14096
+ # @return [Types::GeospatialHeatmapColorScale]
14097
+ #
14098
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/GeospatialHeatmapConfiguration AWS API Documentation
14099
+ #
14100
+ class GeospatialHeatmapConfiguration < Struct.new(
14101
+ :heatmap_color)
14102
+ SENSITIVE = []
14103
+ include Aws::Structure
14104
+ end
14105
+
14106
+ # The color to be used in the heatmap point style.
14107
+ #
14108
+ # @!attribute [rw] color
14109
+ # The hex color to be used in the heatmap point style.
14110
+ # @return [String]
14111
+ #
14112
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/GeospatialHeatmapDataColor AWS API Documentation
14113
+ #
14114
+ class GeospatialHeatmapDataColor < Struct.new(
14115
+ :color)
14116
+ SENSITIVE = []
14117
+ include Aws::Structure
14118
+ end
14119
+
13133
14120
  # The aggregated field wells for a geospatial map.
13134
14121
  #
13135
14122
  # @!attribute [rw] geospatial
@@ -13290,11 +14277,16 @@ module Aws::QuickSight
13290
14277
  # The cluster marker configuration of the geospatial point style.
13291
14278
  # @return [Types::ClusterMarkerConfiguration]
13292
14279
  #
14280
+ # @!attribute [rw] heatmap_configuration
14281
+ # The heatmap configuration of the geospatial point style.
14282
+ # @return [Types::GeospatialHeatmapConfiguration]
14283
+ #
13293
14284
  # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/GeospatialPointStyleOptions AWS API Documentation
13294
14285
  #
13295
14286
  class GeospatialPointStyleOptions < Struct.new(
13296
14287
  :selected_point_style,
13297
- :cluster_marker_configuration)
14288
+ :cluster_marker_configuration,
14289
+ :heatmap_configuration)
13298
14290
  SENSITIVE = []
13299
14291
  include Aws::Structure
13300
14292
  end
@@ -15547,6 +16539,110 @@ module Aws::QuickSight
15547
16539
  include Aws::Structure
15548
16540
  end
15549
16541
 
16542
+ # @!attribute [rw] aws_account_id
16543
+ # The ID of the Amazon Web Services account that the export jobs were
16544
+ # executed in.
16545
+ # @return [String]
16546
+ #
16547
+ # @!attribute [rw] next_token
16548
+ # The token for the next set of results, or null if there are no more
16549
+ # results.
16550
+ # @return [String]
16551
+ #
16552
+ # @!attribute [rw] max_results
16553
+ # The maximum number of results to be returned per request.
16554
+ # @return [Integer]
16555
+ #
16556
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListAssetBundleExportJobsRequest AWS API Documentation
16557
+ #
16558
+ class ListAssetBundleExportJobsRequest < Struct.new(
16559
+ :aws_account_id,
16560
+ :next_token,
16561
+ :max_results)
16562
+ SENSITIVE = []
16563
+ include Aws::Structure
16564
+ end
16565
+
16566
+ # @!attribute [rw] asset_bundle_export_job_summary_list
16567
+ # A list of export job summaries.
16568
+ # @return [Array<Types::AssetBundleExportJobSummary>]
16569
+ #
16570
+ # @!attribute [rw] next_token
16571
+ # The token for the next set of results, or null if there are no more
16572
+ # results.
16573
+ # @return [String]
16574
+ #
16575
+ # @!attribute [rw] request_id
16576
+ # The Amazon Web Services request ID for this operation.
16577
+ # @return [String]
16578
+ #
16579
+ # @!attribute [rw] status
16580
+ # The HTTP status of the request.
16581
+ # @return [Integer]
16582
+ #
16583
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListAssetBundleExportJobsResponse AWS API Documentation
16584
+ #
16585
+ class ListAssetBundleExportJobsResponse < Struct.new(
16586
+ :asset_bundle_export_job_summary_list,
16587
+ :next_token,
16588
+ :request_id,
16589
+ :status)
16590
+ SENSITIVE = []
16591
+ include Aws::Structure
16592
+ end
16593
+
16594
+ # @!attribute [rw] aws_account_id
16595
+ # The ID of the Amazon Web Services account that the import jobs were
16596
+ # executed in.
16597
+ # @return [String]
16598
+ #
16599
+ # @!attribute [rw] next_token
16600
+ # The token for the next set of results, or null if there are no more
16601
+ # results.
16602
+ # @return [String]
16603
+ #
16604
+ # @!attribute [rw] max_results
16605
+ # The maximum number of results to be returned per request.
16606
+ # @return [Integer]
16607
+ #
16608
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListAssetBundleImportJobsRequest AWS API Documentation
16609
+ #
16610
+ class ListAssetBundleImportJobsRequest < Struct.new(
16611
+ :aws_account_id,
16612
+ :next_token,
16613
+ :max_results)
16614
+ SENSITIVE = []
16615
+ include Aws::Structure
16616
+ end
16617
+
16618
+ # @!attribute [rw] asset_bundle_import_job_summary_list
16619
+ # A list of import job summaries.
16620
+ # @return [Array<Types::AssetBundleImportJobSummary>]
16621
+ #
16622
+ # @!attribute [rw] next_token
16623
+ # The token for the next set of results, or null if there are no more
16624
+ # results.
16625
+ # @return [String]
16626
+ #
16627
+ # @!attribute [rw] request_id
16628
+ # The Amazon Web Services request ID for this operation.
16629
+ # @return [String]
16630
+ #
16631
+ # @!attribute [rw] status
16632
+ # The HTTP status of the response.
16633
+ # @return [Integer]
16634
+ #
16635
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListAssetBundleImportJobsResponse AWS API Documentation
16636
+ #
16637
+ class ListAssetBundleImportJobsResponse < Struct.new(
16638
+ :asset_bundle_import_job_summary_list,
16639
+ :next_token,
16640
+ :request_id,
16641
+ :status)
16642
+ SENSITIVE = []
16643
+ include Aws::Structure
16644
+ end
16645
+
15550
16646
  # The display options of a control.
15551
16647
  #
15552
16648
  # @!attribute [rw] search_options
@@ -22816,6 +23912,171 @@ module Aws::QuickSight
22816
23912
  include Aws::Structure
22817
23913
  end
22818
23914
 
23915
+ # @!attribute [rw] aws_account_id
23916
+ # The ID of the Amazon Web Services account to export assets from.
23917
+ # @return [String]
23918
+ #
23919
+ # @!attribute [rw] asset_bundle_export_job_id
23920
+ # The ID of the job. This ID is unique while the job is running. After
23921
+ # the job is completed, you can reuse this ID for another job.
23922
+ # @return [String]
23923
+ #
23924
+ # @!attribute [rw] resource_arns
23925
+ # An array of resource ARNs to export. The following resources are
23926
+ # supported.
23927
+ #
23928
+ # * `Analysis`
23929
+ #
23930
+ # * `Dashboard`
23931
+ #
23932
+ # * `DataSet`
23933
+ #
23934
+ # * `DataSource`
23935
+ #
23936
+ # * `RefreshSchedule`
23937
+ #
23938
+ # * `Theme`
23939
+ #
23940
+ # * `VPCConnection`
23941
+ #
23942
+ # The API caller must have the necessary permissions in their IAM role
23943
+ # to access each resource before the resources can be exported.
23944
+ # @return [Array<String>]
23945
+ #
23946
+ # @!attribute [rw] include_all_dependencies
23947
+ # A Boolean that determines whether all dependencies of each resource
23948
+ # ARN are recursively exported with the job. For example, say you
23949
+ # provided a Dashboard ARN to the `ResourceArns` parameter. If you set
23950
+ # `IncludeAllDependencies` to `TRUE`, any theme, dataset, and
23951
+ # dataource resource that is a dependency of the dashboard is also
23952
+ # exported.
23953
+ # @return [Boolean]
23954
+ #
23955
+ # @!attribute [rw] export_format
23956
+ # The export data format.
23957
+ # @return [String]
23958
+ #
23959
+ # @!attribute [rw] cloud_formation_override_property_configuration
23960
+ # An optional collection of structures that generate CloudFormation
23961
+ # parameters to override the existing resource property values when
23962
+ # the resource is exported to a new CloudFormation template.
23963
+ #
23964
+ # Use this field if the `ExportFormat` field of a
23965
+ # `StartAssetBundleExportJobRequest` API call is set to
23966
+ # `CLOUDFORMATION_JSON`.
23967
+ # @return [Types::AssetBundleCloudFormationOverridePropertyConfiguration]
23968
+ #
23969
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/StartAssetBundleExportJobRequest AWS API Documentation
23970
+ #
23971
+ class StartAssetBundleExportJobRequest < Struct.new(
23972
+ :aws_account_id,
23973
+ :asset_bundle_export_job_id,
23974
+ :resource_arns,
23975
+ :include_all_dependencies,
23976
+ :export_format,
23977
+ :cloud_formation_override_property_configuration)
23978
+ SENSITIVE = []
23979
+ include Aws::Structure
23980
+ end
23981
+
23982
+ # @!attribute [rw] arn
23983
+ # The Amazon Resource Name (ARN) for the export job.
23984
+ # @return [String]
23985
+ #
23986
+ # @!attribute [rw] asset_bundle_export_job_id
23987
+ # The ID of the job. This ID is unique while the job is running. After
23988
+ # the job is completed, you can reuse this ID for another job.
23989
+ # @return [String]
23990
+ #
23991
+ # @!attribute [rw] request_id
23992
+ # The Amazon Web Services response ID for this operation.
23993
+ # @return [String]
23994
+ #
23995
+ # @!attribute [rw] status
23996
+ # The HTTP status of the response.
23997
+ # @return [Integer]
23998
+ #
23999
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/StartAssetBundleExportJobResponse AWS API Documentation
24000
+ #
24001
+ class StartAssetBundleExportJobResponse < Struct.new(
24002
+ :arn,
24003
+ :asset_bundle_export_job_id,
24004
+ :request_id,
24005
+ :status)
24006
+ SENSITIVE = []
24007
+ include Aws::Structure
24008
+ end
24009
+
24010
+ # @!attribute [rw] aws_account_id
24011
+ # The ID of the Amazon Web Services account to import assets into.
24012
+ # @return [String]
24013
+ #
24014
+ # @!attribute [rw] asset_bundle_import_job_id
24015
+ # The ID of the job. This ID is unique while the job is running. After
24016
+ # the job is completed, you can reuse this ID for another job.
24017
+ # @return [String]
24018
+ #
24019
+ # @!attribute [rw] asset_bundle_import_source
24020
+ # The source of the asset bundle zip file that contains the data that
24021
+ # you want to import.
24022
+ # @return [Types::AssetBundleImportSource]
24023
+ #
24024
+ # @!attribute [rw] override_parameters
24025
+ # Optional overrides to be applied to the resource configuration
24026
+ # before import.
24027
+ # @return [Types::AssetBundleImportJobOverrideParameters]
24028
+ #
24029
+ # @!attribute [rw] failure_action
24030
+ # The failure action for the import job.
24031
+ #
24032
+ # If you choose `ROLLBACK`, failed import jobs will attempt to undo
24033
+ # any asset changes caused by the failed job.
24034
+ #
24035
+ # If you choose `DO_NOTHING`, failed import jobs will not attempt to
24036
+ # roll back any asset changes caused by the failed job, possibly
24037
+ # leaving the Amazon QuickSight account in an inconsistent state.
24038
+ # @return [String]
24039
+ #
24040
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/StartAssetBundleImportJobRequest AWS API Documentation
24041
+ #
24042
+ class StartAssetBundleImportJobRequest < Struct.new(
24043
+ :aws_account_id,
24044
+ :asset_bundle_import_job_id,
24045
+ :asset_bundle_import_source,
24046
+ :override_parameters,
24047
+ :failure_action)
24048
+ SENSITIVE = []
24049
+ include Aws::Structure
24050
+ end
24051
+
24052
+ # @!attribute [rw] arn
24053
+ # The Amazon Resource Name (ARN) for the import job.
24054
+ # @return [String]
24055
+ #
24056
+ # @!attribute [rw] asset_bundle_import_job_id
24057
+ # The ID of the job. This ID is unique while the job is running. After
24058
+ # the job is completed, you can reuse this ID for another job.
24059
+ # @return [String]
24060
+ #
24061
+ # @!attribute [rw] request_id
24062
+ # The Amazon Web Services response ID for this operation.
24063
+ # @return [String]
24064
+ #
24065
+ # @!attribute [rw] status
24066
+ # The HTTP status of the response.
24067
+ # @return [Integer]
24068
+ #
24069
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/StartAssetBundleImportJobResponse AWS API Documentation
24070
+ #
24071
+ class StartAssetBundleImportJobResponse < Struct.new(
24072
+ :arn,
24073
+ :asset_bundle_import_job_id,
24074
+ :request_id,
24075
+ :status)
24076
+ SENSITIVE = []
24077
+ include Aws::Structure
24078
+ end
24079
+
22819
24080
  # The state perssitence configuration of an embedded dashboard.
22820
24081
  #
22821
24082
  # @!attribute [rw] enabled