> For the complete documentation index, see [llms.txt](/llms.txt)
# GS2-Deploy SDK API リファレンス
各種プログラミング言語向け GS2-Deploy SDK の モデルの仕様 と API のリファレンス
## モデル
### GitHubCheckoutSetting
GitHubからマスターデータをチェックアウトする設定
GitHub リポジトリからテンプレートやマスターデータファイルを直接取得するための設定です。コミットハッシュ・ブランチ名・タグ名による参照をサポートし、認証には GS2-Key の GitHub API キーが必要です。
| | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 |
| --- | --- | --- | --- | --- | --- | --- |
| apiKeyId | string | | ✓ | | ~ 1024文字 | GitHub APIキーのGRN |
| repositoryName | string | | ✓ | | ~ 1024文字 | リポジトリ名
ファイルを取得する GitHub リポジトリ名です。"owner/repo" 形式で指定します。 |
| sourcePath | string | | ✓ | | ~ 1024文字 | マスターデータ（JSON）ファイルのパス
リポジトリ内の対象ファイルへのファイルパスです。例えば、"data/master.json" や "deploy/template.yaml" のように指定します。 |
| referenceType | 文字列列挙型
enum {
"commit_hash",
"branch",
"tag"
}
| | ✓ | | | コードの取得元
ファイルのチェックアウトに使用する Git 参照の種類です。`commit_hash` は再現性のために特定のコミットから取得、`branch` はブランチの最新を取得、`tag` はタグ付きリリースから取得します。"commit_hash": コミットハッシュ / "branch": ブランチ / "tag": タグ / |
| commitHash | string | {referenceType} == "commit_hash" | ✓※ | | ~ 1024文字 | コミットハッシュ
チェックアウトする Git コミットの完全な SHA です。常に同一バージョンのファイルが取得されることを保証し、デプロイの再現性を提供します。
※ referenceType が "commit_hash" であれば 必須 |
| branchName | string | {referenceType} == "branch" | ✓※ | | ~ 1024文字 | ブランチ名
チェックアウトする Git ブランチ名です。このブランチの最新コミットからファイルが取得されます。
※ referenceType が "branch" であれば 必須 |
| tagName | string | {referenceType} == "tag" | ✓※ | | ~ 1024文字 | タグ名
チェックアウトする Git タグ名です。タグは通常リリースバージョンのマークに使用され、デプロイの安定した参照ポイントを提供します。
※ referenceType が "tag" であれば 必須 |
**関連するメソッド:**
createStackFromGitHub - GitHub からスタックを新規作成
updateStackFromGitHub - GitHub からスタックを更新
---
### Resource
リソース
リソースはスタックによって管理される個々の GS2 サービスエンティティを表します。
各リソースはスタックテンプレートで定義された GS2 API リソース（ネームスペースやモデルなど）に対応します。
| | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 |
| --- | --- | --- | --- | --- | --- | --- |
| resourceId | string | | ※ | | ~ 1024文字 | リソースGRN
※ サーバーが自動で設定 |
| type | string | | ✓ | | ~ 1024文字 | リソースの種類
GS2 リソースタイプの識別子です（例: "GS2::Inventory::Namespace"、"GS2::Experience::ExperienceModel"）。このリソースの作成・更新・削除時にどの GS2 API が呼び出されるかを決定します。 |
| name | string | | ✓ | | ~ 128文字 | リソース名
スタックテンプレート内でこのリソースに割り当てられた論理名です。テンプレート内での依存関係の解決やアウトプットフィールドのマッピングにおいてリソースを参照するために使用されます。 |
| request | string | | ✓ | | ~ 1048576文字 | リクエストパラメータ
このリソースの作成・更新に使用する JSON シリアライズされた API リクエストパラメータです。 |
| response | string | | ✓ | | ~ 1048576文字 | リソースの作成・更新のレスポンス
リソースの作成・更新時に返された JSON シリアライズされた API レスポンスです。生成された ID やデフォルト値を含む実際のリソース状態が格納されます。 |
| rollbackContext | 文字列列挙型
enum {
"create",
"update",
"delete"
}
| | | | | ロールバック操作の種類
このリソースのロールバック時に実行する操作の種類です。`create` はリソースが新規作成されたためロールバック時に削除、`update` はリソースが変更されたため元に戻す、`delete` はリソースが削除されたため再作成することを意味します。"create": Create / "update": Update / "delete": Delete / |
| rollbackRequest | string | | | | ~ 1048576文字 | ロールバック用のリクエストパラメータ
このリソースのロールバック時に使用する JSON シリアライズされた API リクエストパラメータです。更新されたリソースの場合は復元する以前の状態、削除されたリソースの場合は再作成するための作成パラメータが格納されます。 |
| rollbackAfter | List<string> | | | [] | 0 ~ 1000 items | ロールバック時に依存しているリソースの名前
このリソースより先にロールバックする必要があるリソース名のリストです。整合性を維持するためにロールバック操作が正しい依存順序で実行されることを保証します。 |
| outputFields | [List<OutputField>](#outputfield) | | | [] | 0 ~ 1000 items | リソースを作成したときに Output に記録するフィールド
API レスポンスからどのフィールドを抽出してスタックのアウトプットとして保存するかを指定します。各エントリはアウトプット名をレスポンス内のフィールドパスにマッピングし、他のスタックや外部システムが作成されたリソースの値を参照できるようにします。 |
| workId | string | | ✓ | | ~ 1024文字 | このリソースが作成された時の実行 ID
このリソースをプロビジョニングしたスタック操作（作成/更新）の一意な識別子です。 |
| createdAt | long | | ※ | 現在時刻 | | 作成日時
UNIX 時間・ミリ秒
※ サーバーが自動で設定 |
**関連するメソッド:**
describeResources - リソースの一覧を取得
getResource - リソースを取得
---
### Event
イベント
スタック内のリソースの作成、更新、削除などの操作が行われる際、情報を提供するためにイベントが生成されます。
スタックのデプロイプロセスやリソースの変更がどのように進行しているかを開発者がモニタリングし、必要な対応を行うことができます。
| | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 |
| --- | --- | --- | --- | --- | --- | --- |
| eventId | string | | ※ | | ~ 1024文字 | イベントGRN
※ サーバーが自動で設定 |
| name | string | | ✓ | UUID | ~ 36文字 | イベント名
イベントの一意な名前を保持します。
名前はUUID（Universally Unique Identifier）フォーマットで自動的に生成され、各イベントを識別するために使用されます。 |
| resourceName | string | | ✓ | | ~ 128文字 | リソース名
スタックテンプレート内でこのリソースに割り当てられた論理名です。テンプレート内での依存関係の解決やアウトプットフィールドのマッピングにおいてリソースを参照するために使用されます。 |
| type | 文字列列挙型
enum {
"CREATE_IN_PROGRESS",
"CREATE_COMPLETE",
"CREATE_FAILED",
"UPDATE_IN_PROGRESS",
"UPDATE_COMPLETE",
"UPDATE_FAILED",
"CLEAN_IN_PROGRESS",
"CLEAN_COMPLETE",
"CLEAN_FAILED",
"DELETE_IN_PROGRESS",
"DELETE_COMPLETE",
"DELETE_FAILED",
"ROLLBACK_IN_PROGRESS",
"ROLLBACK_COMPLETE",
"ROLLBACK_FAILED"
}
| | ✓ | | | 状態
リソース操作の現在の状態を示すイベントの種類です。個々のリソースに対する作成・更新・クリーン・削除・ロールバック操作の処理中・完了・失敗の状態を追跡します。"CREATE_IN_PROGRESS": 作成中 / "CREATE_COMPLETE": 作成完了 / "CREATE_FAILED": 作成失敗 / "UPDATE_IN_PROGRESS": 更新中 / "UPDATE_COMPLETE": 更新完了 / "UPDATE_FAILED": 更新失敗 / "CLEAN_IN_PROGRESS": リソース削除中 / "CLEAN_COMPLETE": リソース削除完了 / "CLEAN_FAILED": リソース削除失敗 / "DELETE_IN_PROGRESS": 削除中 / "DELETE_COMPLETE": 削除完了 / "DELETE_FAILED": 削除失敗 / "ROLLBACK_IN_PROGRESS": ロールバック中 / "ROLLBACK_COMPLETE": ロールバック完了 / "ROLLBACK_FAILED": ロールバック失敗 / |
| message | string | | | | ~ 5242880文字 | メッセージ
イベントの詳細を説明するメッセージです。失敗した操作の場合、リソース操作が失敗した理由を説明するエラーメッセージが含まれます。成功した操作の場合、完了したアクションに関する追加のコンテキストが含まれることがあります。 |
| eventAt | long | | ※ | 現在時刻 | | 作成日時
UNIX 時間・ミリ秒
※ サーバーが自動で設定 |
| revision | long | | | 0 | 0 ~ 9223372036854775805 | リビジョン |
**関連するメソッド:**
describeEvents - イベントの一覧を取得
getEvent - イベントを取得
---
### Output
スタックによって作成される出力
スタックの Outputs セクションに記録したいデータを記載することで、このモデルを使用して出力を作成できます。
たとえば、クレデンシャルを作成する際にクライアントシークレットは作成した瞬間にしか確認できませんが、その内容を出力として記録することで後でクライアントシークレットの値を参照することができるようになります。
| | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 |
| --- | --- | --- | --- | --- | --- | --- |
| outputId | string | | ※ | | ~ 1024文字 | アウトプットGRN
※ サーバーが自動で設定 |
| name | string | | ✓ | | ~ 1024文字 | アウトプット名
スタックテンプレートの Outputs セクションで定義されたアウトプットの論理名です。他のスタックや外部システムからこのアウトプット値を参照するために使用されます。 |
| value | string | | | | ~ 1048576文字 | 値
リソースの API レスポンスから抽出された実際のアウトプット値です。例えば、リソース作成時に生成されたクライアントシークレットやリソース ARN など、後から参照可能な値が格納されます。 |
| createdAt | long | | ※ | 現在時刻 | | 作成日時
UNIX 時間・ミリ秒
※ サーバーが自動で設定 |
**関連するメソッド:**
describeOutputs - アウトプットの一覧を取得
getOutput - アウトプットを取得
---
### Stack
スタック
スタックとは GS2-Deploy を利用してGS2上のリソースをセットアップするエンティティです。
スタックにはテンプレートファイルを指定するようになっており、テンプレートファイルには GS2 上で必要となるリソースを定義します。
GS2-Deploy はスタックを新規作成または更新する際にはテンプレートファイルの変更点を検出し、追加があればリソースを作成、変更があればリソースを更新、削除があればリソースを削除します。
この仕組みを利用することで、GS2上のリソースを宣言的に記述し、再現可能な状態で管理することが可能となります。
この再現性があることで、開発環境から本番環境に設定を移行する際などにミスなく実行できるようになります。
| | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 |
| --- | --- | --- | --- | --- | --- | --- |
| stackId | string | | ※ | | ~ 1024文字 | スタックGRN
※ サーバーが自動で設定 |
| name | string | | ✓ | | ~ 128文字 | スタック名
スタックを識別する一意な名前です。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。作成・更新・削除操作時にスタックを参照するために使用されます。 |
| description | string | | | | ~ 1024文字 | 説明文 |
| template | string | | ✓ | | ~ 5242880文字 | テンプレートデータ
プロビジョニングする GS2 リソースを宣言的に定義する YAML または JSON ドキュメントです。GS2-Deploy は現在と以前のテンプレートの差分を検出し、必要に応じてリソースの作成・更新・削除を行います。最大サイズは 5 MB です。 |
| status | 文字列列挙型
enum {
"CREATE_PROCESSING",
"CREATE_COMPLETE",
"UPDATE_PROCESSING",
"UPDATE_COMPLETE",
"CLEAN_PROCESSING",
"CLEAN_COMPLETE",
"DELETE_PROCESSING",
"DELETE_COMPLETE",
"ROLLBACK_INITIALIZING",
"ROLLBACK_PROCESSING",
"ROLLBACK_COMPLETE"
}
| | | "CREATE_PROCESSING" | | 実行状態
スタック操作の現在のライフサイクル状態です。作成・更新・クリーン（リソース削除）・削除・ロールバック操作の処理中および完了状態を遷移します。操作の失敗時にはロールバックがトリガーされ、以前の状態に復元される場合があります。"CREATE_PROCESSING": 作成中 / "CREATE_COMPLETE": 作成完了 / "UPDATE_PROCESSING": 更新中 / "UPDATE_COMPLETE": 更新完了 / "CLEAN_PROCESSING": リソース削除中 / "CLEAN_COMPLETE": リソース削除完了 / "DELETE_PROCESSING": 削除中 / "DELETE_COMPLETE": 削除完了 / "ROLLBACK_INITIALIZING": ロールバック初期化中 / "ROLLBACK_PROCESSING": ロールバック中 / "ROLLBACK_COMPLETE": ロールバック完了 / |
| createdAt | long | | ※ | 現在時刻 | | 作成日時
UNIX 時間・ミリ秒
※ サーバーが自動で設定 |
| updatedAt | long | | ※ | 現在時刻 | | 最終更新日時
UNIX 時間・ミリ秒
※ サーバーが自動で設定 |
| revision | long | | | 0 | 0 ~ 9223372036854775805 | リビジョン |
**関連するメソッド:**
describeStacks - スタックの一覧を取得
createStack - スタックを新規作成
createStackFromGitHub - GitHub からスタックを新規作成
getStack - スタックを取得
updateStack - スタックを更新
updateStackFromGitHub - GitHub からスタックを更新
deleteStack - スタックを削除
forceDeleteStack - スタックを強制削除
deleteStackResources - スタックのリソースを削除
deleteStackEntity - スタックを最終削除
---
### OutputField
アウトプットフィールド
リソースの API レスポンスフィールドから名前付きスタックアウトプットへのマッピングを定義します。
| | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 |
| --- | --- | --- | --- | --- | --- | --- |
| name | string | | ✓ | | ~ 1024文字 | 名前
抽出された値が格納されるアウトプットのキー名です。スタックの Outputs からアウトプット値を参照する際にこの名前が使用されます。 |
| fieldName | string | | ✓ | | ~ 1024文字 | フィールド名
値を抽出するリソースの API レスポンス内のフィールドパスです。作成・更新されたリソースのどのプロパティをアウトプットとして記録するかを指定します。 |
**関連するモデル:**
Resource - リソース
---
### ChangeSet
変更内容
現在のスタックテンプレートと新しいテンプレートを比較した際に検出された単一のリソース変更を表します。スタック更新の実行前に、どのリソースが作成・更新・削除されるかをプレビューするバリデーション操作で使用されます。
| | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 |
| --- | --- | --- | --- | --- | --- | --- |
| resourceName | string | | ✓ | | ~ 128文字 | リソース名
この変更の影響を受ける、スタックテンプレートで定義されたリソースの論理名です。 |
| resourceType | string | | ✓ | | ~ 128文字 | リソースの種類
変更されるリソースの GS2 リソースタイプ識別子です（例: "GS2::Inventory::Namespace"）。 |
| operation | 文字列列挙型
enum {
"create",
"update",
"delete"
}
| | ✓ | | | 変更内容
このリソースに適用される変更の種類です。`create` は新しいリソースがプロビジョニングされること、`update` は既存のリソースが変更されること、`delete` はリソースが削除されることを示します。"create": 作成 / "update": 更新 / "delete": 削除 / |
**関連するメソッド:**
changeSet - 変更セットを取得
---
## メソッド
### describeResources
リソースの一覧を取得
指定されたスタックによって管理されているリソースのページネーション付きリストを取得します。
各リソースは、スタックのテンプレートによってプロビジョニングされた GS2 サービスコンポーネント（ネームスペース、モデル、構成など）を表します。
リソース情報には、タイプ、名前、現在のリクエストボディ、関連するプロパティが含まれます。
#### Request
| | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 |
| --- | --- | --- | --- | --- | --- | --- |
| stackName | string | | ✓| | ~ 128文字 | スタック名
スタックを識別する一意な名前です。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。作成・更新・削除操作時にスタックを参照するために使用されます。 |
| pageToken | string | | | | ~ 1024文字 | データの取得を開始する位置を指定するトークン |
| limit | int | | | 30 | 1 ~ 1000 | データの取得件数 |
#### Result
| | 型 | 説明 |
| --- | --- | --- |
| items | [List<Resource>](#resource) | リソースのリスト |
| nextPageToken | string | リストの続きを取得するためのページトークン |
#### 実装例
**Go**
```go
import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/deploy"
import "github.com/openlyinc/pointy"
session := core.Gs2RestSession{
Credential: &core.BasicGs2Credential{
ClientId: "your client id",
ClientSecret: "your client secret",
},
Region: core.ApNortheast1,
}
if err := session.Connect(); err != nil {
panic("error occurred")
}
client := deploy.Gs2DeployRestClient{
Session: &session,
}
result, err := client.DescribeResources(
&deploy.DescribeResourcesRequest {
StackName: pointy.String("stack-0001"),
PageToken: nil,
Limit: nil,
}
)
if err != nil {
panic("error occurred")
}
items := result.Items
nextPageToken := result.NextPageToken
```
**PHP**
```php
use Gs2\Core\Model\BasicGs2Credential;
use Gs2\Core\Model\Region;
use Gs2\Core\Net\Gs2RestSession;
use Gs2\Core\Exception\Gs2Exception;
use Gs2\Deploy\Gs2DeployRestClient;
use Gs2\Deploy\Request\DescribeResourcesRequest;
$session = new Gs2RestSession(
new BasicGs2Credential(
"your client id",
"your client secret"
),
Region::AP_NORTHEAST_1
);
$session->open();
$client = new Gs2DeployRestClient(
$session
);
try {
$result = $client->describeResources(
(new DescribeResourcesRequest())
->withStackName("stack-0001")
->withPageToken(null)
->withLimit(null)
);
$items = $result->getItems();
$nextPageToken = $result->getNextPageToken();
} catch (Gs2Exception $e) {
exit("error occurred")
}
```
**Java**
```java
import io.gs2.core.model.Region;
import io.gs2.core.model.BasicGs2Credential;
import io.gs2.core.rest.Gs2RestSession;
import io.gs2.core.exception.Gs2Exception;
import io.gs2.deploy.rest.Gs2DeployRestClient;
import io.gs2.deploy.request.DescribeResourcesRequest;
import io.gs2.deploy.result.DescribeResourcesResult;
Gs2RestSession session = new Gs2RestSession(
Region.AP_NORTHEAST_1,
new BasicGs2Credential(
"your client id",
"your client secret"
)
);
session.connect();
Gs2DeployRestClient client = new Gs2DeployRestClient(session);
try {
DescribeResourcesResult result = client.describeResources(
new DescribeResourcesRequest()
.withStackName("stack-0001")
.withPageToken(null)
.withLimit(null)
);
List items = result.getItems();
String nextPageToken = result.getNextPageToken();
} catch (Gs2Exception e) {
System.exit(1);
}
```
**C#**
```csharp
using Gs2.Core;
using Gs2.Core.Model;
using Gs2.Core.Net;
using Gs2.Core.Exception;
var session = new Gs2RestSession(
new BasicGs2Credential(
"your client id",
"your client secret"
),
Region.ApNortheast1
);
yield return session.OpenAsync(r => { });
var client = new Gs2DeployRestClient(session);
AsyncResult asyncResult = null;
yield return client.DescribeResources(
new Gs2.Gs2Deploy.Request.DescribeResourcesRequest()
.WithStackName("stack-0001")
.WithPageToken(null)
.WithLimit(null),
r => asyncResult = r
);
if (asyncResult.Error != null) {
throw asyncResult.Error;
}
var result = asyncResult.Result;
var items = result.Items;
var nextPageToken = result.NextPageToken;
```
**TypeScript**
```typescript
import Gs2Core from '@/gs2/core';
import * as Gs2Deploy from '@/gs2/deploy';
const session = new Gs2Core.Gs2RestSession(
"ap-northeast-1",
new Gs2Core.BasicGs2Credential(
'your client id',
'your client secret'
)
);
await session.connect();
const client = new Gs2Deploy.Gs2DeployRestClient(session);
try {
const result = await client.describeResources(
new Gs2Deploy.DescribeResourcesRequest()
.withStackName("stack-0001")
.withPageToken(null)
.withLimit(null)
);
const items = result.getItems();
const nextPageToken = result.getNextPageToken();
} catch (e) {
process.exit(1);
}
```
**Python**
```python
from gs2 import core
from gs2 import deploy
session = core.Gs2RestSession(
core.BasicGs2Credential(
'your client id',
'your client secret'
),
"ap-northeast-1",
)
session.connect()
client = deploy.Gs2DeployRestClient(session)
try:
result = client.describe_resources(
deploy.DescribeResourcesRequest()
.with_stack_name('stack-0001')
.with_page_token(None)
.with_limit(None)
)
items = result.items
next_page_token = result.next_page_token
except core.Gs2Exception as e:
exit(1)
```
**GS2-Script**
```lua
client = gs2('deploy')
api_result = client.describe_resources({
stackName="stack-0001",
pageToken=nil,
limit=nil,
})
if(api_result.isError) then
-- When error occurs
fail(api_result['statusCode'], api_result['errorMessage'])
end
result = api_result.result
items = result.items;
nextPageToken = result.nextPageToken;
```
**GS2-Script(Async)**
```lua
client = gs2('deploy')
api_result_handler = client.describe_resources_async({
stackName="stack-0001",
pageToken=nil,
limit=nil,
})
api_result = api_result_handler() -- Call the handler to get the result
if(api_result.isError) then
-- When error occurs
fail(api_result['statusCode'], api_result['errorMessage'])
end
result = api_result.result
items = result.items;
nextPageToken = result.nextPageToken;
```
---
### getResource
リソースを取得
スタックによって管理されている特定のリソースの詳細情報を取得します。
リソースの詳細には、タイプ、名前、プロビジョニングに使用されたリクエストボディ、作成後に返されたレスポンスプロパティが含まれます。
#### Request
| | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 |
| --- | --- | --- | --- | --- | --- | --- |
| stackName | string | | ✓| | ~ 128文字 | スタック名
スタックを識別する一意な名前です。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。作成・更新・削除操作時にスタックを参照するために使用されます。 |
| resourceName | string | | ✓| | ~ 128文字 | リソース名
スタックテンプレート内でこのリソースに割り当てられた論理名です。テンプレート内での依存関係の解決やアウトプットフィールドのマッピングにおいてリソースを参照するために使用されます。 |
#### Result
| | 型 | 説明 |
| --- | --- | --- |
| item | [Resource](#resource) | リソース |
#### 実装例
**Go**
```go
import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/deploy"
import "github.com/openlyinc/pointy"
session := core.Gs2RestSession{
Credential: &core.BasicGs2Credential{
ClientId: "your client id",
ClientSecret: "your client secret",
},
Region: core.ApNortheast1,
}
if err := session.Connect(); err != nil {
panic("error occurred")
}
client := deploy.Gs2DeployRestClient{
Session: &session,
}
result, err := client.GetResource(
&deploy.GetResourceRequest {
StackName: pointy.String("stack-0001"),
ResourceName: pointy.String("resource-0001"),
}
)
if err != nil {
panic("error occurred")
}
item := result.Item
```
**PHP**
```php
use Gs2\Core\Model\BasicGs2Credential;
use Gs2\Core\Model\Region;
use Gs2\Core\Net\Gs2RestSession;
use Gs2\Core\Exception\Gs2Exception;
use Gs2\Deploy\Gs2DeployRestClient;
use Gs2\Deploy\Request\GetResourceRequest;
$session = new Gs2RestSession(
new BasicGs2Credential(
"your client id",
"your client secret"
),
Region::AP_NORTHEAST_1
);
$session->open();
$client = new Gs2DeployRestClient(
$session
);
try {
$result = $client->getResource(
(new GetResourceRequest())
->withStackName("stack-0001")
->withResourceName("resource-0001")
);
$item = $result->getItem();
} catch (Gs2Exception $e) {
exit("error occurred")
}
```
**Java**
```java
import io.gs2.core.model.Region;
import io.gs2.core.model.BasicGs2Credential;
import io.gs2.core.rest.Gs2RestSession;
import io.gs2.core.exception.Gs2Exception;
import io.gs2.deploy.rest.Gs2DeployRestClient;
import io.gs2.deploy.request.GetResourceRequest;
import io.gs2.deploy.result.GetResourceResult;
Gs2RestSession session = new Gs2RestSession(
Region.AP_NORTHEAST_1,
new BasicGs2Credential(
"your client id",
"your client secret"
)
);
session.connect();
Gs2DeployRestClient client = new Gs2DeployRestClient(session);
try {
GetResourceResult result = client.getResource(
new GetResourceRequest()
.withStackName("stack-0001")
.withResourceName("resource-0001")
);
Resource item = result.getItem();
} catch (Gs2Exception e) {
System.exit(1);
}
```
**C#**
```csharp
using Gs2.Core;
using Gs2.Core.Model;
using Gs2.Core.Net;
using Gs2.Core.Exception;
var session = new Gs2RestSession(
new BasicGs2Credential(
"your client id",
"your client secret"
),
Region.ApNortheast1
);
yield return session.OpenAsync(r => { });
var client = new Gs2DeployRestClient(session);
AsyncResult asyncResult = null;
yield return client.GetResource(
new Gs2.Gs2Deploy.Request.GetResourceRequest()
.WithStackName("stack-0001")
.WithResourceName("resource-0001"),
r => asyncResult = r
);
if (asyncResult.Error != null) {
throw asyncResult.Error;
}
var result = asyncResult.Result;
var item = result.Item;
```
**TypeScript**
```typescript
import Gs2Core from '@/gs2/core';
import * as Gs2Deploy from '@/gs2/deploy';
const session = new Gs2Core.Gs2RestSession(
"ap-northeast-1",
new Gs2Core.BasicGs2Credential(
'your client id',
'your client secret'
)
);
await session.connect();
const client = new Gs2Deploy.Gs2DeployRestClient(session);
try {
const result = await client.getResource(
new Gs2Deploy.GetResourceRequest()
.withStackName("stack-0001")
.withResourceName("resource-0001")
);
const item = result.getItem();
} catch (e) {
process.exit(1);
}
```
**Python**
```python
from gs2 import core
from gs2 import deploy
session = core.Gs2RestSession(
core.BasicGs2Credential(
'your client id',
'your client secret'
),
"ap-northeast-1",
)
session.connect()
client = deploy.Gs2DeployRestClient(session)
try:
result = client.get_resource(
deploy.GetResourceRequest()
.with_stack_name('stack-0001')
.with_resource_name('resource-0001')
)
item = result.item
except core.Gs2Exception as e:
exit(1)
```
**GS2-Script**
```lua
client = gs2('deploy')
api_result = client.get_resource({
stackName="stack-0001",
resourceName="resource-0001",
})
if(api_result.isError) then
-- When error occurs
fail(api_result['statusCode'], api_result['errorMessage'])
end
result = api_result.result
item = result.item;
```
**GS2-Script(Async)**
```lua
client = gs2('deploy')
api_result_handler = client.get_resource_async({
stackName="stack-0001",
resourceName="resource-0001",
})
api_result = api_result_handler() -- Call the handler to get the result
if(api_result.isError) then
-- When error occurs
fail(api_result['statusCode'], api_result['errorMessage'])
end
result = api_result.result
item = result.item;
```
---
### describeEvents
イベントの一覧を取得
スタック操作（作成、更新、削除）中に発生したイベントのページネーション付きリストを取得します。
イベントには、各リソース操作の進行状況と結果（リソースタイプ、実行されたアクション、エラーメッセージなど）が記録されます。
実行中の操作のステータス監視や、完了した操作の履歴確認に便利です。
#### Request
| | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 |
| --- | --- | --- | --- | --- | --- | --- |
| stackName | string | | ✓| | ~ 128文字 | スタック名
スタックを識別する一意な名前です。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。作成・更新・削除操作時にスタックを参照するために使用されます。 |
| pageToken | string | | | | ~ 1024文字 | データの取得を開始する位置を指定するトークン |
| limit | int | | | 30 | 1 ~ 1000 | データの取得件数 |
#### Result
| | 型 | 説明 |
| --- | --- | --- |
| items | [List<Event>](#event) | イベントのリスト |
| nextPageToken | string | リストの続きを取得するためのページトークン |
#### 実装例
**Go**
```go
import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/deploy"
import "github.com/openlyinc/pointy"
session := core.Gs2RestSession{
Credential: &core.BasicGs2Credential{
ClientId: "your client id",
ClientSecret: "your client secret",
},
Region: core.ApNortheast1,
}
if err := session.Connect(); err != nil {
panic("error occurred")
}
client := deploy.Gs2DeployRestClient{
Session: &session,
}
result, err := client.DescribeEvents(
&deploy.DescribeEventsRequest {
StackName: pointy.String("stack-0001"),
PageToken: nil,
Limit: nil,
}
)
if err != nil {
panic("error occurred")
}
items := result.Items
nextPageToken := result.NextPageToken
```
**PHP**
```php
use Gs2\Core\Model\BasicGs2Credential;
use Gs2\Core\Model\Region;
use Gs2\Core\Net\Gs2RestSession;
use Gs2\Core\Exception\Gs2Exception;
use Gs2\Deploy\Gs2DeployRestClient;
use Gs2\Deploy\Request\DescribeEventsRequest;
$session = new Gs2RestSession(
new BasicGs2Credential(
"your client id",
"your client secret"
),
Region::AP_NORTHEAST_1
);
$session->open();
$client = new Gs2DeployRestClient(
$session
);
try {
$result = $client->describeEvents(
(new DescribeEventsRequest())
->withStackName("stack-0001")
->withPageToken(null)
->withLimit(null)
);
$items = $result->getItems();
$nextPageToken = $result->getNextPageToken();
} catch (Gs2Exception $e) {
exit("error occurred")
}
```
**Java**
```java
import io.gs2.core.model.Region;
import io.gs2.core.model.BasicGs2Credential;
import io.gs2.core.rest.Gs2RestSession;
import io.gs2.core.exception.Gs2Exception;
import io.gs2.deploy.rest.Gs2DeployRestClient;
import io.gs2.deploy.request.DescribeEventsRequest;
import io.gs2.deploy.result.DescribeEventsResult;
Gs2RestSession session = new Gs2RestSession(
Region.AP_NORTHEAST_1,
new BasicGs2Credential(
"your client id",
"your client secret"
)
);
session.connect();
Gs2DeployRestClient client = new Gs2DeployRestClient(session);
try {
DescribeEventsResult result = client.describeEvents(
new DescribeEventsRequest()
.withStackName("stack-0001")
.withPageToken(null)
.withLimit(null)
);
List items = result.getItems();
String nextPageToken = result.getNextPageToken();
} catch (Gs2Exception e) {
System.exit(1);
}
```
**C#**
```csharp
using Gs2.Core;
using Gs2.Core.Model;
using Gs2.Core.Net;
using Gs2.Core.Exception;
var session = new Gs2RestSession(
new BasicGs2Credential(
"your client id",
"your client secret"
),
Region.ApNortheast1
);
yield return session.OpenAsync(r => { });
var client = new Gs2DeployRestClient(session);
AsyncResult asyncResult = null;
yield return client.DescribeEvents(
new Gs2.Gs2Deploy.Request.DescribeEventsRequest()
.WithStackName("stack-0001")
.WithPageToken(null)
.WithLimit(null),
r => asyncResult = r
);
if (asyncResult.Error != null) {
throw asyncResult.Error;
}
var result = asyncResult.Result;
var items = result.Items;
var nextPageToken = result.NextPageToken;
```
**TypeScript**
```typescript
import Gs2Core from '@/gs2/core';
import * as Gs2Deploy from '@/gs2/deploy';
const session = new Gs2Core.Gs2RestSession(
"ap-northeast-1",
new Gs2Core.BasicGs2Credential(
'your client id',
'your client secret'
)
);
await session.connect();
const client = new Gs2Deploy.Gs2DeployRestClient(session);
try {
const result = await client.describeEvents(
new Gs2Deploy.DescribeEventsRequest()
.withStackName("stack-0001")
.withPageToken(null)
.withLimit(null)
);
const items = result.getItems();
const nextPageToken = result.getNextPageToken();
} catch (e) {
process.exit(1);
}
```
**Python**
```python
from gs2 import core
from gs2 import deploy
session = core.Gs2RestSession(
core.BasicGs2Credential(
'your client id',
'your client secret'
),
"ap-northeast-1",
)
session.connect()
client = deploy.Gs2DeployRestClient(session)
try:
result = client.describe_events(
deploy.DescribeEventsRequest()
.with_stack_name('stack-0001')
.with_page_token(None)
.with_limit(None)
)
items = result.items
next_page_token = result.next_page_token
except core.Gs2Exception as e:
exit(1)
```
**GS2-Script**
```lua
client = gs2('deploy')
api_result = client.describe_events({
stackName="stack-0001",
pageToken=nil,
limit=nil,
})
if(api_result.isError) then
-- When error occurs
fail(api_result['statusCode'], api_result['errorMessage'])
end
result = api_result.result
items = result.items;
nextPageToken = result.nextPageToken;
```
**GS2-Script(Async)**
```lua
client = gs2('deploy')
api_result_handler = client.describe_events_async({
stackName="stack-0001",
pageToken=nil,
limit=nil,
})
api_result = api_result_handler() -- Call the handler to get the result
if(api_result.isError) then
-- When error occurs
fail(api_result['statusCode'], api_result['errorMessage'])
end
result = api_result.result
items = result.items;
nextPageToken = result.nextPageToken;
```
---
### getEvent
イベントを取得
スタック内の特定のイベントの詳細情報を取得します。
イベントには、リソースタイプ、アクション（作成/更新/削除）、ステータス、操作中に発生したエラーメッセージが含まれます。
#### Request
| | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 |
| --- | --- | --- | --- | --- | --- | --- |
| stackName | string | | ✓| | ~ 128文字 | スタック名
スタックを識別する一意な名前です。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。作成・更新・削除操作時にスタックを参照するために使用されます。 |
| eventName | string | | ✓| UUID | ~ 36文字 | イベント名
イベントの一意な名前を保持します。
名前はUUID（Universally Unique Identifier）フォーマットで自動的に生成され、各イベントを識別するために使用されます。 |
#### Result
| | 型 | 説明 |
| --- | --- | --- |
| item | [Event](#event) | イベント |
#### 実装例
**Go**
```go
import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/deploy"
import "github.com/openlyinc/pointy"
session := core.Gs2RestSession{
Credential: &core.BasicGs2Credential{
ClientId: "your client id",
ClientSecret: "your client secret",
},
Region: core.ApNortheast1,
}
if err := session.Connect(); err != nil {
panic("error occurred")
}
client := deploy.Gs2DeployRestClient{
Session: &session,
}
result, err := client.GetEvent(
&deploy.GetEventRequest {
StackName: pointy.String("stack-0001"),
EventName: pointy.String("event-0001"),
}
)
if err != nil {
panic("error occurred")
}
item := result.Item
```
**PHP**
```php
use Gs2\Core\Model\BasicGs2Credential;
use Gs2\Core\Model\Region;
use Gs2\Core\Net\Gs2RestSession;
use Gs2\Core\Exception\Gs2Exception;
use Gs2\Deploy\Gs2DeployRestClient;
use Gs2\Deploy\Request\GetEventRequest;
$session = new Gs2RestSession(
new BasicGs2Credential(
"your client id",
"your client secret"
),
Region::AP_NORTHEAST_1
);
$session->open();
$client = new Gs2DeployRestClient(
$session
);
try {
$result = $client->getEvent(
(new GetEventRequest())
->withStackName("stack-0001")
->withEventName("event-0001")
);
$item = $result->getItem();
} catch (Gs2Exception $e) {
exit("error occurred")
}
```
**Java**
```java
import io.gs2.core.model.Region;
import io.gs2.core.model.BasicGs2Credential;
import io.gs2.core.rest.Gs2RestSession;
import io.gs2.core.exception.Gs2Exception;
import io.gs2.deploy.rest.Gs2DeployRestClient;
import io.gs2.deploy.request.GetEventRequest;
import io.gs2.deploy.result.GetEventResult;
Gs2RestSession session = new Gs2RestSession(
Region.AP_NORTHEAST_1,
new BasicGs2Credential(
"your client id",
"your client secret"
)
);
session.connect();
Gs2DeployRestClient client = new Gs2DeployRestClient(session);
try {
GetEventResult result = client.getEvent(
new GetEventRequest()
.withStackName("stack-0001")
.withEventName("event-0001")
);
Event item = result.getItem();
} catch (Gs2Exception e) {
System.exit(1);
}
```
**C#**
```csharp
using Gs2.Core;
using Gs2.Core.Model;
using Gs2.Core.Net;
using Gs2.Core.Exception;
var session = new Gs2RestSession(
new BasicGs2Credential(
"your client id",
"your client secret"
),
Region.ApNortheast1
);
yield return session.OpenAsync(r => { });
var client = new Gs2DeployRestClient(session);
AsyncResult asyncResult = null;
yield return client.GetEvent(
new Gs2.Gs2Deploy.Request.GetEventRequest()
.WithStackName("stack-0001")
.WithEventName("event-0001"),
r => asyncResult = r
);
if (asyncResult.Error != null) {
throw asyncResult.Error;
}
var result = asyncResult.Result;
var item = result.Item;
```
**TypeScript**
```typescript
import Gs2Core from '@/gs2/core';
import * as Gs2Deploy from '@/gs2/deploy';
const session = new Gs2Core.Gs2RestSession(
"ap-northeast-1",
new Gs2Core.BasicGs2Credential(
'your client id',
'your client secret'
)
);
await session.connect();
const client = new Gs2Deploy.Gs2DeployRestClient(session);
try {
const result = await client.getEvent(
new Gs2Deploy.GetEventRequest()
.withStackName("stack-0001")
.withEventName("event-0001")
);
const item = result.getItem();
} catch (e) {
process.exit(1);
}
```
**Python**
```python
from gs2 import core
from gs2 import deploy
session = core.Gs2RestSession(
core.BasicGs2Credential(
'your client id',
'your client secret'
),
"ap-northeast-1",
)
session.connect()
client = deploy.Gs2DeployRestClient(session)
try:
result = client.get_event(
deploy.GetEventRequest()
.with_stack_name('stack-0001')
.with_event_name('event-0001')
)
item = result.item
except core.Gs2Exception as e:
exit(1)
```
**GS2-Script**
```lua
client = gs2('deploy')
api_result = client.get_event({
stackName="stack-0001",
eventName="event-0001",
})
if(api_result.isError) then
-- When error occurs
fail(api_result['statusCode'], api_result['errorMessage'])
end
result = api_result.result
item = result.item;
```
**GS2-Script(Async)**
```lua
client = gs2('deploy')
api_result_handler = client.get_event_async({
stackName="stack-0001",
eventName="event-0001",
})
api_result = api_result_handler() -- Call the handler to get the result
if(api_result.isError) then
-- When error occurs
fail(api_result['statusCode'], api_result['errorMessage'])
end
result = api_result.result
item = result.item;
```
---
### describeOutputs
アウトプットの一覧を取得
スタックの作成・更新が成功した後に生成されたアウトプット値のページネーション付きリストを取得します。
アウトプットは、テンプレートで定義されたキーと値のペアで、スタックのプロビジョニング中に生成されたリソース識別子、エンドポイント、構成値などの重要な情報を公開します。
アウトプットはスタックが _COMPLETE ステータスの場合にのみ利用可能です。
#### Request
| | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 |
| --- | --- | --- | --- | --- | --- | --- |
| stackName | string | | ✓| | ~ 128文字 | スタック名
スタックを識別する一意な名前です。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。作成・更新・削除操作時にスタックを参照するために使用されます。 |
| pageToken | string | | | | ~ 1024文字 | データの取得を開始する位置を指定するトークン |
| limit | int | | | 30 | 1 ~ 1000 | データの取得件数 |
#### Result
| | 型 | 説明 |
| --- | --- | --- |
| items | [List<Output>](#output) | アウトプットのリスト |
| nextPageToken | string | リストの続きを取得するためのページトークン |
#### 実装例
**Go**
```go
import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/deploy"
import "github.com/openlyinc/pointy"
session := core.Gs2RestSession{
Credential: &core.BasicGs2Credential{
ClientId: "your client id",
ClientSecret: "your client secret",
},
Region: core.ApNortheast1,
}
if err := session.Connect(); err != nil {
panic("error occurred")
}
client := deploy.Gs2DeployRestClient{
Session: &session,
}
result, err := client.DescribeOutputs(
&deploy.DescribeOutputsRequest {
StackName: pointy.String("stack-0001"),
PageToken: nil,
Limit: nil,
}
)
if err != nil {
panic("error occurred")
}
items := result.Items
nextPageToken := result.NextPageToken
```
**PHP**
```php
use Gs2\Core\Model\BasicGs2Credential;
use Gs2\Core\Model\Region;
use Gs2\Core\Net\Gs2RestSession;
use Gs2\Core\Exception\Gs2Exception;
use Gs2\Deploy\Gs2DeployRestClient;
use Gs2\Deploy\Request\DescribeOutputsRequest;
$session = new Gs2RestSession(
new BasicGs2Credential(
"your client id",
"your client secret"
),
Region::AP_NORTHEAST_1
);
$session->open();
$client = new Gs2DeployRestClient(
$session
);
try {
$result = $client->describeOutputs(
(new DescribeOutputsRequest())
->withStackName("stack-0001")
->withPageToken(null)
->withLimit(null)
);
$items = $result->getItems();
$nextPageToken = $result->getNextPageToken();
} catch (Gs2Exception $e) {
exit("error occurred")
}
```
**Java**
```java
import io.gs2.core.model.Region;
import io.gs2.core.model.BasicGs2Credential;
import io.gs2.core.rest.Gs2RestSession;
import io.gs2.core.exception.Gs2Exception;
import io.gs2.deploy.rest.Gs2DeployRestClient;
import io.gs2.deploy.request.DescribeOutputsRequest;
import io.gs2.deploy.result.DescribeOutputsResult;
Gs2RestSession session = new Gs2RestSession(
Region.AP_NORTHEAST_1,
new BasicGs2Credential(
"your client id",
"your client secret"
)
);
session.connect();
Gs2DeployRestClient client = new Gs2DeployRestClient(session);
try {
DescribeOutputsResult result = client.describeOutputs(
new DescribeOutputsRequest()
.withStackName("stack-0001")
.withPageToken(null)
.withLimit(null)
);
List