create_link `async` ¶

create_link(
    global_network_id: GlobalNetworkId,
    bandwidth: Bandwidth,
    site_id: SiteId,
    *,
    config_overrides: Optional[AsyncNetworkManagerClientConfig] = None,
    description: Optional[ConstrainedString] = None,
    type: Optional[ConstrainedString] = None,
    provider: Optional[ConstrainedString] = None,
    tags: Optional[TagList] = None,
) -> CreateLinkResponse

Creates a new link for a specified site.

Parameters:

global_network_id (GlobalNetworkId) –

The ID of the global network.
description (Optional[ConstrainedString], default: None ) –

A description of the link.

Constraints: Maximum length of 256 characters.
type (Optional[ConstrainedString], default: None ) –

The type of the link.

Constraints: Maximum length of 128 characters. Cannot include the following characters: | \ ^
bandwidth (Bandwidth) –

The upload speed and download speed in Mbps.
provider (Optional[ConstrainedString], default: None ) –

The provider of the link.

Constraints: Maximum length of 128 characters. Cannot include the following characters: | \ ^
site_id (SiteId) –

The ID of the site.
tags (Optional[TagList], default: None ) –

The tags to apply to the resource during creation.

Raises:

AccessDeniedException –

You do not have sufficient access to perform this action.
ConflictException –

There was a conflict processing the request. Updating or deleting the resource can cause an inconsistent state.
InternalServerException –

The request has failed due to an internal error.
ResourceNotFoundException –

The specified resource could not be found.
ServiceQuotaExceededException –

A service limit was exceeded.
ThrottlingException –

The request was denied due to request throttling.
ValidationException –

The input fails to satisfy the constraints.
UnknownServiceError –

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

Source code in docs_src/capo_networkmanager/_services/async_network_manager.py

async def create_link(
    self,
    global_network_id: "capo_networkmanager.types.global_network_id.GlobalNetworkId",
    bandwidth: "capo_networkmanager.types.bandwidth.Bandwidth",
    site_id: "capo_networkmanager.types.site_id.SiteId",
    *,
    config_overrides: Optional[AsyncNetworkManagerClientConfig] = None,
    description: Optional[
        "capo_networkmanager.types.constrained_string.ConstrainedString"
    ] = None,
    type: Optional[
        "capo_networkmanager.types.constrained_string.ConstrainedString"
    ] = None,
    provider: Optional[
        "capo_networkmanager.types.constrained_string.ConstrainedString"
    ] = None,
    tags: Optional["capo_networkmanager.types.tag_list.TagList"] = None,
) -> "capo_networkmanager.types.create_link_response.CreateLinkResponse":
    r"""<p>Creates a new link for a specified site.</p>

    Args:
        global_network_id: <p>The ID of the global network.</p>
        description: <p>A description of the link.</p> <p>Constraints: Maximum length of 256 characters.</p>
        type: <p>The type of the link.</p> <p>Constraints: Maximum length of 128 characters. Cannot include the following characters: | \ ^</p>
        bandwidth: <p> The upload speed and download speed in Mbps. </p>
        provider: <p>The provider of the link.</p> <p>Constraints: Maximum length of 128 characters. Cannot include the following characters: | \ ^</p>
        site_id: <p>The ID of the site.</p>
        tags: <p>The tags to apply to the resource during creation.</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.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_networkmanager.types.create_link_request.CreateLinkRequest]",
    ) -> AsyncOperationResponse[
        "capo_networkmanager.types.create_link_response.CreateLinkResponse"
    ]:
        import capo_networkmanager._operations.network_manager.create_link

        (
            output,
            http_response,
        ) = await capo_networkmanager._operations.network_manager.create_link.async_create_link(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("CreateLink")
    )
    input_: capo_networkmanager.types.create_link_request.CreateLinkRequest = {
        "global_network_id": global_network_id,
        "bandwidth": bandwidth,
        "site_id": site_id,
    }
    if description is not None:
        input_["description"] = description
    if type is not None:
        input_["type"] = type
    if provider is not None:
        input_["provider"] = provider
    if tags is not None:
        input_["tags"] = tags

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

create_link async ¶

create_link `async` ¶