aws-sdk-backupsearch 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,1468 @@
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::BackupSearch
11
+ module Types
12
+
13
+ # You do not have sufficient access to perform this action.
14
+ #
15
+ # @!attribute [rw] message
16
+ # User does not have sufficient access to perform this action.
17
+ # @return [String]
18
+ #
19
+ # @see http://docs.aws.amazon.com/goto/WebAPI/backupsearch-2018-05-10/AccessDeniedException AWS API Documentation
20
+ #
21
+ class AccessDeniedException < Struct.new(
22
+ :message)
23
+ SENSITIVE = []
24
+ include Aws::Structure
25
+ end
26
+
27
+ # This filters by recovery points within the CreatedAfter and
28
+ # CreatedBefore timestamps.
29
+ #
30
+ # @!attribute [rw] created_after
31
+ # This timestamp includes recovery points only created after the
32
+ # specified time.
33
+ # @return [Time]
34
+ #
35
+ # @!attribute [rw] created_before
36
+ # This timestamp includes recovery points only created before the
37
+ # specified time.
38
+ # @return [Time]
39
+ #
40
+ # @see http://docs.aws.amazon.com/goto/WebAPI/backupsearch-2018-05-10/BackupCreationTimeFilter AWS API Documentation
41
+ #
42
+ class BackupCreationTimeFilter < Struct.new(
43
+ :created_after,
44
+ :created_before)
45
+ SENSITIVE = []
46
+ include Aws::Structure
47
+ end
48
+
49
+ # This exception occurs when a conflict with a previous successful
50
+ # operation is detected. This generally occurs when the previous
51
+ # operation did not have time to propagate to the host serving the
52
+ # current request.
53
+ #
54
+ # A retry (with appropriate backoff logic) is the recommended response
55
+ # to this exception.
56
+ #
57
+ # @!attribute [rw] message
58
+ # Updating or deleting a resource can cause an inconsistent state.
59
+ # @return [String]
60
+ #
61
+ # @!attribute [rw] resource_id
62
+ # Identifier of the resource affected.
63
+ # @return [String]
64
+ #
65
+ # @!attribute [rw] resource_type
66
+ # Type of the resource affected.
67
+ # @return [String]
68
+ #
69
+ # @see http://docs.aws.amazon.com/goto/WebAPI/backupsearch-2018-05-10/ConflictException AWS API Documentation
70
+ #
71
+ class ConflictException < Struct.new(
72
+ :message,
73
+ :resource_id,
74
+ :resource_type)
75
+ SENSITIVE = []
76
+ include Aws::Structure
77
+ end
78
+
79
+ # This contains information results retrieved from a search job that may
80
+ # not have completed.
81
+ #
82
+ # @!attribute [rw] recovery_points_scanned_count
83
+ # This number is the sum of all backups that have been scanned so far
84
+ # during a search job.
85
+ # @return [Integer]
86
+ #
87
+ # @!attribute [rw] items_scanned_count
88
+ # This number is the sum of all items that have been scanned so far
89
+ # during a search job.
90
+ # @return [Integer]
91
+ #
92
+ # @!attribute [rw] items_matched_count
93
+ # This number is the sum of all items that match the item filters in a
94
+ # search job in progress.
95
+ # @return [Integer]
96
+ #
97
+ # @see http://docs.aws.amazon.com/goto/WebAPI/backupsearch-2018-05-10/CurrentSearchProgress AWS API Documentation
98
+ #
99
+ class CurrentSearchProgress < Struct.new(
100
+ :recovery_points_scanned_count,
101
+ :items_scanned_count,
102
+ :items_matched_count)
103
+ SENSITIVE = []
104
+ include Aws::Structure
105
+ end
106
+
107
+ # This contains arrays of objects, which may include CreationTimes time
108
+ # condition objects, FilePaths string objects, LastModificationTimes
109
+ # time condition objects,
110
+ #
111
+ # @!attribute [rw] file_paths
112
+ # You can include 1 to 10 values.
113
+ #
114
+ # If one file path is included, the results will return only items
115
+ # that match the file path.
116
+ #
117
+ # If more than one file path is included, the results will return all
118
+ # items that match any of the file paths.
119
+ # @return [Array<Types::StringCondition>]
120
+ #
121
+ # @!attribute [rw] sizes
122
+ # You can include 1 to 10 values.
123
+ #
124
+ # If one is included, the results will return only items that match.
125
+ #
126
+ # If more than one is included, the results will return all items that
127
+ # match any of the included values.
128
+ # @return [Array<Types::LongCondition>]
129
+ #
130
+ # @!attribute [rw] creation_times
131
+ # You can include 1 to 10 values.
132
+ #
133
+ # If one is included, the results will return only items that match.
134
+ #
135
+ # If more than one is included, the results will return all items that
136
+ # match any of the included values.
137
+ # @return [Array<Types::TimeCondition>]
138
+ #
139
+ # @!attribute [rw] last_modification_times
140
+ # You can include 1 to 10 values.
141
+ #
142
+ # If one is included, the results will return only items that match.
143
+ #
144
+ # If more than one is included, the results will return all items that
145
+ # match any of the included values.
146
+ # @return [Array<Types::TimeCondition>]
147
+ #
148
+ # @see http://docs.aws.amazon.com/goto/WebAPI/backupsearch-2018-05-10/EBSItemFilter AWS API Documentation
149
+ #
150
+ class EBSItemFilter < Struct.new(
151
+ :file_paths,
152
+ :sizes,
153
+ :creation_times,
154
+ :last_modification_times)
155
+ SENSITIVE = []
156
+ include Aws::Structure
157
+ end
158
+
159
+ # These are the items returned in the results of a search of Amazon EBS
160
+ # backup metadata.
161
+ #
162
+ # @!attribute [rw] backup_resource_arn
163
+ # These are one or more items in the results that match values for the
164
+ # Amazon Resource Name (ARN) of recovery points returned in a search
165
+ # of Amazon EBS backup metadata.
166
+ # @return [String]
167
+ #
168
+ # @!attribute [rw] source_resource_arn
169
+ # These are one or more items in the results that match values for the
170
+ # Amazon Resource Name (ARN) of source resources returned in a search
171
+ # of Amazon EBS backup metadata.
172
+ # @return [String]
173
+ #
174
+ # @!attribute [rw] backup_vault_name
175
+ # The name of the backup vault.
176
+ # @return [String]
177
+ #
178
+ # @!attribute [rw] file_system_identifier
179
+ # These are one or more items in the results that match values for
180
+ # file systems returned in a search of Amazon EBS backup metadata.
181
+ # @return [String]
182
+ #
183
+ # @!attribute [rw] file_path
184
+ # These are one or more items in the results that match values for
185
+ # file paths returned in a search of Amazon EBS backup metadata.
186
+ # @return [String]
187
+ #
188
+ # @!attribute [rw] file_size
189
+ # These are one or more items in the results that match values for
190
+ # file sizes returned in a search of Amazon EBS backup metadata.
191
+ # @return [Integer]
192
+ #
193
+ # @!attribute [rw] creation_time
194
+ # These are one or more items in the results that match values for
195
+ # creation times returned in a search of Amazon EBS backup metadata.
196
+ # @return [Time]
197
+ #
198
+ # @!attribute [rw] last_modified_time
199
+ # These are one or more items in the results that match values for
200
+ # Last Modified Time returned in a search of Amazon EBS backup
201
+ # metadata.
202
+ # @return [Time]
203
+ #
204
+ # @see http://docs.aws.amazon.com/goto/WebAPI/backupsearch-2018-05-10/EBSResultItem AWS API Documentation
205
+ #
206
+ class EBSResultItem < Struct.new(
207
+ :backup_resource_arn,
208
+ :source_resource_arn,
209
+ :backup_vault_name,
210
+ :file_system_identifier,
211
+ :file_path,
212
+ :file_size,
213
+ :creation_time,
214
+ :last_modified_time)
215
+ SENSITIVE = [:file_path]
216
+ include Aws::Structure
217
+ end
218
+
219
+ # This is the summary of an export job.
220
+ #
221
+ # @!attribute [rw] export_job_identifier
222
+ # This is the unique string that identifies a specific export job.
223
+ # @return [String]
224
+ #
225
+ # @!attribute [rw] export_job_arn
226
+ # This is the unique ARN (Amazon Resource Name) that belongs to the
227
+ # new export job.
228
+ # @return [String]
229
+ #
230
+ # @!attribute [rw] status
231
+ # The status of the export job is one of the following:
232
+ #
233
+ # `CREATED`; `RUNNING`; `FAILED`; or `COMPLETED`.
234
+ # @return [String]
235
+ #
236
+ # @!attribute [rw] creation_time
237
+ # This is a timestamp of the time the export job was created.
238
+ # @return [Time]
239
+ #
240
+ # @!attribute [rw] completion_time
241
+ # This is a timestamp of the time the export job compeleted.
242
+ # @return [Time]
243
+ #
244
+ # @!attribute [rw] status_message
245
+ # A status message is a string that is returned for an export job.
246
+ #
247
+ # A status message is included for any status other than `COMPLETED`
248
+ # without issues.
249
+ # @return [String]
250
+ #
251
+ # @!attribute [rw] search_job_arn
252
+ # The unique string that identifies the Amazon Resource Name (ARN) of
253
+ # the specified search job.
254
+ # @return [String]
255
+ #
256
+ # @see http://docs.aws.amazon.com/goto/WebAPI/backupsearch-2018-05-10/ExportJobSummary AWS API Documentation
257
+ #
258
+ class ExportJobSummary < Struct.new(
259
+ :export_job_identifier,
260
+ :export_job_arn,
261
+ :status,
262
+ :creation_time,
263
+ :completion_time,
264
+ :status_message,
265
+ :search_job_arn)
266
+ SENSITIVE = []
267
+ include Aws::Structure
268
+ end
269
+
270
+ # This contains the export specification object.
271
+ #
272
+ # @note ExportSpecification is a union - when making an API calls you must set exactly one of the members.
273
+ #
274
+ # @note ExportSpecification is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of ExportSpecification corresponding to the set member.
275
+ #
276
+ # @!attribute [rw] s3_export_specification
277
+ # This specifies the destination Amazon S3 bucket for the export job.
278
+ # And, if included, it also specifies the destination prefix.
279
+ # @return [Types::S3ExportSpecification]
280
+ #
281
+ # @see http://docs.aws.amazon.com/goto/WebAPI/backupsearch-2018-05-10/ExportSpecification AWS API Documentation
282
+ #
283
+ class ExportSpecification < Struct.new(
284
+ :s3_export_specification,
285
+ :unknown)
286
+ SENSITIVE = []
287
+ include Aws::Structure
288
+ include Aws::Structure::Union
289
+
290
+ class S3ExportSpecification < ExportSpecification; end
291
+ class Unknown < ExportSpecification; end
292
+ end
293
+
294
+ # @!attribute [rw] search_job_identifier
295
+ # Required unique string that specifies the search job.
296
+ # @return [String]
297
+ #
298
+ # @see http://docs.aws.amazon.com/goto/WebAPI/backupsearch-2018-05-10/GetSearchJobInput AWS API Documentation
299
+ #
300
+ class GetSearchJobInput < Struct.new(
301
+ :search_job_identifier)
302
+ SENSITIVE = []
303
+ include Aws::Structure
304
+ end
305
+
306
+ # @!attribute [rw] name
307
+ # Returned name of the specified search job.
308
+ # @return [String]
309
+ #
310
+ # @!attribute [rw] search_scope_summary
311
+ # Returned summary of the specified search job scope, including:
312
+ #
313
+ # * TotalBackupsToScanCount, the number of recovery points returned by
314
+ # the search.
315
+ #
316
+ # * TotalItemsToScanCount, the number of items returned by the search.
317
+ # @return [Types::SearchScopeSummary]
318
+ #
319
+ # @!attribute [rw] current_search_progress
320
+ # Returns numbers representing BackupsScannedCount, ItemsScanned, and
321
+ # ItemsMatched.
322
+ # @return [Types::CurrentSearchProgress]
323
+ #
324
+ # @!attribute [rw] status_message
325
+ # A status message will be returned for either a earch job with a
326
+ # status of `ERRORED` or a status of `COMPLETED` jobs with issues.
327
+ #
328
+ # For example, a message may say that a search contained recovery
329
+ # points unable to be scanned because of a permissions issue.
330
+ # @return [String]
331
+ #
332
+ # @!attribute [rw] encryption_key_arn
333
+ # The encryption key for the specified search job.
334
+ #
335
+ # Example:
336
+ # `arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`.
337
+ # @return [String]
338
+ #
339
+ # @!attribute [rw] completion_time
340
+ # The date and time that a search job completed, in Unix format and
341
+ # Coordinated Universal Time (UTC). The value of `CompletionTime` is
342
+ # accurate to milliseconds. For example, the value 1516925490.087
343
+ # represents Friday, January 26, 2018 12:11:30.087 AM.
344
+ # @return [Time]
345
+ #
346
+ # @!attribute [rw] status
347
+ # The current status of the specified search job.
348
+ #
349
+ # A search job may have one of the following statuses: `RUNNING`;
350
+ # `COMPLETED`; `STOPPED`; `FAILED`; `TIMED_OUT`; or `EXPIRED` .
351
+ # @return [String]
352
+ #
353
+ # @!attribute [rw] search_scope
354
+ # The search scope is all backup properties input into a search.
355
+ # @return [Types::SearchScope]
356
+ #
357
+ # @!attribute [rw] item_filters
358
+ # Item Filters represent all input item properties specified when the
359
+ # search was created.
360
+ # @return [Types::ItemFilters]
361
+ #
362
+ # @!attribute [rw] creation_time
363
+ # The date and time that a search job was created, in Unix format and
364
+ # Coordinated Universal Time (UTC). The value of `CompletionTime` is
365
+ # accurate to milliseconds. For example, the value 1516925490.087
366
+ # represents Friday, January 26, 2018 12:11:30.087 AM.
367
+ # @return [Time]
368
+ #
369
+ # @!attribute [rw] search_job_identifier
370
+ # The unique string that identifies the specified search job.
371
+ # @return [String]
372
+ #
373
+ # @!attribute [rw] search_job_arn
374
+ # The unique string that identifies the Amazon Resource Name (ARN) of
375
+ # the specified search job.
376
+ # @return [String]
377
+ #
378
+ # @see http://docs.aws.amazon.com/goto/WebAPI/backupsearch-2018-05-10/GetSearchJobOutput AWS API Documentation
379
+ #
380
+ class GetSearchJobOutput < Struct.new(
381
+ :name,
382
+ :search_scope_summary,
383
+ :current_search_progress,
384
+ :status_message,
385
+ :encryption_key_arn,
386
+ :completion_time,
387
+ :status,
388
+ :search_scope,
389
+ :item_filters,
390
+ :creation_time,
391
+ :search_job_identifier,
392
+ :search_job_arn)
393
+ SENSITIVE = []
394
+ include Aws::Structure
395
+ end
396
+
397
+ # @!attribute [rw] export_job_identifier
398
+ # This is the unique string that identifies a specific export job.
399
+ #
400
+ # Required for this operation.
401
+ # @return [String]
402
+ #
403
+ # @see http://docs.aws.amazon.com/goto/WebAPI/backupsearch-2018-05-10/GetSearchResultExportJobInput AWS API Documentation
404
+ #
405
+ class GetSearchResultExportJobInput < Struct.new(
406
+ :export_job_identifier)
407
+ SENSITIVE = []
408
+ include Aws::Structure
409
+ end
410
+
411
+ # @!attribute [rw] export_job_identifier
412
+ # This is the unique string that identifies the specified export job.
413
+ # @return [String]
414
+ #
415
+ # @!attribute [rw] export_job_arn
416
+ # The unique Amazon Resource Name (ARN) that uniquely identifies the
417
+ # export job.
418
+ # @return [String]
419
+ #
420
+ # @!attribute [rw] status
421
+ # This is the current status of the export job.
422
+ # @return [String]
423
+ #
424
+ # @!attribute [rw] creation_time
425
+ # The date and time that an export job was created, in Unix format and
426
+ # Coordinated Universal Time (UTC). The value of `CreationTime` is
427
+ # accurate to milliseconds. For example, the value 1516925490.087
428
+ # represents Friday, January 26, 2018 12:11:30.087 AM.
429
+ # @return [Time]
430
+ #
431
+ # @!attribute [rw] completion_time
432
+ # The date and time that an export job completed, in Unix format and
433
+ # Coordinated Universal Time (UTC). The value of `CreationTime` is
434
+ # accurate to milliseconds. For example, the value 1516925490.087
435
+ # represents Friday, January 26, 2018 12:11:30.087 AM.
436
+ # @return [Time]
437
+ #
438
+ # @!attribute [rw] status_message
439
+ # A status message is a string that is returned for search job with a
440
+ # status of `FAILED`, along with steps to remedy and retry the
441
+ # operation.
442
+ # @return [String]
443
+ #
444
+ # @!attribute [rw] export_specification
445
+ # The export specification consists of the destination S3 bucket to
446
+ # which the search results were exported, along with the destination
447
+ # prefix.
448
+ # @return [Types::ExportSpecification]
449
+ #
450
+ # @!attribute [rw] search_job_arn
451
+ # The unique string that identifies the Amazon Resource Name (ARN) of
452
+ # the specified search job.
453
+ # @return [String]
454
+ #
455
+ # @see http://docs.aws.amazon.com/goto/WebAPI/backupsearch-2018-05-10/GetSearchResultExportJobOutput AWS API Documentation
456
+ #
457
+ class GetSearchResultExportJobOutput < Struct.new(
458
+ :export_job_identifier,
459
+ :export_job_arn,
460
+ :status,
461
+ :creation_time,
462
+ :completion_time,
463
+ :status_message,
464
+ :export_specification,
465
+ :search_job_arn)
466
+ SENSITIVE = []
467
+ include Aws::Structure
468
+ end
469
+
470
+ # An internal server error occurred. Retry your request.
471
+ #
472
+ # @!attribute [rw] message
473
+ # Unexpected error during processing of request.
474
+ # @return [String]
475
+ #
476
+ # @!attribute [rw] retry_after_seconds
477
+ # Retry the call after number of seconds.
478
+ # @return [Integer]
479
+ #
480
+ # @see http://docs.aws.amazon.com/goto/WebAPI/backupsearch-2018-05-10/InternalServerException AWS API Documentation
481
+ #
482
+ class InternalServerException < Struct.new(
483
+ :message,
484
+ :retry_after_seconds)
485
+ SENSITIVE = []
486
+ include Aws::Structure
487
+ end
488
+
489
+ # Item Filters represent all input item properties specified when the
490
+ # search was created.
491
+ #
492
+ # Contains either EBSItemFilters or S3ItemFilters
493
+ #
494
+ # @!attribute [rw] s3_item_filters
495
+ # This array can contain CreationTimes, ETags, ObjectKeys, Sizes, or
496
+ # VersionIds objects.
497
+ # @return [Array<Types::S3ItemFilter>]
498
+ #
499
+ # @!attribute [rw] ebs_item_filters
500
+ # This array can contain CreationTimes, FilePaths,
501
+ # LastModificationTimes, or Sizes objects.
502
+ # @return [Array<Types::EBSItemFilter>]
503
+ #
504
+ # @see http://docs.aws.amazon.com/goto/WebAPI/backupsearch-2018-05-10/ItemFilters AWS API Documentation
505
+ #
506
+ class ItemFilters < Struct.new(
507
+ :s3_item_filters,
508
+ :ebs_item_filters)
509
+ SENSITIVE = []
510
+ include Aws::Structure
511
+ end
512
+
513
+ # @!attribute [rw] search_job_identifier
514
+ # The unique string that specifies the search job.
515
+ # @return [String]
516
+ #
517
+ # @!attribute [rw] next_token
518
+ # The next item following a partial list of returned backups included
519
+ # in a search job.
520
+ #
521
+ # For example, if a request is made to return `MaxResults` number of
522
+ # backups, `NextToken` allows you to return more items in your list
523
+ # starting at the location pointed to by the next token.
524
+ # @return [String]
525
+ #
526
+ # @!attribute [rw] max_results
527
+ # The maximum number of resource list items to be returned.
528
+ # @return [Integer]
529
+ #
530
+ # @see http://docs.aws.amazon.com/goto/WebAPI/backupsearch-2018-05-10/ListSearchJobBackupsInput AWS API Documentation
531
+ #
532
+ class ListSearchJobBackupsInput < Struct.new(
533
+ :search_job_identifier,
534
+ :next_token,
535
+ :max_results)
536
+ SENSITIVE = []
537
+ include Aws::Structure
538
+ end
539
+
540
+ # @!attribute [rw] results
541
+ # The recovery points returned the results of a search job
542
+ # @return [Array<Types::SearchJobBackupsResult>]
543
+ #
544
+ # @!attribute [rw] next_token
545
+ # The next item following a partial list of returned backups included
546
+ # in a search job.
547
+ #
548
+ # For example, if a request is made to return `MaxResults` number of
549
+ # backups, `NextToken` allows you to return more items in your list
550
+ # starting at the location pointed to by the next token.
551
+ # @return [String]
552
+ #
553
+ # @see http://docs.aws.amazon.com/goto/WebAPI/backupsearch-2018-05-10/ListSearchJobBackupsOutput AWS API Documentation
554
+ #
555
+ class ListSearchJobBackupsOutput < Struct.new(
556
+ :results,
557
+ :next_token)
558
+ SENSITIVE = []
559
+ include Aws::Structure
560
+ end
561
+
562
+ # @!attribute [rw] search_job_identifier
563
+ # The unique string that specifies the search job.
564
+ # @return [String]
565
+ #
566
+ # @!attribute [rw] next_token
567
+ # The next item following a partial list of returned search job
568
+ # results.
569
+ #
570
+ # For example, if a request is made to return `MaxResults` number of
571
+ # search job results, `NextToken` allows you to return more items in
572
+ # your list starting at the location pointed to by the next token.
573
+ # @return [String]
574
+ #
575
+ # @!attribute [rw] max_results
576
+ # The maximum number of resource list items to be returned.
577
+ # @return [Integer]
578
+ #
579
+ # @see http://docs.aws.amazon.com/goto/WebAPI/backupsearch-2018-05-10/ListSearchJobResultsInput AWS API Documentation
580
+ #
581
+ class ListSearchJobResultsInput < Struct.new(
582
+ :search_job_identifier,
583
+ :next_token,
584
+ :max_results)
585
+ SENSITIVE = []
586
+ include Aws::Structure
587
+ end
588
+
589
+ # @!attribute [rw] results
590
+ # The results consist of either EBSResultItem or S3ResultItem.
591
+ # @return [Array<Types::ResultItem>]
592
+ #
593
+ # @!attribute [rw] next_token
594
+ # The next item following a partial list of search job results.
595
+ #
596
+ # For example, if a request is made to return `MaxResults` number of
597
+ # backups, `NextToken` allows you to return more items in your list
598
+ # starting at the location pointed to by the next token.
599
+ # @return [String]
600
+ #
601
+ # @see http://docs.aws.amazon.com/goto/WebAPI/backupsearch-2018-05-10/ListSearchJobResultsOutput AWS API Documentation
602
+ #
603
+ class ListSearchJobResultsOutput < Struct.new(
604
+ :results,
605
+ :next_token)
606
+ SENSITIVE = []
607
+ include Aws::Structure
608
+ end
609
+
610
+ # @!attribute [rw] by_status
611
+ # Include this parameter to filter list by search job status.
612
+ # @return [String]
613
+ #
614
+ # @!attribute [rw] next_token
615
+ # The next item following a partial list of returned search jobs.
616
+ #
617
+ # For example, if a request is made to return `MaxResults` number of
618
+ # backups, `NextToken` allows you to return more items in your list
619
+ # starting at the location pointed to by the next token.
620
+ # @return [String]
621
+ #
622
+ # @!attribute [rw] max_results
623
+ # The maximum number of resource list items to be returned.
624
+ # @return [Integer]
625
+ #
626
+ # @see http://docs.aws.amazon.com/goto/WebAPI/backupsearch-2018-05-10/ListSearchJobsInput AWS API Documentation
627
+ #
628
+ class ListSearchJobsInput < Struct.new(
629
+ :by_status,
630
+ :next_token,
631
+ :max_results)
632
+ SENSITIVE = []
633
+ include Aws::Structure
634
+ end
635
+
636
+ # @!attribute [rw] search_jobs
637
+ # The search jobs among the list, with details of the returned search
638
+ # jobs.
639
+ # @return [Array<Types::SearchJobSummary>]
640
+ #
641
+ # @!attribute [rw] next_token
642
+ # The next item following a partial list of returned backups included
643
+ # in a search job.
644
+ #
645
+ # For example, if a request is made to return `MaxResults` number of
646
+ # backups, `NextToken` allows you to return more items in your list
647
+ # starting at the location pointed to by the next token.
648
+ # @return [String]
649
+ #
650
+ # @see http://docs.aws.amazon.com/goto/WebAPI/backupsearch-2018-05-10/ListSearchJobsOutput AWS API Documentation
651
+ #
652
+ class ListSearchJobsOutput < Struct.new(
653
+ :search_jobs,
654
+ :next_token)
655
+ SENSITIVE = []
656
+ include Aws::Structure
657
+ end
658
+
659
+ # @!attribute [rw] status
660
+ # The search jobs to be included in the export job can be filtered by
661
+ # including this parameter.
662
+ # @return [String]
663
+ #
664
+ # @!attribute [rw] search_job_identifier
665
+ # The unique string that specifies the search job.
666
+ # @return [String]
667
+ #
668
+ # @!attribute [rw] next_token
669
+ # The next item following a partial list of returned backups included
670
+ # in a search job.
671
+ #
672
+ # For example, if a request is made to return `MaxResults` number of
673
+ # backups, `NextToken` allows you to return more items in your list
674
+ # starting at the location pointed to by the next token.
675
+ # @return [String]
676
+ #
677
+ # @!attribute [rw] max_results
678
+ # The maximum number of resource list items to be returned.
679
+ # @return [Integer]
680
+ #
681
+ # @see http://docs.aws.amazon.com/goto/WebAPI/backupsearch-2018-05-10/ListSearchResultExportJobsInput AWS API Documentation
682
+ #
683
+ class ListSearchResultExportJobsInput < Struct.new(
684
+ :status,
685
+ :search_job_identifier,
686
+ :next_token,
687
+ :max_results)
688
+ SENSITIVE = []
689
+ include Aws::Structure
690
+ end
691
+
692
+ # @!attribute [rw] export_jobs
693
+ # The operation returns the included export jobs.
694
+ # @return [Array<Types::ExportJobSummary>]
695
+ #
696
+ # @!attribute [rw] next_token
697
+ # The next item following a partial list of returned backups included
698
+ # in a search job.
699
+ #
700
+ # For example, if a request is made to return `MaxResults` number of
701
+ # backups, `NextToken` allows you to return more items in your list
702
+ # starting at the location pointed to by the next token.
703
+ # @return [String]
704
+ #
705
+ # @see http://docs.aws.amazon.com/goto/WebAPI/backupsearch-2018-05-10/ListSearchResultExportJobsOutput AWS API Documentation
706
+ #
707
+ class ListSearchResultExportJobsOutput < Struct.new(
708
+ :export_jobs,
709
+ :next_token)
710
+ SENSITIVE = []
711
+ include Aws::Structure
712
+ end
713
+
714
+ # @!attribute [rw] resource_arn
715
+ # The Amazon Resource Name (ARN) that uniquely identifies the
716
+ # resource.&gt;
717
+ # @return [String]
718
+ #
719
+ # @see http://docs.aws.amazon.com/goto/WebAPI/backupsearch-2018-05-10/ListTagsForResourceRequest AWS API Documentation
720
+ #
721
+ class ListTagsForResourceRequest < Struct.new(
722
+ :resource_arn)
723
+ SENSITIVE = []
724
+ include Aws::Structure
725
+ end
726
+
727
+ # @!attribute [rw] tags
728
+ # List of tags returned by the operation.
729
+ # @return [Hash<String,String>]
730
+ #
731
+ # @see http://docs.aws.amazon.com/goto/WebAPI/backupsearch-2018-05-10/ListTagsForResourceResponse AWS API Documentation
732
+ #
733
+ class ListTagsForResourceResponse < Struct.new(
734
+ :tags)
735
+ SENSITIVE = []
736
+ include Aws::Structure
737
+ end
738
+
739
+ # The long condition contains a `Value` and can optionally contain an
740
+ # `Operator`.
741
+ #
742
+ # @!attribute [rw] value
743
+ # The value of an item included in one of the search item filters.
744
+ # @return [Integer]
745
+ #
746
+ # @!attribute [rw] operator
747
+ # A string that defines what values will be returned.
748
+ #
749
+ # If this is included, avoid combinations of operators that will
750
+ # return all possible values. For example, including both `EQUALS_TO`
751
+ # and `NOT_EQUALS_TO` with a value of `4` will return all values.
752
+ # @return [String]
753
+ #
754
+ # @see http://docs.aws.amazon.com/goto/WebAPI/backupsearch-2018-05-10/LongCondition AWS API Documentation
755
+ #
756
+ class LongCondition < Struct.new(
757
+ :value,
758
+ :operator)
759
+ SENSITIVE = []
760
+ include Aws::Structure
761
+ end
762
+
763
+ # The resource was not found for this request.
764
+ #
765
+ # Confirm the resource information, such as the ARN or type is correct
766
+ # and exists, then retry the request.
767
+ #
768
+ # @!attribute [rw] message
769
+ # Request references a resource which does not exist.
770
+ # @return [String]
771
+ #
772
+ # @!attribute [rw] resource_id
773
+ # Hypothetical identifier of the resource affected.
774
+ # @return [String]
775
+ #
776
+ # @!attribute [rw] resource_type
777
+ # Hypothetical type of the resource affected.
778
+ # @return [String]
779
+ #
780
+ # @see http://docs.aws.amazon.com/goto/WebAPI/backupsearch-2018-05-10/ResourceNotFoundException AWS API Documentation
781
+ #
782
+ class ResourceNotFoundException < Struct.new(
783
+ :message,
784
+ :resource_id,
785
+ :resource_type)
786
+ SENSITIVE = []
787
+ include Aws::Structure
788
+ end
789
+
790
+ # This is an object representing the item returned in the results of a
791
+ # search for a specific resource type.
792
+ #
793
+ # @note ResultItem is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of ResultItem corresponding to the set member.
794
+ #
795
+ # @!attribute [rw] s3_result_item
796
+ # These are items returned in the search results of an Amazon S3
797
+ # search.
798
+ # @return [Types::S3ResultItem]
799
+ #
800
+ # @!attribute [rw] ebs_result_item
801
+ # These are items returned in the search results of an Amazon EBS
802
+ # search.
803
+ # @return [Types::EBSResultItem]
804
+ #
805
+ # @see http://docs.aws.amazon.com/goto/WebAPI/backupsearch-2018-05-10/ResultItem AWS API Documentation
806
+ #
807
+ class ResultItem < Struct.new(
808
+ :s3_result_item,
809
+ :ebs_result_item,
810
+ :unknown)
811
+ SENSITIVE = []
812
+ include Aws::Structure
813
+ include Aws::Structure::Union
814
+
815
+ class S3ResultItem < ResultItem; end
816
+ class EbsResultItem < ResultItem; end
817
+ class Unknown < ResultItem; end
818
+ end
819
+
820
+ # This specification contains a required string of the destination
821
+ # bucket; optionally, you can include the destination prefix.
822
+ #
823
+ # @!attribute [rw] destination_bucket
824
+ # This specifies the destination Amazon S3 bucket for the export job.
825
+ # @return [String]
826
+ #
827
+ # @!attribute [rw] destination_prefix
828
+ # This specifies the prefix for the destination Amazon S3 bucket for
829
+ # the export job.
830
+ # @return [String]
831
+ #
832
+ # @see http://docs.aws.amazon.com/goto/WebAPI/backupsearch-2018-05-10/S3ExportSpecification AWS API Documentation
833
+ #
834
+ class S3ExportSpecification < Struct.new(
835
+ :destination_bucket,
836
+ :destination_prefix)
837
+ SENSITIVE = []
838
+ include Aws::Structure
839
+ end
840
+
841
+ # This contains arrays of objects, which may include ObjectKeys, Sizes,
842
+ # CreationTimes, VersionIds, and/or Etags.
843
+ #
844
+ # @!attribute [rw] object_keys
845
+ # You can include 1 to 10 values.
846
+ #
847
+ # If one value is included, the results will return only items that
848
+ # match the value.
849
+ #
850
+ # If more than one value is included, the results will return all
851
+ # items that match any of the values.
852
+ # @return [Array<Types::StringCondition>]
853
+ #
854
+ # @!attribute [rw] sizes
855
+ # You can include 1 to 10 values.
856
+ #
857
+ # If one value is included, the results will return only items that
858
+ # match the value.
859
+ #
860
+ # If more than one value is included, the results will return all
861
+ # items that match any of the values.
862
+ # @return [Array<Types::LongCondition>]
863
+ #
864
+ # @!attribute [rw] creation_times
865
+ # You can include 1 to 10 values.
866
+ #
867
+ # If one value is included, the results will return only items that
868
+ # match the value.
869
+ #
870
+ # If more than one value is included, the results will return all
871
+ # items that match any of the values.
872
+ # @return [Array<Types::TimeCondition>]
873
+ #
874
+ # @!attribute [rw] version_ids
875
+ # You can include 1 to 10 values.
876
+ #
877
+ # If one value is included, the results will return only items that
878
+ # match the value.
879
+ #
880
+ # If more than one value is included, the results will return all
881
+ # items that match any of the values.
882
+ # @return [Array<Types::StringCondition>]
883
+ #
884
+ # @!attribute [rw] etags
885
+ # You can include 1 to 10 values.
886
+ #
887
+ # If one value is included, the results will return only items that
888
+ # match the value.
889
+ #
890
+ # If more than one value is included, the results will return all
891
+ # items that match any of the values.
892
+ # @return [Array<Types::StringCondition>]
893
+ #
894
+ # @see http://docs.aws.amazon.com/goto/WebAPI/backupsearch-2018-05-10/S3ItemFilter AWS API Documentation
895
+ #
896
+ class S3ItemFilter < Struct.new(
897
+ :object_keys,
898
+ :sizes,
899
+ :creation_times,
900
+ :version_ids,
901
+ :etags)
902
+ SENSITIVE = []
903
+ include Aws::Structure
904
+ end
905
+
906
+ # These are the items returned in the results of a search of Amazon S3
907
+ # backup metadata.
908
+ #
909
+ # @!attribute [rw] backup_resource_arn
910
+ # These are items in the returned results that match recovery point
911
+ # Amazon Resource Names (ARN) input during a search of Amazon S3
912
+ # backup metadata.
913
+ # @return [String]
914
+ #
915
+ # @!attribute [rw] source_resource_arn
916
+ # These are items in the returned results that match source Amazon
917
+ # Resource Names (ARN) input during a search of Amazon S3 backup
918
+ # metadata.
919
+ # @return [String]
920
+ #
921
+ # @!attribute [rw] backup_vault_name
922
+ # The name of the backup vault.
923
+ # @return [String]
924
+ #
925
+ # @!attribute [rw] object_key
926
+ # This is one or more items returned in the results of a search of
927
+ # Amazon S3 backup metadata that match the values input for object
928
+ # key.
929
+ # @return [String]
930
+ #
931
+ # @!attribute [rw] object_size
932
+ # These are items in the returned results that match values for object
933
+ # size(s) input during a search of Amazon S3 backup metadata.
934
+ # @return [Integer]
935
+ #
936
+ # @!attribute [rw] creation_time
937
+ # These are one or more items in the returned results that match
938
+ # values for item creation time input during a search of Amazon S3
939
+ # backup metadata.
940
+ # @return [Time]
941
+ #
942
+ # @!attribute [rw] etag
943
+ # These are one or more items in the returned results that match
944
+ # values for ETags input during a search of Amazon S3 backup metadata.
945
+ # @return [String]
946
+ #
947
+ # @!attribute [rw] version_id
948
+ # These are one or more items in the returned results that match
949
+ # values for version IDs input during a search of Amazon S3 backup
950
+ # metadata.
951
+ # @return [String]
952
+ #
953
+ # @see http://docs.aws.amazon.com/goto/WebAPI/backupsearch-2018-05-10/S3ResultItem AWS API Documentation
954
+ #
955
+ class S3ResultItem < Struct.new(
956
+ :backup_resource_arn,
957
+ :source_resource_arn,
958
+ :backup_vault_name,
959
+ :object_key,
960
+ :object_size,
961
+ :creation_time,
962
+ :etag,
963
+ :version_id)
964
+ SENSITIVE = [:object_key]
965
+ include Aws::Structure
966
+ end
967
+
968
+ # This contains the information about recovery points returned in
969
+ # results of a search job.
970
+ #
971
+ # @!attribute [rw] status
972
+ # This is the status of the search job backup result.
973
+ # @return [String]
974
+ #
975
+ # @!attribute [rw] status_message
976
+ # This is the status message included with the results.
977
+ # @return [String]
978
+ #
979
+ # @!attribute [rw] resource_type
980
+ # This is the resource type of the search.
981
+ # @return [String]
982
+ #
983
+ # @!attribute [rw] backup_resource_arn
984
+ # The Amazon Resource Name (ARN) that uniquely identifies the backup
985
+ # resources.
986
+ # @return [String]
987
+ #
988
+ # @!attribute [rw] source_resource_arn
989
+ # The Amazon Resource Name (ARN) that uniquely identifies the source
990
+ # resources.
991
+ # @return [String]
992
+ #
993
+ # @!attribute [rw] index_creation_time
994
+ # This is the creation time of the backup index.
995
+ # @return [Time]
996
+ #
997
+ # @!attribute [rw] backup_creation_time
998
+ # This is the creation time of the backup (recovery point).
999
+ # @return [Time]
1000
+ #
1001
+ # @see http://docs.aws.amazon.com/goto/WebAPI/backupsearch-2018-05-10/SearchJobBackupsResult AWS API Documentation
1002
+ #
1003
+ class SearchJobBackupsResult < Struct.new(
1004
+ :status,
1005
+ :status_message,
1006
+ :resource_type,
1007
+ :backup_resource_arn,
1008
+ :source_resource_arn,
1009
+ :index_creation_time,
1010
+ :backup_creation_time)
1011
+ SENSITIVE = []
1012
+ include Aws::Structure
1013
+ end
1014
+
1015
+ # This is information pertaining to a search job.
1016
+ #
1017
+ # @!attribute [rw] search_job_identifier
1018
+ # The unique string that specifies the search job.
1019
+ # @return [String]
1020
+ #
1021
+ # @!attribute [rw] search_job_arn
1022
+ # The unique string that identifies the Amazon Resource Name (ARN) of
1023
+ # the specified search job.
1024
+ # @return [String]
1025
+ #
1026
+ # @!attribute [rw] name
1027
+ # This is the name of the search job.
1028
+ # @return [String]
1029
+ #
1030
+ # @!attribute [rw] status
1031
+ # This is the status of the search job.
1032
+ # @return [String]
1033
+ #
1034
+ # @!attribute [rw] creation_time
1035
+ # This is the creation time of the search job.
1036
+ # @return [Time]
1037
+ #
1038
+ # @!attribute [rw] completion_time
1039
+ # This is the completion time of the search job.
1040
+ # @return [Time]
1041
+ #
1042
+ # @!attribute [rw] search_scope_summary
1043
+ # Returned summary of the specified search job scope, including:
1044
+ #
1045
+ # * TotalBackupsToScanCount, the number of recovery points returned by
1046
+ # the search.
1047
+ #
1048
+ # * TotalItemsToScanCount, the number of items returned by the search.
1049
+ # @return [Types::SearchScopeSummary]
1050
+ #
1051
+ # @!attribute [rw] status_message
1052
+ # A status message will be returned for either a earch job with a
1053
+ # status of `ERRORED` or a status of `COMPLETED` jobs with issues.
1054
+ #
1055
+ # For example, a message may say that a search contained recovery
1056
+ # points unable to be scanned because of a permissions issue.
1057
+ # @return [String]
1058
+ #
1059
+ # @see http://docs.aws.amazon.com/goto/WebAPI/backupsearch-2018-05-10/SearchJobSummary AWS API Documentation
1060
+ #
1061
+ class SearchJobSummary < Struct.new(
1062
+ :search_job_identifier,
1063
+ :search_job_arn,
1064
+ :name,
1065
+ :status,
1066
+ :creation_time,
1067
+ :completion_time,
1068
+ :search_scope_summary,
1069
+ :status_message)
1070
+ SENSITIVE = []
1071
+ include Aws::Structure
1072
+ end
1073
+
1074
+ # The search scope is all backup properties input into a search.
1075
+ #
1076
+ # @!attribute [rw] backup_resource_types
1077
+ # The resource types included in a search.
1078
+ #
1079
+ # Eligible resource types include S3 and EBS.
1080
+ # @return [Array<String>]
1081
+ #
1082
+ # @!attribute [rw] backup_resource_creation_time
1083
+ # This is the time a backup resource was created.
1084
+ # @return [Types::BackupCreationTimeFilter]
1085
+ #
1086
+ # @!attribute [rw] source_resource_arns
1087
+ # The Amazon Resource Name (ARN) that uniquely identifies the source
1088
+ # resources.
1089
+ # @return [Array<String>]
1090
+ #
1091
+ # @!attribute [rw] backup_resource_arns
1092
+ # The Amazon Resource Name (ARN) that uniquely identifies the backup
1093
+ # resources.
1094
+ # @return [Array<String>]
1095
+ #
1096
+ # @!attribute [rw] backup_resource_tags
1097
+ # These are one or more tags on the backup (recovery point).
1098
+ # @return [Hash<String,String>]
1099
+ #
1100
+ # @see http://docs.aws.amazon.com/goto/WebAPI/backupsearch-2018-05-10/SearchScope AWS API Documentation
1101
+ #
1102
+ class SearchScope < Struct.new(
1103
+ :backup_resource_types,
1104
+ :backup_resource_creation_time,
1105
+ :source_resource_arns,
1106
+ :backup_resource_arns,
1107
+ :backup_resource_tags)
1108
+ SENSITIVE = []
1109
+ include Aws::Structure
1110
+ end
1111
+
1112
+ # The summary of the specified search job scope, including:
1113
+ #
1114
+ # * TotalBackupsToScanCount, the number of recovery points returned by
1115
+ # the search.
1116
+ #
1117
+ # * TotalItemsToScanCount, the number of items returned by the search.
1118
+ #
1119
+ # @!attribute [rw] total_recovery_points_to_scan_count
1120
+ # This is the count of the total number of backups that will be
1121
+ # scanned in a search.
1122
+ # @return [Integer]
1123
+ #
1124
+ # @!attribute [rw] total_items_to_scan_count
1125
+ # This is the count of the total number of items that will be scanned
1126
+ # in a search.
1127
+ # @return [Integer]
1128
+ #
1129
+ # @see http://docs.aws.amazon.com/goto/WebAPI/backupsearch-2018-05-10/SearchScopeSummary AWS API Documentation
1130
+ #
1131
+ class SearchScopeSummary < Struct.new(
1132
+ :total_recovery_points_to_scan_count,
1133
+ :total_items_to_scan_count)
1134
+ SENSITIVE = []
1135
+ include Aws::Structure
1136
+ end
1137
+
1138
+ # The request denied due to exceeding the quota limits permitted.
1139
+ #
1140
+ # @!attribute [rw] message
1141
+ # This request was not successful due to a service quota exceeding
1142
+ # limits.
1143
+ # @return [String]
1144
+ #
1145
+ # @!attribute [rw] resource_id
1146
+ # Identifier of the resource.
1147
+ # @return [String]
1148
+ #
1149
+ # @!attribute [rw] resource_type
1150
+ # Type of resource.
1151
+ # @return [String]
1152
+ #
1153
+ # @!attribute [rw] service_code
1154
+ # This is the code unique to the originating service with the quota.
1155
+ # @return [String]
1156
+ #
1157
+ # @!attribute [rw] quota_code
1158
+ # This is the code specific to the quota type.
1159
+ # @return [String]
1160
+ #
1161
+ # @see http://docs.aws.amazon.com/goto/WebAPI/backupsearch-2018-05-10/ServiceQuotaExceededException AWS API Documentation
1162
+ #
1163
+ class ServiceQuotaExceededException < Struct.new(
1164
+ :message,
1165
+ :resource_id,
1166
+ :resource_type,
1167
+ :service_code,
1168
+ :quota_code)
1169
+ SENSITIVE = []
1170
+ include Aws::Structure
1171
+ end
1172
+
1173
+ # @!attribute [rw] tags
1174
+ # List of tags returned by the operation.
1175
+ # @return [Hash<String,String>]
1176
+ #
1177
+ # @!attribute [rw] name
1178
+ # Include alphanumeric characters to create a name for this search
1179
+ # job.
1180
+ # @return [String]
1181
+ #
1182
+ # @!attribute [rw] encryption_key_arn
1183
+ # The encryption key for the specified search job.
1184
+ # @return [String]
1185
+ #
1186
+ # @!attribute [rw] client_token
1187
+ # Include this parameter to allow multiple identical calls for
1188
+ # idempotency.
1189
+ #
1190
+ # A client token is valid for 8 hours after the first request that
1191
+ # uses it is completed. After this time, any request with the same
1192
+ # token is treated as a new request.
1193
+ # @return [String]
1194
+ #
1195
+ # @!attribute [rw] search_scope
1196
+ # This object can contain BackupResourceTypes, BackupResourceArns,
1197
+ # BackupResourceCreationTime, BackupResourceTags, and
1198
+ # SourceResourceArns to filter the recovery points returned by the
1199
+ # search job.
1200
+ # @return [Types::SearchScope]
1201
+ #
1202
+ # @!attribute [rw] item_filters
1203
+ # Item Filters represent all input item properties specified when the
1204
+ # search was created.
1205
+ #
1206
+ # Contains either EBSItemFilters or S3ItemFilters
1207
+ # @return [Types::ItemFilters]
1208
+ #
1209
+ # @see http://docs.aws.amazon.com/goto/WebAPI/backupsearch-2018-05-10/StartSearchJobInput AWS API Documentation
1210
+ #
1211
+ class StartSearchJobInput < Struct.new(
1212
+ :tags,
1213
+ :name,
1214
+ :encryption_key_arn,
1215
+ :client_token,
1216
+ :search_scope,
1217
+ :item_filters)
1218
+ SENSITIVE = []
1219
+ include Aws::Structure
1220
+ end
1221
+
1222
+ # @!attribute [rw] search_job_arn
1223
+ # The unique string that identifies the Amazon Resource Name (ARN) of
1224
+ # the specified search job.
1225
+ # @return [String]
1226
+ #
1227
+ # @!attribute [rw] creation_time
1228
+ # The date and time that a job was created, in Unix format and
1229
+ # Coordinated Universal Time (UTC). The value of `CompletionTime` is
1230
+ # accurate to milliseconds. For example, the value 1516925490.087
1231
+ # represents Friday, January 26, 2018 12:11:30.087 AM.
1232
+ # @return [Time]
1233
+ #
1234
+ # @!attribute [rw] search_job_identifier
1235
+ # The unique string that specifies the search job.
1236
+ # @return [String]
1237
+ #
1238
+ # @see http://docs.aws.amazon.com/goto/WebAPI/backupsearch-2018-05-10/StartSearchJobOutput AWS API Documentation
1239
+ #
1240
+ class StartSearchJobOutput < Struct.new(
1241
+ :search_job_arn,
1242
+ :creation_time,
1243
+ :search_job_identifier)
1244
+ SENSITIVE = []
1245
+ include Aws::Structure
1246
+ end
1247
+
1248
+ # @!attribute [rw] search_job_identifier
1249
+ # The unique string that specifies the search job.
1250
+ # @return [String]
1251
+ #
1252
+ # @!attribute [rw] export_specification
1253
+ # This specification contains a required string of the destination
1254
+ # bucket; optionally, you can include the destination prefix.
1255
+ # @return [Types::ExportSpecification]
1256
+ #
1257
+ # @!attribute [rw] client_token
1258
+ # Include this parameter to allow multiple identical calls for
1259
+ # idempotency.
1260
+ #
1261
+ # A client token is valid for 8 hours after the first request that
1262
+ # uses it is completed. After this time, any request with the same
1263
+ # token is treated as a new request.
1264
+ # @return [String]
1265
+ #
1266
+ # @!attribute [rw] tags
1267
+ # Optional tags to include. A tag is a key-value pair you can use to
1268
+ # manage, filter, and search for your resources. Allowed characters
1269
+ # include UTF-8 letters, numbers, spaces, and the following
1270
+ # characters: + - = . \_ : /.
1271
+ # @return [Hash<String,String>]
1272
+ #
1273
+ # @!attribute [rw] role_arn
1274
+ # This parameter specifies the role ARN used to start the search
1275
+ # results export jobs.
1276
+ # @return [String]
1277
+ #
1278
+ # @see http://docs.aws.amazon.com/goto/WebAPI/backupsearch-2018-05-10/StartSearchResultExportJobInput AWS API Documentation
1279
+ #
1280
+ class StartSearchResultExportJobInput < Struct.new(
1281
+ :search_job_identifier,
1282
+ :export_specification,
1283
+ :client_token,
1284
+ :tags,
1285
+ :role_arn)
1286
+ SENSITIVE = []
1287
+ include Aws::Structure
1288
+ end
1289
+
1290
+ # @!attribute [rw] export_job_arn
1291
+ # This is the unique ARN (Amazon Resource Name) that belongs to the
1292
+ # new export job.
1293
+ # @return [String]
1294
+ #
1295
+ # @!attribute [rw] export_job_identifier
1296
+ # This is the unique identifier that specifies the new export job.
1297
+ # @return [String]
1298
+ #
1299
+ # @see http://docs.aws.amazon.com/goto/WebAPI/backupsearch-2018-05-10/StartSearchResultExportJobOutput AWS API Documentation
1300
+ #
1301
+ class StartSearchResultExportJobOutput < Struct.new(
1302
+ :export_job_arn,
1303
+ :export_job_identifier)
1304
+ SENSITIVE = []
1305
+ include Aws::Structure
1306
+ end
1307
+
1308
+ # @!attribute [rw] search_job_identifier
1309
+ # The unique string that specifies the search job.
1310
+ # @return [String]
1311
+ #
1312
+ # @see http://docs.aws.amazon.com/goto/WebAPI/backupsearch-2018-05-10/StopSearchJobInput AWS API Documentation
1313
+ #
1314
+ class StopSearchJobInput < Struct.new(
1315
+ :search_job_identifier)
1316
+ SENSITIVE = []
1317
+ include Aws::Structure
1318
+ end
1319
+
1320
+ # @see http://docs.aws.amazon.com/goto/WebAPI/backupsearch-2018-05-10/StopSearchJobOutput AWS API Documentation
1321
+ #
1322
+ class StopSearchJobOutput < Aws::EmptyStructure; end
1323
+
1324
+ # This contains the value of the string and can contain one or more
1325
+ # operators.
1326
+ #
1327
+ # @!attribute [rw] value
1328
+ # The value of the string.
1329
+ # @return [String]
1330
+ #
1331
+ # @!attribute [rw] operator
1332
+ # A string that defines what values will be returned.
1333
+ #
1334
+ # If this is included, avoid combinations of operators that will
1335
+ # return all possible values. For example, including both `EQUALS_TO`
1336
+ # and `NOT_EQUALS_TO` with a value of `4` will return all values.
1337
+ # @return [String]
1338
+ #
1339
+ # @see http://docs.aws.amazon.com/goto/WebAPI/backupsearch-2018-05-10/StringCondition AWS API Documentation
1340
+ #
1341
+ class StringCondition < Struct.new(
1342
+ :value,
1343
+ :operator)
1344
+ SENSITIVE = []
1345
+ include Aws::Structure
1346
+ end
1347
+
1348
+ # @!attribute [rw] resource_arn
1349
+ # The Amazon Resource Name (ARN) that uniquely identifies the
1350
+ # resource.
1351
+ #
1352
+ # This is the resource that will have the indicated tags.
1353
+ # @return [String]
1354
+ #
1355
+ # @!attribute [rw] tags
1356
+ # Required tags to include. A tag is a key-value pair you can use to
1357
+ # manage, filter, and search for your resources. Allowed characters
1358
+ # include UTF-8 letters, numbers, spaces, and the following
1359
+ # characters: + - = . \_ : /.
1360
+ # @return [Hash<String,String>]
1361
+ #
1362
+ # @see http://docs.aws.amazon.com/goto/WebAPI/backupsearch-2018-05-10/TagResourceRequest AWS API Documentation
1363
+ #
1364
+ class TagResourceRequest < Struct.new(
1365
+ :resource_arn,
1366
+ :tags)
1367
+ SENSITIVE = []
1368
+ include Aws::Structure
1369
+ end
1370
+
1371
+ # @see http://docs.aws.amazon.com/goto/WebAPI/backupsearch-2018-05-10/TagResourceResponse AWS API Documentation
1372
+ #
1373
+ class TagResourceResponse < Aws::EmptyStructure; end
1374
+
1375
+ # The request was denied due to request throttling.
1376
+ #
1377
+ # @!attribute [rw] message
1378
+ # Request was unsuccessful due to request throttling.
1379
+ # @return [String]
1380
+ #
1381
+ # @!attribute [rw] service_code
1382
+ # This is the code unique to the originating service.
1383
+ # @return [String]
1384
+ #
1385
+ # @!attribute [rw] quota_code
1386
+ # This is the code unique to the originating service with the quota.
1387
+ # @return [String]
1388
+ #
1389
+ # @!attribute [rw] retry_after_seconds
1390
+ # Retry the call after number of seconds.
1391
+ # @return [Integer]
1392
+ #
1393
+ # @see http://docs.aws.amazon.com/goto/WebAPI/backupsearch-2018-05-10/ThrottlingException AWS API Documentation
1394
+ #
1395
+ class ThrottlingException < Struct.new(
1396
+ :message,
1397
+ :service_code,
1398
+ :quota_code,
1399
+ :retry_after_seconds)
1400
+ SENSITIVE = []
1401
+ include Aws::Structure
1402
+ end
1403
+
1404
+ # A time condition denotes a creation time, last modification time, or
1405
+ # other time.
1406
+ #
1407
+ # @!attribute [rw] value
1408
+ # This is the timestamp value of the time condition.
1409
+ # @return [Time]
1410
+ #
1411
+ # @!attribute [rw] operator
1412
+ # A string that defines what values will be returned.
1413
+ #
1414
+ # If this is included, avoid combinations of operators that will
1415
+ # return all possible values. For example, including both `EQUALS_TO`
1416
+ # and `NOT_EQUALS_TO` with a value of `4` will return all values.
1417
+ # @return [String]
1418
+ #
1419
+ # @see http://docs.aws.amazon.com/goto/WebAPI/backupsearch-2018-05-10/TimeCondition AWS API Documentation
1420
+ #
1421
+ class TimeCondition < Struct.new(
1422
+ :value,
1423
+ :operator)
1424
+ SENSITIVE = []
1425
+ include Aws::Structure
1426
+ end
1427
+
1428
+ # @!attribute [rw] resource_arn
1429
+ # The Amazon Resource Name (ARN) that uniquely identifies the resource
1430
+ # where you want to remove tags.
1431
+ # @return [String]
1432
+ #
1433
+ # @!attribute [rw] tag_keys
1434
+ # This required parameter contains the tag keys you want to remove
1435
+ # from the source.
1436
+ # @return [Array<String>]
1437
+ #
1438
+ # @see http://docs.aws.amazon.com/goto/WebAPI/backupsearch-2018-05-10/UntagResourceRequest AWS API Documentation
1439
+ #
1440
+ class UntagResourceRequest < Struct.new(
1441
+ :resource_arn,
1442
+ :tag_keys)
1443
+ SENSITIVE = []
1444
+ include Aws::Structure
1445
+ end
1446
+
1447
+ # @see http://docs.aws.amazon.com/goto/WebAPI/backupsearch-2018-05-10/UntagResourceResponse AWS API Documentation
1448
+ #
1449
+ class UntagResourceResponse < Aws::EmptyStructure; end
1450
+
1451
+ # The input fails to satisfy the constraints specified by a service.
1452
+ #
1453
+ # @!attribute [rw] message
1454
+ # The input fails to satisfy the constraints specified by an Amazon
1455
+ # service.
1456
+ # @return [String]
1457
+ #
1458
+ # @see http://docs.aws.amazon.com/goto/WebAPI/backupsearch-2018-05-10/ValidationException AWS API Documentation
1459
+ #
1460
+ class ValidationException < Struct.new(
1461
+ :message)
1462
+ SENSITIVE = []
1463
+ include Aws::Structure
1464
+ end
1465
+
1466
+ end
1467
+ end
1468
+