Amazonka.DeviceFarm.UpdateDevicePool

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).

Creating a Request

data UpdateDevicePool

Represents a request to the update device pool operation.

See: newUpdateDevicePool smart constructor.

Constructors

UpdateDevicePool'

Fields

• 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.

• description :: Maybe Text

  A description 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.

• name :: Maybe Text

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

• 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.

• arn :: Text

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

Instances

ToJSON UpdateDevicePool

Defined in Amazonka.DeviceFarm.UpdateDevicePool

Methods

toJSON :: UpdateDevicePool -> Value

toEncoding :: UpdateDevicePool -> Encoding

toJSONList :: [UpdateDevicePool] -> Value

toEncodingList :: [UpdateDevicePool] -> Encoding

ToHeaders UpdateDevicePool

Defined in Amazonka.DeviceFarm.UpdateDevicePool

Methods

toHeaders :: UpdateDevicePool -> [Header]

ToPath UpdateDevicePool

Defined in Amazonka.DeviceFarm.UpdateDevicePool

Methods

toPath :: UpdateDevicePool -> ByteString

ToQuery UpdateDevicePool

Defined in Amazonka.DeviceFarm.UpdateDevicePool

Methods

toQuery :: UpdateDevicePool -> QueryString

AWSRequest UpdateDevicePool

Defined in Amazonka.DeviceFarm.UpdateDevicePool

Associated Types

type AWSResponse UpdateDevicePool

Methods

request :: (Service -> Service) -> UpdateDevicePool -> Request UpdateDevicePool

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy UpdateDevicePool -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse UpdateDevicePool)))

Generic UpdateDevicePool

Defined in Amazonka.DeviceFarm.UpdateDevicePool

Associated Types

type Rep UpdateDevicePool :: Type -> Type

Methods

from :: UpdateDevicePool -> Rep UpdateDevicePool x

to :: Rep UpdateDevicePool x -> UpdateDevicePool

Read UpdateDevicePool

Defined in Amazonka.DeviceFarm.UpdateDevicePool

Methods

readsPrec :: Int -> ReadS UpdateDevicePool

readList :: ReadS [UpdateDevicePool]

readPrec :: ReadPrec UpdateDevicePool

readListPrec :: ReadPrec [UpdateDevicePool]

Show UpdateDevicePool

Defined in Amazonka.DeviceFarm.UpdateDevicePool

Methods

showsPrec :: Int -> UpdateDevicePool -> ShowS

show :: UpdateDevicePool -> String

showList :: [UpdateDevicePool] -> ShowS

NFData UpdateDevicePool

Defined in Amazonka.DeviceFarm.UpdateDevicePool

Methods

rnf :: UpdateDevicePool -> ()

Eq UpdateDevicePool

Defined in Amazonka.DeviceFarm.UpdateDevicePool

Methods

(==) :: UpdateDevicePool -> UpdateDevicePool -> Bool

(/=) :: UpdateDevicePool -> UpdateDevicePool -> Bool

Hashable UpdateDevicePool

Defined in Amazonka.DeviceFarm.UpdateDevicePool

Methods

hashWithSalt :: Int -> UpdateDevicePool -> Int

hash :: UpdateDevicePool -> Int

type AWSResponse UpdateDevicePool

Defined in Amazonka.DeviceFarm.UpdateDevicePool

type AWSResponse UpdateDevicePool = UpdateDevicePoolResponse

type Rep UpdateDevicePool

Defined in Amazonka.DeviceFarm.UpdateDevicePool

type Rep UpdateDevicePool = D1 ('MetaData "UpdateDevicePool" "Amazonka.DeviceFarm.UpdateDevicePool" "amazonka-devicefarm-2.0-2e4KvZvQ9bT8TNjEPvmW9Q" 'False) (C1 ('MetaCons "UpdateDevicePool'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "clearMaxDevices") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "maxDevices") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)))) :*: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "rules") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Rule])) :*: S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newUpdateDevicePool

Arguments

:: Text

UpdateDevicePool

-> UpdateDevicePool

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: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.

UpdateDevicePool, updateDevicePool_description - A description of the device pool to update.

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.

UpdateDevicePool, updateDevicePool_name - A string that represents the name of the device pool to update.

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.

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

Request Lenses

updateDevicePool_clearMaxDevices :: Lens' UpdateDevicePool (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.

updateDevicePool_description :: Lens' UpdateDevicePool (Maybe Text)

A description of the device pool to update.

updateDevicePool_maxDevices :: Lens' UpdateDevicePool (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.

updateDevicePool_name :: Lens' UpdateDevicePool (Maybe Text)

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

updateDevicePool_rules :: Lens' UpdateDevicePool (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.

updateDevicePool_arn :: Lens' UpdateDevicePool Text

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

Destructuring the Response

data UpdateDevicePoolResponse

Represents the result of an update device pool request.

See: newUpdateDevicePoolResponse smart constructor.

Constructors

UpdateDevicePoolResponse'

Fields

• devicePool :: Maybe DevicePool

  The device pool you just updated.

• httpStatus :: Int

  The response's http status code.

Instances

Generic UpdateDevicePoolResponse

Defined in Amazonka.DeviceFarm.UpdateDevicePool

Associated Types

type Rep UpdateDevicePoolResponse :: Type -> Type

Methods

from :: UpdateDevicePoolResponse -> Rep UpdateDevicePoolResponse x

to :: Rep UpdateDevicePoolResponse x -> UpdateDevicePoolResponse

Read UpdateDevicePoolResponse

Defined in Amazonka.DeviceFarm.UpdateDevicePool

Methods

readsPrec :: Int -> ReadS UpdateDevicePoolResponse

readList :: ReadS [UpdateDevicePoolResponse]

readPrec :: ReadPrec UpdateDevicePoolResponse

readListPrec :: ReadPrec [UpdateDevicePoolResponse]

Show UpdateDevicePoolResponse

Defined in Amazonka.DeviceFarm.UpdateDevicePool

Methods

showsPrec :: Int -> UpdateDevicePoolResponse -> ShowS

show :: UpdateDevicePoolResponse -> String

showList :: [UpdateDevicePoolResponse] -> ShowS

NFData UpdateDevicePoolResponse

Defined in Amazonka.DeviceFarm.UpdateDevicePool

Methods

rnf :: UpdateDevicePoolResponse -> ()

Eq UpdateDevicePoolResponse

Defined in Amazonka.DeviceFarm.UpdateDevicePool

Methods

(==) :: UpdateDevicePoolResponse -> UpdateDevicePoolResponse -> Bool

(/=) :: UpdateDevicePoolResponse -> UpdateDevicePoolResponse -> Bool

type Rep UpdateDevicePoolResponse

Defined in Amazonka.DeviceFarm.UpdateDevicePool

type Rep UpdateDevicePoolResponse = D1 ('MetaData "UpdateDevicePoolResponse" "Amazonka.DeviceFarm.UpdateDevicePool" "amazonka-devicefarm-2.0-2e4KvZvQ9bT8TNjEPvmW9Q" '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

Arguments

:: Int

$sel:httpStatus:UpdateDevicePoolResponse'

-> UpdateDevicePoolResponse

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)

The device pool you just updated.

updateDevicePoolResponse_httpStatus :: Lens' UpdateDevicePoolResponse Int

The response's http status code.