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

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-servicediscovery/lib/aws-sdk-servicediscovery/types.rb

Overview

Note:

When making an API call, you may pass ListNamespacesRequest data as a 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:



1181
1182
1183
1184
1185
1186
# File 'gems/aws-sdk-servicediscovery/lib/aws-sdk-servicediscovery/types.rb', line 1181

class ListNamespacesRequest < Struct.new(
  :next_token,
  :max_results,
  :filters)
  include Aws::Structure
end

#max_resultsInteger

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

Returns:

  • (Integer)


1181
1182
1183
1184
1185
1186
# File 'gems/aws-sdk-servicediscovery/lib/aws-sdk-servicediscovery/types.rb', line 1181

class ListNamespacesRequest < Struct.new(
  :next_token,
  :max_results,
  :filters)
  include Aws::Structure
end

#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.

Route 53 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)


1181
1182
1183
1184
1185
1186
# File 'gems/aws-sdk-servicediscovery/lib/aws-sdk-servicediscovery/types.rb', line 1181

class ListNamespacesRequest < Struct.new(
  :next_token,
  :max_results,
  :filters)
  include Aws::Structure
end