list_services¶
Operation¶
async
¶
list_services(input: ListServicesInput, plugins: list[Plugin] | None = None) -> ListServicesOutput
Returns a list of services. You can filter the results by cluster, launch type, and scheduling strategy.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
ListServicesInput
|
An instance of |
required |
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
|
Returns:
| Type | Description |
|---|---|
ListServicesOutput
|
An instance of |
Input¶
dataclass
¶
Bases: _SerdeShape
Attributes¶
class-attribute
instance-attribute
¶
cluster: str | None = ...
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.
class-attribute
instance-attribute
¶
launch_type: str | None = ...
The launch type to use when filtering the ListServices results.
class-attribute
instance-attribute
¶
max_results: int | None = ...
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.
class-attribute
instance-attribute
¶
next_token: str | None = ...
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.
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.
Output¶
dataclass
¶
Bases: _SerdeShape
Attributes¶
class-attribute
instance-attribute
¶
next_token: str | None = ...
The nextToken value to include in a future ListServices request.
When the results of a ListServices 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.
class-attribute
instance-attribute
¶
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.