AmazonECSClient.ListServiceDeployments Method (ListServiceDeploymentsRequest)

This operation lists all the service deployments that meet the specified filter criteria.

A service deployment happens when you release a software update for the service. You route traffic from the running service revisions to the new service revison and control the number of running tasks.

This API returns the values that you use for the request parameters in DescribeServiceRevisions.

Note:

For .NET Core this operation is only available in asynchronous form. Please refer to ListServiceDeploymentsAsync.

Namespace: Amazon.ECS
Assembly: AWSSDK.ECS.dll
Version: 3.x.y.z

Syntax

public virtual ListServiceDeploymentsResponse ListServiceDeployments(
         ListServiceDeploymentsRequest request
)

Parameters

request: Type: Amazon.ECS.Model.ListServiceDeploymentsRequest

Container for the necessary parameters to execute the ListServiceDeployments service method.

Return Value

Type: ListServiceDeploymentsResponse

The response from the ListServiceDeployments service method, as returned by ECS.

Exceptions

Exception	Condition
AccessDeniedException	You don't have authorization to perform the requested action.
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.
InvalidParameterException	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.
ServerException	These errors are usually caused by a server issue.
ServiceNotFoundException	The specified service wasn't found. You can view your available services with ListServices. Amazon ECS services are cluster specific and Region specific.
UnsupportedFeatureException	The specified task isn't supported in this Region.

Examples

This example lists all successful service deployments for the service "sd-example" in the cluster "example".

To list service deployments that meet the specified criteria


var client = new AmazonECSClient();
var response = client.ListServiceDeployments(new ListServiceDeploymentsRequest 
{
    Cluster = "example",
    Service = "sd-example",
    Status = new List<string> {
        "SUCCESSFUL"
    }
});

List<ServiceDeploymentBrief> serviceDeployments = response.ServiceDeployments;

Version Information

.NET Framework:
Supported in: 4.5 and newer, 3.5

AmazonECSClient.ListServiceDeployments (ListServiceDeploymentsRequest)

Method