AWS Direct Connect

2019/03/25 - AWS Direct Connect - 5 new3 updated api methods

Changes  Update directconnect client to latest version

UpdateDirectConnectGatewayAssociation (new) Link ¶

Updates the specified attributes of the Direct Connect gateway association.

Add or remove prefixes from the association.

See also: AWS API Documentation

Request Syntax

client.update_direct_connect_gateway_association(
    associationId='string',
    addAllowedPrefixesToDirectConnectGateway=[
        {
            'cidr': 'string'
        },
    ],
    removeAllowedPrefixesToDirectConnectGateway=[
        {
            'cidr': 'string'
        },
    ]
)
type associationId:

string

param associationId:

The ID of the Direct Connect gateway association.

type addAllowedPrefixesToDirectConnectGateway:

list

param addAllowedPrefixesToDirectConnectGateway:

The Amazon VPC prefixes to advertise to the Direct Connect gateway.

  • (dict) --

    Information about a route filter prefix that a customer can advertise through Border Gateway Protocol (BGP) over a public virtual interface.

    • cidr (string) --

      The CIDR block for the advertised route. Separate multiple routes using commas. An IPv6 CIDR must use /64 or shorter.

type removeAllowedPrefixesToDirectConnectGateway:

list

param removeAllowedPrefixesToDirectConnectGateway:

The Amazon VPC prefixes to no longer advertise to the Direct Connect gateway.

  • (dict) --

    Information about a route filter prefix that a customer can advertise through Border Gateway Protocol (BGP) over a public virtual interface.

    • cidr (string) --

      The CIDR block for the advertised route. Separate multiple routes using commas. An IPv6 CIDR must use /64 or shorter.

rtype:

dict

returns:

Response Syntax

{
    'directConnectGatewayAssociation': {
        'directConnectGatewayId': 'string',
        'directConnectGatewayOwnerAccount': 'string',
        'associationState': 'associating'|'associated'|'disassociating'|'disassociated'|'updating',
        'stateChangeError': 'string',
        'associatedGateway': {
            'id': 'string',
            'type': 'virtualPrivateGateway',
            'ownerAccount': 'string',
            'region': 'string'
        },
        'associationId': 'string',
        'allowedPrefixesToDirectConnectGateway': [
            {
                'cidr': 'string'
            },
        ],
        'virtualGatewayId': 'string',
        'virtualGatewayRegion': 'string',
        'virtualGatewayOwnerAccount': 'string'
    }
}

Response Structure

  • (dict) --

    • directConnectGatewayAssociation (dict) --

      Information about an association between a Direct Connect gateway and a virtual private gateway.

      • directConnectGatewayId (string) --

        The ID of the Direct Connect gateway.

      • directConnectGatewayOwnerAccount (string) --

        The ID of the AWS account that owns the associated gateway.

      • associationState (string) --

        The state of the association. The following are the possible values:

        • associating: The initial state after calling CreateDirectConnectGatewayAssociation.

        • associated: The Direct Connect gateway and virtual private gateway are successfully associated and ready to pass traffic.

        • disassociating: The initial state after calling DeleteDirectConnectGatewayAssociation.

        • disassociated: The virtual private gateway is disassociated from the Direct Connect gateway. Traffic flow between the Direct Connect gateway and virtual private gateway is stopped.

      • stateChangeError (string) --

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

      • associatedGateway (dict) --

        Information about the associated virtual private gateway.

        • id (string) --

          The ID of the associated gateway.

        • type (string) --

          The type of associated gateway.

        • ownerAccount (string) --

          The ID of the AWS account that owns the associated virtual private gateway.

        • region (string) --

          The Region where the associated gateway is located.

      • associationId (string) --

        The ID of the Direct Connect gateway association.

      • allowedPrefixesToDirectConnectGateway (list) --

        The Amazon VPC prefixes to advertise to the Direct Connect gateway.

        • (dict) --

          Information about a route filter prefix that a customer can advertise through Border Gateway Protocol (BGP) over a public virtual interface.

          • cidr (string) --

            The CIDR block for the advertised route. Separate multiple routes using commas. An IPv6 CIDR must use /64 or shorter.

      • virtualGatewayId (string) --

        The ID of the virtual private gateway. Applies only to private virtual interfaces.

      • virtualGatewayRegion (string) --

        The AWS Region where the virtual private gateway is located.

      • virtualGatewayOwnerAccount (string) --

        The ID of the AWS account that owns the virtual private gateway.

AcceptDirectConnectGatewayAssociationProposal (new) Link ¶

Accepts a proposal request to attach a virtual private gateway to a Direct Connect gateway.

See also: AWS API Documentation

Request Syntax

client.accept_direct_connect_gateway_association_proposal(
    directConnectGatewayId='string',
    proposalId='string',
    associatedGatewayOwnerAccount='string',
    overrideAllowedPrefixesToDirectConnectGateway=[
        {
            'cidr': 'string'
        },
    ]
)
type directConnectGatewayId:

string

param directConnectGatewayId:

[REQUIRED]

The ID of the Direct Connect gateway.

type proposalId:

string

param proposalId:

[REQUIRED]

The ID of the request proposal.

type associatedGatewayOwnerAccount:

string

param associatedGatewayOwnerAccount:

[REQUIRED]

The ID of the AWS account that owns the virtual private gateway.

type overrideAllowedPrefixesToDirectConnectGateway:

list

param overrideAllowedPrefixesToDirectConnectGateway:

Overrides the Amazon VPC prefixes advertised to the Direct Connect gateway.

  • (dict) --

    Information about a route filter prefix that a customer can advertise through Border Gateway Protocol (BGP) over a public virtual interface.

    • cidr (string) --

      The CIDR block for the advertised route. Separate multiple routes using commas. An IPv6 CIDR must use /64 or shorter.

rtype:

dict

returns:

Response Syntax

{
    'directConnectGatewayAssociation': {
        'directConnectGatewayId': 'string',
        'directConnectGatewayOwnerAccount': 'string',
        'associationState': 'associating'|'associated'|'disassociating'|'disassociated'|'updating',
        'stateChangeError': 'string',
        'associatedGateway': {
            'id': 'string',
            'type': 'virtualPrivateGateway',
            'ownerAccount': 'string',
            'region': 'string'
        },
        'associationId': 'string',
        'allowedPrefixesToDirectConnectGateway': [
            {
                'cidr': 'string'
            },
        ],
        'virtualGatewayId': 'string',
        'virtualGatewayRegion': 'string',
        'virtualGatewayOwnerAccount': 'string'
    }
}

Response Structure

  • (dict) --

    • directConnectGatewayAssociation (dict) --

      Information about an association between a Direct Connect gateway and a virtual private gateway.

      • directConnectGatewayId (string) --

        The ID of the Direct Connect gateway.

      • directConnectGatewayOwnerAccount (string) --

        The ID of the AWS account that owns the associated gateway.

      • associationState (string) --

        The state of the association. The following are the possible values:

        • associating: The initial state after calling CreateDirectConnectGatewayAssociation.

        • associated: The Direct Connect gateway and virtual private gateway are successfully associated and ready to pass traffic.

        • disassociating: The initial state after calling DeleteDirectConnectGatewayAssociation.

        • disassociated: The virtual private gateway is disassociated from the Direct Connect gateway. Traffic flow between the Direct Connect gateway and virtual private gateway is stopped.

      • stateChangeError (string) --

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

      • associatedGateway (dict) --

        Information about the associated virtual private gateway.

        • id (string) --

          The ID of the associated gateway.

        • type (string) --

          The type of associated gateway.

        • ownerAccount (string) --

          The ID of the AWS account that owns the associated virtual private gateway.

        • region (string) --

          The Region where the associated gateway is located.

      • associationId (string) --

        The ID of the Direct Connect gateway association.

      • allowedPrefixesToDirectConnectGateway (list) --

        The Amazon VPC prefixes to advertise to the Direct Connect gateway.

        • (dict) --

          Information about a route filter prefix that a customer can advertise through Border Gateway Protocol (BGP) over a public virtual interface.

          • cidr (string) --

            The CIDR block for the advertised route. Separate multiple routes using commas. An IPv6 CIDR must use /64 or shorter.

      • virtualGatewayId (string) --

        The ID of the virtual private gateway. Applies only to private virtual interfaces.

      • virtualGatewayRegion (string) --

        The AWS Region where the virtual private gateway is located.

      • virtualGatewayOwnerAccount (string) --

        The ID of the AWS account that owns the virtual private gateway.

CreateDirectConnectGatewayAssociationProposal (new) Link ¶

Creates a proposal to associate the specified virtual private gateway with the specified Direct Connect gateway.

You can only associate a Direct Connect gateway and virtual private gateway when the account that owns the Direct Connect gateway and the account that owns the virtual private gateway have the same payer ID.

See also: AWS API Documentation

Request Syntax

client.create_direct_connect_gateway_association_proposal(
    directConnectGatewayId='string',
    directConnectGatewayOwnerAccount='string',
    gatewayId='string',
    addAllowedPrefixesToDirectConnectGateway=[
        {
            'cidr': 'string'
        },
    ],
    removeAllowedPrefixesToDirectConnectGateway=[
        {
            'cidr': 'string'
        },
    ]
)
type directConnectGatewayId:

string

param directConnectGatewayId:

[REQUIRED]

The ID of the Direct Connect gateway.

type directConnectGatewayOwnerAccount:

string

param directConnectGatewayOwnerAccount:

[REQUIRED]

The ID of the AWS account that owns the Direct Connect gateway.

type gatewayId:

string

param gatewayId:

[REQUIRED]

The ID of the virtual private gateway.

type addAllowedPrefixesToDirectConnectGateway:

list

param addAllowedPrefixesToDirectConnectGateway:

The Amazon VPC prefixes to advertise to the Direct Connect gateway.

  • (dict) --

    Information about a route filter prefix that a customer can advertise through Border Gateway Protocol (BGP) over a public virtual interface.

    • cidr (string) --

      The CIDR block for the advertised route. Separate multiple routes using commas. An IPv6 CIDR must use /64 or shorter.

type removeAllowedPrefixesToDirectConnectGateway:

list

param removeAllowedPrefixesToDirectConnectGateway:

The Amazon VPC prefixes to no longer advertise to the Direct Connect gateway.

  • (dict) --

    Information about a route filter prefix that a customer can advertise through Border Gateway Protocol (BGP) over a public virtual interface.

    • cidr (string) --

      The CIDR block for the advertised route. Separate multiple routes using commas. An IPv6 CIDR must use /64 or shorter.

rtype:

dict

returns:

Response Syntax

{
    'directConnectGatewayAssociationProposal': {
        'proposalId': 'string',
        'directConnectGatewayId': 'string',
        'directConnectGatewayOwnerAccount': 'string',
        'proposalState': 'requested'|'accepted'|'deleted',
        'associatedGateway': {
            'id': 'string',
            'type': 'virtualPrivateGateway',
            'ownerAccount': 'string',
            'region': 'string'
        },
        'existingAllowedPrefixesToDirectConnectGateway': [
            {
                'cidr': 'string'
            },
        ],
        'requestedAllowedPrefixesToDirectConnectGateway': [
            {
                'cidr': 'string'
            },
        ]
    }
}

Response Structure

  • (dict) --

    • directConnectGatewayAssociationProposal (dict) --

      Information about the Direct Connect gateway proposal.

      • proposalId (string) --

        The ID of the association proposal.

      • directConnectGatewayId (string) --

        The ID of the Direct Connect gateway.

      • directConnectGatewayOwnerAccount (string) --

        The ID of the AWS account that owns the Direct Connect gateway.

      • proposalState (string) --

        The state of the proposal. The following are possible values:

        • accepted: The proposal has been accepted. The Direct Connect gateway association is available to use in this state.

        • deleted: The proposal has been deleted by the owner that made the proposal. The Direct Connect gateway association cannot be used in this state.

        • requested: The proposal has been requested. The Direct Connect gateway association cannot be used in this state.

      • associatedGateway (dict) --

        Information about the associated virtual private gateway.

        • id (string) --

          The ID of the associated gateway.

        • type (string) --

          The type of associated gateway.

        • ownerAccount (string) --

          The ID of the AWS account that owns the associated virtual private gateway.

        • region (string) --

          The Region where the associated gateway is located.

      • existingAllowedPrefixesToDirectConnectGateway (list) --

        The existing Amazon VPC prefixes advertised to the Direct Connect gateway.

        • (dict) --

          Information about a route filter prefix that a customer can advertise through Border Gateway Protocol (BGP) over a public virtual interface.

          • cidr (string) --

            The CIDR block for the advertised route. Separate multiple routes using commas. An IPv6 CIDR must use /64 or shorter.

      • requestedAllowedPrefixesToDirectConnectGateway (list) --

        The Amazon VPC prefixes to advertise to the Direct Connect gateway.

        • (dict) --

          Information about a route filter prefix that a customer can advertise through Border Gateway Protocol (BGP) over a public virtual interface.

          • cidr (string) --

            The CIDR block for the advertised route. Separate multiple routes using commas. An IPv6 CIDR must use /64 or shorter.

DescribeDirectConnectGatewayAssociationProposals (new) Link ¶

Describes one or more association proposals for connection between a virtual private gateway and a Direct Connect gateway.

See also: AWS API Documentation

Request Syntax

client.describe_direct_connect_gateway_association_proposals(
    directConnectGatewayId='string',
    proposalId='string',
    associatedGatewayId='string',
    maxResults=123,
    nextToken='string'
)
type directConnectGatewayId:

string

param directConnectGatewayId:

The ID of the Direct Connect gateway.

type proposalId:

string

param proposalId:

The ID of the proposal.

type associatedGatewayId:

string

param associatedGatewayId:

The ID of the associated virtual private gateway.

type maxResults:

integer

param maxResults:

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

If MaxResults is given a value larger than 100, only 100 results are returned.

type nextToken:

string

param nextToken:

The token for the next page of results.

rtype:

dict

returns:

Response Syntax

{
    'directConnectGatewayAssociationProposals': [
        {
            'proposalId': 'string',
            'directConnectGatewayId': 'string',
            'directConnectGatewayOwnerAccount': 'string',
            'proposalState': 'requested'|'accepted'|'deleted',
            'associatedGateway': {
                'id': 'string',
                'type': 'virtualPrivateGateway',
                'ownerAccount': 'string',
                'region': 'string'
            },
            'existingAllowedPrefixesToDirectConnectGateway': [
                {
                    'cidr': 'string'
                },
            ],
            'requestedAllowedPrefixesToDirectConnectGateway': [
                {
                    'cidr': 'string'
                },
            ]
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    • directConnectGatewayAssociationProposals (list) --

      Describes the Direct Connect gateway association proposals.

      • (dict) --

        Information about the proposal request to attach a virtual private gateway to a DDirect Connect gateway.

        • proposalId (string) --

          The ID of the association proposal.

        • directConnectGatewayId (string) --

          The ID of the Direct Connect gateway.

        • directConnectGatewayOwnerAccount (string) --

          The ID of the AWS account that owns the Direct Connect gateway.

        • proposalState (string) --

          The state of the proposal. The following are possible values:

          • accepted: The proposal has been accepted. The Direct Connect gateway association is available to use in this state.

          • deleted: The proposal has been deleted by the owner that made the proposal. The Direct Connect gateway association cannot be used in this state.

          • requested: The proposal has been requested. The Direct Connect gateway association cannot be used in this state.

        • associatedGateway (dict) --

          Information about the associated virtual private gateway.

          • id (string) --

            The ID of the associated gateway.

          • type (string) --

            The type of associated gateway.

          • ownerAccount (string) --

            The ID of the AWS account that owns the associated virtual private gateway.

          • region (string) --

            The Region where the associated gateway is located.

        • existingAllowedPrefixesToDirectConnectGateway (list) --

          The existing Amazon VPC prefixes advertised to the Direct Connect gateway.

          • (dict) --

            Information about a route filter prefix that a customer can advertise through Border Gateway Protocol (BGP) over a public virtual interface.

            • cidr (string) --

              The CIDR block for the advertised route. Separate multiple routes using commas. An IPv6 CIDR must use /64 or shorter.

        • requestedAllowedPrefixesToDirectConnectGateway (list) --

          The Amazon VPC prefixes to advertise to the Direct Connect gateway.

          • (dict) --

            Information about a route filter prefix that a customer can advertise through Border Gateway Protocol (BGP) over a public virtual interface.

            • cidr (string) --

              The CIDR block for the advertised route. Separate multiple routes using commas. An IPv6 CIDR must use /64 or shorter.

    • nextToken (string) --

      The token to use to retrieve the next page of results. This value is null when there are no more results to return.

DeleteDirectConnectGatewayAssociationProposal (new) Link ¶

Deletes the association proposal request between the specified Direct Connect gateway and virtual private gateway.

See also: AWS API Documentation

Request Syntax

client.delete_direct_connect_gateway_association_proposal(
    proposalId='string'
)
type proposalId:

string

param proposalId:

[REQUIRED]

The ID of the proposal.

rtype:

dict

returns:

Response Syntax

{
    'directConnectGatewayAssociationProposal': {
        'proposalId': 'string',
        'directConnectGatewayId': 'string',
        'directConnectGatewayOwnerAccount': 'string',
        'proposalState': 'requested'|'accepted'|'deleted',
        'associatedGateway': {
            'id': 'string',
            'type': 'virtualPrivateGateway',
            'ownerAccount': 'string',
            'region': 'string'
        },
        'existingAllowedPrefixesToDirectConnectGateway': [
            {
                'cidr': 'string'
            },
        ],
        'requestedAllowedPrefixesToDirectConnectGateway': [
            {
                'cidr': 'string'
            },
        ]
    }
}

Response Structure

  • (dict) --

    • directConnectGatewayAssociationProposal (dict) --

      The ID of the virtual private gateway.

      • proposalId (string) --

        The ID of the association proposal.

      • directConnectGatewayId (string) --

        The ID of the Direct Connect gateway.

      • directConnectGatewayOwnerAccount (string) --

        The ID of the AWS account that owns the Direct Connect gateway.

      • proposalState (string) --

        The state of the proposal. The following are possible values:

        • accepted: The proposal has been accepted. The Direct Connect gateway association is available to use in this state.

        • deleted: The proposal has been deleted by the owner that made the proposal. The Direct Connect gateway association cannot be used in this state.

        • requested: The proposal has been requested. The Direct Connect gateway association cannot be used in this state.

      • associatedGateway (dict) --

        Information about the associated virtual private gateway.

        • id (string) --

          The ID of the associated gateway.

        • type (string) --

          The type of associated gateway.

        • ownerAccount (string) --

          The ID of the AWS account that owns the associated virtual private gateway.

        • region (string) --

          The Region where the associated gateway is located.

      • existingAllowedPrefixesToDirectConnectGateway (list) --

        The existing Amazon VPC prefixes advertised to the Direct Connect gateway.

        • (dict) --

          Information about a route filter prefix that a customer can advertise through Border Gateway Protocol (BGP) over a public virtual interface.

          • cidr (string) --

            The CIDR block for the advertised route. Separate multiple routes using commas. An IPv6 CIDR must use /64 or shorter.

      • requestedAllowedPrefixesToDirectConnectGateway (list) --

        The Amazon VPC prefixes to advertise to the Direct Connect gateway.

        • (dict) --

          Information about a route filter prefix that a customer can advertise through Border Gateway Protocol (BGP) over a public virtual interface.

          • cidr (string) --

            The CIDR block for the advertised route. Separate multiple routes using commas. An IPv6 CIDR must use /64 or shorter.

CreateDirectConnectGatewayAssociation (updated) Link ¶
Changes (request, response)
Request 
{'addAllowedPrefixesToDirectConnectGateway': [{'cidr': 'string'}],
 'gatewayId': 'string'}
Response 
{'directConnectGatewayAssociation': {'allowedPrefixesToDirectConnectGateway': [{'cidr': 'string'}],
                                     'associatedGateway': {'id': 'string',
                                                           'ownerAccount': 'string',
                                                           'region': 'string',
                                                           'type': 'virtualPrivateGateway'},
                                     'associationId': 'string',
                                     'associationState': {'updating'},
                                     'directConnectGatewayOwnerAccount': 'string'}}

Creates an association between a Direct Connect gateway and a virtual private gateway. The virtual private gateway must be attached to a VPC and must not be associated with another Direct Connect gateway.

See also: AWS API Documentation

Request Syntax

client.create_direct_connect_gateway_association(
    directConnectGatewayId='string',
    gatewayId='string',
    addAllowedPrefixesToDirectConnectGateway=[
        {
            'cidr': 'string'
        },
    ],
    virtualGatewayId='string'
)
type directConnectGatewayId:

string

param directConnectGatewayId:

[REQUIRED]

The ID of the Direct Connect gateway.

type gatewayId:

string

param gatewayId:

The ID of the virtual private gateway.

type addAllowedPrefixesToDirectConnectGateway:

list

param addAllowedPrefixesToDirectConnectGateway:

The Amazon VPC prefixes to advertise to the Direct Connect gateway

  • (dict) --

    Information about a route filter prefix that a customer can advertise through Border Gateway Protocol (BGP) over a public virtual interface.

    • cidr (string) --

      The CIDR block for the advertised route. Separate multiple routes using commas. An IPv6 CIDR must use /64 or shorter.

type virtualGatewayId:

string

param virtualGatewayId:

The ID of the virtual private gateway.

rtype:

dict

returns:

Response Syntax

{
    'directConnectGatewayAssociation': {
        'directConnectGatewayId': 'string',
        'directConnectGatewayOwnerAccount': 'string',
        'associationState': 'associating'|'associated'|'disassociating'|'disassociated'|'updating',
        'stateChangeError': 'string',
        'associatedGateway': {
            'id': 'string',
            'type': 'virtualPrivateGateway',
            'ownerAccount': 'string',
            'region': 'string'
        },
        'associationId': 'string',
        'allowedPrefixesToDirectConnectGateway': [
            {
                'cidr': 'string'
            },
        ],
        'virtualGatewayId': 'string',
        'virtualGatewayRegion': 'string',
        'virtualGatewayOwnerAccount': 'string'
    }
}

Response Structure

  • (dict) --

    • directConnectGatewayAssociation (dict) --

      The association to be created.

      • directConnectGatewayId (string) --

        The ID of the Direct Connect gateway.

      • directConnectGatewayOwnerAccount (string) --

        The ID of the AWS account that owns the associated gateway.

      • associationState (string) --

        The state of the association. The following are the possible values:

        • associating: The initial state after calling CreateDirectConnectGatewayAssociation.

        • associated: The Direct Connect gateway and virtual private gateway are successfully associated and ready to pass traffic.

        • disassociating: The initial state after calling DeleteDirectConnectGatewayAssociation.

        • disassociated: The virtual private gateway is disassociated from the Direct Connect gateway. Traffic flow between the Direct Connect gateway and virtual private gateway is stopped.

      • stateChangeError (string) --

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

      • associatedGateway (dict) --

        Information about the associated virtual private gateway.

        • id (string) --

          The ID of the associated gateway.

        • type (string) --

          The type of associated gateway.

        • ownerAccount (string) --

          The ID of the AWS account that owns the associated virtual private gateway.

        • region (string) --

          The Region where the associated gateway is located.

      • associationId (string) --

        The ID of the Direct Connect gateway association.

      • allowedPrefixesToDirectConnectGateway (list) --

        The Amazon VPC prefixes to advertise to the Direct Connect gateway.

        • (dict) --

          Information about a route filter prefix that a customer can advertise through Border Gateway Protocol (BGP) over a public virtual interface.

          • cidr (string) --

            The CIDR block for the advertised route. Separate multiple routes using commas. An IPv6 CIDR must use /64 or shorter.

      • virtualGatewayId (string) --

        The ID of the virtual private gateway. Applies only to private virtual interfaces.

      • virtualGatewayRegion (string) --

        The AWS Region where the virtual private gateway is located.

      • virtualGatewayOwnerAccount (string) --

        The ID of the AWS account that owns the virtual private gateway.

DeleteDirectConnectGatewayAssociation (updated) Link ¶
Changes (request, response)
Request 
{'associationId': 'string'}
Response 
{'directConnectGatewayAssociation': {'allowedPrefixesToDirectConnectGateway': [{'cidr': 'string'}],
                                     'associatedGateway': {'id': 'string',
                                                           'ownerAccount': 'string',
                                                           'region': 'string',
                                                           'type': 'virtualPrivateGateway'},
                                     'associationId': 'string',
                                     'associationState': {'updating'},
                                     'directConnectGatewayOwnerAccount': 'string'}}

Deletes the association between the specified Direct Connect gateway and virtual private gateway.

See also: AWS API Documentation

Request Syntax

client.delete_direct_connect_gateway_association(
    associationId='string',
    directConnectGatewayId='string',
    virtualGatewayId='string'
)
type associationId:

string

param associationId:

The ID of the Direct Connect gateway association.

type directConnectGatewayId:

string

param directConnectGatewayId:

The ID of the Direct Connect gateway.

type virtualGatewayId:

string

param virtualGatewayId:

The ID of the virtual private gateway.

rtype:

dict

returns:

Response Syntax

{
    'directConnectGatewayAssociation': {
        'directConnectGatewayId': 'string',
        'directConnectGatewayOwnerAccount': 'string',
        'associationState': 'associating'|'associated'|'disassociating'|'disassociated'|'updating',
        'stateChangeError': 'string',
        'associatedGateway': {
            'id': 'string',
            'type': 'virtualPrivateGateway',
            'ownerAccount': 'string',
            'region': 'string'
        },
        'associationId': 'string',
        'allowedPrefixesToDirectConnectGateway': [
            {
                'cidr': 'string'
            },
        ],
        'virtualGatewayId': 'string',
        'virtualGatewayRegion': 'string',
        'virtualGatewayOwnerAccount': 'string'
    }
}

Response Structure

  • (dict) --

    • directConnectGatewayAssociation (dict) --

      Information about the deleted association.

      • directConnectGatewayId (string) --

        The ID of the Direct Connect gateway.

      • directConnectGatewayOwnerAccount (string) --

        The ID of the AWS account that owns the associated gateway.

      • associationState (string) --

        The state of the association. The following are the possible values:

        • associating: The initial state after calling CreateDirectConnectGatewayAssociation.

        • associated: The Direct Connect gateway and virtual private gateway are successfully associated and ready to pass traffic.

        • disassociating: The initial state after calling DeleteDirectConnectGatewayAssociation.

        • disassociated: The virtual private gateway is disassociated from the Direct Connect gateway. Traffic flow between the Direct Connect gateway and virtual private gateway is stopped.

      • stateChangeError (string) --

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

      • associatedGateway (dict) --

        Information about the associated virtual private gateway.

        • id (string) --

          The ID of the associated gateway.

        • type (string) --

          The type of associated gateway.

        • ownerAccount (string) --

          The ID of the AWS account that owns the associated virtual private gateway.

        • region (string) --

          The Region where the associated gateway is located.

      • associationId (string) --

        The ID of the Direct Connect gateway association.

      • allowedPrefixesToDirectConnectGateway (list) --

        The Amazon VPC prefixes to advertise to the Direct Connect gateway.

        • (dict) --

          Information about a route filter prefix that a customer can advertise through Border Gateway Protocol (BGP) over a public virtual interface.

          • cidr (string) --

            The CIDR block for the advertised route. Separate multiple routes using commas. An IPv6 CIDR must use /64 or shorter.

      • virtualGatewayId (string) --

        The ID of the virtual private gateway. Applies only to private virtual interfaces.

      • virtualGatewayRegion (string) --

        The AWS Region where the virtual private gateway is located.

      • virtualGatewayOwnerAccount (string) --

        The ID of the AWS account that owns the virtual private gateway.

DescribeDirectConnectGatewayAssociations (updated) Link ¶
Changes (request, response)
Request 
{'associatedGatewayId': 'string', 'associationId': 'string'}
Response 
{'directConnectGatewayAssociations': {'allowedPrefixesToDirectConnectGateway': [{'cidr': 'string'}],
                                      'associatedGateway': {'id': 'string',
                                                            'ownerAccount': 'string',
                                                            'region': 'string',
                                                            'type': 'virtualPrivateGateway'},
                                      'associationId': 'string',
                                      'associationState': {'updating'},
                                      'directConnectGatewayOwnerAccount': 'string'}}

Lists the associations between your Direct Connect gateways and virtual private gateways. You must specify a Direct Connect gateway, a virtual private gateway, or both. If you specify a Direct Connect gateway, the response contains all virtual private gateways associated with the Direct Connect gateway. If you specify a virtual private gateway, the response contains all Direct Connect gateways associated with the virtual private gateway. If you specify both, the response contains the association between the Direct Connect gateway and the virtual private gateway.

See also: AWS API Documentation

Request Syntax

client.describe_direct_connect_gateway_associations(
    associationId='string',
    associatedGatewayId='string',
    directConnectGatewayId='string',
    maxResults=123,
    nextToken='string',
    virtualGatewayId='string'
)
type associationId:

string

param associationId:

The ID of the Direct Connect gateway association.

type associatedGatewayId:

string

param associatedGatewayId:

The ID of the associated gateway.

type directConnectGatewayId:

string

param directConnectGatewayId:

The ID of the Direct Connect gateway.

type maxResults:

integer

param maxResults:

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

If MaxResults is given a value larger than 100, only 100 results are returned.

type nextToken:

string

param nextToken:

The token provided in the previous call to retrieve the next page.

type virtualGatewayId:

string

param virtualGatewayId:

The ID of the virtual private gateway.

rtype:

dict

returns:

Response Syntax

{
    'directConnectGatewayAssociations': [
        {
            'directConnectGatewayId': 'string',
            'directConnectGatewayOwnerAccount': 'string',
            'associationState': 'associating'|'associated'|'disassociating'|'disassociated'|'updating',
            'stateChangeError': 'string',
            'associatedGateway': {
                'id': 'string',
                'type': 'virtualPrivateGateway',
                'ownerAccount': 'string',
                'region': 'string'
            },
            'associationId': 'string',
            'allowedPrefixesToDirectConnectGateway': [
                {
                    'cidr': 'string'
                },
            ],
            'virtualGatewayId': 'string',
            'virtualGatewayRegion': 'string',
            'virtualGatewayOwnerAccount': 'string'
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    • directConnectGatewayAssociations (list) --

      Information about the associations.

      • (dict) --

        Information about an association between a Direct Connect gateway and a virtual private gateway.

        • directConnectGatewayId (string) --

          The ID of the Direct Connect gateway.

        • directConnectGatewayOwnerAccount (string) --

          The ID of the AWS account that owns the associated gateway.

        • associationState (string) --

          The state of the association. The following are the possible values:

          • associating: The initial state after calling CreateDirectConnectGatewayAssociation.

          • associated: The Direct Connect gateway and virtual private gateway are successfully associated and ready to pass traffic.

          • disassociating: The initial state after calling DeleteDirectConnectGatewayAssociation.

          • disassociated: The virtual private gateway is disassociated from the Direct Connect gateway. Traffic flow between the Direct Connect gateway and virtual private gateway is stopped.

        • stateChangeError (string) --

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

        • associatedGateway (dict) --

          Information about the associated virtual private gateway.

          • id (string) --

            The ID of the associated gateway.

          • type (string) --

            The type of associated gateway.

          • ownerAccount (string) --

            The ID of the AWS account that owns the associated virtual private gateway.

          • region (string) --

            The Region where the associated gateway is located.

        • associationId (string) --

          The ID of the Direct Connect gateway association.

        • allowedPrefixesToDirectConnectGateway (list) --

          The Amazon VPC prefixes to advertise to the Direct Connect gateway.

          • (dict) --

            Information about a route filter prefix that a customer can advertise through Border Gateway Protocol (BGP) over a public virtual interface.

            • cidr (string) --

              The CIDR block for the advertised route. Separate multiple routes using commas. An IPv6 CIDR must use /64 or shorter.

        • virtualGatewayId (string) --

          The ID of the virtual private gateway. Applies only to private virtual interfaces.

        • virtualGatewayRegion (string) --

          The AWS Region where the virtual private gateway is located.

        • virtualGatewayOwnerAccount (string) --

          The ID of the AWS account that owns the virtual private gateway.

    • nextToken (string) --

      The token to retrieve the next page.