

As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.

# Criação de planos de relatórios usando a AWS Backup API
<a name="create-report-plan-api"></a>

Também é possível trabalhar com planos de relatórios de forma programática.

Há dois tipos de relatório: Um tipo é o **relatório de trabalhos**, que mostra os trabalhos concluídos nas últimas 24 horas e todos os trabalhos ativos. O segundo tipo de relatório é o **relatório de conformidade**. Os relatórios de conformidade podem monitorar os níveis de recursos ou os diferentes controles em vigor. Ao criar um relatório, escolha o tipo de relatório a ser criado.

Semelhante a um *plano de backup*, você cria um *plano de relatório* para automatizar a criação de seus relatórios e definir seu bucket do Amazon S3 de destino. Um plano de relatório exige que você tenha um bucket do S3 para receber os relatórios. Para obter instruções sobre como configurar um novo bucket do S3, consulte [Etapa 1: Criar seu primeiro bucket do S3](https://docs.aws.amazon.com/AmazonS3/latest/userguide/GetStartedWithS3.html#creating-bucket) no *Guia do usuário do Amazon Simple Storage Service*.

Se você criptografar o bucket usando uma chave do KMS personalizada, a política de chave do KMS deverá atender aos seguintes requisitos:
+ O atributo `Principal` deve incluir o ARN [https://console.aws.amazon.com/iam/home#/policies/arn:aws:iam::aws:policy/aws-service-role/AWSServiceRolePolicyForBackupReports](https://console.aws.amazon.com/iam/home#/policies/arn:aws:iam::aws:policy/aws-service-role/AWSServiceRolePolicyForBackupReports) do perfil vinculado ao serviço do Backup Audit Manager.
+ O atributo `Action` deve incluir `kms:GenerateDataKey` e `kms:Decrypt`, no mínimo.

 A política [AWSServiceRolePolicyForBackupReports](https://console.aws.amazon.com/iam/home#/policies/arn:aws:iam::aws:policy/aws-service-role/AWSServiceRolePolicyForBackupReports)tem essas permissões.

Para relatórios de conta única e região única, use a sintaxe a seguir para chamar a [CreateReportPlan](API_CreateReportPlan.md). 

```
{
   "ReportPlanName": "string",
   "ReportPlanDescription": "string",
   "ReportSetting": {
        "ReportTemplate": enum, // Can be RESOURCE_COMPLIANCE_REPORT, CONTROL_COMPLIANCE_REPORT, BACKUP_JOB_REPORT, COPY_JOB_REPORT, or RESTORE_JOB_REPORT. Only include "ReportCoverageList" if your report is a COMPLIANCE_REPORT.
   "ReportDeliveryChannel": {
       "S3BucketName": "string",
       "S3KeyPrefix": "string",
       "Formats": [ enum ] // Optional. Can be either CSV, JSON, or both. Default is CSV if left blank.
   },
   "ReportPlanTags": { 
       "string" : "string" // Optional.
   },
   "IdempotencyToken": "string"
}
```

Quando você chama [DescribeReportPlan](API_DescribeReportPlan.md) com o nome exclusivo de um plano de relatório, a API do AWS Backup responde com as seguintes informações:

```
{
    "ReportPlanArn": "string",
    "ReportPlanName": "string",
    "ReportPlanDescription": "string",
    "ReportSetting": {
        "ReportTemplate": enum,
    },
    "ReportDeliveryChannel": {
        "S3BucketName": "string",
        "S3KeyPrefix": "string",
        "Formats": [ enum ]
    },
    "DeploymentStatus": enum
    "CreationTime": timestamp,
    "LastAttemptExecutionTime": timestamp,
    "LastSuccessfulExecutionTime": timestamp
}
```

Para relatórios de várias contas e várias regiões, use a sintaxe a seguir para chamar [CreateReportPlan](API_CreateReportPlan.md).

```
{
   "IdempotencyToken": "string",
   "ReportDeliveryChannel": { 
      "Formats": [ "string" ], *//Organization report only support CSV file*
      "S3BucketName": "string",
      "S3KeyPrefix": "string"
   },
   "ReportPlanDescription": "string",
   "ReportPlanName": "string",
   "ReportPlanTags": { 
      "string" : "string" 
   },
   "ReportSetting": { 
      "Accounts": [ "string" ], // Use string value of "ROOT" to include all organizational units
      "OrganizationUnits": [ "string" ],
      "Regions": ["string"], // Use wildcard value in string to include all Regions
      "FrameworkArns": [ "string" ],
      "NumberOfFrameworks": number,
      "ReportTemplate": "string"
   }
}
```

Quando você chama [DescribeReportPlan](API_DescribeReportPlan.md) com o nome exclusivo de um plano de relatório, a API do AWS Backup responde com as seguintes informações para planos de várias contas e várias regiões:

```
{
   "ReportPlan": { 
      "CreationTime": number,
      "DeploymentStatus": "string",
      "LastAttemptedExecutionTime": number,
      "LastSuccessfulExecutionTime": number,
      "ReportDeliveryChannel": { 
         "Formats": [ "string" ],
         "S3BucketName": "string",
         "S3KeyPrefix": "string"
      },
      "ReportPlanArn": "string",
      "ReportPlanDescription": "string",
      "ReportPlanName": "string",
      "ReportSetting": { 
         "Accounts":[ "string" ],
         "OrganizationUnits":[ "string" ],
         "Regions": [ "string" ], 
         "FrameworkArns": [ "string" ],
         "NumberOfFrameworks": number,
         "ReportTemplate": "string"
      }
   }
}
```