Skip to content

list_policy_grants

list_policy_grants(
    domain_identifier: DomainId,
    entity_type: TargetEntityType,
    entity_identifier: str,
    policy_type: ManagedPolicyType,
    *,
    config_overrides: Optional[DataZoneClientConfig] = None,
    max_results: Optional[MaxResultsForListDomains] = None,
    next_token: Optional[PaginationToken] = None,
) -> ListPolicyGrantsOutput

Lists policy grants.

Parameters:

  • domain_identifier (DomainId) –

    The ID of the domain where you want to list policy grants.

  • entity_type (TargetEntityType) –

    The type of entity for which you want to list policy grants.

  • entity_identifier (str) –

    The ID of the entity for which you want to list policy grants.

  • policy_type (ManagedPolicyType) –

    The type of policy that you want to list.

  • max_results (Optional[MaxResultsForListDomains], default: None ) –

    The maximum number of grants to return in a single call to ListPolicyGrants. When the number of grants to be listed is greater than the value of MaxResults, the response contains a NextToken value that you can use in a subsequent call to ListPolicyGrants to list the next set of grants.

  • next_token (Optional[PaginationToken], default: None ) –

    When the number of grants is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of grants, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListPolicyGrants to list the next set of grants.

Raises:

Source code in docs_src/capo_datazone/_services/data_zone.py
def list_policy_grants(
    self,
    domain_identifier: "capo_datazone.types.domain_id.DomainId",
    entity_type: "capo_datazone.types.target_entity_type.TargetEntityType",
    entity_identifier: str,
    policy_type: "capo_datazone.types.managed_policy_type.ManagedPolicyType",
    *,
    config_overrides: Optional[DataZoneClientConfig] = None,
    max_results: Optional[
        "capo_datazone.types.max_results_for_list_domains.MaxResultsForListDomains"
    ] = None,
    next_token: Optional[
        "capo_datazone.types.pagination_token.PaginationToken"
    ] = None,
) -> "capo_datazone.types.list_policy_grants_output.ListPolicyGrantsOutput":
    """<p>Lists policy grants.</p>

    Args:
        domain_identifier: <p>The ID of the domain where you want to list policy grants.</p>
        entity_type: <p>The type of entity for which you want to list policy grants.</p>
        entity_identifier: <p>The ID of the entity for which you want to list policy grants.</p>
        policy_type: <p>The type of policy that you want to list.</p>
        max_results: <p>The maximum number of grants to return in a single call to <code>ListPolicyGrants</code>. When the number of grants to be listed is greater than the value of <code>MaxResults</code>, the response contains a <code>NextToken</code> value that you can use in a subsequent call to <code>ListPolicyGrants</code> to list the next set of grants.</p>
        next_token: <p>When the number of grants is greater than the default value for the <code>MaxResults</code> parameter, or if you explicitly specify a value for <code>MaxResults</code> that is less than the number of grants, the response includes a pagination token named <code>NextToken</code>. You can specify this <code>NextToken</code> value in a subsequent call to <code>ListPolicyGrants</code> to list the next set of grants.</p>

    Raises:
        capo_datazone.errors.access_denied_exception.AccessDeniedException: <p>You do not have sufficient access to perform this action.</p>
        capo_datazone.errors.throttling_exception.ThrottlingException: <p>The request was denied due to request throttling.</p>
        capo_datazone.errors.unauthorized_exception.UnauthorizedException: <p>You do not have permission to perform this action.</p>
        capo_datazone.errors.internal_server_exception.InternalServerException: <p>The request has failed because of an unknown error, exception or failure.</p>
        capo_datazone.errors.validation_exception.ValidationException: <p>The input fails to satisfy the constraints specified by the Amazon Web Services service.</p>
        capo_datazone.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_datazone.types.list_policy_grants_input.ListPolicyGrantsInput]",
    ) -> OperationResponse[
        "capo_datazone.types.list_policy_grants_output.ListPolicyGrantsOutput"
    ]:
        import capo_datazone._operations.data_zone.list_policy_grants

        output, http_response = (
            capo_datazone._operations.data_zone.list_policy_grants.list_policy_grants(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListPolicyGrants")
    )
    input_: capo_datazone.types.list_policy_grants_input.ListPolicyGrantsInput = {
        "domain_identifier": domain_identifier,
        "entity_type": entity_type,
        "entity_identifier": entity_identifier,
        "policy_type": policy_type,
    }
    if max_results is not None:
        input_["max_results"] = max_results
    if next_token is not None:
        input_["next_token"] = next_token

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output