Describe Express Gateway Service

ecs_describe_express_gateway_service

R Documentation

Retrieves detailed information about an Express service, including current status, configuration, managed infrastructure, and service revisions

Description

Retrieves detailed information about an Express service, including current status, configuration, managed infrastructure, and service revisions.

Returns comprehensive service details, active service revisions, ingress paths with endpoints, and managed Amazon Web Services resource status including load balancers and auto-scaling policies.

Use the include parameter to retrieve additional information such as resource tags.

Usage

ecs_describe_express_gateway_service(serviceArn, include)

Arguments

serviceArn	[required] The Amazon Resource Name (ARN) of the Express service to describe. The ARN uniquely identifies the service within your Amazon Web Services account and region.
include	Specifies additional information to include in the response. Valid values are TAGS to include resource tags associated with the Express service.

Value

A list with the following syntax:

list(
  service = list(
    cluster = "string",
    serviceName = "string",
    serviceArn = "string",
    infrastructureRoleArn = "string",
    status = list(
      statusCode = "ACTIVE"|"DRAINING"|"INACTIVE",
      statusReason = "string"
    ),
    currentDeployment = "string",
    activeConfigurations = list(
      list(
        serviceRevisionArn = "string",
        executionRoleArn = "string",
        taskRoleArn = "string",
        cpu = "string",
        memory = "string",
        networkConfiguration = list(
          securityGroups = list(
            "string"
          ),
          subnets = list(
            "string"
          )
        ),
        healthCheckPath = "string",
        primaryContainer = list(
          image = "string",
          containerPort = 123,
          awsLogsConfiguration = list(
            logGroup = "string",
            logStreamPrefix = "string"
          ),
          repositoryCredentials = list(
            credentialsParameter = "string"
          ),
          command = list(
            "string"
          ),
          environment = list(
            list(
              name = "string",
              value = "string"
            )
          ),
          secrets = list(
            list(
              name = "string",
              valueFrom = "string"
            )
          )
        ),
        scalingTarget = list(
          minTaskCount = 123,
          maxTaskCount = 123,
          autoScalingMetric = "AVERAGE_CPU"|"AVERAGE_MEMORY"|"REQUEST_COUNT_PER_TARGET",
          autoScalingTargetValue = 123
        ),
        ingressPaths = list(
          list(
            accessType = "PUBLIC"|"PRIVATE",
            endpoint = "string"
          )
        ),
        createdAt = as.POSIXct(
          "2015-01-01"
        )
      )
    ),
    tags = list(
      list(
        key = "string",
        value = "string"
      )
    ),
    createdAt = as.POSIXct(
      "2015-01-01"
    ),
    updatedAt = as.POSIXct(
      "2015-01-01"
    )
  )
)

Request syntax

svc$describe_express_gateway_service(
  serviceArn = "string",
  include = list(
    "TAGS"
  )
)