Skip to content

CodeCatalyst module

Index > CodeCatalyst

Auto-generated documentation for CodeCatalyst type annotations stubs module mypy-boto3-codecatalyst.

How to install

VSCode extension

Add AWS Boto3 extension to your VSCode and run AWS boto3: Quick Start command.

Click Modify and select boto3 common and CodeCatalyst.

From PyPI with pip

Install boto3-stubs for CodeCatalyst service.

# install with boto3 type annotations
python -m pip install 'boto3-stubs[codecatalyst]'


# Lite version does not provide session.client/resource overloads
# it is more RAM-friendly, but requires explicit type annotations
python -m pip install 'boto3-stubs-lite[codecatalyst]'


# standalone installation
python -m pip install mypy-boto3-codecatalyst

How to uninstall

python -m pip uninstall -y mypy-boto3-codecatalyst

Usage

Code samples can be found in Examples.

CodeCatalystClient

Type annotations and code completion for boto3.client("codecatalyst") as CodeCatalystClient boto3 documentation

Usage example
from boto3.session import Session

from mypy_boto3_codecatalyst.client import CodeCatalystClient

def get_client() -> CodeCatalystClient:
    return Session().client("codecatalyst")

Paginators

Type annotations and code completion for paginators from boto3.client("codecatalyst").get_paginator("...").

Usage example
from boto3.session import Session

from mypy_boto3_codecatalyst.paginator import ListAccessTokensPaginator

def get_list_access_tokens_paginator() -> ListAccessTokensPaginator:
    return Session().client("codecatalyst").get_paginator("list_access_tokens"))

Literals

Type annotations for literals used in methods and schemas.

Usage example
from mypy_boto3_codecatalyst.literals import ComparisonOperatorType

def get_value() -> ComparisonOperatorType:
    return "EQ"

Typed dictionaries

Type annotations for typed dictionaries used in methods and schema.

Usage example
from mypy_boto3_codecatalyst.type_defs import AccessTokenSummaryTypeDef

def get_value() -> AccessTokenSummaryTypeDef:
    return {
        "id": ...,
        "name": ...,
    }