{ "version":"2.0", "metadata":{ "apiVersion":"2016-10-06", "endpointPrefix":"codebuild", "jsonVersion":"1.1", "protocol":"json", "serviceFullName":"AWS CodeBuild", "signatureVersion":"v4", "targetPrefix":"CodeBuild_20161006", "uid":"codebuild-2016-10-06" }, "operations":{ "BatchDeleteBuilds":{ "name":"BatchDeleteBuilds", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"BatchDeleteBuildsInput"}, "output":{"shape":"BatchDeleteBuildsOutput"}, "errors":[ {"shape":"InvalidInputException"} ], "documentation":"

Deletes one or more builds.

" }, "BatchGetBuilds":{ "name":"BatchGetBuilds", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"BatchGetBuildsInput"}, "output":{"shape":"BatchGetBuildsOutput"}, "errors":[ {"shape":"InvalidInputException"} ], "documentation":"

Gets information about builds.

" }, "BatchGetProjects":{ "name":"BatchGetProjects", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"BatchGetProjectsInput"}, "output":{"shape":"BatchGetProjectsOutput"}, "errors":[ {"shape":"InvalidInputException"} ], "documentation":"

Gets information about build projects.

" }, "CreateProject":{ "name":"CreateProject", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateProjectInput"}, "output":{"shape":"CreateProjectOutput"}, "errors":[ {"shape":"InvalidInputException"}, {"shape":"ResourceAlreadyExistsException"}, {"shape":"AccountLimitExceededException"} ], "documentation":"

Creates a build project.

" }, "CreateWebhook":{ "name":"CreateWebhook", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateWebhookInput"}, "output":{"shape":"CreateWebhookOutput"}, "errors":[ {"shape":"InvalidInputException"}, {"shape":"OAuthProviderException"}, {"shape":"ResourceAlreadyExistsException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

For an existing AWS CodeBuild build project that has its source code stored in a GitHub repository, enables AWS CodeBuild to begin automatically rebuilding the source code every time a code change is pushed to the repository.

If you enable webhooks for an AWS CodeBuild project, and the project is used as a build step in AWS CodePipeline, then two identical builds will be created for each commit. One build is triggered through webhooks, and one through AWS CodePipeline. Because billing is on a per-build basis, you will be billed for both builds. Therefore, if you are using AWS CodePipeline, we recommend that you disable webhooks in CodeBuild. In the AWS CodeBuild console, clear the Webhook box. For more information, see step 9 in Change a Build Project's Settings.

" }, "DeleteProject":{ "name":"DeleteProject", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteProjectInput"}, "output":{"shape":"DeleteProjectOutput"}, "errors":[ {"shape":"InvalidInputException"} ], "documentation":"

Deletes a build project.

" }, "DeleteWebhook":{ "name":"DeleteWebhook", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteWebhookInput"}, "output":{"shape":"DeleteWebhookOutput"}, "errors":[ {"shape":"InvalidInputException"}, {"shape":"ResourceNotFoundException"}, {"shape":"OAuthProviderException"} ], "documentation":"

For an existing AWS CodeBuild build project that has its source code stored in a GitHub repository, stops AWS CodeBuild from automatically rebuilding the source code every time a code change is pushed to the repository.

" }, "InvalidateProjectCache":{ "name":"InvalidateProjectCache", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"InvalidateProjectCacheInput"}, "output":{"shape":"InvalidateProjectCacheOutput"}, "errors":[ {"shape":"InvalidInputException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Resets the cache for a project.

" }, "ListBuilds":{ "name":"ListBuilds", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListBuildsInput"}, "output":{"shape":"ListBuildsOutput"}, "errors":[ {"shape":"InvalidInputException"} ], "documentation":"

Gets a list of build IDs, with each build ID representing a single build.

" }, "ListBuildsForProject":{ "name":"ListBuildsForProject", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListBuildsForProjectInput"}, "output":{"shape":"ListBuildsForProjectOutput"}, "errors":[ {"shape":"InvalidInputException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Gets a list of build IDs for the specified build project, with each build ID representing a single build.

" }, "ListCuratedEnvironmentImages":{ "name":"ListCuratedEnvironmentImages", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListCuratedEnvironmentImagesInput"}, "output":{"shape":"ListCuratedEnvironmentImagesOutput"}, "documentation":"

Gets information about Docker images that are managed by AWS CodeBuild.

" }, "ListProjects":{ "name":"ListProjects", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListProjectsInput"}, "output":{"shape":"ListProjectsOutput"}, "errors":[ {"shape":"InvalidInputException"} ], "documentation":"

Gets a list of build project names, with each build project name representing a single build project.

" }, "StartBuild":{ "name":"StartBuild", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"StartBuildInput"}, "output":{"shape":"StartBuildOutput"}, "errors":[ {"shape":"InvalidInputException"}, {"shape":"ResourceNotFoundException"}, {"shape":"AccountLimitExceededException"} ], "documentation":"

Starts running a build.

" }, "StopBuild":{ "name":"StopBuild", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"StopBuildInput"}, "output":{"shape":"StopBuildOutput"}, "errors":[ {"shape":"InvalidInputException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Attempts to stop running a build.

