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 . workmail ]

create-impersonation-role

Description

Creates an impersonation role for the given WorkMail organization.

Idempotency ensures that an API request completes no more than one time. With an idempotent request, if the original request completes successfully, any subsequent retries also complete successfully without performing any further actions.

See also: AWS API Documentation

Synopsis

  create-impersonation-role
[--client-token <value>]
--organization-id <value>
--name <value>
--type <value>
[--description <value>]
--rules <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]

Options

--client-token (string)

The idempotency token for the client request.

--organization-id (string)

The WorkMail organization to create the new impersonation role within.

--name (string)

The name of the new impersonation role.

--type (string)

The impersonation role's type. The available impersonation role types are READ_ONLY or FULL_ACCESS .

Possible values:

• FULL_ACCESS
• READ_ONLY

--description (string)

The description of the new impersonation role.

--rules (list)

The list of rules for the impersonation role.

(structure)

The rules for the given impersonation role.

ImpersonationRuleId -> (string)

The identifier of the rule.

Name -> (string)

The rule name.

Description -> (string)

The rule description.

Effect -> (string)

The effect of the rule when it matches the input. Allowed effect values are ALLOW or DENY .

TargetUsers -> (list)

A list of user IDs that match the rule.

(string)

NotTargetUsers -> (list)

A list of user IDs that don't match the rule.

(string)

Shorthand Syntax:

ImpersonationRuleId=string,Name=string,Description=string,Effect=string,TargetUsers=string,string,NotTargetUsers=string,string ...

JSON Syntax:

[
  {
    "ImpersonationRuleId": "string",
    "Name": "string",
    "Description": "string",
    "Effect": "ALLOW"|"DENY",
    "TargetUsers": ["string", ...],
    "NotTargetUsers": ["string", ...]
  }
  ...
]

--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.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination.

--output (string)

The formatting style for command output.

• json
• text
• table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

• on
• off
• auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

Output

ImpersonationRoleId -> (string)

The new impersonation role ID.