modify_transit_gateway `async` ¶

modify_transit_gateway(
    *,
    config_overrides: Optional[AsyncEC2ClientConfig] = None,
    transit_gateway_id: Optional[TransitGatewayId] = None,
    description: Optional[String] = None,
    options: Optional[ModifyTransitGatewayOptions] = None,
    dry_run: Optional[Boolean] = None,
) -> ModifyTransitGatewayResult

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:

transit_gateway_id (Optional[TransitGatewayId], default: None ) –

The ID of the transit gateway.
description (Optional[String], default: None ) –

The description for the transit gateway.
options (Optional[ModifyTransitGatewayOptions], default: None ) –

The options to modify.
dry_run (Optional[Boolean], default: 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.

Raises:

UnknownServiceError –

The service returned an error code this client does not model.

Source code in docs_src/capo_ec2/_services/async_ec2.py

async def modify_transit_gateway(
    self,
    *,
    config_overrides: Optional[AsyncEC2ClientConfig] = None,
    transit_gateway_id: Optional[
        "capo_ec2.types.transit_gateway_id.TransitGatewayId"
    ] = None,
    description: Optional["capo_ec2.types.string.String"] = None,
    options: Optional[
        "capo_ec2.types.modify_transit_gateway_options.ModifyTransitGatewayOptions"
    ] = None,
    dry_run: Optional["capo_ec2.types.boolean.Boolean"] = None,
) -> "capo_ec2.types.modify_transit_gateway_result.ModifyTransitGatewayResult":
    """<p>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.</p>

    Args:
        transit_gateway_id: <p>The ID of the transit gateway.</p>
        description: <p>The description for the transit gateway.</p>
        options: <p>The options to modify.</p>
        dry_run: <p>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 <code>DryRunOperation</code>. Otherwise, it is <code>UnauthorizedOperation</code>.</p>

    Raises:
        capo_ec2.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_ec2.types.modify_transit_gateway_request.ModifyTransitGatewayRequest]",
    ) -> AsyncOperationResponse[
        "capo_ec2.types.modify_transit_gateway_result.ModifyTransitGatewayResult"
    ]:
        import capo_ec2._operations.amazon_ec2.modify_transit_gateway

        (
            output,
            http_response,
        ) = await capo_ec2._operations.amazon_ec2.modify_transit_gateway.async_modify_transit_gateway(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ModifyTransitGateway")
    )
    input_: capo_ec2.types.modify_transit_gateway_request.ModifyTransitGatewayRequest = {}
    if transit_gateway_id is not None:
        input_["transit_gateway_id"] = transit_gateway_id
    if description is not None:
        input_["description"] = description
    if options is not None:
        input_["options"] = options
    if dry_run is not None:
        input_["dry_run"] = dry_run

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output

modify_transit_gateway async ¶

modify_transit_gateway `async` ¶