Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

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

Creating a Request

data GetInstancesHealthStatus Source #

See: newGetInstancesHealthStatus smart constructor.

Constructors

GetInstancesHealthStatus'

Fields

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.
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.
serviceId :: Text
The ID of the service that the instance is associated with.

Instances

Instances details

ToJSON GetInstancesHealthStatus Source #
Instance details Defined in Amazonka.Route53AutoNaming.GetInstancesHealthStatus Methods toJSON :: GetInstancesHealthStatus -> Value # toEncoding :: GetInstancesHealthStatus -> Encoding # toJSONList :: [GetInstancesHealthStatus] -> Value # toEncodingList :: [GetInstancesHealthStatus] -> Encoding #
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 #
AWSRequest GetInstancesHealthStatus Source #
Instance details Defined in Amazonka.Route53AutoNaming.GetInstancesHealthStatus Associated Types type AWSResponse GetInstancesHealthStatus # Methods request :: (Service -> Service) -> GetInstancesHealthStatus -> Request GetInstancesHealthStatus # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetInstancesHealthStatus -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetInstancesHealthStatus))) #
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 #
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 #
NFData GetInstancesHealthStatus Source #
Instance details Defined in Amazonka.Route53AutoNaming.GetInstancesHealthStatus Methods rnf :: GetInstancesHealthStatus -> () #
Eq GetInstancesHealthStatus Source #
Instance details Defined in Amazonka.Route53AutoNaming.GetInstancesHealthStatus Methods (==) :: GetInstancesHealthStatus -> GetInstancesHealthStatus -> Bool # (/=) :: GetInstancesHealthStatus -> GetInstancesHealthStatus -> Bool #
Hashable GetInstancesHealthStatus Source #
Instance details Defined in Amazonka.Route53AutoNaming.GetInstancesHealthStatus Methods hashWithSalt :: Int -> GetInstancesHealthStatus -> Int # hash :: GetInstancesHealthStatus -> Int #
type AWSResponse GetInstancesHealthStatus Source #
Instance details Defined in Amazonka.Route53AutoNaming.GetInstancesHealthStatus type AWSResponse GetInstancesHealthStatus = GetInstancesHealthStatusResponse
type Rep GetInstancesHealthStatus Source #
Instance details Defined in Amazonka.Route53AutoNaming.GetInstancesHealthStatus type Rep GetInstancesHealthStatus = D1 ('MetaData "GetInstancesHealthStatus" "Amazonka.Route53AutoNaming.GetInstancesHealthStatus" "amazonka-route53-autonaming-2.0-98MlwjLW1enGruUXoTOCqp" 'False) (C1 ('MetaCons "GetInstancesHealthStatus'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "instances") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Text))) :: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "serviceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

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

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:serviceId:GetInstancesHealthStatus', getInstancesHealthStatus_serviceId - The ID of the service that the instance is associated with.

Request Lenses

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

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.
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.
httpStatus :: Int
The response's http status code.

Instances

Instances details

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 #
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 #
NFData GetInstancesHealthStatusResponse Source #
Instance details Defined in Amazonka.Route53AutoNaming.GetInstancesHealthStatus Methods rnf :: GetInstancesHealthStatusResponse -> () #
Eq GetInstancesHealthStatusResponse Source #
Instance details Defined in Amazonka.Route53AutoNaming.GetInstancesHealthStatus Methods (==) :: GetInstancesHealthStatusResponse -> GetInstancesHealthStatusResponse -> Bool # (/=) :: GetInstancesHealthStatusResponse -> GetInstancesHealthStatusResponse -> Bool #
type Rep GetInstancesHealthStatusResponse Source #
Instance details Defined in Amazonka.Route53AutoNaming.GetInstancesHealthStatus type Rep GetInstancesHealthStatusResponse = D1 ('MetaData "GetInstancesHealthStatusResponse" "Amazonka.Route53AutoNaming.GetInstancesHealthStatus" "amazonka-route53-autonaming-2.0-98MlwjLW1enGruUXoTOCqp" 'False) (C1 ('MetaCons "GetInstancesHealthStatusResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text HealthStatus))) :: 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:

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.

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:httpStatus:GetInstancesHealthStatusResponse', getInstancesHealthStatusResponse_httpStatus - The response's http status code.

Response Lenses

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_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_httpStatus :: Lens' GetInstancesHealthStatusResponse Int Source #

The response's http status code.