MediaLive / Client / update_node

update_node

MediaLive.Client.update_node(**kwargs)

Change the settings for a Node.

See also: AWS API Documentation

Request Syntax

response = client.update_node(
    ClusterId='string',
    Name='string',
    NodeId='string',
    Role='BACKUP'|'ACTIVE',
    SdiSourceMappings=[
        {
            'CardNumber': 123,
            'ChannelNumber': 123,
            'SdiSource': 'string'
        },
    ]
)
Parameters:

  • ClusterId (string) – [REQUIRED] The ID of the cluster

  • Name (string) – Include this parameter only if you want to change the current name of the Node. Specify a name that is unique in the Cluster. You can’t change the name. Names are case-sensitive.

  • NodeId (string) – [REQUIRED] The ID of the node.

  • Role (string) – The initial role of the Node in the Cluster. ACTIVE means the Node is available for encoding. BACKUP means the Node is a redundant Node and might get used if an ACTIVE Node fails.

  • SdiSourceMappings (list) –

    The mappings of a SDI capture card port to a logical SDI data stream

    • (dict) – Used in SdiSourceMappingsUpdateRequest. One SDI source mapping. It connects one logical SdiSource to the physical SDI card and port that the physical SDI source uses. You must specify all three parameters in this object.

      • CardNumber (integer) – A number that uniquely identifies the SDI card on the node hardware. For information about how physical cards are identified on your node hardware, see the documentation for your node hardware. The numbering always starts at 1.

      • ChannelNumber (integer) – A number that uniquely identifies a port on the card. This must be an SDI port (not a timecode port, for example). For information about how ports are identified on physical cards, see the documentation for your node hardware.

      • SdiSource (string) – The ID of a SDI source streaming on the given SDI capture card port.

Return type:

dict

Returns:

Response Syntax

{
    'Arn': 'string',
    'ChannelPlacementGroups': [
        'string',
    ],
    'ClusterId': 'string',
    'ConnectionState': 'CONNECTED'|'DISCONNECTED',
    'Id': 'string',
    'InstanceArn': 'string',
    'Name': 'string',
    'NodeInterfaceMappings': [
        {
            'LogicalInterfaceName': 'string',
            'NetworkInterfaceMode': 'NAT'|'BRIDGE',
            'PhysicalInterfaceName': 'string'
        },
    ],
    'Role': 'BACKUP'|'ACTIVE',
    'State': 'CREATED'|'REGISTERING'|'READY_TO_ACTIVATE'|'REGISTRATION_FAILED'|'ACTIVATION_FAILED'|'ACTIVE'|'READY'|'IN_USE'|'DEREGISTERING'|'DRAINING'|'DEREGISTRATION_FAILED'|'DEREGISTERED',
    'SdiSourceMappings': [
        {
            'CardNumber': 123,
            'ChannelNumber': 123,
            'SdiSource': 'string'
        },
    ]
}

Response Structure

  • (dict) – Update of the Node is in progress.

    • Arn (string) – The ARN of the Node. It is automatically assigned when the Node is created.

    • ChannelPlacementGroups (list) – An array of IDs. Each ID is one ChannelPlacementGroup that is associated with this Node. Empty if the Node is not yet associated with any groups.

      • (string) – Placeholder documentation for __string

    • ClusterId (string) – The ID of the Cluster that the Node belongs to.

    • ConnectionState (string) – The current connection state of the Node.

    • Id (string) – The unique ID of the Node. Unique in the Cluster. The ID is the resource-id portion of the ARN.

    • InstanceArn (string) – The ARN of the EC2 instance hosting the Node.

    • Name (string) – The name that you specified for the Node.

    • NodeInterfaceMappings (list) – Documentation update needed

      • (dict) – A mapping that’s used to pair a logical network interface name on a Node with the physical interface name exposed in the operating system.

        • LogicalInterfaceName (string) – A uniform logical interface name to address in a MediaLive channel configuration.

        • NetworkInterfaceMode (string) – Used in NodeInterfaceMapping and NodeInterfaceMappingCreateRequest

        • PhysicalInterfaceName (string) – The name of the physical interface on the hardware that will be running Elemental anywhere.

    • Role (string) – The initial role current role of the Node in the Cluster. ACTIVE means the Node is available for encoding. BACKUP means the Node is a redundant Node and might get used if an ACTIVE Node fails.

    • State (string) – The current state of the Node.

    • SdiSourceMappings (list) – An array of SDI source mappings. Each mapping connects one logical SdiSource to the physical SDI card and port that the physical SDI source uses.

      • (dict) – Used in DescribeNodeSummary, DescribeNodeResult.

        • CardNumber (integer) – A number that uniquely identifies the SDI card on the node hardware.

        • ChannelNumber (integer) – A number that uniquely identifies a port on the SDI card.

        • SdiSource (string) – The ID of the SdiSource to associate with this port on this card. You can use the ListSdiSources operation to discover all the IDs.

Exceptions