Skip to content

disassociate_gateway_from_server

disassociate_gateway_from_server(
    gateway_arn: GatewayArn,
    *,
    config_overrides: Optional[BackupGatewayClientConfig] = None,
) -> DisassociateGatewayFromServerOutput

Disassociates a backup gateway from the specified server. After the disassociation process finishes, the gateway can no longer access the virtual machines on the server.

Parameters:

  • gateway_arn (GatewayArn) –

    The Amazon Resource Name (ARN) of the gateway to disassociate.

Raises:

Source code in docs_src/capo_backup_gateway/_services/backup_gateway.py
def disassociate_gateway_from_server(
    self,
    gateway_arn: "capo_backup_gateway.types.gateway_arn.GatewayArn",
    *,
    config_overrides: Optional[BackupGatewayClientConfig] = None,
) -> "capo_backup_gateway.types.disassociate_gateway_from_server_output.DisassociateGatewayFromServerOutput":
    """<p>Disassociates a backup gateway from the specified server. After the disassociation process finishes, the gateway can no longer access the virtual machines on the server.</p>

    Args:
        gateway_arn: <p>The Amazon Resource Name (ARN) of the gateway to disassociate.</p>

    Raises:
        capo_backup_gateway.errors.internal_server_exception.InternalServerException: <p>The operation did not succeed because an internal error occurred. Try again later.</p>
        capo_backup_gateway.errors.throttling_exception.ThrottlingException: <p>TPS has been limited to protect against intentional or unintentional high request volumes.</p>
        capo_backup_gateway.errors.validation_exception.ValidationException: <p>The operation did not succeed because a validation error occurred.</p>
        capo_backup_gateway.errors.conflict_exception.ConflictException: <p>The operation cannot proceed because it is not supported.</p>
        capo_backup_gateway.errors.resource_not_found_exception.ResourceNotFoundException: <p>A resource that is required for the action wasn't found.</p>
        capo_backup_gateway.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_backup_gateway.types.disassociate_gateway_from_server_input.DisassociateGatewayFromServerInput]",
    ) -> OperationResponse[
        "capo_backup_gateway.types.disassociate_gateway_from_server_output.DisassociateGatewayFromServerOutput"
    ]:
        import capo_backup_gateway._operations.backup_on_premises_v20210101.disassociate_gateway_from_server

        output, http_response = (
            capo_backup_gateway._operations.backup_on_premises_v20210101.disassociate_gateway_from_server.disassociate_gateway_from_server(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DisassociateGatewayFromServer")
    )
    input_: capo_backup_gateway.types.disassociate_gateway_from_server_input.DisassociateGatewayFromServerInput = {
        "gateway_arn": gateway_arn
    }

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output