ASK CLIコマンドリファレンス
このリファレンスでは、Alexa Skills Kit(ASK)コマンドラインインターフェース(CLI)で利用できるすべてのコマンドについて説明します。ASK CLIについては、ASK CLIの概要を参照してください。ASK CLIを使って開発を始めるには、ASK CLIのクイックスタートを参照してください。
概要
ASK CLIコマンドの有効な構文は次のとおりです。
$ ask [オプション]
$ ask [コマンド] [オプション]
$ ask [コマンド] [サブコマンド] [オプション]
開発者アカウントに関連付けられたスキルを処理するASK CLIのコマンドには、2つの種類があります。
-
高レベルコマンドは、詳細を抽象化し、複数のアクションを実行することで、Alexaスキルのプロジェクト作業効率を向上させます。スキル開発が初めての方や、API呼び出しを細かく制御する必要がない場合は、このコマンドが適しています。高レベルコマンドの例として、
new
、deploy
、configure
があります。 -
低レベルコマンドは、Alexaスキルを詳細に管理するために使用します。Alexaスキル管理API(SMAPI)操作のラッパーとして機能するため、各API呼び出しを制御できます。既にアカウントに追加したスキルの一部を変更する場合に便利です。
smapi
コマンドのサブコマンドは、低レベルコマンドです。
コンピューターにインストールされているASK CLIのバージョン番号を取得するには、次のように--version
オプションを使用します。
$ ask [--version | -V]
共通パラメーター
ASK CLIコマンドには、--help
や--debug
などの共通パラメーターがあります。共通パラメーターの動作は、すべてのコマンドで同じです。このセクションでは、共通パラメーターについて説明します。
コマンドのデバッグモード
ほとんどのASK CLIコマンドは、コマンドに続けて--debug
を追加することで、デバッグモードで実行できます。コマンドの実行完了後にデバッグメッセージが表示される(標準エラー出力に送られる)以外は、–debugを指定しない場合と同じ結果が表示されます。このデバッグメッセージは、次のフィールドで構成されます:timestamp
、api-name
、request-id
、method
、url
、response-code
、request-header
、request-body
、response-header
、response-body
これらの結果を保存するには、コマンドを実行し、パイプを使って以下のように出力をローカルテキストファイルに送ります。
$ ask [コマンド] <その他のパラメーター> --debug 2> debug.txt
コマンドのヘルプモード
各ASK CLIコマンドでは、コマンドに--help
を追加することで、その目的とオプションに関するヘルプが提供されます。ヘルプモードでコマンドを実行した場合、コマンド自体は実行されません。
$ ask [コマンド] --help
スキルのステージ
ASK CLIコマンドの多くはスキルのstage
を参照します。stage
の値は、development
、live
のいずれかです。development
の場合、スキルは公開されていません。live
の場合、スキルは公開済みですが、実際に公開中のもの、ユーザーには非表示になっているもの、Alexaスキルストアから削除されたもののいずれかの可能性があります。詳細については、公開ステータスを参照してください。
configureコマンド
Amazon開発者アカウント認証情報を使ってASK CLIを初期化します。スキル操作を実行する前に開発者アカウントの認証情報を使用してツールを初期化するには、このコマンドを実行します。このコマンドはポート9090を使用します。ポートが使用中の場合はエラーになります。
ask configure
コマンドでは、認証情報を設定できます。ASK CLIは、この認証情報をAmazon開発者サービスやアマゾンウェブサービス(AWS)の認証に使います。この対話形式のコマンドを使うと、ウェブブラウザが開きます。Amazon開発者アカウントでサインインすると、使用する認証情報に関する情報を入力するか、質問に答えるようプロンプトが表示されます。
ask configure
を使うと、別のAmazonアカウントやAWSアカウントの認証情報を含むプロファイルの表示や設定ができます。プロファイルでは、ASK CLIを使って別のアカウントで作成したスキルを管理できます。ask new、ask deployなどのコマンドに-p
または--profile
オプションを付けて使用します。
ASK CLIがAmazon開発者アカウントやAWSアカウントの認証情報を保存、管理する方法については、ASK CLIを使った認証情報の管理を参照してください。
構文
ask configure [--profile | -p <プロファイル>]
[--no-browser]
[--debug]
[--help | -h]
オプション
- --profile, -p
- 任意です。設定する認証情報に使うプロファイルを指定します。このオプションを省略すると、リストからプロファイルを選択するか、新規作成するようASK CLIのプロンプトが表示されます。
- --no-browser
- 任意です。このオプションを使うと、
ask configure
コマンドをウェブブラウザを持たないコンピューターで実行できます。ASK CLIにURLが表示されるので、別のコンピューターのウェブブラウザを使ってこのURLにアクセスし、Amazon開発者アカウントでサインインできます。サインインすると、ブラウザにコードが表示されるので、コマンドラインに入力して認証情報の設定を完了します。
deployコマンド
スキルのマニフェスト、音声対話モデル、AWS Lambda関数を含むスキルを開発者アカウントにデプロイします。概要と使用例については、ASK CLIの概要でスキルをデプロイするを参照してください。
構文
ask deploy [-p | --profile <プロファイル>]
[--target | -t <target>]
[--ignore-hash]
[--debug]
[--help | -h]
オプション
- --profile, -p
- 任意です。ASK CLIがスキルリソースをデプロイするプロファイルです。このオプションを含めない場合は、ASK CLIはデフォルトのプロファイルを使用します。
- --target, -t
-
任意です。デプロイするスキルプロジェクトのリソースです。有効な値は次のとおりです。
skill-metadata
:skill-package
ディレクトリのみ。skill-infrastructure
:skill-package
ディレクトリとlambda/
ディレクトリ。
- --ignore-hash
- 任意です。変更がない場合でも、スキルを強制的に再度デプロイします。
dialogコマンド
開発者がAlexaとのマルチターンの会話をシミュレートできるダイアログモードを開始します。各ダイアログはsimulate-skill
を使用します。これは、シミュレーション結果が入手できるまでポーリングを続ける非同期の操作です。結果を入手したら、Alexaのテキスト応答を表示します。パラメーターが無効な場合、対話モードは始まりません。また、ユーザーが特殊コマンドの!quit
かCtrl+C
を入力しない限り終了しません。詳細については、スキルをテストするを参照してください。
ユーザーがダイアログ中に入力できるコマンドは2つあります。1つは.quit
で、対話モードを終了します。もう1つは.record
で、ユーザーにファイル名を入力するようプロンプトを出し、ダイアログ入力を記録できます。これらのコマンドは、現在の対話モードのスキルID、ロケール、入力タイプ、すべての入力テキストと共に使用できます。.record
コマンドは、最後のセッションのユーザー入力のみを記録します。
このコマンドを--replay
オプションを付けて実行する場合、スキルの情報とユーザー入力を含む記録ファイルを指定します。replayオプションはユーザー入力を再生し、Alexaが通常の会話のように応答します。再生ファイル形式を参照してください。コマンドラインでskillId
を指定しないでください。
このコマンドを--replay
オプションを付けないで実行する場合、指定したスキルのリクエストをAlexaに話し掛けるときのようにダイアログに直接入力します。skillId
を指定するか、スキルプロジェクトのルートディレクトリからコマンドを実行し、locale
を指定する必要があります。
-
スキルセッションが終了していない場合、
User >
プロンプトがコマンドラインに引き続き表示されるため、Alexaと会話しているときのようにテキストを入力できます。 -
スキルセッションが終了している場合は
---Skill Session Ended.---
行がコマンドラインウィンドウに表示されますが、対話モードは開いたままです。User >
プロンプトが表示されるので、引き続きテキストを入力できます。
構文
ask dialog [--skill-id | -s <スキルID>]
[--locale | -l <ロケール>]
[--stage | -g <ステージ>]
[--replay | -r <ファイルパス>]
オプション
- --skill-id, -s
- 任意です。
amzn1.ask.skill.12345678-1234-1234-123456789123
の形式で指定する必要があります。スキルIDまたは--replay
オプションを指定していない場合、このコマンドは、スキルが既に作成またはクローンされているルートディレクトリから実行する必要があります。--skill-id
と--replay
の両方のオプションを指定することはできません。 - --locale, -l
ASK_DEFAULT_DEVICE_LOCALE
環境変数が設定されている場合は任意、--replay
オプションが使用されていない場合は必須です。シミュレートするスキルのロケールです。有効な値は、en-US
、en-GB
、en-CA
、en-AU
、en-IN
、de-DE
、ja-JP
です。このオプションも--replay
オプションも指定されていない場合、ロケールを入力するようプロンプトが表示されます。--replay
オプションを使用する場合は、locale
を指定できません。- --stage, -g
- 任意です。スキルのステージを表します。値として、
development
かlive
のいずれかを使用します。デフォルトはdevelopment
です。 - --replay, -r
- 任意です。スキルとの会話をシミュレートする再生ファイルを指定します。このファイルには、セッションの開始または最後に記録した位置からのテキスト発話が含まれます。記録されたファイルを使用して、よく使われるテストを自動化できます。この再生ファイルには、
skill-id
とlocale
が含まれる場合があります。ファイルにskill-id
が含まれていない場合、このコマンドは、スキルプロジェクトのルートディレクトリから実行します。スキルプロジェクトには、テストするスキルが既に作成されているか、クローンされている必要があります。 - --profile, -p
- 任意です。デフォルト以外のプロファイルを使うには、プロファイル名を指定します。
- --debug
- 任意です。標準エラー出力にデバッグメッセージを追加します。
再生ファイル形式
再生ファイルは以下の形式になります。
{
"skillId":"amazon.skill.123..",
"locale": "ja-JP",
"type": "text",
"userInput": ["フライトの予約", "バンクーバー"]
}
アトリビュート | 説明 |
---|---|
skillId | シミュレートするスキルのIDです。 |
locale | 「ja-JP」など、スキルをテストするロケールを指定します。 |
type | "text"(テキスト)を指定します。 |
userInput | ユーザーがスキルに話し掛ける発話の配列です。 |
適切な情報を指定し、以下の形式に従って再生ファイルを手動で作成して、後で利用できるよう保存できます。
再生ファイルは以下の手順でも作成できます。
ask dialog
コマンドを入力します。- プロンプトが出たら、
.record
と入力します。 - プロンプトに従って、必要な情報を入力します。これには、保存するファイル名も含まれます。
どちらの場合にも、--replay
オプションを使用するときに使う再生ファイルを指定します。
initコマンド
ask init
コマンドは、新規または既存のAlexaスキルプロジェクトをセットアップするのに役立ちます。このコマンドによりスキルのデプロイに使用するask-resources.json
ファイルを作成できます。最も一般的なアトリビュートを設定し、エンドポイントとしてAWS Lambdaを使用するのに最適なデフォルト値を提案します。
構文
ask init [--hosted-skill-id <hostedスキルのID>]
[--profile | -p <プロファイル>]
[--debug]
オプション
- -hosted-skill-id
- 任意です。Alexa-hostedスキルのスキルIDを指定すると、現在のディレクトリにスキルのクローンを作成するワークフローが開始されます。
- --profile, -p
- 任意です。ASK CLIがスキル作成に使用したプロファイルです。指定しない場合、ASK CLIはデフォルトのプロファイルを使用します。
newコマンド
ask new
コマンドでは、スキルテンプレートからコピーして新しいスキルプロジェクトを作成できます。コンピューターに新しいAlexaスキルプロジェクトを作成します(最小限の変更でデプロイ先に必要なフォルダやファイルも作成します)。概要と使用例については、ASK CLIの概要で新しいスキルプロジェクトを作成するを参照してください。
構文
ask new [--template-url <URL>]
[--template-branch <ブランチ>]
[--profile | -p <プロフィール>]
[--debug]
[--help]
オプション
- --template-url
- オプション: スキルテンプレートを含むGitリポジトリのURLです。
- --template-branch
- オプション: 使用するスキルテンプレートブランチの名前です。このパラメーターを
--template-url
パラメーターと組み合わせて使用すると、テンプレートリポジトリのどのブランチをローカルに複製するかを指定できます。 - --profile, -p
- 任意です。ASK CLIがスキル作成に使用したプロファイルです。指定しない場合、ASK CLIはデフォルトのプロファイルを使用します。
runコマンド
run
コマンドを使用すると、デバッグセッションが開始され、ローカルで作成しているスキルのテストを実行できます。スキルへのリクエストは、Lambda関数ではなく、ローカルコンピューターにルーティングされます。詳細と前提条件については、ローカルでスキルをテストするを参照してください。
ローカルのデバッグセッションが開始したら、ask dialogコマンドを使用してスキルへのリクエストをシミュレーションします。
構文
ask run [--debug-port <debug-port>]
[--wait-for-attach]
[--watch]
[--region <リージョン>]
[--profile | -p <プロファイル>]
[--debug]
[--help]
オプション
- --debug-port
- オプション: デバッグプロセスを実行するポートです。整数です。デフォルトポートは5000です。
- --wait-for-attach
- オプション: デバッグインスペクターがデバッグポートをアタッチするのを待つ場合は、このフラグを指定します。デフォルトは
false
です。 - --watch
- オプション: nodemonを使って変更をモニタリングし、セッションを自動的に再起動するには、このフラグを指定します。デフォルトは
false
です。 - --region
- オプション: デバッグセッションのリージョンです。以下のいずれかになります:
NA
、EU
、FE
。デフォルトはNA
です。 - --profile, -p
- 任意です。ASK CLIがスキル作成に使用したプロファイルです。指定しない場合、ASK CLIはデフォルトのプロファイルを使用します。
utilコマンド
utilコマンドは、Alexaスキルの作成を管理するユーティリティツールを提供します。
generate-lwa-tokens
LWAクライアントからLogin with Amazonのトークンを生成します。詳細については、Login with Amazonを参照してください。
構文
ask util generate-lwa-tokens [--client-id]
[--client-confirmation]
[--scopes]
[--no-browser]
[--debug]
オプション
- --client-id
- 任意です。LWAアプリケーションを登録するときのクライアントIDです。
- --client-confirmation
- 任意です。LWAアプリケーションを登録するときのクライアントシークレットです。
- --scopes
- 任意です。アクセスをリクエストするスコープのリストです。二重引用符で囲み、スペースで区切られます。たとえば、
"alexa::ask:skills:readwrite alexa::ask:models:readwrite"
のように指定します。 - --no-browser
- 任意です。Amazon開発者アカウントでサインインするための、どこからでも使用できるURLが表示されます。
例
ask util generate-lwa-tokens --client-id amzn1.application-oa2-client.xxx --client-confirmation 1a0example --scopes "alexa::ask:skills:readwrite alexa::ask:models:readwrite alexa::ask:skills:test alexa::ask:catalogs:read alexa::ask:catalogs:readwrite"
git-credentials-helper
Alexa-hostedスキルリポジトリのgit認証情報を返します。
構文
ask util git-credentials-helper [--profile | -p <プロファイル>]
[--debug]
[--help]
オプション
- --profile, -p
- 任意です。ASK CLIがスキルリソースをデプロイするプロファイルです。指定しない場合、ASK CLIはデフォルトのプロファイルを使用します。
upgrade-project
ASK CLI v1.xスキルプロジェクトをASK CLI v2プロジェクト形式にアップグレードします。
構文
ask util upgrade-project [--profile | -p <プロファイル>]
[--debug]
[--help]
オプション
- --profile, -p
- 任意です。ASK CLIがスキルリソースをデプロイするプロファイルです。指定しない場合、ASK CLIはデフォルトのプロファイルを使用します。
smapiコマンド
smapi
コマンドは、Alexaスキル管理API(SMAPI)の基本API操作に1:1でマッピングされたサブコマンドを提供します。これらのコマンドは、API入力を詳細に制御でき、生データを出力します。スキル、音声対話モデル、アカウントリンク情報の作成と更新、スキル認定プロセスの開始を行うサブコマンドがあります。
smapiコマンドおよびサブコマンドを使用すると、開発者アカウントに関連付けられたAlexaスキルの詳細を管理できます。Alexaスキルの一部を作成したり更新したりしたい場合やスキルのベータテストを行う場合は、これらのコマンドを使用します。
構文
$ ask smapi <サブコマンド>
add-testers-to-beta-test
テスターを特定のスキルのベータテストに追加します。システムは、各テスターに招待のEメールを送信し、承諾されると参加資格を追加します。
構文
$ ask smapi add-testers-to-beta-test [--skill-id | -s <スキルID>]
[--testers-emails <テスターのEメール>]
[--profile | -p <プロフィール>]
[--debug]
オプション
- --skill-id, -s
- 必須です。スキルIDです。
- --testers-emails
- 必須です。ベータテストのテスターのEメールアドレスです。[複数可]: 値はコンマで区切ることができます。
- --profile, -p
- 使用するASK CLIプロファイルです。このオプションを含めない場合は、ASK CLIはデフォルトのプロファイルを使用します。
- --debug
- このオプションを指定すると、コマンド出力にデバッグメッセージが表示されます。
associate-catalog-with-skill
カタログをスキルに関連付けます。
構文
$ ask smapi associate-catalog-with-skill [--skill-id | -s <skill-id>]
[--catalog-id | -c <catalog-id>]
[--profile | -p <プロファイル>]
[--full-response]
[--debug]
オプション
- --skill-id, -s
- 必須です。スキルIDです。
- --catalog-id, -c
- 必須です。一意のカタログIDです。
- --profile, -p
- 使用するASK CLIプロファイルです。このオプションを含めない場合は、ASK CLIはデフォルトのプロファイルを使用します。
- --full-response
- このオプションを指定すると、応答の本文、ヘッダー、ステータスが1つのオブジェクトとして返されます。
- --debug
- このオプションを指定すると、コマンド出力にデバッグメッセージが表示されます。
associate-isp-with-skill
スキル内商品をスキルに関連付けます。
構文
$ ask smapi associate-isp-with-skill [--product-id <商品ID>]
[--skill-id | -s <スキルID>]
[--profile | -p <プロフィール>]
[--debug]
オプション
- --product-id
- 必須です。スキル内商品のIDです。
- --skill-id, -s
- 必須です。スキルIDです。
- --profile, -p
- 使用するASK CLIプロファイルです。このオプションを含めない場合は、ASK CLIはデフォルトのプロファイルを使用します。
- --debug
- このオプションを指定すると、コマンド出力にデバッグメッセージが表示されます。
clone-locale
スキルに新しいclone-localeワークフローを作成します。スキルのクローンについては、スキルのクローンを作成する、関連するSMAPI APIリファレンスを参照してください。
構文:
ask smapi clone-locale [-s,--skill-id <スキルID>]
[-g,--stage <ステージ>]
[--source-locale <ソースロケール>]
[--target-locales <ターゲットロケール>]
[--overwrite-mode <上書きモード>]
[-p、--profile <プロファイル>]
[--debug]
[-h、--help]
オプション:
- -s, --skill-id
- 必須です。クローンを作成するスキルのIDです。
- -g, --stage
- 必須です。クローンを作成するスキルの公開ステージです。
有効な値:development
- --sourceLocale
- 必須です。クローンを作成するスキルアセットのロケールです。例:
en-US
1つのクローンに設定できるsourceLocale
は1つだけです。 - --targetLocales
- 必須です。
sourceLocale
アセットのコピー先として指定するロケール(en-CA
など)のリストです。コンマ区切りのリストを使い、1つのコマンドに複数のロケールを指定できます。 - --overwrite-mode
- 任意です。既存のターゲットアセットを指定し、現在のロケールを上書きします。
有効な値:OVERWRITE
、DO_NOT_OVERWRITE
デフォルト値:DO_NOT_OVERWRITE
- -p, --profile
- 任意です。ASK CLIがスキルリソースをデプロイするプロファイルです。入力しない場合、ASK CLIはデフォルトのプロファイルを使用します。
- --debug
- 任意です。このオプションを指定すると、コマンド出力にデバッグメッセージが表示されます。
create-asr-annotation-set
自動音声認識(ASR)アノテーションセットを新規作成します。応答には、後のコマンドでアノテーションセットを参照するために使用できるannotationSetId
が含まれます。詳細については、自動音声認識(ASR)評価ツールについておよびこのコマンドのREST APIバージョンを参照してください。
構文
$ ask smapi create-asr-annotation-set [--skill-id | -s <skill-id>]
[--name <name>]
[--full-response]
[--profile | -p <プロフィール>]
[--debug]
オプション
- --skill-id, -s
- 必須です。スキルIDです。
- --name
- 必須です。アノテーションセットの名前です。名前には最大170文字の英数字を使用できます。
- --full-response
- このオプションを指定すると、応答の本文、ヘッダー、ステータスが1つのオブジェクトとして返されます。
- --profile, -p
- 使用するASK CLIプロファイルです。このオプションを含めない場合は、ASK CLIはデフォルトのプロファイルを使用します。
- --debug
- このオプションを指定すると、コマンド出力にデバッグメッセージが表示されます。
create-beta-test
特定のスキルのベータテストを作成します。
構文
$ ask smapi create-beta-test [--skill-id | -s <スキルID>]
[--feedback-email <フィードバックEメール>]
[--profile | -p <プロフィール>]
[--debug]
オプション
- --skill-id, -s
- 必須です。スキルIDです。
- --feedback-email
- 任意です。フィードバックを提供するEメールアドレスです。
- --profile, -p
- 使用するASK CLIプロファイルです。このオプションを含めない場合は、ASK CLIはデフォルトのプロファイルを使用します。
- --debug
- このオプションを指定すると、コマンド出力にデバッグメッセージが表示されます。
create-catalog
$ ask smapi create-catalog [--title <タイトル>]
[--type <タイプ>]
[--usage <使用法>]
[--profile | -p <プロフィール>]
[--full-response]
[--debug]
指定したタイプ、タイトル、使用法で新しいカタログを作成します。
オプション
- --title
- 必須です。新しいカタログのタイトルです。
- --type
- 必須です。新しいカタログのタイプです。次のいずれかを選択します。
AMAZON.MusicAlbum
、AMAZON.MusicGroup
、AMAZON.Genre
、AMAZON.MusicPlaylist
、AMAZON.MusicRecording
、AMAZON.BroadcastChannel
。type
の値はusage
の値に対応する必要があります。たとえばtype
にAMAZON.MusicAlbum
を選択した場合、usage
にはAlexaMusic.Catalog.MusicAlbum
を選択する必要があります。 - --usage
- 必須です。新しいカタログの使用法です。次のいずれかを選択します。
AlexaMusic.Catalog.MusicAlbum
、AlexaMusic.Catalog.MusicGroup
、AlexaMusic.Catalog.Genre
、AlexaMusic.Catalog.MusicPlaylist
、AlexaMusic.Catalog.MusicRecording
、AlexaMusic.Catalog.BroadcastChannel
。
選択した値は、type
値に対応する必要があります。 - --profile, -p
- 任意です。更新または作成するプロファイルです。指定したプロファイルが既に存在する場合、CLIは入力した内容でプロファイルを上書きします。指定しない場合、CLIは対話型のプロンプトで新しいプロファイルの作成か、既存のプロファイルの更新かをたずねます。
- --full-response
- 任意です。応答の本文、ヘッダー、ステータスが1つのオブジェクトとして返すための設定です。
- --debug
- 任意です。標準エラー出力にデバッグメッセージを追加するための設定です。
create-catalog-upload
カタログの新しいアップロードを作成し、アップロード状態を追跡する場所を返します。
構文
$ ask smapi create-catalog-upload [--catalog-id | -c <カタログID>]
[--catalog-upload-request-body <カタログアップロードリクエスト本文>]
[--profile | -p <プロフィール>]
[--debug]
オプション
- --catalog-id, -c
- 必須です。一意のカタログIDです。
- --catalog-upload-request-body
- 必須です。作成したコンテンツアップロードのリクエスト本文です。[JSON]
- --profile, -p
- 使用するASK CLIプロファイルです。このオプションを含めない場合は、ASK CLIはデフォルトのプロファイルを使用します。
- --debug
- このオプションを指定すると、コマンド出力にデバッグメッセージが表示されます。
create-export-request-for-skill
スキルIDとステージを指定してスキルの新しいエクスポートを作成します。
構文
$ ask smapi create-export-request-for-skill [--skill-id | -s <スキルID>]
[--stage | -g <ステージ>]
[--profile | -p <プロフィール>]
[--debug]
オプション
- --skill-id, -s
- 必須です。スキルIDです。
- --stage, -g
- 必須です。スキルのステージです。
- --profile, -p
- 使用するASK CLIプロファイルです。このオプションを含めない場合は、ASK CLIはデフォルトのプロファイルを使用します。
- --debug
- このオプションを指定すると、コマンド出力にデバッグメッセージが表示されます。
create-interaction-model-catalog
新しいスキルを作成します。詳細については、Interaction Model Catalog Management REST API Referenceを参照してください。
構文
$ ask smapi create-interaction-model-catalog [--catalog-name <カタログ名>]
[--catalog-description <カタログの説明>]
[--profile | -p <プロフィール>]
[--debug]
オプション
- --catalog-name
- 必須です。カタログの名前です。
- --catalog-description
- 任意です。カタログの説明文字列です。
- --profile, -p
- 使用するASK CLIプロファイルです。このオプションを含めない場合は、ASK CLIはデフォルトのプロファイルを使用します。
- --debug
- このオプションを指定すると、コマンド出力にデバッグメッセージが表示されます。
create-interaction-model-catalog-version
指定したcatalogIdの新しいカタログバージョンを作成します。詳細については、Interaction Model Catalog Management REST API Referenceを参照してください。
構文
$ ask smapi create-interaction-model-catalog-version [--catalog-id | -c <カタログID>]
[--source-type <ソースの種類>]
[-source-url <ソースのURL>]
[--description <説明>]
[--profile | -p <プロフィール>]
[--debug]
オプション
- --catalog-id, -c
- 必須です。一意のカタログIDです。
- --source-type
- カタログの種類です。
- --source-url
- 参照するカタログのURLです。
- --description
- 特定のカタログバージョンの説明文字列です。
- --profile, -p
- 使用するASK CLIプロファイルです。このオプションを含めない場合は、ASK CLIはデフォルトのプロファイルを使用します。
- --debug
- このオプションを指定すると、コマンド出力にデバッグメッセージが表示されます。
create-interaction-model-slot-type
指定したslotTypeId内に新しいスロットタイプバージョンを作成します。
構文
$ ask smapi create-interaction-model-slot-type [--slot-type <スロットタイプ>]
[--profile | -p <プロフィール>]
[--debug]
オプション
- --slot-type
- 必須です。[JSON]
- --profile, -p
- 使用するASK CLIプロファイルです。このオプションを含めない場合は、ASK CLIはデフォルトのプロファイルを使用します。
- --debug
- このオプションを指定すると、コマンド出力にデバッグメッセージが表示されます。
create-interaction-model-slot-type-version
指定したslotTypeIdの新しいスロットタイプエンティティバージョンを作成します。
構文
$ ask smapi create-interaction-model-slot-type-version [--slot-type-id <スロットタイプID>]
[--slot-type <スロットタイプ>]
[--profile | -p <プロフィール>]
[--debug]
オプション
- --slot-type-id
- 必須です。スロットタイプのIDです。
- --slot-type
- 必須です。[JSON]
- --profile, -p
- 使用するASK CLIプロファイルです。このオプションを含めない場合は、ASK CLIはデフォルトのプロファイルを使用します。
- --debug
- このオプションを指定すると、コマンド出力にデバッグメッセージが表示されます。
create-isp-for-vendor
指定されたベンダーIDで新しいスキル内商品を作成します。
構文
$ ask smapi create-isp-for-vendor [--create-in-skill-product-request <create-in-skill-product-request>]
[--profile | -p <プロフィール>]
[--debug]
オプション
- --create-in-skill-product-request
- 必須です。createInSkillProduct APIのリクエスト本文をJSONファイルで定義します。
file:<ファイルパス/jsonファイル名>
を使用します。ファイル形式の詳細については、スキル内商品を作成する(SMAPI API)を参照してください。 - --profile, -p
- 使用するASK CLIプロファイルです。このオプションを含めない場合は、ASK CLIはデフォルトのプロファイルを使用します。
- --debug
- このオプションを指定すると、コマンド出力にデバッグメッセージが表示されます。
create-skill-for-vendor
指定されたベンダーIDで新しいスキルを作成します。このコマンドを使用する前にマニフェストスキーマに関する情報を取得するには、get-resource-schemaを呼び出します。
構文
$ ask smapi create-skill-for-vendor [--manifest <マニフェスト>]
[--profile | -p <プロフィール>]
[--debug]
オプション
- --manifest
- 必須です。createSkill APIのリクエスト本文を定義します。[JSON]
- --profile, -p
- 使用するASK CLIプロファイルです。このオプションを含めない場合は、ASK CLIはデフォルトのプロファイルを使用します。
- --debug
- このオプションを指定すると、コマンド出力にデバッグメッセージが表示されます。
create-skill-package
スキルの新しいインポートを作成します。このコマンドを使用する前にスキルパッケージ構造に関する情報を取得するには、get-resource-schemaを呼び出します。
構文
$ ask smapi create-skill-package [--vendor-id <ベンダーID>]
[--location <場所>]
[--profile | -p <プロフィール>]
[--debug]
オプション
- --vendor-id
- 必須です。スキルを所有しているベンダーのIDです。
- --location
- 必須です。パッケージの場所です。
- --profile, -p
- 使用するASK CLIプロファイルです。このオプションを含めない場合は、ASK CLIはデフォルトのプロファイルを使用します。
- --debug
- このオプションを指定すると、コマンド出力にデバッグメッセージが表示されます。
create-smarthome-capability-evaluation
スマートホームスキルの機能評価を作成して開始します。
構文
$ ask smapi create-smarthome-capability-evaluation [--skill-id | -s <スキルID>]
[--capability-test-plan-id <機能テスト計画ID>]
[--endpoint-endpoint-id <エンドポイントID>]
[--stage | -g <ステージ>]
[--profile | -p <プロファイル>]
[--full-response]
[--debug]
オプション
- --skill-id, -s
- 必須です。一意のスキルIDです。
- --capability-test-plan-id
- 必須です。各テスト計画を示す一意のIDです。
- --endpoint-endpoint-id
- 必須です。一意のエンドポイントIDです。
- --stage, -g
- スキルのステージを表します。有効な値は
development
とlive
です。 - --profile, -p
- 使用するASK CLIプロファイルを提供します。このオプションを含めない場合は、ASK CLIはデフォルトのプロファイルを使用します。
- --full-response
- 応答の本文、ヘッダー、ステータスが1つのオブジェクトとして返されます。
- --debug
- ASK CLIはコマンド出力にデバッグメッセージを表示します。
create-upload-url
新しいアップロードURLを作成します。
構文
$ ask smapi create-upload-url [--profile | -p <プロファイル>]
[--debug]
オプション
- --profile, -p
- 使用するASK CLIプロファイルです。このオプションを含めない場合は、ASK CLIはデフォルトのプロファイルを使用します。
- --debug
- このオプションを指定すると、コマンド出力にデバッグメッセージが表示されます。
delete-account-linking-info
スキルの特定ステージのアカウントリンク情報を削除します。
構文
$ ask smapi delete-account-linking-info [--skill-id | -s <スキルID>]
[--stage | -g <ステージ>]
[--profile | -p <プロフィール>]
[--debug]
オプション
- --skill-id, -s
- 必須です。スキルIDです。
- --stage, -g
- 必須です。新たに認定されたステージを含むスキルのステージです。* `development` - 現在開発中のスキルがこのステージに対応します。 * `certified` - 認定を完了し、公開準備のできたスキルがこのステージに対応します。 * `live` - 現在公開中のスキルがこのステージに対応します。
- --profile, -p
- 使用するASK CLIプロファイルです。このオプションを含めない場合は、ASK CLIはデフォルトのプロファイルを使用します。
- --debug
- このオプションを指定すると、コマンド出力にデバッグメッセージが表示されます。
delete-asr-annotation-set
自動音声認識(ASR)アノテーションセットを削除します。詳細については、自動音声認識(ASR)評価ツールについておよびこのコマンドのREST APIバージョンを参照してください。
構文
$ ask smapi delete-asr-annotation-set [--skill-id | -s <skill-id>]
[--annotation-set-id <annotation-set-id>
[--full-response]
[--profile | -p <プロフィール>]
[--debug]
オプション
- --skill-id, -s
- 必須です。スキルIDです。
- --annotation-set-id
- 必須です。アノテーションセットのIDです。
- --full-response
- このオプションを指定すると、応答の本文、ヘッダー、ステータスが1つのオブジェクトとして返されます。
- --profile, -p
- 使用するASK CLIプロファイルです。このオプションを含めない場合は、ASK CLIはデフォルトのプロファイルを使用します。
- --debug
- このオプションを指定すると、コマンド出力にデバッグメッセージが表示されます。
delete-interaction-model-catalog
カタログを削除します。詳細については、Interaction Model Catalog Management REST API Referenceを参照してください。
構文
$ ask smapi delete-interaction-model-catalog [--catalog-id | -c <カタログID>]
[--profile | -p <プロフィール>]
[--debug]
オプション
- --catalog-id, -c
- 必須です。一意のカタログIDです。
- --profile, -p
- 使用するASK CLIプロファイルです。このオプションを含めない場合は、ASK CLIはデフォルトのプロファイルを使用します。
- --debug
- このオプションを指定すると、コマンド出力にデバッグメッセージが表示されます。
delete-interaction-model-catalog-version
カタログのバージョンを削除します。詳細については、Interaction Model Catalog Management REST API Referenceを参照してください。
構文
$ ask smapi delete-interaction-model-catalog-version [--catalog-id | -c <カタログID>]
[--vers <バージョン>]
[--profile | -p <プロフィール>]
[--debug]
オプション
- --catalog-id, -c
- 必須です。一意のカタログIDです。
- --vers
- 必須です。音声対話モデルのバージョンです。
- --profile, -p
- 使用するASK CLIプロファイルです。このオプションを含めない場合は、ASK CLIはデフォルトのプロファイルを使用します。
- --debug
- このオプションを指定すると、コマンド出力にデバッグメッセージが表示されます。
delete-interaction-model-slot-type
スロットタイプを削除します。
構文
$ ask smapi delete-interaction-model-slot-type [--slot-type-id <スロットタイプID>]
[--profile | -p <プロフィール>]
[--debug]
オプション
- --slot-type-id
- 必須です。スロットタイプのIDです。
- --profile, -p
- 使用するASK CLIプロファイルです。このオプションを含めない場合は、ASK CLIはデフォルトのプロファイルを使用します。
- --debug
- このオプションを指定すると、コマンド出力にデバッグメッセージが表示されます。
delete-interaction-model-slot-type-version
スロットタイプのバージョンを削除します。
構文
$ ask smapi delete-interaction-model-slot-type-version [--slot-type-id <スロットタイプID>]
[--vers <バージョン>]
[--profile | -p <プロフィール>]
[--debug]
オプション
- --slot-type-id
- 必須です。スロットタイプのIDです。
- --vers
- 必須です。音声対話モデルのバージョンです。
- --profile, -p
- 使用するASK CLIプロファイルです。このオプションを含めない場合は、ASK CLIはデフォルトのプロファイルを使用します。
- --debug
- このオプションを指定すると、コマンド出力にデバッグメッセージが表示されます。
delete-isp-for-product
指定されたproductIdのスキル内商品を削除します。開発ステージのみサポートされています。公開中のスキル内商品、またはスキルに関連付けられたスキル内商品は、このAPIでは削除できません。
構文
$ ask smapi delete-isp-for-product [--product-id <商品ID>]
[--stage | -g <ステージ>]
[--if-match <一致>]
[--profile | -p <プロフィール>]
[--debug]
オプション
- --product-id
- 必須です。スキル内商品のIDです。
- --stage, -g
- 必須です。スキルのステージです。
- --if-match
- 任意です。エンティティタグを指定したリクエストヘッダーです。サーバーは、eTagがリソースの現在のeTagと一致した場合にのみリソースを更新します。
- --profile, -p
- 使用するASK CLIプロファイルです。このオプションを含めない場合は、ASK CLIはデフォルトのプロファイルを使用します。
- --debug
- このオプションを指定すると、コマンド出力にデバッグメッセージが表示されます。
delete-private-distribution-account-id
非公開の配信アカウントからIDを削除します。
構文
$ ask smapi delete-private-distribution-account-id [--skill-id | -s <スキルID>]
[--stage | -g <ステージ>]
[--id <ID>]
[--profile | -p <プロフィール>]
[--debug]
オプション
- --skill-id, -s
- 必須です。スキルIDです。
- --stage, -g
- 必須です。スキルのステージです。
- --id
- 必須です。スキルを非公開で配信できるARNです。
- --profile, -p
- 使用するASK CLIプロファイルです。このオプションを含めない場合は、ASK CLIはデフォルトのプロファイルを使用します。
- --debug
- このオプションを指定すると、コマンド出力にデバッグメッセージが表示されます。
delete-skill
指定されたskillIdのスキルとモデルを削除します。
構文
$ ask smapi delete-skill [--skill-id | -s <スキルID>]
[--profile | -p <プロフィール>]
[--debug]
オプション
- --skill-id, -s
- 必須です。スキルIDです。
- --profile, -p
- 使用するASK CLIプロファイルです。このオプションを含めない場合は、ASK CLIはデフォルトのプロファイルを使用します。
- --debug
- このオプションを指定すると、コマンド出力にデバッグメッセージが表示されます。
delete-skill-enablement
指定したskillId/stageとcustomerId(Authトークンにより取得)の有効化ステータスを削除します。
構文
$ ask smapi delete-skill-enablement [--skill-id | -s <スキルID>]
[--stage | -g <ステージ>]
[--profile | -p <プロフィール>]
[--debug]
オプション
- --skill-id, -s
- 必須です。スキルIDです。
- --stage, -g
- 必須です。スキルのステージです。
- --profile, -p
- 使用するASK CLIプロファイルです。このオプションを含めない場合は、ASK CLIはデフォルトのプロファイルを使用します。
- --debug
- このオプションを指定すると、コマンド出力にデバッグメッセージが表示されます。
disassociate-isp-with-skill
スキル内商品とスキルの関連付けを解除します。
構文
$ ask smapi disassociate-isp-with-skill [--product-id <商品ID>]
[--skill-id | -s <スキルID>]
[--profile | -p <プロフィール>]
[--debug]
オプション
- --product-id
- 必須です。スキル内商品のIDです。
- --skill-id, -s
- 必須です。スキルIDです。
- --profile, -p
- 使用するASK CLIプロファイルです。このオプションを含めない場合は、ASK CLIはデフォルトのプロファイルを使用します。
- --debug
- このオプションを指定すると、コマンド出力にデバッグメッセージが表示されます。
end-beta-test
特定のスキルのベータテストを終了します。システムは各テスターの参加資格を取り消し、テスターにアクセス終了の通知メールを送信します。
構文
$ ask smapi end-beta-test [--skill-id | -s <スキルID>]
[--profile | -p <プロフィール>]
[--debug]
オプション
- --skill-id, -s
- 必須です。スキルIDです。
- --profile, -p
- 使用するASK CLIプロファイルです。このオプションを含めない場合は、ASK CLIはデフォルトのプロファイルを使用します。
- --debug
- このオプションを指定すると、コマンド出力にデバッグメッセージが表示されます。
export-package
スキルパッケージを現在のディレクトリのskill-package
フォルダにダウンロードします。
構文
$ ask smapi export-package [--skill-id | -s <スキルID>]
[--stage | -g <ステージ>]
[--profile | -p <プロフィール>]
[--debug]
オプション
- --skill-id, -s
- 必須です。スキルIDです。
- --stage, -g
- 必須です。スキルのステージです。
- --profile, -p
- 任意です。使用するASK CLIプロファイルです。このオプションを含めない場合は、ASK CLIはデフォルトのプロファイルを使用します。
- --debug
- 任意です。このオプションを指定すると、コマンド出力にデバッグメッセージが表示されます。
generate-catalog-upload-url
データをアップロードするための署名付きURLを生成します。
構文
$ ask smapi generate-catalog-upload-url [--catalog-id | -c <カタログID>]
[--number-of-upload-parts <アップロードパートの数>]
[--profile | -p <プロフィール>]
[--debug]
オプション
- --catalog-id, -c
- 必須です。一意のカタログIDです。
- --number-of-upload-parts
- 必須です。ファイルのパート数です。アップロードする各ファイルパート数と同じ数の署名付きURLが生成されます。
- --profile, -p
- 使用するASK CLIプロファイルです。このオプションを含めない場合は、ASK CLIはデフォルトのプロファイルを使用します。
- --debug
- このオプションを指定すると、コマンド出力にデバッグメッセージが表示されます。
generate-credentials-for-alexa-hosted-skill
Alexa-hostedスキルのリポジトリにアクセスする認証情報を生成します。
構文
$ ask smapi generate-credentials-for-alexa-hosted-skill [--skill-id | -s <スキルID>]
[--repository-url <リポジトリURL>]
[--repository-type <リポジトリの種類>]
[--profile | -p <プロフィール>]
[--debug]
オプション
- --skill-id, -s
- 必須です。スキルIDです。
- --repository-url
- 任意です。Alexa-hostedスキルリポジトリのURLです。
- --repository-type
- 任意です。Alexa-hostedスキルリポジトリの種類です。[ENUM]: GIT。
- --profile, -p
- 使用するASK CLIプロファイルです。このオプションを含めない場合は、ASK CLIはデフォルトのプロファイルを使用します。
- --debug
- このオプションを指定すると、コマンド出力にデバッグメッセージが表示されます。
get-account-linking-info
スキルのアカウントリンク情報を取得します。
構文
$ ask smapi get-account-linking-info [--skill-id | -s <スキルID>]
[--stage | -g <ステージ>]
[--profile | -p <プロフィール>]
[--debug]
オプション
- --skill-id, -s
- 必須です。スキルIDです。
- --stage, -g
- 必須です。新たに認定されたステージを含むスキルのステージです。* `development` - 現在開発中のスキルがこのステージに対応します。 * `certified` - 認定を完了し、公開準備のできたスキルがこのステージに対応します。 * `live` - 現在公開中のスキルがこのステージに対応します。
- --profile, -p
- 使用するASK CLIプロファイルです。このオプションを含めない場合は、ASK CLIはデフォルトのプロファイルを使用します。
- --debug
- このオプションを指定すると、コマンド出力にデバッグメッセージが表示されます。
get-alexa-hosted-skill-metadata
Alexa-hostedスキルのメタデータを取得します。
構文
$ ask smapi get-alexa-hosted-skill-metadata [--skill-id | -s <スキルID>]
[--profile | -p <プロフィール>]
[--debug]
オプション
- --skill-id, -s
- 必須です。スキルIDです。
- --profile, -p
- 使用するASK CLIプロファイルです。このオプションを含めない場合は、ASK CLIはデフォルトのプロファイルを使用します。
- --debug
- このオプションを指定すると、コマンド出力にデバッグメッセージが表示されます。
get-alexa-hosted-skill-user-permissions
Alexa-hostedスキル機能に対する現在のユーザーのアクセス権限を取得します。
構文
$ ask smapi get-alexa-hosted-skill-user-permissions [--hosted-skill-permission-type <hosted-skill-permission-type>]
[--profile | -p <プロフィール>]
[--debug]
オプション
- --hosted-skill-permission-type
- 必須です。チェックする必要のあるAlexa-hostedスキル機能の権限です。
- --profile, -p
- 使用するASK CLIプロファイルです。このオプションを含めない場合は、ASK CLIはデフォルトのプロファイルを使用します。
- --debug
- このオプションを指定すると、コマンド出力にデバッグメッセージが表示されます。
get-asr-annotation-set
自動音声認識(ASR)アノテーションセットのメタデータを取得します。このコマンドは、アノテーションセットの名前、アノテーションセット内のアノテーション数、アノテーションセットが最後に更新された時刻を返します。詳細については、自動音声認識(ASR)評価ツールについておよびこのコマンドのREST APIバージョンを参照してください。
構文
$ ask smapi get-asr-annotation-set [--skill-id | -s <skill-id>]
[--annotation-set-id <annotation-set-id>
[--full-response]
[--profile | -p <プロフィール>]
[--debug]
オプション
- --skill-id, -s
- 必須です。スキルIDです。
- --annotation-set-id
- 必須です。アノテーションセットのIDです。
- --full-response
- このオプションを指定すると、応答の本文、ヘッダー、ステータスが1つのオブジェクトとして返されます。
- --profile, -p
- 使用するASK CLIプロファイルです。このオプションを含めない場合は、ASK CLIはデフォルトのプロファイルを使用します。
- --debug
- このオプションを指定すると、コマンド出力にデバッグメッセージが表示されます。
get-beta-test
特定のスキルのベータテストを取得します。
構文
$ ask smapi get-beta-test [--skill-id | -s <スキルID>]
[--profile | -p <プロフィール>]
[--debug]
オプション
- --skill-id, -s
- 必須です。スキルIDです。
- --profile, -p
- 使用するASK CLIプロファイルです。このオプションを含めない場合は、ASK CLIはデフォルトのプロファイルを使用します。
- --debug
- このオプションを指定すると、コマンド出力にデバッグメッセージが表示されます。
get-certification-review
特定の認定リソースを取得します。応答には、Amazonによる審査終了までにかかる予想残り時間を示すスキル審査の追跡情報が含まれます。審査が完了すると、応答には審査結果も入ります。古い認定については取得できない場合もありますが、継続中の認定には常に応答を返します。認定情報が取得できない場合、結果にはHTTPステータスコード404が返されます。
構文
$ ask smapi get-certification-review [--accept-language <言語>]
[--skill-id | -s <スキルID>]
[--certification-id | -c <certification-id>]
[--profile | -p <プロフィール>]
[--debug]
オプション
- --accept-language
- 任意です。コンテキスト内のユーザーのロケールまたは言語です。
- --skill-id, -s
- 必須です。スキルIDです。
- --certification-id, -c
- 必須です。認定審査のIDです。直近の認定審査を取得するには、
~mostRecent
の値を使用します。この場合のAPI動作は、リクエストで実際に指定されたIDが最新の認定審査のIDだった場合と同様です。 - --profile, -p
- 使用するASK CLIプロファイルです。このオプションを含めない場合は、ASK CLIはデフォルトのプロファイルを使用します。
- --debug
- このオプションを指定すると、コマンド出力にデバッグメッセージが表示されます。
get-certifications-list
過去の認定や現在有効な認定など、スキルで利用可能なすべての認定のリストを取得します。デフォルトの並べ替え順序は、認定のskillSubmissionTimestampの新しい順です。
構文
$ ask smapi get-certifications-list [--skill-id | -s <skill-id>]
[--next-token <次のトークン>]
[--max-results <結果の最大件数>]
[--profile | -p <プロフィール>]
[--debug]
オプション
- --skill-id, -s
- 必須です。スキルIDです。
- --next-token
- 任意です。このAPI呼び出しへの応答が切り捨てられる(isTruncated応答要素の値がtrue)ときは、応答にnextToken要素も含まれます。nextTokenの値は、オブジェクトの次のセットのリストを表示する継続トークンとして次のリクエストで使用できます。継続トークンは、スキル管理APIが理解できるOpaque値です。トークンは24時間で有効期限が切れます。
- --max-results
- 任意です。応答本文で返される結果の最大数を設定します。上限である50件よりも少ない結果を取得する場合、このパラメーターをリクエストに追加できます。上限を超えるmaxResultsを指定することはできません。応答に含まれる項目がmaxResultsより少ない場合はありますが、この値を超えることはありません。検索条件を満たす結果が他にもあるけれど結果が返されない場合、応答にはisTruncated = trueが含まれます。
- --profile, -p
- 使用するASK CLIプロファイルです。このオプションを含めない場合は、ASK CLIはデフォルトのプロファイルを使用します。
- --debug
- このオプションを指定すると、コマンド出力にデバッグメッセージが表示されます。
get-clone-locale-status
処理中のclone-localeワークフローのステータスが返されます。スキルのクローンについては、スキルのクローンを作成する、関連するSMAPI APIリファレンスを参照してください。
構文:
ask smapi get-clone-locale-status [-s,--skill-id <スキルID>]
[-g,--stage <ステージ>]
[--clone-locale-request-id <クローンロケールリクエストID>]
[-p、--profile <プロファイル>]
[--debug]
[-h、--help]
オプション:
- -s, --skill-id
- 必須です。クローンを作成するスキルのIDです。
- -g, --stage
- 必須です。クローンを作成するスキルの公開ステージです。
有効な値:development
- --clone-locale-request-id
- 必須です。clone-localeワークフローのIDを定義します。
~latest
に設定した場合、結果には最新のclone-localeワークフローのステータスが返されます。 - -p, --profile
- 任意です。ASK CLIがスキルリソースをデプロイするプロファイルです。入力しない場合、ASK CLIはデフォルトのプロファイルを使用します。
- --debug
- 任意です。このオプションを指定すると、コマンド出力にデバッグメッセージが表示されます。
get-content-upload-by-id
特定のカタログの特定のアップロードに関する情報を取得します。アップロードの取り込みステップとファイルダウンロードのURLを含みます。
構文
$ ask smapi get-content-upload-by-id [--catalog-id | -c <カタログID>]
[--upload-id <アップロードID>]
[--profile | -p <プロフィール>]
[--debug]
オプション
- --catalog-id, -c
- 必須です。一意のカタログIDです。
- --upload-id
- 必須です。一意のアップロードIDです。
- --profile, -p
- 使用するASK CLIプロファイルです。このオプションを含めない場合は、ASK CLIはデフォルトのプロファイルを使用します。
- --debug
- このオプションを指定すると、コマンド出力にデバッグメッセージが表示されます。
get-import-status
指定されたimportIdのステータスを取得します。
構文
$ ask smapi get-import-status [--import-id <インポートID>]
[--profile | -p <プロフィール>]
[--debug]
オプション
- --import-id
- 必須です。インポートIDです。
- --profile, -p
- 使用するASK CLIプロファイルです。このオプションを含めない場合は、ASK CLIはデフォルトのプロファイルを使用します。
- --debug
- このオプションを指定すると、コマンド出力にデバッグメッセージが表示されます。
get-interaction-model
指定したステージにあるスキルの音声対話モデルを取得します。
構文
$ ask smapi get-interaction-model [--skill-id | -s <スキルID>]
[--stage | -g <ステージ>]
[--locale | -l <ロケール>]
[--profile | -p <プロフィール>]
[--debug]
オプション
- --skill-id, -s
- 必須です。スキルIDです。
- --stage, -g
- 必須です。新たに認定されたステージを含むスキルのステージです。* `development` - 現在開発中のスキルがこのステージに対応します。 * `certified` - 認定を完了し、公開準備のできたスキルがこのステージに対応します。 * `live` - 現在公開中のスキルがこのステージに対応します。
- --locale, -l
- 必須です。リクエストされたモデルのロケール。例:en-GB、en-US、de-DE。
- --profile, -p
- 使用するASK CLIプロファイルです。このオプションを含めない場合は、ASK CLIはデフォルトのプロファイルを使用します。
- --debug
- このオプションを指定すると、コマンド出力にデバッグメッセージが表示されます。
get-interaction-model-catalog-definition
カタログ定義を取得します。詳細については、Interaction Model Catalog Management REST API Referenceを参照してください。
構文
$ ask smapi get-interaction-model-catalog-definition [--catalog-id | -c <カタログID>]
[--profile | -p <プロフィール>]
[--debug]
オプション
- --catalog-id, -c
- 必須です。一意のカタログIDです。
- --profile, -p
- 使用するASK CLIプロファイルです。このオプションを含めない場合は、ASK CLIはデフォルトのプロファイルを使用します。
- --debug
- このオプションを指定すると、コマンド出力にデバッグメッセージが表示されます。
get-interaction-model-catalog-update-status
カタログの作成や更新を行う以前のリクエストのステータスを取得します。詳細については、Interaction Model Catalog Management REST API Referenceを参照してください。
構文
$ ask smapi get-interaction-model-catalog-update-status [--catalog-id | -c <カタログID>]
[--update-request-id <更新リクエストID>]
[--profile | -p <プロフィール>]
[--debug]
オプション
- --catalog-id, -c
- 必須です。一意のカタログIDです。
- --update-request-id
- 必須です。スロットタイプバージョンの作成プロセスIDです。
- --profile, -p
- 使用するASK CLIプロファイルです。このオプションを含めない場合は、ASK CLIはデフォルトのプロファイルを使用します。
- --debug
- このオプションを指定すると、コマンド出力にデバッグメッセージが表示されます。
get-interaction-model-catalog-values
指定した対話モデルカタログおよびバージョンから値を取得します。詳細については、Interaction Model Catalog Management REST API Referenceを参照してください。
構文
$ ask smapi get-interaction-model-catalog-values [--catalog-id | -c <カタログID>]
[--vers <バージョン>]
[--max-results <結果の最大件数>]
[--next-token <次のトークン>]
[--profile | -p <プロフィール>]
[--debug]
オプション
- --catalog-id, -c
- 必須です。一意のカタログIDです。
- --vers
- 必須です。音声対話モデルのバージョンです。
- --max-results
- 任意です。応答本文で返される結果の最大数を設定します。上限である50件よりも少ない結果を取得する場合、このパラメーターをリクエストに追加できます。上限を超えるmaxResultsを指定することはできません。応答に含まれる項目がmaxResultsより少ない場合はありますが、この値を超えることはありません。検索条件を満たす結果が他にもあるけれど結果が返されない場合、応答にはisTruncated = trueが含まれます。
- --next-token
- 任意です。このAPI呼び出しへの応答が切り捨てられる(isTruncated応答要素の値がtrue)ときは、応答にnextToken要素も含まれます。nextTokenの値は、オブジェクトの次のセットのリストを表示する継続トークンとして次のリクエストで使用できます。継続トークンは、スキル管理APIが理解できるOpaque値です。トークンは24時間で有効期限が切れます。
- --profile, -p
- 使用するASK CLIプロファイルです。このオプションを含めない場合は、ASK CLIはデフォルトのプロファイルを使用します。
- --debug
- このオプションを指定すると、コマンド出力にデバッグメッセージが表示されます。
get-interaction-model-catalog-version
カタログの特定バージョンを取得します。詳細については、Interaction Model Catalog Management REST API Referenceを参照してください。
構文
$ ask smapi get-interaction-model-catalog-version [--catalog-id | -c <カタログID>]
[--vers <バージョン>]
[--profile | -p <プロフィール>]
[--debug]
オプション
- --catalog-id, -c
- 必須です。一意のカタログIDです。
- --vers
- 必須です。音声対話モデルのバージョンです。
- --profile, -p
- 使用するASK CLIプロファイルです。このオプションを含めない場合は、ASK CLIはデフォルトのプロファイルを使用します。
- --debug
- このオプションを指定すると、コマンド出力にデバッグメッセージが表示されます。
get-interaction-model-metadata
指定したステージにある音声対話モデルの最新メタデータを取得します。
構文
$ ask smapi get-interaction-model-metadata [--skill-id | -s <スキルID>]
[--stage | -g <ステージ>]
[--locale | -l <ロケール>]
[--profile | -p <プロフィール>]
[--debug]
オプション
- --skill-id, -s
- 必須です。スキルIDです。
- --stage, -g
- 必須です。新たに認定されたステージを含むスキルのステージです。* `development` - 現在開発中のスキルがこのステージに対応します。 * `certified` - 認定を完了し、公開準備のできたスキルがこのステージに対応します。 * `live` - 現在公開中のスキルがこのステージに対応します。
- --locale, -l
- 必須です。リクエストされたモデルのロケール。例:en-GB、en-US、de-DE。
- --profile, -p
- 使用するASK CLIプロファイルです。このオプションを含めない場合は、ASK CLIはデフォルトのプロファイルを使用します。
- --debug
- このオプションを指定すると、コマンド出力にデバッグメッセージが表示されます。
get-interaction-model-slot-type-build-status
指定したslotTypeIdのスロットタイプリソースとそのサブリソースのステータスを取得します。
構文
$ ask smapi get-interaction-model-slot-type-build-status [--slot-type-id <スロットタイプID>]
[--update-request-id <更新リクエストID>]
[--profile | -p <プロフィール>]
[--debug]
オプション
- --slot-type-id
- 必須です。スロットタイプのIDです。
- --update-request-id
- 必須です。slotTypeバージョンの作成プロセスのIDです。
- --profile, -p
- 使用するASK CLIプロファイルです。このオプションを含めない場合は、ASK CLIはデフォルトのプロファイルを使用します。
- --debug
- このオプションを指定すると、コマンド出力にデバッグメッセージが表示されます。
get-interaction-model-slot-type-definition
スロットタイプ定義を取得します。
構文
$ ask smapi get-interaction-model-slot-type-definition [--slot-type-id <スロットタイプID>]
[--profile | -p <プロフィール>]
[--debug]
オプション
- --slot-type-id
- 必須です。スロットタイプのIDです。
- --profile, -p
- 使用するASK CLIプロファイルです。このオプションを含めない場合は、ASK CLIはデフォルトのプロファイルを使用します。
- --debug
- このオプションを指定すると、コマンド出力にデバッグメッセージが表示されます。
get-interaction-model-slot-type-version
スロットタイプバージョンを指定してスロットタイプバージョンのデータを取得します。
構文
$ ask smapi get-interaction-model-slot-type-version [--slot-type-id <スロットタイプID>]
[--vers <バージョン>]
[--profile | -p <プロフィール>]
[--debug]
オプション
- --slot-type-id
- 必須です。スロットタイプのIDです。
- --vers
- 必須です。音声対話モデルのバージョンです。
- --profile, -p
- 使用するASK CLIプロファイルです。このオプションを含めない場合は、ASK CLIはデフォルトのプロファイルを使用します。
- --debug
- このオプションを指定すると、コマンド出力にデバッグメッセージが表示されます。
get-interaction-model-version
バージョンを指定してスキルの音声対話モデルを取得します。
構文
$ ask smapi get-interaction-model-version [--skill-id | -s <スキルID>]
[--stage | -g <ステージ>]
[--locale | -l <ロケール>]
[--vers <バージョン>]
[--profile | -p <プロフィール>]
[--debug]
オプション
- --skill-id, -s
- 必須です。スキルIDです。
- --stage, -g
- 必須です。新たに認定されたステージを含むスキルのステージです。* `development` - 現在開発中のスキルがこのステージに対応します。 * `certified` - 認定を完了し、公開準備のできたスキルがこのステージに対応します。 * `live` - 現在公開中のスキルがこのステージに対応します。
- --locale, -l
- 必須です。リクエストされたモデルのロケール。例:en-GB、en-US、de-DE。
- --vers
- 必須です。取得する音声対話モデルのバージョンです。
~current
を使い、音声対話モデルの現在のバージョンを取得します。 - --profile, -p
- 使用するASK CLIプロファイルです。このオプションを含めない場合は、ASK CLIはデフォルトのプロファイルを使用します。
- --debug
- このオプションを指定すると、コマンド出力にデバッグメッセージが表示されます。
get-isp-associated-skills
スキル内商品に関連付けられたスキルを取得します。
構文
$ ask smapi get-isp-associated-skills [--product-id <商品ID>]
[--stage | -g <ステージ>]
[--next-token <次のトークン>]
[--max-results <結果の最大件数>]
[--profile | -p <プロフィール>]
[--debug]
オプション
- --product-id
- 必須です。スキル内商品のIDです。
- --stage, -g
- 必須です。スキルのステージです。
- --next-token
- 任意です。このAPI呼び出しへの応答が切り捨てられる(isTruncated応答要素の値がtrue)ときは、応答にnextToken要素も含まれます。nextTokenの値は、オブジェクトの次のセットのリストを表示する継続トークンとして次のリクエストで使用できます。継続トークンは、スキル管理APIが理解できるOpaque値です。トークンは24時間で有効期限が切れます。
- --max-results
- 任意です。応答本文で返される結果の最大数を設定します。上限である50件よりも少ない結果を取得する場合、このパラメーターをリクエストに追加できます。上限を超えるmaxResultsを指定することはできません。応答に含まれる項目がmaxResultsより少ない場合はありますが、この値を超えることはありません。検索条件を満たす結果が他にもあるけれど結果が返されない場合、応答にはisTruncated = trueが含まれます。
- --profile, -p
- 使用するASK CLIプロファイルです。このオプションを含めない場合は、ASK CLIはデフォルトのプロファイルを使用します。
- --debug
- このオプションを指定すると、コマンド出力にデバッグメッセージが表示されます。
get-isp-definition
指定された商品IDのスキル内商品定義を返します。
構文
$ ask smapi get-isp-definition [--product-id <商品ID>]
[--stage | -g <ステージ>]
[--profile | -p <プロフィール>]
[--debug]
オプション
- --product-id
- 必須です。スキル内商品のIDです。
- --stage, -g
- 必須です。スキルのステージです。
- --profile, -p
- 使用するASK CLIプロファイルです。このオプションを含めない場合は、ASK CLIはデフォルトのプロファイルを使用します。
- --debug
- このオプションを指定すると、コマンド出力にデバッグメッセージが表示されます。
get-isp-list-for-skill-id
スキルIDを指定してスキル内商品のリストを取得します。
構文
$ ask smapi get-isp-list-for-skill-id [--skill-id | -s <スキルID>]
[--stage | -g <ステージ>]
[--next-token <次のトークン>]
[--max-results <結果の最大件数>]
[--profile | -p <プロフィール>]
[--debug]
オプション
- --skill-id, -s
- 必須です。スキルIDです。
- --stage, -g
- 必須です。スキルのステージです。
- --next-token
- 任意です。このAPI呼び出しへの応答が切り捨てられる(isTruncated応答要素の値がtrue)ときは、応答にnextToken要素も含まれます。nextTokenの値は、オブジェクトの次のセットのリストを表示する継続トークンとして次のリクエストで使用できます。継続トークンは、スキル管理APIが理解できるOpaque値です。トークンは24時間で有効期限が切れます。
- --max-results
- 任意です。応答本文で返される結果の最大数を設定します。上限である50件よりも少ない結果を取得する場合、このパラメーターをリクエストに追加できます。上限を超えるmaxResultsを指定することはできません。応答に含まれる項目がmaxResultsより少ない場合はありますが、この値を超えることはありません。検索条件を満たす結果が他にもあるけれど結果が返されない場合、応答にはisTruncated = trueが含まれます。
- --profile, -p
- 使用するASK CLIプロファイルです。このオプションを含めない場合は、ASK CLIはデフォルトのプロファイルを使用します。
- --debug
- このオプションを指定すると、コマンド出力にデバッグメッセージが表示されます。
get-isp-list-for-vendor
ベンダーを指定してスキル内商品のリストを取得します。
構文
$ask smapi get-isp-list-for-vendor[-next-token<次のトークン>]
[--max-results <結果の最大件数>]
[--product-id <商品ID>]
[--stage | -g <ステージ>]
[--type <タイプ>]
[--reference-name <参照名>]
[--status <ステータス>]
[--is-associated-with-skill <スキルとの関連付け>]
[--profile | -p <プロフィール>]
[--debug]
オプション
- --next-token
- 任意です。このAPI呼び出しへの応答が切り捨てられる(isTruncated応答要素の値がtrue)ときは、応答にnextToken要素も含まれます。nextTokenの値は、オブジェクトの次のセットのリストを表示する継続トークンとして次のリクエストで使用できます。継続トークンは、スキル管理APIが理解できるOpaque値です。トークンは24時間で有効期限が切れます。
- --max-results
- 任意です。応答本文で返される結果の最大数を設定します。上限である50件よりも少ない結果を取得する場合、このパラメーターをリクエストに追加できます。上限を超えるmaxResultsを指定することはできません。応答に含まれる項目がmaxResultsより少ない場合はありますが、この値を超えることはありません。検索条件を満たす結果が他にもあるけれど結果が返されない場合、応答にはisTruncated = trueが含まれます。
- --product-id
- 任意です。概要を取得するスキル内商品のIDのリストです。1つのlistInSkillProducts呼び出しで、最大50個のスキル内商品IDを指定できます。このパラメーターを'nextToken'、'maxResults'パラメーターのいずれかまたは両方と使用することはできません。[複数可]: 値はコンマで区切ることができます。
- --stage, -g
- 任意です。スキル内商品を指定したステージでフィルタリングします。[列挙]:development,live
- --type
- 任意です。フィルタリングするスキル内商品のタイプです。[列挙]: SUBSCRIPTION,ENTITLEMENT,CONSUMABLE
- --reference-name
- 任意です。スキル内商品を参照名でフィルタリングします。
- --status
- 任意です。スキル内商品のステータスです。[列挙]: INCOMPLETE,COMPLETE,CERTIFICATION,PUBLISHED,SUPPRESSED
- --is-associated-with-skill
- 任意です。スキル内商品を、スキルに関連付けられているかどうかでフィルタリングします。[列挙]: ASSOCIATED_WITH_SKILL,NO_SKILL_ASSOCIATIONS
- --profile, -p
- 使用するASK CLIプロファイルです。このオプションを含めない場合は、ASK CLIはデフォルトのプロファイルを使用します。
- --debug
- このオプションを指定すると、コマンド出力にデバッグメッセージが表示されます。
get-isp-summary
スキル内商品の概要情報を取得します。
構文
$ ask smapi get-isp-summary [--product-id <商品ID>]
[--stage | -g <ステージ>]
[--profile | -p <プロフィール>]
[--debug]
オプション
- --product-id
- 必須です。スキル内商品のIDです。
- --stage, -g
- 必須です。スキルのステージです。
- --profile, -p
- 使用するASK CLIプロファイルです。このオプションを含めない場合は、ASK CLIはデフォルトのプロファイルを使用します。
- --debug
- このオプションを指定すると、コマンド出力にデバッグメッセージが表示されます。
get-list-of-testers
特定のAlexaスキルのベータテストに参加しているテスターをすべて表示します。
構文
$ ask smapi get-list-of-testers [--skill-id | -s <スキルID>]
[--next-token <次のトークン>]
[--max-results <結果の最大件数>]
[--profile | -p <プロフィール>]
[--debug]
オプション
- --skill-id, -s
- 必須です。スキルIDです。
- --next-token
- 任意です。このAPI呼び出しへの応答が切り捨てられる(isTruncated応答要素の値がtrue)ときは、応答にnextToken要素も含まれます。nextTokenの値は、オブジェクトの次のセットのリストを表示する継続トークンとして次のリクエストで使用できます。継続トークンは、スキル管理APIが理解できるOpaque値です。トークンは24時間で有効期限が切れます。
- --max-results
- 任意です。応答本文で返される結果の最大数を設定します。上限である500件よりも少ない結果を取得する場合、このパラメーターをリクエストに追加できます。応答に含まれる項目がmaxResultsより少ない場合はありますが、この値を超えることはありません。
- --profile, -p
- 使用するASK CLIプロファイルです。このオプションを含めない場合は、ASK CLIはデフォルトのプロファイルを使用します。
- --debug
- このオプションを指定すると、コマンド出力にデバッグメッセージが表示されます。
get-resource-schema
get-resource-schema
コマンドを使用して、CLIまたはSMAPIコマンドを呼び出す前、またはスキルパッケージをローカルで操作する前に、スキルが必要とするスキーマまたはディレクトリ構造に関する情報を取得します。この情報を使用して、エラーが発生する前にスキーマまたはディレクトリ構造を検証できます。詳細については、リソーススキーマREST APIリファレンスを参照してください。
構文
$ ask smapi get-resource-schema [--resource <resource>]
[--operation <operation>]
[--full-response]
[--profile | -p <プロフィール>]
[--debug]
オプション
- --resource
- 必須です。情報を要求するリソースです。
manifest
、skillPackageStructure
のいずれかです。 - --operation
resource
にmanifest
を指定した場合に必須です。マニフェストスキーマを必要とするオペレーションです。マニフェストスキーマは、オペレーションによって異なります。たとえば、スキルを認定のために提出する場合、スキルの初回作成時よりも多くのスキーマ検証が必要となります。次のいずれかです:CREATE_SKILL
,UPDATE_SKILL
,ENABLE_SKILL
,SUBMIT_SKILL
- --full-response
- このオプションを指定すると、応答の本文、ヘッダー、ステータスが1つのオブジェクトとして返されます。
- --profile, -p
- 使用するASK CLIプロファイルです。このオプションを含めない場合は、ASK CLIはデフォルトのプロファイルを使用します。
- --debug
- このオプションを指定すると、コマンド出力にデバッグメッセージが表示されます。
get-rollback-for-skill
rollbackRequestId
が関連付けられているスキルのロールバックステータスを取得します。rollbackRequestId
の代わりに~latest
を使うと、最新のロールバックステータスを取得できます。
構文:
ask smapi get-rollback-for-skill [--skill-id | -s <スキルID>]
[--rollback-request-id <ロールバックリクエストID>]
[--profile | -p <プロファイル>]
[--debug]
オプション:
- --skill-id, -s
- 必須です。スキルIDです。
- --rollback-request-id
- 必須です。ロールバックリクエストのIDです。
~latest
に設定した場合、最新のロールバックリクエストステータスが返されます。
- --profile, -p
- 任意です。ASK CLIがスキルリソースをデプロイするプロファイルです。指定しない場合、CLIはデフォルトのプロファイルを使用します。
- --debug
- 任意です。このオプションを指定すると、コマンド出力にデバッグメッセージを表示します。
get-skill-credentials
スキルのクライアント認証情報(clientId
とclientSecret
)を取得します。
構文
$ ask smapi get-skill-credentials [--skill-id | -s <skill-id>]
[--full-response]
[--profile | -p <プロフィール>]
[--debug]
オプション
- --skill-id, -s
- 必須です。スキルIDです。
- --full-response
- このオプションを指定すると、応答の本文、ヘッダー、ステータスが1つのオブジェクトとして返されます。
- --profile, -p
- 使用するASK CLIプロファイルです。このオプションを含めない場合は、ASK CLIはデフォルトのプロファイルを使用します。
- --debug
- このオプションを指定すると、コマンド出力にデバッグメッセージが表示されます。
get-skill-enablement-status
指定したskillId/stageとcustomerId(Authトークンにより取得)の有効化ステータスが存在するかどうかを確認します。
構文
$ ask smapi get-skill-enablement-status [--skill-id | -s <スキルID>]
[--stage | -g <ステージ>]
[--profile | -p <プロフィール>]
[--debug]
オプション
- --skill-id, -s
- 必須です。スキルIDです。
- --stage, -g
- 必須です。スキルのステージです。
- --profile, -p
- 使用するASK CLIプロファイルです。このオプションを含めない場合は、ASK CLIはデフォルトのプロファイルを使用します。
- --debug
- このオプションを指定すると、コマンド出力にデバッグメッセージが表示されます。
get-skill-manifest
指定したskillIdとステージのスキルマニフェストを返します。
構文
$ ask smapi get-skill-manifest [--skill-id | -s <スキルID>]
[--stage | -g <ステージ>]
[--profile | -p <プロフィール>]
[--debug]
オプション
- --skill-id, -s
- 必須です。スキルIDです。
- --stage, -g
- 必須です。新たに認定されたステージを含むスキルのステージです。* `development` - 現在開発中のスキルがこのステージに対応します。 * `certified` - 認定を完了し、公開準備のできたスキルがこのステージに対応します。 * `live` - 現在公開中のスキルがこのステージに対応します。
- --profile, -p
- 使用するASK CLIプロファイルです。このオプションを含めない場合は、ASK CLIはデフォルトのプロファイルを使用します。
- --debug
- このオプションを指定すると、コマンド出力にデバッグメッセージが表示されます。
get-skill-metrics
スキル使用状況の分析メトリクスレポートを取得します。
構文
$ ask smapi get-skill-metrics [--skill-id | -s <スキルID>]
[--start-time <開始時刻>]
[--end-time <終了時刻>]
[--period <期間>]
[--metric <メトリック>]
[--stage | -g <ステージ>]
[--skill-type <スキルの種類>]
[--intent <インテント>]
[--locale | -l <ロケール>]
[--max-results <結果の最大件数>]
[--next-token <次のトークン>]
[--profile | -p <プロフィール>]
[--debug]
オプション
- --skill-id, -s
- 必須です。スキルIDです。
- --start-time
- 必須です。クエリの開始時刻です。
- --end-time
- 必須です。クエリの終了時刻です(最大期間は1週間です)。
- --period
- 必須です。測定基準を取得する際に使用する集計期間は、ISO_8601の継続時間の形式に従います。
- --metric
- 必須です。定期的にデータセットを返す別個のロジックのセットです。
- --stage, -g
- 必須です。スキルのステージです(live、development)。
- --skill-type
- 必須です。スキルの種類です(custom、smartHome、flashBriefing)。
- --intent
- 任意です。スキルのインテントです。
- --locale、-l
- 任意です。スキルのロケールです。例:en-GB、en-US、de-DEなど。
- --max-results
- 任意です。応答本文で返される結果の最大数を設定します。上限である50件よりも少ない結果を取得する場合、このパラメーターをリクエストに追加できます。上限を超えるmaxResultsを指定することはできません。応答に含まれる項目がmaxResultsより少ない場合はありますが、この値を超えることはありません。検索条件を満たす結果が他にもあるけれど結果が返されない場合、応答にはisTruncated = trueが含まれます。
- --next-token
- 任意です。このAPI呼び出しへの応答が切り捨てられる(isTruncated応答要素の値がtrue)ときは、応答にnextToken要素も含まれます。nextTokenの値は、オブジェクトの次のセットのリストを表示する継続トークンとして次のリクエストで使用できます。継続トークンは、スキル管理APIが理解できるOpaque値です。トークンは24時間で有効期限が切れます。
- --profile, -p
- 使用するASK CLIプロファイルです。このオプションを含めない場合は、ASK CLIはデフォルトのプロファイルを使用します。
- --debug
- このオプションを指定すると、コマンド出力にデバッグメッセージが表示されます。
get-skill-simulation
このAPIは、以前に実行したシミュレーションの結果を取得します。成功した場合の応答には、シミュレーションのステータスが含まれます。シミュレーションが成功すると、応答にはスキルの呼び出しに関連する情報が含まれます。このAPIへのリクエストがエラーになった場合、応答にはエラーコードと問題の詳細が含まれます。シミュレーションが失敗した場合、応答にはエラーの発生とスキルエンドポイントに何が送信されたかの詳細を示すステータスアトリビュートが入ります。シミュレーション結果は、10分間保存されます。期限切れのシミュレーション結果をリクエストすると、404のHTTPステータスコードが返されます。
構文
$ ask smapi get-skill-simulation [--skill-id | -s <スキルID>]
[--stage | -g <ステージ>]
[--simulation-id | -i <シミュレーションID>]
[--profile | -p <プロフィール>]
[--debug]
オプション
- --skill-id, -s
- 必須です。スキルIDです。
- --stage, -g
- 必須です。スキルのステージです。
- --simulation-id, -i
- 必須です。シミュレーションのIDです。
- --profile, -p
- 使用するASK CLIプロファイルです。このオプションを含めない場合は、ASK CLIはデフォルトのプロファイルを使用します。
- --debug
- このオプションを指定すると、コマンド出力にデバッグメッセージが表示されます。
get-skill-status
指定したskillIdのスキルリソースとそのサブリソースのステータスを取得します。
構文
$ ask smapi get-skill-status [--skill-id | -s <スキルID>]
[--resource <リソース>]
[--profile | -p <プロフィール>]
[--debug]
オプション
- --skill-id, -s
- 必須です。スキルIDです。
- --resource
- 任意です。ステータス情報を取得するリソース名です。任意のフィルタリングパラメーターであり、1回のAPI呼び出しでパラメーターを複数回使用してすべてのリソースまたはサブリソース(指定したもののみ)のステータスを取得できます。このパラメーターを指定しない場合、すべてのリソースとサブリソースのステータスが返されます。
- --profile, -p
- 使用するASK CLIプロファイルです。このオプションを含めない場合は、ASK CLIはデフォルトのプロファイルを使用します。
- --debug
- このオプションを指定すると、コマンド出力にデバッグメッセージが表示されます。
get-skill-validations
このAPIは、以前に実行した検証の結果を取得します。成功した場合の応答には、検証のステータスが含まれます。検証が成功すると、応答には実行した検証に関連する情報が入ります。このAPIへのリクエストがエラーになった場合、応答には問題の詳細が含まれます。検証が失敗した場合、応答にはエラーの発生を示すステータスアトリビュートが入ります。検証結果は、60分間保存されます。期限切れの検証結果をリクエストすると、404のHTTPステータスコードが返されます。
構文
$ ask smapi get-skill-validations [--skill-id | -s <スキルID>]
[--validation-id | -i <検証ID>]
[--stage | -g <ステージ>]
[--accept-language <言語>]
[--profile | -p <プロフィール>]
[--debug]
オプション
- --skill-id, -s
- 必須です。スキルIDです。
- --validation-id, -i
- 必須です。検証のIDです。スキルとステージの最新の検証結果を取得するには、
~mostRecent
の値を使用します。この場合のAPI動作は、直近で行われた検証の実際の検証IDがリクエストで使用された場合と同様です。 - --stage, -g
- 必須です。スキルのステージです。
- --accept-language
- 任意です。コンテキスト内のユーザーのロケールまたは言語です。
- --profile, -p
- 使用するASK CLIプロファイルです。このオプションを含めない場合は、ASK CLIはデフォルトのプロファイルを使用します。
- --debug
- このオプションを指定すると、コマンド出力にデバッグメッセージが表示されます。
get-smart-home-capability-evaluation
スマートホーム機能評価の重要な情報とステータスを取得します。
構文
$ ask smapi get-smart-home-capability-evaluation [--skill-id | -s <スキルID>]
[--evaluation-id <評価ID>]
[--profile | -p <プロファイル>]
[--full-response]
[--debug]
オプション
- --skill-id, -s
- 必須です。スキルIDです。
- --evaluation-id
- 必須です。各スマートホーム機能の評価を識別する一意のIDです。
- --profile, -p
- 使用するASK CLIプロファイルを提供します。このオプションを含めない場合は、ASK CLIはデフォルトのプロファイルを使用します。
- --full-response
- 応答の本文、ヘッダー、ステータスが1つのオブジェクトとして返されます。
- --debug
- ASK CLIはコマンド出力にデバッグメッセージを表示します。
get-smarthome-capablity-evaluation-results
テストケースについて評価を実行した結果を取得します
構文
$ ask smapi get-smarthome-capablity-evaluation-results [--skill-id | -s <スキルID>]
[--max-results <結果の最大件数>]
[--next-token <次のトークン>]
[--evaluation-id <評価ID>]
[--profile | -p <プロファイル>]
[--full-response]
[--debug]
オプション
- --skill-id, -s
- 必須です。スキルIDです。
- --max-results
- 応答で返される項目の最大数です。このパラメーターを含めない場合は、デフォルトの最大値は50項目です。このパラメーターを含める場合、応答に含まれる項目数は、指定した値を下回ることはあっても、上回ることはありません。50を超える値は指定しないでください。検索条件を満たす結果が他にもあるけれど結果が返されない場合、応答には
isTruncated
=true
が含まれます。 - --next-token
isTruncated
=trueの場合
、応答にはnextToken
要素も含まれます。次のオブジェクトのセットのリストを表示するには、次のリクエストでnextToken
の値を継続トークンとして使用します。継続トークンは、スキル管理APIが理解できるOpaque値です。トークンは24時間で有効期限が切れます。- --evaluation-id
- 必須です。各スマートホーム機能の評価を識別する一意のIDです。
- --profile, -p
- 使用するASK CLIプロファイルを提供します。このオプションを含めない場合は、ASK CLIはデフォルトのプロファイルを使用します。
- --full-response
- 応答の本文、ヘッダー、ステータスが1つのオブジェクトとして返されます。
- --debug
- ASK CLIはコマンド出力にデバッグメッセージを表示します。
get-ssl-certificates
このスキルに現在関連付けられているSSL証明書セットを返します。セットは、リージョンに関連付けられた1つのSSL証明書BLOBと、スキルのデフォルトの証明書で構成されます。
構文
$ ask smapi get-ssl-certificates [--skill-id | -s <スキルID>]
[--profile | -p <プロフィール>]
[--debug]
オプション
- --skill-id, -s
- 必須です。スキルIDです。
- --profile, -p
- 使用するASK CLIプロファイルです。このオプションを含めない場合は、ASK CLIはデフォルトのプロファイルを使用します。
- --debug
- このオプションを指定すると、コマンド出力にデバッグメッセージが表示されます。
get-status-of-export-request
指定したexportIdのステータスを取得します。
構文
$ ask smapi get-status-of-export-request [--export-id <エクスポートID>]
[--profile | -p <プロフィール>]
[--debug]
オプション
- --export-id
- 必須です。エクスポートIDです。
- --profile, -p
- 使用するASK CLIプロファイルです。このオプションを含めない場合は、ASK CLIはデフォルトのプロファイルを使用します。
- --debug
- このオプションを指定すると、コマンド出力にデバッグメッセージが表示されます。
get-task
タスク名とバージョンを指定してタスク定義の詳細を取得します。
構文
$ ask smapi get-task [--skill-id | -s <スキルID>]
[--task-name <タスク名>]
[--task-version <タスクバージョン>]
[--profile | -p <プロフィール>]
[--debug]
オプション
- --skill-id, -s
- 必須です。スキルIDです。
- --task-name
- 必須です。タスク名です。
- --task-version
- 必須です。タスクのバージョンです。たとえば、"1"のように指定します。
- --profile, -p
- 使用するASK CLIプロファイルです。このオプションを含めない場合は、ASK CLIはデフォルトのプロファイルを使用します。
- --debug
- このオプションを指定すると、コマンド出力にデバッグメッセージが表示されます。
get-utterance-data
構文
$ ask smapi get-utterance-data [--skill-id | -s <スキルID>]
[--next-token <次のトークン>]
[--max-results <結果の最大件数>]
[--sort-direction <並べ替え順序>]
[--sort-field <並べ替えフィールド>]
[--stage | -g <ステージ>]
[--locale | -l <ロケール>]
[--dialog-act-name <ダイアログアクション名>]
[--intent-confidence-bin <インテント信頼度>]
[-intent-name <インテント名>]
[-intent-slots-name <インテントスロット名>]
[-interaction-type <対話タイプ>]
[-publication-status <公開ステータス>]
[-utterance-text <発話テキスト>]
[--profile | -p <プロフィール>]
[--debug]
オプション
- --skill-id, -s
- 必須です。スキルIDです。
- --next-token
- 任意です。このAPI呼び出しへの応答が切り捨てられる(isTruncated応答要素の値がtrue)ときは、応答にnextToken要素も含まれます。nextTokenの値は、オブジェクトの次のセットのリストを表示する継続トークンとして次のリクエストで使用できます。継続トークンは、スキル管理APIが理解できるOpaque値です。トークンは24時間で有効期限が切れます。
- --max-results
- 任意です。応答本文で返される結果の最大数を設定します。上限である50件よりも少ない結果を取得する場合、このパラメーターをリクエストに追加できます。上限を超えるmaxResultsを指定することはできません。応答に含まれる項目がmaxResultsより少ない場合はありますが、この値を超えることはありません。検索条件を満たす結果が他にもあるけれど結果が返されない場合、応答にはisTruncated = trueが含まれます。
- --sort-direction
- 任意です。リスト項目の並べ替え順序を設定します。'asc'を設定すると、項目はsortField値の昇順で返され、'desc'を設定すると、項目はsortField値の降順で返されます。
- --sort-field
- 任意です。並べ替えの基準とするフィールドを設定します。
- --stage, -g
- 任意です。指定した値と同じステージの項目取得に使用するフィルターです。[複数可]: 値はコンマで区切ることができます。[列挙]:development,live
- --locale、-l
- 任意です。指定した値と同じロケールの項目取得に使用するフィルターです。[複数可]: 値はコンマで区切ることができます。[列挙]:en-US,en-GB,en-IN,en-CA,en-AU,de-DE,ja-JP
- --dialog-act-name
- 任意です。ダイアログアクションディレクティブの名前です。*
Dialog.ElicitSlot
: Alexaが特定のスロット値をユーザーにたずねた場合です。詳細については、ElicitSlotディレクティブを参照してください。*Dialog.ConfirmSlot
: Alexaがダイアログを続行する前に特定のスロット値を確認した場合です。詳細については、ConfirmSlotディレクティブを参照してください。*Dialog.ConfirmIntent
: Alexaが、スキルでアクションを実行する前に、ユーザーがインテントに提供したすべての情報をユーザーに確認した場合です。詳細については、ConfirmIntentディレクティブを参照してください。[複数可]: 値はコンマで区切ることができます。[列挙]: Dialog.ElicitSlot,Dialog.ConfirmSlot,Dialog.ConfirmIntent - --intent-confidence-bin
- 任意です。指定した値と同じインテント信頼度の項目取得に使用するフィルターです。*'HIGH': インテントが高信頼度と認識された場合。*'MEDIUM': インテントが中信頼度を認識された場合。*'LOW': インテントが低信頼度と認識された場合。低信頼度のインテントはスキルに送信されません。[複数可]: 値はコンマで区切ることができます。[列挙]: HIGH,MEDIUM,LOW
- --intent-name
- 任意です。指定した値と同じインテント名の項目取得に使用するフィルターです。[複数可]: 値はコンマで区切ることができます。
- --intent-slots-name
- 任意です。指定したいずれかの値と同じスロット名の項目取得に使用するフィルターです。[複数可]: 値はコンマで区切ることができます。
- --interaction-type
- 任意です。"ONE_SHOT"形式の対話として実行されたのか、"MODAL"対話として実行されたのかを表します。* `ONE_SHOT`: ユーザーはスキルを呼び出しとインテントのリクエストを単一のフレーズで伝えます。* `MODAL`: ユーザーは最初にスキルを呼び出してからインテントを伝えます。[複数可]: 値はコンマで区切ることができます。[列挙]: ONE_SHOT,MODAL
- --publication-status
- 任意です。この対話が発生したときのスキルの公開ステータスです。[複数可]: 値はコンマで区切ることができます。[列挙]: Development,Certification
- --utterance-text
- 任意です。発話テキストに特定のフレーズを含む項目の取得に使用されるフィルターです。各フィルターの値は1~100文字で指定できます。[複数可]: 値はコンマで区切ることができます。
- --profile, -p
- 使用するASK CLIプロファイルです。このオプションを含めない場合は、ASK CLIはデフォルトのプロファイルを使用します。
- --debug
- このオプションを指定すると、コマンド出力にデバッグメッセージが表示されます。
get-vendor-list
ベンダー情報のリストを取得します。
構文
$ ask smapi get-vendor-list [--profile | -p <プロファイル>]
[--debug]
オプション
- --profile, -p
- 使用するASK CLIプロファイルです。このオプションを含めない場合は、ASK CLIはデフォルトのプロファイルを使用します。
- --debug
- このオプションを指定すると、コマンド出力にデバッグメッセージが表示されます。
import-skill-package
指定されたスキルIDでスキルの新しいインポートを作成します。
構文
$ ask smapi import-skill-package [--location <場所>]
[--skill-id | -s <スキルID>]
[--if-match <一致>]
[--profile | -p <プロフィール>]
[--debug]
オプション
- --location
- 必須です。パッケージの場所です。
- --skill-id, -s
- 必須です。スキルIDです。
- --if-match
- 任意です。エンティティタグを指定したリクエストヘッダーです。サーバーは、eTagがリソースの現在のeTagと一致した場合にのみリソースを更新します。
- --profile, -p
- 使用するASK CLIプロファイルです。このオプションを含めない場合は、ASK CLIはデフォルトのプロファイルを使用します。
- --debug
- このオプションを指定すると、コマンド出力にデバッグメッセージが表示されます。
invoke-skill
これは、あるスキルのLambda(またはサードパーティのHTTPS)エンドポイントを呼び出す同期APIです。応答には、呼び出されたエンドポイントと、エンドポイントとの間で送受信されたペイロードの情報が含まれます。自分が所有し、かつ有効なスキルに対してのみ、invoke-skill
を呼び出すことができます。
スキルのエンドポイントでエラーが発生した場合、応答にはエラーの発生とスキルエンドポイントに何が送信されたかの詳細を示すステータスアトリビュートが入ります。invoke-skill
でエラーが発生した場合、応答にはエラーコードと、問題の詳細が入ります。
スキルエンドポイントへの呼び出しは、10秒後にタイムアウトします。このAPIは、これよりも長いタイムアウトが必要な場合に非同期APIに対して延長を許可するようにデザインされています。
構文
$ ask smapi invoke-skill [--skill-id | -s <スキルID>]
[--endpoint-region <エンドポイントのリージョン>]
[--skill-request-body <スキルリクエスト本文>]
[--full-response]
[--profile | -p <プロフィール>]
[--debug]
オプション
- --skill-id, -s
- 必須です。スキルIDです。
- --endpoint-region
- 必須です。エンドポイントを呼び出すリージョンです。以下のいずれかになります:
NA
、EU
、FE
。 - --skill-request-body
- 必須です。JSON形式で記述したリクエスト本文です。文字列、ファイルのいずれかでJSONを指定できます。ファイルを指定する場合、絶対パス、相対パスのどちらで指定することもできます。たとえば、
"$(cat {filepath})"
か"file:{filepath}"
のようになります。 - --full-response
- このオプションを指定すると、応答の本文、ヘッダー、ステータスが1つのオブジェクトとして返されます。
- --profile, -p
- 使用するASK CLIプロファイルです。このオプションを含めない場合は、ASK CLIはデフォルトのプロファイルを使用します。
- --debug
- このオプションを指定すると、コマンド出力にデバッグメッセージが表示されます。
invoke-skill-end-point
これは、あるスキルのLambda(またはサードパーティのHTTPS)エンドポイントを呼び出す同期APIです。応答には、呼び出されたエンドポイントと、エンドポイントとの間で送受信されたペイロードの情報が含まれます。自分が所有し、かつ有効なスキルに対してのみ、invoke-skill
を呼び出すことができます。
スキルのエンドポイントでエラーが発生した場合、応答にはエラーの発生とスキルエンドポイントに何が送信されたかの詳細を示すステータスアトリビュートが入ります。invoke-skill
でエラーが発生した場合、応答にはエラーコードと、問題の詳細が入ります。
スキルエンドポイントへの呼び出しは、10秒後にタイムアウトします。このAPIは、これよりも長いタイムアウトが必要な場合に非同期APIに対して延長を許可するようにデザインされています。
構文
$ ask smapi invoke-skill-end-point [--skill-id | -s <スキルID>]
[--stage | -g <ステージ>]
[--endpoint-region <エンドポイントのリージョン>]
[--skill-request-body <スキルリクエスト本文>]
[--profile | -p <プロフィール>]
[--debug]
オプション
- --skill-id, -s
- 必須です。スキルIDです。
- --stage, -g
- 必須です。スキルのステージです。
development
、live
のいずれかです。 - --endpoint-region
- 必須です。エンドポイントを呼び出すリージョンです。以下のいずれかになります:
NA
、EU
、FE
。 - --skill-request-body
- 必須です。JSON形式で記述したリクエスト本文です。文字列、ファイルのいずれかでJSONを指定できます。ファイルを指定する場合、絶対パス、相対パスのどちらで指定することもできます。たとえば、
"$(cat {filepath})"
か"file:{filepath}"
のようになります。 - --profile, -p
- 使用するASK CLIプロファイルです。このオプションを含めない場合は、ASK CLIはデフォルトのプロファイルを使用します。
- --debug
- このオプションを指定すると、コマンド出力にデバッグメッセージが表示されます。
list-asr-annotation-sets
指定したスキルの既存の自動音声認識(ASR)アノテーションセットをすべて表示します。このコマンドは、各アノテーションセットのIDとメタデータを返します。詳細については、自動音声認識(ASR)評価ツールについておよびこのコマンドのREST APIバージョンを参照してください。
構文
$ ask smapi list-asr-annotation-sets [--skill-id | -s <skill-id>]
[--next-token <次のトークン>]
[--max-results <結果の最大件数>]
[--full-response]
[--profile | -p <プロフィール>]
[--debug]
オプション
- --skill-id, -s
- 必須です。スキルIDです。
- --next-token
- 任意です。このAPI呼び出しへの応答が切り捨てられる(isTruncated応答要素の値がtrue)ときは、応答にnextToken要素も含まれます。nextTokenの値は、オブジェクトの次のセットのリストを表示する継続トークンとして次のリクエストで使用できます。継続トークンは、スキル管理APIが理解できるOpaque値です。トークンは24時間で有効期限が切れます。
- --max-results
- 任意です。応答本文で返される結果の最大数を設定します。上限である50件よりも少ない結果を取得する場合、このパラメーターをリクエストに追加できます。上限を超えるmaxResultsを指定することはできません。応答に含まれる項目がmaxResultsより少ない場合はありますが、この値を超えることはありません。検索条件を満たす結果が他にもあるけれど結果が返されない場合、応答にはisTruncated = trueが含まれます。
- --full-response
- このオプションを指定すると、応答の本文、ヘッダー、ステータスが1つのオブジェクトとして返されます。
- --profile, -p
- 使用するASK CLIプロファイルです。このオプションを含めない場合は、ASK CLIはデフォルトのプロファイルを使用します。
- --debug
- このオプションを指定すると、コマンド出力にデバッグメッセージが表示されます。
list-catalogs-for-skill
スキルに関連付けられたすべてのカタログのリストを取得します。
構文
$ ask smapi list-catalogs-for-skill [--next-token <next-token>]
[--max-results <結果の最大件数>]
[--skill-id | -s <スキルID>]
[--profile | -p <プロフィール>]
[--full-response]
[--debug]
オプション
- --next-token
- このAPI呼び出しへの応答が切り捨てられる(isTruncated応答要素の値がtrue)ときは、応答にnextToken要素も含まれます。nextTokenの値は、オブジェクトの次のセットのリストを表示する継続トークンとして次のリクエストで使用できます。継続トークンは、スキル管理APIが理解できるOpaque値です。トークンは24時間で有効期限が切れます。
- --max-results
- 応答本文で返される結果の最大数を設定します。応答に含まれる項目がmaxResultsより少ない場合はありますが、この値を超えることはありません。検索条件を満たす結果が他にもあるけれど結果が返されない場合、応答にはisTruncated = trueが含まれます。
- --skill-id, -s
- 必須です。スキルIDです。
- --profile, -p
- 使用するASK CLIプロファイルです。このオプションを含めない場合は、ASK CLIはデフォルトのプロファイルを使用します。
- --full-response
- 応答の本文、ヘッダー、ステータスが1つのオブジェクトとして返されます。
- --debug
- このオプションを指定すると、コマンド出力にデバッグメッセージが表示されます。
list-catalogs-for-vendor
ベンダーのカタログリストを取得します。
構文
$ ask smapi list-catalogs-for-vendor [--next-token <next-token>]
[--max-results <結果の最大件数>]
[--profile | -p <プロフィール>]
[--full-response]
[--debug]
オプション
- --next-token
- このAPI呼び出しへの応答が切り捨てられる(isTruncated応答要素の値がtrue)ときは、応答にnextToken要素も含まれます。nextTokenの値は、オブジェクトの次のセットのリストを表示する継続トークンとして次のリクエストで使用できます。継続トークンは、スキル管理APIが理解できるOpaque値です。トークンは24時間で有効期限が切れます。
- --max-results
- 応答本文で返される結果の最大数を設定します。応答に含まれる項目がmaxResultsより少ない場合はありますが、この値を超えることはありません。検索条件を満たす結果が他にもあるけれど結果が返されない場合、応答にはisTruncated = trueが含まれます。
- --profile, -p
- 使用するASK CLIプロファイルです。このオプションを含めない場合は、ASK CLIはデフォルトのプロファイルを使用します。
- --full-response
- 応答の本文、ヘッダー、ステータスが1つのオブジェクトとして返されます。
- --debug
- このオプションを指定すると、コマンド出力にデバッグメッセージが表示されます。
list-interaction-model-catalog-versions
指定したカタログIDのすべての履歴バージョンを一覧表示します。詳細については、Interaction Model Catalog Management REST API Referenceを参照してください。
構文
$ ask smapi list-interaction-model-catalog-versions <-c|--catalog-id <カタログID>>
[--max-results <結果の最大件数>]
[--next-token <次のトークン>]
[--sort-direction <並べ替え順序>]
[--sort-field <並べ替えフィールド>]
[-p | --profile <プロファイル>]
[--full-response]
[--debug]
オプション
- -c,--catalog-id
- 必須です。一意のカタログIDを提供します。
- --max-results
-
任意です。応答本文で返される結果の最大数を設定します。上限である50件よりも少ない結果を取得する場合、このパラメーターをリクエストに追加します。上限を超える
maxResults
を指定することはできません。応答に含まれる項目がmaxResults
より少ない場合はありますが、この値を超えることはありません。検索条件を満たす結果が他にもあるけれど結果が返されない場合、応答にはisTruncated
=true
が含まれます。 - --next-token
-
任意です。このAPI呼び出しへの応答が切り捨てられる(
isTruncated
応答要素の値がtrue
)ときは、応答にnextToken
要素が含まれます。nextToken
の値は、オブジェクトの次のセットのリストを表示する継続トークンとして次のリクエストで使用できます。継続トークンは、スキル管理APIがデコードするOpaque値です。トークンは24時間で有効期限が切れます。 - --sort-direction
-
任意です。リスト項目の並べ替え順序を設定します。このパラメーターが
asc
の場合、アイテムはsortField
値の昇順で返されます。このパラメータがdesc
の場合、アイテムはsortField
値の降順で返されます。 - --sort-field
- 任意です。並べ替えの基準とするフィールドを設定します。
- -p, --profile
- 使用するASK CLIプロファイルを提供します。このオプションを含めない場合は、ASK CLIはデフォルトのプロファイルを使用します。
- --full-response
- 応答の本文、ヘッダー、ステータスが1つのオブジェクトとして返されます。
- --debug
- ASK CLIはコマンド出力にデバッグメッセージを表示します。
list-interaction-model-catalogs
すべてのカタログのリストを取得します。詳細については、Interaction Model Catalog Management REST API Referenceを参照してください。
構文
$ ask smapi list-interaction-model-catalogs [--max-results <結果の最大件数>]
[--next-token <次のトークン>]
[--sort-direction <並べ替え順序>]
[--profile | -p <プロフィール>]
[--debug]
オプション
- --max-results
- 任意です。応答本文で返される結果の最大数を設定します。上限である50件よりも少ない結果を取得する場合、このパラメーターをリクエストに追加できます。上限を超えるmaxResultsを指定することはできません。応答に含まれる項目がmaxResultsより少ない場合はありますが、この値を超えることはありません。検索条件を満たす結果が他にもあるけれど結果が返されない場合、応答にはisTruncated = trueが含まれます。
- --next-token
- 任意です。このAPI呼び出しへの応答が切り捨てられる(isTruncated応答要素の値がtrue)ときは、応答にnextToken要素も含まれます。nextTokenの値は、オブジェクトの次のセットのリストを表示する継続トークンとして次のリクエストで使用できます。継続トークンは、スキル管理APIが理解できるOpaque値です。トークンは24時間で有効期限が切れます。
- --sort-direction
- 任意です。リスト項目の並べ替え順序を設定します。'asc'を設定すると、項目はsortField値の昇順で返され、'desc'を設定すると、項目はsortField値の降順で返されます。
- --profile, -p
- 使用するASK CLIプロファイルです。このオプションを含めない場合は、ASK CLIはデフォルトのプロファイルを使用します。
- --debug
- このオプションを指定すると、コマンド出力にデバッグメッセージが表示されます。
list-interaction-model-versions
カタログのバージョンリストを表示します。詳細については、Interaction Model Catalog Management REST API Referenceを参照してください。
構文
$ ask smapi list-interaction-model-versions [--skill-id | -s <スキルID>]
[--stage | -g <ステージ>]
[--locale | -l <ロケール>]
[--next-token <次のトークン>]
[--max-results <結果の最大件数>]
[--sort-direction <並べ替え順序>]
[--sort-field <並べ替えフィールド>]
[--profile | -p <プロフィール>]
[--debug]
オプション
- --skill-id, -s
- 必須です。スキルIDです。
- --stage, -g
- 必須です。新たに認定されたステージを含むスキルのステージです。* `development` - 現在開発中のスキルがこのステージに対応します。 * `certified` - 認定を完了し、公開準備のできたスキルがこのステージに対応します。 * `live` - 現在公開中のスキルがこのステージに対応します。
- --locale, -l
- 必須です。リクエストされたモデルのロケール。例:en-GB、en-US、de-DE。
- --next-token
- 任意です。このAPI呼び出しへの応答が切り捨てられる(isTruncated応答要素の値がtrue)ときは、応答にnextToken要素も含まれます。nextTokenの値は、オブジェクトの次のセットのリストを表示する継続トークンとして次のリクエストで使用できます。継続トークンは、スキル管理APIが理解できるOpaque値です。トークンは24時間で有効期限が切れます。
- --max-results
- 任意です。応答本文で返される結果の最大数を設定します。上限である50件よりも少ない結果を取得する場合、このパラメーターをリクエストに追加できます。上限を超えるmaxResultsを指定することはできません。応答に含まれる項目がmaxResultsより少ない場合はありますが、この値を超えることはありません。検索条件を満たす結果が他にもあるけれど結果が返されない場合、応答にはisTruncated = trueが含まれます。
- --sort-direction
- 任意です。リスト項目の並べ替え順序を設定します。'asc'を設定すると、項目はsortField値の昇順で返され、'desc'を設定すると、項目はsortField値の降順で返されます。
- --sort-field
- 任意です。並べ替えの基準とするフィールドを設定します。
- --profile, -p
- 使用するASK CLIプロファイルです。このオプションを含めない場合は、ASK CLIはデフォルトのプロファイルを使用します。
- --debug
- このオプションを指定すると、コマンド出力にデバッグメッセージが表示されます。
list-interaction-model-slot-types
ベンダーのすべてのスロットタイプのリストを取得します。
構文
$ ask smapi list-interaction-model-slot-types [--max-results <結果の最大件数>]
[--next-token <次のトークン>]
[--sort-direction <並べ替え順序>]
[--profile | -p <プロフィール>]
[--debug]
オプション
- --max-results
- 任意です。応答本文で返される結果の最大数を設定します。上限である50件よりも少ない結果を取得する場合、このパラメーターをリクエストに追加できます。上限を超えるmaxResultsを指定することはできません。応答に含まれる項目がmaxResultsより少ない場合はありますが、この値を超えることはありません。検索条件を満たす結果が他にもあるけれど結果が返されない場合、応答にはisTruncated = trueが含まれます。
- --next-token
- 任意です。このAPI呼び出しへの応答が切り捨てられる(isTruncated応答要素の値がtrue)ときは、応答にnextToken要素も含まれます。nextTokenの値は、オブジェクトの次のセットのリストを表示する継続トークンとして次のリクエストで使用できます。継続トークンは、スキル管理APIが理解できるOpaque値です。トークンは24時間で有効期限が切れます。
- --sort-direction
- 任意です。リスト項目の並べ替え順序を設定します。'asc'を設定すると、項目はsortField値の昇順で返され、'desc'を設定すると、項目はsortField値の降順で返されます。
- --profile, -p
- 使用するASK CLIプロファイルです。このオプションを含めない場合は、ASK CLIはデフォルトのプロファイルを使用します。
- --debug
- このオプションを指定すると、コマンド出力にデバッグメッセージが表示されます。
list-interaction-model-slot-type-versions
指定したslotTypeIdのすべてのスロットタイプバージョンのリストを取得します。
構文
$ ask smapi list-interaction-model-slot-type-versions [--slot-type-id <スロットタイプID>]
[--max-results <結果の最大件数>]
[--next-token <次のトークン>]
[--sort-direction <並べ替え順序>]
[--profile | -p <プロフィール>]
[--debug]
オプション
- --slot-type-id
- 必須です。スロットタイプのIDです。
- --max-results
- 任意です。応答本文で返される結果の最大数を設定します。上限である50件よりも少ない結果を取得する場合、このパラメーターをリクエストに追加できます。上限を超えるmaxResultsを指定することはできません。応答に含まれる項目がmaxResultsより少ない場合はありますが、この値を超えることはありません。検索条件を満たす結果が他にもあるけれど結果が返されない場合、応答にはisTruncated = trueが含まれます。
- --next-token
- 任意です。このAPI呼び出しへの応答が切り捨てられる(isTruncated応答要素の値がtrue)ときは、応答にnextToken要素も含まれます。nextTokenの値は、オブジェクトの次のセットのリストを表示する継続トークンとして次のリクエストで使用できます。継続トークンは、スキル管理APIが理解できるOpaque値です。トークンは24時間で有効期限が切れます。
- --sort-direction
- 任意です。リスト項目の並べ替え順序を設定します。'asc'を設定すると、項目はsortField値の昇順で返され、'desc'を設定すると、項目はsortField値の降順で返されます。
- --profile, -p
- 使用するASK CLIプロファイルです。このオプションを含めない場合は、ASK CLIはデフォルトのプロファイルを使用します。
- --debug
- このオプションを指定すると、コマンド出力にデバッグメッセージが表示されます。
list-private-distribution-accounts
非公開の配信アカウントのリストを表示します。
構文
$ ask smapi list-private-distribution-accounts [--skill-id | -s <スキルID>]
[--stage | -g <ステージ>]
[--next-token <次のトークン>]
[--max-results <結果の最大件数>]
[--profile | -p <プロフィール>]
[--debug]
オプション
- --skill-id, -s
- 必須です。スキルIDです。
- --stage, -g
- 必須です。スキルのステージです。
- --next-token
- 任意です。このAPI呼び出しへの応答が切り捨てられる(isTruncated応答要素の値がtrue)ときは、応答にnextToken要素も含まれます。nextTokenの値は、オブジェクトの次のセットのリストを表示する継続トークンとして次のリクエストで使用できます。継続トークンは、スキル管理APIが理解できるOpaque値です。トークンは24時間で有効期限が切れます。
- --max-results
- 任意です。応答本文で返される結果の最大数を設定します。上限である50件よりも少ない結果を取得する場合、このパラメーターをリクエストに追加できます。上限を超えるmaxResultsを指定することはできません。応答に含まれる項目がmaxResultsより少ない場合はありますが、この値を超えることはありません。検索条件を満たす結果が他にもあるけれど結果が返されない場合、応答にはisTruncated = trueが含まれます。
- --profile, -p
- 使用するASK CLIプロファイルです。このオプションを含めない場合は、ASK CLIはデフォルトのプロファイルを使用します。
- --debug
- このオプションを指定すると、コマンド出力にデバッグメッセージが表示されます。
list-skills-for-vendor
ベンダーのスキルリストを取得します。
構文
$ ask smapi list-skills-for-vendor [--next-token <次のトークン>]
[--max-results <結果の最大件数>]
[--skill-id | -s <スキルID>]
[--profile | -p <プロフィール>]
[--debug]
オプション
- --next-token
- 任意です。このAPI呼び出しへの応答が切り捨てられる(isTruncated応答要素の値がtrue)ときは、応答にnextToken要素も含まれます。nextTokenの値は、オブジェクトの次のセットのリストを表示する継続トークンとして次のリクエストで使用できます。継続トークンは、スキル管理APIが理解できるOpaque値です。トークンは24時間で有効期限が切れます。
- --max-results
- 任意です。応答本文で返される結果の最大数を設定します。上限である50件よりも少ない結果を取得する場合、このパラメーターをリクエストに追加できます。上限を超えるmaxResultsを指定することはできません。応答に含まれる項目がmaxResultsより少ない場合はありますが、この値を超えることはありません。検索条件を満たす結果が他にもあるけれど結果が返されない場合、応答にはisTruncated = trueが含まれます。
- --skill-id, -s
- 任意です。概要を取得するスキルIDのリストです。1回のlistSkills呼び出しで、スキルIDを最大10個まで指定してスキルの概要を取得できます。このパラメーターを'nextToken'、'maxResults'パラメーターのいずれかまたは両方と使用することはできません。[複数可]: 値はコンマで区切ることができます。
- --profile, -p
- 使用するASK CLIプロファイルです。このオプションを含めない場合は、ASK CLIはデフォルトのプロファイルを使用します。
- --debug
- このオプションを指定すると、コマンド出力にデバッグメッセージが表示されます。
list-smarthome-capability-evaluations
指定されたスキルIDの機能評価情報を返します。
構文
$ ask smapi list-smarthome-capability-evaluations [--skill-id | -s <スキルID>]
[--stage <ステージ> | -g]
[--start-timestamp-from <タイムスタンプの開始時刻>]
[--start-timestamp-to <タイムスタンプの終了時刻>]
[--max-results <結果の最大件数>]
[--next-token <次のトークン>]
[--profile | -p <プロファイル>]
[--full-response]
[--debug]
オプション
- --skill-id, -s
- 必須です。スキルIDです。
- --stage, -g
- スキルのステージを表します。有効な値は
development
とlive
です。評価に使用されたアカウントでこのスキルステージが有効でない場合、CLIはエラーを返します。 - --start-timestamp-from
- 評価履歴の照会対象とする最初の評価開始日時です。
- --start-timestamp-to
- 評価履歴の照会対象とする最初の評価開始日時です。
- --max-results
- 応答で返される項目の最大数です。このパラメーターを含めない場合は、デフォルトの最大値は50項目です。このパラメーターを含める場合、応答に含まれる項目数は、指定した値を下回ることはあっても、上回ることはありません。50を超える値は指定しないでください。検索条件を満たす結果が他にもあるけれど結果が返されない場合、応答には
isTruncated
=true
が含まれます。 - --next-token
isTruncated
=trueの場合
、応答にはnextToken
要素も含まれます。次のオブジェクトのセットのリストを表示するには、次のリクエストでnextToken
の値を継続トークンとして使用します。継続トークンは、スキル管理APIが理解できるOpaque値です。トークンは24時間で有効期限が切れます。- --profile, -p
- 使用するASK CLIプロファイルを提供します。このオプションを含めない場合は、ASK CLIはデフォルトのプロファイルを使用します。
- --full-response
- 応答の本文、ヘッダー、ステータスが1つのオブジェクトとして返されます。
- --debug
- ASK CLIはコマンド出力にデバッグメッセージを表示します。
list-smarthome-capability-test-plans
指定したスキルIDのすべてのテスト計画名とIDを列挙します
構文
$ ask smapi list-smarthome-capability-test-plans [--skill-id | -s <スキルID>]
[--max-results <結果の最大件数>]
[--next-token <次のトークン>]
[--profile | -p <プロファイル>]
[--full-response]
[--debug]
オプション
- --skill-id, -s
- 必須です。スキルIDです。
- --max-results
- 応答で返される項目の最大数です。このパラメーターを含めない場合は、デフォルトの最大値は50項目です。このパラメーターを含める場合、応答に含まれる項目数は、指定した値を下回ることはあっても、上回ることはありません。50を超える値は指定しないでください。検索条件を満たす結果が他にもあるけれど結果が返されない場合、応答には
isTruncated
=true
が含まれます。 - --next-token
isTruncated
=trueの場合
、応答にはnextToken
要素も含まれます。次のオブジェクトのセットのリストを表示するには、次のリクエストでnextToken
の値を継続トークンとして使用します。継続トークンは、スキル管理APIが理解できるOpaque値です。トークンは24時間で有効期限が切れます。- --profile, -p
- 使用するASK CLIプロファイルを提供します。このオプションを含めない場合は、ASK CLIはデフォルトのプロファイルを使用します。
- --full-response
- 応答の本文、ヘッダー、ステータスが1つのオブジェクトとして返されます。
- --debug
- ASK CLIはコマンド出力にデバッグメッセージを表示します。
list-versions-for-skill
スキルIDに関連付けられたすべてのスキルバージョンのリストを取得します。
構文:
ask smapi list-versions-for-skill [-s,--skill-id <スキルID>]
[--next-token <次のトークン>]
[--max-results <結果の最大件数>]
[-p, --profile <プロファイル>]
[--debug]
[-h、--help]
オプション:
- -s, --skill-id <スキルID>
- 必須です。スキルIDです。
- --next-token <次のトークン>
- 任意です。
MaxResults
のページ分割を制御する継続トークンです。
- --max-results <結果の最大件数>
- 任意です。応答本文で返される結果の最大数を設定します。50件を超える結果を指定することはできません。50件を超える結果が表示される場合、結果には
isTruncated = true
が含まれます。
- --debug
- 任意です。このオプションを指定すると、コマンド出力にデバッグメッセージが表示されます。
profile-nlu
音声対話モデルに対して発話をプロファイルします。
構文
$ ask smapi profile-nlu [--utterance | -u <発話>]
[--multi-turn-token <マルチターントークン>]
[--skill-id | -s <スキルID>]
[--stage | -g <ステージ>]
[--locale | -l <ロケール>]
[--profile | -p <プロフィール>]
[--debug]
オプション
- --utterance, -u
- 必須です。Alexaに対してユーザーが実際に話しかける内容です。
- --multi-turn-token
- 必須です。マルチターン関連のコンテキストを含むOpaque文字列です。
- --skill-id, -s
- 必須です。スキルIDです。
- --stage, -g
- 必須です。スキルのステージです。
- --locale, -l
- 必須です。リクエストされたモデルのロケール。例:en-GB、en-US、de-DE。
- --profile, -p
- 使用するASK CLIプロファイルです。このオプションを含めない場合は、ASK CLIはデフォルトのプロファイルを使用します。
- --debug
- このオプションを指定すると、コマンド出力にデバッグメッセージが表示されます。
query-development-audit-logs
SMAPI監査ログAPIは、ユーザーにそのアカウントに対する権限を持った開発者(複数可)によって呼び出されたすべてのSMAPI呼び出しの監査履歴を提供します。
構文
$ ask smapi query-development-audit-logs [--vendor-id <ベンダーID>]
[--request-filters-clients <クライアントリクエストフィルター>]
[--request-filters-operations <操作リクエストフィルター>]
[--request-filters-resources <リソースリクエストフィルター>]
[--request-filters-requesters <リクエスターリクエストフィルター>]
[--request-filters-start-time <開始時刻リクエストフィルター>]
[--request-filters-end-time <終了時刻リクエストフィルター>]
[--request-filters-http-response-codes <HTTP応答コードリクエストフィルター>]
[--sort-direction <並べ替え順序>]
[--sort-field <並べ替えフィールド>]
[--pagination-context-next-token <ページ分割コンテキストの次のトークン>]
[--pagination-context-max-results <ページ分割コンテキストの最大件数>]
[--profile | -p <プロフィール>]
[--debug]
オプション
- --vendor-id
- 必須です。ベンダーIDです。ユーザー情報を参照してください。
- --request-filters-clients
- 任意です。フィルタリングするクライアントIDのリストです。
- --request-filters-operations
- 任意です。操作名とバージョンリストのフィルターです。
- --request-filters-resources
- 任意です。リソース、リソースの種類のいずれかまたは両方のリストのフィルターです。利用可能な種類については、ドキュメントを参照してください。
- --request-filters-requesters
- 任意です。監査ログをフィルタリングするリクエストフィルターです。
- --request-filters-start-time
- 任意です。この検索の開始時刻を設定します。この時刻以降のタイムスタンプの監査ログがすべて応答に含まれます。この時刻も含まれます。
- --request-filters-end-time
- 任意です。この検索の終了時刻を設定します。この時刻より前のタイムスタンプの監査ログがすべて応答に含まれます。この時刻は含まれません。
- --request-filters-http-response-codes
- 任意です。HTTP応答コードでフィルタリングします。たとえば、'200'や'503'のように指定します。
- --sort-direction
- 任意です。リスト項目の並べ替え順序を設定します。'ASC'を設定すると、項目はsortField値の昇順で返され、'DESC'を設定すると、項目はsortField値の降順で返されます。[列挙]: ASC,DESC
- --sort-field
- 任意です。並べ替えの基準とするフィールドを設定します。[列挙]:timestamp,operation,resource.id,resource.type,requester.userId,client.id,httpResponseCode
- --pagination-context-next-token
- 任意です。このAPI呼び出しへの応答が切り捨てられると、応答にnextToken要素が含まれます。nextTokenの値は、オブジェクトの次のセットのリストを表示する継続トークンとして次のリクエストで使用できます。継続トークンは、このAPIが理解できるOpaque値です。トークンは1時間で有効期限が切れます。
- --pagination-context-max-results
- 任意です。応答本文で返される結果の最大数を設定します。デフォルトの50件より多い結果、または少ない結果を取得する場合、このパラメーターをリクエストに追加できます。最大件数の250を超えるmaxResultsを指定することもできますが、この件数以上の項目は返されません。SLA順守の目的で、または該当する項目が少ないために、応答にmaxResultsよりも少ない件数の項目しか含まれない場合はありますが、それよりも多い件数が含まれることは決してありません。
- --profile, -p
- 使用するASK CLIプロファイルです。このオプションを含めない場合は、ASK CLIはデフォルトのプロファイルを使用します。
- --debug
- このオプションを指定すると、コマンド出力にデバッグメッセージが表示されます。
remove-testers-from-beta-test
特定のスキルのベータテストからテスターを削除します。システムは、各テスターにアクセス終了の通知メールを送信し、参加資格を削除します。
構文
$ ask smapi remove-testers-from-beta-test [--skill-id | -s <スキルID>]
[--testers-emails <テスターのEメール>]
[--profile | -p <プロフィール>]
[--debug]
オプション
- --skill-id, -s
- 必須です。スキルIDです。
- --testers-emails
- 必須です。ベータテストのテスターのEメールアドレスです。[複数可]: 値はコンマで区切ることができます。
- --profile, -p
- 使用するASK CLIプロファイルです。このオプションを含めない場合は、ASK CLIはデフォルトのプロファイルを使用します。
- --debug
- このオプションを指定すると、コマンド出力にデバッグメッセージが表示されます。
request-feedback-from-testers
特定のAlexaスキルについて、ベータテストに参加しているテスターにフィードバックをリクエストします。システムはテスターに通知メールを送信し、フィードバックをリクエストします。
構文
$ ask smapi request-feedback-from-testers [--skill-id | -s <スキルID>]
[--testers-emails <テスターのEメール>]
[--profile | -p <プロフィール>]
[--debug]
オプション
- --skill-id, -s
- 必須です。スキルIDです。
- --testers-emails
- 必須です。ベータテストのテスターのEメールアドレスです。[複数可]: 値はコンマで区切ることができます。
- --profile, -p
- 使用するASK CLIプロファイルです。このオプションを含めない場合は、ASK CLIはデフォルトのプロファイルを使用します。
- --debug
- このオプションを指定すると、コマンド出力にデバッグメッセージが表示されます。
reset-entitlement-for-product
現在のユーザーの商品または有料スキルの購入をリセットします。任意の購入タイプ(買い切り型、消費型、サブスクリプション)をリセットできます。
構文
$ ask smapi reset-entitlement-for-product [--product-id <商品ID>]
[--stage | -g <ステージ>]
[--profile | -p <プロフィール>]
[--debug]
オプション
- --product-id
- 必須です。ISPの場合は、スキル内商品IDを含めます。有料スキルの場合は、スキルIDを含めます。
- --stage, -g
- 必須です。スキルのステージです。
- --profile, -p
- 使用するASK CLIプロファイルです。このオプションを含めない場合は、ASK CLIはデフォルトのプロファイルを使用します。
- --debug
- このオプションを指定すると、コマンド出力にデバッグメッセージが表示されます。
rollback-skill
ロールバック先となるターゲットスキルバージョンを申請します。特定のskillId
に対して、一度に1回だけロールバック操作または公開操作を実行できます。スキルはロールバックの資格要件を満たしている必要があります。
構文:
ask smapi rollback-skill [--skill-id | -s <スキルID>]
[--target-version <ターゲットバージョン>]
[--profile | -p <プロファイル>]
[--debug]
オプション:
- --skill-id, -s
- 必須です。スキルIDです。
- --target-version
- 必須です。ロールバックリクエストのIDです。
- --profile, -p
- 任意です。ASK CLIがスキルリソースをデプロイするプロファイルです。入力しない場合、ASK CLIはデフォルトのプロファイルを使用します。
- --debug
- 任意です。このオプションを指定すると、コマンド出力にデバッグメッセージが表示されます。
search-task
スキルのタスク情報を返します。キーワードとプロバイダースキルIDで検索できます。キーワード、プロバイダースキルIDの両方を省略した場合、スキルのタスクがすべて返されます。
構文
$ ask smapi search-task [--skill-id | -s <スキルID>]
[--provider-skill-id <プロバイダースキルID>]
[--keywords <キーワード>]
[--max-results <結果の最大件数>]
[--next-token <次のトークン>]
[--profile | -p <プロフィール>]
[--debug]
オプション
- --skill-id, -s
- 必須です。スキルIDです。
- --provider-skill-id
- 任意です。プロバイダースキルIDです。
- --keywords
- 任意です。キーワードには、タスクの詳細、タスク名、タスク定義のタグを含めることができます。キーワードはコンマで区切ります。各キーワードには複数の単語を含めることができます。たとえば、
--keywords "computer software, vacuum cleaner"
のように指定します。 - --max-results
- 任意です。応答本文で返される結果の最大数を設定します。上限である50件よりも少ない結果を取得する場合、このパラメーターをリクエストに追加できます。上限を超えるmaxResultsを指定することはできません。応答に含まれる項目がmaxResultsより少ない場合はありますが、この値を超えることはありません。検索条件を満たす結果が他にもあるけれど結果が返されない場合、応答にはisTruncated = trueが含まれます。
- --next-token
- 任意です。このAPI呼び出しへの応答が切り捨てられる(isTruncated応答要素の値がtrue)ときは、応答にnextToken要素も含まれます。nextTokenの値は、オブジェクトの次のセットのリストを表示する継続トークンとして次のリクエストで使用できます。継続トークンは、スキル管理APIが理解できるOpaque値です。トークンは24時間で有効期限が切れます。
- --profile, -p
- 使用するASK CLIプロファイルです。このオプションを含めない場合は、ASK CLIはデフォルトのプロファイルを使用します。
- --debug
- このオプションを指定すると、コマンド出力にデバッグメッセージが表示されます。
send-reminder-to-testers
指定したAlexaスキルについて、ベータテストに参加しているテスターにリマインダーを送信します。システムは、各テスターに招待メールを送信し、受諾時にエンタイトルメントを追加します。
構文
$ ask smapi send-reminder-to-testers [--skill-id | -s <スキルID>]
[--testers-emails <テスターのEメール>]
[--profile | -p <プロフィール>]
[--debug]
オプション
- --skill-id, -s
- 必須です。スキルIDです。
- --testers-emails
- 必須です。ベータテストのテスターのEメールアドレスです。[複数可]: 値はコンマで区切ることができます。
- --profile, -p
- 使用するASK CLIプロファイルです。このオプションを含めない場合は、ASK CLIはデフォルトのプロファイルを使用します。
- --debug
- このオプションを指定すると、コマンド出力にデバッグメッセージが表示されます。
set-asr-annotation-set
既存の自動音声認識(ASR)アノテーションセットを更新します。このコマンドは、アノテーションセットの名前を更新します。詳細については、自動音声認識(ASR)評価ツールについておよびこのコマンドのREST APIバージョンを参照してください。
構文
$ ask smapi set-asr-annotation-set [--skill-id | -s <skill-id>]
[--annotation-set-id <annotation-set-id>
[--name <name>]
[--full-response]
[--profile | -p <プロフィール>]
[--debug]
オプション
- --skill-id, -s
- 必須です。スキルIDです。
- --annotation-set-id
- 必須です。アノテーションセットのIDです。
- --name
- 必須です。アノテーションセットの名前です。名前には最大170文字の英数字を使用できます。
- --full-response
- このオプションを指定すると、応答の本文、ヘッダー、ステータスが1つのオブジェクトとして返されます。
- --profile, -p
- 使用するASK CLIプロファイルです。このオプションを含めない場合は、ASK CLIはデフォルトのプロファイルを使用します。
- --debug
- このオプションを指定すると、コマンド出力にデバッグメッセージが表示されます。
set-interaction-model
スキルの音声対話モデルを作成します
構文
$ ask smapi set-interaction-model [--skill-id | -s <スキルID>]
[--stage | -g <ステージ>]
[--locale | -l <ロケール>]
[--interaction-model <対話モデル>]
[--if-match <一致>]
[--profile | -p <プロフィール>]
[--debug]
オプション
- --skill-id, -s
- 必須です。スキルIDです。
- --stage, -g
- 必須です。新たに認定されたステージを含むスキルのステージです。* `development` - 現在開発中のスキルがこのステージに対応します。 * `certified` - 認定を完了し、公開準備のできたスキルがこのステージに対応します。 * `live` - 現在公開中のスキルがこのステージに対応します。
- --locale, -l
- 必須です。リクエストされたモデルのロケール。例:en-GB、en-US、de-DE。
- --interaction-model
- 必須です。JSON形式の音声対話モデルです。[JSON]
- --if-match
- 任意です。エンティティタグを指定したリクエストヘッダーです。サーバーは、eTagがリソースの現在のeTagと一致した場合にのみリソースを更新します。
- --profile, -p
- 使用するASK CLIプロファイルです。このオプションを含めない場合は、ASK CLIはデフォルトのプロファイルを使用します。
- --debug
- このオプションを指定すると、コマンド出力にデバッグメッセージが表示されます。
set-private-distribution-account-id
非公開の配信アカウントにIDを追加します。
構文
$ ask smapi set-private-distribution-account-id [--skill-id | -s <スキルID>]
[--stage | -g <ステージ>]
[--id <ID>]
[--profile | -p <プロフィール>]
[--debug]
オプション
- --skill-id, -s
- 必須です。スキルIDです。
- --stage, -g
- 必須です。スキルのステージです。
- --id
- 必須です。スキルを非公開で配信できるARNです。
- --profile, -p
- 使用するASK CLIプロファイルです。このオプションを含めない場合は、ASK CLIはデフォルトのプロファイルを使用します。
- --debug
- このオプションを指定すると、コマンド出力にデバッグメッセージが表示されます。
set-skill-enablement
指定したskillId/stageとcustomerId(Authトークンにより取得)の有効化ステータスを作成または更新します。
構文
$ ask smapi set-skill-enablement [--skill-id | -s <スキルID>]
[--stage | -g <ステージ>]
[--profile | -p <プロフィール>]
[--debug]
オプション
- --skill-id, -s
- 必須です。スキルIDです。
- --stage, -g
- 必須です。スキルのステージです。
- --profile, -p
- 使用するASK CLIプロファイルです。このオプションを含めない場合は、ASK CLIはデフォルトのプロファイルを使用します。
- --debug
- このオプションを指定すると、コマンド出力にデバッグメッセージが表示されます。
set-ssl-certificates
このスキルに関連付けられたSSL証明書を更新します。
構文
$ ask smapi set-ssl-certificates [--skill-id | -s <スキルID>]
[--ssl-certificate-payload <SSL証明書のペイロード>]
[--profile | -p <プロフィール>]
[--debug]
オプション
- --skill-id, -s
- 必須です。スキルIDです。
- --ssl-certificate-payload
- 必須です。スキルのSSL証明書APIの入力および出力を定義します。[JSON]
- --profile, -p
- 使用するASK CLIプロファイルです。このオプションを含めない場合は、ASK CLIはデフォルトのプロファイルを使用します。
- --debug
- このオプションを指定すると、コマンド出力にデバッグメッセージが表示されます。
simulate-skill
これは、ユーザーの発話でスキルをシミュレートする非同期APIです。成功した場合の応答のヘッダーには、シミュレーションリソースの場所が含まれます。このAPIへのリクエストがエラーになった場合、応答にはエラーコードと問題の詳細が含まれます。シミュレートされるスキルは、このAPIのユーザーに属し、このユーザーによって有効にされる必要があります。現時点では、1ユーザーからの同時かつ複数のリクエストは許可されていません。
構文
$ ask smapi simulate-skill [--skill-id | -s <スキルID>]
[--stage | -g <ステージ>]
[--input-content <入力コンテンツ>]
[--device-locale <デバイスのロケール>]
[--session-mode <セッションモード>]
[--simulation-type <simulation-type>]
[--profile | -p <プロフィール>]
[--debug]
オプション
- --skill-id, -s
- 必須です。スキルIDです。
- --stage, -g
- 必須です。スキルのステージです。
- --input-content
- 必須です。ユーザーがAlexaに対して話しかける発話テキストを表す文字列です。
- --device-locale
- 必須です。シミュレーションで使用する仮想デバイスの有効なロケール("ja-JP"など)です。
- --session-mode
- 任意です。現在のシミュレーションのセッションモードが使用中であることを表します。[列挙]: DEFAULT,FORCE_NEW_SESSION
- --simulation-type
- シミュレーションリクエストのタイプを示す文字列。[ENUM]: DEFAULT、NFI_ISOLATED_SIMULATION。デフォルトのスキルシミュレーション動作を続行するには、DEFAULTを指定します。NFI_ISOLATED_SIMULATIONを指定すると、無指名対話のスキルを単独でテストできます。
- --profile, -p
- 使用するASK CLIプロファイルです。このオプションを含めない場合は、ASK CLIはデフォルトのプロファイルを使用します。
- --debug
- このオプションを指定すると、コマンド出力にデバッグメッセージが表示されます。
start-beta-test
特定のスキルのベータテストを開始します。システムは、各テスターに招待のEメールを送信し、承諾されると参加資格を追加します。
構文
$ ask smapi start-beta-test [--skill-id | -s <スキルID>]
[--profile | -p <プロフィール>]
[--debug]
オプション
- --skill-id, -s
- 必須です。スキルIDです。
- --profile, -p
- 使用するASK CLIプロファイルです。このオプションを含めない場合は、ASK CLIはデフォルトのプロファイルを使用します。
- --debug
- このオプションを指定すると、コマンド出力にデバッグメッセージが表示されます。
submit-skill-for-certification
スキルの認定を申請します。
構文
$ ask smapi submit-skill-for-certification [--skill-id | -s <スキルID>]
[--publication-method <公開方法>]
[--profile | -p <プロフィール>]
[--debug]
オプション
- --skill-id, -s
- 必須です。スキルIDです。
- --publication-method
- 任意です。スキルを認定のためだけに申請して後から手動で公開するか、認定直後に公開するかを決定します。公開方法を省略すると、デフォルトの自動公開になります。[列挙]: MANUAL_PUBLISHING、AUTO_PUBLISHING.
- --profile, -p
- 使用するASK CLIプロファイルです。このオプションを含めない場合は、ASK CLIはデフォルトのプロファイルを使用します。
- --debug
- このオプションを指定すると、コマンド出力にデバッグメッセージが表示されます。
submit-skill-validation
これは、スキル開発者がスキルに対してさまざまな検証を実行できる非同期APIです。
構文
$ ask smapi submit-skill-validation [--locales | -l <ロケール>]
[--skill-id | -s <スキルID>]
[--stage | -g <ステージ>]
[--profile | -p <プロフィール>]
[--debug]
オプション
- --locale、-ls
- 必須です。
- --skill-id, -s
- 必須です。スキルIDです。
- --stage, -g
- 必須です。スキルのステージです。
- --profile, -p
- 使用するASK CLIプロファイルです。このオプションを含めない場合は、ASK CLIはデフォルトのプロファイルを使用します。
- --debug
- このオプションを指定すると、コマンド出力にデバッグメッセージが表示されます。
update-account-linking-info
スキルのアカウントリンク情報を作成します。
構文
$ ask smapi update-account-linking-info [--skill-id | -s <スキルID>]
[--stage | -g <ステージ>]
[--account-linking-request <アカウントリンクリクエスト>]
[--if-match <一致>]
[--profile | -p <プロフィール>]
[--debug]
オプション
- --skill-id, -s
- 必須です。スキルIDです。
- --stage, -g
- 必須です。新たに認定されたステージを含むスキルのステージです。* `development` - 現在開発中のスキルがこのステージに対応します。 * `certified` - 認定を完了し、公開準備のできたスキルがこのステージに対応します。 * `live` - 現在公開中のスキルがこのステージに対応します。
- --account-linking-request
- 必須です。アカウントリンクパートナーの作成に必要なフィールドです。[JSON]
- --if-match
- 任意です。エンティティタグを指定したリクエストヘッダーです。サーバーは、eTagがリソースの現在のeTagと一致した場合にのみリソースを更新します。
- --profile, -p
- 使用するASK CLIプロファイルです。このオプションを含めない場合は、ASK CLIはデフォルトのプロファイルを使用します。
- --debug
- このオプションを指定すると、コマンド出力にデバッグメッセージが表示されます。
update-beta-test
特定のAlexaスキルのベータテストを更新します。
構文
$ ask smapi update-beta-test [--skill-id | -s <スキルID>]
[--feedback-email <フィードバックEメール>]
[--profile | -p <プロフィール>]
[--debug]
オプション
- --skill-id, -s
- 必須です。スキルIDです。
- --feedback-email
- 任意です。フィードバックを提供するEメールアドレスです。
- --profile, -p
- 使用するASK CLIプロファイルです。このオプションを含めない場合は、ASK CLIはデフォルトのプロファイルを使用します。
- --debug
- このオプションを指定すると、コマンド出力にデバッグメッセージが表示されます。
update-interaction-model-catalog
カタログを更新します。詳細については、Interaction Model Catalog Management REST API Referenceを参照してください。
構文
$ ask smapi update-interaction-model-catalog [--catalog-id | -c <カタログID>]
[--slot-type-description <スロットタイプの説明>]
[--profile | -p <プロフィール>]
[--debug]
オプション
- --catalog-id, -c
- 必須です。一意のカタログIDです。
- --slot-type-description
- 任意です。255文字までのスロットタイプの説明です。
- --profile, -p
- 使用するASK CLIプロファイルです。このオプションを含めない場合は、ASK CLIはデフォルトのプロファイルを使用します。
- --debug
- このオプションを指定すると、コマンド出力にデバッグメッセージが表示されます。
update-interaction-model-catalog-version
カタログのバージョンを指定して説明と手順を更新します。詳細については、Interaction Model Catalog Management REST API Referenceを参照してください。
構文
$ ask smapi update-interaction-model-catalog-version [--catalog-id | -c <カタログID>]
[--vers <バージョン>]
[--description <説明>]
[--profile | -p <プロフィール>]
[--debug]
オプション
- --catalog-id, -c
- 必須です。一意のカタログIDです。
- --vers
- 必須です。音声対話モデルのバージョンです。
- --description
- 任意です。カタログの説明です(最大255文字)。
- --profile, -p
- 使用するASK CLIプロファイルです。このオプションを含めない場合は、ASK CLIはデフォルトのプロファイルを使用します。
- --debug
- このオプションを指定すると、コマンド出力にデバッグメッセージが表示されます。
update-interaction-model-slot-type
スロットタイプの特定バージョンのdescriptionとvendorGuidanceの文字列を更新します。
構文
$ ask smapi update-interaction-model-slot-type [--slot-type-id <スロットタイプID>]
[--slot-type-description <スロットタイプの説明>]
[--profile | -p <プロフィール>]
[--debug]
オプション
- --slot-type-id
- 必須です。スロットタイプのIDです。
- --slot-type-description
- 任意です。255文字までのスロットタイプの説明です。
- --profile, -p
- 使用するASK CLIプロファイルです。このオプションを含めない場合は、ASK CLIはデフォルトのプロファイルを使用します。
- --debug
- このオプションを指定すると、コマンド出力にデバッグメッセージが表示されます。
update-interaction-model-slot-type-version
スロットタイプの特定バージョンのdescriptionとvendorGuidanceの文字列を更新します。
構文
$ ask smapi update-interaction-model-slot-type-version [--slot-type-id <スロットタイプID>]
[--vers <バージョン>]
[--slot-type-description <スロットタイプの説明>]
[--profile | -p <プロフィール>]
[--debug]
オプション
- --slot-type-id
- 必須です。スロットタイプのIDです。
- --vers
- 必須です。音声対話モデルのバージョンです。
- --slot-type-description
- 任意です。255文字までのスロットタイプの説明です。
- --profile, -p
- 使用するASK CLIプロファイルです。このオプションを含めない場合は、ASK CLIはデフォルトのプロファイルを使用します。
- --debug
- このオプションを指定すると、コマンド出力にデバッグメッセージが表示されます。
update-isp-for-product
指定された商品IDのスキル内商品の定義を更新します。開発ステージのみサポートされています。
構文
$ ask smapi update-isp-for-product [--if-match <一致>]
[--product-id <商品ID>]
[--stage | -g <ステージ>]
[--in-skill-product <スキル内商品>]
[--profile | -p <プロフィール>]
[--debug]
オプション
- --if-match
- 任意です。エンティティタグを指定したリクエストヘッダーです。サーバーは、eTagがリソースの現在のeTagと一致した場合にのみリソースを更新します。
- --product-id
- 必須です。スキル内商品のIDです。
- --stage, -g
- 必須です。スキルのステージです。
- --in-skill-product
- 必須です。updateInSkillProduct APIのリクエスト本文をJSONファイルで定義します。
file:<ファイルパス/jsonファイル名>
を使用します。ファイル形式の詳細については、スキル内商品を更新する(SMAPI API)を参照してください。 - --profile, -p
- 使用するASK CLIプロファイルです。このオプションを含めない場合は、ASK CLIはデフォルトのプロファイルを使用します。
- --debug
- このオプションを指定すると、コマンド出力にデバッグメッセージが表示されます。
update-skill-manifest
指定したskillIdとステージのスキルマニフェストを更新します。このコマンドを使用する前にマニフェストスキーマに関する情報を取得するには、get-resource-schemaを呼び出します。
構文
$ ask smapi update-skill-manifest [--if-match <一致>]
[--skill-id | -s <スキルID>]
[--stage | -g <ステージ>]
[--manifest <マニフェスト>]
[--profile | -p <プロフィール>]
[--debug]
オプション
- --if-match
- 任意です。エンティティタグを指定したリクエストヘッダーです。サーバーは、eTagがリソースの現在のeTagと一致した場合にのみリソースを更新します。
- --skill-id, -s
- 必須です。スキルIDです。
- --stage, -g
- 必須です。新たに認定されたステージを含むスキルのステージです。* `development` - 現在開発中のスキルがこのステージに対応します。 * `certified` - 認定を完了し、公開準備のできたスキルがこのステージに対応します。 * `live` - 現在公開中のスキルがこのステージに対応します。
- --manifest
- 必須です。updateSkill APIのリクエスト本文です。[JSON]
- --profile, -p
- 使用するASK CLIプロファイルです。このオプションを含めない場合は、ASK CLIはデフォルトのプロファイルを使用します。
- --debug
- このオプションを指定すると、コマンド出力にデバッグメッセージが表示されます。
upload-catalog
カタログのファイルをアップロードします。カタログはJSON形式である必要があります。以下は、カタログ形式を示すレシピスキルの例です。
{
"values":
[
{
"id": "id1",
"name": {
"value": "ココナッツミルク"
}
},
{
"id": "id2",
"name": {
"value": "エシャロット"
}
},
{
"id": "id3",
"name": {
"value": "ピーマン"
}
}
]
}
構文
$ ask smapi upload-catalog [--catalog-id | -c <カタログID>]
[--file | -f <ファイル>]
[--profile | -p <プロフィール>]
[--debug]
オプション
- --catalog-id, -c
- 必須です。一意のカタログIDです。
- --file, -f
- 必須です。入力するターゲットファイルのパスです。カタログファイルの形式については、upload-catalogの冒頭を参照してください。
- --profile, -p
- 任意です。使用するASK CLIプロファイルです。このオプションを含めない場合は、ASK CLIはデフォルトのプロファイルを使用します。
- --debug
- 任意です。このオプションを指定すると、コマンド出力にデバッグメッセージが表示されます。
withdraw-skill-from-certification
スキルの認定申請を取り下げます。
構文
$ ask smapi withdraw-skill-from-certification [--skill-id | -s <スキルID>]
[--reason <理由>]
[--message <メッセージ>]
[--profile | -p <プロフィール>]
[--debug]
オプション
- --skill-id, -s
- 必須です。スキルIDです。
- --reason
- 任意です。取り下げる理由です。[列挙]: TEST_SKILL,MORE_FEATURES,DISCOVERED_ISSUE,NOT_RECEIVED_CERTIFICATION_FEEDBACK,NOT_INTEND_TO_PUBLISH,OTHER
- --message
- 必須です。理由がOTHERの場合のみメッセージが必要です。
- --profile, -p
- 使用するASK CLIプロファイルです。このオプションを含めない場合は、ASK CLIはデフォルトのプロファイルを使用します。
- --debug
- このオプションを指定すると、コマンド出力にデバッグメッセージが表示されます。
最終更新日: 2023 年 05 月 15 日