DescribeCapacityProvidersRequest Class

Container for the parameters to the DescribeCapacityProviders operation. Describes one or more of your capacity providers.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.ECS.AmazonECSRequest
      Amazon.ECS.Model.DescribeCapacityProvidersRequest

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

Syntax

public class DescribeCapacityProvidersRequest : AmazonECSRequest
         IAmazonWebServiceRequest

The DescribeCapacityProvidersRequest type exposes the following members

Constructors

	Name	Description
	DescribeCapacityProvidersRequest()

Properties

Name	Type	Description
CapacityProviders	System.Collections.Generic.List<System.String>	Gets and sets the property CapacityProviders. The short name or full Amazon Resource Name (ARN) of one or more capacity providers. Up to `100` capacity providers can be described in an action.
Include	System.Collections.Generic.List<System.String>	Gets and sets the property Include. Specifies whether or not you want to see the resource tags for the capacity provider. If `TAGS` is specified, the tags are included in the response. If this field is omitted, tags aren't included in the response.
MaxResults	System.Int32	Gets and sets the property MaxResults. The maximum number of account setting results returned by `DescribeCapacityProviders` in paginated output. When this parameter is used, `DescribeCapacityProviders` 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 `DescribeCapacityProviders` request with the returned `nextToken` value. This value can be between 1 and 10. If this parameter is not used, then `DescribeCapacityProviders` returns up to 10 results and a `nextToken` value if applicable.
NextToken	System.String	Gets and sets the property NextToken. The `nextToken` value returned from a previous paginated `DescribeCapacityProviders` 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 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 retrieves details about all capacity providers.

To describe all capacity providers


var client = new AmazonECSClient();
var response = client.DescribeCapacityProviders(new DescribeCapacityProvidersRequest 
{
});

List<CapacityProvider> capacityProviders = response.CapacityProviders;

This example retrieves details about the capacity provider MyCapacityProvider

To describe a specific capacity provider


var client = new AmazonECSClient();
var response = client.DescribeCapacityProviders(new DescribeCapacityProvidersRequest 
{
    CapacityProviders = new List<string> {
        "MyCapacityProvider"
    },
    Include = new List<string> {
        "TAGS"
    }
});

List<CapacityProvider> capacityProviders = response.CapacityProviders;

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