IAM / Client / update_assume_role_policy

update_assume_role_policy#

IAM.Client.update_assume_role_policy(**kwargs)#

Updates the policy that grants an IAM entity permission to assume a role. This is typically referred to as the “role trust policy”. For more information about roles, see Using roles to delegate permissions and federate identities.

See also: AWS API Documentation

Request Syntax

response = client.update_assume_role_policy(
    RoleName='string',
    PolicyDocument='string'
)
Parameters:

  • RoleName (string) –

    [REQUIRED]

    The name of the role to update with the new policy.

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

  • PolicyDocument (string) –

    [REQUIRED]

    The policy that grants an entity permission to assume the role.

    You must provide policies in JSON format in IAM. However, for CloudFormation templates formatted in YAML, you can provide the policy in JSON or YAML format. CloudFormation always converts a YAML policy to JSON format before submitting it to IAM.

    The regex pattern used to validate this parameter is a string of characters consisting of the following:

    • Any printable ASCII character ranging from the space character ( \u0020) through the end of the ASCII character range

    • The printable characters in the Basic Latin and Latin-1 Supplement character set (through \u00FF)

    • The special characters tab ( \u0009), line feed ( \u000A), and carriage return ( \u000D)

Returns:

None

Exceptions

  • IAM.Client.exceptions.NoSuchEntityException

  • IAM.Client.exceptions.MalformedPolicyDocumentException

  • IAM.Client.exceptions.LimitExceededException

  • IAM.Client.exceptions.UnmodifiableEntityException

  • IAM.Client.exceptions.ServiceFailureException

Examples

The following command updates the role trust policy for the role named Test-Role:

response = client.update_assume_role_policy(
    PolicyDocument='{"Version":"2012-10-17","Statement":[{"Effect":"Allow","Principal":{"Service":["ec2.amazonaws.com"]},"Action":["sts:AssumeRole"]}]}',
    RoleName='S3AccessForEC2Instances',
)

print(response)

Expected Output:

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