應用程式 applicationId 版本 semanticVersion - AWS Serverless Application Repository

本文為英文版的機器翻譯版本,如內容有任何歧義或不一致之處,概以英文版為準。

應用程式 applicationId 版本 semanticVersion

URI

/applications/applicationId/versions/semanticVersion

HTTP 方法

PUT

操作 ID:CreateApplicationVersion

建立應用程式版本。

路徑參數
名稱Type必要描述
applicationId字串True

應用程式的 Amazon Resource Name (ARN)。

semanticVersion字串True

新版本的語意版本。

回應
狀態碼回應模型描述
201Version

Success (成功)

400BadRequestException

請求中的其中一個參數無效。

403ForbiddenException

用戶端未進行身分驗證。

409ConflictException

此資源已存在。

429TooManyRequestsException

用戶端傳送的請求數目超過每單位時間允許的數目。

500InternalServerErrorException

AWS Serverless Application Repository 服務遇到內部錯誤。

OPTIONS

路徑參數
名稱Type必要描述
applicationId字串True

應用程式的 Amazon Resource Name (ARN)。

semanticVersion字串True

新版本的語意版本。

回應
狀態碼回應模型描述
200

200 個回應

結構描述

請求內文

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

回應內文

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

屬性

BadRequestException

請求中的其中一個參數無效。

屬性Type必要描述
errorCode

string

False

400

message

string

False

請求中的其中一個參數無效。

Capability

必須指定值才能部署某些應用程式。

  • CAPABILITY_IAM

  • CAPABILITY_NAMED_IAM

  • CAPABILITY_AUTO_EXPAND

  • CAPABILITY_RESOURCE_POLICY

ConflictException

此資源已存在。

屬性Type必要描述
errorCode

string

False

409

message

string

False

此資源已存在。

CreateApplicationVersionInput

建立版本請求。

屬性Type必要描述
sourceCodeArchiveUrl

string

False

S3 物件的連結,其中包含此版本應用程式的原始程式碼ZIP封存。

大小上限為 50 MB

sourceCodeUrl

string

False

應用程式原始碼的公有儲存庫連結,例如特定 GitHub 遞交URL的 。

templateBody

string

False

應用程式的原始封裝 AWS SAM 範本。

templateUrl

string

False

應用程式封裝 AWS SAM 範本的連結。

ForbiddenException

用戶端未進行身分驗證。

屬性Type必要描述
errorCode

string

False

403

message

string

False

用戶端未進行身分驗證。

InternalServerErrorException

AWS Serverless Application Repository 服務遇到內部錯誤。

屬性Type必要描述
errorCode

string

False

500

message

string

False

AWS Serverless Application Repository 服務遇到內部錯誤。

ParameterDefinition

應用程式支援的參數。

屬性Type必要描述
allowedPattern

string

False

規則表達式,代表 String 類型允許的模式。

allowedValues

類型的陣列 string

False

陣列,包含參數的允許值清單。

constraintDescription

string

False

字串,說明違反限制時的限制。例如,具有允許模式 [A-Za-z0-9]+ 的參數會在使用者指定無效值時顯示下列錯誤訊息,但沒有限制描述:

Malformed input-Parameter MyParameter must match pattern [A-Za-z0-9]+

透過新增限制描述,例如「必須僅包含大寫和小寫字母和數字」,您可以顯示下列自訂錯誤訊息:

Malformed input-Parameter MyParameter must contain only uppercase and lowercase letters and numbers.

defaultValue

string

False

建立堆疊時,範本要在未指定值時使用的適當類型值。如果您定義參數的限制,則必須指定遵循這些限制的值。

description

string

False

最多 4,000 個字元的字串,描述 參數。

maxLength

integer

False

整數值,決定您要允許String類型的最大字元數。

maxValue

integer

False

數值,決定您要允許Number類型的最大數值。

minLength

integer

False

整數值,決定您要允許 String類型的最小字元數。

minValue

integer

False

數值,決定您想要允許 Number類型的最小數值。

name

string

True

參數名稱。

noEcho

boolean

False

