:doc:`IdentityStore <../../identitystore>` / Client / describe_group_membership

*************************
describe_group_membership
*************************



.. py:method:: IdentityStore.Client.describe_group_membership(**kwargs)

  

  Retrieves membership metadata and attributes from ``MembershipId`` in an identity store.

   

  .. note::

    

    If you have access to a member account, you can use this API operation from the member account. For more information, see `Limiting access to the identity store from member accounts <https://docs.aws.amazon.com/singlesignon/latest/userguide/manage-your-accounts.html#limiting-access-from-member-accounts>`__ in the *IAM Identity Center User Guide*.

    

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/DescribeGroupMembership>`_  


  **Request Syntax**
  ::

    response = client.describe_group_membership(
        IdentityStoreId='string',
        MembershipId='string'
    )
    
  :type IdentityStoreId: string
  :param IdentityStoreId: **[REQUIRED]** 

    The globally unique identifier for the identity store.

    

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

    The identifier for a ``GroupMembership`` in an identity store.

    

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

    
    ::

      {
          'IdentityStoreId': 'string',
          'MembershipId': 'string',
          'GroupId': 'string',
          'MemberId': {
              'UserId': 'string'
          },
          'CreatedAt': datetime(2015, 1, 1),
          'UpdatedAt': datetime(2015, 1, 1),
          'CreatedBy': 'string',
          'UpdatedBy': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **IdentityStoreId** *(string) --* 

        The globally unique identifier for the identity store.

        
      

      - **MembershipId** *(string) --* 

        The identifier for a ``GroupMembership`` in an identity store.

        
      

      - **GroupId** *(string) --* 

        The identifier for a group in the identity store.

        
      

      - **MemberId** *(dict) --* 

        An object containing the identifier of a group member.

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


      
        

        - **UserId** *(string) --* 

          An object containing the identifiers of resources that can be members.

          
    
      

      - **CreatedAt** *(datetime) --* 

        The date and time the group membership was created.

        
      

      - **UpdatedAt** *(datetime) --* 

        The date and time the group membership was last updated.

        
      

      - **CreatedBy** *(string) --* 

        The identifier of the user or system that created the group membership.

        
      

      - **UpdatedBy** *(string) --* 

        The identifier of the user or system that last updated the group membership.

        
  
  **Exceptions**
  
  *   :py:class:`IdentityStore.Client.exceptions.ResourceNotFoundException`

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

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

  
  *   :py:class:`IdentityStore.Client.exceptions.InternalServerException`

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

  