ServiceName#
Mypy_boto3_builder Index / Mypy Boto3 Builder / ServiceName
Auto-generated documentation for mypy_boto3_builder.service_name module.
ServiceName#
Show source in service_name.py:15
Description for boto3 service.
Signature#
class ServiceName:
def __init__(
self, name: str, class_name: str, override_boto3_name: str = ""
) -> None: ...
ServiceName().boto3_doc_link#
Show source in service_name.py:98
Link to boto3 docs.
Signature#
ServiceName().boto3_name#
Show source in service_name.py:61
Boto3 package name.
Signature#
ServiceName().extras_name#
Show source in service_name.py:79
Extras name for subpackage installation.
Signature#
ServiceName().get_boto3_doc_link#
Show source in service_name.py:108
Get link to boto3 docs with anchor.
Arguments#
parts
- Anchor parts
Signature#
ServiceName.get_md_doc_link#
Show source in service_name.py:117
Get link to MD docs with anchor.
Arguments#
file
- HTML file nameparts
- Anchor parts
Signature#
@staticmethod
def get_md_doc_link(
file: Literal[
"client", "service_resource", "waiters", "paginators", "type_defs", "literals"
],
*parts: str
) -> str: ...
ServiceName().import_name#
Show source in service_name.py:68
Safe mudule import name.
Signature#
ServiceName().is_conda_forge_available#
Show source in service_name.py:92
Whether service is available for conda-forge
.
Signature#
ServiceName().is_essential#
Show source in service_name.py:86
Whether service is included to boto3-stubs[essential]
.
Signature#
ServiceName().underscore_name#
Show source in service_name.py:54
Python-friendly service name.
Signature#
ServiceNameCatalog#
Show source in service_name.py:143
Finder for boto3 services by name.
Signature#
ServiceNameCatalog.add#
Show source in service_name.py:187
Add new ServiceName to catalog or modify existing one.
Returns#
New ServiceName or modified if it exists.