Skip to content

ECS  >  Operations  >  describe_services

describe_services

Operation

describe_services async

describe_services(input: DescribeServicesInput, plugins: list[Plugin] | None = None) -> DescribeServicesOutput

Describes the specified services running in your cluster.

Parameters:

Name Type Description Default
input DescribeServicesInput

An instance of DescribeServicesInput.

required
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None

Returns:

Type Description
DescribeServicesOutput

An instance of DescribeServicesOutput.

Input

DescribeServicesInput dataclass

Bases: _SerdeShape

Attributes

cluster class-attribute instance-attribute
cluster: str | None = ...

The short name or full Amazon Resource Name (ARN)the cluster that hosts the service to describe. If you do not specify a cluster, the default cluster is assumed. This parameter is required if the service or services you are describing were launched in any cluster other than the default cluster.

include class-attribute instance-attribute
include: list[str] | None = ...

Determines whether you want to see the resource tags for the service. If TAGS is specified, the tags are included in the response. If this field is omitted, tags aren't included in the response.

services class-attribute instance-attribute
services: list[str] | None = ...

A list of services to describe. You may specify up to 10 services to describe in a single operation.

Output

DescribeServicesOutput dataclass

Bases: _SerdeShape

Attributes

failures class-attribute instance-attribute
failures: list[Failure] | None = ...

Any failures associated with the call.

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.

services class-attribute instance-attribute
services: list[Service] | None = ...

The list of services described.