View a markdown version of this page

Anwendungen, Anwendungs-ID, Versionen, Semantische Version - AWS Serverless Application Repository

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.

Anwendungen, Anwendungs-ID, Versionen, Semantische Version

URI

/applications/applicationId/versions/semanticVersion

HTTP-Methoden

PUT

Vorgangs-ID: CreateApplicationVersion

Erstellt eine Anwendungsversion

Pfadparameter
NameTypErforderlichBeschreibung
applicationIdZeichenfolgeWahr

Der Amazon-Ressourcenname (ARN) der Anwendung.

semanticVersionZeichenfolgeWahr

Die semantische Version der neuen Version.

Antworten
StatuscodeAntwortmodellDescription
201Version

Herzlichen Glückwunsch

400BadRequestException

Einer der Parameter der Anfrage ist ungültig.

403ForbiddenException

Der Client ist nicht authentifiziert.

409ConflictException

Die Ressource ist bereits vorhanden.

429TooManyRequestsException

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

500InternalServerErrorException

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

OPTIONS

Pfadparameter
NameTypErforderlichBeschreibung
applicationIdZeichenfolgeWahr

Der Amazon-Ressourcenname (ARN) der Anwendung.

semanticVersionZeichenfolgeWahr

Die semantische Version der neuen Version.

Antworten
StatuscodeAntwortmodellDescription
200Keine

200 Antworten

Schemata

Anfragetexte

{ "templateBody": "string", "templateUrl": "string", "sourceCodeUrl": "string", "sourceCodeArchiveUrl": "string" }

Antworttexte

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

Eigenschaften

BadRequestException

Einer der Parameter der Anfrage ist ungültig.

EigenschaftTypErforderlichBeschreibung
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.

EigenschaftTypErforderlichBeschreibung
errorCode

Zeichenfolge

Falsch

409

message

Zeichenfolge

Falsch

Die Ressource ist bereits vorhanden.

CreateApplicationVersionInput

Erstellen Sie eine Versionsanfrage.

EigenschaftTypErforderlichBeschreibung
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.

templateBody

Zeichenfolge

Falsch

Die unformatierte, verpackte AWS SAM Vorlage Ihrer Anwendung.

templateUrl

Zeichenfolge

Falsch

Ein Link zur verpackten AWS SAM Vorlage Ihrer Anwendung.

ForbiddenException

Der Client ist nicht authentifiziert.

EigenschaftTypErforderlichBeschreibung
errorCode

Zeichenfolge

Falsch

403

message

Zeichenfolge

Falsch

Der Client ist nicht authentifiziert.

InternalServerErrorException

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

EigenschaftTypErforderlichBeschreibung
errorCode

Zeichenfolge

Falsch

500

message

Zeichenfolge

Falsch

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

ParameterDefinition

Parameter, die von der Anwendung unterstützt werden.

EigenschaftTypErforderlichBeschreibung
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.

EigenschaftTypErforderlichBeschreibung
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.

EigenschaftTypErforderlichBeschreibung
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, undCAPABILITY_AUTO_EXPAND.

Für die folgenden Ressourcen müssen Sie CAPABILITY_IAM oder angebenCAPABILITY_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 angebenCAPABILITY_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 verbundenen 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 wird.

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:

CreateApplicationVersion