Batch / Client / create_consumable_resource

create_consumable_resource

Batch.Client.create_consumable_resource(**kwargs)

Creates an Batch consumable resource.

See also: AWS API Documentation

Request Syntax

response = client.create_consumable_resource(
    consumableResourceName='string',
    totalQuantity=123,
    resourceType='string',
    tags={
        'string': 'string'
    }
)
Parameters:

  • consumableResourceName (string) –

    [REQUIRED]

    The name of the consumable resource. Must be unique.

  • totalQuantity (integer) – The total amount of the consumable resource that is available. Must be non-negative.

  • resourceType (string) –

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

    • REPLENISHABLE (default)

    • NON_REPLENISHABLE

  • 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) –

Return type:

dict

Returns:

Response Syntax

{
    'consumableResourceName': 'string',
    'consumableResourceArn': 'string'
}

Response Structure

  • (dict) –

    • consumableResourceName (string) –

      The name of the consumable resource.

    • consumableResourceArn (string) –

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

Exceptions