Skip to content

Client#

Mypy_boto3_builder Index / Mypy Boto3 Builder / Structures / Client

Auto-generated documentation for mypy_boto3_builder.structures.client module.

Client#

Show source in client.py:21

Service Client.

Signature#

class Client(ClassRecord):
    def __init__(
        self, name: str, service_name: ServiceName, boto3_client: BaseClient
    ) -> None: ...

See also#

Client().hash#

Show source in client.py:55

Calculate hash from client service name.

Signature#

def __hash__(self) -> int: ...

Client().alias_name#

Show source in client.py:61

Class alias name for safe import.

Signature#

@property
def alias_name(self) -> str: ...

Show source in client.py:75

List to boto3 docs page.

Signature#

@property
def boto3_doc_link(self) -> str: ...

Client().get_all_names#

Show source in client.py:82

Get a list of names for __all__ statement.

Signature#

def get_all_names(self) -> list[str]: ...

Client.get_class_name#

Show source in client.py:68

Get class name for ServiceName.

Signature#

@staticmethod
def get_class_name(service_name: ServiceName) -> str: ...

See also#

Client().get_example_method#

Show source in client.py:124

Get a nice method with return TypedDict for documentation.

Signature#

def get_example_method(self) -> Method | None: ...

Client().get_exceptions_property#

Show source in client.py:97

Generate Client exceptions property.

Signature#

def get_exceptions_property(self) -> Method: ...

See also#

Client().get_required_import_records#

Show source in client.py:116

Extract import records from required type annotations.

Signature#

def get_required_import_records(self) -> set[ImportRecord]: ...

See also#

Client().own_methods#

Show source in client.py:88

Get a list of auto-generated methods.

Signature#

@property
def own_methods(self) -> Iterator[Method]: ...

See also#