update_gateway¶
Operation¶
async
¶
update_gateway(input: UpdateGatewayInput, plugins: list[Plugin] | None = None) -> UpdateGatewayOutput
Modifies the configuration of a gateway. You can change only the
properties that can be applied without interrupting traffic, and the
configuration variant that you provide must match the gateway's type.
UpdateGateway is an asynchronous operation: the changes are applied to
each load balancer the gateway manages, and the gateway reports a status
of UPDATE_IN_PROGRESS until the update completes. If Amazon ECS can't
update one or more resources, it makes a best effort to update the rest
and the gateway status changes to UPDATE_FAILED. Use DescribeGateway
to inspect the gateway's statusReason and failures list, which gives
the ARN of each load balancer that was not updated and the operation,
error code, and message for each failure.
If you specify infrastructureRoleArn, you must have the iam:PassRole
permission for that role.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
UpdateGatewayInput
|
An instance of |
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 |
|---|---|
UpdateGatewayOutput
|
An instance of |
Input¶
dataclass
¶
Bases: _SerdeShape
Dataclass for UpdateGatewayInput structure.
Attributes¶
class-attribute
instance-attribute
¶
The updated type-specific configuration for the gateway. The configuration variant must match the gateway's existing type, and only mutable fields can be changed.
class-attribute
instance-attribute
¶
deletion_protection: bool | None = ...
Specifies whether to enable deletion protection for the gateway. When enabled, the gateway can't be deleted.
class-attribute
instance-attribute
¶
gateway: str | None = ...
The name or Amazon Resource Name (ARN) of the gateway to update.
Output¶
dataclass
¶
Bases: _SerdeShape
Dataclass for UpdateGatewayOutput structure.
Attributes¶
class-attribute
instance-attribute
¶
gateway_arn: str | None = ...
The Amazon Resource Name (ARN) of the gateway.
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.