Skip to content

Type definitions#

Index > SSMIncidents > Type definitions

Auto-generated documentation for SSMIncidents type annotations stubs module mypy-boto3-ssm-incidents.

TimestampTypeDef#

# TimestampTypeDef definition

TimestampTypeDef = Union[
    datetime,
    str,
]

AddRegionActionTypeDef#

# AddRegionActionTypeDef definition

class AddRegionActionTypeDef(TypedDict):
    regionName: str,
    sseKmsKeyId: NotRequired[str],

AttributeValueListTypeDef#

# AttributeValueListTypeDef definition

class AttributeValueListTypeDef(TypedDict):
    integerValues: NotRequired[Sequence[int]],
    stringValues: NotRequired[Sequence[str]],

AutomationExecutionTypeDef#

# AutomationExecutionTypeDef definition

class AutomationExecutionTypeDef(TypedDict):
    ssmExecutionArn: NotRequired[str],

ChatChannelTypeDef#

# ChatChannelTypeDef definition

class ChatChannelTypeDef(TypedDict):
    chatbotSns: NotRequired[Sequence[str]],
    empty: NotRequired[Mapping[str, Any]],

RegionMapInputValueTypeDef#

# RegionMapInputValueTypeDef definition

class RegionMapInputValueTypeDef(TypedDict):
    sseKmsKeyId: NotRequired[str],

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

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

EventReferenceTypeDef#

# EventReferenceTypeDef definition

class EventReferenceTypeDef(TypedDict):
    relatedItemId: NotRequired[str],
    resource: NotRequired[str],

DeleteIncidentRecordInputRequestTypeDef#

# DeleteIncidentRecordInputRequestTypeDef definition

class DeleteIncidentRecordInputRequestTypeDef(TypedDict):
    arn: str,

DeleteRegionActionTypeDef#

# DeleteRegionActionTypeDef definition

class DeleteRegionActionTypeDef(TypedDict):
    regionName: str,

DeleteReplicationSetInputRequestTypeDef#

# DeleteReplicationSetInputRequestTypeDef definition

class DeleteReplicationSetInputRequestTypeDef(TypedDict):
    arn: str,

DeleteResourcePolicyInputRequestTypeDef#

# DeleteResourcePolicyInputRequestTypeDef definition

class DeleteResourcePolicyInputRequestTypeDef(TypedDict):
    policyId: str,
    resourceArn: str,

DeleteResponsePlanInputRequestTypeDef#

# DeleteResponsePlanInputRequestTypeDef definition

class DeleteResponsePlanInputRequestTypeDef(TypedDict):
    arn: str,

DeleteTimelineEventInputRequestTypeDef#

# DeleteTimelineEventInputRequestTypeDef definition

class DeleteTimelineEventInputRequestTypeDef(TypedDict):
    eventId: str,
    incidentRecordArn: str,

DynamicSsmParameterValueTypeDef#

# DynamicSsmParameterValueTypeDef definition

class DynamicSsmParameterValueTypeDef(TypedDict):
    variable: NotRequired[VariableTypeType],  # (1)
  1. See VariableTypeType

GetIncidentRecordInputRequestTypeDef#

# GetIncidentRecordInputRequestTypeDef definition

class GetIncidentRecordInputRequestTypeDef(TypedDict):
    arn: str,

GetReplicationSetInputRequestTypeDef#

# GetReplicationSetInputRequestTypeDef definition

class GetReplicationSetInputRequestTypeDef(TypedDict):
    arn: str,

WaiterConfigTypeDef#

# WaiterConfigTypeDef definition

class WaiterConfigTypeDef(TypedDict):
    Delay: NotRequired[int],
    MaxAttempts: NotRequired[int],

PaginatorConfigTypeDef#

# PaginatorConfigTypeDef definition

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

GetResourcePoliciesInputRequestTypeDef#

# GetResourcePoliciesInputRequestTypeDef definition

class GetResourcePoliciesInputRequestTypeDef(TypedDict):
    resourceArn: str,
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],

ResourcePolicyTypeDef#

# ResourcePolicyTypeDef definition

