EMRContainers / Client / describe_virtual_cluster

describe_virtual_cluster#

EMRContainers.Client.describe_virtual_cluster(**kwargs)#

Displays detailed information about a specified virtual cluster. Virtual cluster is a managed entity on Amazon EMR on EKS. You can create, describe, list and delete virtual clusters. They do not consume any additional resource in your system. A single virtual cluster maps to a single Kubernetes namespace. Given this relationship, you can model virtual clusters the same way you model Kubernetes namespaces to meet your requirements.

See also: AWS API Documentation

Request Syntax

response = client.describe_virtual_cluster(
    id='string'
)
Parameters:

id (string) –

[REQUIRED]

The ID of the virtual cluster that will be described.

Return type:

dict

Returns:

Response Syntax

{
    'virtualCluster': {
        'id': 'string',
        'name': 'string',
        'arn': 'string',
        'state': 'RUNNING'|'TERMINATING'|'TERMINATED'|'ARRESTED',
        'containerProvider': {
            'type': 'EKS',
            'id': 'string',
            'info': {
                'eksInfo': {
                    'namespace': 'string'
                }
            }
        },
        'createdAt': datetime(2015, 1, 1),
        'tags': {
            'string': 'string'
        }
    }
}

Response Structure

  • (dict) –

    • virtualCluster (dict) –

      This output displays information about the specified virtual cluster.

      • id (string) –

        The ID of the virtual cluster.

      • name (string) –

        The name of the virtual cluster.

      • arn (string) –

        The ARN of the virtual cluster.

      • state (string) –

        The state of the virtual cluster.

      • containerProvider (dict) –

        The container provider of the virtual cluster.

        • type (string) –

          The type of the container provider. Amazon EKS is the only supported type as of now.

        • id (string) –

          The ID of the container cluster.

        • info (dict) –

          The information about the container cluster.

          Note

          This is a Tagged Union structure. Only one of the following top level keys will be set: eksInfo. 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'}

          • eksInfo (dict) –

            The information about the Amazon EKS cluster.

            • namespace (string) –

              The namespaces of the Amazon EKS cluster.

      • createdAt (datetime) –

        The date and time when the virtual cluster is created.

      • tags (dict) –

        The assigned tags of the virtual cluster.

        • (string) –

          • (string) –

Exceptions

  • EMRContainers.Client.exceptions.ValidationException

  • EMRContainers.Client.exceptions.ResourceNotFoundException

  • EMRContainers.Client.exceptions.InternalServerException