Skip to content

GrantListEntry

Source code in docs_src/capo_kms/types/grant_list_entry.py
class GrantListEntry(TypedDict, closed=True):
    key_id: NotRequired["capo_kms.types.key_id_type.KeyIdType"]
    """<p>The unique identifier for the KMS key to which the grant applies.</p>"""
    grant_id: NotRequired["capo_kms.types.grant_id_type.GrantIdType"]
    """<p>The unique identifier for the grant.</p>"""
    name: NotRequired["capo_kms.types.grant_name_type.GrantNameType"]
    """<p>The friendly name that identifies the grant. If a name was provided in the <a>CreateGrant</a> request, that name is returned. Otherwise this value is null.</p>"""
    creation_date: NotRequired["capo_kms.types.date_type.DateType"]
    """<p>The date and time when the grant was created.</p>"""
    grantee_principal: NotRequired["capo_kms.types.principal_id_type.PrincipalIdType"]
    """<p>The identity that gets the permissions in the grant.</p> <p>When a grant is created with the <code>GranteePrincipal</code> field, the <code>ListGrants</code> response usually contains the user or role designated as the grantee principal in the grant. However, if the grantee principal is an Amazon Web Services service, the <code>GranteePrincipal</code> field contains an Amazon Web Services <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_principal.html#principal-services">service principal</a>, which might correspond to several different grantee principals, such as an IAM user, IAM role, or Amazon Web Services account.</p>"""
    retiring_principal: NotRequired["capo_kms.types.principal_id_type.PrincipalIdType"]
    """<p>The principal that can retire the grant.</p>"""
    issuing_account: NotRequired["capo_kms.types.principal_id_type.PrincipalIdType"]
    """<p>The Amazon Web Services account under which the grant was issued.</p>"""
    operations: NotRequired["capo_kms.types.grant_operation_list.GrantOperationList"]
    """<p>The list of operations permitted by the grant.</p>"""
    constraints: NotRequired["capo_kms.types.grant_constraints.GrantConstraints"]
    """<p>The constraints on the grant, such as encryption context pairs or a SourceArn, that restrict the subsequent operations the grant allows.</p>"""
    grantee_service_principal: NotRequired[
        "capo_kms.types.service_principal_type.ServicePrincipalType"
    ]
    """<p>The Amazon Web Services <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_principal.html#principal-services">service principal</a> that gets the permissions in the grant.</p>"""
    retiring_service_principal: NotRequired[
        "capo_kms.types.service_principal_type.ServicePrincipalType"
    ]
    """<p>The Amazon Web Services <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_principal.html#principal-services">service principal</a> that can retire the grant.</p>"""

constraints instance-attribute

constraints: NotRequired[GrantConstraints]

The constraints on the grant, such as encryption context pairs or a SourceArn, that restrict the subsequent operations the grant allows.

creation_date instance-attribute

creation_date: NotRequired[DateType]

The date and time when the grant was created.

grant_id instance-attribute

grant_id: NotRequired[GrantIdType]

The unique identifier for the grant.

grantee_principal instance-attribute

grantee_principal: NotRequired[PrincipalIdType]

The identity that gets the permissions in the grant.

When a grant is created with the GranteePrincipal field, the ListGrants response usually contains the user or role designated as the grantee principal in the grant. However, if the grantee principal is an Amazon Web Services service, the GranteePrincipal field contains an Amazon Web Services service principal, which might correspond to several different grantee principals, such as an IAM user, IAM role, or Amazon Web Services account.

grantee_service_principal instance-attribute

grantee_service_principal: NotRequired[ServicePrincipalType]

The Amazon Web Services service principal that gets the permissions in the grant.

issuing_account instance-attribute

issuing_account: NotRequired[PrincipalIdType]

The Amazon Web Services account under which the grant was issued.

key_id instance-attribute

key_id: NotRequired[KeyIdType]

The unique identifier for the KMS key to which the grant applies.

name instance-attribute

name: NotRequired[GrantNameType]

The friendly name that identifies the grant. If a name was provided in the CreateGrant request, that name is returned. Otherwise this value is null.

operations instance-attribute

operations: NotRequired[GrantOperationList]

The list of operations permitted by the grant.

retiring_principal instance-attribute

retiring_principal: NotRequired[PrincipalIdType]

The principal that can retire the grant.

retiring_service_principal instance-attribute

retiring_service_principal: NotRequired[ServicePrincipalType]

The Amazon Web Services service principal that can retire the grant.