aws-sdk-backup 1.102.0 → 1.103.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.
@@ -63,6 +63,33 @@ module Aws::Backup
63
63
  include Aws::Structure
64
64
  end
65
65
 
66
+ # Contains aggregated scan results across multiple scan operations,
67
+ # providing a summary of scan status and findings.
68
+ #
69
+ # @!attribute [rw] failed_scan
70
+ # A Boolean value indicating whether any of the aggregated scans
71
+ # failed.
72
+ # @return [Boolean]
73
+ #
74
+ # @!attribute [rw] findings
75
+ # An array of findings discovered across all aggregated scans.
76
+ # @return [Array<String>]
77
+ #
78
+ # @!attribute [rw] last_computed
79
+ # The timestamp when the aggregated scan result was last computed, in
80
+ # Unix format and Coordinated Universal Time (UTC).
81
+ # @return [Time]
82
+ #
83
+ # @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/AggregatedScanResult AWS API Documentation
84
+ #
85
+ class AggregatedScanResult < Struct.new(
86
+ :failed_scan,
87
+ :findings,
88
+ :last_computed)
89
+ SENSITIVE = []
90
+ include Aws::Structure
91
+ end
92
+
66
93
  # The required resource already exists.
67
94
  #
68
95
  # @!attribute [rw] code
@@ -498,12 +525,19 @@ module Aws::Backup
498
525
  # Contains a list of `BackupOptions` for each resource type.
499
526
  # @return [Array<Types::AdvancedBackupSetting>]
500
527
  #
528
+ # @!attribute [rw] scan_settings
529
+ # Contains your scanning configuration for the backup plan and
530
+ # includes the Malware scanner, your selected resources, and scanner
531
+ # role.
532
+ # @return [Array<Types::ScanSetting>]
533
+ #
501
534
  # @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/BackupPlan AWS API Documentation
502
535
  #
503
536
  class BackupPlan < Struct.new(
504
537
  :backup_plan_name,
505
538
  :rules,
506
- :advanced_backup_settings)
539
+ :advanced_backup_settings,
540
+ :scan_settings)
507
541
  SENSITIVE = []
508
542
  include Aws::Structure
509
543
  end
@@ -528,12 +562,19 @@ module Aws::Backup
528
562
  # (VSS) backup jobs.
529
563
  # @return [Array<Types::AdvancedBackupSetting>]
530
564
  #
565
+ # @!attribute [rw] scan_settings
566
+ # Contains your scanning configuration for the backup rule and
567
+ # includes the malware scanner, and scan mode of either full or
568
+ # incremental.
569
+ # @return [Array<Types::ScanSetting>]
570
+ #
531
571
  # @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/BackupPlanInput AWS API Documentation
532
572
  #
533
573
  class BackupPlanInput < Struct.new(
534
574
  :backup_plan_name,
535
575
  :rules,
536
- :advanced_backup_settings)
576
+ :advanced_backup_settings,
577
+ :scan_settings)
537
578
  SENSITIVE = []
538
579
  include Aws::Structure
539
580
  end
@@ -754,6 +795,12 @@ module Aws::Backup
754
795
  # BackupRule.
755
796
  # @return [Array<Types::IndexAction>]
756
797
  #
798
+ # @!attribute [rw] scan_actions
799
+ # Contains your scanning configuration for the backup rule and
800
+ # includes the malware scanner, and scan mode of either full or
801
+ # incremental.
802
+ # @return [Array<Types::ScanAction>]
803
+ #
757
804
  # @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/BackupRule AWS API Documentation
758
805
  #
759
806
  class BackupRule < Struct.new(
@@ -769,7 +816,8 @@ module Aws::Backup
769
816
  :copy_actions,
770
817
  :enable_continuous_backup,
771
818
  :schedule_expression_timezone,
772
- :index_actions)
819
+ :index_actions,
820
+ :scan_actions)
773
821
  SENSITIVE = [:recovery_point_tags]
774
822
  include Aws::Structure
775
823
  end
@@ -884,6 +932,12 @@ module Aws::Backup
884
932
  # * `S3` for Amazon Simple Storage Service (Amazon S3)
885
933
  # @return [Array<Types::IndexAction>]
886
934
  #
935
+ # @!attribute [rw] scan_actions
936
+ # Contains your scanning configuration for the backup rule and
937
+ # includes the malware scanner, and scan mode of either full or
938
+ # incremental.
939
+ # @return [Array<Types::ScanAction>]
940
+ #
887
941
  # @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/BackupRuleInput AWS API Documentation
888
942
  #
889
943
  class BackupRuleInput < Struct.new(
@@ -898,7 +952,8 @@ module Aws::Backup
898
952
  :copy_actions,
899
953
  :enable_continuous_backup,
900
954
  :schedule_expression_timezone,
901
- :index_actions)
955
+ :index_actions,
956
+ :scan_actions)
902
957
  SENSITIVE = [:recovery_point_tags]
903
958
  include Aws::Structure
904
959
  end
@@ -2219,7 +2274,8 @@ module Aws::Backup
2219
2274
  # using a report template. The report templates are:
2220
2275
  #
2221
2276
  # `RESOURCE_COMPLIANCE_REPORT | CONTROL_COMPLIANCE_REPORT |
2222
- # BACKUP_JOB_REPORT | COPY_JOB_REPORT | RESTORE_JOB_REPORT`
2277
+ # BACKUP_JOB_REPORT | COPY_JOB_REPORT | RESTORE_JOB_REPORT |
2278
+ # SCAN_JOB_REPORT `
2223
2279
  #
2224
2280
  # If the report template is `RESOURCE_COMPLIANCE_REPORT` or
2225
2281
  # `CONTROL_COMPLIANCE_REPORT`, this API resource also describes the
@@ -3736,6 +3792,12 @@ module Aws::Backup
3736
3792
  # Web Services\_OWNED\_KMS\_KEY for Amazon Web Services-owned keys.
3737
3793
  # @return [String]
3738
3794
  #
3795
+ # @!attribute [rw] scan_results
3796
+ # Contains the latest scanning results against the recovery point and
3797
+ # currently include `MalwareScanner`, `ScanJobState`, `Findings`, and
3798
+ # `LastScanTimestamp`
3799
+ # @return [Array<Types::ScanResult>]
3800
+ #
3739
3801
  # @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/DescribeRecoveryPointOutput AWS API Documentation
3740
3802
  #
3741
3803
  class DescribeRecoveryPointOutput < Struct.new(
@@ -3766,7 +3828,8 @@ module Aws::Backup
3766
3828
  :vault_type,
3767
3829
  :index_status,
3768
3830
  :index_status_message,
3769
- :encryption_key_type)
3831
+ :encryption_key_type,
3832
+ :scan_results)
3770
3833
  SENSITIVE = []
3771
3834
  include Aws::Structure
3772
3835
  end
@@ -4025,6 +4088,155 @@ module Aws::Backup
4025
4088
  include Aws::Structure
4026
4089
  end
4027
4090
 
