Values (p.awso.0.9.0.doc.awso.backup.Awso

Sourceval service : Awso.Service.t

Sourceval apiVersion : string

Sourceval endpointPrefix : string

Sourceval serviceFullName : string

Sourceval signatureVersion : string

Sourceval protocol : string

Sourceval globalEndpoint : string

Sourceval simple_to_json : ('a -> Awso__Botodata.value) -> 'a -> Yojson.Safe.t

Sourceval composed_to_json : ('a -> Awso__Botodata.value) -> 'a -> Yojson.Safe.t

Sourceval to_query : ('a -> Awso.Client.Query.value) -> 'a -> Awso.Client.Query.t

Source

val structure_to_value_aux : 
  ('a * 'b option) list ->
  f:(('a * 'b) list -> 'c) ->
  [> `Structure of 'c ]

Source

val structure_to_value : 
  ('a * 'b option) list ->
  [> `Structure of ('a * 'b) list ]

Source

val structure_to_wrapped_value : 
  wrapper:'a ->
  response:'a ->
  ('b * 'c option) list ->
  [> `Structure of ('a * [> `Structure of ('b * 'c) list ]) list ]

Sourcemodule Boolean : sig ... end

Sourcemodule LifecycleDeleteAfterEvent : sig ... end

Sourcemodule Long : sig ... end

Sourcemodule ResourceType : sig ... end

Sourcemodule ARN : sig ... end

Sourcemodule Lifecycle : sig ... end

Specifies the time period, in days, before a recovery point transitions to cold storage or is deleted. Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, on the console, the retention setting must be 90 days greater than the transition to cold after days setting. The transition to cold after days setting can't be changed after a backup has been transitioned to cold. Resource types that can transition to cold storage are listed in the Feature availability by resource table. Backup ignores this expression for other resource types. To remove the existing lifecycle and retention periods and keep your recovery points indefinitely, specify -1 for MoveToColdStorageAfterDays and DeleteAfterDays.

Sourcemodule ResourceTypes : sig ... end

Sourcemodule MalwareScanner : sig ... end

Sourcemodule ScanMode : sig ... end

Sourcemodule BackupOptionKey : sig ... end

Sourcemodule BackupOptionValue : sig ... end

Sourcemodule String_ : sig ... end

Sourcemodule ParameterName : sig ... end

Sourcemodule ParameterValue : sig ... end

Sourcemodule CopyAction : sig ... end

The details of the copy operation.

Sourcemodule IndexAction : sig ... end

This is an optional array within a BackupRule. IndexAction consists of one ResourceTypes.

Sourcemodule ScanAction : sig ... end

Defines a scanning action that specifies the malware scanner and scan mode to use.

Sourcemodule TagKey : sig ... end

Sourcemodule TagValue : sig ... end

Sourcemodule ScanFinding : sig ... end

Sourcemodule BackupOptions : sig ... end

Sourcemodule ConditionKey : sig ... end

Sourcemodule ConditionValue : sig ... end

Sourcemodule ResourceArns : sig ... end

Sourcemodule TieringDownSettingsInDays : sig ... end

Sourcemodule KeyValue : sig ... end

Pair of two related strings. Allowed characters are letters, white space, and numbers that can be represented in UTF-8 and the following characters: + - = . _ : /

Sourcemodule RestoreTestingRecoveryPointType : sig ... end

Sourcemodule ControlInputParameter : sig ... end

The parameters for a control. A control can have zero, one, or more than one parameter. An example of a control with two parameters is: "backup plan frequency is at least daily and the retention period is at least 1 year". The first parameter is daily. The second parameter is 1 year.

Sourcemodule ComplianceResourceIdList : sig ... end

Sourcemodule ResourceTypeList : sig ... end

Sourcemodule StringMap : sig ... end

Sourcemodule BackupRuleName : sig ... end

Sourcemodule BackupVaultName : sig ... end

Sourcemodule CopyActions : sig ... end

Sourcemodule CronExpression : sig ... end

Sourcemodule IndexActions : sig ... end

Sourcemodule ScanActions : sig ... end

Sourcemodule Tags : sig ... end

Sourcemodule Timezone : sig ... end

Sourcemodule WindowMinutes : sig ... end

Sourcemodule IAMRoleArn : sig ... end

Sourcemodule ScanResultStatus : sig ... end

Sourcemodule MpaRevokeSessionStatus : sig ... end

Sourcemodule FormatList : sig ... end

Sourcemodule Integer : sig ... end

Sourcemodule StringList : sig ... end

Sourcemodule ScanFindings : sig ... end

Sourcemodule CopyJobState : sig ... end

Sourcemodule AdvancedBackupSetting : sig ... end

The backup options for each resource type.

Sourcemodule ConditionParameter : sig ... end

Includes information about tags you define to assign tagged resources to a backup plan. Include the prefix aws:ResourceTag in your tags. For example, "aws:ResourceTag/TagKey1": "Value1".

Sourcemodule ConditionType : sig ... end

Sourcemodule ResourceSelection : sig ... end

This contains metadata about resource selection for tiering configurations. You can specify up to 5 different resource selections per tiering configuration. Data moved to lower-cost tier remains there until deletion (one-way transition).

Sourcemodule KeyValueList : sig ... end

Sourcemodule RestoreTestingRecoveryPointSelectionAlgorithm : sig ... end

Sourcemodule RestoreTestingRecoveryPointTypeList : sig ... end

Sourcemodule ControlInputParameters : sig ... end

Sourcemodule ControlName : sig ... end

Sourcemodule ControlScope : sig ... end

A framework consists of one or more controls. Each control has its own control scope. The control scope can include one or more resource types, a combination of a tag key and value, or a combination of one resource type and one resource ID. If no scope is specified, evaluations for the rule are triggered when any resource in your recording group changes in configuration. To set a control scope that includes all of a particular resource, leave the ControlScope empty or do not pass it when calling CreateFramework.

Sourcemodule BackupRuleInput : sig ... end

Specifies a scheduled task used to back up a selection of resources.

Sourcemodule ScanSetting : sig ... end

Contains configuration settings for malware scanning, including the scanner type, target resource types, and scanner role.

Sourcemodule BackupVaultNameOrWildcard : sig ... end

Sourcemodule TieringConfigurationName : sig ... end

Sourcemodule ScanJobCreator : sig ... end

Contains identifying information about the creation of a scan job, including the backup plan and rule that initiated the scan.

Sourcemodule ScanResourceType : sig ... end

Sourcemodule ScanResultInfo : sig ... end

Contains information about the results of a scan job.

Sourcemodule ScanState : sig ... end

Sourcemodule Timestamp : sig ... end

Sourcemodule AccountId : sig ... end

Sourcemodule Region : sig ... end

Sourcemodule ScanJobStatus : sig ... end

Sourcemodule RestoreDeletionStatus : sig ... end

Sourcemodule RestoreJobCreator : sig ... end

Contains information about the restore testing plan that Backup used to initiate the restore job.

Sourcemodule RestoreJobStatus : sig ... end

Sourcemodule RestoreValidationStatus : sig ... end

Sourcemodule RestoreJobState : sig ... end

Sourcemodule LatestRevokeRequest : sig ... end

Contains information about the latest request to revoke access to a backup vault.

Sourcemodule VaultState : sig ... end

Sourcemodule ReportDeliveryChannel : sig ... end

Contains information from your report plan about where to deliver your reports, specifically your Amazon S3 bucket name, S3 key prefix, and the formats of your reports.

Sourcemodule ReportPlanDescription : sig ... end

Sourcemodule ReportPlanName : sig ... end

Sourcemodule ReportSetting : sig ... end

Contains detailed information about a report setting.

Sourcemodule ReportDestination : sig ... end

Contains information from your report job about your report destination.

Sourcemodule ReportJobId : sig ... end

Sourcemodule AggregatedScanResult : sig ... end

Contains aggregated scan results across multiple scan operations, providing a summary of scan status and findings.

Sourcemodule EncryptionKeyType : sig ... end

Sourcemodule IndexStatus : sig ... end

Sourcemodule RecoveryPointStatus : sig ... end

Sourcemodule VaultType : sig ... end

Sourcemodule CalculatedLifecycle : sig ... end

Contains DeleteAt and MoveToColdStorageAt timestamps, which are used to specify a lifecycle for a recovery point. The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. Backup transitions and expires backups automatically according to the lifecycle that you define. Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, the “retention” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold. Resource types that can transition to cold storage are listed in the Feature availability by resource table. Backup ignores this expression for other resource types.

Sourcemodule RecoveryPointCreator : sig ... end

Contains information about the backup plan and rule that Backup used to initiate the recovery point backup.

Sourcemodule LegalHoldStatus : sig ... end

Sourcemodule FrameworkDescription : sig ... end

Sourcemodule FrameworkName : sig ... end

Sourcemodule CopyJobChildJobsInState : sig ... end

Sourcemodule CopyJobStatus : sig ... end

Sourcemodule MessageCategory : sig ... end

Sourcemodule BackupSelectionName : sig ... end

Sourcemodule AdvancedBackupSettings : sig ... end

Sourcemodule BackupPlanName : sig ... end

Sourcemodule BackupJobState : sig ... end

Sourcemodule BackupJobStatus : sig ... end

Sourcemodule ConditionParameters : sig ... end

Sourcemodule Condition : sig ... end

Contains an array of triplets made up of a condition type (such as StringEquals), a key, and a value. Used to filter resources using their tags and assign them to a backup plan. Case sensitive.

Sourcemodule BackupRule : sig ... end

Specifies a scheduled task used to back up a selection of resources.

Sourcemodule RuleExecutionType : sig ... end

Sourcemodule ScanJobState : sig ... end

Sourcemodule ResourceSelections : sig ... end

Sourcemodule ProtectedResourceConditions : sig ... end

The conditions that you define for resources in your restore testing plan using tags.

Sourcemodule SensitiveStringMap : sig ... end

Sourcemodule RestoreTestingRecoveryPointSelection : sig ... end

RecoveryPointSelection has five parameters (three required and two optional). The values you specify determine which recovery point is included in the restore test. You must indicate with Algorithm if you want the latest recovery point within your SelectionWindowDays or if you want a random recovery point, and you must indicate through IncludeVaults from which vaults the recovery points can be chosen. Algorithm (required) Valid values: "LATEST_WITHIN_WINDOW" or "RANDOM_WITHIN_WINDOW". Recovery point types (required) Valid values: "SNAPSHOT" and/or "CONTINUOUS". Include SNAPSHOT to restore only snapshot recovery points; include CONTINUOUS to restore continuous recovery points (point in time restore / PITR); use both to restore either a snapshot or a continuous recovery point. The recovery point will be determined by the value for Algorithm. IncludeVaults (required). You must include one or more backup vaults. Use the wildcard ["*"] or specific ARNs. SelectionWindowDays (optional) Value must be an integer (in days) from 1 to 365. If not included, the value defaults to 30. ExcludeVaults (optional). You can choose to input one or more specific backup vault ARNs to exclude those vaults' contents from restore eligibility. Or, you can include a list of selectors. If this parameter and its value are not included, it defaults to empty list.

Sourcemodule IsEnabled : sig ... end

Sourcemodule GlobalSettingsName : sig ... end

Sourcemodule GlobalSettingsValue : sig ... end

Sourcemodule FrameworkControl : sig ... end

Contains detailed information about all of the controls of a framework. Each framework must contain at least one control.

Sourcemodule BackupRulesInput : sig ... end

Sourcemodule ScanSettings : sig ... end

Sourcemodule MetadataKey : sig ... end

Sourcemodule MetadataValue : sig ... end

Sourcemodule BackupVaultEvent : sig ... end

Sourcemodule TieringConfigurationsListMember : sig ... end

This contains metadata about a tiering configuration returned in a list.

Sourcemodule ScanJob : sig ... end

Contains metadata about a scan job, including information about the scanning process, results, and associated resources.

Sourcemodule ScanJobSummary : sig ... end

Contains summary information about scan jobs, including counts and metadata for a specific time period and criteria.

Sourcemodule RestoreTestingSelectionForList : sig ... end

This contains metadata about a restore testing selection.

Sourcemodule RestoreTestingPlanForList : sig ... end

This contains metadata about a restore testing plan.

Sourcemodule RestoreJobsListMember : sig ... end

Contains metadata about a restore job.

Sourcemodule RestoreJobSummary : sig ... end

This is a summary of restore jobs created or running within the most recent 30 days. The returned summary may contain the following: Region, Account, State, ResourceType, MessageCategory, StartTime, EndTime, and Count of included jobs.

Sourcemodule RestoreAccessBackupVaultListMember : sig ... end

Contains information about a restore access backup vault.

Sourcemodule ReportPlan : sig ... end

Contains detailed information about a report plan.

Sourcemodule ReportJob : sig ... end

Contains detailed information about a report job. A report job compiles a report based on a report plan and publishes it to Amazon S3.

Sourcemodule RecoveryPointByResource : sig ... end

Contains detailed information about a saved recovery point.

Sourcemodule RecoveryPointMember : sig ... end

This is a recovery point which is a child (nested) recovery point of a parent (composite) recovery point. These recovery points can be disassociated from their parent (composite) recovery point, in which case they will no longer be a member.

Sourcemodule RecoveryPointByBackupVault : sig ... end

Contains detailed information about the recovery points stored in a backup vault.

Sourcemodule ProtectedResource : sig ... end

A structure that contains information about a backed-up resource.

Sourcemodule LegalHold : sig ... end

A legal hold is an administrative tool that helps prevent backups from being deleted while under a hold. While the hold is in place, backups under a hold cannot be deleted and lifecycle policies that would alter the backup status (such as transition to cold storage) are delayed until the legal hold is removed. A backup can have more than one legal hold. Legal holds are applied to one or more backups (also known as recovery points). These backups can be filtered by resource types and by resource IDs.

Sourcemodule IndexedRecoveryPoint : sig ... end

This is a recovery point that has an associated backup index. Only recovery points with a backup index can be included in a search.

Sourcemodule Framework : sig ... end

Contains detailed information about a framework. Frameworks contain controls, which evaluate and report on your backup events and resources. Frameworks generate daily compliance results.

Sourcemodule CopyJob : sig ... end

Contains detailed information about a copy job.

Sourcemodule CopyJobSummary : sig ... end

This is a summary of copy jobs created or running within the most recent 30 days. The returned summary may contain the following: Region, Account, State, RestourceType, MessageCategory, StartTime, EndTime, and Count of included jobs.

Sourcemodule BackupVaultListMember : sig ... end

Contains metadata about a backup vault.

Sourcemodule BackupSelectionsListMember : sig ... end

Contains metadata about a BackupSelection object.

Sourcemodule BackupPlansListMember : sig ... end

Contains metadata about a backup plan.

Sourcemodule BackupPlanTemplatesListMember : sig ... end

An object specifying metadata associated with a backup plan template.

Sourcemodule BackupJob : sig ... end

Contains detailed information about a backup job.

Sourcemodule BackupJobSummary : sig ... end

This is a summary of jobs created or running within the most recent 30 days. The returned summary may contain the following: Region, Account, State, RestourceType, MessageCategory, StartTime, EndTime, and Count of included jobs.

Sourcemodule CreatorRequestId : sig ... end

Sourcemodule DateRange : sig ... end

This is a resource filter containing FromDate: DateTime and ToDate: DateTime. Both values are required. Future DateTime values are not permitted. The date and time are in Unix format and Coordinated Universal Time (UTC), and it is accurate to milliseconds ((milliseconds are optional). For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

Sourcemodule ResourceIdentifiers : sig ... end

Sourcemodule VaultNames : sig ... end

Sourcemodule Conditions : sig ... end

Contains information about which resources to include or exclude from a backup plan using their tags. Conditions are case sensitive.

Sourcemodule ListOfTags : sig ... end

Sourcemodule BackupRules : sig ... end

Sourcemodule ScheduledPlanExecutionMember : sig ... end

Contains information about a scheduled backup plan execution, including the execution time, rule type, and associated rule identifier.

Sourcemodule ScanResult : sig ... end

Contains the results of a security scan, including scanner information, scan state, and any findings discovered.

Sourcemodule MpaSessionStatus : sig ... end

Sourcemodule AlreadyExistsException : sig ... end

The required resource already exists.

Sourcemodule ConflictException : sig ... end

Backup can't perform the action that you requested until it finishes performing a previous action. Try again later.

Sourcemodule InvalidParameterValueException : sig ... end

Indicates that something is wrong with a parameter's value. For example, the value is out of range.

Sourcemodule LimitExceededException : sig ... end

A limit in the request has been exceeded; for example, a maximum number of items allowed in a request.

Sourcemodule MissingParameterValueException : sig ... end

Indicates that a required parameter is missing.

Sourcemodule ResourceNotFoundException : sig ... end

A resource that is required for the action doesn't exist.

Sourcemodule ServiceUnavailableException : sig ... end

The request failed due to a temporary failure of the server.

Sourcemodule TieringConfigurationInputForUpdate : sig ... end

This contains metadata about a tiering configuration for update operations.

Sourcemodule RestoreTestingSelectionForUpdate : sig ... end

This contains metadata about a restore testing selection.

Sourcemodule RestoreTestingPlanForUpdate : sig ... end

This contains metadata about a restore testing plan.

Sourcemodule ResourceTypeManagementPreference : sig ... end

Sourcemodule ResourceTypeOptInPreference : sig ... end

Sourcemodule InvalidRequestException : sig ... end

Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong type.

Sourcemodule Index : sig ... end

Sourcemodule GlobalSettings : sig ... end

Sourcemodule FrameworkControls : sig ... end

Sourcemodule BackupPlanInput : sig ... end

Contains an optional backup plan display name and an array of BackupRule objects, each of which specifies a backup rule. Each rule in a backup plan is a separate scheduled task.

Sourcemodule TagKeyList : sig ... end

Sourcemodule RestoreJobId : sig ... end

Sourcemodule Metadata : sig ... end

Sourcemodule RequesterComment : sig ... end

Sourcemodule BackupVaultEvents : sig ... end

Sourcemodule IAMPolicy : sig ... end

Sourcemodule TieringConfigurationsList : sig ... end

Sourcemodule MaxResults : sig ... end

Sourcemodule ScanJobs : sig ... end

Sourcemodule ListScanJobsInputMaxResultsInteger : sig ... end

Sourcemodule ScanJobSummaryList : sig ... end

Sourcemodule AggregationPeriod : sig ... end

Sourcemodule RestoreTestingSelections : sig ... end

Sourcemodule ListRestoreTestingSelectionsInputMaxResultsInteger : sig ... end

Sourcemodule RestoreTestingPlans : sig ... end

Sourcemodule ListRestoreTestingPlansInputMaxResultsInteger : sig ... end

Sourcemodule RestoreJobsList : sig ... end

Sourcemodule RestoreJobSummaryList : sig ... end

Sourcemodule RestoreAccessBackupVaultList : sig ... end

Sourcemodule ReportPlanList : sig ... end

Sourcemodule ReportJobList : sig ... end

Sourcemodule RecoveryPointByResourceList : sig ... end

Sourcemodule RecoveryPointsList : sig ... end

Sourcemodule RecoveryPointByBackupVaultList : sig ... end

Sourcemodule ProtectedResourcesList : sig ... end

Sourcemodule LegalHoldsList : sig ... end

Sourcemodule IndexedRecoveryPointList : sig ... end

Sourcemodule FrameworkList : sig ... end

Sourcemodule MaxFrameworkInputs : sig ... end

Sourcemodule CopyJobsList : sig ... end

Sourcemodule CopyJobSummaryList : sig ... end

Sourcemodule BackupVaultList : sig ... end

Sourcemodule BackupSelectionsList : sig ... end

Sourcemodule BackupPlansList : sig ... end

Sourcemodule BackupPlanVersionsList : sig ... end

Sourcemodule BackupPlanTemplatesList : sig ... end

Sourcemodule BackupJobsList : sig ... end

Sourcemodule BackupJobSummaryList : sig ... end

Sourcemodule TieringConfiguration : sig ... end

This contains metadata about a tiering configuration.

Sourcemodule RestoreTestingSelectionForGet : sig ... end

This contains metadata about a restore testing selection.

Sourcemodule RestoreTestingPlanForGet : sig ... end

This contains metadata about a restore testing plan.

Sourcemodule RecoveryPointSelection : sig ... end

This specifies criteria to assign a set of resources, such as resource types or backup vaults.

Sourcemodule BackupSelection : sig ... end

Used to specify a set of resources to a backup plan. We recommend that you specify conditions, tags, or resources to include or exclude. Otherwise, Backup attempts to select all supported and opted-in storage resources, which could have unintended cost implications. For more information, see Assigning resources programmatically.

Sourcemodule BackupPlan : sig ... end

Contains an optional backup plan display name and an array of BackupRule objects, each of which specifies a backup rule. Each rule in a backup plan is a separate scheduled task and can back up a different selection of Amazon Web Services resources.

Sourcemodule ScheduledRunsPreview : sig ... end

Sourcemodule MaxScheduledRunsPreview : sig ... end

Sourcemodule DependencyFailureException : sig ... end

A dependent Amazon Web Services service or resource returned an error to the Backup service, and the action cannot be completed.

Sourcemodule ScanResults : sig ... end

Sourcemodule StorageClass : sig ... end

Sourcemodule LatestMpaApprovalTeamUpdate : sig ... end

Contains information about the latest update to an MPA approval team association.

Sourcemodule BackupJobChildJobsInState : sig ... end

Sourcemodule TieringConfigurationInputForCreate : sig ... end

This contains metadata about a tiering configuration for create operations.

Sourcemodule RestoreTestingSelectionForCreate : sig ... end

This contains metadata about a specific restore testing selection. ProtectedResourceType is required, such as Amazon EBS or Amazon EC2. This consists of RestoreTestingSelectionName, ProtectedResourceType, and one of the following: ProtectedResourceArns ProtectedResourceConditions Each protected resource type can have one single value. A restore testing selection can include a wildcard value ("*") for ProtectedResourceArns along with ProtectedResourceConditions. Alternatively, you can include up to 30 specific protected resource ARNs in ProtectedResourceArns. ProtectedResourceConditions examples include as StringEquals and StringNotEquals.

Sourcemodule RestoreTestingPlanForCreate : sig ... end

This contains metadata about a restore testing plan.

Sourcemodule InvalidResourceStateException : sig ... end

Backup is already performing an action on this recovery point. It can't perform the action you requested until the first action finishes. Try again later.

Sourcemodule UpdateTieringConfigurationOutput : sig ... end

This request will send changes to your specified tiering configuration. TieringConfigurationName cannot be updated after it is created. ResourceSelection can contain: Resources TieringDownSettingsInDays ResourceType

Sourcemodule UpdateTieringConfigurationInput : sig ... end

This request will send changes to your specified tiering configuration. TieringConfigurationName cannot be updated after it is created. ResourceSelection can contain: Resources TieringDownSettingsInDays ResourceType

Sourcemodule UpdateRestoreTestingSelectionOutput : sig ... end

Updates the specified restore testing selection. Most elements except the RestoreTestingSelectionName can be updated with this request. You can use either protected resource ARNs or conditions, but not both.

Sourcemodule UpdateRestoreTestingSelectionInput : sig ... end

Updates the specified restore testing selection. Most elements except the RestoreTestingSelectionName can be updated with this request. You can use either protected resource ARNs or conditions, but not both.

Sourcemodule UpdateRestoreTestingPlanOutput : sig ... end

This request will send changes to your specified restore testing plan. RestoreTestingPlanName cannot be updated after it is created. RecoveryPointSelection can contain: Algorithm ExcludeVaults IncludeVaults RecoveryPointTypes SelectionWindowDays

Sourcemodule UpdateRestoreTestingPlanInput : sig ... end

This request will send changes to your specified restore testing plan. RestoreTestingPlanName cannot be updated after it is created. RecoveryPointSelection can contain: Algorithm ExcludeVaults IncludeVaults RecoveryPointTypes SelectionWindowDays

Sourcemodule UpdateReportPlanOutput : sig ... end

Updates the specified report plan.

Sourcemodule UpdateReportPlanInput : sig ... end

Updates the specified report plan.

Sourcemodule UpdateRegionSettingsInput : sig ... end

Updates the current service opt-in settings for the Region. Use the DescribeRegionSettings API to determine the resource types that are supported.

Sourcemodule UpdateRecoveryPointLifecycleOutput : sig ... end

Sets the transition lifecycle of a recovery point. The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. Backup transitions and expires backups automatically according to the lifecycle that you define. Resource types that can transition to cold storage are listed in the Feature availability by resource table. Backup ignores this expression for other resource types. Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, the “retention” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold. If your lifecycle currently uses the parameters DeleteAfterDays and MoveToColdStorageAfterDays, include these parameters and their values when you call this operation. Not including them may result in your plan updating with null values. This operation does not support continuous backups.

Sourcemodule UpdateRecoveryPointLifecycleInput : sig ... end

Sets the transition lifecycle of a recovery point. The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. Backup transitions and expires backups automatically according to the lifecycle that you define. Resource types that can transition to cold storage are listed in the Feature availability by resource table. Backup ignores this expression for other resource types. Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, the “retention” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold. If your lifecycle currently uses the parameters DeleteAfterDays and MoveToColdStorageAfterDays, include these parameters and their values when you call this operation. Not including them may result in your plan updating with null values. This operation does not support continuous backups.

Sourcemodule UpdateRecoveryPointIndexSettingsOutput : sig ... end

This operation updates the settings of a recovery point index. Required: BackupVaultName, RecoveryPointArn, and IAMRoleArn

Sourcemodule UpdateRecoveryPointIndexSettingsInput : sig ... end

This operation updates the settings of a recovery point index. Required: BackupVaultName, RecoveryPointArn, and IAMRoleArn

Sourcemodule UpdateGlobalSettingsInput : sig ... end

Updates whether the Amazon Web Services account has enabled different cross-account management options, including cross-account backup, multi-party approval, and delegated administrator. Returns an error if the account is not an Organizations management account. Use the DescribeGlobalSettings API to determine the current settings.

Sourcemodule UpdateFrameworkOutput : sig ... end

Updates the specified framework.

Sourcemodule UpdateFrameworkInput : sig ... end

Updates the specified framework.

Sourcemodule UpdateBackupPlanOutput : sig ... end

Updates the specified backup plan. The new version is uniquely identified by its ID.

Sourcemodule UpdateBackupPlanInput : sig ... end

Updates the specified backup plan. The new version is uniquely identified by its ID.

Sourcemodule UntagResourceInput : sig ... end

Removes a set of key-value pairs from a recovery point, backup plan, or backup vault identified by an Amazon Resource Name (ARN) This API is not supported for recovery points for resource types including Aurora, Amazon DocumentDB. Amazon EBS, Amazon FSx, Neptune, and Amazon RDS.

Sourcemodule TagResourceInput : sig ... end

Assigns a set of key-value pairs to a resource.

Sourcemodule StopBackupJobInput : sig ... end

Attempts to cancel a job to create a one-time backup of a resource. This action is not supported for the following services: Amazon Aurora Amazon DocumentDB (with MongoDB compatibility) Amazon FSx for Lustre Amazon FSx for NetApp ONTAP Amazon FSx for OpenZFS Amazon FSx for Windows File Server Amazon Neptune SAP HANA databases on Amazon EC2 instances Amazon RDS

Sourcemodule StartScanJobOutput : sig ... end

Starts scanning jobs for specific resources.

Sourcemodule StartScanJobInput : sig ... end

Starts scanning jobs for specific resources.

Sourcemodule StartRestoreJobOutput : sig ... end

Recovers the saved resource identified by an Amazon Resource Name (ARN).

Sourcemodule StartRestoreJobInput : sig ... end

Recovers the saved resource identified by an Amazon Resource Name (ARN).

Sourcemodule StartReportJobOutput : sig ... end

Starts an on-demand report job for the specified report plan.

Sourcemodule StartReportJobInput : sig ... end

Starts an on-demand report job for the specified report plan.

Sourcemodule StartCopyJobOutput : sig ... end

Starts a job to create a one-time copy of the specified resource. Does not support continuous backups. See Copy job retry for information on how Backup retries copy job operations.

Sourcemodule StartCopyJobInput : sig ... end

Starts a job to create a one-time copy of the specified resource. Does not support continuous backups. See Copy job retry for information on how Backup retries copy job operations.

Sourcemodule StartBackupJobOutput : sig ... end

Starts an on-demand backup job for the specified resource.

Sourcemodule StartBackupJobInput : sig ... end

Starts an on-demand backup job for the specified resource.

Sourcemodule RevokeRestoreAccessBackupVaultInput : sig ... end

Revokes access to a restore access backup vault, removing the ability to restore from its recovery points and permanently deleting the vault.

Sourcemodule PutRestoreValidationResultInput : sig ... end

This request allows you to send your independent self-run restore test validation results. RestoreJobId and ValidationStatus are required. Optionally, you can input a ValidationStatusMessage.

Sourcemodule PutBackupVaultNotificationsInput : sig ... end

Turns on notifications on a backup vault for the specified topic and events.

Sourcemodule PutBackupVaultLockConfigurationInput : sig ... end

Applies Backup Vault Lock to a backup vault, preventing attempts to delete any recovery point stored in or created in a backup vault. Vault Lock also prevents attempts to update the lifecycle policy that controls the retention period of any recovery point currently stored in a backup vault. If specified, Vault Lock enforces a minimum and maximum retention period for future backup and copy jobs that target a backup vault. Backup Vault Lock has been assessed by Cohasset Associates for use in environments that are subject to SEC 17a-4, CFTC, and FINRA regulations. For more information about how Backup Vault Lock relates to these regulations, see the Cohasset Associates Compliance Assessment. For more information, see Backup Vault Lock.

Sourcemodule PutBackupVaultAccessPolicyInput : sig ... end

Sets a resource-based policy that is used to manage access permissions on the target backup vault. Requires a backup vault name and an access policy document in JSON format.

Sourcemodule ListTieringConfigurationsOutput : sig ... end

Returns a list of tiering configurations.

Sourcemodule ListTieringConfigurationsInput : sig ... end

Returns a list of tiering configurations.

Sourcemodule ListTagsOutput : sig ... end

Returns the tags assigned to the resource, such as a target recovery point, backup plan, or backup vault. This operation returns results depending on the resource type used in the value for resourceArn. For example, recovery points of Amazon DynamoDB with Advanced Settings have an ARN (Amazon Resource Name) that begins with arn:aws:backup. Recovery points (backups) of DynamoDB without Advanced Settings enabled have an ARN that begins with arn:aws:dynamodb. When this operation is called and when you include values of resourceArn that have an ARN other than arn:aws:backup, it may return one of the exceptions listed below. To prevent this exception, include only values representing resource types that are fully managed by Backup. These have an ARN that begins arn:aws:backup and they are noted in the Feature availability by resource table.

Sourcemodule ListTagsInput : sig ... end

Returns the tags assigned to the resource, such as a target recovery point, backup plan, or backup vault. This operation returns results depending on the resource type used in the value for resourceArn. For example, recovery points of Amazon DynamoDB with Advanced Settings have an ARN (Amazon Resource Name) that begins with arn:aws:backup. Recovery points (backups) of DynamoDB without Advanced Settings enabled have an ARN that begins with arn:aws:dynamodb. When this operation is called and when you include values of resourceArn that have an ARN other than arn:aws:backup, it may return one of the exceptions listed below. To prevent this exception, include only values representing resource types that are fully managed by Backup. These have an ARN that begins arn:aws:backup and they are noted in the Feature availability by resource table.

Sourcemodule ListScanJobsOutput : sig ... end

Returns a list of existing scan jobs for an authenticated account for the last 30 days.

Sourcemodule ListScanJobsInput : sig ... end

Returns a list of existing scan jobs for an authenticated account for the last 30 days.

Sourcemodule ListScanJobSummariesOutput : sig ... end

This is a request for a summary of scan jobs created or running within the most recent 30 days.

Sourcemodule ListScanJobSummariesInput : sig ... end

This is a request for a summary of scan jobs created or running within the most recent 30 days.

Sourcemodule ListRestoreTestingSelectionsOutput : sig ... end

Returns a list of restore testing selections. Can be filtered by MaxResults and RestoreTestingPlanName.

Sourcemodule ListRestoreTestingSelectionsInput : sig ... end

Returns a list of restore testing selections. Can be filtered by MaxResults and RestoreTestingPlanName.

Sourcemodule ListRestoreTestingPlansOutput : sig ... end

Returns a list of restore testing plans.

Sourcemodule ListRestoreTestingPlansInput : sig ... end

Returns a list of restore testing plans.

Sourcemodule ListRestoreJobsOutput : sig ... end

Returns a list of jobs that Backup initiated to restore a saved resource, including details about the recovery process.

Sourcemodule ListRestoreJobsInput : sig ... end

Returns a list of jobs that Backup initiated to restore a saved resource, including details about the recovery process.

Sourcemodule ListRestoreJobsByProtectedResourceOutput : sig ... end

This returns restore jobs that contain the specified protected resource. You must include ResourceArn. You can optionally include NextToken, ByStatus, MaxResults, ByRecoveryPointCreationDateAfter , and ByRecoveryPointCreationDateBefore.

Sourcemodule ListRestoreJobsByProtectedResourceInput : sig ... end

This returns restore jobs that contain the specified protected resource. You must include ResourceArn. You can optionally include NextToken, ByStatus, MaxResults, ByRecoveryPointCreationDateAfter , and ByRecoveryPointCreationDateBefore.

Sourcemodule ListRestoreJobSummariesOutput : sig ... end

This request obtains a summary of restore jobs created or running within the the most recent 30 days. You can include parameters AccountID, State, ResourceType, AggregationPeriod, MaxResults, or NextToken to filter results. This request returns a summary that contains Region, Account, State, RestourceType, MessageCategory, StartTime, EndTime, and Count of included jobs.

Sourcemodule ListRestoreJobSummariesInput : sig ... end

This request obtains a summary of restore jobs created or running within the the most recent 30 days. You can include parameters AccountID, State, ResourceType, AggregationPeriod, MaxResults, or NextToken to filter results. This request returns a summary that contains Region, Account, State, RestourceType, MessageCategory, StartTime, EndTime, and Count of included jobs.

Sourcemodule ListRestoreAccessBackupVaultsOutput : sig ... end

Returns a list of restore access backup vaults associated with a specified backup vault.

Sourcemodule ListRestoreAccessBackupVaultsInput : sig ... end

Returns a list of restore access backup vaults associated with a specified backup vault.

Sourcemodule ListReportPlansOutput : sig ... end

Returns a list of your report plans. For detailed information about a single report plan, use DescribeReportPlan.

Sourcemodule ListReportPlansInput : sig ... end

Returns a list of your report plans. For detailed information about a single report plan, use DescribeReportPlan.

Sourcemodule ListReportJobsOutput : sig ... end

Returns details about your report jobs.

Sourcemodule ListReportJobsInput : sig ... end

Returns details about your report jobs.

Sourcemodule ListRecoveryPointsByResourceOutput : sig ... end

The information about the recovery points of the type specified by a resource Amazon Resource Name (ARN). For Amazon EFS and Amazon EC2, this action only lists recovery points created by Backup.

Sourcemodule ListRecoveryPointsByResourceInput : sig ... end

The information about the recovery points of the type specified by a resource Amazon Resource Name (ARN). For Amazon EFS and Amazon EC2, this action only lists recovery points created by Backup.

Sourcemodule ListRecoveryPointsByLegalHoldOutput : sig ... end

This action returns recovery point ARNs (Amazon Resource Names) of the specified legal hold.

Sourcemodule ListRecoveryPointsByLegalHoldInput : sig ... end

This action returns recovery point ARNs (Amazon Resource Names) of the specified legal hold.

Sourcemodule ListRecoveryPointsByBackupVaultOutput : sig ... end

Returns detailed information about the recovery points stored in a backup vault.

Sourcemodule ListRecoveryPointsByBackupVaultInput : sig ... end

Returns detailed information about the recovery points stored in a backup vault.

Sourcemodule ListProtectedResourcesOutput : sig ... end

Returns an array of resources successfully backed up by Backup, including the time the resource was saved, an Amazon Resource Name (ARN) of the resource, and a resource type.

Sourcemodule ListProtectedResourcesInput : sig ... end

Returns an array of resources successfully backed up by Backup, including the time the resource was saved, an Amazon Resource Name (ARN) of the resource, and a resource type.

Sourcemodule ListProtectedResourcesByBackupVaultOutput : sig ... end

This request lists the protected resources corresponding to each backup vault.

Sourcemodule ListProtectedResourcesByBackupVaultInput : sig ... end

This request lists the protected resources corresponding to each backup vault.

Sourcemodule ListLegalHoldsOutput : sig ... end

This action returns metadata about active and previous legal holds.

Sourcemodule ListLegalHoldsInput : sig ... end

This action returns metadata about active and previous legal holds.

Sourcemodule ListIndexedRecoveryPointsOutput : sig ... end

This operation returns a list of recovery points that have an associated index, belonging to the specified account. Optional parameters you can include are: MaxResults; NextToken; SourceResourceArns; CreatedBefore; CreatedAfter; and ResourceType.

Sourcemodule ListIndexedRecoveryPointsInput : sig ... end

This operation returns a list of recovery points that have an associated index, belonging to the specified account. Optional parameters you can include are: MaxResults; NextToken; SourceResourceArns; CreatedBefore; CreatedAfter; and ResourceType.

Sourcemodule ListFrameworksOutput : sig ... end

Returns a list of all frameworks for an Amazon Web Services account and Amazon Web Services Region.

Sourcemodule ListFrameworksInput : sig ... end

Returns a list of all frameworks for an Amazon Web Services account and Amazon Web Services Region.

Sourcemodule ListCopyJobsOutput : sig ... end

Returns metadata about your copy jobs.

Sourcemodule ListCopyJobsInput : sig ... end

Returns metadata about your copy jobs.

Sourcemodule ListCopyJobSummariesOutput : sig ... end

This request obtains a list of copy jobs created or running within the the most recent 30 days. You can include parameters AccountID, State, ResourceType, MessageCategory, AggregationPeriod, MaxResults, or NextToken to filter results. This request returns a summary that contains Region, Account, State, RestourceType, MessageCategory, StartTime, EndTime, and Count of included jobs.

Sourcemodule ListCopyJobSummariesInput : sig ... end

This request obtains a list of copy jobs created or running within the the most recent 30 days. You can include parameters AccountID, State, ResourceType, MessageCategory, AggregationPeriod, MaxResults, or NextToken to filter results. This request returns a summary that contains Region, Account, State, RestourceType, MessageCategory, StartTime, EndTime, and Count of included jobs.

Sourcemodule ListBackupVaultsOutput : sig ... end

Returns a list of recovery point storage containers along with information about them.

Sourcemodule ListBackupVaultsInput : sig ... end

Returns a list of recovery point storage containers along with information about them.

Sourcemodule ListBackupSelectionsOutput : sig ... end

Returns an array containing metadata of the resources associated with the target backup plan.

Sourcemodule ListBackupSelectionsInput : sig ... end

Returns an array containing metadata of the resources associated with the target backup plan.

Sourcemodule ListBackupPlansOutput : sig ... end

Lists the active backup plans for the account.

Sourcemodule ListBackupPlansInput : sig ... end

Lists the active backup plans for the account.

Sourcemodule ListBackupPlanVersionsOutput : sig ... end

Returns version metadata of your backup plans, including Amazon Resource Names (ARNs), backup plan IDs, creation and deletion dates, plan names, and version IDs.

Sourcemodule ListBackupPlanVersionsInput : sig ... end

Returns version metadata of your backup plans, including Amazon Resource Names (ARNs), backup plan IDs, creation and deletion dates, plan names, and version IDs.

Sourcemodule ListBackupPlanTemplatesOutput : sig ... end

Lists the backup plan templates.

Sourcemodule ListBackupPlanTemplatesInput : sig ... end

Lists the backup plan templates.

Sourcemodule ListBackupJobsOutput : sig ... end

Returns a list of existing backup jobs for an authenticated account for the last 30 days. For a longer period of time, consider using these monitoring tools.

Sourcemodule ListBackupJobsInput : sig ... end

Returns a list of existing backup jobs for an authenticated account for the last 30 days. For a longer period of time, consider using these monitoring tools.

Sourcemodule ListBackupJobSummariesOutput : sig ... end

This is a request for a summary of backup jobs created or running within the most recent 30 days. You can include parameters AccountID, State, ResourceType, MessageCategory, AggregationPeriod, MaxResults, or NextToken to filter results. This request returns a summary that contains Region, Account, State, ResourceType, MessageCategory, StartTime, EndTime, and Count of included jobs.

Sourcemodule ListBackupJobSummariesInput : sig ... end

This is a request for a summary of backup jobs created or running within the most recent 30 days. You can include parameters AccountID, State, ResourceType, MessageCategory, AggregationPeriod, MaxResults, or NextToken to filter results. This request returns a summary that contains Region, Account, State, ResourceType, MessageCategory, StartTime, EndTime, and Count of included jobs.

Sourcemodule GetTieringConfigurationOutput : sig ... end

Returns TieringConfiguration details for the specified TieringConfigurationName. The details are the body of a tiering configuration in JSON format, in addition to configuration metadata.

Sourcemodule GetTieringConfigurationInput : sig ... end

Returns TieringConfiguration details for the specified TieringConfigurationName. The details are the body of a tiering configuration in JSON format, in addition to configuration metadata.

Sourcemodule GetSupportedResourceTypesOutput : sig ... end

Returns the Amazon Web Services resource types supported by Backup.

Sourcemodule GetRestoreTestingSelectionOutput : sig ... end

Returns RestoreTestingSelection, which displays resources and elements of the restore testing plan.

Sourcemodule GetRestoreTestingSelectionInput : sig ... end

Returns RestoreTestingSelection, which displays resources and elements of the restore testing plan.

Sourcemodule GetRestoreTestingPlanOutput : sig ... end

Returns RestoreTestingPlan details for the specified RestoreTestingPlanName. The details are the body of a restore testing plan in JSON format, in addition to plan metadata.

Sourcemodule GetRestoreTestingPlanInput : sig ... end

Returns RestoreTestingPlan details for the specified RestoreTestingPlanName. The details are the body of a restore testing plan in JSON format, in addition to plan metadata.

Sourcemodule GetRestoreTestingInferredMetadataOutput : sig ... end

This request returns the minimal required set of metadata needed to start a restore job with secure default settings. BackupVaultName and RecoveryPointArn are required parameters. BackupVaultAccountId is an optional parameter.

Sourcemodule GetRestoreTestingInferredMetadataInput : sig ... end

This request returns the minimal required set of metadata needed to start a restore job with secure default settings. BackupVaultName and RecoveryPointArn are required parameters. BackupVaultAccountId is an optional parameter.

Sourcemodule GetRestoreJobMetadataOutput : sig ... end

This request returns the metadata for the specified restore job.

Sourcemodule GetRestoreJobMetadataInput : sig ... end

This request returns the metadata for the specified restore job.

Sourcemodule GetRecoveryPointRestoreMetadataOutput : sig ... end

Returns a set of metadata key-value pairs that were used to create the backup.

Sourcemodule GetRecoveryPointRestoreMetadataInput : sig ... end

Returns a set of metadata key-value pairs that were used to create the backup.

Sourcemodule GetRecoveryPointIndexDetailsOutput : sig ... end

This operation returns the metadata and details specific to the backup index associated with the specified recovery point.

Sourcemodule GetRecoveryPointIndexDetailsInput : sig ... end

This operation returns the metadata and details specific to the backup index associated with the specified recovery point.

Sourcemodule GetLegalHoldOutput : sig ... end

This action returns details for a specified legal hold. The details are the body of a legal hold in JSON format, in addition to metadata.

Sourcemodule GetLegalHoldInput : sig ... end

This action returns details for a specified legal hold. The details are the body of a legal hold in JSON format, in addition to metadata.

Sourcemodule GetBackupVaultNotificationsOutput : sig ... end

Returns event notifications for the specified backup vault.

Sourcemodule GetBackupVaultNotificationsInput : sig ... end

Returns event notifications for the specified backup vault.

Sourcemodule GetBackupVaultAccessPolicyOutput : sig ... end

Returns the access policy document that is associated with the named backup vault.

Sourcemodule GetBackupVaultAccessPolicyInput : sig ... end

Returns the access policy document that is associated with the named backup vault.

Sourcemodule GetBackupSelectionOutput : sig ... end

Returns selection metadata and a document in JSON format that specifies a list of resources that are associated with a backup plan.

Sourcemodule GetBackupSelectionInput : sig ... end

Returns selection metadata and a document in JSON format that specifies a list of resources that are associated with a backup plan.

Sourcemodule GetBackupPlanOutput : sig ... end

Returns BackupPlan details for the specified BackupPlanId. The details are the body of a backup plan in JSON format, in addition to plan metadata.

Sourcemodule GetBackupPlanInput : sig ... end

Returns BackupPlan details for the specified BackupPlanId. The details are the body of a backup plan in JSON format, in addition to plan metadata.

Sourcemodule GetBackupPlanFromTemplateOutput : sig ... end

Returns the template specified by its templateId as a backup plan.

Sourcemodule GetBackupPlanFromTemplateInput : sig ... end

Returns the template specified by its templateId as a backup plan.

Sourcemodule GetBackupPlanFromJSONOutput : sig ... end

Returns a valid JSON document specifying a backup plan or an error.

Sourcemodule GetBackupPlanFromJSONInput : sig ... end

Returns a valid JSON document specifying a backup plan or an error.

Sourcemodule ExportBackupPlanTemplateOutput : sig ... end

Returns the backup plan that is specified by the plan ID as a backup template.

Sourcemodule ExportBackupPlanTemplateInput : sig ... end

Returns the backup plan that is specified by the plan ID as a backup template.

Sourcemodule DisassociateRecoveryPointInput : sig ... end

Deletes the specified continuous backup recovery point from Backup and releases control of that continuous backup to the source service, such as Amazon RDS. The source service will continue to create and retain continuous backups using the lifecycle that you specified in your original backup plan. Does not support snapshot backup recovery points.

Sourcemodule DisassociateRecoveryPointFromParentInput : sig ... end

This action to a specific child (nested) recovery point removes the relationship between the specified recovery point and its parent (composite) recovery point.

Sourcemodule DisassociateBackupVaultMpaApprovalTeamInput : sig ... end

Removes the association between an MPA approval team and a backup vault, disabling the MPA approval workflow for restore operations.

Sourcemodule DescribeScanJobOutput : sig ... end

Returns scan job details for the specified ScanJobID.

Sourcemodule DescribeScanJobInput : sig ... end

Returns scan job details for the specified ScanJobID.

Sourcemodule DescribeRestoreJobOutput : sig ... end

Returns metadata associated with a restore job that is specified by a job ID.

Sourcemodule DescribeRestoreJobInput : sig ... end

Returns metadata associated with a restore job that is specified by a job ID.

Sourcemodule DescribeReportPlanOutput : sig ... end

Returns a list of all report plans for an Amazon Web Services account and Amazon Web Services Region.

Sourcemodule DescribeReportPlanInput : sig ... end

Returns a list of all report plans for an Amazon Web Services account and Amazon Web Services Region.

Sourcemodule DescribeReportJobOutput : sig ... end

Returns the details associated with creating a report as specified by its ReportJobId.

Sourcemodule DescribeReportJobInput : sig ... end

Returns the details associated with creating a report as specified by its ReportJobId.

Sourcemodule DescribeRegionSettingsOutput : sig ... end

Returns the current service opt-in settings for the Region. If service opt-in is enabled for a service, Backup tries to protect that service's resources in this Region, when the resource is included in an on-demand backup or scheduled backup plan. Otherwise, Backup does not try to protect that service's resources in this Region.

Sourcemodule DescribeRegionSettingsInput : sig ... end

Returns the current service opt-in settings for the Region. If service opt-in is enabled for a service, Backup tries to protect that service's resources in this Region, when the resource is included in an on-demand backup or scheduled backup plan. Otherwise, Backup does not try to protect that service's resources in this Region.

Sourcemodule DescribeRecoveryPointOutput : sig ... end

Returns metadata associated with a recovery point, including ID, status, encryption, and lifecycle.

Sourcemodule DescribeRecoveryPointInput : sig ... end

Returns metadata associated with a recovery point, including ID, status, encryption, and lifecycle.

Sourcemodule DescribeProtectedResourceOutput : sig ... end

Returns information about a saved resource, including the last time it was backed up, its Amazon Resource Name (ARN), and the Amazon Web Services service type of the saved resource.

Sourcemodule DescribeProtectedResourceInput : sig ... end

Returns information about a saved resource, including the last time it was backed up, its Amazon Resource Name (ARN), and the Amazon Web Services service type of the saved resource.

Sourcemodule DescribeGlobalSettingsOutput : sig ... end

Describes whether the Amazon Web Services account has enabled different cross-account management options, including cross-account backup, multi-party approval, and delegated administrator. Returns an error if the account is not a member of an Organizations organization. Example: describe-global-settings --region us-west-2

Sourcemodule DescribeGlobalSettingsInput : sig ... end

Describes whether the Amazon Web Services account has enabled different cross-account management options, including cross-account backup, multi-party approval, and delegated administrator. Returns an error if the account is not a member of an Organizations organization. Example: describe-global-settings --region us-west-2

Sourcemodule DescribeFrameworkOutput : sig ... end

Returns the framework details for the specified FrameworkName.

Sourcemodule DescribeFrameworkInput : sig ... end

Returns the framework details for the specified FrameworkName.

Sourcemodule DescribeCopyJobOutput : sig ... end

Returns metadata associated with creating a copy of a resource.

Sourcemodule DescribeCopyJobInput : sig ... end

Returns metadata associated with creating a copy of a resource.

Sourcemodule DescribeBackupVaultOutput : sig ... end

Returns metadata about a backup vault specified by its name.

Sourcemodule DescribeBackupVaultInput : sig ... end

Returns metadata about a backup vault specified by its name.

Sourcemodule DescribeBackupJobOutput : sig ... end

Returns backup job details for the specified BackupJobId.

Sourcemodule DescribeBackupJobInput : sig ... end

Returns backup job details for the specified BackupJobId.

Sourcemodule DeleteTieringConfigurationOutput : sig ... end

Deletes the tiering configuration specified by a tiering configuration name.

Sourcemodule DeleteTieringConfigurationInput : sig ... end

Deletes the tiering configuration specified by a tiering configuration name.

Sourcemodule DeleteRestoreTestingSelectionInput : sig ... end

Input the Restore Testing Plan name and Restore Testing Selection name. All testing selections associated with a restore testing plan must be deleted before the restore testing plan can be deleted.

Sourcemodule DeleteRestoreTestingPlanInput : sig ... end

This request deletes the specified restore testing plan. Deletion can only successfully occur if all associated restore testing selections are deleted first.

Sourcemodule DeleteReportPlanInput : sig ... end

Deletes the report plan specified by a report plan name.

Sourcemodule DeleteRecoveryPointInput : sig ... end

Deletes the recovery point specified by a recovery point ID. If the recovery point ID belongs to a continuous backup, calling this endpoint deletes the existing continuous backup and stops future continuous backup. When an IAM role's permissions are insufficient to call this API, the service sends back an HTTP 200 response with an empty HTTP body, but the recovery point is not deleted. Instead, it enters an EXPIRED state. EXPIRED recovery points can be deleted with this API once the IAM role has the iam:CreateServiceLinkedRole action. To learn more about adding this role, see Troubleshooting manual deletions. If the user or role is deleted or the permission within the role is removed, the deletion will not be successful and will enter an EXPIRED state.

Sourcemodule DeleteFrameworkInput : sig ... end

Deletes the framework specified by a framework name.

Sourcemodule DeleteBackupVaultNotificationsInput : sig ... end

Deletes event notifications for the specified backup vault.

Sourcemodule DeleteBackupVaultLockConfigurationInput : sig ... end

Deletes Backup Vault Lock from a backup vault specified by a backup vault name. If the Vault Lock configuration is immutable, then you cannot delete Vault Lock using API operations, and you will receive an InvalidRequestException if you attempt to do so. For more information, see Vault Lock in the Backup Developer Guide.

Sourcemodule DeleteBackupVaultInput : sig ... end

Deletes the backup vault identified by its name. A vault can be deleted only if it is empty.

Sourcemodule DeleteBackupVaultAccessPolicyInput : sig ... end

Deletes the policy document that manages permissions on a backup vault.

Sourcemodule DeleteBackupSelectionInput : sig ... end

Deletes the resource selection associated with a backup plan that is specified by the SelectionId.

Sourcemodule DeleteBackupPlanOutput : sig ... end

Deletes a backup plan. A backup plan can only be deleted after all associated selections of resources have been deleted. Deleting a backup plan deletes the current version of a backup plan. Previous versions, if any, will still exist.

Sourcemodule DeleteBackupPlanInput : sig ... end

Deletes a backup plan. A backup plan can only be deleted after all associated selections of resources have been deleted. Deleting a backup plan deletes the current version of a backup plan. Previous versions, if any, will still exist.

Sourcemodule CreateTieringConfigurationOutput : sig ... end

Creates a tiering configuration. A tiering configuration enables automatic movement of backup data to a lower-cost storage tier based on the age of backed-up objects in the backup vault. Each vault can only have one vault-specific tiering configuration, in addition to any global configuration that applies to all vaults.

Sourcemodule CreateTieringConfigurationInput : sig ... end

Creates a tiering configuration. A tiering configuration enables automatic movement of backup data to a lower-cost storage tier based on the age of backed-up objects in the backup vault. Each vault can only have one vault-specific tiering configuration, in addition to any global configuration that applies to all vaults.

Sourcemodule CreateRestoreTestingSelectionOutput : sig ... end

This request can be sent after CreateRestoreTestingPlan request returns successfully. This is the second part of creating a resource testing plan, and it must be completed sequentially. This consists of RestoreTestingSelectionName, ProtectedResourceType, and one of the following: ProtectedResourceArns ProtectedResourceConditions Each protected resource type can have one single value. A restore testing selection can include a wildcard value ("*") for ProtectedResourceArns along with ProtectedResourceConditions. Alternatively, you can include up to 30 specific protected resource ARNs in ProtectedResourceArns. Cannot select by both protected resource types AND specific ARNs. Request will fail if both are included.

Sourcemodule CreateRestoreTestingSelectionInput : sig ... end

This request can be sent after CreateRestoreTestingPlan request returns successfully. This is the second part of creating a resource testing plan, and it must be completed sequentially. This consists of RestoreTestingSelectionName, ProtectedResourceType, and one of the following: ProtectedResourceArns ProtectedResourceConditions Each protected resource type can have one single value. A restore testing selection can include a wildcard value ("*") for ProtectedResourceArns along with ProtectedResourceConditions. Alternatively, you can include up to 30 specific protected resource ARNs in ProtectedResourceArns. Cannot select by both protected resource types AND specific ARNs. Request will fail if both are included.

Sourcemodule CreateRestoreTestingPlanOutput : sig ... end

Creates a restore testing plan. The first of two steps to create a restore testing plan. After this request is successful, finish the procedure using CreateRestoreTestingSelection.

Sourcemodule CreateRestoreTestingPlanInput : sig ... end

Creates a restore testing plan. The first of two steps to create a restore testing plan. After this request is successful, finish the procedure using CreateRestoreTestingSelection.

Sourcemodule CreateRestoreAccessBackupVaultOutput : sig ... end

Creates a restore access backup vault that provides temporary access to recovery points in a logically air-gapped backup vault, subject to MPA approval.

Sourcemodule CreateRestoreAccessBackupVaultInput : sig ... end

Creates a restore access backup vault that provides temporary access to recovery points in a logically air-gapped backup vault, subject to MPA approval.

Sourcemodule CreateReportPlanOutput : sig ... end

Creates a report plan. A report plan is a document that contains information about the contents of the report and where Backup will deliver it. If you call CreateReportPlan with a plan that already exists, you receive an AlreadyExistsException exception.

Sourcemodule CreateReportPlanInput : sig ... end

Creates a report plan. A report plan is a document that contains information about the contents of the report and where Backup will deliver it. If you call CreateReportPlan with a plan that already exists, you receive an AlreadyExistsException exception.

Sourcemodule CreateLogicallyAirGappedBackupVaultOutput : sig ... end

Creates a logical container to where backups may be copied. This request includes a name, the Region, the maximum number of retention days, the minimum number of retention days, and optionally can include tags and a creator request ID. Do not include sensitive data, such as passport numbers, in the name of a backup vault.

Sourcemodule CreateLogicallyAirGappedBackupVaultInput : sig ... end

Creates a logical container to where backups may be copied. This request includes a name, the Region, the maximum number of retention days, the minimum number of retention days, and optionally can include tags and a creator request ID. Do not include sensitive data, such as passport numbers, in the name of a backup vault.

Sourcemodule CreateLegalHoldOutput : sig ... end

Creates a legal hold on a recovery point (backup). A legal hold is a restraint on altering or deleting a backup until an authorized user cancels the legal hold. Any actions to delete or disassociate a recovery point will fail with an error if one or more active legal holds are on the recovery point.

Sourcemodule CreateLegalHoldInput : sig ... end

Creates a legal hold on a recovery point (backup). A legal hold is a restraint on altering or deleting a backup until an authorized user cancels the legal hold. Any actions to delete or disassociate a recovery point will fail with an error if one or more active legal holds are on the recovery point.

Sourcemodule CreateFrameworkOutput : sig ... end

Creates a framework with one or more controls. A framework is a collection of controls that you can use to evaluate your backup practices. By using pre-built customizable controls to define your policies, you can evaluate whether your backup practices comply with your policies and which resources are not yet in compliance.

Sourcemodule CreateFrameworkInput : sig ... end

Creates a framework with one or more controls. A framework is a collection of controls that you can use to evaluate your backup practices. By using pre-built customizable controls to define your policies, you can evaluate whether your backup practices comply with your policies and which resources are not yet in compliance.

Sourcemodule CreateBackupVaultOutput : sig ... end

Creates a logical container where backups are stored. A CreateBackupVault request includes a name, optionally one or more resource tags, an encryption key, and a request ID. Do not include sensitive data, such as passport numbers, in the name of a backup vault.

Sourcemodule CreateBackupVaultInput : sig ... end

Creates a logical container where backups are stored. A CreateBackupVault request includes a name, optionally one or more resource tags, an encryption key, and a request ID. Do not include sensitive data, such as passport numbers, in the name of a backup vault.

Sourcemodule CreateBackupSelectionOutput : sig ... end

Creates a JSON document that specifies a set of resources to assign to a backup plan. For examples, see Assigning resources programmatically.

Sourcemodule CreateBackupSelectionInput : sig ... end

Creates a JSON document that specifies a set of resources to assign to a backup plan. For examples, see Assigning resources programmatically.

Sourcemodule CreateBackupPlanOutput : sig ... end

Creates a backup plan using a backup plan name and backup rules. A backup plan is a document that contains information that Backup uses to schedule tasks that create recovery points for resources. If you call CreateBackupPlan with a plan that already exists, you receive an AlreadyExistsException exception.

Sourcemodule CreateBackupPlanInput : sig ... end

Creates a backup plan using a backup plan name and backup rules. A backup plan is a document that contains information that Backup uses to schedule tasks that create recovery points for resources. If you call CreateBackupPlan with a plan that already exists, you receive an AlreadyExistsException exception.

Sourcemodule CancelLegalHoldOutput : sig ... end

Removes the specified legal hold on a recovery point. This action can only be performed by a user with sufficient permissions.

Sourcemodule CancelLegalHoldInput : sig ... end

Removes the specified legal hold on a recovery point. This action can only be performed by a user with sufficient permissions.

Sourcemodule AssociateBackupVaultMpaApprovalTeamInput : sig ... end

Associates an MPA approval team with a backup vault.