describe_services¶
Operation¶
describe_services
¶
describe_services(request: DescribeServicesInput | DescribeServicesInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeServicesInputDict]) -> DescribeServicesOutput
Describes the specified services running in your cluster.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
DescribeServicesInput | DescribeServicesInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
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
|
**kwargs
|
Unpack[DescribeServicesInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
DescribeServicesOutput
|
An instance of |
describe_services
async
¶
describe_services(request: DescribeServicesInput | DescribeServicesInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeServicesInputDict]) -> DescribeServicesOutput
Describes the specified services running in your cluster.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
DescribeServicesInput | DescribeServicesInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
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
|
**kwargs
|
Unpack[DescribeServicesInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
DescribeServicesOutput
|
An instance of |
Input¶
Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.
DescribeServicesInputDict
¶
Bases: TypedDict
Dictionary form of DescribeServicesInput.
Attributes¶
cluster
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
instance-attribute
¶
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.
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
¶
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.
Output¶
DescribeServicesOutput
dataclass
¶
Bases: _SerdeShape
Attributes¶
failures
class-attribute
instance-attribute
¶
Any failures associated with the call.
response_metadata
class-attribute
instance-attribute
¶
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.