Command line reference for Amazon CodeBuild
The Amazon CLI provides commands for automating Amazon CodeBuild. Use the information in this topic as a supplement to the Amazon Command Line Interface User Guide and the Amazon CLI Reference for Amazon CodeBuild.
Not what you're looking for? If you want to use the Amazon SDKs to call CodeBuild, see the Amazon SDKs and tools reference.
To use the information in this topic, you should have already installed the Amazon CLI and configured it for use with CodeBuild, as described in Install and configure the Amazon CLI.
To use the Amazon CLI to specify the endpoint for CodeBuild, see Specify the Amazon CodeBuild endpoint (Amazon CLI).
Run this command to get a list of CodeBuild commands.
aws codebuild help
Run this command to get information about a CodeBuild command, where
command-name is the name of the command.
aws codebuildcommand-namehelp
CodeBuild commands include:
-
batch-delete-builds: Deletes one or more builds in CodeBuild. For more information, see Delete builds (Amazon CLI). -
batch-get-builds: Gets information about multiple builds in CodeBuild. For more information, see View build details (Amazon CLI). -
batch-get-projects: Gets information about one or more specified build projects. For more information, see View a build project's details (Amazon CLI). -
create-project: Creates a build project. For more information, see Create a build project (Amazon CLI). -
delete-project: Deletes a build project. For more information, see Delete a build project (Amazon CLI). -
list-builds: Lists Amazon Resource Names (ARNs) for builds in CodeBuild. For more information, see View a list of build IDs (Amazon CLI). -
list-builds-for-project: Gets a list of build IDs that are associated with a specified build project. For more information, see View a list of build IDs for a build project (Amazon CLI). -
list-curated-environment-images: Gets a list of Docker images managed by CodeBuild that you can use for your builds. For more information, see Docker images provided by CodeBuild. -
list-projects: Gets a list of build project names. For more information, see View a list of build project names (Amazon CLI). -
start-build: Starts running a build. For more information, see Run a build (Amazon CLI). -
stop-build: Attempts to stop the specified build from running. For more information, see Stop a build (Amazon CLI). -
update-project: Changes information about the specified build project. For more information, see Change a build project's settings (Amazon CLI).