DirectConnect / Client / describe_customer_metadata

describe_customer_metadata¶

DirectConnect.Client.describe_customer_metadata()¶

Get and view a list of customer agreements, along with their signed status and whether the customer is an NNIPartner, NNIPartnerV2, or a nonPartner.

Request Syntax

response = client.describe_customer_metadata()

Return type:

dict

Returns:

Response Syntax

{
    'agreements': [
        {
            'agreementName': 'string',
            'status': 'string'
        },
    ],
    'nniPartnerType': 'v1'|'v2'|'nonPartner'
}

Response Structure

(dict) –
- agreements (list) –
  
  The list of customer agreements.
  - (dict) –
    
    The name and status of a customer agreement.
    - agreementName (string) –
      
      The name of the agreement.
    - status (string) –
      
      The status of the customer agreement. This will be either signed or unsigned
- nniPartnerType (string) –
  
  The type of network-to-network interface (NNI) partner. The partner type will be one of the following:
  - V1: This partner can only allocate 50Mbps, 100Mbps, 200Mbps, 300Mbps, 400Mbps, or 500Mbps subgigabit connections.
  - V2: This partner can only allocate 1GB, 2GB, 5GB, or 10GB hosted connections.
  - nonPartner: The customer is not a partner.

Exceptions

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