search ¶

def search(
    self,
    domain_identifier: "capo_datazone.types.domain_id.DomainId",
    search_scope: "capo_datazone.types.inventory_search_scope.InventorySearchScope",
    *,
    config_overrides: Optional[DataZoneClientConfig] = None,
    owning_project_identifier: Optional[
        "capo_datazone.types.project_id.ProjectId"
    ] = None,
    max_results: Optional["capo_datazone.types.max_results.MaxResults"] = None,
    next_token: Optional[
        "capo_datazone.types.pagination_token.PaginationToken"
    ] = None,
    search_text: Optional["capo_datazone.types.search_text.SearchText"] = None,
    search_in: Optional["capo_datazone.types.search_in_list.SearchInList"] = None,
    filters: Optional["capo_datazone.types.filter_clause.FilterClause"] = None,
    sort: Optional["capo_datazone.types.search_sort.SearchSort"] = None,
    additional_attributes: Optional[
        "capo_datazone.types.search_output_additional_attributes.SearchOutputAdditionalAttributes"
    ] = None,
) -> "capo_datazone.types.search_output.SearchOutput":
    """<p>Searches for assets in Amazon DataZone.</p> <p>Search in Amazon DataZone is a powerful capability that enables users to discover and explore data assets, glossary terms, and data products across their organization. It provides both basic and advanced search functionality, allowing users to find resources based on names, descriptions, metadata, and other attributes. Search can be scoped to specific types of resources (like assets, glossary terms, or data products) and can be filtered using various criteria such as creation date, owner, or status. The search functionality is essential for making the wealth of data resources in an organization discoverable and usable, helping users find the right data for their needs quickly and efficiently.</p> <p>Many search commands in Amazon DataZone are paginated, including <code>search</code> and <code>search-types</code>. When the result set is large, Amazon DataZone returns a <code>nextToken</code> in the response. This token can be used to retrieve the next page of results. </p> <p>Prerequisites:</p> <ul> <li> <p>The --domain-identifier must refer to an existing Amazon DataZone domain. </p> </li> <li> <p>--search-scope must be one of: ASSET, GLOSSARY_TERM, DATA_PRODUCT, or GLOSSARY.</p> </li> <li> <p>The user must have search permissions in the specified domain.</p> </li> <li> <p>If using --filters, ensure that the JSON is well-formed and that each filter includes valid attribute and value keys. </p> </li> <li> <p>For paginated results, be prepared to use --next-token to fetch additional pages.</p> </li> </ul> <p>To run a standard free-text search, the <code>searchText</code> parameter must be supplied. By default, all searchable fields are indexed for semantic search and will return semantic matches for SearchListings queries. To prevent semantic search indexing for a custom form attribute, see the <a href="https://docs.aws.amazon.com/datazone/latest/APIReference/API_CreateFormType.html">CreateFormType API documentation</a>. To run a lexical search query, enclose the query with double quotes (""). This will disable semantic search even for fields that have semantic search enabled and will only return results that contain the keywords wrapped by double quotes (order of tokens in the query is not enforced). Free-text search is supported for all attributes annotated with @amazon.datazone#searchable.</p> <p>To run a filtered search, provide filter clause using the <code>filters</code> parameter. To filter on glossary terms, use the special attribute <code>__DataZoneGlossaryTerms</code>. To filter on an indexed numeric attribute (i.e., a numeric attribute annotated with <code>@amazon.datazone#sortable</code>), provide a filter using the <code>intValue</code> parameter. The filters parameter can also be used to run more advanced free-text searches that target specific attributes (attributes must be annotated with <code>@amazon.datazone#searchable</code> for free-text search). Create/update timestamp filtering is supported using the special <code>creationTime</code>/<code>lastUpdatedTime</code> attributes. Filter types can be mixed and matched to power complex queries.</p> <p> To find out whether an attribute has been annotated and indexed for a given search type, use the GetFormType API to retrieve the form containing the attribute.</p>

    Args:
        domain_identifier: <p>The identifier of the Amazon DataZone domain.</p>
        owning_project_identifier: <p>The identifier of the owning project specified for the search.</p>
        max_results: <p>The maximum number of results to return in a single call to <code>Search</code>. When the number of results to be listed is greater than the value of <code>MaxResults</code>, the response contains a <code>NextToken</code> value that you can use in a subsequent call to <code>Search</code> to list the next set of results.</p>
        next_token: <p>When the number of results is greater than the default value for the <code>MaxResults</code> parameter, or if you explicitly specify a value for <code>MaxResults</code> that is less than the number of results, the response includes a pagination token named <code>NextToken</code>. You can specify this <code>NextToken</code> value in a subsequent call to <code>Search</code> to list the next set of results.</p>
        search_scope: <p>The scope of the search.</p>
        search_text: <p>Specifies the text for which to search.</p>
        search_in: <p>The details of the search.</p>
        filters: <p>Specifies the search filters.</p>
        sort: <p>Specifies the way in which the search results are to be sorted.</p>
        additional_attributes: <p>Specifies additional attributes for the <code>Search</code> action.</p>

    Raises:
        capo_datazone.errors.access_denied_exception.AccessDeniedException: <p>You do not have sufficient access to perform this action.</p>
        capo_datazone.errors.throttling_exception.ThrottlingException: <p>The request was denied due to request throttling.</p>
        capo_datazone.errors.unauthorized_exception.UnauthorizedException: <p>You do not have permission to perform this action.</p>
        capo_datazone.errors.internal_server_exception.InternalServerException: <p>The request has failed because of an unknown error, exception or failure.</p>
        capo_datazone.errors.validation_exception.ValidationException: <p>The input fails to satisfy the constraints specified by the Amazon Web Services service.</p>
        capo_datazone.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_datazone.types.search_input.SearchInput]",
    ) -> OperationResponse["capo_datazone.types.search_output.SearchOutput"]:
        import capo_datazone._operations.data_zone.search

        output, http_response = capo_datazone._operations.data_zone.search.search(
            req.options, req.input
        )
        return OperationResponse(output=output, response=http_response)

    def _redact_output(
        output: "capo_datazone.types.search_output.SearchOutput",
    ) -> dict[str, Any]:
        import capo_datazone.types.search_output

        return capo_datazone.types.search_output.redact_sensitive(output)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("Search", redact_output=_redact_output)
    )
    input_: capo_datazone.types.search_input.SearchInput = {
        "domain_identifier": domain_identifier,
        "search_scope": search_scope,
    }
    if owning_project_identifier is not None:
        input_["owning_project_identifier"] = owning_project_identifier
    if max_results is not None:
        input_["max_results"] = max_results
    if next_token is not None:
        input_["next_token"] = next_token
    if search_text is not None:
        input_["search_text"] = search_text
    if search_in is not None:
        input_["search_in"] = search_in
    if filters is not None:
        input_["filters"] = filters
    if sort is not None:
        input_["sort"] = sort
    if additional_attributes is not None:
        input_["additional_attributes"] = additional_attributes

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