Copyright | (c) 2013-2021 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Modifies the name, description, and rules in a device pool given the attributes and the pool ARN. Rule updates are all-or-nothing, meaning they can only be updated as a whole (or not at all).
Synopsis
- data UpdateDevicePool = UpdateDevicePool' {}
- newUpdateDevicePool :: Text -> UpdateDevicePool
- updateDevicePool_rules :: Lens' UpdateDevicePool (Maybe [Rule])
- updateDevicePool_clearMaxDevices :: Lens' UpdateDevicePool (Maybe Bool)
- updateDevicePool_name :: Lens' UpdateDevicePool (Maybe Text)
- updateDevicePool_maxDevices :: Lens' UpdateDevicePool (Maybe Int)
- updateDevicePool_description :: Lens' UpdateDevicePool (Maybe Text)
- updateDevicePool_arn :: Lens' UpdateDevicePool Text
- data UpdateDevicePoolResponse = UpdateDevicePoolResponse' {}
- newUpdateDevicePoolResponse :: Int -> UpdateDevicePoolResponse
- updateDevicePoolResponse_devicePool :: Lens' UpdateDevicePoolResponse (Maybe DevicePool)
- updateDevicePoolResponse_httpStatus :: Lens' UpdateDevicePoolResponse Int
Creating a Request
data UpdateDevicePool Source #
Represents a request to the update device pool operation.
See: newUpdateDevicePool
smart constructor.
UpdateDevicePool' | |
|
Instances
Create a value of UpdateDevicePool
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:rules:UpdateDevicePool'
, updateDevicePool_rules
- Represents the rules to modify for the device pool. Updating rules is
optional. If you update rules for your request, the update replaces the
existing rules.
$sel:clearMaxDevices:UpdateDevicePool'
, updateDevicePool_clearMaxDevices
- Sets whether the maxDevices
parameter applies to your device pool. If
you set this parameter to true
, the maxDevices
parameter does not
apply, and Device Farm does not limit the number of devices that it adds
to your device pool. In this case, Device Farm adds all available
devices that meet the criteria specified in the rules
parameter.
If you use this parameter in your request, you cannot use the
maxDevices
parameter in the same request.
$sel:name:UpdateDevicePool'
, updateDevicePool_name
- A string that represents the name of the device pool to update.
$sel:maxDevices:UpdateDevicePool'
, updateDevicePool_maxDevices
- The number of devices that Device Farm can add to your device pool.
Device Farm adds devices that are available and that meet the criteria
that you assign for the rules
parameter. Depending on how many devices
meet these constraints, your device pool might contain fewer devices
than the value for this parameter.
By specifying the maximum number of devices, you can control the costs that you incur by running tests.
If you use this parameter in your request, you cannot use the
clearMaxDevices
parameter in the same request.
$sel:description:UpdateDevicePool'
, updateDevicePool_description
- A description of the device pool to update.
$sel:arn:UpdateDevicePool'
, updateDevicePool_arn
- The Amazon Resource Name (ARN) of the Device Farm device pool to update.
Request Lenses
updateDevicePool_rules :: Lens' UpdateDevicePool (Maybe [Rule]) Source #
Represents the rules to modify for the device pool. Updating rules is optional. If you update rules for your request, the update replaces the existing rules.
updateDevicePool_clearMaxDevices :: Lens' UpdateDevicePool (Maybe Bool) Source #
Sets whether the maxDevices
parameter applies to your device pool. If
you set this parameter to true
, the maxDevices
parameter does not
apply, and Device Farm does not limit the number of devices that it adds
to your device pool. In this case, Device Farm adds all available
devices that meet the criteria specified in the rules
parameter.
If you use this parameter in your request, you cannot use the
maxDevices
parameter in the same request.
updateDevicePool_name :: Lens' UpdateDevicePool (Maybe Text) Source #
A string that represents the name of the device pool to update.
updateDevicePool_maxDevices :: Lens' UpdateDevicePool (Maybe Int) Source #
The number of devices that Device Farm can add to your device pool.
Device Farm adds devices that are available and that meet the criteria
that you assign for the rules
parameter. Depending on how many devices
meet these constraints, your device pool might contain fewer devices
than the value for this parameter.
By specifying the maximum number of devices, you can control the costs that you incur by running tests.
If you use this parameter in your request, you cannot use the
clearMaxDevices
parameter in the same request.
updateDevicePool_description :: Lens' UpdateDevicePool (Maybe Text) Source #
A description of the device pool to update.
updateDevicePool_arn :: Lens' UpdateDevicePool Text Source #
The Amazon Resource Name (ARN) of the Device Farm device pool to update.
Destructuring the Response
data UpdateDevicePoolResponse Source #
Represents the result of an update device pool request.
See: newUpdateDevicePoolResponse
smart constructor.
UpdateDevicePoolResponse' | |
|
Instances
newUpdateDevicePoolResponse Source #
Create a value of UpdateDevicePoolResponse
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:devicePool:UpdateDevicePoolResponse'
, updateDevicePoolResponse_devicePool
- The device pool you just updated.
$sel:httpStatus:UpdateDevicePoolResponse'
, updateDevicePoolResponse_httpStatus
- The response's http status code.
Response Lenses
updateDevicePoolResponse_devicePool :: Lens' UpdateDevicePoolResponse (Maybe DevicePool) Source #
The device pool you just updated.
updateDevicePoolResponse_httpStatus :: Lens' UpdateDevicePoolResponse Int Source #
The response's http status code.