アプリケーション applicationId バージョン semanticVersion - AWS Serverless Application Repository
URIHTTP メソッド スキーマプロパティ以下も参照してください。

翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

アプリケーション applicationId バージョン semanticVersion

URI

/applications/applicationId/versions/semanticVersion

HTTP メソッド

PUT

オペレーション ID: CreateApplicationVersion

アプリケーションバージョンを作成します。

パスパラメータ
名前タイプ必須説明
applicationId文字列真

アプリケーションの Amazon リソースネーム (ARN）。

semanticVersion文字列真

新しいバージョンのセマンティックバージョン。

レスポンス
ステータスコードレスポンスモデル説明
201Version

Success (成功)

400BadRequestException

リクエストに含まれているパラメータの 1 つが無効です。

403ForbiddenException

クライアントは認証されていません。

409ConflictException

リソースは既に存在します。

429TooManyRequestsException

クライアントが、単位時間あたりの許可されるリクエスト数よりも多くのリクエストを送信しています。

500InternalServerErrorException

AWS Serverless Application Repository サービスで内部エラーが発生しました。

OPTIONS

パスパラメータ
名前タイプ必須説明
applicationId文字列真

アプリケーションの Amazon リソースネーム (ARN）。

semanticVersion文字列真

新しいバージョンのセマンティックバージョン。

レスポンス
ステータスコードレスポンスモデル説明
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

リクエストに含まれているパラメータの 1 つが無効です。

プロパティType必須説明
errorCode

string

False

400

message

string

False

リクエストに含まれているパラメータの 1 つが無効です。

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

このバージョンのアプリケーションのソースコードのZIPアーカイブを含む S3 オブジェクトへのリンク。

最大サイズ: 50 MB。

sourceCodeUrl

string

False

URL 特定の GitHub コミットの など、アプリケーションのソースコードのパブリックリポジトリへのリンク。

templateBody

string

False

アプリケーションのパッケージ化された raw 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]+

「must contain only uppercase and lowercase letters and numbers」などの制約の説明を追加することによって、次のようにカスタマイズされたエラーメッセージを表示することができます。

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

defaultValue

string

False

スタックの作成時に値を指定しなかった場合に、テンプレートで使用される適切な型の値。パラメーターの制約を定義する場合は、これらの制約に従う値を指定する必要があります。

description

string

False

パラメータについて説明する最大 4000 文字の文字列。

maxLength

integer

False

String タイプに使用できる最大文字数を決定する整数値。

maxValue

integer

False

Number タイプに使用できる数値の最大値を決定する数値。

minLength

integer

False

String タイプに使用できる最小文字数を決定する整数値。

minValue

integer

False

Number タイプに使用できる数値の最小値を決定する数値。

name

string

真

パラメータの名前。

noEcho

ブール値

False

スタックの詳細を取得する呼び出しが他のユーザーによって作成された場合に、必ずパラメータ値をマスクするかどうか。値を true に設定すると、パラメータ値はアスタリスク (*****) でマスクされます。

referencedByResources

タイプの配列 string

真

このパラメータを使用する AWS SAM リソースのリスト。

type

string

False

パラメータのタイプ。

有効な値: String | Number | List<Number> | CommaDelimitedList

String: リテラル文字列。

例えば、"MyUserName" と指定することができます。

Number: 整数または float. AWS CloudFormation validates the parameter value as a number。ただし、テンプレート内の他の場所で使用した場合には (Ref 組み込み関数を使用した場合など) 文字列として扱います。

例えば、"8888" のように指定することがができます。

List<Number>: カンマで区切られた整数または浮動小数値の配列。 AWS CloudFormation はパラメータ値を数値として検証します。ただし、テンプレート内の他の場所で使用した場合には (Ref 組み込み関数を使用した場合など) 文字列のリストとして扱います。

例えば、「80,20」を指定すると、Ref は ["80","20"] になります。

CommaDelimitedList: カンマで区切られたリテラル文字列の配列。文字列の合計数は、カンマの合計数よりも 1 つ多いはずです。また、各メンバー文字列の前後の空白は削除されます。

例えば、「test,dev,prod」を指定すると、Ref は ["test","dev","prod"] になります。

TooManyRequestsException

クライアントが、単位時間あたりの許可されるリクエスト数よりも多くのリクエストを送信しています。

プロパティType必須説明
errorCode

string

False

429

message

string

False

クライアントが、単位時間あたりの許可されるリクエスト数よりも多くのリクエストを送信しています。

Version

アプリケーションのバージョンの詳細。

プロパティType必須説明
applicationId

string

真

アプリケーションの Amazon リソースネーム (ARN）。

creationTime

string

真

このリソースが作成された日時。

parameterDefinitions

タイプの配列 ParameterDefinition

真

アプリケーションでサポートされるパラメータタイプの配列。

requiredCapabilities

タイプの配列 機能

真

特定のアプリケーションをデプロイする前に指定する必要がある値のリスト。一部のアプリケーションには、新しい AWS Identity and Access Management （IAM) ユーザーを作成するなど、 AWS アカウントのアクセス許可に影響を与えるリソースが含まれている場合があります。このようなアプリケーションの場合は、このパラメータを指定して、それらの機能を明示的に認識する必要があります。

有効な値は、CAPABILITY_IAM、CAPABILITY_NAMED_IAM、CAPABILITY_RESOURCE_POLICY、および CAPABILITY_AUTO_EXPAND のみです。

次のリソースでは、 CAPABILITY_IAMまたは を指定する必要がありますCAPABILITY_NAMED_IAM。AWS::IAM::Group、AWS::IAM::InstanceProfile：、AWS::IAM::Policy、および AWS::IAM::Role。アプリケーションにIAMリソースが含まれている場合は、 CAPABILITY_IAMまたは を指定できますCAPABILITY_NAMED_IAM。アプリケーションにカスタム名のIAMリソースが含まれている場合は、 を指定する必要がありますCAPABILITY_NAMED_IAM。

次のリソースでは、CAPABILITY_RESOURCE_POLICYAWS::Lambda::Permission、AWS::IAM:Policy、AWS::ApplicationAutoScaling：ScalingPolicy：、AWS::S3::BucketPolicy、AWS::SQS：QueuePolicy、および AWS::SNS::TopicPolicy を指定する必要があります。

1 つまたは複数のネストされたアプリケーションが含まれているアプリケーションでは、CAPABILITY_AUTO_EXPAND を指定する必要があります。

アプリケーションテンプレートに前述のリソースが含まれている場合、デプロイする前にアプリケーションに関連付けられたすべてのアクセス許可を確認することをお勧めします。機能を必要とするアプリケーションにこのパラメータを指定しないと、呼び出しは失敗します。

resourcesSupported

ブール値

真

このアプリケーションに含まれるすべての AWS リソースが、取得されるリージョンでサポートされているかどうか。

semanticVersion

string

真

アプリケーションのセマンティックバージョン：

https://semver.org/

sourceCodeArchiveUrl

string

False

このバージョンのアプリケーションのソースコードのZIPアーカイブを含む S3 オブジェクトへのリンク。

最大サイズ: 50 MB。

sourceCodeUrl

string

False

URL 特定の GitHub コミットの など、アプリケーションのソースコードのパブリックリポジトリへのリンク。

templateUrl

string

真

アプリケーションのパッケージ化された AWS SAM テンプレートへのリンク。

以下も参照してください。

言語固有の AWS SDKs および リファレンスのいずれかAPIでこれを使用する方法の詳細については、以下を参照してください。

CreateApplicationVersion