AmazonBatchClient.DescribeConsumableResource Method (DescribeConsumableResourceRequest)

Returns a description of the specified consumable resource.

Note:

For .NET Core this operation is only available in asynchronous form. Please refer to DescribeConsumableResourceAsync.

Namespace: Amazon.Batch
Assembly: AWSSDK.Batch.dll
Version: 3.x.y.z

Syntax

public virtual DescribeConsumableResourceResponse DescribeConsumableResource(
         DescribeConsumableResourceRequest request
)

Parameters

request: Type: Amazon.Batch.Model.DescribeConsumableResourceRequest

Container for the necessary parameters to execute the DescribeConsumableResource service method.

Return Value

Type: DescribeConsumableResourceResponse

The response from the DescribeConsumableResource service method, as returned by Batch.

Exceptions

Exception	Condition
ClientException	These errors are usually caused by a client action. One example cause is using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Another cause is specifying an identifier that's not valid.
ServerException	These errors are usually caused by a server issue.

Examples

Returns a description of the specified consumable resource.

To get a description of a consumable resource


var client = new AmazonBatchClient();
var response = client.DescribeConsumableResource(new DescribeConsumableResourceRequest 
{
    ConsumableResource = "myConsumableResource"
});

long availableQuantity = response.AvailableQuantity;
string consumableResourceArn = response.ConsumableResourceArn;
string consumableResourceName = response.ConsumableResourceName;
long createdAt = response.CreatedAt;
long inUseQuantity = response.InUseQuantity;
string resourceType = response.ResourceType;
Dictionary<string, string> tags = response.Tags;
long totalQuantity = response.TotalQuantity;

Version Information

.NET Framework:
Supported in: 4.5 and newer, 3.5

AmazonBatchClient.DescribeConsumableResource (DescribeConsumableResourceRequest)

Method