{ "version": "2.0", "metadata": { "apiVersion": "2018-11-15", "endpointPrefix": "backup", "jsonVersion": "1.1", "protocol": "rest-json", "serviceFullName": "AWS Backup", "serviceId": "Backup", "signatureVersion": "v4", "uid": "backup-2018-11-15" }, "operations": { "CancelLegalHold": { "name": "CancelLegalHold", "http": { "method": "DELETE", "requestUri": "/legal-holds/{legalHoldId}", "responseCode": 201 }, "input": { "shape": "CancelLegalHoldInput" }, "output": { "shape": "CancelLegalHoldOutput" }, "errors": [ { "shape": "InvalidParameterValueException" }, { "shape": "InvalidResourceStateException" }, { "shape": "MissingParameterValueException" }, { "shape": "ServiceUnavailableException" }, { "shape": "ResourceNotFoundException" } ], "documentation": "

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

", "idempotent": true }, "CreateBackupPlan": { "name": "CreateBackupPlan", "http": { "method": "PUT", "requestUri": "/backup/plans/" }, "input": { "shape": "CreateBackupPlanInput" }, "output": { "shape": "CreateBackupPlanOutput" }, "errors": [ { "shape": "LimitExceededException" }, { "shape": "AlreadyExistsException" }, { "shape": "InvalidParameterValueException" }, { "shape": "MissingParameterValueException" }, { "shape": "ServiceUnavailableException" } ], "documentation": "

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.

", "idempotent": true }, "CreateBackupSelection": { "name": "CreateBackupSelection", "http": { "method": "PUT", "requestUri": "/backup/plans/{backupPlanId}/selections/" }, "input": { "shape": "CreateBackupSelectionInput" }, "output": { "shape": "CreateBackupSelectionOutput" }, "errors": [ { "shape": "LimitExceededException" }, { "shape": "AlreadyExistsException" }, { "shape": "InvalidParameterValueException" }, { "shape": "MissingParameterValueException" }, { "shape": "ServiceUnavailableException" } ], "documentation": "

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

", "idempotent": true }, "CreateBackupVault": { "name": "CreateBackupVault", "http": { "method": "PUT", "requestUri": "/backup-vaults/{backupVaultName}" }, "input": { "shape": "CreateBackupVaultInput" }, "output": { "shape": "CreateBackupVaultOutput" }, "errors": [ { "shape": "InvalidParameterValueException" }, { "shape": "MissingParameterValueException" }, { "shape": "ServiceUnavailableException" }, { "shape": "LimitExceededException" }, { "shape": "AlreadyExistsException" } ], "documentation": "

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.

", "idempotent": true }, "CreateFramework": { "name": "CreateFramework", "http": { "method": "POST", "requestUri": "/audit/frameworks" }, "input": { "shape": "CreateFrameworkInput" }, "output": { "shape": "CreateFrameworkOutput" }, "errors": [ { "shape": "AlreadyExistsException" }, { "shape": "LimitExceededException" }, { "shape": "InvalidParameterValueException" }, { "shape": "MissingParameterValueException" }, { "shape": "ServiceUnavailableException" } ], "documentation": "

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.

", "idempotent": true }, "CreateLegalHold": { "name": "CreateLegalHold", "http": { "method": "POST", "requestUri": "/legal-holds/" }, "input": { "shape": "CreateLegalHoldInput" }, "output": { "shape": "CreateLegalHoldOutput" }, "errors": [ { "shape": "InvalidParameterValueException" }, { "shape": "MissingParameterValueException" }, { "shape": "ServiceUnavailableException" }, { "shape": "LimitExceededException" } ], "documentation": "

This action 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.

", "idempotent": true }, "CreateLogicallyAirGappedBackupVault": { "name": "CreateLogicallyAirGappedBackupVault", "http": { "method": "PUT", "requestUri": "/logically-air-gapped-backup-vaults/{backupVaultName}" }, "input": { "shape": "CreateLogicallyAirGappedBackupVaultInput" }, "output": { "shape": "CreateLogicallyAirGappedBackupVaultOutput" }, "errors": [ { "shape": "AlreadyExistsException" }, { "shape": "InvalidParameterValueException" }, { "shape": "LimitExceededException" }, { "shape": "MissingParameterValueException" }, { "shape": "ServiceUnavailableException" }, { "shape": "InvalidRequestException" } ], "documentation": "

This request 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.

", "idempotent": true }, "CreateReportPlan": { "name": "CreateReportPlan", "http": { "method": "POST", "requestUri": "/audit/report-plans" }, "input": { "shape": "CreateReportPlanInput" }, "output": { "shape": "CreateReportPlanOutput" }, "errors": [ { "shape": "AlreadyExistsException" }, { "shape": "LimitExceededException" }, { "shape": "InvalidParameterValueException" }, { "shape": "ServiceUnavailableException" }, { "shape": "MissingParameterValueException" } ], "documentation": "

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.

", "idempotent": true }, "CreateRestoreTestingPlan": { "name": "CreateRestoreTestingPlan", "http": { "method": "PUT", "requestUri": "/restore-testing/plans", "responseCode": 201 }, "input": { "shape": "CreateRestoreTestingPlanInput" }, "output": { "shape": "CreateRestoreTestingPlanOutput" }, "errors": [ { "shape": "AlreadyExistsException" }, { "shape": "ConflictException" }, { "shape": "InvalidParameterValueException" }, { "shape": "LimitExceededException" }, { "shape": "MissingParameterValueException" }, { "shape": "ServiceUnavailableException" } ], "documentation": "

This is the first of two steps to create a restore testing plan; once this request is successful, finish the procedure with request CreateRestoreTestingSelection.

You must include the parameter RestoreTestingPlan. You may optionally include CreatorRequestId and Tags.

", "idempotent": true }, "CreateRestoreTestingSelection": { "name": "CreateRestoreTestingSelection", "http": { "method": "PUT", "requestUri": "/restore-testing/plans/{RestoreTestingPlanName}/selections", "responseCode": 201 }, "input": { "shape": "CreateRestoreTestingSelectionInput" }, "output": { "shape": "CreateRestoreTestingSelectionOutput" }, "errors": [ { "shape": "AlreadyExistsException" }, { "shape": "InvalidParameterValueException" }, { "shape": "LimitExceededException" }, { "shape": "MissingParameterValueException" }, { "shape": "ResourceNotFoundException" }, { "shape": "ServiceUnavailableException" } ], "documentation": "

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:

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.

", "idempotent": true }, "DeleteBackupPlan": { "name": "DeleteBackupPlan", "http": { "method": "DELETE", "requestUri": "/backup/plans/{backupPlanId}" }, "input": { "shape": "DeleteBackupPlanInput" }, "output": { "shape": "DeleteBackupPlanOutput" }, "errors": [ { "shape": "ResourceNotFoundException" }, { "shape": "InvalidParameterValueException" }, { "shape": "MissingParameterValueException" }, { "shape": "ServiceUnavailableException" }, { "shape": "InvalidRequestException" } ], "documentation": "

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.

" }, "DeleteBackupSelection": { "name": "DeleteBackupSelection", "http": { "method": "DELETE", "requestUri": "/backup/plans/{backupPlanId}/selections/{selectionId}" }, "input": { "shape": "DeleteBackupSelectionInput" }, "errors": [ { "shape": "ResourceNotFoundException" }, { "shape": "InvalidParameterValueException" }, { "shape": "MissingParameterValueException" }, { "shape": "ServiceUnavailableException" } ], "documentation": "

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

" }, "DeleteBackupVault": { "name": "DeleteBackupVault", "http": { "method": "DELETE", "requestUri": "/backup-vaults/{backupVaultName}" }, "input": { "shape": "DeleteBackupVaultInput" }, "errors": [ { "shape": "ResourceNotFoundException" }, { "shape": "InvalidParameterValueException" }, { "shape": "MissingParameterValueException" }, { "shape": "ServiceUnavailableException" }, { "shape": "InvalidRequestException" } ], "documentation": "

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

" }, "DeleteBackupVaultAccessPolicy": { "name": "DeleteBackupVaultAccessPolicy", "http": { "method": "DELETE", "requestUri": "/backup-vaults/{backupVaultName}/access-policy" }, "input": { "shape": "DeleteBackupVaultAccessPolicyInput" }, "errors": [ { "shape": "ResourceNotFoundException" }, { "shape": "InvalidParameterValueException" }, { "shape": "MissingParameterValueException" }, { "shape": "ServiceUnavailableException" } ], "documentation": "

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

", "idempotent": true }, "DeleteBackupVaultLockConfiguration": { "name": "DeleteBackupVaultLockConfiguration", "http": { "method": "DELETE", "requestUri": "/backup-vaults/{backupVaultName}/vault-lock" }, "input": { "shape": "DeleteBackupVaultLockConfigurationInput" }, "errors": [ { "shape": "ResourceNotFoundException" }, { "shape": "InvalidParameterValueException" }, { "shape": "MissingParameterValueException" }, { "shape": "InvalidRequestException" }, { "shape": "ServiceUnavailableException" } ], "documentation": "

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.

", "idempotent": true }, "DeleteBackupVaultNotifications": { "name": "DeleteBackupVaultNotifications", "http": { "method": "DELETE", "requestUri": "/backup-vaults/{backupVaultName}/notification-configuration" }, "input": { "shape": "DeleteBackupVaultNotificationsInput" }, "errors": [ { "shape": "ResourceNotFoundException" }, { "shape": "InvalidParameterValueException" }, { "shape": "MissingParameterValueException" }, { "shape": "ServiceUnavailableException" } ], "documentation": "

Deletes event notifications for the specified backup vault.

", "idempotent": true }, "DeleteFramework": { "name": "DeleteFramework", "http": { "method": "DELETE", "requestUri": "/audit/frameworks/{frameworkName}" }, "input": { "shape": "DeleteFrameworkInput" }, "errors": [ { "shape": "MissingParameterValueException" }, { "shape": "InvalidParameterValueException" }, { "shape": "ServiceUnavailableException" }, { "shape": "ConflictException" }, { "shape": "ResourceNotFoundException" } ], "documentation": "

Deletes the framework specified by a framework name.

" }, "DeleteRecoveryPoint": { "name": "DeleteRecoveryPoint", "http": { "method": "DELETE", "requestUri": "/backup-vaults/{backupVaultName}/recovery-points/{recoveryPointArn}" }, "input": { "shape": "DeleteRecoveryPointInput" }, "errors": [ { "shape": "ResourceNotFoundException" }, { "shape": "InvalidParameterValueException" }, { "shape": "MissingParameterValueException" }, { "shape": "InvalidResourceStateException" }, { "shape": "ServiceUnavailableException" }, { "shape": "InvalidRequestException" } ], "documentation": "

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.

", "idempotent": true }, "DeleteReportPlan": { "name": "DeleteReportPlan", "http": { "method": "DELETE", "requestUri": "/audit/report-plans/{reportPlanName}" }, "input": { "shape": "DeleteReportPlanInput" }, "errors": [ { "shape": "MissingParameterValueException" }, { "shape": "InvalidParameterValueException" }, { "shape": "ConflictException" }, { "shape": "ServiceUnavailableException" }, { "shape": "ResourceNotFoundException" } ], "documentation": "

Deletes the report plan specified by a report plan name.

", "idempotent": true }, "DeleteRestoreTestingPlan": { "name": "DeleteRestoreTestingPlan", "http": { "method": "DELETE", "requestUri": "/restore-testing/plans/{RestoreTestingPlanName}", "responseCode": 204 }, "input": { "shape": "DeleteRestoreTestingPlanInput" }, "errors": [ { "shape": "InvalidRequestException" }, { "shape": "ServiceUnavailableException" } ], "documentation": "

This request deletes the specified restore testing plan.

Deletion can only successfully occur if all associated restore testing selections are deleted first.

", "idempotent": true }, "DeleteRestoreTestingSelection": { "name": "DeleteRestoreTestingSelection", "http": { "method": "DELETE", "requestUri": "/restore-testing/plans/{RestoreTestingPlanName}/selections/{RestoreTestingSelectionName}", "responseCode": 204 }, "input": { "shape": "DeleteRestoreTestingSelectionInput" }, "errors": [ { "shape": "ResourceNotFoundException" }, { "shape": "ServiceUnavailableException" } ], "documentation": "

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.

", "idempotent": true }, "DescribeBackupJob": { "name": "DescribeBackupJob", "http": { "method": "GET", "requestUri": "/backup-jobs/{backupJobId}" }, "input": { "shape": "DescribeBackupJobInput" }, "output": { "shape": "DescribeBackupJobOutput" }, "errors": [ { "shape": "ResourceNotFoundException" }, { "shape": "InvalidParameterValueException" }, { "shape": "MissingParameterValueException" }, { "shape": "ServiceUnavailableException" }, { "shape": "DependencyFailureException" } ], "documentation": "

Returns backup job details for the specified BackupJobId.

", "idempotent": true }, "DescribeBackupVault": { "name": "DescribeBackupVault", "http": { "method": "GET", "requestUri": "/backup-vaults/{backupVaultName}" }, "input": { "shape": "DescribeBackupVaultInput" }, "output": { "shape": "DescribeBackupVaultOutput" }, "errors": [ { "shape": "ResourceNotFoundException" }, { "shape": "InvalidParameterValueException" }, { "shape": "MissingParameterValueException" }, { "shape": "ServiceUnavailableException" } ], "documentation": "

Returns metadata about a backup vault specified by its name.

", "idempotent": true }, "DescribeCopyJob": { "name": "DescribeCopyJob", "http": { "method": "GET", "requestUri": "/copy-jobs/{copyJobId}" }, "input": { "shape": "DescribeCopyJobInput" }, "output": { "shape": "DescribeCopyJobOutput" }, "errors": [ { "shape": "ResourceNotFoundException" }, { "shape": "InvalidParameterValueException" }, { "shape": "MissingParameterValueException" }, { "shape": "ServiceUnavailableException" } ], "documentation": "

Returns metadata associated with creating a copy of a resource.

", "idempotent": true }, "DescribeFramework": { "name": "DescribeFramework", "http": { "method": "GET", "requestUri": "/audit/frameworks/{frameworkName}" }, "input": { "shape": "DescribeFrameworkInput" }, "output": { "shape": "DescribeFrameworkOutput" }, "errors": [ { "shape": "ResourceNotFoundException" }, { "shape": "InvalidParameterValueException" }, { "shape": "MissingParameterValueException" }, { "shape": "ServiceUnavailableException" } ], "documentation": "

Returns the framework details for the specified FrameworkName.

" }, "DescribeGlobalSettings": { "name": "DescribeGlobalSettings", "http": { "method": "GET", "requestUri": "/global-settings" }, "input": { "shape": "DescribeGlobalSettingsInput" }, "output": { "shape": "DescribeGlobalSettingsOutput" }, "errors": [ { "shape": "InvalidRequestException" }, { "shape": "ServiceUnavailableException" } ], "documentation": "

Describes whether the Amazon Web Services account is opted in to cross-account backup. Returns an error if the account is not a member of an Organizations organization. Example: describe-global-settings --region us-west-2

" }, "DescribeProtectedResource": { "name": "DescribeProtectedResource", "http": { "method": "GET", "requestUri": "/resources/{resourceArn}" }, "input": { "shape": "DescribeProtectedResourceInput" }, "output": { "shape": "DescribeProtectedResourceOutput" }, "errors": [ { "shape": "MissingParameterValueException" }, { "shape": "InvalidParameterValueException" }, { "shape": "ServiceUnavailableException" }, { "shape": "ResourceNotFoundException" } ], "documentation": "

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.

", "idempotent": true }, "DescribeRecoveryPoint": { "name": "DescribeRecoveryPoint", "http": { "method": "GET", "requestUri": "/backup-vaults/{backupVaultName}/recovery-points/{recoveryPointArn}" }, "input": { "shape": "DescribeRecoveryPointInput" }, "output": { "shape": "DescribeRecoveryPointOutput" }, "errors": [ { "shape": "ResourceNotFoundException" }, { "shape": "InvalidParameterValueException" }, { "shape": "MissingParameterValueException" }, { "shape": "ServiceUnavailableException" } ], "documentation": "

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

", "idempotent": true }, "DescribeRegionSettings": { "name": "DescribeRegionSettings", "http": { "method": "GET", "requestUri": "/account-settings" }, "input": { "shape": "DescribeRegionSettingsInput" }, "output": { "shape": "DescribeRegionSettingsOutput" }, "errors": [ { "shape": "ServiceUnavailableException" } ], "documentation": "

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.

" }, "DescribeReportJob": { "name": "DescribeReportJob", "http": { "method": "GET", "requestUri": "/audit/report-jobs/{reportJobId}" }, "input": { "shape": "DescribeReportJobInput" }, "output": { "shape": "DescribeReportJobOutput" }, "errors": [ { "shape": "ServiceUnavailableException" }, { "shape": "MissingParameterValueException" }, { "shape": "ResourceNotFoundException" } ], "documentation": "

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

" }, "DescribeReportPlan": { "name": "DescribeReportPlan", "http": { "method": "GET", "requestUri": "/audit/report-plans/{reportPlanName}" }, "input": { "shape": "DescribeReportPlanInput" }, "output": { "shape": "DescribeReportPlanOutput" }, "errors": [ { "shape": "InvalidParameterValueException" }, { "shape": "MissingParameterValueException" }, { "shape": "ResourceNotFoundException" }, { "shape": "ServiceUnavailableException" } ], "documentation": "

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

" }, "DescribeRestoreJob": { "name": "DescribeRestoreJob", "http": { "method": "GET", "requestUri": "/restore-jobs/{restoreJobId}" }, "input": { "shape": "DescribeRestoreJobInput" }, "output": { "shape": "DescribeRestoreJobOutput" }, "errors": [ { "shape": "ResourceNotFoundException" }, { "shape": "InvalidParameterValueException" }, { "shape": "MissingParameterValueException" }, { "shape": "ServiceUnavailableException" }, { "shape": "DependencyFailureException" } ], "documentation": "

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

", "idempotent": true }, "DisassociateRecoveryPoint": { "name": "DisassociateRecoveryPoint", "http": { "method": "POST", "requestUri": "/backup-vaults/{backupVaultName}/recovery-points/{recoveryPointArn}/disassociate" }, "input": { "shape": "DisassociateRecoveryPointInput" }, "errors": [ { "shape": "ResourceNotFoundException" }, { "shape": "InvalidParameterValueException" }, { "shape": "MissingParameterValueException" }, { "shape": "InvalidResourceStateException" }, { "shape": "ServiceUnavailableException" }, { "shape": "InvalidRequestException" } ], "documentation": "

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.

" }, "DisassociateRecoveryPointFromParent": { "name": "DisassociateRecoveryPointFromParent", "http": { "method": "DELETE", "requestUri": "/backup-vaults/{backupVaultName}/recovery-points/{recoveryPointArn}/parentAssociation", "responseCode": 204 }, "input": { "shape": "DisassociateRecoveryPointFromParentInput" }, "errors": [ { "shape": "ResourceNotFoundException" }, { "shape": "InvalidParameterValueException" }, { "shape": "MissingParameterValueException" }, { "shape": "ServiceUnavailableException" }, { "shape": "InvalidRequestException" } ], "documentation": "

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

" }, "ExportBackupPlanTemplate": { "name": "ExportBackupPlanTemplate", "http": { "method": "GET", "requestUri": "/backup/plans/{backupPlanId}/toTemplate/" }, "input": { "shape": "ExportBackupPlanTemplateInput" }, "output": { "shape": "ExportBackupPlanTemplateOutput" }, "errors": [ { "shape": "InvalidParameterValueException" }, { "shape": "MissingParameterValueException" }, { "shape": "ServiceUnavailableException" }, { "shape": "ResourceNotFoundException" } ], "documentation": "

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

" }, "GetBackupPlan": { "name": "GetBackupPlan", "http": { "method": "GET", "requestUri": "/backup/plans/{backupPlanId}/" }, "input": { "shape": "GetBackupPlanInput" }, "output": { "shape": "GetBackupPlanOutput" }, "errors": [ { "shape": "ResourceNotFoundException" }, { "shape": "InvalidParameterValueException" }, { "shape": "MissingParameterValueException" }, { "shape": "ServiceUnavailableException" } ], "documentation": "

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

", "idempotent": true }, "GetBackupPlanFromJSON": { "name": "GetBackupPlanFromJSON", "http": { "method": "POST", "requestUri": "/backup/template/json/toPlan" }, "input": { "shape": "GetBackupPlanFromJSONInput" }, "output": { "shape": "GetBackupPlanFromJSONOutput" }, "errors": [ { "shape": "LimitExceededException" }, { "shape": "InvalidParameterValueException" }, { "shape": "MissingParameterValueException" }, { "shape": "ServiceUnavailableException" }, { "shape": "InvalidRequestException" } ], "documentation": "

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

" }, "GetBackupPlanFromTemplate": { "name": "GetBackupPlanFromTemplate", "http": { "method": "GET", "requestUri": "/backup/template/plans/{templateId}/toPlan" }, "input": { "shape": "GetBackupPlanFromTemplateInput" }, "output": { "shape": "GetBackupPlanFromTemplateOutput" }, "errors": [ { "shape": "InvalidParameterValueException" }, { "shape": "MissingParameterValueException" }, { "shape": "ServiceUnavailableException" }, { "shape": "ResourceNotFoundException" } ], "documentation": "

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

" }, "GetBackupSelection": { "name": "GetBackupSelection", "http": { "method": "GET", "requestUri": "/backup/plans/{backupPlanId}/selections/{selectionId}" }, "input": { "shape": "GetBackupSelectionInput" }, "output": { "shape": "GetBackupSelectionOutput" }, "errors": [ { "shape": "ResourceNotFoundException" }, { "shape": "InvalidParameterValueException" }, { "shape": "MissingParameterValueException" }, { "shape": "ServiceUnavailableException" } ], "documentation": "

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

", "idempotent": true }, "GetBackupVaultAccessPolicy": { "name": "GetBackupVaultAccessPolicy", "http": { "method": "GET", "requestUri": "/backup-vaults/{backupVaultName}/access-policy" }, "input": { "shape": "GetBackupVaultAccessPolicyInput" }, "output": { "shape": "GetBackupVaultAccessPolicyOutput" }, "errors": [ { "shape": "ResourceNotFoundException" }, { "shape": "InvalidParameterValueException" }, { "shape": "MissingParameterValueException" }, { "shape": "ServiceUnavailableException" } ], "documentation": "

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

", "idempotent": true }, "GetBackupVaultNotifications": { "name": "GetBackupVaultNotifications", "http": { "method": "GET", "requestUri": "/backup-vaults/{backupVaultName}/notification-configuration" }, "input": { "shape": "GetBackupVaultNotificationsInput" }, "output": { "shape": "GetBackupVaultNotificationsOutput" }, "errors": [ { "shape": "ResourceNotFoundException" }, { "shape": "InvalidParameterValueException" }, { "shape": "MissingParameterValueException" }, { "shape": "ServiceUnavailableException" } ], "documentation": "

Returns event notifications for the specified backup vault.

", "idempotent": true }, "GetLegalHold": { "name": "GetLegalHold", "http": { "method": "GET", "requestUri": "/legal-holds/{legalHoldId}/" }, "input": { "shape": "GetLegalHoldInput" }, "output": { "shape": "GetLegalHoldOutput" }, "errors": [ { "shape": "InvalidParameterValueException" }, { "shape": "MissingParameterValueException" }, { "shape": "ServiceUnavailableException" }, { "shape": "ResourceNotFoundException" } ], "documentation": "

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.

", "idempotent": true }, "GetRecoveryPointRestoreMetadata": { "name": "GetRecoveryPointRestoreMetadata", "http": { "method": "GET", "requestUri": "/backup-vaults/{backupVaultName}/recovery-points/{recoveryPointArn}/restore-metadata" }, "input": { "shape": "GetRecoveryPointRestoreMetadataInput" }, "output": { "shape": "GetRecoveryPointRestoreMetadataOutput" }, "errors": [ { "shape": "ResourceNotFoundException" }, { "shape": "InvalidParameterValueException" }, { "shape": "MissingParameterValueException" }, { "shape": "ServiceUnavailableException" } ], "documentation": "

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

", "idempotent": true }, "GetRestoreJobMetadata": { "name": "GetRestoreJobMetadata", "http": { "method": "GET", "requestUri": "/restore-jobs/{restoreJobId}/metadata" }, "input": { "shape": "GetRestoreJobMetadataInput" }, "output": { "shape": "GetRestoreJobMetadataOutput" }, "errors": [ { "shape": "ResourceNotFoundException" }, { "shape": "InvalidParameterValueException" }, { "shape": "MissingParameterValueException" }, { "shape": "ServiceUnavailableException" } ], "documentation": "

This request returns the metadata for the specified restore job.

" }, "GetRestoreTestingInferredMetadata": { "name": "GetRestoreTestingInferredMetadata", "http": { "method": "GET", "requestUri": "/restore-testing/inferred-metadata", "responseCode": 200 }, "input": { "shape": "GetRestoreTestingInferredMetadataInput" }, "output": { "shape": "GetRestoreTestingInferredMetadataOutput" }, "errors": [ { "shape": "InvalidParameterValueException" }, { "shape": "MissingParameterValueException" }, { "shape": "ResourceNotFoundException" }, { "shape": "ServiceUnavailableException" } ], "documentation": "

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.

" }, "GetRestoreTestingPlan": { "name": "GetRestoreTestingPlan", "http": { "method": "GET", "requestUri": "/restore-testing/plans/{RestoreTestingPlanName}", "responseCode": 200 }, "input": { "shape": "GetRestoreTestingPlanInput" }, "output": { "shape": "GetRestoreTestingPlanOutput" }, "errors": [ { "shape": "ResourceNotFoundException" }, { "shape": "ServiceUnavailableException" } ], "documentation": "

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.

" }, "GetRestoreTestingSelection": { "name": "GetRestoreTestingSelection", "http": { "method": "GET", "requestUri": "/restore-testing/plans/{RestoreTestingPlanName}/selections/{RestoreTestingSelectionName}", "responseCode": 200 }, "input": { "shape": "GetRestoreTestingSelectionInput" }, "output": { "shape": "GetRestoreTestingSelectionOutput" }, "errors": [ { "shape": "ResourceNotFoundException" }, { "shape": "ServiceUnavailableException" } ], "documentation": "

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

" }, "GetSupportedResourceTypes": { "name": "GetSupportedResourceTypes", "http": { "method": "GET", "requestUri": "/supported-resource-types" }, "output": { "shape": "GetSupportedResourceTypesOutput" }, "errors": [ { "shape": "ServiceUnavailableException" } ], "documentation": "

Returns the Amazon Web Services resource types supported by Backup.

" }, "ListBackupJobSummaries": { "name": "ListBackupJobSummaries", "http": { "method": "GET", "requestUri": "/audit/backup-job-summaries" }, "input": { "shape": "ListBackupJobSummariesInput" }, "output": { "shape": "ListBackupJobSummariesOutput" }, "errors": [ { "shape": "InvalidParameterValueException" }, { "shape": "ServiceUnavailableException" } ], "documentation": "

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.

" }, "ListBackupJobs": { "name": "ListBackupJobs", "http": { "method": "GET", "requestUri": "/backup-jobs/" }, "input": { "shape": "ListBackupJobsInput" }, "output": { "shape": "ListBackupJobsOutput" }, "errors": [ { "shape": "InvalidParameterValueException" }, { "shape": "ServiceUnavailableException" } ], "documentation": "

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.

", "idempotent": true }, "ListBackupPlanTemplates": { "name": "ListBackupPlanTemplates", "http": { "method": "GET", "requestUri": "/backup/template/plans" }, "input": { "shape": "ListBackupPlanTemplatesInput" }, "output": { "shape": "ListBackupPlanTemplatesOutput" }, "errors": [ { "shape": "InvalidParameterValueException" }, { "shape": "MissingParameterValueException" }, { "shape": "ServiceUnavailableException" }, { "shape": "ResourceNotFoundException" } ], "documentation": "

Returns metadata of your saved backup plan templates, including the template ID, name, and the creation and deletion dates.

" }, "ListBackupPlanVersions": { "name": "ListBackupPlanVersions", "http": { "method": "GET", "requestUri": "/backup/plans/{backupPlanId}/versions/" }, "input": { "shape": "ListBackupPlanVersionsInput" }, "output": { "shape": "ListBackupPlanVersionsOutput" }, "errors": [ { "shape": "ResourceNotFoundException" }, { "shape": "InvalidParameterValueException" }, { "shape": "MissingParameterValueException" }, { "shape": "ServiceUnavailableException" } ], "documentation": "

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

", "idempotent": true }, "ListBackupPlans": { "name": "ListBackupPlans", "http": { "method": "GET", "requestUri": "/backup/plans/" }, "input": { "shape": "ListBackupPlansInput" }, "output": { "shape": "ListBackupPlansOutput" }, "errors": [ { "shape": "ResourceNotFoundException" }, { "shape": "InvalidParameterValueException" }, { "shape": "MissingParameterValueException" }, { "shape": "ServiceUnavailableException" } ], "documentation": "

Returns a list of all active backup plans for an authenticated account. The list contains information such as Amazon Resource Names (ARNs), plan IDs, creation and deletion dates, version IDs, plan names, and creator request IDs.

", "idempotent": true }, "ListBackupSelections": { "name": "ListBackupSelections", "http": { "method": "GET", "requestUri": "/backup/plans/{backupPlanId}/selections/" }, "input": { "shape": "ListBackupSelectionsInput" }, "output": { "shape": "ListBackupSelectionsOutput" }, "errors": [ { "shape": "ResourceNotFoundException" }, { "shape": "InvalidParameterValueException" }, { "shape": "MissingParameterValueException" }, { "shape": "ServiceUnavailableException" } ], "documentation": "

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

", "idempotent": true }, "ListBackupVaults": { "name": "ListBackupVaults", "http": { "method": "GET", "requestUri": "/backup-vaults/" }, "input": { "shape": "ListBackupVaultsInput" }, "output": { "shape": "ListBackupVaultsOutput" }, "errors": [ { "shape": "ResourceNotFoundException" }, { "shape": "InvalidParameterValueException" }, { "shape": "MissingParameterValueException" }, { "shape": "ServiceUnavailableException" } ], "documentation": "

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

", "idempotent": true }, "ListCopyJobSummaries": { "name": "ListCopyJobSummaries", "http": { "method": "GET", "requestUri": "/audit/copy-job-summaries" }, "input": { "shape": "ListCopyJobSummariesInput" }, "output": { "shape": "ListCopyJobSummariesOutput" }, "errors": [ { "shape": "InvalidParameterValueException" }, { "shape": "ServiceUnavailableException" } ], "documentation": "

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.

" }, "ListCopyJobs": { "name": "ListCopyJobs", "http": { "method": "GET", "requestUri": "/copy-jobs/" }, "input": { "shape": "ListCopyJobsInput" }, "output": { "shape": "ListCopyJobsOutput" }, "errors": [ { "shape": "InvalidParameterValueException" }, { "shape": "ServiceUnavailableException" } ], "documentation": "

Returns metadata about your copy jobs.

" }, "ListFrameworks": { "name": "ListFrameworks", "http": { "method": "GET", "requestUri": "/audit/frameworks" }, "input": { "shape": "ListFrameworksInput" }, "output": { "shape": "ListFrameworksOutput" }, "errors": [ { "shape": "InvalidParameterValueException" }, { "shape": "ServiceUnavailableException" } ], "documentation": "

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

" }, "ListLegalHolds": { "name": "ListLegalHolds", "http": { "method": "GET", "requestUri": "/legal-holds/" }, "input": { "shape": "ListLegalHoldsInput" }, "output": { "shape": "ListLegalHoldsOutput" }, "errors": [ { "shape": "InvalidParameterValueException" }, { "shape": "ServiceUnavailableException" } ], "documentation": "

This action returns metadata about active and previous legal holds.

", "idempotent": true }, "ListProtectedResources": { "name": "ListProtectedResources", "http": { "method": "GET", "requestUri": "/resources/" }, "input": { "shape": "ListProtectedResourcesInput" }, "output": { "shape": "ListProtectedResourcesOutput" }, "errors": [ { "shape": "InvalidParameterValueException" }, { "shape": "ServiceUnavailableException" } ], "documentation": "

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.

", "idempotent": true }, "ListProtectedResourcesByBackupVault": { "name": "ListProtectedResourcesByBackupVault", "http": { "method": "GET", "requestUri": "/backup-vaults/{backupVaultName}/resources/" }, "input": { "shape": "ListProtectedResourcesByBackupVaultInput" }, "output": { "shape": "ListProtectedResourcesByBackupVaultOutput" }, "errors": [ { "shape": "InvalidParameterValueException" }, { "shape": "ResourceNotFoundException" }, { "shape": "ServiceUnavailableException" } ], "documentation": "

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

" }, "ListRecoveryPointsByBackupVault": { "name": "ListRecoveryPointsByBackupVault", "http": { "method": "GET", "requestUri": "/backup-vaults/{backupVaultName}/recovery-points/" }, "input": { "shape": "ListRecoveryPointsByBackupVaultInput" }, "output": { "shape": "ListRecoveryPointsByBackupVaultOutput" }, "errors": [ { "shape": "ResourceNotFoundException" }, { "shape": "InvalidParameterValueException" }, { "shape": "MissingParameterValueException" }, { "shape": "ServiceUnavailableException" } ], "documentation": "

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

", "idempotent": true }, "ListRecoveryPointsByLegalHold": { "name": "ListRecoveryPointsByLegalHold", "http": { "method": "GET", "requestUri": "/legal-holds/{legalHoldId}/recovery-points" }, "input": { "shape": "ListRecoveryPointsByLegalHoldInput" }, "output": { "shape": "ListRecoveryPointsByLegalHoldOutput" }, "errors": [ { "shape": "InvalidParameterValueException" }, { "shape": "MissingParameterValueException" }, { "shape": "ServiceUnavailableException" } ], "documentation": "

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

", "idempotent": true }, "ListRecoveryPointsByResource": { "name": "ListRecoveryPointsByResource", "http": { "method": "GET", "requestUri": "/resources/{resourceArn}/recovery-points/" }, "input": { "shape": "ListRecoveryPointsByResourceInput" }, "output": { "shape": "ListRecoveryPointsByResourceOutput" }, "errors": [ { "shape": "ResourceNotFoundException" }, { "shape": "InvalidParameterValueException" }, { "shape": "MissingParameterValueException" }, { "shape": "ServiceUnavailableException" } ], "documentation": "

Returns detailed information about all 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.

", "idempotent": true }, "ListReportJobs": { "name": "ListReportJobs", "http": { "method": "GET", "requestUri": "/audit/report-jobs" }, "input": { "shape": "ListReportJobsInput" }, "output": { "shape": "ListReportJobsOutput" }, "errors": [ { "shape": "InvalidParameterValueException" }, { "shape": "ServiceUnavailableException" }, { "shape": "ResourceNotFoundException" } ], "documentation": "

Returns details about your report jobs.

" }, "ListReportPlans": { "name": "ListReportPlans", "http": { "method": "GET", "requestUri": "/audit/report-plans" }, "input": { "shape": "ListReportPlansInput" }, "output": { "shape": "ListReportPlansOutput" }, "errors": [ { "shape": "InvalidParameterValueException" }, { "shape": "ServiceUnavailableException" } ], "documentation": "

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

" }, "ListRestoreJobSummaries": { "name": "ListRestoreJobSummaries", "http": { "method": "GET", "requestUri": "/audit/restore-job-summaries" }, "input": { "shape": "ListRestoreJobSummariesInput" }, "output": { "shape": "ListRestoreJobSummariesOutput" }, "errors": [ { "shape": "InvalidParameterValueException" }, { "shape": "ServiceUnavailableException" } ], "documentation": "

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.

" }, "ListRestoreJobs": { "name": "ListRestoreJobs", "http": { "method": "GET", "requestUri": "/restore-jobs/" }, "input": { "shape": "ListRestoreJobsInput" }, "output": { "shape": "ListRestoreJobsOutput" }, "errors": [ { "shape": "ResourceNotFoundException" }, { "shape": "InvalidParameterValueException" }, { "shape": "MissingParameterValueException" }, { "shape": "ServiceUnavailableException" } ], "documentation": "

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

", "idempotent": true }, "ListRestoreJobsByProtectedResource": { "name": "ListRestoreJobsByProtectedResource", "http": { "method": "GET", "requestUri": "/resources/{resourceArn}/restore-jobs/" }, "input": { "shape": "ListRestoreJobsByProtectedResourceInput" }, "output": { "shape": "ListRestoreJobsByProtectedResourceOutput" }, "errors": [ { "shape": "ResourceNotFoundException" }, { "shape": "InvalidParameterValueException" }, { "shape": "MissingParameterValueException" }, { "shape": "ServiceUnavailableException" } ], "documentation": "

This returns restore jobs that contain the specified protected resource.

You must include ResourceArn. You can optionally include NextToken, ByStatus, MaxResults, ByRecoveryPointCreationDateAfter , and ByRecoveryPointCreationDateBefore.

" }, "ListRestoreTestingPlans": { "name": "ListRestoreTestingPlans", "http": { "method": "GET", "requestUri": "/restore-testing/plans", "responseCode": 200 }, "input": { "shape": "ListRestoreTestingPlansInput" }, "output": { "shape": "ListRestoreTestingPlansOutput" }, "errors": [ { "shape": "InvalidParameterValueException" }, { "shape": "ServiceUnavailableException" } ], "documentation": "

Returns a list of restore testing plans.

" }, "ListRestoreTestingSelections": { "name": "ListRestoreTestingSelections", "http": { "method": "GET", "requestUri": "/restore-testing/plans/{RestoreTestingPlanName}/selections", "responseCode": 200 }, "input": { "shape": "ListRestoreTestingSelectionsInput" }, "output": { "shape": "ListRestoreTestingSelectionsOutput" }, "errors": [ { "shape": "InvalidParameterValueException" }, { "shape": "ResourceNotFoundException" }, { "shape": "ServiceUnavailableException" } ], "documentation": "

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

" }, "ListTags": { "name": "ListTags", "http": { "method": "GET", "requestUri": "/tags/{resourceArn}/" }, "input": { "shape": "ListTagsInput" }, "output": { "shape": "ListTagsOutput" }, "errors": [ { "shape": "ResourceNotFoundException" }, { "shape": "InvalidParameterValueException" }, { "shape": "MissingParameterValueException" }, { "shape": "ServiceUnavailableException" } ], "documentation": "

Returns a list of key-value pairs assigned to a target recovery point, backup plan, or backup vault.

ListTags only works for resource types that support full Backup management of their backups. Those resource types are listed in the \"Full Backup management\" section of the Feature availability by resource table.

", "idempotent": true }, "PutBackupVaultAccessPolicy": { "name": "PutBackupVaultAccessPolicy", "http": { "method": "PUT", "requestUri": "/backup-vaults/{backupVaultName}/access-policy" }, "input": { "shape": "PutBackupVaultAccessPolicyInput" }, "errors": [ { "shape": "ResourceNotFoundException" }, { "shape": "InvalidParameterValueException" }, { "shape": "MissingParameterValueException" }, { "shape": "ServiceUnavailableException" } ], "documentation": "

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.

", "idempotent": true }, "PutBackupVaultLockConfiguration": { "name": "PutBackupVaultLockConfiguration", "http": { "method": "PUT", "requestUri": "/backup-vaults/{backupVaultName}/vault-lock" }, "input": { "shape": "PutBackupVaultLockConfigurationInput" }, "errors": [ { "shape": "ResourceNotFoundException" }, { "shape": "InvalidParameterValueException" }, { "shape": "MissingParameterValueException" }, { "shape": "InvalidRequestException" }, { "shape": "ServiceUnavailableException" } ], "documentation": "

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.

", "idempotent": true }, "PutBackupVaultNotifications": { "name": "PutBackupVaultNotifications", "http": { "method": "PUT", "requestUri": "/backup-vaults/{backupVaultName}/notification-configuration" }, "input": { "shape": "PutBackupVaultNotificationsInput" }, "errors": [ { "shape": "ResourceNotFoundException" }, { "shape": "InvalidParameterValueException" }, { "shape": "MissingParameterValueException" }, { "shape": "ServiceUnavailableException" } ], "documentation": "

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

", "idempotent": true }, "PutRestoreValidationResult": { "name": "PutRestoreValidationResult", "http": { "method": "PUT", "requestUri": "/restore-jobs/{restoreJobId}/validations", "responseCode": 204 }, "input": { "shape": "PutRestoreValidationResultInput" }, "errors": [ { "shape": "InvalidParameterValueException" }, { "shape": "InvalidRequestException" }, { "shape": "MissingParameterValueException" }, { "shape": "ResourceNotFoundException" }, { "shape": "ServiceUnavailableException" } ], "documentation": "

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.

", "idempotent": true }, "StartBackupJob": { "name": "StartBackupJob", "http": { "method": "PUT", "requestUri": "/backup-jobs" }, "input": { "shape": "StartBackupJobInput" }, "output": { "shape": "StartBackupJobOutput" }, "errors": [ { "shape": "ResourceNotFoundException" }, { "shape": "InvalidParameterValueException" }, { "shape": "MissingParameterValueException" }, { "shape": "InvalidRequestException" }, { "shape": "ServiceUnavailableException" }, { "shape": "LimitExceededException" } ], "documentation": "

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

", "idempotent": true }, "StartCopyJob": { "name": "StartCopyJob", "http": { "method": "PUT", "requestUri": "/copy-jobs" }, "input": { "shape": "StartCopyJobInput" }, "output": { "shape": "StartCopyJobOutput" }, "errors": [ { "shape": "ResourceNotFoundException" }, { "shape": "InvalidParameterValueException" }, { "shape": "MissingParameterValueException" }, { "shape": "ServiceUnavailableException" }, { "shape": "LimitExceededException" }, { "shape": "InvalidRequestException" } ], "documentation": "

Starts a job to create a one-time copy of the specified resource.

Does not support continuous backups.

", "idempotent": true }, "StartReportJob": { "name": "StartReportJob", "http": { "method": "POST", "requestUri": "/audit/report-jobs/{reportPlanName}" }, "input": { "shape": "StartReportJobInput" }, "output": { "shape": "StartReportJobOutput" }, "errors": [ { "shape": "InvalidParameterValueException" }, { "shape": "ServiceUnavailableException" }, { "shape": "MissingParameterValueException" }, { "shape": "ResourceNotFoundException" } ], "documentation": "

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

", "idempotent": true }, "StartRestoreJob": { "name": "StartRestoreJob", "http": { "method": "PUT", "requestUri": "/restore-jobs" }, "input": { "shape": "StartRestoreJobInput" }, "output": { "shape": "StartRestoreJobOutput" }, "errors": [ { "shape": "ResourceNotFoundException" }, { "shape": "InvalidParameterValueException" }, { "shape": "MissingParameterValueException" }, { "shape": "ServiceUnavailableException" }, { "shape": "InvalidRequestException" } ], "documentation": "

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

", "idempotent": true }, "StopBackupJob": { "name": "StopBackupJob", "http": { "method": "POST", "requestUri": "/backup-jobs/{backupJobId}" }, "input": { "shape": "StopBackupJobInput" }, "errors": [ { "shape": "MissingParameterValueException" }, { "shape": "ResourceNotFoundException" }, { "shape": "InvalidParameterValueException" }, { "shape": "InvalidRequestException" }, { "shape": "ServiceUnavailableException" } ], "documentation": "

Attempts to cancel a job to create a one-time backup of a resource.

This action is not supported for the following services: Amazon FSx for Windows File Server, Amazon FSx for Lustre, Amazon FSx for NetApp ONTAP , Amazon FSx for OpenZFS, Amazon DocumentDB (with MongoDB compatibility), Amazon RDS, Amazon Aurora, and Amazon Neptune.

" }, "TagResource": { "name": "TagResource", "http": { "method": "POST", "requestUri": "/tags/{resourceArn}" }, "input": { "shape": "TagResourceInput" }, "errors": [ { "shape": "ResourceNotFoundException" }, { "shape": "InvalidParameterValueException" }, { "shape": "MissingParameterValueException" }, { "shape": "ServiceUnavailableException" }, { "shape": "LimitExceededException" } ], "documentation": "

Assigns a set of key-value pairs to a recovery point, backup plan, or backup vault identified by an Amazon Resource Name (ARN).

", "idempotent": true }, "UntagResource": { "name": "UntagResource", "http": { "method": "POST", "requestUri": "/untag/{resourceArn}" }, "input": { "shape": "UntagResourceInput" }, "errors": [ { "shape": "ResourceNotFoundException" }, { "shape": "InvalidParameterValueException" }, { "shape": "MissingParameterValueException" }, { "shape": "ServiceUnavailableException" } ], "documentation": "

Removes a set of key-value pairs from a recovery point, backup plan, or backup vault identified by an Amazon Resource Name (ARN)

", "idempotent": true }, "UpdateBackupPlan": { "name": "UpdateBackupPlan", "http": { "method": "POST", "requestUri": "/backup/plans/{backupPlanId}" }, "input": { "shape": "UpdateBackupPlanInput" }, "output": { "shape": "UpdateBackupPlanOutput" }, "errors": [ { "shape": "ResourceNotFoundException" }, { "shape": "InvalidParameterValueException" }, { "shape": "MissingParameterValueException" }, { "shape": "ServiceUnavailableException" } ], "documentation": "

Updates an existing backup plan identified by its backupPlanId with the input document in JSON format. The new version is uniquely identified by a VersionId.

", "idempotent": true }, "UpdateFramework": { "name": "UpdateFramework", "http": { "method": "PUT", "requestUri": "/audit/frameworks/{frameworkName}" }, "input": { "shape": "UpdateFrameworkInput" }, "output": { "shape": "UpdateFrameworkOutput" }, "errors": [ { "shape": "AlreadyExistsException" }, { "shape": "ResourceNotFoundException" }, { "shape": "LimitExceededException" }, { "shape": "InvalidParameterValueException" }, { "shape": "MissingParameterValueException" }, { "shape": "ConflictException" }, { "shape": "ServiceUnavailableException" } ], "documentation": "

Updates an existing framework identified by its FrameworkName with the input document in JSON format.

", "idempotent": true }, "UpdateGlobalSettings": { "name": "UpdateGlobalSettings", "http": { "method": "PUT", "requestUri": "/global-settings" }, "input": { "shape": "UpdateGlobalSettingsInput" }, "errors": [ { "shape": "ServiceUnavailableException" }, { "shape": "MissingParameterValueException" }, { "shape": "InvalidParameterValueException" }, { "shape": "InvalidRequestException" } ], "documentation": "

Updates whether the Amazon Web Services account is opted in to cross-account backup. Returns an error if the account is not an Organizations management account. Use the DescribeGlobalSettings API to determine the current settings.

" }, "UpdateRecoveryPointLifecycle": { "name": "UpdateRecoveryPointLifecycle", "http": { "method": "POST", "requestUri": "/backup-vaults/{backupVaultName}/recovery-points/{recoveryPointArn}" }, "input": { "shape": "UpdateRecoveryPointLifecycleInput" }, "output": { "shape": "UpdateRecoveryPointLifecycleOutput" }, "errors": [ { "shape": "ResourceNotFoundException" }, { "shape": "InvalidParameterValueException" }, { "shape": "InvalidRequestException" }, { "shape": "MissingParameterValueException" }, { "shape": "ServiceUnavailableException" } ], "documentation": "

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.

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 are able to be transitioned to cold storage are listed in the \"Lifecycle to cold storage\" section of the Feature availability by resource table. Backup ignores this expression for other resource types.

This operation does not support continuous backups.

", "idempotent": true }, "UpdateRegionSettings": { "name": "UpdateRegionSettings", "http": { "method": "PUT", "requestUri": "/account-settings" }, "input": { "shape": "UpdateRegionSettingsInput" }, "errors": [ { "shape": "ServiceUnavailableException" }, { "shape": "MissingParameterValueException" }, { "shape": "InvalidParameterValueException" } ], "documentation": "

Updates the current service opt-in settings for the Region.

Use the DescribeRegionSettings API to determine the resource types that are supported.

" }, "UpdateReportPlan": { "name": "UpdateReportPlan", "http": { "method": "PUT", "requestUri": "/audit/report-plans/{reportPlanName}" }, "input": { "shape": "UpdateReportPlanInput" }, "output": { "shape": "UpdateReportPlanOutput" }, "errors": [ { "shape": "ResourceNotFoundException" }, { "shape": "InvalidParameterValueException" }, { "shape": "ServiceUnavailableException" }, { "shape": "MissingParameterValueException" }, { "shape": "ConflictException" } ], "documentation": "

Updates an existing report plan identified by its ReportPlanName with the input document in JSON format.

", "idempotent": true }, "UpdateRestoreTestingPlan": { "name": "UpdateRestoreTestingPlan", "http": { "method": "PUT", "requestUri": "/restore-testing/plans/{RestoreTestingPlanName}", "responseCode": 200 }, "input": { "shape": "UpdateRestoreTestingPlanInput" }, "output": { "shape": "UpdateRestoreTestingPlanOutput" }, "errors": [ { "shape": "ConflictException" }, { "shape": "InvalidParameterValueException" }, { "shape": "MissingParameterValueException" }, { "shape": "ResourceNotFoundException" }, { "shape": "ServiceUnavailableException" } ], "documentation": "

This request will send changes to your specified restore testing plan. RestoreTestingPlanName cannot be updated after it is created.

RecoveryPointSelection can contain:

", "idempotent": true }, "UpdateRestoreTestingSelection": { "name": "UpdateRestoreTestingSelection", "http": { "method": "PUT", "requestUri": "/restore-testing/plans/{RestoreTestingPlanName}/selections/{RestoreTestingSelectionName}", "responseCode": 200 }, "input": { "shape": "UpdateRestoreTestingSelectionInput" }, "output": { "shape": "UpdateRestoreTestingSelectionOutput" }, "errors": [ { "shape": "ConflictException" }, { "shape": "InvalidParameterValueException" }, { "shape": "MissingParameterValueException" }, { "shape": "ResourceNotFoundException" }, { "shape": "ServiceUnavailableException" } ], "documentation": "

Most elements except the RestoreTestingSelectionName can be updated with this request.

RestoreTestingSelection can use either protected resource ARNs or conditions, but not both. That is, if your selection has ProtectedResourceArns, requesting an update with the parameter ProtectedResourceConditions will be unsuccessful.

", "idempotent": true } }, "shapes": { "ARN": { "type": "string" }, "AccountId": { "type": "string", "pattern": "^[0-9]{12}$" }, "AdvancedBackupSetting": { "type": "structure", "members": { "ResourceType": { "shape": "ResourceType", "documentation": "

Specifies an object containing resource type and backup options. The only supported resource type is Amazon EC2 instances with Windows Volume Shadow Copy Service (VSS). For a CloudFormation example, see the sample CloudFormation template to enable Windows VSS in the Backup User Guide.

Valid values: EC2.

" }, "BackupOptions": { "shape": "BackupOptions", "documentation": "

Specifies the backup option for a selected resource. This option is only available for Windows VSS backup jobs.

Valid values:

Set to \"WindowsVSS\":\"enabled\" to enable the WindowsVSS backup option and create a Windows VSS backup.

Set to \"WindowsVSS\":\"disabled\" to create a regular backup. The WindowsVSS option is not enabled by default.

If you specify an invalid option, you get an InvalidParameterValueException exception.

For more information about Windows VSS backups, see Creating a VSS-Enabled Windows Backup.

" } }, "documentation": "

A list of backup options for each resource type.

" }, "AdvancedBackupSettings": { "type": "list", "member": { "shape": "AdvancedBackupSetting" } }, "AggregationPeriod": { "type": "string", "enum": [ "ONE_DAY", "SEVEN_DAYS", "FOURTEEN_DAYS" ] }, "BackupJob": { "type": "structure", "members": { "AccountId": { "shape": "AccountId", "documentation": "

The account ID that owns the backup job.

" }, "BackupJobId": { "shape": "string", "documentation": "

Uniquely identifies a request to Backup to back up a resource.

" }, "BackupVaultName": { "shape": "BackupVaultName", "documentation": "

The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.

" }, "BackupVaultArn": { "shape": "ARN", "documentation": "

An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.

" }, "RecoveryPointArn": { "shape": "ARN", "documentation": "

An ARN that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

" }, "ResourceArn": { "shape": "ARN", "documentation": "

An ARN that uniquely identifies a resource. The format of the ARN depends on the resource type.

" }, "CreationDate": { "shape": "timestamp", "documentation": "

The date and time a backup job is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

" }, "CompletionDate": { "shape": "timestamp", "documentation": "

The date and time a job to create a backup job is completed, in Unix format and Coordinated Universal Time (UTC). The value of CompletionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

" }, "State": { "shape": "BackupJobState", "documentation": "

The current state of a backup job.

" }, "StatusMessage": { "shape": "string", "documentation": "

A detailed message explaining the status of the job to back up a resource.

" }, "PercentDone": { "shape": "string", "documentation": "

Contains an estimated percentage complete of a job at the time the job status was queried.

" }, "BackupSizeInBytes": { "shape": "Long", "documentation": "

The size, in bytes, of a backup.

" }, "IamRoleArn": { "shape": "IAMRoleArn", "documentation": "

Specifies the IAM role ARN used to create the target recovery point. IAM roles other than the default role must include either AWSBackup or AwsBackup in the role name. For example, arn:aws:iam::123456789012:role/AWSBackupRDSAccess. Role names without those strings lack permissions to perform backup jobs.

" }, "CreatedBy": { "shape": "RecoveryPointCreator", "documentation": "

Contains identifying information about the creation of a backup job, including the BackupPlanArn, BackupPlanId, BackupPlanVersion, and BackupRuleId of the backup plan used to create it.

" }, "ExpectedCompletionDate": { "shape": "timestamp", "documentation": "

The date and time a job to back up resources is expected to be completed, in Unix format and Coordinated Universal Time (UTC). The value of ExpectedCompletionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

" }, "StartBy": { "shape": "timestamp", "documentation": "

Specifies the time in Unix format and Coordinated Universal Time (UTC) when a backup job must be started before it is canceled. The value is calculated by adding the start window to the scheduled time. So if the scheduled time were 6:00 PM and the start window is 2 hours, the StartBy time would be 8:00 PM on the date specified. The value of StartBy is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

" }, "ResourceType": { "shape": "ResourceType", "documentation": "

The type of Amazon Web Services resource to be backed up; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database. For Windows Volume Shadow Copy Service (VSS) backups, the only supported resource type is Amazon EC2.

" }, "BytesTransferred": { "shape": "Long", "documentation": "

The size in bytes transferred to a backup vault at the time that the job status was queried.

" }, "BackupOptions": { "shape": "BackupOptions", "documentation": "

Specifies the backup option for a selected resource. This option is only available for Windows Volume Shadow Copy Service (VSS) backup jobs.

Valid values: Set to \"WindowsVSS\":\"enabled\" to enable the WindowsVSS backup option and create a Windows VSS backup. Set to \"WindowsVSS\":\"disabled\" to create a regular backup. If you specify an invalid option, you get an InvalidParameterValueException exception.

" }, "BackupType": { "shape": "string", "documentation": "

Represents the type of backup for a backup job.

" }, "ParentJobId": { "shape": "string", "documentation": "

This uniquely identifies a request to Backup to back up a resource. The return will be the parent (composite) job ID.

" }, "IsParent": { "shape": "boolean", "documentation": "

This is a boolean value indicating this is a parent (composite) backup job.

" }, "ResourceName": { "shape": "string", "documentation": "

This is the non-unique name of the resource that belongs to the specified backup.

" }, "InitiationDate": { "shape": "timestamp", "documentation": "

This is the date on which the backup job was initiated.

" }, "MessageCategory": { "shape": "string", "documentation": "

This parameter is the job count for the specified message category.

Example strings may include AccessDenied, SUCCESS, AGGREGATE_ALL, and INVALIDPARAMETERS. See Monitoring for a list of MessageCategory strings.

The the value ANY returns count of all message categories.

AGGREGATE_ALL aggregates job counts for all message categories and returns the sum.

" } }, "documentation": "

Contains detailed information about a backup job.

" }, "BackupJobChildJobsInState": { "type": "map", "key": { "shape": "BackupJobState" }, "value": { "shape": "Long" } }, "BackupJobState": { "type": "string", "enum": [ "CREATED", "PENDING", "RUNNING", "ABORTING", "ABORTED", "COMPLETED", "FAILED", "EXPIRED", "PARTIAL" ] }, "BackupJobStatus": { "type": "string", "enum": [ "CREATED", "PENDING", "RUNNING", "ABORTING", "ABORTED", "COMPLETED", "FAILED", "EXPIRED", "PARTIAL", "AGGREGATE_ALL", "ANY" ] }, "BackupJobSummary": { "type": "structure", "members": { "Region": { "shape": "Region", "documentation": "

The Amazon Web Services Regions within the job summary.

" }, "AccountId": { "shape": "AccountId", "documentation": "

The account ID that owns the jobs within the summary.

" }, "State": { "shape": "BackupJobStatus", "documentation": "

This value is job count for jobs with the specified state.

" }, "ResourceType": { "shape": "ResourceType", "documentation": "

This value is the job count for the specified resource type. The request GetSupportedResourceTypes returns strings for supported resource types.

" }, "MessageCategory": { "shape": "MessageCategory", "documentation": "

This parameter is the job count for the specified message category.

Example strings include AccessDenied, Success, and InvalidParameters. See Monitoring for a list of MessageCategory strings.

The the value ANY returns count of all message categories.

AGGREGATE_ALL aggregates job counts for all message categories and returns the sum.

" }, "Count": { "shape": "integer", "documentation": "

The value as a number of jobs in a job summary.

" }, "StartTime": { "shape": "timestamp", "documentation": "

The value of time in number format of a job start time.

This value is the time in Unix format, Coordinated Universal Time (UTC), and accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

" }, "EndTime": { "shape": "timestamp", "documentation": "

The value of time in number format of a job end time.

This value is the time in Unix format, Coordinated Universal Time (UTC), and accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

" } }, "documentation": "

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.

" }, "BackupJobSummaryList": { "type": "list", "member": { "shape": "BackupJobSummary" } }, "BackupJobsList": { "type": "list", "member": { "shape": "BackupJob" } }, "BackupOptionKey": { "type": "string", "pattern": "^[a-zA-Z0-9\\-\\_\\.]{1,50}$" }, "BackupOptionValue": { "type": "string", "pattern": "^[a-zA-Z0-9\\-\\_\\.]{1,50}$" }, "BackupOptions": { "type": "map", "key": { "shape": "BackupOptionKey" }, "value": { "shape": "BackupOptionValue" } }, "BackupPlan": { "type": "structure", "required": [ "BackupPlanName", "Rules" ], "members": { "BackupPlanName": { "shape": "BackupPlanName", "documentation": "

The display name of a backup plan. Must contain 1 to 50 alphanumeric or '-_.' characters.

" }, "Rules": { "shape": "BackupRules", "documentation": "

An array of BackupRule objects, each of which specifies a scheduled task that is used to back up a selection of resources.

" }, "AdvancedBackupSettings": { "shape": "AdvancedBackupSettings", "documentation": "

Contains a list of BackupOptions for each resource type.

" } }, "documentation": "

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.

" }, "BackupPlanInput": { "type": "structure", "required": [ "BackupPlanName", "Rules" ], "members": { "BackupPlanName": { "shape": "BackupPlanName", "documentation": "

The display name of a backup plan. Must contain 1 to 50 alphanumeric or '-_.' characters.

" }, "Rules": { "shape": "BackupRulesInput", "documentation": "

An array of BackupRule objects, each of which specifies a scheduled task that is used to back up a selection of resources.

" }, "AdvancedBackupSettings": { "shape": "AdvancedBackupSettings", "documentation": "

Specifies a list of BackupOptions for each resource type. These settings are only available for Windows Volume Shadow Copy Service (VSS) backup jobs.

" } }, "documentation": "

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.

" }, "BackupPlanName": { "type": "string" }, "BackupPlanTemplatesList": { "type": "list", "member": { "shape": "BackupPlanTemplatesListMember" } }, "BackupPlanTemplatesListMember": { "type": "structure", "members": { "BackupPlanTemplateId": { "shape": "string", "documentation": "

Uniquely identifies a stored backup plan template.

" }, "BackupPlanTemplateName": { "shape": "string", "documentation": "

The optional display name of a backup plan template.

" } }, "documentation": "

An object specifying metadata associated with a backup plan template.

" }, "BackupPlanVersionsList": { "type": "list", "member": { "shape": "BackupPlansListMember" } }, "BackupPlansList": { "type": "list", "member": { "shape": "BackupPlansListMember" } }, "BackupPlansListMember": { "type": "structure", "members": { "BackupPlanArn": { "shape": "ARN", "documentation": "

An Amazon Resource Name (ARN) that uniquely identifies a backup plan; for example, arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50.

" }, "BackupPlanId": { "shape": "string", "documentation": "

Uniquely identifies a backup plan.

" }, "CreationDate": { "shape": "timestamp", "documentation": "

The date and time a resource backup plan is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

" }, "DeletionDate": { "shape": "timestamp", "documentation": "

The date and time a backup plan is deleted, in Unix format and Coordinated Universal Time (UTC). The value of DeletionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

" }, "VersionId": { "shape": "string", "documentation": "

Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes long. Version IDs cannot be edited.

" }, "BackupPlanName": { "shape": "BackupPlanName", "documentation": "

The display name of a saved backup plan.

" }, "CreatorRequestId": { "shape": "string", "documentation": "

A unique string that identifies the request and allows failed requests to be retried without the risk of running the operation twice. This parameter is optional.

If used, this parameter must contain 1 to 50 alphanumeric or '-_.' characters.

" }, "LastExecutionDate": { "shape": "timestamp", "documentation": "

The last time a job to back up resources was run with this rule. A date and time, in Unix format and Coordinated Universal Time (UTC). The value of LastExecutionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

" }, "AdvancedBackupSettings": { "shape": "AdvancedBackupSettings", "documentation": "

Contains a list of BackupOptions for a resource type.

" } }, "documentation": "

Contains metadata about a backup plan.

" }, "BackupRule": { "type": "structure", "required": [ "RuleName", "TargetBackupVaultName" ], "members": { "RuleName": { "shape": "BackupRuleName", "documentation": "

A display name for a backup rule. Must contain 1 to 50 alphanumeric or '-_.' characters.

" }, "TargetBackupVaultName": { "shape": "BackupVaultName", "documentation": "

The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.

" }, "ScheduleExpression": { "shape": "CronExpression", "documentation": "

A cron expression in UTC specifying when Backup initiates a backup job. For more information about Amazon Web Services cron expressions, see Schedule Expressions for Rules in the Amazon CloudWatch Events User Guide.. Two examples of Amazon Web Services cron expressions are 15 * ? * * * (take a backup every hour at 15 minutes past the hour) and 0 12 * * ? * (take a backup every day at 12 noon UTC). For a table of examples, click the preceding link and scroll down the page.

" }, "StartWindowMinutes": { "shape": "WindowMinutes", "documentation": "

A value in minutes after a backup is scheduled before a job will be canceled if it doesn't start successfully. This value is optional. If this value is included, it must be at least 60 minutes to avoid errors.

During the start window, the backup job status remains in CREATED status until it has successfully begun or until the start window time has run out. If within the start window time Backup receives an error that allows the job to be retried, Backup will automatically retry to begin the job at least every 10 minutes until the backup successfully begins (the job status changes to RUNNING) or until the job status changes to EXPIRED (which is expected to occur when the start window time is over).

" }, "CompletionWindowMinutes": { "shape": "WindowMinutes", "documentation": "

A value in minutes after a backup job is successfully started before it must be completed or it will be canceled by Backup. This value is optional.

" }, "Lifecycle": { "shape": "Lifecycle", "documentation": "

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 are able to be transitioned to cold storage are listed in the \"Lifecycle to cold storage\" section of the Feature availability by resource table. Backup ignores this expression for other resource types.

" }, "RecoveryPointTags": { "shape": "Tags", "documentation": "

An array of key-value pair strings that are assigned to resources that are associated with this rule when restored from backup.

" }, "RuleId": { "shape": "string", "documentation": "

Uniquely identifies a rule that is used to schedule the backup of a selection of resources.

" }, "CopyActions": { "shape": "CopyActions", "documentation": "

An array of CopyAction objects, which contains the details of the copy operation.

" }, "EnableContinuousBackup": { "shape": "Boolean", "documentation": "

Specifies whether Backup creates continuous backups. True causes Backup to create continuous backups capable of point-in-time restore (PITR). False (or not specified) causes Backup to create snapshot backups.

" }, "ScheduleExpressionTimezone": { "shape": "Timezone", "documentation": "

This is the timezone in which the schedule expression is set. By default, ScheduleExpressions are in UTC. You can modify this to a specified timezone.

" } }, "documentation": "

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

" }, "BackupRuleInput": { "type": "structure", "required": [ "RuleName", "TargetBackupVaultName" ], "members": { "RuleName": { "shape": "BackupRuleName", "documentation": "

A display name for a backup rule. Must contain 1 to 50 alphanumeric or '-_.' characters.

" }, "TargetBackupVaultName": { "shape": "BackupVaultName", "documentation": "

The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.

" }, "ScheduleExpression": { "shape": "CronExpression", "documentation": "

A CRON expression in UTC specifying when Backup initiates a backup job.

" }, "StartWindowMinutes": { "shape": "WindowMinutes", "documentation": "

A value in minutes after a backup is scheduled before a job will be canceled if it doesn't start successfully. This value is optional. If this value is included, it must be at least 60 minutes to avoid errors.

This parameter has a maximum value of 100 years (52,560,000 minutes).

During the start window, the backup job status remains in CREATED status until it has successfully begun or until the start window time has run out. If within the start window time Backup receives an error that allows the job to be retried, Backup will automatically retry to begin the job at least every 10 minutes until the backup successfully begins (the job status changes to RUNNING) or until the job status changes to EXPIRED (which is expected to occur when the start window time is over).

" }, "CompletionWindowMinutes": { "shape": "WindowMinutes", "documentation": "

A value in minutes after a backup job is successfully started before it must be completed or it will be canceled by Backup. This value is optional.

" }, "Lifecycle": { "shape": "Lifecycle", "documentation": "

The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. Backup will transition and expire 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 are able to be transitioned to cold storage are listed in the \"Lifecycle to cold storage\" section of the Feature availability by resource table. Backup ignores this expression for other resource types.

This parameter has a maximum value of 100 years (36,500 days).

" }, "RecoveryPointTags": { "shape": "Tags", "documentation": "

To help organize your resources, you can assign your own metadata to the resources that you create. Each tag is a key-value pair.

" }, "CopyActions": { "shape": "CopyActions", "documentation": "

An array of CopyAction objects, which contains the details of the copy operation.

" }, "EnableContinuousBackup": { "shape": "Boolean", "documentation": "

Specifies whether Backup creates continuous backups. True causes Backup to create continuous backups capable of point-in-time restore (PITR). False (or not specified) causes Backup to create snapshot backups.

" }, "ScheduleExpressionTimezone": { "shape": "Timezone", "documentation": "

This is the timezone in which the schedule expression is set. By default, ScheduleExpressions are in UTC. You can modify this to a specified timezone.

" } }, "documentation": "

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

" }, "BackupRuleName": { "type": "string", "pattern": "^[a-zA-Z0-9\\-\\_\\.]{1,50}$" }, "BackupRules": { "type": "list", "member": { "shape": "BackupRule" } }, "BackupRulesInput": { "type": "list", "member": { "shape": "BackupRuleInput" } }, "BackupSelection": { "type": "structure", "required": [ "SelectionName", "IamRoleArn" ], "members": { "SelectionName": { "shape": "BackupSelectionName", "documentation": "

The display name of a resource selection document. Must contain 1 to 50 alphanumeric or '-_.' characters.

" }, "IamRoleArn": { "shape": "IAMRoleArn", "documentation": "

The ARN of the IAM role that Backup uses to authenticate when backing up the target resource; for example, arn:aws:iam::123456789012:role/S3Access.

" }, "Resources": { "shape": "ResourceArns", "documentation": "

A list of Amazon Resource Names (ARNs) to assign to a backup plan. The maximum number of ARNs is 500 without wildcards, or 30 ARNs with wildcards.

If you need to assign many resources to a backup plan, consider a different resource selection strategy, such as assigning all resources of a resource type or refining your resource selection using tags.

" }, "ListOfTags": { "shape": "ListOfTags", "documentation": "

A list of conditions that you define to assign resources to your backup plans using tags. For example, \"StringEquals\": { \"Key\": \"aws:ResourceTag/CreatedByCryo\", \"Value\": \"true\" },. Condition operators are case sensitive.

ListOfTags differs from Conditions as follows:

" }, "NotResources": { "shape": "ResourceArns", "documentation": "

A list of Amazon Resource Names (ARNs) to exclude from a backup plan. The maximum number of ARNs is 500 without wildcards, or 30 ARNs with wildcards.

If you need to exclude many resources from a backup plan, consider a different resource selection strategy, such as assigning only one or a few resource types or refining your resource selection using tags.

" }, "Conditions": { "shape": "Conditions", "documentation": "

A list of conditions that you define to assign resources to your backup plans using tags. For example, \"StringEquals\": { \"Key\": \"aws:ResourceTag/CreatedByCryo\", \"Value\": \"true\" },. Condition operators are case sensitive.

Conditions differs from ListOfTags as follows:

" } }, "documentation": "

Used to specify a set of resources to a backup plan.

Specifying your desired Conditions, ListOfTags, NotResources, and/or Resources is recommended. If none of these are specified, Backup will attempt to select all supported and opted-in storage resources, which could have unintended cost implications.

" }, "BackupSelectionName": { "type": "string", "pattern": "^[a-zA-Z0-9\\-\\_\\.]{1,50}$" }, "BackupSelectionsList": { "type": "list", "member": { "shape": "BackupSelectionsListMember" } }, "BackupSelectionsListMember": { "type": "structure", "members": { "SelectionId": { "shape": "string", "documentation": "

Uniquely identifies a request to assign a set of resources to a backup plan.

" }, "SelectionName": { "shape": "BackupSelectionName", "documentation": "

The display name of a resource selection document.

" }, "BackupPlanId": { "shape": "string", "documentation": "

Uniquely identifies a backup plan.

" }, "CreationDate": { "shape": "timestamp", "documentation": "

The date and time a backup plan is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

" }, "CreatorRequestId": { "shape": "string", "documentation": "

A unique string that identifies the request and allows failed requests to be retried without the risk of running the operation twice. This parameter is optional.

If used, this parameter must contain 1 to 50 alphanumeric or '-_.' characters.

" }, "IamRoleArn": { "shape": "IAMRoleArn", "documentation": "

Specifies the IAM role Amazon Resource Name (ARN) to create the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access.

" } }, "documentation": "

Contains metadata about a BackupSelection object.

" }, "BackupVaultEvent": { "type": "string", "enum": [ "BACKUP_JOB_STARTED", "BACKUP_JOB_COMPLETED", "BACKUP_JOB_SUCCESSFUL", "BACKUP_JOB_FAILED", "BACKUP_JOB_EXPIRED", "RESTORE_JOB_STARTED", "RESTORE_JOB_COMPLETED", "RESTORE_JOB_SUCCESSFUL", "RESTORE_JOB_FAILED", "COPY_JOB_STARTED", "COPY_JOB_SUCCESSFUL", "COPY_JOB_FAILED", "RECOVERY_POINT_MODIFIED", "BACKUP_PLAN_CREATED", "BACKUP_PLAN_MODIFIED", "S3_BACKUP_OBJECT_FAILED", "S3_RESTORE_OBJECT_FAILED" ] }, "BackupVaultEvents": { "type": "list", "member": { "shape": "BackupVaultEvent" } }, "BackupVaultList": { "type": "list", "member": { "shape": "BackupVaultListMember" } }, "BackupVaultListMember": { "type": "structure", "members": { "BackupVaultName": { "shape": "BackupVaultName", "documentation": "

The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.

" }, "BackupVaultArn": { "shape": "ARN", "documentation": "

An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.

" }, "CreationDate": { "shape": "timestamp", "documentation": "

The date and time a resource backup is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

" }, "EncryptionKeyArn": { "shape": "ARN", "documentation": "

A server-side encryption key you can specify to encrypt your backups from services that support full Backup management; for example, arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab. If you specify a key, you must specify its ARN, not its alias. If you do not specify a key, Backup creates a KMS key for you by default.

To learn which Backup services support full Backup management and how Backup handles encryption for backups from services that do not yet support full Backup, see Encryption for backups in Backup

" }, "CreatorRequestId": { "shape": "string", "documentation": "

A unique string that identifies the request and allows failed requests to be retried without the risk of running the operation twice. This parameter is optional.

If used, this parameter must contain 1 to 50 alphanumeric or '-_.' characters.

" }, "NumberOfRecoveryPoints": { "shape": "long", "documentation": "

The number of recovery points that are stored in a backup vault.

" }, "Locked": { "shape": "Boolean", "documentation": "

A Boolean value that indicates whether Backup Vault Lock applies to the selected backup vault. If true, Vault Lock prevents delete and update operations on the recovery points in the selected vault.

" }, "MinRetentionDays": { "shape": "Long", "documentation": "

The Backup Vault Lock setting that specifies the minimum retention period that the vault retains its recovery points. If this parameter is not specified, Vault Lock does not enforce a minimum retention period.

If specified, any backup or copy job to the vault must have a lifecycle policy with a retention period equal to or longer than the minimum retention period. If the job's retention period is shorter than that minimum retention period, then the vault fails the backup or copy job, and you should either modify your lifecycle settings or use a different vault. Recovery points already stored in the vault prior to Vault Lock are not affected.

" }, "MaxRetentionDays": { "shape": "Long", "documentation": "

The Backup Vault Lock setting that specifies the maximum retention period that the vault retains its recovery points. If this parameter is not specified, Vault Lock does not enforce a maximum retention period on the recovery points in the vault (allowing indefinite storage).

If specified, any backup or copy job to the vault must have a lifecycle policy with a retention period equal to or shorter than the maximum retention period. If the job's retention period is longer than that maximum retention period, then the vault fails the backup or copy job, and you should either modify your lifecycle settings or use a different vault. Recovery points already stored in the vault prior to Vault Lock are not affected.

" }, "LockDate": { "shape": "timestamp", "documentation": "

The date and time when Backup Vault Lock configuration becomes immutable, meaning it cannot be changed or deleted.

If you applied Vault Lock to your vault without specifying a lock date, you can change your Vault Lock settings, or delete Vault Lock from the vault entirely, at any time.

This value is in Unix format, Coordinated Universal Time (UTC), and accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

" } }, "documentation": "

Contains metadata about a backup vault.

" }, "BackupVaultName": { "type": "string", "pattern": "^[a-zA-Z0-9\\-\\_]{2,50}$" }, "Boolean": { "type": "boolean" }, "CalculatedLifecycle": { "type": "structure", "members": { "MoveToColdStorageAt": { "shape": "timestamp", "documentation": "

A timestamp that specifies when to transition a recovery point to cold storage.

" }, "DeleteAt": { "shape": "timestamp", "documentation": "

A timestamp that specifies when to delete a recovery point.

" } }, "documentation": "

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 are able to be transitioned to cold storage are listed in the \"Lifecycle to cold storage\" section of the Feature availability by resource table. Backup ignores this expression for other resource types.

" }, "CancelLegalHoldInput": { "type": "structure", "required": [ "LegalHoldId", "CancelDescription" ], "members": { "LegalHoldId": { "shape": "string", "documentation": "

Legal hold ID required to remove the specified legal hold on a recovery point.

", "location": "uri", "locationName": "legalHoldId" }, "CancelDescription": { "shape": "string", "documentation": "

String describing the reason for removing the legal hold.

", "location": "querystring", "locationName": "cancelDescription" }, "RetainRecordInDays": { "shape": "Long", "documentation": "

The integer amount in days specifying amount of days after this API operation to remove legal hold.

", "location": "querystring", "locationName": "retainRecordInDays" } } }, "CancelLegalHoldOutput": { "type": "structure", "members": {} }, "ComplianceResourceIdList": { "type": "list", "member": { "shape": "string" }, "max": 100, "min": 1 }, "Condition": { "type": "structure", "required": [ "ConditionType", "ConditionKey", "ConditionValue" ], "members": { "ConditionType": { "shape": "ConditionType", "documentation": "

An operation applied to a key-value pair used to assign resources to your backup plan. Condition only supports StringEquals. For more flexible assignment options, including StringLike and the ability to exclude resources from your backup plan, use Conditions (with an \"s\" on the end) for your BackupSelection .

" }, "ConditionKey": { "shape": "ConditionKey", "documentation": "

The key in a key-value pair. For example, in the tag Department: Accounting, Department is the key.

" }, "ConditionValue": { "shape": "ConditionValue", "documentation": "

The value in a key-value pair. For example, in the tag Department: Accounting, Accounting is the value.

" } }, "documentation": "

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.

" }, "ConditionKey": { "type": "string" }, "ConditionParameter": { "type": "structure", "members": { "ConditionKey": { "shape": "ConditionKey", "documentation": "

The key in a key-value pair. For example, in the tag Department: Accounting, Department is the key.

" }, "ConditionValue": { "shape": "ConditionValue", "documentation": "

The value in a key-value pair. For example, in the tag Department: Accounting, Accounting is the value.

" } }, "documentation": "

Includes information about tags you define to assign tagged resources to a backup plan.

" }, "ConditionParameters": { "type": "list", "member": { "shape": "ConditionParameter" } }, "ConditionType": { "type": "string", "enum": [ "STRINGEQUALS" ] }, "ConditionValue": { "type": "string" }, "Conditions": { "type": "structure", "members": { "StringEquals": { "shape": "ConditionParameters", "documentation": "

Filters the values of your tagged resources for only those resources that you tagged with the same value. Also called \"exact matching.\"

" }, "StringNotEquals": { "shape": "ConditionParameters", "documentation": "

Filters the values of your tagged resources for only those resources that you tagged that do not have the same value. Also called \"negated matching.\"

" }, "StringLike": { "shape": "ConditionParameters", "documentation": "

Filters the values of your tagged resources for matching tag values with the use of a wildcard character (*) anywhere in the string. For example, \"prod*\" or \"*rod*\" matches the tag value \"production\".

" }, "StringNotLike": { "shape": "ConditionParameters", "documentation": "

Filters the values of your tagged resources for non-matching tag values with the use of a wildcard character (*) anywhere in the string.

" } }, "documentation": "

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

" }, "ControlInputParameter": { "type": "structure", "members": { "ParameterName": { "shape": "ParameterName", "documentation": "

The name of a parameter, for example, BackupPlanFrequency.

" }, "ParameterValue": { "shape": "ParameterValue", "documentation": "

The value of parameter, for example, hourly.

" } }, "documentation": "

A list of 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.

" }, "ControlInputParameters": { "type": "list", "member": { "shape": "ControlInputParameter" } }, "ControlName": { "type": "string" }, "ControlScope": { "type": "structure", "members": { "ComplianceResourceIds": { "shape": "ComplianceResourceIdList", "documentation": "

The ID of the only Amazon Web Services resource that you want your control scope to contain.

" }, "ComplianceResourceTypes": { "shape": "ResourceTypeList", "documentation": "

Describes whether the control scope includes one or more types of resources, such as EFS or RDS.

" }, "Tags": { "shape": "stringMap", "documentation": "

The tag key-value pair applied to those Amazon Web Services resources that you want to trigger an evaluation for a rule. A maximum of one key-value pair can be provided. The tag value is optional, but it cannot be an empty string. The structure to assign a tag is: [{\"Key\":\"string\",\"Value\":\"string\"}].

" } }, "documentation": "

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.

" }, "CopyAction": { "type": "structure", "required": [ "DestinationBackupVaultArn" ], "members": { "Lifecycle": { "shape": "Lifecycle" }, "DestinationBackupVaultArn": { "shape": "ARN", "documentation": "

An Amazon Resource Name (ARN) that uniquely identifies the destination backup vault for the copied backup. For example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.

" } }, "documentation": "

The details of the copy operation.

" }, "CopyActions": { "type": "list", "member": { "shape": "CopyAction" } }, "CopyJob": { "type": "structure", "members": { "AccountId": { "shape": "AccountId", "documentation": "

The account ID that owns the copy job.

" }, "CopyJobId": { "shape": "string", "documentation": "

Uniquely identifies a copy job.

" }, "SourceBackupVaultArn": { "shape": "ARN", "documentation": "

An Amazon Resource Name (ARN) that uniquely identifies a source copy vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.

" }, "SourceRecoveryPointArn": { "shape": "ARN", "documentation": "

An ARN that uniquely identifies a source recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

" }, "DestinationBackupVaultArn": { "shape": "ARN", "documentation": "

An Amazon Resource Name (ARN) that uniquely identifies a destination copy vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.

" }, "DestinationRecoveryPointArn": { "shape": "ARN", "documentation": "

An ARN that uniquely identifies a destination recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

" }, "ResourceArn": { "shape": "ARN", "documentation": "

The Amazon Web Services resource to be copied; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.

" }, "CreationDate": { "shape": "timestamp", "documentation": "

The date and time a copy job is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

" }, "CompletionDate": { "shape": "timestamp", "documentation": "

The date and time a copy job is completed, in Unix format and Coordinated Universal Time (UTC). The value of CompletionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

" }, "State": { "shape": "CopyJobState", "documentation": "

The current state of a copy job.

" }, "StatusMessage": { "shape": "string", "documentation": "

A detailed message explaining the status of the job to copy a resource.

" }, "BackupSizeInBytes": { "shape": "Long", "documentation": "

The size, in bytes, of a copy job.

" }, "IamRoleArn": { "shape": "IAMRoleArn", "documentation": "

Specifies the IAM role ARN used to copy the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access.

" }, "CreatedBy": { "shape": "RecoveryPointCreator" }, "ResourceType": { "shape": "ResourceType", "documentation": "

The type of Amazon Web Services resource to be copied; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.

" }, "ParentJobId": { "shape": "string", "documentation": "

This uniquely identifies a request to Backup to copy a resource. The return will be the parent (composite) job ID.

" }, "IsParent": { "shape": "boolean", "documentation": "

This is a boolean value indicating this is a parent (composite) copy job.

" }, "CompositeMemberIdentifier": { "shape": "string", "documentation": "

This is the identifier of a resource within a composite group, such as nested (child) recovery point belonging to a composite (parent) stack. The ID is transferred from the logical ID within a stack.

" }, "NumberOfChildJobs": { "shape": "Long", "documentation": "

This is the number of child (nested) copy jobs.

" }, "ChildJobsInState": { "shape": "CopyJobChildJobsInState", "documentation": "

This returns the statistics of the included child (nested) copy jobs.

" }, "ResourceName": { "shape": "string", "documentation": "

This is the non-unique name of the resource that belongs to the specified backup.

" }, "MessageCategory": { "shape": "string", "documentation": "

This parameter is the job count for the specified message category.

Example strings may include AccessDenied, SUCCESS, AGGREGATE_ALL, and InvalidParameters. See Monitoring for a list of MessageCategory strings.

The the value ANY returns count of all message categories.

AGGREGATE_ALL aggregates job counts for all message categories and returns the sum

" } }, "documentation": "

Contains detailed information about a copy job.

" }, "CopyJobChildJobsInState": { "type": "map", "key": { "shape": "CopyJobState" }, "value": { "shape": "Long" } }, "CopyJobState": { "type": "string", "enum": [ "CREATED", "RUNNING", "COMPLETED", "FAILED", "PARTIAL" ] }, "CopyJobStatus": { "type": "string", "enum": [ "CREATED", "RUNNING", "ABORTING", "ABORTED", "COMPLETING", "COMPLETED", "FAILING", "FAILED", "PARTIAL", "AGGREGATE_ALL", "ANY" ] }, "CopyJobSummary": { "type": "structure", "members": { "Region": { "shape": "Region", "documentation": "

This is the Amazon Web Services Regions within the job summary.

" }, "AccountId": { "shape": "AccountId", "documentation": "

The account ID that owns the jobs within the summary.

" }, "State": { "shape": "CopyJobStatus", "documentation": "

This value is job count for jobs with the specified state.

" }, "ResourceType": { "shape": "ResourceType", "documentation": "

This value is the job count for the specified resource type. The request GetSupportedResourceTypes returns strings for supported resource types

" }, "MessageCategory": { "shape": "MessageCategory", "documentation": "

This parameter is the job count for the specified message category.

Example strings include AccessDenied, Success, and InvalidParameters. See Monitoring for a list of MessageCategory strings.

The the value ANY returns count of all message categories.

AGGREGATE_ALL aggregates job counts for all message categories and returns the sum.

" }, "Count": { "shape": "integer", "documentation": "

The value as a number of jobs in a job summary.

" }, "StartTime": { "shape": "timestamp", "documentation": "

The value of time in number format of a job start time.

This value is the time in Unix format, Coordinated Universal Time (UTC), and accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

" }, "EndTime": { "shape": "timestamp", "documentation": "

The value of time in number format of a job end time.

This value is the time in Unix format, Coordinated Universal Time (UTC), and accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

" } }, "documentation": "

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.

" }, "CopyJobSummaryList": { "type": "list", "member": { "shape": "CopyJobSummary" } }, "CopyJobsList": { "type": "list", "member": { "shape": "CopyJob" } }, "CreateBackupPlanInput": { "type": "structure", "required": [ "BackupPlan" ], "members": { "BackupPlan": { "shape": "BackupPlanInput", "documentation": "

Specifies the body of a backup plan. Includes a BackupPlanName and one or more sets of Rules.

" }, "BackupPlanTags": { "shape": "Tags", "documentation": "

To help organize your resources, you can assign your own metadata to the resources that you create. Each tag is a key-value pair. The specified tags are assigned to all backups created with this plan.

" }, "CreatorRequestId": { "shape": "string", "documentation": "

Identifies the request and allows failed requests to be retried without the risk of running the operation twice. If the request includes a CreatorRequestId that matches an existing backup plan, that plan is returned. This parameter is optional.

If used, this parameter must contain 1 to 50 alphanumeric or '-_.' characters.

" } } }, "CreateBackupPlanOutput": { "type": "structure", "members": { "BackupPlanId": { "shape": "string", "documentation": "

Uniquely identifies a backup plan.

" }, "BackupPlanArn": { "shape": "ARN", "documentation": "

An Amazon Resource Name (ARN) that uniquely identifies a backup plan; for example, arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50.

" }, "CreationDate": { "shape": "timestamp", "documentation": "

The date and time that a backup plan is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

" }, "VersionId": { "shape": "string", "documentation": "

Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes long. They cannot be edited.

" }, "AdvancedBackupSettings": { "shape": "AdvancedBackupSettings", "documentation": "

A list of BackupOptions settings for a resource type. This option is only available for Windows Volume Shadow Copy Service (VSS) backup jobs.

" } } }, "CreateBackupSelectionInput": { "type": "structure", "required": [ "BackupPlanId", "BackupSelection" ], "members": { "BackupPlanId": { "shape": "string", "documentation": "

Uniquely identifies the backup plan to be associated with the selection of resources.

", "location": "uri", "locationName": "backupPlanId" }, "BackupSelection": { "shape": "BackupSelection", "documentation": "

Specifies the body of a request to assign a set of resources to a backup plan.

" }, "CreatorRequestId": { "shape": "string", "documentation": "

A unique string that identifies the request and allows failed requests to be retried without the risk of running the operation twice. This parameter is optional.

If used, this parameter must contain 1 to 50 alphanumeric or '-_.' characters.

" } } }, "CreateBackupSelectionOutput": { "type": "structure", "members": { "SelectionId": { "shape": "string", "documentation": "

Uniquely identifies the body of a request to assign a set of resources to a backup plan.

" }, "BackupPlanId": { "shape": "string", "documentation": "

Uniquely identifies a backup plan.

" }, "CreationDate": { "shape": "timestamp", "documentation": "

The date and time a backup selection is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

" } } }, "CreateBackupVaultInput": { "type": "structure", "required": [ "BackupVaultName" ], "members": { "BackupVaultName": { "shape": "BackupVaultName", "documentation": "

The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of letters, numbers, and hyphens.

", "location": "uri", "locationName": "backupVaultName" }, "BackupVaultTags": { "shape": "Tags", "documentation": "

Metadata that you can assign to help organize the resources that you create. Each tag is a key-value pair.

" }, "EncryptionKeyArn": { "shape": "ARN", "documentation": "

The server-side encryption key that is used to protect your backups; for example, arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab.

" }, "CreatorRequestId": { "shape": "string", "documentation": "

A unique string that identifies the request and allows failed requests to be retried without the risk of running the operation twice. This parameter is optional.

If used, this parameter must contain 1 to 50 alphanumeric or '-_.' characters.

" } } }, "CreateBackupVaultOutput": { "type": "structure", "members": { "BackupVaultName": { "shape": "BackupVaultName", "documentation": "

The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Region where they are created. They consist of lowercase letters, numbers, and hyphens.

" }, "BackupVaultArn": { "shape": "ARN", "documentation": "

An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.

" }, "CreationDate": { "shape": "timestamp", "documentation": "

The date and time a backup vault is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

" } } }, "CreateFrameworkInput": { "type": "structure", "required": [ "FrameworkName", "FrameworkControls" ], "members": { "FrameworkName": { "shape": "FrameworkName", "documentation": "

The unique name of the framework. The name must be between 1 and 256 characters, starting with a letter, and consisting of letters (a-z, A-Z), numbers (0-9), and underscores (_).

" }, "FrameworkDescription": { "shape": "FrameworkDescription", "documentation": "

An optional description of the framework with a maximum of 1,024 characters.

" }, "FrameworkControls": { "shape": "FrameworkControls", "documentation": "

A list of the controls that make up the framework. Each control in the list has a name, input parameters, and scope.

" }, "IdempotencyToken": { "shape": "string", "documentation": "

A customer-chosen string that you can use to distinguish between otherwise identical calls to CreateFrameworkInput. Retrying a successful request with the same idempotency token results in a success message with no action taken.

", "idempotencyToken": true }, "FrameworkTags": { "shape": "stringMap", "documentation": "

Metadata that you can assign to help organize the frameworks that you create. Each tag is a key-value pair.

" } } }, "CreateFrameworkOutput": { "type": "structure", "members": { "FrameworkName": { "shape": "FrameworkName", "documentation": "

The unique name of the framework. The name must be between 1 and 256 characters, starting with a letter, and consisting of letters (a-z, A-Z), numbers (0-9), and underscores (_).

" }, "FrameworkArn": { "shape": "ARN", "documentation": "

An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.

" } } }, "CreateLegalHoldInput": { "type": "structure", "required": [ "Title", "Description" ], "members": { "Title": { "shape": "string", "documentation": "

This is the string title of the legal hold.

" }, "Description": { "shape": "string", "documentation": "

This is the string description of the legal hold.

" }, "IdempotencyToken": { "shape": "string", "documentation": "

This is a user-chosen string used to distinguish between otherwise identical calls. Retrying a successful request with the same idempotency token results in a success message with no action taken.

" }, "RecoveryPointSelection": { "shape": "RecoveryPointSelection", "documentation": "

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

" }, "Tags": { "shape": "Tags", "documentation": "

Optional tags to include. A tag is a key-value pair you can use to manage, filter, and search for your resources. Allowed characters include UTF-8 letters, numbers, spaces, and the following characters: + - = . _ : /.

" } } }, "CreateLegalHoldOutput": { "type": "structure", "members": { "Title": { "shape": "string", "documentation": "

This is the string title of the legal hold returned after creating the legal hold.

" }, "Status": { "shape": "LegalHoldStatus", "documentation": "

This displays the status of the legal hold returned after creating the legal hold. Statuses can be ACTIVE, PENDING, CANCELED, CANCELING, or FAILED.

" }, "Description": { "shape": "string", "documentation": "

This is the returned string description of the legal hold.

" }, "LegalHoldId": { "shape": "string", "documentation": "

Legal hold ID returned for the specified legal hold on a recovery point.

" }, "LegalHoldArn": { "shape": "ARN", "documentation": "

This is the ARN (Amazon Resource Number) of the created legal hold.

" }, "CreationDate": { "shape": "timestamp", "documentation": "

Time in number format when legal hold was created.

" }, "RecoveryPointSelection": { "shape": "RecoveryPointSelection", "documentation": "

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

" } } }, "CreateLogicallyAirGappedBackupVaultInput": { "type": "structure", "required": [ "BackupVaultName", "MinRetentionDays", "MaxRetentionDays" ], "members": { "BackupVaultName": { "shape": "BackupVaultName", "documentation": "

This is the name of the vault that is being created.

", "location": "uri", "locationName": "backupVaultName" }, "BackupVaultTags": { "shape": "Tags", "documentation": "

These are the tags that will be included in the newly-created vault.

" }, "CreatorRequestId": { "shape": "string", "documentation": "

This is the ID of the creation request.

This parameter is optional. If used, this parameter must contain 1 to 50 alphanumeric or '-_.' characters.

" }, "MinRetentionDays": { "shape": "Long", "documentation": "

This setting specifies the minimum retention period that the vault retains its recovery points. If this parameter is not specified, no minimum retention period is enforced.

If specified, any backup or copy job to the vault must have a lifecycle policy with a retention period equal to or longer than the minimum retention period. If a job retention period is shorter than that minimum retention period, then the vault fails the backup or copy job, and you should either modify your lifecycle settings or use a different vault.

" }, "MaxRetentionDays": { "shape": "Long", "documentation": "

This is the setting that specifies the maximum retention period that the vault retains its recovery points. If this parameter is not specified, Backup does not enforce a maximum retention period on the recovery points in the vault (allowing indefinite storage).

If specified, any backup or copy job to the vault must have a lifecycle policy with a retention period equal to or shorter than the maximum retention period. If the job retention period is longer than that maximum retention period, then the vault fails the backup or copy job, and you should either modify your lifecycle settings or use a different vault.

" } } }, "CreateLogicallyAirGappedBackupVaultOutput": { "type": "structure", "members": { "BackupVaultName": { "shape": "BackupVaultName", "documentation": "

The name of a logical container where backups are stored. Logically air-gapped backup vaults are identified by names that are unique to the account used to create them and the Region where they are created. They consist of lowercase letters, numbers, and hyphens.

" }, "BackupVaultArn": { "shape": "ARN", "documentation": "

This is the ARN (Amazon Resource Name) of the vault being created.

" }, "CreationDate": { "shape": "timestamp", "documentation": "

The date and time when the vault was created.

This value is in Unix format, Coordinated Universal Time (UTC), and accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

" }, "VaultState": { "shape": "VaultState", "documentation": "

This is the current state of the vault.

" } } }, "CreateReportPlanInput": { "type": "structure", "required": [ "ReportPlanName", "ReportDeliveryChannel", "ReportSetting" ], "members": { "ReportPlanName": { "shape": "ReportPlanName", "documentation": "

The unique name of the report plan. The name must be between 1 and 256 characters, starting with a letter, and consisting of letters (a-z, A-Z), numbers (0-9), and underscores (_).

" }, "ReportPlanDescription": { "shape": "ReportPlanDescription", "documentation": "

An optional description of the report plan with a maximum of 1,024 characters.

" }, "ReportDeliveryChannel": { "shape": "ReportDeliveryChannel", "documentation": "

A structure that contains information about where and how to deliver your reports, specifically your Amazon S3 bucket name, S3 key prefix, and the formats of your reports.

" }, "ReportSetting": { "shape": "ReportSetting", "documentation": "

Identifies the report template for the report. Reports are built using a report template. The report templates are:

RESOURCE_COMPLIANCE_REPORT | CONTROL_COMPLIANCE_REPORT | BACKUP_JOB_REPORT | COPY_JOB_REPORT | RESTORE_JOB_REPORT

If the report template is RESOURCE_COMPLIANCE_REPORT or CONTROL_COMPLIANCE_REPORT, this API resource also describes the report coverage by Amazon Web Services Regions and frameworks.

" }, "ReportPlanTags": { "shape": "stringMap", "documentation": "

Metadata that you can assign to help organize the report plans that you create. Each tag is a key-value pair.

" }, "IdempotencyToken": { "shape": "string", "documentation": "

A customer-chosen string that you can use to distinguish between otherwise identical calls to CreateReportPlanInput. Retrying a successful request with the same idempotency token results in a success message with no action taken.

", "idempotencyToken": true } } }, "CreateReportPlanOutput": { "type": "structure", "members": { "ReportPlanName": { "shape": "ReportPlanName", "documentation": "

The unique name of the report plan.

" }, "ReportPlanArn": { "shape": "ARN", "documentation": "

An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.

" }, "CreationTime": { "shape": "timestamp", "documentation": "

The date and time a backup vault is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

" } } }, "CreateRestoreTestingPlanInput": { "type": "structure", "required": [ "RestoreTestingPlan" ], "members": { "CreatorRequestId": { "shape": "String", "documentation": "

This is a unique string that identifies the request and allows failed requests to be retriedwithout the risk of running the operation twice. This parameter is optional. If used, this parameter must contain 1 to 50 alphanumeric or '-_.' characters.

" }, "RestoreTestingPlan": { "shape": "RestoreTestingPlanForCreate", "documentation": "

A restore testing plan must contain a unique RestoreTestingPlanName string you create and must contain a ScheduleExpression cron. You may optionally include a StartWindowHours integer and a CreatorRequestId string.

The RestoreTestingPlanName is a unique string that is the name of the restore testing plan. This cannot be changed after creation, and it must consist of only alphanumeric characters and underscores.

" }, "Tags": { "shape": "SensitiveStringMap", "documentation": "

Optional tags to include. A tag is a key-value pair you can use to manage, filter, and search for your resources. Allowed characters include UTF-8 letters,numbers, spaces, and the following characters: + - = . _ : /.

" } } }, "CreateRestoreTestingPlanOutput": { "type": "structure", "required": [ "CreationTime", "RestoreTestingPlanArn", "RestoreTestingPlanName" ], "members": { "CreationTime": { "shape": "Timestamp", "documentation": "

The date and time a restore testing plan was created, in Unix format and Coordinated Universal Time (UTC). The value of CreationTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087AM.

" }, "RestoreTestingPlanArn": { "shape": "String", "documentation": "

An Amazon Resource Name (ARN) that uniquely identifies the created restore testing plan.

" }, "RestoreTestingPlanName": { "shape": "String", "documentation": "

This unique string is the name of the restore testing plan.

The name cannot be changed after creation. The name consists of only alphanumeric characters and underscores. Maximum length is 50.

" } } }, "CreateRestoreTestingSelectionInput": { "type": "structure", "required": [ "RestoreTestingPlanName", "RestoreTestingSelection" ], "members": { "CreatorRequestId": { "shape": "String", "documentation": "

This is an optional unique string that identifies the request and allows failed requests to be retried without the risk of running the operation twice. If used, this parameter must contain 1 to 50 alphanumeric or '-_.' characters.

" }, "RestoreTestingPlanName": { "shape": "String", "documentation": "

Input the restore testing plan name that was returned from the related CreateRestoreTestingPlan request.

", "location": "uri", "locationName": "RestoreTestingPlanName" }, "RestoreTestingSelection": { "shape": "RestoreTestingSelectionForCreate", "documentation": "

This consists of RestoreTestingSelectionName, ProtectedResourceType, and one of the following:

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.

" } } }, "CreateRestoreTestingSelectionOutput": { "type": "structure", "required": [ "CreationTime", "RestoreTestingPlanArn", "RestoreTestingPlanName", "RestoreTestingSelectionName" ], "members": { "CreationTime": { "shape": "Timestamp", "documentation": "

This is the time the resource testing selection was created successfully.

" }, "RestoreTestingPlanArn": { "shape": "String", "documentation": "

This is the ARN of the restore testing plan with which the restore testing selection is associated.

" }, "RestoreTestingPlanName": { "shape": "String", "documentation": "

Unique string that is the name of the restore testing plan.

The name cannot be changed after creation. The name consists of only alphanumeric characters and underscores. Maximum length is 50.

" }, "RestoreTestingSelectionName": { "shape": "String", "documentation": "

This is the unique name of the restore testing selection that belongs to the related restore testing plan.

" } } }, "CronExpression": { "type": "string" }, "DateRange": { "type": "structure", "required": [ "FromDate", "ToDate" ], "members": { "FromDate": { "shape": "timestamp", "documentation": "

This value is the beginning date, inclusive.

The date and time are in Unix format and Coordinated Universal Time (UTC), and it is accurate to milliseconds (milliseconds are optional).

" }, "ToDate": { "shape": "timestamp", "documentation": "

This value is the end date, inclusive.

The date and time are in Unix format and Coordinated Universal Time (UTC), and it is accurate to milliseconds (milliseconds are optional).

" } }, "documentation": "

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.

" }, "DeleteBackupPlanInput": { "type": "structure", "required": [ "BackupPlanId" ], "members": { "BackupPlanId": { "shape": "string", "documentation": "

Uniquely identifies a backup plan.

", "location": "uri", "locationName": "backupPlanId" } } }, "DeleteBackupPlanOutput": { "type": "structure", "members": { "BackupPlanId": { "shape": "string", "documentation": "

Uniquely identifies a backup plan.

" }, "BackupPlanArn": { "shape": "ARN", "documentation": "

An Amazon Resource Name (ARN) that uniquely identifies a backup plan; for example, arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50.

" }, "DeletionDate": { "shape": "timestamp", "documentation": "

The date and time a backup plan is deleted, in Unix format and Coordinated Universal Time (UTC). The value of DeletionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

" }, "VersionId": { "shape": "string", "documentation": "

Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes long. Version IDs cannot be edited.

" } } }, "DeleteBackupSelectionInput": { "type": "structure", "required": [ "BackupPlanId", "SelectionId" ], "members": { "BackupPlanId": { "shape": "string", "documentation": "

Uniquely identifies a backup plan.

", "location": "uri", "locationName": "backupPlanId" }, "SelectionId": { "shape": "string", "documentation": "

Uniquely identifies the body of a request to assign a set of resources to a backup plan.

", "location": "uri", "locationName": "selectionId" } } }, "DeleteBackupVaultAccessPolicyInput": { "type": "structure", "required": [ "BackupVaultName" ], "members": { "BackupVaultName": { "shape": "BackupVaultName", "documentation": "

The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.

", "location": "uri", "locationName": "backupVaultName" } } }, "DeleteBackupVaultInput": { "type": "structure", "required": [ "BackupVaultName" ], "members": { "BackupVaultName": { "shape": "string", "documentation": "

The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.

", "location": "uri", "locationName": "backupVaultName" } } }, "DeleteBackupVaultLockConfigurationInput": { "type": "structure", "required": [ "BackupVaultName" ], "members": { "BackupVaultName": { "shape": "BackupVaultName", "documentation": "

The name of the backup vault from which to delete Backup Vault Lock.

", "location": "uri", "locationName": "backupVaultName" } } }, "DeleteBackupVaultNotificationsInput": { "type": "structure", "required": [ "BackupVaultName" ], "members": { "BackupVaultName": { "shape": "BackupVaultName", "documentation": "

The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Region where they are created. They consist of lowercase letters, numbers, and hyphens.

", "location": "uri", "locationName": "backupVaultName" } } }, "DeleteFrameworkInput": { "type": "structure", "required": [ "FrameworkName" ], "members": { "FrameworkName": { "shape": "FrameworkName", "documentation": "

The unique name of a framework.

", "location": "uri", "locationName": "frameworkName" } } }, "DeleteRecoveryPointInput": { "type": "structure", "required": [ "BackupVaultName", "RecoveryPointArn" ], "members": { "BackupVaultName": { "shape": "BackupVaultName", "documentation": "

The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.

", "location": "uri", "locationName": "backupVaultName" }, "RecoveryPointArn": { "shape": "ARN", "documentation": "

An Amazon Resource Name (ARN) that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

", "location": "uri", "locationName": "recoveryPointArn" } } }, "DeleteReportPlanInput": { "type": "structure", "required": [ "ReportPlanName" ], "members": { "ReportPlanName": { "shape": "ReportPlanName", "documentation": "

The unique name of a report plan.

", "location": "uri", "locationName": "reportPlanName" } } }, "DeleteRestoreTestingPlanInput": { "type": "structure", "required": [ "RestoreTestingPlanName" ], "members": { "RestoreTestingPlanName": { "shape": "String", "documentation": "

Required unique name of the restore testing plan you wish to delete.

", "location": "uri", "locationName": "RestoreTestingPlanName" } } }, "DeleteRestoreTestingSelectionInput": { "type": "structure", "required": [ "RestoreTestingPlanName", "RestoreTestingSelectionName" ], "members": { "RestoreTestingPlanName": { "shape": "String", "documentation": "

Required unique name of the restore testing plan that contains the restore testing selection you wish to delete.

", "location": "uri", "locationName": "RestoreTestingPlanName" }, "RestoreTestingSelectionName": { "shape": "String", "documentation": "

Required unique name of the restore testing selection you wish to delete.

", "location": "uri", "locationName": "RestoreTestingSelectionName" } } }, "DescribeBackupJobInput": { "type": "structure", "required": [ "BackupJobId" ], "members": { "BackupJobId": { "shape": "string", "documentation": "

Uniquely identifies a request to Backup to back up a resource.

", "location": "uri", "locationName": "backupJobId" } } }, "DescribeBackupJobOutput": { "type": "structure", "members": { "AccountId": { "shape": "AccountId", "documentation": "

Returns the account ID that owns the backup job.

" }, "BackupJobId": { "shape": "string", "documentation": "

Uniquely identifies a request to Backup to back up a resource.

" }, "BackupVaultName": { "shape": "BackupVaultName", "documentation": "

The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.

" }, "BackupVaultArn": { "shape": "ARN", "documentation": "

An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.

" }, "RecoveryPointArn": { "shape": "ARN", "documentation": "

An ARN that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

" }, "ResourceArn": { "shape": "ARN", "documentation": "

An ARN that uniquely identifies a saved resource. The format of the ARN depends on the resource type.

" }, "CreationDate": { "shape": "timestamp", "documentation": "

The date and time that a backup job is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

" }, "CompletionDate": { "shape": "timestamp", "documentation": "

The date and time that a job to create a backup job is completed, in Unix format and Coordinated Universal Time (UTC). The value of CompletionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

" }, "State": { "shape": "BackupJobState", "documentation": "

The current state of a backup job.

" }, "StatusMessage": { "shape": "string", "documentation": "

A detailed message explaining the status of the job to back up a resource.

" }, "PercentDone": { "shape": "string", "documentation": "

Contains an estimated percentage that is complete of a job at the time the job status was queried.

" }, "BackupSizeInBytes": { "shape": "Long", "documentation": "

The size, in bytes, of a backup.

" }, "IamRoleArn": { "shape": "IAMRoleArn", "documentation": "

Specifies the IAM role ARN used to create the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access.

" }, "CreatedBy": { "shape": "RecoveryPointCreator", "documentation": "

Contains identifying information about the creation of a backup job, including the BackupPlanArn, BackupPlanId, BackupPlanVersion, and BackupRuleId of the backup plan that is used to create it.

" }, "ResourceType": { "shape": "ResourceType", "documentation": "

The type of Amazon Web Services resource to be backed up; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.

" }, "BytesTransferred": { "shape": "Long", "documentation": "

The size in bytes transferred to a backup vault at the time that the job status was queried.

" }, "ExpectedCompletionDate": { "shape": "timestamp", "documentation": "

The date and time that a job to back up resources is expected to be completed, in Unix format and Coordinated Universal Time (UTC). The value of ExpectedCompletionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

" }, "StartBy": { "shape": "timestamp", "documentation": "

Specifies the time in Unix format and Coordinated Universal Time (UTC) when a backup job must be started before it is canceled. The value is calculated by adding the start window to the scheduled time. So if the scheduled time were 6:00 PM and the start window is 2 hours, the StartBy time would be 8:00 PM on the date specified. The value of StartBy is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

" }, "BackupOptions": { "shape": "BackupOptions", "documentation": "

Represents the options specified as part of backup plan or on-demand backup job.

" }, "BackupType": { "shape": "string", "documentation": "

Represents the actual backup type selected for a backup job. For example, if a successful Windows Volume Shadow Copy Service (VSS) backup was taken, BackupType returns \"WindowsVSS\". If BackupType is empty, then the backup type was a regular backup.

" }, "ParentJobId": { "shape": "string", "documentation": "

This returns the parent (composite) resource backup job ID.

" }, "IsParent": { "shape": "boolean", "documentation": "

This returns the boolean value that a backup job is a parent (composite) job.

" }, "NumberOfChildJobs": { "shape": "Long", "documentation": "

This returns the number of child (nested) backup jobs.

" }, "ChildJobsInState": { "shape": "BackupJobChildJobsInState", "documentation": "

This returns the statistics of the included child (nested) backup jobs.

" }, "ResourceName": { "shape": "string", "documentation": "

This is the non-unique name of the resource that belongs to the specified backup.

" }, "InitiationDate": { "shape": "timestamp", "documentation": "

This is the date a backup job was initiated.

" }, "MessageCategory": { "shape": "string", "documentation": "

This is the job count for the specified message category.

Example strings may include AccessDenied, SUCCESS, AGGREGATE_ALL, and INVALIDPARAMETERS. View Monitoring for a list of accepted MessageCategory strings.

" } } }, "DescribeBackupVaultInput": { "type": "structure", "required": [ "BackupVaultName" ], "members": { "BackupVaultName": { "shape": "string", "documentation": "

The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.

", "location": "uri", "locationName": "backupVaultName" }, "BackupVaultAccountId": { "shape": "string", "documentation": "

This is the account ID of the specified backup vault.

", "location": "querystring", "locationName": "backupVaultAccountId" } } }, "DescribeBackupVaultOutput": { "type": "structure", "members": { "BackupVaultName": { "shape": "string", "documentation": "

The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Region where they are created. They consist of lowercase letters, numbers, and hyphens.

" }, "BackupVaultArn": { "shape": "ARN", "documentation": "

An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.

" }, "VaultType": { "shape": "VaultType", "documentation": "

This is the type of vault described.

" }, "EncryptionKeyArn": { "shape": "ARN", "documentation": "

The server-side encryption key that is used to protect your backups; for example, arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab.

" }, "CreationDate": { "shape": "timestamp", "documentation": "

The date and time that a backup vault is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

" }, "CreatorRequestId": { "shape": "string", "documentation": "

A unique string that identifies the request and allows failed requests to be retried without the risk of running the operation twice. This parameter is optional. If used, this parameter must contain 1 to 50 alphanumeric or '-_.' characters.

" }, "NumberOfRecoveryPoints": { "shape": "long", "documentation": "

The number of recovery points that are stored in a backup vault.

" }, "Locked": { "shape": "Boolean", "documentation": "

A Boolean that indicates whether Backup Vault Lock is currently protecting the backup vault. True means that Vault Lock causes delete or update operations on the recovery points stored in the vault to fail.

" }, "MinRetentionDays": { "shape": "Long", "documentation": "

The Backup Vault Lock setting that specifies the minimum retention period that the vault retains its recovery points. If this parameter is not specified, Vault Lock does not enforce a minimum retention period.

If specified, any backup or copy job to the vault must have a lifecycle policy with a retention period equal to or longer than the minimum retention period. If the job's retention period is shorter than that minimum retention period, then the vault fails the backup or copy job, and you should either modify your lifecycle settings or use a different vault. Recovery points already stored in the vault prior to Vault Lock are not affected.

" }, "MaxRetentionDays": { "shape": "Long", "documentation": "

The Backup Vault Lock setting that specifies the maximum retention period that the vault retains its recovery points. If this parameter is not specified, Vault Lock does not enforce a maximum retention period on the recovery points in the vault (allowing indefinite storage).

If specified, any backup or copy job to the vault must have a lifecycle policy with a retention period equal to or shorter than the maximum retention period. If the job's retention period is longer than that maximum retention period, then the vault fails the backup or copy job, and you should either modify your lifecycle settings or use a different vault. Recovery points already stored in the vault prior to Vault Lock are not affected.

" }, "LockDate": { "shape": "timestamp", "documentation": "

The date and time when Backup Vault Lock configuration cannot be changed or deleted.

If you applied Vault Lock to your vault without specifying a lock date, you can change any of your Vault Lock settings, or delete Vault Lock from the vault entirely, at any time.

This value is in Unix format, Coordinated Universal Time (UTC), and accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

" } } }, "DescribeCopyJobInput": { "type": "structure", "required": [ "CopyJobId" ], "members": { "CopyJobId": { "shape": "string", "documentation": "

Uniquely identifies a copy job.

", "location": "uri", "locationName": "copyJobId" } } }, "DescribeCopyJobOutput": { "type": "structure", "members": { "CopyJob": { "shape": "CopyJob", "documentation": "

Contains detailed information about a copy job.

" } } }, "DescribeFrameworkInput": { "type": "structure", "required": [ "FrameworkName" ], "members": { "FrameworkName": { "shape": "FrameworkName", "documentation": "

The unique name of a framework.

", "location": "uri", "locationName": "frameworkName" } } }, "DescribeFrameworkOutput": { "type": "structure", "members": { "FrameworkName": { "shape": "FrameworkName", "documentation": "

The unique name of a framework.

" }, "FrameworkArn": { "shape": "ARN", "documentation": "

An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.

" }, "FrameworkDescription": { "shape": "FrameworkDescription", "documentation": "

An optional description of the framework.

" }, "FrameworkControls": { "shape": "FrameworkControls", "documentation": "

A list of the controls that make up the framework. Each control in the list has a name, input parameters, and scope.

" }, "CreationTime": { "shape": "timestamp", "documentation": "

The date and time that a framework is created, in ISO 8601 representation. The value of CreationTime is accurate to milliseconds. For example, 2020-07-10T15:00:00.000-08:00 represents the 10th of July 2020 at 3:00 PM 8 hours behind UTC.

" }, "DeploymentStatus": { "shape": "string", "documentation": "

The deployment status of a framework. The statuses are:

CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | COMPLETED | FAILED

" }, "FrameworkStatus": { "shape": "string", "documentation": "

A framework consists of one or more controls. Each control governs a resource, such as backup plans, backup selections, backup vaults, or recovery points. You can also turn Config recording on or off for each resource. The statuses are:

" }, "IdempotencyToken": { "shape": "string", "documentation": "

A customer-chosen string that you can use to distinguish between otherwise identical calls to DescribeFrameworkOutput. Retrying a successful request with the same idempotency token results in a success message with no action taken.

" } } }, "DescribeGlobalSettingsInput": { "type": "structure", "members": {} }, "DescribeGlobalSettingsOutput": { "type": "structure", "members": { "GlobalSettings": { "shape": "GlobalSettings", "documentation": "

The status of the flag isCrossAccountBackupEnabled.

" }, "LastUpdateTime": { "shape": "timestamp", "documentation": "

The date and time that the flag isCrossAccountBackupEnabled was last updated. This update is in Unix format and Coordinated Universal Time (UTC). The value of LastUpdateTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

" } } }, "DescribeProtectedResourceInput": { "type": "structure", "required": [ "ResourceArn" ], "members": { "ResourceArn": { "shape": "ARN", "documentation": "

An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.

", "location": "uri", "locationName": "resourceArn" } } }, "DescribeProtectedResourceOutput": { "type": "structure", "members": { "ResourceArn": { "shape": "ARN", "documentation": "

An ARN that uniquely identifies a resource. The format of the ARN depends on the resource type.

" }, "ResourceType": { "shape": "ResourceType", "documentation": "

The type of Amazon Web Services resource saved as a recovery point; for example, an Amazon EBS volume or an Amazon RDS database.

" }, "LastBackupTime": { "shape": "timestamp", "documentation": "

The date and time that a resource was last backed up, in Unix format and Coordinated Universal Time (UTC). The value of LastBackupTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

" }, "ResourceName": { "shape": "string", "documentation": "

This is the non-unique name of the resource that belongs to the specified backup.

" }, "LastBackupVaultArn": { "shape": "ARN", "documentation": "

This is the ARN (Amazon Resource Name) of the backup vault that contains the most recent backup recovery point.

" }, "LastRecoveryPointArn": { "shape": "ARN", "documentation": "

This is the ARN (Amazon Resource Name) of the most recent recovery point.

" }, "LatestRestoreExecutionTimeMinutes": { "shape": "Long", "documentation": "

This is the time in minutes the most recent restore job took to complete.

" }, "LatestRestoreJobCreationDate": { "shape": "timestamp", "documentation": "

This is the creation date of the most recent restore job.

" }, "LatestRestoreRecoveryPointCreationDate": { "shape": "timestamp", "documentation": "

This is the date the most recent recovery point was created.

" } } }, "DescribeRecoveryPointInput": { "type": "structure", "required": [ "BackupVaultName", "RecoveryPointArn" ], "members": { "BackupVaultName": { "shape": "BackupVaultName", "documentation": "

The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.

", "location": "uri", "locationName": "backupVaultName" }, "RecoveryPointArn": { "shape": "ARN", "documentation": "

An Amazon Resource Name (ARN) that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

", "location": "uri", "locationName": "recoveryPointArn" }, "BackupVaultAccountId": { "shape": "AccountId", "documentation": "

This is the account ID of the specified backup vault.

", "location": "querystring", "locationName": "backupVaultAccountId" } } }, "DescribeRecoveryPointOutput": { "type": "structure", "members": { "RecoveryPointArn": { "shape": "ARN", "documentation": "

An ARN that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

" }, "BackupVaultName": { "shape": "BackupVaultName", "documentation": "

The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Region where they are created. They consist of lowercase letters, numbers, and hyphens.

" }, "BackupVaultArn": { "shape": "ARN", "documentation": "

An ARN that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.

" }, "SourceBackupVaultArn": { "shape": "ARN", "documentation": "

An Amazon Resource Name (ARN) that uniquely identifies the source vault where the resource was originally backed up in; for example, arn:aws:backup:us-east-1:123456789012:vault:BackupVault. If the recovery is restored to the same Amazon Web Services account or Region, this value will be null.

" }, "ResourceArn": { "shape": "ARN", "documentation": "

An ARN that uniquely identifies a saved resource. The format of the ARN depends on the resource type.

" }, "ResourceType": { "shape": "ResourceType", "documentation": "

The type of Amazon Web Services resource to save as a recovery point; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.

" }, "CreatedBy": { "shape": "RecoveryPointCreator", "documentation": "

Contains identifying information about the creation of a recovery point, including the BackupPlanArn, BackupPlanId, BackupPlanVersion, and BackupRuleId of the backup plan used to create it.

" }, "IamRoleArn": { "shape": "IAMRoleArn", "documentation": "

Specifies the IAM role ARN used to create the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access.

" }, "Status": { "shape": "RecoveryPointStatus", "documentation": "

A status code specifying the state of the recovery point.

PARTIAL status indicates Backup could not create the recovery point before the backup window closed. To increase your backup plan window using the API, see UpdateBackupPlan. You can also increase your backup plan window using the Console by choosing and editing your backup plan.

EXPIRED status indicates that the recovery point has exceeded its retention period, but Backup lacks permission or is otherwise unable to delete it. To manually delete these recovery points, see Step 3: Delete the recovery points in the Clean up resources section of Getting started.

STOPPED status occurs on a continuous backup where a user has taken some action that causes the continuous backup to be disabled. This can be caused by the removal of permissions, turning off versioning, turning off events being sent to EventBridge, or disabling the EventBridge rules that are put in place by Backup.

To resolve STOPPED status, ensure that all requested permissions are in place and that versioning is enabled on the S3 bucket. Once these conditions are met, the next instance of a backup rule running will result in a new continuous recovery point being created. The recovery points with STOPPED status do not need to be deleted.

For SAP HANA on Amazon EC2 STOPPED status occurs due to user action, application misconfiguration, or backup failure. To ensure that future continuous backups succeed, refer to the recovery point status and check SAP HANA for details.

" }, "StatusMessage": { "shape": "string", "documentation": "

A status message explaining the status of the recovery point.

" }, "CreationDate": { "shape": "timestamp", "documentation": "

The date and time that a recovery point is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

" }, "CompletionDate": { "shape": "timestamp", "documentation": "

The date and time that a job to create a recovery point is completed, in Unix format and Coordinated Universal Time (UTC). The value of CompletionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

" }, "BackupSizeInBytes": { "shape": "Long", "documentation": "

The size, in bytes, of a backup.

" }, "CalculatedLifecycle": { "shape": "CalculatedLifecycle", "documentation": "

A CalculatedLifecycle object containing DeleteAt and MoveToColdStorageAt timestamps.

" }, "Lifecycle": { "shape": "Lifecycle", "documentation": "

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 that are 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 are able to be transitioned to cold storage are listed in the \"Lifecycle to cold storage\" section of the Feature availability by resource table. Backup ignores this expression for other resource types.

" }, "EncryptionKeyArn": { "shape": "ARN", "documentation": "

The server-side encryption key used to protect your backups; for example, arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab.

" }, "IsEncrypted": { "shape": "boolean", "documentation": "

A Boolean value that is returned as TRUE if the specified recovery point is encrypted, or FALSE if the recovery point is not encrypted.

" }, "StorageClass": { "shape": "StorageClass", "documentation": "

Specifies the storage class of the recovery point. Valid values are WARM or COLD.

" }, "LastRestoreTime": { "shape": "timestamp", "documentation": "

The date and time that a recovery point was last restored, in Unix format and Coordinated Universal Time (UTC). The value of LastRestoreTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

" }, "ParentRecoveryPointArn": { "shape": "ARN", "documentation": "

This is an ARN that uniquely identifies a parent (composite) recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

" }, "CompositeMemberIdentifier": { "shape": "string", "documentation": "

This is the identifier of a resource within a composite group, such as nested (child) recovery point belonging to a composite (parent) stack. The ID is transferred from the logical ID within a stack.

" }, "IsParent": { "shape": "boolean", "documentation": "

This returns the boolean value that a recovery point is a parent (composite) job.

" }, "ResourceName": { "shape": "string", "documentation": "

This is the non-unique name of the resource that belongs to the specified backup.

" }, "VaultType": { "shape": "VaultType", "documentation": "

This is the type of vault in which the described recovery point is stored.

" } } }, "DescribeRegionSettingsInput": { "type": "structure", "members": {} }, "DescribeRegionSettingsOutput": { "type": "structure", "members": { "ResourceTypeOptInPreference": { "shape": "ResourceTypeOptInPreference", "documentation": "

Returns a list of all services along with the opt-in preferences in the Region.

" }, "ResourceTypeManagementPreference": { "shape": "ResourceTypeManagementPreference", "documentation": "

Returns whether Backup fully manages the backups for a resource type.

For the benefits of full Backup management, see Full Backup management.

For a list of resource types and whether each supports full Backup management, see the Feature availability by resource table.

If \"DynamoDB\":false, you can enable full Backup management for DynamoDB backup by enabling Backup's advanced DynamoDB backup features.

" } } }, "DescribeReportJobInput": { "type": "structure", "required": [ "ReportJobId" ], "members": { "ReportJobId": { "shape": "ReportJobId", "documentation": "

The identifier of the report job. A unique, randomly generated, Unicode, UTF-8 encoded string that is at most 1,024 bytes long. The report job ID cannot be edited.

", "location": "uri", "locationName": "reportJobId" } } }, "DescribeReportJobOutput": { "type": "structure", "members": { "ReportJob": { "shape": "ReportJob", "documentation": "

A list of information about a report job, including its completion and creation times, report destination, unique report job ID, Amazon Resource Name (ARN), report template, status, and status message.

" } } }, "DescribeReportPlanInput": { "type": "structure", "required": [ "ReportPlanName" ], "members": { "ReportPlanName": { "shape": "ReportPlanName", "documentation": "

The unique name of a report plan.

", "location": "uri", "locationName": "reportPlanName" } } }, "DescribeReportPlanOutput": { "type": "structure", "members": { "ReportPlan": { "shape": "ReportPlan", "documentation": "

Returns details about the report plan that is specified by its name. These details include the report plan's Amazon Resource Name (ARN), description, settings, delivery channel, deployment status, creation time, and last attempted and successful run times.

" } } }, "DescribeRestoreJobInput": { "type": "structure", "required": [ "RestoreJobId" ], "members": { "RestoreJobId": { "shape": "RestoreJobId", "documentation": "

Uniquely identifies the job that restores a recovery point.

", "location": "uri", "locationName": "restoreJobId" } } }, "DescribeRestoreJobOutput": { "type": "structure", "members": { "AccountId": { "shape": "AccountId", "documentation": "

Returns the account ID that owns the restore job.

" }, "RestoreJobId": { "shape": "string", "documentation": "

Uniquely identifies the job that restores a recovery point.

" }, "RecoveryPointArn": { "shape": "ARN", "documentation": "

An ARN that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

" }, "CreationDate": { "shape": "timestamp", "documentation": "

The date and time that a restore job is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

" }, "CompletionDate": { "shape": "timestamp", "documentation": "

The date and time that a job to restore a recovery point is completed, in Unix format and Coordinated Universal Time (UTC). The value of CompletionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

" }, "Status": { "shape": "RestoreJobStatus", "documentation": "

Status code specifying the state of the job that is initiated by Backup to restore a recovery point.

" }, "StatusMessage": { "shape": "string", "documentation": "

A message showing the status of a job to restore a recovery point.

" }, "PercentDone": { "shape": "string", "documentation": "

Contains an estimated percentage that is complete of a job at the time the job status was queried.

" }, "BackupSizeInBytes": { "shape": "Long", "documentation": "

The size, in bytes, of the restored resource.

" }, "IamRoleArn": { "shape": "IAMRoleArn", "documentation": "

Specifies the IAM role ARN used to create the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access.

" }, "ExpectedCompletionTimeMinutes": { "shape": "Long", "documentation": "

The amount of time in minutes that a job restoring a recovery point is expected to take.

" }, "CreatedResourceArn": { "shape": "ARN", "documentation": "

An Amazon Resource Name (ARN) that uniquely identifies a resource whose recovery point is being restored. The format of the ARN depends on the resource type of the backed-up resource.

" }, "ResourceType": { "shape": "ResourceType", "documentation": "

Returns metadata associated with a restore job listed by resource type.

" }, "RecoveryPointCreationDate": { "shape": "timestamp", "documentation": "

This is the creation date of the recovery point made by the specifed restore job.

" }, "CreatedBy": { "shape": "RestoreJobCreator", "documentation": "

Contains identifying information about the creation of a restore job.

" }, "ValidationStatus": { "shape": "RestoreValidationStatus", "documentation": "

This is the status of validation run on the indicated restore job.

" }, "ValidationStatusMessage": { "shape": "string", "documentation": "

This describes the status of validation run on the indicated restore job.

" }, "DeletionStatus": { "shape": "RestoreDeletionStatus", "documentation": "

This notes the status of the data generated by the restore test. The status may be Deleting, Failed, or Successful.

" }, "DeletionStatusMessage": { "shape": "string", "documentation": "

This describes the restore job deletion status.

" } } }, "DisassociateRecoveryPointFromParentInput": { "type": "structure", "required": [ "BackupVaultName", "RecoveryPointArn" ], "members": { "BackupVaultName": { "shape": "BackupVaultName", "documentation": "

This is the name of a logical container where the child (nested) recovery point is stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.

", "location": "uri", "locationName": "backupVaultName" }, "RecoveryPointArn": { "shape": "ARN", "documentation": "

This is the Amazon Resource Name (ARN) that uniquely identifies the child (nested) recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

", "location": "uri", "locationName": "recoveryPointArn" } } }, "DisassociateRecoveryPointInput": { "type": "structure", "required": [ "BackupVaultName", "RecoveryPointArn" ], "members": { "BackupVaultName": { "shape": "BackupVaultName", "documentation": "

The unique name of an Backup vault.

", "location": "uri", "locationName": "backupVaultName" }, "RecoveryPointArn": { "shape": "ARN", "documentation": "

An Amazon Resource Name (ARN) that uniquely identifies an Backup recovery point.

", "location": "uri", "locationName": "recoveryPointArn" } } }, "ExportBackupPlanTemplateInput": { "type": "structure", "required": [ "BackupPlanId" ], "members": { "BackupPlanId": { "shape": "string", "documentation": "

Uniquely identifies a backup plan.

", "location": "uri", "locationName": "backupPlanId" } } }, "ExportBackupPlanTemplateOutput": { "type": "structure", "members": { "BackupPlanTemplateJson": { "shape": "string", "documentation": "

The body of a backup plan template in JSON format.

This is a signed JSON document that cannot be modified before being passed to GetBackupPlanFromJSON.

" } } }, "FormatList": { "type": "list", "member": { "shape": "string" } }, "Framework": { "type": "structure", "members": { "FrameworkName": { "shape": "FrameworkName", "documentation": "

The unique name of a framework. This name is between 1 and 256 characters, starting with a letter, and consisting of letters (a-z, A-Z), numbers (0-9), and underscores (_).

" }, "FrameworkArn": { "shape": "ARN", "documentation": "

An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.

" }, "FrameworkDescription": { "shape": "FrameworkDescription", "documentation": "

An optional description of the framework with a maximum 1,024 characters.

" }, "NumberOfControls": { "shape": "integer", "documentation": "

The number of controls contained by the framework.

" }, "CreationTime": { "shape": "timestamp", "documentation": "

The date and time that a framework is created, in ISO 8601 representation. The value of CreationTime is accurate to milliseconds. For example, 2020-07-10T15:00:00.000-08:00 represents the 10th of July 2020 at 3:00 PM 8 hours behind UTC.

" }, "DeploymentStatus": { "shape": "string", "documentation": "

The deployment status of a framework. The statuses are:

CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | COMPLETED | FAILED

" } }, "documentation": "

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

" }, "FrameworkControl": { "type": "structure", "required": [ "ControlName" ], "members": { "ControlName": { "shape": "ControlName", "documentation": "

The name of a control. This name is between 1 and 256 characters.

" }, "ControlInputParameters": { "shape": "ControlInputParameters", "documentation": "

A list of ParameterName and ParameterValue pairs.

" }, "ControlScope": { "shape": "ControlScope", "documentation": "

The scope of a control. The control scope defines what the control will evaluate. Three examples of control scopes are: a specific backup plan, all backup plans with a specific tag, or all backup plans.

For more information, see ControlScope.

" } }, "documentation": "

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

" }, "FrameworkControls": { "type": "list", "member": { "shape": "FrameworkControl" } }, "FrameworkDescription": { "type": "string", "max": 1024, "min": 0, "pattern": ".*\\S.*" }, "FrameworkList": { "type": "list", "member": { "shape": "Framework" } }, "FrameworkName": { "type": "string", "max": 256, "min": 1, "pattern": "[a-zA-Z][_a-zA-Z0-9]*" }, "GetBackupPlanFromJSONInput": { "type": "structure", "required": [ "BackupPlanTemplateJson" ], "members": { "BackupPlanTemplateJson": { "shape": "string", "documentation": "

A customer-supplied backup plan document in JSON format.

" } } }, "GetBackupPlanFromJSONOutput": { "type": "structure", "members": { "BackupPlan": { "shape": "BackupPlan", "documentation": "

Specifies the body of a backup plan. Includes a BackupPlanName and one or more sets of Rules.

" } } }, "GetBackupPlanFromTemplateInput": { "type": "structure", "required": [ "BackupPlanTemplateId" ], "members": { "BackupPlanTemplateId": { "shape": "string", "documentation": "

Uniquely identifies a stored backup plan template.

", "location": "uri", "locationName": "templateId" } } }, "GetBackupPlanFromTemplateOutput": { "type": "structure", "members": { "BackupPlanDocument": { "shape": "BackupPlan", "documentation": "

Returns the body of a backup plan based on the target template, including the name, rules, and backup vault of the plan.

" } } }, "GetBackupPlanInput": { "type": "structure", "required": [ "BackupPlanId" ], "members": { "BackupPlanId": { "shape": "string", "documentation": "

Uniquely identifies a backup plan.

", "location": "uri", "locationName": "backupPlanId" }, "VersionId": { "shape": "string", "documentation": "

Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes long. Version IDs cannot be edited.

", "location": "querystring", "locationName": "versionId" } } }, "GetBackupPlanOutput": { "type": "structure", "members": { "BackupPlan": { "shape": "BackupPlan", "documentation": "

Specifies the body of a backup plan. Includes a BackupPlanName and one or more sets of Rules.

" }, "BackupPlanId": { "shape": "string", "documentation": "

Uniquely identifies a backup plan.

" }, "BackupPlanArn": { "shape": "ARN", "documentation": "

An Amazon Resource Name (ARN) that uniquely identifies a backup plan; for example, arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50.

" }, "VersionId": { "shape": "string", "documentation": "

Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes long. Version IDs cannot be edited.

" }, "CreatorRequestId": { "shape": "string", "documentation": "

A unique string that identifies the request and allows failed requests to be retried without the risk of running the operation twice.

" }, "CreationDate": { "shape": "timestamp", "documentation": "

The date and time that a backup plan is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

" }, "DeletionDate": { "shape": "timestamp", "documentation": "

The date and time that a backup plan is deleted, in Unix format and Coordinated Universal Time (UTC). The value of DeletionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

" }, "LastExecutionDate": { "shape": "timestamp", "documentation": "

The last time a job to back up resources was run with this backup plan. A date and time, in Unix format and Coordinated Universal Time (UTC). The value of LastExecutionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

" }, "AdvancedBackupSettings": { "shape": "AdvancedBackupSettings", "documentation": "

Contains a list of BackupOptions for each resource type. The list is populated only if the advanced option is set for the backup plan.

" } } }, "GetBackupSelectionInput": { "type": "structure", "required": [ "BackupPlanId", "SelectionId" ], "members": { "BackupPlanId": { "shape": "string", "documentation": "

Uniquely identifies a backup plan.

", "location": "uri", "locationName": "backupPlanId" }, "SelectionId": { "shape": "string", "documentation": "

Uniquely identifies the body of a request to assign a set of resources to a backup plan.

", "location": "uri", "locationName": "selectionId" } } }, "GetBackupSelectionOutput": { "type": "structure", "members": { "BackupSelection": { "shape": "BackupSelection", "documentation": "

Specifies the body of a request to assign a set of resources to a backup plan.

" }, "SelectionId": { "shape": "string", "documentation": "

Uniquely identifies the body of a request to assign a set of resources to a backup plan.

" }, "BackupPlanId": { "shape": "string", "documentation": "

Uniquely identifies a backup plan.

" }, "CreationDate": { "shape": "timestamp", "documentation": "

The date and time a backup selection is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

" }, "CreatorRequestId": { "shape": "string", "documentation": "

A unique string that identifies the request and allows failed requests to be retried without the risk of running the operation twice.

" } } }, "GetBackupVaultAccessPolicyInput": { "type": "structure", "required": [ "BackupVaultName" ], "members": { "BackupVaultName": { "shape": "BackupVaultName", "documentation": "

The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.

", "location": "uri", "locationName": "backupVaultName" } } }, "GetBackupVaultAccessPolicyOutput": { "type": "structure", "members": { "BackupVaultName": { "shape": "BackupVaultName", "documentation": "

The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Region where they are created. They consist of lowercase letters, numbers, and hyphens.

" }, "BackupVaultArn": { "shape": "ARN", "documentation": "

An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.

" }, "Policy": { "shape": "IAMPolicy", "documentation": "

The backup vault access policy document in JSON format.

" } } }, "GetBackupVaultNotificationsInput": { "type": "structure", "required": [ "BackupVaultName" ], "members": { "BackupVaultName": { "shape": "BackupVaultName", "documentation": "

The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.

", "location": "uri", "locationName": "backupVaultName" } } }, "GetBackupVaultNotificationsOutput": { "type": "structure", "members": { "BackupVaultName": { "shape": "BackupVaultName", "documentation": "

The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Region where they are created. They consist of lowercase letters, numbers, and hyphens.

" }, "BackupVaultArn": { "shape": "ARN", "documentation": "

An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.

" }, "SNSTopicArn": { "shape": "ARN", "documentation": "

An ARN that uniquely identifies an Amazon Simple Notification Service (Amazon SNS) topic; for example, arn:aws:sns:us-west-2:111122223333:MyTopic.

" }, "BackupVaultEvents": { "shape": "BackupVaultEvents", "documentation": "

An array of events that indicate the status of jobs to back up resources to the backup vault.

" } } }, "GetLegalHoldInput": { "type": "structure", "required": [ "LegalHoldId" ], "members": { "LegalHoldId": { "shape": "string", "documentation": "

This is the ID required to use GetLegalHold. This unique ID is associated with a specific legal hold.

", "location": "uri", "locationName": "legalHoldId" } } }, "GetLegalHoldOutput": { "type": "structure", "members": { "Title": { "shape": "string", "documentation": "

This is the string title of the legal hold.

" }, "Status": { "shape": "LegalHoldStatus", "documentation": "

This is the status of the legal hold. Statuses can be ACTIVE, CREATING, CANCELED, and CANCELING.

" }, "Description": { "shape": "string", "documentation": "

This is the returned string description of the legal hold.

" }, "CancelDescription": { "shape": "string", "documentation": "

String describing the reason for removing the legal hold.

" }, "LegalHoldId": { "shape": "string", "documentation": "

This is the returned ID associated with a specified legal hold.

" }, "LegalHoldArn": { "shape": "ARN", "documentation": "

This is the returned framework ARN for the specified legal hold. An Amazon Resource Name (ARN) uniquely identifies a resource. The format of the ARN depends on the resource type.

" }, "CreationDate": { "shape": "timestamp", "documentation": "

Time in number format when legal hold was created.

" }, "CancellationDate": { "shape": "timestamp", "documentation": "

Time in number when legal hold was cancelled.

" }, "RetainRecordUntil": { "shape": "timestamp", "documentation": "

This is the date and time until which the legal hold record will be retained.

" }, "RecoveryPointSelection": { "shape": "RecoveryPointSelection", "documentation": "

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

" } } }, "GetRecoveryPointRestoreMetadataInput": { "type": "structure", "required": [ "BackupVaultName", "RecoveryPointArn" ], "members": { "BackupVaultName": { "shape": "BackupVaultName", "documentation": "

The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.

", "location": "uri", "locationName": "backupVaultName" }, "RecoveryPointArn": { "shape": "ARN", "documentation": "

An Amazon Resource Name (ARN) that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

", "location": "uri", "locationName": "recoveryPointArn" }, "BackupVaultAccountId": { "shape": "AccountId", "documentation": "

This is the account ID of the specified backup vault.

", "location": "querystring", "locationName": "backupVaultAccountId" } } }, "GetRecoveryPointRestoreMetadataOutput": { "type": "structure", "members": { "BackupVaultArn": { "shape": "ARN", "documentation": "

An ARN that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.

" }, "RecoveryPointArn": { "shape": "ARN", "documentation": "

An ARN that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

" }, "RestoreMetadata": { "shape": "Metadata", "documentation": "

The set of metadata key-value pairs that describe the original configuration of the backed-up resource. These values vary depending on the service that is being restored.

" }, "ResourceType": { "shape": "ResourceType", "documentation": "

This is the resource type associated with the recovery point.

" } } }, "GetRestoreJobMetadataInput": { "type": "structure", "required": [ "RestoreJobId" ], "members": { "RestoreJobId": { "shape": "RestoreJobId", "documentation": "

This is a unique identifier of a restore job within Backup.

", "location": "uri", "locationName": "restoreJobId" } } }, "GetRestoreJobMetadataOutput": { "type": "structure", "members": { "RestoreJobId": { "shape": "RestoreJobId", "documentation": "

This is a unique identifier of a restore job within Backup.

" }, "Metadata": { "shape": "Metadata", "documentation": "

This contains the metadata of the specified backup job.

" } } }, "GetRestoreTestingInferredMetadataInput": { "type": "structure", "required": [ "BackupVaultName", "RecoveryPointArn" ], "members": { "BackupVaultAccountId": { "shape": "String", "documentation": "

This is the account ID of the specified backup vault.

", "location": "querystring", "locationName": "BackupVaultAccountId" }, "BackupVaultName": { "shape": "String", "documentation": "

The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web ServicesRegion where they are created. They consist of letters, numbers, and hyphens.

", "location": "querystring", "locationName": "BackupVaultName" }, "RecoveryPointArn": { "shape": "String", "documentation": "

An Amazon Resource Name (ARN) that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

", "location": "querystring", "locationName": "RecoveryPointArn" } } }, "GetRestoreTestingInferredMetadataOutput": { "type": "structure", "required": [ "InferredMetadata" ], "members": { "InferredMetadata": { "shape": "stringMap", "documentation": "

This is a string map of the metadata inferred from the request.

" } } }, "GetRestoreTestingPlanInput": { "type": "structure", "required": [ "RestoreTestingPlanName" ], "members": { "RestoreTestingPlanName": { "shape": "String", "documentation": "

Required unique name of the restore testing plan.

", "location": "uri", "locationName": "RestoreTestingPlanName" } } }, "GetRestoreTestingPlanOutput": { "type": "structure", "required": [ "RestoreTestingPlan" ], "members": { "RestoreTestingPlan": { "shape": "RestoreTestingPlanForGet", "documentation": "

Specifies the body of a restore testing plan. Includes RestoreTestingPlanName.

" } } }, "GetRestoreTestingSelectionInput": { "type": "structure", "required": [ "RestoreTestingPlanName", "RestoreTestingSelectionName" ], "members": { "RestoreTestingPlanName": { "shape": "String", "documentation": "

Required unique name of the restore testing plan.

", "location": "uri", "locationName": "RestoreTestingPlanName" }, "RestoreTestingSelectionName": { "shape": "String", "documentation": "

Required unique name of the restore testing selection.

", "location": "uri", "locationName": "RestoreTestingSelectionName" } } }, "GetRestoreTestingSelectionOutput": { "type": "structure", "required": [ "RestoreTestingSelection" ], "members": { "RestoreTestingSelection": { "shape": "RestoreTestingSelectionForGet", "documentation": "

Unique name of the restore testing selection.

" } } }, "GetSupportedResourceTypesOutput": { "type": "structure", "members": { "ResourceTypes": { "shape": "ResourceTypes", "documentation": "

Contains a string with the supported Amazon Web Services resource types:

" } } }, "GlobalSettings": { "type": "map", "key": { "shape": "GlobalSettingsName" }, "value": { "shape": "GlobalSettingsValue" } }, "GlobalSettingsName": { "type": "string" }, "GlobalSettingsValue": { "type": "string" }, "IAMPolicy": { "type": "string" }, "IAMRoleArn": { "type": "string" }, "IsEnabled": { "type": "boolean" }, "KeyValue": { "type": "structure", "required": [ "Key", "Value" ], "members": { "Key": { "shape": "String", "documentation": "

The tag key (String). The key can't start with aws:.

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: ^(?![aA]{1}[wW]{1}[sS]{1}:)([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]+)$

" }, "Value": { "shape": "String", "documentation": "

The value of the key.

Length Constraints: Maximum length of 256.

Pattern: ^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$

" } }, "documentation": "

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

" }, "KeyValueList": { "type": "list", "member": { "shape": "KeyValue" } }, "LegalHold": { "type": "structure", "members": { "Title": { "shape": "string", "documentation": "

This is the title of a legal hold.

" }, "Status": { "shape": "LegalHoldStatus", "documentation": "

This is the status of the legal hold. Statuses can be ACTIVE, CREATING, CANCELED, and CANCELING.

" }, "Description": { "shape": "string", "documentation": "

This is the description of a legal hold.

" }, "LegalHoldId": { "shape": "string", "documentation": "

ID of specific legal hold on one or more recovery points.

" }, "LegalHoldArn": { "shape": "ARN", "documentation": "

This is an Amazon Resource Number (ARN) that uniquely identifies the legal hold; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

" }, "CreationDate": { "shape": "timestamp", "documentation": "

This is the time in number format when legal hold was created.

" }, "CancellationDate": { "shape": "timestamp", "documentation": "

This is the time in number format when legal hold was cancelled.

" } }, "documentation": "

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.

" }, "LegalHoldStatus": { "type": "string", "enum": [ "CREATING", "ACTIVE", "CANCELING", "CANCELED" ] }, "LegalHoldsList": { "type": "list", "member": { "shape": "LegalHold" } }, "Lifecycle": { "type": "structure", "members": { "MoveToColdStorageAfterDays": { "shape": "Long", "documentation": "

Specifies the number of days after creation that a recovery point is moved to cold storage.

" }, "DeleteAfterDays": { "shape": "Long", "documentation": "

Specifies the number of days after creation that a recovery point is deleted. Must be greater than 90 days plus MoveToColdStorageAfterDays.

" }, "OptInToArchiveForSupportedResources": { "shape": "Boolean", "documentation": "

Optional Boolean. If this is true, this setting will instruct your backup plan to transition supported resources to archive (cold) storage tier in accordance with your lifecycle settings.

" } }, "documentation": "

Contains an array of Transition objects specifying how long 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 cannot be changed after a backup has been transitioned to cold.

Resource types that are able to be transitioned to cold storage are listed in the \"Lifecycle to cold storage\" section of the Feature availability by resource table. Backup ignores this expression for other resource types.

" }, "ListBackupJobSummariesInput": { "type": "structure", "members": { "AccountId": { "shape": "AccountId", "documentation": "

Returns the job count for the specified account.

If the request is sent from a member account or an account not part of Amazon Web Services Organizations, jobs within requestor's account will be returned.

Root, admin, and delegated administrator accounts can use the value ANY to return job counts from every account in the organization.

AGGREGATE_ALL aggregates job counts from all accounts within the authenticated organization, then returns the sum.

", "location": "querystring", "locationName": "AccountId" }, "State": { "shape": "BackupJobStatus", "documentation": "

This parameter returns the job count for jobs with the specified state.

The the value ANY returns count of all states.

AGGREGATE_ALL aggregates job counts for all states and returns the sum.

Completed with issues is a status found only in the Backup console. For API, this status refers to jobs with a state of COMPLETED and a MessageCategory with a value other than SUCCESS; that is, the status is completed but comes with a status message. To obtain the job count for Completed with issues, run two GET requests, and subtract the second, smaller number:

GET /audit/backup-job-summaries?AggregationPeriod=FOURTEEN_DAYS&State=COMPLETED

GET /audit/backup-job-summaries?AggregationPeriod=FOURTEEN_DAYS&MessageCategory=SUCCESS&State=COMPLETED

", "location": "querystring", "locationName": "State" }, "ResourceType": { "shape": "ResourceType", "documentation": "

Returns the job count for the specified resource type. Use request GetSupportedResourceTypes to obtain strings for supported resource types.

The the value ANY returns count of all resource types.

AGGREGATE_ALL aggregates job counts for all resource types and returns the sum.

The type of Amazon Web Services resource to be backed up; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.

", "location": "querystring", "locationName": "ResourceType" }, "MessageCategory": { "shape": "MessageCategory", "documentation": "

This parameter returns the job count for the specified message category.

Example accepted strings include AccessDenied, Success, and InvalidParameters. See Monitoring for a list of accepted MessageCategory strings.

The the value ANY returns count of all message categories.

AGGREGATE_ALL aggregates job counts for all message categories and returns the sum.

", "location": "querystring", "locationName": "MessageCategory" }, "AggregationPeriod": { "shape": "AggregationPeriod", "documentation": "

This is the period that sets the boundaries for returned results.

Acceptable values include

", "location": "querystring", "locationName": "AggregationPeriod" }, "MaxResults": { "shape": "MaxResults", "documentation": "

This parameter sets the maximum number of items to be returned.

The value is an integer. Range of accepted values is from 1 to 500.

", "location": "querystring", "locationName": "MaxResults" }, "NextToken": { "shape": "string", "documentation": "

The next item following a partial list of returned resources. For example, if a request is made to return MaxResults number of resources, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

", "location": "querystring", "locationName": "NextToken" } } }, "ListBackupJobSummariesOutput": { "type": "structure", "members": { "BackupJobSummaries": { "shape": "BackupJobSummaryList", "documentation": "

This request returns a summary that contains Region, Account, State, ResourceType, MessageCategory, StartTime, EndTime, and Count of included jobs.

" }, "AggregationPeriod": { "shape": "string", "documentation": "

This is the period that sets the boundaries for returned results.

" }, "NextToken": { "shape": "string", "documentation": "

The next item following a partial list of returned resources. For example, if a request is made to return MaxResults number of resources, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

" } } }, "ListBackupJobsInput": { "type": "structure", "members": { "NextToken": { "shape": "string", "documentation": "

The next item following a partial list of returned items. For example, if a request is made to return MaxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

", "location": "querystring", "locationName": "nextToken" }, "MaxResults": { "shape": "MaxResults", "documentation": "

The maximum number of items to be returned.

", "location": "querystring", "locationName": "maxResults" }, "ByResourceArn": { "shape": "ARN", "documentation": "

Returns only backup jobs that match the specified resource Amazon Resource Name (ARN).

", "location": "querystring", "locationName": "resourceArn" }, "ByState": { "shape": "BackupJobState", "documentation": "

Returns only backup jobs that are in the specified state.

Completed with issues is a status found only in the Backup console. For API, this status refers to jobs with a state of COMPLETED and a MessageCategory with a value other than SUCCESS; that is, the status is completed but comes with a status message.

To obtain the job count for Completed with issues, run two GET requests, and subtract the second, smaller number:

GET /backup-jobs/?state=COMPLETED

GET /backup-jobs/?messageCategory=SUCCESS&state=COMPLETED

", "location": "querystring", "locationName": "state" }, "ByBackupVaultName": { "shape": "BackupVaultName", "documentation": "

Returns only backup jobs that will be stored in the specified backup vault. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.

", "location": "querystring", "locationName": "backupVaultName" }, "ByCreatedBefore": { "shape": "timestamp", "documentation": "

Returns only backup jobs that were created before the specified date.

", "location": "querystring", "locationName": "createdBefore" }, "ByCreatedAfter": { "shape": "timestamp", "documentation": "

Returns only backup jobs that were created after the specified date.

", "location": "querystring", "locationName": "createdAfter" }, "ByResourceType": { "shape": "ResourceType", "documentation": "

Returns only backup jobs for the specified resources:

", "location": "querystring", "locationName": "resourceType" }, "ByAccountId": { "shape": "AccountId", "documentation": "

The account ID to list the jobs from. Returns only backup jobs associated with the specified account ID.

If used from an Organizations management account, passing * returns all jobs across the organization.

", "location": "querystring", "locationName": "accountId" }, "ByCompleteAfter": { "shape": "timestamp", "documentation": "

Returns only backup jobs completed after a date expressed in Unix format and Coordinated Universal Time (UTC).

", "location": "querystring", "locationName": "completeAfter" }, "ByCompleteBefore": { "shape": "timestamp", "documentation": "

Returns only backup jobs completed before a date expressed in Unix format and Coordinated Universal Time (UTC).

", "location": "querystring", "locationName": "completeBefore" }, "ByParentJobId": { "shape": "string", "documentation": "

This is a filter to list child (nested) jobs based on parent job ID.

", "location": "querystring", "locationName": "parentJobId" }, "ByMessageCategory": { "shape": "string", "documentation": "

This is an optional parameter that can be used to filter out jobs with a MessageCategory which matches the value you input.

Example strings may include AccessDenied, SUCCESS, AGGREGATE_ALL, and InvalidParameters.

View Monitoring

The wildcard () returns count of all message categories.

AGGREGATE_ALL aggregates job counts for all message categories and returns the sum.

", "location": "querystring", "locationName": "messageCategory" } } }, "ListBackupJobsOutput": { "type": "structure", "members": { "BackupJobs": { "shape": "BackupJobsList", "documentation": "

An array of structures containing metadata about your backup jobs returned in JSON format.

" }, "NextToken": { "shape": "string", "documentation": "

The next item following a partial list of returned items. For example, if a request is made to return MaxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

" } } }, "ListBackupPlanTemplatesInput": { "type": "structure", "members": { "NextToken": { "shape": "string", "documentation": "

The next item following a partial list of returned items. For example, if a request is made to return MaxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

", "location": "querystring", "locationName": "nextToken" }, "MaxResults": { "shape": "MaxResults", "documentation": "

The maximum number of items to be returned.

", "location": "querystring", "locationName": "maxResults" } } }, "ListBackupPlanTemplatesOutput": { "type": "structure", "members": { "NextToken": { "shape": "string", "documentation": "

The next item following a partial list of returned items. For example, if a request is made to return MaxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

" }, "BackupPlanTemplatesList": { "shape": "BackupPlanTemplatesList", "documentation": "

An array of template list items containing metadata about your saved templates.

" } } }, "ListBackupPlanVersionsInput": { "type": "structure", "required": [ "BackupPlanId" ], "members": { "BackupPlanId": { "shape": "string", "documentation": "

Uniquely identifies a backup plan.

", "location": "uri", "locationName": "backupPlanId" }, "NextToken": { "shape": "string", "documentation": "

The next item following a partial list of returned items. For example, if a request is made to return MaxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

", "location": "querystring", "locationName": "nextToken" }, "MaxResults": { "shape": "MaxResults", "documentation": "

The maximum number of items to be returned.

", "location": "querystring", "locationName": "maxResults" } } }, "ListBackupPlanVersionsOutput": { "type": "structure", "members": { "NextToken": { "shape": "string", "documentation": "

The next item following a partial list of returned items. For example, if a request is made to return MaxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

" }, "BackupPlanVersionsList": { "shape": "BackupPlanVersionsList", "documentation": "

An array of version list items containing metadata about your backup plans.

" } } }, "ListBackupPlansInput": { "type": "structure", "members": { "NextToken": { "shape": "string", "documentation": "

The next item following a partial list of returned items. For example, if a request is made to return MaxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

", "location": "querystring", "locationName": "nextToken" }, "MaxResults": { "shape": "MaxResults", "documentation": "

The maximum number of items to be returned.

", "location": "querystring", "locationName": "maxResults" }, "IncludeDeleted": { "shape": "Boolean", "documentation": "

A Boolean value with a default value of FALSE that returns deleted backup plans when set to TRUE.

", "location": "querystring", "locationName": "includeDeleted" } } }, "ListBackupPlansOutput": { "type": "structure", "members": { "NextToken": { "shape": "string", "documentation": "

The next item following a partial list of returned items. For example, if a request is made to return MaxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

" }, "BackupPlansList": { "shape": "BackupPlansList", "documentation": "

An array of backup plan list items containing metadata about your saved backup plans.

" } } }, "ListBackupSelectionsInput": { "type": "structure", "required": [ "BackupPlanId" ], "members": { "BackupPlanId": { "shape": "string", "documentation": "

Uniquely identifies a backup plan.

", "location": "uri", "locationName": "backupPlanId" }, "NextToken": { "shape": "string", "documentation": "

The next item following a partial list of returned items. For example, if a request is made to return MaxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

", "location": "querystring", "locationName": "nextToken" }, "MaxResults": { "shape": "MaxResults", "documentation": "

The maximum number of items to be returned.

", "location": "querystring", "locationName": "maxResults" } } }, "ListBackupSelectionsOutput": { "type": "structure", "members": { "NextToken": { "shape": "string", "documentation": "

The next item following a partial list of returned items. For example, if a request is made to return MaxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

" }, "BackupSelectionsList": { "shape": "BackupSelectionsList", "documentation": "

An array of backup selection list items containing metadata about each resource in the list.

" } } }, "ListBackupVaultsInput": { "type": "structure", "members": { "ByVaultType": { "shape": "VaultType", "documentation": "

This parameter will sort the list of vaults by vault type.

", "location": "querystring", "locationName": "vaultType" }, "ByShared": { "shape": "boolean", "documentation": "

This parameter will sort the list of vaults by shared vaults.

", "location": "querystring", "locationName": "shared" }, "NextToken": { "shape": "string", "documentation": "

The next item following a partial list of returned items. For example, if a request is made to return MaxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

", "location": "querystring", "locationName": "nextToken" }, "MaxResults": { "shape": "MaxResults", "documentation": "

The maximum number of items to be returned.

", "location": "querystring", "locationName": "maxResults" } } }, "ListBackupVaultsOutput": { "type": "structure", "members": { "BackupVaultList": { "shape": "BackupVaultList", "documentation": "

An array of backup vault list members containing vault metadata, including Amazon Resource Name (ARN), display name, creation date, number of saved recovery points, and encryption information if the resources saved in the backup vault are encrypted.

" }, "NextToken": { "shape": "string", "documentation": "

The next item following a partial list of returned items. For example, if a request is made to return MaxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

" } } }, "ListCopyJobSummariesInput": { "type": "structure", "members": { "AccountId": { "shape": "AccountId", "documentation": "

Returns the job count for the specified account.

If the request is sent from a member account or an account not part of Amazon Web Services Organizations, jobs within requestor's account will be returned.

Root, admin, and delegated administrator accounts can use the value ANY to return job counts from every account in the organization.

AGGREGATE_ALL aggregates job counts from all accounts within the authenticated organization, then returns the sum.

", "location": "querystring", "locationName": "AccountId" }, "State": { "shape": "CopyJobStatus", "documentation": "

This parameter returns the job count for jobs with the specified state.

The the value ANY returns count of all states.

AGGREGATE_ALL aggregates job counts for all states and returns the sum.

", "location": "querystring", "locationName": "State" }, "ResourceType": { "shape": "ResourceType", "documentation": "

Returns the job count for the specified resource type. Use request GetSupportedResourceTypes to obtain strings for supported resource types.

The the value ANY returns count of all resource types.

AGGREGATE_ALL aggregates job counts for all resource types and returns the sum.

The type of Amazon Web Services resource to be backed up; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.

", "location": "querystring", "locationName": "ResourceType" }, "MessageCategory": { "shape": "MessageCategory", "documentation": "

This parameter returns the job count for the specified message category.

Example accepted strings include AccessDenied, Success, and InvalidParameters. See Monitoring for a list of accepted MessageCategory strings.

The the value ANY returns count of all message categories.

AGGREGATE_ALL aggregates job counts for all message categories and returns the sum.

", "location": "querystring", "locationName": "MessageCategory" }, "AggregationPeriod": { "shape": "AggregationPeriod", "documentation": "

This is the period that sets the boundaries for returned results.

", "location": "querystring", "locationName": "AggregationPeriod" }, "MaxResults": { "shape": "MaxResults", "documentation": "

This parameter sets the maximum number of items to be returned.

The value is an integer. Range of accepted values is from 1 to 500.

", "location": "querystring", "locationName": "MaxResults" }, "NextToken": { "shape": "string", "documentation": "

The next item following a partial list of returned resources. For example, if a request is made to return MaxResults number of resources, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

", "location": "querystring", "locationName": "NextToken" } } }, "ListCopyJobSummariesOutput": { "type": "structure", "members": { "CopyJobSummaries": { "shape": "CopyJobSummaryList", "documentation": "

This return shows a summary that contains Region, Account, State, ResourceType, MessageCategory, StartTime, EndTime, and Count of included jobs.

" }, "AggregationPeriod": { "shape": "string", "documentation": "

This is the period that sets the boundaries for returned results.

" }, "NextToken": { "shape": "string", "documentation": "

The next item following a partial list of returned resources. For example, if a request is made to return MaxResults number of resources, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

" } } }, "ListCopyJobsInput": { "type": "structure", "members": { "NextToken": { "shape": "string", "documentation": "

The next item following a partial list of returned items. For example, if a request is made to return MaxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

", "location": "querystring", "locationName": "nextToken" }, "MaxResults": { "shape": "MaxResults", "documentation": "

The maximum number of items to be returned.

", "location": "querystring", "locationName": "maxResults" }, "ByResourceArn": { "shape": "ARN", "documentation": "

Returns only copy jobs that match the specified resource Amazon Resource Name (ARN).

", "location": "querystring", "locationName": "resourceArn" }, "ByState": { "shape": "CopyJobState", "documentation": "

Returns only copy jobs that are in the specified state.

", "location": "querystring", "locationName": "state" }, "ByCreatedBefore": { "shape": "timestamp", "documentation": "

Returns only copy jobs that were created before the specified date.

", "location": "querystring", "locationName": "createdBefore" }, "ByCreatedAfter": { "shape": "timestamp", "documentation": "

Returns only copy jobs that were created after the specified date.

", "location": "querystring", "locationName": "createdAfter" }, "ByResourceType": { "shape": "ResourceType", "documentation": "

Returns only backup jobs for the specified resources:

", "location": "querystring", "locationName": "resourceType" }, "ByDestinationVaultArn": { "shape": "string", "documentation": "

An Amazon Resource Name (ARN) that uniquely identifies a source backup vault to copy from; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.

", "location": "querystring", "locationName": "destinationVaultArn" }, "ByAccountId": { "shape": "AccountId", "documentation": "

The account ID to list the jobs from. Returns only copy jobs associated with the specified account ID.

", "location": "querystring", "locationName": "accountId" }, "ByCompleteBefore": { "shape": "timestamp", "documentation": "

Returns only copy jobs completed before a date expressed in Unix format and Coordinated Universal Time (UTC).

", "location": "querystring", "locationName": "completeBefore" }, "ByCompleteAfter": { "shape": "timestamp", "documentation": "

Returns only copy jobs completed after a date expressed in Unix format and Coordinated Universal Time (UTC).

", "location": "querystring", "locationName": "completeAfter" }, "ByParentJobId": { "shape": "string", "documentation": "

This is a filter to list child (nested) jobs based on parent job ID.

", "location": "querystring", "locationName": "parentJobId" }, "ByMessageCategory": { "shape": "string", "documentation": "

This is an optional parameter that can be used to filter out jobs with a MessageCategory which matches the value you input.

Example strings may include AccessDenied, SUCCESS, AGGREGATE_ALL, and INVALIDPARAMETERS.

View Monitoring for a list of accepted strings.

The the value ANY returns count of all message categories.

AGGREGATE_ALL aggregates job counts for all message categories and returns the sum.

", "location": "querystring", "locationName": "messageCategory" } } }, "ListCopyJobsOutput": { "type": "structure", "members": { "CopyJobs": { "shape": "CopyJobsList", "documentation": "

An array of structures containing metadata about your copy jobs returned in JSON format.

" }, "NextToken": { "shape": "string", "documentation": "

The next item following a partial list of returned items. For example, if a request is made to return MaxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

" } } }, "ListFrameworksInput": { "type": "structure", "members": { "MaxResults": { "shape": "MaxFrameworkInputs", "documentation": "

The number of desired results from 1 to 1000. Optional. If unspecified, the query will return 1 MB of data.

", "location": "querystring", "locationName": "MaxResults" }, "NextToken": { "shape": "string", "documentation": "

An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

", "location": "querystring", "locationName": "NextToken" } } }, "ListFrameworksOutput": { "type": "structure", "members": { "Frameworks": { "shape": "FrameworkList", "documentation": "

A list of frameworks with details for each framework, including the framework name, Amazon Resource Name (ARN), description, number of controls, creation time, and deployment status.

" }, "NextToken": { "shape": "string", "documentation": "

An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

" } } }, "ListLegalHoldsInput": { "type": "structure", "members": { "NextToken": { "shape": "string", "documentation": "

The next item following a partial list of returned resources. For example, if a request is made to return MaxResults number of resources, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

", "location": "querystring", "locationName": "nextToken" }, "MaxResults": { "shape": "MaxResults", "documentation": "

The maximum number of resource list items to be returned.

", "location": "querystring", "locationName": "maxResults" } } }, "ListLegalHoldsOutput": { "type": "structure", "members": { "NextToken": { "shape": "string", "documentation": "

The next item following a partial list of returned resources. For example, if a request is made to return MaxResults number of resources, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

" }, "LegalHolds": { "shape": "LegalHoldsList", "documentation": "

This is an array of returned legal holds, both active and previous.

" } } }, "ListOfTags": { "type": "list", "member": { "shape": "Condition" } }, "ListProtectedResourcesByBackupVaultInput": { "type": "structure", "required": [ "BackupVaultName" ], "members": { "BackupVaultName": { "shape": "BackupVaultName", "documentation": "

This is the list of protected resources by backup vault within the vault(s) you specify by name.

", "location": "uri", "locationName": "backupVaultName" }, "BackupVaultAccountId": { "shape": "AccountId", "documentation": "

This is the list of protected resources by backup vault within the vault(s) you specify by account ID.

", "location": "querystring", "locationName": "backupVaultAccountId" }, "NextToken": { "shape": "string", "documentation": "

The next item following a partial list of returned items. For example, if a request is made to return MaxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

", "location": "querystring", "locationName": "nextToken" }, "MaxResults": { "shape": "MaxResults", "documentation": "

The maximum number of items to be returned.

", "location": "querystring", "locationName": "maxResults" } } }, "ListProtectedResourcesByBackupVaultOutput": { "type": "structure", "members": { "Results": { "shape": "ProtectedResourcesList", "documentation": "

These are the results returned for the request ListProtectedResourcesByBackupVault.

" }, "NextToken": { "shape": "string", "documentation": "

The next item following a partial list of returned items. For example, if a request is made to return MaxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

" } } }, "ListProtectedResourcesInput": { "type": "structure", "members": { "NextToken": { "shape": "string", "documentation": "

The next item following a partial list of returned items. For example, if a request is made to return MaxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

", "location": "querystring", "locationName": "nextToken" }, "MaxResults": { "shape": "MaxResults", "documentation": "

The maximum number of items to be returned.

", "location": "querystring", "locationName": "maxResults" } } }, "ListProtectedResourcesOutput": { "type": "structure", "members": { "Results": { "shape": "ProtectedResourcesList", "documentation": "

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.

" }, "NextToken": { "shape": "string", "documentation": "

The next item following a partial list of returned items. For example, if a request is made to return MaxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

" } } }, "ListRecoveryPointsByBackupVaultInput": { "type": "structure", "required": [ "BackupVaultName" ], "members": { "BackupVaultName": { "shape": "BackupVaultName", "documentation": "

The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.

Backup vault name might not be available when a supported service creates the backup.

", "location": "uri", "locationName": "backupVaultName" }, "BackupVaultAccountId": { "shape": "AccountId", "documentation": "

This parameter will sort the list of recovery points by account ID.

", "location": "querystring", "locationName": "backupVaultAccountId" }, "NextToken": { "shape": "string", "documentation": "

The next item following a partial list of returned items. For example, if a request is made to return MaxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

", "location": "querystring", "locationName": "nextToken" }, "MaxResults": { "shape": "MaxResults", "documentation": "

The maximum number of items to be returned.

", "location": "querystring", "locationName": "maxResults" }, "ByResourceArn": { "shape": "ARN", "documentation": "

Returns only recovery points that match the specified resource Amazon Resource Name (ARN).

", "location": "querystring", "locationName": "resourceArn" }, "ByResourceType": { "shape": "ResourceType", "documentation": "

Returns only recovery points that match the specified resource type(s):

", "location": "querystring", "locationName": "resourceType" }, "ByBackupPlanId": { "shape": "string", "documentation": "

Returns only recovery points that match the specified backup plan ID.

", "location": "querystring", "locationName": "backupPlanId" }, "ByCreatedBefore": { "shape": "timestamp", "documentation": "

Returns only recovery points that were created before the specified timestamp.

", "location": "querystring", "locationName": "createdBefore" }, "ByCreatedAfter": { "shape": "timestamp", "documentation": "

Returns only recovery points that were created after the specified timestamp.

", "location": "querystring", "locationName": "createdAfter" }, "ByParentRecoveryPointArn": { "shape": "ARN", "documentation": "

This returns only recovery points that match the specified parent (composite) recovery point Amazon Resource Name (ARN).

", "location": "querystring", "locationName": "parentRecoveryPointArn" } } }, "ListRecoveryPointsByBackupVaultOutput": { "type": "structure", "members": { "NextToken": { "shape": "string", "documentation": "

The next item following a partial list of returned items. For example, if a request is made to return MaxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

" }, "RecoveryPoints": { "shape": "RecoveryPointByBackupVaultList", "documentation": "

An array of objects that contain detailed information about recovery points saved in a backup vault.

" } } }, "ListRecoveryPointsByLegalHoldInput": { "type": "structure", "required": [ "LegalHoldId" ], "members": { "LegalHoldId": { "shape": "string", "documentation": "

This is the ID of the legal hold.

", "location": "uri", "locationName": "legalHoldId" }, "NextToken": { "shape": "string", "documentation": "

This is the next item following a partial list of returned resources. For example, if a request is made to return MaxResults number of resources, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

", "location": "querystring", "locationName": "nextToken" }, "MaxResults": { "shape": "MaxResults", "documentation": "

This is the maximum number of resource list items to be returned.

", "location": "querystring", "locationName": "maxResults" } } }, "ListRecoveryPointsByLegalHoldOutput": { "type": "structure", "members": { "RecoveryPoints": { "shape": "RecoveryPointsList", "documentation": "

This is a list of the recovery points returned by ListRecoveryPointsByLegalHold.

" }, "NextToken": { "shape": "string", "documentation": "

This return is the next item following a partial list of returned resources.

" } } }, "ListRecoveryPointsByResourceInput": { "type": "structure", "required": [ "ResourceArn" ], "members": { "ResourceArn": { "shape": "ARN", "documentation": "

An ARN that uniquely identifies a resource. The format of the ARN depends on the resource type.

", "location": "uri", "locationName": "resourceArn" }, "NextToken": { "shape": "string", "documentation": "

The next item following a partial list of returned items. For example, if a request is made to return MaxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

", "location": "querystring", "locationName": "nextToken" }, "MaxResults": { "shape": "MaxResults", "documentation": "

The maximum number of items to be returned.

Amazon RDS requires a value of at least 20.

", "location": "querystring", "locationName": "maxResults" }, "ManagedByAWSBackupOnly": { "shape": "boolean", "documentation": "

This attribute filters recovery points based on ownership.

If this is set to TRUE, the response will contain recovery points associated with the selected resources that are managed by Backup.

If this is set to FALSE, the response will contain all recovery points associated with the selected resource.

Type: Boolean

", "location": "querystring", "locationName": "managedByAWSBackupOnly" } } }, "ListRecoveryPointsByResourceOutput": { "type": "structure", "members": { "NextToken": { "shape": "string", "documentation": "

The next item following a partial list of returned items. For example, if a request is made to return MaxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

" }, "RecoveryPoints": { "shape": "RecoveryPointByResourceList", "documentation": "

An array of objects that contain detailed information about recovery points of the specified resource type.

Only Amazon EFS and Amazon EC2 recovery points return BackupVaultName.

" } } }, "ListReportJobsInput": { "type": "structure", "members": { "ByReportPlanName": { "shape": "ReportPlanName", "documentation": "

Returns only report jobs with the specified report plan name.

", "location": "querystring", "locationName": "ReportPlanName" }, "ByCreationBefore": { "shape": "timestamp", "documentation": "

Returns only report jobs that were created before the date and time specified in Unix format and Coordinated Universal Time (UTC). For example, the value 1516925490 represents Friday, January 26, 2018 12:11:30 AM.

", "location": "querystring", "locationName": "CreationBefore" }, "ByCreationAfter": { "shape": "timestamp", "documentation": "

Returns only report jobs that were created after the date and time specified in Unix format and Coordinated Universal Time (UTC). For example, the value 1516925490 represents Friday, January 26, 2018 12:11:30 AM.

", "location": "querystring", "locationName": "CreationAfter" }, "ByStatus": { "shape": "string", "documentation": "

Returns only report jobs that are in the specified status. The statuses are:

CREATED | RUNNING | COMPLETED | FAILED

", "location": "querystring", "locationName": "Status" }, "MaxResults": { "shape": "MaxResults", "documentation": "

The number of desired results from 1 to 1000. Optional. If unspecified, the query will return 1 MB of data.

", "location": "querystring", "locationName": "MaxResults" }, "NextToken": { "shape": "string", "documentation": "

An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

", "location": "querystring", "locationName": "NextToken" } } }, "ListReportJobsOutput": { "type": "structure", "members": { "ReportJobs": { "shape": "ReportJobList", "documentation": "

Details about your report jobs in JSON format.

" }, "NextToken": { "shape": "string", "documentation": "

An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

" } } }, "ListReportPlansInput": { "type": "structure", "members": { "MaxResults": { "shape": "MaxResults", "documentation": "

The number of desired results from 1 to 1000. Optional. If unspecified, the query will return 1 MB of data.

", "location": "querystring", "locationName": "MaxResults" }, "NextToken": { "shape": "string", "documentation": "

An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

", "location": "querystring", "locationName": "NextToken" } } }, "ListReportPlansOutput": { "type": "structure", "members": { "ReportPlans": { "shape": "ReportPlanList", "documentation": "

A list of your report plans with detailed information for each plan. This information includes the Amazon Resource Name (ARN), report plan name, description, settings, delivery channel, deployment status, creation time, and last times the report plan attempted to and successfully ran.

" }, "NextToken": { "shape": "string", "documentation": "

An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

" } } }, "ListRestoreJobSummariesInput": { "type": "structure", "members": { "AccountId": { "shape": "AccountId", "documentation": "

Returns the job count for the specified account.

If the request is sent from a member account or an account not part of Amazon Web Services Organizations, jobs within requestor's account will be returned.

Root, admin, and delegated administrator accounts can use the value ANY to return job counts from every account in the organization.

AGGREGATE_ALL aggregates job counts from all accounts within the authenticated organization, then returns the sum.

", "location": "querystring", "locationName": "AccountId" }, "State": { "shape": "RestoreJobState", "documentation": "

This parameter returns the job count for jobs with the specified state.

The the value ANY returns count of all states.

AGGREGATE_ALL aggregates job counts for all states and returns the sum.

", "location": "querystring", "locationName": "State" }, "ResourceType": { "shape": "ResourceType", "documentation": "

Returns the job count for the specified resource type. Use request GetSupportedResourceTypes to obtain strings for supported resource types.

The the value ANY returns count of all resource types.

AGGREGATE_ALL aggregates job counts for all resource types and returns the sum.

The type of Amazon Web Services resource to be backed up; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.

", "location": "querystring", "locationName": "ResourceType" }, "AggregationPeriod": { "shape": "AggregationPeriod", "documentation": "

This is the period that sets the boundaries for returned results.

Acceptable values include

", "location": "querystring", "locationName": "AggregationPeriod" }, "MaxResults": { "shape": "MaxResults", "documentation": "

This parameter sets the maximum number of items to be returned.

The value is an integer. Range of accepted values is from 1 to 500.

", "location": "querystring", "locationName": "MaxResults" }, "NextToken": { "shape": "string", "documentation": "

The next item following a partial list of returned resources. For example, if a request is made to return MaxResults number of resources, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

", "location": "querystring", "locationName": "NextToken" } } }, "ListRestoreJobSummariesOutput": { "type": "structure", "members": { "RestoreJobSummaries": { "shape": "RestoreJobSummaryList", "documentation": "

This return contains a summary that contains Region, Account, State, ResourceType, MessageCategory, StartTime, EndTime, and Count of included jobs.

" }, "AggregationPeriod": { "shape": "string", "documentation": "

This is the period that sets the boundaries for returned results.

" }, "NextToken": { "shape": "string", "documentation": "

The next item following a partial list of returned resources. For example, if a request is made to return MaxResults number of resources, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

" } } }, "ListRestoreJobsByProtectedResourceInput": { "type": "structure", "required": [ "ResourceArn" ], "members": { "ResourceArn": { "shape": "ARN", "documentation": "

Returns only restore jobs that match the specified resource Amazon Resource Name (ARN).

", "location": "uri", "locationName": "resourceArn" }, "ByStatus": { "shape": "RestoreJobStatus", "documentation": "

Returns only restore jobs associated with the specified job status.

", "location": "querystring", "locationName": "status" }, "ByRecoveryPointCreationDateAfter": { "shape": "timestamp", "documentation": "

Returns only restore jobs of recovery points that were created after the specified date.

", "location": "querystring", "locationName": "recoveryPointCreationDateAfter" }, "ByRecoveryPointCreationDateBefore": { "shape": "timestamp", "documentation": "

Returns only restore jobs of recovery points that were created before the specified date.

", "location": "querystring", "locationName": "recoveryPointCreationDateBefore" }, "NextToken": { "shape": "string", "documentation": "

The next item following a partial list of returned items. For example, if a request ismade to return MaxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

", "location": "querystring", "locationName": "nextToken" }, "MaxResults": { "shape": "MaxResults", "documentation": "

The maximum number of items to be returned.

", "location": "querystring", "locationName": "maxResults" } } }, "ListRestoreJobsByProtectedResourceOutput": { "type": "structure", "members": { "RestoreJobs": { "shape": "RestoreJobsList", "documentation": "

An array of objects that contain detailed information about jobs to restore saved resources.>

" }, "NextToken": { "shape": "string", "documentation": "

The next item following a partial list of returned items. For example, if a request is made to return MaxResults number of items, NextToken allows youto return more items in your list starting at the location pointed to by the next token

" } } }, "ListRestoreJobsInput": { "type": "structure", "members": { "NextToken": { "shape": "string", "documentation": "

The next item following a partial list of returned items. For example, if a request is made to return MaxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

", "location": "querystring", "locationName": "nextToken" }, "MaxResults": { "shape": "MaxResults", "documentation": "

The maximum number of items to be returned.

", "location": "querystring", "locationName": "maxResults" }, "ByAccountId": { "shape": "AccountId", "documentation": "

The account ID to list the jobs from. Returns only restore jobs associated with the specified account ID.

", "location": "querystring", "locationName": "accountId" }, "ByResourceType": { "shape": "ResourceType", "documentation": "

Include this parameter to return only restore jobs for the specified resources:

", "location": "querystring", "locationName": "resourceType" }, "ByCreatedBefore": { "shape": "timestamp", "documentation": "

Returns only restore jobs that were created before the specified date.

", "location": "querystring", "locationName": "createdBefore" }, "ByCreatedAfter": { "shape": "timestamp", "documentation": "

Returns only restore jobs that were created after the specified date.

", "location": "querystring", "locationName": "createdAfter" }, "ByStatus": { "shape": "RestoreJobStatus", "documentation": "

Returns only restore jobs associated with the specified job status.

", "location": "querystring", "locationName": "status" }, "ByCompleteBefore": { "shape": "timestamp", "documentation": "

Returns only copy jobs completed before a date expressed in Unix format and Coordinated Universal Time (UTC).

", "location": "querystring", "locationName": "completeBefore" }, "ByCompleteAfter": { "shape": "timestamp", "documentation": "

Returns only copy jobs completed after a date expressed in Unix format and Coordinated Universal Time (UTC).

", "location": "querystring", "locationName": "completeAfter" }, "ByRestoreTestingPlanArn": { "shape": "ARN", "documentation": "

This returns only restore testing jobs that match the specified resource Amazon Resource Name (ARN).

", "location": "querystring", "locationName": "restoreTestingPlanArn" } } }, "ListRestoreJobsOutput": { "type": "structure", "members": { "RestoreJobs": { "shape": "RestoreJobsList", "documentation": "

An array of objects that contain detailed information about jobs to restore saved resources.

" }, "NextToken": { "shape": "string", "documentation": "

The next item following a partial list of returned items. For example, if a request is made to return MaxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

" } } }, "ListRestoreTestingPlansInput": { "type": "structure", "members": { "MaxResults": { "shape": "ListRestoreTestingPlansInputMaxResultsInteger", "documentation": "

The maximum number of items to be returned.

", "location": "querystring", "locationName": "MaxResults" }, "NextToken": { "shape": "String", "documentation": "

The next item following a partial list of returned items. For example, if a request is made to return MaxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the nexttoken.

", "location": "querystring", "locationName": "NextToken" } } }, "ListRestoreTestingPlansInputMaxResultsInteger": { "type": "integer", "box": true, "max": 1000, "min": 1 }, "ListRestoreTestingPlansOutput": { "type": "structure", "required": [ "RestoreTestingPlans" ], "members": { "NextToken": { "shape": "String", "documentation": "

The next item following a partial list of returned items. For example, if a request is made to return MaxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the nexttoken.

" }, "RestoreTestingPlans": { "shape": "RestoreTestingPlans", "documentation": "

This is a returned list of restore testing plans.

" } } }, "ListRestoreTestingSelectionsInput": { "type": "structure", "required": [ "RestoreTestingPlanName" ], "members": { "MaxResults": { "shape": "ListRestoreTestingSelectionsInputMaxResultsInteger", "documentation": "

The maximum number of items to be returned.

", "location": "querystring", "locationName": "MaxResults" }, "NextToken": { "shape": "String", "documentation": "

The next item following a partial list of returned items. For example, if a request is made to return MaxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the nexttoken.

", "location": "querystring", "locationName": "NextToken" }, "RestoreTestingPlanName": { "shape": "String", "documentation": "

Returns restore testing selections by the specified restore testing plan name.

", "location": "uri", "locationName": "RestoreTestingPlanName" } } }, "ListRestoreTestingSelectionsInputMaxResultsInteger": { "type": "integer", "box": true, "max": 1000, "min": 1 }, "ListRestoreTestingSelectionsOutput": { "type": "structure", "required": [ "RestoreTestingSelections" ], "members": { "NextToken": { "shape": "String", "documentation": "

The next item following a partial list of returned items. For example, if a request is made to return MaxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the nexttoken.

" }, "RestoreTestingSelections": { "shape": "RestoreTestingSelections", "documentation": "

The returned restore testing selections associated with the restore testing plan.

" } } }, "ListTagsInput": { "type": "structure", "required": [ "ResourceArn" ], "members": { "ResourceArn": { "shape": "ARN", "documentation": "

An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the type of resource. Valid targets for ListTags are recovery points, backup plans, and backup vaults.

", "location": "uri", "locationName": "resourceArn" }, "NextToken": { "shape": "string", "documentation": "

The next item following a partial list of returned items. For example, if a request is made to return MaxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

", "location": "querystring", "locationName": "nextToken" }, "MaxResults": { "shape": "MaxResults", "documentation": "

The maximum number of items to be returned.

", "location": "querystring", "locationName": "maxResults" } } }, "ListTagsOutput": { "type": "structure", "members": { "NextToken": { "shape": "string", "documentation": "

The next item following a partial list of returned items. For example, if a request is made to return MaxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

" }, "Tags": { "shape": "Tags", "documentation": "

To help organize your resources, you can assign your own metadata to the resources you create. Each tag is a key-value pair.

" } } }, "Long": { "type": "long" }, "MaxFrameworkInputs": { "type": "integer", "max": 1000, "min": 1 }, "MaxResults": { "type": "integer", "max": 1000, "min": 1 }, "MessageCategory": { "type": "string" }, "Metadata": { "type": "map", "key": { "shape": "MetadataKey" }, "value": { "shape": "MetadataValue" }, "sensitive": true }, "MetadataKey": { "type": "string" }, "MetadataValue": { "type": "string" }, "ParameterName": { "type": "string" }, "ParameterValue": { "type": "string" }, "ProtectedResource": { "type": "structure", "members": { "ResourceArn": { "shape": "ARN", "documentation": "

An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.

" }, "ResourceType": { "shape": "ResourceType", "documentation": "

The type of Amazon Web Services resource; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database. For Windows Volume Shadow Copy Service (VSS) backups, the only supported resource type is Amazon EC2.

" }, "LastBackupTime": { "shape": "timestamp", "documentation": "

The date and time a resource was last backed up, in Unix format and Coordinated Universal Time (UTC). The value of LastBackupTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

" }, "ResourceName": { "shape": "string", "documentation": "

This is the non-unique name of the resource that belongs to the specified backup.

" }, "LastBackupVaultArn": { "shape": "ARN", "documentation": "

This is the ARN (Amazon Resource Name) of the backup vault that contains the most recent backup recovery point.

" }, "LastRecoveryPointArn": { "shape": "ARN", "documentation": "

This is the ARN (Amazon Resource Name) of the most recent recovery point.

" } }, "documentation": "

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

" }, "ProtectedResourceConditions": { "type": "structure", "members": { "StringEquals": { "shape": "KeyValueList", "documentation": "

Filters the values of your tagged resources for only those resources that you tagged with the same value. Also called \"exact matching.\"

" }, "StringNotEquals": { "shape": "KeyValueList", "documentation": "

Filters the values of your tagged resources for only those resources that you tagged that do not have the same value. Also called \"negated matching.\"

" } }, "documentation": "

A list of conditions that you define for resources in your restore testing plan using tags.

For example, \"StringEquals\": { \"Key\": \"aws:ResourceTag/CreatedByCryo\", \"Value\": \"true\" },. Condition operators are case sensitive.

" }, "ProtectedResourcesList": { "type": "list", "member": { "shape": "ProtectedResource" } }, "PutBackupVaultAccessPolicyInput": { "type": "structure", "required": [ "BackupVaultName" ], "members": { "BackupVaultName": { "shape": "BackupVaultName", "documentation": "

The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.

", "location": "uri", "locationName": "backupVaultName" }, "Policy": { "shape": "IAMPolicy", "documentation": "

The backup vault access policy document in JSON format.

" } } }, "PutBackupVaultLockConfigurationInput": { "type": "structure", "required": [ "BackupVaultName" ], "members": { "BackupVaultName": { "shape": "BackupVaultName", "documentation": "

The Backup Vault Lock configuration that specifies the name of the backup vault it protects.

", "location": "uri", "locationName": "backupVaultName" }, "MinRetentionDays": { "shape": "Long", "documentation": "

The Backup Vault Lock configuration that specifies the minimum retention period that the vault retains its recovery points. This setting can be useful if, for example, your organization's policies require you to retain certain data for at least seven years (2555 days).

If this parameter is not specified, Vault Lock will not enforce a minimum retention period.

If this parameter is specified, any backup or copy job to the vault must have a lifecycle policy with a retention period equal to or longer than the minimum retention period. If the job's retention period is shorter than that minimum retention period, then the vault fails that backup or copy job, and you should either modify your lifecycle settings or use a different vault. The shortest minimum retention period you can specify is 1 day. Recovery points already saved in the vault prior to Vault Lock are not affected.

" }, "MaxRetentionDays": { "shape": "Long", "documentation": "

The Backup Vault Lock configuration that specifies the maximum retention period that the vault retains its recovery points. This setting can be useful if, for example, your organization's policies require you to destroy certain data after retaining it for four years (1460 days).

If this parameter is not included, Vault Lock does not enforce a maximum retention period on the recovery points in the vault. If this parameter is included without a value, Vault Lock will not enforce a maximum retention period.

If this parameter is specified, any backup or copy job to the vault must have a lifecycle policy with a retention period equal to or shorter than the maximum retention period. If the job's retention period is longer than that maximum retention period, then the vault fails the backup or copy job, and you should either modify your lifecycle settings or use a different vault. The longest maximum retention period you can specify is 36500 days (approximately 100 years). Recovery points already saved in the vault prior to Vault Lock are not affected.

" }, "ChangeableForDays": { "shape": "Long", "documentation": "

The Backup Vault Lock configuration that specifies the number of days before the lock date. For example, setting ChangeableForDays to 30 on Jan. 1, 2022 at 8pm UTC will set the lock date to Jan. 31, 2022 at 8pm UTC.

Backup enforces a 72-hour cooling-off period before Vault Lock takes effect and becomes immutable. Therefore, you must set ChangeableForDays to 3 or greater.

Before the lock date, you can delete Vault Lock from the vault using DeleteBackupVaultLockConfiguration or change the Vault Lock configuration using PutBackupVaultLockConfiguration. On and after the lock date, the Vault Lock becomes immutable and cannot be changed or deleted.

If this parameter is not specified, you can delete Vault Lock from the vault using DeleteBackupVaultLockConfiguration or change the Vault Lock configuration using PutBackupVaultLockConfiguration at any time.

" } } }, "PutBackupVaultNotificationsInput": { "type": "structure", "required": [ "BackupVaultName", "SNSTopicArn", "BackupVaultEvents" ], "members": { "BackupVaultName": { "shape": "BackupVaultName", "documentation": "

The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.

", "location": "uri", "locationName": "backupVaultName" }, "SNSTopicArn": { "shape": "ARN", "documentation": "

The Amazon Resource Name (ARN) that specifies the topic for a backup vault’s events; for example, arn:aws:sns:us-west-2:111122223333:MyVaultTopic.

" }, "BackupVaultEvents": { "shape": "BackupVaultEvents", "documentation": "

An array of events that indicate the status of jobs to back up resources to the backup vault.

For common use cases and code samples, see Using Amazon SNS to track Backup events.

The following events are supported:

The list below shows items that are deprecated events (for reference) and are no longer in use. They are no longer supported and will not return statuses or notifications. Refer to the list above for current supported events.

" } } }, "PutRestoreValidationResultInput": { "type": "structure", "required": [ "RestoreJobId", "ValidationStatus" ], "members": { "RestoreJobId": { "shape": "RestoreJobId", "documentation": "

This is a unique identifier of a restore job within Backup.

", "location": "uri", "locationName": "restoreJobId" }, "ValidationStatus": { "shape": "RestoreValidationStatus", "documentation": "

This is the status of your restore validation.

" }, "ValidationStatusMessage": { "shape": "string", "documentation": "

This is an optional message string you can input to describe the validation status for the restore test validation.

" } } }, "RecoveryPointByBackupVault": { "type": "structure", "members": { "RecoveryPointArn": { "shape": "ARN", "documentation": "

An Amazon Resource Name (ARN) that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

" }, "BackupVaultName": { "shape": "BackupVaultName", "documentation": "

The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.

" }, "BackupVaultArn": { "shape": "ARN", "documentation": "

An ARN that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.

" }, "SourceBackupVaultArn": { "shape": "ARN", "documentation": "

The backup vault where the recovery point was originally copied from. If the recovery point is restored to the same account this value will be null.

" }, "ResourceArn": { "shape": "ARN", "documentation": "

An ARN that uniquely identifies a resource. The format of the ARN depends on the resource type.

" }, "ResourceType": { "shape": "ResourceType", "documentation": "

The type of Amazon Web Services resource saved as a recovery point; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database. For Windows Volume Shadow Copy Service (VSS) backups, the only supported resource type is Amazon EC2.

" }, "CreatedBy": { "shape": "RecoveryPointCreator", "documentation": "

Contains identifying information about the creation of a recovery point, including the BackupPlanArn, BackupPlanId, BackupPlanVersion, and BackupRuleId of the backup plan that is used to create it.

" }, "IamRoleArn": { "shape": "IAMRoleArn", "documentation": "

Specifies the IAM role ARN used to create the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access.

" }, "Status": { "shape": "RecoveryPointStatus", "documentation": "

A status code specifying the state of the recovery point.

" }, "StatusMessage": { "shape": "string", "documentation": "

A message explaining the reason of the recovery point deletion failure.

" }, "CreationDate": { "shape": "timestamp", "documentation": "

The date and time a recovery point is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

" }, "CompletionDate": { "shape": "timestamp", "documentation": "

The date and time a job to restore a recovery point is completed, in Unix format and Coordinated Universal Time (UTC). The value of CompletionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

" }, "BackupSizeInBytes": { "shape": "Long", "documentation": "

The size, in bytes, of a backup.

" }, "CalculatedLifecycle": { "shape": "CalculatedLifecycle", "documentation": "

A CalculatedLifecycle object containing DeleteAt and MoveToColdStorageAt timestamps.

" }, "Lifecycle": { "shape": "Lifecycle", "documentation": "

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 are able to be transitioned to cold storage are listed in the \"Lifecycle to cold storage\" section of the Feature availability by resource table. Backup ignores this expression for other resource types.

" }, "EncryptionKeyArn": { "shape": "ARN", "documentation": "

The server-side encryption key that is used to protect your backups; for example, arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab.

" }, "IsEncrypted": { "shape": "boolean", "documentation": "

A Boolean value that is returned as TRUE if the specified recovery point is encrypted, or FALSE if the recovery point is not encrypted.

" }, "LastRestoreTime": { "shape": "timestamp", "documentation": "

The date and time a recovery point was last restored, in Unix format and Coordinated Universal Time (UTC). The value of LastRestoreTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

" }, "ParentRecoveryPointArn": { "shape": "ARN", "documentation": "

This is the Amazon Resource Name (ARN) of the parent (composite) recovery point.

" }, "CompositeMemberIdentifier": { "shape": "string", "documentation": "

This is the identifier of a resource within a composite group, such as nested (child) recovery point belonging to a composite (parent) stack. The ID is transferred from the logical ID within a stack.

" }, "IsParent": { "shape": "boolean", "documentation": "

This is a boolean value indicating this is a parent (composite) recovery point.

" }, "ResourceName": { "shape": "string", "documentation": "

This is the non-unique name of the resource that belongs to the specified backup.

" }, "VaultType": { "shape": "VaultType", "documentation": "

This is the type of vault in which the described recovery point is stored.

" } }, "documentation": "

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

" }, "RecoveryPointByBackupVaultList": { "type": "list", "member": { "shape": "RecoveryPointByBackupVault" } }, "RecoveryPointByResource": { "type": "structure", "members": { "RecoveryPointArn": { "shape": "ARN", "documentation": "

An Amazon Resource Name (ARN) that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

" }, "CreationDate": { "shape": "timestamp", "documentation": "

The date and time a recovery point is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

" }, "Status": { "shape": "RecoveryPointStatus", "documentation": "

A status code specifying the state of the recovery point.

" }, "StatusMessage": { "shape": "string", "documentation": "

A message explaining the reason of the recovery point deletion failure.

" }, "EncryptionKeyArn": { "shape": "ARN", "documentation": "

The server-side encryption key that is used to protect your backups; for example, arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab.

" }, "BackupSizeBytes": { "shape": "Long", "documentation": "

The size, in bytes, of a backup.

" }, "BackupVaultName": { "shape": "BackupVaultName", "documentation": "

The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.

" }, "IsParent": { "shape": "boolean", "documentation": "

This is a boolean value indicating this is a parent (composite) recovery point.

" }, "ParentRecoveryPointArn": { "shape": "ARN", "documentation": "

This is the Amazon Resource Name (ARN) of the parent (composite) recovery point.

" }, "ResourceName": { "shape": "string", "documentation": "

This is the non-unique name of the resource that belongs to the specified backup.

" }, "VaultType": { "shape": "VaultType", "documentation": "

This is the type of vault in which the described recovery point is stored.

" } }, "documentation": "

Contains detailed information about a saved recovery point.

" }, "RecoveryPointByResourceList": { "type": "list", "member": { "shape": "RecoveryPointByResource" } }, "RecoveryPointCreator": { "type": "structure", "members": { "BackupPlanId": { "shape": "string", "documentation": "

Uniquely identifies a backup plan.

" }, "BackupPlanArn": { "shape": "ARN", "documentation": "

An Amazon Resource Name (ARN) that uniquely identifies a backup plan; for example, arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50.

" }, "BackupPlanVersion": { "shape": "string", "documentation": "

Version IDs are unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes long. They cannot be edited.

" }, "BackupRuleId": { "shape": "string", "documentation": "

Uniquely identifies a rule used to schedule the backup of a selection of resources.

" } }, "documentation": "

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

" }, "RecoveryPointMember": { "type": "structure", "members": { "RecoveryPointArn": { "shape": "ARN", "documentation": "

This is the Amazon Resource Name (ARN) of the parent (composite) recovery point.

" }, "ResourceArn": { "shape": "ARN", "documentation": "

This is the Amazon Resource Name (ARN) that uniquely identifies a saved resource.

" }, "ResourceType": { "shape": "ResourceType", "documentation": "

This is the Amazon Web Services resource type that is saved as a recovery point.

" }, "BackupVaultName": { "shape": "BackupVaultName", "documentation": "

This is the name of the backup vault (the logical container in which backups are stored).

" } }, "documentation": "

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.

" }, "RecoveryPointSelection": { "type": "structure", "members": { "VaultNames": { "shape": "VaultNames", "documentation": "

These are the names of the vaults in which the selected recovery points are contained.

" }, "ResourceIdentifiers": { "shape": "ResourceIdentifiers", "documentation": "

These are the resources included in the resource selection (including type of resources and vaults).

" }, "DateRange": { "shape": "DateRange" } }, "documentation": "

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

" }, "RecoveryPointStatus": { "type": "string", "enum": [ "COMPLETED", "PARTIAL", "DELETING", "EXPIRED" ] }, "RecoveryPointsList": { "type": "list", "member": { "shape": "RecoveryPointMember" } }, "Region": { "type": "string" }, "ReportDeliveryChannel": { "type": "structure", "required": [ "S3BucketName" ], "members": { "S3BucketName": { "shape": "string", "documentation": "

The unique name of the S3 bucket that receives your reports.

" }, "S3KeyPrefix": { "shape": "string", "documentation": "

The prefix for where Backup Audit Manager delivers your reports to Amazon S3. The prefix is this part of the following path: s3://your-bucket-name/prefix/Backup/us-west-2/year/month/day/report-name. If not specified, there is no prefix.

" }, "Formats": { "shape": "FormatList", "documentation": "

A list of the format of your reports: CSV, JSON, or both. If not specified, the default format is CSV.

" } }, "documentation": "

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.

" }, "ReportDestination": { "type": "structure", "members": { "S3BucketName": { "shape": "string", "documentation": "

The unique name of the Amazon S3 bucket that receives your reports.

" }, "S3Keys": { "shape": "stringList", "documentation": "

The object key that uniquely identifies your reports in your S3 bucket.

" } }, "documentation": "

Contains information from your report job about your report destination.

" }, "ReportJob": { "type": "structure", "members": { "ReportJobId": { "shape": "ReportJobId", "documentation": "

The identifier for a report job. A unique, randomly generated, Unicode, UTF-8 encoded string that is at most 1,024 bytes long. Report job IDs cannot be edited.

" }, "ReportPlanArn": { "shape": "ARN", "documentation": "

An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.

" }, "ReportTemplate": { "shape": "string", "documentation": "

Identifies the report template for the report. Reports are built using a report template. The report templates are:

RESOURCE_COMPLIANCE_REPORT | CONTROL_COMPLIANCE_REPORT | BACKUP_JOB_REPORT | COPY_JOB_REPORT | RESTORE_JOB_REPORT

" }, "CreationTime": { "shape": "timestamp", "documentation": "

The date and time that a report job is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

" }, "CompletionTime": { "shape": "timestamp", "documentation": "

The date and time that a report job is completed, in Unix format and Coordinated Universal Time (UTC). The value of CompletionTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

" }, "Status": { "shape": "string", "documentation": "

The status of a report job. The statuses are:

CREATED | RUNNING | COMPLETED | FAILED

COMPLETED means that the report is available for your review at your designated destination. If the status is FAILED, review the StatusMessage for the reason.

" }, "StatusMessage": { "shape": "string", "documentation": "

A message explaining the status of the report job.

" }, "ReportDestination": { "shape": "ReportDestination", "documentation": "

The S3 bucket name and S3 keys for the destination where the report job publishes the report.

" } }, "documentation": "

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

" }, "ReportJobId": { "type": "string" }, "ReportJobList": { "type": "list", "member": { "shape": "ReportJob" } }, "ReportPlan": { "type": "structure", "members": { "ReportPlanArn": { "shape": "ARN", "documentation": "

An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.

" }, "ReportPlanName": { "shape": "ReportPlanName", "documentation": "

The unique name of the report plan. This name is between 1 and 256 characters starting with a letter, and consisting of letters (a-z, A-Z), numbers (0-9), and underscores (_).

" }, "ReportPlanDescription": { "shape": "ReportPlanDescription", "documentation": "

An optional description of the report plan with a maximum 1,024 characters.

" }, "ReportSetting": { "shape": "ReportSetting", "documentation": "

Identifies the report template for the report. Reports are built using a report template. The report templates are:

RESOURCE_COMPLIANCE_REPORT | CONTROL_COMPLIANCE_REPORT | BACKUP_JOB_REPORT | COPY_JOB_REPORT | RESTORE_JOB_REPORT

If the report template is RESOURCE_COMPLIANCE_REPORT or CONTROL_COMPLIANCE_REPORT, this API resource also describes the report coverage by Amazon Web Services Regions and frameworks.

" }, "ReportDeliveryChannel": { "shape": "ReportDeliveryChannel", "documentation": "

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

" }, "DeploymentStatus": { "shape": "string", "documentation": "

The deployment status of a report plan. The statuses are:

CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | COMPLETED

" }, "CreationTime": { "shape": "timestamp", "documentation": "

The date and time that a report plan is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

" }, "LastAttemptedExecutionTime": { "shape": "timestamp", "documentation": "

The date and time that a report job associated with this report plan last attempted to run, in Unix format and Coordinated Universal Time (UTC). The value of LastAttemptedExecutionTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

" }, "LastSuccessfulExecutionTime": { "shape": "timestamp", "documentation": "

The date and time that a report job associated with this report plan last successfully ran, in Unix format and Coordinated Universal Time (UTC). The value of LastSuccessfulExecutionTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

" } }, "documentation": "

Contains detailed information about a report plan.

" }, "ReportPlanDescription": { "type": "string", "max": 1024, "min": 0, "pattern": ".*\\S.*" }, "ReportPlanList": { "type": "list", "member": { "shape": "ReportPlan" } }, "ReportPlanName": { "type": "string", "max": 256, "min": 1, "pattern": "[a-zA-Z][_a-zA-Z0-9]*" }, "ReportSetting": { "type": "structure", "required": [ "ReportTemplate" ], "members": { "ReportTemplate": { "shape": "string", "documentation": "

Identifies the report template for the report. Reports are built using a report template. The report templates are:

RESOURCE_COMPLIANCE_REPORT | CONTROL_COMPLIANCE_REPORT | BACKUP_JOB_REPORT | COPY_JOB_REPORT | RESTORE_JOB_REPORT

" }, "FrameworkArns": { "shape": "stringList", "documentation": "

The Amazon Resource Names (ARNs) of the frameworks a report covers.

" }, "NumberOfFrameworks": { "shape": "integer", "documentation": "

The number of frameworks a report covers.

" }, "Accounts": { "shape": "stringList", "documentation": "

These are the accounts to be included in the report.

" }, "OrganizationUnits": { "shape": "stringList", "documentation": "

These are the Organizational Units to be included in the report.

" }, "Regions": { "shape": "stringList", "documentation": "

These are the Regions to be included in the report.

" } }, "documentation": "

Contains detailed information about a report setting.

" }, "ResourceArns": { "type": "list", "member": { "shape": "ARN" } }, "ResourceIdentifiers": { "type": "list", "member": { "shape": "string" } }, "ResourceType": { "type": "string", "pattern": "^[a-zA-Z0-9\\-\\_\\.]{1,50}$" }, "ResourceTypeList": { "type": "list", "member": { "shape": "ARN" } }, "ResourceTypeManagementPreference": { "type": "map", "key": { "shape": "ResourceType" }, "value": { "shape": "IsEnabled" } }, "ResourceTypeOptInPreference": { "type": "map", "key": { "shape": "ResourceType" }, "value": { "shape": "IsEnabled" } }, "ResourceTypes": { "type": "list", "member": { "shape": "ResourceType" } }, "RestoreDeletionStatus": { "type": "string", "enum": [ "DELETING", "FAILED", "SUCCESSFUL" ] }, "RestoreJobCreator": { "type": "structure", "members": { "RestoreTestingPlanArn": { "shape": "ARN", "documentation": "

An Amazon Resource Name (ARN) that uniquely identifies a restore testing plan.

" } }, "documentation": "

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

" }, "RestoreJobId": { "type": "string" }, "RestoreJobState": { "type": "string", "enum": [ "CREATED", "PENDING", "RUNNING", "ABORTED", "COMPLETED", "FAILED", "AGGREGATE_ALL", "ANY" ] }, "RestoreJobStatus": { "type": "string", "enum": [ "PENDING", "RUNNING", "COMPLETED", "ABORTED", "FAILED" ] }, "RestoreJobSummary": { "type": "structure", "members": { "Region": { "shape": "Region", "documentation": "

The Amazon Web Services Regions within the job summary.

" }, "AccountId": { "shape": "AccountId", "documentation": "

The account ID that owns the jobs within the summary.

" }, "State": { "shape": "RestoreJobState", "documentation": "

This value is job count for jobs with the specified state.

" }, "ResourceType": { "shape": "ResourceType", "documentation": "

This value is the job count for the specified resource type. The request GetSupportedResourceTypes returns strings for supported resource types.

" }, "Count": { "shape": "integer", "documentation": "

The value as a number of jobs in a job summary.

" }, "StartTime": { "shape": "timestamp", "documentation": "

The value of time in number format of a job start time.

This value is the time in Unix format, Coordinated Universal Time (UTC), and accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

" }, "EndTime": { "shape": "timestamp", "documentation": "

The value of time in number format of a job end time.

This value is the time in Unix format, Coordinated Universal Time (UTC), and accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

" } }, "documentation": "

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.

" }, "RestoreJobSummaryList": { "type": "list", "member": { "shape": "RestoreJobSummary" } }, "RestoreJobsList": { "type": "list", "member": { "shape": "RestoreJobsListMember" } }, "RestoreJobsListMember": { "type": "structure", "members": { "AccountId": { "shape": "AccountId", "documentation": "

The account ID that owns the restore job.

" }, "RestoreJobId": { "shape": "string", "documentation": "

Uniquely identifies the job that restores a recovery point.

" }, "RecoveryPointArn": { "shape": "ARN", "documentation": "

An ARN that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

" }, "CreationDate": { "shape": "timestamp", "documentation": "

The date and time a restore job is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

" }, "CompletionDate": { "shape": "timestamp", "documentation": "

The date and time a job to restore a recovery point is completed, in Unix format and Coordinated Universal Time (UTC). The value of CompletionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

" }, "Status": { "shape": "RestoreJobStatus", "documentation": "

A status code specifying the state of the job initiated by Backup to restore a recovery point.

" }, "StatusMessage": { "shape": "string", "documentation": "

A detailed message explaining the status of the job to restore a recovery point.

" }, "PercentDone": { "shape": "string", "documentation": "

Contains an estimated percentage complete of a job at the time the job status was queried.

" }, "BackupSizeInBytes": { "shape": "Long", "documentation": "

The size, in bytes, of the restored resource.

" }, "IamRoleArn": { "shape": "IAMRoleArn", "documentation": "

Specifies the IAM role ARN used to create the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access.

" }, "ExpectedCompletionTimeMinutes": { "shape": "Long", "documentation": "

The amount of time in minutes that a job restoring a recovery point is expected to take.

" }, "CreatedResourceArn": { "shape": "ARN", "documentation": "

An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.

" }, "ResourceType": { "shape": "ResourceType", "documentation": "

The resource type of the listed restore jobs; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database. For Windows Volume Shadow Copy Service (VSS) backups, the only supported resource type is Amazon EC2.

" }, "RecoveryPointCreationDate": { "shape": "timestamp", "documentation": "

The date on which a recovery point was created.

" }, "CreatedBy": { "shape": "RestoreJobCreator", "documentation": "

Contains identifying information about the creation of a restore job.

" }, "ValidationStatus": { "shape": "RestoreValidationStatus", "documentation": "

This is the status of validation run on the indicated restore job.

" }, "ValidationStatusMessage": { "shape": "string", "documentation": "

This describes the status of validation run on the indicated restore job.

" }, "DeletionStatus": { "shape": "RestoreDeletionStatus", "documentation": "

This notes the status of the data generated by the restore test. The status may be Deleting, Failed, or Successful.

" }, "DeletionStatusMessage": { "shape": "string", "documentation": "

This describes the restore job deletion status.

" } }, "documentation": "

Contains metadata about a restore job.

" }, "RestoreTestingPlanForCreate": { "type": "structure", "required": [ "RecoveryPointSelection", "RestoreTestingPlanName", "ScheduleExpression" ], "members": { "RecoveryPointSelection": { "shape": "RestoreTestingRecoveryPointSelection", "documentation": "

Required: Algorithm; Required: Recovery point types; IncludeVaults (one or more). Optional: SelectionWindowDays ('30' if not specified); ExcludeVaults (list of selectors), defaults to empty list if not listed.

" }, "RestoreTestingPlanName": { "shape": "String", "documentation": "

The RestoreTestingPlanName is a unique string that is the name of the restore testing plan. This cannot be changed after creation, and it must consist of only alphanumeric characters and underscores.

" }, "ScheduleExpression": { "shape": "String", "documentation": "

A CRON expression in specified timezone when a restore testing plan is executed.

" }, "ScheduleExpressionTimezone": { "shape": "String", "documentation": "

Optional. This is the timezone in which the schedule expression is set. By default, ScheduleExpressions are in UTC. You can modify this to a specified timezone.

" }, "StartWindowHours": { "shape": "integer", "documentation": "

Defaults to 24 hours.

A value in hours after a restore test is scheduled before a job will be canceled if it doesn't start successfully. This value is optional. If this value is included, this parameter has a maximum value of 168 hours (one week).

" } }, "documentation": "

This contains metadata about a restore testing plan.

" }, "RestoreTestingPlanForGet": { "type": "structure", "required": [ "CreationTime", "RecoveryPointSelection", "RestoreTestingPlanArn", "RestoreTestingPlanName", "ScheduleExpression" ], "members": { "CreationTime": { "shape": "Timestamp", "documentation": "

The date and time that a restore testing plan was created, in Unix format and Coordinated Universal Time (UTC). The value of CreationTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

" }, "CreatorRequestId": { "shape": "String", "documentation": "

This identifies the request and allows failed requests to be retried without the risk of running the operation twice. If the request includes a CreatorRequestId that matches an existing backup plan, that plan is returned. This parameter is optional.

If used, this parameter must contain 1 to 50 alphanumeric or '-_.' characters.

" }, "LastExecutionTime": { "shape": "Timestamp", "documentation": "

The last time a restore test was run with the specified restore testing plan. A date and time, in Unix format and Coordinated Universal Time (UTC). The value of LastExecutionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

" }, "LastUpdateTime": { "shape": "Timestamp", "documentation": "

The date and time that the restore testing plan was updated. This update is in Unix format and Coordinated Universal Time (UTC). The value of LastUpdateTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

" }, "RecoveryPointSelection": { "shape": "RestoreTestingRecoveryPointSelection", "documentation": "

The specified criteria to assign a set of resources, such as recovery point types or backup vaults.

" }, "RestoreTestingPlanArn": { "shape": "String", "documentation": "

An Amazon Resource Name (ARN) that uniquely identifies a restore testing plan.

" }, "RestoreTestingPlanName": { "shape": "String", "documentation": "

This is the restore testing plan name.

" }, "ScheduleExpression": { "shape": "String", "documentation": "

A CRON expression in specified timezone when a restore testing plan is executed.

" }, "ScheduleExpressionTimezone": { "shape": "String", "documentation": "

Optional. This is the timezone in which the schedule expression is set. By default, ScheduleExpressions are in UTC. You can modify this to a specified timezone.

" }, "StartWindowHours": { "shape": "integer", "documentation": "

Defaults to 24 hours.

A value in hours after a restore test is scheduled before a job will be canceled if it doesn't start successfully. This value is optional. If this value is included, this parameter has a maximum value of 168 hours (one week).

" } }, "documentation": "

This contains metadata about a restore testing plan.

" }, "RestoreTestingPlanForList": { "type": "structure", "required": [ "CreationTime", "RestoreTestingPlanArn", "RestoreTestingPlanName", "ScheduleExpression" ], "members": { "CreationTime": { "shape": "Timestamp", "documentation": "

The date and time that a restore testing plan was created, in Unix format and Coordinated Universal Time (UTC). The value of CreationTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

" }, "LastExecutionTime": { "shape": "Timestamp", "documentation": "

The last time a restore test was run with the specified restore testing plan. A date and time, in Unix format and Coordinated Universal Time (UTC). The value of LastExecutionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

" }, "LastUpdateTime": { "shape": "Timestamp", "documentation": "

The date and time that the restore testing plan was updated. This update is in Unix format and Coordinated Universal Time (UTC). The value of LastUpdateTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

" }, "RestoreTestingPlanArn": { "shape": "String", "documentation": "

An Amazon Resource Name (ARN) that uniquely identifiesa restore testing plan.

" }, "RestoreTestingPlanName": { "shape": "String", "documentation": "

This is the restore testing plan name.

" }, "ScheduleExpression": { "shape": "String", "documentation": "

A CRON expression in specified timezone when a restore testing plan is executed.

" }, "ScheduleExpressionTimezone": { "shape": "String", "documentation": "

Optional. This is the timezone in which the schedule expression is set. By default, ScheduleExpressions are in UTC. You can modify this to a specified timezone.

" }, "StartWindowHours": { "shape": "integer", "documentation": "

Defaults to 24 hours.

A value in hours after a restore test is scheduled before a job will be canceled if it doesn't start successfully. This value is optional. If this value is included, this parameter has a maximum value of 168 hours (one week).

" } }, "documentation": "

This contains metadata about a restore testing plan.

" }, "RestoreTestingPlanForUpdate": { "type": "structure", "members": { "RecoveryPointSelection": { "shape": "RestoreTestingRecoveryPointSelection", "documentation": "

Required: Algorithm; RecoveryPointTypes; IncludeVaults (one or more).

Optional: SelectionWindowDays ('30' if not specified); ExcludeVaults (defaults to empty list if not listed).

" }, "ScheduleExpression": { "shape": "String", "documentation": "

A CRON expression in specified timezone when a restore testing plan is executed.

" }, "ScheduleExpressionTimezone": { "shape": "String", "documentation": "

Optional. This is the timezone in which the schedule expression is set. By default, ScheduleExpressions are in UTC. You can modify this to a specified timezone.

" }, "StartWindowHours": { "shape": "integer", "documentation": "

Defaults to 24 hours.

A value in hours after a restore test is scheduled before a job will be canceled if it doesn't start successfully. This value is optional. If this value is included, this parameter has a maximum value of 168 hours (one week).

" } }, "documentation": "

This contains metadata about a restore testing plan.

" }, "RestoreTestingPlans": { "type": "list", "member": { "shape": "RestoreTestingPlanForList" } }, "RestoreTestingRecoveryPointSelection": { "type": "structure", "members": { "Algorithm": { "shape": "RestoreTestingRecoveryPointSelectionAlgorithm", "documentation": "

Acceptable values include \"LATEST_WITHIN_WINDOW\" or \"RANDOM_WITHIN_WINDOW\"

" }, "ExcludeVaults": { "shape": "stringList", "documentation": "

Accepted values include specific ARNs or list of selectors. Defaults to empty list if not listed.

" }, "IncludeVaults": { "shape": "stringList", "documentation": "

Accepted values include wildcard [\"*\"] or by specific ARNs or ARN wilcard replacement [\"arn:aws:backup:us-west-2:123456789012:backup-vault:asdf\", ...] [\"arn:aws:backup:*:*:backup-vault:asdf-*\", ...]

" }, "RecoveryPointTypes": { "shape": "RestoreTestingRecoveryPointTypeList", "documentation": "

These are the types of recovery points.

" }, "SelectionWindowDays": { "shape": "integer", "documentation": "

Accepted values are integers from 1 to 365.

" } }, "documentation": "

Required: Algorithm; Required: Recovery point types; IncludeVaults(one or more). Optional: SelectionWindowDays ('30' if not specified);ExcludeVaults (list of selectors), defaults to empty list if not listed.

" }, "RestoreTestingRecoveryPointSelectionAlgorithm": { "type": "string", "enum": [ "LATEST_WITHIN_WINDOW", "RANDOM_WITHIN_WINDOW" ] }, "RestoreTestingRecoveryPointType": { "type": "string", "enum": [ "CONTINUOUS", "SNAPSHOT" ] }, "RestoreTestingRecoveryPointTypeList": { "type": "list", "member": { "shape": "RestoreTestingRecoveryPointType" } }, "RestoreTestingSelectionForCreate": { "type": "structure", "required": [ "IamRoleArn", "ProtectedResourceType", "RestoreTestingSelectionName" ], "members": { "IamRoleArn": { "shape": "String", "documentation": "

The Amazon Resource Name (ARN) of the IAM role that Backup uses to create the target resource; for example: arn:aws:iam::123456789012:role/S3Access.

" }, "ProtectedResourceArns": { "shape": "stringList", "documentation": "

Each protected resource can be filtered by its specific ARNs, such as ProtectedResourceArns: [\"arn:aws:...\", \"arn:aws:...\"] or by a wildcard: ProtectedResourceArns: [\"*\"], but not both.

" }, "ProtectedResourceConditions": { "shape": "ProtectedResourceConditions", "documentation": "

If you have included the wildcard in ProtectedResourceArns, you can include resource conditions, such as ProtectedResourceConditions: { StringEquals: [{ key: \"XXXX\", value: \"YYYY\" }].

" }, "ProtectedResourceType": { "shape": "String", "documentation": "

The type of Amazon Web Services resource included in a restore testing selection; for example, an Amazon EBS volume or an Amazon RDS database.

Supported resource types accepted include:

" }, "RestoreMetadataOverrides": { "shape": "SensitiveStringMap", "documentation": "

You can override certain restore metadata keys by including the parameter RestoreMetadataOverrides in the body of RestoreTestingSelection. Key values are not case sensitive.

See the complete list of restore testing inferred metadata.

" }, "RestoreTestingSelectionName": { "shape": "String", "documentation": "

This is the unique name of the restore testing selection that belongs to the related restore testing plan.

" }, "ValidationWindowHours": { "shape": "integer", "documentation": "

This is amount of hours (1 to 168) available to run a validation script on the data. The data will be deleted upon the completion of the validation script or the end of the specified retention period, whichever comes first.

" } }, "documentation": "

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:

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.

" }, "RestoreTestingSelectionForGet": { "type": "structure", "required": [ "CreationTime", "IamRoleArn", "ProtectedResourceType", "RestoreTestingPlanName", "RestoreTestingSelectionName" ], "members": { "CreationTime": { "shape": "Timestamp", "documentation": "

The date and time that a restore testing selection was created, in Unix format and Coordinated Universal Time (UTC). The value of CreationTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 201812:11:30.087 AM.

" }, "CreatorRequestId": { "shape": "String", "documentation": "

This identifies the request and allows failed requests to be retried without the risk of running the operation twice. If the request includes a CreatorRequestId that matches an existing backup plan, that plan is returned. This parameter is optional.

If used, this parameter must contain 1 to 50 alphanumeric or '-_.' characters.

" }, "IamRoleArn": { "shape": "String", "documentation": "

The Amazon Resource Name (ARN) of the IAM role that Backup uses to create the target resource; for example:arn:aws:iam::123456789012:role/S3Access.

" }, "ProtectedResourceArns": { "shape": "stringList", "documentation": "

You can include specific ARNs, such as ProtectedResourceArns: [\"arn:aws:...\", \"arn:aws:...\"] or you can include a wildcard: ProtectedResourceArns: [\"*\"], but not both.

" }, "ProtectedResourceConditions": { "shape": "ProtectedResourceConditions", "documentation": "

In a resource testing selection, this parameter filters by specific conditions such as StringEquals or StringNotEquals.

" }, "ProtectedResourceType": { "shape": "String", "documentation": "

The type of Amazon Web Services resource included in a resource testing selection; for example, an Amazon EBS volume or an Amazon RDS database.

" }, "RestoreMetadataOverrides": { "shape": "SensitiveStringMap", "documentation": "

You can override certain restore metadata keys by including the parameter RestoreMetadataOverrides in the body of RestoreTestingSelection. Key values are not case sensitive.

See the complete list of restore testing inferred metadata.

" }, "RestoreTestingPlanName": { "shape": "String", "documentation": "

The RestoreTestingPlanName is a unique string that is the name of the restore testing plan.

" }, "RestoreTestingSelectionName": { "shape": "String", "documentation": "

This is the unique name of the restore testing selection that belongs to the related restore testing plan.

" }, "ValidationWindowHours": { "shape": "integer", "documentation": "

This is amount of hours (1 to 168) available to run a validation script on the data. The data will be deleted upon the completion of the validation script or the end of the specified retention period, whichever comes first.

" } }, "documentation": "

This contains metadata about a restore testing selection.

" }, "RestoreTestingSelectionForList": { "type": "structure", "required": [ "CreationTime", "IamRoleArn", "ProtectedResourceType", "RestoreTestingPlanName", "RestoreTestingSelectionName" ], "members": { "CreationTime": { "shape": "Timestamp", "documentation": "

This is the date and time that a restore testing selection was created, in Unix format and Coordinated Universal Time (UTC). The value of CreationTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26,2018 12:11:30.087 AM.

" }, "IamRoleArn": { "shape": "String", "documentation": "

The Amazon Resource Name (ARN) of the IAM role that Backup uses to create the target resource; for example: arn:aws:iam::123456789012:role/S3Access.

" }, "ProtectedResourceType": { "shape": "String", "documentation": "

The type of Amazon Web Services resource included in a restore testing selection; for example, an Amazon EBS volume or an Amazon RDS database.

" }, "RestoreTestingPlanName": { "shape": "String", "documentation": "

Unique string that is the name of the restore testing plan.

The name cannot be changed after creation. The name must consist of only alphanumeric characters and underscores. Maximum length is 50.

" }, "RestoreTestingSelectionName": { "shape": "String", "documentation": "

Unique name of a restore testing selection.

" }, "ValidationWindowHours": { "shape": "integer", "documentation": "

This value represents the time, in hours, data is retained after a restore test so that optional validation can be completed.

Accepted value is an integer between 0 and 168 (the hourly equivalent of seven days).

" } }, "documentation": "

This contains metadata about a restore testing selection.

" }, "RestoreTestingSelectionForUpdate": { "type": "structure", "members": { "IamRoleArn": { "shape": "String", "documentation": "

The Amazon Resource Name (ARN) of the IAM role that Backup uses to create the target resource; for example: arn:aws:iam::123456789012:role/S3Access.

" }, "ProtectedResourceArns": { "shape": "stringList", "documentation": "

You can include a list of specific ARNs, such as ProtectedResourceArns: [\"arn:aws:...\", \"arn:aws:...\"] or you can include a wildcard: ProtectedResourceArns: [\"*\"], but not both.

" }, "ProtectedResourceConditions": { "shape": "ProtectedResourceConditions", "documentation": "

A list of conditions that you define for resources in your restore testing plan using tags.

For example, \"StringEquals\": { \"Key\": \"aws:ResourceTag/CreatedByCryo\", \"Value\": \"true\" },. Condition operators are case sensitive.

" }, "RestoreMetadataOverrides": { "shape": "SensitiveStringMap", "documentation": "

You can override certain restore metadata keys by including the parameter RestoreMetadataOverrides in the body of RestoreTestingSelection. Key values are not case sensitive.

See the complete list of restore testing inferred metadata.

" }, "ValidationWindowHours": { "shape": "integer", "documentation": "

This value represents the time, in hours, data is retained after a restore test so that optional validation can be completed.

Accepted value is an integer between 0 and 168 (the hourly equivalent of seven days).

" } }, "documentation": "

This contains metadata about a restore testing selection.

" }, "RestoreTestingSelections": { "type": "list", "member": { "shape": "RestoreTestingSelectionForList" } }, "RestoreValidationStatus": { "type": "string", "enum": [ "FAILED", "SUCCESSFUL", "TIMED_OUT", "VALIDATING" ] }, "SensitiveStringMap": { "type": "map", "key": { "shape": "String" }, "value": { "shape": "String" }, "sensitive": true }, "StartBackupJobInput": { "type": "structure", "required": [ "BackupVaultName", "ResourceArn", "IamRoleArn" ], "members": { "BackupVaultName": { "shape": "BackupVaultName", "documentation": "

The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.

" }, "ResourceArn": { "shape": "ARN", "documentation": "

An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.

" }, "IamRoleArn": { "shape": "IAMRoleArn", "documentation": "

Specifies the IAM role ARN used to create the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access.

" }, "IdempotencyToken": { "shape": "string", "documentation": "

A customer-chosen string that you can use to distinguish between otherwise identical calls to StartBackupJob. Retrying a successful request with the same idempotency token results in a success message with no action taken.

" }, "StartWindowMinutes": { "shape": "WindowMinutes", "documentation": "

A value in minutes after a backup is scheduled before a job will be canceled if it doesn't start successfully. This value is optional, and the default is 8 hours. If this value is included, it must be at least 60 minutes to avoid errors.

This parameter has a maximum value of 100 years (52,560,000 minutes).

During the start window, the backup job status remains in CREATED status until it has successfully begun or until the start window time has run out. If within the start window time Backup receives an error that allows the job to be retried, Backup will automatically retry to begin the job at least every 10 minutes until the backup successfully begins (the job status changes to RUNNING) or until the job status changes to EXPIRED (which is expected to occur when the start window time is over).

" }, "CompleteWindowMinutes": { "shape": "WindowMinutes", "documentation": "

A value in minutes during which a successfully started backup must complete, or else Backup will cancel the job. This value is optional. This value begins counting down from when the backup was scheduled. It does not add additional time for StartWindowMinutes, or if the backup started later than scheduled.

Like StartWindowMinutes, this parameter has a maximum value of 100 years (52,560,000 minutes).

" }, "Lifecycle": { "shape": "Lifecycle", "documentation": "

The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. Backup will transition and expire 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 are able to be transitioned to cold storage are listed in the \"Lifecycle to cold storage\" section of the Feature availability by resource table. Backup ignores this expression for other resource types.

This parameter has a maximum value of 100 years (36,500 days).

" }, "RecoveryPointTags": { "shape": "Tags", "documentation": "

To help organize your resources, you can assign your own metadata to the resources that you create. Each tag is a key-value pair.

" }, "BackupOptions": { "shape": "BackupOptions", "documentation": "

Specifies the backup option for a selected resource. This option is only available for Windows Volume Shadow Copy Service (VSS) backup jobs.

Valid values: Set to \"WindowsVSS\":\"enabled\" to enable the WindowsVSS backup option and create a Windows VSS backup. Set to \"WindowsVSS\"\"disabled\" to create a regular backup. The WindowsVSS option is not enabled by default.

" } } }, "StartBackupJobOutput": { "type": "structure", "members": { "BackupJobId": { "shape": "string", "documentation": "

Uniquely identifies a request to Backup to back up a resource.

" }, "RecoveryPointArn": { "shape": "ARN", "documentation": "

Note: This field is only returned for Amazon EFS and Advanced DynamoDB resources.

An ARN that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

" }, "CreationDate": { "shape": "timestamp", "documentation": "

The date and time that a backup job is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

" }, "IsParent": { "shape": "boolean", "documentation": "

This is a returned boolean value indicating this is a parent (composite) backup job.

" } } }, "StartCopyJobInput": { "type": "structure", "required": [ "RecoveryPointArn", "SourceBackupVaultName", "DestinationBackupVaultArn", "IamRoleArn" ], "members": { "RecoveryPointArn": { "shape": "ARN", "documentation": "

An ARN that uniquely identifies a recovery point to use for the copy job; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

" }, "SourceBackupVaultName": { "shape": "BackupVaultName", "documentation": "

The name of a logical source container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.

" }, "DestinationBackupVaultArn": { "shape": "ARN", "documentation": "

An Amazon Resource Name (ARN) that uniquely identifies a destination backup vault to copy to; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.

" }, "IamRoleArn": { "shape": "IAMRoleArn", "documentation": "

Specifies the IAM role ARN used to copy the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access.

" }, "IdempotencyToken": { "shape": "string", "documentation": "

A customer-chosen string that you can use to distinguish between otherwise identical calls to StartCopyJob. Retrying a successful request with the same idempotency token results in a success message with no action taken.

" }, "Lifecycle": { "shape": "Lifecycle" } } }, "StartCopyJobOutput": { "type": "structure", "members": { "CopyJobId": { "shape": "string", "documentation": "

Uniquely identifies a copy job.

" }, "CreationDate": { "shape": "timestamp", "documentation": "

The date and time that a copy job is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

" }, "IsParent": { "shape": "boolean", "documentation": "

This is a returned boolean value indicating this is a parent (composite) copy job.

" } } }, "StartReportJobInput": { "type": "structure", "required": [ "ReportPlanName" ], "members": { "ReportPlanName": { "shape": "ReportPlanName", "documentation": "

The unique name of a report plan.

", "location": "uri", "locationName": "reportPlanName" }, "IdempotencyToken": { "shape": "string", "documentation": "

A customer-chosen string that you can use to distinguish between otherwise identical calls to StartReportJobInput. Retrying a successful request with the same idempotency token results in a success message with no action taken.

", "idempotencyToken": true } } }, "StartReportJobOutput": { "type": "structure", "members": { "ReportJobId": { "shape": "ReportJobId", "documentation": "

The identifier of the report job. A unique, randomly generated, Unicode, UTF-8 encoded string that is at most 1,024 bytes long. The report job ID cannot be edited.

" } } }, "StartRestoreJobInput": { "type": "structure", "required": [ "RecoveryPointArn", "Metadata" ], "members": { "RecoveryPointArn": { "shape": "ARN", "documentation": "

An ARN that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

" }, "Metadata": { "shape": "Metadata", "documentation": "

A set of metadata key-value pairs. Contains information, such as a resource name, required to restore a recovery point.

You can get configuration metadata about a resource at the time it was backed up by calling GetRecoveryPointRestoreMetadata. However, values in addition to those provided by GetRecoveryPointRestoreMetadata might be required to restore a resource. For example, you might need to provide a new resource name if the original already exists.

You need to specify specific metadata to restore an Amazon Elastic File System (Amazon EFS) instance:

" }, "IamRoleArn": { "shape": "IAMRoleArn", "documentation": "

The Amazon Resource Name (ARN) of the IAM role that Backup uses to create the target resource; for example: arn:aws:iam::123456789012:role/S3Access.

" }, "IdempotencyToken": { "shape": "string", "documentation": "

A customer-chosen string that you can use to distinguish between otherwise identical calls to StartRestoreJob. Retrying a successful request with the same idempotency token results in a success message with no action taken.

" }, "ResourceType": { "shape": "ResourceType", "documentation": "

Starts a job to restore a recovery point for one of the following resources:

" }, "CopySourceTagsToRestoredResource": { "shape": "boolean", "documentation": "

This is an optional parameter. If this equals True, tags included in the backup will be copied to the restored resource.

This can only be applied to backups created through Backup.

" } } }, "StartRestoreJobOutput": { "type": "structure", "members": { "RestoreJobId": { "shape": "RestoreJobId", "documentation": "

Uniquely identifies the job that restores a recovery point.

" } } }, "StopBackupJobInput": { "type": "structure", "required": [ "BackupJobId" ], "members": { "BackupJobId": { "shape": "string", "documentation": "

Uniquely identifies a request to Backup to back up a resource.

", "location": "uri", "locationName": "backupJobId" } } }, "StorageClass": { "type": "string", "enum": [ "WARM", "COLD", "DELETED" ] }, "String": { "type": "string" }, "TagKey": { "type": "string" }, "TagKeyList": { "type": "list", "member": { "shape": "string" }, "sensitive": true }, "TagResourceInput": { "type": "structure", "required": [ "ResourceArn", "Tags" ], "members": { "ResourceArn": { "shape": "ARN", "documentation": "

An ARN that uniquely identifies a resource. The format of the ARN depends on the type of the tagged resource.

", "location": "uri", "locationName": "resourceArn" }, "Tags": { "shape": "Tags", "documentation": "

Key-value pairs that are used to help organize your resources. You can assign your own metadata to the resources you create. For clarity, this is the structure to assign tags: [{\"Key\":\"string\",\"Value\":\"string\"}].

" } } }, "TagValue": { "type": "string" }, "Tags": { "type": "map", "key": { "shape": "TagKey" }, "value": { "shape": "TagValue" }, "sensitive": true }, "Timestamp": { "type": "timestamp" }, "Timezone": { "type": "string" }, "UntagResourceInput": { "type": "structure", "required": [ "ResourceArn", "TagKeyList" ], "members": { "ResourceArn": { "shape": "ARN", "documentation": "

An ARN that uniquely identifies a resource. The format of the ARN depends on the type of the tagged resource.

", "location": "uri", "locationName": "resourceArn" }, "TagKeyList": { "shape": "TagKeyList", "documentation": "

A list of keys to identify which key-value tags to remove from a resource.

" } } }, "UpdateBackupPlanInput": { "type": "structure", "required": [ "BackupPlanId", "BackupPlan" ], "members": { "BackupPlanId": { "shape": "string", "documentation": "

Uniquely identifies a backup plan.

", "location": "uri", "locationName": "backupPlanId" }, "BackupPlan": { "shape": "BackupPlanInput", "documentation": "

Specifies the body of a backup plan. Includes a BackupPlanName and one or more sets of Rules.

" } } }, "UpdateBackupPlanOutput": { "type": "structure", "members": { "BackupPlanId": { "shape": "string", "documentation": "

Uniquely identifies a backup plan.

" }, "BackupPlanArn": { "shape": "ARN", "documentation": "

An Amazon Resource Name (ARN) that uniquely identifies a backup plan; for example, arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50.

" }, "CreationDate": { "shape": "timestamp", "documentation": "

The date and time a backup plan is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

" }, "VersionId": { "shape": "string", "documentation": "

Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes long. Version Ids cannot be edited.

" }, "AdvancedBackupSettings": { "shape": "AdvancedBackupSettings", "documentation": "

Contains a list of BackupOptions for each resource type.

" } } }, "UpdateFrameworkInput": { "type": "structure", "required": [ "FrameworkName" ], "members": { "FrameworkName": { "shape": "FrameworkName", "documentation": "

The unique name of a framework. This name is between 1 and 256 characters, starting with a letter, and consisting of letters (a-z, A-Z), numbers (0-9), and underscores (_).

", "location": "uri", "locationName": "frameworkName" }, "FrameworkDescription": { "shape": "FrameworkDescription", "documentation": "

An optional description of the framework with a maximum 1,024 characters.

" }, "FrameworkControls": { "shape": "FrameworkControls", "documentation": "

A list of the controls that make up the framework. Each control in the list has a name, input parameters, and scope.

" }, "IdempotencyToken": { "shape": "string", "documentation": "

A customer-chosen string that you can use to distinguish between otherwise identical calls to UpdateFrameworkInput. Retrying a successful request with the same idempotency token results in a success message with no action taken.

", "idempotencyToken": true } } }, "UpdateFrameworkOutput": { "type": "structure", "members": { "FrameworkName": { "shape": "FrameworkName", "documentation": "

The unique name of a framework. This name is between 1 and 256 characters, starting with a letter, and consisting of letters (a-z, A-Z), numbers (0-9), and underscores (_).

" }, "FrameworkArn": { "shape": "ARN", "documentation": "

An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.

" }, "CreationTime": { "shape": "timestamp", "documentation": "

The date and time that a framework is created, in ISO 8601 representation. The value of CreationTime is accurate to milliseconds. For example, 2020-07-10T15:00:00.000-08:00 represents the 10th of July 2020 at 3:00 PM 8 hours behind UTC.

" } } }, "UpdateGlobalSettingsInput": { "type": "structure", "members": { "GlobalSettings": { "shape": "GlobalSettings", "documentation": "

A value for isCrossAccountBackupEnabled and a Region. Example: update-global-settings --global-settings isCrossAccountBackupEnabled=false --region us-west-2.

" } } }, "UpdateRecoveryPointLifecycleInput": { "type": "structure", "required": [ "BackupVaultName", "RecoveryPointArn" ], "members": { "BackupVaultName": { "shape": "BackupVaultName", "documentation": "

The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.

", "location": "uri", "locationName": "backupVaultName" }, "RecoveryPointArn": { "shape": "ARN", "documentation": "

An Amazon Resource Name (ARN) that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

", "location": "uri", "locationName": "recoveryPointArn" }, "Lifecycle": { "shape": "Lifecycle", "documentation": "

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.

" } } }, "UpdateRecoveryPointLifecycleOutput": { "type": "structure", "members": { "BackupVaultArn": { "shape": "ARN", "documentation": "

An ARN that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.

" }, "RecoveryPointArn": { "shape": "ARN", "documentation": "

An Amazon Resource Name (ARN) that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

" }, "Lifecycle": { "shape": "Lifecycle", "documentation": "

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 are able to be transitioned to cold storage are listed in the \"Lifecycle to cold storage\" section of the Feature availability by resource table. Backup ignores this expression for other resource types.

" }, "CalculatedLifecycle": { "shape": "CalculatedLifecycle", "documentation": "

A CalculatedLifecycle object containing DeleteAt and MoveToColdStorageAt timestamps.

" } } }, "UpdateRegionSettingsInput": { "type": "structure", "members": { "ResourceTypeOptInPreference": { "shape": "ResourceTypeOptInPreference", "documentation": "

Updates the list of services along with the opt-in preferences for the Region.

If resource assignments are only based on tags, then service opt-in settings are applied. If a resource type is explicitly assigned to a backup plan, such as Amazon S3, Amazon EC2, or Amazon RDS, it will be included in the backup even if the opt-in is not enabled for that particular service. If both a resource type and tags are specified in a resource assignment, the resource type specified in the backup plan takes priority over the tag condition. Service opt-in settings are disregarded in this situation.

" }, "ResourceTypeManagementPreference": { "shape": "ResourceTypeManagementPreference", "documentation": "

Enables or disables full Backup management of backups for a resource type. To enable full Backup management for DynamoDB along with Backup's advanced DynamoDB backup features, follow the procedure to enable advanced DynamoDB backup programmatically.

" } } }, "UpdateReportPlanInput": { "type": "structure", "required": [ "ReportPlanName" ], "members": { "ReportPlanName": { "shape": "ReportPlanName", "documentation": "

The unique name of the report plan. This name is between 1 and 256 characters, starting with a letter, and consisting of letters (a-z, A-Z), numbers (0-9), and underscores (_).

", "location": "uri", "locationName": "reportPlanName" }, "ReportPlanDescription": { "shape": "ReportPlanDescription", "documentation": "

An optional description of the report plan with a maximum 1,024 characters.

" }, "ReportDeliveryChannel": { "shape": "ReportDeliveryChannel", "documentation": "

A structure that contains information about where to deliver your reports, specifically your Amazon S3 bucket name, S3 key prefix, and the formats of your reports.

" }, "ReportSetting": { "shape": "ReportSetting", "documentation": "

Identifies the report template for the report. Reports are built using a report template. The report templates are:

RESOURCE_COMPLIANCE_REPORT | CONTROL_COMPLIANCE_REPORT | BACKUP_JOB_REPORT | COPY_JOB_REPORT | RESTORE_JOB_REPORT

If the report template is RESOURCE_COMPLIANCE_REPORT or CONTROL_COMPLIANCE_REPORT, this API resource also describes the report coverage by Amazon Web Services Regions and frameworks.

" }, "IdempotencyToken": { "shape": "string", "documentation": "

A customer-chosen string that you can use to distinguish between otherwise identical calls to UpdateReportPlanInput. Retrying a successful request with the same idempotency token results in a success message with no action taken.

", "idempotencyToken": true } } }, "UpdateReportPlanOutput": { "type": "structure", "members": { "ReportPlanName": { "shape": "ReportPlanName", "documentation": "

The unique name of the report plan.

" }, "ReportPlanArn": { "shape": "ARN", "documentation": "

An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.

" }, "CreationTime": { "shape": "timestamp", "documentation": "

The date and time that a report plan is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

" } } }, "UpdateRestoreTestingPlanInput": { "type": "structure", "required": [ "RestoreTestingPlan", "RestoreTestingPlanName" ], "members": { "RestoreTestingPlan": { "shape": "RestoreTestingPlanForUpdate", "documentation": "

Specifies the body of a restore testing plan.

" }, "RestoreTestingPlanName": { "shape": "String", "documentation": "

This is the restore testing plan name you wish to update.

", "location": "uri", "locationName": "RestoreTestingPlanName" } } }, "UpdateRestoreTestingPlanOutput": { "type": "structure", "required": [ "CreationTime", "RestoreTestingPlanArn", "RestoreTestingPlanName", "UpdateTime" ], "members": { "CreationTime": { "shape": "Timestamp", "documentation": "

This is the time the resource testing plan was created.

" }, "RestoreTestingPlanArn": { "shape": "String", "documentation": "

Unique ARN (Amazon Resource Name) of the restore testing plan.

" }, "RestoreTestingPlanName": { "shape": "String", "documentation": "

The name cannot be changed after creation. The name consists of only alphanumeric characters and underscores. Maximum length is 50.

" }, "UpdateTime": { "shape": "Timestamp", "documentation": "

This is the time the update completed for the restore testing plan.

" } } }, "UpdateRestoreTestingSelectionInput": { "type": "structure", "required": [ "RestoreTestingPlanName", "RestoreTestingSelection", "RestoreTestingSelectionName" ], "members": { "RestoreTestingPlanName": { "shape": "String", "documentation": "

The restore testing plan name is required to update the indicated testing plan.

", "location": "uri", "locationName": "RestoreTestingPlanName" }, "RestoreTestingSelection": { "shape": "RestoreTestingSelectionForUpdate", "documentation": "

To update your restore testing selection, you can use either protected resource ARNs or conditions, but not both. That is, if your selection has ProtectedResourceArns, requesting an update with the parameter ProtectedResourceConditions will be unsuccessful.

" }, "RestoreTestingSelectionName": { "shape": "String", "documentation": "

This is the required restore testing selection name of the restore testing selection you wish to update.

", "location": "uri", "locationName": "RestoreTestingSelectionName" } } }, "UpdateRestoreTestingSelectionOutput": { "type": "structure", "required": [ "CreationTime", "RestoreTestingPlanArn", "RestoreTestingPlanName", "RestoreTestingSelectionName", "UpdateTime" ], "members": { "CreationTime": { "shape": "Timestamp", "documentation": "

This is the time the resource testing selection was updated successfully.

" }, "RestoreTestingPlanArn": { "shape": "String", "documentation": "

Unique string that is the name of the restore testing plan.

" }, "RestoreTestingPlanName": { "shape": "String", "documentation": "

This is the restore testing plan with which the updated restore testing selection is associated.

" }, "RestoreTestingSelectionName": { "shape": "String", "documentation": "

This is the returned restore testing selection name.

" }, "UpdateTime": { "shape": "Timestamp", "documentation": "

This is the time the update completed for the restore testing selection.

" } } }, "VaultNames": { "type": "list", "member": { "shape": "string" } }, "VaultState": { "type": "string", "enum": [ "CREATING", "AVAILABLE", "FAILED" ] }, "VaultType": { "type": "string", "enum": [ "BACKUP_VAULT", "LOGICALLY_AIR_GAPPED_BACKUP_VAULT" ] }, "WindowMinutes": { "type": "long" }, "boolean": { "type": "boolean" }, "integer": { "type": "integer" }, "long": { "type": "long" }, "string": { "type": "string" }, "stringList": { "type": "list", "member": { "shape": "string" } }, "stringMap": { "type": "map", "key": { "shape": "string" }, "value": { "shape": "string" } }, "timestamp": { "type": "timestamp" } }, "documentation": "Backup

Backup is a unified backup service designed to protect Amazon Web Services services and their associated data. Backup simplifies the creation, migration, restoration, and deletion of backups, while also providing reporting and auditing.

" }