URI HTTP-Methoden Schemata Eigenschaften Weitere Informationen finden Sie auch unter

Anwendungen

URI

/applications

HTTP-Methoden

GET

Vorgangs-ID: ListApplications

Listet Anwendungen im Besitz des Auftraggebers auf

Abfrageparameter
Name	Typ	Erforderlich	Beschreibung
`maxItems`	Zeichenfolge	Falsch	Die Gesamtzahl der zurückzugebenden Artikel.
`nextToken`	Zeichenfolge	Falsch	Ein Token für den Beginn der Seitennummerierung.

Antworten
Statuscode	Antwortmodell	Description
`200`	`ApplicationPage`	Herzlichen Glückwunsch
`400`	`BadRequestException`	Einer der Parameter der Anfrage ist ungültig.
`403`	`ForbiddenException`	Der Client ist nicht authentifiziert.
`404`	`NotFoundException`	Die in der Anforderung angegebene Ressource (z. B. eine Zugriffsrichtlinien-Anweisung) ist nicht vorhanden.
`500`	`InternalServerErrorException`	Beim AWS Serverless Application Repository Dienst ist ein interner Fehler aufgetreten.

POST

Vorgangs-ID: CreateApplication

Erstellt eine Anwendung, optional einschließlich einer AWS SAM-Datei, um die erste Anwendungsversion im selben Aufruf zu erstellen.

Antworten
Statuscode	Antwortmodell	Description
`201`	`Application`	Herzlichen Glückwunsch
`400`	`BadRequestException`	Einer der Parameter der Anfrage ist ungültig.
`403`	`ForbiddenException`	Der Client ist nicht authentifiziert.
`409`	`ConflictException`	Die Ressource ist bereits vorhanden.
`429`	`TooManyRequestsException`	Der Client sendet mehr als die zulässige Anzahl von Anfragen pro Zeiteinheit.
`500`	`InternalServerErrorException`	Beim AWS Serverless Application Repository Dienst ist ein interner Fehler aufgetreten.

OPTIONS

Antworten
Statuscode	Antwortmodell	Description
`200`	Keine	200 Antwort

Schemata

Anfragetexte


{
  "name": "string",
  "description": "string",
  "author": "string",
  "spdxLicenseId": "string",
  "licenseBody": "string",
  "licenseUrl": "string",
  "readmeBody": "string",
  "readmeUrl": "string",
  "labels": [
    "string"
  ],
  "homePageUrl": "string",
  "semanticVersion": "string",
  "templateBody": "string",
  "templateUrl": "string",
  "sourceCodeUrl": "string",
  "sourceCodeArchiveUrl": "string"
}

Antworttexte


{
  "applications": [
    {
      "applicationId": "string",
      "name": "string",
      "description": "string",
      "author": "string",
      "spdxLicenseId": "string",
      "labels": [
        "string"
      ],
      "creationTime": "string",
      "homePageUrl": "string"
    }
  ],
  "nextToken": "string"
}


{
  "applicationId": "string",
  "name": "string",
  "description": "string",
  "author": "string",
  "isVerifiedAuthor": boolean,
  "verifiedAuthorUrl": "string",
  "spdxLicenseId": "string",
  "licenseUrl": "string",
  "readmeUrl": "string",
  "labels": [
    "string"
  ],
  "creationTime": "string",
  "homePageUrl": "string",
  "version": {
    "applicationId": "string",
    "semanticVersion": "string",
    "sourceCodeUrl": "string",
    "sourceCodeArchiveUrl": "string",
    "templateUrl": "string",
    "creationTime": "string",
    "parameterDefinitions": [
      {
        "name": "string",
        "defaultValue": "string",
        "description": "string",
        "type": "string",
        "noEcho": boolean,
        "allowedPattern": "string",
        "constraintDescription": "string",
        "minValue": integer,
        "maxValue": integer,
        "minLength": integer,
        "maxLength": integer,
        "allowedValues": [
          "string"
        ],
        "referencedByResources": [
          "string"
        ]
      }
    ],
    "requiredCapabilities": [
      enum
    ],
    "resourcesSupported": boolean
  }
}


