Skip to content

PolicyVersion

Source code in docs_src/capo_iam/types/policy_version.py
class PolicyVersion(TypedDict, closed=True):
    document: NotRequired["capo_iam.types.policy_document_type.policyDocumentType"]
    """<p>The policy document.</p> <p>The policy document is returned in the response to the <a href="https://docs.aws.amazon.com/IAM/latest/APIReference/API_GetPolicyVersion.html">GetPolicyVersion</a> and <a href="https://docs.aws.amazon.com/IAM/latest/APIReference/API_GetAccountAuthorizationDetails.html">GetAccountAuthorizationDetails</a> operations. It is not returned in the response to the <a href="https://docs.aws.amazon.com/IAM/latest/APIReference/API_CreatePolicyVersion.html">CreatePolicyVersion</a> or <a href="https://docs.aws.amazon.com/IAM/latest/APIReference/API_ListPolicyVersions.html">ListPolicyVersions</a> operations. </p> <p>The policy document returned in this structure is URL-encoded compliant with <a href="https://tools.ietf.org/html/rfc3986">RFC 3986</a>. 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 <code>decode</code> method of the <code>java.net.URLDecoder</code> utility class in the Java SDK. Other languages and SDKs provide similar functionality.</p>"""
    version_id: NotRequired["capo_iam.types.policy_version_id_type.policyVersionIdType"]
    """<p>The identifier for the policy version.</p> <p>Policy version identifiers always begin with <code>v</code> (always lowercase). When a policy is created, the first policy version is <code>v1</code>. </p>"""
    is_default_version: "capo_iam.types.boolean_type.booleanType"
    """<p>Specifies whether the policy version is set as the policy's default version.</p>"""
    create_date: NotRequired["capo_iam.types.date_type.dateType"]
    """<p>The date and time, in <a href="http://www.iso.org/iso/iso8601">ISO 8601 date-time format</a>, when the policy version was created.</p>"""

create_date instance-attribute

create_date: NotRequired[dateType]

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

document instance-attribute

document: NotRequired[policyDocumentType]

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.

is_default_version instance-attribute

is_default_version: booleanType

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

version_id instance-attribute

version_id: NotRequired[policyVersionIdType]

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.