AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Container for the parameters to the ListTaskDefinitions operation. Returns a list of task definitions that are registered to your account. You can filter the results by family name with the familyPrefix parameter or by status with the status parameter.

Inheritance Hierarchy

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

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

Syntax

C#
public class ListTaskDefinitionsRequest : AmazonECSRequest
         IAmazonWebServiceRequest

The ListTaskDefinitionsRequest type exposes the following members

Constructors

Properties

NameTypeDescription
Public Property FamilyPrefix System.String

Gets and sets the property FamilyPrefix.

The full family name with which to filter the ListTaskDefinitions results. Specifying a familyPrefix limits the listed task definitions to task definition revisions that belong to that family.

Public Property MaxResults System.Int32

Gets and sets the property MaxResults.

The maximum number of task definition results returned by ListTaskDefinitions 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 ListTaskDefinitions request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListTaskDefinitions returns up to 100 results and a nextToken value if applicable.

Public Property NextToken System.String

Gets and sets the property NextToken.

The nextToken value returned from a previous paginated ListTaskDefinitions 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.

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.

Public Property Sort Amazon.ECS.SortOrder

Gets and sets the property Sort.

The order in which to sort the results. Valid values are ASC and DESC. By default (ASC), task definitions are listed lexicographically by family name and in ascending numerical order by revision so that the newest task definitions in a family are listed last. Setting this parameter to DESC reverses the sort order on family name and revision so that the newest task definitions in a family are listed first.

Public Property Status Amazon.ECS.TaskDefinitionStatus

Gets and sets the property Status.

The task definition status with which to filter the ListTaskDefinitions results. By default, only ACTIVE task definitions are listed. By setting this parameter to INACTIVE, you can view task definitions that are INACTIVE as long as an active task or service still references them. 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 definitions.

To list your registered task definitions


var response = client.ListTaskDefinitions(new ListTaskDefinitionsRequest 
{
});

List taskDefinitionArns = response.TaskDefinitionArns;

            

This example lists the task definition revisions of a specified family.

To list the registered task definitions in a family


var response = client.ListTaskDefinitions(new ListTaskDefinitionsRequest 
{
    FamilyPrefix = "wordpress"
});

List taskDefinitionArns = response.TaskDefinitionArns;

            

Version Information

.NET Standard:
Supported in: 1.3

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

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms