DescribeFramework - AWS Backup
AnforderungssyntaxURI-AnfrageparameterAnforderungstextAntwortsyntaxAntwortelementeFehlerWeitere Informationen finden Sie unter:

Die vorliegende Übersetzung wurde maschinell erstellt. Im Falle eines Konflikts oder eines Widerspruchs zwischen dieser übersetzten Fassung und der englischen Fassung (einschließlich infolge von Verzögerungen bei der Übersetzung) ist die englische Fassung maßgeblich.

DescribeFramework

Gibt Framwork-Details für die angegebene FrameworkName zurück.

Anforderungssyntax

GET /audit/frameworks/frameworkName HTTP/1.1

URI-Anfrageparameter

Die Anforderung verwendet die folgenden URI-Parameter.

frameworkName

Der eindeutige Name eines Frameworks.

Längenbeschränkungen: Minimale Länge beträgt 1 Zeichen. Maximale Länge beträgt 256 Zeichen.

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

Erforderlich: Ja

Anforderungstext

Der Anforderung besitzt keinen Anforderungstext.

Antwortsyntax

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"
}

Antwortelemente

Wenn die Aktion erfolgreich ist, sendet der Service eine HTTP 200-Antwort zurück.

Die folgenden Daten werden vom Service im JSON-Format zurückgegeben.

CreationTime

Das Datum und die Uhrzeit, zu der ein Framework erstellt wurde, in ISO 8601-Darstellung. Der Wert von CreationTime ist auf Millisekunden genau. Beispielsweise steht 2020-07-10T 15:00:00.000-08:00 für den 10. Juli 2020 um 15.00 Uhr, UTC minus 8 Stunden.

Typ: Zeitstempel

DeploymentStatus

Der Bereitstellungsstatus eines Frameworks. Die Status sind:

CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | COMPLETED | FAILED

Typ: Zeichenfolge

FrameworkArn

Ein Amazon-Ressourcenname (ARN), der eine Ressource eindeutig identifiziert. Das Format eines ARN hängt vom Ressourcentyp ab.

Typ: Zeichenfolge

FrameworkControls

Die Kontrollen, aus denen das Framework besteht. Jedes Steuerelement in der Liste hat einen Namen, Eingabeparameter und einen Bereich.

Typ: Array von FrameworkControl-Objekten

FrameworkDescription

Eine optionale Beschreibung des Frameworks.

Typ: Zeichenfolge

Längenbeschränkungen: Minimale Länge von 0. Maximale Länge beträgt 1024 Zeichen.

Pattern: .*\S.*

FrameworkName

Der eindeutige Name eines Frameworks.

Typ: Zeichenfolge

Längenbeschränkungen: Minimale Länge beträgt 1 Zeichen. Maximale Länge beträgt 256 Zeichen.

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

FrameworkStatus

Ein Framework besteht aus einem oder mehreren Steuerelementen. Jede Steuerung regelt eine Ressource, z. B. Backup-Pläne, Backup-Auswahlen, Backup-Tresore oder Wiederherstellungspunkte. Sie können die AWS Config -Aufzeichnung auch für jede Ressource ein- oder ausschalten. Die Status sind:

  • ACTIVE, wenn die Aufzeichnung für alle Ressourcen, die das Framework regelt, aktiviert ist.

  • PARTIALLY_ACTIVE, wenn die Aufzeichnung für mindestens eine Ressource, die das Framework regelt, deaktiviert ist.

  • INACTIVE, wenn die Aufzeichnung für alle Ressourcen, die das Framework regelt, deaktiviert ist.

  • UNAVAILABLEwenn AWS Backup der Aufnahmestatus derzeit nicht validiert werden kann.

Typ: Zeichenfolge

IdempotencyToken

Eine vom Kunden gewählte Zeichenfolge, mit der Sie zwischen ansonsten identischen Aufrufen an DescribeFrameworkOutput unterscheiden können. Der erneute Versuch einer erfolgreichen Anforderung mit demselben Idempotenz-Token führt zu einer Erfolgsmeldung, ohne dass Maßnahmen ergriffen werden.

Typ: Zeichenfolge

Fehler

Weitere Informationen zu den allgemeinen Fehlern, die bei allen Aktionen zurückgegeben werden, finden Sie unter Häufige Fehler.

InvalidParameterValueException

Zeigt an, dass etwas mit dem Wert eines Parameters nicht stimmt. Beispielsweise liegt der Wert außerhalb des zulässigen Bereichs.

HTTP Status Code: 400

MissingParameterValueException

Zeigt an, dass ein erforderlicher Parameter fehlt.

HTTP Status Code: 400

ResourceNotFoundException

Eine Ressource, die für die Aktion erforderlich ist, ist nicht vorhanden.

HTTP Status Code: 400

ServiceUnavailableException

Die Anforderung ist aufgrund eines temporären Fehlers des Servers fehlgeschlagen.

HTTP Status Code: 500

Weitere Informationen finden Sie unter:

Weitere Informationen zur Verwendung dieser API in einem der sprachspezifischen AWS SDKs finden Sie im Folgenden: