Amazonka.GameLift.DescribeFleetLocationCapacity

Retrieves the resource capacity settings for a fleet location. The data returned includes the current capacity (number of EC2 instances) and some scaling settings for the requested fleet location. Use this operation to retrieve capacity information for a fleet's remote location or home Region (you can also retrieve home Region capacity by calling DescribeFleetCapacity).

To retrieve capacity data, identify a fleet and location.

If successful, a FleetCapacity object is returned for the requested fleet location.

Learn more

Setting up GameLift fleets

GameLift metrics for fleets

Creating a Request

data DescribeFleetLocationCapacity

See: newDescribeFleetLocationCapacity smart constructor.

Constructors

DescribeFleetLocationCapacity'

Fields

• fleetId :: Text

  A unique identifier for the fleet to request location capacity for. You can use either the fleet ID or ARN value.

• location :: Text

  The fleet location to retrieve capacity information for. Specify a location in the form of an Amazon Web Services Region code, such as us-west-2.

Instances

ToJSON DescribeFleetLocationCapacity

Defined in Amazonka.GameLift.DescribeFleetLocationCapacity

Methods

toJSON :: DescribeFleetLocationCapacity -> Value

toEncoding :: DescribeFleetLocationCapacity -> Encoding

toJSONList :: [DescribeFleetLocationCapacity] -> Value

toEncodingList :: [DescribeFleetLocationCapacity] -> Encoding

ToHeaders DescribeFleetLocationCapacity

Defined in Amazonka.GameLift.DescribeFleetLocationCapacity

Methods

toHeaders :: DescribeFleetLocationCapacity -> [Header]

ToPath DescribeFleetLocationCapacity

Defined in Amazonka.GameLift.DescribeFleetLocationCapacity

Methods

toPath :: DescribeFleetLocationCapacity -> ByteString

ToQuery DescribeFleetLocationCapacity

Defined in Amazonka.GameLift.DescribeFleetLocationCapacity

Methods

toQuery :: DescribeFleetLocationCapacity -> QueryString

AWSRequest DescribeFleetLocationCapacity

Defined in Amazonka.GameLift.DescribeFleetLocationCapacity

Associated Types

type AWSResponse DescribeFleetLocationCapacity

Methods

request :: (Service -> Service) -> DescribeFleetLocationCapacity -> Request DescribeFleetLocationCapacity

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeFleetLocationCapacity -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeFleetLocationCapacity)))

Generic DescribeFleetLocationCapacity

Defined in Amazonka.GameLift.DescribeFleetLocationCapacity

Associated Types

type Rep DescribeFleetLocationCapacity :: Type -> Type

Methods

from :: DescribeFleetLocationCapacity -> Rep DescribeFleetLocationCapacity x

to :: Rep DescribeFleetLocationCapacity x -> DescribeFleetLocationCapacity

Read DescribeFleetLocationCapacity

Defined in Amazonka.GameLift.DescribeFleetLocationCapacity

Methods

readsPrec :: Int -> ReadS DescribeFleetLocationCapacity

readList :: ReadS [DescribeFleetLocationCapacity]

readPrec :: ReadPrec DescribeFleetLocationCapacity

readListPrec :: ReadPrec [DescribeFleetLocationCapacity]

Show DescribeFleetLocationCapacity

Defined in Amazonka.GameLift.DescribeFleetLocationCapacity

Methods

showsPrec :: Int -> DescribeFleetLocationCapacity -> ShowS

show :: DescribeFleetLocationCapacity -> String

showList :: [DescribeFleetLocationCapacity] -> ShowS

NFData DescribeFleetLocationCapacity

Defined in Amazonka.GameLift.DescribeFleetLocationCapacity

Methods

rnf :: DescribeFleetLocationCapacity -> ()

Eq DescribeFleetLocationCapacity

Defined in Amazonka.GameLift.DescribeFleetLocationCapacity

Methods

(==) :: DescribeFleetLocationCapacity -> DescribeFleetLocationCapacity -> Bool

(/=) :: DescribeFleetLocationCapacity -> DescribeFleetLocationCapacity -> Bool

Hashable DescribeFleetLocationCapacity

Defined in Amazonka.GameLift.DescribeFleetLocationCapacity

Methods

hashWithSalt :: Int -> DescribeFleetLocationCapacity -> Int

hash :: DescribeFleetLocationCapacity -> Int

type AWSResponse DescribeFleetLocationCapacity

Defined in Amazonka.GameLift.DescribeFleetLocationCapacity

type AWSResponse DescribeFleetLocationCapacity = DescribeFleetLocationCapacityResponse

type Rep DescribeFleetLocationCapacity

Defined in Amazonka.GameLift.DescribeFleetLocationCapacity

