Interconnect / Client / get_environment

get_environment¶

Interconnect.Client.get_environment(**kwargs)¶

Describes a specific Environment

Request Syntax

response = client.get_environment(
    id='string'
)

Parameters:

id (string) –

[REQUIRED]

The identifier of the specific Environment to describe.

Return type:

dict

Returns:

Response Syntax

{
    'environment': {
        'provider': {
            'cloudServiceProvider': 'string',
            'lastMileProvider': 'string'
        },
        'location': 'string',
        'environmentId': 'string',
        'state': 'available'|'limited'|'unavailable',
        'bandwidths': {
            'available': [
                'string',
            ],
            'supported': [
                'string',
            ]
        },
        'type': 'string',
        'activationPageUrl': 'string',
        'remoteIdentifierType': 'account'|'email'
    }
}

Response Structure

(dict) –
- environment (dict) –
  
  The requested Environment structure.
  - provider (dict) –
    
    The provider on the remote side of this Connection.
    Note
    This is a Tagged Union structure. Only one of the following top level keys will be set: cloudServiceProvider, lastMileProvider. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
    'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
    - cloudServiceProvider (string) –
      
      The provider’s name. Specifically, connections to/from this Cloud Service Provider will be considered Multicloud connections.
    - lastMileProvider (string) –
      
      The provider’s name. Specifically, connections to/from this Last Mile Provider will be considered LastMile connections.
  - location (string) –
    
    The provider specific location on the remote side of this Connection.
  - environmentId (string) –
    
    The identifier of this Environment
  - state (string) –
    
    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.
  - bandwidths (dict) –
    
    The sets of bandwidths that are available and supported on this environment.
    - available (list) –
      
      The list of currently available bandwidths.
      - (string) –
    - supported (list) –
      
      The list of all bandwidths that this environment plans to support
      - (string) –
  - type (string) –
    
    The specific product type of Connection objects provided by this Environment.
  - activationPageUrl (string) –
    
    An HTTPS URL on the remote partner portal where the Activation Key should be brought to complete the creation process.
  - remoteIdentifierType (string) –
    
    The type of identifying information that should be supplied to the remoteAccount parameter of a CreateConnection call for this specific Environment.

Exceptions

Interconnect.Client.exceptions.ResourceNotFoundException
Interconnect.Client.exceptions.InterconnectClientException
Interconnect.Client.exceptions.ThrottlingException
Interconnect.Client.exceptions.AccessDeniedException
Interconnect.Client.exceptions.InterconnectValidationException
Interconnect.Client.exceptions.ServiceQuotaExceededException
Interconnect.Client.exceptions.InterconnectServerException