aws-sdk-bcmdataexports 1.0.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.
@@ -0,0 +1,919 @@
1
+ # frozen_string_literal: true
2
+
3
+ # WARNING ABOUT GENERATED CODE
4
+ #
5
+ # This file is generated. See the contributing guide for more information:
6
+ # https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
7
+ #
8
+ # WARNING ABOUT GENERATED CODE
9
+
10
+ module Aws::BCMDataExports
11
+ module Types
12
+
13
+ # Includes basic information for a data column such as its description,
14
+ # name, and type.
15
+ #
16
+ # @!attribute [rw] description
17
+ # The description for a column.
18
+ # @return [String]
19
+ #
20
+ # @!attribute [rw] name
21
+ # The column name.
22
+ # @return [String]
23
+ #
24
+ # @!attribute [rw] type
25
+ # The kind of data a column stores.
26
+ # @return [String]
27
+ #
28
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bcm-data-exports-2023-11-26/Column AWS API Documentation
29
+ #
30
+ class Column < Struct.new(
31
+ :description,
32
+ :name,
33
+ :type)
34
+ SENSITIVE = []
35
+ include Aws::Structure
36
+ end
37
+
38
+ # @!attribute [rw] export
39
+ # The details of the export, including data query, name, description,
40
+ # and destination configuration.
41
+ # @return [Types::Export]
42
+ #
43
+ # @!attribute [rw] resource_tags
44
+ # An optional list of tags to associate with the specified export.
45
+ # Each tag consists of a key and a value, and each key must be unique
46
+ # for the resource.
47
+ # @return [Array<Types::ResourceTag>]
48
+ #
49
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bcm-data-exports-2023-11-26/CreateExportRequest AWS API Documentation
50
+ #
51
+ class CreateExportRequest < Struct.new(
52
+ :export,
53
+ :resource_tags)
54
+ SENSITIVE = []
55
+ include Aws::Structure
56
+ end
57
+
58
+ # @!attribute [rw] export_arn
59
+ # The Amazon Resource Name (ARN) for this export.
60
+ # @return [String]
61
+ #
62
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bcm-data-exports-2023-11-26/CreateExportResponse AWS API Documentation
63
+ #
64
+ class CreateExportResponse < Struct.new(
65
+ :export_arn)
66
+ SENSITIVE = []
67
+ include Aws::Structure
68
+ end
69
+
70
+ # The SQL query of column selections and row filters from the data table
71
+ # you want.
72
+ #
73
+ # @!attribute [rw] query_statement
74
+ # The query statement.
75
+ # @return [String]
76
+ #
77
+ # @!attribute [rw] table_configurations
78
+ # The table configuration.
79
+ # @return [Hash<String,Hash<String,String>>]
80
+ #
81
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bcm-data-exports-2023-11-26/DataQuery AWS API Documentation
82
+ #
83
+ class DataQuery < Struct.new(
84
+ :query_statement,
85
+ :table_configurations)
86
+ SENSITIVE = []
87
+ include Aws::Structure
88
+ end
89
+
90
+ # @!attribute [rw] export_arn
91
+ # The Amazon Resource Name (ARN) for this export.
92
+ # @return [String]
93
+ #
94
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bcm-data-exports-2023-11-26/DeleteExportRequest AWS API Documentation
95
+ #
96
+ class DeleteExportRequest < Struct.new(
97
+ :export_arn)
98
+ SENSITIVE = []
99
+ include Aws::Structure
100
+ end
101
+
102
+ # @!attribute [rw] export_arn
103
+ # The Amazon Resource Name (ARN) for this export.
104
+ # @return [String]
105
+ #
106
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bcm-data-exports-2023-11-26/DeleteExportResponse AWS API Documentation
107
+ #
108
+ class DeleteExportResponse < Struct.new(
109
+ :export_arn)
110
+ SENSITIVE = []
111
+ include Aws::Structure
112
+ end
113
+
114
+ # The destinations used for data exports.
115
+ #
116
+ # @!attribute [rw] s3_destination
117
+ # An object that describes the destination of the data exports file.
118
+ # @return [Types::S3Destination]
119
+ #
120
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bcm-data-exports-2023-11-26/DestinationConfigurations AWS API Documentation
121
+ #
122
+ class DestinationConfigurations < Struct.new(
123
+ :s3_destination)
124
+ SENSITIVE = []
125
+ include Aws::Structure
126
+ end
127
+
128
+ # The reference for the data export update.
129
+ #
130
+ # @!attribute [rw] execution_id
131
+ # The ID for this specific execution.
132
+ # @return [String]
133
+ #
134
+ # @!attribute [rw] execution_status
135
+ # The status of this specific execution.
136
+ # @return [Types::ExecutionStatus]
137
+ #
138
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bcm-data-exports-2023-11-26/ExecutionReference AWS API Documentation
139
+ #
140
+ class ExecutionReference < Struct.new(
141
+ :execution_id,
142
+ :execution_status)
143
+ SENSITIVE = []
144
+ include Aws::Structure
145
+ end
146
+
147
+ # The status of the execution.
148
+ #
149
+ # @!attribute [rw] completed_at
150
+ # The time when the execution was completed.
151
+ # @return [Time]
152
+ #
153
+ # @!attribute [rw] created_at
154
+ # The time when the execution was created.
155
+ # @return [Time]
156
+ #
157
+ # @!attribute [rw] last_updated_at
158
+ # The time when the execution was last updated.
159
+ # @return [Time]
160
+ #
161
+ # @!attribute [rw] status_code
162
+ # The code for the status of the execution.
163
+ # @return [String]
164
+ #
165
+ # @!attribute [rw] status_reason
166
+ # The reason for the failed status.
167
+ # @return [String]
168
+ #
169
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bcm-data-exports-2023-11-26/ExecutionStatus AWS API Documentation
170
+ #
171
+ class ExecutionStatus < Struct.new(
172
+ :completed_at,
173
+ :created_at,
174
+ :last_updated_at,
175
+ :status_code,
176
+ :status_reason)
177
+ SENSITIVE = []
178
+ include Aws::Structure
179
+ end
180
+
181
+ # The details that are available for an export.
182
+ #
183
+ # @!attribute [rw] data_query
184
+ # The data query for this specific data export.
185
+ # @return [Types::DataQuery]
186
+ #
187
+ # @!attribute [rw] description
188
+ # The description for this specific data export.
189
+ # @return [String]
190
+ #
191
+ # @!attribute [rw] destination_configurations
192
+ # The destination configuration for this specific data export.
193
+ # @return [Types::DestinationConfigurations]
194
+ #
195
+ # @!attribute [rw] export_arn
196
+ # The Amazon Resource Name (ARN) for this export.
197
+ # @return [String]
198
+ #
199
+ # @!attribute [rw] name
200
+ # The name of this specific data export.
201
+ # @return [String]
202
+ #
203
+ # @!attribute [rw] refresh_cadence
204
+ # The cadence for Amazon Web Services to update the export in your S3
205
+ # bucket.
206
+ # @return [Types::RefreshCadence]
207
+ #
208
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bcm-data-exports-2023-11-26/Export AWS API Documentation
209
+ #
210
+ class Export < Struct.new(
211
+ :data_query,
212
+ :description,
213
+ :destination_configurations,
214
+ :export_arn,
215
+ :name,
216
+ :refresh_cadence)
217
+ SENSITIVE = []
218
+ include Aws::Structure
219
+ end
220
+
221
+ # The reference details for a given export.
222
+ #
223
+ # @!attribute [rw] export_arn
224
+ # The Amazon Resource Name (ARN) for this export.
225
+ # @return [String]
226
+ #
227
+ # @!attribute [rw] export_name
228
+ # The name of this specific data export.
229
+ # @return [String]
230
+ #
231
+ # @!attribute [rw] export_status
232
+ # The status of this specific data export.
233
+ # @return [Types::ExportStatus]
234
+ #
235
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bcm-data-exports-2023-11-26/ExportReference AWS API Documentation
236
+ #
237
+ class ExportReference < Struct.new(
238
+ :export_arn,
239
+ :export_name,
240
+ :export_status)
241
+ SENSITIVE = []
242
+ include Aws::Structure
243
+ end
244
+
245
+ # The status of the data export.
246
+ #
247
+ # @!attribute [rw] created_at
248
+ # The timestamp of when the export was created.
249
+ # @return [Time]
250
+ #
251
+ # @!attribute [rw] last_refreshed_at
252
+ # The timestamp of when the export was last generated.
253
+ # @return [Time]
254
+ #
255
+ # @!attribute [rw] last_updated_at
256
+ # The timestamp of when the export was updated.
257
+ # @return [Time]
258
+ #
259
+ # @!attribute [rw] status_code
260
+ # The status code for the request.
261
+ # @return [String]
262
+ #
263
+ # @!attribute [rw] status_reason
264
+ # The description for the status code.
265
+ # @return [String]
266
+ #
267
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bcm-data-exports-2023-11-26/ExportStatus AWS API Documentation
268
+ #
269
+ class ExportStatus < Struct.new(
270
+ :created_at,
271
+ :last_refreshed_at,
272
+ :last_updated_at,
273
+ :status_code,
274
+ :status_reason)
275
+ SENSITIVE = []
276
+ include Aws::Structure
277
+ end
278
+
279
+ # @!attribute [rw] execution_id
280
+ # The ID for this specific execution.
281
+ # @return [String]
282
+ #
283
+ # @!attribute [rw] export_arn
284
+ # The Amazon Resource Name (ARN) of the Export object that generated
285
+ # this specific execution.
286
+ # @return [String]
287
+ #
288
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bcm-data-exports-2023-11-26/GetExecutionRequest AWS API Documentation
289
+ #
290
+ class GetExecutionRequest < Struct.new(
291
+ :execution_id,
292
+ :export_arn)
293
+ SENSITIVE = []
294
+ include Aws::Structure
295
+ end
296
+
297
+ # @!attribute [rw] execution_id
298
+ # The ID for this specific execution.
299
+ # @return [String]
300
+ #
301
+ # @!attribute [rw] execution_status
302
+ # The status of this specific execution.
303
+ # @return [Types::ExecutionStatus]
304
+ #
305
+ # @!attribute [rw] export
306
+ # The export data for this specific execution. This export data is a
307
+ # snapshot from when the execution was generated. The data could be
308
+ # different from the current export data if the export was updated
309
+ # since the execution was generated.
310
+ # @return [Types::Export]
311
+ #
312
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bcm-data-exports-2023-11-26/GetExecutionResponse AWS API Documentation
313
+ #
314
+ class GetExecutionResponse < Struct.new(
315
+ :execution_id,
316
+ :execution_status,
317
+ :export)
318
+ SENSITIVE = []
319
+ include Aws::Structure
320
+ end
321
+
322
+ # @!attribute [rw] export_arn
323
+ # The Amazon Resource Name (ARN) for this export.
324
+ # @return [String]
325
+ #
326
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bcm-data-exports-2023-11-26/GetExportRequest AWS API Documentation
327
+ #
328
+ class GetExportRequest < Struct.new(
329
+ :export_arn)
330
+ SENSITIVE = []
331
+ include Aws::Structure
332
+ end
333
+
334
+ # @!attribute [rw] export
335
+ # The data for this specific export.
336
+ # @return [Types::Export]
337
+ #
338
+ # @!attribute [rw] export_status
339
+ # The status of this specific export.
340
+ # @return [Types::ExportStatus]
341
+ #
342
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bcm-data-exports-2023-11-26/GetExportResponse AWS API Documentation
343
+ #
344
+ class GetExportResponse < Struct.new(
345
+ :export,
346
+ :export_status)
347
+ SENSITIVE = []
348
+ include Aws::Structure
349
+ end
350
+
351
+ # @!attribute [rw] table_name
352
+ # The name of the table.
353
+ # @return [String]
354
+ #
355
+ # @!attribute [rw] table_properties
356
+ # TableProperties are additional configurations you can provide to
357
+ # change the data and schema of a table. Each table can have different
358
+ # TableProperties. Tables are not required to have any
359
+ # TableProperties. Each table property has a default value that it
360
+ # assumes if not specified.
361
+ # @return [Hash<String,String>]
362
+ #
363
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bcm-data-exports-2023-11-26/GetTableRequest AWS API Documentation
364
+ #
365
+ class GetTableRequest < Struct.new(
366
+ :table_name,
367
+ :table_properties)
368
+ SENSITIVE = []
369
+ include Aws::Structure
370
+ end
371
+
372
+ # @!attribute [rw] description
373
+ # The table description.
374
+ # @return [String]
375
+ #
376
+ # @!attribute [rw] schema
377
+ # The schema of the table.
378
+ # @return [Array<Types::Column>]
379
+ #
380
+ # @!attribute [rw] table_name
381
+ # The name of the table.
382
+ # @return [String]
383
+ #
384
+ # @!attribute [rw] table_properties
385
+ # TableProperties are additional configurations you can provide to
386
+ # change the data and schema of a table. Each table can have different
387
+ # TableProperties. Tables are not required to have any
388
+ # TableProperties. Each table property has a default value that it
389
+ # assumes if not specified.
390
+ # @return [Hash<String,String>]
391
+ #
392
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bcm-data-exports-2023-11-26/GetTableResponse AWS API Documentation
393
+ #
394
+ class GetTableResponse < Struct.new(
395
+ :description,
396
+ :schema,
397
+ :table_name,
398
+ :table_properties)
399
+ SENSITIVE = []
400
+ include Aws::Structure
401
+ end
402
+
403
+ # An error on the server occurred during the processing of your request.
404
+ # Try again later.
405
+ #
406
+ # @!attribute [rw] message
407
+ # @return [String]
408
+ #
409
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bcm-data-exports-2023-11-26/InternalServerException AWS API Documentation
410
+ #
411
+ class InternalServerException < Struct.new(
412
+ :message)
413
+ SENSITIVE = []
414
+ include Aws::Structure
415
+ end
416
+
417
+ # @!attribute [rw] export_arn
418
+ # The Amazon Resource Name (ARN) for this export.
419
+ # @return [String]
420
+ #
421
+ # @!attribute [rw] max_results
422
+ # The maximum number of objects that are returned for the request.
423
+ # @return [Integer]
424
+ #
425
+ # @!attribute [rw] next_token
426
+ # The token to retrieve the next set of results.
427
+ # @return [String]
428
+ #
429
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bcm-data-exports-2023-11-26/ListExecutionsRequest AWS API Documentation
430
+ #
431
+ class ListExecutionsRequest < Struct.new(
432
+ :export_arn,
433
+ :max_results,
434
+ :next_token)
435
+ SENSITIVE = []
436
+ include Aws::Structure
437
+ end
438
+
439
+ # @!attribute [rw] executions
440
+ # The list of executions.
441
+ # @return [Array<Types::ExecutionReference>]
442
+ #
443
+ # @!attribute [rw] next_token
444
+ # The token to retrieve the next set of results.
445
+ # @return [String]
446
+ #
447
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bcm-data-exports-2023-11-26/ListExecutionsResponse AWS API Documentation
448
+ #
449
+ class ListExecutionsResponse < Struct.new(
450
+ :executions,
451
+ :next_token)
452
+ SENSITIVE = []
453
+ include Aws::Structure
454
+ end
455
+
456
+ # @!attribute [rw] max_results
457
+ # The maximum number of objects that are returned for the request.
458
+ # @return [Integer]
459
+ #
460
+ # @!attribute [rw] next_token
461
+ # The token to retrieve the next set of results.
462
+ # @return [String]
463
+ #
464
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bcm-data-exports-2023-11-26/ListExportsRequest AWS API Documentation
465
+ #
466
+ class ListExportsRequest < Struct.new(
467
+ :max_results,
468
+ :next_token)
469
+ SENSITIVE = []
470
+ include Aws::Structure
471
+ end
472
+
473
+ # @!attribute [rw] exports
474
+ # The details of the exports, including name and export status.
475
+ # @return [Array<Types::ExportReference>]
476
+ #
477
+ # @!attribute [rw] next_token
478
+ # The token to retrieve the next set of results.
479
+ # @return [String]
480
+ #
481
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bcm-data-exports-2023-11-26/ListExportsResponse AWS API Documentation
482
+ #
483
+ class ListExportsResponse < Struct.new(
484
+ :exports,
485
+ :next_token)
486
+ SENSITIVE = []
487
+ include Aws::Structure
488
+ end
489
+
490
+ # @!attribute [rw] max_results
491
+ # The maximum number of objects that are returned for the request.
492
+ # @return [Integer]
493
+ #
494
+ # @!attribute [rw] next_token
495
+ # The token to retrieve the next set of results.
496
+ # @return [String]
497
+ #
498
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bcm-data-exports-2023-11-26/ListTablesRequest AWS API Documentation
499
+ #
500
+ class ListTablesRequest < Struct.new(
501
+ :max_results,
502
+ :next_token)
503
+ SENSITIVE = []
504
+ include Aws::Structure
505
+ end
506
+
507
+ # @!attribute [rw] next_token
508
+ # The token to retrieve the next set of results.
509
+ # @return [String]
510
+ #
511
+ # @!attribute [rw] tables
512
+ # The list of tables.
513
+ # @return [Array<Types::Table>]
514
+ #
515
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bcm-data-exports-2023-11-26/ListTablesResponse AWS API Documentation
516
+ #
517
+ class ListTablesResponse < Struct.new(
518
+ :next_token,
519
+ :tables)
520
+ SENSITIVE = []
521
+ include Aws::Structure
522
+ end
523
+
524
+ # @!attribute [rw] max_results
525
+ # The maximum number of objects that are returned for the request.
526
+ # @return [Integer]
527
+ #
528
+ # @!attribute [rw] next_token
529
+ # The token to retrieve the next set of results.
530
+ # @return [String]
531
+ #
532
+ # @!attribute [rw] resource_arn
533
+ # The unique identifier for the resource.
534
+ # @return [String]
535
+ #
536
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bcm-data-exports-2023-11-26/ListTagsForResourceRequest AWS API Documentation
537
+ #
538
+ class ListTagsForResourceRequest < Struct.new(
539
+ :max_results,
540
+ :next_token,
541
+ :resource_arn)
542
+ SENSITIVE = []
543
+ include Aws::Structure
544
+ end
545
+
546
+ # @!attribute [rw] next_token
547
+ # The token to retrieve the next set of results.
548
+ # @return [String]
549
+ #
550
+ # @!attribute [rw] resource_tags
551
+ # An optional list of tags to associate with the specified export.
552
+ # Each tag consists of a key and a value, and each key must be unique
553
+ # for the resource.
554
+ # @return [Array<Types::ResourceTag>]
555
+ #
556
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bcm-data-exports-2023-11-26/ListTagsForResourceResponse AWS API Documentation
557
+ #
558
+ class ListTagsForResourceResponse < Struct.new(
559
+ :next_token,
560
+ :resource_tags)
561
+ SENSITIVE = []
562
+ include Aws::Structure
563
+ end
564
+
565
+ # The cadence for Amazon Web Services to update the data export in your
566
+ # S3 bucket.
567
+ #
568
+ # @!attribute [rw] frequency
569
+ # The frequency that data exports are updated. The export refreshes
570
+ # each time the source data updates, up to three times daily.
571
+ # @return [String]
572
+ #
573
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bcm-data-exports-2023-11-26/RefreshCadence AWS API Documentation
574
+ #
575
+ class RefreshCadence < Struct.new(
576
+ :frequency)
577
+ SENSITIVE = []
578
+ include Aws::Structure
579
+ end
580
+
581
+ # The specified Amazon Resource Name (ARN) in the request doesn't
582
+ # exist.
583
+ #
584
+ # @!attribute [rw] message
585
+ # @return [String]
586
+ #
587
+ # @!attribute [rw] resource_id
588
+ # The identifier of the resource that was not found.
589
+ # @return [String]
590
+ #
591
+ # @!attribute [rw] resource_type
592
+ # The type of the resource that was not found.
593
+ # @return [String]
594
+ #
595
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bcm-data-exports-2023-11-26/ResourceNotFoundException AWS API Documentation
596
+ #
597
+ class ResourceNotFoundException < Struct.new(
598
+ :message,
599
+ :resource_id,
600
+ :resource_type)
601
+ SENSITIVE = []
602
+ include Aws::Structure
603
+ end
604
+
605
+ # The tag structure that contains a tag key and value.
606
+ #
607
+ # @!attribute [rw] key
608
+ # The key that's associated with the tag.
609
+ # @return [String]
610
+ #
611
+ # @!attribute [rw] value
612
+ # The value that's associated with the tag.
613
+ # @return [String]
614
+ #
615
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bcm-data-exports-2023-11-26/ResourceTag AWS API Documentation
616
+ #
617
+ class ResourceTag < Struct.new(
618
+ :key,
619
+ :value)
620
+ SENSITIVE = []
621
+ include Aws::Structure
622
+ end
623
+
624
+ # Describes the destination Amazon Simple Storage Service (Amazon S3)
625
+ # bucket name and object keys of a data exports file.
626
+ #
627
+ # @!attribute [rw] s3_bucket
628
+ # The name of the Amazon S3 bucket used as the destination of a data
629
+ # export file.
630
+ # @return [String]
631
+ #
632
+ # @!attribute [rw] s3_output_configurations
633
+ # The output configuration for the data export.
634
+ # @return [Types::S3OutputConfigurations]
635
+ #
636
+ # @!attribute [rw] s3_prefix
637
+ # The S3 path prefix you want prepended to the name of your data
638
+ # export.
639
+ # @return [String]
640
+ #
641
+ # @!attribute [rw] s3_region
642
+ # The S3 bucket Region.
643
+ # @return [String]
644
+ #
645
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bcm-data-exports-2023-11-26/S3Destination AWS API Documentation
646
+ #
647
+ class S3Destination < Struct.new(
648
+ :s3_bucket,
649
+ :s3_output_configurations,
650
+ :s3_prefix,
651
+ :s3_region)
652
+ SENSITIVE = []
653
+ include Aws::Structure
654
+ end
655
+
656
+ # The compression type, file format, and overwrite preference for the
657
+ # data export.
658
+ #
659
+ # @!attribute [rw] compression
660
+ # The compression type for the data export.
661
+ # @return [String]
662
+ #
663
+ # @!attribute [rw] format
664
+ # The file format for the data export.
665
+ # @return [String]
666
+ #
667
+ # @!attribute [rw] output_type
668
+ # The output type for the data export.
669
+ # @return [String]
670
+ #
671
+ # @!attribute [rw] overwrite
672
+ # The rule to follow when generating a version of the data export
673
+ # file. You have the choice to overwrite the previous version or to be
674
+ # delivered in addition to the previous versions. Overwriting exports
675
+ # can save on Amazon S3 storage costs. Creating new export versions
676
+ # allows you to track the changes in cost and usage data over time.
677
+ # @return [String]
678
+ #
679
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bcm-data-exports-2023-11-26/S3OutputConfigurations AWS API Documentation
680
+ #
681
+ class S3OutputConfigurations < Struct.new(
682
+ :compression,
683
+ :format,
684
+ :output_type,
685
+ :overwrite)
686
+ SENSITIVE = []
687
+ include Aws::Structure
688
+ end
689
+
690
+ # You've reached the limit on the number of resources you can create,
691
+ # or exceeded the size of an individual resource.
692
+ #
693
+ # @!attribute [rw] message
694
+ # @return [String]
695
+ #
696
+ # @!attribute [rw] quota_code
697
+ # The quota code that was exceeded.
698
+ # @return [String]
699
+ #
700
+ # @!attribute [rw] resource_id
701
+ # The identifier of the resource that exceeded quota.
702
+ # @return [String]
703
+ #
704
+ # @!attribute [rw] resource_type
705
+ # The type of the resource that exceeded quota.
706
+ # @return [String]
707
+ #
708
+ # @!attribute [rw] service_code
709
+ # The service code that exceeded quota. It will always be
710
+ # “AWSBillingAndCostManagementDataExports”.
711
+ # @return [String]
712
+ #
713
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bcm-data-exports-2023-11-26/ServiceQuotaExceededException AWS API Documentation
714
+ #
715
+ class ServiceQuotaExceededException < Struct.new(
716
+ :message,
717
+ :quota_code,
718
+ :resource_id,
719
+ :resource_type,
720
+ :service_code)
721
+ SENSITIVE = []
722
+ include Aws::Structure
723
+ end
724
+
725
+ # The details for the data export table.
726
+ #
727
+ # @!attribute [rw] description
728
+ # The description for the table.
729
+ # @return [String]
730
+ #
731
+ # @!attribute [rw] table_name
732
+ # The name of the table.
733
+ # @return [String]
734
+ #
735
+ # @!attribute [rw] table_properties
736
+ # The properties for the table.
737
+ # @return [Array<Types::TablePropertyDescription>]
738
+ #
739
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bcm-data-exports-2023-11-26/Table AWS API Documentation
740
+ #
741
+ class Table < Struct.new(
742
+ :description,
743
+ :table_name,
744
+ :table_properties)
745
+ SENSITIVE = []
746
+ include Aws::Structure
747
+ end
748
+
749
+ # The properties for the data export table.
750
+ #
751
+ # @!attribute [rw] default_value
752
+ # The default value for the table.
753
+ # @return [String]
754
+ #
755
+ # @!attribute [rw] description
756
+ # The description for the table.
757
+ # @return [String]
758
+ #
759
+ # @!attribute [rw] name
760
+ # The name of the table.
761
+ # @return [String]
762
+ #
763
+ # @!attribute [rw] valid_values
764
+ # The valid values for the table.
765
+ # @return [Array<String>]
766
+ #
767
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bcm-data-exports-2023-11-26/TablePropertyDescription AWS API Documentation
768
+ #
769
+ class TablePropertyDescription < Struct.new(
770
+ :default_value,
771
+ :description,
772
+ :name,
773
+ :valid_values)
774
+ SENSITIVE = []
775
+ include Aws::Structure
776
+ end
777
+
778
+ # @!attribute [rw] resource_arn
779
+ # The unique identifier for the resource.
780
+ # @return [String]
781
+ #
782
+ # @!attribute [rw] resource_tags
783
+ # The tags to associate with the resource. Each tag consists of a key
784
+ # and a value, and each key must be unique for the resource.
785
+ # @return [Array<Types::ResourceTag>]
786
+ #
787
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bcm-data-exports-2023-11-26/TagResourceRequest AWS API Documentation
788
+ #
789
+ class TagResourceRequest < Struct.new(
790
+ :resource_arn,
791
+ :resource_tags)
792
+ SENSITIVE = []
793
+ include Aws::Structure
794
+ end
795
+
796
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bcm-data-exports-2023-11-26/TagResourceResponse AWS API Documentation
797
+ #
798
+ class TagResourceResponse < Aws::EmptyStructure; end
799
+
800
+ # The request was denied due to request throttling.
801
+ #
802
+ # @!attribute [rw] message
803
+ # @return [String]
804
+ #
805
+ # @!attribute [rw] quota_code
806
+ # The quota code that exceeded the throttling limit.
807
+ # @return [String]
808
+ #
809
+ # @!attribute [rw] service_code
810
+ # The service code that exceeded the throttling limit. It will always
811
+ # be “AWSBillingAndCostManagementDataExports”.
812
+ # @return [String]
813
+ #
814
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bcm-data-exports-2023-11-26/ThrottlingException AWS API Documentation
815
+ #
816
+ class ThrottlingException < Struct.new(
817
+ :message,
818
+ :quota_code,
819
+ :service_code)
820
+ SENSITIVE = []
821
+ include Aws::Structure
822
+ end
823
+
824
+ # @!attribute [rw] resource_arn
825
+ # The unique identifier for the resource.
826
+ # @return [String]
827
+ #
828
+ # @!attribute [rw] resource_tag_keys
829
+ # The tag keys that are associated with the resource ARN.
830
+ # @return [Array<String>]
831
+ #
832
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bcm-data-exports-2023-11-26/UntagResourceRequest AWS API Documentation
833
+ #
834
+ class UntagResourceRequest < Struct.new(
835
+ :resource_arn,
836
+ :resource_tag_keys)
837
+ SENSITIVE = []
838
+ include Aws::Structure
839
+ end
840
+
841
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bcm-data-exports-2023-11-26/UntagResourceResponse AWS API Documentation
842
+ #
843
+ class UntagResourceResponse < Aws::EmptyStructure; end
844
+
845
+ # @!attribute [rw] export
846
+ # The name and query details for the export.
847
+ # @return [Types::Export]
848
+ #
849
+ # @!attribute [rw] export_arn
850
+ # The Amazon Resource Name (ARN) for this export.
851
+ # @return [String]
852
+ #
853
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bcm-data-exports-2023-11-26/UpdateExportRequest AWS API Documentation
854
+ #
855
+ class UpdateExportRequest < Struct.new(
856
+ :export,
857
+ :export_arn)
858
+ SENSITIVE = []
859
+ include Aws::Structure
860
+ end
861
+
862
+ # @!attribute [rw] export_arn
863
+ # The Amazon Resource Name (ARN) for this export.
864
+ # @return [String]
865
+ #
866
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bcm-data-exports-2023-11-26/UpdateExportResponse AWS API Documentation
867
+ #
868
+ class UpdateExportResponse < Struct.new(
869
+ :export_arn)
870
+ SENSITIVE = []
871
+ include Aws::Structure
872
+ end
873
+
874
+ # The input fails to satisfy the constraints specified by an Amazon Web
875
+ # Services service.
876
+ #
877
+ # @!attribute [rw] fields
878
+ # The list of fields that are invalid.
879
+ # @return [Array<Types::ValidationExceptionField>]
880
+ #
881
+ # @!attribute [rw] message
882
+ # @return [String]
883
+ #
884
+ # @!attribute [rw] reason
885
+ # The reason for the validation exception.
886
+ # @return [String]
887
+ #
888
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bcm-data-exports-2023-11-26/ValidationException AWS API Documentation
889
+ #
890
+ class ValidationException < Struct.new(
891
+ :fields,
892
+ :message,
893
+ :reason)
894
+ SENSITIVE = []
895
+ include Aws::Structure
896
+ end
897
+
898
+ # The input failed to meet the constraints specified by the Amazon Web
899
+ # Services service in a specified field.
900
+ #
901
+ # @!attribute [rw] message
902
+ # A message with the reason for the validation exception error.
903
+ # @return [String]
904
+ #
905
+ # @!attribute [rw] name
906
+ # The field name where the invalid entry was detected.
907
+ # @return [String]
908
+ #
909
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bcm-data-exports-2023-11-26/ValidationExceptionField AWS API Documentation
910
+ #
911
+ class ValidationExceptionField < Struct.new(
912
+ :message,
913
+ :name)
914
+ SENSITIVE = []
915
+ include Aws::Structure
916
+ end
917
+
918
+ end
919
+ end