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

ListOnPremisesInstances

Gets a list of names for one or more on-premises instances.

Unless otherwise specified, both registered and deregistered on-premises instance names will be listed. To list only registered or deregistered on-premises instance names, use the registration status parameter.

Request Syntax

Copy
{ "nextToken": "string", "registrationStatus": "string", "tagFilters": [ { "Key": "string", "Type": "string", "Value": "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.

nextToken

An identifier returned from the previous list on-premises instances call. It can be used to return the next set of on-premises instances in the list.

Type: String

Required: No

registrationStatus

The registration status of the on-premises instances:

  • Deregistered: Include deregistered on-premises instances in the resulting list.

  • Registered: Include registered on-premises instances in the resulting list.

Type: String

Valid Values: Registered | Deregistered

Required: No

tagFilters

The on-premises instance tags that will be used to restrict the corresponding on-premises instance names returned.

Type: Array of TagFilter objects

Required: No

Response Syntax

Copy
{ "instanceNames": [ "string" ], "nextToken": "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.

instanceNames

The list of matching on-premises instance names.

Type: Array of strings

nextToken

If a large amount of information is returned, an identifier is also returned. It can be used in a subsequent list on-premises instances call to return the next set of on-premises instances in the list.

Type: String

Errors

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

InvalidNextTokenException

The next token was specified in an invalid format.

HTTP Status Code: 400

InvalidRegistrationStatusException

The registration status was specified in an invalid format.

HTTP Status Code: 400

InvalidTagFilterException

The specified tag filter was specified in an invalid format.

HTTP Status Code: 400

Example

Sample Request

Copy
POST / HTTP/1.1 Host: codedeploy.us-east-1.amazonaws.com Accept-Encoding: identity Content-Length: 2 X-Amz-Target: CodeDeploy_20141006.ListOnPremisesInstances X-Amz-Date: 20160707T022010Z 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

Sample Response

Copy
HTTP/1.1 200 OK x-amzn-RequestId: e69e5d14-88e3-11e5-bb59-fb8eade0dfc3 Content-Type: application/x-amz-json-1.1 Content-Length: 63 { "instanceNames": [ "grp-a-inst-1", "grp-a-inst-2" ] }

See Also

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