deregister_gateway_instance `async` ¶

deregister_gateway_instance(
    gateway_instance_arn: GatewayInstanceArn,
    *,
    config_overrides: Optional[AsyncMediaConnectClientConfig] = None,
    force: Optional[bool] = None,
) -> DeregisterGatewayInstanceResponse

Deregisters an instance. Before you deregister an instance, all bridges running on the instance must be stopped. If you want to deregister an instance without stopping the bridges, you must use the --force option.

Parameters:

force (Optional[bool], default: None ) –

Force the deregistration of an instance. Force will deregister an instance, even if there are bridges running on it.
gateway_instance_arn (GatewayInstanceArn) –

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

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 deregister_gateway_instance(
    self,
    gateway_instance_arn: "capo_mediaconnect.types.gateway_instance_arn.GatewayInstanceArn",
    *,
    config_overrides: Optional[AsyncMediaConnectClientConfig] = None,
    force: Optional[bool] = None,
) -> "capo_mediaconnect.types.deregister_gateway_instance_response.DeregisterGatewayInstanceResponse":
    """<p> Deregisters an instance. Before you deregister an instance, all bridges running on the instance must be stopped. If you want to deregister an instance without stopping the bridges, you must use the --force option.</p>

    Args:
        force: <p> Force the deregistration of an instance. Force will deregister an instance, even if there are bridges running on it.</p>
        gateway_instance_arn: <p> The Amazon Resource Name (ARN) of the gateway that contains the instance that you want to deregister.</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.deregister_gateway_instance_request.DeregisterGatewayInstanceRequest]",
    ) -> AsyncOperationResponse[
        "capo_mediaconnect.types.deregister_gateway_instance_response.DeregisterGatewayInstanceResponse"
    ]:
        import capo_mediaconnect._operations.media_connect.deregister_gateway_instance

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DeregisterGatewayInstance")
    )
    input_: capo_mediaconnect.types.deregister_gateway_instance_request.DeregisterGatewayInstanceRequest = {
        "gateway_instance_arn": gateway_instance_arn
    }
    if force is not None:
        input_["force"] = force

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

deregister_gateway_instance async ¶

deregister_gateway_instance `async` ¶