Type definitions#
Index > CodeStarNotifications > Type definitions
Auto-generated documentation for CodeStarNotifications type annotations stubs module mypy-boto3-codestar-notifications.
TargetTypeDef#
# TargetTypeDef TypedDict usage example
from mypy_boto3_codestar_notifications.type_defs import TargetTypeDef
def get_value() -> TargetTypeDef:
return {
"TargetType": ...,
}
# TargetTypeDef definition
class TargetTypeDef(TypedDict):
TargetType: NotRequired[str],
TargetAddress: NotRequired[str],
ResponseMetadataTypeDef#
# ResponseMetadataTypeDef TypedDict usage example
from mypy_boto3_codestar_notifications.type_defs import ResponseMetadataTypeDef
def get_value() -> ResponseMetadataTypeDef:
return {
"RequestId": ...,
}
# ResponseMetadataTypeDef definition
class ResponseMetadataTypeDef(TypedDict):
RequestId: str,
HTTPStatusCode: int,
HTTPHeaders: Dict[str, str],
RetryAttempts: int,
HostId: NotRequired[str],
DeleteNotificationRuleRequestTypeDef#
# DeleteNotificationRuleRequestTypeDef TypedDict usage example
from mypy_boto3_codestar_notifications.type_defs import DeleteNotificationRuleRequestTypeDef
def get_value() -> DeleteNotificationRuleRequestTypeDef:
return {
"Arn": ...,
}
# DeleteNotificationRuleRequestTypeDef definition
class DeleteNotificationRuleRequestTypeDef(TypedDict):
Arn: str,
DeleteTargetRequestTypeDef#
# DeleteTargetRequestTypeDef TypedDict usage example
from mypy_boto3_codestar_notifications.type_defs import DeleteTargetRequestTypeDef
def get_value() -> DeleteTargetRequestTypeDef:
return {
"TargetAddress": ...,
}
# DeleteTargetRequestTypeDef definition
class DeleteTargetRequestTypeDef(TypedDict):
TargetAddress: str,
ForceUnsubscribeAll: NotRequired[bool],
DescribeNotificationRuleRequestTypeDef#
# DescribeNotificationRuleRequestTypeDef TypedDict usage example
from mypy_boto3_codestar_notifications.type_defs import DescribeNotificationRuleRequestTypeDef
def get_value() -> DescribeNotificationRuleRequestTypeDef:
return {
"Arn": ...,
}
# DescribeNotificationRuleRequestTypeDef definition
class DescribeNotificationRuleRequestTypeDef(TypedDict):
Arn: str,
EventTypeSummaryTypeDef#
# EventTypeSummaryTypeDef TypedDict usage example
from mypy_boto3_codestar_notifications.type_defs import EventTypeSummaryTypeDef
def get_value() -> EventTypeSummaryTypeDef:
return {
"EventTypeId": ...,
}
# EventTypeSummaryTypeDef definition
class EventTypeSummaryTypeDef(TypedDict):
EventTypeId: NotRequired[str],
ServiceName: NotRequired[str],
EventTypeName: NotRequired[str],
ResourceType: NotRequired[str],
TargetSummaryTypeDef#
# TargetSummaryTypeDef TypedDict usage example
from mypy_boto3_codestar_notifications.type_defs import TargetSummaryTypeDef
def get_value() -> TargetSummaryTypeDef:
return {
"TargetAddress": ...,
}
# TargetSummaryTypeDef definition
class TargetSummaryTypeDef(TypedDict):
TargetAddress: NotRequired[str],
TargetType: NotRequired[str],
TargetStatus: NotRequired[TargetStatusType], # (1)
- See TargetStatusType
ListEventTypesFilterTypeDef#
# ListEventTypesFilterTypeDef TypedDict usage example
from mypy_boto3_codestar_notifications.type_defs import ListEventTypesFilterTypeDef
def get_value() -> ListEventTypesFilterTypeDef:
return {
"Name": ...,
}
# ListEventTypesFilterTypeDef definition
class ListEventTypesFilterTypeDef(TypedDict):
Name: ListEventTypesFilterNameType, # (1)
Value: str,
PaginatorConfigTypeDef#
# PaginatorConfigTypeDef TypedDict usage example
from mypy_boto3_codestar_notifications.type_defs import PaginatorConfigTypeDef
def get_value() -> PaginatorConfigTypeDef:
return {
"MaxItems": ...,
}
# PaginatorConfigTypeDef definition
class PaginatorConfigTypeDef(TypedDict):
MaxItems: NotRequired[int],
PageSize: NotRequired[int],
StartingToken: NotRequired[str],
ListNotificationRulesFilterTypeDef#
# ListNotificationRulesFilterTypeDef TypedDict usage example
from mypy_boto3_codestar_notifications.type_defs import ListNotificationRulesFilterTypeDef
def get_value() -> ListNotificationRulesFilterTypeDef:
return {
"Name": ...,
}
# ListNotificationRulesFilterTypeDef definition
class ListNotificationRulesFilterTypeDef(TypedDict):
Name: ListNotificationRulesFilterNameType, # (1)
Value: str,
NotificationRuleSummaryTypeDef#
# NotificationRuleSummaryTypeDef TypedDict usage example
from mypy_boto3_codestar_notifications.type_defs import NotificationRuleSummaryTypeDef
def get_value() -> NotificationRuleSummaryTypeDef:
return {
"Id": ...,
}
# NotificationRuleSummaryTypeDef definition
class NotificationRuleSummaryTypeDef(TypedDict):
Id: NotRequired[str],
Arn: NotRequired[str],
ListTagsForResourceRequestTypeDef#
# ListTagsForResourceRequestTypeDef TypedDict usage example
from mypy_boto3_codestar_notifications.type_defs import ListTagsForResourceRequestTypeDef
def get_value() -> ListTagsForResourceRequestTypeDef:
return {
"Arn": ...,
}
# ListTagsForResourceRequestTypeDef definition
class ListTagsForResourceRequestTypeDef(TypedDict):
Arn: str,
ListTargetsFilterTypeDef#
# ListTargetsFilterTypeDef TypedDict usage example
from mypy_boto3_codestar_notifications.type_defs import ListTargetsFilterTypeDef
def get_value() -> ListTargetsFilterTypeDef:
return {
"Name": ...,
}
# ListTargetsFilterTypeDef definition
class ListTargetsFilterTypeDef(TypedDict):
Name: ListTargetsFilterNameType, # (1)
Value: str,
TagResourceRequestTypeDef#
# TagResourceRequestTypeDef TypedDict usage example
from mypy_boto3_codestar_notifications.type_defs import TagResourceRequestTypeDef
def get_value() -> TagResourceRequestTypeDef:
return {
"Arn": ...,
}
# TagResourceRequestTypeDef definition
class TagResourceRequestTypeDef(TypedDict):
Arn: str,
Tags: Mapping[str, str],
UnsubscribeRequestTypeDef#
# UnsubscribeRequestTypeDef TypedDict usage example
from mypy_boto3_codestar_notifications.type_defs import UnsubscribeRequestTypeDef
def get_value() -> UnsubscribeRequestTypeDef:
return {
"Arn": ...,
}
# UnsubscribeRequestTypeDef definition
class UnsubscribeRequestTypeDef(TypedDict):
Arn: str,
TargetAddress: str,
UntagResourceRequestTypeDef#
# UntagResourceRequestTypeDef TypedDict usage example
from mypy_boto3_codestar_notifications.type_defs import UntagResourceRequestTypeDef
def get_value() -> UntagResourceRequestTypeDef:
return {
"Arn": ...,
}
# UntagResourceRequestTypeDef definition
class UntagResourceRequestTypeDef(TypedDict):
Arn: str,
TagKeys: Sequence[str],
CreateNotificationRuleRequestTypeDef#
# CreateNotificationRuleRequestTypeDef TypedDict usage example
from mypy_boto3_codestar_notifications.type_defs import CreateNotificationRuleRequestTypeDef
def get_value() -> CreateNotificationRuleRequestTypeDef:
return {
"Name": ...,
}
# CreateNotificationRuleRequestTypeDef definition
class CreateNotificationRuleRequestTypeDef(TypedDict):
Name: str,
EventTypeIds: Sequence[str],
Resource: str,
Targets: Sequence[TargetTypeDef], # (1)
DetailType: DetailTypeType, # (2)
ClientRequestToken: NotRequired[str],
Tags: NotRequired[Mapping[str, str]],
Status: NotRequired[NotificationRuleStatusType], # (3)
- See
Sequence[TargetTypeDef]
- See DetailTypeType
- See NotificationRuleStatusType
SubscribeRequestTypeDef#
# SubscribeRequestTypeDef TypedDict usage example
from mypy_boto3_codestar_notifications.type_defs import SubscribeRequestTypeDef
def get_value() -> SubscribeRequestTypeDef:
return {
"Arn": ...,
}
# SubscribeRequestTypeDef definition
class SubscribeRequestTypeDef(TypedDict):
Arn: str,
Target: TargetTypeDef, # (1)
ClientRequestToken: NotRequired[str],
- See TargetTypeDef
UpdateNotificationRuleRequestTypeDef#
# UpdateNotificationRuleRequestTypeDef TypedDict usage example
from mypy_boto3_codestar_notifications.type_defs import UpdateNotificationRuleRequestTypeDef
def get_value() -> UpdateNotificationRuleRequestTypeDef:
return {
"Arn": ...,
}
# UpdateNotificationRuleRequestTypeDef definition
class UpdateNotificationRuleRequestTypeDef(TypedDict):
Arn: str,
Name: NotRequired[str],
Status: NotRequired[NotificationRuleStatusType], # (1)
EventTypeIds: NotRequired[Sequence[str]],
Targets: NotRequired[Sequence[TargetTypeDef]], # (2)
DetailType: NotRequired[DetailTypeType], # (3)
- See NotificationRuleStatusType
- See
Sequence[TargetTypeDef]
- See DetailTypeType
CreateNotificationRuleResultTypeDef#
# CreateNotificationRuleResultTypeDef TypedDict usage example
from mypy_boto3_codestar_notifications.type_defs import CreateNotificationRuleResultTypeDef
def get_value() -> CreateNotificationRuleResultTypeDef:
return {
"Arn": ...,
}
# CreateNotificationRuleResultTypeDef definition
class CreateNotificationRuleResultTypeDef(TypedDict):
Arn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
DeleteNotificationRuleResultTypeDef#
# DeleteNotificationRuleResultTypeDef TypedDict usage example
from mypy_boto3_codestar_notifications.type_defs import DeleteNotificationRuleResultTypeDef
def get_value() -> DeleteNotificationRuleResultTypeDef:
return {
"Arn": ...,
}
# DeleteNotificationRuleResultTypeDef definition
class DeleteNotificationRuleResultTypeDef(TypedDict):
Arn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
ListTagsForResourceResultTypeDef#
# ListTagsForResourceResultTypeDef TypedDict usage example
from mypy_boto3_codestar_notifications.type_defs import ListTagsForResourceResultTypeDef
def get_value() -> ListTagsForResourceResultTypeDef:
return {
"Tags": ...,
}
# ListTagsForResourceResultTypeDef definition
class ListTagsForResourceResultTypeDef(TypedDict):
Tags: Dict[str, str],
ResponseMetadata: ResponseMetadataTypeDef, # (1)
SubscribeResultTypeDef#
# SubscribeResultTypeDef TypedDict usage example
from mypy_boto3_codestar_notifications.type_defs import SubscribeResultTypeDef
def get_value() -> SubscribeResultTypeDef:
return {
"Arn": ...,
}
# SubscribeResultTypeDef definition
class SubscribeResultTypeDef(TypedDict):
Arn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
TagResourceResultTypeDef#
# TagResourceResultTypeDef TypedDict usage example
from mypy_boto3_codestar_notifications.type_defs import TagResourceResultTypeDef
def get_value() -> TagResourceResultTypeDef:
return {
"Tags": ...,
}
# TagResourceResultTypeDef definition
class TagResourceResultTypeDef(TypedDict):
Tags: Dict[str, str],
ResponseMetadata: ResponseMetadataTypeDef, # (1)
UnsubscribeResultTypeDef#
# UnsubscribeResultTypeDef TypedDict usage example
from mypy_boto3_codestar_notifications.type_defs import UnsubscribeResultTypeDef
def get_value() -> UnsubscribeResultTypeDef:
return {
"Arn": ...,
}
# UnsubscribeResultTypeDef definition
class UnsubscribeResultTypeDef(TypedDict):
Arn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
ListEventTypesResultTypeDef#
# ListEventTypesResultTypeDef TypedDict usage example
from mypy_boto3_codestar_notifications.type_defs import ListEventTypesResultTypeDef
def get_value() -> ListEventTypesResultTypeDef:
return {
"EventTypes": ...,
}
# ListEventTypesResultTypeDef definition
class ListEventTypesResultTypeDef(TypedDict):
EventTypes: List[EventTypeSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
NextToken: NotRequired[str],
- See
List[EventTypeSummaryTypeDef]
- See ResponseMetadataTypeDef
DescribeNotificationRuleResultTypeDef#
# DescribeNotificationRuleResultTypeDef TypedDict usage example
from mypy_boto3_codestar_notifications.type_defs import DescribeNotificationRuleResultTypeDef
def get_value() -> DescribeNotificationRuleResultTypeDef:
return {
"Arn": ...,
}
# DescribeNotificationRuleResultTypeDef definition
class DescribeNotificationRuleResultTypeDef(TypedDict):
Arn: str,
Name: str,
EventTypes: List[EventTypeSummaryTypeDef], # (1)
Resource: str,
Targets: List[TargetSummaryTypeDef], # (2)
DetailType: DetailTypeType, # (3)
CreatedBy: str,
Status: NotificationRuleStatusType, # (4)
CreatedTimestamp: datetime.datetime,
LastModifiedTimestamp: datetime.datetime,
Tags: Dict[str, str],
ResponseMetadata: ResponseMetadataTypeDef, # (5)
- See
List[EventTypeSummaryTypeDef]
- See
List[TargetSummaryTypeDef]
- See DetailTypeType
- See NotificationRuleStatusType
- See ResponseMetadataTypeDef
ListTargetsResultTypeDef#
# ListTargetsResultTypeDef TypedDict usage example
from mypy_boto3_codestar_notifications.type_defs import ListTargetsResultTypeDef
def get_value() -> ListTargetsResultTypeDef:
return {
"Targets": ...,
}
# ListTargetsResultTypeDef definition
class ListTargetsResultTypeDef(TypedDict):
Targets: List[TargetSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
NextToken: NotRequired[str],
- See
List[TargetSummaryTypeDef]
- See ResponseMetadataTypeDef
ListEventTypesRequestTypeDef#
# ListEventTypesRequestTypeDef TypedDict usage example
from mypy_boto3_codestar_notifications.type_defs import ListEventTypesRequestTypeDef
def get_value() -> ListEventTypesRequestTypeDef:
return {
"Filters": ...,
}
# ListEventTypesRequestTypeDef definition
class ListEventTypesRequestTypeDef(TypedDict):
Filters: NotRequired[Sequence[ListEventTypesFilterTypeDef]], # (1)
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
- See
Sequence[ListEventTypesFilterTypeDef]
ListEventTypesRequestPaginateTypeDef#
# ListEventTypesRequestPaginateTypeDef TypedDict usage example
from mypy_boto3_codestar_notifications.type_defs import ListEventTypesRequestPaginateTypeDef
def get_value() -> ListEventTypesRequestPaginateTypeDef:
return {
"Filters": ...,
}
# ListEventTypesRequestPaginateTypeDef definition
class ListEventTypesRequestPaginateTypeDef(TypedDict):
Filters: NotRequired[Sequence[ListEventTypesFilterTypeDef]], # (1)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (2)
- See
Sequence[ListEventTypesFilterTypeDef]
- See PaginatorConfigTypeDef
ListNotificationRulesRequestPaginateTypeDef#
# ListNotificationRulesRequestPaginateTypeDef TypedDict usage example
from mypy_boto3_codestar_notifications.type_defs import ListNotificationRulesRequestPaginateTypeDef
def get_value() -> ListNotificationRulesRequestPaginateTypeDef:
return {
"Filters": ...,
}
# ListNotificationRulesRequestPaginateTypeDef definition
class ListNotificationRulesRequestPaginateTypeDef(TypedDict):
Filters: NotRequired[Sequence[ListNotificationRulesFilterTypeDef]], # (1)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (2)
- See
Sequence[ListNotificationRulesFilterTypeDef]
- See PaginatorConfigTypeDef
ListNotificationRulesRequestTypeDef#
# ListNotificationRulesRequestTypeDef TypedDict usage example
from mypy_boto3_codestar_notifications.type_defs import ListNotificationRulesRequestTypeDef
def get_value() -> ListNotificationRulesRequestTypeDef:
return {
"Filters": ...,
}
# ListNotificationRulesRequestTypeDef definition
class ListNotificationRulesRequestTypeDef(TypedDict):
Filters: NotRequired[Sequence[ListNotificationRulesFilterTypeDef]], # (1)
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
- See
Sequence[ListNotificationRulesFilterTypeDef]
ListNotificationRulesResultTypeDef#
# ListNotificationRulesResultTypeDef TypedDict usage example
from mypy_boto3_codestar_notifications.type_defs import ListNotificationRulesResultTypeDef
def get_value() -> ListNotificationRulesResultTypeDef:
return {
"NextToken": ...,
}
# ListNotificationRulesResultTypeDef definition
class ListNotificationRulesResultTypeDef(TypedDict):
NotificationRules: List[NotificationRuleSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
NextToken: NotRequired[str],
- See
List[NotificationRuleSummaryTypeDef]
- See ResponseMetadataTypeDef
ListTargetsRequestPaginateTypeDef#
# ListTargetsRequestPaginateTypeDef TypedDict usage example
from mypy_boto3_codestar_notifications.type_defs import ListTargetsRequestPaginateTypeDef
def get_value() -> ListTargetsRequestPaginateTypeDef:
return {
"Filters": ...,
}
# ListTargetsRequestPaginateTypeDef definition
class ListTargetsRequestPaginateTypeDef(TypedDict):
Filters: NotRequired[Sequence[ListTargetsFilterTypeDef]], # (1)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (2)
- See
Sequence[ListTargetsFilterTypeDef]
- See PaginatorConfigTypeDef
ListTargetsRequestTypeDef#
# ListTargetsRequestTypeDef TypedDict usage example
from mypy_boto3_codestar_notifications.type_defs import ListTargetsRequestTypeDef
def get_value() -> ListTargetsRequestTypeDef:
return {
"Filters": ...,
}
# ListTargetsRequestTypeDef definition
class ListTargetsRequestTypeDef(TypedDict):
Filters: NotRequired[Sequence[ListTargetsFilterTypeDef]], # (1)
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
- See
Sequence[ListTargetsFilterTypeDef]