[System]
You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:
<schema>
{"$schema":"http://json-schema.org/draft-04/schema#","title":"AWS SAM CLI samconfig schema","type":"object","properties":{"version":{"title":"Config version","type":"number","default":0.1}},"required":["version"],"additionalProperties":false,"patternProperties":{"^.+$":{"title":"Environment","properties":{"init":{"title":"Init command","description":"Initialize an AWS SAM application.","properties":{"parameters":{"title":"Parameters for the init command","description":"Available parameters for the init command:\n* no_interactive:\nDisable interactive prompting for init parameters. (fail if any required values are missing)\n* architecture:\nArchitectures for Lambda functions.\n\nArchitectures: ['arm64', 'x86_64']\n* location:\nTemplate location (git, mercurial, http(s), zip, path).\n* runtime:\nLambda runtime for application.\n\nRuntimes: dotnet8, dotnet6, go1.x, java21, java17, java11, java8.al2, nodejs22.x, nodejs20.x, nodejs18.x, nodejs16.x, provided, provided.al2, provided.al2023, python3.9, python3.8, python3.13, python3.12, python3.11, python3.10, ruby3.4, ruby3.3, ruby3.2\n* package_type:\nLambda deployment package type.\n\nPackage Types: Zip, Image\n* base_image:\nLambda base image for deploying IMAGE based package type.\n\nBase images: amazon/dotnet6-base, amazon/dotnet8-base, amazon/go-provided.al2-base, amazon/go-provided.al2023-base, amazon/go1.x-base, amazon/java11-base, amazon/java17-base, amazon/java21-base, amazon/java8.al2-base, amazon/nodejs16.x-base, amazon/nodejs18.x-base, amazon/nodejs20.x-base, amazon/nodejs22.x-base, amazon/python3.10-base, amazon/python3.11-base, amazon/python3.12-base, amazon/python3.13-base, amazon/python3.8-base, amazon/python3.9-base, amazon/ruby3.2-base, amazon/ruby3.3-base, amazon/ruby3.4-base\n* dependency_manager:\nDependency manager for Lambda runtime.\n\nDependency managers: bundler, cli-package, gradle, maven, mod, npm, pip\n* output_dir:\nDirectory to initialize AWS SAM application.\n* name:\nName of AWS SAM Application.\n* app_template:\nIdentifier of the managed application template to be used. Alternatively, run '$ sam init' without options for an interactive workflow.\n* no_input:\nDisable Cookiecutter prompting and accept default values defined in the cookiecutter config.\n* extra_context:\nOverride custom parameters in the template's cookiecutter.json configuration e.g. {\"customParam1\": \"customValue1\", \"customParam2\":\"customValue2\"}\n* tracing:\nEnable AWS X-Ray tracing for application.\n* application_insights:\nEnable CloudWatch Application Insights monitoring for application.\n* structured_logging:\nEnable Structured Logging for application.\n* beta_features:\nEnable/Disable beta features.\n* debug:\nTurn on debug logging to print debug message generated by AWS SAM CLI and display timestamps.\n* save_params:\nSave the parameters provided via the command line to the configuration file.","type":"object","properties":{"no_interactive":{"title":"no_interactive","type":"boolean","description":"Disable interactive prompting for init parameters. (fail if any required values are missing)"},"architecture":{"title":"architecture","type":"string","description":"Architectures for Lambda functions.\n\nArchitectures: ['arm64', 'x86_64']","enum":["arm64","x86_64"]},"location":{"title":"location","type":"string","description":"Template location (git, mercurial, http(s), zip, path)."},"runtime":{"title":"runtime","type":"string","description":"Lambda runtime for application.\n\nRuntimes: dotnet8, dotnet6, go1.x, java21, java17, java11, java8.al2, nodejs22.x, nodejs20.x, nodejs18.x, nodejs16.x, provided, provided.al2, provided.al2023, python3.9, python3.8, python3.13, python3.12, python3.11, python3.10, ruby3.4, ruby3.3, ruby3.2","enum":["dotnet6","dotnet8","go1.x","java11","java17","java21","java8.al2","nodejs16.x","nodejs18.x","nodejs20.x","nodejs22.x","provided","provided.al2","provided.al2023","python3.10","python3.11","python3.12","python3.13","python3.8","python3.9","ruby3.2","ruby3.3","ruby3.4"]},"package_type":{"title":"package_type","type":"string","description":"Lambda deployment package type.\n\nPackage Types: Zip, Image","enum":["Image","Zip"]},"base_image":{"title":"base_image","type":"string","description":"Lambda base image for deploying IMAGE based package type.\n\nBase images: amazon/dotnet6-base, amazon/dotnet8-base, amazon/go-provided.al2-base, amazon/go-provided.al2023-base, amazon/go1.x-base, amazon/java11-base, amazon/java17-base, amazon/java21-base, amazon/java8.al2-base, amazon/nodejs16.x-base, amazon/nodejs18.x-base, amazon/nodejs20.x-base, amazon/nodejs22.x-base, amazon/python3.10-base, amazon/python3.11-base, amazon/python3.12-base, amazon/python3.13-base, amazon/python3.8-base, amazon/python3.9-base, amazon/ruby3.2-base, amazon/ruby3.3-base, amazon/ruby3.4-base","enum":["amazon/dotnet6-base","amazon/dotnet8-base","amazon/go-provided.al2-base","amazon/go-provided.al2023-base","amazon/go1.x-base","amazon/java11-base","amazon/java17-base","amazon/java21-base","amazon/java8.al2-base","amazon/nodejs16.x-base","amazon/nodejs18.x-base","amazon/nodejs20.x-base","amazon/nodejs22.x-base","amazon/python3.10-base","amazon/python3.11-base","amazon/python3.12-base","amazon/python3.13-base","amazon/python3.8-base","amazon/python3.9-base","amazon/ruby3.2-base","amazon/ruby3.3-base","amazon/ruby3.4-base"]},"dependency_manager":{"title":"dependency_manager","type":"string","description":"Dependency manager for Lambda runtime.\n\nDependency managers: bundler, cli-package, gradle, maven, mod, npm, pip","enum":["bundler","cli-package","gradle","maven","mod","npm","pip"]},"output_dir":{"title":"output_dir","type":"string","description":"Directory to initialize AWS SAM application.","default":"."},"name":{"title":"name","type":"string","description":"Name of AWS SAM Application."},"app_template":{"title":"app_template","type":"string","description":"Identifier of the managed application template to be used. Alternatively, run '$ sam init' without options for an interactive workflow."},"no_input":{"title":"no_input","type":"boolean","description":"Disable Cookiecutter prompting and accept default values defined in the cookiecutter config."},"extra_context":{"title":"extra_context","type":"string","description":"Override custom parameters in the template's cookiecutter.json configuration e.g. {\"customParam1\": \"customValue1\", \"customParam2\":\"customValue2\"}"},"tracing":{"title":"tracing","type":"boolean","description":"Enable AWS X-Ray tracing for application."},"application_insights":{"title":"application_insights","type":"boolean","description":"Enable CloudWatch Application Insights monitoring for application."},"structured_logging":{"title":"structured_logging","type":"boolean","description":"Enable Structured Logging for application."},"beta_features":{"title":"beta_features","type":"boolean","description":"Enable/Disable beta features."},"debug":{"title":"debug","type":"boolean","description":"Turn on debug logging to print debug message generated by AWS SAM CLI and display timestamps."},"save_params":{"title":"save_params","type":"boolean","description":"Save the parameters provided via the command line to the configuration file."}}}},"required":["parameters"]},"validate":{"title":"Validate command","description":"Validate an AWS SAM Template.","properties":{"parameters":{"title":"Parameters for the validate command","description":"Available parameters for the validate command:\n* template_file:\nAWS SAM template file.\n* profile:\nSelect a specific profile from your credential file to get AWS credentials.\n* region:\nSet the AWS Region of the service. (e.g. us-east-1)\n* beta_features:\nEnable/Disable beta features.\n* debug:\nTurn on debug logging to print debug message generated by AWS SAM CLI and display timestamps.\n* lint:\nRun linting validation on template through cfn-lint. Create a cfnlintrc config file to specify additional parameters. For more information, see: https://github.com/aws-cloudformation/cfn-lint\n* save_params:\nSave the parameters provided via the command line to the configuration file.","type":"object","properties":{"template_file":{"title":"template_file","type":"string","description":"AWS SAM template file.","default":"template.[yaml|yml|json]"},"profile":{"title":"profile","type":"string","description":"Select a specific profile from your credential file to get AWS credentials."},"region":{"title":"region","type":"string","description":"Set the AWS Region of the service. (e.g. us-east-1)"},"beta_features":{"title":"beta_features","type":"boolean","description":"Enable/Disable beta features."},"debug":{"title":"debug","type":"boolean","description":"Turn on debug logging to print debug message generated by AWS SAM CLI and display timestamps."},"lint":{"title":"lint","type":"boolean","description":"Run linting validation on template through cfn-lint. Create a cfnlintrc config file to specify additional parameters. For more information, see: https://github.com/aws-cloudformation/cfn-lint"},"save_params":{"title":"save_params","type":"boolean","description":"Save the parameters provided via the command line to the configuration file."}}}},"required":["parameters"]},"build":{"title":"Build command","description":"Build AWS serverless function code.","properties":{"parameters":{"title":"Parameters for the build command","description":"Available parameters for the build command:\n* terraform_project_root_path:\nUsed for passing the Terraform project root directory path. Current directory will be used as a default value, if this parameter is not provided.\n* hook_name:\nHook package id to extend AWS SAM CLI commands functionality. \n\nExample: `terraform` to extend AWS SAM CLI commands functionality to support terraform applications. \n\nAvailable Hook Names: ['terraform']\n* skip_prepare_infra:\nSkip preparation stage when there are no infrastructure changes. Only used in conjunction with --hook-name.\n* use_container:\nBuild functions within an AWS Lambda-like container.\n* build_in_source:\nOpts in to build project in the source folder. The following workflows support building in source: ['nodejs16.x', 'nodejs18.x', 'nodejs20.x', 'nodejs22.x', 'Makefile', 'esbuild']\n* container_env_var:\nEnvironment variables to be passed into build containers\nResource format (FuncName.VarName=Value) or Global format (VarName=Value).\n\n Example: --container-env-var Func1.VAR1=value1 --container-env-var VAR2=value2\n* container_env_var_file:\nEnvironment variables json file (e.g., env_vars.json) to be passed to containers.\n* build_image:\nContainer image URIs for building functions/layers. You can specify for all functions/layers with just the image URI (--build-image public.ecr.aws/sam/build-nodejs18.x:latest). You can specify for each individual function with (--build-image FunctionLogicalID=public.ecr.aws/sam/build-nodejs18.x:latest). A combination of the two can be used. If a function does not have build image specified or an image URI for all functions, the default SAM CLI build images will be used.\n* exclude:\nName of the resource(s) to exclude from AWS SAM CLI build.\n* parallel:\nEnable parallel builds for AWS SAM template's functions and layers.\n* mount_with:\nSpecify mount mode for building functions/layers inside container. If it is mounted with write permissions, some files in source code directory may be changed/added by the build process. By default the source code directory is read only.\n* mount_symlinks:\nSpecify if symlinks at the top level of the code should be mounted inside the container. Activating this flag could allow access to locations outside of your workspace by using a symbolic link. By default symlinks are not mounted.\n* build_dir:\nDirectory to store build artifacts.Note: This directory will be first removed before starting a build.\n* cache_dir:\nDirectory to store cached artifacts. The default cache directory is .aws-sam/cache\n* base_dir:\nResolve relative paths to function's source code with respect to this directory. Use this if SAM template and source code are not in same enclosing folder. By default, relative paths are resolved with respect to the SAM template's location.\n* manifest:\nPath to a custom dependency manifest. Example: custom-package.json\n* cached:\nEnable cached builds.Reuse build artifacts that have not changed from previous builds. \n\nAWS SAM CLI evaluates if files in your project directory have changed. \n\nNote: AWS SAM CLI does not evaluate changes made to third party modules that the project depends on.Example: Python function includes a requirements.txt file with the following entry requests=1.x and the latest request module version changes from 1.1 to 1.2, AWS SAM CLI will not pull the latest version until a non-cached build is run.\n* template_file:\nAWS SAM template file.\n* parameter_overrides:\nString that contains AWS CloudFormation parameter overrides encoded as key=value pairs.\n* skip_pull_image:\nSkip pulling down the latest Docker image for Lambda runtime.\n* docker_network:\nName or ID of an existing docker network for AWS Lambda docker containers to connect to, along with the default bridge network. If not specified, the Lambda containers will only connect to the default bridge docker network.\n* beta_features:\nEnable/Disable beta features.\n* debug:\nTurn on debug logging to print debug message generated by AWS SAM CLI and display timestamps.\n* profile:\nSelect a specific profile from your credential file to get AWS credentials.\n* region:\nSet the AWS Region of the service. (e.g. us-east-1)\n* save_params:\nSave the parameters provided via the command line to the configuration file.","type":"object","properties":{"terraform_project_root_path":{"title":"terraform_project_root_path","type":"string","description":"Used for passing the Terraform project root directory path. Current directory will be used as a default value, if this parameter is not provided."},"hook_name":{"title":"hook_name","type":"string","description":"Hook package id to extend AWS SAM CLI commands functionality. \n\nExample: `terraform` to extend AWS SAM CLI commands functionality to support terraform applications. \n\nAvailable Hook Names: ['terraform']"},"skip_prepare_infra":{"title":"skip_prepare_infra","type":"boolean","description":"Skip preparation stage when there are no infrastructure changes. Only used in conjunction with --hook-name."},"use_container":{"title":"use_container","type":"boolean","description":"Build functions within an AWS Lambda-like container."},"build_in_source":{"title":"build_in_source","type":"boolean","description":"Opts in to build project in the source folder. The following workflows support building in source: ['nodejs16.x', 'nodejs18.x', 'nodejs20.x', 'nodejs22.x', 'Makefile', 'esbuild']"},"container_env_var":{"title":"container_env_var","type":"string","description":"Environment variables to be passed into build containers\nResource format (FuncName.VarName=Value) or Global format (VarName=Value).\n\n Example: --container-env-var Func1.VAR1=value1 --container-env-var VAR2=value2"},"container_env_var_file":{"title":"container_env_var_file","type":"string","description":"Environment variables json file (e.g., env_vars.json) to be passed to containers."},"build_image":{"title":"build_image","type":"string","description":"Container image URIs for building functions/layers. You can specify for all functions/layers with just the image URI (--build-image public.ecr.aws/sam/build-nodejs18.x:latest). You can specify for each individual function with (--build-image FunctionLogicalID=public.ecr.aws/sam/build-nodejs18.x:latest). A combination of the two can be used. If a function does not have build image specified or an image URI for all functions, the default SAM CLI build images will be used."},"exclude":{"title":"exclude","type":"string","description":"Name of the resource(s) to exclude from AWS SAM CLI build."},"parallel":{"title":"parallel","type":"boolean","description":"Enable parallel builds for AWS SAM template's functions and layers."},"mount_with":{"title":"mount_with","type":"string","description":"Specify mount mode for building functions/layers inside container. If it is mounted with write permissions, some files in source code directory may be changed/added by the build process. By default the source code directory is read only.","default":"READ","enum":["READ","WRITE"]},"mount_symlinks":{"title":"mount_symlinks","type":"boolean","description":"Specify if symlinks at the top level of the code should be mounted inside the container. Activating this flag could allow access to locations outside of your workspace by using a symbolic link. By default symlinks are not mounted."},"build_dir":{"title":"build_dir","type":"string","description":"Directory to store build artifacts.Note: This directory will be first removed before starting a build.","default":".aws-sam/build"},"cache_dir":{"title":"cache_dir","type":"string","description":"Directory to store cached artifacts. The default cache directory is .aws-sam/cache","default":".aws-sam/cache"},"base_dir":{"title":"base_dir","type":"string","description":"Resolve relative paths to function's source code with respect to this directory. Use this if SAM template and source code are not in same enclosing folder. By default, relative paths are resolved with respect to the SAM template's location."},"manifest":{"title":"manifest","type":"string","description":"Path to a custom dependency manifest. Example: custom-package.json"},"cached":{"title":"cached","type":"boolean","description":"Enable cached builds.Reuse build artifacts that have not changed from previous builds. \n\nAWS SAM CLI evaluates if files in your project directory have changed. \n\nNote: AWS SAM CLI does not evaluate changes made to third party modules that the project depends on.Example: Python function includes a requirements.txt file with the following entry requests=1.x and the latest request module version changes from 1.1 to 1.2, AWS SAM CLI will not pull the latest version until a non-cached build is run."},"template_file":{"title":"template_file","type":"string","description":"AWS SAM template file.","default":"template.[yaml|yml|json]"},"parameter_overrides":{"title":"parameter_overrides","type":["array","string"],"description":"String that contains AWS CloudFormation parameter overrides encoded as key=value pairs.","items":{"type":"string"}},"skip_pull_image":{"title":"skip_pull_image","type":"boolean","description":"Skip pulling down the latest Docker image for Lambda runtime."},"docker_network":{"title":"docker_network","type":"string","description":"Name or ID of an existing docker network for AWS Lambda docker containers to connect to, along with the default bridge network. If not specified, the Lambda containers will only connect to the default bridge docker network."},"beta_features":{"title":"beta_features","type":"boolean","description":"Enable/Disable beta features."},"debug":{"title":"debug","type":"boolean","description":"Turn on debug logging to print debug message generated by AWS SAM CLI and display timestamps."},"profile":{"title":"profile","type":"string","description":"Select a specific profile from your credential file to get AWS credentials."},"region":{"title":"region","type":"string","description":"Set the AWS Region of the service. (e.g. us-east-1)"},"save_params":{"title":"save_params","type":"boolean","description":"Save the parameters provided via the command line to the configuration file."}}}},"required":["parameters"]},"local_invoke":{"title":"Local Invoke command","description":"Invoke AWS serverless functions locally.","properties":{"parameters":{"title":"Parameters for the local invoke command","description":"Available parameters for the local invoke command:\n* terraform_plan_file:\nUsed for passing a custom plan file when executing the Terraform hook.\n* hook_name:\nHook package id to extend AWS SAM CLI commands functionality. \n\nExample: `terraform` to extend AWS SAM CLI commands functionality to support terraform applications. \n\nAvailable Hook Names: ['terraform']\n* skip_prepare_infra:\nSkip preparation stage when there are no infrastructure changes. Only used in conjunction with --hook-name.\n* event:\nJSON file containing event data passed to the Lambda function during invoke. If this option is not specified, no event is assumed. Pass in the value '-' to input JSON via stdin\n* no_event:\nDEPRECATED: By default no event is assumed.\n* runtime:\nLambda runtime used to invoke the function.\n\nRuntimes: dotnet8, dotnet6, go1.x, java21, java17, java11, java8.al2, nodejs22.x, nodejs20.x, nodejs18.x, nodejs16.x, provided, provided.al2, provided.al2023, python3.9, python3.8, python3.13, python3.12, python3.11, python3.10, ruby3.4, ruby3.3, ruby3.2\n* mount_symlinks:\nSpecify if symlinks at the top level of the code should be mounted inside the container. Activating this flag could allow access to locations outside of your workspace by using a symbolic link. By default symlinks are not mounted.\n* template_file:\nAWS SAM template which references built artifacts for resources in the template. (if applicable)\n* env_vars:\nJSON file containing values for Lambda function's environment variables.\n* parameter_overrides:\nString that contains AWS CloudFormation parameter overrides encoded as key=value pairs.\n* debug_port:\nWhen specified, Lambda function container will start in debug mode and will expose this port on localhost.\n* debugger_path:\nHost path to a debugger that will be mounted into the Lambda container.\n* debug_args:\nAdditional arguments to be passed to the debugger.\n* container_env_vars:\nJSON file containing additional environment variables to be set within the container when used in a debugging session locally.\n* docker_volume_basedir:\nSpecify the location basedir where the SAM template exists. If Docker is running on a remote machine, Path of the SAM template must be mounted on the Docker machine and modified to match the remote machine.\n* log_file:\nFile to capture output logs.\n* layer_cache_basedir:\nSpecify the location basedir where the lambda layers used by the template will be downloaded to.\n* skip_pull_image:\nSkip pulling down the latest Docker image for Lambda runtime.\n* docker_network:\nName or ID of an existing docker network for AWS Lambda docker containers to connect to, along with the default bridge network. If not specified, the Lambda containers will only connect to the default bridge docker network.\n* force_image_build:\nForce rebuilding the image used for invoking functions with layers.\n* shutdown:\nEmulate a shutdown event after invoke completes, to test extension handling of shutdown behavior.\n* container_host:\nHost of locally emulated Lambda container. This option is useful when the container runs on a different host than AWS SAM CLI. For example, if one wants to run AWS SAM CLI in a Docker container on macOS, this option could specify `host.docker.internal`\n* container_host_interface:\nIP address of the host network interface that container ports should bind to. Use 0.0.0.0 to bind to all interfaces.\n* add_host:\nPasses a hostname to IP address mapping to the Docker container's host file. This parameter can be passed multiple times.Example:--add-host example.com:127.0.0.1\n* invoke_image:\nContainer image URIs for invoking functions or starting api and function. One can specify the image URI used for the local function invocation (--invoke-image public.ecr.aws/sam/build-nodejs20.x:latest). One can also specify for each individual function with (--invoke-image Function1=public.ecr.aws/sam/build-nodejs20.x:latest). If a function does not have invoke image specified, the default AWS SAM CLI emulation image will be used.\n* no_memory_limit:\nRemoves the Memory limit during emulation. With this parameter, the underlying container will run without a --memory parameter\n* beta_features:\nEnable/Disable beta features.\n* debug:\nTurn on debug logging to print debug message generated by AWS SAM CLI and display timestamps.\n* profile:\nSelect a specific profile from your credential file to get AWS credentials.\n* region:\nSet the AWS Region of the service. (e.g. us-east-1)\n* save_params:\nSave the parameters provided via the command line to the configuration file.","type":"object","properties":{"terraform_plan_file":{"title":"terraform_plan_file","type":"string","description":"Used for passing a custom plan file when executing the Terraform hook."},"hook_name":{"title":"hook_name","type":"string","description":"Hook package id to extend AWS SAM CLI commands functionality. \n\nExample: `terraform` to extend AWS SAM CLI commands functionality to support terraform applications. \n\nAvailable Hook Names: ['terraform']"},"skip_prepare_infra":{"title":"skip_prepare_infra","type":"boolean","description":"Skip preparation stage when there are no infrastructure changes. Only used in conjunction with --hook-name."},"event":{"title":"event","type":"string","description":"JSON file containing event data passed to the Lambda function during invoke. If this option is not specified, no event is assumed. Pass in the value '-' to input JSON via stdin"},"no_event":{"title":"no_event","type":"boolean","description":"DEPRECATED: By default no event is assumed.","default":true},"runtime":{"title":"runtime","type":"string","description":"Lambda runtime used to invoke the function.\n\nRuntimes: dotnet8, dotnet6, go1.x, java21, java17, java11, java8.al2, nodejs22.x, nodejs20.x, nodejs18.x, nodejs16.x, provided, provided.al2, provided.al2023, python3.9, python3.8, python3.13, python3.12, python3.11, python3.10, ruby3.4, ruby3.3, ruby3.2","enum":["dotnet6","dotnet8","go1.x","java11","java17","java21","java8.al2","nodejs16.x","nodejs18.x","nodejs20.x","nodejs22.x","provided","provided.al2","provided.al2023","python3.10","python3.11","python3.12","python3.13","python3.8","python3.9","ruby3.2","ruby3.3","ruby3.4"]},"mount_symlinks":{"title":"mount_symlinks","type":"boolean","description":"Specify if symlinks at the top level of the code should be mounted inside the container. Activating this flag could allow access to locations outside of your workspace by using a symbolic link. By default symlinks are not mounted."},"template_file":{"title":"template_file","type":"string","description":"AWS SAM template which references built artifacts for resources in the template. (if applicable)","default":"template.[yaml|yml|json]"},"env_vars":{"title":"env_vars","type":"string","description":"JSON file containing values for Lambda function's environment variables."},"parameter_overrides":{"title":"parameter_overrides","type":["array","string"],"description":"String that contains AWS CloudFormation parameter overrides encoded as key=value pairs.","items":{"type":"string"}},"debug_port":{"title":"debug_port","type":"integer","description":"When specified, Lambda function container will start in debug mode and will expose this port on localhost."},"debugger_path":{"title":"debugger_path","type":"string","description":"Host path to a debugger that will be mounted into the Lambda container."},"debug_args":{"title":"debug_args","type":"string","description":"Additional arguments to be passed to the debugger."},"container_env_vars":{"title":"container_env_vars","type":"string","description":"JSON file containing additional environment variables to be set within the container when used in a debugging session locally."},"docker_volume_basedir":{"title":"docker_volume_basedir","type":"string","description":"Specify the location basedir where the SAM template exists. If Docker is running on a remote machine, Path of the SAM template must be mounted on the Docker machine and modified to match the remote machine."},"log_file":{"title":"log_file","type":"string","description":"File to capture output logs."},"layer_cache_basedir":{"title":"layer_cache_basedir","type":"string","description":"Specify the location basedir where the lambda layers used by the template will be downloaded to."},"skip_pull_image":{"title":"skip_pull_image","type":"boolean","description":"Skip pulling down the latest Docker image for Lambda runtime."},"docker_network":{"title":"docker_network","type":"string","description":"Name or ID of an existing docker network for AWS Lambda docker containers to connect to, along with the default bridge network. If not specified, the Lambda containers will only connect to the default bridge docker network."},"force_image_build":{"title":"force_image_build","type":"boolean","description":"Force rebuilding the image used for invoking functions with layers."},"shutdown":{"title":"shutdown","type":"boolean","description":"Emulate a shutdown event after invoke completes, to test extension handling of shutdown behavior."},"container_host":{"title":"container_host","type":"string","description":"Host of locally emulated Lambda container. This option is useful when the container runs on a different host than AWS SAM CLI. For example, if one wants to run AWS SAM CLI in a Docker container on macOS, this option could specify `host.docker.internal`","default":"localhost"},"container_host_interface":{"title":"container_host_interface","type":"string","description":"IP address of the host network interface that container ports should bind to. Use 0.0.0.0 to bind to all interfaces.","default":"127.0.0.1"},"add_host":{"title":"add_host","type":"array","description":"Passes a hostname to IP address mapping to the Docker container's host file. This parameter can be passed multiple times.Example:--add-host example.com:127.0.0.1","items":{"type":"string"}},"invoke_image":{"title":"invoke_image","type":"string","description":"Container image URIs for invoking functions or starting api and function. One can specify the image URI used for the local function invocation (--invoke-image public.ecr.aws/sam/build-nodejs20.x:latest). One can also specify for each individual function with (--invoke-image Function1=public.ecr.aws/sam/build-nodejs20.x:latest). If a function does not have invoke image specified, the default AWS SAM CLI emulation image will be used."},"no_memory_limit":{"title":"no_memory_limit","type":"boolean","description":"Removes the Memory limit during emulation. With this parameter, the underlying container will run without a --memory parameter"},"beta_features":{"title":"beta_features","type":"boolean","description":"Enable/Disable beta features."},"debug":{"title":"debug","type":"boolean","description":"Turn on debug logging to print debug message generated by AWS SAM CLI and display timestamps."},"profile":{"title":"profile","type":"string","description":"Select a specific profile from your credential file to get AWS credentials."},"region":{"title":"region","type":"string","description":"Set the AWS Region of the service. (e.g. us-east-1)"},"save_params":{"title":"save_params","type":"boolean","description":"Save the parameters provided via the command line to the configuration file."}}}},"required":["parameters"]},"local_start_api":{"title":"Local Start Api command","description":"Run & test AWS serverless functions locally as a HTTP API.","properties":{"parameters":{"title":"Parameters for the local start api command","description":"Available parameters for the local start api command:\n* terraform_plan_file:\nUsed for passing a custom plan file when executing the Terraform hook.\n* hook_name:\nHook package id to extend AWS SAM CLI commands functionality. \n\nExample: `terraform` to extend AWS SAM CLI commands functionality to support terraform applications. \n\nAvailable Hook Names: ['terraform']\n* skip_prepare_infra:\nSkip preparation stage when there are no infrastructure changes. Only used in conjunction with --hook-name.\n* host:\nLocal hostname or IP address to bind to (default: '127.0.0.1')\n* port:\nLocal port number to listen on (default: '3000')\n* static_dir:\nAny static assets (e.g. CSS/Javascript/HTML) files located in this directory will be presented at /\n* disable_authorizer:\nDisable custom Lambda Authorizers from being parsed and invoked.\n* ssl_cert_file:\nPath to SSL certificate file (default: None)\n* ssl_key_file:\nPath to SSL key file (default: None)\n* template_file:\nAWS SAM template which references built artifacts for resources in the template. (if applicable)\n* env_vars:\nJSON file containing values for Lambda function's environment variables.\n* parameter_overrides:\nString that contains AWS CloudFormation parameter overrides encoded as key=value pairs.\n* debug_port:\nWhen specified, Lambda function container will start in debug mode and will expose this port on localhost.\n* debugger_path:\nHost path to a debugger that will be mounted into the Lambda container.\n* debug_args:\nAdditional arguments to be passed to the debugger.\n* container_env_vars:\nJSON file containing additional environment variables to be set within the container when used in a debugging session locally.\n* docker_volume_basedir:\nSpecify the location basedir where the SAM template exists. If Docker is running on a remote machine, Path of the SAM template must be mounted on the Docker machine and modified to match the remote machine.\n* log_file:\nFile to capture output logs.\n* layer_cache_basedir:\nSpecify the location basedir where the lambda layers used by the template will be downloaded to.\n* skip_pull_image:\nSkip pulling down the latest Docker image for Lambda runtime.\n* docker_network:\nName or ID of an existing docker network for AWS Lambda docker containers to connect to, along with the default bridge network. If not specified, the Lambda containers will only connect to the default bridge docker network.\n* force_image_build:\nForce rebuilding the image used for invoking functions with layers.\n* warm_containers:\nOptional. Specifies how AWS SAM CLI manages \ncontainers for each function.\nTwo modes are available:\nEAGER: Containers for all functions are \nloaded at startup and persist between \ninvocations.\nLAZY:  Containers are only loaded when each \nfunction is first invoked. Those containers \npersist for additional invocations.\n* debug_function:\nOptional. Specifies the Lambda Function logicalId to apply debug options to when --warm-containers is specified. This parameter applies to --debug-port, --debugger-path, and --debug-args.\n* shutdown:\nEmulate a shutdown event after invoke completes, to test extension handling of shutdown behavior.\n* container_host:\nHost of locally emulated Lambda container. This option is useful when the container runs on a different host than AWS SAM CLI. For example, if one wants to run AWS SAM CLI in a Docker container on macOS, this option could specify `host.docker.internal`\n* container_host_interface:\nIP address of the host network interface that container ports should bind to. Use 0.0.0.0 to bind to all interfaces.\n* add_host:\nPasses a hostname to IP address mapping to the Docker container's host file. This parameter can be passed multiple times.Example:--add-host example.com:127.0.0.1\n* invoke_image:\nContainer image URIs for invoking functions or starting api and function. One can specify the image URI used for the local function invocation (--invoke-image public.ecr.aws/sam/build-nodejs20.x:latest). One can also specify for each individual function with (--invoke-image Function1=public.ecr.aws/sam/build-nodejs20.x:latest). If a function does not have invoke image specified, the default AWS SAM CLI emulation image will be used.\n* no_memory_limit:\nRemoves the Memory limit during emulation. With this parameter, the underlying container will run without a --memory parameter\n* beta_features:\nEnable/Disable beta features.\n* debug:\nTurn on debug logging to print debug message generated by AWS SAM CLI and display timestamps.\n* profile:\nSelect a specific profile from your credential file to get AWS credentials.\n* region:\nSet the AWS Region of the service. (e.g. us-east-1)\n* save_params:\nSave the parameters provided via the command line to the configuration file.","type":"object","properties":{"terraform_plan_file":{"title":"terraform_plan_file","type":"string","description":"Used for passing a custom plan file when executing the Terraform hook."},"hook_name":{"title":"hook_name","type":"string","description":"Hook package id to extend AWS SAM CLI commands functionality. \n\nExample: `terraform` to extend AWS SAM CLI commands functionality to support terraform applications. \n\nAvailable Hook Names: ['terraform']"},"skip_prepare_infra":{"title":"skip_prepare_infra","type":"boolean","description":"Skip preparation stage when there are no infrastructure changes. Only used in conjunction with --hook-name."},"host":{"title":"host","type":"string","description":"Local hostname or IP address to bind to (default: '127.0.0.1')","default":"127.0.0.1"},"port":{"title":"port","type":"integer","description":"Local port number to listen on (default: '3000')","default":3000},"static_dir":{"title":"static_dir","type":"string","description":"Any static assets (e.g. CSS/Javascript/HTML) files located in this directory will be presented at /","default":"public"},"disable_authorizer":{"title":"disable_authorizer","type":"boolean","description":"Disable custom Lambda Authorizers from being parsed and invoked."},"ssl_cert_file":{"title":"ssl_cert_file","type":"string","description":"Path to SSL certificate file (default: None)"},"ssl_key_file":{"title":"ssl_key_file","type":"string","description":"Path to SSL key file (default: None)"},"template_file":{"title":"template_file","type":"string","description":"AWS SAM template which references built artifacts for resources in the template. (if applicable)","default":"template.[yaml|yml|json]"},"env_vars":{"title":"env_vars","type":"string","description":"JSON file containing values for Lambda function's environment variables."},"parameter_overrides":{"title":"parameter_overrides","type":["array","string"],"description":"String that contains AWS CloudFormation parameter overrides encoded as key=value pairs.","items":{"type":"string"}},"debug_port":{"title":"debug_port","type":"integer","description":"When specified, Lambda function container will start in debug mode and will expose this port on localhost."},"debugger_path":{"title":"debugger_path","type":"string","description":"Host path to a debugger that will be mounted into the Lambda container."},"debug_args":{"title":"debug_args","type":"string","description":"Additional arguments to be passed to the debugger."},"container_env_vars":{"title":"container_env_vars","type":"string","description":"JSON file containing additional environment variables to be set within the container when used in a debugging session locally."},"docker_volume_basedir":{"title":"docker_volume_basedir","type":"string","description":"Specify the location basedir where the SAM template exists. If Docker is running on a remote machine, Path of the SAM template must be mounted on the Docker machine and modified to match the remote machine."},"log_file":{"title":"log_file","type":"string","description":"File to capture output logs."},"layer_cache_basedir":{"title":"layer_cache_basedir","type":"string","description":"Specify the location basedir where the lambda layers used by the template will be downloaded to."},"skip_pull_image":{"title":"skip_pull_image","type":"boolean","description":"Skip pulling down the latest Docker image for Lambda runtime."},"docker_network":{"title":"docker_network","type":"string","description":"Name or ID of an existing docker network for AWS Lambda docker containers to connect to, along with the default bridge network. If not specified, the Lambda containers will only connect to the default bridge docker network."},"force_image_build":{"title":"force_image_build","type":"boolean","description":"Force rebuilding the image used for invoking functions with layers."},"warm_containers":{"title":"warm_containers","type":"string","description":"Optional. Specifies how AWS SAM CLI manages \ncontainers for each function.\nTwo modes are available:\nEAGER: Containers for all functions are \nloaded at startup and persist between \ninvocations.\nLAZY:  Containers are only loaded when each \nfunction is first invoked. Those containers \npersist for additional invocations.","enum":["EAGER","LAZY"]},"debug_function":{"title":"debug_function","type":"string","description":"Optional. Specifies the Lambda Function logicalId to apply debug options to when --warm-containers is specified. This parameter applies to --debug-port, --debugger-path, and --debug-args."},"shutdown":{"title":"shutdown","type":"boolean","description":"Emulate a shutdown event after invoke completes, to test extension handling of shutdown behavior."},"container_host":{"title":"container_host","type":"string","description":"Host of locally emulated Lambda container. This option is useful when the container runs on a different host than AWS SAM CLI. For example, if one wants to run AWS SAM CLI in a Docker container on macOS, this option could specify `host.docker.internal`","default":"localhost"},"container_host_interface":{"title":"container_host_interface","type":"string","description":"IP address of the host network interface that container ports should bind to. Use 0.0.0.0 to bind to all interfaces.","default":"127.0.0.1"},"add_host":{"title":"add_host","type":"array","description":"Passes a hostname to IP address mapping to the Docker container's host file. This parameter can be passed multiple times.Example:--add-host example.com:127.0.0.1","items":{"type":"string"}},"invoke_image":{"title":"invoke_image","type":"string","description":"Container image URIs for invoking functions or starting api and function. One can specify the image URI used for the local function invocation (--invoke-image public.ecr.aws/sam/build-nodejs20.x:latest). One can also specify for each individual function with (--invoke-image Function1=public.ecr.aws/sam/build-nodejs20.x:latest). If a function does not have invoke image specified, the default AWS SAM CLI emulation image will be used."},"no_memory_limit":{"title":"no_memory_limit","type":"boolean","description":"Removes the Memory limit during emulation. With this parameter, the underlying container will run without a --memory parameter"},"beta_features":{"title":"beta_features","type":"boolean","description":"Enable/Disable beta features."},"debug":{"title":"debug","type":"boolean","description":"Turn on debug logging to print debug message generated by AWS SAM CLI and display timestamps."},"profile":{"title":"profile","type":"string","description":"Select a specific profile from your credential file to get AWS credentials."},"region":{"title":"region","type":"string","description":"Set the AWS Region of the service. (e.g. us-east-1)"},"save_params":{"title":"save_params","type":"boolean","description":"Save the parameters provided via the command line to the configuration file."}}}},"required":["parameters"]},"local_generate_event":{"title":"Local Generate Event command","description":"Generate events for Lambda functions.","properties":{"parameters":{"title":"Parameters for the local generate event command","description":"Available parameters for the local generate event command:\n* ","type":"object","properties":{}}},"required":["parameters"]},"local_start_lambda":{"title":"Local Start Lambda command","description":"Emulate AWS serverless functions locally.","properties":{"parameters":{"title":"Parameters for the local start lambda command","description":"Available parameters for the local start lambda command:\n* terraform_plan_file:\nUsed for passing a custom plan file when executing the Terraform hook.\n* hook_name:\nHook package id to extend AWS SAM CLI commands functionality. \n\nExample: `terraform` to extend AWS SAM CLI commands functionality to support terraform applications. \n\nAvailable Hook Names: ['terraform']\n* skip_prepare_infra:\nSkip preparation stage when there are no infrastructure changes. Only used in conjunction with --hook-name.\n* host:\nLocal hostname or IP address to bind to (default: '127.0.0.1')\n* port:\nLocal port number to listen on (default: '3001')\n* template_file:\nAWS SAM template which references built artifacts for resources in the template. (if applicable)\n* env_vars:\nJSON file containing values for Lambda function's environment variables.\n* parameter_overrides:\nString that contains AWS CloudFormation parameter overrides encoded as key=value pairs.\n* debug_port:\nWhen specified, Lambda function container will start in debug mode and will expose this port on localhost.\n* debugger_path:\nHost path to a debugger that will be mounted into the Lambda container.\n* debug_args:\nAdditional arguments to be passed to the debugger.\n* container_env_vars:\nJSON file containing additional environment variables to be set within the container when used in a debugging session locally.\n* docker_volume_basedir:\nSpecify the location basedir where the SAM template exists. If Docker is running on a remote machine, Path of the SAM template must be mounted on the Docker machine and modified to match the remote machine.\n* log_file:\nFile to capture output logs.\n* layer_cache_basedir:\nSpecify the location basedir where the lambda layers used by the template will be downloaded to.\n* skip_pull_image:\nSkip pulling down the latest Docker image for Lambda runtime.\n* docker_network:\nName or ID of an existing docker network for AWS Lambda docker containers to connect to, along with the default bridge network. If not specified, the Lambda containers will only connect to the default bridge docker network.\n* force_image_build:\nForce rebuilding the image used for invoking functions with layers.\n* warm_containers:\nOptional. Specifies how AWS SAM CLI manages \ncontainers for each function.\nTwo modes are available:\nEAGER: Containers for all functions are \nloaded at startup and persist between \ninvocations.\nLAZY:  Containers are only loaded when each \nfunction is first invoked. Those containers \npersist for additional invocations.\n* debug_function:\nOptional. Specifies the Lambda Function logicalId to apply debug options to when --warm-containers is specified. This parameter applies to --debug-port, --debugger-path, and --debug-args.\n* shutdown:\nEmulate a shutdown event after invoke completes, to test extension handling of shutdown behavior.\n* container_host:\nHost of locally emulated Lambda container. This option is useful when the container runs on a different host than AWS SAM CLI. For example, if one wants to run AWS SAM CLI in a Docker container on macOS, this option could specify `host.docker.internal`\n* container_host_interface:\nIP address of the host network interface that container ports should bind to. Use 0.0.0.0 to bind to all interfaces.\n* add_host:\nPasses a hostname to IP address mapping to the Docker container's host file. This parameter can be passed multiple times.Example:--add-host example.com:127.0.0.1\n* invoke_image:\nContainer image URIs for invoking functions or starting api and function. One can specify the image URI used for the local function invocation (--invoke-image public.ecr.aws/sam/build-nodejs20.x:latest). One can also specify for each individual function with (--invoke-image Function1=public.ecr.aws/sam/build-nodejs20.x:latest). If a function does not have invoke image specified, the default AWS SAM CLI emulation image will be used.\n* no_memory_limit:\nRemoves the Memory limit during emulation. With this parameter, the underlying container will run without a --memory parameter\n* beta_features:\nEnable/Disable beta features.\n* debug:\nTurn on debug logging to print debug message generated by AWS SAM CLI and display timestamps.\n* profile:\nSelect a specific profile from your credential file to get AWS credentials.\n* region:\nSet the AWS Region of the service. (e.g. us-east-1)\n* save_params:\nSave the parameters provided via the command line to the configuration file.","type":"object","properties":{"terraform_plan_file":{"title":"terraform_plan_file","type":"string","description":"Used for passing a custom plan file when executing the Terraform hook."},"hook_name":{"title":"hook_name","type":"string","description":"Hook package id to extend AWS SAM CLI commands functionality. \n\nExample: `terraform` to extend AWS SAM CLI commands functionality to support terraform applications. \n\nAvailable Hook Names: ['terraform']"},"skip_prepare_infra":{"title":"skip_prepare_infra","type":"boolean","description":"Skip preparation stage when there are no infrastructure changes. Only used in conjunction with --hook-name."},"host":{"title":"host","type":"string","description":"Local hostname or IP address to bind to (default: '127.0.0.1')","default":"127.0.0.1"},"port":{"title":"port","type":"integer","description":"Local port number to listen on (default: '3001')","default":3001},"template_file":{"title":"template_file","type":"string","description":"AWS SAM template which references built artifacts for resources in the template. (if applicable)","default":"template.[yaml|yml|json]"},"env_vars":{"title":"env_vars","type":"string","description":"JSON file containing values for Lambda function's environment variables."},"parameter_overrides":{"title":"parameter_overrides","type":["array","string"],"description":"String that contains AWS CloudFormation parameter overrides encoded as key=value pairs.","items":{"type":"string"}},"debug_port":{"title":"debug_port","type":"integer","description":"When specified, Lambda function container will start in debug mode and will expose this port on localhost."},"debugger_path":{"title":"debugger_path","type":"string","description":"Host path to a debugger that will be mounted into the Lambda container."},"debug_args":{"title":"debug_args","type":"string","description":"Additional arguments to be passed to the debugger."},"container_env_vars":{"title":"container_env_vars","type":"string","description":"JSON file containing additional environment variables to be set within the container when used in a debugging session locally."},"docker_volume_basedir":{"title":"docker_volume_basedir","type":"string","description":"Specify the location basedir where the SAM template exists. If Docker is running on a remote machine, Path of the SAM template must be mounted on the Docker machine and modified to match the remote machine."},"log_file":{"title":"log_file","type":"string","description":"File to capture output logs."},"layer_cache_basedir":{"title":"layer_cache_basedir","type":"string","description":"Specify the location basedir where the lambda layers used by the template will be downloaded to."},"skip_pull_image":{"title":"skip_pull_image","type":"boolean","description":"Skip pulling down the latest Docker image for Lambda runtime."},"docker_network":{"title":"docker_network","type":"string","description":"Name or ID of an existing docker network for AWS Lambda docker containers to connect to, along with the default bridge network. If not specified, the Lambda containers will only connect to the default bridge docker network."},"force_image_build":{"title":"force_image_build","type":"boolean","description":"Force rebuilding the image used for invoking functions with layers."},"warm_containers":{"title":"warm_containers","type":"string","description":"Optional. Specifies how AWS SAM CLI manages \ncontainers for each function.\nTwo modes are available:\nEAGER: Containers for all functions are \nloaded at startup and persist between \ninvocations.\nLAZY:  Containers are only loaded when each \nfunction is first invoked. Those containers \npersist for additional invocations.","enum":["EAGER","LAZY"]},"debug_function":{"title":"debug_function","type":"string","description":"Optional. Specifies the Lambda Function logicalId to apply debug options to when --warm-containers is specified. This parameter applies to --debug-port, --debugger-path, and --debug-args."},"shutdown":{"title":"shutdown","type":"boolean","description":"Emulate a shutdown event after invoke completes, to test extension handling of shutdown behavior."},"container_host":{"title":"container_host","type":"string","description":"Host of locally emulated Lambda container. This option is useful when the container runs on a different host than AWS SAM CLI. For example, if one wants to run AWS SAM CLI in a Docker container on macOS, this option could specify `host.docker.internal`","default":"localhost"},"container_host_interface":{"title":"container_host_interface","type":"string","description":"IP address of the host network interface that container ports should bind to. Use 0.0.0.0 to bind to all interfaces.","default":"127.0.0.1"},"add_host":{"title":"add_host","type":"array","description":"Passes a hostname to IP address mapping to the Docker container's host file. This parameter can be passed multiple times.Example:--add-host example.com:127.0.0.1","items":{"type":"string"}},"invoke_image":{"title":"invoke_image","type":"string","description":"Container image URIs for invoking functions or starting api and function. One can specify the image URI used for the local function invocation (--invoke-image public.ecr.aws/sam/build-nodejs20.x:latest). One can also specify for each individual function with (--invoke-image Function1=public.ecr.aws/sam/build-nodejs20.x:latest). If a function does not have invoke image specified, the default AWS SAM CLI emulation image will be used."},"no_memory_limit":{"title":"no_memory_limit","type":"boolean","description":"Removes the Memory limit during emulation. With this parameter, the underlying container will run without a --memory parameter"},"beta_features":{"title":"beta_features","type":"boolean","description":"Enable/Disable beta features."},"debug":{"title":"debug","type":"boolean","description":"Turn on debug logging to print debug message generated by AWS SAM CLI and display timestamps."},"profile":{"title":"profile","type":"string","description":"Select a specific profile from your credential file to get AWS credentials."},"region":{"title":"region","type":"string","description":"Set the AWS Region of the service. (e.g. us-east-1)"},"save_params":{"title":"save_params","type":"boolean","description":"Save the parameters provided via the command line to the configuration file."}}}},"required":["parameters"]},"package":{"title":"Package command","description":"Package an AWS SAM application.","properties":{"parameters":{"title":"Parameters for the package command","description":"Available parameters for the package command:\n* template_file:\nAWS SAM template which references built artifacts for resources in the template. (if applicable)\n* output_template_file:\nThe path to the file where the command writes the output AWS CloudFormation template. If you don't specify a path, the command writes the template to the standard output.\n* s3_bucket:\nAWS S3 bucket where artifacts referenced in the template are uploaded.\n* image_repository:\nAWS ECR repository URI where artifacts referenced in the template are uploaded.\n* image_repositories:\nMapping of Function Logical ID to AWS ECR Repository URI.\n\nExample: Function_Logical_ID=ECR_Repo_Uri\nThis option can be specified multiple times.\n* s3_prefix:\nPrefix name that is added to the artifact's name when it is uploaded to the AWS S3 bucket.\n* kms_key_id:\nThe ID of an AWS KMS key that is used to encrypt artifacts that are at rest in the AWS S3 bucket.\n* use_json:\nIndicates whether to use JSON as the format for the output AWS CloudFormation template. YAML is used by default.\n* force_upload:\nIndicates whether to override existing files in the S3 bucket. Specify this flag to upload artifacts even if they match existing artifacts in the S3 bucket.\n* resolve_s3:\nAutomatically resolve AWS S3 bucket for non-guided deployments. Enabling this option will also create a managed default AWS S3 bucket for you. If one does not provide a --s3-bucket value, the managed bucket will be used. Do not use --guided with this option.\n* metadata:\nMap of metadata to attach to ALL the artifacts that are referenced in the template.\n* signing_profiles:\nA string that contains Code Sign configuration parameters as FunctionOrLayerNameToSign=SigningProfileName:SigningProfileOwner Since signing profile owner is optional, it could also be written as FunctionOrLayerNameToSign=SigningProfileName\n* no_progressbar:\nDoes not showcase a progress bar when uploading artifacts to S3 and pushing docker images to ECR\n* beta_features:\nEnable/Disable beta features.\n* debug:\nTurn on debug logging to print debug message generated by AWS SAM CLI and display timestamps.\n* profile:\nSelect a specific profile from your credential file to get AWS credentials.\n* region:\nSet the AWS Region of the service. (e.g. us-east-1)\n* save_params:\nSave the parameters provided via the command line to the configuration file.","type":"object","properties":{"template_file":{"title":"template_file","type":"string","description":"AWS SAM template which references built artifacts for resources in the template. (if applicable)","default":"template.[yaml|yml|json]"},"output_template_file":{"title":"output_template_file","type":"string","description":"The path to the file where the command writes the output AWS CloudFormation template. If you don't specify a path, the command writes the template to the standard output."},"s3_bucket":{"title":"s3_bucket","type":"string","description":"AWS S3 bucket where artifacts referenced in the template are uploaded."},"image_repository":{"title":"image_repository","type":"string","description":"AWS ECR repository URI where artifacts referenced in the template are uploaded."},"image_repositories":{"title":"image_repositories","type":"array","description":"Mapping of Function Logical ID to AWS ECR Repository URI.\n\nExample: Function_Logical_ID=ECR_Repo_Uri\nThis option can be specified multiple times.","items":{"type":"string"}},"s3_prefix":{"title":"s3_prefix","type":"string","description":"Prefix name that is added to the artifact's name when it is uploaded to the AWS S3 bucket."},"kms_key_id":{"title":"kms_key_id","type":"string","description":"The ID of an AWS KMS key that is used to encrypt artifacts that are at rest in the AWS S3 bucket."},"use_json":{"title":"use_json","type":"boolean","description":"Indicates whether to use JSON as the format for the output AWS CloudFormation template. YAML is used by default."},"force_upload":{"title":"force_upload","type":"boolean","description":"Indicates whether to override existing files in the S3 bucket. Specify this flag to upload artifacts even if they match existing artifacts in the S3 bucket."},"resolve_s3":{"title":"resolve_s3","type":"boolean","description":"Automatically resolve AWS S3 bucket for non-guided deployments. Enabling this option will also create a managed default AWS S3 bucket for you. If one does not provide a --s3-bucket value, the managed bucket will be used. Do not use --guided with this option."},"metadata":{"title":"metadata","type":"string","description":"Map of metadata to attach to ALL the artifacts that are referenced in the template."},"signing_profiles":{"title":"signing_profiles","type":"string","description":"A string that contains Code Sign configuration parameters as FunctionOrLayerNameToSign=SigningProfileName:SigningProfileOwner Since signing profile owner is optional, it could also be written as FunctionOrLayerNameToSign=SigningProfileName"},"no_progressbar":{"title":"no_progressbar","type":"boolean","description":"Does not showcase a progress bar when uploading artifacts to S3 and pushing docker images to ECR"},"beta_features":{"title":"beta_features","type":"boolean","description":"Enable/Disable beta features."},"debug":{"title":"debug","type":"boolean","description":"Turn on debug logging to print debug message generated by AWS SAM CLI and display timestamps."},"profile":{"title":"profile","type":"string","description":"Select a specific profile from your credential file to get AWS credentials."},"region":{"title":"region","type":"string","description":"Set the AWS Region of the service. (e.g. us-east-1)"},"save_params":{"title":"save_params","type":"boolean","description":"Save the parameters provided via the command line to the configuration file."}}}},"required":["parameters"]},"deploy":{"title":"Deploy command","description":"The sam deploy command creates a Cloudformation Stack and deploys your resources.","properties":{"parameters":{"title":"Parameters for the deploy command","description":"Available parameters for the deploy command:\n* guided:\nSpecify this flag to allow SAM CLI to guide you through the deployment using guided prompts.\n* template_file:\nAWS SAM template which references built artifacts for resources in the template. (if applicable)\n* no_execute_changeset:\nIndicates whether to execute the change set. Specify this flag to view stack changes before executing the change set.\n* fail_on_empty_changeset:\nSpecify whether AWS SAM CLI should return a non-zero exit code if there are no changes to be made to the stack. Defaults to a non-zero exit code.\n* confirm_changeset:\nPrompt to confirm if the computed changeset is to be deployed by SAM CLI.\n* disable_rollback:\nPreserves the state of previously provisioned resources when an operation fails.\n* on_failure:\nProvide an action to determine what will happen when a stack fails to create. Three actions are available:\n\n- ROLLBACK: This will rollback a stack to a previous known good state.\n\n- DELETE: The stack will rollback to a previous state if one exists, otherwise the stack will be deleted.\n\n- DO_NOTHING: The stack will not rollback or delete, this is the same as disabling rollback.\n\nDefault behaviour is ROLLBACK.\n\n\n\nThis option is mutually exclusive with --disable-rollback/--no-disable-rollback. You can provide\n--on-failure or --disable-rollback/--no-disable-rollback but not both at the same time.\n* max_wait_duration:\nMaximum duration in minutes to wait for the deployment to complete.\n* stack_name:\nName of the AWS CloudFormation stack.\n* s3_bucket:\nAWS S3 bucket where artifacts referenced in the template are uploaded.\n* image_repository:\nAWS ECR repository URI where artifacts referenced in the template are uploaded.\n* image_repositories:\nMapping of Function Logical ID to AWS ECR Repository URI.\n\nExample: Function_Logical_ID=ECR_Repo_Uri\nThis option can be specified multiple times.\n* force_upload:\nIndicates whether to override existing files in the S3 bucket. Specify this flag to upload artifacts even if they match existing artifacts in the S3 bucket.\n* s3_prefix:\nPrefix name that is added to the artifact's name when it is uploaded to the AWS S3 bucket.\n* kms_key_id:\nThe ID of an AWS KMS key that is used to encrypt artifacts that are at rest in the AWS S3 bucket.\n* role_arn:\nARN of an IAM role that AWS Cloudformation assumes when executing a deployment change set.\n* use_json:\nIndicates whether to use JSON as the format for the output AWS CloudFormation template. YAML is used by default.\n* resolve_s3:\nAutomatically resolve AWS S3 bucket for non-guided deployments. Enabling this option will also create a managed default AWS S3 bucket for you. If one does not provide a --s3-bucket value, the managed bucket will be used. Do not use --guided with this option.\n* resolve_image_repos:\nAutomatically create and delete ECR repositories for image-based functions in non-guided deployments. A companion stack containing ECR repos for each function will be deployed along with the template stack. Automatically created image repositories will be deleted if the corresponding functions are removed.\n* metadata:\nMap of metadata to attach to ALL the artifacts that are referenced in the template.\n* notification_arns:\nARNs of SNS topics that AWS Cloudformation associates with the stack.\n* tags:\nList of tags to associate with the stack.\n* parameter_overrides:\nString that contains AWS CloudFormation parameter overrides encoded as key=value pairs.\n* signing_profiles:\nA string that contains Code Sign configuration parameters as FunctionOrLayerNameToSign=SigningProfileName:SigningProfileOwner Since signing profile owner is optional, it could also be written as FunctionOrLayerNameToSign=SigningProfileName\n* no_progressbar:\nDoes not showcase a progress bar when uploading artifacts to S3 and pushing docker images to ECR\n* capabilities:\nList of capabilities that one must specify before AWS Cloudformation can create certain stacks.\n\nAccepted Values: CAPABILITY_IAM, CAPABILITY_NAMED_IAM, CAPABILITY_RESOURCE_POLICY, CAPABILITY_AUTO_EXPAND.\n\nLearn more at: https://docs.aws.amazon.com/serverlessrepo/latest/devguide/acknowledging-application-capabilities.html\n* profile:\nSelect a specific profile from your credential file to get AWS credentials.\n* region:\nSet the AWS Region of the service. (e.g. us-east-1)\n* beta_features:\nEnable/Disable beta features.\n* debug:\nTurn on debug logging to print debug message generated by AWS SAM CLI and display timestamps.\n* save_params:\nSave the parameters provided via the command line to the configuration file.","type":"object","properties":{"guided":{"title":"guided","type":"boolean","description":"Specify this flag to allow SAM CLI to guide you through the deployment using guided prompts."},"template_file":{"title":"template_file","type":"string","description":"AWS SAM template which references built artifacts for resources in the template. (if applicable)","default":"template.[yaml|yml|json]"},"no_execute_changeset":{"title":"no_execute_changeset","type":"boolean","description":"Indicates whether to execute the change set. Specify this flag to view stack changes before executing the change set."},"fail_on_empty_changeset":{"title":"fail_on_empty_changeset","type":"boolean","description":"Specify whether AWS SAM CLI should return a non-zero exit code if there are no changes to be made to the stack. Defaults to a non-zero exit code.","default":true},"confirm_changeset":{"title":"confirm_changeset","type":"boolean","description":"Prompt to confirm if the computed changeset is to be deployed by SAM CLI."},"disable_rollback":{"title":"disable_rollback","type":"boolean","description":"Preserves the state of previously provisioned resources when an operation fails."},"on_failure":{"title":"on_failure","type":"string","description":"Provide an action to determine what will happen when a stack fails to create. Three actions are available:\n\n- ROLLBACK: This will rollback a stack to a previous known good state.\n\n- DELETE: The stack will rollback to a previous state if one exists, otherwise the stack will be deleted.\n\n- DO_NOTHING: The stack will not rollback or delete, this is the same as disabling rollback.\n\nDefault behaviour is ROLLBACK.\n\n\n\nThis option is mutually exclusive with --disable-rollback/--no-disable-rollback. You can provide\n--on-failure or --disable-rollback/--no-disable-rollback but not both at the same time.","default":"ROLLBACK","enum":["DELETE","DO_NOTHING","ROLLBACK"]},"max_wait_duration":{"title":"max_wait_duration","type":"integer","description":"Maximum duration in minutes to wait for the deployment to complete.","default":60},"stack_name":{"title":"stack_name","type":"string","description":"Name of the AWS CloudFormation stack."},"s3_bucket":{"title":"s3_bucket","type":"string","description":"AWS S3 bucket where artifacts referenced in the template are uploaded."},"image_repository":{"title":"image_repository","type":"string","description":"AWS ECR repository URI where artifacts referenced in the template are uploaded."},"image_repositories":{"title":"image_repositories","type":"array","description":"Mapping of Function Logical ID to AWS ECR Repository URI.\n\nExample: Function_Logical_ID=ECR_Repo_Uri\nThis option can be specified multiple times.","items":{"type":"string"}},"force_upload":{"title":"force_upload","type":"boolean","description":"Indicates whether to override existing files in the S3 bucket. Specify this flag to upload artifacts even if they match existing artifacts in the S3 bucket."},"s3_prefix":{"title":"s3_prefix","type":"string","description":"Prefix name that is added to the artifact's name when it is uploaded to the AWS S3 bucket."},"kms_key_id":{"title":"kms_key_id","type":"string","description":"The ID of an AWS KMS key that is used to encrypt artifacts that are at rest in the AWS S3 bucket."},"role_arn":{"title":"role_arn","type":"string","description":"ARN of an IAM role that AWS Cloudformation assumes when executing a deployment change set."},"use_json":{"title":"use_json","type":"boolean","description":"Indicates whether to use JSON as the format for the output AWS CloudFormation template. YAML is used by default."},"resolve_s3":{"title":"resolve_s3","type":"boolean","description":"Automatically resolve AWS S3 bucket for non-guided deployments. Enabling this option will also create a managed default AWS S3 bucket for you. If one does not provide a --s3-bucket value, the managed bucket will be used. Do not use --guided with this option."},"resolve_image_repos":{"title":"resolve_image_repos","type":"boolean","description":"Automatically create and delete ECR repositories for image-based functions in non-guided deployments. A companion stack containing ECR repos for each function will be deployed along with the template stack. Automatically created image repositories will be deleted if the corresponding functions are removed."},"metadata":{"title":"metadata","type":"string","description":"Map of metadata to attach to ALL the artifacts that are referenced in the template."},"notification_arns":{"title":"notification_arns","type":["array","string"],"description":"ARNs of SNS topics that AWS Cloudformation associates with the stack.","items":{"type":"string"}},"tags":{"title":"tags","type":["array","string"],"description":"List of tags to associate with the stack.","items":{"type":"string"}},"parameter_overrides":{"title":"parameter_overrides","type":["array","string"],"description":"String that contains AWS CloudFormation parameter overrides encoded as key=value pairs.","items":{"type":"string"}},"signing_profiles":{"title":"signing_profiles","type":"string","description":"A string that contains Code Sign configuration parameters as FunctionOrLayerNameToSign=SigningProfileName:SigningProfileOwner Since signing profile owner is optional, it could also be written as FunctionOrLayerNameToSign=SigningProfileName"},"no_progressbar":{"title":"no_progressbar","type":"boolean","description":"Does not showcase a progress bar when uploading artifacts to S3 and pushing docker images to ECR"},"capabilities":{"title":"capabilities","type":["array","string"],"description":"List of capabilities that one must specify before AWS Cloudformation can create certain stacks.\n\nAccepted Values: CAPABILITY_IAM, CAPABILITY_NAMED_IAM, CAPABILITY_RESOURCE_POLICY, CAPABILITY_AUTO_EXPAND.\n\nLearn more at: https://docs.aws.amazon.com/serverlessrepo/latest/devguide/acknowledging-application-capabilities.html","items":{"type":"string"}},"profile":{"title":"profile","type":"string","description":"Select a specific profile from your credential file to get AWS credentials."},"region":{"title":"region","type":"string","description":"Set the AWS Region of the service. (e.g. us-east-1)"},"beta_features":{"title":"beta_features","type":"boolean","description":"Enable/Disable beta features."},"debug":{"title":"debug","type":"boolean","description":"Turn on debug logging to print debug message generated by AWS SAM CLI and display timestamps."},"save_params":{"title":"save_params","type":"boolean","description":"Save the parameters provided via the command line to the configuration file."}}}},"required":["parameters"]},"delete":{"title":"Delete command","description":"The sam delete command deletes the CloudFormation\nstack and all the artifacts which were created using sam deploy.","properties":{"parameters":{"title":"Parameters for the delete command","description":"Available parameters for the delete command:\n* stack_name:\nThe name of the AWS CloudFormation stack you want to delete.\n* no_prompts:\nSpecify this flag to allow SAM CLI to skip through the guided prompts.\n* s3_bucket:\nThe S3 bucket path you want to delete.\n* s3_prefix:\nThe S3 prefix you want to delete\n* profile:\nSelect a specific profile from your credential file to get AWS credentials.\n* region:\nSet the AWS Region of the service. (e.g. us-east-1)\n* beta_features:\nEnable/Disable beta features.\n* debug:\nTurn on debug logging to print debug message generated by AWS SAM CLI and display timestamps.\n* save_params:\nSave the parameters provided via the command line to the configuration file.","type":"object","properties":{"stack_name":{"title":"stack_name","type":"string","description":"The name of the AWS CloudFormation stack you want to delete."},"no_prompts":{"title":"no_prompts","type":"boolean","description":"Specify this flag to allow SAM CLI to skip through the guided prompts."},"s3_bucket":{"title":"s3_bucket","type":"string","description":"The S3 bucket path you want to delete."},"s3_prefix":{"title":"s3_prefix","type":"string","description":"The S3 prefix you want to delete"},"profile":{"title":"profile","type":"string","description":"Select a specific profile from your credential file to get AWS credentials."},"region":{"title":"region","type":"string","description":"Set the AWS Region of the service. (e.g. us-east-1)"},"beta_features":{"title":"beta_features","type":"boolean","description":"Enable/Disable beta features."},"debug":{"title":"debug","type":"boolean","description":"Turn on debug logging to print debug message generated by AWS SAM CLI and display timestamps."},"save_params":{"title":"save_params","type":"boolean","description":"Save the parameters provided via the command line to the configuration file."}}}},"required":["parameters"]},"logs":{"title":"Logs command","description":"The sam logs commands fetches logs of Lambda Functions/CloudWatch log groups\nwith additional filtering by options.","properties":{"parameters":{"title":"Parameters for the logs command","description":"Available parameters for the logs command:\n* name:\nThe name of the resource for which to fetch logs. If this resource is a part of an AWS CloudFormation stack, this can be the LogicalID of the resource in the CloudFormation/SAM template. Multiple names can be provided by repeating the parameter again. If resource is in a nested stack, name can be prepended by nested stack name to pull logs from that resource (NestedStackLogicalId/ResourceLogicalId). If it is not provided and no --cw-log-group have been given, it will scan given stack and find all supported resources, and start pulling log information from them.\n* stack_name:\nName of the AWS CloudFormation stack that the function is a part of.\n* filter:\nYou can specify an expression to quickly find logs that match terms, phrases or values in your log events. This could be a simple keyword (e.g. \"error\") or a pattern supported by AWS CloudWatch Logs. See the AWS CloudWatch Logs documentation for the syntax https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/FilterAndPatternSyntax.html\n* tail:\nTail events. This will ignore the end time argument and continue to fetch events as they become available. If option --tail is provided without a --name, one will be pulled from all possible resources\n* include_traces:\nInclude the XRay traces in the log output.\n* cw_log_group:\nAdditional CloudWatch Log group names that are not auto-discovered based upon --name parameter. When provided, it will only tail the given CloudWatch Log groups. If you want to tail log groups related to resources, please also provide their names as well\n* output:\nThe formatting style of the command output. Following options are available:\n\nTEXT: Prints information as regular text with some formatting (default option)\n\nJSON: Prints each line as JSON without formatting\n* end_time:\nFetch events up to this time. Time can be relative values like '5mins ago', 'tomorrow' or formatted timestamp like '2018-01-01 10:10:10'\n* start_time:\nFetch events starting at this time. Time can be relative values like '5mins ago', 'yesterday' or formatted timestamp like '2018-01-01 10:10:10'. Defaults to '10mins ago'.\n* beta_features:\nEnable/Disable beta features.\n* debug:\nTurn on debug logging to print debug message generated by AWS SAM CLI and display timestamps.\n* profile:\nSelect a specific profile from your credential file to get AWS credentials.\n* region:\nSet the AWS Region of the service. (e.g. us-east-1)\n* save_params:\nSave the parameters provided via the command line to the configuration file.","type":"object","properties":{"name":{"title":"name","type":"string","description":"The name of the resource for which to fetch logs. If this resource is a part of an AWS CloudFormation stack, this can be the LogicalID of the resource in the CloudFormation/SAM template. Multiple names can be provided by repeating the parameter again. If resource is in a nested stack, name can be prepended by nested stack name to pull logs from that resource (NestedStackLogicalId/ResourceLogicalId). If it is not provided and no --cw-log-group have been given, it will scan given stack and find all supported resources, and start pulling log information from them."},"stack_name":{"title":"stack_name","type":"string","description":"Name of the AWS CloudFormation stack that the function is a part of."},"filter":{"title":"filter","type":"string","description":"You can specify an expression to quickly find logs that match terms, phrases or values in your log events. This could be a simple keyword (e.g. \"error\") or a pattern supported by AWS CloudWatch Logs. See the AWS CloudWatch Logs documentation for the syntax https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/FilterAndPatternSyntax.html"},"tail":{"title":"tail","type":"boolean","description":"Tail events. This will ignore the end time argument and continue to fetch events as they become available. If option --tail is provided without a --name, one will be pulled from all possible resources"},"include_traces":{"title":"include_traces","type":"boolean","description":"Include the XRay traces in the log output."},"cw_log_group":{"title":"cw_log_group","type":"string","description":"Additional CloudWatch Log group names that are not auto-discovered based upon --name parameter. When provided, it will only tail the given CloudWatch Log groups. If you want to tail log groups related to resources, please also provide their names as well"},"output":{"title":"output","type":"string","description":"The formatting style of the command output. Following options are available:\n\nTEXT: Prints information as regular text with some formatting (default option)\n\nJSON: Prints each line as JSON without formatting","enum":["json","text"]},"end_time":{"title":"end_time","type":"string","description":"Fetch events up to this time. Time can be relative values like '5mins ago', 'tomorrow' or formatted timestamp like '2018-01-01 10:10:10'"},"start_time":{"title":"start_time","type":"string","description":"Fetch events starting at this time. Time can be relative values like '5mins ago', 'yesterday' or formatted timestamp like '2018-01-01 10:10:10'. Defaults to '10mins ago'.","default":"10m ago"},"beta_features":{"title":"beta_features","type":"boolean","description":"Enable/Disable beta features."},"debug":{"title":"debug","type":"boolean","description":"Turn on debug logging to print debug message generated by AWS SAM CLI and display timestamps."},"profile":{"title":"profile","type":"string","description":"Select a specific profile from your credential file to get AWS credentials."},"region":{"title":"region","type":"string","description":"Set the AWS Region of the service. (e.g. us-east-1)"},"save_params":{"title":"save_params","type":"boolean","description":"Save the parameters provided via the command line to the configuration file."}}}},"required":["parameters"]},"publish":{"title":"Publish command","description":"Use this command to publish a packaged AWS SAM template to\nthe AWS Serverless Application Repository to share within your team,\nacross your organization, or with the community at large.\n\n\nThis command expects the template's Metadata section to contain an\nAWS::ServerlessRepo::Application section with application metadata\nfor publishing. For more details on this metadata section, see\nhttps://docs.aws.amazon.com/serverless-application-model/latest/developerguide/serverless-sam-template-publishing-applications.html\n\nExamples\n--------\nTo publish an application\n$ sam publish -t packaged.yaml --region <region>","properties":{"parameters":{"title":"Parameters for the publish command","description":"Available parameters for the publish command:\n* template_file:\nAWS SAM template which references built artifacts for resources in the template. (if applicable)\n* semantic_version:\nOptional. The value provided here overrides SemanticVersion in the template metadata.\n* fail_on_same_version:\nIf set, AWS SAM CLI will prevent a publish and return a non-zero exit code\nif the publish is attempted with a semantic version that already exists on the SAR application.\nDefault is False.\n* profile:\nSelect a specific profile from your credential file to get AWS credentials.\n* region:\nSet the AWS Region of the service. (e.g. us-east-1)\n* beta_features:\nEnable/Disable beta features.\n* debug:\nTurn on debug logging to print debug message generated by AWS SAM CLI and display timestamps.\n* save_params:\nSave the parameters provided via the command line to the configuration file.","type":"object","properties":{"template_file":{"title":"template_file","type":"string","description":"AWS SAM template which references built artifacts for resources in the template. (if applicable)","default":"template.[yaml|yml|json]"},"semantic_version":{"title":"semantic_version","type":"string","description":"Optional. The value provided here overrides SemanticVersion in the template metadata."},"fail_on_same_version":{"title":"fail_on_same_version","type":"boolean","description":"If set, AWS SAM CLI will prevent a publish and return a non-zero exit code\nif the publish is attempted with a semantic version that already exists on the SAR application.\nDefault is False."},"profile":{"title":"profile","type":"string","description":"Select a specific profile from your credential file to get AWS credentials."},"region":{"title":"region","type":"string","description":"Set the AWS Region of the service. (e.g. us-east-1)"},"beta_features":{"title":"beta_features","type":"boolean","description":"Enable/Disable beta features."},"debug":{"title":"debug","type":"boolean","description":"Turn on debug logging to print debug message generated by AWS SAM CLI and display timestamps."},"save_params":{"title":"save_params","type":"boolean","description":"Save the parameters provided via the command line to the configuration file."}}}},"required":["parameters"]},"traces":{"title":"Traces command","description":"Use this command to fetch AWS X-Ray traces generated by your stack.\n\n\nRun the following command to fetch X-Ray traces by ID.\n$ sam traces --trace-id tracing-id-1 --trace-id tracing-id-2\n\nRun the following command to tail X-Ray traces as they become available.\n$ sam traces --tail","properties":{"parameters":{"title":"Parameters for the traces command","description":"Available parameters for the traces command:\n* trace_id:\nFetch specific trace by providing its id\n* tail:\nTail events. This will ignore the end time argument and continue to fetch events as they become available.\n* output:\nThe formatting style of the command output. Following options are available:\n\nTEXT: Prints information as regular text with some formatting (default option)\n\nJSON: Prints each line as JSON without formatting\n* end_time:\nFetch events up to this time. Time can be relative values like '5mins ago', 'tomorrow' or formatted timestamp like '2018-01-01 10:10:10'\n* start_time:\nFetch events starting at this time. Time can be relative values like '5mins ago', 'yesterday' or formatted timestamp like '2018-01-01 10:10:10'. Defaults to '10mins ago'.\n* beta_features:\nEnable/Disable beta features.\n* debug:\nTurn on debug logging to print debug message generated by AWS SAM CLI and display timestamps.\n* profile:\nSelect a specific profile from your credential file to get AWS credentials.\n* region:\nSet the AWS Region of the service. (e.g. us-east-1)\n* save_params:\nSave the parameters provided via the command line to the configuration file.","type":"object","properties":{"trace_id":{"title":"trace_id","type":"string","description":"Fetch specific trace by providing its id"},"tail":{"title":"tail","type":"boolean","description":"Tail events. This will ignore the end time argument and continue to fetch events as they become available."},"output":{"title":"output","type":"string","description":"The formatting style of the command output. Following options are available:\n\nTEXT: Prints information as regular text with some formatting (default option)\n\nJSON: Prints each line as JSON without formatting","enum":["json","text"]},"end_time":{"title":"end_time","type":"string","description":"Fetch events up to this time. Time can be relative values like '5mins ago', 'tomorrow' or formatted timestamp like '2018-01-01 10:10:10'"},"start_time":{"title":"start_time","type":"string","description":"Fetch events starting at this time. Time can be relative values like '5mins ago', 'yesterday' or formatted timestamp like '2018-01-01 10:10:10'. Defaults to '10mins ago'.","default":"10m ago"},"beta_features":{"title":"beta_features","type":"boolean","description":"Enable/Disable beta features."},"debug":{"title":"debug","type":"boolean","description":"Turn on debug logging to print debug message generated by AWS SAM CLI and display timestamps."},"profile":{"title":"profile","type":"string","description":"Select a specific profile from your credential file to get AWS credentials."},"region":{"title":"region","type":"string","description":"Set the AWS Region of the service. (e.g. us-east-1)"},"save_params":{"title":"save_params","type":"boolean","description":"Save the parameters provided via the command line to the configuration file."}}}},"required":["parameters"]},"sync":{"title":"Sync command","description":"NEW! Sync an AWS SAM Project to AWS.","properties":{"parameters":{"title":"Parameters for the sync command","description":"Available parameters for the sync command:\n* template_file:\nAWS SAM template file.\n* code:\nSync ONLY code resources. This includes Lambda Functions, API Gateway, and Step Functions.\n* watch:\nWatch local files and automatically sync with cloud.\n* resource_id:\nSync code for all the resources with the ID. To sync a resource within a nested stack, use the following pattern {ChildStack}/{logicalId}.\n* resource:\nSync code for all resources of the given resource type. Accepted values are ['AWS::Serverless::Function', 'AWS::Lambda::Function', 'AWS::Serverless::LayerVersion', 'AWS::Lambda::LayerVersion', 'AWS::Serverless::Api', 'AWS::ApiGateway::RestApi', 'AWS::Serverless::HttpApi', 'AWS::ApiGatewayV2::Api', 'AWS::Serverless::StateMachine', 'AWS::StepFunctions::StateMachine']\n* dependency_layer:\nSeparate dependencies of individual function into a Lambda layer for improved performance.\n* skip_deploy_sync:\nThis option will skip the initial infrastructure deployment if it is not required by comparing the local template with the template deployed in cloud.\n* container_env_var_file:\nEnvironment variables json file (e.g., env_vars.json) to be passed to containers.\n* watch_exclude:\nExcludes a file or folder from being observed for file changes. Files and folders that are excluded will not trigger a sync workflow. This option can be provided multiple times.\n\nExamples:\n\nHelloWorldFunction=package-lock.json\n\nChildStackA/FunctionName=database.sqlite3\n* stack_name:\nName of the AWS CloudFormation stack.\n* base_dir:\nResolve relative paths to function's source code with respect to this directory. Use this if SAM template and source code are not in same enclosing folder. By default, relative paths are resolved with respect to the SAM template's location.\n* use_container:\nBuild functions within an AWS Lambda-like container.\n* build_in_source:\nOpts in to build project in the source folder. The following workflows support building in source: ['nodejs16.x', 'nodejs18.x', 'nodejs20.x', 'nodejs22.x', 'Makefile', 'esbuild']\n* build_image:\nContainer image URIs for building functions/layers. You can specify for all functions/layers with just the image URI (--build-image public.ecr.aws/sam/build-nodejs18.x:latest). You can specify for each individual function with (--build-image FunctionLogicalID=public.ecr.aws/sam/build-nodejs18.x:latest). A combination of the two can be used. If a function does not have build image specified or an image URI for all functions, the default SAM CLI build images will be used.\n* image_repository:\nAWS ECR repository URI where artifacts referenced in the template are uploaded.\n* image_repositories:\nMapping of Function Logical ID to AWS ECR Repository URI.\n\nExample: Function_Logical_ID=ECR_Repo_Uri\nThis option can be specified multiple times.\n* s3_bucket:\nAWS S3 bucket where artifacts referenced in the template are uploaded.\n* s3_prefix:\nPrefix name that is added to the artifact's name when it is uploaded to the AWS S3 bucket.\n* kms_key_id:\nThe ID of an AWS KMS key that is used to encrypt artifacts that are at rest in the AWS S3 bucket.\n* role_arn:\nARN of an IAM role that AWS Cloudformation assumes when executing a deployment change set.\n* parameter_overrides:\nString that contains AWS CloudFormation parameter overrides encoded as key=value pairs.\n* beta_features:\nEnable/Disable beta features.\n* debug:\nTurn on debug logging to print debug message generated by AWS SAM CLI and display timestamps.\n* profile:\nSelect a specific profile from your credential file to get AWS credentials.\n* region:\nSet the AWS Region of the service. (e.g. us-east-1)\n* metadata:\nMap of metadata to attach to ALL the artifacts that are referenced in the template.\n* notification_arns:\nARNs of SNS topics that AWS Cloudformation associates with the stack.\n* tags:\nList of tags to associate with the stack.\n* capabilities:\nList of capabilities that one must specify before AWS Cloudformation can create certain stacks.\n\nAccepted Values: CAPABILITY_IAM, CAPABILITY_NAMED_IAM, CAPABILITY_RESOURCE_POLICY, CAPABILITY_AUTO_EXPAND.\n\nLearn more at: https://docs.aws.amazon.com/serverlessrepo/latest/devguide/acknowledging-application-capabilities.html\n* save_params:\nSave the parameters provided via the command line to the configuration file.","type":"object","properties":{"template_file":{"title":"template_file","type":"string","description":"AWS SAM template file.","default":"template.[yaml|yml|json]"},"code":{"title":"code","type":"boolean","description":"Sync ONLY code resources. This includes Lambda Functions, API Gateway, and Step Functions."},"watch":{"title":"watch","type":"boolean","description":"Watch local files and automatically sync with cloud."},"resource_id":{"title":"resource_id","type":"string","description":"Sync code for all the resources with the ID. To sync a resource within a nested stack, use the following pattern {ChildStack}/{logicalId}."},"resource":{"title":"resource","type":"string","description":"Sync code for all resources of the given resource type. Accepted values are ['AWS::Serverless::Function', 'AWS::Lambda::Function', 'AWS::Serverless::LayerVersion', 'AWS::Lambda::LayerVersion', 'AWS::Serverless::Api', 'AWS::ApiGateway::RestApi', 'AWS::Serverless::HttpApi', 'AWS::ApiGatewayV2::Api', 'AWS::Serverless::StateMachine', 'AWS::StepFunctions::StateMachine']","enum":["AWS::ApiGateway::RestApi","AWS::ApiGatewayV2::Api","AWS::Lambda::Function","AWS::Lambda::LayerVersion","AWS::Serverless::Api","AWS::Serverless::Function","AWS::Serverless::HttpApi","AWS::Serverless::LayerVersion","AWS::Serverless::StateMachine","AWS::StepFunctions::StateMachine"]},"dependency_layer":{"title":"dependency_layer","type":"boolean","description":"Separate dependencies of individual function into a Lambda layer for improved performance.","default":true},"skip_deploy_sync":{"title":"skip_deploy_sync","type":"boolean","description":"This option will skip the initial infrastructure deployment if it is not required by comparing the local template with the template deployed in cloud.","default":true},"container_env_var_file":{"title":"container_env_var_file","type":"string","description":"Environment variables json file (e.g., env_vars.json) to be passed to containers."},"watch_exclude":{"title":"watch_exclude","type":"array","description":"Excludes a file or folder from being observed for file changes. Files and folders that are excluded will not trigger a sync workflow. This option can be provided multiple times.\n\nExamples:\n\nHelloWorldFunction=package-lock.json\n\nChildStackA/FunctionName=database.sqlite3","items":{"type":"string"}},"stack_name":{"title":"stack_name","type":"string","description":"Name of the AWS CloudFormation stack."},"base_dir":{"title":"base_dir","type":"string","description":"Resolve relative paths to function's source code with respect to this directory. Use this if SAM template and source code are not in same enclosing folder. By default, relative paths are resolved with respect to the SAM template's location."},"use_container":{"title":"use_container","type":"boolean","description":"Build functions within an AWS Lambda-like container."},"build_in_source":{"title":"build_in_source","type":"boolean","description":"Opts in to build project in the source folder. The following workflows support building in source: ['nodejs16.x', 'nodejs18.x', 'nodejs20.x', 'nodejs22.x', 'Makefile', 'esbuild']"},"build_image":{"title":"build_image","type":"string","description":"Container image URIs for building functions/layers. You can specify for all functions/layers with just the image URI (--build-image public.ecr.aws/sam/build-nodejs18.x:latest). You can specify for each individual function with (--build-image FunctionLogicalID=public.ecr.aws/sam/build-nodejs18.x:latest). A combination of the two can be used. If a function does not have build image specified or an image URI for all functions, the default SAM CLI build images will be used."},"image_repository":{"title":"image_repository","type":"string","description":"AWS ECR repository URI where artifacts referenced in the template are uploaded."},"image_repositories":{"title":"image_repositories","type":"array","description":"Mapping of Function Logical ID to AWS ECR Repository URI.\n\nExample: Function_Logical_ID=ECR_Repo_Uri\nThis option can be specified multiple times.","items":{"type":"string"}},"s3_bucket":{"title":"s3_bucket","type":"string","description":"AWS S3 bucket where artifacts referenced in the template are uploaded."},"s3_prefix":{"title":"s3_prefix","type":"string","description":"Prefix name that is added to the artifact's name when it is uploaded to the AWS S3 bucket."},"kms_key_id":{"title":"kms_key_id","type":"string","description":"The ID of an AWS KMS key that is used to encrypt artifacts that are at rest in the AWS S3 bucket."},"role_arn":{"title":"role_arn","type":"string","description":"ARN of an IAM role that AWS Cloudformation assumes when executing a deployment change set."},"parameter_overrides":{"title":"parameter_overrides","type":["array","string"],"description":"String that contains AWS CloudFormation parameter overrides encoded as key=value pairs.","items":{"type":"string"}},"beta_features":{"title":"beta_features","type":"boolean","description":"Enable/Disable beta features."},"debug":{"title":"debug","type":"boolean","description":"Turn on debug logging to print debug message generated by AWS SAM CLI and display timestamps."},"profile":{"title":"profile","type":"string","description":"Select a specific profile from your credential file to get AWS credentials."},"region":{"title":"region","type":"string","description":"Set the AWS Region of the service. (e.g. us-east-1)"},"metadata":{"title":"metadata","type":"string","description":"Map of metadata to attach to ALL the artifacts that are referenced in the template."},"notification_arns":{"title":"notification_arns","type":["array","string"],"description":"ARNs of SNS topics that AWS Cloudformation associates with the stack.","items":{"type":"string"}},"tags":{"title":"tags","type":["array","string"],"description":"List of tags to associate with the stack.","items":{"type":"string"}},"capabilities":{"title":"capabilities","type":["array","string"],"description":"List of capabilities that one must specify before AWS Cloudformation can create certain stacks.\n\nAccepted Values: CAPABILITY_IAM, CAPABILITY_NAMED_IAM, CAPABILITY_RESOURCE_POLICY, CAPABILITY_AUTO_EXPAND.\n\nLearn more at: https://docs.aws.amazon.com/serverlessrepo/latest/devguide/acknowledging-application-capabilities.html","default":["CAPABILITY_NAMED_IAM","CAPABILITY_AUTO_EXPAND"],"items":{"type":"string"}},"save_params":{"title":"save_params","type":"boolean","description":"Save the parameters provided via the command line to the configuration file."}}}},"required":["parameters"]},"pipeline_bootstrap":{"title":"Pipeline Bootstrap command","description":"This command generates the required AWS infrastructure resources to connect to your CI/CD system.\nThis step must be run for each deployment stage in your pipeline, prior to running the sam pipeline init command.","properties":{"parameters":{"title":"Parameters for the pipeline bootstrap command","description":"Available parameters for the pipeline bootstrap command:\n* interactive:\nDisable interactive prompting for bootstrap parameters, and fail if any required arguments are missing.\n* stage:\nThe name of the corresponding deployment stage. It is used as a suffix for the created AWS infrastructure resources.\n* pipeline_user:\nThe Amazon Resource Name (ARN) of the IAM user having its access key ID and secret access key shared with the CI/CD system. It is used to grant this IAM user permission to access the corresponding AWS account. If not provided, the command will create one along with the access key ID and secret access key credentials.\n* pipeline_execution_role:\nThe ARN of the IAM role to be assumed by the pipeline user to operate on this stage. Provide it only if you want to use your own role, otherwise this command will create one.\n* cloudformation_execution_role:\nThe ARN of the IAM role to be assumed by the AWS CloudFormation service while deploying the application's stack. Provide only if you want to use your own role, otherwise the command will create one.\n* bucket:\nThe ARN of the Amazon S3 bucket to hold the AWS SAM artifacts.\n* create_image_repository:\nIf set to true and no ECR image repository is provided, this command will create an ECR image repository to hold the container images of Lambda functions having an Image package type.\n* image_repository:\nThe ARN of an Amazon ECR image repository to hold the container images of Lambda functions or layers that have a package type of Image. If provided, the --create-image-repository options is ignored. If not provided and --create-image-repository is specified, the command will create one.\n* confirm_changeset:\nPrompt to confirm if the resources are to be deployed.\n* permissions_provider:\nChoose a permissions provider to assume the pipeline execution role. Default is to use an IAM User.\n* oidc_provider_url:\nThe URL of the OIDC provider.\n* oidc_client_id:\nThe client ID configured to use with the OIDC provider.\n* github_org:\nThe GitHub organization that the repository belongs to. If there is no organization enter the Username of the repository owner instead Only used if using GitHub Actions OIDC for user permissions\n* github_repo:\nThe name of the GitHub Repository that deployments will occur from. Only used if using GitHub Actions OIDC for permissions\n* deployment_branch:\nThe name of the branch that deployments will occur from. Only used if using GitHub Actions OIDC for permissions\n* oidc_provider:\nThe name of the CI/CD system that will be used for OIDC permissions Currently supported CI/CD systems are : GitLab, GitHub and Bitbucket\n* gitlab_group:\nThe GitLab group that the repository belongs to. Only used if using GitLab OIDC for permissions\n* gitlab_project:\nThe GitLab project name. Only used if using GitLab OIDC for permissions\n* bitbucket_repo_uuid:\nThe UUID of the Bitbucket repository. Only used if using Bitbucket OIDC for permissions. Found at https://bitbucket.org/<WORKSPACE>/<REPOSITORY>/admin/addon/admin/pipelines/openid-connect\n* cicd_provider:\nThe CICD platform for the SAM Pipeline\n* beta_features:\nEnable/Disable beta features.\n* debug:\nTurn on debug logging to print debug message generated by AWS SAM CLI and display timestamps.\n* profile:\nSelect a specific profile from your credential file to get AWS credentials.\n* region:\nSet the AWS Region of the service. (e.g. us-east-1)\n* save_params:\nSave the parameters provided via the command line to the configuration file.","type":"object","properties":{"interactive":{"title":"interactive","type":"boolean","description":"Disable interactive prompting for bootstrap parameters, and fail if any required arguments are missing.","default":true},"stage":{"title":"stage","type":"string","description":"The name of the corresponding deployment stage. It is used as a suffix for the created AWS infrastructure resources."},"pipeline_user":{"title":"pipeline_user","type":"string","description":"The Amazon Resource Name (ARN) of the IAM user having its access key ID and secret access key shared with the CI/CD system. It is used to grant this IAM user permission to access the corresponding AWS account. If not provided, the command will create one along with the access key ID and secret access key credentials."},"pipeline_execution_role":{"title":"pipeline_execution_role","type":"string","description":"The ARN of the IAM role to be assumed by the pipeline user to operate on this stage. Provide it only if you want to use your own role, otherwise this command will create one."},"cloudformation_execution_role":{"title":"cloudformation_execution_role","type":"string","description":"The ARN of the IAM role to be assumed by the AWS CloudFormation service while deploying the application's stack. Provide only if you want to use your own role, otherwise the command will create one."},"bucket":{"title":"bucket","type":"string","description":"The ARN of the Amazon S3 bucket to hold the AWS SAM artifacts."},"create_image_repository":{"title":"create_image_repository","type":"boolean","description":"If set to true and no ECR image repository is provided, this command will create an ECR image repository to hold the container images of Lambda functions having an Image package type."},"image_repository":{"title":"image_repository","type":"string","description":"The ARN of an Amazon ECR image repository to hold the container images of Lambda functions or layers that have a package type of Image. If provided, the --create-image-repository options is ignored. If not provided and --create-image-repository is specified, the command will create one."},"confirm_changeset":{"title":"confirm_changeset","type":"boolean","description":"Prompt to confirm if the resources are to be deployed.","default":true},"permissions_provider":{"title":"permissions_provider","type":"string","description":"Choose a permissions provider to assume the pipeline execution role. Default is to use an IAM User.","default":"iam","enum":["iam","oidc"]},"oidc_provider_url":{"title":"oidc_provider_url","type":"string","description":"The URL of the OIDC provider."},"oidc_client_id":{"title":"oidc_client_id","type":"string","description":"The client ID configured to use with the OIDC provider."},"github_org":{"title":"github_org","type":"string","description":"The GitHub organization that the repository belongs to. If there is no organization enter the Username of the repository owner instead Only used if using GitHub Actions OIDC for user permissions"},"github_repo":{"title":"github_repo","type":"string","description":"The name of the GitHub Repository that deployments will occur from. Only used if using GitHub Actions OIDC for permissions"},"deployment_branch":{"title":"deployment_branch","type":"string","description":"The name of the branch that deployments will occur from. Only used if using GitHub Actions OIDC for permissions"},"oidc_provider":{"title":"oidc_provider","type":"string","description":"The name of the CI/CD system that will be used for OIDC permissions Currently supported CI/CD systems are : GitLab, GitHub and Bitbucket","enum":["bitbucket-pipelines","github-actions","gitlab"]},"gitlab_group":{"title":"gitlab_group","type":"string","description":"The GitLab group that the repository belongs to. Only used if using GitLab OIDC for permissions"},"gitlab_project":{"title":"gitlab_project","type":"string","description":"The GitLab project name. Only used if using GitLab OIDC for permissions"},"bitbucket_repo_uuid":{"title":"bitbucket_repo_uuid","type":"string","description":"The UUID of the Bitbucket repository. Only used if using Bitbucket OIDC for permissions. Found at https://bitbucket.org/<WORKSPACE>/<REPOSITORY>/admin/addon/admin/pipelines/openid-connect"},"cicd_provider":{"title":"cicd_provider","type":"string","description":"The CICD platform for the SAM Pipeline"},"beta_features":{"title":"beta_features","type":"boolean","description":"Enable/Disable beta features."},"debug":{"title":"debug","type":"boolean","description":"Turn on debug logging to print debug message generated by AWS SAM CLI and display timestamps."},"profile":{"title":"profile","type":"string","description":"Select a specific profile from your credential file to get AWS credentials."},"region":{"title":"region","type":"string","description":"Set the AWS Region of the service. (e.g. us-east-1)"},"save_params":{"title":"save_params","type":"boolean","description":"Save the parameters provided via the command line to the configuration file."}}}},"required":["parameters"]},"pipeline_init":{"title":"Pipeline Init command","description":"This command generates a pipeline configuration file that your CI/CD system can use to deploy\nserverless applications using AWS SAM.\n\nBefore using sam pipeline init, you must bootstrap the necessary resources for each stage in your pipeline.\nYou can do this by running sam pipeline init --bootstrap to be guided through the setup and configuration\nfile generation process, or refer to resources you have previously created with the sam pipeline bootstrap command.","properties":{"parameters":{"title":"Parameters for the pipeline init command","description":"Available parameters for the pipeline init command:\n* bootstrap:\nEnable interactive mode that walks the user through creating necessary AWS infrastructure resources.\n* beta_features:\nEnable/Disable beta features.\n* debug:\nTurn on debug logging to print debug message generated by AWS SAM CLI and display timestamps.\n* save_params:\nSave the parameters provided via the command line to the configuration file.","type":"object","properties":{"bootstrap":{"title":"bootstrap","type":"boolean","description":"Enable interactive mode that walks the user through creating necessary AWS infrastructure resources."},"beta_features":{"title":"beta_features","type":"boolean","description":"Enable/Disable beta features."},"debug":{"title":"debug","type":"boolean","description":"Turn on debug logging to print debug message generated by AWS SAM CLI and display timestamps."},"save_params":{"title":"save_params","type":"boolean","description":"Save the parameters provided via the command line to the configuration file."}}}},"required":["parameters"]},"list_resources":{"title":"List Resources command","description":"Get a list of resources that will be deployed to CloudFormation.\n\nIf a stack name is provided, the corresponding physical IDs of each\nresource will be mapped to the logical ID of each resource.","properties":{"parameters":{"title":"Parameters for the list resources command","description":"Available parameters for the list resources command:\n* parameter_overrides:\nString that contains AWS CloudFormation parameter overrides encoded as key=value pairs.\n* stack_name:\nName of corresponding deployed stack.(Not including a stack name will only show local resources defined in the template.)\n* output:\nOutput the results from the command in a given output format (json or table).\n* template_file:\nAWS SAM template file.\n* profile:\nSelect a specific profile from your credential file to get AWS credentials.\n* region:\nSet the AWS Region of the service. (e.g. us-east-1)\n* beta_features:\nEnable/Disable beta features.\n* debug:\nTurn on debug logging to print debug message generated by AWS SAM CLI and display timestamps.\n* save_params:\nSave the parameters provided via the command line to the configuration file.","type":"object","properties":{"parameter_overrides":{"title":"parameter_overrides","type":["array","string"],"description":"String that contains AWS CloudFormation parameter overrides encoded as key=value pairs.","items":{"type":"string"}},"stack_name":{"title":"stack_name","type":"string","description":"Name of corresponding deployed stack.(Not including a stack name will only show local resources defined in the template.)"},"output":{"title":"output","type":"string","description":"Output the results from the command in a given output format (json or table).","default":"table","enum":["json","table"]},"template_file":{"title":"template_file","type":"string","description":"AWS SAM template file.","default":"template.[yaml|yml|json]"},"profile":{"title":"profile","type":"string","description":"Select a specific profile from your credential file to get AWS credentials."},"region":{"title":"region","type":"string","description":"Set the AWS Region of the service. (e.g. us-east-1)"},"beta_features":{"title":"beta_features","type":"boolean","description":"Enable/Disable beta features."},"debug":{"title":"debug","type":"boolean","description":"Turn on debug logging to print debug message generated by AWS SAM CLI and display timestamps."},"save_params":{"title":"save_params","type":"boolean","description":"Save the parameters provided via the command line to the configuration file."}}}},"required":["parameters"]},"list_stack_outputs":{"title":"List Stack Outputs command","description":"Get the stack outputs as defined in the SAM/CloudFormation template.","properties":{"parameters":{"title":"Parameters for the list stack outputs command","description":"Available parameters for the list stack outputs command:\n* stack_name:\nName of corresponding deployed stack.\n* output:\nOutput the results from the command in a given output format (json or table).\n* profile:\nSelect a specific profile from your credential file to get AWS credentials.\n* region:\nSet the AWS Region of the service. (e.g. us-east-1)\n* beta_features:\nEnable/Disable beta features.\n* debug:\nTurn on debug logging to print debug message generated by AWS SAM CLI and display timestamps.\n* save_params:\nSave the parameters provided via the command line to the configuration file.","type":"object","properties":{"stack_name":{"title":"stack_name","type":"string","description":"Name of corresponding deployed stack."},"output":{"title":"output","type":"string","description":"Output the results from the command in a given output format (json or table).","default":"table","enum":["json","table"]},"profile":{"title":"profile","type":"string","description":"Select a specific profile from your credential file to get AWS credentials."},"region":{"title":"region","type":"string","description":"Set the AWS Region of the service. (e.g. us-east-1)"},"beta_features":{"title":"beta_features","type":"boolean","description":"Enable/Disable beta features."},"debug":{"title":"debug","type":"boolean","description":"Turn on debug logging to print debug message generated by AWS SAM CLI and display timestamps."},"save_params":{"title":"save_params","type":"boolean","description":"Save the parameters provided via the command line to the configuration file."}}}},"required":["parameters"]},"list_endpoints":{"title":"List Endpoints command","description":"Get a summary of the cloud endpoints in the stack.\n\nThis command will show both the cloud and local endpoints that can\nbe used with sam local and sam sync. Currently the endpoint resources\nare Lambda functions and API Gateway API resources.","properties":{"parameters":{"title":"Parameters for the list endpoints command","description":"Available parameters for the list endpoints command:\n* parameter_overrides:\nString that contains AWS CloudFormation parameter overrides encoded as key=value pairs.\n* stack_name:\nName of corresponding deployed stack.(Not including a stack name will only show local resources defined in the template.)\n* output:\nOutput the results from the command in a given output format (json or table).\n* template_file:\nAWS SAM template file.\n* profile:\nSelect a specific profile from your credential file to get AWS credentials.\n* region:\nSet the AWS Region of the service. (e.g. us-east-1)\n* beta_features:\nEnable/Disable beta features.\n* debug:\nTurn on debug logging to print debug message generated by AWS SAM CLI and display timestamps.\n* save_params:\nSave the parameters provided via the command line to the configuration file.","type":"object","properties":{"parameter_overrides":{"title":"parameter_overrides","type":["array","string"],"description":"String that contains AWS CloudFormation parameter overrides encoded as key=value pairs.","items":{"type":"string"}},"stack_name":{"title":"stack_name","type":"string","description":"Name of corresponding deployed stack.(Not including a stack name will only show local resources defined in the template.)"},"output":{"title":"output","type":"string","description":"Output the results from the command in a given output format (json or table).","default":"table","enum":["json","table"]},"template_file":{"title":"template_file","type":"string","description":"AWS SAM template file.","default":"template.[yaml|yml|json]"},"profile":{"title":"profile","type":"string","description":"Select a specific profile from your credential file to get AWS credentials."},"region":{"title":"region","type":"string","description":"Set the AWS Region of the service. (e.g. us-east-1)"},"beta_features":{"title":"beta_features","type":"boolean","description":"Enable/Disable beta features."},"debug":{"title":"debug","type":"boolean","description":"Turn on debug logging to print debug message generated by AWS SAM CLI and display timestamps."},"save_params":{"title":"save_params","type":"boolean","description":"Save the parameters provided via the command line to the configuration file."}}}},"required":["parameters"]},"docs":{"title":"Docs command","description":"NEW! Open the documentation in a browser.","properties":{"parameters":{"title":"Parameters for the docs command","description":"Available parameters for the docs command:\n* ","type":"object","properties":{}}},"required":["parameters"]},"remote_invoke":{"title":"Remote Invoke command","description":"Invoke or send an event to resources in the cloud.","properties":{"parameters":{"title":"Parameters for the remote invoke command","description":"Available parameters for the remote invoke command:\n* stack_name:\nName of the stack to get the resource information from\n* event:\nThe event that will be sent to the resource. The target parameter will depend on the resource type. For instance: 'Payload' for Lambda which can be passed as a JSON string, 'Input' for Step Functions, 'MessageBody' for SQS, and 'Data' for Kinesis data streams.\n* event_file:\nThe file that contains the event that will be sent to the resource.\n* test_event_name:\nName of the remote test event to send to the resource\n* output:\nOutput the results from the command in a given output format. The text format prints a readable AWS API response. The json format prints the full AWS API response.\n* parameter:\nAdditional parameters that can be passed to invoke the resource.\n\nLambda Function (Buffered stream): The following additional parameters can be used to invoke a lambda resource and get a buffered response: InvocationType='Event'|'RequestResponse'|'DryRun', LogType='None'|'Tail', ClientContext='base64-encoded string' Qualifier='string'.\n\nLambda Function (Response stream): The following additional parameters can be used to invoke a lambda resource with response streaming: InvocationType='RequestResponse'|'DryRun', LogType='None'|'Tail', ClientContext='base64-encoded string', Qualifier='string'.\n\nStep Functions: The following additional parameters can be used to start a state machine execution: name='string', traceHeader='string'\n\nSQS Queue: The following additional parameters can be used to send a message to an SQS queue: DelaySeconds=integer, MessageAttributes='json string', MessageSystemAttributes='json string', MessageDeduplicationId='string', MessageGroupId='string'\n\nKinesis Data Stream: The following additional parameters can be used to put a record in the kinesis data stream: PartitionKey='string', ExplicitHashKey='string', SequenceNumberForOrdering='string', StreamARN='string'\n* beta_features:\nEnable/Disable beta features.\n* debug:\nTurn on debug logging to print debug message generated by AWS SAM CLI and display timestamps.\n* profile:\nSelect a specific profile from your credential file to get AWS credentials.\n* region:\nSet the AWS Region of the service. (e.g. us-east-1)\n* save_params:\nSave the parameters provided via the command line to the configuration file.","type":"object","properties":{"stack_name":{"title":"stack_name","type":"string","description":"Name of the stack to get the resource information from"},"event":{"title":"event","type":"string","description":"The event that will be sent to the resource. The target parameter will depend on the resource type. For instance: 'Payload' for Lambda which can be passed as a JSON string, 'Input' for Step Functions, 'MessageBody' for SQS, and 'Data' for Kinesis data streams."},"event_file":{"title":"event_file","type":"string","description":"The file that contains the event that will be sent to the resource."},"test_event_name":{"title":"test_event_name","type":"string","description":"Name of the remote test event to send to the resource"},"output":{"title":"output","type":"string","description":"Output the results from the command in a given output format. The text format prints a readable AWS API response. The json format prints the full AWS API response.","default":"text","enum":["json","text"]},"parameter":{"title":"parameter","type":"array","description":"Additional parameters that can be passed to invoke the resource.\n\nLambda Function (Buffered stream): The following additional parameters can be used to invoke a lambda resource and get a buffered response: InvocationType='Event'|'RequestResponse'|'DryRun', LogType='None'|'Tail', ClientContext='base64-encoded string' Qualifier='string'.\n\nLambda Function (Response stream): The following additional parameters can be used to invoke a lambda resource with response streaming: InvocationType='RequestResponse'|'DryRun', LogType='None'|'Tail', ClientContext='base64-encoded string', Qualifier='string'.\n\nStep Functions: The following additional parameters can be used to start a state machine execution: name='string', traceHeader='string'\n\nSQS Queue: The following additional parameters can be used to send a message to an SQS queue: DelaySeconds=integer, MessageAttributes='json string', MessageSystemAttributes='json string', MessageDeduplicationId='string', MessageGroupId='string'\n\nKinesis Data Stream: The following additional parameters can be used to put a record in the kinesis data stream: PartitionKey='string', ExplicitHashKey='string', SequenceNumberForOrdering='string', StreamARN='string'","items":{"type":"string"}},"beta_features":{"title":"beta_features","type":"boolean","description":"Enable/Disable beta features."},"debug":{"title":"debug","type":"boolean","description":"Turn on debug logging to print debug message generated by AWS SAM CLI and display timestamps."},"profile":{"title":"profile","type":"string","description":"Select a specific profile from your credential file to get AWS credentials."},"region":{"title":"region","type":"string","description":"Set the AWS Region of the service. (e.g. us-east-1)"},"save_params":{"title":"save_params","type":"boolean","description":"Save the parameters provided via the command line to the configuration file."}}}},"required":["parameters"]},"remote_test_event":{"title":"Remote Test Event command","description":"Manage remote test events","properties":{"parameters":{"title":"Parameters for the remote test event command","description":"Available parameters for the remote test event command:\n* ","type":"object","properties":{}}},"required":["parameters"]}}}}}
</schema>

