ListServicesByNamespaceCommand

Suggest an Edit

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.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { ECSClient, ListServicesByNamespaceCommand } from "@aws-sdk/client-ecs"; // ES Modules import
// const { ECSClient, ListServicesByNamespaceCommand } = require("@aws-sdk/client-ecs"); // CommonJS import
const client = new ECSClient(config);
const input = { // ListServicesByNamespaceRequest
  namespace: "STRING_VALUE", // required
  nextToken: "STRING_VALUE",
  maxResults: Number("int"),
};
const command = new ListServicesByNamespaceCommand(input);
const response = await client.send(command);
// { // ListServicesByNamespaceResponse
//   serviceArns: [ // StringList
//     "STRING_VALUE",
//   ],
//   nextToken: "STRING_VALUE",
// };

ListServicesByNamespaceCommand Input

See ListServicesByNamespaceCommandInput for more details

Parameter
Type
Description
namespace
Required
string | undefined

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.

maxResults
number | undefined

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.

nextToken
string | undefined

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.

ListServicesByNamespaceCommand Output

See ListServicesByNamespaceCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
nextToken
string | undefined

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.

serviceArns
string[] | undefined

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

Throws

Name
Fault
Details
ClientException
client

These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.

InvalidParameterException
client

The specified parameter isn't valid. Review the available parameters for the API request.

For more information about service event errors, see Amazon ECS service event messages .

NamespaceNotFoundException
client

The specified namespace wasn't found.

ServerException
server

These errors are usually caused by a server issue.

ECSServiceException
Base exception class for all service exceptions from ECS service.