Skip to content

modify_transit_gateway

Operation

modify_transit_gateway

modify_transit_gateway(request: ModifyTransitGatewayInput | ModifyTransitGatewayInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ModifyTransitGatewayInputDict]) -> ModifyTransitGatewayOutput

Modifies the specified transit gateway. When you modify a transit gateway, the modified options are applied to new transit gateway attachments only. Your existing transit gateway attachments are not modified.

Parameters:

Name Type Description Default
request ModifyTransitGatewayInput | ModifyTransitGatewayInputDict | 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[ModifyTransitGatewayInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
ModifyTransitGatewayOutput

An instance of ModifyTransitGatewayOutput.

modify_transit_gateway async

modify_transit_gateway(request: ModifyTransitGatewayInput | ModifyTransitGatewayInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ModifyTransitGatewayInputDict]) -> ModifyTransitGatewayOutput

Modifies the specified transit gateway. When you modify a transit gateway, the modified options are applied to new transit gateway attachments only. Your existing transit gateway attachments are not modified.

Parameters:

Name Type Description Default
request ModifyTransitGatewayInput | ModifyTransitGatewayInputDict | 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[ModifyTransitGatewayInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
ModifyTransitGatewayOutput

An instance of ModifyTransitGatewayOutput.

Input

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

ModifyTransitGatewayInputDict

Bases: TypedDict

Dictionary form of ModifyTransitGatewayInput.

Attributes

description instance-attribute
description: str | None

The description for the transit gateway.

dry_run instance-attribute
dry_run: bool | None

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

options instance-attribute

The options to modify.

transit_gateway_id instance-attribute
transit_gateway_id: Required[str]

The ID of the transit gateway.

ModifyTransitGatewayInput dataclass

Bases: _SerdeShape

Dataclass for ModifyTransitGatewayInput structure.

Attributes

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

The description for the transit gateway.

dry_run class-attribute instance-attribute
dry_run: bool | None = ...

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

options class-attribute instance-attribute
options: ModifyTransitGatewayOptions | None = ...

The options to modify.

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

The ID of the transit gateway.

Output

ModifyTransitGatewayOutput dataclass

Bases: _SerdeShape

Dataclass for ModifyTransitGatewayOutput 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.

transit_gateway class-attribute instance-attribute
transit_gateway: TransitGateway | None = ...

Information about the transit gateway.