Application-ID-Changesets für Anwendungen

URI

/applications/applicationId/changesets

HTTP-Methoden

POST

Vorgangs-ID: CreateCloudFormationChangeSet

Erstellt einen AWS CloudFormation Änderungssatz für die angegebene Anwendung.

Pfadparameter
Name	Typ	Erforderlich	Beschreibung
applicationId	String	True	Der Amazon-Ressourcenname (ARN) der Anwendung.

Antworten
Statuscode	Antwortmodell	Beschreibung
201	ChangeSetDetails	Herzlichen Glückwunsch
400	BadRequestException	Einer der Parameter der Anfrage ist ungültig.
403	ForbiddenException	Der Client ist nicht authentifiziert.
429	TooManyRequestsException	Der Client sendet mehr als die zulässige Anzahl von Anfragen pro Zeiteinheit.
500	InternalServerErrorException	Beim Service AWS Serverless Application Repository trat ein interner Fehler auf.

OPTIONS

Pfadparameter
Name	Typ	Erforderlich	Beschreibung
applicationId	String	True	Der Amazon-Ressourcenname (ARN) der Anwendung.

Antworten
Statuscode	Antwortmodell	Beschreibung
200	None	Antwort von 200

Schemata

Anfragetexte

POST-Schema

{
  "stackName": "string",
  "semanticVersion": "string",
  "templateId": "string",
  "parameterOverrides": [
    {
      "name": "string",
      "value": "string"
    }
  ],
  "capabilities": [
    "string"
  ],
  "changeSetName": "string",
  "clientToken": "string",
  "description": "string",
  "notificationArns": [
    "string"
  ],
  "resourceTypes": [
    "string"
  ],
  "rollbackConfiguration": {
    "rollbackTriggers": [
      {
        "arn": "string",
        "type": "string"
      }
    ],
    "monitoringTimeInMinutes": integer
  },
  "tags": [
    {
      "key": "string",
      "value": "string"
    }
  ]
}

Antworttexte

ChangeSetDetails-Schema

{
  "applicationId": "string",
  "semanticVersion": "string",
  "changeSetId": "string",
  "stackId": "string"
}

BadRequestException-Schema

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

ForbiddenException-Schema

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

TooManyRequestsException-Schema

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

InternalServerErrorException-Schema

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

Eigenschaften

BadRequestException

Einer der Parameter der Anfrage ist ungültig.

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

ChangeSetDetails

Einzelheiten des Änderungssatzes.

Eigenschaft	Typ	Erforderlich	Beschreibung
applicationId	Zeichenfolge	True	Der Amazon-Ressourcenname (ARN) der -Anwendung
changeSetId	Zeichenfolge	True	Der Amazon-Ressourcenname (ARN) des Änderungssatzes. Längenbeschränkungen: Minimale Länge von 1. Muster: ARN: [-a-Za-Z0-9:/] *
Semantische Version	Zeichenfolge	True	Die semantische Version der Anwendung: https://semver.org/
Stack-ID	Zeichenfolge	True	Die eindeutige ID des Stacks.

CreateCloudFormationChangeSetInput

Erstellen Sie eine Anfrage für ein Anwendungs-Änderungssatz.

Eigenschaft	Typ	Erforderlich	Beschreibung
Funktionen	Array vom Typ string	False	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 oder angebenCAPABILITY_NAMED_IAM: AWS::IAM::GroupAWS::IAM::InstanceProfile, AWS::IAM::Policy, und AWS::IAM::Role. Wenn die Anwendung IAM-Ressourcen enthält, können Sie entweder CAPABILITY_IAM oder CAPABILITY_NAMED_IAM angeben. Beinhaltet die Anwendung IAM-Ressourcen mit benutzerdefinierten Namen, müssen Sie CAPABILITY_NAMED_IAM angeben. Für die folgenden Ressourcen müssen SieCAPABILITY_RESOURCE_POLICY: AWS::Lambda::Permission, AWS: :IAM:Policy,,, AWS::ApplicationAutoScaling::ScalingPolicyAWS::S3::BucketPolicyAWS::SQS::QueuePolicy, und AWS: :SNS: angeben. 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.
changeSetName	Zeichenfolge	False	Diese Eigenschaft entspricht dem gleichnamigen Parameter für die AWS CloudFormationCreateChangeSetAPI.
clientToken	Zeichenfolge	False	Diese Eigenschaft entspricht dem gleichnamigen Parameter für die AWS CloudFormationCreateChangeSetAPI.
description	Zeichenfolge	False	Diese Eigenschaft entspricht dem gleichnamigen Parameter für die AWS CloudFormationCreateChangeSetAPI.
NotificationARNS	Array vom Typ string	False	Diese Eigenschaft entspricht dem gleichnamigen Parameter für die API. AWS CloudFormationCreateChangeSet
Der Parameter überschreibt	Array vom Typ ParameterValue	False	Eine Liste von Parameterwerten für die Parameter der Anwendung.
resourceTypes	Array vom Typ string	False	Diese Eigenschaft entspricht dem gleichnamigen Parameter für die AWS CloudFormationCreateChangeSetAPI.
Rollback-Konfiguration	RollbackConfiguration	False	Diese Eigenschaft entspricht dem gleichnamigen Parameter für die AWS CloudFormationCreateChangeSetAPI.
Semantische Version	Zeichenfolge	False	Die semantische Version der Anwendung: https://semver.org/
Name des Stapels	Zeichenfolge	True	Diese Eigenschaft entspricht dem gleichnamigen Parameter für die AWS CloudFormationCreateChangeSetAPI.
Tags	Array vom Typ Tag	False	Diese Eigenschaft entspricht dem gleichnamigen Parameter für die AWS CloudFormationCreateChangeSetAPI.
TemplateID	Zeichenfolge	False	Die von zurückgegebene UUID. CreateCloudFormationTemplate Muster: [0-9a-fa-F] {8}\ - [0-9a-fa-F] {4}\ - [0-9a-fa-F] {4}\ - [0-9a-fa-F] {4}\ - [0-9a-fa-F] {12}

ForbiddenException

Der Client ist nicht authentifiziert.

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

InternalServerErrorException

Beim Service AWS Serverless Application Repository trat ein interner Fehler auf.

Eigenschaft	Typ	Erforderlich	Beschreibung
errorCode	Zeichenfolge	False	500
Nachricht	Zeichenfolge	False	Beim Service AWS Serverless Application Repository trat ein interner Fehler auf.

ParameterValue

Parameterwert der Anwendung.

Eigenschaft	Typ	Erforderlich	Beschreibung
name	Zeichenfolge	True	Der Schlüssel, der dem Parameter zugeordnet ist. Wenn Sie keinen Schlüssel und keinen Wert für einen bestimmten Parameter angeben, wird der Standardwert AWS CloudFormation verwendet, der in Ihrer Vorlage angegeben ist.
Wert	Zeichenfolge	True	Der dem Parameter zugeordnete Eingabewert.

RollbackConfiguration

Diese Eigenschaft entspricht dem AWS CloudFormationRollbackConfigurationDatentyp.

Eigenschaft	Typ	Erforderlich	Beschreibung
monitoringTimeInMinuten	Ganzzahl	False	Diese Eigenschaft entspricht dem gleichnamigen Inhalt für den AWS CloudFormationRollbackConfigurationDatentyp.
RollbackTrigger	Array vom Typ RollbackTrigger	False	Diese Eigenschaft entspricht dem gleichnamigen Inhalt für den AWS CloudFormationRollbackConfigurationDatentyp.

RollbackTrigger

Diese Eigenschaft entspricht dem AWS CloudFormationRollbackTriggerDatentyp.

Eigenschaft	Typ	Erforderlich	Beschreibung
arn	Zeichenfolge	True	Diese Eigenschaft entspricht dem gleichnamigen Inhalt für den AWS CloudFormationRollbackTriggerDatentyp.
type	Zeichenfolge	True	Diese Eigenschaft entspricht dem gleichnamigen Inhalt für den AWS CloudFormationRollbackTriggerDatentyp.

Tag

Diese Eigenschaft entspricht dem AWS CloudFormationTag-Datentyp.

Eigenschaft	Typ	Erforderlich	Beschreibung
Schlüssel	Zeichenfolge	True	Diese Eigenschaft entspricht dem gleichnamigen Inhalt für den AWS CloudFormationTag-Datentyp.
Wert	Zeichenfolge	True	Diese Eigenschaft entspricht dem gleichnamigen Inhalt für den AWS CloudFormationTag-Datentyp.

TooManyRequestsException

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

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

Weitere Informationen finden Sie auch unter

Weitere Informationen zur Verwendung dieser API in einem der sprachspezifischen AWS-SDKs sowie Referenzen finden Sie unter:

CreateCloudFormationChangeSet

• AWS-Befehlszeilenschnittstelle

• AWS SDK für .NET

• AWS SDK für C++

• AWS SDK for Go

• AWS SDK für Java V2

• AWS-SDK für JavaScript Version 3

• AWS SDK für PHP V3

• AWS SDK für Python

• AWS SDK für Ruby V3