4091
+ # @!attribute [rw] scan_job_id
4092
+ # Uniquely identifies a request to Backup to scan a resource.
4093
+ # @return [String]
4094
+ #
4095
+ # @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/DescribeScanJobInput AWS API Documentation
4096
+ #
4097
+ class DescribeScanJobInput < Struct.new(
4098
+ :scan_job_id)
4099
+ SENSITIVE = []
4100
+ include Aws::Structure
4101
+ end
4102
+
4103
+ # @!attribute [rw] account_id
4104
+ # Returns the account ID that owns the scan job.
4105
+ #
4106
+ # Pattern: `^[0-9]{12}$`
4107
+ # @return [String]
4108
+ #
4109
+ # @!attribute [rw] backup_vault_arn
4110
+ # An Amazon Resource Name (ARN) that uniquely identifies a backup
4111
+ # vault; for example,
4112
+ # `arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault`
4113
+ # @return [String]
4114
+ #
4115
+ # @!attribute [rw] backup_vault_name
4116
+ # The name of a logical container where backups are stored. Backup
4117
+ # vaults are identified by names that are unique to the account used
4118
+ # to create them and the Amazon Web Services Region where they are
4119
+ # created.
4120
+ #
4121
+ # Pattern: `^[a-zA-Z0-9\-\_\.]{2,50}$`
4122
+ # @return [String]
4123
+ #
4124
+ # @!attribute [rw] completion_date
4125
+ # The date and time that a backup index finished creation, in Unix
4126
+ # format and Coordinated Universal Time (UTC). The value of
4127
+ # `CompletionDate` is accurate to milliseconds. For example, the value
4128
+ # 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
4129
+ # @return [Time]
4130
+ #
4131
+ # @!attribute [rw] created_by
4132
+ # Contains identifying information about the creation of a scan job,
4133
+ # including the backup plan and rule that initiated the scan.
4134
+ # @return [Types::ScanJobCreator]
4135
+ #
4136
+ # @!attribute [rw] creation_date
4137
+ # The date and time that a backup index finished creation, in Unix
4138
+ # format and Coordinated Universal Time (UTC). The value of
4139
+ # `CreationDate` is accurate to milliseconds. For example, the value
4140
+ # 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
4141
+ # @return [Time]
4142
+ #
4143
+ # @!attribute [rw] iam_role_arn
4144
+ # An Amazon Resource Name (ARN) that uniquely identifies a backup
4145
+ # vault; for example, `arn:aws:iam::123456789012:role/S3Access`.
4146
+ # @return [String]
4147
+ #
4148
+ # @!attribute [rw] malware_scanner
4149
+ # The scanning engine used for the corresponding scan job. Currently
4150
+ # only `GUARDUTY` is supported.
4151
+ # @return [String]
4152
+ #
4153
+ # @!attribute [rw] recovery_point_arn
4154
+ # An ARN that uniquely identifies the target recovery point for
4155
+ # scanning.; for example,
4156
+ # `arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45`.
4157
+ # @return [String]
4158
+ #
4159
+ # @!attribute [rw] resource_arn
4160
+ # An ARN that uniquely identifies the source resource of the
4161
+ # corresponding recovery point ARN.
4162
+ # @return [String]
4163
+ #
4164
+ # @!attribute [rw] resource_name
4165
+ # The non-unique name of the resource that belongs to the specified
4166
+ # backup.
4167
+ # @return [String]
4168
+ #
4169
+ # @!attribute [rw] resource_type
4170
+ # The type of Amazon Web Services Resource to be backed up; for
4171
+ # example, an Amazon Elastic Block Store (Amazon EBS) volume.
4172
+ #
4173
+ # Pattern: `^[a-zA-Z0-9\-\_\.]{1,50}$`
4174
+ # @return [String]
4175
+ #
4176
+ # @!attribute [rw] scan_base_recovery_point_arn
4177
+ # An ARN that uniquely identifies the base recovery point for
4178
+ # scanning. This field will only be populated when an incremental scan
4179
+ # job has taken place.
4180
+ # @return [String]
4181
+ #
4182
+ # @!attribute [rw] scan_id
4183
+ # The scan ID generated by Amazon GuardDuty for the corresponding Scan
4184
+ # Job ID request from Backup.
4185
+ # @return [String]
4186
+ #
4187
+ # @!attribute [rw] scan_job_id
4188
+ # The scan job ID that uniquely identified the request to Backup.
4189
+ # @return [String]
4190
+ #
4191
+ # @!attribute [rw] scan_mode
4192
+ # Specifies the scan type used for the scan job.
4193
+ # @return [String]
4194
+ #
4195
+ # @!attribute [rw] scan_result
4196
+ # Contains the `ScanResultsStatus` for the scanning job and returns
4197
+ # `THREATS_FOUND` or `NO_THREATS_FOUND` for completed jobs.
4198
+ # @return [Types::ScanResultInfo]
4199
+ #
4200
+ # @!attribute [rw] scanner_role_arn
4201
+ # Specifies the scanner IAM role ARN used to for the scan job.
4202
+ # @return [String]
4203
+ #
4204
+ # @!attribute [rw] state
4205
+ # The current state of a scan job.
4206
+ # @return [String]
4207
+ #
4208
+ # @!attribute [rw] status_message
4209
+ # A detailed message explaining the status of the job to back up a
4210
+ # resource.
4211
+ # @return [String]
4212
+ #
4213
+ # @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/DescribeScanJobOutput AWS API Documentation
4214
+ #
4215
+ class DescribeScanJobOutput < Struct.new(
4216
+ :account_id,
4217
+ :backup_vault_arn,
4218
+ :backup_vault_name,
4219
+ :completion_date,
4220
+ :created_by,
4221
+ :creation_date,
4222
+ :iam_role_arn,
4223
+ :malware_scanner,
4224
+ :recovery_point_arn,
4225
+ :resource_arn,
4226
+ :resource_name,
4227
+ :resource_type,
4228
+ :scan_base_recovery_point_arn,
4229
+ :scan_id,
4230
+ :scan_job_id,
4231
+ :scan_mode,
4232
+ :scan_result,
4233
+ :scanner_role_arn,
4234
+ :state,
4235
+ :status_message)
4236
+ SENSITIVE = []
4237
+ include Aws::Structure
4238
+ end
4239
+
4028
4240
  # @!attribute [rw] backup_vault_name
4029
4241
  # The name of the backup vault from which to disassociate the MPA
4030
4242
  # approval team.
@@ -6672,7 +6884,11 @@ module Aws::Backup
6672
6884
  # Returns only report jobs that are in the specified status. The
6673
6885
  # statuses are:
6674
6886
  #
6675
- # `CREATED | RUNNING | COMPLETED | FAILED`
6887
+ # `CREATED | RUNNING | COMPLETED | FAILED | COMPLETED_WITH_ISSUES`
6888
+ #
6889
+ # Please note that only scanning jobs finish with state completed with
6890
+ # issues. For backup jobs this is a console interpretation of a job
6891
+ # that finishes in completed state and has a status message.
6676
6892
  # @return [String]
