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

ListNamespaces

Lists summary information about the namespaces that were created by the current AWS account.

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.

If you specify more than one filter, a namespace must match all filters to be returned by ListNamespaces.

Type: Array of NamespaceFilter objects

Required: No

MaxResults

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

Type: Integer

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

Required: No

NextToken

For the first ListNamespaces request, omit this value.

If the response contains NextToken, submit another ListNamespaces 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 namespaces and then filters them based on the specified criteria. It's possible that no namespaces in the first MaxResults namespaces matched the specified criteria but that subsequent groups of MaxResults namespaces do contain namespaces that match the criteria.

Type: String

Length Constraints: Maximum length of 4096.

Required: No

Response Syntax

{ "Namespaces": [ { "Arn": "string", "CreateDate": number, "Description": "string", "Id": "string", "Name": "string", "Properties": { "DnsProperties": { "HostedZoneId": "string" }, "HttpProperties": { "HttpName": "string" } }, "ServiceCount": number, "Type": "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.

Namespaces

An array that contains one NamespaceSummary object for each namespace that matches the specified filter criteria.

Type: Array of NamespaceSummary objects

NextToken

If the response contains NextToken, submit another ListNamespaces 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 namespaces and then filters them based on the specified criteria. It's possible that no namespaces in the first MaxResults namespaces matched the specified criteria but that subsequent groups of MaxResults namespaces do contain namespaces that match the criteria.

Type: String

Length Constraints: Maximum length of 4096.

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

ListNamespaces Example

Sample Request

POST / HTTP/1.1 host:servicediscovery.us-west-2.amazonaws.com x-amz-date:20181118T211712Z 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.ListNamespaces content-type:application/x-amz-json-1.1 content-length:2 {}

Sample Response

HTTP/1.1 200 Content-Length: 392 Content-Type: application/x-amz-json-1.1 { "Namespaces": [ { "Arn": "arn:aws:servicediscovery:us-west-2:123456789120:namespace/ns-e1tpmexample0001", "CreateDate": "20181118T211701Z", "Description": "Example.com Cloud Map Public DNS Namespace", "Id": "ns-e1tpmexample0001", "Name": "example-public-dns.com", "Properties": { "DnsProperties": { "HostedZoneId": "TH3TGRTT0TR20S" }, "HttpProperties": { "HttpName": "example-public-dns.com" } }, "Type": "DNS_PUBLIC" }, { "Arn": "arn:aws:servicediscovery:us-west-2:123456789120:namespace/ns-e2a0cexample0002", "CreateDate": "20181118T211702Z", "Description": "Example.com Cloud Map Private DNS Namespace", "Id": "ns-e2a0cexample0002", "Name": "example-private-dns.com", "Properties": { "DnsProperties": { "HostedZoneId": "T1U1TGSSKSSHD" }, "HttpProperties": { "HttpName": "example-private-dns.com" } }, "Type": "DNS_PRIVATE" }, { "Arn": "arn:aws:servicediscovery:us-west-2:123456789120:namespace/ns-e3r0sexample0003", "CreateDate": "20181118T211703Z", "Description": "Example.com Cloud Map HTTP Namespace", "Id": "ns-e3r0sexample0003", "Name": "example-http.com", "Properties": { "DnsProperties": {}, "HttpProperties": { "HttpName": "example-http.com" } }, "Type": "HTTP" } ] }

See Also

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