" }, "UpdateProject":{ "name":"UpdateProject", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateProjectInput"}, "output":{"shape":"UpdateProjectOutput"}, "errors":[ {"shape":"InvalidInputException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Changes the settings of a build project.

" } }, "shapes":{ "AccountLimitExceededException":{ "type":"structure", "members":{ }, "documentation":"

An AWS service limit was exceeded for the calling AWS account.

", "exception":true }, "ArtifactNamespace":{ "type":"string", "enum":[ "NONE", "BUILD_ID" ] }, "ArtifactPackaging":{ "type":"string", "enum":[ "NONE", "ZIP" ] }, "ArtifactsType":{ "type":"string", "enum":[ "CODEPIPELINE", "S3", "NO_ARTIFACTS" ] }, "BatchDeleteBuildsInput":{ "type":"structure", "required":["ids"], "members":{ "ids":{ "shape":"BuildIds", "documentation":"

The IDs of the builds to delete.

" } } }, "BatchDeleteBuildsOutput":{ "type":"structure", "members":{ "buildsDeleted":{ "shape":"BuildIds", "documentation":"

The IDs of the builds that were successfully deleted.

" }, "buildsNotDeleted":{ "shape":"BuildsNotDeleted", "documentation":"

Information about any builds that could not be successfully deleted.

" } } }, "BatchGetBuildsInput":{ "type":"structure", "required":["ids"], "members":{ "ids":{ "shape":"BuildIds", "documentation":"

The IDs of the builds.

" } } }, "BatchGetBuildsOutput":{ "type":"structure", "members":{ "builds":{ "shape":"Builds", "documentation":"

Information about the requested builds.

" }, "buildsNotFound":{ "shape":"BuildIds", "documentation":"

The IDs of builds for which information could not be found.

" } } }, "BatchGetProjectsInput":{ "type":"structure", "required":["names"], "members":{ "names":{ "shape":"ProjectNames", "documentation":"

The names of the build projects.

" } } }, "BatchGetProjectsOutput":{ "type":"structure", "members":{ "projects":{ "shape":"Projects", "documentation":"

Information about the requested build projects.

" }, "projectsNotFound":{ "shape":"ProjectNames", "documentation":"

The names of build projects for which information could not be found.

" } } }, "Boolean":{"type":"boolean"}, "Build":{ "type":"structure", "members":{ "id":{ "shape":"NonEmptyString", "documentation":"

The unique ID for the build.

" }, "arn":{ "shape":"NonEmptyString", "documentation":"

The Amazon Resource Name (ARN) of the build.

" }, "startTime":{ "shape":"Timestamp", "documentation":"

When the build process started, expressed in Unix time format.

" }, "endTime":{ "shape":"Timestamp", "documentation":"

When the build process ended, expressed in Unix time format.

" }, "currentPhase":{ "shape":"String", "documentation":"

The current build phase.

" }, "buildStatus":{ "shape":"StatusType", "documentation":"

The current status of the build. Valid values include:

" }, "sourceVersion":{ "shape":"NonEmptyString", "documentation":"

Any version identifier for the version of the source code to be built.

" }, "projectName":{ "shape":"NonEmptyString", "documentation":"

The name of the build project.

" }, "phases":{ "shape":"BuildPhases", "documentation":"

Information about all previous build phases that are completed and information about any current build phase that is not yet complete.

" }, "source":{ "shape":"ProjectSource", "documentation":"

Information about the source code to be built.

" }, "artifacts":{ "shape":"BuildArtifacts", "documentation":"

Information about the output artifacts for the build.

" }, "cache":{ "shape":"ProjectCache", "documentation":"

Information about the cache for the build.

" }, "environment":{ "shape":"ProjectEnvironment", "documentation":"

Information about the build environment for this build.

" }, "logs":{ "shape":"LogsLocation", "documentation":"

Information about the build's logs in Amazon CloudWatch Logs.

" }, "timeoutInMinutes":{ "shape":"WrapperInt", "documentation":"

How long, in minutes, for AWS CodeBuild to wait before timing out this build if it does not get marked as completed.

" }, "buildComplete":{ "shape":"Boolean", "documentation":"

Whether the build has finished. True if completed; otherwise, false.

" }, "initiator":{ "shape":"String", "documentation":"

The entity that started the build. Valid values include:

" }, "vpcConfig":{ "shape":"VpcConfig", "documentation":"

If your AWS CodeBuild project accesses resources in an Amazon VPC, you provide this parameter that identifies the VPC ID and the list of security group IDs and subnet IDs. The security groups and subnets must belong to the same VPC. You must provide at least one security group and one subnet ID.

" }, "networkInterface":{ "shape":"NetworkInterface", "documentation":"

Describes a network interface.

" } }, "documentation":"

Information about a build.

" }, "BuildArtifacts":{ "type":"structure", "members":{ "location":{ "shape":"String", "documentation":"

Information about the location of the build artifacts.

" }, "sha256sum":{ "shape":"String", "documentation":"

The SHA-256 hash of the build artifact.

You can use this hash along with a checksum tool to confirm both file integrity and authenticity.

This value is available only if the build project's packaging value is set to ZIP.

" }, "md5sum":{ "shape":"String", "documentation":"

The MD5 hash of the build artifact.

You can use this hash along with a checksum tool to confirm both file integrity and authenticity.

This value is available only if the build project's packaging value is set to ZIP.

" } }, "documentation":"

Information about build output artifacts.

" }, "BuildIds":{ "type":"list", "member":{"shape":"NonEmptyString"}, "max":100, "min":1 }, "BuildNotDeleted":{ "type":"structure", "members":{ "id":{ "shape":"NonEmptyString", "documentation":"

The ID of the build that could not be successfully deleted.

" }, "statusCode":{ "shape":"String", "documentation":"

Additional information about the build that could not be successfully deleted.

" } }, "documentation":"

Information about a build that could not be successfully deleted.

" }, "BuildPhase":{ "type":"structure", "members":{ "phaseType":{ "shape":"BuildPhaseType", "documentation":"

The name of the build phase. Valid values include:

" }, "phaseStatus":{ "shape":"StatusType", "documentation":"

The current status of the build phase. Valid values include:

" }, "startTime":{ "shape":"Timestamp", "documentation":"

When the build phase started, expressed in Unix time format.

" }, "endTime":{ "shape":"Timestamp", "documentation":"

When the build phase ended, expressed in Unix time format.

" }, "durationInSeconds":{ "shape":"WrapperLong", "documentation":"

How long, in seconds, between the starting and ending times of the build's phase.

" }, "contexts":{ "shape":"PhaseContexts", "documentation":"

Additional information about a build phase, especially to help troubleshoot a failed build.

" } }, "documentation":"

Information about a stage for a build.

" }, "BuildPhaseType":{ "type":"string", "enum":[ "SUBMITTED", "PROVISIONING", "DOWNLOAD_SOURCE", "INSTALL", "PRE_BUILD", "BUILD", "POST_BUILD", "UPLOAD_ARTIFACTS", "FINALIZING", "COMPLETED" ] }, "BuildPhases":{ "type":"list", "member":{"shape":"BuildPhase"} }, "Builds":{ "type":"list", "member":{"shape":"Build"} }, "BuildsNotDeleted":{ "type":"list", "member":{"shape":"BuildNotDeleted"} }, "CacheType":{ "type":"string", "enum":[ "NO_CACHE", "S3" ] }, "ComputeType":{ "type":"string", "enum":[ "BUILD_GENERAL1_SMALL", "BUILD_GENERAL1_MEDIUM", "BUILD_GENERAL1_LARGE" ] }, "CreateProjectInput":{ "type":"structure", "required":[ "name", "source", "artifacts", "environment" ], "members":{ "name":{ "shape":"ProjectName", "documentation":"

The name of the build project.

" }, "description":{ "shape":"ProjectDescription", "documentation":"

A description that makes the build project easy to identify.

" }, "source":{ "shape":"ProjectSource", "documentation":"

Information about the build input source code for the build project.

" }, "artifacts":{ "shape":"ProjectArtifacts", "documentation":"

Information about the build output artifacts for the build project.

" }, "cache":{ "shape":"ProjectCache", "documentation":"

Stores recently used information so that it can be quickly accessed at a later time.

" }, "environment":{ "shape":"ProjectEnvironment", "documentation":"

Information about the build environment for the build project.

" }, "serviceRole":{ "shape":"NonEmptyString", "documentation":"

The ARN of the AWS Identity and Access Management (IAM) role that enables AWS CodeBuild to interact with dependent AWS services on behalf of the AWS account.

" }, "timeoutInMinutes":{ "shape":"TimeOut", "documentation":"

How long, in minutes, from 5 to 480 (8 hours), for AWS CodeBuild to wait until timing out any build that has not been marked as completed. The default is 60 minutes.

" }, "encryptionKey":{ "shape":"NonEmptyString", "documentation":"

The AWS Key Management Service (AWS KMS) customer master key (CMK) to be used for encrypting the build output artifacts.

You can specify either the CMK's Amazon Resource Name (ARN) or, if available, the CMK's alias (using the format alias/alias-name ).

" }, "tags":{ "shape":"TagList", "documentation":"

A set of tags for this build project.

These tags are available for use by AWS services that support AWS CodeBuild build project tags.

" }, "vpcConfig":{ "shape":"VpcConfig", "documentation":"

VpcConfig enables AWS CodeBuild to access resources in an Amazon VPC.

" }, "badgeEnabled":{ "shape":"WrapperBoolean", "documentation":"

Set this to true to generate a publicly-accessible URL for your project's build badge.

" } } }, "CreateProjectOutput":{ "type":"structure", "members":{ "project":{ "shape":"Project", "documentation":"

Information about the build project that was created.

" } } }, "CreateWebhookInput":{ "type":"structure", "required":["projectName"], "members":{ "projectName":{ "shape":"ProjectName", "documentation":"

The name of the build project.

" } } }, "CreateWebhookOutput":{ "type":"structure", "members":{ "webhook":{ "shape":"Webhook", "documentation":"

Information about a webhook in GitHub that connects repository events to a build project in AWS CodeBuild.

" } } }, "DeleteProjectInput":{ "type":"structure", "required":["name"], "members":{ "name":{ "shape":"NonEmptyString", "documentation":"

The name of the build project.

" } } }, "DeleteProjectOutput":{ "type":"structure", "members":{ } }, "DeleteWebhookInput":{ "type":"structure", "required":["projectName"], "members":{ "projectName":{ "shape":"ProjectName", "documentation":"

The name of the build project.

" } } }, "DeleteWebhookOutput":{ "type":"structure", "members":{ } }, "EnvironmentImage":{ "type":"structure", "members":{ "name":{ "shape":"String", "documentation":"

The name of the Docker image.

" }, "description":{ "shape":"String", "documentation":"

The description of the Docker image.

" }, "versions":{ "shape":"ImageVersions", "documentation":"

A list of environment image versions.

" } }, "documentation":"

Information about a Docker image that is managed by AWS CodeBuild.

" }, "EnvironmentImages":{ "type":"list", "member":{"shape":"EnvironmentImage"} }, "EnvironmentLanguage":{ "type":"structure", "members":{ "language":{ "shape":"LanguageType", "documentation":"

The programming language for the Docker images.

" }, "images":{ "shape":"EnvironmentImages", "documentation":"

The list of Docker images that are related by the specified programming language.

" } }, "documentation":"

A set of Docker images that are related by programming language and are managed by AWS CodeBuild.

" }, "EnvironmentLanguages":{ "type":"list", "member":{"shape":"EnvironmentLanguage"} }, "EnvironmentPlatform":{ "type":"structure", "members":{ "platform":{ "shape":"PlatformType", "documentation":"

The platform's name.

" }, "languages":{ "shape":"EnvironmentLanguages", "documentation":"

The list of programming languages that are available for the specified platform.

" } }, "documentation":"

A set of Docker images that are related by platform and are managed by AWS CodeBuild.

" }, "EnvironmentPlatforms":{ "type":"list", "member":{"shape":"EnvironmentPlatform"} }, "EnvironmentType":{ "type":"string", "enum":["LINUX_CONTAINER"] }, "EnvironmentVariable":{ "type":"structure", "required":[ "name", "value" ], "members":{ "name":{ "shape":"NonEmptyString", "documentation":"

The name or key of the environment variable.

" }, "value":{ "shape":"String", "documentation":"

The value of the environment variable.

We strongly discourage using environment variables to store sensitive values, especially AWS secret key IDs and secret access keys. Environment variables can be displayed in plain text using tools such as the AWS CodeBuild console and the AWS Command Line Interface (AWS CLI).

" }, "type":{ "shape":"EnvironmentVariableType", "documentation":"

The type of environment variable. Valid values include:

" } }, "documentation":"

Information about an environment variable for a build project or a build.

" }, "EnvironmentVariableType":{ "type":"string", "enum":[ "PLAINTEXT", "PARAMETER_STORE" ] }, "EnvironmentVariables":{ "type":"list", "member":{"shape":"EnvironmentVariable"} }, "GitCloneDepth":{ "type":"integer", "min":0 }, "ImageVersions":{ "type":"list", "member":{"shape":"String"} }, "InvalidInputException":{ "type":"structure", "members":{ }, "documentation":"

The input value that was provided is not valid.

", "exception":true }, "InvalidateProjectCacheInput":{ "type":"structure", "required":["projectName"], "members":{ "projectName":{ "shape":"NonEmptyString", "documentation":"

The name of the build project that the cache will be reset for.

" } } }, "InvalidateProjectCacheOutput":{ "type":"structure", "members":{ } }, "KeyInput":{ "type":"string", "max":127, "min":1, "pattern":"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=@+\\\\-]*)$" }, "LanguageType":{ "type":"string", "enum":[ "JAVA", "PYTHON", "NODE_JS", "RUBY", "GOLANG", "DOCKER", "ANDROID", "DOTNET", "BASE" ] }, "ListBuildsForProjectInput":{ "type":"structure", "required":["projectName"], "members":{ "projectName":{ "shape":"NonEmptyString", "documentation":"

