Request Syntax Request Parameters Response Syntax Response Elements Errors Examples See Also

ListDaemonTaskDefinitions

Returns a list of daemon task definitions that are registered to your account. You can filter the results by family name, status, or both to find daemon task definitions that match your criteria.

Request Syntax


{
   "family": "string",
   "familyPrefix": "string",
   "maxResults": number,
   "nextToken": "string",
   "revision": "string",
   "sort": "string",
   "status": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

family

The exact name of the daemon task definition family to filter results with.

Type: String

Required: No

familyPrefix

The full family name to filter the ListDaemonTaskDefinitions results with. Specifying a familyPrefix limits the listed daemon task definitions to daemon task definition families that start with the familyPrefix string.

Type: String

Required: No

maxResults

The maximum number of daemon task definition results that ListDaemonTaskDefinitions returned in paginated output. When this parameter is used, ListDaemonTaskDefinitions 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 ListDaemonTaskDefinitions request with the returned nextToken value. This value can be between 1 and 100. If this parameter isn't used, then ListDaemonTaskDefinitions returns up to 100 results and a nextToken value if applicable.

Type: Integer

Required: No

nextToken

The nextToken value returned from a ListDaemonTaskDefinitions request indicating that more results are available to fulfill the request and further calls will be needed. If maxResults was provided, it's possible for the number of results to be fewer than maxResults.

Note

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.

Type: String

Required: No

revision

The revision filter to apply. Specify LAST_REGISTERED to return only the last registered revision for each daemon task definition family.

Type: String

Valid Values: LAST_REGISTERED

Required: No

sort

The order to sort the results. Valid values are ASC and DESC. By default (ASC), daemon task definitions are listed in ascending order by family name and revision number.

Type: String

Valid Values: ASC | DESC

Required: No

status

The daemon task definition status to filter the ListDaemonTaskDefinitions results with. By default, only ACTIVE daemon task definitions are listed. If you set this parameter to DELETE_IN_PROGRESS, only daemon task definitions that are in the process of being deleted are listed. If you set this parameter to ALL, all daemon task definitions are listed regardless of status.

Type: String

Valid Values: ACTIVE | DELETE_IN_PROGRESS | ALL

Required: No

Response Syntax


{
   "daemonTaskDefinitions": [ 
      { 
         "arn": "string",
         "deleteRequestedAt": number,
         "registeredAt": number,
         "registeredBy": "string",
         "status": "string"
      }
   ],
   "nextToken": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

daemonTaskDefinitions

The list of daemon task definition summaries.

Type: Array of DaemonTaskDefinitionSummary objects

nextToken

The nextToken value to include in a future ListDaemonTaskDefinitions request. When the results of a ListDaemonTaskDefinitions request exceed maxResults, this value can be used to retrieve the next page of results.

Type: String

Errors

For information about the errors that are common to all actions, see Common Error Types.

AccessDeniedException

You don't have authorization to perform the requested action.

message: Message that describes the cause of the exception.

HTTP Status Code: 400

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.

message: Message that describes the cause of the exception.

HTTP Status Code: 400

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.

message: Message that describes the cause of the exception.

HTTP Status Code: 400

ServerException

These errors are usually caused by a server issue.

message: Message that describes the cause of the exception.

HTTP Status Code: 500

Examples

In the following example or examples, the Authorization header contents (AUTHPARAMS) must be replaced with an AWS Signature Version 4 signature. For more information, see Signature Version 4 Signing Process in the AWS General Reference.

You only need to learn how to sign HTTP requests if you intend to create them manually. When you use the AWS Command Line Interface or one of the AWS SDKs to make requests to AWS, these tools automatically sign the requests for you, with the access key that you specify when you configure the tools. When you use these tools, you don't have to sign requests yourself.

Example

This example lists all daemon task definitions in your account that start with the monitoring prefix.

Sample Request


POST / HTTP/1.1
Host: ecs.us-east-1.amazonaws.com
Accept-Encoding: identity
X-Amz-Target: AmazonEC2ContainerServiceV20141113.ListDaemonTaskDefinitions
X-Amz-Date: 20250315T103000Z
Content-Type: application/x-amz-json-1.1
Authorization: AUTHPARAMS

{
  "familyPrefix": "monitoring"
}

Sample Response


HTTP/1.1 200 OK
Server: Server
Date: Sat, 15 Mar 2025 10:30:00 GMT
Content-Type: application/x-amz-json-1.1
Content-Length: 354
Connection: keep-alive
x-amzn-RequestId: 123a4b56-7c89-01d2-3ef4-example5678f

{
  "daemonTaskDefinitions": [
    {
      "arn": "arn:aws:ecs:us-east-1:123456789012:daemon-task-definition/monitoring-agent:2",
      "registeredAt": "2025-03-20T14:00:00.000Z",
      "registeredBy": "arn:aws:iam::123456789012:user/admin",
      "status": "ACTIVE"
    },
    {
      "arn": "arn:aws:ecs:us-east-1:123456789012:daemon-task-definition/monitoring-agent:1",
      "registeredAt": "2025-03-15T10:30:00.000Z",
      "registeredBy": "arn:aws:iam::123456789012:user/admin",
      "status": "ACTIVE"
    }
  ]
}