IdentityStore / Client / describe_group

describe_group¶

IdentityStore.Client.describe_group(**kwargs)¶

Retrieves the group metadata and attributes from GroupId 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(
    IdentityStoreId='string',
    GroupId='string'
)

Parameters:

IdentityStoreId (string) –
[REQUIRED]

The globally unique identifier for the identity store, such as d-1234567890. In this example, d- is a fixed prefix, and 1234567890 is a randomly generated string that contains numbers and lower case letters. This value is generated at the time that a new identity store is created.

You can specify the identity store by ID or by Amazon Resource Name (ARN). For example, identity store ID d-1234567890 or identity store ARN arn:aws:identitystore::111122223333:identitystore/d-1234567890.
GroupId (string) –
[REQUIRED]

The identifier for a group in the identity store.

You can specify the group by ID or by Amazon Resource Name (ARN). For example, group ID a1b2c3d4-5678-90ab-cdef-EXAMPLE22222 or group ARN arn:aws:identitystore:::group/a1b2c3d4-5678-90ab-cdef-EXAMPLE22222.

Return type:

dict

Returns:

Response Syntax

{
    'IdentityStoreId': 'string',
    'GroupId': 'string',
    'GroupArn': 'string',
    'Revision': 'string',
    'DisplayName': 'string',
    'ExternalIds': [
        {
            'Issuer': 'string',
            'Id': 'string'
        },
    ],
    'Description': '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.
- GroupId (string) –
  
  The identifier for a group in the identity store.
- GroupArn (string) –
  
  The Amazon Resource Name (ARN) of the group in the identity store. For example, arn:aws:identitystore:::group/a1b2c3d4-5678-90ab-cdef-EXAMPLE22222.
- Revision (string) –
  
  The current revision of the group in the identity store. This value changes each time the group is modified.
- DisplayName (string) –
  
  The group’s display name value. The length limit is 1,024 characters. This value can consist of letters, accented characters, symbols, numbers, punctuation, tab, new line, carriage return, space, and nonbreaking space in this attribute. This value is specified at the time that the group is created and stored as an attribute of the group object in the identity store.
- ExternalIds (list) –
  
  A list of ExternalId objects that contains the identifiers issued to this resource by an external identity provider.
  - (dict) –
    
    The identifier issued to this resource by an external identity provider.
    - Issuer (string) –
      
      The issuer for an external identifier.
    - Id (string) –
      
      The identifier issued to this resource by an external identity provider.
- Description (string) –
  
  A string containing a description of the group.
- CreatedAt (datetime) –
  
  The date and time the group was created.
- UpdatedAt (datetime) –
  
  The date and time the group was last updated.
- CreatedBy (string) –
  
  The identifier of the user or system that created the group.
- UpdatedBy (string) –
  
  The identifier of the user or system that last updated the group.

Exceptions

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