ListTaskDefinitionFamiliesRequest Class

Container for the parameters to the ListTaskDefinitionFamilies operation. 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.

Inheritance Hierarchy

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

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

Syntax

public class ListTaskDefinitionFamiliesRequest : AmazonECSRequest
         IAmazonWebServiceRequest

The ListTaskDefinitionFamiliesRequest type exposes the following members

Constructors

	Name	Description
	ListTaskDefinitionFamiliesRequest()

Properties

Name	Type	Description
FamilyPrefix	System.String	Gets and sets the property FamilyPrefix. The `familyPrefix` is a string that's used to filter the results of `ListTaskDefinitionFamilies`. If you specify a `familyPrefix`, only task definition family names that begin with the `familyPrefix` string are returned.
MaxResults	System.Int32	Gets and sets the property MaxResults. The maximum number of task definition family results that `ListTaskDefinitionFamilies` returned in paginated output. When this parameter is used, `ListTaskDefinitions` 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 `ListTaskDefinitionFamilies` request with the returned `nextToken` value. This value can be between 1 and 100. If this parameter isn't used, then `ListTaskDefinitionFamilies` 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 `ListTaskDefinitionFamilies` request indicating that more results are available to fulfill the request and further calls will be needed. If `maxResults` was provided, it is possible the number of results to be fewer than `maxResults`. 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.
Status	Amazon.ECS.TaskDefinitionFamilyStatus	Gets and sets the property Status. The task definition family status to filter the `ListTaskDefinitionFamilies` results with. By default, both `ACTIVE` and `INACTIVE` task definition families are listed. If this parameter is set to `ACTIVE`, only task definition families that have an `ACTIVE` task definition revision are returned. If this parameter is set to `INACTIVE`, only task definition families that do not have any `ACTIVE` task definition revisions are returned. If you paginate the resulting output, be sure to keep the `status` value constant in each subsequent request.

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 Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

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