ASK CLIコマンドリファレンス（v1）



• ASK CLIのコマンド
  • initコマンド
  • newコマンド
  • deployコマンド
  • cloneコマンド
  • create-hosted-skillコマンド
  • diffコマンド
  • validateコマンド
  • simulateコマンド
  • dialogコマンド
    • 再生ファイル形式
• カタログURLリファレンス
  • create model catalog
  • create model catalog version
  • get model catalog update status
  • get model catalog
  • get model catalog version
  • update model catalog
  • update model catalog version
  • get model catalog values
  • list model catalogs
  • list model catalog versions
  • delete model catalog
  • delete model catalog version
• apiコマンド
  • create-skillサブコマンド
  • get-skillサブコマンド
  • get-skill-credentialsサブコマンド
  • delete-skillサブコマンド
  • update-skillサブコマンド
  • get-modelサブコマンド
  • update-modelサブコマンド
  • head-modelサブコマンド
  • list-model-versionsサブコマンド
  • get-skill-statusサブコマンド
  • create-account-linkingサブコマンド
  • get-account-linkingサブコマンド
  • delete-account-linkingサブコマンド
  • create-beta-testサブコマンド
  • update-beta-testサブコマンド
  • get-beta-testサブコマンド
  • start-beta-testサブコマンド
  • end-beta-testサブコマンド
  • list-beta-testersサブコマンド
  • add-beta-testersサブコマンド
  • remove-beta-testersサブコマンド
  • send-reminder-to-beta-testersサブコマンド
  • request-feedback-from-beta-testersサブコマンド
  • validate-skillサブコマンド
  • get-validationサブコマンド
  • submitサブコマンド
  • publish-skillサブコマンド
  • withdrawサブコマンド
  • list-certificationsサブコマンド
  • get-certificationサブコマンド
  • get-skill-publicationsサブコマンド
  • list-vendorsサブコマンド
  • list-skillsサブコマンド
  • add-private-distribution-accountサブコマンド
  • delete-private-distribution-accountサブコマンド
  • list-private-distribution-accountsサブコマンド
  • enable-skillサブコマンド
  • disable-skillサブコマンド
  • get-skill-enablementサブコマンド
  • invoke-skillサブコマンド
  • simulate-skillサブコマンド
  • get-simulationサブコマンド
  • intent-requests-historyサブコマンド
  • list-catalogsサブコマンド
  • get-catalogサブコマンド
  • create-catalogサブコマンド
  • list-catalog-uploadsサブコマンド
  • get-catalog-uploadサブコマンド
  • associate-catalog-with-skillサブコマンド
  • upload-catalogサブコマンド
  • create-nlu-annotation-setサブコマンド
  • list-nlu-annotation-setsサブコマンド
  • update-nlu-annotation-set-annotationsサブコマンド
  • get-nlu-annotation-set-annotationsサブコマンド
  • update-nlu-annotation-set-propertiesサブコマンド
  • get-nlu-annotation-set-propertiesサブコマンド
  • delete-nlu-annotation-setサブコマンド
  • evaluate-nluサブコマンド
  • list-nlu-evaluationsサブコマンド
  • get-nlu-evaluationサブコマンド
  • get-nlu-evaluation-resultsサブコマンド
  • get-conflict-detection-job-statusサブコマンド
  • get-conflicts
  • utilコマンド
    • generate-lwa-tokens
  • lambdaコマンド
    • downloadサブコマンド
    • uploadサブコマンド
    • logサブコマンド
  • スマートホーム評価ツールのサブコマンド
    • list-smarthome-capability-test-plansサブコマンド
    • create-smarthome-capability-evaluationサブコマンド
    • list-smarthome-capability-evaluationsサブコマンド
    • get-smarthome-capability-evaluationサブコマンド
    • get-smarthome-capability-evaluation-resultsサブコマンド
  • スロットタイプのサブコマンド
    • create-model-slot-typeサブコマンド
    • get-model-slot-typeサブコマンド
    • update-model-slot-typeサブコマンド
    • list-model-slot-typesサブコマンド
    • delete-model-slot-typeサブコマンド
    • create-model-slot-type-versionサブコマンド
    • get-model-slot-type-update-statusサブコマンド
    • get-model-slot-type-versionサブコマンド
    • update-model-slot-type-versionサブコマンド
    • list-model-slot-type-versionsサブコマンド
    • delete-model-slot-type-versionサブコマンド
  • ASK CLIコマンドのデバッグモード
• 関連トピック

Alexa Skills Kitコマンドラインインターフェース（ASK CLI）を使って開発を始めるには、ASK CLIクイックスタートを参照してください。

ASK CLIについては、ASK CLIの概要を参照してください。

このリファレンスでは、ASK CLIで利用できるすべてのコマンドについて説明します。

ASK CLIのコマンド

開発者アカウントに関連付けられたスキルを処理するASK CLIのコマンドには、2つの種類があります。

• 高レベルコマンドはスキルのプロジェクト作業効率を向上させるためのものです。通常、詳細を抽象化し、複数の操作を内部で実行できるようになっています。スキルを初めて開発する場合や、API呼び出しを細かく制御する必要がない場合に最適です。init、new、deploy、clone、validate、simulateは高レベルコマンドです。
• 低レベルコマンドは、Alexaスキルを詳細に管理するために使用します。Alexaスキル管理API操作のシンラッパーとして機能するため、各API呼び出しを細かく制御することができます。既にアカウントに追加したスキルの一部を変更する場合に特に便利です。apiおよびlambdaは下位コマンドです。

$ ask <コマンド> <サブコマンド> [オプション]

ASK CLIのコマンドにより、以下のタスクを実行できます。

initコマンド

ask initコマンドでは、認証情報を設定できます。ASK CLIは、この認証情報をAmazon開発者サービスやアマゾンウェブサービス（AWS）の認証に使います。この対話形式のコマンドを使うと、ウェブブラウザが開きます。Amazon開発者アカウントでサインインすると、使用する認証情報に関する情報を入力するか、質問に答えるようプロンプトが出ます。

ask initを使うと、別のAmazonアカウントやAWSアカウントの認証情報を含むプロファイルの表示や設定ができます。プロファイルでは、ASK CLIを使って別のアカウントで作成したスキルを管理できます。ask new、ask clone、ask deployなどのコマンドに-pまたは--profileオプションを付けて使用します。

ASK CLIがAmazon開発者アカウントやAWSアカウントの認証情報を保存、管理する方法については、ASK CLIを使った認証情報の管理を参照してください。

構文：

ask init [-l | --list-profiles]
         [-p | --profile <プロファイル>]
         [--no-browser]
         [--aws-setup]
         [--debug]
         [-h | --help]

オプション：

-l

--list-profiles

任意です。ASK CLIが使用可能なプロファイルのリストを表示します。

-p <プロファイル>

--profile <プロファイル>

任意です。設定する認証情報に使うプロファイルを指定します。このオプションを省略すると、リストからプロファイルを選択するか、新規作成するようASK CLIのプロンプトが出ます。

--no-browser

任意です。このオプションを使うと、ask initコマンドをウェブブラウザを持たないコンピューターで実行できます。ASK CLIにURLが表示されるので、別のコンピューターのウェブブラウザを使ってこのURLにアクセスし、Amazon開発者アカウントでサインインできます。サインインすると、ブラウザにコードが表示されるので、コマンドラインに入力して認証情報の設定を完了します。

--aws-setup

任意です。このオプションを使うと、Amazon開発者認証情報の設定を省略し、AWS認証情報のみを設定できます。

newコマンド

ask newコマンドでは、スキルテンプレートからコピーして新しいスキルプロジェクトを作成できます。

概要と使用例については、ASK CLIの概要で新しいスキルプロジェクトを作成するを参照してください。

構文：

ask new [--url <url> [--template <テンプレート名>]]
        [-n | --skill-name <スキル名>]
        [--lambda-name <Lambda関数名>]
        [-p | --profile <プロファイル>]
        [--debug]
        [--help]

オプション：

--url <GitまたはJSONのURL> [--template <テンプレート名>]

任意です。以下のいずれかになります。

• スキルテンプレートを含むGitリポジトリのURL
• スキルテンプレートの一覧を含むJSONファイルのURL

--urlがJSONファイルの場合、任意で--templateを使用して、リストのテンプレート名を指定できます。

-n <スキル名>

--skill-name <スキル名>

任意です。新しいスキルプロジェクトのスキル名です。ASK CLIはこの名前を使用して、コンピューターにスキルのプロジェクトフォルダを作成します。アルファベットの大文字および小文字（A～Z、a～z）、数字（0～9）、アンダーバー（&lowbar;）、ダッシュ（-）を含めることができます。

--lambda-name <Lambda関数名>

任意です。スキルのAWS Lambda関数名です。入力しない場合、ASK CLIがLambda関数にスキルと同じ名前を付けます。

-p <プロファイル>

--profile <プロファイル>

任意です。ASK CLIがスキル作成に使用したプロファイルです。入力しない場合、ASK CLIはデフォルトのプロファイルを使用します。

deployコマンド

概要と使用例については、ASK CLIの概要でスキルプロジェクトを開発中ステージにデプロイするを参照してください。

構文：

ask deploy [--no-wait]
           [-t | --target <ターゲット値>]
           [--force]
           [-p | --profile <プロファイル>]
           [--debug]
           [--help]

オプション：

--no-wait

任意です。--no-waitを指定すると、ASK CLIはモデルのビルドをせず、デプロイされたスキルを有効にしません。--no-waitを使用する場合、次回deployコマンドを使う際に必ず--forceパラメーターを指定するようにしてください。使用しない場合、deployコマンドはeTag値を比較して、eTag値が一致しないという警告を出す可能性があります。これは、前回モデルのビルドを待機せずにdeployコマンドを完了したためです。

-t <ターゲット値>

--target <ターゲット値>

任意です。このパラメーターを使用して、デプロイするリソースを指定します。有効な値は次のとおりです。

• all – 以下のリソースすべて
• skill – スキルマニフェスト
• model – スキルモデルまたはモデル
• lambda – AWS Lambdaソースコードおよびコンフィギュレーション
• isp – スキル内商品

--force

任意です。指定されたリソースのローカルバージョンを確認せずにアップロードします。リソースのリモートバージョンと差異がある場合も実行します。

-p <プロファイル>

--profile <プロファイル>

任意です。ASK CLIがスキルリソースをデプロイするプロファイルです。入力しない場合、ASK CLIはデフォルトのプロファイルを使用します。

cloneコマンド

developmentステージから既存のスキルをクローンすることにより、新しいスキルプロジェクトをローカルに作成します。certifiedまたは liveステージのスキルをクローンすることはできません。スキル内商品を含むスキルをクローンすると、スキル内商品もクローンされます。次の項目を参照してください。

cloneコマンドの形式：

$ ask clone [-s|--skill-id <スキルID>] [-p| --profile <プロファイル>] [--debug]

オプション：

--skill-id, -s

任意です。ターゲットスキルのスキルIDです。amzn1.ask.skill.12345678-1234-1234-123456789123の形式で指定する必要があります。

--profile, -p

任意です。クローンするスキルのプロファイルです。指定しない場合は、デフォルトのプロファイルが使用されます。

--debug

任意です。標準エラー出力にデバッグメッセージを追加します。

ask cloneをオプションなしで実行した場合、スキルのリスト（LastModifiedの順）が表示され、このリストからクローンするスキルを選択できます。

skill-idを指定した場合、現在のディレクトリにスキルのクローンが作成されます。また、存在する場合は対話モデルとLambda関数もダウンロードします。スキルのコードがAWS Lambda関数としてではなく、HTTPSエンドポイントでホストされている場合、ダウンロードされません。

スキル定義のダウンロード後、ASK CLIによってAWS Lambda関数のARNが.ask/configファイルに書き込まれ、skill.jsonファイルのendpoint:uriプロパティがsourceDir（Lambda関数のコードベースのソースディレクトリ）に置き換えられます。これは、スキルプロジェクトを移植できるようにし、必要に応じて同じスキルを複数のプロファイルにデプロイできるようにするためです。スキルがAWS Lambdaではなく、ウェブサービスとしてホストされている場合、何も置換されません。

create-hosted-skillコマンド

このコマンドは、新しいAlexa-hostedスキルを作成します。Alexa-hostedスキルの詳細については、Alexa-hostedスキルを使用してスキルをエンドツーエンドで作成するを参照してください。

このコマンドを使用して新しいAlexa-hostedスキルを作成すると、デフォルトでは、ASK CLIはスキルをコンピューターにクローンしません。Alexa-hostedスキルを作成した後、ask cloneコマンドでスキルをコンピューターにクローンするか、--auto-clone trueオプションを使用してスキルを1個のコマンドで作成、クローンします。

これが最初のAlexa-hostedスキルの場合、ASK CLIがWebブラウザを開くので、Amazon開発者アカウントにサインインし、CAPTCHAテストを完了してください。ローカルコンピューターでWebブラウザを開くことができない場合、--no-browserオプションを使用してこのステップを完了します。

構文：

ask create-hosted-skill [--runtime <runtime>]
                        [-n | --skill-name <name>]
                        [--auto-clone <true | false>]
                        [--no-browser]
                        [-p | --profile <プロファイル>]
                        [--debug]
                        [-h | --help]

オプション：

--runtime <runtime>

任意です。Alexa-hostedスキルで使用するAWS Lambdaランタイムです。デフォルト値はnodejs10.xです。サポートされている値は、nodejs10.xとpython3.7です。

-n <name>

--skill-name <name>

任意です。Alexa-hostedスキルの名前です。

--auto-clone <true | false>

任意です。作成後にAlexa-hostedスキルをローカルコンピューターにクローンするかどうかを決定します。有効な値はtrueまたはfalseです。

--no-browser

任意です。ローカルコンピューターでWebブラウザを開かずに、最初のAlexa-hostedスキルのCAPTCHAテストを完了できます。代わりに、コマンド出力でコピーできるURLを表示し、それを他のコンピューターのWebブラウザで開いてサインインし、CAPTCHAテストを完了することもできます。

-p <プロファイル>

--profile <プロファイル>

任意です。Alexa-hostedスキルを作成するためのASK CLIプロファイルです。

--debug

任意です。コマンド出力でデバッグメッセージを表示します。

-h

--help

任意です。コマンドのヘルプメッセージを表示します。

diffコマンド

指定したターゲットのローカルバージョンとリモートバージョンの差分を列挙します。ターゲットを指定しない場合、ASK CLIはすべてのリソースの差分を表示します。ASK CLIはまずローカルとリモートのeTagを比較し、ローカルバージョンが最新バージョンに基づいているかどうかを通知してから、diffの結果を表示します。プロジェクトのローカルコンポーネントとリモートコンポーネントの差分を表示するため、deployを使用する前にdiffコマンドを実行することをおすすめします。

diffコマンドの形式：

$ ask diff [-t|--target <ターゲット>] [-p| --profile <プロファイル>] [--debug]

オプション：

--target, -t

任意です。targetには差分を表示するプロジェクトコンポーネントを指定します。targetの有効な値は、all、lambda、skill、model、ispです。指定しない場合のデフォルト値はallです。

--profile, -p

任意です。スキルのバージョンを比較するプロファイルです。指定しない場合は、デフォルトのプロファイルが使用されます。

--debug

任意です。標準エラー出力にデバッグメッセージを追加します。

