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

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

アプリケーション applicationId の変更セット

URI

/applications/applicationId/changesets

HTTP メソッド

POST

オペレーション ID: CreateCloudFormationChangeSet

指定されたアプリケーション AWS CloudFormation の変更セットを作成します。

パスパラメータ
名前型必須説明
applicationId文字列True

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

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

成功

400BadRequestException

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

403ForbiddenException

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

429TooManyRequestsException

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

500InternalServerErrorException

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

OPTIONS

パスパラメータ
名前型必須説明
applicationId文字列True

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

レスポンス
ステータスコードレスポンスモデル説明
200なし

200 レスポンス

スキーマ

リクエストボディ

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

レスポンス本文

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

プロパティ

BadRequestException

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

プロパティタイプ必須説明
errorCode

string

False

400

message

string

False

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

ChangeSetDetails

変更セットの詳細。

プロパティタイプ必須説明
applicationId

string

True

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

changeSetId

string

True

変更セットの Amazon リソースネーム (ARN）。

長さの制限: 最小長は 1 です。

パターン: ARN:[-a-zA-Z0-9:/]*

semanticVersion

string

True

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

https://semver.org/

stackId

string

True

スタックの一意の ID。

CreateCloudFormationChangeSetInput

アプリケーション変更セットリクエストを作成します。

プロパティタイプ必須説明
capabilities

string タイプの配列

False

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

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

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

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

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

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

changeSetName

string

False

このプロパティは、 の同じ名前の AWS CloudFormation CreateChangeSet パラメータに対応しますAPI。

clientToken

string

False

このプロパティは、 の同じ名前の AWS CloudFormation CreateChangeSet パラメータに対応しますAPI。

description

string

False

このプロパティは、 の同じ名前の AWS CloudFormation CreateChangeSet パラメータに対応しますAPI。

notificationArns

string タイプの配列

False

このプロパティは、 の同じ名前の AWS CloudFormation CreateChangeSet パラメータに対応しますAPI。

parameterOverrides

ParameterValue タイプの配列

False

アプリケーションのパラメータのパラメータ値のリスト。

resourceTypes

string タイプの配列

False

このプロパティは、 の同じ名前の AWS CloudFormation CreateChangeSet パラメータに対応しますAPI。

rollbackConfiguration

RollbackConfiguration

False

このプロパティは、 の同じ名前の AWS CloudFormation CreateChangeSet パラメータに対応しますAPI。

semanticVersion

string

False

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

https://semver.org/

stackName

string

True

このプロパティは、 の同じ名前の AWS CloudFormation CreateChangeSet パラメータに対応しますAPI。

tags

Tag タイプの配列

False

このプロパティは、 の同じ名前の AWS CloudFormation CreateChangeSet パラメータに対応しますAPI。

templateId

string

False

によってUUID返される CreateCloudFormationTemplate。

パターン: [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

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

プロパティタイプ必須説明
errorCode

string

False

403

message

string

False

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

InternalServerErrorException

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

プロパティタイプ必須説明
errorCode

string

False

500

message

string

False

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

ParameterValue

アプリケーションのパラメータ値。

プロパティタイプ必須説明
name

string

True

パラメータに関連付けられたキー。特定のパラメータにキーと値が指定されていない場合、 AWS CloudFormation はテンプレートに指定されているデフォルト値を使用します。

value

string

True

パラメータに関連付けられた入力値。

RollbackConfiguration

このプロパティは AWS CloudFormation RollbackConfiguration データ型に対応します。

プロパティタイプ必須説明
monitoringTimeInMinutes

integer

False

このプロパティは、AWS CloudFormation RollbackConfigurationデータ型の同じ名前の内容に対応します。

rollbackTriggers

RollbackTrigger タイプの配列

False

このプロパティは、AWS CloudFormation RollbackConfigurationデータ型の同じ名前の内容に対応します。

RollbackTrigger

このプロパティは AWS CloudFormation RollbackTrigger データ型に対応します。

プロパティタイプ必須説明
arn

string

True

このプロパティは、AWS CloudFormation RollbackTriggerデータ型の同じ名前の内容に対応します。

type

string

True

このプロパティは、AWS CloudFormation RollbackTriggerデータ型の同じ名前の内容に対応します。

Tag

このプロパティは AWS CloudFormation Tag データタイプに対応します。

プロパティタイプ必須説明
key

string

True

このプロパティは、AWS CloudFormation Tag データタイプの同じ名前のコンテンツに対応します。

value

string

True

このプロパティは、AWS CloudFormation Tag データタイプの同じ名前のコンテンツに対応します。

TooManyRequestsException

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

プロパティタイプ必須説明
errorCode

string

False

429

message

string

False

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

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

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

CreateCloudFormationChangeSet