ApapplicationId - Amazon Serverless Application Repository
Amazon Web Services 文档中描述的 Amazon Web Services 服务或功能可能因区域而异。要查看适用于中国区域的差异,请参阅中国的 Amazon Web Services 服务入门

本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。

ApapplicationId

URI

/applications/applicationId

HTTP 方法

得到

操作 ID: GetApplication

获取指定的应用程序。

路径参数
名称类型必需描述
applicationIdStringTrue

应用程序的 Amazon 资源名称 (ARN)。

查询参数
名称类型必需描述
语义版StringFalse

要获取的应用程序的语义版本。

响应
状态代码响应模型描述
200应用程序

成功

400BadRequestException

请求中的参数之一无效。

403禁止的例外

客户端未经过身份验证。

404NotFoundException

请求中指定的资源(例如,访问策略语句)不存在。

429TooManyRequestsException

客户端发送的请求超过了允许的每个单位时间的请求数。

500InternalServerErrorException

Amazon Serverless Application Repository 服务遇到了内部错误。

删除

操作 ID: DeleteApplication

删除指定的应用程序。

路径参数
名称类型必需描述
applicationIdStringTrue

应用程序的 Amazon 资源名称 (ARN)。

响应
状态代码响应模型描述
204None

成功

400BadRequestException

请求中的参数之一无效。

403禁止的例外

客户端未经过身份验证。

404NotFoundException

请求中指定的资源(例如,访问策略语句)不存在。

409冲突异常

该资源已存在。

429TooManyRequestsException

客户端发送的请求超过了允许的每个单位时间的请求数。

500InternalServerErrorException

Amazon Serverless Application Repository 服务遇到了内部错误。

补丁

操作 ID: UpdateApplication

更新指定的应用程序。

路径参数
名称类型必需描述
applicationIdStringTrue

应用程序的 Amazon 资源名称 (ARN)。

响应
状态代码响应模型描述
200应用程序

成功

400BadRequestException

请求中的参数之一无效。

403禁止的例外

客户端未经过身份验证。

404NotFoundException

请求中指定的资源(例如,访问策略语句)不存在。

409冲突异常

该资源已存在。

429TooManyRequestsException

客户端发送的请求超过了允许的每个单位时间的请求数。

500InternalServerErrorException

Amazon Serverless Application Repository 服务遇到了内部错误。

Schemas

请求正文

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

属性

应用程序

有关程序的详细信息。

属性类型必需描述
applicationId

字符串

True

应用程序 Amazon 资源名称 (ARN)。

作者

字符串

True

发布应用程序的作者的姓名。

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

模式 "^ [a-z0-9] (([a-z0-9] ([a-z0-9] |-(?! * [a-z0-9])? $”;

creationTime

字符串

False

此资源的创建日期和时间。

description

字符串

True

关于应用程序的描述。

最小长度 = 1。最大长度 = 256

HomePageURLL

字符串

False

一个 URL,其中包含有关应用程序的更多信息例如,应用程序的 GitHub 存储库的位置。

我已验证作者

布尔值

False

指定此应用程序的作者是否已验证。这意味着Amazon作为合理而审慎的服务提供商对请求者提供的信息进行了诚实信用审查,并且确认请求者的身份与所声明的身份相同。

labels

类型的数组string

False

用于改善搜索结果中应用程序的发现的标签。

最小长度 = 1。最大长度 = 127。最大标签数量:10

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

许可证 URL

字符串

False

指向应用程序的许可证文件的链接,该文件与应用程序的 spdxLicSseID 值匹配。

最大大小 5 MB

名称

字符串

True

应用程序的名称。

最小长度 = 1。最大长度 = 140

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

ReadmeURL

字符串

False

指向 Markdown 语言的自述文件的链接,其中包含对应用程序及其工作原理的更详细描述。

最大大小 5 MB

SPDXLicSeID

字符串

False

https://spdx.org/licenses/ 的有效标识符。

已验证的作者 URL

字符串

False

经过验证的作者的公开个人资料的 URL。此 URL 由作者提交。

版本

Version

False

有关应用程序的版本信息。

BadRequestException

请求中的参数之一无效。

属性类型必需描述
errorCode

字符串

False

400

message

字符串

False

请求中的参数之一无效。

能力

为了部署某些应用程序,必须指定的值。

  • CAPABILITY_IAM

  • CAPABILITY_NAMED_IAM

  • CAPABILITY_AUTO_EXPAND

  • CAPABILITY_RESOURCE_POLICY

冲突异常

该资源已存在。

属性类型必需描述
errorCode

字符串

False

409

message

字符串

False

该资源已存在。

禁止的例外

客户端未经过身份验证。

属性类型必需描述
errorCode

字符串

False

403

message

字符串

False

客户端未经过身份验证。

InternalServerErrorException

Amazon Serverless Application Repository 服务遇到了内部错误。

属性类型必需描述
errorCode

字符串

False

500

message

字符串

False

Amazon Serverless Application Repository 服务遇到了内部错误。

NotFoundException

请求中指定的资源(例如,访问策略语句)不存在。

属性类型必需描述
errorCode

字符串

False

404

message

字符串

False

请求中指定的资源(例如,访问策略语句)不存在。

参数/定义

应用程序支持的参数。

属性类型必需描述
allowedPattern

字符串

False

一个正则表达式,表示要允许 String 类型使用的模式。

allowedValues

类型的数组string

False

包含参数允许值列表的阵列。

约束说明

字符串

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

