GetService - AWS Cloud Map


Gets the settings for a specified service.

Request Syntax

{ "Id": "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 ID of the service that you want to get settings for.

Type: String

Length Constraints: Maximum length of 64.

Required: Yes

Response Syntax

{ "Service": { "Arn": "string", "CreateDate": number, "CreatorRequestId": "string", "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", "NamespaceId": "string", "Type": "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.


A complex type that contains information about the service.

Type: Service object


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


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


No service exists with the specified ID.

HTTP Status Code: 400


GetService Example

This example illustrates one usage of GetService.

Sample Request

POST / HTTP/1.1 x-amz-date:20181118T211709Z authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/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.GetService content-type:application/x-amz-json-1.1 content-length:[number of characters in the JSON string] { "Id": "srv-e4anhexample0004" }

Sample Response

HTTP/1.1 200 Content-Length: [number of characters in the JSON string] Content-Type: application/x-amz-json-1.1 { "Service": { "Arn": "arn:aws:servicediscovery:us-west-2:123456789012:service/srv-e4anhexample0004", "CreateDate": "20181118T211707Z", "CreatorRequestId": "example-creator-request-id-0004", "Description": " AWS Cloud Map HTTP Service", "HealthCheckConfig": { "FailureThreshold": 1, "ResourcePath": "/", "Type": "HTTPS" }, "Id": "srv-e4anhexample0004", "Name": "example-http-service", "NamespaceId": "ns-e4anhexample0004" } }

See Also

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