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.
CreateFramework
Crée un cadre avec un ou plusieurs contrôles. Un cadre est un ensemble de contrôles que vous pouvez utiliser pour évaluer vos pratiques de sauvegarde. En utilisant des contrôles personnalisables prédéfinis pour définir vos politiques, vous pouvez évaluer si vos pratiques de sauvegarde sont conformes à vos politiques et quelles ressources ne le sont pas encore.
Syntaxe de la demande
POST /audit/frameworks HTTP/1.1
Content-type: application/json
{
"FrameworkControls": [
{
"ControlInputParameters": [
{
"ParameterName": "string",
"ParameterValue": "string"
}
],
"ControlName": "string",
"ControlScope": {
"ComplianceResourceIds": [ "string" ],
"ComplianceResourceTypes": [ "string" ],
"Tags": {
"string" : "string"
}
}
}
],
"FrameworkDescription": "string",
"FrameworkName": "string",
"FrameworkTags": {
"string" : "string"
},
"IdempotencyToken": "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.
- FrameworkControls
-
Liste des contrôles qui constituent le framework. Chaque contrôle de la liste possède un nom, des paramètres d'entrée et une portée.
Type : tableau d’objets FrameworkControl
Obligatoire : oui
- FrameworkDescription
-
Une description facultative du framework avec 1 024 caractères au maximum.
Type : chaîne
Contraintes de longueur : longueur minimum de 0. Longueur maximum de 1024.
Modèle :
.*\S.*Obligatoire : non
- FrameworkName
-
Le nom unique du framework. 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 : chaîne
Contraintes de longueur : longueur minimum de 1. Longueur maximum de 256.
Modèle :
[a-zA-Z][_a-zA-Z0-9]*Obligatoire : oui
- FrameworkTags
-
Métadonnées que vous pouvez attribuer pour vous aider à organiser les frameworks que vous créez. Chaque balise est une paire clés-valeurs.
Type : mappage chaîne/chaîne
Obligatoire : non
- IdempotencyToken
-
Chaîne choisie par le client que vous pouvez utiliser pour faire la distinction entre des appels par ailleurs identiques à
CreateFrameworkInput. 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
Syntaxe de la réponse
HTTP/1.1 200
Content-type: application/json
{
"FrameworkArn": "string",
"FrameworkName": "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.
- FrameworkArn
-
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 : chaîne
- FrameworkName
-
Le nom unique du framework. 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 : chaîne
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 kits SDK AWS spécifiques au langage, consultez les ressources suivantes :
