Skip to content

delete_express_gateway_service

Operation

delete_express_gateway_service

delete_express_gateway_service(request: DeleteExpressGatewayServiceInput | DeleteExpressGatewayServiceInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DeleteExpressGatewayServiceInputDict]) -> DeleteExpressGatewayServiceOutput

Deletes an Express service and removes all associated Amazon Web Services resources. This operation stops service tasks, removes the Application Load Balancer, target groups, security groups, auto-scaling policies, and other managed infrastructure components.

The service enters a DRAINING state where existing tasks complete current requests without starting new tasks. After all tasks stop, the service and infrastructure are permanently removed.

This operation cannot be reversed. Back up important data and verify the service is no longer needed before deletion.

Parameters:

Name Type Description Default
request DeleteExpressGatewayServiceInput | DeleteExpressGatewayServiceInputDict | 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[DeleteExpressGatewayServiceInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DeleteExpressGatewayServiceOutput

An instance of DeleteExpressGatewayServiceOutput.

delete_express_gateway_service async

delete_express_gateway_service(request: DeleteExpressGatewayServiceInput | DeleteExpressGatewayServiceInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DeleteExpressGatewayServiceInputDict]) -> DeleteExpressGatewayServiceOutput

Deletes an Express service and removes all associated Amazon Web Services resources. This operation stops service tasks, removes the Application Load Balancer, target groups, security groups, auto-scaling policies, and other managed infrastructure components.

The service enters a DRAINING state where existing tasks complete current requests without starting new tasks. After all tasks stop, the service and infrastructure are permanently removed.

This operation cannot be reversed. Back up important data and verify the service is no longer needed before deletion.

Parameters:

Name Type Description Default
request DeleteExpressGatewayServiceInput | DeleteExpressGatewayServiceInputDict | 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[DeleteExpressGatewayServiceInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DeleteExpressGatewayServiceOutput

An instance of DeleteExpressGatewayServiceOutput.

Input

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

DeleteExpressGatewayServiceInputDict

Bases: TypedDict

Dictionary form of DeleteExpressGatewayServiceInput.

Attributes

service_arn instance-attribute
service_arn: Required[str]

The Amazon Resource Name (ARN) of the Express service to delete. The ARN uniquely identifies the service within your Amazon Web Services account and region.

DeleteExpressGatewayServiceInput dataclass

Bases: _SerdeShape

Dataclass for DeleteExpressGatewayServiceInput structure.

Attributes

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

The Amazon Resource Name (ARN) of the Express service to delete. The ARN uniquely identifies the service within your Amazon Web Services account and region.

Output

DeleteExpressGatewayServiceOutput dataclass

Bases: _SerdeShape

Dataclass for DeleteExpressGatewayServiceOutput 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 deleted express service.