Skip to content

Describe Service Deployments

ecs_describe_service_deployments R Documentation

Describes one or more of your service deployments

Description

Describes one or more of your service deployments.

A service deployment happens when you release a software update for the service. For more information, see View service history using Amazon ECS service deployments.

Usage

ecs_describe_service_deployments(serviceDeploymentArns)

Arguments

serviceDeploymentArns

[required] The ARN of the service deployment.

You can specify a maximum of 20 ARNs.

Value

A list with the following syntax:

list(
  serviceDeployments = list(
    list(
      serviceDeploymentArn = "string",
      serviceArn = "string",
      clusterArn = "string",
      createdAt = as.POSIXct(
        "2015-01-01"
      ),
      startedAt = as.POSIXct(
        "2015-01-01"
      ),
      finishedAt = as.POSIXct(
        "2015-01-01"
      ),
      stoppedAt = as.POSIXct(
        "2015-01-01"
      ),
      updatedAt = as.POSIXct(
        "2015-01-01"
      ),
      sourceServiceRevisions = list(
        list(
          arn = "string",
          requestedTaskCount = 123,
          runningTaskCount = 123,
          pendingTaskCount = 123,
          requestedTestTrafficWeight = 123.0,
          requestedProductionTrafficWeight = 123.0
        )
      ),
      targetServiceRevision = list(
        arn = "string",
        requestedTaskCount = 123,
        runningTaskCount = 123,
        pendingTaskCount = 123,
        requestedTestTrafficWeight = 123.0,
        requestedProductionTrafficWeight = 123.0
      ),
      status = "PENDING"|"SUCCESSFUL"|"STOPPED"|"STOP_REQUESTED"|"IN_PROGRESS"|"ROLLBACK_REQUESTED"|"ROLLBACK_IN_PROGRESS"|"ROLLBACK_SUCCESSFUL"|"ROLLBACK_FAILED",
      statusReason = "string",
      lifecycleStage = "RECONCILE_SERVICE"|"PRE_SCALE_UP"|"SCALE_UP"|"POST_SCALE_UP"|"TEST_TRAFFIC_SHIFT"|"POST_TEST_TRAFFIC_SHIFT"|"PRODUCTION_TRAFFIC_SHIFT"|"POST_PRODUCTION_TRAFFIC_SHIFT"|"BAKE_TIME"|"CLEAN_UP",
      lifecycleHookDetails = list(
        list(
          hookId = "string",
          targetType = "AWS_LAMBDA"|"PAUSE",
          targetArn = "string",
          status = "AWAITING_ACTION"|"IN_PROGRESS"|"SUCCEEDED"|"FAILED"|"TIMED_OUT",
          expiresAt = as.POSIXct(
            "2015-01-01"
          ),
          timeoutAction = "ROLLBACK"|"CONTINUE"
        )
      ),
      deploymentConfiguration = list(
        deploymentCircuitBreaker = list(
          enable = TRUE|FALSE,
          rollback = TRUE|FALSE
        ),
        maximumPercent = 123,
        minimumHealthyPercent = 123,
        alarms = list(
          alarmNames = list(
            "string"
          ),
          rollback = TRUE|FALSE,
          enable = TRUE|FALSE
        ),
        strategy = "ROLLING"|"BLUE_GREEN"|"LINEAR"|"CANARY",
        bakeTimeInMinutes = 123,
        lifecycleHooks = list(
          list(
            targetType = "AWS_LAMBDA"|"PAUSE",
            hookTargetArn = "string",
            roleArn = "string",
            lifecycleStages = list(
              "RECONCILE_SERVICE"|"PRE_SCALE_UP"|"POST_SCALE_UP"|"TEST_TRAFFIC_SHIFT"|"POST_TEST_TRAFFIC_SHIFT"|"PRE_PRODUCTION_TRAFFIC_SHIFT"|"PRODUCTION_TRAFFIC_SHIFT"|"POST_PRODUCTION_TRAFFIC_SHIFT"
            ),
            hookDetails = list(),
            timeoutConfiguration = list(
              timeoutInMinutes = 123,
              action = "ROLLBACK"|"CONTINUE"
            )
          )
        ),
        linearConfiguration = list(
          stepPercent = 123.0,
          stepBakeTimeInMinutes = 123
        ),
        canaryConfiguration = list(
          canaryPercent = 123.0,
          canaryBakeTimeInMinutes = 123
        )
      ),
      rollback = list(
        reason = "string",
        startedAt = as.POSIXct(
          "2015-01-01"
        ),
        serviceRevisionArn = "string"
      ),
      deploymentCircuitBreaker = list(
        status = "TRIGGERED"|"MONITORING"|"MONITORING_COMPLETE"|"DISABLED",
        failureCount = 123,
        threshold = 123
      ),
      alarms = list(
        status = "TRIGGERED"|"MONITORING"|"MONITORING_COMPLETE"|"DISABLED",
        alarmNames = list(
          "string"
        ),
        triggeredAlarmNames = list(
          "string"
        )
      )
    )
  ),
  failures = list(
    list(
      arn = "string",
      reason = "string",
      detail = "string"
    )
  )
)

Request syntax

svc$describe_service_deployments(
  serviceDeploymentArns = list(
    "string"
  )
)