Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.Route53AutoNaming.DiscoverInstances

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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.

Synopsis

data DiscoverInstances = DiscoverInstances' {
- queryParameters :: Maybe (HashMap Text Text)
- optionalParameters :: Maybe (HashMap Text Text)
- healthStatus :: Maybe HealthStatusFilter
- maxResults :: Maybe Natural
- namespaceName :: Text
- serviceName :: Text
}
newDiscoverInstances :: Text -> Text -> DiscoverInstances
discoverInstances_queryParameters :: Lens' DiscoverInstances (Maybe (HashMap Text Text))
discoverInstances_optionalParameters :: Lens' DiscoverInstances (Maybe (HashMap Text Text))
discoverInstances_healthStatus :: Lens' DiscoverInstances (Maybe HealthStatusFilter)
discoverInstances_maxResults :: Lens' DiscoverInstances (Maybe Natural)
discoverInstances_namespaceName :: Lens' DiscoverInstances Text
discoverInstances_serviceName :: Lens' DiscoverInstances Text
data DiscoverInstancesResponse = DiscoverInstancesResponse' {
- instances :: Maybe [HttpInstanceSummary]
- httpStatus :: Int
}
newDiscoverInstancesResponse :: Int -> DiscoverInstancesResponse
discoverInstancesResponse_instances :: Lens' DiscoverInstancesResponse (Maybe [HttpInstanceSummary])
discoverInstancesResponse_httpStatus :: Lens' DiscoverInstancesResponse Int

Creating a Request

data DiscoverInstances Source #

See: newDiscoverInstances smart constructor.

Constructors

DiscoverInstances'

Fields

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

Instances details