{
  "message": "string",
  "errorCode": "string"
}


{
  "message": "string",
  "errorCode": "string"
}


{
  "message": "string",
  "errorCode": "string"
}


{
  "message": "string",
  "errorCode": "string"
}


{
  "message": "string",
  "errorCode": "string"
}


{
  "message": "string",
  "errorCode": "string"
}

Eigenschaften

Anwendung

Einzelheiten zur Anwendung.

Eigenschaft	Typ	Erforderlich	Beschreibung
`applicationId`	Zeichenfolge	Wahr	Der Amazon-Ressourcenname (ARN) der -Anwendung
`author`	Zeichenfolge	Wahr	Der Name des Autors, der die App veröffentlicht. Minimale Länge = 1. Maximale Länge = 127. Muster „^ [a-z0-9] (([a-z0-9] \|- (?! -)) * [a-z0-9])? $“;
`creationTime`	Zeichenfolge	Falsch	Datum und Uhrzeit der Erstellung dieser Ressource.
`description`	Zeichenfolge	Wahr	Die Beschreibung der Anwendung. Minimale Länge = 1. Maximale Länge = 256
`homePageUrl`	Zeichenfolge	Falsch	Eine URL mit weiteren Informationen über die Anwendung, zum Beispiel den Speicherort Ihres GitHub Repositorys für die Anwendung.
`isVerifiedAuthor`	boolesch	Falsch	Gibt an, ob der Autor dieser Anwendung verifiziert wurde. Dies bedeutet, AWS dass die vom Antragsteller bereitgestellten Informationen in gutem Glauben als vernünftiger und umsichtiger Dienstleister überprüft und bestätigt wurden, dass die Identität des Anfragenden den Angaben entspricht.
`labels`	Array vom Typ string	Falsch	Labels zur besseren Auffindbarkeit von Apps in den Suchergebnissen. Minimale Länge = 1. Maximale Länge = 127. Maximale Anzahl von Labels: 10 Muster: „^ [a-z A-Z0-9 +\\ -_:\\ /@] +$“;
`licenseUrl`	Zeichenfolge	Falsch	Ein Link zu einer Lizenzdatei der App, die dem spdxLicenseID-Wert Ihrer Anwendung entspricht. Maximale Größe 5 MB
`name`	Zeichenfolge	Wahr	Der Name der Anwendung. Minimale Länge = 1. Maximale Länge = 140 Muster: „[a-zA-Z0-9\\ -] +“;
`readmeUrl`	Zeichenfolge	Falsch	Ein Link zur Readme-Datei in Markdown-Sprache, die eine detailliertere Beschreibung der Anwendung und ihrer Funktionsweise enthält. Maximale Größe 5 MB
`spdxLicenseId`	Zeichenfolge	Falsch	Ein gültiger Bezeichner von https://spdx.org/licenses/.
`verifiedAuthorUrl`	Zeichenfolge	Falsch	Die URL zum öffentlichen Profil eines verifizierten Autors. Diese URL wurde vom Autor eingereicht.
`version`	Version	Falsch	Versionsinformationen zur Anwendung.

ApplicationPage

Eine Liste mit Anwendungsdetails.

Eigenschaft	Typ	Erforderlich	Description
`applications`	Array vom Typ ApplicationSummary	Wahr	Eine Reihe von Anwendungszusammenfassungen.
`nextToken`	Zeichenfolge	Falsch	Das Token zum Anfordern der nächsten Ergebnisseite.

ApplicationSummary

Zusammenfassung der Details zur Anwendung.