違いが表示されたら、開発者は必要に応じて手動でローカルバージョンを編集できます。ローカルバージョンを編集したら、deployを使ってリモートバージョンを更新できます。

validateコマンド

スキルの認定を申請する前や開発中の見直しで随時、スキルを検証するテストを実行します。サポートされるテストについては、スキルの検証の「サポートされる検証」を参照してください。

これは、検証結果を取得できるまでポーリングする非同期操作です。検証の実行と、検証結果の取得をそれぞれ別に行う場合は、validate-skillとget-validationを参照してください。

validateコマンドの形式：

$ ask validate [-s|--skill-id <スキルID>] [-l|--locales <ロケール>] [-g|--stage <ステージ>] [-p|--profile <プロファイル>] [--debug]

オプション：

--skill-id, -s

任意です。検証するスキルのスキルIDです。amzn1.ask.skill.12345678-1234-1234-123456789123の形式で指定する必要があります。skill-idが指定されていない場合、このコマンドは、テストするスキルが既に作成またはクローンされているスキルプロジェクトのルートディレクトリで実行する必要があります。skill-idが指定されている場合、このコマンドはどこからでも実行できます。

--locales, -l

任意です。ロケールのリストです。サポートしている値は、de-DE、en-AU、en-CA、en-GB、en-IN、en-US、es-ES、es-MX、es-US、fr-CA、fr-FR、hi-IN、it-IT、ja-JP、pt-BRです。ASK_DEFAULT_DEVICE_LOCALE環境変数が設定されている場合、このオプションを指定する必要はありません。このオプションが指定されておらず、かつASK_DEFAULT_DEVICE_LOCALE環境変数が設定されていない場合、コマンドを実行すると環境変数またはデバイスロケールを指定するよう求めるエラーメッセージが返されます。

--stage, -g

任意です。スキルのステージを表します。値として、developmentかliveのいずれかを使用します。デフォルトはdevelopmentです。

--profile, -p

任意です。アカウントリンクのコンフィギュレーションを取得するプロファイルです。指定しない場合は、デフォルトのプロファイルが使用されます。

--debug

任意です。標準エラー出力にデバッグメッセージを追加します。

simulateコマンド

テキスト入力によりスキルの呼び出しをシミュレートします。このコマンドは、内部的にask api simulate-skillを呼び出し、完了するまでシミュレーションステータスのポーリングを継続します。パラメーターはask api simulate-skillと同じです。

simulateコマンドの形式：

$ ask simulate [-f| --file <ファイルパス>] [-t| --text <テキスト>] [-l| --locale <ロケール>] [-s|--skill-id <スキルID>] [--force-new-session] [-g| --stage] [-p| --profile <プロファイル>] [--debug]

--file, -f

<-t, --text>を指定する場合は使用しません。それ以外の場合は必須です。シミュレーションに使う発話テキストコンテンツファイルへのパスです。絶対または相対パスで指定できます。

--text, -t

<-f, --file>を指定する場合は使用しません。それ以外の場合は必須です。スキルのシミュレートに使用する発話テキストを入力します。

--locale, -l

ASK_DEFAULT_DEVICE_LOCALE環境変数が設定されている場合は任意、それ以外は必須です。シミュレートするスキルのロケールです。有効な値は、en-US、en-GB、en-CA、en-AU、en-IN、de-DE、ja-JPです。指定しない場合、ロケールを入力するようプロンプトが出ます。

--skill-id, -s

任意です。amzn1.ask.skill.12345678-1234-1234-123456789123の形式で指定する必要があります。指定しない場合、CLIは現在のプロファイルの.ask/configファイルからスキルIDを取得します。

--force-new-session

任意です。新しいダイアログセッションを開始してからシミュレーションを実行します。

--stage, -g

任意です。スキルのステージを表します。値として、developmentかliveのいずれかを使用します。デフォルトはdevelopmentです。

--profile, -p

任意です。デフォルト以外のプロファイルを使うには、プロファイル名を指定します。

--debug

任意です。標準エラー出力にデバッグメッセージを追加します。

dialogコマンド

開発者がAlexaとのマルチターンの会話をシミュレートできるダイアログモードを開始します。各ダイアログはsimulate-skillを使用します。これは、シミュレーション結果が入手できるまでポーリングを続ける非同期の操作です。結果を入手したら、Alexaのテキスト応答を表示します。パラメーターが無効な場合、対話モードは開始しません。また、ユーザーが特殊コマンドの「!quit」かCtrl+Cを入力しない限り終了しません。

dialogコマンドの形式：

ask dialog [-s|--skill-id <スキルID>] [-l|--locale <ロケール>] [-g|--stage <ステージ>] [-r|--replay <ファイルパス>] [-o|--output <ファイルパス>]

ユーザーがダイアログ中に入力できるコマンドは2つあります。1つは!quitで、対話モードを終了します。もう1つは!recordで、ユーザーにファイル名を入力するようプロンプトを出し、ダイアログ入力を録音できます。これらのコマンドは、現在の対話モードのスキルID、ロケール、入力タイプ、すべての入力テキストと共に使用できます。!recordコマンドは、最後のセッションのユーザー入力のみを録音します。

このコマンドを--replayオプションを付けて実行する場合、スキルの情報とユーザー入力を含む録音ファイルを指定します。replayオプションはユーザー入力を再生し、Alexaが通常の会話のように応答します。再生ファイル形式を参照してください。コマンドラインでskillIdを指定しないでください。

このコマンドを--replayオプションを付けないで実行する場合、指定したスキルのリクエストをAlexaに話し掛けるときのようにダイアログに直接入力します。skillIdを指定するか、スキルプロジェクトのルートディレクトリからコマンドを実行し、localeを指定する必要があります。

スキルセッションが終了していない場合、「User >」プロンプトがコマンドラインに引き続き表示されるため、Alexaと会話しているときのようにテキストを入力できます。

スキルセッションが終了している場合は「—Skill Session Ended.—」行がコマンドラインウィンドウに表示されますが、対話モードは開いたままです。「User >」プロンプトが表示されるので、引き続きテキストを入力できます。

--skill-id, -s

任意です。amzn1.ask.skill.12345678-1234-1234-123456789123の形式で指定する必要があります。skill-idが指定されておらず、--replayオプションが指定されていない場合、このコマンドは、テストするスキルが既に作成またはクローンされているスキルプロジェクトのルートディレクトリから実行する必要があります。--replayオプションを使用する場合は、skill-idを指定できません。

--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

任意です。標準エラー出力にデバッグメッセージを追加します。

--output, -o

任意です。すべての発話、スキルの応答、関連するJSON要素のログを記録する出力ファイルを指定します。これらの出力ファイルの情報を使用して、バックエンドサービスのロジックをデバッグすることができます。

再生ファイル形式

再生ファイルは以下の形式になります。

{
    "skillId":"amazon.skill.123..",
    "locale": "ja-JP",
    "type": "text",
    "userInput": ["フライトの予約", "バンクーバー", ...]
}

適切な情報を指定し、以下の形式に従って再生ファイルを手動で作成して、後で利用できるよう保存できます。

再生ファイルは以下の手順でも作成できます。

• ask dialogコマンドを入力します。
• プロンプトが出たら、!recordと入力します。
• プロンプトに従って、必要な情報を入力します。これには、保存するファイル名も含まれます。

どちらの場合にも、--replayオプションを使用するときに使う再生ファイルを指定します。

再生ファイルには「!quit」、「!record」の特殊コマンドがいずれも含まれないようにしてください。これらが含まれていると、[Error]: Replay file should not include any special command.というエラーメッセージが表示されます。

カタログURLリファレンス

参照ベースのカタログ管理に、カスタムスロットタイプで使用できるCLIコマンドが追加されました。

これらのコマンドは、Alexaカタログ管理APIとは異なります。Alexaカタログ管理APIは、コンテンツカタログをAlexaにアップロードするために使用できます。カタログ管理の詳細については、 Alexaカタログの管理を参照してください。カタログを作成するには、 カタログを作成するを参照してください。

サポートされる言語：

参照ベースのカタログ管理では、JSONがサポートされます。

create model catalog

このコマンドでは、カタログとカタログIDを作成できます。

create-model-catalogコマンドの形式；

$ ask api create-model-catalog <-n|--catalog-name <カタログ名>> [-d|--catalog-description <カタログ説明>] [-p|--profile <プロファイル>] [--debug]

オプション

--catalog-name, -n,

必須。カタログの名前です。

--catalog-description, -d,

任意です。カタログの説明を提供します。

--profile, -p,

任意です。使用するASK CLIプロファイルです。

--debug

任意です。標準エラー出力にデバッグメッセージを追加します。

create model catalog version

このコマンドではカタログのバージョンを作成できます。

create-model-catalog-versionコマンドの形式：

$ ask api create-model-catalog-version <-c|--catalog-id <カタログID>> <-f|--file <ファイルへのパス>> [-d|--version-description <バージョン説明>] [-p|--profile <プロファイル>] [--debug]

オプション

--catalog-id, -c,

必須です。カタログのIDです。

--file, -f,

必須です。ソースとなるファイルへのパスです。

--version-description, -d,

任意です。新しいバージョンの説明です。

--profile, -p,

任意です。使用するASK CLIプロファイルです。

--debug

任意です。標準エラー出力にデバッグメッセージを追加します。

get model catalog update status

カタログの作成ステータスを追跡するには、このコマンドを使用します。

get-model-catalog-update-statusコマンドの形式：

$ ask api get-model-catalog-update-status <-c|--catalog-id <カタログID>> <-u|--update-request-id <更新リクエストID>> [-p|--profile <プロファイル>] [--debug]

オプション

--catalog-id, -c,

必須です。カタログのIDです。

--update-request-id, -u,

必須です。カタログバージョンの更新リクエストIDです。

--profile, -p,

任意です。使用するASK CLIプロファイルです。

--debug

任意です。標準エラー出力にデバッグメッセージを追加します。

get model catalog

カタログの名前、説明、作成日、バージョンを確認するには、このコマンドを使用します。

get-model-catalogコマンドの形式：

$ ask api get-model-catalog <-c|--catalog-id <カタログID>> [-p|--profile <プロファイル>] [--debug]

--catalog-id, -c,

必須です。カタログのIDです。

--profile, -p,

任意です。使用するASK CLIプロファイルです。

--debug

任意です。標準エラー出力にデバッグメッセージを追加します。

get model catalog version

カタログID、バージョン、説明を取得するには、このコマンドを使用します。

get-model-catalog-versionコマンドの形式：

$ ask api get-model-catalog-version <-c|--catalog-id <カタログID>> <--catalog-version <カタログのバージョン>> [-p|--profile <プロファイル>] [--debug]

オプション

--catalog-id, -c,

必須です。カタログのIDです。

--catalog-version,

必須です。カタログのバージョンです。

--profile, -p,

任意です。使用するASK CLIプロファイルです。

--debug

任意です。標準エラー出力にデバッグメッセージを追加します。

update model catalog

新しい値でカタログのメタデータを更新します。

update-model-catalogコマンドの形式：

$ ask api update-model-catalog <-c|--catalog-id <カタログID>> [-d|--catalog-description <カタログ説明>] [-n |--catalog-name <カタログ名>] [-p|--profile <プロファイル>] [--debug]

オプション

--catalog-id, -c,

必須です。カタログのIDです。

--catalog-name, -n

必須です。カタログの名前です。

--catalog-description, -d,

任意です。カタログの説明です。

--profile, -p,

任意です。使用するASK CLIプロファイルです。

--debug

任意です。標準エラー出力にデバッグメッセージを追加します。

update model catalog version

新しい値でカタログの説明メタデータを更新します。

update-model-catalog-versionコマンドの形式：

$ask api update-model-catalog-version <-c|--catalog-id <カタログID>> <--catalog-version <カタログのバージョン>> [-d|--version-description <バージョンの説明>] [-p|--profile <プロファイル>] [--debug]

オプション

--catalog-id, -c,

必須です。カタログのIDです。

--catalog-version,

必須です。カタログのバージョンです。

--catalog-description, -d,

任意です。カタログの説明です。

--profile, -p,

任意です。使用するASK CLIプロファイルです。

--debug

任意です。標準エラー出力にデバッグメッセージを追加します。

get model catalog values

カタログの値を取得するには、このコマンドを使用します。

get-model-catalog-valuesコマンドの形式：

$ ask api get-model-catalog-values <-c|--catalog-id <カタログID>> <--catalog-version <カタログのバージョン>> [--max-results <結果項目の最大数>] [--next-token <次のトークン>] [--sort-direction <ソート順>] [-p|--profile <プロファイル>] [--debug]

オプション

--catalog-id, -c,

必須です。カタログのIDです。

--catalog-version,

必須です。カタログのバージョンです。

--max-results

必須です。リクエストによって返される結果の最大数です。

--next-token

必須です。結果の次のページを照会することができます。

--sort-direction

必須です。結果の並び順を設定します。

--profile, -p,

任意です。使用するASK CLIプロファイルです。

--debug

任意です。標準エラー出力にデバッグメッセージを追加します。

list model catalogs

利用可能なすべてのカタログの一覧を取得するには、このコマンドを使用します。

list-model-catalogsコマンドの形式：

$ ask api list-model-catalogs [-m|--max-results <結果項目の最大数>] [--next-token <次のトークン>] [--sort-direction <ソート順>] [-p|--profile <プロファイル>] [--debug]

オプション

--catalog-id, -c,

必須です。カタログのIDです。

--max-results

必須です。リクエストによって返される結果の最大数です。

--next-token

必須です。結果の次のページを照会することができます。

--sort-direction

必須です。結果の並び順を設定します。

--profile, -p,

任意です。使用するASK CLIプロファイルです。

--debug

任意です。標準エラー出力にデバッグメッセージを追加します。

list model catalog versions

カタログIDを指定してすべてのバージョンの一覧を取得するには、このコマンドを使用します。

list-model-catalog-versionsコマンドの形式：

$ ask api list-model-catalog-versions <-c|--catalog-id <カタログID>> [--max-results <結果項目の最大数>] [--next-token <次のトークン>] [--sort-direction <ソート順>] [-p|--profile <プロファイル>] [--debug]

オプション

--max-results

必須です。リクエストによって返される結果の最大数です。

--next-token

必須です。結果の次のページを照会することができます。

--sort-direction

必須です。結果の並び順を設定します。

--profile, -p,

任意です。使用するASK CLIプロファイルです。

--debug

任意です。標準エラー出力にデバッグメッセージを追加します。

delete model catalog

カタログのすべてのバージョンを削除するには、このコマンドを使用します。

delete-model-catalogコマンドの形式：

$ ask api delete-model-catalog <-c|--catalog-id <カタログID>> [-p|--profile <プロファイル>] [--debug]

--catalog-id, -c,

必須です。カタログのIDです。

--profile, -p,

任意です。使用するASK CLIプロファイルです。

--debug

任意です。標準エラー出力にデバッグメッセージを追加します。

delete model catalog version

特定のバージョンのカタログを削除するには、このコマンドを使用します。

delete-model-catalog-versionコマンドの形式：

$ ask api delete-model-catalog-version <-c|--catalog-id <カタログID>> <--catalog-version <カタログのバージョン>> [-p|--profile <プロファイル>] [--debug]

--catalog-id, -c,

必須です。カタログのIDです。

--catalog-version,

必須です。カタログのバージョンです。

--profile, -p,

任意です。使用するASK CLIプロファイルです。

--debug

任意です。標準エラー出力にデバッグメッセージを追加します。

