Skip to content

Update Consumable Resource

batch_update_consumable_resource R Documentation

Updates a consumable resource

Description

Updates a consumable resource.

Usage

batch_update_consumable_resource(consumableResource, operation,
  quantity, clientToken)

Arguments

consumableResource

[required] The name or ARN of the consumable resource to be updated.

operation

Indicates how the quantity of the consumable resource will be updated. Must be one of:

  • SET

    Sets the quantity of the resource to the value specified by the quantity parameter.

  • ADD

    Increases the quantity of the resource by the value specified by the quantity parameter.

  • REMOVE

    Reduces the quantity of the resource by the value specified by the quantity parameter.

quantity

The change in the total quantity of the consumable resource. The operation parameter determines whether the value specified here will be the new total quantity, or the amount by which the total quantity will be increased or reduced. Must be a non-negative value.

clientToken

If this parameter is specified and two update requests with identical payloads and clientTokens are received, these requests are considered the same request and the second request is rejected. A clientToken is valid for 8 hours or until one hour after the consumable resource is deleted, whichever is less.

Value

A list with the following syntax:

list(
  consumableResourceName = "string",
  consumableResourceArn = "string",
  totalQuantity = 123
)

Request syntax

svc$update_consumable_resource(
  consumableResource = "string",
  operation = "string",
  quantity = 123,
  clientToken = "string"
)