NetworkManager / Client / list_attachment_nat_configurations

list_attachment_nat_configurations

NetworkManager.Client.list_attachment_nat_configurations(**kwargs)

Returns the NAT configurations of core network attachments. You must specify either a core network ID or an attachment ID. Only the core network owner can list NAT configurations.

See also: AWS API Documentation

Request Syntax

response = client.list_attachment_nat_configurations(
    CoreNetworkId='string',
    AttachmentId='string',
    Filters={
        'string': [
            'string',
        ]
    },
    MaxResults=123,
    NextToken='string'
)
Parameters:

  • CoreNetworkId (string) – The ID of a core network. Returns the NAT configurations of attachments in the core network that support NAT.

  • AttachmentId (string) – The ID of an attachment. Returns the NAT configuration of the specified attachment. If you specify both an attachment ID and a core network ID, the attachment ID is used.

  • Filters (dict) –

    The filters to apply to the results. Values for the same filter are joined with OR, and different filters are joined with AND. You can specify up to 10 filter values in total. The following filters are supported:

    • nat-gateway-support: The state of NAT gateway support on the attachment, for example ENABLED.

    • nat-system-route-support: Whether system routes are installed for the attachment, true or false.

    • rule-number: The rule number of a NAT rule.

    • match-source-cidr: The source CIDR block of a NAT rule. The value must exactly match the CIDR block of the rule.

    • nat-cidr: The NAT CIDR block of a NAT rule. The value must exactly match the CIDR block of the rule.

    • nat-rule-state: The state of a NAT rule, for example ACTIVATED.

    • (string) –

      • (list) –

        • (string) –

  • 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

{
    'AttachmentNatConfigurations': [
        {
            'AttachmentId': 'string',
            'NatGatewaySupport': 'ENABLED'|'ENABLING'|'DISABLED'|'DISABLING'|'PENDING_ATTACHMENT_ACCEPTANCE',
            'NatSystemRouteSupport': True|False,
            'NatGatewayRules': [
                {
                    'RuleNumber': 123,
                    'MatchSourceCidr': 'string',
                    'NatCidr': 'string',
                    'State': 'CREATING'|'MODIFYING'|'DELETING'|'ACTIVATED'|'ACTIVATING'|'DEACTIVATED'|'DEACTIVATING'|'FAILED'|'PENDING_ATTACHMENT_ACCEPTANCE'
                },
            ]
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • AttachmentNatConfigurations (list) –

      The NAT configurations of the attachments.

      • (dict) –

        Describes the NAT configuration of a core network attachment.

        • AttachmentId (string) –

          The ID of the attachment.

        • NatGatewaySupport (string) –

          The state of NAT gateway support on the attachment.

        • NatSystemRouteSupport (boolean) –

          Indicates whether the core network installs system routes for the NAT CIDR blocks of the attachment’s NAT rules.

        • NatGatewayRules (list) –

          The NAT rules of the attachment.

          • (dict) –

            Describes a NAT rule of an attachment.

            • RuleNumber (integer) –

              The rule number. Rule numbers identify the rules of an attachment and don’t set the order in which rules are evaluated.

            • MatchSourceCidr (string) –

              The source CIDR block that the rule matches for traffic from the attachment.

            • NatCidr (string) –

              The CIDR block that matching source addresses are translated to.

            • State (string) –

              The state of the NAT rule. The possible values are the following:

              • CREATING: The rule is being created.

              • MODIFYING: The rule is being modified.

              • DELETING: The rule is being deleted.

              • ACTIVATING: NAT gateway support is being enabled, and the rule is being applied.

              • ACTIVATED: NAT gateway support is enabled, and the rule is applied.

              • DEACTIVATING: NAT gateway support is being disabled, and the rule is being removed from use.

              • DEACTIVATED: NAT gateway support is disabled, and the rule isn’t applied.

              • FAILED: The attachment failed to be created, and the rule isn’t applied.

              • PENDING_ATTACHMENT_ACCEPTANCE: The attachment is pending acceptance. The rule is applied after the attachment is accepted.

    • NextToken (string) –

      The token for the next page of results.

Exceptions