Eigenschaft	Typ	Erforderlich	Beschreibung
`applicationId`	Zeichenfolge	Wahr	Der Amazon-Ressourcenname (ARN) der -Anwendung
`author`	Zeichenfolge	Wahr	Der Name des Autors, der die App veröffentlicht. Minimale Länge = 1. Maximale Länge = 127. Muster „^ [a-z0-9] (([a-z0-9] \|- (?! -)) * [a-z0-9])? $“;
`creationTime`	Zeichenfolge	Falsch	Datum und Uhrzeit der Erstellung dieser Ressource.
`description`	Zeichenfolge	Wahr	Die Beschreibung der Anwendung. Minimale Länge = 1. Maximale Länge = 256
`homePageUrl`	Zeichenfolge	Falsch	Eine URL mit weiteren Informationen über die Anwendung, zum Beispiel den Speicherort Ihres GitHub Repositorys für die Anwendung.
`labels`	Array vom Typ string	Falsch	Labels zur besseren Auffindbarkeit von Apps in den Suchergebnissen. Minimale Länge = 1. Maximale Länge = 127. Maximale Anzahl von Labels: 10 Muster: „^ [a-z A-Z0-9 +\\ -_:\\ /@] +$“;
`name`	Zeichenfolge	Wahr	Der Name der Anwendung. Minimale Länge = 1. Maximale Länge = 140 Muster: „[a-zA-Z0-9\\ -] +“;
`spdxLicenseId`	Zeichenfolge	Falsch	Ein gültiger Bezeichner von https://spdx.org/licenses/.

BadRequestException

Einer der Parameter der Anfrage ist ungültig.

Eigenschaft	Typ	Erforderlich	Beschreibung
`errorCode`	Zeichenfolge	Falsch	400
`message`	Zeichenfolge	Falsch	Einer der Parameter der Anfrage ist ungültig.

Funktion

Werte, die für die Bereitstellung einiger Anwendungen angegeben werden müssen.

CAPABILITY_IAM
CAPABILITY_NAMED_IAM
CAPABILITY_AUTO_EXPAND
CAPABILITY_RESOURCE_POLICY

ConflictException

Die Ressource ist bereits vorhanden.

Eigenschaft	Typ	Erforderlich	Beschreibung
`errorCode`	Zeichenfolge	Falsch	409
`message`	Zeichenfolge	Falsch	Die Ressource ist bereits vorhanden.

CreateApplicationInput

Erstellen Sie eine Anwendungsanfrage.

Eigenschaft	Typ	Erforderlich	Beschreibung
`author`	Zeichenfolge	Wahr	Der Name des Autors, der die App veröffentlicht. Minimale Länge = 1. Maximale Länge = 127. Muster „^ [a-z0-9] (([a-z0-9] \|- (?! -)) * [a-z0-9])? $“;
`description`	Zeichenfolge	Wahr	Die Beschreibung der Anwendung. Minimale Länge = 1. Maximale Länge = 256
`homePageUrl`	Zeichenfolge	Falsch	Eine URL mit weiteren Informationen über die Anwendung, zum Beispiel den Speicherort Ihres GitHub Repositorys für die Anwendung.
`labels`	Array vom Typ string	Falsch	Labels zur besseren Auffindbarkeit von Apps in den Suchergebnissen. Minimale Länge = 1. Maximale Länge = 127. Maximale Anzahl von Labels: 10 Muster: „^ [a-z A-Z0-9 +\\ -_:\\ /@] +$“;
`licenseBody`	Zeichenfolge	Falsch	Eine lokale Textdatei, die die Lizenz der App enthält, die dem spdxLicenseID-Wert Ihrer Anwendung entspricht. Die Datei hat das Format. `file://<path>/<filename>` Maximale Größe 5 MB Sie können nur eine der Optionen `licenseBody` und angeben. `licenseUrl` Andernfalls tritt ein Fehler auf.
`licenseUrl`	Zeichenfolge	Falsch	Ein Link zum S3-Objekt, das die Lizenz der App enthält, die dem spdxLicenseID-Wert Ihrer Anwendung entspricht. Maximale Größe 5 MB Sie können nur eine der Optionen `licenseBody` und angeben. `licenseUrl` Andernfalls tritt ein Fehler auf.
`name`	Zeichenfolge	Wahr	Der Name der Anwendung, die Sie veröffentlichen möchten. Minimale Länge = 1. Maximale Länge = 140 Muster: „[a-zA-Z0-9\\ -] +“;
`readmeBody`	Zeichenfolge	Falsch	Eine lokale Text-Readme-Datei in Markdown-Sprache, die eine detailliertere Beschreibung der Anwendung und ihrer Funktionsweise enthält. Die Datei hat das Format. `file://<path>/<filename>` Maximale Größe 5 MB Sie können nur eine der Optionen `readmeBody` und angeben. `readmeUrl` Andernfalls tritt ein Fehler auf.
`readmeUrl`	Zeichenfolge	Falsch	Ein Link zum S3-Objekt in Markdown-Sprache, der eine detailliertere Beschreibung der Anwendung und ihrer Funktionsweise enthält. Maximale Größe 5 MB Sie können nur eine der Optionen `readmeBody` und angeben. `readmeUrl` Andernfalls tritt ein Fehler auf.
`semanticVersion`	Zeichenfolge	Falsch	Die semantische Version der Anwendung: https://semver.org/
`sourceCodeArchiveUrl`	Zeichenfolge	Falsch	Ein Link zum S3-Objekt, das das ZIP-Archiv des Quellcodes für diese Version Ihrer Anwendung enthält. Maximale Größe 50 MB
`sourceCodeUrl`	Zeichenfolge	Falsch	Ein Link zu einem öffentlichen Repository für den Quellcode Ihrer Anwendung, zum Beispiel die URL eines bestimmten GitHub Commits.
`spdxLicenseId`	Zeichenfolge	Falsch	Ein gültiger Bezeichner von https://spdx.org/licenses/.
`templateBody`	Zeichenfolge	Falsch	Die lokale gepackte AWS SAM Vorlagendatei Ihrer Anwendung. Die Datei hat das Format`file://<path>/<filename>`. Sie können nur eine der Optionen `templateBody` und angeben, `templateUrl` andernfalls wird ein Fehler ausgegeben.
`templateUrl`	Zeichenfolge	Falsch	Ein Link zum S3-Objekt, das die gepackte AWS SAM Vorlage Ihrer Anwendung enthält. Sie können nur eines von `templateBody` und angeben`templateUrl`; andernfalls tritt ein Fehler auf.

