searcher_metadata#

See SearcherMetadata.

class aws_resource_search.searcher_metadata.SearcherMetadata(id: str, desc: str, ngram: str, module: Optional[str] = None, klass: Optional[str] = None, var: Optional[str] = None)[source]#

This class is a data container for the metadata of a BaseSearcher`. It describes the searcher’s ID, description, and the path to the corresponding searcher module. It doesn’t contain any data about the searcher’s logic.

This class is the data model for the aws_resource_search/searchers.json

This class is used heavily in the code generation process.

See also

What is Searcher

Example:

SearcherMetadata(
    id="s3-bucket",
    desc="A bucket is a container for objects.",
    klass="S3BucketSearcher",
    module="s3",
    ngram="simple storage service",
    var="s3_bucket_searcher"
)
Parameters:

  • id – the maintainer defined unique identifier of the resource type, using hyphen-case.

  • desc – the maintainer defined description for the specific resource type.

  • ngram – ngram search string for the resource type.

  • module – the path to the searcher module, for example, /path/to/aws_resource_search/res/awslambda.py (aws_resource_search.res.awslambda)

  • klass – the class name in the searcher module, for example LambdaFunction

  • var – the variable name of the searcher class instance of the searcher module, for example lambda_function_searcher.

property id_snake: str#

Example:

"s3_bucket"
property id_slug: str#

Example:

"s3-bucket"