DescribeGroupCommand

Suggest an Edit

Retrieves the group metadata and attributes from GroupId in an identity store.

If you have administrator access to a member account, you can use this API from the member account. Read about member accounts  in the Organizations User Guide.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { IdentitystoreClient, DescribeGroupCommand } from "@aws-sdk/client-identitystore"; // ES Modules import
// const { IdentitystoreClient, DescribeGroupCommand } = require("@aws-sdk/client-identitystore"); // CommonJS import
const client = new IdentitystoreClient(config);
const input = { // DescribeGroupRequest
  IdentityStoreId: "STRING_VALUE", // required
  GroupId: "STRING_VALUE", // required
};
const command = new DescribeGroupCommand(input);
const response = await client.send(command);
// { // DescribeGroupResponse
//   GroupId: "STRING_VALUE", // required
//   DisplayName: "STRING_VALUE",
//   ExternalIds: [ // ExternalIds
//     { // ExternalId
//       Issuer: "STRING_VALUE", // required
//       Id: "STRING_VALUE", // required
//     },
//   ],
//   Description: "STRING_VALUE",
//   IdentityStoreId: "STRING_VALUE", // required
// };

DescribeGroupCommand Input

See DescribeGroupCommandInput for more details

Parameter
Type
Description
GroupId
Required
string | undefined

The identifier for a group in the identity store.

IdentityStoreId
Required
string | undefined

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.

DescribeGroupCommand Output

See DescribeGroupCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
GroupId
Required
string | undefined

The identifier for a group in the identity store.

IdentityStoreId
Required
string | undefined

The globally unique identifier for the identity store.

Description
string | undefined

A string containing a description of the group.

DisplayName
string | undefined

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
ExternalId[] | undefined

A list of ExternalId objects that contains the identifiers issued to this resource by an external identity provider.

Throws

Name
Fault
Details
ResourceNotFoundException
client

Indicates that a requested resource is not found.

ValidationException
client

The request failed because it contains a syntax error.

AccessDeniedException
client

You do not have sufficient access to perform this action.

InternalServerException
server

The request processing has failed because of an unknown error, exception or failure with an internal server.

ThrottlingException
client

Indicates that the principal has crossed the throttling limits of the API operations.

IdentitystoreServiceException
Base exception class for all service exceptions from Identitystore service.