Skip to content

describe_express_gateway_service

Operation

describe_express_gateway_service

describe_express_gateway_service(request: DescribeExpressGatewayServiceInput | DescribeExpressGatewayServiceInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeExpressGatewayServiceInputDict]) -> DescribeExpressGatewayServiceOutput

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.

Parameters:

Name Type Description Default
request DescribeExpressGatewayServiceInput | DescribeExpressGatewayServiceInputDict | 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[DescribeExpressGatewayServiceInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DescribeExpressGatewayServiceOutput

An instance of DescribeExpressGatewayServiceOutput.

describe_express_gateway_service async

describe_express_gateway_service(request: DescribeExpressGatewayServiceInput | DescribeExpressGatewayServiceInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeExpressGatewayServiceInputDict]) -> DescribeExpressGatewayServiceOutput

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.

Parameters:

Name Type Description Default
request DescribeExpressGatewayServiceInput | DescribeExpressGatewayServiceInputDict | 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[DescribeExpressGatewayServiceInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DescribeExpressGatewayServiceOutput

An instance of DescribeExpressGatewayServiceOutput.

Input

Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.

DescribeExpressGatewayServiceInputDict

Bases: TypedDict

Dictionary form of DescribeExpressGatewayServiceInput.

Attributes

include instance-attribute
include: Sequence[str] | None

Specifies additional information to include in the response. Valid values are TAGS to include resource tags associated with the Express service.

service_arn instance-attribute
service_arn: Required[str]

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.

DescribeExpressGatewayServiceInput dataclass

Bases: _SerdeShape

Dataclass for DescribeExpressGatewayServiceInput structure.

Attributes

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

Specifies additional information to include in the response. Valid values are TAGS to include resource tags associated with the Express service.

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

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.

Output

DescribeExpressGatewayServiceOutput dataclass

Bases: _SerdeShape

Dataclass for DescribeExpressGatewayServiceOutput structure.

Attributes

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.

service class-attribute instance-attribute
service: ECSExpressGatewayService | None = ...

The full description of the described express service.