[User] Provide a JSON object that satisfies the schema "AWS SAM CLI samconfig schema". Here are the required top‑level fields: version. Return only the valid JSON object.

AWS SAM CLI samconfig schema

Config version

Environment

Init command

Initialize an AWS SAM application.

Parameters for the init command

Available parameters for the init command:
* no_interactive:
Disable interactive prompting for init parameters. (fail if any required values are missing)
* architecture:
Architectures for Lambda functions.

Architectures: ['arm64', 'x86_64']
* location:
Template location (git, mercurial, http(s), zip, path).
* runtime:
Lambda runtime for application.

Runtimes: dotnet8, dotnet6, go1.x, java21, java17, java11, java8.al2, nodejs22.x, nodejs20.x, nodejs18.x, nodejs16.x, provided, provided.al2, provided.al2023, python3.9, python3.8, python3.13, python3.12, python3.11, python3.10, ruby3.4, ruby3.3, ruby3.2
* package_type:
Lambda deployment package type.

Package Types: Zip, Image
* base_image:
Lambda base image for deploying IMAGE based package type.

Base images: amazon/dotnet6-base, amazon/dotnet8-base, amazon/go-provided.al2-base, amazon/go-provided.al2023-base, amazon/go1.x-base, amazon/java11-base, amazon/java17-base, amazon/java21-base, amazon/java8.al2-base, amazon/nodejs16.x-base, amazon/nodejs18.x-base, amazon/nodejs20.x-base, amazon/nodejs22.x-base, amazon/python3.10-base, amazon/python3.11-base, amazon/python3.12-base, amazon/python3.13-base, amazon/python3.8-base, amazon/python3.9-base, amazon/ruby3.2-base, amazon/ruby3.3-base, amazon/ruby3.4-base
* dependency_manager:
Dependency manager for Lambda runtime.

Dependency managers: bundler, cli-package, gradle, maven, mod, npm, pip
* output_dir:
Directory to initialize AWS SAM application.
* name:
Name of AWS SAM Application.
* app_template:
Identifier of the managed application template to be used. Alternatively, run '$ sam init' without options for an interactive workflow.
* no_input:
Disable Cookiecutter prompting and accept default values defined in the cookiecutter config.
* extra_context:
Override custom parameters in the template's cookiecutter.json configuration e.g. {"customParam1": "customValue1", "customParam2":"customValue2"}
* tracing:
Enable AWS X-Ray tracing for application.
* application_insights:
Enable CloudWatch Application Insights monitoring for application.
* structured_logging:
Enable Structured Logging for application.
* beta_features:
Enable/Disable beta features.
* debug:
Turn on debug logging to print debug message generated by AWS SAM CLI and display timestamps.
* save_params:
Save the parameters provided via the command line to the configuration file.

no_interactive

Disable interactive prompting for init parameters. (fail if any required values are missing)

architecture

Architectures for Lambda functions.

Architectures: ['arm64', 'x86_64']

location

Template location (git, mercurial, http(s), zip, path).

runtime

package_type

Lambda deployment package type.

Package Types: Zip, Image

base_image

dependency_manager

Dependency manager for Lambda runtime.