The name of the build project.

" }, "sortOrder":{ "shape":"SortOrderType", "documentation":"

The order to list build IDs. Valid values include:

" }, "nextToken":{ "shape":"String", "documentation":"

During a previous call, if there are more than 100 items in the list, only the first 100 items are returned, along with a unique string called a next token. To get the next batch of items in the list, call this operation again, adding the next token to the call. To get all of the items in the list, keep calling this operation with each subsequent next token that is returned, until no more next tokens are returned.

" } } }, "ListBuildsForProjectOutput":{ "type":"structure", "members":{ "ids":{ "shape":"BuildIds", "documentation":"

A list of build IDs for the specified build project, with each build ID representing a single build.

" }, "nextToken":{ "shape":"String", "documentation":"

If there are more than 100 items in the list, only the first 100 items are returned, along with a unique string called a next token. To get the next batch of items in the list, call this operation again, adding the next token to the call.

" } } }, "ListBuildsInput":{ "type":"structure", "members":{ "sortOrder":{ "shape":"SortOrderType", "documentation":"

The order to list build IDs. Valid values include:

" }, "nextToken":{ "shape":"String", "documentation":"

During a previous call, if there are more than 100 items in the list, only the first 100 items are returned, along with a unique string called a next token. To get the next batch of items in the list, call this operation again, adding the next token to the call. To get all of the items in the list, keep calling this operation with each subsequent next token that is returned, until no more next tokens are returned.

