scaleway.interlink.v1beta1 package

Submodules

scaleway.interlink.v1beta1.api module

class scaleway.interlink.v1beta1.api.InterlinkV1Beta1API(client: Client, *, bypass_validation: bool = False)

Bases: API

This API allows you to manage your Scaleway InterLink, to connect your on-premises infrastructure with your Scaleway VPC.

attach_routing_policy(*, link_id: str, routing_policy_id: str, region: Optional[str] = None) → Link

Attach a routing policy. Attach a routing policy to an existing link. As all routes across the link are blocked by default, you must attach a routing policy to set IP prefix filters for allowed routes, facilitating traffic flow. :param link_id: ID of the link to attach a routing policy to. :param routing_policy_id: ID of the routing policy to be attached. :param region: Region to target. If none is passed will use default region from the config. :return: Link

Usage:

result = api.attach_routing_policy(
    link_id="example",
    routing_policy_id="example",
)

attach_vpc(*, link_id: str, vpc_id: str, region: Optional[str] = None) → Link

Attach a VPC. Attach a VPC to an existing link. This facilitates communication between the resources in your Scaleway VPC, and your on-premises infrastructure. :param link_id: ID of the link to attach VPC to. :param vpc_id: ID of the VPC to attach. :param region: Region to target. If none is passed will use default region from the config. :return: Link

Usage:

result = api.attach_vpc(
    link_id="example",
    vpc_id="example",
)

create_link(*, name: str, pop_id: str, bandwidth_mbps: int, region: Optional[str] = None, project_id: Optional[str] = None, tags: Optional[List[str]] = None, connection_id: Optional[str] = None, partner_id: Optional[str] = None) → Link

Create a link. Create a link (InterLink session / logical InterLink resource) in a given PoP, specifying its various configuration details. Links can either be hosted (faciliated by partners’ shared physical connections) or self-hosted (for users who have purchased a dedicated physical connection). :param name: Name of the link. :param pop_id: PoP (location) where the link will be created. :param bandwidth_mbps: Desired bandwidth for the link. Must be compatible with available link bandwidths and remaining bandwidth capacity of the connection. :param region: Region to target. If none is passed will use default region from the config. :param project_id: ID of the Project to create the link in. :param tags: List of tags to apply to the link. :param connection_id: If set, creates a self-hosted link using this dedicated physical connection. As the customer, specify the ID of the physical connection you already have for this link. One-Of (‘host’): at most one of ‘connection_id’, ‘partner_id’ could be set. :param partner_id: If set, creates a hosted link on a partner’s connection. Specify the ID of the chosen partner, who already has a shared connection with available bandwidth. One-Of (‘host’): at most one of ‘connection_id’, ‘partner_id’ could be set. :return: Link

Usage:

result = api.create_link(
    name="example",
    pop_id="example",
    bandwidth_mbps=1,
)

create_routing_policy(*, name: str, region: Optional[str] = None, project_id: Optional[str] = None, tags: Optional[List[str]] = None, prefix_filter_in: Optional[List[str]] = None, prefix_filter_out: Optional[List[str]] = None) → RoutingPolicy

Create a routing policy. Create a routing policy. Routing policies allow you to set IP prefix filters to define the incoming route announcements to accept from the peer, and the outgoing routes to announce to the peer. :param name: Name of the routing policy. :param region: Region to target. If none is passed will use default region from the config. :param project_id: ID of the Project to create the routing policy in. :param tags: List of tags to apply to the routing policy. :param prefix_filter_in: IP prefixes to accept from the peer (ranges of route announcements to accept). :param prefix_filter_out: IP prefix filters to advertise to the peer (ranges of routes to advertise). :return: RoutingPolicy

Usage:

result = api.create_routing_policy(
    name="example",
)

delete_link(*, link_id: str, region: Optional[str] = None) → Link

Delete a link. Delete an existing link, specified by its link ID. Note that as well as deleting the link here on the Scaleway side, it is also necessary to request deletion from the partner on their side. Only when this action has been carried out on both sides will the resource be completely deleted. :param link_id: ID of the link to delete. :param region: Region to target. If none is passed will use default region from the config. :return: Link

Usage:

result = api.delete_link(
    link_id="example",
)

delete_routing_policy(*, routing_policy_id: str, region: Optional[str] = None) → None

Delete a routing policy. Delete an existing routing policy, specified by its routing policy ID. :param routing_policy_id: ID of the routing policy to delete. :param region: Region to target. If none is passed will use default region from the config.

Usage:

result = api.delete_routing_policy(
    routing_policy_id="example",
)

detach_routing_policy(*, link_id: str, region: Optional[str] = None) → Link

Detach a routing policy. Detach a routing policy from an existing link. Without a routing policy, all routes across the link are blocked by default. :param link_id: ID of the link to detach a routing policy from. :param region: Region to target. If none is passed will use default region from the config. :return: Link

Usage:

result = api.detach_routing_policy(
    link_id="example",
)

detach_vpc(*, link_id: str, region: Optional[str] = None) → Link

Detach a VPC. Detach a VPC from an existing link. :param link_id: ID of the link to detach the VPC from. :param region: Region to target. If none is passed will use default region from the config. :return: Link

Usage:

result = api.detach_vpc(
    link_id="example",
)

disable_route_propagation(*, link_id: str, region: Optional[str] = None) → Link

Disable route propagation. Prevent any prefixes from being announced in the BGP session. Traffic will not be able to flow over the InterLink until route propagation is re-enabled. :param link_id: ID of the link on which to disable route propagation. :param region: Region to target. If none is passed will use default region from the config. :return: Link

Usage:

result = api.disable_route_propagation(
    link_id="example",
)

enable_route_propagation(*, link_id: str, region: Optional[str] = None) → Link

Enable route propagation. Enable all allowed prefixes (defined in a routing policy) to be announced in the BGP session. This allows traffic to flow between the attached VPC and the on-premises infrastructure along the announced routes. Note that by default, even when route propagation is enabled, all routes are blocked. It is essential to attach a routing policy to define the ranges of routes to announce. :param link_id: ID of the link on which to enable route propagation. :param region: Region to target. If none is passed will use default region from the config. :return: Link

Usage:

result = api.enable_route_propagation(
    link_id="example",
)

get_dedicated_connection(*, connection_id: str, region: Optional[str] = None) → DedicatedConnection

Get a dedicated connection. For self-hosted users, get a dedicated physical connection corresponding to the given ID. The response object includes information such as the connection’s name, status and total bandwidth. :param connection_id: ID of connection to get. :param region: Region to target. If none is passed will use default region from the config. :return: DedicatedConnection

Usage:

result = api.get_dedicated_connection(
    connection_id="example",
)

get_link(*, link_id: str, region: Optional[str] = None) → Link

Get a link. Get a link (InterLink session / logical InterLink resource) for the given link ID. The response object includes information about the link’s various configuration details. :param link_id: ID of the link to get. :param region: Region to target. If none is passed will use default region from the config. :return: Link

Usage:

result = api.get_link(
    link_id="example",
)

get_partner(*, partner_id: str, region: Optional[str] = None) → Partner

Get a partner. Get a partner for the given partner IP. The response object includes information such as the partner’s name, email address and portal URL. :param partner_id: ID of partner to get. :param region: Region to target. If none is passed will use default region from the config. :return: Partner

Usage:

result = api.get_partner(
    partner_id="example",
)

get_pop(*, pop_id: str, region: Optional[str] = None) → Pop

Get a PoP. Get a PoP for the given PoP ID. The response object includes the PoP’s name and information about its physical location. :param pop_id: ID of PoP to get. :param region: Region to target. If none is passed will use default region from the config. :return: Pop

Usage:

result = api.get_pop(
    pop_id="example",
)

get_routing_policy(*, routing_policy_id: str, region: Optional[str] = None) → RoutingPolicy

Get routing policy. Get a routing policy for the given routing policy ID. The response object gives information including the policy’s name, tags and prefix filters. :param routing_policy_id: ID of the routing policy to get. :param region: Region to target. If none is passed will use default region from the config. :return: RoutingPolicy

Usage:

result = api.get_routing_policy(
    routing_policy_id="example",
)

list_dedicated_connections(*, region: Optional[str] = None, order_by: Optional[ListDedicatedConnectionsRequestOrderBy] = None, page: Optional[int] = None, page_size: Optional[int] = None, project_id: Optional[str] = None, organization_id: Optional[str] = None, name: Optional[str] = None, tags: Optional[List[str]] = None, status: Optional[DedicatedConnectionStatus] = None, bandwidth_mbps: Optional[int] = None, pop_id: Optional[str] = None) → ListDedicatedConnectionsResponse

List dedicated connections. For self-hosted users, list their dedicated physical connections in a given region. By default, the connections returned in the list are ordered by name in ascending order, though this can be modified via the order_by field. :param region: Region to target. If none is passed will use default region from the config. :param order_by: Order in which to return results. :param page: Page number to return. :param page_size: Maximum number of connections to return per page. :param project_id: Project ID to filter for. :param organization_id: Organization ID to filter for. :param name: Link name to filter for. :param tags: Tags to filter for. :param status: Connection status to filter for. :param bandwidth_mbps: Filter for dedicated connections with this bandwidth size. :param pop_id: Filter for dedicated connections present in this PoP. :return: ListDedicatedConnectionsResponse

Usage:

result = api.list_dedicated_connections()

list_dedicated_connections_all(*, region: Optional[str] = None, order_by: Optional[ListDedicatedConnectionsRequestOrderBy] = None, page: Optional[int] = None, page_size: Optional[int] = None, project_id: Optional[str] = None, organization_id: Optional[str] = None, name: Optional[str] = None, tags: Optional[List[str]] = None, status: Optional[DedicatedConnectionStatus] = None, bandwidth_mbps: Optional[int] = None, pop_id: Optional[str] = None) → List[DedicatedConnection]

List dedicated connections. For self-hosted users, list their dedicated physical connections in a given region. By default, the connections returned in the list are ordered by name in ascending order, though this can be modified via the order_by field. :param region: Region to target. If none is passed will use default region from the config. :param order_by: Order in which to return results. :param page: Page number to return. :param page_size: Maximum number of connections to return per page. :param project_id: Project ID to filter for. :param organization_id: Organization ID to filter for. :param name: Link name to filter for. :param tags: Tags to filter for. :param status: Connection status to filter for. :param bandwidth_mbps: Filter for dedicated connections with this bandwidth size. :param pop_id: Filter for dedicated connections present in this PoP. :return: List[DedicatedConnection]

Usage:

result = api.list_dedicated_connections_all()

list_links(*, region: Optional[str] = None, order_by: Optional[ListLinksRequestOrderBy] = None, page: Optional[int] = None, page_size: Optional[int] = None, project_id: Optional[str] = None, organization_id: Optional[str] = None, name: Optional[str] = None, tags: Optional[List[str]] = None, status: Optional[LinkStatus] = None, bgp_v4_status: Optional[BgpStatus] = None, bgp_v6_status: Optional[BgpStatus] = None, pop_id: Optional[str] = None, bandwidth_mbps: Optional[int] = None, partner_id: Optional[str] = None, vpc_id: Optional[str] = None, routing_policy_id: Optional[str] = None, pairing_key: Optional[str] = None, kind: Optional[LinkKind] = None, connection_id: Optional[str] = None) → ListLinksResponse

List links. List all your links (InterLink connections). A number of filters are available, including Project ID, name, tags and status. :param region: Region to target. If none is passed will use default region from the config. :param order_by: Order in which to return results. :param page: Page number to return. :param page_size: Maximum number of links to return per page. :param project_id: Project ID to filter for. :param organization_id: Organization ID to filter for. :param name: Link name to filter for. :param tags: Tags to filter for. :param status: Link status to filter for. :param bgp_v4_status: BGP IPv4 status to filter for. :param bgp_v6_status: BGP IPv6 status to filter for. :param pop_id: Filter for links attached to this PoP (via connections). :param bandwidth_mbps: Filter for link bandwidth (in Mbps). :param partner_id: Filter for links hosted by this partner. :param vpc_id: Filter for links attached to this VPC. :param routing_policy_id: Filter for links using this routing policy. :param pairing_key: Filter for the link with this pairing_key. :param kind: Filter for hosted or self-hosted links. :param connection_id: Filter for links self-hosted on this connection. :return: ListLinksResponse

Usage:

result = api.list_links()

list_links_all(*, region: Optional[str] = None, order_by: Optional[ListLinksRequestOrderBy] = None, page: Optional[int] = None, page_size: Optional[int] = None, project_id: Optional[str] = None, organization_id: Optional[str] = None, name: Optional[str] = None, tags: Optional[List[str]] = None, status: Optional[LinkStatus] = None, bgp_v4_status: Optional[BgpStatus] = None, bgp_v6_status: Optional[BgpStatus] = None, pop_id: Optional[str] = None, bandwidth_mbps: Optional[int] = None, partner_id: Optional[str] = None, vpc_id: Optional[str] = None, routing_policy_id: Optional[str] = None, pairing_key: Optional[str] = None, kind: Optional[LinkKind] = None, connection_id: Optional[str] = None) → List[Link]

List links. List all your links (InterLink connections). A number of filters are available, including Project ID, name, tags and status. :param region: Region to target. If none is passed will use default region from the config. :param order_by: Order in which to return results. :param page: Page number to return. :param page_size: Maximum number of links to return per page. :param project_id: Project ID to filter for. :param organization_id: Organization ID to filter for. :param name: Link name to filter for. :param tags: Tags to filter for. :param status: Link status to filter for. :param bgp_v4_status: BGP IPv4 status to filter for. :param bgp_v6_status: BGP IPv6 status to filter for. :param pop_id: Filter for links attached to this PoP (via connections). :param bandwidth_mbps: Filter for link bandwidth (in Mbps). :param partner_id: Filter for links hosted by this partner. :param vpc_id: Filter for links attached to this VPC. :param routing_policy_id: Filter for links using this routing policy. :param pairing_key: Filter for the link with this pairing_key. :param kind: Filter for hosted or self-hosted links. :param connection_id: Filter for links self-hosted on this connection. :return: List[Link]

Usage:

result = api.list_links_all()

list_partners(*, region: Optional[str] = None, order_by: Optional[ListPartnersRequestOrderBy] = None, page: Optional[int] = None, page_size: Optional[int] = None, pop_ids: Optional[List[str]] = None) → ListPartnersResponse

List available partners. List all available partners. By default, the partners returned in the list are ordered by name in ascending order, though this can be modified via the order_by field. :param region: Region to target. If none is passed will use default region from the config. :param order_by: Order in which to return results. :param page: Page number to return. :param page_size: Maximum number of partners to return per page. :param pop_ids: Filter for partners present (offering a connection) in one of these PoPs. :return: ListPartnersResponse

Usage:

result = api.list_partners()

list_partners_all(*, region: Optional[str] = None, order_by: Optional[ListPartnersRequestOrderBy] = None, page: Optional[int] = None, page_size: Optional[int] = None, pop_ids: Optional[List[str]] = None) → List[Partner]

List available partners. List all available partners. By default, the partners returned in the list are ordered by name in ascending order, though this can be modified via the order_by field. :param region: Region to target. If none is passed will use default region from the config. :param order_by: Order in which to return results. :param page: Page number to return. :param page_size: Maximum number of partners to return per page. :param pop_ids: Filter for partners present (offering a connection) in one of these PoPs. :return: List[Partner]

Usage:

result = api.list_partners_all()

list_pops(*, region: Optional[str] = None, order_by: Optional[ListPopsRequestOrderBy] = None, page: Optional[int] = None, page_size: Optional[int] = None, name: Optional[str] = None, hosting_provider_name: Optional[str] = None, partner_id: Optional[str] = None, link_bandwidth_mbps: Optional[int] = None, dedicated_available: Optional[bool] = None) → ListPopsResponse

List PoPs. List all available PoPs (locations) for a given region. By default, the results are returned in ascending alphabetical order by name. :param region: Region to target. If none is passed will use default region from the config. :param order_by: Order in which to return results. :param page: Page number to return. :param page_size: Maximum number of PoPs to return per page. :param name: PoP name to filter for. :param hosting_provider_name: Hosting provider name to filter for. :param partner_id: Filter for PoPs hosting an available shared connection from this partner. :param link_bandwidth_mbps: Filter for PoPs with a shared connection allowing this bandwidth size. Note that we cannot guarantee that PoPs returned will have available capacity. :param dedicated_available: Filter for PoPs with a dedicated connection available for self-hosted links. :return: ListPopsResponse

Usage:

result = api.list_pops()

list_pops_all(*, region: Optional[str] = None, order_by: Optional[ListPopsRequestOrderBy] = None, page: Optional[int] = None, page_size: Optional[int] = None, name: Optional[str] = None, hosting_provider_name: Optional[str] = None, partner_id: Optional[str] = None, link_bandwidth_mbps: Optional[int] = None, dedicated_available: Optional[bool] = None) → List[Pop]

List PoPs. List all available PoPs (locations) for a given region. By default, the results are returned in ascending alphabetical order by name. :param region: Region to target. If none is passed will use default region from the config. :param order_by: Order in which to return results. :param page: Page number to return. :param page_size: Maximum number of PoPs to return per page. :param name: PoP name to filter for. :param hosting_provider_name: Hosting provider name to filter for. :param partner_id: Filter for PoPs hosting an available shared connection from this partner. :param link_bandwidth_mbps: Filter for PoPs with a shared connection allowing this bandwidth size. Note that we cannot guarantee that PoPs returned will have available capacity. :param dedicated_available: Filter for PoPs with a dedicated connection available for self-hosted links. :return: List[Pop]

Usage:

result = api.list_pops_all()

list_routing_policies(*, region: Optional[str] = None, order_by: Optional[ListRoutingPoliciesRequestOrderBy] = None, page: Optional[int] = None, page_size: Optional[int] = None, project_id: Optional[str] = None, organization_id: Optional[str] = None, name: Optional[str] = None, tags: Optional[List[str]] = None) → ListRoutingPoliciesResponse

List routing policies. List all routing policies in a given region. A routing policy can be attached to one or multiple links (InterLink connections). :param region: Region to target. If none is passed will use default region from the config. :param order_by: Order in which to return results. :param page: Page number to return. :param page_size: Maximum number of routing policies to return per page. :param project_id: Project ID to filter for. :param organization_id: Organization ID to filter for. :param name: Routing policy name to filter for. :param tags: Tags to filter for. :return: ListRoutingPoliciesResponse

Usage:

result = api.list_routing_policies()

list_routing_policies_all(*, region: Optional[str] = None, order_by: Optional[ListRoutingPoliciesRequestOrderBy] = None, page: Optional[int] = None, page_size: Optional[int] = None, project_id: Optional[str] = None, organization_id: Optional[str] = None, name: Optional[str] = None, tags: Optional[List[str]] = None) → List[RoutingPolicy]

List routing policies. List all routing policies in a given region. A routing policy can be attached to one or multiple links (InterLink connections). :param region: Region to target. If none is passed will use default region from the config. :param order_by: Order in which to return results. :param page: Page number to return. :param page_size: Maximum number of routing policies to return per page. :param project_id: Project ID to filter for. :param organization_id: Organization ID to filter for. :param name: Routing policy name to filter for. :param tags: Tags to filter for. :return: List[RoutingPolicy]

Usage:

result = api.list_routing_policies_all()

update_link(*, link_id: str, region: Optional[str] = None, name: Optional[str] = None, tags: Optional[List[str]] = None) → Link

Update a link. Update an existing link, specified by its link ID. Only its name and tags can be updated. :param link_id: ID of the link to update. :param region: Region to target. If none is passed will use default region from the config. :param name: Name of the link. :param tags: List of tags to apply to the link. :return: Link

Usage:

result = api.update_link(
    link_id="example",
)

update_routing_policy(*, routing_policy_id: str, region: Optional[str] = None, name: Optional[str] = None, tags: Optional[List[str]] = None, prefix_filter_in: Optional[List[str]] = None, prefix_filter_out: Optional[List[str]] = None) → RoutingPolicy

Update a routing policy. Update an existing routing policy, specified by its routing policy ID. Its name, tags and incoming/outgoing prefix filters can be updated. :param routing_policy_id: ID of the routing policy to update. :param region: Region to target. If none is passed will use default region from the config. :param name: Name of the routing policy. :param tags: List of tags to apply to the routing policy. :param prefix_filter_in: IP prefixes to accept from the peer (ranges of route announcements to accept). :param prefix_filter_out: IP prefix filters for routes to advertise to the peer (ranges of routes to advertise). :return: RoutingPolicy

Usage:

result = api.update_routing_policy(
    routing_policy_id="example",
)

wait_for_dedicated_connection(*, connection_id: str, region: Optional[str] = None, options: Optional[WaitForOptions[DedicatedConnection, bool]] = None) → DedicatedConnection

Get a dedicated connection. For self-hosted users, get a dedicated physical connection corresponding to the given ID. The response object includes information such as the connection’s name, status and total bandwidth. :param connection_id: ID of connection to get. :param region: Region to target. If none is passed will use default region from the config. :return: DedicatedConnection

Usage:

result = api.get_dedicated_connection(
    connection_id="example",
)

wait_for_link(*, link_id: str, region: Optional[str] = None, options: Optional[WaitForOptions[Link, bool]] = None) → Link

Get a link. Get a link (InterLink session / logical InterLink resource) for the given link ID. The response object includes information about the link’s various configuration details. :param link_id: ID of the link to get. :param region: Region to target. If none is passed will use default region from the config. :return: Link

Usage:

result = api.get_link(
    link_id="example",
)

scaleway.interlink.v1beta1.content module

scaleway.interlink.v1beta1.content.DEDICATED_CONNECTION_TRANSIENT_STATUSES: List[DedicatedConnectionStatus] = [<DedicatedConnectionStatus.CONFIGURING: 'configuring'>]

Lists transient statutes of the enum DedicatedConnectionStatus.

scaleway.interlink.v1beta1.content.LINK_TRANSIENT_STATUSES: List[LinkStatus] = [<LinkStatus.CONFIGURING: 'configuring'>]

Lists transient statutes of the enum LinkStatus.

scaleway.interlink.v1beta1.marshalling module

scaleway.interlink.v1beta1.marshalling.marshal_AttachRoutingPolicyRequest(request: AttachRoutingPolicyRequest, defaults: ProfileDefaults) → Dict[str, Any]

scaleway.interlink.v1beta1.marshalling.marshal_AttachVpcRequest(request: AttachVpcRequest, defaults: ProfileDefaults) → Dict[str, Any]

scaleway.interlink.v1beta1.marshalling.marshal_CreateLinkRequest(request: CreateLinkRequest, defaults: ProfileDefaults) → Dict[str, Any]

scaleway.interlink.v1beta1.marshalling.marshal_CreateRoutingPolicyRequest(request: CreateRoutingPolicyRequest, defaults: ProfileDefaults) → Dict[str, Any]

scaleway.interlink.v1beta1.marshalling.marshal_UpdateLinkRequest(request: UpdateLinkRequest, defaults: ProfileDefaults) → Dict[str, Any]

scaleway.interlink.v1beta1.marshalling.marshal_UpdateRoutingPolicyRequest(request: UpdateRoutingPolicyRequest, defaults: ProfileDefaults) → Dict[str, Any]

scaleway.interlink.v1beta1.marshalling.unmarshal_BgpConfig(data: Any) → BgpConfig

scaleway.interlink.v1beta1.marshalling.unmarshal_DedicatedConnection(data: Any) → DedicatedConnection

scaleway.interlink.v1beta1.marshalling.unmarshal_Link(data: Any) → Link

scaleway.interlink.v1beta1.marshalling.unmarshal_ListDedicatedConnectionsResponse(data: Any) → ListDedicatedConnectionsResponse

scaleway.interlink.v1beta1.marshalling.unmarshal_ListLinksResponse(data: Any) → ListLinksResponse

scaleway.interlink.v1beta1.marshalling.unmarshal_ListPartnersResponse(data: Any) → ListPartnersResponse

scaleway.interlink.v1beta1.marshalling.unmarshal_ListPopsResponse(data: Any) → ListPopsResponse

scaleway.interlink.v1beta1.marshalling.unmarshal_ListRoutingPoliciesResponse(data: Any) → ListRoutingPoliciesResponse

scaleway.interlink.v1beta1.marshalling.unmarshal_Partner(data: Any) → Partner

scaleway.interlink.v1beta1.marshalling.unmarshal_PartnerHost(data: Any) → PartnerHost

scaleway.interlink.v1beta1.marshalling.unmarshal_Pop(data: Any) → Pop

scaleway.interlink.v1beta1.marshalling.unmarshal_RoutingPolicy(data: Any) → RoutingPolicy

scaleway.interlink.v1beta1.marshalling.unmarshal_SelfHost(data: Any) → SelfHost

scaleway.interlink.v1beta1.types module

class scaleway.interlink.v1beta1.types.AttachRoutingPolicyRequest(link_id: 'str', routing_policy_id: 'str', region: 'Optional[ScwRegion]')

Bases: object

link_id: str

ID of the link to attach a routing policy to.

region: Optional[str]

Region to target. If none is passed will use default region from the config.

routing_policy_id: str

ID of the routing policy to be attached.

class scaleway.interlink.v1beta1.types.AttachVpcRequest(link_id: 'str', vpc_id: 'str', region: 'Optional[ScwRegion]')

Bases: object

link_id: str

ID of the link to attach VPC to.

region: Optional[str]

Region to target. If none is passed will use default region from the config.

vpc_id: str

ID of the VPC to attach.

class scaleway.interlink.v1beta1.types.BgpConfig(asn: 'int', ipv4: 'str', ipv6: 'str')

Bases: object

asn: int

AS Number of the BGP peer.

ipv4: str

IPv4 address of the BGP peer.

ipv6: str

IPv6 address of the BGP peer.

class scaleway.interlink.v1beta1.types.BgpStatus(value: str, names: Optional[Any] = None, *args: Any, **kwargs: Any)

Bases: str, Enum

An enumeration.

DOWN = 'down'

UNKNOWN_BGP_STATUS = 'unknown_bgp_status'

UP = 'up'

class scaleway.interlink.v1beta1.types.CreateLinkRequest(name: 'str', pop_id: 'str', bandwidth_mbps: 'int', region: 'Optional[ScwRegion]', project_id: 'Optional[str]', tags: 'Optional[List[str]]', connection_id: 'Optional[str]', partner_id: 'Optional[str]')

Bases: object

bandwidth_mbps: int

Desired bandwidth for the link. Must be compatible with available link bandwidths and remaining bandwidth capacity of the connection.

connection_id: Optional[str]

name: str

Name of the link.

partner_id: Optional[str]

pop_id: str

PoP (location) where the link will be created.

project_id: Optional[str]

ID of the Project to create the link in.

region: Optional[str]

Region to target. If none is passed will use default region from the config.

tags: Optional[List[str]]

List of tags to apply to the link.

class scaleway.interlink.v1beta1.types.CreateRoutingPolicyRequest(name: 'str', region: 'Optional[ScwRegion]', project_id: 'Optional[str]', tags: 'Optional[List[str]]', prefix_filter_in: 'Optional[List[str]]', prefix_filter_out: 'Optional[List[str]]')

Bases: object

name: str

Name of the routing policy.

prefix_filter_in: Optional[List[str]]

IP prefixes to accept from the peer (ranges of route announcements to accept).

prefix_filter_out: Optional[List[str]]

IP prefix filters to advertise to the peer (ranges of routes to advertise).

project_id: Optional[str]

ID of the Project to create the routing policy in.

region: Optional[str]

Region to target. If none is passed will use default region from the config.

tags: Optional[List[str]]

List of tags to apply to the routing policy.

class scaleway.interlink.v1beta1.types.DedicatedConnection(id: 'str', project_id: 'str', organization_id: 'str', status: 'DedicatedConnectionStatus', name: 'str', tags: 'List[str]', pop_id: 'str', bandwidth_mbps: 'int', available_link_bandwidths: 'List[int]', region: 'ScwRegion', created_at: 'Optional[datetime]', updated_at: 'Optional[datetime]', demarcation_info: 'Optional[str]')

Bases: object

available_link_bandwidths: List[int]

Size of the links supported on this dedicated connection.

bandwidth_mbps: int

Bandwidth size of the dedicated connection.

created_at: Optional[datetime]

Creation date of the dedicated connection.

demarcation_info: Optional[str]

Demarcation details required by the data center to set up the supporting Cross Connect. This generally includes the physical space in the facility, the cabinet or rack the connection should land in, the patch panel to go in, the port designation, and the media type.

id: str

Unique identifier of the dedicated connection.

name: str

Name of the dedicated connection.

organization_id: str

Organization ID.

pop_id: str

ID of the PoP where the dedicated connection is located.

project_id: str

Project ID.

region: str

Region of the dedicated connection.

status: DedicatedConnectionStatus

Status of the dedicated connection.

tags: List[str]

List of tags associated with the dedicated connection.

updated_at: Optional[datetime]

Last modification date of the dedicated connection.

class scaleway.interlink.v1beta1.types.DedicatedConnectionStatus(value: str, names: Optional[Any] = None, *args: Any, **kwargs: Any)

Bases: str, Enum

An enumeration.

ACTIVE = 'active'

CONFIGURING = 'configuring'

CREATED = 'created'

DELETED = 'deleted'

DISABLED = 'disabled'

FAILED = 'failed'

LOCKED = 'locked'

UNKNOWN_STATUS = 'unknown_status'

class scaleway.interlink.v1beta1.types.DeleteLinkRequest(link_id: 'str', region: 'Optional[ScwRegion]')

Bases: object

link_id: str

ID of the link to delete.

region: Optional[str]

Region to target. If none is passed will use default region from the config.

class scaleway.interlink.v1beta1.types.DeleteRoutingPolicyRequest(routing_policy_id: 'str', region: 'Optional[ScwRegion]')

Bases: object

region: Optional[str]

Region to target. If none is passed will use default region from the config.

routing_policy_id: str

ID of the routing policy to delete.

class scaleway.interlink.v1beta1.types.DetachRoutingPolicyRequest(link_id: 'str', region: 'Optional[ScwRegion]')

Bases: object

link_id: str

ID of the link to detach a routing policy from.

region: Optional[str]

Region to target. If none is passed will use default region from the config.

class scaleway.interlink.v1beta1.types.DetachVpcRequest(link_id: 'str', region: 'Optional[ScwRegion]')

Bases: object

link_id: str

ID of the link to detach the VPC from.

region: Optional[str]

Region to target. If none is passed will use default region from the config.

class scaleway.interlink.v1beta1.types.DisableRoutePropagationRequest(link_id: 'str', region: 'Optional[ScwRegion]')

Bases: object

link_id: str

ID of the link on which to disable route propagation.

region: Optional[str]

Region to target. If none is passed will use default region from the config.

class scaleway.interlink.v1beta1.types.EnableRoutePropagationRequest(link_id: 'str', region: 'Optional[ScwRegion]')

Bases: object

link_id: str

ID of the link on which to enable route propagation.

region: Optional[str]

Region to target. If none is passed will use default region from the config.

class scaleway.interlink.v1beta1.types.GetDedicatedConnectionRequest(connection_id: 'str', region: 'Optional[ScwRegion]')

Bases: object

connection_id: str

ID of connection to get.

region: Optional[str]

Region to target. If none is passed will use default region from the config.

class scaleway.interlink.v1beta1.types.GetLinkRequest(link_id: 'str', region: 'Optional[ScwRegion]')

Bases: object

link_id: str

ID of the link to get.

region: Optional[str]

Region to target. If none is passed will use default region from the config.

class scaleway.interlink.v1beta1.types.GetPartnerRequest(partner_id: 'str', region: 'Optional[ScwRegion]')

Bases: object

partner_id: str

ID of partner to get.

region: Optional[str]

Region to target. If none is passed will use default region from the config.

class scaleway.interlink.v1beta1.types.GetPopRequest(pop_id: 'str', region: 'Optional[ScwRegion]')

Bases: object

pop_id: str

ID of PoP to get.

region: Optional[str]

Region to target. If none is passed will use default region from the config.

class scaleway.interlink.v1beta1.types.GetRoutingPolicyRequest(routing_policy_id: 'str', region: 'Optional[ScwRegion]')

Bases: object

region: Optional[str]

Region to target. If none is passed will use default region from the config.

routing_policy_id: str

ID of the routing policy to get.

class scaleway.interlink.v1beta1.types.Link(id: 'str', project_id: 'str', organization_id: 'str', name: 'str', tags: 'List[str]', pop_id: 'str', bandwidth_mbps: 'int', status: 'LinkStatus', bgp_v4_status: 'BgpStatus', bgp_v6_status: 'BgpStatus', enable_route_propagation: 'bool', vlan: 'int', region: 'ScwRegion', vpc_id: 'Optional[str]', routing_policy_id: 'Optional[str]', created_at: 'Optional[datetime]', updated_at: 'Optional[datetime]', scw_bgp_config: 'Optional[BgpConfig]', peer_bgp_config: 'Optional[BgpConfig]', partner: 'Optional[PartnerHost]', self_: 'Optional[SelfHost]')

Bases: object

bandwidth_mbps: int

Rate limited bandwidth of the link.

bgp_v4_status: BgpStatus

Status of the link’s BGP IPv4 session.

bgp_v6_status: BgpStatus

Status of the link’s BGP IPv6 session.

created_at: Optional[datetime]

Creation date of the link.

enable_route_propagation: bool

Defines whether route propagation is enabled or not. To enable or disable route propagation, use the dedicated endpoint.

id: str

Unique identifier of the link.

name: str

Name of the link.

organization_id: str

Organization ID.

partner: Optional[PartnerHost]

peer_bgp_config: Optional[BgpConfig]

BGP configuration on peer’s side (on-premises or other hosting provider).

pop_id: str

ID of the PoP where the link’s corresponding connection is located.

project_id: str

Project ID.

region: str

Region of the link.

routing_policy_id: Optional[str]

ID of the routing policy attached to the link.

scw_bgp_config: Optional[BgpConfig]

BGP configuration on Scaleway’s side.

self_: Optional[SelfHost]

status: LinkStatus

Status of the link.

tags: List[str]

List of tags associated with the link.

updated_at: Optional[datetime]

Last modification date of the link.

vlan: int

VLAN of the link.

vpc_id: Optional[str]

ID of the Scaleway VPC attached to the link.

class scaleway.interlink.v1beta1.types.LinkKind(value: str, names: Optional[Any] = None, *args: Any, **kwargs: Any)

Bases: str, Enum

An enumeration.

HOSTED = 'hosted'

SELF_HOSTED = 'self_hosted'

class scaleway.interlink.v1beta1.types.LinkStatus(value: str, names: Optional[Any] = None, *args: Any, **kwargs: Any)

Bases: str, Enum

An enumeration.

ACTIVE = 'active'

ALL_DOWN = 'all_down'

CONFIGURING = 'configuring'

DELETED = 'deleted'

DEPROVISIONING = 'deprovisioning'

EXPIRED = 'expired'

FAILED = 'failed'

LIMITED_CONNECTIVITY = 'limited_connectivity'

LOCKED = 'locked'

PROVISIONING = 'provisioning'

REFUSED = 'refused'

REQUESTED = 'requested'

UNKNOWN_LINK_STATUS = 'unknown_link_status'

class scaleway.interlink.v1beta1.types.ListDedicatedConnectionsRequest(region: 'Optional[ScwRegion]', order_by: 'Optional[ListDedicatedConnectionsRequestOrderBy]', page: 'Optional[int]', page_size: 'Optional[int]', project_id: 'Optional[str]', organization_id: 'Optional[str]', name: 'Optional[str]', tags: 'Optional[List[str]]', status: 'Optional[DedicatedConnectionStatus]', bandwidth_mbps: 'Optional[int]', pop_id: 'Optional[str]')

Bases: object

bandwidth_mbps: Optional[int]

Filter for dedicated connections with this bandwidth size.

name: Optional[str]

Link name to filter for.

order_by: Optional[ListDedicatedConnectionsRequestOrderBy]

Order in which to return results.

organization_id: Optional[str]

Organization ID to filter for.

page: Optional[int]

Page number to return.

page_size: Optional[int]

Maximum number of connections to return per page.

pop_id: Optional[str]

Filter for dedicated connections present in this PoP.

project_id: Optional[str]

Project ID to filter for.

region: Optional[str]

Region to target. If none is passed will use default region from the config.

status: Optional[DedicatedConnectionStatus]

Connection status to filter for.

tags: Optional[List[str]]

Tags to filter for.

class scaleway.interlink.v1beta1.types.ListDedicatedConnectionsRequestOrderBy(value: str, names: Optional[Any] = None, *args: Any, **kwargs: Any)

Bases: str, Enum

An enumeration.

CREATED_AT_ASC = 'created_at_asc'

CREATED_AT_DESC = 'created_at_desc'

NAME_ASC = 'name_asc'

NAME_DESC = 'name_desc'

STATUS_ASC = 'status_asc'

STATUS_DESC = 'status_desc'

UPDATED_AT_ASC = 'updated_at_asc'

UPDATED_AT_DESC = 'updated_at_desc'

class scaleway.interlink.v1beta1.types.ListDedicatedConnectionsResponse(connections: 'List[DedicatedConnection]', total_count: 'int')

Bases: object

connections: List[DedicatedConnection]

List of connections on current page.

total_count: int

Total number of connections returned.

class scaleway.interlink.v1beta1.types.ListLinksRequest(region: 'Optional[ScwRegion]', order_by: 'Optional[ListLinksRequestOrderBy]', page: 'Optional[int]', page_size: 'Optional[int]', project_id: 'Optional[str]', organization_id: 'Optional[str]', name: 'Optional[str]', tags: 'Optional[List[str]]', status: 'Optional[LinkStatus]', bgp_v4_status: 'Optional[BgpStatus]', bgp_v6_status: 'Optional[BgpStatus]', pop_id: 'Optional[str]', bandwidth_mbps: 'Optional[int]', partner_id: 'Optional[str]', vpc_id: 'Optional[str]', routing_policy_id: 'Optional[str]', pairing_key: 'Optional[str]', kind: 'Optional[LinkKind]', connection_id: 'Optional[str]')

Bases: object

bandwidth_mbps: Optional[int]

Filter for link bandwidth (in Mbps).

bgp_v4_status: Optional[BgpStatus]

BGP IPv4 status to filter for.

bgp_v6_status: Optional[BgpStatus]

BGP IPv6 status to filter for.

connection_id: Optional[str]

Filter for links self-hosted on this connection.

kind: Optional[LinkKind]

Filter for hosted or self-hosted links.

name: Optional[str]

Link name to filter for.

order_by: Optional[ListLinksRequestOrderBy]

Order in which to return results.

organization_id: Optional[str]

Organization ID to filter for.

page: Optional[int]

Page number to return.

page_size: Optional[int]

Maximum number of links to return per page.

pairing_key: Optional[str]

Filter for the link with this pairing_key.

partner_id: Optional[str]

Filter for links hosted by this partner.

pop_id: Optional[str]

Filter for links attached to this PoP (via connections).

project_id: Optional[str]

Project ID to filter for.

region: Optional[str]

Region to target. If none is passed will use default region from the config.

routing_policy_id: Optional[str]

Filter for links using this routing policy.

status: Optional[LinkStatus]

Link status to filter for.

tags: Optional[List[str]]

Tags to filter for.

vpc_id: Optional[str]

Filter for links attached to this VPC.

class scaleway.interlink.v1beta1.types.ListLinksRequestOrderBy(value: str, names: Optional[Any] = None, *args: Any, **kwargs: Any)

Bases: str, Enum

An enumeration.

CREATED_AT_ASC = 'created_at_asc'

CREATED_AT_DESC = 'created_at_desc'

NAME_ASC = 'name_asc'

NAME_DESC = 'name_desc'

STATUS_ASC = 'status_asc'

STATUS_DESC = 'status_desc'

class scaleway.interlink.v1beta1.types.ListLinksResponse(links: 'List[Link]', total_count: 'int')

Bases: object

links: List[Link]

List of links on the current page.

total_count: int

Total number of links.

class scaleway.interlink.v1beta1.types.ListPartnersRequest(region: 'Optional[ScwRegion]', order_by: 'Optional[ListPartnersRequestOrderBy]', page: 'Optional[int]', page_size: 'Optional[int]', pop_ids: 'Optional[List[str]]')

Bases: object

order_by: Optional[ListPartnersRequestOrderBy]

Order in which to return results.

page: Optional[int]

Page number to return.

page_size: Optional[int]

Maximum number of partners to return per page.

pop_ids: Optional[List[str]]

Filter for partners present (offering a connection) in one of these PoPs.

region: Optional[str]

Region to target. If none is passed will use default region from the config.

class scaleway.interlink.v1beta1.types.ListPartnersRequestOrderBy(value: str, names: Optional[Any] = None, *args: Any, **kwargs: Any)

Bases: str, Enum

An enumeration.

NAME_ASC = 'name_asc'

NAME_DESC = 'name_desc'

class scaleway.interlink.v1beta1.types.ListPartnersResponse(partners: 'List[Partner]', total_count: 'int')

Bases: object

partners: List[Partner]

List of partners on current page.

total_count: int

Total number of partners returned.

class scaleway.interlink.v1beta1.types.ListPopsRequest(region: 'Optional[ScwRegion]', order_by: 'Optional[ListPopsRequestOrderBy]', page: 'Optional[int]', page_size: 'Optional[int]', name: 'Optional[str]', hosting_provider_name: 'Optional[str]', partner_id: 'Optional[str]', link_bandwidth_mbps: 'Optional[int]', dedicated_available: 'Optional[bool]')

Bases: object

dedicated_available: Optional[bool]

Filter for PoPs with a dedicated connection available for self-hosted links.

hosting_provider_name: Optional[str]

Hosting provider name to filter for.

link_bandwidth_mbps: Optional[int]

Filter for PoPs with a shared connection allowing this bandwidth size. Note that we cannot guarantee that PoPs returned will have available capacity.

name: Optional[str]

PoP name to filter for.

order_by: Optional[ListPopsRequestOrderBy]

Order in which to return results.

page: Optional[int]

Page number to return.

page_size: Optional[int]

Maximum number of PoPs to return per page.

partner_id: Optional[str]

Filter for PoPs hosting an available shared connection from this partner.

region: Optional[str]

Region to target. If none is passed will use default region from the config.

class scaleway.interlink.v1beta1.types.ListPopsRequestOrderBy(value: str, names: Optional[Any] = None, *args: Any, **kwargs: Any)

Bases: str, Enum

An enumeration.

NAME_ASC = 'name_asc'

NAME_DESC = 'name_desc'

class scaleway.interlink.v1beta1.types.ListPopsResponse(pops: 'List[Pop]', total_count: 'int')

Bases: object

pops: List[Pop]

List of PoPs on the current page.

total_count: int

Total number of PoPs.

class scaleway.interlink.v1beta1.types.ListRoutingPoliciesRequest(region: 'Optional[ScwRegion]', order_by: 'Optional[ListRoutingPoliciesRequestOrderBy]', page: 'Optional[int]', page_size: 'Optional[int]', project_id: 'Optional[str]', organization_id: 'Optional[str]', name: 'Optional[str]', tags: 'Optional[List[str]]')

Bases: object

name: Optional[str]

Routing policy name to filter for.

order_by: Optional[ListRoutingPoliciesRequestOrderBy]

Order in which to return results.

organization_id: Optional[str]

Organization ID to filter for.

page: Optional[int]

Page number to return.

page_size: Optional[int]

Maximum number of routing policies to return per page.

project_id: Optional[str]

Project ID to filter for.

region: Optional[str]

Region to target. If none is passed will use default region from the config.

tags: Optional[List[str]]

Tags to filter for.

class scaleway.interlink.v1beta1.types.ListRoutingPoliciesRequestOrderBy(value: str, names: Optional[Any] = None, *args: Any, **kwargs: Any)

Bases: str, Enum

An enumeration.

CREATED_AT_ASC = 'created_at_asc'

CREATED_AT_DESC = 'created_at_desc'

NAME_ASC = 'name_asc'

NAME_DESC = 'name_desc'

class scaleway.interlink.v1beta1.types.ListRoutingPoliciesResponse(routing_policies: 'List[RoutingPolicy]', total_count: 'int')

Bases: object

routing_policies: List[RoutingPolicy]

total_count: int

class scaleway.interlink.v1beta1.types.Partner(id: 'str', name: 'str', contact_email: 'str', logo_url: 'str', portal_url: 'str', created_at: 'Optional[datetime]', updated_at: 'Optional[datetime]')

Bases: object

contact_email: str

Contact email address of partner.

created_at: Optional[datetime]

Creation date of the partner.

id: str

Unique identifier of the partner.

logo_url: str

Image URL of the partner’s logo.

name: str

Name of the partner.

portal_url: str

URL of the partner’s portal.

updated_at: Optional[datetime]

Last modification date of the partner.

class scaleway.interlink.v1beta1.types.PartnerHost(partner_id: 'str', pairing_key: 'str', disapproved_reason: 'Optional[str]')

Bases: object

disapproved_reason: Optional[str]

Reason given by partner to explain why they did not approve the request for a hosted link.

pairing_key: str

Used to identify a link from a user or partner’s point of view.

partner_id: str

ID of the partner facilitating the link.

class scaleway.interlink.v1beta1.types.Pop(id: 'str', name: 'str', hosting_provider_name: 'str', address: 'str', city: 'str', logo_url: 'str', available_link_bandwidths_mbps: 'List[int]', region: 'ScwRegion')

Bases: object

address: str

Physical address of the PoP.

available_link_bandwidths_mbps: List[int]

Available bandwidth in Mbits/s for future hosted links from available connections in this PoP.

city: str

City where PoP is located.

hosting_provider_name: str

Name of the PoP’s hosting provider, e.g. Telehouse for TH2 or OpCore for DC3.

id: str

Unique identifier of the PoP.

logo_url: str

Image URL of the PoP’s logo.

name: str

Name of the PoP. It is the common reference of Hosting DC (ex: TH2).

region: str

Region of the PoP.

class scaleway.interlink.v1beta1.types.RoutingPolicy(id: 'str', project_id: 'str', organization_id: 'str', name: 'str', tags: 'List[str]', prefix_filter_in: 'List[str]', prefix_filter_out: 'List[str]', region: 'ScwRegion', created_at: 'Optional[datetime]', updated_at: 'Optional[datetime]')

Bases: object

created_at: Optional[datetime]

Creation date of the routing policy.

id: str

Unique identifier of the routing policy.

name: str

Name of the routing policy.

organization_id: str

Organization ID.

prefix_filter_in: List[str]

IP prefixes to accept from the peer (ranges of route announcements to accept).

prefix_filter_out: List[str]

IP prefix filters to advertise to the peer (ranges of routes to advertise).

project_id: str

Project ID.

region: str

Region of the routing policy.

tags: List[str]

List of tags associated with the routing policy.

updated_at: Optional[datetime]

Last modification date of the routing policy.

class scaleway.interlink.v1beta1.types.SelfHost(connection_id: 'str')

Bases: object

connection_id: str

Dedicated physical connection supporting the link.

class scaleway.interlink.v1beta1.types.UpdateLinkRequest(link_id: 'str', region: 'Optional[ScwRegion]', name: 'Optional[str]', tags: 'Optional[List[str]]')

Bases: object

link_id: str

ID of the link to update.

name: Optional[str]

Name of the link.

region: Optional[str]

Region to target. If none is passed will use default region from the config.

tags: Optional[List[str]]

List of tags to apply to the link.

class scaleway.interlink.v1beta1.types.UpdateRoutingPolicyRequest(routing_policy_id: 'str', region: 'Optional[ScwRegion]', name: 'Optional[str]', tags: 'Optional[List[str]]', prefix_filter_in: 'Optional[List[str]]', prefix_filter_out: 'Optional[List[str]]')

Bases: object

name: Optional[str]

Name of the routing policy.

prefix_filter_in: Optional[List[str]]

IP prefixes to accept from the peer (ranges of route announcements to accept).

prefix_filter_out: Optional[List[str]]

IP prefix filters for routes to advertise to the peer (ranges of routes to advertise).

region: Optional[str]

Region to target. If none is passed will use default region from the config.

routing_policy_id: str

ID of the routing policy to update.

tags: Optional[List[str]]

List of tags to apply to the routing policy.

Module contents

class scaleway.interlink.v1beta1.AttachRoutingPolicyRequest(link_id: 'str', routing_policy_id: 'str', region: 'Optional[ScwRegion]')

Bases: object

link_id: str

ID of the link to attach a routing policy to.

region: Optional[str]

Region to target. If none is passed will use default region from the config.

routing_policy_id: str

ID of the routing policy to be attached.

class scaleway.interlink.v1beta1.AttachVpcRequest(link_id: 'str', vpc_id: 'str', region: 'Optional[ScwRegion]')

Bases: object

link_id: str

ID of the link to attach VPC to.

region: Optional[str]

Region to target. If none is passed will use default region from the config.

vpc_id: str

ID of the VPC to attach.

class scaleway.interlink.v1beta1.BgpConfig(asn: 'int', ipv4: 'str', ipv6: 'str')

Bases: object

asn: int

AS Number of the BGP peer.

ipv4: str

IPv4 address of the BGP peer.

ipv6: str

IPv6 address of the BGP peer.

class scaleway.interlink.v1beta1.BgpStatus(value: str, names: Optional[Any] = None, *args: Any, **kwargs: Any)

Bases: str, Enum

An enumeration.

DOWN = 'down'

UNKNOWN_BGP_STATUS = 'unknown_bgp_status'

UP = 'up'

class scaleway.interlink.v1beta1.CreateLinkRequest(name: 'str', pop_id: 'str', bandwidth_mbps: 'int', region: 'Optional[ScwRegion]', project_id: 'Optional[str]', tags: 'Optional[List[str]]', connection_id: 'Optional[str]', partner_id: 'Optional[str]')

Bases: object

bandwidth_mbps: int

Desired bandwidth for the link. Must be compatible with available link bandwidths and remaining bandwidth capacity of the connection.

connection_id: Optional[str]

name: str

Name of the link.

partner_id: Optional[str]

pop_id: str

PoP (location) where the link will be created.

project_id: Optional[str]

ID of the Project to create the link in.

region: Optional[str]

Region to target. If none is passed will use default region from the config.

tags: Optional[List[str]]

List of tags to apply to the link.

class scaleway.interlink.v1beta1.CreateRoutingPolicyRequest(name: 'str', region: 'Optional[ScwRegion]', project_id: 'Optional[str]', tags: 'Optional[List[str]]', prefix_filter_in: 'Optional[List[str]]', prefix_filter_out: 'Optional[List[str]]')

Bases: object

name: str

Name of the routing policy.

prefix_filter_in: Optional[List[str]]

IP prefixes to accept from the peer (ranges of route announcements to accept).

prefix_filter_out: Optional[List[str]]

IP prefix filters to advertise to the peer (ranges of routes to advertise).

project_id: Optional[str]

ID of the Project to create the routing policy in.

region: Optional[str]

Region to target. If none is passed will use default region from the config.

tags: Optional[List[str]]

List of tags to apply to the routing policy.

class scaleway.interlink.v1beta1.DedicatedConnection(id: 'str', project_id: 'str', organization_id: 'str', status: 'DedicatedConnectionStatus', name: 'str', tags: 'List[str]', pop_id: 'str', bandwidth_mbps: 'int', available_link_bandwidths: 'List[int]', region: 'ScwRegion', created_at: 'Optional[datetime]', updated_at: 'Optional[datetime]', demarcation_info: 'Optional[str]')

Bases: object

available_link_bandwidths: List[int]

Size of the links supported on this dedicated connection.

bandwidth_mbps: int

Bandwidth size of the dedicated connection.

created_at: Optional[datetime]

Creation date of the dedicated connection.

demarcation_info: Optional[str]

Demarcation details required by the data center to set up the supporting Cross Connect. This generally includes the physical space in the facility, the cabinet or rack the connection should land in, the patch panel to go in, the port designation, and the media type.

id: str

Unique identifier of the dedicated connection.

name: str

Name of the dedicated connection.

organization_id: str

Organization ID.

pop_id: str

ID of the PoP where the dedicated connection is located.

project_id: str

Project ID.

region: str

Region of the dedicated connection.

status: DedicatedConnectionStatus

Status of the dedicated connection.

tags: List[str]

List of tags associated with the dedicated connection.

updated_at: Optional[datetime]

Last modification date of the dedicated connection.

class scaleway.interlink.v1beta1.DedicatedConnectionStatus(value: str, names: Optional[Any] = None, *args: Any, **kwargs: Any)

Bases: str, Enum

An enumeration.

ACTIVE = 'active'

CONFIGURING = 'configuring'

CREATED = 'created'

DELETED = 'deleted'

DISABLED = 'disabled'

FAILED = 'failed'

LOCKED = 'locked'

UNKNOWN_STATUS = 'unknown_status'

class scaleway.interlink.v1beta1.DeleteLinkRequest(link_id: 'str', region: 'Optional[ScwRegion]')

Bases: object

link_id: str

ID of the link to delete.

region: Optional[str]

Region to target. If none is passed will use default region from the config.

class scaleway.interlink.v1beta1.DeleteRoutingPolicyRequest(routing_policy_id: 'str', region: 'Optional[ScwRegion]')

Bases: object

region: Optional[str]

Region to target. If none is passed will use default region from the config.

routing_policy_id: str

ID of the routing policy to delete.

class scaleway.interlink.v1beta1.DetachRoutingPolicyRequest(link_id: 'str', region: 'Optional[ScwRegion]')

Bases: object

link_id: str

ID of the link to detach a routing policy from.

region: Optional[str]

Region to target. If none is passed will use default region from the config.

class scaleway.interlink.v1beta1.DetachVpcRequest(link_id: 'str', region: 'Optional[ScwRegion]')

Bases: object

link_id: str

ID of the link to detach the VPC from.

region: Optional[str]

Region to target. If none is passed will use default region from the config.

class scaleway.interlink.v1beta1.DisableRoutePropagationRequest(link_id: 'str', region: 'Optional[ScwRegion]')

Bases: object

link_id: str

ID of the link on which to disable route propagation.

region: Optional[str]

Region to target. If none is passed will use default region from the config.

class scaleway.interlink.v1beta1.EnableRoutePropagationRequest(link_id: 'str', region: 'Optional[ScwRegion]')

Bases: object

link_id: str

ID of the link on which to enable route propagation.

region: Optional[str]

Region to target. If none is passed will use default region from the config.

class scaleway.interlink.v1beta1.GetDedicatedConnectionRequest(connection_id: 'str', region: 'Optional[ScwRegion]')

Bases: object

connection_id: str

ID of connection to get.

region: Optional[str]

Region to target. If none is passed will use default region from the config.

class scaleway.interlink.v1beta1.GetLinkRequest(link_id: 'str', region: 'Optional[ScwRegion]')

Bases: object

link_id: str

ID of the link to get.

region: Optional[str]

Region to target. If none is passed will use default region from the config.

class scaleway.interlink.v1beta1.GetPartnerRequest(partner_id: 'str', region: 'Optional[ScwRegion]')

Bases: object

partner_id: str

ID of partner to get.

region: Optional[str]

Region to target. If none is passed will use default region from the config.

class scaleway.interlink.v1beta1.GetPopRequest(pop_id: 'str', region: 'Optional[ScwRegion]')

Bases: object

pop_id: str

ID of PoP to get.

region: Optional[str]

Region to target. If none is passed will use default region from the config.

class scaleway.interlink.v1beta1.GetRoutingPolicyRequest(routing_policy_id: 'str', region: 'Optional[ScwRegion]')

Bases: object

region: Optional[str]

Region to target. If none is passed will use default region from the config.

routing_policy_id: str

ID of the routing policy to get.

class scaleway.interlink.v1beta1.InterlinkV1Beta1API(client: Client, *, bypass_validation: bool = False)

Bases: API

This API allows you to manage your Scaleway InterLink, to connect your on-premises infrastructure with your Scaleway VPC.

attach_routing_policy(*, link_id: str, routing_policy_id: str, region: Optional[str] = None) → Link

Attach a routing policy. Attach a routing policy to an existing link. As all routes across the link are blocked by default, you must attach a routing policy to set IP prefix filters for allowed routes, facilitating traffic flow. :param link_id: ID of the link to attach a routing policy to. :param routing_policy_id: ID of the routing policy to be attached. :param region: Region to target. If none is passed will use default region from the config. :return: Link

Usage:

result = api.attach_routing_policy(
    link_id="example",
    routing_policy_id="example",
)

attach_vpc(*, link_id: str, vpc_id: str, region: Optional[str] = None) → Link

Attach a VPC. Attach a VPC to an existing link. This facilitates communication between the resources in your Scaleway VPC, and your on-premises infrastructure. :param link_id: ID of the link to attach VPC to. :param vpc_id: ID of the VPC to attach. :param region: Region to target. If none is passed will use default region from the config. :return: Link

Usage:

result = api.attach_vpc(
    link_id="example",
    vpc_id="example",
)

create_link(*, name: str, pop_id: str, bandwidth_mbps: int, region: Optional[str] = None, project_id: Optional[str] = None, tags: Optional[List[str]] = None, connection_id: Optional[str] = None, partner_id: Optional[str] = None) → Link

Create a link. Create a link (InterLink session / logical InterLink resource) in a given PoP, specifying its various configuration details. Links can either be hosted (faciliated by partners’ shared physical connections) or self-hosted (for users who have purchased a dedicated physical connection). :param name: Name of the link. :param pop_id: PoP (location) where the link will be created. :param bandwidth_mbps: Desired bandwidth for the link. Must be compatible with available link bandwidths and remaining bandwidth capacity of the connection. :param region: Region to target. If none is passed will use default region from the config. :param project_id: ID of the Project to create the link in. :param tags: List of tags to apply to the link. :param connection_id: If set, creates a self-hosted link using this dedicated physical connection. As the customer, specify the ID of the physical connection you already have for this link. One-Of (‘host’): at most one of ‘connection_id’, ‘partner_id’ could be set. :param partner_id: If set, creates a hosted link on a partner’s connection. Specify the ID of the chosen partner, who already has a shared connection with available bandwidth. One-Of (‘host’): at most one of ‘connection_id’, ‘partner_id’ could be set. :return: Link

Usage:

result = api.create_link(
    name="example",
    pop_id="example",
    bandwidth_mbps=1,
)

create_routing_policy(*, name: str, region: Optional[str] = None, project_id: Optional[str] = None, tags: Optional[List[str]] = None, prefix_filter_in: Optional[List[str]] = None, prefix_filter_out: Optional[List[str]] = None) → RoutingPolicy

Create a routing policy. Create a routing policy. Routing policies allow you to set IP prefix filters to define the incoming route announcements to accept from the peer, and the outgoing routes to announce to the peer. :param name: Name of the routing policy. :param region: Region to target. If none is passed will use default region from the config. :param project_id: ID of the Project to create the routing policy in. :param tags: List of tags to apply to the routing policy. :param prefix_filter_in: IP prefixes to accept from the peer (ranges of route announcements to accept). :param prefix_filter_out: IP prefix filters to advertise to the peer (ranges of routes to advertise). :return: RoutingPolicy

Usage:

result = api.create_routing_policy(
    name="example",
)

delete_link(*, link_id: str, region: Optional[str] = None) → Link

Delete a link. Delete an existing link, specified by its link ID. Note that as well as deleting the link here on the Scaleway side, it is also necessary to request deletion from the partner on their side. Only when this action has been carried out on both sides will the resource be completely deleted. :param link_id: ID of the link to delete. :param region: Region to target. If none is passed will use default region from the config. :return: Link

Usage:

result = api.delete_link(
    link_id="example",
)

delete_routing_policy(*, routing_policy_id: str, region: Optional[str] = None) → None

Delete a routing policy. Delete an existing routing policy, specified by its routing policy ID. :param routing_policy_id: ID of the routing policy to delete. :param region: Region to target. If none is passed will use default region from the config.

Usage:

result = api.delete_routing_policy(
    routing_policy_id="example",
)

detach_routing_policy(*, link_id: str, region: Optional[str] = None) → Link

Detach a routing policy. Detach a routing policy from an existing link. Without a routing policy, all routes across the link are blocked by default. :param link_id: ID of the link to detach a routing policy from. :param region: Region to target. If none is passed will use default region from the config. :return: Link

Usage:

result = api.detach_routing_policy(
    link_id="example",
)

detach_vpc(*, link_id: str, region: Optional[str] = None) → Link

Detach a VPC. Detach a VPC from an existing link. :param link_id: ID of the link to detach the VPC from. :param region: Region to target. If none is passed will use default region from the config. :return: Link

Usage:

result = api.detach_vpc(
    link_id="example",
)

disable_route_propagation(*, link_id: str, region: Optional[str] = None) → Link

Disable route propagation. Prevent any prefixes from being announced in the BGP session. Traffic will not be able to flow over the InterLink until route propagation is re-enabled. :param link_id: ID of the link on which to disable route propagation. :param region: Region to target. If none is passed will use default region from the config. :return: Link

Usage:

result = api.disable_route_propagation(
    link_id="example",
)

enable_route_propagation(*, link_id: str, region: Optional[str] = None) → Link

Enable route propagation. Enable all allowed prefixes (defined in a routing policy) to be announced in the BGP session. This allows traffic to flow between the attached VPC and the on-premises infrastructure along the announced routes. Note that by default, even when route propagation is enabled, all routes are blocked. It is essential to attach a routing policy to define the ranges of routes to announce. :param link_id: ID of the link on which to enable route propagation. :param region: Region to target. If none is passed will use default region from the config. :return: Link

Usage:

result = api.enable_route_propagation(
    link_id="example",
)

get_dedicated_connection(*, connection_id: str, region: Optional[str] = None) → DedicatedConnection

Get a dedicated connection. For self-hosted users, get a dedicated physical connection corresponding to the given ID. The response object includes information such as the connection’s name, status and total bandwidth. :param connection_id: ID of connection to get. :param region: Region to target. If none is passed will use default region from the config. :return: DedicatedConnection

Usage:

result = api.get_dedicated_connection(
    connection_id="example",
)

get_link(*, link_id: str, region: Optional[str] = None) → Link

Get a link. Get a link (InterLink session / logical InterLink resource) for the given link ID. The response object includes information about the link’s various configuration details. :param link_id: ID of the link to get. :param region: Region to target. If none is passed will use default region from the config. :return: Link

Usage:

result = api.get_link(
    link_id="example",
)

get_partner(*, partner_id: str, region: Optional[str] = None) → Partner

Get a partner. Get a partner for the given partner IP. The response object includes information such as the partner’s name, email address and portal URL. :param partner_id: ID of partner to get. :param region: Region to target. If none is passed will use default region from the config. :return: Partner

Usage:

result = api.get_partner(
    partner_id="example",
)

get_pop(*, pop_id: str, region: Optional[str] = None) → Pop

Get a PoP. Get a PoP for the given PoP ID. The response object includes the PoP’s name and information about its physical location. :param pop_id: ID of PoP to get. :param region: Region to target. If none is passed will use default region from the config. :return: Pop

Usage:

result = api.get_pop(
    pop_id="example",
)

get_routing_policy(*, routing_policy_id: str, region: Optional[str] = None) → RoutingPolicy

Get routing policy. Get a routing policy for the given routing policy ID. The response object gives information including the policy’s name, tags and prefix filters. :param routing_policy_id: ID of the routing policy to get. :param region: Region to target. If none is passed will use default region from the config. :return: RoutingPolicy

Usage:

result = api.get_routing_policy(
    routing_policy_id="example",
)

list_dedicated_connections(*, region: Optional[str] = None, order_by: Optional[ListDedicatedConnectionsRequestOrderBy] = None, page: Optional[int] = None, page_size: Optional[int] = None, project_id: Optional[str] = None, organization_id: Optional[str] = None, name: Optional[str] = None, tags: Optional[List[str]] = None, status: Optional[DedicatedConnectionStatus] = None, bandwidth_mbps: Optional[int] = None, pop_id: Optional[str] = None) → ListDedicatedConnectionsResponse

List dedicated connections. For self-hosted users, list their dedicated physical connections in a given region. By default, the connections returned in the list are ordered by name in ascending order, though this can be modified via the order_by field. :param region: Region to target. If none is passed will use default region from the config. :param order_by: Order in which to return results. :param page: Page number to return. :param page_size: Maximum number of connections to return per page. :param project_id: Project ID to filter for. :param organization_id: Organization ID to filter for. :param name: Link name to filter for. :param tags: Tags to filter for. :param status: Connection status to filter for. :param bandwidth_mbps: Filter for dedicated connections with this bandwidth size. :param pop_id: Filter for dedicated connections present in this PoP. :return: ListDedicatedConnectionsResponse

Usage:

result = api.list_dedicated_connections()

list_dedicated_connections_all(*, region: Optional[str] = None, order_by: Optional[ListDedicatedConnectionsRequestOrderBy] = None, page: Optional[int] = None, page_size: Optional[int] = None, project_id: Optional[str] = None, organization_id: Optional[str] = None, name: Optional[str] = None, tags: Optional[List[str]] = None, status: Optional[DedicatedConnectionStatus] = None, bandwidth_mbps: Optional[int] = None, pop_id: Optional[str] = None) → List[DedicatedConnection]

List dedicated connections. For self-hosted users, list their dedicated physical connections in a given region. By default, the connections returned in the list are ordered by name in ascending order, though this can be modified via the order_by field. :param region: Region to target. If none is passed will use default region from the config. :param order_by: Order in which to return results. :param page: Page number to return. :param page_size: Maximum number of connections to return per page. :param project_id: Project ID to filter for. :param organization_id: Organization ID to filter for. :param name: Link name to filter for. :param tags: Tags to filter for. :param status: Connection status to filter for. :param bandwidth_mbps: Filter for dedicated connections with this bandwidth size. :param pop_id: Filter for dedicated connections present in this PoP. :return: List[DedicatedConnection]

Usage:

result = api.list_dedicated_connections_all()

list_links(*, region: Optional[str] = None, order_by: Optional[ListLinksRequestOrderBy] = None, page: Optional[int] = None, page_size: Optional[int] = None, project_id: Optional[str] = None, organization_id: Optional[str] = None, name: Optional[str] = None, tags: Optional[List[str]] = None, status: Optional[LinkStatus] = None, bgp_v4_status: Optional[BgpStatus] = None, bgp_v6_status: Optional[BgpStatus] = None, pop_id: Optional[str] = None, bandwidth_mbps: Optional[int] = None, partner_id: Optional[str] = None, vpc_id: Optional[str] = None, routing_policy_id: Optional[str] = None, pairing_key: Optional[str] = None, kind: Optional[LinkKind] = None, connection_id: Optional[str] = None) → ListLinksResponse

List links. List all your links (InterLink connections). A number of filters are available, including Project ID, name, tags and status. :param region: Region to target. If none is passed will use default region from the config. :param order_by: Order in which to return results. :param page: Page number to return. :param page_size: Maximum number of links to return per page. :param project_id: Project ID to filter for. :param organization_id: Organization ID to filter for. :param name: Link name to filter for. :param tags: Tags to filter for. :param status: Link status to filter for. :param bgp_v4_status: BGP IPv4 status to filter for. :param bgp_v6_status: BGP IPv6 status to filter for. :param pop_id: Filter for links attached to this PoP (via connections). :param bandwidth_mbps: Filter for link bandwidth (in Mbps). :param partner_id: Filter for links hosted by this partner. :param vpc_id: Filter for links attached to this VPC. :param routing_policy_id: Filter for links using this routing policy. :param pairing_key: Filter for the link with this pairing_key. :param kind: Filter for hosted or self-hosted links. :param connection_id: Filter for links self-hosted on this connection. :return: ListLinksResponse

Usage:

result = api.list_links()

list_links_all(*, region: Optional[str] = None, order_by: Optional[ListLinksRequestOrderBy] = None, page: Optional[int] = None, page_size: Optional[int] = None, project_id: Optional[str] = None, organization_id: Optional[str] = None, name: Optional[str] = None, tags: Optional[List[str]] = None, status: Optional[LinkStatus] = None, bgp_v4_status: Optional[BgpStatus] = None, bgp_v6_status: Optional[BgpStatus] = None, pop_id: Optional[str] = None, bandwidth_mbps: Optional[int] = None, partner_id: Optional[str] = None, vpc_id: Optional[str] = None, routing_policy_id: Optional[str] = None, pairing_key: Optional[str] = None, kind: Optional[LinkKind] = None, connection_id: Optional[str] = None) → List[Link]

List links. List all your links (InterLink connections). A number of filters are available, including Project ID, name, tags and status. :param region: Region to target. If none is passed will use default region from the config. :param order_by: Order in which to return results. :param page: Page number to return. :param page_size: Maximum number of links to return per page. :param project_id: Project ID to filter for. :param organization_id: Organization ID to filter for. :param name: Link name to filter for. :param tags: Tags to filter for. :param status: Link status to filter for. :param bgp_v4_status: BGP IPv4 status to filter for. :param bgp_v6_status: BGP IPv6 status to filter for. :param pop_id: Filter for links attached to this PoP (via connections). :param bandwidth_mbps: Filter for link bandwidth (in Mbps). :param partner_id: Filter for links hosted by this partner. :param vpc_id: Filter for links attached to this VPC. :param routing_policy_id: Filter for links using this routing policy. :param pairing_key: Filter for the link with this pairing_key. :param kind: Filter for hosted or self-hosted links. :param connection_id: Filter for links self-hosted on this connection. :return: List[Link]

Usage:

result = api.list_links_all()

list_partners(*, region: Optional[str] = None, order_by: Optional[ListPartnersRequestOrderBy] = None, page: Optional[int] = None, page_size: Optional[int] = None, pop_ids: Optional[List[str]] = None) → ListPartnersResponse

List available partners. List all available partners. By default, the partners returned in the list are ordered by name in ascending order, though this can be modified via the order_by field. :param region: Region to target. If none is passed will use default region from the config. :param order_by: Order in which to return results. :param page: Page number to return. :param page_size: Maximum number of partners to return per page. :param pop_ids: Filter for partners present (offering a connection) in one of these PoPs. :return: ListPartnersResponse

Usage:

result = api.list_partners()

list_partners_all(*, region: Optional[str] = None, order_by: Optional[ListPartnersRequestOrderBy] = None, page: Optional[int] = None, page_size: Optional[int] = None, pop_ids: Optional[List[str]] = None) → List[Partner]

List available partners. List all available partners. By default, the partners returned in the list are ordered by name in ascending order, though this can be modified via the order_by field. :param region: Region to target. If none is passed will use default region from the config. :param order_by: Order in which to return results. :param page: Page number to return. :param page_size: Maximum number of partners to return per page. :param pop_ids: Filter for partners present (offering a connection) in one of these PoPs. :return: List[Partner]

Usage:

result = api.list_partners_all()

list_pops(*, region: Optional[str] = None, order_by: Optional[ListPopsRequestOrderBy] = None, page: Optional[int] = None, page_size: Optional[int] = None, name: Optional[str] = None, hosting_provider_name: Optional[str] = None, partner_id: Optional[str] = None, link_bandwidth_mbps: Optional[int] = None, dedicated_available: Optional[bool] = None) → ListPopsResponse

List PoPs. List all available PoPs (locations) for a given region. By default, the results are returned in ascending alphabetical order by name. :param region: Region to target. If none is passed will use default region from the config. :param order_by: Order in which to return results. :param page: Page number to return. :param page_size: Maximum number of PoPs to return per page. :param name: PoP name to filter for. :param hosting_provider_name: Hosting provider name to filter for. :param partner_id: Filter for PoPs hosting an available shared connection from this partner. :param link_bandwidth_mbps: Filter for PoPs with a shared connection allowing this bandwidth size. Note that we cannot guarantee that PoPs returned will have available capacity. :param dedicated_available: Filter for PoPs with a dedicated connection available for self-hosted links. :return: ListPopsResponse

Usage:

result = api.list_pops()

list_pops_all(*, region: Optional[str] = None, order_by: Optional[ListPopsRequestOrderBy] = None, page: Optional[int] = None, page_size: Optional[int] = None, name: Optional[str] = None, hosting_provider_name: Optional[str] = None, partner_id: Optional[str] = None, link_bandwidth_mbps: Optional[int] = None, dedicated_available: Optional[bool] = None) → List[Pop]

List PoPs. List all available PoPs (locations) for a given region. By default, the results are returned in ascending alphabetical order by name. :param region: Region to target. If none is passed will use default region from the config. :param order_by: Order in which to return results. :param page: Page number to return. :param page_size: Maximum number of PoPs to return per page. :param name: PoP name to filter for. :param hosting_provider_name: Hosting provider name to filter for. :param partner_id: Filter for PoPs hosting an available shared connection from this partner. :param link_bandwidth_mbps: Filter for PoPs with a shared connection allowing this bandwidth size. Note that we cannot guarantee that PoPs returned will have available capacity. :param dedicated_available: Filter for PoPs with a dedicated connection available for self-hosted links. :return: List[Pop]

Usage:

result = api.list_pops_all()

list_routing_policies(*, region: Optional[str] = None, order_by: Optional[ListRoutingPoliciesRequestOrderBy] = None, page: Optional[int] = None, page_size: Optional[int] = None, project_id: Optional[str] = None, organization_id: Optional[str] = None, name: Optional[str] = None, tags: Optional[List[str]] = None) → ListRoutingPoliciesResponse

List routing policies. List all routing policies in a given region. A routing policy can be attached to one or multiple links (InterLink connections). :param region: Region to target. If none is passed will use default region from the config. :param order_by: Order in which to return results. :param page: Page number to return. :param page_size: Maximum number of routing policies to return per page. :param project_id: Project ID to filter for. :param organization_id: Organization ID to filter for. :param name: Routing policy name to filter for. :param tags: Tags to filter for. :return: ListRoutingPoliciesResponse

Usage:

result = api.list_routing_policies()

list_routing_policies_all(*, region: Optional[str] = None, order_by: Optional[ListRoutingPoliciesRequestOrderBy] = None, page: Optional[int] = None, page_size: Optional[int] = None, project_id: Optional[str] = None, organization_id: Optional[str] = None, name: Optional[str] = None, tags: Optional[List[str]] = None) → List[RoutingPolicy]

List routing policies. List all routing policies in a given region. A routing policy can be attached to one or multiple links (InterLink connections). :param region: Region to target. If none is passed will use default region from the config. :param order_by: Order in which to return results. :param page: Page number to return. :param page_size: Maximum number of routing policies to return per page. :param project_id: Project ID to filter for. :param organization_id: Organization ID to filter for. :param name: Routing policy name to filter for. :param tags: Tags to filter for. :return: List[RoutingPolicy]

Usage:

result = api.list_routing_policies_all()

update_link(*, link_id: str, region: Optional[str] = None, name: Optional[str] = None, tags: Optional[List[str]] = None) → Link

Update a link. Update an existing link, specified by its link ID. Only its name and tags can be updated. :param link_id: ID of the link to update. :param region: Region to target. If none is passed will use default region from the config. :param name: Name of the link. :param tags: List of tags to apply to the link. :return: Link

Usage:

result = api.update_link(
    link_id="example",
)

update_routing_policy(*, routing_policy_id: str, region: Optional[str] = None, name: Optional[str] = None, tags: Optional[List[str]] = None, prefix_filter_in: Optional[List[str]] = None, prefix_filter_out: Optional[List[str]] = None) → RoutingPolicy

Update a routing policy. Update an existing routing policy, specified by its routing policy ID. Its name, tags and incoming/outgoing prefix filters can be updated. :param routing_policy_id: ID of the routing policy to update. :param region: Region to target. If none is passed will use default region from the config. :param name: Name of the routing policy. :param tags: List of tags to apply to the routing policy. :param prefix_filter_in: IP prefixes to accept from the peer (ranges of route announcements to accept). :param prefix_filter_out: IP prefix filters for routes to advertise to the peer (ranges of routes to advertise). :return: RoutingPolicy

Usage:

result = api.update_routing_policy(
    routing_policy_id="example",
)

wait_for_dedicated_connection(*, connection_id: str, region: Optional[str] = None, options: Optional[WaitForOptions[DedicatedConnection, bool]] = None) → DedicatedConnection

Get a dedicated connection. For self-hosted users, get a dedicated physical connection corresponding to the given ID. The response object includes information such as the connection’s name, status and total bandwidth. :param connection_id: ID of connection to get. :param region: Region to target. If none is passed will use default region from the config. :return: DedicatedConnection

Usage:

result = api.get_dedicated_connection(
    connection_id="example",
)

wait_for_link(*, link_id: str, region: Optional[str] = None, options: Optional[WaitForOptions[Link, bool]] = None) → Link

Get a link. Get a link (InterLink session / logical InterLink resource) for the given link ID. The response object includes information about the link’s various configuration details. :param link_id: ID of the link to get. :param region: Region to target. If none is passed will use default region from the config. :return: Link

Usage:

result = api.get_link(
    link_id="example",
)

class scaleway.interlink.v1beta1.Link(id: 'str', project_id: 'str', organization_id: 'str', name: 'str', tags: 'List[str]', pop_id: 'str', bandwidth_mbps: 'int', status: 'LinkStatus', bgp_v4_status: 'BgpStatus', bgp_v6_status: 'BgpStatus', enable_route_propagation: 'bool', vlan: 'int', region: 'ScwRegion', vpc_id: 'Optional[str]', routing_policy_id: 'Optional[str]', created_at: 'Optional[datetime]', updated_at: 'Optional[datetime]', scw_bgp_config: 'Optional[BgpConfig]', peer_bgp_config: 'Optional[BgpConfig]', partner: 'Optional[PartnerHost]', self_: 'Optional[SelfHost]')

Bases: object

bandwidth_mbps: int

Rate limited bandwidth of the link.

bgp_v4_status: BgpStatus

Status of the link’s BGP IPv4 session.

bgp_v6_status: BgpStatus

Status of the link’s BGP IPv6 session.

created_at: Optional[datetime]

Creation date of the link.

enable_route_propagation: bool

Defines whether route propagation is enabled or not. To enable or disable route propagation, use the dedicated endpoint.

id: str

Unique identifier of the link.

name: str

Name of the link.

organization_id: str

Organization ID.

partner: Optional[PartnerHost]

peer_bgp_config: Optional[BgpConfig]

BGP configuration on peer’s side (on-premises or other hosting provider).

pop_id: str

ID of the PoP where the link’s corresponding connection is located.

project_id: str

Project ID.

region: str

Region of the link.

routing_policy_id: Optional[str]

ID of the routing policy attached to the link.

scw_bgp_config: Optional[BgpConfig]

BGP configuration on Scaleway’s side.

self_: Optional[SelfHost]

status: LinkStatus

Status of the link.

tags: List[str]

List of tags associated with the link.

updated_at: Optional[datetime]

Last modification date of the link.

vlan: int

VLAN of the link.

vpc_id: Optional[str]

ID of the Scaleway VPC attached to the link.

class scaleway.interlink.v1beta1.LinkKind(value: str, names: Optional[Any] = None, *args: Any, **kwargs: Any)

Bases: str, Enum

An enumeration.

HOSTED = 'hosted'

SELF_HOSTED = 'self_hosted'

class scaleway.interlink.v1beta1.LinkStatus(value: str, names: Optional[Any] = None, *args: Any, **kwargs: Any)

Bases: str, Enum

An enumeration.

ACTIVE = 'active'

ALL_DOWN = 'all_down'

CONFIGURING = 'configuring'

DELETED = 'deleted'

DEPROVISIONING = 'deprovisioning'

EXPIRED = 'expired'

FAILED = 'failed'

LIMITED_CONNECTIVITY = 'limited_connectivity'

LOCKED = 'locked'

PROVISIONING = 'provisioning'

REFUSED = 'refused'

REQUESTED = 'requested'

UNKNOWN_LINK_STATUS = 'unknown_link_status'

class scaleway.interlink.v1beta1.ListDedicatedConnectionsRequest(region: 'Optional[ScwRegion]', order_by: 'Optional[ListDedicatedConnectionsRequestOrderBy]', page: 'Optional[int]', page_size: 'Optional[int]', project_id: 'Optional[str]', organization_id: 'Optional[str]', name: 'Optional[str]', tags: 'Optional[List[str]]', status: 'Optional[DedicatedConnectionStatus]', bandwidth_mbps: 'Optional[int]', pop_id: 'Optional[str]')

Bases: object

bandwidth_mbps: Optional[int]

Filter for dedicated connections with this bandwidth size.

name: Optional[str]

Link name to filter for.

order_by: Optional[ListDedicatedConnectionsRequestOrderBy]

Order in which to return results.

organization_id: Optional[str]

Organization ID to filter for.

page: Optional[int]

Page number to return.

page_size: Optional[int]

Maximum number of connections to return per page.

pop_id: Optional[str]

Filter for dedicated connections present in this PoP.

project_id: Optional[str]

Project ID to filter for.

region: Optional[str]

Region to target. If none is passed will use default region from the config.

status: Optional[DedicatedConnectionStatus]

Connection status to filter for.

tags: Optional[List[str]]

Tags to filter for.

class scaleway.interlink.v1beta1.ListDedicatedConnectionsRequestOrderBy(value: str, names: Optional[Any] = None, *args: Any, **kwargs: Any)

Bases: str, Enum

An enumeration.

CREATED_AT_ASC = 'created_at_asc'

CREATED_AT_DESC = 'created_at_desc'

NAME_ASC = 'name_asc'

NAME_DESC = 'name_desc'

STATUS_ASC = 'status_asc'

STATUS_DESC = 'status_desc'

UPDATED_AT_ASC = 'updated_at_asc'

UPDATED_AT_DESC = 'updated_at_desc'

class scaleway.interlink.v1beta1.ListDedicatedConnectionsResponse(connections: 'List[DedicatedConnection]', total_count: 'int')

Bases: object

connections: List[DedicatedConnection]

List of connections on current page.

total_count: int

Total number of connections returned.

class scaleway.interlink.v1beta1.ListLinksRequest(region: 'Optional[ScwRegion]', order_by: 'Optional[ListLinksRequestOrderBy]', page: 'Optional[int]', page_size: 'Optional[int]', project_id: 'Optional[str]', organization_id: 'Optional[str]', name: 'Optional[str]', tags: 'Optional[List[str]]', status: 'Optional[LinkStatus]', bgp_v4_status: 'Optional[BgpStatus]', bgp_v6_status: 'Optional[BgpStatus]', pop_id: 'Optional[str]', bandwidth_mbps: 'Optional[int]', partner_id: 'Optional[str]', vpc_id: 'Optional[str]', routing_policy_id: 'Optional[str]', pairing_key: 'Optional[str]', kind: 'Optional[LinkKind]', connection_id: 'Optional[str]')

Bases: object

bandwidth_mbps: Optional[int]

Filter for link bandwidth (in Mbps).

bgp_v4_status: Optional[BgpStatus]

BGP IPv4 status to filter for.

bgp_v6_status: Optional[BgpStatus]

BGP IPv6 status to filter for.

connection_id: Optional[str]

Filter for links self-hosted on this connection.

kind: Optional[LinkKind]

Filter for hosted or self-hosted links.

name: Optional[str]

Link name to filter for.

order_by: Optional[ListLinksRequestOrderBy]

Order in which to return results.

organization_id: Optional[str]

Organization ID to filter for.

page: Optional[int]

Page number to return.

page_size: Optional[int]

Maximum number of links to return per page.

pairing_key: Optional[str]

Filter for the link with this pairing_key.

partner_id: Optional[str]

Filter for links hosted by this partner.

pop_id: Optional[str]

Filter for links attached to this PoP (via connections).

project_id: Optional[str]

Project ID to filter for.

region: Optional[str]

Region to target. If none is passed will use default region from the config.

routing_policy_id: Optional[str]

Filter for links using this routing policy.

status: Optional[LinkStatus]

Link status to filter for.

tags: Optional[List[str]]

Tags to filter for.

vpc_id: Optional[str]

Filter for links attached to this VPC.

class scaleway.interlink.v1beta1.ListLinksRequestOrderBy(value: str, names: Optional[Any] = None, *args: Any, **kwargs: Any)

Bases: str, Enum

An enumeration.

CREATED_AT_ASC = 'created_at_asc'

CREATED_AT_DESC = 'created_at_desc'

NAME_ASC = 'name_asc'

NAME_DESC = 'name_desc'

STATUS_ASC = 'status_asc'

STATUS_DESC = 'status_desc'

class scaleway.interlink.v1beta1.ListLinksResponse(links: 'List[Link]', total_count: 'int')

Bases: object

links: List[Link]

List of links on the current page.

total_count: int

Total number of links.

class scaleway.interlink.v1beta1.ListPartnersRequest(region: 'Optional[ScwRegion]', order_by: 'Optional[ListPartnersRequestOrderBy]', page: 'Optional[int]', page_size: 'Optional[int]', pop_ids: 'Optional[List[str]]')

Bases: object

order_by: Optional[ListPartnersRequestOrderBy]

Order in which to return results.

page: Optional[int]

Page number to return.

page_size: Optional[int]

Maximum number of partners to return per page.

pop_ids: Optional[List[str]]

Filter for partners present (offering a connection) in one of these PoPs.

region: Optional[str]

Region to target. If none is passed will use default region from the config.

class scaleway.interlink.v1beta1.ListPartnersRequestOrderBy(value: str, names: Optional[Any] = None, *args: Any, **kwargs: Any)

Bases: str, Enum

An enumeration.

NAME_ASC = 'name_asc'

NAME_DESC = 'name_desc'

class scaleway.interlink.v1beta1.ListPartnersResponse(partners: 'List[Partner]', total_count: 'int')

Bases: object

partners: List[Partner]

List of partners on current page.

total_count: int

Total number of partners returned.

class scaleway.interlink.v1beta1.ListPopsRequest(region: 'Optional[ScwRegion]', order_by: 'Optional[ListPopsRequestOrderBy]', page: 'Optional[int]', page_size: 'Optional[int]', name: 'Optional[str]', hosting_provider_name: 'Optional[str]', partner_id: 'Optional[str]', link_bandwidth_mbps: 'Optional[int]', dedicated_available: 'Optional[bool]')

Bases: object

dedicated_available: Optional[bool]

Filter for PoPs with a dedicated connection available for self-hosted links.

hosting_provider_name: Optional[str]

Hosting provider name to filter for.

link_bandwidth_mbps: Optional[int]

Filter for PoPs with a shared connection allowing this bandwidth size. Note that we cannot guarantee that PoPs returned will have available capacity.

name: Optional[str]

PoP name to filter for.

order_by: Optional[ListPopsRequestOrderBy]

Order in which to return results.

page: Optional[int]

Page number to return.

page_size: Optional[int]

Maximum number of PoPs to return per page.

partner_id: Optional[str]

Filter for PoPs hosting an available shared connection from this partner.

region: Optional[str]

Region to target. If none is passed will use default region from the config.

class scaleway.interlink.v1beta1.ListPopsRequestOrderBy(value: str, names: Optional[Any] = None, *args: Any, **kwargs: Any)

Bases: str, Enum

An enumeration.

NAME_ASC = 'name_asc'

NAME_DESC = 'name_desc'

class scaleway.interlink.v1beta1.ListPopsResponse(pops: 'List[Pop]', total_count: 'int')

Bases: object

pops: List[Pop]

List of PoPs on the current page.

total_count: int

Total number of PoPs.

class scaleway.interlink.v1beta1.ListRoutingPoliciesRequest(region: 'Optional[ScwRegion]', order_by: 'Optional[ListRoutingPoliciesRequestOrderBy]', page: 'Optional[int]', page_size: 'Optional[int]', project_id: 'Optional[str]', organization_id: 'Optional[str]', name: 'Optional[str]', tags: 'Optional[List[str]]')

Bases: object

name: Optional[str]

Routing policy name to filter for.

order_by: Optional[ListRoutingPoliciesRequestOrderBy]

Order in which to return results.

organization_id: Optional[str]

Organization ID to filter for.

page: Optional[int]

Page number to return.

page_size: Optional[int]

Maximum number of routing policies to return per page.

project_id: Optional[str]

Project ID to filter for.

region: Optional[str]

Region to target. If none is passed will use default region from the config.

tags: Optional[List[str]]

Tags to filter for.

class scaleway.interlink.v1beta1.ListRoutingPoliciesRequestOrderBy(value: str, names: Optional[Any] = None, *args: Any, **kwargs: Any)

Bases: str, Enum

An enumeration.

CREATED_AT_ASC = 'created_at_asc'

CREATED_AT_DESC = 'created_at_desc'

NAME_ASC = 'name_asc'

NAME_DESC = 'name_desc'

class scaleway.interlink.v1beta1.ListRoutingPoliciesResponse(routing_policies: 'List[RoutingPolicy]', total_count: 'int')

Bases: object

routing_policies: List[RoutingPolicy]

total_count: int

class scaleway.interlink.v1beta1.Partner(id: 'str', name: 'str', contact_email: 'str', logo_url: 'str', portal_url: 'str', created_at: 'Optional[datetime]', updated_at: 'Optional[datetime]')

Bases: object

contact_email: str

Contact email address of partner.

created_at: Optional[datetime]

Creation date of the partner.

id: str

Unique identifier of the partner.

logo_url: str

Image URL of the partner’s logo.

name: str

Name of the partner.

portal_url: str

URL of the partner’s portal.

updated_at: Optional[datetime]

Last modification date of the partner.

class scaleway.interlink.v1beta1.PartnerHost(partner_id: 'str', pairing_key: 'str', disapproved_reason: 'Optional[str]')

Bases: object

disapproved_reason: Optional[str]

Reason given by partner to explain why they did not approve the request for a hosted link.

pairing_key: str

Used to identify a link from a user or partner’s point of view.

partner_id: str

ID of the partner facilitating the link.

class scaleway.interlink.v1beta1.Pop(id: 'str', name: 'str', hosting_provider_name: 'str', address: 'str', city: 'str', logo_url: 'str', available_link_bandwidths_mbps: 'List[int]', region: 'ScwRegion')

Bases: object

address: str

Physical address of the PoP.

available_link_bandwidths_mbps: List[int]

Available bandwidth in Mbits/s for future hosted links from available connections in this PoP.

city: str

City where PoP is located.

hosting_provider_name: str

Name of the PoP’s hosting provider, e.g. Telehouse for TH2 or OpCore for DC3.

id: str

Unique identifier of the PoP.

logo_url: str

Image URL of the PoP’s logo.

name: str

Name of the PoP. It is the common reference of Hosting DC (ex: TH2).

region: str

Region of the PoP.

class scaleway.interlink.v1beta1.RoutingPolicy(id: 'str', project_id: 'str', organization_id: 'str', name: 'str', tags: 'List[str]', prefix_filter_in: 'List[str]', prefix_filter_out: 'List[str]', region: 'ScwRegion', created_at: 'Optional[datetime]', updated_at: 'Optional[datetime]')

Bases: object

created_at: Optional[datetime]

Creation date of the routing policy.

id: str

Unique identifier of the routing policy.

name: str

Name of the routing policy.

organization_id: str

Organization ID.

prefix_filter_in: List[str]

IP prefixes to accept from the peer (ranges of route announcements to accept).

prefix_filter_out: List[str]

IP prefix filters to advertise to the peer (ranges of routes to advertise).

project_id: str

Project ID.

region: str

Region of the routing policy.

tags: List[str]

List of tags associated with the routing policy.

updated_at: Optional[datetime]

Last modification date of the routing policy.

class scaleway.interlink.v1beta1.SelfHost(connection_id: 'str')

Bases: object

connection_id: str

Dedicated physical connection supporting the link.

class scaleway.interlink.v1beta1.UpdateLinkRequest(link_id: 'str', region: 'Optional[ScwRegion]', name: 'Optional[str]', tags: 'Optional[List[str]]')

Bases: object

link_id: str

ID of the link to update.

name: Optional[str]

Name of the link.

region: Optional[str]

Region to target. If none is passed will use default region from the config.

tags: Optional[List[str]]

List of tags to apply to the link.

class scaleway.interlink.v1beta1.UpdateRoutingPolicyRequest(routing_policy_id: 'str', region: 'Optional[ScwRegion]', name: 'Optional[str]', tags: 'Optional[List[str]]', prefix_filter_in: 'Optional[List[str]]', prefix_filter_out: 'Optional[List[str]]')

Bases: object

name: Optional[str]

Name of the routing policy.

prefix_filter_in: Optional[List[str]]

IP prefixes to accept from the peer (ranges of route announcements to accept).

prefix_filter_out: Optional[List[str]]

IP prefix filters for routes to advertise to the peer (ranges of routes to advertise).

region: Optional[str]

Region to target. If none is passed will use default region from the config.

routing_policy_id: str

ID of the routing policy to update.

tags: Optional[List[str]]

List of tags to apply to the routing policy.