update_link `async` ¶

update_link(
    gateway_id: GatewayId,
    link_id: LinkId,
    *,
    config_overrides: Optional[AsyncRTBFabricClientConfig] = None,
    log_settings: Optional[LinkLogSettings] = None,
    timeout_in_millis: Optional[LinkTimeoutInMillis] = None,
) -> UpdateLinkResponse

Updates the configuration of a link between gateways.

Allows you to modify settings and parameters for an existing link.

Parameters:

gateway_id (GatewayId) –

The unique identifier of the gateway.
link_id (LinkId) –

The unique identifier of the link.
log_settings (Optional[LinkLogSettings], default: None ) –

Settings for the application logs.
timeout_in_millis (Optional[LinkTimeoutInMillis], default: None ) –

The timeout value in milliseconds.

Raises:

AccessDeniedException –

The request could not be completed because you do not have sufficient access to perform this action.
ConflictException –

The request could not be completed because of a conflict in the current state of the resource.
InternalServerException –

The request could not be completed because of an internal server error. Try your call again.
ResourceNotFoundException –

The request could not be completed because the resource does not exist.
ThrottlingException –

The request was denied due to request throttling.
ValidationException –

The request could not be completed because it fails satisfy the constraints specified by the service.
UnknownServiceError –

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

Examples:

Update link settings Updates configuration settings for an existing link

>>> await client.update_link(gateway_id='rtb-gw-12345678', link_id='link-87654321', log_settings={'applicationLogs': {'sampling': {'errorLog': 100.0, 'filterLog': 10.0}}})

Source code in docs_src/capo_rtbfabric/_services/async_rtb_fabric.py

async def update_link(
    self,
    gateway_id: "capo_rtbfabric.types.gateway_id.GatewayId",
    link_id: "capo_rtbfabric.types.link_id.LinkId",
    *,
    config_overrides: Optional[AsyncRTBFabricClientConfig] = None,
    log_settings: Optional[
        "capo_rtbfabric.types.link_log_settings.LinkLogSettings"
    ] = None,
    timeout_in_millis: Optional[
        "capo_rtbfabric.types.link_timeout_in_millis.LinkTimeoutInMillis"
    ] = None,
) -> "capo_rtbfabric.types.update_link_response.UpdateLinkResponse":
    """<p>Updates the configuration of a link between gateways.</p> <p>Allows you to modify settings and parameters for an existing link.</p>

    Args:
        gateway_id: <p>The unique identifier of the gateway.</p>
        link_id: <p>The unique identifier of the link.</p>
        log_settings: <p>Settings for the application logs.</p>
        timeout_in_millis: <p>The timeout value in milliseconds.</p>

    Raises:
        capo_rtbfabric.errors.access_denied_exception.AccessDeniedException: <p>The request could not be completed because you do not have sufficient access to perform this action.</p>
        capo_rtbfabric.errors.conflict_exception.ConflictException: <p>The request could not be completed because of a conflict in the current state of the resource.</p>
        capo_rtbfabric.errors.internal_server_exception.InternalServerException: <p>The request could not be completed because of an internal server error. Try your call again.</p>
        capo_rtbfabric.errors.resource_not_found_exception.ResourceNotFoundException: <p>The request could not be completed because the resource does not exist.</p>
        capo_rtbfabric.errors.throttling_exception.ThrottlingException: <p>The request was denied due to request throttling.</p>
        capo_rtbfabric.errors.validation_exception.ValidationException: <p>The request could not be completed because it fails satisfy the constraints specified by the service.</p>
        capo_rtbfabric.errors.UnknownServiceError: The service returned an error code this client does not model.

    Examples:
        Update link settings
        Updates configuration settings for an existing link

        >>> await client.update_link(gateway_id='rtb-gw-12345678', link_id='link-87654321', log_settings={'applicationLogs': {'sampling': {'errorLog': 100.0, 'filterLog': 10.0}}})
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_rtbfabric.types.update_link_request.UpdateLinkRequest]",
    ) -> AsyncOperationResponse[
        "capo_rtbfabric.types.update_link_response.UpdateLinkResponse"
    ]:
        import capo_rtbfabric._operations.rtb_fabric.update_link

        (
            output,
            http_response,
        ) = await capo_rtbfabric._operations.rtb_fabric.update_link.async_update_link(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("UpdateLink")
    )
    input_: capo_rtbfabric.types.update_link_request.UpdateLinkRequest = {
        "gateway_id": gateway_id,
        "link_id": link_id,
    }
    if log_settings is not None:
        input_["log_settings"] = log_settings
    if timeout_in_millis is not None:
        input_["timeout_in_millis"] = timeout_in_millis

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

update_link async ¶

update_link `async` ¶