Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1426158150.9 KB

Creates a private namespace based on DNS, which is visible only inside a specified Amazon VPC. The namespace defines your service naming scheme. For example, if you name your namespace <code>example.com</code> and name your service <code>backend</code>, the resulting DNS name for the service is <code>backend.example.com</code>. Service instances that are registered using a private DNS namespace can be discovered using either a <code>DiscoverInstances</code> request or using DNS. For the current quota on the number of namespaces that you can create using the same Amazon Web Services account, see <a href="https://docs.aws.amazon.com/cloud-map/latest/dg/cloud-map-limits.html">Cloud Map quotas</a> in the <i>Cloud Map Developer Guide</i>.

post/#X-Amz-Target=Route53AutoNaming_v20170314.CreatePrivateDnsNamespace

Headers

X-Amz-Target'Route53AutoNaming_v20170314.CreatePrivateDnsNamespace' required

Request body

Namestring required

The name that you want to assign to this namespace. When you create a private DNS namespace, Cloud Map automatically creates an Amazon Route 53 private hosted zone that has the same name as the namespace.

CreatorRequestIdstring

A unique string that identifies the request and that allows failed <code>CreatePrivateDnsNamespace</code> requests to be retried without the risk of running the operation twice. <code>CreatorRequestId</code> can be any unique string (for example, a date/timestamp).

Descriptionstring

A description for the namespace.

Vpcstring required

The ID of the Amazon VPC that you want to associate the namespace with.

Response

Success

OperationIdstring

A value that you can use to determine whether the request completed successfully. To get the status of the operation, see <a href="https://docs.aws.amazon.com/cloud-map/latest/api/API_GetOperation.html">GetOperation</a>.

Example response

{
  "OperationId": "gv4g5meo7ndmeh4fqskygvk23d2fijwa-k9302yzd"
}