Eq DiscoverInstances Source #
Instance details Defined in Amazonka.Route53AutoNaming.DiscoverInstances Methods (==) :: DiscoverInstances -> DiscoverInstances -> Bool # (/=) :: DiscoverInstances -> DiscoverInstances -> Bool #
Read DiscoverInstances Source #
Instance details Defined in Amazonka.Route53AutoNaming.DiscoverInstances Methods readsPrec :: Int -> ReadS DiscoverInstances # readList :: ReadS [DiscoverInstances] # readPrec :: ReadPrec DiscoverInstances # readListPrec :: ReadPrec [DiscoverInstances] #
Show DiscoverInstances Source #
Instance details Defined in Amazonka.Route53AutoNaming.DiscoverInstances Methods showsPrec :: Int -> DiscoverInstances -> ShowS # show :: DiscoverInstances -> String # showList :: [DiscoverInstances] -> ShowS #
Generic DiscoverInstances Source #
Instance details Defined in Amazonka.Route53AutoNaming.DiscoverInstances Associated Types type Rep DiscoverInstances :: Type -> Type # Methods from :: DiscoverInstances -> Rep DiscoverInstances x # to :: Rep DiscoverInstances x -> DiscoverInstances #
NFData DiscoverInstances Source #
Instance details Defined in Amazonka.Route53AutoNaming.DiscoverInstances Methods rnf :: DiscoverInstances -> () #
Hashable DiscoverInstances Source #
Instance details Defined in Amazonka.Route53AutoNaming.DiscoverInstances Methods hashWithSalt :: Int -> DiscoverInstances -> Int # hash :: DiscoverInstances -> Int #
ToJSON DiscoverInstances Source #
Instance details Defined in Amazonka.Route53AutoNaming.DiscoverInstances Methods toJSON :: DiscoverInstances -> Value # toEncoding :: DiscoverInstances -> Encoding # toJSONList :: [DiscoverInstances] -> Value # toEncodingList :: [DiscoverInstances] -> Encoding #
AWSRequest DiscoverInstances Source #
Instance details Defined in Amazonka.Route53AutoNaming.DiscoverInstances Associated Types type AWSResponse DiscoverInstances # Methods request :: DiscoverInstances -> Request DiscoverInstances # response :: MonadResource m => Logger -> Service -> Proxy DiscoverInstances -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DiscoverInstances))) #
ToHeaders DiscoverInstances Source #
Instance details Defined in Amazonka.Route53AutoNaming.DiscoverInstances Methods toHeaders :: DiscoverInstances -> [Header] #
ToPath DiscoverInstances Source #
Instance details Defined in Amazonka.Route53AutoNaming.DiscoverInstances Methods toPath :: DiscoverInstances -> ByteString #
ToQuery DiscoverInstances Source #
Instance details Defined in Amazonka.Route53AutoNaming.DiscoverInstances Methods toQuery :: DiscoverInstances -> QueryString #
type Rep DiscoverInstances Source #
Instance details Defined in Amazonka.Route53AutoNaming.DiscoverInstances type Rep DiscoverInstances = D1 ('MetaData "DiscoverInstances" "Amazonka.Route53AutoNaming.DiscoverInstances" "libZSservicesZSamazonka-route53-autonamingZSamazonka-route53-autonaming" 'False) (C1 ('MetaCons "DiscoverInstances'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "queryParameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :: (S1 ('MetaSel ('Just "optionalParameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :: S1 ('MetaSel ('Just "healthStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe HealthStatusFilter)))) :: (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: (S1 ('MetaSel ('Just "namespaceName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "serviceName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))
type AWSResponse DiscoverInstances Source #
Instance details Defined in Amazonka.Route53AutoNaming.DiscoverInstances type AWSResponse DiscoverInstances = DiscoverInstancesResponse

newDiscoverInstances Source #

Arguments

:: Text	`$sel:namespaceName:DiscoverInstances'`
-> Text	`$sel:serviceName: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:

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

$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:healthStatus: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:namespaceName:DiscoverInstances', discoverInstances_namespaceName - The HttpName name of the namespace. It's found in the HttpProperties member of the Properties member of the namespace.

$sel:serviceName:DiscoverInstances', discoverInstances_serviceName - The name of the service that you specified when you registered the instance.

Request Lenses

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

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_optionalParameters :: Lens' DiscoverInstances (Maybe (HashMap Text Text)) Source #

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_healthStatus :: Lens' DiscoverInstances (Maybe HealthStatusFilter) Source #

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) Source #

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_namespaceName :: Lens' DiscoverInstances Text Source #

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

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

Destructuring the Response

data DiscoverInstancesResponse Source #

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

Instances details

Eq DiscoverInstancesResponse Source #
Instance details Defined in Amazonka.Route53AutoNaming.DiscoverInstances Methods (==) :: DiscoverInstancesResponse -> DiscoverInstancesResponse -> Bool # (/=) :: DiscoverInstancesResponse -> DiscoverInstancesResponse -> Bool #
Read DiscoverInstancesResponse Source #
Instance details Defined in Amazonka.Route53AutoNaming.DiscoverInstances Methods readsPrec :: Int -> ReadS DiscoverInstancesResponse # readList :: ReadS [DiscoverInstancesResponse] # readPrec :: ReadPrec DiscoverInstancesResponse # readListPrec :: ReadPrec [DiscoverInstancesResponse] #
Show DiscoverInstancesResponse Source #
Instance details Defined in Amazonka.Route53AutoNaming.DiscoverInstances Methods showsPrec :: Int -> DiscoverInstancesResponse -> ShowS # show :: DiscoverInstancesResponse -> String # showList :: [DiscoverInstancesResponse] -> ShowS #
Generic DiscoverInstancesResponse Source #
Instance details Defined in Amazonka.Route53AutoNaming.DiscoverInstances Associated Types type Rep DiscoverInstancesResponse :: Type -> Type # Methods from :: DiscoverInstancesResponse -> Rep DiscoverInstancesResponse x # to :: Rep DiscoverInstancesResponse x -> DiscoverInstancesResponse #
NFData DiscoverInstancesResponse Source #
Instance details Defined in Amazonka.Route53AutoNaming.DiscoverInstances Methods rnf :: DiscoverInstancesResponse -> () #
type Rep DiscoverInstancesResponse Source #
Instance details Defined in Amazonka.Route53AutoNaming.DiscoverInstances type Rep DiscoverInstancesResponse = D1 ('MetaData "DiscoverInstancesResponse" "Amazonka.Route53AutoNaming.DiscoverInstances" "libZSservicesZSamazonka-route53-autonamingZSamazonka-route53-autonaming" '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 Source #

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]) Source #

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

discoverInstancesResponse_httpStatus :: Lens' DiscoverInstancesResponse Int Source #

The response's http status code.