" } } }, "ListBuildsOutput":{ "type":"structure", "members":{ "ids":{ "shape":"BuildIds", "documentation":"

A list of build IDs, with each build ID representing a single build.

" }, "nextToken":{ "shape":"String", "documentation":"

If there are more than 100 items in the list, only the first 100 items are returned, along with a unique string called a next token. To get the next batch of items in the list, call this operation again, adding the next token to the call.

" } } }, "ListCuratedEnvironmentImagesInput":{ "type":"structure", "members":{ } }, "ListCuratedEnvironmentImagesOutput":{ "type":"structure", "members":{ "platforms":{ "shape":"EnvironmentPlatforms", "documentation":"

Information about supported platforms for Docker images that are managed by AWS CodeBuild.

" } } }, "ListProjectsInput":{ "type":"structure", "members":{ "sortBy":{ "shape":"ProjectSortByType", "documentation":"

The criterion to be used to list build project names. Valid values include:

Use sortOrder to specify in what order to list the build project names based on the preceding criteria.

" }, "sortOrder":{ "shape":"SortOrderType", "documentation":"

The order in which to list build projects. Valid values include:

Use sortBy to specify the criterion to be used to list build project names.

" }, "nextToken":{ "shape":"NonEmptyString", "documentation":"

During a previous call, if there are more than 100 items in the list, only the first 100 items are returned, along with a unique string called a next token. To get the next batch of items in the list, call this operation again, adding the next token to the call. To get all of the items in the list, keep calling this operation with each subsequent next token that is returned, until no more next tokens are returned.

