amazonka-route53-autonaming-2.0: Amazon Cloud Map SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.Route53AutoNaming.ListNamespaces

Description

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

This operation returns paginated results.

Synopsis

Creating a Request

data ListNamespaces Source #

See: newListNamespaces smart constructor.

Constructors

ListNamespaces' 

Fields

  • filters :: Maybe [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.

  • maxResults :: Maybe Natural

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

  • nextToken :: Maybe Text

    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.

    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.

Instances

Instances details
ToJSON ListNamespaces Source # 
Instance details

Defined in Amazonka.Route53AutoNaming.ListNamespaces

ToHeaders ListNamespaces Source # 
Instance details

Defined in Amazonka.Route53AutoNaming.ListNamespaces

ToPath ListNamespaces Source # 
Instance details

Defined in Amazonka.Route53AutoNaming.ListNamespaces

ToQuery ListNamespaces Source # 
Instance details

Defined in Amazonka.Route53AutoNaming.ListNamespaces

AWSPager ListNamespaces Source # 
Instance details

Defined in Amazonka.Route53AutoNaming.ListNamespaces

AWSRequest ListNamespaces Source # 
Instance details

Defined in Amazonka.Route53AutoNaming.ListNamespaces

Associated Types

type AWSResponse ListNamespaces #

Generic ListNamespaces Source # 
Instance details

Defined in Amazonka.Route53AutoNaming.ListNamespaces

Associated Types

type Rep ListNamespaces :: Type -> Type #

Read ListNamespaces Source # 
Instance details

Defined in Amazonka.Route53AutoNaming.ListNamespaces

Show ListNamespaces Source # 
Instance details

Defined in Amazonka.Route53AutoNaming.ListNamespaces

NFData ListNamespaces Source # 
Instance details

Defined in Amazonka.Route53AutoNaming.ListNamespaces

Methods

rnf :: ListNamespaces -> () #

Eq ListNamespaces Source # 
Instance details

Defined in Amazonka.Route53AutoNaming.ListNamespaces

Hashable ListNamespaces Source # 
Instance details

Defined in Amazonka.Route53AutoNaming.ListNamespaces

type AWSResponse ListNamespaces Source # 
Instance details

Defined in Amazonka.Route53AutoNaming.ListNamespaces

type Rep ListNamespaces Source # 
Instance details

Defined in Amazonka.Route53AutoNaming.ListNamespaces

type Rep ListNamespaces = D1 ('MetaData "ListNamespaces" "Amazonka.Route53AutoNaming.ListNamespaces" "amazonka-route53-autonaming-2.0-98MlwjLW1enGruUXoTOCqp" 'False) (C1 ('MetaCons "ListNamespaces'" 'PrefixI 'True) (S1 ('MetaSel ('Just "filters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [NamespaceFilter])) :*: (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newListNamespaces :: ListNamespaces Source #

Create a value of ListNamespaces with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:filters:ListNamespaces', listNamespaces_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.

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

ListNamespaces, listNamespaces_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.

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.

Request Lenses

listNamespaces_filters :: Lens' ListNamespaces (Maybe [NamespaceFilter]) Source #

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.

listNamespaces_maxResults :: Lens' ListNamespaces (Maybe Natural) Source #

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

listNamespaces_nextToken :: Lens' ListNamespaces (Maybe Text) Source #

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.

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.

Destructuring the Response

data ListNamespacesResponse Source #

See: newListNamespacesResponse smart constructor.

Constructors

ListNamespacesResponse' 

Fields

  • namespaces :: Maybe [NamespaceSummary]

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

  • nextToken :: Maybe Text

    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.

    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.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Generic ListNamespacesResponse Source # 
Instance details

Defined in Amazonka.Route53AutoNaming.ListNamespaces

Associated Types

type Rep ListNamespacesResponse :: Type -> Type #

Read ListNamespacesResponse Source # 
Instance details

Defined in Amazonka.Route53AutoNaming.ListNamespaces

Show ListNamespacesResponse Source # 
Instance details

Defined in Amazonka.Route53AutoNaming.ListNamespaces

NFData ListNamespacesResponse Source # 
Instance details

Defined in Amazonka.Route53AutoNaming.ListNamespaces

Methods

rnf :: ListNamespacesResponse -> () #

Eq ListNamespacesResponse Source # 
Instance details

Defined in Amazonka.Route53AutoNaming.ListNamespaces

type Rep ListNamespacesResponse Source # 
Instance details

Defined in Amazonka.Route53AutoNaming.ListNamespaces

type Rep ListNamespacesResponse = D1 ('MetaData "ListNamespacesResponse" "Amazonka.Route53AutoNaming.ListNamespaces" "amazonka-route53-autonaming-2.0-98MlwjLW1enGruUXoTOCqp" 'False) (C1 ('MetaCons "ListNamespacesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "namespaces") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [NamespaceSummary])) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListNamespacesResponse Source #

Create a value of ListNamespacesResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:namespaces:ListNamespacesResponse', listNamespacesResponse_namespaces - An array that contains one NamespaceSummary object for each namespace that matches the specified filter criteria.

ListNamespaces, listNamespacesResponse_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.

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.

$sel:httpStatus:ListNamespacesResponse', listNamespacesResponse_httpStatus - The response's http status code.

Response Lenses

listNamespacesResponse_namespaces :: Lens' ListNamespacesResponse (Maybe [NamespaceSummary]) Source #

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

listNamespacesResponse_nextToken :: Lens' ListNamespacesResponse (Maybe Text) Source #

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.

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.