Typed dictionaries

Index > CodeStarNotifications > Typed dictionaries

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

TargetTypeDef

Usage Example

from mypy_boto3_codestar_notifications.type_defs import TargetTypeDef

def get_value() -> TargetTypeDef:
    return {
        "TargetType": ...,
    }

Definition

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

ResponseMetadataTypeDef

Usage Example

from mypy_boto3_codestar_notifications.type_defs import ResponseMetadataTypeDef

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

Definition

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

DeleteNotificationRuleRequestRequestTypeDef

Usage Example

from mypy_boto3_codestar_notifications.type_defs import DeleteNotificationRuleRequestRequestTypeDef

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

Definition

class DeleteNotificationRuleRequestRequestTypeDef(TypedDict):
    Arn: str,

DeleteTargetRequestRequestTypeDef

Usage Example

from mypy_boto3_codestar_notifications.type_defs import DeleteTargetRequestRequestTypeDef

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

Definition

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

DescribeNotificationRuleRequestRequestTypeDef

Usage Example

from mypy_boto3_codestar_notifications.type_defs import DescribeNotificationRuleRequestRequestTypeDef

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

Definition

class DescribeNotificationRuleRequestRequestTypeDef(TypedDict):
    Arn: str,

EventTypeSummaryTypeDef

Usage Example

from mypy_boto3_codestar_notifications.type_defs import EventTypeSummaryTypeDef

def get_value() -> EventTypeSummaryTypeDef:
    return {
        "EventTypeId": ...,
    }

Definition

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

TargetSummaryTypeDef

Usage Example

from mypy_boto3_codestar_notifications.type_defs import TargetSummaryTypeDef

def get_value() -> TargetSummaryTypeDef:
    return {
        "TargetAddress": ...,
    }

Definition

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

1. See TargetStatusType

ListEventTypesFilterTypeDef

Usage Example

from mypy_boto3_codestar_notifications.type_defs import ListEventTypesFilterTypeDef

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

Definition

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

1. See ListEventTypesFilterNameType

PaginatorConfigTypeDef

Usage Example

from mypy_boto3_codestar_notifications.type_defs import PaginatorConfigTypeDef

def get_value() -> PaginatorConfigTypeDef:
    return {
        "MaxItems": ...,
    }

Definition

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

ListNotificationRulesFilterTypeDef

Usage Example

from mypy_boto3_codestar_notifications.type_defs import ListNotificationRulesFilterTypeDef

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

Definition

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

1. See ListNotificationRulesFilterNameType

NotificationRuleSummaryTypeDef

Usage Example

from mypy_boto3_codestar_notifications.type_defs import NotificationRuleSummaryTypeDef

def get_value() -> NotificationRuleSummaryTypeDef:
    return {
        "Id": ...,
    }

Definition

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

ListTagsForResourceRequestRequestTypeDef

Usage Example

from mypy_boto3_codestar_notifications.type_defs import ListTagsForResourceRequestRequestTypeDef

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

Definition

class ListTagsForResourceRequestRequestTypeDef(TypedDict):
    Arn: str,

ListTargetsFilterTypeDef

Usage Example

from mypy_boto3_codestar_notifications.type_defs import ListTargetsFilterTypeDef

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

Definition

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

1. See ListTargetsFilterNameType

TagResourceRequestRequestTypeDef

Usage Example

from mypy_boto3_codestar_notifications.type_defs import TagResourceRequestRequestTypeDef

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

Definition

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

UnsubscribeRequestRequestTypeDef

Usage Example

from mypy_boto3_codestar_notifications.type_defs import UnsubscribeRequestRequestTypeDef

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

Definition

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

UntagResourceRequestRequestTypeDef

Usage Example

from mypy_boto3_codestar_notifications.type_defs import UntagResourceRequestRequestTypeDef

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

Definition

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

CreateNotificationRuleRequestRequestTypeDef

Usage Example

from mypy_boto3_codestar_notifications.type_defs import CreateNotificationRuleRequestRequestTypeDef

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

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

