DescribeAgreement - AWS Transfer Family
AnforderungssyntaxAnforderungsparameterAntwortsyntaxAntwortelementeFehlerWeitere 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.

DescribeAgreement

Beschreibt die Vereinbarung, die durch den identifiziert wirdAgreementId.

Anforderungssyntax

{
   "AgreementId": "string",
   "ServerId": "string"
}

Anforderungsparameter

Informationen zu den Parametern, die alle Aktionen gemeinsam haben, finden Sie unter Allgemeine Parameter.

Die Anfrage akzeptiert die folgenden Daten im JSON Format.

AgreementId

Eine eindeutige Kennung für die Vereinbarung. Diese Kennung wird zurückgegeben, wenn Sie eine Vereinbarung erstellen.

Typ: Zeichenfolge

Längenbeschränkungen: Feste Länge von 19.

Pattern: a-([0-9a-f]{17})

Erforderlich: Ja

ServerId

Die Server-ID, die der Vereinbarung zugeordnet ist.

Typ: Zeichenfolge

Längenbeschränkungen: Feste Länge von 19.

Pattern: s-([0-9a-f]{17})

Erforderlich: Ja

Antwortsyntax

{
   "Agreement": { 
      "AccessRole": "string",
      "AgreementId": "string",
      "Arn": "string",
      "BaseDirectory": "string",
      "Description": "string",
      "LocalProfileId": "string",
      "PartnerProfileId": "string",
      "ServerId": "string",
      "Status": "string",
      "Tags": [ 
         { 
            "Key": "string",
            "Value": "string"
         }
      ]
   }
}

Antwortelemente

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

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

Agreement

Die Details für die angegebene Vereinbarung, die als DescribedAgreement Objekt zurückgegeben werden.

Typ: DescribedAgreement Objekt

Fehler

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

InternalServiceError

Diese Ausnahme wird ausgelöst, wenn im AWS Transfer Family Dienst ein Fehler auftritt.

HTTPStatuscode: 500

InvalidRequestException

Diese Ausnahme wird ausgelöst, wenn der Client eine falsch formatierte Anfrage sendet.

HTTPStatuscode: 400

ResourceNotFoundException

Diese Ausnahme wird ausgelöst, wenn eine Ressource vom AWS Transfer Family Family-Dienst nicht gefunden wird.

HTTPStatuscode: 400

ServiceUnavailableException

Die Anfrage ist fehlgeschlagen, da der AWS Transfer Family Family-Dienst nicht verfügbar ist.

HTTPStatuscode: 500

Weitere Informationen finden Sie unter:

Weitere Informationen zur Verwendung API in einer der sprachspezifischen Sprachen AWS SDKs finden Sie im Folgenden: