Skip to content

ECS  >  Operations  >  list_services_by_namespace

list_services_by_namespace

Operation

list_services_by_namespace async

list_services_by_namespace(request: ListServicesByNamespaceInput | ListServicesByNamespaceInputDict, /, *, plugins: list[Plugin] | None = None) -> ListServicesByNamespaceOutput
list_services_by_namespace(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListServicesByNamespaceInputDict]) -> ListServicesByNamespaceOutput

This operation lists all of the services that are associated with a Cloud Map namespace. This list might include services in different clusters. In contrast, ListServices can only list services in one cluster at a time. If you need to filter the list of services in a single cluster by various parameters, use ListServices. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.

Parameters:

Name Type Description Default
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
ListServicesByNamespaceOutput

An instance of ListServicesByNamespaceOutput.

Input

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

Model

ListServicesByNamespaceInput dataclass

Bases: _SerdeShape

Dataclass for ListServicesByNamespaceInput structure.

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

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

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

The namespace name or full Amazon Resource Name (ARN) of the Cloud Map namespace to list the services in.

Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.

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

The nextToken value that's returned from a ListServicesByNamespace request. It indicates that more results are available to fulfill the request and further calls are needed. If maxResults is returned, it is possible the number of results is less than maxResults.

Dictionaries

ListServicesByNamespaceInputDict

Bases: TypedDict

Dictionary form of ListServicesByNamespaceInput.

Attributes
max_results instance-attribute
max_results: int | None

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

namespace instance-attribute
namespace: Required[str]

The namespace name or full Amazon Resource Name (ARN) of the Cloud Map namespace to list the services in.

Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.

next_token instance-attribute
next_token: str | None

The nextToken value that's returned from a ListServicesByNamespace request. It indicates that more results are available to fulfill the request and further calls are needed. If maxResults is returned, it is possible the number of results is less than maxResults.

Output

ListServicesByNamespaceOutput dataclass

Bases: _SerdeShape

Dataclass for ListServicesByNamespaceOutput structure.

Attributes

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

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

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.

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

The list of full ARN entries for each service that's associated with the specified namespace.