Dependency managers: bundler, cli-package, gradle, maven, mod, npm, pip

bundler cli-package gradle maven mod npm pip

output_dir

Directory to initialize AWS SAM application.

name

Name of AWS SAM Application.

app_template

Identifier of the managed application template to be used. Alternatively, run '$ sam init' without options for an interactive workflow.

no_input

Disable Cookiecutter prompting and accept default values defined in the cookiecutter config.

extra_context

Override custom parameters in the template's cookiecutter.json configuration e.g. {"customParam1": "customValue1", "customParam2":"customValue2"}

tracing

Enable AWS X-Ray tracing for application.

application_insights

Enable CloudWatch Application Insights monitoring for application.

structured_logging

Enable Structured Logging for application.

beta_features

Enable/Disable beta features.

debug

Turn on debug logging to print debug message generated by AWS SAM CLI and display timestamps.

save_params

Save the parameters provided via the command line to the configuration file.

Validate command

Validate an AWS SAM Template.

Parameters for the validate command

Available parameters for the validate command:
* template_file:
AWS SAM template file.
* profile:
Select a specific profile from your credential file to get AWS credentials.
* region:
Set the AWS Region of the service. (e.g. us-east-1)
* beta_features:
Enable/Disable beta features.
* debug:
Turn on debug logging to print debug message generated by AWS SAM CLI and display timestamps.
* lint:
Run linting validation on template through cfn-lint. Create a cfnlintrc config file to specify additional parameters. For more information, see: https://github.com/aws-cloudformation/cfn-lint
* save_params:
Save the parameters provided via the command line to the configuration file.

