Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.
Crée un plan de rapport. Un plan de rapport est un document qui contient des informations sur le contenu du rapport et sur l'endroit où il AWS Backup sera livré.
Si vous appelez CreateReportPlan avec un plan qui existe déjà, vous recevez une exception AlreadyExistsException.
Syntaxe de la demande
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"
}
}Paramètres de demande URI
La demande n’utilise pas de paramètres URI.
Corps de la demande
Cette demande accepte les données suivantes au format JSON.
- IdempotencyToken
-
Chaîne choisie par le client que vous pouvez utiliser pour faire la distinction entre des appels par ailleurs identiques à
CreateReportPlanInput. Toute nouvelle tentative d'une demande réussie avec le même jeton d'idempotence entraîne un message de réussite sans qu'aucune action ne soit entreprise.Type : chaîne
Obligatoire : non
- ReportDeliveryChannel
-
Une structure qui contient des informations sur où et comment livrer vos rapports, en particulier le nom de votre compartiment Amazon S3, le préfixe de clé S3 et les formats de vos rapports.
Type : objet ReportDeliveryChannel
Obligatoire : oui
- ReportPlanDescription
-
Une description facultative du plan de rapport avec 1 024 caractères au maximum.
Type : String
Contraintes de longueur : longueur minimum de 0. Longueur maximum de 1024.
Modèle :
.*\S.*Obligatoire : non
- ReportPlanName
-
Le nom unique du plan de rapport. Ce nom doit contenir entre 1 et 256 caractères, commence par une lettre et est composé de lettres (a à z, A à Z), de chiffres (0 à 9) et de traits de soulignement (_).
Type : String
Contraintes de longueur : longueur minimum de 1. Longueur maximum de 256.
Modèle :
[a-zA-Z][_a-zA-Z0-9]*Obligatoire : oui
- ReportPlanTags
-
Les balises à attribuer au plan de rapport.
Type : mappage chaîne/chaîne
Obligatoire : non
- ReportSetting
-
Identifie le modèle de rapport pour le rapport. Les rapports sont créés à l'aide d'un modèle de rapport. Les modèles de rapport sont les suivants :
RESOURCE_COMPLIANCE_REPORT | CONTROL_COMPLIANCE_REPORT | BACKUP_JOB_REPORT | COPY_JOB_REPORT | RESTORE_JOB_REPORTSi le modèle de rapport est
RESOURCE_COMPLIANCE_REPORTouCONTROL_COMPLIANCE_REPORT, cette ressource d'API décrit également la couverture du rapport par Régions AWS et les frameworks.Type : objet ReportSetting
Obligatoire : oui
Syntaxe de la réponse
HTTP/1.1 200
Content-type: application/json
{
"CreationTime": number,
"ReportPlanArn": "string",
"ReportPlanName": "string"
}Eléments de réponse
Si l’action aboutit, le service renvoie une réponse HTTP 200.
Les données suivantes sont renvoyées au format JSON par le service.
- CreationTime
-
Date et heure de création d'un coffre-fort de sauvegarde, au format Unix et au format UTC (temps universel coordonné). La valeur de
CreationTimeest précise en millisecondes. Par exemple, la valeur 1516925490,087 représente le vendredi 26 janvier 2018 à 00 h 11 m 30,087 s.Type : Timestamp
- ReportPlanArn
-
Un Amazon Resource Name (ARN) qui identifie de façon unique une ressource. Le format de l'ARN dépend du type de ressource.
Type : String
- ReportPlanName
-
Le nom unique du plan de rapport.
Type : String
Contraintes de longueur : longueur minimum de 1. Longueur maximum de 256.
Modèle :
[a-zA-Z][_a-zA-Z0-9]*
Erreurs
Pour plus d'informations sur les erreurs courantes pour toutes les actions, consultez Erreurs courantes.
- AlreadyExistsException
-
La ressource demandée existe déjà.
Code d’état HTTP : 400
- InvalidParameterValueException
-
Indique une erreur avec la valeur d'un paramètre. Par exemple, la valeur est hors de portée.
Code d’état HTTP : 400
- LimitExceededException
-
Une limite de la demande a été dépassée ; par exemple, le nombre maximum d'éléments autorisés dans une demande.
Code d’état HTTP : 400
- MissingParameterValueException
-
Indique qu'un paramètre obligatoire est manquant.
Code d’état HTTP : 400
- ServiceUnavailableException
-
La demande a échoué en raison d'une défaillance temporaire du serveur.
Code d’état HTTP : 500
consultez aussi
Pour plus d'informations sur l'utilisation de cette API dans l'un des langages spécifiques AWS SDKs, consultez ce qui suit :
