Choosing your report template - AWS Backup
Backup report templatesCompliance report templates

Choosing your report template

A report template defines the information that your report plan includes in your report. When you automate your reports using a report plan, AWS Backup Audit Manager provides you reports for the previous 24 hours. AWS Backup Audit Manager creates these reports between the hours of 1 and 5 AM UTC. It offers the following report templates.

Backup report templates

Backup report templates. These templates give you daily updates on your backup, restore, or copy jobs. You can use these reports to monitor your operational posture and identify any failures that might need further action. The following table lists each backup report template name and its sample output.

Backup report template Sample report in JSON format
BACKUP_JOB_REPORT 
{
  "reportItems": [
    {
      "reportTimePeriod": "2021-07-14T00:00:00Z - 2021-07-15T00:00:00Z",
      "accountId": "112233445566",
      "region": "us-west-2",
      "backupJobId": "FCCB040A-9426-2A49-2EA9-5EAFFAC656AC",
      "jobStatus": "COMPLETED",
      "resourceType": "EC2",
      "resourceArn": "arn:aws:ec2:us-west-2:112233445566:instance/i-0bc877aee7782ba75",
      "backupPlanArn": "arn:aws:backup:us-west-2:112233445566:backup-plan:349f2247-b489-4301-83ac-4b7dd724db9a",
      "backupRuleId": "ab88bbf8-ff4e-4f1b-92e7-e13d3e65dcfb",
      "creationDate": "2021-07-14T23:53:47.229Z",
      "completionDate": "2021-07-15T00:16:07.282Z",
      "recoveryPointArn": "arn:aws:ec2:us-west-2::image/ami-030cafb98e5a6dcdf",
      "jobRunTime": "00:22:20",
      "backupSizeInBytes": 8589934592,
      "backupVaultName": "Default",
      "backupVaultArn": "arn:aws:backup:us-west-2:112233445566:backup-vault:Default",
      "iamRoleArn": "arn:aws:iam::112233445566:role/service-role/AWSBackupDefaultServiceRole"
    }
  ]
}
COPY_JOB_REPORT 
{
  "reportItems": [
    {
      "reportTimePeriod": "2021-07-14T15:48:31Z - 2021-07-15T15:48:31Z",
      "accountId": "112233445566",
      "region": "us-west-2",
      "copyJobId": "E0AD48A9-0560-B668-3EF0-941FDC0AD6B1",
      "jobStatus": "RUNNING",
      "resourceType": "EC2",
      "resourceArn": "arn:aws:ec2:us-west-2:112233445566:instance/i-0bc877aee7782ba75",
      "backupPlanArn": "arn:aws:backup:us-west-2:112233445566:backup-plan:349f2247-b489-4301-83ac-4b7dd724db9a",
      "backupRuleId": "ab88bbf8-ff4e-4f1b-92e7-e13d3e65dcfb",
      "creationDate": "2021-07-15T15:42:04.771Z",
      "backupSizeInBytes": 8589934592,
      "sourceRecoveryPointArn": "arn:aws:ec2:us-west-2::image/ami-007b3819f25697299",
      "sourceBackupVaultArn": "arn:aws:backup:us-west-2:112233445566:backup-vault:Default",
      "destinationRecoveryPointArn": "arn:aws:ec2:us-east-2::image/ami-0eba2199a0bcece3c",
      "destinationBackupVaultArn": "arn:aws:backup:us-east-2:112233445566:backup-vault:Default",
      "iamRoleArn": "arn:aws:iam::112233445566:role/service-role/AWSBackupDefaultServiceRole"
    }
  ]
}
RESTORE_JOB_REPORT 
{
  "reportItems": [
    {
      "reportTimePeriod": "2021-07-14T15:53:30Z - 2021-07-15T15:53:30Z",
      "accountId": "112233445566",
      "region": "us-west-2",
      "restoreJobId": "4CACA67D-4E12-DC05-6C2B-0E97D01FA41E",
      "jobStatus": "RUNNING",
      "recoveryPointArn": "arn:aws:ec2:us-west-2::image/ami-00201ecb57a5271ae",
      "creationDate": "2021-07-15T15:52:49.797Z",
      "backupSizeInBytes": 8589934592,
      "percentDone": "0.00%",
      "iamRoleArn": "arn:aws:iam::112233445566:role/service-role/AWSBackupDefaultServiceRole"
    }
  ]
}

Compliance report templates

Compliance report templates give you daily reports on the compliance of your backup activity and resources against the controls you defined in one or more frameworks. If the compliance status of one of your frameworks is Non-compliant, review a compliance report to identify the non-compliant resources.

Types of compliance report templates

  • Control compliance report helps you track the compliance status of the controls you have defined in your frameworks.

  • Resource compliance report helps you track the compliance status of your resources against the controls you defined in your frameworks. These reports include detailed evaluation results, including identifying information on non-compliant resources that you can use to identify and correct those resources.

The following table shows sample output from a compliance report.

Compliance report template Sample report in JSON format
CONTROL_COMPLIANCE_REPORT 
{
  "reportItems": [
    {
      "accountId": "112233445566",
      "region": "me-south-1",
      "frameworkName": "TestFramework7",
      "frameworkDescription": "A test framework",
      "controlName": "BACKUP_RESOURCES_PROTECTED_BY_BACKUP_PLAN",
      "controlComplianceStatus": "NON_COMPLIANT",
      "lastEvaluationTime": "2021-08-17T03:21:56.002Z",
      "numResourcesCompliant": 91,
      "numResourcesNonCompliant": 205,
      "controlFrequency": "Twelve_Hours",
      "controlScope": "",
      "controlParameters": ""
    },
    {
      "accountId": "112233445566",
      "region": "me-south-1",
      "frameworkName": "TestFramework7",
      "frameworkDescription": "A test framework",
      "controlName": "BACKUP_PLAN_MIN_FREQUENCY_AND_MIN_RETENTION_CHECK",
      "controlComplianceStatus": "NON_COMPLIANT",
      "lastEvaluationTime": "2021-08-17T03:21:19.995Z",
      "numResourcesCompliant": 0,
      "numResourcesNonCompliant": 25,
      "controlScope": "{ComplianceResourceTypes: [],}",
      "controlParameters": "{\"requiredFrequencyValue\":\"1\",\"requiredRetentionDays\":\"35\",\"requiredFrequencyUnit\":\"hours\"}"
    }
  ]
}
RESOURCE_COMPLIANCE_REPORT 
{
  "reportItems": [
    {
      "accountId": "112233445566",
      "region": "us-west-2",
      "frameworkName": "MyTestFramework",
      "frameworkDescription": "",
      "controlName": "BACKUP_LAST_RECOVERY_POINT_CREATED",
      "resourceName": "",
      "resourceId": "AWS::EFS::FileSystem/fs-63c74e66",
      "resourceType": "AWS::EFS::FileSystem",
      "resourceComplianceStatus": "NON_COMPLIANT",
      "lastEvaluationTime": "2021-07-07T18:55:40.963Z"
    },
    {
      "accountId": "112233445566",
      "region": "us-west-2",
      "frameworkName": "MyTestFramework",
      "frameworkDescription": "",
      "controlName": "BACKUP_LAST_RECOVERY_POINT_CREATED",
      "resourceName": "",
      "resourceId": "AWS::EFS::FileSystem/fs-b3d7c218",
      "resourceType": "AWS::EFS::FileSystem",
      "resourceComplianceStatus": "NON_COMPLIANT",
      "lastEvaluationTime": "2021-07-07T18:55:40.961Z"
    }
  ]
}