template_file

AWS SAM template file.

profile

Select a specific profile from your credential file to get AWS credentials.

region

Set the AWS Region of the service. (e.g. us-east-1)

beta_features

Enable/Disable beta features.

debug

lint

Run linting validation on template through cfn-lint. Create a cfnlintrc config file to specify additional parameters. For more information, see: https://github.com/aws-cloudformation/cfn-lint

save_params

Build command

Build AWS serverless function code.

Parameters for the build command

Available parameters for the build command:
* terraform_project_root_path:
Used for passing the Terraform project root directory path. Current directory will be used as a default value, if this parameter is not provided.
* hook_name:
Hook package id to extend AWS SAM CLI commands functionality.

Example: `terraform` to extend AWS SAM CLI commands functionality to support terraform applications.

Available Hook Names: ['terraform']
* skip_prepare_infra:
Skip preparation stage when there are no infrastructure changes. Only used in conjunction with --hook-name.
* use_container:
Build functions within an AWS Lambda-like container.
* build_in_source:
Opts in to build project in the source folder. The following workflows support building in source: ['nodejs16.x', 'nodejs18.x', 'nodejs20.x', 'nodejs22.x', 'Makefile', 'esbuild']
* container_env_var:
Environment variables to be passed into build containers
Resource format (FuncName.VarName=Value) or Global format (VarName=Value).

 Example: --container-env-var Func1.VAR1=value1 --container-env-var VAR2=value2
