{ "version": "2.0", "service": "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. 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:

", "operations": { "BatchDeleteBuilds": "

Deletes one or more builds.

", "BatchGetBuilds": "

Gets information about builds.

", "BatchGetProjects": "

Gets information about build projects.

", "CreateProject": "

Creates a build project.

", "CreateWebhook": "

For an existing AWS CodeBuild build project that has its source code stored in a GitHub or Bitbucket repository, enables AWS CodeBuild to start 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 are created for each commit. One build is triggered through webhooks, and one through AWS CodePipeline. Because billing is on a per-build basis, you are billed for both builds. Therefore, if you are using AWS CodePipeline, we recommend that you disable webhooks in AWS CodeBuild. In the AWS CodeBuild console, clear the Webhook box. For more information, see step 5 in Change a Build Project's Settings.

", "DeleteProject": "

Deletes a build project.

", "DeleteSourceCredentials": "

Deletes a set of GitHub, GitHub Enterprise, or Bitbucket source credentials.

", "DeleteWebhook": "

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

", "ImportSourceCredentials": "

Imports the source repository credentials for an AWS CodeBuild project that has its source code stored in a GitHub, GitHub Enterprise, or Bitbucket repository.

", "InvalidateProjectCache": "

Resets the cache for a project.

", "ListBuilds": "

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

", "ListBuildsForProject": "

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

", "ListCuratedEnvironmentImages": "

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

", "ListProjects": "

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

", "ListSourceCredentials": "

Returns a list of SourceCredentialsInfo objects.

", "StartBuild": "

Starts running a build.

", "StopBuild": "

Attempts to stop running a build.

", "UpdateProject": "

Changes the settings of a build project.

", "UpdateWebhook": "

Updates the webhook associated with an AWS CodeBuild build project.

If you use Bitbucket for your repository, rotateSecret is ignored.

" }, "shapes": { "AccountLimitExceededException": { "base": "

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

", "refs": { } }, "ArtifactNamespace": { "base": null, "refs": { "ProjectArtifacts$namespaceType": "

Along with path and name, the pattern that AWS CodeBuild uses to determine the name and location to store the output artifact:

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

" } }, "ArtifactPackaging": { "base": null, "refs": { "ProjectArtifacts$packaging": "

The type of build output artifact to create:

" } }, "ArtifactsType": { "base": null, "refs": { "ProjectArtifacts$type": "

The type of build output artifact. Valid values include:

" } }, "AuthType": { "base": null, "refs": { "ImportSourceCredentialsInput$authType": "

The type of authentication used to connect to a GitHub, GitHub Enterprise, or Bitbucket repository. An OAUTH connection is not supported by the API and must be created using the AWS CodeBuild console.

", "SourceCredentialsInfo$authType": "

The type of authentication used by the credentials. Valid options are OAUTH, BASIC_AUTH, or PERSONAL_ACCESS_TOKEN.

" } }, "BatchDeleteBuildsInput": { "base": null, "refs": { } }, "BatchDeleteBuildsOutput": { "base": null, "refs": { } }, "BatchGetBuildsInput": { "base": null, "refs": { } }, "BatchGetBuildsOutput": { "base": null, "refs": { } }, "BatchGetProjectsInput": { "base": null, "refs": { } }, "BatchGetProjectsOutput": { "base": null, "refs": { } }, "Boolean": { "base": null, "refs": { "Build$buildComplete": "

Whether the build is complete. True if complete; otherwise, false.

", "ProjectBadge$badgeEnabled": "

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

", "UpdateWebhookInput$rotateSecret": "

A boolean value that specifies whether the associated GitHub repository's secret token should be updated. If you use Bitbucket for your repository, rotateSecret is ignored.

" } }, "Build": { "base": "

Information about a build.

", "refs": { "Builds$member": null, "StartBuildOutput$build": "

Information about the build to be run.

", "StopBuildOutput$build": "

Information about the build.

" } }, "BuildArtifacts": { "base": "

Information about build output artifacts.

", "refs": { "Build$artifacts": "

Information about the output artifacts for the build.

", "BuildArtifactsList$member": null } }, "BuildArtifactsList": { "base": null, "refs": { "Build$secondaryArtifacts": "

An array of ProjectArtifacts objects.

" } }, "BuildIds": { "base": null, "refs": { "BatchDeleteBuildsInput$ids": "

The IDs of the builds to delete.

", "BatchDeleteBuildsOutput$buildsDeleted": "

The IDs of the builds that were successfully deleted.

", "BatchGetBuildsInput$ids": "

The IDs of the builds.

", "BatchGetBuildsOutput$buildsNotFound": "

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

", "ListBuildsForProjectOutput$ids": "

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

", "ListBuildsOutput$ids": "

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

" } }, "BuildNotDeleted": { "base": "

Information about a build that could not be successfully deleted.

", "refs": { "BuildsNotDeleted$member": null } }, "BuildPhase": { "base": "

Information about a stage for a build.

", "refs": { "BuildPhases$member": null } }, "BuildPhaseType": { "base": null, "refs": { "BuildPhase$phaseType": "

The name of the build phase. Valid values include:

" } }, "BuildPhases": { "base": null, "refs": { "Build$phases": "

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

" } }, "Builds": { "base": null, "refs": { "BatchGetBuildsOutput$builds": "

Information about the requested builds.

" } }, "BuildsNotDeleted": { "base": null, "refs": { "BatchDeleteBuildsOutput$buildsNotDeleted": "

Information about any builds that could not be successfully deleted.

" } }, "CacheType": { "base": null, "refs": { "ProjectCache$type": "

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

" } }, "CloudWatchLogsConfig": { "base": "

Information about Amazon CloudWatch Logs for a build project.

", "refs": { "LogsConfig$cloudWatchLogs": "

Information about Amazon CloudWatch Logs for a build project. Amazon CloudWatch Logs are enabled by default.

", "LogsLocation$cloudWatchLogs": "

Information about Amazon CloudWatch Logs for a build project.

" } }, "ComputeType": { "base": null, "refs": { "ProjectEnvironment$computeType": "

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

", "StartBuildInput$computeTypeOverride": "

The name of a compute type for this build that overrides the one specified in the build project.

" } }, "CreateProjectInput": { "base": null, "refs": { } }, "CreateProjectOutput": { "base": null, "refs": { } }, "CreateWebhookInput": { "base": null, "refs": { } }, "CreateWebhookOutput": { "base": null, "refs": { } }, "DeleteProjectInput": { "base": null, "refs": { } }, "DeleteProjectOutput": { "base": null, "refs": { } }, "DeleteSourceCredentialsInput": { "base": null, "refs": { } }, "DeleteSourceCredentialsOutput": { "base": null, "refs": { } }, "DeleteWebhookInput": { "base": null, "refs": { } }, "DeleteWebhookOutput": { "base": null, "refs": { } }, "EnvironmentImage": { "base": "

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

", "refs": { "EnvironmentImages$member": null } }, "EnvironmentImages": { "base": null, "refs": { "EnvironmentLanguage$images": "

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

" } }, "EnvironmentLanguage": { "base": "

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

", "refs": { "EnvironmentLanguages$member": null } }, "EnvironmentLanguages": { "base": null, "refs": { "EnvironmentPlatform$languages": "

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

" } }, "EnvironmentPlatform": { "base": "

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

", "refs": { "EnvironmentPlatforms$member": null } }, "EnvironmentPlatforms": { "base": null, "refs": { "ListCuratedEnvironmentImagesOutput$platforms": "

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

" } }, "EnvironmentType": { "base": null, "refs": { "ProjectEnvironment$type": "

The type of build environment to use for related builds.

", "StartBuildInput$environmentTypeOverride": "

A container type for this build that overrides the one specified in the build project.

" } }, "EnvironmentVariable": { "base": "

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

", "refs": { "EnvironmentVariables$member": null } }, "EnvironmentVariableType": { "base": null, "refs": { "EnvironmentVariable$type": "

The type of environment variable. Valid values include:

" } }, "EnvironmentVariables": { "base": null, "refs": { "ProjectEnvironment$environmentVariables": "

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

", "StartBuildInput$environmentVariablesOverride": "

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

" } }, "GitCloneDepth": { "base": null, "refs": { "ProjectSource$gitCloneDepth": "

Information about the git clone depth for the build project.

", "StartBuildInput$gitCloneDepthOverride": "

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.

" } }, "ImageVersions": { "base": null, "refs": { "EnvironmentImage$versions": "

A list of environment image versions.

" } }, "ImportSourceCredentialsInput": { "base": null, "refs": { } }, "ImportSourceCredentialsOutput": { "base": null, "refs": { } }, "InvalidInputException": { "base": "

The input value that was provided is not valid.

", "refs": { } }, "InvalidateProjectCacheInput": { "base": null, "refs": { } }, "InvalidateProjectCacheOutput": { "base": null, "refs": { } }, "KeyInput": { "base": null, "refs": { "Tag$key": "

The tag's key.

" } }, "LanguageType": { "base": null, "refs": { "EnvironmentLanguage$language": "

The programming language for the Docker images.

" } }, "ListBuildsForProjectInput": { "base": null, "refs": { } }, "ListBuildsForProjectOutput": { "base": null, "refs": { } }, "ListBuildsInput": { "base": null, "refs": { } }, "ListBuildsOutput": { "base": null, "refs": { } }, "ListCuratedEnvironmentImagesInput": { "base": null, "refs": { } }, "ListCuratedEnvironmentImagesOutput": { "base": null, "refs": { } }, "ListProjectsInput": { "base": null, "refs": { } }, "ListProjectsOutput": { "base": null, "refs": { } }, "ListSourceCredentialsInput": { "base": null, "refs": { } }, "ListSourceCredentialsOutput": { "base": null, "refs": { } }, "LogsConfig": { "base": "

Information about logs for a build project. These can be logs in Amazon CloudWatch Logs, built in a specified S3 bucket, or both.

", "refs": { "CreateProjectInput$logsConfig": "

Information about logs for the build project. These can be logs in Amazon CloudWatch Logs, logs uploaded to a specified S3 bucket, or both.

", "Project$logsConfig": "

Information about logs for the build project. A project can create logs in Amazon CloudWatch Logs, an S3 bucket, or both.

", "StartBuildInput$logsConfigOverride": "

Log settings for this build that override the log settings defined in the build project.

", "UpdateProjectInput$logsConfig": "

Information about logs for the build project. A project can create logs in Amazon CloudWatch Logs, logs in an S3 bucket, or both.

" } }, "LogsConfigStatusType": { "base": null, "refs": { "CloudWatchLogsConfig$status": "

The current status of the logs in Amazon CloudWatch Logs for a build project. Valid values are:

", "S3LogsConfig$status": "

The current status of the S3 build logs. Valid values are:

" } }, "LogsLocation": { "base": "

Information about build logs in Amazon CloudWatch Logs.

", "refs": { "Build$logs": "

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

" } }, "NetworkInterface": { "base": "

Describes a network interface.

", "refs": { "Build$networkInterface": "

Describes a network interface.

" } }, "NonEmptyString": { "base": null, "refs": { "Build$id": "

The unique ID for the build.

", "Build$arn": "

The Amazon Resource Name (ARN) of the build.

", "Build$sourceVersion": "

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

", "Build$resolvedSourceVersion": "

An identifier for the version of this build's source code.

", "Build$projectName": "

The name of the AWS CodeBuild project.

", "Build$serviceRole": "

The name of a service role used for this build.

", "Build$encryptionKey": "

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 Amazon Resource Name (ARN) of the CMK or, if specified, the CMK's alias (using the format alias/alias-name ).

", "BuildIds$member": null, "BuildNotDeleted$id": "

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

", "CreateProjectInput$serviceRole": "

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.

", "CreateProjectInput$encryptionKey": "

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 Amazon Resource Name (ARN) of the CMK or, if available, the CMK's alias (using the format alias/alias-name ).

", "DeleteProjectInput$name": "

The name of the build project.

", "DeleteSourceCredentialsInput$arn": "

The Amazon Resource Name (ARN) of the token.

", "DeleteSourceCredentialsOutput$arn": "

The Amazon Resource Name (ARN) of the token.

", "EnvironmentVariable$name": "

The name or key of the environment variable.

", "ImportSourceCredentialsInput$username": "

The Bitbucket username when the authType is BASIC_AUTH. This parameter is not valid for other types of source providers or connections.

", "ImportSourceCredentialsOutput$arn": "

The Amazon Resource Name (ARN) of the token.

", "InvalidateProjectCacheInput$projectName": "

The name of the AWS CodeBuild build project that the cache is reset for.

", "ListBuildsForProjectInput$projectName": "

The name of the AWS CodeBuild project.

", "ListProjectsInput$nextToken": "

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.

", "NetworkInterface$subnetId": "

The ID of the subnet.

", "NetworkInterface$networkInterfaceId": "

The ID of the network interface.

", "Project$serviceRole": "

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.

", "Project$encryptionKey": "

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 Amazon Resource Name (ARN) of the CMK or, if specified, the CMK's alias (using the format alias/alias-name ).

", "ProjectEnvironment$image": "

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

", "ProjectNames$member": null, "SecurityGroupIds$member": null, "SourceCredentialsInfo$arn": "

The Amazon Resource Name (ARN) of the token.

", "StartBuildInput$projectName": "

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

", "StartBuildInput$imageOverride": "

The name of an image for this build that overrides the one specified in the build project.

", "StartBuildInput$serviceRoleOverride": "

The name of a service role for this build that overrides the one specified in the build project.

", "StopBuildInput$id": "

The ID of the build.

", "Subnets$member": null, "UpdateProjectInput$name": "

The name of the build project.

You cannot change a build project's name.

", "UpdateProjectInput$serviceRole": "

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.

", "UpdateProjectInput$encryptionKey": "

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 Amazon Resource Name (ARN)of the CMK or, if available, the CMK's alias (using the format alias/alias-name ).

", "VpcConfig$vpcId": "

The ID of the Amazon VPC.

", "Webhook$url": "

The URL to the webhook.

", "Webhook$payloadUrl": "

The AWS CodeBuild endpoint where webhook events are sent.

", "Webhook$secret": "

The secret token of the associated repository.

A Bitbucket webhook does not support secret.

" } }, "OAuthProviderException": { "base": "

There was a problem with the underlying OAuth provider.

", "refs": { } }, "PhaseContext": { "base": "

Additional information about a build phase that has an error. You can use this information for troubleshooting.

", "refs": { "PhaseContexts$member": null } }, "PhaseContexts": { "base": null, "refs": { "BuildPhase$contexts": "

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

" } }, "PlatformType": { "base": null, "refs": { "EnvironmentPlatform$platform": "

The platform's name.

" } }, "Project": { "base": "

Information about a build project.

", "refs": { "CreateProjectOutput$project": "

Information about the build project that was created.

", "Projects$member": null, "UpdateProjectOutput$project": "

Information about the build project that was changed.

" } }, "ProjectArtifacts": { "base": "

Information about the build output artifacts for the build project.

", "refs": { "CreateProjectInput$artifacts": "

Information about the build output artifacts for the build project.

", "Project$artifacts": "

Information about the build output artifacts for the build project.

", "ProjectArtifactsList$member": null, "StartBuildInput$artifactsOverride": "

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

", "UpdateProjectInput$artifacts": "

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

" } }, "ProjectArtifactsList": { "base": null, "refs": { "CreateProjectInput$secondaryArtifacts": "

An array of ProjectArtifacts objects.

", "Project$secondaryArtifacts": "

An array of ProjectArtifacts objects.

", "StartBuildInput$secondaryArtifactsOverride": "

An array of ProjectArtifacts objects.

", "UpdateProjectInput$secondaryArtifacts": "

An array of ProjectSource objects.

" } }, "ProjectBadge": { "base": "

Information about the build badge for the build project.

", "refs": { "Project$badge": "

Information about the build badge for the build project.

" } }, "ProjectCache": { "base": "

Information about the cache for the build project.

", "refs": { "Build$cache": "

Information about the cache for the build.

", "CreateProjectInput$cache": "

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

", "Project$cache": "

Information about the cache for the build project.

", "StartBuildInput$cacheOverride": "

A ProjectCache object specified for this build that overrides the one defined in the build project.

", "UpdateProjectInput$cache": "

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

" } }, "ProjectDescription": { "base": null, "refs": { "CreateProjectInput$description": "

A description that makes the build project easy to identify.

", "Project$description": "

A description that makes the build project easy to identify.

", "UpdateProjectInput$description": "

A new or replacement description of the build project.

" } }, "ProjectEnvironment": { "base": "

Information about the build environment of the build project.

", "refs": { "Build$environment": "

Information about the build environment for this build.

", "CreateProjectInput$environment": "

Information about the build environment for the build project.

", "Project$environment": "

Information about the build environment for this build project.

", "UpdateProjectInput$environment": "

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

" } }, "ProjectName": { "base": null, "refs": { "CreateProjectInput$name": "

The name of the build project.

", "CreateWebhookInput$projectName": "

The name of the AWS CodeBuild project.

", "DeleteWebhookInput$projectName": "

The name of the AWS CodeBuild project.

", "Project$name": "

The name of the build project.

", "UpdateWebhookInput$projectName": "

The name of the AWS CodeBuild project.

" } }, "ProjectNames": { "base": null, "refs": { "BatchGetProjectsInput$names": "

The names of the build projects.

", "BatchGetProjectsOutput$projectsNotFound": "

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

", "ListProjectsOutput$projects": "

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

" } }, "ProjectSecondarySourceVersions": { "base": null, "refs": { "Build$secondarySourceVersions": "

An array of ProjectSourceVersion objects. Each ProjectSourceVersion must be one of:

", "StartBuildInput$secondarySourcesVersionOverride": "

An array of ProjectSourceVersion objects that specify one or more versions of the project's secondary sources to be used for this build only.

" } }, "ProjectSortByType": { "base": null, "refs": { "ListProjectsInput$sortBy": "

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.

" } }, "ProjectSource": { "base": "

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

", "refs": { "Build$source": "

Information about the source code to be built.

", "CreateProjectInput$source": "

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

", "Project$source": "

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

", "ProjectSources$member": null, "UpdateProjectInput$source": "

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

" } }, "ProjectSourceVersion": { "base": "

A source identifier and its corresponding version.

", "refs": { "ProjectSecondarySourceVersions$member": null } }, "ProjectSources": { "base": null, "refs": { "Build$secondarySources": "

An array of ProjectSource objects.

", "CreateProjectInput$secondarySources": "

An array of ProjectSource objects.

", "Project$secondarySources": "

An array of ProjectSource objects.

", "StartBuildInput$secondarySourcesOverride": "

An array of ProjectSource objects.

", "UpdateProjectInput$secondarySources": "

An array of ProjectSource objects.

" } }, "Projects": { "base": null, "refs": { "BatchGetProjectsOutput$projects": "

Information about the requested build projects.

" } }, "ResourceAlreadyExistsException": { "base": "

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

", "refs": { } }, "ResourceNotFoundException": { "base": "

The specified AWS resource cannot be found.

", "refs": { } }, "S3LogsConfig": { "base": "

Information about S3 logs for a build project.

", "refs": { "LogsConfig$s3Logs": "

Information about logs built to an S3 bucket for a build project. S3 logs are not enabled by default.

", "LogsLocation$s3Logs": "

Information about S3 logs for a build project.

" } }, "SecurityGroupIds": { "base": null, "refs": { "VpcConfig$securityGroupIds": "

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

" } }, "SensitiveNonEmptyString": { "base": null, "refs": { "ImportSourceCredentialsInput$token": "

For GitHub or GitHub Enterprise, this is the personal access token. For Bitbucket, this is the app password.

" } }, "ServerType": { "base": null, "refs": { "ImportSourceCredentialsInput$serverType": "

The source provider used for this project.

", "SourceCredentialsInfo$serverType": "

The type of source provider. The valid options are GITHUB, GITHUB_ENTERPRISE, or BITBUCKET.

" } }, "SortOrderType": { "base": null, "refs": { "ListBuildsForProjectInput$sortOrder": "

The order to list build IDs. Valid values include:

", "ListBuildsInput$sortOrder": "

The order to list build IDs. Valid values include:

", "ListProjectsInput$sortOrder": "

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.

" } }, "SourceAuth": { "base": "

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.

", "refs": { "ProjectSource$auth": "

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.

", "StartBuildInput$sourceAuthOverride": "

An authorization type for this build that overrides the one defined in the build project. This override applies only if the build project's source is BitBucket or GitHub.

" } }, "SourceAuthType": { "base": null, "refs": { "SourceAuth$type": "

This data type is deprecated and is no longer accurate or used.

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

" } }, "SourceCredentialsInfo": { "base": "

Information about the credentials for a GitHub, GitHub Enterprise, or Bitbucket repository.

", "refs": { "SourceCredentialsInfos$member": null } }, "SourceCredentialsInfos": { "base": null, "refs": { "ListSourceCredentialsOutput$sourceCredentialsInfos": "

A list of SourceCredentialsInfo objects. Each SourceCredentialsInfo object includes the authentication type, token ARN, and type of source provider for one set of credentials.

" } }, "SourceType": { "base": null, "refs": { "ProjectSource$type": "

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

", "StartBuildInput$sourceTypeOverride": "

A source input type, for this build, that overrides the source input defined in the build project.

" } }, "StartBuildInput": { "base": null, "refs": { } }, "StartBuildOutput": { "base": null, "refs": { } }, "StatusType": { "base": null, "refs": { "Build$buildStatus": "

The current status of the build. Valid values include:

", "BuildPhase$phaseStatus": "

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

" } }, "StopBuildInput": { "base": null, "refs": { } }, "StopBuildOutput": { "base": null, "refs": { } }, "String": { "base": null, "refs": { "Build$currentPhase": "

The current build phase.

", "Build$initiator": "

The entity that started the build. Valid values include:

", "BuildArtifacts$location": "

Information about the location of the build artifacts.

", "BuildArtifacts$sha256sum": "

The SHA-256 hash of the build artifact.

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

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

", "BuildArtifacts$md5sum": "

The MD5 hash of the build artifact.

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

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

", "BuildArtifacts$artifactIdentifier": "

An identifier for this artifact definition.

", "BuildNotDeleted$statusCode": "

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

", "CloudWatchLogsConfig$groupName": "

The group name of the logs in Amazon CloudWatch Logs. For more information, see Working with Log Groups and Log Streams.

", "CloudWatchLogsConfig$streamName": "

The prefix of the stream name of the Amazon CloudWatch Logs. For more information, see Working with Log Groups and Log Streams.

", "CreateWebhookInput$branchFilter": "

A regular expression used to determine which repository branches are built when a webhook is triggered. If the name of a branch matches the regular expression, then it is built. If branchFilter is empty, then all branches are built.

", "EnvironmentImage$name": "

The name of the Docker image.

", "EnvironmentImage$description": "

The description of the Docker image.

", "EnvironmentVariable$value": "

The value of the environment variable.

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

", "ImageVersions$member": null, "ListBuildsForProjectInput$nextToken": "

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$nextToken": "

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$nextToken": "

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$nextToken": "

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.

", "ListProjectsOutput$nextToken": "

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.

", "LogsLocation$groupName": "

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

", "LogsLocation$streamName": "

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

", "LogsLocation$deepLink": "

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

", "LogsLocation$s3DeepLink": "

The URL to a build log in an S3 bucket.

", "PhaseContext$statusCode": "

The status code for the context of the build phase.

", "PhaseContext$message": "

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

", "Project$arn": "

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

", "ProjectArtifacts$location": "

Information about the build output artifact location:

", "ProjectArtifacts$path": "

Along with namespaceType and name, the pattern that AWS CodeBuild uses to name and store the output artifact:

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

", "ProjectArtifacts$name": "

Along with path and namespaceType, the pattern that AWS CodeBuild uses to name and store the output artifact:

For example:

", "ProjectArtifacts$artifactIdentifier": "

An identifier for this artifact definition.

", "ProjectBadge$badgeRequestUrl": "

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

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

", "ProjectCache$location": "

Information about the cache location:

", "ProjectEnvironment$certificate": "

The certificate to use with this build project.

", "ProjectSource$location": "

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

", "ProjectSource$buildspec": "

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.

", "ProjectSource$sourceIdentifier": "

An identifier for this project source.

", "ProjectSourceVersion$sourceIdentifier": "

An identifier for a source in the build project.

", "ProjectSourceVersion$sourceVersion": "

The source version for the corresponding source identifier. If specified, must be one of:

", "S3LogsConfig$location": "

The ARN of an S3 bucket and the path prefix for S3 logs. If your Amazon S3 bucket name is my-bucket, and your path prefix is build-log, then acceptable formats are my-bucket/build-log or arn:aws:s3:::my-bucket/build-log.

", "SourceAuth$resource": "

The resource value that applies to the specified authorization type.

", "StartBuildInput$sourceVersion": "

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

", "StartBuildInput$sourceLocationOverride": "

A location that overrides, for this build, the source location for the one defined in the build project.

", "StartBuildInput$buildspecOverride": "

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

", "StartBuildInput$certificateOverride": "

The name of a certificate for this build that overrides the one specified in the build project.

", "StartBuildInput$idempotencyToken": "

A unique, case sensitive identifier you provide to ensure the idempotency of the StartBuild request. The token is included in the StartBuild request and is valid for 12 hours. If you repeat the StartBuild request with the same token, but change a parameter, AWS CodeBuild returns a parameter mismatch error.

", "UpdateWebhookInput$branchFilter": "

A regular expression used to determine which repository branches are built when a webhook is triggered. If the name of a branch matches the regular expression, then it is built. If branchFilter is empty, then all branches are built.

", "Webhook$branchFilter": "

A regular expression used to determine which repository branches are built when a webhook is triggered. If the name of a branch matches the regular expression, then it is built. If branchFilter is empty, then all branches are built.

" } }, "Subnets": { "base": null, "refs": { "VpcConfig$subnets": "

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

" } }, "Tag": { "base": "

A tag, consisting of a key and a value.

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

", "refs": { "TagList$member": null } }, "TagList": { "base": null, "refs": { "CreateProjectInput$tags": "

A set of tags for this build project.

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

", "Project$tags": "

The tags for this build project.

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

", "UpdateProjectInput$tags": "

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.

" } }, "TimeOut": { "base": null, "refs": { "CreateProjectInput$timeoutInMinutes": "

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

", "CreateProjectInput$queuedTimeoutInMinutes": "

The number of minutes a build is allowed to be queued before it times out.

", "Project$timeoutInMinutes": "

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.

", "Project$queuedTimeoutInMinutes": "

The number of minutes a build is allowed to be queued before it times out.

", "StartBuildInput$timeoutInMinutesOverride": "

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.

", "StartBuildInput$queuedTimeoutInMinutesOverride": "

The number of minutes a build is allowed to be queued before it times out.

", "UpdateProjectInput$timeoutInMinutes": "

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.

", "UpdateProjectInput$queuedTimeoutInMinutes": "

The number of minutes a build is allowed to be queued before it times out.

" } }, "Timestamp": { "base": null, "refs": { "Build$startTime": "

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

", "Build$endTime": "

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

", "BuildPhase$startTime": "

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

", "BuildPhase$endTime": "

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

", "Project$created": "

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

", "Project$lastModified": "

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

", "Webhook$lastModifiedSecret": "

A timestamp that indicates the last time a repository's secret token was modified.

" } }, "UpdateProjectInput": { "base": null, "refs": { } }, "UpdateProjectOutput": { "base": null, "refs": { } }, "UpdateWebhookInput": { "base": null, "refs": { } }, "UpdateWebhookOutput": { "base": null, "refs": { } }, "ValueInput": { "base": null, "refs": { "Tag$value": "

The tag's value.

" } }, "VpcConfig": { "base": "

Information about the VPC configuration that AWS CodeBuild accesses.

", "refs": { "Build$vpcConfig": "

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.

", "CreateProjectInput$vpcConfig": "

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

", "Project$vpcConfig": "

Information about the VPC configuration that AWS CodeBuild accesses.

", "UpdateProjectInput$vpcConfig": "

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

" } }, "Webhook": { "base": "

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

", "refs": { "CreateWebhookOutput$webhook": "

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

", "Project$webhook": "

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

", "UpdateWebhookOutput$webhook": "

Information about a repository's webhook that is associated with a project in AWS CodeBuild.

" } }, "WrapperBoolean": { "base": null, "refs": { "BuildArtifacts$overrideArtifactName": "

If this flag is set, a name specified in the build spec file overrides the artifact name. The name specified in a build spec file is calculated at build time and uses the Shell Command Language. For example, you can append a date and time to your artifact name so that it is always unique.

", "BuildArtifacts$encryptionDisabled": "

Information that tells you if encryption for build artifacts is disabled.

", "CreateProjectInput$badgeEnabled": "

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

", "ProjectArtifacts$overrideArtifactName": "

If this flag is set, a name specified in the build spec file overrides the artifact name. The name specified in a build spec file is calculated at build time and uses the Shell Command Language. For example, you can append a date and time to your artifact name so that it is always unique.

", "ProjectArtifacts$encryptionDisabled": "

Set to true if you do not want your output artifacts encrypted. This option is valid only if your artifacts type is Amazon Simple Storage Service (Amazon S3). If this is set with another artifacts type, an invalidInputException is thrown.

", "ProjectEnvironment$privilegedMode": "

Enables running the Docker daemon inside a Docker container. Set to true only if the build project is be used to build Docker images, and the specified build environment image is not provided by AWS CodeBuild with Docker support. Otherwise, all associated builds that attempt to interact with the Docker daemon fail. You must also start the Docker daemon so that builds can interact with it. One way to do this is to initialize the Docker daemon during the install phase of your build spec by running the following build commands. (Do not run these commands if the specified build environment image is provided by AWS CodeBuild with Docker support.)

If the operating system's base image is Ubuntu Linux:

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

If the operating system's base image is Alpine Linux, add the -t argument to timeout:

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

", "ProjectSource$reportBuildStatus": "

Set to true to report the status of a build's start and finish to your source provider. This option is valid only when your source provider is GitHub, GitHub Enterprise, or Bitbucket. If this is set and you use a different source provider, an invalidInputException is thrown.

", "ProjectSource$insecureSsl": "

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

", "StartBuildInput$insecureSslOverride": "

Enable this flag to override the insecure SSL setting that is specified in the build project. The insecure SSL setting determines whether to ignore SSL warnings while connecting to the project source code. This override applies only if the build's source is GitHub Enterprise.

", "StartBuildInput$reportBuildStatusOverride": "

Set to true to report to your source provider the status of a build's start and completion. If you use this option with a source provider other than GitHub, GitHub Enterprise, or Bitbucket, an invalidInputException is thrown.

", "StartBuildInput$privilegedModeOverride": "

Enable this flag to override privileged mode in the build project.

", "UpdateProjectInput$badgeEnabled": "

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

" } }, "WrapperInt": { "base": null, "refs": { "Build$timeoutInMinutes": "

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

", "Build$queuedTimeoutInMinutes": "

The number of minutes a build is allowed to be queued before it times out.

" } }, "WrapperLong": { "base": null, "refs": { "BuildPhase$durationInSeconds": "

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

" } } } }