Skip to content

ListServicesRequest

Source code in docs_src/capo_ecs/types/list_services_request.py
class ListServicesRequest(TypedDict, closed=True):
    cluster: NotRequired["capo_ecs.types.string.String"]
    """<p>The short name or full Amazon Resource Name (ARN) of the cluster to use when filtering the <code>ListServices</code> results. If you do not specify a cluster, the default cluster is assumed.</p>"""
    next_token: NotRequired["capo_ecs.types.string.String"]
    """<p>The <code>nextToken</code> value returned from a <code>ListServices</code> request indicating that more results are available to fulfill the request and further calls will be needed. If <code>maxResults</code> was provided, it is possible the number of results to be fewer than <code>maxResults</code>.</p> <note> <p>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.</p> </note>"""
    max_results: NotRequired["capo_ecs.types.boxed_integer.BoxedInteger"]
    """<p>The maximum number of service results that <code>ListServices</code> returned in paginated output. When this parameter is used, <code>ListServices</code> only returns <code>maxResults</code> results in a single page along with a <code>nextToken</code> response element. The remaining results of the initial request can be seen by sending another <code>ListServices</code> request with the returned <code>nextToken</code> value. This value can be between 1 and 100. If this parameter isn't used, then <code>ListServices</code> returns up to 10 results and a <code>nextToken</code> value if applicable.</p>"""
    launch_type: NotRequired["capo_ecs.types.launch_type.LaunchType"]
    """<p>The launch type to use when filtering the <code>ListServices</code> results.</p>"""
    scheduling_strategy: NotRequired[
        "capo_ecs.types.scheduling_strategy.SchedulingStrategy"
    ]
    """<p>The scheduling strategy to use when filtering the <code>ListServices</code> results.</p>"""
    resource_management_type: NotRequired[
        "capo_ecs.types.resource_management_type.ResourceManagementType"
    ]
    """<p>The resourceManagementType type to use when filtering the <code>ListServices</code> results.</p>"""

cluster instance-attribute

cluster: NotRequired[String]

The short name or full Amazon Resource Name (ARN) of the cluster to use when filtering the ListServices results. If you do not specify a cluster, the default cluster is assumed.

launch_type instance-attribute

launch_type: NotRequired[LaunchType]

The launch type to use when filtering the ListServices results.

max_results instance-attribute

max_results: NotRequired[BoxedInteger]

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

next_token instance-attribute

next_token: NotRequired[String]

The nextToken value returned from a ListServices 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.

resource_management_type instance-attribute

resource_management_type: NotRequired[ResourceManagementType]

The resourceManagementType type to use when filtering the ListServices results.

scheduling_strategy instance-attribute

scheduling_strategy: NotRequired[SchedulingStrategy]

The scheduling strategy to use when filtering the ListServices results.