是否在任何人進行描述堆疊的呼叫時遮罩參數值。如果您將值設定為 true,參數值會以星號 (*****) 遮罩。

referencedByResources

類型的陣列 string

True

使用此參數 AWS SAM 的資源清單。

type

string

False

參數的類型。

有效值:String | Number | List<Number> | CommaDelimitedList

String:文字字串。

例如,使用者可以指定 "MyUserName"

Number:整數或 float. AWS CloudFormation validation 參數值作為數字。不過,當您在範本的其他位置使用 參數 (例如,使用Ref內部 函數) 時, 參數值會變成字串。

例如,使用者可能會指定 "8888"

List<Number>:以逗號分隔的整數或浮點數陣列。 AWS CloudFormation 會以數字驗證參數值。不過,當您在範本的其他地方使用 參數 (例如,使用Ref內部 函數) 時, 參數值會變成字串清單。

例如,使用者可能會指定「80,20」,然後Ref產生 ["80","20"]

CommaDelimitedList:以逗號分隔的文字字串陣列。字串總數應該比逗號總數多一個。此外,每個成員字串都經過空格修剪。

例如,使用者可能會指定「測試、開發、生產」,然後在 中Ref產生 ["test","dev","prod"]

TooManyRequestsException

用戶端傳送的請求數目超過每單位時間的允許數目。

屬性Type必要描述
errorCode

string

False

429

message

string

False

用戶端傳送的請求數目超過每單位時間的允許數目。

Version

應用程式版本詳細資訊。

屬性Type必要描述
applicationId

string

True

應用程式 Amazon Resource Name (ARN)。

creationTime

string

True

此資源建立的日期和時間。

parameterDefinitions

類型的陣列 ParameterDefinition

True

應用程式支援的參數類型陣列。

requiredCapabilities

類型的陣列 功能

True

您必須先指定的值清單,才能部署特定應用程式。某些應用程式可能包含可能會影響您 AWS 帳戶中許可的資源,例如,建立新的 AWS Identity and Access Management (IAM) 使用者。對於這些應用程式,您必須指定此參數,明確確認其功能。

唯一有效的值是 CAPABILITY_IAMCAPABILITY_RESOURCE_POLICYCAPABILITY_NAMED_IAMCAPABILITY_AUTO_EXPAND

下列資源需要您指定 CAPABILITY_IAMCAPABILITY_NAMED_IAMAWS:IAM::Group AWS:IAM::InstanceProfileAWS:IAM::Policy AWS:IAM:::Role 。如果應用程式包含 IAM 資源,您可以指定 CAPABILITY_IAMCAPABILITY_NAMED_IAM。如果應用程式包含具有自訂名稱IAM的資源,您必須指定 CAPABILITY_NAMED_IAM

下列資源需要您指定 CAPABILITY_RESOURCE_POLICYAWS:Lambda::Permission AWS:IAM:Policy AWS:ApplicationAutoScaling::ScalingPolicyAWS:S3::BucketPolicyAWS::SQS::QueuePolicyAWS:SNS:::TopicPolicy

包含一個或多個巢狀應用程式的應用程式需要由您指定 CAPABILITY_AUTO_EXPAND

如果您的應用程式範本包含上述任何資源,建議您在部署之前檢閱與應用程式相關聯的所有許可。如果您未為需要 功能的應用程式指定此參數,則呼叫會失敗。

resourcesSupported

布林值

True

此應用程式中包含的所有 AWS 資源是否都支援擷取該資源的 區域。

semanticVersion

string

True

應用程式語意版本:

https://semver.org/

sourceCodeArchiveUrl

string

False

S3 物件的連結,其中包含此版本應用程式的原始程式碼ZIP封存。

大小上限為 50 MB

sourceCodeUrl

string

False

應用程式原始碼的公有儲存庫連結,例如特定 GitHub 遞交URL的 。

templateUrl

string

True

應用程式封裝 AWS SAM 範本的連結。

另請參閱

如需在其中一種語言特定 AWS SDKs和參考API中使用此功能的詳細資訊,請參閱以下內容:

CreateApplicationVersion