sam list endpoints

このページでは、 AWS Serverless Application Model コマンドラインインターフェイス (AWS SAMCLI) sam list endpointsサブコマンドのリファレンス情報を提供します。

の概要については、 AWS SAMCLI「」を参照してくださいとは AWS SAMCLI。

sam list endpoints サブコマンドは、 AWS CloudFormation スタックのクラウドエンドポイントとローカルエンドポイントのリストを表示します。sam local および sam sync コマンドを使用して、これらのリソースを操作できます。

AWS Lambda および Amazon API Gateway リソースタイプは、このコマンドでサポートされています。

注記

カスタムドメインは、Amazon API Gateway リソース用に設定されている場合にサポートされます。このコマンドは、デフォルトのエンドポイントの代わりにカスタムドメインを出力します。

使用方法

$ sam list endpoints <options>

オプション

--config-env TEXT

使用する設定ファイル内のデフォルトパラメータ値を指定する環境名です。

デフォルト値: default

設定ファイルの詳細については、「AWS SAM CLI 設定ファイル」を参照してください。

--config-file TEXT

使用するデフォルトのパラメータ値が含まれる設定ファイルのパスとファイル名です。

デフォルト値: 現在の作業ディレクトリ内の samconfig.toml。

設定ファイルの詳細については、「AWS SAM CLI 設定ファイル」を参照してください。

--debug

デバッグログ記録をオンにして、 AWS SAM CLI によって生成されたデバッグメッセージをタイムスタンプ付きで出力します。

--help, -h

このメッセージを表示して終了します。

--output [json|table]

結果を出力する形式を指定します。

デフォルト値: table

--profile TEXT

認証情報ファイルから特定のプロファイルを選択して、 AWS 認証情報を取得します。

--region TEXT

サービスの AWS リージョンを設定します。例えば us-east-1 です。

--save-params

コマンドラインで指定したパラメータを設定 AWS SAM ファイルに保存します。

--stack-name TEXT

デプロイされた AWS CloudFormation スタックの名前。スタック名は、アプリケーションの samconfig.toml ファイルまたは指定された設定ファイルで見つけることができます。

このオプションが指定されていない場合、テンプレートで定義されているローカルリソースが表示されます。

--template-file, --template, -t PATH

AWS SAM テンプレートファイル。

デフォルト値: template.[yaml|yml|json]

例

という名前の AWS CloudFormation スタックからデプロイされたリソースエンドポイントの出力を JSON 形式で表示しますtest-stack。

$ sam list endpoints --stack-name test-stack --output json
			
[
  {
    "LogicalResourceId": "HelloWorldFunction",
    "PhysicalResourceId": "sam-app-test-list-HelloWorldFunction-H85Y7yIV7ZLq",
    "CloudEndpoint": "https://zt55oi7kbljxjmcoahsj3cknwu0rposq.lambda-url.us-east-1.on.aws/",
    "Methods": "-"
  },
  {
    "LogicalResourceId": "ServerlessRestApi",
    "PhysicalResourceId": "uj80uoe2o2",
    "CloudEndpoint": [
      "https://uj80uoe2o2.execute-api.us-east-1.amazonaws.com/Prod",
      "https://uj80uoe2o2.execute-api.us-east-1.amazonaws.com/Stage"
    ],
    "Methods": [
      "/hello['get']"
    ]
  }
]