DescribeFramework - AWS Backup
Syntaxe de la demandeParamètres de demande URICorps de la demandeSyntaxe de la réponseEléments de réponseErreursconsultez aussi

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.

DescribeFramework

Renvoie les détails du framework pour le paramètre FrameworkName spécifié.

Syntaxe de la demande

GET /audit/frameworks/frameworkName HTTP/1.1

Paramètres de demande URI

La demande utilise les paramètres URI suivants.

frameworkName

Le nom unique d'un cadre.

Contraintes de longueur : longueur minimum de 1. Longueur maximum de 256.

Modèle : [a-zA-Z][_a-zA-Z0-9]*

Obligatoire : oui

Corps de la demande

La demande n’a pas de corps de requête.

Syntaxe de la réponse

HTTP/1.1 200
Content-type: application/json

{
   "CreationTime": number,
   "DeploymentStatus": "string",
   "FrameworkArn": "string",
   "FrameworkControls": [ 
      { 
         "ControlInputParameters": [ 
            { 
               "ParameterName": "string",
               "ParameterValue": "string"
            }
         ],
         "ControlName": "string",
         "ControlScope": { 
            "ComplianceResourceIds": [ "string" ],
            "ComplianceResourceTypes": [ "string" ],
            "Tags": { 
               "string" : "string" 
            }
         }
      }
   ],
   "FrameworkDescription": "string",
   "FrameworkName": "string",
   "FrameworkStatus": "string",
   "IdempotencyToken": "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 framework, dans une représentation ISO 8601. La valeur de CreationTime est précise en millisecondes. Par exemple, 2020-07-10T15:00:00.000-08:00 représente le 10 juillet 2020 à 15 h 00 avec 8 heures de retard sur le temps UTC.

Type : Timestamp

DeploymentStatus

Le statut du déploiement d'un framework. Les statuts sont les suivants :

CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | COMPLETED | FAILED

Type : chaîne

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

FrameworkControls

Les contrôles qui constituent le cadre. 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

FrameworkDescription

Description facultative du framework.

Type : chaîne

Contraintes de longueur : longueur minimum de 0. Longueur maximum de 1024.

Modèle : .*\S.*

FrameworkName

Le nom unique d'un cadre.

Type : chaîne

Contraintes de longueur : longueur minimum de 1. Longueur maximum de 256.

Modèle : [a-zA-Z][_a-zA-Z0-9]*

FrameworkStatus

Un cadre est constitué d'un ou plusieurs contrôles. Chaque contrôle régit une ressource, telle que les plans de sauvegarde, les sélections de sauvegarde, les coffres-forts de sauvegarde ou les points de récupération. Vous pouvez également activer ou désactiver AWS Config l'enregistrement pour chaque ressource. Les statuts sont les suivants :

  • ACTIVE lorsque l'enregistrement est activé pour toutes les ressources que le framework gouverne.

  • PARTIALLY_ACTIVE lorsque l'enregistrement est désactivé pour au moins une ressource que le framework gouverne.

  • INACTIVE lorsque l'enregistrement est désactivé pour toutes les ressources que le framework gouverne.

  • UNAVAILABLElorsqu'il n' AWS Backup est pas en mesure de valider le statut de l'enregistrement pour le moment.

Type : chaîne

IdempotencyToken

Chaîne choisie par le client que vous pouvez utiliser pour faire la distinction entre des appels par ailleurs identiques à DescribeFrameworkOutput. 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

Erreurs

Pour plus d'informations sur les erreurs courantes pour toutes les actions, consultez Erreurs courantes.

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

MissingParameterValueException

Indique qu'un paramètre obligatoire est manquant.

Code d’état HTTP : 400

ResourceNotFoundException

Aucune ressource requise pour l'action n'existe.

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 AWS SDK spécifiques au langage, consultez les pages suivantes :