WorkMail / Client / update_impersonation_role

update_impersonation_role#

WorkMail.Client.update_impersonation_role(**kwargs)#

Updates an impersonation role for the given WorkMail organization.

See also: AWS API Documentation

Request Syntax

response = client.update_impersonation_role(
    OrganizationId='string',
    ImpersonationRoleId='string',
    Name='string',
    Type='FULL_ACCESS'|'READ_ONLY',
    Description='string',
    Rules=[
        {
            'ImpersonationRuleId': 'string',
            'Name': 'string',
            'Description': 'string',
            'Effect': 'ALLOW'|'DENY',
            'TargetUsers': [
                'string',
            ],
            'NotTargetUsers': [
                'string',
            ]
        },
    ]
)
Parameters:

  • OrganizationId (string) –

    [REQUIRED]

    The WorkMail organization that contains the impersonation role to update.

  • ImpersonationRoleId (string) –

    [REQUIRED]

    The ID of the impersonation role to update.

  • Name (string) –

    [REQUIRED]

    The updated impersonation role name.

  • Type (string) –

    [REQUIRED]

    The updated impersonation role type.

  • Description (string) – The updated impersonation role description.

  • Rules (list) –

    [REQUIRED]

    The updated list of rules.

    • (dict) –

      The rules for the given impersonation role.

      • ImpersonationRuleId (string) – [REQUIRED]

        The identifier of the rule.

      • Name (string) –

        The rule name.

      • Description (string) –

        The rule description.

      • Effect (string) – [REQUIRED]

        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) –

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

  • (dict) –

Exceptions

  • WorkMail.Client.exceptions.InvalidParameterException

  • WorkMail.Client.exceptions.OrganizationNotFoundException

  • WorkMail.Client.exceptions.OrganizationStateException

  • WorkMail.Client.exceptions.ResourceNotFoundException

  • WorkMail.Client.exceptions.EntityNotFoundException

  • WorkMail.Client.exceptions.EntityStateException

  • WorkMail.Client.exceptions.LimitExceededException