libZSservicesZSamazonka-gameliftZSamazonka-gamelift
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.GameLift.DescribeRuntimeConfiguration

Description

Retrieves a fleet's runtime configuration settings. The runtime configuration tells GameLift which server processes to run (and how) on each instance in the fleet.

To get the runtime configuration that is currently in forces for a fleet, provide the fleet ID.

If successful, a RuntimeConfiguration object is returned for the requested fleet. If the requested fleet has been deleted, the result set is empty.

Learn more

Setting up GameLift fleets

Running multiple processes on a fleet

Related actions

ListFleets | DescribeEC2InstanceLimits | DescribeFleetAttributes | DescribeFleetCapacity | DescribeFleetEvents | DescribeFleetLocationAttributes | DescribeFleetPortSettings | DescribeFleetUtilization | DescribeRuntimeConfiguration | DescribeScalingPolicies | All APIs by task

Synopsis

Creating a Request

data DescribeRuntimeConfiguration Source #

Represents the input for a request operation.

See: newDescribeRuntimeConfiguration smart constructor.

Constructors

DescribeRuntimeConfiguration' 

Fields

  • fleetId :: Text

    A unique identifier for the fleet to get the runtime configuration for. You can use either the fleet ID or ARN value.

Instances

Instances details
Eq DescribeRuntimeConfiguration Source # 
Instance details

Defined in Amazonka.GameLift.DescribeRuntimeConfiguration

Methods

(==) :: DescribeRuntimeConfiguration -> DescribeRuntimeConfiguration -> Bool #

(/=) :: DescribeRuntimeConfiguration -> DescribeRuntimeConfiguration -> Bool #

Read DescribeRuntimeConfiguration Source # 
Instance details

Defined in Amazonka.GameLift.DescribeRuntimeConfiguration

Methods

readsPrec :: Int -> ReadS DescribeRuntimeConfiguration #

readList :: ReadS [DescribeRuntimeConfiguration] #

readPrec :: ReadPrec DescribeRuntimeConfiguration #

readListPrec :: ReadPrec [DescribeRuntimeConfiguration] #

Show DescribeRuntimeConfiguration Source # 
Instance details

Defined in Amazonka.GameLift.DescribeRuntimeConfiguration

Methods

showsPrec :: Int -> DescribeRuntimeConfiguration -> ShowS #

show :: DescribeRuntimeConfiguration -> String #

showList :: [DescribeRuntimeConfiguration] -> ShowS #

Generic DescribeRuntimeConfiguration Source # 
Instance details

Defined in Amazonka.GameLift.DescribeRuntimeConfiguration

Associated Types

type Rep DescribeRuntimeConfiguration :: Type -> Type #

Methods

from :: DescribeRuntimeConfiguration -> Rep DescribeRuntimeConfiguration x #

to :: Rep DescribeRuntimeConfiguration x -> DescribeRuntimeConfiguration #

NFData DescribeRuntimeConfiguration Source # 
Instance details

Defined in Amazonka.GameLift.DescribeRuntimeConfiguration

Methods

rnf :: DescribeRuntimeConfiguration -> () #

Hashable DescribeRuntimeConfiguration Source # 
Instance details

Defined in Amazonka.GameLift.DescribeRuntimeConfiguration

Methods

hashWithSalt :: Int -> DescribeRuntimeConfiguration -> Int #

hash :: DescribeRuntimeConfiguration -> Int #

ToJSON DescribeRuntimeConfiguration Source # 
Instance details

Defined in Amazonka.GameLift.DescribeRuntimeConfiguration

Methods

toJSON :: DescribeRuntimeConfiguration -> Value #

toEncoding :: DescribeRuntimeConfiguration -> Encoding #

toJSONList :: [DescribeRuntimeConfiguration] -> Value #

toEncodingList :: [DescribeRuntimeConfiguration] -> Encoding #

AWSRequest DescribeRuntimeConfiguration Source # 
Instance details

Defined in Amazonka.GameLift.DescribeRuntimeConfiguration

Associated Types

type AWSResponse DescribeRuntimeConfiguration #

Methods

request :: DescribeRuntimeConfiguration -> Request DescribeRuntimeConfiguration #

response :: MonadResource m => Logger -> Service -> Proxy DescribeRuntimeConfiguration -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeRuntimeConfiguration))) #

ToHeaders DescribeRuntimeConfiguration Source # 
Instance details

Defined in Amazonka.GameLift.DescribeRuntimeConfiguration

Methods

toHeaders :: DescribeRuntimeConfiguration -> [Header] #

ToPath DescribeRuntimeConfiguration Source # 
Instance details

Defined in Amazonka.GameLift.DescribeRuntimeConfiguration

Methods

toPath :: DescribeRuntimeConfiguration -> ByteString #

ToQuery DescribeRuntimeConfiguration Source # 
Instance details

Defined in Amazonka.GameLift.DescribeRuntimeConfiguration

Methods

toQuery :: DescribeRuntimeConfiguration -> QueryString #

type Rep DescribeRuntimeConfiguration Source # 
Instance details

Defined in Amazonka.GameLift.DescribeRuntimeConfiguration

