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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Gets the current health status (Healthy, Unhealthy, or Unknown) of one or more instances that are associated with a specified service.

There's a brief delay between when you register an instance and when the health status for the instance is available.

Synopsis

data GetInstancesHealthStatus = GetInstancesHealthStatus' {
- nextToken :: Maybe Text
- instances :: Maybe (NonEmpty Text)
- maxResults :: Maybe Natural
- serviceId :: Text
}
newGetInstancesHealthStatus :: Text -> GetInstancesHealthStatus
getInstancesHealthStatus_nextToken :: Lens' GetInstancesHealthStatus (Maybe Text)
getInstancesHealthStatus_instances :: Lens' GetInstancesHealthStatus (Maybe (NonEmpty Text))
getInstancesHealthStatus_maxResults :: Lens' GetInstancesHealthStatus (Maybe Natural)
getInstancesHealthStatus_serviceId :: Lens' GetInstancesHealthStatus Text
data GetInstancesHealthStatusResponse = GetInstancesHealthStatusResponse' {
- status :: Maybe (HashMap Text HealthStatus)
- nextToken :: Maybe Text
- httpStatus :: Int
}
newGetInstancesHealthStatusResponse :: Int -> GetInstancesHealthStatusResponse
getInstancesHealthStatusResponse_status :: Lens' GetInstancesHealthStatusResponse (Maybe (HashMap Text HealthStatus))
getInstancesHealthStatusResponse_nextToken :: Lens' GetInstancesHealthStatusResponse (Maybe Text)
getInstancesHealthStatusResponse_httpStatus :: Lens' GetInstancesHealthStatusResponse Int

Creating a Request

data GetInstancesHealthStatus Source #

See: newGetInstancesHealthStatus smart constructor.

Constructors

GetInstancesHealthStatus'

Fields

nextToken :: Maybe Text
For the first GetInstancesHealthStatus request, omit this value.
If more than MaxResults instances match the specified criteria, you can submit another GetInstancesHealthStatus request to get the next group of results. Specify the value of NextToken from the previous response in the next request.
instances :: Maybe (NonEmpty Text)
An array that contains the IDs of all the instances that you want to get the health status for.
If you omit Instances, Cloud Map returns the health status for all the instances that are associated with the specified service.
To get the IDs for the instances that you've registered by using a specified service, submit a ListInstances request.
maxResults :: Maybe Natural
The maximum number of instances that you want Cloud Map to return in the response to a GetInstancesHealthStatus request. If you don't specify a value for MaxResults, Cloud Map returns up to 100 instances.
serviceId :: Text
The ID of the service that the instance is associated with.

Instances

Instances details

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

newGetInstancesHealthStatus Source #

Arguments

:: Text	`$sel:serviceId:GetInstancesHealthStatus'`
-> GetInstancesHealthStatus

Create a value of GetInstancesHealthStatus 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:nextToken:GetInstancesHealthStatus', getInstancesHealthStatus_nextToken - For the first GetInstancesHealthStatus request, omit this value.

If more than MaxResults instances match the specified criteria, you can submit another GetInstancesHealthStatus request to get the next group of results. Specify the value of NextToken from the previous response in the next request.

$sel:instances:GetInstancesHealthStatus', getInstancesHealthStatus_instances - An array that contains the IDs of all the instances that you want to get the health status for.

If you omit Instances, Cloud Map returns the health status for all the instances that are associated with the specified service.

To get the IDs for the instances that you've registered by using a specified service, submit a ListInstances request.

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

$sel:serviceId:GetInstancesHealthStatus', getInstancesHealthStatus_serviceId - The ID of the service that the instance is associated with.

Request Lenses

getInstancesHealthStatus_nextToken :: Lens' GetInstancesHealthStatus (Maybe Text) Source #

For the first GetInstancesHealthStatus request, omit this value.

If more than MaxResults instances match the specified criteria, you can submit another GetInstancesHealthStatus request to get the next group of results. Specify the value of NextToken from the previous response in the next request.

getInstancesHealthStatus_instances :: Lens' GetInstancesHealthStatus (Maybe (NonEmpty Text)) Source #

An array that contains the IDs of all the instances that you want to get the health status for.

If you omit Instances, Cloud Map returns the health status for all the instances that are associated with the specified service.

To get the IDs for the instances that you've registered by using a specified service, submit a ListInstances request.

getInstancesHealthStatus_maxResults :: Lens' GetInstancesHealthStatus (Maybe Natural) Source #

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

getInstancesHealthStatus_serviceId :: Lens' GetInstancesHealthStatus Text Source #

The ID of the service that the instance is associated with.

Destructuring the Response

data GetInstancesHealthStatusResponse Source #

See: newGetInstancesHealthStatusResponse smart constructor.

Constructors

GetInstancesHealthStatusResponse'

Fields

status :: Maybe (HashMap Text HealthStatus)
A complex type that contains the IDs and the health status of the instances that you specified in the GetInstancesHealthStatus request.
nextToken :: Maybe Text
If more than MaxResults instances match the specified criteria, you can submit another GetInstancesHealthStatus request to get the next group of results. Specify the value of NextToken from the previous response in the next request.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Eq GetInstancesHealthStatusResponse Source #
Instance details Defined in Amazonka.Route53AutoNaming.GetInstancesHealthStatus Methods (==) :: GetInstancesHealthStatusResponse -> GetInstancesHealthStatusResponse -> Bool # (/=) :: GetInstancesHealthStatusResponse -> GetInstancesHealthStatusResponse -> Bool #
Read GetInstancesHealthStatusResponse Source #
Instance details Defined in Amazonka.Route53AutoNaming.GetInstancesHealthStatus Methods readsPrec :: Int -> ReadS GetInstancesHealthStatusResponse # readList :: ReadS [GetInstancesHealthStatusResponse] # readPrec :: ReadPrec GetInstancesHealthStatusResponse # readListPrec :: ReadPrec [GetInstancesHealthStatusResponse] #
Show GetInstancesHealthStatusResponse Source #
Instance details Defined in Amazonka.Route53AutoNaming.GetInstancesHealthStatus Methods showsPrec :: Int -> GetInstancesHealthStatusResponse -> ShowS # show :: GetInstancesHealthStatusResponse -> String # showList :: [GetInstancesHealthStatusResponse] -> ShowS #
Generic GetInstancesHealthStatusResponse Source #
Instance details Defined in Amazonka.Route53AutoNaming.GetInstancesHealthStatus Associated Types type Rep GetInstancesHealthStatusResponse :: Type -> Type # Methods from :: GetInstancesHealthStatusResponse -> Rep GetInstancesHealthStatusResponse x # to :: Rep GetInstancesHealthStatusResponse x -> GetInstancesHealthStatusResponse #
NFData GetInstancesHealthStatusResponse Source #
Instance details Defined in Amazonka.Route53AutoNaming.GetInstancesHealthStatus Methods rnf :: GetInstancesHealthStatusResponse -> () #
type Rep GetInstancesHealthStatusResponse Source #
Instance details Defined in Amazonka.Route53AutoNaming.GetInstancesHealthStatus type Rep GetInstancesHealthStatusResponse = D1 ('MetaData "GetInstancesHealthStatusResponse" "Amazonka.Route53AutoNaming.GetInstancesHealthStatus" "libZSservicesZSamazonka-route53-autonamingZSamazonka-route53-autonaming" 'False) (C1 ('MetaCons "GetInstancesHealthStatusResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text HealthStatus))) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newGetInstancesHealthStatusResponse Source #

Arguments

:: Int	`$sel:httpStatus:GetInstancesHealthStatusResponse'`
-> GetInstancesHealthStatusResponse

Create a value of GetInstancesHealthStatusResponse 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:status:GetInstancesHealthStatusResponse', getInstancesHealthStatusResponse_status - A complex type that contains the IDs and the health status of the instances that you specified in the GetInstancesHealthStatus request.

$sel:nextToken:GetInstancesHealthStatus', getInstancesHealthStatusResponse_nextToken - If more than MaxResults instances match the specified criteria, you can submit another GetInstancesHealthStatus request to get the next group of results. Specify the value of NextToken from the previous response in the next request.

$sel:httpStatus:GetInstancesHealthStatusResponse', getInstancesHealthStatusResponse_httpStatus - The response's http status code.

Response Lenses

getInstancesHealthStatusResponse_status :: Lens' GetInstancesHealthStatusResponse (Maybe (HashMap Text HealthStatus)) Source #

A complex type that contains the IDs and the health status of the instances that you specified in the GetInstancesHealthStatus request.

getInstancesHealthStatusResponse_nextToken :: Lens' GetInstancesHealthStatusResponse (Maybe Text) Source #

If more than MaxResults instances match the specified criteria, you can submit another GetInstancesHealthStatus request to get the next group of results. Specify the value of NextToken from the previous response in the next request.

getInstancesHealthStatusResponse_httpStatus :: Lens' GetInstancesHealthStatusResponse Int Source #

The response's http status code.