Skip to content

update_global_network 

update_global_network(
    global_network_id: GlobalNetworkId,
    *,
    config_overrides: Optional[NetworkManagerClientConfig] = None,
    description: Optional[ConstrainedString] = None,
) -> UpdateGlobalNetworkResponse

Updates an existing global network. To remove information for any of the parameters, specify an empty string.

Parameters:

  • global_network_id (GlobalNetworkId) –

    The ID of your global network.

  • description (Optional[ConstrainedString], default: None ) –

    A description of the global network.

    Constraints: Maximum length of 256 characters.

Raises:

Source code in docs_src/capo_networkmanager/_services/network_manager.py 
6950
6951
6952
6953
6954
6955
6956
6957
6958
6959
6960
6961
6962
6963
6964
6965
6966
6967
6968
6969
6970
6971
6972
6973
6974
6975
6976
6977
6978
6979
6980
6981
6982
6983
6984
6985
6986
6987
6988
6989
6990
6991
6992
6993
6994
6995
6996
6997
6998
6999
7000
7001
7002
7003
7004
def update_global_network(
    self,
    global_network_id: "capo_networkmanager.types.global_network_id.GlobalNetworkId",
    *,
    config_overrides: Optional[NetworkManagerClientConfig] = None,
    description: Optional[
        "capo_networkmanager.types.constrained_string.ConstrainedString"
    ] = None,
) -> "capo_networkmanager.types.update_global_network_response.UpdateGlobalNetworkResponse":
    """<p>Updates an existing global network. To remove information for any of the parameters, specify an empty string.</p>

    Args:
        global_network_id: <p>The ID of your global network.</p>
        description: <p>A description of the global network.</p> <p>Constraints: Maximum length of 256 characters.</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.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.update_global_network_request.UpdateGlobalNetworkRequest]",
    ) -> OperationResponse[
        "capo_networkmanager.types.update_global_network_response.UpdateGlobalNetworkResponse"
    ]:
        import capo_networkmanager._operations.network_manager.update_global_network

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("UpdateGlobalNetwork")
    )
    input_: capo_networkmanager.types.update_global_network_request.UpdateGlobalNetworkRequest = {
        "global_network_id": global_network_id
    }
    if description is not None:
        input_["description"] = description

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