Amazonka.GameLift.StopFleetActions

Suspends certain types of activity in a fleet location. Currently, this operation is used to stop auto-scaling activity. For multi-location fleets, fleet actions are managed separately for each location.

Stopping fleet actions has several potential purposes. It allows you to temporarily stop auto-scaling activity but retain your scaling policies for use in the future. For multi-location fleets, you can set up fleet-wide auto-scaling, and then opt out of it for certain locations.

This operation can be used in the following ways:

• To stop actions on instances in the fleet's home Region, provide a fleet ID and the type of actions to suspend.
• To stop actions on instances in one of the fleet's remote locations, provide a fleet ID, a location name, and the type of actions to suspend.

If successful, GameLift no longer initiates scaling events except in response to manual changes using UpdateFleetCapacity.

Learn more

Setting up GameLift Fleets

Creating a Request

data StopFleetActions

See: newStopFleetActions smart constructor.

Constructors

StopFleetActions'

Fields

• location :: Maybe Text

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

• fleetId :: Text

  A unique identifier for the fleet to stop actions on. You can use either the fleet ID or ARN value.

• actions :: NonEmpty FleetAction

  List of actions to suspend on the fleet.

Instances

ToJSON StopFleetActions

Defined in Amazonka.GameLift.StopFleetActions

Methods

toJSON :: StopFleetActions -> Value

toEncoding :: StopFleetActions -> Encoding

toJSONList :: [StopFleetActions] -> Value

toEncodingList :: [StopFleetActions] -> Encoding

ToHeaders StopFleetActions

Defined in Amazonka.GameLift.StopFleetActions

Methods

toHeaders :: StopFleetActions -> [Header]

ToPath StopFleetActions

Defined in Amazonka.GameLift.StopFleetActions

Methods

toPath :: StopFleetActions -> ByteString

ToQuery StopFleetActions

Defined in Amazonka.GameLift.StopFleetActions

Methods

toQuery :: StopFleetActions -> QueryString

AWSRequest StopFleetActions

Defined in Amazonka.GameLift.StopFleetActions

Associated Types

type AWSResponse StopFleetActions

Methods

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

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

Generic StopFleetActions

Defined in Amazonka.GameLift.StopFleetActions

Associated Types

type Rep StopFleetActions :: Type -> Type

Methods

from :: StopFleetActions -> Rep StopFleetActions x

to :: Rep StopFleetActions x -> StopFleetActions

Read StopFleetActions

Defined in Amazonka.GameLift.StopFleetActions

Methods

readsPrec :: Int -> ReadS StopFleetActions

readList :: ReadS [StopFleetActions]

readPrec :: ReadPrec StopFleetActions

readListPrec :: ReadPrec [StopFleetActions]

Show StopFleetActions

Defined in Amazonka.GameLift.StopFleetActions

Methods

showsPrec :: Int -> StopFleetActions -> ShowS

show :: StopFleetActions -> String

showList :: [StopFleetActions] -> ShowS

NFData StopFleetActions

Defined in Amazonka.GameLift.StopFleetActions

Methods

rnf :: StopFleetActions -> ()

Eq StopFleetActions

Defined in Amazonka.GameLift.StopFleetActions

Methods

(==) :: StopFleetActions -> StopFleetActions -> Bool

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

Hashable StopFleetActions

Defined in Amazonka.GameLift.StopFleetActions

Methods

hashWithSalt :: Int -> StopFleetActions -> Int

hash :: StopFleetActions -> Int

type AWSResponse StopFleetActions

Defined in Amazonka.GameLift.StopFleetActions

type AWSResponse StopFleetActions = StopFleetActionsResponse

type Rep StopFleetActions

Defined in Amazonka.GameLift.StopFleetActions

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

newStopFleetActions

Arguments

:: Text

StopFleetActions

-> NonEmpty FleetAction

$sel:actions:StopFleetActions'

-> StopFleetActions

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

StopFleetActions, stopFleetActions_location - The fleet location to stop fleet actions for. Specify a location in the form of an Amazon Web Services Region code, such as us-west-2.

StopFleetActions, stopFleetActions_fleetId - A unique identifier for the fleet to stop actions on. You can use either the fleet ID or ARN value.

$sel:actions:StopFleetActions', stopFleetActions_actions - List of actions to suspend on the fleet.

Request Lenses

stopFleetActions_location :: Lens' StopFleetActions (Maybe Text)

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

stopFleetActions_fleetId :: Lens' StopFleetActions Text

A unique identifier for the fleet to stop actions on. You can use either the fleet ID or ARN value.

stopFleetActions_actions :: Lens' StopFleetActions (NonEmpty FleetAction)

List of actions to suspend on the fleet.

Destructuring the Response

data StopFleetActionsResponse

See: newStopFleetActionsResponse smart constructor.

Constructors

StopFleetActionsResponse'

Fields

• fleetArn :: Maybe Text

  The Amazon Resource Name (ARN) that is assigned to a GameLift fleet resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912.

• fleetId :: Maybe Text

  A unique identifier for the fleet to stop actions on.

• httpStatus :: Int

  The response's http status code.

Instances

Generic StopFleetActionsResponse

Defined in Amazonka.GameLift.StopFleetActions

Associated Types

type Rep StopFleetActionsResponse :: Type -> Type

Methods

from :: StopFleetActionsResponse -> Rep StopFleetActionsResponse x

to :: Rep StopFleetActionsResponse x -> StopFleetActionsResponse

Read StopFleetActionsResponse

Defined in Amazonka.GameLift.StopFleetActions

Methods

readsPrec :: Int -> ReadS StopFleetActionsResponse

readList :: ReadS [StopFleetActionsResponse]

readPrec :: ReadPrec StopFleetActionsResponse

readListPrec :: ReadPrec [StopFleetActionsResponse]

Show StopFleetActionsResponse

Defined in Amazonka.GameLift.StopFleetActions

Methods

showsPrec :: Int -> StopFleetActionsResponse -> ShowS

show :: StopFleetActionsResponse -> String

showList :: [StopFleetActionsResponse] -> ShowS

NFData StopFleetActionsResponse

Defined in Amazonka.GameLift.StopFleetActions

Methods

rnf :: StopFleetActionsResponse -> ()

Eq StopFleetActionsResponse

Defined in Amazonka.GameLift.StopFleetActions

Methods

(==) :: StopFleetActionsResponse -> StopFleetActionsResponse -> Bool

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

type Rep StopFleetActionsResponse

Defined in Amazonka.GameLift.StopFleetActions

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

newStopFleetActionsResponse

Arguments

:: Int

$sel:httpStatus:StopFleetActionsResponse'

-> StopFleetActionsResponse

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

StopFleetActionsResponse, stopFleetActionsResponse_fleetArn - The Amazon Resource Name (ARN) that is assigned to a GameLift fleet resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912.

StopFleetActions, stopFleetActionsResponse_fleetId - A unique identifier for the fleet to stop actions on.

$sel:httpStatus:StopFleetActionsResponse', stopFleetActionsResponse_httpStatus - The response's http status code.

Response Lenses

stopFleetActionsResponse_fleetArn :: Lens' StopFleetActionsResponse (Maybe Text)

The Amazon Resource Name (ARN) that is assigned to a GameLift fleet resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912.

stopFleetActionsResponse_fleetId :: Lens' StopFleetActionsResponse (Maybe Text)

A unique identifier for the fleet to stop actions on.

stopFleetActionsResponse_httpStatus :: Lens' StopFleetActionsResponse Int

The response's http status code.