type Rep DescribeRuntimeConfiguration = D1 ('MetaData "DescribeRuntimeConfiguration" "Amazonka.GameLift.DescribeRuntimeConfiguration" "libZSservicesZSamazonka-gameliftZSamazonka-gamelift" 'False) (C1 ('MetaCons "DescribeRuntimeConfiguration'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fleetId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse DescribeRuntimeConfiguration Source # 
Instance details

Defined in Amazonka.GameLift.DescribeRuntimeConfiguration

type AWSResponse DescribeRuntimeConfiguration = DescribeRuntimeConfigurationResponse

newDescribeRuntimeConfiguration Source #

Arguments

:: Text

$sel:fleetId:DescribeRuntimeConfiguration'

-> DescribeRuntimeConfiguration 

Create a value of DescribeRuntimeConfiguration 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:fleetId:DescribeRuntimeConfiguration', describeRuntimeConfiguration_fleetId - A unique identifier for the fleet to get the runtime configuration for. You can use either the fleet ID or ARN value.

Request Lenses

describeRuntimeConfiguration_fleetId :: Lens' DescribeRuntimeConfiguration Text Source #

A unique identifier for the fleet to get the runtime configuration for. You can use either the fleet ID or ARN value.

Destructuring the Response

data DescribeRuntimeConfigurationResponse Source #

Represents the returned data in response to a request operation.

See: newDescribeRuntimeConfigurationResponse smart constructor.

Constructors

DescribeRuntimeConfigurationResponse' 

Fields

Instances

Instances details
Eq DescribeRuntimeConfigurationResponse Source # 
Instance details

Defined in Amazonka.GameLift.DescribeRuntimeConfiguration

Methods

(==) :: DescribeRuntimeConfigurationResponse -> DescribeRuntimeConfigurationResponse -> Bool #

(/=) :: DescribeRuntimeConfigurationResponse -> DescribeRuntimeConfigurationResponse -> Bool #

Read DescribeRuntimeConfigurationResponse Source # 
Instance details

Defined in Amazonka.GameLift.DescribeRuntimeConfiguration

Methods

readsPrec :: Int -> ReadS DescribeRuntimeConfigurationResponse #

readList :: ReadS [DescribeRuntimeConfigurationResponse] #

readPrec :: ReadPrec DescribeRuntimeConfigurationResponse #

readListPrec :: ReadPrec [DescribeRuntimeConfigurationResponse] #

Show DescribeRuntimeConfigurationResponse Source # 
Instance details

Defined in Amazonka.GameLift.DescribeRuntimeConfiguration

Methods

showsPrec :: Int -> DescribeRuntimeConfigurationResponse -> ShowS #

show :: DescribeRuntimeConfigurationResponse -> String #

showList :: [DescribeRuntimeConfigurationResponse] -> ShowS #

Generic DescribeRuntimeConfigurationResponse Source # 
Instance details

Defined in Amazonka.GameLift.DescribeRuntimeConfiguration

Associated Types

type Rep DescribeRuntimeConfigurationResponse :: Type -> Type #

Methods

from :: DescribeRuntimeConfigurationResponse -> Rep DescribeRuntimeConfigurationResponse x #

to :: Rep DescribeRuntimeConfigurationResponse x -> DescribeRuntimeConfigurationResponse #

NFData DescribeRuntimeConfigurationResponse Source # 
Instance details

Defined in Amazonka.GameLift.DescribeRuntimeConfiguration

Methods

rnf :: DescribeRuntimeConfigurationResponse -> () #

type Rep DescribeRuntimeConfigurationResponse Source # 
Instance details

Defined in Amazonka.GameLift.DescribeRuntimeConfiguration

type Rep DescribeRuntimeConfigurationResponse = D1 ('MetaData "DescribeRuntimeConfigurationResponse" "Amazonka.GameLift.DescribeRuntimeConfiguration" "libZSservicesZSamazonka-gameliftZSamazonka-gamelift" 'False) (C1 ('MetaCons "DescribeRuntimeConfigurationResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "runtimeConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RuntimeConfiguration)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newDescribeRuntimeConfigurationResponse Source #

Arguments

:: Int

$sel:httpStatus:DescribeRuntimeConfigurationResponse'

-> DescribeRuntimeConfigurationResponse 

Create a value of DescribeRuntimeConfigurationResponse 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:runtimeConfiguration:DescribeRuntimeConfigurationResponse', describeRuntimeConfigurationResponse_runtimeConfiguration - Instructions that describe how server processes should be launched and maintained on each instance in the fleet.

$sel:httpStatus:DescribeRuntimeConfigurationResponse', describeRuntimeConfigurationResponse_httpStatus - The response's http status code.

Response Lenses

describeRuntimeConfigurationResponse_runtimeConfiguration :: Lens' DescribeRuntimeConfigurationResponse (Maybe RuntimeConfiguration) Source #

Instructions that describe how server processes should be launched and maintained on each instance in the fleet.

describeRuntimeConfigurationResponse_httpStatus :: Lens' DescribeRuntimeConfigurationResponse Int Source #

The response's http status code.