Amazonka.Route53AutoNaming.DiscoverInstances

Discovers registered instances for a specified namespace and service. You can use DiscoverInstances to discover instances for any type of namespace. For public and private DNS namespaces, you can also use DNS queries to discover instances.

Creating a Request

data DiscoverInstances

See: newDiscoverInstances smart constructor.

Constructors

DiscoverInstances'

Fields

• healthStatus :: Maybe HealthStatusFilter

  The health status of the instances that you want to discover. This parameter is ignored for services that don't have a health check configured, and all instances are returned.

  HEALTHY

  Returns healthy instances.

  UNHEALTHY

  Returns unhealthy instances.

  ALL

  Returns all instances.

  HEALTHY_OR_ELSE_ALL

  Returns healthy instances, unless none are reporting a healthy state. In that case, return all instances. This is also called failing open.

• maxResults :: Maybe Natural

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

• optionalParameters :: Maybe (HashMap Text Text)

  Opportunistic filters to scope the results based on custom attributes. If there are instances that match both the filters specified in both the QueryParameters parameter and this parameter, all of these instances are returned. Otherwise, the filters are ignored, and only instances that match the filters that are specified in the QueryParameters parameter are returned.

• queryParameters :: Maybe (HashMap Text Text)

  Filters to scope the results based on custom attributes for the instance (for example, {version=v1, az=1a}). Only instances that match all the specified key-value pairs are returned.

• namespaceName :: Text

  The HttpName name of the namespace. It's found in the HttpProperties member of the Properties member of the namespace.

• serviceName :: Text

  The name of the service that you specified when you registered the instance.

Instances

ToJSON DiscoverInstances

Defined in Amazonka.Route53AutoNaming.DiscoverInstances

Methods

toJSON :: DiscoverInstances -> Value

toEncoding :: DiscoverInstances -> Encoding

toJSONList :: [DiscoverInstances] -> Value

toEncodingList :: [DiscoverInstances] -> Encoding

ToHeaders DiscoverInstances

Defined in Amazonka.Route53AutoNaming.DiscoverInstances

Methods

toHeaders :: DiscoverInstances -> [Header]

ToPath DiscoverInstances

Defined in Amazonka.Route53AutoNaming.DiscoverInstances

Methods

toPath :: DiscoverInstances -> ByteString

ToQuery DiscoverInstances

Defined in Amazonka.Route53AutoNaming.DiscoverInstances

Methods

toQuery :: DiscoverInstances -> QueryString

AWSRequest DiscoverInstances

Defined in Amazonka.Route53AutoNaming.DiscoverInstances

Associated Types

type AWSResponse DiscoverInstances

Methods

request :: (Service -> Service) -> DiscoverInstances -> Request DiscoverInstances

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DiscoverInstances -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DiscoverInstances)))

Generic DiscoverInstances

Defined in Amazonka.Route53AutoNaming.DiscoverInstances

Associated Types

type Rep DiscoverInstances :: Type -> Type

Methods

from :: DiscoverInstances -> Rep DiscoverInstances x

to :: Rep DiscoverInstances x -> DiscoverInstances

Read DiscoverInstances

Defined in Amazonka.Route53AutoNaming.DiscoverInstances

Methods

readsPrec :: Int -> ReadS DiscoverInstances

readList :: ReadS [DiscoverInstances]

readPrec :: ReadPrec DiscoverInstances

readListPrec :: ReadPrec [DiscoverInstances]

Show DiscoverInstances

Defined in Amazonka.Route53AutoNaming.DiscoverInstances

Methods

showsPrec :: Int -> DiscoverInstances -> ShowS

show :: DiscoverInstances -> String

showList :: [DiscoverInstances] -> ShowS

NFData DiscoverInstances

Defined in Amazonka.Route53AutoNaming.DiscoverInstances

Methods

rnf :: DiscoverInstances -> ()

Eq DiscoverInstances

Defined in Amazonka.Route53AutoNaming.DiscoverInstances

Methods

(==) :: DiscoverInstances -> DiscoverInstances -> Bool

(/=) :: DiscoverInstances -> DiscoverInstances -> Bool

Hashable DiscoverInstances

Defined in Amazonka.Route53AutoNaming.DiscoverInstances

Methods

hashWithSalt :: Int -> DiscoverInstances -> Int

hash :: DiscoverInstances -> Int

type AWSResponse DiscoverInstances

Defined in Amazonka.Route53AutoNaming.DiscoverInstances

type AWSResponse DiscoverInstances = DiscoverInstancesResponse

type Rep DiscoverInstances

Defined in Amazonka.Route53AutoNaming.DiscoverInstances

