:doc:`finspace <../../finspace>` / Client / get_kx_scaling_group

********************
get_kx_scaling_group
********************



.. py:method:: finspace.Client.get_kx_scaling_group(**kwargs)

  

  Retrieves details of a scaling group.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/GetKxScalingGroup>`_  


  **Request Syntax**
  ::

    response = client.get_kx_scaling_group(
        environmentId='string',
        scalingGroupName='string'
    )
    
  :type environmentId: string
  :param environmentId: **[REQUIRED]** 

    A unique identifier for the kdb environment.

    

  
  :type scalingGroupName: string
  :param scalingGroupName: **[REQUIRED]** 

    A unique identifier for the kdb scaling group.

    

  
  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {
          'scalingGroupName': 'string',
          'scalingGroupArn': 'string',
          'hostType': 'string',
          'clusters': [
              'string',
          ],
          'availabilityZoneId': 'string',
          'status': 'CREATING'|'CREATE_FAILED'|'ACTIVE'|'DELETING'|'DELETED'|'DELETE_FAILED',
          'statusReason': 'string',
          'lastModifiedTimestamp': datetime(2015, 1, 1),
          'createdTimestamp': datetime(2015, 1, 1)
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **scalingGroupName** *(string) --* 

        A unique identifier for the kdb scaling group.

        
      

      - **scalingGroupArn** *(string) --* 

        The ARN identifier for the scaling group.

        
      

      - **hostType** *(string) --* 

        The memory and CPU capabilities of the scaling group host on which FinSpace Managed kdb clusters will be placed.

         

        It can have one of the following values:

         

        
        * ``kx.sg.large`` – The host type with a configuration of 16 GiB memory and 2 vCPUs.
         
        * ``kx.sg.xlarge`` – The host type with a configuration of 32 GiB memory and 4 vCPUs.
         
        * ``kx.sg.2xlarge`` – The host type with a configuration of 64 GiB memory and 8 vCPUs.
         
        * ``kx.sg.4xlarge`` – The host type with a configuration of 108 GiB memory and 16 vCPUs.
         
        * ``kx.sg.8xlarge`` – The host type with a configuration of 216 GiB memory and 32 vCPUs.
         
        * ``kx.sg.16xlarge`` – The host type with a configuration of 432 GiB memory and 64 vCPUs.
         
        * ``kx.sg.32xlarge`` – The host type with a configuration of 864 GiB memory and 128 vCPUs.
         
        * ``kx.sg1.16xlarge`` – The host type with a configuration of 1949 GiB memory and 64 vCPUs.
         
        * ``kx.sg1.24xlarge`` – The host type with a configuration of 2948 GiB memory and 96 vCPUs.
        

        
      

      - **clusters** *(list) --* 

        The list of Managed kdb clusters that are currently active in the given scaling group.

        
        

        - *(string) --* 
    
      

      - **availabilityZoneId** *(string) --* 

        The identifier of the availability zones.

        
      

      - **status** *(string) --* 

        The status of scaling group.

         

        
        * CREATING – The scaling group creation is in progress.
         
        * CREATE_FAILED – The scaling group creation has failed.
         
        * ACTIVE – The scaling group is active.
         
        * UPDATING – The scaling group is in the process of being updated.
         
        * UPDATE_FAILED – The update action failed.
         
        * DELETING – The scaling group is in the process of being deleted.
         
        * DELETE_FAILED – The system failed to delete the scaling group.
         
        * DELETED – The scaling group is successfully deleted.
        

        
      

      - **statusReason** *(string) --* 

        The error message when a failed state occurs.

        
      

      - **lastModifiedTimestamp** *(datetime) --* 

        The last time that the scaling group was updated in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.

        
      

      - **createdTimestamp** *(datetime) --* 

        The timestamp at which the scaling group was created in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.

        
  
  **Exceptions**
  
  *   :py:class:`finspace.Client.exceptions.InternalServerException`

  
  *   :py:class:`finspace.Client.exceptions.ValidationException`

  
  *   :py:class:`finspace.Client.exceptions.ThrottlingException`

  
  *   :py:class:`finspace.Client.exceptions.AccessDeniedException`

  
  *   :py:class:`finspace.Client.exceptions.LimitExceededException`

  
  *   :py:class:`finspace.Client.exceptions.ConflictException`

  
  *   :py:class:`finspace.Client.exceptions.ResourceNotFoundException`

  