aws-sdk-quicksight 1.79.0 → 1.80.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -1368,7 +1368,7 @@ module Aws::QuickSight
1368
1368
  # },
1369
1369
  # credentials: {
1370
1370
  # credential_pair: {
1371
- # username: "Username", # required
1371
+ # username: "DbUsername", # required
1372
1372
  # password: "Password", # required
1373
1373
  # alternate_data_source_parameters: [
1374
1374
  # {
@@ -4093,6 +4093,260 @@ module Aws::QuickSight
4093
4093
  req.send_request(options)
4094
4094
  end
4095
4095
 
4096
+ # Describes an existing export job.
4097
+ #
4098
+ # Poll job descriptions after a job starts to know the status of the
4099
+ # job. When a job succeeds, a URL is provided to download the exported
4100
+ # assets' data from. Download URLs are valid for five minutes after
4101
+ # they are generated. You can call the `DescribeAssetBundleExportJob`
4102
+ # API for a new download URL as needed.
4103
+ #
4104
+ # Job descriptions are available for 14 days after the job starts.
4105
+ #
4106
+ # @option params [required, String] :aws_account_id
4107
+ # The ID of the Amazon Web Services account the export job is executed
4108
+ # in.
4109
+ #
4110
+ # @option params [required, String] :asset_bundle_export_job_id
4111
+ # The ID of the job that you want described. The job ID is set when you
4112
+ # start a new job with a `StartAssetBundleExportJob` API call.
4113
+ #
4114
+ # @return [Types::DescribeAssetBundleExportJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
4115
+ #
4116
+ # * {Types::DescribeAssetBundleExportJobResponse#job_status #job_status} => String
4117
+ # * {Types::DescribeAssetBundleExportJobResponse#download_url #download_url} => String
4118
+ # * {Types::DescribeAssetBundleExportJobResponse#errors #errors} => Array<Types::AssetBundleExportJobError>
4119
+ # * {Types::DescribeAssetBundleExportJobResponse#arn #arn} => String
4120
+ # * {Types::DescribeAssetBundleExportJobResponse#created_time #created_time} => Time
4121
+ # * {Types::DescribeAssetBundleExportJobResponse#asset_bundle_export_job_id #asset_bundle_export_job_id} => String
4122
+ # * {Types::DescribeAssetBundleExportJobResponse#aws_account_id #aws_account_id} => String
4123
+ # * {Types::DescribeAssetBundleExportJobResponse#resource_arns #resource_arns} => Array<String>
4124
+ # * {Types::DescribeAssetBundleExportJobResponse#include_all_dependencies #include_all_dependencies} => Boolean
4125
+ # * {Types::DescribeAssetBundleExportJobResponse#export_format #export_format} => String
4126
+ # * {Types::DescribeAssetBundleExportJobResponse#cloud_formation_override_property_configuration #cloud_formation_override_property_configuration} => Types::AssetBundleCloudFormationOverridePropertyConfiguration
4127
+ # * {Types::DescribeAssetBundleExportJobResponse#request_id #request_id} => String
4128
+ # * {Types::DescribeAssetBundleExportJobResponse#status #status} => Integer
4129
+ #
4130
+ # @example Request syntax with placeholder values
4131
+ #
4132
+ # resp = client.describe_asset_bundle_export_job({
4133
+ # aws_account_id: "AwsAccountId", # required
4134
+ # asset_bundle_export_job_id: "ShortRestrictiveResourceId", # required
4135
+ # })
4136
+ #
4137
+ # @example Response structure
4138
+ #
4139
+ # resp.job_status #=> String, one of "QUEUED_FOR_IMMEDIATE_EXECUTION", "IN_PROGRESS", "SUCCESSFUL", "FAILED"
4140
+ # resp.download_url #=> String
4141
+ # resp.errors #=> Array
4142
+ # resp.errors[0].arn #=> String
4143
+ # resp.errors[0].type #=> String
4144
+ # resp.errors[0].message #=> String
4145
+ # resp.arn #=> String
4146
+ # resp.created_time #=> Time
4147
+ # resp.asset_bundle_export_job_id #=> String
4148
+ # resp.aws_account_id #=> String
4149
+ # resp.resource_arns #=> Array
4150
+ # resp.resource_arns[0] #=> String
4151
+ # resp.include_all_dependencies #=> Boolean
4152
+ # resp.export_format #=> String, one of "CLOUDFORMATION_JSON", "QUICKSIGHT_JSON"
4153
+ # resp.cloud_formation_override_property_configuration.resource_id_override_configuration.prefix_for_all_resources #=> Boolean
4154
+ # resp.cloud_formation_override_property_configuration.vpc_connections #=> Array
4155
+ # resp.cloud_formation_override_property_configuration.vpc_connections[0].arn #=> String
4156
+ # resp.cloud_formation_override_property_configuration.vpc_connections[0].properties #=> Array
4157
+ # resp.cloud_formation_override_property_configuration.vpc_connections[0].properties[0] #=> String, one of "Name", "DnsResolvers", "RoleArn"
4158
+ # resp.cloud_formation_override_property_configuration.refresh_schedules #=> Array
4159
+ # resp.cloud_formation_override_property_configuration.refresh_schedules[0].arn #=> String
4160
+ # resp.cloud_formation_override_property_configuration.refresh_schedules[0].properties #=> Array
4161
+ # resp.cloud_formation_override_property_configuration.refresh_schedules[0].properties[0] #=> String, one of "StartAfterDateTime"
4162
+ # resp.cloud_formation_override_property_configuration.data_sources #=> Array
4163
+ # resp.cloud_formation_override_property_configuration.data_sources[0].arn #=> String
4164
+ # resp.cloud_formation_override_property_configuration.data_sources[0].properties #=> Array
4165
+ # resp.cloud_formation_override_property_configuration.data_sources[0].properties[0] #=> String, one of "Name", "DisableSsl", "SecretArn", "Username", "Password", "Domain", "WorkGroup", "Host", "Port", "Database", "DataSetName", "Catalog", "InstanceId", "ClusterId", "ManifestFileLocation", "Warehouse", "RoleArn"
4166
+ # resp.cloud_formation_override_property_configuration.data_sets #=> Array
4167
+ # resp.cloud_formation_override_property_configuration.data_sets[0].arn #=> String
4168
+ # resp.cloud_formation_override_property_configuration.data_sets[0].properties #=> Array
4169
+ # resp.cloud_formation_override_property_configuration.data_sets[0].properties[0] #=> String, one of "Name"
4170
+ # resp.cloud_formation_override_property_configuration.themes #=> Array
4171
+ # resp.cloud_formation_override_property_configuration.themes[0].arn #=> String
4172
+ # resp.cloud_formation_override_property_configuration.themes[0].properties #=> Array
4173
+ # resp.cloud_formation_override_property_configuration.themes[0].properties[0] #=> String, one of "Name"
4174
+ # resp.cloud_formation_override_property_configuration.analyses #=> Array
4175
+ # resp.cloud_formation_override_property_configuration.analyses[0].arn #=> String
4176
+ # resp.cloud_formation_override_property_configuration.analyses[0].properties #=> Array
4177
+ # resp.cloud_formation_override_property_configuration.analyses[0].properties[0] #=> String, one of "Name"
4178
+ # resp.cloud_formation_override_property_configuration.dashboards #=> Array
4179
+ # resp.cloud_formation_override_property_configuration.dashboards[0].arn #=> String
4180
+ # resp.cloud_formation_override_property_configuration.dashboards[0].properties #=> Array
4181
+ # resp.cloud_formation_override_property_configuration.dashboards[0].properties[0] #=> String, one of "Name"
4182
+ # resp.request_id #=> String
4183
+ # resp.status #=> Integer
4184
+ #
4185
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeAssetBundleExportJob AWS API Documentation
4186
+ #
4187
+ # @overload describe_asset_bundle_export_job(params = {})
4188
+ # @param [Hash] params ({})
4189
+ def describe_asset_bundle_export_job(params = {}, options = {})
4190
+ req = build_request(:describe_asset_bundle_export_job, params)
4191
+ req.send_request(options)
4192
+ end
4193
+
4194
+ # Describes an existing import job.
4195
+ #
4196
+ # Poll job descriptions after starting a job to know when it has
4197
+ # succeeded or failed. Job descriptions are available for 14 days after
4198
+ # job starts.
4199
+ #
4200
+ # @option params [required, String] :aws_account_id
4201
+ # The ID of the Amazon Web Services account the import job was executed
4202
+ # in.
4203
+ #
4204
+ # @option params [required, String] :asset_bundle_import_job_id
4205
+ # The ID of the job. The job ID is set when you start a new job with a
4206
+ # `StartAssetBundleImportJob` API call.
4207
+ #
4208
+ # @return [Types::DescribeAssetBundleImportJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
4209
+ #
4210
+ # * {Types::DescribeAssetBundleImportJobResponse#job_status #job_status} => String
4211
+ # * {Types::DescribeAssetBundleImportJobResponse#errors #errors} => Array<Types::AssetBundleImportJobError>
4212
+ # * {Types::DescribeAssetBundleImportJobResponse#rollback_errors #rollback_errors} => Array<Types::AssetBundleImportJobError>
4213
+ # * {Types::DescribeAssetBundleImportJobResponse#arn #arn} => String
4214
+ # * {Types::DescribeAssetBundleImportJobResponse#created_time #created_time} => Time
4215
+ # * {Types::DescribeAssetBundleImportJobResponse#asset_bundle_import_job_id #asset_bundle_import_job_id} => String
4216
+ # * {Types::DescribeAssetBundleImportJobResponse#aws_account_id #aws_account_id} => String
4217
+ # * {Types::DescribeAssetBundleImportJobResponse#asset_bundle_import_source #asset_bundle_import_source} => Types::AssetBundleImportSourceDescription
4218
+ # * {Types::DescribeAssetBundleImportJobResponse#override_parameters #override_parameters} => Types::AssetBundleImportJobOverrideParameters
4219
+ # * {Types::DescribeAssetBundleImportJobResponse#failure_action #failure_action} => String
4220
+ # * {Types::DescribeAssetBundleImportJobResponse#request_id #request_id} => String
4221
+ # * {Types::DescribeAssetBundleImportJobResponse#status #status} => Integer
4222
+ #
4223
+ # @example Request syntax with placeholder values
4224
+ #
4225
+ # resp = client.describe_asset_bundle_import_job({
4226
+ # aws_account_id: "AwsAccountId", # required
4227
+ # asset_bundle_import_job_id: "ShortRestrictiveResourceId", # required
4228
+ # })
4229
+ #
4230
+ # @example Response structure
4231
+ #
4232
+ # resp.job_status #=> String, one of "QUEUED_FOR_IMMEDIATE_EXECUTION", "IN_PROGRESS", "SUCCESSFUL", "FAILED", "FAILED_ROLLBACK_IN_PROGRESS", "FAILED_ROLLBACK_COMPLETED", "FAILED_ROLLBACK_ERROR"
4233
+ # resp.errors #=> Array
4234
+ # resp.errors[0].arn #=> String
4235
+ # resp.errors[0].type #=> String
4236
+ # resp.errors[0].message #=> String
4237
+ # resp.rollback_errors #=> Array
4238
+ # resp.rollback_errors[0].arn #=> String
4239
+ # resp.rollback_errors[0].type #=> String
4240
+ # resp.rollback_errors[0].message #=> String
4241
+ # resp.arn #=> String
4242
+ # resp.created_time #=> Time
4243
+ # resp.asset_bundle_import_job_id #=> String
4244
+ # resp.aws_account_id #=> String
4245
+ # resp.asset_bundle_import_source.body #=> String
4246
+ # resp.asset_bundle_import_source.s3_uri #=> String
4247
+ # resp.override_parameters.resource_id_override_configuration.prefix_for_all_resources #=> String
4248
+ # resp.override_parameters.vpc_connections #=> Array
4249
+ # resp.override_parameters.vpc_connections[0].vpc_connection_id #=> String
4250
+ # resp.override_parameters.vpc_connections[0].name #=> String
4251
+ # resp.override_parameters.vpc_connections[0].subnet_ids #=> Array
4252
+ # resp.override_parameters.vpc_connections[0].subnet_ids[0] #=> String
4253
+ # resp.override_parameters.vpc_connections[0].security_group_ids #=> Array
4254
+ # resp.override_parameters.vpc_connections[0].security_group_ids[0] #=> String
4255
+ # resp.override_parameters.vpc_connections[0].dns_resolvers #=> Array
4256
+ # resp.override_parameters.vpc_connections[0].dns_resolvers[0] #=> String
4257
+ # resp.override_parameters.vpc_connections[0].role_arn #=> String
4258
+ # resp.override_parameters.refresh_schedules #=> Array
4259
+ # resp.override_parameters.refresh_schedules[0].data_set_id #=> String
4260
+ # resp.override_parameters.refresh_schedules[0].schedule_id #=> String
4261
+ # resp.override_parameters.refresh_schedules[0].start_after_date_time #=> Time
4262
+ # resp.override_parameters.data_sources #=> Array
4263
+ # resp.override_parameters.data_sources[0].data_source_id #=> String
4264
+ # resp.override_parameters.data_sources[0].name #=> String
4265
+ # resp.override_parameters.data_sources[0].data_source_parameters.amazon_elasticsearch_parameters.domain #=> String
4266
+ # resp.override_parameters.data_sources[0].data_source_parameters.athena_parameters.work_group #=> String
4267
+ # resp.override_parameters.data_sources[0].data_source_parameters.athena_parameters.role_arn #=> String
4268
+ # resp.override_parameters.data_sources[0].data_source_parameters.aurora_parameters.host #=> String
4269
+ # resp.override_parameters.data_sources[0].data_source_parameters.aurora_parameters.port #=> Integer
4270
+ # resp.override_parameters.data_sources[0].data_source_parameters.aurora_parameters.database #=> String
4271
+ # resp.override_parameters.data_sources[0].data_source_parameters.aurora_postgre_sql_parameters.host #=> String
4272
+ # resp.override_parameters.data_sources[0].data_source_parameters.aurora_postgre_sql_parameters.port #=> Integer
4273
+ # resp.override_parameters.data_sources[0].data_source_parameters.aurora_postgre_sql_parameters.database #=> String
4274
+ # resp.override_parameters.data_sources[0].data_source_parameters.aws_iot_analytics_parameters.data_set_name #=> String
4275
+ # resp.override_parameters.data_sources[0].data_source_parameters.jira_parameters.site_base_url #=> String
4276
+ # resp.override_parameters.data_sources[0].data_source_parameters.maria_db_parameters.host #=> String
4277
+ # resp.override_parameters.data_sources[0].data_source_parameters.maria_db_parameters.port #=> Integer
4278
+ # resp.override_parameters.data_sources[0].data_source_parameters.maria_db_parameters.database #=> String
4279
+ # resp.override_parameters.data_sources[0].data_source_parameters.my_sql_parameters.host #=> String
4280
+ # resp.override_parameters.data_sources[0].data_source_parameters.my_sql_parameters.port #=> Integer
4281
+ # resp.override_parameters.data_sources[0].data_source_parameters.my_sql_parameters.database #=> String
4282
+ # resp.override_parameters.data_sources[0].data_source_parameters.oracle_parameters.host #=> String
4283
+ # resp.override_parameters.data_sources[0].data_source_parameters.oracle_parameters.port #=> Integer
4284
+ # resp.override_parameters.data_sources[0].data_source_parameters.oracle_parameters.database #=> String
4285
+ # resp.override_parameters.data_sources[0].data_source_parameters.postgre_sql_parameters.host #=> String
4286
+ # resp.override_parameters.data_sources[0].data_source_parameters.postgre_sql_parameters.port #=> Integer
4287
+ # resp.override_parameters.data_sources[0].data_source_parameters.postgre_sql_parameters.database #=> String
4288
+ # resp.override_parameters.data_sources[0].data_source_parameters.presto_parameters.host #=> String
4289
+ # resp.override_parameters.data_sources[0].data_source_parameters.presto_parameters.port #=> Integer
4290
+ # resp.override_parameters.data_sources[0].data_source_parameters.presto_parameters.catalog #=> String
4291
+ # resp.override_parameters.data_sources[0].data_source_parameters.rds_parameters.instance_id #=> String
4292
+ # resp.override_parameters.data_sources[0].data_source_parameters.rds_parameters.database #=> String
4293
+ # resp.override_parameters.data_sources[0].data_source_parameters.redshift_parameters.host #=> String
4294
+ # resp.override_parameters.data_sources[0].data_source_parameters.redshift_parameters.port #=> Integer
4295
+ # resp.override_parameters.data_sources[0].data_source_parameters.redshift_parameters.database #=> String
4296
+ # resp.override_parameters.data_sources[0].data_source_parameters.redshift_parameters.cluster_id #=> String
4297
+ # resp.override_parameters.data_sources[0].data_source_parameters.s3_parameters.manifest_file_location.bucket #=> String
4298
+ # resp.override_parameters.data_sources[0].data_source_parameters.s3_parameters.manifest_file_location.key #=> String
4299
+ # resp.override_parameters.data_sources[0].data_source_parameters.s3_parameters.role_arn #=> String
4300
+ # resp.override_parameters.data_sources[0].data_source_parameters.service_now_parameters.site_base_url #=> String
4301
+ # resp.override_parameters.data_sources[0].data_source_parameters.snowflake_parameters.host #=> String
4302
+ # resp.override_parameters.data_sources[0].data_source_parameters.snowflake_parameters.database #=> String
4303
+ # resp.override_parameters.data_sources[0].data_source_parameters.snowflake_parameters.warehouse #=> String
4304
+ # resp.override_parameters.data_sources[0].data_source_parameters.spark_parameters.host #=> String
4305
+ # resp.override_parameters.data_sources[0].data_source_parameters.spark_parameters.port #=> Integer
4306
+ # resp.override_parameters.data_sources[0].data_source_parameters.sql_server_parameters.host #=> String
4307
+ # resp.override_parameters.data_sources[0].data_source_parameters.sql_server_parameters.port #=> Integer
4308
+ # resp.override_parameters.data_sources[0].data_source_parameters.sql_server_parameters.database #=> String
4309
+ # resp.override_parameters.data_sources[0].data_source_parameters.teradata_parameters.host #=> String
4310
+ # resp.override_parameters.data_sources[0].data_source_parameters.teradata_parameters.port #=> Integer
4311
+ # resp.override_parameters.data_sources[0].data_source_parameters.teradata_parameters.database #=> String
4312
+ # resp.override_parameters.data_sources[0].data_source_parameters.twitter_parameters.query #=> String
4313
+ # resp.override_parameters.data_sources[0].data_source_parameters.twitter_parameters.max_rows #=> Integer
4314
+ # resp.override_parameters.data_sources[0].data_source_parameters.amazon_open_search_parameters.domain #=> String
4315
+ # resp.override_parameters.data_sources[0].data_source_parameters.exasol_parameters.host #=> String
4316
+ # resp.override_parameters.data_sources[0].data_source_parameters.exasol_parameters.port #=> Integer
4317
+ # resp.override_parameters.data_sources[0].data_source_parameters.databricks_parameters.host #=> String
4318
+ # resp.override_parameters.data_sources[0].data_source_parameters.databricks_parameters.port #=> Integer
4319
+ # resp.override_parameters.data_sources[0].data_source_parameters.databricks_parameters.sql_endpoint_path #=> String
4320
+ # resp.override_parameters.data_sources[0].vpc_connection_properties.vpc_connection_arn #=> String
4321
+ # resp.override_parameters.data_sources[0].ssl_properties.disable_ssl #=> Boolean
4322
+ # resp.override_parameters.data_sources[0].credentials.credential_pair.username #=> String
4323
+ # resp.override_parameters.data_sources[0].credentials.credential_pair.password #=> String
4324
+ # resp.override_parameters.data_sources[0].credentials.secret_arn #=> String
4325
+ # resp.override_parameters.data_sets #=> Array
4326
+ # resp.override_parameters.data_sets[0].data_set_id #=> String
4327
+ # resp.override_parameters.data_sets[0].name #=> String
4328
+ # resp.override_parameters.themes #=> Array
4329
+ # resp.override_parameters.themes[0].theme_id #=> String
4330
+ # resp.override_parameters.themes[0].name #=> String
4331
+ # resp.override_parameters.analyses #=> Array
4332
+ # resp.override_parameters.analyses[0].analysis_id #=> String
4333
+ # resp.override_parameters.analyses[0].name #=> String
4334
+ # resp.override_parameters.dashboards #=> Array
4335
+ # resp.override_parameters.dashboards[0].dashboard_id #=> String
4336
+ # resp.override_parameters.dashboards[0].name #=> String
4337
+ # resp.failure_action #=> String, one of "DO_NOTHING", "ROLLBACK"
4338
+ # resp.request_id #=> String
4339
+ # resp.status #=> Integer
4340
+ #
4341
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeAssetBundleImportJob AWS API Documentation
4342
+ #
4343
+ # @overload describe_asset_bundle_import_job(params = {})
4344
+ # @param [Hash] params ({})
4345
+ def describe_asset_bundle_import_job(params = {}, options = {})
4346
+ req = build_request(:describe_asset_bundle_import_job, params)
4347
+ req.send_request(options)
4348
+ end
4349
+
4096
4350
  # Provides a summary for a dashboard.
