describe_entity ¶

def describe_entity(
    self,
    connection_name: "capo_glue.types.name_string.NameString",
    entity_name: "capo_glue.types.entity_name.EntityName",
    *,
    config_overrides: Optional[GlueClientConfig] = None,
    catalog_id: Optional[
        "capo_glue.types.catalog_id_string.CatalogIdString"
    ] = None,
    next_token: Optional["capo_glue.types.next_token.NextToken"] = None,
    data_store_api_version: Optional[
        "capo_glue.types.api_version.ApiVersion"
    ] = None,
) -> "capo_glue.types.describe_entity_response.DescribeEntityResponse":
    """<p>Provides details regarding the entity used with the connection type, with a description of the data model for each field in the selected entity.</p> <p> The response includes all the fields which make up the entity.</p>

    Args:
        connection_name: <p>The name of the connection that contains the connection type credentials.</p>
        catalog_id: <p>The catalog ID of the catalog that contains the connection. This can be null, By default, the Amazon Web Services Account ID is the catalog ID.</p>
        entity_name: <p>The name of the entity that you want to describe from the connection type.</p>
        next_token: <p>A continuation token, included if this is a continuation call.</p>
        data_store_api_version: <p>The version of the API used for the data store.</p>

    Raises:
        capo_glue.errors.access_denied_exception.AccessDeniedException: <p>Access to a resource was denied.</p>
        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.glue_encryption_exception.GlueEncryptionException: <p>An encryption operation failed.</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.validation_exception.ValidationException: <p>A value could not be validated.</p>
        capo_glue.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_glue.types.describe_entity_request.DescribeEntityRequest]",
    ) -> OperationResponse[
        "capo_glue.types.describe_entity_response.DescribeEntityResponse"
    ]:
        import capo_glue._operations.aws_glue.describe_entity

        output, http_response = (
            capo_glue._operations.aws_glue.describe_entity.describe_entity(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeEntity")
    )
    input_: capo_glue.types.describe_entity_request.DescribeEntityRequest = {
        "connection_name": connection_name,
        "entity_name": entity_name,
    }
    if catalog_id is not None:
        input_["catalog_id"] = catalog_id
    if next_token is not None:
        input_["next_token"] = next_token
    if data_store_api_version is not None:
        input_["data_store_api_version"] = data_store_api_version

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