AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::ServiceDiscovery::Types::ListNamespacesRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing ListNamespacesRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  next_token: "NextToken",
  max_results: 1,
  filters: [
    {
      name: "TYPE", # required, accepts TYPE
      values: ["FilterValue"], # required
      condition: "EQ", # accepts EQ, IN, BETWEEN
    },
  ],
}

Instance Attribute Summary collapse

Instance Attribute Details

#filtersArray<Types::NamespaceFilter>

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.

Returns:

  • (Array<Types::NamespaceFilter>)

    A complex type that contains specifications for the namespaces that you want to list.

#max_resultsInteger

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.

Returns:

  • (Integer)

    The maximum number of namespaces that you want AWS Cloud Map to return in the response to a ListNamespaces request.

#next_tokenString

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.

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.

Returns:

  • (String)

    For the first ListNamespaces request, omit this value.