6677
6893
  #
6678
6894
  # @!attribute [rw] max_results
@@ -7190,55 +7406,59 @@ module Aws::Backup
7190
7406
  include Aws::Structure
7191
7407
  end
7192
7408
 
7193
- # @!attribute [rw] resource_arn
7194
- # An Amazon Resource Name (ARN) that uniquely identifies a resource.
7195
- # The format of the ARN depends on the type of resource. Valid targets
7196
- # for `ListTags` are recovery points, backup plans, and backup vaults.
7409
+ # @!attribute [rw] account_id
7410
+ # Returns the job count for the specified account.
7411
+ #
7412
+ # If the request is sent from a member account or an account not part
7413
+ # of Amazon Web Services Organizations, jobs within requestor's
7414
+ # account will be returned.
7415
+ #
7416
+ # Root, admin, and delegated administrator accounts can use the value
7417
+ # `ANY` to return job counts from every account in the organization.
7418
+ #
7419
+ # `AGGREGATE_ALL` aggregates job counts from all accounts within the
7420
+ # authenticated organization, then returns the sum.
7197
7421
  # @return [String]
7198
7422
  #
7199
- # @!attribute [rw] next_token
7200
- # The next item following a partial list of returned items. For
7201
- # example, if a request is made to return `MaxResults` number of
7202
- # items, `NextToken` allows you to return more items in your list
7203
- # starting at the location pointed to by the next token.
7423
+ # @!attribute [rw] resource_type
7424
+ # Returns the job count for the specified resource type. Use request
7425
+ # `GetSupportedResourceTypes` to obtain strings for supported resource
7426
+ # types.
7427
+ #
7428
+ # The the value `ANY` returns count of all resource types.
7429
+ #
7430
+ # `AGGREGATE_ALL` aggregates job counts for all resource types and
7431
+ # returns the sum.
7204
7432
  # @return [String]
7205
7433
  #
7206
- # @!attribute [rw] max_results
7207
- # The maximum number of items to be returned.
7208
- # @return [Integer]
7434
+ # @!attribute [rw] malware_scanner
7435
+ # Returns only the scan jobs for the specified malware scanner.
7436
+ # Currently the only MalwareScanner is `GUARDDUTY`. But the field also
7437
+ # supports `ANY`, and `AGGREGATE_ALL`.
7438
+ # @return [String]
7209
7439
  #
7210
- # @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/ListTagsInput AWS API Documentation
7440
+ # @!attribute [rw] scan_result_status
7441
+ # Returns only the scan jobs for the specified scan results.
7442
+ # @return [String]
7211
7443
  #
7212
- class ListTagsInput < Struct.new(
7213
- :resource_arn,
7214
- :next_token,
7215
- :max_results)
7216
- SENSITIVE = []
7217
- include Aws::Structure
7218
- end
7219
-
7220
- # @!attribute [rw] next_token
7221
- # The next item following a partial list of returned items. For
7222
- # example, if a request is made to return `MaxResults` number of
7223
- # items, `NextToken` allows you to return more items in your list
7224
- # starting at the location pointed to by the next token.
7444
+ # @!attribute [rw] state
7445
+ # Returns only the scan jobs for the specified scanning job state.
7225
7446
  # @return [String]
7226
7447
  #
7227
- # @!attribute [rw] tags
7228
- # Information about the tags.
7229
- # @return [Hash<String,String>]
7448
+ # @!attribute [rw] aggregation_period
7449
+ # The period for the returned results.
7230
7450
  #
7231
- # @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/ListTagsOutput AWS API Documentation
7451
+ # * `ONE_DAY`The daily job count for the prior 1 day.
7452
+ #
7453
+ # * `SEVEN_DAYS`The daily job count for the prior 7 days.
7454
+ #
7455
+ # * `FOURTEEN_DAYS`The daily job count for the prior 14 days.
7456
+ # @return [String]
7232
7457
  #
7233
- class ListTagsOutput < Struct.new(
7234
- :next_token,
7235
- :tags)
7236
- SENSITIVE = [:tags]
7237
- include Aws::Structure
7238
- end
7239
-
7240
7458
  # @!attribute [rw] max_results
7241
7459
  # The maximum number of items to be returned.
7460
+ #
7461
+ # The value is an integer. Range of accepted values is from 1 to 500.
7242
7462
  # @return [Integer]
7243
7463
  #
7244
7464
  # @!attribute [rw] next_token
@@ -7248,19 +7468,36 @@ module Aws::Backup
7248
7468
  # starting at the location pointed to by the next token.
7249
7469
  # @return [String]
7250
7470
  #
7251
- # @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/ListTieringConfigurationsInput AWS API Documentation
7471
+ # @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/ListScanJobSummariesInput AWS API Documentation
7252
7472
  #