apiコマンド

apiコマンドには複数のサブコマンドがあり、それぞれAlexaスキル管理API（SMAPI）の基本API操作に1:1でマッピングされます。これらのコマンドは、API入力を詳細に制御でき、生データを出力します。スキル、対話モデル、アカウントリンク情報の作成と更新、スキル認定プロセスの開始を行うサブコマンドがあります。

apiコマンドの形式：

$ ask api <サブコマンド>

サブコマンド

create-skillサブコマンド

skill.jsonファイルから開発者アカウントに関連付けられたスキルを作成します。スキルIDとスキルステータスが返されます。

create-skillコマンドの形式：

$ ask api create-skill [-f|--file <ファイル名>] [-p|--profile <プロファイル>] [--debug]

オプション：

--file, -f

必須です。.json形式のスキル情報ファイルへのパスです。絶対または相対パスで指定できます。

--profile, -p

任意です。スキル作成時に使用するプロファイルです。指定しない場合は、デフォルトのプロファイルが使用されます。

--debug

任意です。標準出力にデバッグメッセージを追加します。

get-skillサブコマンド

スキルIDを指定してスキルのスキーマをターミナルに出力します。以下のように>演算子を使用して、この出力結果をファイルにリダイレクトすることもできます。

$ ask api get-skill -s {skill_id} --stage development > skill.json

get-skillコマンドの形式：

$ ask api get-skill [-s|--skill-id <スキルID>] [-g|--stage <ステージ>] [-p|--profile <プロファイル>] [--debug]

オプション：

--skill-id, -s

必須です。取得するスキルのスキルIDです。amzn1.ask.skill.12345678-1234-1234-123456789123の形式で指定する必要があります。

--stage, -g

任意です。スキルのステージを表します。値として、developmentかliveのいずれかを使用します。デフォルトはdevelopmentです。

--profile, -p

任意です。スキルのスキーマを出力するプロファイルです。指定しない場合は、デフォルトのプロファイルが使用されます。

--debug

任意です。標準出力にデバッグメッセージを追加します。

get-skill-credentialsサブコマンド

指定したスキルIDと共にスキルのclientIdとclientSecretをコマンドウィンドウに出力します。以下の例のように>演算子を使用して、この出力結果をファイルにリダイレクトすることもできます。

$ ask api get-skill-credentials -s {スキルID} > credentials.json

get-skill-credentialsコマンドの形式：

$ ask api get-skill-credentials <-s|--skill-id <スキルID>> [-p|--profile <プロファイル>] [--debug]

オプション：

--skill-id, -s

必須です。スキルのスキルIDです。スキルIDは、`amzn1.ask.skill.12345678-1234-1234-123456789123`の形式で指定する必要があります。

--profile, -p

任意です。ASK CLIがスキルの認証情報を取得するプロファイルです。プロファイルを含めない場合、ASK CLIはデフォルトのプロファイルを使用します。

--debug

任意です。標準出力にデバッグメッセージを追加します。

delete-skillサブコマンド

スキルを削除します。一度削除したスキルを復元することはできません。

delete-skillコマンドの形式：

$ ask api delete-skill [-s|--skill-id <スキルID>] [-p|--profile <プロファイル>] [--debug]

オプション：

--skill-id, -s

必須です。削除するスキルのスキルIDです。amzn1.ask.skill.12345678-1234-1234-123456789123の形式で指定する必要があります。

--profile, -p

任意です。スキルを削除するプロファイルです。指定しない場合は、デフォルトのプロファイルが使用されます。このプロファイルにはスキルを削除できる権限が付与されている必要があります。

--debug

任意です。標準出力にデバッグメッセージを追加します。

update-skillサブコマンド

--fileオプションで指定したスキルのマニフェストを使って指定されたスキルを更新します。

update-skillコマンドの形式：

$ ask api update-skill [-s|--skill-id <スキルID>] [-f|--file <ファイル名>] [-g|--stage <ステージ>] [-p|--profile <プロファイル>] [--debug]

オプション：

--skill-id, -s

必須です。更新するスキルのスキルIDです。amzn1.ask.skill.12345678-1234-1234-123456789123の形式で指定する必要があります。

--file, -f

必須です。.json形式のスキル情報ファイルへのパスです。絶対または相対パスで指定できます。

--stage, -g

任意です。スキルのステージを表します。このコマンドでは、developmentのみがサポートされています。

--profile, -p

任意です。スキルのスキーマを作成または更新するプロファイルです。指定しない場合は、デフォルトのプロファイルが使用されます。

--debug

任意です。標準エラー出力にデバッグメッセージを追加します。

get-modelサブコマンド

スキルIDとロケールを指定してスキルの対話モデルを取得します。以下の例のように>演算子を使用して、この出力結果をファイルにリダイレクトすることもできます。

ask api get-model -s {skill_id} --stage development -l {locale} > model.json

get-modelコマンドの形式：

ask api get-model <-s|--skill-id <スキルID>> <-l|--locale <ロケール>> [-g|--stage <ステージ>] [--model-version <モデルのバージョン>] [-p|--profile <プロファイル>] [--debug]

オプション：

--skill-id, -s

必須です。ターゲットモデルのスキルIDです。amzn1.ask.skill.12345678-1234-1234-123456789123の形式で指定する必要があります。

--locale, -l

ASK_DEFAULT_DEVICE_LOCALE環境変数が設定されている場合は任意、それ以外は必須です。シミュレートするスキルのロケールです。有効な値はde-DE、en-AU、en-CA、en-GB、en-IN、en-US、es-ES、es-MX、es-US、fr-CA、fr-FR、hi-IN、it-IT、ja-JP、pt-BRです。指定しない場合、ロケールを入力するようプロンプトが出ます。

--stage, -g

任意です。スキルのステージを表します。値として、developmentかliveのいずれかを使用します。デフォルトはdevelopmentです。

--model-version

任意です。対話モデルのバージョンです。

--profile, -p

任意です。モデルスキーマを取得するプロファイルです。指定しない場合は、デフォルトのプロファイルが使用されます。

--debug

任意です。標準エラー出力にデバッグメッセージを追加します。

update-modelサブコマンド

スキルとロケールを指定して対話モデルを更新します。

update-modelコマンドの形式：

ask api update-model <-s|--skill-id <スキルID>> <-f|--file <ファイル名>> <-l|--locale <ロケール>> [-g|--stage <ステージ>] [-d|--description <説明>] [-p|--profile <プロファイル>] [--debug]

オプション：

--skill-id, -s

必須です。amzn1.ask.skill.12345678-1234-1234-123456789123の形式で指定する必要があります。

--file, -f

必須です。models/{locale}.jsonファイルへのパスです。絶対または相対パスで指定できます。

--locale, -l

ASK_DEFAULT_DEVICE_LOCALE環境変数が設定されている場合は任意、それ以外は必須です。シミュレートするスキルのロケールです。有効な値はde-DE、en-AU、en-CA、en-GB、en-IN、en-US、es-ES、es-MX、es-US、fr-CA、fr-FR、hi-IN、it-IT、ja-JP、pt-BRです。指定しない場合、ロケールを入力するようプロンプトが出ます。

--stage, -g

任意です。スキルのステージを表します。このコマンドでは、デフォルトのdevelopmentのみがサポートされます。

--description、-d

任意です。対話モデルのこのバージョンの説明です。

--profile, -p

任意です。スキルを更新するプロファイルです。指定しない場合は、デフォルトのプロファイルが使用されます。

--debug

任意です。標準エラー出力にデバッグメッセージを追加します。

head-modelサブコマンド

スキルIDとロケールを指定してスキルモデルのETagを取得できます。Etagはリソースのバージョンを表す一意の識別子です。モデルに対して操作を行う前にモデルが変更されていないことを検証できます。

head-modelコマンドの形式：

$ ask api head-model [-s|--skill-id <スキルID>] [-l|--locale <ロケール>] [-g|--stage <ステージ>] [-p|--profile <プロファイル>] [--debug]

オプション：

--skill-id, -s

必須です。ターゲットモデルのスキルIDです。amzn1.ask.skill.12345678-1234-1234-123456789123の形式で指定する必要があります。

--locale, -l

ASK_DEFAULT_DEVICE_LOCALE環境変数が設定されている場合は任意、それ以外は必須です。シミュレートするスキルのロケールです。有効な値はde-DE、en-AU、en-CA、en-GB、en-IN、en-US、es-ES、es-MX、es-US、fr-CA、fr-FR、hi-IN、it-IT、ja-JP、pt-BRです。指定しない場合、ロケールを入力するようプロンプトが出ます。

--stage, -g

任意です。スキルのステージを表します。値として、developmentかliveのいずれかを使用します。デフォルトはdevelopmentです。

--profile, -p

任意です。ETagを取得するプロファイルです。指定しない場合は、デフォルトのプロファイルが使用されます。

--debug

任意です。標準エラー出力にデバッグメッセージを追加します。

list-model-versionsサブコマンド

指定したスキルの対話モデルで、使用可能なバージョンの一覧を取得します。対話モデルのバージョンが取得できるのは、ビルドが正常に完了した後のみです。

list-model-versionsコマンドの形式：

ask api list-model-versions <-s|--skill-id <スキルID>> <-l|--locale <ロケール>> [-g|--stage <ステージ>] [--max-results <結果項目の最大数>] [--sort-direction <ソート順>] [--sort-field <ソートするフィールド>] [--next-token <次のトークン>] [-p|--profile <プロファイル>] [--debug]

オプション：

--skill-id, -s

必須です。リストしている対話モデルのバージョンを使用しているスキルの一意のIDです。

--locale, -l

必須です。リストする対話モデルのバージョンのロケールです。有効な値はde-DE、en-AU、en-CA、en-GB、en-IN、en-US、es-ES、es-MX、es-US、fr-CA、fr-FR、hi-IN、it-IT、ja-JP、pt-BRです。

--stage, -g

任意です。リストしている対話モデルのバージョンを持つスキルのステージです。有効な値は、development（大文字小文字の区別あり）のみです。

--max-results

任意です。リストするバージョンの最大数です。このオプションを含めない場合は、デフォルトの最大値は10です。50を超える値は指定しないでください。コマンドの出力に含まれる項目がこのオプションの値より少ない場合がありますが、この値より多くは含まれません。

--sort-direction

任意です。リストでのバージョンの並び順を設定します。有効な値はasc（昇順）とdesc（降順）です。

--sort-field

任意です。リストのソートに使用するフィールドを指定します。有効な値はversionのみです。

--next-token

任意です。結果が省略されている応答を受け取った後、さらに多くのバージョンを取得するには、このオプションを使用します。受け取った省略された応答からnextTokenの値に設定します。

--profile, -p

任意です。リストしている対話モデルのバージョンを持つスキルの所有者であるプロファイルです。このオプションを含めない場合は、ASK CLIはデフォルトのプロファイルを使用します。

--debug

任意です。標準エラー出力にデバッグメッセージを追加します。

get-skill-statusサブコマンド

スキルのステータスとその対話モデルを取得します。

get-skill-statusコマンドの形式：

$ ask api get-skill-status [-s|--skill-id <スキルID>] [-p|--profile <プロファイル>] [--debug]

--skill-id, -s

必須です。ステータスを確認しているスキルIDです。amzn1.ask.skill.12345678-1234-1234-123456789123の形式で指定する必要があります。

--profile, -p

任意です。スキルステータスを取得するプロファイルです。指定しない場合は、デフォルトのプロファイルが使用されます。

--debug

任意です。標準エラー出力にデバッグメッセージを追加します。

create-account-linkingサブコマンド

スキルIDを指定してアカウントリンクコンフィギュレーションの詳細情報を追加または更新します。

create-account-linkingを呼び出すと、以下の値を入力するようプロンプトが出ます。これらの値の詳細については、Authorization code grantを設定するとaccountLinkingRequestObjectを参照してください。

• 認証画面のURL
• クライアントID
• スコープ（カンマ区切りリスト）
• ドメイン（カンマ区切りリスト）
• Authorization Grant種別（矢印キーを使ってIMPLICIT、AUTH_CODEのいずれかを選択）
• AUTH_CODEを選択する場合は、次の追加の情報を入力します。
  • アクセストークンURL
  • クライアントシークレット
  • クライアント認証スキーム： HTTP_BASICまたはREQUEST_BODY_CREDENTIALS
  • デフォルトのトークン有効期間（秒）（任意）
  • 相互アクセストークンのURL（任意）
  • アプリ間アカウントリンクのリダイレクト先URL（カンマ区切りリスト）（任意）
• ユーザーがアカウントリンクなしでスキルを有効にすることを許可する（YESかNOを選択）

アカウントリンク情報は、機密保持のためコンピューターには保存されません。

create-account-linkingコマンドの形式：

$ ask api create-account-linking [-s|--skill-id <スキルID>] [-g|--stage <ステージ>] [-p|--profile <プロファイル>] [--debug]

オプション：

--skill-id, -s

必須です。アカウントリンク情報を追加するスキルのIDです。amzn1.ask.skill.12345678-1234-1234-123456789123の形式で指定する必要があります。

--stage, -g

任意です。スキルのステージを表します。このコマンドでは、デフォルトのdevelopmentのみがサポートされます。

--profile, -p

任意です。アカウントリンクを作成するプロファイルです。指定しない場合は、デフォルトのプロファイルが使用されます。

--debug

任意です。標準エラー出力にデバッグメッセージを追加します。

get-account-linkingサブコマンド

アカウントリンクコンフィギュレーションの詳細を取得して、コンソールに出力します。セキュリティを守るため、この情報はコンピューターに保存しないでください。

get-account-linkingコマンドの形式：

$ ask api get-account-linking [-s|--skill-id <スキルID>] [-g|--stage <ステージ>] [-p|--profile <プロファイル>] [--debug]

オプション：

--skill-id, -s

必須です。アカウントリンク情報を取得するスキルのIDです。amzn1.ask.skill.12345678-1234-1234-123456789123の形式で指定する必要があります。

--stage, -g

任意です。スキルのステージを表します。値として、developmentかliveのいずれかを使用します。デフォルトはdevelopmentです。

--profile, -p

任意です。アカウントリンクのコンフィギュレーションを取得するプロファイルです。指定しない場合は、デフォルトのプロファイルが使用されます。

--debug

任意です。標準エラー出力にデバッグメッセージを追加します。

delete-account-linkingサブコマンド

スキルとステージを指定してアカウントリンクコンフィギュレーションを削除します。

delete-account-linkingコマンドの形式：

$ ask api delete-account-linking [-s|--skill-id <スキルID>] [-g|--stage <ステージ>] [-p|--profile <プロファイル>] [--debug]

オプション：

--skill-id, -s

必須です。アカウントリンク情報を取得するスキルのIDです。amzn1.ask.skill.12345678-1234-1234-123456789123の形式で指定する必要があります。

--stage, -g

任意です。スキルのステージを表します。このコマンドでは、デフォルトのdevelopmentのみがサポートされます。

--profile, -p

任意です。アカウントリンクのコンフィギュレーションを取得するプロファイルです。指定しない場合は、デフォルトのプロファイルが使用されます。

--debug

任意です。標準エラー出力にデバッグメッセージを追加します。

create-beta-testサブコマンド

指定したスキルIDに基づいてスキルのベータテストを作成します。

create-beta-testコマンドの形式：

$ ask api create-beta-test <-s|--skill-id <スキルID>> [-f|--feedback-email <フィードバックEメール>] [-p|--profile <プロファイル>] [--debug]

