Skip to content

ServiceResource#

Mypy_boto3_builder Index / Mypy Boto3 Builder / Structures / ServiceResource

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

ServiceResource#

Show source in service_resource.py:23

Service Resource.

Signature#

class ServiceResource(ClassRecord):
    def __init__(
        self,
        name: str,
        service_name: ServiceName,
        boto3_service_resource: Boto3ServiceResource,
    ): ...

See also#

ServiceResource().hash#

Show source in service_resource.py:44

Calculate hash value based on service name.

Signature#

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

ServiceResource().alias_name#

Show source in service_resource.py:50

Class alias name for safe import.

Signature#

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

Show source in service_resource.py:79

Link to boto3 docs.

Signature#

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

ServiceResource().get_all_names#

Show source in service_resource.py:97

Get names for __all__ statement.

Signature#

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

ServiceResource.get_class_name#

Show source in service_resource.py:57

Get class name for ServiceName.

Signature#

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

See also#

ServiceResource().get_collections#

Show source in service_resource.py:108

Get a list of Service Resource collections.

Signature#

def get_collections(self) -> list[Collection]: ...

See also#

ServiceResource().get_sub_resources#

Show source in service_resource.py:124

Get sub-resource in safe order.

Returns#

A list of sub resources.

Signature#

def get_sub_resources(self) -> list[Resource]: ...

See also#

ServiceResource().iterate_types#

Show source in service_resource.py:86

Iterate over type annotations for collections and sub-resources.

Signature#

def iterate_types(self) -> Iterator[FakeAnnotation]: ...

See also#