type Rep DiscoverInstances = D1 ('MetaData "DiscoverInstances" "Amazonka.Route53AutoNaming.DiscoverInstances" "amazonka-route53-autonaming-2.0-98MlwjLW1enGruUXoTOCqp" 'False) (C1 ('MetaCons "DiscoverInstances'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "healthStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe HealthStatusFilter)) :*: (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "optionalParameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))))) :*: (S1 ('MetaSel ('Just "queryParameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :*: (S1 ('MetaSel ('Just "namespaceName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "serviceName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newDiscoverInstances

Arguments

:: Text

DiscoverInstances

-> Text

DiscoverInstances

-> DiscoverInstances

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

DiscoverInstances, discoverInstances_healthStatus - The health status of the instances that you want to discover. This parameter is ignored for services that don't have a health check configured, and all instances are returned.

HEALTHY

Returns healthy instances.

UNHEALTHY

Returns unhealthy instances.

ALL

Returns all instances.

HEALTHY_OR_ELSE_ALL

Returns healthy instances, unless none are reporting a healthy state. In that case, return all instances. This is also called failing open.

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

$sel:optionalParameters:DiscoverInstances', discoverInstances_optionalParameters - Opportunistic filters to scope the results based on custom attributes. If there are instances that match both the filters specified in both the QueryParameters parameter and this parameter, all of these instances are returned. Otherwise, the filters are ignored, and only instances that match the filters that are specified in the QueryParameters parameter are returned.

$sel:queryParameters:DiscoverInstances', discoverInstances_queryParameters - Filters to scope the results based on custom attributes for the instance (for example, {version=v1, az=1a}). Only instances that match all the specified key-value pairs are returned.

DiscoverInstances, discoverInstances_namespaceName - The HttpName name of the namespace. It's found in the HttpProperties member of the Properties member of the namespace.

DiscoverInstances, discoverInstances_serviceName - The name of the service that you specified when you registered the instance.

Request Lenses

discoverInstances_healthStatus :: Lens' DiscoverInstances (Maybe HealthStatusFilter)

The health status of the instances that you want to discover. This parameter is ignored for services that don't have a health check configured, and all instances are returned.

HEALTHY

Returns healthy instances.

UNHEALTHY

Returns unhealthy instances.

ALL

Returns all instances.

HEALTHY_OR_ELSE_ALL

Returns healthy instances, unless none are reporting a healthy state. In that case, return all instances. This is also called failing open.

discoverInstances_maxResults :: Lens' DiscoverInstances (Maybe Natural)

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

discoverInstances_optionalParameters :: Lens' DiscoverInstances (Maybe (HashMap Text Text))

Opportunistic filters to scope the results based on custom attributes. If there are instances that match both the filters specified in both the QueryParameters parameter and this parameter, all of these instances are returned. Otherwise, the filters are ignored, and only instances that match the filters that are specified in the QueryParameters parameter are returned.

discoverInstances_queryParameters :: Lens' DiscoverInstances (Maybe (HashMap Text Text))

Filters to scope the results based on custom attributes for the instance (for example, {version=v1, az=1a}). Only instances that match all the specified key-value pairs are returned.

discoverInstances_namespaceName :: Lens' DiscoverInstances Text

The HttpName name of the namespace. It's found in the HttpProperties member of the Properties member of the namespace.

discoverInstances_serviceName :: Lens' DiscoverInstances Text

The name of the service that you specified when you registered the instance.

Destructuring the Response

data DiscoverInstancesResponse

See: newDiscoverInstancesResponse smart constructor.

Constructors

DiscoverInstancesResponse'

Fields

• instances :: Maybe [HttpInstanceSummary]

  A complex type that contains one HttpInstanceSummary for each registered instance.

• httpStatus :: Int

  The response's http status code.

Instances

Generic DiscoverInstancesResponse

Defined in Amazonka.Route53AutoNaming.DiscoverInstances

Associated Types

type Rep DiscoverInstancesResponse :: Type -> Type

Methods

from :: DiscoverInstancesResponse -> Rep DiscoverInstancesResponse x

to :: Rep DiscoverInstancesResponse x -> DiscoverInstancesResponse

Read DiscoverInstancesResponse

Defined in Amazonka.Route53AutoNaming.DiscoverInstances

Methods

readsPrec :: Int -> ReadS DiscoverInstancesResponse

readList :: ReadS [DiscoverInstancesResponse]

readPrec :: ReadPrec DiscoverInstancesResponse

readListPrec :: ReadPrec [DiscoverInstancesResponse]

Show DiscoverInstancesResponse

Defined in Amazonka.Route53AutoNaming.DiscoverInstances

Methods

showsPrec :: Int -> DiscoverInstancesResponse -> ShowS

show :: DiscoverInstancesResponse -> String

showList :: [DiscoverInstancesResponse] -> ShowS

NFData DiscoverInstancesResponse

Defined in Amazonka.Route53AutoNaming.DiscoverInstances

Methods

rnf :: DiscoverInstancesResponse -> ()

Eq DiscoverInstancesResponse

Defined in Amazonka.Route53AutoNaming.DiscoverInstances

Methods

(==) :: DiscoverInstancesResponse -> DiscoverInstancesResponse -> Bool

(/=) :: DiscoverInstancesResponse -> DiscoverInstancesResponse -> Bool

type Rep DiscoverInstancesResponse

Defined in Amazonka.Route53AutoNaming.DiscoverInstances

type Rep DiscoverInstancesResponse = D1 ('MetaData "DiscoverInstancesResponse" "Amazonka.Route53AutoNaming.DiscoverInstances" "amazonka-route53-autonaming-2.0-98MlwjLW1enGruUXoTOCqp" 'False) (C1 ('MetaCons "DiscoverInstancesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "instances") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [HttpInstanceSummary])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newDiscoverInstancesResponse

Arguments

:: Int

$sel:httpStatus:DiscoverInstancesResponse'

-> DiscoverInstancesResponse

Create a value of DiscoverInstancesResponse 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:instances:DiscoverInstancesResponse', discoverInstancesResponse_instances - A complex type that contains one HttpInstanceSummary for each registered instance.

$sel:httpStatus:DiscoverInstancesResponse', discoverInstancesResponse_httpStatus - The response's http status code.

Response Lenses

discoverInstancesResponse_instances :: Lens' DiscoverInstancesResponse (Maybe [HttpInstanceSummary])

A complex type that contains one HttpInstanceSummary for each registered instance.

discoverInstancesResponse_httpStatus :: Lens' DiscoverInstancesResponse Int

The response's http status code.