The #X Amz Target=CodeBuild 20161006.StopBuild API from Amazon CodeBuild — 1 operation(s) for #x amz target=codebuild 20161006.stopbuild.
openapi: 3.0.0
info:
version: '2016-10-06'
x-release: v4
title: 'AWS CodeBuild Builds #X Amz Target=CodeBuild 20161006.StopBuild API'
description: <fullname>CodeBuild</fullname> <p>CodeBuild is a fully managed build service in the cloud. CodeBuild compiles your source code, runs unit tests, and produces artifacts that are ready to deploy. 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 CodeBuild to use your own build tools. CodeBuild scales automatically to meet peak build requests. You pay only for the build time you consume. For more information about CodeBuild, see the <i> <a href="https://docs.aws.amazon.com/codebuild/latest/userguide/welcome.html">CodeBuild User Guide</a>.</i> </p>
x-logo:
url: https://twitter.com/awscloud/profile_image?size=original
backgroundColor: '#FFFFFF'
termsOfService: https://aws.amazon.com/service-terms/
contact:
name: Mike Ralphson
email: mike.ralphson@gmail.com
url: https://github.com/mermade/aws2openapi
x-twitter: PermittedSoc
license:
name: Apache 2.0 License
url: http://www.apache.org/licenses/
x-providerName: amazonaws.com
x-serviceName: codebuild
x-origin:
- contentType: application/json
url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/codebuild-2016-10-06.normal.json
converter:
url: https://github.com/mermade/aws2openapi
version: 1.0.0
x-apisguru-driver: external
x-apiClientRegistration:
url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct
x-apisguru-categories:
- cloud
x-preferred: true
servers:
- url: http://codebuild.{region}.amazonaws.com
variables:
region:
description: The AWS region
enum:
- us-east-1
- us-east-2
- us-west-1
- us-west-2
- us-gov-west-1
- us-gov-east-1
- ca-central-1
- eu-north-1
- eu-west-1
- eu-west-2
- eu-west-3
- eu-central-1
- eu-south-1
- af-south-1
- ap-northeast-1
- ap-northeast-2
- ap-northeast-3
- ap-southeast-1
- ap-southeast-2
- ap-east-1
- ap-south-1
- sa-east-1
- me-south-1
default: us-east-1
description: The AWS CodeBuild multi-region endpoint
- url: https://codebuild.{region}.amazonaws.com
variables:
region:
description: The AWS region
enum:
- us-east-1
- us-east-2
- us-west-1
- us-west-2
- us-gov-west-1
- us-gov-east-1
- ca-central-1
- eu-north-1
- eu-west-1
- eu-west-2
- eu-west-3
- eu-central-1
- eu-south-1
- af-south-1
- ap-northeast-1
- ap-northeast-2
- ap-northeast-3
- ap-southeast-1
- ap-southeast-2
- ap-east-1
- ap-south-1
- sa-east-1
- me-south-1
default: us-east-1
description: The AWS CodeBuild multi-region endpoint
- url: http://codebuild.{region}.amazonaws.com.cn
variables:
region:
description: The AWS region
enum:
- cn-north-1
- cn-northwest-1
default: cn-north-1
description: The AWS CodeBuild endpoint for China (Beijing) and China (Ningxia)
- url: https://codebuild.{region}.amazonaws.com.cn
variables:
region:
description: The AWS region
enum:
- cn-north-1
- cn-northwest-1
default: cn-north-1
description: The AWS CodeBuild endpoint for China (Beijing) and China (Ningxia)
security:
- hmac: []
tags:
- name: '#X Amz Target=CodeBuild 20161006.StopBuild'
paths:
/#X-Amz-Target=CodeBuild_20161006.StopBuild:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
operationId: StopBuild
description: Attempts to stop running a build.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/StopBuildOutput'
examples:
StopBuild200Example:
summary: Default StopBuild 200 response
x-microcks-default: true
value:
build: example-value
'480':
description: InvalidInputException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidInputException'
examples:
StopBuild480Example:
summary: Default StopBuild 480 response
x-microcks-default: true
value: example-value
'481':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
examples:
StopBuild481Example:
summary: Default StopBuild 481 response
x-microcks-default: true
value: example-value
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/StopBuildInput'
examples:
StopBuildRequestExample:
summary: Default StopBuild request
x-microcks-default: true
value:
id: '500123'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- CodeBuild_20161006.StopBuild
summary: Amazon CodeBuild Stop Build
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- '#X Amz Target=CodeBuild 20161006.StopBuild'
components:
schemas:
BuildReportArns:
type: array
items:
$ref: '#/components/schemas/String'
WrapperLong:
type: integer
NetworkInterface:
type: object
properties:
subnetId:
allOf:
- $ref: '#/components/schemas/NonEmptyString'
- description: The ID of the subnet.
networkInterfaceId:
allOf:
- $ref: '#/components/schemas/NonEmptyString'
- description: The ID of the network interface.
description: Describes a network interface.
ProjectSourceVersion:
type: object
required:
- sourceIdentifier
- sourceVersion
properties:
sourceIdentifier:
allOf:
- $ref: '#/components/schemas/String'
- description: 'An identifier for a source in the build project. The identifier can only contain alphanumeric characters and underscores, and must be less than 128 characters in length. '
sourceVersion:
allOf:
- $ref: '#/components/schemas/String'
- description: '<p>The source version for the corresponding source identifier. If specified, must be one of:</p> <ul> <li> <p>For CodeCommit: the commit ID, branch, or Git tag to use.</p> </li> <li> <p>For GitHub: the commit ID, pull request ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a pull request ID is specified, it must use the format <code>pr/pull-request-ID</code> (for example, <code>pr/25</code>). If a branch name is specified, the branch''s HEAD commit ID is used. If not specified, the default branch''s HEAD commit ID is used.</p> </li> <li> <p>For Bitbucket: the commit ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a branch name is specified, the branch''s HEAD commit ID is used. If not specified, the default branch''s HEAD commit ID is used.</p> </li> <li> <p>For Amazon S3: the version ID of the object that represents the build input ZIP file to use.</p> </li> </ul> <p> For more information, see <a href="https://docs.aws.amazon.com/codebuild/latest/userguide/sample-source-version.html">Source Version Sample with CodeBuild</a> in the <i>CodeBuild User Guide</i>. </p>'
description: ' A source identifier and its corresponding version. '
DebugSession:
type: object
properties:
sessionEnabled:
allOf:
- $ref: '#/components/schemas/WrapperBoolean'
- description: Specifies if session debugging is enabled for this build.
sessionTarget:
allOf:
- $ref: '#/components/schemas/NonEmptyString'
- description: Contains the identifier of the Session Manager session used for the build. To work with the paused build, you open this session to examine, control, and resume the build.
description: Contains information about the debug session for a build. For more information, see <a href="https://docs.aws.amazon.com/codebuild/latest/userguide/session-manager.html">Viewing a running build in Session Manager</a>.
Build:
type: object
properties:
id:
allOf:
- $ref: '#/components/schemas/NonEmptyString'
- description: The unique ID for the build.
arn:
allOf:
- $ref: '#/components/schemas/NonEmptyString'
- description: The Amazon Resource Name (ARN) of the build.
buildNumber:
allOf:
- $ref: '#/components/schemas/WrapperLong'
- description: The number of the build. For each project, the <code>buildNumber</code> of its first build is <code>1</code>. The <code>buildNumber</code> of each subsequent build is incremented by <code>1</code>. If a build is deleted, the <code>buildNumber</code> of other builds does not change.
startTime:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: When the build process started, expressed in Unix time format.
endTime:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: When the build process ended, expressed in Unix time format.
currentPhase:
allOf:
- $ref: '#/components/schemas/String'
- description: The current build phase.
buildStatus:
allOf:
- $ref: '#/components/schemas/StatusType'
- description: '<p>The current status of the build. Valid values include:</p> <ul> <li> <p> <code>FAILED</code>: The build failed.</p> </li> <li> <p> <code>FAULT</code>: The build faulted.</p> </li> <li> <p> <code>IN_PROGRESS</code>: The build is still in progress.</p> </li> <li> <p> <code>STOPPED</code>: The build stopped.</p> </li> <li> <p> <code>SUCCEEDED</code>: The build succeeded.</p> </li> <li> <p> <code>TIMED_OUT</code>: The build timed out.</p> </li> </ul>'
sourceVersion:
allOf:
- $ref: '#/components/schemas/NonEmptyString'
- description: <p>Any version identifier for the version of the source code to be built. If <code>sourceVersion</code> is specified at the project level, then this <code>sourceVersion</code> (at the build level) takes precedence. </p> <p> For more information, see <a href="https://docs.aws.amazon.com/codebuild/latest/userguide/sample-source-version.html">Source Version Sample with CodeBuild</a> in the <i>CodeBuild User Guide</i>. </p>
resolvedSourceVersion:
allOf:
- $ref: '#/components/schemas/NonEmptyString'
- description: <p> An identifier for the version of this build's source code. </p> <ul> <li> <p> For CodeCommit, GitHub, GitHub Enterprise, and BitBucket, the commit ID. </p> </li> <li> <p> For CodePipeline, the source revision provided by CodePipeline. </p> </li> <li> <p> For Amazon S3, this does not apply. </p> </li> </ul>
projectName:
allOf:
- $ref: '#/components/schemas/NonEmptyString'
- description: The name of the CodeBuild project.
phases:
allOf:
- $ref: '#/components/schemas/BuildPhases'
- description: Information about all previous build phases that are complete and information about any current build phase that is not yet complete.
source:
allOf:
- $ref: '#/components/schemas/ProjectSource'
- description: Information about the source code to be built.
secondarySources:
allOf:
- $ref: '#/components/schemas/ProjectSources'
- description: ' An array of <code>ProjectSource</code> objects. '
secondarySourceVersions:
allOf:
- $ref: '#/components/schemas/ProjectSecondarySourceVersions'
- description: '<p> An array of <code>ProjectSourceVersion</code> objects. Each <code>ProjectSourceVersion</code> must be one of: </p> <ul> <li> <p>For CodeCommit: the commit ID, branch, or Git tag to use.</p> </li> <li> <p>For GitHub: the commit ID, pull request ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a pull request ID is specified, it must use the format <code>pr/pull-request-ID</code> (for example, <code>pr/25</code>). If a branch name is specified, the branch''s HEAD commit ID is used. If not specified, the default branch''s HEAD commit ID is used.</p> </li> <li> <p>For Bitbucket: the commit ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a branch name is specified, the branch''s HEAD commit ID is used. If not specified, the default branch''s HEAD commit ID is used.</p> </li> <li> <p>For Amazon S3: the version ID of the object that represents the build input ZIP file to use.</p> </li> </ul>'
artifacts:
allOf:
- $ref: '#/components/schemas/BuildArtifacts'
- description: Information about the output artifacts for the build.
secondaryArtifacts:
allOf:
- $ref: '#/components/schemas/BuildArtifactsList'
- description: ' An array of <code>ProjectArtifacts</code> objects. '
cache:
allOf:
- $ref: '#/components/schemas/ProjectCache'
- description: Information about the cache for the build.
environment:
allOf:
- $ref: '#/components/schemas/ProjectEnvironment'
- description: Information about the build environment for this build.
serviceRole:
allOf:
- $ref: '#/components/schemas/NonEmptyString'
- description: The name of a service role used for this build.
logs:
allOf:
- $ref: '#/components/schemas/LogsLocation'
- description: Information about the build's logs in CloudWatch Logs.
timeoutInMinutes:
allOf:
- $ref: '#/components/schemas/WrapperInt'
- description: How long, in minutes, for CodeBuild to wait before timing out this build if it does not get marked as completed.
queuedTimeoutInMinutes:
allOf:
- $ref: '#/components/schemas/WrapperInt'
- description: ' The number of minutes a build is allowed to be queued before it times out. '
buildComplete:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: Whether the build is complete. True if complete; otherwise, false.
initiator:
allOf:
- $ref: '#/components/schemas/String'
- description: <p>The entity that started the build. Valid values include:</p> <ul> <li> <p>If CodePipeline started the build, the pipeline's name (for example, <code>codepipeline/my-demo-pipeline</code>).</p> </li> <li> <p>If an IAM user started the build, the user's name (for example, <code>MyUserName</code>).</p> </li> <li> <p>If the Jenkins plugin for CodeBuild started the build, the string <code>CodeBuild-Jenkins-Plugin</code>.</p> </li> </ul>
vpcConfig:
allOf:
- $ref: '#/components/schemas/VpcConfig'
- description: If your 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:
allOf:
- $ref: '#/components/schemas/NetworkInterface'
- description: Describes a network interface.
encryptionKey:
allOf:
- $ref: '#/components/schemas/NonEmptyString'
- description: <p>The Key Management Service customer master key (CMK) to be used for encrypting the build output artifacts.</p> <note> <p> You can use a cross-account KMS key to encrypt the build output artifacts if your service role has permission to that key. </p> </note> <p>You can specify either the Amazon Resource Name (ARN) of the CMK or, if available, the CMK's alias (using the format <code>alias/<alias-name></code>).</p>
exportedEnvironmentVariables:
allOf:
- $ref: '#/components/schemas/ExportedEnvironmentVariables'
- description: <p>A list of exported environment variables for this build.</p> <p>Exported environment variables are used in conjunction with CodePipeline to export environment variables from the current build stage to subsequent stages in the pipeline. For more information, see <a href="https://docs.aws.amazon.com/codepipeline/latest/userguide/actions-variables.html">Working with variables</a> in the <i>CodePipeline User Guide</i>.</p>
reportArns:
allOf:
- $ref: '#/components/schemas/BuildReportArns'
- description: ' An array of the ARNs associated with this build''s reports. '
fileSystemLocations:
allOf:
- $ref: '#/components/schemas/ProjectFileSystemLocations'
- description: ' An array of <code>ProjectFileSystemLocation</code> objects for a CodeBuild build project. A <code>ProjectFileSystemLocation</code> object specifies the <code>identifier</code>, <code>location</code>, <code>mountOptions</code>, <code>mountPoint</code>, and <code>type</code> of a file system created using Amazon Elastic File System. '
debugSession:
allOf:
- $ref: '#/components/schemas/DebugSession'
- description: Contains information about the debug session for this build.
buildBatchArn:
allOf:
- $ref: '#/components/schemas/String'
- description: The ARN of the batch build that this build is a member of, if applicable.
description: Information about a build.
LogsLocation:
type: object
properties:
groupName:
allOf:
- $ref: '#/components/schemas/String'
- description: The name of the CloudWatch Logs group for the build logs.
streamName:
allOf:
- $ref: '#/components/schemas/String'
- description: The name of the CloudWatch Logs stream for the build logs.
deepLink:
allOf:
- $ref: '#/components/schemas/String'
- description: The URL to an individual build log in CloudWatch Logs.
s3DeepLink:
allOf:
- $ref: '#/components/schemas/String'
- description: ' The URL to a build log in an S3 bucket. '
cloudWatchLogsArn:
allOf:
- $ref: '#/components/schemas/String'
- description: ' The ARN of CloudWatch Logs for a build project. Its format is <code>arn:${Partition}:logs:${Region}:${Account}:log-group:${LogGroupName}:log-stream:${LogStreamName}</code>. For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/list_amazoncloudwatchlogs.html#amazoncloudwatchlogs-resources-for-iam-policies">Resources Defined by CloudWatch Logs</a>. '
s3LogsArn:
allOf:
- $ref: '#/components/schemas/String'
- description: ' The ARN of S3 logs for a build project. Its format is <code>arn:${Partition}:s3:::${BucketName}/${ObjectName}</code>. For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/list_amazons3.html#amazons3-resources-for-iam-policies">Resources Defined by Amazon S3</a>. '
cloudWatchLogs:
allOf:
- $ref: '#/components/schemas/CloudWatchLogsConfig'
- description: ' Information about CloudWatch Logs for a build project. '
s3Logs:
allOf:
- $ref: '#/components/schemas/S3LogsConfig'
- description: ' Information about S3 logs for a build project. '
description: Information about build logs in CloudWatch Logs.
CacheMode:
type: string
enum:
- LOCAL_DOCKER_LAYER_CACHE
- LOCAL_SOURCE_CACHE
- LOCAL_CUSTOM_CACHE
BuildArtifactsList:
type: array
items:
$ref: '#/components/schemas/BuildArtifacts'
minItems: 0
maxItems: 12
ExportedEnvironmentVariables:
type: array
items:
$ref: '#/components/schemas/ExportedEnvironmentVariable'
PhaseContexts:
type: array
items:
$ref: '#/components/schemas/PhaseContext'
BuildPhaseType:
type: string
enum:
- SUBMITTED
- QUEUED
- PROVISIONING
- DOWNLOAD_SOURCE
- INSTALL
- PRE_BUILD
- BUILD
- POST_BUILD
- UPLOAD_ARTIFACTS
- FINALIZING
- COMPLETED
NonEmptyString:
type: string
minLength: 1
CloudWatchLogsConfig:
type: object
required:
- status
properties:
status:
allOf:
- $ref: '#/components/schemas/LogsConfigStatusType'
- description: '<p>The current status of the logs in CloudWatch Logs for a build project. Valid values are:</p> <ul> <li> <p> <code>ENABLED</code>: CloudWatch Logs are enabled for this build project.</p> </li> <li> <p> <code>DISABLED</code>: CloudWatch Logs are not enabled for this build project.</p> </li> </ul>'
groupName:
allOf:
- $ref: '#/components/schemas/String'
- description: ' The group name of the logs in CloudWatch Logs. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/Working-with-log-groups-and-streams.html">Working with Log Groups and Log Streams</a>. '
streamName:
allOf:
- $ref: '#/components/schemas/String'
- description: ' The prefix of the stream name of the CloudWatch Logs. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/Working-with-log-groups-and-streams.html">Working with Log Groups and Log Streams</a>. '
description: ' Information about CloudWatch Logs for a build project. '
WrapperBoolean:
type: boolean
Timestamp:
type: string
format: date-time
EnvironmentVariable:
type: object
required:
- name
- value
properties:
name:
allOf:
- $ref: '#/components/schemas/NonEmptyString'
- description: The name or key of the environment variable.
value:
allOf:
- $ref: '#/components/schemas/String'
- description: <p>The value of the environment variable.</p> <important> <p>We strongly discourage the use of <code>PLAINTEXT</code> environment variables to store sensitive values, especially Amazon Web Services secret key IDs and secret access keys. <code>PLAINTEXT</code> environment variables can be displayed in plain text using the CodeBuild console and the CLI. For sensitive values, we recommend you use an environment variable of type <code>PARAMETER_STORE</code> or <code>SECRETS_MANAGER</code>. </p> </important>
type:
allOf:
- $ref: '#/components/schemas/EnvironmentVariableType'
- description: '<p>The type of environment variable. Valid values include:</p> <ul> <li> <p> <code>PARAMETER_STORE</code>: An environment variable stored in Systems Manager Parameter Store. To learn how to specify a parameter store environment variable, see <a href="https://docs.aws.amazon.com/codebuild/latest/userguide/build-spec-ref.html#build-spec.env.parameter-store">env/parameter-store</a> in the <i>CodeBuild User Guide</i>.</p> </li> <li> <p> <code>PLAINTEXT</code>: An environment variable in plain text format. This is the default value.</p> </li> <li> <p> <code>SECRETS_MANAGER</code>: An environment variable stored in Secrets Manager. To learn how to specify a secrets manager environment variable, see <a href="https://docs.aws.amazon.com/codebuild/latest/userguide/build-spec-ref.html#build-spec.env.secrets-manager">env/secrets-manager</a> in the <i>CodeBuild User Guide</i>.</p> </li> </ul>'
description: Information about an environment variable for a build project or a build.
StopBuildInput:
type: object
required:
- id
title: StopBuildInput
properties:
id:
allOf:
- $ref: '#/components/schemas/NonEmptyString'
- description: The ID of the build.
ImagePullCredentialsType:
type: string
enum:
- CODEBUILD
- SERVICE_ROLE
ProjectFileSystemLocation:
type: object
properties:
type:
allOf:
- $ref: '#/components/schemas/FileSystemType'
- description: ' The type of the file system. The one supported type is <code>EFS</code>. '
location:
allOf:
- $ref: '#/components/schemas/String'
- description: <p>A string that specifies the location of the file system created by Amazon EFS. Its format is <code>efs-dns-name:/directory-path</code>. You can find the DNS name of file system when you view it in the Amazon EFS console. The directory path is a path to a directory in the file system that CodeBuild mounts. For example, if the DNS name of a file system is <code>fs-abcd1234.efs.us-west-2.amazonaws.com</code>, and its mount directory is <code>my-efs-mount-directory</code>, then the <code>location</code> is <code>fs-abcd1234.efs.us-west-2.amazonaws.com:/my-efs-mount-directory</code>. </p> <p>The directory path in the format <code>efs-dns-name:/directory-path</code> is optional. If you do not specify a directory path, the location is only the DNS name and CodeBuild mounts the entire file system. </p>
mountPoint:
allOf:
- $ref: '#/components/schemas/String'
- description: 'The location in the container where you mount the file system. '
identifier:
allOf:
- $ref: '#/components/schemas/String'
- description: <p>The name used to access a file system created by Amazon EFS. CodeBuild creates an environment variable by appending the <code>identifier</code> in all capital letters to <code>CODEBUILD_</code>. For example, if you specify <code>my_efs</code> for <code>identifier</code>, a new environment variable is create named <code>CODEBUILD_MY_EFS</code>. </p> <p> The <code>identifier</code> is used to mount your file system. </p>
mountOptions:
allOf:
- $ref: '#/components/schemas/String'
- description: ' The mount options for a file system created by Amazon EFS. The default mount options used by CodeBuild are <code>nfsvers=4.1,rsize=1048576,wsize=1048576,hard,timeo=600,retrans=2</code>. For more information, see <a href="https://docs.aws.amazon.com/efs/latest/ug/mounting-fs-nfs-mount-settings.html">Recommended NFS Mount Options</a>. '
description: ' Information about a file system created by Amazon Elastic File System (EFS). For more information, see <a href="https://docs.aws.amazon.com/efs/latest/ug/whatisefs.html">What Is Amazon Elastic File System?</a> '
S3LogsConfig:
type: object
required:
- status
properties:
status:
allOf:
- $ref: '#/components/schemas/LogsConfigStatusType'
- description: '<p>The current status of the S3 build logs. Valid values are:</p> <ul> <li> <p> <code>ENABLED</code>: S3 build logs are enabled for this build project.</p> </li> <li> <p> <code>DISABLED</code>: S3 build logs are not enabled for this build project.</p> </li> </ul>'
location:
allOf:
- $ref: '#/components/schemas/String'
- description: ' The ARN of an S3 bucket and the path prefix for S3 logs. If your Amazon S3 bucket name is <code>my-bucket</code>, and your path prefix is <code>build-log</code>, then acceptable formats are <code>my-bucket/build-log</code> or <code>arn:aws:s3:::my-bucket/build-log</code>. '
encryptionDisabled:
allOf:
- $ref: '#/components/schemas/WrapperBoolean'
- description: ' Set to true if you do not want your S3 build log output encrypted. By default S3 build logs are encrypted. '
bucketOwnerAccess:
$ref: '#/components/schemas/BucketOwnerAccess'
description: ' Information about S3 logs for a build project. '
BuildPhases:
type: array
items:
$ref: '#/components/schemas/BuildPhase'
BuildPhase:
type: object
properties:
phaseType:
allOf:
- $ref: '#/components/schemas/BuildPhaseType'
- description: <p>The name of the build phase. Valid values include:</p> <dl> <dt>BUILD</dt> <dd> <p>Core build activities typically occur in this build phase.</p> </dd> <dt>COMPLETED</dt> <dd> <p>The build has been completed.</p> </dd> <dt>DOWNLOAD_SOURCE</dt> <dd> <p>Source code is being downloaded in this build phase.</p> </dd> <dt>FINALIZING</dt> <dd> <p>The build process is completing in this build phase.</p> </dd> <dt>INSTALL</dt> <dd> <p>Installation activities typically occur in this build phase.</p> </dd> <dt>POST_BUILD</dt> <dd> <p>Post-build activities typically occur in this build phase.</p> </dd> <dt>PRE_BUILD</dt> <dd> <p>Pre-build activities typically occur in this build phase.</p> </dd> <dt>PROVISIONING</dt> <dd> <p>The build environment is being set up.</p> </dd> <dt>QUEUED</dt> <dd> <p>The build has been submitted and is queued behind other submitted builds.</p> </dd> <dt>SUBMITTED</dt> <dd> <p>The build has been submitted.</p> </dd> <dt>UPLOAD_ARTIFACTS</dt> <dd> <p>Build output artifacts are being uploaded to the output location.</p> </dd> </dl>
phaseStatus:
allOf:
- $ref: '#/components/schemas/StatusType'
- description: <p>The current status of the build phase. Valid values include:</p> <dl> <dt>FAILED</dt> <dd> <p>The build phase failed.</p> </dd> <dt>FAULT</dt> <dd> <p>The build phase faulted.</p> </dd> <dt>IN_PROGRESS</dt> <dd> <p>The build phase is still in progress.</p> </dd> <dt>STOPPED</dt> <dd> <p>The build phase stopped.</p> </dd> <dt>SUCCEEDED</dt> <dd> <p>The build phase succeeded.</p> </dd> <dt>TIMED_OUT</dt> <dd> <p>The build phase timed out.</p> </dd> </dl>
startTime:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: When the build phase started, expressed in Unix time format.
endTime:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: When the build phase ended, expressed in Unix time format.
durationInSeconds:
allOf:
- $ref: '#/components/schemas/WrapperLong'
- description: How long, in seconds, between the starting and ending times of the build's phase.
contexts:
allOf:
- $ref: '#/components/schemas/PhaseContexts'
- description: Additional information about a build phase, especially to help troubleshoot a failed build.
description: Information about a stage for a build.
LogsConfigStatusType:
type: string
enum:
- ENABLED
- DISABLED
ProjectSource:
type: object
required:
- type
properties:
type:
allOf:
- $ref: '#/components/schemas/SourceType'
- description: '<p>The type of repository that contains the source code to be built. Valid values include:</p> <ul> <li> <p> <code>BITBUCKET</code>: The source code is in a Bitbucket repository.</p> </li> <li> <p> <code>CODECOMMIT</code>: The source code is in an CodeCommit repository.</p> </li> <li> <p> <code>CODEPIPELINE</code>: The source code settings are specified in the sou
# --- truncated at 32 KB (62 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/amazon-codebuild/refs/heads/main/openapi/amazon-codebuild-x-amz-target-codebuild-20161006-stopbuild-api-openapi.yml