Skip to content

get_schema

get_schema(
    collaboration_identifier: CollaborationIdentifier,
    name: TableAlias,
    *,
    config_overrides: Optional[CleanRoomsClientConfig] = None,
) -> GetSchemaOutput

Retrieves the schema for a relation within a collaboration.

Parameters:

  • collaboration_identifier (CollaborationIdentifier) –

    A unique identifier for the collaboration that the schema belongs to. Currently accepts a collaboration ID.

  • name (TableAlias) –

    The name of the relation to retrieve the schema for.

Raises:

Source code in docs_src/capo_cleanrooms/_services/clean_rooms.py
def get_schema(
    self,
    collaboration_identifier: "capo_cleanrooms.types.collaboration_identifier.CollaborationIdentifier",
    name: "capo_cleanrooms.types.table_alias.TableAlias",
    *,
    config_overrides: Optional[CleanRoomsClientConfig] = None,
) -> "capo_cleanrooms.types.get_schema_output.GetSchemaOutput":
    """<p>Retrieves the schema for a relation within a collaboration.</p>

    Args:
        collaboration_identifier: <p>A unique identifier for the collaboration that the schema belongs to. Currently accepts a collaboration ID.</p>
        name: <p>The name of the relation to retrieve the schema for.</p>

    Raises:
        capo_cleanrooms.errors.access_denied_exception.AccessDeniedException: <p>Caller does not have sufficient access to perform this action.</p>
        capo_cleanrooms.errors.internal_server_exception.InternalServerException: <p>Unexpected error during processing of request.</p>
        capo_cleanrooms.errors.resource_not_found_exception.ResourceNotFoundException: <p>Request references a resource which does not exist.</p>
        capo_cleanrooms.errors.throttling_exception.ThrottlingException: <p>Request was denied due to request throttling.</p>
        capo_cleanrooms.errors.validation_exception.ValidationException: <p>The input fails to satisfy the specified constraints.</p>
        capo_cleanrooms.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_cleanrooms.types.get_schema_input.GetSchemaInput]",
    ) -> OperationResponse[
        "capo_cleanrooms.types.get_schema_output.GetSchemaOutput"
    ]:
        import capo_cleanrooms._operations.aws_bastion_control_plane_service_lambda.get_schema

        output, http_response = (
            capo_cleanrooms._operations.aws_bastion_control_plane_service_lambda.get_schema.get_schema(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetSchema")
    )
    input_: capo_cleanrooms.types.get_schema_input.GetSchemaInput = {
        "collaboration_identifier": collaboration_identifier,
        "name": name,
    }

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