オプション：

--skill-id, -s

必須です。ベータテストを作成するスキルIDです。amzn1.ask.skill.12345678-1234-1234-123456789123の形式で指定する必要があります。

--feedback-email, -f

任意です。テスターがフィードバックを提供するEメールアドレスです。

--profile, -p

任意です。スキルのベータテスト作成時に使用するプロファイルです。指定しない場合は、デフォルトのプロファイルが使用されます。

--debug

任意です。標準エラー出力にデバッグメッセージを追加します。

update-beta-testサブコマンド

既存のベータテストを更新します。

update-beta-testコマンドの形式：

$ ask api update-beta-test <-s|--skill-id <スキルID>> [-f|--feedback-email <フィードバックEメール>] [-p|--profile <プロファイル>] [--debug]

オプション

--skill-id, -s

必須です。ベータテストを作成するスキルIDです。amzn1.ask.skill.12345678-1234-1234-123456789123の形式で指定する必要があります。

--feedback-email, -f

任意です。テスターがフィードバックを提供するEメールアドレスです。

--profile, -p

任意です。スキルのベータテスト作成時に使用するプロファイルです。指定しない場合は、デフォルトのプロファイルが使用されます。

--debug

任意です。標準エラー出力にデバッグメッセージを追加します。

get-beta-testサブコマンド

既存のベータテストを返します。

get-beta-testコマンドの形式：

$ ask api get-beta-test <-s|--skill-id <スキルID>> [-p|--profile <プロファイル>] [--debug]

オプション

--skill-id, -s

必須です。ベータテストを作成するスキルIDです。amzn1.ask.skill.12345678-1234-1234-123456789123の形式で指定する必要があります。

--profile, -p

任意です。スキルのベータテストを取得するプロファイルです。指定しない場合は、デフォルトのプロファイルが使用されます。

--debug

任意です。標準エラー出力にデバッグメッセージを追加します。

start-beta-testサブコマンド

ベータテストを開始します。

start-beta-testコマンドの形式：

$ ask api start-beta-test <-s|--skill-id <スキルID>> [-p|--profile <プロファイル>] [--debug]

オプション

--skill-id, -s

必須です。ベータテストを開始するスキルIDです。amzn1.ask.skill.12345678-1234-1234-123456789123の形式で指定する必要があります。

--profile, -p

任意です。スキルのベータテストを開始するプロファイルです。指定しない場合は、デフォルトのプロファイルが使用されます。

--debug

任意です。標準エラー出力にデバッグメッセージを追加します。

end-beta-testサブコマンド

ベータテストを終了します。

end-beta-testコマンドの形式：

$ ask api end-beta-test <-s|--skill-id <スキルID>> [-p|--profile <プロファイル>] [--debug]

オプション

--skill-id, -s

必須です。ベータテストを終了するスキルIDです。amzn1.ask.skill.12345678-1234-1234-123456789123の形式で指定する必要があります。

--profile, -p

任意です。スキルのベータテストを終了するプロファイルです。指定しない場合は、デフォルトのプロファイルが使用されます。

--debug

任意です。標準エラー出力にデバッグメッセージを追加します。

list-beta-testersサブコマンド

ベータテストに関連付けられているすべてのテスターを一覧表示します。

list-beta-testersコマンドの形式：

$ ask api list-beta-testers <-s|--skill-id <スキルID>> [--max-results <値>] [--next-token <値>] [-p|--profile <プロファイル>] [--debug]

オプション

--skill-id, -s

必須です。ベータテストのスキルIDです。amzn1.ask.skill.12345678-1234-1234-123456789123の形式で指定する必要があります。

--profile, -p

任意です。スキルのベータテストを所有するプロファイルです。指定しない場合は、デフォルトのプロファイルが使用されます。

--max-results

任意です。返される結果の項目の最大数です。デフォルトでは、50に設定されます。入力する場合、valueは1～500（1と500も含む）の正の整数に設定します。500が上限です。

--next-token

任意です。値は、結果の項目に通しでページ番号をふるために使用されます。–next-tokenは–max-resultsパラメーターと共に使用し、ページに読み込む結果の数を指定します。最初のページを読み込むには、–next-tokenをnullに設定できます。このトークン値は24時間で期限が切れます。またこのトークンを取得するために使用したフィルターとスキルIDと結び付けられています。このトークン値は、他のパラメーターと共に使用された場合は無視されます。その場合は、新しい検索パラメーターによって得た結果の最初のページが返されます。

--profile, -p

任意です。スキルのベータテストを終了するプロファイルです。指定しない場合は、デフォルトのプロファイルが使用されます。

--debug

任意です。標準エラー出力にデバッグメッセージを追加します。

add-beta-testersサブコマンド

テスターを既存のベータテストに追加します。

add-beta-testersコマンドの形式：

$ ask api add-beta-testers <-s|--skill-id <スキルID>> <-f|--file <ファイル名>> [-p|--profile <プロファイル>] [--debug]

オプション

--skill-id, -s

必須です。ベータテストのスキルIDです。amzn1.ask.skill.12345678-1234-1234-123456789123の形式で指定する必要があります。

--file, -f

必須です。テスターのEメールアドレスファイル（.csv形式）へのパスです。絶対または相対パスで指定できます。テスターのEメールアドレスは.csvファイルの最初の列に任意のヘッダーと共に表示されます。

--profile, -p

任意です。テスターを追加するプロファイルです。指定しない場合は、デフォルトのプロファイルが使用されます。

--debug

任意です。標準エラー出力にデバッグメッセージを追加します。

remove-beta-testersサブコマンド

テスターを既存のベータテストから削除します。

remove-beta-testersコマンドの形式：

$ ask api remove-beta-testers <-s|--skill-id <スキルID>> <-f|--file <ファイル名>> [-p|--profile <プロファイル>] [--debug]

オプション

--skill-id, -s

必須です。ベータテストのスキルIDです。amzn1.ask.skill.12345678-1234-1234-123456789123の形式で指定する必要があります。

--file, -f

必須です。テスターのEメールアドレスファイル（.csv形式）へのパスです。絶対または相対パスで指定できます。テスターのEメールアドレスは.csvファイルの最初の列に任意のヘッダーと共に表示されます。

--profile, -p

任意です。テスターを削除するプロファイルです。指定しない場合は、デフォルトのプロファイルが使用されます。

--debug

任意です。標準エラー出力にデバッグメッセージを追加します。

send-reminder-to-beta-testersサブコマンド

指定したベータテストのテスターのリストにリマインダー通知のEメールを送信します。このEメールはテスターにベータテストについて知らせる招待状であり、承諾したテスターがベータテストに追加されます。

send-reminder-to-beta-testersコマンドの形式：

$ ask api send-reminder-to-beta-testers <-s|--skill-id <スキルID>> <-f|--file <ファイル名>> [-p|--profile <プロファイル>] [--debug]

オプション

--skill-id, -s

必須です。ベータテストのスキルIDです。amzn1.ask.skill.12345678-1234-1234-123456789123の形式で指定する必要があります。

--file, -f

必須です。テスターのEメールアドレスファイル（.csv形式）へのパスです。絶対または相対パスで指定できます。テスターのEメールアドレスは.csvファイルの最初の列に任意のヘッダーと共に表示されます。

--profile, -p

任意です。テスターにリマインダーを送信するプロファイルです。指定しない場合は、デフォルトのプロファイルが使用されます。

--debug

任意です。標準エラー出力にデバッグメッセージを追加します。

request-feedback-from-beta-testersサブコマンド

ベータテストのテスターのリストにフィードバックをリクエストします。

request-feedback-from-beta-testersコマンドの形式：

$ ask api send-reminder-to-beta-testers <-s|--skill-id <スキルID>> <-f|--file <ファイル名>> [-p|--profile <プロファイル>] [--debug]

オプション

--skill-id, -s

必須です。ベータテストのスキルIDです。amzn1.ask.skill.12345678-1234-1234-123456789123の形式で指定する必要があります。

--file, -f

必須です。テスターのEメールアドレスファイル（.csv形式）へのパスです。絶対または相対パスで指定できます。テスターのEメールアドレスは.csvファイルの最初の列に任意のヘッダーと共に表示されます。

--profile, -p

任意です。テスターにリマインダーを送信するプロファイルです。指定しない場合は、デフォルトのプロファイルが使用されます。

--debug

任意です。標準エラー出力にデバッグメッセージを追加します。

validate-skillサブコマンド

スキルの認定を申請する前や開発中の見直しで随時、スキルを検証するテストを実行します。サポートされるテストについては、スキルの検証の「サポートされる検証」を参照してください。

validate-skillサブコマンドを使って、スキルが公開中のスキルをすぐに更新できるかどうかを確認することもできます。

validate-skillコマンドは、validation-idの値を返します。この値は、get-validationと併せて使用すると、検証結果を照会できます。上位のvalidateコマンドは、検証と結果取得を1つにまとめて行います。

validate-skillコマンドの形式：

$ ask api validate-skill [-s|--skill-id <スキルID>] [-l|--locales <ロケール>] [-g|--stage <ステージ>] [-p|--profile <プロファイル>] [--debug]

オプション：

--skill-id, -s

必須です。検証するスキルのスキルIDです。amzn1.ask.skill.12345678-1234-1234-123456789123の形式で指定する必要があります。

--locales, -l

任意です。ロケールのリストです。サポートしている値は、de-DE、en-AU、en-CA、en-GB、en-IN、en-US、es-ES、es-MX、es-US、fr-CA、fr-FR、hi-IN、it-IT、ja-JP、pt-BRです。ASK_DEFAULT_DEVICE_LOCALE環境変数が設定されている場合、このオプションは不要です。このオプションが指定されておらず、かつASK_DEFAULT_DEVICE_LOCALEが設定されていない場合、コマンドを実行すると環境変数またはデバイスロケールを指定するよう求めるエラーメッセージが返されます。

--stage, -g

任意です。スキルのステージを表します。値として、developmentかliveのいずれかを使用します。デフォルトはdevelopmentです。

--profile, -p

任意です。アカウントリンクのコンフィギュレーションを取得するプロファイルです。指定しない場合は、デフォルトのプロファイルが使用されます。

--debug

任意です。標準エラー出力にデバッグメッセージを追加します。

get-validationサブコマンド

validate-skillサブコマンドで生成された検証結果を返します。

上位のvalidateコマンドは、検証と結果取得を1つにまとめて行います。

get-validationコマンドの形式：

$ ask api get-validation <-i|--validation-id <検証ID>> <-s|--skillId <スキルID>> [-p|--profile <プロファイル>] [--debug]

オプション：

--validation-id, -i

必須です。スキル検証リクエストの検証IDです。これは、validate-skillサブコマンドの実行により取得されます。

--skill-id, -s

必須です。検証するスキルのスキルIDです。amzn1.ask.skill.12345678-1234-1234-123456789123の形式で指定する必要があります。

--profile, -p

任意です。アカウントリンクのコンフィギュレーションを取得するプロファイルです。指定しない場合は、デフォルトのプロファイルが使用されます。

--debug

任意です。標準エラー出力にデバッグメッセージを追加します。

submitサブコマンド

スキルの認定と公開を申請できます。スキルの認定と公開を1つのコマンドで申請することも、認定のみを申請することもできます。認定されたスキルの公開をpublish-skillで別途申請すると、リリース日時を指定できます。

submitコマンドの形式：

$ ask api submit <-s|--skill-id <スキルID>> [--publication-method <公開方法>] [-p|--profile <プロファイル>] [--debug]

オプション：

--skill-id, -s

必須です。ターゲットスキルのスキルIDです。amzn1.ask.skill.12345678-1234-1234-123456789123の形式で指定する必要があります。

--publication-method

任意です。次のいずれかになります。 AUTO_PUBLISHING、MANUAL_PUBLISHING。指定しない場合は、デフォルトのAUTO_PUBLISHINGが使用されます。AUTO_PUBLISHINGでは、認定と公開が同時に行われるため、Alexaスキルストアへの公開日を指定することはできません。AUTO_PUBLISHINGを使用して、公開中スキルを即時に更新することもできます。MANUAL_PUBLISHINGの場合は、publish-skillコマンドを使用してリリース日を設定できます。

--profile, -p

任意です。スキル作成時に使用するプロファイルです。指定しない場合は、デフォルトのプロファイルが使用されます。

--debug

任意です。標準エラー出力にデバッグメッセージを追加します。

例

認定と公開が同時に行われます。Alexaスキルストアへの公開日を設定することはできません。

$ ask api submit --skill-id <スキルID> --publication-method AUTO_PUBLISHING

認定のみを申請します。認定が完了した後、ask api publish-skillを使用して公開することができます。

ask api submit --skill-id <スキルID> --publication-method MANUAL_PUBLISHING

publish-skillサブコマンド

スキルをAlexaスキルストアに公開する日を設定できます。スキルを申請するときに、認定と公開のプロセスを別々に行うことを選択できます。

publish-skillコマンドの形式：

$ ask api publish-skill <-s|--skill-id <スキルID>> <-a|--accept-language <言語コード>> [--publishes-at-date <公開日>] [-p|--profile <プロファイル>] [--debug]

オプション：

--skill-id, -s

必須です。ターゲットスキルのスキルIDです。amzn1.ask.skill.12345678-1234-1234-123456789123の形式で指定する必要があります。

--accept-language

必須です。ローカライズされた応答を指定の言語で受け取ります。有効な値はen-USとja-JPです。

--publish-at-date

任意です。Alexaスキルストアにスキルを公開する日付と時刻を、UTC形式で指定します。例：'2019-12-22T20:54:02Z'日付と時刻を入力しない場合は、公開プロセスがすぐに開始されます。

--profile, -p

任意です。スキル作成時に使用するプロファイルです。指定しない場合は、デフォルトのプロファイルが使用されます。

--debug

任意です。標準エラー出力にデバッグメッセージを追加します。

例

認定されたスキルの公開日を設定します。応答の言語コードには、en-USを指定しています。

$ask api publish-skill -s <スキルID> --publishes-at-date 2019-12-22T20:54:02Z --accept-language en-US

認定されたスキルの公開プロセスをすぐに開始します。応答の言語コードには、en-USを指定しています。

$ ask api publish-skill -s <スキルID> --accept-language en-US

withdrawサブコマンド

認定プロセスからスキルを取り消すことができます。取り消しには、理由を入力するよう求められます。選択肢は以下のとおりです。

• これはテスト用のスキルで、認定対象ではありません
• スキルに機能を追加したいと考えています
• スキルに問題が見つかりました
• 認定申請の結果をまだ受け取っていません
• スキルをすぐに公開する予定がありません
• その他

その他を選択すると、取り消し理由の詳細を入力できます。

withdrawコマンドの形式：

$ ask api withdraw [-s|--skill-id <スキルID>] [-p|--profile <プロファイル>] [--debug]

オプション：

--skill-id, -s

必須です。ターゲットスキルのスキルIDです。amzn1.ask.skill.12345678-1234-1234-123456789123の形式で指定する必要があります。

--profile, -p

任意です。スキルを取り消すプロファイルです。指定しない場合は、デフォルトのプロファイルが使用されます。

--debug

任意です。標準エラー出力にデバッグメッセージを追加します。

list-certificationsサブコマンド

スキルのすべての完了済み、または進行中の認定審査のリストを取得します。

list-certificationsコマンドの形式：