7253
- class ListTieringConfigurationsInput < Struct.new(
7473
+ class ListScanJobSummariesInput < Struct.new(
7474
+ :account_id,
7475
+ :resource_type,
7476
+ :malware_scanner,
7477
+ :scan_result_status,
7478
+ :state,
7479
+ :aggregation_period,
7254
7480
  :max_results,
7255
7481
  :next_token)
7256
7482
  SENSITIVE = []
7257
7483
  include Aws::Structure
7258
7484
  end
7259
7485
 
7260
- # @!attribute [rw] tiering_configurations
7261
- # An array of tiering configurations returned by the
7262
- # `ListTieringConfigurations` call.
7263
- # @return [Array<Types::TieringConfigurationsListMember>]
7486
+ # @!attribute [rw] scan_job_summaries
7487
+ # The summary information.
7488
+ # @return [Array<Types::ScanJobSummary>]
7489
+ #
7490
+ # @!attribute [rw] aggregation_period
7491
+ # The period for the returned results.
7492
+ #
7493
+ # * `ONE_DAY`The daily job count for the prior 1 day.
7494
+ #
7495
+ # * `SEVEN_DAYS`The daily job count for the prior 7 days.
7496
+ #
7497
+ # * `FOURTEEN_DAYS`The daily job count for the prior 14 days.
7498
+ #
7499
+ # Valid Values: `'ONE_DAY'` \| `'SEVEN_DAYS'` \| `'FOURTEEN_DAYS'`
7500
+ # @return [String]
7264
7501
  #
7265
7502
  # @!attribute [rw] next_token
7266
7503
  # The next item following a partial list of returned items. For
@@ -7269,57 +7506,268 @@ module Aws::Backup
7269
7506
  # starting at the location pointed to by the next token.
7270
7507
  # @return [String]
7271
7508
  #
7272
- # @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/ListTieringConfigurationsOutput AWS API Documentation
7509
+ # @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/ListScanJobSummariesOutput AWS API Documentation
7273
7510
  #
7274
- class ListTieringConfigurationsOutput < Struct.new(
7275
- :tiering_configurations,
7511
+ class ListScanJobSummariesOutput < Struct.new(
7512
+ :scan_job_summaries,
7513
+ :aggregation_period,
7276
7514
  :next_token)
7277
7515
  SENSITIVE = []
7278
7516
  include Aws::Structure
7279
7517
  end
7280
7518
 
7281
- # Indicates that a required parameter is missing.
7519
+ # @!attribute [rw] by_account_id
7520
+ # The account ID to list the jobs from. Returns only backup jobs
7521
+ # associated with the specified account ID.
7282
7522
  #
7283
- # @!attribute [rw] code
7284
- # @return [String]
7523
+ # If used from an Amazon Web Services Organizations management
7524
+ # account, passing `*` returns all jobs across the organization.
7285
7525
  #
7286
- # @!attribute [rw] message
7526
+ # Pattern: `^[0-9]{12}$`
7287
7527
  # @return [String]
7288
7528
  #
7289
- # @!attribute [rw] type
7290
- # @return [String]
7529
+ # @!attribute [rw] by_backup_vault_name
7530
+ # Returns only scan jobs that will be stored in the specified backup
7531
+ # vault. Backup vaults are identified by names that are unique to the
7532
+ # account used to create them and the Amazon Web Services Region where
7533
+ # they are created.
7291
7534
  #
7292
- # @!attribute [rw] context
7535
+ # Pattern: `^[a-zA-Z0-9\-\_\.]{2,50}$`
7293
7536
  # @return [String]
7294
7537
  #
7295
- # @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/MissingParameterValueException AWS API Documentation
7538
+ # @!attribute [rw] by_complete_after
7539
+ # Returns only scan jobs completed after a date expressed in Unix
7540
+ # format and Coordinated Universal Time (UTC).
7541
+ # @return [Time]
7296
7542
  #
7297
- class MissingParameterValueException < Struct.new(
7298
- :code,
7299
- :message,
7300
- :type,
7301
- :context)
7302
- SENSITIVE = []
7303
- include Aws::Structure
7304
- end
7305
-
7306
- # A structure that contains information about a backed-up resource.
7543
+ # @!attribute [rw] by_complete_before
7544
+ # Returns only backup jobs completed before a date expressed in Unix
7545
+ # format and Coordinated Universal Time (UTC).
7546
+ # @return [Time]
7307
7547
  #
7308
- # @!attribute [rw] resource_arn
7309
- # An Amazon Resource Name (ARN) that uniquely identifies a resource.
7310
- # The format of the ARN depends on the resource type.
7548
+ # @!attribute [rw] by_malware_scanner
7549
+ # Returns only the scan jobs for the specified malware scanner.
7550
+ # Currently only supports `GUARDDUTY`.
7311
7551
  # @return [String]
7312
7552
  #
7313
- # @!attribute [rw] resource_type
7314
- # The type of Amazon Web Services resource; for example, an Amazon
7315
- # Elastic Block Store (Amazon EBS) volume or an Amazon Relational
7316
- # Database Service (Amazon RDS) database. For Windows Volume Shadow
7317
- # Copy Service (VSS) backups, the only supported resource type is
7318
- # Amazon EC2.
7553
+ # @!attribute [rw] by_recovery_point_arn
7554
+ # Returns only the scan jobs that are ran against the specified
7555
+ # recovery point.
7319
7556
  # @return [String]
7320
7557
  #
7321
- # @!attribute [rw] last_backup_time
7322
- # The date and time a resource was last backed up, in Unix format and
7558
+ # @!attribute [rw] by_resource_arn
7559
+ # Returns only scan jobs that match the specified resource Amazon
7560
+ # Resource Name (ARN).
7561
+ # @return [String]
7562
+ #
7563
+ # @!attribute [rw] by_resource_type
7564
+ # Returns restore testing selections by the specified restore testing
7565
+ # plan name.
7566
+ #
7567
+ # * `EBS`for Amazon Elastic Block Store
7568
+ #
7569
+ # * `EC2`for Amazon Elastic Compute Cloud
7570
+ #
7571
+ # * `S3`for Amazon Simple Storage Service (Amazon S3)
7572
+ #
7573
+ # Pattern: `^[a-zA-Z0-9\-\_\.]{1,50}$`
7574
+ # @return [String]
7575
+ #
7576
+ # @!attribute [rw] by_scan_result_status
7577
+ # Returns only the scan jobs for the specified scan results:
7578
+ #
7579
+ # * `THREATS_FOUND`
7580
+ #
7581
+ # * `NO_THREATS_FOUND`
7582
+ # @return [String]
7583
+ #
7584
+ # @!attribute [rw] by_state
7585
+ # Returns only the scan jobs for the specified scanning job state.
7586
+ # @return [String]
7587
+ #
7588
+ # @!attribute [rw] max_results
7589
+ # The maximum number of items to be returned.
7590
+ #
7591
+ # Valid Range: Minimum value of 1. Maximum value of 1000.
7592
+ # @return [Integer]
7593
+ #
7594
+ # @!attribute [rw] next_token
7595
+ # The next item following a partial list of returned items. For
7596
+ # example, if a request is made to return `MaxResults` number of
7597
+ # items, `NextToken` allows you to return more items in your list
7598
+ # starting at the location pointed to by the next token.
7599
+ # @return [String]
7600
+ #
7601
+ # @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/ListScanJobsInput AWS API Documentation
7602
+ #
7603
+ class ListScanJobsInput < Struct.new(
7604
+ :by_account_id,
7605
+ :by_backup_vault_name,
7606
+ :by_complete_after,
7607
+ :by_complete_before,
7608
+ :by_malware_scanner,
7609
+ :by_recovery_point_arn,
7610
+ :by_resource_arn,
7611
+ :by_resource_type,
7612
+ :by_scan_result_status,
7613
+ :by_state,
7614
+ :max_results,
7615
+ :next_token)
7616
+ SENSITIVE = []
7617
+ include Aws::Structure
7618
+ end
7619
+
7620
+ # @!attribute [rw] next_token
7621
+ # The next item following a partial list of returned items. For
7622
+ # example, if a request is made to return `MaxResults` number of
7623
+ # items, `NextToken` allows you to return more items in your list
7624
+ # starting at the location pointed to by the next token.
7625
+ # @return [String]
7626
+ #
7627
+ # @!attribute [rw] scan_jobs
7628
+ # An array of structures containing metadata about your scan jobs
7629
+ # returned in JSON format.
7630
+ # @return [Array<Types::ScanJob>]
7631
+ #
7632
+ # @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/ListScanJobsOutput AWS API Documentation
7633
+ #
7634
+ class ListScanJobsOutput < Struct.new(
7635
+ :next_token,
7636
+ :scan_jobs)
7637
+ SENSITIVE = []
7638
+ include Aws::Structure
7639
+ end
7640
+
7641
+ # @!attribute [rw] resource_arn
7642
+ # An Amazon Resource Name (ARN) that uniquely identifies a resource.
7643
+ # The format of the ARN depends on the type of resource. Valid targets
7644
+ # for `ListTags` are recovery points, backup plans, and backup vaults.
7645
+ # @return [String]
7646
+ #
7647
+ # @!attribute [rw] next_token
7648
+ # The next item following a partial list of returned items. For
7649
+ # example, if a request is made to return `MaxResults` number of
7650
+ # items, `NextToken` allows you to return more items in your list
7651
+ # starting at the location pointed to by the next token.
7652
+ # @return [String]
7653
+ #
7654
+ # @!attribute [rw] max_results
7655
+ # The maximum number of items to be returned.
7656
+ # @return [Integer]
7657
+ #
7658
+ # @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/ListTagsInput AWS API Documentation
7659
+ #
7660
+ class ListTagsInput < Struct.new(
7661
+ :resource_arn,
7662
+ :next_token,
7663
+ :max_results)
7664
+ SENSITIVE = []
7665
+ include Aws::Structure
7666
+ end
7667
+
7668
+ # @!attribute [rw] next_token
7669
+ # The next item following a partial list of returned items. For
7670
+ # example, if a request is made to return `MaxResults` number of
7671
+ # items, `NextToken` allows you to return more items in your list
7672
+ # starting at the location pointed to by the next token.
7673
+ # @return [String]
7674
+ #
7675
+ # @!attribute [rw] tags
7676
+ # Information about the tags.
7677
+ # @return [Hash<String,String>]
7678
+ #
7679
+ # @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/ListTagsOutput AWS API Documentation
7680
+ #
7681
+ class ListTagsOutput < Struct.new(
7682
+ :next_token,
7683
+ :tags)
7684
+ SENSITIVE = [:tags]
7685
+ include Aws::Structure
7686
+ end
7687
+
7688
+ # @!attribute [rw] max_results
7689
+ # The maximum number of items to be returned.
7690
+ # @return [Integer]
7691
+ #
7692
+ # @!attribute [rw] next_token
7693
+ # The next item following a partial list of returned items. For
7694
+ # example, if a request is made to return `MaxResults` number of
7695
+ # items, `NextToken` allows you to return more items in your list
7696
+ # starting at the location pointed to by the next token.
7697
+ # @return [String]
7698
+ #
7699
+ # @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/ListTieringConfigurationsInput AWS API Documentation
7700
+ #
7701
+ class ListTieringConfigurationsInput < Struct.new(
7702
+ :max_results,
7703
+ :next_token)
7704
+ SENSITIVE = []
7705
+ include Aws::Structure
7706
+ end
7707
+
7708
+ # @!attribute [rw] tiering_configurations
7709
+ # An array of tiering configurations returned by the
7710
+ # `ListTieringConfigurations` call.
7711
+ # @return [Array<Types::TieringConfigurationsListMember>]
7712
+ #
7713
+ # @!attribute [rw] next_token
7714
+ # The next item following a partial list of returned items. For
7715
+ # example, if a request is made to return `MaxResults` number of
7716
+ # items, `NextToken` allows you to return more items in your list
7717
+ # starting at the location pointed to by the next token.
7718
+ # @return [String]
7719
+ #
7720
+ # @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/ListTieringConfigurationsOutput AWS API Documentation
7721
+ #
7722
+ class ListTieringConfigurationsOutput < Struct.new(
7723
+ :tiering_configurations,
7724
+ :next_token)
7725
+ SENSITIVE = []
7726
+ include Aws::Structure
7727
+ end
7728
+
7729
+ # Indicates that a required parameter is missing.
7730
+ #
7731
+ # @!attribute [rw] code
7732
+ # @return [String]
7733
+ #
7734
+ # @!attribute [rw] message
7735
+ # @return [String]
7736
+ #
7737
+ # @!attribute [rw] type
7738
+ # @return [String]
7739
+ #
7740
+ # @!attribute [rw] context
7741
+ # @return [String]
7742
+ #
7743
+ # @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/MissingParameterValueException AWS API Documentation
7744
+ #
7745
+ class MissingParameterValueException < Struct.new(
7746
+ :code,
7747
+ :message,
7748
+ :type,
7749
+ :context)
7750
+ SENSITIVE = []
7751
+ include Aws::Structure
7752
+ end
7753
+
7754
+ # A structure that contains information about a backed-up resource.
7755
+ #
7756
+ # @!attribute [rw] resource_arn
7757
+ # An Amazon Resource Name (ARN) that uniquely identifies a resource.
7758
+ # The format of the ARN depends on the resource type.
7759
+ # @return [String]
7760
+ #
7761
+ # @!attribute [rw] resource_type
7762
+ # The type of Amazon Web Services resource; for example, an Amazon
7763
+ # Elastic Block Store (Amazon EBS) volume or an Amazon Relational
7764
+ # Database Service (Amazon RDS) database. For Windows Volume Shadow
7765
+ # Copy Service (VSS) backups, the only supported resource type is
7766
+ # Amazon EC2.
7767
+ # @return [String]
7768
+ #
7769
+ # @!attribute [rw] last_backup_time
7770
+ # The date and time a resource was last backed up, in Unix format and
7323
7771
  # Coordinated Universal Time (UTC). The value of `LastBackupTime` is
7324
7772
  # accurate to milliseconds. For example, the value 1516925490.087
7325
7773
  # represents Friday, January 26, 2018 12:11:30.087 AM.
@@ -7714,6 +8162,11 @@ module Aws::Backup
7714
8162
  # Web Services\_OWNED\_KMS\_KEY for Amazon Web Services-owned keys.
7715
8163
  # @return [String]
7716
8164
  #
8165
+ # @!attribute [rw] aggregated_scan_result
8166
+ # Contains the latest scanning results against the recovery point and
8167
+ # currently include `FailedScan`, `Findings`, `LastComputed`.
8168
+ # @return [Types::AggregatedScanResult]
8169
+ #
7717
8170
  # @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/RecoveryPointByBackupVault AWS API Documentation
7718
8171
  #
7719
8172
  class RecoveryPointByBackupVault < Struct.new(
@@ -7743,7 +8196,8 @@ module Aws::Backup
7743
8196
  :vault_type,
7744
8197
  :index_status,
7745
8198
  :index_status_message,
7746
- :encryption_key_type)
8199
+ :encryption_key_type,
8200
+ :aggregated_scan_result)
7747
8201
  SENSITIVE = []
7748
8202
  include Aws::Structure
7749
8203
  end
@@ -7828,6 +8282,11 @@ module Aws::Backup
7828
8282
  # Web Services\_OWNED\_KMS\_KEY for Amazon Web Services-owned keys.
7829
8283
  # @return [String]
7830
8284
  #
8285
+ # @!attribute [rw] aggregated_scan_result
8286
+ # Contains the latest scanning results against the recovery point and
8287
+ # currently include `FailedScan`, `Findings`, `LastComputed`.
8288
+ # @return [Types::AggregatedScanResult]
8289
+ #
7831
8290
  # @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/RecoveryPointByResource AWS API Documentation
7832
8291
  #
7833
8292
  class RecoveryPointByResource < Struct.new(
@@ -7844,7 +8303,8 @@ module Aws::Backup
7844
8303
  :vault_type,
7845
8304
  :index_status,
7846
8305
  :index_status_message,
7847
- :encryption_key_type)
8306
+ :encryption_key_type,
8307
+ :aggregated_scan_result)
7848
8308
  SENSITIVE = []
