MediaLive / Client / describe_node

describe_node#

MediaLive.Client.describe_node(**kwargs)#

Get details about a Node in the specified Cluster.

See also: AWS API Documentation

Request Syntax

response = client.describe_node(
    ClusterId='string',
    NodeId='string'
)
Parameters:

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

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

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'
}

Response Structure

  • (dict) – Details for one node.

    • 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.

Exceptions

  • MediaLive.Client.exceptions.BadRequestException

  • MediaLive.Client.exceptions.InternalServerErrorException

  • MediaLive.Client.exceptions.ForbiddenException

  • MediaLive.Client.exceptions.BadGatewayException

  • MediaLive.Client.exceptions.NotFoundException

  • MediaLive.Client.exceptions.GatewayTimeoutException

  • MediaLive.Client.exceptions.TooManyRequestsException