應用 applicationId - AWS Serverless Application Repository
URIHTTP方法結構描述屬性另請參閱

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

應用 applicationId

URI

/applications/applicationId

HTTP方法

GET

操作 ID：GetApplication

取得指定的應用程式。

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

應用程式的 Amazon 資源名稱 (ARN)。

查詢參數
名稱Type必要描述
semanticVersion字串False

要獲取的應用程序的語義版本。

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

Success (成功)

400BadRequestException

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

403ForbiddenException

用戶端未驗證。

404NotFoundException

請求中指定的資源（例如，訪問策略語句）不存在。

429TooManyRequestsException

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

500InternalServerErrorException

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

DELETE

操作 ID：DeleteApplication

刪除指定的應用程式。

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

應用程式的 Amazon 資源名稱 (ARN)。

回應
狀態碼回應模型描述
204無

Success (成功)

400BadRequestException

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

403ForbiddenException

用戶端未驗證。

404NotFoundException

請求中指定的資源（例如，訪問策略語句）不存在。

409ConflictException

此資源已存在。

429TooManyRequestsException

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

500InternalServerErrorException

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

OPTIONS

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

應用程式的 Amazon 資源名稱 (ARN)。

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

二百個回應

PATCH

操作 ID：UpdateApplication

更新指定的應用程式。

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

應用程式的 Amazon 資源名稱 (ARN)。

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

Success (成功)

400BadRequestException

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

403ForbiddenException

用戶端未驗證。

404NotFoundException

請求中指定的資源（例如，訪問策略語句）不存在。

409ConflictException

此資源已存在。

429TooManyRequestsException

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

500InternalServerErrorException

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

結構描述

請求內文

{
  "description": "string",
  "author": "string",
  "readmeBody": "string",
  "readmeUrl": "string",
  "labels": [
    "string"
  ],
  "homePageUrl": "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"
}

屬性

Application

有關應用程序的詳細信息

屬性Type必要描述
applicationId

string

True

應用程序 Amazon 資源名稱（ARN）。

author

string

True

發佈應用程式的作者姓名。

最小長度 = 1。最大長度 = 127。

模式「^ [a-z0-9] (([a-z0-9] |-(?! -））* [一個 Z0-9]）？ $」;

creationTime

string

False

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

description

string

True

應用程式的描述。

最小長度 = 1。最大長度為 256

homePageUrl

string

False

URL包含有關應用程式的詳細資訊，例如應用程式 GitHub 存放庫的位置。

isVerifiedAuthor

boolean

False

指定是否已驗證此應用程式的作者。這意味著，作為一個合理和審慎的服務提供商， AWS 已對請求者提供的信息進行了善意審查，並確認請求者的身份是如所聲稱的。

labels

類型 string 的陣列

False

標籤可改善搜尋結果中應用程式的探索。

最小長度 = 1。最大長度 = 127。最大標籤數量：10

模式："^[a-zA-Z0-9+\\-_:\\/@]+$";

licenseUrl

string

False

與應用程序的 spdxLicense ID 值匹配的應用程序的許可證文件的鏈接。

最大尺寸 5 MB

name

string

True

應用程式名稱。

最小長度 = 1。最大長度為 140

模式："[a-zA-Z0-9\\-]+";

readmeUrl

string

False

Markdown 語言的 Readme 檔案連結，其中包含應用程式及其運作方式的更詳細描述。

最大尺寸 5 MB

spdxLicenseId

string

False

一個有效的標識符來自 https://spdx.org/licenses/。

verifiedAuthorUrl

string

False

URL至已驗證作者的公開個人資料。這URL是由作者提交。

version

版本

False

關於應用程式的版本資訊。

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

此資源已存在。

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 務遇到內部錯誤。

NotFoundException

請求中指定的資源（例如，訪問策略語句）不存在。

屬性Type必要描述
errorCode

string

False

404

message

string

False

請求中指定的資源（例如，訪問策略語句）不存在。

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: 整數或浮點數。 AWS CloudFormation 將參數值驗證為數字。但是，當您在範本中的其他位置使用參數時 (例如，使用Ref內建函數)，參數值會變成字串。

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

List<Number>: 以逗號分隔的整數或浮點數陣列。 AWS CloudFormation 將參數值驗證為數字。但是，當您在範本中的其他位置使用參數時 (例如，使用Ref內建函數)，參數值會變成字串清單。

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

CommaDelimitedList: 以逗號分隔的文字字串陣列。字串總數應該比逗號總數多一個。此外，每個成員字符串都是空間修剪的。

例如，使用者可能會指定「測試、開發、prod」，然後Ref結果。["test","dev","prod"]

TooManyRequestsException

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

屬性Type必要描述
errorCode

string

False

429

message

string

False

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

UpdateApplicationInput

更新應用程式要求。

屬性Type必要描述
author

string

False

發佈應用程式的作者姓名。

最小長度 = 1。最大長度 = 127。

模式「^ [a-z0-9] (([a-z0-9] |-(?! -））* [一個 Z0-9]）？ $」;

description

string

False

應用程式的描述。

最小長度 = 1。最大長度為 256

homePageUrl

string

False

URL包含有關應用程式的詳細資訊，例如應用程式 GitHub 存放庫的位置。

labels

類型 string 的陣列

False

標籤可改善搜尋結果中應用程式的探索。

最小長度 = 1。最大長度 = 127。最大標籤數量：10

模式："^[a-zA-Z0-9+\\-_:\\/@]+$";

readmeBody

string

False

Markdown 語言的文字讀我檔案，其中包含應用程式及其運作方式的更詳細描述。

最大尺寸 5 MB

readmeUrl

string

False

Markdown 語言的 Readme 檔案連結，其中包含應用程式及其運作方式的更詳細描述。

最大尺寸 5 MB

Version

應用程式版本詳情。

屬性Type必要描述
applicationId

string

True

應用程序 Amazon 資源名稱（ARN）。

creationTime

string

True

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

parameterDefinitions

類型 ParameterDefinition 的陣列

True

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

requiredCapabilities

類型 Capability 的陣列

True

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

唯一有效的值為CAPABILITY_IAMCAPABILITY_NAMED_IAM、CAPABILITY_RESOURCE_POLICY、和CAPABILITY_AUTO_EXPAND。

下列資源需要您指定CAPABILITY_IAM或CAPABILITY_NAMED_IAMAWS::IAM:: 群組、AWS::IAM: InstanceProfile,:, AWS:IAM: 政策和:AWS: 角色。IAM如果應用程式包含IAM資源，您可以指定CAPABILITY_IAM或CAPABILITY_NAMED_IAM。如果應用程式包含具有自訂名稱的IAM資源，您必須指定CAPABILITY_NAMED_IAM。

下列資源需要您指定CAPABILITY_RESOURCE_POLICY:AWS:: Lambda:: 權限、AWS::: 政策IAM、AWS::ApplicationAutoScaling:, AWS:ScalingPolicy: S3:,::BucketPolicy:, AWS:, QueuePolicy 和SQS::。AWS SNS TopicPolicy

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

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

resourcesSupported

布林值

True

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

semanticVersion

string

True

該應用程序的語義版本：

https://semver.org/

sourceCodeArchiveUrl

string

False

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

最大尺寸為 50 MB

sourceCodeUrl

string

False

指向應用程序源代碼的公共存儲庫的鏈接，例如URL特定 GitHub 提交的。

templateUrl

string

True

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

另請參閱

如需有關API在其中一種特定語言 AWS SDKs和參照中使用此功能的詳細資訊，請參閱下列內容：

GetApplication

DeleteApplication

UpdateApplication