Menu
AWS CodeDeploy
API Reference (API Version 2014-10-06)

DeregisterOnPremisesInstance

Deregisters an on-premises instance.

Request Syntax

{
   "instanceName": "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.

instanceName

The name of the on-premises instance to deregister.

Type: String

Required: Yes

Response Elements

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

Errors

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

InstanceNameRequiredException

An on-premises instance name was not specified.

HTTP Status Code: 400

InvalidInstanceNameException

The specified on-premises instance name was specified in an invalid format.

HTTP Status Code: 400

Example

Sample Request

POST / HTTP/1.1
Host: codedeploy.us-east-1.amazonaws.com
Accept-Encoding: identity
Content-Length: 43
X-Amz-Target: CodeDeploy_20141006.DeregisterOnPremisesInstance
X-Amz-Date: 20160707T182111Z
User-Agent: aws-cli/1.10.6 Python/2.7.9 Windows/7 botocore/1.3.28
Content-Type: application/x-amz-json-1.1
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20160707/us-east-1/codedeploy/aws4_request, 
	SignedHeaders=content-type;host;user-agent;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE

{
    "instanceName": "grp-b-inst-3"
}

Sample Response

HTTP/1.1 200 OK
x-amzn-RequestId: 4ccc9cf0-88c9-11e5-8ce3-2704437d0309
Content-Type: application/x-amz-json-1.1
Content-Length: 0

See Also

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