IAM / Client / untag_role

untag_role#

IAM.Client.untag_role(**kwargs)#

Removes the specified tags from the role. For more information about tagging, see Tagging IAM resources in the IAM User Guide.

See also: AWS API Documentation

Request Syntax

response = client.untag_role(
    RoleName='string',
    TagKeys=[
        'string',
    ]
)
Parameters:
  • RoleName (string) –

    [REQUIRED]

    The name of the IAM role from which you want to remove tags.

    This parameter accepts (through its regex pattern) a string of characters that consist of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

  • TagKeys (list) –

    [REQUIRED]

    A list of key names as a simple array of strings. The tags with matching keys are removed from the specified role.

    • (string) –

Returns:

None

Exceptions

  • IAM.Client.exceptions.NoSuchEntityException

  • IAM.Client.exceptions.ConcurrentModificationException

  • IAM.Client.exceptions.ServiceFailureException

Examples

The following example shows how to remove a tag with the key ‘Dept’ from a role named ‘taggedrole’.

response = client.untag_role(
    RoleName='taggedrole',
    TagKeys=[
        'Dept',
    ],
)

print(response)

Expected Output:

{
    'ResponseMetadata': {
        '...': '...',
    },
}