MediaConnect / Client / batch_get_router_network_interface

batch_get_router_network_interface

MediaConnect.Client.batch_get_router_network_interface(**kwargs)

Retrieves information about multiple router network interfaces in AWS Elemental MediaConnect.

See also: AWS API Documentation

Request Syntax

response = client.batch_get_router_network_interface(
    Arns=[
        'string',
    ]
)
Parameters:

Arns (list) –

[REQUIRED]

The Amazon Resource Names (ARNs) of the router network interfaces you want to retrieve information about.

  • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'RouterNetworkInterfaces': [
        {
            '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'
            }
        },
    ],
    'Errors': [
        {
            'Arn': 'string',
            'Code': 'string',
            'Message': 'string'
        },
    ]
}

Response Structure

  • (dict) –

    • RouterNetworkInterfaces (list) –

      An array of router network interfaces that were successfully retrieved.

      • (dict) –

        A router network interface in AWS Elemental MediaConnect. A router network interface is a network interface that can be associated with one or more router inputs and outputs.

        • 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) –

    • Errors (list) –

      An array of errors that occurred when retrieving the requested router network interfaces.

      • (dict) –

        An error that occurred when retrieving multiple router network interfaces in the BatchGetRouterNetworkInterface operation, including the ARN, error code, and error message.

        • Arn (string) –

          The Amazon Resource Name (ARN) of the router network interface for which the error occurred.

        • Code (string) –

          The error code associated with the error.

        • Message (string) –

          A message describing the error.

Exceptions