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.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--this is done as part of the delete fleet process.

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

Related actions

CreateFleetLocations | UpdateFleetAttributes | UpdateFleetCapacity | UpdateFleetPortSettings | UpdateRuntimeConfiguration | StopFleetActions | StartFleetActions | PutScalingPolicy | DeleteFleet | DeleteFleetLocations | DeleteScalingPolicy | All APIs by task

Synopsis

Creating a Request

data DeleteFleet Source #

Represents the input for a request operation.

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
Eq DeleteFleet Source # 
Instance details

Defined in Amazonka.GameLift.DeleteFleet

Methods

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

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

Read DeleteFleet Source # 
Instance details

Defined in Amazonka.GameLift.DeleteFleet

Methods

readsPrec :: Int -> ReadS DeleteFleet #

readList :: ReadS [DeleteFleet] #

readPrec :: ReadPrec DeleteFleet #

readListPrec :: ReadPrec [DeleteFleet] #

Show DeleteFleet Source # 
Instance details

Defined in Amazonka.GameLift.DeleteFleet

Methods

showsPrec :: Int -> DeleteFleet -> ShowS #

show :: DeleteFleet -> String #

showList :: [DeleteFleet] -> ShowS #

Generic DeleteFleet Source # 
Instance details

Defined in Amazonka.GameLift.DeleteFleet

Associated Types

type Rep DeleteFleet :: Type -> Type #

Methods

from :: DeleteFleet -> Rep DeleteFleet x #

to :: Rep DeleteFleet x -> DeleteFleet #

NFData DeleteFleet Source # 
Instance details

Defined in Amazonka.GameLift.DeleteFleet

Methods

rnf :: DeleteFleet -> () #

Hashable DeleteFleet Source # 
Instance details

Defined in Amazonka.GameLift.DeleteFleet

Methods

hashWithSalt :: Int -> DeleteFleet -> Int #

hash :: DeleteFleet -> Int #

ToJSON DeleteFleet Source # 
Instance details

Defined in Amazonka.GameLift.DeleteFleet

Methods

toJSON :: DeleteFleet -> Value #

toEncoding :: DeleteFleet -> Encoding #

toJSONList :: [DeleteFleet] -> Value #

toEncodingList :: [DeleteFleet] -> Encoding #

AWSRequest DeleteFleet Source # 
Instance details

Defined in Amazonka.GameLift.DeleteFleet

Associated Types

type AWSResponse DeleteFleet #

Methods

request :: DeleteFleet -> Request DeleteFleet #

response :: MonadResource m => Logger -> Service -> Proxy DeleteFleet -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse 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

Methods

toPath :: DeleteFleet -> ByteString #

ToQuery DeleteFleet Source # 
Instance details

Defined in Amazonka.GameLift.DeleteFleet

Methods

toQuery :: DeleteFleet -> QueryString #

type Rep DeleteFleet Source # 
Instance details

Defined in Amazonka.GameLift.DeleteFleet

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

Defined in Amazonka.GameLift.DeleteFleet

type AWSResponse DeleteFleet = DeleteFleetResponse

newDeleteFleet Source #

Arguments

:: Text

$sel:fleetId:DeleteFleet'

-> DeleteFleet 

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:

$sel:fleetId: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' 

Instances

Instances details
Eq DeleteFleetResponse Source # 
Instance details

Defined in Amazonka.GameLift.DeleteFleet

Methods

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

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

Read DeleteFleetResponse Source # 
Instance details

Defined in Amazonka.GameLift.DeleteFleet

Methods

readsPrec :: Int -> ReadS DeleteFleetResponse #

readList :: ReadS [DeleteFleetResponse] #

readPrec :: ReadPrec DeleteFleetResponse #

readListPrec :: ReadPrec [DeleteFleetResponse] #

Show DeleteFleetResponse Source # 
Instance details

Defined in Amazonka.GameLift.DeleteFleet

Methods

showsPrec :: Int -> DeleteFleetResponse -> ShowS #

show :: DeleteFleetResponse -> String #

showList :: [DeleteFleetResponse] -> ShowS #

Generic DeleteFleetResponse Source # 
Instance details

Defined in Amazonka.GameLift.DeleteFleet

Associated Types

type Rep DeleteFleetResponse :: Type -> Type #

Methods

from :: DeleteFleetResponse -> Rep DeleteFleetResponse x #

to :: Rep DeleteFleetResponse x -> DeleteFleetResponse #

NFData DeleteFleetResponse Source # 
Instance details

Defined in Amazonka.GameLift.DeleteFleet

Methods

rnf :: DeleteFleetResponse -> () #

type Rep DeleteFleetResponse Source # 
Instance details

Defined in Amazonka.GameLift.DeleteFleet

type Rep DeleteFleetResponse = D1 ('MetaData "DeleteFleetResponse" "Amazonka.GameLift.DeleteFleet" "libZSservicesZSamazonka-gameliftZSamazonka-gamelift" 'False) (C1 ('MetaCons "DeleteFleetResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newDeleteFleetResponse :: DeleteFleetResponse Source #

Create a value of DeleteFleetResponse with all optional fields omitted.

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