GameLift / Client / delete_fleet

delete_fleet#

GameLift.Client.delete_fleet(**kwargs)#

Deletes all resources and information related to a fleet and shuts down any currently running fleet instances, including those in remote locations.

Note

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 don’t 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 emitted.

Learn more

Setting up Amazon GameLift Fleets

Request Syntax

response = client.delete_fleet(
    FleetId='string'
)

Parameters:

FleetId (string) –

[REQUIRED]

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

Returns:

None

Exceptions

GameLift.Client.exceptions.NotFoundException
GameLift.Client.exceptions.InternalServiceException
GameLift.Client.exceptions.InvalidFleetStatusException
GameLift.Client.exceptions.UnauthorizedException
GameLift.Client.exceptions.InvalidRequestException
GameLift.Client.exceptions.TaggingFailedException