ask api list-certifications <-s|--skill-id <スキルID>> [--max-results <結果項目の最大数>] [--next-token <次のトークン>] [-p|--profile <プロファイル>] [--debug]

オプション：

-s, --skill-id

必須です。リストする認定を持つスキルの一意のIDです。

--max-results

任意です。応答で返す認定の最大数です。このオプションを含めない場合は、デフォルトの最大値は50です。50を超える値は指定しないでください。応答に含まれる項目がこのオプションの値より少ない場合がありますが、この値より多くは含まれません。

--next-token

任意です。結果が省略されている応答を受け取った後、さらに多くの認定を取得するには、このオプションを使用します。受け取った省略された応答からnextTokenの値に設定します。

-p, --profile

任意です。リストしている認定を持つスキルの所有者であるプロファイルです。このオプションを含めない場合は、ASK CLIはデフォルトのプロファイルを使用します。

--debug

任意です。標準エラー出力にデバッグメッセージを追加します。

例：

以下の例では、読みやすくするために値の中に改行を入れています。実際の出力では値の中に改行は含まれません。

ask api list-certifications --skill-id amzn1.ask.skill.example9-3991-41e5-bb00-example88163 \
                            --max-results 4

{
  "_links": {
    "next": {
      "href": "/v1/skills/amzn1.ask.skill.example9-3991-41e5-bb00-example88163/certifications\
               ?maxResults=4\
               &nextToken=ebFDQ5bxOYjkuXS0EXAMPLE_TOKEN"
    },
    "self": {
      "href": "/v1/skills/amzn1.ask.skill.example9-3991-41e5-bb00-example88163/certifications\
               ?maxResults=4"
    }
  },
  "isTruncated": true,
  "items": [
    {
      "id": "nJhXMnau",
      "reviewTrackingInfo": {
        "estimatedCompletionTimestamp": "",
        "lastUpdated": "2019-02-01T01:01:34.627Z"
      },
      "skillSubmissionTimestamp": "2019-01-18T01:03:29.526Z",
      "status": "IN_PROGRESS"
    },
    {
      "id": "0yGjdNhD",
      "reviewTrackingInfo": {
        "actualCompletionTimestamp": "2019-01-21T17:17:09.462Z",
        "estimatedCompletionTimestamp": "2019-01-21T18:03:09.145Z",
        "lastUpdated": "2019-01-21T17:17:09.462Z"
      },
      "skillSubmissionTimestamp": "2019-01-16T18:03:09.145Z",
      "status": "SUCCEEDED"
    },
    {
      "id": "QJGBDdHj",
      "reviewTrackingInfo": {
        "actualCompletionTimestamp": "2019-01-16T17:50:50.960Z",
        "estimatedCompletionTimestamp": "2019-01-21T17:27:25.889Z",
        "lastUpdated": "2019-01-16T17:50:50.960Z"
      },
      "skillSubmissionTimestamp": "2019-01-16T17:27:25.889Z",
      "status": "CANCELLED"
    },
    {
      "id": "YeQ37Nws",
      "reviewTrackingInfo": {
        "actualCompletionTimestamp": "2019-01-16T17:22:42.188Z",
        "estimatedCompletionTimestamp": "2019-01-23T03:31:40.229Z",
        "lastUpdated": "2019-01-16T17:22:42.188Z"
      },
      "skillSubmissionTimestamp": "2019-01-09T03:31:40.229Z",
      "status": "CANCELLED"
    }
  ],
  "nextToken": "ebFDQ5bxOYjkuXS0EXAMPLE_TOKEN",
  "totalCount": 13
}

get-certificationサブコマンド

スキルの特定の認定審査についての詳細を取得します。このコマンドを使用するには、list-certificationsコマンドの出力から得られる認定IDが必要です。

このコマンドを使用して進行中の認定審査についての詳細を取得すると、必ず出力が返されます。ただし、以前の認定についての詳細を取得すると出力が返されない場合があります。以前の認定についての詳細が取得できない場合は、エラーが返されます（エラーコード： 404）。

get-certificationコマンドの形式：

ask api get-certification <-s|--skill-id <スキルID>> <-c|--certification-id <認定ID>> [--accept-language <言語コード>] [-p|--profile <プロファイル>] [--debug]

オプション：

-s, --skill-id

必須です。取得する認定を持つスキルの一意のIDです。

-c, --certification-id

必須です。取得する認定審査の一意のIDです。直近の認定審査を取得するには、~mostRecentの値を使用します。直近でない認定審査を取得するには、スキルの認定審査のリストを取得して、取得したい認定審査のIDを使用します。

--accept-language

任意です。このオプションを使用して、ローカライズされた応答を受け取ることができます。有効な値はen-USとja-JPです。

-p, --profile

任意です。取得する認定を持つスキルの所有者であるプロファイルです。このオプションを含めない場合は、ASK CLIはデフォルトのプロファイルを使用します。

--debug

任意です。標準エラー出力にデバッグメッセージを追加します。

例：

以下の例では、読みやすくするために値の中に改行を入れています。実際の出力では値の中に改行は含まれません。

ask api get-certification -s amzn1.ask.skill.example9-3991-41e5-bb00-example88163 -c 0yGjdNhD

{
  "id": "0yGjdNhD",
  "result": {
    "distributionInfo": {
      "publicationFailures": [
        {
          "countries": [
            "India"
          ],
          "reason": "スキルを公開する国および地域によっては、\
           不適切あるいはコンプライアンス違反であるとみなされる基準が、より厳格である場合があります。\
           Amazonは、公開対象の国の法律、文化的規範、\
           文化的感受性を侵す可能性のあるあらゆるスキルを、いかなる国においても\
           制限する場合があります。"
        }
      ],
      "publishedCountries": [
        "United States"
      ]
    }
  },
  "reviewTrackingInfo": {
    "actualCompletionTimestamp": "2019-01-21T17:17:09.462Z",
    "estimatedCompletionTimestamp": "2019-01-21T18:03:09.145Z",
    "estimationUpdates": [],
    "lastUpdated": "2019-01-21T17:17:09.462Z"
  },
  "skillSubmissionTimestamp": "2019-01-16T18:03:09.145Z",
  "status": "SUCCEEDED"
}

get-skill-publicationsサブコマンド

認定済みのスキルの公開に関する最新情報を取得します。応答では、ステータスと公開予定日が返されます。返されるステータス値は、次のとおりです。 IN_PROGRESS, SUCCEEDED, FAILED, CANCELLED, SCHEDULED.

get-skill-publicationsコマンドの形式：

$ ask api get-skill-publications <-s|--skill-id <スキルID>> <-a|--accept-language <言語コード>> [-p|--profile <プロファイル>] [--debug]

オプション：

-s, --skill-id

必須です。公開に関する詳細情報を取得する対象スキルの一意のIDです。

--accept-language

必須です。ローカライズされた応答を指定の言語で受け取ります。有効な値はen-USとja-JPです。

-p, --profile

任意です。公開情報を持つスキルの所有者のプロファイルです。このオプションを含めない場合は、ASK CLIはデフォルトのプロファイルを使用します。

--debug

任意です。標準エラー出力にデバッグメッセージを追加します。

例

コマンド：

$ ask api get-skill-publications -s amzn1.ask.skill.b2345e73-c482-4e5d-a259-f8bf2bb02137 -a en-US

応答：

{
  "publishesAtDate": "2019-12-31T21:30:02Z",
  "status": "SCHEDULED"
}

list-vendorsサブコマンド

開発者アカウントに関連付けられたベンダーIDを取得し、ベンダーIDに対して開発者に関連付けられたロールを指定します。

list-vendorsコマンドの形式：

$ ask api list-vendors [-p|--profile <プロファイル>] [--debug]

サンプル出力：

[
  {
    "id": "MYVENDORID1234567",
    "name": "Amazon",
    "roles": [
      "ROLE_ADMINISTRATOR"
    ]
  }
]

オプション：

--profile, -p

任意です。デフォルト以外のプロファイルを使うには、プロファイル名を指定します。

--debug

任意です。標準エラー出力にデバッグメッセージを追加します。

list-skillsサブコマンド

現在のプロファイルのスキルリストを表示します。リストはJSON形式で返されます。

list-skillsコマンドの形式：

$ ask api list-skills [-p|--profile <プロファイル>] [--debug]

サンプル出力：

{
    "skills": [
        {
            "lastUpdated": "2017-07-11T19:29:57.120Z",
            "nameByLocale": {
                "ja-JP": "example"
            },
            "stage": "development",
            "apis": [
                "custom",
                "householdList"
            ],
            "publicationStatus": "DEVELOPMENT",
            "skillId": "amzn1.ask.skill.6acdbdf8-8420-440e-823e-aaaaaaaabbbb"
        },
        {
            "lastUpdated": "2017-07-05T21:11:16.947Z",
            "asin": "ACIS-QA-xxxxxxx",
            "nameByLocale": {
                "ja-JP": "example1"
            },
            "stage": "live",
            "apis": [
                "video"
            ],
            "publicationStatus": "PUBLISHED",
            "skillId": "amzn1.ask.skill.81ded88f-0d0a-4612-aaaaaaaabbbb"
        }
    ]
}

指定したベンダーのスキルの完全なリストが返されます。これらのスキルのいずれかが無効または破損している場合、そのスキルにはnameByLocaleの値ではなく、skillId、stage、lastUpdated、publicationStatusの値が返されます。

オプション：

--profile, -p

任意です。デフォルト以外のプロファイルを使うには、プロファイル名を指定します。

--debug

任意です。標準エラー出力にデバッグメッセージを追加します。

add-private-distribution-accountサブコマンド

スキルを指定して非公開の配信リストにアカウントを追加します。

add-private-distribution-accountコマンドの形式：

ask api add-private-distribution-account <-s|--skill-id <スキルID>> --stage live <--account-id <id>>

オプション：

--skill-id, -s

必須です。ターゲットスキルのIDです。

--stage

任意です。スキルのステージを表します。このコマンドでは、デフォルトのliveのみがサポートされます。

--account-id

必須です。Alexa for Business企業のアカウントARNです（arn:aws:iam::123456789012:rootなど）。

delete-private-distribution-accountサブコマンド

スキルを指定して非公開の配信リストからアカウントを削除します。

delete-private-distribution-accountコマンドの形式：

ask api delete-private-distribution-account <-s|--skill-id <スキルID>> --stage live <--account-id <id>>

オプション：

--skill-id, -s

必須です。ターゲットスキルのIDです。

--stage

任意です。スキルのステージを表します。このコマンドでは、デフォルトのliveのみがサポートされます。

--account-id

必須です。Alexa for Business企業のアカウントARNです（arn:aws:iam::123456789012:rootなど）。

list-private-distribution-accountsサブコマンド

スキルを指定して非公開の配信リストにあるアカウントのリストを表示します。

list-private-distribution-accountsコマンドの形式：

$ ask api list-private-distribution-accounts <-s|--skill-id <スキルID> --stage live

オプション：

--skill-id, -s

必須です。ターゲットスキルのIDです。

--stage

任意です。スキルのステージを表します。このコマンドでは、デフォルトのliveのみがサポートされます。

enable-skillサブコマンド

skillIdとstageを指定して有効にします。

$ ask api enable-skill <-s|--skill-id <スキルID> [-g|--stage <ステージ>]

オプション：

--skill-id, -s

必須です。ターゲットスキルのIDです。

--stage

任意です。スキルのステージを表します。このコマンドでは、デフォルトのdevelopmentのみがサポートされます。

disable-skillサブコマンド

skillIdとstageを指定して無効にします。

$ ask api disable-skill <-s|--skill-id <スキルID> [-g|--stage <ステージ>]

オプション：

--skill-id, -s

必須です。ターゲットスキルのIDです。

--stage

任意です。スキルのステージを表します。このコマンドでは、デフォルトのdevelopmentのみがサポートされます。

get-skill-enablementサブコマンド

指定されたskillIdとstageの有効かどうかを確認します。

$ ask api get-skill-enablement <-s|--skill-id <スキルID> [-g|--stage <ステージ>]

オプション：

--skill-id, -s

必須です。ターゲットスキルのIDです。

--stage

任意です。スキルのステージを表します。このコマンドでは、デフォルトのdevelopmentのみがサポートされます。

invoke-skillサブコマンド

指定したスキルを呼び出します。このコマンドを使えるようにするには、まずAlexaアプリからスキルを有効にする必要があります。

invoke-skillコマンドの形式：

$ ask api invoke-skill [-f|--file <ファイル>] [-s|--skill-id <スキルID>] [-j|--json <json>] [-e|--endpoint-region <エンドポイントのリージョン>] [-g|--stage <ステージ>] [-p|--profile <プロファイル>] [--debug]

オプション：

--skill-id, -s

必須です。amzn1.ask.skill.12345678-1234-1234-123456789123の形式で指定する必要があります。

--file, -f

<-j, --json>を指定する場合は使用しません。それ以外の場合は必須です。スキル呼び出しリクエストファイルへのパスです。リクエストの形式はこちらに定義されています。絶対または相対パスで指定できます。

--json, -j

<-f, --file>を指定する場合は使用しません。それ以外の場合は必須です。JSON文字列です。

--endpoint-region, -e

必須です。スキルで使用するエンドポイントのリージョンを指定します。「NA」、「EU」、「FE」、「default」のいずれかです。「default」のリージョンは、スキルマニフェストのapis.custom.endpointによって指定されるグローバルデフォルトエンドポイントによって決まります。

--stage, -g

任意です。スキルのステージを表します。値として、developmentかliveのいずれかを使用します。デフォルトはdevelopmentです。

--profile, -p

任意です。デフォルト以外のプロファイルを使うには、プロファイル名を指定します。

--debug

任意です。標準エラー出力にデバッグメッセージを追加します。

simulate-skillサブコマンド

指定したスキルをシミュレートします。このコマンドを使えるようにするには、まずAlexaアプリからスキルを有効にする必要があります。

simulate-skillコマンドの形式：

$ ask api simulate-skill [-f|--file <ファイル>] [-t|--text <テキスト>] [-l|--locale <ロケール>] [-s|--skill-id <スキルID>] [-g|--stage <ステージ>] [--force-new-session] [-p|--profile <プロファイル>] [--debug]

オプション：

--file, -f

<-t, --text>を指定する場合は使用しません。それ以外の場合は必須です。シミュレーションに使う発話テキストコンテンツファイルへのパスです。絶対または相対パスで指定できます。

--text, -t

<-f, --file>を指定する場合は使用しません。それ以外の場合は必須です。スキルのシミュレートに使用する発話テキストを入力します。

--locale, -l

ASK_DEFAULT_DEVICE_LOCALE環境変数が設定されている場合は任意、それ以外は必須です。シミュレートするスキルのロケールです。有効な値は、en-US、en-GB、de-DEのいずれかです。指定しない場合、ロケールを入力するようプロンプトが出ます。

--skill-id, -s

必須です。amzn1.ask.skill.12345678-1234-1234-123456789123の形式で指定する必要があります。

--stage, -g

任意です。スキルのステージを表します。値として、developmentかliveのいずれかを使用します。デフォルトはdevelopmentです。

--force-new-session

任意です。新しいダイアログセッションを開始してからシミュレーションを実行します。

--profile, -p

任意です。デフォルト以外のプロファイルを使うには、プロファイル名を指定します。

--debug

任意です。標準エラー出力にデバッグメッセージを追加します。

get-simulationサブコマンド