Usage Example

from mypy_boto3_codestar_notifications.type_defs import SubscribeRequestRequestTypeDef

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

Definition

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

1. See TargetTypeDef

UpdateNotificationRuleRequestRequestTypeDef

Usage Example

from mypy_boto3_codestar_notifications.type_defs import UpdateNotificationRuleRequestRequestTypeDef

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

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

Usage Example

from mypy_boto3_codestar_notifications.type_defs import CreateNotificationRuleResultTypeDef

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

Definition

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

1. See ResponseMetadataTypeDef

DeleteNotificationRuleResultTypeDef

Usage Example

from mypy_boto3_codestar_notifications.type_defs import DeleteNotificationRuleResultTypeDef

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

Definition

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

1. See ResponseMetadataTypeDef

ListTagsForResourceResultTypeDef

Usage Example

from mypy_boto3_codestar_notifications.type_defs import ListTagsForResourceResultTypeDef

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

Definition

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

1. See ResponseMetadataTypeDef

SubscribeResultTypeDef

Usage Example

from mypy_boto3_codestar_notifications.type_defs import SubscribeResultTypeDef

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

Definition

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

1. See ResponseMetadataTypeDef

TagResourceResultTypeDef

Usage Example

from mypy_boto3_codestar_notifications.type_defs import TagResourceResultTypeDef

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

Definition

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

1. See ResponseMetadataTypeDef

UnsubscribeResultTypeDef

Usage Example

from mypy_boto3_codestar_notifications.type_defs import UnsubscribeResultTypeDef

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

Definition

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

1. See ResponseMetadataTypeDef

ListEventTypesResultTypeDef

Usage Example

from mypy_boto3_codestar_notifications.type_defs import ListEventTypesResultTypeDef

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

Definition

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

1. See EventTypeSummaryTypeDef
2. See ResponseMetadataTypeDef

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": ...,
    }

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

Usage Example

from mypy_boto3_codestar_notifications.type_defs import ListTargetsResultTypeDef

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

Definition

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

1. See TargetSummaryTypeDef
2. See ResponseMetadataTypeDef

ListEventTypesRequestRequestTypeDef

Usage Example

from mypy_boto3_codestar_notifications.type_defs import ListEventTypesRequestRequestTypeDef

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

Definition

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

1. See ListEventTypesFilterTypeDef

ListEventTypesRequestListEventTypesPaginateTypeDef

Usage Example

from mypy_boto3_codestar_notifications.type_defs import ListEventTypesRequestListEventTypesPaginateTypeDef

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

Definition

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

1. See ListEventTypesFilterTypeDef
2. See PaginatorConfigTypeDef

ListNotificationRulesRequestListNotificationRulesPaginateTypeDef

Usage Example

from mypy_boto3_codestar_notifications.type_defs import ListNotificationRulesRequestListNotificationRulesPaginateTypeDef

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

Definition

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

1. See ListNotificationRulesFilterTypeDef
2. See PaginatorConfigTypeDef

ListNotificationRulesRequestRequestTypeDef

Usage Example

from mypy_boto3_codestar_notifications.type_defs import ListNotificationRulesRequestRequestTypeDef

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

Definition

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

1. See ListNotificationRulesFilterTypeDef

ListNotificationRulesResultTypeDef

Usage Example

from mypy_boto3_codestar_notifications.type_defs import ListNotificationRulesResultTypeDef

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

Definition

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

1. See NotificationRuleSummaryTypeDef
2. See ResponseMetadataTypeDef

ListTargetsRequestListTargetsPaginateTypeDef

Usage Example

from mypy_boto3_codestar_notifications.type_defs import ListTargetsRequestListTargetsPaginateTypeDef

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

Definition

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

1. See ListTargetsFilterTypeDef
2. See PaginatorConfigTypeDef

ListTargetsRequestRequestTypeDef

Usage Example

from mypy_boto3_codestar_notifications.type_defs import ListTargetsRequestRequestTypeDef

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

Definition

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

1. See ListTargetsFilterTypeDef