Skip to content

Environment

Source code in docs_src/capo_interconnect/types/environment.py
class Environment(TypedDict, closed=True):
    provider: "capo_interconnect.types.provider.Provider"
    """<p>The provider on the remote side of this <a>Connection</a>.</p>"""
    location: "capo_interconnect.types.location.Location"
    """<p>The provider specific location on the remote side of this <a>Connection</a>.</p>"""
    environment_id: "capo_interconnect.types.environment_id.EnvironmentId"
    """<p>The identifier of this <a>Environment</a> </p>"""
    state: "capo_interconnect.types.environment_state.EnvironmentState"
    """<p>The state of the <a>Environment</a>. Possible values:</p> <ul> <li> <p> <code>available</code>: The environment is available and new <a>Connection</a> objects can be requested.</p> </li> <li> <p> <code>limited</code>: The environment is available, but overall capacity is limited. The set of available bandwidths </p> </li> <li> <p> <code>unavailable</code>: The environment is currently unavailable.</p> </li> </ul>"""
    bandwidths: "capo_interconnect.types.bandwidths.Bandwidths"
    """<p>The sets of bandwidths that are available and supported on this environment.</p>"""
    type: "capo_interconnect.types.product_type.ProductType"
    """<p>The specific product type of <a>Connection</a> objects provided by this <a>Environment</a>.</p>"""
    activation_page_url: NotRequired["str"]
    """<p>An HTTPS URL on the remote partner portal where the Activation Key should be brought to complete the creation process.</p>"""
    remote_identifier_type: NotRequired[
        "capo_interconnect.types.remote_account_identifier_type.RemoteAccountIdentifierType"
    ]
    """<p>The type of identifying information that should be supplied to the <code>remoteAccount</code> parameter of a <a>CreateConnection</a> call for this specific Environment.</p>"""

activation_page_url instance-attribute

activation_page_url: NotRequired[str]

An HTTPS URL on the remote partner portal where the Activation Key should be brought to complete the creation process.

bandwidths instance-attribute

bandwidths: Bandwidths

The sets of bandwidths that are available and supported on this environment.

environment_id instance-attribute

environment_id: EnvironmentId

The identifier of this Environment

location instance-attribute

location: Location

The provider specific location on the remote side of this Connection.

provider instance-attribute

provider: Provider

The provider on the remote side of this Connection.

remote_identifier_type instance-attribute

remote_identifier_type: NotRequired[RemoteAccountIdentifierType]

The type of identifying information that should be supplied to the remoteAccount parameter of a CreateConnection call for this specific Environment.

state instance-attribute

The state of the Environment. Possible values:

  • available: The environment is available and new Connection objects can be requested.

  • limited: The environment is available, but overall capacity is limited. The set of available bandwidths

  • unavailable: The environment is currently unavailable.

type instance-attribute

The specific product type of Connection objects provided by this Environment.