type Rep DescribeFleetLocationCapacity = D1 ('MetaData "DescribeFleetLocationCapacity" "Amazonka.GameLift.DescribeFleetLocationCapacity" "amazonka-gamelift-2.0-IjhNQby9jLV6gj30IrgsyK" 'False) (C1 ('MetaCons "DescribeFleetLocationCapacity'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fleetId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "location") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDescribeFleetLocationCapacity

Arguments

:: Text

DescribeFleetLocationCapacity

-> Text

DescribeFleetLocationCapacity

-> DescribeFleetLocationCapacity

Create a value of DescribeFleetLocationCapacity 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:

DescribeFleetLocationCapacity, describeFleetLocationCapacity_fleetId - A unique identifier for the fleet to request location capacity for. You can use either the fleet ID or ARN value.

DescribeFleetLocationCapacity, describeFleetLocationCapacity_location - The fleet location to retrieve capacity information for. Specify a location in the form of an Amazon Web Services Region code, such as us-west-2.

Request Lenses

describeFleetLocationCapacity_fleetId :: Lens' DescribeFleetLocationCapacity Text

A unique identifier for the fleet to request location capacity for. You can use either the fleet ID or ARN value.

describeFleetLocationCapacity_location :: Lens' DescribeFleetLocationCapacity Text

The fleet location to retrieve capacity information for. Specify a location in the form of an Amazon Web Services Region code, such as us-west-2.

Destructuring the Response

data DescribeFleetLocationCapacityResponse

See: newDescribeFleetLocationCapacityResponse smart constructor.

Constructors

DescribeFleetLocationCapacityResponse'

Fields

• fleetCapacity :: Maybe FleetCapacity

  Resource capacity information for the requested fleet location. Capacity objects are returned only for fleets and locations that currently exist.

• httpStatus :: Int

  The response's http status code.

Instances

Generic DescribeFleetLocationCapacityResponse

Defined in Amazonka.GameLift.DescribeFleetLocationCapacity

Associated Types

type Rep DescribeFleetLocationCapacityResponse :: Type -> Type

Methods

from :: DescribeFleetLocationCapacityResponse -> Rep DescribeFleetLocationCapacityResponse x

to :: Rep DescribeFleetLocationCapacityResponse x -> DescribeFleetLocationCapacityResponse

Read DescribeFleetLocationCapacityResponse

Defined in Amazonka.GameLift.DescribeFleetLocationCapacity

Methods

readsPrec :: Int -> ReadS DescribeFleetLocationCapacityResponse

readList :: ReadS [DescribeFleetLocationCapacityResponse]

readPrec :: ReadPrec DescribeFleetLocationCapacityResponse

readListPrec :: ReadPrec [DescribeFleetLocationCapacityResponse]

Show DescribeFleetLocationCapacityResponse

Defined in Amazonka.GameLift.DescribeFleetLocationCapacity

Methods

showsPrec :: Int -> DescribeFleetLocationCapacityResponse -> ShowS

show :: DescribeFleetLocationCapacityResponse -> String

showList :: [DescribeFleetLocationCapacityResponse] -> ShowS

NFData DescribeFleetLocationCapacityResponse

Defined in Amazonka.GameLift.DescribeFleetLocationCapacity

Methods

rnf :: DescribeFleetLocationCapacityResponse -> ()

Eq DescribeFleetLocationCapacityResponse

Defined in Amazonka.GameLift.DescribeFleetLocationCapacity

Methods

(==) :: DescribeFleetLocationCapacityResponse -> DescribeFleetLocationCapacityResponse -> Bool

(/=) :: DescribeFleetLocationCapacityResponse -> DescribeFleetLocationCapacityResponse -> Bool

type Rep DescribeFleetLocationCapacityResponse

Defined in Amazonka.GameLift.DescribeFleetLocationCapacity

type Rep DescribeFleetLocationCapacityResponse = D1 ('MetaData "DescribeFleetLocationCapacityResponse" "Amazonka.GameLift.DescribeFleetLocationCapacity" "amazonka-gamelift-2.0-IjhNQby9jLV6gj30IrgsyK" 'False) (C1 ('MetaCons "DescribeFleetLocationCapacityResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fleetCapacity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe FleetCapacity)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newDescribeFleetLocationCapacityResponse

Arguments

:: Int

$sel:httpStatus:DescribeFleetLocationCapacityResponse'

-> DescribeFleetLocationCapacityResponse

Create a value of DescribeFleetLocationCapacityResponse 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:fleetCapacity:DescribeFleetLocationCapacityResponse', describeFleetLocationCapacityResponse_fleetCapacity - Resource capacity information for the requested fleet location. Capacity objects are returned only for fleets and locations that currently exist.

$sel:httpStatus:DescribeFleetLocationCapacityResponse', describeFleetLocationCapacityResponse_httpStatus - The response's http status code.

Response Lenses

describeFleetLocationCapacityResponse_fleetCapacity :: Lens' DescribeFleetLocationCapacityResponse (Maybe FleetCapacity)

Resource capacity information for the requested fleet location. Capacity objects are returned only for fleets and locations that currently exist.

describeFleetLocationCapacityResponse_httpStatus :: Lens' DescribeFleetLocationCapacityResponse Int

The response's http status code.