DirectoryServiceData / Client / describe_group

describe_group#

DirectoryServiceData.Client.describe_group(**kwargs)#

Returns information about a specific group.

Request Syntax

response = client.describe_group(
    DirectoryId='string',
    OtherAttributes=[
        'string',
    ],
    Realm='string',
    SAMAccountName='string'
)

Parameters:

DirectoryId (string) –
[REQUIRED]

The Identifier (ID) of the directory associated with the group.
OtherAttributes (list) –
One or more attributes to be returned for the group. For a list of supported attributes, see Directory Service Data Attributes.
- (string) –
Realm (string) –
The domain name that’s associated with the group.

Note
This parameter is optional, so you can return groups outside of your Managed Microsoft AD domain. When no value is defined, only your Managed Microsoft AD groups are returned.

This value is case insensitive.
SAMAccountName (string) –
[REQUIRED]

The name of the group.

Return type:

dict

Returns:

Response Syntax

{
    'DirectoryId': 'string',
    'DistinguishedName': 'string',
    'GroupScope': 'DomainLocal'|'Global'|'Universal'|'BuiltinLocal',
    'GroupType': 'Distribution'|'Security',
    'OtherAttributes': {
        'string': {
            'BOOL': True|False,
            'N': 123,
            'S': 'string',
            'SS': [
                'string',
            ]
        }
    },
    'Realm': 'string',
    'SAMAccountName': 'string',
    'SID': 'string'
}

Response Structure

(dict) –
- DirectoryId (string) –
  
  The identifier (ID) of the directory that’s associated with the group.
- DistinguishedName (string) –
  
  The distinguished name of the object.
- GroupScope (string) –
  
  The scope of the AD group. For details, see Active Directory security groups.
- GroupType (string) –
  
  The AD group type. For details, see Active Directory security group type.
- OtherAttributes (dict) –
  
  The attribute values that are returned for the attribute names that are included in the request.
  - (string) –
    - (dict) –
      
      The data type for an attribute. Each attribute value is described as a name-value pair. The name is the AD schema name, and the value is the data itself. For a list of supported attributes, see Directory Service Data Attributes.
      Note
      This is a Tagged Union structure. Only one of the following top level keys will be set: BOOL, N, S, SS. 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'}
      - BOOL (boolean) –
        
        Indicates that the attribute type value is a boolean. For example:
        
        "BOOL": true
      - N (integer) –
        
        Indicates that the attribute type value is a number. For example:
        
        "N": "16"
      - S (string) –
        
        Indicates that the attribute type value is a string. For example:
        
        "S": "S Group"
      - SS (list) –
        
        Indicates that the attribute type value is a string set. For example:
        
        "SS": ["sample_service_class/host.sample.com:1234/sample_service_name_1", "sample_service_class/host.sample.com:1234/sample_service_name_2"]
        
        (string) –
- Realm (string) –
  
  The domain name that’s associated with the group.
- SAMAccountName (string) –
  
  The name of the group.
- SID (string) –
  
  The unique security identifier (SID) of the group.

Exceptions

DirectoryServiceData.Client.exceptions.ResourceNotFoundException
DirectoryServiceData.Client.exceptions.AccessDeniedException
DirectoryServiceData.Client.exceptions.InternalServerException
DirectoryServiceData.Client.exceptions.ValidationException
DirectoryServiceData.Client.exceptions.DirectoryUnavailableException
DirectoryServiceData.Client.exceptions.ThrottlingException