Skip to content

get_unfiltered_partition_metadata async

get_unfiltered_partition_metadata(
    catalog_id: CatalogIdString,
    database_name: NameString,
    table_name: NameString,
    partition_values: ValueStringList,
    supported_permission_types: PermissionTypeList,
    *,
    config_overrides: Optional[AsyncGlueClientConfig] = None,
    region: Optional[ValueString] = None,
    audit_context: Optional[AuditContext] = None,
    query_session_context: Optional[QuerySessionContext] = None,
) -> GetUnfilteredPartitionMetadataResponse

Retrieves partition metadata from the Data Catalog that contains unfiltered metadata.

For IAM authorization, the public IAM action associated with this API is glue:GetPartition.

Parameters:

  • region (Optional[ValueString], default: None ) –

    Specified only if the base tables belong to a different Amazon Web Services Region.

  • catalog_id (CatalogIdString) –

    The catalog ID where the partition resides.

  • database_name (NameString) –

    (Required) Specifies the name of a database that contains the partition.

  • table_name (NameString) –

    (Required) Specifies the name of a table that contains the partition.

  • partition_values (ValueStringList) –

    (Required) A list of partition key values.

  • audit_context (Optional[AuditContext], default: None ) –

    A structure containing Lake Formation audit context information.

  • supported_permission_types (PermissionTypeList) –

    (Required) A list of supported permission types.

  • query_session_context (Optional[QuerySessionContext], default: None ) –

    A structure used as a protocol between query engines and Lake Formation or Glue. Contains both a Lake Formation generated authorization identifier and information from the request's authorization context.

Raises:

Source code in docs_src/capo_glue/_services/async_glue.py
async def get_unfiltered_partition_metadata(
    self,
    catalog_id: "capo_glue.types.catalog_id_string.CatalogIdString",
    database_name: "capo_glue.types.name_string.NameString",
    table_name: "capo_glue.types.name_string.NameString",
    partition_values: "capo_glue.types.value_string_list.ValueStringList",
    supported_permission_types: "capo_glue.types.permission_type_list.PermissionTypeList",
    *,
    config_overrides: Optional[AsyncGlueClientConfig] = None,
    region: Optional["capo_glue.types.value_string.ValueString"] = None,
    audit_context: Optional["capo_glue.types.audit_context.AuditContext"] = None,
    query_session_context: Optional[
        "capo_glue.types.query_session_context.QuerySessionContext"
    ] = None,
) -> "capo_glue.types.get_unfiltered_partition_metadata_response.GetUnfilteredPartitionMetadataResponse":
    """<p>Retrieves partition metadata from the Data Catalog that contains unfiltered metadata.</p> <p>For IAM authorization, the public IAM action associated with this API is <code>glue:GetPartition</code>.</p>

    Args:
        region: <p>Specified only if the base tables belong to a different Amazon Web Services Region.</p>
        catalog_id: <p>The catalog ID where the partition resides.</p>
        database_name: <p>(Required) Specifies the name of a database that contains the partition.</p>
        table_name: <p>(Required) Specifies the name of a table that contains the partition.</p>
        partition_values: <p>(Required) A list of partition key values.</p>
        audit_context: <p>A structure containing Lake Formation audit context information.</p>
        supported_permission_types: <p>(Required) A list of supported permission types. </p>
        query_session_context: <p>A structure used as a protocol between query engines and Lake Formation or Glue. Contains both a Lake Formation generated authorization identifier and information from the request's authorization context.</p>

    Raises:
        capo_glue.errors.entity_not_found_exception.EntityNotFoundException: <p>A specified entity does not exist</p>
        capo_glue.errors.federation_source_exception.FederationSourceException: <p>A federation source failed.</p>
        capo_glue.errors.federation_source_retryable_exception.FederationSourceRetryableException: <p>A federation source failed, but the operation may be retried.</p>
        capo_glue.errors.glue_encryption_exception.GlueEncryptionException: <p>An encryption operation failed.</p>
        capo_glue.errors.internal_service_exception.InternalServiceException: <p>An internal service error occurred.</p>
        capo_glue.errors.invalid_input_exception.InvalidInputException: <p>The input provided was not valid.</p>
        capo_glue.errors.operation_timeout_exception.OperationTimeoutException: <p>The operation timed out.</p>
        capo_glue.errors.permission_type_mismatch_exception.PermissionTypeMismatchException: <p>The operation timed out.</p>
        capo_glue.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_glue.types.get_unfiltered_partition_metadata_request.GetUnfilteredPartitionMetadataRequest]",
    ) -> AsyncOperationResponse[
        "capo_glue.types.get_unfiltered_partition_metadata_response.GetUnfilteredPartitionMetadataResponse"
    ]:
        import capo_glue._operations.aws_glue.get_unfiltered_partition_metadata

        (
            output,
            http_response,
        ) = await capo_glue._operations.aws_glue.get_unfiltered_partition_metadata.async_get_unfiltered_partition_metadata(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetUnfilteredPartitionMetadata")
    )
    input_: capo_glue.types.get_unfiltered_partition_metadata_request.GetUnfilteredPartitionMetadataRequest = {
        "catalog_id": catalog_id,
        "database_name": database_name,
        "table_name": table_name,
        "partition_values": partition_values,
        "supported_permission_types": supported_permission_types,
    }
    if region is not None:
        input_["region"] = region
    if audit_context is not None:
        input_["audit_context"] = audit_context
    if query_session_context is not None:
        input_["query_session_context"] = query_session_context

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output