7849
8309
  include Aws::Structure
7850
8310
  end
@@ -8192,7 +8652,8 @@ module Aws::Backup
8192
8652
  # using a report template. The report templates are:
8193
8653
  #
8194
8654
  # `RESOURCE_COMPLIANCE_REPORT | CONTROL_COMPLIANCE_REPORT |
8195
- # BACKUP_JOB_REPORT | COPY_JOB_REPORT | RESTORE_JOB_REPORT`
8655
+ # BACKUP_JOB_REPORT | COPY_JOB_REPORT | RESTORE_JOB_REPORT |
8656
+ # SCAN_JOB_REPORT`
8196
8657
  # @return [String]
8197
8658
  #
8198
8659
  # @!attribute [rw] framework_arns
@@ -9225,6 +9686,354 @@ module Aws::Backup
9225
9686
  include Aws::Structure
9226
9687
  end
9227
9688
 
9689
+ # Defines a scanning action that specifies the malware scanner and scan
9690
+ # mode to use.
9691
+ #
9692
+ # @!attribute [rw] malware_scanner
9693
+ # The malware scanner to use for the scan action. Currently only
9694
+ # `GUARDDUTY` is supported.
9695
+ # @return [String]
9696
+ #
9697
+ # @!attribute [rw] scan_mode
9698
+ # The scanning mode to use for the scan action.
9699
+ #
9700
+ # Valid values: `FULL_SCAN` \| `INCREMENTAL_SCAN`.
9701
+ # @return [String]
9702
+ #
9703
+ # @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/ScanAction AWS API Documentation
9704
+ #
9705
+ class ScanAction < Struct.new(
9706
+ :malware_scanner,
9707
+ :scan_mode)
9708
+ SENSITIVE = []
9709
+ include Aws::Structure
9710
+ end
9711
+
9712
+ # Contains metadata about a scan job, including information about the
9713
+ # scanning process, results, and associated resources.
9714
+ #
9715
+ # @!attribute [rw] account_id
9716
+ # The account ID that owns the scan job.
9717
+ # @return [String]
9718
+ #
9719
+ # @!attribute [rw] backup_vault_arn
9720
+ # An Amazon Resource Name (ARN) that uniquely identifies a backup
9721
+ # vault; for example,
9722
+ # `arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault`.
9723
+ # @return [String]
9724
+ #
9725
+ # @!attribute [rw] backup_vault_name
9726
+ # The name of a logical container where backups are stored. Backup
9727
+ # vaults are identified by names that are unique to the account used
9728
+ # to create them and the Amazon Web Services Region where they are
9729
+ # created.
9730
+ # @return [String]
9731
+ #
9732
+ # @!attribute [rw] completion_date
9733
+ # The date and time that a scan job is completed, in Unix format and
9734
+ # Coordinated Universal Time (UTC). The value of `CompletionDate` is
9735
+ # accurate to milliseconds. For example, the value 1516925490.087
9736
+ # represents Friday, January 26, 2018 12:11:30.087 AM.
9737
+ # @return [Time]
9738
+ #
9739
+ # @!attribute [rw] created_by
9740
+ # Contains identifying information about the creation of a scan job.
9741
+ # @return [Types::ScanJobCreator]
9742
+ #
9743
+ # @!attribute [rw] creation_date
9744
+ # The date and time that a scan job is created, in Unix format and
9745
+ # Coordinated Universal Time (UTC). The value of `CreationDate` is
9746
+ # accurate to milliseconds. For example, the value 1516925490.087
9747
+ # represents Friday, January 26, 2018 12:11:30.087 AM.
9748
+ # @return [Time]
9749
+ #
9750
+ # @!attribute [rw] iam_role_arn
9751
+ # Specifies the IAM role ARN used to create the scan job; for example,
9752
+ # `arn:aws:iam::123456789012:role/S3Access`.
9753
+ # @return [String]
9754
+ #
9755
+ # @!attribute [rw] malware_scanner
9756
+ # The scanning engine used for the scan job. Currently only
9757
+ # `GUARDDUTY` is supported.
9758
+ # @return [String]
9759
+ #
9760
+ # @!attribute [rw] recovery_point_arn
9761
+ # An ARN that uniquely identifies the recovery point being scanned;
9762
+ # for example,
9763
+ # `arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45`.
9764
+ # @return [String]
9765
+ #
9766
+ # @!attribute [rw] resource_arn
9767
+ # An ARN that uniquely identifies the source resource of the recovery
9768
+ # point being scanned.
9769
+ # @return [String]
9770
+ #
9771
+ # @!attribute [rw] resource_name
9772
+ # The non-unique name of the resource that belongs to the specified
9773
+ # backup.
9774
+ # @return [String]
9775
+ #
9776
+ # @!attribute [rw] resource_type
9777
+ # The type of Amazon Web Services resource being scanned; for example,
9778
+ # an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon
9779
+ # Relational Database Service (Amazon RDS) database.
9780
+ # @return [String]
9781
+ #
9782
+ # @!attribute [rw] scan_base_recovery_point_arn
9783
+ # An ARN that uniquely identifies the base recovery point for
9784
+ # scanning. This field is populated when an incremental scan job has
9785
+ # taken place.
9786
+ # @return [String]
9787
+ #
9788
+ # @!attribute [rw] scan_id
9789
+ # The scan ID generated by the malware scanner for the corresponding
9790
+ # scan job.
9791
+ # @return [String]
9792
+ #
9793
+ # @!attribute [rw] scan_job_id
9794
+ # The unique identifier that identifies the scan job request to
9795
+ # Backup.
9796
+ # @return [String]
9797
+ #
9798
+ # @!attribute [rw] scan_mode
9799
+ # Specifies the scan type use for the scan job.
9800
+ #
9801
+ # Includes:
9802
+ #
9803
+ # `FULL_SCAN` will scan the entire data lineage within the backup.
9804
+ #
9805
+ # `INCREMENTAL_SCAN` will scan the data difference between the target
9806
+ # recovery point and base recovery point ARN.
9807
+ # @return [String]
9808
+ #
9809
+ # @!attribute [rw] scan_result
9810
+ # Contains the scan results information, including the status of
9811
+ # threats found during scanning.
9812
+ # @return [Types::ScanResultInfo]
9813
+ #
9814
+ # @!attribute [rw] scanner_role_arn
9815
+ # Specifies the scanner IAM role ARN used for the scan job.
9816
+ # @return [String]
9817
+ #
9818
+ # @!attribute [rw] state
9819
+ # The current state of the scan job.
9820
+ #
9821
+ # Valid values: `CREATED` \| `RUNNING` \| `COMPLETED` \|
9822
+ # `COMPLETED_WITH_ISSUES` \| `FAILED` \| `CANCELED`.
9823
+ # @return [String]
9824
+ #
9825
+ # @!attribute [rw] status_message
9826
+ # A detailed message explaining the status of the scan job.
9827
+ # @return [String]
9828
+ #
9829
+ # @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/ScanJob AWS API Documentation
9830
+ #
9831
+ class ScanJob < Struct.new(
9832
+ :account_id,
9833
+ :backup_vault_arn,
9834
+ :backup_vault_name,
9835
+ :completion_date,
9836
+ :created_by,
9837
+ :creation_date,
9838
+ :iam_role_arn,
9839
+ :malware_scanner,
9840
+ :recovery_point_arn,
9841
+ :resource_arn,
9842
+ :resource_name,
9843
+ :resource_type,
9844
+ :scan_base_recovery_point_arn,
9845
+ :scan_id,
9846
+ :scan_job_id,
9847
+ :scan_mode,
9848
+ :scan_result,
9849
+ :scanner_role_arn,
9850
+ :state,
9851
+ :status_message)
9852
+ SENSITIVE = []
9853
+ include Aws::Structure
9854
+ end
9855
+
9856
+ # Contains identifying information about the creation of a scan job,
9857
+ # including the backup plan and rule that initiated the scan.
9858
+ #
9859
+ # @!attribute [rw] backup_plan_arn
9860
+ # An Amazon Resource Name (ARN) that uniquely identifies a backup
9861
+ # plan; for example,
9862
+ # `arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50`.
9863
+ # @return [String]
9864
+ #
9865
+ # @!attribute [rw] backup_plan_id
9866
+ # The ID of the backup plan.
9867
+ # @return [String]
9868
+ #
9869
+ # @!attribute [rw] backup_plan_version
9870
+ # Unique, randomly generated, Unicode, UTF-8 encoded strings that are
9871
+ # at most 1,024 bytes long. Version IDs cannot be edited.
9872
+ # @return [String]
9873
+ #
9874
+ # @!attribute [rw] backup_rule_id
9875
+ # Uniquely identifies the backup rule that initiated the scan job.
9876
+ # @return [String]
9877
+ #
9878
+ # @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/ScanJobCreator AWS API Documentation
9879
+ #
9880
+ class ScanJobCreator < Struct.new(
9881
+ :backup_plan_arn,
9882
+ :backup_plan_id,
9883
+ :backup_plan_version,
9884
+ :backup_rule_id)
9885
+ SENSITIVE = []
9886
+ include Aws::Structure
9887
+ end
9888
+
9889
+ # Contains summary information about scan jobs, including counts and
9890
+ # metadata for a specific time period and criteria.
9891
+ #
9892
+ # @!attribute [rw] region
9893
+ # The Amazon Web Services Region where the scan jobs were executed.
9894
+ # @return [String]
9895
+ #
9896
+ # @!attribute [rw] account_id
9897
+ # The account ID that owns the scan jobs included in this summary.
9898
+ # @return [String]
9899
+ #
9900
+ # @!attribute [rw] state
9901
+ # The state of the scan jobs included in this summary.
9902
+ #
9903
+ # Valid values: `CREATED` \| `RUNNING` \| `COMPLETED` \|
9904
+ # `COMPLETED_WITH_ISSUES` \| `FAILED` \| `CANCELED`.
9905
+ # @return [String]
9906
+ #
9907
+ # @!attribute [rw] resource_type
9908
+ # The type of Amazon Web Services resource for the scan jobs included
9909
+ # in this summary.
9910
+ # @return [String]
9911
+ #
9912
+ # @!attribute [rw] count
9913
+ # The number of scan jobs that match the specified criteria.
9914
+ # @return [Integer]
9915
+ #
9916
+ # @!attribute [rw] start_time
9917
+ # The value of time in number format of a job start time.
9918
+ #
9919
+ # This value is the time in Unix format, Coordinated Universal Time
9920
+ # (UTC), and accurate to milliseconds. For example, the value
9921
+ # 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
9922
+ # @return [Time]
9923
+ #
9924
+ # @!attribute [rw] end_time
9925
+ # The value of time in number format of a job end time.
9926
+ #
9927
+ # This value is the time in Unix format, Coordinated Universal Time
9928
+ # (UTC), and accurate to milliseconds. For example, the value
9929
+ # 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
9930
+ # @return [Time]
9931
+ #
9932
+ # @!attribute [rw] malware_scanner
9933
+ # Specifies the malware scanner used during the scan job. Currently
9934
+ # only supports `GUARDDUTY`.
9935
+ # @return [String]
9936
+ #
9937
+ # @!attribute [rw] scan_result_status
9938
+ # The scan result status for the scan jobs included in this summary.
9939
+ #
9940
+ # Valid values: `THREATS_FOUND` \| `NO_THREATS_FOUND`.
9941
+ # @return [String]
9942
+ #
9943
+ # @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/ScanJobSummary AWS API Documentation
9944
+ #
9945
+ class ScanJobSummary < Struct.new(
9946
+ :region,
9947
+ :account_id,
9948
+ :state,
9949
+ :resource_type,
9950
+ :count,
9951
+ :start_time,
9952
+ :end_time,
9953
+ :malware_scanner,
9954
+ :scan_result_status)
9955
+ SENSITIVE = []
9956
+ include Aws::Structure
9957
+ end
9958
+
9959
+ # Contains the results of a security scan, including scanner
9960
+ # information, scan state, and any findings discovered.
9961
+ #
9962
+ # @!attribute [rw] malware_scanner
9963
+ # The malware scanner used to perform the scan. Currently only
9964
+ # `GUARDDUTY` is supported.
9965
+ # @return [String]
9966
+ #
9967
+ # @!attribute [rw] scan_job_state
9968
+ # The final state of the scan job.
9969
+ #
9970
+ # Valid values: `COMPLETED` \| `FAILED` \| `CANCELED`.
9971
+ # @return [String]
9972
+ #
9973
+ # @!attribute [rw] last_scan_timestamp
9974
+ # The timestamp of when the last scan was performed, in Unix format
9975
+ # and Coordinated Universal Time (UTC).
9976
+ # @return [Time]
9977
+ #
9978
+ # @!attribute [rw] findings
9979
+ # An array of findings discovered during the scan.
9980
+ # @return [Array<String>]
9981
+ #
9982
+ # @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/ScanResult AWS API Documentation
9983
+ #
9984
+ class ScanResult < Struct.new(
9985
+ :malware_scanner,
9986
+ :scan_job_state,
9987
+ :last_scan_timestamp,
9988
+ :findings)
9989
+ SENSITIVE = []
9990
+ include Aws::Structure
9991
+ end
9992
+
9993
+ # Contains information about the results of a scan job.
9994
+ #
9995
+ # @!attribute [rw] scan_result_status
9996
+ # The status of the scan results.
9997
+ #
9998
+ # Valid values: `THREATS_FOUND` \| `NO_THREATS_FOUND`.
9999
+ # @return [String]
10000
+ #
10001
+ # @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/ScanResultInfo AWS API Documentation
10002
+ #
10003
+ class ScanResultInfo < Struct.new(
10004
+ :scan_result_status)
10005
+ SENSITIVE = []
10006
+ include Aws::Structure
10007
+ end
10008
+
10009
+ # Contains configuration settings for malware scanning, including the
10010
+ # scanner type, target resource types, and scanner role.
10011
+ #
10012
+ # @!attribute [rw] malware_scanner
10013
+ # The malware scanner to use for scanning. Currently only `GUARDDUTY`
10014
+ # is supported.
10015
+ # @return [String]
10016
+ #
10017
+ # @!attribute [rw] resource_types
10018
+ # An array of resource types to be scanned for malware.
10019
+ # @return [Array<String>]
10020
+ #
10021
+ # @!attribute [rw] scanner_role_arn
10022
+ # The Amazon Resource Name (ARN) of the IAM role that the scanner uses
10023
+ # to access resources; for example,
10024
+ # `arn:aws:iam::123456789012:role/ScannerRole`.
10025
+ # @return [String]
10026
+ #
10027
+ # @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/ScanSetting AWS API Documentation
10028
+ #
10029
+ class ScanSetting < Struct.new(
10030
+ :malware_scanner,
10031
+ :resource_types,
10032
+ :scanner_role_arn)
10033
+ SENSITIVE = []
10034
+ include Aws::Structure
10035
+ end
10036
+
9228
10037
  # Contains information about a scheduled backup plan execution,
