AmazonECSClient.DescribeCapacityProviders Method (DescribeCapacityProvidersRequest)

Describes one or more of your capacity providers.

Note:

For .NET Core this operation is only available in asynchronous form. Please refer to DescribeCapacityProvidersAsync.

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

Syntax

public virtual DescribeCapacityProvidersResponse DescribeCapacityProviders(
         DescribeCapacityProvidersRequest request
)

Parameters

request: Type: Amazon.ECS.Model.DescribeCapacityProvidersRequest

Container for the necessary parameters to execute the DescribeCapacityProviders service method.

Return Value

Type: DescribeCapacityProvidersResponse

The response from the DescribeCapacityProviders service method, as returned by ECS.

Exceptions

Exception	Condition
ClientException	These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.
InvalidParameterException	The specified parameter isn't valid. Review the available parameters for the API request. For more information about service event errors, see Amazon ECS service event messages.
ServerException	These errors are usually caused by a server issue.

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 Framework:
Supported in: 4.5 and newer, 3.5

AmazonECSClient.DescribeCapacityProviders (DescribeCapacityProvidersRequest)

Method