ListConsumableResourcesRequest Class

Container for the parameters to the ListConsumableResources operation. Returns a list of Batch consumable resources.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.Batch.AmazonBatchRequest
      Amazon.Batch.Model.ListConsumableResourcesRequest

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

Syntax

public class ListConsumableResourcesRequest : AmazonBatchRequest
         IAmazonWebServiceRequest

The ListConsumableResourcesRequest type exposes the following members

Constructors

	Name	Description
	ListConsumableResourcesRequest()

Properties

Name Type Description

Name	Type	Description
Filters	System.Collections.Generic.List<Amazon.Batch.Model.KeyValuesPair>	Gets and sets the property Filters. The filters to apply to the consumable resource list query. If used, only those consumable resources that match the filter are listed. Filter names and values can be: name: `CONSUMABLE_RESOURCE_NAME` values: case-insensitive matches for the consumable resource name. If a filter value ends with an asterisk (), it matches any consumable resource name that begins with the string before the ''.
MaxResults	System.Int32	Gets and sets the property MaxResults. The maximum number of results returned by `ListConsumableResources` in paginated output. When this parameter is used, `ListConsumableResources` only returns `maxResults` results in a single page and a `nextToken` response element. The remaining results of the initial request can be seen by sending another `ListConsumableResources` request with the returned `nextToken` value. This value can be between 1 and 100. If this parameter isn't used, then `ListConsumableResources` returns up to 100 results and a `nextToken` value if applicable.
NextToken	System.String	Gets and sets the property NextToken. The `nextToken` value returned from a previous paginated `ListConsumableResources` request where `maxResults` was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the `nextToken` value. This value is `null` when there are no more results to return. Treat this token as an opaque identifier that's only used to retrieve the next items in a list and not for other programmatic purposes.

Filters

System.Collections.Generic.List<Amazon.Batch.Model.KeyValuesPair>

Gets and sets the property Filters.

The filters to apply to the consumable resource list query. If used, only those consumable resources that match the filter are listed. Filter names and values can be:

name: CONSUMABLE_RESOURCE_NAME
values: case-insensitive matches for the consumable resource name. If a filter value ends with an asterisk (*), it matches any consumable resource name that begins with the string before the '*'.

MaxResults

System.Int32

Gets and sets the property MaxResults.

The maximum number of results returned by ListConsumableResources in paginated output. When this parameter is used, ListConsumableResources only returns maxResults results in a single page and a nextToken response element. The remaining results of the initial request can be seen by sending another ListConsumableResources request with the returned nextToken value. This value can be between 1 and 100. If this parameter isn't used, then ListConsumableResources returns up to 100 results and a nextToken value if applicable.

NextToken

System.String

Gets and sets the property NextToken.

The nextToken value returned from a previous paginated ListConsumableResources request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This value is null when there are no more results to return.

Treat this token as an opaque identifier that's only used to retrieve the next items in a list and not for other programmatic purposes.

Examples

Returns a list of the consumable resources for your account.

To get a list of a consumable resources


var client = new AmazonBatchClient();
var response = client.ListConsumableResources(new ListConsumableResourcesRequest 
{
    Filters = new List<KeyValuesPair> {
        new KeyValuesPair {
            Name = "CONSUMABLE_RESOURCE_NAME",
            Values = new List<string> {
                "my*"
            }
        }
    },
    MaxResults = 123
});

List<ConsumableResourceSummary> consumableResources = response.ConsumableResources;

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

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