Applications

URI

/applications

HTTPMethoden

GET

Vorgangs-ID: ListApplications

Listet Anwendungen im Besitz des Auftraggebers auf

Abfrageparameter

Name	Typ	Erforderlich	Beschreibung
maxItems	String	False	Die Gesamtzahl der zurückzugebenden Artikel.
nextToken	String	False	Ein Token für den Beginn der Seitennummerierung.

Antworten

Statuscode	Antwortmodell	Beschreibung
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 Anfrage angegebene Ressource (z. B. eine Anweisung zur Zugriffsrichtlinie) 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 zur Erstellung der ersten Anwendungsversion im selben Aufruf.

Antworten

Statuscode	Antwortmodell	Beschreibung
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	Beschreibung
200	None	Antwort 200

Schemata

Anfragetexte

POST schema

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

ApplicationPage schema

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

Application Schema

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

BadRequestException Schema

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

ForbiddenException Schema

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

NotFoundException Schema

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

ConflictException Schema

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

TooManyRequestsException Schema

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

InternalServerErrorException Schema

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

Eigenschaften

Application

Einzelheiten zur Bewerbung.

Eigenschaft	Typ	Erforderlich	Beschreibung
applicationId	Zeichenfolge	True	Die Anwendung Amazon Resource Name (ARN).
author	Zeichenfolge	True	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	False	Datum und Uhrzeit der Erstellung dieser Ressource.
description	Zeichenfolge	True	Die Beschreibung der Anwendung. Minimale Länge = 1. Maximale Länge = 256
homePageUrl	Zeichenfolge	False	A URL mit weiteren Informationen über die Anwendung, z. B. den Speicherort Ihres GitHub Repositorys für die Anwendung.
isVerifiedAuthor	boolesch	False	Gibt an, ob der Autor dieser Anwendung verifiziert wurde. Das bedeutet, AWS dass das Unternehmen als vernünftiger und umsichtiger Dienstleister die vom Antragsteller bereitgestellten Informationen nach bestem Wissen und Gewissen geprüft und bestätigt hat, dass die Identität des Antragstellers den Angaben entspricht.
labels	Array des Typs string	False	Labels zur besseren Auffindbarkeit von Apps in Suchergebnissen. Minimale Länge = 1. Maximale Länge = 127. Maximale Anzahl von Labels: 10 Pattern: "^[a-zA-Z0-9+\\-_:\\/@]+$";
licenseUrl	Zeichenfolge	False	Ein Link zu einer Lizenzdatei der App, die dem spdxLicense ID-Wert Ihrer Anwendung entspricht. Maximale Größe 5 MB
name	Zeichenfolge	True	Der Name der Anwendung. Minimale Länge = 1. Maximale Länge = 140 Pattern: "[a-zA-Z0-9\\-]+";
readmeUrl	Zeichenfolge	False	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	False	Eine gültige Kennung von https://spdx.org/licenses/.
verifiedAuthorUrl	Zeichenfolge	False	Das URL öffentliche Profil eines verifizierten Autors. Dies URL wird vom Autor eingereicht.
version	Version	False	Versionsinformationen zur Anwendung.

ApplicationPage

Eine Liste mit Anwendungsdetails.

Eigenschaft	Typ	Erforderlich	Beschreibung
applications	Array des Typs ApplicationSummary	True	Eine Reihe von Anwendungszusammenfassungen.
nextToken	Zeichenfolge	False	Das Token zum Anfordern der nächsten Ergebnisseite.

ApplicationSummary

Zusammenfassung der Details zur Anwendung.

Eigenschaft	Typ	Erforderlich	Beschreibung
applicationId	Zeichenfolge	True	Die Anwendung Amazon Resource Name (ARN).
author	Zeichenfolge	True	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	False	Datum und Uhrzeit der Erstellung dieser Ressource.
description	Zeichenfolge	True	Die Beschreibung der Anwendung. Minimale Länge = 1. Maximale Länge = 256
homePageUrl	Zeichenfolge	False	A URL mit weiteren Informationen über die Anwendung, z. B. den Speicherort Ihres GitHub Repositorys für die Anwendung.
labels	Array vom Typ string	False	Labels zur besseren Auffindbarkeit von Apps in Suchergebnissen. Minimale Länge = 1. Maximale Länge = 127. Maximale Anzahl von Labels: 10 Pattern: "^[a-zA-Z0-9+\\-_:\\/@]+$";
name	Zeichenfolge	True	Der Name der Anwendung. Minimale Länge = 1. Maximale Länge = 140 Pattern: "[a-zA-Z0-9\\-]+";
spdxLicenseId	Zeichenfolge	False	Eine gültige Kennung von https://spdx.org/licenses/.

BadRequestException

Einer der Parameter der Anfrage ist ungültig.

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

Capability

Werte, die angegeben werden müssen, um einige Anwendungen bereitzustellen.

• CAPABILITY_IAM

• CAPABILITY_NAMED_IAM

• CAPABILITY_AUTO_EXPAND

• CAPABILITY_RESOURCE_POLICY

ConflictException

