list-namespaces¶

Description¶

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

Synopsis¶

  list-namespaces
[--filters <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]

Options¶

--filters (list)

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 .

(structure)

A complex type that identifies the namespaces that you want to list. You can choose to list public or private namespaces.

Name -> (string)

Specify TYPE .

Values -> (list)

If you specify EQ for Condition , specify either DNS_PUBLIC or DNS_PRIVATE .

If you specify IN for Condition , you can specify DNS_PUBLIC , DNS_PRIVATE , or both.

(string)

Condition -> (string)

The operator that you want to use to determine whether ListNamespaces returns a namespace. Valid values for condition include:

EQ

When you specify EQ for the condition, you can choose to list only public namespaces or private namespaces, but not both. EQ is the default condition and can be omitted.

IN

When you specify IN for the condition, you can choose to list public namespaces, private namespaces, or both.

BETWEEN

Not applicable

Shorthand Syntax:

Name=string,Values=string,string,Condition=string ...

JSON Syntax:

[
  {
    "Name": "TYPE",
    "Values": ["string", ...],
    "Condition": "EQ"|"IN"|"BETWEEN"
  }
  ...
]

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command’s output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--max-items (integer)

The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a NextToken is provided in the command’s output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

See ‘aws help’ for descriptions of global parameters.

Examples¶

Note

To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.

Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal’s quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .

To list namespaces

The following list-namespaces example lists namespaces.

aws servicediscovery list-namespaces

Output:

{
    "Namespaces": [
        {
            "Arn": "arn:aws:servicediscovery:us-west-2:123456789012:namespace/ns-a3ccy2e7e3a7rile",
            "CreateDate": 1585354387.357,
            "Id": "ns-a3ccy2e7e3a7rile",
            "Name": "local",
            "Properties": {
                "DnsProperties": {
                    "HostedZoneId": "Z06752353VBUDTC32S84S"
                },
                "HttpProperties": {
                    "HttpName": "local"
                 }
            },
            "Type": "DNS_PRIVATE"
        },
        {
            "Arn": "arn:aws:servicediscovery:us-west-2:123456789012:namespace/ns-pocfyjtrsmwtvcxx",
            "CreateDate": 1586468974.698,
            "Description": "My second namespace",
            "Id": "ns-pocfyjtrsmwtvcxx",
            "Name": "My-second-namespace",
            "Properties": {
                "DnsProperties": {},
                "HttpProperties": {
                    "HttpName": "My-second-namespace"
                }
            },
            "Type": "HTTP"
        },
        {
            "Arn": "arn:aws:servicediscovery:us-west-2:123456789012:namespace/ns-ylexjili4cdxy3xm",
            "CreateDate": 1587055896.798,
            "Id": "ns-ylexjili4cdxy3xm",
            "Name": "example.com",
            "Properties": {
                "DnsProperties": {
                    "HostedZoneId": "Z09983722P0QME1B3KC8I"
                },
                 "HttpProperties": {
                     "HttpName": "example.com"
                }
            },
            "Type": "DNS_PRIVATE"
        }
    ]
}

For more information, see Viewing a list of namespaces in the AWS Cloud Map Developer Guide.

Output¶

Namespaces -> (list)

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

(structure)

A complex type that contains information about a namespace.

Id -> (string)

The ID of the namespace.

Arn -> (string)

The Amazon Resource Name (ARN) that Cloud Map assigns to the namespace when you create it.

Name -> (string)

The name of the namespace. When you create a namespace, Cloud Map automatically creates a Route 53 hosted zone that has the same name as the namespace.

Type -> (string)

The type of the namespace, either public or private.

Description -> (string)

A description for the namespace.

ServiceCount -> (integer)

The number of services that were created using the namespace.

Properties -> (structure)

The properties of the namespace.

DnsProperties -> (structure)

A complex type that contains the ID for the Route 53 hosted zone that Cloud Map creates when you create a namespace.

HostedZoneId -> (string)

The ID for the Route 53 hosted zone that Cloud Map creates when you create a namespace.

SOA -> (structure)

Start of Authority (SOA) record for the hosted zone.

TTL -> (long)

The time to live (TTL) for purposes of negative caching.

HttpProperties -> (structure)

A complex type that contains the name of an HTTP namespace.

HttpName -> (string)

The name of an HTTP namespace.

CreateDate -> (timestamp)

The date and time that the namespace was created.

NextToken -> (string)

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

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.

Table of Contents

Feedback

User Guide

list-namespaces¶

Description¶

Synopsis¶

Options¶

Examples¶

Output¶