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á.
CreateReportPlan
Cria um plano de relatório. Um plano de relatório é um documento que contém informações sobre o conteúdo do relatório e onde AWS Backup será entregue.
Se chamar CreateReportPlan com um plano existente, você receberá uma exceção AlreadyExistsException.
Sintaxe da Solicitação
POST /audit/report-plans HTTP/1.1
Content-type: application/json
{
"IdempotencyToken": "string",
"ReportDeliveryChannel": {
"Formats": [ "string" ],
"S3BucketName": "string",
"S3KeyPrefix": "string"
},
"ReportPlanDescription": "string",
"ReportPlanName": "string",
"ReportPlanTags": {
"string" : "string"
},
"ReportSetting": {
"Accounts": [ "string" ],
"FrameworkArns": [ "string" ],
"NumberOfFrameworks": number,
"OrganizationUnits": [ "string" ],
"Regions": [ "string" ],
"ReportTemplate": "string"
}
}URIParâmetros de solicitação
A solicitação não usa nenhum URI parâmetro.
Corpo da Solicitação
A solicitação aceita os seguintes dados no JSON formato.
- IdempotencyToken
-
Uma string escolhida pelo cliente que pode ser usada para distinguir entre chamadas idênticas para
CreateReportPlanInput. Tentar novamente uma solicitação com êxito com o mesmo token de idempotência resultará em uma mensagem de êxito sem nenhuma ação tomada.Tipo: string
Obrigatório: Não
- ReportDeliveryChannel
-
Uma estrutura que contém informações sobre onde e como entregar seus relatórios, especificamente o nome do bucket do Amazon S3, o prefixo de chave do S3 e os formatos dos relatórios.
Tipo: objeto ReportDeliveryChannel
Obrigatório: Sim
- ReportPlanDescription
-
Uma descrição opcional do plano de relatório com 1.024 caracteres no máximo.
Tipo: string
Restrições de tamanho: tamanho mínimo 0. Tamanho máximo de 1.024.
Padrão:
.*\S.*Obrigatório: Não
- ReportPlanName
-
O nome exclusivo do plano de relatório. Esse nome deve ter entre 1 e 256 caracteres, começando com uma letra, e consistir em letras (a-z, A-Z), números (0-9) e sublinhados (_).
Tipo: string
Restrições de tamanho: tamanho mínimo 1. Tamanho máximo de 256.
Padrão:
[a-zA-Z][_a-zA-Z0-9]*Exigido: Sim
- ReportPlanTags
-
As tags a serem atribuídas ao plano de relatório.
Tipo: mapa de string para string
Obrigatório: Não
- ReportSetting
-
Identifica o modelo do relatório. Relatórios são criados utilizando um modelo de relatório. Os modelos de relatório são:
RESOURCE_COMPLIANCE_REPORT | CONTROL_COMPLIANCE_REPORT | BACKUP_JOB_REPORT | COPY_JOB_REPORT | RESTORE_JOB_REPORTSe o modelo de relatório for
RESOURCE_COMPLIANCE_REPORTouCONTROL_COMPLIANCE_REPORT, esse API recurso também descreve a cobertura do relatório por Regiões da AWS estruturas.Tipo: objeto ReportSetting
Exigido: Sim
Sintaxe da Resposta
HTTP/1.1 200
Content-type: application/json
{
"CreationTime": number,
"ReportPlanArn": "string",
"ReportPlanName": "string"
}Elementos de Resposta
Se a ação for bem-sucedida, o serviço retornará uma resposta HTTP de 200.
Os dados a seguir são retornados em JSON formato pelo serviço.
- CreationTime
-
A data e a hora em que um cofre de backup é criado, no formato Unix e no Tempo Universal Coordenado ()UTC. O valor de
CreationTimetem precisão de milissegundos. Por exemplo, o valor 1516925490,087 representa sexta-feira, 26 de janeiro de 2018, 0:11:30,087.Tipo: carimbo de data/hora
- ReportPlanArn
-
Um nome de recurso da Amazon (ARN) que identifica de forma exclusiva um recurso. O formato do ARN depende do tipo de recurso.
Tipo: string
- ReportPlanName
-
O nome exclusivo do plano de relatório.
Tipo: string
Restrições de tamanho: tamanho mínimo 1. Tamanho máximo de 256.
Padrão:
[a-zA-Z][_a-zA-Z0-9]*
Erros
Para obter informações sobre os erros comuns a todas as ações, consulte Erros comuns.
- AlreadyExistsException
-
O recurso necessário já existe.
HTTPCódigo de status: 400
- InvalidParameterValueException
-
Indica que há algo errado com o valor de um parâmetro. Por exemplo, o valor está fora do intervalo.
HTTPCódigo de status: 400
- LimitExceededException
-
Um limite na solicitação foi excedido; por exemplo, o número máximo de itens permitidos em uma solicitação.
HTTPCódigo de status: 400
- MissingParameterValueException
-
Indica que um parâmetro necessário está ausente.
HTTPCódigo de status: 400
- ServiceUnavailableException
-
Houve falha na solicitação devido a um erro temporário do servidor.
HTTPCódigo de status: 500
Consulte também
Para obter mais informações sobre como usar isso API em um idioma específico AWS SDKs, consulte o seguinte:
