ListServicesByNamespace
This operation lists all of the services that are associated with a Amazon 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.
Request Syntax
{
"maxResults": number
,
"namespace": "string
",
"nextToken": "string
"
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- maxResults
-
The maximum number of service results that
ListServicesByNamespace
returns in paginated output. When this parameter is used,ListServicesByNamespace
only returnsmaxResults
results in a single page along with anextToken
response element. The remaining results of the initial request can be seen by sending anotherListServicesByNamespace
request with the returnednextToken
value. This value can be between 1 and 100. If this parameter isn't used, thenListServicesByNamespace
returns up to 10 results and anextToken
value if applicable.Type: Integer
Required: No
- namespace
-
The namespace name or full Amazon Resource Name (ARN) of the Amazon 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.
Type: String
Required: Yes
- nextToken
-
The
nextToken
value that's returned from aListServicesByNamespace
request. It indicates that more results are available to fulfill the request and further calls are needed. IfmaxResults
is returned, it is possible the number of results is less thanmaxResults
.Type: String
Required: No
Response Syntax
{
"nextToken": "string",
"serviceArns": [ "string" ]
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- nextToken
-
The
nextToken
value to include in a futureListServicesByNamespace
request. When the results of aListServicesByNamespace
request exceedmaxResults
, this value can be used to retrieve the next page of results. When there are no more results to return, this value isnull
.Type: String
- serviceArns
-
The list of full ARN entries for each service that's associated with the specified namespace.
Type: Array of strings
Errors
For information about the errors that are common to all actions, see Common Errors.
- ClientException
-
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.
The following list includes additional causes for the error:
-
The
RunTask
could not be processed because you use managed scaling and there is a capacity error because the quota of tasks in thePROVISIONING
per cluster has been reached. For information about the service quotas, see Amazon ECS service quotas.
HTTP Status Code: 400
-
- InvalidParameterException
-
The specified parameter isn't valid. Review the available parameters for the API request.
HTTP Status Code: 400
- NamespaceNotFoundException
-
The specified namespace wasn't found.
HTTP Status Code: 400
- ServerException
-
These errors are usually caused by a server issue.
HTTP Status Code: 500
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: