MediaConnect / Client / get_router_network_interface

get_router_network_interface

MediaConnect.Client.get_router_network_interface(**kwargs)

Retrieves information about a specific router network interface in AWS Elemental MediaConnect.

See also: AWS API Documentation

Request Syntax

response = client.get_router_network_interface(
    Arn='string'
)
Parameters:

Arn (string) –

[REQUIRED]

The Amazon Resource Name (ARN) of the router network interface that you want to retrieve information about.

Return type:

dict

Returns:

Response Syntax

{
    'RouterNetworkInterface': {
        'Name': 'string',
        'Arn': 'string',
        'Id': 'string',
        'State': 'CREATING'|'ACTIVE'|'UPDATING'|'DELETING'|'ERROR'|'RECOVERING',
        'NetworkInterfaceType': 'PUBLIC'|'VPC',
        'Configuration': {
            'Public': {
                'AllowRules': [
                    {
                        'Cidr': 'string'
                    },
                ]
            },
            'Vpc': {
                'SecurityGroupIds': [
                    'string',
                ],
                'SubnetId': 'string'
            }
        },
        'AssociatedOutputCount': 123,
        'AssociatedInputCount': 123,
        'RegionName': 'string',
        'CreatedAt': datetime(2015, 1, 1),
        'UpdatedAt': datetime(2015, 1, 1),
        'Tags': {
            'string': 'string'
        }
    }
}

Response Structure

  • (dict) –

    • RouterNetworkInterface (dict) –

      The details of the requested router network interface, including its configuration and other attributes.

      • Name (string) –

        The name of the router network interface.

      • Arn (string) –

        The Amazon Resource Name (ARN) of the router network interface.

      • Id (string) –

        The unique identifier of the router network interface.

      • State (string) –

        The current state of the router network interface.

      • NetworkInterfaceType (string) –

        The type of the router network interface.

      • Configuration (dict) –

        The configuration settings for a router network interface.

        Note

        This is a Tagged Union structure. Only one of the following top level keys will be set: Public, Vpc. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

        'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}

        • Public (dict) –

          The configuration settings for a public router network interface, including the list of allowed CIDR blocks.

          • AllowRules (list) –

            The list of allowed CIDR blocks for the public router network interface.

            • (dict) –

              A rule that allows a specific CIDR block to access the public router network interface.

              • Cidr (string) –

                The CIDR block that is allowed to access the public router network interface.

        • Vpc (dict) –

          The configuration settings for a router network interface within a VPC, including the security group IDs and subnet ID.

          • SecurityGroupIds (list) –

            The IDs of the security groups to associate with the router network interface within the VPC.

            • (string) –

          • SubnetId (string) –

            The ID of the subnet within the VPC to associate the router network interface with.

      • AssociatedOutputCount (integer) –

        The number of router outputs associated with the network interface.

      • AssociatedInputCount (integer) –

        The number of router inputs associated with the network interface.

      • RegionName (string) –

        The AWS Region where the router network interface is located.

      • CreatedAt (datetime) –

        The timestamp when the router network interface was created.

      • UpdatedAt (datetime) –

        The timestamp when the router network interface was last updated.

      • Tags (dict) –

        Key-value pairs that can be used to tag and organize this router network interface.

        • (string) –

          • (string) –

Exceptions