字符串

False

模板适当类型的值,用于在创建堆栈时未指定值的情况下。如果您定义参数的约束,则必须指定一个符合这些约束的值。

description

字符串

False

用于描述参数的长度最多为 4,000 个字符的字符串。

MaxLength

integer

False

一个整数值,确定要允许的字符的最大数目。String类型。

MaxValue

integer

False

一个数字值,确定要允许使用的最大数字值。Number类型。

MinLength

integer

False

一个整数值,确定要允许的字符的最小数目。String类型。

minvalue

integer

False

一个数字值,确定要允许使用的最小数字值。Number类型。

名称

字符串

True

参数的名称。

NoEcho

布尔值

False

在有人发出描述堆栈的调用时是否掩蔽参数值。如果将值设置为 true,则使用星号 (*****) 遮蔽参数值。

由资源引用

类型的数组string

True

列表Amazon SAM使用此参数的资源。

type

字符串

False

参数的类型。

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

String一个文字字符串。

例如,用户可指定"MyUserName".

Number一个整数或浮点数。Amazon CloudFormation将参数值验证为数字。但当您在模板中的其他位置使用该参数时 (例如,通过使用Ref内在函数),参数值将变成字符串。

例如,用户可指定"8888".

List<Number>:一组用逗号分隔的整数或浮点数。Amazon CloudFormation将参数值验证为数字。但当您在模板中的其他位置使用该参数时 (例如,通过使用Ref内部函数),参数值将成为字符串列表。

例如,用户可能会指定 “80,20”,然后Ref结果["80","20"].

CommaDelimitedList:一组用逗号分隔的文本字符串。字符串的总数应比逗号总数多 1。此外,会对每个成员字符串进行空间修剪。

例如,用户可以指定 “测试、开发、prod”,然后Ref结果["test","dev","prod"].

TooManyRequestsException

客户端发送的请求超过了允许的每个单位时间的请求数。

属性类型必需描述
errorCode

字符串

False

429

message

字符串

False

客户端发送的请求超过了允许的每个单位时间的请求数。

更新应用程序输入

更新应用程序请求。

属性类型必需描述
作者

字符串

False

发布应用程序的作者的姓名。

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

模式 "^ [a-z0-9] (([a-z0-9] ([a-z0-9] |-(?! -) * [a-z0-9])? $”;

description

字符串

False

关于应用程序的描述。

最小长度 = 1。最大长度 = 256

HomePageURLL

字符串

False

一个 URL,其中包含有关应用程序的更多信息例如,应用程序的 GitHub 存储库的位置。

labels

类型的数组string

False

用于改善搜索结果中应用程序的发现的标签。

最小长度 = 1。最大长度 = 127。最大标签数量:10

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

ReadmeBody

字符串

False

Markdown 语言的文本自述文件,其中包含对应用程序及其工作原理的更详细描述。

最大大小 5 MB

ReadmeURL

字符串

False

指向 Markdown 语言的自述文件的链接,其中包含对应用程序及其工作原理的更详细描述。

最大大小 5 MB

版本

详细信息。

属性类型必需描述
applicationId

字符串

True

应用程序 Amazon 资源名称 (ARN)。

creationTime

字符串

True

此资源的创建日期和时间。

参数定义

类型的数组ParameterDefinition

True

应用程序支持的参数类型数组。

requiredCapabilities

类型的数组Capability

True

必须在可以部署某些应用程序之前指定的值列表。一些应用程序中包含的资源会影响您的中的权限。Amazon例如,通过创建新账户Amazon Identity and Access Management(IAM) 用户。对于这些应用程序,您必须指定此参数以显示确认它们的功能。

唯一有效值仅为CAPABILITY_IAMCAPABILITY_NAMED_IAMCAPABILITY_RESOURCE_POLICY, 和CAPABILITY_AUTO_EXPAND.

以下资源要求您指定CAPABILITY_IAM要么CAPABILITY_NAMED_IAMAWS::IAM::GroupAWS::IAM::InstanceProfileAWS::IAM::Policy, 和AWS::IAM::Role. 如果应用程序包含 IAM 资源,您可以指定任一内容:CAPABILITY_IAM要么CAPABILITY_NAMED_IAM. 如果应用程序包含具有自定义名称的 IAM 资源,您必须指定 CAPABILITY_NAMED_IAM

以下资源要求您指定CAPABILITY_RESOURCE_POLICYAWS::Lambda::PermissionAmazon። IAM: 政策AWS::ApplicationAutoScaling::ScalingPolicyAWS::S3::BucketPolicyAWS::SQS::QueuePolicy, 和AWS::SNS::TopicPolicy.

包含一个或多个嵌套应用程序的应用程序要求您指定 CAPABILITY_AUTO_EXPAND

如果应用程序模板包含以上任何资源,我们建议您在部署之前检查与应用程序关联的所有权限。如果您不为需要功能的应用程序指定此参数,则该调用将失败。

资源支持

布尔值

True

无论是所有Amazon该应用程序中包含的资源在检索该应用程序的地区受到支持。

语义版

字符串

True

应用程序的语义版本:

https://semver.org/;

源代码存档

字符串

False

指向 S3 对象的链接,其中包含此版本的应用程序源代码的 ZIP 存档。

最大大小 50 MB

源代码 URL

字符串

False

指向应用程序源代码的公共存储库的链接,如特定 GitHub 提交的 URL。

TemplateURL

字符串

True

指向包装的链接Amazon SAM应用程序的模板。