Skip to content

UpdateConsumableResourceRequest

Source code in docs_src/capo_batch/types/update_consumable_resource_request.py 
13
14
15
16
17
18
19
20
21
22
23
class UpdateConsumableResourceRequest(TypedDict, closed=True):
    consumable_resource: NotRequired["capo_batch.types.string.String"]
    """<p>The name or ARN of the consumable resource to be updated.</p>"""
    operation: NotRequired["capo_batch.types.string.String"]
    """<p>Indicates how the quantity of the consumable resource will be updated. Must be one of:</p> <ul> <li> <p> <code>SET</code> </p> <p>Sets the quantity of the resource to the value specified by the <code>quantity</code> parameter.</p> </li> <li> <p> <code>ADD</code> </p> <p>Increases the quantity of the resource by the value specified by the <code>quantity</code> parameter.</p> </li> <li> <p> <code>REMOVE</code> </p> <p>Reduces the quantity of the resource by the value specified by the <code>quantity</code> parameter.</p> </li> </ul>"""
    quantity: NotRequired["capo_batch.types.long.Long"]
    """<p>The change in the total quantity of the consumable resource. The <code>operation</code> 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.</p>"""
    client_token: NotRequired[
        "capo_batch.types.client_request_token.ClientRequestToken"
    ]
    """<p>If this parameter is specified and two update requests with identical payloads and <code>clientToken</code>s are received, these requests are considered the same request. Both requests will succeed, but the update will only happen once. A <code>clientToken</code> is valid for 8 hours.</p>"""

client_token instance-attribute 

client_token: NotRequired[ClientRequestToken]

If this parameter is specified and two update requests with identical payloads and clientTokens are received, these requests are considered the same request. Both requests will succeed, but the update will only happen once. A clientToken is valid for 8 hours.

consumable_resource instance-attribute 

consumable_resource: NotRequired[String]

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

operation instance-attribute 

operation: NotRequired[String]

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 instance-attribute 

quantity: NotRequired[Long]

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.