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

BatchGetIncidentFindingsErrorTypeDef#

# BatchGetIncidentFindingsErrorTypeDef definition

class BatchGetIncidentFindingsErrorTypeDef(TypedDict):
    code: str,
    findingId: str,
    message: str,

BatchGetIncidentFindingsInputRequestTypeDef#

# BatchGetIncidentFindingsInputRequestTypeDef definition

class BatchGetIncidentFindingsInputRequestTypeDef(TypedDict):
    findingIds: Sequence[str],
    incidentRecordArn: str,

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

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

ChatChannelTypeDef#

# ChatChannelTypeDef definition

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

CloudFormationStackUpdateTypeDef#

# CloudFormationStackUpdateTypeDef definition

class CloudFormationStackUpdateTypeDef(TypedDict):
    stackArn: str,
    startTime: datetime,
    endTime: NotRequired[datetime],

CodeDeployDeploymentTypeDef#

# CodeDeployDeploymentTypeDef definition

class CodeDeployDeploymentTypeDef(TypedDict):
    deploymentGroupArn: str,
    deploymentId: str,
    startTime: datetime,
    endTime: NotRequired[datetime],

RegionMapInputValueTypeDef#

# RegionMapInputValueTypeDef definition

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

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

FindingSummaryTypeDef#

# FindingSummaryTypeDef definition

class FindingSummaryTypeDef(TypedDict):
    id: str,
    lastModifiedTime: datetime,

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

ListIncidentFindingsInputRequestTypeDef#

# ListIncidentFindingsInputRequestTypeDef definition

class ListIncidentFindingsInputRequestTypeDef(TypedDict):
    incidentRecordArn: str,
    maxResults: NotRequired[int],
    nextToken: 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],

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

FindingDetailsTypeDef#

# FindingDetailsTypeDef definition

class FindingDetailsTypeDef(TypedDict):
    cloudFormationStackUpdate: NotRequired[CloudFormationStackUpdateTypeDef],  # (1)
    codeDeployDeployment: NotRequired[CodeDeployDeploymentTypeDef],  # (2)
  1. See CloudFormationStackUpdateTypeDef
  2. See CodeDeployDeploymentTypeDef

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

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

ListIncidentFindingsOutputTypeDef#

# ListIncidentFindingsOutputTypeDef definition

class ListIncidentFindingsOutputTypeDef(TypedDict):
    findings: List[FindingSummaryTypeDef],  # (1)
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See FindingSummaryTypeDef
  2. See ResponseMetadataTypeDef

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