create-group¶
Description¶
Creates a group that can be used in Amazon WorkMail by calling the RegisterToWorkMail operation.
See also: AWS API Documentation
See ‘aws help’ for descriptions of global parameters.
Synopsis¶
create-group
--organization-id <value>
--name <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]
Options¶
--organization-id (string)
The organization under which the group is to be created.
--name (string)
The name of the group.
--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.
--cli-auto-prompt (boolean)
Automatically prompt for CLI input parameters.
See ‘aws help’ for descriptions of global parameters.
Examples¶
To create a new group
The following create-group command creates a new group for the specified organization.
aws workmail create-group \
--organization-id m-d281d0a2fd824be5b6cd3d3ce909fd27 \
--name exampleGroup1
Output:
{
"GroupId": "S-1-1-11-1122222222-2222233333-3333334444-4444"
}