指定したシミュレーションIDのシミュレーション結果を取得します。simulate-skillコマンドを実行するたびに、シミュレーションIDが生成されます。

get-simulationコマンドの形式：

$ ask api get-simulation [-i|--simulation-id <シミュレーションID>] [-s|--skill-id <スキルID>] [-g|--stage <ステージ>] [-p|--profile <プロファイル>] [--debug]

オプション：

--simulation-id, -i

必須です。UUIDの形式b8e4ea04-7df3-11e7-bb31-be2e44b06b34で指定する必要があります。

--skill-id, -s

必須です。amzn1.ask.skill.12345678-1234-1234-123456789123の形式で指定する必要があります。

--profile, -p

任意です。デフォルト以外のプロファイルを使うには、プロファイル名を指定します。

--stage, -g

任意です。スキルのステージを表します。値として、developmentかliveのいずれかを使用します。デフォルトはdevelopmentです。

--debug

任意です。標準エラー出力にデバッグメッセージを追加します。

intent-requests-historyサブコマンド

ユーザーの音声データやインテントリクエストの詳細を集めて匿名化した記録を、スキルごとにスキル開発者に提供します。その日のそのロケールのデータを使用できるようにするためには、1つのスキルに対し、ロケールごとに1日最低10人のユニークユーザーを必要とします。しきい値に達したロケールと達しなかったロケールがある場合、しきい値に達したロケールのデータのみが返されます。

$ ask api intent-requests-history <-s|--skill-id <スキルID>> [--filters <値>] [--max-results <値>] [--sort-direction <値>] [--sort-field <値>] [--next-token <値>]

フィルターを適用せず、かつデフォルトを変更せずにスキルのインテントリクエスト履歴を取得するには、以下の例のとおり、他のパラメーターを指定せずにスキルIDを参照します。

$ ask api intent-requests-history --skill-id amzn1.ask.skill.12345678-1234-1234-123456789123

オプション

--skill-id, -s

必須です。amzn1.ask.skill.12345678-1234-1234-123456789123の形式で指定する必要があります。

--filters

任意です。フィルターは以下の例の形式になります。
スキルのインテントリクエスト履歴を1ページに最大100件表示するには、以下のように指定します。
$ ask api intent-requests-history --skill-id amzn1.ask.skill.12345678-1234-1234-123456789123 --max-results 100

en-USとen-GBのロケールのみが含まれるようフィルタリングされたインテントリクエスト履歴を取得するには、以下のように指定します。

$ ask api intent-requests-history --skill-id amzn1.ask.skill.12345678-1234-1234-123456789123 --filters "Name=locale, Values=en-US,en-GB"

複数のフィルターを使用してスキルのインテントリクエスト履歴を取得するには、以下のように指定します。

$ ask api intent-requests-history --skill-id amzn1.ask.skill.12345678-1234-1234-123456789123 --filters "Name=locale, Values=en-US,en-GB; Name=intent.name, Values=PlayMusic,StopMusic"

省略した構文は以下のとおりです。

Name=string,Values=string,string ...

以下のパラメーターでフィルタリングできます。

dialogAct.name - dialogAct.nameフィルターは、「dialogAct.name」の値がこのフィルターの値のいずれかに一致する場合、その結果を表示します。このフィルターは複数の値を持つことができます。このフィルターは大文字と小文字を区別しません。これらの値は、マルチターンの会話のコンテキストで発生します。Dialogディレクティブとマルチターンの会話の詳細については、<a href="https://developer.amazon.com/ja-JP/docs/alexa/custom-skills/dialog-interface-reference.html">こちら</a>を参照してください。locale - localeフィルターは、localeの値がこのフィルターの値のいずれかに一致する場合、その結果を表示します。このフィルターは複数の値を持つことができます。このフィルターは大文字と小文字を区別しません。（en-US | en-GB | en-IN | en-CA | en-AU | de-DE | fr-FR | ja-JP）

intent.confidence.bin - intent.confidence.binフィルターは、intent.confidence.binの値がこのフィルターの値のいずれかに一致する場合、その結果を表示します。実行時にはスキルは信頼度LOWのインテントを受け取らないことに注意してください。このフィルターは複数の値を持つことができます。このフィルターは大文字と小文字を区別しません。（HIGH | MEDIUM | LOW）

stage - stageフィルターは、stageの値がこのフィルターの値のいずれかに一致する場合、その結果を表示します。このフィルターは複数の値を持つことができます。このフィルターは大文字と小文字を区別しません。（live | development）

publicationStatus - publicationStatusフィルターは、publicationStatusの値がこのフィルターの値のいずれかに一致する場合、その結果を表示します。このフィルターは複数の値を持つことができます。このフィルターは大文字と小文字を区別しません。（CERTIFICATION | DEVELOPMENT）

utteranceText - utteranceTextフィルターは、utteranceTextの値をフルテキスト検索した結果を表示します。このフィルターは複数の値を持つことができます。このフィルターは大文字と小文字を区別しません。（すべての文字列）

intent.name - intent.nameフィルターは、intent.nameの値がこのフィルターの値のいずれかに一致する場合、その結果を表示します。このフィルターは複数の値を持つことができます。このフィルターは大文字と小文字を区別しません。（すべての文字列）

intent.slot.name - intent.slot.nameフィルターは、intent.slots.slot.nameの値がこのフィルターの値の1つ以上に一致する場合、その結果を表示します。このフィルターは複数の値を持つことができます。このフィルターは大文字と小文字を区別しません。（すべての文字列）

interactionType - interactionTypeフィルターは、interactionTypeの値がこのフィルターの値に一致する場合、その結果を表示します。このフィルターは複数の値を持つことができます。このフィルターは大文字と小文字を区別しません。（ONE_SHOT | MODAL）

--max-results

任意です。返される結果の項目の最大数です。デフォルトでは、この数は10に設定されています。maxResultsの上限は250です。1から250までの正の整数です（1と250も含む）。

--sort-direction

任意です。適用されるソートの順序です。デフォルトでは、ソートの順序は降順です。このフィールドは大文字と小文字を区別しません。（asc | desc）

--sort-field

任意です。結果の項目は、このアトリビュートで指定したフィールドの値に従ってソートされます。ソートの順序は、--sort-directionという別のアトリビュートで定義します。このフィールドは大文字と小文字を区別しません。（dialogAct.name | locale | intent.confidence.bin | stage | intent.name | utteranceText | interactionType | publicationStatus）

--next-token

任意です。nextTokenは、結果の項目に連続的にページ番号をふるために使用されます。nextTokenはmaxResultsパラメーターと共に使用し、ページに読み込む結果の数を指定します。最初のページを読み込むには、このプロパティをnullに設定します。有効期間は60分です。このトークンは、このトークンを取得するために使用したフィルターとスキルIDのセットに結びついているため、他のパラメーターが使用された場合は無視されます。その場合は、新しい検索パラメーターによって得た結果の最初のページが返されます。

list-catalogsサブコマンド

$ ask api list-catalogs [--max-results <結果項目の最大数>] [--next-token <次のトークン>] [-p|--profile <プロファイル>] [--debug]

選択したプロファイルのvendor-idを指定して、すべてのカタログのリストを表示します。

オプション

--max-results

任意です。返される結果の項目の最大数です。

--next-token

任意です。「nextToken」は、結果の項目に連続的にページ番号をふるために使用されます。最初のページを読み込むには、このプロパティをnullに設定します。

--profile, -p

任意です。更新または作成するプロファイルです。指定したプロファイルが既に存在する場合、CLIはユーザーの入力した内容でプロファイルを上書きします。指定しない場合、CLIは対話型のプロンプトでユーザーに新しいプロファイルの作成か、既存のプロファイルの更新かをたずねます。

--debug

任意です。標準エラー出力にデバッグメッセージを追加します。

get-catalogサブコマンド

$ ask api get-catalog <-c|--catalog-id <カタログID>> [-p|--profile <プロファイル>] [--debug]

catalog-idを指定してカタログの情報を取得します。

オプション

-c, --catalog-id

必須です。リクエストされたカタログのカタログIDです。

--profile, -p

任意です。更新または作成するプロファイルです。指定したプロファイルが既に存在する場合、CLIはユーザーの入力した内容でプロファイルを上書きします。指定しない場合、CLIは対話型のプロンプトでユーザーに新しいプロファイルの作成か、既存のプロファイルの更新かをたずねます。

--debug

任意です。標準エラー出力にデバッグメッセージを追加します。

create-catalogサブコマンド

$ ask api create-catalog <--catalog-type <カタログの種類>> <--catalog-title <カタログのタイトル>> <--catalog-usage <カタログの用途>> [-p|--profile <プロファイル>] [--debug]

catalog-type、catalog-title、catalog-usageに基づいて新しいカタログを作成します

オプション

--catalog-type

必須です。新しいカタログの種類です。次のいずれかを選択します。 「AMAZON.MusicAlbum」、「AMAZON.MusicGroup」、「AMAZON.Genre」、「AMAZON.MusicPlaylist」、「AMAZON.MusicRecording」、「AMAZON.BroadcastChannel」。catalog-type値はcatalog-usage値と一致する必要があります。このため、「AMAZON.MusicAlbum」をcatalog-typeとして選択する場合は、「AlexaMusic.Catalog.MusicAlbum」をcatalog-usage値として選択する必要があります。

--catalog-title

必須です。新しいカタログのタイトルです。

--catalog-usage

必須です。新しいカタログの用途です。次のいずれかを選択します。 「AlexaMusic.Catalog.MusicAlbum」、「AlexaMusic.Catalog.MusicGroup」、「AlexaMusic.Catalog.Genre」、「AlexaMusic.Catalog.MusicPlaylist」、「AlexaMusic.Catalog.MusicRecording」、「AlexaMusic.Catalog.BroadcastChannel」。選択した値はcatalog-type値に対応する必要があります。

--profile, -p

任意です。更新または作成するプロファイルです。指定したプロファイルが既に存在する場合、CLIはユーザーの入力した内容でプロファイルを上書きします。指定しない場合、CLIは対話型のプロンプトでユーザーに新しいプロファイルの作成か、既存のプロファイルの更新かをたずねます。

--debug

任意です。標準エラー出力にデバッグメッセージを追加します。

list-catalog-uploadsサブコマンド

$ ask api list-catalog-uploads <-c|--catalog-id <カタログID>> [--max-results <結果項目の最大数>] [--next-token <次のトークン>] [-p|--profile <プロファイル>] [--debug]

指定したカタログのすべてのアップロード情報のリストを表示します。

オプション

-c, --catalog-id

必須です。アップロードをリストするカタログのIDです。

--max-results

任意です。返される結果の項目の最大数です。

--next-token

任意です。「nextToken」は、結果の項目に連続的にページ番号をふるために使用されます。最初のページを読み込むには、このプロパティをnullに設定します。

--profile, -p

任意です。更新または作成するプロファイルです。指定したプロファイルが既に存在する場合、CLIはユーザーの入力した内容でプロファイルを上書きします。指定しない場合、CLIは対話型のプロンプトでユーザーに新しいプロファイルの作成か、既存のプロファイルの更新かをたずねます。

--debug

任意です。標準エラー出力にデバッグメッセージを追加します。

get-catalog-uploadサブコマンド

$ ask api get-catalog-upload <-c|--catalog-id <カタログID>> <-u|--upload-id <アップロードID>> [-p|--profile <プロファイル>] [--debug]

アップロードの詳細を取得します。

オプション

-c, --catalog-id

必須です。リクエストされたカタログのカタログIDです。

-u, --upload-id

必須です。アップロードのIDです。

--profile, -p

任意です。更新または作成するプロファイルです。指定したプロファイルが既に存在する場合、CLIはユーザーの入力した内容でプロファイルを上書きします。指定しない場合、CLIは対話型のプロンプトでユーザーに新しいプロファイルの作成か、既存のプロファイルの更新かをたずねます。

--debug

任意です。標準エラー出力にデバッグメッセージを追加します。

associate-catalog-with-skillサブコマンド

$ ask api associate-catalog-with-skill <--skill-id <スキルID>> <-c|--catalog-id <カタログID>> [-p|--profile <プロファイル>] [--debug]

カタログをスキルに関連付けます。

オプション

-s, --skill-id

必須です。すべての関連するカタログのリストを表示するスキルのIDです。

-c, --catalog-id

必須です。リクエストされたカタログのカタログIDです。

--profile, -p

任意です。更新または作成するプロファイルです。指定したプロファイルが既に存在する場合、CLIはユーザーの入力した内容でプロファイルを上書きします。指定しない場合、CLIは対話型のプロンプトでユーザーに新しいプロファイルの作成か、既存のプロファイルの更新かをたずねます。

--debug

任意です。標準エラー出力にデバッグメッセージを追加します。

upload-catalogサブコマンド

$ ask api upload-catalog <-c|--catalog-id <カタログID>> <-f|--file <ファイル>> [-p|--profile <プロファイル>] [--debug]

ファイルでカタログを更新します。アップロードでは、マルチパートアップロード方式を利用して新しいコンテンツをAmazon S3（シンプルなクラウドストレージソリューション）バケットにアップロードします。

このコマンドを入力するプロセスは次のとおりです。

1. まずASK CLIが、デフォルトのパートサイズ（8MB）に基づいて算出したパート数を提案します。
2. その後、このコマンドがカタログのアップロードを作成するリクエストを送信します。次に、パート数を確認するか、別の数を指定するかをたずねるプロンプトが出されます。ASK CLIは指定可能なパート数の範囲を表示します。上限は各パートが5MB以上になることを保証する数となります。
3. ASK CLIはアップロードを作成する署名済みURLのリストをAmazon S3から受信します。
4. ASK CLIはファイルをストリームで読み込み、先ほど確認したパート数にファイルを分割します。
5. すべてのパートが正常にアップロードされたら、ASK CLIは各パートのeTagのリストを送信してアップロードを完了します。

オプション

-c, --catalog-id

必須です。リクエストされたカタログのカタログIDです。

-f, --file

必須です。catalogコンテンツを含むファイルです。

--profile, -p

任意です。更新または作成するプロファイルです。指定したプロファイルが既に存在する場合、CLIはユーザーの入力した内容でプロファイルを上書きします。指定しない場合、CLIは対話型のプロンプトでユーザーに新しいプロファイルの作成か、既存のプロファイルの更新かをたずねます。

--debug

任意です。標準エラー出力にデバッグメッセージを追加します。

create-nlu-annotation-setサブコマンド

指定したスキルのアノテーションセットを新規作成します。このコマンドは、アノテーションセットのアップロードや更新に使うアノテーションIDを返します。

ask api create-nlu-annotation-set <-s|--skill-id <スキルID>> <-l|--locale <ロケール>> <-n|--annotation-set-name <アノテーションセット名>> [-p|--profile <プロファイル>] [--debug]

オプション

-s, --skill-id

必須です。 アノテーションセットのスキルIDです。

-l, --locale

必須です。 アノテーションセットを指定したスキルの対話モデルのロケールです。たとえば、en-US, en-GB, de-DEなどです。

-n, --annotation-set-name

必須です。 アノテーションセットの名前です。

-p, --profile

任意です。 使用するASK CLIプロファイルです。このオプションを含めない場合は、ASK CLIはデフォルトのプロファイルを使用します。

--debug

任意です。 このオプションを指定すると、ASK CLIはコマンド出力にデバッグメッセージを表示します。

list-nlu-annotation-setsサブコマンド

指定したスキルのアノテーションセットの一覧を取得します。

ask api list-nlu-annotation-sets <-s|--skill-id <スキルID>> [-l|--locale <ロケール>] [--next-token <次のトークン>] [--max-results <結果項目の最大数>] [-p|--profile <プロファイル>] [--debug]

-s, --skill-id

必須です。 アノテーションセットの一覧を取得するスキルのIDです。

-l, --locale

任意です。 応答に返される結果をフィルタリングするロケールです。たとえば、en-US, en-GB, de-DEなどです。

--next-token

任意です。 一部のみの応答を受け取った後、さらに多くのアノテーションセットを取得するには、このパラメーターを使用します。一部のみの応答からnextTokenの値に設定します。

--max-results

任意です。 応答で返す項目の最大数です。このパラメーターを含めない場合は、デフォルトの最大値は10です。このパラメーターを含める場合は、応答には指定した値よりも小さい数の項目しかない場合もありますが、これを超える数の項目は含まれません。100を超える値を指定することはできません。

-p, --profile

任意です。 使用するASK CLIプロファイルです。このオプションを含めない場合は、ASK CLIはデフォルトのプロファイルを使用します。

--debug

任意です。 このオプションを指定すると、ASK CLIはコマンド出力にデバッグメッセージを表示します。

update-nlu-annotation-set-annotationsサブコマンド

新規アノテーションセットをアップロードします。指定したIDのアノテーションセットが存在する場合は、アノテーションセットファイルに指定したアノテーションセットで更新します。

このコマンドを使用するには、アノテーションセットファイルが必要です。アノテーションセットファイルはJSON、CSVのいずれかの形式で作成できます。詳細については、アノテーションセットを参照してください。

ask api update-nlu-annotation-set-annotations <-s|--skill-id <スキルID>> <-a|--annotation-id <アノテーションID>> <-f|--annotations-file <アノテーションファイル>> <--annotations-format <アノテーションの形式>> [-p|--profile <プロファイル>] [--debug]

-s, --skill-id

必須です。 このアノテーションセットのスキルIDです。

-a, --annotation-id

必須です。 アップロードまたは更新するアノテーションセットのIDです。

-f, --annotations-file

必須です。 アップロードまたは更新するアノテーションセットを含む、コンピューターのローカルにあるファイルです。

--annotations-format

必須です。 アノテーションセットファイルの形式に応じて、application/json、application/csvのいずれかを指定します。

-p, --profile

任意です。 使用するASK CLIプロファイルです。このオプションを含めない場合は、ASK CLIはデフォルトのプロファイルを使用します。

--debug

任意です。 このオプションを指定すると、ASK CLIはコマンド出力にデバッグメッセージを表示します。

get-nlu-annotation-set-annotationsサブコマンド

指定したスキルのアノテーションセットを指定して取得します。

ask api get-nlu-annotation-set-annotations <-s|--skill-id <スキルID>> <-a|--annotation-id <アノテーションID>> <--annotations-format <アノテーションの形式>> [-p|--profile <プロファイル>] [--debug]

-s, --skill-id

必須です。 アノテーションセットのスキルIDです。

-a, --annotation-id

必須です。 取得するアノテーションセットのIDです。

--annotations-format

必須です。 アノテーションセットをJSON形式で取得する場合はapplication/jsonを、CSV形式で取得する場合はapplication/csvを指定します。

-p, --profile

任意です。 使用するASK CLIプロファイルです。このオプションを含めない場合は、ASK CLIはデフォルトのプロファイルを使用します。

--debug

任意です。 このオプションを指定すると、ASK CLIはコマンド出力にデバッグメッセージを表示します。

update-nlu-annotation-set-propertiesサブコマンド

指定したアノテーションセットのプロパティを更新します。現時点で更新可能なプロパティはnameのみです。

ask api update-nlu-annotation-set-properties <-s|--skill-id <スキルID>> <-a|--annotation-id <アノテーションID>> <-n|--annotation-set-name <アノテーションセット名>> [-p|--profile <プロファイル>] [--debug]

-s, --skill-id

必須です。 アノテーションセットのスキルIDです。

-a, --annotation-id

必須です。 プロパティを更新するアノテーションセットのIDです。

-n, --annotation-set-name

必須です。 アノテーションセットの名前です。

-p, --profile

任意です。 使用するASK CLIプロファイルです。このオプションを含めない場合は、ASK CLIはデフォルトのプロファイルを使用します。

--debug

任意です。 このオプションを指定すると、ASK CLIはコマンド出力にデバッグメッセージを表示します。

get-nlu-annotation-set-propertiesサブコマンド

指定したアノテーションセットのプロパティを取得します。プロパティには、名前、ロケール、アノテーション数、アノテーションセットを最後に更新したタイムスタンプがあります。

ask api get-nlu-annotation-set-properties <-s|--skill-id <スキルID>> <-a|--annotation-id <アノテーションID>> [-p|--profile <プロファイル>] [--debug]

-s, --skill-id

必須です。 アノテーションセットのスキルIDです。

-a, --annotation-id

必須です。 プロパティを取得するアノテーションセットのIDです。

-p, --profile

任意です。 使用するASK CLIプロファイルです。このオプションを含めない場合は、ASK CLIはデフォルトのプロファイルを使用します。

--debug

任意です。 このオプションを指定すると、ASK CLIはコマンド出力にデバッグメッセージを表示します。

delete-nlu-annotation-setサブコマンド

アノテーションセットを削除します。

ask api delete-nlu-annotation-set <-s|--skill-id <スキルID>> <-a|--annotation-id <アノテーションID>> [-p|--profile <プロファイル>] [--debug]

-s, --skill-id

必須です。 アノテーションセットのスキルIDです。

-a, --annotation-id

必須です。 削除するアノテーションセットのIDです。

-p, --profile

任意です。 使用するASK CLIプロファイルです。このオプションを含めない場合は、ASK CLIはデフォルトのプロファイルを使用します。

--debug

任意です。 このオプションを指定すると、ASK CLIはコマンド出力にデバッグメッセージを表示します。

evaluate-nluサブコマンド

スキルの対話モデルから派生した自然言語理解（NLU）モデルを、指定したアノテーションセットを使って評価します。

ask api evaluate-nlu <-s|--skill-id <スキルID>> <-l|--locale <ロケール>> <-a|--annotationId <アノテーションID>> [-g|--stage <ステージ>] [-p|--profile <プロファイル>] [--debug]

-s, --skill-id

必須です。 モデルを評価するスキルのIDです。

-l, --locale

必須です。 評価する対話モデルのロケールです。たとえば、en-US, en-GB, de-DEなどです。

-a, --annotation-id

必須です。 評価で使用するアノテーションセットのIDです。アノテーションセットを新規作成するとき、スキルのアノテーションセットの一覧を取得するときに、このIDを取得します。

-g, --stage

必須です。 モデルを評価するスキルのステージです。有効な値はdevelopmentとliveです。

-p, --profile

任意です。 使用するASK CLIプロファイルです。このオプションを含めない場合は、ASK CLIはデフォルトのプロファイルを使用します。

--debug

任意です。 このオプションを指定すると、ASK CLIはコマンド出力にデバッグメッセージを表示します。

list-nlu-evaluationsサブコマンド

評価の一覧を取得します。任意で、結果のページ分割やフィルタリングができます。

ask api list-nlu-evaluations <-s|--skill-id <スキルID>> [-g|--stage <ステージ>] [-l|--locale <ロケール>] [--next-token <次のトークン>] [--max-results <結果項目の最大数>] [-a|--annotation-id <アノテーションID>] [-p|--profile <プロファイル>] [--debug]

-s, --skill-id

必須です。 評価の一覧を取得するスキルのIDです。

-g, --stage

任意です。 応答に返される結果をフィルタリングするステージです。有効な値はdevelopmentとliveです。

-l, --locale

任意です。 応答に返される結果をフィルタリングするロケールです。たとえば、en-US, en-GB, de-DEなどです。

--next-token

任意です。 一部のみの応答を受け取った後、さらに多くの評価結果を取得するには、このオプションを使用します。一部のみの応答からnextTokenの値に設定します。

--max-results

任意です。 応答で返す項目の最大数です。このオプションを含めない場合は、デフォルトの最大値は10です。このオプションを指定した場合、応答に含まれる項目が指定した値よりも少ないことがありますが、この数より多いことはありません。100を超える値を指定することはできません。

-a, --annotation-id

任意です。 指定したアノテーションセットから開始された評価のみに、応答に返される結果をフィルタリングするIDです。

-p, --profile

任意です。 使用するASK CLIプロファイルです。このオプションを含めない場合は、ASK CLIはデフォルトのプロファイルを使用します。

--debug

任意です。 このオプションを指定すると、ASK CLIはコマンド出力にデバッグメッセージを表示します。

get-nlu-evaluationサブコマンド

ステータスを含む、指定した評価に関する情報を取得します。

ask api get-nlu-evaluation <-s|--skill-id <スキルID>> <-e|--evaluation-id <評価ID>> [-p|--profile <プロファイル>] [--debug]

-s, --skill-id

必須です。 評価を取得するスキルのIDです。

-e, --evaluation-id

必須です。 取得する評価のIDです。

-p, --profile

任意です。 使用するASK CLIプロファイルです。このオプションを含めない場合は、ASK CLIはデフォルトのプロファイルを使用します。

--debug

任意です。 このオプションを指定すると、ASK CLIはコマンド出力にデバッグメッセージを表示します。

get-nlu-evaluation-resultsサブコマンド

評価結果を取得します。任意で、結果のページ分割やフィルタリングができます。

ask api get-nlu-evaluation-results <-s|--skill-id <スキルID>> <-e|--evaluation-id <評価ID>> [--sort-field <ソートするフィールド>] [--test-case-status <テストケースのステータス>] [--actual-intent-name <実際のインテント名>] [--expected-intent-name <予想されるインテント名>] [--next-token <次のトークン>] [--max-results <結果項目の最大数>] [-p|--profile <プロファイル>] [--debug]

-s, --skill-id

必須です。 評価を取得するスキルのIDです。

-e, --evaluation-id

必須です。 取得する評価のIDです。

--sort-field

任意です。 応答に返される結果を並べ替える基準とするフィールドです。有効な値はSTATUS、ACTUAL_INTENT、EXPECTED_INTENTです。

--test-case-status

任意です。 指定したステータスのテストケースのみを返すフィルターです。有効な値はPASSEDとFAILEDです。

--actual-intent-name

任意です。 指定したインテントに解決されるテストケースのみを返すフィルターです。

--expected-intent-name

任意です。 指定したインテントが予想されるテストケースのみを返すフィルターです。

--next-token

任意です。 一部のみの応答を受け取った後、さらに多くの結果を取得するには、このパラメーターを使用します。一部のみの応答からnextTokenの値に設定します。

--max-results

任意です。 応答で返す項目の最大数です。このパラメーターを含めない場合は、デフォルトの最大値は1000です。このパラメーターを含める場合は、応答には指定した値よりも小さい数の項目しかない場合もありますが、これを超える数の項目は含まれません。1000を超える値を指定することはできません。

-p, --profile

任意です。 使用するASK CLIプロファイルです。このオプションを含めない場合は、ASK CLIはデフォルトのプロファイルを使用します。

--debug

任意です。 このオプションを指定すると、ASK CLIはコマンド出力にデバッグメッセージを表示します。

get-conflict-detection-job-statusサブコマンド

発話の競合を検出するジョブのステータスを取得します。

ask api get-conflict-detection-job-status <-s|--skill-id <skill-id>> <-l|--locale <locale>> <--model-version <model-version>>

-s, --skill-id

必須です。発話の競合を取得するスキルの識別子です。

-l, --locale

ASK_DEFAULT_DEVICE_LOCALE環境変数が設定されている場合は任意、それ以外は必須です。localeの値の例は ja-JPです。

--model-version

任意です。対話モデルのバージョンです。

get-conflicts

スキルの発話の競合を取得します。オプションで、一度に表示する結果の数を指定できます。

ask api get-conflicts <-s|--skill-id <skill-id>> <-l|--locale <locale>> <--model-version <model-version>> <--next-token <next-token>> <--max-results <max-results>>

-s, --skill-id

必須です。発話の競合を取得するスキルの識別子です。

-l, --locale

ASK_DEFAULT_DEVICE_LOCALE環境変数が設定されている場合は任意、それ以外は必須です。localeの値の例は ja-JPです。

--model-version

任意です。対話モデルのバージョンです。

--next-token

任意です。一部のみの応答を受け取った後、さらに多くの結果を取得するには、このパラメーターを使用します。一部のみの応答からnextTokenの値に設定します。

--max-results

任意です。応答で返す項目の最大数です。このパラメーターを含めない場合は、デフォルトの最大値は100です。このパラメーターを含める場合は、応答には指定した値よりも小さい数の項目しかない場合もありますが、これを超える数の項目は含まれません。1以上1000未満の値を指定します。

utilコマンド

utilコマンドは、Alexaスキルの作成を管理するユーティリティツールを提供します。

サブコマンド

generate-lwa-tokens

LWAのアクセストークンと更新トークンを生成します。スキルがAlexa開発者用ツールにアクセスする際に必要になる可能性があります。

この機能を使用するには、以下の手順でURLをホワイトリストに登録する必要があります。

1. https://developer.amazon.com/home.htmlに移動します。
2. 上のメニューバーで設定を選択します。
3. サブメニューバーでセキュリティプロファイルを選択します。
4. 使用するプロファイルを選択し、ウェブ設定を選択します。プロファイルがない場合、セキュリティプロファイルを新規作成をクリックし、手順に従って作成します。
5. 編集をクリックして、許可された返信URLにhttp://127.0.0.1:9090/cb（デフォルトオプションを使ってブラウザを開く場合）、https://s3.amazonaws.com/ask-cli/response_parser.html（--no-browserオプションを使う場合）のいずれかのURLをコピーして貼り付けます。
6. 変更を保存します。

generate-lwa-tokensコマンドの形式

$ ask util generate-lwa-tokens [--scope <スコープ>] [--no-browser]

オプション

--scope

任意です。Alexa開発者ポータルにログインするユーザーから、特定のスコープ（複数可）をリクエストします。scopesオプションが指定されない場合、デフォルトでASK CLIと同じスコープが使用されます。

--no-browser

任意です。ブラウザを開く代わりに認証画面のURLを表示します。開発者はコンソールに表示されたURLをコピーし、別のデバイスのウェブブラウザでリンクを開いてAmazonのログインページに移動します。

CLIウィンドウに、クライアントIDとクライアントシークレットを入力するようプロンプトが出されます。セキュリティプロファイルからこれらの値を取得します。セキュリティプロファイルにアクセスするには、https://developer.amazon.com/home.htmlを開き、セキュリティプロファイルを選択します。セキュリティプロファイルを開いて、クライアントIDとクライアントシークレットをコピーします。

クライアントIDとクライアントシークレットを入力すると、開発者アカウントを使ってAmazonのSMAPI CLIページにログインするようプロンプトが出されます。ログインすると、CLIウィンドウにaccess_tokenとrefresh_tokenの値が表示されます。

lambdaコマンド

Lambdaコマンドを使うと、AWS Lambda関数のコードを取得してアップロードできます。

lambdaコマンドの形式：

$ ask lambda <サブコマンド> [-f|--function <関数名>] [その他のオプション]

サブコマンド

downloadサブコマンド

指定したLambda関数のコードを指定した場所（指定は任意）にダウンロードします

