AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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

C#
public class DescribeJobQueuesRequest : AmazonBatchRequest
         IAmazonWebServiceRequest

The DescribeJobQueuesRequest type exposes the following members

Constructors

NameDescription
Public Method DescribeJobQueuesRequest()

Properties

NameTypeDescription
Public Property 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.

Public Property 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 along with 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 is not used, then DescribeJobQueues returns up to 100 results and a nextToken value if applicable.

Public Property 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.

This token should be treated as an opaque identifier that is 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 response = client.DescribeJobQueues(new DescribeJobQueuesRequest 
{
    JobQueues = new List {
        "HighPriority"
    }
});

List jobQueues = response.JobQueues;

            

Version Information

.NET Standard:
Supported in: 1.3

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

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms