list_peerings

list_peerings(**kwargs)

Lists the peerings for a core network.

See also: AWS API Documentation

Request Syntax

response = client.list_peerings(
    CoreNetworkId='string',
    PeeringType='TRANSIT_GATEWAY',
    EdgeLocation='string',
    State='CREATING'|'FAILED'|'AVAILABLE'|'DELETING',
    MaxResults=123,
    NextToken='string'
)
Parameters
  • CoreNetworkId (string) -- The ID of a core network.
  • PeeringType (string) -- Returns a list of a peering requests.
  • EdgeLocation (string) -- Returns a list edge locations for the
  • State (string) -- Returns a list of the peering request states.
  • MaxResults (integer) -- The maximum number of results to return.
  • NextToken (string) -- The token for the next page of results.
Return type

dict

Returns

Response Syntax

{
    'Peerings': [
        {
            'CoreNetworkId': 'string',
            'CoreNetworkArn': 'string',
            'PeeringId': 'string',
            'OwnerAccountId': 'string',
            'PeeringType': 'TRANSIT_GATEWAY',
            'State': 'CREATING'|'FAILED'|'AVAILABLE'|'DELETING',
            'EdgeLocation': 'string',
            'ResourceArn': 'string',
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ],
            'CreatedAt': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • Peerings (list) --

      Lists the transit gateway peerings for the ListPeerings request.

      • (dict) --

        Describes a peering connection.

        • CoreNetworkId (string) --

          The ID of the core network for the peering request.

        • CoreNetworkArn (string) --

          The ARN of a core network.

        • PeeringId (string) --

          The ID of the peering attachment.

        • OwnerAccountId (string) --

          The ID of the account owner.

        • PeeringType (string) --

          The type of peering. This will be TRANSIT_GATEWAY .

        • State (string) --

          The current state of the peering connection.

        • EdgeLocation (string) --

          The edge location for the peer.

        • ResourceArn (string) --

          The resource ARN of the peer.

        • Tags (list) --

          The list of key-value tags associated with the peering.

          • (dict) --

            Describes a tag.

            • Key (string) --

              The tag key.

              Constraints: Maximum length of 128 characters.

            • Value (string) --

              The tag value.

              Constraints: Maximum length of 256 characters.

        • CreatedAt (datetime) --

          The timestamp when the attachment peer was created.

    • NextToken (string) --

      The token for the next page of results.

Exceptions

  • NetworkManager.Client.exceptions.ValidationException
  • NetworkManager.Client.exceptions.AccessDeniedException
  • NetworkManager.Client.exceptions.ThrottlingException
  • NetworkManager.Client.exceptions.InternalServerException