<a id="mypy-boto3-codestar"></a>
# mypy-boto3-codestar
[![PyPI - mypy-boto3-codestar](https://img.shields.io/pypi/v/mypy-boto3-codestar.svg?color=blue)](https://pypi.org/project/mypy-boto3-codestar)
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/mypy-boto3-codestar.svg?color=blue)](https://pypi.org/project/mypy-boto3-codestar)
[![Docs](https://img.shields.io/readthedocs/mypy-boto3-builder.svg?color=blue)](https://mypy-boto3-builder.readthedocs.io/)
[![PyPI - Downloads](https://img.shields.io/pypi/dw/mypy-boto3-codestar?color=blue)](https://pypistats.org/packages/mypy-boto3-codestar)
![boto3.typed](https://github.com/vemel/mypy_boto3_builder/raw/master/logo.png)
Type annotations for
[boto3.CodeStar 1.19.5](https://boto3.amazonaws.com/v1/documentation/api/1.19.5/reference/services/codestar.html#CodeStar)
service compatible with [VSCode](https://code.visualstudio.com/),
[PyCharm](https://www.jetbrains.com/pycharm/),
[Emacs](https://www.gnu.org/software/emacs/),
[Sublime Text](https://www.sublimetext.com/),
[mypy](https://github.com/python/mypy),
[pyright](https://github.com/microsoft/pyright) and other tools.
Generated by
[mypy-boto3-builder 6.0.2](https://github.com/vemel/mypy_boto3_builder).
More information can be found on
[boto3-stubs](https://pypi.org/project/boto3-stubs/) page and in
[mypy-boto3-codestar docs](https://vemel.github.io/boto3_stubs_docs/mypy_boto3_codestar/)
See how it helps to find and fix potential bugs:
![boto3-stubs demo](https://github.com/vemel/mypy_boto3_builder/raw/master/demo.gif)
- [mypy-boto3-codestar](#mypy-boto3-codestar)
- [How to install](#how-to-install)
- [Usage](#usage)
- [VSCode](#vscode)
- [PyCharm](#pycharm)
- [Other IDEs](#other-ides)
- [mypy](#mypy)
- [pyright](#pyright)
- [Explicit type annotations](#explicit-type-annotations)
- [Client annotations](#client-annotations)
- [Paginators annotations](#paginators-annotations)
- [Literals](#literals)
- [Typed dictionaries](#typed-dictionaries)
- [Versioning](#versioning)
- [Documentation](#documentation)
- [Support and contributing](#support-and-contributing)
<a id="how-to-install"></a>
## How to install
Install `boto3-stubs` for `CodeStar` service.
```bash
python -m pip install boto3-stubs[codestar]
```
<a id="usage"></a>
## Usage
<a id="vscode"></a>
### VSCode
- Install
[Python extension](https://marketplace.visualstudio.com/items?itemName=ms-python.python)
- Install
[Pylance extension](https://marketplace.visualstudio.com/items?itemName=ms-python.vscode-pylance)
- Set `Pylance` as your Python Language Server
- Install `boto-stubs[codestar]` in your environment:
`python -m pip install 'boto3-stubs[codestar]'`
Both type checking and auto-complete should work for `CodeStar` service. No
explicit type annotations required, write your `boto3` code as usual.
<a id="pycharm"></a>
### PyCharm
- Install `boto-stubs[codestar]` in your environment:
`python -m pip install 'boto3-stubs[codestar]'`
Both type checking and auto-complete should work for `CodeStar` service. No
explicit type annotations required, write your `boto3` code as usual.
Auto-complete can be slow on big projects or if you have a lot of installed
`boto3-stubs` submodules.
<a id="other-ides"></a>
### Other IDEs
Not tested, but as long as your IDE supports `mypy` or `pyright`, everything
should work.
<a id="mypy"></a>
### mypy
- Install `mypy`: `python -m pip install mypy`
- Install `boto-stubs[codestar]` in your environment:
`python -m pip install 'boto3-stubs[codestar]'`
- Run `mypy` as usual
Type checking should work for `CodeStar` service. No explicit type annotations
required, write your `boto3` code as usual.
<a id="pyright"></a>
### pyright
- Install `pyright`: `yarn global add pyright`
- Install `boto-stubs[codestar]` in your environment:
`python -m pip install 'boto3-stubs[codestar]'`
- Optionally, you can install `boto3-stubs` to `typings` folder.
Type checking should work for `CodeStar` service. No explicit type annotations
required, write your `boto3` code as usual.
<a id="explicit-type-annotations"></a>
## Explicit type annotations
<a id="client-annotations"></a>
### Client annotations
`CodeStarClient` provides annotations for `boto3.client("codestar")`.
```python
import boto3
from mypy_boto3_codestar import CodeStarClient
client: CodeStarClient = boto3.client("codestar")
# now client usage is checked by mypy and IDE should provide code auto-complete
# works for session as well
session = boto3.session.Session(region="us-west-1")
session_client: CodeStarClient = session.client("codestar")
```
<a id="paginators-annotations"></a>
### Paginators annotations
`mypy_boto3_codestar.paginator` module contains type annotations for all
paginators.
```python
from mypy_boto3_codestar import CodeStarClient
from mypy_boto3_codestar.paginator import (
ListProjectsPaginator,
ListResourcesPaginator,
ListTeamMembersPaginator,
ListUserProfilesPaginator,
)
client: CodeStarClient = boto3.client("codestar")
# Explicit type annotations are optional here
# Type should be correctly discovered by mypy and IDEs
# VSCode requires explicit type annotations
list_projects_paginator: ListProjectsPaginator = client.get_paginator("list_projects")
list_resources_paginator: ListResourcesPaginator = client.get_paginator("list_resources")
list_team_members_paginator: ListTeamMembersPaginator = client.get_paginator("list_team_members")
list_user_profiles_paginator: ListUserProfilesPaginator = client.get_paginator("list_user_profiles")
```
<a id="literals"></a>
### Literals
`mypy_boto3_codestar.literals` module contains literals extracted from shapes
that can be used in user code for type checking.
```python
from mypy_boto3_codestar.literals import (
ListProjectsPaginatorName,
ListResourcesPaginatorName,
ListTeamMembersPaginatorName,
ListUserProfilesPaginatorName,
ServiceName,
PaginatorName,
)
def check_value(value: ListProjectsPaginatorName) -> bool:
...
```
<a id="typed-dictionaries"></a>
### Typed dictionaries
`mypy_boto3_codestar.type_defs` module contains structures and shapes assembled
to typed dictionaries for additional type checking.
```python
from mypy_boto3_codestar.type_defs import (
AssociateTeamMemberRequestRequestTypeDef,
AssociateTeamMemberResultTypeDef,
CodeCommitCodeDestinationTypeDef,
CodeDestinationTypeDef,
CodeSourceTypeDef,
CodeTypeDef,
CreateProjectRequestRequestTypeDef,
CreateProjectResultTypeDef,
CreateUserProfileRequestRequestTypeDef,
CreateUserProfileResultTypeDef,
DeleteProjectRequestRequestTypeDef,
DeleteProjectResultTypeDef,
DeleteUserProfileRequestRequestTypeDef,
DeleteUserProfileResultTypeDef,
DescribeProjectRequestRequestTypeDef,
DescribeProjectResultTypeDef,
DescribeUserProfileRequestRequestTypeDef,
DescribeUserProfileResultTypeDef,
DisassociateTeamMemberRequestRequestTypeDef,
GitHubCodeDestinationTypeDef,
ListProjectsRequestRequestTypeDef,
ListProjectsResultTypeDef,
ListResourcesRequestRequestTypeDef,
ListResourcesResultTypeDef,
ListTagsForProjectRequestRequestTypeDef,
ListTagsForProjectResultTypeDef,
ListTeamMembersRequestRequestTypeDef,
ListTeamMembersResultTypeDef,
ListUserProfilesRequestRequestTypeDef,
ListUserProfilesResultTypeDef,
PaginatorConfigTypeDef,
ProjectStatusTypeDef,
ProjectSummaryTypeDef,
ResourceTypeDef,
ResponseMetadataTypeDef,
S3LocationTypeDef,
TagProjectRequestRequestTypeDef,
TagProjectResultTypeDef,
TeamMemberTypeDef,
ToolchainSourceTypeDef,
ToolchainTypeDef,
UntagProjectRequestRequestTypeDef,
UpdateProjectRequestRequestTypeDef,
UpdateTeamMemberRequestRequestTypeDef,
UpdateTeamMemberResultTypeDef,
UpdateUserProfileRequestRequestTypeDef,
UpdateUserProfileResultTypeDef,
UserProfileSummaryTypeDef,
)
def get_structure