" } } }, "ListProjectsOutput":{ "type":"structure", "members":{ "nextToken":{ "shape":"String", "documentation":"

If there are more than 100 items in the list, only the first 100 items are returned, along with a unique string called a next token. To get the next batch of items in the list, call this operation again, adding the next token to the call.

" }, "projects":{ "shape":"ProjectNames", "documentation":"

The list of build project names, with each build project name representing a single build project.

" } } }, "LogsLocation":{ "type":"structure", "members":{ "groupName":{ "shape":"String", "documentation":"

The name of the Amazon CloudWatch Logs group for the build logs.

" }, "streamName":{ "shape":"String", "documentation":"

The name of the Amazon CloudWatch Logs stream for the build logs.

" }, "deepLink":{ "shape":"String", "documentation":"

The URL to an individual build log in Amazon CloudWatch Logs.

" } }, "documentation":"

Information about build logs in Amazon CloudWatch Logs.

" }, "NetworkInterface":{ "type":"structure", "members":{ "subnetId":{ "shape":"NonEmptyString", "documentation":"

The ID of the subnet.

" }, "networkInterfaceId":{ "shape":"NonEmptyString", "documentation":"

The ID of the network interface.

" } }, "documentation":"

Describes a network interface.

" }, "NonEmptyString":{ "type":"string", "min":1 }, "OAuthProviderException":{ "type":"structure", "members":{ }, "documentation":"

There was a problem with the underlying OAuth provider.

", "exception":true }, "PhaseContext":{ "type":"structure", "members":{ "statusCode":{ "shape":"String", "documentation":"

The status code for the context of the build phase.

" }, "message":{ "shape":"String", "documentation":"

An explanation of the build phase's context. This explanation might include a command ID and an exit code.

" } }, "documentation":"

Additional information about a build phase that has an error. You can use this information to help troubleshoot a failed build.

" }, "PhaseContexts":{ "type":"list", "member":{"shape":"PhaseContext"} }, "PlatformType":{ "type":"string", "enum":[ "DEBIAN", "AMAZON_LINUX", "UBUNTU" ] }, "Project":{ "type":"structure", "members":{ "name":{ "shape":"ProjectName", "documentation":"

The name of the build project.

" }, "arn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) of the build project.

" }, "description":{ "shape":"ProjectDescription", "documentation":"

A description that makes the build project easy to identify.

" }, "source":{ "shape":"ProjectSource", "documentation":"

Information about the build input source code for this build project.

" }, "artifacts":{ "shape":"ProjectArtifacts", "documentation":"

Information about the build output artifacts for the build project.

" }, "cache":{ "shape":"ProjectCache", "documentation":"

Information about the cache for the build project.

" }, "environment":{ "shape":"ProjectEnvironment", "documentation":"

Information about the build environment for this build project.

" }, "serviceRole":{ "shape":"NonEmptyString", "documentation":"

The ARN of the AWS Identity and Access Management (IAM) role that enables AWS CodeBuild to interact with dependent AWS services on behalf of the AWS account.

