Skip to content

Type definitions#

Index > CodeStarNotifications > Type definitions

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

TargetTypeDef#

# TargetTypeDef definition

class TargetTypeDef(TypedDict):
    TargetType: NotRequired[str],
    TargetAddress: NotRequired[str],

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

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

DeleteNotificationRuleRequestRequestTypeDef#

# DeleteNotificationRuleRequestRequestTypeDef definition

class DeleteNotificationRuleRequestRequestTypeDef(TypedDict):
    Arn: str,

DeleteTargetRequestRequestTypeDef#

# DeleteTargetRequestRequestTypeDef definition

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

DescribeNotificationRuleRequestRequestTypeDef#

# DescribeNotificationRuleRequestRequestTypeDef definition

class DescribeNotificationRuleRequestRequestTypeDef(TypedDict):
    Arn: str,

EventTypeSummaryTypeDef#

# EventTypeSummaryTypeDef definition

class EventTypeSummaryTypeDef(TypedDict):
    EventTypeId: NotRequired[str],
    ServiceName: NotRequired[str],
    EventTypeName: NotRequired[str],
    ResourceType: NotRequired[str],

TargetSummaryTypeDef#

# TargetSummaryTypeDef definition

class TargetSummaryTypeDef(TypedDict):
    TargetAddress: NotRequired[str],
    TargetType: NotRequired[str],
    TargetStatus: NotRequired[TargetStatusType],  # (1)
  1. See TargetStatusType

ListEventTypesFilterTypeDef#

# ListEventTypesFilterTypeDef definition

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

PaginatorConfigTypeDef#

# PaginatorConfigTypeDef definition

class PaginatorConfigTypeDef(TypedDict):
    MaxItems: NotRequired[int],
    PageSize: NotRequired[int],
    StartingToken: NotRequired[str],

ListNotificationRulesFilterTypeDef#

# ListNotificationRulesFilterTypeDef definition

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

NotificationRuleSummaryTypeDef#

# NotificationRuleSummaryTypeDef definition

class NotificationRuleSummaryTypeDef(TypedDict):
    Id: NotRequired[str],
    Arn: NotRequired[str],

ListTagsForResourceRequestRequestTypeDef#

# ListTagsForResourceRequestRequestTypeDef definition

class ListTagsForResourceRequestRequestTypeDef(TypedDict):
    Arn: str,

ListTargetsFilterTypeDef#

# ListTargetsFilterTypeDef definition

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

TagResourceRequestRequestTypeDef#

# TagResourceRequestRequestTypeDef definition

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

UnsubscribeRequestRequestTypeDef#

# UnsubscribeRequestRequestTypeDef definition

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

UntagResourceRequestRequestTypeDef#

# UntagResourceRequestRequestTypeDef definition

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

CreateNotificationRuleRequestRequestTypeDef#

# 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 definition

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

UpdateNotificationRuleRequestRequestTypeDef#

# 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

CreateNotificationRuleResultTypeDef#

# CreateNotificationRuleResultTypeDef definition

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

DeleteNotificationRuleResultTypeDef#

# DeleteNotificationRuleResultTypeDef definition

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

ListTagsForResourceResultTypeDef#

# ListTagsForResourceResultTypeDef definition

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

SubscribeResultTypeDef#

# SubscribeResultTypeDef definition

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

TagResourceResultTypeDef#

# TagResourceResultTypeDef definition

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

UnsubscribeResultTypeDef#

# UnsubscribeResultTypeDef definition

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

ListEventTypesResultTypeDef#

# ListEventTypesResultTypeDef definition

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

DescribeNotificationRuleResultTypeDef#

# 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 definition

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

ListEventTypesRequestRequestTypeDef#

# ListEventTypesRequestRequestTypeDef definition

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

ListEventTypesRequestListEventTypesPaginateTypeDef#

# ListEventTypesRequestListEventTypesPaginateTypeDef definition

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

ListNotificationRulesRequestListNotificationRulesPaginateTypeDef#

# ListNotificationRulesRequestListNotificationRulesPaginateTypeDef definition

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

ListNotificationRulesRequestRequestTypeDef#

# ListNotificationRulesRequestRequestTypeDef definition

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

ListNotificationRulesResultTypeDef#

# ListNotificationRulesResultTypeDef definition

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

ListTargetsRequestListTargetsPaginateTypeDef#

# ListTargetsRequestListTargetsPaginateTypeDef definition

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

ListTargetsRequestRequestTypeDef#

# ListTargetsRequestRequestTypeDef definition

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