4097
4351
  #
4098
4352
  # @option params [required, String] :aws_account_id
@@ -6567,6 +6821,117 @@ module Aws::QuickSight
6567
6821
  req.send_request(options)
6568
6822
  end
6569
6823
 
6824
+ # Lists all asset bundle export jobs that have been taken place in the
6825
+ # last 14 days. Jobs created more than 14 days ago are deleted forever
6826
+ # and are not returned. If you are using the same job ID for multiple
6827
+ # jobs, `ListAssetBundleExportJobs` only returns the most recent job
6828
+ # that uses the repeated job ID.
6829
+ #
6830
+ # @option params [required, String] :aws_account_id
6831
+ # The ID of the Amazon Web Services account that the export jobs were
6832
+ # executed in.
6833
+ #
6834
+ # @option params [String] :next_token
6835
+ # The token for the next set of results, or null if there are no more
6836
+ # results.
6837
+ #
6838
+ # @option params [Integer] :max_results
6839
+ # The maximum number of results to be returned per request.
6840
+ #
6841
+ # @return [Types::ListAssetBundleExportJobsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
6842
+ #
6843
+ # * {Types::ListAssetBundleExportJobsResponse#asset_bundle_export_job_summary_list #asset_bundle_export_job_summary_list} => Array<Types::AssetBundleExportJobSummary>
6844
+ # * {Types::ListAssetBundleExportJobsResponse#next_token #next_token} => String
6845
+ # * {Types::ListAssetBundleExportJobsResponse#request_id #request_id} => String
6846
+ # * {Types::ListAssetBundleExportJobsResponse#status #status} => Integer
6847
+ #
6848
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
6849
+ #
6850
+ # @example Request syntax with placeholder values
6851
+ #
6852
+ # resp = client.list_asset_bundle_export_jobs({
6853
+ # aws_account_id: "AwsAccountId", # required
6854
+ # next_token: "String",
6855
+ # max_results: 1,
6856
+ # })
6857
+ #
6858
+ # @example Response structure
6859
+ #
6860
+ # resp.asset_bundle_export_job_summary_list #=> Array
6861
+ # resp.asset_bundle_export_job_summary_list[0].job_status #=> String, one of "QUEUED_FOR_IMMEDIATE_EXECUTION", "IN_PROGRESS", "SUCCESSFUL", "FAILED"
6862
+ # resp.asset_bundle_export_job_summary_list[0].arn #=> String
6863
+ # resp.asset_bundle_export_job_summary_list[0].created_time #=> Time
6864
+ # resp.asset_bundle_export_job_summary_list[0].asset_bundle_export_job_id #=> String
6865
+ # resp.asset_bundle_export_job_summary_list[0].include_all_dependencies #=> Boolean
6866
+ # resp.asset_bundle_export_job_summary_list[0].export_format #=> String, one of "CLOUDFORMATION_JSON", "QUICKSIGHT_JSON"
6867
+ # resp.next_token #=> String
6868
+ # resp.request_id #=> String
6869
+ # resp.status #=> Integer
6870
+ #
6871
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListAssetBundleExportJobs AWS API Documentation
6872
+ #
6873
+ # @overload list_asset_bundle_export_jobs(params = {})
6874
+ # @param [Hash] params ({})
6875
+ def list_asset_bundle_export_jobs(params = {}, options = {})
6876
+ req = build_request(:list_asset_bundle_export_jobs, params)
6877
+ req.send_request(options)
6878
+ end
6879
+
6880
+ # Lists all asset bundle import jobs that have taken place in the last
6881
+ # 14 days. Jobs created more than 14 days ago are deleted forever and
6882
+ # are not returned. If you are using the same job ID for multiple jobs,
6883
+ # `ListAssetBundleImportJobs` only returns the most recent job that uses
6884
+ # the repeated job ID.
6885
+ #
6886
+ # @option params [required, String] :aws_account_id
6887
+ # The ID of the Amazon Web Services account that the import jobs were
6888
+ # executed in.
6889
+ #
6890
+ # @option params [String] :next_token
6891
+ # The token for the next set of results, or null if there are no more
6892
+ # results.
6893
+ #
6894
+ # @option params [Integer] :max_results
6895
+ # The maximum number of results to be returned per request.
6896
+ #
6897
+ # @return [Types::ListAssetBundleImportJobsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
6898
+ #
6899
+ # * {Types::ListAssetBundleImportJobsResponse#asset_bundle_import_job_summary_list #asset_bundle_import_job_summary_list} => Array<Types::AssetBundleImportJobSummary>
6900
+ # * {Types::ListAssetBundleImportJobsResponse#next_token #next_token} => String
6901
+ # * {Types::ListAssetBundleImportJobsResponse#request_id #request_id} => String
6902
+ # * {Types::ListAssetBundleImportJobsResponse#status #status} => Integer
6903
+ #
6904
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
6905
+ #
6906
+ # @example Request syntax with placeholder values
6907
+ #
6908
+ # resp = client.list_asset_bundle_import_jobs({
6909
+ # aws_account_id: "AwsAccountId", # required
6910
+ # next_token: "String",
6911
+ # max_results: 1,
6912
+ # })
6913
+ #
6914
+ # @example Response structure
6915
+ #
6916
+ # resp.asset_bundle_import_job_summary_list #=> Array
6917
+ # resp.asset_bundle_import_job_summary_list[0].job_status #=> String, one of "QUEUED_FOR_IMMEDIATE_EXECUTION", "IN_PROGRESS", "SUCCESSFUL", "FAILED", "FAILED_ROLLBACK_IN_PROGRESS", "FAILED_ROLLBACK_COMPLETED", "FAILED_ROLLBACK_ERROR"
6918
+ # resp.asset_bundle_import_job_summary_list[0].arn #=> String
6919
+ # resp.asset_bundle_import_job_summary_list[0].created_time #=> Time
6920
+ # resp.asset_bundle_import_job_summary_list[0].asset_bundle_import_job_id #=> String
6921
+ # resp.asset_bundle_import_job_summary_list[0].failure_action #=> String, one of "DO_NOTHING", "ROLLBACK"
6922
+ # resp.next_token #=> String
6923
+ # resp.request_id #=> String
6924
+ # resp.status #=> Integer
6925
+ #
6926
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListAssetBundleImportJobs AWS API Documentation
6927
+ #
6928
+ # @overload list_asset_bundle_import_jobs(params = {})
6929
+ # @param [Hash] params ({})
6930
+ def list_asset_bundle_import_jobs(params = {}, options = {})
6931
+ req = build_request(:list_asset_bundle_import_jobs, params)
6932
+ req.send_request(options)
6933
+ end
6934
+
6570
6935
  # Lists all the versions of the dashboards in the Amazon QuickSight
