[ aws . synthetics ]

get-group

Description

Returns information about one group. Groups are a global resource, so you can use this operation from any Region.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  get-group
--group-identifier <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--group-identifier (string)

Specifies the group to return information for. You can specify the group name, the ARN, or the group ID as the GroupIdentifier .

--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. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

See ‘aws help’ for descriptions of global parameters.

Output

Group -> (structure)

A structure that contains information about the group.

Id -> (string)

The unique ID of the group.

Name -> (string)

The name of the group.

Arn -> (string)

The ARN of the group.

Tags -> (map)

The list of key-value pairs that are associated with the canary.

key -> (string)

value -> (string)

CreatedTime -> (timestamp)

The date and time that the group was created.

LastModifiedTime -> (timestamp)

The date and time that the group was most recently updated.