CodeStarNotifications module#
Index > CodeStarNotifications
Auto-generated documentation for CodeStarNotifications type annotations stubs module mypy-boto3-codestar-notifications.
How to install#
Generate locally (recommended)#
You can generate type annotations for boto3
package locally with mypy-boto3-builder
.
Use uv for build isolation.
- Run mypy-boto3-builder in your package root directory:
uvx --with 'boto3==1.36.26' mypy-boto3-builder
- Select
boto3-stubs
AWS SDK. - Add
CodeStarNotifications
service. - Use provided commands to install generated packages.
VSCode extension#
Add AWS Boto3
extension to your VSCode and run AWS boto3: Quick Start
command.
Click Modify
and select boto3 common
and CodeStarNotifications
.
From PyPI with pip#
Install boto3-stubs
for CodeStarNotifications
service.
# install with boto3 type annotations
python -m pip install 'boto3-stubs[codestar-notifications]'
# 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-notifications]'
# standalone installation
python -m pip install mypy-boto3-codestar-notifications
How to uninstall#
python -m pip uninstall -y mypy-boto3-codestar-notifications
Usage#
Code samples can be found in Examples.
CodeStarNotificationsClient#
Type annotations and code completion for boto3.client("codestar-notifications")
as CodeStarNotificationsClient
boto3 documentation
# CodeStarNotificationsClient usage example
from boto3.session import Session
from mypy_boto3_codestar_notifications.client import CodeStarNotificationsClient
def get_client() -> CodeStarNotificationsClient:
return Session().client("codestar-notifications")
Paginators#
Type annotations and code completion for paginators
from boto3.client("codestar-notifications").get_paginator("...")
.
# ListEventTypesPaginator usage example
from boto3.session import Session
from mypy_boto3_codestar_notifications.paginator import ListEventTypesPaginator
def get_list_event_types_paginator() -> ListEventTypesPaginator:
return Session().client("codestar-notifications").get_paginator("list_event_types"))
Literals#
Type annotations for literals used in methods and schema.
# DetailTypeType usage example
from mypy_boto3_codestar_notifications.literals import DetailTypeType
def get_value() -> DetailTypeType:
return "BASIC"
- DetailTypeType
- ListEventTypesFilterNameType
- ListEventTypesPaginatorName
- ListNotificationRulesFilterNameType
- ListNotificationRulesPaginatorName
- ListTargetsFilterNameType
- ListTargetsPaginatorName
- NotificationRuleStatusType
- TargetStatusType
- CodeStarNotificationsServiceName
- ServiceName
- ResourceServiceName
- PaginatorName
- RegionName
Type definitions#
Type annotations for type definitions used in methods and schema.
- TargetTypeDef
- ResponseMetadataTypeDef
- DeleteNotificationRuleRequestTypeDef
- DeleteTargetRequestTypeDef
- DescribeNotificationRuleRequestTypeDef
- EventTypeSummaryTypeDef
- TargetSummaryTypeDef
- ListEventTypesFilterTypeDef
- PaginatorConfigTypeDef
- ListNotificationRulesFilterTypeDef
- NotificationRuleSummaryTypeDef
- ListTagsForResourceRequestTypeDef
- ListTargetsFilterTypeDef
- TagResourceRequestTypeDef
- UnsubscribeRequestTypeDef
- UntagResourceRequestTypeDef
- CreateNotificationRuleRequestTypeDef
- SubscribeRequestTypeDef
- UpdateNotificationRuleRequestTypeDef
- CreateNotificationRuleResultTypeDef
- DeleteNotificationRuleResultTypeDef
- ListTagsForResourceResultTypeDef
- SubscribeResultTypeDef
- TagResourceResultTypeDef
- UnsubscribeResultTypeDef
- ListEventTypesResultTypeDef
- DescribeNotificationRuleResultTypeDef
- ListTargetsResultTypeDef
- ListEventTypesRequestTypeDef
- ListEventTypesRequestPaginateTypeDef
- ListNotificationRulesRequestPaginateTypeDef
- ListNotificationRulesRequestTypeDef
- ListNotificationRulesResultTypeDef
- ListTargetsRequestPaginateTypeDef
- ListTargetsRequestTypeDef