Skip to content

CodeStar module#

Index > CodeStar

Auto-generated documentation for CodeStar type annotations stubs module mypy-boto3-codestar.

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 CodeStar.

From PyPI with pip#

Install boto3-stubs for CodeStar service.

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


# 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[codestar]'


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

How to uninstall#

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

Usage#

Code samples can be found in Examples.

CodeStarClient#

Type annotations and code completion for boto3.client("codestar") as CodeStarClient boto3 documentation

# CodeStarClient usage example

from boto3.session import Session

from mypy_boto3_codestar.client import CodeStarClient

def get_client() -> CodeStarClient:
    return Session().client("codestar")

Paginators#

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

# ListProjectsPaginator usage example

from boto3.session import Session

from mypy_boto3_codestar.paginator import ListProjectsPaginator

def get_list_projects_paginator() -> ListProjectsPaginator:
    return Session().client("codestar").get_paginator("list_projects"))

Literals#

Type annotations for literals used in methods and schemas.

# ListProjectsPaginatorName usage example

from mypy_boto3_codestar.literals import ListProjectsPaginatorName

def get_value() -> ListProjectsPaginatorName:
    return "list_projects"

Typed dictionaries#

Type annotations for typed dictionaries used in methods and schema.

# AssociateTeamMemberRequestRequestTypeDef usage example

from mypy_boto3_codestar.type_defs import AssociateTeamMemberRequestRequestTypeDef

def get_value() -> AssociateTeamMemberRequestRequestTypeDef:
    return {
        "projectId": ...,
        "userArn": ...,
        "projectRole": ...,
    }