GetOnPremisesInstance - AWS CodeDeploy


Gets information about 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.


The name of the on-premises instance about which to get information.

Type: String

Required: Yes

Response Syntax

{ "instanceInfo": { "deregisterTime": number, "iamSessionArn": "string", "iamUserArn": "string", "instanceArn": "string", "instanceName": "string", "registerTime": number, "tags": [ { "Key": "string", "Value": "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.


Information about the on-premises instance.

Type: InstanceInfo object


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


An on-premises instance name was not specified.

HTTP Status Code: 400


The specified on-premises instance is not registered.

HTTP Status Code: 400


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

HTTP Status Code: 400



This example illustrates one usage of GetOnPremisesInstance.

Sample Request

POST / HTTP/1.1 Host: Accept-Encoding: identity Content-Length: 31 X-Amz-Target: CodeDeploy_20141006.GetOnPremisesInstance X-Amz-Date: 20160707T020614Z 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-c-inst-2" }

Sample Response

HTTP/1.1 200 OK x-amzn-RequestId: caf06837-88e1-11e5-b0f5-a331fa97e4b5 Content-Type: application/x-amz-json-1.1 Content-Length: 386 { "InstanceInfo": { "deregisterTime": 1.446744190402E9, "iamUserArn": "arn:aws:iam::444455556666:user/janedoe", "instanceArn": "arn:aws:codedeploy:us-east-1:444455556666:instance/grp-e-inst-3_EJFIFC3LrD", "instanceName": "grp-o-inst-7", "registerTime": 1.446744207564E9, "tags": [ { "Key": "Name", "Value": "Cost-Center-765" } ] } }

See Also

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