IAM / Client / get_policy_version

get_policy_version#

IAM.Client.get_policy_version(**kwargs)#

Retrieves information about the specified version of the specified managed policy, including the policy document.

Note

Policies returned by this operation are URL-encoded compliant with RFC 3986. You can use a URL decoding method to convert the policy back to plain JSON text. For example, if you use Java, you can use the decode method of the java.net.URLDecoder utility class in the Java SDK. Other languages and SDKs provide similar functionality.

To list the available versions for a policy, use ListPolicyVersions.

This operation retrieves information about managed policies. To retrieve information about an inline policy that is embedded in a user, group, or role, use GetUserPolicy, GetGroupPolicy, or GetRolePolicy.

For more information about the types of policies, see Managed policies and inline policies in the IAM User Guide.

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

See also: AWS API Documentation

Request Syntax

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

  • PolicyArn (string) –

    [REQUIRED]

    The Amazon Resource Name (ARN) of the managed policy that you want information about.

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

  • VersionId (string) –

    [REQUIRED]

    Identifies the policy version to retrieve.

    This parameter allows (through its regex pattern) a string of characters that consists of the lowercase letter ‘v’ followed by one or two digits, and optionally followed by a period ‘.’ and a string of letters and digits.

Return type:

dict

Returns:

Response Syntax

{
    'PolicyVersion': {
        'Document': 'string',
        'VersionId': 'string',
        'IsDefaultVersion': True|False,
        'CreateDate': datetime(2015, 1, 1)
    }
}

Response Structure

  • (dict) –

    Contains the response to a successful GetPolicyVersion request.

    • PolicyVersion (dict) –

      A structure containing details about the policy version.

      • Document (string) –

        The policy document.

        The policy document is returned in the response to the GetPolicyVersion and GetAccountAuthorizationDetails operations. It is not returned in the response to the CreatePolicyVersion or ListPolicyVersions operations.

        The policy document returned in this structure is URL-encoded compliant with RFC 3986. You can use a URL decoding method to convert the policy back to plain JSON text. For example, if you use Java, you can use the decode method of the java.net.URLDecoder utility class in the Java SDK. Other languages and SDKs provide similar functionality.

      • VersionId (string) –

        The identifier for the policy version.

        Policy version identifiers always begin with v (always lowercase). When a policy is created, the first policy version is v1.

      • IsDefaultVersion (boolean) –

        Specifies whether the policy version is set as the policy’s default version.

      • CreateDate (datetime) –

        The date and time, in ISO 8601 date-time format, when the policy version was created.

Exceptions

  • IAM.Client.exceptions.NoSuchEntityException

  • IAM.Client.exceptions.InvalidInputException

  • IAM.Client.exceptions.ServiceFailureException