Batch / Client / describe_consumable_resource

describe_consumable_resource#

Batch.Client.describe_consumable_resource(**kwargs)#

Returns a description of the specified consumable resource.

See also: AWS API Documentation

Request Syntax

response = client.describe_consumable_resource(
    consumableResource='string'
)
Parameters:

consumableResource (string) –

[REQUIRED]

The name or ARN of the consumable resource whose description will be returned.

Return type:

dict

Returns:

Response Syntax

{
    'consumableResourceName': 'string',
    'consumableResourceArn': 'string',
    'totalQuantity': 123,
    'inUseQuantity': 123,
    'availableQuantity': 123,
    'resourceType': 'string',
    'createdAt': 123,
    'tags': {
        'string': 'string'
    }
}

Response Structure

  • (dict) –

    • consumableResourceName (string) –

      The name of the consumable resource.

    • consumableResourceArn (string) –

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

    • totalQuantity (integer) –

      The total amount of the consumable resource that is available.

    • inUseQuantity (integer) –

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

    • availableQuantity (integer) –

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

    • resourceType (string) –

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

      • REPLENISHABLE

      • NON_REPLENISHABLE

    • createdAt (integer) –

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

    • tags (dict) –

      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.

      • (string) –

        • (string) –

Exceptions