Deletes a group resource.
See also: AWS API Documentation
See ‘aws help’ for descriptions of global parameters.
delete-group
[--group-name <value>]
[--group-arn <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
--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
| --cli-input-yaml
(string)
Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton
. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml
.
--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
. Similarly, if provided yaml-input
it will print a sample input YAML that can be used with --cli-input-yaml
. 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.
To delete a group
The following delete-group
example deletes the specified group resource.
aws xray delete-group \
--group-name "AdminGroup" \
--group-arn "arn:aws:xray:us-east-2:123456789012:group/AdminGroup/123456789"
This command produces no output.
For more information, see Configuring Sampling, Groups, and Encryption Settings with the AWS X-Ray API in the AWS X-Ray Developer Guide.
None