CreateReportPlan
Crea un plan de informe. Un plan de informe es un documento que contiene información sobre el contenido del informe y dónde lo entregará AWS Backup.
Si llama a CreateReportPlan con un plan que ya existe, recibirá una excepción AlreadyExistsException.
Sintaxis de la solicitud
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"
}
}Parámetros de solicitud del URI
La solicitud no utiliza ningún parámetro de URI.
Cuerpo de la solicitud
La solicitud acepta los siguientes datos en formato JSON.
- IdempotencyToken
-
Una cadena elegida por el cliente que puede utilizar para distinguir entre llamadas a
CreateReportPlanInputque, de otro modo, serían idénticas. Si se vuelve a intentar una solicitud correcta con el mismo token de idempotencia, aparece un mensaje de confirmación y no se realiza ninguna acción.Tipo: cadena
Requerido: no
- ReportDeliveryChannel
-
Una estructura que contiene información sobre dónde y cómo entregar sus informes, específicamente el nombre del bucket de Amazon S3, el prefijo de clave de S3 y los formatos de sus informes.
Tipo: objeto ReportDeliveryChannel
Obligatorio: sí
- ReportPlanDescription
-
Una descripción opcional del plan de informes con un máximo de 1024 caracteres.
Tipo: cadena
Limitaciones de longitud: longitud mínima de 0 caracteres. La longitud máxima es de 1024 caracteres.
Patrón:
.*\S.*Requerido: no
- ReportPlanName
-
El nombre único del plan de informes. El nombre debe contener entre 1 y 256 caracteres, comenzando por una letra, y contar con letras (a-z, A-Z), números (0-9) y guiones bajos (_).
Tipo: cadena
Limitaciones de longitud: longitud mínima de 1. La longitud máxima es de 256 caracteres.
Patrón:
[a-zA-Z][_a-zA-Z0-9]*Obligatorio: sí
- ReportPlanTags
-
Las etiquetas que se van a asignar al plan de informe.
Tipo: mapa de cadena a cadena
Requerido: no
- ReportSetting
-
Identifica la plantilla para el informe. Los informes se crean mediante una plantilla. Las plantillas de informes son:
RESOURCE_COMPLIANCE_REPORT | CONTROL_COMPLIANCE_REPORT | BACKUP_JOB_REPORT | COPY_JOB_REPORT | RESTORE_JOB_REPORTSi la plantilla de informe es
RESOURCE_COMPLIANCE_REPORToCONTROL_COMPLIANCE_REPORT, este recurso de la API también describe la cobertura de informes por Regiones de AWS y marcos.Tipo: objeto ReportSetting
Obligatorio: sí
Sintaxis de la respuesta
HTTP/1.1 200
Content-type: application/json
{
"CreationTime": number,
"ReportPlanArn": "string",
"ReportPlanName": "string"
}Elementos de respuesta
Si la acción se realiza correctamente, el servicio devuelve una respuesta HTTP 200.
El servicio devuelve los datos siguientes en formato JSON.
- CreationTime
-
La fecha y la hora en que se creó la lista de dominios, en formato Unix y horario universal coordinado (UTC). El valor de
CreationTimetiene una precisión de milisegundos. Por ejemplo, el valor 1516925490.087 representa el viernes 26 de enero de 2018 a las 12:11:30.087 h.Tipo: marca temporal
- ReportPlanArn
-
Un nombre de recurso de Amazon (ARN) que identifica de forma exclusiva un recurso. El formato del ARN depende del tipo de recurso.
Tipo: cadena
- ReportPlanName
-
El nombre único del plan de informes.
Tipo: cadena
Limitaciones de longitud: longitud mínima de 1. La longitud máxima es de 256 caracteres.
Patrón:
[a-zA-Z][_a-zA-Z0-9]*
Errores
Para obtener información acerca de los errores comunes a todas las acciones, consulte Errores comunes.
- AlreadyExistsException
-
El recurso ya existe.
Código de estado HTTP: 400
- InvalidParameterValueException
-
Indica que hay algún problema con el valor de un parámetro. Por ejemplo, el valor está fuera del rango.
Código de estado HTTP: 400
- LimitExceededException
-
Se ha superado un límite en la solicitud; por ejemplo, el número máximo de elementos permitidos en una solicitud.
Código de estado HTTP: 400
- MissingParameterValueException
-
Indica que falta un parámetro obligatorio.
Código de estado HTTP: 400
- ServiceUnavailableException
-
La solicitud no se ha ejecutado correctamente debido a un error temporal del servidor.
Código de estado HTTP: 500
Véase también
Para obtener más información sobre el uso de esta API en un SDK de AWS de un idioma específico, consulte:
