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

The AWS Documentation website is getting a new look!
Try it now and let us know what you think. Switch to the new look >>

You can return to the original look by selecting English in the language selector above.


Gets information about a namespace.

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 namespace that you want to get information about.

Type: String

Length Constraints: Maximum length of 64.

Required: Yes

Response Syntax

{ "Namespace": { "Arn": "string", "CreateDate": number, "CreatorRequestId": "string", "Description": "string", "Id": "string", "Name": "string", "Properties": { "DnsProperties": { "HostedZoneId": "string" }, "HttpProperties": { "HttpName": "string" } }, "ServiceCount": number, "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 specified namespace.

Type: Namespace 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 namespace exists with the specified ID.

HTTP Status Code: 400


GetNamespace Example

Sample Request

POST / HTTP/1.1 x-amz-date:20181118T211711Z 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.GetNamespace content-type:application/x-amz-json-1.1 content-length:[number of characters in the JSON string] { "Id": "ns-e4anhexample0004" }

Sample Response

HTTP/1.1 200 Content-Length: 392 Content-Type: application/x-amz-json-1.1 { "Namespace": { "Arn": "arn:aws:servicediscovery:us-west-2: 123456789120:namespace/ns-e1tpmexample0001", "CreateDate": "20181118T211712Z", "CreatorRequestId": "example-creator-request-id-0001", "Description": " Cloud Map HTTP Namespace", "Id": "ns-e1tpmexample0001", "Name": "", "Properties": { "DnsProperties": {}, "HttpProperties": { "HttpName": "" } }, "Type": "HTTP" } }

See Also

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