DescribeCustomerMetadata
Get and view a list of customer agreements, along with their signed status and whether the customer is an NNIPartner, NNIPartnerV2, or a nonPartner.
Response Syntax
{
"agreements": [
{
"agreementName": "string",
"status": "string"
}
],
"nniPartnerType": "string"
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- agreements
-
The list of customer agreements.
Type: Array of CustomerAgreement objects
- nniPartnerType
-
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.
Type: String
Valid Values:
v1 | v2 | nonPartner -
Errors
For information about the errors that are common to all actions, see Common Errors.
- DirectConnectClientException
-
One or more parameters are not valid.
HTTP Status Code: 400
- DirectConnectServerException
-
A server-side error occurred.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
