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

Description

Lists summary information for all the services that are associated with one or more specified namespaces.

This operation returns paginated results.

Synopsis

Creating a Request

data ListServices Source #

See: newListServices smart constructor.

Constructors

ListServices' 

Fields

  • filters :: Maybe [ServiceFilter]

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

    If you specify more than one filter, an operation must match all filters to be returned by ListServices.

  • maxResults :: Maybe Natural

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

  • nextToken :: Maybe Text

    For the first ListServices request, omit this value.

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

Instances

Instances details
ToJSON ListServices Source # 
Instance details

Defined in Amazonka.Route53AutoNaming.ListServices

ToHeaders ListServices Source # 
Instance details

Defined in Amazonka.Route53AutoNaming.ListServices

ToPath ListServices Source # 
Instance details

Defined in Amazonka.Route53AutoNaming.ListServices

ToQuery ListServices Source # 
Instance details

Defined in Amazonka.Route53AutoNaming.ListServices

AWSPager ListServices Source # 
Instance details

Defined in Amazonka.Route53AutoNaming.ListServices

AWSRequest ListServices Source # 
Instance details

Defined in Amazonka.Route53AutoNaming.ListServices

Associated Types

type AWSResponse ListServices #

Generic ListServices Source # 
Instance details

Defined in Amazonka.Route53AutoNaming.ListServices

Associated Types

type Rep ListServices :: Type -> Type #

Read ListServices Source # 
Instance details

Defined in Amazonka.Route53AutoNaming.ListServices

Show ListServices Source # 
Instance details

Defined in Amazonka.Route53AutoNaming.ListServices

NFData ListServices Source # 
Instance details

Defined in Amazonka.Route53AutoNaming.ListServices

Methods

rnf :: ListServices -> () #

Eq ListServices Source # 
Instance details

Defined in Amazonka.Route53AutoNaming.ListServices

Hashable ListServices Source # 
Instance details

Defined in Amazonka.Route53AutoNaming.ListServices

type AWSResponse ListServices Source # 
Instance details

Defined in Amazonka.Route53AutoNaming.ListServices

type Rep ListServices Source # 
Instance details

Defined in Amazonka.Route53AutoNaming.ListServices

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

newListServices :: ListServices Source #

Create a value of ListServices 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:ListServices', listServices_filters - A complex type that contains specifications for the namespaces that you want to list services for.

If you specify more than one filter, an operation must match all filters to be returned by ListServices.

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

ListServices, listServices_nextToken - For the first ListServices request, omit this value.

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

Request Lenses

listServices_filters :: Lens' ListServices (Maybe [ServiceFilter]) Source #

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

If you specify more than one filter, an operation must match all filters to be returned by ListServices.

listServices_maxResults :: Lens' ListServices (Maybe Natural) Source #

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

listServices_nextToken :: Lens' ListServices (Maybe Text) Source #

For the first ListServices request, omit this value.

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

Destructuring the Response

data ListServicesResponse Source #

See: newListServicesResponse smart constructor.

Constructors

ListServicesResponse' 

Fields

  • nextToken :: Maybe Text

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

  • services :: Maybe [ServiceSummary]

    An array that contains one ServiceSummary object for each service that matches the specified filter criteria.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Generic ListServicesResponse Source # 
Instance details

Defined in Amazonka.Route53AutoNaming.ListServices

Associated Types

type Rep ListServicesResponse :: Type -> Type #

Read ListServicesResponse Source # 
Instance details

Defined in Amazonka.Route53AutoNaming.ListServices

Show ListServicesResponse Source # 
Instance details

Defined in Amazonka.Route53AutoNaming.ListServices

NFData ListServicesResponse Source # 
Instance details

Defined in Amazonka.Route53AutoNaming.ListServices

Methods

rnf :: ListServicesResponse -> () #

Eq ListServicesResponse Source # 
Instance details

Defined in Amazonka.Route53AutoNaming.ListServices

type Rep ListServicesResponse Source # 
Instance details

Defined in Amazonka.Route53AutoNaming.ListServices

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

newListServicesResponse Source #

Create a value of ListServicesResponse 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:

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

$sel:services:ListServicesResponse', listServicesResponse_services - An array that contains one ServiceSummary object for each service that matches the specified filter criteria.

$sel:httpStatus:ListServicesResponse', listServicesResponse_httpStatus - The response's http status code.

Response Lenses

listServicesResponse_nextToken :: Lens' ListServicesResponse (Maybe Text) Source #

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

listServicesResponse_services :: Lens' ListServicesResponse (Maybe [ServiceSummary]) Source #

An array that contains one ServiceSummary object for each service that matches the specified filter criteria.