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

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

アプリケーション applicationId

URI

/applications/applicationId

HTTP メソッド

GET

オペレーション ID: GetApplication

指定されたアプリケーションを入手します。

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

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

クエリパラメータ
名前型必須説明
semanticVersion文字列False

取得するアプリケーションのセマンティックバージョン。

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

成功

400BadRequestException

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

403ForbiddenException

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

404NotFoundException

リクエストで指定されたリソース (例えば、アクセスポリシーステートメント) は存在しません。

429TooManyRequestsException

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

500InternalServerErrorException

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

DELETE

オペレーション ID: DeleteApplication

指定されたアプリケーションを削除します。

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

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

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

成功

400BadRequestException

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

403ForbiddenException

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

404NotFoundException

リクエストで指定されたリソース (例えば、アクセスポリシーステートメント) は存在しません。

409ConflictException

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

429TooManyRequestsException

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

500InternalServerErrorException

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

OPTIONS

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

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

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

200 レスポンス

PATCH

オペレーション ID: UpdateApplication

指定されたアプリケーションを更新します。

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

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

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

成功

400BadRequestException

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

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

アプリケーションに関する詳細。

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

string

True

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

author

string

True

アプリケーションを公開する作成者の名前。

最小長: 1 最大長 = 127。

パターン: "^[a-z0-9](([a-z0-9]|-(?!-))*[a-z0-9])?$";

creationTime

string

False

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

description

string

True

アプリケーションの説明。

最小長: 1 最大長 = 256。

homePageUrl

string

False

アプリケーションの GitHub リポジトリの場所など、アプリケーションに関する詳細情報URLを含む 。

isVerifiedAuthor

ブール値

False

このアプリケーションの作成者が検証されているかどうかを指定します。つまり、 AWS は、合理的かつ慎重なサービスプロバイダーとして、リクエスタから提供された情報を誠実に確認し、リクエスタのアイデンティティがクレーム済みであることを確認しました。

labels

タイプの配列 string

False

検索結果でアプリケーションを発見しやすくするラベル。

最小長: 1 最大長 = 127。ラベルの最大数: 10。

パターン: "^[a-zA-Z0-9+\\-_:\\/@]+$";

licenseUrl

string

False

アプリケーションの spdxLicenseID 値と一致するアプリケーションのライセンスファイルへのリンク。

最大サイズ: 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

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

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

string

False

400

message

string

False

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

Capability

一部のアプリケーションをデプロイするために指定する必要がある値。

  • CAPABILITY_IAM

  • CAPABILITY_NAMED_IAM

  • CAPABILITY_AUTO_EXPAND

  • CAPABILITY_RESOURCE_POLICY

ConflictException

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

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

string

False

409

message

string

False

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

ForbiddenException

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

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

string

False

403

message

string

False

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

InternalServerErrorException

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

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

string

False

500

message

string

False

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

NotFoundException

リクエストで指定されたリソース (例えば、アクセスポリシーステートメント) は存在しません。

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

string

False

404

message

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

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

description

string

False

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

maxLength

integer

False

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

maxValue

integer

False

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

minLength

integer

False

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

minValue

integer

False

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

name

string

True

パラメータの名前。

noEcho

ブール値

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

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

TooManyRequestsException

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

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

string

False

429

message

string

False

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

UpdateApplicationInput

アプリケーションリクエストを更新します。

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

string

False

アプリケーションを公開する作成者の名前。

最小長: 1 最大長 = 127。

パターン: "^[a-z0-9](([a-z0-9]|-(?!-))*[a-z0-9])?$";

description

string

False

アプリケーションの説明。

最小長: 1 最大長 = 256。

homePageUrl

string

False

アプリケーションの GitHub リポジトリの場所など、アプリケーションに関する詳細情報URLを含む 。

labels

タイプの配列 string

False

検索結果でアプリケーションを発見しやすくするラベル。

最小長: 1 最大長 = 127。ラベルの最大数: 10。

パターン: "^[a-zA-Z0-9+\\-_:\\/@]+$";

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

True

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

requiredCapabilities

タイプの配列 機能

True

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

有効な値は、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 を指定する必要があります。

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

resourcesSupported

ブール値

True

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

semanticVersion

string

True

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

https://semver.org/

sourceCodeArchiveUrl

string

False

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

最大サイズ: 50 MB。

sourceCodeUrl

string

False

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

templateUrl

string

True

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

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

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

GetApplication

DeleteApplication

UpdateApplication