class ResourcePolicyTypeDef(TypedDict):
    policyDocument: str,
    policyId: str,
    ramResourceShareRegion: str,

GetResponsePlanInputRequestTypeDef#

# GetResponsePlanInputRequestTypeDef definition

class GetResponsePlanInputRequestTypeDef(TypedDict):
    arn: str,

GetTimelineEventInputRequestTypeDef#

# GetTimelineEventInputRequestTypeDef definition

class GetTimelineEventInputRequestTypeDef(TypedDict):
    eventId: str,
    incidentRecordArn: str,

IncidentRecordSourceTypeDef#

# IncidentRecordSourceTypeDef definition

class IncidentRecordSourceTypeDef(TypedDict):
    createdBy: str,
    source: str,
    invokedBy: NotRequired[str],
    resourceArn: NotRequired[str],

NotificationTargetItemTypeDef#

# NotificationTargetItemTypeDef definition

class NotificationTargetItemTypeDef(TypedDict):
    snsTopicArn: NotRequired[str],

PagerDutyIncidentDetailTypeDef#

# PagerDutyIncidentDetailTypeDef definition

class PagerDutyIncidentDetailTypeDef(TypedDict):
    id: str,
    autoResolve: NotRequired[bool],
    secretId: NotRequired[str],

ListRelatedItemsInputRequestTypeDef#

# ListRelatedItemsInputRequestTypeDef definition

class ListRelatedItemsInputRequestTypeDef(TypedDict):
    incidentRecordArn: str,
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],

ListReplicationSetsInputRequestTypeDef#

# ListReplicationSetsInputRequestTypeDef definition

class ListReplicationSetsInputRequestTypeDef(TypedDict):
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],

ListResponsePlansInputRequestTypeDef#

# ListResponsePlansInputRequestTypeDef definition

class ListResponsePlansInputRequestTypeDef(TypedDict):
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],

ResponsePlanSummaryTypeDef#

# ResponsePlanSummaryTypeDef definition

class ResponsePlanSummaryTypeDef(TypedDict):
    arn: str,
    name: str,
    displayName: NotRequired[str],

ListTagsForResourceRequestRequestTypeDef#

# ListTagsForResourceRequestRequestTypeDef definition

class ListTagsForResourceRequestRequestTypeDef(TypedDict):
    resourceArn: str,

PagerDutyIncidentConfigurationTypeDef#

# PagerDutyIncidentConfigurationTypeDef definition

class PagerDutyIncidentConfigurationTypeDef(TypedDict):
    serviceId: str,

PutResourcePolicyInputRequestTypeDef#

# PutResourcePolicyInputRequestTypeDef definition

class PutResourcePolicyInputRequestTypeDef(TypedDict):
    policy: str,
    resourceArn: str,

RegionInfoTypeDef#

# RegionInfoTypeDef definition

class RegionInfoTypeDef(TypedDict):
    status: RegionStatusType,  # (1)
    statusUpdateDateTime: datetime,
    sseKmsKeyId: NotRequired[str],
    statusMessage: NotRequired[str],
  1. See RegionStatusType

TagResourceRequestRequestTypeDef#

# TagResourceRequestRequestTypeDef definition

class TagResourceRequestRequestTypeDef(TypedDict):
    resourceArn: str,
    tags: Mapping[str, str],

UntagResourceRequestRequestTypeDef#

# UntagResourceRequestRequestTypeDef definition

class UntagResourceRequestRequestTypeDef(TypedDict):
    resourceArn: str,
    tagKeys: Sequence[str],

UpdateDeletionProtectionInputRequestTypeDef#

# UpdateDeletionProtectionInputRequestTypeDef definition

class UpdateDeletionProtectionInputRequestTypeDef(TypedDict):
    arn: str,
    deletionProtected: bool,
    clientToken: NotRequired[str],

ConditionTypeDef#

# ConditionTypeDef definition

class ConditionTypeDef(TypedDict):
    after: NotRequired[Union[datetime, str]],
    before: NotRequired[Union[datetime, str]],
    equals: NotRequired[AttributeValueListTypeDef],  # (1)
  1. See AttributeValueListTypeDef

TriggerDetailsTypeDef#

# TriggerDetailsTypeDef definition

class TriggerDetailsTypeDef(TypedDict):
    source: str,
    timestamp: Union[datetime, str],
    rawData: NotRequired[str],
    triggerArn: NotRequired[str],

CreateReplicationSetInputRequestTypeDef#

# CreateReplicationSetInputRequestTypeDef definition

class CreateReplicationSetInputRequestTypeDef(TypedDict):
    regions: Mapping[str, RegionMapInputValueTypeDef],  # (1)
    clientToken: NotRequired[str],
    tags: NotRequired[Mapping[str, str]],
  1. See RegionMapInputValueTypeDef

CreateReplicationSetOutputTypeDef#

# CreateReplicationSetOutputTypeDef definition

class CreateReplicationSetOutputTypeDef(TypedDict):
    arn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateResponsePlanOutputTypeDef#

# CreateResponsePlanOutputTypeDef definition

class CreateResponsePlanOutputTypeDef(TypedDict):
    arn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateTimelineEventOutputTypeDef#

# CreateTimelineEventOutputTypeDef definition

class CreateTimelineEventOutputTypeDef(TypedDict):
    eventId: str,
    incidentRecordArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

ListReplicationSetsOutputTypeDef#

# ListReplicationSetsOutputTypeDef definition

class ListReplicationSetsOutputTypeDef(TypedDict):
    nextToken: str,
    replicationSetArns: List[str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

ListTagsForResourceResponseTypeDef#

# ListTagsForResourceResponseTypeDef definition

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

PutResourcePolicyOutputTypeDef#

# PutResourcePolicyOutputTypeDef definition

class PutResourcePolicyOutputTypeDef(TypedDict):
    policyId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

StartIncidentOutputTypeDef#

# StartIncidentOutputTypeDef definition

class StartIncidentOutputTypeDef(TypedDict):
    incidentRecordArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateTimelineEventInputRequestTypeDef#

# CreateTimelineEventInputRequestTypeDef definition

class CreateTimelineEventInputRequestTypeDef(TypedDict):
    eventData: str,
    eventTime: Union[datetime, str],
    eventType: str,
    incidentRecordArn: str,
    clientToken: NotRequired[str],
    eventReferences: NotRequired[Sequence[EventReferenceTypeDef]],  # (1)
  1. See EventReferenceTypeDef

EventSummaryTypeDef#

# EventSummaryTypeDef definition

class EventSummaryTypeDef(TypedDict):
    eventId: str,
    eventTime: datetime,
    eventType: str,
    eventUpdatedTime: datetime,
    incidentRecordArn: str,
    eventReferences: NotRequired[List[EventReferenceTypeDef]],  # (1)
  1. See EventReferenceTypeDef

TimelineEventTypeDef#

# TimelineEventTypeDef definition

class TimelineEventTypeDef(TypedDict):
    eventData: str,
    eventId: str,
    eventTime: datetime,
    eventType: str,
    eventUpdatedTime: datetime,
    incidentRecordArn: str,
    eventReferences: NotRequired[List[EventReferenceTypeDef]],  # (1)
  1. See EventReferenceTypeDef

UpdateTimelineEventInputRequestTypeDef#

# UpdateTimelineEventInputRequestTypeDef definition

class UpdateTimelineEventInputRequestTypeDef(TypedDict):
    eventId: str,
    incidentRecordArn: str,
    clientToken: NotRequired[str],
    eventData: NotRequired[str],
    eventReferences: NotRequired[Sequence[EventReferenceTypeDef]],  # (1)
    eventTime: NotRequired[Union[datetime, str]],
    eventType: NotRequired[str],
  1. See EventReferenceTypeDef

UpdateReplicationSetActionTypeDef#

# UpdateReplicationSetActionTypeDef definition

class UpdateReplicationSetActionTypeDef(TypedDict):
    addRegionAction: NotRequired[AddRegionActionTypeDef],  # (1)
    deleteRegionAction: NotRequired[DeleteRegionActionTypeDef],  # (2)
  1. See AddRegionActionTypeDef
  2. See DeleteRegionActionTypeDef

SsmAutomationTypeDef#

# SsmAutomationTypeDef definition

class SsmAutomationTypeDef(TypedDict):
    documentName: str,
    roleArn: str,
    documentVersion: NotRequired[str],
    dynamicParameters: NotRequired[Mapping[str, DynamicSsmParameterValueTypeDef]],  # (1)
    parameters: NotRequired[Mapping[str, Sequence[str]]],
    targetAccount: NotRequired[SsmTargetAccountType],  # (2)
  1. See DynamicSsmParameterValueTypeDef
  2. See SsmTargetAccountType

GetReplicationSetInputWaitForReplicationSetActiveWaitTypeDef#

# GetReplicationSetInputWaitForReplicationSetActiveWaitTypeDef definition

class GetReplicationSetInputWaitForReplicationSetActiveWaitTypeDef(TypedDict):
    arn: str,
    WaiterConfig: NotRequired[WaiterConfigTypeDef],  # (1)
  1. See WaiterConfigTypeDef

GetReplicationSetInputWaitForReplicationSetDeletedWaitTypeDef#

# GetReplicationSetInputWaitForReplicationSetDeletedWaitTypeDef definition

class GetReplicationSetInputWaitForReplicationSetDeletedWaitTypeDef(TypedDict):
    arn: str,
    WaiterConfig: NotRequired[WaiterConfigTypeDef],  # (1)
  1. See WaiterConfigTypeDef

GetResourcePoliciesInputGetResourcePoliciesPaginateTypeDef#

# GetResourcePoliciesInputGetResourcePoliciesPaginateTypeDef definition

class GetResourcePoliciesInputGetResourcePoliciesPaginateTypeDef(TypedDict):
    resourceArn: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListRelatedItemsInputListRelatedItemsPaginateTypeDef#

# ListRelatedItemsInputListRelatedItemsPaginateTypeDef definition

class ListRelatedItemsInputListRelatedItemsPaginateTypeDef(TypedDict):
    incidentRecordArn: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListReplicationSetsInputListReplicationSetsPaginateTypeDef#

# ListReplicationSetsInputListReplicationSetsPaginateTypeDef definition

class ListReplicationSetsInputListReplicationSetsPaginateTypeDef(TypedDict):
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListResponsePlansInputListResponsePlansPaginateTypeDef#

# ListResponsePlansInputListResponsePlansPaginateTypeDef definition

class ListResponsePlansInputListResponsePlansPaginateTypeDef(TypedDict):
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

GetResourcePoliciesOutputTypeDef#

# GetResourcePoliciesOutputTypeDef definition

class GetResourcePoliciesOutputTypeDef(TypedDict):
    nextToken: str,
    resourcePolicies: List[ResourcePolicyTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ResourcePolicyTypeDef
  2. See ResponseMetadataTypeDef

IncidentRecordSummaryTypeDef#

# IncidentRecordSummaryTypeDef definition

class IncidentRecordSummaryTypeDef(TypedDict):
    arn: str,
    creationTime: datetime,
    impact: int,
    incidentRecordSource: IncidentRecordSourceTypeDef,  # (1)
    status: IncidentRecordStatusType,  # (2)
    title: str,
    resolvedTime: NotRequired[datetime],
  1. See IncidentRecordSourceTypeDef
  2. See IncidentRecordStatusType

IncidentRecordTypeDef#

# IncidentRecordTypeDef definition

class IncidentRecordTypeDef(TypedDict):
    arn: str,
    creationTime: datetime,
    dedupeString: str,
    impact: int,
    incidentRecordSource: IncidentRecordSourceTypeDef,  # (3)
    lastModifiedBy: str,
    lastModifiedTime: datetime,
    status: IncidentRecordStatusType,  # (5)
    title: str,
    automationExecutions: NotRequired[List[AutomationExecutionTypeDef]],  # (1)
    chatChannel: NotRequired[ChatChannelTypeDef],  # (2)
    notificationTargets: NotRequired[List[NotificationTargetItemTypeDef]],  # (4)
    resolvedTime: NotRequired[datetime],
    summary: NotRequired[str],
  1. See AutomationExecutionTypeDef
  2. See ChatChannelTypeDef
  3. See IncidentRecordSourceTypeDef
  4. See NotificationTargetItemTypeDef
  5. See IncidentRecordStatusType

IncidentTemplateTypeDef#

# IncidentTemplateTypeDef definition

class IncidentTemplateTypeDef(TypedDict):
    impact: int,
    title: str,
    dedupeString: NotRequired[str],
    incidentTags: NotRequired[Mapping[str, str]],
    notificationTargets: NotRequired[Sequence[NotificationTargetItemTypeDef]],  # (1)
    summary: NotRequired[str],
  1. See NotificationTargetItemTypeDef

UpdateIncidentRecordInputRequestTypeDef#

# UpdateIncidentRecordInputRequestTypeDef definition

class UpdateIncidentRecordInputRequestTypeDef(TypedDict):
    arn: str,
    chatChannel: NotRequired[ChatChannelTypeDef],  # (1)
    clientToken: NotRequired[str],
    impact: NotRequired[int],
    notificationTargets: NotRequired[Sequence[NotificationTargetItemTypeDef]],  # (2)
    status: NotRequired[IncidentRecordStatusType],  # (3)
    summary: NotRequired[str],
    title: NotRequired[str],
  1. See ChatChannelTypeDef
  2. See NotificationTargetItemTypeDef
  3. See IncidentRecordStatusType

ItemValueTypeDef#

# ItemValueTypeDef definition

class ItemValueTypeDef(TypedDict):
    arn: NotRequired[str],
    metricDefinition: NotRequired[str],
    pagerDutyIncidentDetail: NotRequired[PagerDutyIncidentDetailTypeDef],  # (1)
    url: NotRequired[str],
  1. See PagerDutyIncidentDetailTypeDef

ListResponsePlansOutputTypeDef#

# ListResponsePlansOutputTypeDef definition

class ListResponsePlansOutputTypeDef(TypedDict):
    nextToken: str,
    responsePlanSummaries: List[ResponsePlanSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ResponsePlanSummaryTypeDef
  2. See ResponseMetadataTypeDef

PagerDutyConfigurationTypeDef#

# PagerDutyConfigurationTypeDef definition

class PagerDutyConfigurationTypeDef(TypedDict):
    name: str,
    pagerDutyIncidentConfiguration: PagerDutyIncidentConfigurationTypeDef,  # (1)
    secretId: str,
  1. See PagerDutyIncidentConfigurationTypeDef

ReplicationSetTypeDef#

# ReplicationSetTypeDef definition

class ReplicationSetTypeDef(TypedDict):
    createdBy: str,
    createdTime: datetime,
    deletionProtected: bool,
    lastModifiedBy: str,
    lastModifiedTime: datetime,
    regionMap: Dict[str, RegionInfoTypeDef],  # (1)
    status: ReplicationSetStatusType,  # (2)
    arn: NotRequired[str],
  1. See RegionInfoTypeDef
  2. See ReplicationSetStatusType

FilterTypeDef#

# FilterTypeDef definition

class FilterTypeDef(TypedDict):
    condition: ConditionTypeDef,  # (1)
    key: str,
  1. See ConditionTypeDef

ListTimelineEventsOutputTypeDef#

# ListTimelineEventsOutputTypeDef definition

class ListTimelineEventsOutputTypeDef(TypedDict):
    eventSummaries: List[EventSummaryTypeDef],  # (1)
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See EventSummaryTypeDef
  2. See ResponseMetadataTypeDef

GetTimelineEventOutputTypeDef#

# GetTimelineEventOutputTypeDef definition

class GetTimelineEventOutputTypeDef(TypedDict):
    event: TimelineEventTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See TimelineEventTypeDef
  2. See ResponseMetadataTypeDef

UpdateReplicationSetInputRequestTypeDef#

# UpdateReplicationSetInputRequestTypeDef definition

class UpdateReplicationSetInputRequestTypeDef(TypedDict):
    actions: Sequence[UpdateReplicationSetActionTypeDef],  # (1)
    arn: str,
    clientToken: NotRequired[str],
  1. See UpdateReplicationSetActionTypeDef

ActionTypeDef#

# ActionTypeDef definition

class ActionTypeDef(TypedDict):
    ssmAutomation: NotRequired[SsmAutomationTypeDef],  # (1)
  1. See SsmAutomationTypeDef

ListIncidentRecordsOutputTypeDef#

# ListIncidentRecordsOutputTypeDef definition

class ListIncidentRecordsOutputTypeDef(TypedDict):
    incidentRecordSummaries: List[IncidentRecordSummaryTypeDef],  # (1)
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See IncidentRecordSummaryTypeDef
  2. See ResponseMetadataTypeDef

GetIncidentRecordOutputTypeDef#

# GetIncidentRecordOutputTypeDef definition

class GetIncidentRecordOutputTypeDef(TypedDict):
    incidentRecord: IncidentRecordTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See IncidentRecordTypeDef
  2. See ResponseMetadataTypeDef

ItemIdentifierTypeDef#

# ItemIdentifierTypeDef definition

class ItemIdentifierTypeDef(TypedDict):
    type: ItemTypeType,  # (1)
    value: ItemValueTypeDef,  # (2)
  1. See ItemTypeType
  2. See ItemValueTypeDef

IntegrationTypeDef#

# IntegrationTypeDef definition

class IntegrationTypeDef(TypedDict):
    pagerDutyConfiguration: NotRequired[PagerDutyConfigurationTypeDef],  # (1)
  1. See PagerDutyConfigurationTypeDef

GetReplicationSetOutputTypeDef#

# GetReplicationSetOutputTypeDef definition

class GetReplicationSetOutputTypeDef(TypedDict):
    replicationSet: ReplicationSetTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ReplicationSetTypeDef
  2. See ResponseMetadataTypeDef

ListIncidentRecordsInputListIncidentRecordsPaginateTypeDef#

# ListIncidentRecordsInputListIncidentRecordsPaginateTypeDef definition

class ListIncidentRecordsInputListIncidentRecordsPaginateTypeDef(TypedDict):
    filters: NotRequired[Sequence[FilterTypeDef]],  # (1)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)
  1. See FilterTypeDef
  2. See PaginatorConfigTypeDef

ListIncidentRecordsInputRequestTypeDef#

# ListIncidentRecordsInputRequestTypeDef definition

class ListIncidentRecordsInputRequestTypeDef(TypedDict):
    filters: NotRequired[Sequence[FilterTypeDef]],  # (1)
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],
  1. See FilterTypeDef

ListTimelineEventsInputListTimelineEventsPaginateTypeDef#

# ListTimelineEventsInputListTimelineEventsPaginateTypeDef definition

class ListTimelineEventsInputListTimelineEventsPaginateTypeDef(TypedDict):
    incidentRecordArn: str,
    filters: NotRequired[Sequence[FilterTypeDef]],  # (1)
    sortBy: NotRequired[TimelineEventSortType],  # (2)
    sortOrder: NotRequired[SortOrderType],  # (3)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (4)
  1. See FilterTypeDef
  2. See TimelineEventSortType
  3. See SortOrderType
  4. See PaginatorConfigTypeDef

ListTimelineEventsInputRequestTypeDef#

# ListTimelineEventsInputRequestTypeDef definition

class ListTimelineEventsInputRequestTypeDef(TypedDict):
    incidentRecordArn: str,
    filters: NotRequired[Sequence[FilterTypeDef]],  # (1)
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],
    sortBy: NotRequired[TimelineEventSortType],  # (2)
    sortOrder: NotRequired[SortOrderType],  # (3)
  1. See FilterTypeDef
  2. See TimelineEventSortType
  3. See SortOrderType

RelatedItemTypeDef#

# RelatedItemTypeDef definition

class RelatedItemTypeDef(TypedDict):
    identifier: ItemIdentifierTypeDef,  # (1)
    generatedId: NotRequired[str],
    title: NotRequired[str],
  1. See ItemIdentifierTypeDef

CreateResponsePlanInputRequestTypeDef#

# CreateResponsePlanInputRequestTypeDef definition

class CreateResponsePlanInputRequestTypeDef(TypedDict):
    incidentTemplate: IncidentTemplateTypeDef,  # (1)
    name: str,
    actions: NotRequired[Sequence[ActionTypeDef]],  # (2)
    chatChannel: NotRequired[ChatChannelTypeDef],  # (3)
    clientToken: NotRequired[str],
    displayName: NotRequired[str],
    engagements: NotRequired[Sequence[str]],
    integrations: NotRequired[Sequence[IntegrationTypeDef]],  # (4)
    tags: NotRequired[Mapping[str, str]],
  1. See IncidentTemplateTypeDef
  2. See ActionTypeDef
  3. See ChatChannelTypeDef
  4. See IntegrationTypeDef

GetResponsePlanOutputTypeDef#

# GetResponsePlanOutputTypeDef definition

class GetResponsePlanOutputTypeDef(TypedDict):
    actions: List[ActionTypeDef],  # (1)
    arn: str,
    chatChannel: ChatChannelTypeDef,  # (2)
    displayName: str,
    engagements: List[str],
    incidentTemplate: IncidentTemplateTypeDef,  # (3)
    integrations: List[IntegrationTypeDef],  # (4)
    name: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (5)
  1. See ActionTypeDef
  2. See ChatChannelTypeDef
  3. See IncidentTemplateTypeDef
  4. See IntegrationTypeDef
  5. See ResponseMetadataTypeDef

UpdateResponsePlanInputRequestTypeDef#

# UpdateResponsePlanInputRequestTypeDef definition

class UpdateResponsePlanInputRequestTypeDef(TypedDict):
    arn: str,
    actions: NotRequired[Sequence[ActionTypeDef]],  # (1)
    chatChannel: NotRequired[ChatChannelTypeDef],  # (2)
    clientToken: NotRequired[str],
    displayName: NotRequired[str],
    engagements: NotRequired[Sequence[str]],
    incidentTemplateDedupeString: NotRequired[str],
    incidentTemplateImpact: NotRequired[int],
    incidentTemplateNotificationTargets: NotRequired[Sequence[NotificationTargetItemTypeDef]],  # (3)
    incidentTemplateSummary: NotRequired[str],
    incidentTemplateTags: NotRequired[Mapping[str, str]],
    incidentTemplateTitle: NotRequired[str],
    integrations: NotRequired[Sequence[IntegrationTypeDef]],  # (4)
  1. See ActionTypeDef
  2. See ChatChannelTypeDef
  3. See NotificationTargetItemTypeDef
  4. See IntegrationTypeDef

ListRelatedItemsOutputTypeDef#

# ListRelatedItemsOutputTypeDef definition

class ListRelatedItemsOutputTypeDef(TypedDict):
    nextToken: str,
    relatedItems: List[RelatedItemTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See RelatedItemTypeDef
  2. See ResponseMetadataTypeDef

RelatedItemsUpdateTypeDef#

# RelatedItemsUpdateTypeDef definition

class RelatedItemsUpdateTypeDef(TypedDict):
    itemToAdd: NotRequired[RelatedItemTypeDef],  # (1)
    itemToRemove: NotRequired[ItemIdentifierTypeDef],  # (2)
  1. See RelatedItemTypeDef
  2. See ItemIdentifierTypeDef

StartIncidentInputRequestTypeDef#

# StartIncidentInputRequestTypeDef definition

class StartIncidentInputRequestTypeDef(TypedDict):
    responsePlanArn: str,
    clientToken: NotRequired[str],
    impact: NotRequired[int],
    relatedItems: NotRequired[Sequence[RelatedItemTypeDef]],  # (1)
    title: NotRequired[str],
    triggerDetails: NotRequired[TriggerDetailsTypeDef],  # (2)
  1. See RelatedItemTypeDef
  2. See TriggerDetailsTypeDef

UpdateRelatedItemsInputRequestTypeDef#

# UpdateRelatedItemsInputRequestTypeDef definition

class UpdateRelatedItemsInputRequestTypeDef(TypedDict):
    incidentRecordArn: str,
    relatedItemsUpdate: RelatedItemsUpdateTypeDef,  # (1)
    clientToken: NotRequired[str],
  1. See RelatedItemsUpdateTypeDef