Returns a list of services. You can filter the results by cluster, launch type, and scheduling strategy.
Request Syntax{
"cluster": "string
",
"launchType": "string
",
"maxResults": number
,
"nextToken": "string
",
"schedulingStrategy": "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.
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.
Type: String
Required: No
The launch type to use when filtering the ListServices
results.
Type: String
Valid Values: EC2 | FARGATE | EXTERNAL
Required: No
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.
Type: Integer
Required: No
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
.
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.
Type: String
Required: No
The scheduling strategy to use when filtering the ListServices
results.
Type: String
Valid Values: REPLICA | DAEMON
Required: No
{
"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.
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.
Type: String
The list of full ARN entries for each service that's associated with the specified cluster.
Type: Array of strings
For information about the errors that are common to all actions, see Common Errors.
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.
HTTP Status Code: 400
The specified cluster wasn't found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region specific.
HTTP Status Code: 400
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.
HTTP Status Code: 400
These errors are usually caused by a server issue.
HTTP Status Code: 500
In the following example or examples, the Authorization header contents (AUTHPARAMS
) must be replaced with an AWS Signature Version 4 signature. For more information, see Signature Version 4 Signing Process in the AWS General Reference.
You only need to learn how to sign HTTP requests if you intend to create them manually. When you use the AWS Command Line Interface or one of the AWS SDKs to make requests to AWS, these tools automatically sign the requests for you, with the access key that you specify when you configure the tools. When you use these tools, you don't have to sign requests yourself.
ExampleThis example request lists the services in the default cluster.
Sample RequestPOST / HTTP/1.1
Host: ecs.us-east-1.amazonaws.com
Accept-Encoding: identity
Content-Length: 2
X-Amz-Target: AmazonEC2ContainerServiceV20141113.ListServices
X-Amz-Date: 20150429T191342Z
Content-Type: application/x-amz-json-1.1
Authorization: AUTHPARAMS
{}
Sample Response
HTTP/1.1 200 OK
Server: Server
Date: Wed, 29 Apr 2015 19:13:42 GMT
Content-Type: application/x-amz-json-1.1
Content-Length: 138
Connection: keep-alive
x-amzn-RequestId: 123a4b56-7c89-01d2-3ef4-example5678f
{
"serviceArns": [
"arn:aws:ecs:us-east-1:012345678910:service/hello_world",
"arn:aws:ecs:us-east-1:012345678910:service/ecs-simple-service"
]
}
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4