Skip to content

remove_custom_routing_endpoints

remove_custom_routing_endpoints(
    endpoint_ids: EndpointIds,
    endpoint_group_arn: GenericString,
    *,
    config_overrides: Optional[GlobalAcceleratorClientConfig] = None,
) -> None

Remove endpoints from a custom routing accelerator.

Parameters:

  • endpoint_ids (EndpointIds) –

    The IDs for the endpoints. For custom routing accelerators, endpoint IDs are the virtual private cloud (VPC) subnet IDs.

  • endpoint_group_arn (GenericString) –

    The Amazon Resource Name (ARN) of the endpoint group to remove endpoints from.

Raises:

Source code in docs_src/capo_global_accelerator/_services/global_accelerator.py
def remove_custom_routing_endpoints(
    self,
    endpoint_ids: "capo_global_accelerator.types.endpoint_ids.EndpointIds",
    endpoint_group_arn: "capo_global_accelerator.types.generic_string.GenericString",
    *,
    config_overrides: Optional[GlobalAcceleratorClientConfig] = None,
) -> None:
    """<p>Remove endpoints from a custom routing accelerator.</p>

    Args:
        endpoint_ids: <p>The IDs for the endpoints. For custom routing accelerators, endpoint IDs are the virtual private cloud (VPC) subnet IDs. </p>
        endpoint_group_arn: <p>The Amazon Resource Name (ARN) of the endpoint group to remove endpoints from.</p>

    Raises:
        capo_global_accelerator.errors.access_denied_exception.AccessDeniedException: <p>You don't have access permission.</p>
        capo_global_accelerator.errors.conflict_exception.ConflictException: <p>You can't use both of those options.</p>
        capo_global_accelerator.errors.endpoint_group_not_found_exception.EndpointGroupNotFoundException: <p>The endpoint group that you specified doesn't exist.</p>
        capo_global_accelerator.errors.endpoint_not_found_exception.EndpointNotFoundException: <p>The endpoint that you specified doesn't exist.</p>
        capo_global_accelerator.errors.internal_service_error_exception.InternalServiceErrorException: <p>There was an internal error for Global Accelerator.</p>
        capo_global_accelerator.errors.invalid_argument_exception.InvalidArgumentException: <p>An argument that you specified is invalid.</p>
        capo_global_accelerator.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_global_accelerator.types.remove_custom_routing_endpoints_request.RemoveCustomRoutingEndpointsRequest]",
    ) -> OperationResponse[None]:
        import capo_global_accelerator._operations.global_accelerator_v20180706.remove_custom_routing_endpoints

        output, http_response = (
            capo_global_accelerator._operations.global_accelerator_v20180706.remove_custom_routing_endpoints.remove_custom_routing_endpoints(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("RemoveCustomRoutingEndpoints")
    )
    input_: capo_global_accelerator.types.remove_custom_routing_endpoints_request.RemoveCustomRoutingEndpointsRequest = {
        "endpoint_ids": endpoint_ids,
        "endpoint_group_arn": endpoint_group_arn,
    }

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