Skip to content

list_schemas

list_schemas(
    collaboration_identifier: CollaborationIdentifier,
    *,
    config_overrides: Optional[CleanRoomsClientConfig] = None,
    schema_type: Optional[SchemaType] = None,
    next_token: Optional[PaginationToken] = None,
    max_results: Optional[MaxResults] = None,
) -> ListSchemasOutput

Lists the schemas for relations within a collaboration.

Parameters:

  • collaboration_identifier (CollaborationIdentifier) –

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

  • schema_type (Optional[SchemaType], default: None ) –

    If present, filter schemas by schema type.

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

    The pagination token that's used to fetch the next set of results.

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

    The maximum number of results that are returned for an API request call. The service chooses a default number if you don't set one. The service might return a `nextToken` even if the `maxResults` value has not been met.

Raises:

Source code in docs_src/capo_cleanrooms/_services/clean_rooms.py
def list_schemas(
    self,
    collaboration_identifier: "capo_cleanrooms.types.collaboration_identifier.CollaborationIdentifier",
    *,
    config_overrides: Optional[CleanRoomsClientConfig] = None,
    schema_type: Optional["capo_cleanrooms.types.schema_type.SchemaType"] = None,
    next_token: Optional[
        "capo_cleanrooms.types.pagination_token.PaginationToken"
    ] = None,
    max_results: Optional["capo_cleanrooms.types.max_results.MaxResults"] = None,
) -> "capo_cleanrooms.types.list_schemas_output.ListSchemasOutput":
    """<p>Lists the schemas for relations 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>
        schema_type: <p>If present, filter schemas by schema type.</p>
        next_token: <p>The pagination token that's used to fetch the next set of results.</p>
        max_results: <p>The maximum number of results that are returned for an API request call. The service chooses a default number if you don't set one. The service might return a `nextToken` even if the `maxResults` value has not been met.</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.list_schemas_input.ListSchemasInput]",
    ) -> OperationResponse[
        "capo_cleanrooms.types.list_schemas_output.ListSchemasOutput"
    ]:
        import capo_cleanrooms._operations.aws_bastion_control_plane_service_lambda.list_schemas

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListSchemas")
    )
    input_: capo_cleanrooms.types.list_schemas_input.ListSchemasInput = {
        "collaboration_identifier": collaboration_identifier
    }
    if schema_type is not None:
        input_["schema_type"] = schema_type
    if next_token is not None:
        input_["next_token"] = next_token
    if max_results is not None:
        input_["max_results"] = max_results

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