ECS / Client / list_services

list_services

ECS.Client.list_services(**kwargs)

Returns a list of services. You can filter the results by cluster, launch type, and scheduling strategy.

See also: AWS API Documentation

Request Syntax

response = client.list_services(
    cluster='string',
    nextToken='string',
    maxResults=123,
    launchType='EC2'|'FARGATE'|'EXTERNAL'|'MANAGED_INSTANCES',
    schedulingStrategy='REPLICA'|'DAEMON'
)
Parameters:

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

  • nextToken (string) –

    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.

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

  • launchType (string) – The launch type to use when filtering the ListServices results.

  • schedulingStrategy (string) – The scheduling strategy to use when filtering the ListServices results.

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 cluster.

      • (string) –

    • nextToken (string) –

      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.

Exceptions

  • ECS.Client.exceptions.ServerException

  • ECS.Client.exceptions.ClientException

  • ECS.Client.exceptions.InvalidParameterException

  • ECS.Client.exceptions.ClusterNotFoundException

Examples

This example lists the services running in the default cluster for an account.

response = client.list_services(
)

print(response)

Expected Output:

{
    'serviceArns': [
        'arn:aws:ecs:us-east-1:012345678910:service/my-http-service',
    ],
    'ResponseMetadata': {
        '...': '...',
    },
}