downloadコマンドの形式：

$ ask lambda download [-f|--function <関数名>] [-d|--dest <ダウンロード先のパス>]

オプション

--function、-f

任意です。Lambda関数の名前です。このオプションがセットされない場合、ダウンロードを実行すると設定されたアカウントのLambda関数のリストを表示します。開発者はこの番号付きリストから1つ選択できます。

--dest、-d

任意です。Lambda関数のダウンロード先の場所を指定します。指定されない場合、Lambdaは現在の作業ディレクトリにダウンロードされます。

uploadサブコマンド

現在のディレクトリまたは指定ディレクトリのファイルを指定したLambda関数にアップロードします。

uploadコマンドの形式：

$ ask lambda upload [-f|--function <関数名>] [-s|--src <ソースディレクトリのパス>]

オプション

--function、-f

必須です。ターゲットのLambda関数名を指定します。

--src、-s

任意です。アップロード元のソースディレクトリを指定します。指定しない場合、現在の作業ディレクトリのコンテンツがアップロードされます。

logサブコマンド

指定したLambda関数のCloudWatchログを表示できます。

logコマンドの形式：

$ ask lambda log [-f|--function <関数名>] [--start-time <開始時刻>] [--end-time <終了時刻>] [--limit <最大数>] [--raw]

オプション

--function、-f

必須です。Lambda関数の名前です。

--start-time

任意です。表示するログの開始時間です。1日前の場合は1dayago、30時間前の場合は30hoursagoの形式で記述する必要があります。デフォルトは1dayagoです。

--end-time

任意です。表示するログの終了時間です。1日前の場合は1dayago、30時間前の場合は30hoursagoの形式で記述する必要があります。

--limit

任意です。表示するログエントリの数を表す整数値です。

--raw

任意です。色や書式なしでログを表示します。

スマートホーム評価ツールのサブコマンド

list-smarthome-capability-test-plansサブコマンド

スマートホームスキルの機能テスト計画を表示するには、このコマンドを使用します。テスト計画とは、指定した機能インターフェースで実行する一連のテストケースです。利用できるテスト計画については、 こちらを参照してください。

list-smarthome-capability-test-plansコマンドの形式：

$ ask api list-smarthome-capability-test-plans <-s|--skill-id <スキルID>> [--max-results <結果項目の最大数>] [--next-token <次のトークン>]

オプション

-s, --skill-id

必須です。検証するスキルのスキルIDです。amzn1.ask.skill.12345678-1234-1234-123456789123 の形式で指定する必要があります。

--max-results

任意です。応答で返す項目の最大数です。このパラメーターを含めない場合は、デフォルトの最大値は20です。このパラメーターを含める場合は、指定した値よりも少ない項目が応答に含まれる場合もあります。1000を超える値を指定することはできません。

--next-token

任意です。前回のリクエストから引き続き結果を返すためのトークンです。より多くの評価を取得するには、このオプションを使用します。

create-smarthome-capability-evaluationサブコマンド

スマートホームスキルの機能評価を作成して開始するには、このコマンドを使用します。機能評価とは、選択したテスト計画と指定した機能インターフェースに基づいて実行するテストです。機能評価では、テスト計画を使用して、指定した機能インターフェースを評価します。

create-smarthome-capability-evaluationコマンドの形式：

$ ask api create-smarthome-capability-evaluation <-s|--skill-id <スキルID>> [-g|--stage <ステージ>] <--endpoint-id <エンドポイントID>> <--test-plan-id <テスト計画ID>>

オプション

-s, --skill-id

必須です。検証するスキルのスキルIDです。amzn1.ask.skill.12345678-1234-1234-123456789123 の形式で指定する必要があります。

--stage, -g

任意です。スキルのステージを表します。値はdevelopmentまたはliveを使用します。デフォルト値はdevelopmentです。

--endpoint-id

必須です。一意のエンドポイントIDです。

--test-plan-id

必須です。各テスト計画を示す一意のIDです。

list-smarthome-capability-evaluationsサブコマンド

スマートホームスキルの機能評価を表示するには、このコマンドを使用します。

list-smarthome-capability-evaluationsコマンドの形式：

$ ask api list-smarthome-capability-evaluations <-s|--skill-id <スキルID>> [-g|--stage <ステージ>] [--start-timestamp-from <最初のタイムスタンプ>] [--start-timestamp-to <最終のタイムスタンプ>] [--max-results <結果項目の最大数>] [--next-token <次のトークン>]

オプション

-s, --skill-id

必須です。検証するスキルのスキルIDです。形式はamzn1.ask.skill.12345678-1234-1234-123456789123です。

--stage, -g

任意です。スキルのステージを表します。値はdevelopmentまたはliveを使用します。デフォルト値はdevelopmentです。

--start-timestamp-from

任意です。評価履歴の照会対象とする最初の評価開始日時です。yyyy-MM-d'T'HH:mm:ss.SSS'zの形式で指定します。デフォルト値は現在の時刻から30日前です。

--start-timestamp-to

任意です。評価履歴の照会対象とする最終の評価開始日時です。yyyy-MM-d'T'HH:mm:ss.SSS'zの形式で指定します。デフォルト値は現在の時刻です。

--max-results

任意です。応答で返す項目の最大数です。このパラメーターを含めない場合は、デフォルトの最大値は20です。このパラメーターを含める場合は、指定した値よりも少ない項目が応答に含まれる場合もあります。1000を超える値を指定することはできません。

--next-token

任意です。前回のリクエストから引き続き結果を返すためのトークンです。より多くの評価を取得するには、このオプションを使用します。

get-smarthome-capability-evaluationサブコマンド

スマートホーム機能評価の重要な情報とステータスを取得するには、このコマンドを使用します。

get-smarthome-capability-evaluationコマンドの形式：

$ ask api get-smarthome-capability-evaluation <-s|--skill-id <スキルID>> <-e|--evaluation-id <評価ID>>

オプション

-s, --skill-id

必須です。検証するスキルのスキルIDです。形式はamzn1.ask.skill.12345678-1234-1234-123456789123です。

--evaluation-id、-e

必須です。各機能評価を識別する一意のIDです。

get-smarthome-capability-evaluation-resultsサブコマンド

テストケースについて評価を実行した結果を取得するには、このコマンドを使用します。

get-smarthome-capability-evaluation-resultsコマンドの形式：

$ ask api get-smarthome-capability-evaluation-results <-s|--skill-id <skill-id>> <-e|--evaluation-id <evaluation-id>> [--max-results <max-results>] [--offset <offset>]

オプション

-s, --skill-id

必須です。検証するスキルのスキルIDです。形式はamzn1.ask.skill.12345678-1234-1234-123456789123です。

--evaluation-id、-e

必須です。各機能評価を識別する一意のIDです。

--max-results

任意です。応答で返す項目の最大数です。このパラメーターを含めない場合は、デフォルトの最大値は20です。このパラメーターを含める場合は、指定した値よりも少ない項目が応答に含まれる場合もあります。1000を超える値を指定することはできません。

--offset

任意です。このコマンドは結果ページを返します。

スロットタイプのサブコマンド

これらのコマンドを使うと、開発者アカウントで複数のスキルに使用する独自のスロットタイプを作成できます。スキルの対話モデルで、ビルトインスロットタイプと同じ方法でスロットタイプを拡張できます。詳細については、複数のスキルで使用可能なスロットタイプを作成するを参照してください。

create-model-slot-typeサブコマンド

スロットタイプを作成します。スロットタイプは、スロットタイプのバージョンを保持するコンテナです。

ask api create-model-slot-type <-n|--slot-type-name <スロットタイプ名>> [-d|--slot-type-description <スロットタイプの説明>] [-p|--profile <プロファイル>] [--debug]

-n, --slot-type-name

必須です。 スロットタイプの名前です。

-d, --slot-type-description

任意です。 スロットタイプの説明です。

-p, --profile

任意です。 使用するASK CLIプロファイルです。このオプションを含めない場合は、ASK CLIはデフォルトのプロファイルを使用します。

--debug

任意です。 このオプションを指定すると、ASK CLIはコマンド出力にデバッグメッセージを表示します。

get-model-slot-typeサブコマンド

指定されたIDのスロットタイプを返します。

ask api get-model-slot-type <-t|--slot-type-id <スロットタイプID>> [-p|--profile <プロファイル>] [--debug]

-t, --slot-type-id

必須です。 スロットタイプのIDです。

-p, --profile

任意です。 使用するASK CLIプロファイルです。このオプションを含めない場合は、ASK CLIはデフォルトのプロファイルを使用します。

--debug

任意です。 このオプションを指定すると、ASK CLIはコマンド出力にデバッグメッセージを表示します。

update-model-slot-typeサブコマンド

スロットタイプの説明を更新します。説明を指定しない場合、コマンドは既存の説明を削除します。

ask api update-model-slot-type <-t|--slot-type-id <スロットタイプID>> [-d|--slot-type-description <スロットタイプの説明>] [-p|--profile <プロファイル>] [--debug]

-t, --slot-type-id

必須です。 スロットタイプのIDです。

-d, --slot-type-description

任意です。 スロットタイプの説明です。

-p, --profile

任意です。 使用するASK CLIプロファイルです。このオプションを含めない場合は、ASK CLIはデフォルトのプロファイルを使用します。

--debug

任意です。 このオプションを指定すると、ASK CLIはコマンド出力にデバッグメッセージを表示します。

list-model-slot-typesサブコマンド

開発者アカウントで作成したすべてのスロットタイプのリストを返します。

ask api list-model-slot-types [--max-results <結果項目の最大数>] [--next-token <次のトークン>] [--sort-direction <ソート順>] [-p|--profile <プロファイル>] [--debug]

--max-results

任意です。 リクエストによって返される結果の最大数です。

--next-token

任意です。 結果の次のページを照会することができます。

--sort-direction

任意です。 結果の並び順を設定します。

--profile, -p,

任意です。 使用するASK CLIプロファイルです。

--debug

任意です。 標準エラー出力にデバッグメッセージを追加します。

delete-model-slot-typeサブコマンド

スロットタイプを削除します。

ask api delete-model-slot-type <-t|--slot-type-id <スロットタイプID>> [-p|--profile <プロファイル>] [--debug]

-t, --slot-type-id

必須です。 スロットタイプのIDです。

-p, --profile

任意です。 使用するASK CLIプロファイルです。このオプションを含めない場合は、ASK CLIはデフォルトのプロファイルを使用します。

--debug

任意です。 このオプションを指定すると、ASK CLIはコマンド出力にデバッグメッセージを表示します。

create-model-slot-type-versionサブコマンド

スロットタイプの新しいバージョンを作成します。スロットタイプのバージョンには、スロットタイプの定義が含まれます。この定義には、スロットタイプの値または値を格納した外部データソースへの参照が含まれます。各スロットタイプバージョンはスロットタイプに属します。

ask api create-model-slot-type-version <-t|--slot-type-id <スロットタイプID>> <-f|--file <ファイルへのパス>> [-d|--version-description <バージョン説明>] [-p|--profile <プロファイル>] [--debug]

-t, --slot-type-id

必須です。 スロットタイプのIDです。

-f, --file-path

必須です。 スロットタイプ定義を含むファイルです。

-d, --version-description

任意です。 スロットタイプバージョンの説明です。

-p, --profile

任意です。 使用するASK CLIプロファイルです。このオプションを含めない場合は、ASK CLIはデフォルトのプロファイルを使用します。

--debug

任意です。 このオプションを指定すると、ASK CLIはコマンド出力にデバッグメッセージを表示します。

get-model-slot-type-update-statusサブコマンド

指定されたIDのスロットタイプのビルドステータスを返します。ビルドステータスの有効な値は、succeeded、in progress、failedのいずれかです。

ask api get-model-slot-type-update-status <-t|--slot-type-id <スロットタイプID>> <-u|--update-request-id <更新リクエストID>> [-p|--profile <プロファイル>] [--debug]

-t, --slot-type-id

必須です。 スロットタイプのIDです。

-u, --update-request-id

必須です。 create-model-slot-type-versionサブコマンドで返される場所のリクエストIDです。

-p, --profile

任意です。 使用するASK CLIプロファイルです。このオプションを含めない場合は、ASK CLIはデフォルトのプロファイルを使用します。

--debug

任意です。 このオプションを指定すると、ASK CLIはコマンド出力にデバッグメッセージを表示します。

get-model-slot-type-versionサブコマンド

指定されたIDとバージョンのスロットタイプデータを返します。

ask api get-model-slot-type-version <-t|--slot-type-id <スロットタイプID>> <--slot-type-version <スロットタイプバージョン>> [-p|--profile <プロファイル>] [--debug]

-t, --slot-type-id

必須です。 スロットタイプのIDです。

--slot-type-version

必須です。 スロットタイプのバージョンです。

-p, --profile

任意です。 使用するASK CLIプロファイルです。このオプションを含めない場合は、ASK CLIはデフォルトのプロファイルを使用します。

--debug

任意です。 このオプションを指定すると、ASK CLIはコマンド出力にデバッグメッセージを表示します。

update-model-slot-type-versionサブコマンド

スロットタイプバージョンの説明を更新します。説明を指定しない場合、コマンドは既存の説明を削除します。

ask api update-model-slot-type-version <-t|--slot-type-id <スロットタイプID>> <--slot-type-version <スロットタイプバージョン>> [-d|--version-description <バージョンの説明>] [-p|--profile <プロファイル>] [--debug]

-t, --slot-type-id

必須です。 スロットタイプのIDです。

--slot-type-version

必須です。 スロットタイプのバージョンです。

-d, --version-description

任意です。 スロットタイプバージョンの説明です。

-p, --profile

任意です。 使用するASK CLIプロファイルです。このオプションを含めない場合は、ASK CLIはデフォルトのプロファイルを使用します。

--debug

任意です。 このオプションを指定すると、ASK CLIはコマンド出力にデバッグメッセージを表示します。

list-model-slot-type-versionsサブコマンド

指定したIDのスロットタイプ定義のリストを表示します。

ask api list-model-slot-type-versions <-t|--slot-type-id <スロットタイプID>> [--max-results <max-results>] [--next-token <次のトークン>] [--sort-direction <ソート順>] [-p|--profile <プロファイル>] [--debug]

-t, --slot-type-id

必須です。 スロットタイプのIDです。

--max-results

任意です。 リクエストによって返される結果の最大数です。

--next-token

任意です。 結果の次のページを照会することができます。

--sort-direction

任意です。 結果の並び順を設定します。

--profile, -p,

任意です。 使用するASK CLIプロファイルです。

--debug

任意です。 標準エラー出力にデバッグメッセージを追加します。

delete-model-slot-type-versionサブコマンド

特定のスロットタイプバージョンを削除します。スキルがそのバージョンを使っている場合、コマンドは失敗します。

ask api delete-model-slot-type-version <-t|--slot-type-id <スロットタイプID>> <--slot-type-version <スロットタイプバージョン>> [-p|--profile <プロファイル>] [--debug]

-t, --slot-type-id

必須です。 スロットタイプのIDです。

--slot-type-version

必須です。 スロットタイプのバージョンです。

-p, --profile

任意です。 使用するASK CLIプロファイルです。このオプションを含めない場合は、ASK CLIはデフォルトのプロファイルを使用します。

--debug

任意です。 このオプションを指定すると、ASK CLIはコマンド出力にデバッグメッセージを表示します。

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

関連トピック

スキル内商品コマンドリファレンス