Skip to content

List Service Deployments

ecs_list_service_deployments R Documentation

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

Description

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

Usage

ecs_list_service_deployments(service, cluster, status, createdAt,
  nextToken, maxResults)

Arguments

service

[required] The ARN or name of the service

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.

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.

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.

nextToken

The nextToken value returned from a list_service_deployments 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.

maxResults

The maximum number of service deployment results that list_service_deployments returned in paginated output. When this parameter is used, list_service_deployments 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 list_service_deployments request with the returned nextToken value. This value can be between 1 and 100. If this parameter isn't used, then list_service_deployments returns up to 20 results and a nextToken value if applicable.

Value

A list with the following syntax: 

list(
  serviceDeployments = list(
    list(
      serviceDeploymentArn = "string",
      serviceArn = "string",
      clusterArn = "string",
      startedAt = as.POSIXct(
        "2015-01-01"
      ),
      createdAt = as.POSIXct(
        "2015-01-01"
      ),
      finishedAt = as.POSIXct(
        "2015-01-01"
      ),
      targetServiceRevisionArn = "string",
      status = "PENDING"|"SUCCESSFUL"|"STOPPED"|"STOP_REQUESTED"|"IN_PROGRESS"|"ROLLBACK_IN_PROGRESS"|"ROLLBACK_SUCCESSFUL"|"ROLLBACK_FAILED",
      statusReason = "string"
    )
  ),
  nextToken = "string"
)

Request syntax

svc$list_service_deployments(
  service = "string",
  cluster = "string",
  status = list(
    "PENDING"|"SUCCESSFUL"|"STOPPED"|"STOP_REQUESTED"|"IN_PROGRESS"|"ROLLBACK_IN_PROGRESS"|"ROLLBACK_SUCCESSFUL"|"ROLLBACK_FAILED"
  ),
  createdAt = list(
    before = as.POSIXct(
      "2015-01-01"
    ),
    after = as.POSIXct(
      "2015-01-01"
    )
  ),
  nextToken = "string",
  maxResults = 123
)