UpdateGroupCommand

Suggest an Edit

Updates a group resource.

Example Syntax

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

import { XRayClient, UpdateGroupCommand } from "@aws-sdk/client-xray"; // ES Modules import
// const { XRayClient, UpdateGroupCommand } = require("@aws-sdk/client-xray"); // CommonJS import
const client = new XRayClient(config);
const input = { // UpdateGroupRequest
  GroupName: "STRING_VALUE",
  GroupARN: "STRING_VALUE",
  FilterExpression: "STRING_VALUE",
  InsightsConfiguration: { // InsightsConfiguration
    InsightsEnabled: true || false,
    NotificationsEnabled: true || false,
  },
};
const command = new UpdateGroupCommand(input);
const response = await client.send(command);
// { // UpdateGroupResult
//   Group: { // Group
//     GroupName: "STRING_VALUE",
//     GroupARN: "STRING_VALUE",
//     FilterExpression: "STRING_VALUE",
//     InsightsConfiguration: { // InsightsConfiguration
//       InsightsEnabled: true || false,
//       NotificationsEnabled: true || false,
//     },
//   },
// };

UpdateGroupCommand Input

See UpdateGroupCommandInput for more details

Parameter
Type
Description
FilterExpression
string | undefined

The updated filter expression defining criteria by which to group traces.

GroupARN
string | undefined

The ARN that was generated upon creation.

GroupName
string | undefined

The case-sensitive name of the group.

InsightsConfiguration
InsightsConfiguration | undefined

The structure containing configurations related to insights.

  • The InsightsEnabled boolean can be set to true to enable insights for the group or false to disable insights for the group.

  • The NotificationsEnabled boolean can be set to true to enable insights notifications for the group. Notifications can only be enabled on a group with InsightsEnabled set to true.

UpdateGroupCommand Output

See UpdateGroupCommandOutput for details

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

The group that was updated. Contains the name of the group that was updated, the ARN of the group that was updated, the updated filter expression, and the updated insight configuration assigned to the group.

Throws

Name
Fault
Details
InvalidRequestException
client

The request is missing required parameters or has invalid parameters.

ThrottledException
client

The request exceeds the maximum number of requests per second.

XRayServiceException
Base exception class for all service exceptions from XRay service.