amazonka-gamelift-2.0: Amazon GameLift 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.GameLift.DeleteFleet

Description

Deletes all resources and information related a fleet. Any current fleet instances, including those in remote locations, are shut down. You don't need to call DeleteFleetLocations separately.

If the fleet being deleted has a VPC peering connection, you first need to get a valid authorization (good for 24 hours) by calling CreateVpcPeeringAuthorization. You do not need to explicitly delete the VPC peering connection.

To delete a fleet, specify the fleet ID to be terminated. During the deletion process the fleet status is changed to DELETING. When completed, the status switches to TERMINATED and the fleet event FLEET_DELETED is sent.

Learn more

Setting up GameLift Fleets

Synopsis

Creating a Request

data DeleteFleet Source #

See: newDeleteFleet smart constructor.

Constructors

DeleteFleet' 

Fields

  • fleetId :: Text

    A unique identifier for the fleet to be deleted. You can use either the fleet ID or ARN value.

Instances

Instances details
ToJSON DeleteFleet Source # 
Instance details

Defined in Amazonka.GameLift.DeleteFleet

ToHeaders DeleteFleet Source # 
Instance details

Defined in Amazonka.GameLift.DeleteFleet

Methods

toHeaders :: DeleteFleet -> [Header] #

ToPath DeleteFleet Source # 
Instance details

Defined in Amazonka.GameLift.DeleteFleet

ToQuery DeleteFleet Source # 
Instance details

Defined in Amazonka.GameLift.DeleteFleet

AWSRequest DeleteFleet Source # 
Instance details

Defined in Amazonka.GameLift.DeleteFleet

Associated Types

type AWSResponse DeleteFleet #

Generic DeleteFleet Source # 
Instance details

Defined in Amazonka.GameLift.DeleteFleet

Associated Types

type Rep DeleteFleet :: Type -> Type #

Read DeleteFleet Source # 
Instance details

Defined in Amazonka.GameLift.DeleteFleet

Show DeleteFleet Source # 
Instance details

Defined in Amazonka.GameLift.DeleteFleet

NFData DeleteFleet Source # 
Instance details

Defined in Amazonka.GameLift.DeleteFleet

Methods

rnf :: DeleteFleet -> () #

Eq DeleteFleet Source # 
Instance details

Defined in Amazonka.GameLift.DeleteFleet

Hashable DeleteFleet Source # 
Instance details

Defined in Amazonka.GameLift.DeleteFleet

type AWSResponse DeleteFleet Source # 
Instance details

Defined in Amazonka.GameLift.DeleteFleet

type Rep DeleteFleet Source # 
Instance details

Defined in Amazonka.GameLift.DeleteFleet

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

newDeleteFleet Source #

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

DeleteFleet, deleteFleet_fleetId - A unique identifier for the fleet to be deleted. You can use either the fleet ID or ARN value.

Request Lenses

deleteFleet_fleetId :: Lens' DeleteFleet Text Source #

A unique identifier for the fleet to be deleted. You can use either the fleet ID or ARN value.

Destructuring the Response

data DeleteFleetResponse Source #

See: newDeleteFleetResponse smart constructor.

Constructors

DeleteFleetResponse' 

newDeleteFleetResponse :: DeleteFleetResponse Source #

Create a value of DeleteFleetResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.