Skip to content

DescribeConsumableResourceResponse

Source code in docs_src/capo_batch/types/describe_consumable_resource_response.py
class DescribeConsumableResourceResponse(TypedDict, closed=True):
    consumable_resource_name: NotRequired["capo_batch.types.string.String"]
    """<p>The name of the consumable resource.</p>"""
    consumable_resource_arn: NotRequired["capo_batch.types.string.String"]
    """<p>The Amazon Resource Name (ARN) of the consumable resource.</p>"""
    total_quantity: NotRequired["capo_batch.types.long.Long"]
    """<p>The total amount of the consumable resource that is available.</p>"""
    in_use_quantity: NotRequired["capo_batch.types.long.Long"]
    """<p>The amount of the consumable resource that is currently in use.</p>"""
    available_quantity: NotRequired["capo_batch.types.long.Long"]
    """<p>The amount of the consumable resource that is currently available to use.</p>"""
    resource_type: NotRequired["capo_batch.types.string.String"]
    """<p>Indicates whether the resource is available to be re-used after a job completes. Can be one of: </p> <ul> <li> <p> <code>REPLENISHABLE</code> </p> </li> <li> <p> <code>NON_REPLENISHABLE</code> </p> </li> </ul>"""
    created_at: NotRequired["capo_batch.types.long.Long"]
    """<p>The Unix timestamp (in milliseconds) for when the consumable resource was created.</p>"""
    tags: NotRequired["capo_batch.types.tagris_tags_map.TagrisTagsMap"]
    """<p>The tags that you apply to the consumable resource to help you categorize and organize your resources. Each tag consists of a key and an optional value. For more information, see <a href="https://docs.aws.amazon.com/batch/latest/userguide/using-tags.html">Tagging your Batch resources</a>.</p>"""

available_quantity instance-attribute

available_quantity: NotRequired[Long]

The amount of the consumable resource that is currently available to use.

consumable_resource_arn instance-attribute

consumable_resource_arn: NotRequired[String]

The Amazon Resource Name (ARN) of the consumable resource.

consumable_resource_name instance-attribute

consumable_resource_name: NotRequired[String]

The name of the consumable resource.

created_at instance-attribute

created_at: NotRequired[Long]

The Unix timestamp (in milliseconds) for when the consumable resource was created.

in_use_quantity instance-attribute

in_use_quantity: NotRequired[Long]

The amount of the consumable resource that is currently in use.

resource_type instance-attribute

resource_type: NotRequired[String]

Indicates whether the resource is available to be re-used after a job completes. Can be one of:

  • REPLENISHABLE

  • NON_REPLENISHABLE

tags instance-attribute

tags: NotRequired[TagrisTagsMap]

The tags that you apply to the consumable resource to help you categorize and organize your resources. Each tag consists of a key and an optional value. For more information, see Tagging your Batch resources.

total_quantity instance-attribute

total_quantity: NotRequired[Long]

The total amount of the consumable resource that is available.