" }, "timeoutInMinutes":{ "shape":"TimeOut", "documentation":"

How long, in minutes, from 5 to 480 (8 hours), for AWS CodeBuild to wait before timing out any related build that did not get marked as completed. The default is 60 minutes.

" }, "encryptionKey":{ "shape":"NonEmptyString", "documentation":"

The AWS Key Management Service (AWS KMS) customer master key (CMK) to be used for encrypting the build output artifacts.

This is expressed either as the CMK's Amazon Resource Name (ARN) or, if specified, the CMK's alias (using the format alias/alias-name ).

" }, "tags":{ "shape":"TagList", "documentation":"

The tags for this build project.

These tags are available for use by AWS services that support AWS CodeBuild build project tags.

" }, "created":{ "shape":"Timestamp", "documentation":"

When the build project was created, expressed in Unix time format.

" }, "lastModified":{ "shape":"Timestamp", "documentation":"

When the build project's settings were last modified, expressed in Unix time format.

" }, "webhook":{ "shape":"Webhook", "documentation":"

Information about a webhook in GitHub that connects repository events to a build project in AWS CodeBuild.

" }, "vpcConfig":{ "shape":"VpcConfig", "documentation":"

Information about the VPC configuration that AWS CodeBuild will access.

" }, "badge":{ "shape":"ProjectBadge", "documentation":"

Information about the build badge for the build project.

" } }, "documentation":"

Information about a build project.

" }, "ProjectArtifacts":{ "type":"structure", "required":["type"], "members":{ "type":{ "shape":"ArtifactsType", "documentation":"

The type of build output artifact. Valid values include:

" }, "location":{ "shape":"String", "documentation":"

Information about the build output artifact location, as follows:

" }, "path":{ "shape":"String", "documentation":"

Along with namespaceType and name, the pattern that AWS CodeBuild will use to name and store the output artifact, as follows:

For example, if path is set to MyArtifacts, namespaceType is set to NONE, and name is set to MyArtifact.zip, then the output artifact would be stored in the output bucket at MyArtifacts/MyArtifact.zip.

" }, "namespaceType":{ "shape":"ArtifactNamespace", "documentation":"

Along with path and name, the pattern that AWS CodeBuild will use to determine the name and location to store the output artifact, as follows:

For example, if path is set to MyArtifacts, namespaceType is set to BUILD_ID, and name is set to MyArtifact.zip, then the output artifact would be stored in MyArtifacts/build-ID/MyArtifact.zip.

" }, "name":{ "shape":"String", "documentation":"

Along with path and namespaceType, the pattern that AWS CodeBuild will use to name and store the output artifact, as follows:

For example, if path is set to MyArtifacts, namespaceType is set to BUILD_ID, and name is set to MyArtifact.zip, then the output artifact would be stored in MyArtifacts/build-ID/MyArtifact.zip.

" }, "packaging":{ "shape":"ArtifactPackaging", "documentation":"

The type of build output artifact to create, as follows:

" } }, "documentation":"

Information about the build output artifacts for the build project.

" }, "ProjectBadge":{ "type":"structure", "members":{ "badgeEnabled":{ "shape":"Boolean", "documentation":"

Set this to true to generate a publicly-accessible URL for your project's build badge.

" }, "badgeRequestUrl":{ "shape":"String", "documentation":"

The publicly-accessible URL through which you can access the build badge for your project.

" } }, "documentation":"

Information about the build badge for the build project.

" }, "ProjectCache":{ "type":"structure", "required":["type"], "members":{ "type":{ "shape":"CacheType", "documentation":"

The type of cache used by the build project. Valid values include:

" }, "location":{ "shape":"String", "documentation":"

Information about the cache location, as follows:

" } }, "documentation":"

Information about the cache for the build project.

" }, "ProjectDescription":{ "type":"string", "max":255, "min":0 }, "ProjectEnvironment":{ "type":"structure", "required":[ "type", "image", "computeType" ], "members":{ "type":{ "shape":"EnvironmentType", "documentation":"

The type of build environment to use for related builds.

" }, "image":{ "shape":"NonEmptyString", "documentation":"

The ID of the Docker image to use for this build project.

" }, "computeType":{ "shape":"ComputeType", "documentation":"

Information about the compute resources the build project will use. Available values include:

" }, "environmentVariables":{ "shape":"EnvironmentVariables", "documentation":"

A set of environment variables to make available to builds for this build project.

" }, "privilegedMode":{ "shape":"WrapperBoolean", "documentation":"

If set to true, enables running the Docker daemon inside a Docker container; otherwise, false or not specified (the default). This value must be set to true only if this build project will be used to build Docker images, and the specified build environment image is not one provided by AWS CodeBuild with Docker support. Otherwise, all associated builds that attempt to interact with the Docker daemon will fail. Note that you must also start the Docker daemon so that your builds can interact with it as needed. One way to do this is to initialize the Docker daemon in the install phase of your build spec by running the following build commands. (Do not run the following build commands if the specified build environment image is provided by AWS CodeBuild with Docker support.)