ForbiddenException

Der Client ist nicht authentifiziert.

Eigenschaft	Typ	Erforderlich	Beschreibung
`errorCode`	Zeichenfolge	Falsch	403
`message`	Zeichenfolge	Falsch	Der Client ist nicht authentifiziert.

InternalServerErrorException

Beim AWS Serverless Application Repository Dienst ist ein interner Fehler aufgetreten.

Eigenschaft	Typ	Erforderlich	Beschreibung
`errorCode`	Zeichenfolge	Falsch	500
`message`	Zeichenfolge	Falsch	Beim AWS Serverless Application Repository Dienst ist ein interner Fehler aufgetreten.

NotFoundException

Die in der Anforderung angegebene Ressource (z. B. eine Zugriffsrichtlinien-Anweisung) ist nicht vorhanden.

Eigenschaft	Typ	Erforderlich	Beschreibung
`errorCode`	Zeichenfolge	Falsch	404
`message`	Zeichenfolge	Falsch	Die in der Anforderung angegebene Ressource (z. B. eine Zugriffsrichtlinienanweisung) ist nicht vorhanden.

ParameterDefinition

Parameter, die von der Anwendung unterstützt werden.

Eigenschaft	Typ	Erforderlich	Beschreibung
`allowedPattern`	Zeichenfolge	Falsch	Gibt einen regulären Ausdruck an, der die zulässigen Muster für `String`-Typen beschreibt.
`allowedValues`	Array vom Typ string	Falsch	Gibt ein Array mit einer Liste der für den Parameter zulässigen Werte an.
`constraintDescription`	Zeichenfolge	Falsch	Gibt eine Zeichenfolge als Beschreibung für eine Einschränkung an. Diese Beschreibung wird bei Verstößen gegen die Einschränkung angezeigt. Für einen Parameter mit einem zulässigen Muster `[A-Za-z0-9]+` beispielsweise wird ohne Einschränkungsbeschreibung die folgende Fehlermeldung angezeigt, wenn der Benutzer einen ungültigen Wert angibt: `Malformed input-Parameter MyParameter must match pattern [A-Za-z0-9]+` Wenn Sie eine Beschreibung der Einschränkung hinzufügen, z. B. „darf nur Groß- und Kleinbuchstaben und Zahlen enthalten“, können Sie die folgende benutzerdefinierte Fehlermeldung anzeigen: `Malformed input-Parameter MyParameter must contain only uppercase and lowercase letters and numbers.`
`defaultValue`	Zeichenfolge	Falsch	Gibt einen Wert des entsprechenden Typs an, den die Vorlage nutzen soll, wenn zum Zeitpunkt der Stack-Erstellung kein Wert angegeben wird. Wenn Sie Einschränkungen für den Parameter definieren, müssen Sie einen Wert angeben, der diese Einschränkungen einhält.
`description`	Zeichenfolge	Falsch	Eine Zeichenfolge mit bis zu 4.000 Zeichen, die den Parameter beschreibt.
`maxLength`	Ganzzahl	Falsch	Ein Ganzzahlwert, der die größte Anzahl von Zeichen bestimmt, die Sie für `String` Typen zulassen möchten.
`maxValue`	Ganzzahl	Falsch	Ein numerischer Wert, der den größten numerischen Wert bestimmt, den Sie für `Number` Typen zulassen möchten.
`minLength`	Ganzzahl	Falsch	Ein Ganzzahlwert, der die kleinste Anzahl von Zeichen bestimmt, die Sie für `String` Typen zulassen möchten.
`minValue`	Ganzzahl	Falsch	Ein numerischer Wert, der den kleinsten numerischen Wert bestimmt, den Sie für `Number` Typen zulassen möchten.
`name`	Zeichenfolge	Wahr	Der Name des Parameters.
`noEcho`	boolesch	Falsch	Ob der Parameterwert maskiert werden soll, wenn jemand einen Aufruf tätigt, der den Stack beschreibt. Wenn Sie den Wert auf true setzen, wird der Parameterwert mit Sternchen (*****) maskiert.
`referencedByResources`	Array vom Typ string	Wahr	Eine Liste von AWS SAM Ressourcen, die diesen Parameter verwenden.
`type`	Zeichenfolge	Falsch	Der Typ des Parameters. Zulässige Werte: `String \| Number \| List<Number> \| CommaDelimitedList` `String`: Eine literale Zeichenfolge. Beispielsweise können Benutzer angeben`"MyUserName"`. `Number`: Eine Ganzzahl oder ein Gleitkommawert. CloudFormation validiert den Parameterwert als Zahl. Wenn Sie den Parameter jedoch an einer anderen Stelle in Ihrer Vorlage verwenden (z. B. mithilfe der `Ref` intrinsischen Funktion), wird der Parameterwert zu einer Zeichenfolge. Beispielsweise könnten Benutzer angeben. `"8888"` `List<Number>`: Ein Array von Ganzzahlen oder Gleitkommazahlen, die durch Kommas getrennt sind. CloudFormation validiert den Parameterwert als Zahlen. Wenn Sie den Parameter jedoch an anderer Stelle in Ihrer Vorlage verwenden (z. B. mithilfe der `Ref` intrinsischen Funktion), wird der Parameterwert zu einer Liste von Zeichenfolgen. Beispielsweise könnten Benutzer „80,20" angeben, und das Ergebnis lautet dann. `Ref` `["80","20"]` `CommaDelimitedList`: Ein Array von Literalzeichenfolgen, die durch Kommas getrennt sind. Die Gesamtanzahl von Zeichenfolgen sollte um 1 höher sein als die Gesamtanzahl von Kommas. Außerdem ist jede Elementzeichenfolge durch Leerzeichen getrennt. Beispielsweise könnten Benutzer „test, dev, prod“ angeben und dann die Ergebnisse wie folgt angeben. `Ref` `["test","dev","prod"]`

