MediaLive / Client / list_clusters

list_clusters#

MediaLive.Client.list_clusters(**kwargs)#

Retrieve the list of Clusters.

Request Syntax

response = client.list_clusters(
    MaxResults=123,
    NextToken='string'
)

Parameters:

MaxResults (integer) – The maximum number of items to return.
NextToken (string) – The token to retrieve the next page of results.

Return type:

dict

Returns:

Response Syntax

{
    'Clusters': [
        {
            'Arn': 'string',
            'ChannelIds': [
                'string',
            ],
            'ClusterType': 'ON_PREMISES',
            'Id': 'string',
            'InstanceRoleArn': 'string',
            'Name': 'string',
            'NetworkSettings': {
                'DefaultRoute': 'string',
                'InterfaceMappings': [
                    {
                        'LogicalInterfaceName': 'string',
                        'NetworkId': 'string'
                    },
                ]
            },
            'State': 'CREATING'|'CREATE_FAILED'|'ACTIVE'|'DELETING'|'DELETE_FAILED'|'DELETED'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) – An array of clusters.
- Clusters (list) – A list of the Clusters that exist in your AWS account.
  - (dict) – Used in ListClustersResult.
    - Arn (string) – The ARN of this Cluster. It is automatically assigned when the Cluster is created.
    - ChannelIds (list) – An array of the IDs of the Channels that are associated with this Cluster. One Channel is associated with the Cluster as follows: A Channel belongs to a ChannelPlacementGroup. A ChannelPlacementGroup is attached to a Node. A Node belongs to a Cluster.
      - (string) – Placeholder documentation for __string
    - ClusterType (string) – The hardware type for the Cluster.
    - Id (string) – The ID of the Cluster. Unique in the AWS account. The ID is the resource-id portion of the ARN.
    - InstanceRoleArn (string) – The ARN of the IAM role for the Node in this Cluster. Any Nodes that are associated with this Cluster assume this role. The role gives permissions to the operations that you expect these Node to perform.
    - Name (string) – The name that you specified for the Cluster.
    - NetworkSettings (dict) – Network settings that connect the Nodes in the Cluster to one or more of the Networks that the Cluster is associated with.
      - DefaultRoute (string) – The network interface that is the default route for traffic to and from the node. MediaLive Anywhere uses this default when the destination for the traffic isn’t covered by the route table for any of the networks. Specify the value of the appropriate logicalInterfaceName parameter that you create in the interfaceMappings.
      - InterfaceMappings (list) – An array of interfaceMapping objects for this Cluster. Each mapping logically connects one interface on the nodes with one Network. You need only one mapping for each interface because all the Nodes share the mapping.
        
        (dict) – Used in ClusterNetworkSettings
        
        LogicalInterfaceName (string) – The logical name for one interface (on every Node) that handles a specific type of traffic. We recommend that the name hints at the physical interface it applies to. For example, it could refer to the traffic that the physical interface handles. For example, my-Inputs-Interface.
        
        NetworkId (string) – The ID of the network that you want to connect to the specified logicalInterfaceName.
    - State (string) – The current state of the Cluster.
- NextToken (string) – Token for the next result.

Exceptions

MediaLive.Client.exceptions.BadRequestException
MediaLive.Client.exceptions.InternalServerErrorException
MediaLive.Client.exceptions.ForbiddenException
MediaLive.Client.exceptions.BadGatewayException
MediaLive.Client.exceptions.GatewayTimeoutException
MediaLive.Client.exceptions.TooManyRequestsException