DescribeFramework - AWS Backup
Sintassi della richiestaURIParametri di richiestaCorpo della richiestaSintassi della rispostaElementi di rispostaErroriVedi anche

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

Restituisce i dettagli del framework per il FrameworkName specificato.

Sintassi della richiesta

GET /audit/frameworks/frameworkName HTTP/1.1

URIParametri di richiesta

La richiesta utilizza i seguenti URI parametri.

frameworkName

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]*

Campo obbligatorio: sì

Corpo della richiesta

La richiesta non ha un corpo della richiesta.

Sintassi della risposta

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

Se l'azione ha esito positivo, il servizio restituisce una risposta di HTTP 200.

I seguenti dati vengono restituiti in JSON formato dal servizio.

CreationTime

La data e l'ora di creazione di un framework, nella rappresentazione ISO 8601. Il valore di CreationTime è preciso al millisecondo. Ad esempio, 2020-07-10T 15:00:00.000-08:00 rappresenta il 10 luglio 2020 alle 15:00 con 8 ore di ritardo. UTC

Tipo: Timestamp

DeploymentStatus

Lo stato di implementazione di un framework. Gli stati sono:

CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | COMPLETED | FAILED

Tipo: stringa

FrameworkArn

Un Amazon Resource Name (ARN) che identifica in modo univoco una risorsa. Il formato di ARN dipende dal tipo di risorsa.

Tipo: stringa

FrameworkControls

I controlli che compongono il framework. Ogni controllo nell'elenco dispone di nome, parametri di input e ambito.

Tipo: matrice di oggetti FrameworkControl

FrameworkDescription

Una descrizione facoltativa del framework.

Tipo: stringa

Limitazioni di lunghezza: lunghezza minima di 0. La lunghezza massima è 1024 caratteri.

Modello: .*\S.*

FrameworkName

Il nome univoco di un framework.

Tipo: stringa

Limitazioni di lunghezza: lunghezza minima pari a 1. La lunghezza massima è 256 caratteri.

Modello: [a-zA-Z][_a-zA-Z0-9]*

FrameworkStatus

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.

  • UNAVAILABLEquando non AWS Backup è in grado di convalidare lo stato della registrazione in questo momento.

Tipo: stringa

IdempotencyToken

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: stringa

Errori

Per informazioni sugli errori comuni a tutte le operazioni, consultare Errori comuni.

InvalidParameterValueException

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

HTTPCodice di stato: 400

MissingParameterValueException

Indica che manca un parametro obbligatorio.

HTTPCodice di stato: 400

ResourceNotFoundException

Una risorsa necessaria per l'azione non esiste.

HTTPCodice di stato: 400

ServiceUnavailableException

La richiesta non è riuscita a causa di un errore temporaneo del server.

HTTPCodice di stato: 500

Vedi anche

Per ulteriori informazioni sull'utilizzo API in una delle lingue specifiche AWS SDKs, consulta quanto segue: