ListServiceDeploymentsRequest Class

Container for the parameters to the ListServiceDeployments operation. 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.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.ECS.AmazonECSRequest
      Amazon.ECS.Model.ListServiceDeploymentsRequest

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

Syntax

public class ListServiceDeploymentsRequest : AmazonECSRequest
         IAmazonWebServiceRequest

The ListServiceDeploymentsRequest type exposes the following members

Constructors

	Name	Description
	ListServiceDeploymentsRequest()

Properties

Name	Type	Description
Cluster	System.String	Gets and sets the property Cluster. The cluster that hosts the service. This can either be the cluster name or ARN. Starting April 15, 2023, Amazon Web Services will not onboard new customers to Amazon Elastic Inference (EI), and will help current customers migrate their workloads to options that offer better price and performance. If you don't specify a cluster, `default` is used.
CreatedAt	Amazon.ECS.Model.CreatedAt	Gets and sets the property CreatedAt. An optional filter you can use to narrow the results by the service creation date. If you do not specify a value, the result includes all services created before the current time. The format is yyyy-MM-dd HH:mm:ss.SSSSSS.
MaxResults	System.Int32	Gets and sets the property MaxResults. The maximum number of service deployment results that `ListServiceDeployments` returned in paginated output. When this parameter is used, `ListServiceDeployments` 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 `ListServiceDeployments` request with the returned `nextToken` value. This value can be between 1 and 100. If this parameter isn't used, then `ListServiceDeployments` returns up to 20 results and a `nextToken` value if applicable.
NextToken	System.String	Gets and sets the property NextToken. The `nextToken` value returned from a `ListServiceDeployments` request indicating that more results are available to fulfill the request and further calls are needed. If you provided `maxResults`, it's possible the number of results is fewer than `maxResults`.
Service	System.String	Gets and sets the property Service. The ARN or name of the service
Status	System.Collections.Generic.List<System.String>	Gets and sets the property Status. An optional filter you can use to narrow the results. If you do not specify a status, then all status values are included in the result.

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:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

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