libZSservicesZSamazonka-devicefarmZSamazonka-devicefarm
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.DeviceFarm.UpdateDevicePool

Description

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

Creating a Request

data UpdateDevicePool Source #

Represents a request to the update device pool operation.

See: newUpdateDevicePool smart constructor.

Constructors

UpdateDevicePool' 

Fields

  • rules :: Maybe [Rule]

    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.

  • clearMaxDevices :: Maybe Bool

    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.

  • name :: Maybe Text

    A string that represents the name of the device pool to update.

  • maxDevices :: Maybe Int

    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.

  • description :: Maybe Text

    A description of the device pool to update.

  • arn :: Text

    The Amazon Resource Name (ARN) of the Device Farm device pool to update.

Instances

Instances details
Eq UpdateDevicePool Source # 
Instance details

Defined in Amazonka.DeviceFarm.UpdateDevicePool

Read UpdateDevicePool Source # 
Instance details

Defined in Amazonka.DeviceFarm.UpdateDevicePool

Show UpdateDevicePool Source # 
Instance details

Defined in Amazonka.DeviceFarm.UpdateDevicePool

Generic UpdateDevicePool Source # 
Instance details

Defined in Amazonka.DeviceFarm.UpdateDevicePool

Associated Types

type Rep UpdateDevicePool :: Type -> Type #

NFData UpdateDevicePool Source # 
Instance details

Defined in Amazonka.DeviceFarm.UpdateDevicePool

Methods

rnf :: UpdateDevicePool -> () #

Hashable UpdateDevicePool Source # 
Instance details

Defined in Amazonka.DeviceFarm.UpdateDevicePool

ToJSON UpdateDevicePool Source # 
Instance details

Defined in Amazonka.DeviceFarm.UpdateDevicePool

AWSRequest UpdateDevicePool Source # 
Instance details

Defined in Amazonka.DeviceFarm.UpdateDevicePool

Associated Types

type AWSResponse UpdateDevicePool #

ToHeaders UpdateDevicePool Source # 
Instance details

Defined in Amazonka.DeviceFarm.UpdateDevicePool

ToPath UpdateDevicePool Source # 
Instance details

Defined in Amazonka.DeviceFarm.UpdateDevicePool

ToQuery UpdateDevicePool Source # 
Instance details

Defined in Amazonka.DeviceFarm.UpdateDevicePool

type Rep UpdateDevicePool Source # 
Instance details

Defined in Amazonka.DeviceFarm.UpdateDevicePool

type Rep UpdateDevicePool = D1 ('MetaData "UpdateDevicePool" "Amazonka.DeviceFarm.UpdateDevicePool" "libZSservicesZSamazonka-devicefarmZSamazonka-devicefarm" 'False) (C1 ('MetaCons "UpdateDevicePool'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "rules") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Rule])) :*: (S1 ('MetaSel ('Just "clearMaxDevices") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 ('MetaSel ('Just "maxDevices") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))
type AWSResponse UpdateDevicePool Source # 
Instance details

Defined in Amazonka.DeviceFarm.UpdateDevicePool

newUpdateDevicePool Source #

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.

Constructors

UpdateDevicePoolResponse' 

Fields

Instances

Instances details
Eq UpdateDevicePoolResponse Source # 
Instance details

Defined in Amazonka.DeviceFarm.UpdateDevicePool

Read UpdateDevicePoolResponse Source # 
Instance details

Defined in Amazonka.DeviceFarm.UpdateDevicePool

Show UpdateDevicePoolResponse Source # 
Instance details

Defined in Amazonka.DeviceFarm.UpdateDevicePool

Generic UpdateDevicePoolResponse Source # 
Instance details

Defined in Amazonka.DeviceFarm.UpdateDevicePool

Associated Types

type Rep UpdateDevicePoolResponse :: Type -> Type #

NFData UpdateDevicePoolResponse Source # 
Instance details

Defined in Amazonka.DeviceFarm.UpdateDevicePool

type Rep UpdateDevicePoolResponse Source # 
Instance details

Defined in Amazonka.DeviceFarm.UpdateDevicePool

type Rep UpdateDevicePoolResponse = D1 ('MetaData "UpdateDevicePoolResponse" "Amazonka.DeviceFarm.UpdateDevicePool" "libZSservicesZSamazonka-devicefarmZSamazonka-devicefarm" 'False) (C1 ('MetaCons "UpdateDevicePoolResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "devicePool") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DevicePool)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

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