amazonka-ec2-2.0: Amazon Elastic Compute Cloud SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.EC2.DescribeCapacityReservationFleets

Description

Describes one or more Capacity Reservation Fleets.

This operation returns paginated results.

Synopsis

Creating a Request

data DescribeCapacityReservationFleets Source #

See: newDescribeCapacityReservationFleets smart constructor.

Constructors

DescribeCapacityReservationFleets' 

Fields

  • capacityReservationFleetIds :: Maybe [Text]

    The IDs of the Capacity Reservation Fleets to describe.

  • 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]

    One or more filters.

    • state - The state of the Fleet (submitted | modifying | active | partially_fulfilled | expiring | expired | cancelling | cancelled | failed).
    • instance-match-criteria - The instance matching criteria for the Fleet. Only open is supported.
    • tenancy - The tenancy of the Fleet (default | dedicated).
    • allocation-strategy - The allocation strategy used by the Fleet. Only prioritized is supported.
  • maxResults :: Maybe Natural

    The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the returned nextToken value. This value can be between 5 and 500. If maxResults is given a larger value than 500, you receive an error.

  • nextToken :: Maybe Text

    The token to use to retrieve the next page of results.

Instances

Instances details
ToHeaders DescribeCapacityReservationFleets Source # 
Instance details

Defined in Amazonka.EC2.DescribeCapacityReservationFleets

ToPath DescribeCapacityReservationFleets Source # 
Instance details

Defined in Amazonka.EC2.DescribeCapacityReservationFleets

ToQuery DescribeCapacityReservationFleets Source # 
Instance details

Defined in Amazonka.EC2.DescribeCapacityReservationFleets

AWSPager DescribeCapacityReservationFleets Source # 
Instance details

Defined in Amazonka.EC2.DescribeCapacityReservationFleets

AWSRequest DescribeCapacityReservationFleets Source # 
Instance details

Defined in Amazonka.EC2.DescribeCapacityReservationFleets

Generic DescribeCapacityReservationFleets Source # 
Instance details

Defined in Amazonka.EC2.DescribeCapacityReservationFleets

Associated Types

type Rep DescribeCapacityReservationFleets :: Type -> Type #

Read DescribeCapacityReservationFleets Source # 
Instance details

Defined in Amazonka.EC2.DescribeCapacityReservationFleets

Show DescribeCapacityReservationFleets Source # 
Instance details

Defined in Amazonka.EC2.DescribeCapacityReservationFleets

NFData DescribeCapacityReservationFleets Source # 
Instance details

Defined in Amazonka.EC2.DescribeCapacityReservationFleets

Eq DescribeCapacityReservationFleets Source # 
Instance details

Defined in Amazonka.EC2.DescribeCapacityReservationFleets

Hashable DescribeCapacityReservationFleets Source # 
Instance details

Defined in Amazonka.EC2.DescribeCapacityReservationFleets

type AWSResponse DescribeCapacityReservationFleets Source # 
Instance details

Defined in Amazonka.EC2.DescribeCapacityReservationFleets

type Rep DescribeCapacityReservationFleets Source # 
Instance details

Defined in Amazonka.EC2.DescribeCapacityReservationFleets

type Rep DescribeCapacityReservationFleets = D1 ('MetaData "DescribeCapacityReservationFleets" "Amazonka.EC2.DescribeCapacityReservationFleets" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "DescribeCapacityReservationFleets'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "capacityReservationFleetIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "dryRun") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :*: (S1 ('MetaSel ('Just "filters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Filter])) :*: (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

newDescribeCapacityReservationFleets :: DescribeCapacityReservationFleets Source #

Create a value of DescribeCapacityReservationFleets 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:capacityReservationFleetIds:DescribeCapacityReservationFleets', describeCapacityReservationFleets_capacityReservationFleetIds - The IDs of the Capacity Reservation Fleets to describe.

$sel:dryRun:DescribeCapacityReservationFleets', describeCapacityReservationFleets_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:DescribeCapacityReservationFleets', describeCapacityReservationFleets_filters - One or more filters.

  • state - The state of the Fleet (submitted | modifying | active | partially_fulfilled | expiring | expired | cancelling | cancelled | failed).
  • instance-match-criteria - The instance matching criteria for the Fleet. Only open is supported.
  • tenancy - The tenancy of the Fleet (default | dedicated).
  • allocation-strategy - The allocation strategy used by the Fleet. Only prioritized is supported.

$sel:maxResults:DescribeCapacityReservationFleets', describeCapacityReservationFleets_maxResults - The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the returned nextToken value. This value can be between 5 and 500. If maxResults is given a larger value than 500, you receive an error.

DescribeCapacityReservationFleets, describeCapacityReservationFleets_nextToken - The token to use to retrieve the next page of results.

Request Lenses

describeCapacityReservationFleets_dryRun :: Lens' DescribeCapacityReservationFleets (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.

describeCapacityReservationFleets_filters :: Lens' DescribeCapacityReservationFleets (Maybe [Filter]) Source #

One or more filters.

  • state - The state of the Fleet (submitted | modifying | active | partially_fulfilled | expiring | expired | cancelling | cancelled | failed).
  • instance-match-criteria - The instance matching criteria for the Fleet. Only open is supported.
  • tenancy - The tenancy of the Fleet (default | dedicated).
  • allocation-strategy - The allocation strategy used by the Fleet. Only prioritized is supported.

describeCapacityReservationFleets_maxResults :: Lens' DescribeCapacityReservationFleets (Maybe Natural) Source #

The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the returned nextToken value. This value can be between 5 and 500. If maxResults is given a larger value than 500, you receive an error.

describeCapacityReservationFleets_nextToken :: Lens' DescribeCapacityReservationFleets (Maybe Text) Source #

The token to use to retrieve the next page of results.

Destructuring the Response

data DescribeCapacityReservationFleetsResponse Source #

Constructors

DescribeCapacityReservationFleetsResponse' 

Fields

Instances

Instances details
Generic DescribeCapacityReservationFleetsResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribeCapacityReservationFleets

Read DescribeCapacityReservationFleetsResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribeCapacityReservationFleets

Show DescribeCapacityReservationFleetsResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribeCapacityReservationFleets

NFData DescribeCapacityReservationFleetsResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribeCapacityReservationFleets

Eq DescribeCapacityReservationFleetsResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribeCapacityReservationFleets

type Rep DescribeCapacityReservationFleetsResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribeCapacityReservationFleets

type Rep DescribeCapacityReservationFleetsResponse = D1 ('MetaData "DescribeCapacityReservationFleetsResponse" "Amazonka.EC2.DescribeCapacityReservationFleets" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "DescribeCapacityReservationFleetsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "capacityReservationFleets") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [CapacityReservationFleet])) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeCapacityReservationFleetsResponse Source #

Create a value of DescribeCapacityReservationFleetsResponse 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:capacityReservationFleets:DescribeCapacityReservationFleetsResponse', describeCapacityReservationFleetsResponse_capacityReservationFleets - Information about the Capacity Reservation Fleets.

DescribeCapacityReservationFleets, describeCapacityReservationFleetsResponse_nextToken - The token to use to retrieve the next page of results. This value is null when there are no more results to return.

$sel:httpStatus:DescribeCapacityReservationFleetsResponse', describeCapacityReservationFleetsResponse_httpStatus - The response's http status code.

Response Lenses

describeCapacityReservationFleetsResponse_nextToken :: Lens' DescribeCapacityReservationFleetsResponse (Maybe Text) Source #

The token to use to retrieve the next page of results. This value is null when there are no more results to return.