AWS Direct Connect

The confirmation of the terms of agreement when creating the connection/link aggregation group (LAG).

See also: AWS API Documentation

Request Syntax

client.confirm_customer_agreement(
    agreementName='string'
)

type agreementName:

string

param agreementName:

The name of the customer agreement.

rtype:

dict

returns:

Response Syntax

{
    'status': 'string'
}

Response Structure

• (dict) --

  • status (string) --

    The status of the customer agreement when the connection was created. This will be either signed or unsigned.

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

See also: AWS API Documentation

Request Syntax

client.describe_customer_metadata()

rtype:

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.

Details about the router.

See also: AWS API Documentation

Request Syntax

client.describe_router_configuration(
    virtualInterfaceId='string',
    routerTypeIdentifier='string'
)

type virtualInterfaceId:

string

param virtualInterfaceId:

[REQUIRED]

The ID of the virtual interface.

type routerTypeIdentifier:

string

param routerTypeIdentifier:

Identifies the router by a combination of vendor, platform, and software version. For example, CiscoSystemsInc-2900SeriesRouters-IOS124.

rtype:

dict

returns:

Response Syntax

{
    'customerRouterConfig': 'string',
    'router': {
        'vendor': 'string',
        'platform': 'string',
        'software': 'string',
        'xsltTemplateName': 'string',
        'xsltTemplateNameForMacSec': 'string',
        'routerTypeIdentifier': 'string'
    },
    'virtualInterfaceId': 'string',
    'virtualInterfaceName': 'string'
}

Response Structure

• (dict) --

  • customerRouterConfig (string) --

    The customer router configuration.

  • router (dict) --

    The details about the router.

    • vendor (string) --

      The vendor for the virtual interface's router.

    • platform (string) --

      The virtual interface router platform.

    • software (string) --

      The router software.

    • xsltTemplateName (string) --

      The template for the virtual interface's router.

    • xsltTemplateNameForMacSec (string) --

      The MAC Security (MACsec) template for the virtual interface's router.

    • routerTypeIdentifier (string) --

      Identifies the router by a combination of vendor, platform, and software version. For example, CiscoSystemsInc-2900SeriesRouters-IOS124.

  • virtualInterfaceId (string) --

    The ID assigned to the virtual interface.

  • virtualInterfaceName (string) --

    The name of the virtual interface assigned by the customer network.

Updates the name of a current Direct Connect gateway.

See also: AWS API Documentation

Request Syntax

client.update_direct_connect_gateway(
    directConnectGatewayId='string',
    newDirectConnectGatewayName='string'
)

type directConnectGatewayId:

string

param directConnectGatewayId:

[REQUIRED]

The ID of the Direct Connect gateway to update.

type newDirectConnectGatewayName:

string

param newDirectConnectGatewayName:

[REQUIRED]

The new name for the Direct Connect gateway.

rtype:

dict

returns:

Response Syntax

{
    'directConnectGateway': {
        'directConnectGatewayId': 'string',
        'directConnectGatewayName': 'string',
        'amazonSideAsn': 123,
        'ownerAccount': 'string',
        'directConnectGatewayState': 'pending'|'available'|'deleting'|'deleted',
        'stateChangeError': 'string'
    }
}

Response Structure

• (dict) --

  • directConnectGateway (dict) --

    Information about a Direct Connect gateway, which enables you to connect virtual interfaces and virtual private gateway or transit gateways.

    • directConnectGatewayId (string) --

      The ID of the Direct Connect gateway.

    • directConnectGatewayName (string) --

      The name of the Direct Connect gateway.

    • amazonSideAsn (integer) --

      The autonomous system number (ASN) for the Amazon side of the connection.

    • ownerAccount (string) --

      The ID of the Amazon Web Services account that owns the Direct Connect gateway.

    • directConnectGatewayState (string) --

      The state of the Direct Connect gateway. The following are the possible values:

      • pending: The initial state after calling CreateDirectConnectGateway.

      • available: The Direct Connect gateway is ready for use.

      • deleting: The initial state after calling DeleteDirectConnectGateway.

      • deleted: The Direct Connect gateway is deleted and cannot pass traffic.

    • stateChangeError (string) --

      The error message if the state of an object failed to advance.