Skip to content

associate_link 

associate_link(
    global_network_id: GlobalNetworkId,
    device_id: DeviceId,
    link_id: LinkId,
    *,
    config_overrides: Optional[NetworkManagerClientConfig] = None,
) -> AssociateLinkResponse

Associates a link to a device. A device can be associated to multiple links and a link can be associated to multiple devices. The device and link must be in the same global network and the same site.

Parameters:

  • global_network_id (GlobalNetworkId) –

    The ID of the global network.

  • device_id (DeviceId) –

    The ID of the device.

  • link_id (LinkId) –

    The ID of the link.

Raises:

Source code in docs_src/capo_networkmanager/_services/network_manager.py 
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
def associate_link(
    self,
    global_network_id: "capo_networkmanager.types.global_network_id.GlobalNetworkId",
    device_id: "capo_networkmanager.types.device_id.DeviceId",
    link_id: "capo_networkmanager.types.link_id.LinkId",
    *,
    config_overrides: Optional[NetworkManagerClientConfig] = None,
) -> "capo_networkmanager.types.associate_link_response.AssociateLinkResponse":
    """<p>Associates a link to a device. A device can be associated to multiple links and a link can be associated to multiple devices. The device and link must be in the same global network and the same site.</p>

    Args:
        global_network_id: <p>The ID of the global network.</p>
        device_id: <p>The ID of the device.</p>
        link_id: <p>The ID of the link.</p>

    Raises:
        capo_networkmanager.errors.access_denied_exception.AccessDeniedException: <p>You do not have sufficient access to perform this action.</p>
        capo_networkmanager.errors.conflict_exception.ConflictException: <p>There was a conflict processing the request. Updating or deleting the resource can cause an inconsistent state.</p>
        capo_networkmanager.errors.internal_server_exception.InternalServerException: <p>The request has failed due to an internal error.</p>
        capo_networkmanager.errors.resource_not_found_exception.ResourceNotFoundException: <p>The specified resource could not be found.</p>
        capo_networkmanager.errors.service_quota_exceeded_exception.ServiceQuotaExceededException: <p>A service limit was exceeded.</p>
        capo_networkmanager.errors.throttling_exception.ThrottlingException: <p>The request was denied due to request throttling.</p>
        capo_networkmanager.errors.validation_exception.ValidationException: <p>The input fails to satisfy the constraints.</p>
        capo_networkmanager.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_networkmanager.types.associate_link_request.AssociateLinkRequest]",
    ) -> OperationResponse[
        "capo_networkmanager.types.associate_link_response.AssociateLinkResponse"
    ]:
        import capo_networkmanager._operations.network_manager.associate_link

        output, http_response = (
            capo_networkmanager._operations.network_manager.associate_link.associate_link(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("AssociateLink")
    )
    input_: capo_networkmanager.types.associate_link_request.AssociateLinkRequest = {
        "global_network_id": global_network_id,
        "device_id": device_id,
        "link_id": link_id,
    }

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