Skip to content

Typed dictionaries#

Index > CodeStarNotifications > Typed dictionaries

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

TargetTypeDef#

# TargetTypeDef 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],

CreateNotificationRuleResultTypeDef#

# CreateNotificationRuleResultTypeDef usage example

from mypy_boto3_codestar_notifications.type_defs import CreateNotificationRuleResultTypeDef

def get_value() -> CreateNotificationRuleResultTypeDef:
    return {
        "Arn": ...,
        "ResponseMetadata": ...,
    }
# CreateNotificationRuleResultTypeDef definition

class CreateNotificationRuleResultTypeDef(TypedDict):
    Arn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

DeleteNotificationRuleRequestRequestTypeDef#

# DeleteNotificationRuleRequestRequestTypeDef usage example

from mypy_boto3_codestar_notifications.type_defs import DeleteNotificationRuleRequestRequestTypeDef

def get_value() -> DeleteNotificationRuleRequestRequestTypeDef:
    return {
        "Arn": ...,
    }
# DeleteNotificationRuleRequestRequestTypeDef definition

class DeleteNotificationRuleRequestRequestTypeDef(TypedDict):
    Arn: str,

DeleteNotificationRuleResultTypeDef#

# DeleteNotificationRuleResultTypeDef usage example

from mypy_boto3_codestar_notifications.type_defs import DeleteNotificationRuleResultTypeDef

def get_value() -> DeleteNotificationRuleResultTypeDef:
    return {
        "Arn": ...,
        "ResponseMetadata": ...,
    }
# DeleteNotificationRuleResultTypeDef definition

class DeleteNotificationRuleResultTypeDef(TypedDict):
    Arn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

DeleteTargetRequestRequestTypeDef#

# DeleteTargetRequestRequestTypeDef usage example

from mypy_boto3_codestar_notifications.type_defs import DeleteTargetRequestRequestTypeDef

def get_value() -> DeleteTargetRequestRequestTypeDef:
    return {
        "TargetAddress": ...,
    }
# DeleteTargetRequestRequestTypeDef definition

class DeleteTargetRequestRequestTypeDef(TypedDict):
    TargetAddress: str,
    ForceUnsubscribeAll: NotRequired[bool],

DescribeNotificationRuleRequestRequestTypeDef#

# DescribeNotificationRuleRequestRequestTypeDef usage example

from mypy_boto3_codestar_notifications.type_defs import DescribeNotificationRuleRequestRequestTypeDef

def get_value() -> DescribeNotificationRuleRequestRequestTypeDef:
    return {
        "Arn": ...,
    }
# DescribeNotificationRuleRequestRequestTypeDef definition

class DescribeNotificationRuleRequestRequestTypeDef(TypedDict):
    Arn: str,

EventTypeSummaryTypeDef#

# EventTypeSummaryTypeDef 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 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)
  1. See TargetStatusType

ListEventTypesFilterTypeDef#

# ListEventTypesFilterTypeDef usage example

from mypy_boto3_codestar_notifications.type_defs import ListEventTypesFilterTypeDef

def get_value() -> ListEventTypesFilterTypeDef:
    return {
        "Name": ...,
        "Value": ...,
    }
# ListEventTypesFilterTypeDef definition

class ListEventTypesFilterTypeDef(TypedDict):
    Name: ListEventTypesFilterNameType,  # (1)
    Value: str,
  1. See ListEventTypesFilterNameType

ListNotificationRulesFilterTypeDef#

# ListNotificationRulesFilterTypeDef usage example

from mypy_boto3_codestar_notifications.type_defs import ListNotificationRulesFilterTypeDef

def get_value() -> ListNotificationRulesFilterTypeDef:
    return {
        "Name": ...,
        "Value": ...,
    }
# ListNotificationRulesFilterTypeDef definition

class ListNotificationRulesFilterTypeDef(TypedDict):
    Name: ListNotificationRulesFilterNameType,  # (1)
    Value: str,
  1. See ListNotificationRulesFilterNameType

NotificationRuleSummaryTypeDef#

# NotificationRuleSummaryTypeDef 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],

ListTagsForResourceRequestRequestTypeDef#

# ListTagsForResourceRequestRequestTypeDef usage example

from mypy_boto3_codestar_notifications.type_defs import ListTagsForResourceRequestRequestTypeDef

def get_value() -> ListTagsForResourceRequestRequestTypeDef:
    return {
        "Arn": ...,
    }
# ListTagsForResourceRequestRequestTypeDef definition

class ListTagsForResourceRequestRequestTypeDef(TypedDict):
    Arn: str,

