Copyright | (c) 2013-2018 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 |
Language | Haskell2010 |
Gets the current health status (Healthy
, Unhealthy
, or Unknown
) of one or more instances that are associated with a specified service.
- getInstancesHealthStatus :: Text -> GetInstancesHealthStatus
- data GetInstancesHealthStatus
- gihsNextToken :: Lens' GetInstancesHealthStatus (Maybe Text)
- gihsInstances :: Lens' GetInstancesHealthStatus (Maybe (NonEmpty Text))
- gihsMaxResults :: Lens' GetInstancesHealthStatus (Maybe Natural)
- gihsServiceId :: Lens' GetInstancesHealthStatus Text
- getInstancesHealthStatusResponse :: Int -> GetInstancesHealthStatusResponse
- data GetInstancesHealthStatusResponse
- gihsrsStatus :: Lens' GetInstancesHealthStatusResponse (HashMap Text HealthStatus)
- gihsrsNextToken :: Lens' GetInstancesHealthStatusResponse (Maybe Text)
- gihsrsResponseStatus :: Lens' GetInstancesHealthStatusResponse Int
Creating a Request
getInstancesHealthStatus Source #
Creates a value of GetInstancesHealthStatus
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
gihsNextToken
- For the firstGetInstancesHealthStatus
request, omit this value. If more thanMaxResults
instances match the specified criteria, you can submit anotherGetInstancesHealthStatus
request to get the next group of results. Specify the value ofNextToken
from the previous response in the next request.gihsInstances
- An array that contains the IDs of all the instances that you want to get the health status for. If you omitInstances
, Amazon Route 53 returns the health status for all the instances that are associated with the specified service.gihsMaxResults
- The maximum number of instances that you want Route 53 to return in the response to aGetInstancesHealthStatus
request. If you don't specify a value forMaxResults
, Route 53 returns up to 100 instances.gihsServiceId
- The ID of the service that the instance is associated with.
data GetInstancesHealthStatus Source #
See: getInstancesHealthStatus
smart constructor.
Request Lenses
gihsNextToken :: 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.
gihsInstances :: 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
, Amazon Route 53 returns the health status for all the instances that are associated with the specified service.
gihsMaxResults :: Lens' GetInstancesHealthStatus (Maybe Natural) Source #
The maximum number of instances that you want Route 53 to return in the response to a GetInstancesHealthStatus
request. If you don't specify a value for MaxResults
, Route 53 returns up to 100 instances.
gihsServiceId :: Lens' GetInstancesHealthStatus Text Source #
The ID of the service that the instance is associated with.
Destructuring the Response
getInstancesHealthStatusResponse Source #
Creates a value of GetInstancesHealthStatusResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
gihsrsStatus
- A complex type that contains the IDs and the health status of the instances that you specified in theGetInstancesHealthStatus
request.gihsrsNextToken
- If more thanMaxResults
instances match the specified criteria, you can submit anotherGetInstancesHealthStatus
request to get the next group of results. Specify the value ofNextToken
from the previous response in the next request.gihsrsResponseStatus
- -- | The response status code.
data GetInstancesHealthStatusResponse Source #
See: getInstancesHealthStatusResponse
smart constructor.
Response Lenses
gihsrsStatus :: Lens' GetInstancesHealthStatusResponse (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.
gihsrsNextToken :: 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.
gihsrsResponseStatus :: Lens' GetInstancesHealthStatusResponse Int Source #
- - | The response status code.