update_gateway_instance `async` ¶

update_gateway_instance(
    gateway_instance_arn: GatewayInstanceArn,
    *,
    config_overrides: Optional[AsyncMediaConnectClientConfig] = None,
    bridge_placement: Optional[BridgePlacement] = None,
) -> UpdateGatewayInstanceResponse

Updates an existing gateway instance.

Parameters:

bridge_placement (Optional[BridgePlacement], default: None ) –

The state of the instance. ACTIVE or INACTIVE.
gateway_instance_arn (GatewayInstanceArn) –

The Amazon Resource Name (ARN) of the gateway instance that you want to update.

Raises:

BadRequestException –

This exception is thrown if the request contains a semantic error. The precise meaning depends on the API, and is documented in the error message.
ConflictException –

The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request.
ForbiddenException –

You do not have sufficient access to perform this action.
InternalServerErrorException –

The server encountered an internal error and is unable to complete the request.
NotFoundException –

One or more of the resources in the request does not exist in the system.
ServiceUnavailableException –

The service is currently unavailable or busy.
TooManyRequestsException –

The request was denied due to request throttling.
UnknownServiceError –

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

Source code in docs_src/capo_mediaconnect/_services/async_media_connect.py

async def update_gateway_instance(
    self,
    gateway_instance_arn: "capo_mediaconnect.types.gateway_instance_arn.GatewayInstanceArn",
    *,
    config_overrides: Optional[AsyncMediaConnectClientConfig] = None,
    bridge_placement: Optional[
        "capo_mediaconnect.types.bridge_placement.BridgePlacement"
    ] = None,
) -> "capo_mediaconnect.types.update_gateway_instance_response.UpdateGatewayInstanceResponse":
    """<p>Updates an existing gateway instance. </p>

    Args:
        bridge_placement: <p>The state of the instance. <code>ACTIVE</code> or <code>INACTIVE</code>. </p>
        gateway_instance_arn: <p>The Amazon Resource Name (ARN) of the gateway instance that you want to update. </p>

    Raises:
        capo_mediaconnect.errors.bad_request_exception.BadRequestException: <p>This exception is thrown if the request contains a semantic error. The precise meaning depends on the API, and is documented in the error message. </p>
        capo_mediaconnect.errors.conflict_exception.ConflictException: <p>The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request. </p>
        capo_mediaconnect.errors.forbidden_exception.ForbiddenException: <p>You do not have sufficient access to perform this action. </p>
        capo_mediaconnect.errors.internal_server_error_exception.InternalServerErrorException: <p>The server encountered an internal error and is unable to complete the request. </p>
        capo_mediaconnect.errors.not_found_exception.NotFoundException: <p>One or more of the resources in the request does not exist in the system. </p>
        capo_mediaconnect.errors.service_unavailable_exception.ServiceUnavailableException: <p>The service is currently unavailable or busy. </p>
        capo_mediaconnect.errors.too_many_requests_exception.TooManyRequestsException: <p>The request was denied due to request throttling. </p>
        capo_mediaconnect.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_mediaconnect.types.update_gateway_instance_request.UpdateGatewayInstanceRequest]",
    ) -> AsyncOperationResponse[
        "capo_mediaconnect.types.update_gateway_instance_response.UpdateGatewayInstanceResponse"
    ]:
        import capo_mediaconnect._operations.media_connect.update_gateway_instance

        (
            output,
            http_response,
        ) = await capo_mediaconnect._operations.media_connect.update_gateway_instance.async_update_gateway_instance(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("UpdateGatewayInstance")
    )
    input_: capo_mediaconnect.types.update_gateway_instance_request.UpdateGatewayInstanceRequest = {
        "gateway_instance_arn": gateway_instance_arn
    }
    if bridge_placement is not None:
        input_["bridge_placement"] = bridge_placement

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

update_gateway_instance async ¶

update_gateway_instance `async` ¶