BatchGetOnPremisesInstances
Gets information about one or more on-premises instances. The maximum number of on-premises instances that can be returned is 25.
Request Syntax
{
"instanceNames": [ "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.
- instanceNames
-
The names of the on-premises instances about which to get information. The maximum number of instance names you can specify is 25.
Type: Array of strings
Required: Yes
Response Syntax
{
"instanceInfos": [
{
"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.
- instanceInfos
-
Information about the on-premises instances.
Type: Array of InstanceInfo objects
Errors
For information about the errors that are common to all actions, see Common Errors.
- BatchLimitExceededException
-
The maximum number of names or IDs allowed for this request (100) was exceeded.
HTTP Status Code: 400
- InstanceNameRequiredException
-
An on-premises instance name was not specified.
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 BatchGetOnPremisesInstances.
Sample Request
POST / HTTP/1.1
Host: codedeploy.us-east-1.amazonaws.com
Accept-Encoding: identity
Content-Length: 63
X-Amz-Target: CodeDeploy_20141006.BatchGetOnPremisesInstances
X-Amz-Date: 20160707T232825Z
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
{
"instanceNames": [
"grp-a-inst-1",
"grp-a-inst-3"
]
}
Sample Response
HTTP/1.1 200 OK
x-amzn-RequestId: e895fb62-88cb-11e5-a908-6dc86959d072
Content-Type: application/x-amz-json-1.1
Content-Length: 303
{
"instanceInfos": [
{
"iamUserArn": "arn:aws:iam::444455556666:user/janedoe",
"instanceArn": "arn:aws:codedeploy:us-east-1:444455556666:instance/grp-a-inst-1_rDH556dxUG",
"instanceName": "grp-a-inst-1",
"registerTime": 1428086184.401,
"tags": [
{
"Key": "Name",
"Value": "Project-DEF"
}
]
}
]
}
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: