Class DescribeCustomerMetadataCommandProtected

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

Example

Use a bare-bones client and the command you need to make an API call.

import { DirectConnectClient, DescribeCustomerMetadataCommand } from "@aws-sdk/client-direct-connect"; // ES Modules import
// const { DirectConnectClient, DescribeCustomerMetadataCommand } = require("@aws-sdk/client-direct-connect"); // CommonJS import
const client = new DirectConnectClient(config);
const input = {};
const command = new DescribeCustomerMetadataCommand(input);
const response = await client.send(command);
// { // DescribeCustomerMetadataResponse
//   agreements: [ // AgreementList
//     { // CustomerAgreement
//       agreementName: "STRING_VALUE",
//       status: "STRING_VALUE",
//     },
//   ],
//   nniPartnerType: "v1" || "v2" || "nonPartner",
// };

Param

DescribeCustomerMetadataCommandInput

Returns

DescribeCustomerMetadataCommandOutput

See

• DescribeCustomerMetadataCommandInput for command's input shape.
• DescribeCustomerMetadataCommandOutput for command's response shape.
• config for DirectConnectClient's config shape.

Throws

DirectConnectClientException (client fault)

One or more parameters are not valid.

Throws

DirectConnectServerException (server fault)

A server-side error occurred.

Throws

DirectConnectServiceException

Base exception class for all service exceptions from DirectConnect service.