IAM / Client / set_default_policy_version

set_default_policy_version#

IAM.Client.set_default_policy_version(**kwargs)#

Sets the specified version of the specified policy as the policy’s default (operative) version.

This operation affects all users, groups, and roles that the policy is attached to. To list the users, groups, and roles that the policy is attached to, use ListEntitiesForPolicy.

For information about managed policies, see Managed policies and inline policies in the IAM User Guide.

See also: AWS API Documentation

Request Syntax

response = client.set_default_policy_version(
    PolicyArn='string',
    VersionId='string'
)
Parameters:

  • PolicyArn (string) –

    [REQUIRED]

    The Amazon Resource Name (ARN) of the IAM policy whose default version you want to set.

    For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

  • VersionId (string) –

    [REQUIRED]

    The version of the policy to set as the default (operative) version.

    For more information about managed policy versions, see Versioning for managed policies in the IAM User Guide.

Returns:

None

Exceptions

  • IAM.Client.exceptions.NoSuchEntityException

  • IAM.Client.exceptions.InvalidInputException

  • IAM.Client.exceptions.LimitExceededException

  • IAM.Client.exceptions.ServiceFailureException