IdentityStore / Client / describe_group_membership

describe_group_membership¶

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 in the IAM Identity Center User Guide.

Request Syntax

response = client.describe_group_membership(
    IdentityStoreId='string',
    MembershipId='string'
)

Parameters:

IdentityStoreId (string) –
[REQUIRED]

The globally unique identifier for the identity store.
MembershipId (string) –
[REQUIRED]

The identifier for a GroupMembership in an identity store.

Return type:

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

IdentityStore.Client.exceptions.ResourceNotFoundException
IdentityStore.Client.exceptions.ThrottlingException
IdentityStore.Client.exceptions.AccessDeniedException
IdentityStore.Client.exceptions.InternalServerException
IdentityStore.Client.exceptions.ValidationException