Copyright | (c) 2013-2016 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
Updates fleet properties, including name and description, for a fleet. To update metadata, specify the fleet ID and the property values you want to change. If successful, the fleet ID for the updated fleet is returned.
- updateFleetAttributes :: Text -> UpdateFleetAttributes
- data UpdateFleetAttributes
- ufaNewGameSessionProtectionPolicy :: Lens' UpdateFleetAttributes (Maybe ProtectionPolicy)
- ufaName :: Lens' UpdateFleetAttributes (Maybe Text)
- ufaDescription :: Lens' UpdateFleetAttributes (Maybe Text)
- ufaResourceCreationLimitPolicy :: Lens' UpdateFleetAttributes (Maybe ResourceCreationLimitPolicy)
- ufaFleetId :: Lens' UpdateFleetAttributes Text
- updateFleetAttributesResponse :: Int -> UpdateFleetAttributesResponse
- data UpdateFleetAttributesResponse
- ufarsFleetId :: Lens' UpdateFleetAttributesResponse (Maybe Text)
- ufarsResponseStatus :: Lens' UpdateFleetAttributesResponse Int
Creating a Request
updateFleetAttributes Source #
Creates a value of UpdateFleetAttributes
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ufaNewGameSessionProtectionPolicy
- Game session protection policy to apply to all new instances created in this fleet. Instances that already exist are not affected. You can set protection for individual instances usingUpdateGameSession
. * NoProtection – The game session can be terminated during a scale-down event. * FullProtection – If the game session is in anACTIVE
status, it cannot be terminated during a scale-down event.ufaName
- Descriptive label associated with a fleet. Fleet names do not need to be unique.ufaDescription
- Human-readable description of a fleet.ufaResourceCreationLimitPolicy
- Policy that limits the number of game sessions an individual player can create over a span of time.ufaFleetId
- Unique identifier for the fleet you want to update attribute metadata for.
data UpdateFleetAttributes Source #
Represents the input for a request action.
See: updateFleetAttributes
smart constructor.
Request Lenses
ufaNewGameSessionProtectionPolicy :: Lens' UpdateFleetAttributes (Maybe ProtectionPolicy) Source #
Game session protection policy to apply to all new instances created in this fleet. Instances that already exist are not affected. You can set protection for individual instances using UpdateGameSession
. * NoProtection – The game session can be terminated during a scale-down event. * FullProtection – If the game session is in an ACTIVE
status, it cannot be terminated during a scale-down event.
ufaName :: Lens' UpdateFleetAttributes (Maybe Text) Source #
Descriptive label associated with a fleet. Fleet names do not need to be unique.
ufaDescription :: Lens' UpdateFleetAttributes (Maybe Text) Source #
Human-readable description of a fleet.
ufaResourceCreationLimitPolicy :: Lens' UpdateFleetAttributes (Maybe ResourceCreationLimitPolicy) Source #
Policy that limits the number of game sessions an individual player can create over a span of time.
ufaFleetId :: Lens' UpdateFleetAttributes Text Source #
Unique identifier for the fleet you want to update attribute metadata for.
Destructuring the Response
updateFleetAttributesResponse Source #
Creates a value of UpdateFleetAttributesResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ufarsFleetId
- Unique identifier for the updated fleet.ufarsResponseStatus
- -- | The response status code.
data UpdateFleetAttributesResponse Source #
Represents the returned data in response to a request action.
See: updateFleetAttributesResponse
smart constructor.
Response Lenses
ufarsFleetId :: Lens' UpdateFleetAttributesResponse (Maybe Text) Source #
Unique identifier for the updated fleet.
ufarsResponseStatus :: Lens' UpdateFleetAttributesResponse Int Source #
- - | The response status code.