search_provisioned_products ¶

def search_provisioned_products(
    self,
    *,
    config_overrides: Optional[ServiceCatalogClientConfig] = None,
    accept_language: Optional[
        "capo_service_catalog.types.accept_language.AcceptLanguage"
    ] = None,
    access_level_filter: Optional[
        "capo_service_catalog.types.access_level_filter.AccessLevelFilter"
    ] = None,
    filters: Optional[
        "capo_service_catalog.types.provisioned_product_filters.ProvisionedProductFilters"
    ] = None,
    sort_by: Optional["capo_service_catalog.types.sort_field.SortField"] = None,
    sort_order: Optional["capo_service_catalog.types.sort_order.SortOrder"] = None,
    page_size: Optional[
        "capo_service_catalog.types.search_provisioned_products_page_size.SearchProvisionedProductsPageSize"
    ] = None,
    page_token: Optional["capo_service_catalog.types.page_token.PageToken"] = None,
) -> "capo_service_catalog.types.search_provisioned_products_output.SearchProvisionedProductsOutput":
    """<p>Gets information about the provisioned products that meet the specified criteria.</p>

    Args:
        accept_language: <p>The language code.</p> <ul> <li> <p> <code>jp</code> - Japanese</p> </li> <li> <p> <code>zh</code> - Chinese</p> </li> </ul>
        access_level_filter: <p>The access level to use to obtain results. The default is <code>Account</code>.</p>
        filters: <p>The search filters.</p> <p>When the key is <code>SearchQuery</code>, the searchable fields are <code>arn</code>, <code>createdTime</code>, <code>id</code>, <code>lastRecordId</code>, <code>idempotencyToken</code>, <code>name</code>, <code>physicalId</code>, <code>productId</code>, <code>provisioningArtifactId</code>, <code>type</code>, <code>status</code>, <code>tags</code>, <code>userArn</code>, <code>userArnSession</code>, <code>lastProvisioningRecordId</code>, <code>lastSuccessfulProvisioningRecordId</code>, <code>productName</code>, and <code>provisioningArtifactName</code>.</p> <p>Example: <code>"SearchQuery":["status:AVAILABLE"]</code> </p>
        sort_by: <p>The sort field. If no value is specified, the results are not sorted. The valid values are <code>arn</code>, <code>id</code>, <code>name</code>, and <code>lastRecordId</code>.</p>
        sort_order: <p>The sort order. If no value is specified, the results are not sorted.</p>
        page_size: <p>The maximum number of items to return with this call.</p>
        page_token: <p>The page token for the next set of results. To retrieve the first set of results, use null.</p>

    Raises:
        capo_service_catalog.errors.invalid_parameters_exception.InvalidParametersException: <p>One or more parameters provided to the operation are not valid.</p>
        capo_service_catalog.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_service_catalog.types.search_provisioned_products_input.SearchProvisionedProductsInput]",
    ) -> OperationResponse[
        "capo_service_catalog.types.search_provisioned_products_output.SearchProvisionedProductsOutput"
    ]:
        import capo_service_catalog._operations.aws242_service_catalog_service.search_provisioned_products

        output, http_response = (
            capo_service_catalog._operations.aws242_service_catalog_service.search_provisioned_products.search_provisioned_products(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("SearchProvisionedProducts")
    )
    input_: capo_service_catalog.types.search_provisioned_products_input.SearchProvisionedProductsInput = {}
    if accept_language is not None:
        input_["accept_language"] = accept_language
    if access_level_filter is not None:
        input_["access_level_filter"] = access_level_filter
    if filters is not None:
        input_["filters"] = filters
    if sort_by is not None:
        input_["sort_by"] = sort_by
    if sort_order is not None:
        input_["sort_order"] = sort_order
    if page_size is not None:
        input_["page_size"] = page_size
    if page_token is not None:
        input_["page_token"] = page_token

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