NetworkManager / Client / get_core_network_change_set

get_core_network_change_set

NetworkManager.Client.get_core_network_change_set(**kwargs)

Returns a change set between the LIVE core network policy and a submitted policy.

See also: AWS API Documentation

Request Syntax

response = client.get_core_network_change_set(
    CoreNetworkId='string',
    PolicyVersionId=123,
    MaxResults=123,
    NextToken='string'
)
Parameters:

  • CoreNetworkId (string) –

    [REQUIRED]

    The ID of a core network.

  • PolicyVersionId (integer) –

    [REQUIRED]

    The ID of the policy version.

  • 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

{
    'CoreNetworkChanges': [
        {
            'Type': 'CORE_NETWORK_SEGMENT'|'NETWORK_FUNCTION_GROUP'|'CORE_NETWORK_EDGE'|'ATTACHMENT_MAPPING'|'ATTACHMENT_ROUTE_PROPAGATION'|'ATTACHMENT_ROUTE_STATIC'|'CORE_NETWORK_CONFIGURATION'|'SEGMENTS_CONFIGURATION'|'SEGMENT_ACTIONS_CONFIGURATION'|'ATTACHMENT_POLICIES_CONFIGURATION',
            'Action': 'ADD'|'MODIFY'|'REMOVE',
            'Identifier': 'string',
            'PreviousValues': {
                'SegmentName': 'string',
                'NetworkFunctionGroupName': 'string',
                'EdgeLocations': [
                    'string',
                ],
                'Asn': 123,
                'Cidr': 'string',
                'DestinationIdentifier': 'string',
                'InsideCidrBlocks': [
                    'string',
                ],
                'SharedSegments': [
                    'string',
                ],
                'ServiceInsertionActions': [
                    {
                        'Action': 'send-via'|'send-to',
                        'Mode': 'dual-hop'|'single-hop',
                        'WhenSentTo': {
                            'WhenSentToSegmentsList': [
                                'string',
                            ]
                        },
                        'Via': {
                            'NetworkFunctionGroups': [
                                {
                                    'Name': 'string'
                                },
                            ],
                            'WithEdgeOverrides': [
                                {
                                    'EdgeSets': [
                                        [
                                            'string',
                                        ],
                                    ],
                                    'UseEdge': 'string'
                                },
                            ]
                        }
                    },
                ],
                'VpnEcmpSupport': True|False,
                'DnsSupport': True|False,
                'SecurityGroupReferencingSupport': True|False
            },
            'NewValues': {
                'SegmentName': 'string',
                'NetworkFunctionGroupName': 'string',
                'EdgeLocations': [
                    'string',
                ],
                'Asn': 123,
                'Cidr': 'string',
                'DestinationIdentifier': 'string',
                'InsideCidrBlocks': [
                    'string',
                ],
                'SharedSegments': [
                    'string',
                ],
                'ServiceInsertionActions': [
                    {
                        'Action': 'send-via'|'send-to',
                        'Mode': 'dual-hop'|'single-hop',
                        'WhenSentTo': {
                            'WhenSentToSegmentsList': [
                                'string',
                            ]
                        },
                        'Via': {
                            'NetworkFunctionGroups': [
                                {
                                    'Name': 'string'
                                },
                            ],
                            'WithEdgeOverrides': [
                                {
                                    'EdgeSets': [
                                        [
                                            'string',
                                        ],
                                    ],
                                    'UseEdge': 'string'
                                },
                            ]
                        }
                    },
                ],
                'VpnEcmpSupport': True|False,
                'DnsSupport': True|False,
                'SecurityGroupReferencingSupport': True|False
            },
            'IdentifierPath': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • CoreNetworkChanges (list) –

      Describes a core network changes.

      • (dict) –

        Details describing a core network change.

        • Type (string) –

          The type of change.

        • Action (string) –

          The action to take for a core network.

        • Identifier (string) –

          The resource identifier.

        • PreviousValues (dict) –

          The previous values for a core network.

          • SegmentName (string) –

            The names of the segments in a core network.

          • NetworkFunctionGroupName (string) –

            The network function group name if the change event is associated with a network function group.

          • EdgeLocations (list) –

            The Regions where edges are located in a core network.

            • (string) –

          • Asn (integer) –

            The ASN of a core network.

          • Cidr (string) –

            The IP addresses used for a core network.

          • DestinationIdentifier (string) –

            The ID of the destination.

          • InsideCidrBlocks (list) –

            The inside IP addresses used for core network change values.

            • (string) –

          • SharedSegments (list) –

            The shared segments for a core network change value.

            • (string) –

          • ServiceInsertionActions (list) –

            Describes the service insertion action.

            • (dict) –

              Describes the action that the service insertion will take for any segments associated with it.

              • Action (string) –

                The action the service insertion takes for traffic. send-via sends east-west traffic between attachments. send-to sends north-south traffic to the security appliance, and then from that to either the Internet or to an on-premesis location.

              • Mode (string) –

                Describes the mode packets take for the send-via action. This is not used when the action is send-to. dual-hop packets traverse attachments in both the source to the destination core network edges. This mode requires that an inspection attachment must be present in all Regions of the service insertion-enabled segments. For single-hop, packets traverse a single intermediate inserted attachment. You can use EdgeOverride to specify a specific edge to use.

              • WhenSentTo (dict) –

                The list of destination segments if the service insertion action is send-via.

                • WhenSentToSegmentsList (list) –

                  The list of destination segments when the service insertion action is send-to.

                  • (string) –

              • Via (dict) –

                The list of network function groups and any edge overrides for the chosen service insertion action. Used for both send-to or send-via.

                • NetworkFunctionGroups (list) –

                  The list of network function groups associated with the service insertion action.

                  • (dict) –

                    Describes a network function group for service insertion.

                    • Name (string) –

                      The name of the network function group.

                • WithEdgeOverrides (list) –

                  Describes any edge overrides. An edge override is a specific edge to be used for traffic.

                  • (dict) –

                    Describes the edge that’s used for the override.

                    • EdgeSets (list) –

                      The list of edge locations.

                      • (list) –

                        • (string) –

                    • UseEdge (string) –

                      The edge that should be used when overriding the current edge order.

          • VpnEcmpSupport (boolean) –

            Indicates whether Equal Cost Multipath (ECMP) is enabled for the core network.

          • DnsSupport (boolean) –

            Indicates whether public DNS support is supported. The default is true.

          • SecurityGroupReferencingSupport (boolean) –

            Indicates whether security group referencing is enabled for the core network.

        • NewValues (dict) –

          The new value for a core network

          • SegmentName (string) –

            The names of the segments in a core network.

          • NetworkFunctionGroupName (string) –

            The network function group name if the change event is associated with a network function group.

          • EdgeLocations (list) –

            The Regions where edges are located in a core network.

            • (string) –

          • Asn (integer) –

            The ASN of a core network.

          • Cidr (string) –

            The IP addresses used for a core network.

          • DestinationIdentifier (string) –

            The ID of the destination.

          • InsideCidrBlocks (list) –

            The inside IP addresses used for core network change values.

            • (string) –

          • SharedSegments (list) –

            The shared segments for a core network change value.

            • (string) –

          • ServiceInsertionActions (list) –

            Describes the service insertion action.

            • (dict) –

              Describes the action that the service insertion will take for any segments associated with it.

              • Action (string) –

                The action the service insertion takes for traffic. send-via sends east-west traffic between attachments. send-to sends north-south traffic to the security appliance, and then from that to either the Internet or to an on-premesis location.

              • Mode (string) –

                Describes the mode packets take for the send-via action. This is not used when the action is send-to. dual-hop packets traverse attachments in both the source to the destination core network edges. This mode requires that an inspection attachment must be present in all Regions of the service insertion-enabled segments. For single-hop, packets traverse a single intermediate inserted attachment. You can use EdgeOverride to specify a specific edge to use.

              • WhenSentTo (dict) –

                The list of destination segments if the service insertion action is send-via.

                • WhenSentToSegmentsList (list) –

                  The list of destination segments when the service insertion action is send-to.

                  • (string) –

              • Via (dict) –

                The list of network function groups and any edge overrides for the chosen service insertion action. Used for both send-to or send-via.

                • NetworkFunctionGroups (list) –

                  The list of network function groups associated with the service insertion action.

                  • (dict) –

                    Describes a network function group for service insertion.

                    • Name (string) –

                      The name of the network function group.

                • WithEdgeOverrides (list) –

                  Describes any edge overrides. An edge override is a specific edge to be used for traffic.

                  • (dict) –

                    Describes the edge that’s used for the override.

                    • EdgeSets (list) –

                      The list of edge locations.

                      • (list) –

                        • (string) –

                    • UseEdge (string) –

                      The edge that should be used when overriding the current edge order.

          • VpnEcmpSupport (boolean) –

            Indicates whether Equal Cost Multipath (ECMP) is enabled for the core network.

          • DnsSupport (boolean) –

            Indicates whether public DNS support is supported. The default is true.

          • SecurityGroupReferencingSupport (boolean) –

            Indicates whether security group referencing is enabled for the core network.

        • IdentifierPath (string) –

          Uniquely identifies the path for a change within the changeset. For example, the IdentifierPath for a core network segment change might be "CORE_NETWORK_SEGMENT/us-east-1/devsegment".

    • NextToken (string) –

      The token for the next page of results.

Exceptions