# DescribeGroup
<a name="API_DescribeGroup"></a>

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](https://docs.aws.amazon.com/singlesignon/latest/userguide/manage-your-accounts.html#limiting-access-from-member-accounts) in the * Amazon IAM Identity Center User Guide*.

## Request Syntax
<a name="API_DescribeGroup_RequestSyntax"></a>

```
{
   "GroupId": "string",
   "IdentityStoreId": "string"
}
```

## Request Parameters
<a name="API_DescribeGroup_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [GroupId](#API_DescribeGroup_RequestSyntax) **   <a name="singlesignon-DescribeGroup-request-GroupId"></a>
The identifier for a group in the identity store.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 47.  
Pattern: `([0-9a-f]{10}-|)[A-Fa-f0-9]{8}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{12}`   
Required: Yes

 ** [IdentityStoreId](#API_DescribeGroup_RequestSyntax) **   <a name="singlesignon-DescribeGroup-request-IdentityStoreId"></a>
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.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 36.  
Pattern: `d-[0-9a-f]{10}$|^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}`   
Required: Yes

## Response Syntax
<a name="API_DescribeGroup_ResponseSyntax"></a>

```
{
   "CreatedAt": number,
   "CreatedBy": "string",
   "Description": "string",
   "DisplayName": "string",
   "ExternalIds": [ 
      { 
         "Id": "string",
         "Issuer": "string"
      }
   ],
   "GroupId": "string",
   "IdentityStoreId": "string",
   "UpdatedAt": number,
   "UpdatedBy": "string"
}
```

## Response Elements
<a name="API_DescribeGroup_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [CreatedAt](#API_DescribeGroup_ResponseSyntax) **   <a name="singlesignon-DescribeGroup-response-CreatedAt"></a>
The date and time the group was created.  
Type: Timestamp

 ** [CreatedBy](#API_DescribeGroup_ResponseSyntax) **   <a name="singlesignon-DescribeGroup-response-CreatedBy"></a>
The identifier of the user or system that created the group.  
Type: String

 ** [Description](#API_DescribeGroup_ResponseSyntax) **   <a name="singlesignon-DescribeGroup-response-Description"></a>
A string containing a description of the group.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `[\p{L}\p{M}\p{S}\p{N}\p{P}\t\n\r  　]+` 

 ** [DisplayName](#API_DescribeGroup_ResponseSyntax) **   <a name="singlesignon-DescribeGroup-response-DisplayName"></a>
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.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `[\p{L}\p{M}\p{S}\p{N}\p{P}\t\n\r  ]+` 

 ** [ExternalIds](#API_DescribeGroup_ResponseSyntax) **   <a name="singlesignon-DescribeGroup-response-ExternalIds"></a>
A list of `ExternalId` objects that contains the identifiers issued to this resource by an external identity provider.  
Type: Array of [ExternalId](API_ExternalId.md) objects  
Array Members: Minimum number of 1 item. Maximum number of 10 items.

 ** [GroupId](#API_DescribeGroup_ResponseSyntax) **   <a name="singlesignon-DescribeGroup-response-GroupId"></a>
The identifier for a group in the identity store.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 47.  
Pattern: `([0-9a-f]{10}-|)[A-Fa-f0-9]{8}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{12}` 

 ** [IdentityStoreId](#API_DescribeGroup_ResponseSyntax) **   <a name="singlesignon-DescribeGroup-response-IdentityStoreId"></a>
The globally unique identifier for the identity store.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 36.  
Pattern: `d-[0-9a-f]{10}$|^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}` 

 ** [UpdatedAt](#API_DescribeGroup_ResponseSyntax) **   <a name="singlesignon-DescribeGroup-response-UpdatedAt"></a>
The date and time the group was last updated.  
Type: Timestamp

 ** [UpdatedBy](#API_DescribeGroup_ResponseSyntax) **   <a name="singlesignon-DescribeGroup-response-UpdatedBy"></a>
The identifier of the user or system that last updated the group.  
Type: String

## Errors
<a name="API_DescribeGroup_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.    
 ** Reason **   
Indicates the reason for an access denial when returned by KMS while accessing a Customer Managed KMS key. For non-KMS access-denied errors, this field is not included.  
 ** RequestId **   
The identifier for each request. This value is a globally unique ID that is generated by the identity store service for each sent request, and is then returned inside the exception if the request fails.
HTTP Status Code: 400

 ** InternalServerException **   
The request processing has failed because of an unknown error, exception or failure with an internal server.    
 ** RequestId **   
The identifier for each request. This value is a globally unique ID that is generated by the identity store service for each sent request, and is then returned inside the exception if the request fails.  
 ** RetryAfterSeconds **   
The number of seconds to wait before retrying the next request.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
Indicates that a requested resource is not found.    
 ** Reason **   
Indicates the reason for a resource not found error when the service is unable to access a Customer Managed KMS key. For non-KMS permission errors, this field is not included.  
 ** RequestId **   
The identifier for each request. This value is a globally unique ID that is generated by the identity store service for each sent request, and is then returned inside the exception if the request fails.  
 ** ResourceId **   
The identifier for a resource in the identity store that can be used as `UserId` or `GroupId`. The format for `ResourceId` is either `UUID` or `1234567890-UUID`, where `UUID` is a randomly generated value for each resource when it is created and `1234567890` represents the ` IdentityStoreId` string value. In the case that the identity store is migrated from a legacy SSO identity store, the `ResourceId` for that identity store will be in the format of `UUID`. Otherwise, it will be in the `1234567890-UUID` format.  
 ** ResourceType **   
An enum object indicating the type of resource in the identity store service. Valid values include USER, GROUP, and IDENTITY\$1STORE.
HTTP Status Code: 400

 ** ThrottlingException **   
Indicates that the principal has crossed the throttling limits of the API operations.    
 ** Reason **   
Indicates the reason for the throttling error when the service is unable to access a Customer Managed KMS key. For non-KMS permission errors, this field is not included.  
 ** RequestId **   
The identifier for each request. This value is a globally unique ID that is generated by the identity store service for each sent request, and is then returned inside the exception if the request fails.  
 ** RetryAfterSeconds **   
The number of seconds to wait before retrying the next request.
HTTP Status Code: 400

 ** ValidationException **   
The request failed because it contains a syntax error.    
 ** Reason **   
Indicates the reason for the validation error when the service is unable to access a Customer Managed KMS key. For non-KMS permission errors, this field is not included.  
 ** RequestId **   
The identifier for each request. This value is a globally unique ID that is generated by the identity store service for each sent request, and is then returned inside the exception if the request fails.
HTTP Status Code: 400

## Examples
<a name="API_DescribeGroup_Examples"></a>

### Example
<a name="API_DescribeGroup_Example_1"></a>

This example retrieves the group name and description for a group called Developers.

#### Sample Request
<a name="API_DescribeGroup_Example_1_Request"></a>

```
{
    "IdentityStoreId": "d-1234567890",
    "GroupId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE22222"
}
```

#### Sample Response
<a name="API_DescribeGroup_Example_1_Response"></a>

```
{
    "GroupId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE22222",
    "DisplayName": "Developers",
    "Description": "Group that contains all developers",
    "IdentityStoreId": "d-1234567890"
}
```

## See Also
<a name="API_DescribeGroup_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon Command Line Interface V2](https://docs.amazonaws.cn/goto/cli2/identitystore-2020-06-15/DescribeGroup) 
+  [Amazon SDK for .NET V4](https://docs.amazonaws.cn/goto/DotNetSDKV4/identitystore-2020-06-15/DescribeGroup) 
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/identitystore-2020-06-15/DescribeGroup) 
+  [Amazon SDK for Go v2](https://docs.amazonaws.cn/goto/SdkForGoV2/identitystore-2020-06-15/DescribeGroup) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/identitystore-2020-06-15/DescribeGroup) 
+  [Amazon SDK for JavaScript V3](https://docs.amazonaws.cn/goto/SdkForJavaScriptV3/identitystore-2020-06-15/DescribeGroup) 
+  [Amazon SDK for Kotlin](https://docs.amazonaws.cn/goto/SdkForKotlin/identitystore-2020-06-15/DescribeGroup) 
+  [Amazon SDK for PHP V3](https://docs.amazonaws.cn/goto/SdkForPHPV3/identitystore-2020-06-15/DescribeGroup) 
+  [Amazon SDK for Python](https://docs.amazonaws.cn/goto/boto3/identitystore-2020-06-15/DescribeGroup) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/identitystore-2020-06-15/DescribeGroup)