DescribeComputeEnvironmentsRequest Class

Container for the parameters to the DescribeComputeEnvironments operation. Describes one or more of your compute environments.

If you're using an unmanaged compute environment, you can use the DescribeComputeEnvironment operation to determine the ecsClusterArn that you launch your Amazon ECS container instances into.

Inheritance Hierarchy

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

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

Syntax

public class DescribeComputeEnvironmentsRequest : AmazonBatchRequest
         IAmazonWebServiceRequest

The DescribeComputeEnvironmentsRequest type exposes the following members

Constructors

	Name	Description
	DescribeComputeEnvironmentsRequest()

Properties

Name Type Description

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

ComputeEnvironments

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

Gets and sets the property ComputeEnvironments.

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

MaxResults

System.Int32

Gets and sets the property MaxResults.

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

To describe a compute environment


var client = new AmazonBatchClient();
var response = client.DescribeComputeEnvironments(new DescribeComputeEnvironmentsRequest 
{
    ComputeEnvironments = new List<string> {
        "P2OnDemand"
    }
});

List<ComputeEnvironmentDetail> computeEnvironments = response.ComputeEnvironments;

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