* container_env_var_file:
Environment variables json file (e.g., env_vars.json) to be passed to containers.
* build_image:
Container image URIs for building functions/layers. You can specify for all functions/layers with just the image URI (--build-image public.ecr.aws/sam/build-nodejs18.x:latest). You can specify for each individual function with (--build-image FunctionLogicalID=public.ecr.aws/sam/build-nodejs18.x:latest). A combination of the two can be used. If a function does not have build image specified or an image URI for all functions, the default SAM CLI build images will be used.
* exclude:
Name of the resource(s) to exclude from AWS SAM CLI build.
* parallel:
Enable parallel builds for AWS SAM template's functions and layers.
* mount_with:
Specify mount mode for building functions/layers inside container. If it is mounted with write permissions, some files in source code directory may be changed/added by the build process. By default the source code directory is read only.
* mount_symlinks:
Specify if symlinks at the top level of the code should be mounted inside the container. Activating this flag could allow access to locations outside of your workspace by using a symbolic link. By default symlinks are not mounted.
* build_dir:
Directory to store build artifacts.Note: This directory will be first removed before starting a build.
* cache_dir:
Directory to store cached artifacts. The default cache directory is .aws-sam/cache
* base_dir:
Resolve relative paths to function's source code with respect to this directory. Use this if SAM template and source code are not in same enclosing folder. By default, relative paths are resolved with respect to the SAM template's location.
* manifest:
Path to a custom dependency manifest. Example: custom-package.json
* cached:
Enable cached builds.Reuse build artifacts that have not changed from previous builds.

AWS SAM CLI evaluates if files in your project directory have changed.

Note: AWS SAM CLI does not evaluate changes made to third party modules that the project depends on.Example: Python function includes a requirements.txt file with the following entry requests=1.x and the latest request module version changes from 1.1 to 1.2, AWS SAM CLI will not pull the latest version until a non-cached build is run.
* template_file:
AWS SAM template file.
* parameter_overrides:
String that contains AWS CloudFormation parameter overrides encoded as key=value pairs.
* skip_pull_image:
Skip pulling down the latest Docker image for Lambda runtime.
* docker_network:
Name or ID of an existing docker network for AWS Lambda docker containers to connect to, along with the default bridge network. If not specified, the Lambda containers will only connect to the default bridge docker network.
* beta_features:
Enable/Disable beta features.
* debug:
Turn on debug logging to print debug message generated by AWS SAM CLI and display timestamps.
* profile:
Select a specific profile from your credential file to get AWS credentials.
* region:
Set the AWS Region of the service. (e.g. us-east-1)
* save_params:
Save the parameters provided via the command line to the configuration file.

terraform_project_root_path

Used for passing the Terraform project root directory path. Current directory will be used as a default value, if this parameter is not provided.

hook_name

Hook package id to extend AWS SAM CLI commands functionality.

Example: `terraform` to extend AWS SAM CLI commands functionality to support terraform applications.

Available Hook Names: ['terraform']

skip_prepare_infra

Skip preparation stage when there are no infrastructure changes. Only used in conjunction with --hook-name.

use_container

Build functions within an AWS Lambda-like container.

build_in_source

Opts in to build project in the source folder. The following workflows support building in source: ['nodejs16.x', 'nodejs18.x', 'nodejs20.x', 'nodejs22.x', 'Makefile', 'esbuild']

container_env_var

Environment variables to be passed into build containers
Resource format (FuncName.VarName=Value) or Global format (VarName=Value).

 Example: --container-env-var Func1.VAR1=value1 --container-env-var VAR2=value2

container_env_var_file

Environment variables json file (e.g., env_vars.json) to be passed to containers.

build_image

exclude

Name of the resource(s) to exclude from AWS SAM CLI build.

parallel

Enable parallel builds for AWS SAM template's functions and layers.

mount_with

mount_symlinks

build_dir

Directory to store build artifacts.Note: This directory will be first removed before starting a build.

cache_dir

Directory to store cached artifacts. The default cache directory is .aws-sam/cache

base_dir

manifest

Path to a custom dependency manifest. Example: custom-package.json

cached

template_file

AWS SAM template file.

parameter_overrides

String that contains AWS CloudFormation parameter overrides encoded as key=value pairs.

skip_pull_image

Skip pulling down the latest Docker image for Lambda runtime.

docker_network

beta_features

Enable/Disable beta features.

debug

Turn on debug logging to print debug message generated by AWS SAM CLI and display timestamps.

profile

Select a specific profile from your credential file to get AWS credentials.

region

Set the AWS Region of the service. (e.g. us-east-1)

save_params

Save the parameters provided via the command line to the configuration file.

Local Invoke command

Invoke AWS serverless functions locally.

Parameters for the local invoke command

Available parameters for the local invoke command:
* terraform_plan_file:
Used for passing a custom plan file when executing the Terraform hook.
* hook_name:
Hook package id to extend AWS SAM CLI commands functionality.

Example: `terraform` to extend AWS SAM CLI commands functionality to support terraform applications.

Available Hook Names: ['terraform']
* skip_prepare_infra:
Skip preparation stage when there are no infrastructure changes. Only used in conjunction with --hook-name.
* event:
JSON file containing event data passed to the Lambda function during invoke. If this option is not specified, no event is assumed. Pass in the value '-' to input JSON via stdin
* no_event:
DEPRECATED: By default no event is assumed.
* runtime:
Lambda runtime used to invoke the function.

Runtimes: dotnet8, dotnet6, go1.x, java21, java17, java11, java8.al2, nodejs22.x, nodejs20.x, nodejs18.x, nodejs16.x, provided, provided.al2, provided.al2023, python3.9, python3.8, python3.13, python3.12, python3.11, python3.10, ruby3.4, ruby3.3, ruby3.2
* mount_symlinks:
Specify if symlinks at the top level of the code should be mounted inside the container. Activating this flag could allow access to locations outside of your workspace by using a symbolic link. By default symlinks are not mounted.
* template_file:
AWS SAM template which references built artifacts for resources in the template. (if applicable)
* env_vars:
JSON file containing values for Lambda function's environment variables.
* parameter_overrides:
String that contains AWS CloudFormation parameter overrides encoded as key=value pairs.
* debug_port:
When specified, Lambda function container will start in debug mode and will expose this port on localhost.
* debugger_path:
Host path to a debugger that will be mounted into the Lambda container.
* debug_args:
Additional arguments to be passed to the debugger.
* container_env_vars:
JSON file containing additional environment variables to be set within the container when used in a debugging session locally.
* docker_volume_basedir:
Specify the location basedir where the SAM template exists. If Docker is running on a remote machine, Path of the SAM template must be mounted on the Docker machine and modified to match the remote machine.
* log_file:
File to capture output logs.
* layer_cache_basedir:
Specify the location basedir where the lambda layers used by the template will be downloaded to.
* skip_pull_image:
Skip pulling down the latest Docker image for Lambda runtime.
* docker_network:
Name or ID of an existing docker network for AWS Lambda docker containers to connect to, along with the default bridge network. If not specified, the Lambda containers will only connect to the default bridge docker network.
* force_image_build:
Force rebuilding the image used for invoking functions with layers.
* shutdown:
Emulate a shutdown event after invoke completes, to test extension handling of shutdown behavior.
* container_host:
Host of locally emulated Lambda container. This option is useful when the container runs on a different host than AWS SAM CLI. For example, if one wants to run AWS SAM CLI in a Docker container on macOS, this option could specify `host.docker.internal`
* container_host_interface:
IP address of the host network interface that container ports should bind to. Use 0.0.0.0 to bind to all interfaces.
* add_host:
Passes a hostname to IP address mapping to the Docker container's host file. This parameter can be passed multiple times.Example:--add-host example.com:127.0.0.1
* invoke_image:
Container image URIs for invoking functions or starting api and function. One can specify the image URI used for the local function invocation (--invoke-image public.ecr.aws/sam/build-nodejs20.x:latest). One can also specify for each individual function with (--invoke-image Function1=public.ecr.aws/sam/build-nodejs20.x:latest). If a function does not have invoke image specified, the default AWS SAM CLI emulation image will be used.
* no_memory_limit:
Removes the Memory limit during emulation. With this parameter, the underlying container will run without a --memory parameter
* beta_features:
Enable/Disable beta features.
* debug:
Turn on debug logging to print debug message generated by AWS SAM CLI and display timestamps.
* profile:
Select a specific profile from your credential file to get AWS credentials.
* region:
Set the AWS Region of the service. (e.g. us-east-1)
* save_params:
Save the parameters provided via the command line to the configuration file.

terraform_plan_file

Used for passing a custom plan file when executing the Terraform hook.

hook_name

Hook package id to extend AWS SAM CLI commands functionality.

Example: `terraform` to extend AWS SAM CLI commands functionality to support terraform applications.

Available Hook Names: ['terraform']

skip_prepare_infra

Skip preparation stage when there are no infrastructure changes. Only used in conjunction with --hook-name.

event

JSON file containing event data passed to the Lambda function during invoke. If this option is not specified, no event is assumed. Pass in the value '-' to input JSON via stdin

no_event

DEPRECATED: By default no event is assumed.

runtime

mount_symlinks

template_file

AWS SAM template which references built artifacts for resources in the template. (if applicable)

env_vars

JSON file containing values for Lambda function's environment variables.

parameter_overrides

String that contains AWS CloudFormation parameter overrides encoded as key=value pairs.

debug_port

When specified, Lambda function container will start in debug mode and will expose this port on localhost.

debugger_path

Host path to a debugger that will be mounted into the Lambda container.

debug_args

Additional arguments to be passed to the debugger.

container_env_vars

JSON file containing additional environment variables to be set within the container when used in a debugging session locally.

docker_volume_basedir

Specify the location basedir where the SAM template exists. If Docker is running on a remote machine, Path of the SAM template must be mounted on the Docker machine and modified to match the remote machine.

log_file

File to capture output logs.

layer_cache_basedir

Specify the location basedir where the lambda layers used by the template will be downloaded to.

skip_pull_image

Skip pulling down the latest Docker image for Lambda runtime.

docker_network

force_image_build

Force rebuilding the image used for invoking functions with layers.

shutdown

Emulate a shutdown event after invoke completes, to test extension handling of shutdown behavior.

container_host

container_host_interface

IP address of the host network interface that container ports should bind to. Use 0.0.0.0 to bind to all interfaces.

add_host

Passes a hostname to IP address mapping to the Docker container's host file. This parameter can be passed multiple times.Example:--add-host example.com:127.0.0.1

invoke_image

no_memory_limit

Removes the Memory limit during emulation. With this parameter, the underlying container will run without a --memory parameter

beta_features

Enable/Disable beta features.

debug

Turn on debug logging to print debug message generated by AWS SAM CLI and display timestamps.

profile

Select a specific profile from your credential file to get AWS credentials.

region

Set the AWS Region of the service. (e.g. us-east-1)

save_params

Save the parameters provided via the command line to the configuration file.

Local Start Api command

Run & test AWS serverless functions locally as a HTTP API.

Parameters for the local start api command

Available parameters for the local start api command:
* terraform_plan_file:
Used for passing a custom plan file when executing the Terraform hook.
* hook_name:
Hook package id to extend AWS SAM CLI commands functionality.

Example: `terraform` to extend AWS SAM CLI commands functionality to support terraform applications.

Available Hook Names: ['terraform']
* skip_prepare_infra:
Skip preparation stage when there are no infrastructure changes. Only used in conjunction with --hook-name.
* host:
Local hostname or IP address to bind to (default: '127.0.0.1')
* port:
Local port number to listen on (default: '3000')
* static_dir:
Any static assets (e.g. CSS/Javascript/HTML) files located in this directory will be presented at /
* disable_authorizer:
Disable custom Lambda Authorizers from being parsed and invoked.
* ssl_cert_file:
Path to SSL certificate file (default: None)
* ssl_key_file:
Path to SSL key file (default: None)
* template_file:
AWS SAM template which references built artifacts for resources in the template. (if applicable)
* env_vars:
JSON file containing values for Lambda function's environment variables.
* parameter_overrides:
String that contains AWS CloudFormation parameter overrides encoded as key=value pairs.
* debug_port:
When specified, Lambda function container will start in debug mode and will expose this port on localhost.
* debugger_path:
Host path to a debugger that will be mounted into the Lambda container.
* debug_args:
Additional arguments to be passed to the debugger.
* container_env_vars:
JSON file containing additional environment variables to be set within the container when used in a debugging session locally.
* docker_volume_basedir:
Specify the location basedir where the SAM template exists. If Docker is running on a remote machine, Path of the SAM template must be mounted on the Docker machine and modified to match the remote machine.
* log_file:
File to capture output logs.
* layer_cache_basedir:
Specify the location basedir where the lambda layers used by the template will be downloaded to.
* skip_pull_image:
Skip pulling down the latest Docker image for Lambda runtime.
* docker_network:
Name or ID of an existing docker network for AWS Lambda docker containers to connect to, along with the default bridge network. If not specified, the Lambda containers will only connect to the default bridge docker network.
* force_image_build:
Force rebuilding the image used for invoking functions with layers.
* warm_containers:
Optional. Specifies how AWS SAM CLI manages
containers for each function.
Two modes are available:
EAGER: Containers for all functions are
loaded at startup and persist between
invocations.
LAZY:  Containers are only loaded when each
function is first invoked. Those containers
persist for additional invocations.
* debug_function:
Optional. Specifies the Lambda Function logicalId to apply debug options to when --warm-containers is specified. This parameter applies to --debug-port, --debugger-path, and --debug-args.
* shutdown:
Emulate a shutdown event after invoke completes, to test extension handling of shutdown behavior.
* container_host:
Host of locally emulated Lambda container. This option is useful when the container runs on a different host than AWS SAM CLI. For example, if one wants to run AWS SAM CLI in a Docker container on macOS, this option could specify `host.docker.internal`
* container_host_interface:
IP address of the host network interface that container ports should bind to. Use 0.0.0.0 to bind to all interfaces.
* add_host:
Passes a hostname to IP address mapping to the Docker container's host file. This parameter can be passed multiple times.Example:--add-host example.com:127.0.0.1
* invoke_image:
Container image URIs for invoking functions or starting api and function. One can specify the image URI used for the local function invocation (--invoke-image public.ecr.aws/sam/build-nodejs20.x:latest). One can also specify for each individual function with (--invoke-image Function1=public.ecr.aws/sam/build-nodejs20.x:latest). If a function does not have invoke image specified, the default AWS SAM CLI emulation image will be used.
* no_memory_limit:
Removes the Memory limit during emulation. With this parameter, the underlying container will run without a --memory parameter
* beta_features:
Enable/Disable beta features.
* debug:
Turn on debug logging to print debug message generated by AWS SAM CLI and display timestamps.
* profile:
Select a specific profile from your credential file to get AWS credentials.
* region:
Set the AWS Region of the service. (e.g. us-east-1)
* save_params:
Save the parameters provided via the command line to the configuration file.

terraform_plan_file

Used for passing a custom plan file when executing the Terraform hook.

hook_name

Hook package id to extend AWS SAM CLI commands functionality.

Example: `terraform` to extend AWS SAM CLI commands functionality to support terraform applications.

Available Hook Names: ['terraform']

skip_prepare_infra

Skip preparation stage when there are no infrastructure changes. Only used in conjunction with --hook-name.

host

Local hostname or IP address to bind to (default: '127.0.0.1')

port

Local port number to listen on (default: '3000')

static_dir

Any static assets (e.g. CSS/Javascript/HTML) files located in this directory will be presented at /

disable_authorizer

Disable custom Lambda Authorizers from being parsed and invoked.

ssl_cert_file

Path to SSL certificate file (default: None)

ssl_key_file

Path to SSL key file (default: None)

template_file

AWS SAM template which references built artifacts for resources in the template. (if applicable)

env_vars

JSON file containing values for Lambda function's environment variables.

parameter_overrides

String that contains AWS CloudFormation parameter overrides encoded as key=value pairs.

debug_port

When specified, Lambda function container will start in debug mode and will expose this port on localhost.

debugger_path

Host path to a debugger that will be mounted into the Lambda container.

debug_args

Additional arguments to be passed to the debugger.

container_env_vars

JSON file containing additional environment variables to be set within the container when used in a debugging session locally.

docker_volume_basedir

Specify the location basedir where the SAM template exists. If Docker is running on a remote machine, Path of the SAM template must be mounted on the Docker machine and modified to match the remote machine.

log_file

File to capture output logs.

layer_cache_basedir

Specify the location basedir where the lambda layers used by the template will be downloaded to.

skip_pull_image

Skip pulling down the latest Docker image for Lambda runtime.

docker_network

force_image_build

Force rebuilding the image used for invoking functions with layers.

warm_containers

debug_function

Optional. Specifies the Lambda Function logicalId to apply debug options to when --warm-containers is specified. This parameter applies to --debug-port, --debugger-path, and --debug-args.

shutdown

Emulate a shutdown event after invoke completes, to test extension handling of shutdown behavior.

container_host

container_host_interface

IP address of the host network interface that container ports should bind to. Use 0.0.0.0 to bind to all interfaces.

add_host

Passes a hostname to IP address mapping to the Docker container's host file. This parameter can be passed multiple times.Example:--add-host example.com:127.0.0.1

invoke_image

no_memory_limit

Removes the Memory limit during emulation. With this parameter, the underlying container will run without a --memory parameter

beta_features

Enable/Disable beta features.

debug

Turn on debug logging to print debug message generated by AWS SAM CLI and display timestamps.

profile

Select a specific profile from your credential file to get AWS credentials.

region

Set the AWS Region of the service. (e.g. us-east-1)

save_params

Save the parameters provided via the command line to the configuration file.

Local Generate Event command

Generate events for Lambda functions.

Parameters for the local generate event command

Available parameters for the local generate event command:
*

Local Start Lambda command

Emulate AWS serverless functions locally.

Parameters for the local start lambda command

Available parameters for the local start lambda command:
* terraform_plan_file:
Used for passing a custom plan file when executing the Terraform hook.
* hook_name:
Hook package id to extend AWS SAM CLI commands functionality.

Example: `terraform` to extend AWS SAM CLI commands functionality to support terraform applications.

