Request Syntax Request Parameters Response Syntax Response Elements Errors Examples See Also

GetOnPremisesInstance

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.

instanceName

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.

instanceInfo

Information about the on-premises instance.

Type: InstanceInfo object

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

InstanceNotRegisteredException

The specified on-premises instance is not registered.

HTTP Status Code: 400

InvalidInstanceNameException

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

HTTP Status Code: 400

Examples

Example

This example illustrates one usage of GetOnPremisesInstance.

Sample Request


POST / HTTP/1.1
Host: codedeploy.us-east-1.amazonaws.com
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"
            }
        ]
    }
}