翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。 # Applications applicationId ## [URI] `/applications/applicationId` ## HTTP メソッド ### GET **オペレーション ID:** `GetApplication` 指定されたアプリケーションを入手します。 **パスパラメータ** | 名前 | 型 | 必須 | 説明 | | --- |--- |--- |--- | | applicationId | String | True | アプリケーションの Amazon リソースネーム (ARN) です。 | **クエリパラメータ** | 名前 | 型 | 必須 | 説明 | | --- |--- |--- |--- | | semanticVersion | String | False | 取得するアプリケーションのセマンティックバージョン。 | **レスポンス** | ステータスコード | レスポンスモデル | 説明 | | --- |--- |--- | | 200 | Application | Success | | 400 | BadRequestException | リクエストに含まれているパラメータの 1 つが無効です。 | | 403 | ForbiddenException | クライアントは認証されていません。 | | 404 | NotFoundException | リクエストで指定されたリソース (例えば、アクセスポリシーステートメント) は存在しません。 | | 429 | TooManyRequestsException | クライアントが、単位時間あたりの許可されるリクエスト数よりも多くのリクエストを送信しています。 | | 500 | InternalServerErrorException | AWS Serverless Application Repository サービスで内部エラーが発生しました。 | ### DELETE **オペレーション ID:** `DeleteApplication` 指定されたアプリケーションを削除します。 **パスパラメータ** | 名前 | 型 | 必須 | 説明 | | --- |--- |--- |--- | | applicationId | String | True | アプリケーションの Amazon リソースネーム (ARN) です。 | **レスポンス** | ステータスコード | レスポンスモデル | 説明 | | --- |--- |--- | | 204 | None | Success | | 400 | BadRequestException | リクエストに含まれているパラメータの 1 つが無効です。 | | 403 | ForbiddenException | クライアントは認証されていません。 | | 404 | NotFoundException | リクエストで指定されたリソース (例えば、アクセスポリシーステートメント) は存在しません。 | | 409 | ConflictException | リソースは既に存在します。 | | 429 | TooManyRequestsException | クライアントが、単位時間あたりの許可されるリクエスト数よりも多くのリクエストを送信しています。 | | 500 | InternalServerErrorException | AWS Serverless Application Repository サービスで内部エラーが発生しました。 | ### OPTIONS **パスパラメータ** | 名前 | 型 | 必須 | 説明 | | --- |--- |--- |--- | | applicationId | String | True | アプリケーションの Amazon リソースネーム (ARN) です。 | **レスポンス** | ステータスコード | レスポンスモデル | 説明 | | --- |--- |--- | | 200 | None | 200 レスポンス | ### PATCH **オペレーション ID:** `UpdateApplication` 指定されたアプリケーションを更新します。 **パスパラメータ** | 名前 | 型 | 必須 | 説明 | | --- |--- |--- |--- | | applicationId | String | True | アプリケーションの Amazon リソースネーム (ARN) です。 | **レスポンス** | ステータスコード | レスポンスモデル | 説明 | | --- |--- |--- | | 200 | Application | Success | | 400 | BadRequestException | リクエストに含まれているパラメータの 1 つが無効です。 | | 403 | ForbiddenException | クライアントは認証されていません。 | | 404 | NotFoundException | リクエストで指定されたリソース (例えば、アクセスポリシーステートメント) は存在しません。 | | 409 | ConflictException | リソースは既に存在します。 | | 429 | TooManyRequestsException | クライアントが、単位時間あたりの許可されるリクエスト数よりも多くのリクエストを送信しています。 | | 500 | InternalServerErrorException | AWS Serverless Application Repository サービスで内部エラーが発生しました。 | ## スキーマ ### リクエストボディ #### PATCH スキーマ ``` { "description": "string", "author": "string", "readmeBody": "string", "readmeUrl": "string", "labels": [ "string" ], "homePageUrl": "string" } ``` ### レスポンス本文 #### Application スキーマ ``` { "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 } } ``` #### BadRequestException スキーマ ``` { "message": "string", "errorCode": "string" } ``` #### ForbiddenException スキーマ ``` { "message": "string", "errorCode": "string" } ``` #### NotFoundException スキーマ ``` { "message": "string", "errorCode": "string" } ``` #### ConflictException スキーマ ``` { "message": "string", "errorCode": "string" } ``` #### TooManyRequestsException スキーマ ``` { "message": "string", "errorCode": "string" } ``` #### InternalServerErrorException スキーマ ``` { "message": "string", "errorCode": "string" } ``` ## プロパティ ### Application アプリケーションに関する詳細。 | プロパティ | タイプ | 必須 | 説明 | | --- |--- |--- |--- | | applicationId | string | True | アプリケーションの Amazon リソースネーム (ARN)。 | | author | string | True | アプリケーションを公開する作成者の名前。最小長 = 1。最大長 = 127。パターン: "^[a-z0-9](([a-z0-9]\$1-(?\$1-))\$1[a-z0-9])?\$1"; | | creationTime | string | False | このリソースが作成された日時。 | | 説明 | string | True | アプリケーションの説明。最小長 = 1。最大長 = 256。 | | homePageUrl | string | False | アプリケーションに関する詳細情報が含まれた URL。例えば、アプリケーションの GitHub リポジトリの場所などです。 | | isVerifiedAuthor | boolean | False | このアプリケーションの作成者が検証されているかどうかを指定します。つまり、 AWS は、合理的かつ慎重なサービスプロバイダーとして、リクエスタから提供された情報を誠実に確認し、リクエスタの ID が要求どおりであることを確認しています。 | | ラベル | string タイプの配列 | False | 検索結果でアプリケーションを発見しやすくするラベル。最小長 = 1。最大長 = 127。ラベルの最大数: 10。パターン: "^[a-zA-Z0-9\$1\$1\$1-\$1:\$1\$1/@]\$1\$1"; | | licenseUrl | string | False | アプリケーションの spdxLicenseID 値に一致するアプリケーションのライセンスファイルへのリンク。最大サイズ: 5 MB。 | | 名前 | string | True | アプリケーションの名前。最小長 = 1。最大長 = 140。パターン: "[a-zA-Z0-9\$1\$1-]\$1"; | | readmeUrl | string | False | Markdown 言語の readme ファイルへのリンク。アプリケーションとその動作に関する詳細な説明が含まれます。最大サイズ: 5 MB。 | | spdxLicenseId | string | False | https://spdx.org/licenses/ からの有効な識別子。 | | verifiedAuthorUrl | string | False | 検証済み作成者のパブリックプロファイルへの URL。この URL は作成者によって提出されます。 | | バージョン | [バージョン](#applications-applicationid-model-version) | False | アプリケーションに関するバージョン情報。 | ### BadRequestException リクエストに含まれているパラメータの 1 つが無効です。 | プロパティ | タイプ | 必須 | 説明 | | --- |--- |--- |--- | | errorCode | string | False | 400 | | メッセージ | string | False | リクエストに含まれているパラメータの 1 つが無効です。 | ### Capability 一部のアプリケーションをデプロイするために指定する必要がある値。 + `CAPABILITY_IAM` + `CAPABILITY_NAMED_IAM` + `CAPABILITY_AUTO_EXPAND` + `CAPABILITY_RESOURCE_POLICY` ### ConflictException リソースは既に存在します。 | プロパティ | タイプ | 必須 | 説明 | | --- |--- |--- |--- | | errorCode | string | False | 409 | | メッセージ | string | False | リソースは既に存在します。 | ### ForbiddenException クライアントは認証されていません。 | プロパティ | タイプ | 必須 | 説明 | | --- |--- |--- |--- | | errorCode | string | False | 403 | | メッセージ | string | False | クライアントは認証されていません。 | ### InternalServerErrorException AWS Serverless Application Repository サービスで内部エラーが発生しました。 | プロパティ | タイプ | 必須 | 説明 | | --- |--- |--- |--- | | errorCode | string | False | 500 | | メッセージ | string | False | AWS Serverless Application Repository サービスで内部エラーが発生しました。 | ### NotFoundException リクエストで指定されたリソース (例えば、アクセスポリシーステートメント) は存在しません。 | プロパティ | タイプ | 必須 | 説明 | | --- |--- |--- |--- | | errorCode | string | False | 404 | | メッセージ | string | False | リクエストで指定されたリソース (例えば、アクセスポリシーステートメント) は存在しません。 | ### ParameterDefinition アプリケーションでサポートされるパラメータ。 | プロパティ | タイプ | 必須 | 説明 | | --- |--- |--- |--- | | 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 | スタックの作成時に値を指定しなかった場合に、テンプレートで使用される適切な型の値。パラメーターの制約を定義する場合は、これらの制約に従う値を指定する必要があります。 | | 説明 | string | False | パラメータについて説明する最大 4000 文字の文字列。 | | maxLength | integer | False | `String` タイプに使用できる最大文字数を決定する整数値。 | | maxValue | integer | False | `Number` タイプに使用できる数値の最大値を決定する数値。 | | minLength | integer | False | `String` タイプに使用できる最小文字数を決定する整数値。 | | minValue | integer | False | `Number` タイプに使用できる数値の最小値を決定する数値。 | | 名前 | string | True | パラメータの名前。 | | noEcho | boolean | False | スタックの詳細を取得する呼び出しが他のユーザーによって作成された場合に、必ずパラメータ値をマスクするかどうか。値を true に設定すると、パラメータ値はアスタリスク (\$1\$1\$1\$1\$1) でマスクされます。 | | referencedByResources | string タイプの配列 | True | このパラメータを使用する AWS SAM リソースのリスト。 | | 型 | string | False | パラメータのタイプ。有効な値: `String \| Number \| List \| CommaDelimitedList` `String`: リテラル文字列。例えば、`"MyUserName"` と指定することができます。 `Number`: 整数または float. CloudFormation validates the parameter value as a number。ただし、テンプレート内の他の場所で使用した場合には (`Ref` 組み込み関数を使用した場合など) 文字列として扱います。例えば、`"8888"` のように指定することがができます。 `List`: カンマで区切られた整数または浮動小数値の配列。 CloudFormation はパラメータ値を数値として検証します。ただし、テンプレート内の他の場所で使用した場合には (`Ref` 組み込み関数を使用した場合など) 文字列のリストとして扱います。例えば、「80,20」を指定すると、`Ref` は `["80","20"]` になります。 `CommaDelimitedList`: カンマで区切られたリテラル文字列の配列。文字列の合計数は、カンマの合計数よりも 1 つ多いはずです。また、各メンバー文字列の前後の空白は削除されます。例えば、「test,dev,prod」を指定すると、`Ref` は `["test","dev","prod"]` になります。 | ### TooManyRequestsException クライアントが、単位時間あたりの許可されるリクエスト数よりも多くのリクエストを送信しています。 | プロパティ | タイプ | 必須 | 説明 | | --- |--- |--- |--- | | errorCode | string | False | 429 | | メッセージ | string | False | クライアントが、単位時間あたりの許可されるリクエスト数よりも多くのリクエストを送信しています。 | ### UpdateApplicationInput アプリケーションリクエストを更新します。 | プロパティ | タイプ | 必須 | 説明 | | --- |--- |--- |--- | | author | string | False | アプリケーションを公開する作成者の名前。最小長 = 1。最大長 = 127。パターン: "^[a-z0-9](([a-z0-9]\$1-(?\$1-))\$1[a-z0-9])?\$1"; | | 説明 | string | False | アプリケーションの説明。最小長 = 1。最大長 = 256。 | | homePageUrl | string | False | アプリケーションに関する詳細情報が含まれた URL。例えば、アプリケーションの GitHub リポジトリの場所などです。 | | ラベル | string タイプの配列 | False | 検索結果でアプリケーションを発見しやすくするラベル。最小長 = 1。最大長 = 127。ラベルの最大数: 10。パターン: "^[a-zA-Z0-9\$1\$1\$1-\$1:\$1\$1/@]\$1\$1"; | | readmeBody | string | False | Markdown 言語のテキスト readme ファイル。アプリケーションとその動作に関する詳細な説明が含まれます。最大サイズ: 5 MB。 | | readmeUrl | string | False | Markdown 言語の readme ファイルへのリンク。アプリケーションとその動作に関する詳細な説明が含まれます。最大サイズ: 5 MB。 | ### Version アプリケーションのバージョンの詳細。 | プロパティ | タイプ | 必須 | 説明 | | --- |--- |--- |--- | | applicationId | string | True | アプリケーションの Amazon リソースネーム (ARN)。 | | creationTime | string | True | このリソースが作成された日時。 | | parameterDefinitions | [ParameterDefinition](#applications-applicationid-model-parameterdefinition) タイプの配列 | True | アプリケーションでサポートされるパラメータタイプの配列。 | | requiredCapabilities | [Capability](#applications-applicationid-model-capability) タイプの配列 | True | 特定のアプリケーションをデプロイする前に指定する必要がある値のリスト。一部のアプリケーションには、新しい 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](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-group.html)、[AWS::IAM::InstanceProfile](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-instanceprofile.html)、[AWS::IAM::Policy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-policy.html)、および [AWS::IAM::Role](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html) の各リソースに対して指定する必要があります。アプリケーションに IAM リソースがある場合、`CAPABILITY_IAM` または `CAPABILITY_NAMED_IAM` のいずれかを指定できます。アプリケーションにカスタム名を持つ IAM リソースがある場合は、`CAPABILITY_NAMED_IAM` を指定する必要があります。以下のリソースでは、`CAPABILITY_RESOURCE_POLICY`: [AWS::Lambda::Permission](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-permission.html)、[AWS::IAM:Policy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-policy.html)、[AWS::ApplicationAutoScaling::ScalingPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-applicationautoscaling-scalingpolicy.html)、[AWS::S3::BucketPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-policy.html)、[AWS::SQS::QueuePolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sqs-policy.html)、および [AWS::SNS::TopicPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sns-policy.html) を指定する必要があります。1 つまたは複数のネストされたアプリケーションが含まれているアプリケーションでは、`CAPABILITY_AUTO_EXPAND` を指定する必要があります。アプリケーションテンプレートに前述のリソースが含まれている場合、デプロイする前にアプリケーションに関連付けられたすべてのアクセス許可を確認することをお勧めします。機能を必要とするアプリケーションにこのパラメータを指定しないと、呼び出しは失敗します。 | | resourcesSupported | boolean | True | このアプリケーションに含まれるすべての AWS リソースが、取得するリージョンでサポートされているかどうか。 | | semanticVersion | string | True | アプリケーションのセマンティックバージョン： [https://semver.org/](https://semver.org/) | | sourceCodeArchiveUrl | string | False | アプリケーションのこのバージョンのソースコードの ZIP アーカイブを含む S3 オブジェクトへのリンク。最大サイズ: 50 MB。 | | SourceCodeUrl | string | False | 特定の GitHub コミットの URL など、アプリケーションのソースコードのパブリックリポジトリへのリンク。 | | templateUrl | string | True | アプリケーションのパッケージ化された AWS SAM テンプレートへのリンク。 | ## 関連情報 言語固有の AWS SDKs とリファレンスのいずれかでこの API を使用する方法の詳細については、以下を参照してください。 ### GetApplication + [AWS コマンドラインインターフェイス V2](/goto/cli2/serverlessrepo-2017-09-08/GetApplication) + [AWS SDK for .NET V4](/goto/DotNetSDKV4/serverlessrepo-2017-09-08/GetApplication) + [AWS SDK for C\$1\$1](/goto/SdkForCpp/serverlessrepo-2017-09-08/GetApplication) + [AWS SDK for Go v2](/goto/SdkForGoV2/serverlessrepo-2017-09-08/GetApplication) + [AWS SDK for Java V2](/goto/SdkForJavaV2/serverlessrepo-2017-09-08/GetApplication) + [AWS SDK for JavaScript V3](/goto/SdkForJavaScriptV3/serverlessrepo-2017-09-08/GetApplication) + [AWS SDK for Kotlin](/goto/SdkForKotlin/serverlessrepo-2017-09-08/GetApplication) + [AWS SDK for PHP V3](/goto/SdkForPHPV3/serverlessrepo-2017-09-08/GetApplication) + [AWS SDK for Python](/goto/boto3/serverlessrepo-2017-09-08/GetApplication) + [AWS SDK for Ruby v3](/goto/SdkForRubyV3/serverlessrepo-2017-09-08/GetApplication) ### DeleteApplication + [AWS コマンドラインインターフェイス V2](/goto/cli2/serverlessrepo-2017-09-08/DeleteApplication) + [AWS SDK for .NET V4](/goto/DotNetSDKV4/serverlessrepo-2017-09-08/DeleteApplication) + [AWS SDK for C\$1\$1](/goto/SdkForCpp/serverlessrepo-2017-09-08/DeleteApplication) + [AWS SDK for Go v2](/goto/SdkForGoV2/serverlessrepo-2017-09-08/DeleteApplication) + [AWS SDK for Java V2](/goto/SdkForJavaV2/serverlessrepo-2017-09-08/DeleteApplication) + [AWS SDK for JavaScript V3](/goto/SdkForJavaScriptV3/serverlessrepo-2017-09-08/DeleteApplication) + [AWS SDK for Kotlin](/goto/SdkForKotlin/serverlessrepo-2017-09-08/DeleteApplication) + [AWS SDK for PHP V3](/goto/SdkForPHPV3/serverlessrepo-2017-09-08/DeleteApplication) + [AWS SDK for Python](/goto/boto3/serverlessrepo-2017-09-08/DeleteApplication) + [AWS SDK for Ruby v3](/goto/SdkForRubyV3/serverlessrepo-2017-09-08/DeleteApplication) ### UpdateApplication + [AWS コマンドラインインターフェイス V2](/goto/cli2/serverlessrepo-2017-09-08/UpdateApplication) + [AWS SDK for .NET V4](/goto/DotNetSDKV4/serverlessrepo-2017-09-08/UpdateApplication) + [AWS SDK for C\$1\$1](/goto/SdkForCpp/serverlessrepo-2017-09-08/UpdateApplication) + [AWS SDK for Go v2](/goto/SdkForGoV2/serverlessrepo-2017-09-08/UpdateApplication) + [AWS SDK for Java V2](/goto/SdkForJavaV2/serverlessrepo-2017-09-08/UpdateApplication) + [AWS SDK for JavaScript V3](/goto/SdkForJavaScriptV3/serverlessrepo-2017-09-08/UpdateApplication) + [AWS SDK for Kotlin](/goto/SdkForKotlin/serverlessrepo-2017-09-08/UpdateApplication) + [AWS SDK for PHP V3](/goto/SdkForPHPV3/serverlessrepo-2017-09-08/UpdateApplication) + [AWS SDK for Python](/goto/boto3/serverlessrepo-2017-09-08/UpdateApplication) + [AWS SDK for Ruby v3](/goto/SdkForRubyV3/serverlessrepo-2017-09-08/UpdateApplication)