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
<a name="API_DescribeFramework"></a>

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

## Syntaxe de la demande
<a name="API_DescribeFramework_RequestSyntax"></a>

```
GET /audit/frameworks/frameworkName HTTP/1.1
```

## Paramètres de demande URI
<a name="API_DescribeFramework_RequestParameters"></a>

La demande utilise les paramètres URI suivants.

 ** [frameworkName](#API_DescribeFramework_RequestSyntax) **   <a name="Backup-DescribeFramework-request-uri-FrameworkName"></a>
Le nom unique d'un cadre.  
Contraintes de longueur : longueur minimale de 1 caractère. Longueur maximum de 256.  
Modèle : `[a-zA-Z][_a-zA-Z0-9]*`   
Obligatoire : oui

## Corps de la demande
<a name="API_DescribeFramework_RequestBody"></a>

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

## Syntaxe de la réponse
<a name="API_DescribeFramework_ResponseSyntax"></a>

```
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
<a name="API_DescribeFramework_ResponseElements"></a>

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](#API_DescribeFramework_ResponseSyntax) **   <a name="Backup-DescribeFramework-response-CreationTime"></a>
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](#API_DescribeFramework_ResponseSyntax) **   <a name="Backup-DescribeFramework-response-DeploymentStatus"></a>
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](#API_DescribeFramework_ResponseSyntax) **   <a name="Backup-DescribeFramework-response-FrameworkArn"></a>
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](#API_DescribeFramework_ResponseSyntax) **   <a name="Backup-DescribeFramework-response-FrameworkControls"></a>
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](API_FrameworkControl.md)

 ** [FrameworkDescription](#API_DescribeFramework_ResponseSyntax) **   <a name="Backup-DescribeFramework-response-FrameworkDescription"></a>
Description facultative du framework.  
Type : Chaîne  
Contraintes de longueur : longueur minimum de 0. Longueur maximum de 1024.  
Modèle : `.*\S.*` 

 ** [FrameworkName](#API_DescribeFramework_ResponseSyntax) **   <a name="Backup-DescribeFramework-response-FrameworkName"></a>
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](#API_DescribeFramework_ResponseSyntax) **   <a name="Backup-DescribeFramework-response-FrameworkStatus"></a>
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.
+  `UNAVAILABLE`lorsqu'il n' AWS Backup est pas en mesure de valider le statut de l'enregistrement pour le moment.
Type : Chaîne

 ** [IdempotencyToken](#API_DescribeFramework_ResponseSyntax) **   <a name="Backup-DescribeFramework-response-IdempotencyToken"></a>
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
<a name="API_DescribeFramework_Errors"></a>

Pour plus d'informations sur les erreurs courantes pour toutes les actions, consultez [Types d'erreurs courants](CommonErrors.md).

 ** InvalidParameterValueException **   
Indique une erreur avec la valeur d'un paramètre. Par exemple, la valeur est hors de portée.    
 ** Context **   
  
 ** Type **   

Code d’état HTTP : 400

 ** MissingParameterValueException **   
Indique qu'un paramètre obligatoire est manquant.    
 ** Context **   
  
 ** Type **   

Code d’état HTTP : 400

 ** ResourceNotFoundException **   
Aucune ressource requise pour l'action n'existe.    
 ** Context **   
  
 ** Type **   

Code d’état HTTP : 400

 ** ServiceUnavailableException **   
La demande a échoué en raison d'une défaillance temporaire du serveur.    
 ** Context **   
  
 ** Type **   

Code d’état HTTP : 500

## Voir aussi
<a name="API_DescribeFramework_SeeAlso"></a>

Pour plus d'informations sur l'utilisation de cette API dans l'un des langages spécifiques AWS SDKs, consultez ce qui suit :
+  [AWS Interface de ligne de commande V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/DescribeFramework) 
+  [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/DescribeFramework) 
+  [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/DescribeFramework) 
+  [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/DescribeFramework) 
+  [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/DescribeFramework) 
+  [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/DescribeFramework) 
+  [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/DescribeFramework) 
+  [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/DescribeFramework) 
+  [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/DescribeFramework) 
+  [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/DescribeFramework)