9229
10038
  # including the execution time, rule type, and associated rule
9230
10039
  # identifier.
@@ -9738,6 +10547,94 @@ module Aws::Backup
9738
10547
  include Aws::Structure
9739
10548
  end
9740
10549
 
10550
+ # @!attribute [rw] backup_vault_name
10551
+ # The name of a logical container where backups are stored. Backup
10552
+ # vaults are identified by names that are unique to the account used
10553
+ # to create them and the Amazon Web Services Region where they are
10554
+ # created.
10555
+ #
10556
+ # Pattern: `^[a-zA-Z0-9\-\_]{2,50}$`
10557
+ # @return [String]
10558
+ #
10559
+ # @!attribute [rw] iam_role_arn
10560
+ # Specifies the IAM role ARN used to create the target recovery point;
10561
+ # for example, `arn:aws:iam::123456789012:role/S3Access`.
10562
+ # @return [String]
10563
+ #
10564
+ # @!attribute [rw] idempotency_token
10565
+ # A customer-chosen string that you can use to distinguish between
10566
+ # otherwise identical calls to `StartScanJob`. Retrying a successful
10567
+ # request with the same idempotency token results in a success message
10568
+ # with no action taken.
10569
+ # @return [String]
10570
+ #
10571
+ # @!attribute [rw] malware_scanner
10572
+ # Specifies the malware scanner used during the scan job. Currently
10573
+ # only supports `GUARDDUTY`.
10574
+ # @return [String]
10575
+ #
10576
+ # @!attribute [rw] recovery_point_arn
10577
+ # An Amazon Resource Name (ARN) that uniquely identifies a recovery
10578
+ # point. This is your target recovery point for a full scan. If you
10579
+ # are running an incremental scan, this will be your a recovery point
10580
+ # which has been created after your base recovery point selection.
10581
+ # @return [String]
10582
+ #
10583
+ # @!attribute [rw] scan_base_recovery_point_arn
10584
+ # An ARN that uniquely identifies the base recovery point to be used
10585
+ # for incremental scanning.
10586
+ # @return [String]
10587
+ #
10588
+ # @!attribute [rw] scan_mode
10589
+ # Specifies the scan type use for the scan job.
10590
+ #
10591
+ # Includes:
10592
+ #
10593
+ # * `FULL_SCAN` will scan the entire data lineage within the backup.
10594
+ #
10595
+ # * `INCREMENTAL_SCAN` will scan the data difference between the
10596
+ # target recovery point and base recovery point ARN.
10597
+ # @return [String]
10598
+ #
10599
+ # @!attribute [rw] scanner_role_arn
10600
+ # Specified the IAM scanner role ARN.
10601
+ # @return [String]
10602
+ #
10603
+ # @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/StartScanJobInput AWS API Documentation
10604
+ #
10605
+ class StartScanJobInput < Struct.new(
10606
+ :backup_vault_name,
10607
+ :iam_role_arn,
10608
+ :idempotency_token,
10609
+ :malware_scanner,
10610
+ :recovery_point_arn,
10611
+ :scan_base_recovery_point_arn,
10612
+ :scan_mode,
10613
+ :scanner_role_arn)
10614
+ SENSITIVE = []
10615
+ include Aws::Structure
10616
+ end
10617
+
10618
+ # @!attribute [rw] creation_date
10619
+ # The date and time that a backup job is created, in Unix format and
10620
+ # Coordinated Universal Time (UTC). The value of `CreationDate` is
10621
+ # accurate to milliseconds. For example, the value 1516925490.087
10622
+ # represents Friday, January 26, 2018 12:11:30.087 AM.
10623
+ # @return [Time]
10624
+ #
10625
+ # @!attribute [rw] scan_job_id
10626
+ # Uniquely identifies a request to Backup to back up a resource.
10627
+ # @return [String]
10628
+ #
10629
+ # @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/StartScanJobOutput AWS API Documentation
10630
+ #
10631
+ class StartScanJobOutput < Struct.new(
10632
+ :creation_date,
10633
+ :scan_job_id)
10634
+ SENSITIVE = []
10635
+ include Aws::Structure
10636
+ end
10637
+
9741
10638
  # @!attribute [rw] backup_job_id
9742
10639
  # Uniquely identifies a request to Backup to back up a resource.
9743
10640
  # @return [String]
@@ -9994,6 +10891,12 @@ module Aws::Backup
9994
10891
  # Contains a list of `BackupOptions` for each resource type.
9995
10892
  # @return [Array<Types::AdvancedBackupSetting>]
9996
10893
  #
10894
+ # @!attribute [rw] scan_settings
10895
+ # Contains your scanning configuration for the backup plan and
10896
+ # includes the Malware scanner, your selected resources, and scanner
10897
+ # role.
10898
+ # @return [Array<Types::ScanSetting>]
10899
+ #
9997
10900
  # @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/UpdateBackupPlanOutput AWS API Documentation
9998
10901
  #
9999
10902
  class UpdateBackupPlanOutput < Struct.new(
@@ -10001,7 +10904,8 @@ module Aws::Backup
10001
10904
  :backup_plan_arn,
10002
10905
  :creation_date,
10003
10906
  :version_id,
10004
- :advanced_backup_settings)
10907
+ :advanced_backup_settings,
10908
+ :scan_settings)
10005
10909
  SENSITIVE = []
10006
10910
  include Aws::Structure
10007
10911
  end