- nohup /usr/local/bin/dockerd --host=unix:///var/run/docker.sock --host=tcp://0.0.0.0:2375 --storage-driver=overlay& - timeout -t 15 sh -c \"until docker info; do echo .; sleep 1; done\"

" }, "certificate":{ "shape":"String", "documentation":"

The certificate to use with this build project.

" } }, "documentation":"

Information about the build environment of the build project.

" }, "ProjectName":{ "type":"string", "max":255, "min":2, "pattern":"[A-Za-z0-9][A-Za-z0-9\\-_]{1,254}" }, "ProjectNames":{ "type":"list", "member":{"shape":"NonEmptyString"}, "max":100, "min":1 }, "ProjectSortByType":{ "type":"string", "enum":[ "NAME", "CREATED_TIME", "LAST_MODIFIED_TIME" ] }, "ProjectSource":{ "type":"structure", "required":["type"], "members":{ "type":{ "shape":"SourceType", "documentation":"

The type of repository that contains the source code to be built. Valid values include:

" }, "location":{ "shape":"String", "documentation":"

Information about the location of the source code to be built. Valid values include:

" }, "gitCloneDepth":{ "shape":"GitCloneDepth", "documentation":"

Information about the git clone depth for the build project.

" }, "buildspec":{ "shape":"String", "documentation":"

The build spec declaration to use for the builds in this build project.

If this value is not specified, a build spec must be included along with the source code to be built.

" }, "auth":{ "shape":"SourceAuth", "documentation":"

Information about the authorization settings for AWS CodeBuild to access the source code to be built.

This information is for the AWS CodeBuild console's use only. Your code should not get or set this information directly (unless the build project's source type value is BITBUCKET or GITHUB).

" }, "insecureSsl":{ "shape":"WrapperBoolean", "documentation":"

Enable this flag to ignore SSL warnings while connecting to the project source code.

" } }, "documentation":"

Information about the build input source code for the build project.

" }, "Projects":{ "type":"list", "member":{"shape":"Project"} }, "ResourceAlreadyExistsException":{ "type":"structure", "members":{ }, "documentation":"

The specified AWS resource cannot be created, because an AWS resource with the same settings already exists.

", "exception":true }, "ResourceNotFoundException":{ "type":"structure", "members":{ }, "documentation":"

The specified AWS resource cannot be found.

", "exception":true }, "SecurityGroupIds":{ "type":"list", "member":{"shape":"NonEmptyString"}, "max":5 }, "SortOrderType":{ "type":"string", "enum":[ "ASCENDING", "DESCENDING" ] }, "SourceAuth":{ "type":"structure", "required":["type"], "members":{ "type":{ "shape":"SourceAuthType", "documentation":"

The authorization type to use. The only valid value is OAUTH, which represents the OAuth authorization type.

" }, "resource":{ "shape":"String", "documentation":"

The resource value that applies to the specified authorization type.

" } }, "documentation":"

Information about the authorization settings for AWS CodeBuild to access the source code to be built.

This information is for the AWS CodeBuild console's use only. Your code should not get or set this information directly (unless the build project's source type value is BITBUCKET or GITHUB).

" }, "SourceAuthType":{ "type":"string", "enum":["OAUTH"] }, "SourceType":{ "type":"string", "enum":[ "CODECOMMIT", "CODEPIPELINE", "GITHUB", "S3", "BITBUCKET", "GITHUB_ENTERPRISE" ] }, "StartBuildInput":{ "type":"structure", "required":["projectName"], "members":{ "projectName":{ "shape":"NonEmptyString", "documentation":"

The name of the build project to start running a build.

" }, "sourceVersion":{ "shape":"String", "documentation":"

A version of the build input to be built, for this build only. If not specified, the latest version will be used. If specified, must be one of:

" }, "artifactsOverride":{ "shape":"ProjectArtifacts", "documentation":"

Build output artifact settings that override, for this build only, the latest ones already defined in the build project.

" }, "environmentVariablesOverride":{ "shape":"EnvironmentVariables", "documentation":"

A set of environment variables that overrides, for this build only, the latest ones already defined in the build project.

" }, "gitCloneDepthOverride":{ "shape":"GitCloneDepth", "documentation":"

The user-defined depth of history, with a minimum value of 0, that overrides, for this build only, any previous depth of history defined in the build project.

" }, "buildspecOverride":{ "shape":"String", "documentation":"

A build spec declaration that overrides, for this build only, the latest one already defined in the build project.

" }, "timeoutInMinutesOverride":{ "shape":"TimeOut", "documentation":"

The number of build timeout minutes, from 5 to 480 (8 hours), that overrides, for this build only, the latest setting already defined in the build project.

" } } }, "StartBuildOutput":{ "type":"structure", "members":{ "build":{ "shape":"Build", "documentation":"

Information about the build to be run.

" } } }, "StatusType":{ "type":"string", "enum":[ "SUCCEEDED", "FAILED", "FAULT", "TIMED_OUT", "IN_PROGRESS", "STOPPED" ] }, "StopBuildInput":{ "type":"structure", "required":["id"], "members":{ "id":{ "shape":"NonEmptyString", "documentation":"

The ID of the build.