6571
6936
  # subscription.
6572
6937
  #
@@ -8703,6 +9068,392 @@ module Aws::QuickSight
8703
9068
  req.send_request(options)
8704
9069
  end
8705
9070
 
9071
+ # Starts an Asset Bundle export job.
9072
+ #
9073
+ # An Asset Bundle export job exports specified Amazon QuickSight assets.
9074
+ # You can also choose to export any asset dependencies in the same job.
9075
+ # Export jobs run asynchronously and can be polled with a
9076
+ # `DescribeAssetBundleExportJob` API call. When a job is successfully
9077
+ # completed, a download URL that contains the exported assets is
9078
+ # returned. The URL is valid for 5 minutes and can be refreshed with a
9079
+ # `DescribeAssetBundleExportJob` API call. Each Amazon QuickSight
9080
+ # account can run up to 10 export jobs concurrently.
9081
+ #
9082
+ # The API caller must have the necessary permissions in their IAM role
9083
+ # to access each resource before the resources can be exported.
9084
+ #
9085
+ # @option params [required, String] :aws_account_id
9086
+ # The ID of the Amazon Web Services account to export assets from.
9087
+ #
9088
+ # @option params [required, String] :asset_bundle_export_job_id
9089
+ # The ID of the job. This ID is unique while the job is running. After
9090
+ # the job is completed, you can reuse this ID for another job.
9091
+ #
9092
+ # @option params [required, Array<String>] :resource_arns
9093
+ # An array of resource ARNs to export. The following resources are
9094
+ # supported.
9095
+ #
9096
+ # * `Analysis`
9097
+ #
9098
+ # * `Dashboard`
9099
+ #
9100
+ # * `DataSet`
9101
+ #
9102
+ # * `DataSource`
9103
+ #
9104
+ # * `RefreshSchedule`
9105
+ #
9106
+ # * `Theme`
9107
+ #
9108
+ # * `VPCConnection`
9109
+ #
9110
+ # The API caller must have the necessary permissions in their IAM role
9111
+ # to access each resource before the resources can be exported.
9112
+ #
9113
+ # @option params [Boolean] :include_all_dependencies
9114
+ # A Boolean that determines whether all dependencies of each resource
9115
+ # ARN are recursively exported with the job. For example, say you
9116
+ # provided a Dashboard ARN to the `ResourceArns` parameter. If you set
9117
+ # `IncludeAllDependencies` to `TRUE`, any theme, dataset, and dataource
9118
+ # resource that is a dependency of the dashboard is also exported.
9119
+ #
9120
+ # @option params [required, String] :export_format
9121
+ # The export data format.
9122
+ #
9123
+ # @option params [Types::AssetBundleCloudFormationOverridePropertyConfiguration] :cloud_formation_override_property_configuration
9124
+ # An optional collection of structures that generate CloudFormation
9125
+ # parameters to override the existing resource property values when the
9126
+ # resource is exported to a new CloudFormation template.
9127
+ #
9128
+ # Use this field if the `ExportFormat` field of a
9129
+ # `StartAssetBundleExportJobRequest` API call is set to
9130
+ # `CLOUDFORMATION_JSON`.
9131
+ #
9132
+ # @return [Types::StartAssetBundleExportJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
9133
+ #
9134
+ # * {Types::StartAssetBundleExportJobResponse#arn #arn} => String
9135
+ # * {Types::StartAssetBundleExportJobResponse#asset_bundle_export_job_id #asset_bundle_export_job_id} => String
9136
+ # * {Types::StartAssetBundleExportJobResponse#request_id #request_id} => String
9137
+ # * {Types::StartAssetBundleExportJobResponse#status #status} => Integer
9138
+ #
9139
+ # @example Request syntax with placeholder values
9140
+ #
9141
+ # resp = client.start_asset_bundle_export_job({
9142
+ # aws_account_id: "AwsAccountId", # required
9143
+ # asset_bundle_export_job_id: "ShortRestrictiveResourceId", # required
9144
+ # resource_arns: ["Arn"], # required
9145
+ # include_all_dependencies: false,
9146
+ # export_format: "CLOUDFORMATION_JSON", # required, accepts CLOUDFORMATION_JSON, QUICKSIGHT_JSON
9147
+ # cloud_formation_override_property_configuration: {
9148
+ # resource_id_override_configuration: {
9149
+ # prefix_for_all_resources: false,
9150
+ # },
9151
+ # vpc_connections: [
9152
+ # {
9153
+ # arn: "Arn",
9154
+ # properties: ["Name"], # required, accepts Name, DnsResolvers, RoleArn
9155
+ # },
9156
+ # ],
9157
+ # refresh_schedules: [
9158
+ # {
9159
+ # arn: "Arn",
9160
+ # properties: ["StartAfterDateTime"], # required, accepts StartAfterDateTime
9161
+ # },
9162
+ # ],
9163
+ # data_sources: [
9164
+ # {
9165
+ # arn: "Arn",
9166
+ # properties: ["Name"], # required, accepts Name, DisableSsl, SecretArn, Username, Password, Domain, WorkGroup, Host, Port, Database, DataSetName, Catalog, InstanceId, ClusterId, ManifestFileLocation, Warehouse, RoleArn
9167
+ # },
9168
+ # ],
9169
+ # data_sets: [
9170
+ # {
9171
+ # arn: "Arn",
9172
+ # properties: ["Name"], # required, accepts Name
9173
+ # },
9174
+ # ],
9175
+ # themes: [
9176
+ # {
9177
+ # arn: "Arn",
9178
+ # properties: ["Name"], # required, accepts Name
9179
+ # },
9180
+ # ],
9181
+ # analyses: [
9182
+ # {
9183
+ # arn: "Arn",
9184
+ # properties: ["Name"], # required, accepts Name
9185
+ # },
9186
+ # ],
9187
+ # dashboards: [
9188
+ # {
9189
+ # arn: "Arn",
9190
+ # properties: ["Name"], # required, accepts Name
9191
+ # },
9192
+ # ],
9193
+ # },
9194
+ # })
9195
+ #
9196
+ # @example Response structure
9197
+ #
9198
+ # resp.arn #=> String
9199
+ # resp.asset_bundle_export_job_id #=> String
9200
+ # resp.request_id #=> String
9201
+ # resp.status #=> Integer
9202
+ #
9203
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/StartAssetBundleExportJob AWS API Documentation
9204
+ #
9205
+ # @overload start_asset_bundle_export_job(params = {})
9206
+ # @param [Hash] params ({})
9207
+ def start_asset_bundle_export_job(params = {}, options = {})
9208
+ req = build_request(:start_asset_bundle_export_job, params)
9209
+ req.send_request(options)
9210
+ end
9211
+
9212
+ # Starts an Asset Bundle import job.
9213
+ #
9214
+ # An Asset Bundle import job imports specified Amazon QuickSight assets
9215
+ # into an Amazon QuickSight account. You can also choose to import a
9216
+ # naming prefix and specified configuration overrides. The assets that
9217
+ # are contained in the bundle file that you provide are used to create
9218
+ # or update a new or existing asset in your Amazon QuickSight account.
9219
+ # Each Amazon QuickSight account can run up to 10 import jobs
9220
+ # concurrently.
9221
+ #
9222
+ # The API caller must have the necessary `"create"`, `"describe"`, and
9223
+ # `"update"` permissions in their IAM role to access each resource type
9224
+ # that is contained in the bundle file before the resources can be
9225
+ # imported.
9226
+ #
9227
+ # @option params [required, String] :aws_account_id
9228
+ # The ID of the Amazon Web Services account to import assets into.
9229
+ #
9230
+ # @option params [required, String] :asset_bundle_import_job_id
9231
+ # The ID of the job. This ID is unique while the job is running. After
9232
+ # the job is completed, you can reuse this ID for another job.
9233
+ #
9234
+ # @option params [required, Types::AssetBundleImportSource] :asset_bundle_import_source
9235
+ # The source of the asset bundle zip file that contains the data that
9236
+ # you want to import.
9237
+ #
9238
+ # @option params [Types::AssetBundleImportJobOverrideParameters] :override_parameters
9239
+ # Optional overrides to be applied to the resource configuration before
9240
+ # import.
9241
+ #
9242
+ # @option params [String] :failure_action
9243
+ # The failure action for the import job.
9244
+ #
9245
+ # If you choose `ROLLBACK`, failed import jobs will attempt to undo any
9246
+ # asset changes caused by the failed job.
9247
+ #
9248
+ # If you choose `DO_NOTHING`, failed import jobs will not attempt to
9249
+ # roll back any asset changes caused by the failed job, possibly leaving
9250
+ # the Amazon QuickSight account in an inconsistent state.
9251
+ #
9252
+ # @return [Types::StartAssetBundleImportJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
9253
+ #
9254
+ # * {Types::StartAssetBundleImportJobResponse#arn #arn} => String
9255
+ # * {Types::StartAssetBundleImportJobResponse#asset_bundle_import_job_id #asset_bundle_import_job_id} => String
9256
+ # * {Types::StartAssetBundleImportJobResponse#request_id #request_id} => String
9257
+ # * {Types::StartAssetBundleImportJobResponse#status #status} => Integer
9258
+ #
9259
+ # @example Request syntax with placeholder values
9260
+ #
9261
+ # resp = client.start_asset_bundle_import_job({
9262
+ # aws_account_id: "AwsAccountId", # required
9263
+ # asset_bundle_import_job_id: "ShortRestrictiveResourceId", # required
9264
+ # asset_bundle_import_source: { # required
9265
+ # body: "data",
9266
+ # s3_uri: "S3Uri",
9267
+ # },
9268
+ # override_parameters: {
9269
+ # resource_id_override_configuration: {
9270
+ # prefix_for_all_resources: "String",
9271
+ # },
9272
+ # vpc_connections: [
9273
+ # {
9274
+ # vpc_connection_id: "VPCConnectionResourceIdUnrestricted", # required
9275
+ # name: "ResourceName",
9276
+ # subnet_ids: ["SubnetId"],
9277
+ # security_group_ids: ["SecurityGroupId"],
9278
+ # dns_resolvers: ["IPv4Address"],
9279
+ # role_arn: "RoleArn",
9280
+ # },
9281
+ # ],
9282
+ # refresh_schedules: [
9283
+ # {
9284
+ # data_set_id: "ResourceId", # required
9285
+ # schedule_id: "String", # required
9286
+ # start_after_date_time: Time.now,
9287
+ # },
9288
+ # ],
9289
+ # data_sources: [
9290
+ # {
9291
+ # data_source_id: "ResourceId", # required
9292
+ # name: "ResourceName",
9293
+ # data_source_parameters: {
9294
+ # amazon_elasticsearch_parameters: {
9295
+ # domain: "Domain", # required
9296
+ # },
9297
+ # athena_parameters: {
9298
+ # work_group: "WorkGroup",
9299
+ # role_arn: "RoleArn",
9300
+ # },
9301
+ # aurora_parameters: {
9302
+ # host: "Host", # required
9303
+ # port: 1, # required
9304
+ # database: "Database", # required
9305
+ # },
9306
+ # aurora_postgre_sql_parameters: {
9307
+ # host: "Host", # required
9308
+ # port: 1, # required
9309
+ # database: "Database", # required
9310
+ # },
9311
+ # aws_iot_analytics_parameters: {
9312
+ # data_set_name: "DataSetName", # required
9313
+ # },
9314
+ # jira_parameters: {
9315
+ # site_base_url: "SiteBaseUrl", # required
9316
+ # },
9317
+ # maria_db_parameters: {
9318
+ # host: "Host", # required
9319
+ # port: 1, # required
9320
+ # database: "Database", # required
9321
+ # },
9322
+ # my_sql_parameters: {
9323
+ # host: "Host", # required
9324
+ # port: 1, # required
9325
+ # database: "Database", # required
9326
+ # },
9327
+ # oracle_parameters: {
9328
+ # host: "Host", # required
9329
+ # port: 1, # required
9330
+ # database: "Database", # required
9331
+ # },
9332
+ # postgre_sql_parameters: {
9333
+ # host: "Host", # required
9334
+ # port: 1, # required
9335
+ # database: "Database", # required
9336
+ # },
9337
+ # presto_parameters: {
9338
+ # host: "Host", # required
9339
+ # port: 1, # required
9340
+ # catalog: "Catalog", # required
9341
+ # },
9342
+ # rds_parameters: {
9343
+ # instance_id: "InstanceId", # required
9344
+ # database: "Database", # required
9345
+ # },
9346
+ # redshift_parameters: {
9347
+ # host: "Host",
9348
+ # port: 1,
9349
+ # database: "Database", # required
9350
+ # cluster_id: "ClusterId",
9351
+ # },
9352
+ # s3_parameters: {
9353
+ # manifest_file_location: { # required
9354
+ # bucket: "S3Bucket", # required
9355
+ # key: "S3Key", # required
9356
+ # },
9357
+ # role_arn: "RoleArn",
9358
+ # },
9359
+ # service_now_parameters: {
9360
+ # site_base_url: "SiteBaseUrl", # required
9361
+ # },
9362
+ # snowflake_parameters: {
9363
+ # host: "Host", # required
9364
+ # database: "Database", # required
9365
+ # warehouse: "Warehouse", # required
9366
+ # },
9367
+ # spark_parameters: {
9368
+ # host: "Host", # required
9369
+ # port: 1, # required
9370
+ # },
9371
+ # sql_server_parameters: {
9372
+ # host: "Host", # required
9373
+ # port: 1, # required
9374
+ # database: "Database", # required
9375
+ # },
9376
+ # teradata_parameters: {
9377
+ # host: "Host", # required
9378
+ # port: 1, # required
9379
+ # database: "Database", # required
9380
+ # },
9381
+ # twitter_parameters: {
9382
+ # query: "Query", # required
9383
+ # max_rows: 1, # required
9384
+ # },
9385
+ # amazon_open_search_parameters: {
9386
+ # domain: "Domain", # required
9387
+ # },
9388
+ # exasol_parameters: {
9389
+ # host: "Host", # required
9390
+ # port: 1, # required
9391
+ # },
9392
+ # databricks_parameters: {
9393
+ # host: "Host", # required
9394
+ # port: 1, # required
9395
+ # sql_endpoint_path: "SqlEndpointPath", # required
9396
+ # },
9397
+ # },
9398
+ # vpc_connection_properties: {
9399
+ # vpc_connection_arn: "Arn", # required
9400
+ # },
9401
+ # ssl_properties: {
9402
+ # disable_ssl: false,
9403
+ # },
9404
+ # credentials: {
9405
+ # credential_pair: {
9406
+ # username: "DbUsername", # required
9407
+ # password: "Password", # required
9408
+ # },
9409
+ # secret_arn: "SecretArn",
9410
+ # },
9411
+ # },
9412
+ # ],
9413
+ # data_sets: [
9414
+ # {
9415
+ # data_set_id: "ResourceId", # required
9416
+ # name: "ResourceName",
9417
+ # },
9418
+ # ],
9419
+ # themes: [
9420
+ # {
9421
+ # theme_id: "ResourceId", # required
9422
+ # name: "ResourceName",
9423
+ # },
9424
+ # ],
9425
+ # analyses: [
9426
+ # {
9427
+ # analysis_id: "ResourceId", # required
9428
+ # name: "ResourceName",
9429
+ # },
9430
+ # ],
9431
+ # dashboards: [
9432
+ # {
9433
+ # dashboard_id: "ResourceId", # required
9434
+ # name: "ResourceName",
9435
+ # },
9436
+ # ],
9437
+ # },
9438
+ # failure_action: "DO_NOTHING", # accepts DO_NOTHING, ROLLBACK
9439
+ # })
9440
+ #
9441
+ # @example Response structure
9442
+ #
9443
+ # resp.arn #=> String
9444
+ # resp.asset_bundle_import_job_id #=> String
9445
+ # resp.request_id #=> String
9446
+ # resp.status #=> Integer
9447
+ #
9448
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/StartAssetBundleImportJob AWS API Documentation
9449
+ #
9450
+ # @overload start_asset_bundle_import_job(params = {})
9451
+ # @param [Hash] params ({})
9452
+ def start_asset_bundle_import_job(params = {}, options = {})
9453
+ req = build_request(:start_asset_bundle_import_job, params)
9454
+ req.send_request(options)
9455
+ end
9456
+
8706
9457
  # Assigns one or more tags (key-value pairs) to the specified Amazon
8707
9458
  # QuickSight resource.
8708
9459
  #
@@ -9770,7 +10521,7 @@ module Aws::QuickSight
9770
10521
  # },
9771
10522
  # credentials: {
9772
10523
  # credential_pair: {
9773
- # username: "Username", # required
10524
+ # username: "DbUsername", # required
9774
10525
  # password: "Password", # required
9775
10526
  # alternate_data_source_parameters: [
9776
10527
  # {
@@ -11392,7 +12143,7 @@ module Aws::QuickSight
11392
12143
  params: params,
11393
12144
  config: config)
11394
12145
  context[:gem_name] = 'aws-sdk-quicksight'
11395
- context[:gem_version] = '1.79.0'
12146
+ context[:gem_version] = '1.80.0'
11396
12147
  Seahorse::Client::Request.new(handlers, context)
11397
12148
  end
11398
12149