Menu
AWS CodeBuild
API Reference (API Version 2016-10-06)

StopBuild

Attempts to stop running a build.

Request Syntax

{
   "id": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

Note

In the following list, the required parameters are described first.

id

The ID of the build.

Type: String

Length Constraints: Minimum length of 1.

Required: Yes

Response Syntax

{
   "build": { 
      "arn": "string",
      "artifacts": { 
         "location": "string",
         "md5sum": "string",
         "sha256sum": "string"
      },
      "buildComplete": boolean,
      "buildStatus": "string",
      "cache": { 
         "location": "string",
         "type": "string"
      },
      "currentPhase": "string",
      "endTime": number,
      "environment": { 
         "computeType": "string",
         "environmentVariables": [ 
            { 
               "name": "string",
               "type": "string",
               "value": "string"
            }
         ],
         "image": "string",
         "privilegedMode": boolean,
         "type": "string"
      },
      "id": "string",
      "initiator": "string",
      "logs": { 
         "deepLink": "string",
         "groupName": "string",
         "streamName": "string"
      },
      "networkInterface": { 
         "networkInterfaceId": "string",
         "subnetId": "string"
      },
      "phases": [ 
         { 
            "contexts": [ 
               { 
                  "message": "string",
                  "statusCode": "string"
               }
            ],
            "durationInSeconds": number,
            "endTime": number,
            "phaseStatus": "string",
            "phaseType": "string",
            "startTime": number
         }
      ],
      "projectName": "string",
      "source": { 
         "auth": { 
            "resource": "string",
            "type": "string"
         },
         "buildspec": "string",
         "location": "string",
         "type": "string"
      },
      "sourceVersion": "string",
      "startTime": number,
      "timeoutInMinutes": number,
      "vpcConfig": { 
         "securityGroupIds": [ "string" ],
         "subnets": [ "string" ],
         "vpcId": "string"
      }
   }
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

build

Information about the build.

Type: Build object

Errors

For information about the errors that are common to all actions, see Common Errors.

InvalidInputException

The input value that was provided is not valid.

HTTP Status Code: 400

ResourceNotFoundException

The specified AWS resource cannot be found.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: