AWS Cloud Map
API Reference (API Version 2017-03-14)

ListServices

Lists summary information for all the services that are associated with one or more specified namespaces.

Request Syntax

{ "Filters": [ { "Condition": "string", "Name": "string", "Values": [ "string" ] } ], "MaxResults": number, "NextToken": "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.

Filters

A complex type that contains specifications for the namespaces that you want to list services for.

If you specify more than one filter, an operation must match all filters to be returned by ListServices.

Type: Array of ServiceFilter objects

Required: No

MaxResults

The maximum number of services that you want AWS Cloud Map to return in the response to a ListServices request. If you don't specify a value for MaxResults, AWS Cloud Map returns up to 100 services.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 100.

Required: No

NextToken

For the first ListServices request, omit this value.

If the response contains NextToken, submit another ListServices request to get the next group of results. Specify the value of NextToken from the previous response in the next request.

Note

AWS Cloud Map gets MaxResults services and then filters them based on the specified criteria. It's possible that no services in the first MaxResults services matched the specified criteria but that subsequent groups of MaxResults services do contain services that match the criteria.

Type: String

Length Constraints: Maximum length of 4096.

Required: No

Response Syntax

{ "NextToken": "string", "Services": [ { "Arn": "string", "CreateDate": number, "Description": "string", "DnsConfig": { "DnsRecords": [ { "TTL": number, "Type": "string" } ], "NamespaceId": "string", "RoutingPolicy": "string" }, "HealthCheckConfig": { "FailureThreshold": number, "ResourcePath": "string", "Type": "string" }, "HealthCheckCustomConfig": { "FailureThreshold": number }, "Id": "string", "InstanceCount": number, "Name": "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.

NextToken

If the response contains NextToken, submit another ListServices request to get the next group of results. Specify the value of NextToken from the previous response in the next request.

Note

AWS Cloud Map gets MaxResults services and then filters them based on the specified criteria. It's possible that no services in the first MaxResults services matched the specified criteria but that subsequent groups of MaxResults services do contain services that match the criteria.

Type: String

Length Constraints: Maximum length of 4096.

Services

An array that contains one ServiceSummary object for each service that matches the specified filter criteria.

Type: Array of ServiceSummary objects

Errors

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

InvalidInput

One or more specified values aren't valid. For example, a required value might be missing, a numeric value might be outside the allowed range, or a string value might exceed length constraints.

HTTP Status Code: 400

Example

ListServices Example

Sample Request

POST / HTTP/1.1 host:servicediscovery.us-west-2.amazonaws.com x-amz-date:20181118T211713Z authorization: AWS4-HMAC-SHA256 Credential=AKIAIIO2CIV3EXAMPLE/20181118/us-west-2/servicediscovery/aws4_request, SignedHeaders=content-length;content-type;host;user-agent;x-amz-date;x-amz-target, Signature=[calculated-signature] x-amz-target:Route53AutoNaming_v20170314.ListServices content-type:application/x-amz-json-1.1 content-length:number of characters in the JSON string] { "Filters": [ { "Name": "NAMESPACE_ID", "Condition": "EQ", "Values": [ "ns-e3r0sexample0003" ] } ] }

Sample Response

HTTP/1.1 200 Content-Length: 392 Content-Type: application/x-amz-json-1.1 { "Services": [ { "Arn": "arn:aws:servicediscovery:us-west-2:123456789120:service/srv-e4anhexample0004", "CreateDate": "20181118T211707Z", "Description": "Example.com Cloud Map HTTP Service", "HealthCheckConfig": { "FailureThreshold": 3, "ResourcePath": "/", "Type": "HTTPS" }, "Id": "srv-e4anhexample0004", "Name": "example-http-service" } ] }

See Also

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