Die Ressource ist bereits vorhanden.

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

CreateApplicationInput

Erstellen Sie eine Anwendungsanfrage.

Eigenschaft	Typ	Erforderlich	Beschreibung
author	Zeichenfolge	True	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	True	Die Beschreibung der Anwendung. Minimale Länge = 1. Maximale Länge = 256
homePageUrl	Zeichenfolge	False	A URL mit weiteren Informationen über die Anwendung, z. B. den Speicherort Ihres GitHub Repositorys für die Anwendung.
labels	Array vom Typ string	False	Labels zur besseren Auffindbarkeit von Apps in Suchergebnissen. Minimale Länge = 1. Maximale Länge = 127. Maximale Anzahl von Labels: 10 Pattern: "^[a-zA-Z0-9+\\-_:\\/@]+$";
licenseBody	Zeichenfolge	False	Eine lokale Textdatei, die die Lizenz der App enthält, die dem spdxLicense ID-Wert Ihrer Anwendung entspricht. Die Datei hat das Formatfile://<path>/<filename>. Maximale Größe 5 MB Sie können nur einen Wert von licenseBody und angeben. licenseUrl Andernfalls tritt ein Fehler auf.
licenseUrl	Zeichenfolge	False	Ein Link zum S3-Objekt, das die Lizenz der App enthält, die dem spdxLicense ID-Wert Ihrer Anwendung entspricht. Maximale Größe 5 MB Sie können nur einen Wert von licenseBody und angeben. licenseUrl Andernfalls tritt ein Fehler auf.
name	Zeichenfolge	True	Der Name der Anwendung, die Sie veröffentlichen möchten. Minimale Länge = 1. Maximale Länge = 140 Pattern: "[a-zA-Z0-9\\-]+";
readmeBody	Zeichenfolge	False	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 einen Wert von readmeBody und angeben. readmeUrl Andernfalls tritt ein Fehler auf.
readmeUrl	Zeichenfolge	False	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 einen Wert von readmeBody und angeben. readmeUrl Andernfalls tritt ein Fehler auf.
semanticVersion	Zeichenfolge	False	Die semantische Version der Anwendung: https://semver.org/
sourceCodeArchiveUrl	Zeichenfolge	False	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	False	Ein Link zu einem öffentlichen Repository für den Quellcode Ihrer Anwendung, z. B. den URL eines bestimmten GitHub Commits.
spdxLicenseId	Zeichenfolge	False	Ein gültiger Bezeichner von https://spdx.org/licenses/.
templateBody	Zeichenfolge	False	Die lokale rohe, verpackte AWS SAM Vorlagendatei Ihrer Anwendung. Die Datei hat das Formatfile://<path>/<filename>. Sie können nur eines von templateBody und angeben, templateUrl andernfalls wird ein Fehler angezeigt.
templateUrl	Zeichenfolge	False	Ein Link zu dem S3-Objekt, das die verpackte AWS SAM Vorlage Ihrer Anwendung enthält. Sie können nur eines von templateBody und angeben. templateUrl Andernfalls wird ein Fehler angezeigt.

ForbiddenException

Der Client ist nicht authentifiziert.

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

InternalServerErrorException

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

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

NotFoundException

Die in der Anfrage angegebene Ressource (z. B. eine Anweisung zur Zugriffsrichtlinie) ist nicht vorhanden.

Eigenschaft	Typ	Erforderlich	Beschreibung
errorCode	Zeichenfolge	False	404
message	Zeichenfolge	False	Die in der Anfrage angegebene Ressource (z. B. eine Erklärung zur Zugriffsrichtlinie) ist nicht vorhanden.

ParameterDefinition

Von der Anwendung unterstützte Parameter.

Eigenschaft	Typ	Erforderlich	Beschreibung
allowedPattern	Zeichenfolge	False	Gibt einen regulären Ausdruck an, der die zulässigen Muster für String-Typen beschreibt.
allowedValues	Array des Typs string	False	Gibt ein Array mit einer Liste der für den Parameter zulässigen Werte an.
constraintDescription	Zeichenfolge	False	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]+ Durch Hinzufügen einer Beschränkungsbeschreibung, 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	False	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	False	Eine Zeichenfolge mit bis zu 4.000 Zeichen, die den Parameter beschreibt.
maxLength	Ganzzahl	False	Ein ganzzahliger Wert, der die größte Anzahl von Zeichen bestimmt, die Sie für String Typen zulassen möchten.
maxValue	Ganzzahl	False	Ein numerischer Wert, der den größten numerischen Wert bestimmt, den Sie für Number Typen zulassen möchten.
minLength	Ganzzahl	False	Ein ganzzahliger Wert, der die kleinste Anzahl von Zeichen bestimmt, die Sie für String Typen zulassen möchten.
minValue	Ganzzahl	False	Ein numerischer Wert, der den kleinsten numerischen Wert bestimmt, den Sie für Number Typen zulassen möchten.
name	Zeichenfolge	True	Der Name des Parameters.
noEcho	boolesch	False	Gibt an, ob der Parameterwert immer dann 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 des Typs string	True	Eine Liste von AWS SAM Ressourcen, die diesen Parameter verwenden.
type	Zeichenfolge	False	Der Typ des Parameters. Zulässige Werte: String | Number | List<Number> | CommaDelimitedList String: Eine wörtliche Zeichenfolge. Benutzer können beispielsweise angeben"MyUserName". Number: Eine Ganzzahl oder eine Fließkommazahl. AWS CloudFormation validiert den Parameterwert als Zahl. Wenn Sie den Parameter jedoch an einer anderen Stelle in Ihrer Vorlage verwenden (z. B. mithilfe der Ref systeminternen Funktion), wird der Parameterwert zu einer Zeichenfolge. Benutzer könnten beispielsweise angeben. "8888" List<Number>: Eine Reihe von Ganzzahlen oder Gleitkommazahlen, die durch Kommas getrennt sind. AWS CloudFormation validiert den Parameterwert als Zahlen. Wenn Sie den Parameter jedoch an einer anderen Stelle in Ihrer Vorlage verwenden (z. B. mithilfe der Ref systeminternen Funktion), wird der Parameterwert zu einer Liste von Zeichenfolgen. Benutzer könnten beispielsweise „80,20" angeben und dann das Ergebnis anzeigen. 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 wird jede Elementzeichenfolge durch Leerzeichen gekürzt. Benutzer könnten beispielsweise „test, dev, prod“ angeben und dann die Ergebnisse 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	False	429
message	Zeichenfolge	False	Der Client sendet mehr als die zulässige Anzahl von Anfragen pro Zeiteinheit.

Version

Einzelheiten zur Anwendungsversion.

Eigenschaft	Typ	Erforderlich	Beschreibung
applicationId	Zeichenfolge	True	Die Anwendung Amazon Resource Name (ARN).
creationTime	Zeichenfolge	True	Datum und Uhrzeit der Erstellung dieser Ressource.
parameterDefinitions	Array des Typs ParameterDefinition	True	Eine Reihe von Parametertypen, die von der Anwendung unterstützt werden.
requiredCapabilities	Array des Typs Funktion	True	Eine Liste von Werten, die Sie angeben müssen, bevor Sie bestimmte Anwendungen bereitstellen können. Einige Anwendungen können Ressourcen enthalten, die sich auf die Berechtigungen in Ihrem AWS Konto auswirken können, z. B. indem neue Benutzer AWS Identity and Access Management (IAM) erstellt werden. Für diese Anwendungen müssen Sie ihre Funktionen ausdrücklich bestätigen, indem Sie diesen Parameter angeben. Die einzig gültigen Werte sind CAPABILITY_IAMCAPABILITY_NAMED_IAM,CAPABILITY_RESOURCE_POLICY, undCAPABILITY_AUTO_EXPAND. Für die folgenden Ressourcen müssen Sie CAPABILITY_IAM oderCAPABILITY_NAMED_IAM:: AWS: :Group,IAM:: AWS:::,InstanceProfile,IAM:AWS:, Policy undIAM::: AWS:Role angeben. IAM Wenn die Anwendung IAM Ressourcen enthält, können Sie entweder oder angeben. CAPABILITY_IAM CAPABILITY_NAMED_IAM Wenn die Anwendung IAM Ressourcen mit benutzerdefinierten Namen enthält, müssen Sie Folgendes angebenCAPABILITY_NAMED_IAM. Für die folgenden Ressourcen müssen SieCAPABILITY_RESOURCE_POLICY:: :LambdaAWS: :Permission,: ::Policy,AWS:::::IAM, AWS::ApplicationAutoScaling:, ScalingPolicy::: AWS,::, undBucketPolicy: AWS::SQS: angeben. QueuePolicy AWS 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	True	Ob alle in dieser Anwendung enthaltenen AWS Ressourcen in der Region unterstützt werden, in der sie abgerufen wird.
semanticVersion	Zeichenfolge	True	Die semantische Version der Anwendung: https://semver.org/
sourceCodeArchiveUrl	Zeichenfolge	False	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	False	Ein Link zu einem öffentlichen Repository für den Quellcode Ihrer Anwendung, z. B. den URL eines bestimmten GitHub Commits.
templateUrl	Zeichenfolge	True	Ein Link zum AWS SAM Template-Paket Ihrer Anwendung.

Weitere Informationen finden Sie auch unter

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

ListApplications

• AWS-Befehlszeilenschnittstelle

• AWSSDKfür. NET

• AWSSDKfür C++

• AWSSDKfür Go v2

• AWSSDKfür Java V2

• AWSSDKfür JavaScript V3

• AWSSDKfür PHP V3

• AWSSDKfür Python

• AWSSDKfür Ruby V3

CreateApplication

• AWS-Befehlszeilenschnittstelle

• AWSSDKfür. NET

• AWSSDKfür C++

• AWSSDKfür Go v2

• AWSSDKfür Java V2

• AWSSDKfür JavaScript V3

• AWSSDKfür PHP V3

• AWSSDKfür Python

• AWSSDKfür Ruby V3