ListTagsForResourceResultTypeDef#

# ListTagsForResourceResultTypeDef usage example

from mypy_boto3_codestar_notifications.type_defs import ListTagsForResourceResultTypeDef

def get_value() -> ListTagsForResourceResultTypeDef:
    return {
        "Tags": ...,
        "ResponseMetadata": ...,
    }
# ListTagsForResourceResultTypeDef definition

class ListTagsForResourceResultTypeDef(TypedDict):
    Tags: Dict[str, str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

ListTargetsFilterTypeDef#

# ListTargetsFilterTypeDef usage example

from mypy_boto3_codestar_notifications.type_defs import ListTargetsFilterTypeDef

def get_value() -> ListTargetsFilterTypeDef:
    return {
        "Name": ...,
        "Value": ...,
    }
# ListTargetsFilterTypeDef definition

class ListTargetsFilterTypeDef(TypedDict):
    Name: ListTargetsFilterNameType,  # (1)
    Value: str,
  1. See ListTargetsFilterNameType

PaginatorConfigTypeDef#

# PaginatorConfigTypeDef 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],

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef usage example

from mypy_boto3_codestar_notifications.type_defs import ResponseMetadataTypeDef

def get_value() -> ResponseMetadataTypeDef:
    return {
        "RequestId": ...,
        "HostId": ...,
        "HTTPStatusCode": ...,
        "HTTPHeaders": ...,
        "RetryAttempts": ...,
    }
# ResponseMetadataTypeDef definition

class ResponseMetadataTypeDef(TypedDict):
    RequestId: str,
    HostId: str,
    HTTPStatusCode: int,
    HTTPHeaders: Dict[str, str],
    RetryAttempts: int,

SubscribeResultTypeDef#

# SubscribeResultTypeDef usage example

from mypy_boto3_codestar_notifications.type_defs import SubscribeResultTypeDef

def get_value() -> SubscribeResultTypeDef:
    return {
        "Arn": ...,
        "ResponseMetadata": ...,
    }
# SubscribeResultTypeDef definition

class SubscribeResultTypeDef(TypedDict):
    Arn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

TagResourceRequestRequestTypeDef#

# TagResourceRequestRequestTypeDef usage example

from mypy_boto3_codestar_notifications.type_defs import TagResourceRequestRequestTypeDef

def get_value() -> TagResourceRequestRequestTypeDef:
    return {
        "Arn": ...,
        "Tags": ...,
    }
# TagResourceRequestRequestTypeDef definition

class TagResourceRequestRequestTypeDef(TypedDict):
    Arn: str,
    Tags: Mapping[str, str],

TagResourceResultTypeDef#

# TagResourceResultTypeDef usage example

from mypy_boto3_codestar_notifications.type_defs import TagResourceResultTypeDef

def get_value() -> TagResourceResultTypeDef:
    return {
        "Tags": ...,
        "ResponseMetadata": ...,
    }
# TagResourceResultTypeDef definition

class TagResourceResultTypeDef(TypedDict):
    Tags: Dict[str, str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

UnsubscribeRequestRequestTypeDef#

# UnsubscribeRequestRequestTypeDef usage example

from mypy_boto3_codestar_notifications.type_defs import UnsubscribeRequestRequestTypeDef

def get_value() -> UnsubscribeRequestRequestTypeDef:
    return {
        "Arn": ...,
        "TargetAddress": ...,
    }
# UnsubscribeRequestRequestTypeDef definition

class UnsubscribeRequestRequestTypeDef(TypedDict):
    Arn: str,
    TargetAddress: str,

UnsubscribeResultTypeDef#

# UnsubscribeResultTypeDef usage example

from mypy_boto3_codestar_notifications.type_defs import UnsubscribeResultTypeDef

def get_value() -> UnsubscribeResultTypeDef:
    return {
        "Arn": ...,
        "ResponseMetadata": ...,
    }
# UnsubscribeResultTypeDef definition

class UnsubscribeResultTypeDef(TypedDict):
    Arn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

UntagResourceRequestRequestTypeDef#

# UntagResourceRequestRequestTypeDef usage example

from mypy_boto3_codestar_notifications.type_defs import UntagResourceRequestRequestTypeDef

def get_value() -> UntagResourceRequestRequestTypeDef:
    return {
        "Arn": ...,
        "TagKeys": ...,
    }
# UntagResourceRequestRequestTypeDef definition

class UntagResourceRequestRequestTypeDef(TypedDict):
    Arn: str,
    TagKeys: Sequence[str],

CreateNotificationRuleRequestRequestTypeDef#

# CreateNotificationRuleRequestRequestTypeDef usage example

from mypy_boto3_codestar_notifications.type_defs import CreateNotificationRuleRequestRequestTypeDef

def get_value() -> CreateNotificationRuleRequestRequestTypeDef:
    return {
        "Name": ...,
        "EventTypeIds": ...,
        "Resource": ...,
        "Targets": ...,
        "DetailType": ...,
    }
# CreateNotificationRuleRequestRequestTypeDef definition

class CreateNotificationRuleRequestRequestTypeDef(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)
  1. See TargetTypeDef
  2. See DetailTypeType
  3. See NotificationRuleStatusType

SubscribeRequestRequestTypeDef#

# SubscribeRequestRequestTypeDef usage example

from mypy_boto3_codestar_notifications.type_defs import SubscribeRequestRequestTypeDef

def get_value() -> SubscribeRequestRequestTypeDef:
    return {
        "Arn": ...,
        "Target": ...,
    }
# SubscribeRequestRequestTypeDef definition

class SubscribeRequestRequestTypeDef(TypedDict):
    Arn: str,
    Target: TargetTypeDef,  # (1)
    ClientRequestToken: NotRequired[str],
  1. See TargetTypeDef

UpdateNotificationRuleRequestRequestTypeDef#

# UpdateNotificationRuleRequestRequestTypeDef usage example

from mypy_boto3_codestar_notifications.type_defs import UpdateNotificationRuleRequestRequestTypeDef

def get_value() -> UpdateNotificationRuleRequestRequestTypeDef:
    return {
        "Arn": ...,
    }
# UpdateNotificationRuleRequestRequestTypeDef definition

class UpdateNotificationRuleRequestRequestTypeDef(TypedDict):
    Arn: str,
    Name: NotRequired[str],
    Status: NotRequired[NotificationRuleStatusType],  # (1)
    EventTypeIds: NotRequired[Sequence[str]],
    Targets: NotRequired[Sequence[TargetTypeDef]],  # (2)
    DetailType: NotRequired[DetailTypeType],  # (3)
  1. See NotificationRuleStatusType
  2. See TargetTypeDef
  3. See DetailTypeType

ListEventTypesResultTypeDef#

# ListEventTypesResultTypeDef usage example

from mypy_boto3_codestar_notifications.type_defs import ListEventTypesResultTypeDef

def get_value() -> ListEventTypesResultTypeDef:
    return {
        "EventTypes": ...,
        "NextToken": ...,
        "ResponseMetadata": ...,
    }
# ListEventTypesResultTypeDef definition

class ListEventTypesResultTypeDef(TypedDict):
    EventTypes: List[EventTypeSummaryTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See EventTypeSummaryTypeDef
  2. See ResponseMetadataTypeDef

DescribeNotificationRuleResultTypeDef#

# DescribeNotificationRuleResultTypeDef usage example

from mypy_boto3_codestar_notifications.type_defs import DescribeNotificationRuleResultTypeDef

def get_value() -> DescribeNotificationRuleResultTypeDef:
    return {
        "Arn": ...,
        "Name": ...,
        "EventTypes": ...,
        "Resource": ...,
        "Targets": ...,
        "DetailType": ...,
        "CreatedBy": ...,
        "Status": ...,
        "CreatedTimestamp": ...,
        "LastModifiedTimestamp": ...,
        "Tags": ...,
        "ResponseMetadata": ...,
    }
# 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,
    LastModifiedTimestamp: datetime,
    Tags: Dict[str, str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (5)
  1. See EventTypeSummaryTypeDef
  2. See TargetSummaryTypeDef
  3. See DetailTypeType
  4. See NotificationRuleStatusType
  5. See ResponseMetadataTypeDef

ListTargetsResultTypeDef#

# ListTargetsResultTypeDef usage example

from mypy_boto3_codestar_notifications.type_defs import ListTargetsResultTypeDef

def get_value() -> ListTargetsResultTypeDef:
    return {
        "Targets": ...,
        "NextToken": ...,
        "ResponseMetadata": ...,
    }
# ListTargetsResultTypeDef definition

class ListTargetsResultTypeDef(TypedDict):
    Targets: List[TargetSummaryTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See TargetSummaryTypeDef
  2. See ResponseMetadataTypeDef

ListEventTypesRequestListEventTypesPaginateTypeDef#

# ListEventTypesRequestListEventTypesPaginateTypeDef usage example

from mypy_boto3_codestar_notifications.type_defs import ListEventTypesRequestListEventTypesPaginateTypeDef

def get_value() -> ListEventTypesRequestListEventTypesPaginateTypeDef:
    return {
        "Filters": ...,
    }
# ListEventTypesRequestListEventTypesPaginateTypeDef definition

class ListEventTypesRequestListEventTypesPaginateTypeDef(TypedDict):
    Filters: NotRequired[Sequence[ListEventTypesFilterTypeDef]],  # (1)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)
  1. See ListEventTypesFilterTypeDef
  2. See PaginatorConfigTypeDef

ListEventTypesRequestRequestTypeDef#

# ListEventTypesRequestRequestTypeDef usage example

from mypy_boto3_codestar_notifications.type_defs import ListEventTypesRequestRequestTypeDef

def get_value() -> ListEventTypesRequestRequestTypeDef:
    return {
        "Filters": ...,
    }
# ListEventTypesRequestRequestTypeDef definition

class ListEventTypesRequestRequestTypeDef(TypedDict):
    Filters: NotRequired[Sequence[ListEventTypesFilterTypeDef]],  # (1)
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],
  1. See ListEventTypesFilterTypeDef

ListNotificationRulesRequestListNotificationRulesPaginateTypeDef#

# ListNotificationRulesRequestListNotificationRulesPaginateTypeDef usage example

from mypy_boto3_codestar_notifications.type_defs import ListNotificationRulesRequestListNotificationRulesPaginateTypeDef

def get_value() -> ListNotificationRulesRequestListNotificationRulesPaginateTypeDef:
    return {
        "Filters": ...,
    }
# ListNotificationRulesRequestListNotificationRulesPaginateTypeDef definition

class ListNotificationRulesRequestListNotificationRulesPaginateTypeDef(TypedDict):
    Filters: NotRequired[Sequence[ListNotificationRulesFilterTypeDef]],  # (1)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)
  1. See ListNotificationRulesFilterTypeDef
  2. See PaginatorConfigTypeDef

ListNotificationRulesRequestRequestTypeDef#

# ListNotificationRulesRequestRequestTypeDef usage example

from mypy_boto3_codestar_notifications.type_defs import ListNotificationRulesRequestRequestTypeDef

def get_value() -> ListNotificationRulesRequestRequestTypeDef:
    return {
        "Filters": ...,
    }
# ListNotificationRulesRequestRequestTypeDef definition

class ListNotificationRulesRequestRequestTypeDef(TypedDict):
    Filters: NotRequired[Sequence[ListNotificationRulesFilterTypeDef]],  # (1)
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],
  1. See ListNotificationRulesFilterTypeDef

ListNotificationRulesResultTypeDef#

# ListNotificationRulesResultTypeDef usage example

from mypy_boto3_codestar_notifications.type_defs import ListNotificationRulesResultTypeDef

def get_value() -> ListNotificationRulesResultTypeDef:
    return {
        "NextToken": ...,
        "NotificationRules": ...,
        "ResponseMetadata": ...,
    }
# ListNotificationRulesResultTypeDef definition

class ListNotificationRulesResultTypeDef(TypedDict):
    NextToken: str,
    NotificationRules: List[NotificationRuleSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See NotificationRuleSummaryTypeDef
  2. See ResponseMetadataTypeDef

ListTargetsRequestListTargetsPaginateTypeDef#

# ListTargetsRequestListTargetsPaginateTypeDef usage example

from mypy_boto3_codestar_notifications.type_defs import ListTargetsRequestListTargetsPaginateTypeDef

def get_value() -> ListTargetsRequestListTargetsPaginateTypeDef:
    return {
        "Filters": ...,
    }
# ListTargetsRequestListTargetsPaginateTypeDef definition

class ListTargetsRequestListTargetsPaginateTypeDef(TypedDict):
    Filters: NotRequired[Sequence[ListTargetsFilterTypeDef]],  # (1)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)
  1. See ListTargetsFilterTypeDef
  2. See PaginatorConfigTypeDef

ListTargetsRequestRequestTypeDef#

# ListTargetsRequestRequestTypeDef usage example

from mypy_boto3_codestar_notifications.type_defs import ListTargetsRequestRequestTypeDef

def get_value() -> ListTargetsRequestRequestTypeDef:
    return {
        "Filters": ...,
    }
# ListTargetsRequestRequestTypeDef definition

class ListTargetsRequestRequestTypeDef(TypedDict):
    Filters: NotRequired[Sequence[ListTargetsFilterTypeDef]],  # (1)
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],
  1. See ListTargetsFilterTypeDef