

Le traduzioni sono generate tramite traduzione automatica. In caso di conflitto tra il contenuto di una traduzione e la versione originale in Inglese, quest'ultima prevarrà.

# DescribeFramework
<a name="API_DescribeFramework"></a>

Restituisce i dettagli del framework per il `FrameworkName` specificato.

## Sintassi della richiesta
<a name="API_DescribeFramework_RequestSyntax"></a>

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

## Parametri della richiesta URI
<a name="API_DescribeFramework_RequestParameters"></a>

La richiesta utilizza i seguenti parametri URI.

 ** [frameworkName](#API_DescribeFramework_RequestSyntax) **   <a name="Backup-DescribeFramework-request-uri-FrameworkName"></a>
Il nome univoco di un framework.  
Limitazioni di lunghezza: lunghezza minima pari a 1. La lunghezza massima è 256 caratteri.  
Modello: `[a-zA-Z][_a-zA-Z0-9]*`   
Obbligatorio: sì

## Corpo della richiesta
<a name="API_DescribeFramework_RequestBody"></a>

La richiesta non ha un corpo della richiesta.

## Sintassi della risposta
<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"
}
```

## Elementi di risposta
<a name="API_DescribeFramework_ResponseElements"></a>

Se l'operazione riesce, il servizio restituisce una risposta HTTP 200.

I dati seguenti vengono restituiti in formato JSON mediante il servizio.

 ** [CreationTime](#API_DescribeFramework_ResponseSyntax) **   <a name="Backup-DescribeFramework-response-CreationTime"></a>
La data e l'ora di creazione del framework, nella rappresentazione ISO 8601. Il valore di `CreationTime` è preciso al millisecondo. Ad esempio, 2020-07-10T15:00:00.000-08:00 rappresenta il 10 luglio 2020 alle 15:00 8 ore indietro rispetto all'UTC.  
Tipo: Timestamp

 ** [DeploymentStatus](#API_DescribeFramework_ResponseSyntax) **   <a name="Backup-DescribeFramework-response-DeploymentStatus"></a>
Lo stato di implementazione di un framework. Gli stati sono:  
 `CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | COMPLETED | FAILED`   
Tipo: String

 ** [FrameworkArn](#API_DescribeFramework_ResponseSyntax) **   <a name="Backup-DescribeFramework-response-FrameworkArn"></a>
Un nome della risorsa Amazon (ARN) che identifica in modo univoco una risorsa. Il formato dell'ARN dipende dal tipo di risorsa.  
Tipo: String

 ** [FrameworkControls](#API_DescribeFramework_ResponseSyntax) **   <a name="Backup-DescribeFramework-response-FrameworkControls"></a>
I controlli che compongono il framework. Ogni controllo nell'elenco dispone di nome, parametri di input e ambito.  
Tipo: matrice di oggetti [FrameworkControl](API_FrameworkControl.md)

 ** [FrameworkDescription](#API_DescribeFramework_ResponseSyntax) **   <a name="Backup-DescribeFramework-response-FrameworkDescription"></a>
Una descrizione facoltativa del framework.  
Tipo: String  
Limitazioni di lunghezza: lunghezza minima di 0. La lunghezza massima è 1024 caratteri.  
Modello: `.*\S.*` 

 ** [FrameworkName](#API_DescribeFramework_ResponseSyntax) **   <a name="Backup-DescribeFramework-response-FrameworkName"></a>
Il nome univoco di un framework.  
Tipo: String  
Limitazioni di lunghezza: lunghezza minima pari a 1. La lunghezza massima è 256 caratteri.  
Modello: `[a-zA-Z][_a-zA-Z0-9]*` 

 ** [FrameworkStatus](#API_DescribeFramework_ResponseSyntax) **   <a name="Backup-DescribeFramework-response-FrameworkStatus"></a>
Un framework consiste in uno o più controlli. Ogni controllo regola una risorsa, ad esempio piani di backup, selezioni di backup, vault di backup o punti di ripristino. È inoltre possibile attivare o disattivare la registrazione AWS Config per ciascuna risorsa. Gli stati sono:  
+  `ACTIVE` quando la registrazione è attivata per tutte le risorse amministrate dal framework.
+  `PARTIALLY_ACTIVE` quando la registrazione è disattivata per almeno una risorsa amministrata dal framework.
+  `INACTIVE` quando la registrazione è disattivata per tutte le risorse amministrate dal framework.
+  `UNAVAILABLE`quando non AWS Backup è in grado di convalidare lo stato della registrazione in questo momento.
Tipo: String

 ** [IdempotencyToken](#API_DescribeFramework_ResponseSyntax) **   <a name="Backup-DescribeFramework-response-IdempotencyToken"></a>
Una stringa scelta dal cliente che puoi usare per distinguere tra chiamate altrimenti identiche a `DescribeFrameworkOutput`. Riprovare una richiesta riuscita con lo stesso token di idempotenza restituisce un messaggio di completamento senza alcuna azione eseguita.  
Tipo: String

## Errori
<a name="API_DescribeFramework_Errors"></a>

Per informazioni sugli errori comuni a tutte le operazioni, consultare [Tipi di errore comuni](CommonErrors.md).

 ** InvalidParameterValueException **   
Indica che si è verificato un errore con il valore di un parametro. Ad esempio, il valore non è compreso nell'intervallo.    
 ** Context **   
  
 ** Type **   

Codice di stato HTTP: 400

 ** MissingParameterValueException **   
Indica che manca un parametro obbligatorio.    
 ** Context **   
  
 ** Type **   

Codice di stato HTTP: 400

 ** ResourceNotFoundException **   
Una risorsa necessaria per l'azione non esiste.    
 ** Context **   
  
 ** Type **   

Codice di stato HTTP: 400

 ** ServiceUnavailableException **   
La richiesta non è riuscita a causa di un errore temporaneo del server.    
 ** Context **   
  
 ** Type **   

Codice di stato HTTP: 500

## Vedi anche
<a name="API_DescribeFramework_SeeAlso"></a>

Per ulteriori informazioni sull'utilizzo di questa API in una delle lingue specifiche AWS SDKs, consulta quanto segue:
+  [AWS Interfaccia a riga di comando V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/DescribeFramework) 
+  [AWS SDK per.NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/DescribeFramework) 
+  [AWS SDK per C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/DescribeFramework) 
+  [AWS SDK per Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/DescribeFramework) 
+  [AWS SDK per Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/DescribeFramework) 
+  [AWS SDK per V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/DescribeFramework) 
+  [AWS SDK per Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/DescribeFramework) 
+  [AWS SDK per PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/DescribeFramework) 
+  [AWS SDK per Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/DescribeFramework) 
+  [AWS SDK per Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/DescribeFramework) 