Backup ****** Client ====== class Backup.Client A low-level client representing AWS 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. import boto3 client = boto3.client('backup') These are the available methods: * associate_backup_vault_mpa_approval_team * can_paginate * cancel_legal_hold * close * create_backup_plan * create_backup_selection * create_backup_vault * create_framework * create_legal_hold * create_logically_air_gapped_backup_vault * create_report_plan * create_restore_access_backup_vault * create_restore_testing_plan * create_restore_testing_selection * delete_backup_plan * delete_backup_selection * delete_backup_vault * delete_backup_vault_access_policy * delete_backup_vault_lock_configuration * delete_backup_vault_notifications * delete_framework * delete_recovery_point * delete_report_plan * delete_restore_testing_plan * delete_restore_testing_selection * describe_backup_job * describe_backup_vault * describe_copy_job * describe_framework * describe_global_settings * describe_protected_resource * describe_recovery_point * describe_region_settings * describe_report_job * describe_report_plan * describe_restore_job * disassociate_backup_vault_mpa_approval_team * disassociate_recovery_point * disassociate_recovery_point_from_parent * export_backup_plan_template * get_backup_plan * get_backup_plan_from_json * get_backup_plan_from_template * get_backup_selection * get_backup_vault_access_policy * get_backup_vault_notifications * get_legal_hold * get_paginator * get_recovery_point_index_details * get_recovery_point_restore_metadata * get_restore_job_metadata * get_restore_testing_inferred_metadata * get_restore_testing_plan * get_restore_testing_selection * get_supported_resource_types * get_waiter * list_backup_job_summaries * list_backup_jobs * list_backup_plan_templates * list_backup_plan_versions * list_backup_plans * list_backup_selections * list_backup_vaults * list_copy_job_summaries * list_copy_jobs * list_frameworks * list_indexed_recovery_points * list_legal_holds * list_protected_resources * list_protected_resources_by_backup_vault * list_recovery_points_by_backup_vault * list_recovery_points_by_legal_hold * list_recovery_points_by_resource * list_report_jobs * list_report_plans * list_restore_access_backup_vaults * list_restore_job_summaries * list_restore_jobs * list_restore_jobs_by_protected_resource * list_restore_testing_plans * list_restore_testing_selections * list_tags * put_backup_vault_access_policy * put_backup_vault_lock_configuration * put_backup_vault_notifications * put_restore_validation_result * revoke_restore_access_backup_vault * start_backup_job * start_copy_job * start_report_job * start_restore_job * stop_backup_job * tag_resource * untag_resource * update_backup_plan * update_framework * update_global_settings * update_recovery_point_index_settings * update_recovery_point_lifecycle * update_region_settings * update_report_plan * update_restore_testing_plan * update_restore_testing_selection Paginators ========== Paginators are available on a client instance via the "get_paginator" method. For more detailed instructions and examples on the usage of paginators, see the paginators user guide. The available paginators are: * ListBackupJobs * ListBackupPlanTemplates * ListBackupPlanVersions * ListBackupPlans * ListBackupSelections * ListBackupVaults * ListCopyJobs * ListIndexedRecoveryPoints * ListLegalHolds * ListProtectedResources * ListProtectedResourcesByBackupVault * ListRecoveryPointsByBackupVault * ListRecoveryPointsByLegalHold * ListRecoveryPointsByResource * ListRestoreAccessBackupVaults * ListRestoreJobs * ListRestoreJobsByProtectedResource * ListRestoreTestingPlans * ListRestoreTestingSelections Backup / Paginator / ListBackupVaults ListBackupVaults **************** class Backup.Paginator.ListBackupVaults paginator = client.get_paginator('list_backup_vaults') paginate(**kwargs) Creates an iterator that will paginate through responses from "Backup.Client.list_backup_vaults()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( ByVaultType='BACKUP_VAULT'|'LOGICALLY_AIR_GAPPED_BACKUP_VAULT'|'RESTORE_ACCESS_BACKUP_VAULT', ByShared=True|False, PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **ByVaultType** (*string*) -- This parameter will sort the list of vaults by vault type. * **ByShared** (*boolean*) -- This parameter will sort the list of vaults by shared vaults. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'BackupVaultList': [ { 'BackupVaultName': 'string', 'BackupVaultArn': 'string', 'VaultType': 'BACKUP_VAULT'|'LOGICALLY_AIR_GAPPED_BACKUP_VAULT'|'RESTORE_ACCESS_BACKUP_VAULT', 'VaultState': 'CREATING'|'AVAILABLE'|'FAILED', 'CreationDate': datetime(2015, 1, 1), 'EncryptionKeyArn': 'string', 'CreatorRequestId': 'string', 'NumberOfRecoveryPoints': 123, 'Locked': True|False, 'MinRetentionDays': 123, 'MaxRetentionDays': 123, 'LockDate': datetime(2015, 1, 1) }, ], } **Response Structure** * *(dict) --* * **BackupVaultList** *(list) --* 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. * *(dict) --* Contains metadata about a backup vault. * **BackupVaultName** *(string) --* 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. * **BackupVaultArn** *(string) --* An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, "arn:aws:backup:us-east-1:123456789012:backup- vault:aBackupVault". * **VaultType** *(string) --* The type of vault in which the described recovery point is stored. * **VaultState** *(string) --* The current state of the vault. * **CreationDate** *(datetime) --* 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** *(string) --* 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** *(string) --* 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** *(integer) --* The number of recovery points that are stored in a backup vault. * **Locked** *(boolean) --* 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** *(integer) --* 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** *(integer) --* 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** *(datetime) --* 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. Backup / Paginator / ListRestoreJobs ListRestoreJobs *************** class Backup.Paginator.ListRestoreJobs paginator = client.get_paginator('list_restore_jobs') paginate(**kwargs) Creates an iterator that will paginate through responses from "Backup.Client.list_restore_jobs()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( ByAccountId='string', ByResourceType='string', ByCreatedBefore=datetime(2015, 1, 1), ByCreatedAfter=datetime(2015, 1, 1), ByStatus='PENDING'|'RUNNING'|'COMPLETED'|'ABORTED'|'FAILED', ByCompleteBefore=datetime(2015, 1, 1), ByCompleteAfter=datetime(2015, 1, 1), ByRestoreTestingPlanArn='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **ByAccountId** (*string*) -- The account ID to list the jobs from. Returns only restore jobs associated with the specified account ID. * **ByResourceType** (*string*) -- Include this parameter to return only restore jobs for the specified resources: * "Aurora" for Amazon Aurora * "CloudFormation" for CloudFormation * "DocumentDB" for Amazon DocumentDB (with MongoDB compatibility) * "DynamoDB" for Amazon DynamoDB * "EBS" for Amazon Elastic Block Store * "EC2" for Amazon Elastic Compute Cloud * "EFS" for Amazon Elastic File System * "FSx" for Amazon FSx * "Neptune" for Amazon Neptune * "RDS" for Amazon Relational Database Service * "Redshift" for Amazon Redshift * "S3" for Amazon Simple Storage Service (Amazon S3) * "SAP HANA on Amazon EC2" for SAP HANA databases on Amazon Elastic Compute Cloud instances * "Storage Gateway" for Storage Gateway * "Timestream" for Amazon Timestream * "VirtualMachine" for VMware virtual machines * **ByCreatedBefore** (*datetime*) -- Returns only restore jobs that were created before the specified date. * **ByCreatedAfter** (*datetime*) -- Returns only restore jobs that were created after the specified date. * **ByStatus** (*string*) -- Returns only restore jobs associated with the specified job status. * **ByCompleteBefore** (*datetime*) -- Returns only copy jobs completed before a date expressed in Unix format and Coordinated Universal Time (UTC). * **ByCompleteAfter** (*datetime*) -- Returns only copy jobs completed after a date expressed in Unix format and Coordinated Universal Time (UTC). * **ByRestoreTestingPlanArn** (*string*) -- This returns only restore testing jobs that match the specified resource Amazon Resource Name (ARN). * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'RestoreJobs': [ { 'AccountId': 'string', 'RestoreJobId': 'string', 'RecoveryPointArn': 'string', 'CreationDate': datetime(2015, 1, 1), 'CompletionDate': datetime(2015, 1, 1), 'Status': 'PENDING'|'RUNNING'|'COMPLETED'|'ABORTED'|'FAILED', 'StatusMessage': 'string', 'PercentDone': 'string', 'BackupSizeInBytes': 123, 'IamRoleArn': 'string', 'ExpectedCompletionTimeMinutes': 123, 'CreatedResourceArn': 'string', 'ResourceType': 'string', 'RecoveryPointCreationDate': datetime(2015, 1, 1), 'CreatedBy': { 'RestoreTestingPlanArn': 'string' }, 'ValidationStatus': 'FAILED'|'SUCCESSFUL'|'TIMED_OUT'|'VALIDATING', 'ValidationStatusMessage': 'string', 'DeletionStatus': 'DELETING'|'FAILED'|'SUCCESSFUL', 'DeletionStatusMessage': 'string' }, ], } **Response Structure** * *(dict) --* * **RestoreJobs** *(list) --* An array of objects that contain detailed information about jobs to restore saved resources. * *(dict) --* Contains metadata about a restore job. * **AccountId** *(string) --* The account ID that owns the restore job. * **RestoreJobId** *(string) --* Uniquely identifies the job that restores a recovery point. * **RecoveryPointArn** *(string) --* 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** *(datetime) --* 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** *(datetime) --* 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** *(string) --* A status code specifying the state of the job initiated by Backup to restore a recovery point. * **StatusMessage** *(string) --* A detailed message explaining the status of the job to restore a recovery point. * **PercentDone** *(string) --* Contains an estimated percentage complete of a job at the time the job status was queried. * **BackupSizeInBytes** *(integer) --* The size, in bytes, of the restored resource. * **IamRoleArn** *(string) --* The IAM role ARN used to create the target recovery point; for example, "arn:aws:iam::123456789012:role/S3Access". * **ExpectedCompletionTimeMinutes** *(integer) --* The amount of time in minutes that a job restoring a recovery point is expected to take. * **CreatedResourceArn** *(string) --* An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type. * **ResourceType** *(string) --* 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** *(datetime) --* The date on which a recovery point was created. * **CreatedBy** *(dict) --* Contains identifying information about the creation of a restore job. * **RestoreTestingPlanArn** *(string) --* An Amazon Resource Name (ARN) that uniquely identifies a restore testing plan. * **ValidationStatus** *(string) --* The status of validation run on the indicated restore job. * **ValidationStatusMessage** *(string) --* This describes the status of validation run on the indicated restore job. * **DeletionStatus** *(string) --* This notes the status of the data generated by the restore test. The status may be "Deleting", "Failed", or "Successful". * **DeletionStatusMessage** *(string) --* This describes the restore job deletion status. Backup / Paginator / ListIndexedRecoveryPoints ListIndexedRecoveryPoints ************************* class Backup.Paginator.ListIndexedRecoveryPoints paginator = client.get_paginator('list_indexed_recovery_points') paginate(**kwargs) Creates an iterator that will paginate through responses from "Backup.Client.list_indexed_recovery_points()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( SourceResourceArn='string', CreatedBefore=datetime(2015, 1, 1), CreatedAfter=datetime(2015, 1, 1), ResourceType='string', IndexStatus='PENDING'|'ACTIVE'|'FAILED'|'DELETING', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **SourceResourceArn** (*string*) -- A string of the Amazon Resource Name (ARN) that uniquely identifies the source resource. * **CreatedBefore** (*datetime*) -- Returns only indexed recovery points that were created before the specified date. * **CreatedAfter** (*datetime*) -- Returns only indexed recovery points that were created after the specified date. * **ResourceType** (*string*) -- Returns a list of indexed recovery points for the specified resource type(s). Accepted values include: * "EBS" for Amazon Elastic Block Store * "S3" for Amazon Simple Storage Service (Amazon S3) * **IndexStatus** (*string*) -- Include this parameter to filter the returned list by the indicated statuses. Accepted values: "PENDING" | "ACTIVE" | "FAILED" | "DELETING" A recovery point with an index that has the status of "ACTIVE" can be included in a search. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'IndexedRecoveryPoints': [ { 'RecoveryPointArn': 'string', 'SourceResourceArn': 'string', 'IamRoleArn': 'string', 'BackupCreationDate': datetime(2015, 1, 1), 'ResourceType': 'string', 'IndexCreationDate': datetime(2015, 1, 1), 'IndexStatus': 'PENDING'|'ACTIVE'|'FAILED'|'DELETING', 'IndexStatusMessage': 'string', 'BackupVaultArn': 'string' }, ], } **Response Structure** * *(dict) --* * **IndexedRecoveryPoints** *(list) --* This is a list of recovery points that have an associated index, belonging to the specified account. * *(dict) --* This is a recovery point that has an associated backup index. Only recovery points with a backup index can be included in a search. * **RecoveryPointArn** *(string) --* An ARN that uniquely identifies a recovery point; for example, "arn:aws:backup:us-east-1:123456789012 :recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45" * **SourceResourceArn** *(string) --* A string of the Amazon Resource Name (ARN) that uniquely identifies the source resource. * **IamRoleArn** *(string) --* This specifies the IAM role ARN used for this operation. For example, arn:aws:iam::123456789012:role/S3Access * **BackupCreationDate** *(datetime) --* The date and time that a backup was 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. * **ResourceType** *(string) --* The resource type of the indexed recovery point. * "EBS" for Amazon Elastic Block Store * "S3" for Amazon Simple Storage Service (Amazon S3) * **IndexCreationDate** *(datetime) --* The date and time that a backup index was 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. * **IndexStatus** *(string) --* This is the current status for the backup index associated with the specified recovery point. Statuses are: "PENDING" | "ACTIVE" | "FAILED" | "DELETING" A recovery point with an index that has the status of "ACTIVE" can be included in a search. * **IndexStatusMessage** *(string) --* A string in the form of a detailed message explaining the status of a backup index associated with the recovery point. * **BackupVaultArn** *(string) --* An ARN that uniquely identifies the backup vault where the recovery point index is stored. For example, "arn:aws:backup:us-east-1:123456789012 :backup-vault:aBackupVault". Backup / Paginator / ListProtectedResourcesByBackupVault ListProtectedResourcesByBackupVault *********************************** class Backup.Paginator.ListProtectedResourcesByBackupVault paginator = client.get_paginator('list_protected_resources_by_backup_vault') paginate(**kwargs) Creates an iterator that will paginate through responses from "Backup.Client.list_protected_resources_by_backup_vault()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( BackupVaultName='string', BackupVaultAccountId='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **BackupVaultName** (*string*) -- **[REQUIRED]** The list of protected resources by backup vault within the vault(s) you specify by name. * **BackupVaultAccountId** (*string*) -- The list of protected resources by backup vault within the vault(s) you specify by account ID. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'Results': [ { 'ResourceArn': 'string', 'ResourceType': 'string', 'LastBackupTime': datetime(2015, 1, 1), 'ResourceName': 'string', 'LastBackupVaultArn': 'string', 'LastRecoveryPointArn': 'string' }, ], } **Response Structure** * *(dict) --* * **Results** *(list) --* These are the results returned for the request ListProtectedResourcesByBackupVault. * *(dict) --* A structure that contains information about a backed-up resource. * **ResourceArn** *(string) --* An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type. * **ResourceType** *(string) --* 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** *(datetime) --* 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** *(string) --* The non-unique name of the resource that belongs to the specified backup. * **LastBackupVaultArn** *(string) --* The ARN (Amazon Resource Name) of the backup vault that contains the most recent backup recovery point. * **LastRecoveryPointArn** *(string) --* The ARN (Amazon Resource Name) of the most recent recovery point. Backup / Paginator / ListRecoveryPointsByResource ListRecoveryPointsByResource **************************** class Backup.Paginator.ListRecoveryPointsByResource paginator = client.get_paginator('list_recovery_points_by_resource') paginate(**kwargs) Creates an iterator that will paginate through responses from "Backup.Client.list_recovery_points_by_resource()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( ResourceArn='string', ManagedByAWSBackupOnly=True|False, PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **ResourceArn** (*string*) -- **[REQUIRED]** An ARN that uniquely identifies a resource. The format of the ARN depends on the resource type. * **ManagedByAWSBackupOnly** (*boolean*) -- 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 * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'RecoveryPoints': [ { 'RecoveryPointArn': 'string', 'CreationDate': datetime(2015, 1, 1), 'Status': 'COMPLETED'|'PARTIAL'|'DELETING'|'EXPIRED'|'AVAILABLE'|'STOPPED'|'CREATING', 'StatusMessage': 'string', 'EncryptionKeyArn': 'string', 'BackupSizeBytes': 123, 'BackupVaultName': 'string', 'IsParent': True|False, 'ParentRecoveryPointArn': 'string', 'ResourceName': 'string', 'VaultType': 'BACKUP_VAULT'|'LOGICALLY_AIR_GAPPED_BACKUP_VAULT'|'RESTORE_ACCESS_BACKUP_VAULT', 'IndexStatus': 'PENDING'|'ACTIVE'|'FAILED'|'DELETING', 'IndexStatusMessage': 'string' }, ] } **Response Structure** * *(dict) --* * **RecoveryPoints** *(list) --* An array of objects that contain detailed information about recovery points of the specified resource type. Note: Only Amazon EFS and Amazon EC2 recovery points return BackupVaultName. * *(dict) --* Contains detailed information about a saved recovery point. * **RecoveryPointArn** *(string) --* 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** *(datetime) --* 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** *(string) --* A status code specifying the state of the recovery point. * **StatusMessage** *(string) --* A message explaining the current status of the recovery point. * **EncryptionKeyArn** *(string) --* 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** *(integer) --* The size, in bytes, of a backup. * **BackupVaultName** *(string) --* 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. * **IsParent** *(boolean) --* This is a boolean value indicating this is a parent (composite) recovery point. * **ParentRecoveryPointArn** *(string) --* The Amazon Resource Name (ARN) of the parent (composite) recovery point. * **ResourceName** *(string) --* The non-unique name of the resource that belongs to the specified backup. * **VaultType** *(string) --* The type of vault in which the described recovery point is stored. * **IndexStatus** *(string) --* This is the current status for the backup index associated with the specified recovery point. Statuses are: "PENDING" | "ACTIVE" | "FAILED" | "DELETING" A recovery point with an index that has the status of "ACTIVE" can be included in a search. * **IndexStatusMessage** *(string) --* A string in the form of a detailed message explaining the status of a backup index associated with the recovery point. Backup / Paginator / ListRecoveryPointsByLegalHold ListRecoveryPointsByLegalHold ***************************** class Backup.Paginator.ListRecoveryPointsByLegalHold paginator = client.get_paginator('list_recovery_points_by_legal_hold') paginate(**kwargs) Creates an iterator that will paginate through responses from "Backup.Client.list_recovery_points_by_legal_hold()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( LegalHoldId='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **LegalHoldId** (*string*) -- **[REQUIRED]** The ID of the legal hold. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'RecoveryPoints': [ { 'RecoveryPointArn': 'string', 'ResourceArn': 'string', 'ResourceType': 'string', 'BackupVaultName': 'string' }, ], } **Response Structure** * *(dict) --* * **RecoveryPoints** *(list) --* The recovery points. * *(dict) --* 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. * **RecoveryPointArn** *(string) --* The Amazon Resource Name (ARN) of the parent (composite) recovery point. * **ResourceArn** *(string) --* The Amazon Resource Name (ARN) that uniquely identifies a saved resource. * **ResourceType** *(string) --* The Amazon Web Services resource type that is saved as a recovery point. * **BackupVaultName** *(string) --* The name of the backup vault (the logical container in which backups are stored). Backup / Paginator / ListRestoreJobsByProtectedResource ListRestoreJobsByProtectedResource ********************************** class Backup.Paginator.ListRestoreJobsByProtectedResource paginator = client.get_paginator('list_restore_jobs_by_protected_resource') paginate(**kwargs) Creates an iterator that will paginate through responses from "Backup.Client.list_restore_jobs_by_protected_resource()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( ResourceArn='string', ByStatus='PENDING'|'RUNNING'|'COMPLETED'|'ABORTED'|'FAILED', ByRecoveryPointCreationDateAfter=datetime(2015, 1, 1), ByRecoveryPointCreationDateBefore=datetime(2015, 1, 1), PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **ResourceArn** (*string*) -- **[REQUIRED]** Returns only restore jobs that match the specified resource Amazon Resource Name (ARN). * **ByStatus** (*string*) -- Returns only restore jobs associated with the specified job status. * **ByRecoveryPointCreationDateAfter** (*datetime*) -- Returns only restore jobs of recovery points that were created after the specified date. * **ByRecoveryPointCreationDateBefore** (*datetime*) -- Returns only restore jobs of recovery points that were created before the specified date. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'RestoreJobs': [ { 'AccountId': 'string', 'RestoreJobId': 'string', 'RecoveryPointArn': 'string', 'CreationDate': datetime(2015, 1, 1), 'CompletionDate': datetime(2015, 1, 1), 'Status': 'PENDING'|'RUNNING'|'COMPLETED'|'ABORTED'|'FAILED', 'StatusMessage': 'string', 'PercentDone': 'string', 'BackupSizeInBytes': 123, 'IamRoleArn': 'string', 'ExpectedCompletionTimeMinutes': 123, 'CreatedResourceArn': 'string', 'ResourceType': 'string', 'RecoveryPointCreationDate': datetime(2015, 1, 1), 'CreatedBy': { 'RestoreTestingPlanArn': 'string' }, 'ValidationStatus': 'FAILED'|'SUCCESSFUL'|'TIMED_OUT'|'VALIDATING', 'ValidationStatusMessage': 'string', 'DeletionStatus': 'DELETING'|'FAILED'|'SUCCESSFUL', 'DeletionStatusMessage': 'string' }, ], } **Response Structure** * *(dict) --* * **RestoreJobs** *(list) --* An array of objects that contain detailed information about jobs to restore saved resources.> * *(dict) --* Contains metadata about a restore job. * **AccountId** *(string) --* The account ID that owns the restore job. * **RestoreJobId** *(string) --* Uniquely identifies the job that restores a recovery point. * **RecoveryPointArn** *(string) --* 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** *(datetime) --* 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** *(datetime) --* 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** *(string) --* A status code specifying the state of the job initiated by Backup to restore a recovery point. * **StatusMessage** *(string) --* A detailed message explaining the status of the job to restore a recovery point. * **PercentDone** *(string) --* Contains an estimated percentage complete of a job at the time the job status was queried. * **BackupSizeInBytes** *(integer) --* The size, in bytes, of the restored resource. * **IamRoleArn** *(string) --* The IAM role ARN used to create the target recovery point; for example, "arn:aws:iam::123456789012:role/S3Access". * **ExpectedCompletionTimeMinutes** *(integer) --* The amount of time in minutes that a job restoring a recovery point is expected to take. * **CreatedResourceArn** *(string) --* An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type. * **ResourceType** *(string) --* 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** *(datetime) --* The date on which a recovery point was created. * **CreatedBy** *(dict) --* Contains identifying information about the creation of a restore job. * **RestoreTestingPlanArn** *(string) --* An Amazon Resource Name (ARN) that uniquely identifies a restore testing plan. * **ValidationStatus** *(string) --* The status of validation run on the indicated restore job. * **ValidationStatusMessage** *(string) --* This describes the status of validation run on the indicated restore job. * **DeletionStatus** *(string) --* This notes the status of the data generated by the restore test. The status may be "Deleting", "Failed", or "Successful". * **DeletionStatusMessage** *(string) --* This describes the restore job deletion status. Backup / Paginator / ListRestoreTestingSelections ListRestoreTestingSelections **************************** class Backup.Paginator.ListRestoreTestingSelections paginator = client.get_paginator('list_restore_testing_selections') paginate(**kwargs) Creates an iterator that will paginate through responses from "Backup.Client.list_restore_testing_selections()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( RestoreTestingPlanName='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **RestoreTestingPlanName** (*string*) -- **[REQUIRED]** Returns restore testing selections by the specified restore testing plan name. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'RestoreTestingSelections': [ { 'CreationTime': datetime(2015, 1, 1), 'IamRoleArn': 'string', 'ProtectedResourceType': 'string', 'RestoreTestingPlanName': 'string', 'RestoreTestingSelectionName': 'string', 'ValidationWindowHours': 123 }, ] } **Response Structure** * *(dict) --* * **RestoreTestingSelections** *(list) --* The returned restore testing selections associated with the restore testing plan. * *(dict) --* This contains metadata about a restore testing selection. * **CreationTime** *(datetime) --* 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** *(string) --* 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** *(string) --* 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** *(string) --* 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** *(string) --* Unique name of a restore testing selection. * **ValidationWindowHours** *(integer) --* 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). Backup / Paginator / ListBackupPlans ListBackupPlans *************** class Backup.Paginator.ListBackupPlans paginator = client.get_paginator('list_backup_plans') paginate(**kwargs) Creates an iterator that will paginate through responses from "Backup.Client.list_backup_plans()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( IncludeDeleted=True|False, PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **IncludeDeleted** (*boolean*) -- A Boolean value with a default value of "FALSE" that returns deleted backup plans when set to "TRUE". * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'BackupPlansList': [ { 'BackupPlanArn': 'string', 'BackupPlanId': 'string', 'CreationDate': datetime(2015, 1, 1), 'DeletionDate': datetime(2015, 1, 1), 'VersionId': 'string', 'BackupPlanName': 'string', 'CreatorRequestId': 'string', 'LastExecutionDate': datetime(2015, 1, 1), 'AdvancedBackupSettings': [ { 'ResourceType': 'string', 'BackupOptions': { 'string': 'string' } }, ] }, ] } **Response Structure** * *(dict) --* * **BackupPlansList** *(list) --* Information about the backup plans. * *(dict) --* Contains metadata about a backup plan. * **BackupPlanArn** *(string) --* 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** *(string) --* Uniquely identifies a backup plan. * **CreationDate** *(datetime) --* 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** *(datetime) --* 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** *(string) --* Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes long. Version IDs cannot be edited. * **BackupPlanName** *(string) --* The display name of a saved backup plan. * **CreatorRequestId** *(string) --* 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** *(datetime) --* The last time this backup plan was run. 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** *(list) --* Contains a list of "BackupOptions" for a resource type. * *(dict) --* The backup options for each resource type. * **ResourceType** *(string) --* 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** *(dict) --* 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. * *(string) --* * *(string) --* Backup / Paginator / ListBackupJobs ListBackupJobs ************** class Backup.Paginator.ListBackupJobs paginator = client.get_paginator('list_backup_jobs') paginate(**kwargs) Creates an iterator that will paginate through responses from "Backup.Client.list_backup_jobs()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( ByResourceArn='string', ByState='CREATED'|'PENDING'|'RUNNING'|'ABORTING'|'ABORTED'|'COMPLETED'|'FAILED'|'EXPIRED'|'PARTIAL', ByBackupVaultName='string', ByCreatedBefore=datetime(2015, 1, 1), ByCreatedAfter=datetime(2015, 1, 1), ByResourceType='string', ByAccountId='string', ByCompleteAfter=datetime(2015, 1, 1), ByCompleteBefore=datetime(2015, 1, 1), ByParentJobId='string', ByMessageCategory='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **ByResourceArn** (*string*) -- Returns only backup jobs that match the specified resource Amazon Resource Name (ARN). * **ByState** (*string*) -- 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 * **ByBackupVaultName** (*string*) -- 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. * **ByCreatedBefore** (*datetime*) -- Returns only backup jobs that were created before the specified date. * **ByCreatedAfter** (*datetime*) -- Returns only backup jobs that were created after the specified date. * **ByResourceType** (*string*) -- Returns only backup jobs for the specified resources: * "Aurora" for Amazon Aurora * "CloudFormation" for CloudFormation * "DocumentDB" for Amazon DocumentDB (with MongoDB compatibility) * "DynamoDB" for Amazon DynamoDB * "EBS" for Amazon Elastic Block Store * "EC2" for Amazon Elastic Compute Cloud * "EFS" for Amazon Elastic File System * "FSx" for Amazon FSx * "Neptune" for Amazon Neptune * "RDS" for Amazon Relational Database Service * "Redshift" for Amazon Redshift * "S3" for Amazon Simple Storage Service (Amazon S3) * "SAP HANA on Amazon EC2" for SAP HANA databases on Amazon Elastic Compute Cloud instances * "Storage Gateway" for Storage Gateway * "Timestream" for Amazon Timestream * "VirtualMachine" for VMware virtual machines * **ByAccountId** (*string*) -- 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. * **ByCompleteAfter** (*datetime*) -- Returns only backup jobs completed after a date expressed in Unix format and Coordinated Universal Time (UTC). * **ByCompleteBefore** (*datetime*) -- Returns only backup jobs completed before a date expressed in Unix format and Coordinated Universal Time (UTC). * **ByParentJobId** (*string*) -- This is a filter to list child (nested) jobs based on parent job ID. * **ByMessageCategory** (*string*) -- 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. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'BackupJobs': [ { 'AccountId': 'string', 'BackupJobId': 'string', 'BackupVaultName': 'string', 'BackupVaultArn': 'string', 'RecoveryPointArn': 'string', 'ResourceArn': 'string', 'CreationDate': datetime(2015, 1, 1), 'CompletionDate': datetime(2015, 1, 1), 'State': 'CREATED'|'PENDING'|'RUNNING'|'ABORTING'|'ABORTED'|'COMPLETED'|'FAILED'|'EXPIRED'|'PARTIAL', 'StatusMessage': 'string', 'PercentDone': 'string', 'BackupSizeInBytes': 123, 'IamRoleArn': 'string', 'CreatedBy': { 'BackupPlanId': 'string', 'BackupPlanArn': 'string', 'BackupPlanVersion': 'string', 'BackupRuleId': 'string' }, 'ExpectedCompletionDate': datetime(2015, 1, 1), 'StartBy': datetime(2015, 1, 1), 'ResourceType': 'string', 'BytesTransferred': 123, 'BackupOptions': { 'string': 'string' }, 'BackupType': 'string', 'ParentJobId': 'string', 'IsParent': True|False, 'ResourceName': 'string', 'InitiationDate': datetime(2015, 1, 1), 'MessageCategory': 'string' }, ], } **Response Structure** * *(dict) --* * **BackupJobs** *(list) --* An array of structures containing metadata about your backup jobs returned in JSON format. * *(dict) --* Contains detailed information about a backup job. * **AccountId** *(string) --* The account ID that owns the backup job. * **BackupJobId** *(string) --* Uniquely identifies a request to Backup to back up a resource. * **BackupVaultName** *(string) --* 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. * **BackupVaultArn** *(string) --* An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, "arn:aws:backup:us-east-1:123456789012:backup- vault:aBackupVault". * **RecoveryPointArn** *(string) --* 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** *(string) --* An ARN that uniquely identifies a resource. The format of the ARN depends on the resource type. * **CreationDate** *(datetime) --* 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** *(datetime) --* 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** *(string) --* The current state of a backup job. * **StatusMessage** *(string) --* A detailed message explaining the status of the job to back up a resource. * **PercentDone** *(string) --* Contains an estimated percentage complete of a job at the time the job status was queried. * **BackupSizeInBytes** *(integer) --* The size, in bytes, of a backup (recovery point). This value can render differently depending on the resource type as Backup pulls in data information from other Amazon Web Services services. For example, the value returned may show a value of "0", which may differ from the anticipated value. The expected behavior for values by resource type are described as follows: * Amazon Aurora, Amazon DocumentDB, and Amazon Neptune do not have this value populate from the operation "GetBackupJobStatus". * For Amazon DynamoDB with advanced features, this value refers to the size of the recovery point (backup). * Amazon EC2 and Amazon EBS show volume size (provisioned storage) returned as part of this value. Amazon EBS does not return backup size information; snapshot size will have the same value as the original resource that was backed up. * For Amazon EFS, this value refers to the delta bytes transferred during a backup. * Amazon FSx does not populate this value from the operation "GetBackupJobStatus" for FSx file systems. * An Amazon RDS instance will show as "0". * For virtual machines running VMware, this value is passed to Backup through an asynchronous workflow, which can mean this displayed value can under- represent the actual backup size. * **IamRoleArn** *(string) --* 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** *(dict) --* 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. * **BackupPlanId** *(string) --* Uniquely identifies a backup plan. * **BackupPlanArn** *(string) --* 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** *(string) --* Version IDs are unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes long. They cannot be edited. * **BackupRuleId** *(string) --* Uniquely identifies a rule used to schedule the backup of a selection of resources. * **ExpectedCompletionDate** *(datetime) --* 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** *(datetime) --* 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** *(string) --* 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** *(integer) --* The size in bytes transferred to a backup vault at the time that the job status was queried. * **BackupOptions** *(dict) --* 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. * *(string) --* * *(string) --* * **BackupType** *(string) --* Represents the type of backup for a backup job. * **ParentJobId** *(string) --* This uniquely identifies a request to Backup to back up a resource. The return will be the parent (composite) job ID. * **IsParent** *(boolean) --* This is a boolean value indicating this is a parent (composite) backup job. * **ResourceName** *(string) --* The non-unique name of the resource that belongs to the specified backup. * **InitiationDate** *(datetime) --* The date on which the backup job was initiated. * **MessageCategory** *(string) --* 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. Backup / Paginator / ListRestoreTestingPlans ListRestoreTestingPlans *********************** class Backup.Paginator.ListRestoreTestingPlans paginator = client.get_paginator('list_restore_testing_plans') paginate(**kwargs) Creates an iterator that will paginate through responses from "Backup.Client.list_restore_testing_plans()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max- items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'RestoreTestingPlans': [ { 'CreationTime': datetime(2015, 1, 1), 'LastExecutionTime': datetime(2015, 1, 1), 'LastUpdateTime': datetime(2015, 1, 1), 'RestoreTestingPlanArn': 'string', 'RestoreTestingPlanName': 'string', 'ScheduleExpression': 'string', 'ScheduleExpressionTimezone': 'string', 'StartWindowHours': 123 }, ] } **Response Structure** * *(dict) --* * **RestoreTestingPlans** *(list) --* This is a returned list of restore testing plans. * *(dict) --* This contains metadata about a restore testing plan. * **CreationTime** *(datetime) --* 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** *(datetime) --* 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** *(datetime) --* 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** *(string) --* An Amazon Resource Name (ARN) that uniquely identifiesa restore testing plan. * **RestoreTestingPlanName** *(string) --* The restore testing plan name. * **ScheduleExpression** *(string) --* A CRON expression in specified timezone when a restore testing plan is executed. When no CRON expression is provided, Backup will use the default expression "cron(0 5 ? * * *)". * **ScheduleExpressionTimezone** *(string) --* 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** *(integer) --* 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). Backup / Paginator / ListBackupSelections ListBackupSelections ******************** class Backup.Paginator.ListBackupSelections paginator = client.get_paginator('list_backup_selections') paginate(**kwargs) Creates an iterator that will paginate through responses from "Backup.Client.list_backup_selections()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( BackupPlanId='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **BackupPlanId** (*string*) -- **[REQUIRED]** Uniquely identifies a backup plan. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'BackupSelectionsList': [ { 'SelectionId': 'string', 'SelectionName': 'string', 'BackupPlanId': 'string', 'CreationDate': datetime(2015, 1, 1), 'CreatorRequestId': 'string', 'IamRoleArn': 'string' }, ] } **Response Structure** * *(dict) --* * **BackupSelectionsList** *(list) --* An array of backup selection list items containing metadata about each resource in the list. * *(dict) --* Contains metadata about a "BackupSelection" object. * **SelectionId** *(string) --* Uniquely identifies a request to assign a set of resources to a backup plan. * **SelectionName** *(string) --* The display name of a resource selection document. * **BackupPlanId** *(string) --* Uniquely identifies a backup plan. * **CreationDate** *(datetime) --* 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** *(string) --* 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** *(string) --* Specifies the IAM role Amazon Resource Name (ARN) to create the target recovery point; for example, "arn:aws:iam::123456789012:role/S3Access". Backup / Paginator / ListRecoveryPointsByBackupVault ListRecoveryPointsByBackupVault ******************************* class Backup.Paginator.ListRecoveryPointsByBackupVault paginator = client.get_paginator('list_recovery_points_by_backup_vault') paginate(**kwargs) Creates an iterator that will paginate through responses from "Backup.Client.list_recovery_points_by_backup_vault()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( BackupVaultName='string', BackupVaultAccountId='string', ByResourceArn='string', ByResourceType='string', ByBackupPlanId='string', ByCreatedBefore=datetime(2015, 1, 1), ByCreatedAfter=datetime(2015, 1, 1), ByParentRecoveryPointArn='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **BackupVaultName** (*string*) -- **[REQUIRED]** 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. Note: Backup vault name might not be available when a supported service creates the backup. * **BackupVaultAccountId** (*string*) -- This parameter will sort the list of recovery points by account ID. * **ByResourceArn** (*string*) -- Returns only recovery points that match the specified resource Amazon Resource Name (ARN). * **ByResourceType** (*string*) -- Returns only recovery points that match the specified resource type(s): * "Aurora" for Amazon Aurora * "CloudFormation" for CloudFormation * "DocumentDB" for Amazon DocumentDB (with MongoDB compatibility) * "DynamoDB" for Amazon DynamoDB * "EBS" for Amazon Elastic Block Store * "EC2" for Amazon Elastic Compute Cloud * "EFS" for Amazon Elastic File System * "FSx" for Amazon FSx * "Neptune" for Amazon Neptune * "RDS" for Amazon Relational Database Service * "Redshift" for Amazon Redshift * "S3" for Amazon Simple Storage Service (Amazon S3) * "SAP HANA on Amazon EC2" for SAP HANA databases on Amazon Elastic Compute Cloud instances * "Storage Gateway" for Storage Gateway * "Timestream" for Amazon Timestream * "VirtualMachine" for VMware virtual machines * **ByBackupPlanId** (*string*) -- Returns only recovery points that match the specified backup plan ID. * **ByCreatedBefore** (*datetime*) -- Returns only recovery points that were created before the specified timestamp. * **ByCreatedAfter** (*datetime*) -- Returns only recovery points that were created after the specified timestamp. * **ByParentRecoveryPointArn** (*string*) -- This returns only recovery points that match the specified parent (composite) recovery point Amazon Resource Name (ARN). * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'RecoveryPoints': [ { 'RecoveryPointArn': 'string', 'BackupVaultName': 'string', 'BackupVaultArn': 'string', 'SourceBackupVaultArn': 'string', 'ResourceArn': 'string', 'ResourceType': 'string', 'CreatedBy': { 'BackupPlanId': 'string', 'BackupPlanArn': 'string', 'BackupPlanVersion': 'string', 'BackupRuleId': 'string' }, 'IamRoleArn': 'string', 'Status': 'COMPLETED'|'PARTIAL'|'DELETING'|'EXPIRED'|'AVAILABLE'|'STOPPED'|'CREATING', 'StatusMessage': 'string', 'CreationDate': datetime(2015, 1, 1), 'InitiationDate': datetime(2015, 1, 1), 'CompletionDate': datetime(2015, 1, 1), 'BackupSizeInBytes': 123, 'CalculatedLifecycle': { 'MoveToColdStorageAt': datetime(2015, 1, 1), 'DeleteAt': datetime(2015, 1, 1) }, 'Lifecycle': { 'MoveToColdStorageAfterDays': 123, 'DeleteAfterDays': 123, 'OptInToArchiveForSupportedResources': True|False }, 'EncryptionKeyArn': 'string', 'IsEncrypted': True|False, 'LastRestoreTime': datetime(2015, 1, 1), 'ParentRecoveryPointArn': 'string', 'CompositeMemberIdentifier': 'string', 'IsParent': True|False, 'ResourceName': 'string', 'VaultType': 'BACKUP_VAULT'|'LOGICALLY_AIR_GAPPED_BACKUP_VAULT'|'RESTORE_ACCESS_BACKUP_VAULT', 'IndexStatus': 'PENDING'|'ACTIVE'|'FAILED'|'DELETING', 'IndexStatusMessage': 'string' }, ] } **Response Structure** * *(dict) --* * **RecoveryPoints** *(list) --* An array of objects that contain detailed information about recovery points saved in a backup vault. * *(dict) --* Contains detailed information about the recovery points stored in a backup vault. * **RecoveryPointArn** *(string) --* 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** *(string) --* 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. * **BackupVaultArn** *(string) --* An ARN that uniquely identifies a backup vault; for example, "arn:aws:backup:us-east-1:123456789012 :backup-vault:aBackupVault". * **SourceBackupVaultArn** *(string) --* 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** *(string) --* An ARN that uniquely identifies a resource. The format of the ARN depends on the resource type. * **ResourceType** *(string) --* 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** *(dict) --* 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. * **BackupPlanId** *(string) --* Uniquely identifies a backup plan. * **BackupPlanArn** *(string) --* 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** *(string) --* Version IDs are unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes long. They cannot be edited. * **BackupRuleId** *(string) --* Uniquely identifies a rule used to schedule the backup of a selection of resources. * **IamRoleArn** *(string) --* Specifies the IAM role ARN used to create the target recovery point; for example, "arn:aws:iam::123456789012:role/S3Access". * **Status** *(string) --* A status code specifying the state of the recovery point. * **StatusMessage** *(string) --* A message explaining the current status of the recovery point. * **CreationDate** *(datetime) --* 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. * **InitiationDate** *(datetime) --* The date and time when the backup job that created this recovery point was initiated, in Unix format and Coordinated Universal Time (UTC). * **CompletionDate** *(datetime) --* 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** *(integer) --* The size, in bytes, of a backup. * **CalculatedLifecycle** *(dict) --* A "CalculatedLifecycle" object containing "DeleteAt" and "MoveToColdStorageAt" timestamps. * **MoveToColdStorageAt** *(datetime) --* A timestamp that specifies when to transition a recovery point to cold storage. * **DeleteAt** *(datetime) --* A timestamp that specifies when to delete a recovery point. * **Lifecycle** *(dict) --* The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. Backup transitions and expires backups automatically according to the lifecycle that you define. Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, the “retention” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold. Resource types that can transition to cold storage are listed in the Feature availability by resource table. Backup ignores this expression for other resource types. * **MoveToColdStorageAfterDays** *(integer) --* The number of days after creation that a recovery point is moved to cold storage. * **DeleteAfterDays** *(integer) --* The number of days after creation that a recovery point is deleted. This value must be at least 90 days after the number of days specified in "MoveToColdStorageAfterDays". * **OptInToArchiveForSupportedResources** *(boolean) --* If the value is true, your backup plan transitions supported resources to archive (cold) storage tier in accordance with your lifecycle settings. * **EncryptionKeyArn** *(string) --* 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** *(boolean) --* 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** *(datetime) --* 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** *(string) --* The Amazon Resource Name (ARN) of the parent (composite) recovery point. * **CompositeMemberIdentifier** *(string) --* 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** *(boolean) --* This is a boolean value indicating this is a parent (composite) recovery point. * **ResourceName** *(string) --* The non-unique name of the resource that belongs to the specified backup. * **VaultType** *(string) --* The type of vault in which the described recovery point is stored. * **IndexStatus** *(string) --* This is the current status for the backup index associated with the specified recovery point. Statuses are: "PENDING" | "ACTIVE" | "FAILED" | "DELETING" A recovery point with an index that has the status of "ACTIVE" can be included in a search. * **IndexStatusMessage** *(string) --* A string in the form of a detailed message explaining the status of a backup index associated with the recovery point. Backup / Paginator / ListBackupPlanVersions ListBackupPlanVersions ********************** class Backup.Paginator.ListBackupPlanVersions paginator = client.get_paginator('list_backup_plan_versions') paginate(**kwargs) Creates an iterator that will paginate through responses from "Backup.Client.list_backup_plan_versions()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( BackupPlanId='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **BackupPlanId** (*string*) -- **[REQUIRED]** Uniquely identifies a backup plan. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'BackupPlanVersionsList': [ { 'BackupPlanArn': 'string', 'BackupPlanId': 'string', 'CreationDate': datetime(2015, 1, 1), 'DeletionDate': datetime(2015, 1, 1), 'VersionId': 'string', 'BackupPlanName': 'string', 'CreatorRequestId': 'string', 'LastExecutionDate': datetime(2015, 1, 1), 'AdvancedBackupSettings': [ { 'ResourceType': 'string', 'BackupOptions': { 'string': 'string' } }, ] }, ] } **Response Structure** * *(dict) --* * **BackupPlanVersionsList** *(list) --* An array of version list items containing metadata about your backup plans. * *(dict) --* Contains metadata about a backup plan. * **BackupPlanArn** *(string) --* 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** *(string) --* Uniquely identifies a backup plan. * **CreationDate** *(datetime) --* 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** *(datetime) --* 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** *(string) --* Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes long. Version IDs cannot be edited. * **BackupPlanName** *(string) --* The display name of a saved backup plan. * **CreatorRequestId** *(string) --* 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** *(datetime) --* The last time this backup plan was run. 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** *(list) --* Contains a list of "BackupOptions" for a resource type. * *(dict) --* The backup options for each resource type. * **ResourceType** *(string) --* 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** *(dict) --* 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. * *(string) --* * *(string) --* Backup / Paginator / ListCopyJobs ListCopyJobs ************ class Backup.Paginator.ListCopyJobs paginator = client.get_paginator('list_copy_jobs') paginate(**kwargs) Creates an iterator that will paginate through responses from "Backup.Client.list_copy_jobs()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( ByResourceArn='string', ByState='CREATED'|'RUNNING'|'COMPLETED'|'FAILED'|'PARTIAL', ByCreatedBefore=datetime(2015, 1, 1), ByCreatedAfter=datetime(2015, 1, 1), ByResourceType='string', ByDestinationVaultArn='string', ByAccountId='string', ByCompleteBefore=datetime(2015, 1, 1), ByCompleteAfter=datetime(2015, 1, 1), ByParentJobId='string', ByMessageCategory='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **ByResourceArn** (*string*) -- Returns only copy jobs that match the specified resource Amazon Resource Name (ARN). * **ByState** (*string*) -- Returns only copy jobs that are in the specified state. * **ByCreatedBefore** (*datetime*) -- Returns only copy jobs that were created before the specified date. * **ByCreatedAfter** (*datetime*) -- Returns only copy jobs that were created after the specified date. * **ByResourceType** (*string*) -- Returns only backup jobs for the specified resources: * "Aurora" for Amazon Aurora * "CloudFormation" for CloudFormation * "DocumentDB" for Amazon DocumentDB (with MongoDB compatibility) * "DynamoDB" for Amazon DynamoDB * "EBS" for Amazon Elastic Block Store * "EC2" for Amazon Elastic Compute Cloud * "EFS" for Amazon Elastic File System * "FSx" for Amazon FSx * "Neptune" for Amazon Neptune * "RDS" for Amazon Relational Database Service * "Redshift" for Amazon Redshift * "S3" for Amazon Simple Storage Service (Amazon S3) * "SAP HANA on Amazon EC2" for SAP HANA databases on Amazon Elastic Compute Cloud instances * "Storage Gateway" for Storage Gateway * "Timestream" for Amazon Timestream * "VirtualMachine" for VMware virtual machines * **ByDestinationVaultArn** (*string*) -- An Amazon Resource Name (ARN) that uniquely identifies a source backup vault to copy from; for example, "arn:aws:backup:us- east-1:123456789012:backup-vault:aBackupVault". * **ByAccountId** (*string*) -- The account ID to list the jobs from. Returns only copy jobs associated with the specified account ID. * **ByCompleteBefore** (*datetime*) -- Returns only copy jobs completed before a date expressed in Unix format and Coordinated Universal Time (UTC). * **ByCompleteAfter** (*datetime*) -- Returns only copy jobs completed after a date expressed in Unix format and Coordinated Universal Time (UTC). * **ByParentJobId** (*string*) -- This is a filter to list child (nested) jobs based on parent job ID. * **ByMessageCategory** (*string*) -- 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. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'CopyJobs': [ { 'AccountId': 'string', 'CopyJobId': 'string', 'SourceBackupVaultArn': 'string', 'SourceRecoveryPointArn': 'string', 'DestinationBackupVaultArn': 'string', 'DestinationRecoveryPointArn': 'string', 'ResourceArn': 'string', 'CreationDate': datetime(2015, 1, 1), 'CompletionDate': datetime(2015, 1, 1), 'State': 'CREATED'|'RUNNING'|'COMPLETED'|'FAILED'|'PARTIAL', 'StatusMessage': 'string', 'BackupSizeInBytes': 123, 'IamRoleArn': 'string', 'CreatedBy': { 'BackupPlanId': 'string', 'BackupPlanArn': 'string', 'BackupPlanVersion': 'string', 'BackupRuleId': 'string' }, 'ResourceType': 'string', 'ParentJobId': 'string', 'IsParent': True|False, 'CompositeMemberIdentifier': 'string', 'NumberOfChildJobs': 123, 'ChildJobsInState': { 'string': 123 }, 'ResourceName': 'string', 'MessageCategory': 'string' }, ], } **Response Structure** * *(dict) --* * **CopyJobs** *(list) --* An array of structures containing metadata about your copy jobs returned in JSON format. * *(dict) --* Contains detailed information about a copy job. * **AccountId** *(string) --* The account ID that owns the copy job. * **CopyJobId** *(string) --* Uniquely identifies a copy job. * **SourceBackupVaultArn** *(string) --* An Amazon Resource Name (ARN) that uniquely identifies a source copy vault; for example, "arn:aws:backup:us-east-1:123456789012:backup- vault:aBackupVault". * **SourceRecoveryPointArn** *(string) --* 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** *(string) --* An Amazon Resource Name (ARN) that uniquely identifies a destination copy vault; for example, "arn:aws:backup:us-east-1:123456789012:backup- vault:aBackupVault". * **DestinationRecoveryPointArn** *(string) --* 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** *(string) --* 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** *(datetime) --* 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** *(datetime) --* 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** *(string) --* The current state of a copy job. * **StatusMessage** *(string) --* A detailed message explaining the status of the job to copy a resource. * **BackupSizeInBytes** *(integer) --* The size, in bytes, of a copy job. * **IamRoleArn** *(string) --* Specifies the IAM role ARN used to copy the target recovery point; for example, "arn:aws:iam::123456789012:role/S3Access". * **CreatedBy** *(dict) --* Contains information about the backup plan and rule that Backup used to initiate the recovery point backup. * **BackupPlanId** *(string) --* Uniquely identifies a backup plan. * **BackupPlanArn** *(string) --* 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** *(string) --* Version IDs are unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes long. They cannot be edited. * **BackupRuleId** *(string) --* Uniquely identifies a rule used to schedule the backup of a selection of resources. * **ResourceType** *(string) --* 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** *(string) --* This uniquely identifies a request to Backup to copy a resource. The return will be the parent (composite) job ID. * **IsParent** *(boolean) --* This is a boolean value indicating this is a parent (composite) copy job. * **CompositeMemberIdentifier** *(string) --* 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** *(integer) --* The number of child (nested) copy jobs. * **ChildJobsInState** *(dict) --* This returns the statistics of the included child (nested) copy jobs. * *(string) --* * *(integer) --* * **ResourceName** *(string) --* The non-unique name of the resource that belongs to the specified backup. * **MessageCategory** *(string) --* 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 Backup / Paginator / ListRestoreAccessBackupVaults ListRestoreAccessBackupVaults ***************************** class Backup.Paginator.ListRestoreAccessBackupVaults paginator = client.get_paginator('list_restore_access_backup_vaults') paginate(**kwargs) Creates an iterator that will paginate through responses from "Backup.Client.list_restore_access_backup_vaults()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( BackupVaultName='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **BackupVaultName** (*string*) -- **[REQUIRED]** The name of the backup vault for which to list associated restore access backup vaults. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'RestoreAccessBackupVaults': [ { 'RestoreAccessBackupVaultArn': 'string', 'CreationDate': datetime(2015, 1, 1), 'ApprovalDate': datetime(2015, 1, 1), 'VaultState': 'CREATING'|'AVAILABLE'|'FAILED', 'LatestRevokeRequest': { 'MpaSessionArn': 'string', 'Status': 'PENDING'|'FAILED', 'StatusMessage': 'string', 'InitiationDate': datetime(2015, 1, 1), 'ExpiryDate': datetime(2015, 1, 1) } }, ] } **Response Structure** * *(dict) --* * **RestoreAccessBackupVaults** *(list) --* A list of restore access backup vaults associated with the specified backup vault. * *(dict) --* Contains information about a restore access backup vault. * **RestoreAccessBackupVaultArn** *(string) --* The ARN of the restore access backup vault. * **CreationDate** *(datetime) --* The date and time when the restore access backup vault was created. * **ApprovalDate** *(datetime) --* The date and time when the restore access backup vault was approved. * **VaultState** *(string) --* The current state of the restore access backup vault. * **LatestRevokeRequest** *(dict) --* Information about the latest request to revoke access to this backup vault. * **MpaSessionArn** *(string) --* The ARN of the MPA session associated with this revoke request. * **Status** *(string) --* The current status of the revoke request. * **StatusMessage** *(string) --* A message describing the current status of the revoke request. * **InitiationDate** *(datetime) --* The date and time when the revoke request was initiated. * **ExpiryDate** *(datetime) --* The date and time when the revoke request will expire. Backup / Paginator / ListLegalHolds ListLegalHolds ************** class Backup.Paginator.ListLegalHolds paginator = client.get_paginator('list_legal_holds') paginate(**kwargs) Creates an iterator that will paginate through responses from "Backup.Client.list_legal_holds()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max- items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'LegalHolds': [ { 'Title': 'string', 'Status': 'CREATING'|'ACTIVE'|'CANCELING'|'CANCELED', 'Description': 'string', 'LegalHoldId': 'string', 'LegalHoldArn': 'string', 'CreationDate': datetime(2015, 1, 1), 'CancellationDate': datetime(2015, 1, 1) }, ] } **Response Structure** * *(dict) --* * **LegalHolds** *(list) --* This is an array of returned legal holds, both active and previous. * *(dict) --* 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. * **Title** *(string) --* The title of a legal hold. * **Status** *(string) --* The status of the legal hold. * **Description** *(string) --* The description of a legal hold. * **LegalHoldId** *(string) --* The ID of the legal hold. * **LegalHoldArn** *(string) --* The Amazon Resource Name (ARN) of the legal hold; for example, "arn:aws:backup:us-east-1:123456789012 :recovery-point:1EB3B5E7-9EB0-435A-A80B- 108B488B0D45". * **CreationDate** *(datetime) --* The time when the legal hold was created. * **CancellationDate** *(datetime) --* The time when the legal hold was cancelled. Backup / Paginator / ListBackupPlanTemplates ListBackupPlanTemplates *********************** class Backup.Paginator.ListBackupPlanTemplates paginator = client.get_paginator('list_backup_plan_templates') paginate(**kwargs) Creates an iterator that will paginate through responses from "Backup.Client.list_backup_plan_templates()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max- items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'BackupPlanTemplatesList': [ { 'BackupPlanTemplateId': 'string', 'BackupPlanTemplateName': 'string' }, ] } **Response Structure** * *(dict) --* * **BackupPlanTemplatesList** *(list) --* An array of template list items containing metadata about your saved templates. * *(dict) --* An object specifying metadata associated with a backup plan template. * **BackupPlanTemplateId** *(string) --* Uniquely identifies a stored backup plan template. * **BackupPlanTemplateName** *(string) --* The optional display name of a backup plan template. Backup / Paginator / ListProtectedResources ListProtectedResources ********************** class Backup.Paginator.ListProtectedResources paginator = client.get_paginator('list_protected_resources') paginate(**kwargs) Creates an iterator that will paginate through responses from "Backup.Client.list_protected_resources()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max- items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'Results': [ { 'ResourceArn': 'string', 'ResourceType': 'string', 'LastBackupTime': datetime(2015, 1, 1), 'ResourceName': 'string', 'LastBackupVaultArn': 'string', 'LastRecoveryPointArn': 'string' }, ], } **Response Structure** * *(dict) --* * **Results** *(list) --* 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. * *(dict) --* A structure that contains information about a backed-up resource. * **ResourceArn** *(string) --* An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type. * **ResourceType** *(string) --* 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** *(datetime) --* 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** *(string) --* The non-unique name of the resource that belongs to the specified backup. * **LastBackupVaultArn** *(string) --* The ARN (Amazon Resource Name) of the backup vault that contains the most recent backup recovery point. * **LastRecoveryPointArn** *(string) --* The ARN (Amazon Resource Name) of the most recent recovery point. Backup / Client / list_protected_resources list_protected_resources ************************ Backup.Client.list_protected_resources(**kwargs) 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. See also: AWS API Documentation **Request Syntax** response = client.list_protected_resources( NextToken='string', MaxResults=123 ) Parameters: * **NextToken** (*string*) -- 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. * **MaxResults** (*integer*) -- The maximum number of items to be returned. Return type: dict Returns: **Response Syntax** { 'Results': [ { 'ResourceArn': 'string', 'ResourceType': 'string', 'LastBackupTime': datetime(2015, 1, 1), 'ResourceName': 'string', 'LastBackupVaultArn': 'string', 'LastRecoveryPointArn': 'string' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **Results** *(list) --* 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. * *(dict) --* A structure that contains information about a backed-up resource. * **ResourceArn** *(string) --* An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type. * **ResourceType** *(string) --* 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** *(datetime) --* 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** *(string) --* The non-unique name of the resource that belongs to the specified backup. * **LastBackupVaultArn** *(string) --* The ARN (Amazon Resource Name) of the backup vault that contains the most recent backup recovery point. * **LastRecoveryPointArn** *(string) --* The ARN (Amazon Resource Name) of the most recent recovery point. * **NextToken** *(string) --* 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. **Exceptions** * "Backup.Client.exceptions.InvalidParameterValueException" * "Backup.Client.exceptions.ServiceUnavailableException" Backup / Client / create_restore_testing_plan create_restore_testing_plan *************************** Backup.Client.create_restore_testing_plan(**kwargs) Creates a restore testing plan. The first of two steps to create a restore testing plan. After this request is successful, finish the procedure using CreateRestoreTestingSelection. See also: AWS API Documentation **Request Syntax** response = client.create_restore_testing_plan( CreatorRequestId='string', RestoreTestingPlan={ 'RecoveryPointSelection': { 'Algorithm': 'LATEST_WITHIN_WINDOW'|'RANDOM_WITHIN_WINDOW', 'ExcludeVaults': [ 'string', ], 'IncludeVaults': [ 'string', ], 'RecoveryPointTypes': [ 'CONTINUOUS'|'SNAPSHOT', ], 'SelectionWindowDays': 123 }, 'RestoreTestingPlanName': 'string', 'ScheduleExpression': 'string', 'ScheduleExpressionTimezone': 'string', 'StartWindowHours': 123 }, Tags={ 'string': 'string' } ) Parameters: * **CreatorRequestId** (*string*) -- 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** (*dict*) -- **[REQUIRED]** 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. * **RecoveryPointSelection** *(dict) --* **[REQUIRED]** "RecoveryPointSelection" has five parameters (three required and two optional). The values you specify determine which recovery point is included in the restore test. You must indicate with "Algorithm" if you want the latest recovery point within your "SelectionWindowDays" or if you want a random recovery point, and you must indicate through "IncludeVaults" from which vaults the recovery points can be chosen. "Algorithm" (*required*) Valid values: " "LATEST_WITHIN_WINDOW"" or " "RANDOM_WITHIN_WINDOW"". "Recovery point types" (*required*) Valid values: " "SNAPSHOT"" and/or " "CONTINUOUS"". Include "SNAPSHOT" to restore only snapshot recovery points; include "CONTINUOUS" to restore continuous recovery points (point in time restore / PITR); use both to restore either a snapshot or a continuous recovery point. The recovery point will be determined by the value for "Algorithm". "IncludeVaults" (*required*). You must include one or more backup vaults. Use the wildcard ["*"] or specific ARNs. "SelectionWindowDays" (*optional*) Value must be an integer (in days) from 1 to 365. If not included, the value defaults to "30". "ExcludeVaults" (*optional*). You can choose to input one or more specific backup vault ARNs to exclude those vaults' contents from restore eligibility. Or, you can include a list of selectors. If this parameter and its value are not included, it defaults to empty list. * **Algorithm** *(string) --* Acceptable values include "LATEST_WITHIN_WINDOW" or "RANDOM_WITHIN_WINDOW" * **ExcludeVaults** *(list) --* Accepted values include specific ARNs or list of selectors. Defaults to empty list if not listed. * *(string) --* * **IncludeVaults** *(list) --* 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->>*<<", ...] * *(string) --* * **RecoveryPointTypes** *(list) --* These are the types of recovery points. Include "SNAPSHOT" to restore only snapshot recovery points; include "CONTINUOUS" to restore continuous recovery points (point in time restore / PITR); use both to restore either a snapshot or a continuous recovery point. The recovery point will be determined by the value for "Algorithm". * *(string) --* * **SelectionWindowDays** *(integer) --* Accepted values are integers from 1 to 365. * **RestoreTestingPlanName** *(string) --* **[REQUIRED]** 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** *(string) --* **[REQUIRED]** A CRON expression in specified timezone when a restore testing plan is executed. When no CRON expression is provided, Backup will use the default expression "cron(0 5 ? * * *)". * **ScheduleExpressionTimezone** *(string) --* 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** *(integer) --* 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). * **Tags** (*dict*) -- The tags to assign to the restore testing plan. * *(string) --* * *(string) --* Return type: dict Returns: **Response Syntax** { 'CreationTime': datetime(2015, 1, 1), 'RestoreTestingPlanArn': 'string', 'RestoreTestingPlanName': 'string' } **Response Structure** * *(dict) --* * **CreationTime** *(datetime) --* 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** *(string) --* An Amazon Resource Name (ARN) that uniquely identifies the created restore testing plan. * **RestoreTestingPlanName** *(string) --* 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. **Exceptions** * "Backup.Client.exceptions.AlreadyExistsException" * "Backup.Client.exceptions.ConflictException" * "Backup.Client.exceptions.InvalidParameterValueException" * "Backup.Client.exceptions.LimitExceededException" * "Backup.Client.exceptions.MissingParameterValueException" * "Backup.Client.exceptions.ServiceUnavailableException" Backup / Client / start_report_job start_report_job **************** Backup.Client.start_report_job(**kwargs) Starts an on-demand report job for the specified report plan. See also: AWS API Documentation **Request Syntax** response = client.start_report_job( ReportPlanName='string', IdempotencyToken='string' ) Parameters: * **ReportPlanName** (*string*) -- **[REQUIRED]** The unique name of a report plan. * **IdempotencyToken** (*string*) -- 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. This field is autopopulated if not provided. Return type: dict Returns: **Response Syntax** { 'ReportJobId': 'string' } **Response Structure** * *(dict) --* * **ReportJobId** *(string) --* 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. **Exceptions** * "Backup.Client.exceptions.InvalidParameterValueException" * "Backup.Client.exceptions.ServiceUnavailableException" * "Backup.Client.exceptions.MissingParameterValueException" * "Backup.Client.exceptions.ResourceNotFoundException" Backup / Client / get_paginator get_paginator ************* Backup.Client.get_paginator(operation_name) Create a paginator for an operation. Parameters: **operation_name** (*string*) -- The operation name. This is the same name as the method name on the client. For example, if the method name is "create_foo", and you'd normally invoke the operation as "client.create_foo(**kwargs)", if the "create_foo" operation can be paginated, you can use the call "client.get_paginator("create_foo")". Raises: **OperationNotPageableError** -- Raised if the operation is not pageable. You can use the "client.can_paginate" method to check if an operation is pageable. Return type: "botocore.paginate.Paginator" Returns: A paginator object. Backup / Client / describe_recovery_point describe_recovery_point *********************** Backup.Client.describe_recovery_point(**kwargs) Returns metadata associated with a recovery point, including ID, status, encryption, and lifecycle. See also: AWS API Documentation **Request Syntax** response = client.describe_recovery_point( BackupVaultName='string', RecoveryPointArn='string', BackupVaultAccountId='string' ) Parameters: * **BackupVaultName** (*string*) -- **[REQUIRED]** 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. * **RecoveryPointArn** (*string*) -- **[REQUIRED]** 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". * **BackupVaultAccountId** (*string*) -- The account ID of the specified backup vault. Return type: dict Returns: **Response Syntax** { 'RecoveryPointArn': 'string', 'BackupVaultName': 'string', 'BackupVaultArn': 'string', 'SourceBackupVaultArn': 'string', 'ResourceArn': 'string', 'ResourceType': 'string', 'CreatedBy': { 'BackupPlanId': 'string', 'BackupPlanArn': 'string', 'BackupPlanVersion': 'string', 'BackupRuleId': 'string' }, 'IamRoleArn': 'string', 'Status': 'COMPLETED'|'PARTIAL'|'DELETING'|'EXPIRED'|'AVAILABLE'|'STOPPED'|'CREATING', 'StatusMessage': 'string', 'CreationDate': datetime(2015, 1, 1), 'InitiationDate': datetime(2015, 1, 1), 'CompletionDate': datetime(2015, 1, 1), 'BackupSizeInBytes': 123, 'CalculatedLifecycle': { 'MoveToColdStorageAt': datetime(2015, 1, 1), 'DeleteAt': datetime(2015, 1, 1) }, 'Lifecycle': { 'MoveToColdStorageAfterDays': 123, 'DeleteAfterDays': 123, 'OptInToArchiveForSupportedResources': True|False }, 'EncryptionKeyArn': 'string', 'IsEncrypted': True|False, 'StorageClass': 'WARM'|'COLD'|'DELETED', 'LastRestoreTime': datetime(2015, 1, 1), 'ParentRecoveryPointArn': 'string', 'CompositeMemberIdentifier': 'string', 'IsParent': True|False, 'ResourceName': 'string', 'VaultType': 'BACKUP_VAULT'|'LOGICALLY_AIR_GAPPED_BACKUP_VAULT'|'RESTORE_ACCESS_BACKUP_VAULT', 'IndexStatus': 'PENDING'|'ACTIVE'|'FAILED'|'DELETING', 'IndexStatusMessage': 'string' } **Response Structure** * *(dict) --* * **RecoveryPointArn** *(string) --* 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** *(string) --* 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. * **BackupVaultArn** *(string) --* An ARN that uniquely identifies a backup vault; for example, "arn:aws:backup:us-east-1:123456789012:backup- vault:aBackupVault". * **SourceBackupVaultArn** *(string) --* 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:backup- vault:aBackupVault". If the recovery is restored to the same Amazon Web Services account or Region, this value will be "null". * **ResourceArn** *(string) --* An ARN that uniquely identifies a saved resource. The format of the ARN depends on the resource type. * **ResourceType** *(string) --* 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** *(dict) --* 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. * **BackupPlanId** *(string) --* Uniquely identifies a backup plan. * **BackupPlanArn** *(string) --* 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** *(string) --* Version IDs are unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes long. They cannot be edited. * **BackupRuleId** *(string) --* Uniquely identifies a rule used to schedule the backup of a selection of resources. * **IamRoleArn** *(string) --* Specifies the IAM role ARN used to create the target recovery point; for example, "arn:aws:iam::123456789012:role/S3Access". * **Status** *(string) --* A status code specifying the state of the recovery point. For more information, see Recovery point status in the *Backup Developer Guide*. * "CREATING" status indicates that an Backup job has been initiated for a resource. The backup process has started and is actively processing a backup job for the associated recovery point. * "AVAILABLE" status indicates that the backup was successfully created for the recovery point. The backup process has completed without any issues, and the recovery point is now ready for use. * "PARTIAL" status indicates a composite recovery point has one or more nested recovery points that were not in the backup. * "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. For recovery points of Amazon S3, Amazon RDS, and Amazon Aurora resources, this status occurs when the retention period of a continuous backup rule is changed. 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** *(string) --* A status message explaining the status of the recovery point. * **CreationDate** *(datetime) --* 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. * **InitiationDate** *(datetime) --* The date and time when the backup job that created this recovery point was initiated, in Unix format and Coordinated Universal Time (UTC). * **CompletionDate** *(datetime) --* 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** *(integer) --* The size, in bytes, of a backup. * **CalculatedLifecycle** *(dict) --* A "CalculatedLifecycle" object containing "DeleteAt" and "MoveToColdStorageAt" timestamps. * **MoveToColdStorageAt** *(datetime) --* A timestamp that specifies when to transition a recovery point to cold storage. * **DeleteAt** *(datetime) --* A timestamp that specifies when to delete a recovery point. * **Lifecycle** *(dict) --* 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 can transition to cold storage are listed in the Feature availability by resource table. Backup ignores this expression for other resource types. * **MoveToColdStorageAfterDays** *(integer) --* The number of days after creation that a recovery point is moved to cold storage. * **DeleteAfterDays** *(integer) --* The number of days after creation that a recovery point is deleted. This value must be at least 90 days after the number of days specified in "MoveToColdStorageAfterDays". * **OptInToArchiveForSupportedResources** *(boolean) --* If the value is true, your backup plan transitions supported resources to archive (cold) storage tier in accordance with your lifecycle settings. * **EncryptionKeyArn** *(string) --* 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** *(boolean) --* 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** *(string) --* Specifies the storage class of the recovery point. Valid values are "WARM" or "COLD". * **LastRestoreTime** *(datetime) --* 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** *(string) --* 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** *(string) --* 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** *(boolean) --* This returns the boolean value that a recovery point is a parent (composite) job. * **ResourceName** *(string) --* The name of the resource that belongs to the specified backup. * **VaultType** *(string) --* The type of vault in which the described recovery point is stored. * **IndexStatus** *(string) --* This is the current status for the backup index associated with the specified recovery point. Statuses are: "PENDING" | "ACTIVE" | "FAILED" | "DELETING" A recovery point with an index that has the status of "ACTIVE" can be included in a search. * **IndexStatusMessage** *(string) --* A string in the form of a detailed message explaining the status of a backup index associated with the recovery point. **Exceptions** * "Backup.Client.exceptions.ResourceNotFoundException" * "Backup.Client.exceptions.InvalidParameterValueException" * "Backup.Client.exceptions.MissingParameterValueException" * "Backup.Client.exceptions.ServiceUnavailableException" Backup / Client / create_framework create_framework **************** Backup.Client.create_framework(**kwargs) 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. See also: AWS API Documentation **Request Syntax** response = client.create_framework( FrameworkName='string', FrameworkDescription='string', FrameworkControls=[ { 'ControlName': 'string', 'ControlInputParameters': [ { 'ParameterName': 'string', 'ParameterValue': 'string' }, ], 'ControlScope': { 'ComplianceResourceIds': [ 'string', ], 'ComplianceResourceTypes': [ 'string', ], 'Tags': { 'string': 'string' } } }, ], IdempotencyToken='string', FrameworkTags={ 'string': 'string' } ) Parameters: * **FrameworkName** (*string*) -- **[REQUIRED]** 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** (*string*) -- An optional description of the framework with a maximum of 1,024 characters. * **FrameworkControls** (*list*) -- **[REQUIRED]** The controls that make up the framework. Each control in the list has a name, input parameters, and scope. * *(dict) --* Contains detailed information about all of the controls of a framework. Each framework must contain at least one control. * **ControlName** *(string) --* **[REQUIRED]** The name of a control. This name is between 1 and 256 characters. * **ControlInputParameters** *(list) --* The name/value pairs. * *(dict) --* The parameters for a control. A control can have zero, one, or more than one parameter. An example of a control with two parameters is: "backup plan frequency is at least "daily" and the retention period is at least "1 year"". The first parameter is "daily". The second parameter is "1 year". * **ParameterName** *(string) --* The name of a parameter, for example, "BackupPlanFrequency". * **ParameterValue** *(string) --* The value of parameter, for example, "hourly". * **ControlScope** *(dict) --* 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. * **ComplianceResourceIds** *(list) --* The ID of the only Amazon Web Services resource that you want your control scope to contain. * *(string) --* * **ComplianceResourceTypes** *(list) --* Describes whether the control scope includes one or more types of resources, such as "EFS" or "RDS". * *(string) --* * **Tags** *(dict) --* 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 if you are creating or editing a framework from the console (though the value can be an empty string when included in a CloudFormation template). The structure to assign a tag is: "[{"Key":"string","Value":"string"}]". * *(string) --* * *(string) --* * **IdempotencyToken** (*string*) -- 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. This field is autopopulated if not provided. * **FrameworkTags** (*dict*) -- The tags to assign to the framework. * *(string) --* * *(string) --* Return type: dict Returns: **Response Syntax** { 'FrameworkName': 'string', 'FrameworkArn': 'string' } **Response Structure** * *(dict) --* * **FrameworkName** *(string) --* 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** *(string) --* An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type. **Exceptions** * "Backup.Client.exceptions.AlreadyExistsException" * "Backup.Client.exceptions.LimitExceededException" * "Backup.Client.exceptions.InvalidParameterValueException" * "Backup.Client.exceptions.MissingParameterValueException" * "Backup.Client.exceptions.ServiceUnavailableException" Backup / Client / describe_backup_vault describe_backup_vault ********************* Backup.Client.describe_backup_vault(**kwargs) Returns metadata about a backup vault specified by its name. See also: AWS API Documentation **Request Syntax** response = client.describe_backup_vault( BackupVaultName='string', BackupVaultAccountId='string' ) Parameters: * **BackupVaultName** (*string*) -- **[REQUIRED]** 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. * **BackupVaultAccountId** (*string*) -- The account ID of the specified backup vault. Return type: dict Returns: **Response Syntax** { 'BackupVaultName': 'string', 'BackupVaultArn': 'string', 'VaultType': 'BACKUP_VAULT'|'LOGICALLY_AIR_GAPPED_BACKUP_VAULT'|'RESTORE_ACCESS_BACKUP_VAULT', 'VaultState': 'CREATING'|'AVAILABLE'|'FAILED', 'EncryptionKeyArn': 'string', 'CreationDate': datetime(2015, 1, 1), 'CreatorRequestId': 'string', 'NumberOfRecoveryPoints': 123, 'Locked': True|False, 'MinRetentionDays': 123, 'MaxRetentionDays': 123, 'LockDate': datetime(2015, 1, 1), 'SourceBackupVaultArn': 'string', 'MpaApprovalTeamArn': 'string', 'MpaSessionArn': 'string', 'LatestMpaApprovalTeamUpdate': { 'MpaSessionArn': 'string', 'Status': 'PENDING'|'APPROVED'|'FAILED', 'StatusMessage': 'string', 'InitiationDate': datetime(2015, 1, 1), 'ExpiryDate': datetime(2015, 1, 1) } } **Response Structure** * *(dict) --* * **BackupVaultName** *(string) --* 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. * **BackupVaultArn** *(string) --* An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, "arn:aws:backup:us- east-1:123456789012:backup-vault:aBackupVault". * **VaultType** *(string) --* The type of vault described. * **VaultState** *(string) --* The current state of the vault.-> * **EncryptionKeyArn** *(string) --* 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** *(datetime) --* 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** *(string) --* 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** *(integer) --* The number of recovery points that are stored in a backup vault. Recovery point count value displayed in the console can be an approximation. Use ListRecoveryPointsByBackupVault API to obtain the exact count. * **Locked** *(boolean) --* 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** *(integer) --* 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 will 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** *(integer) --* 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** *(datetime) --* 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. * **SourceBackupVaultArn** *(string) --* The ARN of the source backup vault from which this restore access backup vault was created. * **MpaApprovalTeamArn** *(string) --* The ARN of the MPA approval team associated with this backup vault. * **MpaSessionArn** *(string) --* The ARN of the MPA session associated with this backup vault. * **LatestMpaApprovalTeamUpdate** *(dict) --* Information about the latest update to the MPA approval team association for this backup vault. * **MpaSessionArn** *(string) --* The ARN of the MPA session associated with this update. * **Status** *(string) --* The current status of the MPA approval team update. * **StatusMessage** *(string) --* A message describing the current status of the MPA approval team update. * **InitiationDate** *(datetime) --* The date and time when the MPA approval team update was initiated. * **ExpiryDate** *(datetime) --* The date and time when the MPA approval team update will expire. **Exceptions** * "Backup.Client.exceptions.ResourceNotFoundException" * "Backup.Client.exceptions.InvalidParameterValueException" * "Backup.Client.exceptions.MissingParameterValueException" * "Backup.Client.exceptions.ServiceUnavailableException" Backup / Client / list_indexed_recovery_points list_indexed_recovery_points **************************** Backup.Client.list_indexed_recovery_points(**kwargs) This operation returns a list of recovery points that have an associated index, belonging to the specified account. Optional parameters you can include are: MaxResults; NextToken; SourceResourceArns; CreatedBefore; CreatedAfter; and ResourceType. See also: AWS API Documentation **Request Syntax** response = client.list_indexed_recovery_points( NextToken='string', MaxResults=123, SourceResourceArn='string', CreatedBefore=datetime(2015, 1, 1), CreatedAfter=datetime(2015, 1, 1), ResourceType='string', IndexStatus='PENDING'|'ACTIVE'|'FAILED'|'DELETING' ) Parameters: * **NextToken** (*string*) -- The next item following a partial list of returned recovery points. For example, if a request is made to return "MaxResults" number of indexed recovery points, "NextToken" allows you to return more items in your list starting at the location pointed to by the next token. * **MaxResults** (*integer*) -- The maximum number of resource list items to be returned. * **SourceResourceArn** (*string*) -- A string of the Amazon Resource Name (ARN) that uniquely identifies the source resource. * **CreatedBefore** (*datetime*) -- Returns only indexed recovery points that were created before the specified date. * **CreatedAfter** (*datetime*) -- Returns only indexed recovery points that were created after the specified date. * **ResourceType** (*string*) -- Returns a list of indexed recovery points for the specified resource type(s). Accepted values include: * "EBS" for Amazon Elastic Block Store * "S3" for Amazon Simple Storage Service (Amazon S3) * **IndexStatus** (*string*) -- Include this parameter to filter the returned list by the indicated statuses. Accepted values: "PENDING" | "ACTIVE" | "FAILED" | "DELETING" A recovery point with an index that has the status of "ACTIVE" can be included in a search. Return type: dict Returns: **Response Syntax** { 'IndexedRecoveryPoints': [ { 'RecoveryPointArn': 'string', 'SourceResourceArn': 'string', 'IamRoleArn': 'string', 'BackupCreationDate': datetime(2015, 1, 1), 'ResourceType': 'string', 'IndexCreationDate': datetime(2015, 1, 1), 'IndexStatus': 'PENDING'|'ACTIVE'|'FAILED'|'DELETING', 'IndexStatusMessage': 'string', 'BackupVaultArn': 'string' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **IndexedRecoveryPoints** *(list) --* This is a list of recovery points that have an associated index, belonging to the specified account. * *(dict) --* This is a recovery point that has an associated backup index. Only recovery points with a backup index can be included in a search. * **RecoveryPointArn** *(string) --* An ARN that uniquely identifies a recovery point; for example, "arn:aws:backup:us-east-1:123456789012 :recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45" * **SourceResourceArn** *(string) --* A string of the Amazon Resource Name (ARN) that uniquely identifies the source resource. * **IamRoleArn** *(string) --* This specifies the IAM role ARN used for this operation. For example, arn:aws:iam::123456789012:role/S3Access * **BackupCreationDate** *(datetime) --* The date and time that a backup was 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. * **ResourceType** *(string) --* The resource type of the indexed recovery point. * "EBS" for Amazon Elastic Block Store * "S3" for Amazon Simple Storage Service (Amazon S3) * **IndexCreationDate** *(datetime) --* The date and time that a backup index was 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. * **IndexStatus** *(string) --* This is the current status for the backup index associated with the specified recovery point. Statuses are: "PENDING" | "ACTIVE" | "FAILED" | "DELETING" A recovery point with an index that has the status of "ACTIVE" can be included in a search. * **IndexStatusMessage** *(string) --* A string in the form of a detailed message explaining the status of a backup index associated with the recovery point. * **BackupVaultArn** *(string) --* An ARN that uniquely identifies the backup vault where the recovery point index is stored. For example, "arn:aws:backup:us-east-1:123456789012 :backup-vault:aBackupVault". * **NextToken** *(string) --* The next item following a partial list of returned recovery points. For example, if a request is made to return "MaxResults" number of indexed recovery points, "NextToken" allows you to return more items in your list starting at the location pointed to by the next token. **Exceptions** * "Backup.Client.exceptions.InvalidParameterValueException" * "Backup.Client.exceptions.ResourceNotFoundException" * "Backup.Client.exceptions.ServiceUnavailableException" Backup / Client / get_recovery_point_restore_metadata get_recovery_point_restore_metadata *********************************** Backup.Client.get_recovery_point_restore_metadata(**kwargs) Returns a set of metadata key-value pairs that were used to create the backup. See also: AWS API Documentation **Request Syntax** response = client.get_recovery_point_restore_metadata( BackupVaultName='string', RecoveryPointArn='string', BackupVaultAccountId='string' ) Parameters: * **BackupVaultName** (*string*) -- **[REQUIRED]** 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. * **RecoveryPointArn** (*string*) -- **[REQUIRED]** 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". * **BackupVaultAccountId** (*string*) -- The account ID of the specified backup vault. Return type: dict Returns: **Response Syntax** { 'BackupVaultArn': 'string', 'RecoveryPointArn': 'string', 'RestoreMetadata': { 'string': 'string' }, 'ResourceType': 'string' } **Response Structure** * *(dict) --* * **BackupVaultArn** *(string) --* An ARN that uniquely identifies a backup vault; for example, "arn:aws:backup:us-east-1:123456789012:backup- vault:aBackupVault". * **RecoveryPointArn** *(string) --* 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** *(dict) --* 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. * *(string) --* * *(string) --* * **ResourceType** *(string) --* The resource type of the recovery point. **Exceptions** * "Backup.Client.exceptions.ResourceNotFoundException" * "Backup.Client.exceptions.InvalidParameterValueException" * "Backup.Client.exceptions.MissingParameterValueException" * "Backup.Client.exceptions.ServiceUnavailableException" Backup / Client / start_restore_job start_restore_job ***************** Backup.Client.start_restore_job(**kwargs) Recovers the saved resource identified by an Amazon Resource Name (ARN). See also: AWS API Documentation **Request Syntax** response = client.start_restore_job( RecoveryPointArn='string', Metadata={ 'string': 'string' }, IamRoleArn='string', IdempotencyToken='string', ResourceType='string', CopySourceTagsToRestoredResource=True|False ) Parameters: * **RecoveryPointArn** (*string*) -- **[REQUIRED]** 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** (*dict*) -- **[REQUIRED]** A set of metadata key-value pairs. 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. For more information about the metadata for each resource, see the following: * Metadata for Amazon Aurora * Metadata for Amazon DocumentDB * Metadata for CloudFormation * Metadata for Amazon DynamoDB * Metadata for Amazon EBS * Metadata for Amazon EC2 * Metadata for Amazon EFS * Metadata for Amazon FSx * Metadata for Amazon Neptune * Metadata for Amazon RDS * Metadata for Amazon Redshift * Metadata for Storage Gateway * Metadata for Amazon S3 * Metadata for Amazon Timestream * Metadata for virtual machines * *(string) --* * *(string) --* * **IamRoleArn** (*string*) -- 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** (*string*) -- 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. This field is autopopulated if not provided. * **ResourceType** (*string*) -- Starts a job to restore a recovery point for one of the following resources: * "Aurora" - Amazon Aurora * "DocumentDB" - Amazon DocumentDB * "CloudFormation" - CloudFormation * "DynamoDB" - Amazon DynamoDB * "EBS" - Amazon Elastic Block Store * "EC2" - Amazon Elastic Compute Cloud * "EFS" - Amazon Elastic File System * "FSx" - Amazon FSx * "Neptune" - Amazon Neptune * "RDS" - Amazon Relational Database Service * "Redshift" - Amazon Redshift * "Storage Gateway" - Storage Gateway * "S3" - Amazon Simple Storage Service * "Timestream" - Amazon Timestream * "VirtualMachine" - Virtual machines * **CopySourceTagsToRestoredResource** (*boolean*) -- 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. Return type: dict Returns: **Response Syntax** { 'RestoreJobId': 'string' } **Response Structure** * *(dict) --* * **RestoreJobId** *(string) --* Uniquely identifies the job that restores a recovery point. **Exceptions** * "Backup.Client.exceptions.ResourceNotFoundException" * "Backup.Client.exceptions.InvalidParameterValueException" * "Backup.Client.exceptions.MissingParameterValueException" * "Backup.Client.exceptions.ServiceUnavailableException" * "Backup.Client.exceptions.InvalidRequestException" Backup / Client / list_recovery_points_by_backup_vault list_recovery_points_by_backup_vault ************************************ Backup.Client.list_recovery_points_by_backup_vault(**kwargs) Returns detailed information about the recovery points stored in a backup vault. See also: AWS API Documentation **Request Syntax** response = client.list_recovery_points_by_backup_vault( BackupVaultName='string', BackupVaultAccountId='string', NextToken='string', MaxResults=123, ByResourceArn='string', ByResourceType='string', ByBackupPlanId='string', ByCreatedBefore=datetime(2015, 1, 1), ByCreatedAfter=datetime(2015, 1, 1), ByParentRecoveryPointArn='string' ) Parameters: * **BackupVaultName** (*string*) -- **[REQUIRED]** 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. Note: Backup vault name might not be available when a supported service creates the backup. * **BackupVaultAccountId** (*string*) -- This parameter will sort the list of recovery points by account ID. * **NextToken** (*string*) -- 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. * **MaxResults** (*integer*) -- The maximum number of items to be returned. * **ByResourceArn** (*string*) -- Returns only recovery points that match the specified resource Amazon Resource Name (ARN). * **ByResourceType** (*string*) -- Returns only recovery points that match the specified resource type(s): * "Aurora" for Amazon Aurora * "CloudFormation" for CloudFormation * "DocumentDB" for Amazon DocumentDB (with MongoDB compatibility) * "DynamoDB" for Amazon DynamoDB * "EBS" for Amazon Elastic Block Store * "EC2" for Amazon Elastic Compute Cloud * "EFS" for Amazon Elastic File System * "FSx" for Amazon FSx * "Neptune" for Amazon Neptune * "RDS" for Amazon Relational Database Service * "Redshift" for Amazon Redshift * "S3" for Amazon Simple Storage Service (Amazon S3) * "SAP HANA on Amazon EC2" for SAP HANA databases on Amazon Elastic Compute Cloud instances * "Storage Gateway" for Storage Gateway * "Timestream" for Amazon Timestream * "VirtualMachine" for VMware virtual machines * **ByBackupPlanId** (*string*) -- Returns only recovery points that match the specified backup plan ID. * **ByCreatedBefore** (*datetime*) -- Returns only recovery points that were created before the specified timestamp. * **ByCreatedAfter** (*datetime*) -- Returns only recovery points that were created after the specified timestamp. * **ByParentRecoveryPointArn** (*string*) -- This returns only recovery points that match the specified parent (composite) recovery point Amazon Resource Name (ARN). Return type: dict Returns: **Response Syntax** { 'NextToken': 'string', 'RecoveryPoints': [ { 'RecoveryPointArn': 'string', 'BackupVaultName': 'string', 'BackupVaultArn': 'string', 'SourceBackupVaultArn': 'string', 'ResourceArn': 'string', 'ResourceType': 'string', 'CreatedBy': { 'BackupPlanId': 'string', 'BackupPlanArn': 'string', 'BackupPlanVersion': 'string', 'BackupRuleId': 'string' }, 'IamRoleArn': 'string', 'Status': 'COMPLETED'|'PARTIAL'|'DELETING'|'EXPIRED'|'AVAILABLE'|'STOPPED'|'CREATING', 'StatusMessage': 'string', 'CreationDate': datetime(2015, 1, 1), 'InitiationDate': datetime(2015, 1, 1), 'CompletionDate': datetime(2015, 1, 1), 'BackupSizeInBytes': 123, 'CalculatedLifecycle': { 'MoveToColdStorageAt': datetime(2015, 1, 1), 'DeleteAt': datetime(2015, 1, 1) }, 'Lifecycle': { 'MoveToColdStorageAfterDays': 123, 'DeleteAfterDays': 123, 'OptInToArchiveForSupportedResources': True|False }, 'EncryptionKeyArn': 'string', 'IsEncrypted': True|False, 'LastRestoreTime': datetime(2015, 1, 1), 'ParentRecoveryPointArn': 'string', 'CompositeMemberIdentifier': 'string', 'IsParent': True|False, 'ResourceName': 'string', 'VaultType': 'BACKUP_VAULT'|'LOGICALLY_AIR_GAPPED_BACKUP_VAULT'|'RESTORE_ACCESS_BACKUP_VAULT', 'IndexStatus': 'PENDING'|'ACTIVE'|'FAILED'|'DELETING', 'IndexStatusMessage': 'string' }, ] } **Response Structure** * *(dict) --* * **NextToken** *(string) --* 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** *(list) --* An array of objects that contain detailed information about recovery points saved in a backup vault. * *(dict) --* Contains detailed information about the recovery points stored in a backup vault. * **RecoveryPointArn** *(string) --* 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** *(string) --* 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. * **BackupVaultArn** *(string) --* An ARN that uniquely identifies a backup vault; for example, "arn:aws:backup:us-east-1:123456789012:backup- vault:aBackupVault". * **SourceBackupVaultArn** *(string) --* 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** *(string) --* An ARN that uniquely identifies a resource. The format of the ARN depends on the resource type. * **ResourceType** *(string) --* 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** *(dict) --* 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. * **BackupPlanId** *(string) --* Uniquely identifies a backup plan. * **BackupPlanArn** *(string) --* 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** *(string) --* Version IDs are unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes long. They cannot be edited. * **BackupRuleId** *(string) --* Uniquely identifies a rule used to schedule the backup of a selection of resources. * **IamRoleArn** *(string) --* Specifies the IAM role ARN used to create the target recovery point; for example, "arn:aws:iam::123456789012:role/S3Access". * **Status** *(string) --* A status code specifying the state of the recovery point. * **StatusMessage** *(string) --* A message explaining the current status of the recovery point. * **CreationDate** *(datetime) --* 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. * **InitiationDate** *(datetime) --* The date and time when the backup job that created this recovery point was initiated, in Unix format and Coordinated Universal Time (UTC). * **CompletionDate** *(datetime) --* 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** *(integer) --* The size, in bytes, of a backup. * **CalculatedLifecycle** *(dict) --* A "CalculatedLifecycle" object containing "DeleteAt" and "MoveToColdStorageAt" timestamps. * **MoveToColdStorageAt** *(datetime) --* A timestamp that specifies when to transition a recovery point to cold storage. * **DeleteAt** *(datetime) --* A timestamp that specifies when to delete a recovery point. * **Lifecycle** *(dict) --* The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. Backup transitions and expires backups automatically according to the lifecycle that you define. Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, the “retention” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold. Resource types that can transition to cold storage are listed in the Feature availability by resource table. Backup ignores this expression for other resource types. * **MoveToColdStorageAfterDays** *(integer) --* The number of days after creation that a recovery point is moved to cold storage. * **DeleteAfterDays** *(integer) --* The number of days after creation that a recovery point is deleted. This value must be at least 90 days after the number of days specified in "MoveToColdStorageAfterDays". * **OptInToArchiveForSupportedResources** *(boolean) --* If the value is true, your backup plan transitions supported resources to archive (cold) storage tier in accordance with your lifecycle settings. * **EncryptionKeyArn** *(string) --* 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** *(boolean) --* 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** *(datetime) --* 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** *(string) --* The Amazon Resource Name (ARN) of the parent (composite) recovery point. * **CompositeMemberIdentifier** *(string) --* 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** *(boolean) --* This is a boolean value indicating this is a parent (composite) recovery point. * **ResourceName** *(string) --* The non-unique name of the resource that belongs to the specified backup. * **VaultType** *(string) --* The type of vault in which the described recovery point is stored. * **IndexStatus** *(string) --* This is the current status for the backup index associated with the specified recovery point. Statuses are: "PENDING" | "ACTIVE" | "FAILED" | "DELETING" A recovery point with an index that has the status of "ACTIVE" can be included in a search. * **IndexStatusMessage** *(string) --* A string in the form of a detailed message explaining the status of a backup index associated with the recovery point. **Exceptions** * "Backup.Client.exceptions.ResourceNotFoundException" * "Backup.Client.exceptions.InvalidParameterValueException" * "Backup.Client.exceptions.MissingParameterValueException" * "Backup.Client.exceptions.ServiceUnavailableException" Backup / Client / list_restore_job_summaries list_restore_job_summaries ************************** Backup.Client.list_restore_job_summaries(**kwargs) 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. See also: AWS API Documentation **Request Syntax** response = client.list_restore_job_summaries( AccountId='string', State='CREATED'|'PENDING'|'RUNNING'|'ABORTED'|'COMPLETED'|'FAILED'|'AGGREGATE_ALL'|'ANY', ResourceType='string', AggregationPeriod='ONE_DAY'|'SEVEN_DAYS'|'FOURTEEN_DAYS', MaxResults=123, NextToken='string' ) Parameters: * **AccountId** (*string*) -- 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. * **State** (*string*) -- 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. * **ResourceType** (*string*) -- 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. * **AggregationPeriod** (*string*) -- The period for the returned results. * "ONE_DAY" - The daily job count for the prior 14 days. * "SEVEN_DAYS" - The aggregated job count for the prior 7 days. * "FOURTEEN_DAYS" - The aggregated job count for prior 14 days. * **MaxResults** (*integer*) -- 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. * **NextToken** (*string*) -- 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. Return type: dict Returns: **Response Syntax** { 'RestoreJobSummaries': [ { 'Region': 'string', 'AccountId': 'string', 'State': 'CREATED'|'PENDING'|'RUNNING'|'ABORTED'|'COMPLETED'|'FAILED'|'AGGREGATE_ALL'|'ANY', 'ResourceType': 'string', 'Count': 123, 'StartTime': datetime(2015, 1, 1), 'EndTime': datetime(2015, 1, 1) }, ], 'AggregationPeriod': 'string', 'NextToken': 'string' } **Response Structure** * *(dict) --* * **RestoreJobSummaries** *(list) --* This return contains a summary that contains Region, Account, State, ResourceType, MessageCategory, StartTime, EndTime, and Count of included jobs. * *(dict) --* 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. * **Region** *(string) --* The Amazon Web Services Regions within the job summary. * **AccountId** *(string) --* The account ID that owns the jobs within the summary. * **State** *(string) --* This value is job count for jobs with the specified state. * **ResourceType** *(string) --* This value is the job count for the specified resource type. The request "GetSupportedResourceTypes" returns strings for supported resource types. * **Count** *(integer) --* The value as a number of jobs in a job summary. * **StartTime** *(datetime) --* 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** *(datetime) --* 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. * **AggregationPeriod** *(string) --* The period for the returned results. * "ONE_DAY" - The daily job count for the prior 14 days. * "SEVEN_DAYS" - The aggregated job count for the prior 7 days. * "FOURTEEN_DAYS" - The aggregated job count for prior 14 days. * **NextToken** *(string) --* 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. **Exceptions** * "Backup.Client.exceptions.InvalidParameterValueException" * "Backup.Client.exceptions.ServiceUnavailableException" Backup / Client / describe_region_settings describe_region_settings ************************ Backup.Client.describe_region_settings() 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. See also: AWS API Documentation **Request Syntax** response = client.describe_region_settings() Return type: dict Returns: **Response Syntax** { 'ResourceTypeOptInPreference': { 'string': True|False }, 'ResourceTypeManagementPreference': { 'string': True|False } } **Response Structure** * *(dict) --* * **ResourceTypeOptInPreference** *(dict) --* The services along with the opt-in preferences in the Region. * *(string) --* * *(boolean) --* * **ResourceTypeManagementPreference** *(dict) --* 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. * *(string) --* * *(boolean) --* **Exceptions** * "Backup.Client.exceptions.ServiceUnavailableException" Backup / Client / describe_copy_job describe_copy_job ***************** Backup.Client.describe_copy_job(**kwargs) Returns metadata associated with creating a copy of a resource. See also: AWS API Documentation **Request Syntax** response = client.describe_copy_job( CopyJobId='string' ) Parameters: **CopyJobId** (*string*) -- **[REQUIRED]** Uniquely identifies a copy job. Return type: dict Returns: **Response Syntax** { 'CopyJob': { 'AccountId': 'string', 'CopyJobId': 'string', 'SourceBackupVaultArn': 'string', 'SourceRecoveryPointArn': 'string', 'DestinationBackupVaultArn': 'string', 'DestinationRecoveryPointArn': 'string', 'ResourceArn': 'string', 'CreationDate': datetime(2015, 1, 1), 'CompletionDate': datetime(2015, 1, 1), 'State': 'CREATED'|'RUNNING'|'COMPLETED'|'FAILED'|'PARTIAL', 'StatusMessage': 'string', 'BackupSizeInBytes': 123, 'IamRoleArn': 'string', 'CreatedBy': { 'BackupPlanId': 'string', 'BackupPlanArn': 'string', 'BackupPlanVersion': 'string', 'BackupRuleId': 'string' }, 'ResourceType': 'string', 'ParentJobId': 'string', 'IsParent': True|False, 'CompositeMemberIdentifier': 'string', 'NumberOfChildJobs': 123, 'ChildJobsInState': { 'string': 123 }, 'ResourceName': 'string', 'MessageCategory': 'string' } } **Response Structure** * *(dict) --* * **CopyJob** *(dict) --* Contains detailed information about a copy job. * **AccountId** *(string) --* The account ID that owns the copy job. * **CopyJobId** *(string) --* Uniquely identifies a copy job. * **SourceBackupVaultArn** *(string) --* An Amazon Resource Name (ARN) that uniquely identifies a source copy vault; for example, "arn:aws:backup:us- east-1:123456789012:backup-vault:aBackupVault". * **SourceRecoveryPointArn** *(string) --* 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** *(string) --* An Amazon Resource Name (ARN) that uniquely identifies a destination copy vault; for example, "arn:aws:backup:us- east-1:123456789012:backup-vault:aBackupVault". * **DestinationRecoveryPointArn** *(string) --* 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** *(string) --* 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** *(datetime) --* 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** *(datetime) --* 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** *(string) --* The current state of a copy job. * **StatusMessage** *(string) --* A detailed message explaining the status of the job to copy a resource. * **BackupSizeInBytes** *(integer) --* The size, in bytes, of a copy job. * **IamRoleArn** *(string) --* Specifies the IAM role ARN used to copy the target recovery point; for example, "arn:aws:iam::123456789012:role/S3Access". * **CreatedBy** *(dict) --* Contains information about the backup plan and rule that Backup used to initiate the recovery point backup. * **BackupPlanId** *(string) --* Uniquely identifies a backup plan. * **BackupPlanArn** *(string) --* 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** *(string) --* Version IDs are unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes long. They cannot be edited. * **BackupRuleId** *(string) --* Uniquely identifies a rule used to schedule the backup of a selection of resources. * **ResourceType** *(string) --* 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** *(string) --* This uniquely identifies a request to Backup to copy a resource. The return will be the parent (composite) job ID. * **IsParent** *(boolean) --* This is a boolean value indicating this is a parent (composite) copy job. * **CompositeMemberIdentifier** *(string) --* 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** *(integer) --* The number of child (nested) copy jobs. * **ChildJobsInState** *(dict) --* This returns the statistics of the included child (nested) copy jobs. * *(string) --* * *(integer) --* * **ResourceName** *(string) --* The non-unique name of the resource that belongs to the specified backup. * **MessageCategory** *(string) --* 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 **Exceptions** * "Backup.Client.exceptions.ResourceNotFoundException" * "Backup.Client.exceptions.InvalidParameterValueException" * "Backup.Client.exceptions.MissingParameterValueException" * "Backup.Client.exceptions.ServiceUnavailableException" Backup / Client / start_backup_job start_backup_job **************** Backup.Client.start_backup_job(**kwargs) Starts an on-demand backup job for the specified resource. See also: AWS API Documentation **Request Syntax** response = client.start_backup_job( BackupVaultName='string', ResourceArn='string', IamRoleArn='string', IdempotencyToken='string', StartWindowMinutes=123, CompleteWindowMinutes=123, Lifecycle={ 'MoveToColdStorageAfterDays': 123, 'DeleteAfterDays': 123, 'OptInToArchiveForSupportedResources': True|False }, RecoveryPointTags={ 'string': 'string' }, BackupOptions={ 'string': 'string' }, Index='ENABLED'|'DISABLED' ) Parameters: * **BackupVaultName** (*string*) -- **[REQUIRED]** 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. * **ResourceArn** (*string*) -- **[REQUIRED]** An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type. * **IamRoleArn** (*string*) -- **[REQUIRED]** Specifies the IAM role ARN used to create the target recovery point; for example, "arn:aws:iam::123456789012:role/S3Access". * **IdempotencyToken** (*string*) -- 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. This field is autopopulated if not provided. * **StartWindowMinutes** (*integer*) -- 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** (*integer*) -- 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** (*dict*) -- 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 can transition to cold storage are listed in 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). * **MoveToColdStorageAfterDays** *(integer) --* The number of days after creation that a recovery point is moved to cold storage. * **DeleteAfterDays** *(integer) --* The number of days after creation that a recovery point is deleted. This value must be at least 90 days after the number of days specified in "MoveToColdStorageAfterDays". * **OptInToArchiveForSupportedResources** *(boolean) --* If the value is true, your backup plan transitions supported resources to archive (cold) storage tier in accordance with your lifecycle settings. * **RecoveryPointTags** (*dict*) -- The tags to assign to the resources. * *(string) --* * *(string) --* * **BackupOptions** (*dict*) -- 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. * *(string) --* * *(string) --* * **Index** (*string*) -- Include this parameter to enable index creation if your backup job has a resource type that supports backup indexes. Resource types that support backup indexes include: * "EBS" for Amazon Elastic Block Store * "S3" for Amazon Simple Storage Service (Amazon S3) Index can have 1 of 2 possible values, either "ENABLED" or "DISABLED". To create a backup index for an eligible "ACTIVE" recovery point that does not yet have a backup index, set value to "ENABLED". To delete a backup index, set value to "DISABLED". Return type: dict Returns: **Response Syntax** { 'BackupJobId': 'string', 'RecoveryPointArn': 'string', 'CreationDate': datetime(2015, 1, 1), 'IsParent': True|False } **Response Structure** * *(dict) --* * **BackupJobId** *(string) --* Uniquely identifies a request to Backup to back up a resource. * **RecoveryPointArn** *(string) --* *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** *(datetime) --* 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** *(boolean) --* This is a returned boolean value indicating this is a parent (composite) backup job. **Exceptions** * "Backup.Client.exceptions.ResourceNotFoundException" * "Backup.Client.exceptions.InvalidParameterValueException" * "Backup.Client.exceptions.MissingParameterValueException" * "Backup.Client.exceptions.InvalidRequestException" * "Backup.Client.exceptions.ServiceUnavailableException" * "Backup.Client.exceptions.LimitExceededException" Backup / Client / list_backup_selections list_backup_selections ********************** Backup.Client.list_backup_selections(**kwargs) Returns an array containing metadata of the resources associated with the target backup plan. See also: AWS API Documentation **Request Syntax** response = client.list_backup_selections( BackupPlanId='string', NextToken='string', MaxResults=123 ) Parameters: * **BackupPlanId** (*string*) -- **[REQUIRED]** Uniquely identifies a backup plan. * **NextToken** (*string*) -- 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. * **MaxResults** (*integer*) -- The maximum number of items to be returned. Return type: dict Returns: **Response Syntax** { 'NextToken': 'string', 'BackupSelectionsList': [ { 'SelectionId': 'string', 'SelectionName': 'string', 'BackupPlanId': 'string', 'CreationDate': datetime(2015, 1, 1), 'CreatorRequestId': 'string', 'IamRoleArn': 'string' }, ] } **Response Structure** * *(dict) --* * **NextToken** *(string) --* 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** *(list) --* An array of backup selection list items containing metadata about each resource in the list. * *(dict) --* Contains metadata about a "BackupSelection" object. * **SelectionId** *(string) --* Uniquely identifies a request to assign a set of resources to a backup plan. * **SelectionName** *(string) --* The display name of a resource selection document. * **BackupPlanId** *(string) --* Uniquely identifies a backup plan. * **CreationDate** *(datetime) --* 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** *(string) --* 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** *(string) --* Specifies the IAM role Amazon Resource Name (ARN) to create the target recovery point; for example, "arn:aws:iam::123456789012:role/S3Access". **Exceptions** * "Backup.Client.exceptions.ResourceNotFoundException" * "Backup.Client.exceptions.InvalidParameterValueException" * "Backup.Client.exceptions.MissingParameterValueException" * "Backup.Client.exceptions.ServiceUnavailableException" Backup / Client / can_paginate can_paginate ************ Backup.Client.can_paginate(operation_name) Check if an operation can be paginated. Parameters: **operation_name** (*string*) -- The operation name. This is the same name as the method name on the client. For example, if the method name is "create_foo", and you'd normally invoke the operation as "client.create_foo(**kwargs)", if the "create_foo" operation can be paginated, you can use the call "client.get_paginator("create_foo")". Returns: "True" if the operation can be paginated, "False" otherwise. Backup / Client / update_restore_testing_plan update_restore_testing_plan *************************** Backup.Client.update_restore_testing_plan(**kwargs) This request will send changes to your specified restore testing plan. "RestoreTestingPlanName" cannot be updated after it is created. "RecoveryPointSelection" can contain: * "Algorithm" * "ExcludeVaults" * "IncludeVaults" * "RecoveryPointTypes" * "SelectionWindowDays" See also: AWS API Documentation **Request Syntax** response = client.update_restore_testing_plan( RestoreTestingPlan={ 'RecoveryPointSelection': { 'Algorithm': 'LATEST_WITHIN_WINDOW'|'RANDOM_WITHIN_WINDOW', 'ExcludeVaults': [ 'string', ], 'IncludeVaults': [ 'string', ], 'RecoveryPointTypes': [ 'CONTINUOUS'|'SNAPSHOT', ], 'SelectionWindowDays': 123 }, 'ScheduleExpression': 'string', 'ScheduleExpressionTimezone': 'string', 'StartWindowHours': 123 }, RestoreTestingPlanName='string' ) Parameters: * **RestoreTestingPlan** (*dict*) -- **[REQUIRED]** Specifies the body of a restore testing plan. * **RecoveryPointSelection** *(dict) --* Required: "Algorithm"; "RecoveryPointTypes"; "IncludeVaults" (*one or more*). Optional: *SelectionWindowDays* (*'30' if not specified*); "ExcludeVaults" (defaults to empty list if not listed). * **Algorithm** *(string) --* Acceptable values include "LATEST_WITHIN_WINDOW" or "RANDOM_WITHIN_WINDOW" * **ExcludeVaults** *(list) --* Accepted values include specific ARNs or list of selectors. Defaults to empty list if not listed. * *(string) --* * **IncludeVaults** *(list) --* 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->>*<<", ...] * *(string) --* * **RecoveryPointTypes** *(list) --* These are the types of recovery points. Include "SNAPSHOT" to restore only snapshot recovery points; include "CONTINUOUS" to restore continuous recovery points (point in time restore / PITR); use both to restore either a snapshot or a continuous recovery point. The recovery point will be determined by the value for "Algorithm". * *(string) --* * **SelectionWindowDays** *(integer) --* Accepted values are integers from 1 to 365. * **ScheduleExpression** *(string) --* A CRON expression in specified timezone when a restore testing plan is executed. When no CRON expression is provided, Backup will use the default expression "cron(0 5 ? * * *)". * **ScheduleExpressionTimezone** *(string) --* 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** *(integer) --* 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). * **RestoreTestingPlanName** (*string*) -- **[REQUIRED]** The name of the restore testing plan name. Return type: dict Returns: **Response Syntax** { 'CreationTime': datetime(2015, 1, 1), 'RestoreTestingPlanArn': 'string', 'RestoreTestingPlanName': 'string', 'UpdateTime': datetime(2015, 1, 1) } **Response Structure** * *(dict) --* * **CreationTime** *(datetime) --* The time the resource testing plan was created. * **RestoreTestingPlanArn** *(string) --* Unique ARN (Amazon Resource Name) of the restore testing plan. * **RestoreTestingPlanName** *(string) --* The name cannot be changed after creation. The name consists of only alphanumeric characters and underscores. Maximum length is 50. * **UpdateTime** *(datetime) --* The time the update completed for the restore testing plan. **Exceptions** * "Backup.Client.exceptions.ConflictException" * "Backup.Client.exceptions.InvalidParameterValueException" * "Backup.Client.exceptions.MissingParameterValueException" * "Backup.Client.exceptions.ResourceNotFoundException" * "Backup.Client.exceptions.ServiceUnavailableException" Backup / Client / list_tags list_tags ********* Backup.Client.list_tags(**kwargs) Returns the tags assigned to the resource, such as a target recovery point, backup plan, or backup vault. This operation returns results depending on the resource type used in the value for "resourceArn". For example, recovery points of Amazon DynamoDB with Advanced Settings have an ARN (Amazon Resource Name) that begins with "arn:aws:backup". Recovery points (backups) of DynamoDB without Advanced Settings enabled have an ARN that begins with "arn:aws:dynamodb". When this operation is called and when you include values of "resourceArn" that have an ARN other than "arn:aws:backup", it may return one of the exceptions listed below. To prevent this exception, include only values representing resource types that are fully managed by Backup. These have an ARN that begins "arn:aws:backup" and they are noted in the Feature availability by resource table. See also: AWS API Documentation **Request Syntax** response = client.list_tags( ResourceArn='string', NextToken='string', MaxResults=123 ) Parameters: * **ResourceArn** (*string*) -- **[REQUIRED]** 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. * **NextToken** (*string*) -- 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. * **MaxResults** (*integer*) -- The maximum number of items to be returned. Return type: dict Returns: **Response Syntax** { 'NextToken': 'string', 'Tags': { 'string': 'string' } } **Response Structure** * *(dict) --* * **NextToken** *(string) --* 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** *(dict) --* Information about the tags. * *(string) --* * *(string) --* **Exceptions** * "Backup.Client.exceptions.ResourceNotFoundException" * "Backup.Client.exceptions.InvalidParameterValueException" * "Backup.Client.exceptions.MissingParameterValueException" * "Backup.Client.exceptions.ServiceUnavailableException" Backup / Client / list_backup_plans list_backup_plans ***************** Backup.Client.list_backup_plans(**kwargs) Lists the active backup plans for the account. See also: AWS API Documentation **Request Syntax** response = client.list_backup_plans( NextToken='string', MaxResults=123, IncludeDeleted=True|False ) Parameters: * **NextToken** (*string*) -- 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. * **MaxResults** (*integer*) -- The maximum number of items to be returned. * **IncludeDeleted** (*boolean*) -- A Boolean value with a default value of "FALSE" that returns deleted backup plans when set to "TRUE". Return type: dict Returns: **Response Syntax** { 'NextToken': 'string', 'BackupPlansList': [ { 'BackupPlanArn': 'string', 'BackupPlanId': 'string', 'CreationDate': datetime(2015, 1, 1), 'DeletionDate': datetime(2015, 1, 1), 'VersionId': 'string', 'BackupPlanName': 'string', 'CreatorRequestId': 'string', 'LastExecutionDate': datetime(2015, 1, 1), 'AdvancedBackupSettings': [ { 'ResourceType': 'string', 'BackupOptions': { 'string': 'string' } }, ] }, ] } **Response Structure** * *(dict) --* * **NextToken** *(string) --* 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** *(list) --* Information about the backup plans. * *(dict) --* Contains metadata about a backup plan. * **BackupPlanArn** *(string) --* 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** *(string) --* Uniquely identifies a backup plan. * **CreationDate** *(datetime) --* 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** *(datetime) --* 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** *(string) --* Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes long. Version IDs cannot be edited. * **BackupPlanName** *(string) --* The display name of a saved backup plan. * **CreatorRequestId** *(string) --* 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** *(datetime) --* The last time this backup plan was run. 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** *(list) --* Contains a list of "BackupOptions" for a resource type. * *(dict) --* The backup options for each resource type. * **ResourceType** *(string) --* 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** *(dict) --* 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. * *(string) --* * *(string) --* **Exceptions** * "Backup.Client.exceptions.ResourceNotFoundException" * "Backup.Client.exceptions.InvalidParameterValueException" * "Backup.Client.exceptions.MissingParameterValueException" * "Backup.Client.exceptions.ServiceUnavailableException" Backup / Client / create_backup_vault create_backup_vault ******************* Backup.Client.create_backup_vault(**kwargs) 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. Note: Do not include sensitive data, such as passport numbers, in the name of a backup vault. See also: AWS API Documentation **Request Syntax** response = client.create_backup_vault( BackupVaultName='string', BackupVaultTags={ 'string': 'string' }, EncryptionKeyArn='string', CreatorRequestId='string' ) Parameters: * **BackupVaultName** (*string*) -- **[REQUIRED]** 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. * **BackupVaultTags** (*dict*) -- The tags to assign to the backup vault. * *(string) --* * *(string) --* * **EncryptionKeyArn** (*string*) -- 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** (*string*) -- 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. This field is autopopulated if not provided. Return type: dict Returns: **Response Syntax** { 'BackupVaultName': 'string', 'BackupVaultArn': 'string', 'CreationDate': datetime(2015, 1, 1) } **Response Structure** * *(dict) --* * **BackupVaultName** *(string) --* 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** *(string) --* An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, "arn:aws:backup:us- east-1:123456789012:backup-vault:aBackupVault". * **CreationDate** *(datetime) --* 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. **Exceptions** * "Backup.Client.exceptions.InvalidParameterValueException" * "Backup.Client.exceptions.MissingParameterValueException" * "Backup.Client.exceptions.ServiceUnavailableException" * "Backup.Client.exceptions.LimitExceededException" * "Backup.Client.exceptions.AlreadyExistsException" Backup / Client / delete_restore_testing_plan delete_restore_testing_plan *************************** Backup.Client.delete_restore_testing_plan(**kwargs) This request deletes the specified restore testing plan. Deletion can only successfully occur if all associated restore testing selections are deleted first. See also: AWS API Documentation **Request Syntax** response = client.delete_restore_testing_plan( RestoreTestingPlanName='string' ) Parameters: **RestoreTestingPlanName** (*string*) -- **[REQUIRED]** Required unique name of the restore testing plan you wish to delete. Returns: None **Exceptions** * "Backup.Client.exceptions.InvalidRequestException" * "Backup.Client.exceptions.ServiceUnavailableException" Backup / Client / list_restore_testing_selections list_restore_testing_selections ******************************* Backup.Client.list_restore_testing_selections(**kwargs) Returns a list of restore testing selections. Can be filtered by "MaxResults" and "RestoreTestingPlanName". See also: AWS API Documentation **Request Syntax** response = client.list_restore_testing_selections( MaxResults=123, NextToken='string', RestoreTestingPlanName='string' ) Parameters: * **MaxResults** (*integer*) -- The maximum number of items to be returned. * **NextToken** (*string*) -- 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. * **RestoreTestingPlanName** (*string*) -- **[REQUIRED]** Returns restore testing selections by the specified restore testing plan name. Return type: dict Returns: **Response Syntax** { 'NextToken': 'string', 'RestoreTestingSelections': [ { 'CreationTime': datetime(2015, 1, 1), 'IamRoleArn': 'string', 'ProtectedResourceType': 'string', 'RestoreTestingPlanName': 'string', 'RestoreTestingSelectionName': 'string', 'ValidationWindowHours': 123 }, ] } **Response Structure** * *(dict) --* * **NextToken** *(string) --* 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** *(list) --* The returned restore testing selections associated with the restore testing plan. * *(dict) --* This contains metadata about a restore testing selection. * **CreationTime** *(datetime) --* 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** *(string) --* 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** *(string) --* 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** *(string) --* 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** *(string) --* Unique name of a restore testing selection. * **ValidationWindowHours** *(integer) --* 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). **Exceptions** * "Backup.Client.exceptions.InvalidParameterValueException" * "Backup.Client.exceptions.ResourceNotFoundException" * "Backup.Client.exceptions.ServiceUnavailableException" Backup / Client / start_copy_job start_copy_job ************** Backup.Client.start_copy_job(**kwargs) Starts a job to create a one-time copy of the specified resource. Does not support continuous backups. See also: AWS API Documentation **Request Syntax** response = client.start_copy_job( RecoveryPointArn='string', SourceBackupVaultName='string', DestinationBackupVaultArn='string', IamRoleArn='string', IdempotencyToken='string', Lifecycle={ 'MoveToColdStorageAfterDays': 123, 'DeleteAfterDays': 123, 'OptInToArchiveForSupportedResources': True|False } ) Parameters: * **RecoveryPointArn** (*string*) -- **[REQUIRED]** 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** (*string*) -- **[REQUIRED]** 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. * **DestinationBackupVaultArn** (*string*) -- **[REQUIRED]** An Amazon Resource Name (ARN) that uniquely identifies a destination backup vault to copy to; for example, "arn:aws:backup:us-east-1:123456789012:backup- vault:aBackupVault". * **IamRoleArn** (*string*) -- **[REQUIRED]** Specifies the IAM role ARN used to copy the target recovery point; for example, "arn:aws:iam::123456789012:role/S3Access". * **IdempotencyToken** (*string*) -- 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. This field is autopopulated if not provided. * **Lifecycle** (*dict*) -- Specifies the time period, in days, before a recovery point transitions to cold storage or is deleted. Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, on the console, the retention setting must be 90 days greater than the transition to cold after days setting. The transition to cold after days setting can't be changed after a backup has been transitioned to cold. Resource types that can transition to cold storage are listed in the Feature availability by resource table. Backup ignores this expression for other resource types. To remove the existing lifecycle and retention periods and keep your recovery points indefinitely, specify -1 for "MoveToColdStorageAfterDays" and "DeleteAfterDays". * **MoveToColdStorageAfterDays** *(integer) --* The number of days after creation that a recovery point is moved to cold storage. * **DeleteAfterDays** *(integer) --* The number of days after creation that a recovery point is deleted. This value must be at least 90 days after the number of days specified in "MoveToColdStorageAfterDays". * **OptInToArchiveForSupportedResources** *(boolean) --* If the value is true, your backup plan transitions supported resources to archive (cold) storage tier in accordance with your lifecycle settings. Return type: dict Returns: **Response Syntax** { 'CopyJobId': 'string', 'CreationDate': datetime(2015, 1, 1), 'IsParent': True|False } **Response Structure** * *(dict) --* * **CopyJobId** *(string) --* Uniquely identifies a copy job. * **CreationDate** *(datetime) --* 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** *(boolean) --* This is a returned boolean value indicating this is a parent (composite) copy job. **Exceptions** * "Backup.Client.exceptions.ResourceNotFoundException" * "Backup.Client.exceptions.InvalidParameterValueException" * "Backup.Client.exceptions.MissingParameterValueException" * "Backup.Client.exceptions.ServiceUnavailableException" * "Backup.Client.exceptions.LimitExceededException" * "Backup.Client.exceptions.InvalidRequestException" Backup / Client / create_logically_air_gapped_backup_vault create_logically_air_gapped_backup_vault **************************************** Backup.Client.create_logically_air_gapped_backup_vault(**kwargs) 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. Note: Do not include sensitive data, such as passport numbers, in the name of a backup vault. See also: AWS API Documentation **Request Syntax** response = client.create_logically_air_gapped_backup_vault( BackupVaultName='string', BackupVaultTags={ 'string': 'string' }, CreatorRequestId='string', MinRetentionDays=123, MaxRetentionDays=123 ) Parameters: * **BackupVaultName** (*string*) -- **[REQUIRED]** 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. * **BackupVaultTags** (*dict*) -- The tags to assign to the vault. * *(string) --* * *(string) --* * **CreatorRequestId** (*string*) -- The ID of the creation request. This parameter is optional. If used, this parameter must contain 1 to 50 alphanumeric or '-_.' characters. This field is autopopulated if not provided. * **MinRetentionDays** (*integer*) -- **[REQUIRED]** This setting specifies the minimum retention period that the vault retains its recovery points. The minimum value accepted is 7 days. * **MaxRetentionDays** (*integer*) -- **[REQUIRED]** The maximum retention period that the vault retains its recovery points. Return type: dict Returns: **Response Syntax** { 'BackupVaultName': 'string', 'BackupVaultArn': 'string', 'CreationDate': datetime(2015, 1, 1), 'VaultState': 'CREATING'|'AVAILABLE'|'FAILED' } **Response Structure** * *(dict) --* * **BackupVaultName** *(string) --* 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. * **BackupVaultArn** *(string) --* The ARN (Amazon Resource Name) of the vault. * **CreationDate** *(datetime) --* 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** *(string) --* The current state of the vault. **Exceptions** * "Backup.Client.exceptions.AlreadyExistsException" * "Backup.Client.exceptions.InvalidParameterValueException" * "Backup.Client.exceptions.LimitExceededException" * "Backup.Client.exceptions.MissingParameterValueException" * "Backup.Client.exceptions.ServiceUnavailableException" * "Backup.Client.exceptions.InvalidRequestException" Backup / Client / delete_backup_vault_access_policy delete_backup_vault_access_policy ********************************* Backup.Client.delete_backup_vault_access_policy(**kwargs) Deletes the policy document that manages permissions on a backup vault. See also: AWS API Documentation **Request Syntax** response = client.delete_backup_vault_access_policy( BackupVaultName='string' ) Parameters: **BackupVaultName** (*string*) -- **[REQUIRED]** 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. Returns: None **Exceptions** * "Backup.Client.exceptions.ResourceNotFoundException" * "Backup.Client.exceptions.InvalidParameterValueException" * "Backup.Client.exceptions.MissingParameterValueException" * "Backup.Client.exceptions.ServiceUnavailableException" Backup / Client / list_backup_plan_versions list_backup_plan_versions ************************* Backup.Client.list_backup_plan_versions(**kwargs) Returns version metadata of your backup plans, including Amazon Resource Names (ARNs), backup plan IDs, creation and deletion dates, plan names, and version IDs. See also: AWS API Documentation **Request Syntax** response = client.list_backup_plan_versions( BackupPlanId='string', NextToken='string', MaxResults=123 ) Parameters: * **BackupPlanId** (*string*) -- **[REQUIRED]** Uniquely identifies a backup plan. * **NextToken** (*string*) -- 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. * **MaxResults** (*integer*) -- The maximum number of items to be returned. Return type: dict Returns: **Response Syntax** { 'NextToken': 'string', 'BackupPlanVersionsList': [ { 'BackupPlanArn': 'string', 'BackupPlanId': 'string', 'CreationDate': datetime(2015, 1, 1), 'DeletionDate': datetime(2015, 1, 1), 'VersionId': 'string', 'BackupPlanName': 'string', 'CreatorRequestId': 'string', 'LastExecutionDate': datetime(2015, 1, 1), 'AdvancedBackupSettings': [ { 'ResourceType': 'string', 'BackupOptions': { 'string': 'string' } }, ] }, ] } **Response Structure** * *(dict) --* * **NextToken** *(string) --* 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** *(list) --* An array of version list items containing metadata about your backup plans. * *(dict) --* Contains metadata about a backup plan. * **BackupPlanArn** *(string) --* 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** *(string) --* Uniquely identifies a backup plan. * **CreationDate** *(datetime) --* 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** *(datetime) --* 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** *(string) --* Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes long. Version IDs cannot be edited. * **BackupPlanName** *(string) --* The display name of a saved backup plan. * **CreatorRequestId** *(string) --* 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** *(datetime) --* The last time this backup plan was run. 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** *(list) --* Contains a list of "BackupOptions" for a resource type. * *(dict) --* The backup options for each resource type. * **ResourceType** *(string) --* 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** *(dict) --* 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. * *(string) --* * *(string) --* **Exceptions** * "Backup.Client.exceptions.ResourceNotFoundException" * "Backup.Client.exceptions.InvalidParameterValueException" * "Backup.Client.exceptions.MissingParameterValueException" * "Backup.Client.exceptions.ServiceUnavailableException" Backup / Client / get_recovery_point_index_details get_recovery_point_index_details ******************************** Backup.Client.get_recovery_point_index_details(**kwargs) This operation returns the metadata and details specific to the backup index associated with the specified recovery point. See also: AWS API Documentation **Request Syntax** response = client.get_recovery_point_index_details( BackupVaultName='string', RecoveryPointArn='string' ) Parameters: * **BackupVaultName** (*string*) -- **[REQUIRED]** 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. Accepted characters include lowercase letters, numbers, and hyphens. * **RecoveryPointArn** (*string*) -- **[REQUIRED]** An ARN that uniquely identifies a recovery point; for example, "arn:aws:backup:us-east-1:123456789012:recovery- point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45". Return type: dict Returns: **Response Syntax** { 'RecoveryPointArn': 'string', 'BackupVaultArn': 'string', 'SourceResourceArn': 'string', 'IndexCreationDate': datetime(2015, 1, 1), 'IndexDeletionDate': datetime(2015, 1, 1), 'IndexCompletionDate': datetime(2015, 1, 1), 'IndexStatus': 'PENDING'|'ACTIVE'|'FAILED'|'DELETING', 'IndexStatusMessage': 'string', 'TotalItemsIndexed': 123 } **Response Structure** * *(dict) --* * **RecoveryPointArn** *(string) --* An ARN that uniquely identifies a recovery point; for example, "arn:aws:backup:us-east-1:123456789012:recovery- point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45". * **BackupVaultArn** *(string) --* An ARN that uniquely identifies the backup vault where the recovery point index is stored. For example, "arn:aws:backup:us-east-1:123456789012:backup- vault:aBackupVault". * **SourceResourceArn** *(string) --* A string of the Amazon Resource Name (ARN) that uniquely identifies the source resource. * **IndexCreationDate** *(datetime) --* The date and time that a backup index was 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. * **IndexDeletionDate** *(datetime) --* The date and time that a backup index was deleted, 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. * **IndexCompletionDate** *(datetime) --* The date and time that a backup index finished creation, 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. * **IndexStatus** *(string) --* This is the current status for the backup index associated with the specified recovery point. Statuses are: "PENDING" | "ACTIVE" | "FAILED" | "DELETING" A recovery point with an index that has the status of "ACTIVE" can be included in a search. * **IndexStatusMessage** *(string) --* A detailed message explaining the status of a backup index associated with the recovery point. * **TotalItemsIndexed** *(integer) --* Count of items within the backup index associated with the recovery point. **Exceptions** * "Backup.Client.exceptions.MissingParameterValueException" * "Backup.Client.exceptions.InvalidParameterValueException" * "Backup.Client.exceptions.ResourceNotFoundException" * "Backup.Client.exceptions.ServiceUnavailableException" Backup / Client / list_restore_jobs list_restore_jobs ***************** Backup.Client.list_restore_jobs(**kwargs) Returns a list of jobs that Backup initiated to restore a saved resource, including details about the recovery process. See also: AWS API Documentation **Request Syntax** response = client.list_restore_jobs( NextToken='string', MaxResults=123, ByAccountId='string', ByResourceType='string', ByCreatedBefore=datetime(2015, 1, 1), ByCreatedAfter=datetime(2015, 1, 1), ByStatus='PENDING'|'RUNNING'|'COMPLETED'|'ABORTED'|'FAILED', ByCompleteBefore=datetime(2015, 1, 1), ByCompleteAfter=datetime(2015, 1, 1), ByRestoreTestingPlanArn='string' ) Parameters: * **NextToken** (*string*) -- 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. * **MaxResults** (*integer*) -- The maximum number of items to be returned. * **ByAccountId** (*string*) -- The account ID to list the jobs from. Returns only restore jobs associated with the specified account ID. * **ByResourceType** (*string*) -- Include this parameter to return only restore jobs for the specified resources: * "Aurora" for Amazon Aurora * "CloudFormation" for CloudFormation * "DocumentDB" for Amazon DocumentDB (with MongoDB compatibility) * "DynamoDB" for Amazon DynamoDB * "EBS" for Amazon Elastic Block Store * "EC2" for Amazon Elastic Compute Cloud * "EFS" for Amazon Elastic File System * "FSx" for Amazon FSx * "Neptune" for Amazon Neptune * "RDS" for Amazon Relational Database Service * "Redshift" for Amazon Redshift * "S3" for Amazon Simple Storage Service (Amazon S3) * "SAP HANA on Amazon EC2" for SAP HANA databases on Amazon Elastic Compute Cloud instances * "Storage Gateway" for Storage Gateway * "Timestream" for Amazon Timestream * "VirtualMachine" for VMware virtual machines * **ByCreatedBefore** (*datetime*) -- Returns only restore jobs that were created before the specified date. * **ByCreatedAfter** (*datetime*) -- Returns only restore jobs that were created after the specified date. * **ByStatus** (*string*) -- Returns only restore jobs associated with the specified job status. * **ByCompleteBefore** (*datetime*) -- Returns only copy jobs completed before a date expressed in Unix format and Coordinated Universal Time (UTC). * **ByCompleteAfter** (*datetime*) -- Returns only copy jobs completed after a date expressed in Unix format and Coordinated Universal Time (UTC). * **ByRestoreTestingPlanArn** (*string*) -- This returns only restore testing jobs that match the specified resource Amazon Resource Name (ARN). Return type: dict Returns: **Response Syntax** { 'RestoreJobs': [ { 'AccountId': 'string', 'RestoreJobId': 'string', 'RecoveryPointArn': 'string', 'CreationDate': datetime(2015, 1, 1), 'CompletionDate': datetime(2015, 1, 1), 'Status': 'PENDING'|'RUNNING'|'COMPLETED'|'ABORTED'|'FAILED', 'StatusMessage': 'string', 'PercentDone': 'string', 'BackupSizeInBytes': 123, 'IamRoleArn': 'string', 'ExpectedCompletionTimeMinutes': 123, 'CreatedResourceArn': 'string', 'ResourceType': 'string', 'RecoveryPointCreationDate': datetime(2015, 1, 1), 'CreatedBy': { 'RestoreTestingPlanArn': 'string' }, 'ValidationStatus': 'FAILED'|'SUCCESSFUL'|'TIMED_OUT'|'VALIDATING', 'ValidationStatusMessage': 'string', 'DeletionStatus': 'DELETING'|'FAILED'|'SUCCESSFUL', 'DeletionStatusMessage': 'string' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **RestoreJobs** *(list) --* An array of objects that contain detailed information about jobs to restore saved resources. * *(dict) --* Contains metadata about a restore job. * **AccountId** *(string) --* The account ID that owns the restore job. * **RestoreJobId** *(string) --* Uniquely identifies the job that restores a recovery point. * **RecoveryPointArn** *(string) --* 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** *(datetime) --* 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** *(datetime) --* 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** *(string) --* A status code specifying the state of the job initiated by Backup to restore a recovery point. * **StatusMessage** *(string) --* A detailed message explaining the status of the job to restore a recovery point. * **PercentDone** *(string) --* Contains an estimated percentage complete of a job at the time the job status was queried. * **BackupSizeInBytes** *(integer) --* The size, in bytes, of the restored resource. * **IamRoleArn** *(string) --* The IAM role ARN used to create the target recovery point; for example, "arn:aws:iam::123456789012:role/S3Access". * **ExpectedCompletionTimeMinutes** *(integer) --* The amount of time in minutes that a job restoring a recovery point is expected to take. * **CreatedResourceArn** *(string) --* An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type. * **ResourceType** *(string) --* 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** *(datetime) --* The date on which a recovery point was created. * **CreatedBy** *(dict) --* Contains identifying information about the creation of a restore job. * **RestoreTestingPlanArn** *(string) --* An Amazon Resource Name (ARN) that uniquely identifies a restore testing plan. * **ValidationStatus** *(string) --* The status of validation run on the indicated restore job. * **ValidationStatusMessage** *(string) --* This describes the status of validation run on the indicated restore job. * **DeletionStatus** *(string) --* This notes the status of the data generated by the restore test. The status may be "Deleting", "Failed", or "Successful". * **DeletionStatusMessage** *(string) --* This describes the restore job deletion status. * **NextToken** *(string) --* 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. **Exceptions** * "Backup.Client.exceptions.ResourceNotFoundException" * "Backup.Client.exceptions.InvalidParameterValueException" * "Backup.Client.exceptions.MissingParameterValueException" * "Backup.Client.exceptions.ServiceUnavailableException" Backup / Client / delete_backup_vault_notifications delete_backup_vault_notifications ********************************* Backup.Client.delete_backup_vault_notifications(**kwargs) Deletes event notifications for the specified backup vault. See also: AWS API Documentation **Request Syntax** response = client.delete_backup_vault_notifications( BackupVaultName='string' ) Parameters: **BackupVaultName** (*string*) -- **[REQUIRED]** 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. Returns: None **Exceptions** * "Backup.Client.exceptions.ResourceNotFoundException" * "Backup.Client.exceptions.InvalidParameterValueException" * "Backup.Client.exceptions.MissingParameterValueException" * "Backup.Client.exceptions.ServiceUnavailableException" Backup / Client / stop_backup_job stop_backup_job *************** Backup.Client.stop_backup_job(**kwargs) Attempts to cancel a job to create a one-time backup of a resource. This action is not supported for the following services: * Amazon Aurora * Amazon DocumentDB (with MongoDB compatibility) * Amazon FSx for Lustre * Amazon FSx for NetApp ONTAP * Amazon FSx for OpenZFS * Amazon FSx for Windows File Server * Amazon Neptune * SAP HANA databases on Amazon EC2 instances * Amazon RDS See also: AWS API Documentation **Request Syntax** response = client.stop_backup_job( BackupJobId='string' ) Parameters: **BackupJobId** (*string*) -- **[REQUIRED]** Uniquely identifies a request to Backup to back up a resource. Returns: None **Exceptions** * "Backup.Client.exceptions.MissingParameterValueException" * "Backup.Client.exceptions.ResourceNotFoundException" * "Backup.Client.exceptions.InvalidParameterValueException" * "Backup.Client.exceptions.InvalidRequestException" * "Backup.Client.exceptions.ServiceUnavailableException" Backup / Client / create_restore_testing_selection create_restore_testing_selection ******************************** Backup.Client.create_restore_testing_selection(**kwargs) This request can be sent after CreateRestoreTestingPlan request returns successfully. This is the second part of creating a resource testing plan, and it must be completed sequentially. This consists of "RestoreTestingSelectionName", "ProtectedResourceType", and one of the following: * "ProtectedResourceArns" * "ProtectedResourceConditions" Each protected resource type can have one single value. A restore testing selection can include a wildcard value ("*") for "ProtectedResourceArns" along with "ProtectedResourceConditions". Alternatively, you can include up to 30 specific protected resource ARNs in "ProtectedResourceArns". Cannot select by both protected resource types AND specific ARNs. Request will fail if both are included. See also: AWS API Documentation **Request Syntax** response = client.create_restore_testing_selection( CreatorRequestId='string', RestoreTestingPlanName='string', RestoreTestingSelection={ 'IamRoleArn': 'string', 'ProtectedResourceArns': [ 'string', ], 'ProtectedResourceConditions': { 'StringEquals': [ { 'Key': 'string', 'Value': 'string' }, ], 'StringNotEquals': [ { 'Key': 'string', 'Value': 'string' }, ] }, 'ProtectedResourceType': 'string', 'RestoreMetadataOverrides': { 'string': 'string' }, 'RestoreTestingSelectionName': 'string', 'ValidationWindowHours': 123 } ) Parameters: * **CreatorRequestId** (*string*) -- 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** (*string*) -- **[REQUIRED]** Input the restore testing plan name that was returned from the related CreateRestoreTestingPlan request. * **RestoreTestingSelection** (*dict*) -- **[REQUIRED]** This consists of "RestoreTestingSelectionName", "ProtectedResourceType", and one of the following: * "ProtectedResourceArns" * "ProtectedResourceConditions" Each protected resource type can have one single value. A restore testing selection can include a wildcard value ("*") for "ProtectedResourceArns" along with "ProtectedResourceConditions". Alternatively, you can include up to 30 specific protected resource ARNs in "ProtectedResourceArns". * **IamRoleArn** *(string) --* **[REQUIRED]** 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** *(list) --* 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. * *(string) --* * **ProtectedResourceConditions** *(dict) --* If you have included the wildcard in ProtectedResourceArns, you can include resource conditions, such as "ProtectedResourceConditions: { StringEquals: [{ key: "XXXX", value: "YYYY" }]". * **StringEquals** *(list) --* Filters the values of your tagged resources for only those resources that you tagged with the same value. Also called "exact matching." * *(dict) --* Pair of two related strings. Allowed characters are letters, white space, and numbers that can be represented in UTF-8 and the following characters: "+ - = . _ : /" * **Key** *(string) --* **[REQUIRED]** 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** *(string) --* **[REQUIRED]** The value of the key. Length Constraints: Maximum length of 256. Pattern: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$" * **StringNotEquals** *(list) --* 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." * *(dict) --* Pair of two related strings. Allowed characters are letters, white space, and numbers that can be represented in UTF-8 and the following characters: "+ - = . _ : /" * **Key** *(string) --* **[REQUIRED]** 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** *(string) --* **[REQUIRED]** The value of the key. Length Constraints: Maximum length of 256. Pattern: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$" * **ProtectedResourceType** *(string) --* **[REQUIRED]** 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: * "Aurora" for Amazon Aurora * "DocumentDB" for Amazon DocumentDB (with MongoDB compatibility) * "DynamoDB" for Amazon DynamoDB * "EBS" for Amazon Elastic Block Store * "EC2" for Amazon Elastic Compute Cloud * "EFS" for Amazon Elastic File System * "FSx" for Amazon FSx * "Neptune" for Amazon Neptune * "RDS" for Amazon Relational Database Service * "S3" for Amazon S3 * **RestoreMetadataOverrides** *(dict) --* 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. * *(string) --* * *(string) --* * **RestoreTestingSelectionName** *(string) --* **[REQUIRED]** The unique name of the restore testing selection that belongs to the related restore testing plan. * **ValidationWindowHours** *(integer) --* This is amount of hours (0 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. Return type: dict Returns: **Response Syntax** { 'CreationTime': datetime(2015, 1, 1), 'RestoreTestingPlanArn': 'string', 'RestoreTestingPlanName': 'string', 'RestoreTestingSelectionName': 'string' } **Response Structure** * *(dict) --* * **CreationTime** *(datetime) --* The time that the resource testing selection was created. * **RestoreTestingPlanArn** *(string) --* The ARN of the restore testing plan with which the restore testing selection is associated. * **RestoreTestingPlanName** *(string) --* 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** *(string) --* The name of the restore testing selection for the related restore testing plan. **Exceptions** * "Backup.Client.exceptions.AlreadyExistsException" * "Backup.Client.exceptions.InvalidParameterValueException" * "Backup.Client.exceptions.LimitExceededException" * "Backup.Client.exceptions.MissingParameterValueException" * "Backup.Client.exceptions.ResourceNotFoundException" * "Backup.Client.exceptions.ServiceUnavailableException" Backup / Client / describe_protected_resource describe_protected_resource *************************** Backup.Client.describe_protected_resource(**kwargs) 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. See also: AWS API Documentation **Request Syntax** response = client.describe_protected_resource( ResourceArn='string' ) Parameters: **ResourceArn** (*string*) -- **[REQUIRED]** An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type. Return type: dict Returns: **Response Syntax** { 'ResourceArn': 'string', 'ResourceType': 'string', 'LastBackupTime': datetime(2015, 1, 1), 'ResourceName': 'string', 'LastBackupVaultArn': 'string', 'LastRecoveryPointArn': 'string', 'LatestRestoreExecutionTimeMinutes': 123, 'LatestRestoreJobCreationDate': datetime(2015, 1, 1), 'LatestRestoreRecoveryPointCreationDate': datetime(2015, 1, 1) } **Response Structure** * *(dict) --* * **ResourceArn** *(string) --* An ARN that uniquely identifies a resource. The format of the ARN depends on the resource type. * **ResourceType** *(string) --* The type of Amazon Web Services resource saved as a recovery point; for example, an Amazon EBS volume or an Amazon RDS database. * **LastBackupTime** *(datetime) --* 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** *(string) --* The name of the resource that belongs to the specified backup. * **LastBackupVaultArn** *(string) --* The ARN (Amazon Resource Name) of the backup vault that contains the most recent backup recovery point. * **LastRecoveryPointArn** *(string) --* The ARN (Amazon Resource Name) of the most recent recovery point. * **LatestRestoreExecutionTimeMinutes** *(integer) --* The time, in minutes, that the most recent restore job took to complete. * **LatestRestoreJobCreationDate** *(datetime) --* The creation date of the most recent restore job. * **LatestRestoreRecoveryPointCreationDate** *(datetime) --* The date the most recent recovery point was created. **Exceptions** * "Backup.Client.exceptions.MissingParameterValueException" * "Backup.Client.exceptions.InvalidParameterValueException" * "Backup.Client.exceptions.ServiceUnavailableException" * "Backup.Client.exceptions.ResourceNotFoundException" Backup / Client / list_backup_vaults list_backup_vaults ****************** Backup.Client.list_backup_vaults(**kwargs) Returns a list of recovery point storage containers along with information about them. See also: AWS API Documentation **Request Syntax** response = client.list_backup_vaults( ByVaultType='BACKUP_VAULT'|'LOGICALLY_AIR_GAPPED_BACKUP_VAULT'|'RESTORE_ACCESS_BACKUP_VAULT', ByShared=True|False, NextToken='string', MaxResults=123 ) Parameters: * **ByVaultType** (*string*) -- This parameter will sort the list of vaults by vault type. * **ByShared** (*boolean*) -- This parameter will sort the list of vaults by shared vaults. * **NextToken** (*string*) -- 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. * **MaxResults** (*integer*) -- The maximum number of items to be returned. Return type: dict Returns: **Response Syntax** { 'BackupVaultList': [ { 'BackupVaultName': 'string', 'BackupVaultArn': 'string', 'VaultType': 'BACKUP_VAULT'|'LOGICALLY_AIR_GAPPED_BACKUP_VAULT'|'RESTORE_ACCESS_BACKUP_VAULT', 'VaultState': 'CREATING'|'AVAILABLE'|'FAILED', 'CreationDate': datetime(2015, 1, 1), 'EncryptionKeyArn': 'string', 'CreatorRequestId': 'string', 'NumberOfRecoveryPoints': 123, 'Locked': True|False, 'MinRetentionDays': 123, 'MaxRetentionDays': 123, 'LockDate': datetime(2015, 1, 1) }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **BackupVaultList** *(list) --* 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. * *(dict) --* Contains metadata about a backup vault. * **BackupVaultName** *(string) --* 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. * **BackupVaultArn** *(string) --* An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, "arn:aws:backup:us- east-1:123456789012:backup-vault:aBackupVault". * **VaultType** *(string) --* The type of vault in which the described recovery point is stored. * **VaultState** *(string) --* The current state of the vault. * **CreationDate** *(datetime) --* 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** *(string) --* 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** *(string) --* 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** *(integer) --* The number of recovery points that are stored in a backup vault. * **Locked** *(boolean) --* 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** *(integer) --* 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** *(integer) --* 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** *(datetime) --* 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. * **NextToken** *(string) --* 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. **Exceptions** * "Backup.Client.exceptions.ResourceNotFoundException" * "Backup.Client.exceptions.InvalidParameterValueException" * "Backup.Client.exceptions.MissingParameterValueException" * "Backup.Client.exceptions.ServiceUnavailableException" Backup / Client / list_restore_testing_plans list_restore_testing_plans ************************** Backup.Client.list_restore_testing_plans(**kwargs) Returns a list of restore testing plans. See also: AWS API Documentation **Request Syntax** response = client.list_restore_testing_plans( MaxResults=123, NextToken='string' ) Parameters: * **MaxResults** (*integer*) -- The maximum number of items to be returned. * **NextToken** (*string*) -- 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. Return type: dict Returns: **Response Syntax** { 'NextToken': 'string', 'RestoreTestingPlans': [ { 'CreationTime': datetime(2015, 1, 1), 'LastExecutionTime': datetime(2015, 1, 1), 'LastUpdateTime': datetime(2015, 1, 1), 'RestoreTestingPlanArn': 'string', 'RestoreTestingPlanName': 'string', 'ScheduleExpression': 'string', 'ScheduleExpressionTimezone': 'string', 'StartWindowHours': 123 }, ] } **Response Structure** * *(dict) --* * **NextToken** *(string) --* 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** *(list) --* This is a returned list of restore testing plans. * *(dict) --* This contains metadata about a restore testing plan. * **CreationTime** *(datetime) --* 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** *(datetime) --* 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** *(datetime) --* 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** *(string) --* An Amazon Resource Name (ARN) that uniquely identifiesa restore testing plan. * **RestoreTestingPlanName** *(string) --* The restore testing plan name. * **ScheduleExpression** *(string) --* A CRON expression in specified timezone when a restore testing plan is executed. When no CRON expression is provided, Backup will use the default expression "cron(0 5 ? * * *)". * **ScheduleExpressionTimezone** *(string) --* 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** *(integer) --* 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). **Exceptions** * "Backup.Client.exceptions.InvalidParameterValueException" * "Backup.Client.exceptions.ServiceUnavailableException" Backup / Client / untag_resource untag_resource ************** Backup.Client.untag_resource(**kwargs) Removes a set of key-value pairs from a recovery point, backup plan, or backup vault identified by an Amazon Resource Name (ARN) This API is not supported for recovery points for resource types including Aurora, Amazon DocumentDB. Amazon EBS, Amazon FSx, Neptune, and Amazon RDS. See also: AWS API Documentation **Request Syntax** response = client.untag_resource( ResourceArn='string', TagKeyList=[ 'string', ] ) Parameters: * **ResourceArn** (*string*) -- **[REQUIRED]** An ARN that uniquely identifies a resource. The format of the ARN depends on the type of the tagged resource. ARNs that do not include "backup" are incompatible with tagging. "TagResource" and "UntagResource" with invalid ARNs will result in an error. Acceptable ARN content can include "arn:aws:backup:us-east". Invalid ARN content may look like "arn:aws:ec2:us-east". * **TagKeyList** (*list*) -- **[REQUIRED]** The keys to identify which key-value tags to remove from a resource. * *(string) --* Returns: None **Exceptions** * "Backup.Client.exceptions.ResourceNotFoundException" * "Backup.Client.exceptions.InvalidParameterValueException" * "Backup.Client.exceptions.MissingParameterValueException" * "Backup.Client.exceptions.ServiceUnavailableException" Backup / Client / revoke_restore_access_backup_vault revoke_restore_access_backup_vault ********************************** Backup.Client.revoke_restore_access_backup_vault(**kwargs) Revokes access to a restore access backup vault, removing the ability to restore from its recovery points and permanently deleting the vault. See also: AWS API Documentation **Request Syntax** response = client.revoke_restore_access_backup_vault( BackupVaultName='string', RestoreAccessBackupVaultArn='string', RequesterComment='string' ) Parameters: * **BackupVaultName** (*string*) -- **[REQUIRED]** The name of the source backup vault associated with the restore access backup vault to be revoked. * **RestoreAccessBackupVaultArn** (*string*) -- **[REQUIRED]** The ARN of the restore access backup vault to revoke. * **RequesterComment** (*string*) -- A comment explaining the reason for revoking access to the restore access backup vault. Returns: None **Exceptions** * "Backup.Client.exceptions.ResourceNotFoundException" * "Backup.Client.exceptions.MissingParameterValueException" * "Backup.Client.exceptions.ServiceUnavailableException" * "Backup.Client.exceptions.InvalidParameterValueException" * "Backup.Client.exceptions.InvalidRequestException" Backup / Client / list_legal_holds list_legal_holds **************** Backup.Client.list_legal_holds(**kwargs) This action returns metadata about active and previous legal holds. See also: AWS API Documentation **Request Syntax** response = client.list_legal_holds( NextToken='string', MaxResults=123 ) Parameters: * **NextToken** (*string*) -- 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. * **MaxResults** (*integer*) -- The maximum number of resource list items to be returned. Return type: dict Returns: **Response Syntax** { 'NextToken': 'string', 'LegalHolds': [ { 'Title': 'string', 'Status': 'CREATING'|'ACTIVE'|'CANCELING'|'CANCELED', 'Description': 'string', 'LegalHoldId': 'string', 'LegalHoldArn': 'string', 'CreationDate': datetime(2015, 1, 1), 'CancellationDate': datetime(2015, 1, 1) }, ] } **Response Structure** * *(dict) --* * **NextToken** *(string) --* 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** *(list) --* This is an array of returned legal holds, both active and previous. * *(dict) --* 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. * **Title** *(string) --* The title of a legal hold. * **Status** *(string) --* The status of the legal hold. * **Description** *(string) --* The description of a legal hold. * **LegalHoldId** *(string) --* The ID of the legal hold. * **LegalHoldArn** *(string) --* The Amazon Resource Name (ARN) of the legal hold; for example, "arn:aws:backup:us-east-1:123456789012 :recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45". * **CreationDate** *(datetime) --* The time when the legal hold was created. * **CancellationDate** *(datetime) --* The time when the legal hold was cancelled. **Exceptions** * "Backup.Client.exceptions.InvalidParameterValueException" * "Backup.Client.exceptions.ServiceUnavailableException" Backup / Client / update_global_settings update_global_settings ********************** Backup.Client.update_global_settings(**kwargs) 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. See also: AWS API Documentation **Request Syntax** response = client.update_global_settings( GlobalSettings={ 'string': 'string' } ) Parameters: **GlobalSettings** (*dict*) -- A value for "isCrossAccountBackupEnabled" and a Region. Example: "update-global-settings --global-settings isCrossAccountBackupEnabled=false --region us-west-2". * *(string) --* * *(string) --* Returns: None **Exceptions** * "Backup.Client.exceptions.ServiceUnavailableException" * "Backup.Client.exceptions.MissingParameterValueException" * "Backup.Client.exceptions.InvalidParameterValueException" * "Backup.Client.exceptions.InvalidRequestException" Backup / Client / delete_recovery_point delete_recovery_point ********************* Backup.Client.delete_recovery_point(**kwargs) 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. See also: AWS API Documentation **Request Syntax** response = client.delete_recovery_point( BackupVaultName='string', RecoveryPointArn='string' ) Parameters: * **BackupVaultName** (*string*) -- **[REQUIRED]** 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. * **RecoveryPointArn** (*string*) -- **[REQUIRED]** 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". Returns: None **Exceptions** * "Backup.Client.exceptions.ResourceNotFoundException" * "Backup.Client.exceptions.InvalidParameterValueException" * "Backup.Client.exceptions.MissingParameterValueException" * "Backup.Client.exceptions.InvalidResourceStateException" * "Backup.Client.exceptions.ServiceUnavailableException" * "Backup.Client.exceptions.InvalidRequestException" Backup / Client / get_waiter get_waiter ********** Backup.Client.get_waiter(waiter_name) Returns an object that can wait for some condition. Parameters: **waiter_name** (*str*) -- The name of the waiter to get. See the waiters section of the service docs for a list of available waiters. Returns: The specified waiter object. Return type: "botocore.waiter.Waiter" Backup / Client / delete_framework delete_framework **************** Backup.Client.delete_framework(**kwargs) Deletes the framework specified by a framework name. See also: AWS API Documentation **Request Syntax** response = client.delete_framework( FrameworkName='string' ) Parameters: **FrameworkName** (*string*) -- **[REQUIRED]** The unique name of a framework. Returns: None **Exceptions** * "Backup.Client.exceptions.MissingParameterValueException" * "Backup.Client.exceptions.InvalidParameterValueException" * "Backup.Client.exceptions.ServiceUnavailableException" * "Backup.Client.exceptions.ConflictException" * "Backup.Client.exceptions.ResourceNotFoundException" Backup / Client / delete_backup_vault_lock_configuration delete_backup_vault_lock_configuration ************************************** Backup.Client.delete_backup_vault_lock_configuration(**kwargs) 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*. See also: AWS API Documentation **Request Syntax** response = client.delete_backup_vault_lock_configuration( BackupVaultName='string' ) Parameters: **BackupVaultName** (*string*) -- **[REQUIRED]** The name of the backup vault from which to delete Backup Vault Lock. Returns: None **Exceptions** * "Backup.Client.exceptions.ResourceNotFoundException" * "Backup.Client.exceptions.InvalidParameterValueException" * "Backup.Client.exceptions.MissingParameterValueException" * "Backup.Client.exceptions.InvalidRequestException" * "Backup.Client.exceptions.ServiceUnavailableException" Backup / Client / list_copy_job_summaries list_copy_job_summaries *********************** Backup.Client.list_copy_job_summaries(**kwargs) 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. See also: AWS API Documentation **Request Syntax** response = client.list_copy_job_summaries( AccountId='string', State='CREATED'|'RUNNING'|'ABORTING'|'ABORTED'|'COMPLETING'|'COMPLETED'|'FAILING'|'FAILED'|'PARTIAL'|'AGGREGATE_ALL'|'ANY', ResourceType='string', MessageCategory='string', AggregationPeriod='ONE_DAY'|'SEVEN_DAYS'|'FOURTEEN_DAYS', MaxResults=123, NextToken='string' ) Parameters: * **AccountId** (*string*) -- 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. * **State** (*string*) -- 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. * **ResourceType** (*string*) -- 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. * **MessageCategory** (*string*) -- 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. * **AggregationPeriod** (*string*) -- The period for the returned results. * "ONE_DAY" - The daily job count for the prior 14 days. * "SEVEN_DAYS" - The aggregated job count for the prior 7 days. * "FOURTEEN_DAYS" - The aggregated job count for prior 14 days. * **MaxResults** (*integer*) -- 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. * **NextToken** (*string*) -- 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. Return type: dict Returns: **Response Syntax** { 'CopyJobSummaries': [ { 'Region': 'string', 'AccountId': 'string', 'State': 'CREATED'|'RUNNING'|'ABORTING'|'ABORTED'|'COMPLETING'|'COMPLETED'|'FAILING'|'FAILED'|'PARTIAL'|'AGGREGATE_ALL'|'ANY', 'ResourceType': 'string', 'MessageCategory': 'string', 'Count': 123, 'StartTime': datetime(2015, 1, 1), 'EndTime': datetime(2015, 1, 1) }, ], 'AggregationPeriod': 'string', 'NextToken': 'string' } **Response Structure** * *(dict) --* * **CopyJobSummaries** *(list) --* This return shows a summary that contains Region, Account, State, ResourceType, MessageCategory, StartTime, EndTime, and Count of included jobs. * *(dict) --* 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. * **Region** *(string) --* The Amazon Web Services Regions within the job summary. * **AccountId** *(string) --* The account ID that owns the jobs within the summary. * **State** *(string) --* This value is job count for jobs with the specified state. * **ResourceType** *(string) --* This value is the job count for the specified resource type. The request "GetSupportedResourceTypes" returns strings for supported resource types * **MessageCategory** *(string) --* 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** *(integer) --* The value as a number of jobs in a job summary. * **StartTime** *(datetime) --* 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** *(datetime) --* 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. * **AggregationPeriod** *(string) --* The period for the returned results. * "ONE_DAY" - The daily job count for the prior 14 days. * "SEVEN_DAYS" - The aggregated job count for the prior 7 days. * "FOURTEEN_DAYS" - The aggregated job count for prior 14 days. * **NextToken** *(string) --* 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. **Exceptions** * "Backup.Client.exceptions.InvalidParameterValueException" * "Backup.Client.exceptions.ServiceUnavailableException" Backup / Client / get_restore_testing_plan get_restore_testing_plan ************************ Backup.Client.get_restore_testing_plan(**kwargs) 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. See also: AWS API Documentation **Request Syntax** response = client.get_restore_testing_plan( RestoreTestingPlanName='string' ) Parameters: **RestoreTestingPlanName** (*string*) -- **[REQUIRED]** Required unique name of the restore testing plan. Return type: dict Returns: **Response Syntax** { 'RestoreTestingPlan': { 'CreationTime': datetime(2015, 1, 1), 'CreatorRequestId': 'string', 'LastExecutionTime': datetime(2015, 1, 1), 'LastUpdateTime': datetime(2015, 1, 1), 'RecoveryPointSelection': { 'Algorithm': 'LATEST_WITHIN_WINDOW'|'RANDOM_WITHIN_WINDOW', 'ExcludeVaults': [ 'string', ], 'IncludeVaults': [ 'string', ], 'RecoveryPointTypes': [ 'CONTINUOUS'|'SNAPSHOT', ], 'SelectionWindowDays': 123 }, 'RestoreTestingPlanArn': 'string', 'RestoreTestingPlanName': 'string', 'ScheduleExpression': 'string', 'ScheduleExpressionTimezone': 'string', 'StartWindowHours': 123 } } **Response Structure** * *(dict) --* * **RestoreTestingPlan** *(dict) --* Specifies the body of a restore testing plan. Includes "RestoreTestingPlanName". * **CreationTime** *(datetime) --* 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** *(string) --* 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** *(datetime) --* 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** *(datetime) --* 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** *(dict) --* The specified criteria to assign a set of resources, such as recovery point types or backup vaults. * **Algorithm** *(string) --* Acceptable values include "LATEST_WITHIN_WINDOW" or "RANDOM_WITHIN_WINDOW" * **ExcludeVaults** *(list) --* Accepted values include specific ARNs or list of selectors. Defaults to empty list if not listed. * *(string) --* * **IncludeVaults** *(list) --* 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->>*<<", ...] * *(string) --* * **RecoveryPointTypes** *(list) --* These are the types of recovery points. Include "SNAPSHOT" to restore only snapshot recovery points; include "CONTINUOUS" to restore continuous recovery points (point in time restore / PITR); use both to restore either a snapshot or a continuous recovery point. The recovery point will be determined by the value for "Algorithm". * *(string) --* * **SelectionWindowDays** *(integer) --* Accepted values are integers from 1 to 365. * **RestoreTestingPlanArn** *(string) --* An Amazon Resource Name (ARN) that uniquely identifies a restore testing plan. * **RestoreTestingPlanName** *(string) --* The restore testing plan name. * **ScheduleExpression** *(string) --* A CRON expression in specified timezone when a restore testing plan is executed. When no CRON expression is provided, Backup will use the default expression "cron(0 5 ? * * *)". * **ScheduleExpressionTimezone** *(string) --* 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** *(integer) --* 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). **Exceptions** * "Backup.Client.exceptions.ResourceNotFoundException" * "Backup.Client.exceptions.ServiceUnavailableException" Backup / Client / describe_framework describe_framework ****************** Backup.Client.describe_framework(**kwargs) Returns the framework details for the specified "FrameworkName". See also: AWS API Documentation **Request Syntax** response = client.describe_framework( FrameworkName='string' ) Parameters: **FrameworkName** (*string*) -- **[REQUIRED]** The unique name of a framework. Return type: dict Returns: **Response Syntax** { 'FrameworkName': 'string', 'FrameworkArn': 'string', 'FrameworkDescription': 'string', 'FrameworkControls': [ { 'ControlName': 'string', 'ControlInputParameters': [ { 'ParameterName': 'string', 'ParameterValue': 'string' }, ], 'ControlScope': { 'ComplianceResourceIds': [ 'string', ], 'ComplianceResourceTypes': [ 'string', ], 'Tags': { 'string': 'string' } } }, ], 'CreationTime': datetime(2015, 1, 1), 'DeploymentStatus': 'string', 'FrameworkStatus': 'string', 'IdempotencyToken': 'string' } **Response Structure** * *(dict) --* * **FrameworkName** *(string) --* The unique name of a framework. * **FrameworkArn** *(string) --* An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type. * **FrameworkDescription** *(string) --* An optional description of the framework. * **FrameworkControls** *(list) --* The controls that make up the framework. Each control in the list has a name, input parameters, and scope. * *(dict) --* Contains detailed information about all of the controls of a framework. Each framework must contain at least one control. * **ControlName** *(string) --* The name of a control. This name is between 1 and 256 characters. * **ControlInputParameters** *(list) --* The name/value pairs. * *(dict) --* The parameters for a control. A control can have zero, one, or more than one parameter. An example of a control with two parameters is: "backup plan frequency is at least "daily" and the retention period is at least "1 year"". The first parameter is "daily". The second parameter is "1 year". * **ParameterName** *(string) --* The name of a parameter, for example, "BackupPlanFrequency". * **ParameterValue** *(string) --* The value of parameter, for example, "hourly". * **ControlScope** *(dict) --* 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. * **ComplianceResourceIds** *(list) --* The ID of the only Amazon Web Services resource that you want your control scope to contain. * *(string) --* * **ComplianceResourceTypes** *(list) --* Describes whether the control scope includes one or more types of resources, such as "EFS" or "RDS". * *(string) --* * **Tags** *(dict) --* 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 if you are creating or editing a framework from the console (though the value can be an empty string when included in a CloudFormation template). The structure to assign a tag is: "[{"Key":"string","Value":"string"}]". * *(string) --* * *(string) --* * **CreationTime** *(datetime) --* 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** *(string) --* The deployment status of a framework. The statuses are: "CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | COMPLETED | FAILED" * **FrameworkStatus** *(string) --* 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: * "ACTIVE" when recording is turned on for all resources governed by the framework. * "PARTIALLY_ACTIVE" when recording is turned off for at least one resource governed by the framework. * "INACTIVE" when recording is turned off for all resources governed by the framework. * "UNAVAILABLE" when Backup is unable to validate recording status at this time. * **IdempotencyToken** *(string) --* 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. **Exceptions** * "Backup.Client.exceptions.ResourceNotFoundException" * "Backup.Client.exceptions.InvalidParameterValueException" * "Backup.Client.exceptions.MissingParameterValueException" * "Backup.Client.exceptions.ServiceUnavailableException" Backup / Client / create_report_plan create_report_plan ****************** Backup.Client.create_report_plan(**kwargs) 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. See also: AWS API Documentation **Request Syntax** response = client.create_report_plan( ReportPlanName='string', ReportPlanDescription='string', ReportDeliveryChannel={ 'S3BucketName': 'string', 'S3KeyPrefix': 'string', 'Formats': [ 'string', ] }, ReportSetting={ 'ReportTemplate': 'string', 'FrameworkArns': [ 'string', ], 'NumberOfFrameworks': 123, 'Accounts': [ 'string', ], 'OrganizationUnits': [ 'string', ], 'Regions': [ 'string', ] }, ReportPlanTags={ 'string': 'string' }, IdempotencyToken='string' ) Parameters: * **ReportPlanName** (*string*) -- **[REQUIRED]** 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** (*string*) -- An optional description of the report plan with a maximum of 1,024 characters. * **ReportDeliveryChannel** (*dict*) -- **[REQUIRED]** 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. * **S3BucketName** *(string) --* **[REQUIRED]** The unique name of the S3 bucket that receives your reports. * **S3KeyPrefix** *(string) --* 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** *(list) --* The format of your reports: "CSV", "JSON", or both. If not specified, the default format is "CSV". * *(string) --* * **ReportSetting** (*dict*) -- **[REQUIRED]** 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. * **ReportTemplate** *(string) --* **[REQUIRED]** 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** *(list) --* The Amazon Resource Names (ARNs) of the frameworks a report covers. * *(string) --* * **NumberOfFrameworks** *(integer) --* The number of frameworks a report covers. * **Accounts** *(list) --* These are the accounts to be included in the report. Use string value of "ROOT" to include all organizational units. * *(string) --* * **OrganizationUnits** *(list) --* These are the Organizational Units to be included in the report. * *(string) --* * **Regions** *(list) --* These are the Regions to be included in the report. Use the wildcard as the string value to include all Regions. * *(string) --* * **ReportPlanTags** (*dict*) -- The tags to assign to the report plan. * *(string) --* * *(string) --* * **IdempotencyToken** (*string*) -- 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. This field is autopopulated if not provided. Return type: dict Returns: **Response Syntax** { 'ReportPlanName': 'string', 'ReportPlanArn': 'string', 'CreationTime': datetime(2015, 1, 1) } **Response Structure** * *(dict) --* * **ReportPlanName** *(string) --* The unique name of the report plan. * **ReportPlanArn** *(string) --* An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type. * **CreationTime** *(datetime) --* 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. **Exceptions** * "Backup.Client.exceptions.AlreadyExistsException" * "Backup.Client.exceptions.LimitExceededException" * "Backup.Client.exceptions.InvalidParameterValueException" * "Backup.Client.exceptions.ServiceUnavailableException" * "Backup.Client.exceptions.MissingParameterValueException" Backup / Client / get_restore_job_metadata get_restore_job_metadata ************************ Backup.Client.get_restore_job_metadata(**kwargs) This request returns the metadata for the specified restore job. See also: AWS API Documentation **Request Syntax** response = client.get_restore_job_metadata( RestoreJobId='string' ) Parameters: **RestoreJobId** (*string*) -- **[REQUIRED]** This is a unique identifier of a restore job within Backup. Return type: dict Returns: **Response Syntax** { 'RestoreJobId': 'string', 'Metadata': { 'string': 'string' } } **Response Structure** * *(dict) --* * **RestoreJobId** *(string) --* This is a unique identifier of a restore job within Backup. * **Metadata** *(dict) --* This contains the metadata of the specified backup job. * *(string) --* * *(string) --* **Exceptions** * "Backup.Client.exceptions.ResourceNotFoundException" * "Backup.Client.exceptions.InvalidParameterValueException" * "Backup.Client.exceptions.MissingParameterValueException" * "Backup.Client.exceptions.ServiceUnavailableException" Backup / Client / create_backup_selection create_backup_selection *********************** Backup.Client.create_backup_selection(**kwargs) Creates a JSON document that specifies a set of resources to assign to a backup plan. For examples, see Assigning resources programmatically. See also: AWS API Documentation **Request Syntax** response = client.create_backup_selection( BackupPlanId='string', BackupSelection={ 'SelectionName': 'string', 'IamRoleArn': 'string', 'Resources': [ 'string', ], 'ListOfTags': [ { 'ConditionType': 'STRINGEQUALS', 'ConditionKey': 'string', 'ConditionValue': 'string' }, ], 'NotResources': [ 'string', ], 'Conditions': { 'StringEquals': [ { 'ConditionKey': 'string', 'ConditionValue': 'string' }, ], 'StringNotEquals': [ { 'ConditionKey': 'string', 'ConditionValue': 'string' }, ], 'StringLike': [ { 'ConditionKey': 'string', 'ConditionValue': 'string' }, ], 'StringNotLike': [ { 'ConditionKey': 'string', 'ConditionValue': 'string' }, ] } }, CreatorRequestId='string' ) Parameters: * **BackupPlanId** (*string*) -- **[REQUIRED]** The ID of the backup plan. * **BackupSelection** (*dict*) -- **[REQUIRED]** The body of a request to assign a set of resources to a backup plan. * **SelectionName** *(string) --* **[REQUIRED]** The display name of a resource selection document. Must contain 1 to 50 alphanumeric or '-_.' characters. * **IamRoleArn** *(string) --* **[REQUIRED]** 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** *(list) --* The Amazon Resource Names (ARNs) of the resources 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. If you specify multiple ARNs, the resources much match any of the ARNs (OR logic). * *(string) --* * **ListOfTags** *(list) --* The conditions that you define to assign resources to your backup plans using tags. For example, ""StringEquals": { "ConditionKey": "backup", "ConditionValue": "daily"}". "ListOfTags" supports only "StringEquals". Condition operators are case sensitive. If you specify multiple conditions, the resources much match any of the conditions (OR logic). * *(dict) --* 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. * **ConditionType** *(string) --* **[REQUIRED]** 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** *(string) --* **[REQUIRED]** The key in a key-value pair. For example, in the tag "Department: Accounting", "Department" is the key. * **ConditionValue** *(string) --* **[REQUIRED]** The value in a key-value pair. For example, in the tag "Department: Accounting", "Accounting" is the value. * **NotResources** *(list) --* The Amazon Resource Names (ARNs) of the resources 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. * *(string) --* * **Conditions** *(dict) --* The conditions that you define to assign resources to your backup plans using tags. For example, ""StringEquals": { "ConditionKey": "aws:ResourceTag/backup", "ConditionValue": "daily" }". "Conditions" supports "StringEquals", "StringLike", "StringNotEquals", and "StringNotLike". Condition operators are case sensitive. If you specify multiple conditions, the resources much match all conditions (AND logic). * **StringEquals** *(list) --* Filters the values of your tagged resources for only those resources that you tagged with the same value. Also called "exact matching." * *(dict) --* Includes information about tags you define to assign tagged resources to a backup plan. Include the prefix "aws:ResourceTag" in your tags. For example, ""aws:ResourceTag/TagKey1": "Value1"". * **ConditionKey** *(string) --* The key in a key-value pair. For example, in the tag "Department: Accounting", "Department" is the key. * **ConditionValue** *(string) --* The value in a key-value pair. For example, in the tag "Department: Accounting", "Accounting" is the value. * **StringNotEquals** *(list) --* 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." * *(dict) --* Includes information about tags you define to assign tagged resources to a backup plan. Include the prefix "aws:ResourceTag" in your tags. For example, ""aws:ResourceTag/TagKey1": "Value1"". * **ConditionKey** *(string) --* The key in a key-value pair. For example, in the tag "Department: Accounting", "Department" is the key. * **ConditionValue** *(string) --* The value in a key-value pair. For example, in the tag "Department: Accounting", "Accounting" is the value. * **StringLike** *(list) --* 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". * *(dict) --* Includes information about tags you define to assign tagged resources to a backup plan. Include the prefix "aws:ResourceTag" in your tags. For example, ""aws:ResourceTag/TagKey1": "Value1"". * **ConditionKey** *(string) --* The key in a key-value pair. For example, in the tag "Department: Accounting", "Department" is the key. * **ConditionValue** *(string) --* The value in a key-value pair. For example, in the tag "Department: Accounting", "Accounting" is the value. * **StringNotLike** *(list) --* Filters the values of your tagged resources for non- matching tag values with the use of a wildcard character (*) anywhere in the string. * *(dict) --* Includes information about tags you define to assign tagged resources to a backup plan. Include the prefix "aws:ResourceTag" in your tags. For example, ""aws:ResourceTag/TagKey1": "Value1"". * **ConditionKey** *(string) --* The key in a key-value pair. For example, in the tag "Department: Accounting", "Department" is the key. * **ConditionValue** *(string) --* The value in a key-value pair. For example, in the tag "Department: Accounting", "Accounting" is the value. * **CreatorRequestId** (*string*) -- 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. This field is autopopulated if not provided. Return type: dict Returns: **Response Syntax** { 'SelectionId': 'string', 'BackupPlanId': 'string', 'CreationDate': datetime(2015, 1, 1) } **Response Structure** * *(dict) --* * **SelectionId** *(string) --* Uniquely identifies the body of a request to assign a set of resources to a backup plan. * **BackupPlanId** *(string) --* The ID of the backup plan. * **CreationDate** *(datetime) --* 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. **Exceptions** * "Backup.Client.exceptions.LimitExceededException" * "Backup.Client.exceptions.AlreadyExistsException" * "Backup.Client.exceptions.InvalidParameterValueException" * "Backup.Client.exceptions.MissingParameterValueException" * "Backup.Client.exceptions.ServiceUnavailableException" Backup / Client / delete_report_plan delete_report_plan ****************** Backup.Client.delete_report_plan(**kwargs) Deletes the report plan specified by a report plan name. See also: AWS API Documentation **Request Syntax** response = client.delete_report_plan( ReportPlanName='string' ) Parameters: **ReportPlanName** (*string*) -- **[REQUIRED]** The unique name of a report plan. Returns: None **Exceptions** * "Backup.Client.exceptions.MissingParameterValueException" * "Backup.Client.exceptions.InvalidParameterValueException" * "Backup.Client.exceptions.ConflictException" * "Backup.Client.exceptions.ServiceUnavailableException" * "Backup.Client.exceptions.ResourceNotFoundException" Backup / Client / create_restore_access_backup_vault create_restore_access_backup_vault ********************************** Backup.Client.create_restore_access_backup_vault(**kwargs) Creates a restore access backup vault that provides temporary access to recovery points in a logically air-gapped backup vault, subject to MPA approval. See also: AWS API Documentation **Request Syntax** response = client.create_restore_access_backup_vault( SourceBackupVaultArn='string', BackupVaultName='string', BackupVaultTags={ 'string': 'string' }, CreatorRequestId='string', RequesterComment='string' ) Parameters: * **SourceBackupVaultArn** (*string*) -- **[REQUIRED]** The ARN of the source backup vault containing the recovery points to which temporary access is requested. * **BackupVaultName** (*string*) -- The name of the backup vault to associate with an MPA approval team. * **BackupVaultTags** (*dict*) -- Optional tags to assign to the restore access backup vault. * *(string) --* * *(string) --* * **CreatorRequestId** (*string*) -- A unique string that identifies the request and allows failed requests to be retried without the risk of executing the operation twice. This field is autopopulated if not provided. * **RequesterComment** (*string*) -- A comment explaining the reason for requesting restore access to the backup vault. Return type: dict Returns: **Response Syntax** { 'RestoreAccessBackupVaultArn': 'string', 'VaultState': 'CREATING'|'AVAILABLE'|'FAILED', 'RestoreAccessBackupVaultName': 'string', 'CreationDate': datetime(2015, 1, 1) } **Response Structure** * *(dict) --* * **RestoreAccessBackupVaultArn** *(string) --* The ARN that uniquely identifies the created restore access backup vault. * **VaultState** *(string) --* The current state of the restore access backup vault. * **RestoreAccessBackupVaultName** *(string) --* The name of the created restore access backup vault. * **CreationDate** *(datetime) --* >The date and time when the restore access backup vault was created, in Unix format and Coordinated Universal Time **Exceptions** * "Backup.Client.exceptions.AlreadyExistsException" * "Backup.Client.exceptions.InvalidParameterValueException" * "Backup.Client.exceptions.LimitExceededException" * "Backup.Client.exceptions.MissingParameterValueException" * "Backup.Client.exceptions.ResourceNotFoundException" * "Backup.Client.exceptions.InvalidRequestException" * "Backup.Client.exceptions.ServiceUnavailableException" Backup / Client / list_recovery_points_by_resource list_recovery_points_by_resource ******************************** Backup.Client.list_recovery_points_by_resource(**kwargs) The information about the recovery points of the type specified by a resource Amazon Resource Name (ARN). Note: For Amazon EFS and Amazon EC2, this action only lists recovery points created by Backup. See also: AWS API Documentation **Request Syntax** response = client.list_recovery_points_by_resource( ResourceArn='string', NextToken='string', MaxResults=123, ManagedByAWSBackupOnly=True|False ) Parameters: * **ResourceArn** (*string*) -- **[REQUIRED]** An ARN that uniquely identifies a resource. The format of the ARN depends on the resource type. * **NextToken** (*string*) -- 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. * **MaxResults** (*integer*) -- The maximum number of items to be returned. Note: Amazon RDS requires a value of at least 20. * **ManagedByAWSBackupOnly** (*boolean*) -- 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 Return type: dict Returns: **Response Syntax** { 'NextToken': 'string', 'RecoveryPoints': [ { 'RecoveryPointArn': 'string', 'CreationDate': datetime(2015, 1, 1), 'Status': 'COMPLETED'|'PARTIAL'|'DELETING'|'EXPIRED'|'AVAILABLE'|'STOPPED'|'CREATING', 'StatusMessage': 'string', 'EncryptionKeyArn': 'string', 'BackupSizeBytes': 123, 'BackupVaultName': 'string', 'IsParent': True|False, 'ParentRecoveryPointArn': 'string', 'ResourceName': 'string', 'VaultType': 'BACKUP_VAULT'|'LOGICALLY_AIR_GAPPED_BACKUP_VAULT'|'RESTORE_ACCESS_BACKUP_VAULT', 'IndexStatus': 'PENDING'|'ACTIVE'|'FAILED'|'DELETING', 'IndexStatusMessage': 'string' }, ] } **Response Structure** * *(dict) --* * **NextToken** *(string) --* 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** *(list) --* An array of objects that contain detailed information about recovery points of the specified resource type. Note: Only Amazon EFS and Amazon EC2 recovery points return BackupVaultName. * *(dict) --* Contains detailed information about a saved recovery point. * **RecoveryPointArn** *(string) --* 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** *(datetime) --* 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** *(string) --* A status code specifying the state of the recovery point. * **StatusMessage** *(string) --* A message explaining the current status of the recovery point. * **EncryptionKeyArn** *(string) --* 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** *(integer) --* The size, in bytes, of a backup. * **BackupVaultName** *(string) --* 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. * **IsParent** *(boolean) --* This is a boolean value indicating this is a parent (composite) recovery point. * **ParentRecoveryPointArn** *(string) --* The Amazon Resource Name (ARN) of the parent (composite) recovery point. * **ResourceName** *(string) --* The non-unique name of the resource that belongs to the specified backup. * **VaultType** *(string) --* The type of vault in which the described recovery point is stored. * **IndexStatus** *(string) --* This is the current status for the backup index associated with the specified recovery point. Statuses are: "PENDING" | "ACTIVE" | "FAILED" | "DELETING" A recovery point with an index that has the status of "ACTIVE" can be included in a search. * **IndexStatusMessage** *(string) --* A string in the form of a detailed message explaining the status of a backup index associated with the recovery point. **Exceptions** * "Backup.Client.exceptions.ResourceNotFoundException" * "Backup.Client.exceptions.InvalidParameterValueException" * "Backup.Client.exceptions.MissingParameterValueException" * "Backup.Client.exceptions.ServiceUnavailableException" Backup / Client / disassociate_recovery_point_from_parent disassociate_recovery_point_from_parent *************************************** Backup.Client.disassociate_recovery_point_from_parent(**kwargs) This action to a specific child (nested) recovery point removes the relationship between the specified recovery point and its parent (composite) recovery point. See also: AWS API Documentation **Request Syntax** response = client.disassociate_recovery_point_from_parent( BackupVaultName='string', RecoveryPointArn='string' ) Parameters: * **BackupVaultName** (*string*) -- **[REQUIRED]** 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. * **RecoveryPointArn** (*string*) -- **[REQUIRED]** 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." Returns: None **Exceptions** * "Backup.Client.exceptions.ResourceNotFoundException" * "Backup.Client.exceptions.InvalidParameterValueException" * "Backup.Client.exceptions.MissingParameterValueException" * "Backup.Client.exceptions.ServiceUnavailableException" * "Backup.Client.exceptions.InvalidRequestException" Backup / Client / list_report_plans list_report_plans ***************** Backup.Client.list_report_plans(**kwargs) Returns a list of your report plans. For detailed information about a single report plan, use "DescribeReportPlan". See also: AWS API Documentation **Request Syntax** response = client.list_report_plans( MaxResults=123, NextToken='string' ) Parameters: * **MaxResults** (*integer*) -- The number of desired results from 1 to 1000. Optional. If unspecified, the query will return 1 MB of data. * **NextToken** (*string*) -- 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. Return type: dict Returns: **Response Syntax** { 'ReportPlans': [ { 'ReportPlanArn': 'string', 'ReportPlanName': 'string', 'ReportPlanDescription': 'string', 'ReportSetting': { 'ReportTemplate': 'string', 'FrameworkArns': [ 'string', ], 'NumberOfFrameworks': 123, 'Accounts': [ 'string', ], 'OrganizationUnits': [ 'string', ], 'Regions': [ 'string', ] }, 'ReportDeliveryChannel': { 'S3BucketName': 'string', 'S3KeyPrefix': 'string', 'Formats': [ 'string', ] }, 'DeploymentStatus': 'string', 'CreationTime': datetime(2015, 1, 1), 'LastAttemptedExecutionTime': datetime(2015, 1, 1), 'LastSuccessfulExecutionTime': datetime(2015, 1, 1) }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **ReportPlans** *(list) --* The 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. * *(dict) --* Contains detailed information about a report plan. * **ReportPlanArn** *(string) --* An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type. * **ReportPlanName** *(string) --* 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** *(string) --* An optional description of the report plan with a maximum 1,024 characters. * **ReportSetting** *(dict) --* 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. * **ReportTemplate** *(string) --* 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** *(list) --* The Amazon Resource Names (ARNs) of the frameworks a report covers. * *(string) --* * **NumberOfFrameworks** *(integer) --* The number of frameworks a report covers. * **Accounts** *(list) --* These are the accounts to be included in the report. Use string value of "ROOT" to include all organizational units. * *(string) --* * **OrganizationUnits** *(list) --* These are the Organizational Units to be included in the report. * *(string) --* * **Regions** *(list) --* These are the Regions to be included in the report. Use the wildcard as the string value to include all Regions. * *(string) --* * **ReportDeliveryChannel** *(dict) --* 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. * **S3BucketName** *(string) --* The unique name of the S3 bucket that receives your reports. * **S3KeyPrefix** *(string) --* 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** *(list) --* The format of your reports: "CSV", "JSON", or both. If not specified, the default format is "CSV". * *(string) --* * **DeploymentStatus** *(string) --* The deployment status of a report plan. The statuses are: "CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | COMPLETED" * **CreationTime** *(datetime) --* 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** *(datetime) --* 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** *(datetime) --* 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. * **NextToken** *(string) --* 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. **Exceptions** * "Backup.Client.exceptions.InvalidParameterValueException" * "Backup.Client.exceptions.ServiceUnavailableException" Backup / Client / put_backup_vault_lock_configuration put_backup_vault_lock_configuration *********************************** Backup.Client.put_backup_vault_lock_configuration(**kwargs) 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. Note: Backup Vault Lock has been assessed by Cohasset Associates for use in environments that are subject to SEC 17a-4, CFTC, and FINRA regulations. For more information about how Backup Vault Lock relates to these regulations, see the Cohasset Associates Compliance Assessment. For more information, see Backup Vault Lock. See also: AWS API Documentation **Request Syntax** response = client.put_backup_vault_lock_configuration( BackupVaultName='string', MinRetentionDays=123, MaxRetentionDays=123, ChangeableForDays=123 ) Parameters: * **BackupVaultName** (*string*) -- **[REQUIRED]** The Backup Vault Lock configuration that specifies the name of the backup vault it protects. * **MinRetentionDays** (*integer*) -- 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). This parameter is required when a vault lock is created through CloudFormation; otherwise, this parameter is optional. 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** (*integer*) -- 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** (*integer*) -- 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. Returns: None **Exceptions** * "Backup.Client.exceptions.ResourceNotFoundException" * "Backup.Client.exceptions.InvalidParameterValueException" * "Backup.Client.exceptions.MissingParameterValueException" * "Backup.Client.exceptions.InvalidRequestException" * "Backup.Client.exceptions.ServiceUnavailableException" Backup / Client / list_copy_jobs list_copy_jobs ************** Backup.Client.list_copy_jobs(**kwargs) Returns metadata about your copy jobs. See also: AWS API Documentation **Request Syntax** response = client.list_copy_jobs( NextToken='string', MaxResults=123, ByResourceArn='string', ByState='CREATED'|'RUNNING'|'COMPLETED'|'FAILED'|'PARTIAL', ByCreatedBefore=datetime(2015, 1, 1), ByCreatedAfter=datetime(2015, 1, 1), ByResourceType='string', ByDestinationVaultArn='string', ByAccountId='string', ByCompleteBefore=datetime(2015, 1, 1), ByCompleteAfter=datetime(2015, 1, 1), ByParentJobId='string', ByMessageCategory='string' ) Parameters: * **NextToken** (*string*) -- 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. * **MaxResults** (*integer*) -- The maximum number of items to be returned. * **ByResourceArn** (*string*) -- Returns only copy jobs that match the specified resource Amazon Resource Name (ARN). * **ByState** (*string*) -- Returns only copy jobs that are in the specified state. * **ByCreatedBefore** (*datetime*) -- Returns only copy jobs that were created before the specified date. * **ByCreatedAfter** (*datetime*) -- Returns only copy jobs that were created after the specified date. * **ByResourceType** (*string*) -- Returns only backup jobs for the specified resources: * "Aurora" for Amazon Aurora * "CloudFormation" for CloudFormation * "DocumentDB" for Amazon DocumentDB (with MongoDB compatibility) * "DynamoDB" for Amazon DynamoDB * "EBS" for Amazon Elastic Block Store * "EC2" for Amazon Elastic Compute Cloud * "EFS" for Amazon Elastic File System * "FSx" for Amazon FSx * "Neptune" for Amazon Neptune * "RDS" for Amazon Relational Database Service * "Redshift" for Amazon Redshift * "S3" for Amazon Simple Storage Service (Amazon S3) * "SAP HANA on Amazon EC2" for SAP HANA databases on Amazon Elastic Compute Cloud instances * "Storage Gateway" for Storage Gateway * "Timestream" for Amazon Timestream * "VirtualMachine" for VMware virtual machines * **ByDestinationVaultArn** (*string*) -- An Amazon Resource Name (ARN) that uniquely identifies a source backup vault to copy from; for example, "arn:aws:backup:us-east-1:123456789012 :backup-vault:aBackupVault". * **ByAccountId** (*string*) -- The account ID to list the jobs from. Returns only copy jobs associated with the specified account ID. * **ByCompleteBefore** (*datetime*) -- Returns only copy jobs completed before a date expressed in Unix format and Coordinated Universal Time (UTC). * **ByCompleteAfter** (*datetime*) -- Returns only copy jobs completed after a date expressed in Unix format and Coordinated Universal Time (UTC). * **ByParentJobId** (*string*) -- This is a filter to list child (nested) jobs based on parent job ID. * **ByMessageCategory** (*string*) -- 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. Return type: dict Returns: **Response Syntax** { 'CopyJobs': [ { 'AccountId': 'string', 'CopyJobId': 'string', 'SourceBackupVaultArn': 'string', 'SourceRecoveryPointArn': 'string', 'DestinationBackupVaultArn': 'string', 'DestinationRecoveryPointArn': 'string', 'ResourceArn': 'string', 'CreationDate': datetime(2015, 1, 1), 'CompletionDate': datetime(2015, 1, 1), 'State': 'CREATED'|'RUNNING'|'COMPLETED'|'FAILED'|'PARTIAL', 'StatusMessage': 'string', 'BackupSizeInBytes': 123, 'IamRoleArn': 'string', 'CreatedBy': { 'BackupPlanId': 'string', 'BackupPlanArn': 'string', 'BackupPlanVersion': 'string', 'BackupRuleId': 'string' }, 'ResourceType': 'string', 'ParentJobId': 'string', 'IsParent': True|False, 'CompositeMemberIdentifier': 'string', 'NumberOfChildJobs': 123, 'ChildJobsInState': { 'string': 123 }, 'ResourceName': 'string', 'MessageCategory': 'string' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **CopyJobs** *(list) --* An array of structures containing metadata about your copy jobs returned in JSON format. * *(dict) --* Contains detailed information about a copy job. * **AccountId** *(string) --* The account ID that owns the copy job. * **CopyJobId** *(string) --* Uniquely identifies a copy job. * **SourceBackupVaultArn** *(string) --* An Amazon Resource Name (ARN) that uniquely identifies a source copy vault; for example, "arn:aws:backup:us- east-1:123456789012:backup-vault:aBackupVault". * **SourceRecoveryPointArn** *(string) --* 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** *(string) --* An Amazon Resource Name (ARN) that uniquely identifies a destination copy vault; for example, "arn:aws:backup:us- east-1:123456789012:backup-vault:aBackupVault". * **DestinationRecoveryPointArn** *(string) --* 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** *(string) --* 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** *(datetime) --* 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** *(datetime) --* 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** *(string) --* The current state of a copy job. * **StatusMessage** *(string) --* A detailed message explaining the status of the job to copy a resource. * **BackupSizeInBytes** *(integer) --* The size, in bytes, of a copy job. * **IamRoleArn** *(string) --* Specifies the IAM role ARN used to copy the target recovery point; for example, "arn:aws:iam::123456789012:role/S3Access". * **CreatedBy** *(dict) --* Contains information about the backup plan and rule that Backup used to initiate the recovery point backup. * **BackupPlanId** *(string) --* Uniquely identifies a backup plan. * **BackupPlanArn** *(string) --* 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** *(string) --* Version IDs are unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes long. They cannot be edited. * **BackupRuleId** *(string) --* Uniquely identifies a rule used to schedule the backup of a selection of resources. * **ResourceType** *(string) --* 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** *(string) --* This uniquely identifies a request to Backup to copy a resource. The return will be the parent (composite) job ID. * **IsParent** *(boolean) --* This is a boolean value indicating this is a parent (composite) copy job. * **CompositeMemberIdentifier** *(string) --* 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** *(integer) --* The number of child (nested) copy jobs. * **ChildJobsInState** *(dict) --* This returns the statistics of the included child (nested) copy jobs. * *(string) --* * *(integer) --* * **ResourceName** *(string) --* The non-unique name of the resource that belongs to the specified backup. * **MessageCategory** *(string) --* 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 * **NextToken** *(string) --* 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. **Exceptions** * "Backup.Client.exceptions.InvalidParameterValueException" * "Backup.Client.exceptions.ServiceUnavailableException" Backup / Client / get_backup_plan get_backup_plan *************** Backup.Client.get_backup_plan(**kwargs) Returns "BackupPlan" details for the specified "BackupPlanId". The details are the body of a backup plan in JSON format, in addition to plan metadata. See also: AWS API Documentation **Request Syntax** response = client.get_backup_plan( BackupPlanId='string', VersionId='string' ) Parameters: * **BackupPlanId** (*string*) -- **[REQUIRED]** Uniquely identifies a backup plan. * **VersionId** (*string*) -- Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes long. Version IDs cannot be edited. Return type: dict Returns: **Response Syntax** { 'BackupPlan': { 'BackupPlanName': 'string', 'Rules': [ { 'RuleName': 'string', 'TargetBackupVaultName': 'string', 'ScheduleExpression': 'string', 'StartWindowMinutes': 123, 'CompletionWindowMinutes': 123, 'Lifecycle': { 'MoveToColdStorageAfterDays': 123, 'DeleteAfterDays': 123, 'OptInToArchiveForSupportedResources': True|False }, 'RecoveryPointTags': { 'string': 'string' }, 'RuleId': 'string', 'CopyActions': [ { 'Lifecycle': { 'MoveToColdStorageAfterDays': 123, 'DeleteAfterDays': 123, 'OptInToArchiveForSupportedResources': True|False }, 'DestinationBackupVaultArn': 'string' }, ], 'EnableContinuousBackup': True|False, 'ScheduleExpressionTimezone': 'string', 'IndexActions': [ { 'ResourceTypes': [ 'string', ] }, ] }, ], 'AdvancedBackupSettings': [ { 'ResourceType': 'string', 'BackupOptions': { 'string': 'string' } }, ] }, 'BackupPlanId': 'string', 'BackupPlanArn': 'string', 'VersionId': 'string', 'CreatorRequestId': 'string', 'CreationDate': datetime(2015, 1, 1), 'DeletionDate': datetime(2015, 1, 1), 'LastExecutionDate': datetime(2015, 1, 1), 'AdvancedBackupSettings': [ { 'ResourceType': 'string', 'BackupOptions': { 'string': 'string' } }, ] } **Response Structure** * *(dict) --* * **BackupPlan** *(dict) --* Specifies the body of a backup plan. Includes a "BackupPlanName" and one or more sets of "Rules". * **BackupPlanName** *(string) --* The display name of a backup plan. Must contain only alphanumeric or '-_.' special characters. If this is set in the console, it can contain 1 to 50 characters; if this is set through CLI or API, it can contain 1 to 200 characters. * **Rules** *(list) --* An array of "BackupRule" objects, each of which specifies a scheduled task that is used to back up a selection of resources. * *(dict) --* Specifies a scheduled task used to back up a selection of resources. * **RuleName** *(string) --* A display name for a backup rule. Must contain 1 to 50 alphanumeric or '-_.' characters. * **TargetBackupVaultName** *(string) --* 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. * **ScheduleExpression** *(string) --* A cron expression in UTC specifying when Backup initiates a backup job. When no CRON expression is provided, Backup will use the default expression "cron(0 5 ? * * *)". 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** *(integer) --* 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** *(integer) --* 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** *(dict) --* The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. Backup transitions and expires backups automatically according to the lifecycle that you define. Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, the “retention” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold. Resource types that can transition to cold storage are listed in the Feature availability by resource table. Backup ignores this expression for other resource types. * **MoveToColdStorageAfterDays** *(integer) --* The number of days after creation that a recovery point is moved to cold storage. * **DeleteAfterDays** *(integer) --* The number of days after creation that a recovery point is deleted. This value must be at least 90 days after the number of days specified in "MoveToColdStorageAfterDays". * **OptInToArchiveForSupportedResources** *(boolean) --* If the value is true, your backup plan transitions supported resources to archive (cold) storage tier in accordance with your lifecycle settings. * **RecoveryPointTags** *(dict) --* The tags that are assigned to resources that are associated with this rule when restored from backup. * *(string) --* * *(string) --* * **RuleId** *(string) --* Uniquely identifies a rule that is used to schedule the backup of a selection of resources. * **CopyActions** *(list) --* An array of "CopyAction" objects, which contains the details of the copy operation. * *(dict) --* The details of the copy operation. * **Lifecycle** *(dict) --* Specifies the time period, in days, before a recovery point transitions to cold storage or is deleted. Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, on the console, the retention setting must be 90 days greater than the transition to cold after days setting. The transition to cold after days setting can't be changed after a backup has been transitioned to cold. Resource types that can transition to cold storage are listed in the Feature availability by resource table. Backup ignores this expression for other resource types. To remove the existing lifecycle and retention periods and keep your recovery points indefinitely, specify -1 for "MoveToColdStorageAfterDays" and "DeleteAfterDays". * **MoveToColdStorageAfterDays** *(integer) --* The number of days after creation that a recovery point is moved to cold storage. * **DeleteAfterDays** *(integer) --* The number of days after creation that a recovery point is deleted. This value must be at least 90 days after the number of days specified in "MoveToColdStorageAfterDays". * **OptInToArchiveForSupportedResources** *(boolean) --* If the value is true, your backup plan transitions supported resources to archive (cold) storage tier in accordance with your lifecycle settings. * **DestinationBackupVaultArn** *(string) --* 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:backup-vault:aBackupVault". * **EnableContinuousBackup** *(boolean) --* 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** *(string) --* The timezone in which the schedule expression is set. By default, ScheduleExpressions are in UTC. You can modify this to a specified timezone. * **IndexActions** *(list) --* IndexActions is an array you use to specify how backup data should be indexed. eEach BackupRule can have 0 or 1 IndexAction, as each backup can have up to one index associated with it. Within the array is ResourceType. Only one will be accepted for each BackupRule. * *(dict) --* This is an optional array within a BackupRule. IndexAction consists of one ResourceTypes. * **ResourceTypes** *(list) --* 0 or 1 index action will be accepted for each BackupRule. Valid values: * "EBS" for Amazon Elastic Block Store * "S3" for Amazon Simple Storage Service (Amazon S3) * *(string) --* * **AdvancedBackupSettings** *(list) --* Contains a list of "BackupOptions" for each resource type. * *(dict) --* The backup options for each resource type. * **ResourceType** *(string) --* 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** *(dict) --* 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. * *(string) --* * *(string) --* * **BackupPlanId** *(string) --* Uniquely identifies a backup plan. * **BackupPlanArn** *(string) --* 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** *(string) --* Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes long. Version IDs cannot be edited. * **CreatorRequestId** *(string) --* A unique string that identifies the request and allows failed requests to be retried without the risk of running the operation twice. * **CreationDate** *(datetime) --* 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** *(datetime) --* 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** *(datetime) --* The last time this backup plan was run. 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** *(list) --* Contains a list of "BackupOptions" for each resource type. The list is populated only if the advanced option is set for the backup plan. * *(dict) --* The backup options for each resource type. * **ResourceType** *(string) --* 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** *(dict) --* 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. * *(string) --* * *(string) --* **Exceptions** * "Backup.Client.exceptions.ResourceNotFoundException" * "Backup.Client.exceptions.InvalidParameterValueException" * "Backup.Client.exceptions.MissingParameterValueException" * "Backup.Client.exceptions.ServiceUnavailableException" Backup / Client / list_recovery_points_by_legal_hold list_recovery_points_by_legal_hold ********************************** Backup.Client.list_recovery_points_by_legal_hold(**kwargs) This action returns recovery point ARNs (Amazon Resource Names) of the specified legal hold. See also: AWS API Documentation **Request Syntax** response = client.list_recovery_points_by_legal_hold( LegalHoldId='string', NextToken='string', MaxResults=123 ) Parameters: * **LegalHoldId** (*string*) -- **[REQUIRED]** The ID of the legal hold. * **NextToken** (*string*) -- 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. * **MaxResults** (*integer*) -- The maximum number of resource list items to be returned. Return type: dict Returns: **Response Syntax** { 'RecoveryPoints': [ { 'RecoveryPointArn': 'string', 'ResourceArn': 'string', 'ResourceType': 'string', 'BackupVaultName': 'string' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **RecoveryPoints** *(list) --* The recovery points. * *(dict) --* 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. * **RecoveryPointArn** *(string) --* The Amazon Resource Name (ARN) of the parent (composite) recovery point. * **ResourceArn** *(string) --* The Amazon Resource Name (ARN) that uniquely identifies a saved resource. * **ResourceType** *(string) --* The Amazon Web Services resource type that is saved as a recovery point. * **BackupVaultName** *(string) --* The name of the backup vault (the logical container in which backups are stored). * **NextToken** *(string) --* The next item following a partial list of returned resources. **Exceptions** * "Backup.Client.exceptions.InvalidParameterValueException" * "Backup.Client.exceptions.MissingParameterValueException" * "Backup.Client.exceptions.ServiceUnavailableException" Backup / Client / describe_report_plan describe_report_plan ******************** Backup.Client.describe_report_plan(**kwargs) Returns a list of all report plans for an Amazon Web Services account and Amazon Web Services Region. See also: AWS API Documentation **Request Syntax** response = client.describe_report_plan( ReportPlanName='string' ) Parameters: **ReportPlanName** (*string*) -- **[REQUIRED]** The unique name of a report plan. Return type: dict Returns: **Response Syntax** { 'ReportPlan': { 'ReportPlanArn': 'string', 'ReportPlanName': 'string', 'ReportPlanDescription': 'string', 'ReportSetting': { 'ReportTemplate': 'string', 'FrameworkArns': [ 'string', ], 'NumberOfFrameworks': 123, 'Accounts': [ 'string', ], 'OrganizationUnits': [ 'string', ], 'Regions': [ 'string', ] }, 'ReportDeliveryChannel': { 'S3BucketName': 'string', 'S3KeyPrefix': 'string', 'Formats': [ 'string', ] }, 'DeploymentStatus': 'string', 'CreationTime': datetime(2015, 1, 1), 'LastAttemptedExecutionTime': datetime(2015, 1, 1), 'LastSuccessfulExecutionTime': datetime(2015, 1, 1) } } **Response Structure** * *(dict) --* * **ReportPlan** *(dict) --* 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. * **ReportPlanArn** *(string) --* An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type. * **ReportPlanName** *(string) --* 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** *(string) --* An optional description of the report plan with a maximum 1,024 characters. * **ReportSetting** *(dict) --* 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. * **ReportTemplate** *(string) --* 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** *(list) --* The Amazon Resource Names (ARNs) of the frameworks a report covers. * *(string) --* * **NumberOfFrameworks** *(integer) --* The number of frameworks a report covers. * **Accounts** *(list) --* These are the accounts to be included in the report. Use string value of "ROOT" to include all organizational units. * *(string) --* * **OrganizationUnits** *(list) --* These are the Organizational Units to be included in the report. * *(string) --* * **Regions** *(list) --* These are the Regions to be included in the report. Use the wildcard as the string value to include all Regions. * *(string) --* * **ReportDeliveryChannel** *(dict) --* 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. * **S3BucketName** *(string) --* The unique name of the S3 bucket that receives your reports. * **S3KeyPrefix** *(string) --* 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** *(list) --* The format of your reports: "CSV", "JSON", or both. If not specified, the default format is "CSV". * *(string) --* * **DeploymentStatus** *(string) --* The deployment status of a report plan. The statuses are: "CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | COMPLETED" * **CreationTime** *(datetime) --* 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** *(datetime) --* 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** *(datetime) --* 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. **Exceptions** * "Backup.Client.exceptions.InvalidParameterValueException" * "Backup.Client.exceptions.MissingParameterValueException" * "Backup.Client.exceptions.ResourceNotFoundException" * "Backup.Client.exceptions.ServiceUnavailableException" Backup / Client / list_backup_jobs list_backup_jobs **************** Backup.Client.list_backup_jobs(**kwargs) 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. See also: AWS API Documentation **Request Syntax** response = client.list_backup_jobs( NextToken='string', MaxResults=123, ByResourceArn='string', ByState='CREATED'|'PENDING'|'RUNNING'|'ABORTING'|'ABORTED'|'COMPLETED'|'FAILED'|'EXPIRED'|'PARTIAL', ByBackupVaultName='string', ByCreatedBefore=datetime(2015, 1, 1), ByCreatedAfter=datetime(2015, 1, 1), ByResourceType='string', ByAccountId='string', ByCompleteAfter=datetime(2015, 1, 1), ByCompleteBefore=datetime(2015, 1, 1), ByParentJobId='string', ByMessageCategory='string' ) Parameters: * **NextToken** (*string*) -- 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. * **MaxResults** (*integer*) -- The maximum number of items to be returned. * **ByResourceArn** (*string*) -- Returns only backup jobs that match the specified resource Amazon Resource Name (ARN). * **ByState** (*string*) -- 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 * **ByBackupVaultName** (*string*) -- 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. * **ByCreatedBefore** (*datetime*) -- Returns only backup jobs that were created before the specified date. * **ByCreatedAfter** (*datetime*) -- Returns only backup jobs that were created after the specified date. * **ByResourceType** (*string*) -- Returns only backup jobs for the specified resources: * "Aurora" for Amazon Aurora * "CloudFormation" for CloudFormation * "DocumentDB" for Amazon DocumentDB (with MongoDB compatibility) * "DynamoDB" for Amazon DynamoDB * "EBS" for Amazon Elastic Block Store * "EC2" for Amazon Elastic Compute Cloud * "EFS" for Amazon Elastic File System * "FSx" for Amazon FSx * "Neptune" for Amazon Neptune * "RDS" for Amazon Relational Database Service * "Redshift" for Amazon Redshift * "S3" for Amazon Simple Storage Service (Amazon S3) * "SAP HANA on Amazon EC2" for SAP HANA databases on Amazon Elastic Compute Cloud instances * "Storage Gateway" for Storage Gateway * "Timestream" for Amazon Timestream * "VirtualMachine" for VMware virtual machines * **ByAccountId** (*string*) -- 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. * **ByCompleteAfter** (*datetime*) -- Returns only backup jobs completed after a date expressed in Unix format and Coordinated Universal Time (UTC). * **ByCompleteBefore** (*datetime*) -- Returns only backup jobs completed before a date expressed in Unix format and Coordinated Universal Time (UTC). * **ByParentJobId** (*string*) -- This is a filter to list child (nested) jobs based on parent job ID. * **ByMessageCategory** (*string*) -- 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. Return type: dict Returns: **Response Syntax** { 'BackupJobs': [ { 'AccountId': 'string', 'BackupJobId': 'string', 'BackupVaultName': 'string', 'BackupVaultArn': 'string', 'RecoveryPointArn': 'string', 'ResourceArn': 'string', 'CreationDate': datetime(2015, 1, 1), 'CompletionDate': datetime(2015, 1, 1), 'State': 'CREATED'|'PENDING'|'RUNNING'|'ABORTING'|'ABORTED'|'COMPLETED'|'FAILED'|'EXPIRED'|'PARTIAL', 'StatusMessage': 'string', 'PercentDone': 'string', 'BackupSizeInBytes': 123, 'IamRoleArn': 'string', 'CreatedBy': { 'BackupPlanId': 'string', 'BackupPlanArn': 'string', 'BackupPlanVersion': 'string', 'BackupRuleId': 'string' }, 'ExpectedCompletionDate': datetime(2015, 1, 1), 'StartBy': datetime(2015, 1, 1), 'ResourceType': 'string', 'BytesTransferred': 123, 'BackupOptions': { 'string': 'string' }, 'BackupType': 'string', 'ParentJobId': 'string', 'IsParent': True|False, 'ResourceName': 'string', 'InitiationDate': datetime(2015, 1, 1), 'MessageCategory': 'string' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **BackupJobs** *(list) --* An array of structures containing metadata about your backup jobs returned in JSON format. * *(dict) --* Contains detailed information about a backup job. * **AccountId** *(string) --* The account ID that owns the backup job. * **BackupJobId** *(string) --* Uniquely identifies a request to Backup to back up a resource. * **BackupVaultName** *(string) --* 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. * **BackupVaultArn** *(string) --* An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, "arn:aws:backup:us- east-1:123456789012:backup-vault:aBackupVault". * **RecoveryPointArn** *(string) --* 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** *(string) --* An ARN that uniquely identifies a resource. The format of the ARN depends on the resource type. * **CreationDate** *(datetime) --* 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** *(datetime) --* 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** *(string) --* The current state of a backup job. * **StatusMessage** *(string) --* A detailed message explaining the status of the job to back up a resource. * **PercentDone** *(string) --* Contains an estimated percentage complete of a job at the time the job status was queried. * **BackupSizeInBytes** *(integer) --* The size, in bytes, of a backup (recovery point). This value can render differently depending on the resource type as Backup pulls in data information from other Amazon Web Services services. For example, the value returned may show a value of "0", which may differ from the anticipated value. The expected behavior for values by resource type are described as follows: * Amazon Aurora, Amazon DocumentDB, and Amazon Neptune do not have this value populate from the operation "GetBackupJobStatus". * For Amazon DynamoDB with advanced features, this value refers to the size of the recovery point (backup). * Amazon EC2 and Amazon EBS show volume size (provisioned storage) returned as part of this value. Amazon EBS does not return backup size information; snapshot size will have the same value as the original resource that was backed up. * For Amazon EFS, this value refers to the delta bytes transferred during a backup. * Amazon FSx does not populate this value from the operation "GetBackupJobStatus" for FSx file systems. * An Amazon RDS instance will show as "0". * For virtual machines running VMware, this value is passed to Backup through an asynchronous workflow, which can mean this displayed value can under- represent the actual backup size. * **IamRoleArn** *(string) --* 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** *(dict) --* 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. * **BackupPlanId** *(string) --* Uniquely identifies a backup plan. * **BackupPlanArn** *(string) --* 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** *(string) --* Version IDs are unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes long. They cannot be edited. * **BackupRuleId** *(string) --* Uniquely identifies a rule used to schedule the backup of a selection of resources. * **ExpectedCompletionDate** *(datetime) --* 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** *(datetime) --* 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** *(string) --* 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** *(integer) --* The size in bytes transferred to a backup vault at the time that the job status was queried. * **BackupOptions** *(dict) --* 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. * *(string) --* * *(string) --* * **BackupType** *(string) --* Represents the type of backup for a backup job. * **ParentJobId** *(string) --* This uniquely identifies a request to Backup to back up a resource. The return will be the parent (composite) job ID. * **IsParent** *(boolean) --* This is a boolean value indicating this is a parent (composite) backup job. * **ResourceName** *(string) --* The non-unique name of the resource that belongs to the specified backup. * **InitiationDate** *(datetime) --* The date on which the backup job was initiated. * **MessageCategory** *(string) --* 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. * **NextToken** *(string) --* 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. **Exceptions** * "Backup.Client.exceptions.InvalidParameterValueException" * "Backup.Client.exceptions.ServiceUnavailableException" Backup / Client / get_legal_hold get_legal_hold ************** Backup.Client.get_legal_hold(**kwargs) 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. See also: AWS API Documentation **Request Syntax** response = client.get_legal_hold( LegalHoldId='string' ) Parameters: **LegalHoldId** (*string*) -- **[REQUIRED]** The ID of the legal hold. Return type: dict Returns: **Response Syntax** { 'Title': 'string', 'Status': 'CREATING'|'ACTIVE'|'CANCELING'|'CANCELED', 'Description': 'string', 'CancelDescription': 'string', 'LegalHoldId': 'string', 'LegalHoldArn': 'string', 'CreationDate': datetime(2015, 1, 1), 'CancellationDate': datetime(2015, 1, 1), 'RetainRecordUntil': datetime(2015, 1, 1), 'RecoveryPointSelection': { 'VaultNames': [ 'string', ], 'ResourceIdentifiers': [ 'string', ], 'DateRange': { 'FromDate': datetime(2015, 1, 1), 'ToDate': datetime(2015, 1, 1) } } } **Response Structure** * *(dict) --* * **Title** *(string) --* The title of the legal hold. * **Status** *(string) --* The status of the legal hold. * **Description** *(string) --* The description of the legal hold. * **CancelDescription** *(string) --* The reason for removing the legal hold. * **LegalHoldId** *(string) --* The ID of the legal hold. * **LegalHoldArn** *(string) --* The framework ARN for the specified legal hold. The format of the ARN depends on the resource type. * **CreationDate** *(datetime) --* The time when the legal hold was created. * **CancellationDate** *(datetime) --* The time when the legal hold was cancelled. * **RetainRecordUntil** *(datetime) --* The date and time until which the legal hold record is retained. * **RecoveryPointSelection** *(dict) --* The criteria to assign a set of resources, such as resource types or backup vaults. * **VaultNames** *(list) --* These are the names of the vaults in which the selected recovery points are contained. * *(string) --* * **ResourceIdentifiers** *(list) --* These are the resources included in the resource selection (including type of resources and vaults). * *(string) --* * **DateRange** *(dict) --* 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. * **FromDate** *(datetime) --* 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** *(datetime) --* 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). **Exceptions** * "Backup.Client.exceptions.InvalidParameterValueException" * "Backup.Client.exceptions.MissingParameterValueException" * "Backup.Client.exceptions.ServiceUnavailableException" * "Backup.Client.exceptions.ResourceNotFoundException" Backup / Client / update_region_settings update_region_settings ********************** Backup.Client.update_region_settings(**kwargs) Updates the current service opt-in settings for the Region. Use the "DescribeRegionSettings" API to determine the resource types that are supported. See also: AWS API Documentation **Request Syntax** response = client.update_region_settings( ResourceTypeOptInPreference={ 'string': True|False }, ResourceTypeManagementPreference={ 'string': True|False } ) Parameters: * **ResourceTypeOptInPreference** (*dict*) -- 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. * *(string) --* * *(boolean) --* * **ResourceTypeManagementPreference** (*dict*) -- 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. * *(string) --* * *(boolean) --* Returns: None **Exceptions** * "Backup.Client.exceptions.ServiceUnavailableException" * "Backup.Client.exceptions.MissingParameterValueException" * "Backup.Client.exceptions.InvalidParameterValueException" Backup / Client / list_report_jobs list_report_jobs **************** Backup.Client.list_report_jobs(**kwargs) Returns details about your report jobs. See also: AWS API Documentation **Request Syntax** response = client.list_report_jobs( ByReportPlanName='string', ByCreationBefore=datetime(2015, 1, 1), ByCreationAfter=datetime(2015, 1, 1), ByStatus='string', MaxResults=123, NextToken='string' ) Parameters: * **ByReportPlanName** (*string*) -- Returns only report jobs with the specified report plan name. * **ByCreationBefore** (*datetime*) -- 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. * **ByCreationAfter** (*datetime*) -- 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. * **ByStatus** (*string*) -- Returns only report jobs that are in the specified status. The statuses are: "CREATED | RUNNING | COMPLETED | FAILED" * **MaxResults** (*integer*) -- The number of desired results from 1 to 1000. Optional. If unspecified, the query will return 1 MB of data. * **NextToken** (*string*) -- 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. Return type: dict Returns: **Response Syntax** { 'ReportJobs': [ { 'ReportJobId': 'string', 'ReportPlanArn': 'string', 'ReportTemplate': 'string', 'CreationTime': datetime(2015, 1, 1), 'CompletionTime': datetime(2015, 1, 1), 'Status': 'string', 'StatusMessage': 'string', 'ReportDestination': { 'S3BucketName': 'string', 'S3Keys': [ 'string', ] } }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **ReportJobs** *(list) --* Details about your report jobs in JSON format. * *(dict) --* 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** *(string) --* 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** *(string) --* An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type. * **ReportTemplate** *(string) --* 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** *(datetime) --* 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** *(datetime) --* 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** *(string) --* 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** *(string) --* A message explaining the status of the report job. * **ReportDestination** *(dict) --* The S3 bucket name and S3 keys for the destination where the report job publishes the report. * **S3BucketName** *(string) --* The unique name of the Amazon S3 bucket that receives your reports. * **S3Keys** *(list) --* The object key that uniquely identifies your reports in your S3 bucket. * *(string) --* * **NextToken** *(string) --* 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. **Exceptions** * "Backup.Client.exceptions.InvalidParameterValueException" * "Backup.Client.exceptions.ServiceUnavailableException" * "Backup.Client.exceptions.ResourceNotFoundException" Backup / Client / get_restore_testing_inferred_metadata get_restore_testing_inferred_metadata ************************************* Backup.Client.get_restore_testing_inferred_metadata(**kwargs) 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. See also: AWS API Documentation **Request Syntax** response = client.get_restore_testing_inferred_metadata( BackupVaultAccountId='string', BackupVaultName='string', RecoveryPointArn='string' ) Parameters: * **BackupVaultAccountId** (*string*) -- The account ID of the specified backup vault. * **BackupVaultName** (*string*) -- **[REQUIRED]** 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. * **RecoveryPointArn** (*string*) -- **[REQUIRED]** 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". Return type: dict Returns: **Response Syntax** { 'InferredMetadata': { 'string': 'string' } } **Response Structure** * *(dict) --* * **InferredMetadata** *(dict) --* This is a string map of the metadata inferred from the request. * *(string) --* * *(string) --* **Exceptions** * "Backup.Client.exceptions.InvalidParameterValueException" * "Backup.Client.exceptions.MissingParameterValueException" * "Backup.Client.exceptions.ResourceNotFoundException" * "Backup.Client.exceptions.ServiceUnavailableException" Backup / Client / update_recovery_point_index_settings update_recovery_point_index_settings ************************************ Backup.Client.update_recovery_point_index_settings(**kwargs) This operation updates the settings of a recovery point index. Required: BackupVaultName, RecoveryPointArn, and IAMRoleArn See also: AWS API Documentation **Request Syntax** response = client.update_recovery_point_index_settings( BackupVaultName='string', RecoveryPointArn='string', IamRoleArn='string', Index='ENABLED'|'DISABLED' ) Parameters: * **BackupVaultName** (*string*) -- **[REQUIRED]** 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. Accepted characters include lowercase letters, numbers, and hyphens. * **RecoveryPointArn** (*string*) -- **[REQUIRED]** An ARN that uniquely identifies a recovery point; for example, "arn:aws:backup:us-east-1:123456789012:recovery- point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45". * **IamRoleArn** (*string*) -- This specifies the IAM role ARN used for this operation. For example, arn:aws:iam::123456789012:role/S3Access * **Index** (*string*) -- **[REQUIRED]** Index can have 1 of 2 possible values, either "ENABLED" or "DISABLED". To create a backup index for an eligible "ACTIVE" recovery point that does not yet have a backup index, set value to "ENABLED". To delete a backup index, set value to "DISABLED". Return type: dict Returns: **Response Syntax** { 'BackupVaultName': 'string', 'RecoveryPointArn': 'string', 'IndexStatus': 'PENDING'|'ACTIVE'|'FAILED'|'DELETING', 'Index': 'ENABLED'|'DISABLED' } **Response Structure** * *(dict) --* * **BackupVaultName** *(string) --* 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. * **RecoveryPointArn** *(string) --* An ARN that uniquely identifies a recovery point; for example, "arn:aws:backup:us-east-1:123456789012:recovery- point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45". * **IndexStatus** *(string) --* This is the current status for the backup index associated with the specified recovery point. Statuses are: "PENDING" | "ACTIVE" | "FAILED" | "DELETING" A recovery point with an index that has the status of "ACTIVE" can be included in a search. * **Index** *(string) --* Index can have 1 of 2 possible values, either "ENABLED" or "DISABLED". A value of "ENABLED" means a backup index for an eligible "ACTIVE" recovery point has been created. A value of "DISABLED" means a backup index was deleted. **Exceptions** * "Backup.Client.exceptions.MissingParameterValueException" * "Backup.Client.exceptions.InvalidParameterValueException" * "Backup.Client.exceptions.InvalidRequestException" * "Backup.Client.exceptions.ResourceNotFoundException" * "Backup.Client.exceptions.ServiceUnavailableException" Backup / Client / list_backup_plan_templates list_backup_plan_templates ************************** Backup.Client.list_backup_plan_templates(**kwargs) Lists the backup plan templates. See also: AWS API Documentation **Request Syntax** response = client.list_backup_plan_templates( NextToken='string', MaxResults=123 ) Parameters: * **NextToken** (*string*) -- 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. * **MaxResults** (*integer*) -- The maximum number of items to return. Return type: dict Returns: **Response Syntax** { 'NextToken': 'string', 'BackupPlanTemplatesList': [ { 'BackupPlanTemplateId': 'string', 'BackupPlanTemplateName': 'string' }, ] } **Response Structure** * *(dict) --* * **NextToken** *(string) --* 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** *(list) --* An array of template list items containing metadata about your saved templates. * *(dict) --* An object specifying metadata associated with a backup plan template. * **BackupPlanTemplateId** *(string) --* Uniquely identifies a stored backup plan template. * **BackupPlanTemplateName** *(string) --* The optional display name of a backup plan template. **Exceptions** * "Backup.Client.exceptions.InvalidParameterValueException" * "Backup.Client.exceptions.MissingParameterValueException" * "Backup.Client.exceptions.ServiceUnavailableException" * "Backup.Client.exceptions.ResourceNotFoundException" Backup / Client / put_backup_vault_access_policy put_backup_vault_access_policy ****************************** Backup.Client.put_backup_vault_access_policy(**kwargs) 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. See also: AWS API Documentation **Request Syntax** response = client.put_backup_vault_access_policy( BackupVaultName='string', Policy='string' ) Parameters: * **BackupVaultName** (*string*) -- **[REQUIRED]** 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. * **Policy** (*string*) -- The backup vault access policy document in JSON format. Returns: None **Exceptions** * "Backup.Client.exceptions.ResourceNotFoundException" * "Backup.Client.exceptions.InvalidParameterValueException" * "Backup.Client.exceptions.MissingParameterValueException" * "Backup.Client.exceptions.ServiceUnavailableException" Backup / Client / list_restore_jobs_by_protected_resource list_restore_jobs_by_protected_resource *************************************** Backup.Client.list_restore_jobs_by_protected_resource(**kwargs) This returns restore jobs that contain the specified protected resource. You must include "ResourceArn". You can optionally include "NextToken", "ByStatus", "MaxResults", "ByRecoveryPointCreationDateAfter" , and "ByRecoveryPointCreationDateBefore". See also: AWS API Documentation **Request Syntax** response = client.list_restore_jobs_by_protected_resource( ResourceArn='string', ByStatus='PENDING'|'RUNNING'|'COMPLETED'|'ABORTED'|'FAILED', ByRecoveryPointCreationDateAfter=datetime(2015, 1, 1), ByRecoveryPointCreationDateBefore=datetime(2015, 1, 1), NextToken='string', MaxResults=123 ) Parameters: * **ResourceArn** (*string*) -- **[REQUIRED]** Returns only restore jobs that match the specified resource Amazon Resource Name (ARN). * **ByStatus** (*string*) -- Returns only restore jobs associated with the specified job status. * **ByRecoveryPointCreationDateAfter** (*datetime*) -- Returns only restore jobs of recovery points that were created after the specified date. * **ByRecoveryPointCreationDateBefore** (*datetime*) -- Returns only restore jobs of recovery points that were created before the specified date. * **NextToken** (*string*) -- 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. * **MaxResults** (*integer*) -- The maximum number of items to be returned. Return type: dict Returns: **Response Syntax** { 'RestoreJobs': [ { 'AccountId': 'string', 'RestoreJobId': 'string', 'RecoveryPointArn': 'string', 'CreationDate': datetime(2015, 1, 1), 'CompletionDate': datetime(2015, 1, 1), 'Status': 'PENDING'|'RUNNING'|'COMPLETED'|'ABORTED'|'FAILED', 'StatusMessage': 'string', 'PercentDone': 'string', 'BackupSizeInBytes': 123, 'IamRoleArn': 'string', 'ExpectedCompletionTimeMinutes': 123, 'CreatedResourceArn': 'string', 'ResourceType': 'string', 'RecoveryPointCreationDate': datetime(2015, 1, 1), 'CreatedBy': { 'RestoreTestingPlanArn': 'string' }, 'ValidationStatus': 'FAILED'|'SUCCESSFUL'|'TIMED_OUT'|'VALIDATING', 'ValidationStatusMessage': 'string', 'DeletionStatus': 'DELETING'|'FAILED'|'SUCCESSFUL', 'DeletionStatusMessage': 'string' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **RestoreJobs** *(list) --* An array of objects that contain detailed information about jobs to restore saved resources.> * *(dict) --* Contains metadata about a restore job. * **AccountId** *(string) --* The account ID that owns the restore job. * **RestoreJobId** *(string) --* Uniquely identifies the job that restores a recovery point. * **RecoveryPointArn** *(string) --* 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** *(datetime) --* 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** *(datetime) --* 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** *(string) --* A status code specifying the state of the job initiated by Backup to restore a recovery point. * **StatusMessage** *(string) --* A detailed message explaining the status of the job to restore a recovery point. * **PercentDone** *(string) --* Contains an estimated percentage complete of a job at the time the job status was queried. * **BackupSizeInBytes** *(integer) --* The size, in bytes, of the restored resource. * **IamRoleArn** *(string) --* The IAM role ARN used to create the target recovery point; for example, "arn:aws:iam::123456789012:role/S3Access". * **ExpectedCompletionTimeMinutes** *(integer) --* The amount of time in minutes that a job restoring a recovery point is expected to take. * **CreatedResourceArn** *(string) --* An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type. * **ResourceType** *(string) --* 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** *(datetime) --* The date on which a recovery point was created. * **CreatedBy** *(dict) --* Contains identifying information about the creation of a restore job. * **RestoreTestingPlanArn** *(string) --* An Amazon Resource Name (ARN) that uniquely identifies a restore testing plan. * **ValidationStatus** *(string) --* The status of validation run on the indicated restore job. * **ValidationStatusMessage** *(string) --* This describes the status of validation run on the indicated restore job. * **DeletionStatus** *(string) --* This notes the status of the data generated by the restore test. The status may be "Deleting", "Failed", or "Successful". * **DeletionStatusMessage** *(string) --* This describes the restore job deletion status. * **NextToken** *(string) --* 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 **Exceptions** * "Backup.Client.exceptions.ResourceNotFoundException" * "Backup.Client.exceptions.InvalidParameterValueException" * "Backup.Client.exceptions.MissingParameterValueException" * "Backup.Client.exceptions.ServiceUnavailableException" Backup / Client / list_protected_resources_by_backup_vault list_protected_resources_by_backup_vault **************************************** Backup.Client.list_protected_resources_by_backup_vault(**kwargs) This request lists the protected resources corresponding to each backup vault. See also: AWS API Documentation **Request Syntax** response = client.list_protected_resources_by_backup_vault( BackupVaultName='string', BackupVaultAccountId='string', NextToken='string', MaxResults=123 ) Parameters: * **BackupVaultName** (*string*) -- **[REQUIRED]** The list of protected resources by backup vault within the vault(s) you specify by name. * **BackupVaultAccountId** (*string*) -- The list of protected resources by backup vault within the vault(s) you specify by account ID. * **NextToken** (*string*) -- 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. * **MaxResults** (*integer*) -- The maximum number of items to be returned. Return type: dict Returns: **Response Syntax** { 'Results': [ { 'ResourceArn': 'string', 'ResourceType': 'string', 'LastBackupTime': datetime(2015, 1, 1), 'ResourceName': 'string', 'LastBackupVaultArn': 'string', 'LastRecoveryPointArn': 'string' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **Results** *(list) --* These are the results returned for the request ListProtectedResourcesByBackupVault. * *(dict) --* A structure that contains information about a backed-up resource. * **ResourceArn** *(string) --* An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type. * **ResourceType** *(string) --* 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** *(datetime) --* 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** *(string) --* The non-unique name of the resource that belongs to the specified backup. * **LastBackupVaultArn** *(string) --* The ARN (Amazon Resource Name) of the backup vault that contains the most recent backup recovery point. * **LastRecoveryPointArn** *(string) --* The ARN (Amazon Resource Name) of the most recent recovery point. * **NextToken** *(string) --* 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. **Exceptions** * "Backup.Client.exceptions.InvalidParameterValueException" * "Backup.Client.exceptions.ResourceNotFoundException" * "Backup.Client.exceptions.ServiceUnavailableException" Backup / Client / put_backup_vault_notifications put_backup_vault_notifications ****************************** Backup.Client.put_backup_vault_notifications(**kwargs) Turns on notifications on a backup vault for the specified topic and events. See also: AWS API Documentation **Request Syntax** response = client.put_backup_vault_notifications( BackupVaultName='string', SNSTopicArn='string', BackupVaultEvents=[ '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'|'CONTINUOUS_BACKUP_INTERRUPTED'|'RECOVERY_POINT_INDEX_COMPLETED'|'RECOVERY_POINT_INDEX_DELETED'|'RECOVERY_POINT_INDEXING_FAILED', ] ) Parameters: * **BackupVaultName** (*string*) -- **[REQUIRED]** 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. * **SNSTopicArn** (*string*) -- **[REQUIRED]** 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** (*list*) -- **[REQUIRED]** An array of events that indicate the status of jobs to back up resources to the backup vault. For the list of supported events, common use cases, and code samples, see Notification options with Backup. * *(string) --* Returns: None **Exceptions** * "Backup.Client.exceptions.ResourceNotFoundException" * "Backup.Client.exceptions.InvalidParameterValueException" * "Backup.Client.exceptions.MissingParameterValueException" * "Backup.Client.exceptions.ServiceUnavailableException" Backup / Client / close close ***** Backup.Client.close() Closes underlying endpoint connections. Backup / Client / associate_backup_vault_mpa_approval_team associate_backup_vault_mpa_approval_team **************************************** Backup.Client.associate_backup_vault_mpa_approval_team(**kwargs) Associates an MPA approval team with a backup vault. See also: AWS API Documentation **Request Syntax** response = client.associate_backup_vault_mpa_approval_team( BackupVaultName='string', MpaApprovalTeamArn='string', RequesterComment='string' ) Parameters: * **BackupVaultName** (*string*) -- **[REQUIRED]** The name of the backup vault to associate with the MPA approval team. * **MpaApprovalTeamArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the MPA approval team to associate with the backup vault. * **RequesterComment** (*string*) -- A comment provided by the requester explaining the association request. Returns: None **Exceptions** * "Backup.Client.exceptions.ResourceNotFoundException" * "Backup.Client.exceptions.InvalidParameterValueException" * "Backup.Client.exceptions.MissingParameterValueException" * "Backup.Client.exceptions.InvalidRequestException" * "Backup.Client.exceptions.ServiceUnavailableException" Backup / Client / get_backup_plan_from_template get_backup_plan_from_template ***************************** Backup.Client.get_backup_plan_from_template(**kwargs) Returns the template specified by its "templateId" as a backup plan. See also: AWS API Documentation **Request Syntax** response = client.get_backup_plan_from_template( BackupPlanTemplateId='string' ) Parameters: **BackupPlanTemplateId** (*string*) -- **[REQUIRED]** Uniquely identifies a stored backup plan template. Return type: dict Returns: **Response Syntax** { 'BackupPlanDocument': { 'BackupPlanName': 'string', 'Rules': [ { 'RuleName': 'string', 'TargetBackupVaultName': 'string', 'ScheduleExpression': 'string', 'StartWindowMinutes': 123, 'CompletionWindowMinutes': 123, 'Lifecycle': { 'MoveToColdStorageAfterDays': 123, 'DeleteAfterDays': 123, 'OptInToArchiveForSupportedResources': True|False }, 'RecoveryPointTags': { 'string': 'string' }, 'RuleId': 'string', 'CopyActions': [ { 'Lifecycle': { 'MoveToColdStorageAfterDays': 123, 'DeleteAfterDays': 123, 'OptInToArchiveForSupportedResources': True|False }, 'DestinationBackupVaultArn': 'string' }, ], 'EnableContinuousBackup': True|False, 'ScheduleExpressionTimezone': 'string', 'IndexActions': [ { 'ResourceTypes': [ 'string', ] }, ] }, ], 'AdvancedBackupSettings': [ { 'ResourceType': 'string', 'BackupOptions': { 'string': 'string' } }, ] } } **Response Structure** * *(dict) --* * **BackupPlanDocument** *(dict) --* Returns the body of a backup plan based on the target template, including the name, rules, and backup vault of the plan. * **BackupPlanName** *(string) --* The display name of a backup plan. Must contain only alphanumeric or '-_.' special characters. If this is set in the console, it can contain 1 to 50 characters; if this is set through CLI or API, it can contain 1 to 200 characters. * **Rules** *(list) --* An array of "BackupRule" objects, each of which specifies a scheduled task that is used to back up a selection of resources. * *(dict) --* Specifies a scheduled task used to back up a selection of resources. * **RuleName** *(string) --* A display name for a backup rule. Must contain 1 to 50 alphanumeric or '-_.' characters. * **TargetBackupVaultName** *(string) --* 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. * **ScheduleExpression** *(string) --* A cron expression in UTC specifying when Backup initiates a backup job. When no CRON expression is provided, Backup will use the default expression "cron(0 5 ? * * *)". 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** *(integer) --* 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** *(integer) --* 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** *(dict) --* The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. Backup transitions and expires backups automatically according to the lifecycle that you define. Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, the “retention” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold. Resource types that can transition to cold storage are listed in the Feature availability by resource table. Backup ignores this expression for other resource types. * **MoveToColdStorageAfterDays** *(integer) --* The number of days after creation that a recovery point is moved to cold storage. * **DeleteAfterDays** *(integer) --* The number of days after creation that a recovery point is deleted. This value must be at least 90 days after the number of days specified in "MoveToColdStorageAfterDays". * **OptInToArchiveForSupportedResources** *(boolean) --* If the value is true, your backup plan transitions supported resources to archive (cold) storage tier in accordance with your lifecycle settings. * **RecoveryPointTags** *(dict) --* The tags that are assigned to resources that are associated with this rule when restored from backup. * *(string) --* * *(string) --* * **RuleId** *(string) --* Uniquely identifies a rule that is used to schedule the backup of a selection of resources. * **CopyActions** *(list) --* An array of "CopyAction" objects, which contains the details of the copy operation. * *(dict) --* The details of the copy operation. * **Lifecycle** *(dict) --* Specifies the time period, in days, before a recovery point transitions to cold storage or is deleted. Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, on the console, the retention setting must be 90 days greater than the transition to cold after days setting. The transition to cold after days setting can't be changed after a backup has been transitioned to cold. Resource types that can transition to cold storage are listed in the Feature availability by resource table. Backup ignores this expression for other resource types. To remove the existing lifecycle and retention periods and keep your recovery points indefinitely, specify -1 for "MoveToColdStorageAfterDays" and "DeleteAfterDays". * **MoveToColdStorageAfterDays** *(integer) --* The number of days after creation that a recovery point is moved to cold storage. * **DeleteAfterDays** *(integer) --* The number of days after creation that a recovery point is deleted. This value must be at least 90 days after the number of days specified in "MoveToColdStorageAfterDays". * **OptInToArchiveForSupportedResources** *(boolean) --* If the value is true, your backup plan transitions supported resources to archive (cold) storage tier in accordance with your lifecycle settings. * **DestinationBackupVaultArn** *(string) --* 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:backup-vault:aBackupVault". * **EnableContinuousBackup** *(boolean) --* 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** *(string) --* The timezone in which the schedule expression is set. By default, ScheduleExpressions are in UTC. You can modify this to a specified timezone. * **IndexActions** *(list) --* IndexActions is an array you use to specify how backup data should be indexed. eEach BackupRule can have 0 or 1 IndexAction, as each backup can have up to one index associated with it. Within the array is ResourceType. Only one will be accepted for each BackupRule. * *(dict) --* This is an optional array within a BackupRule. IndexAction consists of one ResourceTypes. * **ResourceTypes** *(list) --* 0 or 1 index action will be accepted for each BackupRule. Valid values: * "EBS" for Amazon Elastic Block Store * "S3" for Amazon Simple Storage Service (Amazon S3) * *(string) --* * **AdvancedBackupSettings** *(list) --* Contains a list of "BackupOptions" for each resource type. * *(dict) --* The backup options for each resource type. * **ResourceType** *(string) --* 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** *(dict) --* 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. * *(string) --* * *(string) --* **Exceptions** * "Backup.Client.exceptions.InvalidParameterValueException" * "Backup.Client.exceptions.MissingParameterValueException" * "Backup.Client.exceptions.ServiceUnavailableException" * "Backup.Client.exceptions.ResourceNotFoundException" Backup / Client / create_backup_plan create_backup_plan ****************** Backup.Client.create_backup_plan(**kwargs) 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. See also: AWS API Documentation **Request Syntax** response = client.create_backup_plan( BackupPlan={ 'BackupPlanName': 'string', 'Rules': [ { 'RuleName': 'string', 'TargetBackupVaultName': 'string', 'ScheduleExpression': 'string', 'StartWindowMinutes': 123, 'CompletionWindowMinutes': 123, 'Lifecycle': { 'MoveToColdStorageAfterDays': 123, 'DeleteAfterDays': 123, 'OptInToArchiveForSupportedResources': True|False }, 'RecoveryPointTags': { 'string': 'string' }, 'CopyActions': [ { 'Lifecycle': { 'MoveToColdStorageAfterDays': 123, 'DeleteAfterDays': 123, 'OptInToArchiveForSupportedResources': True|False }, 'DestinationBackupVaultArn': 'string' }, ], 'EnableContinuousBackup': True|False, 'ScheduleExpressionTimezone': 'string', 'IndexActions': [ { 'ResourceTypes': [ 'string', ] }, ] }, ], 'AdvancedBackupSettings': [ { 'ResourceType': 'string', 'BackupOptions': { 'string': 'string' } }, ] }, BackupPlanTags={ 'string': 'string' }, CreatorRequestId='string' ) Parameters: * **BackupPlan** (*dict*) -- **[REQUIRED]** The body of a backup plan. Includes a "BackupPlanName" and one or more sets of "Rules". * **BackupPlanName** *(string) --* **[REQUIRED]** The display name of a backup plan. Must contain 1 to 50 alphanumeric or '-_.' characters. * **Rules** *(list) --* **[REQUIRED]** An array of "BackupRule" objects, each of which specifies a scheduled task that is used to back up a selection of resources. * *(dict) --* Specifies a scheduled task used to back up a selection of resources. * **RuleName** *(string) --* **[REQUIRED]** A display name for a backup rule. Must contain 1 to 50 alphanumeric or '-_.' characters. * **TargetBackupVaultName** *(string) --* **[REQUIRED]** 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. * **ScheduleExpression** *(string) --* A CRON expression in UTC specifying when Backup initiates a backup job. When no CRON expression is provided, Backup will use the default expression "cron(0 5 ? * * *)". * **StartWindowMinutes** *(integer) --* 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** *(integer) --* 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** *(dict) --* 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 storage. Resource types that can transition to cold storage are listed in the Feature availability by resource table. Backup ignores this expression for other resource types. This parameter has a maximum value of 100 years (36,500 days). * **MoveToColdStorageAfterDays** *(integer) --* The number of days after creation that a recovery point is moved to cold storage. * **DeleteAfterDays** *(integer) --* The number of days after creation that a recovery point is deleted. This value must be at least 90 days after the number of days specified in "MoveToColdStorageAfterDays". * **OptInToArchiveForSupportedResources** *(boolean) --* If the value is true, your backup plan transitions supported resources to archive (cold) storage tier in accordance with your lifecycle settings. * **RecoveryPointTags** *(dict) --* The tags to assign to the resources. * *(string) --* * *(string) --* * **CopyActions** *(list) --* An array of "CopyAction" objects, which contains the details of the copy operation. * *(dict) --* The details of the copy operation. * **Lifecycle** *(dict) --* Specifies the time period, in days, before a recovery point transitions to cold storage or is deleted. Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, on the console, the retention setting must be 90 days greater than the transition to cold after days setting. The transition to cold after days setting can't be changed after a backup has been transitioned to cold. Resource types that can transition to cold storage are listed in the Feature availability by resource table. Backup ignores this expression for other resource types. To remove the existing lifecycle and retention periods and keep your recovery points indefinitely, specify -1 for "MoveToColdStorageAfterDays" and "DeleteAfterDays". * **MoveToColdStorageAfterDays** *(integer) --* The number of days after creation that a recovery point is moved to cold storage. * **DeleteAfterDays** *(integer) --* The number of days after creation that a recovery point is deleted. This value must be at least 90 days after the number of days specified in "MoveToColdStorageAfterDays". * **OptInToArchiveForSupportedResources** *(boolean) --* If the value is true, your backup plan transitions supported resources to archive (cold) storage tier in accordance with your lifecycle settings. * **DestinationBackupVaultArn** *(string) --* **[REQUIRED]** 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:backup-vault:aBackupVault". * **EnableContinuousBackup** *(boolean) --* 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** *(string) --* The timezone in which the schedule expression is set. By default, ScheduleExpressions are in UTC. You can modify this to a specified timezone. * **IndexActions** *(list) --* There can up to one IndexAction in each BackupRule, as each backup can have 0 or 1 backup index associated with it. Within the array is ResourceTypes. Only 1 resource type will be accepted for each BackupRule. Valid values: * "EBS" for Amazon Elastic Block Store * "S3" for Amazon Simple Storage Service (Amazon S3) * *(dict) --* This is an optional array within a BackupRule. IndexAction consists of one ResourceTypes. * **ResourceTypes** *(list) --* 0 or 1 index action will be accepted for each BackupRule. Valid values: * "EBS" for Amazon Elastic Block Store * "S3" for Amazon Simple Storage Service (Amazon S3) * *(string) --* * **AdvancedBackupSettings** *(list) --* Specifies a list of "BackupOptions" for each resource type. These settings are only available for Windows Volume Shadow Copy Service (VSS) backup jobs. * *(dict) --* The backup options for each resource type. * **ResourceType** *(string) --* 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** *(dict) --* 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. * *(string) --* * *(string) --* * **BackupPlanTags** (*dict*) -- The tags to assign to the backup plan. * *(string) --* * *(string) --* * **CreatorRequestId** (*string*) -- 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. This field is autopopulated if not provided. Return type: dict Returns: **Response Syntax** { 'BackupPlanId': 'string', 'BackupPlanArn': 'string', 'CreationDate': datetime(2015, 1, 1), 'VersionId': 'string', 'AdvancedBackupSettings': [ { 'ResourceType': 'string', 'BackupOptions': { 'string': 'string' } }, ] } **Response Structure** * *(dict) --* * **BackupPlanId** *(string) --* The ID of the backup plan. * **BackupPlanArn** *(string) --* 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** *(datetime) --* 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** *(string) --* Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes long. They cannot be edited. * **AdvancedBackupSettings** *(list) --* The settings for a resource type. This option is only available for Windows Volume Shadow Copy Service (VSS) backup jobs. * *(dict) --* The backup options for each resource type. * **ResourceType** *(string) --* 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** *(dict) --* 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. * *(string) --* * *(string) --* **Exceptions** * "Backup.Client.exceptions.LimitExceededException" * "Backup.Client.exceptions.AlreadyExistsException" * "Backup.Client.exceptions.InvalidParameterValueException" * "Backup.Client.exceptions.MissingParameterValueException" * "Backup.Client.exceptions.ServiceUnavailableException" Backup / Client / delete_backup_plan delete_backup_plan ****************** Backup.Client.delete_backup_plan(**kwargs) 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. See also: AWS API Documentation **Request Syntax** response = client.delete_backup_plan( BackupPlanId='string' ) Parameters: **BackupPlanId** (*string*) -- **[REQUIRED]** Uniquely identifies a backup plan. Return type: dict Returns: **Response Syntax** { 'BackupPlanId': 'string', 'BackupPlanArn': 'string', 'DeletionDate': datetime(2015, 1, 1), 'VersionId': 'string' } **Response Structure** * *(dict) --* * **BackupPlanId** *(string) --* Uniquely identifies a backup plan. * **BackupPlanArn** *(string) --* 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** *(datetime) --* 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** *(string) --* Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes long. Version IDs cannot be edited. **Exceptions** * "Backup.Client.exceptions.ResourceNotFoundException" * "Backup.Client.exceptions.InvalidParameterValueException" * "Backup.Client.exceptions.MissingParameterValueException" * "Backup.Client.exceptions.ServiceUnavailableException" * "Backup.Client.exceptions.InvalidRequestException" Backup / Client / disassociate_recovery_point disassociate_recovery_point *************************** Backup.Client.disassociate_recovery_point(**kwargs) 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. See also: AWS API Documentation **Request Syntax** response = client.disassociate_recovery_point( BackupVaultName='string', RecoveryPointArn='string' ) Parameters: * **BackupVaultName** (*string*) -- **[REQUIRED]** The unique name of an Backup vault. * **RecoveryPointArn** (*string*) -- **[REQUIRED]** An Amazon Resource Name (ARN) that uniquely identifies an Backup recovery point. Returns: None **Exceptions** * "Backup.Client.exceptions.ResourceNotFoundException" * "Backup.Client.exceptions.InvalidParameterValueException" * "Backup.Client.exceptions.MissingParameterValueException" * "Backup.Client.exceptions.InvalidResourceStateException" * "Backup.Client.exceptions.ServiceUnavailableException" * "Backup.Client.exceptions.InvalidRequestException" Backup / Client / get_backup_plan_from_json get_backup_plan_from_json ************************* Backup.Client.get_backup_plan_from_json(**kwargs) Returns a valid JSON document specifying a backup plan or an error. See also: AWS API Documentation **Request Syntax** response = client.get_backup_plan_from_json( BackupPlanTemplateJson='string' ) Parameters: **BackupPlanTemplateJson** (*string*) -- **[REQUIRED]** A customer-supplied backup plan document in JSON format. Return type: dict Returns: **Response Syntax** { 'BackupPlan': { 'BackupPlanName': 'string', 'Rules': [ { 'RuleName': 'string', 'TargetBackupVaultName': 'string', 'ScheduleExpression': 'string', 'StartWindowMinutes': 123, 'CompletionWindowMinutes': 123, 'Lifecycle': { 'MoveToColdStorageAfterDays': 123, 'DeleteAfterDays': 123, 'OptInToArchiveForSupportedResources': True|False }, 'RecoveryPointTags': { 'string': 'string' }, 'RuleId': 'string', 'CopyActions': [ { 'Lifecycle': { 'MoveToColdStorageAfterDays': 123, 'DeleteAfterDays': 123, 'OptInToArchiveForSupportedResources': True|False }, 'DestinationBackupVaultArn': 'string' }, ], 'EnableContinuousBackup': True|False, 'ScheduleExpressionTimezone': 'string', 'IndexActions': [ { 'ResourceTypes': [ 'string', ] }, ] }, ], 'AdvancedBackupSettings': [ { 'ResourceType': 'string', 'BackupOptions': { 'string': 'string' } }, ] } } **Response Structure** * *(dict) --* * **BackupPlan** *(dict) --* Specifies the body of a backup plan. Includes a "BackupPlanName" and one or more sets of "Rules". * **BackupPlanName** *(string) --* The display name of a backup plan. Must contain only alphanumeric or '-_.' special characters. If this is set in the console, it can contain 1 to 50 characters; if this is set through CLI or API, it can contain 1 to 200 characters. * **Rules** *(list) --* An array of "BackupRule" objects, each of which specifies a scheduled task that is used to back up a selection of resources. * *(dict) --* Specifies a scheduled task used to back up a selection of resources. * **RuleName** *(string) --* A display name for a backup rule. Must contain 1 to 50 alphanumeric or '-_.' characters. * **TargetBackupVaultName** *(string) --* 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. * **ScheduleExpression** *(string) --* A cron expression in UTC specifying when Backup initiates a backup job. When no CRON expression is provided, Backup will use the default expression "cron(0 5 ? * * *)". 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** *(integer) --* 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** *(integer) --* 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** *(dict) --* The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. Backup transitions and expires backups automatically according to the lifecycle that you define. Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, the “retention” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold. Resource types that can transition to cold storage are listed in the Feature availability by resource table. Backup ignores this expression for other resource types. * **MoveToColdStorageAfterDays** *(integer) --* The number of days after creation that a recovery point is moved to cold storage. * **DeleteAfterDays** *(integer) --* The number of days after creation that a recovery point is deleted. This value must be at least 90 days after the number of days specified in "MoveToColdStorageAfterDays". * **OptInToArchiveForSupportedResources** *(boolean) --* If the value is true, your backup plan transitions supported resources to archive (cold) storage tier in accordance with your lifecycle settings. * **RecoveryPointTags** *(dict) --* The tags that are assigned to resources that are associated with this rule when restored from backup. * *(string) --* * *(string) --* * **RuleId** *(string) --* Uniquely identifies a rule that is used to schedule the backup of a selection of resources. * **CopyActions** *(list) --* An array of "CopyAction" objects, which contains the details of the copy operation. * *(dict) --* The details of the copy operation. * **Lifecycle** *(dict) --* Specifies the time period, in days, before a recovery point transitions to cold storage or is deleted. Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, on the console, the retention setting must be 90 days greater than the transition to cold after days setting. The transition to cold after days setting can't be changed after a backup has been transitioned to cold. Resource types that can transition to cold storage are listed in the Feature availability by resource table. Backup ignores this expression for other resource types. To remove the existing lifecycle and retention periods and keep your recovery points indefinitely, specify -1 for "MoveToColdStorageAfterDays" and "DeleteAfterDays". * **MoveToColdStorageAfterDays** *(integer) --* The number of days after creation that a recovery point is moved to cold storage. * **DeleteAfterDays** *(integer) --* The number of days after creation that a recovery point is deleted. This value must be at least 90 days after the number of days specified in "MoveToColdStorageAfterDays". * **OptInToArchiveForSupportedResources** *(boolean) --* If the value is true, your backup plan transitions supported resources to archive (cold) storage tier in accordance with your lifecycle settings. * **DestinationBackupVaultArn** *(string) --* 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:backup-vault:aBackupVault". * **EnableContinuousBackup** *(boolean) --* 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** *(string) --* The timezone in which the schedule expression is set. By default, ScheduleExpressions are in UTC. You can modify this to a specified timezone. * **IndexActions** *(list) --* IndexActions is an array you use to specify how backup data should be indexed. eEach BackupRule can have 0 or 1 IndexAction, as each backup can have up to one index associated with it. Within the array is ResourceType. Only one will be accepted for each BackupRule. * *(dict) --* This is an optional array within a BackupRule. IndexAction consists of one ResourceTypes. * **ResourceTypes** *(list) --* 0 or 1 index action will be accepted for each BackupRule. Valid values: * "EBS" for Amazon Elastic Block Store * "S3" for Amazon Simple Storage Service (Amazon S3) * *(string) --* * **AdvancedBackupSettings** *(list) --* Contains a list of "BackupOptions" for each resource type. * *(dict) --* The backup options for each resource type. * **ResourceType** *(string) --* 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** *(dict) --* 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. * *(string) --* * *(string) --* **Exceptions** * "Backup.Client.exceptions.LimitExceededException" * "Backup.Client.exceptions.InvalidParameterValueException" * "Backup.Client.exceptions.MissingParameterValueException" * "Backup.Client.exceptions.ServiceUnavailableException" * "Backup.Client.exceptions.InvalidRequestException" Backup / Client / update_recovery_point_lifecycle update_recovery_point_lifecycle ******************************* Backup.Client.update_recovery_point_lifecycle(**kwargs) Sets the transition lifecycle of a recovery point. The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. Backup transitions and expires backups automatically according to the lifecycle that you define. Resource types that can transition to cold storage are listed in the Feature availability by resource table. Backup ignores this expression for other resource types. Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, the “retention” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold. Warning: If your lifecycle currently uses the parameters "DeleteAfterDays" and "MoveToColdStorageAfterDays", include these parameters and their values when you call this operation. Not including them may result in your plan updating with null values. This operation does not support continuous backups. See also: AWS API Documentation **Request Syntax** response = client.update_recovery_point_lifecycle( BackupVaultName='string', RecoveryPointArn='string', Lifecycle={ 'MoveToColdStorageAfterDays': 123, 'DeleteAfterDays': 123, 'OptInToArchiveForSupportedResources': True|False } ) Parameters: * **BackupVaultName** (*string*) -- **[REQUIRED]** 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. * **RecoveryPointArn** (*string*) -- **[REQUIRED]** 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** (*dict*) -- 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. * **MoveToColdStorageAfterDays** *(integer) --* The number of days after creation that a recovery point is moved to cold storage. * **DeleteAfterDays** *(integer) --* The number of days after creation that a recovery point is deleted. This value must be at least 90 days after the number of days specified in "MoveToColdStorageAfterDays". * **OptInToArchiveForSupportedResources** *(boolean) --* If the value is true, your backup plan transitions supported resources to archive (cold) storage tier in accordance with your lifecycle settings. Return type: dict Returns: **Response Syntax** { 'BackupVaultArn': 'string', 'RecoveryPointArn': 'string', 'Lifecycle': { 'MoveToColdStorageAfterDays': 123, 'DeleteAfterDays': 123, 'OptInToArchiveForSupportedResources': True|False }, 'CalculatedLifecycle': { 'MoveToColdStorageAt': datetime(2015, 1, 1), 'DeleteAt': datetime(2015, 1, 1) } } **Response Structure** * *(dict) --* * **BackupVaultArn** *(string) --* An ARN that uniquely identifies a backup vault; for example, "arn:aws:backup:us-east-1:123456789012:backup- vault:aBackupVault". * **RecoveryPointArn** *(string) --* 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** *(dict) --* The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. Backup transitions and expires backups automatically according to the lifecycle that you define. Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, the “retention” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold. Resource types that can transition to cold storage are listed in the Feature availability by resource table. Backup ignores this expression for other resource types. * **MoveToColdStorageAfterDays** *(integer) --* The number of days after creation that a recovery point is moved to cold storage. * **DeleteAfterDays** *(integer) --* The number of days after creation that a recovery point is deleted. This value must be at least 90 days after the number of days specified in "MoveToColdStorageAfterDays". * **OptInToArchiveForSupportedResources** *(boolean) --* If the value is true, your backup plan transitions supported resources to archive (cold) storage tier in accordance with your lifecycle settings. * **CalculatedLifecycle** *(dict) --* A "CalculatedLifecycle" object containing "DeleteAt" and "MoveToColdStorageAt" timestamps. * **MoveToColdStorageAt** *(datetime) --* A timestamp that specifies when to transition a recovery point to cold storage. * **DeleteAt** *(datetime) --* A timestamp that specifies when to delete a recovery point. **Exceptions** * "Backup.Client.exceptions.ResourceNotFoundException" * "Backup.Client.exceptions.InvalidParameterValueException" * "Backup.Client.exceptions.InvalidRequestException" * "Backup.Client.exceptions.MissingParameterValueException" * "Backup.Client.exceptions.ServiceUnavailableException" Backup / Client / update_backup_plan update_backup_plan ****************** Backup.Client.update_backup_plan(**kwargs) Updates the specified backup plan. The new version is uniquely identified by its ID. See also: AWS API Documentation **Request Syntax** response = client.update_backup_plan( BackupPlanId='string', BackupPlan={ 'BackupPlanName': 'string', 'Rules': [ { 'RuleName': 'string', 'TargetBackupVaultName': 'string', 'ScheduleExpression': 'string', 'StartWindowMinutes': 123, 'CompletionWindowMinutes': 123, 'Lifecycle': { 'MoveToColdStorageAfterDays': 123, 'DeleteAfterDays': 123, 'OptInToArchiveForSupportedResources': True|False }, 'RecoveryPointTags': { 'string': 'string' }, 'CopyActions': [ { 'Lifecycle': { 'MoveToColdStorageAfterDays': 123, 'DeleteAfterDays': 123, 'OptInToArchiveForSupportedResources': True|False }, 'DestinationBackupVaultArn': 'string' }, ], 'EnableContinuousBackup': True|False, 'ScheduleExpressionTimezone': 'string', 'IndexActions': [ { 'ResourceTypes': [ 'string', ] }, ] }, ], 'AdvancedBackupSettings': [ { 'ResourceType': 'string', 'BackupOptions': { 'string': 'string' } }, ] } ) Parameters: * **BackupPlanId** (*string*) -- **[REQUIRED]** The ID of the backup plan. * **BackupPlan** (*dict*) -- **[REQUIRED]** The body of a backup plan. Includes a "BackupPlanName" and one or more sets of "Rules". * **BackupPlanName** *(string) --* **[REQUIRED]** The display name of a backup plan. Must contain 1 to 50 alphanumeric or '-_.' characters. * **Rules** *(list) --* **[REQUIRED]** An array of "BackupRule" objects, each of which specifies a scheduled task that is used to back up a selection of resources. * *(dict) --* Specifies a scheduled task used to back up a selection of resources. * **RuleName** *(string) --* **[REQUIRED]** A display name for a backup rule. Must contain 1 to 50 alphanumeric or '-_.' characters. * **TargetBackupVaultName** *(string) --* **[REQUIRED]** 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. * **ScheduleExpression** *(string) --* A CRON expression in UTC specifying when Backup initiates a backup job. When no CRON expression is provided, Backup will use the default expression "cron(0 5 ? * * *)". * **StartWindowMinutes** *(integer) --* 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** *(integer) --* 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** *(dict) --* 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 storage. Resource types that can transition to cold storage are listed in the Feature availability by resource table. Backup ignores this expression for other resource types. This parameter has a maximum value of 100 years (36,500 days). * **MoveToColdStorageAfterDays** *(integer) --* The number of days after creation that a recovery point is moved to cold storage. * **DeleteAfterDays** *(integer) --* The number of days after creation that a recovery point is deleted. This value must be at least 90 days after the number of days specified in "MoveToColdStorageAfterDays". * **OptInToArchiveForSupportedResources** *(boolean) --* If the value is true, your backup plan transitions supported resources to archive (cold) storage tier in accordance with your lifecycle settings. * **RecoveryPointTags** *(dict) --* The tags to assign to the resources. * *(string) --* * *(string) --* * **CopyActions** *(list) --* An array of "CopyAction" objects, which contains the details of the copy operation. * *(dict) --* The details of the copy operation. * **Lifecycle** *(dict) --* Specifies the time period, in days, before a recovery point transitions to cold storage or is deleted. Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, on the console, the retention setting must be 90 days greater than the transition to cold after days setting. The transition to cold after days setting can't be changed after a backup has been transitioned to cold. Resource types that can transition to cold storage are listed in the Feature availability by resource table. Backup ignores this expression for other resource types. To remove the existing lifecycle and retention periods and keep your recovery points indefinitely, specify -1 for "MoveToColdStorageAfterDays" and "DeleteAfterDays". * **MoveToColdStorageAfterDays** *(integer) --* The number of days after creation that a recovery point is moved to cold storage. * **DeleteAfterDays** *(integer) --* The number of days after creation that a recovery point is deleted. This value must be at least 90 days after the number of days specified in "MoveToColdStorageAfterDays". * **OptInToArchiveForSupportedResources** *(boolean) --* If the value is true, your backup plan transitions supported resources to archive (cold) storage tier in accordance with your lifecycle settings. * **DestinationBackupVaultArn** *(string) --* **[REQUIRED]** 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:backup-vault:aBackupVault". * **EnableContinuousBackup** *(boolean) --* 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** *(string) --* The timezone in which the schedule expression is set. By default, ScheduleExpressions are in UTC. You can modify this to a specified timezone. * **IndexActions** *(list) --* There can up to one IndexAction in each BackupRule, as each backup can have 0 or 1 backup index associated with it. Within the array is ResourceTypes. Only 1 resource type will be accepted for each BackupRule. Valid values: * "EBS" for Amazon Elastic Block Store * "S3" for Amazon Simple Storage Service (Amazon S3) * *(dict) --* This is an optional array within a BackupRule. IndexAction consists of one ResourceTypes. * **ResourceTypes** *(list) --* 0 or 1 index action will be accepted for each BackupRule. Valid values: * "EBS" for Amazon Elastic Block Store * "S3" for Amazon Simple Storage Service (Amazon S3) * *(string) --* * **AdvancedBackupSettings** *(list) --* Specifies a list of "BackupOptions" for each resource type. These settings are only available for Windows Volume Shadow Copy Service (VSS) backup jobs. * *(dict) --* The backup options for each resource type. * **ResourceType** *(string) --* 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** *(dict) --* 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. * *(string) --* * *(string) --* Return type: dict Returns: **Response Syntax** { 'BackupPlanId': 'string', 'BackupPlanArn': 'string', 'CreationDate': datetime(2015, 1, 1), 'VersionId': 'string', 'AdvancedBackupSettings': [ { 'ResourceType': 'string', 'BackupOptions': { 'string': 'string' } }, ] } **Response Structure** * *(dict) --* * **BackupPlanId** *(string) --* Uniquely identifies a backup plan. * **BackupPlanArn** *(string) --* 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** *(datetime) --* 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** *(string) --* Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes long. Version Ids cannot be edited. * **AdvancedBackupSettings** *(list) --* Contains a list of "BackupOptions" for each resource type. * *(dict) --* The backup options for each resource type. * **ResourceType** *(string) --* 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** *(dict) --* 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. * *(string) --* * *(string) --* **Exceptions** * "Backup.Client.exceptions.ResourceNotFoundException" * "Backup.Client.exceptions.InvalidParameterValueException" * "Backup.Client.exceptions.MissingParameterValueException" * "Backup.Client.exceptions.ServiceUnavailableException" Backup / Client / describe_report_job describe_report_job ******************* Backup.Client.describe_report_job(**kwargs) Returns the details associated with creating a report as specified by its "ReportJobId". See also: AWS API Documentation **Request Syntax** response = client.describe_report_job( ReportJobId='string' ) Parameters: **ReportJobId** (*string*) -- **[REQUIRED]** 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. Return type: dict Returns: **Response Syntax** { 'ReportJob': { 'ReportJobId': 'string', 'ReportPlanArn': 'string', 'ReportTemplate': 'string', 'CreationTime': datetime(2015, 1, 1), 'CompletionTime': datetime(2015, 1, 1), 'Status': 'string', 'StatusMessage': 'string', 'ReportDestination': { 'S3BucketName': 'string', 'S3Keys': [ 'string', ] } } } **Response Structure** * *(dict) --* * **ReportJob** *(dict) --* The 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. * **ReportJobId** *(string) --* 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** *(string) --* An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type. * **ReportTemplate** *(string) --* 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** *(datetime) --* 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** *(datetime) --* 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** *(string) --* 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** *(string) --* A message explaining the status of the report job. * **ReportDestination** *(dict) --* The S3 bucket name and S3 keys for the destination where the report job publishes the report. * **S3BucketName** *(string) --* The unique name of the Amazon S3 bucket that receives your reports. * **S3Keys** *(list) --* The object key that uniquely identifies your reports in your S3 bucket. * *(string) --* **Exceptions** * "Backup.Client.exceptions.ServiceUnavailableException" * "Backup.Client.exceptions.MissingParameterValueException" * "Backup.Client.exceptions.ResourceNotFoundException" Backup / Client / update_restore_testing_selection update_restore_testing_selection ******************************** Backup.Client.update_restore_testing_selection(**kwargs) Updates the specified restore testing selection. Most elements except the "RestoreTestingSelectionName" can be updated with this request. You can use either protected resource ARNs or conditions, but not both. See also: AWS API Documentation **Request Syntax** response = client.update_restore_testing_selection( RestoreTestingPlanName='string', RestoreTestingSelection={ 'IamRoleArn': 'string', 'ProtectedResourceArns': [ 'string', ], 'ProtectedResourceConditions': { 'StringEquals': [ { 'Key': 'string', 'Value': 'string' }, ], 'StringNotEquals': [ { 'Key': 'string', 'Value': 'string' }, ] }, 'RestoreMetadataOverrides': { 'string': 'string' }, 'ValidationWindowHours': 123 }, RestoreTestingSelectionName='string' ) Parameters: * **RestoreTestingPlanName** (*string*) -- **[REQUIRED]** The restore testing plan name is required to update the indicated testing plan. * **RestoreTestingSelection** (*dict*) -- **[REQUIRED]** 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. * **IamRoleArn** *(string) --* 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** *(list) --* 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. * *(string) --* * **ProtectedResourceConditions** *(dict) --* The conditions that you define for resources in your restore testing plan using tags. * **StringEquals** *(list) --* Filters the values of your tagged resources for only those resources that you tagged with the same value. Also called "exact matching." * *(dict) --* Pair of two related strings. Allowed characters are letters, white space, and numbers that can be represented in UTF-8 and the following characters: "+ - = . _ : /" * **Key** *(string) --* **[REQUIRED]** 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** *(string) --* **[REQUIRED]** The value of the key. Length Constraints: Maximum length of 256. Pattern: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$" * **StringNotEquals** *(list) --* 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." * *(dict) --* Pair of two related strings. Allowed characters are letters, white space, and numbers that can be represented in UTF-8 and the following characters: "+ - = . _ : /" * **Key** *(string) --* **[REQUIRED]** 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** *(string) --* **[REQUIRED]** The value of the key. Length Constraints: Maximum length of 256. Pattern: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$" * **RestoreMetadataOverrides** *(dict) --* 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. * *(string) --* * *(string) --* * **ValidationWindowHours** *(integer) --* 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). * **RestoreTestingSelectionName** (*string*) -- **[REQUIRED]** The required restore testing selection name of the restore testing selection you wish to update. Return type: dict Returns: **Response Syntax** { 'CreationTime': datetime(2015, 1, 1), 'RestoreTestingPlanArn': 'string', 'RestoreTestingPlanName': 'string', 'RestoreTestingSelectionName': 'string', 'UpdateTime': datetime(2015, 1, 1) } **Response Structure** * *(dict) --* * **CreationTime** *(datetime) --* The time the resource testing selection was updated successfully. * **RestoreTestingPlanArn** *(string) --* Unique string that is the name of the restore testing plan. * **RestoreTestingPlanName** *(string) --* The restore testing plan with which the updated restore testing selection is associated. * **RestoreTestingSelectionName** *(string) --* The returned restore testing selection name. * **UpdateTime** *(datetime) --* The time the update completed for the restore testing selection. **Exceptions** * "Backup.Client.exceptions.ConflictException" * "Backup.Client.exceptions.InvalidParameterValueException" * "Backup.Client.exceptions.MissingParameterValueException" * "Backup.Client.exceptions.ResourceNotFoundException" * "Backup.Client.exceptions.ServiceUnavailableException" Backup / Client / get_restore_testing_selection get_restore_testing_selection ***************************** Backup.Client.get_restore_testing_selection(**kwargs) Returns RestoreTestingSelection, which displays resources and elements of the restore testing plan. See also: AWS API Documentation **Request Syntax** response = client.get_restore_testing_selection( RestoreTestingPlanName='string', RestoreTestingSelectionName='string' ) Parameters: * **RestoreTestingPlanName** (*string*) -- **[REQUIRED]** Required unique name of the restore testing plan. * **RestoreTestingSelectionName** (*string*) -- **[REQUIRED]** Required unique name of the restore testing selection. Return type: dict Returns: **Response Syntax** { 'RestoreTestingSelection': { 'CreationTime': datetime(2015, 1, 1), 'CreatorRequestId': 'string', 'IamRoleArn': 'string', 'ProtectedResourceArns': [ 'string', ], 'ProtectedResourceConditions': { 'StringEquals': [ { 'Key': 'string', 'Value': 'string' }, ], 'StringNotEquals': [ { 'Key': 'string', 'Value': 'string' }, ] }, 'ProtectedResourceType': 'string', 'RestoreMetadataOverrides': { 'string': 'string' }, 'RestoreTestingPlanName': 'string', 'RestoreTestingSelectionName': 'string', 'ValidationWindowHours': 123 } } **Response Structure** * *(dict) --* * **RestoreTestingSelection** *(dict) --* Unique name of the restore testing selection. * **CreationTime** *(datetime) --* 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** *(string) --* 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** *(string) --* 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** *(list) --* You can include specific ARNs, such as "ProtectedResourceArns: ["arn:aws:...", "arn:aws:..."]" or you can include a wildcard: "ProtectedResourceArns: ["*"]", but not both. * *(string) --* * **ProtectedResourceConditions** *(dict) --* In a resource testing selection, this parameter filters by specific conditions such as "StringEquals" or "StringNotEquals". * **StringEquals** *(list) --* Filters the values of your tagged resources for only those resources that you tagged with the same value. Also called "exact matching." * *(dict) --* Pair of two related strings. Allowed characters are letters, white space, and numbers that can be represented in UTF-8 and the following characters: "+ - = . _ : /" * **Key** *(string) --* 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** *(string) --* The value of the key. Length Constraints: Maximum length of 256. Pattern: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$" * **StringNotEquals** *(list) --* 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." * *(dict) --* Pair of two related strings. Allowed characters are letters, white space, and numbers that can be represented in UTF-8 and the following characters: "+ - = . _ : /" * **Key** *(string) --* 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** *(string) --* The value of the key. Length Constraints: Maximum length of 256. Pattern: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$" * **ProtectedResourceType** *(string) --* 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** *(dict) --* 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. * *(string) --* * *(string) --* * **RestoreTestingPlanName** *(string) --* The RestoreTestingPlanName is a unique string that is the name of the restore testing plan. * **RestoreTestingSelectionName** *(string) --* The unique name of the restore testing selection that belongs to the related restore testing plan. * **ValidationWindowHours** *(integer) --* 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. **Exceptions** * "Backup.Client.exceptions.ResourceNotFoundException" * "Backup.Client.exceptions.ServiceUnavailableException" Backup / Client / describe_global_settings describe_global_settings ************************ Backup.Client.describe_global_settings() 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" See also: AWS API Documentation **Request Syntax** response = client.describe_global_settings() Return type: dict Returns: **Response Syntax** { 'GlobalSettings': { 'string': 'string' }, 'LastUpdateTime': datetime(2015, 1, 1) } **Response Structure** * *(dict) --* * **GlobalSettings** *(dict) --* The status of the flag "isCrossAccountBackupEnabled". * *(string) --* * *(string) --* * **LastUpdateTime** *(datetime) --* 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. **Exceptions** * "Backup.Client.exceptions.InvalidRequestException" * "Backup.Client.exceptions.ServiceUnavailableException" Backup / Client / describe_backup_job describe_backup_job ******************* Backup.Client.describe_backup_job(**kwargs) Returns backup job details for the specified "BackupJobId". See also: AWS API Documentation **Request Syntax** response = client.describe_backup_job( BackupJobId='string' ) Parameters: **BackupJobId** (*string*) -- **[REQUIRED]** Uniquely identifies a request to Backup to back up a resource. Return type: dict Returns: **Response Syntax** { 'AccountId': 'string', 'BackupJobId': 'string', 'BackupVaultName': 'string', 'BackupVaultArn': 'string', 'RecoveryPointArn': 'string', 'ResourceArn': 'string', 'CreationDate': datetime(2015, 1, 1), 'CompletionDate': datetime(2015, 1, 1), 'State': 'CREATED'|'PENDING'|'RUNNING'|'ABORTING'|'ABORTED'|'COMPLETED'|'FAILED'|'EXPIRED'|'PARTIAL', 'StatusMessage': 'string', 'PercentDone': 'string', 'BackupSizeInBytes': 123, 'IamRoleArn': 'string', 'CreatedBy': { 'BackupPlanId': 'string', 'BackupPlanArn': 'string', 'BackupPlanVersion': 'string', 'BackupRuleId': 'string' }, 'ResourceType': 'string', 'BytesTransferred': 123, 'ExpectedCompletionDate': datetime(2015, 1, 1), 'StartBy': datetime(2015, 1, 1), 'BackupOptions': { 'string': 'string' }, 'BackupType': 'string', 'ParentJobId': 'string', 'IsParent': True|False, 'NumberOfChildJobs': 123, 'ChildJobsInState': { 'string': 123 }, 'ResourceName': 'string', 'InitiationDate': datetime(2015, 1, 1), 'MessageCategory': 'string' } **Response Structure** * *(dict) --* * **AccountId** *(string) --* Returns the account ID that owns the backup job. * **BackupJobId** *(string) --* Uniquely identifies a request to Backup to back up a resource. * **BackupVaultName** *(string) --* 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. * **BackupVaultArn** *(string) --* An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, "arn:aws:backup:us- east-1:123456789012:backup-vault:aBackupVault". * **RecoveryPointArn** *(string) --* 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** *(string) --* An ARN that uniquely identifies a saved resource. The format of the ARN depends on the resource type. * **CreationDate** *(datetime) --* 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** *(datetime) --* 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** *(string) --* The current state of a backup job. * **StatusMessage** *(string) --* A detailed message explaining the status of the job to back up a resource. * **PercentDone** *(string) --* Contains an estimated percentage that is complete of a job at the time the job status was queried. * **BackupSizeInBytes** *(integer) --* The size, in bytes, of a backup (recovery point). This value can render differently depending on the resource type as Backup pulls in data information from other Amazon Web Services services. For example, the value returned may show a value of "0", which may differ from the anticipated value. The expected behavior for values by resource type are described as follows: * Amazon Aurora, Amazon DocumentDB, and Amazon Neptune do not have this value populate from the operation "GetBackupJobStatus". * For Amazon DynamoDB with advanced features, this value refers to the size of the recovery point (backup). * Amazon EC2 and Amazon EBS show volume size (provisioned storage) returned as part of this value. Amazon EBS does not return backup size information; snapshot size will have the same value as the original resource that was backed up. * For Amazon EFS, this value refers to the delta bytes transferred during a backup. * Amazon FSx does not populate this value from the operation "GetBackupJobStatus" for FSx file systems. * An Amazon RDS instance will show as "0". * For virtual machines running VMware, this value is passed to Backup through an asynchronous workflow, which can mean this displayed value can under-represent the actual backup size. * **IamRoleArn** *(string) --* Specifies the IAM role ARN used to create the target recovery point; for example, "arn:aws:iam::123456789012:role/S3Access". * **CreatedBy** *(dict) --* 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. * **BackupPlanId** *(string) --* Uniquely identifies a backup plan. * **BackupPlanArn** *(string) --* 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** *(string) --* Version IDs are unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes long. They cannot be edited. * **BackupRuleId** *(string) --* Uniquely identifies a rule used to schedule the backup of a selection of resources. * **ResourceType** *(string) --* 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** *(integer) --* The size in bytes transferred to a backup vault at the time that the job status was queried. * **ExpectedCompletionDate** *(datetime) --* 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** *(datetime) --* 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** *(dict) --* Represents the options specified as part of backup plan or on-demand backup job. * *(string) --* * *(string) --* * **BackupType** *(string) --* 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** *(string) --* This returns the parent (composite) resource backup job ID. * **IsParent** *(boolean) --* This returns the boolean value that a backup job is a parent (composite) job. * **NumberOfChildJobs** *(integer) --* This returns the number of child (nested) backup jobs. * **ChildJobsInState** *(dict) --* This returns the statistics of the included child (nested) backup jobs. * *(string) --* * *(integer) --* * **ResourceName** *(string) --* The non-unique name of the resource that belongs to the specified backup. * **InitiationDate** *(datetime) --* The date a backup job was initiated. * **MessageCategory** *(string) --* 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. **Exceptions** * "Backup.Client.exceptions.ResourceNotFoundException" * "Backup.Client.exceptions.InvalidParameterValueException" * "Backup.Client.exceptions.MissingParameterValueException" * "Backup.Client.exceptions.ServiceUnavailableException" * "Backup.Client.exceptions.DependencyFailureException" Backup / Client / cancel_legal_hold cancel_legal_hold ***************** Backup.Client.cancel_legal_hold(**kwargs) Removes the specified legal hold on a recovery point. This action can only be performed by a user with sufficient permissions. See also: AWS API Documentation **Request Syntax** response = client.cancel_legal_hold( LegalHoldId='string', CancelDescription='string', RetainRecordInDays=123 ) Parameters: * **LegalHoldId** (*string*) -- **[REQUIRED]** The ID of the legal hold. * **CancelDescription** (*string*) -- **[REQUIRED]** A string the describes the reason for removing the legal hold. * **RetainRecordInDays** (*integer*) -- The integer amount, in days, after which to remove legal hold. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "Backup.Client.exceptions.InvalidParameterValueException" * "Backup.Client.exceptions.InvalidResourceStateException" * "Backup.Client.exceptions.MissingParameterValueException" * "Backup.Client.exceptions.ServiceUnavailableException" * "Backup.Client.exceptions.ResourceNotFoundException" Backup / Client / describe_restore_job describe_restore_job ******************** Backup.Client.describe_restore_job(**kwargs) Returns metadata associated with a restore job that is specified by a job ID. See also: AWS API Documentation **Request Syntax** response = client.describe_restore_job( RestoreJobId='string' ) Parameters: **RestoreJobId** (*string*) -- **[REQUIRED]** Uniquely identifies the job that restores a recovery point. Return type: dict Returns: **Response Syntax** { 'AccountId': 'string', 'RestoreJobId': 'string', 'RecoveryPointArn': 'string', 'CreationDate': datetime(2015, 1, 1), 'CompletionDate': datetime(2015, 1, 1), 'Status': 'PENDING'|'RUNNING'|'COMPLETED'|'ABORTED'|'FAILED', 'StatusMessage': 'string', 'PercentDone': 'string', 'BackupSizeInBytes': 123, 'IamRoleArn': 'string', 'ExpectedCompletionTimeMinutes': 123, 'CreatedResourceArn': 'string', 'ResourceType': 'string', 'RecoveryPointCreationDate': datetime(2015, 1, 1), 'CreatedBy': { 'RestoreTestingPlanArn': 'string' }, 'ValidationStatus': 'FAILED'|'SUCCESSFUL'|'TIMED_OUT'|'VALIDATING', 'ValidationStatusMessage': 'string', 'DeletionStatus': 'DELETING'|'FAILED'|'SUCCESSFUL', 'DeletionStatusMessage': 'string' } **Response Structure** * *(dict) --* * **AccountId** *(string) --* Returns the account ID that owns the restore job. * **RestoreJobId** *(string) --* Uniquely identifies the job that restores a recovery point. * **RecoveryPointArn** *(string) --* 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** *(datetime) --* 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** *(datetime) --* 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** *(string) --* Status code specifying the state of the job that is initiated by Backup to restore a recovery point. * **StatusMessage** *(string) --* A message showing the status of a job to restore a recovery point. * **PercentDone** *(string) --* Contains an estimated percentage that is complete of a job at the time the job status was queried. * **BackupSizeInBytes** *(integer) --* The size, in bytes, of the restored resource. * **IamRoleArn** *(string) --* Specifies the IAM role ARN used to create the target recovery point; for example, "arn:aws:iam::123456789012:role/S3Access". * **ExpectedCompletionTimeMinutes** *(integer) --* The amount of time in minutes that a job restoring a recovery point is expected to take. * **CreatedResourceArn** *(string) --* The Amazon Resource Name (ARN) of the resource that was created by the restore job. The format of the ARN depends on the resource type of the backed-up resource. * **ResourceType** *(string) --* Returns metadata associated with a restore job listed by resource type. * **RecoveryPointCreationDate** *(datetime) --* The creation date of the recovery point made by the specifed restore job. * **CreatedBy** *(dict) --* Contains identifying information about the creation of a restore job. * **RestoreTestingPlanArn** *(string) --* An Amazon Resource Name (ARN) that uniquely identifies a restore testing plan. * **ValidationStatus** *(string) --* The status of validation run on the indicated restore job. * **ValidationStatusMessage** *(string) --* The status message. * **DeletionStatus** *(string) --* The status of the data generated by the restore test. * **DeletionStatusMessage** *(string) --* This describes the restore job deletion status. **Exceptions** * "Backup.Client.exceptions.ResourceNotFoundException" * "Backup.Client.exceptions.InvalidParameterValueException" * "Backup.Client.exceptions.MissingParameterValueException" * "Backup.Client.exceptions.ServiceUnavailableException" * "Backup.Client.exceptions.DependencyFailureException" Backup / Client / tag_resource tag_resource ************ Backup.Client.tag_resource(**kwargs) Assigns a set of key-value pairs to a resource. See also: AWS API Documentation **Request Syntax** response = client.tag_resource( ResourceArn='string', Tags={ 'string': 'string' } ) Parameters: * **ResourceArn** (*string*) -- **[REQUIRED]** The ARN that uniquely identifies the resource. * **Tags** (*dict*) -- **[REQUIRED]** 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"}]". * *(string) --* * *(string) --* Returns: None **Exceptions** * "Backup.Client.exceptions.ResourceNotFoundException" * "Backup.Client.exceptions.InvalidParameterValueException" * "Backup.Client.exceptions.MissingParameterValueException" * "Backup.Client.exceptions.ServiceUnavailableException" * "Backup.Client.exceptions.LimitExceededException" Backup / Client / delete_backup_vault delete_backup_vault ******************* Backup.Client.delete_backup_vault(**kwargs) Deletes the backup vault identified by its name. A vault can be deleted only if it is empty. See also: AWS API Documentation **Request Syntax** response = client.delete_backup_vault( BackupVaultName='string' ) Parameters: **BackupVaultName** (*string*) -- **[REQUIRED]** 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. Returns: None **Exceptions** * "Backup.Client.exceptions.ResourceNotFoundException" * "Backup.Client.exceptions.InvalidParameterValueException" * "Backup.Client.exceptions.MissingParameterValueException" * "Backup.Client.exceptions.ServiceUnavailableException" * "Backup.Client.exceptions.InvalidRequestException" Backup / Client / get_supported_resource_types get_supported_resource_types **************************** Backup.Client.get_supported_resource_types() Returns the Amazon Web Services resource types supported by Backup. See also: AWS API Documentation **Request Syntax** response = client.get_supported_resource_types() Return type: dict Returns: **Response Syntax** { 'ResourceTypes': [ 'string', ] } **Response Structure** * *(dict) --* * **ResourceTypes** *(list) --* Contains a string with the supported Amazon Web Services resource types: * "Aurora" for Amazon Aurora * "CloudFormation" for CloudFormation * "DocumentDB" for Amazon DocumentDB (with MongoDB compatibility) * "DynamoDB" for Amazon DynamoDB * "EBS" for Amazon Elastic Block Store * "EC2" for Amazon Elastic Compute Cloud * "EFS" for Amazon Elastic File System * "FSx" for Amazon FSx * "Neptune" for Amazon Neptune * "RDS" for Amazon Relational Database Service * "Redshift" for Amazon Redshift * "S3" for Amazon Simple Storage Service (Amazon S3) * "SAP HANA on Amazon EC2" for SAP HANA databases on Amazon Elastic Compute Cloud instances * "Storage Gateway" for Storage Gateway * "Timestream" for Amazon Timestream * "VirtualMachine" for VMware virtual machines * *(string) --* **Exceptions** * "Backup.Client.exceptions.ServiceUnavailableException" Backup / Client / list_restore_access_backup_vaults list_restore_access_backup_vaults ********************************* Backup.Client.list_restore_access_backup_vaults(**kwargs) Returns a list of restore access backup vaults associated with a specified backup vault. See also: AWS API Documentation **Request Syntax** response = client.list_restore_access_backup_vaults( BackupVaultName='string', NextToken='string', MaxResults=123 ) Parameters: * **BackupVaultName** (*string*) -- **[REQUIRED]** The name of the backup vault for which to list associated restore access backup vaults. * **NextToken** (*string*) -- The pagination token from a previous request to retrieve the next set of results. * **MaxResults** (*integer*) -- The maximum number of items to return in the response. Return type: dict Returns: **Response Syntax** { 'NextToken': 'string', 'RestoreAccessBackupVaults': [ { 'RestoreAccessBackupVaultArn': 'string', 'CreationDate': datetime(2015, 1, 1), 'ApprovalDate': datetime(2015, 1, 1), 'VaultState': 'CREATING'|'AVAILABLE'|'FAILED', 'LatestRevokeRequest': { 'MpaSessionArn': 'string', 'Status': 'PENDING'|'FAILED', 'StatusMessage': 'string', 'InitiationDate': datetime(2015, 1, 1), 'ExpiryDate': datetime(2015, 1, 1) } }, ] } **Response Structure** * *(dict) --* * **NextToken** *(string) --* The pagination token to use in a subsequent request to retrieve the next set of results. * **RestoreAccessBackupVaults** *(list) --* A list of restore access backup vaults associated with the specified backup vault. * *(dict) --* Contains information about a restore access backup vault. * **RestoreAccessBackupVaultArn** *(string) --* The ARN of the restore access backup vault. * **CreationDate** *(datetime) --* The date and time when the restore access backup vault was created. * **ApprovalDate** *(datetime) --* The date and time when the restore access backup vault was approved. * **VaultState** *(string) --* The current state of the restore access backup vault. * **LatestRevokeRequest** *(dict) --* Information about the latest request to revoke access to this backup vault. * **MpaSessionArn** *(string) --* The ARN of the MPA session associated with this revoke request. * **Status** *(string) --* The current status of the revoke request. * **StatusMessage** *(string) --* A message describing the current status of the revoke request. * **InitiationDate** *(datetime) --* The date and time when the revoke request was initiated. * **ExpiryDate** *(datetime) --* The date and time when the revoke request will expire. **Exceptions** * "Backup.Client.exceptions.ResourceNotFoundException" * "Backup.Client.exceptions.InvalidParameterValueException" * "Backup.Client.exceptions.MissingParameterValueException" * "Backup.Client.exceptions.ServiceUnavailableException" Backup / Client / delete_backup_selection delete_backup_selection *********************** Backup.Client.delete_backup_selection(**kwargs) Deletes the resource selection associated with a backup plan that is specified by the "SelectionId". See also: AWS API Documentation **Request Syntax** response = client.delete_backup_selection( BackupPlanId='string', SelectionId='string' ) Parameters: * **BackupPlanId** (*string*) -- **[REQUIRED]** Uniquely identifies a backup plan. * **SelectionId** (*string*) -- **[REQUIRED]** Uniquely identifies the body of a request to assign a set of resources to a backup plan. Returns: None **Exceptions** * "Backup.Client.exceptions.ResourceNotFoundException" * "Backup.Client.exceptions.InvalidParameterValueException" * "Backup.Client.exceptions.MissingParameterValueException" * "Backup.Client.exceptions.ServiceUnavailableException" Backup / Client / list_backup_job_summaries list_backup_job_summaries ************************* Backup.Client.list_backup_job_summaries(**kwargs) 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. See also: AWS API Documentation **Request Syntax** response = client.list_backup_job_summaries( AccountId='string', State='CREATED'|'PENDING'|'RUNNING'|'ABORTING'|'ABORTED'|'COMPLETED'|'FAILED'|'EXPIRED'|'PARTIAL'|'AGGREGATE_ALL'|'ANY', ResourceType='string', MessageCategory='string', AggregationPeriod='ONE_DAY'|'SEVEN_DAYS'|'FOURTEEN_DAYS', MaxResults=123, NextToken='string' ) Parameters: * **AccountId** (*string*) -- 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. * **State** (*string*) -- 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_DA YS&MessageCategory=SUCCESS&State=COMPLETED * **ResourceType** (*string*) -- 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. * **MessageCategory** (*string*) -- 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. * **AggregationPeriod** (*string*) -- The period for the returned results. * "ONE_DAY" - The daily job count for the prior 14 days. * "SEVEN_DAYS" - The aggregated job count for the prior 7 days. * "FOURTEEN_DAYS" - The aggregated job count for prior 14 days. * **MaxResults** (*integer*) -- The maximum number of items to be returned. The value is an integer. Range of accepted values is from 1 to 500. * **NextToken** (*string*) -- 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. Return type: dict Returns: **Response Syntax** { 'BackupJobSummaries': [ { 'Region': 'string', 'AccountId': 'string', 'State': 'CREATED'|'PENDING'|'RUNNING'|'ABORTING'|'ABORTED'|'COMPLETED'|'FAILED'|'EXPIRED'|'PARTIAL'|'AGGREGATE_ALL'|'ANY', 'ResourceType': 'string', 'MessageCategory': 'string', 'Count': 123, 'StartTime': datetime(2015, 1, 1), 'EndTime': datetime(2015, 1, 1) }, ], 'AggregationPeriod': 'string', 'NextToken': 'string' } **Response Structure** * *(dict) --* * **BackupJobSummaries** *(list) --* The summary information. * *(dict) --* 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. * **Region** *(string) --* The Amazon Web Services Regions within the job summary. * **AccountId** *(string) --* The account ID that owns the jobs within the summary. * **State** *(string) --* This value is job count for jobs with the specified state. * **ResourceType** *(string) --* This value is the job count for the specified resource type. The request "GetSupportedResourceTypes" returns strings for supported resource types. * **MessageCategory** *(string) --* 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** *(integer) --* The value as a number of jobs in a job summary. * **StartTime** *(datetime) --* 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** *(datetime) --* 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. * **AggregationPeriod** *(string) --* The period for the returned results. * "ONE_DAY" - The daily job count for the prior 14 days. * "SEVEN_DAYS" - The aggregated job count for the prior 7 days. * "FOURTEEN_DAYS" - The aggregated job count for prior 14 days. * **NextToken** *(string) --* 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. **Exceptions** * "Backup.Client.exceptions.InvalidParameterValueException" * "Backup.Client.exceptions.ServiceUnavailableException" Backup / Client / list_frameworks list_frameworks *************** Backup.Client.list_frameworks(**kwargs) Returns a list of all frameworks for an Amazon Web Services account and Amazon Web Services Region. See also: AWS API Documentation **Request Syntax** response = client.list_frameworks( MaxResults=123, NextToken='string' ) Parameters: * **MaxResults** (*integer*) -- The number of desired results from 1 to 1000. Optional. If unspecified, the query will return 1 MB of data. * **NextToken** (*string*) -- 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. Return type: dict Returns: **Response Syntax** { 'Frameworks': [ { 'FrameworkName': 'string', 'FrameworkArn': 'string', 'FrameworkDescription': 'string', 'NumberOfControls': 123, 'CreationTime': datetime(2015, 1, 1), 'DeploymentStatus': 'string' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **Frameworks** *(list) --* The frameworks with details for each framework, including the framework name, Amazon Resource Name (ARN), description, number of controls, creation time, and deployment status. * *(dict) --* Contains detailed information about a framework. Frameworks contain controls, which evaluate and report on your backup events and resources. Frameworks generate daily compliance results. * **FrameworkName** *(string) --* 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** *(string) --* An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type. * **FrameworkDescription** *(string) --* An optional description of the framework with a maximum 1,024 characters. * **NumberOfControls** *(integer) --* The number of controls contained by the framework. * **CreationTime** *(datetime) --* 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** *(string) --* The deployment status of a framework. The statuses are: "CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | COMPLETED | FAILED" * **NextToken** *(string) --* 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. **Exceptions** * "Backup.Client.exceptions.InvalidParameterValueException" * "Backup.Client.exceptions.ServiceUnavailableException" Backup / Client / get_backup_vault_access_policy get_backup_vault_access_policy ****************************** Backup.Client.get_backup_vault_access_policy(**kwargs) Returns the access policy document that is associated with the named backup vault. See also: AWS API Documentation **Request Syntax** response = client.get_backup_vault_access_policy( BackupVaultName='string' ) Parameters: **BackupVaultName** (*string*) -- **[REQUIRED]** 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. Return type: dict Returns: **Response Syntax** { 'BackupVaultName': 'string', 'BackupVaultArn': 'string', 'Policy': 'string' } **Response Structure** * *(dict) --* * **BackupVaultName** *(string) --* 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. * **BackupVaultArn** *(string) --* An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, "arn:aws:backup:us- east-1:123456789012:backup-vault:aBackupVault". * **Policy** *(string) --* The backup vault access policy document in JSON format. **Exceptions** * "Backup.Client.exceptions.ResourceNotFoundException" * "Backup.Client.exceptions.InvalidParameterValueException" * "Backup.Client.exceptions.MissingParameterValueException" * "Backup.Client.exceptions.ServiceUnavailableException" Backup / Client / export_backup_plan_template export_backup_plan_template *************************** Backup.Client.export_backup_plan_template(**kwargs) Returns the backup plan that is specified by the plan ID as a backup template. See also: AWS API Documentation **Request Syntax** response = client.export_backup_plan_template( BackupPlanId='string' ) Parameters: **BackupPlanId** (*string*) -- **[REQUIRED]** Uniquely identifies a backup plan. Return type: dict Returns: **Response Syntax** { 'BackupPlanTemplateJson': 'string' } **Response Structure** * *(dict) --* * **BackupPlanTemplateJson** *(string) --* The body of a backup plan template in JSON format. Note: This is a signed JSON document that cannot be modified before being passed to "GetBackupPlanFromJSON." **Exceptions** * "Backup.Client.exceptions.InvalidParameterValueException" * "Backup.Client.exceptions.MissingParameterValueException" * "Backup.Client.exceptions.ServiceUnavailableException" * "Backup.Client.exceptions.ResourceNotFoundException" Backup / Client / update_framework update_framework **************** Backup.Client.update_framework(**kwargs) Updates the specified framework. See also: AWS API Documentation **Request Syntax** response = client.update_framework( FrameworkName='string', FrameworkDescription='string', FrameworkControls=[ { 'ControlName': 'string', 'ControlInputParameters': [ { 'ParameterName': 'string', 'ParameterValue': 'string' }, ], 'ControlScope': { 'ComplianceResourceIds': [ 'string', ], 'ComplianceResourceTypes': [ 'string', ], 'Tags': { 'string': 'string' } } }, ], IdempotencyToken='string' ) Parameters: * **FrameworkName** (*string*) -- **[REQUIRED]** 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 (_). * **FrameworkDescription** (*string*) -- An optional description of the framework with a maximum 1,024 characters. * **FrameworkControls** (*list*) -- The controls that make up the framework. Each control in the list has a name, input parameters, and scope. * *(dict) --* Contains detailed information about all of the controls of a framework. Each framework must contain at least one control. * **ControlName** *(string) --* **[REQUIRED]** The name of a control. This name is between 1 and 256 characters. * **ControlInputParameters** *(list) --* The name/value pairs. * *(dict) --* The parameters for a control. A control can have zero, one, or more than one parameter. An example of a control with two parameters is: "backup plan frequency is at least "daily" and the retention period is at least "1 year"". The first parameter is "daily". The second parameter is "1 year". * **ParameterName** *(string) --* The name of a parameter, for example, "BackupPlanFrequency". * **ParameterValue** *(string) --* The value of parameter, for example, "hourly". * **ControlScope** *(dict) --* 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. * **ComplianceResourceIds** *(list) --* The ID of the only Amazon Web Services resource that you want your control scope to contain. * *(string) --* * **ComplianceResourceTypes** *(list) --* Describes whether the control scope includes one or more types of resources, such as "EFS" or "RDS". * *(string) --* * **Tags** *(dict) --* 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 if you are creating or editing a framework from the console (though the value can be an empty string when included in a CloudFormation template). The structure to assign a tag is: "[{"Key":"string","Value":"string"}]". * *(string) --* * *(string) --* * **IdempotencyToken** (*string*) -- 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. This field is autopopulated if not provided. Return type: dict Returns: **Response Syntax** { 'FrameworkName': 'string', 'FrameworkArn': 'string', 'CreationTime': datetime(2015, 1, 1) } **Response Structure** * *(dict) --* * **FrameworkName** *(string) --* 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** *(string) --* An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type. * **CreationTime** *(datetime) --* 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. **Exceptions** * "Backup.Client.exceptions.AlreadyExistsException" * "Backup.Client.exceptions.ResourceNotFoundException" * "Backup.Client.exceptions.LimitExceededException" * "Backup.Client.exceptions.InvalidParameterValueException" * "Backup.Client.exceptions.MissingParameterValueException" * "Backup.Client.exceptions.ConflictException" * "Backup.Client.exceptions.ServiceUnavailableException" Backup / Client / put_restore_validation_result put_restore_validation_result ***************************** Backup.Client.put_restore_validation_result(**kwargs) 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". See also: AWS API Documentation **Request Syntax** response = client.put_restore_validation_result( RestoreJobId='string', ValidationStatus='FAILED'|'SUCCESSFUL'|'TIMED_OUT'|'VALIDATING', ValidationStatusMessage='string' ) Parameters: * **RestoreJobId** (*string*) -- **[REQUIRED]** This is a unique identifier of a restore job within Backup. * **ValidationStatus** (*string*) -- **[REQUIRED]** The status of your restore validation. * **ValidationStatusMessage** (*string*) -- This is an optional message string you can input to describe the validation status for the restore test validation. Returns: None **Exceptions** * "Backup.Client.exceptions.InvalidParameterValueException" * "Backup.Client.exceptions.InvalidRequestException" * "Backup.Client.exceptions.MissingParameterValueException" * "Backup.Client.exceptions.ResourceNotFoundException" * "Backup.Client.exceptions.ServiceUnavailableException" Backup / Client / get_backup_vault_notifications get_backup_vault_notifications ****************************** Backup.Client.get_backup_vault_notifications(**kwargs) Returns event notifications for the specified backup vault. See also: AWS API Documentation **Request Syntax** response = client.get_backup_vault_notifications( BackupVaultName='string' ) Parameters: **BackupVaultName** (*string*) -- **[REQUIRED]** 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. Return type: dict Returns: **Response Syntax** { 'BackupVaultName': 'string', 'BackupVaultArn': 'string', 'SNSTopicArn': 'string', 'BackupVaultEvents': [ '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'|'CONTINUOUS_BACKUP_INTERRUPTED'|'RECOVERY_POINT_INDEX_COMPLETED'|'RECOVERY_POINT_INDEX_DELETED'|'RECOVERY_POINT_INDEXING_FAILED', ] } **Response Structure** * *(dict) --* * **BackupVaultName** *(string) --* 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. * **BackupVaultArn** *(string) --* An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, "arn:aws:backup:us- east-1:123456789012:backup-vault:aBackupVault". * **SNSTopicArn** *(string) --* An ARN that uniquely identifies an Amazon Simple Notification Service (Amazon SNS) topic; for example, "arn:aws:sns:us-west-2:111122223333:MyTopic". * **BackupVaultEvents** *(list) --* An array of events that indicate the status of jobs to back up resources to the backup vault. * *(string) --* **Exceptions** * "Backup.Client.exceptions.ResourceNotFoundException" * "Backup.Client.exceptions.InvalidParameterValueException" * "Backup.Client.exceptions.MissingParameterValueException" * "Backup.Client.exceptions.ServiceUnavailableException" Backup / Client / update_report_plan update_report_plan ****************** Backup.Client.update_report_plan(**kwargs) Updates the specified report plan. See also: AWS API Documentation **Request Syntax** response = client.update_report_plan( ReportPlanName='string', ReportPlanDescription='string', ReportDeliveryChannel={ 'S3BucketName': 'string', 'S3KeyPrefix': 'string', 'Formats': [ 'string', ] }, ReportSetting={ 'ReportTemplate': 'string', 'FrameworkArns': [ 'string', ], 'NumberOfFrameworks': 123, 'Accounts': [ 'string', ], 'OrganizationUnits': [ 'string', ], 'Regions': [ 'string', ] }, IdempotencyToken='string' ) Parameters: * **ReportPlanName** (*string*) -- **[REQUIRED]** 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** (*string*) -- An optional description of the report plan with a maximum 1,024 characters. * **ReportDeliveryChannel** (*dict*) -- The information about where to deliver your reports, specifically your Amazon S3 bucket name, S3 key prefix, and the formats of your reports. * **S3BucketName** *(string) --* **[REQUIRED]** The unique name of the S3 bucket that receives your reports. * **S3KeyPrefix** *(string) --* 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** *(list) --* The format of your reports: "CSV", "JSON", or both. If not specified, the default format is "CSV". * *(string) --* * **ReportSetting** (*dict*) -- 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. * **ReportTemplate** *(string) --* **[REQUIRED]** 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** *(list) --* The Amazon Resource Names (ARNs) of the frameworks a report covers. * *(string) --* * **NumberOfFrameworks** *(integer) --* The number of frameworks a report covers. * **Accounts** *(list) --* These are the accounts to be included in the report. Use string value of "ROOT" to include all organizational units. * *(string) --* * **OrganizationUnits** *(list) --* These are the Organizational Units to be included in the report. * *(string) --* * **Regions** *(list) --* These are the Regions to be included in the report. Use the wildcard as the string value to include all Regions. * *(string) --* * **IdempotencyToken** (*string*) -- 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. This field is autopopulated if not provided. Return type: dict Returns: **Response Syntax** { 'ReportPlanName': 'string', 'ReportPlanArn': 'string', 'CreationTime': datetime(2015, 1, 1) } **Response Structure** * *(dict) --* * **ReportPlanName** *(string) --* The unique name of the report plan. * **ReportPlanArn** *(string) --* An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type. * **CreationTime** *(datetime) --* 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. **Exceptions** * "Backup.Client.exceptions.ResourceNotFoundException" * "Backup.Client.exceptions.InvalidParameterValueException" * "Backup.Client.exceptions.ServiceUnavailableException" * "Backup.Client.exceptions.MissingParameterValueException" * "Backup.Client.exceptions.ConflictException" Backup / Client / delete_restore_testing_selection delete_restore_testing_selection ******************************** Backup.Client.delete_restore_testing_selection(**kwargs) 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. See also: AWS API Documentation **Request Syntax** response = client.delete_restore_testing_selection( RestoreTestingPlanName='string', RestoreTestingSelectionName='string' ) Parameters: * **RestoreTestingPlanName** (*string*) -- **[REQUIRED]** Required unique name of the restore testing plan that contains the restore testing selection you wish to delete. * **RestoreTestingSelectionName** (*string*) -- **[REQUIRED]** Required unique name of the restore testing selection you wish to delete. Returns: None **Exceptions** * "Backup.Client.exceptions.ResourceNotFoundException" * "Backup.Client.exceptions.ServiceUnavailableException" Backup / Client / disassociate_backup_vault_mpa_approval_team disassociate_backup_vault_mpa_approval_team ******************************************* Backup.Client.disassociate_backup_vault_mpa_approval_team(**kwargs) Removes the association between an MPA approval team and a backup vault, disabling the MPA approval workflow for restore operations. See also: AWS API Documentation **Request Syntax** response = client.disassociate_backup_vault_mpa_approval_team( BackupVaultName='string', RequesterComment='string' ) Parameters: * **BackupVaultName** (*string*) -- **[REQUIRED]** The name of the backup vault from which to disassociate the MPA approval team. * **RequesterComment** (*string*) -- An optional comment explaining the reason for disassociating the MPA approval team from the backup vault. Returns: None **Exceptions** * "Backup.Client.exceptions.ResourceNotFoundException" * "Backup.Client.exceptions.InvalidParameterValueException" * "Backup.Client.exceptions.MissingParameterValueException" * "Backup.Client.exceptions.InvalidRequestException" * "Backup.Client.exceptions.ServiceUnavailableException" Backup / Client / get_backup_selection get_backup_selection ******************** Backup.Client.get_backup_selection(**kwargs) Returns selection metadata and a document in JSON format that specifies a list of resources that are associated with a backup plan. See also: AWS API Documentation **Request Syntax** response = client.get_backup_selection( BackupPlanId='string', SelectionId='string' ) Parameters: * **BackupPlanId** (*string*) -- **[REQUIRED]** Uniquely identifies a backup plan. * **SelectionId** (*string*) -- **[REQUIRED]** Uniquely identifies the body of a request to assign a set of resources to a backup plan. Return type: dict Returns: **Response Syntax** { 'BackupSelection': { 'SelectionName': 'string', 'IamRoleArn': 'string', 'Resources': [ 'string', ], 'ListOfTags': [ { 'ConditionType': 'STRINGEQUALS', 'ConditionKey': 'string', 'ConditionValue': 'string' }, ], 'NotResources': [ 'string', ], 'Conditions': { 'StringEquals': [ { 'ConditionKey': 'string', 'ConditionValue': 'string' }, ], 'StringNotEquals': [ { 'ConditionKey': 'string', 'ConditionValue': 'string' }, ], 'StringLike': [ { 'ConditionKey': 'string', 'ConditionValue': 'string' }, ], 'StringNotLike': [ { 'ConditionKey': 'string', 'ConditionValue': 'string' }, ] } }, 'SelectionId': 'string', 'BackupPlanId': 'string', 'CreationDate': datetime(2015, 1, 1), 'CreatorRequestId': 'string' } **Response Structure** * *(dict) --* * **BackupSelection** *(dict) --* Specifies the body of a request to assign a set of resources to a backup plan. * **SelectionName** *(string) --* The display name of a resource selection document. Must contain 1 to 50 alphanumeric or '-_.' characters. * **IamRoleArn** *(string) --* 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** *(list) --* The Amazon Resource Names (ARNs) of the resources 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. If you specify multiple ARNs, the resources much match any of the ARNs (OR logic). * *(string) --* * **ListOfTags** *(list) --* The conditions that you define to assign resources to your backup plans using tags. For example, ""StringEquals": { "ConditionKey": "backup", "ConditionValue": "daily"}". "ListOfTags" supports only "StringEquals". Condition operators are case sensitive. If you specify multiple conditions, the resources much match any of the conditions (OR logic). * *(dict) --* 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. * **ConditionType** *(string) --* 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** *(string) --* The key in a key-value pair. For example, in the tag "Department: Accounting", "Department" is the key. * **ConditionValue** *(string) --* The value in a key-value pair. For example, in the tag "Department: Accounting", "Accounting" is the value. * **NotResources** *(list) --* The Amazon Resource Names (ARNs) of the resources 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. * *(string) --* * **Conditions** *(dict) --* The conditions that you define to assign resources to your backup plans using tags. For example, ""StringEquals": { "ConditionKey": "aws:ResourceTag/backup", "ConditionValue": "daily" }". "Conditions" supports "StringEquals", "StringLike", "StringNotEquals", and "StringNotLike". Condition operators are case sensitive. If you specify multiple conditions, the resources much match all conditions (AND logic). * **StringEquals** *(list) --* Filters the values of your tagged resources for only those resources that you tagged with the same value. Also called "exact matching." * *(dict) --* Includes information about tags you define to assign tagged resources to a backup plan. Include the prefix "aws:ResourceTag" in your tags. For example, ""aws:ResourceTag/TagKey1": "Value1"". * **ConditionKey** *(string) --* The key in a key-value pair. For example, in the tag "Department: Accounting", "Department" is the key. * **ConditionValue** *(string) --* The value in a key-value pair. For example, in the tag "Department: Accounting", "Accounting" is the value. * **StringNotEquals** *(list) --* 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." * *(dict) --* Includes information about tags you define to assign tagged resources to a backup plan. Include the prefix "aws:ResourceTag" in your tags. For example, ""aws:ResourceTag/TagKey1": "Value1"". * **ConditionKey** *(string) --* The key in a key-value pair. For example, in the tag "Department: Accounting", "Department" is the key. * **ConditionValue** *(string) --* The value in a key-value pair. For example, in the tag "Department: Accounting", "Accounting" is the value. * **StringLike** *(list) --* 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". * *(dict) --* Includes information about tags you define to assign tagged resources to a backup plan. Include the prefix "aws:ResourceTag" in your tags. For example, ""aws:ResourceTag/TagKey1": "Value1"". * **ConditionKey** *(string) --* The key in a key-value pair. For example, in the tag "Department: Accounting", "Department" is the key. * **ConditionValue** *(string) --* The value in a key-value pair. For example, in the tag "Department: Accounting", "Accounting" is the value. * **StringNotLike** *(list) --* Filters the values of your tagged resources for non- matching tag values with the use of a wildcard character (*) anywhere in the string. * *(dict) --* Includes information about tags you define to assign tagged resources to a backup plan. Include the prefix "aws:ResourceTag" in your tags. For example, ""aws:ResourceTag/TagKey1": "Value1"". * **ConditionKey** *(string) --* The key in a key-value pair. For example, in the tag "Department: Accounting", "Department" is the key. * **ConditionValue** *(string) --* The value in a key-value pair. For example, in the tag "Department: Accounting", "Accounting" is the value. * **SelectionId** *(string) --* Uniquely identifies the body of a request to assign a set of resources to a backup plan. * **BackupPlanId** *(string) --* Uniquely identifies a backup plan. * **CreationDate** *(datetime) --* 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** *(string) --* A unique string that identifies the request and allows failed requests to be retried without the risk of running the operation twice. **Exceptions** * "Backup.Client.exceptions.ResourceNotFoundException" * "Backup.Client.exceptions.InvalidParameterValueException" * "Backup.Client.exceptions.MissingParameterValueException" * "Backup.Client.exceptions.ServiceUnavailableException" Backup / Client / create_legal_hold create_legal_hold ***************** Backup.Client.create_legal_hold(**kwargs) 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. See also: AWS API Documentation **Request Syntax** response = client.create_legal_hold( Title='string', Description='string', IdempotencyToken='string', RecoveryPointSelection={ 'VaultNames': [ 'string', ], 'ResourceIdentifiers': [ 'string', ], 'DateRange': { 'FromDate': datetime(2015, 1, 1), 'ToDate': datetime(2015, 1, 1) } }, Tags={ 'string': 'string' } ) Parameters: * **Title** (*string*) -- **[REQUIRED]** The title of the legal hold. * **Description** (*string*) -- **[REQUIRED]** The description of the legal hold. * **IdempotencyToken** (*string*) -- 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. This field is autopopulated if not provided. * **RecoveryPointSelection** (*dict*) -- The criteria to assign a set of resources, such as resource types or backup vaults. * **VaultNames** *(list) --* These are the names of the vaults in which the selected recovery points are contained. * *(string) --* * **ResourceIdentifiers** *(list) --* These are the resources included in the resource selection (including type of resources and vaults). * *(string) --* * **DateRange** *(dict) --* 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. * **FromDate** *(datetime) --* **[REQUIRED]** 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** *(datetime) --* **[REQUIRED]** 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). * **Tags** (*dict*) -- 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: + - = . _ : /. * *(string) --* * *(string) --* Return type: dict Returns: **Response Syntax** { 'Title': 'string', 'Status': 'CREATING'|'ACTIVE'|'CANCELING'|'CANCELED', 'Description': 'string', 'LegalHoldId': 'string', 'LegalHoldArn': 'string', 'CreationDate': datetime(2015, 1, 1), 'RecoveryPointSelection': { 'VaultNames': [ 'string', ], 'ResourceIdentifiers': [ 'string', ], 'DateRange': { 'FromDate': datetime(2015, 1, 1), 'ToDate': datetime(2015, 1, 1) } } } **Response Structure** * *(dict) --* * **Title** *(string) --* The title of the legal hold. * **Status** *(string) --* The status of the legal hold. * **Description** *(string) --* The description of the legal hold. * **LegalHoldId** *(string) --* The ID of the legal hold. * **LegalHoldArn** *(string) --* The Amazon Resource Name (ARN) of the legal hold. * **CreationDate** *(datetime) --* The time when the legal hold was created. * **RecoveryPointSelection** *(dict) --* The criteria to assign to a set of resources, such as resource types or backup vaults. * **VaultNames** *(list) --* These are the names of the vaults in which the selected recovery points are contained. * *(string) --* * **ResourceIdentifiers** *(list) --* These are the resources included in the resource selection (including type of resources and vaults). * *(string) --* * **DateRange** *(dict) --* 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. * **FromDate** *(datetime) --* 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** *(datetime) --* 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). **Exceptions** * "Backup.Client.exceptions.InvalidParameterValueException" * "Backup.Client.exceptions.MissingParameterValueException" * "Backup.Client.exceptions.ServiceUnavailableException" * "Backup.Client.exceptions.LimitExceededException"