update_endpoint_group ¶

def update_endpoint_group(
    self,
    endpoint_group_arn: "capo_global_accelerator.types.generic_string.GenericString",
    *,
    config_overrides: Optional[GlobalAcceleratorClientConfig] = None,
    endpoint_configurations: Optional[
        "capo_global_accelerator.types.endpoint_configurations.EndpointConfigurations"
    ] = None,
    traffic_dial_percentage: Optional[
        "capo_global_accelerator.types.traffic_dial_percentage.TrafficDialPercentage"
    ] = None,
    health_check_port: Optional[
        "capo_global_accelerator.types.health_check_port.HealthCheckPort"
    ] = None,
    health_check_protocol: Optional[
        "capo_global_accelerator.types.health_check_protocol.HealthCheckProtocol"
    ] = None,
    health_check_path: Optional[
        "capo_global_accelerator.types.health_check_path.HealthCheckPath"
    ] = None,
    health_check_interval_seconds: Optional[
        "capo_global_accelerator.types.health_check_interval_seconds.HealthCheckIntervalSeconds"
    ] = None,
    threshold_count: Optional[
        "capo_global_accelerator.types.threshold_count.ThresholdCount"
    ] = None,
    port_overrides: Optional[
        "capo_global_accelerator.types.port_overrides.PortOverrides"
    ] = None,
) -> "capo_global_accelerator.types.update_endpoint_group_response.UpdateEndpointGroupResponse":
    """<p>Update an endpoint group. A resource must be valid and active when you add it as an endpoint.</p>

    Args:
        endpoint_group_arn: <p>The Amazon Resource Name (ARN) of the endpoint group.</p>
        endpoint_configurations: <p>The list of endpoint objects. A resource must be valid and active when you add it as an endpoint.</p>
        traffic_dial_percentage: <p>The percentage of traffic to send to an Amazon Web Services Region. Additional traffic is distributed to other endpoint groups for this listener. </p> <p>Use this action to increase (dial up) or decrease (dial down) traffic to a specific Region. The percentage is applied to the traffic that would otherwise have been routed to the Region based on optimal routing.</p> <p>The default value is 100.</p>
        health_check_port: <p>The port that Global Accelerator uses to check the health of endpoints that are part of this endpoint group. The default port is the listener port that this endpoint group is associated with. If the listener port is a list of ports, Global Accelerator uses the first port in the list.</p>
        health_check_protocol: <p>The protocol that Global Accelerator uses to check the health of endpoints that are part of this endpoint group. The default value is TCP.</p>
        health_check_path: <p>If the protocol is HTTP/S, then this specifies the path that is the destination for health check targets. The default value is slash (/).</p>
        health_check_interval_seconds: <p>The time—10 seconds or 30 seconds—between each health check for an endpoint. The default value is 30.</p>
        threshold_count: <p>The number of consecutive health checks required to set the state of a healthy endpoint to unhealthy, or to set an unhealthy endpoint to healthy. The default value is 3.</p>
        port_overrides: <p>Override specific listener ports used to route traffic to endpoints that are part of this endpoint group. For example, you can create a port override in which the listener receives user traffic on ports 80 and 443, but your accelerator routes that traffic to ports 1080 and 1443, respectively, on the endpoints.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/global-accelerator/latest/dg/about-endpoint-groups-port-override.html"> Overriding listener ports</a> in the <i>Global Accelerator Developer Guide</i>.</p>

    Raises:
        capo_global_accelerator.errors.access_denied_exception.AccessDeniedException: <p>You don't have access permission.</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.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.limit_exceeded_exception.LimitExceededException: <p>Processing your request would cause you to exceed an Global Accelerator limit.</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.update_endpoint_group_request.UpdateEndpointGroupRequest]",
    ) -> OperationResponse[
        "capo_global_accelerator.types.update_endpoint_group_response.UpdateEndpointGroupResponse"
    ]:
        import capo_global_accelerator._operations.global_accelerator_v20180706.update_endpoint_group

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("UpdateEndpointGroup")
    )
    input_: capo_global_accelerator.types.update_endpoint_group_request.UpdateEndpointGroupRequest = {
        "endpoint_group_arn": endpoint_group_arn
    }
    if endpoint_configurations is not None:
        input_["endpoint_configurations"] = endpoint_configurations
    if traffic_dial_percentage is not None:
        input_["traffic_dial_percentage"] = traffic_dial_percentage
    if health_check_port is not None:
        input_["health_check_port"] = health_check_port
    if health_check_protocol is not None:
        input_["health_check_protocol"] = health_check_protocol
    if health_check_path is not None:
        input_["health_check_path"] = health_check_path
    if health_check_interval_seconds is not None:
        input_["health_check_interval_seconds"] = health_check_interval_seconds
    if threshold_count is not None:
        input_["threshold_count"] = threshold_count
    if port_overrides is not None:
        input_["port_overrides"] = port_overrides

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