AmazonECSClient.ListTaskDefinitionFamilies Method (ListTaskDefinitionFamiliesRequest)

Returns a list of task definition families that are registered to your account. This list includes task definition families that no longer have any ACTIVE task definition revisions.

You can filter out task definition families that don't contain any ACTIVE task definition revisions by setting the status parameter to ACTIVE. You can also filter the results with the familyPrefix parameter.

Note:

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

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

Syntax

public virtual ListTaskDefinitionFamiliesResponse ListTaskDefinitionFamilies(
         ListTaskDefinitionFamiliesRequest request
)

Parameters

request: Type: Amazon.ECS.Model.ListTaskDefinitionFamiliesRequest

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

Return Value

Type: ListTaskDefinitionFamiliesResponse

The response from the ListTaskDefinitionFamilies 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. The following list includes additional causes for the error: The RunTask could not be processed because you use managed scaling and there is a capacity error because the quota of tasks in the PROVISIONING per cluster has been reached. For information about the service quotas, see Amazon ECS service quotas.
InvalidParameterException	The specified parameter isn't valid. Review the available parameters for the API request.
ServerException	These errors are usually caused by a server issue.

Examples

This example lists all of your registered task definition families.

To list your registered task definition families


var client = new AmazonECSClient();
var response = client.ListTaskDefinitionFamilies(new ListTaskDefinitionFamiliesRequest 
{
});

List<string> families = response.Families;

This example lists the task definition revisions that start with "hpcc".

To filter your registered task definition families


var client = new AmazonECSClient();
var response = client.ListTaskDefinitionFamilies(new ListTaskDefinitionFamiliesRequest 
{
    FamilyPrefix = "hpcc"
});

List<string> families = response.Families;

Version Information

.NET Framework:
Supported in: 4.5 and newer, 3.5

AmazonECSClient.ListTaskDefinitionFamilies (ListTaskDefinitionFamiliesRequest)

Method