Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.GameLift.DeleteFleetLocations

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Removes locations from a multi-location fleet. When deleting a location, all game server process and all instances that are still active in the location are shut down.

To delete fleet locations, identify the fleet ID and provide a list of the locations to be deleted.

If successful, GameLift sets the location status to DELETING, and begins to shut down existing server processes and terminate instances in each location being deleted. When completed, the location status changes to TERMINATED.

Learn more

Setting up GameLift fleets

Synopsis

data DeleteFleetLocations = DeleteFleetLocations' {
- fleetId :: Text
- locations :: NonEmpty Text
}
newDeleteFleetLocations :: Text -> NonEmpty Text -> DeleteFleetLocations
deleteFleetLocations_fleetId :: Lens' DeleteFleetLocations Text
deleteFleetLocations_locations :: Lens' DeleteFleetLocations (NonEmpty Text)
data DeleteFleetLocationsResponse = DeleteFleetLocationsResponse' {
- fleetArn :: Maybe Text
- fleetId :: Maybe Text
- locationStates :: Maybe [LocationState]
- httpStatus :: Int
}
newDeleteFleetLocationsResponse :: Int -> DeleteFleetLocationsResponse
deleteFleetLocationsResponse_fleetArn :: Lens' DeleteFleetLocationsResponse (Maybe Text)
deleteFleetLocationsResponse_fleetId :: Lens' DeleteFleetLocationsResponse (Maybe Text)
deleteFleetLocationsResponse_locationStates :: Lens' DeleteFleetLocationsResponse (Maybe [LocationState])
deleteFleetLocationsResponse_httpStatus :: Lens' DeleteFleetLocationsResponse Int

Creating a Request

data DeleteFleetLocations Source #

See: newDeleteFleetLocations smart constructor.

Constructors

DeleteFleetLocations'
Fields fleetId :: Text A unique identifier for the fleet to delete locations for. You can use either the fleet ID or ARN value. locations :: NonEmpty Text The list of fleet locations to delete. Specify locations in the form of an Amazon Web Services Region code, such as `us-west-2`.

Instances

Instances details

ToJSON DeleteFleetLocations Source #
Instance details Defined in Amazonka.GameLift.DeleteFleetLocations Methods toJSON :: DeleteFleetLocations -> Value # toEncoding :: DeleteFleetLocations -> Encoding # toJSONList :: [DeleteFleetLocations] -> Value # toEncodingList :: [DeleteFleetLocations] -> Encoding #
ToHeaders DeleteFleetLocations Source #
Instance details Defined in Amazonka.GameLift.DeleteFleetLocations Methods toHeaders :: DeleteFleetLocations -> [Header] #
ToPath DeleteFleetLocations Source #
Instance details Defined in Amazonka.GameLift.DeleteFleetLocations Methods toPath :: DeleteFleetLocations -> ByteString #
ToQuery DeleteFleetLocations Source #
Instance details Defined in Amazonka.GameLift.DeleteFleetLocations Methods toQuery :: DeleteFleetLocations -> QueryString #
AWSRequest DeleteFleetLocations Source #
Instance details Defined in Amazonka.GameLift.DeleteFleetLocations Associated Types type AWSResponse DeleteFleetLocations # Methods request :: (Service -> Service) -> DeleteFleetLocations -> Request DeleteFleetLocations # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DeleteFleetLocations -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DeleteFleetLocations))) #
Generic DeleteFleetLocations Source #
Instance details Defined in Amazonka.GameLift.DeleteFleetLocations Associated Types type Rep DeleteFleetLocations :: Type -> Type # Methods from :: DeleteFleetLocations -> Rep DeleteFleetLocations x # to :: Rep DeleteFleetLocations x -> DeleteFleetLocations #
Read DeleteFleetLocations Source #
Instance details Defined in Amazonka.GameLift.DeleteFleetLocations Methods readsPrec :: Int -> ReadS DeleteFleetLocations # readList :: ReadS [DeleteFleetLocations] # readPrec :: ReadPrec DeleteFleetLocations # readListPrec :: ReadPrec [DeleteFleetLocations] #
Show DeleteFleetLocations Source #
Instance details Defined in Amazonka.GameLift.DeleteFleetLocations Methods showsPrec :: Int -> DeleteFleetLocations -> ShowS # show :: DeleteFleetLocations -> String # showList :: [DeleteFleetLocations] -> ShowS #
NFData DeleteFleetLocations Source #
Instance details Defined in Amazonka.GameLift.DeleteFleetLocations Methods rnf :: DeleteFleetLocations -> () #
Eq DeleteFleetLocations Source #
Instance details Defined in Amazonka.GameLift.DeleteFleetLocations Methods (==) :: DeleteFleetLocations -> DeleteFleetLocations -> Bool # (/=) :: DeleteFleetLocations -> DeleteFleetLocations -> Bool #
Hashable DeleteFleetLocations Source #
Instance details Defined in Amazonka.GameLift.DeleteFleetLocations Methods hashWithSalt :: Int -> DeleteFleetLocations -> Int # hash :: DeleteFleetLocations -> Int #
type AWSResponse DeleteFleetLocations Source #
Instance details Defined in Amazonka.GameLift.DeleteFleetLocations type AWSResponse DeleteFleetLocations = DeleteFleetLocationsResponse
type Rep DeleteFleetLocations Source #
Instance details Defined in Amazonka.GameLift.DeleteFleetLocations type Rep DeleteFleetLocations = D1 ('MetaData "DeleteFleetLocations" "Amazonka.GameLift.DeleteFleetLocations" "amazonka-gamelift-2.0-IjhNQby9jLV6gj30IrgsyK" 'False) (C1 ('MetaCons "DeleteFleetLocations'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fleetId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "locations") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (NonEmpty Text))))

newDeleteFleetLocations Source #

Arguments

:: Text	`DeleteFleetLocations`
-> NonEmpty Text	`$sel:locations:DeleteFleetLocations'`
-> DeleteFleetLocations

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

DeleteFleetLocations, deleteFleetLocations_fleetId - A unique identifier for the fleet to delete locations for. You can use either the fleet ID or ARN value.

$sel:locations:DeleteFleetLocations', deleteFleetLocations_locations - The list of fleet locations to delete. Specify locations in the form of an Amazon Web Services Region code, such as us-west-2.

Request Lenses

deleteFleetLocations_fleetId :: Lens' DeleteFleetLocations Text Source #

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

deleteFleetLocations_locations :: Lens' DeleteFleetLocations (NonEmpty Text) Source #

The list of fleet locations to delete. Specify locations in the form of an Amazon Web Services Region code, such as us-west-2.

Destructuring the Response

data DeleteFleetLocationsResponse Source #

See: newDeleteFleetLocationsResponse smart constructor.

Constructors

DeleteFleetLocationsResponse'

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 that location attributes are being deleted for.
locationStates :: Maybe [LocationState]
The remote locations that are being deleted, with each location status set to DELETING.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic DeleteFleetLocationsResponse Source #
Instance details Defined in Amazonka.GameLift.DeleteFleetLocations Associated Types type Rep DeleteFleetLocationsResponse :: Type -> Type # Methods from :: DeleteFleetLocationsResponse -> Rep DeleteFleetLocationsResponse x # to :: Rep DeleteFleetLocationsResponse x -> DeleteFleetLocationsResponse #
Read DeleteFleetLocationsResponse Source #
Instance details Defined in Amazonka.GameLift.DeleteFleetLocations Methods readsPrec :: Int -> ReadS DeleteFleetLocationsResponse # readList :: ReadS [DeleteFleetLocationsResponse] # readPrec :: ReadPrec DeleteFleetLocationsResponse # readListPrec :: ReadPrec [DeleteFleetLocationsResponse] #
Show DeleteFleetLocationsResponse Source #
Instance details Defined in Amazonka.GameLift.DeleteFleetLocations Methods showsPrec :: Int -> DeleteFleetLocationsResponse -> ShowS # show :: DeleteFleetLocationsResponse -> String # showList :: [DeleteFleetLocationsResponse] -> ShowS #
NFData DeleteFleetLocationsResponse Source #
Instance details Defined in Amazonka.GameLift.DeleteFleetLocations Methods rnf :: DeleteFleetLocationsResponse -> () #
Eq DeleteFleetLocationsResponse Source #
Instance details Defined in Amazonka.GameLift.DeleteFleetLocations Methods (==) :: DeleteFleetLocationsResponse -> DeleteFleetLocationsResponse -> Bool # (/=) :: DeleteFleetLocationsResponse -> DeleteFleetLocationsResponse -> Bool #
type Rep DeleteFleetLocationsResponse Source #
Instance details Defined in Amazonka.GameLift.DeleteFleetLocations type Rep DeleteFleetLocationsResponse = D1 ('MetaData "DeleteFleetLocationsResponse" "Amazonka.GameLift.DeleteFleetLocations" "amazonka-gamelift-2.0-IjhNQby9jLV6gj30IrgsyK" 'False) (C1 ('MetaCons "DeleteFleetLocationsResponse'" '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 "locationStates") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [LocationState])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDeleteFleetLocationsResponse Source #

Arguments

:: Int	`$sel:httpStatus:DeleteFleetLocationsResponse'`
-> DeleteFleetLocationsResponse

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

DeleteFleetLocationsResponse, deleteFleetLocationsResponse_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.

DeleteFleetLocations, deleteFleetLocationsResponse_fleetId - A unique identifier for the fleet that location attributes are being deleted for.

$sel:locationStates:DeleteFleetLocationsResponse', deleteFleetLocationsResponse_locationStates - The remote locations that are being deleted, with each location status set to DELETING.

$sel:httpStatus:DeleteFleetLocationsResponse', deleteFleetLocationsResponse_httpStatus - The response's http status code.

Response Lenses

deleteFleetLocationsResponse_fleetArn :: Lens' DeleteFleetLocationsResponse (Maybe Text) Source #

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.

deleteFleetLocationsResponse_fleetId :: Lens' DeleteFleetLocationsResponse (Maybe Text) Source #

A unique identifier for the fleet that location attributes are being deleted for.

deleteFleetLocationsResponse_locationStates :: Lens' DeleteFleetLocationsResponse (Maybe [LocationState]) Source #

The remote locations that are being deleted, with each location status set to DELETING.

deleteFleetLocationsResponse_httpStatus :: Lens' DeleteFleetLocationsResponse Int Source #

The response's http status code.