TooManyRequestsException

Der Client sendet mehr als die zulässige Anzahl von Anfragen pro Zeiteinheit.

Eigenschaft	Typ	Erforderlich	Beschreibung
`errorCode`	Zeichenfolge	Falsch	429
`message`	Zeichenfolge	Falsch	Der Client sendet mehr als die zulässige Anzahl von Anfragen pro Zeiteinheit.

Version

Details zur Version der Anwendung.

Eigenschaft	Typ	Erforderlich	Beschreibung
`applicationId`	Zeichenfolge	Wahr	Der Amazon-Ressourcenname (ARN) der -Anwendung
`creationTime`	Zeichenfolge	Wahr	Datum und Uhrzeit der Erstellung dieser Ressource.
`parameterDefinitions`	Array vom Typ ParameterDefinition	Wahr	Eine Reihe von Parametertypen, die von der Anwendung unterstützt werden.
`requiredCapabilities`	Array vom Typ Capability	Wahr	Eine Liste von Werten, die Sie angeben müssen, bevor Sie bestimmte Anwendungen bereitstellen können. Einige Anwendungen enthalten möglicherweise Ressourcen, die sich auf die Berechtigungen in Ihrem AWS Konto auswirken können, z. B. durch das Erstellen neuer AWS Identity and Access Management (IAM) -Benutzer. Für diese Anwendungen müssen Sie deren Funktionen explizit bestätigen, indem Sie diesen Parameter angeben. Die einzig gültigen Werte sind `CAPABILITY_IAMCAPABILITY_NAMED_IAM`,`CAPABILITY_RESOURCE_POLICY`, und`CAPABILITY_AUTO_EXPAND`. Für die folgenden Ressourcen müssen Sie `CAPABILITY_IAM` oder angeben`CAPABILITY_NAMED_IAM`: AWS: :IAM: :Group, AWS: :IAM::, AWS: :IAM: InstanceProfile :Policy und AWS: :IAM: :Role. https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html Wenn die Anwendung IAM-Ressourcen enthält, können Sie entweder oder angeben. `CAPABILITY_IAM` `CAPABILITY_NAMED_IAM` Beinhaltet die Anwendung IAM-Ressourcen mit benutzerdefinierten Namen, müssen Sie `CAPABILITY_NAMED_IAM` angeben. Für die folgenden Ressourcen müssen Sie Folgendes angeben`CAPABILITY_RESOURCE_POLICY`: AWS::Lambda: :Permission, AWS:: IAM:Policy,: AWS::ApplicationAutoScaling: ScalingPolicy, AWS: :S3:: BucketPolicy, AWS: :SQS:: und AWS: QueuePolicy :SNS::. TopicPolicy Bei Anwendungen, die eine oder mehrere verschachtelte Anwendungen enthalten, müssen Sie `CAPABILITY_AUTO_EXPAND` angeben. Wenn Ihre Anwendungsvorlage eine der oben genannten Ressourcen enthält, empfehlen wir Ihnen, vor der Bereitstellung alle mit der Anwendung verknüpften Berechtigungen zu überprüfen. Wenn Sie diesen Parameter nicht für eine Anwendung angeben, die Funktionen benötigt, schlägt der Aufruf fehl.
`resourcesSupported`	boolesch	Wahr	Ob alle in dieser Anwendung enthaltenen AWS Ressourcen in der Region unterstützt werden, in der sie abgerufen werden.
`semanticVersion`	Zeichenfolge	Wahr	Die semantische Version der Anwendung: https://semver.org/
`sourceCodeArchiveUrl`	Zeichenfolge	Falsch	Ein Link zum S3-Objekt, das das ZIP-Archiv des Quellcodes für diese Version Ihrer Anwendung enthält. Maximale Größe 50 MB
`sourceCodeUrl`	Zeichenfolge	Falsch	Ein Link zu einem öffentlichen Repository für den Quellcode Ihrer Anwendung, zum Beispiel die URL eines bestimmten GitHub Commits.
`templateUrl`	Zeichenfolge	Wahr	Ein Link zur verpackten AWS SAM Vorlage Ihrer Anwendung.

Weitere Informationen finden Sie auch unter

Weitere Informationen zur Verwendung dieser API in einem der sprachspezifischen AWS SDKs und Referenzen finden Sie unter den folgenden Links:

ListApplications

CreateApplication

Warnung JavaScript ist in Ihrem Browser nicht verfügbar oder deaktiviert.

Zur Nutzung der AWS-Dokumentation muss JavaScript aktiviert sein. Weitere Informationen finden auf den Hilfe-Seiten Ihres Browsers.

Dokumentkonventionen

Ressourcen

Anwendungen (Anwendungs-ID)