EC2 / Client / create_transit_gateway_metering_policy_entry

create_transit_gateway_metering_policy_entry

EC2.Client.create_transit_gateway_metering_policy_entry(**kwargs)

Creates an entry in a transit gateway metering policy to define traffic measurement rules.

See also: AWS API Documentation

Request Syntax

response = client.create_transit_gateway_metering_policy_entry(
    TransitGatewayMeteringPolicyId='string',
    PolicyRuleNumber=123,
    SourceTransitGatewayAttachmentId='string',
    SourceTransitGatewayAttachmentType='vpc'|'vpn'|'vpn-concentrator'|'direct-connect-gateway'|'connect'|'peering'|'tgw-peering'|'network-function',
    SourceCidrBlock='string',
    SourcePortRange='string',
    DestinationTransitGatewayAttachmentId='string',
    DestinationTransitGatewayAttachmentType='vpc'|'vpn'|'vpn-concentrator'|'direct-connect-gateway'|'connect'|'peering'|'tgw-peering'|'network-function',
    DestinationCidrBlock='string',
    DestinationPortRange='string',
    Protocol='string',
    MeteredAccount='source-attachment-owner'|'destination-attachment-owner'|'transit-gateway-owner',
    DryRun=True|False
)

Parameters:

• TransitGatewayMeteringPolicyId (string) –

  [REQUIRED]

  The ID of the transit gateway metering policy to add the entry to.

• PolicyRuleNumber (integer) –

  [REQUIRED]

  The rule number for the metering policy entry. Rules are processed in order from lowest to highest number.

• SourceTransitGatewayAttachmentId (string) – The ID of the source transit gateway attachment for traffic matching.

• SourceTransitGatewayAttachmentType (string) – The type of the source transit gateway attachment for traffic matching. Note that the tgw-peering resource type has been deprecated. To configure metering policies for Connect, use the transport attachment type.

• SourceCidrBlock (string) – The source CIDR block for traffic matching.

• SourcePortRange (string) – The source port range for traffic matching.

• DestinationTransitGatewayAttachmentId (string) – The ID of the destination transit gateway attachment for traffic matching.

• DestinationTransitGatewayAttachmentType (string) – The type of the destination transit gateway attachment for traffic matching. Note that the tgw-peering resource type has been deprecated. To configure metering policies for Connect, use the transport attachment type.

• DestinationCidrBlock (string) – The destination CIDR block for traffic matching.

• DestinationPortRange (string) – The destination port range for traffic matching.

• Protocol (string) – The protocol for traffic matching (1, 6, 17, etc.).

• MeteredAccount (string) –

  [REQUIRED]

  The Amazon Web Services account ID to which the metered traffic should be attributed.

• DryRun (boolean) – Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Return type:

dict

Returns:

Response Syntax

{
    'TransitGatewayMeteringPolicyEntry': {
        'PolicyRuleNumber': 'string',
        'MeteredAccount': 'source-attachment-owner'|'destination-attachment-owner'|'transit-gateway-owner',
        'State': 'available'|'deleted',
        'UpdatedAt': datetime(2015, 1, 1),
        'UpdateEffectiveAt': datetime(2015, 1, 1),
        'MeteringPolicyRule': {
            'SourceTransitGatewayAttachmentId': 'string',
            'SourceTransitGatewayAttachmentType': 'vpc'|'vpn'|'vpn-concentrator'|'direct-connect-gateway'|'connect'|'peering'|'tgw-peering'|'network-function',
            'SourceCidrBlock': 'string',
            'SourcePortRange': 'string',
            'DestinationTransitGatewayAttachmentId': 'string',
            'DestinationTransitGatewayAttachmentType': 'vpc'|'vpn'|'vpn-concentrator'|'direct-connect-gateway'|'connect'|'peering'|'tgw-peering'|'network-function',
            'DestinationCidrBlock': 'string',
            'DestinationPortRange': 'string',
            'Protocol': 'string'
        }
    }
}

Response Structure

• (dict) –

  • TransitGatewayMeteringPolicyEntry (dict) –

    Information about the created transit gateway metering policy entry.

    • PolicyRuleNumber (string) –

      The rule number of the metering policy entry.

    • MeteredAccount (string) –

      The Amazon Web Services account ID to which the metered traffic is attributed.

    • State (string) –

      The state of the metering policy entry.

    • UpdatedAt (datetime) –

      The date and time when the metering policy entry was last updated.

    • UpdateEffectiveAt (datetime) –

      The date and time when the metering policy entry update becomes effective.

    • MeteringPolicyRule (dict) –

      The metering policy rule that defines traffic matching criteria.

      • SourceTransitGatewayAttachmentId (string) –

        The ID of the source transit gateway attachment.

      • SourceTransitGatewayAttachmentType (string) –

        The type of the source transit gateway attachment. Note that the tgw-peering resource type has been deprecated. To configure metering policies for Connect, use the transport attachment type.

      • SourceCidrBlock (string) –

        The source CIDR block for the rule.

      • SourcePortRange (string) –

        The source port range for the rule.

      • DestinationTransitGatewayAttachmentId (string) –

        The ID of the destination transit gateway attachment.

      • DestinationTransitGatewayAttachmentType (string) –

        The type of the destination transit gateway attachment. Note that the tgw-peering resource type has been deprecated. To configure metering policies for Connect, use the transport attachment type.

      • DestinationCidrBlock (string) –

        The destination CIDR block for the rule.

      • DestinationPortRange (string) –

        The destination port range for the rule.

      • Protocol (string) –

        The protocol for the rule (1, 6, 17, etc.).