Available Hook Names: ['terraform']
* skip_prepare_infra:
Skip preparation stage when there are no infrastructure changes. Only used in conjunction with --hook-name.
* host:
Local hostname or IP address to bind to (default: '127.0.0.1')
* port:
Local port number to listen on (default: '3001')
* template_file:
AWS SAM template which references built artifacts for resources in the template. (if applicable)
* env_vars:
JSON file containing values for Lambda function's environment variables.
* parameter_overrides:
String that contains AWS CloudFormation parameter overrides encoded as key=value pairs.
* debug_port:
When specified, Lambda function container will start in debug mode and will expose this port on localhost.
* debugger_path:
Host path to a debugger that will be mounted into the Lambda container.
* debug_args:
Additional arguments to be passed to the debugger.
* container_env_vars:
JSON file containing additional environment variables to be set within the container when used in a debugging session locally.
* docker_volume_basedir:
Specify the location basedir where the SAM template exists. If Docker is running on a remote machine, Path of the SAM template must be mounted on the Docker machine and modified to match the remote machine.
* log_file:
File to capture output logs.
* layer_cache_basedir:
Specify the location basedir where the lambda layers used by the template will be downloaded to.
* skip_pull_image:
Skip pulling down the latest Docker image for Lambda runtime.
* docker_network:
Name or ID of an existing docker network for AWS Lambda docker containers to connect to, along with the default bridge network. If not specified, the Lambda containers will only connect to the default bridge docker network.
* force_image_build:
Force rebuilding the image used for invoking functions with layers.
* warm_containers:
Optional. Specifies how AWS SAM CLI manages
containers for each function.
Two modes are available:
EAGER: Containers for all functions are
loaded at startup and persist between
invocations.
LAZY:  Containers are only loaded when each
function is first invoked. Those containers
persist for additional invocations.
* debug_function:
Optional. Specifies the Lambda Function logicalId to apply debug options to when --warm-containers is specified. This parameter applies to --debug-port, --debugger-path, and --debug-args.
* shutdown:
Emulate a shutdown event after invoke completes, to test extension handling of shutdown behavior.
* container_host:
Host of locally emulated Lambda container. This option is useful when the container runs on a different host than AWS SAM CLI. For example, if one wants to run AWS SAM CLI in a Docker container on macOS, this option could specify `host.docker.internal`
* container_host_interface:
IP address of the host network interface that container ports should bind to. Use 0.0.0.0 to bind to all interfaces.
* add_host:
Passes a hostname to IP address mapping to the Docker container's host file. This parameter can be passed multiple times.Example:--add-host example.com:127.0.0.1
* invoke_image:
Container image URIs for invoking functions or starting api and function. One can specify the image URI used for the local function invocation (--invoke-image public.ecr.aws/sam/build-nodejs20.x:latest). One can also specify for each individual function with (--invoke-image Function1=public.ecr.aws/sam/build-nodejs20.x:latest). If a function does not have invoke image specified, the default AWS SAM CLI emulation image will be used.
* no_memory_limit:
Removes the Memory limit during emulation. With this parameter, the underlying container will run without a --memory parameter
* beta_features:
Enable/Disable beta features.
* debug:
Turn on debug logging to print debug message generated by AWS SAM CLI and display timestamps.
* profile:
Select a specific profile from your credential file to get AWS credentials.
* region:
Set the AWS Region of the service. (e.g. us-east-1)
* save_params:
Save the parameters provided via the command line to the configuration file.

terraform_plan_file

Used for passing a custom plan file when executing the Terraform hook.

hook_name

Hook package id to extend AWS SAM CLI commands functionality.

Example: `terraform` to extend AWS SAM CLI commands functionality to support terraform applications.

Available Hook Names: ['terraform']

skip_prepare_infra

Skip preparation stage when there are no infrastructure changes. Only used in conjunction with --hook-name.

host

Local hostname or IP address to bind to (default: '127.0.0.1')

port

Local port number to listen on (default: '3001')

template_file

AWS SAM template which references built artifacts for resources in the template. (if applicable)

env_vars

JSON file containing values for Lambda function's environment variables.

parameter_overrides

String that contains AWS CloudFormation parameter overrides encoded as key=value pairs.

debug_port

When specified, Lambda function container will start in debug mode and will expose this port on localhost.

debugger_path

Host path to a debugger that will be mounted into the Lambda container.

debug_args

Additional arguments to be passed to the debugger.

container_env_vars

JSON file containing additional environment variables to be set within the container when used in a debugging session locally.

docker_volume_basedir

Specify the location basedir where the SAM template exists. If Docker is running on a remote machine, Path of the SAM template must be mounted on the Docker machine and modified to match the remote machine.

log_file

File to capture output logs.

layer_cache_basedir

Specify the location basedir where the lambda layers used by the template will be downloaded to.

skip_pull_image

Skip pulling down the latest Docker image for Lambda runtime.

docker_network

force_image_build

Force rebuilding the image used for invoking functions with layers.

warm_containers

debug_function

Optional. Specifies the Lambda Function logicalId to apply debug options to when --warm-containers is specified. This parameter applies to --debug-port, --debugger-path, and --debug-args.

shutdown

Emulate a shutdown event after invoke completes, to test extension handling of shutdown behavior.

container_host

container_host_interface

IP address of the host network interface that container ports should bind to. Use 0.0.0.0 to bind to all interfaces.

add_host

Passes a hostname to IP address mapping to the Docker container's host file. This parameter can be passed multiple times.Example:--add-host example.com:127.0.0.1

invoke_image

no_memory_limit

Removes the Memory limit during emulation. With this parameter, the underlying container will run without a --memory parameter

beta_features

Enable/Disable beta features.

debug

Turn on debug logging to print debug message generated by AWS SAM CLI and display timestamps.

profile

Select a specific profile from your credential file to get AWS credentials.

region

Set the AWS Region of the service. (e.g. us-east-1)

save_params

Save the parameters provided via the command line to the configuration file.

Package command

Package an AWS SAM application.

Parameters for the package command

Available parameters for the package command:
* template_file:
AWS SAM template which references built artifacts for resources in the template. (if applicable)
* output_template_file:
The path to the file where the command writes the output AWS CloudFormation template. If you don't specify a path, the command writes the template to the standard output.
* s3_bucket:
AWS S3 bucket where artifacts referenced in the template are uploaded.
* image_repository:
AWS ECR repository URI where artifacts referenced in the template are uploaded.
* image_repositories:
Mapping of Function Logical ID to AWS ECR Repository URI.

Example: Function_Logical_ID=ECR_Repo_Uri
This option can be specified multiple times.
* s3_prefix:
Prefix name that is added to the artifact's name when it is uploaded to the AWS S3 bucket.
* kms_key_id:
The ID of an AWS KMS key that is used to encrypt artifacts that are at rest in the AWS S3 bucket.
* use_json:
Indicates whether to use JSON as the format for the output AWS CloudFormation template. YAML is used by default.
* force_upload:
Indicates whether to override existing files in the S3 bucket. Specify this flag to upload artifacts even if they match existing artifacts in the S3 bucket.
* resolve_s3:
Automatically resolve AWS S3 bucket for non-guided deployments. Enabling this option will also create a managed default AWS S3 bucket for you. If one does not provide a --s3-bucket value, the managed bucket will be used. Do not use --guided with this option.
* metadata:
Map of metadata to attach to ALL the artifacts that are referenced in the template.
* signing_profiles:
A string that contains Code Sign configuration parameters as FunctionOrLayerNameToSign=SigningProfileName:SigningProfileOwner Since signing profile owner is optional, it could also be written as FunctionOrLayerNameToSign=SigningProfileName
* no_progressbar:
Does not showcase a progress bar when uploading artifacts to S3 and pushing docker images to ECR
* beta_features:
Enable/Disable beta features.
* debug:
Turn on debug logging to print debug message generated by AWS SAM CLI and display timestamps.
* profile:
Select a specific profile from your credential file to get AWS credentials.
* region:
Set the AWS Region of the service. (e.g. us-east-1)
* save_params:
Save the parameters provided via the command line to the configuration file.

template_file

AWS SAM template which references built artifacts for resources in the template. (if applicable)

output_template_file

The path to the file where the command writes the output AWS CloudFormation template. If you don't specify a path, the command writes the template to the standard output.

s3_bucket

AWS S3 bucket where artifacts referenced in the template are uploaded.

image_repository

AWS ECR repository URI where artifacts referenced in the template are uploaded.

image_repositories

Mapping of Function Logical ID to AWS ECR Repository URI.

Example: Function_Logical_ID=ECR_Repo_Uri
This option can be specified multiple times.

s3_prefix

Prefix name that is added to the artifact's name when it is uploaded to the AWS S3 bucket.

kms_key_id

The ID of an AWS KMS key that is used to encrypt artifacts that are at rest in the AWS S3 bucket.

use_json

Indicates whether to use JSON as the format for the output AWS CloudFormation template. YAML is used by default.

force_upload

Indicates whether to override existing files in the S3 bucket. Specify this flag to upload artifacts even if they match existing artifacts in the S3 bucket.

resolve_s3

metadata

Map of metadata to attach to ALL the artifacts that are referenced in the template.

signing_profiles

no_progressbar

Does not showcase a progress bar when uploading artifacts to S3 and pushing docker images to ECR

beta_features

Enable/Disable beta features.

debug

Turn on debug logging to print debug message generated by AWS SAM CLI and display timestamps.

profile

Select a specific profile from your credential file to get AWS credentials.

region

Set the AWS Region of the service. (e.g. us-east-1)

save_params

Save the parameters provided via the command line to the configuration file.

Deploy command

The sam deploy command creates a Cloudformation Stack and deploys your resources.

Parameters for the deploy command

Available parameters for the deploy command:
* guided:
Specify this flag to allow SAM CLI to guide you through the deployment using guided prompts.
* template_file:
AWS SAM template which references built artifacts for resources in the template. (if applicable)
* no_execute_changeset:
Indicates whether to execute the change set. Specify this flag to view stack changes before executing the change set.
* fail_on_empty_changeset:
Specify whether AWS SAM CLI should return a non-zero exit code if there are no changes to be made to the stack. Defaults to a non-zero exit code.
* confirm_changeset:
Prompt to confirm if the computed changeset is to be deployed by SAM CLI.
* disable_rollback:
Preserves the state of previously provisioned resources when an operation fails.
* on_failure:
Provide an action to determine what will happen when a stack fails to create. Three actions are available:

- ROLLBACK: This will rollback a stack to a previous known good state.

- DELETE: The stack will rollback to a previous state if one exists, otherwise the stack will be deleted.

- DO_NOTHING: The stack will not rollback or delete, this is the same as disabling rollback.

Default behaviour is ROLLBACK.

This option is mutually exclusive with --disable-rollback/--no-disable-rollback. You can provide
--on-failure or --disable-rollback/--no-disable-rollback but not both at the same time.
* max_wait_duration:
Maximum duration in minutes to wait for the deployment to complete.
* stack_name:
Name of the AWS CloudFormation stack.
* s3_bucket:
AWS S3 bucket where artifacts referenced in the template are uploaded.
* image_repository:
AWS ECR repository URI where artifacts referenced in the template are uploaded.
* image_repositories:
Mapping of Function Logical ID to AWS ECR Repository URI.

Example: Function_Logical_ID=ECR_Repo_Uri
This option can be specified multiple times.
* force_upload:
Indicates whether to override existing files in the S3 bucket. Specify this flag to upload artifacts even if they match existing artifacts in the S3 bucket.
* s3_prefix:
Prefix name that is added to the artifact's name when it is uploaded to the AWS S3 bucket.
* kms_key_id:
The ID of an AWS KMS key that is used to encrypt artifacts that are at rest in the AWS S3 bucket.
* role_arn:
ARN of an IAM role that AWS Cloudformation assumes when executing a deployment change set.
* use_json:
Indicates whether to use JSON as the format for the output AWS CloudFormation template. YAML is used by default.
* resolve_s3:
Automatically resolve AWS S3 bucket for non-guided deployments. Enabling this option will also create a managed default AWS S3 bucket for you. If one does not provide a --s3-bucket value, the managed bucket will be used. Do not use --guided with this option.
* resolve_image_repos:
Automatically create and delete ECR repositories for image-based functions in non-guided deployments. A companion stack containing ECR repos for each function will be deployed along with the template stack. Automatically created image repositories will be deleted if the corresponding functions are removed.
* metadata:
Map of metadata to attach to ALL the artifacts that are referenced in the template.
* notification_arns:
ARNs of SNS topics that AWS Cloudformation associates with the stack.
* tags:
List of tags to associate with the stack.
* parameter_overrides:
String that contains AWS CloudFormation parameter overrides encoded as key=value pairs.
* signing_profiles:
A string that contains Code Sign configuration parameters as FunctionOrLayerNameToSign=SigningProfileName:SigningProfileOwner Since signing profile owner is optional, it could also be written as FunctionOrLayerNameToSign=SigningProfileName
* no_progressbar:
Does not showcase a progress bar when uploading artifacts to S3 and pushing docker images to ECR
* capabilities:
List of capabilities that one must specify before AWS Cloudformation can create certain stacks.

Accepted Values: CAPABILITY_IAM, CAPABILITY_NAMED_IAM, CAPABILITY_RESOURCE_POLICY, CAPABILITY_AUTO_EXPAND.

Learn more at: https://docs.aws.amazon.com/serverlessrepo/latest/devguide/acknowledging-application-capabilities.html
* profile:
Select a specific profile from your credential file to get AWS credentials.
* region:
Set the AWS Region of the service. (e.g. us-east-1)
* beta_features:
Enable/Disable beta features.
* debug:
Turn on debug logging to print debug message generated by AWS SAM CLI and display timestamps.
* save_params:
Save the parameters provided via the command line to the configuration file.

guided

Specify this flag to allow SAM CLI to guide you through the deployment using guided prompts.

template_file

AWS SAM template which references built artifacts for resources in the template. (if applicable)

no_execute_changeset

Indicates whether to execute the change set. Specify this flag to view stack changes before executing the change set.

fail_on_empty_changeset

Specify whether AWS SAM CLI should return a non-zero exit code if there are no changes to be made to the stack. Defaults to a non-zero exit code.

confirm_changeset

Prompt to confirm if the computed changeset is to be deployed by SAM CLI.

disable_rollback

Preserves the state of previously provisioned resources when an operation fails.

on_failure

max_wait_duration

Maximum duration in minutes to wait for the deployment to complete.

stack_name

Name of the AWS CloudFormation stack.

s3_bucket

AWS S3 bucket where artifacts referenced in the template are uploaded.

image_repository

AWS ECR repository URI where artifacts referenced in the template are uploaded.

image_repositories

Mapping of Function Logical ID to AWS ECR Repository URI.

Example: Function_Logical_ID=ECR_Repo_Uri
This option can be specified multiple times.

force_upload

Indicates whether to override existing files in the S3 bucket. Specify this flag to upload artifacts even if they match existing artifacts in the S3 bucket.

s3_prefix

Prefix name that is added to the artifact's name when it is uploaded to the AWS S3 bucket.

kms_key_id

The ID of an AWS KMS key that is used to encrypt artifacts that are at rest in the AWS S3 bucket.

role_arn

ARN of an IAM role that AWS Cloudformation assumes when executing a deployment change set.

use_json

Indicates whether to use JSON as the format for the output AWS CloudFormation template. YAML is used by default.

resolve_s3

resolve_image_repos

metadata

Map of metadata to attach to ALL the artifacts that are referenced in the template.

notification_arns

ARNs of SNS topics that AWS Cloudformation associates with the stack.

tags

List of tags to associate with the stack.

parameter_overrides

String that contains AWS CloudFormation parameter overrides encoded as key=value pairs.

signing_profiles

no_progressbar

Does not showcase a progress bar when uploading artifacts to S3 and pushing docker images to ECR

capabilities

profile

Select a specific profile from your credential file to get AWS credentials.

region

Set the AWS Region of the service. (e.g. us-east-1)

beta_features

Enable/Disable beta features.

debug

Turn on debug logging to print debug message generated by AWS SAM CLI and display timestamps.

save_params

Save the parameters provided via the command line to the configuration file.

Delete command

The sam delete command deletes the CloudFormation
stack and all the artifacts which were created using sam deploy.

Parameters for the delete command

Available parameters for the delete command:
* stack_name:
The name of the AWS CloudFormation stack you want to delete.
* no_prompts:
Specify this flag to allow SAM CLI to skip through the guided prompts.
* s3_bucket:
The S3 bucket path you want to delete.
* s3_prefix:
The S3 prefix you want to delete
* profile:
Select a specific profile from your credential file to get AWS credentials.
* region:
Set the AWS Region of the service. (e.g. us-east-1)
* beta_features:
Enable/Disable beta features.
* debug:
Turn on debug logging to print debug message generated by AWS SAM CLI and display timestamps.
* save_params:
Save the parameters provided via the command line to the configuration file.

stack_name

The name of the AWS CloudFormation stack you want to delete.

no_prompts

Specify this flag to allow SAM CLI to skip through the guided prompts.

s3_bucket

The S3 bucket path you want to delete.

s3_prefix

The S3 prefix you want to delete

profile

region

beta_features

Enable/Disable beta features.

debug

save_params

Logs command

The sam logs commands fetches logs of Lambda Functions/CloudWatch log groups
with additional filtering by options.

Parameters for the logs command

Available parameters for the logs command:
* name:
The name of the resource for which to fetch logs. If this resource is a part of an AWS CloudFormation stack, this can be the LogicalID of the resource in the CloudFormation/SAM template. Multiple names can be provided by repeating the parameter again. If resource is in a nested stack, name can be prepended by nested stack name to pull logs from that resource (NestedStackLogicalId/ResourceLogicalId). If it is not provided and no --cw-log-group have been given, it will scan given stack and find all supported resources, and start pulling log information from them.
* stack_name:
Name of the AWS CloudFormation stack that the function is a part of.
* filter:
You can specify an expression to quickly find logs that match terms, phrases or values in your log events. This could be a simple keyword (e.g. "error") or a pattern supported by AWS CloudWatch Logs. See the AWS CloudWatch Logs documentation for the syntax https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/FilterAndPatternSyntax.html
* tail:
Tail events. This will ignore the end time argument and continue to fetch events as they become available. If option --tail is provided without a --name, one will be pulled from all possible resources
* include_traces:
Include the XRay traces in the log output.
* cw_log_group:
Additional CloudWatch Log group names that are not auto-discovered based upon --name parameter. When provided, it will only tail the given CloudWatch Log groups. If you want to tail log groups related to resources, please also provide their names as well
* output:
The formatting style of the command output. Following options are available:

TEXT: Prints information as regular text with some formatting (default option)

JSON: Prints each line as JSON without formatting
* end_time:
Fetch events up to this time. Time can be relative values like '5mins ago', 'tomorrow' or formatted timestamp like '2018-01-01 10:10:10'
* start_time:
Fetch events starting at this time. Time can be relative values like '5mins ago', 'yesterday' or formatted timestamp like '2018-01-01 10:10:10'. Defaults to '10mins ago'.
* beta_features:
Enable/Disable beta features.
* debug:
Turn on debug logging to print debug message generated by AWS SAM CLI and display timestamps.
* profile:
Select a specific profile from your credential file to get AWS credentials.
* region:
Set the AWS Region of the service. (e.g. us-east-1)
* save_params:
Save the parameters provided via the command line to the configuration file.

name

stack_name

Name of the AWS CloudFormation stack that the function is a part of.

filter

tail

Tail events. This will ignore the end time argument and continue to fetch events as they become available. If option --tail is provided without a --name, one will be pulled from all possible resources

include_traces

Include the XRay traces in the log output.

cw_log_group

output

The formatting style of the command output. Following options are available:

TEXT: Prints information as regular text with some formatting (default option)

JSON: Prints each line as JSON without formatting

end_time

Fetch events up to this time. Time can be relative values like '5mins ago', 'tomorrow' or formatted timestamp like '2018-01-01 10:10:10'

start_time

Fetch events starting at this time. Time can be relative values like '5mins ago', 'yesterday' or formatted timestamp like '2018-01-01 10:10:10'. Defaults to '10mins ago'.

beta_features

Enable/Disable beta features.

debug

Turn on debug logging to print debug message generated by AWS SAM CLI and display timestamps.

profile

Select a specific profile from your credential file to get AWS credentials.

region

Set the AWS Region of the service. (e.g. us-east-1)

save_params

Save the parameters provided via the command line to the configuration file.

Publish command

Use this command to publish a packaged AWS SAM template to
the AWS Serverless Application Repository to share within your team,
across your organization, or with the community at large.

This command expects the template's Metadata section to contain an
AWS::ServerlessRepo::Application section with application metadata
for publishing. For more details on this metadata section, see
https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/serverless-sam-template-publishing-applications.html

Examples
--------
To publish an application
$ sam publish -t packaged.yaml --region <region>

Parameters for the publish command

Available parameters for the publish command:
* template_file:
AWS SAM template which references built artifacts for resources in the template. (if applicable)
* semantic_version:
Optional. The value provided here overrides SemanticVersion in the template metadata.
* fail_on_same_version:
If set, AWS SAM CLI will prevent a publish and return a non-zero exit code
if the publish is attempted with a semantic version that already exists on the SAR application.
Default is False.
* profile:
Select a specific profile from your credential file to get AWS credentials.
* region:
Set the AWS Region of the service. (e.g. us-east-1)
* beta_features:
Enable/Disable beta features.
* debug:
Turn on debug logging to print debug message generated by AWS SAM CLI and display timestamps.
* save_params:
Save the parameters provided via the command line to the configuration file.

template_file

AWS SAM template which references built artifacts for resources in the template. (if applicable)

semantic_version

Optional. The value provided here overrides SemanticVersion in the template metadata.

fail_on_same_version

If set, AWS SAM CLI will prevent a publish and return a non-zero exit code
if the publish is attempted with a semantic version that already exists on the SAR application.
Default is False.

profile

region

beta_features

Enable/Disable beta features.

debug

save_params

Traces command

Use this command to fetch AWS X-Ray traces generated by your stack.

Run the following command to fetch X-Ray traces by ID.
$ sam traces --trace-id tracing-id-1 --trace-id tracing-id-2

Run the following command to tail X-Ray traces as they become available.
$ sam traces --tail

Parameters for the traces command

