SSMIncidents module#
Index > SSMIncidents
Auto-generated documentation for SSMIncidents type annotations stubs module mypy-boto3-ssm-incidents.
How to install#
VSCode extension#
Add AWS Boto3
extension to your VSCode and run AWS boto3: Quick Start
command.
Click Modify
and select boto3 common
and SSMIncidents
.
From PyPI with pip#
Install boto3-stubs
for SSMIncidents
service.
# install with boto3 type annotations
python -m pip install 'boto3-stubs[ssm-incidents]'
# Lite version does not provide session.client/resource overloads
# it is more RAM-friendly, but requires explicit type annotations
python -m pip install 'boto3-stubs-lite[ssm-incidents]'
# standalone installation
python -m pip install mypy-boto3-ssm-incidents
How to uninstall#
python -m pip uninstall -y mypy-boto3-ssm-incidents
Usage#
Code samples can be found in Examples.
SSMIncidentsClient#
Type annotations and code completion for boto3.client("ssm-incidents")
as SSMIncidentsClient
boto3 documentation
# SSMIncidentsClient usage example
from boto3.session import Session
from mypy_boto3_ssm_incidents.client import SSMIncidentsClient
def get_client() -> SSMIncidentsClient:
return Session().client("ssm-incidents")
Paginators#
Type annotations and code completion for paginators
from boto3.client("ssm-incidents").get_paginator("...")
.
# GetResourcePoliciesPaginator usage example
from boto3.session import Session
from mypy_boto3_ssm_incidents.paginator import GetResourcePoliciesPaginator
def get_get_resource_policies_paginator() -> GetResourcePoliciesPaginator:
return Session().client("ssm-incidents").get_paginator("get_resource_policies"))
- GetResourcePoliciesPaginator
- ListIncidentRecordsPaginator
- ListRelatedItemsPaginator
- ListReplicationSetsPaginator
- ListResponsePlansPaginator
- ListTimelineEventsPaginator
Waiters#
Type annotations and code completion for waiters
from boto3.client("ssm-incidents").get_waiter("...")
.
# WaitForReplicationSetActiveWaiter usage example
from boto3.session import Session
from mypy_boto3_ssm_incidents.waiter import WaitForReplicationSetActiveWaiter
def get_wait_for_replication_set_active_waiter() -> WaitForReplicationSetActiveWaiter:
return Session().client("ssm-incidents").get_waiter("wait_for_replication_set_active")
Literals#
Type annotations for literals used in methods and schemas.
# GetResourcePoliciesPaginatorName usage example
from mypy_boto3_ssm_incidents.literals import GetResourcePoliciesPaginatorName
def get_value() -> GetResourcePoliciesPaginatorName:
return "get_resource_policies"
- GetResourcePoliciesPaginatorName
- IncidentRecordStatusType
- ItemTypeType
- ListIncidentRecordsPaginatorName
- ListRelatedItemsPaginatorName
- ListReplicationSetsPaginatorName
- ListResponsePlansPaginatorName
- ListTimelineEventsPaginatorName
- RegionStatusType
- ReplicationSetStatusType
- SortOrderType
- SsmTargetAccountType
- TimelineEventSortType
- VariableTypeType
- WaitForReplicationSetActiveWaiterName
- WaitForReplicationSetDeletedWaiterName
- SSMIncidentsServiceName
- ServiceName
- ResourceServiceName
- PaginatorName
- WaiterName
- RegionName
Typed dictionaries#
Type annotations for typed dictionaries used in methods and schema.
# AddRegionActionTypeDef usage example
from mypy_boto3_ssm_incidents.type_defs import AddRegionActionTypeDef
def get_value() -> AddRegionActionTypeDef:
return {
"regionName": ...,
}
- AddRegionActionTypeDef
- AttributeValueListTypeDef
- AutomationExecutionTypeDef
- ChatChannelTypeDef
- RegionMapInputValueTypeDef
- CreateReplicationSetOutputTypeDef
- CreateResponsePlanOutputTypeDef
- EventReferenceTypeDef
- CreateTimelineEventOutputTypeDef
- DeleteIncidentRecordInputRequestTypeDef
- DeleteRegionActionTypeDef
- DeleteReplicationSetInputRequestTypeDef
- DeleteResourcePolicyInputRequestTypeDef
- DeleteResponsePlanInputRequestTypeDef
- DeleteTimelineEventInputRequestTypeDef
- DynamicSsmParameterValueTypeDef
- GetIncidentRecordInputRequestTypeDef
- GetReplicationSetInputRequestTypeDef
- WaiterConfigTypeDef
- GetResourcePoliciesInputGetResourcePoliciesPaginateTypeDef
- GetResourcePoliciesInputRequestTypeDef
- ResourcePolicyTypeDef
- GetResponsePlanInputRequestTypeDef
- GetTimelineEventInputRequestTypeDef
- IncidentRecordSourceTypeDef
- NotificationTargetItemTypeDef
- PagerDutyIncidentDetailTypeDef
- ListRelatedItemsInputListRelatedItemsPaginateTypeDef
- ListRelatedItemsInputRequestTypeDef
- ListReplicationSetsInputListReplicationSetsPaginateTypeDef
- ListReplicationSetsInputRequestTypeDef
- ListReplicationSetsOutputTypeDef
- ListResponsePlansInputListResponsePlansPaginateTypeDef
- ListResponsePlansInputRequestTypeDef
- ResponsePlanSummaryTypeDef
- ListTagsForResourceRequestRequestTypeDef
- ListTagsForResourceResponseTypeDef
- PagerDutyIncidentConfigurationTypeDef
- PaginatorConfigTypeDef
- PutResourcePolicyInputRequestTypeDef
- PutResourcePolicyOutputTypeDef
- RegionInfoTypeDef
- ResponseMetadataTypeDef
- TriggerDetailsTypeDef
- StartIncidentOutputTypeDef
- TagResourceRequestRequestTypeDef
- UntagResourceRequestRequestTypeDef
- UpdateDeletionProtectionInputRequestTypeDef
- ConditionTypeDef
- CreateReplicationSetInputRequestTypeDef
- CreateTimelineEventInputRequestTypeDef
- EventSummaryTypeDef
- TimelineEventTypeDef
- UpdateTimelineEventInputRequestTypeDef
- UpdateReplicationSetActionTypeDef
- SsmAutomationTypeDef
- GetReplicationSetInputWaitForReplicationSetActiveWaitTypeDef
- GetReplicationSetInputWaitForReplicationSetDeletedWaitTypeDef
- GetResourcePoliciesOutputTypeDef
- IncidentRecordSummaryTypeDef
- IncidentRecordTypeDef
- IncidentTemplateTypeDef
- UpdateIncidentRecordInputRequestTypeDef
- ItemValueTypeDef
- ListResponsePlansOutputTypeDef
- PagerDutyConfigurationTypeDef
- ReplicationSetTypeDef
- FilterTypeDef
- ListTimelineEventsOutputTypeDef
- GetTimelineEventOutputTypeDef
- UpdateReplicationSetInputRequestTypeDef
- ActionTypeDef
- ListIncidentRecordsOutputTypeDef
- GetIncidentRecordOutputTypeDef
- ItemIdentifierTypeDef
- IntegrationTypeDef
- GetReplicationSetOutputTypeDef
- ListIncidentRecordsInputListIncidentRecordsPaginateTypeDef
- ListIncidentRecordsInputRequestTypeDef
- ListTimelineEventsInputListTimelineEventsPaginateTypeDef
- ListTimelineEventsInputRequestTypeDef
- RelatedItemTypeDef
- CreateResponsePlanInputRequestTypeDef
- GetResponsePlanOutputTypeDef
- UpdateResponsePlanInputRequestTypeDef
- ListRelatedItemsOutputTypeDef
- RelatedItemsUpdateTypeDef
- StartIncidentInputRequestTypeDef
- UpdateRelatedItemsInputRequestTypeDef