DirectConnect / Client / describe_locations

describe_locations¶

DirectConnect.Client.describe_locations()¶

Lists the Direct Connect locations in the current Amazon Web Services Region. These are the locations that can be selected when calling CreateConnection or CreateInterconnect.

Request Syntax

response = client.describe_locations()

Return type:

dict

Returns:

Response Syntax

{
    'locations': [
        {
            'locationCode': 'string',
            'locationName': 'string',
            'region': 'string',
            'availablePortSpeeds': [
                'string',
            ],
            'availableProviders': [
                'string',
            ],
            'availableMacSecPortSpeeds': [
                'string',
            ],
            'availableBillingModes': [
                {
                    'billingMode': 'PayAsYouGo'|'FlatRateTier1'|'FlatRateTier2'|'FlatRateTier3'|'FlatRateTier4'|'FlatRateTier5'|'PortPairFlatRateTier1'|'PortPairFlatRateTier2'|'PortPairFlatRateTier3'|'PortPairFlatRateTier4'|'PortPairFlatRateTier5',
                    'availablePortSpeeds': [
                        'string',
                    ],
                    'includedRegions': [
                        'string',
                    ]
                },
            ]
        },
    ]
}

Response Structure

(dict) –
- locations (list) –
  
  The locations.
  - (dict) –
    
    Information about an Direct Connect location.
    - locationCode (string) –
      
      The code for the location.
    - locationName (string) –
      
      The name of the location. This includes the name of the colocation partner and the physical site of the building.
    - region (string) –
      
      The Amazon Web Services Region for the location.
    - availablePortSpeeds (list) –
      
      The available port speeds for the location.
      - (string) –
    - availableProviders (list) –
      
      The name of the service provider for the location.
      - (string) –
    - availableMacSecPortSpeeds (list) –
      
      The available MAC Security (MACsec) port speeds for the location.
      - (string) –
    - availableBillingModes (list) –
      
      The billing modes available at the location, including the port speeds and Amazon Web Services Regions supported by each mode.
      - (dict) –
        
        Information about a billing mode available at an Direct Connect location.
        
        billingMode (string) –
        
        The billing mode.
        
        availablePortSpeeds (list) –
        
        The port speeds available for the billing mode.
        
        (string) –
        
        includedRegions (list) –
        
        The Amazon Web Services Regions included with the billing mode.
        
        (string) –

Exceptions

DirectConnect.Client.exceptions.DirectConnectServerException
DirectConnect.Client.exceptions.DirectConnectClientException