GetGroupCommand

Suggest an Edit

Describes a group by group name.

Example Syntax

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

import { QBusinessClient, GetGroupCommand } from "@aws-sdk/client-qbusiness"; // ES Modules import
// const { QBusinessClient, GetGroupCommand } = require("@aws-sdk/client-qbusiness"); // CommonJS import
const client = new QBusinessClient(config);
const input = { // GetGroupRequest
  applicationId: "STRING_VALUE", // required
  indexId: "STRING_VALUE", // required
  groupName: "STRING_VALUE", // required
  dataSourceId: "STRING_VALUE",
};
const command = new GetGroupCommand(input);
const response = await client.send(command);
// { // GetGroupResponse
//   status: { // GroupStatusDetail
//     status: "FAILED" || "SUCCEEDED" || "PROCESSING" || "DELETING" || "DELETED",
//     lastUpdatedAt: new Date("TIMESTAMP"),
//     errorDetail: { // ErrorDetail
//       errorMessage: "STRING_VALUE",
//       errorCode: "InternalError" || "InvalidRequest" || "ResourceInactive" || "ResourceNotFound",
//     },
//   },
//   statusHistory: [ // GroupStatusDetails
//     {
//       status: "FAILED" || "SUCCEEDED" || "PROCESSING" || "DELETING" || "DELETED",
//       lastUpdatedAt: new Date("TIMESTAMP"),
//       errorDetail: {
//         errorMessage: "STRING_VALUE",
//         errorCode: "InternalError" || "InvalidRequest" || "ResourceInactive" || "ResourceNotFound",
//       },
//     },
//   ],
// };

GetGroupCommand Input

See GetGroupCommandInput for more details

Parameter
Type
Description
applicationId
Required
string | undefined

The identifier of the application id the group is attached to.

groupName
Required
string | undefined

The name of the group.

indexId
Required
string | undefined

The identifier of the index the group is attached to.

dataSourceId
string | undefined

The identifier of the data source the group is attached to.

GetGroupCommand Output

See GetGroupCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
status
GroupStatusDetail | undefined

The current status of the group.

statusHistory
GroupStatusDetail[] | undefined

The status history of the group.

Throws

Name
Fault
Details
AccessDeniedException
client

You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.

ConflictException
client

You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistencies with your resources and try again.

InternalServerException
server

An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support  for help.

ResourceNotFoundException
client

The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.

ThrottlingException
client

The request was denied due to throttling. Reduce the number of requests and try again.

ValidationException
client

The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.

QBusinessServiceException
Base exception class for all service exceptions from QBusiness service.