Skip to content

list_task_definition_families

Operation

list_task_definition_families

list_task_definition_families(request: ListTaskDefinitionFamiliesInput | ListTaskDefinitionFamiliesInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListTaskDefinitionFamiliesInputDict]) -> ListTaskDefinitionFamiliesOutput

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.

Parameters:

Name Type Description Default
request ListTaskDefinitionFamiliesInput | ListTaskDefinitionFamiliesInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None
**kwargs Unpack[ListTaskDefinitionFamiliesInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
ListTaskDefinitionFamiliesOutput

An instance of ListTaskDefinitionFamiliesOutput.

list_task_definition_families async

list_task_definition_families(request: ListTaskDefinitionFamiliesInput | ListTaskDefinitionFamiliesInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListTaskDefinitionFamiliesInputDict]) -> ListTaskDefinitionFamiliesOutput

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.

Parameters:

Name Type Description Default
request ListTaskDefinitionFamiliesInput | ListTaskDefinitionFamiliesInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None
**kwargs Unpack[ListTaskDefinitionFamiliesInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
ListTaskDefinitionFamiliesOutput

An instance of ListTaskDefinitionFamiliesOutput.

Input

Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.

ListTaskDefinitionFamiliesInputDict

Bases: TypedDict

Dictionary form of ListTaskDefinitionFamiliesInput.

Attributes

family_prefix instance-attribute
family_prefix: str | None

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.

max_results instance-attribute
max_results: int | None

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.

next_token instance-attribute
next_token: str | None

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.

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.

status instance-attribute
status: str | None

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.

ListTaskDefinitionFamiliesInput dataclass

Bases: _SerdeShape

Attributes

family_prefix class-attribute instance-attribute
family_prefix: str | None = ...

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.

max_results class-attribute instance-attribute
max_results: int | None = ...

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.

next_token class-attribute instance-attribute
next_token: str | None = ...

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.

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.

status class-attribute instance-attribute
status: str | None = ...

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.

Output

ListTaskDefinitionFamiliesOutput dataclass

Bases: _SerdeShape

Attributes

families class-attribute instance-attribute
families: list[str] | None = ...

The list of task definition family names that match the ListTaskDefinitionFamilies request.

next_token class-attribute instance-attribute
next_token: str | None = ...

The nextToken value to include in a future ListTaskDefinitionFamilies request. When the results of a ListTaskDefinitionFamilies request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.