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 |
Gets information about a warm pool and its instances.
For more information, see Warm pools for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
Synopsis
- data DescribeWarmPool = DescribeWarmPool' {}
- newDescribeWarmPool :: Text -> DescribeWarmPool
- describeWarmPool_maxRecords :: Lens' DescribeWarmPool (Maybe Int)
- describeWarmPool_nextToken :: Lens' DescribeWarmPool (Maybe Text)
- describeWarmPool_autoScalingGroupName :: Lens' DescribeWarmPool Text
- data DescribeWarmPoolResponse = DescribeWarmPoolResponse' {}
- newDescribeWarmPoolResponse :: Int -> DescribeWarmPoolResponse
- describeWarmPoolResponse_instances :: Lens' DescribeWarmPoolResponse (Maybe [Instance])
- describeWarmPoolResponse_nextToken :: Lens' DescribeWarmPoolResponse (Maybe Text)
- describeWarmPoolResponse_warmPoolConfiguration :: Lens' DescribeWarmPoolResponse (Maybe WarmPoolConfiguration)
- describeWarmPoolResponse_httpStatus :: Lens' DescribeWarmPoolResponse Int
Creating a Request
data DescribeWarmPool Source #
See: newDescribeWarmPool
smart constructor.
DescribeWarmPool' | |
|
Instances
Create a value of DescribeWarmPool
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:maxRecords:DescribeWarmPool'
, describeWarmPool_maxRecords
- The maximum number of instances to return with this call. The maximum
value is 50
.
DescribeWarmPool
, describeWarmPool_nextToken
- The token for the next set of instances to return. (You received this
token from a previous call.)
DescribeWarmPool
, describeWarmPool_autoScalingGroupName
- The name of the Auto Scaling group.
Request Lenses
describeWarmPool_maxRecords :: Lens' DescribeWarmPool (Maybe Int) Source #
The maximum number of instances to return with this call. The maximum
value is 50
.
describeWarmPool_nextToken :: Lens' DescribeWarmPool (Maybe Text) Source #
The token for the next set of instances to return. (You received this token from a previous call.)
describeWarmPool_autoScalingGroupName :: Lens' DescribeWarmPool Text Source #
The name of the Auto Scaling group.
Destructuring the Response
data DescribeWarmPoolResponse Source #
See: newDescribeWarmPoolResponse
smart constructor.
DescribeWarmPoolResponse' | |
|
Instances
newDescribeWarmPoolResponse Source #
Create a value of DescribeWarmPoolResponse
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:
DescribeWarmPoolResponse
, describeWarmPoolResponse_instances
- The instances that are currently in the warm pool.
DescribeWarmPool
, describeWarmPoolResponse_nextToken
- This string indicates that the response contains more items than can be
returned in a single response. To receive additional items, specify this
string for the NextToken
value when requesting the next set of items.
This value is null when there are no more items to return.
DescribeWarmPoolResponse
, describeWarmPoolResponse_warmPoolConfiguration
- The warm pool configuration details.
$sel:httpStatus:DescribeWarmPoolResponse'
, describeWarmPoolResponse_httpStatus
- The response's http status code.
Response Lenses
describeWarmPoolResponse_instances :: Lens' DescribeWarmPoolResponse (Maybe [Instance]) Source #
The instances that are currently in the warm pool.
describeWarmPoolResponse_nextToken :: Lens' DescribeWarmPoolResponse (Maybe Text) Source #
This string indicates that the response contains more items than can be
returned in a single response. To receive additional items, specify this
string for the NextToken
value when requesting the next set of items.
This value is null when there are no more items to return.
describeWarmPoolResponse_warmPoolConfiguration :: Lens' DescribeWarmPoolResponse (Maybe WarmPoolConfiguration) Source #
The warm pool configuration details.
describeWarmPoolResponse_httpStatus :: Lens' DescribeWarmPoolResponse Int Source #
The response's http status code.