ECS / Client / list_services_by_namespace

list_services_by_namespace#

ECS.Client.list_services_by_namespace(**kwargs)#

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.

See also: AWS API Documentation

Request Syntax

response = client.list_services_by_namespace(
    namespace='string',
    nextToken='string',
    maxResults=123
)
Parameters:

  • namespace (string) –

    [REQUIRED]

    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.

  • nextToken (string) – 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.

  • maxResults (integer) – 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.

Return type:

dict

Returns:

Response Syntax

{
    'serviceArns': [
        'string',
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) –

    • serviceArns (list) –

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

      • (string) –

    • nextToken (string) –

      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.

Exceptions