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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Describes the specified EC2 Fleets or all of your EC2 Fleets.

For more information, see Monitor your EC2 Fleet in the Amazon EC2 User Guide.

This operation returns paginated results.

Synopsis

data DescribeFleets = DescribeFleets' {
- dryRun :: Maybe Bool
- filters :: Maybe [Filter]
- fleetIds :: Maybe [Text]
- maxResults :: Maybe Int
- nextToken :: Maybe Text
}
newDescribeFleets :: DescribeFleets
describeFleets_dryRun :: Lens' DescribeFleets (Maybe Bool)
describeFleets_filters :: Lens' DescribeFleets (Maybe [Filter])
describeFleets_fleetIds :: Lens' DescribeFleets (Maybe [Text])
describeFleets_maxResults :: Lens' DescribeFleets (Maybe Int)
describeFleets_nextToken :: Lens' DescribeFleets (Maybe Text)
data DescribeFleetsResponse = DescribeFleetsResponse' {
- fleets :: Maybe [FleetData]
- nextToken :: Maybe Text
- httpStatus :: Int
}
newDescribeFleetsResponse :: Int -> DescribeFleetsResponse
describeFleetsResponse_fleets :: Lens' DescribeFleetsResponse (Maybe [FleetData])
describeFleetsResponse_nextToken :: Lens' DescribeFleetsResponse (Maybe Text)
describeFleetsResponse_httpStatus :: Lens' DescribeFleetsResponse Int

Creating a Request

data DescribeFleets Source #

See: newDescribeFleets smart constructor.

Constructors

DescribeFleets'

Fields

dryRun :: Maybe Bool
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
filters :: Maybe [Filter]
The filters.
- activity-status - The progress of the EC2 Fleet ( error | pending-fulfillment | pending-termination | fulfilled).
- excess-capacity-termination-policy - Indicates whether to terminate running instances if the target capacity is decreased below the current EC2 Fleet size (true | false).
- fleet-state - The state of the EC2 Fleet (submitted | active | deleted | failed | deleted-running | deleted-terminating | modifying).
- replace-unhealthy-instances - Indicates whether EC2 Fleet should replace unhealthy instances (true | false).
- type - The type of request (instant | request | maintain).
fleetIds :: Maybe [Text]
The IDs of the EC2 Fleets.
If a fleet is of type instant, you must specify the fleet ID, otherwise it does not appear in the response.
maxResults :: Maybe Int
The maximum number of results to return in a single call. Specify a value between 1 and 1000. The default value is 1000. To retrieve the remaining results, make another call with the returned NextToken value.
nextToken :: Maybe Text
The token for the next set of results.

Instances

Instances details

ToHeaders DescribeFleets Source #
Instance details Defined in Amazonka.EC2.DescribeFleets Methods toHeaders :: DescribeFleets -> [Header] #
ToPath DescribeFleets Source #
Instance details Defined in Amazonka.EC2.DescribeFleets Methods toPath :: DescribeFleets -> ByteString #
ToQuery DescribeFleets Source #
Instance details Defined in Amazonka.EC2.DescribeFleets Methods toQuery :: DescribeFleets -> QueryString #
AWSPager DescribeFleets Source #
Instance details Defined in Amazonka.EC2.DescribeFleets Methods page :: DescribeFleets -> AWSResponse DescribeFleets -> Maybe DescribeFleets #
AWSRequest DescribeFleets Source #
Instance details Defined in Amazonka.EC2.DescribeFleets Associated Types type AWSResponse DescribeFleets # Methods request :: (Service -> Service) -> DescribeFleets -> Request DescribeFleets # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeFleets -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeFleets))) #
Generic DescribeFleets Source #
Instance details Defined in Amazonka.EC2.DescribeFleets Associated Types type Rep DescribeFleets :: Type -> Type # Methods from :: DescribeFleets -> Rep DescribeFleets x # to :: Rep DescribeFleets x -> DescribeFleets #
Read DescribeFleets Source #
Instance details Defined in Amazonka.EC2.DescribeFleets Methods readsPrec :: Int -> ReadS DescribeFleets # readList :: ReadS [DescribeFleets] # readPrec :: ReadPrec DescribeFleets # readListPrec :: ReadPrec [DescribeFleets] #
Show DescribeFleets Source #
Instance details Defined in Amazonka.EC2.DescribeFleets Methods showsPrec :: Int -> DescribeFleets -> ShowS # show :: DescribeFleets -> String # showList :: [DescribeFleets] -> ShowS #
NFData DescribeFleets Source #
Instance details Defined in Amazonka.EC2.DescribeFleets Methods rnf :: DescribeFleets -> () #
Eq DescribeFleets Source #
Instance details Defined in Amazonka.EC2.DescribeFleets Methods (==) :: DescribeFleets -> DescribeFleets -> Bool # (/=) :: DescribeFleets -> DescribeFleets -> Bool #
Hashable DescribeFleets Source #
Instance details Defined in Amazonka.EC2.DescribeFleets Methods hashWithSalt :: Int -> DescribeFleets -> Int # hash :: DescribeFleets -> Int #
type AWSResponse DescribeFleets Source #
Instance details Defined in Amazonka.EC2.DescribeFleets type AWSResponse DescribeFleets = DescribeFleetsResponse
type Rep DescribeFleets Source #
Instance details Defined in Amazonka.EC2.DescribeFleets type Rep DescribeFleets = D1 ('MetaData "DescribeFleets" "Amazonka.EC2.DescribeFleets" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "DescribeFleets'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "dryRun") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "filters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Filter]))) :: (S1 ('MetaSel ('Just "fleetIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

newDescribeFleets :: DescribeFleets Source #

Create a value of DescribeFleets 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:dryRun:DescribeFleets', describeFleets_dryRun - Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

$sel:filters:DescribeFleets', describeFleets_filters - The filters.

activity-status - The progress of the EC2 Fleet ( error | pending-fulfillment | pending-termination | fulfilled).
excess-capacity-termination-policy - Indicates whether to terminate running instances if the target capacity is decreased below the current EC2 Fleet size (true | false).
fleet-state - The state of the EC2 Fleet (submitted | active | deleted | failed | deleted-running | deleted-terminating | modifying).
replace-unhealthy-instances - Indicates whether EC2 Fleet should replace unhealthy instances (true | false).
type - The type of request (instant | request | maintain).

$sel:fleetIds:DescribeFleets', describeFleets_fleetIds - The IDs of the EC2 Fleets.

If a fleet is of type instant, you must specify the fleet ID, otherwise it does not appear in the response.

$sel:maxResults:DescribeFleets', describeFleets_maxResults - The maximum number of results to return in a single call. Specify a value between 1 and 1000. The default value is 1000. To retrieve the remaining results, make another call with the returned NextToken value.

DescribeFleets, describeFleets_nextToken - The token for the next set of results.

Request Lenses

describeFleets_dryRun :: Lens' DescribeFleets (Maybe Bool) Source #

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

describeFleets_filters :: Lens' DescribeFleets (Maybe [Filter]) Source #

The filters.

activity-status - The progress of the EC2 Fleet ( error | pending-fulfillment | pending-termination | fulfilled).
excess-capacity-termination-policy - Indicates whether to terminate running instances if the target capacity is decreased below the current EC2 Fleet size (true | false).
fleet-state - The state of the EC2 Fleet (submitted | active | deleted | failed | deleted-running | deleted-terminating | modifying).
replace-unhealthy-instances - Indicates whether EC2 Fleet should replace unhealthy instances (true | false).
type - The type of request (instant | request | maintain).

describeFleets_fleetIds :: Lens' DescribeFleets (Maybe [Text]) Source #

The IDs of the EC2 Fleets.

If a fleet is of type instant, you must specify the fleet ID, otherwise it does not appear in the response.

describeFleets_maxResults :: Lens' DescribeFleets (Maybe Int) Source #

The maximum number of results to return in a single call. Specify a value between 1 and 1000. The default value is 1000. To retrieve the remaining results, make another call with the returned NextToken value.

describeFleets_nextToken :: Lens' DescribeFleets (Maybe Text) Source #

The token for the next set of results.

Destructuring the Response

data DescribeFleetsResponse Source #

See: newDescribeFleetsResponse smart constructor.

Constructors

DescribeFleetsResponse'
Fields fleets :: Maybe [FleetData] Information about the EC2 Fleets. nextToken :: Maybe Text The token for the next set of results. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic DescribeFleetsResponse Source #
Instance details Defined in Amazonka.EC2.DescribeFleets Associated Types type Rep DescribeFleetsResponse :: Type -> Type # Methods from :: DescribeFleetsResponse -> Rep DescribeFleetsResponse x # to :: Rep DescribeFleetsResponse x -> DescribeFleetsResponse #
Read DescribeFleetsResponse Source #
Instance details Defined in Amazonka.EC2.DescribeFleets Methods readsPrec :: Int -> ReadS DescribeFleetsResponse # readList :: ReadS [DescribeFleetsResponse] # readPrec :: ReadPrec DescribeFleetsResponse # readListPrec :: ReadPrec [DescribeFleetsResponse] #
Show DescribeFleetsResponse Source #
Instance details Defined in Amazonka.EC2.DescribeFleets Methods showsPrec :: Int -> DescribeFleetsResponse -> ShowS # show :: DescribeFleetsResponse -> String # showList :: [DescribeFleetsResponse] -> ShowS #
NFData DescribeFleetsResponse Source #
Instance details Defined in Amazonka.EC2.DescribeFleets Methods rnf :: DescribeFleetsResponse -> () #
Eq DescribeFleetsResponse Source #
Instance details Defined in Amazonka.EC2.DescribeFleets Methods (==) :: DescribeFleetsResponse -> DescribeFleetsResponse -> Bool # (/=) :: DescribeFleetsResponse -> DescribeFleetsResponse -> Bool #
type Rep DescribeFleetsResponse Source #
Instance details Defined in Amazonka.EC2.DescribeFleets type Rep DescribeFleetsResponse = D1 ('MetaData "DescribeFleetsResponse" "Amazonka.EC2.DescribeFleets" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "DescribeFleetsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fleets") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [FleetData])) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeFleetsResponse Source #

Arguments

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

Create a value of DescribeFleetsResponse 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:fleets:DescribeFleetsResponse', describeFleetsResponse_fleets - Information about the EC2 Fleets.

DescribeFleets, describeFleetsResponse_nextToken - The token for the next set of results.

$sel:httpStatus:DescribeFleetsResponse', describeFleetsResponse_httpStatus - The response's http status code.

Response Lenses

describeFleetsResponse_fleets :: Lens' DescribeFleetsResponse (Maybe [FleetData]) Source #

Information about the EC2 Fleets.

describeFleetsResponse_nextToken :: Lens' DescribeFleetsResponse (Maybe Text) Source #

The token for the next set of results.

describeFleetsResponse_httpStatus :: Lens' DescribeFleetsResponse Int Source #

The response's http status code.