" } } }, "StopBuildOutput":{ "type":"structure", "members":{ "build":{ "shape":"Build", "documentation":"

Information about the build.

" } } }, "String":{"type":"string"}, "Subnets":{ "type":"list", "member":{"shape":"NonEmptyString"}, "max":16 }, "Tag":{ "type":"structure", "members":{ "key":{ "shape":"KeyInput", "documentation":"

The tag's key.

" }, "value":{ "shape":"ValueInput", "documentation":"

The tag's value.

" } }, "documentation":"

A tag, consisting of a key and a value.

This tag is available for use by AWS services that support tags in AWS CodeBuild.

" }, "TagList":{ "type":"list", "member":{"shape":"Tag"}, "max":50, "min":0 }, "TimeOut":{ "type":"integer", "max":480, "min":5 }, "Timestamp":{"type":"timestamp"}, "UpdateProjectInput":{ "type":"structure", "required":["name"], "members":{ "name":{ "shape":"NonEmptyString", "documentation":"

The name of the build project.

You cannot change a build project's name.

" }, "description":{ "shape":"ProjectDescription", "documentation":"

A new or replacement description of the build project.

" }, "source":{ "shape":"ProjectSource", "documentation":"

Information to be changed about the build input source code for the build project.

" }, "artifacts":{ "shape":"ProjectArtifacts", "documentation":"

Information to be changed about the build output artifacts for the build project.

" }, "cache":{ "shape":"ProjectCache", "documentation":"

Stores recently used information so that it can be quickly accessed at a later time.

" }, "environment":{ "shape":"ProjectEnvironment", "documentation":"

Information to be changed about the build environment for the build project.

" }, "serviceRole":{ "shape":"NonEmptyString", "documentation":"

The replacement ARN of the AWS Identity and Access Management (IAM) role that enables AWS CodeBuild to interact with dependent AWS services on behalf of the AWS account.

" }, "timeoutInMinutes":{ "shape":"TimeOut", "documentation":"

The replacement value in minutes, from 5 to 480 (8 hours), for AWS CodeBuild to wait before timing out any related build that did not get marked as completed.

" }, "encryptionKey":{ "shape":"NonEmptyString", "documentation":"

The replacement AWS Key Management Service (AWS KMS) customer master key (CMK) to be used for encrypting the build output artifacts.

You can specify either the CMK's Amazon Resource Name (ARN) or, if available, the CMK's alias (using the format alias/alias-name ).

" }, "tags":{ "shape":"TagList", "documentation":"

The replacement set of tags for this build project.

These tags are available for use by AWS services that support AWS CodeBuild build project tags.

" }, "vpcConfig":{ "shape":"VpcConfig", "documentation":"

VpcConfig enables AWS CodeBuild to access resources in an Amazon VPC.

" }, "badgeEnabled":{ "shape":"WrapperBoolean", "documentation":"

Set this to true to generate a publicly-accessible URL for your project's build badge.

" } } }, "UpdateProjectOutput":{ "type":"structure", "members":{ "project":{ "shape":"Project", "documentation":"

Information about the build project that was changed.

" } } }, "ValueInput":{ "type":"string", "max":255, "min":1, "pattern":"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=@+\\\\-]*)$" }, "VpcConfig":{ "type":"structure", "members":{ "vpcId":{ "shape":"NonEmptyString", "documentation":"

The ID of the Amazon VPC.

" }, "subnets":{ "shape":"Subnets", "documentation":"

A list of one or more subnet IDs in your Amazon VPC.

" }, "securityGroupIds":{ "shape":"SecurityGroupIds", "documentation":"

A list of one or more security groups IDs in your Amazon VPC.

" } }, "documentation":"

Information about the VPC configuration that AWS CodeBuild will access.

" }, "Webhook":{ "type":"structure", "members":{ "url":{ "shape":"NonEmptyString", "documentation":"

The URL to the webhook.

" }, "payloadUrl":{ "shape":"NonEmptyString", "documentation":"

This is the server endpoint that will receive the webhook payload.

" }, "secret":{ "shape":"NonEmptyString", "documentation":"

Use this secret while creating a webhook in GitHub for Enterprise. The secret allows webhook requests sent by GitHub for Enterprise to be authenticated by AWS CodeBuild.

" } }, "documentation":"

Information about a webhook in GitHub that connects repository events to a build project in AWS CodeBuild.

" }, "WrapperBoolean":{"type":"boolean"}, "WrapperInt":{"type":"integer"}, "WrapperLong":{"type":"long"} }, "documentation":"AWS CodeBuild

AWS CodeBuild is a fully managed build service in the cloud. AWS CodeBuild compiles your source code, runs unit tests, and produces artifacts that are ready to deploy. AWS CodeBuild eliminates the need to provision, manage, and scale your own build servers. It provides prepackaged build environments for the most popular programming languages and build tools, such as Apache Maven, Gradle, and more. You can also fully customize build environments in AWS CodeBuild to use your own build tools. AWS CodeBuild scales automatically to meet peak build requests, and you pay only for the build time you consume. For more information about AWS CodeBuild, see the AWS CodeBuild User Guide.

AWS CodeBuild supports these operations:

" }