DescribeJobQueuesRequest Class | AWS SDK for .NET V3

Container for the parameters to the DescribeJobQueues operation. Describes one or more of your job queues.

Inheritance Hierarchy

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

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

Syntax

public class DescribeJobQueuesRequest : AmazonBatchRequest
         IAmazonWebServiceRequest

The DescribeJobQueuesRequest type exposes the following members

Constructors

	Name	Description
	DescribeJobQueuesRequest()

Properties

Name Type Description

Name	Type	Description
JobQueues	System.Collections.Generic.List<System.String>	Gets and sets the property JobQueues. A list of up to 100 queue names or full queue Amazon Resource Name (ARN) entries.
MaxResults	System.Int32	Gets and sets the property MaxResults. The maximum number of results returned by `DescribeJobQueues` in paginated output. When this parameter is used, `DescribeJobQueues` 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 `DescribeJobQueues` request with the returned `nextToken` value. This value can be between 1 and 100. If this parameter isn't used, then `DescribeJobQueues` 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 `DescribeJobQueues` 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.

JobQueues

System.Collections.Generic.List<System.String>

Gets and sets the property JobQueues.

A list of up to 100 queue names or full queue Amazon Resource Name (ARN) entries.

MaxResults

System.Int32

Gets and sets the property MaxResults.

The maximum number of results returned by DescribeJobQueues in paginated output. When this parameter is used, DescribeJobQueues 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 DescribeJobQueues request with the returned nextToken value. This value can be between 1 and 100. If this parameter isn't used, then DescribeJobQueues 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 DescribeJobQueues 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

This example describes the HighPriority job queue.

To describe a job queue


var client = new AmazonBatchClient();
var response = client.DescribeJobQueues(new DescribeJobQueuesRequest 
{
    JobQueues = new List<string> {
        "HighPriority"
    }
});

List<JobQueueDetail> jobQueues = response.JobQueues;

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5, 4.0, 3.5