Skip to content

batch_grant_permissions

batch_grant_permissions(
    entries: BatchPermissionsRequestEntryList,
    *,
    config_overrides: Optional[LakeFormationClientConfig] = None,
    catalog_id: Optional[CatalogIdString] = None,
) -> BatchGrantPermissionsResponse

Batch operation to grant permissions to the principal.

Parameters:

  • catalog_id (Optional[CatalogIdString], default: None ) –

    The identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your Lake Formation environment.

  • entries (BatchPermissionsRequestEntryList) –

    A list of up to 20 entries for resource permissions to be granted by batch operation to the principal.

Raises:

Source code in docs_src/capo_lakeformation/_services/lake_formation.py
def batch_grant_permissions(
    self,
    entries: "capo_lakeformation.types.batch_permissions_request_entry_list.BatchPermissionsRequestEntryList",
    *,
    config_overrides: Optional[LakeFormationClientConfig] = None,
    catalog_id: Optional[
        "capo_lakeformation.types.catalog_id_string.CatalogIdString"
    ] = None,
) -> "capo_lakeformation.types.batch_grant_permissions_response.BatchGrantPermissionsResponse":
    """<p>Batch operation to grant permissions to the principal.</p>

    Args:
        catalog_id: <p>The identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your Lake Formation environment. </p>
        entries: <p>A list of up to 20 entries for resource permissions to be granted by batch operation to the principal.</p>

    Raises:
        capo_lakeformation.errors.invalid_input_exception.InvalidInputException: <p>The input provided was not valid.</p>
        capo_lakeformation.errors.operation_timeout_exception.OperationTimeoutException: <p>The operation timed out.</p>
        capo_lakeformation.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_lakeformation.types.batch_grant_permissions_request.BatchGrantPermissionsRequest]",
    ) -> OperationResponse[
        "capo_lakeformation.types.batch_grant_permissions_response.BatchGrantPermissionsResponse"
    ]:
        import capo_lakeformation._operations.aws_lake_formation.batch_grant_permissions

        output, http_response = (
            capo_lakeformation._operations.aws_lake_formation.batch_grant_permissions.batch_grant_permissions(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("BatchGrantPermissions")
    )
    input_: capo_lakeformation.types.batch_grant_permissions_request.BatchGrantPermissionsRequest = {
        "entries": entries
    }
    if catalog_id is not None:
        input_["catalog_id"] = catalog_id

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