Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . xray ]

get-group

Description

Retrieves group resource details.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  get-group
[--group-name <value>]
[--group-arn <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--group-name (string)

The case-sensitive name of the group.

--group-arn (string)

The ARN of the group that was generated on creation.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Examples

To retrieve a group

The following get-group example displays details for the specified group resource. The details include the group name, the group ARN, and the filter expression that defines the criteria for that group. Groups can also be retrieved by ARN.

aws xray get-group \
    --group-name "AdminGroup"

Output:

{
    "Group": [
        {
            "GroupName": "AdminGroup",
            "GroupARN": "arn:aws:xray:us-west-2:123456789012:group/AdminGroup/123456789",
            "FilterExpression": "service(\"mydomain.com\") {fault OR error}"
        }
    ]
}

For more information, see Configuring Sampling, Groups, and Encryption Settings with the AWS X-Ray API in the AWS X-Ray Developer Guide.

Output

Group -> (structure)

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

GroupName -> (string)

The unique case-sensitive name of the group.

GroupARN -> (string)

The ARN of the group generated based on the GroupName.

FilterExpression -> (string)

The filter expression defining the parameters to include traces.