Available parameters for the traces command:
* trace_id:
Fetch specific trace by providing its id
* tail:
Tail events. This will ignore the end time argument and continue to fetch events as they become available.
* output:
The formatting style of the command output. Following options are available:

TEXT: Prints information as regular text with some formatting (default option)

JSON: Prints each line as JSON without formatting
* end_time:
Fetch events up to this time. Time can be relative values like '5mins ago', 'tomorrow' or formatted timestamp like '2018-01-01 10:10:10'
* start_time:
Fetch events starting at this time. Time can be relative values like '5mins ago', 'yesterday' or formatted timestamp like '2018-01-01 10:10:10'. Defaults to '10mins ago'.
* beta_features:
Enable/Disable beta features.
* debug:
Turn on debug logging to print debug message generated by AWS SAM CLI and display timestamps.
* profile:
Select a specific profile from your credential file to get AWS credentials.
* region:
Set the AWS Region of the service. (e.g. us-east-1)
* save_params:
Save the parameters provided via the command line to the configuration file.

trace_id

Fetch specific trace by providing its id

tail

Tail events. This will ignore the end time argument and continue to fetch events as they become available.

output

The formatting style of the command output. Following options are available:

TEXT: Prints information as regular text with some formatting (default option)

JSON: Prints each line as JSON without formatting

end_time

Fetch events up to this time. Time can be relative values like '5mins ago', 'tomorrow' or formatted timestamp like '2018-01-01 10:10:10'

start_time

Fetch events starting at this time. Time can be relative values like '5mins ago', 'yesterday' or formatted timestamp like '2018-01-01 10:10:10'. Defaults to '10mins ago'.

beta_features

Enable/Disable beta features.

debug

Turn on debug logging to print debug message generated by AWS SAM CLI and display timestamps.

profile

Select a specific profile from your credential file to get AWS credentials.

region

Set the AWS Region of the service. (e.g. us-east-1)

save_params

Save the parameters provided via the command line to the configuration file.

Sync command

NEW! Sync an AWS SAM Project to AWS.

Parameters for the sync command

Available parameters for the sync command:
* template_file:
AWS SAM template file.
* code:
Sync ONLY code resources. This includes Lambda Functions, API Gateway, and Step Functions.
* watch:
Watch local files and automatically sync with cloud.
* resource_id:
Sync code for all the resources with the ID. To sync a resource within a nested stack, use the following pattern {ChildStack}/{logicalId}.
* resource:
Sync code for all resources of the given resource type. Accepted values are ['AWS::Serverless::Function', 'AWS::Lambda::Function', 'AWS::Serverless::LayerVersion', 'AWS::Lambda::LayerVersion', 'AWS::Serverless::Api', 'AWS::ApiGateway::RestApi', 'AWS::Serverless::HttpApi', 'AWS::ApiGatewayV2::Api', 'AWS::Serverless::StateMachine', 'AWS::StepFunctions::StateMachine']
* dependency_layer:
Separate dependencies of individual function into a Lambda layer for improved performance.
* skip_deploy_sync:
This option will skip the initial infrastructure deployment if it is not required by comparing the local template with the template deployed in cloud.
* container_env_var_file:
Environment variables json file (e.g., env_vars.json) to be passed to containers.
* watch_exclude:
Excludes a file or folder from being observed for file changes. Files and folders that are excluded will not trigger a sync workflow. This option can be provided multiple times.

Examples:

HelloWorldFunction=package-lock.json

ChildStackA/FunctionName=database.sqlite3
* stack_name:
Name of the AWS CloudFormation stack.
* base_dir:
Resolve relative paths to function's source code with respect to this directory. Use this if SAM template and source code are not in same enclosing folder. By default, relative paths are resolved with respect to the SAM template's location.
* use_container:
Build functions within an AWS Lambda-like container.
* build_in_source:
Opts in to build project in the source folder. The following workflows support building in source: ['nodejs16.x', 'nodejs18.x', 'nodejs20.x', 'nodejs22.x', 'Makefile', 'esbuild']
* build_image:
Container image URIs for building functions/layers. You can specify for all functions/layers with just the image URI (--build-image public.ecr.aws/sam/build-nodejs18.x:latest). You can specify for each individual function with (--build-image FunctionLogicalID=public.ecr.aws/sam/build-nodejs18.x:latest). A combination of the two can be used. If a function does not have build image specified or an image URI for all functions, the default SAM CLI build images will be used.
* image_repository:
AWS ECR repository URI where artifacts referenced in the template are uploaded.
* image_repositories:
Mapping of Function Logical ID to AWS ECR Repository URI.

Example: Function_Logical_ID=ECR_Repo_Uri
This option can be specified multiple times.
* s3_bucket:
AWS S3 bucket where artifacts referenced in the template are uploaded.
* s3_prefix:
Prefix name that is added to the artifact's name when it is uploaded to the AWS S3 bucket.
* kms_key_id:
The ID of an AWS KMS key that is used to encrypt artifacts that are at rest in the AWS S3 bucket.
* role_arn:
ARN of an IAM role that AWS Cloudformation assumes when executing a deployment change set.
* parameter_overrides:
String that contains AWS CloudFormation parameter overrides encoded as key=value pairs.
* beta_features:
Enable/Disable beta features.
* debug:
Turn on debug logging to print debug message generated by AWS SAM CLI and display timestamps.
* profile:
Select a specific profile from your credential file to get AWS credentials.
* region:
Set the AWS Region of the service. (e.g. us-east-1)
* metadata:
Map of metadata to attach to ALL the artifacts that are referenced in the template.
* notification_arns:
ARNs of SNS topics that AWS Cloudformation associates with the stack.
* tags:
List of tags to associate with the stack.
* capabilities:
List of capabilities that one must specify before AWS Cloudformation can create certain stacks.

Accepted Values: CAPABILITY_IAM, CAPABILITY_NAMED_IAM, CAPABILITY_RESOURCE_POLICY, CAPABILITY_AUTO_EXPAND.

Learn more at: https://docs.aws.amazon.com/serverlessrepo/latest/devguide/acknowledging-application-capabilities.html
* save_params:
Save the parameters provided via the command line to the configuration file.

template_file

AWS SAM template file.

code

Sync ONLY code resources. This includes Lambda Functions, API Gateway, and Step Functions.

watch

Watch local files and automatically sync with cloud.

resource_id

Sync code for all the resources with the ID. To sync a resource within a nested stack, use the following pattern {ChildStack}/{logicalId}.

resource

AWS::ApiGateway::RestApi AWS::ApiGatewayV2::Api AWS::Lambda::Function AWS::Lambda::LayerVersion AWS::Serverless::Api AWS::Serverless::Function AWS::Serverless::HttpApi AWS::Serverless::LayerVersion AWS::Serverless::StateMachine AWS::StepFunctions::StateMachine

dependency_layer

Separate dependencies of individual function into a Lambda layer for improved performance.

skip_deploy_sync

This option will skip the initial infrastructure deployment if it is not required by comparing the local template with the template deployed in cloud.

container_env_var_file

Environment variables json file (e.g., env_vars.json) to be passed to containers.

watch_exclude

stack_name

Name of the AWS CloudFormation stack.

base_dir

use_container

Build functions within an AWS Lambda-like container.

build_in_source

Opts in to build project in the source folder. The following workflows support building in source: ['nodejs16.x', 'nodejs18.x', 'nodejs20.x', 'nodejs22.x', 'Makefile', 'esbuild']

build_image

image_repository

AWS ECR repository URI where artifacts referenced in the template are uploaded.

image_repositories

Mapping of Function Logical ID to AWS ECR Repository URI.

Example: Function_Logical_ID=ECR_Repo_Uri
This option can be specified multiple times.

s3_bucket

AWS S3 bucket where artifacts referenced in the template are uploaded.

s3_prefix

Prefix name that is added to the artifact's name when it is uploaded to the AWS S3 bucket.

kms_key_id

The ID of an AWS KMS key that is used to encrypt artifacts that are at rest in the AWS S3 bucket.

role_arn

ARN of an IAM role that AWS Cloudformation assumes when executing a deployment change set.

parameter_overrides

String that contains AWS CloudFormation parameter overrides encoded as key=value pairs.

beta_features

Enable/Disable beta features.

debug

Turn on debug logging to print debug message generated by AWS SAM CLI and display timestamps.

profile

Select a specific profile from your credential file to get AWS credentials.

region

Set the AWS Region of the service. (e.g. us-east-1)

metadata

Map of metadata to attach to ALL the artifacts that are referenced in the template.

notification_arns

ARNs of SNS topics that AWS Cloudformation associates with the stack.

tags

List of tags to associate with the stack.

capabilities

save_params

Save the parameters provided via the command line to the configuration file.

Pipeline Bootstrap command

This command generates the required AWS infrastructure resources to connect to your CI/CD system.
This step must be run for each deployment stage in your pipeline, prior to running the sam pipeline init command.

Parameters for the pipeline bootstrap command

Available parameters for the pipeline bootstrap command:
* interactive:
Disable interactive prompting for bootstrap parameters, and fail if any required arguments are missing.
* stage:
The name of the corresponding deployment stage. It is used as a suffix for the created AWS infrastructure resources.
* pipeline_user:
The Amazon Resource Name (ARN) of the IAM user having its access key ID and secret access key shared with the CI/CD system. It is used to grant this IAM user permission to access the corresponding AWS account. If not provided, the command will create one along with the access key ID and secret access key credentials.
* pipeline_execution_role:
The ARN of the IAM role to be assumed by the pipeline user to operate on this stage. Provide it only if you want to use your own role, otherwise this command will create one.
* cloudformation_execution_role:
The ARN of the IAM role to be assumed by the AWS CloudFormation service while deploying the application's stack. Provide only if you want to use your own role, otherwise the command will create one.
* bucket:
The ARN of the Amazon S3 bucket to hold the AWS SAM artifacts.
* create_image_repository:
If set to true and no ECR image repository is provided, this command will create an ECR image repository to hold the container images of Lambda functions having an Image package type.
* image_repository:
The ARN of an Amazon ECR image repository to hold the container images of Lambda functions or layers that have a package type of Image. If provided, the --create-image-repository options is ignored. If not provided and --create-image-repository is specified, the command will create one.
* confirm_changeset:
Prompt to confirm if the resources are to be deployed.
* permissions_provider:
Choose a permissions provider to assume the pipeline execution role. Default is to use an IAM User.
* oidc_provider_url:
The URL of the OIDC provider.
* oidc_client_id:
The client ID configured to use with the OIDC provider.
* github_org:
The GitHub organization that the repository belongs to. If there is no organization enter the Username of the repository owner instead Only used if using GitHub Actions OIDC for user permissions
* github_repo:
The name of the GitHub Repository that deployments will occur from. Only used if using GitHub Actions OIDC for permissions
* deployment_branch:
The name of the branch that deployments will occur from. Only used if using GitHub Actions OIDC for permissions
* oidc_provider:
The name of the CI/CD system that will be used for OIDC permissions Currently supported CI/CD systems are : GitLab, GitHub and Bitbucket
* gitlab_group:
The GitLab group that the repository belongs to. Only used if using GitLab OIDC for permissions
* gitlab_project:
The GitLab project name. Only used if using GitLab OIDC for permissions
* bitbucket_repo_uuid:
The UUID of the Bitbucket repository. Only used if using Bitbucket OIDC for permissions. Found at https://bitbucket.org/<WORKSPACE>/<REPOSITORY>/admin/addon/admin/pipelines/openid-connect
* cicd_provider:
The CICD platform for the SAM Pipeline
* beta_features:
Enable/Disable beta features.
* debug:
Turn on debug logging to print debug message generated by AWS SAM CLI and display timestamps.
* profile:
Select a specific profile from your credential file to get AWS credentials.
* region:
Set the AWS Region of the service. (e.g. us-east-1)
* save_params:
Save the parameters provided via the command line to the configuration file.

interactive

Disable interactive prompting for bootstrap parameters, and fail if any required arguments are missing.

stage

The name of the corresponding deployment stage. It is used as a suffix for the created AWS infrastructure resources.

pipeline_user

pipeline_execution_role

The ARN of the IAM role to be assumed by the pipeline user to operate on this stage. Provide it only if you want to use your own role, otherwise this command will create one.

cloudformation_execution_role

The ARN of the IAM role to be assumed by the AWS CloudFormation service while deploying the application's stack. Provide only if you want to use your own role, otherwise the command will create one.

bucket

The ARN of the Amazon S3 bucket to hold the AWS SAM artifacts.

create_image_repository

If set to true and no ECR image repository is provided, this command will create an ECR image repository to hold the container images of Lambda functions having an Image package type.

image_repository

confirm_changeset

Prompt to confirm if the resources are to be deployed.

permissions_provider

Choose a permissions provider to assume the pipeline execution role. Default is to use an IAM User.

oidc_provider_url

The URL of the OIDC provider.

oidc_client_id

The client ID configured to use with the OIDC provider.

github_org

The GitHub organization that the repository belongs to. If there is no organization enter the Username of the repository owner instead Only used if using GitHub Actions OIDC for user permissions

github_repo

The name of the GitHub Repository that deployments will occur from. Only used if using GitHub Actions OIDC for permissions

deployment_branch

The name of the branch that deployments will occur from. Only used if using GitHub Actions OIDC for permissions

oidc_provider

The name of the CI/CD system that will be used for OIDC permissions Currently supported CI/CD systems are : GitLab, GitHub and Bitbucket

gitlab_group

The GitLab group that the repository belongs to. Only used if using GitLab OIDC for permissions

gitlab_project

The GitLab project name. Only used if using GitLab OIDC for permissions

bitbucket_repo_uuid

The UUID of the Bitbucket repository. Only used if using Bitbucket OIDC for permissions. Found at https://bitbucket.org/<WORKSPACE>/<REPOSITORY>/admin/addon/admin/pipelines/openid-connect

cicd_provider

The CICD platform for the SAM Pipeline

beta_features

Enable/Disable beta features.

debug

Turn on debug logging to print debug message generated by AWS SAM CLI and display timestamps.

profile

Select a specific profile from your credential file to get AWS credentials.

region

Set the AWS Region of the service. (e.g. us-east-1)

save_params

Save the parameters provided via the command line to the configuration file.

Pipeline Init command

This command generates a pipeline configuration file that your CI/CD system can use to deploy
serverless applications using AWS SAM.

Before using sam pipeline init, you must bootstrap the necessary resources for each stage in your pipeline.
You can do this by running sam pipeline init --bootstrap to be guided through the setup and configuration
file generation process, or refer to resources you have previously created with the sam pipeline bootstrap command.

Parameters for the pipeline init command

Available parameters for the pipeline init command:
* bootstrap:
Enable interactive mode that walks the user through creating necessary AWS infrastructure resources.
* beta_features:
Enable/Disable beta features.
* debug:
Turn on debug logging to print debug message generated by AWS SAM CLI and display timestamps.
* save_params:
Save the parameters provided via the command line to the configuration file.

bootstrap

Enable interactive mode that walks the user through creating necessary AWS infrastructure resources.

beta_features

Enable/Disable beta features.

debug

save_params

List Resources command

Get a list of resources that will be deployed to CloudFormation.

If a stack name is provided, the corresponding physical IDs of each
resource will be mapped to the logical ID of each resource.

Parameters for the list resources command

Available parameters for the list resources command:
* parameter_overrides:
String that contains AWS CloudFormation parameter overrides encoded as key=value pairs.
* stack_name:
Name of corresponding deployed stack.(Not including a stack name will only show local resources defined in the template.)
* output:
Output the results from the command in a given output format (json or table).
* template_file:
AWS SAM template file.
* profile:
Select a specific profile from your credential file to get AWS credentials.
* region:
Set the AWS Region of the service. (e.g. us-east-1)
* beta_features:
Enable/Disable beta features.
* debug:
Turn on debug logging to print debug message generated by AWS SAM CLI and display timestamps.
* save_params:
Save the parameters provided via the command line to the configuration file.

parameter_overrides

String that contains AWS CloudFormation parameter overrides encoded as key=value pairs.

stack_name

Name of corresponding deployed stack.(Not including a stack name will only show local resources defined in the template.)

output

Output the results from the command in a given output format (json or table).

template_file

AWS SAM template file.

profile

Select a specific profile from your credential file to get AWS credentials.

region

Set the AWS Region of the service. (e.g. us-east-1)

beta_features

Enable/Disable beta features.

debug

Turn on debug logging to print debug message generated by AWS SAM CLI and display timestamps.

save_params

Save the parameters provided via the command line to the configuration file.

List Stack Outputs command

Get the stack outputs as defined in the SAM/CloudFormation template.

Parameters for the list stack outputs command

Available parameters for the list stack outputs command:
* stack_name:
Name of corresponding deployed stack.
* output:
Output the results from the command in a given output format (json or table).
* profile:
Select a specific profile from your credential file to get AWS credentials.
* region:
Set the AWS Region of the service. (e.g. us-east-1)
* beta_features:
Enable/Disable beta features.
* debug:
Turn on debug logging to print debug message generated by AWS SAM CLI and display timestamps.
* save_params:
Save the parameters provided via the command line to the configuration file.

stack_name

Name of corresponding deployed stack.

output

Output the results from the command in a given output format (json or table).

profile

Select a specific profile from your credential file to get AWS credentials.

region

Set the AWS Region of the service. (e.g. us-east-1)

beta_features

Enable/Disable beta features.

debug

Turn on debug logging to print debug message generated by AWS SAM CLI and display timestamps.

save_params

Save the parameters provided via the command line to the configuration file.

List Endpoints command

Get a summary of the cloud endpoints in the stack.

This command will show both the cloud and local endpoints that can
be used with sam local and sam sync. Currently the endpoint resources
are Lambda functions and API Gateway API resources.

Parameters for the list endpoints command

Available parameters for the list endpoints command:
* parameter_overrides:
String that contains AWS CloudFormation parameter overrides encoded as key=value pairs.
* stack_name:
Name of corresponding deployed stack.(Not including a stack name will only show local resources defined in the template.)
* output:
Output the results from the command in a given output format (json or table).
* template_file:
AWS SAM template file.
* profile:
Select a specific profile from your credential file to get AWS credentials.
* region:
Set the AWS Region of the service. (e.g. us-east-1)
* beta_features:
Enable/Disable beta features.
* debug:
Turn on debug logging to print debug message generated by AWS SAM CLI and display timestamps.
* save_params:
Save the parameters provided via the command line to the configuration file.

parameter_overrides

String that contains AWS CloudFormation parameter overrides encoded as key=value pairs.

stack_name

Name of corresponding deployed stack.(Not including a stack name will only show local resources defined in the template.)

output

Output the results from the command in a given output format (json or table).

template_file

AWS SAM template file.

profile

Select a specific profile from your credential file to get AWS credentials.

region

Set the AWS Region of the service. (e.g. us-east-1)

beta_features

Enable/Disable beta features.

debug

Turn on debug logging to print debug message generated by AWS SAM CLI and display timestamps.

save_params

Save the parameters provided via the command line to the configuration file.

Docs command

NEW! Open the documentation in a browser.

Parameters for the docs command

Available parameters for the docs command:
*

Remote Invoke command

Invoke or send an event to resources in the cloud.

Parameters for the remote invoke command

Available parameters for the remote invoke command:
* stack_name:
Name of the stack to get the resource information from
* event:
The event that will be sent to the resource. The target parameter will depend on the resource type. For instance: 'Payload' for Lambda which can be passed as a JSON string, 'Input' for Step Functions, 'MessageBody' for SQS, and 'Data' for Kinesis data streams.
* event_file:
The file that contains the event that will be sent to the resource.
* test_event_name:
Name of the remote test event to send to the resource
* output:
Output the results from the command in a given output format. The text format prints a readable AWS API response. The json format prints the full AWS API response.
* parameter:
Additional parameters that can be passed to invoke the resource.

Lambda Function (Buffered stream): The following additional parameters can be used to invoke a lambda resource and get a buffered response: InvocationType='Event'|'RequestResponse'|'DryRun', LogType='None'|'Tail', ClientContext='base64-encoded string' Qualifier='string'.

Lambda Function (Response stream): The following additional parameters can be used to invoke a lambda resource with response streaming: InvocationType='RequestResponse'|'DryRun', LogType='None'|'Tail', ClientContext='base64-encoded string', Qualifier='string'.

Step Functions: The following additional parameters can be used to start a state machine execution: name='string', traceHeader='string'

SQS Queue: The following additional parameters can be used to send a message to an SQS queue: DelaySeconds=integer, MessageAttributes='json string', MessageSystemAttributes='json string', MessageDeduplicationId='string', MessageGroupId='string'

Kinesis Data Stream: The following additional parameters can be used to put a record in the kinesis data stream: PartitionKey='string', ExplicitHashKey='string', SequenceNumberForOrdering='string', StreamARN='string'
* beta_features:
Enable/Disable beta features.
* debug:
Turn on debug logging to print debug message generated by AWS SAM CLI and display timestamps.
* profile:
Select a specific profile from your credential file to get AWS credentials.
* region:
Set the AWS Region of the service. (e.g. us-east-1)
* save_params:
Save the parameters provided via the command line to the configuration file.

stack_name

Name of the stack to get the resource information from

event

event_file

The file that contains the event that will be sent to the resource.

test_event_name

Name of the remote test event to send to the resource

output

Output the results from the command in a given output format. The text format prints a readable AWS API response. The json format prints the full AWS API response.

parameter

beta_features

Enable/Disable beta features.

debug

Turn on debug logging to print debug message generated by AWS SAM CLI and display timestamps.

profile

Select a specific profile from your credential file to get AWS credentials.

region

Set the AWS Region of the service. (e.g. us-east-1)

save_params

Save the parameters provided via the command line to the configuration file.

Remote Test Event command

Manage remote test events

Parameters for the remote test event command

Available parameters for the remote test event command:
*

Provide a JSON object that satisfies the schema "AWS SAM CLI samconfig schema". Here are the required top‑level fields: version. Return only the valid JSON object.